preproc: correctly handle quoted strings inside %[...] constructs
[nasm.git] / preproc.c
blob434383b555f0b3ad6b60961988e6b5127b7b84b4
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 c, *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 (lvl && (c = *p)) {
814 switch (c) {
815 case ']':
816 lvl--;
817 break;
818 case '%':
819 p++;
820 if (*p == '[')
821 lvl++;
822 break;
823 case '\'':
824 case '\"':
825 case '`':
826 p = nasm_skip_string(p);
827 break;
828 default:
829 break;
831 p++;
833 if (*p)
834 *p++ = '\0';
835 type = TOK_INDIRECT;
836 } else if (*p == '?') {
837 type = TOK_PREPROC_Q; /* %? */
838 p++;
839 if (*p == '?') {
840 type = TOK_PREPROC_QQ; /* %?? */
841 p++;
843 } else if (isidchar(*p) ||
844 ((*p == '!' || *p == '%' || *p == '$') &&
845 isidchar(p[1]))) {
846 do {
847 p++;
849 while (isidchar(*p));
850 type = TOK_PREPROC_ID;
851 } else {
852 type = TOK_OTHER;
853 if (*p == '%')
854 p++;
856 } else if (isidstart(*p) || (*p == '$' && isidstart(p[1]))) {
857 type = TOK_ID;
858 p++;
859 while (*p && isidchar(*p))
860 p++;
861 } else if (*p == '\'' || *p == '"' || *p == '`') {
863 * A string token.
865 type = TOK_STRING;
866 p = nasm_skip_string(p);
868 if (*p) {
869 p++;
870 } else {
871 error(ERR_WARNING|ERR_PASS1, "unterminated string");
872 /* Handling unterminated strings by UNV */
873 /* type = -1; */
875 } else if (isnumstart(*p)) {
876 bool is_hex = false;
877 bool is_float = false;
878 bool has_e = false;
879 char c, *r;
882 * A numeric token.
885 if (*p == '$') {
886 p++;
887 is_hex = true;
890 for (;;) {
891 c = *p++;
893 if (!is_hex && (c == 'e' || c == 'E')) {
894 has_e = true;
895 if (*p == '+' || *p == '-') {
896 /* e can only be followed by +/- if it is either a
897 prefixed hex number or a floating-point number */
898 p++;
899 is_float = true;
901 } else if (c == 'H' || c == 'h' || c == 'X' || c == 'x') {
902 is_hex = true;
903 } else if (c == 'P' || c == 'p') {
904 is_float = true;
905 if (*p == '+' || *p == '-')
906 p++;
907 } else if (isnumchar(c) || c == '_')
908 ; /* just advance */
909 else if (c == '.') {
910 /* we need to deal with consequences of the legacy
911 parser, like "1.nolist" being two tokens
912 (TOK_NUMBER, TOK_ID) here; at least give it
913 a shot for now. In the future, we probably need
914 a flex-based scanner with proper pattern matching
915 to do it as well as it can be done. Nothing in
916 the world is going to help the person who wants
917 0x123.p16 interpreted as two tokens, though. */
918 r = p;
919 while (*r == '_')
920 r++;
922 if (nasm_isdigit(*r) || (is_hex && nasm_isxdigit(*r)) ||
923 (!is_hex && (*r == 'e' || *r == 'E')) ||
924 (*r == 'p' || *r == 'P')) {
925 p = r;
926 is_float = true;
927 } else
928 break; /* Terminate the token */
929 } else
930 break;
932 p--; /* Point to first character beyond number */
934 if (has_e && !is_hex) {
935 /* 1e13 is floating-point, but 1e13h is not */
936 is_float = true;
939 type = is_float ? TOK_FLOAT : TOK_NUMBER;
940 } else if (nasm_isspace(*p)) {
941 type = TOK_WHITESPACE;
942 p++;
943 while (*p && nasm_isspace(*p))
944 p++;
946 * Whitespace just before end-of-line is discarded by
947 * pretending it's a comment; whitespace just before a
948 * comment gets lumped into the comment.
950 if (!*p || *p == ';') {
951 type = TOK_COMMENT;
952 while (*p)
953 p++;
955 } else if (*p == ';') {
956 type = TOK_COMMENT;
957 while (*p)
958 p++;
959 } else {
961 * Anything else is an operator of some kind. We check
962 * for all the double-character operators (>>, <<, //,
963 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
964 * else is a single-character operator.
966 type = TOK_OTHER;
967 if ((p[0] == '>' && p[1] == '>') ||
968 (p[0] == '<' && p[1] == '<') ||
969 (p[0] == '/' && p[1] == '/') ||
970 (p[0] == '<' && p[1] == '=') ||
971 (p[0] == '>' && p[1] == '=') ||
972 (p[0] == '=' && p[1] == '=') ||
973 (p[0] == '!' && p[1] == '=') ||
974 (p[0] == '<' && p[1] == '>') ||
975 (p[0] == '&' && p[1] == '&') ||
976 (p[0] == '|' && p[1] == '|') ||
977 (p[0] == '^' && p[1] == '^')) {
978 p++;
980 p++;
983 /* Handling unterminated string by UNV */
984 /*if (type == -1)
986 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
987 t->text[p-line] = *line;
988 tail = &t->next;
990 else */
991 if (type != TOK_COMMENT) {
992 *tail = t = new_Token(NULL, type, line, p - line);
993 tail = &t->next;
995 line = p;
997 return list;
1001 * this function allocates a new managed block of memory and
1002 * returns a pointer to the block. The managed blocks are
1003 * deleted only all at once by the delete_Blocks function.
1005 static void *new_Block(size_t size)
1007 Blocks *b = &blocks;
1009 /* first, get to the end of the linked list */
1010 while (b->next)
1011 b = b->next;
1012 /* now allocate the requested chunk */
1013 b->chunk = nasm_malloc(size);
1015 /* now allocate a new block for the next request */
1016 b->next = nasm_malloc(sizeof(Blocks));
1017 /* and initialize the contents of the new block */
1018 b->next->next = NULL;
1019 b->next->chunk = NULL;
1020 return b->chunk;
1024 * this function deletes all managed blocks of memory
1026 static void delete_Blocks(void)
1028 Blocks *a, *b = &blocks;
1031 * keep in mind that the first block, pointed to by blocks
1032 * is a static and not dynamically allocated, so we don't
1033 * free it.
1035 while (b) {
1036 if (b->chunk)
1037 nasm_free(b->chunk);
1038 a = b;
1039 b = b->next;
1040 if (a != &blocks)
1041 nasm_free(a);
1046 * this function creates a new Token and passes a pointer to it
1047 * back to the caller. It sets the type and text elements, and
1048 * also the a.mac and next elements to NULL.
1050 static Token *new_Token(Token * next, enum pp_token_type type,
1051 const char *text, int txtlen)
1053 Token *t;
1054 int i;
1056 if (freeTokens == NULL) {
1057 freeTokens = (Token *) new_Block(TOKEN_BLOCKSIZE * sizeof(Token));
1058 for (i = 0; i < TOKEN_BLOCKSIZE - 1; i++)
1059 freeTokens[i].next = &freeTokens[i + 1];
1060 freeTokens[i].next = NULL;
1062 t = freeTokens;
1063 freeTokens = t->next;
1064 t->next = next;
1065 t->a.mac = NULL;
1066 t->type = type;
1067 if (type == TOK_WHITESPACE || text == NULL) {
1068 t->text = NULL;
1069 } else {
1070 if (txtlen == 0)
1071 txtlen = strlen(text);
1072 t->text = nasm_malloc(txtlen+1);
1073 memcpy(t->text, text, txtlen);
1074 t->text[txtlen] = '\0';
1076 return t;
1079 static Token *delete_Token(Token * t)
1081 Token *next = t->next;
1082 nasm_free(t->text);
1083 t->next = freeTokens;
1084 freeTokens = t;
1085 return next;
1089 * Convert a line of tokens back into text.
1090 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1091 * will be transformed into ..@ctxnum.xxx
1093 static char *detoken(Token * tlist, bool expand_locals)
1095 Token *t;
1096 int len;
1097 char *line, *p;
1098 const char *q;
1100 len = 0;
1101 for (t = tlist; t; t = t->next) {
1102 if (t->type == TOK_PREPROC_ID && t->text[1] == '!') {
1103 char *p = getenv(t->text + 2);
1104 nasm_free(t->text);
1105 if (p)
1106 t->text = nasm_strdup(p);
1107 else
1108 t->text = NULL;
1110 /* Expand local macros here and not during preprocessing */
1111 if (expand_locals &&
1112 t->type == TOK_PREPROC_ID && t->text &&
1113 t->text[0] == '%' && t->text[1] == '$') {
1114 Context *ctx = get_ctx(t->text, false);
1115 if (ctx) {
1116 char buffer[40];
1117 char *p, *q = t->text + 2;
1119 q += strspn(q, "$");
1120 snprintf(buffer, sizeof(buffer), "..@%"PRIu32".", ctx->number);
1121 p = nasm_strcat(buffer, q);
1122 nasm_free(t->text);
1123 t->text = p;
1126 if (t->type == TOK_WHITESPACE) {
1127 len++;
1128 } else if (t->text) {
1129 len += strlen(t->text);
1132 p = line = nasm_malloc(len + 1);
1133 for (t = tlist; t; t = t->next) {
1134 if (t->type == TOK_WHITESPACE) {
1135 *p++ = ' ';
1136 } else if (t->text) {
1137 q = t->text;
1138 while (*q)
1139 *p++ = *q++;
1142 *p = '\0';
1143 return line;
1147 * A scanner, suitable for use by the expression evaluator, which
1148 * operates on a line of Tokens. Expects a pointer to a pointer to
1149 * the first token in the line to be passed in as its private_data
1150 * field.
1152 * FIX: This really needs to be unified with stdscan.
1154 static int ppscan(void *private_data, struct tokenval *tokval)
1156 Token **tlineptr = private_data;
1157 Token *tline;
1158 char ourcopy[MAX_KEYWORD+1], *p, *r, *s;
1160 do {
1161 tline = *tlineptr;
1162 *tlineptr = tline ? tline->next : NULL;
1164 while (tline && (tline->type == TOK_WHITESPACE ||
1165 tline->type == TOK_COMMENT));
1167 if (!tline)
1168 return tokval->t_type = TOKEN_EOS;
1170 tokval->t_charptr = tline->text;
1172 if (tline->text[0] == '$' && !tline->text[1])
1173 return tokval->t_type = TOKEN_HERE;
1174 if (tline->text[0] == '$' && tline->text[1] == '$' && !tline->text[2])
1175 return tokval->t_type = TOKEN_BASE;
1177 if (tline->type == TOK_ID) {
1178 p = tokval->t_charptr = tline->text;
1179 if (p[0] == '$') {
1180 tokval->t_charptr++;
1181 return tokval->t_type = TOKEN_ID;
1184 for (r = p, s = ourcopy; *r; r++) {
1185 if (r >= p+MAX_KEYWORD)
1186 return tokval->t_type = TOKEN_ID; /* Not a keyword */
1187 *s++ = nasm_tolower(*r);
1189 *s = '\0';
1190 /* right, so we have an identifier sitting in temp storage. now,
1191 * is it actually a register or instruction name, or what? */
1192 return nasm_token_hash(ourcopy, tokval);
1195 if (tline->type == TOK_NUMBER) {
1196 bool rn_error;
1197 tokval->t_integer = readnum(tline->text, &rn_error);
1198 tokval->t_charptr = tline->text;
1199 if (rn_error)
1200 return tokval->t_type = TOKEN_ERRNUM;
1201 else
1202 return tokval->t_type = TOKEN_NUM;
1205 if (tline->type == TOK_FLOAT) {
1206 return tokval->t_type = TOKEN_FLOAT;
1209 if (tline->type == TOK_STRING) {
1210 char bq, *ep;
1212 bq = tline->text[0];
1213 tokval->t_charptr = tline->text;
1214 tokval->t_inttwo = nasm_unquote(tline->text, &ep);
1216 if (ep[0] != bq || ep[1] != '\0')
1217 return tokval->t_type = TOKEN_ERRSTR;
1218 else
1219 return tokval->t_type = TOKEN_STR;
1222 if (tline->type == TOK_OTHER) {
1223 if (!strcmp(tline->text, "<<"))
1224 return tokval->t_type = TOKEN_SHL;
1225 if (!strcmp(tline->text, ">>"))
1226 return tokval->t_type = TOKEN_SHR;
1227 if (!strcmp(tline->text, "//"))
1228 return tokval->t_type = TOKEN_SDIV;
1229 if (!strcmp(tline->text, "%%"))
1230 return tokval->t_type = TOKEN_SMOD;
1231 if (!strcmp(tline->text, "=="))
1232 return tokval->t_type = TOKEN_EQ;
1233 if (!strcmp(tline->text, "<>"))
1234 return tokval->t_type = TOKEN_NE;
1235 if (!strcmp(tline->text, "!="))
1236 return tokval->t_type = TOKEN_NE;
1237 if (!strcmp(tline->text, "<="))
1238 return tokval->t_type = TOKEN_LE;
1239 if (!strcmp(tline->text, ">="))
1240 return tokval->t_type = TOKEN_GE;
1241 if (!strcmp(tline->text, "&&"))
1242 return tokval->t_type = TOKEN_DBL_AND;
1243 if (!strcmp(tline->text, "^^"))
1244 return tokval->t_type = TOKEN_DBL_XOR;
1245 if (!strcmp(tline->text, "||"))
1246 return tokval->t_type = TOKEN_DBL_OR;
1250 * We have no other options: just return the first character of
1251 * the token text.
1253 return tokval->t_type = tline->text[0];
1257 * Compare a string to the name of an existing macro; this is a
1258 * simple wrapper which calls either strcmp or nasm_stricmp
1259 * depending on the value of the `casesense' parameter.
1261 static int mstrcmp(const char *p, const char *q, bool casesense)
1263 return casesense ? strcmp(p, q) : nasm_stricmp(p, q);
1267 * Compare a string to the name of an existing macro; this is a
1268 * simple wrapper which calls either strcmp or nasm_stricmp
1269 * depending on the value of the `casesense' parameter.
1271 static int mmemcmp(const char *p, const char *q, size_t l, bool casesense)
1273 return casesense ? memcmp(p, q, l) : nasm_memicmp(p, q, l);
1277 * Return the Context structure associated with a %$ token. Return
1278 * NULL, having _already_ reported an error condition, if the
1279 * context stack isn't deep enough for the supplied number of $
1280 * signs.
1281 * If all_contexts == true, contexts that enclose current are
1282 * also scanned for such smacro, until it is found; if not -
1283 * only the context that directly results from the number of $'s
1284 * in variable's name.
1286 static Context *get_ctx(const char *name, bool all_contexts)
1288 Context *ctx;
1289 SMacro *m;
1290 int i;
1292 if (!name || name[0] != '%' || name[1] != '$')
1293 return NULL;
1295 if (!cstk) {
1296 error(ERR_NONFATAL, "`%s': context stack is empty", name);
1297 return NULL;
1300 for (i = strspn(name + 2, "$"), ctx = cstk; (i > 0) && ctx; i--) {
1301 ctx = ctx->next;
1302 /* i--; Lino - 02/25/02 */
1304 if (!ctx) {
1305 error(ERR_NONFATAL, "`%s': context stack is only"
1306 " %d level%s deep", name, i - 1, (i == 2 ? "" : "s"));
1307 return NULL;
1309 if (!all_contexts)
1310 return ctx;
1312 do {
1313 /* Search for this smacro in found context */
1314 m = hash_findix(&ctx->localmac, name);
1315 while (m) {
1316 if (!mstrcmp(m->name, name, m->casesense))
1317 return ctx;
1318 m = m->next;
1320 ctx = ctx->next;
1322 while (ctx);
1323 return NULL;
1327 * Check to see if a file is already in a string list
1329 static bool in_list(const StrList *list, const char *str)
1331 while (list) {
1332 if (!strcmp(list->str, str))
1333 return true;
1334 list = list->next;
1336 return false;
1340 * Open an include file. This routine must always return a valid
1341 * file pointer if it returns - it's responsible for throwing an
1342 * ERR_FATAL and bombing out completely if not. It should also try
1343 * the include path one by one until it finds the file or reaches
1344 * the end of the path.
1346 static FILE *inc_fopen(const char *file, StrList **dhead, StrList ***dtail,
1347 bool missing_ok)
1349 FILE *fp;
1350 char *prefix = "";
1351 IncPath *ip = ipath;
1352 int len = strlen(file);
1353 size_t prefix_len = 0;
1354 StrList *sl;
1356 while (1) {
1357 sl = nasm_malloc(prefix_len+len+1+sizeof sl->next);
1358 memcpy(sl->str, prefix, prefix_len);
1359 memcpy(sl->str+prefix_len, file, len+1);
1360 fp = fopen(sl->str, "r");
1361 if (fp && dhead && !in_list(*dhead, sl->str)) {
1362 sl->next = NULL;
1363 **dtail = sl;
1364 *dtail = &sl->next;
1365 } else {
1366 nasm_free(sl);
1368 if (fp)
1369 return fp;
1370 if (!ip) {
1371 if (!missing_ok)
1372 break;
1373 prefix = NULL;
1374 } else {
1375 prefix = ip->path;
1376 ip = ip->next;
1378 if (prefix) {
1379 prefix_len = strlen(prefix);
1380 } else {
1381 /* -MG given and file not found */
1382 if (dhead && !in_list(*dhead, file)) {
1383 sl = nasm_malloc(len+1+sizeof sl->next);
1384 sl->next = NULL;
1385 strcpy(sl->str, file);
1386 **dtail = sl;
1387 *dtail = &sl->next;
1389 return NULL;
1393 error(ERR_FATAL, "unable to open include file `%s'", file);
1394 return NULL; /* never reached - placate compilers */
1398 * Determine if we should warn on defining a single-line macro of
1399 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1400 * return true if _any_ single-line macro of that name is defined.
1401 * Otherwise, will return true if a single-line macro with either
1402 * `nparam' or no parameters is defined.
1404 * If a macro with precisely the right number of parameters is
1405 * defined, or nparam is -1, the address of the definition structure
1406 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1407 * is NULL, no action will be taken regarding its contents, and no
1408 * error will occur.
1410 * Note that this is also called with nparam zero to resolve
1411 * `ifdef'.
1413 * If you already know which context macro belongs to, you can pass
1414 * the context pointer as first parameter; if you won't but name begins
1415 * with %$ the context will be automatically computed. If all_contexts
1416 * is true, macro will be searched in outer contexts as well.
1418 static bool
1419 smacro_defined(Context * ctx, const char *name, int nparam, SMacro ** defn,
1420 bool nocase)
1422 struct hash_table *smtbl;
1423 SMacro *m;
1425 if (ctx) {
1426 smtbl = &ctx->localmac;
1427 } else if (name[0] == '%' && name[1] == '$') {
1428 if (cstk)
1429 ctx = get_ctx(name, false);
1430 if (!ctx)
1431 return false; /* got to return _something_ */
1432 smtbl = &ctx->localmac;
1433 } else {
1434 smtbl = &smacros;
1436 m = (SMacro *) hash_findix(smtbl, name);
1438 while (m) {
1439 if (!mstrcmp(m->name, name, m->casesense && nocase) &&
1440 (nparam <= 0 || m->nparam == 0 || nparam == (int) m->nparam)) {
1441 if (defn) {
1442 if (nparam == (int) m->nparam || nparam == -1)
1443 *defn = m;
1444 else
1445 *defn = NULL;
1447 return true;
1449 m = m->next;
1452 return false;
1456 * Count and mark off the parameters in a multi-line macro call.
1457 * This is called both from within the multi-line macro expansion
1458 * code, and also to mark off the default parameters when provided
1459 * in a %macro definition line.
1461 static void count_mmac_params(Token * t, int *nparam, Token *** params)
1463 int paramsize, brace;
1465 *nparam = paramsize = 0;
1466 *params = NULL;
1467 while (t) {
1468 /* +1: we need space for the final NULL */
1469 if (*nparam+1 >= paramsize) {
1470 paramsize += PARAM_DELTA;
1471 *params = nasm_realloc(*params, sizeof(**params) * paramsize);
1473 skip_white_(t);
1474 brace = false;
1475 if (tok_is_(t, "{"))
1476 brace = true;
1477 (*params)[(*nparam)++] = t;
1478 while (tok_isnt_(t, brace ? "}" : ","))
1479 t = t->next;
1480 if (t) { /* got a comma/brace */
1481 t = t->next;
1482 if (brace) {
1484 * Now we've found the closing brace, look further
1485 * for the comma.
1487 skip_white_(t);
1488 if (tok_isnt_(t, ",")) {
1489 error(ERR_NONFATAL,
1490 "braces do not enclose all of macro parameter");
1491 while (tok_isnt_(t, ","))
1492 t = t->next;
1494 if (t)
1495 t = t->next; /* eat the comma */
1502 * Determine whether one of the various `if' conditions is true or
1503 * not.
1505 * We must free the tline we get passed.
1507 static bool if_condition(Token * tline, enum preproc_token ct)
1509 enum pp_conditional i = PP_COND(ct);
1510 bool j;
1511 Token *t, *tt, **tptr, *origline;
1512 struct tokenval tokval;
1513 expr *evalresult;
1514 enum pp_token_type needtype;
1516 origline = tline;
1518 switch (i) {
1519 case PPC_IFCTX:
1520 j = false; /* have we matched yet? */
1521 while (true) {
1522 skip_white_(tline);
1523 if (!tline)
1524 break;
1525 if (tline->type != TOK_ID) {
1526 error(ERR_NONFATAL,
1527 "`%s' expects context identifiers", pp_directives[ct]);
1528 free_tlist(origline);
1529 return -1;
1531 if (cstk && cstk->name && !nasm_stricmp(tline->text, cstk->name))
1532 j = true;
1533 tline = tline->next;
1535 break;
1537 case PPC_IFDEF:
1538 j = false; /* have we matched yet? */
1539 while (tline) {
1540 skip_white_(tline);
1541 if (!tline || (tline->type != TOK_ID &&
1542 (tline->type != TOK_PREPROC_ID ||
1543 tline->text[1] != '$'))) {
1544 error(ERR_NONFATAL,
1545 "`%s' expects macro identifiers", pp_directives[ct]);
1546 goto fail;
1548 if (smacro_defined(NULL, tline->text, 0, NULL, true))
1549 j = true;
1550 tline = tline->next;
1552 break;
1554 case PPC_IFIDN:
1555 case PPC_IFIDNI:
1556 tline = expand_smacro(tline);
1557 t = tt = tline;
1558 while (tok_isnt_(tt, ","))
1559 tt = tt->next;
1560 if (!tt) {
1561 error(ERR_NONFATAL,
1562 "`%s' expects two comma-separated arguments",
1563 pp_directives[ct]);
1564 goto fail;
1566 tt = tt->next;
1567 j = true; /* assume equality unless proved not */
1568 while ((t->type != TOK_OTHER || strcmp(t->text, ",")) && tt) {
1569 if (tt->type == TOK_OTHER && !strcmp(tt->text, ",")) {
1570 error(ERR_NONFATAL, "`%s': more than one comma on line",
1571 pp_directives[ct]);
1572 goto fail;
1574 if (t->type == TOK_WHITESPACE) {
1575 t = t->next;
1576 continue;
1578 if (tt->type == TOK_WHITESPACE) {
1579 tt = tt->next;
1580 continue;
1582 if (tt->type != t->type) {
1583 j = false; /* found mismatching tokens */
1584 break;
1586 /* When comparing strings, need to unquote them first */
1587 if (t->type == TOK_STRING) {
1588 size_t l1 = nasm_unquote(t->text, NULL);
1589 size_t l2 = nasm_unquote(tt->text, NULL);
1591 if (l1 != l2) {
1592 j = false;
1593 break;
1595 if (mmemcmp(t->text, tt->text, l1, i == PPC_IFIDN)) {
1596 j = false;
1597 break;
1599 } else if (mstrcmp(tt->text, t->text, i == PPC_IFIDN) != 0) {
1600 j = false; /* found mismatching tokens */
1601 break;
1604 t = t->next;
1605 tt = tt->next;
1607 if ((t->type != TOK_OTHER || strcmp(t->text, ",")) || tt)
1608 j = false; /* trailing gunk on one end or other */
1609 break;
1611 case PPC_IFMACRO:
1613 bool found = false;
1614 MMacro searching, *mmac;
1616 tline = tline->next;
1617 skip_white_(tline);
1618 tline = expand_id(tline);
1619 if (!tok_type_(tline, TOK_ID)) {
1620 error(ERR_NONFATAL,
1621 "`%s' expects a macro name", pp_directives[ct]);
1622 goto fail;
1624 searching.name = nasm_strdup(tline->text);
1625 searching.casesense = true;
1626 searching.plus = false;
1627 searching.nolist = false;
1628 searching.in_progress = 0;
1629 searching.rep_nest = NULL;
1630 searching.nparam_min = 0;
1631 searching.nparam_max = INT_MAX;
1632 tline = expand_smacro(tline->next);
1633 skip_white_(tline);
1634 if (!tline) {
1635 } else if (!tok_type_(tline, TOK_NUMBER)) {
1636 error(ERR_NONFATAL,
1637 "`%s' expects a parameter count or nothing",
1638 pp_directives[ct]);
1639 } else {
1640 searching.nparam_min = searching.nparam_max =
1641 readnum(tline->text, &j);
1642 if (j)
1643 error(ERR_NONFATAL,
1644 "unable to parse parameter count `%s'",
1645 tline->text);
1647 if (tline && tok_is_(tline->next, "-")) {
1648 tline = tline->next->next;
1649 if (tok_is_(tline, "*"))
1650 searching.nparam_max = INT_MAX;
1651 else if (!tok_type_(tline, TOK_NUMBER))
1652 error(ERR_NONFATAL,
1653 "`%s' expects a parameter count after `-'",
1654 pp_directives[ct]);
1655 else {
1656 searching.nparam_max = readnum(tline->text, &j);
1657 if (j)
1658 error(ERR_NONFATAL,
1659 "unable to parse parameter count `%s'",
1660 tline->text);
1661 if (searching.nparam_min > searching.nparam_max)
1662 error(ERR_NONFATAL,
1663 "minimum parameter count exceeds maximum");
1666 if (tline && tok_is_(tline->next, "+")) {
1667 tline = tline->next;
1668 searching.plus = true;
1670 mmac = (MMacro *) hash_findix(&mmacros, searching.name);
1671 while (mmac) {
1672 if (!strcmp(mmac->name, searching.name) &&
1673 (mmac->nparam_min <= searching.nparam_max
1674 || searching.plus)
1675 && (searching.nparam_min <= mmac->nparam_max
1676 || mmac->plus)) {
1677 found = true;
1678 break;
1680 mmac = mmac->next;
1682 if(tline && tline->next)
1683 error(ERR_WARNING|ERR_PASS1,
1684 "trailing garbage after %%ifmacro ignored");
1685 nasm_free(searching.name);
1686 j = found;
1687 break;
1690 case PPC_IFID:
1691 needtype = TOK_ID;
1692 goto iftype;
1693 case PPC_IFNUM:
1694 needtype = TOK_NUMBER;
1695 goto iftype;
1696 case PPC_IFSTR:
1697 needtype = TOK_STRING;
1698 goto iftype;
1700 iftype:
1701 t = tline = expand_smacro(tline);
1703 while (tok_type_(t, TOK_WHITESPACE) ||
1704 (needtype == TOK_NUMBER &&
1705 tok_type_(t, TOK_OTHER) &&
1706 (t->text[0] == '-' || t->text[0] == '+') &&
1707 !t->text[1]))
1708 t = t->next;
1710 j = tok_type_(t, needtype);
1711 break;
1713 case PPC_IFTOKEN:
1714 t = tline = expand_smacro(tline);
1715 while (tok_type_(t, TOK_WHITESPACE))
1716 t = t->next;
1718 j = false;
1719 if (t) {
1720 t = t->next; /* Skip the actual token */
1721 while (tok_type_(t, TOK_WHITESPACE))
1722 t = t->next;
1723 j = !t; /* Should be nothing left */
1725 break;
1727 case PPC_IFEMPTY:
1728 t = tline = expand_smacro(tline);
1729 while (tok_type_(t, TOK_WHITESPACE))
1730 t = t->next;
1732 j = !t; /* Should be empty */
1733 break;
1735 case PPC_IF:
1736 t = tline = expand_smacro(tline);
1737 tptr = &t;
1738 tokval.t_type = TOKEN_INVALID;
1739 evalresult = evaluate(ppscan, tptr, &tokval,
1740 NULL, pass | CRITICAL, error, NULL);
1741 if (!evalresult)
1742 return -1;
1743 if (tokval.t_type)
1744 error(ERR_WARNING|ERR_PASS1,
1745 "trailing garbage after expression ignored");
1746 if (!is_simple(evalresult)) {
1747 error(ERR_NONFATAL,
1748 "non-constant value given to `%s'", pp_directives[ct]);
1749 goto fail;
1751 j = reloc_value(evalresult) != 0;
1752 break;
1754 default:
1755 error(ERR_FATAL,
1756 "preprocessor directive `%s' not yet implemented",
1757 pp_directives[ct]);
1758 goto fail;
1761 free_tlist(origline);
1762 return j ^ PP_NEGATIVE(ct);
1764 fail:
1765 free_tlist(origline);
1766 return -1;
1770 * Common code for defining an smacro
1772 static bool define_smacro(Context *ctx, char *mname, bool casesense,
1773 int nparam, Token *expansion)
1775 SMacro *smac, **smhead;
1776 struct hash_table *smtbl;
1778 if (smacro_defined(ctx, mname, nparam, &smac, casesense)) {
1779 if (!smac) {
1780 error(ERR_WARNING|ERR_PASS1,
1781 "single-line macro `%s' defined both with and"
1782 " without parameters", mname);
1784 /* Some instances of the old code considered this a failure,
1785 some others didn't. What is the right thing to do here? */
1786 free_tlist(expansion);
1787 return false; /* Failure */
1788 } else {
1790 * We're redefining, so we have to take over an
1791 * existing SMacro structure. This means freeing
1792 * what was already in it.
1794 nasm_free(smac->name);
1795 free_tlist(smac->expansion);
1797 } else {
1798 smtbl = ctx ? &ctx->localmac : &smacros;
1799 smhead = (SMacro **) hash_findi_add(smtbl, mname);
1800 smac = nasm_malloc(sizeof(SMacro));
1801 smac->next = *smhead;
1802 *smhead = smac;
1804 smac->name = nasm_strdup(mname);
1805 smac->casesense = casesense;
1806 smac->nparam = nparam;
1807 smac->expansion = expansion;
1808 smac->in_progress = false;
1809 return true; /* Success */
1813 * Undefine an smacro
1815 static void undef_smacro(Context *ctx, const char *mname)
1817 SMacro **smhead, *s, **sp;
1818 struct hash_table *smtbl;
1820 smtbl = ctx ? &ctx->localmac : &smacros;
1821 smhead = (SMacro **)hash_findi(smtbl, mname, NULL);
1823 if (smhead) {
1825 * We now have a macro name... go hunt for it.
1827 sp = smhead;
1828 while ((s = *sp) != NULL) {
1829 if (!mstrcmp(s->name, mname, s->casesense)) {
1830 *sp = s->next;
1831 nasm_free(s->name);
1832 free_tlist(s->expansion);
1833 nasm_free(s);
1834 } else {
1835 sp = &s->next;
1842 * Parse a mmacro specification.
1844 static bool parse_mmacro_spec(Token *tline, MMacro *def, const char *directive)
1846 bool err;
1848 tline = tline->next;
1849 skip_white_(tline);
1850 tline = expand_id(tline);
1851 if (!tok_type_(tline, TOK_ID)) {
1852 error(ERR_NONFATAL, "`%s' expects a macro name", directive);
1853 return false;
1856 def->name = nasm_strdup(tline->text);
1857 def->plus = false;
1858 def->nolist = false;
1859 def->in_progress = 0;
1860 def->rep_nest = NULL;
1861 def->nparam_min = 0;
1862 def->nparam_max = 0;
1864 tline = expand_smacro(tline->next);
1865 skip_white_(tline);
1866 if (!tok_type_(tline, TOK_NUMBER)) {
1867 error(ERR_NONFATAL, "`%s' expects a parameter count", directive);
1868 } else {
1869 def->nparam_min = def->nparam_max =
1870 readnum(tline->text, &err);
1871 if (err)
1872 error(ERR_NONFATAL,
1873 "unable to parse parameter count `%s'", tline->text);
1875 if (tline && tok_is_(tline->next, "-")) {
1876 tline = tline->next->next;
1877 if (tok_is_(tline, "*")) {
1878 def->nparam_max = INT_MAX;
1879 } else if (!tok_type_(tline, TOK_NUMBER)) {
1880 error(ERR_NONFATAL,
1881 "`%s' expects a parameter count after `-'", directive);
1882 } else {
1883 def->nparam_max = readnum(tline->text, &err);
1884 if (err) {
1885 error(ERR_NONFATAL, "unable to parse parameter count `%s'",
1886 tline->text);
1888 if (def->nparam_min > def->nparam_max) {
1889 error(ERR_NONFATAL, "minimum parameter count exceeds maximum");
1893 if (tline && tok_is_(tline->next, "+")) {
1894 tline = tline->next;
1895 def->plus = true;
1897 if (tline && tok_type_(tline->next, TOK_ID) &&
1898 !nasm_stricmp(tline->next->text, ".nolist")) {
1899 tline = tline->next;
1900 def->nolist = true;
1904 * Handle default parameters.
1906 if (tline && tline->next) {
1907 def->dlist = tline->next;
1908 tline->next = NULL;
1909 count_mmac_params(def->dlist, &def->ndefs, &def->defaults);
1910 } else {
1911 def->dlist = NULL;
1912 def->defaults = NULL;
1914 def->expansion = NULL;
1916 if(def->defaults &&
1917 def->ndefs > def->nparam_max - def->nparam_min &&
1918 !def->plus)
1919 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MDP,
1920 "too many default macro parameters");
1922 return true;
1927 * Decode a size directive
1929 static int parse_size(const char *str) {
1930 static const char *size_names[] =
1931 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
1932 static const int sizes[] =
1933 { 0, 1, 4, 16, 8, 10, 2, 32 };
1935 return sizes[bsii(str, size_names, elements(size_names))+1];
1939 * find and process preprocessor directive in passed line
1940 * Find out if a line contains a preprocessor directive, and deal
1941 * with it if so.
1943 * If a directive _is_ found, it is the responsibility of this routine
1944 * (and not the caller) to free_tlist() the line.
1946 * @param tline a pointer to the current tokeninzed line linked list
1947 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
1950 static int do_directive(Token * tline)
1952 enum preproc_token i;
1953 int j;
1954 bool err;
1955 int nparam;
1956 bool nolist;
1957 bool casesense;
1958 int k, m;
1959 int offset;
1960 char *p, *pp, *mname;
1961 Include *inc;
1962 Context *ctx;
1963 Cond *cond;
1964 MMacro *mmac, **mmhead;
1965 Token *t, *tt, *param_start, *macro_start, *last, **tptr, *origline;
1966 Line *l;
1967 struct tokenval tokval;
1968 expr *evalresult;
1969 MMacro *tmp_defining; /* Used when manipulating rep_nest */
1970 int64_t count;
1971 size_t len;
1972 int severity;
1974 origline = tline;
1976 skip_white_(tline);
1977 if (!tline || !tok_type_(tline, TOK_PREPROC_ID) ||
1978 (tline->text[1] == '%' || tline->text[1] == '$'
1979 || tline->text[1] == '!'))
1980 return NO_DIRECTIVE_FOUND;
1982 i = pp_token_hash(tline->text);
1985 * If we're in a non-emitting branch of a condition construct,
1986 * or walking to the end of an already terminated %rep block,
1987 * we should ignore all directives except for condition
1988 * directives.
1990 if (((istk->conds && !emitting(istk->conds->state)) ||
1991 (istk->mstk && !istk->mstk->in_progress)) && !is_condition(i)) {
1992 return NO_DIRECTIVE_FOUND;
1996 * If we're defining a macro or reading a %rep block, we should
1997 * ignore all directives except for %macro/%imacro (which nest),
1998 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
1999 * If we're in a %rep block, another %rep nests, so should be let through.
2001 if (defining && i != PP_MACRO && i != PP_IMACRO &&
2002 i != PP_ENDMACRO && i != PP_ENDM &&
2003 (defining->name || (i != PP_ENDREP && i != PP_REP))) {
2004 return NO_DIRECTIVE_FOUND;
2007 if (defining) {
2008 if (i == PP_MACRO || i == PP_IMACRO) {
2009 nested_mac_count++;
2010 return NO_DIRECTIVE_FOUND;
2011 } else if (nested_mac_count > 0) {
2012 if (i == PP_ENDMACRO) {
2013 nested_mac_count--;
2014 return NO_DIRECTIVE_FOUND;
2017 if (!defining->name) {
2018 if (i == PP_REP) {
2019 nested_rep_count++;
2020 return NO_DIRECTIVE_FOUND;
2021 } else if (nested_rep_count > 0) {
2022 if (i == PP_ENDREP) {
2023 nested_rep_count--;
2024 return NO_DIRECTIVE_FOUND;
2030 switch (i) {
2031 case PP_INVALID:
2032 error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2033 tline->text);
2034 return NO_DIRECTIVE_FOUND; /* didn't get it */
2036 case PP_STACKSIZE:
2037 /* Directive to tell NASM what the default stack size is. The
2038 * default is for a 16-bit stack, and this can be overriden with
2039 * %stacksize large.
2040 * the following form:
2042 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2044 tline = tline->next;
2045 if (tline && tline->type == TOK_WHITESPACE)
2046 tline = tline->next;
2047 if (!tline || tline->type != TOK_ID) {
2048 error(ERR_NONFATAL, "`%%stacksize' missing size parameter");
2049 free_tlist(origline);
2050 return DIRECTIVE_FOUND;
2052 if (nasm_stricmp(tline->text, "flat") == 0) {
2053 /* All subsequent ARG directives are for a 32-bit stack */
2054 StackSize = 4;
2055 StackPointer = "ebp";
2056 ArgOffset = 8;
2057 LocalOffset = 0;
2058 } else if (nasm_stricmp(tline->text, "flat64") == 0) {
2059 /* All subsequent ARG directives are for a 64-bit stack */
2060 StackSize = 8;
2061 StackPointer = "rbp";
2062 ArgOffset = 8;
2063 LocalOffset = 0;
2064 } else if (nasm_stricmp(tline->text, "large") == 0) {
2065 /* All subsequent ARG directives are for a 16-bit stack,
2066 * far function call.
2068 StackSize = 2;
2069 StackPointer = "bp";
2070 ArgOffset = 4;
2071 LocalOffset = 0;
2072 } else if (nasm_stricmp(tline->text, "small") == 0) {
2073 /* All subsequent ARG directives are for a 16-bit stack,
2074 * far function call. We don't support near functions.
2076 StackSize = 2;
2077 StackPointer = "bp";
2078 ArgOffset = 6;
2079 LocalOffset = 0;
2080 } else {
2081 error(ERR_NONFATAL, "`%%stacksize' invalid size type");
2082 free_tlist(origline);
2083 return DIRECTIVE_FOUND;
2085 free_tlist(origline);
2086 return DIRECTIVE_FOUND;
2088 case PP_ARG:
2089 /* TASM like ARG directive to define arguments to functions, in
2090 * the following form:
2092 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2094 offset = ArgOffset;
2095 do {
2096 char *arg, directive[256];
2097 int size = StackSize;
2099 /* Find the argument name */
2100 tline = tline->next;
2101 if (tline && tline->type == TOK_WHITESPACE)
2102 tline = tline->next;
2103 if (!tline || tline->type != TOK_ID) {
2104 error(ERR_NONFATAL, "`%%arg' missing argument parameter");
2105 free_tlist(origline);
2106 return DIRECTIVE_FOUND;
2108 arg = tline->text;
2110 /* Find the argument size type */
2111 tline = tline->next;
2112 if (!tline || tline->type != TOK_OTHER
2113 || tline->text[0] != ':') {
2114 error(ERR_NONFATAL,
2115 "Syntax error processing `%%arg' directive");
2116 free_tlist(origline);
2117 return DIRECTIVE_FOUND;
2119 tline = tline->next;
2120 if (!tline || tline->type != TOK_ID) {
2121 error(ERR_NONFATAL, "`%%arg' missing size type parameter");
2122 free_tlist(origline);
2123 return DIRECTIVE_FOUND;
2126 /* Allow macro expansion of type parameter */
2127 tt = tokenize(tline->text);
2128 tt = expand_smacro(tt);
2129 size = parse_size(tt->text);
2130 if (!size) {
2131 error(ERR_NONFATAL,
2132 "Invalid size type for `%%arg' missing directive");
2133 free_tlist(tt);
2134 free_tlist(origline);
2135 return DIRECTIVE_FOUND;
2137 free_tlist(tt);
2139 /* Round up to even stack slots */
2140 size = (size+StackSize-1) & ~(StackSize-1);
2142 /* Now define the macro for the argument */
2143 snprintf(directive, sizeof(directive), "%%define %s (%s+%d)",
2144 arg, StackPointer, offset);
2145 do_directive(tokenize(directive));
2146 offset += size;
2148 /* Move to the next argument in the list */
2149 tline = tline->next;
2150 if (tline && tline->type == TOK_WHITESPACE)
2151 tline = tline->next;
2152 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2153 ArgOffset = offset;
2154 free_tlist(origline);
2155 return DIRECTIVE_FOUND;
2157 case PP_LOCAL:
2158 /* TASM like LOCAL directive to define local variables for a
2159 * function, in the following form:
2161 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2163 * The '= LocalSize' at the end is ignored by NASM, but is
2164 * required by TASM to define the local parameter size (and used
2165 * by the TASM macro package).
2167 offset = LocalOffset;
2168 do {
2169 char *local, directive[256];
2170 int size = StackSize;
2172 /* Find the argument name */
2173 tline = tline->next;
2174 if (tline && tline->type == TOK_WHITESPACE)
2175 tline = tline->next;
2176 if (!tline || tline->type != TOK_ID) {
2177 error(ERR_NONFATAL,
2178 "`%%local' missing argument parameter");
2179 free_tlist(origline);
2180 return DIRECTIVE_FOUND;
2182 local = tline->text;
2184 /* Find the argument size type */
2185 tline = tline->next;
2186 if (!tline || tline->type != TOK_OTHER
2187 || tline->text[0] != ':') {
2188 error(ERR_NONFATAL,
2189 "Syntax error processing `%%local' directive");
2190 free_tlist(origline);
2191 return DIRECTIVE_FOUND;
2193 tline = tline->next;
2194 if (!tline || tline->type != TOK_ID) {
2195 error(ERR_NONFATAL,
2196 "`%%local' missing size type parameter");
2197 free_tlist(origline);
2198 return DIRECTIVE_FOUND;
2201 /* Allow macro expansion of type parameter */
2202 tt = tokenize(tline->text);
2203 tt = expand_smacro(tt);
2204 size = parse_size(tt->text);
2205 if (!size) {
2206 error(ERR_NONFATAL,
2207 "Invalid size type for `%%local' missing directive");
2208 free_tlist(tt);
2209 free_tlist(origline);
2210 return DIRECTIVE_FOUND;
2212 free_tlist(tt);
2214 /* Round up to even stack slots */
2215 size = (size+StackSize-1) & ~(StackSize-1);
2217 offset += size; /* Negative offset, increment before */
2219 /* Now define the macro for the argument */
2220 snprintf(directive, sizeof(directive), "%%define %s (%s-%d)",
2221 local, StackPointer, offset);
2222 do_directive(tokenize(directive));
2224 /* Now define the assign to setup the enter_c macro correctly */
2225 snprintf(directive, sizeof(directive),
2226 "%%assign %%$localsize %%$localsize+%d", size);
2227 do_directive(tokenize(directive));
2229 /* Move to the next argument in the list */
2230 tline = tline->next;
2231 if (tline && tline->type == TOK_WHITESPACE)
2232 tline = tline->next;
2233 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2234 LocalOffset = offset;
2235 free_tlist(origline);
2236 return DIRECTIVE_FOUND;
2238 case PP_CLEAR:
2239 if (tline->next)
2240 error(ERR_WARNING|ERR_PASS1,
2241 "trailing garbage after `%%clear' ignored");
2242 free_macros();
2243 init_macros();
2244 free_tlist(origline);
2245 return DIRECTIVE_FOUND;
2247 case PP_DEPEND:
2248 t = tline->next = expand_smacro(tline->next);
2249 skip_white_(t);
2250 if (!t || (t->type != TOK_STRING &&
2251 t->type != TOK_INTERNAL_STRING)) {
2252 error(ERR_NONFATAL, "`%%depend' expects a file name");
2253 free_tlist(origline);
2254 return DIRECTIVE_FOUND; /* but we did _something_ */
2256 if (t->next)
2257 error(ERR_WARNING|ERR_PASS1,
2258 "trailing garbage after `%%depend' ignored");
2259 p = t->text;
2260 if (t->type != TOK_INTERNAL_STRING)
2261 nasm_unquote(p, NULL);
2262 if (dephead && !in_list(*dephead, p)) {
2263 StrList *sl = nasm_malloc(strlen(p)+1+sizeof sl->next);
2264 sl->next = NULL;
2265 strcpy(sl->str, p);
2266 *deptail = sl;
2267 deptail = &sl->next;
2269 free_tlist(origline);
2270 return DIRECTIVE_FOUND;
2272 case PP_INCLUDE:
2273 t = tline->next = expand_smacro(tline->next);
2274 skip_white_(t);
2276 if (!t || (t->type != TOK_STRING &&
2277 t->type != TOK_INTERNAL_STRING)) {
2278 error(ERR_NONFATAL, "`%%include' expects a file name");
2279 free_tlist(origline);
2280 return DIRECTIVE_FOUND; /* but we did _something_ */
2282 if (t->next)
2283 error(ERR_WARNING|ERR_PASS1,
2284 "trailing garbage after `%%include' ignored");
2285 p = t->text;
2286 if (t->type != TOK_INTERNAL_STRING)
2287 nasm_unquote(p, NULL);
2288 inc = nasm_malloc(sizeof(Include));
2289 inc->next = istk;
2290 inc->conds = NULL;
2291 inc->fp = inc_fopen(p, dephead, &deptail, pass == 0);
2292 if (!inc->fp) {
2293 /* -MG given but file not found */
2294 nasm_free(inc);
2295 } else {
2296 inc->fname = src_set_fname(nasm_strdup(p));
2297 inc->lineno = src_set_linnum(0);
2298 inc->lineinc = 1;
2299 inc->expansion = NULL;
2300 inc->mstk = NULL;
2301 istk = inc;
2302 list->uplevel(LIST_INCLUDE);
2304 free_tlist(origline);
2305 return DIRECTIVE_FOUND;
2307 case PP_USE:
2309 static macros_t *use_pkg;
2310 const char *pkg_macro;
2312 t = tline->next = expand_smacro(tline->next);
2313 skip_white_(t);
2315 if (!t || (t->type != TOK_STRING &&
2316 t->type != TOK_INTERNAL_STRING &&
2317 t->type != TOK_ID)) {
2318 error(ERR_NONFATAL, "`%%use' expects a package name");
2319 free_tlist(origline);
2320 return DIRECTIVE_FOUND; /* but we did _something_ */
2322 if (t->next)
2323 error(ERR_WARNING|ERR_PASS1,
2324 "trailing garbage after `%%use' ignored");
2325 if (t->type == TOK_STRING)
2326 nasm_unquote(t->text, NULL);
2327 use_pkg = nasm_stdmac_find_package(t->text);
2328 if (!use_pkg)
2329 error(ERR_NONFATAL, "unknown `%%use' package: %s", t->text);
2330 /* The first string will be <%define>__USE_*__ */
2331 pkg_macro = (char *)use_pkg + 1;
2332 if (!smacro_defined(NULL, pkg_macro, 0, NULL, true)) {
2333 /* Not already included, go ahead and include it */
2334 stdmacpos = use_pkg;
2336 free_tlist(origline);
2337 return DIRECTIVE_FOUND;
2339 case PP_PUSH:
2340 tline = tline->next;
2341 skip_white_(tline);
2342 tline = expand_id(tline);
2343 if (tline) {
2344 if (!tok_type_(tline, TOK_ID)) {
2345 error(ERR_NONFATAL, "`%%push' expects a context identifier");
2346 free_tlist(origline);
2347 return DIRECTIVE_FOUND; /* but we did _something_ */
2349 if (tline->next)
2350 error(ERR_WARNING|ERR_PASS1,
2351 "trailing garbage after `%%push' ignored");
2352 p = nasm_strdup(tline->text);
2353 } else {
2354 p = NULL; /* Anonymous context */
2356 ctx = nasm_malloc(sizeof(Context));
2357 ctx->next = cstk;
2358 hash_init(&ctx->localmac, HASH_SMALL);
2359 ctx->name = p;
2360 ctx->number = unique++;
2361 cstk = ctx;
2362 free_tlist(origline);
2363 return DIRECTIVE_FOUND;
2365 case PP_REPL:
2366 tline = tline->next;
2367 skip_white_(tline);
2368 tline = expand_id(tline);
2369 if (tline) {
2370 if (!tok_type_(tline, TOK_ID)) {
2371 error(ERR_NONFATAL, "`%%repl' expects a context identifier");
2372 free_tlist(origline);
2373 return DIRECTIVE_FOUND; /* but we did _something_ */
2375 if (tline->next)
2376 error(ERR_WARNING|ERR_PASS1,
2377 "trailing garbage after `%%repl' ignored");
2378 p = nasm_strdup(tline->text);
2379 } else {
2380 p = NULL;
2382 if (!cstk)
2383 error(ERR_NONFATAL, "`%%repl': context stack is empty");
2384 else {
2385 nasm_free(cstk->name);
2386 cstk->name = p;
2388 free_tlist(origline);
2389 return DIRECTIVE_FOUND;
2391 case PP_POP:
2392 if (tline->next)
2393 error(ERR_WARNING|ERR_PASS1,
2394 "trailing garbage after `%%pop' ignored");
2395 if (!cstk)
2396 error(ERR_NONFATAL, "`%%pop': context stack is already empty");
2397 else
2398 ctx_pop();
2399 free_tlist(origline);
2400 return DIRECTIVE_FOUND;
2402 case PP_FATAL:
2403 severity = ERR_FATAL|ERR_NO_SEVERITY;
2404 goto issue_error;
2405 case PP_ERROR:
2406 severity = ERR_NONFATAL|ERR_NO_SEVERITY;
2407 goto issue_error;
2408 case PP_WARNING:
2409 severity = ERR_WARNING|ERR_NO_SEVERITY|ERR_WARN_USER;
2410 goto issue_error;
2412 issue_error:
2414 /* Only error out if this is the final pass */
2415 if (pass != 2 && i != PP_FATAL)
2416 return DIRECTIVE_FOUND;
2418 tline->next = expand_smacro(tline->next);
2419 tline = tline->next;
2420 skip_white_(tline);
2421 t = tline ? tline->next : NULL;
2422 skip_white_(t);
2423 if (tok_type_(tline, TOK_STRING) && !t) {
2424 /* The line contains only a quoted string */
2425 p = tline->text;
2426 nasm_unquote(p, NULL);
2427 error(severity, "%s: %s", pp_directives[i], p);
2428 } else {
2429 /* Not a quoted string, or more than a quoted string */
2430 p = detoken(tline, false);
2431 error(severity, "%s: %s", pp_directives[i], p);
2432 nasm_free(p);
2434 free_tlist(origline);
2435 return DIRECTIVE_FOUND;
2438 CASE_PP_IF:
2439 if (istk->conds && !emitting(istk->conds->state))
2440 j = COND_NEVER;
2441 else {
2442 j = if_condition(tline->next, i);
2443 tline->next = NULL; /* it got freed */
2444 j = j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2446 cond = nasm_malloc(sizeof(Cond));
2447 cond->next = istk->conds;
2448 cond->state = j;
2449 istk->conds = cond;
2450 free_tlist(origline);
2451 return DIRECTIVE_FOUND;
2453 CASE_PP_ELIF:
2454 if (!istk->conds)
2455 error(ERR_FATAL, "`%s': no matching `%%if'", pp_directives[i]);
2456 switch(istk->conds->state) {
2457 case COND_IF_TRUE:
2458 istk->conds->state = COND_DONE;
2459 break;
2461 case COND_DONE:
2462 case COND_NEVER:
2463 break;
2465 case COND_ELSE_TRUE:
2466 case COND_ELSE_FALSE:
2467 error_precond(ERR_WARNING|ERR_PASS1,
2468 "`%%elif' after `%%else' ignored");
2469 istk->conds->state = COND_NEVER;
2470 break;
2472 case COND_IF_FALSE:
2474 * IMPORTANT: In the case of %if, we will already have
2475 * called expand_mmac_params(); however, if we're
2476 * processing an %elif we must have been in a
2477 * non-emitting mode, which would have inhibited
2478 * the normal invocation of expand_indirect() and
2479 * expand_mmac_params(). Therefore, we have to do it
2480 * explicitly here.
2482 t = expand_indirect(tline->next,0);
2483 t = expand_mmac_params(t);
2484 j = if_condition(expand_mmac_params(t), i);
2485 tline->next = NULL; /* it got freed */
2486 istk->conds->state =
2487 j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2488 break;
2490 free_tlist(origline);
2491 return DIRECTIVE_FOUND;
2493 case PP_ELSE:
2494 if (tline->next)
2495 error_precond(ERR_WARNING|ERR_PASS1,
2496 "trailing garbage after `%%else' ignored");
2497 if (!istk->conds)
2498 error(ERR_FATAL, "`%%else': no matching `%%if'");
2499 switch(istk->conds->state) {
2500 case COND_IF_TRUE:
2501 case COND_DONE:
2502 istk->conds->state = COND_ELSE_FALSE;
2503 break;
2505 case COND_NEVER:
2506 break;
2508 case COND_IF_FALSE:
2509 istk->conds->state = COND_ELSE_TRUE;
2510 break;
2512 case COND_ELSE_TRUE:
2513 case COND_ELSE_FALSE:
2514 error_precond(ERR_WARNING|ERR_PASS1,
2515 "`%%else' after `%%else' ignored.");
2516 istk->conds->state = COND_NEVER;
2517 break;
2519 free_tlist(origline);
2520 return DIRECTIVE_FOUND;
2522 case PP_ENDIF:
2523 if (tline->next)
2524 error_precond(ERR_WARNING|ERR_PASS1,
2525 "trailing garbage after `%%endif' ignored");
2526 if (!istk->conds)
2527 error(ERR_FATAL, "`%%endif': no matching `%%if'");
2528 cond = istk->conds;
2529 istk->conds = cond->next;
2530 nasm_free(cond);
2531 free_tlist(origline);
2532 return DIRECTIVE_FOUND;
2534 case PP_MACRO:
2535 case PP_IMACRO:
2536 if (defining) {
2537 error(ERR_FATAL,
2538 "`%%%smacro': already defining a macro",
2539 (i == PP_IMACRO ? "i" : ""));
2540 return DIRECTIVE_FOUND;
2542 defining = nasm_malloc(sizeof(MMacro));
2543 defining->casesense = (i == PP_MACRO);
2544 if (!parse_mmacro_spec(tline, defining, pp_directives[i])) {
2545 nasm_free(defining);
2546 defining = NULL;
2547 return DIRECTIVE_FOUND;
2550 mmac = (MMacro *) hash_findix(&mmacros, defining->name);
2551 while (mmac) {
2552 if (!strcmp(mmac->name, defining->name) &&
2553 (mmac->nparam_min <= defining->nparam_max
2554 || defining->plus)
2555 && (defining->nparam_min <= mmac->nparam_max
2556 || mmac->plus)) {
2557 error(ERR_WARNING|ERR_PASS1,
2558 "redefining multi-line macro `%s'", defining->name);
2559 return DIRECTIVE_FOUND;
2561 mmac = mmac->next;
2563 free_tlist(origline);
2564 return DIRECTIVE_FOUND;
2566 case PP_ENDM:
2567 case PP_ENDMACRO:
2568 if (! (defining && defining->name)) {
2569 error(ERR_NONFATAL, "`%s': not defining a macro", tline->text);
2570 return DIRECTIVE_FOUND;
2572 mmhead = (MMacro **) hash_findi_add(&mmacros, defining->name);
2573 defining->next = *mmhead;
2574 *mmhead = defining;
2575 defining = NULL;
2576 free_tlist(origline);
2577 return DIRECTIVE_FOUND;
2579 case PP_UNMACRO:
2580 case PP_UNIMACRO:
2582 MMacro **mmac_p;
2583 MMacro spec;
2585 spec.casesense = (i == PP_UNMACRO);
2586 if (!parse_mmacro_spec(tline, &spec, pp_directives[i])) {
2587 return DIRECTIVE_FOUND;
2589 mmac_p = (MMacro **) hash_findi(&mmacros, spec.name, NULL);
2590 while (mmac_p && *mmac_p) {
2591 mmac = *mmac_p;
2592 if (mmac->casesense == spec.casesense &&
2593 !mstrcmp(mmac->name, spec.name, spec.casesense) &&
2594 mmac->nparam_min == spec.nparam_min &&
2595 mmac->nparam_max == spec.nparam_max &&
2596 mmac->plus == spec.plus) {
2597 *mmac_p = mmac->next;
2598 free_mmacro(mmac);
2599 } else {
2600 mmac_p = &mmac->next;
2603 free_tlist(origline);
2604 free_tlist(spec.dlist);
2605 return DIRECTIVE_FOUND;
2608 case PP_ROTATE:
2609 if (tline->next && tline->next->type == TOK_WHITESPACE)
2610 tline = tline->next;
2611 if (tline->next == NULL) {
2612 free_tlist(origline);
2613 error(ERR_NONFATAL, "`%%rotate' missing rotate count");
2614 return DIRECTIVE_FOUND;
2616 t = expand_smacro(tline->next);
2617 tline->next = NULL;
2618 free_tlist(origline);
2619 tline = t;
2620 tptr = &t;
2621 tokval.t_type = TOKEN_INVALID;
2622 evalresult =
2623 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2624 free_tlist(tline);
2625 if (!evalresult)
2626 return DIRECTIVE_FOUND;
2627 if (tokval.t_type)
2628 error(ERR_WARNING|ERR_PASS1,
2629 "trailing garbage after expression ignored");
2630 if (!is_simple(evalresult)) {
2631 error(ERR_NONFATAL, "non-constant value given to `%%rotate'");
2632 return DIRECTIVE_FOUND;
2634 mmac = istk->mstk;
2635 while (mmac && !mmac->name) /* avoid mistaking %reps for macros */
2636 mmac = mmac->next_active;
2637 if (!mmac) {
2638 error(ERR_NONFATAL, "`%%rotate' invoked outside a macro call");
2639 } else if (mmac->nparam == 0) {
2640 error(ERR_NONFATAL,
2641 "`%%rotate' invoked within macro without parameters");
2642 } else {
2643 int rotate = mmac->rotate + reloc_value(evalresult);
2645 rotate %= (int)mmac->nparam;
2646 if (rotate < 0)
2647 rotate += mmac->nparam;
2649 mmac->rotate = rotate;
2651 return DIRECTIVE_FOUND;
2653 case PP_REP:
2654 nolist = false;
2655 do {
2656 tline = tline->next;
2657 } while (tok_type_(tline, TOK_WHITESPACE));
2659 if (tok_type_(tline, TOK_ID) &&
2660 nasm_stricmp(tline->text, ".nolist") == 0) {
2661 nolist = true;
2662 do {
2663 tline = tline->next;
2664 } while (tok_type_(tline, TOK_WHITESPACE));
2667 if (tline) {
2668 t = expand_smacro(tline);
2669 tptr = &t;
2670 tokval.t_type = TOKEN_INVALID;
2671 evalresult =
2672 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2673 if (!evalresult) {
2674 free_tlist(origline);
2675 return DIRECTIVE_FOUND;
2677 if (tokval.t_type)
2678 error(ERR_WARNING|ERR_PASS1,
2679 "trailing garbage after expression ignored");
2680 if (!is_simple(evalresult)) {
2681 error(ERR_NONFATAL, "non-constant value given to `%%rep'");
2682 return DIRECTIVE_FOUND;
2684 count = reloc_value(evalresult) + 1;
2685 } else {
2686 error(ERR_NONFATAL, "`%%rep' expects a repeat count");
2687 count = 0;
2689 free_tlist(origline);
2691 tmp_defining = defining;
2692 defining = nasm_malloc(sizeof(MMacro));
2693 defining->name = NULL; /* flags this macro as a %rep block */
2694 defining->casesense = false;
2695 defining->plus = false;
2696 defining->nolist = nolist;
2697 defining->in_progress = count;
2698 defining->nparam_min = defining->nparam_max = 0;
2699 defining->defaults = NULL;
2700 defining->dlist = NULL;
2701 defining->expansion = NULL;
2702 defining->next_active = istk->mstk;
2703 defining->rep_nest = tmp_defining;
2704 return DIRECTIVE_FOUND;
2706 case PP_ENDREP:
2707 if (!defining || defining->name) {
2708 error(ERR_NONFATAL, "`%%endrep': no matching `%%rep'");
2709 return DIRECTIVE_FOUND;
2713 * Now we have a "macro" defined - although it has no name
2714 * and we won't be entering it in the hash tables - we must
2715 * push a macro-end marker for it on to istk->expansion.
2716 * After that, it will take care of propagating itself (a
2717 * macro-end marker line for a macro which is really a %rep
2718 * block will cause the macro to be re-expanded, complete
2719 * with another macro-end marker to ensure the process
2720 * continues) until the whole expansion is forcibly removed
2721 * from istk->expansion by a %exitrep.
2723 l = nasm_malloc(sizeof(Line));
2724 l->next = istk->expansion;
2725 l->finishes = defining;
2726 l->first = NULL;
2727 istk->expansion = l;
2729 istk->mstk = defining;
2731 list->uplevel(defining->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
2732 tmp_defining = defining;
2733 defining = defining->rep_nest;
2734 free_tlist(origline);
2735 return DIRECTIVE_FOUND;
2737 case PP_EXITREP:
2739 * We must search along istk->expansion until we hit a
2740 * macro-end marker for a macro with no name. Then we set
2741 * its `in_progress' flag to 0.
2743 for (l = istk->expansion; l; l = l->next)
2744 if (l->finishes && !l->finishes->name)
2745 break;
2747 if (l)
2748 l->finishes->in_progress = 1;
2749 else
2750 error(ERR_NONFATAL, "`%%exitrep' not within `%%rep' block");
2751 free_tlist(origline);
2752 return DIRECTIVE_FOUND;
2754 case PP_XDEFINE:
2755 case PP_IXDEFINE:
2756 case PP_DEFINE:
2757 case PP_IDEFINE:
2758 casesense = (i == PP_DEFINE || i == PP_XDEFINE);
2760 tline = tline->next;
2761 skip_white_(tline);
2762 tline = expand_id(tline);
2763 if (!tline || (tline->type != TOK_ID &&
2764 (tline->type != TOK_PREPROC_ID ||
2765 tline->text[1] != '$'))) {
2766 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2767 pp_directives[i]);
2768 free_tlist(origline);
2769 return DIRECTIVE_FOUND;
2772 ctx = get_ctx(tline->text, false);
2774 mname = tline->text;
2775 last = tline;
2776 param_start = tline = tline->next;
2777 nparam = 0;
2779 /* Expand the macro definition now for %xdefine and %ixdefine */
2780 if ((i == PP_XDEFINE) || (i == PP_IXDEFINE))
2781 tline = expand_smacro(tline);
2783 if (tok_is_(tline, "(")) {
2785 * This macro has parameters.
2788 tline = tline->next;
2789 while (1) {
2790 skip_white_(tline);
2791 if (!tline) {
2792 error(ERR_NONFATAL, "parameter identifier expected");
2793 free_tlist(origline);
2794 return DIRECTIVE_FOUND;
2796 if (tline->type != TOK_ID) {
2797 error(ERR_NONFATAL,
2798 "`%s': parameter identifier expected",
2799 tline->text);
2800 free_tlist(origline);
2801 return DIRECTIVE_FOUND;
2803 tline->type = TOK_SMAC_PARAM + nparam++;
2804 tline = tline->next;
2805 skip_white_(tline);
2806 if (tok_is_(tline, ",")) {
2807 tline = tline->next;
2808 } else {
2809 if (!tok_is_(tline, ")")) {
2810 error(ERR_NONFATAL,
2811 "`)' expected to terminate macro template");
2812 free_tlist(origline);
2813 return DIRECTIVE_FOUND;
2815 break;
2818 last = tline;
2819 tline = tline->next;
2821 if (tok_type_(tline, TOK_WHITESPACE))
2822 last = tline, tline = tline->next;
2823 macro_start = NULL;
2824 last->next = NULL;
2825 t = tline;
2826 while (t) {
2827 if (t->type == TOK_ID) {
2828 for (tt = param_start; tt; tt = tt->next)
2829 if (tt->type >= TOK_SMAC_PARAM &&
2830 !strcmp(tt->text, t->text))
2831 t->type = tt->type;
2833 tt = t->next;
2834 t->next = macro_start;
2835 macro_start = t;
2836 t = tt;
2839 * Good. We now have a macro name, a parameter count, and a
2840 * token list (in reverse order) for an expansion. We ought
2841 * to be OK just to create an SMacro, store it, and let
2842 * free_tlist have the rest of the line (which we have
2843 * carefully re-terminated after chopping off the expansion
2844 * from the end).
2846 define_smacro(ctx, mname, casesense, nparam, macro_start);
2847 free_tlist(origline);
2848 return DIRECTIVE_FOUND;
2850 case PP_UNDEF:
2851 tline = tline->next;
2852 skip_white_(tline);
2853 tline = expand_id(tline);
2854 if (!tline || (tline->type != TOK_ID &&
2855 (tline->type != TOK_PREPROC_ID ||
2856 tline->text[1] != '$'))) {
2857 error(ERR_NONFATAL, "`%%undef' expects a macro identifier");
2858 free_tlist(origline);
2859 return DIRECTIVE_FOUND;
2861 if (tline->next) {
2862 error(ERR_WARNING|ERR_PASS1,
2863 "trailing garbage after macro name ignored");
2866 /* Find the context that symbol belongs to */
2867 ctx = get_ctx(tline->text, false);
2868 undef_smacro(ctx, tline->text);
2869 free_tlist(origline);
2870 return DIRECTIVE_FOUND;
2872 case PP_DEFSTR:
2873 case PP_IDEFSTR:
2874 casesense = (i == PP_DEFSTR);
2876 tline = tline->next;
2877 skip_white_(tline);
2878 tline = expand_id(tline);
2879 if (!tline || (tline->type != TOK_ID &&
2880 (tline->type != TOK_PREPROC_ID ||
2881 tline->text[1] != '$'))) {
2882 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2883 pp_directives[i]);
2884 free_tlist(origline);
2885 return DIRECTIVE_FOUND;
2888 ctx = get_ctx(tline->text, false);
2890 mname = tline->text;
2891 last = tline;
2892 tline = expand_smacro(tline->next);
2893 last->next = NULL;
2895 while (tok_type_(tline, TOK_WHITESPACE))
2896 tline = delete_Token(tline);
2898 p = detoken(tline, false);
2899 macro_start = nasm_malloc(sizeof(*macro_start));
2900 macro_start->next = NULL;
2901 macro_start->text = nasm_quote(p, strlen(p));
2902 macro_start->type = TOK_STRING;
2903 macro_start->a.mac = NULL;
2904 nasm_free(p);
2907 * We now have a macro name, an implicit parameter count of
2908 * zero, and a string token to use as an expansion. Create
2909 * and store an SMacro.
2911 define_smacro(ctx, mname, casesense, 0, macro_start);
2912 free_tlist(origline);
2913 return DIRECTIVE_FOUND;
2915 case PP_PATHSEARCH:
2917 FILE *fp;
2918 StrList *xsl = NULL;
2919 StrList **xst = &xsl;
2921 casesense = true;
2923 tline = tline->next;
2924 skip_white_(tline);
2925 tline = expand_id(tline);
2926 if (!tline || (tline->type != TOK_ID &&
2927 (tline->type != TOK_PREPROC_ID ||
2928 tline->text[1] != '$'))) {
2929 error(ERR_NONFATAL,
2930 "`%%pathsearch' expects a macro identifier as first parameter");
2931 free_tlist(origline);
2932 return DIRECTIVE_FOUND;
2934 ctx = get_ctx(tline->text, false);
2936 mname = tline->text;
2937 last = tline;
2938 tline = expand_smacro(tline->next);
2939 last->next = NULL;
2941 t = tline;
2942 while (tok_type_(t, TOK_WHITESPACE))
2943 t = t->next;
2945 if (!t || (t->type != TOK_STRING &&
2946 t->type != TOK_INTERNAL_STRING)) {
2947 error(ERR_NONFATAL, "`%%pathsearch' expects a file name");
2948 free_tlist(tline);
2949 free_tlist(origline);
2950 return DIRECTIVE_FOUND; /* but we did _something_ */
2952 if (t->next)
2953 error(ERR_WARNING|ERR_PASS1,
2954 "trailing garbage after `%%pathsearch' ignored");
2955 p = t->text;
2956 if (t->type != TOK_INTERNAL_STRING)
2957 nasm_unquote(p, NULL);
2959 fp = inc_fopen(p, &xsl, &xst, true);
2960 if (fp) {
2961 p = xsl->str;
2962 fclose(fp); /* Don't actually care about the file */
2964 macro_start = nasm_malloc(sizeof(*macro_start));
2965 macro_start->next = NULL;
2966 macro_start->text = nasm_quote(p, strlen(p));
2967 macro_start->type = TOK_STRING;
2968 macro_start->a.mac = NULL;
2969 if (xsl)
2970 nasm_free(xsl);
2973 * We now have a macro name, an implicit parameter count of
2974 * zero, and a string token to use as an expansion. Create
2975 * and store an SMacro.
2977 define_smacro(ctx, mname, casesense, 0, macro_start);
2978 free_tlist(tline);
2979 free_tlist(origline);
2980 return DIRECTIVE_FOUND;
2983 case PP_STRLEN:
2984 casesense = true;
2986 tline = tline->next;
2987 skip_white_(tline);
2988 tline = expand_id(tline);
2989 if (!tline || (tline->type != TOK_ID &&
2990 (tline->type != TOK_PREPROC_ID ||
2991 tline->text[1] != '$'))) {
2992 error(ERR_NONFATAL,
2993 "`%%strlen' expects a macro identifier as first parameter");
2994 free_tlist(origline);
2995 return DIRECTIVE_FOUND;
2997 ctx = get_ctx(tline->text, false);
2999 mname = tline->text;
3000 last = tline;
3001 tline = expand_smacro(tline->next);
3002 last->next = NULL;
3004 t = tline;
3005 while (tok_type_(t, TOK_WHITESPACE))
3006 t = t->next;
3007 /* t should now point to the string */
3008 if (t->type != TOK_STRING) {
3009 error(ERR_NONFATAL,
3010 "`%%strlen` requires string as second parameter");
3011 free_tlist(tline);
3012 free_tlist(origline);
3013 return DIRECTIVE_FOUND;
3016 macro_start = nasm_malloc(sizeof(*macro_start));
3017 macro_start->next = NULL;
3018 make_tok_num(macro_start, nasm_unquote(t->text, NULL));
3019 macro_start->a.mac = NULL;
3022 * We now have a macro name, an implicit parameter count of
3023 * zero, and a numeric token to use as an expansion. Create
3024 * and store an SMacro.
3026 define_smacro(ctx, mname, casesense, 0, macro_start);
3027 free_tlist(tline);
3028 free_tlist(origline);
3029 return DIRECTIVE_FOUND;
3031 case PP_STRCAT:
3032 casesense = true;
3034 tline = tline->next;
3035 skip_white_(tline);
3036 tline = expand_id(tline);
3037 if (!tline || (tline->type != TOK_ID &&
3038 (tline->type != TOK_PREPROC_ID ||
3039 tline->text[1] != '$'))) {
3040 error(ERR_NONFATAL,
3041 "`%%strcat' expects a macro identifier as first parameter");
3042 free_tlist(origline);
3043 return DIRECTIVE_FOUND;
3045 ctx = get_ctx(tline->text, false);
3047 mname = tline->text;
3048 last = tline;
3049 tline = expand_smacro(tline->next);
3050 last->next = NULL;
3052 len = 0;
3053 for (t = tline; t; t = t->next) {
3054 switch (t->type) {
3055 case TOK_WHITESPACE:
3056 break;
3057 case TOK_STRING:
3058 len += t->a.len = nasm_unquote(t->text, NULL);
3059 break;
3060 case TOK_OTHER:
3061 if (!strcmp(t->text, ",")) /* permit comma separators */
3062 break;
3063 /* else fall through */
3064 default:
3065 error(ERR_NONFATAL,
3066 "non-string passed to `%%strcat' (%d)", t->type);
3067 free_tlist(tline);
3068 free_tlist(origline);
3069 return DIRECTIVE_FOUND;
3073 p = pp = nasm_malloc(len);
3074 t = tline;
3075 for (t = tline; t; t = t->next) {
3076 if (t->type == TOK_STRING) {
3077 memcpy(p, t->text, t->a.len);
3078 p += t->a.len;
3083 * We now have a macro name, an implicit parameter count of
3084 * zero, and a numeric token to use as an expansion. Create
3085 * and store an SMacro.
3087 macro_start = new_Token(NULL, TOK_STRING, NULL, 0);
3088 macro_start->text = nasm_quote(pp, len);
3089 nasm_free(pp);
3090 define_smacro(ctx, mname, casesense, 0, macro_start);
3091 free_tlist(tline);
3092 free_tlist(origline);
3093 return DIRECTIVE_FOUND;
3095 case PP_SUBSTR:
3097 int64_t a1, a2;
3098 size_t len;
3100 casesense = true;
3102 tline = tline->next;
3103 skip_white_(tline);
3104 tline = expand_id(tline);
3105 if (!tline || (tline->type != TOK_ID &&
3106 (tline->type != TOK_PREPROC_ID ||
3107 tline->text[1] != '$'))) {
3108 error(ERR_NONFATAL,
3109 "`%%substr' expects a macro identifier as first parameter");
3110 free_tlist(origline);
3111 return DIRECTIVE_FOUND;
3113 ctx = get_ctx(tline->text, false);
3115 mname = tline->text;
3116 last = tline;
3117 tline = expand_smacro(tline->next);
3118 last->next = NULL;
3120 t = tline->next;
3121 while (tok_type_(t, TOK_WHITESPACE))
3122 t = t->next;
3124 /* t should now point to the string */
3125 if (t->type != TOK_STRING) {
3126 error(ERR_NONFATAL,
3127 "`%%substr` requires string as second parameter");
3128 free_tlist(tline);
3129 free_tlist(origline);
3130 return DIRECTIVE_FOUND;
3133 tt = t->next;
3134 tptr = &tt;
3135 tokval.t_type = TOKEN_INVALID;
3136 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3137 pass, error, NULL);
3138 if (!evalresult) {
3139 free_tlist(tline);
3140 free_tlist(origline);
3141 return DIRECTIVE_FOUND;
3142 } else if (!is_simple(evalresult)) {
3143 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3144 free_tlist(tline);
3145 free_tlist(origline);
3146 return DIRECTIVE_FOUND;
3148 a1 = evalresult->value-1;
3150 while (tok_type_(tt, TOK_WHITESPACE))
3151 tt = tt->next;
3152 if (!tt) {
3153 a2 = 1; /* Backwards compatibility: one character */
3154 } else {
3155 tokval.t_type = TOKEN_INVALID;
3156 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3157 pass, error, NULL);
3158 if (!evalresult) {
3159 free_tlist(tline);
3160 free_tlist(origline);
3161 return DIRECTIVE_FOUND;
3162 } else if (!is_simple(evalresult)) {
3163 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3164 free_tlist(tline);
3165 free_tlist(origline);
3166 return DIRECTIVE_FOUND;
3168 a2 = evalresult->value;
3171 len = nasm_unquote(t->text, NULL);
3172 if (a2 < 0)
3173 a2 = a2+1+len-a1;
3174 if (a1+a2 > (int64_t)len)
3175 a2 = len-a1;
3177 macro_start = nasm_malloc(sizeof(*macro_start));
3178 macro_start->next = NULL;
3179 macro_start->text = nasm_quote((a1 < 0) ? "" : t->text+a1, a2);
3180 macro_start->type = TOK_STRING;
3181 macro_start->a.mac = NULL;
3184 * We now have a macro name, an implicit parameter count of
3185 * zero, and a numeric token to use as an expansion. Create
3186 * and store an SMacro.
3188 define_smacro(ctx, mname, casesense, 0, macro_start);
3189 free_tlist(tline);
3190 free_tlist(origline);
3191 return DIRECTIVE_FOUND;
3194 case PP_ASSIGN:
3195 case PP_IASSIGN:
3196 casesense = (i == PP_ASSIGN);
3198 tline = tline->next;
3199 skip_white_(tline);
3200 tline = expand_id(tline);
3201 if (!tline || (tline->type != TOK_ID &&
3202 (tline->type != TOK_PREPROC_ID ||
3203 tline->text[1] != '$'))) {
3204 error(ERR_NONFATAL,
3205 "`%%%sassign' expects a macro identifier",
3206 (i == PP_IASSIGN ? "i" : ""));
3207 free_tlist(origline);
3208 return DIRECTIVE_FOUND;
3210 ctx = get_ctx(tline->text, false);
3212 mname = tline->text;
3213 last = tline;
3214 tline = expand_smacro(tline->next);
3215 last->next = NULL;
3217 t = tline;
3218 tptr = &t;
3219 tokval.t_type = TOKEN_INVALID;
3220 evalresult =
3221 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
3222 free_tlist(tline);
3223 if (!evalresult) {
3224 free_tlist(origline);
3225 return DIRECTIVE_FOUND;
3228 if (tokval.t_type)
3229 error(ERR_WARNING|ERR_PASS1,
3230 "trailing garbage after expression ignored");
3232 if (!is_simple(evalresult)) {
3233 error(ERR_NONFATAL,
3234 "non-constant value given to `%%%sassign'",
3235 (i == PP_IASSIGN ? "i" : ""));
3236 free_tlist(origline);
3237 return DIRECTIVE_FOUND;
3240 macro_start = nasm_malloc(sizeof(*macro_start));
3241 macro_start->next = NULL;
3242 make_tok_num(macro_start, reloc_value(evalresult));
3243 macro_start->a.mac = NULL;
3246 * We now have a macro name, an implicit parameter count of
3247 * zero, and a numeric token to use as an expansion. Create
3248 * and store an SMacro.
3250 define_smacro(ctx, mname, casesense, 0, macro_start);
3251 free_tlist(origline);
3252 return DIRECTIVE_FOUND;
3254 case PP_LINE:
3256 * Syntax is `%line nnn[+mmm] [filename]'
3258 tline = tline->next;
3259 skip_white_(tline);
3260 if (!tok_type_(tline, TOK_NUMBER)) {
3261 error(ERR_NONFATAL, "`%%line' expects line number");
3262 free_tlist(origline);
3263 return DIRECTIVE_FOUND;
3265 k = readnum(tline->text, &err);
3266 m = 1;
3267 tline = tline->next;
3268 if (tok_is_(tline, "+")) {
3269 tline = tline->next;
3270 if (!tok_type_(tline, TOK_NUMBER)) {
3271 error(ERR_NONFATAL, "`%%line' expects line increment");
3272 free_tlist(origline);
3273 return DIRECTIVE_FOUND;
3275 m = readnum(tline->text, &err);
3276 tline = tline->next;
3278 skip_white_(tline);
3279 src_set_linnum(k);
3280 istk->lineinc = m;
3281 if (tline) {
3282 nasm_free(src_set_fname(detoken(tline, false)));
3284 free_tlist(origline);
3285 return DIRECTIVE_FOUND;
3287 default:
3288 error(ERR_FATAL,
3289 "preprocessor directive `%s' not yet implemented",
3290 pp_directives[i]);
3291 return DIRECTIVE_FOUND;
3296 * Ensure that a macro parameter contains a condition code and
3297 * nothing else. Return the condition code index if so, or -1
3298 * otherwise.
3300 static int find_cc(Token * t)
3302 Token *tt;
3303 int i, j, k, m;
3305 if (!t)
3306 return -1; /* Probably a %+ without a space */
3308 skip_white_(t);
3309 if (t->type != TOK_ID)
3310 return -1;
3311 tt = t->next;
3312 skip_white_(tt);
3313 if (tt && (tt->type != TOK_OTHER || strcmp(tt->text, ",")))
3314 return -1;
3316 i = -1;
3317 j = elements(conditions);
3318 while (j - i > 1) {
3319 k = (j + i) / 2;
3320 m = nasm_stricmp(t->text, conditions[k]);
3321 if (m == 0) {
3322 i = k;
3323 j = -2;
3324 break;
3325 } else if (m < 0) {
3326 j = k;
3327 } else
3328 i = k;
3330 if (j != -2)
3331 return -1;
3332 return i;
3336 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3337 * %-n) and MMacro-local identifiers (%%foo).
3339 static Token *expand_mmac_params(Token * tline)
3341 Token *t, *tt, **tail, *thead;
3343 tail = &thead;
3344 thead = NULL;
3346 while (tline) {
3347 if (tline->type == TOK_PREPROC_ID &&
3348 (((tline->text[1] == '+' || tline->text[1] == '-')
3349 && tline->text[2]) || tline->text[1] == '%'
3350 || (tline->text[1] >= '0' && tline->text[1] <= '9'))) {
3351 char *text = NULL;
3352 int type = 0, cc; /* type = 0 to placate optimisers */
3353 char tmpbuf[30];
3354 unsigned int n;
3355 int i;
3356 MMacro *mac;
3358 t = tline;
3359 tline = tline->next;
3361 mac = istk->mstk;
3362 while (mac && !mac->name) /* avoid mistaking %reps for macros */
3363 mac = mac->next_active;
3364 if (!mac)
3365 error(ERR_NONFATAL, "`%s': not in a macro call", t->text);
3366 else
3367 switch (t->text[1]) {
3369 * We have to make a substitution of one of the
3370 * forms %1, %-1, %+1, %%foo, %0.
3372 case '0':
3373 type = TOK_NUMBER;
3374 snprintf(tmpbuf, sizeof(tmpbuf), "%d", mac->nparam);
3375 text = nasm_strdup(tmpbuf);
3376 break;
3377 case '%':
3378 type = TOK_ID;
3379 snprintf(tmpbuf, sizeof(tmpbuf), "..@%"PRIu64".",
3380 mac->unique);
3381 text = nasm_strcat(tmpbuf, t->text + 2);
3382 break;
3383 case '-':
3384 n = atoi(t->text + 2) - 1;
3385 if (n >= mac->nparam)
3386 tt = NULL;
3387 else {
3388 if (mac->nparam > 1)
3389 n = (n + mac->rotate) % mac->nparam;
3390 tt = mac->params[n];
3392 cc = find_cc(tt);
3393 if (cc == -1) {
3394 error(ERR_NONFATAL,
3395 "macro parameter %d is not a condition code",
3396 n + 1);
3397 text = NULL;
3398 } else {
3399 type = TOK_ID;
3400 if (inverse_ccs[cc] == -1) {
3401 error(ERR_NONFATAL,
3402 "condition code `%s' is not invertible",
3403 conditions[cc]);
3404 text = NULL;
3405 } else
3406 text =
3407 nasm_strdup(conditions[inverse_ccs[cc]]);
3409 break;
3410 case '+':
3411 n = atoi(t->text + 2) - 1;
3412 if (n >= mac->nparam)
3413 tt = NULL;
3414 else {
3415 if (mac->nparam > 1)
3416 n = (n + mac->rotate) % mac->nparam;
3417 tt = mac->params[n];
3419 cc = find_cc(tt);
3420 if (cc == -1) {
3421 error(ERR_NONFATAL,
3422 "macro parameter %d is not a condition code",
3423 n + 1);
3424 text = NULL;
3425 } else {
3426 type = TOK_ID;
3427 text = nasm_strdup(conditions[cc]);
3429 break;
3430 default:
3431 n = atoi(t->text + 1) - 1;
3432 if (n >= mac->nparam)
3433 tt = NULL;
3434 else {
3435 if (mac->nparam > 1)
3436 n = (n + mac->rotate) % mac->nparam;
3437 tt = mac->params[n];
3439 if (tt) {
3440 for (i = 0; i < mac->paramlen[n]; i++) {
3441 *tail = new_Token(NULL, tt->type, tt->text, 0);
3442 tail = &(*tail)->next;
3443 tt = tt->next;
3446 text = NULL; /* we've done it here */
3447 break;
3449 if (!text) {
3450 delete_Token(t);
3451 } else {
3452 *tail = t;
3453 tail = &t->next;
3454 t->type = type;
3455 nasm_free(t->text);
3456 t->text = text;
3457 t->a.mac = NULL;
3459 continue;
3460 } else {
3461 t = *tail = tline;
3462 tline = tline->next;
3463 t->a.mac = NULL;
3464 tail = &t->next;
3467 *tail = NULL;
3468 t = thead;
3469 for (; t && (tt = t->next) != NULL; t = t->next)
3470 switch (t->type) {
3471 case TOK_WHITESPACE:
3472 if (tt->type == TOK_WHITESPACE) {
3473 t->next = delete_Token(tt);
3475 break;
3476 case TOK_ID:
3477 case TOK_NUMBER:
3478 if (tt->type == t->type || tt->type == TOK_NUMBER) {
3479 char *tmp = nasm_strcat(t->text, tt->text);
3480 nasm_free(t->text);
3481 t->text = tmp;
3482 t->next = delete_Token(tt);
3484 break;
3485 default:
3486 break;
3489 return thead;
3493 * Expand all single-line macro calls made in the given line.
3494 * Return the expanded version of the line. The original is deemed
3495 * to be destroyed in the process. (In reality we'll just move
3496 * Tokens from input to output a lot of the time, rather than
3497 * actually bothering to destroy and replicate.)
3499 #define DEADMAN_LIMIT (1 << 20)
3501 static Token *expand_smacro(Token * tline)
3503 Token *t, *tt, *mstart, **tail, *thead;
3504 struct hash_table *smtbl;
3505 SMacro *head = NULL, *m;
3506 Token **params;
3507 int *paramsize;
3508 unsigned int nparam, sparam;
3509 int brackets, rescan;
3510 Token *org_tline = tline;
3511 Context *ctx;
3512 char *mname;
3513 int deadman = DEADMAN_LIMIT;
3516 * Trick: we should avoid changing the start token pointer since it can
3517 * be contained in "next" field of other token. Because of this
3518 * we allocate a copy of first token and work with it; at the end of
3519 * routine we copy it back
3521 if (org_tline) {
3522 tline =
3523 new_Token(org_tline->next, org_tline->type, org_tline->text,
3525 tline->a.mac = org_tline->a.mac;
3526 nasm_free(org_tline->text);
3527 org_tline->text = NULL;
3530 again:
3531 tail = &thead;
3532 thead = NULL;
3534 while (tline) { /* main token loop */
3535 if (!--deadman) {
3536 error(ERR_NONFATAL, "interminable macro recursion");
3537 break;
3540 if ((mname = tline->text)) {
3541 /* if this token is a local macro, look in local context */
3542 ctx = NULL;
3543 smtbl = &smacros;
3544 if (tline->type == TOK_ID || tline->type == TOK_PREPROC_ID) {
3545 ctx = get_ctx(mname, true);
3546 if (ctx)
3547 smtbl = &ctx->localmac;
3549 head = (SMacro *) hash_findix(smtbl, mname);
3552 * We've hit an identifier. As in is_mmacro below, we first
3553 * check whether the identifier is a single-line macro at
3554 * all, then think about checking for parameters if
3555 * necessary.
3557 for (m = head; m; m = m->next)
3558 if (!mstrcmp(m->name, mname, m->casesense))
3559 break;
3560 if (m) {
3561 mstart = tline;
3562 params = NULL;
3563 paramsize = NULL;
3564 if (m->nparam == 0) {
3566 * Simple case: the macro is parameterless. Discard the
3567 * one token that the macro call took, and push the
3568 * expansion back on the to-do stack.
3570 if (!m->expansion) {
3571 if (!strcmp("__FILE__", m->name)) {
3572 int32_t num = 0;
3573 char *file = NULL;
3574 src_get(&num, &file);
3575 tline->text = nasm_quote(file, strlen(file));
3576 tline->type = TOK_STRING;
3577 nasm_free(file);
3578 continue;
3580 if (!strcmp("__LINE__", m->name)) {
3581 nasm_free(tline->text);
3582 make_tok_num(tline, src_get_linnum());
3583 continue;
3585 if (!strcmp("__BITS__", m->name)) {
3586 nasm_free(tline->text);
3587 make_tok_num(tline, globalbits);
3588 continue;
3590 tline = delete_Token(tline);
3591 continue;
3593 } else {
3595 * Complicated case: at least one macro with this name
3596 * exists and takes parameters. We must find the
3597 * parameters in the call, count them, find the SMacro
3598 * that corresponds to that form of the macro call, and
3599 * substitute for the parameters when we expand. What a
3600 * pain.
3602 /*tline = tline->next;
3603 skip_white_(tline); */
3604 do {
3605 t = tline->next;
3606 while (tok_type_(t, TOK_SMAC_END)) {
3607 t->a.mac->in_progress = false;
3608 t->text = NULL;
3609 t = tline->next = delete_Token(t);
3611 tline = t;
3612 } while (tok_type_(tline, TOK_WHITESPACE));
3613 if (!tok_is_(tline, "(")) {
3615 * This macro wasn't called with parameters: ignore
3616 * the call. (Behaviour borrowed from gnu cpp.)
3618 tline = mstart;
3619 m = NULL;
3620 } else {
3621 int paren = 0;
3622 int white = 0;
3623 brackets = 0;
3624 nparam = 0;
3625 sparam = PARAM_DELTA;
3626 params = nasm_malloc(sparam * sizeof(Token *));
3627 params[0] = tline->next;
3628 paramsize = nasm_malloc(sparam * sizeof(int));
3629 paramsize[0] = 0;
3630 while (true) { /* parameter loop */
3632 * For some unusual expansions
3633 * which concatenates function call
3635 t = tline->next;
3636 while (tok_type_(t, TOK_SMAC_END)) {
3637 t->a.mac->in_progress = false;
3638 t->text = NULL;
3639 t = tline->next = delete_Token(t);
3641 tline = t;
3643 if (!tline) {
3644 error(ERR_NONFATAL,
3645 "macro call expects terminating `)'");
3646 break;
3648 if (tline->type == TOK_WHITESPACE
3649 && brackets <= 0) {
3650 if (paramsize[nparam])
3651 white++;
3652 else
3653 params[nparam] = tline->next;
3654 continue; /* parameter loop */
3656 if (tline->type == TOK_OTHER
3657 && tline->text[1] == 0) {
3658 char ch = tline->text[0];
3659 if (ch == ',' && !paren && brackets <= 0) {
3660 if (++nparam >= sparam) {
3661 sparam += PARAM_DELTA;
3662 params = nasm_realloc(params,
3663 sparam *
3664 sizeof(Token
3665 *));
3666 paramsize =
3667 nasm_realloc(paramsize,
3668 sparam *
3669 sizeof(int));
3671 params[nparam] = tline->next;
3672 paramsize[nparam] = 0;
3673 white = 0;
3674 continue; /* parameter loop */
3676 if (ch == '{' &&
3677 (brackets > 0 || (brackets == 0 &&
3678 !paramsize[nparam])))
3680 if (!(brackets++)) {
3681 params[nparam] = tline->next;
3682 continue; /* parameter loop */
3685 if (ch == '}' && brackets > 0)
3686 if (--brackets == 0) {
3687 brackets = -1;
3688 continue; /* parameter loop */
3690 if (ch == '(' && !brackets)
3691 paren++;
3692 if (ch == ')' && brackets <= 0)
3693 if (--paren < 0)
3694 break;
3696 if (brackets < 0) {
3697 brackets = 0;
3698 error(ERR_NONFATAL, "braces do not "
3699 "enclose all of macro parameter");
3701 paramsize[nparam] += white + 1;
3702 white = 0;
3703 } /* parameter loop */
3704 nparam++;
3705 while (m && (m->nparam != nparam ||
3706 mstrcmp(m->name, mname,
3707 m->casesense)))
3708 m = m->next;
3709 if (!m)
3710 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
3711 "macro `%s' exists, "
3712 "but not taking %d parameters",
3713 mstart->text, nparam);
3716 if (m && m->in_progress)
3717 m = NULL;
3718 if (!m) { /* in progess or didn't find '(' or wrong nparam */
3720 * Design question: should we handle !tline, which
3721 * indicates missing ')' here, or expand those
3722 * macros anyway, which requires the (t) test a few
3723 * lines down?
3725 nasm_free(params);
3726 nasm_free(paramsize);
3727 tline = mstart;
3728 } else {
3730 * Expand the macro: we are placed on the last token of the
3731 * call, so that we can easily split the call from the
3732 * following tokens. We also start by pushing an SMAC_END
3733 * token for the cycle removal.
3735 t = tline;
3736 if (t) {
3737 tline = t->next;
3738 t->next = NULL;
3740 tt = new_Token(tline, TOK_SMAC_END, NULL, 0);
3741 tt->a.mac = m;
3742 m->in_progress = true;
3743 tline = tt;
3744 for (t = m->expansion; t; t = t->next) {
3745 if (t->type >= TOK_SMAC_PARAM) {
3746 Token *pcopy = tline, **ptail = &pcopy;
3747 Token *ttt, *pt;
3748 int i;
3750 ttt = params[t->type - TOK_SMAC_PARAM];
3751 for (i = paramsize[t->type - TOK_SMAC_PARAM];
3752 --i >= 0;) {
3753 pt = *ptail =
3754 new_Token(tline, ttt->type, ttt->text,
3756 ptail = &pt->next;
3757 ttt = ttt->next;
3759 tline = pcopy;
3760 } else if (t->type == TOK_PREPROC_Q) {
3761 tt = new_Token(tline, TOK_ID, mname, 0);
3762 tline = tt;
3763 } else if (t->type == TOK_PREPROC_QQ) {
3764 tt = new_Token(tline, TOK_ID, m->name, 0);
3765 tline = tt;
3766 } else {
3767 tt = new_Token(tline, t->type, t->text, 0);
3768 tline = tt;
3773 * Having done that, get rid of the macro call, and clean
3774 * up the parameters.
3776 nasm_free(params);
3777 nasm_free(paramsize);
3778 free_tlist(mstart);
3779 continue; /* main token loop */
3784 if (tline->type == TOK_SMAC_END) {
3785 tline->a.mac->in_progress = false;
3786 tline = delete_Token(tline);
3787 } else {
3788 t = *tail = tline;
3789 tline = tline->next;
3790 t->a.mac = NULL;
3791 t->next = NULL;
3792 tail = &t->next;
3797 * Now scan the entire line and look for successive TOK_IDs that resulted
3798 * after expansion (they can't be produced by tokenize()). The successive
3799 * TOK_IDs should be concatenated.
3800 * Also we look for %+ tokens and concatenate the tokens before and after
3801 * them (without white spaces in between).
3803 t = thead;
3804 rescan = 0;
3805 while (t) {
3806 while (t && t->type != TOK_ID && t->type != TOK_PREPROC_ID)
3807 t = t->next;
3808 if (!t || !t->next)
3809 break;
3810 if (t->next->type == TOK_ID ||
3811 t->next->type == TOK_PREPROC_ID ||
3812 t->next->type == TOK_NUMBER) {
3813 char *p = nasm_strcat(t->text, t->next->text);
3814 nasm_free(t->text);
3815 t->next = delete_Token(t->next);
3816 t->text = p;
3817 rescan = 1;
3818 } else if (t->next->type == TOK_WHITESPACE && t->next->next &&
3819 t->next->next->type == TOK_PREPROC_ID &&
3820 strcmp(t->next->next->text, "%+") == 0) {
3821 /* free the next whitespace, the %+ token and next whitespace */
3822 int i;
3823 for (i = 1; i <= 3; i++) {
3824 if (!t->next
3825 || (i != 2 && t->next->type != TOK_WHITESPACE))
3826 break;
3827 t->next = delete_Token(t->next);
3828 } /* endfor */
3829 } else
3830 t = t->next;
3832 /* If we concatenaded something, re-scan the line for macros */
3833 if (rescan) {
3834 tline = thead;
3835 goto again;
3838 if (org_tline) {
3839 if (thead) {
3840 *org_tline = *thead;
3841 /* since we just gave text to org_line, don't free it */
3842 thead->text = NULL;
3843 delete_Token(thead);
3844 } else {
3845 /* the expression expanded to empty line;
3846 we can't return NULL for some reasons
3847 we just set the line to a single WHITESPACE token. */
3848 memset(org_tline, 0, sizeof(*org_tline));
3849 org_tline->text = NULL;
3850 org_tline->type = TOK_WHITESPACE;
3852 thead = org_tline;
3855 return thead;
3859 * Similar to expand_smacro but used exclusively with macro identifiers
3860 * right before they are fetched in. The reason is that there can be
3861 * identifiers consisting of several subparts. We consider that if there
3862 * are more than one element forming the name, user wants a expansion,
3863 * otherwise it will be left as-is. Example:
3865 * %define %$abc cde
3867 * the identifier %$abc will be left as-is so that the handler for %define
3868 * will suck it and define the corresponding value. Other case:
3870 * %define _%$abc cde
3872 * In this case user wants name to be expanded *before* %define starts
3873 * working, so we'll expand %$abc into something (if it has a value;
3874 * otherwise it will be left as-is) then concatenate all successive
3875 * PP_IDs into one.
3877 static Token *expand_id(Token * tline)
3879 Token *cur, *oldnext = NULL;
3881 if (!tline || !tline->next)
3882 return tline;
3884 cur = tline;
3885 while (cur->next &&
3886 (cur->next->type == TOK_ID ||
3887 cur->next->type == TOK_PREPROC_ID
3888 || cur->next->type == TOK_NUMBER))
3889 cur = cur->next;
3891 /* If identifier consists of just one token, don't expand */
3892 if (cur == tline)
3893 return tline;
3895 if (cur) {
3896 oldnext = cur->next; /* Detach the tail past identifier */
3897 cur->next = NULL; /* so that expand_smacro stops here */
3900 tline = expand_smacro(tline);
3902 if (cur) {
3903 /* expand_smacro possibly changhed tline; re-scan for EOL */
3904 cur = tline;
3905 while (cur && cur->next)
3906 cur = cur->next;
3907 if (cur)
3908 cur->next = oldnext;
3911 return tline;
3915 * Expand indirect tokens, %[...]. Just like expand_smacro(),
3916 * the input is considered destroyed.
3918 static Token *expand_indirect(Token * tline, int level)
3920 const int max_indirect_level = 1000;
3921 Token *t, *thead, **tp;
3922 Token *it;
3923 bool skip;
3925 if (level >= max_indirect_level) {
3926 error(ERR_NONFATAL, "interminable indirect expansion");
3927 } else {
3928 thead = NULL;
3929 tp = &tline;
3930 while ((t = *tp)) {
3931 if (t->type != TOK_INDIRECT) {
3932 thead = t;
3933 tp = &t->next;
3934 } else {
3935 it = tokenize(t->text);
3936 it = expand_indirect(it, level+1);
3937 it = expand_smacro(it);
3938 while (it) {
3939 skip = false;
3940 switch (thead ? thead->type : TOK_NONE) {
3941 case TOK_WHITESPACE:
3942 skip = (it->type == TOK_WHITESPACE);
3943 break;
3944 case TOK_ID:
3945 case TOK_NUMBER:
3946 if (it->type == thead->type || it->type == TOK_NUMBER) {
3947 char *tmp = nasm_strcat(thead->text, it->text);
3948 nasm_free(thead->text);
3949 thead->text = tmp;
3950 skip = true;
3952 break;
3953 default:
3954 break;
3956 if (skip) {
3957 it = delete_Token(it);
3958 } else {
3959 *tp = thead = it;
3960 tp = &it->next;
3961 it = it->next;
3964 *tp = thead = t->next;
3965 t = delete_Token(t);
3969 return tline;
3973 * Determine whether the given line constitutes a multi-line macro
3974 * call, and return the MMacro structure called if so. Doesn't have
3975 * to check for an initial label - that's taken care of in
3976 * expand_mmacro - but must check numbers of parameters. Guaranteed
3977 * to be called with tline->type == TOK_ID, so the putative macro
3978 * name is easy to find.
3980 static MMacro *is_mmacro(Token * tline, Token *** params_array)
3982 MMacro *head, *m;
3983 Token **params;
3984 int nparam;
3986 head = (MMacro *) hash_findix(&mmacros, tline->text);
3989 * Efficiency: first we see if any macro exists with the given
3990 * name. If not, we can return NULL immediately. _Then_ we
3991 * count the parameters, and then we look further along the
3992 * list if necessary to find the proper MMacro.
3994 for (m = head; m; m = m->next)
3995 if (!mstrcmp(m->name, tline->text, m->casesense))
3996 break;
3997 if (!m)
3998 return NULL;
4001 * OK, we have a potential macro. Count and demarcate the
4002 * parameters.
4004 count_mmac_params(tline->next, &nparam, &params);
4007 * So we know how many parameters we've got. Find the MMacro
4008 * structure that handles this number.
4010 while (m) {
4011 if (m->nparam_min <= nparam
4012 && (m->plus || nparam <= m->nparam_max)) {
4014 * This one is right. Just check if cycle removal
4015 * prohibits us using it before we actually celebrate...
4017 if (m->in_progress) {
4018 #if 0
4019 error(ERR_NONFATAL,
4020 "self-reference in multi-line macro `%s'", m->name);
4021 #endif
4022 nasm_free(params);
4023 return NULL;
4026 * It's right, and we can use it. Add its default
4027 * parameters to the end of our list if necessary.
4029 if (m->defaults && nparam < m->nparam_min + m->ndefs) {
4030 params =
4031 nasm_realloc(params,
4032 ((m->nparam_min + m->ndefs +
4033 1) * sizeof(*params)));
4034 while (nparam < m->nparam_min + m->ndefs) {
4035 params[nparam] = m->defaults[nparam - m->nparam_min];
4036 nparam++;
4040 * If we've gone over the maximum parameter count (and
4041 * we're in Plus mode), ignore parameters beyond
4042 * nparam_max.
4044 if (m->plus && nparam > m->nparam_max)
4045 nparam = m->nparam_max;
4047 * Then terminate the parameter list, and leave.
4049 if (!params) { /* need this special case */
4050 params = nasm_malloc(sizeof(*params));
4051 nparam = 0;
4053 params[nparam] = NULL;
4054 *params_array = params;
4055 return m;
4058 * This one wasn't right: look for the next one with the
4059 * same name.
4061 for (m = m->next; m; m = m->next)
4062 if (!mstrcmp(m->name, tline->text, m->casesense))
4063 break;
4067 * After all that, we didn't find one with the right number of
4068 * parameters. Issue a warning, and fail to expand the macro.
4070 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
4071 "macro `%s' exists, but not taking %d parameters",
4072 tline->text, nparam);
4073 nasm_free(params);
4074 return NULL;
4078 * Expand the multi-line macro call made by the given line, if
4079 * there is one to be expanded. If there is, push the expansion on
4080 * istk->expansion and return 1. Otherwise return 0.
4082 static int expand_mmacro(Token * tline)
4084 Token *startline = tline;
4085 Token *label = NULL;
4086 int dont_prepend = 0;
4087 Token **params, *t, *mtok, *tt;
4088 MMacro *m;
4089 Line *l, *ll;
4090 int i, nparam, *paramlen;
4091 const char *mname;
4093 t = tline;
4094 skip_white_(t);
4095 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
4096 if (!tok_type_(t, TOK_ID) && !tok_type_(t, TOK_PREPROC_ID))
4097 return 0;
4098 mtok = t;
4099 m = is_mmacro(t, &params);
4100 if (m) {
4101 mname = t->text;
4102 } else {
4103 Token *last;
4105 * We have an id which isn't a macro call. We'll assume
4106 * it might be a label; we'll also check to see if a
4107 * colon follows it. Then, if there's another id after
4108 * that lot, we'll check it again for macro-hood.
4110 label = last = t;
4111 t = t->next;
4112 if (tok_type_(t, TOK_WHITESPACE))
4113 last = t, t = t->next;
4114 if (tok_is_(t, ":")) {
4115 dont_prepend = 1;
4116 last = t, t = t->next;
4117 if (tok_type_(t, TOK_WHITESPACE))
4118 last = t, t = t->next;
4120 if (!tok_type_(t, TOK_ID) || (m = is_mmacro(t, &params)) == NULL)
4121 return 0;
4122 last->next = NULL;
4123 mname = t->text;
4124 tline = t;
4128 * Fix up the parameters: this involves stripping leading and
4129 * trailing whitespace, then stripping braces if they are
4130 * present.
4132 for (nparam = 0; params[nparam]; nparam++) ;
4133 paramlen = nparam ? nasm_malloc(nparam * sizeof(*paramlen)) : NULL;
4135 for (i = 0; params[i]; i++) {
4136 int brace = false;
4137 int comma = (!m->plus || i < nparam - 1);
4139 t = params[i];
4140 skip_white_(t);
4141 if (tok_is_(t, "{"))
4142 t = t->next, brace = true, comma = false;
4143 params[i] = t;
4144 paramlen[i] = 0;
4145 while (t) {
4146 if (comma && t->type == TOK_OTHER && !strcmp(t->text, ","))
4147 break; /* ... because we have hit a comma */
4148 if (comma && t->type == TOK_WHITESPACE
4149 && tok_is_(t->next, ","))
4150 break; /* ... or a space then a comma */
4151 if (brace && t->type == TOK_OTHER && !strcmp(t->text, "}"))
4152 break; /* ... or a brace */
4153 t = t->next;
4154 paramlen[i]++;
4159 * OK, we have a MMacro structure together with a set of
4160 * parameters. We must now go through the expansion and push
4161 * copies of each Line on to istk->expansion. Substitution of
4162 * parameter tokens and macro-local tokens doesn't get done
4163 * until the single-line macro substitution process; this is
4164 * because delaying them allows us to change the semantics
4165 * later through %rotate.
4167 * First, push an end marker on to istk->expansion, mark this
4168 * macro as in progress, and set up its invocation-specific
4169 * variables.
4171 ll = nasm_malloc(sizeof(Line));
4172 ll->next = istk->expansion;
4173 ll->finishes = m;
4174 ll->first = NULL;
4175 istk->expansion = ll;
4177 m->in_progress = true;
4178 m->params = params;
4179 m->iline = tline;
4180 m->nparam = nparam;
4181 m->rotate = 0;
4182 m->paramlen = paramlen;
4183 m->unique = unique++;
4184 m->lineno = 0;
4186 m->next_active = istk->mstk;
4187 istk->mstk = m;
4189 for (l = m->expansion; l; l = l->next) {
4190 Token **tail;
4192 ll = nasm_malloc(sizeof(Line));
4193 ll->finishes = NULL;
4194 ll->next = istk->expansion;
4195 istk->expansion = ll;
4196 tail = &ll->first;
4198 for (t = l->first; t; t = t->next) {
4199 Token *x = t;
4200 switch (t->type) {
4201 case TOK_PREPROC_Q:
4202 tt = *tail = new_Token(NULL, TOK_ID, mname, 0);
4203 break;
4204 case TOK_PREPROC_QQ:
4205 tt = *tail = new_Token(NULL, TOK_ID, m->name, 0);
4206 break;
4207 case TOK_PREPROC_ID:
4208 if (t->text[1] == '0' && t->text[2] == '0') {
4209 dont_prepend = -1;
4210 x = label;
4211 if (!x)
4212 continue;
4214 /* fall through */
4215 default:
4216 tt = *tail = new_Token(NULL, x->type, x->text, 0);
4217 break;
4219 tail = &tt->next;
4221 *tail = NULL;
4225 * If we had a label, push it on as the first line of
4226 * the macro expansion.
4228 if (label) {
4229 if (dont_prepend < 0)
4230 free_tlist(startline);
4231 else {
4232 ll = nasm_malloc(sizeof(Line));
4233 ll->finishes = NULL;
4234 ll->next = istk->expansion;
4235 istk->expansion = ll;
4236 ll->first = startline;
4237 if (!dont_prepend) {
4238 while (label->next)
4239 label = label->next;
4240 label->next = tt = new_Token(NULL, TOK_OTHER, ":", 0);
4245 list->uplevel(m->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
4247 return 1;
4250 /* The function that actually does the error reporting */
4251 static void verror(int severity, const char *fmt, va_list arg)
4253 char buff[1024];
4255 vsnprintf(buff, sizeof(buff), fmt, arg);
4257 if (istk && istk->mstk && istk->mstk->name)
4258 _error(severity, "(%s:%d) %s", istk->mstk->name,
4259 istk->mstk->lineno, buff);
4260 else
4261 _error(severity, "%s", buff);
4265 * Since preprocessor always operate only on the line that didn't
4266 * arrived yet, we should always use ERR_OFFBY1.
4268 static void error(int severity, const char *fmt, ...)
4270 va_list arg;
4272 /* If we're in a dead branch of IF or something like it, ignore the error */
4273 if (istk && istk->conds && !emitting(istk->conds->state))
4274 return;
4276 va_start(arg, fmt);
4277 verror(severity, fmt, arg);
4278 va_end(arg);
4282 * Because %else etc are evaluated in the state context
4283 * of the previous branch, errors might get lost with error():
4284 * %if 0 ... %else trailing garbage ... %endif
4285 * So %else etc should report errors with this function.
4287 static void error_precond(int severity, const char *fmt, ...)
4289 va_list arg;
4291 /* Only ignore the error if it's really in a dead branch */
4292 if (istk && istk->conds && istk->conds->state == COND_NEVER)
4293 return;
4295 va_start(arg, fmt);
4296 verror(severity, fmt, arg);
4297 va_end(arg);
4300 static void
4301 pp_reset(char *file, int apass, efunc errfunc, evalfunc eval,
4302 ListGen * listgen, StrList **deplist)
4304 Token *t;
4306 _error = errfunc;
4307 cstk = NULL;
4308 istk = nasm_malloc(sizeof(Include));
4309 istk->next = NULL;
4310 istk->conds = NULL;
4311 istk->expansion = NULL;
4312 istk->mstk = NULL;
4313 istk->fp = fopen(file, "r");
4314 istk->fname = NULL;
4315 src_set_fname(nasm_strdup(file));
4316 src_set_linnum(0);
4317 istk->lineinc = 1;
4318 if (!istk->fp)
4319 error(ERR_FATAL|ERR_NOFILE, "unable to open input file `%s'",
4320 file);
4321 defining = NULL;
4322 nested_mac_count = 0;
4323 nested_rep_count = 0;
4324 init_macros();
4325 unique = 0;
4326 if (tasm_compatible_mode) {
4327 stdmacpos = nasm_stdmac;
4328 } else {
4329 stdmacpos = nasm_stdmac_after_tasm;
4331 any_extrastdmac = extrastdmac && *extrastdmac;
4332 do_predef = true;
4333 list = listgen;
4334 evaluate = eval;
4337 * 0 for dependencies, 1 for preparatory passes, 2 for final pass.
4338 * The caller, however, will also pass in 3 for preprocess-only so
4339 * we can set __PASS__ accordingly.
4341 pass = apass > 2 ? 2 : apass;
4343 dephead = deptail = deplist;
4344 if (deplist) {
4345 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
4346 sl->next = NULL;
4347 strcpy(sl->str, file);
4348 *deptail = sl;
4349 deptail = &sl->next;
4353 * Define the __PASS__ macro. This is defined here unlike
4354 * all the other builtins, because it is special -- it varies between
4355 * passes.
4357 t = nasm_malloc(sizeof(*t));
4358 t->next = NULL;
4359 make_tok_num(t, apass);
4360 t->a.mac = NULL;
4361 define_smacro(NULL, "__PASS__", true, 0, t);
4364 static char *pp_getline(void)
4366 char *line;
4367 Token *tline;
4369 while (1) {
4371 * Fetch a tokenized line, either from the macro-expansion
4372 * buffer or from the input file.
4374 tline = NULL;
4375 while (istk->expansion && istk->expansion->finishes) {
4376 Line *l = istk->expansion;
4377 if (!l->finishes->name && l->finishes->in_progress > 1) {
4378 Line *ll;
4381 * This is a macro-end marker for a macro with no
4382 * name, which means it's not really a macro at all
4383 * but a %rep block, and the `in_progress' field is
4384 * more than 1, meaning that we still need to
4385 * repeat. (1 means the natural last repetition; 0
4386 * means termination by %exitrep.) We have
4387 * therefore expanded up to the %endrep, and must
4388 * push the whole block on to the expansion buffer
4389 * again. We don't bother to remove the macro-end
4390 * marker: we'd only have to generate another one
4391 * if we did.
4393 l->finishes->in_progress--;
4394 for (l = l->finishes->expansion; l; l = l->next) {
4395 Token *t, *tt, **tail;
4397 ll = nasm_malloc(sizeof(Line));
4398 ll->next = istk->expansion;
4399 ll->finishes = NULL;
4400 ll->first = NULL;
4401 tail = &ll->first;
4403 for (t = l->first; t; t = t->next) {
4404 if (t->text || t->type == TOK_WHITESPACE) {
4405 tt = *tail =
4406 new_Token(NULL, t->type, t->text, 0);
4407 tail = &tt->next;
4411 istk->expansion = ll;
4413 } else {
4415 * Check whether a `%rep' was started and not ended
4416 * within this macro expansion. This can happen and
4417 * should be detected. It's a fatal error because
4418 * I'm too confused to work out how to recover
4419 * sensibly from it.
4421 if (defining) {
4422 if (defining->name)
4423 error(ERR_PANIC,
4424 "defining with name in expansion");
4425 else if (istk->mstk->name)
4426 error(ERR_FATAL,
4427 "`%%rep' without `%%endrep' within"
4428 " expansion of macro `%s'",
4429 istk->mstk->name);
4433 * FIXME: investigate the relationship at this point between
4434 * istk->mstk and l->finishes
4437 MMacro *m = istk->mstk;
4438 istk->mstk = m->next_active;
4439 if (m->name) {
4441 * This was a real macro call, not a %rep, and
4442 * therefore the parameter information needs to
4443 * be freed.
4445 nasm_free(m->params);
4446 free_tlist(m->iline);
4447 nasm_free(m->paramlen);
4448 l->finishes->in_progress = false;
4449 } else
4450 free_mmacro(m);
4452 istk->expansion = l->next;
4453 nasm_free(l);
4454 list->downlevel(LIST_MACRO);
4457 while (1) { /* until we get a line we can use */
4459 if (istk->expansion) { /* from a macro expansion */
4460 char *p;
4461 Line *l = istk->expansion;
4462 if (istk->mstk)
4463 istk->mstk->lineno++;
4464 tline = l->first;
4465 istk->expansion = l->next;
4466 nasm_free(l);
4467 p = detoken(tline, false);
4468 list->line(LIST_MACRO, p);
4469 nasm_free(p);
4470 break;
4472 line = read_line();
4473 if (line) { /* from the current input file */
4474 line = prepreproc(line);
4475 tline = tokenize(line);
4476 nasm_free(line);
4477 break;
4480 * The current file has ended; work down the istk
4483 Include *i = istk;
4484 fclose(i->fp);
4485 if (i->conds)
4486 error(ERR_FATAL,
4487 "expected `%%endif' before end of file");
4488 /* only set line and file name if there's a next node */
4489 if (i->next) {
4490 src_set_linnum(i->lineno);
4491 nasm_free(src_set_fname(i->fname));
4493 istk = i->next;
4494 list->downlevel(LIST_INCLUDE);
4495 nasm_free(i);
4496 if (!istk)
4497 return NULL;
4498 if (istk->expansion && istk->expansion->finishes)
4499 break;
4504 * We must expand MMacro parameters and MMacro-local labels
4505 * _before_ we plunge into directive processing, to cope
4506 * with things like `%define something %1' such as STRUC
4507 * uses. Unless we're _defining_ a MMacro, in which case
4508 * those tokens should be left alone to go into the
4509 * definition; and unless we're in a non-emitting
4510 * condition, in which case we don't want to meddle with
4511 * anything.
4513 if (!defining && !(istk->conds && !emitting(istk->conds->state))
4514 && !(istk->mstk && !istk->mstk->in_progress)) {
4515 tline = expand_indirect(tline,0);
4516 tline = expand_mmac_params(tline);
4520 * Check the line to see if it's a preprocessor directive.
4522 if (do_directive(tline) == DIRECTIVE_FOUND) {
4523 continue;
4524 } else if (defining) {
4526 * We're defining a multi-line macro. We emit nothing
4527 * at all, and just
4528 * shove the tokenized line on to the macro definition.
4530 Line *l = nasm_malloc(sizeof(Line));
4531 l->next = defining->expansion;
4532 l->first = tline;
4533 l->finishes = NULL;
4534 defining->expansion = l;
4535 continue;
4536 } else if (istk->conds && !emitting(istk->conds->state)) {
4538 * We're in a non-emitting branch of a condition block.
4539 * Emit nothing at all, not even a blank line: when we
4540 * emerge from the condition we'll give a line-number
4541 * directive so we keep our place correctly.
4543 free_tlist(tline);
4544 continue;
4545 } else if (istk->mstk && !istk->mstk->in_progress) {
4547 * We're in a %rep block which has been terminated, so
4548 * we're walking through to the %endrep without
4549 * emitting anything. Emit nothing at all, not even a
4550 * blank line: when we emerge from the %rep block we'll
4551 * give a line-number directive so we keep our place
4552 * correctly.
4554 free_tlist(tline);
4555 continue;
4556 } else {
4557 tline = expand_smacro(tline);
4558 if (!expand_mmacro(tline)) {
4560 * De-tokenize the line again, and emit it.
4562 line = detoken(tline, true);
4563 free_tlist(tline);
4564 break;
4565 } else {
4566 continue; /* expand_mmacro calls free_tlist */
4571 return line;
4574 static void pp_cleanup(int pass)
4576 if (defining) {
4577 if(defining->name) {
4578 error(ERR_NONFATAL,
4579 "end of file while still defining macro `%s'",
4580 defining->name);
4581 } else {
4582 error(ERR_NONFATAL, "end of file while still in %%rep");
4585 free_mmacro(defining);
4587 while (cstk)
4588 ctx_pop();
4589 free_macros();
4590 while (istk) {
4591 Include *i = istk;
4592 istk = istk->next;
4593 fclose(i->fp);
4594 nasm_free(i->fname);
4595 nasm_free(i);
4597 while (cstk)
4598 ctx_pop();
4599 nasm_free(src_set_fname(NULL));
4600 if (pass == 0) {
4601 IncPath *i;
4602 free_llist(predef);
4603 delete_Blocks();
4604 while ((i = ipath)) {
4605 ipath = i->next;
4606 if (i->path)
4607 nasm_free(i->path);
4608 nasm_free(i);
4613 void pp_include_path(char *path)
4615 IncPath *i;
4617 i = nasm_malloc(sizeof(IncPath));
4618 i->path = path ? nasm_strdup(path) : NULL;
4619 i->next = NULL;
4621 if (ipath != NULL) {
4622 IncPath *j = ipath;
4623 while (j->next != NULL)
4624 j = j->next;
4625 j->next = i;
4626 } else {
4627 ipath = i;
4631 void pp_pre_include(char *fname)
4633 Token *inc, *space, *name;
4634 Line *l;
4636 name = new_Token(NULL, TOK_INTERNAL_STRING, fname, 0);
4637 space = new_Token(name, TOK_WHITESPACE, NULL, 0);
4638 inc = new_Token(space, TOK_PREPROC_ID, "%include", 0);
4640 l = nasm_malloc(sizeof(Line));
4641 l->next = predef;
4642 l->first = inc;
4643 l->finishes = NULL;
4644 predef = l;
4647 void pp_pre_define(char *definition)
4649 Token *def, *space;
4650 Line *l;
4651 char *equals;
4653 equals = strchr(definition, '=');
4654 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4655 def = new_Token(space, TOK_PREPROC_ID, "%define", 0);
4656 if (equals)
4657 *equals = ' ';
4658 space->next = tokenize(definition);
4659 if (equals)
4660 *equals = '=';
4662 l = nasm_malloc(sizeof(Line));
4663 l->next = predef;
4664 l->first = def;
4665 l->finishes = NULL;
4666 predef = l;
4669 void pp_pre_undefine(char *definition)
4671 Token *def, *space;
4672 Line *l;
4674 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4675 def = new_Token(space, TOK_PREPROC_ID, "%undef", 0);
4676 space->next = tokenize(definition);
4678 l = nasm_malloc(sizeof(Line));
4679 l->next = predef;
4680 l->first = def;
4681 l->finishes = NULL;
4682 predef = l;
4686 * Added by Keith Kanios:
4688 * This function is used to assist with "runtime" preprocessor
4689 * directives. (e.g. pp_runtime("%define __BITS__ 64");)
4691 * ERRORS ARE IGNORED HERE, SO MAKE COMPLETELY SURE THAT YOU
4692 * PASS A VALID STRING TO THIS FUNCTION!!!!!
4695 void pp_runtime(char *definition)
4697 Token *def;
4699 def = tokenize(definition);
4700 if(do_directive(def) == NO_DIRECTIVE_FOUND)
4701 free_tlist(def);
4705 void pp_extra_stdmac(macros_t *macros)
4707 extrastdmac = macros;
4710 static void make_tok_num(Token * tok, int64_t val)
4712 char numbuf[20];
4713 snprintf(numbuf, sizeof(numbuf), "%"PRId64"", val);
4714 tok->text = nasm_strdup(numbuf);
4715 tok->type = TOK_NUMBER;
4718 Preproc nasmpp = {
4719 pp_reset,
4720 pp_getline,
4721 pp_cleanup