1 /* ----------------------------------------------------------------------- *
3 * Copyright 1996-2009 The NASM Authors - All Rights Reserved
4 * See the file AUTHORS included with the NASM distribution for
5 * the specific copyright holders.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 * ----------------------------------------------------------------------- */
35 * preproc.c macro preprocessor for the Netwide Assembler
38 /* Typical flow of text through preproc
40 * pp_getline gets tokenized lines, either
42 * from a macro expansion
46 * read_line gets raw text from stdmacpos, or predef, or current input file
47 * tokenize converts to tokens
50 * expand_mmac_params is used to expand %1 etc., unless a macro is being
51 * defined or a false conditional is being processed
52 * (%0, %1, %+1, %-1, %%foo
54 * do_directive checks for directives
56 * expand_smacro is used to expand single line macros
58 * expand_mmacro is used to expand multi-line macros
60 * detoken is used to convert the line back to text
83 typedef struct SMacro SMacro;
84 typedef struct MMacro MMacro;
85 typedef struct MMacroInvocation MMacroInvocation;
86 typedef struct Context Context;
87 typedef struct Token Token;
88 typedef struct Blocks Blocks;
89 typedef struct Line Line;
90 typedef struct Include Include;
91 typedef struct Cond Cond;
92 typedef struct IncPath IncPath;
95 * Note on the storage of both SMacro and MMacros: the hash table
96 * indexes them case-insensitively, and we then have to go through a
97 * linked list of potential case aliases (and, for MMacros, parameter
98 * ranges); this is to preserve the matching semantics of the earlier
99 * code. If the number of case aliases for a specific macro is a
100 * performance issue, you may want to reconsider your coding style.
104 * Store the definition of a single-line macro.
116 * Store the definition of a multi-line macro. This is also used to
117 * store the interiors of `%rep...%endrep' blocks, which are
118 * effectively self-re-invoking multi-line macros which simply
119 * don't have a name or bother to appear in the hash tables. %rep
120 * blocks are signified by having a NULL `name' field.
122 * In a MMacro describing a `%rep' block, the `in_progress' field
123 * isn't merely boolean, but gives the number of repeats left to
126 * The `next' field is used for storing MMacros in hash tables; the
127 * `next_active' field is for stacking them on istk entries.
129 * When a MMacro is being expanded, `params', `iline', `nparam',
130 * `paramlen', `rotate' and `unique' are local to the invocation.
134 MMacroInvocation *prev; /* previous invocation */
136 int nparam_min, nparam_max;
138 bool plus; /* is the last parameter greedy? */
139 bool nolist; /* is this macro listing-inhibited? */
140 int64_t in_progress; /* is this macro currently being expanded? */
141 int32_t max_depth; /* maximum number of recursive expansions allowed */
142 Token *dlist; /* All defaults as one list */
143 Token **defaults; /* Parameter default pointers */
144 int ndefs; /* number of default parameters */
148 MMacro *rep_nest; /* used for nesting %rep */
149 Token **params; /* actual parameters */
150 Token *iline; /* invocation line */
151 unsigned int nparam, rotate;
154 int lineno; /* Current line number on expansion */
158 /* Store the definition of a multi-line macro, as defined in a
159 * previous recursive macro expansion.
161 struct MMacroInvocation {
162 MMacroInvocation *prev; /* previous invocation */
163 Token **params; /* actual parameters */
164 Token *iline; /* invocation line */
165 unsigned int nparam, rotate;
172 * The context stack is composed of a linked list of these.
177 struct hash_table localmac;
182 * This is the internal form which we break input lines up into.
183 * Typically stored in linked lists.
185 * Note that `type' serves a double meaning: TOK_SMAC_PARAM is not
186 * necessarily used as-is, but is intended to denote the number of
187 * the substituted parameter. So in the definition
189 * %define a(x,y) ( (x) & ~(y) )
191 * the token representing `x' will have its type changed to
192 * TOK_SMAC_PARAM, but the one representing `y' will be
195 * TOK_INTERNAL_STRING is a dirty hack: it's a single string token
196 * which doesn't need quotes around it. Used in the pre-include
197 * mechanism as an alternative to trying to find a sensible type of
198 * quote to use on the filename we were passed.
201 TOK_NONE = 0, TOK_WHITESPACE, TOK_COMMENT, TOK_ID,
202 TOK_PREPROC_ID, TOK_STRING,
203 TOK_NUMBER, TOK_FLOAT, TOK_SMAC_END, TOK_OTHER,
205 TOK_PREPROC_Q, TOK_PREPROC_QQ,
207 TOK_INDIRECT, /* %[...] */
208 TOK_SMAC_PARAM, /* MUST BE LAST IN THE LIST!!! */
209 TOK_MAX = INT_MAX /* Keep compiler from reducing the range */
216 SMacro *mac; /* associated macro for TOK_SMAC_END */
217 size_t len; /* scratch length field */
218 } a; /* Auxiliary data */
219 enum pp_token_type type;
223 * Multi-line macro definitions are stored as a linked list of
224 * these, which is essentially a container to allow several linked
227 * Note that in this module, linked lists are treated as stacks
228 * wherever possible. For this reason, Lines are _pushed_ on to the
229 * `expansion' field in MMacro structures, so that the linked list,
230 * if walked, would give the macro lines in reverse order; this
231 * means that we can walk the list when expanding a macro, and thus
232 * push the lines on to the `expansion' field in _istk_ in reverse
233 * order (so that when popped back off they are in the right
234 * order). It may seem cockeyed, and it relies on my design having
235 * an even number of steps in, but it works...
237 * Some of these structures, rather than being actual lines, are
238 * markers delimiting the end of the expansion of a given macro.
239 * This is for use in the cycle-tracking and %rep-handling code.
240 * Such structures have `finishes' non-NULL, and `first' NULL. All
241 * others have `finishes' NULL, but `first' may still be NULL if
251 * To handle an arbitrary level of file inclusion, we maintain a
252 * stack (ie linked list) of these things.
261 MMacro *mstk; /* stack of active macros/reps */
265 * Include search path. This is simply a list of strings which get
266 * prepended, in turn, to the name of an include file, in an
267 * attempt to find the file if it's not in the current directory.
275 * Conditional assembly: we maintain a separate stack of these for
276 * each level of file inclusion. (The only reason we keep the
277 * stacks separate is to ensure that a stray `%endif' in a file
278 * included from within the true branch of a `%if' won't terminate
279 * it and cause confusion: instead, rightly, it'll cause an error.)
287 * These states are for use just after %if or %elif: IF_TRUE
288 * means the condition has evaluated to truth so we are
289 * currently emitting, whereas IF_FALSE means we are not
290 * currently emitting but will start doing so if a %else comes
291 * up. In these states, all directives are admissible: %elif,
292 * %else and %endif. (And of course %if.)
294 COND_IF_TRUE, COND_IF_FALSE,
296 * These states come up after a %else: ELSE_TRUE means we're
297 * emitting, and ELSE_FALSE means we're not. In ELSE_* states,
298 * any %elif or %else will cause an error.
300 COND_ELSE_TRUE, COND_ELSE_FALSE,
302 * These states mean that we're not emitting now, and also that
303 * nothing until %endif will be emitted at all. COND_DONE is
304 * used when we've had our moment of emission
305 * and have now started seeing %elifs. COND_NEVER is used when
306 * the condition construct in question is contained within a
307 * non-emitting branch of a larger condition construct,
308 * or if there is an error.
310 COND_DONE, COND_NEVER
312 #define emitting(x) ( (x) == COND_IF_TRUE || (x) == COND_ELSE_TRUE )
315 * These defines are used as the possible return values for do_directive
317 #define NO_DIRECTIVE_FOUND 0
318 #define DIRECTIVE_FOUND 1
321 * This define sets the upper limit for smacro and recursive mmacro
324 #define DEADMAN_LIMIT (1 << 20)
327 * Condition codes. Note that we use c_ prefix not C_ because C_ is
328 * used in nasm.h for the "real" condition codes. At _this_ level,
329 * we treat CXZ and ECXZ as condition codes, albeit non-invertible
330 * ones, so we need a different enum...
332 static const char * const conditions[] = {
333 "a", "ae", "b", "be", "c", "cxz", "e", "ecxz", "g", "ge", "l", "le",
334 "na", "nae", "nb", "nbe", "nc", "ne", "ng", "nge", "nl", "nle", "no",
335 "np", "ns", "nz", "o", "p", "pe", "po", "rcxz", "s", "z"
338 c_A, c_AE, c_B, c_BE, c_C, c_CXZ, c_E, c_ECXZ, c_G, c_GE, c_L, c_LE,
339 c_NA, c_NAE, c_NB, c_NBE, c_NC, c_NE, c_NG, c_NGE, c_NL, c_NLE, c_NO,
340 c_NP, c_NS, c_NZ, c_O, c_P, c_PE, c_PO, c_RCXZ, c_S, c_Z,
343 static const enum pp_conds inverse_ccs[] = {
344 c_NA, c_NAE, c_NB, c_NBE, c_NC, -1, c_NE, -1, c_NG, c_NGE, c_NL, c_NLE,
345 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,
346 c_Z, c_NO, c_NP, c_PO, c_PE, -1, c_NS, c_NZ
352 /* If this is a an IF, ELIF, ELSE or ENDIF keyword */
353 static int is_condition(enum preproc_token arg)
355 return PP_IS_COND(arg) || (arg == PP_ELSE) || (arg == PP_ENDIF);
358 /* For TASM compatibility we need to be able to recognise TASM compatible
359 * conditional compilation directives. Using the NASM pre-processor does
360 * not work, so we look for them specifically from the following list and
361 * then jam in the equivalent NASM directive into the input stream.
365 TM_ARG, TM_ELIF, TM_ELSE, TM_ENDIF, TM_IF, TM_IFDEF, TM_IFDIFI,
366 TM_IFNDEF, TM_INCLUDE, TM_LOCAL
369 static const char * const tasm_directives[] = {
370 "arg", "elif", "else", "endif", "if", "ifdef", "ifdifi",
371 "ifndef", "include", "local"
374 static int StackSize = 4;
375 static char *StackPointer = "ebp";
376 static int ArgOffset = 8;
377 static int LocalOffset = 0;
379 static Context *cstk;
380 static Include *istk;
381 static IncPath *ipath = NULL;
383 static efunc _error; /* Pointer to client-provided error reporting function */
384 static evalfunc evaluate;
386 static int pass; /* HACK: pass 0 = generate dependencies only */
387 static StrList **dephead, **deptail; /* Dependency list */
389 static uint64_t unique; /* unique identifier numbers */
391 static Line *predef = NULL;
392 static bool do_predef;
394 static ListGen *list;
397 * The current set of multi-line macros we have defined.
399 static struct hash_table mmacros;
402 * The current set of single-line macros we have defined.
404 static struct hash_table smacros;
407 * The multi-line macro we are currently defining, or the %rep
408 * block we are currently reading, if any.
410 static MMacro *defining;
412 static uint64_t nested_mac_count;
413 static uint64_t nested_rep_count;
416 * The number of macro parameters to allocate space for at a time.
418 #define PARAM_DELTA 16
421 * The standard macro set: defined in macros.c in the array nasm_stdmac.
422 * This gives our position in the macro set, when we're processing it.
424 static macros_t *stdmacpos;
427 * The extra standard macros that come from the object format, if
430 static macros_t *extrastdmac = NULL;
431 static bool any_extrastdmac;
434 * Tokens are allocated in blocks to improve speed
436 #define TOKEN_BLOCKSIZE 4096
437 static Token *freeTokens = NULL;
443 static Blocks blocks = { NULL, NULL };
446 * Forward declarations.
448 static Token *expand_mmac_params(Token * tline);
449 static Token *expand_smacro(Token * tline);
450 static Token *expand_id(Token * tline);
451 static Context *get_ctx(const char *name, const char **namep,
453 static void make_tok_num(Token * tok, int64_t val);
454 static void error(int severity, const char *fmt, ...);
455 static void error_precond(int severity, const char *fmt, ...);
456 static void *new_Block(size_t size);
457 static void delete_Blocks(void);
458 static Token *new_Token(Token * next, enum pp_token_type type,
459 const char *text, int txtlen);
460 static Token *delete_Token(Token * t);
463 * Macros for safe checking of token pointers, avoid *(NULL)
465 #define tok_type_(x,t) ((x) && (x)->type == (t))
466 #define skip_white_(x) if (tok_type_((x), TOK_WHITESPACE)) (x)=(x)->next
467 #define tok_is_(x,v) (tok_type_((x), TOK_OTHER) && !strcmp((x)->text,(v)))
468 #define tok_isnt_(x,v) ((x) && ((x)->type!=TOK_OTHER || strcmp((x)->text,(v))))
470 /* Handle TASM specific directives, which do not contain a % in
471 * front of them. We do it here because I could not find any other
472 * place to do it for the moment, and it is a hack (ideally it would
473 * be nice to be able to use the NASM pre-processor to do it).
475 static char *check_tasm_directive(char *line)
477 int32_t i, j, k, m, len;
478 char *p = line, *oldline, oldchar;
480 /* Skip whitespace */
481 while (nasm_isspace(*p) && *p != 0)
484 /* Binary search for the directive name */
486 j = elements(tasm_directives);
488 while (!nasm_isspace(p[len]) && p[len] != 0)
495 m = nasm_stricmp(p, tasm_directives[k]);
497 /* We have found a directive, so jam a % in front of it
498 * so that NASM will then recognise it as one if it's own.
503 line = nasm_malloc(len + 2);
505 if (k == TM_IFDIFI) {
507 * NASM does not recognise IFDIFI, so we convert
508 * it to %if 0. This is not used in NASM
509 * compatible code, but does need to parse for the
510 * TASM macro package.
512 strcpy(line + 1, "if 0");
514 memcpy(line + 1, p, len + 1);
529 * The pre-preprocessing stage... This function translates line
530 * number indications as they emerge from GNU cpp (`# lineno "file"
531 * flags') into NASM preprocessor line number indications (`%line
534 static char *prepreproc(char *line)
537 char *fname, *oldline;
539 if (line[0] == '#' && line[1] == ' ') {
542 lineno = atoi(fname);
543 fname += strspn(fname, "0123456789 ");
546 fnlen = strcspn(fname, "\"");
547 line = nasm_malloc(20 + fnlen);
548 snprintf(line, 20 + fnlen, "%%line %d %.*s", lineno, fnlen, fname);
551 if (tasm_compatible_mode)
552 return check_tasm_directive(line);
557 * Free a linked list of tokens.
559 static void free_tlist(Token * list)
562 list = delete_Token(list);
567 * Free a linked list of lines.
569 static void free_llist(Line * list)
575 free_tlist(l->first);
583 static void free_mmacro(MMacro * m)
586 free_tlist(m->dlist);
587 nasm_free(m->defaults);
588 free_llist(m->expansion);
593 * Free all currently defined macros, and free the hash tables
595 static void free_smacro_table(struct hash_table *smt)
599 struct hash_tbl_node *it = NULL;
601 while ((s = hash_iterate(smt, &it, &key)) != NULL) {
602 nasm_free((void *)key);
604 SMacro *ns = s->next;
606 free_tlist(s->expansion);
614 static void free_mmacro_table(struct hash_table *mmt)
618 struct hash_tbl_node *it = NULL;
621 while ((m = hash_iterate(mmt, &it, &key)) != NULL) {
622 nasm_free((void *)key);
624 MMacro *nm = m->next;
632 static void free_macros(void)
634 free_smacro_table(&smacros);
635 free_mmacro_table(&mmacros);
639 * Initialize the hash tables
641 static void init_macros(void)
643 hash_init(&smacros, HASH_LARGE);
644 hash_init(&mmacros, HASH_LARGE);
648 * Pop the context stack.
650 static void ctx_pop(void)
655 free_smacro_table(&c->localmac);
661 * Search for a key in the hash index; adding it if necessary
662 * (in which case we initialize the data pointer to NULL.)
665 hash_findi_add(struct hash_table *hash, const char *str)
667 struct hash_insert hi;
671 r = hash_findi(hash, str, &hi);
675 strx = nasm_strdup(str); /* Use a more efficient allocator here? */
676 return hash_add(&hi, strx, NULL);
680 * Like hash_findi, but returns the data element rather than a pointer
681 * to it. Used only when not adding a new element, hence no third
685 hash_findix(struct hash_table *hash, const char *str)
689 p = hash_findi(hash, str, NULL);
690 return p ? *p : NULL;
693 #define BUF_DELTA 512
695 * Read a line from the top file in istk, handling multiple CR/LFs
696 * at the end of the line read, and handling spurious ^Zs. Will
697 * return lines from the standard macro set if this has not already
700 static char *read_line(void)
702 char *buffer, *p, *q;
703 int bufsize, continued_count;
707 const unsigned char *p = stdmacpos;
712 len += pp_directives_len[c-0x80]+1;
716 ret = nasm_malloc(len+1);
718 while ((c = *stdmacpos++)) {
720 memcpy(q, pp_directives[c-0x80], pp_directives_len[c-0x80]);
721 q += pp_directives_len[c-0x80];
731 /* This was the last of the standard macro chain... */
733 if (any_extrastdmac) {
734 stdmacpos = extrastdmac;
735 any_extrastdmac = false;
736 } else if (do_predef) {
738 Token *head, **tail, *t;
741 * Nasty hack: here we push the contents of
742 * `predef' on to the top-level expansion stack,
743 * since this is the most convenient way to
744 * implement the pre-include and pre-define
747 for (pd = predef; pd; pd = pd->next) {
750 for (t = pd->first; t; t = t->next) {
751 *tail = new_Token(NULL, t->type, t->text, 0);
752 tail = &(*tail)->next;
754 l = nasm_malloc(sizeof(Line));
755 l->next = istk->expansion;
767 buffer = nasm_malloc(BUF_DELTA);
771 q = fgets(p, bufsize - (p - buffer), istk->fp);
775 if (p > buffer && p[-1] == '\n') {
776 /* Convert backslash-CRLF line continuation sequences into
777 nothing at all (for DOS and Windows) */
778 if (((p - 2) > buffer) && (p[-3] == '\\') && (p[-2] == '\r')) {
783 /* Also convert backslash-LF line continuation sequences into
784 nothing at all (for Unix) */
785 else if (((p - 1) > buffer) && (p[-2] == '\\')) {
793 if (p - buffer > bufsize - 10) {
794 int32_t offset = p - buffer;
795 bufsize += BUF_DELTA;
796 buffer = nasm_realloc(buffer, bufsize);
797 p = buffer + offset; /* prevent stale-pointer problems */
801 if (!q && p == buffer) {
806 src_set_linnum(src_get_linnum() + istk->lineinc +
807 (continued_count * istk->lineinc));
810 * Play safe: remove CRs as well as LFs, if any of either are
811 * present at the end of the line.
813 while (--p >= buffer && (*p == '\n' || *p == '\r'))
817 * Handle spurious ^Z, which may be inserted into source files
818 * by some file transfer utilities.
820 buffer[strcspn(buffer, "\032")] = '\0';
822 list->line(LIST_READ, buffer);
828 * Tokenize a line of text. This is a very simple process since we
829 * don't need to parse the value out of e.g. numeric tokens: we
830 * simply split one string into many.
832 static Token *tokenize(char *line)
835 enum pp_token_type type;
837 Token *t, **tail = &list;
843 if (*p == '+' && !nasm_isdigit(p[1])) {
846 } else if (nasm_isdigit(*p) ||
847 ((*p == '-' || *p == '+') && nasm_isdigit(p[1]))) {
851 while (nasm_isdigit(*p));
852 type = TOK_PREPROC_ID;
853 } else if (*p == '{') {
855 while (*p && *p != '}') {
862 type = TOK_PREPROC_ID;
863 } else if (*p == '[') {
865 line += 2; /* Skip the leading %[ */
867 while (lvl && (c = *p++)) {
879 p = nasm_skip_string(p)+1;
889 error(ERR_NONFATAL, "unterminated %[ construct");
891 } else if (*p == '?') {
892 type = TOK_PREPROC_Q; /* %? */
895 type = TOK_PREPROC_QQ; /* %?? */
898 } else if (isidchar(*p) ||
899 ((*p == '!' || *p == '%' || *p == '$') &&
904 while (isidchar(*p));
905 type = TOK_PREPROC_ID;
911 } else if (isidstart(*p) || (*p == '$' && isidstart(p[1]))) {
914 while (*p && isidchar(*p))
916 } else if (*p == '\'' || *p == '"' || *p == '`') {
921 p = nasm_skip_string(p);
926 error(ERR_WARNING|ERR_PASS1, "unterminated string");
927 /* Handling unterminated strings by UNV */
930 } else if (p[0] == '$' && p[1] == '$') {
931 type = TOK_OTHER; /* TOKEN_BASE */
933 } else if (isnumstart(*p)) {
935 bool is_float = false;
951 if (!is_hex && (c == 'e' || c == 'E')) {
953 if (*p == '+' || *p == '-') {
954 /* e can only be followed by +/- if it is either a
955 prefixed hex number or a floating-point number */
959 } else if (c == 'H' || c == 'h' || c == 'X' || c == 'x') {
961 } else if (c == 'P' || c == 'p') {
963 if (*p == '+' || *p == '-')
965 } else if (isnumchar(c) || c == '_')
968 /* we need to deal with consequences of the legacy
969 parser, like "1.nolist" being two tokens
970 (TOK_NUMBER, TOK_ID) here; at least give it
971 a shot for now. In the future, we probably need
972 a flex-based scanner with proper pattern matching
973 to do it as well as it can be done. Nothing in
974 the world is going to help the person who wants
975 0x123.p16 interpreted as two tokens, though. */
980 if (nasm_isdigit(*r) || (is_hex && nasm_isxdigit(*r)) ||
981 (!is_hex && (*r == 'e' || *r == 'E')) ||
982 (*r == 'p' || *r == 'P')) {
986 break; /* Terminate the token */
990 p--; /* Point to first character beyond number */
992 if (p == line+1 && *line == '$') {
993 type = TOK_OTHER; /* TOKEN_HERE */
995 if (has_e && !is_hex) {
996 /* 1e13 is floating-point, but 1e13h is not */
1000 type = is_float ? TOK_FLOAT : TOK_NUMBER;
1002 } else if (nasm_isspace(*p)) {
1003 type = TOK_WHITESPACE;
1005 while (*p && nasm_isspace(*p))
1008 * Whitespace just before end-of-line is discarded by
1009 * pretending it's a comment; whitespace just before a
1010 * comment gets lumped into the comment.
1012 if (!*p || *p == ';') {
1017 } else if (*p == ';') {
1023 * Anything else is an operator of some kind. We check
1024 * for all the double-character operators (>>, <<, //,
1025 * %%, <=, >=, ==, !=, <>, &&, ||, ^^), but anything
1026 * else is a single-character operator.
1029 if ((p[0] == '>' && p[1] == '>') ||
1030 (p[0] == '<' && p[1] == '<') ||
1031 (p[0] == '/' && p[1] == '/') ||
1032 (p[0] == '<' && p[1] == '=') ||
1033 (p[0] == '>' && p[1] == '=') ||
1034 (p[0] == '=' && p[1] == '=') ||
1035 (p[0] == '!' && p[1] == '=') ||
1036 (p[0] == '<' && p[1] == '>') ||
1037 (p[0] == '&' && p[1] == '&') ||
1038 (p[0] == '|' && p[1] == '|') ||
1039 (p[0] == '^' && p[1] == '^')) {
1045 /* Handling unterminated string by UNV */
1048 *tail = t = new_Token(NULL, TOK_STRING, line, p-line+1);
1049 t->text[p-line] = *line;
1053 if (type != TOK_COMMENT) {
1054 *tail = t = new_Token(NULL, type, line, p - line);
1063 * this function allocates a new managed block of memory and
1064 * returns a pointer to the block. The managed blocks are
1065 * deleted only all at once by the delete_Blocks function.
1067 static void *new_Block(size_t size)
1069 Blocks *b = &blocks;
1071 /* first, get to the end of the linked list */
1074 /* now allocate the requested chunk */
1075 b->chunk = nasm_malloc(size);
1077 /* now allocate a new block for the next request */
1078 b->next = nasm_malloc(sizeof(Blocks));
1079 /* and initialize the contents of the new block */
1080 b->next->next = NULL;
1081 b->next->chunk = NULL;
1086 * this function deletes all managed blocks of memory
1088 static void delete_Blocks(void)
1090 Blocks *a, *b = &blocks;
1093 * keep in mind that the first block, pointed to by blocks
1094 * is a static and not dynamically allocated, so we don't
1099 nasm_free(b->chunk);
1108 * this function creates a new Token and passes a pointer to it
1109 * back to the caller. It sets the type and text elements, and
1110 * also the a.mac and next elements to NULL.
1112 static Token *new_Token(Token * next, enum pp_token_type type,
1113 const char *text, int txtlen)
1118 if (freeTokens == NULL) {
1119 freeTokens = (Token *) new_Block(TOKEN_BLOCKSIZE * sizeof(Token));
1120 for (i = 0; i < TOKEN_BLOCKSIZE - 1; i++)
1121 freeTokens[i].next = &freeTokens[i + 1];
1122 freeTokens[i].next = NULL;
1125 freeTokens = t->next;
1129 if (type == TOK_WHITESPACE || text == NULL) {
1133 txtlen = strlen(text);
1134 t->text = nasm_malloc(txtlen+1);
1135 memcpy(t->text, text, txtlen);
1136 t->text[txtlen] = '\0';
1141 static Token *delete_Token(Token * t)
1143 Token *next = t->next;
1145 t->next = freeTokens;
1151 * Convert a line of tokens back into text.
1152 * If expand_locals is not zero, identifiers of the form "%$*xxx"
1153 * will be transformed into ..@ctxnum.xxx
1155 static char *detoken(Token * tlist, bool expand_locals)
1163 for (t = tlist; t; t = t->next) {
1164 if (t->type == TOK_PREPROC_ID && t->text[1] == '!') {
1165 char *p = getenv(t->text + 2);
1168 t->text = nasm_strdup(p);
1172 /* Expand local macros here and not during preprocessing */
1173 if (expand_locals &&
1174 t->type == TOK_PREPROC_ID && t->text &&
1175 t->text[0] == '%' && t->text[1] == '$') {
1178 Context *ctx = get_ctx(t->text, &q, false);
1181 snprintf(buffer, sizeof(buffer), "..@%"PRIu32".", ctx->number);
1182 p = nasm_strcat(buffer, q);
1187 if (t->type == TOK_WHITESPACE) {
1189 } else if (t->text) {
1190 len += strlen(t->text);
1193 p = line = nasm_malloc(len + 1);
1194 for (t = tlist; t; t = t->next) {
1195 if (t->type == TOK_WHITESPACE) {
1197 } else if (t->text) {
1208 * A scanner, suitable for use by the expression evaluator, which
1209 * operates on a line of Tokens. Expects a pointer to a pointer to
1210 * the first token in the line to be passed in as its private_data
1213 * FIX: This really needs to be unified with stdscan.
1215 static int ppscan(void *private_data, struct tokenval *tokval)
1217 Token **tlineptr = private_data;
1219 char ourcopy[MAX_KEYWORD+1], *p, *r, *s;
1223 *tlineptr = tline ? tline->next : NULL;
1225 while (tline && (tline->type == TOK_WHITESPACE ||
1226 tline->type == TOK_COMMENT));
1229 return tokval->t_type = TOKEN_EOS;
1231 tokval->t_charptr = tline->text;
1233 if (tline->text[0] == '$' && !tline->text[1])
1234 return tokval->t_type = TOKEN_HERE;
1235 if (tline->text[0] == '$' && tline->text[1] == '$' && !tline->text[2])
1236 return tokval->t_type = TOKEN_BASE;
1238 if (tline->type == TOK_ID) {
1239 p = tokval->t_charptr = tline->text;
1241 tokval->t_charptr++;
1242 return tokval->t_type = TOKEN_ID;
1245 for (r = p, s = ourcopy; *r; r++) {
1246 if (r >= p+MAX_KEYWORD)
1247 return tokval->t_type = TOKEN_ID; /* Not a keyword */
1248 *s++ = nasm_tolower(*r);
1251 /* right, so we have an identifier sitting in temp storage. now,
1252 * is it actually a register or instruction name, or what? */
1253 return nasm_token_hash(ourcopy, tokval);
1256 if (tline->type == TOK_NUMBER) {
1258 tokval->t_integer = readnum(tline->text, &rn_error);
1259 tokval->t_charptr = tline->text;
1261 return tokval->t_type = TOKEN_ERRNUM;
1263 return tokval->t_type = TOKEN_NUM;
1266 if (tline->type == TOK_FLOAT) {
1267 return tokval->t_type = TOKEN_FLOAT;
1270 if (tline->type == TOK_STRING) {
1273 bq = tline->text[0];
1274 tokval->t_charptr = tline->text;
1275 tokval->t_inttwo = nasm_unquote(tline->text, &ep);
1277 if (ep[0] != bq || ep[1] != '\0')
1278 return tokval->t_type = TOKEN_ERRSTR;
1280 return tokval->t_type = TOKEN_STR;
1283 if (tline->type == TOK_OTHER) {
1284 if (!strcmp(tline->text, "<<"))
1285 return tokval->t_type = TOKEN_SHL;
1286 if (!strcmp(tline->text, ">>"))
1287 return tokval->t_type = TOKEN_SHR;
1288 if (!strcmp(tline->text, "//"))
1289 return tokval->t_type = TOKEN_SDIV;
1290 if (!strcmp(tline->text, "%%"))
1291 return tokval->t_type = TOKEN_SMOD;
1292 if (!strcmp(tline->text, "=="))
1293 return tokval->t_type = TOKEN_EQ;
1294 if (!strcmp(tline->text, "<>"))
1295 return tokval->t_type = TOKEN_NE;
1296 if (!strcmp(tline->text, "!="))
1297 return tokval->t_type = TOKEN_NE;
1298 if (!strcmp(tline->text, "<="))
1299 return tokval->t_type = TOKEN_LE;
1300 if (!strcmp(tline->text, ">="))
1301 return tokval->t_type = TOKEN_GE;
1302 if (!strcmp(tline->text, "&&"))
1303 return tokval->t_type = TOKEN_DBL_AND;
1304 if (!strcmp(tline->text, "^^"))
1305 return tokval->t_type = TOKEN_DBL_XOR;
1306 if (!strcmp(tline->text, "||"))
1307 return tokval->t_type = TOKEN_DBL_OR;
1311 * We have no other options: just return the first character of
1314 return tokval->t_type = tline->text[0];
1318 * Compare a string to the name of an existing macro; this is a
1319 * simple wrapper which calls either strcmp or nasm_stricmp
1320 * depending on the value of the `casesense' parameter.
1322 static int mstrcmp(const char *p, const char *q, bool casesense)
1324 return casesense ? strcmp(p, q) : nasm_stricmp(p, q);
1328 * Compare a string to the name of an existing macro; this is a
1329 * simple wrapper which calls either strcmp or nasm_stricmp
1330 * depending on the value of the `casesense' parameter.
1332 static int mmemcmp(const char *p, const char *q, size_t l, bool casesense)
1334 return casesense ? memcmp(p, q, l) : nasm_memicmp(p, q, l);
1338 * Return the Context structure associated with a %$ token. Return
1339 * NULL, having _already_ reported an error condition, if the
1340 * context stack isn't deep enough for the supplied number of $
1342 * If all_contexts == true, contexts that enclose current are
1343 * also scanned for such smacro, until it is found; if not -
1344 * only the context that directly results from the number of $'s
1345 * in variable's name.
1347 * If "namep" is non-NULL, set it to the pointer to the macro name
1348 * tail, i.e. the part beyond %$...
1350 static Context *get_ctx(const char *name, const char **namep,
1360 if (!name || name[0] != '%' || name[1] != '$')
1364 error(ERR_NONFATAL, "`%s': context stack is empty", name);
1371 while (ctx && *name == '$') {
1377 error(ERR_NONFATAL, "`%s': context stack is only"
1378 " %d level%s deep", name, i, (i == 1 ? "" : "s"));
1389 /* Search for this smacro in found context */
1390 m = hash_findix(&ctx->localmac, name);
1392 if (!mstrcmp(m->name, name, m->casesense))
1403 * Check to see if a file is already in a string list
1405 static bool in_list(const StrList *list, const char *str)
1408 if (!strcmp(list->str, str))
1416 * Open an include file. This routine must always return a valid
1417 * file pointer if it returns - it's responsible for throwing an
1418 * ERR_FATAL and bombing out completely if not. It should also try
1419 * the include path one by one until it finds the file or reaches
1420 * the end of the path.
1422 static FILE *inc_fopen(const char *file, StrList **dhead, StrList ***dtail,
1427 IncPath *ip = ipath;
1428 int len = strlen(file);
1429 size_t prefix_len = 0;
1433 sl = nasm_malloc(prefix_len+len+1+sizeof sl->next);
1434 memcpy(sl->str, prefix, prefix_len);
1435 memcpy(sl->str+prefix_len, file, len+1);
1436 fp = fopen(sl->str, "r");
1437 if (fp && dhead && !in_list(*dhead, sl->str)) {
1455 prefix_len = strlen(prefix);
1457 /* -MG given and file not found */
1458 if (dhead && !in_list(*dhead, file)) {
1459 sl = nasm_malloc(len+1+sizeof sl->next);
1461 strcpy(sl->str, file);
1469 error(ERR_FATAL, "unable to open include file `%s'", file);
1470 return NULL; /* never reached - placate compilers */
1474 * Determine if we should warn on defining a single-line macro of
1475 * name `name', with `nparam' parameters. If nparam is 0 or -1, will
1476 * return true if _any_ single-line macro of that name is defined.
1477 * Otherwise, will return true if a single-line macro with either
1478 * `nparam' or no parameters is defined.
1480 * If a macro with precisely the right number of parameters is
1481 * defined, or nparam is -1, the address of the definition structure
1482 * will be returned in `defn'; otherwise NULL will be returned. If `defn'
1483 * is NULL, no action will be taken regarding its contents, and no
1486 * Note that this is also called with nparam zero to resolve
1489 * If you already know which context macro belongs to, you can pass
1490 * the context pointer as first parameter; if you won't but name begins
1491 * with %$ the context will be automatically computed. If all_contexts
1492 * is true, macro will be searched in outer contexts as well.
1495 smacro_defined(Context * ctx, const char *name, int nparam, SMacro ** defn,
1498 struct hash_table *smtbl;
1502 smtbl = &ctx->localmac;
1503 } else if (name[0] == '%' && name[1] == '$') {
1505 ctx = get_ctx(name, &name, false);
1507 return false; /* got to return _something_ */
1508 smtbl = &ctx->localmac;
1512 m = (SMacro *) hash_findix(smtbl, name);
1515 if (!mstrcmp(m->name, name, m->casesense && nocase) &&
1516 (nparam <= 0 || m->nparam == 0 || nparam == (int) m->nparam)) {
1518 if (nparam == (int) m->nparam || nparam == -1)
1532 * Count and mark off the parameters in a multi-line macro call.
1533 * This is called both from within the multi-line macro expansion
1534 * code, and also to mark off the default parameters when provided
1535 * in a %macro definition line.
1537 static void count_mmac_params(Token * t, int *nparam, Token *** params)
1539 int paramsize, brace;
1541 *nparam = paramsize = 0;
1544 /* +1: we need space for the final NULL */
1545 if (*nparam+1 >= paramsize) {
1546 paramsize += PARAM_DELTA;
1547 *params = nasm_realloc(*params, sizeof(**params) * paramsize);
1551 if (tok_is_(t, "{"))
1553 (*params)[(*nparam)++] = t;
1554 while (tok_isnt_(t, brace ? "}" : ","))
1556 if (t) { /* got a comma/brace */
1560 * Now we've found the closing brace, look further
1564 if (tok_isnt_(t, ",")) {
1566 "braces do not enclose all of macro parameter");
1567 while (tok_isnt_(t, ","))
1571 t = t->next; /* eat the comma */
1578 * Determine whether one of the various `if' conditions is true or
1581 * We must free the tline we get passed.
1583 static bool if_condition(Token * tline, enum preproc_token ct)
1585 enum pp_conditional i = PP_COND(ct);
1587 Token *t, *tt, **tptr, *origline;
1588 struct tokenval tokval;
1590 enum pp_token_type needtype;
1596 j = false; /* have we matched yet? */
1601 if (tline->type != TOK_ID) {
1603 "`%s' expects context identifiers", pp_directives[ct]);
1604 free_tlist(origline);
1607 if (cstk && cstk->name && !nasm_stricmp(tline->text, cstk->name))
1609 tline = tline->next;
1614 j = false; /* have we matched yet? */
1617 if (!tline || (tline->type != TOK_ID &&
1618 (tline->type != TOK_PREPROC_ID ||
1619 tline->text[1] != '$'))) {
1621 "`%s' expects macro identifiers", pp_directives[ct]);
1624 if (smacro_defined(NULL, tline->text, 0, NULL, true))
1626 tline = tline->next;
1632 tline = expand_smacro(tline);
1634 while (tok_isnt_(tt, ","))
1638 "`%s' expects two comma-separated arguments",
1643 j = true; /* assume equality unless proved not */
1644 while ((t->type != TOK_OTHER || strcmp(t->text, ",")) && tt) {
1645 if (tt->type == TOK_OTHER && !strcmp(tt->text, ",")) {
1646 error(ERR_NONFATAL, "`%s': more than one comma on line",
1650 if (t->type == TOK_WHITESPACE) {
1654 if (tt->type == TOK_WHITESPACE) {
1658 if (tt->type != t->type) {
1659 j = false; /* found mismatching tokens */
1662 /* When comparing strings, need to unquote them first */
1663 if (t->type == TOK_STRING) {
1664 size_t l1 = nasm_unquote(t->text, NULL);
1665 size_t l2 = nasm_unquote(tt->text, NULL);
1671 if (mmemcmp(t->text, tt->text, l1, i == PPC_IFIDN)) {
1675 } else if (mstrcmp(tt->text, t->text, i == PPC_IFIDN) != 0) {
1676 j = false; /* found mismatching tokens */
1683 if ((t->type != TOK_OTHER || strcmp(t->text, ",")) || tt)
1684 j = false; /* trailing gunk on one end or other */
1690 MMacro searching, *mmac;
1693 tline = expand_id(tline);
1694 if (!tok_type_(tline, TOK_ID)) {
1696 "`%s' expects a macro name", pp_directives[ct]);
1699 searching.name = nasm_strdup(tline->text);
1700 searching.casesense = true;
1701 searching.plus = false;
1702 searching.nolist = false;
1703 searching.in_progress = 0;
1704 searching.max_depth = 0;
1705 searching.rep_nest = NULL;
1706 searching.nparam_min = 0;
1707 searching.nparam_max = INT_MAX;
1708 tline = expand_smacro(tline->next);
1711 } else if (!tok_type_(tline, TOK_NUMBER)) {
1713 "`%s' expects a parameter count or nothing",
1716 searching.nparam_min = searching.nparam_max =
1717 readnum(tline->text, &j);
1720 "unable to parse parameter count `%s'",
1723 if (tline && tok_is_(tline->next, "-")) {
1724 tline = tline->next->next;
1725 if (tok_is_(tline, "*"))
1726 searching.nparam_max = INT_MAX;
1727 else if (!tok_type_(tline, TOK_NUMBER))
1729 "`%s' expects a parameter count after `-'",
1732 searching.nparam_max = readnum(tline->text, &j);
1735 "unable to parse parameter count `%s'",
1737 if (searching.nparam_min > searching.nparam_max)
1739 "minimum parameter count exceeds maximum");
1742 if (tline && tok_is_(tline->next, "+")) {
1743 tline = tline->next;
1744 searching.plus = true;
1746 mmac = (MMacro *) hash_findix(&mmacros, searching.name);
1748 if (!strcmp(mmac->name, searching.name) &&
1749 (mmac->nparam_min <= searching.nparam_max
1751 && (searching.nparam_min <= mmac->nparam_max
1758 if(tline && tline->next)
1759 error(ERR_WARNING|ERR_PASS1,
1760 "trailing garbage after %%ifmacro ignored");
1761 nasm_free(searching.name);
1770 needtype = TOK_NUMBER;
1773 needtype = TOK_STRING;
1777 t = tline = expand_smacro(tline);
1779 while (tok_type_(t, TOK_WHITESPACE) ||
1780 (needtype == TOK_NUMBER &&
1781 tok_type_(t, TOK_OTHER) &&
1782 (t->text[0] == '-' || t->text[0] == '+') &&
1786 j = tok_type_(t, needtype);
1790 t = tline = expand_smacro(tline);
1791 while (tok_type_(t, TOK_WHITESPACE))
1796 t = t->next; /* Skip the actual token */
1797 while (tok_type_(t, TOK_WHITESPACE))
1799 j = !t; /* Should be nothing left */
1804 t = tline = expand_smacro(tline);
1805 while (tok_type_(t, TOK_WHITESPACE))
1808 j = !t; /* Should be empty */
1812 t = tline = expand_smacro(tline);
1814 tokval.t_type = TOKEN_INVALID;
1815 evalresult = evaluate(ppscan, tptr, &tokval,
1816 NULL, pass | CRITICAL, error, NULL);
1820 error(ERR_WARNING|ERR_PASS1,
1821 "trailing garbage after expression ignored");
1822 if (!is_simple(evalresult)) {
1824 "non-constant value given to `%s'", pp_directives[ct]);
1827 j = reloc_value(evalresult) != 0;
1832 "preprocessor directive `%s' not yet implemented",
1837 free_tlist(origline);
1838 return j ^ PP_NEGATIVE(ct);
1841 free_tlist(origline);
1846 * Common code for defining an smacro
1848 static bool define_smacro(Context *ctx, const char *mname, bool casesense,
1849 int nparam, Token *expansion)
1851 SMacro *smac, **smhead;
1852 struct hash_table *smtbl;
1854 if (smacro_defined(ctx, mname, nparam, &smac, casesense)) {
1856 error(ERR_WARNING|ERR_PASS1,
1857 "single-line macro `%s' defined both with and"
1858 " without parameters", mname);
1860 /* Some instances of the old code considered this a failure,
1861 some others didn't. What is the right thing to do here? */
1862 free_tlist(expansion);
1863 return false; /* Failure */
1866 * We're redefining, so we have to take over an
1867 * existing SMacro structure. This means freeing
1868 * what was already in it.
1870 nasm_free(smac->name);
1871 free_tlist(smac->expansion);
1874 smtbl = ctx ? &ctx->localmac : &smacros;
1875 smhead = (SMacro **) hash_findi_add(smtbl, mname);
1876 smac = nasm_malloc(sizeof(SMacro));
1877 smac->next = *smhead;
1880 smac->name = nasm_strdup(mname);
1881 smac->casesense = casesense;
1882 smac->nparam = nparam;
1883 smac->expansion = expansion;
1884 smac->in_progress = false;
1885 return true; /* Success */
1889 * Undefine an smacro
1891 static void undef_smacro(Context *ctx, const char *mname)
1893 SMacro **smhead, *s, **sp;
1894 struct hash_table *smtbl;
1896 smtbl = ctx ? &ctx->localmac : &smacros;
1897 smhead = (SMacro **)hash_findi(smtbl, mname, NULL);
1901 * We now have a macro name... go hunt for it.
1904 while ((s = *sp) != NULL) {
1905 if (!mstrcmp(s->name, mname, s->casesense)) {
1908 free_tlist(s->expansion);
1918 * Parse a mmacro specification.
1920 static bool parse_mmacro_spec(Token *tline, MMacro *def, const char *directive)
1924 tline = tline->next;
1926 tline = expand_id(tline);
1927 if (!tok_type_(tline, TOK_ID)) {
1928 error(ERR_NONFATAL, "`%s' expects a macro name", directive);
1933 def->name = nasm_strdup(tline->text);
1935 def->nolist = false;
1936 def->in_progress = 0;
1937 def->rep_nest = NULL;
1938 def->nparam_min = 0;
1939 def->nparam_max = 0;
1941 tline = expand_smacro(tline->next);
1943 if (!tok_type_(tline, TOK_NUMBER)) {
1944 error(ERR_NONFATAL, "`%s' expects a parameter count", directive);
1946 def->nparam_min = def->nparam_max =
1947 readnum(tline->text, &err);
1950 "unable to parse parameter count `%s'", tline->text);
1952 if (tline && tok_is_(tline->next, "-")) {
1953 tline = tline->next->next;
1954 if (tok_is_(tline, "*")) {
1955 def->nparam_max = INT_MAX;
1956 } else if (!tok_type_(tline, TOK_NUMBER)) {
1958 "`%s' expects a parameter count after `-'", directive);
1960 def->nparam_max = readnum(tline->text, &err);
1962 error(ERR_NONFATAL, "unable to parse parameter count `%s'",
1965 if (def->nparam_min > def->nparam_max) {
1966 error(ERR_NONFATAL, "minimum parameter count exceeds maximum");
1970 if (tline && tok_is_(tline->next, "+")) {
1971 tline = tline->next;
1974 if (tline && tok_type_(tline->next, TOK_ID) &&
1975 !nasm_stricmp(tline->next->text, ".nolist")) {
1976 tline = tline->next;
1981 * Handle default parameters.
1983 if (tline && tline->next) {
1984 def->dlist = tline->next;
1986 count_mmac_params(def->dlist, &def->ndefs, &def->defaults);
1989 def->defaults = NULL;
1991 def->expansion = NULL;
1994 def->ndefs > def->nparam_max - def->nparam_min &&
1996 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MDP,
1997 "too many default macro parameters");
2004 * Decode a size directive
2006 static int parse_size(const char *str) {
2007 static const char *size_names[] =
2008 { "byte", "dword", "oword", "qword", "tword", "word", "yword" };
2009 static const int sizes[] =
2010 { 0, 1, 4, 16, 8, 10, 2, 32 };
2012 return sizes[bsii(str, size_names, elements(size_names))+1];
2016 * find and process preprocessor directive in passed line
2017 * Find out if a line contains a preprocessor directive, and deal
2020 * If a directive _is_ found, it is the responsibility of this routine
2021 * (and not the caller) to free_tlist() the line.
2023 * @param tline a pointer to the current tokeninzed line linked list
2024 * @return DIRECTIVE_FOUND or NO_DIRECTIVE_FOUND
2027 static int do_directive(Token * tline)
2029 enum preproc_token i;
2042 MMacro *mmac, **mmhead;
2043 Token *t, *tt, *param_start, *macro_start, *last, **tptr, *origline;
2045 struct tokenval tokval;
2047 MMacro *tmp_defining; /* Used when manipulating rep_nest */
2055 if (!tline || !tok_type_(tline, TOK_PREPROC_ID) ||
2056 (tline->text[1] == '%' || tline->text[1] == '$'
2057 || tline->text[1] == '!'))
2058 return NO_DIRECTIVE_FOUND;
2060 i = pp_token_hash(tline->text);
2063 * If we're in a non-emitting branch of a condition construct,
2064 * or walking to the end of an already terminated %rep block,
2065 * we should ignore all directives except for condition
2068 if (((istk->conds && !emitting(istk->conds->state)) ||
2069 (istk->mstk && !istk->mstk->in_progress)) && !is_condition(i)) {
2070 return NO_DIRECTIVE_FOUND;
2074 * If we're defining a macro or reading a %rep block, we should
2075 * ignore all directives except for %macro/%imacro (which nest),
2076 * %endm/%endmacro, and (only if we're in a %rep block) %endrep.
2077 * If we're in a %rep block, another %rep nests, so should be let through.
2079 if (defining && i != PP_MACRO && i != PP_IMACRO &&
2080 i != PP_RMACRO && i != PP_RIMACRO &&
2081 i != PP_ENDMACRO && i != PP_ENDM &&
2082 (defining->name || (i != PP_ENDREP && i != PP_REP))) {
2083 return NO_DIRECTIVE_FOUND;
2087 if (i == PP_MACRO || i == PP_IMACRO ||
2088 i == PP_RMACRO || i == PP_RIMACRO) {
2090 return NO_DIRECTIVE_FOUND;
2091 } else if (nested_mac_count > 0) {
2092 if (i == PP_ENDMACRO) {
2094 return NO_DIRECTIVE_FOUND;
2097 if (!defining->name) {
2100 return NO_DIRECTIVE_FOUND;
2101 } else if (nested_rep_count > 0) {
2102 if (i == PP_ENDREP) {
2104 return NO_DIRECTIVE_FOUND;
2112 error(ERR_NONFATAL, "unknown preprocessor directive `%s'",
2114 return NO_DIRECTIVE_FOUND; /* didn't get it */
2117 /* Directive to tell NASM what the default stack size is. The
2118 * default is for a 16-bit stack, and this can be overriden with
2120 * the following form:
2122 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2124 tline = tline->next;
2125 if (tline && tline->type == TOK_WHITESPACE)
2126 tline = tline->next;
2127 if (!tline || tline->type != TOK_ID) {
2128 error(ERR_NONFATAL, "`%%stacksize' missing size parameter");
2129 free_tlist(origline);
2130 return DIRECTIVE_FOUND;
2132 if (nasm_stricmp(tline->text, "flat") == 0) {
2133 /* All subsequent ARG directives are for a 32-bit stack */
2135 StackPointer = "ebp";
2138 } else if (nasm_stricmp(tline->text, "flat64") == 0) {
2139 /* All subsequent ARG directives are for a 64-bit stack */
2141 StackPointer = "rbp";
2144 } else if (nasm_stricmp(tline->text, "large") == 0) {
2145 /* All subsequent ARG directives are for a 16-bit stack,
2146 * far function call.
2149 StackPointer = "bp";
2152 } else if (nasm_stricmp(tline->text, "small") == 0) {
2153 /* All subsequent ARG directives are for a 16-bit stack,
2154 * far function call. We don't support near functions.
2157 StackPointer = "bp";
2161 error(ERR_NONFATAL, "`%%stacksize' invalid size type");
2162 free_tlist(origline);
2163 return DIRECTIVE_FOUND;
2165 free_tlist(origline);
2166 return DIRECTIVE_FOUND;
2169 /* TASM like ARG directive to define arguments to functions, in
2170 * the following form:
2172 * ARG arg1:WORD, arg2:DWORD, arg4:QWORD
2176 char *arg, directive[256];
2177 int size = StackSize;
2179 /* Find the argument name */
2180 tline = tline->next;
2181 if (tline && tline->type == TOK_WHITESPACE)
2182 tline = tline->next;
2183 if (!tline || tline->type != TOK_ID) {
2184 error(ERR_NONFATAL, "`%%arg' missing argument parameter");
2185 free_tlist(origline);
2186 return DIRECTIVE_FOUND;
2190 /* Find the argument size type */
2191 tline = tline->next;
2192 if (!tline || tline->type != TOK_OTHER
2193 || tline->text[0] != ':') {
2195 "Syntax error processing `%%arg' directive");
2196 free_tlist(origline);
2197 return DIRECTIVE_FOUND;
2199 tline = tline->next;
2200 if (!tline || tline->type != TOK_ID) {
2201 error(ERR_NONFATAL, "`%%arg' missing size type parameter");
2202 free_tlist(origline);
2203 return DIRECTIVE_FOUND;
2206 /* Allow macro expansion of type parameter */
2207 tt = tokenize(tline->text);
2208 tt = expand_smacro(tt);
2209 size = parse_size(tt->text);
2212 "Invalid size type for `%%arg' missing directive");
2214 free_tlist(origline);
2215 return DIRECTIVE_FOUND;
2219 /* Round up to even stack slots */
2220 size = (size+StackSize-1) & ~(StackSize-1);
2222 /* Now define the macro for the argument */
2223 snprintf(directive, sizeof(directive), "%%define %s (%s+%d)",
2224 arg, StackPointer, offset);
2225 do_directive(tokenize(directive));
2228 /* Move to the next argument in the list */
2229 tline = tline->next;
2230 if (tline && tline->type == TOK_WHITESPACE)
2231 tline = tline->next;
2232 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2234 free_tlist(origline);
2235 return DIRECTIVE_FOUND;
2238 /* TASM like LOCAL directive to define local variables for a
2239 * function, in the following form:
2241 * LOCAL local1:WORD, local2:DWORD, local4:QWORD = LocalSize
2243 * The '= LocalSize' at the end is ignored by NASM, but is
2244 * required by TASM to define the local parameter size (and used
2245 * by the TASM macro package).
2247 offset = LocalOffset;
2249 char *local, directive[256];
2250 int size = StackSize;
2252 /* Find the argument name */
2253 tline = tline->next;
2254 if (tline && tline->type == TOK_WHITESPACE)
2255 tline = tline->next;
2256 if (!tline || tline->type != TOK_ID) {
2258 "`%%local' missing argument parameter");
2259 free_tlist(origline);
2260 return DIRECTIVE_FOUND;
2262 local = tline->text;
2264 /* Find the argument size type */
2265 tline = tline->next;
2266 if (!tline || tline->type != TOK_OTHER
2267 || tline->text[0] != ':') {
2269 "Syntax error processing `%%local' directive");
2270 free_tlist(origline);
2271 return DIRECTIVE_FOUND;
2273 tline = tline->next;
2274 if (!tline || tline->type != TOK_ID) {
2276 "`%%local' missing size type parameter");
2277 free_tlist(origline);
2278 return DIRECTIVE_FOUND;
2281 /* Allow macro expansion of type parameter */
2282 tt = tokenize(tline->text);
2283 tt = expand_smacro(tt);
2284 size = parse_size(tt->text);
2287 "Invalid size type for `%%local' missing directive");
2289 free_tlist(origline);
2290 return DIRECTIVE_FOUND;
2294 /* Round up to even stack slots */
2295 size = (size+StackSize-1) & ~(StackSize-1);
2297 offset += size; /* Negative offset, increment before */
2299 /* Now define the macro for the argument */
2300 snprintf(directive, sizeof(directive), "%%define %s (%s-%d)",
2301 local, StackPointer, offset);
2302 do_directive(tokenize(directive));
2304 /* Now define the assign to setup the enter_c macro correctly */
2305 snprintf(directive, sizeof(directive),
2306 "%%assign %%$localsize %%$localsize+%d", size);
2307 do_directive(tokenize(directive));
2309 /* Move to the next argument in the list */
2310 tline = tline->next;
2311 if (tline && tline->type == TOK_WHITESPACE)
2312 tline = tline->next;
2313 } while (tline && tline->type == TOK_OTHER && tline->text[0] == ',');
2314 LocalOffset = offset;
2315 free_tlist(origline);
2316 return DIRECTIVE_FOUND;
2320 error(ERR_WARNING|ERR_PASS1,
2321 "trailing garbage after `%%clear' ignored");
2324 free_tlist(origline);
2325 return DIRECTIVE_FOUND;
2328 t = tline->next = expand_smacro(tline->next);
2330 if (!t || (t->type != TOK_STRING &&
2331 t->type != TOK_INTERNAL_STRING)) {
2332 error(ERR_NONFATAL, "`%%depend' expects a file name");
2333 free_tlist(origline);
2334 return DIRECTIVE_FOUND; /* but we did _something_ */
2337 error(ERR_WARNING|ERR_PASS1,
2338 "trailing garbage after `%%depend' ignored");
2340 if (t->type != TOK_INTERNAL_STRING)
2341 nasm_unquote(p, NULL);
2342 if (dephead && !in_list(*dephead, p)) {
2343 StrList *sl = nasm_malloc(strlen(p)+1+sizeof sl->next);
2347 deptail = &sl->next;
2349 free_tlist(origline);
2350 return DIRECTIVE_FOUND;
2353 t = tline->next = expand_smacro(tline->next);
2356 if (!t || (t->type != TOK_STRING &&
2357 t->type != TOK_INTERNAL_STRING)) {
2358 error(ERR_NONFATAL, "`%%include' expects a file name");
2359 free_tlist(origline);
2360 return DIRECTIVE_FOUND; /* but we did _something_ */
2363 error(ERR_WARNING|ERR_PASS1,
2364 "trailing garbage after `%%include' ignored");
2366 if (t->type != TOK_INTERNAL_STRING)
2367 nasm_unquote(p, NULL);
2368 inc = nasm_malloc(sizeof(Include));
2371 inc->fp = inc_fopen(p, dephead, &deptail, pass == 0);
2373 /* -MG given but file not found */
2376 inc->fname = src_set_fname(nasm_strdup(p));
2377 inc->lineno = src_set_linnum(0);
2379 inc->expansion = NULL;
2382 list->uplevel(LIST_INCLUDE);
2384 free_tlist(origline);
2385 return DIRECTIVE_FOUND;
2389 static macros_t *use_pkg;
2390 const char *pkg_macro;
2392 tline = tline->next;
2394 tline = expand_id(tline);
2396 if (!tline || (tline->type != TOK_STRING &&
2397 tline->type != TOK_INTERNAL_STRING &&
2398 tline->type != TOK_ID)) {
2399 error(ERR_NONFATAL, "`%%use' expects a package name");
2400 free_tlist(origline);
2401 return DIRECTIVE_FOUND; /* but we did _something_ */
2404 error(ERR_WARNING|ERR_PASS1,
2405 "trailing garbage after `%%use' ignored");
2406 if (tline->type == TOK_STRING)
2407 nasm_unquote(tline->text, NULL);
2408 use_pkg = nasm_stdmac_find_package(tline->text);
2410 error(ERR_NONFATAL, "unknown `%%use' package: %s", tline->text);
2411 /* The first string will be <%define>__USE_*__ */
2412 pkg_macro = (char *)use_pkg + 1;
2413 if (!smacro_defined(NULL, pkg_macro, 0, NULL, true)) {
2414 /* Not already included, go ahead and include it */
2415 stdmacpos = use_pkg;
2417 free_tlist(origline);
2418 return DIRECTIVE_FOUND;
2423 tline = tline->next;
2425 tline = expand_id(tline);
2427 if (!tok_type_(tline, TOK_ID)) {
2428 error(ERR_NONFATAL, "`%s' expects a context identifier",
2430 free_tlist(origline);
2431 return DIRECTIVE_FOUND; /* but we did _something_ */
2434 error(ERR_WARNING|ERR_PASS1,
2435 "trailing garbage after `%s' ignored",
2437 p = nasm_strdup(tline->text);
2439 p = NULL; /* Anonymous */
2443 ctx = nasm_malloc(sizeof(Context));
2445 hash_init(&ctx->localmac, HASH_SMALL);
2447 ctx->number = unique++;
2452 error(ERR_NONFATAL, "`%s': context stack is empty",
2454 } else if (i == PP_POP) {
2455 if (p && (!cstk->name || nasm_stricmp(p, cstk->name)))
2456 error(ERR_NONFATAL, "`%%pop' in wrong context: %s, "
2458 cstk->name ? cstk->name : "anonymous", p);
2463 nasm_free(cstk->name);
2469 free_tlist(origline);
2470 return DIRECTIVE_FOUND;
2472 severity = ERR_FATAL;
2475 severity = ERR_NONFATAL;
2478 severity = ERR_WARNING|ERR_WARN_USER;
2483 /* Only error out if this is the final pass */
2484 if (pass != 2 && i != PP_FATAL)
2485 return DIRECTIVE_FOUND;
2487 tline->next = expand_smacro(tline->next);
2488 tline = tline->next;
2490 t = tline ? tline->next : NULL;
2492 if (tok_type_(tline, TOK_STRING) && !t) {
2493 /* The line contains only a quoted string */
2495 nasm_unquote(p, NULL);
2496 error(severity, "%s", p);
2498 /* Not a quoted string, or more than a quoted string */
2499 p = detoken(tline, false);
2500 error(severity, "%s", p);
2503 free_tlist(origline);
2504 return DIRECTIVE_FOUND;
2508 if (istk->conds && !emitting(istk->conds->state))
2511 j = if_condition(tline->next, i);
2512 tline->next = NULL; /* it got freed */
2513 j = j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2515 cond = nasm_malloc(sizeof(Cond));
2516 cond->next = istk->conds;
2519 free_tlist(origline);
2520 return DIRECTIVE_FOUND;
2524 error(ERR_FATAL, "`%s': no matching `%%if'", pp_directives[i]);
2525 switch(istk->conds->state) {
2527 istk->conds->state = COND_DONE;
2534 case COND_ELSE_TRUE:
2535 case COND_ELSE_FALSE:
2536 error_precond(ERR_WARNING|ERR_PASS1,
2537 "`%%elif' after `%%else' ignored");
2538 istk->conds->state = COND_NEVER;
2543 * IMPORTANT: In the case of %if, we will already have
2544 * called expand_mmac_params(); however, if we're
2545 * processing an %elif we must have been in a
2546 * non-emitting mode, which would have inhibited
2547 * the normal invocation of expand_mmac_params().
2548 * Therefore, we have to do it explicitly here.
2550 j = if_condition(expand_mmac_params(tline->next), i);
2551 tline->next = NULL; /* it got freed */
2552 istk->conds->state =
2553 j < 0 ? COND_NEVER : j ? COND_IF_TRUE : COND_IF_FALSE;
2556 free_tlist(origline);
2557 return DIRECTIVE_FOUND;
2561 error_precond(ERR_WARNING|ERR_PASS1,
2562 "trailing garbage after `%%else' ignored");
2564 error(ERR_FATAL, "`%%else': no matching `%%if'");
2565 switch(istk->conds->state) {
2568 istk->conds->state = COND_ELSE_FALSE;
2575 istk->conds->state = COND_ELSE_TRUE;
2578 case COND_ELSE_TRUE:
2579 case COND_ELSE_FALSE:
2580 error_precond(ERR_WARNING|ERR_PASS1,
2581 "`%%else' after `%%else' ignored.");
2582 istk->conds->state = COND_NEVER;
2585 free_tlist(origline);
2586 return DIRECTIVE_FOUND;
2590 error_precond(ERR_WARNING|ERR_PASS1,
2591 "trailing garbage after `%%endif' ignored");
2593 error(ERR_FATAL, "`%%endif': no matching `%%if'");
2595 istk->conds = cond->next;
2597 free_tlist(origline);
2598 return DIRECTIVE_FOUND;
2606 "`%%%smacro': already defining a macro",
2607 (i == PP_IMACRO ? "i" :
2608 i == PP_RMACRO ? "r" :
2609 i == PP_RIMACRO ? "ri" : ""));
2610 return DIRECTIVE_FOUND;
2612 defining = nasm_malloc(sizeof(MMacro));
2613 defining->max_depth = (((i == PP_RMACRO) || (i == PP_RIMACRO))
2614 ? (DEADMAN_LIMIT) : 0);
2615 defining->casesense = ((i == PP_MACRO) || (i == PP_RMACRO));
2616 if (!parse_mmacro_spec(tline, defining, pp_directives[i])) {
2617 nasm_free(defining);
2619 return DIRECTIVE_FOUND;
2622 mmac = (MMacro *) hash_findix(&mmacros, defining->name);
2624 if (!strcmp(mmac->name, defining->name) &&
2625 (mmac->nparam_min <= defining->nparam_max
2627 && (defining->nparam_min <= mmac->nparam_max
2629 error(ERR_WARNING|ERR_PASS1,
2630 "redefining multi-line macro `%s'", defining->name);
2631 return DIRECTIVE_FOUND;
2635 free_tlist(origline);
2636 return DIRECTIVE_FOUND;
2640 if (! (defining && defining->name)) {
2641 error(ERR_NONFATAL, "`%s': not defining a macro", tline->text);
2642 return DIRECTIVE_FOUND;
2644 mmhead = (MMacro **) hash_findi_add(&mmacros, defining->name);
2645 defining->next = *mmhead;
2648 free_tlist(origline);
2649 return DIRECTIVE_FOUND;
2653 * We must search along istk->expansion until we hit a
2654 * macro-end marker for a macro with a name. Then we set
2655 * its `in_progress' flag to 0.
2657 for (l = istk->expansion; l; l = l->next)
2658 if (l->finishes && l->finishes->name)
2662 l->finishes->in_progress = 0;
2664 error(ERR_NONFATAL, "`%%exitmacro' not within `%%macro' block");
2666 free_tlist(origline);
2667 return DIRECTIVE_FOUND;
2675 spec.casesense = (i == PP_UNMACRO);
2676 if (!parse_mmacro_spec(tline, &spec, pp_directives[i])) {
2677 return DIRECTIVE_FOUND;
2679 mmac_p = (MMacro **) hash_findi(&mmacros, spec.name, NULL);
2680 while (mmac_p && *mmac_p) {
2682 if (mmac->casesense == spec.casesense &&
2683 !mstrcmp(mmac->name, spec.name, spec.casesense) &&
2684 mmac->nparam_min == spec.nparam_min &&
2685 mmac->nparam_max == spec.nparam_max &&
2686 mmac->plus == spec.plus) {
2687 *mmac_p = mmac->next;
2690 mmac_p = &mmac->next;
2693 free_tlist(origline);
2694 free_tlist(spec.dlist);
2695 return DIRECTIVE_FOUND;
2699 if (tline->next && tline->next->type == TOK_WHITESPACE)
2700 tline = tline->next;
2701 if (tline->next == NULL) {
2702 free_tlist(origline);
2703 error(ERR_NONFATAL, "`%%rotate' missing rotate count");
2704 return DIRECTIVE_FOUND;
2706 t = expand_smacro(tline->next);
2708 free_tlist(origline);
2711 tokval.t_type = TOKEN_INVALID;
2713 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2716 return DIRECTIVE_FOUND;
2718 error(ERR_WARNING|ERR_PASS1,
2719 "trailing garbage after expression ignored");
2720 if (!is_simple(evalresult)) {
2721 error(ERR_NONFATAL, "non-constant value given to `%%rotate'");
2722 return DIRECTIVE_FOUND;
2725 while (mmac && !mmac->name) /* avoid mistaking %reps for macros */
2726 mmac = mmac->next_active;
2728 error(ERR_NONFATAL, "`%%rotate' invoked outside a macro call");
2729 } else if (mmac->nparam == 0) {
2731 "`%%rotate' invoked within macro without parameters");
2733 int rotate = mmac->rotate + reloc_value(evalresult);
2735 rotate %= (int)mmac->nparam;
2737 rotate += mmac->nparam;
2739 mmac->rotate = rotate;
2741 return DIRECTIVE_FOUND;
2746 tline = tline->next;
2747 } while (tok_type_(tline, TOK_WHITESPACE));
2749 if (tok_type_(tline, TOK_ID) &&
2750 nasm_stricmp(tline->text, ".nolist") == 0) {
2753 tline = tline->next;
2754 } while (tok_type_(tline, TOK_WHITESPACE));
2758 t = expand_smacro(tline);
2760 tokval.t_type = TOKEN_INVALID;
2762 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
2764 free_tlist(origline);
2765 return DIRECTIVE_FOUND;
2768 error(ERR_WARNING|ERR_PASS1,
2769 "trailing garbage after expression ignored");
2770 if (!is_simple(evalresult)) {
2771 error(ERR_NONFATAL, "non-constant value given to `%%rep'");
2772 return DIRECTIVE_FOUND;
2774 count = reloc_value(evalresult) + 1;
2776 error(ERR_NONFATAL, "`%%rep' expects a repeat count");
2779 free_tlist(origline);
2781 tmp_defining = defining;
2782 defining = nasm_malloc(sizeof(MMacro));
2783 defining->prev = NULL;
2784 defining->name = NULL; /* flags this macro as a %rep block */
2785 defining->casesense = false;
2786 defining->plus = false;
2787 defining->nolist = nolist;
2788 defining->in_progress = count;
2789 defining->max_depth = 0;
2790 defining->nparam_min = defining->nparam_max = 0;
2791 defining->defaults = NULL;
2792 defining->dlist = NULL;
2793 defining->expansion = NULL;
2794 defining->next_active = istk->mstk;
2795 defining->rep_nest = tmp_defining;
2796 return DIRECTIVE_FOUND;
2799 if (!defining || defining->name) {
2800 error(ERR_NONFATAL, "`%%endrep': no matching `%%rep'");
2801 return DIRECTIVE_FOUND;
2805 * Now we have a "macro" defined - although it has no name
2806 * and we won't be entering it in the hash tables - we must
2807 * push a macro-end marker for it on to istk->expansion.
2808 * After that, it will take care of propagating itself (a
2809 * macro-end marker line for a macro which is really a %rep
2810 * block will cause the macro to be re-expanded, complete
2811 * with another macro-end marker to ensure the process
2812 * continues) until the whole expansion is forcibly removed
2813 * from istk->expansion by a %exitrep.
2815 l = nasm_malloc(sizeof(Line));
2816 l->next = istk->expansion;
2817 l->finishes = defining;
2819 istk->expansion = l;
2821 istk->mstk = defining;
2823 list->uplevel(defining->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
2824 tmp_defining = defining;
2825 defining = defining->rep_nest;
2826 free_tlist(origline);
2827 return DIRECTIVE_FOUND;
2831 * We must search along istk->expansion until we hit a
2832 * macro-end marker for a macro with no name. Then we set
2833 * its `in_progress' flag to 0.
2835 for (l = istk->expansion; l; l = l->next)
2836 if (l->finishes && !l->finishes->name)
2840 l->finishes->in_progress = 1;
2842 error(ERR_NONFATAL, "`%%exitrep' not within `%%rep' block");
2843 free_tlist(origline);
2844 return DIRECTIVE_FOUND;
2850 casesense = (i == PP_DEFINE || i == PP_XDEFINE);
2852 tline = tline->next;
2854 tline = expand_id(tline);
2855 if (!tline || (tline->type != TOK_ID &&
2856 (tline->type != TOK_PREPROC_ID ||
2857 tline->text[1] != '$'))) {
2858 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2860 free_tlist(origline);
2861 return DIRECTIVE_FOUND;
2864 ctx = get_ctx(tline->text, &mname, false);
2866 param_start = tline = tline->next;
2869 /* Expand the macro definition now for %xdefine and %ixdefine */
2870 if ((i == PP_XDEFINE) || (i == PP_IXDEFINE))
2871 tline = expand_smacro(tline);
2873 if (tok_is_(tline, "(")) {
2875 * This macro has parameters.
2878 tline = tline->next;
2882 error(ERR_NONFATAL, "parameter identifier expected");
2883 free_tlist(origline);
2884 return DIRECTIVE_FOUND;
2886 if (tline->type != TOK_ID) {
2888 "`%s': parameter identifier expected",
2890 free_tlist(origline);
2891 return DIRECTIVE_FOUND;
2893 tline->type = TOK_SMAC_PARAM + nparam++;
2894 tline = tline->next;
2896 if (tok_is_(tline, ",")) {
2897 tline = tline->next;
2899 if (!tok_is_(tline, ")")) {
2901 "`)' expected to terminate macro template");
2902 free_tlist(origline);
2903 return DIRECTIVE_FOUND;
2909 tline = tline->next;
2911 if (tok_type_(tline, TOK_WHITESPACE))
2912 last = tline, tline = tline->next;
2917 if (t->type == TOK_ID) {
2918 for (tt = param_start; tt; tt = tt->next)
2919 if (tt->type >= TOK_SMAC_PARAM &&
2920 !strcmp(tt->text, t->text))
2924 t->next = macro_start;
2929 * Good. We now have a macro name, a parameter count, and a
2930 * token list (in reverse order) for an expansion. We ought
2931 * to be OK just to create an SMacro, store it, and let
2932 * free_tlist have the rest of the line (which we have
2933 * carefully re-terminated after chopping off the expansion
2936 define_smacro(ctx, mname, casesense, nparam, macro_start);
2937 free_tlist(origline);
2938 return DIRECTIVE_FOUND;
2941 tline = tline->next;
2943 tline = expand_id(tline);
2944 if (!tline || (tline->type != TOK_ID &&
2945 (tline->type != TOK_PREPROC_ID ||
2946 tline->text[1] != '$'))) {
2947 error(ERR_NONFATAL, "`%%undef' expects a macro identifier");
2948 free_tlist(origline);
2949 return DIRECTIVE_FOUND;
2952 error(ERR_WARNING|ERR_PASS1,
2953 "trailing garbage after macro name ignored");
2956 /* Find the context that symbol belongs to */
2957 ctx = get_ctx(tline->text, &mname, false);
2958 undef_smacro(ctx, mname);
2959 free_tlist(origline);
2960 return DIRECTIVE_FOUND;
2964 casesense = (i == PP_DEFSTR);
2966 tline = tline->next;
2968 tline = expand_id(tline);
2969 if (!tline || (tline->type != TOK_ID &&
2970 (tline->type != TOK_PREPROC_ID ||
2971 tline->text[1] != '$'))) {
2972 error(ERR_NONFATAL, "`%s' expects a macro identifier",
2974 free_tlist(origline);
2975 return DIRECTIVE_FOUND;
2978 ctx = get_ctx(tline->text, &mname, false);
2980 tline = expand_smacro(tline->next);
2983 while (tok_type_(tline, TOK_WHITESPACE))
2984 tline = delete_Token(tline);
2986 p = detoken(tline, false);
2987 macro_start = nasm_malloc(sizeof(*macro_start));
2988 macro_start->next = NULL;
2989 macro_start->text = nasm_quote(p, strlen(p));
2990 macro_start->type = TOK_STRING;
2991 macro_start->a.mac = NULL;
2995 * We now have a macro name, an implicit parameter count of
2996 * zero, and a string token to use as an expansion. Create
2997 * and store an SMacro.
2999 define_smacro(ctx, mname, casesense, 0, macro_start);
3000 free_tlist(origline);
3001 return DIRECTIVE_FOUND;
3008 casesense = (i == PP_DEFTOK);
3010 tline = tline->next;
3012 tline = expand_id(tline);
3013 if (!tline || (tline->type != TOK_ID &&
3014 (tline->type != TOK_PREPROC_ID ||
3015 tline->text[1] != '$'))) {
3017 "`%s' expects a macro identifier as first parameter",
3019 free_tlist(origline);
3020 return DIRECTIVE_FOUND;
3022 ctx = get_ctx(tline->text, &mname, false);
3024 tline = expand_smacro(tline->next);
3028 while (tok_type_(t, TOK_WHITESPACE))
3030 /* t should now point to the string */
3031 if (t->type != TOK_STRING) {
3033 "`%s` requires string as second parameter",
3036 free_tlist(origline);
3037 return DIRECTIVE_FOUND;
3040 len = nasm_unquote(t->text, NULL);
3041 if (memchr(t->text, '\0', len))
3042 error(ERR_NONFATAL, "NUL character in `%s' directive",
3044 macro_start = tokenize(t->text);
3047 * We now have a macro name, an implicit parameter count of
3048 * zero, and a numeric token to use as an expansion. Create
3049 * and store an SMacro.
3051 define_smacro(ctx, mname, casesense, 0, macro_start);
3053 free_tlist(origline);
3054 return DIRECTIVE_FOUND;
3060 StrList *xsl = NULL;
3061 StrList **xst = &xsl;
3065 tline = tline->next;
3067 tline = expand_id(tline);
3068 if (!tline || (tline->type != TOK_ID &&
3069 (tline->type != TOK_PREPROC_ID ||
3070 tline->text[1] != '$'))) {
3072 "`%%pathsearch' expects a macro identifier as first parameter");
3073 free_tlist(origline);
3074 return DIRECTIVE_FOUND;
3076 ctx = get_ctx(tline->text, &mname, false);
3078 tline = expand_smacro(tline->next);
3082 while (tok_type_(t, TOK_WHITESPACE))
3085 if (!t || (t->type != TOK_STRING &&
3086 t->type != TOK_INTERNAL_STRING)) {
3087 error(ERR_NONFATAL, "`%%pathsearch' expects a file name");
3089 free_tlist(origline);
3090 return DIRECTIVE_FOUND; /* but we did _something_ */
3093 error(ERR_WARNING|ERR_PASS1,
3094 "trailing garbage after `%%pathsearch' ignored");
3096 if (t->type != TOK_INTERNAL_STRING)
3097 nasm_unquote(p, NULL);
3099 fp = inc_fopen(p, &xsl, &xst, true);
3102 fclose(fp); /* Don't actually care about the file */
3104 macro_start = nasm_malloc(sizeof(*macro_start));
3105 macro_start->next = NULL;
3106 macro_start->text = nasm_quote(p, strlen(p));
3107 macro_start->type = TOK_STRING;
3108 macro_start->a.mac = NULL;
3113 * We now have a macro name, an implicit parameter count of
3114 * zero, and a string token to use as an expansion. Create
3115 * and store an SMacro.
3117 define_smacro(ctx, mname, casesense, 0, macro_start);
3119 free_tlist(origline);
3120 return DIRECTIVE_FOUND;
3126 tline = tline->next;
3128 tline = expand_id(tline);
3129 if (!tline || (tline->type != TOK_ID &&
3130 (tline->type != TOK_PREPROC_ID ||
3131 tline->text[1] != '$'))) {
3133 "`%%strlen' expects a macro identifier as first parameter");
3134 free_tlist(origline);
3135 return DIRECTIVE_FOUND;
3137 ctx = get_ctx(tline->text, &mname, false);
3139 tline = expand_smacro(tline->next);
3143 while (tok_type_(t, TOK_WHITESPACE))
3145 /* t should now point to the string */
3146 if (t->type != TOK_STRING) {
3148 "`%%strlen` requires string as second parameter");
3150 free_tlist(origline);
3151 return DIRECTIVE_FOUND;
3154 macro_start = nasm_malloc(sizeof(*macro_start));
3155 macro_start->next = NULL;
3156 make_tok_num(macro_start, nasm_unquote(t->text, NULL));
3157 macro_start->a.mac = NULL;
3160 * We now have a macro name, an implicit parameter count of
3161 * zero, and a numeric token to use as an expansion. Create
3162 * and store an SMacro.
3164 define_smacro(ctx, mname, casesense, 0, macro_start);
3166 free_tlist(origline);
3167 return DIRECTIVE_FOUND;
3172 tline = tline->next;
3174 tline = expand_id(tline);
3175 if (!tline || (tline->type != TOK_ID &&
3176 (tline->type != TOK_PREPROC_ID ||
3177 tline->text[1] != '$'))) {
3179 "`%%strcat' expects a macro identifier as first parameter");
3180 free_tlist(origline);
3181 return DIRECTIVE_FOUND;
3183 ctx = get_ctx(tline->text, &mname, false);
3185 tline = expand_smacro(tline->next);
3189 for (t = tline; t; t = t->next) {
3191 case TOK_WHITESPACE:
3194 len += t->a.len = nasm_unquote(t->text, NULL);
3197 if (!strcmp(t->text, ",")) /* permit comma separators */
3199 /* else fall through */
3202 "non-string passed to `%%strcat' (%d)", t->type);
3204 free_tlist(origline);
3205 return DIRECTIVE_FOUND;
3209 p = pp = nasm_malloc(len);
3211 for (t = tline; t; t = t->next) {
3212 if (t->type == TOK_STRING) {
3213 memcpy(p, t->text, t->a.len);
3219 * We now have a macro name, an implicit parameter count of
3220 * zero, and a numeric token to use as an expansion. Create
3221 * and store an SMacro.
3223 macro_start = new_Token(NULL, TOK_STRING, NULL, 0);
3224 macro_start->text = nasm_quote(pp, len);
3226 define_smacro(ctx, mname, casesense, 0, macro_start);
3228 free_tlist(origline);
3229 return DIRECTIVE_FOUND;
3238 tline = tline->next;
3240 tline = expand_id(tline);
3241 if (!tline || (tline->type != TOK_ID &&
3242 (tline->type != TOK_PREPROC_ID ||
3243 tline->text[1] != '$'))) {
3245 "`%%substr' expects a macro identifier as first parameter");
3246 free_tlist(origline);
3247 return DIRECTIVE_FOUND;
3249 ctx = get_ctx(tline->text, &mname, false);
3251 tline = expand_smacro(tline->next);
3255 while (tok_type_(t, TOK_WHITESPACE))
3258 /* t should now point to the string */
3259 if (t->type != TOK_STRING) {
3261 "`%%substr` requires string as second parameter");
3263 free_tlist(origline);
3264 return DIRECTIVE_FOUND;
3269 tokval.t_type = TOKEN_INVALID;
3270 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3274 free_tlist(origline);
3275 return DIRECTIVE_FOUND;
3276 } else if (!is_simple(evalresult)) {
3277 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3279 free_tlist(origline);
3280 return DIRECTIVE_FOUND;
3282 a1 = evalresult->value-1;
3284 while (tok_type_(tt, TOK_WHITESPACE))
3287 a2 = 1; /* Backwards compatibility: one character */
3289 tokval.t_type = TOKEN_INVALID;
3290 evalresult = evaluate(ppscan, tptr, &tokval, NULL,
3294 free_tlist(origline);
3295 return DIRECTIVE_FOUND;
3296 } else if (!is_simple(evalresult)) {
3297 error(ERR_NONFATAL, "non-constant value given to `%%substr`");
3299 free_tlist(origline);
3300 return DIRECTIVE_FOUND;
3302 a2 = evalresult->value;
3305 len = nasm_unquote(t->text, NULL);
3308 if (a1+a2 > (int64_t)len)
3311 macro_start = nasm_malloc(sizeof(*macro_start));
3312 macro_start->next = NULL;
3313 macro_start->text = nasm_quote((a1 < 0) ? "" : t->text+a1, a2);
3314 macro_start->type = TOK_STRING;
3315 macro_start->a.mac = NULL;
3318 * We now have a macro name, an implicit parameter count of
3319 * zero, and a numeric token to use as an expansion. Create
3320 * and store an SMacro.
3322 define_smacro(ctx, mname, casesense, 0, macro_start);
3324 free_tlist(origline);
3325 return DIRECTIVE_FOUND;
3330 casesense = (i == PP_ASSIGN);
3332 tline = tline->next;
3334 tline = expand_id(tline);
3335 if (!tline || (tline->type != TOK_ID &&
3336 (tline->type != TOK_PREPROC_ID ||
3337 tline->text[1] != '$'))) {
3339 "`%%%sassign' expects a macro identifier",
3340 (i == PP_IASSIGN ? "i" : ""));
3341 free_tlist(origline);
3342 return DIRECTIVE_FOUND;
3344 ctx = get_ctx(tline->text, &mname, false);
3346 tline = expand_smacro(tline->next);
3351 tokval.t_type = TOKEN_INVALID;
3353 evaluate(ppscan, tptr, &tokval, NULL, pass, error, NULL);
3356 free_tlist(origline);
3357 return DIRECTIVE_FOUND;
3361 error(ERR_WARNING|ERR_PASS1,
3362 "trailing garbage after expression ignored");
3364 if (!is_simple(evalresult)) {
3366 "non-constant value given to `%%%sassign'",
3367 (i == PP_IASSIGN ? "i" : ""));
3368 free_tlist(origline);
3369 return DIRECTIVE_FOUND;
3372 macro_start = nasm_malloc(sizeof(*macro_start));
3373 macro_start->next = NULL;
3374 make_tok_num(macro_start, reloc_value(evalresult));
3375 macro_start->a.mac = NULL;
3378 * We now have a macro name, an implicit parameter count of
3379 * zero, and a numeric token to use as an expansion. Create
3380 * and store an SMacro.
3382 define_smacro(ctx, mname, casesense, 0, macro_start);
3383 free_tlist(origline);
3384 return DIRECTIVE_FOUND;
3388 * Syntax is `%line nnn[+mmm] [filename]'
3390 tline = tline->next;
3392 if (!tok_type_(tline, TOK_NUMBER)) {
3393 error(ERR_NONFATAL, "`%%line' expects line number");
3394 free_tlist(origline);
3395 return DIRECTIVE_FOUND;
3397 k = readnum(tline->text, &err);
3399 tline = tline->next;
3400 if (tok_is_(tline, "+")) {
3401 tline = tline->next;
3402 if (!tok_type_(tline, TOK_NUMBER)) {
3403 error(ERR_NONFATAL, "`%%line' expects line increment");
3404 free_tlist(origline);
3405 return DIRECTIVE_FOUND;
3407 m = readnum(tline->text, &err);
3408 tline = tline->next;
3414 nasm_free(src_set_fname(detoken(tline, false)));
3416 free_tlist(origline);
3417 return DIRECTIVE_FOUND;
3421 "preprocessor directive `%s' not yet implemented",
3423 return DIRECTIVE_FOUND;
3428 * Ensure that a macro parameter contains a condition code and
3429 * nothing else. Return the condition code index if so, or -1
3432 static int find_cc(Token * t)
3438 return -1; /* Probably a %+ without a space */
3441 if (t->type != TOK_ID)
3445 if (tt && (tt->type != TOK_OTHER || strcmp(tt->text, ",")))
3449 j = elements(conditions);
3452 m = nasm_stricmp(t->text, conditions[k]);
3467 static bool paste_tokens(Token **head, bool handle_paste_tokens)
3469 Token **tail, *t, *tt;
3471 bool did_paste = false;
3474 /* Now handle token pasting... */
3477 while ((t = *tail) && (tt = t->next)) {
3479 case TOK_WHITESPACE:
3480 if (tt->type == TOK_WHITESPACE) {
3481 /* Zap adjacent whitespace tokens */
3482 t->next = delete_Token(tt);
3484 /* Do not advance paste_head here */
3489 case TOK_PREPROC_ID:
3496 while (tt && (tt->type == TOK_ID || tt->type == TOK_PREPROC_ID ||
3497 tt->type == TOK_NUMBER || tt->type == TOK_FLOAT ||
3498 tt->type == TOK_OTHER)) {
3499 len += strlen(tt->text);
3503 /* Now tt points to the first token after the potential
3505 if (tt != t->next) {
3506 /* We have at least two tokens... */
3507 len += strlen(t->text);
3508 p = tmp = nasm_malloc(len+1);
3512 p = strchr(p, '\0');
3513 t = delete_Token(t);
3516 t = *tail = tokenize(tmp);
3523 t->next = tt; /* Attach the remaining token chain */
3531 case TOK_PASTE: /* %+ */
3532 if (handle_paste_tokens) {
3533 /* Zap %+ and whitespace tokens to the right */
3534 while (t && (t->type == TOK_WHITESPACE ||
3535 t->type == TOK_PASTE))
3536 t = *tail = delete_Token(t);
3537 if (!paste_head || !t)
3538 break; /* Nothing to paste with */
3542 while (tok_type_(tt, TOK_WHITESPACE))
3543 tt = t->next = delete_Token(tt);
3546 tmp = nasm_strcat(t->text, tt->text);
3548 tt = delete_Token(tt);
3549 t = *tail = tokenize(tmp);
3555 t->next = tt; /* Attach the remaining token chain */
3562 /* else fall through */
3564 tail = paste_head = &t->next;
3571 * Expand MMacro-local things: parameter references (%0, %n, %+n,
3572 * %-n) and MMacro-local identifiers (%%foo) as well as
3573 * macro indirection (%[...]).
3575 static Token *expand_mmac_params(Token * tline)
3577 Token *t, *tt, **tail, *thead;
3578 bool changed = false;
3584 if (tline->type == TOK_PREPROC_ID &&
3585 (((tline->text[1] == '+' || tline->text[1] == '-')
3586 && tline->text[2]) || tline->text[1] == '%'
3587 || (tline->text[1] >= '0' && tline->text[1] <= '9'))) {
3589 int type = 0, cc; /* type = 0 to placate optimisers */
3596 tline = tline->next;
3599 while (mac && !mac->name) /* avoid mistaking %reps for macros */
3600 mac = mac->next_active;
3602 error(ERR_NONFATAL, "`%s': not in a macro call", t->text);
3604 switch (t->text[1]) {
3606 * We have to make a substitution of one of the
3607 * forms %1, %-1, %+1, %%foo, %0.
3611 snprintf(tmpbuf, sizeof(tmpbuf), "%d", mac->nparam);
3612 text = nasm_strdup(tmpbuf);
3616 snprintf(tmpbuf, sizeof(tmpbuf), "..@%"PRIu64".",
3618 text = nasm_strcat(tmpbuf, t->text + 2);
3621 n = atoi(t->text + 2) - 1;
3622 if (n >= mac->nparam)
3625 if (mac->nparam > 1)
3626 n = (n + mac->rotate) % mac->nparam;
3627 tt = mac->params[n];
3632 "macro parameter %d is not a condition code",
3637 if (inverse_ccs[cc] == -1) {
3639 "condition code `%s' is not invertible",
3643 text = nasm_strdup(conditions[inverse_ccs[cc]]);
3647 n = atoi(t->text + 2) - 1;
3648 if (n >= mac->nparam)
3651 if (mac->nparam > 1)
3652 n = (n + mac->rotate) % mac->nparam;
3653 tt = mac->params[n];
3658 "macro parameter %d is not a condition code",
3663 text = nasm_strdup(conditions[cc]);
3667 n = atoi(t->text + 1) - 1;
3668 if (n >= mac->nparam)
3671 if (mac->nparam > 1)
3672 n = (n + mac->rotate) % mac->nparam;
3673 tt = mac->params[n];
3676 for (i = 0; i < mac->paramlen[n]; i++) {
3677 *tail = new_Token(NULL, tt->type, tt->text, 0);
3678 tail = &(*tail)->next;
3682 text = NULL; /* we've done it here */
3697 } else if (tline->type == TOK_INDIRECT) {
3699 tline = tline->next;
3700 tt = tokenize(t->text);
3701 tt = expand_mmac_params(tt);
3702 tt = expand_smacro(tt);
3705 tt->a.mac = NULL; /* Necessary? */
3713 tline = tline->next;
3721 paste_tokens(&thead, false);
3727 * Expand all single-line macro calls made in the given line.
3728 * Return the expanded version of the line. The original is deemed
3729 * to be destroyed in the process. (In reality we'll just move
3730 * Tokens from input to output a lot of the time, rather than
3731 * actually bothering to destroy and replicate.)
3734 static Token *expand_smacro(Token * tline)
3736 Token *t, *tt, *mstart, **tail, *thead;
3737 struct hash_table *smtbl;
3738 SMacro *head = NULL, *m;
3741 unsigned int nparam, sparam;
3743 Token *org_tline = tline;
3746 int deadman = DEADMAN_LIMIT;
3750 * Trick: we should avoid changing the start token pointer since it can
3751 * be contained in "next" field of other token. Because of this
3752 * we allocate a copy of first token and work with it; at the end of
3753 * routine we copy it back
3757 new_Token(org_tline->next, org_tline->type, org_tline->text,
3759 tline->a.mac = org_tline->a.mac;
3760 nasm_free(org_tline->text);
3761 org_tline->text = NULL;
3764 expanded = true; /* Always expand %+ at least once */
3770 while (tline) { /* main token loop */
3772 error(ERR_NONFATAL, "interminable macro recursion");
3776 if ((mname = tline->text)) {
3777 /* if this token is a local macro, look in local context */
3778 if (tline->type == TOK_ID || tline->type == TOK_PREPROC_ID)
3779 ctx = get_ctx(mname, &mname, true);
3782 smtbl = ctx ? &ctx->localmac : &smacros;
3783 head = (SMacro *) hash_findix(smtbl, mname);
3786 * We've hit an identifier. As in is_mmacro below, we first
3787 * check whether the identifier is a single-line macro at
3788 * all, then think about checking for parameters if
3791 for (m = head; m; m = m->next)
3792 if (!mstrcmp(m->name, mname, m->casesense))
3798 if (m->nparam == 0) {
3800 * Simple case: the macro is parameterless. Discard the
3801 * one token that the macro call took, and push the
3802 * expansion back on the to-do stack.
3804 if (!m->expansion) {
3805 if (!strcmp("__FILE__", m->name)) {
3808 src_get(&num, &file);
3809 tline->text = nasm_quote(file, strlen(file));
3810 tline->type = TOK_STRING;
3814 if (!strcmp("__LINE__", m->name)) {
3815 nasm_free(tline->text);
3816 make_tok_num(tline, src_get_linnum());
3819 if (!strcmp("__BITS__", m->name)) {
3820 nasm_free(tline->text);
3821 make_tok_num(tline, globalbits);
3824 tline = delete_Token(tline);
3829 * Complicated case: at least one macro with this name
3830 * exists and takes parameters. We must find the
3831 * parameters in the call, count them, find the SMacro
3832 * that corresponds to that form of the macro call, and
3833 * substitute for the parameters when we expand. What a
3836 /*tline = tline->next;
3837 skip_white_(tline); */
3840 while (tok_type_(t, TOK_SMAC_END)) {
3841 t->a.mac->in_progress = false;
3843 t = tline->next = delete_Token(t);
3846 } while (tok_type_(tline, TOK_WHITESPACE));
3847 if (!tok_is_(tline, "(")) {
3849 * This macro wasn't called with parameters: ignore
3850 * the call. (Behaviour borrowed from gnu cpp.)
3859 sparam = PARAM_DELTA;
3860 params = nasm_malloc(sparam * sizeof(Token *));
3861 params[0] = tline->next;
3862 paramsize = nasm_malloc(sparam * sizeof(int));
3864 while (true) { /* parameter loop */
3866 * For some unusual expansions
3867 * which concatenates function call
3870 while (tok_type_(t, TOK_SMAC_END)) {
3871 t->a.mac->in_progress = false;
3873 t = tline->next = delete_Token(t);
3879 "macro call expects terminating `)'");
3882 if (tline->type == TOK_WHITESPACE
3884 if (paramsize[nparam])
3887 params[nparam] = tline->next;
3888 continue; /* parameter loop */
3890 if (tline->type == TOK_OTHER
3891 && tline->text[1] == 0) {
3892 char ch = tline->text[0];
3893 if (ch == ',' && !paren && brackets <= 0) {
3894 if (++nparam >= sparam) {
3895 sparam += PARAM_DELTA;
3896 params = nasm_realloc(params,
3901 nasm_realloc(paramsize,
3905 params[nparam] = tline->next;
3906 paramsize[nparam] = 0;
3908 continue; /* parameter loop */
3911 (brackets > 0 || (brackets == 0 &&
3912 !paramsize[nparam])))
3914 if (!(brackets++)) {
3915 params[nparam] = tline->next;
3916 continue; /* parameter loop */
3919 if (ch == '}' && brackets > 0)
3920 if (--brackets == 0) {
3922 continue; /* parameter loop */
3924 if (ch == '(' && !brackets)
3926 if (ch == ')' && brackets <= 0)
3932 error(ERR_NONFATAL, "braces do not "
3933 "enclose all of macro parameter");
3935 paramsize[nparam] += white + 1;
3937 } /* parameter loop */
3939 while (m && (m->nparam != nparam ||
3940 mstrcmp(m->name, mname,
3944 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
3945 "macro `%s' exists, "
3946 "but not taking %d parameters",
3947 mstart->text, nparam);
3950 if (m && m->in_progress)
3952 if (!m) { /* in progess or didn't find '(' or wrong nparam */
3954 * Design question: should we handle !tline, which
3955 * indicates missing ')' here, or expand those
3956 * macros anyway, which requires the (t) test a few
3960 nasm_free(paramsize);
3964 * Expand the macro: we are placed on the last token of the
3965 * call, so that we can easily split the call from the
3966 * following tokens. We also start by pushing an SMAC_END
3967 * token for the cycle removal.
3974 tt = new_Token(tline, TOK_SMAC_END, NULL, 0);
3976 m->in_progress = true;
3978 for (t = m->expansion; t; t = t->next) {
3979 if (t->type >= TOK_SMAC_PARAM) {
3980 Token *pcopy = tline, **ptail = &pcopy;
3984 ttt = params[t->type - TOK_SMAC_PARAM];
3985 for (i = paramsize[t->type - TOK_SMAC_PARAM];
3988 new_Token(tline, ttt->type, ttt->text,
3994 } else if (t->type == TOK_PREPROC_Q) {
3995 tt = new_Token(tline, TOK_ID, mname, 0);
3997 } else if (t->type == TOK_PREPROC_QQ) {
3998 tt = new_Token(tline, TOK_ID, m->name, 0);
4001 tt = new_Token(tline, t->type, t->text, 0);
4007 * Having done that, get rid of the macro call, and clean
4008 * up the parameters.
4011 nasm_free(paramsize);
4014 continue; /* main token loop */
4019 if (tline->type == TOK_SMAC_END) {
4020 tline->a.mac->in_progress = false;
4021 tline = delete_Token(tline);
4024 tline = tline->next;
4032 * Now scan the entire line and look for successive TOK_IDs that resulted
4033 * after expansion (they can't be produced by tokenize()). The successive
4034 * TOK_IDs should be concatenated.
4035 * Also we look for %+ tokens and concatenate the tokens before and after
4036 * them (without white spaces in between).
4038 if (expanded && paste_tokens(&thead, true)) {
4040 * If we concatenated something, *and* we had previously expanded
4041 * an actual macro, scan the lines again for macros...
4050 *org_tline = *thead;
4051 /* since we just gave text to org_line, don't free it */
4053 delete_Token(thead);
4055 /* the expression expanded to empty line;
4056 we can't return NULL for some reasons
4057 we just set the line to a single WHITESPACE token. */
4058 memset(org_tline, 0, sizeof(*org_tline));
4059 org_tline->text = NULL;
4060 org_tline->type = TOK_WHITESPACE;
4069 * Similar to expand_smacro but used exclusively with macro identifiers
4070 * right before they are fetched in. The reason is that there can be
4071 * identifiers consisting of several subparts. We consider that if there
4072 * are more than one element forming the name, user wants a expansion,
4073 * otherwise it will be left as-is. Example:
4077 * the identifier %$abc will be left as-is so that the handler for %define
4078 * will suck it and define the corresponding value. Other case:
4080 * %define _%$abc cde
4082 * In this case user wants name to be expanded *before* %define starts
4083 * working, so we'll expand %$abc into something (if it has a value;
4084 * otherwise it will be left as-is) then concatenate all successive
4087 static Token *expand_id(Token * tline)
4089 Token *cur, *oldnext = NULL;
4091 if (!tline || !tline->next)
4096 (cur->next->type == TOK_ID ||
4097 cur->next->type == TOK_PREPROC_ID
4098 || cur->next->type == TOK_NUMBER))
4101 /* If identifier consists of just one token, don't expand */
4106 oldnext = cur->next; /* Detach the tail past identifier */
4107 cur->next = NULL; /* so that expand_smacro stops here */
4110 tline = expand_smacro(tline);
4113 /* expand_smacro possibly changhed tline; re-scan for EOL */
4115 while (cur && cur->next)
4118 cur->next = oldnext;
4125 * Determine whether the given line constitutes a multi-line macro
4126 * call, and return the MMacro structure called if so. Doesn't have
4127 * to check for an initial label - that's taken care of in
4128 * expand_mmacro - but must check numbers of parameters. Guaranteed
4129 * to be called with tline->type == TOK_ID, so the putative macro
4130 * name is easy to find.
4132 static MMacro *is_mmacro(Token * tline, Token *** params_array)
4138 head = (MMacro *) hash_findix(&mmacros, tline->text);
4141 * Efficiency: first we see if any macro exists with the given
4142 * name. If not, we can return NULL immediately. _Then_ we
4143 * count the parameters, and then we look further along the
4144 * list if necessary to find the proper MMacro.
4146 for (m = head; m; m = m->next)
4147 if (!mstrcmp(m->name, tline->text, m->casesense))
4153 * OK, we have a potential macro. Count and demarcate the
4156 count_mmac_params(tline->next, &nparam, ¶ms);
4159 * So we know how many parameters we've got. Find the MMacro
4160 * structure that handles this number.
4163 if (m->nparam_min <= nparam
4164 && (m->plus || nparam <= m->nparam_max)) {
4166 * This one is right. Just check if cycle removal
4167 * prohibits us using it before we actually celebrate...
4169 if (m->in_progress > m->max_depth) {
4170 if (m->max_depth > 0) {
4172 "reached maximum recursion depth of %i",
4179 * It's right, and we can use it. Add its default
4180 * parameters to the end of our list if necessary.
4182 if (m->defaults && nparam < m->nparam_min + m->ndefs) {
4184 nasm_realloc(params,
4185 ((m->nparam_min + m->ndefs +
4186 1) * sizeof(*params)));
4187 while (nparam < m->nparam_min + m->ndefs) {
4188 params[nparam] = m->defaults[nparam - m->nparam_min];
4193 * If we've gone over the maximum parameter count (and
4194 * we're in Plus mode), ignore parameters beyond
4197 if (m->plus && nparam > m->nparam_max)
4198 nparam = m->nparam_max;
4200 * Then terminate the parameter list, and leave.
4202 if (!params) { /* need this special case */
4203 params = nasm_malloc(sizeof(*params));
4206 params[nparam] = NULL;
4207 *params_array = params;
4211 * This one wasn't right: look for the next one with the
4214 for (m = m->next; m; m = m->next)
4215 if (!mstrcmp(m->name, tline->text, m->casesense))
4220 * After all that, we didn't find one with the right number of
4221 * parameters. Issue a warning, and fail to expand the macro.
4223 error(ERR_WARNING|ERR_PASS1|ERR_WARN_MNP,
4224 "macro `%s' exists, but not taking %d parameters",
4225 tline->text, nparam);
4232 * Save MMacro invocation specific fields in
4233 * preparation for a recursive macro expansion
4235 static void push_mmacro(MMacro *m)
4237 MMacroInvocation *i;
4239 i = nasm_malloc(sizeof(MMacroInvocation));
4241 i->params = m->params;
4242 i->iline = m->iline;
4243 i->nparam = m->nparam;
4244 i->rotate = m->rotate;
4245 i->paramlen = m->paramlen;
4246 i->unique = m->unique;
4252 * Restore MMacro invocation specific fields that were
4253 * saved during a previous recursive macro expansion
4255 static void pop_mmacro(MMacro *m)
4257 MMacroInvocation *i;
4259 if(m->prev != NULL){
4262 m->params = i->params;
4263 m->iline = i->iline;
4264 m->nparam = i->nparam;
4265 m->rotate = i->rotate;
4266 m->paramlen = i->paramlen;
4267 m->unique = i->unique;
4274 * Expand the multi-line macro call made by the given line, if
4275 * there is one to be expanded. If there is, push the expansion on
4276 * istk->expansion and return 1. Otherwise return 0.
4278 static int expand_mmacro(Token * tline)
4280 Token *startline = tline;
4281 Token *label = NULL;
4282 int dont_prepend = 0;
4283 Token **params, *t, *mtok, *tt;
4286 int i, nparam, *paramlen;
4291 /* if (!tok_type_(t, TOK_ID)) Lino 02/25/02 */
4292 if (!tok_type_(t, TOK_ID) && !tok_type_(t, TOK_PREPROC_ID))
4295 m = is_mmacro(t, ¶ms);
4301 * We have an id which isn't a macro call. We'll assume
4302 * it might be a label; we'll also check to see if a
4303 * colon follows it. Then, if there's another id after
4304 * that lot, we'll check it again for macro-hood.
4308 if (tok_type_(t, TOK_WHITESPACE))
4309 last = t, t = t->next;
4310 if (tok_is_(t, ":")) {
4312 last = t, t = t->next;
4313 if (tok_type_(t, TOK_WHITESPACE))
4314 last = t, t = t->next;
4316 if (!tok_type_(t, TOK_ID) || (m = is_mmacro(t, ¶ms)) == NULL)
4324 * Fix up the parameters: this involves stripping leading and
4325 * trailing whitespace, then stripping braces if they are
4328 for (nparam = 0; params[nparam]; nparam++) ;
4329 paramlen = nparam ? nasm_malloc(nparam * sizeof(*paramlen)) : NULL;
4331 for (i = 0; params[i]; i++) {
4333 int comma = (!m->plus || i < nparam - 1);
4337 if (tok_is_(t, "{"))
4338 t = t->next, brace = true, comma = false;
4342 if (comma && t->type == TOK_OTHER && !strcmp(t->text, ","))
4343 break; /* ... because we have hit a comma */
4344 if (comma && t->type == TOK_WHITESPACE
4345 && tok_is_(t->next, ","))
4346 break; /* ... or a space then a comma */
4347 if (brace && t->type == TOK_OTHER && !strcmp(t->text, "}"))
4348 break; /* ... or a brace */
4355 * OK, we have a MMacro structure together with a set of
4356 * parameters. We must now go through the expansion and push
4357 * copies of each Line on to istk->expansion. Substitution of
4358 * parameter tokens and macro-local tokens doesn't get done
4359 * until the single-line macro substitution process; this is
4360 * because delaying them allows us to change the semantics
4361 * later through %rotate.
4363 * First, push an end marker on to istk->expansion, mark this
4364 * macro as in progress, and set up its invocation-specific
4367 ll = nasm_malloc(sizeof(Line));
4368 ll->next = istk->expansion;
4371 istk->expansion = ll;
4374 * Save the previous MMacro expansion in the case of
4377 if (m->max_depth && m->in_progress)
4385 m->paramlen = paramlen;
4386 m->unique = unique++;
4389 m->next_active = istk->mstk;
4392 for (l = m->expansion; l; l = l->next) {
4395 ll = nasm_malloc(sizeof(Line));
4396 ll->finishes = NULL;
4397 ll->next = istk->expansion;
4398 istk->expansion = ll;
4401 for (t = l->first; t; t = t->next) {
4405 tt = *tail = new_Token(NULL, TOK_ID, mname, 0);
4407 case TOK_PREPROC_QQ:
4408 tt = *tail = new_Token(NULL, TOK_ID, m->name, 0);
4410 case TOK_PREPROC_ID:
4411 if (t->text[1] == '0' && t->text[2] == '0') {
4419 tt = *tail = new_Token(NULL, x->type, x->text, 0);
4428 * If we had a label, push it on as the first line of
4429 * the macro expansion.
4432 if (dont_prepend < 0)
4433 free_tlist(startline);
4435 ll = nasm_malloc(sizeof(Line));
4436 ll->finishes = NULL;
4437 ll->next = istk->expansion;
4438 istk->expansion = ll;
4439 ll->first = startline;
4440 if (!dont_prepend) {
4442 label = label->next;
4443 label->next = tt = new_Token(NULL, TOK_OTHER, ":", 0);
4448 list->uplevel(m->nolist ? LIST_MACRO_NOLIST : LIST_MACRO);
4453 /* The function that actually does the error reporting */
4454 static void verror(int severity, const char *fmt, va_list arg)
4458 vsnprintf(buff, sizeof(buff), fmt, arg);
4460 if (istk && istk->mstk && istk->mstk->name)
4461 _error(severity, "(%s:%d) %s", istk->mstk->name,
4462 istk->mstk->lineno, buff);
4464 _error(severity, "%s", buff);
4468 * Since preprocessor always operate only on the line that didn't
4469 * arrived yet, we should always use ERR_OFFBY1.
4471 static void error(int severity, const char *fmt, ...)
4475 /* If we're in a dead branch of IF or something like it, ignore the error */
4476 if (istk && istk->conds && !emitting(istk->conds->state))
4480 verror(severity, fmt, arg);
4485 * Because %else etc are evaluated in the state context
4486 * of the previous branch, errors might get lost with error():
4487 * %if 0 ... %else trailing garbage ... %endif
4488 * So %else etc should report errors with this function.
4490 static void error_precond(int severity, const char *fmt, ...)
4494 /* Only ignore the error if it's really in a dead branch */
4495 if (istk && istk->conds && istk->conds->state == COND_NEVER)
4499 verror(severity, fmt, arg);
4504 pp_reset(char *file, int apass, efunc errfunc, evalfunc eval,
4505 ListGen * listgen, StrList **deplist)
4511 istk = nasm_malloc(sizeof(Include));
4514 istk->expansion = NULL;
4516 istk->fp = fopen(file, "r");
4518 src_set_fname(nasm_strdup(file));
4522 error(ERR_FATAL|ERR_NOFILE, "unable to open input file `%s'",
4525 nested_mac_count = 0;
4526 nested_rep_count = 0;
4529 if (tasm_compatible_mode) {
4530 stdmacpos = nasm_stdmac;
4532 stdmacpos = nasm_stdmac_after_tasm;
4534 any_extrastdmac = extrastdmac && *extrastdmac;
4540 * 0 for dependencies, 1 for preparatory passes, 2 for final pass.
4541 * The caller, however, will also pass in 3 for preprocess-only so
4542 * we can set __PASS__ accordingly.
4544 pass = apass > 2 ? 2 : apass;
4546 dephead = deptail = deplist;
4548 StrList *sl = nasm_malloc(strlen(file)+1+sizeof sl->next);
4550 strcpy(sl->str, file);
4552 deptail = &sl->next;
4556 * Define the __PASS__ macro. This is defined here unlike
4557 * all the other builtins, because it is special -- it varies between
4560 t = nasm_malloc(sizeof(*t));
4562 make_tok_num(t, apass);
4564 define_smacro(NULL, "__PASS__", true, 0, t);
4567 static char *pp_getline(void)
4574 * Fetch a tokenized line, either from the macro-expansion
4575 * buffer or from the input file.
4578 while (istk->expansion && istk->expansion->finishes) {
4579 Line *l = istk->expansion;
4580 if (!l->finishes->name && l->finishes->in_progress > 1) {
4584 * This is a macro-end marker for a macro with no
4585 * name, which means it's not really a macro at all
4586 * but a %rep block, and the `in_progress' field is
4587 * more than 1, meaning that we still need to
4588 * repeat. (1 means the natural last repetition; 0
4589 * means termination by %exitrep.) We have
4590 * therefore expanded up to the %endrep, and must
4591 * push the whole block on to the expansion buffer
4592 * again. We don't bother to remove the macro-end
4593 * marker: we'd only have to generate another one
4596 l->finishes->in_progress--;
4597 for (l = l->finishes->expansion; l; l = l->next) {
4598 Token *t, *tt, **tail;
4600 ll = nasm_malloc(sizeof(Line));
4601 ll->next = istk->expansion;
4602 ll->finishes = NULL;
4606 for (t = l->first; t; t = t->next) {
4607 if (t->text || t->type == TOK_WHITESPACE) {
4609 new_Token(NULL, t->type, t->text, 0);
4614 istk->expansion = ll;
4618 * Check whether a `%rep' was started and not ended
4619 * within this macro expansion. This can happen and
4620 * should be detected. It's a fatal error because
4621 * I'm too confused to work out how to recover
4627 "defining with name in expansion");
4628 else if (istk->mstk->name)
4630 "`%%rep' without `%%endrep' within"
4631 " expansion of macro `%s'",
4636 * FIXME: investigate the relationship at this point between
4637 * istk->mstk and l->finishes
4640 MMacro *m = istk->mstk;
4641 istk->mstk = m->next_active;
4644 * This was a real macro call, not a %rep, and
4645 * therefore the parameter information needs to
4648 if (m->prev != NULL) {
4650 l->finishes->in_progress --;
4652 nasm_free(m->params);
4653 free_tlist(m->iline);
4654 nasm_free(m->paramlen);
4655 l->finishes->in_progress = 0;
4660 istk->expansion = l->next;
4662 list->downlevel(LIST_MACRO);
4665 while (1) { /* until we get a line we can use */
4667 if (istk->expansion) { /* from a macro expansion */
4669 Line *l = istk->expansion;
4671 istk->mstk->lineno++;
4673 istk->expansion = l->next;
4675 p = detoken(tline, false);
4676 list->line(LIST_MACRO, p);
4681 if (line) { /* from the current input file */
4682 line = prepreproc(line);
4683 tline = tokenize(line);
4688 * The current file has ended; work down the istk
4695 "expected `%%endif' before end of file");
4696 /* only set line and file name if there's a next node */
4698 src_set_linnum(i->lineno);
4699 nasm_free(src_set_fname(i->fname));
4702 list->downlevel(LIST_INCLUDE);
4706 if (istk->expansion && istk->expansion->finishes)
4712 * We must expand MMacro parameters and MMacro-local labels
4713 * _before_ we plunge into directive processing, to cope
4714 * with things like `%define something %1' such as STRUC
4715 * uses. Unless we're _defining_ a MMacro, in which case
4716 * those tokens should be left alone to go into the
4717 * definition; and unless we're in a non-emitting
4718 * condition, in which case we don't want to meddle with
4721 if (!defining && !(istk->conds && !emitting(istk->conds->state))
4722 && !(istk->mstk && !istk->mstk->in_progress)) {
4723 tline = expand_mmac_params(tline);
4727 * Check the line to see if it's a preprocessor directive.
4729 if (do_directive(tline) == DIRECTIVE_FOUND) {
4731 } else if (defining) {
4733 * We're defining a multi-line macro. We emit nothing
4735 * shove the tokenized line on to the macro definition.
4737 Line *l = nasm_malloc(sizeof(Line));
4738 l->next = defining->expansion;
4741 defining->expansion = l;
4743 } else if (istk->conds && !emitting(istk->conds->state)) {
4745 * We're in a non-emitting branch of a condition block.
4746 * Emit nothing at all, not even a blank line: when we
4747 * emerge from the condition we'll give a line-number
4748 * directive so we keep our place correctly.
4752 } else if (istk->mstk && !istk->mstk->in_progress) {
4754 * We're in a %rep block which has been terminated, so
4755 * we're walking through to the %endrep without
4756 * emitting anything. Emit nothing at all, not even a
4757 * blank line: when we emerge from the %rep block we'll
4758 * give a line-number directive so we keep our place
4764 tline = expand_smacro(tline);
4765 if (!expand_mmacro(tline)) {
4767 * De-tokenize the line again, and emit it.
4769 line = detoken(tline, true);
4773 continue; /* expand_mmacro calls free_tlist */
4781 static void pp_cleanup(int pass)
4784 if(defining->name) {
4786 "end of file while still defining macro `%s'",
4789 error(ERR_NONFATAL, "end of file while still in %%rep");
4792 free_mmacro(defining);
4801 nasm_free(i->fname);
4806 nasm_free(src_set_fname(NULL));
4811 while ((i = ipath)) {
4820 void pp_include_path(char *path)
4824 i = nasm_malloc(sizeof(IncPath));
4825 i->path = path ? nasm_strdup(path) : NULL;
4828 if (ipath != NULL) {
4830 while (j->next != NULL)
4838 void pp_pre_include(char *fname)
4840 Token *inc, *space, *name;
4843 name = new_Token(NULL, TOK_INTERNAL_STRING, fname, 0);
4844 space = new_Token(name, TOK_WHITESPACE, NULL, 0);
4845 inc = new_Token(space, TOK_PREPROC_ID, "%include", 0);
4847 l = nasm_malloc(sizeof(Line));
4854 void pp_pre_define(char *definition)
4860 equals = strchr(definition, '=');
4861 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4862 def = new_Token(space, TOK_PREPROC_ID, "%define", 0);
4865 space->next = tokenize(definition);
4869 l = nasm_malloc(sizeof(Line));
4876 void pp_pre_undefine(char *definition)
4881 space = new_Token(NULL, TOK_WHITESPACE, NULL, 0);
4882 def = new_Token(space, TOK_PREPROC_ID, "%undef", 0);
4883 space->next = tokenize(definition);
4885 l = nasm_malloc(sizeof(Line));
4893 * Added by Keith Kanios:
4895 * This function is used to assist with "runtime" preprocessor
4896 * directives. (e.g. pp_runtime("%define __BITS__ 64");)
4898 * ERRORS ARE IGNORED HERE, SO MAKE COMPLETELY SURE THAT YOU
4899 * PASS A VALID STRING TO THIS FUNCTION!!!!!
4902 void pp_runtime(char *definition)
4906 def = tokenize(definition);
4907 if(do_directive(def) == NO_DIRECTIVE_FOUND)
4912 void pp_extra_stdmac(macros_t *macros)
4914 extrastdmac = macros;
4917 static void make_tok_num(Token * tok, int64_t val)
4920 snprintf(numbuf, sizeof(numbuf), "%"PRId64"", val);
4921 tok->text = nasm_strdup(numbuf);
4922 tok->type = TOK_NUMBER;