NASM 2.05rc1
[nasm.git] / preproc.c
blobe5b5ab3bf7739277639c62aafd9b778c11981d61
1 /* preproc.c macro preprocessor for the Netwide Assembler
3 * The Netwide Assembler is copyright (C) 1996 Simon Tatham and
4 * Julian Hall. All rights reserved. The software is
5 * redistributable under the license given in the file "LICENSE"
6 * distributed in the NASM archive.
8 * initial version 18/iii/97 by Simon Tatham
9 */
11 /* Typical flow of text through preproc
13 * pp_getline gets tokenized lines, either
15 * from a macro expansion
17 * or
18 * {
19 * read_line gets raw text from stdmacpos, or predef, or current input file
20 * tokenize converts to tokens
21 * }
23 * expand_mmac_params is used to expand %1 etc., unless a macro is being
24 * defined or a false conditional is being processed
25 * (%0, %1, %+1, %-1, %%foo
27 * do_directive checks for directives
29 * expand_smacro is used to expand single line macros
31 * expand_mmacro is used to expand multi-line macros
33 * detoken is used to convert the line back to text
36 #include "compiler.h"
38 #include <stdio.h>
39 #include <stdarg.h>
40 #include <stdlib.h>
41 #include <stddef.h>
42 #include <string.h>
43 #include <ctype.h>
44 #include <limits.h>
45 #include <inttypes.h>
47 #include "nasm.h"
48 #include "nasmlib.h"
49 #include "preproc.h"
50 #include "hashtbl.h"
51 #include "quote.h"
52 #include "stdscan.h"
53 #include "tokens.h"
54 #include "tables.h"
56 typedef struct SMacro SMacro;
57 typedef struct MMacro MMacro;
58 typedef struct Context Context;
59 typedef struct Token Token;
60 typedef struct Blocks Blocks;
61 typedef struct Line Line;
62 typedef struct Include Include;
63 typedef struct Cond Cond;
64 typedef struct IncPath IncPath;
67 * Note on the storage of both SMacro and MMacros: the hash table
68 * indexes them case-insensitively, and we then have to go through a
69 * linked list of potential case aliases (and, for MMacros, parameter
70 * ranges); this is to preserve the matching semantics of the earlier
71 * code. If the number of case aliases for a specific macro is a
72 * performance issue, you may want to reconsider your coding style.
76 * Store the definition of a single-line macro.
78 struct SMacro {
79 SMacro *next;
80 char *name;
81 bool casesense;
82 bool in_progress;
83 unsigned int nparam;
84 Token *expansion;
88 * Store the definition of a multi-line macro. This is also used to
89 * store the interiors of `%rep...%endrep' blocks, which are
90 * effectively self-re-invoking multi-line macros which simply
91 * don't have a name or bother to appear in the hash tables. %rep
92 * blocks are signified by having a NULL `name' field.
94 * In a MMacro describing a `%rep' block, the `in_progress' field
95 * isn't merely boolean, but gives the number of repeats left to
96 * run.
98 * The `next' field is used for storing MMacros in hash tables; the
99 * `next_active' field is for stacking them on istk entries.
101 * When a MMacro is being expanded, `params', `iline', `nparam',
102 * `paramlen', `rotate' and `unique' are local to the invocation.
104 struct MMacro {
105 MMacro *next;
106 char *name;
107 int nparam_min, nparam_max;
108 bool casesense;
109 bool plus; /* is the last parameter greedy? */
110 bool nolist; /* is this macro listing-inhibited? */
111 int64_t in_progress;
112 Token *dlist; /* All defaults as one list */
113 Token **defaults; /* Parameter default pointers */
114 int ndefs; /* number of default parameters */
115 Line *expansion;
117 MMacro *next_active;
118 MMacro *rep_nest; /* used for nesting %rep */
119 Token **params; /* actual parameters */
120 Token *iline; /* invocation line */
121 unsigned int nparam, rotate;
122 int *paramlen;
123 uint64_t unique;
124 int lineno; /* Current line number on expansion */
128 * The context stack is composed of a linked list of these.
130 struct Context {
131 Context *next;
132 char *name;
133 struct hash_table localmac;
134 uint32_t number;
138 * This is the internal form which we break input lines up into.
139 * Typically stored in linked lists.
141 * Note that `type' serves a double meaning: TOK_SMAC_PARAM is not
142 * necessarily used as-is, but is intended to denote the number of
143 * the substituted parameter. So in the definition
145 * %define a(x,y) ( (x) & ~(y) )
147 * the token representing `x' will have its type changed to
148 * TOK_SMAC_PARAM, but the one representing `y' will be
149 * TOK_SMAC_PARAM+1.
151 * TOK_INTERNAL_STRING is a dirty hack: it's a single string token
152 * which doesn't need quotes around it. Used in the pre-include
153 * mechanism as an alternative to trying to find a sensible type of
154 * quote to use on the filename we were passed.
156 enum pp_token_type {
157 TOK_NONE = 0, TOK_WHITESPACE, TOK_COMMENT, TOK_ID,
158 TOK_PREPROC_ID, TOK_STRING,
159 TOK_NUMBER, TOK_FLOAT, TOK_SMAC_END, TOK_OTHER,
160 TOK_INTERNAL_STRING,
161 TOK_PREPROC_Q, TOK_PREPROC_QQ,
162 TOK_SMAC_PARAM, /* MUST BE LAST IN THE LIST!!! */
163 TOK_MAX = INT_MAX /* Keep compiler from reducing the range */
166 struct Token {
167 Token *next;
168 char *text;
169 union {
170 SMacro *mac; /* associated macro for TOK_SMAC_END */
171 size_t len; /* scratch length field */
172 } a; /* Auxiliary data */
173 enum pp_token_type type;
177 * Multi-line macro definitions are stored as a linked list of
178 * these, which is essentially a container to allow several linked
179 * lists of Tokens.
181 * Note that in this module, linked lists are treated as stacks
182 * wherever possible. For this reason, Lines are _pushed_ on to the
183 * `expansion' field in MMacro structures, so that the linked list,
184 * if walked, would give the macro lines in reverse order; this
185 * means that we can walk the list when expanding a macro, and thus
186 * push the lines on to the `expansion' field in _istk_ in reverse
187 * order (so that when popped back off they are in the right
188 * order). It may seem cockeyed, and it relies on my design having
189 * an even number of steps in, but it works...
191 * Some of these structures, rather than being actual lines, are
192 * markers delimiting the end of the expansion of a given macro.
193 * This is for use in the cycle-tracking and %rep-handling code.
194 * Such structures have `finishes' non-NULL, and `first' NULL. All
195 * others have `finishes' NULL, but `first' may still be NULL if
196 * the line is blank.
198 struct Line {
199 Line *next;
200 MMacro *finishes;
201 Token *first;
205 * To handle an arbitrary level of file inclusion, we maintain a
206 * stack (ie linked list) of these things.
208 struct Include {
209 Include *next;
210 FILE *fp;
211 Cond *conds;
212 Line *expansion;
213 char *fname;
214 int lineno, lineinc;
215 MMacro *mstk; /* stack of active macros/reps */
219 * Include search path. This is simply a list of strings which get
220 * prepended, in turn, to the name of an include file, in an
221 * attempt to find the file if it's not in the current directory.
223 struct IncPath {
224 IncPath *next;
225 char *path;
229 * Conditional assembly: we maintain a separate stack of these for
230 * each level of file inclusion. (The only reason we keep the
231 * stacks separate is to ensure that a stray `%endif' in a file
232 * included from within the true branch of a `%if' won't terminate
233 * it and cause confusion: instead, rightly, it'll cause an error.)
235 struct Cond {
236 Cond *next;
237 int state;
239 enum {
241 * These states are for use just after %if or %elif: IF_TRUE
242 * means the condition has evaluated to truth so we are
243 * currently emitting, whereas IF_FALSE means we are not
244 * currently emitting but will start doing so if a %else comes
245 * up. In these states, all directives are admissible: %elif,
246 * %else and %endif. (And of course %if.)
248 COND_IF_TRUE, COND_IF_FALSE,
250 * These states come up after a %else: ELSE_TRUE means we're
251 * emitting, and ELSE_FALSE means we're not. In ELSE_* states,
252 * any %elif or %else will cause an error.
254 COND_ELSE_TRUE, COND_ELSE_FALSE,
256 * These states mean that we're not emitting now, and also that
257 * nothing until %endif will be emitted at all. COND_DONE is
258 * used when we've had our moment of emission
259 * and have now started seeing %elifs. COND_NEVER is used when
260 * the condition construct in question is contained within a
261 * non-emitting branch of a larger condition construct,
262 * or if there is an error.
264 COND_DONE, COND_NEVER
266 #define emitting(x) ( (x) == COND_IF_TRUE || (x) == COND_ELSE_TRUE )
269 * These defines are used as the possible return values for do_directive
271 #define NO_DIRECTIVE_FOUND 0
272 #define DIRECTIVE_FOUND 1
275 * Condition codes. Note that we use c_ prefix not C_ because C_ is
276 * used in nasm.h for the "real" condition codes. At _this_ level,
277 * we treat CXZ and ECXZ as condition codes, albeit non-invertible
278 * ones, so we need a different enum...
280 static const char * const conditions[] = {
281 "a", "ae", "b", "be", "c", "cxz", "e", "ecxz", "g", "ge", "l", "le",
282 "na", "nae", "nb", "nbe", "nc", "ne", "ng", "nge", "nl", "nle", "no",
283 "np", "ns", "nz", "o", "p", "pe", "po", "rcxz", "s", "z"
285 enum pp_conds {
286 c_A, c_AE, c_B, c_BE, c_C, c_CXZ, c_E, c_ECXZ, c_G, c_GE, c_L, c_LE,
287 c_NA, c_NAE, c_NB, c_NBE, c_NC, c_NE, c_NG, c_NGE, c_NL, c_NLE, c_NO,
288 c_NP, c_NS, c_NZ, c_O, c_P, c_PE, c_PO, c_RCXZ, c_S, c_Z,
289 c_none = -1
291 static const enum pp_conds inverse_ccs[] = {
292 c_NA, c_NAE, c_NB, c_NBE, c_NC, -1, c_NE, -1, c_NG, c_NGE, c_NL, c_NLE,
293 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,
294 c_Z, c_NO, c_NP, c_PO, c_PE, -1, c_NS, c_NZ
298 * Directive names.
300 /* If this is a an IF, ELIF, ELSE or ENDIF keyword */
301 static int is_condition(enum preproc_token arg)
303 return PP_IS_COND(arg) || (arg == PP_ELSE) || (arg == PP_ENDIF);
306 /* For TASM compatibility we need to be able to recognise TASM compatible
307 * conditional compilation directives. Using the NASM pre-processor does
308 * not work, so we look for them specifically from the following list and
309 * then jam in the equivalent NASM directive into the input stream.
312 enum {
313 TM_ARG, TM_ELIF, TM_ELSE, TM_ENDIF, TM_IF, TM_IFDEF, TM_IFDIFI,
314 TM_IFNDEF, TM_INCLUDE, TM_LOCAL
317 static const char * const tasm_directives[] = {
318 "arg", "elif", "else", "endif", "if", "ifdef", "ifdifi",
319 "ifndef", "include", "local"
322 static int StackSize = 4;
323 static char *StackPointer = "ebp";
324 static int ArgOffset = 8;
325 static int LocalOffset = 0;
327 static Context *cstk;
328 static Include *istk;
329 static IncPath *ipath = NULL;
331 static efunc _error; /* Pointer to client-provided error reporting function */
332 static evalfunc evaluate;
334 static int pass; /* HACK: pass 0 = generate dependencies only */
335 static StrList **dephead, **deptail; /* Dependency list */
337 static uint64_t unique; /* unique identifier numbers */
339 static Line *predef = NULL;
340 static bool do_predef;
342 static ListGen *list;
345 * The current set of multi-line macros we have defined.
347 static struct hash_table mmacros;
350 * The current set of single-line macros we have defined.
352 static struct hash_table smacros;
355 * The multi-line macro we are currently defining, or the %rep
356 * block we are currently reading, if any.
358 static MMacro *defining;
360 static uint64_t nested_mac_count;
361 static uint64_t nested_rep_count;
364 * The number of macro parameters to allocate space for at a time.
366 #define PARAM_DELTA 16
369 * The standard macro set: defined in macros.c in the array nasm_stdmac.
370 * This gives our position in the macro set, when we're processing it.
372 static macros_t *stdmacpos;
375 * The extra standard macros that come from the object format, if
376 * any.
378 static macros_t *extrastdmac = NULL;
379 static bool any_extrastdmac;
382 * Tokens are allocated in blocks to improve speed
384 #define TOKEN_BLOCKSIZE 4096
385 static Token *freeTokens = NULL;
386 struct Blocks {
387 Blocks *next;
388 void *chunk;
391 static Blocks blocks = { NULL, NULL };
394 * Forward declarations.
396 static Token *expand_mmac_params(Token * tline);
397 static Token *expand_smacro(Token * tline);
398 static Token *expand_id(Token * tline);
399 static Context *get_ctx(const char *name, bool all_contexts);
400 static void make_tok_num(Token * tok, int64_t val);
401 static void error(int severity, const char *fmt, ...);
402 static void error_precond(int severity, const char *fmt, ...);
403 static void *new_Block(size_t size);
404 static void delete_Blocks(void);
405 static Token *new_Token(Token * next, enum pp_token_type type,
406 const char *text, int txtlen);
407 static Token *delete_Token(Token * t);
410 * Macros for safe checking of token pointers, avoid *(NULL)
412 #define tok_type_(x,t) ((x) && (x)->type == (t))
413 #define skip_white_(x) if (tok_type_((x), TOK_WHITESPACE)) (x)=(x)->next
414 #define tok_is_(x,v) (tok_type_((x), TOK_OTHER) && !strcmp((x)->text,(v)))
415 #define tok_isnt_(x,v) ((x) && ((x)->type!=TOK_OTHER || strcmp((x)->text,(v))))
417 /* Handle TASM specific directives, which do not contain a % in
418 * front of them. We do it here because I could not find any other
419 * place to do it for the moment, and it is a hack (ideally it would
420 * be nice to be able to use the NASM pre-processor to do it).
422 static char *check_tasm_directive(char *line)
424 int32_t i, j, k, m, len;
425 char *p = line, *oldline, oldchar;
427 /* Skip whitespace */
428 while (nasm_isspace(*p) && *p != 0)
429 p++;
431 /* Binary search for the directive name */
432 i = -1;
433 j = elements(tasm_directives);
434 len = 0;
435 while (!nasm_isspace(p[len]) && p[len] != 0)
436 len++;
437 if (len) {
438 oldchar = p[len];
439 p[len] = 0;
440 while (j - i > 1) {
441 k = (j + i) / 2;
442 m = nasm_stricmp(p, tasm_directives[k]);
443 if (m == 0) {
444 /* We have found a directive, so jam a % in front of it
445 * so that NASM will then recognise it as one if it's own.
447 p[len] = oldchar;
448 len = strlen(p);
449 oldline = line;
450 line = nasm_malloc(len + 2);
451 line[0] = '%';
452 if (k == TM_IFDIFI) {
453 /* NASM does not recognise IFDIFI, so we convert it to
454 * %ifdef BOGUS. This is not used in NASM comaptible
455 * code, but does need to parse for the TASM macro
456 * package.
458 strcpy(line + 1, "ifdef BOGUS");
459 } else {
460 memcpy(line + 1, p, len + 1);
462 nasm_free(oldline);
463 return line;
464 } else if (m < 0) {
465 j = k;
466 } else
467 i = k;
469 p[len] = oldchar;
471 return line;
475 * The pre-preprocessing stage... This function translates line
476 * number indications as they emerge from GNU cpp (`# lineno "file"
477 * flags') into NASM preprocessor line number indications (`%line
478 * lineno file').
480 static char *prepreproc(char *line)
482 int lineno, fnlen;
483 char *fname, *oldline;
485 if (line[0] == '#' && line[1] == ' ') {
486 oldline = line;
487 fname = oldline + 2;
488 lineno = atoi(fname);
489 fname += strspn(fname, "0123456789 ");
490 if (*fname == '"')
491 fname++;
492 fnlen = strcspn(fname, "\"");
493 line = nasm_malloc(20 + fnlen);
494 snprintf(line, 20 + fnlen, "%%line %d %.*s", lineno, fnlen, fname);
495 nasm_free(oldline);
497 if (tasm_compatible_mode)
498 return check_tasm_directive(line);
499 return line;
503 * Free a linked list of tokens.
505 static void free_tlist(Token * list)
507 while (list) {
508 list = delete_Token(list);
513 * Free a linked list of lines.
515 static void free_llist(Line * list)
517 Line *l;
518 while (list) {
519 l = list;
520 list = list->next;
521 free_tlist(l->first);
522 nasm_free(l);
527 * Free an MMacro
529 static void free_mmacro(MMacro * m)
531 nasm_free(m->name);
532 free_tlist(m->dlist);
533 nasm_free(m->defaults);
534 free_llist(m->expansion);
535 nasm_free(m);
539 * Free all currently defined macros, and free the hash tables
541 static void free_smacro_table(struct hash_table *smt)
543 SMacro *s;
544 const char *key;
545 struct hash_tbl_node *it = NULL;
547 while ((s = hash_iterate(smt, &it, &key)) != NULL) {
548 nasm_free((void *)key);
549 while (s) {
550 SMacro *ns = s->next;
551 nasm_free(s->name);
552 free_tlist(s->expansion);
553 nasm_free(s);
554 s = ns;
557 hash_free(smt);
560 static void free_mmacro_table(struct hash_table *mmt)
562 MMacro *m;
563 const char *key;
564 struct hash_tbl_node *it = NULL;
566 it = NULL;
567 while ((m = hash_iterate(mmt, &it, &key)) != NULL) {
568 nasm_free((void *)key);
569 while (m) {
570 MMacro *nm = m->next;
571 free_mmacro(m);
572 m = nm;
575 hash_free(mmt);
578 static void free_macros(void)
580 free_smacro_table(&smacros);
581 free_mmacro_table(&mmacros);
585 * Initialize the hash tables
587 static void init_macros(void)
589 hash_init(&smacros, HASH_LARGE);
590 hash_init(&mmacros, HASH_LARGE);
594 * Pop the context stack.
596 static void ctx_pop(void)
598 Context *c = cstk;
600 cstk = cstk->next;
601 free_smacro_table(&c->localmac);
602 nasm_free(c->name);
603 nasm_free(c);
607 * Search for a key in the hash index; adding it if necessary
608 * (in which case we initialize the data pointer to NULL.)
610 static void **
611 hash_findi_add(struct hash_table *hash, const char *str)
613 struct hash_insert hi;
614 void **r;
615 char *strx;
617 r = hash_findi(hash, str, &hi);
618 if (r)
619 return r;
621 strx = nasm_strdup(str); /* Use a more efficient allocator here? */
622 return hash_add(&hi, strx, NULL);
626 * Like hash_findi, but returns the data element rather than a pointer
627 * to it. Used only when not adding a new element, hence no third
628 * argument.
630 static void *
631 hash_findix(struct hash_table *hash, const char *str)
633 void **p;
635 p = hash_findi(hash, str, NULL);
636 return p ? *p : NULL;
639 #define BUF_DELTA 512
641 * Read a line from the top file in istk, handling multiple CR/LFs
642 * at the end of the line read, and handling spurious ^Zs. Will
643 * return lines from the standard macro set if this has not already
644 * been done.
646 static char *read_line(void)
648 char *buffer, *p, *q;
649 int bufsize, continued_count;
651 if (stdmacpos) {
652 unsigned char c;
653 const unsigned char *p = stdmacpos;
654 char *ret, *q;
655 size_t len = 0;
656 while ((c = *p++)) {
657 if (c >= 0x80)
658 len += pp_directives_len[c-0x80]+1;
659 else
660 len++;
662 ret = nasm_malloc(len+1);
663 q = ret;
664 while ((c = *stdmacpos++)) {
665 if (c >= 0x80) {
666 memcpy(q, pp_directives[c-0x80], pp_directives_len[c-0x80]);
667 q += pp_directives_len[c-0x80];
668 *q++ = ' ';
669 } else {
670 *q++ = c;
673 stdmacpos = p;
674 *q = '\0';
676 if (!*stdmacpos) {
677 /* This was the last of the standard macro chain... */
678 stdmacpos = NULL;
679 if (any_extrastdmac) {
680 stdmacpos = extrastdmac;
681 any_extrastdmac = false;
682 } else if (do_predef) {
683 Line *pd, *l;
684 Token *head, **tail, *t;
687 * Nasty hack: here we push the contents of
688 * `predef' on to the top-level expansion stack,
689 * since this is the most convenient way to
690 * implement the pre-include and pre-define
691 * features.
693 for (pd = predef; pd; pd = pd->next) {
694 head = NULL;
695 tail = &head;
696 for (t = pd->first; t; t = t->next) {
697 *tail = new_Token(NULL, t->type, t->text, 0);
698 tail = &(*tail)->next;
700 l = nasm_malloc(sizeof(Line));
701 l->next = istk->expansion;
702 l->first = head;
703 l->finishes = NULL;
704 istk->expansion = l;
706 do_predef = false;
709 return ret;
712 bufsize = BUF_DELTA;
713 buffer = nasm_malloc(BUF_DELTA);
714 p = buffer;
715 continued_count = 0;
716 while (1) {
717 q = fgets(p, bufsize - (p - buffer), istk->fp);
718 if (!q)
719 break;
720 p += strlen(p);
721 if (p > buffer && p[-1] == '\n') {
722 /* Convert backslash-CRLF line continuation sequences into
723 nothing at all (for DOS and Windows) */
724 if (((p - 2) > buffer) && (p[-3] == '\\') && (p[-2] == '\r')) {
725 p -= 3;
726 *p = 0;
727 continued_count++;
729 /* Also convert backslash-LF line continuation sequences into
730 nothing at all (for Unix) */
731 else if (((p - 1) > buffer) && (p[-2] == '\\')) {
732 p -= 2;
733 *p = 0;
734 continued_count++;
735 } else {
736 break;
739 if (p - buffer > bufsize - 10) {
740 int32_t offset = p - buffer;
741 bufsize += BUF_DELTA;
742 buffer = nasm_realloc(buffer, bufsize);
743 p = buffer + offset; /* prevent stale-pointer problems */
747 if (!q && p == buffer) {
748 nasm_free(buffer);
749 return NULL;
752 src_set_linnum(src_get_linnum() + istk->lineinc +
753 (continued_count * istk->lineinc));
756 * Play safe: remove CRs as well as LFs, if any of either are
757 * present at the end of the line.
759 while (--p >= buffer && (*p == '\n' || *p == '\r'))
760 *p = '\0';
763 * Handle spurious ^Z, which may be inserted into source files
764 * by some file transfer utilities.
766 buffer[strcspn(buffer, "\032")] = '\0';
768 list->line(LIST_READ, buffer);
770 return buffer;
774 * Tokenize a line of text. This is a very simple process since we
775 * don't need to parse the value out of e.g. numeric tokens: we
776 * simply split one string into many.
778 static Token *tokenize(char *line)
780 char *p = line;
781 enum pp_token_type type;
782 Token *list = NULL;
783 Token *t, **tail = &list;
785 while (*line) {
786 p = line;
787 if (*p == '%') {
788 p++;
789 if (nasm_isdigit(*p) ||
790 ((*p == '-' || *p == '+') && nasm_isdigit(p[1])) ||
791 ((*p == '+') && (nasm_isspace(p[1]) || !p[1]))) {
792 do {
793 p++;
795 while (nasm_isdigit(*p));
796 type = TOK_PREPROC_ID;
797 } else if (*p == '{') {
798 p++;
799 while (*p && *p != '}') {
800 p[-1] = *p;
801 p++;
803 p[-1] = '\0';
804 if (*p)
805 p++;
806 type = TOK_PREPROC_ID;
807 } else if (*p == '?') {
808 type = TOK_PREPROC_Q; /* %? */
809 p++;
810 if (*p == '?') {
811 type = TOK_PREPROC_QQ; /* %?? */
812 p++;
814 } else if (isidchar(*p) ||
815 ((*p == '!' || *p == '%' || *p == '$') &&
816 isidchar(p[1]))) {
817 do {
818 p++;
820 while (isidchar(*p));
821 type = TOK_PREPROC_ID;
822 } else {
823 type = TOK_OTHER;
824 if (*p == '%')
825 p++;
827 } else if (isidstart(*p) || (*p == '$' && isidstart(p[1]))) {
828 type = TOK_ID;
829 p++;
830 while (*p && isidchar(*p))
831 p++;
832 } else if (*p == '\'' || *p == '"' || *p == '`') {
834 * A string token.
836 type = TOK_STRING;
837 p = nasm_skip_string(p);
839 if (*p) {
840 p++;
841 } else {
842 error(ERR_WARNING|ERR_PASS1, "unterminated string");
843 /* Handling unterminated strings by UNV */
844 /* type = -1; */
846 } else if (isnumstart(*p)) {
847 bool is_hex = false;
848 bool is_float = false;
849 bool has_e = false;
850 char c, *r;
853 * A numeric token.
856 if (*p == '$') {
857 p++;
858 is_hex = true;
861 for (;;) {
862 c = *p++;
864 if (!is_hex && (c == 'e' || c == 'E')) {
865 has_e = true;
866 if (*p == '+' || *p == '-') {
867 /* e can only be followed by +/- if it is either a
868 prefixed hex number or a floating-point number */
869 p++;
870 is_float = true;
872 } else if (c == 'H' || c == 'h' || c == 'X' || c == 'x') {
873 is_hex = true;
874 } else if (c == 'P' || c == 'p') {
875 is_float = true;
876 if (*p == '+' || *p == '-')
877 p++;
878 } else if (isnumchar(c) || c == '_')
879 ; /* just advance */
880 else if (c == '.') {
881 /* we need to deal with consequences of the legacy
882 parser, like "1.nolist" being two tokens
883 (TOK_NUMBER, TOK_ID) here; at least give it
884 a shot for now. In the future, we probably need
885 a flex-based scanner with proper pattern matching
886 to do it as well as it can be done. Nothing in
887 the world is going to help the person who wants
888 0x123.p16 interpreted as two tokens, though. */
889 r = p;
890 while (*r == '_')
891 r++;
893 if (nasm_isdigit(*r) || (is_hex && nasm_isxdigit(*r)) ||
894 (!is_hex && (*r == 'e' || *r == 'E')) ||
895 (*r == 'p' || *r == 'P')) {
896 p = r;
897 is_float = true;
898 } else
899 break; /* Terminate the token */
900 } else
901 break;
903 p--; /* Point to first character beyond number */
905 if (has_e && !is_hex) {
906 /* 1e13 is floating-point, but 1e13h is not */
907 is_float = true;
910 type = is_float ? TOK_FLOAT : TOK_NUMBER;
911 } else if (nasm_isspace(*p)) {
912 type = TOK_WHITESPACE;
913 p++;
914 while (*p && nasm_isspace(*p))
915 p++;
917 * Whitespace just before end-of-line is discarded by
918 * pretending it's a comment; whitespace just before a
919 * comment gets lumped into the comment.
921 if (!*p || *p == ';') {
922 type = TOK_COMMENT;
923 while (*p)
924 p++;
926 } else if (*p == ';') {
927 type = TOK_COMMENT;
928 while (*p)
929 p++;
930 } else {
932 * Anything else is an operator of some kind. We check
933 * for all the double-character operators (>>, <<, //,
934 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
935 * else is a single-character operator.
937 type = TOK_OTHER;
938 if ((p[0] == '>' && p[1] == '>') ||
939 (p[0] == '<' && p[1] == '<') ||
940 (p[0] == '/' && p[1] == '/') ||
941 (p[0] == '<' && p[1] == '=') ||
942 (p[0] == '>' && p[1] == '=') ||
943 (p[0] == '=' && p[1] == '=') ||
944 (p[0] == '!' && p[1] == '=') ||
945 (p[0] == '<' && p[1] == '>') ||
946 (p[0] == '&' && p[1] == '&') ||
947 (p[0] == '|' && p[1] == '|') ||
948 (p[0] == '^' && p[1] == '^')) {
949 p++;
951 p++;
954 /* Handling unterminated string by UNV */
955 /*if (type == -1)
957 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
958 t->text[p-line] = *line;
959 tail = &t->next;
961 else */
962 if (type != TOK_COMMENT) {
963 *tail = t = new_Token(NULL, type, line, p - line);
964 tail = &t->next;
966 line = p;
968 return list;
972 * this function allocates a new managed block of memory and
973 * returns a pointer to the block. The managed blocks are
974 * deleted only all at once by the delete_Blocks function.
976 static void *new_Block(size_t size)
978 Blocks *b = &blocks;
980 /* first, get to the end of the linked list */
981 while (b->next)
982 b = b->next;
983 /* now allocate the requested chunk */
984 b->chunk = nasm_malloc(size);
986 /* now allocate a new block for the next request */
987 b->next = nasm_malloc(sizeof(Blocks));
988 /* and initialize the contents of the new block */
989 b->next->next = NULL;
990 b->next->chunk = NULL;
991 return b->chunk;
995 * this function deletes all managed blocks of memory
997 static void delete_Blocks(void)
999 Blocks *a, *b = &blocks;
1002 * keep in mind that the first block, pointed to by blocks
1003 * is a static and not dynamically allocated, so we don't
1004 * free it.
1006 while (b) {
1007 if (b->chunk)
1008 nasm_free(b->chunk);
1009 a = b;
1010 b = b->next;
1011 if (a != &blocks)
1012 nasm_free(a);
1017 * this function creates a new Token and passes a pointer to it
1018 * back to the caller. It sets the type and text elements, and
1019 * also the a.mac and next elements to NULL.
1021 static Token *new_Token(Token * next, enum pp_token_type type,
1022 const char *text, int txtlen)
1024 Token *t;
1025 int i;
1027 if (freeTokens == NULL) {
1028 freeTokens = (Token *) new_Block(TOKEN_BLOCKSIZE * sizeof(Token));
1029 for (i = 0; i < TOKEN_BLOCKSIZE - 1; i++)
1030 freeTokens[i].next = &freeTokens[i + 1];
1031 freeTokens[i].next = NULL;
1033 t = freeTokens;
1034 freeTokens = t->next;
1035 t->next = next;
1036 t->a.mac = NULL;
1037 t->type = type;
1038 if (type == TOK_WHITESPACE || text == NULL) {
1039 t->text = NULL;
1040 } else {
1041 if (txtlen == 0)
1042 txtlen = strlen(text);
1043 t->text = nasm_malloc(txtlen+1);
1044 memcpy(t->text, text, txtlen);
1045 t->text[txtlen] = '\0';
1047 return t;
1050 static Token *delete_Token(Token * t)
1052 Token *next = t->next;
1053 nasm_free(t->text);
1054 t->next = freeTokens;
1055 freeTokens = t;
1056 return next;
1060 * Convert a line of tokens back into text.
1061 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1062 * will be transformed into ..@ctxnum.xxx
1064 static char *detoken(Token * tlist, bool expand_locals)
1066 Token *t;
1067 int len;
1068 char *line, *p;
1069 const char *q;
1071 len = 0;
1072 for (t = tlist; t; t = t->next) {
1073 if (t->type == TOK_PREPROC_ID && t->text[1] == '!') {
1074 char *p = getenv(t->text + 2);
1075 nasm_free(t->text);
1076 if (p)
1077 t->text = nasm_strdup(p);
1078 else
1079 t->text = NULL;
1081 /* Expand local macros here and not during preprocessing */
1082 if (expand_locals &&
1083 t->type == TOK_PREPROC_ID && t->text &&
1084 t->text[0] == '%' && t->text[1] == '$') {
1085 Context *ctx = get_ctx(t->text, false);
1086 if (ctx) {
1087 char buffer[40];
1088 char *p, *q = t->text + 2;
1090 q += strspn(q, "$");
1091 snprintf(buffer, sizeof(buffer), "..@%"PRIu32".", ctx->number);
1092 p = nasm_strcat(buffer, q);
1093 nasm_free(t->text);
1094 t->text = p;
1097 if (t->type == TOK_WHITESPACE) {
1098 len++;
1099 } else if (t->text) {
1100 len += strlen(t->text);
1103 p = line = nasm_malloc(len + 1);
1104 for (t = tlist; t; t = t->next) {
1105 if (t->type == TOK_WHITESPACE) {
1106 *p++ = ' ';
1107 } else if (t->text) {
1108 q = t->text;
1109 while (*q)
1110 *p++ = *q++;
1113 *p = '\0';
1114 return line;
1118 * A scanner, suitable for use by the expression evaluator, which
1119 * operates on a line of Tokens. Expects a pointer to a pointer to
1120 * the first token in the line to be passed in as its private_data
1121 * field.
1123 * FIX: This really needs to be unified with stdscan.
1125 static int ppscan(void *private_data, struct tokenval *tokval)
1127 Token **tlineptr = private_data;
1128 Token *tline;
1129 char ourcopy[MAX_KEYWORD+1], *p, *r, *s;
1131 do {
1132 tline = *tlineptr;
1133 *tlineptr = tline ? tline->next : NULL;
1135 while (tline && (tline->type == TOK_WHITESPACE ||
1136 tline->type == TOK_COMMENT));
1138 if (!tline)
1139 return tokval->t_type = TOKEN_EOS;
1141 tokval->t_charptr = tline->text;
1143 if (tline->text[0] == '$' && !tline->text[1])
1144 return tokval->t_type = TOKEN_HERE;
1145 if (tline->text[0] == '$' && tline->text[1] == '$' && !tline->text[2])
1146 return tokval->t_type = TOKEN_BASE;
1148 if (tline->type == TOK_ID) {
1149 p = tokval->t_charptr = tline->text;
1150 if (p[0] == '$') {
1151 tokval->t_charptr++;
1152 return tokval->t_type = TOKEN_ID;
1155 for (r = p, s = ourcopy; *r; r++) {
1156 if (r >= p+MAX_KEYWORD)
1157 return tokval->t_type = TOKEN_ID; /* Not a keyword */
1158 *s++ = nasm_tolower(*r);
1160 *s = '\0';
1161 /* right, so we have an identifier sitting in temp storage. now,
1162 * is it actually a register or instruction name, or what? */
1163 return nasm_token_hash(ourcopy, tokval);
1166 if (tline->type == TOK_NUMBER) {
1167 bool rn_error;
1168 tokval->t_integer = readnum(tline->text, &rn_error);
1169 tokval->t_charptr = tline->text;
1170 if (rn_error)
1171 return tokval->t_type = TOKEN_ERRNUM;
1172 else
1173 return tokval->t_type = TOKEN_NUM;
1176 if (tline->type == TOK_FLOAT) {
1177 return tokval->t_type = TOKEN_FLOAT;
1180 if (tline->type == TOK_STRING) {
1181 char bq, *ep;
1183 bq = tline->text[0];
1184 tokval->t_charptr = tline->text;
1185 tokval->t_inttwo = nasm_unquote(tline->text, &ep);
1187 if (ep[0] != bq || ep[1] != '\0')
1188 return tokval->t_type = TOKEN_ERRSTR;
1189 else
1190 return tokval->t_type = TOKEN_STR;
1193 if (tline->type == TOK_OTHER) {
1194 if (!strcmp(tline->text, "<<"))
1195 return tokval->t_type = TOKEN_SHL;
1196 if (!strcmp(tline->text, ">>"))
1197 return tokval->t_type = TOKEN_SHR;
1198 if (!strcmp(tline->text, "//"))
1199 return tokval->t_type = TOKEN_SDIV;
1200 if (!strcmp(tline->text, "%%"))
1201 return tokval->t_type = TOKEN_SMOD;
1202 if (!strcmp(tline->text, "=="))
1203 return tokval->t_type = TOKEN_EQ;
1204 if (!strcmp(tline->text, "<>"))
1205 return tokval->t_type = TOKEN_NE;
1206 if (!strcmp(tline->text, "!="))
1207 return tokval->t_type = TOKEN_NE;
1208 if (!strcmp(tline->text, "<="))
1209 return tokval->t_type = TOKEN_LE;
1210 if (!strcmp(tline->text, ">="))
1211 return tokval->t_type = TOKEN_GE;
1212 if (!strcmp(tline->text, "&&"))
1213 return tokval->t_type = TOKEN_DBL_AND;
1214 if (!strcmp(tline->text, "^^"))
1215 return tokval->t_type = TOKEN_DBL_XOR;
1216 if (!strcmp(tline->text, "||"))
1217 return tokval->t_type = TOKEN_DBL_OR;
1221 * We have no other options: just return the first character of
1222 * the token text.
1224 return tokval->t_type = tline->text[0];
1228 * Compare a string to the name of an existing macro; this is a
1229 * simple wrapper which calls either strcmp or nasm_stricmp
1230 * depending on the value of the `casesense' parameter.
1232 static int mstrcmp(const char *p, const char *q, bool casesense)
1234 return casesense ? strcmp(p, q) : nasm_stricmp(p, q);
1238 * Compare a string to the name of an existing macro; this is a
1239 * simple wrapper which calls either strcmp or nasm_stricmp
1240 * depending on the value of the `casesense' parameter.
1242 static int mmemcmp(const char *p, const char *q, size_t l, bool casesense)
1244 return casesense ? memcmp(p, q, l) : nasm_memicmp(p, q, l);
1248 * Return the Context structure associated with a %$ token. Return
1249 * NULL, having _already_ reported an error condition, if the
1250 * context stack isn't deep enough for the supplied number of $
1251 * signs.
1252 * If all_contexts == true, contexts that enclose current are
1253 * also scanned for such smacro, until it is found; if not -
1254 * only the context that directly results from the number of $'s
1255 * in variable's name.
1257 static Context *get_ctx(const char *name, bool all_contexts)
1259 Context *ctx;
1260 SMacro *m;
1261 int i;
1263 if (!name || name[0] != '%' || name[1] != '$')
1264 return NULL;
1266 if (!cstk) {
1267 error(ERR_NONFATAL, "`%s': context stack is empty", name);
1268 return NULL;
1271 for (i = strspn(name + 2, "$"), ctx = cstk; (i > 0) && ctx; i--) {
1272 ctx = ctx->next;
1273 /* i--; Lino - 02/25/02 */
1275 if (!ctx) {
1276 error(ERR_NONFATAL, "`%s': context stack is only"
1277 " %d level%s deep", name, i - 1, (i == 2 ? "" : "s"));
1278 return NULL;
1280 if (!all_contexts)
1281 return ctx;
1283 do {
1284 /* Search for this smacro in found context */
1285 m = hash_findix(&ctx->localmac, name);
1286 while (m) {
1287 if (!mstrcmp(m->name, name, m->casesense))
1288 return ctx;
1289 m = m->next;
1291 ctx = ctx->next;
1293 while (ctx);
1294 return NULL;
1298 * Check to see if a file is already in a string list
1300 static bool in_list(const StrList *list, const char *str)
1302 while (list) {
1303 if (!strcmp(list->str, str))
1304 return true;
1305 list = list->next;
1307 return false;
1311 * Open an include file. This routine must always return a valid
1312 * file pointer if it returns - it's responsible for throwing an
1313 * ERR_FATAL and bombing out completely if not. It should also try
1314 * the include path one by one until it finds the file or reaches
1315 * the end of the path.
1317 static FILE *inc_fopen(const char *file, StrList **dhead, StrList ***dtail,
1318 bool missing_ok)
1320 FILE *fp;
1321 char *prefix = "";
1322 IncPath *ip = ipath;
1323 int len = strlen(file);
1324 size_t prefix_len = 0;
1325 StrList *sl;
1327 while (1) {
1328 sl = nasm_malloc(prefix_len+len+1+sizeof sl->next);
1329 memcpy(sl->str, prefix, prefix_len);
1330 memcpy(sl->str+prefix_len, file, len+1);
1331 fp = fopen(sl->str, "r");
1332 if (fp && dhead && !in_list(*dhead, sl->str)) {
1333 sl->next = NULL;
1334 **dtail = sl;
1335 *dtail = &sl->next;
1336 } else {
1337 nasm_free(sl);
1339 if (fp)
1340 return fp;
1341 if (!ip) {
1342 if (!missing_ok)
1343 break;
1344 prefix = NULL;
1345 } else {
1346 prefix = ip->path;
1347 ip = ip->next;
1349 if (prefix) {
1350 prefix_len = strlen(prefix);
1351 } else {
1352 /* -MG given and file not found */
1353 if (dhead && !in_list(*dhead, file)) {
1354 sl = nasm_malloc(len+1+sizeof sl->next);
1355 sl->next = NULL;
1356 strcpy(sl->str, file);
1357 **dtail = sl;
1358 *dtail = &sl->next;
1360 return NULL;
1364 error(ERR_FATAL, "unable to open include file `%s'", file);
1365 return NULL; /* never reached - placate compilers */
1369 * Determine if we should warn on defining a single-line macro of
1370 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1371 * return true if _any_ single-line macro of that name is defined.
1372 * Otherwise, will return true if a single-line macro with either
1373 * `nparam' or no parameters is defined.
1375 * If a macro with precisely the right number of parameters is
1376 * defined, or nparam is -1, the address of the definition structure
1377 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1378 * is NULL, no action will be taken regarding its contents, and no
1379 * error will occur.
1381 * Note that this is also called with nparam zero to resolve
1382 * `ifdef'.
1384 * If you already know which context macro belongs to, you can pass
1385 * the context pointer as first parameter; if you won't but name begins
1386 * with %$ the context will be automatically computed. If all_contexts
1387 * is true, macro will be searched in outer contexts as well.
1389 static bool
1390 smacro_defined(Context * ctx, const char *name, int nparam, SMacro ** defn,
1391 bool nocase)
1393 struct hash_table *smtbl;
1394 SMacro *m;
1396 if (ctx) {
1397 smtbl = &ctx->localmac;
1398 } else if (name[0] == '%' && name[1] == '$') {
1399 if (cstk)
1400 ctx = get_ctx(name, false);
1401 if (!ctx)
1402 return false; /* got to return _something_ */
1403 smtbl = &ctx->localmac;
1404 } else {
1405 smtbl = &smacros;
1407 m = (SMacro *) hash_findix(smtbl, name);
1409 while (m) {
1410 if (!mstrcmp(m->name, name, m->casesense && nocase) &&
1411 (nparam <= 0 || m->nparam == 0 || nparam == (int) m->nparam)) {
1412 if (defn) {
1413 if (nparam == (int) m->nparam || nparam == -1)
1414 *defn = m;
1415 else
1416 *defn = NULL;
1418 return true;
1420 m = m->next;
1423 return false;
1427 * Count and mark off the parameters in a multi-line macro call.
1428 * This is called both from within the multi-line macro expansion
1429 * code, and also to mark off the default parameters when provided
1430 * in a %macro definition line.
1432 static void count_mmac_params(Token * t, int *nparam, Token *** params)
1434 int paramsize, brace;
1436 *nparam = paramsize = 0;
1437 *params = NULL;
1438 while (t) {
1439 /* +1: we need space for the final NULL */
1440 if (*nparam+1 >= paramsize) {
1441 paramsize += PARAM_DELTA;
1442 *params = nasm_realloc(*params, sizeof(**params) * paramsize);
1444 skip_white_(t);
1445 brace = false;
1446 if (tok_is_(t, "{"))
1447 brace = true;
1448 (*params)[(*nparam)++] = t;
1449 while (tok_isnt_(t, brace ? "}" : ","))
1450 t = t->next;
1451 if (t) { /* got a comma/brace */
1452 t = t->next;
1453 if (brace) {
1455 * Now we've found the closing brace, look further
1456 * for the comma.
1458 skip_white_(t);
1459 if (tok_isnt_(t, ",")) {
1460 error(ERR_NONFATAL,
1461 "braces do not enclose all of macro parameter");
1462 while (tok_isnt_(t, ","))
1463 t = t->next;
1465 if (t)
1466 t = t->next; /* eat the comma */
1473 * Determine whether one of the various `if' conditions is true or
1474 * not.
1476 * We must free the tline we get passed.
1478 static bool if_condition(Token * tline, enum preproc_token ct)
1480 enum pp_conditional i = PP_COND(ct);
1481 bool j;
1482 Token *t, *tt, **tptr, *origline;
1483 struct tokenval tokval;
1484 expr *evalresult;
1485 enum pp_token_type needtype;
1487 origline = tline;
1489 switch (i) {
1490 case PPC_IFCTX:
1491 j = false; /* have we matched yet? */
1492 while (true) {
1493 skip_white_(tline);
1494 if (!tline)
1495 break;
1496 if (tline->type != TOK_ID) {
1497 error(ERR_NONFATAL,
1498 "`%s' expects context identifiers", pp_directives[ct]);
1499 free_tlist(origline);
1500 return -1;
1502 if (cstk && cstk->name && !nasm_stricmp(tline->text, cstk->name))
1503 j = true;
1504 tline = tline->next;
1506 break;
1508 case PPC_IFDEF:
1509 j = false; /* have we matched yet? */
1510 while (tline) {
1511 skip_white_(tline);
1512 if (!tline || (tline->type != TOK_ID &&
1513 (tline->type != TOK_PREPROC_ID ||
1514 tline->text[1] != '$'))) {
1515 error(ERR_NONFATAL,
1516 "`%s' expects macro identifiers", pp_directives[ct]);
1517 goto fail;
1519 if (smacro_defined(NULL, tline->text, 0, NULL, true))
1520 j = true;
1521 tline = tline->next;
1523 break;
1525 case PPC_IFIDN:
1526 case PPC_IFIDNI:
1527 tline = expand_smacro(tline);
1528 t = tt = tline;
1529 while (tok_isnt_(tt, ","))
1530 tt = tt->next;
1531 if (!tt) {
1532 error(ERR_NONFATAL,
1533 "`%s' expects two comma-separated arguments",
1534 pp_directives[ct]);
1535 goto fail;
1537 tt = tt->next;
1538 j = true; /* assume equality unless proved not */
1539 while ((t->type != TOK_OTHER || strcmp(t->text, ",")) && tt) {
1540 if (tt->type == TOK_OTHER && !strcmp(tt->text, ",")) {
1541 error(ERR_NONFATAL, "`%s': more than one comma on line",
1542 pp_directives[ct]);
1543 goto fail;
1545 if (t->type == TOK_WHITESPACE) {
1546 t = t->next;
1547 continue;
1549 if (tt->type == TOK_WHITESPACE) {
1550 tt = tt->next;
1551 continue;
1553 if (tt->type != t->type) {
1554 j = false; /* found mismatching tokens */
1555 break;
1557 /* When comparing strings, need to unquote them first */
1558 if (t->type == TOK_STRING) {
1559 size_t l1 = nasm_unquote(t->text, NULL);
1560 size_t l2 = nasm_unquote(tt->text, NULL);
1562 if (l1 != l2) {
1563 j = false;
1564 break;
1566 if (mmemcmp(t->text, tt->text, l1, i == PPC_IFIDN)) {
1567 j = false;
1568 break;
1570 } else if (mstrcmp(tt->text, t->text, i == PPC_IFIDN) != 0) {
1571 j = false; /* found mismatching tokens */
1572 break;
1575 t = t->next;
1576 tt = tt->next;
1578 if ((t->type != TOK_OTHER || strcmp(t->text, ",")) || tt)
1579 j = false; /* trailing gunk on one end or other */
1580 break;
1582 case PPC_IFMACRO:
1584 bool found = false;
1585 MMacro searching, *mmac;
1587 tline = tline->next;
1588 skip_white_(tline);
1589 tline = expand_id(tline);
1590 if (!tok_type_(tline, TOK_ID)) {
1591 error(ERR_NONFATAL,
1592 "`%s' expects a macro name", pp_directives[ct]);
1593 goto fail;
1595 searching.name = nasm_strdup(tline->text);
1596 searching.casesense = true;
1597 searching.plus = false;
1598 searching.nolist = false;
1599 searching.in_progress = 0;
1600 searching.rep_nest = NULL;
1601 searching.nparam_min = 0;
1602 searching.nparam_max = INT_MAX;
1603 tline = expand_smacro(tline->next);
1604 skip_white_(tline);
1605 if (!tline) {
1606 } else if (!tok_type_(tline, TOK_NUMBER)) {
1607 error(ERR_NONFATAL,
1608 "`%s' expects a parameter count or nothing",
1609 pp_directives[ct]);
1610 } else {
1611 searching.nparam_min = searching.nparam_max =
1612 readnum(tline->text, &j);
1613 if (j)
1614 error(ERR_NONFATAL,
1615 "unable to parse parameter count `%s'",
1616 tline->text);
1618 if (tline && tok_is_(tline->next, "-")) {
1619 tline = tline->next->next;
1620 if (tok_is_(tline, "*"))
1621 searching.nparam_max = INT_MAX;
1622 else if (!tok_type_(tline, TOK_NUMBER))
1623 error(ERR_NONFATAL,
1624 "`%s' expects a parameter count after `-'",
1625 pp_directives[ct]);
1626 else {
1627 searching.nparam_max = readnum(tline->text, &j);
1628 if (j)
1629 error(ERR_NONFATAL,
1630 "unable to parse parameter count `%s'",
1631 tline->text);
1632 if (searching.nparam_min > searching.nparam_max)
1633 error(ERR_NONFATAL,
1634 "minimum parameter count exceeds maximum");
1637 if (tline && tok_is_(tline->next, "+")) {
1638 tline = tline->next;
1639 searching.plus = true;
1641 mmac = (MMacro *) hash_findix(&mmacros, searching.name);
1642 while (mmac) {
1643 if (!strcmp(mmac->name, searching.name) &&
1644 (mmac->nparam_min <= searching.nparam_max
1645 || searching.plus)
1646 && (searching.nparam_min <= mmac->nparam_max
1647 || mmac->plus)) {
1648 found = true;
1649 break;
1651 mmac = mmac->next;
1653 if(tline && tline->next)
1654 error(ERR_WARNING|ERR_PASS1,
1655 "trailing garbage after %%ifmacro ignored");
1656 nasm_free(searching.name);
1657 j = found;
1658 break;
1661 case PPC_IFID:
1662 needtype = TOK_ID;
1663 goto iftype;
1664 case PPC_IFNUM:
1665 needtype = TOK_NUMBER;
1666 goto iftype;
1667 case PPC_IFSTR:
1668 needtype = TOK_STRING;
1669 goto iftype;
1671 iftype:
1672 t = tline = expand_smacro(tline);
1674 while (tok_type_(t, TOK_WHITESPACE) ||
1675 (needtype == TOK_NUMBER &&
1676 tok_type_(t, TOK_OTHER) &&
1677 (t->text[0] == '-' || t->text[0] == '+') &&
1678 !t->text[1]))
1679 t = t->next;
1681 j = tok_type_(t, needtype);
1682 break;
1684 case PPC_IFTOKEN:
1685 t = tline = expand_smacro(tline);
1686 while (tok_type_(t, TOK_WHITESPACE))
1687 t = t->next;
1689 j = false;
1690 if (t) {
1691 t = t->next; /* Skip the actual token */
1692 while (tok_type_(t, TOK_WHITESPACE))
1693 t = t->next;
1694 j = !t; /* Should be nothing left */
1696 break;
1698 case PPC_IFEMPTY:
1699 t = tline = expand_smacro(tline);
1700 while (tok_type_(t, TOK_WHITESPACE))
1701 t = t->next;
1703 j = !t; /* Should be empty */
1704 break;
1706 case PPC_IF:
1707 t = tline = expand_smacro(tline);
1708 tptr = &t;
1709 tokval.t_type = TOKEN_INVALID;
1710 evalresult = evaluate(ppscan, tptr, &tokval,
1711 NULL, pass | CRITICAL, error, NULL);
1712 if (!evalresult)
1713 return -1;
1714 if (tokval.t_type)
1715 error(ERR_WARNING|ERR_PASS1,
1716 "trailing garbage after expression ignored");
1717 if (!is_simple(evalresult)) {
1718 error(ERR_NONFATAL,
1719 "non-constant value given to `%s'", pp_directives[ct]);
1720 goto fail;
1722 j = reloc_value(evalresult) != 0;
1723 break;
1725 default:
1726 error(ERR_FATAL,
1727 "preprocessor directive `%s' not yet implemented",
1728 pp_directives[ct]);
1729 goto fail;
1732 free_tlist(origline);
1733 return j ^ PP_NEGATIVE(ct);
1735 fail:
1736 free_tlist(origline);
1737 return -1;
1741 * Common code for defining an smacro
1743 static bool define_smacro(Context *ctx, char *mname, bool casesense,
1744 int nparam, Token *expansion)
1746 SMacro *smac, **smhead;
1747 struct hash_table *smtbl;
1749 if (smacro_defined(ctx, mname, nparam, &smac, casesense)) {
1750 if (!smac) {
1751 error(ERR_WARNING|ERR_PASS1,
1752 "single-line macro `%s' defined both with and"
1753 " without parameters", mname);
1755 /* Some instances of the old code considered this a failure,
1756 some others didn't. What is the right thing to do here? */
1757 free_tlist(expansion);
1758 return false; /* Failure */
1759 } else {
1761 * We're redefining, so we have to take over an
1762 * existing SMacro structure. This means freeing
1763 * what was already in it.
1765 nasm_free(smac->name);
1766 free_tlist(smac->expansion);
1768 } else {
1769 smtbl = ctx ? &ctx->localmac : &smacros;
1770 smhead = (SMacro **) hash_findi_add(smtbl, mname);
1771 smac = nasm_malloc(sizeof(SMacro));
1772 smac->next = *smhead;
1773 *smhead = smac;
1775 smac->name = nasm_strdup(mname);
1776 smac->casesense = casesense;
1777 smac->nparam = nparam;
1778 smac->expansion = expansion;
1779 smac->in_progress = false;
1780 return true; /* Success */
1784 * Undefine an smacro
1786 static void undef_smacro(Context *ctx, const char *mname)
1788 SMacro **smhead, *s, **sp;
1789 struct hash_table *smtbl;
1791 smtbl = ctx ? &ctx->localmac : &smacros;
1792 smhead = (SMacro **)hash_findi(smtbl, mname, NULL);
1794 if (smhead) {
1796 * We now have a macro name... go hunt for it.
1798 sp = smhead;
1799 while ((s = *sp) != NULL) {
1800 if (!mstrcmp(s->name, mname, s->casesense)) {
1801 *sp = s->next;
1802 nasm_free(s->name);
1803 free_tlist(s->expansion);
1804 nasm_free(s);
1805 } else {
1806 sp = &s->next;
1813 * Parse a mmacro specification.
1815 static bool parse_mmacro_spec(Token *tline, MMacro *def, const char *directive)
1817 bool err;
1819 tline = tline->next;
1820 skip_white_(tline);
1821 tline = expand_id(tline);
1822 if (!tok_type_(tline, TOK_ID)) {
1823 error(ERR_NONFATAL, "`%s' expects a macro name", directive);
1824 return false;
1827 def->name = nasm_strdup(tline->text);
1828 def->plus = false;
1829 def->nolist = false;
1830 def->in_progress = 0;
1831 def->rep_nest = NULL;
1832 def->nparam_min = 0;
1833 def->nparam_max = 0;
1835 tline = expand_smacro(tline->next);
1836 skip_white_(tline);
1837 if (!tok_type_(tline, TOK_NUMBER)) {
1838 error(ERR_NONFATAL, "`%s' expects a parameter count", directive);
1839 } else {
1840 def->nparam_min = def->nparam_max =
1841 readnum(tline->text, &err);
1842 if (err)
1843 error(ERR_NONFATAL,
1844 "unable to parse parameter count `%s'", tline->text);
1846 if (tline && tok_is_(tline->next, "-")) {
1847 tline = tline->next->next;
1848 if (tok_is_(tline, "*")) {
1849 def->nparam_max = INT_MAX;
1850 } else if (!tok_type_(tline, TOK_NUMBER)) {
1851 error(ERR_NONFATAL,
1852 "`%s' expects a parameter count after `-'", directive);
1853 } else {
1854 def->nparam_max = readnum(tline->text, &err);
1855 if (err) {
1856 error(ERR_NONFATAL, "unable to parse parameter count `%s'",
1857 tline->text);
1859 if (def->nparam_min > def->nparam_max) {
1860 error(ERR_NONFATAL, "minimum parameter count exceeds maximum");
1864 if (tline && tok_is_(tline->next, "+")) {
1865 tline = tline->next;
1866 def->plus = true;
1868 if (tline && tok_type_(tline->next, TOK_ID) &&
1869 !nasm_stricmp(tline->next->text, ".nolist")) {
1870 tline = tline->next;
1871 def->nolist = true;
1875 * Handle default parameters.
1877 if (tline && tline->next) {
1878 def->dlist = tline->next;
1879 tline->next = NULL;
1880 count_mmac_params(def->dlist, &def->ndefs, &def->defaults);
1881 } else {
1882 def->dlist = NULL;
1883 def->defaults = NULL;
1885 def->expansion = NULL;
1887 if(def->defaults &&
1888 def->ndefs > def->nparam_max - def->nparam_min &&
1889 !def->plus)
1890 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MDP,
1891 "too many default macro parameters");
1893 return true;
1898 * Decode a size directive
1900 static int parse_size(const char *str) {
1901 static const char *size_names[] =
1902 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
1903 static const int sizes[] =
1904 { 0, 1, 4, 16, 8, 10, 2, 32 };
1906 return sizes[bsii(str, size_names, elements(size_names))+1];
1910 * find and process preprocessor directive in passed line
1911 * Find out if a line contains a preprocessor directive, and deal
1912 * with it if so.
1914 * If a directive _is_ found, it is the responsibility of this routine
1915 * (and not the caller) to free_tlist() the line.
1917 * @param tline a pointer to the current tokeninzed line linked list
1918 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
1921 static int do_directive(Token * tline)
1923 enum preproc_token i;
1924 int j;
1925 bool err;
1926 int nparam;
1927 bool nolist;
1928 bool casesense;
1929 int k, m;
1930 int offset;
1931 char *p, *pp, *mname;
1932 Include *inc;
1933 Context *ctx;
1934 Cond *cond;
1935 MMacro *mmac, **mmhead;
1936 Token *t, *tt, *param_start, *macro_start, *last, **tptr, *origline;
1937 Line *l;
1938 struct tokenval tokval;
1939 expr *evalresult;
1940 MMacro *tmp_defining; /* Used when manipulating rep_nest */
1941 int64_t count;
1942 size_t len;
1943 int severity;
1945 origline = tline;
1947 skip_white_(tline);
1948 if (!tline || !tok_type_(tline, TOK_PREPROC_ID) ||
1949 (tline->text[1] == '%' || tline->text[1] == '$'
1950 || tline->text[1] == '!'))
1951 return NO_DIRECTIVE_FOUND;
1953 i = pp_token_hash(tline->text);
1956 * If we're in a non-emitting branch of a condition construct,
1957 * or walking to the end of an already terminated %rep block,
1958 * we should ignore all directives except for condition
1959 * directives.
1961 if (((istk->conds && !emitting(istk->conds->state)) ||
1962 (istk->mstk && !istk->mstk->in_progress)) && !is_condition(i)) {
1963 return NO_DIRECTIVE_FOUND;
1967 * If we're defining a macro or reading a %rep block, we should
1968 * ignore all directives except for %macro/%imacro (which nest),
1969 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
1970 * If we're in a %rep block, another %rep nests, so should be let through.
1972 if (defining && i != PP_MACRO && i != PP_IMACRO &&
1973 i != PP_ENDMACRO && i != PP_ENDM &&
1974 (defining->name || (i != PP_ENDREP && i != PP_REP))) {
1975 return NO_DIRECTIVE_FOUND;
1978 if (defining) {
1979 if (i == PP_MACRO || i == PP_IMACRO) {
1980 nested_mac_count++;
1981 return NO_DIRECTIVE_FOUND;
1982 } else if (nested_mac_count > 0) {
1983 if (i == PP_ENDMACRO) {
1984 nested_mac_count--;
1985 return NO_DIRECTIVE_FOUND;
1988 if (!defining->name) {
1989 if (i == PP_REP) {
1990 nested_rep_count++;
1991 return NO_DIRECTIVE_FOUND;
1992 } else if (nested_rep_count > 0) {
1993 if (i == PP_ENDREP) {
1994 nested_rep_count--;
1995 return NO_DIRECTIVE_FOUND;
2001 switch (i) {
2002 case PP_INVALID:
2003 error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2004 tline->text);
2005 return NO_DIRECTIVE_FOUND; /* didn't get it */
2007 case PP_STACKSIZE:
2008 /* Directive to tell NASM what the default stack size is. The
2009 * default is for a 16-bit stack, and this can be overriden with
2010 * %stacksize large.
2011 * the following form:
2013 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2015 tline = tline->next;
2016 if (tline && tline->type == TOK_WHITESPACE)
2017 tline = tline->next;
2018 if (!tline || tline->type != TOK_ID) {
2019 error(ERR_NONFATAL, "`%%stacksize' missing size parameter");
2020 free_tlist(origline);
2021 return DIRECTIVE_FOUND;
2023 if (nasm_stricmp(tline->text, "flat") == 0) {
2024 /* All subsequent ARG directives are for a 32-bit stack */
2025 StackSize = 4;
2026 StackPointer = "ebp";
2027 ArgOffset = 8;
2028 LocalOffset = 0;
2029 } else if (nasm_stricmp(tline->text, "flat64") == 0) {
2030 /* All subsequent ARG directives are for a 64-bit stack */
2031 StackSize = 8;
2032 StackPointer = "rbp";
2033 ArgOffset = 8;
2034 LocalOffset = 0;
2035 } else if (nasm_stricmp(tline->text, "large") == 0) {
2036 /* All subsequent ARG directives are for a 16-bit stack,
2037 * far function call.
2039 StackSize = 2;
2040 StackPointer = "bp";
2041 ArgOffset = 4;
2042 LocalOffset = 0;
2043 } else if (nasm_stricmp(tline->text, "small") == 0) {
2044 /* All subsequent ARG directives are for a 16-bit stack,
2045 * far function call. We don't support near functions.
2047 StackSize = 2;
2048 StackPointer = "bp";
2049 ArgOffset = 6;
2050 LocalOffset = 0;
2051 } else {
2052 error(ERR_NONFATAL, "`%%stacksize' invalid size type");
2053 free_tlist(origline);
2054 return DIRECTIVE_FOUND;
2056 free_tlist(origline);
2057 return DIRECTIVE_FOUND;
2059 case PP_ARG:
2060 /* TASM like ARG directive to define arguments to functions, in
2061 * the following form:
2063 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2065 offset = ArgOffset;
2066 do {
2067 char *arg, directive[256];
2068 int size = StackSize;
2070 /* Find the argument name */
2071 tline = tline->next;
2072 if (tline && tline->type == TOK_WHITESPACE)
2073 tline = tline->next;
2074 if (!tline || tline->type != TOK_ID) {
2075 error(ERR_NONFATAL, "`%%arg' missing argument parameter");
2076 free_tlist(origline);
2077 return DIRECTIVE_FOUND;
2079 arg = tline->text;
2081 /* Find the argument size type */
2082 tline = tline->next;
2083 if (!tline || tline->type != TOK_OTHER
2084 || tline->text[0] != ':') {
2085 error(ERR_NONFATAL,
2086 "Syntax error processing `%%arg' directive");
2087 free_tlist(origline);
2088 return DIRECTIVE_FOUND;
2090 tline = tline->next;
2091 if (!tline || tline->type != TOK_ID) {
2092 error(ERR_NONFATAL, "`%%arg' missing size type parameter");
2093 free_tlist(origline);
2094 return DIRECTIVE_FOUND;
2097 /* Allow macro expansion of type parameter */
2098 tt = tokenize(tline->text);
2099 tt = expand_smacro(tt);
2100 size = parse_size(tt->text);
2101 if (!size) {
2102 error(ERR_NONFATAL,
2103 "Invalid size type for `%%arg' missing directive");
2104 free_tlist(tt);
2105 free_tlist(origline);
2106 return DIRECTIVE_FOUND;
2108 free_tlist(tt);
2110 /* Round up to even stack slots */
2111 size = (size+StackSize-1) & ~(StackSize-1);
2113 /* Now define the macro for the argument */
2114 snprintf(directive, sizeof(directive), "%%define %s (%s+%d)",
2115 arg, StackPointer, offset);
2116 do_directive(tokenize(directive));
2117 offset += size;
2119 /* Move to the next argument in the list */
2120 tline = tline->next;
2121 if (tline && tline->type == TOK_WHITESPACE)
2122 tline = tline->next;
2123 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2124 ArgOffset = offset;
2125 free_tlist(origline);
2126 return DIRECTIVE_FOUND;
2128 case PP_LOCAL:
2129 /* TASM like LOCAL directive to define local variables for a
2130 * function, in the following form:
2132 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2134 * The '= LocalSize' at the end is ignored by NASM, but is
2135 * required by TASM to define the local parameter size (and used
2136 * by the TASM macro package).
2138 offset = LocalOffset;
2139 do {
2140 char *local, directive[256];
2141 int size = StackSize;
2143 /* Find the argument name */
2144 tline = tline->next;
2145 if (tline && tline->type == TOK_WHITESPACE)
2146 tline = tline->next;
2147 if (!tline || tline->type != TOK_ID) {
2148 error(ERR_NONFATAL,
2149 "`%%local' missing argument parameter");
2150 free_tlist(origline);
2151 return DIRECTIVE_FOUND;
2153 local = tline->text;
2155 /* Find the argument size type */
2156 tline = tline->next;
2157 if (!tline || tline->type != TOK_OTHER
2158 || tline->text[0] != ':') {
2159 error(ERR_NONFATAL,
2160 "Syntax error processing `%%local' directive");
2161 free_tlist(origline);
2162 return DIRECTIVE_FOUND;
2164 tline = tline->next;
2165 if (!tline || tline->type != TOK_ID) {
2166 error(ERR_NONFATAL,
2167 "`%%local' missing size type parameter");
2168 free_tlist(origline);
2169 return DIRECTIVE_FOUND;
2172 /* Allow macro expansion of type parameter */
2173 tt = tokenize(tline->text);
2174 tt = expand_smacro(tt);
2175 size = parse_size(tt->text);
2176 if (!size) {
2177 error(ERR_NONFATAL,
2178 "Invalid size type for `%%local' missing directive");
2179 free_tlist(tt);
2180 free_tlist(origline);
2181 return DIRECTIVE_FOUND;
2183 free_tlist(tt);
2185 /* Round up to even stack slots */
2186 size = (size+StackSize-1) & ~(StackSize-1);
2188 offset += size; /* Negative offset, increment before */
2190 /* Now define the macro for the argument */
2191 snprintf(directive, sizeof(directive), "%%define %s (%s-%d)",
2192 local, StackPointer, offset);
2193 do_directive(tokenize(directive));
2195 /* Now define the assign to setup the enter_c macro correctly */
2196 snprintf(directive, sizeof(directive),
2197 "%%assign %%$localsize %%$localsize+%d", size);
2198 do_directive(tokenize(directive));
2200 /* Move to the next argument in the list */
2201 tline = tline->next;
2202 if (tline && tline->type == TOK_WHITESPACE)
2203 tline = tline->next;
2204 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2205 LocalOffset = offset;
2206 free_tlist(origline);
2207 return DIRECTIVE_FOUND;
2209 case PP_CLEAR:
2210 if (tline->next)
2211 error(ERR_WARNING|ERR_PASS1,
2212 "trailing garbage after `%%clear' ignored");
2213 free_macros();
2214 init_macros();
2215 free_tlist(origline);
2216 return DIRECTIVE_FOUND;
2218 case PP_DEPEND:
2219 t = tline->next = expand_smacro(tline->next);
2220 skip_white_(t);
2221 if (!t || (t->type != TOK_STRING &&
2222 t->type != TOK_INTERNAL_STRING)) {
2223 error(ERR_NONFATAL, "`%%depend' expects a file name");
2224 free_tlist(origline);
2225 return DIRECTIVE_FOUND; /* but we did _something_ */
2227 if (t->next)
2228 error(ERR_WARNING|ERR_PASS1,
2229 "trailing garbage after `%%depend' ignored");
2230 p = t->text;
2231 if (t->type != TOK_INTERNAL_STRING)
2232 nasm_unquote(p, NULL);
2233 if (dephead && !in_list(*dephead, p)) {
2234 StrList *sl = nasm_malloc(strlen(p)+1+sizeof sl->next);
2235 sl->next = NULL;
2236 strcpy(sl->str, p);
2237 *deptail = sl;
2238 deptail = &sl->next;
2240 free_tlist(origline);
2241 return DIRECTIVE_FOUND;
2243 case PP_INCLUDE:
2244 t = tline->next = expand_smacro(tline->next);
2245 skip_white_(t);
2247 if (!t || (t->type != TOK_STRING &&
2248 t->type != TOK_INTERNAL_STRING)) {
2249 error(ERR_NONFATAL, "`%%include' expects a file name");
2250 free_tlist(origline);
2251 return DIRECTIVE_FOUND; /* but we did _something_ */
2253 if (t->next)
2254 error(ERR_WARNING|ERR_PASS1,
2255 "trailing garbage after `%%include' ignored");
2256 p = t->text;
2257 if (t->type != TOK_INTERNAL_STRING)
2258 nasm_unquote(p, NULL);
2259 inc = nasm_malloc(sizeof(Include));
2260 inc->next = istk;
2261 inc->conds = NULL;
2262 inc->fp = inc_fopen(p, dephead, &deptail, pass == 0);
2263 if (!inc->fp) {
2264 /* -MG given but file not found */
2265 nasm_free(inc);
2266 } else {
2267 inc->fname = src_set_fname(nasm_strdup(p));
2268 inc->lineno = src_set_linnum(0);
2269 inc->lineinc = 1;
2270 inc->expansion = NULL;
2271 inc->mstk = NULL;
2272 istk = inc;
2273 list->uplevel(LIST_INCLUDE);
2275 free_tlist(origline);
2276 return DIRECTIVE_FOUND;
2278 case PP_USE:
2280 static macros_t *use_pkg;
2281 const char *pkg_macro;
2283 t = tline->next = expand_smacro(tline->next);
2284 skip_white_(t);
2286 if (!t || (t->type != TOK_STRING &&
2287 t->type != TOK_INTERNAL_STRING &&
2288 t->type != TOK_ID)) {
2289 error(ERR_NONFATAL, "`%%use' expects a package name");
2290 free_tlist(origline);
2291 return DIRECTIVE_FOUND; /* but we did _something_ */
2293 if (t->next)
2294 error(ERR_WARNING|ERR_PASS1,
2295 "trailing garbage after `%%use' ignored");
2296 if (t->type == TOK_STRING)
2297 nasm_unquote(t->text, NULL);
2298 use_pkg = nasm_stdmac_find_package(t->text);
2299 if (!use_pkg)
2300 error(ERR_NONFATAL, "unknown `%%use' package: %s", t->text);
2301 /* The first string will be <%define>__USE_*__ */
2302 pkg_macro = (char *)use_pkg + 1;
2303 if (!smacro_defined(NULL, pkg_macro, 0, NULL, true)) {
2304 /* Not already included, go ahead and include it */
2305 stdmacpos = use_pkg;
2307 free_tlist(origline);
2308 return DIRECTIVE_FOUND;
2310 case PP_PUSH:
2311 tline = tline->next;
2312 skip_white_(tline);
2313 tline = expand_id(tline);
2314 if (tline) {
2315 if (!tok_type_(tline, TOK_ID)) {
2316 error(ERR_NONFATAL, "`%%push' expects a context identifier");
2317 free_tlist(origline);
2318 return DIRECTIVE_FOUND; /* but we did _something_ */
2320 if (tline->next)
2321 error(ERR_WARNING|ERR_PASS1,
2322 "trailing garbage after `%%push' ignored");
2323 p = nasm_strdup(tline->text);
2324 } else {
2325 p = NULL; /* Anonymous context */
2327 ctx = nasm_malloc(sizeof(Context));
2328 ctx->next = cstk;
2329 hash_init(&ctx->localmac, HASH_SMALL);
2330 ctx->name = p;
2331 ctx->number = unique++;
2332 cstk = ctx;
2333 free_tlist(origline);
2334 return DIRECTIVE_FOUND;
2336 case PP_REPL:
2337 tline = tline->next;
2338 skip_white_(tline);
2339 tline = expand_id(tline);
2340 if (tline) {
2341 if (!tok_type_(tline, TOK_ID)) {
2342 error(ERR_NONFATAL, "`%%repl' expects a context identifier");
2343 free_tlist(origline);
2344 return DIRECTIVE_FOUND; /* but we did _something_ */
2346 if (tline->next)
2347 error(ERR_WARNING|ERR_PASS1,
2348 "trailing garbage after `%%repl' ignored");
2349 p = nasm_strdup(tline->text);
2350 } else {
2351 p = NULL;
2353 if (!cstk)
2354 error(ERR_NONFATAL, "`%%repl': context stack is empty");
2355 else {
2356 nasm_free(cstk->name);
2357 cstk->name = p;
2359 free_tlist(origline);
2360 return DIRECTIVE_FOUND;
2362 case PP_POP:
2363 if (tline->next)
2364 error(ERR_WARNING|ERR_PASS1,
2365 "trailing garbage after `%%pop' ignored");
2366 if (!cstk)
2367 error(ERR_NONFATAL, "`%%pop': context stack is already empty");
2368 else
2369 ctx_pop();
2370 free_tlist(origline);
2371 return DIRECTIVE_FOUND;
2373 case PP_FATAL:
2374 severity = ERR_FATAL|ERR_NO_SEVERITY;
2375 goto issue_error;
2376 case PP_ERROR:
2377 severity = ERR_NONFATAL|ERR_NO_SEVERITY;
2378 goto issue_error;
2379 case PP_WARNING:
2380 severity = ERR_WARNING|ERR_NO_SEVERITY|ERR_WARN_USER;
2381 goto issue_error;
2383 issue_error:
2385 /* Only error out if this is the final pass */
2386 if (pass != 2 && i != PP_FATAL)
2387 return DIRECTIVE_FOUND;
2389 tline->next = expand_smacro(tline->next);
2390 tline = tline->next;
2391 skip_white_(tline);
2392 t = tline ? tline->next : NULL;
2393 skip_white_(t);
2394 if (tok_type_(tline, TOK_STRING) && !t) {
2395 /* The line contains only a quoted string */
2396 p = tline->text;
2397 nasm_unquote(p, NULL);
2398 error(severity, "%s: %s", pp_directives[i], p);
2399 } else {
2400 /* Not a quoted string, or more than a quoted string */
2401 p = detoken(tline, false);
2402 error(severity, "%s: %s", pp_directives[i], p);
2403 nasm_free(p);
2405 free_tlist(origline);
2406 return DIRECTIVE_FOUND;
2409 CASE_PP_IF:
2410 if (istk->conds && !emitting(istk->conds->state))
2411 j = COND_NEVER;
2412 else {
2413 j = if_condition(tline->next, i);
2414 tline->next = NULL; /* it got freed */
2415 j = j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2417 cond = nasm_malloc(sizeof(Cond));
2418 cond->next = istk->conds;
2419 cond->state = j;
2420 istk->conds = cond;
2421 free_tlist(origline);
2422 return DIRECTIVE_FOUND;
2424 CASE_PP_ELIF:
2425 if (!istk->conds)
2426 error(ERR_FATAL, "`%s': no matching `%%if'", pp_directives[i]);
2427 switch(istk->conds->state) {
2428 case COND_IF_TRUE:
2429 istk->conds->state = COND_DONE;
2430 break;
2432 case COND_DONE:
2433 case COND_NEVER:
2434 break;
2436 case COND_ELSE_TRUE:
2437 case COND_ELSE_FALSE:
2438 error_precond(ERR_WARNING|ERR_PASS1,
2439 "`%%elif' after `%%else' ignored");
2440 istk->conds->state = COND_NEVER;
2441 break;
2443 case COND_IF_FALSE:
2445 * IMPORTANT: In the case of %if, we will already have
2446 * called expand_mmac_params(); however, if we're
2447 * processing an %elif we must have been in a
2448 * non-emitting mode, which would have inhibited
2449 * the normal invocation of expand_mmac_params(). Therefore,
2450 * we have to do it explicitly here.
2452 j = if_condition(expand_mmac_params(tline->next), i);
2453 tline->next = NULL; /* it got freed */
2454 istk->conds->state =
2455 j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2456 break;
2458 free_tlist(origline);
2459 return DIRECTIVE_FOUND;
2461 case PP_ELSE:
2462 if (tline->next)
2463 error_precond(ERR_WARNING|ERR_PASS1,
2464 "trailing garbage after `%%else' ignored");
2465 if (!istk->conds)
2466 error(ERR_FATAL, "`%%else': no matching `%%if'");
2467 switch(istk->conds->state) {
2468 case COND_IF_TRUE:
2469 case COND_DONE:
2470 istk->conds->state = COND_ELSE_FALSE;
2471 break;
2473 case COND_NEVER:
2474 break;
2476 case COND_IF_FALSE:
2477 istk->conds->state = COND_ELSE_TRUE;
2478 break;
2480 case COND_ELSE_TRUE:
2481 case COND_ELSE_FALSE:
2482 error_precond(ERR_WARNING|ERR_PASS1,
2483 "`%%else' after `%%else' ignored.");
2484 istk->conds->state = COND_NEVER;
2485 break;
2487 free_tlist(origline);
2488 return DIRECTIVE_FOUND;
2490 case PP_ENDIF:
2491 if (tline->next)
2492 error_precond(ERR_WARNING|ERR_PASS1,
2493 "trailing garbage after `%%endif' ignored");
2494 if (!istk->conds)
2495 error(ERR_FATAL, "`%%endif': no matching `%%if'");
2496 cond = istk->conds;
2497 istk->conds = cond->next;
2498 nasm_free(cond);
2499 free_tlist(origline);
2500 return DIRECTIVE_FOUND;
2502 case PP_MACRO:
2503 case PP_IMACRO:
2504 if (defining) {
2505 error(ERR_FATAL,
2506 "`%%%smacro': already defining a macro",
2507 (i == PP_IMACRO ? "i" : ""));
2508 return DIRECTIVE_FOUND;
2510 defining = nasm_malloc(sizeof(MMacro));
2511 defining->casesense = (i == PP_MACRO);
2512 if (!parse_mmacro_spec(tline, defining, pp_directives[i])) {
2513 nasm_free(defining);
2514 defining = NULL;
2515 return DIRECTIVE_FOUND;
2518 mmac = (MMacro *) hash_findix(&mmacros, defining->name);
2519 while (mmac) {
2520 if (!strcmp(mmac->name, defining->name) &&
2521 (mmac->nparam_min <= defining->nparam_max
2522 || defining->plus)
2523 && (defining->nparam_min <= mmac->nparam_max
2524 || mmac->plus)) {
2525 error(ERR_WARNING|ERR_PASS1,
2526 "redefining multi-line macro `%s'", defining->name);
2527 return DIRECTIVE_FOUND;
2529 mmac = mmac->next;
2531 free_tlist(origline);
2532 return DIRECTIVE_FOUND;
2534 case PP_ENDM:
2535 case PP_ENDMACRO:
2536 if (! (defining && defining->name)) {
2537 error(ERR_NONFATAL, "`%s': not defining a macro", tline->text);
2538 return DIRECTIVE_FOUND;
2540 mmhead = (MMacro **) hash_findi_add(&mmacros, defining->name);
2541 defining->next = *mmhead;
2542 *mmhead = defining;
2543 defining = NULL;
2544 free_tlist(origline);
2545 return DIRECTIVE_FOUND;
2547 case PP_UNMACRO:
2548 case PP_UNIMACRO:
2550 MMacro **mmac_p;
2551 MMacro spec;
2553 spec.casesense = (i == PP_UNMACRO);
2554 if (!parse_mmacro_spec(tline, &spec, pp_directives[i])) {
2555 return DIRECTIVE_FOUND;
2557 mmac_p = (MMacro **) hash_findi(&mmacros, spec.name, NULL);
2558 while (mmac_p && *mmac_p) {
2559 mmac = *mmac_p;
2560 if (mmac->casesense == spec.casesense &&
2561 !mstrcmp(mmac->name, spec.name, spec.casesense) &&
2562 mmac->nparam_min == spec.nparam_min &&
2563 mmac->nparam_max == spec.nparam_max &&
2564 mmac->plus == spec.plus) {
2565 *mmac_p = mmac->next;
2566 free_mmacro(mmac);
2567 } else {
2568 mmac_p = &mmac->next;
2571 free_tlist(origline);
2572 free_tlist(spec.dlist);
2573 return DIRECTIVE_FOUND;
2576 case PP_ROTATE:
2577 if (tline->next && tline->next->type == TOK_WHITESPACE)
2578 tline = tline->next;
2579 if (tline->next == NULL) {
2580 free_tlist(origline);
2581 error(ERR_NONFATAL, "`%%rotate' missing rotate count");
2582 return DIRECTIVE_FOUND;
2584 t = expand_smacro(tline->next);
2585 tline->next = NULL;
2586 free_tlist(origline);
2587 tline = t;
2588 tptr = &t;
2589 tokval.t_type = TOKEN_INVALID;
2590 evalresult =
2591 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2592 free_tlist(tline);
2593 if (!evalresult)
2594 return DIRECTIVE_FOUND;
2595 if (tokval.t_type)
2596 error(ERR_WARNING|ERR_PASS1,
2597 "trailing garbage after expression ignored");
2598 if (!is_simple(evalresult)) {
2599 error(ERR_NONFATAL, "non-constant value given to `%%rotate'");
2600 return DIRECTIVE_FOUND;
2602 mmac = istk->mstk;
2603 while (mmac && !mmac->name) /* avoid mistaking %reps for macros */
2604 mmac = mmac->next_active;
2605 if (!mmac) {
2606 error(ERR_NONFATAL, "`%%rotate' invoked outside a macro call");
2607 } else if (mmac->nparam == 0) {
2608 error(ERR_NONFATAL,
2609 "`%%rotate' invoked within macro without parameters");
2610 } else {
2611 int rotate = mmac->rotate + reloc_value(evalresult);
2613 rotate %= (int)mmac->nparam;
2614 if (rotate < 0)
2615 rotate += mmac->nparam;
2617 mmac->rotate = rotate;
2619 return DIRECTIVE_FOUND;
2621 case PP_REP:
2622 nolist = false;
2623 do {
2624 tline = tline->next;
2625 } while (tok_type_(tline, TOK_WHITESPACE));
2627 if (tok_type_(tline, TOK_ID) &&
2628 nasm_stricmp(tline->text, ".nolist") == 0) {
2629 nolist = true;
2630 do {
2631 tline = tline->next;
2632 } while (tok_type_(tline, TOK_WHITESPACE));
2635 if (tline) {
2636 t = expand_smacro(tline);
2637 tptr = &t;
2638 tokval.t_type = TOKEN_INVALID;
2639 evalresult =
2640 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2641 if (!evalresult) {
2642 free_tlist(origline);
2643 return DIRECTIVE_FOUND;
2645 if (tokval.t_type)
2646 error(ERR_WARNING|ERR_PASS1,
2647 "trailing garbage after expression ignored");
2648 if (!is_simple(evalresult)) {
2649 error(ERR_NONFATAL, "non-constant value given to `%%rep'");
2650 return DIRECTIVE_FOUND;
2652 count = reloc_value(evalresult) + 1;
2653 } else {
2654 error(ERR_NONFATAL, "`%%rep' expects a repeat count");
2655 count = 0;
2657 free_tlist(origline);
2659 tmp_defining = defining;
2660 defining = nasm_malloc(sizeof(MMacro));
2661 defining->name = NULL; /* flags this macro as a %rep block */
2662 defining->casesense = false;
2663 defining->plus = false;
2664 defining->nolist = nolist;
2665 defining->in_progress = count;
2666 defining->nparam_min = defining->nparam_max = 0;
2667 defining->defaults = NULL;
2668 defining->dlist = NULL;
2669 defining->expansion = NULL;
2670 defining->next_active = istk->mstk;
2671 defining->rep_nest = tmp_defining;
2672 return DIRECTIVE_FOUND;
2674 case PP_ENDREP:
2675 if (!defining || defining->name) {
2676 error(ERR_NONFATAL, "`%%endrep': no matching `%%rep'");
2677 return DIRECTIVE_FOUND;
2681 * Now we have a "macro" defined - although it has no name
2682 * and we won't be entering it in the hash tables - we must
2683 * push a macro-end marker for it on to istk->expansion.
2684 * After that, it will take care of propagating itself (a
2685 * macro-end marker line for a macro which is really a %rep
2686 * block will cause the macro to be re-expanded, complete
2687 * with another macro-end marker to ensure the process
2688 * continues) until the whole expansion is forcibly removed
2689 * from istk->expansion by a %exitrep.
2691 l = nasm_malloc(sizeof(Line));
2692 l->next = istk->expansion;
2693 l->finishes = defining;
2694 l->first = NULL;
2695 istk->expansion = l;
2697 istk->mstk = defining;
2699 list->uplevel(defining->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
2700 tmp_defining = defining;
2701 defining = defining->rep_nest;
2702 free_tlist(origline);
2703 return DIRECTIVE_FOUND;
2705 case PP_EXITREP:
2707 * We must search along istk->expansion until we hit a
2708 * macro-end marker for a macro with no name. Then we set
2709 * its `in_progress' flag to 0.
2711 for (l = istk->expansion; l; l = l->next)
2712 if (l->finishes && !l->finishes->name)
2713 break;
2715 if (l)
2716 l->finishes->in_progress = 1;
2717 else
2718 error(ERR_NONFATAL, "`%%exitrep' not within `%%rep' block");
2719 free_tlist(origline);
2720 return DIRECTIVE_FOUND;
2722 case PP_XDEFINE:
2723 case PP_IXDEFINE:
2724 case PP_DEFINE:
2725 case PP_IDEFINE:
2726 casesense = (i == PP_DEFINE || i == PP_XDEFINE);
2728 tline = tline->next;
2729 skip_white_(tline);
2730 tline = expand_id(tline);
2731 if (!tline || (tline->type != TOK_ID &&
2732 (tline->type != TOK_PREPROC_ID ||
2733 tline->text[1] != '$'))) {
2734 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2735 pp_directives[i]);
2736 free_tlist(origline);
2737 return DIRECTIVE_FOUND;
2740 ctx = get_ctx(tline->text, false);
2742 mname = tline->text;
2743 last = tline;
2744 param_start = tline = tline->next;
2745 nparam = 0;
2747 /* Expand the macro definition now for %xdefine and %ixdefine */
2748 if ((i == PP_XDEFINE) || (i == PP_IXDEFINE))
2749 tline = expand_smacro(tline);
2751 if (tok_is_(tline, "(")) {
2753 * This macro has parameters.
2756 tline = tline->next;
2757 while (1) {
2758 skip_white_(tline);
2759 if (!tline) {
2760 error(ERR_NONFATAL, "parameter identifier expected");
2761 free_tlist(origline);
2762 return DIRECTIVE_FOUND;
2764 if (tline->type != TOK_ID) {
2765 error(ERR_NONFATAL,
2766 "`%s': parameter identifier expected",
2767 tline->text);
2768 free_tlist(origline);
2769 return DIRECTIVE_FOUND;
2771 tline->type = TOK_SMAC_PARAM + nparam++;
2772 tline = tline->next;
2773 skip_white_(tline);
2774 if (tok_is_(tline, ",")) {
2775 tline = tline->next;
2776 } else {
2777 if (!tok_is_(tline, ")")) {
2778 error(ERR_NONFATAL,
2779 "`)' expected to terminate macro template");
2780 free_tlist(origline);
2781 return DIRECTIVE_FOUND;
2783 break;
2786 last = tline;
2787 tline = tline->next;
2789 if (tok_type_(tline, TOK_WHITESPACE))
2790 last = tline, tline = tline->next;
2791 macro_start = NULL;
2792 last->next = NULL;
2793 t = tline;
2794 while (t) {
2795 if (t->type == TOK_ID) {
2796 for (tt = param_start; tt; tt = tt->next)
2797 if (tt->type >= TOK_SMAC_PARAM &&
2798 !strcmp(tt->text, t->text))
2799 t->type = tt->type;
2801 tt = t->next;
2802 t->next = macro_start;
2803 macro_start = t;
2804 t = tt;
2807 * Good. We now have a macro name, a parameter count, and a
2808 * token list (in reverse order) for an expansion. We ought
2809 * to be OK just to create an SMacro, store it, and let
2810 * free_tlist have the rest of the line (which we have
2811 * carefully re-terminated after chopping off the expansion
2812 * from the end).
2814 define_smacro(ctx, mname, casesense, nparam, macro_start);
2815 free_tlist(origline);
2816 return DIRECTIVE_FOUND;
2818 case PP_UNDEF:
2819 tline = tline->next;
2820 skip_white_(tline);
2821 tline = expand_id(tline);
2822 if (!tline || (tline->type != TOK_ID &&
2823 (tline->type != TOK_PREPROC_ID ||
2824 tline->text[1] != '$'))) {
2825 error(ERR_NONFATAL, "`%%undef' expects a macro identifier");
2826 free_tlist(origline);
2827 return DIRECTIVE_FOUND;
2829 if (tline->next) {
2830 error(ERR_WARNING|ERR_PASS1,
2831 "trailing garbage after macro name ignored");
2834 /* Find the context that symbol belongs to */
2835 ctx = get_ctx(tline->text, false);
2836 undef_smacro(ctx, tline->text);
2837 free_tlist(origline);
2838 return DIRECTIVE_FOUND;
2840 case PP_DEFSTR:
2841 case PP_IDEFSTR:
2842 casesense = (i == PP_DEFSTR);
2844 tline = tline->next;
2845 skip_white_(tline);
2846 tline = expand_id(tline);
2847 if (!tline || (tline->type != TOK_ID &&
2848 (tline->type != TOK_PREPROC_ID ||
2849 tline->text[1] != '$'))) {
2850 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2851 pp_directives[i]);
2852 free_tlist(origline);
2853 return DIRECTIVE_FOUND;
2856 ctx = get_ctx(tline->text, false);
2858 mname = tline->text;
2859 last = tline;
2860 tline = expand_smacro(tline->next);
2861 last->next = NULL;
2863 while (tok_type_(tline, TOK_WHITESPACE))
2864 tline = delete_Token(tline);
2866 p = detoken(tline, false);
2867 macro_start = nasm_malloc(sizeof(*macro_start));
2868 macro_start->next = NULL;
2869 macro_start->text = nasm_quote(p, strlen(p));
2870 macro_start->type = TOK_STRING;
2871 macro_start->a.mac = NULL;
2872 nasm_free(p);
2875 * We now have a macro name, an implicit parameter count of
2876 * zero, and a string token to use as an expansion. Create
2877 * and store an SMacro.
2879 define_smacro(ctx, mname, casesense, 0, macro_start);
2880 free_tlist(origline);
2881 return DIRECTIVE_FOUND;
2883 case PP_PATHSEARCH:
2885 FILE *fp;
2886 StrList *xsl = NULL;
2887 StrList **xst = &xsl;
2889 casesense = true;
2891 tline = tline->next;
2892 skip_white_(tline);
2893 tline = expand_id(tline);
2894 if (!tline || (tline->type != TOK_ID &&
2895 (tline->type != TOK_PREPROC_ID ||
2896 tline->text[1] != '$'))) {
2897 error(ERR_NONFATAL,
2898 "`%%pathsearch' expects a macro identifier as first parameter");
2899 free_tlist(origline);
2900 return DIRECTIVE_FOUND;
2902 ctx = get_ctx(tline->text, false);
2904 mname = tline->text;
2905 last = tline;
2906 tline = expand_smacro(tline->next);
2907 last->next = NULL;
2909 t = tline;
2910 while (tok_type_(t, TOK_WHITESPACE))
2911 t = t->next;
2913 if (!t || (t->type != TOK_STRING &&
2914 t->type != TOK_INTERNAL_STRING)) {
2915 error(ERR_NONFATAL, "`%%pathsearch' expects a file name");
2916 free_tlist(tline);
2917 free_tlist(origline);
2918 return DIRECTIVE_FOUND; /* but we did _something_ */
2920 if (t->next)
2921 error(ERR_WARNING|ERR_PASS1,
2922 "trailing garbage after `%%pathsearch' ignored");
2923 p = t->text;
2924 if (t->type != TOK_INTERNAL_STRING)
2925 nasm_unquote(p, NULL);
2927 fp = inc_fopen(p, &xsl, &xst, true);
2928 if (fp) {
2929 p = xsl->str;
2930 fclose(fp); /* Don't actually care about the file */
2932 macro_start = nasm_malloc(sizeof(*macro_start));
2933 macro_start->next = NULL;
2934 macro_start->text = nasm_quote(p, strlen(p));
2935 macro_start->type = TOK_STRING;
2936 macro_start->a.mac = NULL;
2937 if (xsl)
2938 nasm_free(xsl);
2941 * We now have a macro name, an implicit parameter count of
2942 * zero, and a string token to use as an expansion. Create
2943 * and store an SMacro.
2945 define_smacro(ctx, mname, casesense, 0, macro_start);
2946 free_tlist(tline);
2947 free_tlist(origline);
2948 return DIRECTIVE_FOUND;
2951 case PP_STRLEN:
2952 casesense = true;
2954 tline = tline->next;
2955 skip_white_(tline);
2956 tline = expand_id(tline);
2957 if (!tline || (tline->type != TOK_ID &&
2958 (tline->type != TOK_PREPROC_ID ||
2959 tline->text[1] != '$'))) {
2960 error(ERR_NONFATAL,
2961 "`%%strlen' expects a macro identifier as first parameter");
2962 free_tlist(origline);
2963 return DIRECTIVE_FOUND;
2965 ctx = get_ctx(tline->text, false);
2967 mname = tline->text;
2968 last = tline;
2969 tline = expand_smacro(tline->next);
2970 last->next = NULL;
2972 t = tline;
2973 while (tok_type_(t, TOK_WHITESPACE))
2974 t = t->next;
2975 /* t should now point to the string */
2976 if (t->type != TOK_STRING) {
2977 error(ERR_NONFATAL,
2978 "`%%strlen` requires string as second parameter");
2979 free_tlist(tline);
2980 free_tlist(origline);
2981 return DIRECTIVE_FOUND;
2984 macro_start = nasm_malloc(sizeof(*macro_start));
2985 macro_start->next = NULL;
2986 make_tok_num(macro_start, nasm_unquote(t->text, NULL));
2987 macro_start->a.mac = NULL;
2990 * We now have a macro name, an implicit parameter count of
2991 * zero, and a numeric token to use as an expansion. Create
2992 * and store an SMacro.
2994 define_smacro(ctx, mname, casesense, 0, macro_start);
2995 free_tlist(tline);
2996 free_tlist(origline);
2997 return DIRECTIVE_FOUND;
2999 case PP_STRCAT:
3000 casesense = true;
3002 tline = tline->next;
3003 skip_white_(tline);
3004 tline = expand_id(tline);
3005 if (!tline || (tline->type != TOK_ID &&
3006 (tline->type != TOK_PREPROC_ID ||
3007 tline->text[1] != '$'))) {
3008 error(ERR_NONFATAL,
3009 "`%%strcat' expects a macro identifier as first parameter");
3010 free_tlist(origline);
3011 return DIRECTIVE_FOUND;
3013 ctx = get_ctx(tline->text, false);
3015 mname = tline->text;
3016 last = tline;
3017 tline = expand_smacro(tline->next);
3018 last->next = NULL;
3020 len = 0;
3021 for (t = tline; t; t = t->next) {
3022 switch (t->type) {
3023 case TOK_WHITESPACE:
3024 break;
3025 case TOK_STRING:
3026 len += t->a.len = nasm_unquote(t->text, NULL);
3027 break;
3028 case TOK_OTHER:
3029 if (!strcmp(t->text, ",")) /* permit comma separators */
3030 break;
3031 /* else fall through */
3032 default:
3033 error(ERR_NONFATAL,
3034 "non-string passed to `%%strcat' (%d)", t->type);
3035 free_tlist(tline);
3036 free_tlist(origline);
3037 return DIRECTIVE_FOUND;
3041 p = pp = nasm_malloc(len);
3042 t = tline;
3043 for (t = tline; t; t = t->next) {
3044 if (t->type == TOK_STRING) {
3045 memcpy(p, t->text, t->a.len);
3046 p += t->a.len;
3051 * We now have a macro name, an implicit parameter count of
3052 * zero, and a numeric token to use as an expansion. Create
3053 * and store an SMacro.
3055 macro_start = new_Token(NULL, TOK_STRING, NULL, 0);
3056 macro_start->text = nasm_quote(pp, len);
3057 nasm_free(pp);
3058 define_smacro(ctx, mname, casesense, 0, macro_start);
3059 free_tlist(tline);
3060 free_tlist(origline);
3061 return DIRECTIVE_FOUND;
3063 case PP_SUBSTR:
3065 int64_t a1, a2;
3066 size_t len;
3068 casesense = true;
3070 tline = tline->next;
3071 skip_white_(tline);
3072 tline = expand_id(tline);
3073 if (!tline || (tline->type != TOK_ID &&
3074 (tline->type != TOK_PREPROC_ID ||
3075 tline->text[1] != '$'))) {
3076 error(ERR_NONFATAL,
3077 "`%%substr' expects a macro identifier as first parameter");
3078 free_tlist(origline);
3079 return DIRECTIVE_FOUND;
3081 ctx = get_ctx(tline->text, false);
3083 mname = tline->text;
3084 last = tline;
3085 tline = expand_smacro(tline->next);
3086 last->next = NULL;
3088 t = tline->next;
3089 while (tok_type_(t, TOK_WHITESPACE))
3090 t = t->next;
3092 /* t should now point to the string */
3093 if (t->type != TOK_STRING) {
3094 error(ERR_NONFATAL,
3095 "`%%substr` requires string as second parameter");
3096 free_tlist(tline);
3097 free_tlist(origline);
3098 return DIRECTIVE_FOUND;
3101 tt = t->next;
3102 tptr = &tt;
3103 tokval.t_type = TOKEN_INVALID;
3104 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3105 pass, error, NULL);
3106 if (!evalresult) {
3107 free_tlist(tline);
3108 free_tlist(origline);
3109 return DIRECTIVE_FOUND;
3110 } else if (!is_simple(evalresult)) {
3111 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3112 free_tlist(tline);
3113 free_tlist(origline);
3114 return DIRECTIVE_FOUND;
3116 a1 = evalresult->value-1;
3118 while (tok_type_(tt, TOK_WHITESPACE))
3119 tt = tt->next;
3120 if (!tt) {
3121 a2 = 1; /* Backwards compatibility: one character */
3122 } else {
3123 tokval.t_type = TOKEN_INVALID;
3124 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3125 pass, error, NULL);
3126 if (!evalresult) {
3127 free_tlist(tline);
3128 free_tlist(origline);
3129 return DIRECTIVE_FOUND;
3130 } else if (!is_simple(evalresult)) {
3131 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3132 free_tlist(tline);
3133 free_tlist(origline);
3134 return DIRECTIVE_FOUND;
3136 a2 = evalresult->value;
3139 len = nasm_unquote(t->text, NULL);
3140 if (a2 < 0)
3141 a2 = a2+1+len-a1;
3142 if (a1+a2 > (int64_t)len)
3143 a2 = len-a1;
3145 macro_start = nasm_malloc(sizeof(*macro_start));
3146 macro_start->next = NULL;
3147 macro_start->text = nasm_quote((a1 < 0) ? "" : t->text+a1, a2);
3148 macro_start->type = TOK_STRING;
3149 macro_start->a.mac = NULL;
3152 * We now have a macro name, an implicit parameter count of
3153 * zero, and a numeric token to use as an expansion. Create
3154 * and store an SMacro.
3156 define_smacro(ctx, mname, casesense, 0, macro_start);
3157 free_tlist(tline);
3158 free_tlist(origline);
3159 return DIRECTIVE_FOUND;
3162 case PP_ASSIGN:
3163 case PP_IASSIGN:
3164 casesense = (i == PP_ASSIGN);
3166 tline = tline->next;
3167 skip_white_(tline);
3168 tline = expand_id(tline);
3169 if (!tline || (tline->type != TOK_ID &&
3170 (tline->type != TOK_PREPROC_ID ||
3171 tline->text[1] != '$'))) {
3172 error(ERR_NONFATAL,
3173 "`%%%sassign' expects a macro identifier",
3174 (i == PP_IASSIGN ? "i" : ""));
3175 free_tlist(origline);
3176 return DIRECTIVE_FOUND;
3178 ctx = get_ctx(tline->text, false);
3180 mname = tline->text;
3181 last = tline;
3182 tline = expand_smacro(tline->next);
3183 last->next = NULL;
3185 t = tline;
3186 tptr = &t;
3187 tokval.t_type = TOKEN_INVALID;
3188 evalresult =
3189 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
3190 free_tlist(tline);
3191 if (!evalresult) {
3192 free_tlist(origline);
3193 return DIRECTIVE_FOUND;
3196 if (tokval.t_type)
3197 error(ERR_WARNING|ERR_PASS1,
3198 "trailing garbage after expression ignored");
3200 if (!is_simple(evalresult)) {
3201 error(ERR_NONFATAL,
3202 "non-constant value given to `%%%sassign'",
3203 (i == PP_IASSIGN ? "i" : ""));
3204 free_tlist(origline);
3205 return DIRECTIVE_FOUND;
3208 macro_start = nasm_malloc(sizeof(*macro_start));
3209 macro_start->next = NULL;
3210 make_tok_num(macro_start, reloc_value(evalresult));
3211 macro_start->a.mac = NULL;
3214 * We now have a macro name, an implicit parameter count of
3215 * zero, and a numeric token to use as an expansion. Create
3216 * and store an SMacro.
3218 define_smacro(ctx, mname, casesense, 0, macro_start);
3219 free_tlist(origline);
3220 return DIRECTIVE_FOUND;
3222 case PP_LINE:
3224 * Syntax is `%line nnn[+mmm] [filename]'
3226 tline = tline->next;
3227 skip_white_(tline);
3228 if (!tok_type_(tline, TOK_NUMBER)) {
3229 error(ERR_NONFATAL, "`%%line' expects line number");
3230 free_tlist(origline);
3231 return DIRECTIVE_FOUND;
3233 k = readnum(tline->text, &err);
3234 m = 1;
3235 tline = tline->next;
3236 if (tok_is_(tline, "+")) {
3237 tline = tline->next;
3238 if (!tok_type_(tline, TOK_NUMBER)) {
3239 error(ERR_NONFATAL, "`%%line' expects line increment");
3240 free_tlist(origline);
3241 return DIRECTIVE_FOUND;
3243 m = readnum(tline->text, &err);
3244 tline = tline->next;
3246 skip_white_(tline);
3247 src_set_linnum(k);
3248 istk->lineinc = m;
3249 if (tline) {
3250 nasm_free(src_set_fname(detoken(tline, false)));
3252 free_tlist(origline);
3253 return DIRECTIVE_FOUND;
3255 default:
3256 error(ERR_FATAL,
3257 "preprocessor directive `%s' not yet implemented",
3258 pp_directives[i]);
3259 return DIRECTIVE_FOUND;
3264 * Ensure that a macro parameter contains a condition code and
3265 * nothing else. Return the condition code index if so, or -1
3266 * otherwise.
3268 static int find_cc(Token * t)
3270 Token *tt;
3271 int i, j, k, m;
3273 if (!t)
3274 return -1; /* Probably a %+ without a space */
3276 skip_white_(t);
3277 if (t->type != TOK_ID)
3278 return -1;
3279 tt = t->next;
3280 skip_white_(tt);
3281 if (tt && (tt->type != TOK_OTHER || strcmp(tt->text, ",")))
3282 return -1;
3284 i = -1;
3285 j = elements(conditions);
3286 while (j - i > 1) {
3287 k = (j + i) / 2;
3288 m = nasm_stricmp(t->text, conditions[k]);
3289 if (m == 0) {
3290 i = k;
3291 j = -2;
3292 break;
3293 } else if (m < 0) {
3294 j = k;
3295 } else
3296 i = k;
3298 if (j != -2)
3299 return -1;
3300 return i;
3304 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3305 * %-n) and MMacro-local identifiers (%%foo).
3307 static Token *expand_mmac_params(Token * tline)
3309 Token *t, *tt, **tail, *thead;
3311 tail = &thead;
3312 thead = NULL;
3314 while (tline) {
3315 if (tline->type == TOK_PREPROC_ID &&
3316 (((tline->text[1] == '+' || tline->text[1] == '-')
3317 && tline->text[2]) || tline->text[1] == '%'
3318 || (tline->text[1] >= '0' && tline->text[1] <= '9'))) {
3319 char *text = NULL;
3320 int type = 0, cc; /* type = 0 to placate optimisers */
3321 char tmpbuf[30];
3322 unsigned int n;
3323 int i;
3324 MMacro *mac;
3326 t = tline;
3327 tline = tline->next;
3329 mac = istk->mstk;
3330 while (mac && !mac->name) /* avoid mistaking %reps for macros */
3331 mac = mac->next_active;
3332 if (!mac)
3333 error(ERR_NONFATAL, "`%s': not in a macro call", t->text);
3334 else
3335 switch (t->text[1]) {
3337 * We have to make a substitution of one of the
3338 * forms %1, %-1, %+1, %%foo, %0.
3340 case '0':
3341 type = TOK_NUMBER;
3342 snprintf(tmpbuf, sizeof(tmpbuf), "%d", mac->nparam);
3343 text = nasm_strdup(tmpbuf);
3344 break;
3345 case '%':
3346 type = TOK_ID;
3347 snprintf(tmpbuf, sizeof(tmpbuf), "..@%"PRIu64".",
3348 mac->unique);
3349 text = nasm_strcat(tmpbuf, t->text + 2);
3350 break;
3351 case '-':
3352 n = atoi(t->text + 2) - 1;
3353 if (n >= mac->nparam)
3354 tt = NULL;
3355 else {
3356 if (mac->nparam > 1)
3357 n = (n + mac->rotate) % mac->nparam;
3358 tt = mac->params[n];
3360 cc = find_cc(tt);
3361 if (cc == -1) {
3362 error(ERR_NONFATAL,
3363 "macro parameter %d is not a condition code",
3364 n + 1);
3365 text = NULL;
3366 } else {
3367 type = TOK_ID;
3368 if (inverse_ccs[cc] == -1) {
3369 error(ERR_NONFATAL,
3370 "condition code `%s' is not invertible",
3371 conditions[cc]);
3372 text = NULL;
3373 } else
3374 text =
3375 nasm_strdup(conditions[inverse_ccs[cc]]);
3377 break;
3378 case '+':
3379 n = atoi(t->text + 2) - 1;
3380 if (n >= mac->nparam)
3381 tt = NULL;
3382 else {
3383 if (mac->nparam > 1)
3384 n = (n + mac->rotate) % mac->nparam;
3385 tt = mac->params[n];
3387 cc = find_cc(tt);
3388 if (cc == -1) {
3389 error(ERR_NONFATAL,
3390 "macro parameter %d is not a condition code",
3391 n + 1);
3392 text = NULL;
3393 } else {
3394 type = TOK_ID;
3395 text = nasm_strdup(conditions[cc]);
3397 break;
3398 default:
3399 n = atoi(t->text + 1) - 1;
3400 if (n >= mac->nparam)
3401 tt = NULL;
3402 else {
3403 if (mac->nparam > 1)
3404 n = (n + mac->rotate) % mac->nparam;
3405 tt = mac->params[n];
3407 if (tt) {
3408 for (i = 0; i < mac->paramlen[n]; i++) {
3409 *tail = new_Token(NULL, tt->type, tt->text, 0);
3410 tail = &(*tail)->next;
3411 tt = tt->next;
3414 text = NULL; /* we've done it here */
3415 break;
3417 if (!text) {
3418 delete_Token(t);
3419 } else {
3420 *tail = t;
3421 tail = &t->next;
3422 t->type = type;
3423 nasm_free(t->text);
3424 t->text = text;
3425 t->a.mac = NULL;
3427 continue;
3428 } else {
3429 t = *tail = tline;
3430 tline = tline->next;
3431 t->a.mac = NULL;
3432 tail = &t->next;
3435 *tail = NULL;
3436 t = thead;
3437 for (; t && (tt = t->next) != NULL; t = t->next)
3438 switch (t->type) {
3439 case TOK_WHITESPACE:
3440 if (tt->type == TOK_WHITESPACE) {
3441 t->next = delete_Token(tt);
3443 break;
3444 case TOK_ID:
3445 if (tt->type == TOK_ID || tt->type == TOK_NUMBER) {
3446 char *tmp = nasm_strcat(t->text, tt->text);
3447 nasm_free(t->text);
3448 t->text = tmp;
3449 t->next = delete_Token(tt);
3451 break;
3452 case TOK_NUMBER:
3453 if (tt->type == TOK_NUMBER) {
3454 char *tmp = nasm_strcat(t->text, tt->text);
3455 nasm_free(t->text);
3456 t->text = tmp;
3457 t->next = delete_Token(tt);
3459 break;
3460 default:
3461 break;
3464 return thead;
3468 * Expand all single-line macro calls made in the given line.
3469 * Return the expanded version of the line. The original is deemed
3470 * to be destroyed in the process. (In reality we'll just move
3471 * Tokens from input to output a lot of the time, rather than
3472 * actually bothering to destroy and replicate.)
3474 #define DEADMAN_LIMIT (1 << 20)
3476 static Token *expand_smacro(Token * tline)
3478 Token *t, *tt, *mstart, **tail, *thead;
3479 struct hash_table *smtbl;
3480 SMacro *head = NULL, *m;
3481 Token **params;
3482 int *paramsize;
3483 unsigned int nparam, sparam;
3484 int brackets, rescan;
3485 Token *org_tline = tline;
3486 Context *ctx;
3487 char *mname;
3488 int deadman = DEADMAN_LIMIT;
3491 * Trick: we should avoid changing the start token pointer since it can
3492 * be contained in "next" field of other token. Because of this
3493 * we allocate a copy of first token and work with it; at the end of
3494 * routine we copy it back
3496 if (org_tline) {
3497 tline =
3498 new_Token(org_tline->next, org_tline->type, org_tline->text,
3500 tline->a.mac = org_tline->a.mac;
3501 nasm_free(org_tline->text);
3502 org_tline->text = NULL;
3505 again:
3506 tail = &thead;
3507 thead = NULL;
3509 while (tline) { /* main token loop */
3510 if (!--deadman) {
3511 error(ERR_NONFATAL, "interminable macro recursion");
3512 break;
3515 if ((mname = tline->text)) {
3516 /* if this token is a local macro, look in local context */
3517 ctx = NULL;
3518 smtbl = &smacros;
3519 if (tline->type == TOK_ID || tline->type == TOK_PREPROC_ID) {
3520 ctx = get_ctx(mname, true);
3521 if (ctx)
3522 smtbl = &ctx->localmac;
3524 head = (SMacro *) hash_findix(smtbl, mname);
3527 * We've hit an identifier. As in is_mmacro below, we first
3528 * check whether the identifier is a single-line macro at
3529 * all, then think about checking for parameters if
3530 * necessary.
3532 for (m = head; m; m = m->next)
3533 if (!mstrcmp(m->name, mname, m->casesense))
3534 break;
3535 if (m) {
3536 mstart = tline;
3537 params = NULL;
3538 paramsize = NULL;
3539 if (m->nparam == 0) {
3541 * Simple case: the macro is parameterless. Discard the
3542 * one token that the macro call took, and push the
3543 * expansion back on the to-do stack.
3545 if (!m->expansion) {
3546 if (!strcmp("__FILE__", m->name)) {
3547 int32_t num = 0;
3548 char *file = NULL;
3549 src_get(&num, &file);
3550 tline->text = nasm_quote(file, strlen(file));
3551 tline->type = TOK_STRING;
3552 nasm_free(file);
3553 continue;
3555 if (!strcmp("__LINE__", m->name)) {
3556 nasm_free(tline->text);
3557 make_tok_num(tline, src_get_linnum());
3558 continue;
3560 if (!strcmp("__BITS__", m->name)) {
3561 nasm_free(tline->text);
3562 make_tok_num(tline, globalbits);
3563 continue;
3565 tline = delete_Token(tline);
3566 continue;
3568 } else {
3570 * Complicated case: at least one macro with this name
3571 * exists and takes parameters. We must find the
3572 * parameters in the call, count them, find the SMacro
3573 * that corresponds to that form of the macro call, and
3574 * substitute for the parameters when we expand. What a
3575 * pain.
3577 /*tline = tline->next;
3578 skip_white_(tline); */
3579 do {
3580 t = tline->next;
3581 while (tok_type_(t, TOK_SMAC_END)) {
3582 t->a.mac->in_progress = false;
3583 t->text = NULL;
3584 t = tline->next = delete_Token(t);
3586 tline = t;
3587 } while (tok_type_(tline, TOK_WHITESPACE));
3588 if (!tok_is_(tline, "(")) {
3590 * This macro wasn't called with parameters: ignore
3591 * the call. (Behaviour borrowed from gnu cpp.)
3593 tline = mstart;
3594 m = NULL;
3595 } else {
3596 int paren = 0;
3597 int white = 0;
3598 brackets = 0;
3599 nparam = 0;
3600 sparam = PARAM_DELTA;
3601 params = nasm_malloc(sparam * sizeof(Token *));
3602 params[0] = tline->next;
3603 paramsize = nasm_malloc(sparam * sizeof(int));
3604 paramsize[0] = 0;
3605 while (true) { /* parameter loop */
3607 * For some unusual expansions
3608 * which concatenates function call
3610 t = tline->next;
3611 while (tok_type_(t, TOK_SMAC_END)) {
3612 t->a.mac->in_progress = false;
3613 t->text = NULL;
3614 t = tline->next = delete_Token(t);
3616 tline = t;
3618 if (!tline) {
3619 error(ERR_NONFATAL,
3620 "macro call expects terminating `)'");
3621 break;
3623 if (tline->type == TOK_WHITESPACE
3624 && brackets <= 0) {
3625 if (paramsize[nparam])
3626 white++;
3627 else
3628 params[nparam] = tline->next;
3629 continue; /* parameter loop */
3631 if (tline->type == TOK_OTHER
3632 && tline->text[1] == 0) {
3633 char ch = tline->text[0];
3634 if (ch == ',' && !paren && brackets <= 0) {
3635 if (++nparam >= sparam) {
3636 sparam += PARAM_DELTA;
3637 params = nasm_realloc(params,
3638 sparam *
3639 sizeof(Token
3640 *));
3641 paramsize =
3642 nasm_realloc(paramsize,
3643 sparam *
3644 sizeof(int));
3646 params[nparam] = tline->next;
3647 paramsize[nparam] = 0;
3648 white = 0;
3649 continue; /* parameter loop */
3651 if (ch == '{' &&
3652 (brackets > 0 || (brackets == 0 &&
3653 !paramsize[nparam])))
3655 if (!(brackets++)) {
3656 params[nparam] = tline->next;
3657 continue; /* parameter loop */
3660 if (ch == '}' && brackets > 0)
3661 if (--brackets == 0) {
3662 brackets = -1;
3663 continue; /* parameter loop */
3665 if (ch == '(' && !brackets)
3666 paren++;
3667 if (ch == ')' && brackets <= 0)
3668 if (--paren < 0)
3669 break;
3671 if (brackets < 0) {
3672 brackets = 0;
3673 error(ERR_NONFATAL, "braces do not "
3674 "enclose all of macro parameter");
3676 paramsize[nparam] += white + 1;
3677 white = 0;
3678 } /* parameter loop */
3679 nparam++;
3680 while (m && (m->nparam != nparam ||
3681 mstrcmp(m->name, mname,
3682 m->casesense)))
3683 m = m->next;
3684 if (!m)
3685 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
3686 "macro `%s' exists, "
3687 "but not taking %d parameters",
3688 mstart->text, nparam);
3691 if (m && m->in_progress)
3692 m = NULL;
3693 if (!m) { /* in progess or didn't find '(' or wrong nparam */
3695 * Design question: should we handle !tline, which
3696 * indicates missing ')' here, or expand those
3697 * macros anyway, which requires the (t) test a few
3698 * lines down?
3700 nasm_free(params);
3701 nasm_free(paramsize);
3702 tline = mstart;
3703 } else {
3705 * Expand the macro: we are placed on the last token of the
3706 * call, so that we can easily split the call from the
3707 * following tokens. We also start by pushing an SMAC_END
3708 * token for the cycle removal.
3710 t = tline;
3711 if (t) {
3712 tline = t->next;
3713 t->next = NULL;
3715 tt = new_Token(tline, TOK_SMAC_END, NULL, 0);
3716 tt->a.mac = m;
3717 m->in_progress = true;
3718 tline = tt;
3719 for (t = m->expansion; t; t = t->next) {
3720 if (t->type >= TOK_SMAC_PARAM) {
3721 Token *pcopy = tline, **ptail = &pcopy;
3722 Token *ttt, *pt;
3723 int i;
3725 ttt = params[t->type - TOK_SMAC_PARAM];
3726 for (i = paramsize[t->type - TOK_SMAC_PARAM];
3727 --i >= 0;) {
3728 pt = *ptail =
3729 new_Token(tline, ttt->type, ttt->text,
3731 ptail = &pt->next;
3732 ttt = ttt->next;
3734 tline = pcopy;
3735 } else if (t->type == TOK_PREPROC_Q) {
3736 tt = new_Token(tline, TOK_ID, mname, 0);
3737 tline = tt;
3738 } else if (t->type == TOK_PREPROC_QQ) {
3739 tt = new_Token(tline, TOK_ID, m->name, 0);
3740 tline = tt;
3741 } else {
3742 tt = new_Token(tline, t->type, t->text, 0);
3743 tline = tt;
3748 * Having done that, get rid of the macro call, and clean
3749 * up the parameters.
3751 nasm_free(params);
3752 nasm_free(paramsize);
3753 free_tlist(mstart);
3754 continue; /* main token loop */
3759 if (tline->type == TOK_SMAC_END) {
3760 tline->a.mac->in_progress = false;
3761 tline = delete_Token(tline);
3762 } else {
3763 t = *tail = tline;
3764 tline = tline->next;
3765 t->a.mac = NULL;
3766 t->next = NULL;
3767 tail = &t->next;
3772 * Now scan the entire line and look for successive TOK_IDs that resulted
3773 * after expansion (they can't be produced by tokenize()). The successive
3774 * TOK_IDs should be concatenated.
3775 * Also we look for %+ tokens and concatenate the tokens before and after
3776 * them (without white spaces in between).
3778 t = thead;
3779 rescan = 0;
3780 while (t) {
3781 while (t && t->type != TOK_ID && t->type != TOK_PREPROC_ID)
3782 t = t->next;
3783 if (!t || !t->next)
3784 break;
3785 if (t->next->type == TOK_ID ||
3786 t->next->type == TOK_PREPROC_ID ||
3787 t->next->type == TOK_NUMBER) {
3788 char *p = nasm_strcat(t->text, t->next->text);
3789 nasm_free(t->text);
3790 t->next = delete_Token(t->next);
3791 t->text = p;
3792 rescan = 1;
3793 } else if (t->next->type == TOK_WHITESPACE && t->next->next &&
3794 t->next->next->type == TOK_PREPROC_ID &&
3795 strcmp(t->next->next->text, "%+") == 0) {
3796 /* free the next whitespace, the %+ token and next whitespace */
3797 int i;
3798 for (i = 1; i <= 3; i++) {
3799 if (!t->next
3800 || (i != 2 && t->next->type != TOK_WHITESPACE))
3801 break;
3802 t->next = delete_Token(t->next);
3803 } /* endfor */
3804 } else
3805 t = t->next;
3807 /* If we concatenaded something, re-scan the line for macros */
3808 if (rescan) {
3809 tline = thead;
3810 goto again;
3813 if (org_tline) {
3814 if (thead) {
3815 *org_tline = *thead;
3816 /* since we just gave text to org_line, don't free it */
3817 thead->text = NULL;
3818 delete_Token(thead);
3819 } else {
3820 /* the expression expanded to empty line;
3821 we can't return NULL for some reasons
3822 we just set the line to a single WHITESPACE token. */
3823 memset(org_tline, 0, sizeof(*org_tline));
3824 org_tline->text = NULL;
3825 org_tline->type = TOK_WHITESPACE;
3827 thead = org_tline;
3830 return thead;
3834 * Similar to expand_smacro but used exclusively with macro identifiers
3835 * right before they are fetched in. The reason is that there can be
3836 * identifiers consisting of several subparts. We consider that if there
3837 * are more than one element forming the name, user wants a expansion,
3838 * otherwise it will be left as-is. Example:
3840 * %define %$abc cde
3842 * the identifier %$abc will be left as-is so that the handler for %define
3843 * will suck it and define the corresponding value. Other case:
3845 * %define _%$abc cde
3847 * In this case user wants name to be expanded *before* %define starts
3848 * working, so we'll expand %$abc into something (if it has a value;
3849 * otherwise it will be left as-is) then concatenate all successive
3850 * PP_IDs into one.
3852 static Token *expand_id(Token * tline)
3854 Token *cur, *oldnext = NULL;
3856 if (!tline || !tline->next)
3857 return tline;
3859 cur = tline;
3860 while (cur->next &&
3861 (cur->next->type == TOK_ID ||
3862 cur->next->type == TOK_PREPROC_ID
3863 || cur->next->type == TOK_NUMBER))
3864 cur = cur->next;
3866 /* If identifier consists of just one token, don't expand */
3867 if (cur == tline)
3868 return tline;
3870 if (cur) {
3871 oldnext = cur->next; /* Detach the tail past identifier */
3872 cur->next = NULL; /* so that expand_smacro stops here */
3875 tline = expand_smacro(tline);
3877 if (cur) {
3878 /* expand_smacro possibly changhed tline; re-scan for EOL */
3879 cur = tline;
3880 while (cur && cur->next)
3881 cur = cur->next;
3882 if (cur)
3883 cur->next = oldnext;
3886 return tline;
3890 * Determine whether the given line constitutes a multi-line macro
3891 * call, and return the MMacro structure called if so. Doesn't have
3892 * to check for an initial label - that's taken care of in
3893 * expand_mmacro - but must check numbers of parameters. Guaranteed
3894 * to be called with tline->type == TOK_ID, so the putative macro
3895 * name is easy to find.
3897 static MMacro *is_mmacro(Token * tline, Token *** params_array)
3899 MMacro *head, *m;
3900 Token **params;
3901 int nparam;
3903 head = (MMacro *) hash_findix(&mmacros, tline->text);
3906 * Efficiency: first we see if any macro exists with the given
3907 * name. If not, we can return NULL immediately. _Then_ we
3908 * count the parameters, and then we look further along the
3909 * list if necessary to find the proper MMacro.
3911 for (m = head; m; m = m->next)
3912 if (!mstrcmp(m->name, tline->text, m->casesense))
3913 break;
3914 if (!m)
3915 return NULL;
3918 * OK, we have a potential macro. Count and demarcate the
3919 * parameters.
3921 count_mmac_params(tline->next, &nparam, &params);
3924 * So we know how many parameters we've got. Find the MMacro
3925 * structure that handles this number.
3927 while (m) {
3928 if (m->nparam_min <= nparam
3929 && (m->plus || nparam <= m->nparam_max)) {
3931 * This one is right. Just check if cycle removal
3932 * prohibits us using it before we actually celebrate...
3934 if (m->in_progress) {
3935 #if 0
3936 error(ERR_NONFATAL,
3937 "self-reference in multi-line macro `%s'", m->name);
3938 #endif
3939 nasm_free(params);
3940 return NULL;
3943 * It's right, and we can use it. Add its default
3944 * parameters to the end of our list if necessary.
3946 if (m->defaults && nparam < m->nparam_min + m->ndefs) {
3947 params =
3948 nasm_realloc(params,
3949 ((m->nparam_min + m->ndefs +
3950 1) * sizeof(*params)));
3951 while (nparam < m->nparam_min + m->ndefs) {
3952 params[nparam] = m->defaults[nparam - m->nparam_min];
3953 nparam++;
3957 * If we've gone over the maximum parameter count (and
3958 * we're in Plus mode), ignore parameters beyond
3959 * nparam_max.
3961 if (m->plus && nparam > m->nparam_max)
3962 nparam = m->nparam_max;
3964 * Then terminate the parameter list, and leave.
3966 if (!params) { /* need this special case */
3967 params = nasm_malloc(sizeof(*params));
3968 nparam = 0;
3970 params[nparam] = NULL;
3971 *params_array = params;
3972 return m;
3975 * This one wasn't right: look for the next one with the
3976 * same name.
3978 for (m = m->next; m; m = m->next)
3979 if (!mstrcmp(m->name, tline->text, m->casesense))
3980 break;
3984 * After all that, we didn't find one with the right number of
3985 * parameters. Issue a warning, and fail to expand the macro.
3987 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
3988 "macro `%s' exists, but not taking %d parameters",
3989 tline->text, nparam);
3990 nasm_free(params);
3991 return NULL;
3995 * Expand the multi-line macro call made by the given line, if
3996 * there is one to be expanded. If there is, push the expansion on
3997 * istk->expansion and return 1. Otherwise return 0.
3999 static int expand_mmacro(Token * tline)
4001 Token *startline = tline;
4002 Token *label = NULL;
4003 int dont_prepend = 0;
4004 Token **params, *t, *mtok, *tt;
4005 MMacro *m;
4006 Line *l, *ll;
4007 int i, nparam, *paramlen;
4008 const char *mname;
4010 t = tline;
4011 skip_white_(t);
4012 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
4013 if (!tok_type_(t, TOK_ID) && !tok_type_(t, TOK_PREPROC_ID))
4014 return 0;
4015 mtok = t;
4016 m = is_mmacro(t, &params);
4017 if (m) {
4018 mname = t->text;
4019 } else {
4020 Token *last;
4022 * We have an id which isn't a macro call. We'll assume
4023 * it might be a label; we'll also check to see if a
4024 * colon follows it. Then, if there's another id after
4025 * that lot, we'll check it again for macro-hood.
4027 label = last = t;
4028 t = t->next;
4029 if (tok_type_(t, TOK_WHITESPACE))
4030 last = t, t = t->next;
4031 if (tok_is_(t, ":")) {
4032 dont_prepend = 1;
4033 last = t, t = t->next;
4034 if (tok_type_(t, TOK_WHITESPACE))
4035 last = t, t = t->next;
4037 if (!tok_type_(t, TOK_ID) || (m = is_mmacro(t, &params)) == NULL)
4038 return 0;
4039 last->next = NULL;
4040 mname = t->text;
4041 tline = t;
4045 * Fix up the parameters: this involves stripping leading and
4046 * trailing whitespace, then stripping braces if they are
4047 * present.
4049 for (nparam = 0; params[nparam]; nparam++) ;
4050 paramlen = nparam ? nasm_malloc(nparam * sizeof(*paramlen)) : NULL;
4052 for (i = 0; params[i]; i++) {
4053 int brace = false;
4054 int comma = (!m->plus || i < nparam - 1);
4056 t = params[i];
4057 skip_white_(t);
4058 if (tok_is_(t, "{"))
4059 t = t->next, brace = true, comma = false;
4060 params[i] = t;
4061 paramlen[i] = 0;
4062 while (t) {
4063 if (comma && t->type == TOK_OTHER && !strcmp(t->text, ","))
4064 break; /* ... because we have hit a comma */
4065 if (comma && t->type == TOK_WHITESPACE
4066 && tok_is_(t->next, ","))
4067 break; /* ... or a space then a comma */
4068 if (brace && t->type == TOK_OTHER && !strcmp(t->text, "}"))
4069 break; /* ... or a brace */
4070 t = t->next;
4071 paramlen[i]++;
4076 * OK, we have a MMacro structure together with a set of
4077 * parameters. We must now go through the expansion and push
4078 * copies of each Line on to istk->expansion. Substitution of
4079 * parameter tokens and macro-local tokens doesn't get done
4080 * until the single-line macro substitution process; this is
4081 * because delaying them allows us to change the semantics
4082 * later through %rotate.
4084 * First, push an end marker on to istk->expansion, mark this
4085 * macro as in progress, and set up its invocation-specific
4086 * variables.
4088 ll = nasm_malloc(sizeof(Line));
4089 ll->next = istk->expansion;
4090 ll->finishes = m;
4091 ll->first = NULL;
4092 istk->expansion = ll;
4094 m->in_progress = true;
4095 m->params = params;
4096 m->iline = tline;
4097 m->nparam = nparam;
4098 m->rotate = 0;
4099 m->paramlen = paramlen;
4100 m->unique = unique++;
4101 m->lineno = 0;
4103 m->next_active = istk->mstk;
4104 istk->mstk = m;
4106 for (l = m->expansion; l; l = l->next) {
4107 Token **tail;
4109 ll = nasm_malloc(sizeof(Line));
4110 ll->finishes = NULL;
4111 ll->next = istk->expansion;
4112 istk->expansion = ll;
4113 tail = &ll->first;
4115 for (t = l->first; t; t = t->next) {
4116 Token *x = t;
4117 switch (t->type) {
4118 case TOK_PREPROC_Q:
4119 tt = *tail = new_Token(NULL, TOK_ID, mname, 0);
4120 break;
4121 case TOK_PREPROC_QQ:
4122 tt = *tail = new_Token(NULL, TOK_ID, m->name, 0);
4123 break;
4124 case TOK_PREPROC_ID:
4125 if (t->text[1] == '0' && t->text[2] == '0') {
4126 dont_prepend = -1;
4127 x = label;
4128 if (!x)
4129 continue;
4131 /* fall through */
4132 default:
4133 tt = *tail = new_Token(NULL, x->type, x->text, 0);
4134 break;
4136 tail = &tt->next;
4138 *tail = NULL;
4142 * If we had a label, push it on as the first line of
4143 * the macro expansion.
4145 if (label) {
4146 if (dont_prepend < 0)
4147 free_tlist(startline);
4148 else {
4149 ll = nasm_malloc(sizeof(Line));
4150 ll->finishes = NULL;
4151 ll->next = istk->expansion;
4152 istk->expansion = ll;
4153 ll->first = startline;
4154 if (!dont_prepend) {
4155 while (label->next)
4156 label = label->next;
4157 label->next = tt = new_Token(NULL, TOK_OTHER, ":", 0);
4162 list->uplevel(m->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
4164 return 1;
4167 /* The function that actually does the error reporting */
4168 static void verror(int severity, const char *fmt, va_list arg)
4170 char buff[1024];
4172 vsnprintf(buff, sizeof(buff), fmt, arg);
4174 if (istk && istk->mstk && istk->mstk->name)
4175 _error(severity, "(%s:%d) %s", istk->mstk->name,
4176 istk->mstk->lineno, buff);
4177 else
4178 _error(severity, "%s", buff);
4182 * Since preprocessor always operate only on the line that didn't
4183 * arrived yet, we should always use ERR_OFFBY1.
4185 static void error(int severity, const char *fmt, ...)
4187 va_list arg;
4189 /* If we're in a dead branch of IF or something like it, ignore the error */
4190 if (istk && istk->conds && !emitting(istk->conds->state))
4191 return;
4193 va_start(arg, fmt);
4194 verror(severity, fmt, arg);
4195 va_end(arg);
4199 * Because %else etc are evaluated in the state context
4200 * of the previous branch, errors might get lost with error():
4201 * %if 0 ... %else trailing garbage ... %endif
4202 * So %else etc should report errors with this function.
4204 static void error_precond(int severity, const char *fmt, ...)
4206 va_list arg;
4208 /* Only ignore the error if it's really in a dead branch */
4209 if (istk && istk->conds && istk->conds->state == COND_NEVER)
4210 return;
4212 va_start(arg, fmt);
4213 verror(severity, fmt, arg);
4214 va_end(arg);
4217 static void
4218 pp_reset(char *file, int apass, efunc errfunc, evalfunc eval,
4219 ListGen * listgen, StrList **deplist)
4221 Token *t;
4223 _error = errfunc;
4224 cstk = NULL;
4225 istk = nasm_malloc(sizeof(Include));
4226 istk->next = NULL;
4227 istk->conds = NULL;
4228 istk->expansion = NULL;
4229 istk->mstk = NULL;
4230 istk->fp = fopen(file, "r");
4231 istk->fname = NULL;
4232 src_set_fname(nasm_strdup(file));
4233 src_set_linnum(0);
4234 istk->lineinc = 1;
4235 if (!istk->fp)
4236 error(ERR_FATAL|ERR_NOFILE, "unable to open input file `%s'",
4237 file);
4238 defining = NULL;
4239 nested_mac_count = 0;
4240 nested_rep_count = 0;
4241 init_macros();
4242 unique = 0;
4243 if (tasm_compatible_mode) {
4244 stdmacpos = nasm_stdmac;
4245 } else {
4246 stdmacpos = nasm_stdmac_after_tasm;
4248 any_extrastdmac = extrastdmac && *extrastdmac;
4249 do_predef = true;
4250 list = listgen;
4251 evaluate = eval;
4254 * 0 for dependencies, 1 for preparatory passes, 2 for final pass.
4255 * The caller, however, will also pass in 3 for preprocess-only so
4256 * we can set __PASS__ accordingly.
4258 pass = apass > 2 ? 2 : apass;
4260 dephead = deptail = deplist;
4261 if (deplist) {
4262 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
4263 sl->next = NULL;
4264 strcpy(sl->str, file);
4265 *deptail = sl;
4266 deptail = &sl->next;
4270 * Define the __PASS__ macro. This is defined here unlike
4271 * all the other builtins, because it is special -- it varies between
4272 * passes.
4274 t = nasm_malloc(sizeof(*t));
4275 t->next = NULL;
4276 make_tok_num(t, apass);
4277 t->a.mac = NULL;
4278 define_smacro(NULL, "__PASS__", true, 0, t);
4281 static char *pp_getline(void)
4283 char *line;
4284 Token *tline;
4286 while (1) {
4288 * Fetch a tokenized line, either from the macro-expansion
4289 * buffer or from the input file.
4291 tline = NULL;
4292 while (istk->expansion && istk->expansion->finishes) {
4293 Line *l = istk->expansion;
4294 if (!l->finishes->name && l->finishes->in_progress > 1) {
4295 Line *ll;
4298 * This is a macro-end marker for a macro with no
4299 * name, which means it's not really a macro at all
4300 * but a %rep block, and the `in_progress' field is
4301 * more than 1, meaning that we still need to
4302 * repeat. (1 means the natural last repetition; 0
4303 * means termination by %exitrep.) We have
4304 * therefore expanded up to the %endrep, and must
4305 * push the whole block on to the expansion buffer
4306 * again. We don't bother to remove the macro-end
4307 * marker: we'd only have to generate another one
4308 * if we did.
4310 l->finishes->in_progress--;
4311 for (l = l->finishes->expansion; l; l = l->next) {
4312 Token *t, *tt, **tail;
4314 ll = nasm_malloc(sizeof(Line));
4315 ll->next = istk->expansion;
4316 ll->finishes = NULL;
4317 ll->first = NULL;
4318 tail = &ll->first;
4320 for (t = l->first; t; t = t->next) {
4321 if (t->text || t->type == TOK_WHITESPACE) {
4322 tt = *tail =
4323 new_Token(NULL, t->type, t->text, 0);
4324 tail = &tt->next;
4328 istk->expansion = ll;
4330 } else {
4332 * Check whether a `%rep' was started and not ended
4333 * within this macro expansion. This can happen and
4334 * should be detected. It's a fatal error because
4335 * I'm too confused to work out how to recover
4336 * sensibly from it.
4338 if (defining) {
4339 if (defining->name)
4340 error(ERR_PANIC,
4341 "defining with name in expansion");
4342 else if (istk->mstk->name)
4343 error(ERR_FATAL,
4344 "`%%rep' without `%%endrep' within"
4345 " expansion of macro `%s'",
4346 istk->mstk->name);
4350 * FIXME: investigate the relationship at this point between
4351 * istk->mstk and l->finishes
4354 MMacro *m = istk->mstk;
4355 istk->mstk = m->next_active;
4356 if (m->name) {
4358 * This was a real macro call, not a %rep, and
4359 * therefore the parameter information needs to
4360 * be freed.
4362 nasm_free(m->params);
4363 free_tlist(m->iline);
4364 nasm_free(m->paramlen);
4365 l->finishes->in_progress = false;
4366 } else
4367 free_mmacro(m);
4369 istk->expansion = l->next;
4370 nasm_free(l);
4371 list->downlevel(LIST_MACRO);
4374 while (1) { /* until we get a line we can use */
4376 if (istk->expansion) { /* from a macro expansion */
4377 char *p;
4378 Line *l = istk->expansion;
4379 if (istk->mstk)
4380 istk->mstk->lineno++;
4381 tline = l->first;
4382 istk->expansion = l->next;
4383 nasm_free(l);
4384 p = detoken(tline, false);
4385 list->line(LIST_MACRO, p);
4386 nasm_free(p);
4387 break;
4389 line = read_line();
4390 if (line) { /* from the current input file */
4391 line = prepreproc(line);
4392 tline = tokenize(line);
4393 nasm_free(line);
4394 break;
4397 * The current file has ended; work down the istk
4400 Include *i = istk;
4401 fclose(i->fp);
4402 if (i->conds)
4403 error(ERR_FATAL,
4404 "expected `%%endif' before end of file");
4405 /* only set line and file name if there's a next node */
4406 if (i->next) {
4407 src_set_linnum(i->lineno);
4408 nasm_free(src_set_fname(i->fname));
4410 istk = i->next;
4411 list->downlevel(LIST_INCLUDE);
4412 nasm_free(i);
4413 if (!istk)
4414 return NULL;
4415 if (istk->expansion && istk->expansion->finishes)
4416 break;
4421 * We must expand MMacro parameters and MMacro-local labels
4422 * _before_ we plunge into directive processing, to cope
4423 * with things like `%define something %1' such as STRUC
4424 * uses. Unless we're _defining_ a MMacro, in which case
4425 * those tokens should be left alone to go into the
4426 * definition; and unless we're in a non-emitting
4427 * condition, in which case we don't want to meddle with
4428 * anything.
4430 if (!defining && !(istk->conds && !emitting(istk->conds->state))
4431 && !(istk->mstk && !istk->mstk->in_progress))
4432 tline = expand_mmac_params(tline);
4435 * Check the line to see if it's a preprocessor directive.
4437 if (do_directive(tline) == DIRECTIVE_FOUND) {
4438 continue;
4439 } else if (defining) {
4441 * We're defining a multi-line macro. We emit nothing
4442 * at all, and just
4443 * shove the tokenized line on to the macro definition.
4445 Line *l = nasm_malloc(sizeof(Line));
4446 l->next = defining->expansion;
4447 l->first = tline;
4448 l->finishes = NULL;
4449 defining->expansion = l;
4450 continue;
4451 } else if (istk->conds && !emitting(istk->conds->state)) {
4453 * We're in a non-emitting branch of a condition block.
4454 * Emit nothing at all, not even a blank line: when we
4455 * emerge from the condition we'll give a line-number
4456 * directive so we keep our place correctly.
4458 free_tlist(tline);
4459 continue;
4460 } else if (istk->mstk && !istk->mstk->in_progress) {
4462 * We're in a %rep block which has been terminated, so
4463 * we're walking through to the %endrep without
4464 * emitting anything. Emit nothing at all, not even a
4465 * blank line: when we emerge from the %rep block we'll
4466 * give a line-number directive so we keep our place
4467 * correctly.
4469 free_tlist(tline);
4470 continue;
4471 } else {
4472 tline = expand_smacro(tline);
4473 if (!expand_mmacro(tline)) {
4475 * De-tokenize the line again, and emit it.
4477 line = detoken(tline, true);
4478 free_tlist(tline);
4479 break;
4480 } else {
4481 continue; /* expand_mmacro calls free_tlist */
4486 return line;
4489 static void pp_cleanup(int pass)
4491 if (defining) {
4492 if(defining->name) {
4493 error(ERR_NONFATAL,
4494 "end of file while still defining macro `%s'",
4495 defining->name);
4496 } else {
4497 error(ERR_NONFATAL, "end of file while still in %%rep");
4500 free_mmacro(defining);
4502 while (cstk)
4503 ctx_pop();
4504 free_macros();
4505 while (istk) {
4506 Include *i = istk;
4507 istk = istk->next;
4508 fclose(i->fp);
4509 nasm_free(i->fname);
4510 nasm_free(i);
4512 while (cstk)
4513 ctx_pop();
4514 nasm_free(src_set_fname(NULL));
4515 if (pass == 0) {
4516 IncPath *i;
4517 free_llist(predef);
4518 delete_Blocks();
4519 while ((i = ipath)) {
4520 ipath = i->next;
4521 if (i->path)
4522 nasm_free(i->path);
4523 nasm_free(i);
4528 void pp_include_path(char *path)
4530 IncPath *i;
4532 i = nasm_malloc(sizeof(IncPath));
4533 i->path = path ? nasm_strdup(path) : NULL;
4534 i->next = NULL;
4536 if (ipath != NULL) {
4537 IncPath *j = ipath;
4538 while (j->next != NULL)
4539 j = j->next;
4540 j->next = i;
4541 } else {
4542 ipath = i;
4546 void pp_pre_include(char *fname)
4548 Token *inc, *space, *name;
4549 Line *l;
4551 name = new_Token(NULL, TOK_INTERNAL_STRING, fname, 0);
4552 space = new_Token(name, TOK_WHITESPACE, NULL, 0);
4553 inc = new_Token(space, TOK_PREPROC_ID, "%include", 0);
4555 l = nasm_malloc(sizeof(Line));
4556 l->next = predef;
4557 l->first = inc;
4558 l->finishes = NULL;
4559 predef = l;
4562 void pp_pre_define(char *definition)
4564 Token *def, *space;
4565 Line *l;
4566 char *equals;
4568 equals = strchr(definition, '=');
4569 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4570 def = new_Token(space, TOK_PREPROC_ID, "%define", 0);
4571 if (equals)
4572 *equals = ' ';
4573 space->next = tokenize(definition);
4574 if (equals)
4575 *equals = '=';
4577 l = nasm_malloc(sizeof(Line));
4578 l->next = predef;
4579 l->first = def;
4580 l->finishes = NULL;
4581 predef = l;
4584 void pp_pre_undefine(char *definition)
4586 Token *def, *space;
4587 Line *l;
4589 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4590 def = new_Token(space, TOK_PREPROC_ID, "%undef", 0);
4591 space->next = tokenize(definition);
4593 l = nasm_malloc(sizeof(Line));
4594 l->next = predef;
4595 l->first = def;
4596 l->finishes = NULL;
4597 predef = l;
4601 * Added by Keith Kanios:
4603 * This function is used to assist with "runtime" preprocessor
4604 * directives. (e.g. pp_runtime("%define __BITS__ 64");)
4606 * ERRORS ARE IGNORED HERE, SO MAKE COMPLETELY SURE THAT YOU
4607 * PASS A VALID STRING TO THIS FUNCTION!!!!!
4610 void pp_runtime(char *definition)
4612 Token *def;
4614 def = tokenize(definition);
4615 if(do_directive(def) == NO_DIRECTIVE_FOUND)
4616 free_tlist(def);
4620 void pp_extra_stdmac(macros_t *macros)
4622 extrastdmac = macros;
4625 static void make_tok_num(Token * tok, int64_t val)
4627 char numbuf[20];
4628 snprintf(numbuf, sizeof(numbuf), "%"PRId64"", val);
4629 tok->text = nasm_strdup(numbuf);
4630 tok->type = TOK_NUMBER;
4633 Preproc nasmpp = {
4634 pp_reset,
4635 pp_getline,
4636 pp_cleanup