1 /*****************************************************************************/
5 /* Symbol table entries for the cc65 C compiler */
9 /* (C) 2000-2009 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 /*****************************************************************************/
51 /*****************************************************************************/
53 /*****************************************************************************/
61 /*****************************************************************************/
63 /*****************************************************************************/
67 /* Storage classes and flags */
68 #define SC_AUTO 0x0001U
69 #define SC_REGISTER 0x0002U /* Register variable, is in static storage */
70 #define SC_STATIC 0x0004U
71 #define SC_EXTERN 0x0008U
73 #define SC_ENUM 0x0030U /* An enum (numeric constant) */
74 #define SC_CONST 0x0020U /* A numeric constant with a type */
75 #define SC_LABEL 0x0040U /* A goto label */
76 #define SC_PARAM 0x0080U /* This is a function parameter */
77 #define SC_FUNC 0x0100U /* Function entry */
79 #define SC_DEFTYPE 0x0200U /* Parameter has default type (=int, old style) */
80 #define SC_STORAGE 0x0400U /* Symbol with associated storage */
81 #define SC_DEFAULT 0x0800U /* Flag: default storage class was used */
83 #define SC_DEF 0x1000U /* Symbol is defined */
84 #define SC_REF 0x2000U /* Symbol is referenced */
86 #define SC_TYPE 0x4000U /* This is a type, struct, typedef, etc. */
87 #define SC_STRUCT 0x4001U /* Struct or union */
88 #define SC_STRUCTFIELD 0x4002U /* Struct or union field */
89 #define SC_BITFIELD 0x4004U /* A bit-field inside a struct or union */
90 #define SC_TYPEDEF 0x4008U /* A typedef */
92 #define SC_ZEROPAGE 0x8000U /* Symbol marked as zeropage */
96 /* Symbol table entry */
97 typedef struct SymEntry SymEntry;
99 SymEntry* NextHash; /* Next entry in hash list */
100 SymEntry* PrevSym; /* Previous symbol in dl list */
101 SymEntry* NextSym; /* Next symbol double linked list */
102 SymEntry* Link; /* General purpose single linked list */
103 struct SymTable* Owner; /* Symbol table the symbol is in */
104 unsigned Flags; /* Symbol flags */
105 Type* Type; /* Symbol type */
106 char* AsmName; /* Assembler name if any */
108 /* Data that differs for the different symbol types */
111 /* Offset for locals or struct members */
114 /* Label name for static symbols */
117 /* Register bank offset and offset of the saved copy on stack for
118 * register variables.
125 /* Value for constants (including enums) */
128 /* Data for structs/unions */
130 struct SymTable* SymTab; /* Member symbol table */
131 unsigned Size; /* Size of the union/struct */
134 /* Data for bit fields */
136 unsigned Offs; /* Byte offset into struct */
137 unsigned BitOffs; /* Bit offset into storage unit */
138 unsigned BitWidth; /* Width in bits */
141 /* Data for functions */
143 struct FuncDesc* Func; /* Function descriptor */
144 struct Segments* Seg; /* Segments for this function */
148 char Name[1]; /* Name, dynamically allocated */
153 /*****************************************************************************/
155 /*****************************************************************************/
159 SymEntry* NewSymEntry (const char* Name, unsigned Flags);
160 /* Create a new symbol table with the given name */
162 void FreeSymEntry (SymEntry* E);
163 /* Free a symbol entry */
165 void DumpSymEntry (FILE* F, const SymEntry* E);
166 /* Dump the given symbol table entry to the file in readable form */
168 #if defined(HAVE_INLINE)
169 INLINE int SymIsBitField (const SymEntry* Sym)
170 /* Return true if the given entry is a bit-field entry */
172 return ((Sym->Flags & SC_BITFIELD) == SC_BITFIELD);
175 # define SymIsBitField(Sym) (((Sym)->Flags & SC_BITFIELD) == SC_BITFIELD)
178 #if defined(HAVE_INLINE)
179 INLINE int SymIsTypeDef (const SymEntry* Sym)
180 /* Return true if the given entry is a typedef entry */
182 return ((Sym->Flags & SC_TYPEDEF) == SC_TYPEDEF);
185 # define SymIsTypeDef(Sym) (((Sym)->Flags & SC_TYPEDEF) == SC_TYPEDEF)
188 #if defined(HAVE_INLINE)
189 INLINE int SymIsDef (const SymEntry* Sym)
190 /* Return true if the given entry is defined */
192 return ((Sym->Flags & SC_DEF) == SC_DEF);
195 # define SymIsDef(Sym) (((Sym)->Flags & SC_DEF) == SC_DEF)
198 #if defined(HAVE_INLINE)
199 INLINE int SymIsRef (const SymEntry* Sym)
200 /* Return true if the given entry is referenced */
202 return ((Sym->Flags & SC_REF) == SC_REF);
205 # define SymIsRef(Sym) (((Sym)->Flags & SC_REF) == SC_REF)
208 #if defined(HAVE_INLINE)
209 INLINE int SymIsRegVar (const SymEntry* Sym)
210 /* Return true if the given entry is a register variable */
211 /* ### HACK! Fix the ugly type flags! */
213 return ((Sym->Flags & (SC_REGISTER|SC_TYPE)) == SC_REGISTER);
216 # define SymIsRegVar(Sym) (((Sym)->Flags & (SC_REGISTER|SC_TYPE)) == SC_REGISTER)
219 #if defined(HAVE_INLINE)
220 INLINE const char* SymGetAsmName (const SymEntry* Sym)
221 /* Return the assembler label name for the symbol (beware: may be NULL!) */
226 # define SymGetAsmName(Sym) ((Sym)->AsmName)
229 void CvtRegVarToAuto (SymEntry* Sym);
230 /* Convert a register variable to an auto variable */
232 void ChangeSymType (SymEntry* Entry, Type* T);
233 /* Change the type of the given symbol */
235 void ChangeAsmName (SymEntry* Entry, const char* NewAsmName);
236 /* Change the assembler name of the symbol */
238 int HasAnonName (const SymEntry* Entry);
239 /* Return true if the symbol entry has an anonymous name */
243 /* End of symentry.h */