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 */
137 /* Maximum number of nested macro expansions */
138 #define MAX_MACEXPANSIONS 256U
140 /* Number of active macro expansions */
141 static unsigned MacExpansions = 0;
143 /* Flag if a macro expansion should get aborted */
144 static int DoMacAbort = 0;
146 /* Counter to create local names for symbols */
147 static unsigned LocalName = 0;
149 /* Define style macros disabled if != 0 */
150 static unsigned DisableDefines = 0;
154 /*****************************************************************************/
155 /* Hash table functions */
156 /*****************************************************************************/
160 static unsigned HT_GenHash (const void* Key)
161 /* Generate the hash over a key. */
163 return HashBuf (Key);
168 static const void* HT_GetKey (const void* Entry)
169 /* Given a pointer to the user entry data, return a pointer to the index */
171 return &((Macro*) Entry)->Name;
176 static int HT_Compare (const void* Key1, const void* Key2)
177 /* Compare two keys. The function must return a value less than zero if
178 * Key1 is smaller than Key2, zero if both are equal, and a value greater
179 * than zero if Key1 is greater then Key2.
182 return SB_Compare (Key1, Key2);
187 /*****************************************************************************/
189 /*****************************************************************************/
193 static IdDesc* NewIdDesc (const StrBuf* Id)
194 /* Create a new IdDesc, initialize and return it */
196 /* Allocate memory */
197 IdDesc* ID = xmalloc (sizeof (IdDesc));
199 /* Initialize the struct */
202 SB_Copy (&ID->Id, Id);
204 /* Return the new struct */
210 static void FreeIdDesc (IdDesc* ID)
216 /* Free the structure itself */
222 static void FreeIdDescList (IdDesc* ID)
223 /* Free a complete list of IdDesc structures */
234 static Macro* NewMacro (const StrBuf* Name, unsigned char Style)
235 /* Generate a new macro entry, initialize and return it */
237 /* Allocate memory */
238 Macro* M = xmalloc (sizeof (Macro));
240 /* Initialize the macro struct */
241 InitHashNode (&M->Node);
250 SB_Copy (&M->Name, Name);
255 /* Insert the macro into the hash table */
256 HT_Insert (&MacroTab, &M->Node);
258 /* Return the new macro struct */
264 static void FreeMacro (Macro* M)
265 /* Free a macro entry which has already been removed from the macro table. */
270 FreeIdDescList (M->Locals);
272 /* Free identifiers of parameters */
273 FreeIdDescList (M->Params);
275 /* Free the token list for the macro */
276 while ((T = M->TokRoot) != 0) {
277 M->TokRoot = T->Next;
281 /* Free the macro name */
284 /* Free the macro structure itself */
290 static MacExp* NewMacExp (Macro* M)
291 /* Create a new expansion structure for the given macro */
295 /* Allocate memory */
296 MacExp* E = xmalloc (sizeof (MacExp));
298 /* Initialize the data */
300 E->IfSP = GetIfStack ();
303 E->MacExpansions = ++MacExpansions; /* One macro expansion more */
304 E->LocalStart = LocalName;
305 LocalName += M->LocalCount;
307 E->Params = xmalloc (M->ParamCount * sizeof (TokNode*));
308 for (I = 0; I < M->ParamCount; ++I) {
314 /* Mark the macro as expanding */
317 /* Return the new macro expansion */
323 static void FreeMacExp (MacExp* E)
324 /* Remove and free the current macro expansion */
328 /* One macro expansion less */
331 /* No longer expanding this macro */
334 /* Free the parameter lists */
335 for (I = 0; I < E->ParamCount; ++I) {
336 /* Free one parameter list */
337 TokNode* N = E->Params[I];
339 TokNode* P = N->Next;
346 /* Free the additional line info */
351 /* Free the final token if we have one */
353 FreeTokNode (E->Final);
356 /* Free the structure itself */
362 static void MacSkipDef (unsigned Style)
363 /* Skip a macro definition */
365 if (Style == MAC_STYLE_CLASSIC) {
366 /* Skip tokens until we reach the final .endmacro */
367 while (CurTok.Tok != TOK_ENDMACRO && CurTok.Tok != TOK_EOF) {
370 if (CurTok.Tok != TOK_EOF) {
373 Error ("`.ENDMACRO' expected");
376 /* Skip until end of line */
383 void MacDef (unsigned Style)
384 /* Parse a macro definition */
390 /* We expect a macro name here */
391 if (CurTok.Tok != TOK_IDENT) {
392 Error ("Identifier expected");
395 } else if (!UbiquitousIdents && FindInstruction (&CurTok.SVal) >= 0) {
396 /* The identifier is a name of a 6502 instruction, which is not
397 * allowed if not explicitly enabled.
399 Error ("Cannot use an instruction as macro name");
404 /* Did we already define that macro? */
405 if (HT_Find (&MacroTab, &CurTok.SVal) != 0) {
406 /* Macro is already defined */
407 Error ("A macro named `%m%p' is already defined", &CurTok.SVal);
408 /* Skip tokens until we reach the final .endmacro */
413 /* Define the macro */
414 M = NewMacro (&CurTok.SVal, Style);
416 /* Switch to raw token mode and skip the macro name */
417 EnterRawTokenMode ();
420 /* If we have a DEFINE style macro, we may have parameters in braces,
421 * otherwise we may have parameters without braces.
423 if (Style == MAC_STYLE_CLASSIC) {
426 if (CurTok.Tok == TOK_LPAREN) {
434 /* Parse the parameter list */
437 while (CurTok.Tok == TOK_IDENT) {
439 /* Create a struct holding the identifier */
440 IdDesc* I = NewIdDesc (&CurTok.SVal);
442 /* Insert the struct into the list, checking for duplicate idents */
443 if (M->ParamCount == 0) {
446 IdDesc* List = M->Params;
448 if (SB_Compare (&List->Id, &CurTok.SVal) == 0) {
449 Error ("Duplicate symbol `%m%p'", &CurTok.SVal);
451 if (List->Next == 0) {
464 /* Maybe there are more params... */
465 if (CurTok.Tok == TOK_COMMA) {
473 /* For class macros, we expect a separator token, for define style macros,
474 * we expect the closing paren.
476 if (Style == MAC_STYLE_CLASSIC) {
478 } else if (HaveParams) {
482 /* Preparse the macro body. We will read the tokens until we reach end of
483 * file, or a .endmacro (or end of line for DEFINE style macros) and store
484 * them into an token list internal to the macro. For classic macros, there
485 * the .LOCAL command is detected and removed at this time.
489 /* Check for end of macro */
490 if (Style == MAC_STYLE_CLASSIC) {
491 /* In classic macros, only .endmacro is allowed */
492 if (CurTok.Tok == TOK_ENDMACRO) {
496 /* May not have end of file in a macro definition */
497 if (CurTok.Tok == TOK_EOF) {
498 Error ("`.ENDMACRO' expected");
502 /* Accept a newline or end of file for new style macros */
503 if (TokIsSep (CurTok.Tok)) {
508 /* Check for a .LOCAL declaration */
509 if (CurTok.Tok == TOK_LOCAL && Style == MAC_STYLE_CLASSIC) {
515 /* Skip .local or comma */
518 /* Need an identifer */
519 if (CurTok.Tok != TOK_IDENT && CurTok.Tok != TOK_LOCAL_IDENT) {
520 Error ("Identifier expected");
525 /* Put the identifier into the locals list and skip it */
526 I = NewIdDesc (&CurTok.SVal);
532 /* Check for end of list */
533 if (CurTok.Tok != TOK_COMMA) {
539 /* We need end of line after the locals */
544 /* Create a token node for the current token */
547 /* If the token is an ident, check if it is a local parameter */
548 if (CurTok.Tok == TOK_IDENT) {
550 IdDesc* I = M->Params;
552 if (SB_Compare (&I->Id, &CurTok.SVal) == 0) {
553 /* Local param name, replace it */
554 N->T.Tok = TOK_MACPARAM;
563 /* Insert the new token in the list */
564 if (M->TokCount == 0) {
566 M->TokRoot = M->TokLast = N;
568 /* We have already tokens */
569 M->TokLast->Next = N;
574 /* Read the next token */
578 /* Skip the .endmacro for a classic macro */
579 if (Style == MAC_STYLE_CLASSIC) {
583 /* Reset the Incomplete flag now that parsing is done */
587 /* Switch out of raw token mode */
588 LeaveRawTokenMode ();
593 void MacUndef (const StrBuf* Name, unsigned char Style)
594 /* Undefine the macro with the given name and style. A style mismatch is
595 * treated as if the macro didn't exist.
598 /* Search for the macro */
599 Macro* M = HT_Find (&MacroTab, Name);
601 /* Don't let the user kid with us */
602 if (M == 0 || M->Style != Style) {
603 Error ("No such macro: %m%p", Name);
606 if (M->Expansions > 0) {
607 Error ("Cannot delete a macro that is currently expanded");
611 /* Remove the macro from the macro table */
612 HT_Remove (&MacroTab, M);
614 /* Free the macro structure */
620 static int MacExpand (void* Data)
621 /* If we're currently expanding a macro, set the the scanner token and
622 * attribute to the next value and return true. If we are not expanding
623 * a macro, return false.
626 /* Cast the Data pointer to the actual data structure */
627 MacExp* Mac = (MacExp*) Data;
629 /* Check if we should abort this macro */
635 /* Abort any open .IF statements in this macro expansion */
636 CleanupIfStack (Mac->IfSP);
638 /* Terminate macro expansion */
642 /* We're expanding a macro. Check if we are expanding one of the
648 /* Ok, use token from parameter list */
649 TokSet (Mac->ParamExp);
651 /* Set pointer to next token */
652 Mac->ParamExp = Mac->ParamExp->Next;
658 /* We're not expanding macro parameters. Check if we have tokens left from
663 /* Use next macro token */
666 /* Create new line info for this token */
670 Mac->LI = StartLine (&CurTok.Pos, LI_TYPE_MACRO, Mac->MacExpansions);
672 /* Set pointer to next token */
673 Mac->Exp = Mac->Exp->Next;
675 /* Is it a request for actual parameter count? */
676 if (CurTok.Tok == TOK_PARAMCOUNT) {
677 CurTok.Tok = TOK_INTCON;
678 CurTok.IVal = Mac->ParamCount;
682 /* Is it the name of a macro parameter? */
683 if (CurTok.Tok == TOK_MACPARAM) {
685 /* Start to expand the parameter token list */
686 Mac->ParamExp = Mac->Params[CurTok.IVal];
688 /* Go back and expand the parameter */
692 /* If it's an identifier, it may in fact be a local symbol */
693 if ((CurTok.Tok == TOK_IDENT || CurTok.Tok == TOK_LOCAL_IDENT) &&
694 Mac->M->LocalCount) {
695 /* Search for the local symbol in the list */
697 IdDesc* I = Mac->M->Locals;
699 if (SB_Compare (&CurTok.SVal, &I->Id) == 0) {
700 /* This is in fact a local symbol, change the name. Be sure
701 * to generate a local label name if the original name was
702 * a local label, and also generate a name that cannot be
703 * generated by a user.
705 if (SB_At (&I->Id, 0) == LocalStart) {
706 /* Must generate a local symbol */
707 SB_Printf (&CurTok.SVal, "%cLOCAL-MACRO_SYMBOL-%04X",
708 LocalStart, Mac->LocalStart + Index);
711 SB_Printf (&CurTok.SVal, "LOCAL-MACRO_SYMBOL-%04X",
712 Mac->LocalStart + Index);
725 /* The token was successfully set */
729 /* No more macro tokens. Do we have a final token? */
732 /* Set the final token and remove it */
734 FreeTokNode (Mac->Final);
737 /* Problem: When a .define style macro is expanded within the call
738 * of a classic one, the latter may be terminated and removed while
739 * the expansion of the .define style macro is still active. Because
740 * line info slots are "stacked", this runs into a CHECK FAILED. For
741 * now, we will fix that by removing the .define style macro expansion
742 * immediately, once the final token is placed. The better solution
743 * would probably be to not require AllocLineInfoSlot/FreeLineInfoSlot
744 * to be called in FIFO order, but this is a bigger change.
746 /* End of macro expansion and pop the input function */
750 /* The token was successfully set */
755 /* End of macro expansion */
758 /* Pop the input function */
761 /* No token available */
767 static void StartExpClassic (MacExp* E)
768 /* Start expanding a classic macro */
772 /* Skip the macro name */
775 /* Read the actual parameters */
776 while (!TokIsSep (CurTok.Tok)) {
780 /* Check for maximum parameter count */
781 if (E->ParamCount >= E->M->ParamCount) {
782 ErrorSkip ("Too many macro parameters");
786 /* The macro may optionally be enclosed in curly braces */
787 Term = GetTokListTerm (TOK_COMMA);
789 /* Read tokens for one parameter, accept empty params */
791 while (CurTok.Tok != Term && CurTok.Tok != TOK_SEP) {
795 /* Check for end of file */
796 if (CurTok.Tok == TOK_EOF) {
797 Error ("Unexpected end of file");
802 /* Get the next token in a node */
805 /* Insert it into the list */
807 E->Params [E->ParamCount] = T;
817 /* One parameter more */
820 /* If the macro argument was enclosed in curly braces, end-of-line
821 * is an error. Skip the closing curly brace.
823 if (Term == TOK_RCURLY) {
824 if (CurTok.Tok == TOK_SEP) {
825 Error ("End of line encountered within macro argument");
831 /* Check for a comma */
832 if (CurTok.Tok == TOK_COMMA) {
839 /* We must be at end of line now, otherwise something is wrong */
842 /* Insert a new token input function */
843 PushInput (MacExpand, E, ".MACRO");
848 static void StartExpDefine (MacExp* E)
849 /* Start expanding a DEFINE style macro */
851 /* A define style macro must be called with as many actual parameters
852 * as there are formal ones. Get the parameter count.
854 unsigned Count = E->M->ParamCount;
856 /* Skip the current token */
859 /* Read the actual parameters */
864 /* The macro may optionally be enclosed in curly braces */
865 token_t Term = GetTokListTerm (TOK_COMMA);
867 /* Check if there is really a parameter */
868 if (TokIsSep (CurTok.Tok) || CurTok.Tok == Term) {
869 ErrorSkip ("Macro parameter #%u is empty", E->ParamCount+1);
874 /* Read tokens for one parameter */
880 /* Get the next token in a node */
883 /* Insert it into the list */
885 E->Params [E->ParamCount] = T;
894 } while (CurTok.Tok != Term && !TokIsSep (CurTok.Tok));
896 /* One parameter more */
899 /* If the macro argument was enclosed in curly braces, end-of-line
900 * is an error. Skip the closing curly brace.
902 if (Term == TOK_RCURLY) {
903 if (TokIsSep (CurTok.Tok)) {
904 Error ("End of line encountered within macro argument");
910 /* Check for a comma */
912 if (CurTok.Tok == TOK_COMMA) {
915 Error ("`,' expected");
920 /* Macro expansion will overwrite the current token. This is a problem
921 * for define style macros since these are called from the scanner level.
922 * To avoid it, remember the current token and re-insert it, once macro
925 E->Final = NewTokNode ();
927 /* Insert a new token input function */
928 PushInput (MacExpand, E, ".DEFINE");
933 void MacExpandStart (Macro* M)
934 /* Start expanding a macro */
938 /* Check the argument */
939 PRECONDITION (M && (M->Style != MAC_STYLE_DEFINE || DisableDefines == 0));
941 /* We cannot expand an incomplete macro */
943 Error ("Cannot expand an incomplete macro");
947 /* Don't allow too many nested macro expansions - otherwise it is possible
948 * to force an endless loop and assembler crash.
950 if (MacExpansions >= MAX_MACEXPANSIONS) {
951 Error ("Too many nested macro expansions");
955 /* Create a structure holding expansion data */
958 /* Call the apropriate subroutine */
960 case MAC_STYLE_CLASSIC: StartExpClassic (E); break;
961 case MAC_STYLE_DEFINE: StartExpDefine (E); break;
962 default: Internal ("Invalid macro style: %d", M->Style);
969 /* Abort the current macro expansion */
971 /* Must have an expansion */
972 CHECK (MacExpansions > 0);
974 /* Set a flag so macro expansion will terminate on the next call */
980 Macro* FindMacro (const StrBuf* Name)
981 /* Try to find the macro with the given name and return it. If no macro with
982 * this name was found, return NULL.
985 Macro* M = HT_Find (&MacroTab, Name);
986 return (M != 0 && M->Style == MAC_STYLE_CLASSIC)? M : 0;
991 Macro* FindDefine (const StrBuf* Name)
992 /* Try to find the define style macro with the given name and return it. If no
993 * such macro was found, return NULL.
998 /* Never if disabled */
999 if (DisableDefines) {
1003 /* Check if we have such a macro */
1004 M = HT_Find (&MacroTab, Name);
1005 return (M != 0 && M->Style == MAC_STYLE_DEFINE)? M : 0;
1010 int InMacExpansion (void)
1011 /* Return true if we're currently expanding a macro */
1013 return (MacExpansions > 0);
1018 void DisableDefineStyleMacros (void)
1019 /* Disable define style macros until EnableDefineStyleMacros is called */
1026 void EnableDefineStyleMacros (void)
1027 /* Re-enable define style macros previously disabled with
1028 * DisableDefineStyleMacros.
1031 PRECONDITION (DisableDefines > 0);