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

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                symentry.h                                 */
   4 /*                                                                           */
   5 /*               Symbol table entries for the cc65 C compiler                */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2013, Ullrich von Bassewitz                                      */
  10 /*                Roemerstrasse 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 #include <stdio.h>
  42
  43 /* common */
  44 #include "coll.h"
  45 #include "inline.h"
  46
  47 /* cc65 */
  48 #include "datatype.h"
  49 #include "declattr.h"
  50
  51
  52
  53 /*****************************************************************************/
  54 /*                                  Forwards                                 */
  55 /*****************************************************************************/
  56
  57
  58
  59 struct Segments;
  60 struct LiteralPool;
  61
  62
  63
  64 /*****************************************************************************/
  65 /*                              struct SymEntry                              */
  66 /*****************************************************************************/
  67
  68
  69
  70 /* Storage classes and flags */
  71 #define SC_AUTO         0x0001U         /* Auto variable */
  72 #define SC_REGISTER     0x0002U         /* Register variable */
  73 #define SC_STATIC       0x0004U         /* Static */
  74 #define SC_EXTERN       0x0008U         /* Extern linkage */
  75
  76 #define SC_ENUM         0x0030U         /* An enum */
  77 #define SC_CONST        0x0020U         /* A numeric constant with a type */
  78 #define SC_LABEL        0x0040U         /* A goto label */
  79 #define SC_PARAM        0x0080U         /* A function parameter */
  80 #define SC_FUNC         0x0100U         /* A function */
  81
  82 #define SC_DEFTYPE      0x0200U         /* Parameter has default type (=int, old style) */
  83 #define SC_STORAGE      0x0400U         /* Symbol with associated storage */
  84 #define SC_DEFAULT      0x0800U         /* Flag: default storage class was used */
  85
  86 #define SC_DEF          0x1000U         /* Symbol is defined */
  87 #define SC_REF          0x2000U         /* Symbol is referenced */
  88
  89 #define SC_TYPE         0x4000U         /* This is a type, struct, typedef, etc. */
  90 #define SC_STRUCT       0x4001U         /* Struct */
  91 #define SC_UNION        0x4002U         /* Union */
  92 #define SC_STRUCTFIELD  0x4003U         /* Struct or union field */
  93 #define SC_BITFIELD     0x4004U         /* A bit-field inside a struct or union */
  94 #define SC_TYPEDEF      0x4005U         /* A typedef */
  95 #define SC_TYPEMASK     0x400FU         /* Mask for above types */
  96
  97 #define SC_ZEROPAGE     0x8000U         /* Symbol marked as zeropage */
  98
  99 #define SC_HAVEATTR     0x10000U        /* Symbol has attributes */
 100
 101
 102
 103 /* Symbol table entry */
 104 typedef struct SymEntry SymEntry;
 105 struct SymEntry {
 106     SymEntry*                   NextHash; /* Next entry in hash list */
 107     SymEntry*                   PrevSym;  /* Previous symbol in dl list */
 108     SymEntry*                   NextSym;  /* Next symbol double linked list */
 109     SymEntry*                   Link;     /* General purpose single linked list */
 110     struct SymTable*            Owner;    /* Symbol table the symbol is in */
 111     unsigned                    Flags;    /* Symbol flags */
 112     Type*                       Type;     /* Symbol type */
 113     Collection*                 Attr;     /* Attribute list if any */
 114     char*                       AsmName;  /* Assembler name if any */
 115
 116     /* Data that differs for the different symbol types */
 117     union {
 118
 119         /* Offset for locals or struct members */
 120         int                     Offs;
 121
 122         /* Label name for static symbols */
 123         unsigned                Label;
 124
 125         /* Register bank offset and offset of the saved copy on stack for
 126          * register variables.
 127          */
 128         struct {
 129             int                 RegOffs;
 130             int                 SaveOffs;
 131         } R;
 132
 133         /* Value for constants (including enums) */
 134         long                    ConstVal;
 135
 136         /* Data for structs/unions */
 137         struct {
 138             struct SymTable*    SymTab;   /* Member symbol table */
 139             unsigned            Size;     /* Size of the union/struct */
 140         } S;
 141
 142         /* Data for bit fields */
 143         struct {
 144             unsigned            Offs;     /* Byte offset into struct */
 145             unsigned            BitOffs;  /* Bit offset into storage unit */
 146             unsigned            BitWidth; /* Width in bits */
 147         } B;
 148
 149         /* Data for functions */
 150         struct {
 151             struct FuncDesc*    Func;     /* Function descriptor */
 152             struct Segments*    Seg;      /* Segments for this function */
 153             struct LiteralPool* LitPool;  /* Literal pool for this function */
 154         } F;
 155
 156     } V;
 157     char                       Name[1]; /* Name, dynamically allocated */
 158 };
 159
 160
 161
 162 /*****************************************************************************/
 163 /*                                   Code                                    */
 164 /*****************************************************************************/
 165
 166
 167
 168 SymEntry* NewSymEntry (const char* Name, unsigned Flags);
 169 /* Create a new symbol table with the given name */
 170
 171 void FreeSymEntry (SymEntry* E);
 172 /* Free a symbol entry */
 173
 174 void DumpSymEntry (FILE* F, const SymEntry* E);
 175 /* Dump the given symbol table entry to the file in readable form */
 176
 177 #if defined(HAVE_INLINE)
 178 INLINE int SymIsBitField (const SymEntry* Sym)
 179 /* Return true if the given entry is a bit-field entry */
 180 {
 181     return ((Sym->Flags & SC_BITFIELD) == SC_BITFIELD);
 182 }
 183 #else
 184 #  define SymIsBitField(Sym)    (((Sym)->Flags & SC_BITFIELD) == SC_BITFIELD)
 185 #endif
 186
 187 #if defined(HAVE_INLINE)
 188 INLINE int SymIsTypeDef (const SymEntry* Sym)
 189 /* Return true if the given entry is a typedef entry */
 190 {
 191     return ((Sym->Flags & SC_TYPEDEF) == SC_TYPEDEF);
 192 }
 193 #else
 194 #  define SymIsTypeDef(Sym)     (((Sym)->Flags & SC_TYPEDEF) == SC_TYPEDEF)
 195 #endif
 196
 197 #if defined(HAVE_INLINE)
 198 INLINE int SymIsDef (const SymEntry* Sym)
 199 /* Return true if the given entry is defined */
 200 {
 201     return ((Sym->Flags & SC_DEF) == SC_DEF);
 202 }
 203 #else
 204 #  define SymIsDef(Sym)     (((Sym)->Flags & SC_DEF) == SC_DEF)
 205 #endif
 206
 207 #if defined(HAVE_INLINE)
 208 INLINE int SymIsRef (const SymEntry* Sym)
 209 /* Return true if the given entry is referenced */
 210 {
 211     return ((Sym->Flags & SC_REF) == SC_REF);
 212 }
 213 #else
 214 #  define SymIsRef(Sym)     (((Sym)->Flags & SC_REF) == SC_REF)
 215 #endif
 216
 217 #if defined(HAVE_INLINE)
 218 INLINE int SymIsRegVar (const SymEntry* Sym)
 219 /* Return true if the given entry is a register variable */
 220 /* ### HACK! Fix the ugly type flags! */
 221 {
 222     return ((Sym->Flags & (SC_REGISTER|SC_TYPE)) == SC_REGISTER);
 223 }
 224 #else
 225 #  define SymIsRegVar(Sym)      (((Sym)->Flags & (SC_REGISTER|SC_TYPE)) == SC_REGISTER)
 226 #endif
 227
 228 int SymIsOutputFunc (const SymEntry* Sym);
 229 /* Return true if this is a function that must be output */
 230
 231 #if defined(HAVE_INLINE)
 232 INLINE const char* SymGetAsmName (const SymEntry* Sym)
 233 /* Return the assembler label name for the symbol (beware: may be NULL!) */
 234 {
 235     return Sym->AsmName;
 236 }
 237 #else
 238 #  define SymGetAsmName(Sym)      ((Sym)->AsmName)
 239 #endif
 240
 241 const DeclAttr* SymGetAttr (const SymEntry* Sym, DeclAttrType AttrType);
 242 /* Return an attribute for this symbol or NULL if the attribute does not exist */
 243
 244 #if defined(HAVE_INLINE)
 245 INLINE int SymHasAttr (const SymEntry* Sym, DeclAttrType A)
 246 /* Return true if the symbol has the given attribute */
 247 {
 248     return (SymGetAttr (Sym, A) != 0);
 249 }
 250 #else
 251 #  define SymHasAttr(Sym, A)       (SymGetAttr (Sym, A) != 0)
 252 #endif
 253
 254 void SymUseAttr (SymEntry* Sym, struct Declaration* D);
 255 /* Use the attributes from the declaration for this symbol */
 256
 257 void SymSetAsmName (SymEntry* Sym);
 258 /* Set the assembler name for an external symbol from the name of the symbol */
 259
 260 void CvtRegVarToAuto (SymEntry* Sym);
 261 /* Convert a register variable to an auto variable */
 262
 263 void ChangeSymType (SymEntry* Entry, Type* T);
 264 /* Change the type of the given symbol */
 265
 266 void ChangeAsmName (SymEntry* Entry, const char* NewAsmName);
 267 /* Change the assembler name of the symbol */
 268
 269 int HasAnonName (const SymEntry* Entry);
 270 /* Return true if the symbol entry has an anonymous name */
 271
 272
 273
 274 /* End of symentry.h */
 275
 276 #endif