1 /*****************************************************************************/
5 /* Symbol table entry forward for the ca65 macroassembler */
9 /* (C) 1998-2003 Ullrich von Bassewitz */
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 /*****************************************************************************/
54 /* Bits for the Flags value in SymEntry */
55 #define SF_NONE 0x0000 /* Empty flag set */
56 #define SF_USER 0x0001 /* User bit */
57 #define SF_TRAMPOLINE 0x0002 /* Trampoline entry */
58 #define SF_EXPORT 0x0004 /* Export this symbol */
59 #define SF_IMPORT 0x0008 /* Import this symbol */
60 #define SF_GLOBAL 0x0010 /* Global symbol */
61 #define SF_LABEL 0x0080 /* Used as a label */
62 #define SF_FORCED 0x0100 /* Forced import, SF_IMPORT also set */
63 #define SF_INDEXED 0x0800 /* Index is valid */
64 #define SF_MULTDEF 0x2000 /* Multiply defined symbol */
65 #define SF_DEFINED 0x4000 /* Defined */
66 #define SF_REFERENCED 0x8000 /* Referenced */
68 /* Arguments for SymFind... */
69 #define SYM_FIND_EXISTING 0
70 #define SYM_ALLOC_NEW 1
72 /* Structure of a symbol table entry */
73 typedef struct SymEntry SymEntry;
75 SymEntry* Left; /* Lexically smaller entry */
76 SymEntry* Right; /* Lexically larger entry */
77 SymEntry* List; /* List of all entries */
78 SymEntry* Locals; /* Root of subtree for local symbols */
79 struct SymTable* SymTab; /* Table this symbol is in, 0 for locals */
80 FilePos Pos; /* File position for this symbol */
81 unsigned Flags; /* Symbol flags */
82 unsigned Index; /* Index of import/export entries */
84 struct ExprNode* Expr; /* Expression if CONST not set */
85 long Val; /* Value (if CONST set) */
86 SymEntry* Sym; /* Symbol (if trampoline entry) */
88 Collection ExprRefs; /* Expressions using this symbol */
89 unsigned char ExportSize; /* Export address size */
90 unsigned char AddrSize; /* Address size of label */
91 unsigned char ConDesPrio[CD_TYPE_COUNT]; /* ConDes priorities... */
92 /* ...actually value+1 (used as flag) */
93 unsigned Name; /* Name index in global string pool */
96 /* List of all symbol table entries */
97 extern SymEntry* SymList;
99 /* Pointer to last defined symbol */
100 extern SymEntry* SymLast;
104 /*****************************************************************************/
106 /*****************************************************************************/
110 int IsLocalName (const char* Name);
111 /* Return true if Name is the name of a local symbol */
113 int IsLocalNameId (unsigned Name);
114 /* Return true if Name is the name of a local symbol */
116 SymEntry* NewSymEntry (const char* Name);
117 /* Allocate a symbol table entry, initialize and return it */
119 #if defined(HAVE_INLINE)
120 INLINE void SymAddExprRef (SymEntry* Sym, struct ExprNode* Expr)
121 /* Add an expression reference to this symbol */
123 CollAppend (&Sym->ExprRefs, Expr);
126 #define SymAddExprRef(Sym,Expr) CollAppend (&(Sym)->ExprRefs, Expr)
129 #if defined(HAVE_INLINE)
130 INLINE void SymDelExprRef (SymEntry* Sym, struct ExprNode* Expr)
131 /* Delete an expression reference to this symbol */
133 CollDeleteItem (&Sym->ExprRefs, Expr);
136 #define SymDelExprRef(Sym,Expr) CollDeleteItem (&(Sym)->ExprRefs, Expr)
139 void SymDef (SymEntry* Sym, ExprNode* Expr, unsigned char AddrSize, unsigned Flags);
140 /* Mark a symbol as defined */
142 void SymRef (SymEntry* Sym);
143 /* Mark the given symbol as referenced */
145 void SymImport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
146 /* Mark the given symbol as an imported symbol */
148 void SymExport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
149 /* Mark the given symbol as an exported symbol */
151 void SymGlobal (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
152 /* Mark the given symbol as a global symbol, that is, as a symbol that is
153 * either imported or exported.
156 void SymConDes (SymEntry* Sym, unsigned char AddrSize, unsigned Type, unsigned Prio);
157 /* Mark the given symbol as a module constructor/destructor. This will also
158 * mark the symbol as an export. Initializers may never be zero page symbols.
161 int SymIsDef (const SymEntry* Sym);
162 /* Return true if the given symbol is already defined */
164 int SymIsRef (const SymEntry* Sym);
165 /* Return true if the given symbol has been referenced */
167 int SymIsImport (const SymEntry* Sym);
168 /* Return true if the given symbol is marked as import */
170 int SymIsConst (SymEntry* Sym, long* Val);
171 /* Return true if the given symbol has a constant value. If Val is not NULL
172 * and the symbol has a constant value, store it's value there.
175 int SymHasExpr (const SymEntry* Sym);
176 /* Return true if the given symbol has an associated expression */
178 void SymMarkUser (SymEntry* Sym);
179 /* Set a user mark on the specified symbol */
181 void SymUnmarkUser (SymEntry* Sym);
182 /* Remove a user mark from the specified symbol */
184 int SymHasUserMark (SymEntry* Sym);
185 /* Return the state of the user mark for the specified symbol */
187 struct ExprNode* GetSymExpr (SymEntry* Sym);
188 /* Get the expression for a non-const symbol */
190 const struct ExprNode* SymResolve (const SymEntry* Sym);
191 /* Helper function for DumpExpr. Resolves a symbol into an expression or return
192 * NULL. Do not call in other contexts!
195 const char* GetSymName (const SymEntry* Sym);
196 /* Return the name of the symbol */
198 unsigned GetSymAddrSize (const SymEntry* Sym);
199 /* Return the address size of the symbol. Beware: This function will just
200 * return the AddrSize member, it will not look at the expression!
203 unsigned GetSymIndex (const SymEntry* Sym);
204 /* Return the symbol index for the given symbol */
206 const FilePos* GetSymPos (const SymEntry* Sym);
207 /* Return the position of first occurence in the source for the given symbol */
212 /* End of symentry.h */