1 /* preproc.c macro preprocessor for the Netwide Assembler
3 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
4 * Julian Hall. All rights reserved. The software is
5 * redistributable under the license given in the file "LICENSE"
6 * distributed in the NASM archive.
8 * initial version 18/iii/97 by Simon Tatham
11 /* Typical flow of text through preproc
13 * pp_getline gets tokenized lines, either
15 * from a macro expansion
19 * read_line gets raw text from stdmacpos, or predef, or current input file
20 * tokenize converts to tokens
23 * expand_mmac_params is used to expand %1 etc., unless a macro is being
24 * defined or a false conditional is being processed
25 * (%0, %1, %+1, %-1, %%foo
27 * do_directive checks for directives
29 * expand_smacro is used to expand single line macros
31 * expand_mmacro is used to expand multi-line macros
33 * detoken is used to convert the line back to text
56 typedef struct SMacro SMacro
;
57 typedef struct MMacro MMacro
;
58 typedef struct Context Context
;
59 typedef struct Token Token
;
60 typedef struct Blocks Blocks
;
61 typedef struct Line Line
;
62 typedef struct Include Include
;
63 typedef struct Cond Cond
;
64 typedef struct IncPath IncPath
;
67 * Note on the storage of both SMacro and MMacros: the hash table
68 * indexes them case-insensitively, and we then have to go through a
69 * linked list of potential case aliases (and, for MMacros, parameter
70 * ranges); this is to preserve the matching semantics of the earlier
71 * code. If the number of case aliases for a specific macro is a
72 * performance issue, you may want to reconsider your coding style.
76 * Store the definition of a single-line macro.
88 * Store the definition of a multi-line macro. This is also used to
89 * store the interiors of `%rep...%endrep' blocks, which are
90 * effectively self-re-invoking multi-line macros which simply
91 * don't have a name or bother to appear in the hash tables. %rep
92 * blocks are signified by having a NULL `name' field.
94 * In a MMacro describing a `%rep' block, the `in_progress' field
95 * isn't merely boolean, but gives the number of repeats left to
98 * The `next' field is used for storing MMacros in hash tables; the
99 * `next_active' field is for stacking them on istk entries.
101 * When a MMacro is being expanded, `params', `iline', `nparam',
102 * `paramlen', `rotate' and `unique' are local to the invocation.
107 int nparam_min
, nparam_max
;
109 bool plus
; /* is the last parameter greedy? */
110 bool nolist
; /* is this macro listing-inhibited? */
112 Token
*dlist
; /* All defaults as one list */
113 Token
**defaults
; /* Parameter default pointers */
114 int ndefs
; /* number of default parameters */
118 MMacro
*rep_nest
; /* used for nesting %rep */
119 Token
**params
; /* actual parameters */
120 Token
*iline
; /* invocation line */
121 unsigned int nparam
, rotate
;
124 int lineno
; /* Current line number on expansion */
128 * The context stack is composed of a linked list of these.
133 struct hash_table localmac
;
138 * This is the internal form which we break input lines up into.
139 * Typically stored in linked lists.
141 * Note that `type' serves a double meaning: TOK_SMAC_PARAM is not
142 * necessarily used as-is, but is intended to denote the number of
143 * the substituted parameter. So in the definition
145 * %define a(x,y) ( (x) & ~(y) )
147 * the token representing `x' will have its type changed to
148 * TOK_SMAC_PARAM, but the one representing `y' will be
151 * TOK_INTERNAL_STRING is a dirty hack: it's a single string token
152 * which doesn't need quotes around it. Used in the pre-include
153 * mechanism as an alternative to trying to find a sensible type of
154 * quote to use on the filename we were passed.
157 TOK_NONE
= 0, TOK_WHITESPACE
, TOK_COMMENT
, TOK_ID
,
158 TOK_PREPROC_ID
, TOK_STRING
,
159 TOK_NUMBER
, TOK_FLOAT
, TOK_SMAC_END
, TOK_OTHER
,
161 TOK_PREPROC_Q
, TOK_PREPROC_QQ
,
162 TOK_SMAC_PARAM
, /* MUST BE LAST IN THE LIST!!! */
163 TOK_MAX
= INT_MAX
/* Keep compiler from reducing the range */
170 SMacro
*mac
; /* associated macro for TOK_SMAC_END */
171 size_t len
; /* scratch length field */
172 } a
; /* Auxiliary data */
173 enum pp_token_type type
;
177 * Multi-line macro definitions are stored as a linked list of
178 * these, which is essentially a container to allow several linked
181 * Note that in this module, linked lists are treated as stacks
182 * wherever possible. For this reason, Lines are _pushed_ on to the
183 * `expansion' field in MMacro structures, so that the linked list,
184 * if walked, would give the macro lines in reverse order; this
185 * means that we can walk the list when expanding a macro, and thus
186 * push the lines on to the `expansion' field in _istk_ in reverse
187 * order (so that when popped back off they are in the right
188 * order). It may seem cockeyed, and it relies on my design having
189 * an even number of steps in, but it works...
191 * Some of these structures, rather than being actual lines, are
192 * markers delimiting the end of the expansion of a given macro.
193 * This is for use in the cycle-tracking and %rep-handling code.
194 * Such structures have `finishes' non-NULL, and `first' NULL. All
195 * others have `finishes' NULL, but `first' may still be NULL if
205 * To handle an arbitrary level of file inclusion, we maintain a
206 * stack (ie linked list) of these things.
215 MMacro
*mstk
; /* stack of active macros/reps */
219 * Include search path. This is simply a list of strings which get
220 * prepended, in turn, to the name of an include file, in an
221 * attempt to find the file if it's not in the current directory.
229 * Conditional assembly: we maintain a separate stack of these for
230 * each level of file inclusion. (The only reason we keep the
231 * stacks separate is to ensure that a stray `%endif' in a file
232 * included from within the true branch of a `%if' won't terminate
233 * it and cause confusion: instead, rightly, it'll cause an error.)
241 * These states are for use just after %if or %elif: IF_TRUE
242 * means the condition has evaluated to truth so we are
243 * currently emitting, whereas IF_FALSE means we are not
244 * currently emitting but will start doing so if a %else comes
245 * up. In these states, all directives are admissible: %elif,
246 * %else and %endif. (And of course %if.)
248 COND_IF_TRUE
, COND_IF_FALSE
,
250 * These states come up after a %else: ELSE_TRUE means we're
251 * emitting, and ELSE_FALSE means we're not. In ELSE_* states,
252 * any %elif or %else will cause an error.
254 COND_ELSE_TRUE
, COND_ELSE_FALSE
,
256 * This state means that we're not emitting now, and also that
257 * nothing until %endif will be emitted at all. It's for use in
258 * two circumstances: (i) when we've had our moment of emission
259 * and have now started seeing %elifs, and (ii) when the
260 * condition construct in question is contained within a
261 * non-emitting branch of a larger condition construct.
265 #define emitting(x) ( (x) == COND_IF_TRUE || (x) == COND_ELSE_TRUE )
268 * These defines are used as the possible return values for do_directive
270 #define NO_DIRECTIVE_FOUND 0
271 #define DIRECTIVE_FOUND 1
274 * Condition codes. Note that we use c_ prefix not C_ because C_ is
275 * used in nasm.h for the "real" condition codes. At _this_ level,
276 * we treat CXZ and ECXZ as condition codes, albeit non-invertible
277 * ones, so we need a different enum...
279 static const char * const conditions
[] = {
280 "a", "ae", "b", "be", "c", "cxz", "e", "ecxz", "g", "ge", "l", "le",
281 "na", "nae", "nb", "nbe", "nc", "ne", "ng", "nge", "nl", "nle", "no",
282 "np", "ns", "nz", "o", "p", "pe", "po", "rcxz", "s", "z"
285 c_A
, c_AE
, c_B
, c_BE
, c_C
, c_CXZ
, c_E
, c_ECXZ
, c_G
, c_GE
, c_L
, c_LE
,
286 c_NA
, c_NAE
, c_NB
, c_NBE
, c_NC
, c_NE
, c_NG
, c_NGE
, c_NL
, c_NLE
, c_NO
,
287 c_NP
, c_NS
, c_NZ
, c_O
, c_P
, c_PE
, c_PO
, c_RCXZ
, c_S
, c_Z
,
290 static const enum pp_conds inverse_ccs
[] = {
291 c_NA
, c_NAE
, c_NB
, c_NBE
, c_NC
, -1, c_NE
, -1, c_NG
, c_NGE
, c_NL
, c_NLE
,
292 c_A
, c_AE
, c_B
, c_BE
, c_C
, c_E
, c_G
, c_GE
, c_L
, c_LE
, c_O
, c_P
, c_S
,
293 c_Z
, c_NO
, c_NP
, c_PO
, c_PE
, -1, c_NS
, c_NZ
299 /* If this is a an IF, ELIF, ELSE or ENDIF keyword */
300 static int is_condition(enum preproc_token arg
)
302 return PP_IS_COND(arg
) || (arg
== PP_ELSE
) || (arg
== PP_ENDIF
);
305 /* For TASM compatibility we need to be able to recognise TASM compatible
306 * conditional compilation directives. Using the NASM pre-processor does
307 * not work, so we look for them specifically from the following list and
308 * then jam in the equivalent NASM directive into the input stream.
312 TM_ARG
, TM_ELIF
, TM_ELSE
, TM_ENDIF
, TM_IF
, TM_IFDEF
, TM_IFDIFI
,
313 TM_IFNDEF
, TM_INCLUDE
, TM_LOCAL
316 static const char * const tasm_directives
[] = {
317 "arg", "elif", "else", "endif", "if", "ifdef", "ifdifi",
318 "ifndef", "include", "local"
321 static int StackSize
= 4;
322 static char *StackPointer
= "ebp";
323 static int ArgOffset
= 8;
324 static int LocalOffset
= 0;
326 static Context
*cstk
;
327 static Include
*istk
;
328 static IncPath
*ipath
= NULL
;
330 static efunc _error
; /* Pointer to client-provided error reporting function */
331 static evalfunc evaluate
;
333 static int pass
; /* HACK: pass 0 = generate dependencies only */
334 static StrList
**dephead
, **deptail
; /* Dependency list */
336 static uint64_t unique
; /* unique identifier numbers */
338 static Line
*predef
= NULL
;
339 static bool do_predef
;
341 static ListGen
*list
;
344 * The current set of multi-line macros we have defined.
346 static struct hash_table mmacros
;
349 * The current set of single-line macros we have defined.
351 static struct hash_table smacros
;
354 * The multi-line macro we are currently defining, or the %rep
355 * block we are currently reading, if any.
357 static MMacro
*defining
;
359 static uint64_t nested_mac_count
;
360 static uint64_t nested_rep_count
;
363 * The number of macro parameters to allocate space for at a time.
365 #define PARAM_DELTA 16
368 * The standard macro set: defined in macros.c in the array nasm_stdmac.
369 * This gives our position in the macro set, when we're processing it.
371 static macros_t
*stdmacpos
;
374 * The extra standard macros that come from the object format, if
377 static macros_t
*extrastdmac
= NULL
;
378 static bool any_extrastdmac
;
381 * Tokens are allocated in blocks to improve speed
383 #define TOKEN_BLOCKSIZE 4096
384 static Token
*freeTokens
= NULL
;
390 static Blocks blocks
= { NULL
, NULL
};
393 * Forward declarations.
395 static Token
*expand_mmac_params(Token
* tline
);
396 static Token
*expand_smacro(Token
* tline
);
397 static Token
*expand_id(Token
* tline
);
398 static Context
*get_ctx(const char *name
, bool all_contexts
);
399 static void make_tok_num(Token
* tok
, int64_t val
);
400 static void error(int severity
, const char *fmt
, ...);
401 static void *new_Block(size_t size
);
402 static void delete_Blocks(void);
403 static Token
*new_Token(Token
* next
, enum pp_token_type type
,
404 const char *text
, int txtlen
);
405 static Token
*delete_Token(Token
* t
);
408 * Macros for safe checking of token pointers, avoid *(NULL)
410 #define tok_type_(x,t) ((x) && (x)->type == (t))
411 #define skip_white_(x) if (tok_type_((x), TOK_WHITESPACE)) (x)=(x)->next
412 #define tok_is_(x,v) (tok_type_((x), TOK_OTHER) && !strcmp((x)->text,(v)))
413 #define tok_isnt_(x,v) ((x) && ((x)->type!=TOK_OTHER || strcmp((x)->text,(v))))
415 /* Handle TASM specific directives, which do not contain a % in
416 * front of them. We do it here because I could not find any other
417 * place to do it for the moment, and it is a hack (ideally it would
418 * be nice to be able to use the NASM pre-processor to do it).
420 static char *check_tasm_directive(char *line
)
422 int32_t i
, j
, k
, m
, len
;
423 char *p
= line
, *oldline
, oldchar
;
425 /* Skip whitespace */
426 while (nasm_isspace(*p
) && *p
!= 0)
429 /* Binary search for the directive name */
431 j
= elements(tasm_directives
);
433 while (!nasm_isspace(p
[len
]) && p
[len
] != 0)
440 m
= nasm_stricmp(p
, tasm_directives
[k
]);
442 /* We have found a directive, so jam a % in front of it
443 * so that NASM will then recognise it as one if it's own.
448 line
= nasm_malloc(len
+ 2);
450 if (k
== TM_IFDIFI
) {
451 /* NASM does not recognise IFDIFI, so we convert it to
452 * %ifdef BOGUS. This is not used in NASM comaptible
453 * code, but does need to parse for the TASM macro
456 strcpy(line
+ 1, "ifdef BOGUS");
458 memcpy(line
+ 1, p
, len
+ 1);
473 * The pre-preprocessing stage... This function translates line
474 * number indications as they emerge from GNU cpp (`# lineno "file"
475 * flags') into NASM preprocessor line number indications (`%line
478 static char *prepreproc(char *line
)
481 char *fname
, *oldline
;
483 if (line
[0] == '#' && line
[1] == ' ') {
486 lineno
= atoi(fname
);
487 fname
+= strspn(fname
, "0123456789 ");
490 fnlen
= strcspn(fname
, "\"");
491 line
= nasm_malloc(20 + fnlen
);
492 snprintf(line
, 20 + fnlen
, "%%line %d %.*s", lineno
, fnlen
, fname
);
495 if (tasm_compatible_mode
)
496 return check_tasm_directive(line
);
501 * Free a linked list of tokens.
503 static void free_tlist(Token
* list
)
506 list
= delete_Token(list
);
511 * Free a linked list of lines.
513 static void free_llist(Line
* list
)
519 free_tlist(l
->first
);
527 static void free_mmacro(MMacro
* m
)
530 free_tlist(m
->dlist
);
531 nasm_free(m
->defaults
);
532 free_llist(m
->expansion
);
537 * Free all currently defined macros, and free the hash tables
539 static void free_smacro_table(struct hash_table
*smt
)
543 struct hash_tbl_node
*it
= NULL
;
545 while ((s
= hash_iterate(smt
, &it
, &key
)) != NULL
) {
546 nasm_free((void *)key
);
548 SMacro
*ns
= s
->next
;
550 free_tlist(s
->expansion
);
558 static void free_mmacro_table(struct hash_table
*mmt
)
562 struct hash_tbl_node
*it
= NULL
;
565 while ((m
= hash_iterate(mmt
, &it
, &key
)) != NULL
) {
566 nasm_free((void *)key
);
568 MMacro
*nm
= m
->next
;
576 static void free_macros(void)
578 free_smacro_table(&smacros
);
579 free_mmacro_table(&mmacros
);
583 * Initialize the hash tables
585 static void init_macros(void)
587 hash_init(&smacros
, HASH_LARGE
);
588 hash_init(&mmacros
, HASH_LARGE
);
592 * Pop the context stack.
594 static void ctx_pop(void)
599 free_smacro_table(&c
->localmac
);
605 * Search for a key in the hash index; adding it if necessary
606 * (in which case we initialize the data pointer to NULL.)
609 hash_findi_add(struct hash_table
*hash
, const char *str
)
611 struct hash_insert hi
;
615 r
= hash_findi(hash
, str
, &hi
);
619 strx
= nasm_strdup(str
); /* Use a more efficient allocator here? */
620 return hash_add(&hi
, strx
, NULL
);
624 * Like hash_findi, but returns the data element rather than a pointer
625 * to it. Used only when not adding a new element, hence no third
629 hash_findix(struct hash_table
*hash
, const char *str
)
633 p
= hash_findi(hash
, str
, NULL
);
634 return p
? *p
: NULL
;
637 #define BUF_DELTA 512
639 * Read a line from the top file in istk, handling multiple CR/LFs
640 * at the end of the line read, and handling spurious ^Zs. Will
641 * return lines from the standard macro set if this has not already
644 static char *read_line(void)
646 char *buffer
, *p
, *q
;
647 int bufsize
, continued_count
;
651 const unsigned char *p
= stdmacpos
;
656 len
+= pp_directives_len
[c
-0x80]+1;
660 ret
= nasm_malloc(len
+1);
662 while ((c
= *stdmacpos
++)) {
664 memcpy(q
, pp_directives
[c
-0x80], pp_directives_len
[c
-0x80]);
665 q
+= pp_directives_len
[c
-0x80];
675 /* This was the last of the standard macro chain... */
677 if (any_extrastdmac
) {
678 stdmacpos
= extrastdmac
;
679 any_extrastdmac
= false;
680 } else if (do_predef
) {
682 Token
*head
, **tail
, *t
;
685 * Nasty hack: here we push the contents of
686 * `predef' on to the top-level expansion stack,
687 * since this is the most convenient way to
688 * implement the pre-include and pre-define
691 for (pd
= predef
; pd
; pd
= pd
->next
) {
694 for (t
= pd
->first
; t
; t
= t
->next
) {
695 *tail
= new_Token(NULL
, t
->type
, t
->text
, 0);
696 tail
= &(*tail
)->next
;
698 l
= nasm_malloc(sizeof(Line
));
699 l
->next
= istk
->expansion
;
711 buffer
= nasm_malloc(BUF_DELTA
);
715 q
= fgets(p
, bufsize
- (p
- buffer
), istk
->fp
);
719 if (p
> buffer
&& p
[-1] == '\n') {
720 /* Convert backslash-CRLF line continuation sequences into
721 nothing at all (for DOS and Windows) */
722 if (((p
- 2) > buffer
) && (p
[-3] == '\\') && (p
[-2] == '\r')) {
727 /* Also convert backslash-LF line continuation sequences into
728 nothing at all (for Unix) */
729 else if (((p
- 1) > buffer
) && (p
[-2] == '\\')) {
737 if (p
- buffer
> bufsize
- 10) {
738 int32_t offset
= p
- buffer
;
739 bufsize
+= BUF_DELTA
;
740 buffer
= nasm_realloc(buffer
, bufsize
);
741 p
= buffer
+ offset
; /* prevent stale-pointer problems */
745 if (!q
&& p
== buffer
) {
750 src_set_linnum(src_get_linnum() + istk
->lineinc
+
751 (continued_count
* istk
->lineinc
));
754 * Play safe: remove CRs as well as LFs, if any of either are
755 * present at the end of the line.
757 while (--p
>= buffer
&& (*p
== '\n' || *p
== '\r'))
761 * Handle spurious ^Z, which may be inserted into source files
762 * by some file transfer utilities.
764 buffer
[strcspn(buffer
, "\032")] = '\0';
766 list
->line(LIST_READ
, buffer
);
772 * Tokenize a line of text. This is a very simple process since we
773 * don't need to parse the value out of e.g. numeric tokens: we
774 * simply split one string into many.
776 static Token
*tokenize(char *line
)
779 enum pp_token_type type
;
781 Token
*t
, **tail
= &list
;
787 if (nasm_isdigit(*p
) ||
788 ((*p
== '-' || *p
== '+') && nasm_isdigit(p
[1])) ||
789 ((*p
== '+') && (nasm_isspace(p
[1]) || !p
[1]))) {
793 while (nasm_isdigit(*p
));
794 type
= TOK_PREPROC_ID
;
795 } else if (*p
== '{') {
797 while (*p
&& *p
!= '}') {
804 type
= TOK_PREPROC_ID
;
805 } else if (*p
== '?') {
806 type
= TOK_PREPROC_Q
; /* %? */
809 type
= TOK_PREPROC_QQ
; /* %?? */
812 } else if (isidchar(*p
) ||
813 ((*p
== '!' || *p
== '%' || *p
== '$') &&
818 while (isidchar(*p
));
819 type
= TOK_PREPROC_ID
;
825 } else if (isidstart(*p
) || (*p
== '$' && isidstart(p
[1]))) {
828 while (*p
&& isidchar(*p
))
830 } else if (*p
== '\'' || *p
== '"' || *p
== '`') {
835 p
= nasm_skip_string(p
);
840 error(ERR_WARNING
, "unterminated string");
841 /* Handling unterminated strings by UNV */
844 } else if (isnumstart(*p
)) {
846 bool is_float
= false;
862 if (!is_hex
&& (c
== 'e' || c
== 'E')) {
864 if (*p
== '+' || *p
== '-') {
865 /* e can only be followed by +/- if it is either a
866 prefixed hex number or a floating-point number */
870 } else if (c
== 'H' || c
== 'h' || c
== 'X' || c
== 'x') {
872 } else if (c
== 'P' || c
== 'p') {
874 if (*p
== '+' || *p
== '-')
876 } else if (isnumchar(c
) || c
== '_')
879 /* we need to deal with consequences of the legacy
880 parser, like "1.nolist" being two tokens
881 (TOK_NUMBER, TOK_ID) here; at least give it
882 a shot for now. In the future, we probably need
883 a flex-based scanner with proper pattern matching
884 to do it as well as it can be done. Nothing in
885 the world is going to help the person who wants
886 0x123.p16 interpreted as two tokens, though. */
891 if (nasm_isdigit(*r
) || (is_hex
&& nasm_isxdigit(*r
)) ||
892 (!is_hex
&& (*r
== 'e' || *r
== 'E')) ||
893 (*r
== 'p' || *r
== 'P')) {
897 break; /* Terminate the token */
901 p
--; /* Point to first character beyond number */
903 if (has_e
&& !is_hex
) {
904 /* 1e13 is floating-point, but 1e13h is not */
908 type
= is_float
? TOK_FLOAT
: TOK_NUMBER
;
909 } else if (nasm_isspace(*p
)) {
910 type
= TOK_WHITESPACE
;
912 while (*p
&& nasm_isspace(*p
))
915 * Whitespace just before end-of-line is discarded by
916 * pretending it's a comment; whitespace just before a
917 * comment gets lumped into the comment.
919 if (!*p
|| *p
== ';') {
924 } else if (*p
== ';') {
930 * Anything else is an operator of some kind. We check
931 * for all the double-character operators (>>, <<, //,
932 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
933 * else is a single-character operator.
936 if ((p
[0] == '>' && p
[1] == '>') ||
937 (p
[0] == '<' && p
[1] == '<') ||
938 (p
[0] == '/' && p
[1] == '/') ||
939 (p
[0] == '<' && p
[1] == '=') ||
940 (p
[0] == '>' && p
[1] == '=') ||
941 (p
[0] == '=' && p
[1] == '=') ||
942 (p
[0] == '!' && p
[1] == '=') ||
943 (p
[0] == '<' && p
[1] == '>') ||
944 (p
[0] == '&' && p
[1] == '&') ||
945 (p
[0] == '|' && p
[1] == '|') ||
946 (p
[0] == '^' && p
[1] == '^')) {
952 /* Handling unterminated string by UNV */
955 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
956 t->text[p-line] = *line;
960 if (type
!= TOK_COMMENT
) {
961 *tail
= t
= new_Token(NULL
, type
, line
, p
- line
);
970 * this function allocates a new managed block of memory and
971 * returns a pointer to the block. The managed blocks are
972 * deleted only all at once by the delete_Blocks function.
974 static void *new_Block(size_t size
)
978 /* first, get to the end of the linked list */
981 /* now allocate the requested chunk */
982 b
->chunk
= nasm_malloc(size
);
984 /* now allocate a new block for the next request */
985 b
->next
= nasm_malloc(sizeof(Blocks
));
986 /* and initialize the contents of the new block */
987 b
->next
->next
= NULL
;
988 b
->next
->chunk
= NULL
;
993 * this function deletes all managed blocks of memory
995 static void delete_Blocks(void)
997 Blocks
*a
, *b
= &blocks
;
1000 * keep in mind that the first block, pointed to by blocks
1001 * is a static and not dynamically allocated, so we don't
1006 nasm_free(b
->chunk
);
1015 * this function creates a new Token and passes a pointer to it
1016 * back to the caller. It sets the type and text elements, and
1017 * also the a.mac and next elements to NULL.
1019 static Token
*new_Token(Token
* next
, enum pp_token_type type
,
1020 const char *text
, int txtlen
)
1025 if (freeTokens
== NULL
) {
1026 freeTokens
= (Token
*) new_Block(TOKEN_BLOCKSIZE
* sizeof(Token
));
1027 for (i
= 0; i
< TOKEN_BLOCKSIZE
- 1; i
++)
1028 freeTokens
[i
].next
= &freeTokens
[i
+ 1];
1029 freeTokens
[i
].next
= NULL
;
1032 freeTokens
= t
->next
;
1036 if (type
== TOK_WHITESPACE
|| text
== NULL
) {
1040 txtlen
= strlen(text
);
1041 t
->text
= nasm_malloc(txtlen
+1);
1042 memcpy(t
->text
, text
, txtlen
);
1043 t
->text
[txtlen
] = '\0';
1048 static Token
*delete_Token(Token
* t
)
1050 Token
*next
= t
->next
;
1052 t
->next
= freeTokens
;
1058 * Convert a line of tokens back into text.
1059 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1060 * will be transformed into ..@ctxnum.xxx
1062 static char *detoken(Token
* tlist
, bool expand_locals
)
1070 for (t
= tlist
; t
; t
= t
->next
) {
1071 if (t
->type
== TOK_PREPROC_ID
&& t
->text
[1] == '!') {
1072 char *p
= getenv(t
->text
+ 2);
1075 t
->text
= nasm_strdup(p
);
1079 /* Expand local macros here and not during preprocessing */
1080 if (expand_locals
&&
1081 t
->type
== TOK_PREPROC_ID
&& t
->text
&&
1082 t
->text
[0] == '%' && t
->text
[1] == '$') {
1083 Context
*ctx
= get_ctx(t
->text
, false);
1086 char *p
, *q
= t
->text
+ 2;
1088 q
+= strspn(q
, "$");
1089 snprintf(buffer
, sizeof(buffer
), "..@%"PRIu32
".", ctx
->number
);
1090 p
= nasm_strcat(buffer
, q
);
1095 if (t
->type
== TOK_WHITESPACE
) {
1097 } else if (t
->text
) {
1098 len
+= strlen(t
->text
);
1101 p
= line
= nasm_malloc(len
+ 1);
1102 for (t
= tlist
; t
; t
= t
->next
) {
1103 if (t
->type
== TOK_WHITESPACE
) {
1105 } else if (t
->text
) {
1116 * A scanner, suitable for use by the expression evaluator, which
1117 * operates on a line of Tokens. Expects a pointer to a pointer to
1118 * the first token in the line to be passed in as its private_data
1121 * FIX: This really needs to be unified with stdscan.
1123 static int ppscan(void *private_data
, struct tokenval
*tokval
)
1125 Token
**tlineptr
= private_data
;
1127 char ourcopy
[MAX_KEYWORD
+1], *p
, *r
, *s
;
1131 *tlineptr
= tline
? tline
->next
: NULL
;
1133 while (tline
&& (tline
->type
== TOK_WHITESPACE
||
1134 tline
->type
== TOK_COMMENT
));
1137 return tokval
->t_type
= TOKEN_EOS
;
1139 tokval
->t_charptr
= tline
->text
;
1141 if (tline
->text
[0] == '$' && !tline
->text
[1])
1142 return tokval
->t_type
= TOKEN_HERE
;
1143 if (tline
->text
[0] == '$' && tline
->text
[1] == '$' && !tline
->text
[2])
1144 return tokval
->t_type
= TOKEN_BASE
;
1146 if (tline
->type
== TOK_ID
) {
1147 p
= tokval
->t_charptr
= tline
->text
;
1149 tokval
->t_charptr
++;
1150 return tokval
->t_type
= TOKEN_ID
;
1153 for (r
= p
, s
= ourcopy
; *r
; r
++) {
1154 if (r
>= p
+MAX_KEYWORD
)
1155 return tokval
->t_type
= TOKEN_ID
; /* Not a keyword */
1156 *s
++ = nasm_tolower(*r
);
1159 /* right, so we have an identifier sitting in temp storage. now,
1160 * is it actually a register or instruction name, or what? */
1161 return nasm_token_hash(ourcopy
, tokval
);
1164 if (tline
->type
== TOK_NUMBER
) {
1166 tokval
->t_integer
= readnum(tline
->text
, &rn_error
);
1167 tokval
->t_charptr
= tline
->text
;
1169 return tokval
->t_type
= TOKEN_ERRNUM
;
1171 return tokval
->t_type
= TOKEN_NUM
;
1174 if (tline
->type
== TOK_FLOAT
) {
1175 return tokval
->t_type
= TOKEN_FLOAT
;
1178 if (tline
->type
== TOK_STRING
) {
1181 bq
= tline
->text
[0];
1182 tokval
->t_charptr
= tline
->text
;
1183 tokval
->t_inttwo
= nasm_unquote(tline
->text
, &ep
);
1185 if (ep
[0] != bq
|| ep
[1] != '\0')
1186 return tokval
->t_type
= TOKEN_ERRSTR
;
1188 return tokval
->t_type
= TOKEN_STR
;
1191 if (tline
->type
== TOK_OTHER
) {
1192 if (!strcmp(tline
->text
, "<<"))
1193 return tokval
->t_type
= TOKEN_SHL
;
1194 if (!strcmp(tline
->text
, ">>"))
1195 return tokval
->t_type
= TOKEN_SHR
;
1196 if (!strcmp(tline
->text
, "//"))
1197 return tokval
->t_type
= TOKEN_SDIV
;
1198 if (!strcmp(tline
->text
, "%%"))
1199 return tokval
->t_type
= TOKEN_SMOD
;
1200 if (!strcmp(tline
->text
, "=="))
1201 return tokval
->t_type
= TOKEN_EQ
;
1202 if (!strcmp(tline
->text
, "<>"))
1203 return tokval
->t_type
= TOKEN_NE
;
1204 if (!strcmp(tline
->text
, "!="))
1205 return tokval
->t_type
= TOKEN_NE
;
1206 if (!strcmp(tline
->text
, "<="))
1207 return tokval
->t_type
= TOKEN_LE
;
1208 if (!strcmp(tline
->text
, ">="))
1209 return tokval
->t_type
= TOKEN_GE
;
1210 if (!strcmp(tline
->text
, "&&"))
1211 return tokval
->t_type
= TOKEN_DBL_AND
;
1212 if (!strcmp(tline
->text
, "^^"))
1213 return tokval
->t_type
= TOKEN_DBL_XOR
;
1214 if (!strcmp(tline
->text
, "||"))
1215 return tokval
->t_type
= TOKEN_DBL_OR
;
1219 * We have no other options: just return the first character of
1222 return tokval
->t_type
= tline
->text
[0];
1226 * Compare a string to the name of an existing macro; this is a
1227 * simple wrapper which calls either strcmp or nasm_stricmp
1228 * depending on the value of the `casesense' parameter.
1230 static int mstrcmp(const char *p
, const char *q
, bool casesense
)
1232 return casesense
? strcmp(p
, q
) : nasm_stricmp(p
, q
);
1236 * Compare a string to the name of an existing macro; this is a
1237 * simple wrapper which calls either strcmp or nasm_stricmp
1238 * depending on the value of the `casesense' parameter.
1240 static int mmemcmp(const char *p
, const char *q
, size_t l
, bool casesense
)
1242 return casesense
? memcmp(p
, q
, l
) : nasm_memicmp(p
, q
, l
);
1246 * Return the Context structure associated with a %$ token. Return
1247 * NULL, having _already_ reported an error condition, if the
1248 * context stack isn't deep enough for the supplied number of $
1250 * If all_contexts == true, contexts that enclose current are
1251 * also scanned for such smacro, until it is found; if not -
1252 * only the context that directly results from the number of $'s
1253 * in variable's name.
1255 static Context
*get_ctx(const char *name
, bool all_contexts
)
1261 if (!name
|| name
[0] != '%' || name
[1] != '$')
1265 error(ERR_NONFATAL
, "`%s': context stack is empty", name
);
1269 for (i
= strspn(name
+ 2, "$"), ctx
= cstk
; (i
> 0) && ctx
; i
--) {
1271 /* i--; Lino - 02/25/02 */
1274 error(ERR_NONFATAL
, "`%s': context stack is only"
1275 " %d level%s deep", name
, i
- 1, (i
== 2 ? "" : "s"));
1282 /* Search for this smacro in found context */
1283 m
= hash_findix(&ctx
->localmac
, name
);
1285 if (!mstrcmp(m
->name
, name
, m
->casesense
))
1296 * Check to see if a file is already in a string list
1298 static bool in_list(const StrList
*list
, const char *str
)
1301 if (!strcmp(list
->str
, str
))
1309 * Open an include file. This routine must always return a valid
1310 * file pointer if it returns - it's responsible for throwing an
1311 * ERR_FATAL and bombing out completely if not. It should also try
1312 * the include path one by one until it finds the file or reaches
1313 * the end of the path.
1315 static FILE *inc_fopen(const char *file
, StrList
**dhead
, StrList
***dtail
,
1320 IncPath
*ip
= ipath
;
1321 int len
= strlen(file
);
1322 size_t prefix_len
= 0;
1326 sl
= nasm_malloc(prefix_len
+len
+1+sizeof sl
->next
);
1327 memcpy(sl
->str
, prefix
, prefix_len
);
1328 memcpy(sl
->str
+prefix_len
, file
, len
+1);
1329 fp
= fopen(sl
->str
, "r");
1330 if (fp
&& dhead
&& !in_list(*dhead
, sl
->str
)) {
1348 prefix_len
= strlen(prefix
);
1350 /* -MG given and file not found */
1351 if (dhead
&& !in_list(*dhead
, file
)) {
1352 sl
= nasm_malloc(len
+1+sizeof sl
->next
);
1354 strcpy(sl
->str
, file
);
1362 error(ERR_FATAL
, "unable to open include file `%s'", file
);
1363 return NULL
; /* never reached - placate compilers */
1367 * Determine if we should warn on defining a single-line macro of
1368 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1369 * return true if _any_ single-line macro of that name is defined.
1370 * Otherwise, will return true if a single-line macro with either
1371 * `nparam' or no parameters is defined.
1373 * If a macro with precisely the right number of parameters is
1374 * defined, or nparam is -1, the address of the definition structure
1375 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1376 * is NULL, no action will be taken regarding its contents, and no
1379 * Note that this is also called with nparam zero to resolve
1382 * If you already know which context macro belongs to, you can pass
1383 * the context pointer as first parameter; if you won't but name begins
1384 * with %$ the context will be automatically computed. If all_contexts
1385 * is true, macro will be searched in outer contexts as well.
1388 smacro_defined(Context
* ctx
, const char *name
, int nparam
, SMacro
** defn
,
1391 struct hash_table
*smtbl
;
1395 smtbl
= &ctx
->localmac
;
1396 } else if (name
[0] == '%' && name
[1] == '$') {
1398 ctx
= get_ctx(name
, false);
1400 return false; /* got to return _something_ */
1401 smtbl
= &ctx
->localmac
;
1405 m
= (SMacro
*) hash_findix(smtbl
, name
);
1408 if (!mstrcmp(m
->name
, name
, m
->casesense
&& nocase
) &&
1409 (nparam
<= 0 || m
->nparam
== 0 || nparam
== (int) m
->nparam
)) {
1411 if (nparam
== (int) m
->nparam
|| nparam
== -1)
1425 * Count and mark off the parameters in a multi-line macro call.
1426 * This is called both from within the multi-line macro expansion
1427 * code, and also to mark off the default parameters when provided
1428 * in a %macro definition line.
1430 static void count_mmac_params(Token
* t
, int *nparam
, Token
*** params
)
1432 int paramsize
, brace
;
1434 *nparam
= paramsize
= 0;
1437 if (*nparam
>= paramsize
) {
1438 paramsize
+= PARAM_DELTA
;
1439 *params
= nasm_realloc(*params
, sizeof(**params
) * paramsize
);
1443 if (tok_is_(t
, "{"))
1445 (*params
)[(*nparam
)++] = t
;
1446 while (tok_isnt_(t
, brace
? "}" : ","))
1448 if (t
) { /* got a comma/brace */
1452 * Now we've found the closing brace, look further
1456 if (tok_isnt_(t
, ",")) {
1458 "braces do not enclose all of macro parameter");
1459 while (tok_isnt_(t
, ","))
1463 t
= t
->next
; /* eat the comma */
1470 * Determine whether one of the various `if' conditions is true or
1473 * We must free the tline we get passed.
1475 static bool if_condition(Token
* tline
, enum preproc_token ct
)
1477 enum pp_conditional i
= PP_COND(ct
);
1479 Token
*t
, *tt
, **tptr
, *origline
;
1480 struct tokenval tokval
;
1482 enum pp_token_type needtype
;
1488 j
= false; /* have we matched yet? */
1493 if (tline
->type
!= TOK_ID
) {
1495 "`%s' expects context identifiers", pp_directives
[ct
]);
1496 free_tlist(origline
);
1499 if (cstk
&& cstk
->name
&& !nasm_stricmp(tline
->text
, cstk
->name
))
1501 tline
= tline
->next
;
1506 j
= false; /* have we matched yet? */
1509 if (!tline
|| (tline
->type
!= TOK_ID
&&
1510 (tline
->type
!= TOK_PREPROC_ID
||
1511 tline
->text
[1] != '$'))) {
1513 "`%s' expects macro identifiers", pp_directives
[ct
]);
1516 if (smacro_defined(NULL
, tline
->text
, 0, NULL
, true))
1518 tline
= tline
->next
;
1524 tline
= expand_smacro(tline
);
1526 while (tok_isnt_(tt
, ","))
1530 "`%s' expects two comma-separated arguments",
1535 j
= true; /* assume equality unless proved not */
1536 while ((t
->type
!= TOK_OTHER
|| strcmp(t
->text
, ",")) && tt
) {
1537 if (tt
->type
== TOK_OTHER
&& !strcmp(tt
->text
, ",")) {
1538 error(ERR_NONFATAL
, "`%s': more than one comma on line",
1542 if (t
->type
== TOK_WHITESPACE
) {
1546 if (tt
->type
== TOK_WHITESPACE
) {
1550 if (tt
->type
!= t
->type
) {
1551 j
= false; /* found mismatching tokens */
1554 /* When comparing strings, need to unquote them first */
1555 if (t
->type
== TOK_STRING
) {
1556 size_t l1
= nasm_unquote(t
->text
, NULL
);
1557 size_t l2
= nasm_unquote(tt
->text
, NULL
);
1563 if (mmemcmp(t
->text
, tt
->text
, l1
, i
== PPC_IFIDN
)) {
1567 } else if (mstrcmp(tt
->text
, t
->text
, i
== PPC_IFIDN
) != 0) {
1568 j
= false; /* found mismatching tokens */
1575 if ((t
->type
!= TOK_OTHER
|| strcmp(t
->text
, ",")) || tt
)
1576 j
= false; /* trailing gunk on one end or other */
1582 MMacro searching
, *mmac
;
1584 tline
= tline
->next
;
1586 tline
= expand_id(tline
);
1587 if (!tok_type_(tline
, TOK_ID
)) {
1589 "`%s' expects a macro name", pp_directives
[ct
]);
1592 searching
.name
= nasm_strdup(tline
->text
);
1593 searching
.casesense
= true;
1594 searching
.plus
= false;
1595 searching
.nolist
= false;
1596 searching
.in_progress
= 0;
1597 searching
.rep_nest
= NULL
;
1598 searching
.nparam_min
= 0;
1599 searching
.nparam_max
= INT_MAX
;
1600 tline
= expand_smacro(tline
->next
);
1603 } else if (!tok_type_(tline
, TOK_NUMBER
)) {
1605 "`%s' expects a parameter count or nothing",
1608 searching
.nparam_min
= searching
.nparam_max
=
1609 readnum(tline
->text
, &j
);
1612 "unable to parse parameter count `%s'",
1615 if (tline
&& tok_is_(tline
->next
, "-")) {
1616 tline
= tline
->next
->next
;
1617 if (tok_is_(tline
, "*"))
1618 searching
.nparam_max
= INT_MAX
;
1619 else if (!tok_type_(tline
, TOK_NUMBER
))
1621 "`%s' expects a parameter count after `-'",
1624 searching
.nparam_max
= readnum(tline
->text
, &j
);
1627 "unable to parse parameter count `%s'",
1629 if (searching
.nparam_min
> searching
.nparam_max
)
1631 "minimum parameter count exceeds maximum");
1634 if (tline
&& tok_is_(tline
->next
, "+")) {
1635 tline
= tline
->next
;
1636 searching
.plus
= true;
1638 mmac
= (MMacro
*) hash_findix(&mmacros
, searching
.name
);
1640 if (!strcmp(mmac
->name
, searching
.name
) &&
1641 (mmac
->nparam_min
<= searching
.nparam_max
1643 && (searching
.nparam_min
<= mmac
->nparam_max
1650 nasm_free(searching
.name
);
1659 needtype
= TOK_NUMBER
;
1662 needtype
= TOK_STRING
;
1666 t
= tline
= expand_smacro(tline
);
1668 while (tok_type_(t
, TOK_WHITESPACE
) ||
1669 (needtype
== TOK_NUMBER
&&
1670 tok_type_(t
, TOK_OTHER
) &&
1671 (t
->text
[0] == '-' || t
->text
[0] == '+') &&
1675 j
= tok_type_(t
, needtype
);
1679 t
= tline
= expand_smacro(tline
);
1680 while (tok_type_(t
, TOK_WHITESPACE
))
1685 t
= t
->next
; /* Skip the actual token */
1686 while (tok_type_(t
, TOK_WHITESPACE
))
1688 j
= !t
; /* Should be nothing left */
1693 t
= tline
= expand_smacro(tline
);
1694 while (tok_type_(t
, TOK_WHITESPACE
))
1697 j
= !t
; /* Should be empty */
1701 t
= tline
= expand_smacro(tline
);
1703 tokval
.t_type
= TOKEN_INVALID
;
1704 evalresult
= evaluate(ppscan
, tptr
, &tokval
,
1705 NULL
, pass
| CRITICAL
, error
, NULL
);
1710 "trailing garbage after expression ignored");
1711 if (!is_simple(evalresult
)) {
1713 "non-constant value given to `%s'", pp_directives
[ct
]);
1716 j
= reloc_value(evalresult
) != 0;
1721 "preprocessor directive `%s' not yet implemented",
1726 free_tlist(origline
);
1727 return j
^ PP_NEGATIVE(ct
);
1730 free_tlist(origline
);
1735 * Common code for defining an smacro
1737 static bool define_smacro(Context
*ctx
, char *mname
, bool casesense
,
1738 int nparam
, Token
*expansion
)
1740 SMacro
*smac
, **smhead
;
1741 struct hash_table
*smtbl
;
1743 if (smacro_defined(ctx
, mname
, nparam
, &smac
, casesense
)) {
1746 "single-line macro `%s' defined both with and"
1747 " without parameters", mname
);
1749 /* Some instances of the old code considered this a failure,
1750 some others didn't. What is the right thing to do here? */
1751 free_tlist(expansion
);
1752 return false; /* Failure */
1755 * We're redefining, so we have to take over an
1756 * existing SMacro structure. This means freeing
1757 * what was already in it.
1759 nasm_free(smac
->name
);
1760 free_tlist(smac
->expansion
);
1763 smtbl
= ctx
? &ctx
->localmac
: &smacros
;
1764 smhead
= (SMacro
**) hash_findi_add(smtbl
, mname
);
1765 smac
= nasm_malloc(sizeof(SMacro
));
1766 smac
->next
= *smhead
;
1769 smac
->name
= nasm_strdup(mname
);
1770 smac
->casesense
= casesense
;
1771 smac
->nparam
= nparam
;
1772 smac
->expansion
= expansion
;
1773 smac
->in_progress
= false;
1774 return true; /* Success */
1778 * Undefine an smacro
1780 static void undef_smacro(Context
*ctx
, const char *mname
)
1782 SMacro
**smhead
, *s
, **sp
;
1783 struct hash_table
*smtbl
;
1785 smtbl
= ctx
? &ctx
->localmac
: &smacros
;
1786 smhead
= (SMacro
**)hash_findi(smtbl
, mname
, NULL
);
1790 * We now have a macro name... go hunt for it.
1793 while ((s
= *sp
) != NULL
) {
1794 if (!mstrcmp(s
->name
, mname
, s
->casesense
)) {
1797 free_tlist(s
->expansion
);
1807 * Parse a mmacro specification.
1809 static bool parse_mmacro_spec(Token
*tline
, MMacro
*def
, const char *directive
)
1813 tline
= tline
->next
;
1815 tline
= expand_id(tline
);
1816 if (!tok_type_(tline
, TOK_ID
)) {
1817 error(ERR_NONFATAL
, "`%s' expects a macro name", directive
);
1820 def
->name
= nasm_strdup(tline
->text
);
1822 def
->nolist
= false;
1823 def
->in_progress
= 0;
1824 def
->rep_nest
= NULL
;
1825 tline
= expand_smacro(tline
->next
);
1827 if (!tok_type_(tline
, TOK_NUMBER
)) {
1828 error(ERR_NONFATAL
, "`%s' expects a parameter count", directive
);
1829 def
->nparam_min
= def
->nparam_max
= 0;
1831 def
->nparam_min
= def
->nparam_max
=
1832 readnum(tline
->text
, &err
);
1835 "unable to parse parameter count `%s'", tline
->text
);
1837 if (tline
&& tok_is_(tline
->next
, "-")) {
1838 tline
= tline
->next
->next
;
1839 if (tok_is_(tline
, "*")) {
1840 def
->nparam_max
= INT_MAX
;
1841 } else if (!tok_type_(tline
, TOK_NUMBER
)) {
1843 "`%s' expects a parameter count after `-'", directive
);
1845 def
->nparam_max
= readnum(tline
->text
, &err
);
1847 error(ERR_NONFATAL
, "unable to parse parameter count `%s'",
1850 if (def
->nparam_min
> def
->nparam_max
) {
1851 error(ERR_NONFATAL
, "minimum parameter count exceeds maximum");
1855 if (tline
&& tok_is_(tline
->next
, "+")) {
1856 tline
= tline
->next
;
1859 if (tline
&& tok_type_(tline
->next
, TOK_ID
) &&
1860 !nasm_stricmp(tline
->next
->text
, ".nolist")) {
1861 tline
= tline
->next
;
1866 * Handle default parameters.
1868 if (tline
&& tline
->next
) {
1869 def
->dlist
= tline
->next
;
1871 count_mmac_params(def
->dlist
, &def
->ndefs
, &def
->defaults
);
1874 def
->defaults
= NULL
;
1876 def
->expansion
= NULL
;
1883 * Decode a size directive
1885 static int parse_size(const char *str
) {
1886 static const char *size_names
[] =
1887 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
1888 static const int sizes
[] =
1889 { 0, 1, 4, 16, 8, 10, 2, 32 };
1891 return sizes
[bsii(str
, size_names
, elements(size_names
))+1];
1895 * find and process preprocessor directive in passed line
1896 * Find out if a line contains a preprocessor directive, and deal
1899 * If a directive _is_ found, it is the responsibility of this routine
1900 * (and not the caller) to free_tlist() the line.
1902 * @param tline a pointer to the current tokeninzed line linked list
1903 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
1906 static int do_directive(Token
* tline
)
1908 enum preproc_token i
;
1916 char *p
, *pp
, *mname
;
1920 MMacro
*mmac
, **mmhead
;
1921 Token
*t
, *tt
, *param_start
, *macro_start
, *last
, **tptr
, *origline
;
1923 struct tokenval tokval
;
1925 MMacro
*tmp_defining
; /* Used when manipulating rep_nest */
1932 if (!tline
|| !tok_type_(tline
, TOK_PREPROC_ID
) ||
1933 (tline
->text
[1] == '%' || tline
->text
[1] == '$'
1934 || tline
->text
[1] == '!'))
1935 return NO_DIRECTIVE_FOUND
;
1937 i
= pp_token_hash(tline
->text
);
1940 * If we're in a non-emitting branch of a condition construct,
1941 * or walking to the end of an already terminated %rep block,
1942 * we should ignore all directives except for condition
1945 if (((istk
->conds
&& !emitting(istk
->conds
->state
)) ||
1946 (istk
->mstk
&& !istk
->mstk
->in_progress
)) && !is_condition(i
)) {
1947 return NO_DIRECTIVE_FOUND
;
1951 * If we're defining a macro or reading a %rep block, we should
1952 * ignore all directives except for %macro/%imacro (which nest),
1953 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
1954 * If we're in a %rep block, another %rep nests, so should be let through.
1956 if (defining
&& i
!= PP_MACRO
&& i
!= PP_IMACRO
&&
1957 i
!= PP_ENDMACRO
&& i
!= PP_ENDM
&&
1958 (defining
->name
|| (i
!= PP_ENDREP
&& i
!= PP_REP
))) {
1959 return NO_DIRECTIVE_FOUND
;
1963 if (i
== PP_MACRO
|| i
== PP_IMACRO
) {
1965 return NO_DIRECTIVE_FOUND
;
1966 } else if (nested_mac_count
> 0) {
1967 if (i
== PP_ENDMACRO
) {
1969 return NO_DIRECTIVE_FOUND
;
1972 if (!defining
->name
) {
1975 return NO_DIRECTIVE_FOUND
;
1976 } else if (nested_rep_count
> 0) {
1977 if (i
== PP_ENDREP
) {
1979 return NO_DIRECTIVE_FOUND
;
1987 error(ERR_NONFATAL
, "unknown preprocessor directive `%s'",
1989 return NO_DIRECTIVE_FOUND
; /* didn't get it */
1992 /* Directive to tell NASM what the default stack size is. The
1993 * default is for a 16-bit stack, and this can be overriden with
1995 * the following form:
1997 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
1999 tline
= tline
->next
;
2000 if (tline
&& tline
->type
== TOK_WHITESPACE
)
2001 tline
= tline
->next
;
2002 if (!tline
|| tline
->type
!= TOK_ID
) {
2003 error(ERR_NONFATAL
, "`%%stacksize' missing size parameter");
2004 free_tlist(origline
);
2005 return DIRECTIVE_FOUND
;
2007 if (nasm_stricmp(tline
->text
, "flat") == 0) {
2008 /* All subsequent ARG directives are for a 32-bit stack */
2010 StackPointer
= "ebp";
2013 } else if (nasm_stricmp(tline
->text
, "flat64") == 0) {
2014 /* All subsequent ARG directives are for a 64-bit stack */
2016 StackPointer
= "rbp";
2019 } else if (nasm_stricmp(tline
->text
, "large") == 0) {
2020 /* All subsequent ARG directives are for a 16-bit stack,
2021 * far function call.
2024 StackPointer
= "bp";
2027 } else if (nasm_stricmp(tline
->text
, "small") == 0) {
2028 /* All subsequent ARG directives are for a 16-bit stack,
2029 * far function call. We don't support near functions.
2032 StackPointer
= "bp";
2036 error(ERR_NONFATAL
, "`%%stacksize' invalid size type");
2037 free_tlist(origline
);
2038 return DIRECTIVE_FOUND
;
2040 free_tlist(origline
);
2041 return DIRECTIVE_FOUND
;
2044 /* TASM like ARG directive to define arguments to functions, in
2045 * the following form:
2047 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2051 char *arg
, directive
[256];
2052 int size
= StackSize
;
2054 /* Find the argument name */
2055 tline
= tline
->next
;
2056 if (tline
&& tline
->type
== TOK_WHITESPACE
)
2057 tline
= tline
->next
;
2058 if (!tline
|| tline
->type
!= TOK_ID
) {
2059 error(ERR_NONFATAL
, "`%%arg' missing argument parameter");
2060 free_tlist(origline
);
2061 return DIRECTIVE_FOUND
;
2065 /* Find the argument size type */
2066 tline
= tline
->next
;
2067 if (!tline
|| tline
->type
!= TOK_OTHER
2068 || tline
->text
[0] != ':') {
2070 "Syntax error processing `%%arg' directive");
2071 free_tlist(origline
);
2072 return DIRECTIVE_FOUND
;
2074 tline
= tline
->next
;
2075 if (!tline
|| tline
->type
!= TOK_ID
) {
2076 error(ERR_NONFATAL
, "`%%arg' missing size type parameter");
2077 free_tlist(origline
);
2078 return DIRECTIVE_FOUND
;
2081 /* Allow macro expansion of type parameter */
2082 tt
= tokenize(tline
->text
);
2083 tt
= expand_smacro(tt
);
2084 size
= parse_size(tt
->text
);
2087 "Invalid size type for `%%arg' missing directive");
2089 free_tlist(origline
);
2090 return DIRECTIVE_FOUND
;
2094 /* Round up to even stack slots */
2095 size
= (size
+StackSize
-1) & ~(StackSize
-1);
2097 /* Now define the macro for the argument */
2098 snprintf(directive
, sizeof(directive
), "%%define %s (%s+%d)",
2099 arg
, StackPointer
, offset
);
2100 do_directive(tokenize(directive
));
2103 /* Move to the next argument in the list */
2104 tline
= tline
->next
;
2105 if (tline
&& tline
->type
== TOK_WHITESPACE
)
2106 tline
= tline
->next
;
2107 } while (tline
&& tline
->type
== TOK_OTHER
&& tline
->text
[0] == ',');
2109 free_tlist(origline
);
2110 return DIRECTIVE_FOUND
;
2113 /* TASM like LOCAL directive to define local variables for a
2114 * function, in the following form:
2116 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2118 * The '= LocalSize' at the end is ignored by NASM, but is
2119 * required by TASM to define the local parameter size (and used
2120 * by the TASM macro package).
2122 offset
= LocalOffset
;
2124 char *local
, directive
[256];
2125 int size
= StackSize
;
2127 /* Find the argument name */
2128 tline
= tline
->next
;
2129 if (tline
&& tline
->type
== TOK_WHITESPACE
)
2130 tline
= tline
->next
;
2131 if (!tline
|| tline
->type
!= TOK_ID
) {
2133 "`%%local' missing argument parameter");
2134 free_tlist(origline
);
2135 return DIRECTIVE_FOUND
;
2137 local
= tline
->text
;
2139 /* Find the argument size type */
2140 tline
= tline
->next
;
2141 if (!tline
|| tline
->type
!= TOK_OTHER
2142 || tline
->text
[0] != ':') {
2144 "Syntax error processing `%%local' directive");
2145 free_tlist(origline
);
2146 return DIRECTIVE_FOUND
;
2148 tline
= tline
->next
;
2149 if (!tline
|| tline
->type
!= TOK_ID
) {
2151 "`%%local' missing size type parameter");
2152 free_tlist(origline
);
2153 return DIRECTIVE_FOUND
;
2156 /* Allow macro expansion of type parameter */
2157 tt
= tokenize(tline
->text
);
2158 tt
= expand_smacro(tt
);
2159 size
= parse_size(tt
->text
);
2162 "Invalid size type for `%%local' missing directive");
2164 free_tlist(origline
);
2165 return DIRECTIVE_FOUND
;
2169 /* Round up to even stack slots */
2170 size
= (size
+StackSize
-1) & ~(StackSize
-1);
2172 offset
+= size
; /* Negative offset, increment before */
2174 /* Now define the macro for the argument */
2175 snprintf(directive
, sizeof(directive
), "%%define %s (%s-%d)",
2176 local
, StackPointer
, offset
);
2177 do_directive(tokenize(directive
));
2179 /* Now define the assign to setup the enter_c macro correctly */
2180 snprintf(directive
, sizeof(directive
),
2181 "%%assign %%$localsize %%$localsize+%d", size
);
2182 do_directive(tokenize(directive
));
2184 /* Move to the next argument in the list */
2185 tline
= tline
->next
;
2186 if (tline
&& tline
->type
== TOK_WHITESPACE
)
2187 tline
= tline
->next
;
2188 } while (tline
&& tline
->type
== TOK_OTHER
&& tline
->text
[0] == ',');
2189 LocalOffset
= offset
;
2190 free_tlist(origline
);
2191 return DIRECTIVE_FOUND
;
2195 error(ERR_WARNING
, "trailing garbage after `%%clear' ignored");
2198 free_tlist(origline
);
2199 return DIRECTIVE_FOUND
;
2202 t
= tline
->next
= expand_smacro(tline
->next
);
2204 if (!t
|| (t
->type
!= TOK_STRING
&&
2205 t
->type
!= TOK_INTERNAL_STRING
)) {
2206 error(ERR_NONFATAL
, "`%%depend' expects a file name");
2207 free_tlist(origline
);
2208 return DIRECTIVE_FOUND
; /* but we did _something_ */
2212 "trailing garbage after `%%depend' ignored");
2214 if (t
->type
!= TOK_INTERNAL_STRING
)
2215 nasm_unquote(p
, NULL
);
2216 if (dephead
&& !in_list(*dephead
, p
)) {
2217 StrList
*sl
= nasm_malloc(strlen(p
)+1+sizeof sl
->next
);
2221 deptail
= &sl
->next
;
2223 free_tlist(origline
);
2224 return DIRECTIVE_FOUND
;
2227 t
= tline
->next
= expand_smacro(tline
->next
);
2230 if (!t
|| (t
->type
!= TOK_STRING
&&
2231 t
->type
!= TOK_INTERNAL_STRING
)) {
2232 error(ERR_NONFATAL
, "`%%include' expects a file name");
2233 free_tlist(origline
);
2234 return DIRECTIVE_FOUND
; /* but we did _something_ */
2238 "trailing garbage after `%%include' ignored");
2240 if (t
->type
!= TOK_INTERNAL_STRING
)
2241 nasm_unquote(p
, NULL
);
2242 inc
= nasm_malloc(sizeof(Include
));
2245 inc
->fp
= inc_fopen(p
, dephead
, &deptail
, pass
== 0);
2247 /* -MG given but file not found */
2250 inc
->fname
= src_set_fname(nasm_strdup(p
));
2251 inc
->lineno
= src_set_linnum(0);
2253 inc
->expansion
= NULL
;
2256 list
->uplevel(LIST_INCLUDE
);
2258 free_tlist(origline
);
2259 return DIRECTIVE_FOUND
;
2263 static macros_t
*use_pkg
;
2264 const char *pkg_macro
;
2266 t
= tline
->next
= expand_smacro(tline
->next
);
2269 if (!t
|| (t
->type
!= TOK_STRING
&&
2270 t
->type
!= TOK_INTERNAL_STRING
&&
2271 t
->type
!= TOK_ID
)) {
2272 error(ERR_NONFATAL
, "`%%use' expects a package name");
2273 free_tlist(origline
);
2274 return DIRECTIVE_FOUND
; /* but we did _something_ */
2278 "trailing garbage after `%%use' ignored");
2279 if (t
->type
== TOK_STRING
)
2280 nasm_unquote(t
->text
, NULL
);
2281 use_pkg
= nasm_stdmac_find_package(t
->text
);
2283 error(ERR_NONFATAL
, "unknown `%%use' package: %s", t
->text
);
2284 /* The first string will be <%define>__USE_*__ */
2285 pkg_macro
= (char *)use_pkg
+ 1;
2286 if (!smacro_defined(NULL
, pkg_macro
, 0, NULL
, true)) {
2287 /* Not already included, go ahead and include it */
2288 stdmacpos
= use_pkg
;
2290 free_tlist(origline
);
2291 return DIRECTIVE_FOUND
;
2294 tline
= tline
->next
;
2296 tline
= expand_id(tline
);
2298 if (!tok_type_(tline
, TOK_ID
)) {
2299 error(ERR_NONFATAL
, "`%%push' expects a context identifier");
2300 free_tlist(origline
);
2301 return DIRECTIVE_FOUND
; /* but we did _something_ */
2304 error(ERR_WARNING
, "trailing garbage after `%%push' ignored");
2305 p
= nasm_strdup(tline
->text
);
2307 p
= NULL
; /* Anonymous context */
2309 ctx
= nasm_malloc(sizeof(Context
));
2311 hash_init(&ctx
->localmac
, HASH_SMALL
);
2313 ctx
->number
= unique
++;
2315 free_tlist(origline
);
2316 return DIRECTIVE_FOUND
;
2319 tline
= tline
->next
;
2321 tline
= expand_id(tline
);
2323 if (!tok_type_(tline
, TOK_ID
)) {
2324 error(ERR_NONFATAL
, "`%%repl' expects a context identifier");
2325 free_tlist(origline
);
2326 return DIRECTIVE_FOUND
; /* but we did _something_ */
2329 error(ERR_WARNING
, "trailing garbage after `%%repl' ignored");
2330 p
= nasm_strdup(tline
->text
);
2335 error(ERR_NONFATAL
, "`%%repl': context stack is empty");
2337 nasm_free(cstk
->name
);
2340 free_tlist(origline
);
2341 return DIRECTIVE_FOUND
;
2345 error(ERR_WARNING
, "trailing garbage after `%%pop' ignored");
2347 error(ERR_NONFATAL
, "`%%pop': context stack is already empty");
2350 free_tlist(origline
);
2351 return DIRECTIVE_FOUND
;
2356 int severity
= (i
== PP_ERROR
)
2357 ? ERR_NONFATAL
|ERR_NO_SEVERITY
2358 : ERR_WARNING
|ERR_NO_SEVERITY
;
2360 tline
->next
= expand_smacro(tline
->next
);
2361 tline
= tline
->next
;
2363 t
= tline
? tline
->next
: NULL
;
2365 if (tok_type_(tline
, TOK_STRING
) && !t
) {
2366 /* The line contains only a quoted string */
2368 nasm_unquote(p
, NULL
);
2369 error(severity
, "%s: %s", pp_directives
[i
], p
);
2371 /* Not a quoted string, or more than a quoted string */
2372 p
= detoken(tline
, false);
2373 error(severity
, "%s: %s", pp_directives
[i
], p
);
2376 free_tlist(origline
);
2377 return DIRECTIVE_FOUND
;
2381 if (istk
->conds
&& !emitting(istk
->conds
->state
))
2384 j
= if_condition(tline
->next
, i
);
2385 tline
->next
= NULL
; /* it got freed */
2386 j
= j
< 0 ? COND_NEVER
: j
? COND_IF_TRUE
: COND_IF_FALSE
;
2388 cond
= nasm_malloc(sizeof(Cond
));
2389 cond
->next
= istk
->conds
;
2392 free_tlist(origline
);
2393 return DIRECTIVE_FOUND
;
2397 error(ERR_FATAL
, "`%s': no matching `%%if'", pp_directives
[i
]);
2398 if (emitting(istk
->conds
->state
)
2399 || istk
->conds
->state
== COND_NEVER
)
2400 istk
->conds
->state
= COND_NEVER
;
2403 * IMPORTANT: In the case of %if, we will already have
2404 * called expand_mmac_params(); however, if we're
2405 * processing an %elif we must have been in a
2406 * non-emitting mode, which would have inhibited
2407 * the normal invocation of expand_mmac_params(). Therefore,
2408 * we have to do it explicitly here.
2410 j
= if_condition(expand_mmac_params(tline
->next
), i
);
2411 tline
->next
= NULL
; /* it got freed */
2412 istk
->conds
->state
=
2413 j
< 0 ? COND_NEVER
: j
? COND_IF_TRUE
: COND_IF_FALSE
;
2415 free_tlist(origline
);
2416 return DIRECTIVE_FOUND
;
2420 error(ERR_WARNING
, "trailing garbage after `%%else' ignored");
2422 error(ERR_FATAL
, "`%%else': no matching `%%if'");
2423 if (emitting(istk
->conds
->state
)
2424 || istk
->conds
->state
== COND_NEVER
)
2425 istk
->conds
->state
= COND_ELSE_FALSE
;
2427 istk
->conds
->state
= COND_ELSE_TRUE
;
2428 free_tlist(origline
);
2429 return DIRECTIVE_FOUND
;
2433 error(ERR_WARNING
, "trailing garbage after `%%endif' ignored");
2435 error(ERR_FATAL
, "`%%endif': no matching `%%if'");
2437 istk
->conds
= cond
->next
;
2439 free_tlist(origline
);
2440 return DIRECTIVE_FOUND
;
2446 "`%%%smacro': already defining a macro",
2447 (i
== PP_IMACRO
? "i" : ""));
2448 return DIRECTIVE_FOUND
;
2450 defining
= nasm_malloc(sizeof(MMacro
));
2451 defining
->casesense
= (i
== PP_MACRO
);
2452 if (!parse_mmacro_spec(tline
, defining
, pp_directives
[i
])) {
2453 nasm_free(defining
);
2455 return DIRECTIVE_FOUND
;
2458 mmac
= (MMacro
*) hash_findix(&mmacros
, defining
->name
);
2460 if (!strcmp(mmac
->name
, defining
->name
) &&
2461 (mmac
->nparam_min
<= defining
->nparam_max
2463 && (defining
->nparam_min
<= mmac
->nparam_max
2466 "redefining multi-line macro `%s'", defining
->name
);
2467 return DIRECTIVE_FOUND
;
2471 free_tlist(origline
);
2472 return DIRECTIVE_FOUND
;
2476 if (! (defining
&& defining
->name
)) {
2477 error(ERR_NONFATAL
, "`%s': not defining a macro", tline
->text
);
2478 return DIRECTIVE_FOUND
;
2480 mmhead
= (MMacro
**) hash_findi_add(&mmacros
, defining
->name
);
2481 defining
->next
= *mmhead
;
2484 free_tlist(origline
);
2485 return DIRECTIVE_FOUND
;
2493 spec
.casesense
= (i
== PP_UNMACRO
);
2494 if (!parse_mmacro_spec(tline
, &spec
, pp_directives
[i
])) {
2495 return DIRECTIVE_FOUND
;
2497 mmac_p
= (MMacro
**) hash_findi(&mmacros
, spec
.name
, NULL
);
2498 while (mmac_p
&& *mmac_p
) {
2500 if (mmac
->casesense
== spec
.casesense
&&
2501 !mstrcmp(mmac
->name
, spec
.name
, spec
.casesense
) &&
2502 mmac
->nparam_min
== spec
.nparam_min
&&
2503 mmac
->nparam_max
== spec
.nparam_max
&&
2504 mmac
->plus
== spec
.plus
) {
2505 *mmac_p
= mmac
->next
;
2508 mmac_p
= &mmac
->next
;
2511 free_tlist(origline
);
2512 free_tlist(spec
.dlist
);
2513 return DIRECTIVE_FOUND
;
2517 if (tline
->next
&& tline
->next
->type
== TOK_WHITESPACE
)
2518 tline
= tline
->next
;
2519 if (tline
->next
== NULL
) {
2520 free_tlist(origline
);
2521 error(ERR_NONFATAL
, "`%%rotate' missing rotate count");
2522 return DIRECTIVE_FOUND
;
2524 t
= expand_smacro(tline
->next
);
2526 free_tlist(origline
);
2529 tokval
.t_type
= TOKEN_INVALID
;
2531 evaluate(ppscan
, tptr
, &tokval
, NULL
, pass
, error
, NULL
);
2534 return DIRECTIVE_FOUND
;
2537 "trailing garbage after expression ignored");
2538 if (!is_simple(evalresult
)) {
2539 error(ERR_NONFATAL
, "non-constant value given to `%%rotate'");
2540 return DIRECTIVE_FOUND
;
2543 while (mmac
&& !mmac
->name
) /* avoid mistaking %reps for macros */
2544 mmac
= mmac
->next_active
;
2546 error(ERR_NONFATAL
, "`%%rotate' invoked outside a macro call");
2547 } else if (mmac
->nparam
== 0) {
2549 "`%%rotate' invoked within macro without parameters");
2551 int rotate
= mmac
->rotate
+ reloc_value(evalresult
);
2553 rotate
%= (int)mmac
->nparam
;
2555 rotate
+= mmac
->nparam
;
2557 mmac
->rotate
= rotate
;
2559 return DIRECTIVE_FOUND
;
2564 tline
= tline
->next
;
2565 } while (tok_type_(tline
, TOK_WHITESPACE
));
2567 if (tok_type_(tline
, TOK_ID
) &&
2568 nasm_stricmp(tline
->text
, ".nolist") == 0) {
2571 tline
= tline
->next
;
2572 } while (tok_type_(tline
, TOK_WHITESPACE
));
2576 t
= expand_smacro(tline
);
2578 tokval
.t_type
= TOKEN_INVALID
;
2580 evaluate(ppscan
, tptr
, &tokval
, NULL
, pass
, error
, NULL
);
2582 free_tlist(origline
);
2583 return DIRECTIVE_FOUND
;
2587 "trailing garbage after expression ignored");
2588 if (!is_simple(evalresult
)) {
2589 error(ERR_NONFATAL
, "non-constant value given to `%%rep'");
2590 return DIRECTIVE_FOUND
;
2592 count
= reloc_value(evalresult
) + 1;
2594 error(ERR_NONFATAL
, "`%%rep' expects a repeat count");
2597 free_tlist(origline
);
2599 tmp_defining
= defining
;
2600 defining
= nasm_malloc(sizeof(MMacro
));
2601 defining
->name
= NULL
; /* flags this macro as a %rep block */
2602 defining
->casesense
= false;
2603 defining
->plus
= false;
2604 defining
->nolist
= nolist
;
2605 defining
->in_progress
= count
;
2606 defining
->nparam_min
= defining
->nparam_max
= 0;
2607 defining
->defaults
= NULL
;
2608 defining
->dlist
= NULL
;
2609 defining
->expansion
= NULL
;
2610 defining
->next_active
= istk
->mstk
;
2611 defining
->rep_nest
= tmp_defining
;
2612 return DIRECTIVE_FOUND
;
2615 if (!defining
|| defining
->name
) {
2616 error(ERR_NONFATAL
, "`%%endrep': no matching `%%rep'");
2617 return DIRECTIVE_FOUND
;
2621 * Now we have a "macro" defined - although it has no name
2622 * and we won't be entering it in the hash tables - we must
2623 * push a macro-end marker for it on to istk->expansion.
2624 * After that, it will take care of propagating itself (a
2625 * macro-end marker line for a macro which is really a %rep
2626 * block will cause the macro to be re-expanded, complete
2627 * with another macro-end marker to ensure the process
2628 * continues) until the whole expansion is forcibly removed
2629 * from istk->expansion by a %exitrep.
2631 l
= nasm_malloc(sizeof(Line
));
2632 l
->next
= istk
->expansion
;
2633 l
->finishes
= defining
;
2635 istk
->expansion
= l
;
2637 istk
->mstk
= defining
;
2639 list
->uplevel(defining
->nolist
? LIST_MACRO_NOLIST
: LIST_MACRO
);
2640 tmp_defining
= defining
;
2641 defining
= defining
->rep_nest
;
2642 free_tlist(origline
);
2643 return DIRECTIVE_FOUND
;
2647 * We must search along istk->expansion until we hit a
2648 * macro-end marker for a macro with no name. Then we set
2649 * its `in_progress' flag to 0.
2651 for (l
= istk
->expansion
; l
; l
= l
->next
)
2652 if (l
->finishes
&& !l
->finishes
->name
)
2653 return DIRECTIVE_FOUND
;
2656 l
->finishes
->in_progress
= 1;
2658 error(ERR_NONFATAL
, "`%%exitrep' not within `%%rep' block");
2659 free_tlist(origline
);
2660 return DIRECTIVE_FOUND
;
2666 casesense
= (i
== PP_DEFINE
|| i
== PP_XDEFINE
);
2668 tline
= tline
->next
;
2670 tline
= expand_id(tline
);
2671 if (!tline
|| (tline
->type
!= TOK_ID
&&
2672 (tline
->type
!= TOK_PREPROC_ID
||
2673 tline
->text
[1] != '$'))) {
2674 error(ERR_NONFATAL
, "`%s' expects a macro identifier",
2676 free_tlist(origline
);
2677 return DIRECTIVE_FOUND
;
2680 ctx
= get_ctx(tline
->text
, false);
2682 mname
= tline
->text
;
2684 param_start
= tline
= tline
->next
;
2687 /* Expand the macro definition now for %xdefine and %ixdefine */
2688 if ((i
== PP_XDEFINE
) || (i
== PP_IXDEFINE
))
2689 tline
= expand_smacro(tline
);
2691 if (tok_is_(tline
, "(")) {
2693 * This macro has parameters.
2696 tline
= tline
->next
;
2700 error(ERR_NONFATAL
, "parameter identifier expected");
2701 free_tlist(origline
);
2702 return DIRECTIVE_FOUND
;
2704 if (tline
->type
!= TOK_ID
) {
2706 "`%s': parameter identifier expected",
2708 free_tlist(origline
);
2709 return DIRECTIVE_FOUND
;
2711 tline
->type
= TOK_SMAC_PARAM
+ nparam
++;
2712 tline
= tline
->next
;
2714 if (tok_is_(tline
, ",")) {
2715 tline
= tline
->next
;
2718 if (!tok_is_(tline
, ")")) {
2720 "`)' expected to terminate macro template");
2721 free_tlist(origline
);
2722 return DIRECTIVE_FOUND
;
2724 return DIRECTIVE_FOUND
;
2727 tline
= tline
->next
;
2729 if (tok_type_(tline
, TOK_WHITESPACE
))
2730 last
= tline
, tline
= tline
->next
;
2735 if (t
->type
== TOK_ID
) {
2736 for (tt
= param_start
; tt
; tt
= tt
->next
)
2737 if (tt
->type
>= TOK_SMAC_PARAM
&&
2738 !strcmp(tt
->text
, t
->text
))
2742 t
->next
= macro_start
;
2747 * Good. We now have a macro name, a parameter count, and a
2748 * token list (in reverse order) for an expansion. We ought
2749 * to be OK just to create an SMacro, store it, and let
2750 * free_tlist have the rest of the line (which we have
2751 * carefully re-terminated after chopping off the expansion
2754 define_smacro(ctx
, mname
, casesense
, nparam
, macro_start
);
2755 free_tlist(origline
);
2756 return DIRECTIVE_FOUND
;
2759 tline
= tline
->next
;
2761 tline
= expand_id(tline
);
2762 if (!tline
|| (tline
->type
!= TOK_ID
&&
2763 (tline
->type
!= TOK_PREPROC_ID
||
2764 tline
->text
[1] != '$'))) {
2765 error(ERR_NONFATAL
, "`%%undef' expects a macro identifier");
2766 free_tlist(origline
);
2767 return DIRECTIVE_FOUND
;
2771 "trailing garbage after macro name ignored");
2774 /* Find the context that symbol belongs to */
2775 ctx
= get_ctx(tline
->text
, false);
2776 undef_smacro(ctx
, tline
->text
);
2777 free_tlist(origline
);
2778 return DIRECTIVE_FOUND
;
2782 casesense
= (i
== PP_DEFSTR
);
2784 tline
= tline
->next
;
2786 tline
= expand_id(tline
);
2787 if (!tline
|| (tline
->type
!= TOK_ID
&&
2788 (tline
->type
!= TOK_PREPROC_ID
||
2789 tline
->text
[1] != '$'))) {
2790 error(ERR_NONFATAL
, "`%s' expects a macro identifier",
2792 free_tlist(origline
);
2793 return DIRECTIVE_FOUND
;
2796 ctx
= get_ctx(tline
->text
, false);
2798 mname
= tline
->text
;
2800 tline
= expand_smacro(tline
->next
);
2803 while (tok_type_(tline
, TOK_WHITESPACE
))
2804 tline
= delete_Token(tline
);
2806 p
= detoken(tline
, false);
2807 macro_start
= nasm_malloc(sizeof(*macro_start
));
2808 macro_start
->next
= NULL
;
2809 macro_start
->text
= nasm_quote(p
, strlen(p
));
2810 macro_start
->type
= TOK_STRING
;
2811 macro_start
->a
.mac
= NULL
;
2815 * We now have a macro name, an implicit parameter count of
2816 * zero, and a string token to use as an expansion. Create
2817 * and store an SMacro.
2819 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
2820 free_tlist(origline
);
2821 return DIRECTIVE_FOUND
;
2826 StrList
*xsl
= NULL
;
2827 StrList
**xst
= &xsl
;
2831 tline
= tline
->next
;
2833 tline
= expand_id(tline
);
2834 if (!tline
|| (tline
->type
!= TOK_ID
&&
2835 (tline
->type
!= TOK_PREPROC_ID
||
2836 tline
->text
[1] != '$'))) {
2838 "`%%pathsearch' expects a macro identifier as first parameter");
2839 free_tlist(origline
);
2840 return DIRECTIVE_FOUND
;
2842 ctx
= get_ctx(tline
->text
, false);
2844 mname
= tline
->text
;
2846 tline
= expand_smacro(tline
->next
);
2850 while (tok_type_(t
, TOK_WHITESPACE
))
2853 if (!t
|| (t
->type
!= TOK_STRING
&&
2854 t
->type
!= TOK_INTERNAL_STRING
)) {
2855 error(ERR_NONFATAL
, "`%%pathsearch' expects a file name");
2857 free_tlist(origline
);
2858 return DIRECTIVE_FOUND
; /* but we did _something_ */
2862 "trailing garbage after `%%pathsearch' ignored");
2864 if (t
->type
!= TOK_INTERNAL_STRING
)
2865 nasm_unquote(p
, NULL
);
2867 fp
= inc_fopen(p
, &xsl
, &xst
, true);
2870 fclose(fp
); /* Don't actually care about the file */
2872 macro_start
= nasm_malloc(sizeof(*macro_start
));
2873 macro_start
->next
= NULL
;
2874 macro_start
->text
= nasm_quote(p
, strlen(p
));
2875 macro_start
->type
= TOK_STRING
;
2876 macro_start
->a
.mac
= NULL
;
2881 * We now have a macro name, an implicit parameter count of
2882 * zero, and a string token to use as an expansion. Create
2883 * and store an SMacro.
2885 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
2887 free_tlist(origline
);
2888 return DIRECTIVE_FOUND
;
2894 tline
= tline
->next
;
2896 tline
= expand_id(tline
);
2897 if (!tline
|| (tline
->type
!= TOK_ID
&&
2898 (tline
->type
!= TOK_PREPROC_ID
||
2899 tline
->text
[1] != '$'))) {
2901 "`%%strlen' expects a macro identifier as first parameter");
2902 free_tlist(origline
);
2903 return DIRECTIVE_FOUND
;
2905 ctx
= get_ctx(tline
->text
, false);
2907 mname
= tline
->text
;
2909 tline
= expand_smacro(tline
->next
);
2913 while (tok_type_(t
, TOK_WHITESPACE
))
2915 /* t should now point to the string */
2916 if (t
->type
!= TOK_STRING
) {
2918 "`%%strlen` requires string as second parameter");
2920 free_tlist(origline
);
2921 return DIRECTIVE_FOUND
;
2924 macro_start
= nasm_malloc(sizeof(*macro_start
));
2925 macro_start
->next
= NULL
;
2926 make_tok_num(macro_start
, nasm_unquote(t
->text
, NULL
));
2927 macro_start
->a
.mac
= NULL
;
2930 * We now have a macro name, an implicit parameter count of
2931 * zero, and a numeric token to use as an expansion. Create
2932 * and store an SMacro.
2934 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
2936 free_tlist(origline
);
2937 return DIRECTIVE_FOUND
;
2942 tline
= tline
->next
;
2944 tline
= expand_id(tline
);
2945 if (!tline
|| (tline
->type
!= TOK_ID
&&
2946 (tline
->type
!= TOK_PREPROC_ID
||
2947 tline
->text
[1] != '$'))) {
2949 "`%%strcat' expects a macro identifier as first parameter");
2950 free_tlist(origline
);
2951 return DIRECTIVE_FOUND
;
2953 ctx
= get_ctx(tline
->text
, false);
2955 mname
= tline
->text
;
2957 tline
= expand_smacro(tline
->next
);
2961 for (t
= tline
; t
; t
= t
->next
) {
2963 case TOK_WHITESPACE
:
2966 len
+= t
->a
.len
= nasm_unquote(t
->text
, NULL
);
2969 if (!strcmp(t
->text
, ",")) /* permit comma separators */
2971 /* else fall through */
2974 "non-string passed to `%%strcat' (%d)", t
->type
);
2976 free_tlist(origline
);
2977 return DIRECTIVE_FOUND
;
2981 p
= pp
= nasm_malloc(len
);
2983 for (t
= tline
; t
; t
= t
->next
) {
2984 if (t
->type
== TOK_STRING
) {
2985 memcpy(p
, t
->text
, t
->a
.len
);
2991 * We now have a macro name, an implicit parameter count of
2992 * zero, and a numeric token to use as an expansion. Create
2993 * and store an SMacro.
2995 macro_start
= new_Token(NULL
, TOK_STRING
, NULL
, 0);
2996 macro_start
->text
= nasm_quote(pp
, len
);
2998 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
3000 free_tlist(origline
);
3001 return DIRECTIVE_FOUND
;
3010 tline
= tline
->next
;
3012 tline
= expand_id(tline
);
3013 if (!tline
|| (tline
->type
!= TOK_ID
&&
3014 (tline
->type
!= TOK_PREPROC_ID
||
3015 tline
->text
[1] != '$'))) {
3017 "`%%substr' expects a macro identifier as first parameter");
3018 free_tlist(origline
);
3019 return DIRECTIVE_FOUND
;
3021 ctx
= get_ctx(tline
->text
, false);
3023 mname
= tline
->text
;
3025 tline
= expand_smacro(tline
->next
);
3029 while (tok_type_(t
, TOK_WHITESPACE
))
3032 /* t should now point to the string */
3033 if (t
->type
!= TOK_STRING
) {
3035 "`%%substr` requires string as second parameter");
3037 free_tlist(origline
);
3038 return DIRECTIVE_FOUND
;
3043 tokval
.t_type
= TOKEN_INVALID
;
3044 evalresult
= evaluate(ppscan
, tptr
, &tokval
, NULL
,
3048 free_tlist(origline
);
3049 return DIRECTIVE_FOUND
;
3050 } else if (!is_simple(evalresult
)) {
3051 error(ERR_NONFATAL
, "non-constant value given to `%%substr`");
3053 free_tlist(origline
);
3054 return DIRECTIVE_FOUND
;
3056 a1
= evalresult
->value
-1;
3058 while (tok_type_(tt
, TOK_WHITESPACE
))
3061 a2
= 1; /* Backwards compatibility: one character */
3063 tokval
.t_type
= TOKEN_INVALID
;
3064 evalresult
= evaluate(ppscan
, tptr
, &tokval
, NULL
,
3068 free_tlist(origline
);
3069 return DIRECTIVE_FOUND
;
3070 } else if (!is_simple(evalresult
)) {
3071 error(ERR_NONFATAL
, "non-constant value given to `%%substr`");
3073 free_tlist(origline
);
3074 return DIRECTIVE_FOUND
;
3076 a2
= evalresult
->value
;
3079 len
= nasm_unquote(t
->text
, NULL
);
3082 if (a1
+a2
> (int64_t)len
)
3085 macro_start
= nasm_malloc(sizeof(*macro_start
));
3086 macro_start
->next
= NULL
;
3087 macro_start
->text
= nasm_quote((a1
< 0) ? "" : t
->text
+a1
, a2
);
3088 macro_start
->type
= TOK_STRING
;
3089 macro_start
->a
.mac
= NULL
;
3092 * We now have a macro name, an implicit parameter count of
3093 * zero, and a numeric token to use as an expansion. Create
3094 * and store an SMacro.
3096 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
3098 free_tlist(origline
);
3099 return DIRECTIVE_FOUND
;
3104 casesense
= (i
== PP_ASSIGN
);
3106 tline
= tline
->next
;
3108 tline
= expand_id(tline
);
3109 if (!tline
|| (tline
->type
!= TOK_ID
&&
3110 (tline
->type
!= TOK_PREPROC_ID
||
3111 tline
->text
[1] != '$'))) {
3113 "`%%%sassign' expects a macro identifier",
3114 (i
== PP_IASSIGN
? "i" : ""));
3115 free_tlist(origline
);
3116 return DIRECTIVE_FOUND
;
3118 ctx
= get_ctx(tline
->text
, false);
3120 mname
= tline
->text
;
3122 tline
= expand_smacro(tline
->next
);
3127 tokval
.t_type
= TOKEN_INVALID
;
3129 evaluate(ppscan
, tptr
, &tokval
, NULL
, pass
, error
, NULL
);
3132 free_tlist(origline
);
3133 return DIRECTIVE_FOUND
;
3138 "trailing garbage after expression ignored");
3140 if (!is_simple(evalresult
)) {
3142 "non-constant value given to `%%%sassign'",
3143 (i
== PP_IASSIGN
? "i" : ""));
3144 free_tlist(origline
);
3145 return DIRECTIVE_FOUND
;
3148 macro_start
= nasm_malloc(sizeof(*macro_start
));
3149 macro_start
->next
= NULL
;
3150 make_tok_num(macro_start
, reloc_value(evalresult
));
3151 macro_start
->a
.mac
= NULL
;
3154 * We now have a macro name, an implicit parameter count of
3155 * zero, and a numeric token to use as an expansion. Create
3156 * and store an SMacro.
3158 define_smacro(ctx
, mname
, casesense
, 0, macro_start
);
3159 free_tlist(origline
);
3160 return DIRECTIVE_FOUND
;
3164 * Syntax is `%line nnn[+mmm] [filename]'
3166 tline
= tline
->next
;
3168 if (!tok_type_(tline
, TOK_NUMBER
)) {
3169 error(ERR_NONFATAL
, "`%%line' expects line number");
3170 free_tlist(origline
);
3171 return DIRECTIVE_FOUND
;
3173 k
= readnum(tline
->text
, &err
);
3175 tline
= tline
->next
;
3176 if (tok_is_(tline
, "+")) {
3177 tline
= tline
->next
;
3178 if (!tok_type_(tline
, TOK_NUMBER
)) {
3179 error(ERR_NONFATAL
, "`%%line' expects line increment");
3180 free_tlist(origline
);
3181 return DIRECTIVE_FOUND
;
3183 m
= readnum(tline
->text
, &err
);
3184 tline
= tline
->next
;
3190 nasm_free(src_set_fname(detoken(tline
, false)));
3192 free_tlist(origline
);
3193 return DIRECTIVE_FOUND
;
3197 "preprocessor directive `%s' not yet implemented",
3199 return DIRECTIVE_FOUND
;
3204 * Ensure that a macro parameter contains a condition code and
3205 * nothing else. Return the condition code index if so, or -1
3208 static int find_cc(Token
* t
)
3214 return -1; /* Probably a %+ without a space */
3217 if (t
->type
!= TOK_ID
)
3221 if (tt
&& (tt
->type
!= TOK_OTHER
|| strcmp(tt
->text
, ",")))
3225 j
= elements(conditions
);
3228 m
= nasm_stricmp(t
->text
, conditions
[k
]);
3244 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3245 * %-n) and MMacro-local identifiers (%%foo).
3247 static Token
*expand_mmac_params(Token
* tline
)
3249 Token
*t
, *tt
, **tail
, *thead
;
3255 if (tline
->type
== TOK_PREPROC_ID
&&
3256 (((tline
->text
[1] == '+' || tline
->text
[1] == '-')
3257 && tline
->text
[2]) || tline
->text
[1] == '%'
3258 || (tline
->text
[1] >= '0' && tline
->text
[1] <= '9'))) {
3260 int type
= 0, cc
; /* type = 0 to placate optimisers */
3267 tline
= tline
->next
;
3270 while (mac
&& !mac
->name
) /* avoid mistaking %reps for macros */
3271 mac
= mac
->next_active
;
3273 error(ERR_NONFATAL
, "`%s': not in a macro call", t
->text
);
3275 switch (t
->text
[1]) {
3277 * We have to make a substitution of one of the
3278 * forms %1, %-1, %+1, %%foo, %0.
3282 snprintf(tmpbuf
, sizeof(tmpbuf
), "%d", mac
->nparam
);
3283 text
= nasm_strdup(tmpbuf
);
3287 snprintf(tmpbuf
, sizeof(tmpbuf
), "..@%"PRIu64
".",
3289 text
= nasm_strcat(tmpbuf
, t
->text
+ 2);
3292 n
= atoi(t
->text
+ 2) - 1;
3293 if (n
>= mac
->nparam
)
3296 if (mac
->nparam
> 1)
3297 n
= (n
+ mac
->rotate
) % mac
->nparam
;
3298 tt
= mac
->params
[n
];
3303 "macro parameter %d is not a condition code",
3308 if (inverse_ccs
[cc
] == -1) {
3310 "condition code `%s' is not invertible",
3315 nasm_strdup(conditions
[inverse_ccs
[cc
]]);
3319 n
= atoi(t
->text
+ 2) - 1;
3320 if (n
>= mac
->nparam
)
3323 if (mac
->nparam
> 1)
3324 n
= (n
+ mac
->rotate
) % mac
->nparam
;
3325 tt
= mac
->params
[n
];
3330 "macro parameter %d is not a condition code",
3335 text
= nasm_strdup(conditions
[cc
]);
3339 n
= atoi(t
->text
+ 1) - 1;
3340 if (n
>= mac
->nparam
)
3343 if (mac
->nparam
> 1)
3344 n
= (n
+ mac
->rotate
) % mac
->nparam
;
3345 tt
= mac
->params
[n
];
3348 for (i
= 0; i
< mac
->paramlen
[n
]; i
++) {
3349 *tail
= new_Token(NULL
, tt
->type
, tt
->text
, 0);
3350 tail
= &(*tail
)->next
;
3354 text
= NULL
; /* we've done it here */
3370 tline
= tline
->next
;
3377 for (; t
&& (tt
= t
->next
) != NULL
; t
= t
->next
)
3379 case TOK_WHITESPACE
:
3380 if (tt
->type
== TOK_WHITESPACE
) {
3381 t
->next
= delete_Token(tt
);
3385 if (tt
->type
== TOK_ID
|| tt
->type
== TOK_NUMBER
) {
3386 char *tmp
= nasm_strcat(t
->text
, tt
->text
);
3389 t
->next
= delete_Token(tt
);
3393 if (tt
->type
== TOK_NUMBER
) {
3394 char *tmp
= nasm_strcat(t
->text
, tt
->text
);
3397 t
->next
= delete_Token(tt
);
3408 * Expand all single-line macro calls made in the given line.
3409 * Return the expanded version of the line. The original is deemed
3410 * to be destroyed in the process. (In reality we'll just move
3411 * Tokens from input to output a lot of the time, rather than
3412 * actually bothering to destroy and replicate.)
3414 #define DEADMAN_LIMIT (1 << 20)
3416 static Token
*expand_smacro(Token
* tline
)
3418 Token
*t
, *tt
, *mstart
, **tail
, *thead
;
3419 struct hash_table
*smtbl
;
3420 SMacro
*head
= NULL
, *m
;
3423 unsigned int nparam
, sparam
;
3424 int brackets
, rescan
;
3425 Token
*org_tline
= tline
;
3428 int deadman
= DEADMAN_LIMIT
;
3431 * Trick: we should avoid changing the start token pointer since it can
3432 * be contained in "next" field of other token. Because of this
3433 * we allocate a copy of first token and work with it; at the end of
3434 * routine we copy it back
3438 new_Token(org_tline
->next
, org_tline
->type
, org_tline
->text
,
3440 tline
->a
.mac
= org_tline
->a
.mac
;
3441 nasm_free(org_tline
->text
);
3442 org_tline
->text
= NULL
;
3449 while (tline
) { /* main token loop */
3451 error(ERR_NONFATAL
, "interminable macro recursion");
3455 if ((mname
= tline
->text
)) {
3456 /* if this token is a local macro, look in local context */
3459 if (tline
->type
== TOK_ID
|| tline
->type
== TOK_PREPROC_ID
) {
3460 ctx
= get_ctx(mname
, true);
3462 smtbl
= &ctx
->localmac
;
3464 head
= (SMacro
*) hash_findix(smtbl
, mname
);
3467 * We've hit an identifier. As in is_mmacro below, we first
3468 * check whether the identifier is a single-line macro at
3469 * all, then think about checking for parameters if
3472 for (m
= head
; m
; m
= m
->next
)
3473 if (!mstrcmp(m
->name
, mname
, m
->casesense
))
3479 if (m
->nparam
== 0) {
3481 * Simple case: the macro is parameterless. Discard the
3482 * one token that the macro call took, and push the
3483 * expansion back on the to-do stack.
3485 if (!m
->expansion
) {
3486 if (!strcmp("__FILE__", m
->name
)) {
3489 src_get(&num
, &file
);
3490 tline
->text
= nasm_quote(file
, strlen(file
));
3491 tline
->type
= TOK_STRING
;
3495 if (!strcmp("__LINE__", m
->name
)) {
3496 nasm_free(tline
->text
);
3497 make_tok_num(tline
, src_get_linnum());
3500 if (!strcmp("__BITS__", m
->name
)) {
3501 nasm_free(tline
->text
);
3502 make_tok_num(tline
, globalbits
);
3505 tline
= delete_Token(tline
);
3510 * Complicated case: at least one macro with this name
3511 * exists and takes parameters. We must find the
3512 * parameters in the call, count them, find the SMacro
3513 * that corresponds to that form of the macro call, and
3514 * substitute for the parameters when we expand. What a
3517 /*tline = tline->next;
3518 skip_white_(tline); */
3521 while (tok_type_(t
, TOK_SMAC_END
)) {
3522 t
->a
.mac
->in_progress
= false;
3524 t
= tline
->next
= delete_Token(t
);
3527 } while (tok_type_(tline
, TOK_WHITESPACE
));
3528 if (!tok_is_(tline
, "(")) {
3530 * This macro wasn't called with parameters: ignore
3531 * the call. (Behaviour borrowed from gnu cpp.)
3540 sparam
= PARAM_DELTA
;
3541 params
= nasm_malloc(sparam
* sizeof(Token
*));
3542 params
[0] = tline
->next
;
3543 paramsize
= nasm_malloc(sparam
* sizeof(int));
3545 while (true) { /* parameter loop */
3547 * For some unusual expansions
3548 * which concatenates function call
3551 while (tok_type_(t
, TOK_SMAC_END
)) {
3552 t
->a
.mac
->in_progress
= false;
3554 t
= tline
->next
= delete_Token(t
);
3560 "macro call expects terminating `)'");
3563 if (tline
->type
== TOK_WHITESPACE
3565 if (paramsize
[nparam
])
3568 params
[nparam
] = tline
->next
;
3569 continue; /* parameter loop */
3571 if (tline
->type
== TOK_OTHER
3572 && tline
->text
[1] == 0) {
3573 char ch
= tline
->text
[0];
3574 if (ch
== ',' && !paren
&& brackets
<= 0) {
3575 if (++nparam
>= sparam
) {
3576 sparam
+= PARAM_DELTA
;
3577 params
= nasm_realloc(params
,
3582 nasm_realloc(paramsize
,
3586 params
[nparam
] = tline
->next
;
3587 paramsize
[nparam
] = 0;
3589 continue; /* parameter loop */
3592 (brackets
> 0 || (brackets
== 0 &&
3593 !paramsize
[nparam
])))
3595 if (!(brackets
++)) {
3596 params
[nparam
] = tline
->next
;
3597 continue; /* parameter loop */
3600 if (ch
== '}' && brackets
> 0)
3601 if (--brackets
== 0) {
3603 continue; /* parameter loop */
3605 if (ch
== '(' && !brackets
)
3607 if (ch
== ')' && brackets
<= 0)
3613 error(ERR_NONFATAL
, "braces do not "
3614 "enclose all of macro parameter");
3616 paramsize
[nparam
] += white
+ 1;
3618 } /* parameter loop */
3620 while (m
&& (m
->nparam
!= nparam
||
3621 mstrcmp(m
->name
, mname
,
3625 error(ERR_WARNING
| ERR_WARN_MNP
,
3626 "macro `%s' exists, "
3627 "but not taking %d parameters",
3628 mstart
->text
, nparam
);
3631 if (m
&& m
->in_progress
)
3633 if (!m
) { /* in progess or didn't find '(' or wrong nparam */
3635 * Design question: should we handle !tline, which
3636 * indicates missing ')' here, or expand those
3637 * macros anyway, which requires the (t) test a few
3641 nasm_free(paramsize
);
3645 * Expand the macro: we are placed on the last token of the
3646 * call, so that we can easily split the call from the
3647 * following tokens. We also start by pushing an SMAC_END
3648 * token for the cycle removal.
3655 tt
= new_Token(tline
, TOK_SMAC_END
, NULL
, 0);
3657 m
->in_progress
= true;
3659 for (t
= m
->expansion
; t
; t
= t
->next
) {
3660 if (t
->type
>= TOK_SMAC_PARAM
) {
3661 Token
*pcopy
= tline
, **ptail
= &pcopy
;
3665 ttt
= params
[t
->type
- TOK_SMAC_PARAM
];
3666 for (i
= paramsize
[t
->type
- TOK_SMAC_PARAM
];
3669 new_Token(tline
, ttt
->type
, ttt
->text
,
3675 } else if (t
->type
== TOK_PREPROC_Q
) {
3676 tt
= new_Token(tline
, TOK_ID
, mname
, 0);
3678 } else if (t
->type
== TOK_PREPROC_QQ
) {
3679 tt
= new_Token(tline
, TOK_ID
, m
->name
, 0);
3682 tt
= new_Token(tline
, t
->type
, t
->text
, 0);
3688 * Having done that, get rid of the macro call, and clean
3689 * up the parameters.
3692 nasm_free(paramsize
);
3694 continue; /* main token loop */
3699 if (tline
->type
== TOK_SMAC_END
) {
3700 tline
->a
.mac
->in_progress
= false;
3701 tline
= delete_Token(tline
);
3704 tline
= tline
->next
;
3712 * Now scan the entire line and look for successive TOK_IDs that resulted
3713 * after expansion (they can't be produced by tokenize()). The successive
3714 * TOK_IDs should be concatenated.
3715 * Also we look for %+ tokens and concatenate the tokens before and after
3716 * them (without white spaces in between).
3721 while (t
&& t
->type
!= TOK_ID
&& t
->type
!= TOK_PREPROC_ID
)
3725 if (t
->next
->type
== TOK_ID
||
3726 t
->next
->type
== TOK_PREPROC_ID
||
3727 t
->next
->type
== TOK_NUMBER
) {
3728 char *p
= nasm_strcat(t
->text
, t
->next
->text
);
3730 t
->next
= delete_Token(t
->next
);
3733 } else if (t
->next
->type
== TOK_WHITESPACE
&& t
->next
->next
&&
3734 t
->next
->next
->type
== TOK_PREPROC_ID
&&
3735 strcmp(t
->next
->next
->text
, "%+") == 0) {
3736 /* free the next whitespace, the %+ token and next whitespace */
3738 for (i
= 1; i
<= 3; i
++) {
3740 || (i
!= 2 && t
->next
->type
!= TOK_WHITESPACE
))
3742 t
->next
= delete_Token(t
->next
);
3747 /* If we concatenaded something, re-scan the line for macros */
3755 *org_tline
= *thead
;
3756 /* since we just gave text to org_line, don't free it */
3758 delete_Token(thead
);
3760 /* the expression expanded to empty line;
3761 we can't return NULL for some reasons
3762 we just set the line to a single WHITESPACE token. */
3763 memset(org_tline
, 0, sizeof(*org_tline
));
3764 org_tline
->text
= NULL
;
3765 org_tline
->type
= TOK_WHITESPACE
;
3774 * Similar to expand_smacro but used exclusively with macro identifiers
3775 * right before they are fetched in. The reason is that there can be
3776 * identifiers consisting of several subparts. We consider that if there
3777 * are more than one element forming the name, user wants a expansion,
3778 * otherwise it will be left as-is. Example:
3782 * the identifier %$abc will be left as-is so that the handler for %define
3783 * will suck it and define the corresponding value. Other case:
3785 * %define _%$abc cde
3787 * In this case user wants name to be expanded *before* %define starts
3788 * working, so we'll expand %$abc into something (if it has a value;
3789 * otherwise it will be left as-is) then concatenate all successive
3792 static Token
*expand_id(Token
* tline
)
3794 Token
*cur
, *oldnext
= NULL
;
3796 if (!tline
|| !tline
->next
)
3801 (cur
->next
->type
== TOK_ID
||
3802 cur
->next
->type
== TOK_PREPROC_ID
3803 || cur
->next
->type
== TOK_NUMBER
))
3806 /* If identifier consists of just one token, don't expand */
3811 oldnext
= cur
->next
; /* Detach the tail past identifier */
3812 cur
->next
= NULL
; /* so that expand_smacro stops here */
3815 tline
= expand_smacro(tline
);
3818 /* expand_smacro possibly changhed tline; re-scan for EOL */
3820 while (cur
&& cur
->next
)
3823 cur
->next
= oldnext
;
3830 * Determine whether the given line constitutes a multi-line macro
3831 * call, and return the MMacro structure called if so. Doesn't have
3832 * to check for an initial label - that's taken care of in
3833 * expand_mmacro - but must check numbers of parameters. Guaranteed
3834 * to be called with tline->type == TOK_ID, so the putative macro
3835 * name is easy to find.
3837 static MMacro
*is_mmacro(Token
* tline
, Token
*** params_array
)
3843 head
= (MMacro
*) hash_findix(&mmacros
, tline
->text
);
3846 * Efficiency: first we see if any macro exists with the given
3847 * name. If not, we can return NULL immediately. _Then_ we
3848 * count the parameters, and then we look further along the
3849 * list if necessary to find the proper MMacro.
3851 for (m
= head
; m
; m
= m
->next
)
3852 if (!mstrcmp(m
->name
, tline
->text
, m
->casesense
))
3858 * OK, we have a potential macro. Count and demarcate the
3861 count_mmac_params(tline
->next
, &nparam
, ¶ms
);
3864 * So we know how many parameters we've got. Find the MMacro
3865 * structure that handles this number.
3868 if (m
->nparam_min
<= nparam
3869 && (m
->plus
|| nparam
<= m
->nparam_max
)) {
3871 * This one is right. Just check if cycle removal
3872 * prohibits us using it before we actually celebrate...
3874 if (m
->in_progress
) {
3877 "self-reference in multi-line macro `%s'", m
->name
);
3883 * It's right, and we can use it. Add its default
3884 * parameters to the end of our list if necessary.
3886 if (m
->defaults
&& nparam
< m
->nparam_min
+ m
->ndefs
) {
3888 nasm_realloc(params
,
3889 ((m
->nparam_min
+ m
->ndefs
+
3890 1) * sizeof(*params
)));
3891 while (nparam
< m
->nparam_min
+ m
->ndefs
) {
3892 params
[nparam
] = m
->defaults
[nparam
- m
->nparam_min
];
3897 * If we've gone over the maximum parameter count (and
3898 * we're in Plus mode), ignore parameters beyond
3901 if (m
->plus
&& nparam
> m
->nparam_max
)
3902 nparam
= m
->nparam_max
;
3904 * Then terminate the parameter list, and leave.
3906 if (!params
) { /* need this special case */
3907 params
= nasm_malloc(sizeof(*params
));
3910 params
[nparam
] = NULL
;
3911 *params_array
= params
;
3915 * This one wasn't right: look for the next one with the
3918 for (m
= m
->next
; m
; m
= m
->next
)
3919 if (!mstrcmp(m
->name
, tline
->text
, m
->casesense
))
3924 * After all that, we didn't find one with the right number of
3925 * parameters. Issue a warning, and fail to expand the macro.
3927 error(ERR_WARNING
| ERR_WARN_MNP
,
3928 "macro `%s' exists, but not taking %d parameters",
3929 tline
->text
, nparam
);
3935 * Expand the multi-line macro call made by the given line, if
3936 * there is one to be expanded. If there is, push the expansion on
3937 * istk->expansion and return 1. Otherwise return 0.
3939 static int expand_mmacro(Token
* tline
)
3941 Token
*startline
= tline
;
3942 Token
*label
= NULL
;
3943 int dont_prepend
= 0;
3944 Token
**params
, *t
, *mtok
, *tt
;
3947 int i
, nparam
, *paramlen
;
3952 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
3953 if (!tok_type_(t
, TOK_ID
) && !tok_type_(t
, TOK_PREPROC_ID
))
3956 m
= is_mmacro(t
, ¶ms
);
3962 * We have an id which isn't a macro call. We'll assume
3963 * it might be a label; we'll also check to see if a
3964 * colon follows it. Then, if there's another id after
3965 * that lot, we'll check it again for macro-hood.
3969 if (tok_type_(t
, TOK_WHITESPACE
))
3970 last
= t
, t
= t
->next
;
3971 if (tok_is_(t
, ":")) {
3973 last
= t
, t
= t
->next
;
3974 if (tok_type_(t
, TOK_WHITESPACE
))
3975 last
= t
, t
= t
->next
;
3977 if (!tok_type_(t
, TOK_ID
) || (m
= is_mmacro(t
, ¶ms
)) == NULL
)
3985 * Fix up the parameters: this involves stripping leading and
3986 * trailing whitespace, then stripping braces if they are
3989 for (nparam
= 0; params
[nparam
]; nparam
++) ;
3990 paramlen
= nparam
? nasm_malloc(nparam
* sizeof(*paramlen
)) : NULL
;
3992 for (i
= 0; params
[i
]; i
++) {
3994 int comma
= (!m
->plus
|| i
< nparam
- 1);
3998 if (tok_is_(t
, "{"))
3999 t
= t
->next
, brace
= true, comma
= false;
4003 if (comma
&& t
->type
== TOK_OTHER
&& !strcmp(t
->text
, ","))
4004 break; /* ... because we have hit a comma */
4005 if (comma
&& t
->type
== TOK_WHITESPACE
4006 && tok_is_(t
->next
, ","))
4007 break; /* ... or a space then a comma */
4008 if (brace
&& t
->type
== TOK_OTHER
&& !strcmp(t
->text
, "}"))
4009 break; /* ... or a brace */
4016 * OK, we have a MMacro structure together with a set of
4017 * parameters. We must now go through the expansion and push
4018 * copies of each Line on to istk->expansion. Substitution of
4019 * parameter tokens and macro-local tokens doesn't get done
4020 * until the single-line macro substitution process; this is
4021 * because delaying them allows us to change the semantics
4022 * later through %rotate.
4024 * First, push an end marker on to istk->expansion, mark this
4025 * macro as in progress, and set up its invocation-specific
4028 ll
= nasm_malloc(sizeof(Line
));
4029 ll
->next
= istk
->expansion
;
4032 istk
->expansion
= ll
;
4034 m
->in_progress
= true;
4039 m
->paramlen
= paramlen
;
4040 m
->unique
= unique
++;
4043 m
->next_active
= istk
->mstk
;
4046 for (l
= m
->expansion
; l
; l
= l
->next
) {
4049 ll
= nasm_malloc(sizeof(Line
));
4050 ll
->finishes
= NULL
;
4051 ll
->next
= istk
->expansion
;
4052 istk
->expansion
= ll
;
4055 for (t
= l
->first
; t
; t
= t
->next
) {
4059 tt
= *tail
= new_Token(NULL
, TOK_ID
, mname
, 0);
4061 case TOK_PREPROC_QQ
:
4062 tt
= *tail
= new_Token(NULL
, TOK_ID
, m
->name
, 0);
4064 case TOK_PREPROC_ID
:
4065 if (t
->text
[1] == '0' && t
->text
[2] == '0') {
4073 tt
= *tail
= new_Token(NULL
, x
->type
, x
->text
, 0);
4082 * If we had a label, push it on as the first line of
4083 * the macro expansion.
4086 if (dont_prepend
< 0)
4087 free_tlist(startline
);
4089 ll
= nasm_malloc(sizeof(Line
));
4090 ll
->finishes
= NULL
;
4091 ll
->next
= istk
->expansion
;
4092 istk
->expansion
= ll
;
4093 ll
->first
= startline
;
4094 if (!dont_prepend
) {
4096 label
= label
->next
;
4097 label
->next
= tt
= new_Token(NULL
, TOK_OTHER
, ":", 0);
4102 list
->uplevel(m
->nolist
? LIST_MACRO_NOLIST
: LIST_MACRO
);
4108 * Since preprocessor always operate only on the line that didn't
4109 * arrived yet, we should always use ERR_OFFBY1. Also since user
4110 * won't want to see same error twice (preprocessing is done once
4111 * per pass) we will want to show errors only during pass one.
4113 static void error(int severity
, const char *fmt
, ...)
4118 /* If we're in a dead branch of IF or something like it, ignore the error */
4119 if (istk
&& istk
->conds
&& !emitting(istk
->conds
->state
))
4123 vsnprintf(buff
, sizeof(buff
), fmt
, arg
);
4126 if (istk
&& istk
->mstk
&& istk
->mstk
->name
)
4127 _error(severity
| ERR_PASS1
, "(%s:%d) %s", istk
->mstk
->name
,
4128 istk
->mstk
->lineno
, buff
);
4130 _error(severity
| ERR_PASS1
, "%s", buff
);
4134 pp_reset(char *file
, int apass
, efunc errfunc
, evalfunc eval
,
4135 ListGen
* listgen
, StrList
**deplist
)
4139 istk
= nasm_malloc(sizeof(Include
));
4142 istk
->expansion
= NULL
;
4144 istk
->fp
= fopen(file
, "r");
4146 src_set_fname(nasm_strdup(file
));
4150 error(ERR_FATAL
| ERR_NOFILE
, "unable to open input file `%s'",
4153 nested_mac_count
= 0;
4154 nested_rep_count
= 0;
4157 if (tasm_compatible_mode
) {
4158 stdmacpos
= nasm_stdmac
;
4160 stdmacpos
= nasm_stdmac_after_tasm
;
4162 any_extrastdmac
= extrastdmac
&& *extrastdmac
;
4167 dephead
= deptail
= deplist
;
4169 StrList
*sl
= nasm_malloc(strlen(file
)+1+sizeof sl
->next
);
4171 strcpy(sl
->str
, file
);
4173 deptail
= &sl
->next
;
4177 static char *pp_getline(void)
4184 * Fetch a tokenized line, either from the macro-expansion
4185 * buffer or from the input file.
4188 while (istk
->expansion
&& istk
->expansion
->finishes
) {
4189 Line
*l
= istk
->expansion
;
4190 if (!l
->finishes
->name
&& l
->finishes
->in_progress
> 1) {
4194 * This is a macro-end marker for a macro with no
4195 * name, which means it's not really a macro at all
4196 * but a %rep block, and the `in_progress' field is
4197 * more than 1, meaning that we still need to
4198 * repeat. (1 means the natural last repetition; 0
4199 * means termination by %exitrep.) We have
4200 * therefore expanded up to the %endrep, and must
4201 * push the whole block on to the expansion buffer
4202 * again. We don't bother to remove the macro-end
4203 * marker: we'd only have to generate another one
4206 l
->finishes
->in_progress
--;
4207 for (l
= l
->finishes
->expansion
; l
; l
= l
->next
) {
4208 Token
*t
, *tt
, **tail
;
4210 ll
= nasm_malloc(sizeof(Line
));
4211 ll
->next
= istk
->expansion
;
4212 ll
->finishes
= NULL
;
4216 for (t
= l
->first
; t
; t
= t
->next
) {
4217 if (t
->text
|| t
->type
== TOK_WHITESPACE
) {
4219 new_Token(NULL
, t
->type
, t
->text
, 0);
4224 istk
->expansion
= ll
;
4228 * Check whether a `%rep' was started and not ended
4229 * within this macro expansion. This can happen and
4230 * should be detected. It's a fatal error because
4231 * I'm too confused to work out how to recover
4237 "defining with name in expansion");
4238 else if (istk
->mstk
->name
)
4240 "`%%rep' without `%%endrep' within"
4241 " expansion of macro `%s'",
4246 * FIXME: investigate the relationship at this point between
4247 * istk->mstk and l->finishes
4250 MMacro
*m
= istk
->mstk
;
4251 istk
->mstk
= m
->next_active
;
4254 * This was a real macro call, not a %rep, and
4255 * therefore the parameter information needs to
4258 nasm_free(m
->params
);
4259 free_tlist(m
->iline
);
4260 nasm_free(m
->paramlen
);
4261 l
->finishes
->in_progress
= false;
4265 istk
->expansion
= l
->next
;
4267 list
->downlevel(LIST_MACRO
);
4270 while (1) { /* until we get a line we can use */
4272 if (istk
->expansion
) { /* from a macro expansion */
4274 Line
*l
= istk
->expansion
;
4276 istk
->mstk
->lineno
++;
4278 istk
->expansion
= l
->next
;
4280 p
= detoken(tline
, false);
4281 list
->line(LIST_MACRO
, p
);
4286 if (line
) { /* from the current input file */
4287 line
= prepreproc(line
);
4288 tline
= tokenize(line
);
4293 * The current file has ended; work down the istk
4300 "expected `%%endif' before end of file");
4301 /* only set line and file name if there's a next node */
4303 src_set_linnum(i
->lineno
);
4304 nasm_free(src_set_fname(i
->fname
));
4307 list
->downlevel(LIST_INCLUDE
);
4315 * We must expand MMacro parameters and MMacro-local labels
4316 * _before_ we plunge into directive processing, to cope
4317 * with things like `%define something %1' such as STRUC
4318 * uses. Unless we're _defining_ a MMacro, in which case
4319 * those tokens should be left alone to go into the
4320 * definition; and unless we're in a non-emitting
4321 * condition, in which case we don't want to meddle with
4324 if (!defining
&& !(istk
->conds
&& !emitting(istk
->conds
->state
))
4325 && !(istk
->mstk
&& !istk
->mstk
->in_progress
))
4326 tline
= expand_mmac_params(tline
);
4329 * Check the line to see if it's a preprocessor directive.
4331 if (do_directive(tline
) == DIRECTIVE_FOUND
) {
4333 } else if (defining
) {
4335 * We're defining a multi-line macro. We emit nothing
4337 * shove the tokenized line on to the macro definition.
4339 Line
*l
= nasm_malloc(sizeof(Line
));
4340 l
->next
= defining
->expansion
;
4343 defining
->expansion
= l
;
4345 } else if (istk
->conds
&& !emitting(istk
->conds
->state
)) {
4347 * We're in a non-emitting branch of a condition block.
4348 * Emit nothing at all, not even a blank line: when we
4349 * emerge from the condition we'll give a line-number
4350 * directive so we keep our place correctly.
4354 } else if (istk
->mstk
&& !istk
->mstk
->in_progress
) {
4356 * We're in a %rep block which has been terminated, so
4357 * we're walking through to the %endrep without
4358 * emitting anything. Emit nothing at all, not even a
4359 * blank line: when we emerge from the %rep block we'll
4360 * give a line-number directive so we keep our place
4366 tline
= expand_smacro(tline
);
4367 if (!expand_mmacro(tline
)) {
4369 * De-tokenize the line again, and emit it.
4371 line
= detoken(tline
, true);
4375 continue; /* expand_mmacro calls free_tlist */
4383 static void pp_cleanup(int pass
)
4386 if(defining
->name
) {
4388 "end of file while still defining macro `%s'",
4391 error(ERR_NONFATAL
, "end of file while still in %%rep");
4394 free_mmacro(defining
);
4403 nasm_free(i
->fname
);
4408 nasm_free(src_set_fname(NULL
));
4413 while ((i
= ipath
)) {
4422 void pp_include_path(char *path
)
4426 i
= nasm_malloc(sizeof(IncPath
));
4427 i
->path
= path
? nasm_strdup(path
) : NULL
;
4430 if (ipath
!= NULL
) {
4432 while (j
->next
!= NULL
)
4440 void pp_pre_include(char *fname
)
4442 Token
*inc
, *space
, *name
;
4445 name
= new_Token(NULL
, TOK_INTERNAL_STRING
, fname
, 0);
4446 space
= new_Token(name
, TOK_WHITESPACE
, NULL
, 0);
4447 inc
= new_Token(space
, TOK_PREPROC_ID
, "%include", 0);
4449 l
= nasm_malloc(sizeof(Line
));
4456 void pp_pre_define(char *definition
)
4462 equals
= strchr(definition
, '=');
4463 space
= new_Token(NULL
, TOK_WHITESPACE
, NULL
, 0);
4464 def
= new_Token(space
, TOK_PREPROC_ID
, "%define", 0);
4467 space
->next
= tokenize(definition
);
4471 l
= nasm_malloc(sizeof(Line
));
4478 void pp_pre_undefine(char *definition
)
4483 space
= new_Token(NULL
, TOK_WHITESPACE
, NULL
, 0);
4484 def
= new_Token(space
, TOK_PREPROC_ID
, "%undef", 0);
4485 space
->next
= tokenize(definition
);
4487 l
= nasm_malloc(sizeof(Line
));
4495 * Added by Keith Kanios:
4497 * This function is used to assist with "runtime" preprocessor
4498 * directives. (e.g. pp_runtime("%define __BITS__ 64");)
4500 * ERRORS ARE IGNORED HERE, SO MAKE COMPLETELY SURE THAT YOU
4501 * PASS A VALID STRING TO THIS FUNCTION!!!!!
4504 void pp_runtime(char *definition
)
4508 def
= tokenize(definition
);
4509 if(do_directive(def
) == NO_DIRECTIVE_FOUND
)
4514 void pp_extra_stdmac(macros_t
*macros
)
4516 extrastdmac
= macros
;
4519 static void make_tok_num(Token
* tok
, int64_t val
)
4522 snprintf(numbuf
, sizeof(numbuf
), "%"PRId64
"", val
);
4523 tok
->text
= nasm_strdup(numbuf
);
4524 tok
->type
= TOK_NUMBER
;