1 /* Part of CPP library. (Macro and #define handling.)
2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 2006 Free Software Foundation, Inc.
5 Written by Per Bothner, 1994.
6 Based on CCCP program by Paul Rubin, June 1986
7 Adapted to ANSI C, Richard Stallman, Jan 1987
9 This program is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 In other words, you are welcome to use, share and improve this program.
24 You are forbidden to forbid anyone else to use, share and improve
25 what you give them. Help stamp out software-hoarding! */
32 typedef struct macro_arg macro_arg;
35 const cpp_token **first; /* First token in unexpanded argument. */
36 const cpp_token **expanded; /* Macro-expanded argument. */
37 const cpp_token *stringified; /* Stringified argument. */
38 unsigned int count; /* # of tokens in argument. */
39 unsigned int expanded_count; /* # of tokens in expanded argument. */
42 /* Macro expansion. */
44 static int enter_macro_context (cpp_reader *, cpp_hashnode *);
45 static int builtin_macro (cpp_reader *, cpp_hashnode *);
46 static void push_ptoken_context (cpp_reader *, cpp_hashnode *, _cpp_buff *,
47 const cpp_token **, unsigned int);
48 static _cpp_buff *collect_args (cpp_reader *, const cpp_hashnode *);
49 static cpp_context *next_context (cpp_reader *);
50 static const cpp_token *padding_token (cpp_reader *, const cpp_token *);
51 static void expand_arg (cpp_reader *, macro_arg *);
52 static const cpp_token *new_string_token (cpp_reader *, uchar *, unsigned int);
53 static const cpp_token *stringify_arg (cpp_reader *, macro_arg *);
54 static void paste_all_tokens (cpp_reader *, const cpp_token *);
55 static bool paste_tokens (cpp_reader *, const cpp_token **, const cpp_token *);
56 static void replace_args (cpp_reader *, cpp_hashnode *, cpp_macro *,
58 static _cpp_buff *funlike_invocation_p (cpp_reader *, cpp_hashnode *);
59 static bool create_iso_definition (cpp_reader *, cpp_macro *);
61 /* #define directive parsing and handling. */
63 static cpp_token *alloc_expansion_token (cpp_reader *, cpp_macro *);
64 static cpp_token *lex_expansion_token (cpp_reader *, cpp_macro *);
65 static bool warn_of_redefinition (cpp_reader *, const cpp_hashnode *,
67 static bool parse_params (cpp_reader *, cpp_macro *);
68 static void check_trad_stringification (cpp_reader *, const cpp_macro *,
71 /* Emits a warning if NODE is a macro defined in the main file that
74 _cpp_warn_if_unused_macro (cpp_reader *pfile, cpp_hashnode *node,
75 void *v ATTRIBUTE_UNUSED)
77 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
79 cpp_macro *macro = node->value.macro;
82 && MAIN_FILE_P (linemap_lookup (pfile->line_table, macro->line)))
83 cpp_error_with_line (pfile, CPP_DL_WARNING, macro->line, 0,
84 "macro \"%s\" is not used", NODE_NAME (node));
90 /* Allocates and returns a CPP_STRING token, containing TEXT of length
91 LEN, after null-terminating it. TEXT must be in permanent storage. */
92 static const cpp_token *
93 new_string_token (cpp_reader *pfile, unsigned char *text, unsigned int len)
95 cpp_token *token = _cpp_temp_token (pfile);
98 token->type = CPP_STRING;
99 token->val.str.len = len;
100 token->val.str.text = text;
105 static const char * const monthnames[] =
107 "Jan", "Feb", "Mar", "Apr", "May", "Jun",
108 "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
111 /* Helper function for builtin_macro. Returns the text generated by
114 _cpp_builtin_macro_text (cpp_reader *pfile, cpp_hashnode *node)
116 const struct line_map *map;
117 const uchar *result = NULL;
118 unsigned int number = 1;
120 switch (node->value.builtin)
123 cpp_error (pfile, CPP_DL_ICE, "invalid built-in macro \"%s\"",
129 cpp_buffer *pbuffer = cpp_get_buffer (pfile);
130 if (pbuffer->timestamp == NULL)
132 /* Initialize timestamp value of the assotiated file. */
133 struct _cpp_file *file = cpp_get_file (pbuffer);
136 /* Generate __TIMESTAMP__ string, that represents
137 the date and time of the last modification
138 of the current source file. The string constant
139 looks like "Sun Sep 16 01:03:52 1973". */
140 struct tm *tb = NULL;
141 struct stat *st = _cpp_get_file_stat (file);
143 tb = localtime (&st->st_mtime);
146 char *str = asctime (tb);
147 size_t len = strlen (str);
148 unsigned char *buf = _cpp_unaligned_alloc (pfile, len + 2);
150 strcpy ((char *) buf + 1, str);
152 pbuffer->timestamp = buf;
156 cpp_errno (pfile, CPP_DL_WARNING,
157 "could not determine file timestamp");
158 pbuffer->timestamp = U"\"??? ??? ?? ??:??:?? ????\"";
162 result = pbuffer->timestamp;
171 map = linemap_lookup (pfile->line_table, pfile->line_table->highest_line);
173 if (node->value.builtin == BT_BASE_FILE)
174 while (! MAIN_FILE_P (map))
175 map = INCLUDED_FROM (pfile->line_table, map);
179 buf = _cpp_unaligned_alloc (pfile, len * 2 + 3);
182 buf = cpp_quote_string (buf + 1, (const unsigned char *) name, len);
188 case BT_INCLUDE_LEVEL:
189 /* The line map depth counts the primary source as level 1, but
190 historically __INCLUDE_DEPTH__ has called the primary source
192 number = pfile->line_table->depth - 1;
196 map = &pfile->line_table->maps[pfile->line_table->used-1];
197 /* If __LINE__ is embedded in a macro, it must expand to the
198 line of the macro's invocation, not its definition.
199 Otherwise things like assert() will not work properly. */
200 if (CPP_OPTION (pfile, traditional))
201 number = pfile->line_table->highest_line;
203 number = pfile->cur_token[-1].src_loc;
204 number = SOURCE_LINE (map, number);
207 /* __STDC__ has the value 1 under normal circumstances.
208 However, if (a) we are in a system header, (b) the option
209 stdc_0_in_system_headers is true (set by target config), and
210 (c) we are not in strictly conforming mode, then it has the
211 value 0. (b) and (c) are already checked in cpp_init_builtins. */
213 if (cpp_in_system_header (pfile))
221 if (pfile->date == NULL)
223 /* Allocate __DATE__ and __TIME__ strings from permanent
224 storage. We only do this once, and don't generate them
225 at init time, because time() and localtime() are very
226 slow on some systems. */
228 struct tm *tb = NULL;
230 /* (time_t) -1 is a legitimate value for "number of seconds
231 since the Epoch", so we have to do a little dance to
232 distinguish that from a genuine error. */
235 if (tt != (time_t)-1 || errno == 0)
236 tb = localtime (&tt);
240 pfile->date = _cpp_unaligned_alloc (pfile,
241 sizeof ("\"Oct 11 1347\""));
242 sprintf ((char *) pfile->date, "\"%s %2d %4d\"",
243 monthnames[tb->tm_mon], tb->tm_mday,
246 pfile->time = _cpp_unaligned_alloc (pfile,
247 sizeof ("\"12:34:56\""));
248 sprintf ((char *) pfile->time, "\"%02d:%02d:%02d\"",
249 tb->tm_hour, tb->tm_min, tb->tm_sec);
253 cpp_errno (pfile, CPP_DL_WARNING,
254 "could not determine date and time");
256 pfile->date = U"\"??? ?? ????\"";
257 pfile->time = U"\"??:??:??\"";
261 if (node->value.builtin == BT_DATE)
262 result = pfile->date;
264 result = pfile->time;
268 if (CPP_OPTION (pfile, directives_only) && pfile->state.in_directive)
269 cpp_error (pfile, CPP_DL_ERROR,
270 "__COUNTER__ expanded inside directive with -fdirectives-only");
271 number = pfile->counter++;
277 /* 21 bytes holds all NUL-terminated unsigned 64-bit numbers. */
278 result = _cpp_unaligned_alloc (pfile, 21);
279 sprintf ((char *) result, "%u", number);
285 /* Convert builtin macros like __FILE__ to a token and push it on the
286 context stack. Also handles _Pragma, for which a new token may not
287 be created. Returns 1 if it generates a new token context, 0 to
288 return the token to the caller. */
290 builtin_macro (cpp_reader *pfile, cpp_hashnode *node)
296 if (node->value.builtin == BT_PRAGMA)
298 /* Don't interpret _Pragma within directives. The standard is
299 not clear on this, but to me this makes most sense. */
300 if (pfile->state.in_directive)
303 _cpp_do__Pragma (pfile);
307 buf = _cpp_builtin_macro_text (pfile, node);
309 nbuf = (char *) alloca (len + 1);
310 memcpy (nbuf, buf, len);
313 cpp_push_buffer (pfile, (uchar *) nbuf, len, /* from_stage3 */ true);
314 _cpp_clean_line (pfile);
316 /* Set pfile->cur_token as required by _cpp_lex_direct. */
317 pfile->cur_token = _cpp_temp_token (pfile);
318 _cpp_push_token_context (pfile, NULL, _cpp_lex_direct (pfile), 1);
319 if (pfile->buffer->cur != pfile->buffer->rlimit)
320 cpp_error (pfile, CPP_DL_ICE, "invalid built-in macro \"%s\"",
322 _cpp_pop_buffer (pfile);
327 /* Copies SRC, of length LEN, to DEST, adding backslashes before all
328 backslashes and double quotes. DEST must be of sufficient size.
329 Returns a pointer to the end of the string. */
331 cpp_quote_string (uchar *dest, const uchar *src, unsigned int len)
337 if (c == '\\' || c == '"')
349 /* Convert a token sequence ARG to a single string token according to
350 the rules of the ISO C #-operator. */
351 static const cpp_token *
352 stringify_arg (cpp_reader *pfile, macro_arg *arg)
355 unsigned int i, escape_it, backslash_count = 0;
356 const cpp_token *source = NULL;
359 if (BUFF_ROOM (pfile->u_buff) < 3)
360 _cpp_extend_buff (pfile, &pfile->u_buff, 3);
361 dest = BUFF_FRONT (pfile->u_buff);
364 /* Loop, reading in the argument's tokens. */
365 for (i = 0; i < arg->count; i++)
367 const cpp_token *token = arg->first[i];
369 if (token->type == CPP_PADDING)
372 source = token->val.source;
376 escape_it = (token->type == CPP_STRING || token->type == CPP_WSTRING
377 || token->type == CPP_CHAR || token->type == CPP_WCHAR);
379 /* Room for each char being written in octal, initial space and
380 final quote and NUL. */
381 len = cpp_token_len (token);
386 if ((size_t) (BUFF_LIMIT (pfile->u_buff) - dest) < len)
388 size_t len_so_far = dest - BUFF_FRONT (pfile->u_buff);
389 _cpp_extend_buff (pfile, &pfile->u_buff, len);
390 dest = BUFF_FRONT (pfile->u_buff) + len_so_far;
393 /* Leading white space? */
394 if (dest - 1 != BUFF_FRONT (pfile->u_buff))
398 if (source->flags & PREV_WHITE)
405 _cpp_buff *buff = _cpp_get_buff (pfile, len);
406 unsigned char *buf = BUFF_FRONT (buff);
407 len = cpp_spell_token (pfile, token, buf, true) - buf;
408 dest = cpp_quote_string (dest, buf, len);
409 _cpp_release_buff (pfile, buff);
412 dest = cpp_spell_token (pfile, token, dest, true);
414 if (token->type == CPP_OTHER && token->val.str.text[0] == '\\')
420 /* Ignore the final \ of invalid string literals. */
421 if (backslash_count & 1)
423 cpp_error (pfile, CPP_DL_WARNING,
424 "invalid string literal, ignoring final '\\'");
428 /* Commit the memory, including NUL, and return the token. */
430 len = dest - BUFF_FRONT (pfile->u_buff);
431 BUFF_FRONT (pfile->u_buff) = dest + 1;
432 return new_string_token (pfile, dest - len, len);
435 /* Try to paste two tokens. On success, return nonzero. In any
436 case, PLHS is updated to point to the pasted token, which is
437 guaranteed to not have the PASTE_LEFT flag set. */
439 paste_tokens (cpp_reader *pfile, const cpp_token **plhs, const cpp_token *rhs)
441 unsigned char *buf, *end, *lhsend;
445 len = cpp_token_len (*plhs) + cpp_token_len (rhs) + 1;
446 buf = (unsigned char *) alloca (len);
447 end = lhsend = cpp_spell_token (pfile, *plhs, buf, false);
449 /* Avoid comment headers, since they are still processed in stage 3.
450 It is simpler to insert a space here, rather than modifying the
451 lexer to ignore comments in some circumstances. Simply returning
452 false doesn't work, since we want to clear the PASTE_LEFT flag. */
453 if ((*plhs)->type == CPP_DIV && rhs->type != CPP_EQ)
455 end = cpp_spell_token (pfile, rhs, end, false);
458 cpp_push_buffer (pfile, buf, end - buf, /* from_stage3 */ true);
459 _cpp_clean_line (pfile);
461 /* Set pfile->cur_token as required by _cpp_lex_direct. */
462 pfile->cur_token = _cpp_temp_token (pfile);
463 lhs = _cpp_lex_direct (pfile);
464 if (pfile->buffer->cur != pfile->buffer->rlimit)
466 source_location saved_loc = lhs->src_loc;
468 _cpp_pop_buffer (pfile);
469 _cpp_backup_tokens (pfile, 1);
472 /* We have to remove the PASTE_LEFT flag from the old lhs, but
473 we want to keep the new location. */
476 lhs->src_loc = saved_loc;
477 lhs->flags &= ~PASTE_LEFT;
479 /* Mandatory error for all apart from assembler. */
480 if (CPP_OPTION (pfile, lang) != CLK_ASM)
481 cpp_error (pfile, CPP_DL_ERROR,
482 "pasting \"%s\" and \"%s\" does not give a valid preprocessing token",
483 buf, cpp_token_as_text (pfile, rhs));
488 _cpp_pop_buffer (pfile);
492 /* Handles an arbitrarily long sequence of ## operators, with initial
493 operand LHS. This implementation is left-associative,
494 non-recursive, and finishes a paste before handling succeeding
495 ones. If a paste fails, we back up to the RHS of the failing ##
496 operator before pushing the context containing the result of prior
497 successful pastes, with the effect that the RHS appears in the
498 output stream after the pasted LHS normally. */
500 paste_all_tokens (cpp_reader *pfile, const cpp_token *lhs)
502 const cpp_token *rhs;
503 cpp_context *context = pfile->context;
507 /* Take the token directly from the current context. We can do
508 this, because we are in the replacement list of either an
509 object-like macro, or a function-like macro with arguments
510 inserted. In either case, the constraints to #define
511 guarantee we have at least one more token. */
512 if (context->direct_p)
513 rhs = FIRST (context).token++;
515 rhs = *FIRST (context).ptoken++;
517 if (rhs->type == CPP_PADDING)
520 if (!paste_tokens (pfile, &lhs, rhs))
523 while (rhs->flags & PASTE_LEFT);
525 /* Put the resulting token in its own context. */
526 _cpp_push_token_context (pfile, NULL, lhs, 1);
529 /* Returns TRUE if the number of arguments ARGC supplied in an
530 invocation of the MACRO referenced by NODE is valid. An empty
531 invocation to a macro with no parameters should pass ARGC as zero.
533 Note that MACRO cannot necessarily be deduced from NODE, in case
534 NODE was redefined whilst collecting arguments. */
536 _cpp_arguments_ok (cpp_reader *pfile, cpp_macro *macro, const cpp_hashnode *node, unsigned int argc)
538 if (argc == macro->paramc)
541 if (argc < macro->paramc)
543 /* As an extension, a rest argument is allowed to not appear in
544 the invocation at all.
545 e.g. #define debug(format, args...) something
548 This is exactly the same as if there had been an empty rest
549 argument - debug("string", ). */
551 if (argc + 1 == macro->paramc && macro->variadic)
553 if (CPP_PEDANTIC (pfile) && ! macro->syshdr)
554 cpp_error (pfile, CPP_DL_PEDWARN,
555 "ISO C99 requires rest arguments to be used");
559 cpp_error (pfile, CPP_DL_ERROR,
560 "macro \"%s\" requires %u arguments, but only %u given",
561 NODE_NAME (node), macro->paramc, argc);
564 cpp_error (pfile, CPP_DL_ERROR,
565 "macro \"%s\" passed %u arguments, but takes just %u",
566 NODE_NAME (node), argc, macro->paramc);
571 /* Reads and returns the arguments to a function-like macro
572 invocation. Assumes the opening parenthesis has been processed.
573 If there is an error, emits an appropriate diagnostic and returns
574 NULL. Each argument is terminated by a CPP_EOF token, for the
575 future benefit of expand_arg(). */
577 collect_args (cpp_reader *pfile, const cpp_hashnode *node)
579 _cpp_buff *buff, *base_buff;
581 macro_arg *args, *arg;
582 const cpp_token *token;
585 macro = node->value.macro;
587 argc = macro->paramc;
590 buff = _cpp_get_buff (pfile, argc * (50 * sizeof (cpp_token *)
591 + sizeof (macro_arg)));
593 args = (macro_arg *) buff->base;
594 memset (args, 0, argc * sizeof (macro_arg));
595 buff->cur = (unsigned char *) &args[argc];
596 arg = args, argc = 0;
598 /* Collect the tokens making up each argument. We don't yet know
599 how many arguments have been supplied, whether too many or too
600 few. Hence the slightly bizarre usage of "argc" and "arg". */
603 unsigned int paren_depth = 0;
604 unsigned int ntokens = 0;
607 arg->first = (const cpp_token **) buff->cur;
611 /* Require space for 2 new tokens (including a CPP_EOF). */
612 if ((unsigned char *) &arg->first[ntokens + 2] > buff->limit)
614 buff = _cpp_append_extend_buff (pfile, buff,
615 1000 * sizeof (cpp_token *));
616 arg->first = (const cpp_token **) buff->cur;
619 token = cpp_get_token (pfile);
621 if (token->type == CPP_PADDING)
623 /* Drop leading padding. */
627 else if (token->type == CPP_OPEN_PAREN)
629 else if (token->type == CPP_CLOSE_PAREN)
631 if (paren_depth-- == 0)
634 else if (token->type == CPP_COMMA)
636 /* A comma does not terminate an argument within
637 parentheses or as part of a variable argument. */
639 && ! (macro->variadic && argc == macro->paramc))
642 else if (token->type == CPP_EOF
643 || (token->type == CPP_HASH && token->flags & BOL))
646 arg->first[ntokens++] = token;
649 /* Drop trailing padding. */
650 while (ntokens > 0 && arg->first[ntokens - 1]->type == CPP_PADDING)
653 arg->count = ntokens;
654 arg->first[ntokens] = &pfile->eof;
656 /* Terminate the argument. Excess arguments loop back and
657 overwrite the final legitimate argument, before failing. */
658 if (argc <= macro->paramc)
660 buff->cur = (unsigned char *) &arg->first[ntokens + 1];
661 if (argc != macro->paramc)
665 while (token->type != CPP_CLOSE_PAREN && token->type != CPP_EOF);
667 if (token->type == CPP_EOF)
669 /* We still need the CPP_EOF to end directives, and to end
670 pre-expansion of a macro argument. Step back is not
671 unconditional, since we don't want to return a CPP_EOF to our
672 callers at the end of an -include-d file. */
673 if (pfile->context->prev || pfile->state.in_directive)
674 _cpp_backup_tokens (pfile, 1);
675 cpp_error (pfile, CPP_DL_ERROR,
676 "unterminated argument list invoking macro \"%s\"",
681 /* A single empty argument is counted as no argument. */
682 if (argc == 1 && macro->paramc == 0 && args[0].count == 0)
684 if (_cpp_arguments_ok (pfile, macro, node, argc))
686 /* GCC has special semantics for , ## b where b is a varargs
687 parameter: we remove the comma if b was omitted entirely.
688 If b was merely an empty argument, the comma is retained.
689 If the macro takes just one (varargs) parameter, then we
690 retain the comma only if we are standards conforming.
692 If FIRST is NULL replace_args () swallows the comma. */
693 if (macro->variadic && (argc < macro->paramc
694 || (argc == 1 && args[0].count == 0
695 && !CPP_OPTION (pfile, std))))
696 args[macro->paramc - 1].first = NULL;
701 /* An error occurred. */
702 _cpp_release_buff (pfile, base_buff);
706 /* Search for an opening parenthesis to the macro of NODE, in such a
707 way that, if none is found, we don't lose the information in any
708 intervening padding tokens. If we find the parenthesis, collect
709 the arguments and return the buffer containing them. */
711 funlike_invocation_p (cpp_reader *pfile, cpp_hashnode *node)
713 const cpp_token *token, *padding = NULL;
717 token = cpp_get_token (pfile);
718 if (token->type != CPP_PADDING)
721 || (!(padding->flags & PREV_WHITE) && token->val.source == NULL))
725 if (token->type == CPP_OPEN_PAREN)
727 pfile->state.parsing_args = 2;
728 return collect_args (pfile, node);
731 /* CPP_EOF can be the end of macro arguments, or the end of the
732 file. We mustn't back up over the latter. Ugh. */
733 if (token->type != CPP_EOF || token == &pfile->eof)
735 /* Back up. We may have skipped padding, in which case backing
736 up more than one token when expanding macros is in general
737 too difficult. We re-insert it in its own context. */
738 _cpp_backup_tokens (pfile, 1);
740 _cpp_push_token_context (pfile, NULL, padding, 1);
746 /* Push the context of a macro with hash entry NODE onto the context
747 stack. If we can successfully expand the macro, we push a context
748 containing its yet-to-be-rescanned replacement list and return one.
749 Otherwise, we don't push a context and return zero. */
751 enter_macro_context (cpp_reader *pfile, cpp_hashnode *node)
753 /* The presence of a macro invalidates a file's controlling macro. */
754 pfile->mi_valid = false;
756 pfile->state.angled_headers = false;
758 /* Handle standard macros. */
759 if (! (node->flags & NODE_BUILTIN))
761 cpp_macro *macro = node->value.macro;
767 pfile->state.prevent_expansion++;
768 pfile->keep_tokens++;
769 pfile->state.parsing_args = 1;
770 buff = funlike_invocation_p (pfile, node);
771 pfile->state.parsing_args = 0;
772 pfile->keep_tokens--;
773 pfile->state.prevent_expansion--;
777 if (CPP_WTRADITIONAL (pfile) && ! node->value.macro->syshdr)
778 cpp_error (pfile, CPP_DL_WARNING,
779 "function-like macro \"%s\" must be used with arguments in traditional C",
785 if (macro->paramc > 0)
786 replace_args (pfile, node, macro, (macro_arg *) buff->base);
787 _cpp_release_buff (pfile, buff);
790 /* Disable the macro within its expansion. */
791 node->flags |= NODE_DISABLED;
795 if (macro->paramc == 0)
796 _cpp_push_token_context (pfile, node, macro->exp.tokens, macro->count);
801 /* Handle built-in macros and the _Pragma operator. */
802 return builtin_macro (pfile, node);
805 /* Replace the parameters in a function-like macro of NODE with the
806 actual ARGS, and place the result in a newly pushed token context.
807 Expand each argument before replacing, unless it is operated upon
808 by the # or ## operators. */
810 replace_args (cpp_reader *pfile, cpp_hashnode *node, cpp_macro *macro, macro_arg *args)
812 unsigned int i, total;
813 const cpp_token *src, *limit;
814 const cpp_token **dest, **first;
818 /* First, fully macro-expand arguments, calculating the number of
819 tokens in the final expansion as we go. The ordering of the if
820 statements below is subtle; we must handle stringification before
822 total = macro->count;
823 limit = macro->exp.tokens + macro->count;
825 for (src = macro->exp.tokens; src < limit; src++)
826 if (src->type == CPP_MACRO_ARG)
828 /* Leading and trailing padding tokens. */
831 /* We have an argument. If it is not being stringified or
832 pasted it is macro-replaced before insertion. */
833 arg = &args[src->val.arg_no - 1];
835 if (src->flags & STRINGIFY_ARG)
837 if (!arg->stringified)
838 arg->stringified = stringify_arg (pfile, arg);
840 else if ((src->flags & PASTE_LEFT)
841 || (src > macro->exp.tokens && (src[-1].flags & PASTE_LEFT)))
842 total += arg->count - 1;
846 expand_arg (pfile, arg);
847 total += arg->expanded_count - 1;
851 /* Now allocate space for the expansion, copy the tokens and replace
853 buff = _cpp_get_buff (pfile, total * sizeof (cpp_token *));
854 first = (const cpp_token **) buff->base;
857 for (src = macro->exp.tokens; src < limit; src++)
860 const cpp_token **from, **paste_flag;
862 if (src->type != CPP_MACRO_ARG)
869 arg = &args[src->val.arg_no - 1];
870 if (src->flags & STRINGIFY_ARG)
871 count = 1, from = &arg->stringified;
872 else if (src->flags & PASTE_LEFT)
873 count = arg->count, from = arg->first;
874 else if (src != macro->exp.tokens && (src[-1].flags & PASTE_LEFT))
876 count = arg->count, from = arg->first;
879 if (dest[-1]->type == CPP_COMMA
881 && src->val.arg_no == macro->paramc)
883 /* Swallow a pasted comma if from == NULL, otherwise
884 drop the paste flag. */
888 paste_flag = dest - 1;
890 /* Remove the paste flag if the RHS is a placemarker. */
892 paste_flag = dest - 1;
896 count = arg->expanded_count, from = arg->expanded;
898 /* Padding on the left of an argument (unless RHS of ##). */
899 if ((!pfile->state.in_directive || pfile->state.directive_wants_padding)
900 && src != macro->exp.tokens && !(src[-1].flags & PASTE_LEFT))
901 *dest++ = padding_token (pfile, src);
905 memcpy (dest, from, count * sizeof (cpp_token *));
908 /* With a non-empty argument on the LHS of ##, the last
909 token should be flagged PASTE_LEFT. */
910 if (src->flags & PASTE_LEFT)
911 paste_flag = dest - 1;
914 /* Avoid paste on RHS (even case count == 0). */
915 if (!pfile->state.in_directive && !(src->flags & PASTE_LEFT))
916 *dest++ = &pfile->avoid_paste;
918 /* Add a new paste flag, or remove an unwanted one. */
921 cpp_token *token = _cpp_temp_token (pfile);
922 token->type = (*paste_flag)->type;
923 token->val = (*paste_flag)->val;
924 if (src->flags & PASTE_LEFT)
925 token->flags = (*paste_flag)->flags | PASTE_LEFT;
927 token->flags = (*paste_flag)->flags & ~PASTE_LEFT;
932 /* Free the expanded arguments. */
933 for (i = 0; i < macro->paramc; i++)
934 if (args[i].expanded)
935 free (args[i].expanded);
937 push_ptoken_context (pfile, node, buff, first, dest - first);
940 /* Return a special padding token, with padding inherited from SOURCE. */
941 static const cpp_token *
942 padding_token (cpp_reader *pfile, const cpp_token *source)
944 cpp_token *result = _cpp_temp_token (pfile);
946 result->type = CPP_PADDING;
948 /* Data in GCed data structures cannot be made const so far, so we
950 result->val.source = (cpp_token *) source;
955 /* Get a new uninitialized context. Create a new one if we cannot
956 re-use an old one. */
958 next_context (cpp_reader *pfile)
960 cpp_context *result = pfile->context->next;
964 result = XNEW (cpp_context);
965 result->prev = pfile->context;
967 pfile->context->next = result;
970 pfile->context = result;
974 /* Push a list of pointers to tokens. */
976 push_ptoken_context (cpp_reader *pfile, cpp_hashnode *macro, _cpp_buff *buff,
977 const cpp_token **first, unsigned int count)
979 cpp_context *context = next_context (pfile);
981 context->direct_p = false;
982 context->macro = macro;
983 context->buff = buff;
984 FIRST (context).ptoken = first;
985 LAST (context).ptoken = first + count;
988 /* Push a list of tokens. */
990 _cpp_push_token_context (cpp_reader *pfile, cpp_hashnode *macro,
991 const cpp_token *first, unsigned int count)
993 cpp_context *context = next_context (pfile);
995 context->direct_p = true;
996 context->macro = macro;
997 context->buff = NULL;
998 FIRST (context).token = first;
999 LAST (context).token = first + count;
1002 /* Push a traditional macro's replacement text. */
1004 _cpp_push_text_context (cpp_reader *pfile, cpp_hashnode *macro,
1005 const uchar *start, size_t len)
1007 cpp_context *context = next_context (pfile);
1009 context->direct_p = true;
1010 context->macro = macro;
1011 context->buff = NULL;
1012 CUR (context) = start;
1013 RLIMIT (context) = start + len;
1014 macro->flags |= NODE_DISABLED;
1017 /* Expand an argument ARG before replacing parameters in a
1018 function-like macro. This works by pushing a context with the
1019 argument's tokens, and then expanding that into a temporary buffer
1020 as if it were a normal part of the token stream. collect_args()
1021 has terminated the argument's tokens with a CPP_EOF so that we know
1022 when we have fully expanded the argument. */
1024 expand_arg (cpp_reader *pfile, macro_arg *arg)
1026 unsigned int capacity;
1027 bool saved_warn_trad;
1029 if (arg->count == 0)
1032 /* Don't warn about funlike macros when pre-expanding. */
1033 saved_warn_trad = CPP_WTRADITIONAL (pfile);
1034 CPP_WTRADITIONAL (pfile) = 0;
1036 /* Loop, reading in the arguments. */
1038 arg->expanded = XNEWVEC (const cpp_token *, capacity);
1040 push_ptoken_context (pfile, NULL, NULL, arg->first, arg->count + 1);
1043 const cpp_token *token;
1045 if (arg->expanded_count + 1 >= capacity)
1048 arg->expanded = XRESIZEVEC (const cpp_token *, arg->expanded,
1052 token = cpp_get_token (pfile);
1054 if (token->type == CPP_EOF)
1057 arg->expanded[arg->expanded_count++] = token;
1060 _cpp_pop_context (pfile);
1062 CPP_WTRADITIONAL (pfile) = saved_warn_trad;
1065 /* Pop the current context off the stack, re-enabling the macro if the
1066 context represented a macro's replacement list. The context
1067 structure is not freed so that we can re-use it later. */
1069 _cpp_pop_context (cpp_reader *pfile)
1071 cpp_context *context = pfile->context;
1074 context->macro->flags &= ~NODE_DISABLED;
1077 _cpp_release_buff (pfile, context->buff);
1079 pfile->context = context->prev;
1082 /* External routine to get a token. Also used nearly everywhere
1083 internally, except for places where we know we can safely call
1084 _cpp_lex_token directly, such as lexing a directive name.
1086 Macro expansions and directives are transparently handled,
1087 including entering included files. Thus tokens are post-macro
1088 expansion, and after any intervening directives. External callers
1089 see CPP_EOF only at EOF. Internal callers also see it when meeting
1090 a directive inside a macro call, when at the end of a directive and
1091 state.in_directive is still 1, and at the end of argument
1094 cpp_get_token (cpp_reader *pfile)
1096 const cpp_token *result;
1101 cpp_context *context = pfile->context;
1103 /* Context->prev == 0 <=> base context. */
1105 result = _cpp_lex_token (pfile);
1106 else if (FIRST (context).token != LAST (context).token)
1108 if (context->direct_p)
1109 result = FIRST (context).token++;
1111 result = *FIRST (context).ptoken++;
1113 if (result->flags & PASTE_LEFT)
1115 paste_all_tokens (pfile, result);
1116 if (pfile->state.in_directive)
1118 return padding_token (pfile, result);
1123 _cpp_pop_context (pfile);
1124 if (pfile->state.in_directive)
1126 return &pfile->avoid_paste;
1129 if (pfile->state.in_directive && result->type == CPP_COMMENT)
1132 if (result->type != CPP_NAME)
1135 node = result->val.node;
1137 if (node->type != NT_MACRO || (result->flags & NO_EXPAND))
1140 if (!(node->flags & NODE_DISABLED))
1142 if (!pfile->state.prevent_expansion
1143 && enter_macro_context (pfile, node))
1145 if (pfile->state.in_directive)
1147 return padding_token (pfile, result);
1152 /* Flag this token as always unexpandable. FIXME: move this
1153 to collect_args()?. */
1154 cpp_token *t = _cpp_temp_token (pfile);
1155 t->type = result->type;
1156 t->flags = result->flags | NO_EXPAND;
1157 t->val = result->val;
1167 /* Returns true if we're expanding an object-like macro that was
1168 defined in a system header. Just checks the macro at the top of
1169 the stack. Used for diagnostic suppression. */
1171 cpp_sys_macro_p (cpp_reader *pfile)
1173 cpp_hashnode *node = pfile->context->macro;
1175 return node && node->value.macro && node->value.macro->syshdr;
1178 /* Read each token in, until end of the current file. Directives are
1179 transparently processed. */
1181 cpp_scan_nooutput (cpp_reader *pfile)
1183 /* Request a CPP_EOF token at the end of this file, rather than
1184 transparently continuing with the including file. */
1185 pfile->buffer->return_at_eof = true;
1187 pfile->state.discarding_output++;
1188 pfile->state.prevent_expansion++;
1190 if (CPP_OPTION (pfile, traditional))
1191 while (_cpp_read_logical_line_trad (pfile))
1194 while (cpp_get_token (pfile)->type != CPP_EOF)
1197 pfile->state.discarding_output--;
1198 pfile->state.prevent_expansion--;
1201 /* Step back one (or more) tokens. Can only step back more than 1 if
1202 they are from the lexer, and not from macro expansion. */
1204 _cpp_backup_tokens (cpp_reader *pfile, unsigned int count)
1206 if (pfile->context->prev == NULL)
1208 pfile->lookaheads += count;
1212 if (pfile->cur_token == pfile->cur_run->base
1213 /* Possible with -fpreprocessed and no leading #line. */
1214 && pfile->cur_run->prev != NULL)
1216 pfile->cur_run = pfile->cur_run->prev;
1217 pfile->cur_token = pfile->cur_run->limit;
1225 if (pfile->context->direct_p)
1226 FIRST (pfile->context).token--;
1228 FIRST (pfile->context).ptoken--;
1232 /* #define directive parsing and handling. */
1234 /* Returns nonzero if a macro redefinition warning is required. */
1236 warn_of_redefinition (cpp_reader *pfile, const cpp_hashnode *node,
1237 const cpp_macro *macro2)
1239 const cpp_macro *macro1;
1242 /* Some redefinitions need to be warned about regardless. */
1243 if (node->flags & NODE_WARN)
1246 /* Redefinition of a macro is allowed if and only if the old and new
1247 definitions are the same. (6.10.3 paragraph 2). */
1248 macro1 = node->value.macro;
1250 /* Don't check count here as it can be different in valid
1251 traditional redefinitions with just whitespace differences. */
1252 if (macro1->paramc != macro2->paramc
1253 || macro1->fun_like != macro2->fun_like
1254 || macro1->variadic != macro2->variadic)
1257 /* Check parameter spellings. */
1258 for (i = 0; i < macro1->paramc; i++)
1259 if (macro1->params[i] != macro2->params[i])
1262 /* Check the replacement text or tokens. */
1263 if (CPP_OPTION (pfile, traditional))
1264 return _cpp_expansions_different_trad (macro1, macro2);
1266 if (macro1->count != macro2->count)
1269 for (i = 0; i < macro1->count; i++)
1270 if (!_cpp_equiv_tokens (¯o1->exp.tokens[i], ¯o2->exp.tokens[i]))
1276 /* Free the definition of hashnode H. */
1278 _cpp_free_definition (cpp_hashnode *h)
1280 /* Macros and assertions no longer have anything to free. */
1282 /* Clear builtin flag in case of redefinition. */
1283 h->flags &= ~(NODE_BUILTIN | NODE_DISABLED);
1286 /* Save parameter NODE to the parameter list of macro MACRO. Returns
1287 zero on success, nonzero if the parameter is a duplicate. */
1289 _cpp_save_parameter (cpp_reader *pfile, cpp_macro *macro, cpp_hashnode *node)
1292 /* Constraint 6.10.3.6 - duplicate parameter names. */
1293 if (node->flags & NODE_MACRO_ARG)
1295 cpp_error (pfile, CPP_DL_ERROR, "duplicate macro parameter \"%s\"",
1300 if (BUFF_ROOM (pfile->a_buff)
1301 < (macro->paramc + 1) * sizeof (cpp_hashnode *))
1302 _cpp_extend_buff (pfile, &pfile->a_buff, sizeof (cpp_hashnode *));
1304 ((cpp_hashnode **) BUFF_FRONT (pfile->a_buff))[macro->paramc++] = node;
1305 node->flags |= NODE_MACRO_ARG;
1306 len = macro->paramc * sizeof (union _cpp_hashnode_value);
1307 if (len > pfile->macro_buffer_len)
1309 pfile->macro_buffer = XRESIZEVEC (unsigned char, pfile->macro_buffer,
1311 pfile->macro_buffer_len = len;
1313 ((union _cpp_hashnode_value *) pfile->macro_buffer)[macro->paramc - 1]
1316 node->value.arg_index = macro->paramc;
1320 /* Check the syntax of the parameters in a MACRO definition. Returns
1321 false if an error occurs. */
1323 parse_params (cpp_reader *pfile, cpp_macro *macro)
1325 unsigned int prev_ident = 0;
1329 const cpp_token *token = _cpp_lex_token (pfile);
1331 switch (token->type)
1334 /* Allow/ignore comments in parameter lists if we are
1335 preserving comments in macro expansions. */
1336 if (token->type == CPP_COMMENT
1337 && ! CPP_OPTION (pfile, discard_comments_in_macro_exp))
1340 cpp_error (pfile, CPP_DL_ERROR,
1341 "\"%s\" may not appear in macro parameter list",
1342 cpp_token_as_text (pfile, token));
1348 cpp_error (pfile, CPP_DL_ERROR,
1349 "macro parameters must be comma-separated");
1354 if (_cpp_save_parameter (pfile, macro, token->val.node))
1358 case CPP_CLOSE_PAREN:
1359 if (prev_ident || macro->paramc == 0)
1362 /* Fall through to pick up the error. */
1366 cpp_error (pfile, CPP_DL_ERROR, "parameter name missing");
1373 macro->variadic = 1;
1376 _cpp_save_parameter (pfile, macro,
1377 pfile->spec_nodes.n__VA_ARGS__);
1378 pfile->state.va_args_ok = 1;
1379 if (! CPP_OPTION (pfile, c99)
1380 && CPP_OPTION (pfile, pedantic)
1381 && CPP_OPTION (pfile, warn_variadic_macros))
1382 cpp_error (pfile, CPP_DL_PEDWARN,
1383 "anonymous variadic macros were introduced in C99");
1385 else if (CPP_OPTION (pfile, pedantic)
1386 && CPP_OPTION (pfile, warn_variadic_macros))
1387 cpp_error (pfile, CPP_DL_PEDWARN,
1388 "ISO C does not permit named variadic macros");
1390 /* We're at the end, and just expect a closing parenthesis. */
1391 token = _cpp_lex_token (pfile);
1392 if (token->type == CPP_CLOSE_PAREN)
1397 cpp_error (pfile, CPP_DL_ERROR, "missing ')' in macro parameter list");
1403 /* Allocate room for a token from a macro's replacement list. */
1405 alloc_expansion_token (cpp_reader *pfile, cpp_macro *macro)
1407 if (BUFF_ROOM (pfile->a_buff) < (macro->count + 1) * sizeof (cpp_token))
1408 _cpp_extend_buff (pfile, &pfile->a_buff, sizeof (cpp_token));
1410 return &((cpp_token *) BUFF_FRONT (pfile->a_buff))[macro->count++];
1413 /* Lex a token from the expansion of MACRO, but mark parameters as we
1414 find them and warn of traditional stringification. */
1416 lex_expansion_token (cpp_reader *pfile, cpp_macro *macro)
1418 cpp_token *token, *saved_cur_token;
1420 saved_cur_token = pfile->cur_token;
1421 pfile->cur_token = alloc_expansion_token (pfile, macro);
1422 token = _cpp_lex_direct (pfile);
1423 pfile->cur_token = saved_cur_token;
1425 /* Is this a parameter? */
1426 if (token->type == CPP_NAME
1427 && (token->val.node->flags & NODE_MACRO_ARG) != 0)
1429 token->type = CPP_MACRO_ARG;
1430 token->val.arg_no = token->val.node->value.arg_index;
1432 else if (CPP_WTRADITIONAL (pfile) && macro->paramc > 0
1433 && (token->type == CPP_STRING || token->type == CPP_CHAR))
1434 check_trad_stringification (pfile, macro, &token->val.str);
1440 create_iso_definition (cpp_reader *pfile, cpp_macro *macro)
1443 const cpp_token *ctoken;
1444 bool following_paste_op = false;
1445 const char *paste_op_error_msg =
1446 N_("'##' cannot appear at either end of a macro expansion");
1448 /* Get the first token of the expansion (or the '(' of a
1449 function-like macro). */
1450 ctoken = _cpp_lex_token (pfile);
1452 if (ctoken->type == CPP_OPEN_PAREN && !(ctoken->flags & PREV_WHITE))
1454 bool ok = parse_params (pfile, macro);
1455 macro->params = (cpp_hashnode **) BUFF_FRONT (pfile->a_buff);
1459 /* Success. Commit or allocate the parameter array. */
1460 if (pfile->hash_table->alloc_subobject)
1462 cpp_hashnode **params =
1463 (cpp_hashnode **) pfile->hash_table->alloc_subobject
1464 (sizeof (cpp_hashnode *) * macro->paramc);
1465 memcpy (params, macro->params,
1466 sizeof (cpp_hashnode *) * macro->paramc);
1467 macro->params = params;
1470 BUFF_FRONT (pfile->a_buff) = (uchar *) ¯o->params[macro->paramc];
1471 macro->fun_like = 1;
1473 else if (ctoken->type != CPP_EOF && !(ctoken->flags & PREV_WHITE))
1475 /* While ISO C99 requires whitespace before replacement text
1476 in a macro definition, ISO C90 with TC1 allows there characters
1477 from the basic source character set. */
1478 if (CPP_OPTION (pfile, c99))
1479 cpp_error (pfile, CPP_DL_PEDWARN,
1480 "ISO C99 requires whitespace after the macro name");
1483 int warntype = CPP_DL_WARNING;
1484 switch (ctoken->type)
1488 case CPP_OBJC_STRING:
1489 /* '@' is not in basic character set. */
1490 warntype = CPP_DL_PEDWARN;
1493 /* Basic character set sans letters, digits and _. */
1494 if (strchr ("!\"#%&'()*+,-./:;<=>?[\\]^{|}~",
1495 ctoken->val.str.text[0]) == NULL)
1496 warntype = CPP_DL_PEDWARN;
1499 /* All other tokens start with a character from basic
1503 cpp_error (pfile, warntype,
1504 "missing whitespace after the macro name");
1508 if (macro->fun_like)
1509 token = lex_expansion_token (pfile, macro);
1512 token = alloc_expansion_token (pfile, macro);
1518 /* Check the stringifying # constraint 6.10.3.2.1 of
1519 function-like macros when lexing the subsequent token. */
1520 if (macro->count > 1 && token[-1].type == CPP_HASH && macro->fun_like)
1522 if (token->type == CPP_MACRO_ARG)
1524 token->flags &= ~PREV_WHITE;
1525 token->flags |= STRINGIFY_ARG;
1526 token->flags |= token[-1].flags & PREV_WHITE;
1527 token[-1] = token[0];
1530 /* Let assembler get away with murder. */
1531 else if (CPP_OPTION (pfile, lang) != CLK_ASM)
1533 cpp_error (pfile, CPP_DL_ERROR,
1534 "'#' is not followed by a macro parameter");
1539 if (token->type == CPP_EOF)
1541 /* Paste operator constraint 6.10.3.3.1:
1542 Token-paste ##, can appear in both object-like and
1543 function-like macros, but not at the end. */
1544 if (following_paste_op)
1546 cpp_error (pfile, CPP_DL_ERROR, paste_op_error_msg);
1552 /* Paste operator constraint 6.10.3.3.1. */
1553 if (token->type == CPP_PASTE)
1555 /* Token-paste ##, can appear in both object-like and
1556 function-like macros, but not at the beginning. */
1557 if (macro->count == 1)
1559 cpp_error (pfile, CPP_DL_ERROR, paste_op_error_msg);
1564 token[-1].flags |= PASTE_LEFT;
1567 following_paste_op = (token->type == CPP_PASTE);
1568 token = lex_expansion_token (pfile, macro);
1571 macro->exp.tokens = (cpp_token *) BUFF_FRONT (pfile->a_buff);
1572 macro->traditional = 0;
1574 /* Don't count the CPP_EOF. */
1577 /* Clear whitespace on first token for warn_of_redefinition(). */
1579 macro->exp.tokens[0].flags &= ~PREV_WHITE;
1581 /* Commit or allocate the memory. */
1582 if (pfile->hash_table->alloc_subobject)
1585 (cpp_token *) pfile->hash_table->alloc_subobject (sizeof (cpp_token)
1587 memcpy (tokns, macro->exp.tokens, sizeof (cpp_token) * macro->count);
1588 macro->exp.tokens = tokns;
1591 BUFF_FRONT (pfile->a_buff) = (uchar *) ¯o->exp.tokens[macro->count];
1596 /* Parse a macro and save its expansion. Returns nonzero on success. */
1598 _cpp_create_definition (cpp_reader *pfile, cpp_hashnode *node)
1604 if (pfile->hash_table->alloc_subobject)
1605 macro = (cpp_macro *) pfile->hash_table->alloc_subobject
1606 (sizeof (cpp_macro));
1608 macro = (cpp_macro *) _cpp_aligned_alloc (pfile, sizeof (cpp_macro));
1609 macro->line = pfile->directive_line;
1612 macro->variadic = 0;
1613 macro->used = !CPP_OPTION (pfile, warn_unused_macros);
1615 macro->fun_like = 0;
1616 /* To suppress some diagnostics. */
1617 macro->syshdr = pfile->buffer && pfile->buffer->sysp != 0;
1619 if (CPP_OPTION (pfile, traditional))
1620 ok = _cpp_create_trad_definition (pfile, macro);
1623 ok = create_iso_definition (pfile, macro);
1625 /* We set the type for SEEN_EOL() in directives.c.
1627 Longer term we should lex the whole line before coming here,
1628 and just copy the expansion. */
1630 /* Stop the lexer accepting __VA_ARGS__. */
1631 pfile->state.va_args_ok = 0;
1634 /* Clear the fast argument lookup indices. */
1635 for (i = macro->paramc; i-- > 0; )
1637 struct cpp_hashnode *node = macro->params[i];
1638 node->flags &= ~ NODE_MACRO_ARG;
1639 node->value = ((union _cpp_hashnode_value *) pfile->macro_buffer)[i];
1645 if (node->type == NT_MACRO)
1647 if (CPP_OPTION (pfile, warn_unused_macros))
1648 _cpp_warn_if_unused_macro (pfile, node, NULL);
1650 if (warn_of_redefinition (pfile, node, macro))
1652 cpp_error_with_line (pfile, CPP_DL_PEDWARN, pfile->directive_line, 0,
1653 "\"%s\" redefined", NODE_NAME (node));
1655 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
1656 cpp_error_with_line (pfile, CPP_DL_PEDWARN,
1657 node->value.macro->line, 0,
1658 "this is the location of the previous definition");
1662 if (node->type != NT_VOID)
1663 _cpp_free_definition (node);
1665 /* Enter definition in hash table. */
1666 node->type = NT_MACRO;
1667 node->value.macro = macro;
1668 if (! ustrncmp (NODE_NAME (node), DSC ("__STDC_")))
1669 node->flags |= NODE_WARN;
1674 /* Warn if a token in STRING matches one of a function-like MACRO's
1677 check_trad_stringification (cpp_reader *pfile, const cpp_macro *macro,
1678 const cpp_string *string)
1680 unsigned int i, len;
1681 const uchar *p, *q, *limit;
1683 /* Loop over the string. */
1684 limit = string->text + string->len - 1;
1685 for (p = string->text + 1; p < limit; p = q)
1687 /* Find the start of an identifier. */
1688 while (p < limit && !is_idstart (*p))
1691 /* Find the end of the identifier. */
1693 while (q < limit && is_idchar (*q))
1698 /* Loop over the function macro arguments to see if the
1699 identifier inside the string matches one of them. */
1700 for (i = 0; i < macro->paramc; i++)
1702 const cpp_hashnode *node = macro->params[i];
1704 if (NODE_LEN (node) == len
1705 && !memcmp (p, NODE_NAME (node), len))
1707 cpp_error (pfile, CPP_DL_WARNING,
1708 "macro argument \"%s\" would be stringified in traditional C",
1716 /* Returns the name, arguments and expansion of a macro, in a format
1717 suitable to be read back in again, and therefore also for DWARF 2
1718 debugging info. e.g. "PASTE(X, Y) X ## Y", or "MACNAME EXPANSION".
1719 Caller is expected to generate the "#define" bit if needed. The
1720 returned text is temporary, and automatically freed later. */
1721 const unsigned char *
1722 cpp_macro_definition (cpp_reader *pfile, const cpp_hashnode *node)
1724 unsigned int i, len;
1725 const cpp_macro *macro = node->value.macro;
1726 unsigned char *buffer;
1728 if (node->type != NT_MACRO || (node->flags & NODE_BUILTIN))
1730 cpp_error (pfile, CPP_DL_ICE,
1731 "invalid hash type %d in cpp_macro_definition", node->type);
1735 /* Calculate length. */
1736 len = NODE_LEN (node) + 2; /* ' ' and NUL. */
1737 if (macro->fun_like)
1739 len += 4; /* "()" plus possible final ".." of named
1740 varargs (we have + 1 below). */
1741 for (i = 0; i < macro->paramc; i++)
1742 len += NODE_LEN (macro->params[i]) + 1; /* "," */
1745 /* This should match below where we fill in the buffer. */
1746 if (CPP_OPTION (pfile, traditional))
1747 len += _cpp_replacement_text_len (macro);
1750 for (i = 0; i < macro->count; i++)
1752 cpp_token *token = ¯o->exp.tokens[i];
1754 if (token->type == CPP_MACRO_ARG)
1755 len += NODE_LEN (macro->params[token->val.arg_no - 1]);
1757 len += cpp_token_len (token);
1759 if (token->flags & STRINGIFY_ARG)
1761 if (token->flags & PASTE_LEFT)
1762 len += 3; /* " ##" */
1763 if (token->flags & PREV_WHITE)
1768 if (len > pfile->macro_buffer_len)
1770 pfile->macro_buffer = XRESIZEVEC (unsigned char,
1771 pfile->macro_buffer, len);
1772 pfile->macro_buffer_len = len;
1775 /* Fill in the buffer. Start with the macro name. */
1776 buffer = pfile->macro_buffer;
1777 memcpy (buffer, NODE_NAME (node), NODE_LEN (node));
1778 buffer += NODE_LEN (node);
1780 /* Parameter names. */
1781 if (macro->fun_like)
1784 for (i = 0; i < macro->paramc; i++)
1786 cpp_hashnode *param = macro->params[i];
1788 if (param != pfile->spec_nodes.n__VA_ARGS__)
1790 memcpy (buffer, NODE_NAME (param), NODE_LEN (param));
1791 buffer += NODE_LEN (param);
1794 if (i + 1 < macro->paramc)
1795 /* Don't emit a space after the comma here; we're trying
1796 to emit a Dwarf-friendly definition, and the Dwarf spec
1797 forbids spaces in the argument list. */
1799 else if (macro->variadic)
1800 *buffer++ = '.', *buffer++ = '.', *buffer++ = '.';
1805 /* The Dwarf spec requires a space after the macro name, even if the
1806 definition is the empty string. */
1809 if (CPP_OPTION (pfile, traditional))
1810 buffer = _cpp_copy_replacement_text (macro, buffer);
1811 else if (macro->count)
1812 /* Expansion tokens. */
1814 for (i = 0; i < macro->count; i++)
1816 cpp_token *token = ¯o->exp.tokens[i];
1818 if (token->flags & PREV_WHITE)
1820 if (token->flags & STRINGIFY_ARG)
1823 if (token->type == CPP_MACRO_ARG)
1826 NODE_NAME (macro->params[token->val.arg_no - 1]),
1827 NODE_LEN (macro->params[token->val.arg_no - 1]));
1828 buffer += NODE_LEN (macro->params[token->val.arg_no - 1]);
1831 buffer = cpp_spell_token (pfile, token, buffer, false);
1833 if (token->flags & PASTE_LEFT)
1838 /* Next has PREV_WHITE; see _cpp_create_definition. */
1844 return pfile->macro_buffer;