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 /*****************************************************************************/
52 /*****************************************************************************/
54 /*****************************************************************************/
58 /* Symbol table flags */
59 #define ST_NONE 0x00 /* No flags */
60 #define ST_DEFINED 0x01 /* Scope has been defined */
62 /* Symbol table types */
63 #define ST_GLOBAL 0x00 /* Root level */
64 #define ST_PROC 0x01 /* .PROC */
65 #define ST_SCOPE 0x02 /* .SCOPE */
66 #define ST_STRUCT 0x03 /* .STRUCT/.UNION */
67 #define ST_ENUM 0x04 /* .ENUM */
71 typedef struct SymTable SymTable;
73 SymTable* Left; /* Pointer to smaller entry */
74 SymTable* Right; /* Pointer to greater entry */
75 SymTable* Parent; /* Link to enclosing scope if any */
76 SymTable* Childs; /* Pointer to child scopes */
77 unsigned short Flags; /* Symbol table flags */
78 unsigned char AddrSize; /* Address size */
79 unsigned char Type; /* Type of the scope */
80 unsigned Level; /* Lexical level */
81 unsigned TableSlots; /* Number of hash table slots */
82 unsigned TableEntries; /* Number of entries in the table */
83 unsigned Name; /* Name of the scope */
84 SymEntry* Table[1]; /* Dynamic allocation */
88 SymTable* CurrentScope; /* Pointer to current symbol table */
89 SymTable* RootScope; /* Root symbol table */
93 /*****************************************************************************/
95 /*****************************************************************************/
99 void SymEnterLevel (const char* ScopeName, unsigned char Type, unsigned char AddrSize);
100 /* Enter a new lexical level */
102 void SymLeaveLevel (void);
103 /* Leave the current lexical level */
105 SymTable* SymFindScope (SymTable* Parent, const char* Name, int AllocNew);
106 /* Find a scope in the given enclosing scope */
108 SymTable* SymFindAnyScope (SymTable* Parent, const char* Name);
109 /* Find a scope in the given or any of its parent scopes. The function will
110 * never create a new symbol, since this can only be done in one specific
114 SymEntry* SymFindLocal (SymEntry* Parent, const char* Name, int AllocNew);
115 /* Find a cheap local symbol. If AllocNew is given and the entry is not
116 * found, create a new one. Return the entry found, or the new entry created,
117 * or - in case AllocNew is zero - return 0.
120 SymEntry* SymFind (SymTable* Scope, const char* Name, int AllocNew);
121 /* Find a new symbol table entry in the given table. If AllocNew is given and
122 * the entry is not found, create a new one. Return the entry found, or the
123 * new entry created, or - in case AllocNew is zero - return 0.
126 SymEntry* SymFindAny (SymTable* Scope, const char* Name);
127 /* Find a symbol in the given or any of its parent scopes. The function will
128 * never create a new symbol, since this can only be done in one specific
132 int SymIsZP (SymEntry* Sym);
133 /* Return true if the symbol is explicitly marked as zeropage symbol */
135 #if defined(HAVE_INLINE)
136 INLINE unsigned char GetSymTabType (const SymTable* S)
137 /* Return the type of the given symbol table */
142 # define GetSymTabType(S) ((S)->Type)
145 unsigned char GetCurrentSymTabType ();
146 /* Return the type of the current symbol table */
148 void SymCheck (void);
149 /* Run through all symbols and check for anomalies and errors */
151 void SymDump (FILE* F);
152 /* Dump the symbol table */
154 void WriteImports (void);
155 /* Write the imports list to the object file */
157 void WriteExports (void);
158 /* Write the exports list to the object file */
160 void WriteDbgSyms (void);
161 /* Write a list of all symbols to the object file */
165 /* End of symtab.h */