/*****************************************************************************/
/* */
-/* macro.c */
+/* macro.c */
/* */
-/* Macros for the ca65 macroassembler */
+/* Macros for the ca65 macroassembler */
/* */
/* */
/* */
-/* (C) 1998-2000 Ullrich von Bassewitz */
-/* Wacholderweg 14 */
-/* D-70597 Stuttgart */
-/* EMail: uz@musoftware.de */
+/* (C) 1998-2011, Ullrich von Bassewitz */
+/* Roemerstrasse 52 */
+/* D-70794 Filderstadt */
+/* EMail: uz@cc65.org */
/* */
/* */
/* This software is provided 'as-is', without any expressed or implied */
/* common */
#include "check.h"
-#include "hashstr.h"
+#include "hashfunc.h"
+#include "hashtab.h"
#include "xmalloc.h"
-
+
/* ca65 */
#include "condasm.h"
#include "error.h"
+#include "global.h"
+#include "instr.h"
#include "istack.h"
+#include "lineinfo.h"
#include "nexttok.h"
#include "pseudo.h"
#include "toklist.h"
/*****************************************************************************/
-/* Data */
+/* Forwards */
+/*****************************************************************************/
+
+
+
+static unsigned HT_GenHash (const void* Key);
+/* Generate the hash over a key. */
+
+static const void* HT_GetKey (const void* Entry);
+/* Given a pointer to the user entry data, return a pointer to the key */
+
+static int HT_Compare (const void* Key1, const void* Key2);
+/* Compare two keys. The function must return a value less than zero if
+ * Key1 is smaller than Key2, zero if both are equal, and a value greater
+ * than zero if Key1 is greater then Key2.
+ */
+
+
+
+/*****************************************************************************/
+/* Data */
/*****************************************************************************/
/* Struct that describes an identifer (macro param, local list) */
-typedef struct IdDesc_ IdDesc;
-struct IdDesc_ {
- IdDesc* Next; /* Linked list */
- char Id [1]; /* Identifier, dynamically allocated */
+typedef struct IdDesc IdDesc;
+struct IdDesc {
+ IdDesc* Next; /* Linked list */
+ StrBuf Id; /* Identifier, dynamically allocated */
};
/* Struct that describes a macro definition */
-typedef struct Macro_ Macro;
-struct Macro_ {
- Macro* Next; /* Next macro with same hash */
- Macro* List; /* List of all macros */
- unsigned LocalCount; /* Count of local symbols */
- IdDesc* Locals; /* List of local symbols */
- unsigned ParamCount; /* Parameter count of macro */
- IdDesc* Params; /* Identifiers of macro parameters */
- unsigned TokCount; /* Number of tokens for this macro */
- TokNode* TokRoot; /* Root of token list */
- TokNode* TokLast; /* Pointer to last token in list */
- unsigned char Style; /* Macro style */
- char Name [1]; /* Macro name, dynamically allocated */
+struct Macro {
+ HashNode Node; /* Hash list node */
+ Macro* List; /* List of all macros */
+ unsigned LocalCount; /* Count of local symbols */
+ IdDesc* Locals; /* List of local symbols */
+ unsigned ParamCount; /* Parameter count of macro */
+ IdDesc* Params; /* Identifiers of macro parameters */
+ unsigned TokCount; /* Number of tokens for this macro */
+ TokNode* TokRoot; /* Root of token list */
+ TokNode* TokLast; /* Pointer to last token in list */
+ StrBuf Name; /* Macro name, dynamically allocated */
+ unsigned Expansions; /* Number of active macro expansions */
+ unsigned char Style; /* Macro style */
+ unsigned char Incomplete; /* Macro is currently built */
};
-/* Macro hash table */
-#define HASHTAB_SIZE 117
-static Macro* MacroTab [HASHTAB_SIZE];
+/* Hash table functions */
+static const HashFunctions HashFunc = {
+ HT_GenHash,
+ HT_GetKey,
+ HT_Compare
+};
-/* Global macro data */
-static Macro* MacroRoot = 0; /* List of all macros */
+/* Macro hash table */
+static HashTable MacroTab = STATIC_HASHTABLE_INITIALIZER (117, &HashFunc);
/* Structs that holds data for a macro expansion */
-typedef struct MacExp_ MacExp;
-struct MacExp_ {
- MacExp* Next; /* Pointer to next expansion */
- Macro* M; /* Which macro do we expand? */
- unsigned IfSP; /* .IF stack pointer at start of expansion */
- TokNode* Exp; /* Pointer to current token */
- TokNode* Final; /* Pointer to final token */
- unsigned LocalStart; /* Start of counter for local symbol names */
- unsigned ParamCount; /* Number of actual parameters */
- TokNode** Params; /* List of actual parameters */
- TokNode* ParamExp; /* Node for expanding parameters */
+typedef struct MacExp MacExp;
+struct MacExp {
+ MacExp* Next; /* Pointer to next expansion */
+ Macro* M; /* Which macro do we expand? */
+ unsigned IfSP; /* .IF stack pointer at start of expansion */
+ TokNode* Exp; /* Pointer to current token */
+ TokNode* Final; /* Pointer to final token */
+ unsigned MacExpansions; /* Number of active macro expansions */
+ unsigned LocalStart; /* Start of counter for local symbol names */
+ unsigned ParamCount; /* Number of actual parameters */
+ TokNode** Params; /* List of actual parameters */
+ TokNode* ParamExp; /* Node for expanding parameters */
+ LineInfo* LI; /* Line info for the expansion */
+ LineInfo* ParamLI; /* Line info for parameter expansion */
};
+/* Maximum number of nested macro expansions */
+#define MAX_MACEXPANSIONS 256U
+
/* Number of active macro expansions */
static unsigned MacExpansions = 0;
/* Counter to create local names for symbols */
static unsigned LocalName = 0;
+/* Define style macros disabled if != 0 */
+static unsigned DisableDefines = 0;
+
/*****************************************************************************/
-/* Code */
+/* Hash table functions */
/*****************************************************************************/
-static IdDesc* NewIdDesc (const char* Id)
+static unsigned HT_GenHash (const void* Key)
+/* Generate the hash over a key. */
+{
+ return HashBuf (Key);
+}
+
+
+
+static const void* HT_GetKey (const void* Entry)
+/* Given a pointer to the user entry data, return a pointer to the index */
+{
+ return &((Macro*) Entry)->Name;
+}
+
+
+
+static int HT_Compare (const void* Key1, const void* Key2)
+/* Compare two keys. The function must return a value less than zero if
+ * Key1 is smaller than Key2, zero if both are equal, and a value greater
+ * than zero if Key1 is greater then Key2.
+ */
+{
+ return SB_Compare (Key1, Key2);
+}
+
+
+
+/*****************************************************************************/
+/* Code */
+/*****************************************************************************/
+
+
+
+static IdDesc* NewIdDesc (const StrBuf* Id)
/* Create a new IdDesc, initialize and return it */
{
/* Allocate memory */
- unsigned Len = strlen (Id);
- IdDesc* I = xmalloc (sizeof (IdDesc) + Len);
+ IdDesc* ID = xmalloc (sizeof (IdDesc));
/* Initialize the struct */
- I->Next = 0;
- memcpy (I->Id, Id, Len);
- I->Id [Len] = '\0';
+ ID->Next = 0;
+ SB_Init (&ID->Id);
+ SB_Copy (&ID->Id, Id);
/* Return the new struct */
- return I;
+ return ID;
+}
+
+
+
+static void FreeIdDesc (IdDesc* ID)
+/* Free an IdDesc */
+{
+ /* Free the name */
+ SB_Done (&ID->Id);
+
+ /* Free the structure itself */
+ xfree (ID);
+}
+
+
+
+static void FreeIdDescList (IdDesc* ID)
+/* Free a complete list of IdDesc structures */
+{
+ while (ID) {
+ IdDesc* This = ID;
+ ID = ID->Next;
+ FreeIdDesc (This);
+ }
}
-static Macro* NewMacro (const char* Name, unsigned HashVal, unsigned char Style)
+static Macro* NewMacro (const StrBuf* Name, unsigned char Style)
/* Generate a new macro entry, initialize and return it */
{
/* Allocate memory */
- unsigned Len = strlen (Name);
- Macro* M = xmalloc (sizeof (Macro) + Len);
+ Macro* M = xmalloc (sizeof (Macro));
/* Initialize the macro struct */
+ InitHashNode (&M->Node);
M->LocalCount = 0;
+ M->Locals = 0;
M->ParamCount = 0;
M->Params = 0;
- M->TokCount = 0;
+ M->TokCount = 0;
M->TokRoot = 0;
M->TokLast = 0;
- M->Style = Style;
- memcpy (M->Name, Name, Len);
- M->Name [Len] = '\0';
-
- /* Insert the macro into the global macro list */
- M->List = MacroRoot;
- MacroRoot = M;
+ SB_Init (&M->Name);
+ SB_Copy (&M->Name, Name);
+ M->Expansions = 0;
+ M->Style = Style;
+ M->Incomplete = 1;
/* Insert the macro into the hash table */
- M->Next = MacroTab [HashVal];
- MacroTab [HashVal] = M;
+ HT_Insert (&MacroTab, &M->Node);
/* Return the new macro struct */
return M;
+static void FreeMacro (Macro* M)
+/* Free a macro entry which has already been removed from the macro table. */
+{
+ TokNode* T;
+
+ /* Free locals */
+ FreeIdDescList (M->Locals);
+
+ /* Free identifiers of parameters */
+ FreeIdDescList (M->Params);
+
+ /* Free the token list for the macro */
+ while ((T = M->TokRoot) != 0) {
+ M->TokRoot = T->Next;
+ FreeTokNode (T);
+ }
+
+ /* Free the macro name */
+ SB_Done (&M->Name);
+
+ /* Free the macro structure itself */
+ xfree (M);
+}
+
+
+
static MacExp* NewMacExp (Macro* M)
/* Create a new expansion structure for the given macro */
{
MacExp* E = xmalloc (sizeof (MacExp));
/* Initialize the data */
- E->M = M;
- E->IfSP = GetIfStack ();
- E->Exp = M->TokRoot;
- E->Final = 0;
- E->LocalStart = LocalName;
- LocalName += M->LocalCount;
- E->ParamCount = 0;
- E->Params = xmalloc (M->ParamCount * sizeof (TokNode*));
- E->ParamExp = 0;
+ E->M = M;
+ E->IfSP = GetIfStack ();
+ E->Exp = M->TokRoot;
+ E->Final = 0;
+ E->MacExpansions = ++MacExpansions; /* One macro expansion more */
+ E->LocalStart = LocalName;
+ LocalName += M->LocalCount;
+ E->ParamCount = 0;
+ E->Params = xmalloc (M->ParamCount * sizeof (TokNode*));
for (I = 0; I < M->ParamCount; ++I) {
- E->Params [I] = 0;
+ E->Params[I] = 0;
}
+ E->ParamExp = 0;
+ E->LI = 0;
+ E->ParamLI = 0;
- /* One macro expansion more */
- ++MacExpansions;
+ /* Mark the macro as expanding */
+ ++M->Expansions;
/* Return the new macro expansion */
return E;
/* One macro expansion less */
--MacExpansions;
- /* Free the parameter list */
+ /* No longer expanding this macro */
+ --E->M->Expansions;
+
+ /* Free the parameter lists */
for (I = 0; I < E->ParamCount; ++I) {
- xfree (E->Params [I]);
+ /* Free one parameter list */
+ TokNode* N = E->Params[I];
+ while (N) {
+ TokNode* P = N->Next;
+ FreeTokNode (N);
+ N = P;
+ }
}
xfree (E->Params);
+ /* Free the additional line info */
+ if (E->ParamLI) {
+ EndLine (E->ParamLI);
+ }
+ if (E->LI) {
+ EndLine (E->LI);
+ }
+
/* Free the final token if we have one */
if (E->Final) {
- FreeTokNode (E->Final);
+ FreeTokNode (E->Final);
}
/* Free the structure itself */
/* Skip a macro definition */
{
if (Style == MAC_STYLE_CLASSIC) {
- /* Skip tokens until we reach the final .endmacro */
- while (Tok != TOK_ENDMACRO && Tok != TOK_EOF) {
- NextTok ();
- }
- if (Tok != TOK_EOF) {
- SkipUntilSep ();
- } else {
- Error (ERR_ENDMACRO_EXPECTED);
- }
+ /* Skip tokens until we reach the final .endmacro */
+ while (CurTok.Tok != TOK_ENDMACRO && CurTok.Tok != TOK_EOF) {
+ NextTok ();
+ }
+ if (CurTok.Tok != TOK_EOF) {
+ SkipUntilSep ();
+ } else {
+ Error ("`.ENDMACRO' expected");
+ }
} else {
- /* Skip until end of line */
- SkipUntilSep ();
+ /* Skip until end of line */
+ SkipUntilSep ();
}
}
-static Macro* MacFind (const char* Name, unsigned HashVal)
-/* Search for a macro in the hash table */
-{
- /* Search for the identifier */
- Macro* M = MacroTab [HashVal];
- while (M) {
- if (strcmp (Name, M->Name) == 0) {
- return M;
- }
- M = M->Next;
- }
- return 0;
-}
-
-
-
void MacDef (unsigned Style)
/* Parse a macro definition */
{
Macro* M;
- TokNode* T;
- unsigned HashVal;
+ TokNode* N;
int HaveParams;
/* We expect a macro name here */
- if (Tok != TOK_IDENT) {
- Error (ERR_IDENT_EXPECTED);
- MacSkipDef (Style);
- return;
+ if (CurTok.Tok != TOK_IDENT) {
+ Error ("Identifier expected");
+ MacSkipDef (Style);
+ return;
+ } else if (!UbiquitousIdents && FindInstruction (&CurTok.SVal) >= 0) {
+ /* The identifier is a name of a 6502 instruction, which is not
+ * allowed if not explicitly enabled.
+ */
+ Error ("Cannot use an instruction as macro name");
+ MacSkipDef (Style);
+ return;
}
- /* Generate the hash value */
- HashVal = HashStr (SVal) % HASHTAB_SIZE;
-
/* Did we already define that macro? */
- if (MacFind (SVal, HashVal) != 0) {
- /* Macro is already defined */
- Error (ERR_SYM_ALREADY_DEFINED, SVal);
- /* Skip tokens until we reach the final .endmacro */
- MacSkipDef (Style);
- return;
+ if (HT_Find (&MacroTab, &CurTok.SVal) != 0) {
+ /* Macro is already defined */
+ Error ("A macro named `%m%p' is already defined", &CurTok.SVal);
+ /* Skip tokens until we reach the final .endmacro */
+ MacSkipDef (Style);
+ return;
}
/* Define the macro */
- M = NewMacro (SVal, HashVal, Style);
+ M = NewMacro (&CurTok.SVal, Style);
/* Switch to raw token mode and skip the macro name */
EnterRawTokenMode ();
* otherwise we may have parameters without braces.
*/
if (Style == MAC_STYLE_CLASSIC) {
- HaveParams = 1;
+ HaveParams = 1;
} else {
- if (Tok == TOK_LPAREN) {
- HaveParams = 1;
- NextTok ();
- } else {
- HaveParams = 0;
- }
+ if (CurTok.Tok == TOK_LPAREN) {
+ HaveParams = 1;
+ NextTok ();
+ } else {
+ HaveParams = 0;
+ }
}
/* Parse the parameter list */
if (HaveParams) {
- while (Tok == TOK_IDENT) {
-
- /* Create a struct holding the identifier */
- IdDesc* I = NewIdDesc (SVal);
-
- /* Insert the struct into the list, checking for duplicate idents */
- if (M->ParamCount == 0) {
- M->Params = I;
- } else {
- IdDesc* List = M->Params;
- while (1) {
- if (strcmp (List->Id, SVal) == 0) {
- Error (ERR_SYM_ALREADY_DEFINED, SVal);
- }
- if (List->Next == 0) {
- break;
- } else {
- List = List->Next;
- }
- }
- List->Next = I;
- }
- ++M->ParamCount;
-
- /* Skip the name */
- NextTok ();
-
- /* Maybe there are more params... */
- if (Tok == TOK_COMMA) {
- NextTok ();
- } else {
- break;
- }
- }
+ while (CurTok.Tok == TOK_IDENT) {
+
+ /* Create a struct holding the identifier */
+ IdDesc* I = NewIdDesc (&CurTok.SVal);
+
+ /* Insert the struct into the list, checking for duplicate idents */
+ if (M->ParamCount == 0) {
+ M->Params = I;
+ } else {
+ IdDesc* List = M->Params;
+ while (1) {
+ if (SB_Compare (&List->Id, &CurTok.SVal) == 0) {
+ Error ("Duplicate symbol `%m%p'", &CurTok.SVal);
+ }
+ if (List->Next == 0) {
+ break;
+ } else {
+ List = List->Next;
+ }
+ }
+ List->Next = I;
+ }
+ ++M->ParamCount;
+
+ /* Skip the name */
+ NextTok ();
+
+ /* Maybe there are more params... */
+ if (CurTok.Tok == TOK_COMMA) {
+ NextTok ();
+ } else {
+ break;
+ }
+ }
}
/* For class macros, we expect a separator token, for define style macros,
* we expect the closing paren.
*/
if (Style == MAC_STYLE_CLASSIC) {
- ConsumeSep ();
+ ConsumeSep ();
} else if (HaveParams) {
- ConsumeRParen ();
+ ConsumeRParen ();
}
/* Preparse the macro body. We will read the tokens until we reach end of
*/
while (1) {
- /* Check for end of macro */
- if (Style == MAC_STYLE_CLASSIC) {
- /* In classic macros, only .endmacro is allowed */
- if (Tok == TOK_ENDMACRO) {
- /* Done */
- break;
- }
- /* May not have end of file in a macro definition */
- if (Tok == TOK_EOF) {
- Error (ERR_ENDMACRO_EXPECTED);
- goto Done;
- }
- } else {
- /* Accept a newline or end of file for new style macros */
- if (Tok == TOK_SEP || Tok == TOK_EOF) {
- break;
- }
- }
-
- /* Check for a .LOCAL declaration */
- if (Tok == TOK_LOCAL && Style == MAC_STYLE_CLASSIC) {
-
- while (1) {
-
- IdDesc* I;
-
- /* Skip .local or comma */
- NextTok ();
-
- /* Need an identifer */
- if (Tok != TOK_IDENT) {
- Error (ERR_IDENT_EXPECTED);
- SkipUntilSep ();
- break;
- }
-
- /* Put the identifier into the locals list and skip it */
- I = NewIdDesc (SVal);
- I->Next = M->Locals;
- M->Locals = I;
- ++M->LocalCount;
- NextTok ();
-
- /* Check for end of list */
- if (Tok != TOK_COMMA) {
- break;
- }
-
- }
-
- /* We need end of line after the locals */
- ConsumeSep ();
- continue;
- }
-
- /* Create a token node for the current token */
- T = NewTokNode ();
-
- /* If the token is an ident, check if it is a local parameter */
- if (Tok == TOK_IDENT) {
- unsigned Count = 0;
- IdDesc* I = M->Params;
- while (I) {
- if (strcmp (I->Id, SVal) == 0) {
- /* Local param name, replace it */
- T->Tok = TOK_MACPARAM;
- T->IVal = Count;
- break;
- }
- ++Count;
- I = I->Next;
- }
- }
-
- /* Insert the new token in the list */
- if (M->TokCount == 0) {
- /* First token */
- M->TokRoot = M->TokLast = T;
- } else {
- /* We have already tokens */
- M->TokLast->Next = T;
- M->TokLast = T;
- }
- ++M->TokCount;
-
- /* Read the next token */
- NextTok ();
+ /* Check for end of macro */
+ if (Style == MAC_STYLE_CLASSIC) {
+ /* In classic macros, only .endmacro is allowed */
+ if (CurTok.Tok == TOK_ENDMACRO) {
+ /* Done */
+ break;
+ }
+ /* May not have end of file in a macro definition */
+ if (CurTok.Tok == TOK_EOF) {
+ Error ("`.ENDMACRO' expected");
+ goto Done;
+ }
+ } else {
+ /* Accept a newline or end of file for new style macros */
+ if (TokIsSep (CurTok.Tok)) {
+ break;
+ }
+ }
+
+ /* Check for a .LOCAL declaration */
+ if (CurTok.Tok == TOK_LOCAL && Style == MAC_STYLE_CLASSIC) {
+
+ while (1) {
+
+ IdDesc* I;
+
+ /* Skip .local or comma */
+ NextTok ();
+
+ /* Need an identifer */
+ if (CurTok.Tok != TOK_IDENT && CurTok.Tok != TOK_LOCAL_IDENT) {
+ Error ("Identifier expected");
+ SkipUntilSep ();
+ break;
+ }
+
+ /* Put the identifier into the locals list and skip it */
+ I = NewIdDesc (&CurTok.SVal);
+ I->Next = M->Locals;
+ M->Locals = I;
+ ++M->LocalCount;
+ NextTok ();
+
+ /* Check for end of list */
+ if (CurTok.Tok != TOK_COMMA) {
+ break;
+ }
+
+ }
+
+ /* We need end of line after the locals */
+ ConsumeSep ();
+ continue;
+ }
+
+ /* Create a token node for the current token */
+ N = NewTokNode ();
+
+ /* If the token is an identifier, check if it is a local parameter */
+ if (CurTok.Tok == TOK_IDENT) {
+ unsigned Count = 0;
+ IdDesc* I = M->Params;
+ while (I) {
+ if (SB_Compare (&I->Id, &CurTok.SVal) == 0) {
+ /* Local param name, replace it */
+ N->T.Tok = TOK_MACPARAM;
+ N->T.IVal = Count;
+ break;
+ }
+ ++Count;
+ I = I->Next;
+ }
+ }
+
+ /* Insert the new token in the list */
+ if (M->TokCount == 0) {
+ /* First token */
+ M->TokRoot = M->TokLast = N;
+ } else {
+ /* We have already tokens */
+ M->TokLast->Next = N;
+ M->TokLast = N;
+ }
+ ++M->TokCount;
+
+ /* Read the next token */
+ NextTok ();
}
/* Skip the .endmacro for a classic macro */
if (Style == MAC_STYLE_CLASSIC) {
- NextTok ();
+ NextTok ();
}
+ /* Reset the Incomplete flag now that parsing is done */
+ M->Incomplete = 0;
+
Done:
/* Switch out of raw token mode */
LeaveRawTokenMode ();
+void MacUndef (const StrBuf* Name, unsigned char Style)
+/* Undefine the macro with the given name and style. A style mismatch is
+ * treated as if the macro didn't exist.
+ */
+{
+ /* Search for the macro */
+ Macro* M = HT_Find (&MacroTab, Name);
+
+ /* Don't let the user kid with us */
+ if (M == 0 || M->Style != Style) {
+ Error ("No such macro: %m%p", Name);
+ return;
+ }
+ if (M->Expansions > 0) {
+ Error ("Cannot delete a macro that is currently expanded");
+ return;
+ }
+
+ /* Remove the macro from the macro table */
+ HT_Remove (&MacroTab, M);
+
+ /* Free the macro structure */
+ FreeMacro (M);
+}
+
+
+
static int MacExpand (void* Data)
/* If we're currently expanding a macro, set the the scanner token and
* attribute to the next value and return true. If we are not expanding
/* Check if we should abort this macro */
if (DoMacAbort) {
- /* Reset the flag */
- DoMacAbort = 0;
+ /* Reset the flag */
+ DoMacAbort = 0;
- /* Abort any open .IF statements in this macro expansion */
- CleanupIfStack (Mac->IfSP);
+ /* Abort any open .IF statements in this macro expansion */
+ CleanupIfStack (Mac->IfSP);
- /* Terminate macro expansion */
- goto MacEnd;
+ /* Terminate macro expansion */
+ goto MacEnd;
}
/* We're expanding a macro. Check if we are expanding one of the
* macro parameters.
*/
+ExpandParam:
if (Mac->ParamExp) {
- /* Ok, use token from parameter list */
- TokSet (Mac->ParamExp);
+ /* Ok, use token from parameter list */
+ TokSet (Mac->ParamExp);
+
+ /* Create new line info for this parameter token */
+ if (Mac->ParamLI) {
+ EndLine (Mac->ParamLI);
+ }
+ Mac->ParamLI = StartLine (&CurTok.Pos, LI_TYPE_MACPARAM, Mac->MacExpansions);
+
+ /* Set pointer to next token */
+ Mac->ParamExp = Mac->ParamExp->Next;
+
+ /* Done */
+ return 1;
- /* Set pointer to next token */
- Mac->ParamExp = Mac->ParamExp->Next;
+ } else if (Mac->ParamLI) {
- /* Done */
- return 1;
+ /* There's still line info open from the parameter expansion - end it */
+ EndLine (Mac->ParamLI);
+ Mac->ParamLI = 0;
}
*/
if (Mac->Exp) {
- /* Use next macro token */
- TokSet (Mac->Exp);
-
- /* Set pointer to next token */
- Mac->Exp = Mac->Exp->Next;
-
- /* Is it a request for actual parameter count? */
- if (Tok == TOK_PARAMCOUNT) {
- Tok = TOK_INTCON;
- IVal = Mac->ParamCount;
- return 1;
- }
-
- /* Is it the name of a macro parameter? */
- if (Tok == TOK_MACPARAM) {
-
- /* Start to expand the parameter token list */
- Mac->ParamExp = Mac->Params [IVal];
-
- /* Recursive call to expand the parameter */
- return MacExpand (Mac);
- }
-
- /* If it's an identifier, it may in fact be a local symbol */
- if (Tok == TOK_IDENT && Mac->M->LocalCount) {
- /* Search for the local symbol in the list */
- unsigned Index = 0;
- IdDesc* I = Mac->M->Locals;
- while (I) {
- if (strcmp (SVal, I->Id) == 0) {
- /* This is in fact a local symbol, change the name */
- sprintf (SVal, "___%04X__", Mac->LocalStart + Index);
- break;
- }
- /* Next symbol */
- ++Index;
- I = I->Next;
- }
-
- /* Done */
- return 1;
- }
-
- /* The token was successfully set */
- return 1;
-
+ /* Use next macro token */
+ TokSet (Mac->Exp);
+
+ /* Create new line info for this token */
+ if (Mac->LI) {
+ EndLine (Mac->LI);
+ }
+ Mac->LI = StartLine (&CurTok.Pos, LI_TYPE_MACRO, Mac->MacExpansions);
+
+ /* Set pointer to next token */
+ Mac->Exp = Mac->Exp->Next;
+
+ /* Is it a request for actual parameter count? */
+ if (CurTok.Tok == TOK_PARAMCOUNT) {
+ CurTok.Tok = TOK_INTCON;
+ CurTok.IVal = Mac->ParamCount;
+ return 1;
+ }
+
+ /* Is it the name of a macro parameter? */
+ if (CurTok.Tok == TOK_MACPARAM) {
+
+ /* Start to expand the parameter token list */
+ Mac->ParamExp = Mac->Params[CurTok.IVal];
+
+ /* Go back and expand the parameter */
+ goto ExpandParam;
+ }
+
+ /* If it's an identifier, it may in fact be a local symbol */
+ if ((CurTok.Tok == TOK_IDENT || CurTok.Tok == TOK_LOCAL_IDENT) &&
+ Mac->M->LocalCount) {
+ /* Search for the local symbol in the list */
+ unsigned Index = 0;
+ IdDesc* I = Mac->M->Locals;
+ while (I) {
+ if (SB_Compare (&CurTok.SVal, &I->Id) == 0) {
+ /* This is in fact a local symbol, change the name. Be sure
+ * to generate a local label name if the original name was
+ * a local label, and also generate a name that cannot be
+ * generated by a user.
+ */
+ if (SB_At (&I->Id, 0) == LocalStart) {
+ /* Must generate a local symbol */
+ SB_Printf (&CurTok.SVal, "%cLOCAL-MACRO_SYMBOL-%04X",
+ LocalStart, Mac->LocalStart + Index);
+ } else {
+ /* Global symbol */
+ SB_Printf (&CurTok.SVal, "LOCAL-MACRO_SYMBOL-%04X",
+ Mac->LocalStart + Index);
+ }
+ break;
+ }
+ /* Next symbol */
+ ++Index;
+ I = I->Next;
+ }
+
+ /* Done */
+ return 1;
+ }
+
+ /* The token was successfully set */
+ return 1;
}
/* No more macro tokens. Do we have a final token? */
if (Mac->Final) {
- /* Set the final token and remove it */
- TokSet (Mac->Final);
- FreeTokNode (Mac->Final);
- Mac->Final = 0;
-
- /* The token was successfully set */
- return 1;
-
+ /* Set the final token and remove it */
+ TokSet (Mac->Final);
+ FreeTokNode (Mac->Final);
+ Mac->Final = 0;
+
+ /* Problem: When a .define style macro is expanded within the call
+ * of a classic one, the latter may be terminated and removed while
+ * the expansion of the .define style macro is still active. Because
+ * line info slots are "stacked", this runs into a CHECK FAILED. For
+ * now, we will fix that by removing the .define style macro expansion
+ * immediately, once the final token is placed. The better solution
+ * would probably be to not require AllocLineInfoSlot/FreeLineInfoSlot
+ * to be called in FIFO order, but this is a bigger change.
+ */
+ /* End of macro expansion and pop the input function */
+ FreeMacExp (Mac);
+ PopInput ();
+
+ /* The token was successfully set */
+ return 1;
}
MacEnd:
-static void StartExpClassic (Macro* M)
-/* Start expanding the classic macro M */
+static void StartExpClassic (MacExp* E)
+/* Start expanding a classic macro */
{
- MacExp* E;
+ token_t Term;
/* Skip the macro name */
NextTok ();
- /* Create a structure holding expansion data */
- E = NewMacExp (M);
-
/* Read the actual parameters */
- while (Tok != TOK_SEP && Tok != TOK_EOF) {
-
- TokNode* Last;
-
- /* Check for maximum parameter count */
- if (E->ParamCount >= M->ParamCount) {
- Error (ERR_TOO_MANY_PARAMS);
- SkipUntilSep ();
- break;
- }
-
- /* Read tokens for one parameter, accept empty params */
- Last = 0;
- while (Tok != TOK_COMMA && Tok != TOK_SEP) {
-
- TokNode* T;
-
- /* Check for end of file */
- if (Tok == TOK_EOF) {
- Error (ERR_SYNTAX);
- return;
- }
-
- /* Get the next token in a node */
- T = NewTokNode ();
-
- /* Insert it into the list */
- if (Last == 0) {
- E->Params [E->ParamCount] = T;
- } else {
- Last->Next = T;
- }
- Last = T;
-
- /* And skip it... */
- NextTok ();
- }
-
- /* One parameter more */
- ++E->ParamCount;
-
- /* Check for a comma */
- if (Tok == TOK_COMMA) {
- NextTok ();
- } else {
- break;
- }
+ while (!TokIsSep (CurTok.Tok)) {
+
+ TokNode* Last;
+
+ /* Check for maximum parameter count */
+ if (E->ParamCount >= E->M->ParamCount) {
+ ErrorSkip ("Too many macro parameters");
+ break;
+ }
+
+ /* The macro may optionally be enclosed in curly braces */
+ Term = GetTokListTerm (TOK_COMMA);
+
+ /* Read tokens for one parameter, accept empty params */
+ Last = 0;
+ while (CurTok.Tok != Term && CurTok.Tok != TOK_SEP) {
+
+ TokNode* T;
+
+ /* Check for end of file */
+ if (CurTok.Tok == TOK_EOF) {
+ Error ("Unexpected end of file");
+ FreeMacExp (E);
+ return;
+ }
+
+ /* Get the next token in a node */
+ T = NewTokNode ();
+
+ /* Insert it into the list */
+ if (Last == 0) {
+ E->Params [E->ParamCount] = T;
+ } else {
+ Last->Next = T;
+ }
+ Last = T;
+
+ /* And skip it... */
+ NextTok ();
+ }
+
+ /* One parameter more */
+ ++E->ParamCount;
+
+ /* If the macro argument was enclosed in curly braces, end-of-line
+ * is an error. Skip the closing curly brace.
+ */
+ if (Term == TOK_RCURLY) {
+ if (CurTok.Tok == TOK_SEP) {
+ Error ("End of line encountered within macro argument");
+ break;
+ }
+ NextTok ();
+ }
+
+ /* Check for a comma */
+ if (CurTok.Tok == TOK_COMMA) {
+ NextTok ();
+ } else {
+ break;
+ }
}
+ /* We must be at end of line now, otherwise something is wrong */
+ ExpectSep ();
+
/* Insert a new token input function */
PushInput (MacExpand, E, ".MACRO");
}
-static void StartExpDefine (Macro* M)
+static void StartExpDefine (MacExp* E)
/* Start expanding a DEFINE style macro */
{
- /* Create a structure holding expansion data */
- MacExp* E = NewMacExp (M);
-
/* A define style macro must be called with as many actual parameters
* as there are formal ones. Get the parameter count.
*/
- unsigned Count = M->ParamCount;
+ unsigned Count = E->M->ParamCount;
/* Skip the current token */
NextTok ();
/* Read the actual parameters */
while (Count--) {
- TokNode* Last;
-
- /* Check if there is really a parameter */
- if (Tok == TOK_SEP || Tok == TOK_EOF || Tok == TOK_COMMA) {
- Error (ERR_MACRO_PARAM_EXPECTED);
- SkipUntilSep ();
- return;
- }
-
- /* Read tokens for one parameter */
- Last = 0;
- do {
-
- TokNode* T;
-
- /* Get the next token in a node */
- T = NewTokNode ();
-
- /* Insert it into the list */
- if (Last == 0) {
- E->Params [E->ParamCount] = T;
- } else {
- Last->Next = T;
- }
- Last = T;
-
- /* And skip it... */
- NextTok ();
-
- } while (Tok != TOK_COMMA && Tok != TOK_SEP && Tok != TOK_EOF);
-
- /* One parameter more */
- ++E->ParamCount;
-
- /* Check for a comma */
- if (Count > 0) {
- if (Tok == TOK_COMMA) {
- NextTok ();
- } else {
- Error (ERR_COMMA_EXPECTED);
- }
- }
+ TokNode* Last;
+
+ /* The macro may optionally be enclosed in curly braces */
+ token_t Term = GetTokListTerm (TOK_COMMA);
+
+ /* Check if there is really a parameter */
+ if (TokIsSep (CurTok.Tok) || CurTok.Tok == Term) {
+ ErrorSkip ("Macro parameter #%u is empty", E->ParamCount+1);
+ FreeMacExp (E);
+ return;
+ }
+
+ /* Read tokens for one parameter */
+ Last = 0;
+ do {
+
+ TokNode* T;
+
+ /* Get the next token in a node */
+ T = NewTokNode ();
+
+ /* Insert it into the list */
+ if (Last == 0) {
+ E->Params [E->ParamCount] = T;
+ } else {
+ Last->Next = T;
+ }
+ Last = T;
+
+ /* And skip it... */
+ NextTok ();
+
+ } while (CurTok.Tok != Term && !TokIsSep (CurTok.Tok));
+
+ /* One parameter more */
+ ++E->ParamCount;
+
+ /* If the macro argument was enclosed in curly braces, end-of-line
+ * is an error. Skip the closing curly brace.
+ */
+ if (Term == TOK_RCURLY) {
+ if (TokIsSep (CurTok.Tok)) {
+ Error ("End of line encountered within macro argument");
+ break;
+ }
+ NextTok ();
+ }
+
+ /* Check for a comma */
+ if (Count > 0) {
+ if (CurTok.Tok == TOK_COMMA) {
+ NextTok ();
+ } else {
+ Error ("`,' expected");
+ }
+ }
}
/* Macro expansion will overwrite the current token. This is a problem
* for define style macros since these are called from the scanner level.
- * To avoid it, remember the current token and re-insert it if macro
+ * To avoid it, remember the current token and re-insert it, once macro
* expansion is done.
*/
E->Final = NewTokNode ();
-void MacExpandStart (void)
-/* Start expanding the macro in SVal */
+void MacExpandStart (Macro* M)
+/* Start expanding a macro */
{
- /* Search for the macro */
- Macro* M = MacFind (SVal, HashStr (SVal) % HASHTAB_SIZE);
- CHECK (M != 0);
+ MacExp* E;
+
+ /* Check the argument */
+ PRECONDITION (M && (M->Style != MAC_STYLE_DEFINE || DisableDefines == 0));
+
+ /* We cannot expand an incomplete macro */
+ if (M->Incomplete) {
+ Error ("Cannot expand an incomplete macro");
+ return;
+ }
+
+ /* Don't allow too many nested macro expansions - otherwise it is possible
+ * to force an endless loop and assembler crash.
+ */
+ if (MacExpansions >= MAX_MACEXPANSIONS) {
+ Error ("Too many nested macro expansions");
+ return;
+ }
+
+ /* Create a structure holding expansion data */
+ E = NewMacExp (M);
/* Call the apropriate subroutine */
switch (M->Style) {
- case MAC_STYLE_CLASSIC: StartExpClassic (M); break;
- case MAC_STYLE_DEFINE: StartExpDefine (M); break;
- default: Internal ("Invalid macro style: %d", M->Style);
+ case MAC_STYLE_CLASSIC: StartExpClassic (E); break;
+ case MAC_STYLE_DEFINE: StartExpDefine (E); break;
+ default: Internal ("Invalid macro style: %d", M->Style);
}
}
-int IsMacro (const char* Name)
-/* Return true if the given name is the name of a macro */
+Macro* FindMacro (const StrBuf* Name)
+/* Try to find the macro with the given name and return it. If no macro with
+ * this name was found, return NULL.
+ */
{
- return MacFind (SVal, HashStr (SVal) % HASHTAB_SIZE) != 0;
+ Macro* M = HT_Find (&MacroTab, Name);
+ return (M != 0 && M->Style == MAC_STYLE_CLASSIC)? M : 0;
}
-int IsDefine (const char* Name)
-/* Return true if the given name is the name of a define style macro */
+Macro* FindDefine (const StrBuf* Name)
+/* Try to find the define style macro with the given name and return it. If no
+ * such macro was found, return NULL.
+ */
{
- Macro* M = MacFind (SVal, HashStr (SVal) % HASHTAB_SIZE);
- return (M != 0 && M->Style == MAC_STYLE_DEFINE);
+ Macro* M;
+
+ /* Never if disabled */
+ if (DisableDefines) {
+ return 0;
+ }
+
+ /* Check if we have such a macro */
+ M = HT_Find (&MacroTab, Name);
+ return (M != 0 && M->Style == MAC_STYLE_DEFINE)? M : 0;
}
+void DisableDefineStyleMacros (void)
+/* Disable define style macros until EnableDefineStyleMacros is called */
+{
+ ++DisableDefines;
+}
+void EnableDefineStyleMacros (void)
+/* Re-enable define style macros previously disabled with
+ * DisableDefineStyleMacros.
+ */
+{
+ PRECONDITION (DisableDefines > 0);
+ --DisableDefines;
+}