assemble: avoid redundant repetition in RESx warning message
[nasm.git] / preproc.c
blobfdb9fc197cf2e11c01897f84639b7b674dcae4c6
1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2016 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
9 * conditions are met:
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * ----------------------------------------------------------------------- */
35 * preproc.c macro preprocessor for the Netwide Assembler
38 /* Typical flow of text through preproc
40 * pp_getline gets tokenized lines, either
42 * from a macro expansion
44 * or
45 * {
46 * read_line gets raw text from stdmacpos, or predef, or current input file
47 * tokenize converts to tokens
48 * }
50 * expand_mmac_params is used to expand %1 etc., unless a macro is being
51 * defined or a false conditional is being processed
52 * (%0, %1, %+1, %-1, %%foo
54 * do_directive checks for directives
56 * expand_smacro is used to expand single line macros
58 * expand_mmacro is used to expand multi-line macros
60 * detoken is used to convert the line back to text
63 #include "compiler.h"
65 #include <stdio.h>
66 #include <stdarg.h>
67 #include <stdlib.h>
68 #include <stddef.h>
69 #include <string.h>
70 #include <ctype.h>
71 #include <limits.h>
72 #include <inttypes.h>
74 #include "nasm.h"
75 #include "nasmlib.h"
76 #include "preproc.h"
77 #include "hashtbl.h"
78 #include "quote.h"
79 #include "stdscan.h"
80 #include "eval.h"
81 #include "tokens.h"
82 #include "tables.h"
83 #include "listing.h"
85 typedef struct SMacro SMacro;
86 typedef struct MMacro MMacro;
87 typedef struct MMacroInvocation MMacroInvocation;
88 typedef struct Context Context;
89 typedef struct Token Token;
90 typedef struct Blocks Blocks;
91 typedef struct Line Line;
92 typedef struct Include Include;
93 typedef struct Cond Cond;
94 typedef struct IncPath IncPath;
97 * Note on the storage of both SMacro and MMacros: the hash table
98 * indexes them case-insensitively, and we then have to go through a
99 * linked list of potential case aliases (and, for MMacros, parameter
100 * ranges); this is to preserve the matching semantics of the earlier
101 * code. If the number of case aliases for a specific macro is a
102 * performance issue, you may want to reconsider your coding style.
106 * Store the definition of a single-line macro.
108 struct SMacro {
109 SMacro *next;
110 char *name;
111 bool casesense;
112 bool in_progress;
113 unsigned int nparam;
114 Token *expansion;
118 * Store the definition of a multi-line macro. This is also used to
119 * store the interiors of `%rep...%endrep' blocks, which are
120 * effectively self-re-invoking multi-line macros which simply
121 * don't have a name or bother to appear in the hash tables. %rep
122 * blocks are signified by having a NULL `name' field.
124 * In a MMacro describing a `%rep' block, the `in_progress' field
125 * isn't merely boolean, but gives the number of repeats left to
126 * run.
128 * The `next' field is used for storing MMacros in hash tables; the
129 * `next_active' field is for stacking them on istk entries.
131 * When a MMacro is being expanded, `params', `iline', `nparam',
132 * `paramlen', `rotate' and `unique' are local to the invocation.
134 struct MMacro {
135 MMacro *next;
136 MMacroInvocation *prev; /* previous invocation */
137 char *name;
138 int nparam_min, nparam_max;
139 bool casesense;
140 bool plus; /* is the last parameter greedy? */
141 bool nolist; /* is this macro listing-inhibited? */
142 int64_t in_progress; /* is this macro currently being expanded? */
143 int32_t max_depth; /* maximum number of recursive expansions allowed */
144 Token *dlist; /* All defaults as one list */
145 Token **defaults; /* Parameter default pointers */
146 int ndefs; /* number of default parameters */
147 Line *expansion;
149 MMacro *next_active;
150 MMacro *rep_nest; /* used for nesting %rep */
151 Token **params; /* actual parameters */
152 Token *iline; /* invocation line */
153 unsigned int nparam, rotate;
154 int *paramlen;
155 uint64_t unique;
156 int lineno; /* Current line number on expansion */
157 uint64_t condcnt; /* number of if blocks... */
159 const char *fname; /* File where defined */
160 int32_t xline; /* First line in macro */
164 /* Store the definition of a multi-line macro, as defined in a
165 * previous recursive macro expansion.
167 struct MMacroInvocation {
168 MMacroInvocation *prev; /* previous invocation */
169 Token **params; /* actual parameters */
170 Token *iline; /* invocation line */
171 unsigned int nparam, rotate;
172 int *paramlen;
173 uint64_t unique;
174 uint64_t condcnt;
179 * The context stack is composed of a linked list of these.
181 struct Context {
182 Context *next;
183 char *name;
184 struct hash_table localmac;
185 uint32_t number;
189 * This is the internal form which we break input lines up into.
190 * Typically stored in linked lists.
192 * Note that `type' serves a double meaning: TOK_SMAC_PARAM is not
193 * necessarily used as-is, but is intended to denote the number of
194 * the substituted parameter. So in the definition
196 * %define a(x,y) ( (x) & ~(y) )
198 * the token representing `x' will have its type changed to
199 * TOK_SMAC_PARAM, but the one representing `y' will be
200 * TOK_SMAC_PARAM+1.
202 * TOK_INTERNAL_STRING is a dirty hack: it's a single string token
203 * which doesn't need quotes around it. Used in the pre-include
204 * mechanism as an alternative to trying to find a sensible type of
205 * quote to use on the filename we were passed.
207 enum pp_token_type {
208 TOK_NONE = 0, TOK_WHITESPACE, TOK_COMMENT, TOK_ID,
209 TOK_PREPROC_ID, TOK_STRING,
210 TOK_NUMBER, TOK_FLOAT, TOK_SMAC_END, TOK_OTHER,
211 TOK_INTERNAL_STRING,
212 TOK_PREPROC_Q, TOK_PREPROC_QQ,
213 TOK_PASTE, /* %+ */
214 TOK_INDIRECT, /* %[...] */
215 TOK_SMAC_PARAM, /* MUST BE LAST IN THE LIST!!! */
216 TOK_MAX = INT_MAX /* Keep compiler from reducing the range */
219 #define PP_CONCAT_MASK(x) (1 << (x))
220 #define PP_CONCAT_MATCH(t, mask) (PP_CONCAT_MASK((t)->type) & mask)
222 struct tokseq_match {
223 int mask_head;
224 int mask_tail;
227 struct Token {
228 Token *next;
229 char *text;
230 union {
231 SMacro *mac; /* associated macro for TOK_SMAC_END */
232 size_t len; /* scratch length field */
233 } a; /* Auxiliary data */
234 enum pp_token_type type;
238 * Multi-line macro definitions are stored as a linked list of
239 * these, which is essentially a container to allow several linked
240 * lists of Tokens.
242 * Note that in this module, linked lists are treated as stacks
243 * wherever possible. For this reason, Lines are _pushed_ on to the
244 * `expansion' field in MMacro structures, so that the linked list,
245 * if walked, would give the macro lines in reverse order; this
246 * means that we can walk the list when expanding a macro, and thus
247 * push the lines on to the `expansion' field in _istk_ in reverse
248 * order (so that when popped back off they are in the right
249 * order). It may seem cockeyed, and it relies on my design having
250 * an even number of steps in, but it works...
252 * Some of these structures, rather than being actual lines, are
253 * markers delimiting the end of the expansion of a given macro.
254 * This is for use in the cycle-tracking and %rep-handling code.
255 * Such structures have `finishes' non-NULL, and `first' NULL. All
256 * others have `finishes' NULL, but `first' may still be NULL if
257 * the line is blank.
259 struct Line {
260 Line *next;
261 MMacro *finishes;
262 Token *first;
266 * To handle an arbitrary level of file inclusion, we maintain a
267 * stack (ie linked list) of these things.
269 struct Include {
270 Include *next;
271 FILE *fp;
272 Cond *conds;
273 Line *expansion;
274 const char *fname;
275 int lineno, lineinc;
276 MMacro *mstk; /* stack of active macros/reps */
280 * Include search path. This is simply a list of strings which get
281 * prepended, in turn, to the name of an include file, in an
282 * attempt to find the file if it's not in the current directory.
284 struct IncPath {
285 IncPath *next;
286 char *path;
290 * Conditional assembly: we maintain a separate stack of these for
291 * each level of file inclusion. (The only reason we keep the
292 * stacks separate is to ensure that a stray `%endif' in a file
293 * included from within the true branch of a `%if' won't terminate
294 * it and cause confusion: instead, rightly, it'll cause an error.)
296 struct Cond {
297 Cond *next;
298 int state;
300 enum {
302 * These states are for use just after %if or %elif: IF_TRUE
303 * means the condition has evaluated to truth so we are
304 * currently emitting, whereas IF_FALSE means we are not
305 * currently emitting but will start doing so if a %else comes
306 * up. In these states, all directives are admissible: %elif,
307 * %else and %endif. (And of course %if.)
309 COND_IF_TRUE, COND_IF_FALSE,
311 * These states come up after a %else: ELSE_TRUE means we're
312 * emitting, and ELSE_FALSE means we're not. In ELSE_* states,
313 * any %elif or %else will cause an error.
315 COND_ELSE_TRUE, COND_ELSE_FALSE,
317 * These states mean that we're not emitting now, and also that
318 * nothing until %endif will be emitted at all. COND_DONE is
319 * used when we've had our moment of emission
320 * and have now started seeing %elifs. COND_NEVER is used when
321 * the condition construct in question is contained within a
322 * non-emitting branch of a larger condition construct,
323 * or if there is an error.
325 COND_DONE, COND_NEVER
327 #define emitting(x) ( (x) == COND_IF_TRUE || (x) == COND_ELSE_TRUE )
330 * These defines are used as the possible return values for do_directive
332 #define NO_DIRECTIVE_FOUND 0
333 #define DIRECTIVE_FOUND 1
336 * This define sets the upper limit for smacro and recursive mmacro
337 * expansions
339 #define DEADMAN_LIMIT (1 << 20)
341 /* max reps */
342 #define REP_LIMIT ((INT64_C(1) << 62))
345 * Condition codes. Note that we use c_ prefix not C_ because C_ is
346 * used in nasm.h for the "real" condition codes. At _this_ level,
347 * we treat CXZ and ECXZ as condition codes, albeit non-invertible
348 * ones, so we need a different enum...
350 static const char * const conditions[] = {
351 "a", "ae", "b", "be", "c", "cxz", "e", "ecxz", "g", "ge", "l", "le",
352 "na", "nae", "nb", "nbe", "nc", "ne", "ng", "nge", "nl", "nle", "no",
353 "np", "ns", "nz", "o", "p", "pe", "po", "rcxz", "s", "z"
355 enum pp_conds {
356 c_A, c_AE, c_B, c_BE, c_C, c_CXZ, c_E, c_ECXZ, c_G, c_GE, c_L, c_LE,
357 c_NA, c_NAE, c_NB, c_NBE, c_NC, c_NE, c_NG, c_NGE, c_NL, c_NLE, c_NO,
358 c_NP, c_NS, c_NZ, c_O, c_P, c_PE, c_PO, c_RCXZ, c_S, c_Z,
359 c_none = -1
361 static const enum pp_conds inverse_ccs[] = {
362 c_NA, c_NAE, c_NB, c_NBE, c_NC, -1, c_NE, -1, c_NG, c_NGE, c_NL, c_NLE,
363 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,
364 c_Z, c_NO, c_NP, c_PO, c_PE, -1, c_NS, c_NZ
368 * Directive names.
370 /* If this is a an IF, ELIF, ELSE or ENDIF keyword */
371 static int is_condition(enum preproc_token arg)
373 return PP_IS_COND(arg) || (arg == PP_ELSE) || (arg == PP_ENDIF);
376 /* For TASM compatibility we need to be able to recognise TASM compatible
377 * conditional compilation directives. Using the NASM pre-processor does
378 * not work, so we look for them specifically from the following list and
379 * then jam in the equivalent NASM directive into the input stream.
382 enum {
383 TM_ARG, TM_ELIF, TM_ELSE, TM_ENDIF, TM_IF, TM_IFDEF, TM_IFDIFI,
384 TM_IFNDEF, TM_INCLUDE, TM_LOCAL
387 static const char * const tasm_directives[] = {
388 "arg", "elif", "else", "endif", "if", "ifdef", "ifdifi",
389 "ifndef", "include", "local"
392 static int StackSize = 4;
393 static char *StackPointer = "ebp";
394 static int ArgOffset = 8;
395 static int LocalOffset = 0;
397 static Context *cstk;
398 static Include *istk;
399 static IncPath *ipath = NULL;
401 static int pass; /* HACK: pass 0 = generate dependencies only */
402 static StrList **dephead, **deptail; /* Dependency list */
404 static uint64_t unique; /* unique identifier numbers */
406 static Line *predef = NULL;
407 static bool do_predef;
410 * The current set of multi-line macros we have defined.
412 static struct hash_table mmacros;
415 * The current set of single-line macros we have defined.
417 static struct hash_table smacros;
420 * The multi-line macro we are currently defining, or the %rep
421 * block we are currently reading, if any.
423 static MMacro *defining;
425 static uint64_t nested_mac_count;
426 static uint64_t nested_rep_count;
429 * The number of macro parameters to allocate space for at a time.
431 #define PARAM_DELTA 16
434 * The standard macro set: defined in macros.c in the array nasm_stdmac.
435 * This gives our position in the macro set, when we're processing it.
437 static macros_t *stdmacpos;
440 * The extra standard macros that come from the object format, if
441 * any.
443 static macros_t *extrastdmac = NULL;
444 static bool any_extrastdmac;
447 * Tokens are allocated in blocks to improve speed
449 #define TOKEN_BLOCKSIZE 4096
450 static Token *freeTokens = NULL;
451 struct Blocks {
452 Blocks *next;
453 void *chunk;
456 static Blocks blocks = { NULL, NULL };
459 * Forward declarations.
461 static Token *expand_mmac_params(Token * tline);
462 static Token *expand_smacro(Token * tline);
463 static Token *expand_id(Token * tline);
464 static Context *get_ctx(const char *name, const char **namep);
465 static void make_tok_num(Token * tok, int64_t val);
466 static void pp_verror(int severity, const char *fmt, va_list ap);
467 static vefunc real_verror;
468 static void *new_Block(size_t size);
469 static void delete_Blocks(void);
470 static Token *new_Token(Token * next, enum pp_token_type type,
471 const char *text, int txtlen);
472 static Token *delete_Token(Token * t);
475 * Macros for safe checking of token pointers, avoid *(NULL)
477 #define tok_type_(x,t) ((x) && (x)->type == (t))
478 #define skip_white_(x) if (tok_type_((x), TOK_WHITESPACE)) (x)=(x)->next
479 #define tok_is_(x,v) (tok_type_((x), TOK_OTHER) && !strcmp((x)->text,(v)))
480 #define tok_isnt_(x,v) ((x) && ((x)->type!=TOK_OTHER || strcmp((x)->text,(v))))
483 * nasm_unquote with error if the string contains NUL characters.
484 * If the string contains NUL characters, issue an error and return
485 * the C len, i.e. truncate at the NUL.
487 static size_t nasm_unquote_cstr(char *qstr, enum preproc_token directive)
489 size_t len = nasm_unquote(qstr, NULL);
490 size_t clen = strlen(qstr);
492 if (len != clen)
493 nasm_error(ERR_NONFATAL, "NUL character in `%s' directive",
494 pp_directives[directive]);
496 return clen;
500 * In-place reverse a list of tokens.
502 static Token *reverse_tokens(Token *t)
504 Token *prev = NULL;
505 Token *next;
507 while (t) {
508 next = t->next;
509 t->next = prev;
510 prev = t;
511 t = next;
514 return prev;
518 * Handle TASM specific directives, which do not contain a % in
519 * front of them. We do it here because I could not find any other
520 * place to do it for the moment, and it is a hack (ideally it would
521 * be nice to be able to use the NASM pre-processor to do it).
523 static char *check_tasm_directive(char *line)
525 int32_t i, j, k, m, len;
526 char *p, *q, *oldline, oldchar;
528 p = nasm_skip_spaces(line);
530 /* Binary search for the directive name */
531 i = -1;
532 j = ARRAY_SIZE(tasm_directives);
533 q = nasm_skip_word(p);
534 len = q - p;
535 if (len) {
536 oldchar = p[len];
537 p[len] = 0;
538 while (j - i > 1) {
539 k = (j + i) / 2;
540 m = nasm_stricmp(p, tasm_directives[k]);
541 if (m == 0) {
542 /* We have found a directive, so jam a % in front of it
543 * so that NASM will then recognise it as one if it's own.
545 p[len] = oldchar;
546 len = strlen(p);
547 oldline = line;
548 line = nasm_malloc(len + 2);
549 line[0] = '%';
550 if (k == TM_IFDIFI) {
552 * NASM does not recognise IFDIFI, so we convert
553 * it to %if 0. This is not used in NASM
554 * compatible code, but does need to parse for the
555 * TASM macro package.
557 strcpy(line + 1, "if 0");
558 } else {
559 memcpy(line + 1, p, len + 1);
561 nasm_free(oldline);
562 return line;
563 } else if (m < 0) {
564 j = k;
565 } else
566 i = k;
568 p[len] = oldchar;
570 return line;
574 * The pre-preprocessing stage... This function translates line
575 * number indications as they emerge from GNU cpp (`# lineno "file"
576 * flags') into NASM preprocessor line number indications (`%line
577 * lineno file').
579 static char *prepreproc(char *line)
581 int lineno, fnlen;
582 char *fname, *oldline;
584 if (line[0] == '#' && line[1] == ' ') {
585 oldline = line;
586 fname = oldline + 2;
587 lineno = atoi(fname);
588 fname += strspn(fname, "0123456789 ");
589 if (*fname == '"')
590 fname++;
591 fnlen = strcspn(fname, "\"");
592 line = nasm_malloc(20 + fnlen);
593 snprintf(line, 20 + fnlen, "%%line %d %.*s", lineno, fnlen, fname);
594 nasm_free(oldline);
596 if (tasm_compatible_mode)
597 return check_tasm_directive(line);
598 return line;
602 * Free a linked list of tokens.
604 static void free_tlist(Token * list)
606 while (list)
607 list = delete_Token(list);
611 * Free a linked list of lines.
613 static void free_llist(Line * list)
615 Line *l, *tmp;
616 list_for_each_safe(l, tmp, list) {
617 free_tlist(l->first);
618 nasm_free(l);
623 * Free an MMacro
625 static void free_mmacro(MMacro * m)
627 nasm_free(m->name);
628 free_tlist(m->dlist);
629 nasm_free(m->defaults);
630 free_llist(m->expansion);
631 nasm_free(m);
635 * Free all currently defined macros, and free the hash tables
637 static void free_smacro_table(struct hash_table *smt)
639 SMacro *s, *tmp;
640 const char *key;
641 struct hash_tbl_node *it = NULL;
643 while ((s = hash_iterate(smt, &it, &key)) != NULL) {
644 nasm_free((void *)key);
645 list_for_each_safe(s, tmp, s) {
646 nasm_free(s->name);
647 free_tlist(s->expansion);
648 nasm_free(s);
651 hash_free(smt);
654 static void free_mmacro_table(struct hash_table *mmt)
656 MMacro *m, *tmp;
657 const char *key;
658 struct hash_tbl_node *it = NULL;
660 it = NULL;
661 while ((m = hash_iterate(mmt, &it, &key)) != NULL) {
662 nasm_free((void *)key);
663 list_for_each_safe(m ,tmp, m)
664 free_mmacro(m);
666 hash_free(mmt);
669 static void free_macros(void)
671 free_smacro_table(&smacros);
672 free_mmacro_table(&mmacros);
676 * Initialize the hash tables
678 static void init_macros(void)
680 hash_init(&smacros, HASH_LARGE);
681 hash_init(&mmacros, HASH_LARGE);
685 * Pop the context stack.
687 static void ctx_pop(void)
689 Context *c = cstk;
691 cstk = cstk->next;
692 free_smacro_table(&c->localmac);
693 nasm_free(c->name);
694 nasm_free(c);
698 * Search for a key in the hash index; adding it if necessary
699 * (in which case we initialize the data pointer to NULL.)
701 static void **
702 hash_findi_add(struct hash_table *hash, const char *str)
704 struct hash_insert hi;
705 void **r;
706 char *strx;
708 r = hash_findi(hash, str, &hi);
709 if (r)
710 return r;
712 strx = nasm_strdup(str); /* Use a more efficient allocator here? */
713 return hash_add(&hi, strx, NULL);
717 * Like hash_findi, but returns the data element rather than a pointer
718 * to it. Used only when not adding a new element, hence no third
719 * argument.
721 static void *
722 hash_findix(struct hash_table *hash, const char *str)
724 void **p;
726 p = hash_findi(hash, str, NULL);
727 return p ? *p : NULL;
731 * read line from standart macros set,
732 * if there no more left -- return NULL
734 static char *line_from_stdmac(void)
736 unsigned char c;
737 const unsigned char *p = stdmacpos;
738 char *line, *q;
739 size_t len = 0;
741 if (!stdmacpos)
742 return NULL;
744 while ((c = *p++)) {
745 if (c >= 0x80)
746 len += pp_directives_len[c - 0x80] + 1;
747 else
748 len++;
751 line = nasm_malloc(len + 1);
752 q = line;
753 while ((c = *stdmacpos++)) {
754 if (c >= 0x80) {
755 memcpy(q, pp_directives[c - 0x80], pp_directives_len[c - 0x80]);
756 q += pp_directives_len[c - 0x80];
757 *q++ = ' ';
758 } else {
759 *q++ = c;
762 stdmacpos = p;
763 *q = '\0';
765 if (!*stdmacpos) {
766 /* This was the last of the standard macro chain... */
767 stdmacpos = NULL;
768 if (any_extrastdmac) {
769 stdmacpos = extrastdmac;
770 any_extrastdmac = false;
771 } else if (do_predef) {
772 Line *pd, *l;
773 Token *head, **tail, *t;
776 * Nasty hack: here we push the contents of
777 * `predef' on to the top-level expansion stack,
778 * since this is the most convenient way to
779 * implement the pre-include and pre-define
780 * features.
782 list_for_each(pd, predef) {
783 head = NULL;
784 tail = &head;
785 list_for_each(t, pd->first) {
786 *tail = new_Token(NULL, t->type, t->text, 0);
787 tail = &(*tail)->next;
790 l = nasm_malloc(sizeof(Line));
791 l->next = istk->expansion;
792 l->first = head;
793 l->finishes = NULL;
795 istk->expansion = l;
797 do_predef = false;
801 return line;
804 static char *read_line(void)
806 unsigned int size, c, next;
807 const unsigned int delta = 512;
808 const unsigned int pad = 8;
809 unsigned int nr_cont = 0;
810 bool cont = false;
811 char *buffer, *p;
813 /* Standart macros set (predefined) goes first */
814 p = line_from_stdmac();
815 if (p)
816 return p;
818 size = delta;
819 p = buffer = nasm_malloc(size);
821 for (;;) {
822 c = fgetc(istk->fp);
823 if ((int)(c) == EOF) {
824 p[0] = 0;
825 break;
828 switch (c) {
829 case '\r':
830 next = fgetc(istk->fp);
831 if (next != '\n')
832 ungetc(next, istk->fp);
833 if (cont) {
834 cont = false;
835 continue;
837 break;
839 case '\n':
840 if (cont) {
841 cont = false;
842 continue;
844 break;
846 case '\\':
847 next = fgetc(istk->fp);
848 ungetc(next, istk->fp);
849 if (next == '\r' || next == '\n') {
850 cont = true;
851 nr_cont++;
852 continue;
854 break;
857 if (c == '\r' || c == '\n') {
858 *p++ = 0;
859 break;
862 if (p >= (buffer + size - pad)) {
863 buffer = nasm_realloc(buffer, size + delta);
864 p = buffer + size - pad;
865 size += delta;
868 *p++ = (unsigned char)c;
871 if (p == buffer) {
872 nasm_free(buffer);
873 return NULL;
876 src_set_linnum(src_get_linnum() + istk->lineinc +
877 (nr_cont * istk->lineinc));
880 * Handle spurious ^Z, which may be inserted into source files
881 * by some file transfer utilities.
883 buffer[strcspn(buffer, "\032")] = '\0';
885 lfmt->line(LIST_READ, buffer);
887 return buffer;
891 * Tokenize a line of text. This is a very simple process since we
892 * don't need to parse the value out of e.g. numeric tokens: we
893 * simply split one string into many.
895 static Token *tokenize(char *line)
897 char c, *p = line;
898 enum pp_token_type type;
899 Token *list = NULL;
900 Token *t, **tail = &list;
902 while (*line) {
903 p = line;
904 if (*p == '%') {
905 p++;
906 if (*p == '+' && !nasm_isdigit(p[1])) {
907 p++;
908 type = TOK_PASTE;
909 } else if (nasm_isdigit(*p) ||
910 ((*p == '-' || *p == '+') && nasm_isdigit(p[1]))) {
911 do {
912 p++;
914 while (nasm_isdigit(*p));
915 type = TOK_PREPROC_ID;
916 } else if (*p == '{') {
917 p++;
918 while (*p) {
919 if (*p == '}')
920 break;
921 p[-1] = *p;
922 p++;
924 if (*p != '}')
925 nasm_error(ERR_WARNING | ERR_PASS1,
926 "unterminated %%{ construct");
927 p[-1] = '\0';
928 if (*p)
929 p++;
930 type = TOK_PREPROC_ID;
931 } else if (*p == '[') {
932 int lvl = 1;
933 line += 2; /* Skip the leading %[ */
934 p++;
935 while (lvl && (c = *p++)) {
936 switch (c) {
937 case ']':
938 lvl--;
939 break;
940 case '%':
941 if (*p == '[')
942 lvl++;
943 break;
944 case '\'':
945 case '\"':
946 case '`':
947 p = nasm_skip_string(p - 1) + 1;
948 break;
949 default:
950 break;
953 p--;
954 if (*p)
955 *p++ = '\0';
956 if (lvl)
957 nasm_error(ERR_NONFATAL|ERR_PASS1,
958 "unterminated %%[ construct");
959 type = TOK_INDIRECT;
960 } else if (*p == '?') {
961 type = TOK_PREPROC_Q; /* %? */
962 p++;
963 if (*p == '?') {
964 type = TOK_PREPROC_QQ; /* %?? */
965 p++;
967 } else if (*p == '!') {
968 type = TOK_PREPROC_ID;
969 p++;
970 if (isidchar(*p)) {
971 do {
972 p++;
974 while (isidchar(*p));
975 } else if (*p == '\'' || *p == '\"' || *p == '`') {
976 p = nasm_skip_string(p);
977 if (*p)
978 p++;
979 else
980 nasm_error(ERR_NONFATAL|ERR_PASS1,
981 "unterminated %%! string");
982 } else {
983 /* %! without string or identifier */
984 type = TOK_OTHER; /* Legacy behavior... */
986 } else if (isidchar(*p) ||
987 ((*p == '!' || *p == '%' || *p == '$') &&
988 isidchar(p[1]))) {
989 do {
990 p++;
992 while (isidchar(*p));
993 type = TOK_PREPROC_ID;
994 } else {
995 type = TOK_OTHER;
996 if (*p == '%')
997 p++;
999 } else if (isidstart(*p) || (*p == '$' && isidstart(p[1]))) {
1000 type = TOK_ID;
1001 p++;
1002 while (*p && isidchar(*p))
1003 p++;
1004 } else if (*p == '\'' || *p == '"' || *p == '`') {
1006 * A string token.
1008 type = TOK_STRING;
1009 p = nasm_skip_string(p);
1011 if (*p) {
1012 p++;
1013 } else {
1014 nasm_error(ERR_WARNING|ERR_PASS1, "unterminated string");
1015 /* Handling unterminated strings by UNV */
1016 /* type = -1; */
1018 } else if (p[0] == '$' && p[1] == '$') {
1019 type = TOK_OTHER; /* TOKEN_BASE */
1020 p += 2;
1021 } else if (isnumstart(*p)) {
1022 bool is_hex = false;
1023 bool is_float = false;
1024 bool has_e = false;
1025 char c, *r;
1028 * A numeric token.
1031 if (*p == '$') {
1032 p++;
1033 is_hex = true;
1036 for (;;) {
1037 c = *p++;
1039 if (!is_hex && (c == 'e' || c == 'E')) {
1040 has_e = true;
1041 if (*p == '+' || *p == '-') {
1043 * e can only be followed by +/- if it is either a
1044 * prefixed hex number or a floating-point number
1046 p++;
1047 is_float = true;
1049 } else if (c == 'H' || c == 'h' || c == 'X' || c == 'x') {
1050 is_hex = true;
1051 } else if (c == 'P' || c == 'p') {
1052 is_float = true;
1053 if (*p == '+' || *p == '-')
1054 p++;
1055 } else if (isnumchar(c) || c == '_')
1056 ; /* just advance */
1057 else if (c == '.') {
1059 * we need to deal with consequences of the legacy
1060 * parser, like "1.nolist" being two tokens
1061 * (TOK_NUMBER, TOK_ID) here; at least give it
1062 * a shot for now. In the future, we probably need
1063 * a flex-based scanner with proper pattern matching
1064 * to do it as well as it can be done. Nothing in
1065 * the world is going to help the person who wants
1066 * 0x123.p16 interpreted as two tokens, though.
1068 r = p;
1069 while (*r == '_')
1070 r++;
1072 if (nasm_isdigit(*r) || (is_hex && nasm_isxdigit(*r)) ||
1073 (!is_hex && (*r == 'e' || *r == 'E')) ||
1074 (*r == 'p' || *r == 'P')) {
1075 p = r;
1076 is_float = true;
1077 } else
1078 break; /* Terminate the token */
1079 } else
1080 break;
1082 p--; /* Point to first character beyond number */
1084 if (p == line+1 && *line == '$') {
1085 type = TOK_OTHER; /* TOKEN_HERE */
1086 } else {
1087 if (has_e && !is_hex) {
1088 /* 1e13 is floating-point, but 1e13h is not */
1089 is_float = true;
1092 type = is_float ? TOK_FLOAT : TOK_NUMBER;
1094 } else if (nasm_isspace(*p)) {
1095 type = TOK_WHITESPACE;
1096 p = nasm_skip_spaces(p);
1098 * Whitespace just before end-of-line is discarded by
1099 * pretending it's a comment; whitespace just before a
1100 * comment gets lumped into the comment.
1102 if (!*p || *p == ';') {
1103 type = TOK_COMMENT;
1104 while (*p)
1105 p++;
1107 } else if (*p == ';') {
1108 type = TOK_COMMENT;
1109 while (*p)
1110 p++;
1111 } else {
1113 * Anything else is an operator of some kind. We check
1114 * for all the double-character operators (>>, <<, //,
1115 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
1116 * else is a single-character operator.
1118 type = TOK_OTHER;
1119 if ((p[0] == '>' && p[1] == '>') ||
1120 (p[0] == '<' && p[1] == '<') ||
1121 (p[0] == '/' && p[1] == '/') ||
1122 (p[0] == '<' && p[1] == '=') ||
1123 (p[0] == '>' && p[1] == '=') ||
1124 (p[0] == '=' && p[1] == '=') ||
1125 (p[0] == '!' && p[1] == '=') ||
1126 (p[0] == '<' && p[1] == '>') ||
1127 (p[0] == '&' && p[1] == '&') ||
1128 (p[0] == '|' && p[1] == '|') ||
1129 (p[0] == '^' && p[1] == '^')) {
1130 p++;
1132 p++;
1135 /* Handling unterminated string by UNV */
1136 /*if (type == -1)
1138 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
1139 t->text[p-line] = *line;
1140 tail = &t->next;
1142 else */
1143 if (type != TOK_COMMENT) {
1144 *tail = t = new_Token(NULL, type, line, p - line);
1145 tail = &t->next;
1147 line = p;
1149 return list;
1153 * this function allocates a new managed block of memory and
1154 * returns a pointer to the block. The managed blocks are
1155 * deleted only all at once by the delete_Blocks function.
1157 static void *new_Block(size_t size)
1159 Blocks *b = &blocks;
1161 /* first, get to the end of the linked list */
1162 while (b->next)
1163 b = b->next;
1164 /* now allocate the requested chunk */
1165 b->chunk = nasm_malloc(size);
1167 /* now allocate a new block for the next request */
1168 b->next = nasm_zalloc(sizeof(Blocks));
1169 return b->chunk;
1173 * this function deletes all managed blocks of memory
1175 static void delete_Blocks(void)
1177 Blocks *a, *b = &blocks;
1180 * keep in mind that the first block, pointed to by blocks
1181 * is a static and not dynamically allocated, so we don't
1182 * free it.
1184 while (b) {
1185 if (b->chunk)
1186 nasm_free(b->chunk);
1187 a = b;
1188 b = b->next;
1189 if (a != &blocks)
1190 nasm_free(a);
1192 memset(&blocks, 0, sizeof(blocks));
1196 * this function creates a new Token and passes a pointer to it
1197 * back to the caller. It sets the type and text elements, and
1198 * also the a.mac and next elements to NULL.
1200 static Token *new_Token(Token * next, enum pp_token_type type,
1201 const char *text, int txtlen)
1203 Token *t;
1204 int i;
1206 if (!freeTokens) {
1207 freeTokens = (Token *) new_Block(TOKEN_BLOCKSIZE * sizeof(Token));
1208 for (i = 0; i < TOKEN_BLOCKSIZE - 1; i++)
1209 freeTokens[i].next = &freeTokens[i + 1];
1210 freeTokens[i].next = NULL;
1212 t = freeTokens;
1213 freeTokens = t->next;
1214 t->next = next;
1215 t->a.mac = NULL;
1216 t->type = type;
1217 if (type == TOK_WHITESPACE || !text) {
1218 t->text = NULL;
1219 } else {
1220 if (txtlen == 0)
1221 txtlen = strlen(text);
1222 t->text = nasm_malloc(txtlen+1);
1223 memcpy(t->text, text, txtlen);
1224 t->text[txtlen] = '\0';
1226 return t;
1229 static Token *delete_Token(Token * t)
1231 Token *next = t->next;
1232 nasm_free(t->text);
1233 t->next = freeTokens;
1234 freeTokens = t;
1235 return next;
1239 * Convert a line of tokens back into text.
1240 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1241 * will be transformed into ..@ctxnum.xxx
1243 static char *detoken(Token * tlist, bool expand_locals)
1245 Token *t;
1246 char *line, *p;
1247 const char *q;
1248 int len = 0;
1250 list_for_each(t, tlist) {
1251 if (t->type == TOK_PREPROC_ID && t->text[1] == '!') {
1252 char *v;
1253 char *q = t->text;
1255 v = t->text + 2;
1256 if (*v == '\'' || *v == '\"' || *v == '`') {
1257 size_t len = nasm_unquote(v, NULL);
1258 size_t clen = strlen(v);
1260 if (len != clen) {
1261 nasm_error(ERR_NONFATAL | ERR_PASS1,
1262 "NUL character in %%! string");
1263 v = NULL;
1267 if (v) {
1268 char *p = getenv(v);
1269 if (!p) {
1270 nasm_error(ERR_NONFATAL | ERR_PASS1,
1271 "nonexistent environment variable `%s'", v);
1273 * FIXME We better should investigate if accessing
1274 * ->text[1] without ->text[0] is safe enough.
1276 t->text = nasm_zalloc(2);
1277 } else
1278 t->text = nasm_strdup(p);
1280 nasm_free(q);
1283 /* Expand local macros here and not during preprocessing */
1284 if (expand_locals &&
1285 t->type == TOK_PREPROC_ID && t->text &&
1286 t->text[0] == '%' && t->text[1] == '$') {
1287 const char *q;
1288 char *p;
1289 Context *ctx = get_ctx(t->text, &q);
1290 if (ctx) {
1291 char buffer[40];
1292 snprintf(buffer, sizeof(buffer), "..@%"PRIu32".", ctx->number);
1293 p = nasm_strcat(buffer, q);
1294 nasm_free(t->text);
1295 t->text = p;
1298 if (t->type == TOK_WHITESPACE)
1299 len++;
1300 else if (t->text)
1301 len += strlen(t->text);
1304 p = line = nasm_malloc(len + 1);
1306 list_for_each(t, tlist) {
1307 if (t->type == TOK_WHITESPACE) {
1308 *p++ = ' ';
1309 } else if (t->text) {
1310 q = t->text;
1311 while (*q)
1312 *p++ = *q++;
1315 *p = '\0';
1317 return line;
1321 * A scanner, suitable for use by the expression evaluator, which
1322 * operates on a line of Tokens. Expects a pointer to a pointer to
1323 * the first token in the line to be passed in as its private_data
1324 * field.
1326 * FIX: This really needs to be unified with stdscan.
1328 static int ppscan(void *private_data, struct tokenval *tokval)
1330 Token **tlineptr = private_data;
1331 Token *tline;
1332 char ourcopy[MAX_KEYWORD+1], *p, *r, *s;
1334 do {
1335 tline = *tlineptr;
1336 *tlineptr = tline ? tline->next : NULL;
1337 } while (tline && (tline->type == TOK_WHITESPACE ||
1338 tline->type == TOK_COMMENT));
1340 if (!tline)
1341 return tokval->t_type = TOKEN_EOS;
1343 tokval->t_charptr = tline->text;
1345 if (tline->text[0] == '$' && !tline->text[1])
1346 return tokval->t_type = TOKEN_HERE;
1347 if (tline->text[0] == '$' && tline->text[1] == '$' && !tline->text[2])
1348 return tokval->t_type = TOKEN_BASE;
1350 if (tline->type == TOK_ID) {
1351 p = tokval->t_charptr = tline->text;
1352 if (p[0] == '$') {
1353 tokval->t_charptr++;
1354 return tokval->t_type = TOKEN_ID;
1357 for (r = p, s = ourcopy; *r; r++) {
1358 if (r >= p+MAX_KEYWORD)
1359 return tokval->t_type = TOKEN_ID; /* Not a keyword */
1360 *s++ = nasm_tolower(*r);
1362 *s = '\0';
1363 /* right, so we have an identifier sitting in temp storage. now,
1364 * is it actually a register or instruction name, or what? */
1365 return nasm_token_hash(ourcopy, tokval);
1368 if (tline->type == TOK_NUMBER) {
1369 bool rn_error;
1370 tokval->t_integer = readnum(tline->text, &rn_error);
1371 tokval->t_charptr = tline->text;
1372 if (rn_error)
1373 return tokval->t_type = TOKEN_ERRNUM;
1374 else
1375 return tokval->t_type = TOKEN_NUM;
1378 if (tline->type == TOK_FLOAT) {
1379 return tokval->t_type = TOKEN_FLOAT;
1382 if (tline->type == TOK_STRING) {
1383 char bq, *ep;
1385 bq = tline->text[0];
1386 tokval->t_charptr = tline->text;
1387 tokval->t_inttwo = nasm_unquote(tline->text, &ep);
1389 if (ep[0] != bq || ep[1] != '\0')
1390 return tokval->t_type = TOKEN_ERRSTR;
1391 else
1392 return tokval->t_type = TOKEN_STR;
1395 if (tline->type == TOK_OTHER) {
1396 if (!strcmp(tline->text, "<<"))
1397 return tokval->t_type = TOKEN_SHL;
1398 if (!strcmp(tline->text, ">>"))
1399 return tokval->t_type = TOKEN_SHR;
1400 if (!strcmp(tline->text, "//"))
1401 return tokval->t_type = TOKEN_SDIV;
1402 if (!strcmp(tline->text, "%%"))
1403 return tokval->t_type = TOKEN_SMOD;
1404 if (!strcmp(tline->text, "=="))
1405 return tokval->t_type = TOKEN_EQ;
1406 if (!strcmp(tline->text, "<>"))
1407 return tokval->t_type = TOKEN_NE;
1408 if (!strcmp(tline->text, "!="))
1409 return tokval->t_type = TOKEN_NE;
1410 if (!strcmp(tline->text, "<="))
1411 return tokval->t_type = TOKEN_LE;
1412 if (!strcmp(tline->text, ">="))
1413 return tokval->t_type = TOKEN_GE;
1414 if (!strcmp(tline->text, "&&"))
1415 return tokval->t_type = TOKEN_DBL_AND;
1416 if (!strcmp(tline->text, "^^"))
1417 return tokval->t_type = TOKEN_DBL_XOR;
1418 if (!strcmp(tline->text, "||"))
1419 return tokval->t_type = TOKEN_DBL_OR;
1423 * We have no other options: just return the first character of
1424 * the token text.
1426 return tokval->t_type = tline->text[0];
1430 * Compare a string to the name of an existing macro; this is a
1431 * simple wrapper which calls either strcmp or nasm_stricmp
1432 * depending on the value of the `casesense' parameter.
1434 static int mstrcmp(const char *p, const char *q, bool casesense)
1436 return casesense ? strcmp(p, q) : nasm_stricmp(p, q);
1440 * Compare a string to the name of an existing macro; this is a
1441 * simple wrapper which calls either strcmp or nasm_stricmp
1442 * depending on the value of the `casesense' parameter.
1444 static int mmemcmp(const char *p, const char *q, size_t l, bool casesense)
1446 return casesense ? memcmp(p, q, l) : nasm_memicmp(p, q, l);
1450 * Return the Context structure associated with a %$ token. Return
1451 * NULL, having _already_ reported an error condition, if the
1452 * context stack isn't deep enough for the supplied number of $
1453 * signs.
1455 * If "namep" is non-NULL, set it to the pointer to the macro name
1456 * tail, i.e. the part beyond %$...
1458 static Context *get_ctx(const char *name, const char **namep)
1460 Context *ctx;
1461 int i;
1463 if (namep)
1464 *namep = name;
1466 if (!name || name[0] != '%' || name[1] != '$')
1467 return NULL;
1469 if (!cstk) {
1470 nasm_error(ERR_NONFATAL, "`%s': context stack is empty", name);
1471 return NULL;
1474 name += 2;
1475 ctx = cstk;
1476 i = 0;
1477 while (ctx && *name == '$') {
1478 name++;
1479 i++;
1480 ctx = ctx->next;
1482 if (!ctx) {
1483 nasm_error(ERR_NONFATAL, "`%s': context stack is only"
1484 " %d level%s deep", name, i, (i == 1 ? "" : "s"));
1485 return NULL;
1488 if (namep)
1489 *namep = name;
1491 return ctx;
1495 * Check to see if a file is already in a string list
1497 static bool in_list(const StrList *list, const char *str)
1499 while (list) {
1500 if (!strcmp(list->str, str))
1501 return true;
1502 list = list->next;
1504 return false;
1508 * Open an include file. This routine must always return a valid
1509 * file pointer if it returns - it's responsible for throwing an
1510 * ERR_FATAL and bombing out completely if not. It should also try
1511 * the include path one by one until it finds the file or reaches
1512 * the end of the path.
1514 static FILE *inc_fopen(const char *file, StrList **dhead, StrList ***dtail,
1515 char **found_path, bool missing_ok, const char *mode)
1517 FILE *fp;
1518 char *prefix = "";
1519 IncPath *ip = ipath;
1520 int len = strlen(file);
1521 size_t prefix_len = 0;
1522 StrList *sl;
1523 size_t path_len;
1525 while (1) {
1526 path_len = prefix_len + len + 1;
1528 sl = nasm_malloc(path_len + sizeof sl->next);
1529 memcpy(sl->str, prefix, prefix_len);
1530 memcpy(sl->str+prefix_len, file, len+1);
1532 if (found_path != NULL) {
1533 *found_path = nasm_malloc(path_len);
1534 memcpy(*found_path, sl->str, path_len);
1537 fp = fopen(sl->str, mode);
1538 if (fp && dhead && !in_list(*dhead, sl->str)) {
1539 sl->next = NULL;
1540 **dtail = sl;
1541 *dtail = &sl->next;
1542 } else {
1543 nasm_free(sl);
1545 if (fp)
1546 return fp;
1548 if (found_path != NULL && *found_path != NULL) {
1549 nasm_free(*found_path);
1550 *found_path = NULL;
1553 if (!ip) {
1554 if (!missing_ok)
1555 break;
1556 prefix = NULL;
1557 } else {
1558 prefix = ip->path;
1559 ip = ip->next;
1561 if (prefix) {
1562 prefix_len = strlen(prefix);
1563 } else {
1564 /* -MG given and file not found */
1565 if (dhead && !in_list(*dhead, file)) {
1566 sl = nasm_malloc(len+1+sizeof sl->next);
1567 sl->next = NULL;
1568 strcpy(sl->str, file);
1569 **dtail = sl;
1570 *dtail = &sl->next;
1572 return NULL;
1576 nasm_error(ERR_FATAL, "unable to open include file `%s'", file);
1577 return NULL;
1581 * Opens an include or input file. Public version, for use by modules
1582 * that get a file:lineno pair and need to look at the file again
1583 * (e.g. the CodeView debug backend). Returns NULL on failure.
1585 FILE *pp_input_fopen(const char *filename, const char *mode)
1587 FILE *fp;
1588 StrList *xsl = NULL;
1589 StrList **xst = &xsl;
1591 fp = inc_fopen(filename, &xsl, &xst, NULL, true, mode);
1592 if (xsl)
1593 nasm_free(xsl);
1594 return fp;
1598 * Determine if we should warn on defining a single-line macro of
1599 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1600 * return true if _any_ single-line macro of that name is defined.
1601 * Otherwise, will return true if a single-line macro with either
1602 * `nparam' or no parameters is defined.
1604 * If a macro with precisely the right number of parameters is
1605 * defined, or nparam is -1, the address of the definition structure
1606 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1607 * is NULL, no action will be taken regarding its contents, and no
1608 * error will occur.
1610 * Note that this is also called with nparam zero to resolve
1611 * `ifdef'.
1613 * If you already know which context macro belongs to, you can pass
1614 * the context pointer as first parameter; if you won't but name begins
1615 * with %$ the context will be automatically computed. If all_contexts
1616 * is true, macro will be searched in outer contexts as well.
1618 static bool
1619 smacro_defined(Context * ctx, const char *name, int nparam, SMacro ** defn,
1620 bool nocase)
1622 struct hash_table *smtbl;
1623 SMacro *m;
1625 if (ctx) {
1626 smtbl = &ctx->localmac;
1627 } else if (name[0] == '%' && name[1] == '$') {
1628 if (cstk)
1629 ctx = get_ctx(name, &name);
1630 if (!ctx)
1631 return false; /* got to return _something_ */
1632 smtbl = &ctx->localmac;
1633 } else {
1634 smtbl = &smacros;
1636 m = (SMacro *) hash_findix(smtbl, name);
1638 while (m) {
1639 if (!mstrcmp(m->name, name, m->casesense && nocase) &&
1640 (nparam <= 0 || m->nparam == 0 || nparam == (int) m->nparam)) {
1641 if (defn) {
1642 if (nparam == (int) m->nparam || nparam == -1)
1643 *defn = m;
1644 else
1645 *defn = NULL;
1647 return true;
1649 m = m->next;
1652 return false;
1656 * Count and mark off the parameters in a multi-line macro call.
1657 * This is called both from within the multi-line macro expansion
1658 * code, and also to mark off the default parameters when provided
1659 * in a %macro definition line.
1661 static void count_mmac_params(Token * t, int *nparam, Token *** params)
1663 int paramsize, brace;
1665 *nparam = paramsize = 0;
1666 *params = NULL;
1667 while (t) {
1668 /* +1: we need space for the final NULL */
1669 if (*nparam+1 >= paramsize) {
1670 paramsize += PARAM_DELTA;
1671 *params = nasm_realloc(*params, sizeof(**params) * paramsize);
1673 skip_white_(t);
1674 brace = 0;
1675 if (tok_is_(t, "{"))
1676 brace++;
1677 (*params)[(*nparam)++] = t;
1678 if (brace) {
1679 while (brace && (t = t->next) != NULL) {
1680 if (tok_is_(t, "{"))
1681 brace++;
1682 else if (tok_is_(t, "}"))
1683 brace--;
1686 if (t) {
1688 * Now we've found the closing brace, look further
1689 * for the comma.
1691 t = t->next;
1692 skip_white_(t);
1693 if (tok_isnt_(t, ",")) {
1694 nasm_error(ERR_NONFATAL,
1695 "braces do not enclose all of macro parameter");
1696 while (tok_isnt_(t, ","))
1697 t = t->next;
1700 } else {
1701 while (tok_isnt_(t, ","))
1702 t = t->next;
1704 if (t) { /* got a comma/brace */
1705 t = t->next; /* eat the comma */
1711 * Determine whether one of the various `if' conditions is true or
1712 * not.
1714 * We must free the tline we get passed.
1716 static bool if_condition(Token * tline, enum preproc_token ct)
1718 enum pp_conditional i = PP_COND(ct);
1719 bool j;
1720 Token *t, *tt, **tptr, *origline;
1721 struct tokenval tokval;
1722 expr *evalresult;
1723 enum pp_token_type needtype;
1724 char *p;
1726 origline = tline;
1728 switch (i) {
1729 case PPC_IFCTX:
1730 j = false; /* have we matched yet? */
1731 while (true) {
1732 skip_white_(tline);
1733 if (!tline)
1734 break;
1735 if (tline->type != TOK_ID) {
1736 nasm_error(ERR_NONFATAL,
1737 "`%s' expects context identifiers", pp_directives[ct]);
1738 free_tlist(origline);
1739 return -1;
1741 if (cstk && cstk->name && !nasm_stricmp(tline->text, cstk->name))
1742 j = true;
1743 tline = tline->next;
1745 break;
1747 case PPC_IFDEF:
1748 j = false; /* have we matched yet? */
1749 while (tline) {
1750 skip_white_(tline);
1751 if (!tline || (tline->type != TOK_ID &&
1752 (tline->type != TOK_PREPROC_ID ||
1753 tline->text[1] != '$'))) {
1754 nasm_error(ERR_NONFATAL,
1755 "`%s' expects macro identifiers", pp_directives[ct]);
1756 goto fail;
1758 if (smacro_defined(NULL, tline->text, 0, NULL, true))
1759 j = true;
1760 tline = tline->next;
1762 break;
1764 case PPC_IFENV:
1765 tline = expand_smacro(tline);
1766 j = false; /* have we matched yet? */
1767 while (tline) {
1768 skip_white_(tline);
1769 if (!tline || (tline->type != TOK_ID &&
1770 tline->type != TOK_STRING &&
1771 (tline->type != TOK_PREPROC_ID ||
1772 tline->text[1] != '!'))) {
1773 nasm_error(ERR_NONFATAL,
1774 "`%s' expects environment variable names",
1775 pp_directives[ct]);
1776 goto fail;
1778 p = tline->text;
1779 if (tline->type == TOK_PREPROC_ID)
1780 p += 2; /* Skip leading %! */
1781 if (*p == '\'' || *p == '\"' || *p == '`')
1782 nasm_unquote_cstr(p, ct);
1783 if (getenv(p))
1784 j = true;
1785 tline = tline->next;
1787 break;
1789 case PPC_IFIDN:
1790 case PPC_IFIDNI:
1791 tline = expand_smacro(tline);
1792 t = tt = tline;
1793 while (tok_isnt_(tt, ","))
1794 tt = tt->next;
1795 if (!tt) {
1796 nasm_error(ERR_NONFATAL,
1797 "`%s' expects two comma-separated arguments",
1798 pp_directives[ct]);
1799 goto fail;
1801 tt = tt->next;
1802 j = true; /* assume equality unless proved not */
1803 while ((t->type != TOK_OTHER || strcmp(t->text, ",")) && tt) {
1804 if (tt->type == TOK_OTHER && !strcmp(tt->text, ",")) {
1805 nasm_error(ERR_NONFATAL, "`%s': more than one comma on line",
1806 pp_directives[ct]);
1807 goto fail;
1809 if (t->type == TOK_WHITESPACE) {
1810 t = t->next;
1811 continue;
1813 if (tt->type == TOK_WHITESPACE) {
1814 tt = tt->next;
1815 continue;
1817 if (tt->type != t->type) {
1818 j = false; /* found mismatching tokens */
1819 break;
1821 /* When comparing strings, need to unquote them first */
1822 if (t->type == TOK_STRING) {
1823 size_t l1 = nasm_unquote(t->text, NULL);
1824 size_t l2 = nasm_unquote(tt->text, NULL);
1826 if (l1 != l2) {
1827 j = false;
1828 break;
1830 if (mmemcmp(t->text, tt->text, l1, i == PPC_IFIDN)) {
1831 j = false;
1832 break;
1834 } else if (mstrcmp(tt->text, t->text, i == PPC_IFIDN) != 0) {
1835 j = false; /* found mismatching tokens */
1836 break;
1839 t = t->next;
1840 tt = tt->next;
1842 if ((t->type != TOK_OTHER || strcmp(t->text, ",")) || tt)
1843 j = false; /* trailing gunk on one end or other */
1844 break;
1846 case PPC_IFMACRO:
1848 bool found = false;
1849 MMacro searching, *mmac;
1851 skip_white_(tline);
1852 tline = expand_id(tline);
1853 if (!tok_type_(tline, TOK_ID)) {
1854 nasm_error(ERR_NONFATAL,
1855 "`%s' expects a macro name", pp_directives[ct]);
1856 goto fail;
1858 searching.name = nasm_strdup(tline->text);
1859 searching.casesense = true;
1860 searching.plus = false;
1861 searching.nolist = false;
1862 searching.in_progress = 0;
1863 searching.max_depth = 0;
1864 searching.rep_nest = NULL;
1865 searching.nparam_min = 0;
1866 searching.nparam_max = INT_MAX;
1867 tline = expand_smacro(tline->next);
1868 skip_white_(tline);
1869 if (!tline) {
1870 } else if (!tok_type_(tline, TOK_NUMBER)) {
1871 nasm_error(ERR_NONFATAL,
1872 "`%s' expects a parameter count or nothing",
1873 pp_directives[ct]);
1874 } else {
1875 searching.nparam_min = searching.nparam_max =
1876 readnum(tline->text, &j);
1877 if (j)
1878 nasm_error(ERR_NONFATAL,
1879 "unable to parse parameter count `%s'",
1880 tline->text);
1882 if (tline && tok_is_(tline->next, "-")) {
1883 tline = tline->next->next;
1884 if (tok_is_(tline, "*"))
1885 searching.nparam_max = INT_MAX;
1886 else if (!tok_type_(tline, TOK_NUMBER))
1887 nasm_error(ERR_NONFATAL,
1888 "`%s' expects a parameter count after `-'",
1889 pp_directives[ct]);
1890 else {
1891 searching.nparam_max = readnum(tline->text, &j);
1892 if (j)
1893 nasm_error(ERR_NONFATAL,
1894 "unable to parse parameter count `%s'",
1895 tline->text);
1896 if (searching.nparam_min > searching.nparam_max)
1897 nasm_error(ERR_NONFATAL,
1898 "minimum parameter count exceeds maximum");
1901 if (tline && tok_is_(tline->next, "+")) {
1902 tline = tline->next;
1903 searching.plus = true;
1905 mmac = (MMacro *) hash_findix(&mmacros, searching.name);
1906 while (mmac) {
1907 if (!strcmp(mmac->name, searching.name) &&
1908 (mmac->nparam_min <= searching.nparam_max
1909 || searching.plus)
1910 && (searching.nparam_min <= mmac->nparam_max
1911 || mmac->plus)) {
1912 found = true;
1913 break;
1915 mmac = mmac->next;
1917 if (tline && tline->next)
1918 nasm_error(ERR_WARNING|ERR_PASS1,
1919 "trailing garbage after %%ifmacro ignored");
1920 nasm_free(searching.name);
1921 j = found;
1922 break;
1925 case PPC_IFID:
1926 needtype = TOK_ID;
1927 goto iftype;
1928 case PPC_IFNUM:
1929 needtype = TOK_NUMBER;
1930 goto iftype;
1931 case PPC_IFSTR:
1932 needtype = TOK_STRING;
1933 goto iftype;
1935 iftype:
1936 t = tline = expand_smacro(tline);
1938 while (tok_type_(t, TOK_WHITESPACE) ||
1939 (needtype == TOK_NUMBER &&
1940 tok_type_(t, TOK_OTHER) &&
1941 (t->text[0] == '-' || t->text[0] == '+') &&
1942 !t->text[1]))
1943 t = t->next;
1945 j = tok_type_(t, needtype);
1946 break;
1948 case PPC_IFTOKEN:
1949 t = tline = expand_smacro(tline);
1950 while (tok_type_(t, TOK_WHITESPACE))
1951 t = t->next;
1953 j = false;
1954 if (t) {
1955 t = t->next; /* Skip the actual token */
1956 while (tok_type_(t, TOK_WHITESPACE))
1957 t = t->next;
1958 j = !t; /* Should be nothing left */
1960 break;
1962 case PPC_IFEMPTY:
1963 t = tline = expand_smacro(tline);
1964 while (tok_type_(t, TOK_WHITESPACE))
1965 t = t->next;
1967 j = !t; /* Should be empty */
1968 break;
1970 case PPC_IF:
1971 t = tline = expand_smacro(tline);
1972 tptr = &t;
1973 tokval.t_type = TOKEN_INVALID;
1974 evalresult = evaluate(ppscan, tptr, &tokval,
1975 NULL, pass | CRITICAL, NULL);
1976 if (!evalresult)
1977 return -1;
1978 if (tokval.t_type)
1979 nasm_error(ERR_WARNING|ERR_PASS1,
1980 "trailing garbage after expression ignored");
1981 if (!is_simple(evalresult)) {
1982 nasm_error(ERR_NONFATAL,
1983 "non-constant value given to `%s'", pp_directives[ct]);
1984 goto fail;
1986 j = reloc_value(evalresult) != 0;
1987 break;
1989 default:
1990 nasm_error(ERR_FATAL,
1991 "preprocessor directive `%s' not yet implemented",
1992 pp_directives[ct]);
1993 goto fail;
1996 free_tlist(origline);
1997 return j ^ PP_NEGATIVE(ct);
1999 fail:
2000 free_tlist(origline);
2001 return -1;
2005 * Common code for defining an smacro
2007 static bool define_smacro(Context *ctx, const char *mname, bool casesense,
2008 int nparam, Token *expansion)
2010 SMacro *smac, **smhead;
2011 struct hash_table *smtbl;
2013 if (smacro_defined(ctx, mname, nparam, &smac, casesense)) {
2014 if (!smac) {
2015 nasm_error(ERR_WARNING|ERR_PASS1,
2016 "single-line macro `%s' defined both with and"
2017 " without parameters", mname);
2019 * Some instances of the old code considered this a failure,
2020 * some others didn't. What is the right thing to do here?
2022 free_tlist(expansion);
2023 return false; /* Failure */
2024 } else {
2026 * We're redefining, so we have to take over an
2027 * existing SMacro structure. This means freeing
2028 * what was already in it.
2030 nasm_free(smac->name);
2031 free_tlist(smac->expansion);
2033 } else {
2034 smtbl = ctx ? &ctx->localmac : &smacros;
2035 smhead = (SMacro **) hash_findi_add(smtbl, mname);
2036 smac = nasm_malloc(sizeof(SMacro));
2037 smac->next = *smhead;
2038 *smhead = smac;
2040 smac->name = nasm_strdup(mname);
2041 smac->casesense = casesense;
2042 smac->nparam = nparam;
2043 smac->expansion = expansion;
2044 smac->in_progress = false;
2045 return true; /* Success */
2049 * Undefine an smacro
2051 static void undef_smacro(Context *ctx, const char *mname)
2053 SMacro **smhead, *s, **sp;
2054 struct hash_table *smtbl;
2056 smtbl = ctx ? &ctx->localmac : &smacros;
2057 smhead = (SMacro **)hash_findi(smtbl, mname, NULL);
2059 if (smhead) {
2061 * We now have a macro name... go hunt for it.
2063 sp = smhead;
2064 while ((s = *sp) != NULL) {
2065 if (!mstrcmp(s->name, mname, s->casesense)) {
2066 *sp = s->next;
2067 nasm_free(s->name);
2068 free_tlist(s->expansion);
2069 nasm_free(s);
2070 } else {
2071 sp = &s->next;
2078 * Parse a mmacro specification.
2080 static bool parse_mmacro_spec(Token *tline, MMacro *def, const char *directive)
2082 bool err;
2084 tline = tline->next;
2085 skip_white_(tline);
2086 tline = expand_id(tline);
2087 if (!tok_type_(tline, TOK_ID)) {
2088 nasm_error(ERR_NONFATAL, "`%s' expects a macro name", directive);
2089 return false;
2092 def->prev = NULL;
2093 def->name = nasm_strdup(tline->text);
2094 def->plus = false;
2095 def->nolist = false;
2096 def->in_progress = 0;
2097 def->rep_nest = NULL;
2098 def->nparam_min = 0;
2099 def->nparam_max = 0;
2101 tline = expand_smacro(tline->next);
2102 skip_white_(tline);
2103 if (!tok_type_(tline, TOK_NUMBER)) {
2104 nasm_error(ERR_NONFATAL, "`%s' expects a parameter count", directive);
2105 } else {
2106 def->nparam_min = def->nparam_max =
2107 readnum(tline->text, &err);
2108 if (err)
2109 nasm_error(ERR_NONFATAL,
2110 "unable to parse parameter count `%s'", tline->text);
2112 if (tline && tok_is_(tline->next, "-")) {
2113 tline = tline->next->next;
2114 if (tok_is_(tline, "*")) {
2115 def->nparam_max = INT_MAX;
2116 } else if (!tok_type_(tline, TOK_NUMBER)) {
2117 nasm_error(ERR_NONFATAL,
2118 "`%s' expects a parameter count after `-'", directive);
2119 } else {
2120 def->nparam_max = readnum(tline->text, &err);
2121 if (err) {
2122 nasm_error(ERR_NONFATAL, "unable to parse parameter count `%s'",
2123 tline->text);
2125 if (def->nparam_min > def->nparam_max) {
2126 nasm_error(ERR_NONFATAL, "minimum parameter count exceeds maximum");
2130 if (tline && tok_is_(tline->next, "+")) {
2131 tline = tline->next;
2132 def->plus = true;
2134 if (tline && tok_type_(tline->next, TOK_ID) &&
2135 !nasm_stricmp(tline->next->text, ".nolist")) {
2136 tline = tline->next;
2137 def->nolist = true;
2141 * Handle default parameters.
2143 if (tline && tline->next) {
2144 def->dlist = tline->next;
2145 tline->next = NULL;
2146 count_mmac_params(def->dlist, &def->ndefs, &def->defaults);
2147 } else {
2148 def->dlist = NULL;
2149 def->defaults = NULL;
2151 def->expansion = NULL;
2153 if (def->defaults && def->ndefs > def->nparam_max - def->nparam_min &&
2154 !def->plus)
2155 nasm_error(ERR_WARNING|ERR_PASS1|ERR_WARN_MDP,
2156 "too many default macro parameters");
2158 return true;
2163 * Decode a size directive
2165 static int parse_size(const char *str) {
2166 static const char *size_names[] =
2167 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
2168 static const int sizes[] =
2169 { 0, 1, 4, 16, 8, 10, 2, 32 };
2171 return sizes[bsii(str, size_names, ARRAY_SIZE(size_names))+1];
2175 * find and process preprocessor directive in passed line
2176 * Find out if a line contains a preprocessor directive, and deal
2177 * with it if so.
2179 * If a directive _is_ found, it is the responsibility of this routine
2180 * (and not the caller) to free_tlist() the line.
2182 * @param tline a pointer to the current tokeninzed line linked list
2183 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
2186 static int do_directive(Token * tline)
2188 enum preproc_token i;
2189 int j;
2190 bool err;
2191 int nparam;
2192 bool nolist;
2193 bool casesense;
2194 int k, m;
2195 int offset;
2196 char *p, *pp, *found_path;
2197 const char *mname;
2198 Include *inc;
2199 Context *ctx;
2200 Cond *cond;
2201 MMacro *mmac, **mmhead;
2202 Token *t = NULL, *tt, *param_start, *macro_start, *last, **tptr, *origline;
2203 Line *l;
2204 struct tokenval tokval;
2205 expr *evalresult;
2206 MMacro *tmp_defining; /* Used when manipulating rep_nest */
2207 int64_t count;
2208 size_t len;
2209 int severity;
2211 origline = tline;
2213 skip_white_(tline);
2214 if (!tline || !tok_type_(tline, TOK_PREPROC_ID) ||
2215 (tline->text[1] == '%' || tline->text[1] == '$'
2216 || tline->text[1] == '!'))
2217 return NO_DIRECTIVE_FOUND;
2219 i = pp_token_hash(tline->text);
2222 * FIXME: We zap execution of PP_RMACRO, PP_IRMACRO, PP_EXITMACRO
2223 * since they are known to be buggy at moment, we need to fix them
2224 * in future release (2.09-2.10)
2226 if (i == PP_RMACRO || i == PP_IRMACRO || i == PP_EXITMACRO) {
2227 nasm_error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2228 tline->text);
2229 return NO_DIRECTIVE_FOUND;
2233 * If we're in a non-emitting branch of a condition construct,
2234 * or walking to the end of an already terminated %rep block,
2235 * we should ignore all directives except for condition
2236 * directives.
2238 if (((istk->conds && !emitting(istk->conds->state)) ||
2239 (istk->mstk && !istk->mstk->in_progress)) && !is_condition(i)) {
2240 return NO_DIRECTIVE_FOUND;
2244 * If we're defining a macro or reading a %rep block, we should
2245 * ignore all directives except for %macro/%imacro (which nest),
2246 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
2247 * If we're in a %rep block, another %rep nests, so should be let through.
2249 if (defining && i != PP_MACRO && i != PP_IMACRO &&
2250 i != PP_RMACRO && i != PP_IRMACRO &&
2251 i != PP_ENDMACRO && i != PP_ENDM &&
2252 (defining->name || (i != PP_ENDREP && i != PP_REP))) {
2253 return NO_DIRECTIVE_FOUND;
2256 if (defining) {
2257 if (i == PP_MACRO || i == PP_IMACRO ||
2258 i == PP_RMACRO || i == PP_IRMACRO) {
2259 nested_mac_count++;
2260 return NO_DIRECTIVE_FOUND;
2261 } else if (nested_mac_count > 0) {
2262 if (i == PP_ENDMACRO) {
2263 nested_mac_count--;
2264 return NO_DIRECTIVE_FOUND;
2267 if (!defining->name) {
2268 if (i == PP_REP) {
2269 nested_rep_count++;
2270 return NO_DIRECTIVE_FOUND;
2271 } else if (nested_rep_count > 0) {
2272 if (i == PP_ENDREP) {
2273 nested_rep_count--;
2274 return NO_DIRECTIVE_FOUND;
2280 switch (i) {
2281 case PP_INVALID:
2282 nasm_error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2283 tline->text);
2284 return NO_DIRECTIVE_FOUND; /* didn't get it */
2286 case PP_STACKSIZE:
2287 /* Directive to tell NASM what the default stack size is. The
2288 * default is for a 16-bit stack, and this can be overriden with
2289 * %stacksize large.
2291 tline = tline->next;
2292 if (tline && tline->type == TOK_WHITESPACE)
2293 tline = tline->next;
2294 if (!tline || tline->type != TOK_ID) {
2295 nasm_error(ERR_NONFATAL, "`%%stacksize' missing size parameter");
2296 free_tlist(origline);
2297 return DIRECTIVE_FOUND;
2299 if (nasm_stricmp(tline->text, "flat") == 0) {
2300 /* All subsequent ARG directives are for a 32-bit stack */
2301 StackSize = 4;
2302 StackPointer = "ebp";
2303 ArgOffset = 8;
2304 LocalOffset = 0;
2305 } else if (nasm_stricmp(tline->text, "flat64") == 0) {
2306 /* All subsequent ARG directives are for a 64-bit stack */
2307 StackSize = 8;
2308 StackPointer = "rbp";
2309 ArgOffset = 16;
2310 LocalOffset = 0;
2311 } else if (nasm_stricmp(tline->text, "large") == 0) {
2312 /* All subsequent ARG directives are for a 16-bit stack,
2313 * far function call.
2315 StackSize = 2;
2316 StackPointer = "bp";
2317 ArgOffset = 4;
2318 LocalOffset = 0;
2319 } else if (nasm_stricmp(tline->text, "small") == 0) {
2320 /* All subsequent ARG directives are for a 16-bit stack,
2321 * far function call. We don't support near functions.
2323 StackSize = 2;
2324 StackPointer = "bp";
2325 ArgOffset = 6;
2326 LocalOffset = 0;
2327 } else {
2328 nasm_error(ERR_NONFATAL, "`%%stacksize' invalid size type");
2329 free_tlist(origline);
2330 return DIRECTIVE_FOUND;
2332 free_tlist(origline);
2333 return DIRECTIVE_FOUND;
2335 case PP_ARG:
2336 /* TASM like ARG directive to define arguments to functions, in
2337 * the following form:
2339 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2341 offset = ArgOffset;
2342 do {
2343 char *arg, directive[256];
2344 int size = StackSize;
2346 /* Find the argument name */
2347 tline = tline->next;
2348 if (tline && tline->type == TOK_WHITESPACE)
2349 tline = tline->next;
2350 if (!tline || tline->type != TOK_ID) {
2351 nasm_error(ERR_NONFATAL, "`%%arg' missing argument parameter");
2352 free_tlist(origline);
2353 return DIRECTIVE_FOUND;
2355 arg = tline->text;
2357 /* Find the argument size type */
2358 tline = tline->next;
2359 if (!tline || tline->type != TOK_OTHER
2360 || tline->text[0] != ':') {
2361 nasm_error(ERR_NONFATAL,
2362 "Syntax error processing `%%arg' directive");
2363 free_tlist(origline);
2364 return DIRECTIVE_FOUND;
2366 tline = tline->next;
2367 if (!tline || tline->type != TOK_ID) {
2368 nasm_error(ERR_NONFATAL, "`%%arg' missing size type parameter");
2369 free_tlist(origline);
2370 return DIRECTIVE_FOUND;
2373 /* Allow macro expansion of type parameter */
2374 tt = tokenize(tline->text);
2375 tt = expand_smacro(tt);
2376 size = parse_size(tt->text);
2377 if (!size) {
2378 nasm_error(ERR_NONFATAL,
2379 "Invalid size type for `%%arg' missing directive");
2380 free_tlist(tt);
2381 free_tlist(origline);
2382 return DIRECTIVE_FOUND;
2384 free_tlist(tt);
2386 /* Round up to even stack slots */
2387 size = ALIGN(size, StackSize);
2389 /* Now define the macro for the argument */
2390 snprintf(directive, sizeof(directive), "%%define %s (%s+%d)",
2391 arg, StackPointer, offset);
2392 do_directive(tokenize(directive));
2393 offset += size;
2395 /* Move to the next argument in the list */
2396 tline = tline->next;
2397 if (tline && tline->type == TOK_WHITESPACE)
2398 tline = tline->next;
2399 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2400 ArgOffset = offset;
2401 free_tlist(origline);
2402 return DIRECTIVE_FOUND;
2404 case PP_LOCAL:
2405 /* TASM like LOCAL directive to define local variables for a
2406 * function, in the following form:
2408 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2410 * The '= LocalSize' at the end is ignored by NASM, but is
2411 * required by TASM to define the local parameter size (and used
2412 * by the TASM macro package).
2414 offset = LocalOffset;
2415 do {
2416 char *local, directive[256];
2417 int size = StackSize;
2419 /* Find the argument name */
2420 tline = tline->next;
2421 if (tline && tline->type == TOK_WHITESPACE)
2422 tline = tline->next;
2423 if (!tline || tline->type != TOK_ID) {
2424 nasm_error(ERR_NONFATAL,
2425 "`%%local' missing argument parameter");
2426 free_tlist(origline);
2427 return DIRECTIVE_FOUND;
2429 local = tline->text;
2431 /* Find the argument size type */
2432 tline = tline->next;
2433 if (!tline || tline->type != TOK_OTHER
2434 || tline->text[0] != ':') {
2435 nasm_error(ERR_NONFATAL,
2436 "Syntax error processing `%%local' directive");
2437 free_tlist(origline);
2438 return DIRECTIVE_FOUND;
2440 tline = tline->next;
2441 if (!tline || tline->type != TOK_ID) {
2442 nasm_error(ERR_NONFATAL,
2443 "`%%local' missing size type parameter");
2444 free_tlist(origline);
2445 return DIRECTIVE_FOUND;
2448 /* Allow macro expansion of type parameter */
2449 tt = tokenize(tline->text);
2450 tt = expand_smacro(tt);
2451 size = parse_size(tt->text);
2452 if (!size) {
2453 nasm_error(ERR_NONFATAL,
2454 "Invalid size type for `%%local' missing directive");
2455 free_tlist(tt);
2456 free_tlist(origline);
2457 return DIRECTIVE_FOUND;
2459 free_tlist(tt);
2461 /* Round up to even stack slots */
2462 size = ALIGN(size, StackSize);
2464 offset += size; /* Negative offset, increment before */
2466 /* Now define the macro for the argument */
2467 snprintf(directive, sizeof(directive), "%%define %s (%s-%d)",
2468 local, StackPointer, offset);
2469 do_directive(tokenize(directive));
2471 /* Now define the assign to setup the enter_c macro correctly */
2472 snprintf(directive, sizeof(directive),
2473 "%%assign %%$localsize %%$localsize+%d", size);
2474 do_directive(tokenize(directive));
2476 /* Move to the next argument in the list */
2477 tline = tline->next;
2478 if (tline && tline->type == TOK_WHITESPACE)
2479 tline = tline->next;
2480 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2481 LocalOffset = offset;
2482 free_tlist(origline);
2483 return DIRECTIVE_FOUND;
2485 case PP_CLEAR:
2486 if (tline->next)
2487 nasm_error(ERR_WARNING|ERR_PASS1,
2488 "trailing garbage after `%%clear' ignored");
2489 free_macros();
2490 init_macros();
2491 free_tlist(origline);
2492 return DIRECTIVE_FOUND;
2494 case PP_DEPEND:
2495 t = tline->next = expand_smacro(tline->next);
2496 skip_white_(t);
2497 if (!t || (t->type != TOK_STRING &&
2498 t->type != TOK_INTERNAL_STRING)) {
2499 nasm_error(ERR_NONFATAL, "`%%depend' expects a file name");
2500 free_tlist(origline);
2501 return DIRECTIVE_FOUND; /* but we did _something_ */
2503 if (t->next)
2504 nasm_error(ERR_WARNING|ERR_PASS1,
2505 "trailing garbage after `%%depend' ignored");
2506 p = t->text;
2507 if (t->type != TOK_INTERNAL_STRING)
2508 nasm_unquote_cstr(p, i);
2509 if (dephead && !in_list(*dephead, p)) {
2510 StrList *sl = nasm_malloc(strlen(p)+1+sizeof sl->next);
2511 sl->next = NULL;
2512 strcpy(sl->str, p);
2513 *deptail = sl;
2514 deptail = &sl->next;
2516 free_tlist(origline);
2517 return DIRECTIVE_FOUND;
2519 case PP_INCLUDE:
2520 t = tline->next = expand_smacro(tline->next);
2521 skip_white_(t);
2523 if (!t || (t->type != TOK_STRING &&
2524 t->type != TOK_INTERNAL_STRING)) {
2525 nasm_error(ERR_NONFATAL, "`%%include' expects a file name");
2526 free_tlist(origline);
2527 return DIRECTIVE_FOUND; /* but we did _something_ */
2529 if (t->next)
2530 nasm_error(ERR_WARNING|ERR_PASS1,
2531 "trailing garbage after `%%include' ignored");
2532 p = t->text;
2533 if (t->type != TOK_INTERNAL_STRING)
2534 nasm_unquote_cstr(p, i);
2535 inc = nasm_malloc(sizeof(Include));
2536 inc->next = istk;
2537 inc->conds = NULL;
2538 found_path = NULL;
2539 inc->fp = inc_fopen(p, dephead, &deptail, &found_path, pass == 0, "r");
2540 if (!inc->fp) {
2541 /* -MG given but file not found */
2542 nasm_free(inc);
2543 } else {
2544 inc->fname = src_set_fname(found_path ? found_path : p);
2545 inc->lineno = src_set_linnum(0);
2546 inc->lineinc = 1;
2547 inc->expansion = NULL;
2548 inc->mstk = NULL;
2549 istk = inc;
2550 lfmt->uplevel(LIST_INCLUDE);
2552 free_tlist(origline);
2553 return DIRECTIVE_FOUND;
2555 case PP_USE:
2557 static macros_t *use_pkg;
2558 const char *pkg_macro = NULL;
2560 tline = tline->next;
2561 skip_white_(tline);
2562 tline = expand_id(tline);
2564 if (!tline || (tline->type != TOK_STRING &&
2565 tline->type != TOK_INTERNAL_STRING &&
2566 tline->type != TOK_ID)) {
2567 nasm_error(ERR_NONFATAL, "`%%use' expects a package name");
2568 free_tlist(origline);
2569 return DIRECTIVE_FOUND; /* but we did _something_ */
2571 if (tline->next)
2572 nasm_error(ERR_WARNING|ERR_PASS1,
2573 "trailing garbage after `%%use' ignored");
2574 if (tline->type == TOK_STRING)
2575 nasm_unquote_cstr(tline->text, i);
2576 use_pkg = nasm_stdmac_find_package(tline->text);
2577 if (!use_pkg)
2578 nasm_error(ERR_NONFATAL, "unknown `%%use' package: %s", tline->text);
2579 else
2580 pkg_macro = (char *)use_pkg + 1; /* The first string will be <%define>__USE_*__ */
2581 if (use_pkg && ! smacro_defined(NULL, pkg_macro, 0, NULL, true)) {
2582 /* Not already included, go ahead and include it */
2583 stdmacpos = use_pkg;
2585 free_tlist(origline);
2586 return DIRECTIVE_FOUND;
2588 case PP_PUSH:
2589 case PP_REPL:
2590 case PP_POP:
2591 tline = tline->next;
2592 skip_white_(tline);
2593 tline = expand_id(tline);
2594 if (tline) {
2595 if (!tok_type_(tline, TOK_ID)) {
2596 nasm_error(ERR_NONFATAL, "`%s' expects a context identifier",
2597 pp_directives[i]);
2598 free_tlist(origline);
2599 return DIRECTIVE_FOUND; /* but we did _something_ */
2601 if (tline->next)
2602 nasm_error(ERR_WARNING|ERR_PASS1,
2603 "trailing garbage after `%s' ignored",
2604 pp_directives[i]);
2605 p = nasm_strdup(tline->text);
2606 } else {
2607 p = NULL; /* Anonymous */
2610 if (i == PP_PUSH) {
2611 ctx = nasm_malloc(sizeof(Context));
2612 ctx->next = cstk;
2613 hash_init(&ctx->localmac, HASH_SMALL);
2614 ctx->name = p;
2615 ctx->number = unique++;
2616 cstk = ctx;
2617 } else {
2618 /* %pop or %repl */
2619 if (!cstk) {
2620 nasm_error(ERR_NONFATAL, "`%s': context stack is empty",
2621 pp_directives[i]);
2622 } else if (i == PP_POP) {
2623 if (p && (!cstk->name || nasm_stricmp(p, cstk->name)))
2624 nasm_error(ERR_NONFATAL, "`%%pop' in wrong context: %s, "
2625 "expected %s",
2626 cstk->name ? cstk->name : "anonymous", p);
2627 else
2628 ctx_pop();
2629 } else {
2630 /* i == PP_REPL */
2631 nasm_free(cstk->name);
2632 cstk->name = p;
2633 p = NULL;
2635 nasm_free(p);
2637 free_tlist(origline);
2638 return DIRECTIVE_FOUND;
2639 case PP_FATAL:
2640 severity = ERR_FATAL;
2641 goto issue_error;
2642 case PP_ERROR:
2643 severity = ERR_NONFATAL;
2644 goto issue_error;
2645 case PP_WARNING:
2646 severity = ERR_WARNING|ERR_WARN_USER;
2647 goto issue_error;
2649 issue_error:
2651 /* Only error out if this is the final pass */
2652 if (pass != 2 && i != PP_FATAL)
2653 return DIRECTIVE_FOUND;
2655 tline->next = expand_smacro(tline->next);
2656 tline = tline->next;
2657 skip_white_(tline);
2658 t = tline ? tline->next : NULL;
2659 skip_white_(t);
2660 if (tok_type_(tline, TOK_STRING) && !t) {
2661 /* The line contains only a quoted string */
2662 p = tline->text;
2663 nasm_unquote(p, NULL); /* Ignore NUL character truncation */
2664 nasm_error(severity, "%s", p);
2665 } else {
2666 /* Not a quoted string, or more than a quoted string */
2667 p = detoken(tline, false);
2668 nasm_error(severity, "%s", p);
2669 nasm_free(p);
2671 free_tlist(origline);
2672 return DIRECTIVE_FOUND;
2675 CASE_PP_IF:
2676 if (istk->conds && !emitting(istk->conds->state))
2677 j = COND_NEVER;
2678 else {
2679 j = if_condition(tline->next, i);
2680 tline->next = NULL; /* it got freed */
2681 j = j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2683 cond = nasm_malloc(sizeof(Cond));
2684 cond->next = istk->conds;
2685 cond->state = j;
2686 istk->conds = cond;
2687 if(istk->mstk)
2688 istk->mstk->condcnt ++;
2689 free_tlist(origline);
2690 return DIRECTIVE_FOUND;
2692 CASE_PP_ELIF:
2693 if (!istk->conds)
2694 nasm_error(ERR_FATAL, "`%s': no matching `%%if'", pp_directives[i]);
2695 switch(istk->conds->state) {
2696 case COND_IF_TRUE:
2697 istk->conds->state = COND_DONE;
2698 break;
2700 case COND_DONE:
2701 case COND_NEVER:
2702 break;
2704 case COND_ELSE_TRUE:
2705 case COND_ELSE_FALSE:
2706 nasm_error(ERR_WARNING|ERR_PASS1|ERR_PP_PRECOND,
2707 "`%%elif' after `%%else' ignored");
2708 istk->conds->state = COND_NEVER;
2709 break;
2711 case COND_IF_FALSE:
2713 * IMPORTANT: In the case of %if, we will already have
2714 * called expand_mmac_params(); however, if we're
2715 * processing an %elif we must have been in a
2716 * non-emitting mode, which would have inhibited
2717 * the normal invocation of expand_mmac_params().
2718 * Therefore, we have to do it explicitly here.
2720 j = if_condition(expand_mmac_params(tline->next), i);
2721 tline->next = NULL; /* it got freed */
2722 istk->conds->state =
2723 j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2724 break;
2726 free_tlist(origline);
2727 return DIRECTIVE_FOUND;
2729 case PP_ELSE:
2730 if (tline->next)
2731 nasm_error(ERR_WARNING|ERR_PASS1|ERR_PP_PRECOND,
2732 "trailing garbage after `%%else' ignored");
2733 if (!istk->conds)
2734 nasm_fatal(0, "`%%else: no matching `%%if'");
2735 switch(istk->conds->state) {
2736 case COND_IF_TRUE:
2737 case COND_DONE:
2738 istk->conds->state = COND_ELSE_FALSE;
2739 break;
2741 case COND_NEVER:
2742 break;
2744 case COND_IF_FALSE:
2745 istk->conds->state = COND_ELSE_TRUE;
2746 break;
2748 case COND_ELSE_TRUE:
2749 case COND_ELSE_FALSE:
2750 nasm_error(ERR_WARNING|ERR_PASS1|ERR_PP_PRECOND,
2751 "`%%else' after `%%else' ignored.");
2752 istk->conds->state = COND_NEVER;
2753 break;
2755 free_tlist(origline);
2756 return DIRECTIVE_FOUND;
2758 case PP_ENDIF:
2759 if (tline->next)
2760 nasm_error(ERR_WARNING|ERR_PASS1|ERR_PP_PRECOND,
2761 "trailing garbage after `%%endif' ignored");
2762 if (!istk->conds)
2763 nasm_error(ERR_FATAL, "`%%endif': no matching `%%if'");
2764 cond = istk->conds;
2765 istk->conds = cond->next;
2766 nasm_free(cond);
2767 if(istk->mstk)
2768 istk->mstk->condcnt --;
2769 free_tlist(origline);
2770 return DIRECTIVE_FOUND;
2772 case PP_RMACRO:
2773 case PP_IRMACRO:
2774 case PP_MACRO:
2775 case PP_IMACRO:
2776 if (defining) {
2777 nasm_error(ERR_FATAL, "`%s': already defining a macro",
2778 pp_directives[i]);
2779 return DIRECTIVE_FOUND;
2781 defining = nasm_zalloc(sizeof(MMacro));
2782 defining->max_depth =
2783 (i == PP_RMACRO) || (i == PP_IRMACRO) ? DEADMAN_LIMIT : 0;
2784 defining->casesense = (i == PP_MACRO) || (i == PP_RMACRO);
2785 if (!parse_mmacro_spec(tline, defining, pp_directives[i])) {
2786 nasm_free(defining);
2787 defining = NULL;
2788 return DIRECTIVE_FOUND;
2791 src_get(&defining->xline, &defining->fname);
2793 mmac = (MMacro *) hash_findix(&mmacros, defining->name);
2794 while (mmac) {
2795 if (!strcmp(mmac->name, defining->name) &&
2796 (mmac->nparam_min <= defining->nparam_max
2797 || defining->plus)
2798 && (defining->nparam_min <= mmac->nparam_max
2799 || mmac->plus)) {
2800 nasm_error(ERR_WARNING|ERR_PASS1,
2801 "redefining multi-line macro `%s'", defining->name);
2802 return DIRECTIVE_FOUND;
2804 mmac = mmac->next;
2806 free_tlist(origline);
2807 return DIRECTIVE_FOUND;
2809 case PP_ENDM:
2810 case PP_ENDMACRO:
2811 if (! (defining && defining->name)) {
2812 nasm_error(ERR_NONFATAL, "`%s': not defining a macro", tline->text);
2813 return DIRECTIVE_FOUND;
2815 mmhead = (MMacro **) hash_findi_add(&mmacros, defining->name);
2816 defining->next = *mmhead;
2817 *mmhead = defining;
2818 defining = NULL;
2819 free_tlist(origline);
2820 return DIRECTIVE_FOUND;
2822 case PP_EXITMACRO:
2824 * We must search along istk->expansion until we hit a
2825 * macro-end marker for a macro with a name. Then we
2826 * bypass all lines between exitmacro and endmacro.
2828 list_for_each(l, istk->expansion)
2829 if (l->finishes && l->finishes->name)
2830 break;
2832 if (l) {
2834 * Remove all conditional entries relative to this
2835 * macro invocation. (safe to do in this context)
2837 for ( ; l->finishes->condcnt > 0; l->finishes->condcnt --) {
2838 cond = istk->conds;
2839 istk->conds = cond->next;
2840 nasm_free(cond);
2842 istk->expansion = l;
2843 } else {
2844 nasm_error(ERR_NONFATAL, "`%%exitmacro' not within `%%macro' block");
2846 free_tlist(origline);
2847 return DIRECTIVE_FOUND;
2849 case PP_UNMACRO:
2850 case PP_UNIMACRO:
2852 MMacro **mmac_p;
2853 MMacro spec;
2855 spec.casesense = (i == PP_UNMACRO);
2856 if (!parse_mmacro_spec(tline, &spec, pp_directives[i])) {
2857 return DIRECTIVE_FOUND;
2859 mmac_p = (MMacro **) hash_findi(&mmacros, spec.name, NULL);
2860 while (mmac_p && *mmac_p) {
2861 mmac = *mmac_p;
2862 if (mmac->casesense == spec.casesense &&
2863 !mstrcmp(mmac->name, spec.name, spec.casesense) &&
2864 mmac->nparam_min == spec.nparam_min &&
2865 mmac->nparam_max == spec.nparam_max &&
2866 mmac->plus == spec.plus) {
2867 *mmac_p = mmac->next;
2868 free_mmacro(mmac);
2869 } else {
2870 mmac_p = &mmac->next;
2873 free_tlist(origline);
2874 free_tlist(spec.dlist);
2875 return DIRECTIVE_FOUND;
2878 case PP_ROTATE:
2879 if (tline->next && tline->next->type == TOK_WHITESPACE)
2880 tline = tline->next;
2881 if (!tline->next) {
2882 free_tlist(origline);
2883 nasm_error(ERR_NONFATAL, "`%%rotate' missing rotate count");
2884 return DIRECTIVE_FOUND;
2886 t = expand_smacro(tline->next);
2887 tline->next = NULL;
2888 free_tlist(origline);
2889 tline = t;
2890 tptr = &t;
2891 tokval.t_type = TOKEN_INVALID;
2892 evalresult =
2893 evaluate(ppscan, tptr, &tokval, NULL, pass, NULL);
2894 free_tlist(tline);
2895 if (!evalresult)
2896 return DIRECTIVE_FOUND;
2897 if (tokval.t_type)
2898 nasm_error(ERR_WARNING|ERR_PASS1,
2899 "trailing garbage after expression ignored");
2900 if (!is_simple(evalresult)) {
2901 nasm_error(ERR_NONFATAL, "non-constant value given to `%%rotate'");
2902 return DIRECTIVE_FOUND;
2904 mmac = istk->mstk;
2905 while (mmac && !mmac->name) /* avoid mistaking %reps for macros */
2906 mmac = mmac->next_active;
2907 if (!mmac) {
2908 nasm_error(ERR_NONFATAL, "`%%rotate' invoked outside a macro call");
2909 } else if (mmac->nparam == 0) {
2910 nasm_error(ERR_NONFATAL,
2911 "`%%rotate' invoked within macro without parameters");
2912 } else {
2913 int rotate = mmac->rotate + reloc_value(evalresult);
2915 rotate %= (int)mmac->nparam;
2916 if (rotate < 0)
2917 rotate += mmac->nparam;
2919 mmac->rotate = rotate;
2921 return DIRECTIVE_FOUND;
2923 case PP_REP:
2924 nolist = false;
2925 do {
2926 tline = tline->next;
2927 } while (tok_type_(tline, TOK_WHITESPACE));
2929 if (tok_type_(tline, TOK_ID) &&
2930 nasm_stricmp(tline->text, ".nolist") == 0) {
2931 nolist = true;
2932 do {
2933 tline = tline->next;
2934 } while (tok_type_(tline, TOK_WHITESPACE));
2937 if (tline) {
2938 t = expand_smacro(tline);
2939 tptr = &t;
2940 tokval.t_type = TOKEN_INVALID;
2941 evalresult =
2942 evaluate(ppscan, tptr, &tokval, NULL, pass, NULL);
2943 if (!evalresult) {
2944 free_tlist(origline);
2945 return DIRECTIVE_FOUND;
2947 if (tokval.t_type)
2948 nasm_error(ERR_WARNING|ERR_PASS1,
2949 "trailing garbage after expression ignored");
2950 if (!is_simple(evalresult)) {
2951 nasm_error(ERR_NONFATAL, "non-constant value given to `%%rep'");
2952 return DIRECTIVE_FOUND;
2954 count = reloc_value(evalresult);
2955 if (count >= REP_LIMIT) {
2956 nasm_error(ERR_NONFATAL, "`%%rep' value exceeds limit");
2957 count = 0;
2958 } else
2959 count++;
2960 } else {
2961 nasm_error(ERR_NONFATAL, "`%%rep' expects a repeat count");
2962 count = 0;
2964 free_tlist(origline);
2966 tmp_defining = defining;
2967 defining = nasm_malloc(sizeof(MMacro));
2968 defining->prev = NULL;
2969 defining->name = NULL; /* flags this macro as a %rep block */
2970 defining->casesense = false;
2971 defining->plus = false;
2972 defining->nolist = nolist;
2973 defining->in_progress = count;
2974 defining->max_depth = 0;
2975 defining->nparam_min = defining->nparam_max = 0;
2976 defining->defaults = NULL;
2977 defining->dlist = NULL;
2978 defining->expansion = NULL;
2979 defining->next_active = istk->mstk;
2980 defining->rep_nest = tmp_defining;
2981 return DIRECTIVE_FOUND;
2983 case PP_ENDREP:
2984 if (!defining || defining->name) {
2985 nasm_error(ERR_NONFATAL, "`%%endrep': no matching `%%rep'");
2986 return DIRECTIVE_FOUND;
2990 * Now we have a "macro" defined - although it has no name
2991 * and we won't be entering it in the hash tables - we must
2992 * push a macro-end marker for it on to istk->expansion.
2993 * After that, it will take care of propagating itself (a
2994 * macro-end marker line for a macro which is really a %rep
2995 * block will cause the macro to be re-expanded, complete
2996 * with another macro-end marker to ensure the process
2997 * continues) until the whole expansion is forcibly removed
2998 * from istk->expansion by a %exitrep.
3000 l = nasm_malloc(sizeof(Line));
3001 l->next = istk->expansion;
3002 l->finishes = defining;
3003 l->first = NULL;
3004 istk->expansion = l;
3006 istk->mstk = defining;
3008 lfmt->uplevel(defining->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
3009 tmp_defining = defining;
3010 defining = defining->rep_nest;
3011 free_tlist(origline);
3012 return DIRECTIVE_FOUND;
3014 case PP_EXITREP:
3016 * We must search along istk->expansion until we hit a
3017 * macro-end marker for a macro with no name. Then we set
3018 * its `in_progress' flag to 0.
3020 list_for_each(l, istk->expansion)
3021 if (l->finishes && !l->finishes->name)
3022 break;
3024 if (l)
3025 l->finishes->in_progress = 1;
3026 else
3027 nasm_error(ERR_NONFATAL, "`%%exitrep' not within `%%rep' block");
3028 free_tlist(origline);
3029 return DIRECTIVE_FOUND;
3031 case PP_XDEFINE:
3032 case PP_IXDEFINE:
3033 case PP_DEFINE:
3034 case PP_IDEFINE:
3035 casesense = (i == PP_DEFINE || i == PP_XDEFINE);
3037 tline = tline->next;
3038 skip_white_(tline);
3039 tline = expand_id(tline);
3040 if (!tline || (tline->type != TOK_ID &&
3041 (tline->type != TOK_PREPROC_ID ||
3042 tline->text[1] != '$'))) {
3043 nasm_error(ERR_NONFATAL, "`%s' expects a macro identifier",
3044 pp_directives[i]);
3045 free_tlist(origline);
3046 return DIRECTIVE_FOUND;
3049 ctx = get_ctx(tline->text, &mname);
3050 last = tline;
3051 param_start = tline = tline->next;
3052 nparam = 0;
3054 /* Expand the macro definition now for %xdefine and %ixdefine */
3055 if ((i == PP_XDEFINE) || (i == PP_IXDEFINE))
3056 tline = expand_smacro(tline);
3058 if (tok_is_(tline, "(")) {
3060 * This macro has parameters.
3063 tline = tline->next;
3064 while (1) {
3065 skip_white_(tline);
3066 if (!tline) {
3067 nasm_error(ERR_NONFATAL, "parameter identifier expected");
3068 free_tlist(origline);
3069 return DIRECTIVE_FOUND;
3071 if (tline->type != TOK_ID) {
3072 nasm_error(ERR_NONFATAL,
3073 "`%s': parameter identifier expected",
3074 tline->text);
3075 free_tlist(origline);
3076 return DIRECTIVE_FOUND;
3078 tline->type = TOK_SMAC_PARAM + nparam++;
3079 tline = tline->next;
3080 skip_white_(tline);
3081 if (tok_is_(tline, ",")) {
3082 tline = tline->next;
3083 } else {
3084 if (!tok_is_(tline, ")")) {
3085 nasm_error(ERR_NONFATAL,
3086 "`)' expected to terminate macro template");
3087 free_tlist(origline);
3088 return DIRECTIVE_FOUND;
3090 break;
3093 last = tline;
3094 tline = tline->next;
3096 if (tok_type_(tline, TOK_WHITESPACE))
3097 last = tline, tline = tline->next;
3098 macro_start = NULL;
3099 last->next = NULL;
3100 t = tline;
3101 while (t) {
3102 if (t->type == TOK_ID) {
3103 list_for_each(tt, param_start)
3104 if (tt->type >= TOK_SMAC_PARAM &&
3105 !strcmp(tt->text, t->text))
3106 t->type = tt->type;
3108 tt = t->next;
3109 t->next = macro_start;
3110 macro_start = t;
3111 t = tt;
3114 * Good. We now have a macro name, a parameter count, and a
3115 * token list (in reverse order) for an expansion. We ought
3116 * to be OK just to create an SMacro, store it, and let
3117 * free_tlist have the rest of the line (which we have
3118 * carefully re-terminated after chopping off the expansion
3119 * from the end).
3121 define_smacro(ctx, mname, casesense, nparam, macro_start);
3122 free_tlist(origline);
3123 return DIRECTIVE_FOUND;
3125 case PP_UNDEF:
3126 tline = tline->next;
3127 skip_white_(tline);
3128 tline = expand_id(tline);
3129 if (!tline || (tline->type != TOK_ID &&
3130 (tline->type != TOK_PREPROC_ID ||
3131 tline->text[1] != '$'))) {
3132 nasm_error(ERR_NONFATAL, "`%%undef' expects a macro identifier");
3133 free_tlist(origline);
3134 return DIRECTIVE_FOUND;
3136 if (tline->next) {
3137 nasm_error(ERR_WARNING|ERR_PASS1,
3138 "trailing garbage after macro name ignored");
3141 /* Find the context that symbol belongs to */
3142 ctx = get_ctx(tline->text, &mname);
3143 undef_smacro(ctx, mname);
3144 free_tlist(origline);
3145 return DIRECTIVE_FOUND;
3147 case PP_DEFSTR:
3148 case PP_IDEFSTR:
3149 casesense = (i == PP_DEFSTR);
3151 tline = tline->next;
3152 skip_white_(tline);
3153 tline = expand_id(tline);
3154 if (!tline || (tline->type != TOK_ID &&
3155 (tline->type != TOK_PREPROC_ID ||
3156 tline->text[1] != '$'))) {
3157 nasm_error(ERR_NONFATAL, "`%s' expects a macro identifier",
3158 pp_directives[i]);
3159 free_tlist(origline);
3160 return DIRECTIVE_FOUND;
3163 ctx = get_ctx(tline->text, &mname);
3164 last = tline;
3165 tline = expand_smacro(tline->next);
3166 last->next = NULL;
3168 while (tok_type_(tline, TOK_WHITESPACE))
3169 tline = delete_Token(tline);
3171 p = detoken(tline, false);
3172 macro_start = nasm_malloc(sizeof(*macro_start));
3173 macro_start->next = NULL;
3174 macro_start->text = nasm_quote(p, strlen(p));
3175 macro_start->type = TOK_STRING;
3176 macro_start->a.mac = NULL;
3177 nasm_free(p);
3180 * We now have a macro name, an implicit parameter count of
3181 * zero, and a string token to use as an expansion. Create
3182 * and store an SMacro.
3184 define_smacro(ctx, mname, casesense, 0, macro_start);
3185 free_tlist(origline);
3186 return DIRECTIVE_FOUND;
3188 case PP_DEFTOK:
3189 case PP_IDEFTOK:
3190 casesense = (i == PP_DEFTOK);
3192 tline = tline->next;
3193 skip_white_(tline);
3194 tline = expand_id(tline);
3195 if (!tline || (tline->type != TOK_ID &&
3196 (tline->type != TOK_PREPROC_ID ||
3197 tline->text[1] != '$'))) {
3198 nasm_error(ERR_NONFATAL,
3199 "`%s' expects a macro identifier as first parameter",
3200 pp_directives[i]);
3201 free_tlist(origline);
3202 return DIRECTIVE_FOUND;
3204 ctx = get_ctx(tline->text, &mname);
3205 last = tline;
3206 tline = expand_smacro(tline->next);
3207 last->next = NULL;
3209 t = tline;
3210 while (tok_type_(t, TOK_WHITESPACE))
3211 t = t->next;
3212 /* t should now point to the string */
3213 if (!tok_type_(t, TOK_STRING)) {
3214 nasm_error(ERR_NONFATAL,
3215 "`%s` requires string as second parameter",
3216 pp_directives[i]);
3217 free_tlist(tline);
3218 free_tlist(origline);
3219 return DIRECTIVE_FOUND;
3223 * Convert the string to a token stream. Note that smacros
3224 * are stored with the token stream reversed, so we have to
3225 * reverse the output of tokenize().
3227 nasm_unquote_cstr(t->text, i);
3228 macro_start = reverse_tokens(tokenize(t->text));
3231 * We now have a macro name, an implicit parameter count of
3232 * zero, and a numeric token to use as an expansion. Create
3233 * and store an SMacro.
3235 define_smacro(ctx, mname, casesense, 0, macro_start);
3236 free_tlist(tline);
3237 free_tlist(origline);
3238 return DIRECTIVE_FOUND;
3240 case PP_PATHSEARCH:
3242 FILE *fp;
3243 StrList *xsl = NULL;
3244 StrList **xst = &xsl;
3246 casesense = true;
3248 tline = tline->next;
3249 skip_white_(tline);
3250 tline = expand_id(tline);
3251 if (!tline || (tline->type != TOK_ID &&
3252 (tline->type != TOK_PREPROC_ID ||
3253 tline->text[1] != '$'))) {
3254 nasm_error(ERR_NONFATAL,
3255 "`%%pathsearch' expects a macro identifier as first parameter");
3256 free_tlist(origline);
3257 return DIRECTIVE_FOUND;
3259 ctx = get_ctx(tline->text, &mname);
3260 last = tline;
3261 tline = expand_smacro(tline->next);
3262 last->next = NULL;
3264 t = tline;
3265 while (tok_type_(t, TOK_WHITESPACE))
3266 t = t->next;
3268 if (!t || (t->type != TOK_STRING &&
3269 t->type != TOK_INTERNAL_STRING)) {
3270 nasm_error(ERR_NONFATAL, "`%%pathsearch' expects a file name");
3271 free_tlist(tline);
3272 free_tlist(origline);
3273 return DIRECTIVE_FOUND; /* but we did _something_ */
3275 if (t->next)
3276 nasm_error(ERR_WARNING|ERR_PASS1,
3277 "trailing garbage after `%%pathsearch' ignored");
3278 p = t->text;
3279 if (t->type != TOK_INTERNAL_STRING)
3280 nasm_unquote(p, NULL);
3282 fp = inc_fopen(p, &xsl, &xst, NULL, true, "r");
3283 if (fp) {
3284 p = xsl->str;
3285 fclose(fp); /* Don't actually care about the file */
3287 macro_start = nasm_malloc(sizeof(*macro_start));
3288 macro_start->next = NULL;
3289 macro_start->text = nasm_quote(p, strlen(p));
3290 macro_start->type = TOK_STRING;
3291 macro_start->a.mac = NULL;
3292 if (xsl)
3293 nasm_free(xsl);
3296 * We now have a macro name, an implicit parameter count of
3297 * zero, and a string token to use as an expansion. Create
3298 * and store an SMacro.
3300 define_smacro(ctx, mname, casesense, 0, macro_start);
3301 free_tlist(tline);
3302 free_tlist(origline);
3303 return DIRECTIVE_FOUND;
3306 case PP_STRLEN:
3307 casesense = true;
3309 tline = tline->next;
3310 skip_white_(tline);
3311 tline = expand_id(tline);
3312 if (!tline || (tline->type != TOK_ID &&
3313 (tline->type != TOK_PREPROC_ID ||
3314 tline->text[1] != '$'))) {
3315 nasm_error(ERR_NONFATAL,
3316 "`%%strlen' expects a macro identifier as first parameter");
3317 free_tlist(origline);
3318 return DIRECTIVE_FOUND;
3320 ctx = get_ctx(tline->text, &mname);
3321 last = tline;
3322 tline = expand_smacro(tline->next);
3323 last->next = NULL;
3325 t = tline;
3326 while (tok_type_(t, TOK_WHITESPACE))
3327 t = t->next;
3328 /* t should now point to the string */
3329 if (!tok_type_(t, TOK_STRING)) {
3330 nasm_error(ERR_NONFATAL,
3331 "`%%strlen` requires string as second parameter");
3332 free_tlist(tline);
3333 free_tlist(origline);
3334 return DIRECTIVE_FOUND;
3337 macro_start = nasm_malloc(sizeof(*macro_start));
3338 macro_start->next = NULL;
3339 make_tok_num(macro_start, nasm_unquote(t->text, NULL));
3340 macro_start->a.mac = NULL;
3343 * We now have a macro name, an implicit parameter count of
3344 * zero, and a numeric token to use as an expansion. Create
3345 * and store an SMacro.
3347 define_smacro(ctx, mname, casesense, 0, macro_start);
3348 free_tlist(tline);
3349 free_tlist(origline);
3350 return DIRECTIVE_FOUND;
3352 case PP_STRCAT:
3353 casesense = true;
3355 tline = tline->next;
3356 skip_white_(tline);
3357 tline = expand_id(tline);
3358 if (!tline || (tline->type != TOK_ID &&
3359 (tline->type != TOK_PREPROC_ID ||
3360 tline->text[1] != '$'))) {
3361 nasm_error(ERR_NONFATAL,
3362 "`%%strcat' expects a macro identifier as first parameter");
3363 free_tlist(origline);
3364 return DIRECTIVE_FOUND;
3366 ctx = get_ctx(tline->text, &mname);
3367 last = tline;
3368 tline = expand_smacro(tline->next);
3369 last->next = NULL;
3371 len = 0;
3372 list_for_each(t, tline) {
3373 switch (t->type) {
3374 case TOK_WHITESPACE:
3375 break;
3376 case TOK_STRING:
3377 len += t->a.len = nasm_unquote(t->text, NULL);
3378 break;
3379 case TOK_OTHER:
3380 if (!strcmp(t->text, ",")) /* permit comma separators */
3381 break;
3382 /* else fall through */
3383 default:
3384 nasm_error(ERR_NONFATAL,
3385 "non-string passed to `%%strcat' (%d)", t->type);
3386 free_tlist(tline);
3387 free_tlist(origline);
3388 return DIRECTIVE_FOUND;
3392 p = pp = nasm_malloc(len);
3393 list_for_each(t, tline) {
3394 if (t->type == TOK_STRING) {
3395 memcpy(p, t->text, t->a.len);
3396 p += t->a.len;
3401 * We now have a macro name, an implicit parameter count of
3402 * zero, and a numeric token to use as an expansion. Create
3403 * and store an SMacro.
3405 macro_start = new_Token(NULL, TOK_STRING, NULL, 0);
3406 macro_start->text = nasm_quote(pp, len);
3407 nasm_free(pp);
3408 define_smacro(ctx, mname, casesense, 0, macro_start);
3409 free_tlist(tline);
3410 free_tlist(origline);
3411 return DIRECTIVE_FOUND;
3413 case PP_SUBSTR:
3415 int64_t start, count;
3416 size_t len;
3418 casesense = true;
3420 tline = tline->next;
3421 skip_white_(tline);
3422 tline = expand_id(tline);
3423 if (!tline || (tline->type != TOK_ID &&
3424 (tline->type != TOK_PREPROC_ID ||
3425 tline->text[1] != '$'))) {
3426 nasm_error(ERR_NONFATAL,
3427 "`%%substr' expects a macro identifier as first parameter");
3428 free_tlist(origline);
3429 return DIRECTIVE_FOUND;
3431 ctx = get_ctx(tline->text, &mname);
3432 last = tline;
3433 tline = expand_smacro(tline->next);
3434 last->next = NULL;
3436 if (tline) /* skip expanded id */
3437 t = tline->next;
3438 while (tok_type_(t, TOK_WHITESPACE))
3439 t = t->next;
3441 /* t should now point to the string */
3442 if (!tok_type_(t, TOK_STRING)) {
3443 nasm_error(ERR_NONFATAL,
3444 "`%%substr` requires string as second parameter");
3445 free_tlist(tline);
3446 free_tlist(origline);
3447 return DIRECTIVE_FOUND;
3450 tt = t->next;
3451 tptr = &tt;
3452 tokval.t_type = TOKEN_INVALID;
3453 evalresult = evaluate(ppscan, tptr, &tokval, NULL, pass, NULL);
3454 if (!evalresult) {
3455 free_tlist(tline);
3456 free_tlist(origline);
3457 return DIRECTIVE_FOUND;
3458 } else if (!is_simple(evalresult)) {
3459 nasm_error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3460 free_tlist(tline);
3461 free_tlist(origline);
3462 return DIRECTIVE_FOUND;
3464 start = evalresult->value - 1;
3466 while (tok_type_(tt, TOK_WHITESPACE))
3467 tt = tt->next;
3468 if (!tt) {
3469 count = 1; /* Backwards compatibility: one character */
3470 } else {
3471 tokval.t_type = TOKEN_INVALID;
3472 evalresult = evaluate(ppscan, tptr, &tokval, NULL, pass, NULL);
3473 if (!evalresult) {
3474 free_tlist(tline);
3475 free_tlist(origline);
3476 return DIRECTIVE_FOUND;
3477 } else if (!is_simple(evalresult)) {
3478 nasm_error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3479 free_tlist(tline);
3480 free_tlist(origline);
3481 return DIRECTIVE_FOUND;
3483 count = evalresult->value;
3486 len = nasm_unquote(t->text, NULL);
3488 /* make start and count being in range */
3489 if (start < 0)
3490 start = 0;
3491 if (count < 0)
3492 count = len + count + 1 - start;
3493 if (start + count > (int64_t)len)
3494 count = len - start;
3495 if (!len || count < 0 || start >=(int64_t)len)
3496 start = -1, count = 0; /* empty string */
3498 macro_start = nasm_malloc(sizeof(*macro_start));
3499 macro_start->next = NULL;
3500 macro_start->text = nasm_quote((start < 0) ? "" : t->text + start, count);
3501 macro_start->type = TOK_STRING;
3502 macro_start->a.mac = NULL;
3505 * We now have a macro name, an implicit parameter count of
3506 * zero, and a numeric token to use as an expansion. Create
3507 * and store an SMacro.
3509 define_smacro(ctx, mname, casesense, 0, macro_start);
3510 free_tlist(tline);
3511 free_tlist(origline);
3512 return DIRECTIVE_FOUND;
3515 case PP_ASSIGN:
3516 case PP_IASSIGN:
3517 casesense = (i == PP_ASSIGN);
3519 tline = tline->next;
3520 skip_white_(tline);
3521 tline = expand_id(tline);
3522 if (!tline || (tline->type != TOK_ID &&
3523 (tline->type != TOK_PREPROC_ID ||
3524 tline->text[1] != '$'))) {
3525 nasm_error(ERR_NONFATAL,
3526 "`%%%sassign' expects a macro identifier",
3527 (i == PP_IASSIGN ? "i" : ""));
3528 free_tlist(origline);
3529 return DIRECTIVE_FOUND;
3531 ctx = get_ctx(tline->text, &mname);
3532 last = tline;
3533 tline = expand_smacro(tline->next);
3534 last->next = NULL;
3536 t = tline;
3537 tptr = &t;
3538 tokval.t_type = TOKEN_INVALID;
3539 evalresult = evaluate(ppscan, tptr, &tokval, NULL, pass, NULL);
3540 free_tlist(tline);
3541 if (!evalresult) {
3542 free_tlist(origline);
3543 return DIRECTIVE_FOUND;
3546 if (tokval.t_type)
3547 nasm_error(ERR_WARNING|ERR_PASS1,
3548 "trailing garbage after expression ignored");
3550 if (!is_simple(evalresult)) {
3551 nasm_error(ERR_NONFATAL,
3552 "non-constant value given to `%%%sassign'",
3553 (i == PP_IASSIGN ? "i" : ""));
3554 free_tlist(origline);
3555 return DIRECTIVE_FOUND;
3558 macro_start = nasm_malloc(sizeof(*macro_start));
3559 macro_start->next = NULL;
3560 make_tok_num(macro_start, reloc_value(evalresult));
3561 macro_start->a.mac = NULL;
3564 * We now have a macro name, an implicit parameter count of
3565 * zero, and a numeric token to use as an expansion. Create
3566 * and store an SMacro.
3568 define_smacro(ctx, mname, casesense, 0, macro_start);
3569 free_tlist(origline);
3570 return DIRECTIVE_FOUND;
3572 case PP_LINE:
3574 * Syntax is `%line nnn[+mmm] [filename]'
3576 tline = tline->next;
3577 skip_white_(tline);
3578 if (!tok_type_(tline, TOK_NUMBER)) {
3579 nasm_error(ERR_NONFATAL, "`%%line' expects line number");
3580 free_tlist(origline);
3581 return DIRECTIVE_FOUND;
3583 k = readnum(tline->text, &err);
3584 m = 1;
3585 tline = tline->next;
3586 if (tok_is_(tline, "+")) {
3587 tline = tline->next;
3588 if (!tok_type_(tline, TOK_NUMBER)) {
3589 nasm_error(ERR_NONFATAL, "`%%line' expects line increment");
3590 free_tlist(origline);
3591 return DIRECTIVE_FOUND;
3593 m = readnum(tline->text, &err);
3594 tline = tline->next;
3596 skip_white_(tline);
3597 src_set_linnum(k);
3598 istk->lineinc = m;
3599 if (tline) {
3600 char *fname = detoken(tline, false);
3601 src_set_fname(fname);
3602 nasm_free(fname);
3604 free_tlist(origline);
3605 return DIRECTIVE_FOUND;
3607 default:
3608 nasm_error(ERR_FATAL,
3609 "preprocessor directive `%s' not yet implemented",
3610 pp_directives[i]);
3611 return DIRECTIVE_FOUND;
3616 * Ensure that a macro parameter contains a condition code and
3617 * nothing else. Return the condition code index if so, or -1
3618 * otherwise.
3620 static int find_cc(Token * t)
3622 Token *tt;
3624 if (!t)
3625 return -1; /* Probably a %+ without a space */
3627 skip_white_(t);
3628 if (t->type != TOK_ID)
3629 return -1;
3630 tt = t->next;
3631 skip_white_(tt);
3632 if (tt && (tt->type != TOK_OTHER || strcmp(tt->text, ",")))
3633 return -1;
3635 return bsii(t->text, (const char **)conditions, ARRAY_SIZE(conditions));
3639 * This routines walks over tokens strem and hadnles tokens
3640 * pasting, if @handle_explicit passed then explicit pasting
3641 * term is handled, otherwise -- implicit pastings only.
3643 static bool paste_tokens(Token **head, const struct tokseq_match *m,
3644 size_t mnum, bool handle_explicit)
3646 Token *tok, *next, **prev_next, **prev_nonspace;
3647 bool pasted = false;
3648 char *buf, *p;
3649 size_t len, i;
3652 * The last token before pasting. We need it
3653 * to be able to connect new handled tokens.
3654 * In other words if there were a tokens stream
3656 * A -> B -> C -> D
3658 * and we've joined tokens B and C, the resulting
3659 * stream should be
3661 * A -> BC -> D
3663 tok = *head;
3664 prev_next = NULL;
3666 if (!tok_type_(tok, TOK_WHITESPACE) && !tok_type_(tok, TOK_PASTE))
3667 prev_nonspace = head;
3668 else
3669 prev_nonspace = NULL;
3671 while (tok && (next = tok->next)) {
3673 switch (tok->type) {
3674 case TOK_WHITESPACE:
3675 /* Zap redundant whitespaces */
3676 while (tok_type_(next, TOK_WHITESPACE))
3677 next = delete_Token(next);
3678 tok->next = next;
3679 break;
3681 case TOK_PASTE:
3682 /* Explicit pasting */
3683 if (!handle_explicit)
3684 break;
3685 next = delete_Token(tok);
3687 while (tok_type_(next, TOK_WHITESPACE))
3688 next = delete_Token(next);
3690 if (!pasted)
3691 pasted = true;
3693 /* Left pasting token is start of line */
3694 if (!prev_nonspace)
3695 nasm_error(ERR_FATAL, "No lvalue found on pasting");
3698 * No ending token, this might happen in two
3699 * cases
3701 * 1) There indeed no right token at all
3702 * 2) There is a bare "%define ID" statement,
3703 * and @ID does expand to whitespace.
3705 * So technically we need to do a grammar analysis
3706 * in another stage of parsing, but for now lets don't
3707 * change the behaviour people used to. Simply allow
3708 * whitespace after paste token.
3710 if (!next) {
3712 * Zap ending space tokens and that's all.
3714 tok = (*prev_nonspace)->next;
3715 while (tok_type_(tok, TOK_WHITESPACE))
3716 tok = delete_Token(tok);
3717 tok = *prev_nonspace;
3718 tok->next = NULL;
3719 break;
3722 tok = *prev_nonspace;
3723 while (tok_type_(tok, TOK_WHITESPACE))
3724 tok = delete_Token(tok);
3725 len = strlen(tok->text);
3726 len += strlen(next->text);
3728 p = buf = nasm_malloc(len + 1);
3729 strcpy(p, tok->text);
3730 p = strchr(p, '\0');
3731 strcpy(p, next->text);
3733 delete_Token(tok);
3735 tok = tokenize(buf);
3736 nasm_free(buf);
3738 *prev_nonspace = tok;
3739 while (tok && tok->next)
3740 tok = tok->next;
3742 tok->next = delete_Token(next);
3744 /* Restart from pasted tokens head */
3745 tok = *prev_nonspace;
3746 break;
3748 default:
3749 /* implicit pasting */
3750 for (i = 0; i < mnum; i++) {
3751 if (!(PP_CONCAT_MATCH(tok, m[i].mask_head)))
3752 continue;
3754 len = 0;
3755 while (next && PP_CONCAT_MATCH(next, m[i].mask_tail)) {
3756 len += strlen(next->text);
3757 next = next->next;
3760 /* No match */
3761 if (tok == next)
3762 break;
3764 len += strlen(tok->text);
3765 p = buf = nasm_malloc(len + 1);
3767 while (tok != next) {
3768 strcpy(p, tok->text);
3769 p = strchr(p, '\0');
3770 tok = delete_Token(tok);
3773 tok = tokenize(buf);
3774 nasm_free(buf);
3776 if (prev_next)
3777 *prev_next = tok;
3778 else
3779 *head = tok;
3782 * Connect pasted into original stream,
3783 * ie A -> new-tokens -> B
3785 while (tok && tok->next)
3786 tok = tok->next;
3787 tok->next = next;
3789 if (!pasted)
3790 pasted = true;
3792 /* Restart from pasted tokens head */
3793 tok = prev_next ? *prev_next : *head;
3796 break;
3799 prev_next = &tok->next;
3801 if (tok->next &&
3802 !tok_type_(tok->next, TOK_WHITESPACE) &&
3803 !tok_type_(tok->next, TOK_PASTE))
3804 prev_nonspace = prev_next;
3806 tok = tok->next;
3809 return pasted;
3813 * expands to a list of tokens from %{x:y}
3815 static Token *expand_mmac_params_range(MMacro *mac, Token *tline, Token ***last)
3817 Token *t = tline, **tt, *tm, *head;
3818 char *pos;
3819 int fst, lst, j, i;
3821 pos = strchr(tline->text, ':');
3822 nasm_assert(pos);
3824 lst = atoi(pos + 1);
3825 fst = atoi(tline->text + 1);
3828 * only macros params are accounted so
3829 * if someone passes %0 -- we reject such
3830 * value(s)
3832 if (lst == 0 || fst == 0)
3833 goto err;
3835 /* the values should be sane */
3836 if ((fst > (int)mac->nparam || fst < (-(int)mac->nparam)) ||
3837 (lst > (int)mac->nparam || lst < (-(int)mac->nparam)))
3838 goto err;
3840 fst = fst < 0 ? fst + (int)mac->nparam + 1: fst;
3841 lst = lst < 0 ? lst + (int)mac->nparam + 1: lst;
3843 /* counted from zero */
3844 fst--, lst--;
3847 * It will be at least one token. Note we
3848 * need to scan params until separator, otherwise
3849 * only first token will be passed.
3851 tm = mac->params[(fst + mac->rotate) % mac->nparam];
3852 head = new_Token(NULL, tm->type, tm->text, 0);
3853 tt = &head->next, tm = tm->next;
3854 while (tok_isnt_(tm, ",")) {
3855 t = new_Token(NULL, tm->type, tm->text, 0);
3856 *tt = t, tt = &t->next, tm = tm->next;
3859 if (fst < lst) {
3860 for (i = fst + 1; i <= lst; i++) {
3861 t = new_Token(NULL, TOK_OTHER, ",", 0);
3862 *tt = t, tt = &t->next;
3863 j = (i + mac->rotate) % mac->nparam;
3864 tm = mac->params[j];
3865 while (tok_isnt_(tm, ",")) {
3866 t = new_Token(NULL, tm->type, tm->text, 0);
3867 *tt = t, tt = &t->next, tm = tm->next;
3870 } else {
3871 for (i = fst - 1; i >= lst; i--) {
3872 t = new_Token(NULL, TOK_OTHER, ",", 0);
3873 *tt = t, tt = &t->next;
3874 j = (i + mac->rotate) % mac->nparam;
3875 tm = mac->params[j];
3876 while (tok_isnt_(tm, ",")) {
3877 t = new_Token(NULL, tm->type, tm->text, 0);
3878 *tt = t, tt = &t->next, tm = tm->next;
3883 *last = tt;
3884 return head;
3886 err:
3887 nasm_error(ERR_NONFATAL, "`%%{%s}': macro parameters out of range",
3888 &tline->text[1]);
3889 return tline;
3893 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3894 * %-n) and MMacro-local identifiers (%%foo) as well as
3895 * macro indirection (%[...]) and range (%{..:..}).
3897 static Token *expand_mmac_params(Token * tline)
3899 Token *t, *tt, **tail, *thead;
3900 bool changed = false;
3901 char *pos;
3903 tail = &thead;
3904 thead = NULL;
3906 while (tline) {
3907 if (tline->type == TOK_PREPROC_ID &&
3908 (((tline->text[1] == '+' || tline->text[1] == '-') && tline->text[2]) ||
3909 (tline->text[1] >= '0' && tline->text[1] <= '9') ||
3910 tline->text[1] == '%')) {
3911 char *text = NULL;
3912 int type = 0, cc; /* type = 0 to placate optimisers */
3913 char tmpbuf[30];
3914 unsigned int n;
3915 int i;
3916 MMacro *mac;
3918 t = tline;
3919 tline = tline->next;
3921 mac = istk->mstk;
3922 while (mac && !mac->name) /* avoid mistaking %reps for macros */
3923 mac = mac->next_active;
3924 if (!mac) {
3925 nasm_error(ERR_NONFATAL, "`%s': not in a macro call", t->text);
3926 } else {
3927 pos = strchr(t->text, ':');
3928 if (!pos) {
3929 switch (t->text[1]) {
3931 * We have to make a substitution of one of the
3932 * forms %1, %-1, %+1, %%foo, %0.
3934 case '0':
3935 type = TOK_NUMBER;
3936 snprintf(tmpbuf, sizeof(tmpbuf), "%d", mac->nparam);
3937 text = nasm_strdup(tmpbuf);
3938 break;
3939 case '%':
3940 type = TOK_ID;
3941 snprintf(tmpbuf, sizeof(tmpbuf), "..@%"PRIu64".",
3942 mac->unique);
3943 text = nasm_strcat(tmpbuf, t->text + 2);
3944 break;
3945 case '-':
3946 n = atoi(t->text + 2) - 1;
3947 if (n >= mac->nparam)
3948 tt = NULL;
3949 else {
3950 if (mac->nparam > 1)
3951 n = (n + mac->rotate) % mac->nparam;
3952 tt = mac->params[n];
3954 cc = find_cc(tt);
3955 if (cc == -1) {
3956 nasm_error(ERR_NONFATAL,
3957 "macro parameter %d is not a condition code",
3958 n + 1);
3959 text = NULL;
3960 } else {
3961 type = TOK_ID;
3962 if (inverse_ccs[cc] == -1) {
3963 nasm_error(ERR_NONFATAL,
3964 "condition code `%s' is not invertible",
3965 conditions[cc]);
3966 text = NULL;
3967 } else
3968 text = nasm_strdup(conditions[inverse_ccs[cc]]);
3970 break;
3971 case '+':
3972 n = atoi(t->text + 2) - 1;
3973 if (n >= mac->nparam)
3974 tt = NULL;
3975 else {
3976 if (mac->nparam > 1)
3977 n = (n + mac->rotate) % mac->nparam;
3978 tt = mac->params[n];
3980 cc = find_cc(tt);
3981 if (cc == -1) {
3982 nasm_error(ERR_NONFATAL,
3983 "macro parameter %d is not a condition code",
3984 n + 1);
3985 text = NULL;
3986 } else {
3987 type = TOK_ID;
3988 text = nasm_strdup(conditions[cc]);
3990 break;
3991 default:
3992 n = atoi(t->text + 1) - 1;
3993 if (n >= mac->nparam)
3994 tt = NULL;
3995 else {
3996 if (mac->nparam > 1)
3997 n = (n + mac->rotate) % mac->nparam;
3998 tt = mac->params[n];
4000 if (tt) {
4001 for (i = 0; i < mac->paramlen[n]; i++) {
4002 *tail = new_Token(NULL, tt->type, tt->text, 0);
4003 tail = &(*tail)->next;
4004 tt = tt->next;
4007 text = NULL; /* we've done it here */
4008 break;
4010 } else {
4012 * seems we have a parameters range here
4014 Token *head, **last;
4015 head = expand_mmac_params_range(mac, t, &last);
4016 if (head != t) {
4017 *tail = head;
4018 *last = tline;
4019 tline = head;
4020 text = NULL;
4024 if (!text) {
4025 delete_Token(t);
4026 } else {
4027 *tail = t;
4028 tail = &t->next;
4029 t->type = type;
4030 nasm_free(t->text);
4031 t->text = text;
4032 t->a.mac = NULL;
4034 changed = true;
4035 continue;
4036 } else if (tline->type == TOK_INDIRECT) {
4037 t = tline;
4038 tline = tline->next;
4039 tt = tokenize(t->text);
4040 tt = expand_mmac_params(tt);
4041 tt = expand_smacro(tt);
4042 *tail = tt;
4043 while (tt) {
4044 tt->a.mac = NULL; /* Necessary? */
4045 tail = &tt->next;
4046 tt = tt->next;
4048 delete_Token(t);
4049 changed = true;
4050 } else {
4051 t = *tail = tline;
4052 tline = tline->next;
4053 t->a.mac = NULL;
4054 tail = &t->next;
4057 *tail = NULL;
4059 if (changed) {
4060 const struct tokseq_match t[] = {
4062 PP_CONCAT_MASK(TOK_ID) |
4063 PP_CONCAT_MASK(TOK_FLOAT), /* head */
4064 PP_CONCAT_MASK(TOK_ID) |
4065 PP_CONCAT_MASK(TOK_NUMBER) |
4066 PP_CONCAT_MASK(TOK_FLOAT) |
4067 PP_CONCAT_MASK(TOK_OTHER) /* tail */
4070 PP_CONCAT_MASK(TOK_NUMBER), /* head */
4071 PP_CONCAT_MASK(TOK_NUMBER) /* tail */
4074 paste_tokens(&thead, t, ARRAY_SIZE(t), false);
4077 return thead;
4081 * Expand all single-line macro calls made in the given line.
4082 * Return the expanded version of the line. The original is deemed
4083 * to be destroyed in the process. (In reality we'll just move
4084 * Tokens from input to output a lot of the time, rather than
4085 * actually bothering to destroy and replicate.)
4088 static Token *expand_smacro(Token * tline)
4090 Token *t, *tt, *mstart, **tail, *thead;
4091 SMacro *head = NULL, *m;
4092 Token **params;
4093 int *paramsize;
4094 unsigned int nparam, sparam;
4095 int brackets;
4096 Token *org_tline = tline;
4097 Context *ctx;
4098 const char *mname;
4099 int deadman = DEADMAN_LIMIT;
4100 bool expanded;
4103 * Trick: we should avoid changing the start token pointer since it can
4104 * be contained in "next" field of other token. Because of this
4105 * we allocate a copy of first token and work with it; at the end of
4106 * routine we copy it back
4108 if (org_tline) {
4109 tline = new_Token(org_tline->next, org_tline->type,
4110 org_tline->text, 0);
4111 tline->a.mac = org_tline->a.mac;
4112 nasm_free(org_tline->text);
4113 org_tline->text = NULL;
4116 expanded = true; /* Always expand %+ at least once */
4118 again:
4119 thead = NULL;
4120 tail = &thead;
4122 while (tline) { /* main token loop */
4123 if (!--deadman) {
4124 nasm_error(ERR_NONFATAL, "interminable macro recursion");
4125 goto err;
4128 if ((mname = tline->text)) {
4129 /* if this token is a local macro, look in local context */
4130 if (tline->type == TOK_ID) {
4131 head = (SMacro *)hash_findix(&smacros, mname);
4132 } else if (tline->type == TOK_PREPROC_ID) {
4133 ctx = get_ctx(mname, &mname);
4134 head = ctx ? (SMacro *)hash_findix(&ctx->localmac, mname) : NULL;
4135 } else
4136 head = NULL;
4139 * We've hit an identifier. As in is_mmacro below, we first
4140 * check whether the identifier is a single-line macro at
4141 * all, then think about checking for parameters if
4142 * necessary.
4144 list_for_each(m, head)
4145 if (!mstrcmp(m->name, mname, m->casesense))
4146 break;
4147 if (m) {
4148 mstart = tline;
4149 params = NULL;
4150 paramsize = NULL;
4151 if (m->nparam == 0) {
4153 * Simple case: the macro is parameterless. Discard the
4154 * one token that the macro call took, and push the
4155 * expansion back on the to-do stack.
4157 if (!m->expansion) {
4158 if (!strcmp("__FILE__", m->name)) {
4159 const char *file = src_get_fname();
4160 /* nasm_free(tline->text); here? */
4161 tline->text = nasm_quote(file, strlen(file));
4162 tline->type = TOK_STRING;
4163 continue;
4165 if (!strcmp("__LINE__", m->name)) {
4166 nasm_free(tline->text);
4167 make_tok_num(tline, src_get_linnum());
4168 continue;
4170 if (!strcmp("__BITS__", m->name)) {
4171 nasm_free(tline->text);
4172 make_tok_num(tline, globalbits);
4173 continue;
4175 tline = delete_Token(tline);
4176 continue;
4178 } else {
4180 * Complicated case: at least one macro with this name
4181 * exists and takes parameters. We must find the
4182 * parameters in the call, count them, find the SMacro
4183 * that corresponds to that form of the macro call, and
4184 * substitute for the parameters when we expand. What a
4185 * pain.
4187 /*tline = tline->next;
4188 skip_white_(tline); */
4189 do {
4190 t = tline->next;
4191 while (tok_type_(t, TOK_SMAC_END)) {
4192 t->a.mac->in_progress = false;
4193 t->text = NULL;
4194 t = tline->next = delete_Token(t);
4196 tline = t;
4197 } while (tok_type_(tline, TOK_WHITESPACE));
4198 if (!tok_is_(tline, "(")) {
4200 * This macro wasn't called with parameters: ignore
4201 * the call. (Behaviour borrowed from gnu cpp.)
4203 tline = mstart;
4204 m = NULL;
4205 } else {
4206 int paren = 0;
4207 int white = 0;
4208 brackets = 0;
4209 nparam = 0;
4210 sparam = PARAM_DELTA;
4211 params = nasm_malloc(sparam * sizeof(Token *));
4212 params[0] = tline->next;
4213 paramsize = nasm_malloc(sparam * sizeof(int));
4214 paramsize[0] = 0;
4215 while (true) { /* parameter loop */
4217 * For some unusual expansions
4218 * which concatenates function call
4220 t = tline->next;
4221 while (tok_type_(t, TOK_SMAC_END)) {
4222 t->a.mac->in_progress = false;
4223 t->text = NULL;
4224 t = tline->next = delete_Token(t);
4226 tline = t;
4228 if (!tline) {
4229 nasm_error(ERR_NONFATAL,
4230 "macro call expects terminating `)'");
4231 break;
4233 if (tline->type == TOK_WHITESPACE
4234 && brackets <= 0) {
4235 if (paramsize[nparam])
4236 white++;
4237 else
4238 params[nparam] = tline->next;
4239 continue; /* parameter loop */
4241 if (tline->type == TOK_OTHER
4242 && tline->text[1] == 0) {
4243 char ch = tline->text[0];
4244 if (ch == ',' && !paren && brackets <= 0) {
4245 if (++nparam >= sparam) {
4246 sparam += PARAM_DELTA;
4247 params = nasm_realloc(params,
4248 sparam * sizeof(Token *));
4249 paramsize = nasm_realloc(paramsize,
4250 sparam * sizeof(int));
4252 params[nparam] = tline->next;
4253 paramsize[nparam] = 0;
4254 white = 0;
4255 continue; /* parameter loop */
4257 if (ch == '{' &&
4258 (brackets > 0 || (brackets == 0 &&
4259 !paramsize[nparam])))
4261 if (!(brackets++)) {
4262 params[nparam] = tline->next;
4263 continue; /* parameter loop */
4266 if (ch == '}' && brackets > 0)
4267 if (--brackets == 0) {
4268 brackets = -1;
4269 continue; /* parameter loop */
4271 if (ch == '(' && !brackets)
4272 paren++;
4273 if (ch == ')' && brackets <= 0)
4274 if (--paren < 0)
4275 break;
4277 if (brackets < 0) {
4278 brackets = 0;
4279 nasm_error(ERR_NONFATAL, "braces do not "
4280 "enclose all of macro parameter");
4282 paramsize[nparam] += white + 1;
4283 white = 0;
4284 } /* parameter loop */
4285 nparam++;
4286 while (m && (m->nparam != nparam ||
4287 mstrcmp(m->name, mname,
4288 m->casesense)))
4289 m = m->next;
4290 if (!m)
4291 nasm_error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
4292 "macro `%s' exists, "
4293 "but not taking %d parameters",
4294 mstart->text, nparam);
4297 if (m && m->in_progress)
4298 m = NULL;
4299 if (!m) { /* in progess or didn't find '(' or wrong nparam */
4301 * Design question: should we handle !tline, which
4302 * indicates missing ')' here, or expand those
4303 * macros anyway, which requires the (t) test a few
4304 * lines down?
4306 nasm_free(params);
4307 nasm_free(paramsize);
4308 tline = mstart;
4309 } else {
4311 * Expand the macro: we are placed on the last token of the
4312 * call, so that we can easily split the call from the
4313 * following tokens. We also start by pushing an SMAC_END
4314 * token for the cycle removal.
4316 t = tline;
4317 if (t) {
4318 tline = t->next;
4319 t->next = NULL;
4321 tt = new_Token(tline, TOK_SMAC_END, NULL, 0);
4322 tt->a.mac = m;
4323 m->in_progress = true;
4324 tline = tt;
4325 list_for_each(t, m->expansion) {
4326 if (t->type >= TOK_SMAC_PARAM) {
4327 Token *pcopy = tline, **ptail = &pcopy;
4328 Token *ttt, *pt;
4329 int i;
4331 ttt = params[t->type - TOK_SMAC_PARAM];
4332 i = paramsize[t->type - TOK_SMAC_PARAM];
4333 while (--i >= 0) {
4334 pt = *ptail = new_Token(tline, ttt->type,
4335 ttt->text, 0);
4336 ptail = &pt->next;
4337 ttt = ttt->next;
4339 tline = pcopy;
4340 } else if (t->type == TOK_PREPROC_Q) {
4341 tt = new_Token(tline, TOK_ID, mname, 0);
4342 tline = tt;
4343 } else if (t->type == TOK_PREPROC_QQ) {
4344 tt = new_Token(tline, TOK_ID, m->name, 0);
4345 tline = tt;
4346 } else {
4347 tt = new_Token(tline, t->type, t->text, 0);
4348 tline = tt;
4353 * Having done that, get rid of the macro call, and clean
4354 * up the parameters.
4356 nasm_free(params);
4357 nasm_free(paramsize);
4358 free_tlist(mstart);
4359 expanded = true;
4360 continue; /* main token loop */
4365 if (tline->type == TOK_SMAC_END) {
4366 tline->a.mac->in_progress = false;
4367 tline = delete_Token(tline);
4368 } else {
4369 t = *tail = tline;
4370 tline = tline->next;
4371 t->a.mac = NULL;
4372 t->next = NULL;
4373 tail = &t->next;
4378 * Now scan the entire line and look for successive TOK_IDs that resulted
4379 * after expansion (they can't be produced by tokenize()). The successive
4380 * TOK_IDs should be concatenated.
4381 * Also we look for %+ tokens and concatenate the tokens before and after
4382 * them (without white spaces in between).
4384 if (expanded) {
4385 const struct tokseq_match t[] = {
4387 PP_CONCAT_MASK(TOK_ID) |
4388 PP_CONCAT_MASK(TOK_PREPROC_ID), /* head */
4389 PP_CONCAT_MASK(TOK_ID) |
4390 PP_CONCAT_MASK(TOK_PREPROC_ID) |
4391 PP_CONCAT_MASK(TOK_NUMBER) /* tail */
4394 if (paste_tokens(&thead, t, ARRAY_SIZE(t), true)) {
4396 * If we concatenated something, *and* we had previously expanded
4397 * an actual macro, scan the lines again for macros...
4399 tline = thead;
4400 expanded = false;
4401 goto again;
4405 err:
4406 if (org_tline) {
4407 if (thead) {
4408 *org_tline = *thead;
4409 /* since we just gave text to org_line, don't free it */
4410 thead->text = NULL;
4411 delete_Token(thead);
4412 } else {
4413 /* the expression expanded to empty line;
4414 we can't return NULL for some reasons
4415 we just set the line to a single WHITESPACE token. */
4416 memset(org_tline, 0, sizeof(*org_tline));
4417 org_tline->text = NULL;
4418 org_tline->type = TOK_WHITESPACE;
4420 thead = org_tline;
4423 return thead;
4427 * Similar to expand_smacro but used exclusively with macro identifiers
4428 * right before they are fetched in. The reason is that there can be
4429 * identifiers consisting of several subparts. We consider that if there
4430 * are more than one element forming the name, user wants a expansion,
4431 * otherwise it will be left as-is. Example:
4433 * %define %$abc cde
4435 * the identifier %$abc will be left as-is so that the handler for %define
4436 * will suck it and define the corresponding value. Other case:
4438 * %define _%$abc cde
4440 * In this case user wants name to be expanded *before* %define starts
4441 * working, so we'll expand %$abc into something (if it has a value;
4442 * otherwise it will be left as-is) then concatenate all successive
4443 * PP_IDs into one.
4445 static Token *expand_id(Token * tline)
4447 Token *cur, *oldnext = NULL;
4449 if (!tline || !tline->next)
4450 return tline;
4452 cur = tline;
4453 while (cur->next &&
4454 (cur->next->type == TOK_ID ||
4455 cur->next->type == TOK_PREPROC_ID
4456 || cur->next->type == TOK_NUMBER))
4457 cur = cur->next;
4459 /* If identifier consists of just one token, don't expand */
4460 if (cur == tline)
4461 return tline;
4463 if (cur) {
4464 oldnext = cur->next; /* Detach the tail past identifier */
4465 cur->next = NULL; /* so that expand_smacro stops here */
4468 tline = expand_smacro(tline);
4470 if (cur) {
4471 /* expand_smacro possibly changhed tline; re-scan for EOL */
4472 cur = tline;
4473 while (cur && cur->next)
4474 cur = cur->next;
4475 if (cur)
4476 cur->next = oldnext;
4479 return tline;
4483 * Determine whether the given line constitutes a multi-line macro
4484 * call, and return the MMacro structure called if so. Doesn't have
4485 * to check for an initial label - that's taken care of in
4486 * expand_mmacro - but must check numbers of parameters. Guaranteed
4487 * to be called with tline->type == TOK_ID, so the putative macro
4488 * name is easy to find.
4490 static MMacro *is_mmacro(Token * tline, Token *** params_array)
4492 MMacro *head, *m;
4493 Token **params;
4494 int nparam;
4496 head = (MMacro *) hash_findix(&mmacros, tline->text);
4499 * Efficiency: first we see if any macro exists with the given
4500 * name. If not, we can return NULL immediately. _Then_ we
4501 * count the parameters, and then we look further along the
4502 * list if necessary to find the proper MMacro.
4504 list_for_each(m, head)
4505 if (!mstrcmp(m->name, tline->text, m->casesense))
4506 break;
4507 if (!m)
4508 return NULL;
4511 * OK, we have a potential macro. Count and demarcate the
4512 * parameters.
4514 count_mmac_params(tline->next, &nparam, &params);
4517 * So we know how many parameters we've got. Find the MMacro
4518 * structure that handles this number.
4520 while (m) {
4521 if (m->nparam_min <= nparam
4522 && (m->plus || nparam <= m->nparam_max)) {
4524 * This one is right. Just check if cycle removal
4525 * prohibits us using it before we actually celebrate...
4527 if (m->in_progress > m->max_depth) {
4528 if (m->max_depth > 0) {
4529 nasm_error(ERR_WARNING,
4530 "reached maximum recursion depth of %i",
4531 m->max_depth);
4533 nasm_free(params);
4534 return NULL;
4537 * It's right, and we can use it. Add its default
4538 * parameters to the end of our list if necessary.
4540 if (m->defaults && nparam < m->nparam_min + m->ndefs) {
4541 params =
4542 nasm_realloc(params,
4543 ((m->nparam_min + m->ndefs +
4544 1) * sizeof(*params)));
4545 while (nparam < m->nparam_min + m->ndefs) {
4546 params[nparam] = m->defaults[nparam - m->nparam_min];
4547 nparam++;
4551 * If we've gone over the maximum parameter count (and
4552 * we're in Plus mode), ignore parameters beyond
4553 * nparam_max.
4555 if (m->plus && nparam > m->nparam_max)
4556 nparam = m->nparam_max;
4558 * Then terminate the parameter list, and leave.
4560 if (!params) { /* need this special case */
4561 params = nasm_malloc(sizeof(*params));
4562 nparam = 0;
4564 params[nparam] = NULL;
4565 *params_array = params;
4566 return m;
4569 * This one wasn't right: look for the next one with the
4570 * same name.
4572 list_for_each(m, m->next)
4573 if (!mstrcmp(m->name, tline->text, m->casesense))
4574 break;
4578 * After all that, we didn't find one with the right number of
4579 * parameters. Issue a warning, and fail to expand the macro.
4581 nasm_error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
4582 "macro `%s' exists, but not taking %d parameters",
4583 tline->text, nparam);
4584 nasm_free(params);
4585 return NULL;
4590 * Save MMacro invocation specific fields in
4591 * preparation for a recursive macro expansion
4593 static void push_mmacro(MMacro *m)
4595 MMacroInvocation *i;
4597 i = nasm_malloc(sizeof(MMacroInvocation));
4598 i->prev = m->prev;
4599 i->params = m->params;
4600 i->iline = m->iline;
4601 i->nparam = m->nparam;
4602 i->rotate = m->rotate;
4603 i->paramlen = m->paramlen;
4604 i->unique = m->unique;
4605 i->condcnt = m->condcnt;
4606 m->prev = i;
4611 * Restore MMacro invocation specific fields that were
4612 * saved during a previous recursive macro expansion
4614 static void pop_mmacro(MMacro *m)
4616 MMacroInvocation *i;
4618 if (m->prev) {
4619 i = m->prev;
4620 m->prev = i->prev;
4621 m->params = i->params;
4622 m->iline = i->iline;
4623 m->nparam = i->nparam;
4624 m->rotate = i->rotate;
4625 m->paramlen = i->paramlen;
4626 m->unique = i->unique;
4627 m->condcnt = i->condcnt;
4628 nasm_free(i);
4634 * Expand the multi-line macro call made by the given line, if
4635 * there is one to be expanded. If there is, push the expansion on
4636 * istk->expansion and return 1. Otherwise return 0.
4638 static int expand_mmacro(Token * tline)
4640 Token *startline = tline;
4641 Token *label = NULL;
4642 int dont_prepend = 0;
4643 Token **params, *t, *tt;
4644 MMacro *m;
4645 Line *l, *ll;
4646 int i, nparam, *paramlen;
4647 const char *mname;
4649 t = tline;
4650 skip_white_(t);
4651 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
4652 if (!tok_type_(t, TOK_ID) && !tok_type_(t, TOK_PREPROC_ID))
4653 return 0;
4654 m = is_mmacro(t, &params);
4655 if (m) {
4656 mname = t->text;
4657 } else {
4658 Token *last;
4660 * We have an id which isn't a macro call. We'll assume
4661 * it might be a label; we'll also check to see if a
4662 * colon follows it. Then, if there's another id after
4663 * that lot, we'll check it again for macro-hood.
4665 label = last = t;
4666 t = t->next;
4667 if (tok_type_(t, TOK_WHITESPACE))
4668 last = t, t = t->next;
4669 if (tok_is_(t, ":")) {
4670 dont_prepend = 1;
4671 last = t, t = t->next;
4672 if (tok_type_(t, TOK_WHITESPACE))
4673 last = t, t = t->next;
4675 if (!tok_type_(t, TOK_ID) || !(m = is_mmacro(t, &params)))
4676 return 0;
4677 last->next = NULL;
4678 mname = t->text;
4679 tline = t;
4683 * Fix up the parameters: this involves stripping leading and
4684 * trailing whitespace, then stripping braces if they are
4685 * present.
4687 for (nparam = 0; params[nparam]; nparam++) ;
4688 paramlen = nparam ? nasm_malloc(nparam * sizeof(*paramlen)) : NULL;
4690 for (i = 0; params[i]; i++) {
4691 int brace = 0;
4692 int comma = (!m->plus || i < nparam - 1);
4694 t = params[i];
4695 skip_white_(t);
4696 if (tok_is_(t, "{"))
4697 t = t->next, brace++, comma = false;
4698 params[i] = t;
4699 paramlen[i] = 0;
4700 while (t) {
4701 if (comma && t->type == TOK_OTHER && !strcmp(t->text, ","))
4702 break; /* ... because we have hit a comma */
4703 if (comma && t->type == TOK_WHITESPACE
4704 && tok_is_(t->next, ","))
4705 break; /* ... or a space then a comma */
4706 if (brace && t->type == TOK_OTHER) {
4707 if (t->text[0] == '{')
4708 brace++; /* ... or a nested opening brace */
4709 else if (t->text[0] == '}')
4710 if (!--brace)
4711 break; /* ... or a brace */
4713 t = t->next;
4714 paramlen[i]++;
4716 if (brace)
4717 nasm_error(ERR_NONFATAL, "macro params should be enclosed in braces");
4721 * OK, we have a MMacro structure together with a set of
4722 * parameters. We must now go through the expansion and push
4723 * copies of each Line on to istk->expansion. Substitution of
4724 * parameter tokens and macro-local tokens doesn't get done
4725 * until the single-line macro substitution process; this is
4726 * because delaying them allows us to change the semantics
4727 * later through %rotate.
4729 * First, push an end marker on to istk->expansion, mark this
4730 * macro as in progress, and set up its invocation-specific
4731 * variables.
4733 ll = nasm_malloc(sizeof(Line));
4734 ll->next = istk->expansion;
4735 ll->finishes = m;
4736 ll->first = NULL;
4737 istk->expansion = ll;
4740 * Save the previous MMacro expansion in the case of
4741 * macro recursion
4743 if (m->max_depth && m->in_progress)
4744 push_mmacro(m);
4746 m->in_progress ++;
4747 m->params = params;
4748 m->iline = tline;
4749 m->nparam = nparam;
4750 m->rotate = 0;
4751 m->paramlen = paramlen;
4752 m->unique = unique++;
4753 m->lineno = 0;
4754 m->condcnt = 0;
4756 m->next_active = istk->mstk;
4757 istk->mstk = m;
4759 list_for_each(l, m->expansion) {
4760 Token **tail;
4762 ll = nasm_malloc(sizeof(Line));
4763 ll->finishes = NULL;
4764 ll->next = istk->expansion;
4765 istk->expansion = ll;
4766 tail = &ll->first;
4768 list_for_each(t, l->first) {
4769 Token *x = t;
4770 switch (t->type) {
4771 case TOK_PREPROC_Q:
4772 tt = *tail = new_Token(NULL, TOK_ID, mname, 0);
4773 break;
4774 case TOK_PREPROC_QQ:
4775 tt = *tail = new_Token(NULL, TOK_ID, m->name, 0);
4776 break;
4777 case TOK_PREPROC_ID:
4778 if (t->text[1] == '0' && t->text[2] == '0') {
4779 dont_prepend = -1;
4780 x = label;
4781 if (!x)
4782 continue;
4784 /* fall through */
4785 default:
4786 tt = *tail = new_Token(NULL, x->type, x->text, 0);
4787 break;
4789 tail = &tt->next;
4791 *tail = NULL;
4795 * If we had a label, push it on as the first line of
4796 * the macro expansion.
4798 if (label) {
4799 if (dont_prepend < 0)
4800 free_tlist(startline);
4801 else {
4802 ll = nasm_malloc(sizeof(Line));
4803 ll->finishes = NULL;
4804 ll->next = istk->expansion;
4805 istk->expansion = ll;
4806 ll->first = startline;
4807 if (!dont_prepend) {
4808 while (label->next)
4809 label = label->next;
4810 label->next = tt = new_Token(NULL, TOK_OTHER, ":", 0);
4815 lfmt->uplevel(m->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
4817 return 1;
4821 * This function adds macro names to error messages, and suppresses
4822 * them if necessary.
4824 static void pp_verror(int severity, const char *fmt, va_list arg)
4826 char buff[BUFSIZ];
4827 MMacro *mmac = NULL;
4828 int delta = 0;
4831 * If we're in a dead branch of IF or something like it, ignore the error.
4832 * However, because %else etc are evaluated in the state context
4833 * of the previous branch, errors might get lost:
4834 * %if 0 ... %else trailing garbage ... %endif
4835 * So %else etc should set the ERR_PP_PRECOND flag.
4837 if ((severity & ERR_MASK) < ERR_FATAL &&
4838 istk && istk->conds &&
4839 ((severity & ERR_PP_PRECOND) ?
4840 istk->conds->state == COND_NEVER :
4841 !emitting(istk->conds->state)))
4842 return;
4844 /* get %macro name */
4845 if (!(severity & ERR_NOFILE) && istk && istk->mstk) {
4846 mmac = istk->mstk;
4847 /* but %rep blocks should be skipped */
4848 while (mmac && !mmac->name)
4849 mmac = mmac->next_active, delta++;
4852 if (mmac) {
4853 vsnprintf(buff, sizeof(buff), fmt, arg);
4855 nasm_set_verror(real_verror);
4856 nasm_error(severity, "(%s:%d) %s",
4857 mmac->name, mmac->lineno - delta, buff);
4858 nasm_set_verror(pp_verror);
4859 } else {
4860 real_verror(severity, fmt, arg);
4864 static void
4865 pp_reset(char *file, int apass, StrList **deplist)
4867 Token *t;
4869 cstk = NULL;
4870 istk = nasm_malloc(sizeof(Include));
4871 istk->next = NULL;
4872 istk->conds = NULL;
4873 istk->expansion = NULL;
4874 istk->mstk = NULL;
4875 istk->fp = fopen(file, "r");
4876 istk->fname = NULL;
4877 src_set(0, file);
4878 istk->lineinc = 1;
4879 if (!istk->fp)
4880 nasm_fatal(ERR_NOFILE, "unable to open input file `%s'", file);
4881 defining = NULL;
4882 nested_mac_count = 0;
4883 nested_rep_count = 0;
4884 init_macros();
4885 unique = 0;
4886 if (tasm_compatible_mode) {
4887 stdmacpos = nasm_stdmac;
4888 } else {
4889 stdmacpos = nasm_stdmac_after_tasm;
4891 any_extrastdmac = extrastdmac && *extrastdmac;
4892 do_predef = true;
4895 * 0 for dependencies, 1 for preparatory passes, 2 for final pass.
4896 * The caller, however, will also pass in 3 for preprocess-only so
4897 * we can set __PASS__ accordingly.
4899 pass = apass > 2 ? 2 : apass;
4901 dephead = deptail = deplist;
4902 if (deplist) {
4903 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
4904 sl->next = NULL;
4905 strcpy(sl->str, file);
4906 *deptail = sl;
4907 deptail = &sl->next;
4911 * Define the __PASS__ macro. This is defined here unlike
4912 * all the other builtins, because it is special -- it varies between
4913 * passes.
4915 t = nasm_malloc(sizeof(*t));
4916 t->next = NULL;
4917 make_tok_num(t, apass);
4918 t->a.mac = NULL;
4919 define_smacro(NULL, "__PASS__", true, 0, t);
4922 static char *pp_getline(void)
4924 char *line;
4925 Token *tline;
4927 real_verror = nasm_set_verror(pp_verror);
4929 while (1) {
4931 * Fetch a tokenized line, either from the macro-expansion
4932 * buffer or from the input file.
4934 tline = NULL;
4935 while (istk->expansion && istk->expansion->finishes) {
4936 Line *l = istk->expansion;
4937 if (!l->finishes->name && l->finishes->in_progress > 1) {
4938 Line *ll;
4941 * This is a macro-end marker for a macro with no
4942 * name, which means it's not really a macro at all
4943 * but a %rep block, and the `in_progress' field is
4944 * more than 1, meaning that we still need to
4945 * repeat. (1 means the natural last repetition; 0
4946 * means termination by %exitrep.) We have
4947 * therefore expanded up to the %endrep, and must
4948 * push the whole block on to the expansion buffer
4949 * again. We don't bother to remove the macro-end
4950 * marker: we'd only have to generate another one
4951 * if we did.
4953 l->finishes->in_progress--;
4954 list_for_each(l, l->finishes->expansion) {
4955 Token *t, *tt, **tail;
4957 ll = nasm_malloc(sizeof(Line));
4958 ll->next = istk->expansion;
4959 ll->finishes = NULL;
4960 ll->first = NULL;
4961 tail = &ll->first;
4963 list_for_each(t, l->first) {
4964 if (t->text || t->type == TOK_WHITESPACE) {
4965 tt = *tail = new_Token(NULL, t->type, t->text, 0);
4966 tail = &tt->next;
4970 istk->expansion = ll;
4972 } else {
4974 * Check whether a `%rep' was started and not ended
4975 * within this macro expansion. This can happen and
4976 * should be detected. It's a fatal error because
4977 * I'm too confused to work out how to recover
4978 * sensibly from it.
4980 if (defining) {
4981 if (defining->name)
4982 nasm_panic(0, "defining with name in expansion");
4983 else if (istk->mstk->name)
4984 nasm_fatal(0, "`%%rep' without `%%endrep' within"
4985 " expansion of macro `%s'",
4986 istk->mstk->name);
4990 * FIXME: investigate the relationship at this point between
4991 * istk->mstk and l->finishes
4994 MMacro *m = istk->mstk;
4995 istk->mstk = m->next_active;
4996 if (m->name) {
4998 * This was a real macro call, not a %rep, and
4999 * therefore the parameter information needs to
5000 * be freed.
5002 if (m->prev) {
5003 pop_mmacro(m);
5004 l->finishes->in_progress --;
5005 } else {
5006 nasm_free(m->params);
5007 free_tlist(m->iline);
5008 nasm_free(m->paramlen);
5009 l->finishes->in_progress = 0;
5011 } else
5012 free_mmacro(m);
5014 istk->expansion = l->next;
5015 nasm_free(l);
5016 lfmt->downlevel(LIST_MACRO);
5019 while (1) { /* until we get a line we can use */
5021 if (istk->expansion) { /* from a macro expansion */
5022 char *p;
5023 Line *l = istk->expansion;
5024 if (istk->mstk)
5025 istk->mstk->lineno++;
5026 tline = l->first;
5027 istk->expansion = l->next;
5028 nasm_free(l);
5029 p = detoken(tline, false);
5030 lfmt->line(LIST_MACRO, p);
5031 nasm_free(p);
5032 break;
5034 line = read_line();
5035 if (line) { /* from the current input file */
5036 line = prepreproc(line);
5037 tline = tokenize(line);
5038 nasm_free(line);
5039 break;
5042 * The current file has ended; work down the istk
5045 Include *i = istk;
5046 fclose(i->fp);
5047 if (i->conds) {
5048 /* nasm_error can't be conditionally suppressed */
5049 nasm_fatal(0,
5050 "expected `%%endif' before end of file");
5052 /* only set line and file name if there's a next node */
5053 if (i->next)
5054 src_set(i->lineno, i->fname);
5055 istk = i->next;
5056 lfmt->downlevel(LIST_INCLUDE);
5057 nasm_free(i);
5058 if (!istk) {
5059 line = NULL;
5060 goto done;
5062 if (istk->expansion && istk->expansion->finishes)
5063 break;
5068 * We must expand MMacro parameters and MMacro-local labels
5069 * _before_ we plunge into directive processing, to cope
5070 * with things like `%define something %1' such as STRUC
5071 * uses. Unless we're _defining_ a MMacro, in which case
5072 * those tokens should be left alone to go into the
5073 * definition; and unless we're in a non-emitting
5074 * condition, in which case we don't want to meddle with
5075 * anything.
5077 if (!defining && !(istk->conds && !emitting(istk->conds->state))
5078 && !(istk->mstk && !istk->mstk->in_progress)) {
5079 tline = expand_mmac_params(tline);
5083 * Check the line to see if it's a preprocessor directive.
5085 if (do_directive(tline) == DIRECTIVE_FOUND) {
5086 continue;
5087 } else if (defining) {
5089 * We're defining a multi-line macro. We emit nothing
5090 * at all, and just
5091 * shove the tokenized line on to the macro definition.
5093 Line *l = nasm_malloc(sizeof(Line));
5094 l->next = defining->expansion;
5095 l->first = tline;
5096 l->finishes = NULL;
5097 defining->expansion = l;
5098 continue;
5099 } else if (istk->conds && !emitting(istk->conds->state)) {
5101 * We're in a non-emitting branch of a condition block.
5102 * Emit nothing at all, not even a blank line: when we
5103 * emerge from the condition we'll give a line-number
5104 * directive so we keep our place correctly.
5106 free_tlist(tline);
5107 continue;
5108 } else if (istk->mstk && !istk->mstk->in_progress) {
5110 * We're in a %rep block which has been terminated, so
5111 * we're walking through to the %endrep without
5112 * emitting anything. Emit nothing at all, not even a
5113 * blank line: when we emerge from the %rep block we'll
5114 * give a line-number directive so we keep our place
5115 * correctly.
5117 free_tlist(tline);
5118 continue;
5119 } else {
5120 tline = expand_smacro(tline);
5121 if (!expand_mmacro(tline)) {
5123 * De-tokenize the line again, and emit it.
5125 line = detoken(tline, true);
5126 free_tlist(tline);
5127 break;
5128 } else {
5129 continue; /* expand_mmacro calls free_tlist */
5134 done:
5135 nasm_set_verror(real_verror);
5136 return line;
5139 static void pp_cleanup(int pass)
5141 real_verror = nasm_set_verror(pp_verror);
5143 if (defining) {
5144 if (defining->name) {
5145 nasm_error(ERR_NONFATAL,
5146 "end of file while still defining macro `%s'",
5147 defining->name);
5148 } else {
5149 nasm_error(ERR_NONFATAL, "end of file while still in %%rep");
5152 free_mmacro(defining);
5153 defining = NULL;
5156 nasm_set_verror(real_verror);
5158 while (cstk)
5159 ctx_pop();
5160 free_macros();
5161 while (istk) {
5162 Include *i = istk;
5163 istk = istk->next;
5164 fclose(i->fp);
5165 nasm_free(i);
5167 while (cstk)
5168 ctx_pop();
5169 src_set_fname(NULL);
5170 if (pass == 0) {
5171 IncPath *i;
5172 free_llist(predef);
5173 predef = NULL;
5174 delete_Blocks();
5175 freeTokens = NULL;
5176 while ((i = ipath)) {
5177 ipath = i->next;
5178 if (i->path)
5179 nasm_free(i->path);
5180 nasm_free(i);
5185 static void pp_include_path(char *path)
5187 IncPath *i;
5189 i = nasm_malloc(sizeof(IncPath));
5190 i->path = path ? nasm_strdup(path) : NULL;
5191 i->next = NULL;
5193 if (ipath) {
5194 IncPath *j = ipath;
5195 while (j->next)
5196 j = j->next;
5197 j->next = i;
5198 } else {
5199 ipath = i;
5203 static void pp_pre_include(char *fname)
5205 Token *inc, *space, *name;
5206 Line *l;
5208 name = new_Token(NULL, TOK_INTERNAL_STRING, fname, 0);
5209 space = new_Token(name, TOK_WHITESPACE, NULL, 0);
5210 inc = new_Token(space, TOK_PREPROC_ID, "%include", 0);
5212 l = nasm_malloc(sizeof(Line));
5213 l->next = predef;
5214 l->first = inc;
5215 l->finishes = NULL;
5216 predef = l;
5219 static void pp_pre_define(char *definition)
5221 Token *def, *space;
5222 Line *l;
5223 char *equals;
5225 real_verror = nasm_set_verror(pp_verror);
5227 equals = strchr(definition, '=');
5228 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
5229 def = new_Token(space, TOK_PREPROC_ID, "%define", 0);
5230 if (equals)
5231 *equals = ' ';
5232 space->next = tokenize(definition);
5233 if (equals)
5234 *equals = '=';
5236 if (space->next->type != TOK_PREPROC_ID &&
5237 space->next->type != TOK_ID)
5238 nasm_error(ERR_WARNING, "pre-defining non ID `%s\'\n", definition);
5240 l = nasm_malloc(sizeof(Line));
5241 l->next = predef;
5242 l->first = def;
5243 l->finishes = NULL;
5244 predef = l;
5246 nasm_set_verror(real_verror);
5249 static void pp_pre_undefine(char *definition)
5251 Token *def, *space;
5252 Line *l;
5254 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
5255 def = new_Token(space, TOK_PREPROC_ID, "%undef", 0);
5256 space->next = tokenize(definition);
5258 l = nasm_malloc(sizeof(Line));
5259 l->next = predef;
5260 l->first = def;
5261 l->finishes = NULL;
5262 predef = l;
5265 static void pp_extra_stdmac(macros_t *macros)
5267 extrastdmac = macros;
5270 static void make_tok_num(Token * tok, int64_t val)
5272 char numbuf[32];
5273 snprintf(numbuf, sizeof(numbuf), "%"PRId64"", val);
5274 tok->text = nasm_strdup(numbuf);
5275 tok->type = TOK_NUMBER;
5278 static void pp_list_one_macro(MMacro *m, int severity)
5280 if (!m)
5281 return;
5283 /* We need to print the next_active list in reverse order */
5284 pp_list_one_macro(m->next_active, severity);
5286 if (m->name && !m->nolist) {
5287 src_set(m->xline + m->lineno, m->fname);
5288 nasm_error(severity, "... from macro `%s' defined here", m->name);
5292 static void pp_error_list_macros(int severity)
5294 int32_t saved_line;
5295 const char *saved_fname = NULL;
5297 severity |= ERR_PP_LISTMACRO | ERR_NO_SEVERITY;
5298 src_get(&saved_line, &saved_fname);
5300 if (istk)
5301 pp_list_one_macro(istk->mstk, severity);
5303 src_set(saved_line, saved_fname);
5306 const struct preproc_ops nasmpp = {
5307 pp_reset,
5308 pp_getline,
5309 pp_cleanup,
5310 pp_extra_stdmac,
5311 pp_pre_define,
5312 pp_pre_undefine,
5313 pp_pre_include,
5314 pp_include_path,
5315 pp_error_list_macros,