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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                symentry.h                                 */
   4 /*                                                                           */
   5 /*          Symbol table entry forward 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 SYMENTRY_H
  37 #define SYMENTRY_H
  38
  39
  40
  41 /* common */
  42 #include "cddefs.h"
  43 #include "coll.h"
  44 #include "filepos.h"
  45
  46
  47
  48 /*****************************************************************************/
  49 /*                                   Data                                    */
  50 /*****************************************************************************/
  51
  52
  53
  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_FINALIZED    0x0200          /* Symbol is finalized */
  64 #define SF_INDEXED      0x0800          /* Index is valid */
  65 #define SF_CONST        0x1000          /* The symbol has a constant value */
  66 #define SF_MULTDEF      0x2000          /* Multiply defined symbol */
  67 #define SF_DEFINED      0x4000          /* Defined */
  68 #define SF_REFERENCED   0x8000          /* Referenced */
  69
  70 /* Arguments for SymFind... */
  71 #define SYM_FIND_EXISTING       0
  72 #define SYM_ALLOC_NEW           1
  73
  74 /* Structure of a symbol table entry */
  75 typedef struct SymEntry SymEntry;
  76 struct SymEntry {
  77     SymEntry*               Left;       /* Lexically smaller entry */
  78     SymEntry*               Right;      /* Lexically larger entry */
  79     SymEntry*               List;       /* List of all entries */
  80     SymEntry*               Locals;     /* Root of subtree for local symbols */
  81     struct SymTable*        SymTab;     /* Table this symbol is in, 0 for locals */
  82     FilePos                 Pos;        /* File position for this symbol */
  83     unsigned                Flags;      /* Symbol flags */
  84     unsigned                Index;      /* Index of import/export entries */
  85     union {
  86         struct ExprNode*    Expr;       /* Expression if CONST not set */
  87         long                Val;        /* Value (if CONST set) */
  88         SymEntry*           Sym;        /* Symbol (if trampoline entry) */
  89     } V;
  90     Collection              ExprRefs;   /* Expressions using this symbol */
  91     unsigned char           ExportSize; /* Export address size */
  92     unsigned char           AddrSize;   /* Address size of label */
  93     unsigned char           ConDesPrio[CD_TYPE_COUNT];  /* ConDes priorities... */
  94                                         /* ...actually value+1 (used as flag) */
  95     unsigned                Name;       /* Name index in global string pool */
  96 };
  97
  98 /* List of all symbol table entries */
  99 extern SymEntry* SymList;
 100
 101 /* Pointer to last defined symbol */
 102 extern SymEntry* SymLast;
 103
 104
 105
 106 /*****************************************************************************/
 107 /*                                   Code                                    */
 108 /*****************************************************************************/
 109
 110
 111
 112 int IsLocalName (const char* Name);
 113 /* Return true if Name is the name of a local symbol */
 114
 115 int IsLocalNameId (unsigned Name);
 116 /* Return true if Name is the name of a local symbol */
 117
 118 SymEntry* NewSymEntry (const char* Name);
 119 /* Allocate a symbol table entry, initialize and return it */
 120
 121 #if defined(HAVE_INLINE)
 122 INLINE void SymAddExprRef (SymEntry* Sym, struct ExprNode* Expr)
 123 /* Add an expression reference to this symbol */
 124 {
 125     CollAppend (&Sym->ExprRefs, Expr);
 126 }
 127 #else
 128 #define SymAddExprRef(Sym,Expr)     CollAppend (&(Sym)->ExprRefs, Expr)
 129 #endif
 130
 131 #if defined(HAVE_INLINE)
 132 INLINE void SymDelExprRef (SymEntry* Sym, struct ExprNode* Expr)
 133 /* Delete an expression reference to this symbol */
 134 {
 135     CollDeleteItem (&Sym->ExprRefs, Expr);
 136 }
 137 #else
 138 #define SymDelExprRef(Sym,Expr)     CollDeleteItem (&(Sym)->ExprRefs, Expr)
 139 #endif
 140
 141 void SymDef (SymEntry* Sym, ExprNode* Expr, unsigned AddrSize, unsigned Flags);
 142 /* Mark a symbol as defined */
 143
 144 void SymRef (SymEntry* Sym);
 145 /* Mark the given symbol as referenced */
 146
 147 void SymImport (SymEntry* Sym, unsigned AddrSize, unsigned Flags);
 148 /* Mark the given symbol as an imported symbol */
 149
 150 void SymExport (SymEntry* Sym, unsigned AddrSize, unsigned Flags);
 151 /* Mark the given symbol as an exported symbol */
 152
 153 void SymGlobal (SymEntry* S, unsigned AddrSize, unsigned Flags);
 154 /* Mark the given symbol as a global symbol, that is, as a symbol that is
 155  * either imported or exported.
 156  */
 157
 158 int SymIsDef (const SymEntry* Sym);
 159 /* Return true if the given symbol is already defined */
 160
 161 int SymIsRef (const SymEntry* Sym);
 162 /* Return true if the given symbol has been referenced */
 163
 164 int SymIsImport (const SymEntry* Sym);
 165 /* Return true if the given symbol is marked as import */
 166
 167 int SymHasExpr (const SymEntry* Sym);
 168 /* Return true if the given symbol has an associated expression */
 169
 170 void SymFinalize (SymEntry* S);
 171 /* Finalize a symbol expression if there is one */
 172
 173 void SymMarkUser (SymEntry* Sym);
 174 /* Set a user mark on the specified symbol */
 175
 176 void SymUnmarkUser (SymEntry* Sym);
 177 /* Remove a user mark from the specified symbol */
 178
 179 int SymHasUserMark (SymEntry* Sym);
 180 /* Return the state of the user mark for the specified symbol */
 181
 182 long GetSymVal (SymEntry* Sym);
 183 /* Return the symbol value */
 184
 185 struct ExprNode* GetSymExpr (SymEntry* Sym);
 186 /* Get the expression for a non-const symbol */
 187
 188 const char* GetSymName (SymEntry* Sym);
 189 /* Return the name of the symbol */
 190
 191 unsigned GetSymIndex (SymEntry* Sym);
 192 /* Return the symbol index for the given symbol */
 193
 194 const FilePos* GetSymPos (SymEntry* Sym);
 195 /* Return the position of first occurence in the source for the given symbol */
 196
 197
 198
 199
 200 /* End of symentry.h */
 201
 202 #endif
 203
 204
 205