1 /*****************************************************************************/
5 /* Macros for the ca65 macroassembler */
9 /* (C) 1998-2011, Ullrich von Bassewitz */
10 /* Roemerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
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. */
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: */
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 */
32 /*****************************************************************************/
59 /*****************************************************************************/
61 /*****************************************************************************/
65 static unsigned HT_GenHash (const void* Key);
66 /* Generate the hash over a key. */
68 static const void* HT_GetKey (const void* Entry);
69 /* Given a pointer to the user entry data, return a pointer to the key */
71 static int HT_Compare (const void* Key1, const void* Key2);
72 /* Compare two keys. The function must return a value less than zero if
73 ** Key1 is smaller than Key2, zero if both are equal, and a value greater
74 ** than zero if Key1 is greater then Key2.
79 /*****************************************************************************/
81 /*****************************************************************************/
85 /* Struct that describes an identifer (macro param, local list) */
86 typedef struct IdDesc IdDesc;
88 IdDesc* Next; /* Linked list */
89 StrBuf Id; /* Identifier, dynamically allocated */
94 /* Struct that describes a macro definition */
96 HashNode Node; /* Hash list node */
97 Macro* List; /* List of all macros */
98 unsigned LocalCount; /* Count of local symbols */
99 IdDesc* Locals; /* List of local symbols */
100 unsigned ParamCount; /* Parameter count of macro */
101 IdDesc* Params; /* Identifiers of macro parameters */
102 unsigned TokCount; /* Number of tokens for this macro */
103 TokNode* TokRoot; /* Root of token list */
104 TokNode* TokLast; /* Pointer to last token in list */
105 StrBuf Name; /* Macro name, dynamically allocated */
106 unsigned Expansions; /* Number of active macro expansions */
107 unsigned char Style; /* Macro style */
108 unsigned char Incomplete; /* Macro is currently built */
111 /* Hash table functions */
112 static const HashFunctions HashFunc = {
118 /* Macro hash table */
119 static HashTable MacroTab = STATIC_HASHTABLE_INITIALIZER (117, &HashFunc);
121 /* Structs that holds data for a macro expansion */
122 typedef struct MacExp MacExp;
124 MacExp* Next; /* Pointer to next expansion */
125 Macro* M; /* Which macro do we expand? */
126 unsigned IfSP; /* .IF stack pointer at start of expansion */
127 TokNode* Exp; /* Pointer to current token */
128 TokNode* Final; /* Pointer to final token */
129 unsigned MacExpansions; /* Number of active macro expansions */
130 unsigned LocalStart; /* Start of counter for local symbol names */
131 unsigned ParamCount; /* Number of actual parameters */
132 TokNode** Params; /* List of actual parameters */
133 TokNode* ParamExp; /* Node for expanding parameters */
134 LineInfo* LI; /* Line info for the expansion */
135 LineInfo* ParamLI; /* Line info for parameter expansion */
138 /* Maximum number of nested macro expansions */
139 #define MAX_MACEXPANSIONS 256U
141 /* Number of active macro expansions */
142 static unsigned MacExpansions = 0;
144 /* Flag if a macro expansion should get aborted */
145 static int DoMacAbort = 0;
147 /* Counter to create local names for symbols */
148 static unsigned LocalName = 0;
150 /* Define-style macros disabled if != 0 */
151 static unsigned DisableDefines = 0;
155 /*****************************************************************************/
156 /* Hash table functions */
157 /*****************************************************************************/
161 static unsigned HT_GenHash (const void* Key)
162 /* Generate the hash over a key. */
164 return HashBuf (Key);
169 static const void* HT_GetKey (const void* Entry)
170 /* Given a pointer to the user entry data, return a pointer to the index */
172 return &((Macro*) Entry)->Name;
177 static int HT_Compare (const void* Key1, const void* Key2)
178 /* Compare two keys. The function must return a value less than zero if
179 ** Key1 is smaller than Key2, zero if both are equal, and a value greater
180 ** than zero if Key1 is greater then Key2.
183 return SB_Compare (Key1, Key2);
188 /*****************************************************************************/
190 /*****************************************************************************/
194 static IdDesc* NewIdDesc (const StrBuf* Id)
195 /* Create a new IdDesc, initialize and return it */
197 /* Allocate memory */
198 IdDesc* ID = xmalloc (sizeof (IdDesc));
200 /* Initialize the struct */
203 SB_Copy (&ID->Id, Id);
205 /* Return the new struct */
211 static void FreeIdDesc (IdDesc* ID)
217 /* Free the structure itself */
223 static void FreeIdDescList (IdDesc* ID)
224 /* Free a complete list of IdDesc structures */
235 static Macro* NewMacro (const StrBuf* Name, unsigned char Style)
236 /* Generate a new macro entry, initialize and return it */
238 /* Allocate memory */
239 Macro* M = xmalloc (sizeof (Macro));
241 /* Initialize the macro struct */
242 InitHashNode (&M->Node);
251 SB_Copy (&M->Name, Name);
256 /* Insert the macro into the hash table */
257 HT_Insert (&MacroTab, &M->Node);
259 /* Return the new macro struct */
265 static void FreeMacro (Macro* M)
266 /* Free a macro entry which has already been removed from the macro table. */
271 FreeIdDescList (M->Locals);
273 /* Free identifiers of parameters */
274 FreeIdDescList (M->Params);
276 /* Free the token list for the macro */
277 while ((T = M->TokRoot) != 0) {
278 M->TokRoot = T->Next;
282 /* Free the macro name */
285 /* Free the macro structure itself */
291 static MacExp* NewMacExp (Macro* M)
292 /* Create a new expansion structure for the given macro */
296 /* Allocate memory */
297 MacExp* E = xmalloc (sizeof (MacExp));
299 /* Initialize the data */
301 E->IfSP = GetIfStack ();
304 E->MacExpansions = ++MacExpansions; /* One macro expansion more */
305 E->LocalStart = LocalName;
306 LocalName += M->LocalCount;
308 E->Params = xmalloc (M->ParamCount * sizeof (TokNode*));
309 for (I = 0; I < M->ParamCount; ++I) {
316 /* Mark the macro as expanding */
319 /* Return the new macro expansion */
325 static void FreeMacExp (MacExp* E)
326 /* Remove and free the current macro expansion */
330 /* One macro expansion less */
333 /* No longer expanding this macro */
336 /* Free the parameter lists */
337 for (I = 0; I < E->ParamCount; ++I) {
338 /* Free one parameter list */
339 TokNode* N = E->Params[I];
341 TokNode* P = N->Next;
348 /* Free the additional line info */
350 EndLine (E->ParamLI);
356 /* Free the final token if we have one */
358 FreeTokNode (E->Final);
361 /* Free the structure itself */
367 static void MacSkipDef (unsigned Style)
368 /* Skip a macro definition */
370 if (Style == MAC_STYLE_CLASSIC) {
371 /* Skip tokens until we reach the final .endmacro */
372 while (CurTok.Tok != TOK_ENDMACRO && CurTok.Tok != TOK_EOF) {
375 if (CurTok.Tok != TOK_EOF) {
378 Error ("`.ENDMACRO' expected");
381 /* Skip until end of line */
388 void MacDef (unsigned Style)
389 /* Parse a macro definition */
395 /* We expect a macro name here */
396 if (CurTok.Tok != TOK_IDENT) {
397 Error ("Identifier expected");
400 } else if (!UbiquitousIdents && FindInstruction (&CurTok.SVal) >= 0) {
401 /* The identifier is a name of a 6502 instruction, which is not
402 ** allowed if not explicitly enabled.
404 Error ("Cannot use an instruction as macro name");
409 /* Did we already define that macro? */
410 if (HT_Find (&MacroTab, &CurTok.SVal) != 0) {
411 /* Macro is already defined */
412 Error ("A macro named `%m%p' is already defined", &CurTok.SVal);
413 /* Skip tokens until we reach the final .endmacro */
418 /* Define the macro */
419 M = NewMacro (&CurTok.SVal, Style);
421 /* Switch to raw token mode and skip the macro name */
422 EnterRawTokenMode ();
425 /* If we have a DEFINE-style macro, we may have parameters in parentheses;
426 ** otherwise, we may have parameters without parentheses.
428 if (Style == MAC_STYLE_CLASSIC) {
431 if (CurTok.Tok == TOK_LPAREN) {
439 /* Parse the parameter list */
442 while (CurTok.Tok == TOK_IDENT) {
444 /* Create a struct holding the identifier */
445 IdDesc* I = NewIdDesc (&CurTok.SVal);
447 /* Insert the struct into the list, checking for duplicate idents */
448 if (M->ParamCount == 0) {
451 IdDesc* List = M->Params;
453 if (SB_Compare (&List->Id, &CurTok.SVal) == 0) {
454 Error ("Duplicate symbol `%m%p'", &CurTok.SVal);
456 if (List->Next == 0) {
469 /* Maybe there are more params... */
470 if (CurTok.Tok == TOK_COMMA) {
478 /* For classic macros, we expect a separator token, for define-style macros,
479 ** we expect the closing paren.
481 if (Style == MAC_STYLE_CLASSIC) {
483 } else if (HaveParams) {
487 /* Preparse the macro body. We will read the tokens until we reach end of
488 ** file, or a .endmacro (or end of line for DEFINE-style macros) and store
489 ** them into a token list internal to the macro. For classic macros,
490 ** the .LOCAL command is detected and removed, at this time.
494 /* Check for end of macro */
495 if (Style == MAC_STYLE_CLASSIC) {
496 /* In classic macros, only .endmacro is allowed */
497 if (CurTok.Tok == TOK_ENDMACRO) {
501 /* May not have end of file in a macro definition */
502 if (CurTok.Tok == TOK_EOF) {
503 Error ("`.ENDMACRO' expected");
507 /* Accept a newline or end of file for new style macros */
508 if (TokIsSep (CurTok.Tok)) {
513 /* Check for a .LOCAL declaration */
514 if (CurTok.Tok == TOK_LOCAL && Style == MAC_STYLE_CLASSIC) {
520 /* Skip .local or comma */
523 /* Need an identifer */
524 if (CurTok.Tok != TOK_IDENT && CurTok.Tok != TOK_LOCAL_IDENT) {
525 Error ("Identifier expected");
530 /* Put the identifier into the locals list and skip it */
531 I = NewIdDesc (&CurTok.SVal);
537 /* Check for end of list */
538 if (CurTok.Tok != TOK_COMMA) {
544 /* We need end of line after the locals */
549 /* Create a token node for the current token */
552 /* If the token is an identifier, check if it is a local parameter */
553 if (CurTok.Tok == TOK_IDENT) {
555 IdDesc* I = M->Params;
557 if (SB_Compare (&I->Id, &CurTok.SVal) == 0) {
558 /* Local param name, replace it */
559 N->T.Tok = TOK_MACPARAM;
568 /* Insert the new token in the list */
569 if (M->TokCount == 0) {
571 M->TokRoot = M->TokLast = N;
573 /* We have already tokens */
574 M->TokLast->Next = N;
579 /* Read the next token */
583 /* Skip the .endmacro for a classic macro */
584 if (Style == MAC_STYLE_CLASSIC) {
588 /* Reset the Incomplete flag now that parsing is done */
592 /* Switch out of raw token mode */
593 LeaveRawTokenMode ();
598 void MacUndef (const StrBuf* Name, unsigned char Style)
599 /* Undefine the macro with the given name and style. A style mismatch is
600 ** treated as if the macro didn't exist.
603 /* Search for the macro */
604 Macro* M = HT_Find (&MacroTab, Name);
606 /* Don't let the user kid with us */
607 if (M == 0 || M->Style != Style) {
608 Error ("No such macro: %m%p", Name);
611 if (M->Expansions > 0) {
612 Error ("Cannot delete a macro that is currently expanded");
616 /* Remove the macro from the macro table */
617 HT_Remove (&MacroTab, M);
619 /* Free the macro structure */
625 static int MacExpand (void* Data)
626 /* If we're currently expanding a macro, set the the scanner token and
627 ** attribute to the next value and return true. If we are not expanding
628 ** a macro, return false.
631 /* Cast the Data pointer to the actual data structure */
632 MacExp* Mac = (MacExp*) Data;
634 /* Check if we should abort this macro */
640 /* Abort any open .IF statements in this macro expansion */
641 CleanupIfStack (Mac->IfSP);
643 /* Terminate macro expansion */
647 /* We're expanding a macro. Check if we are expanding one of the
653 /* Ok, use token from parameter list */
654 TokSet (Mac->ParamExp);
656 /* Create new line info for this parameter token */
658 EndLine (Mac->ParamLI);
660 Mac->ParamLI = StartLine (&CurTok.Pos, LI_TYPE_MACPARAM, Mac->MacExpansions);
662 /* Set pointer to next token */
663 Mac->ParamExp = Mac->ParamExp->Next;
668 } else if (Mac->ParamLI) {
670 /* There's still line info open from the parameter expansion - end it */
671 EndLine (Mac->ParamLI);
676 /* We're not expanding macro parameters. Check if we have tokens left from
681 /* Use next macro token */
684 /* Create new line info for this token */
688 Mac->LI = StartLine (&CurTok.Pos, LI_TYPE_MACRO, Mac->MacExpansions);
690 /* Set pointer to next token */
691 Mac->Exp = Mac->Exp->Next;
693 /* Is it a request for actual parameter count? */
694 if (CurTok.Tok == TOK_PARAMCOUNT) {
695 CurTok.Tok = TOK_INTCON;
696 CurTok.IVal = Mac->ParamCount;
700 /* Is it the name of a macro parameter? */
701 if (CurTok.Tok == TOK_MACPARAM) {
703 /* Start to expand the parameter token list */
704 Mac->ParamExp = Mac->Params[CurTok.IVal];
706 /* Go back and expand the parameter */
710 /* If it's an identifier, it may in fact be a local symbol */
711 if ((CurTok.Tok == TOK_IDENT || CurTok.Tok == TOK_LOCAL_IDENT) &&
712 Mac->M->LocalCount) {
713 /* Search for the local symbol in the list */
715 IdDesc* I = Mac->M->Locals;
717 if (SB_Compare (&CurTok.SVal, &I->Id) == 0) {
718 /* This is in fact a local symbol, change the name. Be sure
719 ** to generate a local label name if the original name was
720 ** a local label, and also generate a name that cannot be
721 ** generated by a user.
723 if (SB_At (&I->Id, 0) == LocalStart) {
724 /* Must generate a local symbol */
725 SB_Printf (&CurTok.SVal, "%cLOCAL-MACRO_SYMBOL-%04X",
726 LocalStart, Mac->LocalStart + Index);
729 SB_Printf (&CurTok.SVal, "LOCAL-MACRO_SYMBOL-%04X",
730 Mac->LocalStart + Index);
743 /* The token was successfully set */
747 /* No more macro tokens. Do we have a final token? */
750 /* Set the final token and remove it */
752 FreeTokNode (Mac->Final);
755 /* Problem: When a .define-style macro is expanded within the call
756 ** of a classic one, the latter may be terminated and removed while
757 ** the expansion of the .define-style macro is still active. Because
758 ** line info slots are "stacked", this runs into a CHECK FAILED. For
759 ** now, we will fix that by removing the .define-style macro expansion
760 ** immediately, once the final token is placed. The better solution
761 ** would probably be to not require AllocLineInfoSlot/FreeLineInfoSlot
762 ** to be called in FIFO order, but this is a bigger change.
764 /* End of macro expansion and pop the input function */
768 /* The token was successfully set */
773 /* End of macro expansion */
776 /* Pop the input function */
779 /* No token available */
785 static void StartExpClassic (MacExp* E)
786 /* Start expanding a classic macro */
790 /* Skip the macro name */
793 /* Does this invocation have any arguments? */
794 if (!TokIsSep (CurTok.Tok)) {
796 /* Read the actual parameters */
800 /* Check for maximum parameter count */
801 if (E->ParamCount >= E->M->ParamCount) {
802 ErrorSkip ("Too many macro parameters");
806 /* The macro argument optionally may be enclosed in curly braces */
807 Term = GetTokListTerm (TOK_COMMA);
809 /* Read tokens for one parameter, accept empty params */
811 while (CurTok.Tok != Term && CurTok.Tok != TOK_SEP) {
814 /* Check for end of file */
815 if (CurTok.Tok == TOK_EOF) {
816 Error ("Unexpected end of file");
821 /* Get the next token in a node */
824 /* Insert it into the list */
826 E->Params [E->ParamCount] = T;
836 /* One parameter more */
839 /* If the macro argument was enclosed in curly braces, end-of-line
840 ** is an error. Skip the closing curly brace.
842 if (Term == TOK_RCURLY) {
843 if (CurTok.Tok == TOK_SEP) {
844 Error ("End of line encountered within macro argument");
850 /* Check for a comma */
851 if (CurTok.Tok == TOK_COMMA) {
859 /* We must be at end of line now, otherwise something is wrong */
862 /* Insert a new token input function */
863 PushInput (MacExpand, E, ".MACRO");
868 static void StartExpDefine (MacExp* E)
869 /* Start expanding a DEFINE-style macro */
871 /* A define-style macro must be called with as many actual parameters
872 ** as there are formal ones. Get the parameter count.
874 unsigned Count = E->M->ParamCount;
876 /* Skip the current token */
879 /* Read the actual parameters */
883 /* The macro argument optionally may be enclosed in curly braces */
884 token_t Term = GetTokListTerm (TOK_COMMA);
886 /* Check if there is really a parameter */
887 if (TokIsSep (CurTok.Tok) || CurTok.Tok == Term) {
888 ErrorSkip ("Macro parameter #%u is empty", E->ParamCount+1);
893 /* Read tokens for one parameter */
898 /* Get the next token in a node */
901 /* Insert it into the list */
903 E->Params [E->ParamCount] = T;
912 } while (CurTok.Tok != Term && !TokIsSep (CurTok.Tok));
914 /* One parameter more */
917 /* If the macro argument was enclosed in curly braces, end-of-line
918 ** is an error. Skip the closing curly brace.
920 if (Term == TOK_RCURLY) {
921 if (TokIsSep (CurTok.Tok)) {
922 Error ("End of line encountered within macro argument");
928 /* Check for a comma */
930 if (CurTok.Tok == TOK_COMMA) {
933 Error ("`,' expected");
938 /* Macro expansion will overwrite the current token. This is a problem
939 ** for define-style macros since these are called from the scanner level.
940 ** To avoid it, remember the current token and re-insert it, once macro
941 ** expansion is done.
943 E->Final = NewTokNode ();
945 /* Insert a new token input function */
946 PushInput (MacExpand, E, ".DEFINE");
951 void MacExpandStart (Macro* M)
952 /* Start expanding a macro */
956 /* Check the argument */
957 PRECONDITION (M && (M->Style != MAC_STYLE_DEFINE || DisableDefines == 0));
959 /* We cannot expand an incomplete macro */
961 Error ("Cannot expand an incomplete macro");
965 /* Don't allow too many nested macro expansions - otherwise it is possible
966 ** to force an endless loop and assembler crash.
968 if (MacExpansions >= MAX_MACEXPANSIONS) {
969 Error ("Too many nested macro expansions");
973 /* Create a structure holding expansion data */
976 /* Call the apropriate subroutine */
978 case MAC_STYLE_CLASSIC: StartExpClassic (E); break;
979 case MAC_STYLE_DEFINE: StartExpDefine (E); break;
980 default: Internal ("Invalid macro style: %d", M->Style);
987 /* Abort the current macro expansion */
989 /* Must have an expansion */
990 CHECK (MacExpansions > 0);
992 /* Set a flag so macro expansion will terminate on the next call */
998 Macro* FindMacro (const StrBuf* Name)
999 /* Try to find the macro with the given name and return it. If no macro with
1000 ** this name was found, return NULL.
1003 Macro* M = HT_Find (&MacroTab, Name);
1004 return (M != 0 && M->Style == MAC_STYLE_CLASSIC)? M : 0;
1009 Macro* FindDefine (const StrBuf* Name)
1010 /* Try to find the define-style macro with the given name; and, return it.
1011 ** If no such macro was found, return NULL.
1016 /* Never if disabled */
1017 if (DisableDefines) {
1021 /* Check if we have such a macro */
1022 M = HT_Find (&MacroTab, Name);
1023 return (M != 0 && M->Style == MAC_STYLE_DEFINE)? M : 0;
1028 int InMacExpansion (void)
1029 /* Return true if we're currently expanding a macro */
1031 return (MacExpansions > 0);
1036 void DisableDefineStyleMacros (void)
1037 /* Disable define-style macros until EnableDefineStyleMacros() is called */
1044 void EnableDefineStyleMacros (void)
1045 /* Re-enable define-style macros previously disabled with
1046 ** DisableDefineStyleMacros().
1049 PRECONDITION (DisableDefines > 0);