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ömerstraße 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 #include "inline.h"
  46
  47 /* ca65 */
  48 #include "spool.h"
  49
  50
  51
  52 /*****************************************************************************/
  53 /*                                   Data                                    */
  54 /*****************************************************************************/
  55
  56
  57
  58 /* Bits for the Flags value in SymEntry */
  59 #define SF_NONE         0x0000          /* Empty flag set */
  60 #define SF_USER         0x0001          /* User bit */
  61 #define SF_UNUSED       0x0002          /* Unused entry */
  62 #define SF_EXPORT       0x0004          /* Export this symbol */
  63 #define SF_IMPORT       0x0008          /* Import this symbol */
  64 #define SF_GLOBAL       0x0010          /* Global symbol */
  65 #define SF_LOCAL        0x0020          /* Cheap local symbol */
  66 #define SF_LABEL        0x0080          /* Used as a label */
  67 #define SF_FORCED       0x0100          /* Forced import, SF_IMPORT also set */
  68 #define SF_INDEXED      0x0800          /* Index is valid */
  69 #define SF_MULTDEF      0x2000          /* Multiply defined symbol */
  70 #define SF_DEFINED      0x4000          /* Defined */
  71 #define SF_REFERENCED   0x8000          /* Referenced */
  72
  73 /* Arguments for SymFind... */
  74 #define SYM_FIND_EXISTING       0
  75 #define SYM_ALLOC_NEW           1
  76
  77 /* Structure of a symbol table entry */
  78 typedef struct SymEntry SymEntry;
  79 struct SymEntry {
  80     SymEntry*               Left;       /* Lexically smaller entry */
  81     SymEntry*               Right;      /* Lexically larger entry */
  82     SymEntry*               List;       /* List of all entries */
  83     SymEntry*               Locals;     /* Root of subtree for local symbols */
  84     struct SymTable*        SymTab;     /* Table this symbol is in, 0 for locals */
  85     FilePos                 Pos;        /* File position for this symbol */
  86     unsigned                Flags;      /* Symbol flags */
  87     unsigned                Index;      /* Index of import/export entries */
  88     union {
  89         struct ExprNode*    Expr;       /* Symbol expression */
  90         SymEntry*           Sym;        /* Symbol (if trampoline entry) */
  91     } V;
  92     Collection              ExprRefs;   /* Expressions using this symbol */
  93     unsigned char           ExportSize; /* Export address size */
  94     unsigned char           AddrSize;   /* Address size of label */
  95     unsigned char           ConDesPrio[CD_TYPE_COUNT];  /* ConDes priorities... */
  96                                         /* ...actually value+1 (used as flag) */
  97     unsigned                Name;       /* Name index in global string pool */
  98 };
  99
 100 /* List of all symbol table entries */
 101 extern SymEntry* SymList;
 102
 103 /* Pointer to last defined symbol */
 104 extern SymEntry* SymLast;
 105
 106
 107
 108 /*****************************************************************************/
 109 /*                                   Code                                    */
 110 /*****************************************************************************/
 111
 112
 113
 114 SymEntry* NewSymEntry (const char* Name, unsigned Flags);
 115 /* Allocate a symbol table entry, initialize and return it */
 116
 117 int SymSearchTree (SymEntry* T, const char* Name, SymEntry** E);
 118 /* Search in the given tree for a name. If we find the symbol, the function
 119  * will return 0 and put the entry pointer into E. If we did not find the
 120  * symbol, and the tree is empty, E is set to NULL. If the tree is not empty,
 121  * E will be set to the last entry, and the result of the function is <0 if
 122  * the entry should be inserted on the left side, and >0 if it should get
 123  * inserted on the right side.
 124  */
 125
 126 #if defined(HAVE_INLINE)
 127 INLINE void SymAddExprRef (SymEntry* Sym, struct ExprNode* Expr)
 128 /* Add an expression reference to this symbol */
 129 {
 130     CollAppend (&Sym->ExprRefs, Expr);
 131 }
 132 #else
 133 #define SymAddExprRef(Sym,Expr)     CollAppend (&(Sym)->ExprRefs, Expr)
 134 #endif
 135
 136 #if defined(HAVE_INLINE)
 137 INLINE void SymDelExprRef (SymEntry* Sym, struct ExprNode* Expr)
 138 /* Delete an expression reference to this symbol */
 139 {
 140     CollDeleteItem (&Sym->ExprRefs, Expr);
 141 }
 142 #else
 143 #define SymDelExprRef(Sym,Expr)     CollDeleteItem (&(Sym)->ExprRefs, Expr)
 144 #endif
 145
 146 void SymTransferExprRefs (SymEntry* From, SymEntry* To);
 147 /* Transfer all expression references from one symbol to another. */
 148
 149 void SymDef (SymEntry* Sym, ExprNode* Expr, unsigned char AddrSize, unsigned Flags);
 150 /* Mark a symbol as defined */
 151
 152 void SymRef (SymEntry* Sym);
 153 /* Mark the given symbol as referenced */
 154
 155 void SymImport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 156 /* Mark the given symbol as an imported symbol */
 157
 158 void SymExport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 159 /* Mark the given symbol as an exported symbol */
 160
 161 void SymGlobal (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 162 /* Mark the given symbol as a global symbol, that is, as a symbol that is
 163  * either imported or exported.
 164  */
 165
 166 void SymConDes (SymEntry* Sym, unsigned char AddrSize, unsigned Type, unsigned Prio);
 167 /* Mark the given symbol as a module constructor/destructor. This will also
 168  * mark the symbol as an export. Initializers may never be zero page symbols.
 169  */
 170
 171 #if defined(HAVE_INLINE)
 172 INLINE int SymIsDef (const SymEntry* S)
 173 /* Return true if the given symbol is already defined */
 174 {
 175     return (S->Flags & SF_DEFINED) != 0;
 176 }
 177 #else
 178 #  define SymIsDef(S)   (((S)->Flags & SF_DEFINED) != 0)
 179 #endif
 180
 181 #if defined(HAVE_INLINE)
 182 INLINE int SymIsRef (const SymEntry* S)
 183 /* Return true if the given symbol has been referenced */
 184 {
 185     return (S->Flags & SF_REFERENCED) != 0;
 186 }
 187 #else
 188 #  define SymIsRef(S)   (((S)->Flags & SF_REFERENCED) != 0)
 189 #endif
 190
 191 #if defined(HAVE_INLINE)
 192 INLINE int SymIsImport (const SymEntry* S)
 193 /* Return true if the given symbol is marked as import */
 194 {
 195     /* Check the import flag */
 196     return (S->Flags & SF_IMPORT) != 0;
 197 }
 198 #else
 199 #  define SymIsImport(S)  (((S)->Flags & SF_IMPORT) != 0)
 200 #endif
 201
 202 int SymIsConst (SymEntry* Sym, long* Val);
 203 /* Return true if the given symbol has a constant value. If Val is not NULL
 204  * and the symbol has a constant value, store it's value there.
 205  */
 206
 207 #if defined(HAVE_INLINE)
 208 INLINE int SymHasExpr (const SymEntry* S)
 209 /* Return true if the given symbol has an associated expression */
 210 {
 211     /* Check the expression */
 212     return ((S->Flags & (SF_DEFINED|SF_IMPORT)) == SF_DEFINED);
 213 }
 214 #else
 215 #  define SymHasExpr(S)   (((S)->Flags & (SF_DEFINED|SF_IMPORT)) != SF_DEFINED)
 216 #endif
 217
 218 #if defined(HAVE_INLINE)
 219 INLINE void SymMarkUser (SymEntry* S)
 220 /* Set a user mark on the specified symbol */
 221 {
 222     /* Set the bit */
 223     S->Flags |= SF_USER;
 224 }
 225 #else
 226 #  define SymMarkUser(S)   ((S)->Flags |= SF_USER)
 227 #endif
 228
 229 #if defined(HAVE_INLINE)
 230 INLINE void SymUnmarkUser (SymEntry* S)
 231 /* Remove a user mark from the specified symbol */
 232 {
 233     /* Reset the bit */
 234     S->Flags &= ~SF_USER;
 235 }
 236 #else
 237 #  define SymUnmarkUser(S)   ((S)->Flags &= ~SF_USER)
 238 #endif
 239
 240 #if defined(HAVE_INLINE)
 241 INLINE int SymHasUserMark (SymEntry* S)
 242 /* Return the state of the user mark for the specified symbol */
 243 {
 244     /* Check the bit */
 245     return (S->Flags & SF_USER) != 0;
 246 }
 247 #else
 248 #  define SymHasUserMark(S) (((S)->Flags & SF_USER) != 0)
 249 #endif
 250
 251 struct ExprNode* GetSymExpr (SymEntry* Sym);
 252 /* Get the expression for a non-const symbol */
 253
 254 const struct ExprNode* SymResolve (const SymEntry* Sym);
 255 /* Helper function for DumpExpr. Resolves a symbol into an expression or return
 256  * NULL. Do not call in other contexts!
 257  */
 258
 259 #if defined(HAVE_INLINE)
 260 INLINE const char* GetSymName (const SymEntry* S)
 261 /* Return the name of the symbol */
 262 {
 263     return GetString (S->Name);
 264 }
 265 #else
 266 #  define GetSymName(S)   GetString ((S)->Name)
 267 #endif
 268
 269 #if defined(HAVE_INLINE)
 270 INLINE unsigned char GetSymAddrSize (const SymEntry* S)
 271 /* Return the address size of the symbol. Beware: This function will just
 272  * return the AddrSize member, it will not look at the expression!
 273  */
 274 {
 275     return S->AddrSize;
 276 }
 277 #else
 278 #  define GetSymAddrSize(S)   ((S)->AddrSize)
 279 #endif
 280
 281 long GetSymVal (SymEntry* Sym);
 282 /* Return the value of a symbol assuming it's constant. FAIL will be called
 283  * in case the symbol is undefined or not constant.
 284  */
 285
 286 unsigned GetSymIndex (const SymEntry* Sym);
 287 /* Return the symbol index for the given symbol */
 288
 289 #if defined(HAVE_INLINE)
 290 INLINE const FilePos* GetSymPos (const SymEntry* S)
 291 /* Return the position of first occurence in the source for the given symbol */
 292 {
 293     return &S->Pos;
 294 }
 295 #else
 296 #  define GetSymPos(S)   (&(S)->Pos)
 297 #endif
 298
 299
 300
 301 /* End of symentry.h */
 302
 303 #endif
 304
 305
 306