3b9c4cb1f98ebd236248c20a9da4548d06a53448
[cparser] / lexer.c
1 /*
2  * This file is part of cparser.
3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18  * 02111-1307, USA.
19  */
20 #include <config.h>
21
22 #include "adt/strutil.h"
23 #include "input.h"
24 #include "diagnostic.h"
25 #include "lexer.h"
26 #include "symbol_t.h"
27 #include "token_t.h"
28 #include "symbol_table_t.h"
29 #include "adt/error.h"
30 #include "adt/strset.h"
31 #include "adt/util.h"
32 #include "types.h"
33 #include "type_t.h"
34 #include "parser.h"
35 #include "warning.h"
36 #include "lang_features.h"
37
38 #include <assert.h>
39 #include <errno.h>
40 #include <string.h>
41 #include <stdbool.h>
42 #include <ctype.h>
43
44 #ifndef _WIN32
45 #include <strings.h>
46 #endif
47
48 #define MAX_PUTBACK 16    // 3 would be enough, but 16 gives a nicer alignment
49 #define BUF_SIZE    1024
50
51 static input_t           *input;
52 static utf32              input_buf[BUF_SIZE + MAX_PUTBACK];
53 static const utf32       *bufpos;
54 static const utf32       *bufend;
55 static utf32              c;
56 static source_position_t  lexer_pos;
57 token_t                   lexer_token;
58 static symbol_t          *symbol_L;
59 static strset_t           stringset;
60 bool                      allow_dollar_in_symbol = true;
61
62 /**
63  * Prints a parse error message at the current token.
64  *
65  * @param msg   the error message
66  */
67 static void parse_error(const char *msg)
68 {
69         errorf(&lexer_pos, "%s", msg);
70 }
71
72 /**
73  * Prints an internal error message at the current token.
74  *
75  * @param msg   the error message
76  */
77 static NORETURN internal_error(const char *msg)
78 {
79         internal_errorf(&lexer_pos, "%s", msg);
80 }
81
82 static inline void next_real_char(void)
83 {
84         assert(bufpos <= bufend);
85         if (bufpos >= bufend) {
86                 size_t n = decode(input, input_buf+MAX_PUTBACK, BUF_SIZE);
87                 if (n == 0) {
88                         c = EOF;
89                         return;
90                 }
91                 bufpos = input_buf + MAX_PUTBACK;
92                 bufend = bufpos + n;
93         }
94         c = *bufpos++;
95         ++lexer_pos.colno;
96 }
97
98 /**
99  * Put a character back into the buffer.
100  *
101  * @param pc  the character to put back
102  */
103 static inline void put_back(utf32 const pc)
104 {
105         *(--bufpos - input_buf + input_buf) = pc;
106         --lexer_pos.colno;
107 }
108
109 static inline void next_char(void);
110
111 #define MATCH_NEWLINE(code)  \
112         case '\r':               \
113                 next_char();         \
114                 if (c == '\n') {     \
115         case '\n':               \
116                         next_char();     \
117                 }                    \
118                 lexer_pos.lineno++;  \
119                 lexer_pos.colno = 1; \
120                 code
121
122 #define eat(c_type) (assert(c == c_type), next_char())
123
124 static void maybe_concat_lines(void)
125 {
126         eat('\\');
127
128         switch (c) {
129         MATCH_NEWLINE(return;)
130
131         default:
132                 break;
133         }
134
135         put_back(c);
136         c = '\\';
137 }
138
139 /**
140  * Set c to the next input character, ie.
141  * after expanding trigraphs.
142  */
143 static inline void next_char(void)
144 {
145         next_real_char();
146
147         /* filter trigraphs */
148         if (UNLIKELY(c == '\\')) {
149                 maybe_concat_lines();
150                 return;
151         }
152
153         if (LIKELY(c != '?'))
154                 return;
155
156         next_real_char();
157         if (LIKELY(c != '?')) {
158                 put_back(c);
159                 c = '?';
160                 return;
161         }
162
163         next_real_char();
164         switch (c) {
165         case '=': c = '#'; break;
166         case '(': c = '['; break;
167         case '/': c = '\\'; maybe_concat_lines(); break;
168         case ')': c = ']'; break;
169         case '\'': c = '^'; break;
170         case '<': c = '{'; break;
171         case '!': c = '|'; break;
172         case '>': c = '}'; break;
173         case '-': c = '~'; break;
174         default:
175                 put_back(c);
176                 put_back('?');
177                 c = '?';
178                 break;
179         }
180 }
181
182 #define SYMBOL_CHARS  \
183         case '$': if (!allow_dollar_in_symbol) goto dollar_sign; \
184         case 'a':         \
185         case 'b':         \
186         case 'c':         \
187         case 'd':         \
188         case 'e':         \
189         case 'f':         \
190         case 'g':         \
191         case 'h':         \
192         case 'i':         \
193         case 'j':         \
194         case 'k':         \
195         case 'l':         \
196         case 'm':         \
197         case 'n':         \
198         case 'o':         \
199         case 'p':         \
200         case 'q':         \
201         case 'r':         \
202         case 's':         \
203         case 't':         \
204         case 'u':         \
205         case 'v':         \
206         case 'w':         \
207         case 'x':         \
208         case 'y':         \
209         case 'z':         \
210         case 'A':         \
211         case 'B':         \
212         case 'C':         \
213         case 'D':         \
214         case 'E':         \
215         case 'F':         \
216         case 'G':         \
217         case 'H':         \
218         case 'I':         \
219         case 'J':         \
220         case 'K':         \
221         case 'L':         \
222         case 'M':         \
223         case 'N':         \
224         case 'O':         \
225         case 'P':         \
226         case 'Q':         \
227         case 'R':         \
228         case 'S':         \
229         case 'T':         \
230         case 'U':         \
231         case 'V':         \
232         case 'W':         \
233         case 'X':         \
234         case 'Y':         \
235         case 'Z':         \
236         case '_':
237
238 #define DIGITS        \
239         case '0':         \
240         case '1':         \
241         case '2':         \
242         case '3':         \
243         case '4':         \
244         case '5':         \
245         case '6':         \
246         case '7':         \
247         case '8':         \
248         case '9':
249
250 /**
251  * Read a symbol from the input and build
252  * the lexer_token.
253  */
254 static void parse_symbol(void)
255 {
256         obstack_1grow(&symbol_obstack, (char) c);
257         next_char();
258
259         while (true) {
260                 switch (c) {
261                 DIGITS
262                 SYMBOL_CHARS
263                         obstack_1grow(&symbol_obstack, (char) c);
264                         next_char();
265                         break;
266
267                 default:
268 dollar_sign:
269                         goto end_symbol;
270                 }
271         }
272
273 end_symbol:
274         obstack_1grow(&symbol_obstack, '\0');
275
276         char     *string = obstack_finish(&symbol_obstack);
277         symbol_t *symbol = symbol_table_insert(string);
278
279         lexer_token.kind        = symbol->ID;
280         lexer_token.base.symbol = symbol;
281
282         if (symbol->string != string) {
283                 obstack_free(&symbol_obstack, string);
284         }
285 }
286
287 static string_t identify_string(char *string, size_t len)
288 {
289         /* TODO hash */
290 #if 0
291         const char *result = strset_insert(&stringset, concat);
292         if (result != concat) {
293                 obstack_free(&symbol_obstack, concat);
294         }
295 #else
296         const char *result = string;
297 #endif
298         return (string_t) {result, len};
299 }
300
301 /**
302  * parse suffixes like 'LU' or 'f' after numbers
303  */
304 static void parse_number_suffix(void)
305 {
306         assert(obstack_object_size(&symbol_obstack) == 0);
307         while (true) {
308                 switch (c) {
309                 SYMBOL_CHARS
310                         obstack_1grow(&symbol_obstack, (char) c);
311                         next_char();
312                         break;
313                 default:
314                 dollar_sign:
315                         goto finish_suffix;
316                 }
317         }
318 finish_suffix:
319         if (obstack_object_size(&symbol_obstack) == 0) {
320                 lexer_token.number.suffix.begin = NULL;
321                 lexer_token.number.suffix.size  = 0;
322                 return;
323         }
324
325         obstack_1grow(&symbol_obstack, '\0');
326         size_t size   = obstack_object_size(&symbol_obstack) - 1;
327         char  *string = obstack_finish(&symbol_obstack);
328
329         lexer_token.number.suffix = identify_string(string, size);
330 }
331
332 static void parse_exponent(void)
333 {
334         if (c == '-' || c == '+') {
335                 obstack_1grow(&symbol_obstack, (char)c);
336                 next_char();
337         }
338
339         if (isdigit(c)) {
340                 do {
341                         obstack_1grow(&symbol_obstack, (char)c);
342                         next_char();
343                 } while (isdigit(c));
344         } else {
345                 errorf(&lexer_token.base.source_position, "exponent has no digits");
346         }
347 }
348
349 /**
350  * Parses a hex number including hex floats and set the
351  * lexer_token.
352  */
353 static void parse_number_hex(void)
354 {
355         bool is_float   = false;
356         bool has_digits = false;
357
358         while (isxdigit(c)) {
359                 has_digits = true;
360                 obstack_1grow(&symbol_obstack, (char) c);
361                 next_char();
362         }
363
364         if (c == '.') {
365                 is_float = true;
366                 obstack_1grow(&symbol_obstack, (char) c);
367                 next_char();
368
369                 while (isxdigit(c)) {
370                         has_digits = true;
371                         obstack_1grow(&symbol_obstack, (char) c);
372                         next_char();
373                 }
374         }
375         if (c == 'p' || c == 'P') {
376                 is_float = true;
377                 obstack_1grow(&symbol_obstack, (char) c);
378                 next_char();
379                 parse_exponent();
380         } else if (is_float) {
381                 errorf(&lexer_token.base.source_position,
382                        "hexadecimal floatingpoint constant requires an exponent");
383         }
384         obstack_1grow(&symbol_obstack, '\0');
385
386         size_t  size   = obstack_object_size(&symbol_obstack) - 1;
387         char   *string = obstack_finish(&symbol_obstack);
388         lexer_token.number.number = identify_string(string, size);
389
390         lexer_token.kind = is_float ? T_FLOATINGPOINT : T_INTEGER;
391
392         if (!has_digits) {
393                 errorf(&lexer_token.base.source_position, "invalid number literal '%S'", &lexer_token.number.number);
394                 lexer_token.number.number.begin = "0";
395                 lexer_token.number.number.size  = 1;
396         }
397
398         parse_number_suffix();
399 }
400
401 static void parse_number_bin(void)
402 {
403         bool has_digits = false;
404
405         while (c == '0' || c == '1') {
406                 has_digits = true;
407                 obstack_1grow(&symbol_obstack, (char)c);
408                 next_char();
409         }
410         obstack_1grow(&symbol_obstack, '\0');
411
412         size_t  const size   = obstack_object_size(&symbol_obstack) - 1;
413         char   *const string = obstack_finish(&symbol_obstack);
414         lexer_token.number.number = identify_string(string, size);
415         lexer_token.kind          = T_INTEGER;
416
417         if (!has_digits) {
418                 errorf(&lexer_token.base.source_position, "invalid number literal '%S'", &lexer_token.number.number);
419                 lexer_token.number.number.begin = "0";
420                 lexer_token.number.number.size  = 1;
421         }
422
423         parse_number_suffix();
424 }
425
426 /**
427  * Returns true if the given char is a octal digit.
428  *
429  * @param char  the character to check
430  */
431 static bool is_octal_digit(utf32 chr)
432 {
433         return '0' <= chr && chr <= '7';
434 }
435
436 /**
437  * Parses a number and sets the lexer_token.
438  */
439 static void parse_number(void)
440 {
441         bool is_float   = false;
442         bool has_digits = false;
443
444         assert(obstack_object_size(&symbol_obstack) == 0);
445         if (c == '0') {
446                 obstack_1grow(&symbol_obstack, (char)c);
447                 next_char();
448                 if (c == 'x' || c == 'X') {
449                         obstack_1grow(&symbol_obstack, (char)c);
450                         next_char();
451                         parse_number_hex();
452                         return;
453                 } else if (c == 'b' || c == 'B') {
454                         /* GCC extension: binary constant 0x[bB][01]+.  */
455                         obstack_1grow(&symbol_obstack, (char)c);
456                         next_char();
457                         parse_number_bin();
458                         return;
459                 }
460                 has_digits = true;
461         }
462
463         while (isdigit(c)) {
464                 has_digits = true;
465                 obstack_1grow(&symbol_obstack, (char) c);
466                 next_char();
467         }
468
469         if (c == '.') {
470                 is_float = true;
471                 obstack_1grow(&symbol_obstack, '.');
472                 next_char();
473
474                 while (isdigit(c)) {
475                         has_digits = true;
476                         obstack_1grow(&symbol_obstack, (char) c);
477                         next_char();
478                 }
479         }
480         if (c == 'e' || c == 'E') {
481                 is_float = true;
482                 obstack_1grow(&symbol_obstack, 'e');
483                 next_char();
484                 parse_exponent();
485         }
486
487         obstack_1grow(&symbol_obstack, '\0');
488         size_t  size   = obstack_object_size(&symbol_obstack) - 1;
489         char   *string = obstack_finish(&symbol_obstack);
490         lexer_token.number.number = identify_string(string, size);
491
492         if (is_float) {
493                 lexer_token.kind = T_FLOATINGPOINT;
494         } else {
495                 lexer_token.kind = T_INTEGER;
496
497                 if (string[0] == '0') {
498                         /* check for invalid octal digits */
499                         for (size_t i= 0; i < size; ++i) {
500                                 char t = string[i];
501                                 if (t >= '8')
502                                         errorf(&lexer_token.base.source_position, "invalid digit '%c' in octal number", t);
503                         }
504                 }
505         }
506
507         if (!has_digits) {
508                 errorf(&lexer_token.base.source_position, "invalid number literal '%S'",
509                        &lexer_token.number.number);
510         }
511
512         parse_number_suffix();
513 }
514
515 /**
516  * Returns the value of a digit.
517  * The only portable way to do it ...
518  */
519 static int digit_value(utf32 const digit)
520 {
521         switch (digit) {
522         case '0': return 0;
523         case '1': return 1;
524         case '2': return 2;
525         case '3': return 3;
526         case '4': return 4;
527         case '5': return 5;
528         case '6': return 6;
529         case '7': return 7;
530         case '8': return 8;
531         case '9': return 9;
532         case 'a':
533         case 'A': return 10;
534         case 'b':
535         case 'B': return 11;
536         case 'c':
537         case 'C': return 12;
538         case 'd':
539         case 'D': return 13;
540         case 'e':
541         case 'E': return 14;
542         case 'f':
543         case 'F': return 15;
544         default:
545                 internal_error("wrong character given");
546         }
547 }
548
549 /**
550  * Parses an octal character sequence.
551  *
552  * @param first_digit  the already read first digit
553  */
554 static utf32 parse_octal_sequence(utf32 const first_digit)
555 {
556         assert(is_octal_digit(first_digit));
557         utf32 value = digit_value(first_digit);
558         if (!is_octal_digit(c)) return value;
559         value = 8 * value + digit_value(c);
560         next_char();
561         if (!is_octal_digit(c)) return value;
562         value = 8 * value + digit_value(c);
563         next_char();
564         return value;
565 }
566
567 /**
568  * Parses a hex character sequence.
569  */
570 static utf32 parse_hex_sequence(void)
571 {
572         utf32 value = 0;
573         while (isxdigit(c)) {
574                 value = 16 * value + digit_value(c);
575                 next_char();
576         }
577         return value;
578 }
579
580 /**
581  * Parse an escape sequence.
582  */
583 static utf32 parse_escape_sequence(void)
584 {
585         eat('\\');
586
587         utf32 const ec = c;
588         next_char();
589
590         switch (ec) {
591         case '"':  return '"';
592         case '\'': return '\'';
593         case '\\': return '\\';
594         case '?': return '\?';
595         case 'a': return '\a';
596         case 'b': return '\b';
597         case 'f': return '\f';
598         case 'n': return '\n';
599         case 'r': return '\r';
600         case 't': return '\t';
601         case 'v': return '\v';
602         case 'x':
603                 return parse_hex_sequence();
604         case '0':
605         case '1':
606         case '2':
607         case '3':
608         case '4':
609         case '5':
610         case '6':
611         case '7':
612                 return parse_octal_sequence(ec);
613         case EOF:
614                 parse_error("reached end of file while parsing escape sequence");
615                 return EOF;
616         /* \E is not documented, but handled, by GCC.  It is acceptable according
617          * to Â§6.11.4, whereas \e is not. */
618         case 'E':
619         case 'e':
620                 if (c_mode & _GNUC)
621                         return 27;   /* hopefully 27 is ALWAYS the code for ESCAPE */
622                 break;
623         case 'u':
624         case 'U':
625                 parse_error("universal character parsing not implemented yet");
626                 return EOF;
627         default:
628                 break;
629         }
630         /* Â§6.4.4.4:8 footnote 64 */
631         parse_error("unknown escape sequence");
632         return EOF;
633 }
634
635 string_t make_string(const char *string)
636 {
637         size_t      len   = strlen(string) + 1;
638         char *const space = obstack_alloc(&symbol_obstack, len);
639         memcpy(space, string, len);
640
641         return identify_string(space, len);
642 }
643
644 /**
645  * Parse a string literal and set lexer_token.
646  */
647 static void parse_string_literal(string_encoding_t const enc)
648 {
649         eat('"');
650
651         while (true) {
652                 switch (c) {
653                 case '\\': {
654                         utf32 const tc = parse_escape_sequence();
655                         if (tc >= 0x100) {
656                                 warningf(WARN_OTHER, &lexer_pos, "escape sequence out of range");
657                         }
658                         obstack_1grow(&symbol_obstack, tc);
659                         break;
660                 }
661
662                 case EOF:
663                         errorf(&lexer_token.base.source_position, "string has no end");
664                         goto end_of_string;
665
666                 case '"':
667                         next_char();
668                         goto end_of_string;
669
670                 default:
671                         obstack_grow_symbol(&symbol_obstack, c);
672                         next_char();
673                         break;
674                 }
675         }
676
677 end_of_string:
678
679         /* TODO: concatenate multiple strings separated by whitespace... */
680
681         /* add finishing 0 to the string */
682         obstack_1grow(&symbol_obstack, '\0');
683         const size_t  size   = (size_t)obstack_object_size(&symbol_obstack);
684         char         *string = obstack_finish(&symbol_obstack);
685
686         lexer_token.kind            = T_STRING_LITERAL;
687         lexer_token.string.encoding = enc;
688         lexer_token.string.string   = identify_string(string, size);
689 }
690
691 /**
692  * Parse a wide character constant and set lexer_token.
693  */
694 static void parse_wide_character_constant(void)
695 {
696         eat('\'');
697
698         while (true) {
699                 switch (c) {
700                 case '\\': {
701                         const utf32 tc = parse_escape_sequence();
702                         obstack_grow_symbol(&symbol_obstack, tc);
703                         break;
704                 }
705
706                 MATCH_NEWLINE(
707                         parse_error("newline while parsing character constant");
708                         break;
709                 )
710
711                 case '\'':
712                         next_char();
713                         goto end_of_wide_char_constant;
714
715                 case EOF:
716                         errorf(&lexer_token.base.source_position, "EOF while parsing character constant");
717                         goto end_of_wide_char_constant;
718
719                 default:
720                         obstack_grow_symbol(&symbol_obstack, c);
721                         next_char();
722                         break;
723                 }
724         }
725
726 end_of_wide_char_constant:;
727         obstack_1grow(&symbol_obstack, '\0');
728         size_t  size   = (size_t) obstack_object_size(&symbol_obstack) - 1;
729         char   *string = obstack_finish(&symbol_obstack);
730
731         lexer_token.kind          = T_WIDE_CHARACTER_CONSTANT;
732         lexer_token.string.string = identify_string(string, size);
733
734         if (size == 0) {
735                 errorf(&lexer_token.base.source_position, "empty character constant");
736         }
737 }
738
739 /**
740  * Parse a character constant and set lexer_token.
741  */
742 static void parse_character_constant(void)
743 {
744         eat('\'');
745
746         while (true) {
747                 switch (c) {
748                 case '\\': {
749                         utf32 const tc = parse_escape_sequence();
750                         if (tc >= 0x100) {
751                                 warningf(WARN_OTHER, &lexer_pos, "escape sequence out of range");
752                         }
753                         obstack_1grow(&symbol_obstack, tc);
754                         break;
755                 }
756
757                 MATCH_NEWLINE(
758                         parse_error("newline while parsing character constant");
759                         break;
760                 )
761
762                 case '\'':
763                         next_char();
764                         goto end_of_char_constant;
765
766                 case EOF:
767                         errorf(&lexer_token.base.source_position, "EOF while parsing character constant");
768                         goto end_of_char_constant;
769
770                 default:
771                         obstack_grow_symbol(&symbol_obstack, c);
772                         next_char();
773                         break;
774
775                 }
776         }
777
778 end_of_char_constant:;
779         obstack_1grow(&symbol_obstack, '\0');
780         const size_t        size   = (size_t)obstack_object_size(&symbol_obstack)-1;
781         char         *const string = obstack_finish(&symbol_obstack);
782
783         lexer_token.kind          = T_CHARACTER_CONSTANT;
784         lexer_token.string.string = identify_string(string, size);
785
786         if (size == 0) {
787                 errorf(&lexer_token.base.source_position, "empty character constant");
788         }
789 }
790
791 /**
792  * Skip a multiline comment.
793  */
794 static void skip_multiline_comment(void)
795 {
796         while (true) {
797                 switch (c) {
798                 case '/':
799                         next_char();
800                         if (c == '*') {
801                                 /* nested comment, warn here */
802                                 warningf(WARN_COMMENT, &lexer_pos, "'/*' within comment");
803                         }
804                         break;
805                 case '*':
806                         next_char();
807                         if (c == '/') {
808                                 next_char();
809                                 return;
810                         }
811                         break;
812
813                 MATCH_NEWLINE(break;)
814
815                 case EOF: {
816                         errorf(&lexer_token.base.source_position,
817                                "at end of file while looking for comment end");
818                         return;
819                 }
820
821                 default:
822                         next_char();
823                         break;
824                 }
825         }
826 }
827
828 /**
829  * Skip a single line comment.
830  */
831 static void skip_line_comment(void)
832 {
833         while (true) {
834                 switch (c) {
835                 case EOF:
836                         return;
837
838                 case '\n':
839                 case '\r':
840                         return;
841
842                 case '\\':
843                         next_char();
844                         if (c == '\n' || c == '\r') {
845                                 warningf(WARN_COMMENT, &lexer_pos, "multi-line comment");
846                                 return;
847                         }
848                         break;
849
850                 default:
851                         next_char();
852                         break;
853                 }
854         }
855 }
856
857 /** The current preprocessor token. */
858 static token_t pp_token;
859
860 /**
861  * Read the next preprocessor token.
862  */
863 static inline void next_pp_token(void)
864 {
865         lexer_next_preprocessing_token();
866         pp_token = lexer_token;
867 }
868
869 /**
870  * Eat all preprocessor tokens until newline.
871  */
872 static void eat_until_newline(void)
873 {
874         while (pp_token.kind != '\n' && pp_token.kind != T_EOF) {
875                 next_pp_token();
876         }
877 }
878
879 /**
880  * Parse the line directive.
881  */
882 static void parse_line_directive(void)
883 {
884         if (pp_token.kind != T_INTEGER) {
885                 parse_error("expected integer");
886         } else {
887                 /* use offset -1 as this is about the next line */
888                 lexer_pos.lineno = atoi(pp_token.number.number.begin) - 1;
889                 next_pp_token();
890         }
891         if (pp_token.kind == T_STRING_LITERAL && pp_token.string.encoding == STRING_ENCODING_CHAR) {
892                 lexer_pos.input_name = pp_token.string.string.begin;
893                 lexer_pos.is_system_header = false;
894                 next_pp_token();
895
896                 /* attempt to parse numeric flags as outputted by gcc preprocessor */
897                 while (pp_token.kind == T_INTEGER) {
898                         /* flags:
899                          * 1 - indicates start of a new file
900                          * 2 - indicates return from a file
901                          * 3 - indicates system header
902                          * 4 - indicates implicit extern "C" in C++ mode
903                          *
904                          * currently we're only interested in "3"
905                          */
906                         if (streq(pp_token.number.number.begin, "3")) {
907                                 lexer_pos.is_system_header = true;
908                         }
909                         next_pp_token();
910                 }
911         }
912
913         eat_until_newline();
914 }
915
916 /**
917  * STDC pragmas.
918  */
919 typedef enum stdc_pragma_kind_t {
920         STDC_UNKNOWN,
921         STDC_FP_CONTRACT,
922         STDC_FENV_ACCESS,
923         STDC_CX_LIMITED_RANGE
924 } stdc_pragma_kind_t;
925
926 /**
927  * STDC pragma values.
928  */
929 typedef enum stdc_pragma_value_kind_t {
930         STDC_VALUE_UNKNOWN,
931         STDC_VALUE_ON,
932         STDC_VALUE_OFF,
933         STDC_VALUE_DEFAULT
934 } stdc_pragma_value_kind_t;
935
936 /**
937  * Parse a pragma directive.
938  */
939 static void parse_pragma(void)
940 {
941         next_pp_token();
942         if (pp_token.kind != T_IDENTIFIER) {
943                 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
944                          "expected identifier after #pragma");
945                 eat_until_newline();
946                 return;
947         }
948
949         stdc_pragma_kind_t kind = STDC_UNKNOWN;
950         if (pp_token.base.symbol->pp_ID == TP_STDC && c_mode & _C99) {
951                 /* a STDC pragma */
952                 next_pp_token();
953
954                 switch (pp_token.base.symbol->pp_ID) {
955                 case TP_FP_CONTRACT:      kind = STDC_FP_CONTRACT;      break;
956                 case TP_FENV_ACCESS:      kind = STDC_FENV_ACCESS;      break;
957                 case TP_CX_LIMITED_RANGE: kind = STDC_CX_LIMITED_RANGE; break;
958                 default:                  break;
959                 }
960                 if (kind != STDC_UNKNOWN) {
961                         next_pp_token();
962                         stdc_pragma_value_kind_t value;
963                         switch (pp_token.base.symbol->pp_ID) {
964                         case TP_ON:      value = STDC_VALUE_ON;      break;
965                         case TP_OFF:     value = STDC_VALUE_OFF;     break;
966                         case TP_DEFAULT: value = STDC_VALUE_DEFAULT; break;
967                         default:         value = STDC_VALUE_UNKNOWN; break;
968                         }
969                         if (value == STDC_VALUE_UNKNOWN) {
970                                 kind = STDC_UNKNOWN;
971                                 errorf(&pp_token.base.source_position, "bad STDC pragma argument");
972                         }
973                 }
974         }
975         eat_until_newline();
976         if (kind == STDC_UNKNOWN) {
977                 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
978                          "encountered unknown #pragma");
979         }
980 }
981
982 /**
983  * Parse a preprocessor non-null directive.
984  */
985 static void parse_preprocessor_identifier(void)
986 {
987         assert(pp_token.kind == T_IDENTIFIER);
988         switch (pp_token.base.symbol->pp_ID) {
989         case TP_line:
990                 next_pp_token();
991                 parse_line_directive();
992                 break;
993         case TP_pragma:
994                 parse_pragma();
995                 break;
996         case TP_error:
997                 /* TODO; output the rest of the line */
998                 parse_error("#error directive");
999                 break;
1000         }
1001 }
1002
1003 /**
1004  * Parse a preprocessor directive.
1005  */
1006 static void parse_preprocessor_directive(void)
1007 {
1008         next_pp_token();
1009
1010         switch (pp_token.kind) {
1011         case T_IDENTIFIER:
1012                 parse_preprocessor_identifier();
1013                 break;
1014         case T_INTEGER:
1015                 parse_line_directive();
1016                 break;
1017         case '\n':
1018                 /* NULL directive, see Â§6.10.7 */
1019                 break;
1020         default:
1021                 parse_error("invalid preprocessor directive");
1022                 eat_until_newline();
1023                 break;
1024         }
1025 }
1026
1027 #define MAYBE_PROLOG                                       \
1028                         next_char();                                   \
1029                         while (true) {                                 \
1030                                 switch (c) {
1031
1032 #define MAYBE(ch, set_type)                                \
1033                                 case ch:                                   \
1034                                         next_char();                           \
1035                                         lexer_token.kind = set_type;           \
1036                                         return;
1037
1038 /* must use this as last thing */
1039 #define MAYBE_MODE(ch, set_type, mode)                     \
1040                                 case ch:                                   \
1041                                         if (c_mode & mode) {                   \
1042                                                 next_char();                       \
1043                                                 lexer_token.kind = set_type;       \
1044                                                 return;                            \
1045                                         }                                      \
1046                                         /* fallthrough */
1047
1048 #define ELSE_CODE(code)                                    \
1049                                 default:                                   \
1050                                         code                                   \
1051                                         return;                                \
1052                                 }                                          \
1053                         } /* end of while (true) */                    \
1054
1055 #define ELSE(set_type)                                     \
1056                 ELSE_CODE(                                         \
1057                         lexer_token.kind = set_type;                   \
1058                 )
1059
1060 void lexer_next_preprocessing_token(void)
1061 {
1062         while (true) {
1063                 lexer_token.base.source_position = lexer_pos;
1064                 lexer_token.base.symbol          = NULL;
1065
1066                 switch (c) {
1067                 case ' ':
1068                 case '\t':
1069                         next_char();
1070                         break;
1071
1072                 MATCH_NEWLINE(
1073                         lexer_token.kind = '\n';
1074                         return;
1075                 )
1076
1077                 SYMBOL_CHARS {
1078                         parse_symbol();
1079                         /* might be a wide string ( L"string" ) */
1080                         string_encoding_t const enc = STRING_ENCODING_WIDE;
1081                         if (lexer_token.base.symbol == symbol_L) {
1082                                 switch (c) {
1083                                         case '"':  parse_string_literal(enc);       break;
1084                                         case '\'': parse_wide_character_constant(); break;
1085                                 }
1086                         }
1087                         return;
1088                 }
1089
1090                 DIGITS
1091                         parse_number();
1092                         return;
1093
1094                 case '"':
1095                         parse_string_literal(STRING_ENCODING_CHAR);
1096                         return;
1097
1098                 case '\'':
1099                         parse_character_constant();
1100                         return;
1101
1102                 case '.':
1103                         MAYBE_PROLOG
1104                                 DIGITS
1105                                         put_back(c);
1106                                         c = '.';
1107                                         parse_number();
1108                                         return;
1109
1110                                 case '.':
1111                                         MAYBE_PROLOG
1112                                         MAYBE('.', T_DOTDOTDOT)
1113                                         ELSE_CODE(
1114                                                 put_back(c);
1115                                                 c = '.';
1116                                                 lexer_token.kind = '.';
1117                                         )
1118                         ELSE('.')
1119                 case '&':
1120                         MAYBE_PROLOG
1121                         MAYBE('&', T_ANDAND)
1122                         MAYBE('=', T_ANDEQUAL)
1123                         ELSE('&')
1124                 case '*':
1125                         MAYBE_PROLOG
1126                         MAYBE('=', T_ASTERISKEQUAL)
1127                         ELSE('*')
1128                 case '+':
1129                         MAYBE_PROLOG
1130                         MAYBE('+', T_PLUSPLUS)
1131                         MAYBE('=', T_PLUSEQUAL)
1132                         ELSE('+')
1133                 case '-':
1134                         MAYBE_PROLOG
1135                         MAYBE('>', T_MINUSGREATER)
1136                         MAYBE('-', T_MINUSMINUS)
1137                         MAYBE('=', T_MINUSEQUAL)
1138                         ELSE('-')
1139                 case '!':
1140                         MAYBE_PROLOG
1141                         MAYBE('=', T_EXCLAMATIONMARKEQUAL)
1142                         ELSE('!')
1143                 case '/':
1144                         MAYBE_PROLOG
1145                         MAYBE('=', T_SLASHEQUAL)
1146                                 case '*':
1147                                         next_char();
1148                                         skip_multiline_comment();
1149                                         lexer_next_preprocessing_token();
1150                                         return;
1151                                 case '/':
1152                                         next_char();
1153                                         skip_line_comment();
1154                                         lexer_next_preprocessing_token();
1155                                         return;
1156                         ELSE('/')
1157                 case '%':
1158                         MAYBE_PROLOG
1159                         MAYBE('>', '}')
1160                         MAYBE('=', T_PERCENTEQUAL)
1161                                 case ':':
1162                                         MAYBE_PROLOG
1163                                                 case '%':
1164                                                         MAYBE_PROLOG
1165                                                         MAYBE(':', T_HASHHASH)
1166                                                         ELSE_CODE(
1167                                                                 put_back(c);
1168                                                                 c = '%';
1169                                                                 lexer_token.kind = '#';
1170                                                         )
1171                                         ELSE('#')
1172                         ELSE('%')
1173                 case '<':
1174                         MAYBE_PROLOG
1175                         MAYBE(':', '[')
1176                         MAYBE('%', '{')
1177                         MAYBE('=', T_LESSEQUAL)
1178                                 case '<':
1179                                         MAYBE_PROLOG
1180                                         MAYBE('=', T_LESSLESSEQUAL)
1181                                         ELSE(T_LESSLESS)
1182                         ELSE('<')
1183                 case '>':
1184                         MAYBE_PROLOG
1185                         MAYBE('=', T_GREATEREQUAL)
1186                                 case '>':
1187                                         MAYBE_PROLOG
1188                                         MAYBE('=', T_GREATERGREATEREQUAL)
1189                                         ELSE(T_GREATERGREATER)
1190                         ELSE('>')
1191                 case '^':
1192                         MAYBE_PROLOG
1193                         MAYBE('=', T_CARETEQUAL)
1194                         ELSE('^')
1195                 case '|':
1196                         MAYBE_PROLOG
1197                         MAYBE('=', T_PIPEEQUAL)
1198                         MAYBE('|', T_PIPEPIPE)
1199                         ELSE('|')
1200                 case ':':
1201                         MAYBE_PROLOG
1202                         MAYBE('>', ']')
1203                         MAYBE_MODE(':', T_COLONCOLON, _CXX)
1204                         ELSE(':')
1205                 case '=':
1206                         MAYBE_PROLOG
1207                         MAYBE('=', T_EQUALEQUAL)
1208                         ELSE('=')
1209                 case '#':
1210                         MAYBE_PROLOG
1211                         MAYBE('#', T_HASHHASH)
1212                         ELSE('#')
1213
1214                 case '?':
1215                 case '[':
1216                 case ']':
1217                 case '(':
1218                 case ')':
1219                 case '{':
1220                 case '}':
1221                 case '~':
1222                 case ';':
1223                 case ',':
1224                 case '\\':
1225                         lexer_token.kind = c;
1226                         next_char();
1227                         return;
1228
1229                 case EOF:
1230                         lexer_token.kind = T_EOF;
1231                         return;
1232
1233                 default:
1234 dollar_sign:
1235                         errorf(&lexer_pos, "unknown character '%c' found", c);
1236                         next_char();
1237                         break;
1238                 }
1239         }
1240 }
1241
1242 void lexer_next_token(void)
1243 {
1244         lexer_next_preprocessing_token();
1245
1246         while (lexer_token.kind == '\n') {
1247 newline_found:
1248                 lexer_next_preprocessing_token();
1249         }
1250
1251         if (lexer_token.kind == '#') {
1252                 parse_preprocessor_directive();
1253                 goto newline_found;
1254         }
1255 }
1256
1257 void init_lexer(void)
1258 {
1259         strset_init(&stringset);
1260         symbol_L = symbol_table_insert("L");
1261 }
1262
1263 static void input_error(unsigned delta_lines, unsigned delta_cols,
1264                         const char *message)
1265 {
1266         lexer_pos.lineno += delta_lines;
1267         lexer_pos.colno  += delta_cols;
1268         errorf(&lexer_pos, "%s", message);
1269 }
1270
1271 void lexer_switch_input(input_t *new_input, const char *input_name)
1272 {
1273         lexer_pos.lineno     = 0;
1274         lexer_pos.colno      = 0;
1275         lexer_pos.input_name = input_name;
1276
1277         set_input_error_callback(input_error);
1278         input  = new_input;
1279         bufpos = NULL;
1280         bufend = NULL;
1281
1282         /* place a virtual \n at the beginning so the lexer knows that we're
1283          * at the beginning of a line */
1284         c = '\n';
1285 }
1286
1287 void exit_lexer(void)
1288 {
1289         strset_destroy(&stringset);
1290 }
1291
1292 static __attribute__((unused))
1293 void dbg_pos(const source_position_t source_position)
1294 {
1295         fprintf(stdout, "%s:%u:%u\n", source_position.input_name,
1296                 source_position.lineno, (unsigned)source_position.colno);
1297         fflush(stdout);
1298 }