/*****************************************************************************/
/* */
-/* symentry.h */
+/* symentry.h */
/* */
-/* Symbol table entry forward for the ca65 macroassembler */
+/* Symbol table entry forward for the ca65 macroassembler */
/* */
/* */
/* */
-/* (C) 1998-2003 Ullrich von Bassewitz */
-/* Römerstraße 52 */
-/* D-70794 Filderstadt */
-/* EMail: uz@cc65.org */
+/* (C) 1998-2012, Ullrich von Bassewitz */
+/* Roemerstrasse 52 */
+/* D-70794 Filderstadt */
+/* EMail: uz@cc65.org */
/* */
/* */
/* This software is provided 'as-is', without any expressed or implied */
#include "coll.h"
#include "filepos.h"
#include "inline.h"
+#include "strbuf.h"
/* ca65 */
#include "spool.h"
/*****************************************************************************/
-/* Data */
+/* Data */
/*****************************************************************************/
+/* Forwards */
+struct HLLDbgSym;
+
/* Bits for the Flags value in SymEntry */
#define SF_NONE 0x0000 /* Empty flag set */
-#define SF_USER 0x0001 /* User bit */
-#define SF_UNUSED 0x0002 /* Unused entry */
-#define SF_EXPORT 0x0004 /* Export this symbol */
-#define SF_IMPORT 0x0008 /* Import this symbol */
-#define SF_GLOBAL 0x0010 /* Global symbol */
+#define SF_USER 0x0001 /* User bit */
+#define SF_UNUSED 0x0002 /* Unused entry */
+#define SF_EXPORT 0x0004 /* Export this symbol */
+#define SF_IMPORT 0x0008 /* Import this symbol */
+#define SF_GLOBAL 0x0010 /* Global symbol */
#define SF_LOCAL 0x0020 /* Cheap local symbol */
-#define SF_LABEL 0x0080 /* Used as a label */
+#define SF_LABEL 0x0040 /* Used as a label */
+#define SF_VAR 0x0080 /* Variable symbol */
#define SF_FORCED 0x0100 /* Forced import, SF_IMPORT also set */
-#define SF_INDEXED 0x0800 /* Index is valid */
-#define SF_MULTDEF 0x2000 /* Multiply defined symbol */
-#define SF_DEFINED 0x4000 /* Defined */
-#define SF_REFERENCED 0x8000 /* Referenced */
+#define SF_FIXED 0x0200 /* May not be trampoline */
+#define SF_MULTDEF 0x1000 /* Multiply defined symbol */
+#define SF_DEFINED 0x2000 /* Defined */
+#define SF_REFERENCED 0x4000 /* Referenced */
-/* Arguments for SymFind... */
-#define SYM_FIND_EXISTING 0
-#define SYM_ALLOC_NEW 1
+/* Combined values */
+#define SF_REFIMP (SF_REFERENCED|SF_IMPORT) /* A ref'd import */
/* Structure of a symbol table entry */
typedef struct SymEntry SymEntry;
struct SymEntry {
- SymEntry* Left; /* Lexically smaller entry */
- SymEntry* Right; /* Lexically larger entry */
- SymEntry* List; /* List of all entries */
- SymEntry* Locals; /* Root of subtree for local symbols */
- struct SymTable* SymTab; /* Table this symbol is in, 0 for locals */
- FilePos Pos; /* File position for this symbol */
- unsigned Flags; /* Symbol flags */
- unsigned Index; /* Index of import/export entries */
- struct ExprNode* Expr; /* Symbol expression */
- Collection ExprRefs; /* Expressions using this symbol */
- unsigned char ExportSize; /* Export address size */
- unsigned char AddrSize; /* Address size of label */
- unsigned char ConDesPrio[CD_TYPE_COUNT]; /* ConDes priorities... */
- /* ...actually value+1 (used as flag) */
- unsigned Name; /* Name index in global string pool */
+ SymEntry* Left; /* Lexically smaller entry */
+ SymEntry* Right; /* Lexically larger entry */
+ SymEntry* List; /* List of all entries */
+ SymEntry* Locals; /* Root of subtree for local symbols */
+ union {
+ struct SymTable* Tab; /* Table this symbol is in */
+ struct SymEntry* Entry; /* Parent for cheap locals */
+ } Sym;
+ Collection DefLines; /* Line infos for definition */
+ Collection RefLines; /* Line infos for references */
+ FilePos* GuessedUse[1]; /* File position where symbol
+ * address size was guessed, and the
+ * smallest possible addressing was NOT
+ * used. Currently only for zero page
+ * addressing
+ */
+ struct HLLDbgSym* HLLSym; /* Symbol from high level language */
+ unsigned Flags; /* Symbol flags */
+ unsigned DebugSymId; /* Debug symbol id */
+ unsigned ImportId; /* Id of import if this is one */
+ unsigned ExportId; /* Id of export if this is one */
+ struct ExprNode* Expr; /* Symbol expression */
+ Collection ExprRefs; /* Expressions using this symbol */
+ unsigned char ExportSize; /* Export address size */
+ unsigned char AddrSize; /* Address size of label */
+ unsigned char ConDesPrio[CD_TYPE_COUNT]; /* ConDes priorities... */
+ /* ...actually value+1 (used as flag) */
+ unsigned Name; /* Name index in global string pool */
};
/* List of all symbol table entries */
/*****************************************************************************/
-/* Code */
+/* Code */
/*****************************************************************************/
-SymEntry* NewSymEntry (const char* Name, unsigned Flags);
+SymEntry* NewSymEntry (const StrBuf* Name, unsigned Flags);
/* Allocate a symbol table entry, initialize and return it */
-int SymSearchTree (SymEntry* T, const char* Name, SymEntry** E);
+int SymSearchTree (SymEntry* T, const StrBuf* Name, SymEntry** E);
/* Search in the given tree for a name. If we find the symbol, the function
* will return 0 and put the entry pointer into E. If we did not find the
* symbol, and the tree is empty, E is set to NULL. If the tree is not empty,
* mark the symbol as an export. Initializers may never be zero page symbols.
*/
+void SymGuessedAddrSize (SymEntry* Sym, unsigned char AddrSize);
+/* Mark the address size of the given symbol as guessed. The address size
+ * passed as argument is the one NOT used, because the actual address size
+ * wasn't known. Example: Zero page addressing was not used because symbol
+ * is undefined, and absolute addressing was available.
+ */
+
+void SymExportFromGlobal (SymEntry* S);
+/* Called at the end of assembly. Converts a global symbol that is defined
+ * into an export.
+ */
+
+void SymImportFromGlobal (SymEntry* S);
+/* Called at the end of assembly. Converts a global symbol that is undefined
+ * into an import.
+ */
+
#if defined(HAVE_INLINE)
INLINE int SymIsDef (const SymEntry* S)
/* Return true if the given symbol is already defined */
# define SymIsImport(S) (((S)->Flags & SF_IMPORT) != 0)
#endif
-int SymIsConst (SymEntry* Sym, long* Val);
+#if defined(HAVE_INLINE)
+INLINE int SymIsExport (const SymEntry* S)
+/* Return true if the given symbol is marked as export */
+{
+ /* Check the export flag */
+ return (S->Flags & SF_EXPORT) != 0;
+}
+#else
+# define SymIsExport(S) (((S)->Flags & SF_EXPORT) != 0)
+#endif
+
+#if defined(HAVE_INLINE)
+INLINE int SymIsVar (const SymEntry* S)
+/* Return true if the given symbol is marked as variable */
+{
+ /* Check the variable flag */
+ return (S->Flags & SF_VAR) != 0;
+}
+#else
+# define SymIsVar(S) (((S)->Flags & SF_VAR) != 0)
+#endif
+
+int SymIsConst (const SymEntry* Sym, long* Val);
/* Return true if the given symbol has a constant value. If Val is not NULL
* and the symbol has a constant value, store it's value there.
*/
*/
#if defined(HAVE_INLINE)
-INLINE const char* GetSymName (const SymEntry* S)
+INLINE const StrBuf* GetSymName (const SymEntry* S)
/* Return the name of the symbol */
{
- return GetString (S->Name);
+ return GetStrBuf (S->Name);
}
#else
-# define GetSymName(S) GetString ((S)->Name)
+# define GetSymName(S) GetStrBuf ((S)->Name)
#endif
#if defined(HAVE_INLINE)
* in case the symbol is undefined or not constant.
*/
-unsigned GetSymIndex (const SymEntry* Sym);
-/* Return the symbol index for the given symbol */
+unsigned GetSymImportId (const SymEntry* Sym);
+/* Return the import id for the given symbol */
-#if defined(HAVE_INLINE)
-INLINE const FilePos* GetSymPos (const SymEntry* S)
-/* Return the position of first occurence in the source for the given symbol */
-{
- return &S->Pos;
-}
-#else
-# define GetSymPos(S) (&(S)->Pos)
-#endif
+unsigned GetSymExportId (const SymEntry* Sym);
+/* Return the export id for the given symbol */
+
+unsigned GetSymInfoFlags (const SymEntry* Sym, long* ConstVal);
+/* Return a set of flags used when writing symbol information into a file.
+ * If the SYM_CONST bit is set, ConstVal will contain the constant value
+ * of the symbol. The result does not include the condes count.
+ * See common/symdefs.h for more information.
+ */
/* End of symentry.h */
#endif
-
-
-