preprocessor: implement stringify operation '#'
[cparser] / preprocessor.c
1 #include <config.h>
2
3 #include <assert.h>
4 #include <errno.h>
5 #include <string.h>
6 #include <stdbool.h>
7 #include <ctype.h>
8
9 #include "preprocessor.h"
10 #include "token_t.h"
11 #include "symbol_t.h"
12 #include "adt/util.h"
13 #include "adt/error.h"
14 #include "adt/strutil.h"
15 #include "adt/strset.h"
16 #include "lang_features.h"
17 #include "diagnostic.h"
18 #include "string_rep.h"
19 #include "input.h"
20
21 #define MAX_PUTBACK 3
22 #define INCLUDE_LIMIT 199  /* 199 is for gcc "compatibility" */
23
24 typedef struct saved_token_t {
25         token_t token;
26         bool    had_whitespace;
27 } saved_token_t;
28
29 typedef struct whitespace_info_t {
30         /** current token had whitespace in front of it */
31         bool     had_whitespace;
32         /** current token is at the beginning of a line.
33          * => a "#" at line begin starts a preprocessing directive. */
34         bool     at_line_begin;
35         /** number of spaces before the first token in a line */
36         unsigned whitespace_at_line_begin;
37 } whitespace_info_t;
38
39 struct pp_definition_t {
40         symbol_t          *symbol;
41         source_position_t  source_position;
42         pp_definition_t   *parent_expansion;
43         size_t             expand_pos;
44         whitespace_info_t  expand_info;
45         bool               is_variadic    : 1;
46         bool               is_expanding   : 1;
47         bool               has_parameters : 1;
48         bool               is_parameter   : 1;
49         pp_definition_t   *function_definition;
50         size_t             n_parameters;
51         pp_definition_t   *parameters;
52
53         /* replacement */
54         size_t             list_len;
55         saved_token_t     *token_list;
56 };
57
58 typedef struct pp_conditional_t pp_conditional_t;
59 struct pp_conditional_t {
60         source_position_t  source_position;
61         bool               condition;
62         bool               in_else;
63         /** conditional in skip mode (then+else gets skipped) */
64         bool               skip;
65         pp_conditional_t  *parent;
66 };
67
68 typedef struct pp_input_t pp_input_t;
69 struct pp_input_t {
70         FILE               *file;
71         input_t            *input;
72         utf32               c;
73         utf32               buf[1024+MAX_PUTBACK];
74         const utf32        *bufend;
75         const utf32        *bufpos;
76         source_position_t   position;
77         pp_input_t         *parent;
78         unsigned            output_line;
79         searchpath_entry_t *path;
80 };
81
82 struct searchpath_entry_t {
83         const char         *path;
84         searchpath_entry_t *next;
85 };
86
87 static pp_input_t      input;
88
89 static pp_input_t     *input_stack;
90 static unsigned        n_inputs;
91 static struct obstack  input_obstack;
92
93 static pp_conditional_t *conditional_stack;
94
95 token_t                  pp_token;
96 bool                     allow_dollar_in_symbol   = true;
97 static bool              resolve_escape_sequences = true;
98 static bool              error_on_unknown_chars   = true;
99 static bool              skip_mode;
100 static FILE             *out;
101 static struct obstack    pp_obstack;
102 static struct obstack    config_obstack;
103 static const char       *printed_input_name = NULL;
104 static source_position_t expansion_pos;
105 static pp_definition_t  *current_expansion  = NULL;
106 static pp_definition_t  *current_call       = NULL;
107 static pp_definition_t  *current_argument   = NULL;
108 static pp_definition_t  *argument_expanding = NULL;
109 static unsigned          argument_brace_count;
110 static strset_t          stringset;
111 static token_kind_t      last_token;
112
113 static searchpath_entry_t *searchpath;
114
115 static whitespace_info_t next_info; /* valid if had_whitespace is true */
116 static whitespace_info_t info;
117
118 static inline void next_char(void);
119 static void next_input_token(void);
120 static void print_line_directive(const source_position_t *pos, const char *add);
121
122 static symbol_t *symbol_colongreater;
123 static symbol_t *symbol_lesscolon;
124 static symbol_t *symbol_lesspercent;
125 static symbol_t *symbol_percentcolon;
126 static symbol_t *symbol_percentcolonpercentcolon;
127 static symbol_t *symbol_percentgreater;
128
129 static void init_symbols(void)
130 {
131         symbol_colongreater             = symbol_table_insert(":>");
132         symbol_lesscolon                = symbol_table_insert("<:");
133         symbol_lesspercent              = symbol_table_insert("<%");
134         symbol_percentcolon             = symbol_table_insert("%:");
135         symbol_percentcolonpercentcolon = symbol_table_insert("%:%:");
136         symbol_percentgreater           = symbol_table_insert("%>");
137 }
138
139 void switch_pp_input(FILE *const file, char const *const filename, searchpath_entry_t *const path)
140 {
141         input.file                = file;
142         input.input               = input_from_stream(file, NULL);
143         input.bufend              = NULL;
144         input.bufpos              = NULL;
145         input.output_line         = 0;
146         input.position.input_name = filename;
147         input.position.lineno     = 1;
148         input.path                = path;
149
150         /* indicate that we're at a new input */
151         print_line_directive(&input.position, input_stack != NULL ? "1" : NULL);
152
153         /* place a virtual '\n' so we realize we're at line begin */
154         input.position.lineno = 0;
155         input.c               = '\n';
156 }
157
158 FILE *close_pp_input(void)
159 {
160         input_free(input.input);
161
162         FILE* const file = input.file;
163         assert(file);
164
165         input.input  = NULL;
166         input.file   = NULL;
167         input.bufend = NULL;
168         input.bufpos = NULL;
169         input.c      = EOF;
170
171         return file;
172 }
173
174 static void push_input(void)
175 {
176         pp_input_t *const saved_input = obstack_copy(&input_obstack, &input, sizeof(input));
177
178         /* adjust buffer positions */
179         if (input.bufpos != NULL)
180                 saved_input->bufpos = saved_input->buf + (input.bufpos - input.buf);
181         if (input.bufend != NULL)
182                 saved_input->bufend = saved_input->buf + (input.bufend - input.buf);
183
184         saved_input->parent = input_stack;
185         input_stack         = saved_input;
186         ++n_inputs;
187 }
188
189 static void pop_restore_input(void)
190 {
191         assert(n_inputs > 0);
192         assert(input_stack != NULL);
193
194         pp_input_t *saved_input = input_stack;
195
196         memcpy(&input, saved_input, sizeof(input));
197         input.parent = NULL;
198
199         /* adjust buffer positions */
200         if (saved_input->bufpos != NULL)
201                 input.bufpos = input.buf + (saved_input->bufpos - saved_input->buf);
202         if (saved_input->bufend != NULL)
203                 input.bufend = input.buf + (saved_input->bufend - saved_input->buf);
204
205         input_stack = saved_input->parent;
206         obstack_free(&input_obstack, saved_input);
207         --n_inputs;
208 }
209
210 /**
211  * Prints a parse error message at the current token.
212  *
213  * @param msg   the error message
214  */
215 static void parse_error(const char *msg)
216 {
217         errorf(&pp_token.base.source_position,  "%s", msg);
218 }
219
220 static inline void next_real_char(void)
221 {
222         assert(input.bufpos <= input.bufend);
223         if (input.bufpos >= input.bufend) {
224                 size_t const n = decode(input.input, input.buf + MAX_PUTBACK, lengthof(input.buf) - MAX_PUTBACK);
225                 if (n == 0) {
226                         input.c = EOF;
227                         return;
228                 }
229                 input.bufpos = input.buf + MAX_PUTBACK;
230                 input.bufend = input.bufpos + n;
231         }
232         input.c = *input.bufpos++;
233         ++input.position.colno;
234 }
235
236 /**
237  * Put a character back into the buffer.
238  *
239  * @param pc  the character to put back
240  */
241 static inline void put_back(utf32 const pc)
242 {
243         assert(input.bufpos > input.buf);
244         *(--input.bufpos - input.buf + input.buf) = (char) pc;
245         --input.position.colno;
246 }
247
248 #define NEWLINE \
249         '\r': \
250                 next_char(); \
251                 if (input.c == '\n') { \
252         case '\n': \
253                         next_char(); \
254                 } \
255                 ++input.position.lineno; \
256                 input.position.colno = 1; \
257                 goto newline; \
258                 newline // Let it look like an ordinary case label.
259
260 #define eat(c_type) (assert(input.c == c_type), next_char())
261
262 static void maybe_concat_lines(void)
263 {
264         eat('\\');
265
266         switch (input.c) {
267         case NEWLINE:
268                 info.whitespace_at_line_begin = 0;
269                 return;
270
271         default:
272                 break;
273         }
274
275         put_back(input.c);
276         input.c = '\\';
277 }
278
279 /**
280  * Set c to the next input character, ie.
281  * after expanding trigraphs.
282  */
283 static inline void next_char(void)
284 {
285         next_real_char();
286
287         /* filter trigraphs and concatenated lines */
288         if (UNLIKELY(input.c == '\\')) {
289                 maybe_concat_lines();
290                 goto end_of_next_char;
291         }
292
293         if (LIKELY(input.c != '?'))
294                 goto end_of_next_char;
295
296         next_real_char();
297         if (LIKELY(input.c != '?')) {
298                 put_back(input.c);
299                 input.c = '?';
300                 goto end_of_next_char;
301         }
302
303         next_real_char();
304         switch (input.c) {
305         case '=': input.c = '#'; break;
306         case '(': input.c = '['; break;
307         case '/': input.c = '\\'; maybe_concat_lines(); break;
308         case ')': input.c = ']'; break;
309         case '\'': input.c = '^'; break;
310         case '<': input.c = '{'; break;
311         case '!': input.c = '|'; break;
312         case '>': input.c = '}'; break;
313         case '-': input.c = '~'; break;
314         default:
315                 put_back(input.c);
316                 put_back('?');
317                 input.c = '?';
318                 break;
319         }
320
321 end_of_next_char:;
322 #ifdef DEBUG_CHARS
323         printf("nchar '%c'\n", input.c);
324 #endif
325 }
326
327
328
329 /**
330  * Returns true if the given char is a octal digit.
331  *
332  * @param char  the character to check
333  */
334 static inline bool is_octal_digit(int chr)
335 {
336         switch (chr) {
337         case '0':
338         case '1':
339         case '2':
340         case '3':
341         case '4':
342         case '5':
343         case '6':
344         case '7':
345                 return true;
346         default:
347                 return false;
348         }
349 }
350
351 /**
352  * Returns the value of a digit.
353  * The only portable way to do it ...
354  */
355 static int digit_value(int digit)
356 {
357         switch (digit) {
358         case '0': return 0;
359         case '1': return 1;
360         case '2': return 2;
361         case '3': return 3;
362         case '4': return 4;
363         case '5': return 5;
364         case '6': return 6;
365         case '7': return 7;
366         case '8': return 8;
367         case '9': return 9;
368         case 'a':
369         case 'A': return 10;
370         case 'b':
371         case 'B': return 11;
372         case 'c':
373         case 'C': return 12;
374         case 'd':
375         case 'D': return 13;
376         case 'e':
377         case 'E': return 14;
378         case 'f':
379         case 'F': return 15;
380         default:
381                 panic("wrong character given");
382         }
383 }
384
385 /**
386  * Parses an octal character sequence.
387  *
388  * @param first_digit  the already read first digit
389  */
390 static utf32 parse_octal_sequence(const utf32 first_digit)
391 {
392         assert(is_octal_digit(first_digit));
393         utf32 value = digit_value(first_digit);
394         if (!is_octal_digit(input.c)) return value;
395         value = 8 * value + digit_value(input.c);
396         next_char();
397         if (!is_octal_digit(input.c)) return value;
398         value = 8 * value + digit_value(input.c);
399         next_char();
400         return value;
401
402 }
403
404 /**
405  * Parses a hex character sequence.
406  */
407 static utf32 parse_hex_sequence(void)
408 {
409         utf32 value = 0;
410         while (isxdigit(input.c)) {
411                 value = 16 * value + digit_value(input.c);
412                 next_char();
413         }
414         return value;
415 }
416
417 static bool is_universal_char_valid(utf32 const v)
418 {
419         /* C11 Â§6.4.3:2 */
420         if (v < 0xA0U && v != 0x24 && v != 0x40 && v != 0x60)
421                 return false;
422         if (0xD800 <= v && v <= 0xDFFF)
423                 return false;
424         return true;
425 }
426
427 static utf32 parse_universal_char(unsigned const n_digits)
428 {
429         utf32 v = 0;
430         for (unsigned k = n_digits; k != 0; --k) {
431                 if (isxdigit(input.c)) {
432                         v = 16 * v + digit_value(input.c);
433                         if (!resolve_escape_sequences)
434                                 obstack_1grow(&symbol_obstack, input.c);
435                         next_char();
436                 } else {
437                         errorf(&input.position,
438                                "short universal character name, expected %u more digits",
439                                    k);
440                         break;
441                 }
442         }
443         if (!is_universal_char_valid(v)) {
444                 errorf(&input.position,
445                        "\\%c%0*X is not a valid universal character name",
446                        n_digits == 4 ? 'u' : 'U', (int)n_digits, v);
447         }
448         return v;
449 }
450
451 static bool is_universal_char_valid_identifier(utf32 const v)
452 {
453         /* C11 Annex D.1 */
454         if (                v == 0x000A8) return true;
455         if (                v == 0x000AA) return true;
456         if (                v == 0x000AD) return true;
457         if (                v == 0x000AF) return true;
458         if (0x000B2 <= v && v <= 0x000B5) return true;
459         if (0x000B7 <= v && v <= 0x000BA) return true;
460         if (0x000BC <= v && v <= 0x000BE) return true;
461         if (0x000C0 <= v && v <= 0x000D6) return true;
462         if (0x000D8 <= v && v <= 0x000F6) return true;
463         if (0x000F8 <= v && v <= 0x000FF) return true;
464         if (0x00100 <= v && v <= 0x0167F) return true;
465         if (0x01681 <= v && v <= 0x0180D) return true;
466         if (0x0180F <= v && v <= 0x01FFF) return true;
467         if (0x0200B <= v && v <= 0x0200D) return true;
468         if (0x0202A <= v && v <= 0x0202E) return true;
469         if (0x0203F <= v && v <= 0x02040) return true;
470         if (                v == 0x02054) return true;
471         if (0x02060 <= v && v <= 0x0206F) return true;
472         if (0x02070 <= v && v <= 0x0218F) return true;
473         if (0x02460 <= v && v <= 0x024FF) return true;
474         if (0x02776 <= v && v <= 0x02793) return true;
475         if (0x02C00 <= v && v <= 0x02DFF) return true;
476         if (0x02E80 <= v && v <= 0x02FFF) return true;
477         if (0x03004 <= v && v <= 0x03007) return true;
478         if (0x03021 <= v && v <= 0x0302F) return true;
479         if (0x03031 <= v && v <= 0x0303F) return true;
480         if (0x03040 <= v && v <= 0x0D7FF) return true;
481         if (0x0F900 <= v && v <= 0x0FD3D) return true;
482         if (0x0FD40 <= v && v <= 0x0FDCF) return true;
483         if (0x0FDF0 <= v && v <= 0x0FE44) return true;
484         if (0x0FE47 <= v && v <= 0x0FFFD) return true;
485         if (0x10000 <= v && v <= 0x1FFFD) return true;
486         if (0x20000 <= v && v <= 0x2FFFD) return true;
487         if (0x30000 <= v && v <= 0x3FFFD) return true;
488         if (0x40000 <= v && v <= 0x4FFFD) return true;
489         if (0x50000 <= v && v <= 0x5FFFD) return true;
490         if (0x60000 <= v && v <= 0x6FFFD) return true;
491         if (0x70000 <= v && v <= 0x7FFFD) return true;
492         if (0x80000 <= v && v <= 0x8FFFD) return true;
493         if (0x90000 <= v && v <= 0x9FFFD) return true;
494         if (0xA0000 <= v && v <= 0xAFFFD) return true;
495         if (0xB0000 <= v && v <= 0xBFFFD) return true;
496         if (0xC0000 <= v && v <= 0xCFFFD) return true;
497         if (0xD0000 <= v && v <= 0xDFFFD) return true;
498         if (0xE0000 <= v && v <= 0xEFFFD) return true;
499         return false;
500 }
501
502 static bool is_universal_char_valid_identifier_start(utf32 const v)
503 {
504         /* C11 Annex D.2 */
505         if (0x0300 <= v && v <= 0x036F) return false;
506         if (0x1DC0 <= v && v <= 0x1DFF) return false;
507         if (0x20D0 <= v && v <= 0x20FF) return false;
508         if (0xFE20 <= v && v <= 0xFE2F) return false;
509         return true;
510 }
511
512 /**
513  * Parse an escape sequence.
514  */
515 static utf32 parse_escape_sequence(void)
516 {
517         eat('\\');
518
519         utf32 const ec = input.c;
520         next_char();
521
522         switch (ec) {
523         case '"':  return '"';
524         case '\'': return '\'';
525         case '\\': return '\\';
526         case '?': return '\?';
527         case 'a': return '\a';
528         case 'b': return '\b';
529         case 'f': return '\f';
530         case 'n': return '\n';
531         case 'r': return '\r';
532         case 't': return '\t';
533         case 'v': return '\v';
534         case 'x':
535                 return parse_hex_sequence();
536         case '0':
537         case '1':
538         case '2':
539         case '3':
540         case '4':
541         case '5':
542         case '6':
543         case '7':
544                 return parse_octal_sequence(ec);
545         case EOF:
546                 parse_error("reached end of file while parsing escape sequence");
547                 return EOF;
548         /* \E is not documented, but handled, by GCC.  It is acceptable according
549          * to Â§6.11.4, whereas \e is not. */
550         case 'E':
551         case 'e':
552                 if (c_mode & _GNUC)
553                         return 27;   /* hopefully 27 is ALWAYS the code for ESCAPE */
554                 break;
555
556         case 'U': return parse_universal_char(8);
557         case 'u': return parse_universal_char(4);
558
559         default:
560                 break;
561         }
562         /* Â§6.4.4.4:8 footnote 64 */
563         parse_error("unknown escape sequence");
564         return EOF;
565 }
566
567 static const char *identify_string(char *string)
568 {
569         const char *result = strset_insert(&stringset, string);
570         if (result != string) {
571                 obstack_free(&symbol_obstack, string);
572         }
573         return result;
574 }
575
576 static string_t sym_make_string(string_encoding_t const enc)
577 {
578         obstack_1grow(&symbol_obstack, '\0');
579         size_t      const len    = obstack_object_size(&symbol_obstack) - 1;
580         char       *const string = obstack_finish(&symbol_obstack);
581         char const *const result = identify_string(string);
582         return (string_t){ result, len, enc };
583 }
584
585 string_t make_string(char const *const string)
586 {
587         obstack_grow(&symbol_obstack, string, strlen(string));
588         return sym_make_string(STRING_ENCODING_CHAR);
589 }
590
591 static void parse_string(utf32 const delimiter, token_kind_t const kind,
592                          string_encoding_t const enc,
593                          char const *const context)
594 {
595         const unsigned start_linenr = input.position.lineno;
596
597         eat(delimiter);
598
599         while (true) {
600                 switch (input.c) {
601                 case '\\': {
602                         if (resolve_escape_sequences) {
603                                 utf32 const tc = parse_escape_sequence();
604                                 if (enc == STRING_ENCODING_CHAR) {
605                                         if (tc >= 0x100) {
606                                                 warningf(WARN_OTHER, &pp_token.base.source_position, "escape sequence out of range");
607                                         }
608                                         obstack_1grow(&symbol_obstack, tc);
609                                 } else {
610                                         obstack_grow_utf8(&symbol_obstack, tc);
611                                 }
612                         } else {
613                                 obstack_1grow(&symbol_obstack, (char)input.c);
614                                 next_char();
615                                 obstack_1grow(&symbol_obstack, (char)input.c);
616                                 next_char();
617                         }
618                         break;
619                 }
620
621                 case NEWLINE:
622                         errorf(&pp_token.base.source_position, "newline while parsing %s", context);
623                         break;
624
625                 case EOF: {
626                         source_position_t source_position;
627                         source_position.input_name = pp_token.base.source_position.input_name;
628                         source_position.lineno     = start_linenr;
629                         errorf(&source_position, "EOF while parsing %s", context);
630                         goto end_of_string;
631                 }
632
633                 default:
634                         if (input.c == delimiter) {
635                                 next_char();
636                                 goto end_of_string;
637                         } else {
638                                 obstack_grow_utf8(&symbol_obstack, input.c);
639                                 next_char();
640                                 break;
641                         }
642                 }
643         }
644
645 end_of_string:
646         pp_token.kind           = kind;
647         pp_token.literal.string = sym_make_string(enc);
648 }
649
650 static void parse_string_literal(string_encoding_t const enc)
651 {
652         parse_string('"', T_STRING_LITERAL, enc, "string literal");
653 }
654
655 static void parse_character_constant(string_encoding_t const enc)
656 {
657         parse_string('\'', T_CHARACTER_CONSTANT, enc, "character constant");
658         if (pp_token.literal.string.size == 0) {
659                 parse_error("empty character constant");
660         }
661 }
662
663 #define SYMBOL_CASES_WITHOUT_E_P \
664              '$': if (!allow_dollar_in_symbol) goto dollar_sign; \
665         case 'a': \
666         case 'b': \
667         case 'c': \
668         case 'd': \
669         case 'f': \
670         case 'g': \
671         case 'h': \
672         case 'i': \
673         case 'j': \
674         case 'k': \
675         case 'l': \
676         case 'm': \
677         case 'n': \
678         case 'o': \
679         case 'q': \
680         case 'r': \
681         case 's': \
682         case 't': \
683         case 'u': \
684         case 'v': \
685         case 'w': \
686         case 'x': \
687         case 'y': \
688         case 'z': \
689         case 'A': \
690         case 'B': \
691         case 'C': \
692         case 'D': \
693         case 'F': \
694         case 'G': \
695         case 'H': \
696         case 'I': \
697         case 'J': \
698         case 'K': \
699         case 'L': \
700         case 'M': \
701         case 'N': \
702         case 'O': \
703         case 'Q': \
704         case 'R': \
705         case 'S': \
706         case 'T': \
707         case 'U': \
708         case 'V': \
709         case 'W': \
710         case 'X': \
711         case 'Y': \
712         case 'Z': \
713         case '_'
714
715 #define SYMBOL_CASES \
716              SYMBOL_CASES_WITHOUT_E_P: \
717         case 'e': \
718         case 'p': \
719         case 'E': \
720         case 'P'
721
722 #define DIGIT_CASES \
723              '0':  \
724         case '1':  \
725         case '2':  \
726         case '3':  \
727         case '4':  \
728         case '5':  \
729         case '6':  \
730         case '7':  \
731         case '8':  \
732         case '9'
733
734 static void start_expanding(pp_definition_t *definition)
735 {
736         definition->parent_expansion = current_expansion;
737         definition->expand_pos       = 0;
738         definition->is_expanding     = true;
739         if (definition->list_len > 0) {
740                 definition->token_list[0].had_whitespace
741                         = info.had_whitespace;
742         }
743         current_expansion = definition;
744 }
745
746 static void finished_expanding(pp_definition_t *definition)
747 {
748         assert(definition->is_expanding);
749         pp_definition_t *parent = definition->parent_expansion;
750         definition->parent_expansion = NULL;
751         definition->is_expanding     = false;
752
753         /* stop further expanding once we expanded a parameter used in a
754          * sub macro-call */
755         if (definition == argument_expanding)
756                 argument_expanding = NULL;
757
758         assert(current_expansion == definition);
759         current_expansion = parent;
760 }
761
762 static void grow_string_escaped(struct obstack *obst, const string_t *string, char const *delimiter)
763 {
764         char const *prefix = get_string_encoding_prefix(string->encoding);
765         obstack_printf(obst, "%s%s", prefix, delimiter);
766         size_t      size = string->size;
767         const char *str  = string->begin;
768         if (resolve_escape_sequences) {
769                 obstack_grow(obst, str, size);
770         } else {
771                 for (size_t i = 0; i < size; ++i) {
772                         const char c = str[i];
773                         if (c == '\\' || c == '"')
774                                 obstack_1grow(obst, '\\');
775                         obstack_1grow(obst, c);
776                 }
777         }
778         obstack_printf(obst, "%s", delimiter);
779 }
780
781 static void grow_token(struct obstack *obst, const token_t *token)
782 {
783         switch (token->kind) {
784         case T_NUMBER:
785                 obstack_grow(obst, token->literal.string.begin, token->literal.string.size);
786                 break;
787
788         case T_STRING_LITERAL: {
789                 char const *const delimiter = resolve_escape_sequences ? "\"" : "\\\"";
790                 grow_string_escaped(obst, &token->literal.string, delimiter);
791                 break;
792         }
793
794         case T_CHARACTER_CONSTANT:
795                 grow_string_escaped(obst, &token->literal.string, "'");
796                 break;
797
798         case T_IDENTIFIER:
799         default: {
800                 const char *str = token->base.symbol->string;
801                 size_t      len = strlen(str);
802                 obstack_grow(obst, str, len);
803                 break;
804         }
805         }
806 }
807
808 static void stringify(const pp_definition_t *definition)
809 {
810         assert(obstack_object_size(&symbol_obstack) == 0);
811
812         size_t list_len = definition->list_len;
813         for (size_t p = 0; p < list_len; ++p) {
814                 const saved_token_t *saved = &definition->token_list[p];
815                 if (p > 0 && saved->had_whitespace)
816                         obstack_1grow(&symbol_obstack, ' ');
817                 grow_token(&symbol_obstack, &saved->token);
818         }
819         pp_token.kind           = T_STRING_LITERAL;
820         pp_token.literal.string = sym_make_string(STRING_ENCODING_CHAR);
821 }
822
823 static inline void set_punctuator(token_kind_t const kind)
824 {
825         pp_token.kind        = kind;
826         pp_token.base.symbol = token_symbols[kind];
827 }
828
829 static inline void set_digraph(token_kind_t const kind, symbol_t *const symbol)
830 {
831         pp_token.kind        = kind;
832         pp_token.base.symbol = symbol;
833 }
834
835 /**
836  * returns next final token from a preprocessor macro expansion
837  */
838 static bool expand_next(void)
839 {
840         if (current_expansion == NULL)
841                 return false;
842
843 restart:;
844         size_t pos = current_expansion->expand_pos;
845         if (pos >= current_expansion->list_len) {
846                 finished_expanding(current_expansion);
847                 /* it was the outermost expansion, parse pptoken normally */
848                 if (current_expansion == NULL) {
849                         return false;
850                 }
851                 goto restart;
852         }
853         const saved_token_t *saved = &current_expansion->token_list[pos++];
854         pp_token = saved->token;
855         if (pp_token.kind == '#') {
856                 if (pos < current_expansion->list_len) {
857                         const saved_token_t *next = &current_expansion->token_list[pos];
858                         if (next->token.kind == T_MACRO_PARAMETER) {
859                                 pp_definition_t *def = next->token.macro_parameter.def;
860                                 assert(def != NULL && def->is_parameter);
861                                 stringify(def);
862                                 ++pos;
863                         }
864                 }
865         }
866
867         if (current_expansion->expand_pos > 0)
868                 info.had_whitespace = saved->had_whitespace;
869         current_expansion->expand_pos = pos;
870         pp_token.base.source_position = expansion_pos;
871
872         return true;
873 }
874
875 /**
876  * Returns the next token kind found when continuing the current expansions
877  * without starting new sub-expansions.
878  */
879 static token_kind_t peek_expansion(void)
880 {
881         for (pp_definition_t *e = current_expansion; e; e = e->parent_expansion) {
882                 if (e->expand_pos < e->list_len)
883                         return e->token_list[e->expand_pos].token.kind;
884         }
885         return T_EOF;
886 }
887
888 static void skip_line_comment(void)
889 {
890         info.had_whitespace = true;
891         while (true) {
892                 switch (input.c) {
893                 case EOF:
894                         return;
895
896                 case '\r':
897                 case '\n':
898                         return;
899
900                 default:
901                         next_char();
902                         break;
903                 }
904         }
905 }
906
907 static void skip_multiline_comment(void)
908 {
909         info.had_whitespace = true;
910
911         unsigned start_linenr = input.position.lineno;
912         while (true) {
913                 switch (input.c) {
914                 case '/':
915                         next_char();
916                         if (input.c == '*') {
917                                 /* TODO: nested comment, warn here */
918                         }
919                         break;
920                 case '*':
921                         next_char();
922                         if (input.c == '/') {
923                                 if (input.position.lineno != input.output_line)
924                                         info.whitespace_at_line_begin = input.position.colno;
925                                 next_char();
926                                 return;
927                         }
928                         break;
929
930                 case NEWLINE:
931                         break;
932
933                 case EOF: {
934                         source_position_t source_position;
935                         source_position.input_name = pp_token.base.source_position.input_name;
936                         source_position.lineno     = start_linenr;
937                         errorf(&source_position, "at end of file while looking for comment end");
938                         return;
939                 }
940
941                 default:
942                         next_char();
943                         break;
944                 }
945         }
946 }
947
948 static bool skip_till_newline(bool stop_at_non_whitespace)
949 {
950         bool res = false;
951         while (true) {
952                 switch (input.c) {
953                 case ' ':
954                 case '\t':
955                         next_char();
956                         continue;
957
958                 case '/':
959                         next_char();
960                         if (input.c == '/') {
961                                 next_char();
962                                 skip_line_comment();
963                                 continue;
964                         } else if (input.c == '*') {
965                                 next_char();
966                                 skip_multiline_comment();
967                                 continue;
968                         } else {
969                                 put_back(input.c);
970                                 input.c = '/';
971                         }
972                         return true;
973
974                 case NEWLINE:
975                         return res;
976
977                 default:
978                         if (stop_at_non_whitespace)
979                                 return false;
980                         res = true;
981                         next_char();
982                         continue;
983                 }
984         }
985 }
986
987 static void skip_whitespace(void)
988 {
989         while (true) {
990                 switch (input.c) {
991                 case ' ':
992                 case '\t':
993                         ++info.whitespace_at_line_begin;
994                         info.had_whitespace = true;
995                         next_char();
996                         continue;
997
998                 case NEWLINE:
999                         info.at_line_begin  = true;
1000                         info.had_whitespace = true;
1001                         info.whitespace_at_line_begin = 0;
1002                         continue;
1003
1004                 case '/':
1005                         next_char();
1006                         if (input.c == '/') {
1007                                 next_char();
1008                                 skip_line_comment();
1009                                 continue;
1010                         } else if (input.c == '*') {
1011                                 next_char();
1012                                 skip_multiline_comment();
1013                                 continue;
1014                         } else {
1015                                 put_back(input.c);
1016                                 input.c = '/';
1017                         }
1018                         return;
1019
1020                 default:
1021                         return;
1022                 }
1023         }
1024 }
1025
1026 static inline void eat_pp(pp_token_kind_t const kind)
1027 {
1028         assert(pp_token.base.symbol->pp_ID == kind);
1029         (void) kind;
1030         next_input_token();
1031 }
1032
1033 static inline void eat_token(token_kind_t const kind)
1034 {
1035         assert(pp_token.kind == kind);
1036         (void)kind;
1037         next_input_token();
1038 }
1039
1040 static void parse_symbol(void)
1041 {
1042         assert(obstack_object_size(&symbol_obstack) == 0);
1043         while (true) {
1044                 switch (input.c) {
1045                 case DIGIT_CASES:
1046                 case SYMBOL_CASES:
1047                         obstack_1grow(&symbol_obstack, (char) input.c);
1048                         next_char();
1049                         break;
1050
1051                 case '\\':
1052                         next_char();
1053                         switch (input.c) {
1054                         {
1055                                 unsigned n;
1056                         case 'U': n = 8; goto universal;
1057                         case 'u': n = 4; goto universal;
1058 universal:
1059                                 if (!resolve_escape_sequences) {
1060                                         obstack_1grow(&symbol_obstack, '\\');
1061                                         obstack_1grow(&symbol_obstack, input.c);
1062                                 }
1063                                 next_char();
1064                                 utf32 const v = parse_universal_char(n);
1065                                 if (!is_universal_char_valid_identifier(v)) {
1066                                         if (is_universal_char_valid(v)) {
1067                                                 errorf(&input.position,
1068                                                            "universal character \\%c%0*X is not valid in an identifier",
1069                                                            n == 4 ? 'u' : 'U', (int)n, v);
1070                                         }
1071                                 } else if (obstack_object_size(&symbol_obstack) == 0 && !is_universal_char_valid_identifier_start(v)) {
1072                                         errorf(&input.position,
1073                                                    "universal character \\%c%0*X is not valid as start of an identifier",
1074                                                    n == 4 ? 'u' : 'U', (int)n, v);
1075                                 } else if (resolve_escape_sequences) {
1076                                         obstack_grow_utf8(&symbol_obstack, v);
1077                                 }
1078                                 break;
1079                         }
1080
1081                         default:
1082                                 put_back(input.c);
1083                                 input.c = '\\';
1084                                 goto end_symbol;
1085                         }
1086
1087                 default:
1088 dollar_sign:
1089                         goto end_symbol;
1090                 }
1091         }
1092
1093 end_symbol:
1094         obstack_1grow(&symbol_obstack, '\0');
1095         char *string = obstack_finish(&symbol_obstack);
1096
1097         /* might be a wide string or character constant ( L"string"/L'c' ) */
1098         if (input.c == '"' && string[0] == 'L' && string[1] == '\0') {
1099                 obstack_free(&symbol_obstack, string);
1100                 parse_string_literal(STRING_ENCODING_WIDE);
1101                 return;
1102         } else if (input.c == '\'' && string[0] == 'L' && string[1] == '\0') {
1103                 obstack_free(&symbol_obstack, string);
1104                 parse_character_constant(STRING_ENCODING_WIDE);
1105                 return;
1106         }
1107
1108         symbol_t *symbol = symbol_table_insert(string);
1109
1110         pp_token.kind        = symbol->ID;
1111         pp_token.base.symbol = symbol;
1112
1113         /* we can free the memory from symbol obstack if we already had an entry in
1114          * the symbol table */
1115         if (symbol->string != string) {
1116                 obstack_free(&symbol_obstack, string);
1117         }
1118 }
1119
1120 static void parse_number(void)
1121 {
1122         obstack_1grow(&symbol_obstack, (char) input.c);
1123         next_char();
1124
1125         while (true) {
1126                 switch (input.c) {
1127                 case '.':
1128                 case DIGIT_CASES:
1129                 case SYMBOL_CASES_WITHOUT_E_P:
1130                         obstack_1grow(&symbol_obstack, (char) input.c);
1131                         next_char();
1132                         break;
1133
1134                 case 'e':
1135                 case 'p':
1136                 case 'E':
1137                 case 'P':
1138                         obstack_1grow(&symbol_obstack, (char) input.c);
1139                         next_char();
1140                         if (input.c == '+' || input.c == '-') {
1141                                 obstack_1grow(&symbol_obstack, (char) input.c);
1142                                 next_char();
1143                         }
1144                         break;
1145
1146                 default:
1147 dollar_sign:
1148                         goto end_number;
1149                 }
1150         }
1151
1152 end_number:
1153         pp_token.kind           = T_NUMBER;
1154         pp_token.literal.string = sym_make_string(STRING_ENCODING_CHAR);
1155 }
1156
1157 #define MAYBE_PROLOG \
1158         next_char(); \
1159         switch (input.c) {
1160
1161 #define MAYBE(ch, kind) \
1162         case ch: \
1163                 next_char(); \
1164                 set_punctuator(kind); \
1165                 return;
1166
1167 #define MAYBE_DIGRAPH(ch, kind, symbol) \
1168         case ch: \
1169                 next_char(); \
1170                 set_digraph(kind, symbol); \
1171                 return;
1172
1173 #define ELSE_CODE(code) \
1174         default: \
1175                 code \
1176         }
1177
1178 #define ELSE(kind) ELSE_CODE(set_punctuator(kind); return;)
1179
1180 /** identifies and returns the next preprocessing token contained in the
1181  * input stream. No macro expansion is performed. */
1182 static void next_input_token(void)
1183 {
1184         if (next_info.had_whitespace) {
1185                 info = next_info;
1186                 next_info.had_whitespace = false;
1187         } else {
1188                 info.at_line_begin  = false;
1189                 info.had_whitespace = false;
1190         }
1191 restart:
1192         pp_token.base.source_position = input.position;
1193         pp_token.base.symbol          = NULL;
1194
1195         switch (input.c) {
1196         case ' ':
1197         case '\t':
1198                 info.whitespace_at_line_begin++;
1199                 info.had_whitespace = true;
1200                 next_char();
1201                 goto restart;
1202
1203         case NEWLINE:
1204                 info.at_line_begin            = true;
1205                 info.had_whitespace           = true;
1206                 info.whitespace_at_line_begin = 0;
1207                 goto restart;
1208
1209         case SYMBOL_CASES:
1210                 parse_symbol();
1211                 return;
1212
1213         case DIGIT_CASES:
1214                 parse_number();
1215                 return;
1216
1217         case '"':
1218                 parse_string_literal(STRING_ENCODING_CHAR);
1219                 return;
1220
1221         case '\'':
1222                 parse_character_constant(STRING_ENCODING_CHAR);
1223                 return;
1224
1225         case '.':
1226                 MAYBE_PROLOG
1227                         case '0':
1228                         case '1':
1229                         case '2':
1230                         case '3':
1231                         case '4':
1232                         case '5':
1233                         case '6':
1234                         case '7':
1235                         case '8':
1236                         case '9':
1237                                 put_back(input.c);
1238                                 input.c = '.';
1239                                 parse_number();
1240                                 return;
1241
1242                         case '.':
1243                                 MAYBE_PROLOG
1244                                 MAYBE('.', T_DOTDOTDOT)
1245                                 ELSE_CODE(
1246                                         put_back(input.c);
1247                                         input.c = '.';
1248                                         set_punctuator('.');
1249                                         return;
1250                                 )
1251                 ELSE('.')
1252         case '&':
1253                 MAYBE_PROLOG
1254                 MAYBE('&', T_ANDAND)
1255                 MAYBE('=', T_ANDEQUAL)
1256                 ELSE('&')
1257         case '*':
1258                 MAYBE_PROLOG
1259                 MAYBE('=', T_ASTERISKEQUAL)
1260                 ELSE('*')
1261         case '+':
1262                 MAYBE_PROLOG
1263                 MAYBE('+', T_PLUSPLUS)
1264                 MAYBE('=', T_PLUSEQUAL)
1265                 ELSE('+')
1266         case '-':
1267                 MAYBE_PROLOG
1268                 MAYBE('>', T_MINUSGREATER)
1269                 MAYBE('-', T_MINUSMINUS)
1270                 MAYBE('=', T_MINUSEQUAL)
1271                 ELSE('-')
1272         case '!':
1273                 MAYBE_PROLOG
1274                 MAYBE('=', T_EXCLAMATIONMARKEQUAL)
1275                 ELSE('!')
1276         case '/':
1277                 MAYBE_PROLOG
1278                 MAYBE('=', T_SLASHEQUAL)
1279                 case '*':
1280                         next_char();
1281                         skip_multiline_comment();
1282                         goto restart;
1283                 case '/':
1284                         next_char();
1285                         skip_line_comment();
1286                         goto restart;
1287                 ELSE('/')
1288         case '%':
1289                 MAYBE_PROLOG
1290                 MAYBE_DIGRAPH('>', '}', symbol_percentgreater)
1291                 MAYBE('=', T_PERCENTEQUAL)
1292                 case ':':
1293                         MAYBE_PROLOG
1294                         case '%':
1295                                 MAYBE_PROLOG
1296                                 MAYBE_DIGRAPH(':', T_HASHHASH, symbol_percentcolonpercentcolon)
1297                                 ELSE_CODE(
1298                                         put_back(input.c);
1299                                         input.c = '%';
1300                                         goto digraph_percentcolon;
1301                                 )
1302                         ELSE_CODE(
1303 digraph_percentcolon:
1304                                 set_digraph('#', symbol_percentcolon);
1305                                 return;
1306                         )
1307                 ELSE('%')
1308         case '<':
1309                 MAYBE_PROLOG
1310                 MAYBE_DIGRAPH(':', '[', symbol_lesscolon)
1311                 MAYBE_DIGRAPH('%', '{', symbol_lesspercent)
1312                 MAYBE('=', T_LESSEQUAL)
1313                 case '<':
1314                         MAYBE_PROLOG
1315                         MAYBE('=', T_LESSLESSEQUAL)
1316                         ELSE(T_LESSLESS)
1317                 ELSE('<')
1318         case '>':
1319                 MAYBE_PROLOG
1320                 MAYBE('=', T_GREATEREQUAL)
1321                 case '>':
1322                         MAYBE_PROLOG
1323                         MAYBE('=', T_GREATERGREATEREQUAL)
1324                         ELSE(T_GREATERGREATER)
1325                 ELSE('>')
1326         case '^':
1327                 MAYBE_PROLOG
1328                 MAYBE('=', T_CARETEQUAL)
1329                 ELSE('^')
1330         case '|':
1331                 MAYBE_PROLOG
1332                 MAYBE('=', T_PIPEEQUAL)
1333                 MAYBE('|', T_PIPEPIPE)
1334                 ELSE('|')
1335         case ':':
1336                 MAYBE_PROLOG
1337                 MAYBE_DIGRAPH('>', ']', symbol_colongreater)
1338                 case ':':
1339                         if (c_mode & _CXX) {
1340                                 next_char();
1341                                 set_punctuator(T_COLONCOLON);
1342                                 return;
1343                         }
1344                         /* FALLTHROUGH */
1345                 ELSE(':')
1346         case '=':
1347                 MAYBE_PROLOG
1348                 MAYBE('=', T_EQUALEQUAL)
1349                 ELSE('=')
1350         case '#':
1351                 MAYBE_PROLOG
1352                 MAYBE('#', T_HASHHASH)
1353                 ELSE('#')
1354
1355         case '?':
1356         case '[':
1357         case ']':
1358         case '(':
1359         case ')':
1360         case '{':
1361         case '}':
1362         case '~':
1363         case ';':
1364         case ',':
1365                 set_punctuator(input.c);
1366                 next_char();
1367                 return;
1368
1369         case EOF:
1370                 if (input_stack != NULL) {
1371                         fclose(close_pp_input());
1372                         pop_restore_input();
1373                         fputc('\n', out);
1374                         if (input.c == (utf32)EOF)
1375                                 --input.position.lineno;
1376                         print_line_directive(&input.position, "2");
1377                         goto restart;
1378                 } else {
1379                         info.at_line_begin = true;
1380                         set_punctuator(T_EOF);
1381                 }
1382                 return;
1383
1384         case '\\':
1385                 next_char();
1386                 int next_c = input.c;
1387                 put_back(input.c);
1388                 input.c = '\\';
1389                 if (next_c == 'U' || next_c == 'u') {
1390                         parse_symbol();
1391                         return;
1392                 }
1393                 /* FALLTHROUGH */
1394         default:
1395 dollar_sign:
1396                 if (error_on_unknown_chars) {
1397                         errorf(&pp_token.base.source_position,
1398                                "unknown character '%lc' found\n", input.c);
1399                         next_char();
1400                         goto restart;
1401                 } else {
1402                         assert(obstack_object_size(&symbol_obstack) == 0);
1403                         obstack_grow_utf8(&symbol_obstack, input.c);
1404                         obstack_1grow(&symbol_obstack, '\0');
1405                         char     *const string = obstack_finish(&symbol_obstack);
1406                         symbol_t *const symbol = symbol_table_insert(string);
1407                         if (symbol->string != string)
1408                                 obstack_free(&symbol_obstack, string);
1409
1410                         pp_token.kind        = T_UNKNOWN_CHAR;
1411                         pp_token.base.symbol = symbol;
1412                         next_char();
1413                         return;
1414                 }
1415         }
1416 }
1417
1418 static void print_quoted_string(const char *const string)
1419 {
1420         fputc('"', out);
1421         for (const char *c = string; *c != 0; ++c) {
1422                 switch (*c) {
1423                 case '"': fputs("\\\"", out); break;
1424                 case '\\':  fputs("\\\\", out); break;
1425                 case '\a':  fputs("\\a", out); break;
1426                 case '\b':  fputs("\\b", out); break;
1427                 case '\f':  fputs("\\f", out); break;
1428                 case '\n':  fputs("\\n", out); break;
1429                 case '\r':  fputs("\\r", out); break;
1430                 case '\t':  fputs("\\t", out); break;
1431                 case '\v':  fputs("\\v", out); break;
1432                 case '\?':  fputs("\\?", out); break;
1433                 default:
1434                         if (!isprint(*c)) {
1435                                 fprintf(out, "\\%03o", (unsigned)*c);
1436                                 break;
1437                         }
1438                         fputc(*c, out);
1439                         break;
1440                 }
1441         }
1442         fputc('"', out);
1443 }
1444
1445 static void print_line_directive(const source_position_t *pos, const char *add)
1446 {
1447         if (!out)
1448                 return;
1449
1450         fprintf(out, "# %u ", pos->lineno);
1451         print_quoted_string(pos->input_name);
1452         if (add != NULL) {
1453                 fputc(' ', out);
1454                 fputs(add, out);
1455         }
1456         if (pos->is_system_header) {
1457                 fputs(" 3", out);
1458         }
1459
1460         printed_input_name = pos->input_name;
1461         input.output_line  = pos->lineno-1;
1462 }
1463
1464 static bool emit_newlines(void)
1465 {
1466         unsigned delta = pp_token.base.source_position.lineno - input.output_line;
1467         if (delta == 0)
1468                 return false;
1469
1470         if (delta >= 9) {
1471                 fputc('\n', out);
1472                 print_line_directive(&pp_token.base.source_position, NULL);
1473                 fputc('\n', out);
1474         } else {
1475                 for (unsigned i = 0; i < delta; ++i) {
1476                         fputc('\n', out);
1477                 }
1478         }
1479         input.output_line = pp_token.base.source_position.lineno;
1480
1481         for (unsigned i = 0; i < info.whitespace_at_line_begin; ++i)
1482                 fputc(' ', out);
1483
1484         return true;
1485 }
1486
1487 void set_preprocessor_output(FILE *output)
1488 {
1489         out = output;
1490         if (out != NULL) {
1491                 error_on_unknown_chars   = false;
1492                 resolve_escape_sequences = false;
1493         } else {
1494                 error_on_unknown_chars   = true;
1495                 resolve_escape_sequences = true;
1496         }
1497 }
1498
1499 void emit_pp_token(void)
1500 {
1501         if (!emit_newlines() &&
1502             (info.had_whitespace || tokens_would_paste(last_token, pp_token.kind)))
1503                 fputc(' ', out);
1504
1505         switch (pp_token.kind) {
1506         case T_NUMBER:
1507                 fputs(pp_token.literal.string.begin, out);
1508                 break;
1509
1510         case T_STRING_LITERAL:
1511                 fputs(get_string_encoding_prefix(pp_token.literal.string.encoding), out);
1512                 fputc('"', out);
1513                 fputs(pp_token.literal.string.begin, out);
1514                 fputc('"', out);
1515                 break;
1516
1517         case T_CHARACTER_CONSTANT:
1518                 fputs(get_string_encoding_prefix(pp_token.literal.string.encoding), out);
1519                 fputc('\'', out);
1520                 fputs(pp_token.literal.string.begin, out);
1521                 fputc('\'', out);
1522                 break;
1523
1524         case T_MACRO_PARAMETER:
1525                 panic("macro parameter not expanded");
1526
1527         default:
1528                 fputs(pp_token.base.symbol->string, out);
1529                 break;
1530         }
1531         last_token = pp_token.kind;
1532 }
1533
1534 static void eat_pp_directive(void)
1535 {
1536         while (!info.at_line_begin) {
1537                 next_input_token();
1538         }
1539 }
1540
1541 static bool strings_equal(const string_t *string1, const string_t *string2)
1542 {
1543         size_t size = string1->size;
1544         if (size != string2->size)
1545                 return false;
1546
1547         const char *c1 = string1->begin;
1548         const char *c2 = string2->begin;
1549         for (size_t i = 0; i < size; ++i, ++c1, ++c2) {
1550                 if (*c1 != *c2)
1551                         return false;
1552         }
1553         return true;
1554 }
1555
1556 static bool pp_tokens_equal(const token_t *token1, const token_t *token2)
1557 {
1558         if (token1->kind != token2->kind)
1559                 return false;
1560
1561         switch (token1->kind) {
1562         case T_NUMBER:
1563         case T_CHARACTER_CONSTANT:
1564         case T_STRING_LITERAL:
1565                 return strings_equal(&token1->literal.string, &token2->literal.string);
1566
1567         case T_MACRO_PARAMETER:
1568                 return token1->macro_parameter.def->symbol
1569                     == token2->macro_parameter.def->symbol;
1570
1571         default:
1572                 return token1->base.symbol == token2->base.symbol;
1573         }
1574 }
1575
1576 static bool pp_definitions_equal(const pp_definition_t *definition1,
1577                                  const pp_definition_t *definition2)
1578 {
1579         if (definition1->list_len != definition2->list_len)
1580                 return false;
1581
1582         size_t               len = definition1->list_len;
1583         const saved_token_t *t1  = definition1->token_list;
1584         const saved_token_t *t2  = definition2->token_list;
1585         for (size_t i = 0; i < len; ++i, ++t1, ++t2) {
1586                 if (!pp_tokens_equal(&t1->token, &t2->token))
1587                         return false;
1588         }
1589         return true;
1590 }
1591
1592 static void missing_macro_param_error(void)
1593 {
1594         errorf(&pp_token.base.source_position,
1595                "'#' is not followed by a macro parameter");
1596 }
1597
1598 static bool is_defineable_token(char const *const context)
1599 {
1600         if (info.at_line_begin) {
1601                 errorf(&pp_token.base.source_position, "unexpected end of line after %s", context);
1602         }
1603
1604         symbol_t *const symbol = pp_token.base.symbol;
1605         if (!symbol)
1606                 goto no_ident;
1607
1608         if (pp_token.kind != T_IDENTIFIER) {
1609                 switch (symbol->string[0]) {
1610                 case SYMBOL_CASES:
1611 dollar_sign:
1612                         break;
1613
1614                 default:
1615 no_ident:
1616                         errorf(&pp_token.base.source_position, "expected identifier after %s, got %K", context, &pp_token);
1617                         return false;
1618                 }
1619         }
1620
1621         /* TODO turn this into a flag in pp_def. */
1622         switch (symbol->pp_ID) {
1623         /* Â§6.10.8:4 */
1624         case TP_defined:
1625                 errorf(&pp_token.base.source_position, "%K cannot be used as macro name in %s", &pp_token, context);
1626                 return false;
1627
1628         default:
1629                 return true;
1630         }
1631 }
1632
1633 static void parse_define_directive(void)
1634 {
1635         eat_pp(TP_define);
1636         if (skip_mode) {
1637                 eat_pp_directive();
1638                 return;
1639         }
1640
1641         assert(obstack_object_size(&pp_obstack) == 0);
1642
1643         if (!is_defineable_token("#define"))
1644                 goto error_out;
1645         symbol_t *const symbol = pp_token.base.symbol;
1646
1647         pp_definition_t *new_definition
1648                 = obstack_alloc(&pp_obstack, sizeof(new_definition[0]));
1649         memset(new_definition, 0, sizeof(new_definition[0]));
1650         new_definition->symbol          = symbol;
1651         new_definition->source_position = input.position;
1652
1653         /* this is probably the only place where spaces are significant in the
1654          * lexer (except for the fact that they separate tokens). #define b(x)
1655          * is something else than #define b (x) */
1656         if (input.c == '(') {
1657                 next_input_token();
1658                 eat_token('(');
1659
1660                 while (true) {
1661                         switch (pp_token.kind) {
1662                         case T_DOTDOTDOT:
1663                                 new_definition->is_variadic = true;
1664                                 eat_token(T_DOTDOTDOT);
1665                                 if (pp_token.kind != ')') {
1666                                         errorf(&input.position,
1667                                                         "'...' not at end of macro argument list");
1668                                         goto error_out;
1669                                 }
1670                                 break;
1671
1672                         case T_IDENTIFIER: {
1673                                 pp_definition_t parameter;
1674                                 memset(&parameter, 0, sizeof(parameter));
1675                                 parameter.source_position = pp_token.base.source_position;
1676                                 parameter.symbol          = pp_token.base.symbol;
1677                                 parameter.is_parameter    = true;
1678                                 obstack_grow(&pp_obstack, &parameter, sizeof(parameter));
1679                                 eat_token(T_IDENTIFIER);
1680
1681                                 if (pp_token.kind == ',') {
1682                                         eat_token(',');
1683                                         break;
1684                                 }
1685
1686                                 if (pp_token.kind != ')') {
1687                                         errorf(&pp_token.base.source_position,
1688                                                "expected ',' or ')' after identifier, got %K",
1689                                                &pp_token);
1690                                         goto error_out;
1691                                 }
1692                                 break;
1693                         }
1694
1695                         case ')':
1696                                 eat_token(')');
1697                                 goto finish_argument_list;
1698
1699                         default:
1700                                 errorf(&pp_token.base.source_position,
1701                                        "expected identifier, '...' or ')' in #define argument list, got %K",
1702                                        &pp_token);
1703                                 goto error_out;
1704                         }
1705                 }
1706
1707         finish_argument_list:
1708                 new_definition->has_parameters = true;
1709                 size_t size = obstack_object_size(&pp_obstack);
1710                 new_definition->n_parameters
1711                         = size / sizeof(new_definition->parameters[0]);
1712                 new_definition->parameters = obstack_finish(&pp_obstack);
1713                 for (size_t i = 0; i < new_definition->n_parameters; ++i) {
1714                         pp_definition_t *param    = &new_definition->parameters[i];
1715                         symbol_t        *symbol   = param->symbol;
1716                         pp_definition_t *previous = symbol->pp_definition;
1717                         if (previous != NULL
1718                             && previous->function_definition == new_definition) {
1719                                 errorf(&param->source_position,
1720                                        "duplicate macro parameter '%Y'", symbol);
1721                                 param->symbol = sym_anonymous;
1722                                 continue;
1723                         }
1724                         param->parent_expansion    = previous;
1725                         param->function_definition = new_definition;
1726                         symbol->pp_definition      = param;
1727                 }
1728         } else {
1729                 next_input_token();
1730         }
1731
1732         /* construct token list */
1733         assert(obstack_object_size(&pp_obstack) == 0);
1734         bool next_must_be_param = false;
1735         while (!info.at_line_begin) {
1736                 if (pp_token.kind == T_IDENTIFIER) {
1737                         const symbol_t  *symbol     = pp_token.base.symbol;
1738                         pp_definition_t *definition = symbol->pp_definition;
1739                         if (definition != NULL
1740                             && definition->function_definition == new_definition) {
1741                             pp_token.kind                = T_MACRO_PARAMETER;
1742                             pp_token.macro_parameter.def = definition;
1743                         }
1744                 }
1745                 if (next_must_be_param && pp_token.kind != T_MACRO_PARAMETER) {
1746                         missing_macro_param_error();
1747                 }
1748                 saved_token_t saved_token;
1749                 saved_token.token = pp_token;
1750                 saved_token.had_whitespace = info.had_whitespace;
1751                 obstack_grow(&pp_obstack, &saved_token, sizeof(saved_token));
1752                 next_must_be_param
1753                         = new_definition->has_parameters && pp_token.kind == '#';
1754                 next_input_token();
1755         }
1756         if (next_must_be_param)
1757                 missing_macro_param_error();
1758
1759         new_definition->list_len   = obstack_object_size(&pp_obstack)
1760                 / sizeof(new_definition->token_list[0]);
1761         new_definition->token_list = obstack_finish(&pp_obstack);
1762
1763         if (new_definition->has_parameters) {
1764                 for (size_t i = 0; i < new_definition->n_parameters; ++i) {
1765                         pp_definition_t *param      = &new_definition->parameters[i];
1766                         symbol_t        *symbol     = param->symbol;
1767                         if (symbol == sym_anonymous)
1768                                 continue;
1769                         assert(symbol->pp_definition == param);
1770                         assert(param->function_definition == new_definition);
1771                         symbol->pp_definition   = param->parent_expansion;
1772                         param->parent_expansion = NULL;
1773                 }
1774         }
1775
1776         pp_definition_t *old_definition = symbol->pp_definition;
1777         if (old_definition != NULL) {
1778                 if (!pp_definitions_equal(old_definition, new_definition)) {
1779                         warningf(WARN_OTHER, &input.position, "multiple definition of macro '%Y' (first defined %P)", symbol, &old_definition->source_position);
1780                 } else {
1781                         /* reuse the old definition */
1782                         obstack_free(&pp_obstack, new_definition);
1783                         new_definition = old_definition;
1784                 }
1785         }
1786
1787         symbol->pp_definition = new_definition;
1788         return;
1789
1790 error_out:
1791         if (obstack_object_size(&pp_obstack) > 0) {
1792                 char *ptr = obstack_finish(&pp_obstack);
1793                 obstack_free(&pp_obstack, ptr);
1794         }
1795         eat_pp_directive();
1796 }
1797
1798 static void parse_undef_directive(void)
1799 {
1800         eat_pp(TP_undef);
1801         if (skip_mode) {
1802                 eat_pp_directive();
1803                 return;
1804         }
1805
1806         if (!is_defineable_token("#undef")) {
1807                 eat_pp_directive();
1808                 return;
1809         }
1810
1811         pp_token.base.symbol->pp_definition = NULL;
1812         next_input_token();
1813
1814         if (!info.at_line_begin) {
1815                 warningf(WARN_OTHER, &input.position, "extra tokens at end of #undef directive");
1816         }
1817         eat_pp_directive();
1818 }
1819
1820 /** behind an #include we can have the special headername lexems.
1821  * They're only allowed behind an #include so they're not recognized
1822  * by the normal next_preprocessing_token. We handle them as a special
1823  * exception here */
1824 static void parse_headername(void)
1825 {
1826         const source_position_t start_position = input.position;
1827         string_t                string         = { NULL, 0, STRING_ENCODING_CHAR };
1828         assert(obstack_object_size(&symbol_obstack) == 0);
1829
1830         if (info.at_line_begin) {
1831                 parse_error("expected headername after #include");
1832                 goto finish_error;
1833         }
1834
1835         /* check wether we have a "... or <... headername */
1836         switch (input.c) {
1837         {
1838                 utf32 delimiter;
1839         case '<': delimiter = '>'; goto parse_name;
1840         case '"': delimiter = '"'; goto parse_name;
1841 parse_name:
1842                 next_char();
1843                 while (true) {
1844                         switch (input.c) {
1845                         case NEWLINE:
1846                         case EOF:
1847                                 errorf(&pp_token.base.source_position, "header name without closing '%c'", (char)delimiter);
1848                                 goto finish_error;
1849
1850                         default:
1851                                 if (input.c == delimiter) {
1852                                         next_char();
1853                                         goto finished_headername;
1854                                 } else {
1855                                         obstack_1grow(&symbol_obstack, (char)input.c);
1856                                         next_char();
1857                                 }
1858                                 break;
1859                         }
1860                 }
1861                 /* we should never be here */
1862         }
1863
1864         default:
1865                 /* TODO: do normal pp_token parsing and concatenate results */
1866                 panic("pp_token concat include not implemented yet");
1867         }
1868
1869 finished_headername:
1870         string = sym_make_string(STRING_ENCODING_CHAR);
1871
1872 finish_error:
1873         pp_token.base.source_position = start_position;
1874         pp_token.kind                 = T_HEADERNAME;
1875         pp_token.literal.string       = string;
1876 }
1877
1878 static bool do_include(bool const system_include, bool const include_next, char const *const headername)
1879 {
1880         size_t const        headername_len = strlen(headername);
1881         searchpath_entry_t *entry;
1882         if (include_next) {
1883                 entry = input.path ? input.path->next : searchpath;
1884         } else {
1885                 if (!system_include) {
1886                         /* put dirname of current input on obstack */
1887                         const char *filename   = input.position.input_name;
1888                         const char *last_slash = strrchr(filename, '/');
1889                         const char *full_name;
1890                         if (last_slash != NULL) {
1891                                 size_t len = last_slash - filename;
1892                                 obstack_grow(&symbol_obstack, filename, len + 1);
1893                                 obstack_grow0(&symbol_obstack, headername, headername_len);
1894                                 char *complete_path = obstack_finish(&symbol_obstack);
1895                                 full_name = identify_string(complete_path);
1896                         } else {
1897                                 full_name = headername;
1898                         }
1899
1900                         FILE *file = fopen(full_name, "r");
1901                         if (file != NULL) {
1902                                 switch_pp_input(file, full_name, NULL);
1903                                 return true;
1904                         }
1905                 }
1906
1907                 entry = searchpath;
1908         }
1909
1910         assert(obstack_object_size(&symbol_obstack) == 0);
1911         /* check searchpath */
1912         for (; entry; entry = entry->next) {
1913             const char *path = entry->path;
1914             size_t      len  = strlen(path);
1915                 obstack_grow(&symbol_obstack, path, len);
1916                 if (path[len-1] != '/')
1917                         obstack_1grow(&symbol_obstack, '/');
1918                 obstack_grow(&symbol_obstack, headername, headername_len+1);
1919
1920                 char *complete_path = obstack_finish(&symbol_obstack);
1921                 FILE *file          = fopen(complete_path, "r");
1922                 if (file != NULL) {
1923                         const char *filename = identify_string(complete_path);
1924                         switch_pp_input(file, filename, entry);
1925                         return true;
1926                 } else {
1927                         obstack_free(&symbol_obstack, complete_path);
1928                 }
1929         }
1930
1931         return false;
1932 }
1933
1934 static void parse_include_directive(bool const include_next)
1935 {
1936         if (skip_mode) {
1937                 eat_pp_directive();
1938                 return;
1939         }
1940
1941         /* don't eat the TP_include here!
1942          * we need an alternative parsing for the next token */
1943         skip_till_newline(true);
1944         bool system_include = input.c == '<';
1945         parse_headername();
1946         string_t headername = pp_token.literal.string;
1947         if (headername.begin == NULL) {
1948                 eat_pp_directive();
1949                 return;
1950         }
1951
1952         bool had_nonwhitespace = skip_till_newline(false);
1953         if (had_nonwhitespace) {
1954                 warningf(WARN_OTHER, &pp_token.base.source_position,
1955                          "extra tokens at end of #include directive");
1956         }
1957
1958         if (n_inputs > INCLUDE_LIMIT) {
1959                 errorf(&pp_token.base.source_position, "#include nested too deeply");
1960                 /* eat \n or EOF */
1961                 next_input_token();
1962                 return;
1963         }
1964
1965         /* switch inputs */
1966         info.whitespace_at_line_begin = 0;
1967         info.had_whitespace           = false;
1968         info.at_line_begin            = true;
1969         emit_newlines();
1970         push_input();
1971         bool res = do_include(system_include, include_next, pp_token.literal.string.begin);
1972         if (res) {
1973                 next_input_token();
1974         } else {
1975                 errorf(&pp_token.base.source_position, "failed including '%S': %s", &pp_token.literal.string, strerror(errno));
1976                 pop_restore_input();
1977         }
1978 }
1979
1980 static pp_conditional_t *push_conditional(void)
1981 {
1982         pp_conditional_t *conditional
1983                 = obstack_alloc(&pp_obstack, sizeof(*conditional));
1984         memset(conditional, 0, sizeof(*conditional));
1985
1986         conditional->parent = conditional_stack;
1987         conditional_stack   = conditional;
1988
1989         return conditional;
1990 }
1991
1992 static void pop_conditional(void)
1993 {
1994         assert(conditional_stack != NULL);
1995         conditional_stack = conditional_stack->parent;
1996 }
1997
1998 void check_unclosed_conditionals(void)
1999 {
2000         while (conditional_stack != NULL) {
2001                 pp_conditional_t *conditional = conditional_stack;
2002
2003                 if (conditional->in_else) {
2004                         errorf(&conditional->source_position, "unterminated #else");
2005                 } else {
2006                         errorf(&conditional->source_position, "unterminated condition");
2007                 }
2008                 pop_conditional();
2009         }
2010 }
2011
2012 static void parse_ifdef_ifndef_directive(bool const is_ifdef)
2013 {
2014         bool condition;
2015         eat_pp(is_ifdef ? TP_ifdef : TP_ifndef);
2016
2017         if (skip_mode) {
2018                 eat_pp_directive();
2019                 pp_conditional_t *conditional = push_conditional();
2020                 conditional->source_position  = pp_token.base.source_position;
2021                 conditional->skip             = true;
2022                 return;
2023         }
2024
2025         if (pp_token.kind != T_IDENTIFIER || info.at_line_begin) {
2026                 errorf(&pp_token.base.source_position,
2027                        "expected identifier after #%s, got %K",
2028                        is_ifdef ? "ifdef" : "ifndef", &pp_token);
2029                 eat_pp_directive();
2030
2031                 /* just take the true case in the hope to avoid further errors */
2032                 condition = true;
2033         } else {
2034                 /* evaluate wether we are in true or false case */
2035                 condition = (bool)pp_token.base.symbol->pp_definition == is_ifdef;
2036                 eat_token(T_IDENTIFIER);
2037
2038                 if (!info.at_line_begin) {
2039                         errorf(&pp_token.base.source_position,
2040                                "extra tokens at end of #%s",
2041                                is_ifdef ? "ifdef" : "ifndef");
2042                         eat_pp_directive();
2043                 }
2044         }
2045
2046         pp_conditional_t *conditional = push_conditional();
2047         conditional->source_position  = pp_token.base.source_position;
2048         conditional->condition        = condition;
2049
2050         if (!condition) {
2051                 skip_mode = true;
2052         }
2053 }
2054
2055 static void parse_else_directive(void)
2056 {
2057         eat_pp(TP_else);
2058
2059         if (!info.at_line_begin) {
2060                 if (!skip_mode) {
2061                         warningf(WARN_OTHER, &pp_token.base.source_position, "extra tokens at end of #else");
2062                 }
2063                 eat_pp_directive();
2064         }
2065
2066         pp_conditional_t *conditional = conditional_stack;
2067         if (conditional == NULL) {
2068                 errorf(&pp_token.base.source_position, "#else without prior #if");
2069                 return;
2070         }
2071
2072         if (conditional->in_else) {
2073                 errorf(&pp_token.base.source_position,
2074                        "#else after #else (condition started %P)",
2075                        &conditional->source_position);
2076                 skip_mode = true;
2077                 return;
2078         }
2079
2080         conditional->in_else = true;
2081         if (!conditional->skip) {
2082                 skip_mode = conditional->condition;
2083         }
2084         conditional->source_position = pp_token.base.source_position;
2085 }
2086
2087 static void parse_endif_directive(void)
2088 {
2089         eat_pp(TP_endif);
2090
2091         if (!info.at_line_begin) {
2092                 if (!skip_mode) {
2093                         warningf(WARN_OTHER, &pp_token.base.source_position, "extra tokens at end of #endif");
2094                 }
2095                 eat_pp_directive();
2096         }
2097
2098         pp_conditional_t *conditional = conditional_stack;
2099         if (conditional == NULL) {
2100                 errorf(&pp_token.base.source_position, "#endif without prior #if");
2101                 return;
2102         }
2103
2104         if (!conditional->skip) {
2105                 skip_mode = false;
2106         }
2107         pop_conditional();
2108 }
2109
2110 typedef enum stdc_pragma_kind_t {
2111         STDC_UNKNOWN,
2112         STDC_FP_CONTRACT,
2113         STDC_FENV_ACCESS,
2114         STDC_CX_LIMITED_RANGE
2115 } stdc_pragma_kind_t;
2116
2117 typedef enum stdc_pragma_value_kind_t {
2118         STDC_VALUE_UNKNOWN,
2119         STDC_VALUE_ON,
2120         STDC_VALUE_OFF,
2121         STDC_VALUE_DEFAULT
2122 } stdc_pragma_value_kind_t;
2123
2124 static void parse_pragma_directive(void)
2125 {
2126         eat_pp(TP_pragma);
2127         if (skip_mode) {
2128                 eat_pp_directive();
2129                 return;
2130         }
2131
2132         if (pp_token.kind != T_IDENTIFIER) {
2133                 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
2134                          "expected identifier after #pragma");
2135                 eat_pp_directive();
2136                 return;
2137         }
2138
2139         stdc_pragma_kind_t kind = STDC_UNKNOWN;
2140         if (pp_token.base.symbol->pp_ID == TP_STDC && c_mode & _C99) {
2141                 /* a STDC pragma */
2142                 next_input_token();
2143
2144                 switch (pp_token.base.symbol->pp_ID) {
2145                 case TP_FP_CONTRACT:      kind = STDC_FP_CONTRACT;      break;
2146                 case TP_FENV_ACCESS:      kind = STDC_FENV_ACCESS;      break;
2147                 case TP_CX_LIMITED_RANGE: kind = STDC_CX_LIMITED_RANGE; break;
2148                 default:                  break;
2149                 }
2150                 if (kind != STDC_UNKNOWN) {
2151                         next_input_token();
2152                         stdc_pragma_value_kind_t value;
2153                         switch (pp_token.base.symbol->pp_ID) {
2154                         case TP_ON:      value = STDC_VALUE_ON;      break;
2155                         case TP_OFF:     value = STDC_VALUE_OFF;     break;
2156                         case TP_DEFAULT: value = STDC_VALUE_DEFAULT; break;
2157                         default:         value = STDC_VALUE_UNKNOWN; break;
2158                         }
2159                         if (value == STDC_VALUE_UNKNOWN) {
2160                                 kind = STDC_UNKNOWN;
2161                                 errorf(&pp_token.base.source_position, "bad STDC pragma argument");
2162                         }
2163                 }
2164         }
2165         eat_pp_directive();
2166         if (kind == STDC_UNKNOWN) {
2167                 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
2168                          "encountered unknown #pragma");
2169         }
2170 }
2171
2172 static void parse_line_directive(void)
2173 {
2174         if (pp_token.kind != T_NUMBER) {
2175                 if (!skip_mode)
2176                         parse_error("expected integer");
2177         } else {
2178                 char      *end;
2179                 long const line = strtol(pp_token.literal.string.begin, &end, 0);
2180                 if (*end == '\0') {
2181                         /* use offset -1 as this is about the next line */
2182                         input.position.lineno = line - 1;
2183                         /* force output of line */
2184                         input.output_line = input.position.lineno - 20;
2185                 } else {
2186                         if (!skip_mode) {
2187                                 errorf(&input.position, "'%S' is not a valid line number",
2188                                            &pp_token.literal.string);
2189                         }
2190                 }
2191                 next_input_token();
2192                 if (info.at_line_begin)
2193                         return;
2194         }
2195         if (pp_token.kind == T_STRING_LITERAL
2196             && pp_token.literal.string.encoding == STRING_ENCODING_CHAR) {
2197                 input.position.input_name       = pp_token.literal.string.begin;
2198                 input.position.is_system_header = false;
2199                 next_input_token();
2200
2201                 /* attempt to parse numeric flags as outputted by gcc preprocessor */
2202                 while (!info.at_line_begin && pp_token.kind == T_NUMBER) {
2203                         /* flags:
2204                          * 1 - indicates start of a new file
2205                          * 2 - indicates return from a file
2206                          * 3 - indicates system header
2207                          * 4 - indicates implicit extern "C" in C++ mode
2208                          *
2209                          * currently we're only interested in "3"
2210                          */
2211                         if (streq(pp_token.literal.string.begin, "3")) {
2212                                 input.position.is_system_header = true;
2213                         }
2214                         next_input_token();
2215                 }
2216         }
2217
2218         eat_pp_directive();
2219 }
2220
2221 static void parse_error_directive(void)
2222 {
2223         if (skip_mode) {
2224                 eat_pp_directive();
2225                 return;
2226         }
2227
2228         bool const old_resolve_escape_sequences = resolve_escape_sequences;
2229         resolve_escape_sequences = false;
2230
2231         source_position_t const pos = pp_token.base.source_position;
2232         do {
2233                 if (info.had_whitespace && obstack_object_size(&pp_obstack) != 0)
2234                         obstack_1grow(&pp_obstack, ' ');
2235
2236                 switch (pp_token.kind) {
2237                 case T_NUMBER: {
2238                         string_t const *const str = &pp_token.literal.string;
2239                         obstack_grow(&pp_obstack, str->begin, str->size);
2240                         break;
2241                 }
2242
2243                 {
2244                         char delim;
2245                 case T_STRING_LITERAL:     delim =  '"'; goto string;
2246                 case T_CHARACTER_CONSTANT: delim = '\''; goto string;
2247 string:;
2248                         string_t const *const str = &pp_token.literal.string;
2249                         char     const *const enc = get_string_encoding_prefix(str->encoding);
2250                         obstack_printf(&pp_obstack, "%s%c%s%c", enc, delim, str->begin, delim);
2251                         break;
2252                 }
2253
2254                 default: {
2255                         char const *const str = pp_token.base.symbol->string;
2256                         obstack_grow(&pp_obstack, str, strlen(str));
2257                         break;
2258                 }
2259                 }
2260
2261                 next_input_token();
2262         } while (!info.at_line_begin);
2263
2264         resolve_escape_sequences = old_resolve_escape_sequences;
2265
2266         obstack_1grow(&pp_obstack, '\0');
2267         char *const str = obstack_finish(&pp_obstack);
2268         errorf(&pos, "#%s", str);
2269         obstack_free(&pp_obstack, str);
2270 }
2271
2272 static void parse_preprocessing_directive(void)
2273 {
2274         eat_token('#');
2275
2276         if (info.at_line_begin) {
2277                 /* empty directive */
2278                 return;
2279         }
2280
2281         if (pp_token.base.symbol) {
2282                 switch (pp_token.base.symbol->pp_ID) {
2283                 case TP_define:       parse_define_directive();            break;
2284                 case TP_else:         parse_else_directive();              break;
2285                 case TP_endif:        parse_endif_directive();             break;
2286                 case TP_error:        parse_error_directive();             break;
2287                 case TP_ifdef:        parse_ifdef_ifndef_directive(true);  break;
2288                 case TP_ifndef:       parse_ifdef_ifndef_directive(false); break;
2289                 case TP_include:      parse_include_directive(false);      break;
2290                 case TP_include_next: parse_include_directive(true);       break;
2291                 case TP_line:         next_input_token(); goto line_directive;
2292                 case TP_pragma:       parse_pragma_directive();            break;
2293                 case TP_undef:        parse_undef_directive();             break;
2294                 default:              goto skip;
2295                 }
2296         } else if (pp_token.kind == T_NUMBER) {
2297 line_directive:
2298                 parse_line_directive();
2299         } else {
2300 skip:
2301                 if (!skip_mode) {
2302                         errorf(&pp_token.base.source_position, "invalid preprocessing directive #%K", &pp_token);
2303                 }
2304                 eat_pp_directive();
2305         }
2306
2307         assert(info.at_line_begin);
2308 }
2309
2310 static void finish_current_argument(void)
2311 {
2312         if (current_argument == NULL)
2313                 return;
2314         size_t size = obstack_object_size(&pp_obstack);
2315         current_argument->list_len   = size/sizeof(current_argument->token_list[0]);
2316         current_argument->token_list = obstack_finish(&pp_obstack);
2317 }
2318
2319 void next_preprocessing_token(void)
2320 {
2321 restart:
2322         if (!expand_next()) {
2323                 do {
2324                         next_input_token();
2325                         while (pp_token.kind == '#' && info.at_line_begin) {
2326                                 parse_preprocessing_directive();
2327                         }
2328                 } while (skip_mode && pp_token.kind != T_EOF);
2329         }
2330
2331         const token_kind_t kind = pp_token.kind;
2332         if (current_call == NULL || argument_expanding != NULL) {
2333                 symbol_t *const symbol = pp_token.base.symbol;
2334                 if (symbol) {
2335                         if (kind == T_MACRO_PARAMETER) {
2336                                 assert(current_expansion != NULL);
2337                                 start_expanding(pp_token.macro_parameter.def);
2338                                 goto restart;
2339                         }
2340
2341                         pp_definition_t *const pp_definition = symbol->pp_definition;
2342                         if (pp_definition != NULL && !pp_definition->is_expanding) {
2343                                 if (pp_definition->has_parameters) {
2344
2345                                         /* check if next token is a '(' */
2346                                         whitespace_info_t old_info   = info;
2347                                         token_kind_t      next_token = peek_expansion();
2348                                         if (next_token == T_EOF) {
2349                                                 info.at_line_begin  = false;
2350                                                 info.had_whitespace = false;
2351                                                 skip_whitespace();
2352                                                 if (input.c == '(') {
2353                                                         next_token = '(';
2354                                                 }
2355                                         }
2356
2357                                         if (next_token == '(') {
2358                                                 if (current_expansion == NULL)
2359                                                         expansion_pos = pp_token.base.source_position;
2360                                                 next_preprocessing_token();
2361                                                 assert(pp_token.kind == '(');
2362
2363                                                 pp_definition->parent_expansion = current_expansion;
2364                                                 current_call              = pp_definition;
2365                                                 current_call->expand_pos  = 0;
2366                                                 current_call->expand_info = old_info;
2367                                                 if (current_call->n_parameters > 0) {
2368                                                         current_argument = &current_call->parameters[0];
2369                                                         assert(argument_brace_count == 0);
2370                                                 }
2371                                                 goto restart;
2372                                         } else {
2373                                                 /* skip_whitespaces() skipped newlines and whitespace,
2374                                                  * remember results for next token */
2375                                                 next_info = info;
2376                                                 info      = old_info;
2377                                                 return;
2378                                         }
2379                                 } else {
2380                                         if (current_expansion == NULL)
2381                                                 expansion_pos = pp_token.base.source_position;
2382                                         start_expanding(pp_definition);
2383                                         goto restart;
2384                                 }
2385                         }
2386                 }
2387         }
2388
2389         if (current_call != NULL) {
2390                 /* current_call != NULL */
2391                 if (kind == '(') {
2392                         ++argument_brace_count;
2393                 } else if (kind == ')') {
2394                         if (argument_brace_count > 0) {
2395                                 --argument_brace_count;
2396                         } else {
2397                                 finish_current_argument();
2398                                 assert(kind == ')');
2399                                 start_expanding(current_call);
2400                                 info = current_call->expand_info;
2401                                 current_call     = NULL;
2402                                 current_argument = NULL;
2403                                 goto restart;
2404                         }
2405                 } else if (kind == ',' && argument_brace_count == 0) {
2406                         finish_current_argument();
2407                         current_call->expand_pos++;
2408                         if (current_call->expand_pos >= current_call->n_parameters) {
2409                                 errorf(&pp_token.base.source_position,
2410                                            "too many arguments passed for macro '%Y'",
2411                                            current_call->symbol);
2412                                 current_argument = NULL;
2413                         } else {
2414                                 current_argument
2415                                         = &current_call->parameters[current_call->expand_pos];
2416                         }
2417                         goto restart;
2418                 } else if (kind == T_MACRO_PARAMETER) {
2419                         /* parameters have to be fully expanded before being used as
2420                          * parameters for another macro-call */
2421                         assert(current_expansion != NULL);
2422                         pp_definition_t *argument = pp_token.macro_parameter.def;
2423                         argument_expanding = argument;
2424                         start_expanding(argument);
2425                         goto restart;
2426                 } else if (kind == T_EOF) {
2427                         errorf(&expansion_pos,
2428                                "reached end of file while parsing arguments for '%Y'",
2429                                current_call->symbol);
2430                         return;
2431                 }
2432                 if (current_argument != NULL) {
2433                         saved_token_t saved;
2434                         saved.token = pp_token;
2435                         saved.had_whitespace = info.had_whitespace;
2436                         obstack_grow(&pp_obstack, &saved, sizeof(saved));
2437                 }
2438                 goto restart;
2439         }
2440 }
2441
2442
2443 static void prepend_include_path(const char *path)
2444 {
2445         searchpath_entry_t *entry = OALLOCZ(&config_obstack, searchpath_entry_t);
2446         entry->path = path;
2447         entry->next = searchpath;
2448         searchpath  = entry;
2449 }
2450
2451 static void setup_include_path(void)
2452 {
2453         /* built-in paths */
2454         prepend_include_path("/usr/include");
2455
2456         /* parse environment variable */
2457         const char *cpath = getenv("CPATH");
2458         if (cpath != NULL && *cpath != '\0') {
2459                 const char *begin = cpath;
2460                 const char *c;
2461                 do {
2462                         c = begin;
2463                         while (*c != '\0' && *c != ':')
2464                                 ++c;
2465
2466                         size_t len = c-begin;
2467                         if (len == 0) {
2468                                 /* for gcc compatibility (Matze: I would expect that
2469                                  * nothing happens for an empty entry...) */
2470                                 prepend_include_path(".");
2471                         } else {
2472                                 char *const string = obstack_copy0(&config_obstack, begin, len);
2473                                 prepend_include_path(string);
2474                         }
2475
2476                         begin = c+1;
2477                         /* skip : */
2478                         if (*begin == ':')
2479                                 ++begin;
2480                 } while(*c != '\0');
2481         }
2482 }
2483
2484 static void input_error(unsigned const delta_lines, unsigned const delta_cols, char const *const message)
2485 {
2486         source_position_t pos = pp_token.base.source_position;
2487         pos.lineno += delta_lines;
2488         pos.colno  += delta_cols;
2489         errorf(&pos, "%s", message);
2490 }
2491
2492 void init_preprocessor(void)
2493 {
2494         init_symbols();
2495
2496         obstack_init(&config_obstack);
2497         obstack_init(&pp_obstack);
2498         obstack_init(&input_obstack);
2499         strset_init(&stringset);
2500
2501         setup_include_path();
2502
2503         set_input_error_callback(input_error);
2504 }
2505
2506 void exit_preprocessor(void)
2507 {
2508         obstack_free(&input_obstack, NULL);
2509         obstack_free(&pp_obstack, NULL);
2510         obstack_free(&config_obstack, NULL);
2511
2512         strset_destroy(&stringset);
2513 }
2514
2515 int pptest_main(int argc, char **argv);
2516 int pptest_main(int argc, char **argv)
2517 {
2518         init_symbol_table();
2519         init_preprocessor();
2520         init_tokens();
2521
2522         error_on_unknown_chars   = false;
2523         resolve_escape_sequences = false;
2524
2525         /* simplistic commandline parser */
2526         const char *filename = NULL;
2527         const char *output = NULL;
2528         for (int i = 1; i < argc; ++i) {
2529                 const char *opt = argv[i];
2530                 if (streq(opt, "-I")) {
2531                         prepend_include_path(argv[++i]);
2532                         continue;
2533                 } else if (streq(opt, "-E")) {
2534                         /* ignore */
2535                 } else if (streq(opt, "-o")) {
2536                         output = argv[++i];
2537                         continue;
2538                 } else if (opt[0] == '-') {
2539                         fprintf(stderr, "Unknown option '%s'\n", opt);
2540                 } else {
2541                         if (filename != NULL)
2542                                 fprintf(stderr, "Multiple inputs not supported\n");
2543                         filename = argv[i];
2544                 }
2545         }
2546         if (filename == NULL) {
2547                 fprintf(stderr, "No input specified\n");
2548                 return 1;
2549         }
2550
2551         if (output == NULL) {
2552                 out = stdout;
2553         } else {
2554                 out = fopen(output, "w");
2555                 if (out == NULL) {
2556                         fprintf(stderr, "Couldn't open output '%s'\n", output);
2557                         return 1;
2558                 }
2559         }
2560
2561         /* just here for gcc compatibility */
2562         fprintf(out, "# 1 \"%s\"\n", filename);
2563         fprintf(out, "# 1 \"<built-in>\"\n");
2564         fprintf(out, "# 1 \"<command-line>\"\n");
2565
2566         FILE *file = fopen(filename, "r");
2567         if (file == NULL) {
2568                 fprintf(stderr, "Couldn't open input '%s'\n", filename);
2569                 return 1;
2570         }
2571         switch_pp_input(file, filename, NULL);
2572
2573         for (;;) {
2574                 next_preprocessing_token();
2575                 if (pp_token.kind == T_EOF)
2576                         break;
2577                 emit_pp_token();
2578         }
2579
2580         fputc('\n', out);
2581         check_unclosed_conditionals();
2582         fclose(close_pp_input());
2583         if (out != stdout)
2584                 fclose(out);
2585
2586         exit_tokens();
2587         exit_preprocessor();
2588         exit_symbol_table();
2589
2590         return 0;
2591 }