3 * Copyright © 2010 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
32 #include "main/core.h" /* for struct gl_extensions */
33 #include "main/mtypes.h" /* for gl_api enum */
36 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error);
39 _define_object_macro (glcpp_parser_t *parser,
42 token_list_t *replacements);
45 _define_function_macro (glcpp_parser_t *parser,
48 string_list_t *parameters,
49 token_list_t *replacements);
51 static string_list_t *
52 _string_list_create (void *ctx);
55 _string_list_append_item (string_list_t *list, const char *str);
58 _string_list_contains (string_list_t *list, const char *member, int *index);
61 _string_list_length (string_list_t *list);
64 _string_list_equal (string_list_t *a, string_list_t *b);
66 static argument_list_t *
67 _argument_list_create (void *ctx);
70 _argument_list_append (argument_list_t *list, token_list_t *argument);
73 _argument_list_length (argument_list_t *list);
76 _argument_list_member_at (argument_list_t *list, int index);
78 /* Note: This function ralloc_steal()s the str pointer. */
80 _token_create_str (void *ctx, int type, char *str);
83 _token_create_ival (void *ctx, int type, int ival);
86 _token_list_create (void *ctx);
89 _token_list_append (token_list_t *list, token_t *token);
92 _token_list_append_list (token_list_t *list, token_list_t *tail);
95 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b);
98 _parser_active_list_push (glcpp_parser_t *parser,
99 const char *identifier,
100 token_node_t *marker);
103 _parser_active_list_pop (glcpp_parser_t *parser);
106 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier);
108 /* Expand list, and begin lexing from the result (after first
109 * prefixing a token of type 'head_token_type').
112 _glcpp_parser_expand_and_lex_from (glcpp_parser_t *parser,
116 /* Perform macro expansion in-place on the given list. */
118 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
122 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
126 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
130 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
131 const char *type, int condition);
134 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc);
137 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
141 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser);
144 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list);
147 add_builtin_define(glcpp_parser_t *parser, const char *name, int value);
163 %parse-param {glcpp_parser_t *parser}
164 %lex-param {glcpp_parser_t *parser}
167 %token COMMA_FINAL DEFINED ELIF_EXPANDED HASH HASH_DEFINE FUNC_IDENTIFIER OBJ_IDENTIFIER HASH_ELIF HASH_ELSE HASH_ENDIF HASH_IF HASH_IFDEF HASH_IFNDEF HASH_LINE HASH_UNDEF HASH_VERSION IDENTIFIER IF_EXPANDED INTEGER INTEGER_STRING LINE_EXPANDED NEWLINE OTHER PLACEHOLDER SPACE
169 %type <ival> expression INTEGER operator SPACE integer_constant
170 %type <str> IDENTIFIER FUNC_IDENTIFIER OBJ_IDENTIFIER INTEGER_STRING OTHER
171 %type <string_list> identifier_list
172 %type <token> preprocessing_token conditional_token
173 %type <token_list> pp_tokens replacement_list text_line conditional_tokens
179 %left EQUAL NOT_EQUAL
180 %left '<' '>' LESS_OR_EQUAL GREATER_OR_EQUAL
181 %left LEFT_SHIFT RIGHT_SHIFT
195 ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length, "\n");
197 | HASH_LINE pp_tokens NEWLINE {
198 if (parser->skip_stack == NULL ||
199 parser->skip_stack->type == SKIP_NO_SKIP)
201 _glcpp_parser_expand_and_lex_from (parser,
206 _glcpp_parser_print_expanded_token_list (parser, $1);
207 ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length, "\n");
215 IF_EXPANDED expression NEWLINE {
216 _glcpp_parser_skip_stack_push_if (parser, & @1, $2);
218 | ELIF_EXPANDED expression NEWLINE {
219 _glcpp_parser_skip_stack_change_if (parser, & @1, "elif", $2);
221 | LINE_EXPANDED integer_constant NEWLINE {
222 parser->has_new_line_number = 1;
223 parser->new_line_number = $2;
224 ralloc_asprintf_rewrite_tail (&parser->output,
225 &parser->output_length,
226 "#line %" PRIiMAX "\n",
229 | LINE_EXPANDED integer_constant integer_constant NEWLINE {
230 parser->has_new_line_number = 1;
231 parser->new_line_number = $2;
232 parser->has_new_source_number = 1;
233 parser->new_source_number = $3;
234 ralloc_asprintf_rewrite_tail (&parser->output,
235 &parser->output_length,
236 "#line %" PRIiMAX " %" PRIiMAX "\n",
242 HASH_DEFINE OBJ_IDENTIFIER replacement_list NEWLINE {
243 _define_object_macro (parser, & @2, $2, $3);
245 | HASH_DEFINE FUNC_IDENTIFIER '(' ')' replacement_list NEWLINE {
246 _define_function_macro (parser, & @2, $2, NULL, $5);
248 | HASH_DEFINE FUNC_IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
249 _define_function_macro (parser, & @2, $2, $4, $6);
251 | HASH_UNDEF IDENTIFIER NEWLINE {
252 macro_t *macro = hash_table_find (parser->defines, $2);
254 hash_table_remove (parser->defines, $2);
259 | HASH_IF conditional_tokens NEWLINE {
260 /* Be careful to only evaluate the 'if' expression if
261 * we are not skipping. When we are skipping, we
262 * simply push a new 0-valued 'if' onto the skip
265 * This avoids generating diagnostics for invalid
266 * expressions that are being skipped. */
267 if (parser->skip_stack == NULL ||
268 parser->skip_stack->type == SKIP_NO_SKIP)
270 _glcpp_parser_expand_and_lex_from (parser,
275 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
276 parser->skip_stack->type = SKIP_TO_ENDIF;
280 /* #if without an expression is only an error if we
281 * are not skipping */
282 if (parser->skip_stack == NULL ||
283 parser->skip_stack->type == SKIP_NO_SKIP)
285 glcpp_error(& @1, parser, "#if with no expression");
287 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
289 | HASH_IFDEF IDENTIFIER junk NEWLINE {
290 macro_t *macro = hash_table_find (parser->defines, $2);
292 _glcpp_parser_skip_stack_push_if (parser, & @1, macro != NULL);
294 | HASH_IFNDEF IDENTIFIER junk NEWLINE {
295 macro_t *macro = hash_table_find (parser->defines, $2);
297 _glcpp_parser_skip_stack_push_if (parser, & @1, macro == NULL);
299 | HASH_ELIF conditional_tokens NEWLINE {
300 /* Be careful to only evaluate the 'elif' expression
301 * if we are not skipping. When we are skipping, we
302 * simply change to a 0-valued 'elif' on the skip
305 * This avoids generating diagnostics for invalid
306 * expressions that are being skipped. */
307 if (parser->skip_stack &&
308 parser->skip_stack->type == SKIP_TO_ELSE)
310 _glcpp_parser_expand_and_lex_from (parser,
315 _glcpp_parser_skip_stack_change_if (parser, & @1,
319 | HASH_ELIF NEWLINE {
320 /* #elif without an expression is an error unless we
322 if (parser->skip_stack &&
323 parser->skip_stack->type == SKIP_TO_ELSE)
325 glcpp_error(& @1, parser, "#elif with no expression");
329 _glcpp_parser_skip_stack_change_if (parser, & @1,
331 glcpp_warning(& @1, parser, "ignoring illegal #elif without expression");
335 _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
338 _glcpp_parser_skip_stack_pop (parser, & @1);
340 | HASH_VERSION integer_constant NEWLINE {
341 _glcpp_parser_handle_version_declaration(parser, $2, NULL);
343 | HASH_VERSION integer_constant IDENTIFIER NEWLINE {
344 _glcpp_parser_handle_version_declaration(parser, $2, $3);
351 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
352 $$ = strtoll ($1 + 2, NULL, 16);
353 } else if ($1[0] == '0') {
354 $$ = strtoll ($1, NULL, 8);
356 $$ = strtoll ($1, NULL, 10);
367 glcpp_error(& @1, parser, "undefined macro %s in expression (illegal in GLES)", $1);
370 | expression OR expression {
373 | expression AND expression {
376 | expression '|' expression {
379 | expression '^' expression {
382 | expression '&' expression {
385 | expression NOT_EQUAL expression {
388 | expression EQUAL expression {
391 | expression GREATER_OR_EQUAL expression {
394 | expression LESS_OR_EQUAL expression {
397 | expression '>' expression {
400 | expression '<' expression {
403 | expression RIGHT_SHIFT expression {
406 | expression LEFT_SHIFT expression {
409 | expression '-' expression {
412 | expression '+' expression {
415 | expression '%' expression {
417 yyerror (& @1, parser,
418 "zero modulus in preprocessor directive");
423 | expression '/' expression {
425 yyerror (& @1, parser,
426 "division by 0 in preprocessor directive");
431 | expression '*' expression {
434 | '!' expression %prec UNARY {
437 | '~' expression %prec UNARY {
440 | '-' expression %prec UNARY {
443 | '+' expression %prec UNARY {
446 | '(' expression ')' {
453 $$ = _string_list_create (parser);
454 _string_list_append_item ($$, $1);
455 ralloc_steal ($$, $1);
457 | identifier_list ',' IDENTIFIER {
459 _string_list_append_item ($$, $3);
460 ralloc_steal ($$, $3);
465 NEWLINE { $$ = NULL; }
471 yyerror (& @1, parser, "Invalid tokens after #");
476 /* empty */ { $$ = NULL; }
483 glcpp_warning(&@1, parser, "extra tokens at end of directive");
488 /* Handle "defined" operator */
490 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
491 $$ = _token_create_ival (parser, INTEGER, v);
493 | DEFINED '(' IDENTIFIER ')' {
494 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
495 $$ = _token_create_ival (parser, INTEGER, v);
497 | preprocessing_token
501 /* Exactly the same as pp_tokens, but using conditional_token */
503 $$ = _token_list_create (parser);
504 _token_list_append ($$, $1);
506 | conditional_tokens conditional_token {
508 _token_list_append ($$, $2);
513 preprocessing_token {
514 parser->space_tokens = 1;
515 $$ = _token_list_create (parser);
516 _token_list_append ($$, $1);
518 | pp_tokens preprocessing_token {
520 _token_list_append ($$, $2);
526 $$ = _token_create_str (parser, IDENTIFIER, $1);
527 $$->location = yylloc;
530 $$ = _token_create_str (parser, INTEGER_STRING, $1);
531 $$->location = yylloc;
534 $$ = _token_create_ival (parser, $1, $1);
535 $$->location = yylloc;
538 $$ = _token_create_str (parser, OTHER, $1);
539 $$->location = yylloc;
542 $$ = _token_create_ival (parser, SPACE, SPACE);
543 $$->location = yylloc;
563 | LEFT_SHIFT { $$ = LEFT_SHIFT; }
564 | RIGHT_SHIFT { $$ = RIGHT_SHIFT; }
567 | LESS_OR_EQUAL { $$ = LESS_OR_EQUAL; }
568 | GREATER_OR_EQUAL { $$ = GREATER_OR_EQUAL; }
569 | EQUAL { $$ = EQUAL; }
570 | NOT_EQUAL { $$ = NOT_EQUAL; }
578 | PASTE { $$ = PASTE; }
584 _string_list_create (void *ctx)
588 list = ralloc (ctx, string_list_t);
596 _string_list_append_item (string_list_t *list, const char *str)
600 node = ralloc (list, string_node_t);
601 node->str = ralloc_strdup (node, str);
605 if (list->head == NULL) {
608 list->tail->next = node;
615 _string_list_contains (string_list_t *list, const char *member, int *index)
623 for (i = 0, node = list->head; node; i++, node = node->next) {
624 if (strcmp (node->str, member) == 0) {
635 _string_list_length (string_list_t *list)
643 for (node = list->head; node; node = node->next)
650 _string_list_equal (string_list_t *a, string_list_t *b)
652 string_node_t *node_a, *node_b;
654 if (a == NULL && b == NULL)
657 if (a == NULL || b == NULL)
660 for (node_a = a->head, node_b = b->head;
662 node_a = node_a->next, node_b = node_b->next)
664 if (strcmp (node_a->str, node_b->str))
668 /* Catch the case of lists being different lengths, (which
669 * would cause the loop above to terminate after the shorter
671 return node_a == node_b;
675 _argument_list_create (void *ctx)
677 argument_list_t *list;
679 list = ralloc (ctx, argument_list_t);
687 _argument_list_append (argument_list_t *list, token_list_t *argument)
689 argument_node_t *node;
691 node = ralloc (list, argument_node_t);
692 node->argument = argument;
696 if (list->head == NULL) {
699 list->tail->next = node;
706 _argument_list_length (argument_list_t *list)
709 argument_node_t *node;
714 for (node = list->head; node; node = node->next)
721 _argument_list_member_at (argument_list_t *list, int index)
723 argument_node_t *node;
730 for (i = 0; i < index; i++) {
737 return node->argument;
742 /* Note: This function ralloc_steal()s the str pointer. */
744 _token_create_str (void *ctx, int type, char *str)
748 token = ralloc (ctx, token_t);
750 token->value.str = str;
752 ralloc_steal (token, str);
758 _token_create_ival (void *ctx, int type, int ival)
762 token = ralloc (ctx, token_t);
764 token->value.ival = ival;
770 _token_list_create (void *ctx)
774 list = ralloc (ctx, token_list_t);
777 list->non_space_tail = NULL;
783 _token_list_append (token_list_t *list, token_t *token)
787 node = ralloc (list, token_node_t);
791 if (list->head == NULL) {
794 list->tail->next = node;
798 if (token->type != SPACE)
799 list->non_space_tail = node;
803 _token_list_append_list (token_list_t *list, token_list_t *tail)
805 if (tail == NULL || tail->head == NULL)
808 if (list->head == NULL) {
809 list->head = tail->head;
811 list->tail->next = tail->head;
814 list->tail = tail->tail;
815 list->non_space_tail = tail->non_space_tail;
818 static token_list_t *
819 _token_list_copy (void *ctx, token_list_t *other)
827 copy = _token_list_create (ctx);
828 for (node = other->head; node; node = node->next) {
829 token_t *new_token = ralloc (copy, token_t);
830 *new_token = *node->token;
831 _token_list_append (copy, new_token);
838 _token_list_trim_trailing_space (token_list_t *list)
840 token_node_t *tail, *next;
842 if (list->non_space_tail) {
843 tail = list->non_space_tail->next;
844 list->non_space_tail->next = NULL;
845 list->tail = list->non_space_tail;
856 _token_list_is_empty_ignoring_space (token_list_t *l)
864 while (n != NULL && n->token->type == SPACE)
871 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
873 token_node_t *node_a, *node_b;
875 if (a == NULL || b == NULL) {
876 int a_empty = _token_list_is_empty_ignoring_space(a);
877 int b_empty = _token_list_is_empty_ignoring_space(b);
878 return a_empty == b_empty;
886 if (node_a == NULL && node_b == NULL)
889 if (node_a == NULL || node_b == NULL)
892 if (node_a->token->type == SPACE) {
893 node_a = node_a->next;
897 if (node_b->token->type == SPACE) {
898 node_b = node_b->next;
902 if (node_a->token->type != node_b->token->type)
905 switch (node_a->token->type) {
907 if (node_a->token->value.ival !=
908 node_b->token->value.ival)
916 if (strcmp (node_a->token->value.str,
917 node_b->token->value.str))
924 node_a = node_a->next;
925 node_b = node_b->next;
932 _token_print (char **out, size_t *len, token_t *token)
934 if (token->type < 256) {
935 ralloc_asprintf_rewrite_tail (out, len, "%c", token->type);
939 switch (token->type) {
941 ralloc_asprintf_rewrite_tail (out, len, "%" PRIiMAX, token->value.ival);
946 ralloc_asprintf_rewrite_tail (out, len, "%s", token->value.str);
949 ralloc_asprintf_rewrite_tail (out, len, " ");
952 ralloc_asprintf_rewrite_tail (out, len, "<<");
955 ralloc_asprintf_rewrite_tail (out, len, ">>");
958 ralloc_asprintf_rewrite_tail (out, len, "<=");
960 case GREATER_OR_EQUAL:
961 ralloc_asprintf_rewrite_tail (out, len, ">=");
964 ralloc_asprintf_rewrite_tail (out, len, "==");
967 ralloc_asprintf_rewrite_tail (out, len, "!=");
970 ralloc_asprintf_rewrite_tail (out, len, "&&");
973 ralloc_asprintf_rewrite_tail (out, len, "||");
976 ralloc_asprintf_rewrite_tail (out, len, "##");
979 ralloc_asprintf_rewrite_tail (out, len, ",");
982 /* Nothing to print. */
985 assert(!"Error: Don't know how to print token.");
990 /* Return a new token (ralloc()ed off of 'token') formed by pasting
991 * 'token' and 'other'. Note that this function may return 'token' or
992 * 'other' directly rather than allocating anything new.
994 * Caution: Only very cursory error-checking is performed to see if
995 * the final result is a valid single token. */
997 _token_paste (glcpp_parser_t *parser, token_t *token, token_t *other)
999 token_t *combined = NULL;
1001 /* Pasting a placeholder onto anything makes no change. */
1002 if (other->type == PLACEHOLDER)
1005 /* When 'token' is a placeholder, just return 'other'. */
1006 if (token->type == PLACEHOLDER)
1009 /* A very few single-character punctuators can be combined
1010 * with another to form a multi-character punctuator. */
1011 switch (token->type) {
1013 if (other->type == '<')
1014 combined = _token_create_ival (token, LEFT_SHIFT, LEFT_SHIFT);
1015 else if (other->type == '=')
1016 combined = _token_create_ival (token, LESS_OR_EQUAL, LESS_OR_EQUAL);
1019 if (other->type == '>')
1020 combined = _token_create_ival (token, RIGHT_SHIFT, RIGHT_SHIFT);
1021 else if (other->type == '=')
1022 combined = _token_create_ival (token, GREATER_OR_EQUAL, GREATER_OR_EQUAL);
1025 if (other->type == '=')
1026 combined = _token_create_ival (token, EQUAL, EQUAL);
1029 if (other->type == '=')
1030 combined = _token_create_ival (token, NOT_EQUAL, NOT_EQUAL);
1033 if (other->type == '&')
1034 combined = _token_create_ival (token, AND, AND);
1037 if (other->type == '|')
1038 combined = _token_create_ival (token, OR, OR);
1042 if (combined != NULL) {
1043 /* Inherit the location from the first token */
1044 combined->location = token->location;
1048 /* Two string-valued (or integer) tokens can usually just be
1049 * mashed together. (We also handle a string followed by an
1050 * integer here as well.)
1052 * There are some exceptions here. Notably, if the first token
1053 * is an integer (or a string representing an integer), then
1054 * the second token must also be an integer or must be a
1055 * string representing an integer that begins with a digit.
1057 if ((token->type == IDENTIFIER || token->type == OTHER || token->type == INTEGER_STRING || token->type == INTEGER) &&
1058 (other->type == IDENTIFIER || other->type == OTHER || other->type == INTEGER_STRING || other->type == INTEGER))
1063 /* Check that pasting onto an integer doesn't create a
1064 * non-integer, (that is, only digits can be
1066 if (token->type == INTEGER_STRING || token->type == INTEGER)
1068 switch (other->type) {
1069 case INTEGER_STRING:
1070 if (other->value.str[0] < '0' ||
1071 other->value.str[0] > '9')
1075 if (other->value.ival < 0)
1083 if (token->type == INTEGER)
1084 str = ralloc_asprintf (token, "%" PRIiMAX,
1087 str = ralloc_strdup (token, token->value.str);
1090 if (other->type == INTEGER)
1091 ralloc_asprintf_append (&str, "%" PRIiMAX,
1094 ralloc_strcat (&str, other->value.str);
1096 /* New token is same type as original token, unless we
1097 * started with an integer, in which case we will be
1098 * creating an integer-string. */
1099 combined_type = token->type;
1100 if (combined_type == INTEGER)
1101 combined_type = INTEGER_STRING;
1103 combined = _token_create_str (token, combined_type, str);
1104 combined->location = token->location;
1109 glcpp_error (&token->location, parser, "");
1110 ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "Pasting \"");
1111 _token_print (&parser->info_log, &parser->info_log_length, token);
1112 ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "\" and \"");
1113 _token_print (&parser->info_log, &parser->info_log_length, other);
1114 ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "\" does not give a valid preprocessing token.\n");
1120 _token_list_print (glcpp_parser_t *parser, token_list_t *list)
1127 for (node = list->head; node; node = node->next)
1128 _token_print (&parser->output, &parser->output_length, node->token);
1132 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error)
1134 glcpp_error(locp, parser, "%s", error);
1137 static void add_builtin_define(glcpp_parser_t *parser,
1138 const char *name, int value)
1143 tok = _token_create_ival (parser, INTEGER, value);
1145 list = _token_list_create(parser);
1146 _token_list_append(list, tok);
1147 _define_object_macro(parser, NULL, name, list);
1151 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1153 glcpp_parser_t *parser;
1154 int language_version;
1156 parser = ralloc (NULL, glcpp_parser_t);
1158 glcpp_lex_init_extra (parser, &parser->scanner);
1159 parser->defines = hash_table_ctor (32, hash_table_string_hash,
1160 hash_table_string_compare);
1161 parser->active = NULL;
1162 parser->lexing_if = 0;
1163 parser->space_tokens = 1;
1164 parser->newline_as_space = 0;
1165 parser->in_control_line = 0;
1166 parser->paren_count = 0;
1168 parser->skip_stack = NULL;
1170 parser->lex_from_list = NULL;
1171 parser->lex_from_node = NULL;
1173 parser->output = ralloc_strdup(parser, "");
1174 parser->output_length = 0;
1175 parser->info_log = ralloc_strdup(parser, "");
1176 parser->info_log_length = 0;
1179 parser->has_new_line_number = 0;
1180 parser->new_line_number = 1;
1181 parser->has_new_source_number = 0;
1182 parser->new_source_number = 0;
1184 parser->is_gles = false;
1186 /* Add pre-defined macros. */
1187 if (api == API_OPENGLES2) {
1188 parser->is_gles = true;
1189 add_builtin_define(parser, "GL_ES", 1);
1191 if (extensions != NULL) {
1192 if (extensions->OES_EGL_image_external)
1193 add_builtin_define(parser, "GL_OES_EGL_image_external", 1);
1196 add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1197 add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1199 if (extensions != NULL) {
1200 if (extensions->EXT_texture_array) {
1201 add_builtin_define(parser, "GL_EXT_texture_array", 1);
1204 if (extensions->ARB_fragment_coord_conventions)
1205 add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1208 if (extensions->ARB_explicit_attrib_location)
1209 add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
1211 if (extensions->ARB_shader_texture_lod)
1212 add_builtin_define(parser, "GL_ARB_shader_texture_lod", 1);
1214 if (extensions->ARB_draw_instanced)
1215 add_builtin_define(parser, "GL_ARB_draw_instanced", 1);
1217 if (extensions->ARB_conservative_depth) {
1218 add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
1219 add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
1222 if (extensions->ARB_shader_bit_encoding)
1223 add_builtin_define(parser, "GL_ARB_shader_bit_encoding", 1);
1225 if (extensions->ARB_uniform_buffer_object)
1226 add_builtin_define(parser, "GL_ARB_uniform_buffer_object", 1);
1228 if (extensions->ARB_texture_cube_map_array)
1229 add_builtin_define(parser, "GL_ARB_texture_cube_map_array", 1);
1231 if (extensions->ARB_shading_language_packing)
1232 add_builtin_define(parser, "GL_ARB_shading_language_packing", 1);
1234 if (extensions->ARB_texture_multisample)
1235 add_builtin_define(parser, "GL_ARB_texture_multisample", 1);
1237 if (extensions->ARB_texture_query_levels)
1238 add_builtin_define(parser, "GL_ARB_texture_query_levels", 1);
1240 if (extensions->ARB_texture_query_lod)
1241 add_builtin_define(parser, "GL_ARB_texture_query_lod", 1);
1243 if (extensions->ARB_gpu_shader5)
1244 add_builtin_define(parser, "GL_ARB_gpu_shader5", 1);
1246 if (extensions->AMD_vertex_shader_layer)
1247 add_builtin_define(parser, "GL_AMD_vertex_shader_layer", 1);
1249 if (extensions->ARB_shading_language_420pack)
1250 add_builtin_define(parser, "GL_ARB_shading_language_420pack", 1);
1252 if (extensions->EXT_shader_integer_mix)
1253 add_builtin_define(parser, "GL_EXT_shader_integer_mix", 1);
1255 if (extensions->ARB_texture_gather)
1256 add_builtin_define(parser, "GL_ARB_texture_gather", 1);
1258 if (extensions->ARB_shader_atomic_counters)
1259 add_builtin_define(parser, "GL_ARB_shader_atomic_counters", 1);
1263 language_version = 110;
1264 add_builtin_define(parser, "__VERSION__", language_version);
1270 glcpp_parser_destroy (glcpp_parser_t *parser)
1272 glcpp_lex_destroy (parser->scanner);
1273 hash_table_dtor (parser->defines);
1274 ralloc_free (parser);
1277 typedef enum function_status
1279 FUNCTION_STATUS_SUCCESS,
1280 FUNCTION_NOT_A_FUNCTION,
1281 FUNCTION_UNBALANCED_PARENTHESES
1282 } function_status_t;
1284 /* Find a set of function-like macro arguments by looking for a
1285 * balanced set of parentheses.
1287 * When called, 'node' should be the opening-parenthesis token, (or
1288 * perhaps preceeding SPACE tokens). Upon successful return *last will
1289 * be the last consumed node, (corresponding to the closing right
1294 * FUNCTION_STATUS_SUCCESS:
1296 * Successfully parsed a set of function arguments.
1298 * FUNCTION_NOT_A_FUNCTION:
1300 * Macro name not followed by a '('. This is not an error, but
1301 * simply that the macro name should be treated as a non-macro.
1303 * FUNCTION_UNBALANCED_PARENTHESES
1305 * Macro name is not followed by a balanced set of parentheses.
1307 static function_status_t
1308 _arguments_parse (argument_list_t *arguments,
1310 token_node_t **last)
1312 token_list_t *argument;
1317 /* Ignore whitespace before first parenthesis. */
1318 while (node && node->token->type == SPACE)
1321 if (node == NULL || node->token->type != '(')
1322 return FUNCTION_NOT_A_FUNCTION;
1326 argument = _token_list_create (arguments);
1327 _argument_list_append (arguments, argument);
1329 for (paren_count = 1; node; node = node->next) {
1330 if (node->token->type == '(')
1334 else if (node->token->type == ')')
1337 if (paren_count == 0)
1341 if (node->token->type == ',' &&
1344 _token_list_trim_trailing_space (argument);
1345 argument = _token_list_create (arguments);
1346 _argument_list_append (arguments, argument);
1349 if (argument->head == NULL) {
1350 /* Don't treat initial whitespace as
1351 * part of the arguement. */
1352 if (node->token->type == SPACE)
1355 _token_list_append (argument, node->token);
1360 return FUNCTION_UNBALANCED_PARENTHESES;
1364 return FUNCTION_STATUS_SUCCESS;
1367 static token_list_t *
1368 _token_list_create_with_one_ival (void *ctx, int type, int ival)
1373 list = _token_list_create (ctx);
1374 node = _token_create_ival (list, type, ival);
1375 _token_list_append (list, node);
1380 static token_list_t *
1381 _token_list_create_with_one_space (void *ctx)
1383 return _token_list_create_with_one_ival (ctx, SPACE, SPACE);
1386 static token_list_t *
1387 _token_list_create_with_one_integer (void *ctx, int ival)
1389 return _token_list_create_with_one_ival (ctx, INTEGER, ival);
1392 /* Perform macro expansion on 'list', placing the resulting tokens
1393 * into a new list which is initialized with a first token of type
1394 * 'head_token_type'. Then begin lexing from the resulting list,
1395 * (return to the current lexing source when this list is exhausted).
1398 _glcpp_parser_expand_and_lex_from (glcpp_parser_t *parser,
1399 int head_token_type,
1402 token_list_t *expanded;
1405 expanded = _token_list_create (parser);
1406 token = _token_create_ival (parser, head_token_type, head_token_type);
1407 _token_list_append (expanded, token);
1408 _glcpp_parser_expand_token_list (parser, list);
1409 _token_list_append_list (expanded, list);
1410 glcpp_parser_lex_from (parser, expanded);
1414 _glcpp_parser_apply_pastes (glcpp_parser_t *parser, token_list_t *list)
1421 token_node_t *next_non_space;
1423 /* Look ahead for a PASTE token, skipping space. */
1424 next_non_space = node->next;
1425 while (next_non_space && next_non_space->token->type == SPACE)
1426 next_non_space = next_non_space->next;
1428 if (next_non_space == NULL)
1431 if (next_non_space->token->type != PASTE) {
1432 node = next_non_space;
1436 /* Now find the next non-space token after the PASTE. */
1437 next_non_space = next_non_space->next;
1438 while (next_non_space && next_non_space->token->type == SPACE)
1439 next_non_space = next_non_space->next;
1441 if (next_non_space == NULL) {
1442 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1446 node->token = _token_paste (parser, node->token, next_non_space->token);
1447 node->next = next_non_space->next;
1448 if (next_non_space == list->tail)
1452 list->non_space_tail = list->tail;
1455 /* This is a helper function that's essentially part of the
1456 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1457 * except for by that function.
1459 * Returns NULL if node is a simple token with no expansion, (that is,
1460 * although 'node' corresponds to an identifier defined as a
1461 * function-like macro, it is not followed with a parenthesized
1464 * Compute the complete expansion of node (which is a function-like
1465 * macro) and subsequent nodes which are arguments.
1467 * Returns the token list that results from the expansion and sets
1468 * *last to the last node in the list that was consumed by the
1469 * expansion. Specifically, *last will be set as follows: as the
1470 * token of the closing right parenthesis.
1472 static token_list_t *
1473 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1475 token_node_t **last)
1479 const char *identifier;
1480 argument_list_t *arguments;
1481 function_status_t status;
1482 token_list_t *substituted;
1483 int parameter_index;
1485 identifier = node->token->value.str;
1487 macro = hash_table_find (parser->defines, identifier);
1489 assert (macro->is_function);
1491 arguments = _argument_list_create (parser);
1492 status = _arguments_parse (arguments, node, last);
1495 case FUNCTION_STATUS_SUCCESS:
1497 case FUNCTION_NOT_A_FUNCTION:
1499 case FUNCTION_UNBALANCED_PARENTHESES:
1500 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1504 /* Replace a macro defined as empty with a SPACE token. */
1505 if (macro->replacements == NULL) {
1506 ralloc_free (arguments);
1507 return _token_list_create_with_one_space (parser);
1510 if (! ((_argument_list_length (arguments) ==
1511 _string_list_length (macro->parameters)) ||
1512 (_string_list_length (macro->parameters) == 0 &&
1513 _argument_list_length (arguments) == 1 &&
1514 arguments->head->argument->head == NULL)))
1516 glcpp_error (&node->token->location, parser,
1517 "Error: macro %s invoked with %d arguments (expected %d)\n",
1519 _argument_list_length (arguments),
1520 _string_list_length (macro->parameters));
1524 /* Perform argument substitution on the replacement list. */
1525 substituted = _token_list_create (arguments);
1527 for (node = macro->replacements->head; node; node = node->next)
1529 if (node->token->type == IDENTIFIER &&
1530 _string_list_contains (macro->parameters,
1531 node->token->value.str,
1534 token_list_t *argument;
1535 argument = _argument_list_member_at (arguments,
1537 /* Before substituting, we expand the argument
1538 * tokens, or append a placeholder token for
1539 * an empty argument. */
1540 if (argument->head) {
1541 token_list_t *expanded_argument;
1542 expanded_argument = _token_list_copy (parser,
1544 _glcpp_parser_expand_token_list (parser,
1546 _token_list_append_list (substituted,
1551 new_token = _token_create_ival (substituted,
1554 _token_list_append (substituted, new_token);
1557 _token_list_append (substituted, node->token);
1561 /* After argument substitution, and before further expansion
1562 * below, implement token pasting. */
1564 _token_list_trim_trailing_space (substituted);
1566 _glcpp_parser_apply_pastes (parser, substituted);
1571 /* Compute the complete expansion of node, (and subsequent nodes after
1572 * 'node' in the case that 'node' is a function-like macro and
1573 * subsequent nodes are arguments).
1575 * Returns NULL if node is a simple token with no expansion.
1577 * Otherwise, returns the token list that results from the expansion
1578 * and sets *last to the last node in the list that was consumed by
1579 * the expansion. Specifically, *last will be set as follows:
1581 * As 'node' in the case of object-like macro expansion.
1583 * As the token of the closing right parenthesis in the case of
1584 * function-like macro expansion.
1586 static token_list_t *
1587 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1589 token_node_t **last)
1591 token_t *token = node->token;
1592 const char *identifier;
1595 /* We only expand identifiers */
1596 if (token->type != IDENTIFIER) {
1597 /* We change any COMMA into a COMMA_FINAL to prevent
1598 * it being mistaken for an argument separator
1600 if (token->type == ',') {
1601 token->type = COMMA_FINAL;
1602 token->value.ival = COMMA_FINAL;
1609 identifier = token->value.str;
1611 /* Special handling for __LINE__ and __FILE__, (not through
1612 * the hash table). */
1613 if (strcmp(identifier, "__LINE__") == 0)
1614 return _token_list_create_with_one_integer (parser, node->token->location.first_line);
1616 if (strcmp(identifier, "__FILE__") == 0)
1617 return _token_list_create_with_one_integer (parser, node->token->location.source);
1619 /* Look up this identifier in the hash table. */
1620 macro = hash_table_find (parser->defines, identifier);
1622 /* Not a macro, so no expansion needed. */
1626 /* Finally, don't expand this macro if we're already actively
1627 * expanding it, (to avoid infinite recursion). */
1628 if (_parser_active_list_contains (parser, identifier)) {
1629 /* We change the token type here from IDENTIFIER to
1630 * OTHER to prevent any future expansion of this
1631 * unexpanded token. */
1633 token_list_t *expansion;
1636 str = ralloc_strdup (parser, token->value.str);
1637 final = _token_create_str (parser, OTHER, str);
1638 expansion = _token_list_create (parser);
1639 _token_list_append (expansion, final);
1643 if (! macro->is_function)
1645 token_list_t *replacement;
1647 /* Replace a macro defined as empty with a SPACE token. */
1648 if (macro->replacements == NULL)
1649 return _token_list_create_with_one_space (parser);
1651 replacement = _token_list_copy (parser, macro->replacements);
1652 _glcpp_parser_apply_pastes (parser, replacement);
1656 return _glcpp_parser_expand_function (parser, node, last);
1659 /* Push a new identifier onto the parser's active list.
1661 * Here, 'marker' is the token node that appears in the list after the
1662 * expansion of 'identifier'. That is, when the list iterator begins
1663 * examining 'marker', then it is time to pop this node from the
1667 _parser_active_list_push (glcpp_parser_t *parser,
1668 const char *identifier,
1669 token_node_t *marker)
1671 active_list_t *node;
1673 node = ralloc (parser->active, active_list_t);
1674 node->identifier = ralloc_strdup (node, identifier);
1675 node->marker = marker;
1676 node->next = parser->active;
1678 parser->active = node;
1682 _parser_active_list_pop (glcpp_parser_t *parser)
1684 active_list_t *node = parser->active;
1687 parser->active = NULL;
1691 node = parser->active->next;
1692 ralloc_free (parser->active);
1694 parser->active = node;
1698 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier)
1700 active_list_t *node;
1702 if (parser->active == NULL)
1705 for (node = parser->active; node; node = node->next)
1706 if (strcmp (node->identifier, identifier) == 0)
1712 /* Walk over the token list replacing nodes with their expansion.
1713 * Whenever nodes are expanded the walking will walk over the new
1714 * nodes, continuing to expand as necessary. The results are placed in
1718 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1721 token_node_t *node_prev;
1722 token_node_t *node, *last = NULL;
1723 token_list_t *expansion;
1724 active_list_t *active_initial = parser->active;
1729 _token_list_trim_trailing_space (list);
1736 while (parser->active && parser->active->marker == node)
1737 _parser_active_list_pop (parser);
1739 expansion = _glcpp_parser_expand_node (parser, node, &last);
1743 for (n = node; n != last->next; n = n->next)
1744 while (parser->active &&
1745 parser->active->marker == n)
1747 _parser_active_list_pop (parser);
1750 _parser_active_list_push (parser,
1751 node->token->value.str,
1754 /* Splice expansion into list, supporting a
1755 * simple deletion if the expansion is
1757 if (expansion->head) {
1759 node_prev->next = expansion->head;
1761 list->head = expansion->head;
1762 expansion->tail->next = last->next;
1763 if (last == list->tail)
1764 list->tail = expansion->tail;
1767 node_prev->next = last->next;
1769 list->head = last->next;
1770 if (last == list->tail)
1776 node = node_prev ? node_prev->next : list->head;
1779 /* Remove any lingering effects of this invocation on the
1780 * active list. That is, pop until the list looks like it did
1781 * at the beginning of this function. */
1782 while (parser->active && parser->active != active_initial)
1783 _parser_active_list_pop (parser);
1785 list->non_space_tail = list->tail;
1789 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1795 _glcpp_parser_expand_token_list (parser, list);
1797 _token_list_trim_trailing_space (list);
1799 _token_list_print (parser, list);
1803 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1804 const char *identifier)
1806 /* According to the GLSL specification, macro names starting with "__"
1807 * or "GL_" are reserved for future use. So, don't allow them.
1809 if (strstr(identifier, "__")) {
1810 glcpp_error (loc, parser, "Macro names containing \"__\" are reserved.\n");
1812 if (strncmp(identifier, "GL_", 3) == 0) {
1813 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1818 _macro_equal (macro_t *a, macro_t *b)
1820 if (a->is_function != b->is_function)
1823 if (a->is_function) {
1824 if (! _string_list_equal (a->parameters, b->parameters))
1828 return _token_list_equal_ignoring_space (a->replacements,
1833 _define_object_macro (glcpp_parser_t *parser,
1835 const char *identifier,
1836 token_list_t *replacements)
1838 macro_t *macro, *previous;
1841 _check_for_reserved_macro_name(parser, loc, identifier);
1843 macro = ralloc (parser, macro_t);
1845 macro->is_function = 0;
1846 macro->parameters = NULL;
1847 macro->identifier = ralloc_strdup (macro, identifier);
1848 macro->replacements = replacements;
1849 ralloc_steal (macro, replacements);
1851 previous = hash_table_find (parser->defines, identifier);
1853 if (_macro_equal (macro, previous)) {
1854 ralloc_free (macro);
1857 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1861 hash_table_insert (parser->defines, macro, identifier);
1865 _define_function_macro (glcpp_parser_t *parser,
1867 const char *identifier,
1868 string_list_t *parameters,
1869 token_list_t *replacements)
1871 macro_t *macro, *previous;
1873 _check_for_reserved_macro_name(parser, loc, identifier);
1875 macro = ralloc (parser, macro_t);
1876 ralloc_steal (macro, parameters);
1877 ralloc_steal (macro, replacements);
1879 macro->is_function = 1;
1880 macro->parameters = parameters;
1881 macro->identifier = ralloc_strdup (macro, identifier);
1882 macro->replacements = replacements;
1883 previous = hash_table_find (parser->defines, identifier);
1885 if (_macro_equal (macro, previous)) {
1886 ralloc_free (macro);
1889 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1893 hash_table_insert (parser->defines, macro, identifier);
1897 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1902 if (parser->lex_from_list == NULL) {
1903 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1905 /* XXX: This ugly block of code exists for the sole
1906 * purpose of converting a NEWLINE token into a SPACE
1907 * token, but only in the case where we have seen a
1908 * function-like macro name, but have not yet seen its
1909 * closing parenthesis.
1911 * There's perhaps a more compact way to do this with
1912 * mid-rule actions in the grammar.
1914 * I'm definitely not pleased with the complexity of
1917 if (parser->newline_as_space)
1920 parser->paren_count++;
1921 } else if (ret == ')') {
1922 parser->paren_count--;
1923 if (parser->paren_count == 0)
1924 parser->newline_as_space = 0;
1925 } else if (ret == NEWLINE) {
1927 } else if (ret != SPACE) {
1928 if (parser->paren_count == 0)
1929 parser->newline_as_space = 0;
1932 else if (parser->in_control_line)
1935 parser->in_control_line = 0;
1937 else if (ret == HASH_DEFINE ||
1938 ret == HASH_UNDEF || ret == HASH_IF ||
1939 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1940 ret == HASH_ELIF || ret == HASH_ELSE ||
1941 ret == HASH_ENDIF || ret == HASH)
1943 parser->in_control_line = 1;
1945 else if (ret == IDENTIFIER)
1948 macro = hash_table_find (parser->defines,
1950 if (macro && macro->is_function) {
1951 parser->newline_as_space = 1;
1952 parser->paren_count = 0;
1959 node = parser->lex_from_node;
1962 ralloc_free (parser->lex_from_list);
1963 parser->lex_from_list = NULL;
1967 *yylval = node->token->value;
1968 ret = node->token->type;
1970 parser->lex_from_node = node->next;
1976 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1980 assert (parser->lex_from_list == NULL);
1982 /* Copy list, eliminating any space tokens. */
1983 parser->lex_from_list = _token_list_create (parser);
1985 for (node = list->head; node; node = node->next) {
1986 if (node->token->type == SPACE)
1988 _token_list_append (parser->lex_from_list, node->token);
1993 parser->lex_from_node = parser->lex_from_list->head;
1995 /* It's possible the list consisted of nothing but whitespace. */
1996 if (parser->lex_from_node == NULL) {
1997 ralloc_free (parser->lex_from_list);
1998 parser->lex_from_list = NULL;
2003 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
2006 skip_type_t current = SKIP_NO_SKIP;
2009 if (parser->skip_stack)
2010 current = parser->skip_stack->type;
2012 node = ralloc (parser, skip_node_t);
2015 if (current == SKIP_NO_SKIP) {
2017 node->type = SKIP_NO_SKIP;
2019 node->type = SKIP_TO_ELSE;
2021 node->type = SKIP_TO_ENDIF;
2024 node->next = parser->skip_stack;
2025 parser->skip_stack = node;
2029 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
2030 const char *type, int condition)
2032 if (parser->skip_stack == NULL) {
2033 glcpp_error (loc, parser, "%s without #if\n", type);
2037 if (parser->skip_stack->type == SKIP_TO_ELSE) {
2039 parser->skip_stack->type = SKIP_NO_SKIP;
2041 parser->skip_stack->type = SKIP_TO_ENDIF;
2046 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
2050 if (parser->skip_stack == NULL) {
2051 glcpp_error (loc, parser, "#endif without #if\n");
2055 node = parser->skip_stack;
2056 parser->skip_stack = node->next;
2061 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
2062 const char *es_identifier)
2064 macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
2066 hash_table_remove (parser->defines, "__VERSION__");
2067 ralloc_free (macro);
2069 add_builtin_define (parser, "__VERSION__", version);
2071 /* If we didn't have a GLES context to begin with, (indicated
2072 * by parser->api), then the version declaration here might
2074 if (! parser->is_gles &&
2076 (es_identifier && (strcmp(es_identifier, "es") == 0))))
2078 parser->is_gles = true;
2079 add_builtin_define (parser, "GL_ES", 1);
2083 add_builtin_define(parser, "GL_core_profile", 1);
2085 /* Currently, all ES2/ES3 implementations support highp in the
2086 * fragment shader, so we always define this macro in ES2/ES3.
2087 * If we ever get a driver that doesn't support highp, we'll
2088 * need to add a flag to the gl_context and check that here.
2090 if (version >= 130 || parser->is_gles)
2091 add_builtin_define (parser, "GL_FRAGMENT_PRECISION_HIGH", 1);
2093 ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length,
2094 "#version %" PRIiMAX "%s%s", version,
2095 es_identifier ? " " : "",
2096 es_identifier ? es_identifier : "");