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     Ullrich von Bassewitz                                        */
  10 /*              Wacholderweg 14                                              */
  11 /*              D-70597 Stuttgart                                            */
  12 /* EMail:       uz@musoftware.de                                             */
  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 /*                                   Code                                    */
  53 /*****************************************************************************/
  54
  55
  56
  57 void SymEnterLevel (void);
  58 /* Enter a new lexical level */
  59
  60 void SymLeaveLevel (void);
  61 /* Leave the current lexical level */
  62
  63 void SymDef (const char* Name, ExprNode* Expr, int ZP);
  64 /* Define a new symbol */
  65
  66 SymEntry* SymRef (const char* Name);
  67 /* Search for the symbol and return it */
  68
  69 SymEntry* SymRefGlobal (const char* Name);
  70 /* Search for the symbol in the global namespace and return it */
  71
  72 int SymIsDef (const char* Name);
  73 /* Return true if the given symbol is already defined */
  74
  75 int SymIsRef (const char* Name);
  76 /* Return true if the given symbol has been referenced */
  77
  78 void SymImport (const char* Name, int ZP);
  79 /* Mark the given symbol as an imported symbol */
  80
  81 void SymExport (const char* Name, int ZP);
  82 /* Mark the given symbol as an exported symbol */
  83
  84 void SymGlobal (const char* Name, int ZP);
  85 /* Mark the given symbol as a global symbol, that is, as a symbol that is
  86  * either imported or exported.
  87  */
  88
  89 void SymConDes (const char* Name, unsigned Type, unsigned Prio);
  90 /* Mark the given symbol as a module constructor/destructor. This will also
  91  * mark the symbol as an export. Initializers may never be zero page symbols.
  92  */
  93
  94 int SymIsConst (SymEntry* Sym);
  95 /* Return true if the given symbol has a constant value */
  96
  97 int SymIsZP (SymEntry* Sym);
  98 /* Return true if the symbol is explicitly marked as zeropage symbol */
  99
 100 int SymIsImport (SymEntry* Sym);
 101 /* Return true if the given symbol is marked as import */
 102
 103 int SymHasExpr (SymEntry* Sym);
 104 /* Return true if the given symbol has an associated expression */
 105
 106 void SymMarkUser (SymEntry* Sym);
 107 /* Set a user mark on the specified symbol */
 108
 109 void SymUnmarkUser (SymEntry* Sym);
 110 /* Remove a user mark from the specified symbol */
 111
 112 int SymHasUserMark (SymEntry* Sym);
 113 /* Return the state of the user mark for the specified symbol */
 114
 115 long GetSymVal (SymEntry* Sym);
 116 /* Return the symbol value */
 117
 118 ExprNode* GetSymExpr (SymEntry* Sym);
 119 /* Get the expression for a non-const symbol */
 120
 121 const char* GetSymName (SymEntry* Sym);
 122 /* Return the name of the symbol */
 123
 124 unsigned GetSymIndex (SymEntry* Sym);
 125 /* Return the symbol index for the given symbol */
 126
 127 const FilePos* GetSymPos (SymEntry* Sym);
 128 /* Return the position of first occurence in the source for the given symbol */
 129
 130 void SymCheck (void);
 131 /* Run through all symbols and check for anomalies and errors */
 132
 133 void SymDump (FILE* F);
 134 /* Dump the symbol table */
 135
 136 void WriteImports (void);
 137 /* Write the imports list to the object file */
 138
 139 void WriteExports (void);
 140 /* Write the exports list to the object file */
 141
 142 void WriteDbgSyms (void);
 143 /* Write a list of all symbols to the object file */
 144
 145
 146
 147 /* End of symtab.h */
 148
 149 #endif
 150
 151
 152
 153