1 /*****************************************************************************/
5 /* Symbol table for the ca65 macroassembler */
9 /* (C) 1998-2011, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
15 /* This software is provided 'as-is', without any expressed or implied */
16 /* warranty. In no event will the authors be held liable for any damages */
17 /* arising from the use of this software. */
19 /* Permission is granted to anyone to use this software for any purpose, */
20 /* including commercial applications, and to alter it and redistribute it */
21 /* freely, subject to the following restrictions: */
23 /* 1. The origin of this software must not be misrepresented; you must not */
24 /* claim that you wrote the original software. If you use this software */
25 /* in a product, an acknowledgment in the product documentation would be */
26 /* appreciated but is not required. */
27 /* 2. Altered source versions must be plainly marked as such, and must not */
28 /* be misrepresented as being the original software. */
29 /* 3. This notice may not be removed or altered from any source */
32 /*****************************************************************************/
53 /*****************************************************************************/
55 /*****************************************************************************/
59 /* Symbol table flags */
60 #define ST_NONE 0x00 /* No flags */
61 #define ST_DEFINED 0x01 /* Scope has been defined */
64 typedef struct SymTable SymTable;
66 SymTable* Next; /* Pointer to next table in list */
67 SymTable* Left; /* Pointer to smaller entry */
68 SymTable* Right; /* Pointer to greater entry */
69 SymTable* Parent; /* Link to enclosing scope if any */
70 SymTable* Childs; /* Pointer to child scopes */
71 SymEntry* OwnerSym; /* Symbol that "owns" the scope */
72 Collection SegRanges; /* Segment ranges for this scope */
73 unsigned Id; /* Scope id */
74 unsigned short Flags; /* Symbol table flags */
75 unsigned char AddrSize; /* Address size */
76 unsigned char Type; /* Type of the scope */
77 unsigned Level; /* Lexical level */
78 unsigned TableSlots; /* Number of hash table slots */
79 unsigned TableEntries; /* Number of entries in the table */
80 unsigned Name; /* Name of the scope */
81 SymEntry* Table[1]; /* Dynamic allocation */
85 extern SymTable* CurrentScope; /* Pointer to current symbol table */
86 extern SymTable* RootScope; /* Root symbol table */
90 /*****************************************************************************/
92 /*****************************************************************************/
96 void SymEnterLevel (const StrBuf* ScopeName, unsigned char Type,
97 unsigned char AddrSize, SymEntry* OwnerSym);
98 /* Enter a new lexical level */
100 void SymLeaveLevel (void);
101 /* Leave the current lexical level */
103 SymTable* SymFindScope (SymTable* Parent, const StrBuf* Name, int AllocNew);
104 /* Find a scope in the given enclosing scope */
106 SymTable* SymFindAnyScope (SymTable* Parent, const StrBuf* Name);
107 /* Find a scope in the given or any of its parent scopes. The function will
108 * never create a new symbol, since this can only be done in one specific
112 SymEntry* SymFindLocal (SymEntry* Parent, const StrBuf* StrBuf, int AllocNew);
113 /* Find a cheap local symbol. If AllocNew is given and the entry is not
114 * found, create a new one. Return the entry found, or the new entry created,
115 * or - in case AllocNew is zero - return 0.
118 SymEntry* SymFind (SymTable* Scope, const StrBuf* Name, int AllocNew);
119 /* Find a new symbol table entry in the given table. If AllocNew is given and
120 * the entry is not found, create a new one. Return the entry found, or the
121 * new entry created, or - in case AllocNew is zero - return 0.
124 SymEntry* SymFindAny (SymTable* Scope, const StrBuf* Name);
125 /* Find a symbol in the given or any of its parent scopes. The function will
126 * never create a new symbol, since this can only be done in one specific
130 #if defined(HAVE_INLINE)
131 INLINE unsigned char GetSymTabType (const SymTable* S)
132 /* Return the type of the given symbol table */
137 # define GetSymTabType(S) ((S)->Type)
140 void SymCheck (void);
141 /* Run through all symbols and check for anomalies and errors */
143 void SymDump (FILE* F);
144 /* Dump the symbol table */
146 void WriteImports (void);
147 /* Write the imports list to the object file */
149 void WriteExports (void);
150 /* Write the exports list to the object file */
152 void WriteDbgSyms (void);
153 /* Write a list of all symbols to the object file */
155 void WriteScopes (void);
156 /* Write the scope table to the object file */
160 /* End of symtab.h */