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     struct ExprNode*        Expr;       /* Symbol expression */
  89     Collection              ExprRefs;   /* Expressions using this symbol */
  90     unsigned char           ExportSize; /* Export address size */
  91     unsigned char           AddrSize;   /* Address size of label */
  92     unsigned char           ConDesPrio[CD_TYPE_COUNT];  /* ConDes priorities... */
  93                                         /* ...actually value+1 (used as flag) */
  94     unsigned                Name;       /* Name index in global string pool */
  95 };
  96
  97 /* List of all symbol table entries */
  98 extern SymEntry* SymList;
  99
 100 /* Pointer to last defined symbol */
 101 extern SymEntry* SymLast;
 102
 103
 104
 105 /*****************************************************************************/
 106 /*                                   Code                                    */
 107 /*****************************************************************************/
 108
 109
 110
 111 SymEntry* NewSymEntry (const char* Name, unsigned Flags);
 112 /* Allocate a symbol table entry, initialize and return it */
 113
 114 int SymSearchTree (SymEntry* T, const char* Name, SymEntry** E);
 115 /* Search in the given tree for a name. If we find the symbol, the function
 116  * will return 0 and put the entry pointer into E. If we did not find the
 117  * symbol, and the tree is empty, E is set to NULL. If the tree is not empty,
 118  * E will be set to the last entry, and the result of the function is <0 if
 119  * the entry should be inserted on the left side, and >0 if it should get
 120  * inserted on the right side.
 121  */
 122
 123 #if defined(HAVE_INLINE)
 124 INLINE void SymAddExprRef (SymEntry* Sym, struct ExprNode* Expr)
 125 /* Add an expression reference to this symbol */
 126 {
 127     CollAppend (&Sym->ExprRefs, Expr);
 128 }
 129 #else
 130 #define SymAddExprRef(Sym,Expr)     CollAppend (&(Sym)->ExprRefs, Expr)
 131 #endif
 132
 133 #if defined(HAVE_INLINE)
 134 INLINE void SymDelExprRef (SymEntry* Sym, struct ExprNode* Expr)
 135 /* Delete an expression reference to this symbol */
 136 {
 137     CollDeleteItem (&Sym->ExprRefs, Expr);
 138 }
 139 #else
 140 #define SymDelExprRef(Sym,Expr)     CollDeleteItem (&(Sym)->ExprRefs, Expr)
 141 #endif
 142
 143 void SymTransferExprRefs (SymEntry* From, SymEntry* To);
 144 /* Transfer all expression references from one symbol to another. */
 145
 146 void SymDef (SymEntry* Sym, ExprNode* Expr, unsigned char AddrSize, unsigned Flags);
 147 /* Mark a symbol as defined */
 148
 149 void SymRef (SymEntry* Sym);
 150 /* Mark the given symbol as referenced */
 151
 152 void SymImport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 153 /* Mark the given symbol as an imported symbol */
 154
 155 void SymExport (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 156 /* Mark the given symbol as an exported symbol */
 157
 158 void SymGlobal (SymEntry* Sym, unsigned char AddrSize, unsigned Flags);
 159 /* Mark the given symbol as a global symbol, that is, as a symbol that is
 160  * either imported or exported.
 161  */
 162
 163 void SymConDes (SymEntry* Sym, unsigned char AddrSize, unsigned Type, unsigned Prio);
 164 /* Mark the given symbol as a module constructor/destructor. This will also
 165  * mark the symbol as an export. Initializers may never be zero page symbols.
 166  */
 167
 168 #if defined(HAVE_INLINE)
 169 INLINE int SymIsDef (const SymEntry* S)
 170 /* Return true if the given symbol is already defined */
 171 {
 172     return (S->Flags & SF_DEFINED) != 0;
 173 }
 174 #else
 175 #  define SymIsDef(S)   (((S)->Flags & SF_DEFINED) != 0)
 176 #endif
 177
 178 #if defined(HAVE_INLINE)
 179 INLINE int SymIsRef (const SymEntry* S)
 180 /* Return true if the given symbol has been referenced */
 181 {
 182     return (S->Flags & SF_REFERENCED) != 0;
 183 }
 184 #else
 185 #  define SymIsRef(S)   (((S)->Flags & SF_REFERENCED) != 0)
 186 #endif
 187
 188 #if defined(HAVE_INLINE)
 189 INLINE int SymIsImport (const SymEntry* S)
 190 /* Return true if the given symbol is marked as import */
 191 {
 192     /* Check the import flag */
 193     return (S->Flags & SF_IMPORT) != 0;
 194 }
 195 #else
 196 #  define SymIsImport(S)  (((S)->Flags & SF_IMPORT) != 0)
 197 #endif
 198
 199 int SymIsConst (SymEntry* Sym, long* Val);
 200 /* Return true if the given symbol has a constant value. If Val is not NULL
 201  * and the symbol has a constant value, store it's value there.
 202  */
 203
 204 #if defined(HAVE_INLINE)
 205 INLINE int SymHasExpr (const SymEntry* S)
 206 /* Return true if the given symbol has an associated expression */
 207 {
 208     /* Check the expression */
 209     return ((S->Flags & (SF_DEFINED|SF_IMPORT)) == SF_DEFINED);
 210 }
 211 #else
 212 #  define SymHasExpr(S)   (((S)->Flags & (SF_DEFINED|SF_IMPORT)) == SF_DEFINED)
 213 #endif
 214
 215 #if defined(HAVE_INLINE)
 216 INLINE void SymMarkUser (SymEntry* S)
 217 /* Set a user mark on the specified symbol */
 218 {
 219     /* Set the bit */
 220     S->Flags |= SF_USER;
 221 }
 222 #else
 223 #  define SymMarkUser(S)   ((S)->Flags |= SF_USER)
 224 #endif
 225
 226 #if defined(HAVE_INLINE)
 227 INLINE void SymUnmarkUser (SymEntry* S)
 228 /* Remove a user mark from the specified symbol */
 229 {
 230     /* Reset the bit */
 231     S->Flags &= ~SF_USER;
 232 }
 233 #else
 234 #  define SymUnmarkUser(S)   ((S)->Flags &= ~SF_USER)
 235 #endif
 236
 237 #if defined(HAVE_INLINE)
 238 INLINE int SymHasUserMark (SymEntry* S)
 239 /* Return the state of the user mark for the specified symbol */
 240 {
 241     /* Check the bit */
 242     return (S->Flags & SF_USER) != 0;
 243 }
 244 #else
 245 #  define SymHasUserMark(S) (((S)->Flags & SF_USER) != 0)
 246 #endif
 247
 248 struct SymTable* GetSymParentScope (SymEntry* S);
 249 /* Get the parent scope of the symbol (not the one it is defined in). Return
 250  * NULL if the symbol is a cheap local, or defined on global level.
 251  */
 252
 253 struct ExprNode* GetSymExpr (SymEntry* Sym);
 254 /* Get the expression for a non-const symbol */
 255
 256 const struct ExprNode* SymResolve (const SymEntry* Sym);
 257 /* Helper function for DumpExpr. Resolves a symbol into an expression or return
 258  * NULL. Do not call in other contexts!
 259  */
 260
 261 #if defined(HAVE_INLINE)
 262 INLINE const char* GetSymName (const SymEntry* S)
 263 /* Return the name of the symbol */
 264 {
 265     return GetString (S->Name);
 266 }
 267 #else
 268 #  define GetSymName(S)   GetString ((S)->Name)
 269 #endif
 270
 271 #if defined(HAVE_INLINE)
 272 INLINE unsigned char GetSymAddrSize (const SymEntry* S)
 273 /* Return the address size of the symbol. Beware: This function will just
 274  * return the AddrSize member, it will not look at the expression!
 275  */
 276 {
 277     return S->AddrSize;
 278 }
 279 #else
 280 #  define GetSymAddrSize(S)   ((S)->AddrSize)
 281 #endif
 282
 283 long GetSymVal (SymEntry* Sym);
 284 /* Return the value of a symbol assuming it's constant. FAIL will be called
 285  * in case the symbol is undefined or not constant.
 286  */
 287
 288 unsigned GetSymIndex (const SymEntry* Sym);
 289 /* Return the symbol index for the given symbol */
 290
 291 #if defined(HAVE_INLINE)
 292 INLINE const FilePos* GetSymPos (const SymEntry* S)
 293 /* Return the position of first occurence in the source for the given symbol */
 294 {
 295     return &S->Pos;
 296 }
 297 #else
 298 #  define GetSymPos(S)   (&(S)->Pos)
 299 #endif
 300
 301
 302
 303 /* End of symentry.h */
 304
 305 #endif
 306
 307
 308