1 /*****************************************************************************/
5 /* Symbol table management for the cc65 C compiler */
9 /* (C) 2000-2013, 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 /*****************************************************************************/
48 /*****************************************************************************/
50 /*****************************************************************************/
55 typedef struct SymTable SymTable;
57 SymTable* PrevTab; /* Pointer to higher level symbol table */
58 SymEntry* SymHead; /* Double linked list of symbols */
59 SymEntry* SymTail; /* Double linked list of symbols */
60 unsigned SymCount; /* Count of symbols in this table */
61 unsigned Size; /* Size of table */
62 SymEntry* Tab[1]; /* Actual table, dynamically allocated */
65 /* An empty symbol table */
66 extern SymTable EmptySymTab;
71 /* Predefined lexical levels */
72 #define LEX_LEVEL_GLOBAL 1U
73 #define LEX_LEVEL_FUNCTION 2U
77 /*****************************************************************************/
78 /* Handling of lexical levels */
79 /*****************************************************************************/
83 unsigned GetLexicalLevel (void);
84 /* Return the current lexical level */
86 void EnterGlobalLevel (void);
87 /* Enter the program global lexical level */
89 void LeaveGlobalLevel (void);
90 /* Leave the program global lexical level */
92 void EnterFunctionLevel (void);
93 /* Enter function lexical level */
95 void RememberFunctionLevel (struct FuncDesc* F);
96 /* Remember the symbol tables for the level and leave the level without checks */
98 void ReenterFunctionLevel (struct FuncDesc* F);
99 /* Reenter the function lexical level using the existing tables from F */
101 void LeaveFunctionLevel (void);
102 /* Leave function lexical level */
104 void EnterBlockLevel (void);
105 /* Enter a nested block in a function */
107 void LeaveBlockLevel (void);
108 /* Leave a nested block in a function */
110 void EnterStructLevel (void);
111 /* Enter a nested block for a struct definition */
113 void LeaveStructLevel (void);
114 /* Leave a nested block for a struct definition */
118 /*****************************************************************************/
120 /*****************************************************************************/
124 SymEntry* FindSym (const char* Name);
125 /* Find the symbol with the given name */
127 SymEntry* FindGlobalSym (const char* Name);
128 /* Find the symbol with the given name in the global symbol table only */
130 SymEntry* FindLocalSym (const char* Name);
131 /* Find the symbol with the given name in the current symbol table only */
133 SymEntry* FindTagSym (const char* Name);
134 /* Find the symbol with the given name in the tag table */
136 SymEntry* FindStructField (const Type* TypeArray, const char* Name);
137 /* Find a struct field in the fields list */
139 unsigned short FindSPAdjustment (const char* Name);
140 /* Search for an entry in the table of SP adjustments */
143 /*****************************************************************************/
144 /* Add stuff to the symbol table */
145 /*****************************************************************************/
149 SymEntry* AddStructSym (const char* Name, unsigned Type, unsigned Size, SymTable* Tab);
150 /* Add a struct/union entry and return it */
152 SymEntry* AddBitField (const char* Name, unsigned Offs, unsigned BitOffs, unsigned Width);
153 /* Add a bit field to the local symbol table and return the symbol entry */
155 SymEntry* AddConstSym (const char* Name, const Type* T, unsigned Flags, long Val);
156 /* Add an constant symbol to the symbol table and return it */
158 SymEntry* AddLabelSym (const char* Name, unsigned Flags);
159 /* Add a goto label to the symbol table */
161 SymEntry* AddLocalSym (const char* Name, const Type* T, unsigned Flags, int Offs);
162 /* Add a local symbol and return the symbol entry */
164 SymEntry* AddGlobalSym (const char* Name, const Type* T, unsigned Flags);
165 /* Add an external or global symbol to the symbol table and return the entry */
169 /*****************************************************************************/
171 /*****************************************************************************/
175 SymTable* GetSymTab (void);
176 /* Return the current symbol table */
178 SymTable* GetGlobalSymTab (void);
179 /* Return the global symbol table */
181 int SymIsLocal (SymEntry* Sym);
182 /* Return true if the symbol is defined in the highest lexical level */
184 void MakeZPSym (const char* Name);
185 /* Mark the given symbol as zero page symbol */
187 void PrintSymTable (const SymTable* Tab, FILE* F, const char* Header, ...);
188 /* Write the symbol table to the given file */
190 void EmitExternals (void);
191 /* Write import/export statements for external symbols */
193 void EmitDebugInfo (void);
194 /* Emit debug infos for the locals of the current scope */
198 /* End of symtab.h */