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);
88 /* Note: This function calls ralloc_steal on token. */
90 _token_list_append (token_list_t *list, token_t *token);
93 _token_list_append_list (token_list_t *list, token_list_t *tail);
96 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b);
99 _parser_active_list_push (glcpp_parser_t *parser,
100 const char *identifier,
101 token_node_t *marker);
104 _parser_active_list_pop (glcpp_parser_t *parser);
107 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier);
110 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list);
113 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
117 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
121 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
125 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
126 const char *type, int condition);
129 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc);
131 #define yylex glcpp_parser_lex
134 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser);
137 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list);
140 add_builtin_define(glcpp_parser_t *parser, const char *name, int value);
156 %parse-param {glcpp_parser_t *parser}
157 %lex-param {glcpp_parser_t *parser}
160 %token COMMA_FINAL DEFINED ELIF_EXPANDED HASH HASH_DEFINE_FUNC HASH_DEFINE_OBJ HASH_ELIF HASH_ELSE HASH_ENDIF HASH_IF HASH_IFDEF HASH_IFNDEF HASH_UNDEF HASH_VERSION IDENTIFIER IF_EXPANDED INTEGER INTEGER_STRING NEWLINE OTHER PLACEHOLDER SPACE
162 %type <ival> expression INTEGER operator SPACE integer_constant
163 %type <str> IDENTIFIER INTEGER_STRING OTHER
164 %type <string_list> identifier_list
165 %type <token> preprocessing_token conditional_token
166 %type <token_list> pp_tokens replacement_list text_line conditional_tokens
172 %left EQUAL NOT_EQUAL
173 %left '<' '>' LESS_OR_EQUAL GREATER_OR_EQUAL
174 %left LEFT_SHIFT RIGHT_SHIFT
188 ralloc_strcat (&parser->output, "\n");
191 _glcpp_parser_print_expanded_token_list (parser, $1);
192 ralloc_strcat (&parser->output, "\n");
200 IF_EXPANDED expression NEWLINE {
201 _glcpp_parser_skip_stack_push_if (parser, & @1, $2);
203 | ELIF_EXPANDED expression NEWLINE {
204 _glcpp_parser_skip_stack_change_if (parser, & @1, "elif", $2);
209 HASH_DEFINE_OBJ IDENTIFIER replacement_list NEWLINE {
210 _define_object_macro (parser, & @2, $2, $3);
212 | HASH_DEFINE_FUNC IDENTIFIER '(' ')' replacement_list NEWLINE {
213 _define_function_macro (parser, & @2, $2, NULL, $5);
215 | HASH_DEFINE_FUNC IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
216 _define_function_macro (parser, & @2, $2, $4, $6);
218 | HASH_UNDEF IDENTIFIER NEWLINE {
219 macro_t *macro = hash_table_find (parser->defines, $2);
221 hash_table_remove (parser->defines, $2);
226 | HASH_IF conditional_tokens NEWLINE {
227 /* Be careful to only evaluate the 'if' expression if
228 * we are not skipping. When we are skipping, we
229 * simply push a new 0-valued 'if' onto the skip
232 * This avoids generating diagnostics for invalid
233 * expressions that are being skipped. */
234 if (parser->skip_stack == NULL ||
235 parser->skip_stack->type == SKIP_NO_SKIP)
237 _glcpp_parser_expand_if (parser, IF_EXPANDED, $2);
241 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
242 parser->skip_stack->type = SKIP_TO_ENDIF;
246 /* #if without an expression is only an error if we
247 * are not skipping */
248 if (parser->skip_stack == NULL ||
249 parser->skip_stack->type == SKIP_NO_SKIP)
251 glcpp_error(& @1, parser, "#if with no expression");
253 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
255 | HASH_IFDEF IDENTIFIER junk NEWLINE {
256 macro_t *macro = hash_table_find (parser->defines, $2);
258 _glcpp_parser_skip_stack_push_if (parser, & @1, macro != NULL);
260 | HASH_IFNDEF IDENTIFIER junk NEWLINE {
261 macro_t *macro = hash_table_find (parser->defines, $2);
263 _glcpp_parser_skip_stack_push_if (parser, & @1, macro == NULL);
265 | HASH_ELIF conditional_tokens NEWLINE {
266 /* Be careful to only evaluate the 'elif' expression
267 * if we are not skipping. When we are skipping, we
268 * simply change to a 0-valued 'elif' on the skip
271 * This avoids generating diagnostics for invalid
272 * expressions that are being skipped. */
273 if (parser->skip_stack &&
274 parser->skip_stack->type == SKIP_TO_ELSE)
276 _glcpp_parser_expand_if (parser, ELIF_EXPANDED, $2);
280 _glcpp_parser_skip_stack_change_if (parser, & @1,
284 | HASH_ELIF NEWLINE {
285 /* #elif without an expression is an error unless we
287 if (parser->skip_stack &&
288 parser->skip_stack->type == SKIP_TO_ELSE)
290 glcpp_error(& @1, parser, "#elif with no expression");
294 _glcpp_parser_skip_stack_change_if (parser, & @1,
296 glcpp_warning(& @1, parser, "ignoring illegal #elif without expression");
299 | HASH_ELSE NEWLINE {
300 _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
302 | HASH_ENDIF NEWLINE {
303 _glcpp_parser_skip_stack_pop (parser, & @1);
305 | HASH_VERSION integer_constant NEWLINE {
306 macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
308 hash_table_remove (parser->defines, "__VERSION__");
311 add_builtin_define (parser, "__VERSION__", $2);
314 add_builtin_define (parser, "GL_ES", 1);
316 /* Currently, all ES2 implementations support highp in the
317 * fragment shader, so we always define this macro in ES2.
318 * If we ever get a driver that doesn't support highp, we'll
319 * need to add a flag to the gl_context and check that here.
321 if ($2 >= 130 || $2 == 100)
322 add_builtin_define (parser, "GL_FRAGMENT_PRECISION_HIGH", 1);
324 ralloc_asprintf_append (&parser->output, "#version %" PRIiMAX, $2);
331 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
332 $$ = strtoll ($1 + 2, NULL, 16);
333 } else if ($1[0] == '0') {
334 $$ = strtoll ($1, NULL, 8);
336 $$ = strtoll ($1, NULL, 10);
345 | expression OR expression {
348 | expression AND expression {
351 | expression '|' expression {
354 | expression '^' expression {
357 | expression '&' expression {
360 | expression NOT_EQUAL expression {
363 | expression EQUAL expression {
366 | expression GREATER_OR_EQUAL expression {
369 | expression LESS_OR_EQUAL expression {
372 | expression '>' expression {
375 | expression '<' expression {
378 | expression RIGHT_SHIFT expression {
381 | expression LEFT_SHIFT expression {
384 | expression '-' expression {
387 | expression '+' expression {
390 | expression '%' expression {
392 yyerror (& @1, parser,
393 "zero modulus in preprocessor directive");
398 | expression '/' expression {
400 yyerror (& @1, parser,
401 "division by 0 in preprocessor directive");
406 | expression '*' expression {
409 | '!' expression %prec UNARY {
412 | '~' expression %prec UNARY {
415 | '-' expression %prec UNARY {
418 | '+' expression %prec UNARY {
421 | '(' expression ')' {
428 $$ = _string_list_create (parser);
429 _string_list_append_item ($$, $1);
430 ralloc_steal ($$, $1);
432 | identifier_list ',' IDENTIFIER {
434 _string_list_append_item ($$, $3);
435 ralloc_steal ($$, $3);
440 NEWLINE { $$ = NULL; }
446 yyerror (& @1, parser, "Invalid tokens after #");
451 /* empty */ { $$ = NULL; }
458 glcpp_warning(&@1, parser, "extra tokens at end of directive");
463 /* Handle "defined" operator */
465 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
466 $$ = _token_create_ival (parser, INTEGER, v);
468 | DEFINED '(' IDENTIFIER ')' {
469 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
470 $$ = _token_create_ival (parser, INTEGER, v);
472 | preprocessing_token
476 /* Exactly the same as pp_tokens, but using conditional_token */
478 $$ = _token_list_create (parser);
479 _token_list_append ($$, $1);
481 | conditional_tokens conditional_token {
483 _token_list_append ($$, $2);
488 preprocessing_token {
489 parser->space_tokens = 1;
490 $$ = _token_list_create (parser);
491 _token_list_append ($$, $1);
493 | pp_tokens preprocessing_token {
495 _token_list_append ($$, $2);
501 $$ = _token_create_str (parser, IDENTIFIER, $1);
502 $$->location = yylloc;
505 $$ = _token_create_str (parser, INTEGER_STRING, $1);
506 $$->location = yylloc;
509 $$ = _token_create_ival (parser, $1, $1);
510 $$->location = yylloc;
513 $$ = _token_create_str (parser, OTHER, $1);
514 $$->location = yylloc;
517 $$ = _token_create_ival (parser, SPACE, SPACE);
518 $$->location = yylloc;
538 | LEFT_SHIFT { $$ = LEFT_SHIFT; }
539 | RIGHT_SHIFT { $$ = RIGHT_SHIFT; }
542 | LESS_OR_EQUAL { $$ = LESS_OR_EQUAL; }
543 | GREATER_OR_EQUAL { $$ = GREATER_OR_EQUAL; }
544 | EQUAL { $$ = EQUAL; }
545 | NOT_EQUAL { $$ = NOT_EQUAL; }
553 | PASTE { $$ = PASTE; }
559 _string_list_create (void *ctx)
563 list = ralloc (ctx, string_list_t);
571 _string_list_append_item (string_list_t *list, const char *str)
575 node = ralloc (list, string_node_t);
576 node->str = ralloc_strdup (node, str);
580 if (list->head == NULL) {
583 list->tail->next = node;
590 _string_list_contains (string_list_t *list, const char *member, int *index)
598 for (i = 0, node = list->head; node; i++, node = node->next) {
599 if (strcmp (node->str, member) == 0) {
610 _string_list_length (string_list_t *list)
618 for (node = list->head; node; node = node->next)
625 _string_list_equal (string_list_t *a, string_list_t *b)
627 string_node_t *node_a, *node_b;
629 if (a == NULL && b == NULL)
632 if (a == NULL || b == NULL)
635 for (node_a = a->head, node_b = b->head;
637 node_a = node_a->next, node_b = node_b->next)
639 if (strcmp (node_a->str, node_b->str))
643 /* Catch the case of lists being different lengths, (which
644 * would cause the loop above to terminate after the shorter
646 return node_a == node_b;
650 _argument_list_create (void *ctx)
652 argument_list_t *list;
654 list = ralloc (ctx, argument_list_t);
662 _argument_list_append (argument_list_t *list, token_list_t *argument)
664 argument_node_t *node;
666 node = ralloc (list, argument_node_t);
667 node->argument = argument;
671 if (list->head == NULL) {
674 list->tail->next = node;
681 _argument_list_length (argument_list_t *list)
684 argument_node_t *node;
689 for (node = list->head; node; node = node->next)
696 _argument_list_member_at (argument_list_t *list, int index)
698 argument_node_t *node;
705 for (i = 0; i < index; i++) {
712 return node->argument;
717 /* Note: This function ralloc_steal()s the str pointer. */
719 _token_create_str (void *ctx, int type, char *str)
723 token = ralloc (ctx, token_t);
725 token->value.str = str;
727 ralloc_steal (token, str);
733 _token_create_ival (void *ctx, int type, int ival)
737 token = ralloc (ctx, token_t);
739 token->value.ival = ival;
745 _token_list_create (void *ctx)
749 list = ralloc (ctx, token_list_t);
752 list->non_space_tail = NULL;
758 _token_list_append (token_list_t *list, token_t *token)
762 node = ralloc (list, token_node_t);
766 ralloc_steal (list, token);
768 if (list->head == NULL) {
771 list->tail->next = node;
775 if (token->type != SPACE)
776 list->non_space_tail = node;
780 _token_list_append_list (token_list_t *list, token_list_t *tail)
782 if (tail == NULL || tail->head == NULL)
785 if (list->head == NULL) {
786 list->head = tail->head;
788 list->tail->next = tail->head;
791 list->tail = tail->tail;
792 list->non_space_tail = tail->non_space_tail;
795 static token_list_t *
796 _token_list_copy (void *ctx, token_list_t *other)
804 copy = _token_list_create (ctx);
805 for (node = other->head; node; node = node->next) {
806 token_t *new_token = ralloc (copy, token_t);
807 *new_token = *node->token;
808 _token_list_append (copy, new_token);
815 _token_list_trim_trailing_space (token_list_t *list)
817 token_node_t *tail, *next;
819 if (list->non_space_tail) {
820 tail = list->non_space_tail->next;
821 list->non_space_tail->next = NULL;
822 list->tail = list->non_space_tail;
833 _token_list_is_empty_ignoring_space (token_list_t *l)
841 while (n != NULL && n->token->type == SPACE)
848 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
850 token_node_t *node_a, *node_b;
852 if (a == NULL || b == NULL) {
853 int a_empty = _token_list_is_empty_ignoring_space(a);
854 int b_empty = _token_list_is_empty_ignoring_space(b);
855 return a_empty == b_empty;
863 if (node_a == NULL && node_b == NULL)
866 if (node_a == NULL || node_b == NULL)
869 if (node_a->token->type == SPACE) {
870 node_a = node_a->next;
874 if (node_b->token->type == SPACE) {
875 node_b = node_b->next;
879 if (node_a->token->type != node_b->token->type)
882 switch (node_a->token->type) {
884 if (node_a->token->value.ival !=
885 node_b->token->value.ival)
893 if (strcmp (node_a->token->value.str,
894 node_b->token->value.str))
901 node_a = node_a->next;
902 node_b = node_b->next;
909 _token_print (char **out, token_t *token)
911 if (token->type < 256) {
912 ralloc_asprintf_append (out, "%c", token->type);
916 switch (token->type) {
918 ralloc_asprintf_append (out, "%" PRIiMAX, token->value.ival);
923 ralloc_strcat (out, token->value.str);
926 ralloc_strcat (out, " ");
929 ralloc_strcat (out, "<<");
932 ralloc_strcat (out, ">>");
935 ralloc_strcat (out, "<=");
937 case GREATER_OR_EQUAL:
938 ralloc_strcat (out, ">=");
941 ralloc_strcat (out, "==");
944 ralloc_strcat (out, "!=");
947 ralloc_strcat (out, "&&");
950 ralloc_strcat (out, "||");
953 ralloc_strcat (out, "##");
956 ralloc_strcat (out, ",");
959 /* Nothing to print. */
962 assert(!"Error: Don't know how to print token.");
967 /* Return a new token (ralloc()ed off of 'token') formed by pasting
968 * 'token' and 'other'. Note that this function may return 'token' or
969 * 'other' directly rather than allocating anything new.
971 * Caution: Only very cursory error-checking is performed to see if
972 * the final result is a valid single token. */
974 _token_paste (glcpp_parser_t *parser, token_t *token, token_t *other)
976 token_t *combined = NULL;
978 /* Pasting a placeholder onto anything makes no change. */
979 if (other->type == PLACEHOLDER)
982 /* When 'token' is a placeholder, just return 'other'. */
983 if (token->type == PLACEHOLDER)
986 /* A very few single-character punctuators can be combined
987 * with another to form a multi-character punctuator. */
988 switch (token->type) {
990 if (other->type == '<')
991 combined = _token_create_ival (token, LEFT_SHIFT, LEFT_SHIFT);
992 else if (other->type == '=')
993 combined = _token_create_ival (token, LESS_OR_EQUAL, LESS_OR_EQUAL);
996 if (other->type == '>')
997 combined = _token_create_ival (token, RIGHT_SHIFT, RIGHT_SHIFT);
998 else if (other->type == '=')
999 combined = _token_create_ival (token, GREATER_OR_EQUAL, GREATER_OR_EQUAL);
1002 if (other->type == '=')
1003 combined = _token_create_ival (token, EQUAL, EQUAL);
1006 if (other->type == '=')
1007 combined = _token_create_ival (token, NOT_EQUAL, NOT_EQUAL);
1010 if (other->type == '&')
1011 combined = _token_create_ival (token, AND, AND);
1014 if (other->type == '|')
1015 combined = _token_create_ival (token, OR, OR);
1019 if (combined != NULL) {
1020 /* Inherit the location from the first token */
1021 combined->location = token->location;
1025 /* Two string-valued tokens can usually just be mashed
1028 * XXX: This isn't actually legitimate. Several things here
1029 * should result in a diagnostic since the result cannot be a
1030 * valid, single pre-processing token. For example, pasting
1031 * "123" and "abc" is not legal, but we don't catch that
1033 if ((token->type == IDENTIFIER || token->type == OTHER || token->type == INTEGER_STRING) &&
1034 (other->type == IDENTIFIER || other->type == OTHER || other->type == INTEGER_STRING))
1038 str = ralloc_asprintf (token, "%s%s", token->value.str,
1040 combined = _token_create_str (token, token->type, str);
1041 combined->location = token->location;
1045 glcpp_error (&token->location, parser, "");
1046 ralloc_strcat (&parser->info_log, "Pasting \"");
1047 _token_print (&parser->info_log, token);
1048 ralloc_strcat (&parser->info_log, "\" and \"");
1049 _token_print (&parser->info_log, other);
1050 ralloc_strcat (&parser->info_log, "\" does not give a valid preprocessing token.\n");
1056 _token_list_print (glcpp_parser_t *parser, token_list_t *list)
1063 for (node = list->head; node; node = node->next)
1064 _token_print (&parser->output, node->token);
1068 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error)
1070 glcpp_error(locp, parser, "%s", error);
1073 static void add_builtin_define(glcpp_parser_t *parser,
1074 const char *name, int value)
1079 tok = _token_create_ival (parser, INTEGER, value);
1081 list = _token_list_create(parser);
1082 _token_list_append(list, tok);
1083 _define_object_macro(parser, NULL, name, list);
1087 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1089 glcpp_parser_t *parser;
1090 int language_version;
1092 parser = ralloc (NULL, glcpp_parser_t);
1094 glcpp_lex_init_extra (parser, &parser->scanner);
1095 parser->defines = hash_table_ctor (32, hash_table_string_hash,
1096 hash_table_string_compare);
1097 parser->active = NULL;
1098 parser->lexing_if = 0;
1099 parser->space_tokens = 1;
1100 parser->newline_as_space = 0;
1101 parser->in_control_line = 0;
1102 parser->paren_count = 0;
1104 parser->skip_stack = NULL;
1106 parser->lex_from_list = NULL;
1107 parser->lex_from_node = NULL;
1109 parser->output = ralloc_strdup(parser, "");
1110 parser->info_log = ralloc_strdup(parser, "");
1113 /* Add pre-defined macros. */
1114 add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1115 add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1117 if (api == API_OPENGLES2)
1118 add_builtin_define(parser, "GL_ES", 1);
1120 if (extensions != NULL) {
1121 if (extensions->EXT_texture_array) {
1122 add_builtin_define(parser, "GL_EXT_texture_array", 1);
1125 if (extensions->ARB_fragment_coord_conventions)
1126 add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1129 if (extensions->ARB_explicit_attrib_location)
1130 add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
1132 if (extensions->ARB_shader_texture_lod)
1133 add_builtin_define(parser, "GL_ARB_shader_texture_lod", 1);
1135 if (extensions->ARB_draw_instanced)
1136 add_builtin_define(parser, "GL_ARB_draw_instanced", 1);
1138 if (extensions->AMD_conservative_depth) {
1139 add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
1140 add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
1143 if (extensions->OES_EGL_image_external)
1144 add_builtin_define(parser, "GL_OES_EGL_image_external", 1);
1147 language_version = 110;
1148 add_builtin_define(parser, "__VERSION__", language_version);
1154 glcpp_parser_parse (glcpp_parser_t *parser)
1156 return yyparse (parser);
1160 glcpp_parser_destroy (glcpp_parser_t *parser)
1162 glcpp_lex_destroy (parser->scanner);
1163 hash_table_dtor (parser->defines);
1164 ralloc_free (parser);
1167 typedef enum function_status
1169 FUNCTION_STATUS_SUCCESS,
1170 FUNCTION_NOT_A_FUNCTION,
1171 FUNCTION_UNBALANCED_PARENTHESES
1172 } function_status_t;
1174 /* Find a set of function-like macro arguments by looking for a
1175 * balanced set of parentheses.
1177 * When called, 'node' should be the opening-parenthesis token, (or
1178 * perhaps preceeding SPACE tokens). Upon successful return *last will
1179 * be the last consumed node, (corresponding to the closing right
1184 * FUNCTION_STATUS_SUCCESS:
1186 * Successfully parsed a set of function arguments.
1188 * FUNCTION_NOT_A_FUNCTION:
1190 * Macro name not followed by a '('. This is not an error, but
1191 * simply that the macro name should be treated as a non-macro.
1193 * FUNCTION_UNBALANCED_PARENTHESES
1195 * Macro name is not followed by a balanced set of parentheses.
1197 static function_status_t
1198 _arguments_parse (argument_list_t *arguments,
1200 token_node_t **last)
1202 token_list_t *argument;
1207 /* Ignore whitespace before first parenthesis. */
1208 while (node && node->token->type == SPACE)
1211 if (node == NULL || node->token->type != '(')
1212 return FUNCTION_NOT_A_FUNCTION;
1216 argument = _token_list_create (arguments);
1217 _argument_list_append (arguments, argument);
1219 for (paren_count = 1; node; node = node->next) {
1220 if (node->token->type == '(')
1224 else if (node->token->type == ')')
1227 if (paren_count == 0)
1231 if (node->token->type == ',' &&
1234 _token_list_trim_trailing_space (argument);
1235 argument = _token_list_create (arguments);
1236 _argument_list_append (arguments, argument);
1239 if (argument->head == NULL) {
1240 /* Don't treat initial whitespace as
1241 * part of the arguement. */
1242 if (node->token->type == SPACE)
1245 _token_list_append (argument, node->token);
1250 return FUNCTION_UNBALANCED_PARENTHESES;
1254 return FUNCTION_STATUS_SUCCESS;
1257 static token_list_t *
1258 _token_list_create_with_one_space (void *ctx)
1263 list = _token_list_create (ctx);
1264 space = _token_create_ival (list, SPACE, SPACE);
1265 _token_list_append (list, space);
1271 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list)
1273 token_list_t *expanded;
1276 expanded = _token_list_create (parser);
1277 token = _token_create_ival (parser, type, type);
1278 _token_list_append (expanded, token);
1279 _glcpp_parser_expand_token_list (parser, list);
1280 _token_list_append_list (expanded, list);
1281 glcpp_parser_lex_from (parser, expanded);
1285 _glcpp_parser_apply_pastes (glcpp_parser_t *parser, token_list_t *list)
1292 token_node_t *next_non_space;
1294 /* Look ahead for a PASTE token, skipping space. */
1295 next_non_space = node->next;
1296 while (next_non_space && next_non_space->token->type == SPACE)
1297 next_non_space = next_non_space->next;
1299 if (next_non_space == NULL)
1302 if (next_non_space->token->type != PASTE) {
1303 node = next_non_space;
1307 /* Now find the next non-space token after the PASTE. */
1308 next_non_space = next_non_space->next;
1309 while (next_non_space && next_non_space->token->type == SPACE)
1310 next_non_space = next_non_space->next;
1312 if (next_non_space == NULL) {
1313 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1317 node->token = _token_paste (parser, node->token, next_non_space->token);
1318 node->next = next_non_space->next;
1319 if (next_non_space == list->tail)
1323 list->non_space_tail = list->tail;
1326 /* This is a helper function that's essentially part of the
1327 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1328 * except for by that function.
1330 * Returns NULL if node is a simple token with no expansion, (that is,
1331 * although 'node' corresponds to an identifier defined as a
1332 * function-like macro, it is not followed with a parenthesized
1335 * Compute the complete expansion of node (which is a function-like
1336 * macro) and subsequent nodes which are arguments.
1338 * Returns the token list that results from the expansion and sets
1339 * *last to the last node in the list that was consumed by the
1340 * expansion. Specifically, *last will be set as follows: as the
1341 * token of the closing right parenthesis.
1343 static token_list_t *
1344 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1346 token_node_t **last)
1350 const char *identifier;
1351 argument_list_t *arguments;
1352 function_status_t status;
1353 token_list_t *substituted;
1354 int parameter_index;
1356 identifier = node->token->value.str;
1358 macro = hash_table_find (parser->defines, identifier);
1360 assert (macro->is_function);
1362 arguments = _argument_list_create (parser);
1363 status = _arguments_parse (arguments, node, last);
1366 case FUNCTION_STATUS_SUCCESS:
1368 case FUNCTION_NOT_A_FUNCTION:
1370 case FUNCTION_UNBALANCED_PARENTHESES:
1371 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1375 /* Replace a macro defined as empty with a SPACE token. */
1376 if (macro->replacements == NULL) {
1377 ralloc_free (arguments);
1378 return _token_list_create_with_one_space (parser);
1381 if (! ((_argument_list_length (arguments) ==
1382 _string_list_length (macro->parameters)) ||
1383 (_string_list_length (macro->parameters) == 0 &&
1384 _argument_list_length (arguments) == 1 &&
1385 arguments->head->argument->head == NULL)))
1387 glcpp_error (&node->token->location, parser,
1388 "Error: macro %s invoked with %d arguments (expected %d)\n",
1390 _argument_list_length (arguments),
1391 _string_list_length (macro->parameters));
1395 /* Perform argument substitution on the replacement list. */
1396 substituted = _token_list_create (arguments);
1398 for (node = macro->replacements->head; node; node = node->next)
1400 if (node->token->type == IDENTIFIER &&
1401 _string_list_contains (macro->parameters,
1402 node->token->value.str,
1405 token_list_t *argument;
1406 argument = _argument_list_member_at (arguments,
1408 /* Before substituting, we expand the argument
1409 * tokens, or append a placeholder token for
1410 * an empty argument. */
1411 if (argument->head) {
1412 token_list_t *expanded_argument;
1413 expanded_argument = _token_list_copy (parser,
1415 _glcpp_parser_expand_token_list (parser,
1417 _token_list_append_list (substituted,
1422 new_token = _token_create_ival (substituted,
1425 _token_list_append (substituted, new_token);
1428 _token_list_append (substituted, node->token);
1432 /* After argument substitution, and before further expansion
1433 * below, implement token pasting. */
1435 _token_list_trim_trailing_space (substituted);
1437 _glcpp_parser_apply_pastes (parser, substituted);
1442 /* Compute the complete expansion of node, (and subsequent nodes after
1443 * 'node' in the case that 'node' is a function-like macro and
1444 * subsequent nodes are arguments).
1446 * Returns NULL if node is a simple token with no expansion.
1448 * Otherwise, returns the token list that results from the expansion
1449 * and sets *last to the last node in the list that was consumed by
1450 * the expansion. Specifically, *last will be set as follows:
1452 * As 'node' in the case of object-like macro expansion.
1454 * As the token of the closing right parenthesis in the case of
1455 * function-like macro expansion.
1457 static token_list_t *
1458 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1460 token_node_t **last)
1462 token_t *token = node->token;
1463 const char *identifier;
1466 /* We only expand identifiers */
1467 if (token->type != IDENTIFIER) {
1468 /* We change any COMMA into a COMMA_FINAL to prevent
1469 * it being mistaken for an argument separator
1471 if (token->type == ',') {
1472 token->type = COMMA_FINAL;
1473 token->value.ival = COMMA_FINAL;
1479 /* Look up this identifier in the hash table. */
1480 identifier = token->value.str;
1481 macro = hash_table_find (parser->defines, identifier);
1483 /* Not a macro, so no expansion needed. */
1487 /* Finally, don't expand this macro if we're already actively
1488 * expanding it, (to avoid infinite recursion). */
1489 if (_parser_active_list_contains (parser, identifier)) {
1490 /* We change the token type here from IDENTIFIER to
1491 * OTHER to prevent any future expansion of this
1492 * unexpanded token. */
1494 token_list_t *expansion;
1497 str = ralloc_strdup (parser, token->value.str);
1498 final = _token_create_str (parser, OTHER, str);
1499 expansion = _token_list_create (parser);
1500 _token_list_append (expansion, final);
1505 if (! macro->is_function)
1507 token_list_t *replacement;
1510 /* Replace a macro defined as empty with a SPACE token. */
1511 if (macro->replacements == NULL)
1512 return _token_list_create_with_one_space (parser);
1514 replacement = _token_list_copy (parser, macro->replacements);
1515 _glcpp_parser_apply_pastes (parser, replacement);
1519 return _glcpp_parser_expand_function (parser, node, last);
1522 /* Push a new identifier onto the parser's active list.
1524 * Here, 'marker' is the token node that appears in the list after the
1525 * expansion of 'identifier'. That is, when the list iterator begins
1526 * examining 'marker', then it is time to pop this node from the
1530 _parser_active_list_push (glcpp_parser_t *parser,
1531 const char *identifier,
1532 token_node_t *marker)
1534 active_list_t *node;
1536 node = ralloc (parser->active, active_list_t);
1537 node->identifier = ralloc_strdup (node, identifier);
1538 node->marker = marker;
1539 node->next = parser->active;
1541 parser->active = node;
1545 _parser_active_list_pop (glcpp_parser_t *parser)
1547 active_list_t *node = parser->active;
1550 parser->active = NULL;
1554 node = parser->active->next;
1555 ralloc_free (parser->active);
1557 parser->active = node;
1561 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier)
1563 active_list_t *node;
1565 if (parser->active == NULL)
1568 for (node = parser->active; node; node = node->next)
1569 if (strcmp (node->identifier, identifier) == 0)
1575 /* Walk over the token list replacing nodes with their expansion.
1576 * Whenever nodes are expanded the walking will walk over the new
1577 * nodes, continuing to expand as necessary. The results are placed in
1581 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1584 token_node_t *node_prev;
1585 token_node_t *node, *last = NULL;
1586 token_list_t *expansion;
1587 active_list_t *active_initial = parser->active;
1592 _token_list_trim_trailing_space (list);
1599 while (parser->active && parser->active->marker == node)
1600 _parser_active_list_pop (parser);
1602 expansion = _glcpp_parser_expand_node (parser, node, &last);
1606 for (n = node; n != last->next; n = n->next)
1607 while (parser->active &&
1608 parser->active->marker == n)
1610 _parser_active_list_pop (parser);
1613 _parser_active_list_push (parser,
1614 node->token->value.str,
1617 /* Splice expansion into list, supporting a
1618 * simple deletion if the expansion is
1620 if (expansion->head) {
1622 node_prev->next = expansion->head;
1624 list->head = expansion->head;
1625 expansion->tail->next = last->next;
1626 if (last == list->tail)
1627 list->tail = expansion->tail;
1630 node_prev->next = last->next;
1632 list->head = last->next;
1633 if (last == list->tail)
1639 node = node_prev ? node_prev->next : list->head;
1642 /* Remove any lingering effects of this invocation on the
1643 * active list. That is, pop until the list looks like it did
1644 * at the beginning of this function. */
1645 while (parser->active && parser->active != active_initial)
1646 _parser_active_list_pop (parser);
1648 list->non_space_tail = list->tail;
1652 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1658 _glcpp_parser_expand_token_list (parser, list);
1660 _token_list_trim_trailing_space (list);
1662 _token_list_print (parser, list);
1666 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1667 const char *identifier)
1669 /* According to the GLSL specification, macro names starting with "__"
1670 * or "GL_" are reserved for future use. So, don't allow them.
1672 if (strstr(identifier, "__")) {
1673 glcpp_error (loc, parser, "Macro names containing \"__\" are reserved.\n");
1675 if (strncmp(identifier, "GL_", 3) == 0) {
1676 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1681 _macro_equal (macro_t *a, macro_t *b)
1683 if (a->is_function != b->is_function)
1686 if (a->is_function) {
1687 if (! _string_list_equal (a->parameters, b->parameters))
1691 return _token_list_equal_ignoring_space (a->replacements,
1696 _define_object_macro (glcpp_parser_t *parser,
1698 const char *identifier,
1699 token_list_t *replacements)
1701 macro_t *macro, *previous;
1704 _check_for_reserved_macro_name(parser, loc, identifier);
1706 macro = ralloc (parser, macro_t);
1708 macro->is_function = 0;
1709 macro->parameters = NULL;
1710 macro->identifier = ralloc_strdup (macro, identifier);
1711 macro->replacements = replacements;
1712 ralloc_steal (macro, replacements);
1714 previous = hash_table_find (parser->defines, identifier);
1716 if (_macro_equal (macro, previous)) {
1717 ralloc_free (macro);
1720 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1724 hash_table_insert (parser->defines, macro, identifier);
1728 _define_function_macro (glcpp_parser_t *parser,
1730 const char *identifier,
1731 string_list_t *parameters,
1732 token_list_t *replacements)
1734 macro_t *macro, *previous;
1736 _check_for_reserved_macro_name(parser, loc, identifier);
1738 macro = ralloc (parser, macro_t);
1739 ralloc_steal (macro, parameters);
1740 ralloc_steal (macro, replacements);
1742 macro->is_function = 1;
1743 macro->parameters = parameters;
1744 macro->identifier = ralloc_strdup (macro, identifier);
1745 macro->replacements = replacements;
1746 previous = hash_table_find (parser->defines, identifier);
1748 if (_macro_equal (macro, previous)) {
1749 ralloc_free (macro);
1752 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1756 hash_table_insert (parser->defines, macro, identifier);
1760 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1765 if (parser->lex_from_list == NULL) {
1766 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1768 /* XXX: This ugly block of code exists for the sole
1769 * purpose of converting a NEWLINE token into a SPACE
1770 * token, but only in the case where we have seen a
1771 * function-like macro name, but have not yet seen its
1772 * closing parenthesis.
1774 * There's perhaps a more compact way to do this with
1775 * mid-rule actions in the grammar.
1777 * I'm definitely not pleased with the complexity of
1780 if (parser->newline_as_space)
1783 parser->paren_count++;
1784 } else if (ret == ')') {
1785 parser->paren_count--;
1786 if (parser->paren_count == 0)
1787 parser->newline_as_space = 0;
1788 } else if (ret == NEWLINE) {
1790 } else if (ret != SPACE) {
1791 if (parser->paren_count == 0)
1792 parser->newline_as_space = 0;
1795 else if (parser->in_control_line)
1798 parser->in_control_line = 0;
1800 else if (ret == HASH_DEFINE_OBJ || ret == HASH_DEFINE_FUNC ||
1801 ret == HASH_UNDEF || ret == HASH_IF ||
1802 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1803 ret == HASH_ELIF || ret == HASH_ELSE ||
1804 ret == HASH_ENDIF || ret == HASH)
1806 parser->in_control_line = 1;
1808 else if (ret == IDENTIFIER)
1811 macro = hash_table_find (parser->defines,
1813 if (macro && macro->is_function) {
1814 parser->newline_as_space = 1;
1815 parser->paren_count = 0;
1822 node = parser->lex_from_node;
1825 ralloc_free (parser->lex_from_list);
1826 parser->lex_from_list = NULL;
1830 *yylval = node->token->value;
1831 ret = node->token->type;
1833 parser->lex_from_node = node->next;
1839 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1843 assert (parser->lex_from_list == NULL);
1845 /* Copy list, eliminating any space tokens. */
1846 parser->lex_from_list = _token_list_create (parser);
1848 for (node = list->head; node; node = node->next) {
1849 if (node->token->type == SPACE)
1851 _token_list_append (parser->lex_from_list, node->token);
1856 parser->lex_from_node = parser->lex_from_list->head;
1858 /* It's possible the list consisted of nothing but whitespace. */
1859 if (parser->lex_from_node == NULL) {
1860 ralloc_free (parser->lex_from_list);
1861 parser->lex_from_list = NULL;
1866 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1869 skip_type_t current = SKIP_NO_SKIP;
1872 if (parser->skip_stack)
1873 current = parser->skip_stack->type;
1875 node = ralloc (parser, skip_node_t);
1878 if (current == SKIP_NO_SKIP) {
1880 node->type = SKIP_NO_SKIP;
1882 node->type = SKIP_TO_ELSE;
1884 node->type = SKIP_TO_ENDIF;
1887 node->next = parser->skip_stack;
1888 parser->skip_stack = node;
1892 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
1893 const char *type, int condition)
1895 if (parser->skip_stack == NULL) {
1896 glcpp_error (loc, parser, "%s without #if\n", type);
1900 if (parser->skip_stack->type == SKIP_TO_ELSE) {
1902 parser->skip_stack->type = SKIP_NO_SKIP;
1904 parser->skip_stack->type = SKIP_TO_ENDIF;
1909 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
1913 if (parser->skip_stack == NULL) {
1914 glcpp_error (loc, parser, "#endif without #if\n");
1918 node = parser->skip_stack;
1919 parser->skip_stack = node->next;