smatch.h: add the declaration to sm_to_arg_name()
[smatch.git] / pre-process.c
blobc35cbcfb3c5bc4b55cbe242810378efd7ce89747
1 /*
2 * Do C preprocessing, based on a token list gathered by
3 * the tokenizer.
5 * This may not be the smartest preprocessor on the planet.
7 * Copyright (C) 2003 Transmeta Corp.
8 * 2003-2004 Linus Torvalds
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 * THE SOFTWARE.
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <stdarg.h>
31 #include <stddef.h>
32 #include <string.h>
33 #include <ctype.h>
34 #include <unistd.h>
35 #include <fcntl.h>
36 #include <limits.h>
37 #include <time.h>
38 #include <dirent.h>
39 #include <sys/stat.h>
41 #include "lib.h"
42 #include "allocate.h"
43 #include "parse.h"
44 #include "token.h"
45 #include "symbol.h"
46 #include "expression.h"
47 #include "scope.h"
49 static struct ident_list *macros; // only needed for -dD
50 static int false_nesting = 0;
51 static int counter_macro = 0; // __COUNTER__ expansion
52 static int include_level = 0;
54 #define INCLUDEPATHS 300
55 const char *includepath[INCLUDEPATHS+1] = {
56 "",
57 "/usr/include",
58 "/usr/local/include",
59 NULL
62 static const char **quote_includepath = includepath;
63 static const char **angle_includepath = includepath + 1;
64 static const char **isys_includepath = includepath + 1;
65 static const char **sys_includepath = includepath + 1;
66 static const char **dirafter_includepath = includepath + 3;
68 #define dirty_stream(stream) \
69 do { \
70 if (!stream->dirty) { \
71 stream->dirty = 1; \
72 if (!stream->ifndef) \
73 stream->protect = NULL; \
74 } \
75 } while(0)
77 #define end_group(stream) \
78 do { \
79 if (stream->ifndef == stream->top_if) { \
80 stream->ifndef = NULL; \
81 if (!stream->dirty) \
82 stream->protect = NULL; \
83 else if (stream->protect) \
84 stream->dirty = 0; \
85 } \
86 } while(0)
88 #define nesting_error(stream) \
89 do { \
90 stream->dirty = 1; \
91 stream->ifndef = NULL; \
92 stream->protect = NULL; \
93 } while(0)
95 static struct token *alloc_token(struct position *pos)
97 struct token *token = __alloc_token(0);
99 token->pos.stream = pos->stream;
100 token->pos.line = pos->line;
101 token->pos.pos = pos->pos;
102 token->pos.whitespace = 1;
103 return token;
106 /* Expand symbol 'sym' at '*list' */
107 static int expand(struct token **, struct symbol *);
109 static void replace_with_string(struct token *token, const char *str)
111 int size = strlen(str) + 1;
112 struct string *s = __alloc_string(size);
114 s->length = size;
115 memcpy(s->data, str, size);
116 token_type(token) = TOKEN_STRING;
117 token->string = s;
120 static void replace_with_integer(struct token *token, unsigned int val)
122 char *buf = __alloc_bytes(11);
123 sprintf(buf, "%u", val);
124 token_type(token) = TOKEN_NUMBER;
125 token->number = buf;
128 static struct symbol *lookup_macro(struct ident *ident)
130 struct symbol *sym = lookup_symbol(ident, NS_MACRO | NS_UNDEF);
131 if (sym && sym->namespace != NS_MACRO)
132 sym = NULL;
133 return sym;
136 static int token_defined(struct token *token)
138 if (token_type(token) == TOKEN_IDENT) {
139 struct symbol *sym = lookup_macro(token->ident);
140 if (sym) {
141 sym->used_in = file_scope;
142 return 1;
144 return 0;
147 sparse_error(token->pos, "expected preprocessor identifier");
148 return 0;
151 static void replace_with_bool(struct token *token, bool val)
153 static const char *string[] = { "0", "1" };
155 token_type(token) = TOKEN_NUMBER;
156 token->number = string[val];
159 static void replace_with_defined(struct token *token)
161 replace_with_bool(token, token_defined(token));
164 static void replace_with_has_builtin(struct token *token)
166 struct symbol *sym = lookup_symbol(token->ident, NS_SYMBOL);
167 replace_with_bool(token, sym && sym->builtin);
170 static void replace_with_has_attribute(struct token *token)
172 struct symbol *sym = lookup_symbol(token->ident, NS_KEYWORD);
173 replace_with_bool(token, sym && sym->op && sym->op->attribute);
176 static void expand_line(struct token *token)
178 replace_with_integer(token, token->pos.line);
181 static void expand_file(struct token *token)
183 replace_with_string(token, stream_name(token->pos.stream));
186 static void expand_basefile(struct token *token)
188 replace_with_string(token, base_filename);
191 static time_t t = 0;
192 static void expand_date(struct token *token)
194 static char buffer[12]; /* __DATE__: 3 + ' ' + 2 + ' ' + 4 + '\0' */
196 if (!t)
197 time(&t);
198 strftime(buffer, 12, "%b %e %Y", localtime(&t));
199 replace_with_string(token, buffer);
202 static void expand_time(struct token *token)
204 static char buffer[9]; /* __TIME__: 2 + ':' + 2 + ':' + 2 + '\0' */
206 if (!t)
207 time(&t);
208 strftime(buffer, 9, "%T", localtime(&t));
209 replace_with_string(token, buffer);
212 static void expand_counter(struct token *token)
214 replace_with_integer(token, counter_macro++);
217 static void expand_include_level(struct token *token)
219 replace_with_integer(token, include_level - 1);
222 static int expand_one_symbol(struct token **list)
224 struct token *token = *list;
225 struct symbol *sym;
227 if (token->pos.noexpand)
228 return 1;
230 sym = lookup_macro(token->ident);
231 if (!sym)
232 return 1;
233 store_macro_pos(token);
234 if (sym->expander) {
235 sym->expander(token);
236 return 1;
237 } else {
238 sym->used_in = file_scope;
239 return expand(list, sym);
243 static inline struct token *scan_next(struct token **where)
245 struct token *token = *where;
246 if (token_type(token) != TOKEN_UNTAINT)
247 return token;
248 do {
249 token->ident->tainted = 0;
250 token = token->next;
251 } while (token_type(token) == TOKEN_UNTAINT);
252 *where = token;
253 return token;
256 static void expand_list(struct token **list)
258 struct token *next;
259 while (!eof_token(next = scan_next(list))) {
260 if (token_type(next) != TOKEN_IDENT || expand_one_symbol(list))
261 list = &next->next;
265 static void preprocessor_line(struct stream *stream, struct token **line);
267 static struct token *collect_arg(struct token *prev, int vararg, struct position *pos, int count)
269 struct stream *stream = input_streams + prev->pos.stream;
270 struct token **p = &prev->next;
271 struct token *next;
272 int nesting = 0;
274 while (!eof_token(next = scan_next(p))) {
275 if (next->pos.newline && match_op(next, '#')) {
276 if (!next->pos.noexpand) {
277 sparse_error(next->pos,
278 "directive in argument list");
279 preprocessor_line(stream, p);
280 __free_token(next); /* Free the '#' token */
281 continue;
284 switch (token_type(next)) {
285 case TOKEN_STREAMEND:
286 case TOKEN_STREAMBEGIN:
287 *p = &eof_token_entry;
288 return next;
289 case TOKEN_STRING:
290 case TOKEN_WIDE_STRING:
291 if (count > 1)
292 next->string->immutable = 1;
293 break;
295 if (false_nesting) {
296 *p = next->next;
297 __free_token(next);
298 continue;
300 if (match_op(next, '(')) {
301 nesting++;
302 } else if (match_op(next, ')')) {
303 if (!nesting--)
304 break;
305 } else if (match_op(next, ',') && !nesting && !vararg) {
306 break;
308 next->pos.stream = pos->stream;
309 next->pos.line = pos->line;
310 next->pos.pos = pos->pos;
311 p = &next->next;
313 *p = &eof_token_entry;
314 return next;
318 * We store arglist as <counter> [arg1] <number of uses for arg1> ... eof
321 struct arg {
322 struct token *arg;
323 struct token *expanded;
324 struct token *str;
325 int n_normal;
326 int n_quoted;
327 int n_str;
330 static int collect_arguments(struct token *start, struct token *arglist, struct arg *args, struct token *what)
332 int wanted = arglist->count.normal;
333 struct token *next = NULL;
334 int count = 0;
336 arglist = arglist->next; /* skip counter */
338 if (!wanted) {
339 next = collect_arg(start, 0, &what->pos, 0);
340 if (eof_token(next))
341 goto Eclosing;
342 if (!eof_token(start->next) || !match_op(next, ')')) {
343 count++;
344 goto Emany;
346 } else {
347 for (count = 0; count < wanted; count++) {
348 struct argcount *p = &arglist->next->count;
349 next = collect_arg(start, p->vararg, &what->pos, p->normal);
350 if (eof_token(next))
351 goto Eclosing;
352 if (p->vararg && wanted == 1 && eof_token(start->next))
353 break;
354 arglist = arglist->next->next;
355 args[count].arg = start->next;
356 args[count].n_normal = p->normal;
357 args[count].n_quoted = p->quoted;
358 args[count].n_str = p->str;
359 if (match_op(next, ')')) {
360 count++;
361 break;
363 start = next;
365 if (count == wanted && !match_op(next, ')'))
366 goto Emany;
367 if (count == wanted - 1) {
368 struct argcount *p = &arglist->next->count;
369 if (!p->vararg)
370 goto Efew;
371 args[count].arg = NULL;
372 args[count].n_normal = p->normal;
373 args[count].n_quoted = p->quoted;
374 args[count].n_str = p->str;
376 if (count < wanted - 1)
377 goto Efew;
379 what->next = next->next;
380 return 1;
382 Efew:
383 sparse_error(what->pos, "macro \"%s\" requires %d arguments, but only %d given",
384 show_token(what), wanted, count);
385 goto out;
386 Emany:
387 while (match_op(next, ',')) {
388 next = collect_arg(next, 0, &what->pos, 0);
389 count++;
391 if (eof_token(next))
392 goto Eclosing;
393 sparse_error(what->pos, "macro \"%s\" passed %d arguments, but takes just %d",
394 show_token(what), count, wanted);
395 goto out;
396 Eclosing:
397 sparse_error(what->pos, "unterminated argument list invoking macro \"%s\"",
398 show_token(what));
399 out:
400 what->next = next->next;
401 return 0;
404 static struct token *dup_list(struct token *list)
406 struct token *res = NULL;
407 struct token **p = &res;
409 while (!eof_token(list)) {
410 struct token *newtok = __alloc_token(0);
411 *newtok = *list;
412 *p = newtok;
413 p = &newtok->next;
414 list = list->next;
416 return res;
419 static const char *show_token_sequence(struct token *token, int quote)
421 static char buffer[MAX_STRING];
422 char *ptr = buffer;
423 int whitespace = 0;
425 if (!token && !quote)
426 return "<none>";
427 while (!eof_token(token)) {
428 const char *val = quote ? quote_token(token) : show_token(token);
429 int len = strlen(val);
431 if (ptr + whitespace + len >= buffer + sizeof(buffer)) {
432 sparse_error(token->pos, "too long token expansion");
433 break;
436 if (whitespace)
437 *ptr++ = ' ';
438 memcpy(ptr, val, len);
439 ptr += len;
440 token = token->next;
441 whitespace = token->pos.whitespace;
443 *ptr = 0;
444 return buffer;
447 static struct token *stringify(struct token *arg)
449 const char *s = show_token_sequence(arg, 1);
450 int size = strlen(s)+1;
451 struct token *token = __alloc_token(0);
452 struct string *string = __alloc_string(size);
454 memcpy(string->data, s, size);
455 string->length = size;
456 token->pos = arg->pos;
457 token_type(token) = TOKEN_STRING;
458 token->string = string;
459 token->next = &eof_token_entry;
460 return token;
463 static void expand_arguments(int count, struct arg *args)
465 int i;
466 for (i = 0; i < count; i++) {
467 struct token *arg = args[i].arg;
468 if (!arg)
469 arg = &eof_token_entry;
470 if (args[i].n_str)
471 args[i].str = stringify(arg);
472 if (args[i].n_normal) {
473 if (!args[i].n_quoted) {
474 args[i].expanded = arg;
475 args[i].arg = NULL;
476 } else if (eof_token(arg)) {
477 args[i].expanded = arg;
478 } else {
479 args[i].expanded = dup_list(arg);
481 expand_list(&args[i].expanded);
487 * Possibly valid combinations:
488 * - ident + ident -> ident
489 * - ident + number -> ident unless number contains '.', '+' or '-'.
490 * - 'L' + char constant -> wide char constant
491 * - 'L' + string literal -> wide string literal
492 * - number + number -> number
493 * - number + ident -> number
494 * - number + '.' -> number
495 * - number + '+' or '-' -> number, if number used to end on [eEpP].
496 * - '.' + number -> number, if number used to start with a digit.
497 * - special + special -> either special or an error.
499 static enum token_type combine(struct token *left, struct token *right, char *p)
501 int len;
502 enum token_type t1 = token_type(left), t2 = token_type(right);
504 if (t1 != TOKEN_IDENT && t1 != TOKEN_NUMBER && t1 != TOKEN_SPECIAL)
505 return TOKEN_ERROR;
507 if (t1 == TOKEN_IDENT && left->ident == &L_ident) {
508 if (t2 >= TOKEN_CHAR && t2 < TOKEN_WIDE_CHAR)
509 return t2 + TOKEN_WIDE_CHAR - TOKEN_CHAR;
510 if (t2 == TOKEN_STRING)
511 return TOKEN_WIDE_STRING;
514 if (t2 != TOKEN_IDENT && t2 != TOKEN_NUMBER && t2 != TOKEN_SPECIAL)
515 return TOKEN_ERROR;
517 strcpy(p, show_token(left));
518 strcat(p, show_token(right));
519 len = strlen(p);
521 if (len >= 256)
522 return TOKEN_ERROR;
524 if (t1 == TOKEN_IDENT) {
525 if (t2 == TOKEN_SPECIAL)
526 return TOKEN_ERROR;
527 if (t2 == TOKEN_NUMBER && strpbrk(p, "+-."))
528 return TOKEN_ERROR;
529 return TOKEN_IDENT;
532 if (t1 == TOKEN_NUMBER) {
533 if (t2 == TOKEN_SPECIAL) {
534 switch (right->special) {
535 case '.':
536 break;
537 case '+': case '-':
538 if (strchr("eEpP", p[len - 2]))
539 break;
540 default:
541 return TOKEN_ERROR;
544 return TOKEN_NUMBER;
547 if (p[0] == '.' && isdigit((unsigned char)p[1]))
548 return TOKEN_NUMBER;
550 return TOKEN_SPECIAL;
553 static int merge(struct token *left, struct token *right)
555 static char buffer[512];
556 enum token_type res = combine(left, right, buffer);
557 int n;
559 switch (res) {
560 case TOKEN_IDENT:
561 left->ident = built_in_ident(buffer);
562 left->pos.noexpand = 0;
563 return 1;
565 case TOKEN_NUMBER:
566 token_type(left) = TOKEN_NUMBER; /* could be . + num */
567 left->number = xstrdup(buffer);
568 return 1;
570 case TOKEN_SPECIAL:
571 if (buffer[2] && buffer[3])
572 break;
573 for (n = SPECIAL_BASE; n < SPECIAL_ARG_SEPARATOR; n++) {
574 if (!memcmp(buffer, combinations[n-SPECIAL_BASE], 3)) {
575 left->special = n;
576 return 1;
579 break;
581 case TOKEN_WIDE_CHAR:
582 case TOKEN_WIDE_STRING:
583 token_type(left) = res;
584 left->pos.noexpand = 0;
585 left->string = right->string;
586 return 1;
588 case TOKEN_WIDE_CHAR_EMBEDDED_0 ... TOKEN_WIDE_CHAR_EMBEDDED_3:
589 token_type(left) = res;
590 left->pos.noexpand = 0;
591 memcpy(left->embedded, right->embedded, 4);
592 return 1;
594 default:
597 sparse_error(left->pos, "'##' failed: concatenation is not a valid token");
598 return 0;
601 static struct token *dup_token(struct token *token, struct position *streampos)
603 struct token *alloc = alloc_token(streampos);
604 token_type(alloc) = token_type(token);
605 alloc->pos.newline = token->pos.newline;
606 alloc->pos.whitespace = token->pos.whitespace;
607 alloc->number = token->number;
608 alloc->pos.noexpand = token->pos.noexpand;
609 return alloc;
612 static struct token **copy(struct token **where, struct token *list, int *count)
614 int need_copy = --*count;
615 while (!eof_token(list)) {
616 struct token *token;
617 if (need_copy)
618 token = dup_token(list, &list->pos);
619 else
620 token = list;
621 if (token_type(token) == TOKEN_IDENT && token->ident->tainted)
622 token->pos.noexpand = 1;
623 *where = token;
624 where = &token->next;
625 list = list->next;
627 *where = &eof_token_entry;
628 return where;
631 static int handle_kludge(struct token **p, struct arg *args)
633 struct token *t = (*p)->next->next;
634 while (1) {
635 struct arg *v = &args[t->argnum];
636 if (token_type(t->next) != TOKEN_CONCAT) {
637 if (v->arg) {
638 /* ignore the first ## */
639 *p = (*p)->next;
640 return 0;
642 /* skip the entire thing */
643 *p = t;
644 return 1;
646 if (v->arg && !eof_token(v->arg))
647 return 0; /* no magic */
648 t = t->next->next;
652 static struct token **substitute(struct token **list, struct token *body, struct arg *args)
654 struct position *base_pos = &(*list)->pos;
655 int *count;
656 enum {Normal, Placeholder, Concat} state = Normal;
658 for (; !eof_token(body); body = body->next) {
659 struct token *added, *arg;
660 struct token **tail;
661 struct token *t;
663 switch (token_type(body)) {
664 case TOKEN_GNU_KLUDGE:
666 * GNU kludge: if we had <comma>##<vararg>, behaviour
667 * depends on whether we had enough arguments to have
668 * a vararg. If we did, ## is just ignored. Otherwise
669 * both , and ## are ignored. Worse, there can be
670 * an arbitrary number of ##<arg> in between; if all of
671 * those are empty, we act as if they hadn't been there,
672 * otherwise we act as if the kludge didn't exist.
674 t = body;
675 if (handle_kludge(&body, args)) {
676 if (state == Concat)
677 state = Normal;
678 else
679 state = Placeholder;
680 continue;
682 added = dup_token(t, base_pos);
683 token_type(added) = TOKEN_SPECIAL;
684 tail = &added->next;
685 break;
687 case TOKEN_STR_ARGUMENT:
688 arg = args[body->argnum].str;
689 count = &args[body->argnum].n_str;
690 goto copy_arg;
692 case TOKEN_QUOTED_ARGUMENT:
693 arg = args[body->argnum].arg;
694 count = &args[body->argnum].n_quoted;
695 if (!arg || eof_token(arg)) {
696 if (state == Concat)
697 state = Normal;
698 else
699 state = Placeholder;
700 continue;
702 goto copy_arg;
704 case TOKEN_MACRO_ARGUMENT:
705 arg = args[body->argnum].expanded;
706 count = &args[body->argnum].n_normal;
707 if (eof_token(arg)) {
708 state = Normal;
709 continue;
711 copy_arg:
712 tail = copy(&added, arg, count);
713 added->pos.newline = body->pos.newline;
714 added->pos.whitespace = body->pos.whitespace;
715 break;
717 case TOKEN_CONCAT:
718 if (state == Placeholder)
719 state = Normal;
720 else
721 state = Concat;
722 continue;
724 case TOKEN_IDENT:
725 added = dup_token(body, base_pos);
726 if (added->ident->tainted)
727 added->pos.noexpand = 1;
728 tail = &added->next;
729 break;
731 default:
732 added = dup_token(body, base_pos);
733 tail = &added->next;
734 break;
738 * if we got to doing real concatenation, we already have
739 * added something into the list, so containing_token() is OK.
741 if (state == Concat && merge(containing_token(list), added)) {
742 *list = added->next;
743 if (tail != &added->next)
744 list = tail;
745 } else {
746 *list = added;
747 list = tail;
749 state = Normal;
751 *list = &eof_token_entry;
752 return list;
755 static int expand(struct token **list, struct symbol *sym)
757 struct token *last;
758 struct token *token = *list;
759 struct ident *expanding = token->ident;
760 struct token **tail;
761 int nargs = sym->arglist ? sym->arglist->count.normal : 0;
762 struct arg args[nargs];
764 if (expanding->tainted) {
765 token->pos.noexpand = 1;
766 return 1;
769 if (sym->arglist) {
770 if (!match_op(scan_next(&token->next), '('))
771 return 1;
772 if (!collect_arguments(token->next, sym->arglist, args, token))
773 return 1;
774 expand_arguments(nargs, args);
777 expanding->tainted = 1;
779 last = token->next;
780 tail = substitute(list, sym->expansion, args);
782 * Note that it won't be eof - at least TOKEN_UNTAINT will be there.
783 * We still can lose the newline flag if the sucker expands to nothing,
784 * but the price of dealing with that is probably too high (we'd need
785 * to collect the flags during scan_next())
787 (*list)->pos.newline = token->pos.newline;
788 (*list)->pos.whitespace = token->pos.whitespace;
789 *tail = last;
791 return 0;
794 static const char *token_name_sequence(struct token *token, int endop, struct token *start)
796 static char buffer[256];
797 char *ptr = buffer;
799 while (!eof_token(token) && !match_op(token, endop)) {
800 int len;
801 const char *val = token->string->data;
802 if (token_type(token) != TOKEN_STRING)
803 val = show_token(token);
804 len = strlen(val);
805 memcpy(ptr, val, len);
806 ptr += len;
807 token = token->next;
809 *ptr = 0;
810 if (endop && !match_op(token, endop))
811 sparse_error(start->pos, "expected '>' at end of filename");
812 return buffer;
815 static int already_tokenized(const char *path)
817 int stream, next;
819 for (stream = *hash_stream(path); stream >= 0 ; stream = next) {
820 struct stream *s = input_streams + stream;
822 next = s->next_stream;
823 if (s->once) {
824 if (strcmp(path, s->name))
825 continue;
826 return 1;
828 if (s->constant != CONSTANT_FILE_YES)
829 continue;
830 if (strcmp(path, s->name))
831 continue;
832 if (s->protect && !lookup_macro(s->protect))
833 continue;
834 return 1;
836 return 0;
839 /* Handle include of header files.
840 * The relevant options are made compatible with gcc. The only options that
841 * are not supported is -withprefix and friends.
843 * Three set of include paths are known:
844 * quote_includepath: Path to search when using #include "file.h"
845 * angle_includepath: Paths to search when using #include <file.h>
846 * isys_includepath: Paths specified with -isystem, come before the
847 * built-in system include paths. Gcc would suppress
848 * warnings from system headers. Here we separate
849 * them from the angle_ ones to keep search ordering.
851 * sys_includepath: Built-in include paths.
852 * dirafter_includepath Paths added with -dirafter.
854 * The above is implemented as one array with pointers
855 * +--------------+
856 * quote_includepath ---> | |
857 * +--------------+
858 * | |
859 * +--------------+
860 * angle_includepath ---> | |
861 * +--------------+
862 * isys_includepath ---> | |
863 * +--------------+
864 * sys_includepath ---> | |
865 * +--------------+
866 * dirafter_includepath -> | |
867 * +--------------+
869 * -I dir insert dir just before isys_includepath and move the rest
870 * -I- makes all dirs specified with -I before to quote dirs only and
871 * angle_includepath is set equal to isys_includepath.
872 * -nostdinc removes all sys dirs by storing NULL in entry pointed
873 * to by * sys_includepath. Note that this will reset all dirs built-in
874 * and added before -nostdinc by -isystem and -idirafter.
875 * -isystem dir adds dir where isys_includepath points adding this dir as
876 * first systemdir
877 * -idirafter dir adds dir to the end of the list
880 static void set_stream_include_path(struct stream *stream)
882 const char *path = stream->path;
883 if (!path) {
884 const char *p = strrchr(stream->name, '/');
885 path = "";
886 if (p) {
887 int len = p - stream->name + 1;
888 char *m = malloc(len+1);
889 /* This includes the final "/" */
890 memcpy(m, stream->name, len);
891 m[len] = 0;
892 path = m;
894 stream->path = path;
896 includepath[0] = path;
899 #ifndef PATH_MAX
900 #define PATH_MAX 4096 // for Hurd where it's not defined
901 #endif
903 static int try_include(const char *path, const char *filename, int flen, struct token **where, const char **next_path)
905 int fd;
906 int plen = strlen(path);
907 static char fullname[PATH_MAX];
909 memcpy(fullname, path, plen);
910 if (plen && path[plen-1] != '/') {
911 fullname[plen] = '/';
912 plen++;
914 memcpy(fullname+plen, filename, flen);
915 if (already_tokenized(fullname))
916 return 1;
917 fd = open(fullname, O_RDONLY);
918 if (fd >= 0) {
919 char *streamname = xmemdup(fullname, plen + flen);
920 *where = tokenize(streamname, fd, *where, next_path);
921 close(fd);
922 return 1;
924 return 0;
927 static int do_include_path(const char **pptr, struct token **list, struct token *token, const char *filename, int flen)
929 const char *path;
931 while ((path = *pptr++) != NULL) {
932 if (!try_include(path, filename, flen, list, pptr))
933 continue;
934 return 1;
936 return 0;
939 static int free_preprocessor_line(struct token *token)
941 while (token_type(token) != TOKEN_EOF) {
942 struct token *free = token;
943 token = token->next;
944 __free_token(free);
946 return 1;
949 const char *find_include(const char *skip, const char *look_for)
951 DIR *dp;
952 struct dirent *entry;
953 struct stat statbuf;
954 const char *ret;
955 char cwd[PATH_MAX];
956 static char buf[PATH_MAX + 1];
958 dp = opendir(".");
959 if (!dp)
960 return NULL;
962 if (!getcwd(cwd, sizeof(cwd)))
963 goto close;
965 while ((entry = readdir(dp))) {
966 lstat(entry->d_name, &statbuf);
968 if (strcmp(entry->d_name, look_for) == 0) {
969 snprintf(buf, sizeof(buf), "%s/%s", cwd, entry->d_name);
970 closedir(dp);
971 return buf;
974 if (S_ISDIR(statbuf.st_mode)) {
975 /* Found a directory, but ignore . and .. */
976 if (strcmp(".", entry->d_name) == 0 ||
977 strcmp("..", entry->d_name) == 0 ||
978 strcmp(skip, entry->d_name) == 0)
979 continue;
981 chdir(entry->d_name);
982 ret = find_include("", look_for);
983 chdir("..");
984 if (ret) {
985 closedir(dp);
986 return ret;
990 close:
991 closedir(dp);
993 return NULL;
996 const char *search_dir(const char *stop, const char *look_for)
998 char cwd[PATH_MAX];
999 int len;
1000 const char *ret;
1001 int cnt = 0;
1003 if (!getcwd(cwd, sizeof(cwd)))
1004 return NULL;
1006 len = strlen(cwd);
1007 while (len >= 0) {
1008 ret = find_include(cnt++ ? cwd + len + 1 : "", look_for);
1009 if (ret)
1010 return ret;
1012 if (strcmp(cwd, stop) == 0 ||
1013 strcmp(cwd, "/usr/include") == 0 ||
1014 strcmp(cwd, "/usr/local/include") == 0 ||
1015 strlen(cwd) <= 10 || /* heck... don't search /usr/lib/ */
1016 strcmp(cwd, "/") == 0)
1017 return NULL;
1019 while (--len >= 0) {
1020 if (cwd[len] == '/') {
1021 cwd[len] = '\0';
1022 break;
1026 chdir("..");
1028 return NULL;
1031 static void use_best_guess_header_file(struct token *token, const char *filename, struct token **list)
1033 char cwd[PATH_MAX];
1034 char dir_part[PATH_MAX];
1035 const char *file_part;
1036 const char *include_name;
1037 static int cnt;
1038 int len;
1040 /* Avoid guessing includes recursively. */
1041 if (cnt++ > 1000)
1042 return;
1044 if (!filename || filename[0] == '\0')
1045 return;
1047 file_part = filename;
1048 while ((filename = strchr(filename, '/'))) {
1049 ++filename;
1050 if (filename[0])
1051 file_part = filename;
1054 snprintf(dir_part, sizeof(dir_part), "%s", stream_name(token->pos.stream));
1055 len = strlen(dir_part);
1056 while (--len >= 0) {
1057 if (dir_part[len] == '/') {
1058 dir_part[len] = '\0';
1059 break;
1062 if (len < 0)
1063 sprintf(dir_part, ".");
1065 if (!getcwd(cwd, sizeof(cwd)))
1066 return;
1068 chdir(dir_part);
1069 include_name = search_dir(cwd, file_part);
1070 chdir(cwd);
1071 if (!include_name)
1072 return;
1073 sparse_error(token->pos, "using '%s'", include_name);
1075 try_include("", include_name, strlen(include_name), list, includepath);
1078 static int handle_include_path(struct stream *stream, struct token **list, struct token *token, int how)
1080 const char *filename;
1081 struct token *next;
1082 const char **path;
1083 int expect;
1084 int flen;
1086 next = token->next;
1087 expect = '>';
1088 if (!match_op(next, '<')) {
1089 expand_list(&token->next);
1090 expect = 0;
1091 next = token;
1092 if (match_op(token->next, '<')) {
1093 next = token->next;
1094 expect = '>';
1098 token = next->next;
1099 filename = token_name_sequence(token, expect, token);
1100 flen = strlen(filename) + 1;
1102 /* Absolute path? */
1103 if (filename[0] == '/') {
1104 if (try_include("", filename, flen, list, includepath))
1105 return 0;
1106 goto out;
1109 switch (how) {
1110 case 1:
1111 path = stream->next_path;
1112 break;
1113 case 2:
1114 includepath[0] = "";
1115 path = includepath;
1116 break;
1117 default:
1118 /* Dir of input file is first dir to search for quoted includes */
1119 set_stream_include_path(stream);
1120 path = expect ? angle_includepath : quote_includepath;
1121 break;
1123 /* Check the standard include paths.. */
1124 if (do_include_path(path, list, token, filename, flen))
1125 return 0;
1126 out:
1127 sparse_error(token->pos, "unable to open '%s'", filename);
1128 use_best_guess_header_file(token, filename, list);
1129 return 0;
1132 static int handle_include(struct stream *stream, struct token **list, struct token *token)
1134 return handle_include_path(stream, list, token, 0);
1137 static int handle_include_next(struct stream *stream, struct token **list, struct token *token)
1139 return handle_include_path(stream, list, token, 1);
1142 static int handle_argv_include(struct stream *stream, struct token **list, struct token *token)
1144 return handle_include_path(stream, list, token, 2);
1147 static int token_different(struct token *t1, struct token *t2)
1149 int different;
1151 if (token_type(t1) != token_type(t2))
1152 return 1;
1154 switch (token_type(t1)) {
1155 case TOKEN_IDENT:
1156 different = t1->ident != t2->ident;
1157 break;
1158 case TOKEN_ARG_COUNT:
1159 case TOKEN_UNTAINT:
1160 case TOKEN_CONCAT:
1161 case TOKEN_GNU_KLUDGE:
1162 different = 0;
1163 break;
1164 case TOKEN_NUMBER:
1165 different = strcmp(t1->number, t2->number);
1166 break;
1167 case TOKEN_SPECIAL:
1168 different = t1->special != t2->special;
1169 break;
1170 case TOKEN_MACRO_ARGUMENT:
1171 case TOKEN_QUOTED_ARGUMENT:
1172 case TOKEN_STR_ARGUMENT:
1173 different = t1->argnum != t2->argnum;
1174 break;
1175 case TOKEN_CHAR_EMBEDDED_0 ... TOKEN_CHAR_EMBEDDED_3:
1176 case TOKEN_WIDE_CHAR_EMBEDDED_0 ... TOKEN_WIDE_CHAR_EMBEDDED_3:
1177 different = memcmp(t1->embedded, t2->embedded, 4);
1178 break;
1179 case TOKEN_CHAR:
1180 case TOKEN_WIDE_CHAR:
1181 case TOKEN_STRING:
1182 case TOKEN_WIDE_STRING: {
1183 struct string *s1, *s2;
1185 s1 = t1->string;
1186 s2 = t2->string;
1187 different = 1;
1188 if (s1->length != s2->length)
1189 break;
1190 different = memcmp(s1->data, s2->data, s1->length);
1191 break;
1193 default:
1194 different = 1;
1195 break;
1197 return different;
1200 static int token_list_different(struct token *list1, struct token *list2)
1202 for (;;) {
1203 if (list1 == list2)
1204 return 0;
1205 if (!list1 || !list2)
1206 return 1;
1207 if (token_different(list1, list2))
1208 return 1;
1209 list1 = list1->next;
1210 list2 = list2->next;
1214 static inline void set_arg_count(struct token *token)
1216 token_type(token) = TOKEN_ARG_COUNT;
1217 token->count.normal = token->count.quoted =
1218 token->count.str = token->count.vararg = 0;
1221 static struct token *parse_arguments(struct token *list)
1223 struct token *arg = list->next, *next = list;
1224 struct argcount *count = &list->count;
1226 set_arg_count(list);
1228 if (match_op(arg, ')')) {
1229 next = arg->next;
1230 list->next = &eof_token_entry;
1231 return next;
1234 while (token_type(arg) == TOKEN_IDENT) {
1235 if (arg->ident == &__VA_ARGS___ident)
1236 goto Eva_args;
1237 if (!++count->normal)
1238 goto Eargs;
1239 next = arg->next;
1241 if (match_op(next, ',')) {
1242 set_arg_count(next);
1243 arg = next->next;
1244 continue;
1247 if (match_op(next, ')')) {
1248 set_arg_count(next);
1249 next = next->next;
1250 arg->next->next = &eof_token_entry;
1251 return next;
1254 /* normal cases are finished here */
1256 if (match_op(next, SPECIAL_ELLIPSIS)) {
1257 if (match_op(next->next, ')')) {
1258 set_arg_count(next);
1259 next->count.vararg = 1;
1260 next = next->next;
1261 arg->next->next = &eof_token_entry;
1262 return next->next;
1265 arg = next;
1266 goto Enotclosed;
1269 if (eof_token(next)) {
1270 goto Enotclosed;
1271 } else {
1272 arg = next;
1273 goto Ebadstuff;
1277 if (match_op(arg, SPECIAL_ELLIPSIS)) {
1278 next = arg->next;
1279 token_type(arg) = TOKEN_IDENT;
1280 arg->ident = &__VA_ARGS___ident;
1281 if (!match_op(next, ')'))
1282 goto Enotclosed;
1283 if (!++count->normal)
1284 goto Eargs;
1285 set_arg_count(next);
1286 next->count.vararg = 1;
1287 next = next->next;
1288 arg->next->next = &eof_token_entry;
1289 return next;
1292 if (eof_token(arg)) {
1293 arg = next;
1294 goto Enotclosed;
1296 if (match_op(arg, ','))
1297 goto Emissing;
1298 else
1299 goto Ebadstuff;
1302 Emissing:
1303 sparse_error(arg->pos, "parameter name missing");
1304 return NULL;
1305 Ebadstuff:
1306 sparse_error(arg->pos, "\"%s\" may not appear in macro parameter list",
1307 show_token(arg));
1308 return NULL;
1309 Enotclosed:
1310 sparse_error(arg->pos, "missing ')' in macro parameter list");
1311 return NULL;
1312 Eva_args:
1313 sparse_error(arg->pos, "__VA_ARGS__ can only appear in the expansion of a C99 variadic macro");
1314 return NULL;
1315 Eargs:
1316 sparse_error(arg->pos, "too many arguments in macro definition");
1317 return NULL;
1320 static int try_arg(struct token *token, enum token_type type, struct token *arglist)
1322 struct ident *ident = token->ident;
1323 int nr;
1325 if (!arglist || token_type(token) != TOKEN_IDENT)
1326 return 0;
1328 arglist = arglist->next;
1330 for (nr = 0; !eof_token(arglist); nr++, arglist = arglist->next->next) {
1331 if (arglist->ident == ident) {
1332 struct argcount *count = &arglist->next->count;
1333 int n;
1335 token->argnum = nr;
1336 token_type(token) = type;
1337 switch (type) {
1338 case TOKEN_MACRO_ARGUMENT:
1339 n = ++count->normal;
1340 break;
1341 case TOKEN_QUOTED_ARGUMENT:
1342 n = ++count->quoted;
1343 break;
1344 default:
1345 n = ++count->str;
1347 if (n)
1348 return count->vararg ? 2 : 1;
1350 * XXX - need saner handling of that
1351 * (>= 1024 instances of argument)
1353 token_type(token) = TOKEN_ERROR;
1354 return -1;
1357 return 0;
1360 static struct token *handle_hash(struct token **p, struct token *arglist)
1362 struct token *token = *p;
1363 if (arglist) {
1364 struct token *next = token->next;
1365 if (!try_arg(next, TOKEN_STR_ARGUMENT, arglist))
1366 goto Equote;
1367 next->pos.whitespace = token->pos.whitespace;
1368 __free_token(token);
1369 token = *p = next;
1370 } else {
1371 token->pos.noexpand = 1;
1373 return token;
1375 Equote:
1376 sparse_error(token->pos, "'#' is not followed by a macro parameter");
1377 return NULL;
1380 /* token->next is ## */
1381 static struct token *handle_hashhash(struct token *token, struct token *arglist)
1383 struct token *last = token;
1384 struct token *concat;
1385 int state = match_op(token, ',');
1387 try_arg(token, TOKEN_QUOTED_ARGUMENT, arglist);
1389 while (1) {
1390 struct token *t;
1391 int is_arg;
1393 /* eat duplicate ## */
1394 concat = token->next;
1395 while (match_op(t = concat->next, SPECIAL_HASHHASH)) {
1396 token->next = t;
1397 __free_token(concat);
1398 concat = t;
1400 token_type(concat) = TOKEN_CONCAT;
1402 if (eof_token(t))
1403 goto Econcat;
1405 if (match_op(t, '#')) {
1406 t = handle_hash(&concat->next, arglist);
1407 if (!t)
1408 return NULL;
1411 is_arg = try_arg(t, TOKEN_QUOTED_ARGUMENT, arglist);
1413 if (state == 1 && is_arg) {
1414 state = is_arg;
1415 } else {
1416 last = t;
1417 state = match_op(t, ',');
1420 token = t;
1421 if (!match_op(token->next, SPECIAL_HASHHASH))
1422 break;
1424 /* handle GNU ,##__VA_ARGS__ kludge, in all its weirdness */
1425 if (state == 2)
1426 token_type(last) = TOKEN_GNU_KLUDGE;
1427 return token;
1429 Econcat:
1430 sparse_error(concat->pos, "'##' cannot appear at the ends of macro expansion");
1431 return NULL;
1434 static struct token *parse_expansion(struct token *expansion, struct token *arglist, struct ident *name)
1436 struct token *token = expansion;
1437 struct token **p;
1439 if (match_op(token, SPECIAL_HASHHASH))
1440 goto Econcat;
1442 for (p = &expansion; !eof_token(token); p = &token->next, token = *p) {
1443 if (match_op(token, '#')) {
1444 token = handle_hash(p, arglist);
1445 if (!token)
1446 return NULL;
1448 if (match_op(token->next, SPECIAL_HASHHASH)) {
1449 token = handle_hashhash(token, arglist);
1450 if (!token)
1451 return NULL;
1452 } else {
1453 try_arg(token, TOKEN_MACRO_ARGUMENT, arglist);
1455 switch (token_type(token)) {
1456 case TOKEN_ERROR:
1457 goto Earg;
1459 case TOKEN_STRING:
1460 case TOKEN_WIDE_STRING:
1461 token->string->immutable = 1;
1462 break;
1465 token = alloc_token(&expansion->pos);
1466 token_type(token) = TOKEN_UNTAINT;
1467 token->ident = name;
1468 token->next = *p;
1469 *p = token;
1470 return expansion;
1472 Econcat:
1473 sparse_error(token->pos, "'##' cannot appear at the ends of macro expansion");
1474 return NULL;
1475 Earg:
1476 sparse_error(token->pos, "too many instances of argument in body");
1477 return NULL;
1480 static int do_define(struct position pos, struct token *token, struct ident *name,
1481 struct token *arglist, struct token *expansion, int attr)
1483 struct symbol *sym;
1484 int ret = 1;
1486 expansion = parse_expansion(expansion, arglist, name);
1487 if (!expansion)
1488 return 1;
1490 sym = lookup_symbol(name, NS_MACRO | NS_UNDEF);
1491 if (sym) {
1492 int clean;
1494 if (attr < sym->attr)
1495 goto out;
1497 clean = (attr == sym->attr && sym->namespace == NS_MACRO);
1499 if (token_list_different(sym->expansion, expansion) ||
1500 token_list_different(sym->arglist, arglist)) {
1501 ret = 0;
1502 if ((clean && attr == SYM_ATTR_NORMAL)
1503 || sym->used_in == file_scope) {
1504 warning(pos, "preprocessor token %.*s redefined",
1505 name->len, name->name);
1506 info(sym->pos, "this was the original definition");
1508 } else if (clean)
1509 goto out;
1512 if (!sym || sym->scope != file_scope) {
1513 sym = alloc_symbol(pos, SYM_NODE);
1514 bind_symbol(sym, name, NS_MACRO);
1515 add_ident(&macros, name);
1516 ret = 0;
1519 if (!ret) {
1520 sym->expansion = expansion;
1521 sym->arglist = arglist;
1522 if (token) /* Free the "define" token, but not the rest of the line */
1523 __free_token(token);
1526 sym->namespace = NS_MACRO;
1527 sym->used_in = NULL;
1528 sym->attr = attr;
1529 out:
1530 return ret;
1534 // predefine a macro with a printf-formatted value
1535 // @name: the name of the macro
1536 // @weak: 0/1 for a normal or a weak define
1537 // @fmt: the printf format followed by it's arguments.
1539 // The type of the value is automatically infered:
1540 // TOKEN_NUMBER if it starts by a digit, TOKEN_IDENT otherwise.
1541 // If @fmt is null or empty, the macro is defined with an empty definition.
1542 void predefine(const char *name, int weak, const char *fmt, ...)
1544 struct ident *ident = built_in_ident(name);
1545 struct token *value = &eof_token_entry;
1546 int attr = weak ? SYM_ATTR_WEAK : SYM_ATTR_NORMAL;
1548 if (fmt && fmt[0]) {
1549 static char buf[256];
1550 va_list ap;
1552 va_start(ap, fmt);
1553 vsnprintf(buf, sizeof(buf), fmt, ap);
1554 va_end(ap);
1556 value = __alloc_token(0);
1557 if (isdigit(buf[0])) {
1558 token_type(value) = TOKEN_NUMBER;
1559 value->number = xstrdup(buf);
1560 } else {
1561 token_type(value) = TOKEN_IDENT;
1562 value->ident = built_in_ident(buf);
1564 value->pos.whitespace = 1;
1565 value->next = &eof_token_entry;
1568 do_define(value->pos, NULL, ident, NULL, value, attr);
1571 static int do_handle_define(struct stream *stream, struct token **line, struct token *token, int attr)
1573 struct token *arglist, *expansion;
1574 struct token *left = token->next;
1575 struct ident *name;
1577 if (token_type(left) != TOKEN_IDENT) {
1578 sparse_error(token->pos, "expected identifier to 'define'");
1579 return 1;
1582 name = left->ident;
1584 arglist = NULL;
1585 expansion = left->next;
1586 if (!expansion->pos.whitespace) {
1587 if (match_op(expansion, '(')) {
1588 arglist = expansion;
1589 expansion = parse_arguments(expansion);
1590 if (!expansion)
1591 return 1;
1592 } else if (!eof_token(expansion)) {
1593 warning(expansion->pos,
1594 "no whitespace before object-like macro body");
1598 return do_define(left->pos, token, name, arglist, expansion, attr);
1601 static int handle_define(struct stream *stream, struct token **line, struct token *token)
1603 return do_handle_define(stream, line, token, SYM_ATTR_NORMAL);
1606 static int handle_weak_define(struct stream *stream, struct token **line, struct token *token)
1608 return do_handle_define(stream, line, token, SYM_ATTR_WEAK);
1611 static int handle_strong_define(struct stream *stream, struct token **line, struct token *token)
1613 return do_handle_define(stream, line, token, SYM_ATTR_STRONG);
1616 static int do_handle_undef(struct stream *stream, struct token **line, struct token *token, int attr)
1618 struct token *left = token->next;
1619 struct symbol *sym;
1621 if (token_type(left) != TOKEN_IDENT) {
1622 sparse_error(token->pos, "expected identifier to 'undef'");
1623 return 1;
1626 sym = lookup_symbol(left->ident, NS_MACRO | NS_UNDEF);
1627 if (sym) {
1628 if (attr < sym->attr)
1629 return 1;
1630 if (attr == sym->attr && sym->namespace == NS_UNDEF)
1631 return 1;
1632 } else if (attr <= SYM_ATTR_NORMAL)
1633 return 1;
1635 if (!sym || sym->scope != file_scope) {
1636 sym = alloc_symbol(left->pos, SYM_NODE);
1637 bind_symbol(sym, left->ident, NS_MACRO);
1640 sym->namespace = NS_UNDEF;
1641 sym->used_in = NULL;
1642 sym->attr = attr;
1644 return 1;
1647 static int handle_undef(struct stream *stream, struct token **line, struct token *token)
1649 return do_handle_undef(stream, line, token, SYM_ATTR_NORMAL);
1652 static int handle_strong_undef(struct stream *stream, struct token **line, struct token *token)
1654 return do_handle_undef(stream, line, token, SYM_ATTR_STRONG);
1657 static int preprocessor_if(struct stream *stream, struct token *token, int cond)
1659 token_type(token) = false_nesting ? TOKEN_SKIP_GROUPS : TOKEN_IF;
1660 free_preprocessor_line(token->next);
1661 token->next = stream->top_if;
1662 stream->top_if = token;
1663 if (false_nesting || cond != 1)
1664 false_nesting++;
1665 return 0;
1668 static int handle_ifdef(struct stream *stream, struct token **line, struct token *token)
1670 struct token *next = token->next;
1671 int arg;
1672 if (token_type(next) == TOKEN_IDENT) {
1673 arg = token_defined(next);
1674 } else {
1675 dirty_stream(stream);
1676 if (!false_nesting)
1677 sparse_error(token->pos, "expected preprocessor identifier");
1678 arg = -1;
1680 return preprocessor_if(stream, token, arg);
1683 static int handle_ifndef(struct stream *stream, struct token **line, struct token *token)
1685 struct token *next = token->next;
1686 int arg;
1687 if (token_type(next) == TOKEN_IDENT) {
1688 if (!stream->dirty && !stream->ifndef) {
1689 if (!stream->protect) {
1690 stream->ifndef = token;
1691 stream->protect = next->ident;
1692 } else if (stream->protect == next->ident) {
1693 stream->ifndef = token;
1694 stream->dirty = 1;
1697 arg = !token_defined(next);
1698 } else {
1699 dirty_stream(stream);
1700 if (!false_nesting)
1701 sparse_error(token->pos, "expected preprocessor identifier");
1702 arg = -1;
1705 return preprocessor_if(stream, token, arg);
1708 static const char *show_token_sequence(struct token *token, int quote);
1711 * Expression handling for #if and #elif; it differs from normal expansion
1712 * due to special treatment of "defined".
1714 static int expression_value(struct token **where)
1716 struct expression *expr;
1717 struct token *p;
1718 struct token **list = where, **beginning = NULL;
1719 long long value;
1720 int state = 0;
1722 while (!eof_token(p = scan_next(list))) {
1723 switch (state) {
1724 case 0:
1725 if (token_type(p) != TOKEN_IDENT)
1726 break;
1727 if (p->ident == &defined_ident) {
1728 state = 1;
1729 beginning = list;
1730 break;
1731 } else if (p->ident == &__has_builtin_ident) {
1732 state = 4;
1733 beginning = list;
1734 break;
1735 } else if (p->ident == &__has_attribute_ident) {
1736 state = 6;
1737 beginning = list;
1738 break;
1740 if (!expand_one_symbol(list))
1741 continue;
1742 if (token_type(p) != TOKEN_IDENT)
1743 break;
1744 token_type(p) = TOKEN_ZERO_IDENT;
1745 break;
1746 case 1:
1747 if (match_op(p, '(')) {
1748 state = 2;
1749 } else {
1750 state = 0;
1751 replace_with_defined(p);
1752 *beginning = p;
1754 break;
1755 case 2:
1756 if (token_type(p) == TOKEN_IDENT)
1757 state = 3;
1758 else
1759 state = 0;
1760 replace_with_defined(p);
1761 *beginning = p;
1762 break;
1763 case 3:
1764 state = 0;
1765 if (!match_op(p, ')'))
1766 sparse_error(p->pos, "missing ')' after \"defined\"");
1767 *list = p->next;
1768 continue;
1770 // __has_builtin(x) or __has_attribute(x)
1771 case 4: case 6:
1772 if (match_op(p, '(')) {
1773 state++;
1774 } else {
1775 sparse_error(p->pos, "missing '(' after \"__has_%s\"",
1776 state == 4 ? "builtin" : "attribute");
1777 state = 0;
1779 *beginning = p;
1780 break;
1781 case 5: case 7:
1782 if (token_type(p) != TOKEN_IDENT) {
1783 sparse_error(p->pos, "identifier expected");
1784 state = 0;
1785 break;
1787 if (!match_op(p->next, ')'))
1788 sparse_error(p->pos, "missing ')' after \"__has_%s\"",
1789 state == 5 ? "builtin" : "attribute");
1790 if (state == 5)
1791 replace_with_has_builtin(p);
1792 else
1793 replace_with_has_attribute(p);
1794 state = 8;
1795 *beginning = p;
1796 break;
1797 case 8:
1798 state = 0;
1799 *list = p->next;
1800 continue;
1802 list = &p->next;
1805 p = constant_expression(*where, &expr);
1806 if (!eof_token(p))
1807 sparse_error(p->pos, "garbage at end: %s", show_token_sequence(p, 0));
1808 value = get_expression_value(expr);
1809 return value != 0;
1812 static int handle_if(struct stream *stream, struct token **line, struct token *token)
1814 int value = 0;
1815 if (!false_nesting)
1816 value = expression_value(&token->next);
1818 dirty_stream(stream);
1819 return preprocessor_if(stream, token, value);
1822 static int handle_elif(struct stream * stream, struct token **line, struct token *token)
1824 struct token *top_if = stream->top_if;
1825 end_group(stream);
1827 if (!top_if) {
1828 nesting_error(stream);
1829 sparse_error(token->pos, "unmatched #elif within stream");
1830 return 1;
1833 if (token_type(top_if) == TOKEN_ELSE) {
1834 nesting_error(stream);
1835 sparse_error(token->pos, "#elif after #else");
1836 if (!false_nesting)
1837 false_nesting = 1;
1838 return 1;
1841 dirty_stream(stream);
1842 if (token_type(top_if) != TOKEN_IF)
1843 return 1;
1844 if (false_nesting) {
1845 false_nesting = 0;
1846 if (!expression_value(&token->next))
1847 false_nesting = 1;
1848 } else {
1849 false_nesting = 1;
1850 token_type(top_if) = TOKEN_SKIP_GROUPS;
1852 return 1;
1855 static int handle_else(struct stream *stream, struct token **line, struct token *token)
1857 struct token *top_if = stream->top_if;
1858 end_group(stream);
1860 if (!top_if) {
1861 nesting_error(stream);
1862 sparse_error(token->pos, "unmatched #else within stream");
1863 return 1;
1866 if (token_type(top_if) == TOKEN_ELSE) {
1867 nesting_error(stream);
1868 sparse_error(token->pos, "#else after #else");
1870 if (false_nesting) {
1871 if (token_type(top_if) == TOKEN_IF)
1872 false_nesting = 0;
1873 } else {
1874 false_nesting = 1;
1876 token_type(top_if) = TOKEN_ELSE;
1877 return 1;
1880 static int handle_endif(struct stream *stream, struct token **line, struct token *token)
1882 struct token *top_if = stream->top_if;
1883 end_group(stream);
1884 if (!top_if) {
1885 nesting_error(stream);
1886 sparse_error(token->pos, "unmatched #endif in stream");
1887 return 1;
1889 if (false_nesting)
1890 false_nesting--;
1891 stream->top_if = top_if->next;
1892 __free_token(top_if);
1893 return 1;
1896 static int handle_warning(struct stream *stream, struct token **line, struct token *token)
1898 warning(token->pos, "%s", show_token_sequence(token->next, 0));
1899 return 1;
1902 static int handle_error(struct stream *stream, struct token **line, struct token *token)
1904 sparse_error(token->pos, "%s", show_token_sequence(token->next, 0));
1905 return 1;
1908 static int handle_nostdinc(struct stream *stream, struct token **line, struct token *token)
1911 * Do we have any non-system includes?
1912 * Clear them out if so..
1914 *sys_includepath = NULL;
1915 return 1;
1918 static inline void update_inc_ptrs(const char ***where)
1921 if (*where <= dirafter_includepath) {
1922 dirafter_includepath++;
1923 /* If this was the entry that we prepend, don't
1924 * rise the lower entries, even if they are at
1925 * the same level. */
1926 if (where == &dirafter_includepath)
1927 return;
1929 if (*where <= sys_includepath) {
1930 sys_includepath++;
1931 if (where == &sys_includepath)
1932 return;
1934 if (*where <= isys_includepath) {
1935 isys_includepath++;
1936 if (where == &isys_includepath)
1937 return;
1940 /* angle_includepath is actually never updated, since we
1941 * don't suppport -iquote rught now. May change some day. */
1942 if (*where <= angle_includepath) {
1943 angle_includepath++;
1944 if (where == &angle_includepath)
1945 return;
1949 /* Add a path before 'where' and update the pointers associated with the
1950 * includepath array */
1951 static void add_path_entry(struct token *token, const char *path,
1952 const char ***where)
1954 const char **dst;
1955 const char *next;
1957 /* Need one free entry.. */
1958 if (includepath[INCLUDEPATHS-2])
1959 error_die(token->pos, "too many include path entries");
1961 /* check that this is not a duplicate */
1962 dst = includepath;
1963 while (*dst) {
1964 if (strcmp(*dst, path) == 0)
1965 return;
1966 dst++;
1968 next = path;
1969 dst = *where;
1971 update_inc_ptrs(where);
1974 * Move them all up starting at dst,
1975 * insert the new entry..
1977 do {
1978 const char *tmp = *dst;
1979 *dst = next;
1980 next = tmp;
1981 dst++;
1982 } while (next);
1985 static int handle_add_include(struct stream *stream, struct token **line, struct token *token)
1987 for (;;) {
1988 token = token->next;
1989 if (eof_token(token))
1990 return 1;
1991 if (token_type(token) != TOKEN_STRING) {
1992 warning(token->pos, "expected path string");
1993 return 1;
1995 add_path_entry(token, token->string->data, &isys_includepath);
1999 static int handle_add_isystem(struct stream *stream, struct token **line, struct token *token)
2001 for (;;) {
2002 token = token->next;
2003 if (eof_token(token))
2004 return 1;
2005 if (token_type(token) != TOKEN_STRING) {
2006 sparse_error(token->pos, "expected path string");
2007 return 1;
2009 add_path_entry(token, token->string->data, &sys_includepath);
2013 static int handle_add_system(struct stream *stream, struct token **line, struct token *token)
2015 for (;;) {
2016 token = token->next;
2017 if (eof_token(token))
2018 return 1;
2019 if (token_type(token) != TOKEN_STRING) {
2020 sparse_error(token->pos, "expected path string");
2021 return 1;
2023 add_path_entry(token, token->string->data, &dirafter_includepath);
2027 /* Add to end on includepath list - no pointer updates */
2028 static void add_dirafter_entry(struct token *token, const char *path)
2030 const char **dst = includepath;
2032 /* Need one free entry.. */
2033 if (includepath[INCLUDEPATHS-2])
2034 error_die(token->pos, "too many include path entries");
2036 /* Add to the end */
2037 while (*dst)
2038 dst++;
2039 *dst = path;
2040 dst++;
2041 *dst = NULL;
2044 static int handle_add_dirafter(struct stream *stream, struct token **line, struct token *token)
2046 for (;;) {
2047 token = token->next;
2048 if (eof_token(token))
2049 return 1;
2050 if (token_type(token) != TOKEN_STRING) {
2051 sparse_error(token->pos, "expected path string");
2052 return 1;
2054 add_dirafter_entry(token, token->string->data);
2058 static int handle_split_include(struct stream *stream, struct token **line, struct token *token)
2061 * -I-
2062 * From info gcc:
2063 * Split the include path. Any directories specified with `-I'
2064 * options before `-I-' are searched only for headers requested with
2065 * `#include "FILE"'; they are not searched for `#include <FILE>'.
2066 * If additional directories are specified with `-I' options after
2067 * the `-I-', those directories are searched for all `#include'
2068 * directives.
2069 * In addition, `-I-' inhibits the use of the directory of the current
2070 * file directory as the first search directory for `#include "FILE"'.
2072 quote_includepath = includepath+1;
2073 angle_includepath = sys_includepath;
2074 return 1;
2078 * We replace "#pragma xxx" with "__pragma__" in the token
2079 * stream. Just as an example.
2081 * We'll just #define that away for now, but the theory here
2082 * is that we can use this to insert arbitrary token sequences
2083 * to turn the pragmas into internal front-end sequences for
2084 * when we actually start caring about them.
2086 * So eventually this will turn into some kind of extended
2087 * __attribute__() like thing, except called __pragma__(xxx).
2089 static int handle_pragma(struct stream *stream, struct token **line, struct token *token)
2091 struct token *next = *line;
2093 if (match_ident(token->next, &once_ident) && eof_token(token->next->next)) {
2094 stream->once = 1;
2095 return 1;
2097 token->ident = &pragma_ident;
2098 token->pos.newline = 1;
2099 token->pos.whitespace = 1;
2100 token->pos.pos = 1;
2101 *line = token;
2102 token->next = next;
2103 return 0;
2107 * We ignore #line for now.
2109 static int handle_line(struct stream *stream, struct token **line, struct token *token)
2111 return 1;
2114 static int handle_ident(struct stream *stream, struct token **line, struct token *token)
2116 return 1;
2119 static int handle_nondirective(struct stream *stream, struct token **line, struct token *token)
2121 sparse_error(token->pos, "unrecognized preprocessor line '%s'", show_token_sequence(token, 0));
2122 return 1;
2126 static void init_preprocessor(void)
2128 int i;
2129 int stream = init_stream("preprocessor", -1, includepath);
2130 static struct {
2131 const char *name;
2132 int (*handler)(struct stream *, struct token **, struct token *);
2133 } normal[] = {
2134 { "define", handle_define },
2135 { "weak_define", handle_weak_define },
2136 { "strong_define", handle_strong_define },
2137 { "undef", handle_undef },
2138 { "strong_undef", handle_strong_undef },
2139 { "warning", handle_warning },
2140 { "error", handle_error },
2141 { "include", handle_include },
2142 { "include_next", handle_include_next },
2143 { "pragma", handle_pragma },
2144 { "line", handle_line },
2145 { "ident", handle_ident },
2147 // our internal preprocessor tokens
2148 { "nostdinc", handle_nostdinc },
2149 { "add_include", handle_add_include },
2150 { "add_isystem", handle_add_isystem },
2151 { "add_system", handle_add_system },
2152 { "add_dirafter", handle_add_dirafter },
2153 { "split_include", handle_split_include },
2154 { "argv_include", handle_argv_include },
2155 }, special[] = {
2156 { "ifdef", handle_ifdef },
2157 { "ifndef", handle_ifndef },
2158 { "else", handle_else },
2159 { "endif", handle_endif },
2160 { "if", handle_if },
2161 { "elif", handle_elif },
2163 static struct {
2164 const char *name;
2165 void (*expander)(struct token *);
2166 } dynamic[] = {
2167 { "__LINE__", expand_line },
2168 { "__FILE__", expand_file },
2169 { "__BASE_FILE__", expand_basefile },
2170 { "__DATE__", expand_date },
2171 { "__TIME__", expand_time },
2172 { "__COUNTER__", expand_counter },
2173 { "__INCLUDE_LEVEL__", expand_include_level },
2176 for (i = 0; i < ARRAY_SIZE(normal); i++) {
2177 struct symbol *sym;
2178 sym = create_symbol(stream, normal[i].name, SYM_PREPROCESSOR, NS_PREPROCESSOR);
2179 sym->handler = normal[i].handler;
2180 sym->normal = 1;
2182 for (i = 0; i < ARRAY_SIZE(special); i++) {
2183 struct symbol *sym;
2184 sym = create_symbol(stream, special[i].name, SYM_PREPROCESSOR, NS_PREPROCESSOR);
2185 sym->handler = special[i].handler;
2186 sym->normal = 0;
2188 for (i = 0; i < ARRAY_SIZE(dynamic); i++) {
2189 struct symbol *sym;
2190 sym = create_symbol(stream, dynamic[i].name, SYM_NODE, NS_MACRO);
2191 sym->expander = dynamic[i].expander;
2194 counter_macro = 0;
2197 static void handle_preprocessor_line(struct stream *stream, struct token **line, struct token *start)
2199 int (*handler)(struct stream *, struct token **, struct token *);
2200 struct token *token = start->next;
2201 int is_normal = 1;
2203 if (eof_token(token))
2204 return;
2206 if (token_type(token) == TOKEN_IDENT) {
2207 struct symbol *sym = lookup_symbol(token->ident, NS_PREPROCESSOR);
2208 if (sym) {
2209 handler = sym->handler;
2210 is_normal = sym->normal;
2211 } else {
2212 handler = handle_nondirective;
2214 } else if (token_type(token) == TOKEN_NUMBER) {
2215 handler = handle_line;
2216 } else {
2217 handler = handle_nondirective;
2220 if (is_normal) {
2221 dirty_stream(stream);
2222 if (false_nesting)
2223 goto out;
2225 if (!handler(stream, line, token)) /* all set */
2226 return;
2228 out:
2229 free_preprocessor_line(token);
2232 static void preprocessor_line(struct stream *stream, struct token **line)
2234 struct token *start = *line, *next;
2235 struct token **tp = &start->next;
2237 for (;;) {
2238 next = *tp;
2239 if (next->pos.newline)
2240 break;
2241 tp = &next->next;
2243 *line = next;
2244 *tp = &eof_token_entry;
2245 handle_preprocessor_line(stream, line, start);
2248 static void do_preprocess(struct token **list)
2250 struct token *next;
2252 while (!eof_token(next = scan_next(list))) {
2253 struct stream *stream = input_streams + next->pos.stream;
2255 if (next->pos.newline && match_op(next, '#')) {
2256 if (!next->pos.noexpand) {
2257 preprocessor_line(stream, list);
2258 __free_token(next); /* Free the '#' token */
2259 continue;
2263 switch (token_type(next)) {
2264 case TOKEN_STREAMEND:
2265 if (stream->top_if) {
2266 nesting_error(stream);
2267 sparse_error(stream->top_if->pos, "unterminated preprocessor conditional");
2268 stream->top_if = NULL;
2269 false_nesting = 0;
2271 if (!stream->dirty)
2272 stream->constant = CONSTANT_FILE_YES;
2273 *list = next->next;
2274 include_level--;
2275 continue;
2276 case TOKEN_STREAMBEGIN:
2277 *list = next->next;
2278 include_level++;
2279 continue;
2281 default:
2282 dirty_stream(stream);
2283 if (false_nesting) {
2284 *list = next->next;
2285 __free_token(next);
2286 continue;
2289 if (token_type(next) != TOKEN_IDENT ||
2290 expand_one_symbol(list))
2291 list = &next->next;
2296 void init_include_path(void)
2298 FILE *fp;
2299 char path[256];
2300 char arch[32];
2301 char os[32];
2303 fp = popen("/bin/uname -m", "r");
2304 if (!fp)
2305 return;
2306 if (!fgets(arch, sizeof(arch) - 1, fp))
2307 return;
2308 pclose(fp);
2309 if (arch[strlen(arch) - 1] == '\n')
2310 arch[strlen(arch) - 1] = '\0';
2312 fp = popen("/bin/uname -o", "r");
2313 if (!fp)
2314 return;
2315 fgets(os, sizeof(os) - 1, fp);
2316 pclose(fp);
2318 if (strcmp(os, "GNU/Linux\n") != 0)
2319 return;
2320 strcpy(os, "linux-gnu");
2322 snprintf(path, sizeof(path), "/usr/include/%s-%s/", arch, os);
2323 add_pre_buffer("#add_system \"%s/\"\n", path);
2326 struct token * preprocess(struct token *token)
2328 preprocessing = 1;
2329 init_preprocessor();
2330 do_preprocess(&token);
2332 // Drop all expressions from preprocessing, they're not used any more.
2333 // This is not true when we have multiple files, though ;/
2334 // clear_expression_alloc();
2335 preprocessing = 0;
2337 return token;
2340 static int is_VA_ARGS_token(struct token *token)
2342 return (token_type(token) == TOKEN_IDENT) &&
2343 (token->ident == &__VA_ARGS___ident);
2346 static void dump_macro(struct symbol *sym)
2348 int nargs = sym->arglist ? sym->arglist->count.normal : 0;
2349 struct token *args[nargs];
2350 struct token *token;
2352 printf("#define %s", show_ident(sym->ident));
2353 token = sym->arglist;
2354 if (token) {
2355 const char *sep = "";
2356 int narg = 0;
2357 putchar('(');
2358 for (; !eof_token(token); token = token->next) {
2359 if (token_type(token) == TOKEN_ARG_COUNT)
2360 continue;
2361 if (is_VA_ARGS_token(token))
2362 printf("%s...", sep);
2363 else
2364 printf("%s%s", sep, show_token(token));
2365 args[narg++] = token;
2366 sep = ",";
2368 putchar(')');
2371 token = sym->expansion;
2372 while (token_type(token) != TOKEN_UNTAINT) {
2373 struct token *next = token->next;
2374 if (token->pos.whitespace)
2375 putchar(' ');
2376 switch (token_type(token)) {
2377 case TOKEN_CONCAT:
2378 printf("##");
2379 break;
2380 case TOKEN_STR_ARGUMENT:
2381 printf("#");
2382 /* fall-through */
2383 case TOKEN_QUOTED_ARGUMENT:
2384 case TOKEN_MACRO_ARGUMENT:
2385 token = args[token->argnum];
2386 /* fall-through */
2387 default:
2388 printf("%s", show_token(token));
2390 token = next;
2392 putchar('\n');
2395 void dump_macro_definitions(void)
2397 struct ident *name;
2399 FOR_EACH_PTR(macros, name) {
2400 struct symbol *sym = lookup_macro(name);
2401 if (sym)
2402 dump_macro(sym);
2403 } END_FOR_EACH_PTR(name);