preproc: fix list iteration in the case of expand_indirect()
[nasm/perl-rewrite.git] / preproc.c
blobe83abbe9ccce834ab5e742b93ad2c144850006ca
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_INDIRECT, /* %[...] */
163 TOK_SMAC_PARAM, /* MUST BE LAST IN THE LIST!!! */
164 TOK_MAX = INT_MAX /* Keep compiler from reducing the range */
167 struct Token {
168 Token *next;
169 char *text;
170 union {
171 SMacro *mac; /* associated macro for TOK_SMAC_END */
172 size_t len; /* scratch length field */
173 } a; /* Auxiliary data */
174 enum pp_token_type type;
178 * Multi-line macro definitions are stored as a linked list of
179 * these, which is essentially a container to allow several linked
180 * lists of Tokens.
182 * Note that in this module, linked lists are treated as stacks
183 * wherever possible. For this reason, Lines are _pushed_ on to the
184 * `expansion' field in MMacro structures, so that the linked list,
185 * if walked, would give the macro lines in reverse order; this
186 * means that we can walk the list when expanding a macro, and thus
187 * push the lines on to the `expansion' field in _istk_ in reverse
188 * order (so that when popped back off they are in the right
189 * order). It may seem cockeyed, and it relies on my design having
190 * an even number of steps in, but it works...
192 * Some of these structures, rather than being actual lines, are
193 * markers delimiting the end of the expansion of a given macro.
194 * This is for use in the cycle-tracking and %rep-handling code.
195 * Such structures have `finishes' non-NULL, and `first' NULL. All
196 * others have `finishes' NULL, but `first' may still be NULL if
197 * the line is blank.
199 struct Line {
200 Line *next;
201 MMacro *finishes;
202 Token *first;
206 * To handle an arbitrary level of file inclusion, we maintain a
207 * stack (ie linked list) of these things.
209 struct Include {
210 Include *next;
211 FILE *fp;
212 Cond *conds;
213 Line *expansion;
214 char *fname;
215 int lineno, lineinc;
216 MMacro *mstk; /* stack of active macros/reps */
220 * Include search path. This is simply a list of strings which get
221 * prepended, in turn, to the name of an include file, in an
222 * attempt to find the file if it's not in the current directory.
224 struct IncPath {
225 IncPath *next;
226 char *path;
230 * Conditional assembly: we maintain a separate stack of these for
231 * each level of file inclusion. (The only reason we keep the
232 * stacks separate is to ensure that a stray `%endif' in a file
233 * included from within the true branch of a `%if' won't terminate
234 * it and cause confusion: instead, rightly, it'll cause an error.)
236 struct Cond {
237 Cond *next;
238 int state;
240 enum {
242 * These states are for use just after %if or %elif: IF_TRUE
243 * means the condition has evaluated to truth so we are
244 * currently emitting, whereas IF_FALSE means we are not
245 * currently emitting but will start doing so if a %else comes
246 * up. In these states, all directives are admissible: %elif,
247 * %else and %endif. (And of course %if.)
249 COND_IF_TRUE, COND_IF_FALSE,
251 * These states come up after a %else: ELSE_TRUE means we're
252 * emitting, and ELSE_FALSE means we're not. In ELSE_* states,
253 * any %elif or %else will cause an error.
255 COND_ELSE_TRUE, COND_ELSE_FALSE,
257 * These states mean that we're not emitting now, and also that
258 * nothing until %endif will be emitted at all. COND_DONE is
259 * used when we've had our moment of emission
260 * and have now started seeing %elifs. COND_NEVER is used when
261 * the condition construct in question is contained within a
262 * non-emitting branch of a larger condition construct,
263 * or if there is an error.
265 COND_DONE, COND_NEVER
267 #define emitting(x) ( (x) == COND_IF_TRUE || (x) == COND_ELSE_TRUE )
270 * These defines are used as the possible return values for do_directive
272 #define NO_DIRECTIVE_FOUND 0
273 #define DIRECTIVE_FOUND 1
276 * Condition codes. Note that we use c_ prefix not C_ because C_ is
277 * used in nasm.h for the "real" condition codes. At _this_ level,
278 * we treat CXZ and ECXZ as condition codes, albeit non-invertible
279 * ones, so we need a different enum...
281 static const char * const conditions[] = {
282 "a", "ae", "b", "be", "c", "cxz", "e", "ecxz", "g", "ge", "l", "le",
283 "na", "nae", "nb", "nbe", "nc", "ne", "ng", "nge", "nl", "nle", "no",
284 "np", "ns", "nz", "o", "p", "pe", "po", "rcxz", "s", "z"
286 enum pp_conds {
287 c_A, c_AE, c_B, c_BE, c_C, c_CXZ, c_E, c_ECXZ, c_G, c_GE, c_L, c_LE,
288 c_NA, c_NAE, c_NB, c_NBE, c_NC, c_NE, c_NG, c_NGE, c_NL, c_NLE, c_NO,
289 c_NP, c_NS, c_NZ, c_O, c_P, c_PE, c_PO, c_RCXZ, c_S, c_Z,
290 c_none = -1
292 static const enum pp_conds inverse_ccs[] = {
293 c_NA, c_NAE, c_NB, c_NBE, c_NC, -1, c_NE, -1, c_NG, c_NGE, c_NL, c_NLE,
294 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,
295 c_Z, c_NO, c_NP, c_PO, c_PE, -1, c_NS, c_NZ
299 * Directive names.
301 /* If this is a an IF, ELIF, ELSE or ENDIF keyword */
302 static int is_condition(enum preproc_token arg)
304 return PP_IS_COND(arg) || (arg == PP_ELSE) || (arg == PP_ENDIF);
307 /* For TASM compatibility we need to be able to recognise TASM compatible
308 * conditional compilation directives. Using the NASM pre-processor does
309 * not work, so we look for them specifically from the following list and
310 * then jam in the equivalent NASM directive into the input stream.
313 enum {
314 TM_ARG, TM_ELIF, TM_ELSE, TM_ENDIF, TM_IF, TM_IFDEF, TM_IFDIFI,
315 TM_IFNDEF, TM_INCLUDE, TM_LOCAL
318 static const char * const tasm_directives[] = {
319 "arg", "elif", "else", "endif", "if", "ifdef", "ifdifi",
320 "ifndef", "include", "local"
323 static int StackSize = 4;
324 static char *StackPointer = "ebp";
325 static int ArgOffset = 8;
326 static int LocalOffset = 0;
328 static Context *cstk;
329 static Include *istk;
330 static IncPath *ipath = NULL;
332 static efunc _error; /* Pointer to client-provided error reporting function */
333 static evalfunc evaluate;
335 static int pass; /* HACK: pass 0 = generate dependencies only */
336 static StrList **dephead, **deptail; /* Dependency list */
338 static uint64_t unique; /* unique identifier numbers */
340 static Line *predef = NULL;
341 static bool do_predef;
343 static ListGen *list;
346 * The current set of multi-line macros we have defined.
348 static struct hash_table mmacros;
351 * The current set of single-line macros we have defined.
353 static struct hash_table smacros;
356 * The multi-line macro we are currently defining, or the %rep
357 * block we are currently reading, if any.
359 static MMacro *defining;
361 static uint64_t nested_mac_count;
362 static uint64_t nested_rep_count;
365 * The number of macro parameters to allocate space for at a time.
367 #define PARAM_DELTA 16
370 * The standard macro set: defined in macros.c in the array nasm_stdmac.
371 * This gives our position in the macro set, when we're processing it.
373 static macros_t *stdmacpos;
376 * The extra standard macros that come from the object format, if
377 * any.
379 static macros_t *extrastdmac = NULL;
380 static bool any_extrastdmac;
383 * Tokens are allocated in blocks to improve speed
385 #define TOKEN_BLOCKSIZE 4096
386 static Token *freeTokens = NULL;
387 struct Blocks {
388 Blocks *next;
389 void *chunk;
392 static Blocks blocks = { NULL, NULL };
395 * Forward declarations.
397 static Token *expand_mmac_params(Token * tline);
398 static Token *expand_smacro(Token * tline);
399 static Token *expand_id(Token * tline);
400 static Token *expand_indirect(Token * tline, int level);
401 static Context *get_ctx(const char *name, bool all_contexts);
402 static void make_tok_num(Token * tok, int64_t val);
403 static void error(int severity, const char *fmt, ...);
404 static void error_precond(int severity, const char *fmt, ...);
405 static void *new_Block(size_t size);
406 static void delete_Blocks(void);
407 static Token *new_Token(Token * next, enum pp_token_type type,
408 const char *text, int txtlen);
409 static Token *delete_Token(Token * t);
412 * Macros for safe checking of token pointers, avoid *(NULL)
414 #define tok_type_(x,t) ((x) && (x)->type == (t))
415 #define skip_white_(x) if (tok_type_((x), TOK_WHITESPACE)) (x)=(x)->next
416 #define tok_is_(x,v) (tok_type_((x), TOK_OTHER) && !strcmp((x)->text,(v)))
417 #define tok_isnt_(x,v) ((x) && ((x)->type!=TOK_OTHER || strcmp((x)->text,(v))))
419 /* Handle TASM specific directives, which do not contain a % in
420 * front of them. We do it here because I could not find any other
421 * place to do it for the moment, and it is a hack (ideally it would
422 * be nice to be able to use the NASM pre-processor to do it).
424 static char *check_tasm_directive(char *line)
426 int32_t i, j, k, m, len;
427 char *p = line, *oldline, oldchar;
429 /* Skip whitespace */
430 while (nasm_isspace(*p) && *p != 0)
431 p++;
433 /* Binary search for the directive name */
434 i = -1;
435 j = elements(tasm_directives);
436 len = 0;
437 while (!nasm_isspace(p[len]) && p[len] != 0)
438 len++;
439 if (len) {
440 oldchar = p[len];
441 p[len] = 0;
442 while (j - i > 1) {
443 k = (j + i) / 2;
444 m = nasm_stricmp(p, tasm_directives[k]);
445 if (m == 0) {
446 /* We have found a directive, so jam a % in front of it
447 * so that NASM will then recognise it as one if it's own.
449 p[len] = oldchar;
450 len = strlen(p);
451 oldline = line;
452 line = nasm_malloc(len + 2);
453 line[0] = '%';
454 if (k == TM_IFDIFI) {
455 /* NASM does not recognise IFDIFI, so we convert it to
456 * %ifdef BOGUS. This is not used in NASM comaptible
457 * code, but does need to parse for the TASM macro
458 * package.
460 strcpy(line + 1, "ifdef BOGUS");
461 } else {
462 memcpy(line + 1, p, len + 1);
464 nasm_free(oldline);
465 return line;
466 } else if (m < 0) {
467 j = k;
468 } else
469 i = k;
471 p[len] = oldchar;
473 return line;
477 * The pre-preprocessing stage... This function translates line
478 * number indications as they emerge from GNU cpp (`# lineno "file"
479 * flags') into NASM preprocessor line number indications (`%line
480 * lineno file').
482 static char *prepreproc(char *line)
484 int lineno, fnlen;
485 char *fname, *oldline;
487 if (line[0] == '#' && line[1] == ' ') {
488 oldline = line;
489 fname = oldline + 2;
490 lineno = atoi(fname);
491 fname += strspn(fname, "0123456789 ");
492 if (*fname == '"')
493 fname++;
494 fnlen = strcspn(fname, "\"");
495 line = nasm_malloc(20 + fnlen);
496 snprintf(line, 20 + fnlen, "%%line %d %.*s", lineno, fnlen, fname);
497 nasm_free(oldline);
499 if (tasm_compatible_mode)
500 return check_tasm_directive(line);
501 return line;
505 * Free a linked list of tokens.
507 static void free_tlist(Token * list)
509 while (list) {
510 list = delete_Token(list);
515 * Free a linked list of lines.
517 static void free_llist(Line * list)
519 Line *l;
520 while (list) {
521 l = list;
522 list = list->next;
523 free_tlist(l->first);
524 nasm_free(l);
529 * Free an MMacro
531 static void free_mmacro(MMacro * m)
533 nasm_free(m->name);
534 free_tlist(m->dlist);
535 nasm_free(m->defaults);
536 free_llist(m->expansion);
537 nasm_free(m);
541 * Free all currently defined macros, and free the hash tables
543 static void free_smacro_table(struct hash_table *smt)
545 SMacro *s;
546 const char *key;
547 struct hash_tbl_node *it = NULL;
549 while ((s = hash_iterate(smt, &it, &key)) != NULL) {
550 nasm_free((void *)key);
551 while (s) {
552 SMacro *ns = s->next;
553 nasm_free(s->name);
554 free_tlist(s->expansion);
555 nasm_free(s);
556 s = ns;
559 hash_free(smt);
562 static void free_mmacro_table(struct hash_table *mmt)
564 MMacro *m;
565 const char *key;
566 struct hash_tbl_node *it = NULL;
568 it = NULL;
569 while ((m = hash_iterate(mmt, &it, &key)) != NULL) {
570 nasm_free((void *)key);
571 while (m) {
572 MMacro *nm = m->next;
573 free_mmacro(m);
574 m = nm;
577 hash_free(mmt);
580 static void free_macros(void)
582 free_smacro_table(&smacros);
583 free_mmacro_table(&mmacros);
587 * Initialize the hash tables
589 static void init_macros(void)
591 hash_init(&smacros, HASH_LARGE);
592 hash_init(&mmacros, HASH_LARGE);
596 * Pop the context stack.
598 static void ctx_pop(void)
600 Context *c = cstk;
602 cstk = cstk->next;
603 free_smacro_table(&c->localmac);
604 nasm_free(c->name);
605 nasm_free(c);
609 * Search for a key in the hash index; adding it if necessary
610 * (in which case we initialize the data pointer to NULL.)
612 static void **
613 hash_findi_add(struct hash_table *hash, const char *str)
615 struct hash_insert hi;
616 void **r;
617 char *strx;
619 r = hash_findi(hash, str, &hi);
620 if (r)
621 return r;
623 strx = nasm_strdup(str); /* Use a more efficient allocator here? */
624 return hash_add(&hi, strx, NULL);
628 * Like hash_findi, but returns the data element rather than a pointer
629 * to it. Used only when not adding a new element, hence no third
630 * argument.
632 static void *
633 hash_findix(struct hash_table *hash, const char *str)
635 void **p;
637 p = hash_findi(hash, str, NULL);
638 return p ? *p : NULL;
641 #define BUF_DELTA 512
643 * Read a line from the top file in istk, handling multiple CR/LFs
644 * at the end of the line read, and handling spurious ^Zs. Will
645 * return lines from the standard macro set if this has not already
646 * been done.
648 static char *read_line(void)
650 char *buffer, *p, *q;
651 int bufsize, continued_count;
653 if (stdmacpos) {
654 unsigned char c;
655 const unsigned char *p = stdmacpos;
656 char *ret, *q;
657 size_t len = 0;
658 while ((c = *p++)) {
659 if (c >= 0x80)
660 len += pp_directives_len[c-0x80]+1;
661 else
662 len++;
664 ret = nasm_malloc(len+1);
665 q = ret;
666 while ((c = *stdmacpos++)) {
667 if (c >= 0x80) {
668 memcpy(q, pp_directives[c-0x80], pp_directives_len[c-0x80]);
669 q += pp_directives_len[c-0x80];
670 *q++ = ' ';
671 } else {
672 *q++ = c;
675 stdmacpos = p;
676 *q = '\0';
678 if (!*stdmacpos) {
679 /* This was the last of the standard macro chain... */
680 stdmacpos = NULL;
681 if (any_extrastdmac) {
682 stdmacpos = extrastdmac;
683 any_extrastdmac = false;
684 } else if (do_predef) {
685 Line *pd, *l;
686 Token *head, **tail, *t;
689 * Nasty hack: here we push the contents of
690 * `predef' on to the top-level expansion stack,
691 * since this is the most convenient way to
692 * implement the pre-include and pre-define
693 * features.
695 for (pd = predef; pd; pd = pd->next) {
696 head = NULL;
697 tail = &head;
698 for (t = pd->first; t; t = t->next) {
699 *tail = new_Token(NULL, t->type, t->text, 0);
700 tail = &(*tail)->next;
702 l = nasm_malloc(sizeof(Line));
703 l->next = istk->expansion;
704 l->first = head;
705 l->finishes = NULL;
706 istk->expansion = l;
708 do_predef = false;
711 return ret;
714 bufsize = BUF_DELTA;
715 buffer = nasm_malloc(BUF_DELTA);
716 p = buffer;
717 continued_count = 0;
718 while (1) {
719 q = fgets(p, bufsize - (p - buffer), istk->fp);
720 if (!q)
721 break;
722 p += strlen(p);
723 if (p > buffer && p[-1] == '\n') {
724 /* Convert backslash-CRLF line continuation sequences into
725 nothing at all (for DOS and Windows) */
726 if (((p - 2) > buffer) && (p[-3] == '\\') && (p[-2] == '\r')) {
727 p -= 3;
728 *p = 0;
729 continued_count++;
731 /* Also convert backslash-LF line continuation sequences into
732 nothing at all (for Unix) */
733 else if (((p - 1) > buffer) && (p[-2] == '\\')) {
734 p -= 2;
735 *p = 0;
736 continued_count++;
737 } else {
738 break;
741 if (p - buffer > bufsize - 10) {
742 int32_t offset = p - buffer;
743 bufsize += BUF_DELTA;
744 buffer = nasm_realloc(buffer, bufsize);
745 p = buffer + offset; /* prevent stale-pointer problems */
749 if (!q && p == buffer) {
750 nasm_free(buffer);
751 return NULL;
754 src_set_linnum(src_get_linnum() + istk->lineinc +
755 (continued_count * istk->lineinc));
758 * Play safe: remove CRs as well as LFs, if any of either are
759 * present at the end of the line.
761 while (--p >= buffer && (*p == '\n' || *p == '\r'))
762 *p = '\0';
765 * Handle spurious ^Z, which may be inserted into source files
766 * by some file transfer utilities.
768 buffer[strcspn(buffer, "\032")] = '\0';
770 list->line(LIST_READ, buffer);
772 return buffer;
776 * Tokenize a line of text. This is a very simple process since we
777 * don't need to parse the value out of e.g. numeric tokens: we
778 * simply split one string into many.
780 static Token *tokenize(char *line)
782 char *p = line;
783 enum pp_token_type type;
784 Token *list = NULL;
785 Token *t, **tail = &list;
787 while (*line) {
788 p = line;
789 if (*p == '%') {
790 p++;
791 if (nasm_isdigit(*p) ||
792 ((*p == '-' || *p == '+') && nasm_isdigit(p[1])) ||
793 ((*p == '+') && (nasm_isspace(p[1]) || !p[1]))) {
794 do {
795 p++;
797 while (nasm_isdigit(*p));
798 type = TOK_PREPROC_ID;
799 } else if (*p == '{') {
800 p++;
801 while (*p && *p != '}') {
802 p[-1] = *p;
803 p++;
805 p[-1] = '\0';
806 if (*p)
807 p++;
808 type = TOK_PREPROC_ID;
809 } else if (*p == '[') {
810 int lvl = 1;
811 line += 2; /* Skip the leading %[ */
812 p++;
813 while (*p) {
814 if (*p == ']') {
815 if (!--lvl)
816 break;
817 } else if (*p == '%' && p[1] == '[') {
818 lvl++;
820 p++;
822 if (*p)
823 *p++ = '\0';
824 type = TOK_INDIRECT;
825 } else if (*p == '?') {
826 type = TOK_PREPROC_Q; /* %? */
827 p++;
828 if (*p == '?') {
829 type = TOK_PREPROC_QQ; /* %?? */
830 p++;
832 } else if (isidchar(*p) ||
833 ((*p == '!' || *p == '%' || *p == '$') &&
834 isidchar(p[1]))) {
835 do {
836 p++;
838 while (isidchar(*p));
839 type = TOK_PREPROC_ID;
840 } else {
841 type = TOK_OTHER;
842 if (*p == '%')
843 p++;
845 } else if (isidstart(*p) || (*p == '$' && isidstart(p[1]))) {
846 type = TOK_ID;
847 p++;
848 while (*p && isidchar(*p))
849 p++;
850 } else if (*p == '\'' || *p == '"' || *p == '`') {
852 * A string token.
854 type = TOK_STRING;
855 p = nasm_skip_string(p);
857 if (*p) {
858 p++;
859 } else {
860 error(ERR_WARNING|ERR_PASS1, "unterminated string");
861 /* Handling unterminated strings by UNV */
862 /* type = -1; */
864 } else if (isnumstart(*p)) {
865 bool is_hex = false;
866 bool is_float = false;
867 bool has_e = false;
868 char c, *r;
871 * A numeric token.
874 if (*p == '$') {
875 p++;
876 is_hex = true;
879 for (;;) {
880 c = *p++;
882 if (!is_hex && (c == 'e' || c == 'E')) {
883 has_e = true;
884 if (*p == '+' || *p == '-') {
885 /* e can only be followed by +/- if it is either a
886 prefixed hex number or a floating-point number */
887 p++;
888 is_float = true;
890 } else if (c == 'H' || c == 'h' || c == 'X' || c == 'x') {
891 is_hex = true;
892 } else if (c == 'P' || c == 'p') {
893 is_float = true;
894 if (*p == '+' || *p == '-')
895 p++;
896 } else if (isnumchar(c) || c == '_')
897 ; /* just advance */
898 else if (c == '.') {
899 /* we need to deal with consequences of the legacy
900 parser, like "1.nolist" being two tokens
901 (TOK_NUMBER, TOK_ID) here; at least give it
902 a shot for now. In the future, we probably need
903 a flex-based scanner with proper pattern matching
904 to do it as well as it can be done. Nothing in
905 the world is going to help the person who wants
906 0x123.p16 interpreted as two tokens, though. */
907 r = p;
908 while (*r == '_')
909 r++;
911 if (nasm_isdigit(*r) || (is_hex && nasm_isxdigit(*r)) ||
912 (!is_hex && (*r == 'e' || *r == 'E')) ||
913 (*r == 'p' || *r == 'P')) {
914 p = r;
915 is_float = true;
916 } else
917 break; /* Terminate the token */
918 } else
919 break;
921 p--; /* Point to first character beyond number */
923 if (has_e && !is_hex) {
924 /* 1e13 is floating-point, but 1e13h is not */
925 is_float = true;
928 type = is_float ? TOK_FLOAT : TOK_NUMBER;
929 } else if (nasm_isspace(*p)) {
930 type = TOK_WHITESPACE;
931 p++;
932 while (*p && nasm_isspace(*p))
933 p++;
935 * Whitespace just before end-of-line is discarded by
936 * pretending it's a comment; whitespace just before a
937 * comment gets lumped into the comment.
939 if (!*p || *p == ';') {
940 type = TOK_COMMENT;
941 while (*p)
942 p++;
944 } else if (*p == ';') {
945 type = TOK_COMMENT;
946 while (*p)
947 p++;
948 } else {
950 * Anything else is an operator of some kind. We check
951 * for all the double-character operators (>>, <<, //,
952 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
953 * else is a single-character operator.
955 type = TOK_OTHER;
956 if ((p[0] == '>' && p[1] == '>') ||
957 (p[0] == '<' && p[1] == '<') ||
958 (p[0] == '/' && p[1] == '/') ||
959 (p[0] == '<' && p[1] == '=') ||
960 (p[0] == '>' && p[1] == '=') ||
961 (p[0] == '=' && p[1] == '=') ||
962 (p[0] == '!' && p[1] == '=') ||
963 (p[0] == '<' && p[1] == '>') ||
964 (p[0] == '&' && p[1] == '&') ||
965 (p[0] == '|' && p[1] == '|') ||
966 (p[0] == '^' && p[1] == '^')) {
967 p++;
969 p++;
972 /* Handling unterminated string by UNV */
973 /*if (type == -1)
975 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
976 t->text[p-line] = *line;
977 tail = &t->next;
979 else */
980 if (type != TOK_COMMENT) {
981 *tail = t = new_Token(NULL, type, line, p - line);
982 tail = &t->next;
984 line = p;
986 return list;
990 * this function allocates a new managed block of memory and
991 * returns a pointer to the block. The managed blocks are
992 * deleted only all at once by the delete_Blocks function.
994 static void *new_Block(size_t size)
996 Blocks *b = &blocks;
998 /* first, get to the end of the linked list */
999 while (b->next)
1000 b = b->next;
1001 /* now allocate the requested chunk */
1002 b->chunk = nasm_malloc(size);
1004 /* now allocate a new block for the next request */
1005 b->next = nasm_malloc(sizeof(Blocks));
1006 /* and initialize the contents of the new block */
1007 b->next->next = NULL;
1008 b->next->chunk = NULL;
1009 return b->chunk;
1013 * this function deletes all managed blocks of memory
1015 static void delete_Blocks(void)
1017 Blocks *a, *b = &blocks;
1020 * keep in mind that the first block, pointed to by blocks
1021 * is a static and not dynamically allocated, so we don't
1022 * free it.
1024 while (b) {
1025 if (b->chunk)
1026 nasm_free(b->chunk);
1027 a = b;
1028 b = b->next;
1029 if (a != &blocks)
1030 nasm_free(a);
1035 * this function creates a new Token and passes a pointer to it
1036 * back to the caller. It sets the type and text elements, and
1037 * also the a.mac and next elements to NULL.
1039 static Token *new_Token(Token * next, enum pp_token_type type,
1040 const char *text, int txtlen)
1042 Token *t;
1043 int i;
1045 if (freeTokens == NULL) {
1046 freeTokens = (Token *) new_Block(TOKEN_BLOCKSIZE * sizeof(Token));
1047 for (i = 0; i < TOKEN_BLOCKSIZE - 1; i++)
1048 freeTokens[i].next = &freeTokens[i + 1];
1049 freeTokens[i].next = NULL;
1051 t = freeTokens;
1052 freeTokens = t->next;
1053 t->next = next;
1054 t->a.mac = NULL;
1055 t->type = type;
1056 if (type == TOK_WHITESPACE || text == NULL) {
1057 t->text = NULL;
1058 } else {
1059 if (txtlen == 0)
1060 txtlen = strlen(text);
1061 t->text = nasm_malloc(txtlen+1);
1062 memcpy(t->text, text, txtlen);
1063 t->text[txtlen] = '\0';
1065 return t;
1068 static Token *delete_Token(Token * t)
1070 Token *next = t->next;
1071 nasm_free(t->text);
1072 t->next = freeTokens;
1073 freeTokens = t;
1074 return next;
1078 * Convert a line of tokens back into text.
1079 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1080 * will be transformed into ..@ctxnum.xxx
1082 static char *detoken(Token * tlist, bool expand_locals)
1084 Token *t;
1085 int len;
1086 char *line, *p;
1087 const char *q;
1089 len = 0;
1090 for (t = tlist; t; t = t->next) {
1091 if (t->type == TOK_PREPROC_ID && t->text[1] == '!') {
1092 char *p = getenv(t->text + 2);
1093 nasm_free(t->text);
1094 if (p)
1095 t->text = nasm_strdup(p);
1096 else
1097 t->text = NULL;
1099 /* Expand local macros here and not during preprocessing */
1100 if (expand_locals &&
1101 t->type == TOK_PREPROC_ID && t->text &&
1102 t->text[0] == '%' && t->text[1] == '$') {
1103 Context *ctx = get_ctx(t->text, false);
1104 if (ctx) {
1105 char buffer[40];
1106 char *p, *q = t->text + 2;
1108 q += strspn(q, "$");
1109 snprintf(buffer, sizeof(buffer), "..@%"PRIu32".", ctx->number);
1110 p = nasm_strcat(buffer, q);
1111 nasm_free(t->text);
1112 t->text = p;
1115 if (t->type == TOK_WHITESPACE) {
1116 len++;
1117 } else if (t->text) {
1118 len += strlen(t->text);
1121 p = line = nasm_malloc(len + 1);
1122 for (t = tlist; t; t = t->next) {
1123 if (t->type == TOK_WHITESPACE) {
1124 *p++ = ' ';
1125 } else if (t->text) {
1126 q = t->text;
1127 while (*q)
1128 *p++ = *q++;
1131 *p = '\0';
1132 return line;
1136 * A scanner, suitable for use by the expression evaluator, which
1137 * operates on a line of Tokens. Expects a pointer to a pointer to
1138 * the first token in the line to be passed in as its private_data
1139 * field.
1141 * FIX: This really needs to be unified with stdscan.
1143 static int ppscan(void *private_data, struct tokenval *tokval)
1145 Token **tlineptr = private_data;
1146 Token *tline;
1147 char ourcopy[MAX_KEYWORD+1], *p, *r, *s;
1149 do {
1150 tline = *tlineptr;
1151 *tlineptr = tline ? tline->next : NULL;
1153 while (tline && (tline->type == TOK_WHITESPACE ||
1154 tline->type == TOK_COMMENT));
1156 if (!tline)
1157 return tokval->t_type = TOKEN_EOS;
1159 tokval->t_charptr = tline->text;
1161 if (tline->text[0] == '$' && !tline->text[1])
1162 return tokval->t_type = TOKEN_HERE;
1163 if (tline->text[0] == '$' && tline->text[1] == '$' && !tline->text[2])
1164 return tokval->t_type = TOKEN_BASE;
1166 if (tline->type == TOK_ID) {
1167 p = tokval->t_charptr = tline->text;
1168 if (p[0] == '$') {
1169 tokval->t_charptr++;
1170 return tokval->t_type = TOKEN_ID;
1173 for (r = p, s = ourcopy; *r; r++) {
1174 if (r >= p+MAX_KEYWORD)
1175 return tokval->t_type = TOKEN_ID; /* Not a keyword */
1176 *s++ = nasm_tolower(*r);
1178 *s = '\0';
1179 /* right, so we have an identifier sitting in temp storage. now,
1180 * is it actually a register or instruction name, or what? */
1181 return nasm_token_hash(ourcopy, tokval);
1184 if (tline->type == TOK_NUMBER) {
1185 bool rn_error;
1186 tokval->t_integer = readnum(tline->text, &rn_error);
1187 tokval->t_charptr = tline->text;
1188 if (rn_error)
1189 return tokval->t_type = TOKEN_ERRNUM;
1190 else
1191 return tokval->t_type = TOKEN_NUM;
1194 if (tline->type == TOK_FLOAT) {
1195 return tokval->t_type = TOKEN_FLOAT;
1198 if (tline->type == TOK_STRING) {
1199 char bq, *ep;
1201 bq = tline->text[0];
1202 tokval->t_charptr = tline->text;
1203 tokval->t_inttwo = nasm_unquote(tline->text, &ep);
1205 if (ep[0] != bq || ep[1] != '\0')
1206 return tokval->t_type = TOKEN_ERRSTR;
1207 else
1208 return tokval->t_type = TOKEN_STR;
1211 if (tline->type == TOK_OTHER) {
1212 if (!strcmp(tline->text, "<<"))
1213 return tokval->t_type = TOKEN_SHL;
1214 if (!strcmp(tline->text, ">>"))
1215 return tokval->t_type = TOKEN_SHR;
1216 if (!strcmp(tline->text, "//"))
1217 return tokval->t_type = TOKEN_SDIV;
1218 if (!strcmp(tline->text, "%%"))
1219 return tokval->t_type = TOKEN_SMOD;
1220 if (!strcmp(tline->text, "=="))
1221 return tokval->t_type = TOKEN_EQ;
1222 if (!strcmp(tline->text, "<>"))
1223 return tokval->t_type = TOKEN_NE;
1224 if (!strcmp(tline->text, "!="))
1225 return tokval->t_type = TOKEN_NE;
1226 if (!strcmp(tline->text, "<="))
1227 return tokval->t_type = TOKEN_LE;
1228 if (!strcmp(tline->text, ">="))
1229 return tokval->t_type = TOKEN_GE;
1230 if (!strcmp(tline->text, "&&"))
1231 return tokval->t_type = TOKEN_DBL_AND;
1232 if (!strcmp(tline->text, "^^"))
1233 return tokval->t_type = TOKEN_DBL_XOR;
1234 if (!strcmp(tline->text, "||"))
1235 return tokval->t_type = TOKEN_DBL_OR;
1239 * We have no other options: just return the first character of
1240 * the token text.
1242 return tokval->t_type = tline->text[0];
1246 * Compare a string to the name of an existing macro; this is a
1247 * simple wrapper which calls either strcmp or nasm_stricmp
1248 * depending on the value of the `casesense' parameter.
1250 static int mstrcmp(const char *p, const char *q, bool casesense)
1252 return casesense ? strcmp(p, q) : nasm_stricmp(p, q);
1256 * Compare a string to the name of an existing macro; this is a
1257 * simple wrapper which calls either strcmp or nasm_stricmp
1258 * depending on the value of the `casesense' parameter.
1260 static int mmemcmp(const char *p, const char *q, size_t l, bool casesense)
1262 return casesense ? memcmp(p, q, l) : nasm_memicmp(p, q, l);
1266 * Return the Context structure associated with a %$ token. Return
1267 * NULL, having _already_ reported an error condition, if the
1268 * context stack isn't deep enough for the supplied number of $
1269 * signs.
1270 * If all_contexts == true, contexts that enclose current are
1271 * also scanned for such smacro, until it is found; if not -
1272 * only the context that directly results from the number of $'s
1273 * in variable's name.
1275 static Context *get_ctx(const char *name, bool all_contexts)
1277 Context *ctx;
1278 SMacro *m;
1279 int i;
1281 if (!name || name[0] != '%' || name[1] != '$')
1282 return NULL;
1284 if (!cstk) {
1285 error(ERR_NONFATAL, "`%s': context stack is empty", name);
1286 return NULL;
1289 for (i = strspn(name + 2, "$"), ctx = cstk; (i > 0) && ctx; i--) {
1290 ctx = ctx->next;
1291 /* i--; Lino - 02/25/02 */
1293 if (!ctx) {
1294 error(ERR_NONFATAL, "`%s': context stack is only"
1295 " %d level%s deep", name, i - 1, (i == 2 ? "" : "s"));
1296 return NULL;
1298 if (!all_contexts)
1299 return ctx;
1301 do {
1302 /* Search for this smacro in found context */
1303 m = hash_findix(&ctx->localmac, name);
1304 while (m) {
1305 if (!mstrcmp(m->name, name, m->casesense))
1306 return ctx;
1307 m = m->next;
1309 ctx = ctx->next;
1311 while (ctx);
1312 return NULL;
1316 * Check to see if a file is already in a string list
1318 static bool in_list(const StrList *list, const char *str)
1320 while (list) {
1321 if (!strcmp(list->str, str))
1322 return true;
1323 list = list->next;
1325 return false;
1329 * Open an include file. This routine must always return a valid
1330 * file pointer if it returns - it's responsible for throwing an
1331 * ERR_FATAL and bombing out completely if not. It should also try
1332 * the include path one by one until it finds the file or reaches
1333 * the end of the path.
1335 static FILE *inc_fopen(const char *file, StrList **dhead, StrList ***dtail,
1336 bool missing_ok)
1338 FILE *fp;
1339 char *prefix = "";
1340 IncPath *ip = ipath;
1341 int len = strlen(file);
1342 size_t prefix_len = 0;
1343 StrList *sl;
1345 while (1) {
1346 sl = nasm_malloc(prefix_len+len+1+sizeof sl->next);
1347 memcpy(sl->str, prefix, prefix_len);
1348 memcpy(sl->str+prefix_len, file, len+1);
1349 fp = fopen(sl->str, "r");
1350 if (fp && dhead && !in_list(*dhead, sl->str)) {
1351 sl->next = NULL;
1352 **dtail = sl;
1353 *dtail = &sl->next;
1354 } else {
1355 nasm_free(sl);
1357 if (fp)
1358 return fp;
1359 if (!ip) {
1360 if (!missing_ok)
1361 break;
1362 prefix = NULL;
1363 } else {
1364 prefix = ip->path;
1365 ip = ip->next;
1367 if (prefix) {
1368 prefix_len = strlen(prefix);
1369 } else {
1370 /* -MG given and file not found */
1371 if (dhead && !in_list(*dhead, file)) {
1372 sl = nasm_malloc(len+1+sizeof sl->next);
1373 sl->next = NULL;
1374 strcpy(sl->str, file);
1375 **dtail = sl;
1376 *dtail = &sl->next;
1378 return NULL;
1382 error(ERR_FATAL, "unable to open include file `%s'", file);
1383 return NULL; /* never reached - placate compilers */
1387 * Determine if we should warn on defining a single-line macro of
1388 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1389 * return true if _any_ single-line macro of that name is defined.
1390 * Otherwise, will return true if a single-line macro with either
1391 * `nparam' or no parameters is defined.
1393 * If a macro with precisely the right number of parameters is
1394 * defined, or nparam is -1, the address of the definition structure
1395 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1396 * is NULL, no action will be taken regarding its contents, and no
1397 * error will occur.
1399 * Note that this is also called with nparam zero to resolve
1400 * `ifdef'.
1402 * If you already know which context macro belongs to, you can pass
1403 * the context pointer as first parameter; if you won't but name begins
1404 * with %$ the context will be automatically computed. If all_contexts
1405 * is true, macro will be searched in outer contexts as well.
1407 static bool
1408 smacro_defined(Context * ctx, const char *name, int nparam, SMacro ** defn,
1409 bool nocase)
1411 struct hash_table *smtbl;
1412 SMacro *m;
1414 if (ctx) {
1415 smtbl = &ctx->localmac;
1416 } else if (name[0] == '%' && name[1] == '$') {
1417 if (cstk)
1418 ctx = get_ctx(name, false);
1419 if (!ctx)
1420 return false; /* got to return _something_ */
1421 smtbl = &ctx->localmac;
1422 } else {
1423 smtbl = &smacros;
1425 m = (SMacro *) hash_findix(smtbl, name);
1427 while (m) {
1428 if (!mstrcmp(m->name, name, m->casesense && nocase) &&
1429 (nparam <= 0 || m->nparam == 0 || nparam == (int) m->nparam)) {
1430 if (defn) {
1431 if (nparam == (int) m->nparam || nparam == -1)
1432 *defn = m;
1433 else
1434 *defn = NULL;
1436 return true;
1438 m = m->next;
1441 return false;
1445 * Count and mark off the parameters in a multi-line macro call.
1446 * This is called both from within the multi-line macro expansion
1447 * code, and also to mark off the default parameters when provided
1448 * in a %macro definition line.
1450 static void count_mmac_params(Token * t, int *nparam, Token *** params)
1452 int paramsize, brace;
1454 *nparam = paramsize = 0;
1455 *params = NULL;
1456 while (t) {
1457 /* +1: we need space for the final NULL */
1458 if (*nparam+1 >= paramsize) {
1459 paramsize += PARAM_DELTA;
1460 *params = nasm_realloc(*params, sizeof(**params) * paramsize);
1462 skip_white_(t);
1463 brace = false;
1464 if (tok_is_(t, "{"))
1465 brace = true;
1466 (*params)[(*nparam)++] = t;
1467 while (tok_isnt_(t, brace ? "}" : ","))
1468 t = t->next;
1469 if (t) { /* got a comma/brace */
1470 t = t->next;
1471 if (brace) {
1473 * Now we've found the closing brace, look further
1474 * for the comma.
1476 skip_white_(t);
1477 if (tok_isnt_(t, ",")) {
1478 error(ERR_NONFATAL,
1479 "braces do not enclose all of macro parameter");
1480 while (tok_isnt_(t, ","))
1481 t = t->next;
1483 if (t)
1484 t = t->next; /* eat the comma */
1491 * Determine whether one of the various `if' conditions is true or
1492 * not.
1494 * We must free the tline we get passed.
1496 static bool if_condition(Token * tline, enum preproc_token ct)
1498 enum pp_conditional i = PP_COND(ct);
1499 bool j;
1500 Token *t, *tt, **tptr, *origline;
1501 struct tokenval tokval;
1502 expr *evalresult;
1503 enum pp_token_type needtype;
1505 origline = tline;
1507 switch (i) {
1508 case PPC_IFCTX:
1509 j = false; /* have we matched yet? */
1510 while (true) {
1511 skip_white_(tline);
1512 if (!tline)
1513 break;
1514 if (tline->type != TOK_ID) {
1515 error(ERR_NONFATAL,
1516 "`%s' expects context identifiers", pp_directives[ct]);
1517 free_tlist(origline);
1518 return -1;
1520 if (cstk && cstk->name && !nasm_stricmp(tline->text, cstk->name))
1521 j = true;
1522 tline = tline->next;
1524 break;
1526 case PPC_IFDEF:
1527 j = false; /* have we matched yet? */
1528 while (tline) {
1529 skip_white_(tline);
1530 if (!tline || (tline->type != TOK_ID &&
1531 (tline->type != TOK_PREPROC_ID ||
1532 tline->text[1] != '$'))) {
1533 error(ERR_NONFATAL,
1534 "`%s' expects macro identifiers", pp_directives[ct]);
1535 goto fail;
1537 if (smacro_defined(NULL, tline->text, 0, NULL, true))
1538 j = true;
1539 tline = tline->next;
1541 break;
1543 case PPC_IFIDN:
1544 case PPC_IFIDNI:
1545 tline = expand_smacro(tline);
1546 t = tt = tline;
1547 while (tok_isnt_(tt, ","))
1548 tt = tt->next;
1549 if (!tt) {
1550 error(ERR_NONFATAL,
1551 "`%s' expects two comma-separated arguments",
1552 pp_directives[ct]);
1553 goto fail;
1555 tt = tt->next;
1556 j = true; /* assume equality unless proved not */
1557 while ((t->type != TOK_OTHER || strcmp(t->text, ",")) && tt) {
1558 if (tt->type == TOK_OTHER && !strcmp(tt->text, ",")) {
1559 error(ERR_NONFATAL, "`%s': more than one comma on line",
1560 pp_directives[ct]);
1561 goto fail;
1563 if (t->type == TOK_WHITESPACE) {
1564 t = t->next;
1565 continue;
1567 if (tt->type == TOK_WHITESPACE) {
1568 tt = tt->next;
1569 continue;
1571 if (tt->type != t->type) {
1572 j = false; /* found mismatching tokens */
1573 break;
1575 /* When comparing strings, need to unquote them first */
1576 if (t->type == TOK_STRING) {
1577 size_t l1 = nasm_unquote(t->text, NULL);
1578 size_t l2 = nasm_unquote(tt->text, NULL);
1580 if (l1 != l2) {
1581 j = false;
1582 break;
1584 if (mmemcmp(t->text, tt->text, l1, i == PPC_IFIDN)) {
1585 j = false;
1586 break;
1588 } else if (mstrcmp(tt->text, t->text, i == PPC_IFIDN) != 0) {
1589 j = false; /* found mismatching tokens */
1590 break;
1593 t = t->next;
1594 tt = tt->next;
1596 if ((t->type != TOK_OTHER || strcmp(t->text, ",")) || tt)
1597 j = false; /* trailing gunk on one end or other */
1598 break;
1600 case PPC_IFMACRO:
1602 bool found = false;
1603 MMacro searching, *mmac;
1605 tline = tline->next;
1606 skip_white_(tline);
1607 tline = expand_id(tline);
1608 if (!tok_type_(tline, TOK_ID)) {
1609 error(ERR_NONFATAL,
1610 "`%s' expects a macro name", pp_directives[ct]);
1611 goto fail;
1613 searching.name = nasm_strdup(tline->text);
1614 searching.casesense = true;
1615 searching.plus = false;
1616 searching.nolist = false;
1617 searching.in_progress = 0;
1618 searching.rep_nest = NULL;
1619 searching.nparam_min = 0;
1620 searching.nparam_max = INT_MAX;
1621 tline = expand_smacro(tline->next);
1622 skip_white_(tline);
1623 if (!tline) {
1624 } else if (!tok_type_(tline, TOK_NUMBER)) {
1625 error(ERR_NONFATAL,
1626 "`%s' expects a parameter count or nothing",
1627 pp_directives[ct]);
1628 } else {
1629 searching.nparam_min = searching.nparam_max =
1630 readnum(tline->text, &j);
1631 if (j)
1632 error(ERR_NONFATAL,
1633 "unable to parse parameter count `%s'",
1634 tline->text);
1636 if (tline && tok_is_(tline->next, "-")) {
1637 tline = tline->next->next;
1638 if (tok_is_(tline, "*"))
1639 searching.nparam_max = INT_MAX;
1640 else if (!tok_type_(tline, TOK_NUMBER))
1641 error(ERR_NONFATAL,
1642 "`%s' expects a parameter count after `-'",
1643 pp_directives[ct]);
1644 else {
1645 searching.nparam_max = readnum(tline->text, &j);
1646 if (j)
1647 error(ERR_NONFATAL,
1648 "unable to parse parameter count `%s'",
1649 tline->text);
1650 if (searching.nparam_min > searching.nparam_max)
1651 error(ERR_NONFATAL,
1652 "minimum parameter count exceeds maximum");
1655 if (tline && tok_is_(tline->next, "+")) {
1656 tline = tline->next;
1657 searching.plus = true;
1659 mmac = (MMacro *) hash_findix(&mmacros, searching.name);
1660 while (mmac) {
1661 if (!strcmp(mmac->name, searching.name) &&
1662 (mmac->nparam_min <= searching.nparam_max
1663 || searching.plus)
1664 && (searching.nparam_min <= mmac->nparam_max
1665 || mmac->plus)) {
1666 found = true;
1667 break;
1669 mmac = mmac->next;
1671 if(tline && tline->next)
1672 error(ERR_WARNING|ERR_PASS1,
1673 "trailing garbage after %%ifmacro ignored");
1674 nasm_free(searching.name);
1675 j = found;
1676 break;
1679 case PPC_IFID:
1680 needtype = TOK_ID;
1681 goto iftype;
1682 case PPC_IFNUM:
1683 needtype = TOK_NUMBER;
1684 goto iftype;
1685 case PPC_IFSTR:
1686 needtype = TOK_STRING;
1687 goto iftype;
1689 iftype:
1690 t = tline = expand_smacro(tline);
1692 while (tok_type_(t, TOK_WHITESPACE) ||
1693 (needtype == TOK_NUMBER &&
1694 tok_type_(t, TOK_OTHER) &&
1695 (t->text[0] == '-' || t->text[0] == '+') &&
1696 !t->text[1]))
1697 t = t->next;
1699 j = tok_type_(t, needtype);
1700 break;
1702 case PPC_IFTOKEN:
1703 t = tline = expand_smacro(tline);
1704 while (tok_type_(t, TOK_WHITESPACE))
1705 t = t->next;
1707 j = false;
1708 if (t) {
1709 t = t->next; /* Skip the actual token */
1710 while (tok_type_(t, TOK_WHITESPACE))
1711 t = t->next;
1712 j = !t; /* Should be nothing left */
1714 break;
1716 case PPC_IFEMPTY:
1717 t = tline = expand_smacro(tline);
1718 while (tok_type_(t, TOK_WHITESPACE))
1719 t = t->next;
1721 j = !t; /* Should be empty */
1722 break;
1724 case PPC_IF:
1725 t = tline = expand_smacro(tline);
1726 tptr = &t;
1727 tokval.t_type = TOKEN_INVALID;
1728 evalresult = evaluate(ppscan, tptr, &tokval,
1729 NULL, pass | CRITICAL, error, NULL);
1730 if (!evalresult)
1731 return -1;
1732 if (tokval.t_type)
1733 error(ERR_WARNING|ERR_PASS1,
1734 "trailing garbage after expression ignored");
1735 if (!is_simple(evalresult)) {
1736 error(ERR_NONFATAL,
1737 "non-constant value given to `%s'", pp_directives[ct]);
1738 goto fail;
1740 j = reloc_value(evalresult) != 0;
1741 break;
1743 default:
1744 error(ERR_FATAL,
1745 "preprocessor directive `%s' not yet implemented",
1746 pp_directives[ct]);
1747 goto fail;
1750 free_tlist(origline);
1751 return j ^ PP_NEGATIVE(ct);
1753 fail:
1754 free_tlist(origline);
1755 return -1;
1759 * Common code for defining an smacro
1761 static bool define_smacro(Context *ctx, char *mname, bool casesense,
1762 int nparam, Token *expansion)
1764 SMacro *smac, **smhead;
1765 struct hash_table *smtbl;
1767 if (smacro_defined(ctx, mname, nparam, &smac, casesense)) {
1768 if (!smac) {
1769 error(ERR_WARNING|ERR_PASS1,
1770 "single-line macro `%s' defined both with and"
1771 " without parameters", mname);
1773 /* Some instances of the old code considered this a failure,
1774 some others didn't. What is the right thing to do here? */
1775 free_tlist(expansion);
1776 return false; /* Failure */
1777 } else {
1779 * We're redefining, so we have to take over an
1780 * existing SMacro structure. This means freeing
1781 * what was already in it.
1783 nasm_free(smac->name);
1784 free_tlist(smac->expansion);
1786 } else {
1787 smtbl = ctx ? &ctx->localmac : &smacros;
1788 smhead = (SMacro **) hash_findi_add(smtbl, mname);
1789 smac = nasm_malloc(sizeof(SMacro));
1790 smac->next = *smhead;
1791 *smhead = smac;
1793 smac->name = nasm_strdup(mname);
1794 smac->casesense = casesense;
1795 smac->nparam = nparam;
1796 smac->expansion = expansion;
1797 smac->in_progress = false;
1798 return true; /* Success */
1802 * Undefine an smacro
1804 static void undef_smacro(Context *ctx, const char *mname)
1806 SMacro **smhead, *s, **sp;
1807 struct hash_table *smtbl;
1809 smtbl = ctx ? &ctx->localmac : &smacros;
1810 smhead = (SMacro **)hash_findi(smtbl, mname, NULL);
1812 if (smhead) {
1814 * We now have a macro name... go hunt for it.
1816 sp = smhead;
1817 while ((s = *sp) != NULL) {
1818 if (!mstrcmp(s->name, mname, s->casesense)) {
1819 *sp = s->next;
1820 nasm_free(s->name);
1821 free_tlist(s->expansion);
1822 nasm_free(s);
1823 } else {
1824 sp = &s->next;
1831 * Parse a mmacro specification.
1833 static bool parse_mmacro_spec(Token *tline, MMacro *def, const char *directive)
1835 bool err;
1837 tline = tline->next;
1838 skip_white_(tline);
1839 tline = expand_id(tline);
1840 if (!tok_type_(tline, TOK_ID)) {
1841 error(ERR_NONFATAL, "`%s' expects a macro name", directive);
1842 return false;
1845 def->name = nasm_strdup(tline->text);
1846 def->plus = false;
1847 def->nolist = false;
1848 def->in_progress = 0;
1849 def->rep_nest = NULL;
1850 def->nparam_min = 0;
1851 def->nparam_max = 0;
1853 tline = expand_smacro(tline->next);
1854 skip_white_(tline);
1855 if (!tok_type_(tline, TOK_NUMBER)) {
1856 error(ERR_NONFATAL, "`%s' expects a parameter count", directive);
1857 } else {
1858 def->nparam_min = def->nparam_max =
1859 readnum(tline->text, &err);
1860 if (err)
1861 error(ERR_NONFATAL,
1862 "unable to parse parameter count `%s'", tline->text);
1864 if (tline && tok_is_(tline->next, "-")) {
1865 tline = tline->next->next;
1866 if (tok_is_(tline, "*")) {
1867 def->nparam_max = INT_MAX;
1868 } else if (!tok_type_(tline, TOK_NUMBER)) {
1869 error(ERR_NONFATAL,
1870 "`%s' expects a parameter count after `-'", directive);
1871 } else {
1872 def->nparam_max = readnum(tline->text, &err);
1873 if (err) {
1874 error(ERR_NONFATAL, "unable to parse parameter count `%s'",
1875 tline->text);
1877 if (def->nparam_min > def->nparam_max) {
1878 error(ERR_NONFATAL, "minimum parameter count exceeds maximum");
1882 if (tline && tok_is_(tline->next, "+")) {
1883 tline = tline->next;
1884 def->plus = true;
1886 if (tline && tok_type_(tline->next, TOK_ID) &&
1887 !nasm_stricmp(tline->next->text, ".nolist")) {
1888 tline = tline->next;
1889 def->nolist = true;
1893 * Handle default parameters.
1895 if (tline && tline->next) {
1896 def->dlist = tline->next;
1897 tline->next = NULL;
1898 count_mmac_params(def->dlist, &def->ndefs, &def->defaults);
1899 } else {
1900 def->dlist = NULL;
1901 def->defaults = NULL;
1903 def->expansion = NULL;
1905 if(def->defaults &&
1906 def->ndefs > def->nparam_max - def->nparam_min &&
1907 !def->plus)
1908 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MDP,
1909 "too many default macro parameters");
1911 return true;
1916 * Decode a size directive
1918 static int parse_size(const char *str) {
1919 static const char *size_names[] =
1920 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
1921 static const int sizes[] =
1922 { 0, 1, 4, 16, 8, 10, 2, 32 };
1924 return sizes[bsii(str, size_names, elements(size_names))+1];
1928 * find and process preprocessor directive in passed line
1929 * Find out if a line contains a preprocessor directive, and deal
1930 * with it if so.
1932 * If a directive _is_ found, it is the responsibility of this routine
1933 * (and not the caller) to free_tlist() the line.
1935 * @param tline a pointer to the current tokeninzed line linked list
1936 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
1939 static int do_directive(Token * tline)
1941 enum preproc_token i;
1942 int j;
1943 bool err;
1944 int nparam;
1945 bool nolist;
1946 bool casesense;
1947 int k, m;
1948 int offset;
1949 char *p, *pp, *mname;
1950 Include *inc;
1951 Context *ctx;
1952 Cond *cond;
1953 MMacro *mmac, **mmhead;
1954 Token *t, *tt, *param_start, *macro_start, *last, **tptr, *origline;
1955 Line *l;
1956 struct tokenval tokval;
1957 expr *evalresult;
1958 MMacro *tmp_defining; /* Used when manipulating rep_nest */
1959 int64_t count;
1960 size_t len;
1961 int severity;
1963 origline = tline;
1965 skip_white_(tline);
1966 if (!tline || !tok_type_(tline, TOK_PREPROC_ID) ||
1967 (tline->text[1] == '%' || tline->text[1] == '$'
1968 || tline->text[1] == '!'))
1969 return NO_DIRECTIVE_FOUND;
1971 i = pp_token_hash(tline->text);
1974 * If we're in a non-emitting branch of a condition construct,
1975 * or walking to the end of an already terminated %rep block,
1976 * we should ignore all directives except for condition
1977 * directives.
1979 if (((istk->conds && !emitting(istk->conds->state)) ||
1980 (istk->mstk && !istk->mstk->in_progress)) && !is_condition(i)) {
1981 return NO_DIRECTIVE_FOUND;
1985 * If we're defining a macro or reading a %rep block, we should
1986 * ignore all directives except for %macro/%imacro (which nest),
1987 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
1988 * If we're in a %rep block, another %rep nests, so should be let through.
1990 if (defining && i != PP_MACRO && i != PP_IMACRO &&
1991 i != PP_ENDMACRO && i != PP_ENDM &&
1992 (defining->name || (i != PP_ENDREP && i != PP_REP))) {
1993 return NO_DIRECTIVE_FOUND;
1996 if (defining) {
1997 if (i == PP_MACRO || i == PP_IMACRO) {
1998 nested_mac_count++;
1999 return NO_DIRECTIVE_FOUND;
2000 } else if (nested_mac_count > 0) {
2001 if (i == PP_ENDMACRO) {
2002 nested_mac_count--;
2003 return NO_DIRECTIVE_FOUND;
2006 if (!defining->name) {
2007 if (i == PP_REP) {
2008 nested_rep_count++;
2009 return NO_DIRECTIVE_FOUND;
2010 } else if (nested_rep_count > 0) {
2011 if (i == PP_ENDREP) {
2012 nested_rep_count--;
2013 return NO_DIRECTIVE_FOUND;
2019 switch (i) {
2020 case PP_INVALID:
2021 error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2022 tline->text);
2023 return NO_DIRECTIVE_FOUND; /* didn't get it */
2025 case PP_STACKSIZE:
2026 /* Directive to tell NASM what the default stack size is. The
2027 * default is for a 16-bit stack, and this can be overriden with
2028 * %stacksize large.
2029 * the following form:
2031 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2033 tline = tline->next;
2034 if (tline && tline->type == TOK_WHITESPACE)
2035 tline = tline->next;
2036 if (!tline || tline->type != TOK_ID) {
2037 error(ERR_NONFATAL, "`%%stacksize' missing size parameter");
2038 free_tlist(origline);
2039 return DIRECTIVE_FOUND;
2041 if (nasm_stricmp(tline->text, "flat") == 0) {
2042 /* All subsequent ARG directives are for a 32-bit stack */
2043 StackSize = 4;
2044 StackPointer = "ebp";
2045 ArgOffset = 8;
2046 LocalOffset = 0;
2047 } else if (nasm_stricmp(tline->text, "flat64") == 0) {
2048 /* All subsequent ARG directives are for a 64-bit stack */
2049 StackSize = 8;
2050 StackPointer = "rbp";
2051 ArgOffset = 8;
2052 LocalOffset = 0;
2053 } else if (nasm_stricmp(tline->text, "large") == 0) {
2054 /* All subsequent ARG directives are for a 16-bit stack,
2055 * far function call.
2057 StackSize = 2;
2058 StackPointer = "bp";
2059 ArgOffset = 4;
2060 LocalOffset = 0;
2061 } else if (nasm_stricmp(tline->text, "small") == 0) {
2062 /* All subsequent ARG directives are for a 16-bit stack,
2063 * far function call. We don't support near functions.
2065 StackSize = 2;
2066 StackPointer = "bp";
2067 ArgOffset = 6;
2068 LocalOffset = 0;
2069 } else {
2070 error(ERR_NONFATAL, "`%%stacksize' invalid size type");
2071 free_tlist(origline);
2072 return DIRECTIVE_FOUND;
2074 free_tlist(origline);
2075 return DIRECTIVE_FOUND;
2077 case PP_ARG:
2078 /* TASM like ARG directive to define arguments to functions, in
2079 * the following form:
2081 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2083 offset = ArgOffset;
2084 do {
2085 char *arg, directive[256];
2086 int size = StackSize;
2088 /* Find the argument name */
2089 tline = tline->next;
2090 if (tline && tline->type == TOK_WHITESPACE)
2091 tline = tline->next;
2092 if (!tline || tline->type != TOK_ID) {
2093 error(ERR_NONFATAL, "`%%arg' missing argument parameter");
2094 free_tlist(origline);
2095 return DIRECTIVE_FOUND;
2097 arg = tline->text;
2099 /* Find the argument size type */
2100 tline = tline->next;
2101 if (!tline || tline->type != TOK_OTHER
2102 || tline->text[0] != ':') {
2103 error(ERR_NONFATAL,
2104 "Syntax error processing `%%arg' directive");
2105 free_tlist(origline);
2106 return DIRECTIVE_FOUND;
2108 tline = tline->next;
2109 if (!tline || tline->type != TOK_ID) {
2110 error(ERR_NONFATAL, "`%%arg' missing size type parameter");
2111 free_tlist(origline);
2112 return DIRECTIVE_FOUND;
2115 /* Allow macro expansion of type parameter */
2116 tt = tokenize(tline->text);
2117 tt = expand_smacro(tt);
2118 size = parse_size(tt->text);
2119 if (!size) {
2120 error(ERR_NONFATAL,
2121 "Invalid size type for `%%arg' missing directive");
2122 free_tlist(tt);
2123 free_tlist(origline);
2124 return DIRECTIVE_FOUND;
2126 free_tlist(tt);
2128 /* Round up to even stack slots */
2129 size = (size+StackSize-1) & ~(StackSize-1);
2131 /* Now define the macro for the argument */
2132 snprintf(directive, sizeof(directive), "%%define %s (%s+%d)",
2133 arg, StackPointer, offset);
2134 do_directive(tokenize(directive));
2135 offset += size;
2137 /* Move to the next argument in the list */
2138 tline = tline->next;
2139 if (tline && tline->type == TOK_WHITESPACE)
2140 tline = tline->next;
2141 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2142 ArgOffset = offset;
2143 free_tlist(origline);
2144 return DIRECTIVE_FOUND;
2146 case PP_LOCAL:
2147 /* TASM like LOCAL directive to define local variables for a
2148 * function, in the following form:
2150 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2152 * The '= LocalSize' at the end is ignored by NASM, but is
2153 * required by TASM to define the local parameter size (and used
2154 * by the TASM macro package).
2156 offset = LocalOffset;
2157 do {
2158 char *local, directive[256];
2159 int size = StackSize;
2161 /* Find the argument name */
2162 tline = tline->next;
2163 if (tline && tline->type == TOK_WHITESPACE)
2164 tline = tline->next;
2165 if (!tline || tline->type != TOK_ID) {
2166 error(ERR_NONFATAL,
2167 "`%%local' missing argument parameter");
2168 free_tlist(origline);
2169 return DIRECTIVE_FOUND;
2171 local = tline->text;
2173 /* Find the argument size type */
2174 tline = tline->next;
2175 if (!tline || tline->type != TOK_OTHER
2176 || tline->text[0] != ':') {
2177 error(ERR_NONFATAL,
2178 "Syntax error processing `%%local' directive");
2179 free_tlist(origline);
2180 return DIRECTIVE_FOUND;
2182 tline = tline->next;
2183 if (!tline || tline->type != TOK_ID) {
2184 error(ERR_NONFATAL,
2185 "`%%local' missing size type parameter");
2186 free_tlist(origline);
2187 return DIRECTIVE_FOUND;
2190 /* Allow macro expansion of type parameter */
2191 tt = tokenize(tline->text);
2192 tt = expand_smacro(tt);
2193 size = parse_size(tt->text);
2194 if (!size) {
2195 error(ERR_NONFATAL,
2196 "Invalid size type for `%%local' missing directive");
2197 free_tlist(tt);
2198 free_tlist(origline);
2199 return DIRECTIVE_FOUND;
2201 free_tlist(tt);
2203 /* Round up to even stack slots */
2204 size = (size+StackSize-1) & ~(StackSize-1);
2206 offset += size; /* Negative offset, increment before */
2208 /* Now define the macro for the argument */
2209 snprintf(directive, sizeof(directive), "%%define %s (%s-%d)",
2210 local, StackPointer, offset);
2211 do_directive(tokenize(directive));
2213 /* Now define the assign to setup the enter_c macro correctly */
2214 snprintf(directive, sizeof(directive),
2215 "%%assign %%$localsize %%$localsize+%d", size);
2216 do_directive(tokenize(directive));
2218 /* Move to the next argument in the list */
2219 tline = tline->next;
2220 if (tline && tline->type == TOK_WHITESPACE)
2221 tline = tline->next;
2222 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2223 LocalOffset = offset;
2224 free_tlist(origline);
2225 return DIRECTIVE_FOUND;
2227 case PP_CLEAR:
2228 if (tline->next)
2229 error(ERR_WARNING|ERR_PASS1,
2230 "trailing garbage after `%%clear' ignored");
2231 free_macros();
2232 init_macros();
2233 free_tlist(origline);
2234 return DIRECTIVE_FOUND;
2236 case PP_DEPEND:
2237 t = tline->next = expand_smacro(tline->next);
2238 skip_white_(t);
2239 if (!t || (t->type != TOK_STRING &&
2240 t->type != TOK_INTERNAL_STRING)) {
2241 error(ERR_NONFATAL, "`%%depend' expects a file name");
2242 free_tlist(origline);
2243 return DIRECTIVE_FOUND; /* but we did _something_ */
2245 if (t->next)
2246 error(ERR_WARNING|ERR_PASS1,
2247 "trailing garbage after `%%depend' ignored");
2248 p = t->text;
2249 if (t->type != TOK_INTERNAL_STRING)
2250 nasm_unquote(p, NULL);
2251 if (dephead && !in_list(*dephead, p)) {
2252 StrList *sl = nasm_malloc(strlen(p)+1+sizeof sl->next);
2253 sl->next = NULL;
2254 strcpy(sl->str, p);
2255 *deptail = sl;
2256 deptail = &sl->next;
2258 free_tlist(origline);
2259 return DIRECTIVE_FOUND;
2261 case PP_INCLUDE:
2262 t = tline->next = expand_smacro(tline->next);
2263 skip_white_(t);
2265 if (!t || (t->type != TOK_STRING &&
2266 t->type != TOK_INTERNAL_STRING)) {
2267 error(ERR_NONFATAL, "`%%include' expects a file name");
2268 free_tlist(origline);
2269 return DIRECTIVE_FOUND; /* but we did _something_ */
2271 if (t->next)
2272 error(ERR_WARNING|ERR_PASS1,
2273 "trailing garbage after `%%include' ignored");
2274 p = t->text;
2275 if (t->type != TOK_INTERNAL_STRING)
2276 nasm_unquote(p, NULL);
2277 inc = nasm_malloc(sizeof(Include));
2278 inc->next = istk;
2279 inc->conds = NULL;
2280 inc->fp = inc_fopen(p, dephead, &deptail, pass == 0);
2281 if (!inc->fp) {
2282 /* -MG given but file not found */
2283 nasm_free(inc);
2284 } else {
2285 inc->fname = src_set_fname(nasm_strdup(p));
2286 inc->lineno = src_set_linnum(0);
2287 inc->lineinc = 1;
2288 inc->expansion = NULL;
2289 inc->mstk = NULL;
2290 istk = inc;
2291 list->uplevel(LIST_INCLUDE);
2293 free_tlist(origline);
2294 return DIRECTIVE_FOUND;
2296 case PP_USE:
2298 static macros_t *use_pkg;
2299 const char *pkg_macro;
2301 t = tline->next = expand_smacro(tline->next);
2302 skip_white_(t);
2304 if (!t || (t->type != TOK_STRING &&
2305 t->type != TOK_INTERNAL_STRING &&
2306 t->type != TOK_ID)) {
2307 error(ERR_NONFATAL, "`%%use' expects a package name");
2308 free_tlist(origline);
2309 return DIRECTIVE_FOUND; /* but we did _something_ */
2311 if (t->next)
2312 error(ERR_WARNING|ERR_PASS1,
2313 "trailing garbage after `%%use' ignored");
2314 if (t->type == TOK_STRING)
2315 nasm_unquote(t->text, NULL);
2316 use_pkg = nasm_stdmac_find_package(t->text);
2317 if (!use_pkg)
2318 error(ERR_NONFATAL, "unknown `%%use' package: %s", t->text);
2319 /* The first string will be <%define>__USE_*__ */
2320 pkg_macro = (char *)use_pkg + 1;
2321 if (!smacro_defined(NULL, pkg_macro, 0, NULL, true)) {
2322 /* Not already included, go ahead and include it */
2323 stdmacpos = use_pkg;
2325 free_tlist(origline);
2326 return DIRECTIVE_FOUND;
2328 case PP_PUSH:
2329 tline = tline->next;
2330 skip_white_(tline);
2331 tline = expand_id(tline);
2332 if (tline) {
2333 if (!tok_type_(tline, TOK_ID)) {
2334 error(ERR_NONFATAL, "`%%push' expects a context identifier");
2335 free_tlist(origline);
2336 return DIRECTIVE_FOUND; /* but we did _something_ */
2338 if (tline->next)
2339 error(ERR_WARNING|ERR_PASS1,
2340 "trailing garbage after `%%push' ignored");
2341 p = nasm_strdup(tline->text);
2342 } else {
2343 p = NULL; /* Anonymous context */
2345 ctx = nasm_malloc(sizeof(Context));
2346 ctx->next = cstk;
2347 hash_init(&ctx->localmac, HASH_SMALL);
2348 ctx->name = p;
2349 ctx->number = unique++;
2350 cstk = ctx;
2351 free_tlist(origline);
2352 return DIRECTIVE_FOUND;
2354 case PP_REPL:
2355 tline = tline->next;
2356 skip_white_(tline);
2357 tline = expand_id(tline);
2358 if (tline) {
2359 if (!tok_type_(tline, TOK_ID)) {
2360 error(ERR_NONFATAL, "`%%repl' expects a context identifier");
2361 free_tlist(origline);
2362 return DIRECTIVE_FOUND; /* but we did _something_ */
2364 if (tline->next)
2365 error(ERR_WARNING|ERR_PASS1,
2366 "trailing garbage after `%%repl' ignored");
2367 p = nasm_strdup(tline->text);
2368 } else {
2369 p = NULL;
2371 if (!cstk)
2372 error(ERR_NONFATAL, "`%%repl': context stack is empty");
2373 else {
2374 nasm_free(cstk->name);
2375 cstk->name = p;
2377 free_tlist(origline);
2378 return DIRECTIVE_FOUND;
2380 case PP_POP:
2381 if (tline->next)
2382 error(ERR_WARNING|ERR_PASS1,
2383 "trailing garbage after `%%pop' ignored");
2384 if (!cstk)
2385 error(ERR_NONFATAL, "`%%pop': context stack is already empty");
2386 else
2387 ctx_pop();
2388 free_tlist(origline);
2389 return DIRECTIVE_FOUND;
2391 case PP_FATAL:
2392 severity = ERR_FATAL|ERR_NO_SEVERITY;
2393 goto issue_error;
2394 case PP_ERROR:
2395 severity = ERR_NONFATAL|ERR_NO_SEVERITY;
2396 goto issue_error;
2397 case PP_WARNING:
2398 severity = ERR_WARNING|ERR_NO_SEVERITY|ERR_WARN_USER;
2399 goto issue_error;
2401 issue_error:
2403 /* Only error out if this is the final pass */
2404 if (pass != 2 && i != PP_FATAL)
2405 return DIRECTIVE_FOUND;
2407 tline->next = expand_smacro(tline->next);
2408 tline = tline->next;
2409 skip_white_(tline);
2410 t = tline ? tline->next : NULL;
2411 skip_white_(t);
2412 if (tok_type_(tline, TOK_STRING) && !t) {
2413 /* The line contains only a quoted string */
2414 p = tline->text;
2415 nasm_unquote(p, NULL);
2416 error(severity, "%s: %s", pp_directives[i], p);
2417 } else {
2418 /* Not a quoted string, or more than a quoted string */
2419 p = detoken(tline, false);
2420 error(severity, "%s: %s", pp_directives[i], p);
2421 nasm_free(p);
2423 free_tlist(origline);
2424 return DIRECTIVE_FOUND;
2427 CASE_PP_IF:
2428 if (istk->conds && !emitting(istk->conds->state))
2429 j = COND_NEVER;
2430 else {
2431 j = if_condition(tline->next, i);
2432 tline->next = NULL; /* it got freed */
2433 j = j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2435 cond = nasm_malloc(sizeof(Cond));
2436 cond->next = istk->conds;
2437 cond->state = j;
2438 istk->conds = cond;
2439 free_tlist(origline);
2440 return DIRECTIVE_FOUND;
2442 CASE_PP_ELIF:
2443 if (!istk->conds)
2444 error(ERR_FATAL, "`%s': no matching `%%if'", pp_directives[i]);
2445 switch(istk->conds->state) {
2446 case COND_IF_TRUE:
2447 istk->conds->state = COND_DONE;
2448 break;
2450 case COND_DONE:
2451 case COND_NEVER:
2452 break;
2454 case COND_ELSE_TRUE:
2455 case COND_ELSE_FALSE:
2456 error_precond(ERR_WARNING|ERR_PASS1,
2457 "`%%elif' after `%%else' ignored");
2458 istk->conds->state = COND_NEVER;
2459 break;
2461 case COND_IF_FALSE:
2463 * IMPORTANT: In the case of %if, we will already have
2464 * called expand_mmac_params(); however, if we're
2465 * processing an %elif we must have been in a
2466 * non-emitting mode, which would have inhibited
2467 * the normal invocation of expand_indirect() and
2468 * expand_mmac_params(). Therefore, we have to do it
2469 * explicitly here.
2471 t = expand_indirect(tline->next,0);
2472 t = expand_mmac_params(t);
2473 j = if_condition(expand_mmac_params(t), i);
2474 tline->next = NULL; /* it got freed */
2475 istk->conds->state =
2476 j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2477 break;
2479 free_tlist(origline);
2480 return DIRECTIVE_FOUND;
2482 case PP_ELSE:
2483 if (tline->next)
2484 error_precond(ERR_WARNING|ERR_PASS1,
2485 "trailing garbage after `%%else' ignored");
2486 if (!istk->conds)
2487 error(ERR_FATAL, "`%%else': no matching `%%if'");
2488 switch(istk->conds->state) {
2489 case COND_IF_TRUE:
2490 case COND_DONE:
2491 istk->conds->state = COND_ELSE_FALSE;
2492 break;
2494 case COND_NEVER:
2495 break;
2497 case COND_IF_FALSE:
2498 istk->conds->state = COND_ELSE_TRUE;
2499 break;
2501 case COND_ELSE_TRUE:
2502 case COND_ELSE_FALSE:
2503 error_precond(ERR_WARNING|ERR_PASS1,
2504 "`%%else' after `%%else' ignored.");
2505 istk->conds->state = COND_NEVER;
2506 break;
2508 free_tlist(origline);
2509 return DIRECTIVE_FOUND;
2511 case PP_ENDIF:
2512 if (tline->next)
2513 error_precond(ERR_WARNING|ERR_PASS1,
2514 "trailing garbage after `%%endif' ignored");
2515 if (!istk->conds)
2516 error(ERR_FATAL, "`%%endif': no matching `%%if'");
2517 cond = istk->conds;
2518 istk->conds = cond->next;
2519 nasm_free(cond);
2520 free_tlist(origline);
2521 return DIRECTIVE_FOUND;
2523 case PP_MACRO:
2524 case PP_IMACRO:
2525 if (defining) {
2526 error(ERR_FATAL,
2527 "`%%%smacro': already defining a macro",
2528 (i == PP_IMACRO ? "i" : ""));
2529 return DIRECTIVE_FOUND;
2531 defining = nasm_malloc(sizeof(MMacro));
2532 defining->casesense = (i == PP_MACRO);
2533 if (!parse_mmacro_spec(tline, defining, pp_directives[i])) {
2534 nasm_free(defining);
2535 defining = NULL;
2536 return DIRECTIVE_FOUND;
2539 mmac = (MMacro *) hash_findix(&mmacros, defining->name);
2540 while (mmac) {
2541 if (!strcmp(mmac->name, defining->name) &&
2542 (mmac->nparam_min <= defining->nparam_max
2543 || defining->plus)
2544 && (defining->nparam_min <= mmac->nparam_max
2545 || mmac->plus)) {
2546 error(ERR_WARNING|ERR_PASS1,
2547 "redefining multi-line macro `%s'", defining->name);
2548 return DIRECTIVE_FOUND;
2550 mmac = mmac->next;
2552 free_tlist(origline);
2553 return DIRECTIVE_FOUND;
2555 case PP_ENDM:
2556 case PP_ENDMACRO:
2557 if (! (defining && defining->name)) {
2558 error(ERR_NONFATAL, "`%s': not defining a macro", tline->text);
2559 return DIRECTIVE_FOUND;
2561 mmhead = (MMacro **) hash_findi_add(&mmacros, defining->name);
2562 defining->next = *mmhead;
2563 *mmhead = defining;
2564 defining = NULL;
2565 free_tlist(origline);
2566 return DIRECTIVE_FOUND;
2568 case PP_UNMACRO:
2569 case PP_UNIMACRO:
2571 MMacro **mmac_p;
2572 MMacro spec;
2574 spec.casesense = (i == PP_UNMACRO);
2575 if (!parse_mmacro_spec(tline, &spec, pp_directives[i])) {
2576 return DIRECTIVE_FOUND;
2578 mmac_p = (MMacro **) hash_findi(&mmacros, spec.name, NULL);
2579 while (mmac_p && *mmac_p) {
2580 mmac = *mmac_p;
2581 if (mmac->casesense == spec.casesense &&
2582 !mstrcmp(mmac->name, spec.name, spec.casesense) &&
2583 mmac->nparam_min == spec.nparam_min &&
2584 mmac->nparam_max == spec.nparam_max &&
2585 mmac->plus == spec.plus) {
2586 *mmac_p = mmac->next;
2587 free_mmacro(mmac);
2588 } else {
2589 mmac_p = &mmac->next;
2592 free_tlist(origline);
2593 free_tlist(spec.dlist);
2594 return DIRECTIVE_FOUND;
2597 case PP_ROTATE:
2598 if (tline->next && tline->next->type == TOK_WHITESPACE)
2599 tline = tline->next;
2600 if (tline->next == NULL) {
2601 free_tlist(origline);
2602 error(ERR_NONFATAL, "`%%rotate' missing rotate count");
2603 return DIRECTIVE_FOUND;
2605 t = expand_smacro(tline->next);
2606 tline->next = NULL;
2607 free_tlist(origline);
2608 tline = t;
2609 tptr = &t;
2610 tokval.t_type = TOKEN_INVALID;
2611 evalresult =
2612 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2613 free_tlist(tline);
2614 if (!evalresult)
2615 return DIRECTIVE_FOUND;
2616 if (tokval.t_type)
2617 error(ERR_WARNING|ERR_PASS1,
2618 "trailing garbage after expression ignored");
2619 if (!is_simple(evalresult)) {
2620 error(ERR_NONFATAL, "non-constant value given to `%%rotate'");
2621 return DIRECTIVE_FOUND;
2623 mmac = istk->mstk;
2624 while (mmac && !mmac->name) /* avoid mistaking %reps for macros */
2625 mmac = mmac->next_active;
2626 if (!mmac) {
2627 error(ERR_NONFATAL, "`%%rotate' invoked outside a macro call");
2628 } else if (mmac->nparam == 0) {
2629 error(ERR_NONFATAL,
2630 "`%%rotate' invoked within macro without parameters");
2631 } else {
2632 int rotate = mmac->rotate + reloc_value(evalresult);
2634 rotate %= (int)mmac->nparam;
2635 if (rotate < 0)
2636 rotate += mmac->nparam;
2638 mmac->rotate = rotate;
2640 return DIRECTIVE_FOUND;
2642 case PP_REP:
2643 nolist = false;
2644 do {
2645 tline = tline->next;
2646 } while (tok_type_(tline, TOK_WHITESPACE));
2648 if (tok_type_(tline, TOK_ID) &&
2649 nasm_stricmp(tline->text, ".nolist") == 0) {
2650 nolist = true;
2651 do {
2652 tline = tline->next;
2653 } while (tok_type_(tline, TOK_WHITESPACE));
2656 if (tline) {
2657 t = expand_smacro(tline);
2658 tptr = &t;
2659 tokval.t_type = TOKEN_INVALID;
2660 evalresult =
2661 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2662 if (!evalresult) {
2663 free_tlist(origline);
2664 return DIRECTIVE_FOUND;
2666 if (tokval.t_type)
2667 error(ERR_WARNING|ERR_PASS1,
2668 "trailing garbage after expression ignored");
2669 if (!is_simple(evalresult)) {
2670 error(ERR_NONFATAL, "non-constant value given to `%%rep'");
2671 return DIRECTIVE_FOUND;
2673 count = reloc_value(evalresult) + 1;
2674 } else {
2675 error(ERR_NONFATAL, "`%%rep' expects a repeat count");
2676 count = 0;
2678 free_tlist(origline);
2680 tmp_defining = defining;
2681 defining = nasm_malloc(sizeof(MMacro));
2682 defining->name = NULL; /* flags this macro as a %rep block */
2683 defining->casesense = false;
2684 defining->plus = false;
2685 defining->nolist = nolist;
2686 defining->in_progress = count;
2687 defining->nparam_min = defining->nparam_max = 0;
2688 defining->defaults = NULL;
2689 defining->dlist = NULL;
2690 defining->expansion = NULL;
2691 defining->next_active = istk->mstk;
2692 defining->rep_nest = tmp_defining;
2693 return DIRECTIVE_FOUND;
2695 case PP_ENDREP:
2696 if (!defining || defining->name) {
2697 error(ERR_NONFATAL, "`%%endrep': no matching `%%rep'");
2698 return DIRECTIVE_FOUND;
2702 * Now we have a "macro" defined - although it has no name
2703 * and we won't be entering it in the hash tables - we must
2704 * push a macro-end marker for it on to istk->expansion.
2705 * After that, it will take care of propagating itself (a
2706 * macro-end marker line for a macro which is really a %rep
2707 * block will cause the macro to be re-expanded, complete
2708 * with another macro-end marker to ensure the process
2709 * continues) until the whole expansion is forcibly removed
2710 * from istk->expansion by a %exitrep.
2712 l = nasm_malloc(sizeof(Line));
2713 l->next = istk->expansion;
2714 l->finishes = defining;
2715 l->first = NULL;
2716 istk->expansion = l;
2718 istk->mstk = defining;
2720 list->uplevel(defining->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
2721 tmp_defining = defining;
2722 defining = defining->rep_nest;
2723 free_tlist(origline);
2724 return DIRECTIVE_FOUND;
2726 case PP_EXITREP:
2728 * We must search along istk->expansion until we hit a
2729 * macro-end marker for a macro with no name. Then we set
2730 * its `in_progress' flag to 0.
2732 for (l = istk->expansion; l; l = l->next)
2733 if (l->finishes && !l->finishes->name)
2734 break;
2736 if (l)
2737 l->finishes->in_progress = 1;
2738 else
2739 error(ERR_NONFATAL, "`%%exitrep' not within `%%rep' block");
2740 free_tlist(origline);
2741 return DIRECTIVE_FOUND;
2743 case PP_XDEFINE:
2744 case PP_IXDEFINE:
2745 case PP_DEFINE:
2746 case PP_IDEFINE:
2747 casesense = (i == PP_DEFINE || i == PP_XDEFINE);
2749 tline = tline->next;
2750 skip_white_(tline);
2751 tline = expand_id(tline);
2752 if (!tline || (tline->type != TOK_ID &&
2753 (tline->type != TOK_PREPROC_ID ||
2754 tline->text[1] != '$'))) {
2755 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2756 pp_directives[i]);
2757 free_tlist(origline);
2758 return DIRECTIVE_FOUND;
2761 ctx = get_ctx(tline->text, false);
2763 mname = tline->text;
2764 last = tline;
2765 param_start = tline = tline->next;
2766 nparam = 0;
2768 /* Expand the macro definition now for %xdefine and %ixdefine */
2769 if ((i == PP_XDEFINE) || (i == PP_IXDEFINE))
2770 tline = expand_smacro(tline);
2772 if (tok_is_(tline, "(")) {
2774 * This macro has parameters.
2777 tline = tline->next;
2778 while (1) {
2779 skip_white_(tline);
2780 if (!tline) {
2781 error(ERR_NONFATAL, "parameter identifier expected");
2782 free_tlist(origline);
2783 return DIRECTIVE_FOUND;
2785 if (tline->type != TOK_ID) {
2786 error(ERR_NONFATAL,
2787 "`%s': parameter identifier expected",
2788 tline->text);
2789 free_tlist(origline);
2790 return DIRECTIVE_FOUND;
2792 tline->type = TOK_SMAC_PARAM + nparam++;
2793 tline = tline->next;
2794 skip_white_(tline);
2795 if (tok_is_(tline, ",")) {
2796 tline = tline->next;
2797 } else {
2798 if (!tok_is_(tline, ")")) {
2799 error(ERR_NONFATAL,
2800 "`)' expected to terminate macro template");
2801 free_tlist(origline);
2802 return DIRECTIVE_FOUND;
2804 break;
2807 last = tline;
2808 tline = tline->next;
2810 if (tok_type_(tline, TOK_WHITESPACE))
2811 last = tline, tline = tline->next;
2812 macro_start = NULL;
2813 last->next = NULL;
2814 t = tline;
2815 while (t) {
2816 if (t->type == TOK_ID) {
2817 for (tt = param_start; tt; tt = tt->next)
2818 if (tt->type >= TOK_SMAC_PARAM &&
2819 !strcmp(tt->text, t->text))
2820 t->type = tt->type;
2822 tt = t->next;
2823 t->next = macro_start;
2824 macro_start = t;
2825 t = tt;
2828 * Good. We now have a macro name, a parameter count, and a
2829 * token list (in reverse order) for an expansion. We ought
2830 * to be OK just to create an SMacro, store it, and let
2831 * free_tlist have the rest of the line (which we have
2832 * carefully re-terminated after chopping off the expansion
2833 * from the end).
2835 define_smacro(ctx, mname, casesense, nparam, macro_start);
2836 free_tlist(origline);
2837 return DIRECTIVE_FOUND;
2839 case PP_UNDEF:
2840 tline = tline->next;
2841 skip_white_(tline);
2842 tline = expand_id(tline);
2843 if (!tline || (tline->type != TOK_ID &&
2844 (tline->type != TOK_PREPROC_ID ||
2845 tline->text[1] != '$'))) {
2846 error(ERR_NONFATAL, "`%%undef' expects a macro identifier");
2847 free_tlist(origline);
2848 return DIRECTIVE_FOUND;
2850 if (tline->next) {
2851 error(ERR_WARNING|ERR_PASS1,
2852 "trailing garbage after macro name ignored");
2855 /* Find the context that symbol belongs to */
2856 ctx = get_ctx(tline->text, false);
2857 undef_smacro(ctx, tline->text);
2858 free_tlist(origline);
2859 return DIRECTIVE_FOUND;
2861 case PP_DEFSTR:
2862 case PP_IDEFSTR:
2863 casesense = (i == PP_DEFSTR);
2865 tline = tline->next;
2866 skip_white_(tline);
2867 tline = expand_id(tline);
2868 if (!tline || (tline->type != TOK_ID &&
2869 (tline->type != TOK_PREPROC_ID ||
2870 tline->text[1] != '$'))) {
2871 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2872 pp_directives[i]);
2873 free_tlist(origline);
2874 return DIRECTIVE_FOUND;
2877 ctx = get_ctx(tline->text, false);
2879 mname = tline->text;
2880 last = tline;
2881 tline = expand_smacro(tline->next);
2882 last->next = NULL;
2884 while (tok_type_(tline, TOK_WHITESPACE))
2885 tline = delete_Token(tline);
2887 p = detoken(tline, false);
2888 macro_start = nasm_malloc(sizeof(*macro_start));
2889 macro_start->next = NULL;
2890 macro_start->text = nasm_quote(p, strlen(p));
2891 macro_start->type = TOK_STRING;
2892 macro_start->a.mac = NULL;
2893 nasm_free(p);
2896 * We now have a macro name, an implicit parameter count of
2897 * zero, and a string token to use as an expansion. Create
2898 * and store an SMacro.
2900 define_smacro(ctx, mname, casesense, 0, macro_start);
2901 free_tlist(origline);
2902 return DIRECTIVE_FOUND;
2904 case PP_PATHSEARCH:
2906 FILE *fp;
2907 StrList *xsl = NULL;
2908 StrList **xst = &xsl;
2910 casesense = true;
2912 tline = tline->next;
2913 skip_white_(tline);
2914 tline = expand_id(tline);
2915 if (!tline || (tline->type != TOK_ID &&
2916 (tline->type != TOK_PREPROC_ID ||
2917 tline->text[1] != '$'))) {
2918 error(ERR_NONFATAL,
2919 "`%%pathsearch' expects a macro identifier as first parameter");
2920 free_tlist(origline);
2921 return DIRECTIVE_FOUND;
2923 ctx = get_ctx(tline->text, false);
2925 mname = tline->text;
2926 last = tline;
2927 tline = expand_smacro(tline->next);
2928 last->next = NULL;
2930 t = tline;
2931 while (tok_type_(t, TOK_WHITESPACE))
2932 t = t->next;
2934 if (!t || (t->type != TOK_STRING &&
2935 t->type != TOK_INTERNAL_STRING)) {
2936 error(ERR_NONFATAL, "`%%pathsearch' expects a file name");
2937 free_tlist(tline);
2938 free_tlist(origline);
2939 return DIRECTIVE_FOUND; /* but we did _something_ */
2941 if (t->next)
2942 error(ERR_WARNING|ERR_PASS1,
2943 "trailing garbage after `%%pathsearch' ignored");
2944 p = t->text;
2945 if (t->type != TOK_INTERNAL_STRING)
2946 nasm_unquote(p, NULL);
2948 fp = inc_fopen(p, &xsl, &xst, true);
2949 if (fp) {
2950 p = xsl->str;
2951 fclose(fp); /* Don't actually care about the file */
2953 macro_start = nasm_malloc(sizeof(*macro_start));
2954 macro_start->next = NULL;
2955 macro_start->text = nasm_quote(p, strlen(p));
2956 macro_start->type = TOK_STRING;
2957 macro_start->a.mac = NULL;
2958 if (xsl)
2959 nasm_free(xsl);
2962 * We now have a macro name, an implicit parameter count of
2963 * zero, and a string token to use as an expansion. Create
2964 * and store an SMacro.
2966 define_smacro(ctx, mname, casesense, 0, macro_start);
2967 free_tlist(tline);
2968 free_tlist(origline);
2969 return DIRECTIVE_FOUND;
2972 case PP_STRLEN:
2973 casesense = true;
2975 tline = tline->next;
2976 skip_white_(tline);
2977 tline = expand_id(tline);
2978 if (!tline || (tline->type != TOK_ID &&
2979 (tline->type != TOK_PREPROC_ID ||
2980 tline->text[1] != '$'))) {
2981 error(ERR_NONFATAL,
2982 "`%%strlen' expects a macro identifier as first parameter");
2983 free_tlist(origline);
2984 return DIRECTIVE_FOUND;
2986 ctx = get_ctx(tline->text, false);
2988 mname = tline->text;
2989 last = tline;
2990 tline = expand_smacro(tline->next);
2991 last->next = NULL;
2993 t = tline;
2994 while (tok_type_(t, TOK_WHITESPACE))
2995 t = t->next;
2996 /* t should now point to the string */
2997 if (t->type != TOK_STRING) {
2998 error(ERR_NONFATAL,
2999 "`%%strlen` requires string as second parameter");
3000 free_tlist(tline);
3001 free_tlist(origline);
3002 return DIRECTIVE_FOUND;
3005 macro_start = nasm_malloc(sizeof(*macro_start));
3006 macro_start->next = NULL;
3007 make_tok_num(macro_start, nasm_unquote(t->text, NULL));
3008 macro_start->a.mac = NULL;
3011 * We now have a macro name, an implicit parameter count of
3012 * zero, and a numeric token to use as an expansion. Create
3013 * and store an SMacro.
3015 define_smacro(ctx, mname, casesense, 0, macro_start);
3016 free_tlist(tline);
3017 free_tlist(origline);
3018 return DIRECTIVE_FOUND;
3020 case PP_STRCAT:
3021 casesense = true;
3023 tline = tline->next;
3024 skip_white_(tline);
3025 tline = expand_id(tline);
3026 if (!tline || (tline->type != TOK_ID &&
3027 (tline->type != TOK_PREPROC_ID ||
3028 tline->text[1] != '$'))) {
3029 error(ERR_NONFATAL,
3030 "`%%strcat' expects a macro identifier as first parameter");
3031 free_tlist(origline);
3032 return DIRECTIVE_FOUND;
3034 ctx = get_ctx(tline->text, false);
3036 mname = tline->text;
3037 last = tline;
3038 tline = expand_smacro(tline->next);
3039 last->next = NULL;
3041 len = 0;
3042 for (t = tline; t; t = t->next) {
3043 switch (t->type) {
3044 case TOK_WHITESPACE:
3045 break;
3046 case TOK_STRING:
3047 len += t->a.len = nasm_unquote(t->text, NULL);
3048 break;
3049 case TOK_OTHER:
3050 if (!strcmp(t->text, ",")) /* permit comma separators */
3051 break;
3052 /* else fall through */
3053 default:
3054 error(ERR_NONFATAL,
3055 "non-string passed to `%%strcat' (%d)", t->type);
3056 free_tlist(tline);
3057 free_tlist(origline);
3058 return DIRECTIVE_FOUND;
3062 p = pp = nasm_malloc(len);
3063 t = tline;
3064 for (t = tline; t; t = t->next) {
3065 if (t->type == TOK_STRING) {
3066 memcpy(p, t->text, t->a.len);
3067 p += t->a.len;
3072 * We now have a macro name, an implicit parameter count of
3073 * zero, and a numeric token to use as an expansion. Create
3074 * and store an SMacro.
3076 macro_start = new_Token(NULL, TOK_STRING, NULL, 0);
3077 macro_start->text = nasm_quote(pp, len);
3078 nasm_free(pp);
3079 define_smacro(ctx, mname, casesense, 0, macro_start);
3080 free_tlist(tline);
3081 free_tlist(origline);
3082 return DIRECTIVE_FOUND;
3084 case PP_SUBSTR:
3086 int64_t a1, a2;
3087 size_t len;
3089 casesense = true;
3091 tline = tline->next;
3092 skip_white_(tline);
3093 tline = expand_id(tline);
3094 if (!tline || (tline->type != TOK_ID &&
3095 (tline->type != TOK_PREPROC_ID ||
3096 tline->text[1] != '$'))) {
3097 error(ERR_NONFATAL,
3098 "`%%substr' expects a macro identifier as first parameter");
3099 free_tlist(origline);
3100 return DIRECTIVE_FOUND;
3102 ctx = get_ctx(tline->text, false);
3104 mname = tline->text;
3105 last = tline;
3106 tline = expand_smacro(tline->next);
3107 last->next = NULL;
3109 t = tline->next;
3110 while (tok_type_(t, TOK_WHITESPACE))
3111 t = t->next;
3113 /* t should now point to the string */
3114 if (t->type != TOK_STRING) {
3115 error(ERR_NONFATAL,
3116 "`%%substr` requires string as second parameter");
3117 free_tlist(tline);
3118 free_tlist(origline);
3119 return DIRECTIVE_FOUND;
3122 tt = t->next;
3123 tptr = &tt;
3124 tokval.t_type = TOKEN_INVALID;
3125 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3126 pass, error, NULL);
3127 if (!evalresult) {
3128 free_tlist(tline);
3129 free_tlist(origline);
3130 return DIRECTIVE_FOUND;
3131 } else if (!is_simple(evalresult)) {
3132 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3133 free_tlist(tline);
3134 free_tlist(origline);
3135 return DIRECTIVE_FOUND;
3137 a1 = evalresult->value-1;
3139 while (tok_type_(tt, TOK_WHITESPACE))
3140 tt = tt->next;
3141 if (!tt) {
3142 a2 = 1; /* Backwards compatibility: one character */
3143 } else {
3144 tokval.t_type = TOKEN_INVALID;
3145 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3146 pass, error, NULL);
3147 if (!evalresult) {
3148 free_tlist(tline);
3149 free_tlist(origline);
3150 return DIRECTIVE_FOUND;
3151 } else if (!is_simple(evalresult)) {
3152 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3153 free_tlist(tline);
3154 free_tlist(origline);
3155 return DIRECTIVE_FOUND;
3157 a2 = evalresult->value;
3160 len = nasm_unquote(t->text, NULL);
3161 if (a2 < 0)
3162 a2 = a2+1+len-a1;
3163 if (a1+a2 > (int64_t)len)
3164 a2 = len-a1;
3166 macro_start = nasm_malloc(sizeof(*macro_start));
3167 macro_start->next = NULL;
3168 macro_start->text = nasm_quote((a1 < 0) ? "" : t->text+a1, a2);
3169 macro_start->type = TOK_STRING;
3170 macro_start->a.mac = NULL;
3173 * We now have a macro name, an implicit parameter count of
3174 * zero, and a numeric token to use as an expansion. Create
3175 * and store an SMacro.
3177 define_smacro(ctx, mname, casesense, 0, macro_start);
3178 free_tlist(tline);
3179 free_tlist(origline);
3180 return DIRECTIVE_FOUND;
3183 case PP_ASSIGN:
3184 case PP_IASSIGN:
3185 casesense = (i == PP_ASSIGN);
3187 tline = tline->next;
3188 skip_white_(tline);
3189 tline = expand_id(tline);
3190 if (!tline || (tline->type != TOK_ID &&
3191 (tline->type != TOK_PREPROC_ID ||
3192 tline->text[1] != '$'))) {
3193 error(ERR_NONFATAL,
3194 "`%%%sassign' expects a macro identifier",
3195 (i == PP_IASSIGN ? "i" : ""));
3196 free_tlist(origline);
3197 return DIRECTIVE_FOUND;
3199 ctx = get_ctx(tline->text, false);
3201 mname = tline->text;
3202 last = tline;
3203 tline = expand_smacro(tline->next);
3204 last->next = NULL;
3206 t = tline;
3207 tptr = &t;
3208 tokval.t_type = TOKEN_INVALID;
3209 evalresult =
3210 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
3211 free_tlist(tline);
3212 if (!evalresult) {
3213 free_tlist(origline);
3214 return DIRECTIVE_FOUND;
3217 if (tokval.t_type)
3218 error(ERR_WARNING|ERR_PASS1,
3219 "trailing garbage after expression ignored");
3221 if (!is_simple(evalresult)) {
3222 error(ERR_NONFATAL,
3223 "non-constant value given to `%%%sassign'",
3224 (i == PP_IASSIGN ? "i" : ""));
3225 free_tlist(origline);
3226 return DIRECTIVE_FOUND;
3229 macro_start = nasm_malloc(sizeof(*macro_start));
3230 macro_start->next = NULL;
3231 make_tok_num(macro_start, reloc_value(evalresult));
3232 macro_start->a.mac = NULL;
3235 * We now have a macro name, an implicit parameter count of
3236 * zero, and a numeric token to use as an expansion. Create
3237 * and store an SMacro.
3239 define_smacro(ctx, mname, casesense, 0, macro_start);
3240 free_tlist(origline);
3241 return DIRECTIVE_FOUND;
3243 case PP_LINE:
3245 * Syntax is `%line nnn[+mmm] [filename]'
3247 tline = tline->next;
3248 skip_white_(tline);
3249 if (!tok_type_(tline, TOK_NUMBER)) {
3250 error(ERR_NONFATAL, "`%%line' expects line number");
3251 free_tlist(origline);
3252 return DIRECTIVE_FOUND;
3254 k = readnum(tline->text, &err);
3255 m = 1;
3256 tline = tline->next;
3257 if (tok_is_(tline, "+")) {
3258 tline = tline->next;
3259 if (!tok_type_(tline, TOK_NUMBER)) {
3260 error(ERR_NONFATAL, "`%%line' expects line increment");
3261 free_tlist(origline);
3262 return DIRECTIVE_FOUND;
3264 m = readnum(tline->text, &err);
3265 tline = tline->next;
3267 skip_white_(tline);
3268 src_set_linnum(k);
3269 istk->lineinc = m;
3270 if (tline) {
3271 nasm_free(src_set_fname(detoken(tline, false)));
3273 free_tlist(origline);
3274 return DIRECTIVE_FOUND;
3276 default:
3277 error(ERR_FATAL,
3278 "preprocessor directive `%s' not yet implemented",
3279 pp_directives[i]);
3280 return DIRECTIVE_FOUND;
3285 * Ensure that a macro parameter contains a condition code and
3286 * nothing else. Return the condition code index if so, or -1
3287 * otherwise.
3289 static int find_cc(Token * t)
3291 Token *tt;
3292 int i, j, k, m;
3294 if (!t)
3295 return -1; /* Probably a %+ without a space */
3297 skip_white_(t);
3298 if (t->type != TOK_ID)
3299 return -1;
3300 tt = t->next;
3301 skip_white_(tt);
3302 if (tt && (tt->type != TOK_OTHER || strcmp(tt->text, ",")))
3303 return -1;
3305 i = -1;
3306 j = elements(conditions);
3307 while (j - i > 1) {
3308 k = (j + i) / 2;
3309 m = nasm_stricmp(t->text, conditions[k]);
3310 if (m == 0) {
3311 i = k;
3312 j = -2;
3313 break;
3314 } else if (m < 0) {
3315 j = k;
3316 } else
3317 i = k;
3319 if (j != -2)
3320 return -1;
3321 return i;
3325 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3326 * %-n) and MMacro-local identifiers (%%foo).
3328 static Token *expand_mmac_params(Token * tline)
3330 Token *t, *tt, **tail, *thead;
3332 tail = &thead;
3333 thead = NULL;
3335 while (tline) {
3336 if (tline->type == TOK_PREPROC_ID &&
3337 (((tline->text[1] == '+' || tline->text[1] == '-')
3338 && tline->text[2]) || tline->text[1] == '%'
3339 || (tline->text[1] >= '0' && tline->text[1] <= '9'))) {
3340 char *text = NULL;
3341 int type = 0, cc; /* type = 0 to placate optimisers */
3342 char tmpbuf[30];
3343 unsigned int n;
3344 int i;
3345 MMacro *mac;
3347 t = tline;
3348 tline = tline->next;
3350 mac = istk->mstk;
3351 while (mac && !mac->name) /* avoid mistaking %reps for macros */
3352 mac = mac->next_active;
3353 if (!mac)
3354 error(ERR_NONFATAL, "`%s': not in a macro call", t->text);
3355 else
3356 switch (t->text[1]) {
3358 * We have to make a substitution of one of the
3359 * forms %1, %-1, %+1, %%foo, %0.
3361 case '0':
3362 type = TOK_NUMBER;
3363 snprintf(tmpbuf, sizeof(tmpbuf), "%d", mac->nparam);
3364 text = nasm_strdup(tmpbuf);
3365 break;
3366 case '%':
3367 type = TOK_ID;
3368 snprintf(tmpbuf, sizeof(tmpbuf), "..@%"PRIu64".",
3369 mac->unique);
3370 text = nasm_strcat(tmpbuf, t->text + 2);
3371 break;
3372 case '-':
3373 n = atoi(t->text + 2) - 1;
3374 if (n >= mac->nparam)
3375 tt = NULL;
3376 else {
3377 if (mac->nparam > 1)
3378 n = (n + mac->rotate) % mac->nparam;
3379 tt = mac->params[n];
3381 cc = find_cc(tt);
3382 if (cc == -1) {
3383 error(ERR_NONFATAL,
3384 "macro parameter %d is not a condition code",
3385 n + 1);
3386 text = NULL;
3387 } else {
3388 type = TOK_ID;
3389 if (inverse_ccs[cc] == -1) {
3390 error(ERR_NONFATAL,
3391 "condition code `%s' is not invertible",
3392 conditions[cc]);
3393 text = NULL;
3394 } else
3395 text =
3396 nasm_strdup(conditions[inverse_ccs[cc]]);
3398 break;
3399 case '+':
3400 n = atoi(t->text + 2) - 1;
3401 if (n >= mac->nparam)
3402 tt = NULL;
3403 else {
3404 if (mac->nparam > 1)
3405 n = (n + mac->rotate) % mac->nparam;
3406 tt = mac->params[n];
3408 cc = find_cc(tt);
3409 if (cc == -1) {
3410 error(ERR_NONFATAL,
3411 "macro parameter %d is not a condition code",
3412 n + 1);
3413 text = NULL;
3414 } else {
3415 type = TOK_ID;
3416 text = nasm_strdup(conditions[cc]);
3418 break;
3419 default:
3420 n = atoi(t->text + 1) - 1;
3421 if (n >= mac->nparam)
3422 tt = NULL;
3423 else {
3424 if (mac->nparam > 1)
3425 n = (n + mac->rotate) % mac->nparam;
3426 tt = mac->params[n];
3428 if (tt) {
3429 for (i = 0; i < mac->paramlen[n]; i++) {
3430 *tail = new_Token(NULL, tt->type, tt->text, 0);
3431 tail = &(*tail)->next;
3432 tt = tt->next;
3435 text = NULL; /* we've done it here */
3436 break;
3438 if (!text) {
3439 delete_Token(t);
3440 } else {
3441 *tail = t;
3442 tail = &t->next;
3443 t->type = type;
3444 nasm_free(t->text);
3445 t->text = text;
3446 t->a.mac = NULL;
3448 continue;
3449 } else {
3450 t = *tail = tline;
3451 tline = tline->next;
3452 t->a.mac = NULL;
3453 tail = &t->next;
3456 *tail = NULL;
3457 t = thead;
3458 for (; t && (tt = t->next) != NULL; t = t->next)
3459 switch (t->type) {
3460 case TOK_WHITESPACE:
3461 if (tt->type == TOK_WHITESPACE) {
3462 t->next = delete_Token(tt);
3464 break;
3465 case TOK_ID:
3466 case TOK_NUMBER:
3467 if (tt->type == t->type || tt->type == TOK_NUMBER) {
3468 char *tmp = nasm_strcat(t->text, tt->text);
3469 nasm_free(t->text);
3470 t->text = tmp;
3471 t->next = delete_Token(tt);
3473 break;
3474 default:
3475 break;
3478 return thead;
3482 * Expand all single-line macro calls made in the given line.
3483 * Return the expanded version of the line. The original is deemed
3484 * to be destroyed in the process. (In reality we'll just move
3485 * Tokens from input to output a lot of the time, rather than
3486 * actually bothering to destroy and replicate.)
3488 #define DEADMAN_LIMIT (1 << 20)
3490 static Token *expand_smacro(Token * tline)
3492 Token *t, *tt, *mstart, **tail, *thead;
3493 struct hash_table *smtbl;
3494 SMacro *head = NULL, *m;
3495 Token **params;
3496 int *paramsize;
3497 unsigned int nparam, sparam;
3498 int brackets, rescan;
3499 Token *org_tline = tline;
3500 Context *ctx;
3501 char *mname;
3502 int deadman = DEADMAN_LIMIT;
3505 * Trick: we should avoid changing the start token pointer since it can
3506 * be contained in "next" field of other token. Because of this
3507 * we allocate a copy of first token and work with it; at the end of
3508 * routine we copy it back
3510 if (org_tline) {
3511 tline =
3512 new_Token(org_tline->next, org_tline->type, org_tline->text,
3514 tline->a.mac = org_tline->a.mac;
3515 nasm_free(org_tline->text);
3516 org_tline->text = NULL;
3519 again:
3520 tail = &thead;
3521 thead = NULL;
3523 while (tline) { /* main token loop */
3524 if (!--deadman) {
3525 error(ERR_NONFATAL, "interminable macro recursion");
3526 break;
3529 if ((mname = tline->text)) {
3530 /* if this token is a local macro, look in local context */
3531 ctx = NULL;
3532 smtbl = &smacros;
3533 if (tline->type == TOK_ID || tline->type == TOK_PREPROC_ID) {
3534 ctx = get_ctx(mname, true);
3535 if (ctx)
3536 smtbl = &ctx->localmac;
3538 head = (SMacro *) hash_findix(smtbl, mname);
3541 * We've hit an identifier. As in is_mmacro below, we first
3542 * check whether the identifier is a single-line macro at
3543 * all, then think about checking for parameters if
3544 * necessary.
3546 for (m = head; m; m = m->next)
3547 if (!mstrcmp(m->name, mname, m->casesense))
3548 break;
3549 if (m) {
3550 mstart = tline;
3551 params = NULL;
3552 paramsize = NULL;
3553 if (m->nparam == 0) {
3555 * Simple case: the macro is parameterless. Discard the
3556 * one token that the macro call took, and push the
3557 * expansion back on the to-do stack.
3559 if (!m->expansion) {
3560 if (!strcmp("__FILE__", m->name)) {
3561 int32_t num = 0;
3562 char *file = NULL;
3563 src_get(&num, &file);
3564 tline->text = nasm_quote(file, strlen(file));
3565 tline->type = TOK_STRING;
3566 nasm_free(file);
3567 continue;
3569 if (!strcmp("__LINE__", m->name)) {
3570 nasm_free(tline->text);
3571 make_tok_num(tline, src_get_linnum());
3572 continue;
3574 if (!strcmp("__BITS__", m->name)) {
3575 nasm_free(tline->text);
3576 make_tok_num(tline, globalbits);
3577 continue;
3579 tline = delete_Token(tline);
3580 continue;
3582 } else {
3584 * Complicated case: at least one macro with this name
3585 * exists and takes parameters. We must find the
3586 * parameters in the call, count them, find the SMacro
3587 * that corresponds to that form of the macro call, and
3588 * substitute for the parameters when we expand. What a
3589 * pain.
3591 /*tline = tline->next;
3592 skip_white_(tline); */
3593 do {
3594 t = tline->next;
3595 while (tok_type_(t, TOK_SMAC_END)) {
3596 t->a.mac->in_progress = false;
3597 t->text = NULL;
3598 t = tline->next = delete_Token(t);
3600 tline = t;
3601 } while (tok_type_(tline, TOK_WHITESPACE));
3602 if (!tok_is_(tline, "(")) {
3604 * This macro wasn't called with parameters: ignore
3605 * the call. (Behaviour borrowed from gnu cpp.)
3607 tline = mstart;
3608 m = NULL;
3609 } else {
3610 int paren = 0;
3611 int white = 0;
3612 brackets = 0;
3613 nparam = 0;
3614 sparam = PARAM_DELTA;
3615 params = nasm_malloc(sparam * sizeof(Token *));
3616 params[0] = tline->next;
3617 paramsize = nasm_malloc(sparam * sizeof(int));
3618 paramsize[0] = 0;
3619 while (true) { /* parameter loop */
3621 * For some unusual expansions
3622 * which concatenates function call
3624 t = tline->next;
3625 while (tok_type_(t, TOK_SMAC_END)) {
3626 t->a.mac->in_progress = false;
3627 t->text = NULL;
3628 t = tline->next = delete_Token(t);
3630 tline = t;
3632 if (!tline) {
3633 error(ERR_NONFATAL,
3634 "macro call expects terminating `)'");
3635 break;
3637 if (tline->type == TOK_WHITESPACE
3638 && brackets <= 0) {
3639 if (paramsize[nparam])
3640 white++;
3641 else
3642 params[nparam] = tline->next;
3643 continue; /* parameter loop */
3645 if (tline->type == TOK_OTHER
3646 && tline->text[1] == 0) {
3647 char ch = tline->text[0];
3648 if (ch == ',' && !paren && brackets <= 0) {
3649 if (++nparam >= sparam) {
3650 sparam += PARAM_DELTA;
3651 params = nasm_realloc(params,
3652 sparam *
3653 sizeof(Token
3654 *));
3655 paramsize =
3656 nasm_realloc(paramsize,
3657 sparam *
3658 sizeof(int));
3660 params[nparam] = tline->next;
3661 paramsize[nparam] = 0;
3662 white = 0;
3663 continue; /* parameter loop */
3665 if (ch == '{' &&
3666 (brackets > 0 || (brackets == 0 &&
3667 !paramsize[nparam])))
3669 if (!(brackets++)) {
3670 params[nparam] = tline->next;
3671 continue; /* parameter loop */
3674 if (ch == '}' && brackets > 0)
3675 if (--brackets == 0) {
3676 brackets = -1;
3677 continue; /* parameter loop */
3679 if (ch == '(' && !brackets)
3680 paren++;
3681 if (ch == ')' && brackets <= 0)
3682 if (--paren < 0)
3683 break;
3685 if (brackets < 0) {
3686 brackets = 0;
3687 error(ERR_NONFATAL, "braces do not "
3688 "enclose all of macro parameter");
3690 paramsize[nparam] += white + 1;
3691 white = 0;
3692 } /* parameter loop */
3693 nparam++;
3694 while (m && (m->nparam != nparam ||
3695 mstrcmp(m->name, mname,
3696 m->casesense)))
3697 m = m->next;
3698 if (!m)
3699 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
3700 "macro `%s' exists, "
3701 "but not taking %d parameters",
3702 mstart->text, nparam);
3705 if (m && m->in_progress)
3706 m = NULL;
3707 if (!m) { /* in progess or didn't find '(' or wrong nparam */
3709 * Design question: should we handle !tline, which
3710 * indicates missing ')' here, or expand those
3711 * macros anyway, which requires the (t) test a few
3712 * lines down?
3714 nasm_free(params);
3715 nasm_free(paramsize);
3716 tline = mstart;
3717 } else {
3719 * Expand the macro: we are placed on the last token of the
3720 * call, so that we can easily split the call from the
3721 * following tokens. We also start by pushing an SMAC_END
3722 * token for the cycle removal.
3724 t = tline;
3725 if (t) {
3726 tline = t->next;
3727 t->next = NULL;
3729 tt = new_Token(tline, TOK_SMAC_END, NULL, 0);
3730 tt->a.mac = m;
3731 m->in_progress = true;
3732 tline = tt;
3733 for (t = m->expansion; t; t = t->next) {
3734 if (t->type >= TOK_SMAC_PARAM) {
3735 Token *pcopy = tline, **ptail = &pcopy;
3736 Token *ttt, *pt;
3737 int i;
3739 ttt = params[t->type - TOK_SMAC_PARAM];
3740 for (i = paramsize[t->type - TOK_SMAC_PARAM];
3741 --i >= 0;) {
3742 pt = *ptail =
3743 new_Token(tline, ttt->type, ttt->text,
3745 ptail = &pt->next;
3746 ttt = ttt->next;
3748 tline = pcopy;
3749 } else if (t->type == TOK_PREPROC_Q) {
3750 tt = new_Token(tline, TOK_ID, mname, 0);
3751 tline = tt;
3752 } else if (t->type == TOK_PREPROC_QQ) {
3753 tt = new_Token(tline, TOK_ID, m->name, 0);
3754 tline = tt;
3755 } else {
3756 tt = new_Token(tline, t->type, t->text, 0);
3757 tline = tt;
3762 * Having done that, get rid of the macro call, and clean
3763 * up the parameters.
3765 nasm_free(params);
3766 nasm_free(paramsize);
3767 free_tlist(mstart);
3768 continue; /* main token loop */
3773 if (tline->type == TOK_SMAC_END) {
3774 tline->a.mac->in_progress = false;
3775 tline = delete_Token(tline);
3776 } else {
3777 t = *tail = tline;
3778 tline = tline->next;
3779 t->a.mac = NULL;
3780 t->next = NULL;
3781 tail = &t->next;
3786 * Now scan the entire line and look for successive TOK_IDs that resulted
3787 * after expansion (they can't be produced by tokenize()). The successive
3788 * TOK_IDs should be concatenated.
3789 * Also we look for %+ tokens and concatenate the tokens before and after
3790 * them (without white spaces in between).
3792 t = thead;
3793 rescan = 0;
3794 while (t) {
3795 while (t && t->type != TOK_ID && t->type != TOK_PREPROC_ID)
3796 t = t->next;
3797 if (!t || !t->next)
3798 break;
3799 if (t->next->type == TOK_ID ||
3800 t->next->type == TOK_PREPROC_ID ||
3801 t->next->type == TOK_NUMBER) {
3802 char *p = nasm_strcat(t->text, t->next->text);
3803 nasm_free(t->text);
3804 t->next = delete_Token(t->next);
3805 t->text = p;
3806 rescan = 1;
3807 } else if (t->next->type == TOK_WHITESPACE && t->next->next &&
3808 t->next->next->type == TOK_PREPROC_ID &&
3809 strcmp(t->next->next->text, "%+") == 0) {
3810 /* free the next whitespace, the %+ token and next whitespace */
3811 int i;
3812 for (i = 1; i <= 3; i++) {
3813 if (!t->next
3814 || (i != 2 && t->next->type != TOK_WHITESPACE))
3815 break;
3816 t->next = delete_Token(t->next);
3817 } /* endfor */
3818 } else
3819 t = t->next;
3821 /* If we concatenaded something, re-scan the line for macros */
3822 if (rescan) {
3823 tline = thead;
3824 goto again;
3827 if (org_tline) {
3828 if (thead) {
3829 *org_tline = *thead;
3830 /* since we just gave text to org_line, don't free it */
3831 thead->text = NULL;
3832 delete_Token(thead);
3833 } else {
3834 /* the expression expanded to empty line;
3835 we can't return NULL for some reasons
3836 we just set the line to a single WHITESPACE token. */
3837 memset(org_tline, 0, sizeof(*org_tline));
3838 org_tline->text = NULL;
3839 org_tline->type = TOK_WHITESPACE;
3841 thead = org_tline;
3844 return thead;
3848 * Similar to expand_smacro but used exclusively with macro identifiers
3849 * right before they are fetched in. The reason is that there can be
3850 * identifiers consisting of several subparts. We consider that if there
3851 * are more than one element forming the name, user wants a expansion,
3852 * otherwise it will be left as-is. Example:
3854 * %define %$abc cde
3856 * the identifier %$abc will be left as-is so that the handler for %define
3857 * will suck it and define the corresponding value. Other case:
3859 * %define _%$abc cde
3861 * In this case user wants name to be expanded *before* %define starts
3862 * working, so we'll expand %$abc into something (if it has a value;
3863 * otherwise it will be left as-is) then concatenate all successive
3864 * PP_IDs into one.
3866 static Token *expand_id(Token * tline)
3868 Token *cur, *oldnext = NULL;
3870 if (!tline || !tline->next)
3871 return tline;
3873 cur = tline;
3874 while (cur->next &&
3875 (cur->next->type == TOK_ID ||
3876 cur->next->type == TOK_PREPROC_ID
3877 || cur->next->type == TOK_NUMBER))
3878 cur = cur->next;
3880 /* If identifier consists of just one token, don't expand */
3881 if (cur == tline)
3882 return tline;
3884 if (cur) {
3885 oldnext = cur->next; /* Detach the tail past identifier */
3886 cur->next = NULL; /* so that expand_smacro stops here */
3889 tline = expand_smacro(tline);
3891 if (cur) {
3892 /* expand_smacro possibly changhed tline; re-scan for EOL */
3893 cur = tline;
3894 while (cur && cur->next)
3895 cur = cur->next;
3896 if (cur)
3897 cur->next = oldnext;
3900 return tline;
3904 * Expand indirect tokens, %[...]. Just like expand_smacro(),
3905 * the input is considered destroyed.
3907 static Token *expand_indirect(Token * tline, int level)
3909 const int max_indirect_level = 1000;
3910 Token *t, *thead, **tp;
3911 Token *it;
3912 bool skip;
3914 if (level >= max_indirect_level) {
3915 error(ERR_NONFATAL, "interminable indirect expansion");
3916 } else {
3917 thead = NULL;
3918 tp = &tline;
3919 while ((t = *tp)) {
3920 if (t->type != TOK_INDIRECT) {
3921 thead = t;
3922 tp = &t->next;
3923 } else {
3924 it = tokenize(t->text);
3925 it = expand_indirect(it, level+1);
3926 it = expand_smacro(it);
3927 while (it) {
3928 skip = false;
3929 switch (thead ? thead->type : TOK_NONE) {
3930 case TOK_WHITESPACE:
3931 skip = (it->type == TOK_WHITESPACE);
3932 break;
3933 case TOK_ID:
3934 case TOK_NUMBER:
3935 if (it->type == thead->type || it->type == TOK_NUMBER) {
3936 char *tmp = nasm_strcat(thead->text, it->text);
3937 nasm_free(thead->text);
3938 thead->text = tmp;
3939 skip = true;
3941 break;
3942 default:
3943 break;
3945 if (skip) {
3946 it = delete_Token(it);
3947 } else {
3948 *tp = thead = it;
3949 tp = &it->next;
3950 it = it->next;
3953 *tp = thead = t->next;
3954 t = delete_Token(t);
3958 return tline;
3962 * Determine whether the given line constitutes a multi-line macro
3963 * call, and return the MMacro structure called if so. Doesn't have
3964 * to check for an initial label - that's taken care of in
3965 * expand_mmacro - but must check numbers of parameters. Guaranteed
3966 * to be called with tline->type == TOK_ID, so the putative macro
3967 * name is easy to find.
3969 static MMacro *is_mmacro(Token * tline, Token *** params_array)
3971 MMacro *head, *m;
3972 Token **params;
3973 int nparam;
3975 head = (MMacro *) hash_findix(&mmacros, tline->text);
3978 * Efficiency: first we see if any macro exists with the given
3979 * name. If not, we can return NULL immediately. _Then_ we
3980 * count the parameters, and then we look further along the
3981 * list if necessary to find the proper MMacro.
3983 for (m = head; m; m = m->next)
3984 if (!mstrcmp(m->name, tline->text, m->casesense))
3985 break;
3986 if (!m)
3987 return NULL;
3990 * OK, we have a potential macro. Count and demarcate the
3991 * parameters.
3993 count_mmac_params(tline->next, &nparam, &params);
3996 * So we know how many parameters we've got. Find the MMacro
3997 * structure that handles this number.
3999 while (m) {
4000 if (m->nparam_min <= nparam
4001 && (m->plus || nparam <= m->nparam_max)) {
4003 * This one is right. Just check if cycle removal
4004 * prohibits us using it before we actually celebrate...
4006 if (m->in_progress) {
4007 #if 0
4008 error(ERR_NONFATAL,
4009 "self-reference in multi-line macro `%s'", m->name);
4010 #endif
4011 nasm_free(params);
4012 return NULL;
4015 * It's right, and we can use it. Add its default
4016 * parameters to the end of our list if necessary.
4018 if (m->defaults && nparam < m->nparam_min + m->ndefs) {
4019 params =
4020 nasm_realloc(params,
4021 ((m->nparam_min + m->ndefs +
4022 1) * sizeof(*params)));
4023 while (nparam < m->nparam_min + m->ndefs) {
4024 params[nparam] = m->defaults[nparam - m->nparam_min];
4025 nparam++;
4029 * If we've gone over the maximum parameter count (and
4030 * we're in Plus mode), ignore parameters beyond
4031 * nparam_max.
4033 if (m->plus && nparam > m->nparam_max)
4034 nparam = m->nparam_max;
4036 * Then terminate the parameter list, and leave.
4038 if (!params) { /* need this special case */
4039 params = nasm_malloc(sizeof(*params));
4040 nparam = 0;
4042 params[nparam] = NULL;
4043 *params_array = params;
4044 return m;
4047 * This one wasn't right: look for the next one with the
4048 * same name.
4050 for (m = m->next; m; m = m->next)
4051 if (!mstrcmp(m->name, tline->text, m->casesense))
4052 break;
4056 * After all that, we didn't find one with the right number of
4057 * parameters. Issue a warning, and fail to expand the macro.
4059 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
4060 "macro `%s' exists, but not taking %d parameters",
4061 tline->text, nparam);
4062 nasm_free(params);
4063 return NULL;
4067 * Expand the multi-line macro call made by the given line, if
4068 * there is one to be expanded. If there is, push the expansion on
4069 * istk->expansion and return 1. Otherwise return 0.
4071 static int expand_mmacro(Token * tline)
4073 Token *startline = tline;
4074 Token *label = NULL;
4075 int dont_prepend = 0;
4076 Token **params, *t, *mtok, *tt;
4077 MMacro *m;
4078 Line *l, *ll;
4079 int i, nparam, *paramlen;
4080 const char *mname;
4082 t = tline;
4083 skip_white_(t);
4084 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
4085 if (!tok_type_(t, TOK_ID) && !tok_type_(t, TOK_PREPROC_ID))
4086 return 0;
4087 mtok = t;
4088 m = is_mmacro(t, &params);
4089 if (m) {
4090 mname = t->text;
4091 } else {
4092 Token *last;
4094 * We have an id which isn't a macro call. We'll assume
4095 * it might be a label; we'll also check to see if a
4096 * colon follows it. Then, if there's another id after
4097 * that lot, we'll check it again for macro-hood.
4099 label = last = t;
4100 t = t->next;
4101 if (tok_type_(t, TOK_WHITESPACE))
4102 last = t, t = t->next;
4103 if (tok_is_(t, ":")) {
4104 dont_prepend = 1;
4105 last = t, t = t->next;
4106 if (tok_type_(t, TOK_WHITESPACE))
4107 last = t, t = t->next;
4109 if (!tok_type_(t, TOK_ID) || (m = is_mmacro(t, &params)) == NULL)
4110 return 0;
4111 last->next = NULL;
4112 mname = t->text;
4113 tline = t;
4117 * Fix up the parameters: this involves stripping leading and
4118 * trailing whitespace, then stripping braces if they are
4119 * present.
4121 for (nparam = 0; params[nparam]; nparam++) ;
4122 paramlen = nparam ? nasm_malloc(nparam * sizeof(*paramlen)) : NULL;
4124 for (i = 0; params[i]; i++) {
4125 int brace = false;
4126 int comma = (!m->plus || i < nparam - 1);
4128 t = params[i];
4129 skip_white_(t);
4130 if (tok_is_(t, "{"))
4131 t = t->next, brace = true, comma = false;
4132 params[i] = t;
4133 paramlen[i] = 0;
4134 while (t) {
4135 if (comma && t->type == TOK_OTHER && !strcmp(t->text, ","))
4136 break; /* ... because we have hit a comma */
4137 if (comma && t->type == TOK_WHITESPACE
4138 && tok_is_(t->next, ","))
4139 break; /* ... or a space then a comma */
4140 if (brace && t->type == TOK_OTHER && !strcmp(t->text, "}"))
4141 break; /* ... or a brace */
4142 t = t->next;
4143 paramlen[i]++;
4148 * OK, we have a MMacro structure together with a set of
4149 * parameters. We must now go through the expansion and push
4150 * copies of each Line on to istk->expansion. Substitution of
4151 * parameter tokens and macro-local tokens doesn't get done
4152 * until the single-line macro substitution process; this is
4153 * because delaying them allows us to change the semantics
4154 * later through %rotate.
4156 * First, push an end marker on to istk->expansion, mark this
4157 * macro as in progress, and set up its invocation-specific
4158 * variables.
4160 ll = nasm_malloc(sizeof(Line));
4161 ll->next = istk->expansion;
4162 ll->finishes = m;
4163 ll->first = NULL;
4164 istk->expansion = ll;
4166 m->in_progress = true;
4167 m->params = params;
4168 m->iline = tline;
4169 m->nparam = nparam;
4170 m->rotate = 0;
4171 m->paramlen = paramlen;
4172 m->unique = unique++;
4173 m->lineno = 0;
4175 m->next_active = istk->mstk;
4176 istk->mstk = m;
4178 for (l = m->expansion; l; l = l->next) {
4179 Token **tail;
4181 ll = nasm_malloc(sizeof(Line));
4182 ll->finishes = NULL;
4183 ll->next = istk->expansion;
4184 istk->expansion = ll;
4185 tail = &ll->first;
4187 for (t = l->first; t; t = t->next) {
4188 Token *x = t;
4189 switch (t->type) {
4190 case TOK_PREPROC_Q:
4191 tt = *tail = new_Token(NULL, TOK_ID, mname, 0);
4192 break;
4193 case TOK_PREPROC_QQ:
4194 tt = *tail = new_Token(NULL, TOK_ID, m->name, 0);
4195 break;
4196 case TOK_PREPROC_ID:
4197 if (t->text[1] == '0' && t->text[2] == '0') {
4198 dont_prepend = -1;
4199 x = label;
4200 if (!x)
4201 continue;
4203 /* fall through */
4204 default:
4205 tt = *tail = new_Token(NULL, x->type, x->text, 0);
4206 break;
4208 tail = &tt->next;
4210 *tail = NULL;
4214 * If we had a label, push it on as the first line of
4215 * the macro expansion.
4217 if (label) {
4218 if (dont_prepend < 0)
4219 free_tlist(startline);
4220 else {
4221 ll = nasm_malloc(sizeof(Line));
4222 ll->finishes = NULL;
4223 ll->next = istk->expansion;
4224 istk->expansion = ll;
4225 ll->first = startline;
4226 if (!dont_prepend) {
4227 while (label->next)
4228 label = label->next;
4229 label->next = tt = new_Token(NULL, TOK_OTHER, ":", 0);
4234 list->uplevel(m->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
4236 return 1;
4239 /* The function that actually does the error reporting */
4240 static void verror(int severity, const char *fmt, va_list arg)
4242 char buff[1024];
4244 vsnprintf(buff, sizeof(buff), fmt, arg);
4246 if (istk && istk->mstk && istk->mstk->name)
4247 _error(severity, "(%s:%d) %s", istk->mstk->name,
4248 istk->mstk->lineno, buff);
4249 else
4250 _error(severity, "%s", buff);
4254 * Since preprocessor always operate only on the line that didn't
4255 * arrived yet, we should always use ERR_OFFBY1.
4257 static void error(int severity, const char *fmt, ...)
4259 va_list arg;
4261 /* If we're in a dead branch of IF or something like it, ignore the error */
4262 if (istk && istk->conds && !emitting(istk->conds->state))
4263 return;
4265 va_start(arg, fmt);
4266 verror(severity, fmt, arg);
4267 va_end(arg);
4271 * Because %else etc are evaluated in the state context
4272 * of the previous branch, errors might get lost with error():
4273 * %if 0 ... %else trailing garbage ... %endif
4274 * So %else etc should report errors with this function.
4276 static void error_precond(int severity, const char *fmt, ...)
4278 va_list arg;
4280 /* Only ignore the error if it's really in a dead branch */
4281 if (istk && istk->conds && istk->conds->state == COND_NEVER)
4282 return;
4284 va_start(arg, fmt);
4285 verror(severity, fmt, arg);
4286 va_end(arg);
4289 static void
4290 pp_reset(char *file, int apass, efunc errfunc, evalfunc eval,
4291 ListGen * listgen, StrList **deplist)
4293 Token *t;
4295 _error = errfunc;
4296 cstk = NULL;
4297 istk = nasm_malloc(sizeof(Include));
4298 istk->next = NULL;
4299 istk->conds = NULL;
4300 istk->expansion = NULL;
4301 istk->mstk = NULL;
4302 istk->fp = fopen(file, "r");
4303 istk->fname = NULL;
4304 src_set_fname(nasm_strdup(file));
4305 src_set_linnum(0);
4306 istk->lineinc = 1;
4307 if (!istk->fp)
4308 error(ERR_FATAL|ERR_NOFILE, "unable to open input file `%s'",
4309 file);
4310 defining = NULL;
4311 nested_mac_count = 0;
4312 nested_rep_count = 0;
4313 init_macros();
4314 unique = 0;
4315 if (tasm_compatible_mode) {
4316 stdmacpos = nasm_stdmac;
4317 } else {
4318 stdmacpos = nasm_stdmac_after_tasm;
4320 any_extrastdmac = extrastdmac && *extrastdmac;
4321 do_predef = true;
4322 list = listgen;
4323 evaluate = eval;
4326 * 0 for dependencies, 1 for preparatory passes, 2 for final pass.
4327 * The caller, however, will also pass in 3 for preprocess-only so
4328 * we can set __PASS__ accordingly.
4330 pass = apass > 2 ? 2 : apass;
4332 dephead = deptail = deplist;
4333 if (deplist) {
4334 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
4335 sl->next = NULL;
4336 strcpy(sl->str, file);
4337 *deptail = sl;
4338 deptail = &sl->next;
4342 * Define the __PASS__ macro. This is defined here unlike
4343 * all the other builtins, because it is special -- it varies between
4344 * passes.
4346 t = nasm_malloc(sizeof(*t));
4347 t->next = NULL;
4348 make_tok_num(t, apass);
4349 t->a.mac = NULL;
4350 define_smacro(NULL, "__PASS__", true, 0, t);
4353 static char *pp_getline(void)
4355 char *line;
4356 Token *tline;
4358 while (1) {
4360 * Fetch a tokenized line, either from the macro-expansion
4361 * buffer or from the input file.
4363 tline = NULL;
4364 while (istk->expansion && istk->expansion->finishes) {
4365 Line *l = istk->expansion;
4366 if (!l->finishes->name && l->finishes->in_progress > 1) {
4367 Line *ll;
4370 * This is a macro-end marker for a macro with no
4371 * name, which means it's not really a macro at all
4372 * but a %rep block, and the `in_progress' field is
4373 * more than 1, meaning that we still need to
4374 * repeat. (1 means the natural last repetition; 0
4375 * means termination by %exitrep.) We have
4376 * therefore expanded up to the %endrep, and must
4377 * push the whole block on to the expansion buffer
4378 * again. We don't bother to remove the macro-end
4379 * marker: we'd only have to generate another one
4380 * if we did.
4382 l->finishes->in_progress--;
4383 for (l = l->finishes->expansion; l; l = l->next) {
4384 Token *t, *tt, **tail;
4386 ll = nasm_malloc(sizeof(Line));
4387 ll->next = istk->expansion;
4388 ll->finishes = NULL;
4389 ll->first = NULL;
4390 tail = &ll->first;
4392 for (t = l->first; t; t = t->next) {
4393 if (t->text || t->type == TOK_WHITESPACE) {
4394 tt = *tail =
4395 new_Token(NULL, t->type, t->text, 0);
4396 tail = &tt->next;
4400 istk->expansion = ll;
4402 } else {
4404 * Check whether a `%rep' was started and not ended
4405 * within this macro expansion. This can happen and
4406 * should be detected. It's a fatal error because
4407 * I'm too confused to work out how to recover
4408 * sensibly from it.
4410 if (defining) {
4411 if (defining->name)
4412 error(ERR_PANIC,
4413 "defining with name in expansion");
4414 else if (istk->mstk->name)
4415 error(ERR_FATAL,
4416 "`%%rep' without `%%endrep' within"
4417 " expansion of macro `%s'",
4418 istk->mstk->name);
4422 * FIXME: investigate the relationship at this point between
4423 * istk->mstk and l->finishes
4426 MMacro *m = istk->mstk;
4427 istk->mstk = m->next_active;
4428 if (m->name) {
4430 * This was a real macro call, not a %rep, and
4431 * therefore the parameter information needs to
4432 * be freed.
4434 nasm_free(m->params);
4435 free_tlist(m->iline);
4436 nasm_free(m->paramlen);
4437 l->finishes->in_progress = false;
4438 } else
4439 free_mmacro(m);
4441 istk->expansion = l->next;
4442 nasm_free(l);
4443 list->downlevel(LIST_MACRO);
4446 while (1) { /* until we get a line we can use */
4448 if (istk->expansion) { /* from a macro expansion */
4449 char *p;
4450 Line *l = istk->expansion;
4451 if (istk->mstk)
4452 istk->mstk->lineno++;
4453 tline = l->first;
4454 istk->expansion = l->next;
4455 nasm_free(l);
4456 p = detoken(tline, false);
4457 list->line(LIST_MACRO, p);
4458 nasm_free(p);
4459 break;
4461 line = read_line();
4462 if (line) { /* from the current input file */
4463 line = prepreproc(line);
4464 tline = tokenize(line);
4465 nasm_free(line);
4466 break;
4469 * The current file has ended; work down the istk
4472 Include *i = istk;
4473 fclose(i->fp);
4474 if (i->conds)
4475 error(ERR_FATAL,
4476 "expected `%%endif' before end of file");
4477 /* only set line and file name if there's a next node */
4478 if (i->next) {
4479 src_set_linnum(i->lineno);
4480 nasm_free(src_set_fname(i->fname));
4482 istk = i->next;
4483 list->downlevel(LIST_INCLUDE);
4484 nasm_free(i);
4485 if (!istk)
4486 return NULL;
4487 if (istk->expansion && istk->expansion->finishes)
4488 break;
4493 * We must expand MMacro parameters and MMacro-local labels
4494 * _before_ we plunge into directive processing, to cope
4495 * with things like `%define something %1' such as STRUC
4496 * uses. Unless we're _defining_ a MMacro, in which case
4497 * those tokens should be left alone to go into the
4498 * definition; and unless we're in a non-emitting
4499 * condition, in which case we don't want to meddle with
4500 * anything.
4502 if (!defining && !(istk->conds && !emitting(istk->conds->state))
4503 && !(istk->mstk && !istk->mstk->in_progress)) {
4504 tline = expand_indirect(tline,0);
4505 tline = expand_mmac_params(tline);
4509 * Check the line to see if it's a preprocessor directive.
4511 if (do_directive(tline) == DIRECTIVE_FOUND) {
4512 continue;
4513 } else if (defining) {
4515 * We're defining a multi-line macro. We emit nothing
4516 * at all, and just
4517 * shove the tokenized line on to the macro definition.
4519 Line *l = nasm_malloc(sizeof(Line));
4520 l->next = defining->expansion;
4521 l->first = tline;
4522 l->finishes = NULL;
4523 defining->expansion = l;
4524 continue;
4525 } else if (istk->conds && !emitting(istk->conds->state)) {
4527 * We're in a non-emitting branch of a condition block.
4528 * Emit nothing at all, not even a blank line: when we
4529 * emerge from the condition we'll give a line-number
4530 * directive so we keep our place correctly.
4532 free_tlist(tline);
4533 continue;
4534 } else if (istk->mstk && !istk->mstk->in_progress) {
4536 * We're in a %rep block which has been terminated, so
4537 * we're walking through to the %endrep without
4538 * emitting anything. Emit nothing at all, not even a
4539 * blank line: when we emerge from the %rep block we'll
4540 * give a line-number directive so we keep our place
4541 * correctly.
4543 free_tlist(tline);
4544 continue;
4545 } else {
4546 tline = expand_smacro(tline);
4547 if (!expand_mmacro(tline)) {
4549 * De-tokenize the line again, and emit it.
4551 line = detoken(tline, true);
4552 free_tlist(tline);
4553 break;
4554 } else {
4555 continue; /* expand_mmacro calls free_tlist */
4560 return line;
4563 static void pp_cleanup(int pass)
4565 if (defining) {
4566 if(defining->name) {
4567 error(ERR_NONFATAL,
4568 "end of file while still defining macro `%s'",
4569 defining->name);
4570 } else {
4571 error(ERR_NONFATAL, "end of file while still in %%rep");
4574 free_mmacro(defining);
4576 while (cstk)
4577 ctx_pop();
4578 free_macros();
4579 while (istk) {
4580 Include *i = istk;
4581 istk = istk->next;
4582 fclose(i->fp);
4583 nasm_free(i->fname);
4584 nasm_free(i);
4586 while (cstk)
4587 ctx_pop();
4588 nasm_free(src_set_fname(NULL));
4589 if (pass == 0) {
4590 IncPath *i;
4591 free_llist(predef);
4592 delete_Blocks();
4593 while ((i = ipath)) {
4594 ipath = i->next;
4595 if (i->path)
4596 nasm_free(i->path);
4597 nasm_free(i);
4602 void pp_include_path(char *path)
4604 IncPath *i;
4606 i = nasm_malloc(sizeof(IncPath));
4607 i->path = path ? nasm_strdup(path) : NULL;
4608 i->next = NULL;
4610 if (ipath != NULL) {
4611 IncPath *j = ipath;
4612 while (j->next != NULL)
4613 j = j->next;
4614 j->next = i;
4615 } else {
4616 ipath = i;
4620 void pp_pre_include(char *fname)
4622 Token *inc, *space, *name;
4623 Line *l;
4625 name = new_Token(NULL, TOK_INTERNAL_STRING, fname, 0);
4626 space = new_Token(name, TOK_WHITESPACE, NULL, 0);
4627 inc = new_Token(space, TOK_PREPROC_ID, "%include", 0);
4629 l = nasm_malloc(sizeof(Line));
4630 l->next = predef;
4631 l->first = inc;
4632 l->finishes = NULL;
4633 predef = l;
4636 void pp_pre_define(char *definition)
4638 Token *def, *space;
4639 Line *l;
4640 char *equals;
4642 equals = strchr(definition, '=');
4643 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4644 def = new_Token(space, TOK_PREPROC_ID, "%define", 0);
4645 if (equals)
4646 *equals = ' ';
4647 space->next = tokenize(definition);
4648 if (equals)
4649 *equals = '=';
4651 l = nasm_malloc(sizeof(Line));
4652 l->next = predef;
4653 l->first = def;
4654 l->finishes = NULL;
4655 predef = l;
4658 void pp_pre_undefine(char *definition)
4660 Token *def, *space;
4661 Line *l;
4663 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4664 def = new_Token(space, TOK_PREPROC_ID, "%undef", 0);
4665 space->next = tokenize(definition);
4667 l = nasm_malloc(sizeof(Line));
4668 l->next = predef;
4669 l->first = def;
4670 l->finishes = NULL;
4671 predef = l;
4675 * Added by Keith Kanios:
4677 * This function is used to assist with "runtime" preprocessor
4678 * directives. (e.g. pp_runtime("%define __BITS__ 64");)
4680 * ERRORS ARE IGNORED HERE, SO MAKE COMPLETELY SURE THAT YOU
4681 * PASS A VALID STRING TO THIS FUNCTION!!!!!
4684 void pp_runtime(char *definition)
4686 Token *def;
4688 def = tokenize(definition);
4689 if(do_directive(def) == NO_DIRECTIVE_FOUND)
4690 free_tlist(def);
4694 void pp_extra_stdmac(macros_t *macros)
4696 extrastdmac = macros;
4699 static void make_tok_num(Token * tok, int64_t val)
4701 char numbuf[20];
4702 snprintf(numbuf, sizeof(numbuf), "%"PRId64"", val);
4703 tok->text = nasm_strdup(numbuf);
4704 tok->type = TOK_NUMBER;
4707 Preproc nasmpp = {
4708 pp_reset,
4709 pp_getline,
4710 pp_cleanup