mirror of
https://github.com/gbdev/rgbds.git
synced 2025-11-20 18:22:07 +00:00
120 lines
3.2 KiB
C
120 lines
3.2 KiB
C
/*
|
|
* This file is part of RGBDS.
|
|
*
|
|
* Copyright (c) 1997-2018, Carsten Sorensen and RGBDS contributors.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*/
|
|
|
|
#ifndef RGBDS_SYMBOL_H
|
|
#define RGBDS_SYMBOL_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stdint.h>
|
|
#include <string.h>
|
|
|
|
#include "types.h"
|
|
|
|
#define HASHSIZE (1 << 16)
|
|
#define MAXSYMLEN 256
|
|
|
|
enum SymbolType {
|
|
SYM_LABEL,
|
|
SYM_EQU,
|
|
SYM_SET,
|
|
SYM_MACRO,
|
|
SYM_EQUS,
|
|
SYM_REF // Forward reference to a label
|
|
};
|
|
|
|
struct sSymbol {
|
|
char tzName[MAXSYMLEN + 1];
|
|
enum SymbolType type;
|
|
bool isConstant; /* Whether the symbol's value is currently known */
|
|
bool isExported; /* Whether the symbol is to be exported */
|
|
bool isBuiltin; /* Whether the symbol is a built-in */
|
|
struct sSymbol *pScope;
|
|
struct sSymbol *pNext;
|
|
struct Section *pSection;
|
|
int32_t nValue;
|
|
uint32_t ulMacroSize;
|
|
char *pMacro;
|
|
int32_t (*Callback)(struct sSymbol const *self);
|
|
char tzFileName[_MAX_PATH + 1]; /* File where the symbol was defined. */
|
|
uint32_t nFileLine; /* Line where the symbol was defined. */
|
|
};
|
|
|
|
static inline bool sym_IsDefined(struct sSymbol const *sym)
|
|
{
|
|
return sym->type != SYM_REF;
|
|
}
|
|
|
|
static inline bool sym_IsConstant(struct sSymbol const *sym)
|
|
{
|
|
return sym->isConstant;
|
|
}
|
|
|
|
static inline bool sym_IsNumeric(struct sSymbol const *sym)
|
|
{
|
|
return sym->type == SYM_LABEL || sym->type == SYM_EQU
|
|
|| sym->type == SYM_SET;
|
|
}
|
|
|
|
static inline bool sym_IsLabel(struct sSymbol const *sym)
|
|
{
|
|
return sym->type == SYM_LABEL || sym->type == SYM_REF;
|
|
}
|
|
|
|
static inline bool sym_IsLocal(struct sSymbol const *sym)
|
|
{
|
|
return sym_IsLabel(sym) && strchr(sym->tzName, '.');
|
|
}
|
|
|
|
static inline bool sym_IsExported(struct sSymbol const *sym)
|
|
{
|
|
return sym->isExported;
|
|
}
|
|
|
|
/*
|
|
* Get a string equate's value
|
|
*/
|
|
static inline char *sym_GetStringValue(struct sSymbol const *sym)
|
|
{
|
|
return sym->pMacro;
|
|
}
|
|
|
|
int32_t sym_GetValue(struct sSymbol const *sym);
|
|
uint32_t sym_CalcHash(const char *s);
|
|
void sym_SetExportAll(bool set);
|
|
struct sSymbol *sym_AddLocalReloc(char const *tzSym);
|
|
struct sSymbol *sym_AddReloc(char const *tzSym);
|
|
void sym_Export(char const *tzSym);
|
|
void sym_PrintSymbolTable(void);
|
|
struct sSymbol *sym_FindMacro(char const *s);
|
|
void sym_InitNewMacroArgs(void);
|
|
void sym_AddNewMacroArg(char const *s);
|
|
void sym_SaveCurrentMacroArgs(char *save[]);
|
|
void sym_RestoreCurrentMacroArgs(char *save[]);
|
|
void sym_UseNewMacroArgs(void);
|
|
struct sSymbol *sym_AddEqu(char const *tzSym, int32_t value);
|
|
struct sSymbol *sym_AddSet(char const *tzSym, int32_t value);
|
|
void sym_Init(void);
|
|
uint32_t sym_GetConstantValue(char const *s);
|
|
struct sSymbol *sym_FindSymbol(char const *tzName);
|
|
char *sym_FindMacroArg(int32_t i);
|
|
char *sym_GetStringValue(struct sSymbol const *sym);
|
|
void sym_UseCurrentMacroArgs(void);
|
|
void sym_SetMacroArgID(uint32_t nMacroCount);
|
|
struct sSymbol *sym_AddMacro(char const *tzSym, int32_t nDefLineNo);
|
|
void sym_Ref(char const *tzSym);
|
|
void sym_ShiftCurrentMacroArgs(void);
|
|
struct sSymbol *sym_AddString(char const *tzSym, char const *tzValue);
|
|
uint32_t sym_GetDefinedValue(char const *s);
|
|
void sym_Purge(char const *tzName);
|
|
|
|
/* Functions to save and restore the current symbol scope. */
|
|
struct sSymbol *sym_GetCurrentSymbolScope(void);
|
|
void sym_SetCurrentSymbolScope(struct sSymbol *pNewScope);
|
|
|
|
#endif /* RGBDS_SYMBOL_H */
|