2 * This file is part of cparser.
3 * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
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.
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.
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
23 #include "diagnostic.h"
27 #include "symbol_table_t.h"
28 #include "adt/error.h"
29 #include "adt/strset.h"
33 #include "target_architecture.h"
36 #include "lang_features.h"
48 #define MAX_PUTBACK 16 // 3 would be enough, but 16 gives a nicer alignment
51 static input_t *input;
52 static utf32 input_buf[BUF_SIZE + MAX_PUTBACK];
53 static const utf32 *bufpos;
54 static const utf32 *bufend;
56 static source_position_t lexer_pos;
58 static symbol_t *symbol_L;
59 static strset_t stringset;
60 static char *encoding;
61 bool allow_dollar_in_symbol = true;
64 * Prints a parse error message at the current token.
66 * @param msg the error message
68 static void parse_error(const char *msg)
70 errorf(&lexer_pos, "%s", msg);
74 * Prints an internal error message at the current token.
76 * @param msg the error message
78 static NORETURN internal_error(const char *msg)
80 internal_errorf(&lexer_pos, "%s", msg);
83 static inline void next_real_char(void)
85 assert(bufpos <= bufend);
86 if (bufpos >= bufend) {
87 size_t n = decode(input, input_buf+MAX_PUTBACK, BUF_SIZE);
92 bufpos = input_buf + MAX_PUTBACK;
100 * Put a character back into the buffer.
102 * @param pc the character to put back
104 static inline void put_back(utf32 const pc)
106 *(--bufpos - input_buf + input_buf) = pc;
110 static inline void next_char(void);
112 #define MATCH_NEWLINE(code) \
119 lexer_pos.lineno++; \
120 lexer_pos.colno = 1; \
123 #define eat(c_type) (assert(c == c_type), next_char())
125 static void maybe_concat_lines(void)
130 MATCH_NEWLINE(return;)
141 * Set c to the next input character, ie.
142 * after expanding trigraphs.
144 static inline void next_char(void)
148 /* filter trigraphs */
149 if (UNLIKELY(c == '\\')) {
150 maybe_concat_lines();
154 if (LIKELY(c != '?'))
158 if (LIKELY(c != '?')) {
166 case '=': c = '#'; break;
167 case '(': c = '['; break;
168 case '/': c = '\\'; maybe_concat_lines(); break;
169 case ')': c = ']'; break;
170 case '\'': c = '^'; break;
171 case '<': c = '{'; break;
172 case '!': c = '|'; break;
173 case '>': c = '}'; break;
174 case '-': c = '~'; break;
183 #define SYMBOL_CHARS \
184 case '$': if (!allow_dollar_in_symbol) goto dollar_sign; \
252 * Read a symbol from the input and build
255 static void parse_symbol(void)
257 obstack_1grow(&symbol_obstack, (char) c);
264 obstack_1grow(&symbol_obstack, (char) c);
275 obstack_1grow(&symbol_obstack, '\0');
277 char *string = obstack_finish(&symbol_obstack);
278 symbol_t *symbol = symbol_table_insert(string);
280 lexer_token.kind = symbol->ID;
281 lexer_token.identifier.symbol = symbol;
283 if (symbol->string != string) {
284 obstack_free(&symbol_obstack, string);
288 static string_t identify_string(char *string, size_t len)
292 const char *result = strset_insert(&stringset, concat);
293 if (result != concat) {
294 obstack_free(&symbol_obstack, concat);
297 const char *result = string;
299 return (string_t) {result, len};
303 * parse suffixes like 'LU' or 'f' after numbers
305 static void parse_number_suffix(void)
307 assert(obstack_object_size(&symbol_obstack) == 0);
311 obstack_1grow(&symbol_obstack, (char) c);
320 if (obstack_object_size(&symbol_obstack) == 0) {
321 lexer_token.number.suffix.begin = NULL;
322 lexer_token.number.suffix.size = 0;
326 obstack_1grow(&symbol_obstack, '\0');
327 size_t size = obstack_object_size(&symbol_obstack);
328 char *string = obstack_finish(&symbol_obstack);
330 lexer_token.number.suffix = identify_string(string, size);
334 * Parses a hex number including hex floats and set the
337 static void parse_number_hex(void)
339 bool is_float = false;
340 bool has_digits = false;
342 assert(obstack_object_size(&symbol_obstack) == 0);
343 while (isxdigit(c)) {
345 obstack_1grow(&symbol_obstack, (char) c);
351 obstack_1grow(&symbol_obstack, (char) c);
354 while (isxdigit(c)) {
356 obstack_1grow(&symbol_obstack, (char) c);
360 if (c == 'p' || c == 'P') {
362 obstack_1grow(&symbol_obstack, (char) c);
365 if (c == '-' || c == '+') {
366 obstack_1grow(&symbol_obstack, (char) c);
370 while (isxdigit(c)) {
371 obstack_1grow(&symbol_obstack, (char) c);
374 } else if (is_float) {
375 errorf(&lexer_token.base.source_position,
376 "hexadecimal floatingpoint constant requires an exponent");
378 obstack_1grow(&symbol_obstack, '\0');
380 size_t size = obstack_object_size(&symbol_obstack) - 1;
381 char *string = obstack_finish(&symbol_obstack);
382 lexer_token.number.number = identify_string(string, size);
385 is_float ? T_FLOATINGPOINT_HEXADECIMAL : T_INTEGER_HEXADECIMAL;
388 errorf(&lexer_token.base.source_position,
389 "invalid number literal '0x%S'", &lexer_token.number.number);
390 lexer_token.number.number.begin = "0";
391 lexer_token.number.number.size = 1;
394 parse_number_suffix();
398 * Returns true if the given char is a octal digit.
400 * @param char the character to check
402 static bool is_octal_digit(utf32 chr)
404 return '0' <= chr && chr <= '7';
408 * Parses a number and sets the lexer_token.
410 static void parse_number(void)
412 bool is_float = false;
413 bool has_digits = false;
415 assert(obstack_object_size(&symbol_obstack) == 0);
418 if (c == 'x' || c == 'X') {
425 obstack_1grow(&symbol_obstack, '0');
430 obstack_1grow(&symbol_obstack, (char) c);
436 obstack_1grow(&symbol_obstack, '.');
441 obstack_1grow(&symbol_obstack, (char) c);
445 if (c == 'e' || c == 'E') {
447 obstack_1grow(&symbol_obstack, 'e');
450 if (c == '-' || c == '+') {
451 obstack_1grow(&symbol_obstack, (char) c);
456 obstack_1grow(&symbol_obstack, (char) c);
461 obstack_1grow(&symbol_obstack, '\0');
462 size_t size = obstack_object_size(&symbol_obstack) - 1;
463 char *string = obstack_finish(&symbol_obstack);
464 lexer_token.number.number = identify_string(string, size);
466 /* is it an octal number? */
468 lexer_token.kind = T_FLOATINGPOINT;
469 } else if (string[0] == '0') {
470 lexer_token.kind = T_INTEGER_OCTAL;
472 /* check for invalid octal digits */
473 for (size_t i= 0; i < size; ++i) {
476 errorf(&lexer_token.base.source_position,
477 "invalid digit '%c' in octal number", t);
480 lexer_token.kind = T_INTEGER;
484 errorf(&lexer_token.base.source_position, "invalid number literal '%S'",
485 &lexer_token.number.number);
488 parse_number_suffix();
492 * Returns the value of a digit.
493 * The only portable way to do it ...
495 static int digit_value(utf32 const digit)
521 internal_error("wrong character given");
526 * Parses an octal character sequence.
528 * @param first_digit the already read first digit
530 static utf32 parse_octal_sequence(utf32 const first_digit)
532 assert(is_octal_digit(first_digit));
533 utf32 value = digit_value(first_digit);
534 if (!is_octal_digit(c)) return value;
535 value = 8 * value + digit_value(c);
537 if (!is_octal_digit(c)) return value;
538 value = 8 * value + digit_value(c);
544 * Parses a hex character sequence.
546 static utf32 parse_hex_sequence(void)
549 while (isxdigit(c)) {
550 value = 16 * value + digit_value(c);
557 * Parse an escape sequence.
559 static utf32 parse_escape_sequence(void)
567 case '"': return '"';
568 case '\'': return '\'';
569 case '\\': return '\\';
570 case '?': return '\?';
571 case 'a': return '\a';
572 case 'b': return '\b';
573 case 'f': return '\f';
574 case 'n': return '\n';
575 case 'r': return '\r';
576 case 't': return '\t';
577 case 'v': return '\v';
579 return parse_hex_sequence();
588 return parse_octal_sequence(ec);
590 parse_error("reached end of file while parsing escape sequence");
592 /* \E is not documented, but handled, by GCC. It is acceptable according
593 * to §6.11.4, whereas \e is not. */
597 return 27; /* hopefully 27 is ALWAYS the code for ESCAPE */
601 parse_error("universal character parsing not implemented yet");
606 /* §6.4.4.4:8 footnote 64 */
607 parse_error("unknown escape sequence");
612 * Concatenate two strings.
614 string_t concat_strings(const string_t *const s1, const string_t *const s2)
616 const size_t len1 = s1->size - 1;
617 const size_t len2 = s2->size - 1;
619 char *const concat = obstack_alloc(&symbol_obstack, len1 + len2 + 1);
620 memcpy(concat, s1->begin, len1);
621 memcpy(concat + len1, s2->begin, len2 + 1);
623 return identify_string(concat, len1 + len2 + 1);
626 string_t make_string(const char *string)
628 size_t len = strlen(string) + 1;
629 char *const space = obstack_alloc(&symbol_obstack, len);
630 memcpy(space, string, len);
632 return identify_string(space, len);
636 * Parse a string literal and set lexer_token.
638 static void parse_string_literal(void)
645 utf32 const tc = parse_escape_sequence();
647 warningf(WARN_OTHER, &lexer_pos, "escape sequence out of range");
649 obstack_1grow(&symbol_obstack, tc);
654 errorf(&lexer_token.base.source_position, "string has no end");
655 lexer_token.kind = T_ERROR;
664 obstack_grow_symbol(&symbol_obstack, c);
672 /* TODO: concatenate multiple strings separated by whitespace... */
674 /* add finishing 0 to the string */
675 obstack_1grow(&symbol_obstack, '\0');
676 const size_t size = (size_t)obstack_object_size(&symbol_obstack);
677 char *string = obstack_finish(&symbol_obstack);
679 lexer_token.kind = T_STRING_LITERAL;
680 lexer_token.string.string = identify_string(string, size);
684 * Parse a wide character constant and set lexer_token.
686 static void parse_wide_character_constant(void)
693 const utf32 tc = parse_escape_sequence();
694 obstack_grow_symbol(&symbol_obstack, tc);
699 parse_error("newline while parsing character constant");
705 goto end_of_wide_char_constant;
708 errorf(&lexer_token.base.source_position,
709 "EOF while parsing character constant");
710 lexer_token.kind = T_ERROR;
715 obstack_grow_symbol(&symbol_obstack, c);
721 end_of_wide_char_constant:;
722 obstack_1grow(&symbol_obstack, '\0');
723 size_t size = (size_t) obstack_object_size(&symbol_obstack) - 1;
724 char *string = obstack_finish(&symbol_obstack);
726 lexer_token.kind = T_WIDE_CHARACTER_CONSTANT;
727 lexer_token.string.string = identify_string(string, size);
730 errorf(&lexer_token.base.source_position, "empty character constant");
735 * Parse a wide string literal and set lexer_token.
737 static void parse_wide_string_literal(void)
739 parse_string_literal();
740 if (lexer_token.kind == T_STRING_LITERAL)
741 lexer_token.kind = T_WIDE_STRING_LITERAL;
745 * Parse a character constant and set lexer_token.
747 static void parse_character_constant(void)
754 utf32 const tc = parse_escape_sequence();
756 warningf(WARN_OTHER, &lexer_pos, "escape sequence out of range");
758 obstack_1grow(&symbol_obstack, tc);
763 parse_error("newline while parsing character constant");
769 goto end_of_char_constant;
772 errorf(&lexer_token.base.source_position,
773 "EOF while parsing character constant");
774 lexer_token.kind = T_ERROR;
779 obstack_grow_symbol(&symbol_obstack, c);
786 end_of_char_constant:;
787 obstack_1grow(&symbol_obstack, '\0');
788 const size_t size = (size_t)obstack_object_size(&symbol_obstack)-1;
789 char *const string = obstack_finish(&symbol_obstack);
791 lexer_token.kind = T_CHARACTER_CONSTANT;
792 lexer_token.string.string = identify_string(string, size);
795 errorf(&lexer_token.base.source_position, "empty character constant");
800 * Skip a multiline comment.
802 static void skip_multiline_comment(void)
809 /* nested comment, warn here */
810 warningf(WARN_COMMENT, &lexer_pos, "'/*' within comment");
821 MATCH_NEWLINE(break;)
824 errorf(&lexer_token.base.source_position,
825 "at end of file while looking for comment end");
837 * Skip a single line comment.
839 static void skip_line_comment(void)
852 if (c == '\n' || c == '\r') {
853 warningf(WARN_COMMENT, &lexer_pos, "multi-line comment");
865 /** The current preprocessor token. */
866 static token_t pp_token;
869 * Read the next preprocessor token.
871 static inline void next_pp_token(void)
873 lexer_next_preprocessing_token();
874 pp_token = lexer_token;
878 * Eat all preprocessor tokens until newline.
880 static void eat_until_newline(void)
882 while (pp_token.kind != '\n' && pp_token.kind != T_EOF) {
888 * Handle the define directive.
890 static void define_directive(void)
892 lexer_next_preprocessing_token();
893 if (lexer_token.kind != T_IDENTIFIER) {
894 parse_error("expected identifier after #define\n");
900 * Handle the ifdef directive.
902 static void ifdef_directive(int is_ifndef)
905 lexer_next_preprocessing_token();
906 //expect_identifier();
911 * Handle the endif directive.
913 static void endif_directive(void)
919 * Parse the line directive.
921 static void parse_line_directive(void)
923 if (pp_token.kind != T_INTEGER) {
924 parse_error("expected integer");
926 /* use offset -1 as this is about the next line */
927 lexer_pos.lineno = atoi(pp_token.number.number.begin) - 1;
930 if (pp_token.kind == T_STRING_LITERAL) {
931 lexer_pos.input_name = pp_token.string.string.begin;
941 typedef enum stdc_pragma_kind_t {
945 STDC_CX_LIMITED_RANGE
946 } stdc_pragma_kind_t;
949 * STDC pragma values.
951 typedef enum stdc_pragma_value_kind_t {
956 } stdc_pragma_value_kind_t;
959 * Parse a pragma directive.
961 static void parse_pragma(void)
963 bool unknown_pragma = true;
966 if (pp_token.kind != T_IDENTIFIER) {
967 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
968 "expected identifier after #pragma");
973 symbol_t *symbol = pp_token.identifier.symbol;
974 if (symbol->pp_ID == TP_STDC) {
975 stdc_pragma_kind_t kind = STDC_UNKNOWN;
980 switch (pp_token.identifier.symbol->pp_ID) {
982 kind = STDC_FP_CONTRACT;
985 kind = STDC_FENV_ACCESS;
987 case TP_CX_LIMITED_RANGE:
988 kind = STDC_CX_LIMITED_RANGE;
993 if (kind != STDC_UNKNOWN) {
994 stdc_pragma_value_kind_t value = STDC_VALUE_UNKNOWN;
996 switch (pp_token.identifier.symbol->pp_ID) {
998 value = STDC_VALUE_ON;
1001 value = STDC_VALUE_OFF;
1004 value = STDC_VALUE_DEFAULT;
1009 if (value != STDC_VALUE_UNKNOWN) {
1010 unknown_pragma = false;
1012 errorf(&pp_token.base.source_position,
1013 "bad STDC pragma argument");
1018 unknown_pragma = true;
1020 eat_until_newline();
1021 if (unknown_pragma) {
1022 warningf(WARN_UNKNOWN_PRAGMAS, &pp_token.base.source_position,
1023 "encountered unknown #pragma");
1028 * Parse a preprocessor non-null directive.
1030 static void parse_preprocessor_identifier(void)
1032 assert(pp_token.kind == T_IDENTIFIER);
1033 symbol_t *symbol = pp_token.identifier.symbol;
1035 switch (symbol->pp_ID) {
1037 printf("include - enable header name parsing!\n");
1053 parse_line_directive();
1060 /* TODO; output the rest of the line */
1061 parse_error("#error directive: ");
1070 * Parse a preprocessor directive.
1072 static void parse_preprocessor_directive(void)
1076 switch (pp_token.kind) {
1078 parse_preprocessor_identifier();
1081 parse_line_directive();
1084 /* NULL directive, see §6.10.7 */
1087 parse_error("invalid preprocessor directive");
1088 eat_until_newline();
1093 #define MAYBE_PROLOG \
1098 #define MAYBE(ch, set_type) \
1101 lexer_token.kind = set_type; \
1104 /* must use this as last thing */
1105 #define MAYBE_MODE(ch, set_type, mode) \
1107 if (c_mode & mode) { \
1109 lexer_token.kind = set_type; \
1114 #define ELSE_CODE(code) \
1119 } /* end of while (true) */ \
1121 #define ELSE(set_type) \
1123 lexer_token.kind = set_type; \
1126 void lexer_next_preprocessing_token(void)
1129 lexer_token.base.source_position = lexer_pos;
1138 lexer_token.kind = '\n';
1144 /* might be a wide string ( L"string" ) */
1145 if (lexer_token.identifier.symbol == symbol_L) {
1147 case '"': parse_wide_string_literal(); break;
1148 case '\'': parse_wide_character_constant(); break;
1158 parse_string_literal();
1162 parse_character_constant();
1175 MAYBE('.', T_DOTDOTDOT)
1179 lexer_token.kind = '.';
1184 MAYBE('&', T_ANDAND)
1185 MAYBE('=', T_ANDEQUAL)
1189 MAYBE('=', T_ASTERISKEQUAL)
1193 MAYBE('+', T_PLUSPLUS)
1194 MAYBE('=', T_PLUSEQUAL)
1198 MAYBE('>', T_MINUSGREATER)
1199 MAYBE('-', T_MINUSMINUS)
1200 MAYBE('=', T_MINUSEQUAL)
1204 MAYBE('=', T_EXCLAMATIONMARKEQUAL)
1208 MAYBE('=', T_SLASHEQUAL)
1211 skip_multiline_comment();
1212 lexer_next_preprocessing_token();
1216 skip_line_comment();
1217 lexer_next_preprocessing_token();
1223 MAYBE('=', T_PERCENTEQUAL)
1228 MAYBE(':', T_HASHHASH)
1232 lexer_token.kind = '#';
1240 MAYBE('=', T_LESSEQUAL)
1243 MAYBE('=', T_LESSLESSEQUAL)
1248 MAYBE('=', T_GREATEREQUAL)
1251 MAYBE('=', T_GREATERGREATEREQUAL)
1252 ELSE(T_GREATERGREATER)
1256 MAYBE('=', T_CARETEQUAL)
1260 MAYBE('=', T_PIPEEQUAL)
1261 MAYBE('|', T_PIPEPIPE)
1266 MAYBE_MODE(':', T_COLONCOLON, _CXX)
1270 MAYBE('=', T_EQUALEQUAL)
1274 MAYBE('#', T_HASHHASH)
1288 lexer_token.kind = c;
1293 lexer_token.kind = T_EOF;
1298 errorf(&lexer_pos, "unknown character '%c' found", c);
1300 lexer_token.kind = T_ERROR;
1306 void lexer_next_token(void)
1308 lexer_next_preprocessing_token();
1310 while (lexer_token.kind == '\n') {
1312 lexer_next_preprocessing_token();
1315 if (lexer_token.kind == '#') {
1316 parse_preprocessor_directive();
1321 void init_lexer(void)
1323 strset_init(&stringset);
1324 symbol_L = symbol_table_insert("L");
1327 static void input_error(unsigned delta_lines, unsigned delta_cols,
1328 const char *message)
1330 lexer_pos.lineno += delta_lines;
1331 lexer_pos.colno += delta_cols;
1332 errorf(&lexer_pos, "%s", message);
1335 void select_input_encoding(char const* new_encoding)
1337 if (encoding != NULL)
1339 encoding = xstrdup(new_encoding);
1342 void lexer_open_stream(FILE *stream, const char *input_name)
1344 if (input != NULL) {
1349 lexer_pos.lineno = 0;
1350 lexer_pos.colno = 0;
1351 lexer_pos.input_name = input_name;
1353 set_input_error_callback(input_error);
1354 input = input_from_stream(stream, encoding);
1358 /* place a virtual \n at the beginning so the lexer knows that we're
1359 * at the beginning of a line */
1363 void exit_lexer(void)
1365 if (input != NULL) {
1369 strset_destroy(&stringset);
1372 static __attribute__((unused))
1373 void dbg_pos(const source_position_t source_position)
1375 fprintf(stdout, "%s:%u:%u\n", source_position.input_name,
1376 source_position.lineno, source_position.colno);