1 /*****************************************************************************/
5 /* Symbol table 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 /*****************************************************************************/
53 /*****************************************************************************/
55 /*****************************************************************************/
59 /* Symbol table flags */
60 #define ST_NONE 0x00 /* No flags */
61 #define ST_DEFINED 0x01 /* Scope has been defined */
63 /* Symbol table types */
65 ST_GLOBAL, /* Root level */
67 ST_SCOPE, /* .SCOPE */
68 ST_SCOPE_HAS_DATA = ST_SCOPE, /* Last scope that contains data */
69 ST_STRUCT, /* .STRUCT/.UNION */
75 typedef struct SymTable SymTable;
77 SymTable* Left; /* Pointer to smaller entry */
78 SymTable* Right; /* Pointer to greater entry */
79 SymTable* Parent; /* Link to enclosing scope if any */
80 SymTable* Childs; /* Pointer to child scopes */
81 Collection SegRanges; /* Segment ranges for this scope */
82 unsigned short Flags; /* Symbol table flags */
83 unsigned char AddrSize; /* Address size */
84 unsigned char Type; /* Type of the scope */
85 unsigned Level; /* Lexical level */
86 unsigned TableSlots; /* Number of hash table slots */
87 unsigned TableEntries; /* Number of entries in the table */
88 unsigned Name; /* Name of the scope */
89 SymEntry* Table[1]; /* Dynamic allocation */
93 extern SymTable* CurrentScope; /* Pointer to current symbol table */
94 extern SymTable* RootScope; /* Root symbol table */
98 /*****************************************************************************/
100 /*****************************************************************************/
104 void SymEnterLevel (const char* ScopeName, unsigned char Type, unsigned char AddrSize);
105 /* Enter a new lexical level */
107 void SymLeaveLevel (void);
108 /* Leave the current lexical level */
110 SymTable* SymFindScope (SymTable* Parent, const char* Name, int AllocNew);
111 /* Find a scope in the given enclosing scope */
113 SymTable* SymFindAnyScope (SymTable* Parent, const char* Name);
114 /* Find a scope in the given or any of its parent scopes. The function will
115 * never create a new symbol, since this can only be done in one specific
119 SymEntry* SymFindLocal (SymEntry* Parent, const char* Name, int AllocNew);
120 /* Find a cheap local symbol. If AllocNew is given and the entry is not
121 * found, create a new one. Return the entry found, or the new entry created,
122 * or - in case AllocNew is zero - return 0.
125 SymEntry* SymFind (SymTable* Scope, const char* Name, int AllocNew);
126 /* Find a new symbol table entry in the given table. If AllocNew is given and
127 * the entry is not found, create a new one. Return the entry found, or the
128 * new entry created, or - in case AllocNew is zero - return 0.
131 SymEntry* SymFindAny (SymTable* Scope, const char* Name);
132 /* Find a symbol in the given or any of its parent scopes. The function will
133 * never create a new symbol, since this can only be done in one specific
137 #if defined(HAVE_INLINE)
138 INLINE unsigned char GetSymTabType (const SymTable* S)
139 /* Return the type of the given symbol table */
144 # define GetSymTabType(S) ((S)->Type)
147 unsigned char GetCurrentSymTabType ();
148 /* Return the type of the current symbol table */
150 void SymCheck (void);
151 /* Run through all symbols and check for anomalies and errors */
153 void SymDump (FILE* F);
154 /* Dump the symbol table */
156 void WriteImports (void);
157 /* Write the imports list to the object file */
159 void WriteExports (void);
160 /* Write the exports list to the object file */
162 void WriteDbgSyms (void);
163 /* Write a list of all symbols to the object file */
167 /* End of symtab.h */