git.sur5r.net Git - cc65/blob - src/ca65/symtab.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 symtab.h                                  */
   4 /*                                                                           */
   5 /*                 Symbol table for the ca65 macroassembler                  */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 1998-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  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.                                    */
  18 /*                                                                           */
  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:                            */
  22 /*                                                                           */
  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              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef SYMTAB_H
  37 #define SYMTAB_H
  38
  39
  40
  41 #include <stdio.h>
  42
  43 /* common */
  44 #include "exprdefs.h"
  45
  46 /* ca65 */
  47 #include "symentry.h"
  48
  49
  50
  51 /*****************************************************************************/
  52 /*                                   Data                                    */
  53 /*****************************************************************************/
  54
  55
  56
  57 /* Scope identifiers */
  58 #define SCOPE_ANY       0
  59 #define SCOPE_GLOBAL    1
  60 #define SCOPE_LOCAL     2
  61
  62 /* Flags used in SymDef */
  63 #define SYM_DEFAULT     0x00
  64 #define SYM_ZP          0x01
  65 #define SYM_LABEL       0x02
  66
  67
  68
  69 /*****************************************************************************/
  70 /*                                   Code                                    */
  71 /*****************************************************************************/
  72
  73
  74
  75 void SymEnterLevel (void);
  76 /* Enter a new lexical level */
  77
  78 void SymLeaveLevel (void);
  79 /* Leave the current lexical level */
  80
  81 int SymIsLocalLevel (void);
  82 /* Return true if we are on a local symbol table level. */
  83
  84 void SymDef (const char* Name, ExprNode* Expr, unsigned Flags);
  85 /* Define a new symbol */
  86
  87 SymEntry* SymRef (const char* Name, int Scope);
  88 /* Search for the symbol and return it */
  89
  90 int SymIsDef (const char* Name, int Scope);
  91 /* Return true if the given symbol is already defined */
  92
  93 int SymIsRef (const char* Name, int Scope);
  94 /* Return true if the given symbol has been referenced */
  95
  96 void SymImport (const char* Name);
  97 /* Mark the given symbol as an imported symbol */
  98
  99 void SymImportZP (const char* Name);
 100 /* Mark the given symbol as a imported zeropage symbol */
 101
 102 void SymImportForced (const char* Name);
 103 /* Mark the given symbol as a forced imported symbol */
 104
 105 void SymExport (const char* Name);
 106 /* Mark the given symbol as an exported symbol */
 107
 108 void SymExportZP (const char* Name);
 109 /* Mark the given symbol as an exported zeropage symbol */
 110
 111 void SymGlobal (const char* Name);
 112 /* Mark the given symbol as a global symbol, that is, as a symbol that is
 113  * either imported or exported.
 114  */
 115
 116 void SymGlobalZP (const char* Name);
 117 /* Mark the given symbol as a global zeropage symbol, that is, as a symbol
 118  * that is either imported or exported.
 119  */
 120
 121 void SymConDes (const char* Name, unsigned Type, unsigned Prio);
 122 /* Mark the given symbol as a module constructor/destructor. This will also
 123  * mark the symbol as an export. Initializers may never be zero page symbols.
 124  */
 125
 126 int SymIsConst (SymEntry* Sym);
 127 /* Return true if the given symbol has a constant value */
 128
 129 int SymIsZP (SymEntry* Sym);
 130 /* Return true if the symbol is explicitly marked as zeropage symbol */
 131
 132 int SymIsImport (SymEntry* Sym);
 133 /* Return true if the given symbol is marked as import */
 134
 135 int SymHasExpr (SymEntry* Sym);
 136 /* Return true if the given symbol has an associated expression */
 137
 138 void SymMarkUser (SymEntry* Sym);
 139 /* Set a user mark on the specified symbol */
 140
 141 void SymUnmarkUser (SymEntry* Sym);
 142 /* Remove a user mark from the specified symbol */
 143
 144 int SymHasUserMark (SymEntry* Sym);
 145 /* Return the state of the user mark for the specified symbol */
 146
 147 long GetSymVal (SymEntry* Sym);
 148 /* Return the symbol value */
 149
 150 ExprNode* GetSymExpr (SymEntry* Sym);
 151 /* Get the expression for a non-const symbol */
 152
 153 const char* GetSymName (SymEntry* Sym);
 154 /* Return the name of the symbol */
 155
 156 unsigned GetSymIndex (SymEntry* Sym);
 157 /* Return the symbol index for the given symbol */
 158
 159 const FilePos* GetSymPos (SymEntry* Sym);
 160 /* Return the position of first occurence in the source for the given symbol */
 161
 162 void SymCheck (void);
 163 /* Run through all symbols and check for anomalies and errors */
 164
 165 void SymDump (FILE* F);
 166 /* Dump the symbol table */
 167
 168 void WriteImports (void);
 169 /* Write the imports list to the object file */
 170
 171 void WriteExports (void);
 172 /* Write the exports list to the object file */
 173
 174 void WriteDbgSyms (void);
 175 /* Write a list of all symbols to the object file */
 176
 177
 178
 179 /* End of symtab.h */
 180
 181 #endif
 182
 183
 184
 185