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->AMD_conservative_depth) {
1136 add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
1137 add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
1141 language_version = 110;
1142 add_builtin_define(parser, "__VERSION__", language_version);
1148 glcpp_parser_parse (glcpp_parser_t *parser)
1150 return yyparse (parser);
1154 glcpp_parser_destroy (glcpp_parser_t *parser)
1156 glcpp_lex_destroy (parser->scanner);
1157 hash_table_dtor (parser->defines);
1158 ralloc_free (parser);
1161 typedef enum function_status
1163 FUNCTION_STATUS_SUCCESS,
1164 FUNCTION_NOT_A_FUNCTION,
1165 FUNCTION_UNBALANCED_PARENTHESES
1166 } function_status_t;
1168 /* Find a set of function-like macro arguments by looking for a
1169 * balanced set of parentheses.
1171 * When called, 'node' should be the opening-parenthesis token, (or
1172 * perhaps preceeding SPACE tokens). Upon successful return *last will
1173 * be the last consumed node, (corresponding to the closing right
1178 * FUNCTION_STATUS_SUCCESS:
1180 * Successfully parsed a set of function arguments.
1182 * FUNCTION_NOT_A_FUNCTION:
1184 * Macro name not followed by a '('. This is not an error, but
1185 * simply that the macro name should be treated as a non-macro.
1187 * FUNCTION_UNBALANCED_PARENTHESES
1189 * Macro name is not followed by a balanced set of parentheses.
1191 static function_status_t
1192 _arguments_parse (argument_list_t *arguments,
1194 token_node_t **last)
1196 token_list_t *argument;
1201 /* Ignore whitespace before first parenthesis. */
1202 while (node && node->token->type == SPACE)
1205 if (node == NULL || node->token->type != '(')
1206 return FUNCTION_NOT_A_FUNCTION;
1210 argument = _token_list_create (arguments);
1211 _argument_list_append (arguments, argument);
1213 for (paren_count = 1; node; node = node->next) {
1214 if (node->token->type == '(')
1218 else if (node->token->type == ')')
1221 if (paren_count == 0)
1225 if (node->token->type == ',' &&
1228 _token_list_trim_trailing_space (argument);
1229 argument = _token_list_create (arguments);
1230 _argument_list_append (arguments, argument);
1233 if (argument->head == NULL) {
1234 /* Don't treat initial whitespace as
1235 * part of the arguement. */
1236 if (node->token->type == SPACE)
1239 _token_list_append (argument, node->token);
1244 return FUNCTION_UNBALANCED_PARENTHESES;
1248 return FUNCTION_STATUS_SUCCESS;
1251 static token_list_t *
1252 _token_list_create_with_one_space (void *ctx)
1257 list = _token_list_create (ctx);
1258 space = _token_create_ival (list, SPACE, SPACE);
1259 _token_list_append (list, space);
1265 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list)
1267 token_list_t *expanded;
1270 expanded = _token_list_create (parser);
1271 token = _token_create_ival (parser, type, type);
1272 _token_list_append (expanded, token);
1273 _glcpp_parser_expand_token_list (parser, list);
1274 _token_list_append_list (expanded, list);
1275 glcpp_parser_lex_from (parser, expanded);
1278 /* This is a helper function that's essentially part of the
1279 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1280 * except for by that function.
1282 * Returns NULL if node is a simple token with no expansion, (that is,
1283 * although 'node' corresponds to an identifier defined as a
1284 * function-like macro, it is not followed with a parenthesized
1287 * Compute the complete expansion of node (which is a function-like
1288 * macro) and subsequent nodes which are arguments.
1290 * Returns the token list that results from the expansion and sets
1291 * *last to the last node in the list that was consumed by the
1292 * expansion. Specifically, *last will be set as follows: as the
1293 * token of the closing right parenthesis.
1295 static token_list_t *
1296 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1298 token_node_t **last)
1302 const char *identifier;
1303 argument_list_t *arguments;
1304 function_status_t status;
1305 token_list_t *substituted;
1306 int parameter_index;
1308 identifier = node->token->value.str;
1310 macro = hash_table_find (parser->defines, identifier);
1312 assert (macro->is_function);
1314 arguments = _argument_list_create (parser);
1315 status = _arguments_parse (arguments, node, last);
1318 case FUNCTION_STATUS_SUCCESS:
1320 case FUNCTION_NOT_A_FUNCTION:
1322 case FUNCTION_UNBALANCED_PARENTHESES:
1323 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1327 /* Replace a macro defined as empty with a SPACE token. */
1328 if (macro->replacements == NULL) {
1329 ralloc_free (arguments);
1330 return _token_list_create_with_one_space (parser);
1333 if (! ((_argument_list_length (arguments) ==
1334 _string_list_length (macro->parameters)) ||
1335 (_string_list_length (macro->parameters) == 0 &&
1336 _argument_list_length (arguments) == 1 &&
1337 arguments->head->argument->head == NULL)))
1339 glcpp_error (&node->token->location, parser,
1340 "Error: macro %s invoked with %d arguments (expected %d)\n",
1342 _argument_list_length (arguments),
1343 _string_list_length (macro->parameters));
1347 /* Perform argument substitution on the replacement list. */
1348 substituted = _token_list_create (arguments);
1350 for (node = macro->replacements->head; node; node = node->next)
1352 if (node->token->type == IDENTIFIER &&
1353 _string_list_contains (macro->parameters,
1354 node->token->value.str,
1357 token_list_t *argument;
1358 argument = _argument_list_member_at (arguments,
1360 /* Before substituting, we expand the argument
1361 * tokens, or append a placeholder token for
1362 * an empty argument. */
1363 if (argument->head) {
1364 token_list_t *expanded_argument;
1365 expanded_argument = _token_list_copy (parser,
1367 _glcpp_parser_expand_token_list (parser,
1369 _token_list_append_list (substituted,
1374 new_token = _token_create_ival (substituted,
1377 _token_list_append (substituted, new_token);
1380 _token_list_append (substituted, node->token);
1384 /* After argument substitution, and before further expansion
1385 * below, implement token pasting. */
1387 _token_list_trim_trailing_space (substituted);
1389 node = substituted->head;
1392 token_node_t *next_non_space;
1394 /* Look ahead for a PASTE token, skipping space. */
1395 next_non_space = node->next;
1396 while (next_non_space && next_non_space->token->type == SPACE)
1397 next_non_space = next_non_space->next;
1399 if (next_non_space == NULL)
1402 if (next_non_space->token->type != PASTE) {
1403 node = next_non_space;
1407 /* Now find the next non-space token after the PASTE. */
1408 next_non_space = next_non_space->next;
1409 while (next_non_space && next_non_space->token->type == SPACE)
1410 next_non_space = next_non_space->next;
1412 if (next_non_space == NULL) {
1413 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1417 node->token = _token_paste (parser, node->token, next_non_space->token);
1418 node->next = next_non_space->next;
1419 if (next_non_space == substituted->tail)
1420 substituted->tail = node;
1425 substituted->non_space_tail = substituted->tail;
1430 /* Compute the complete expansion of node, (and subsequent nodes after
1431 * 'node' in the case that 'node' is a function-like macro and
1432 * subsequent nodes are arguments).
1434 * Returns NULL if node is a simple token with no expansion.
1436 * Otherwise, returns the token list that results from the expansion
1437 * and sets *last to the last node in the list that was consumed by
1438 * the expansion. Specifically, *last will be set as follows:
1440 * As 'node' in the case of object-like macro expansion.
1442 * As the token of the closing right parenthesis in the case of
1443 * function-like macro expansion.
1445 static token_list_t *
1446 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1448 token_node_t **last)
1450 token_t *token = node->token;
1451 const char *identifier;
1454 /* We only expand identifiers */
1455 if (token->type != IDENTIFIER) {
1456 /* We change any COMMA into a COMMA_FINAL to prevent
1457 * it being mistaken for an argument separator
1459 if (token->type == ',') {
1460 token->type = COMMA_FINAL;
1461 token->value.ival = COMMA_FINAL;
1467 /* Look up this identifier in the hash table. */
1468 identifier = token->value.str;
1469 macro = hash_table_find (parser->defines, identifier);
1471 /* Not a macro, so no expansion needed. */
1475 /* Finally, don't expand this macro if we're already actively
1476 * expanding it, (to avoid infinite recursion). */
1477 if (_parser_active_list_contains (parser, identifier)) {
1478 /* We change the token type here from IDENTIFIER to
1479 * OTHER to prevent any future expansion of this
1480 * unexpanded token. */
1482 token_list_t *expansion;
1485 str = ralloc_strdup (parser, token->value.str);
1486 final = _token_create_str (parser, OTHER, str);
1487 expansion = _token_list_create (parser);
1488 _token_list_append (expansion, final);
1493 if (! macro->is_function)
1497 /* Replace a macro defined as empty with a SPACE token. */
1498 if (macro->replacements == NULL)
1499 return _token_list_create_with_one_space (parser);
1501 return _token_list_copy (parser, macro->replacements);
1504 return _glcpp_parser_expand_function (parser, node, last);
1507 /* Push a new identifier onto the parser's active list.
1509 * Here, 'marker' is the token node that appears in the list after the
1510 * expansion of 'identifier'. That is, when the list iterator begins
1511 * examining 'marker', then it is time to pop this node from the
1515 _parser_active_list_push (glcpp_parser_t *parser,
1516 const char *identifier,
1517 token_node_t *marker)
1519 active_list_t *node;
1521 node = ralloc (parser->active, active_list_t);
1522 node->identifier = ralloc_strdup (node, identifier);
1523 node->marker = marker;
1524 node->next = parser->active;
1526 parser->active = node;
1530 _parser_active_list_pop (glcpp_parser_t *parser)
1532 active_list_t *node = parser->active;
1535 parser->active = NULL;
1539 node = parser->active->next;
1540 ralloc_free (parser->active);
1542 parser->active = node;
1546 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier)
1548 active_list_t *node;
1550 if (parser->active == NULL)
1553 for (node = parser->active; node; node = node->next)
1554 if (strcmp (node->identifier, identifier) == 0)
1560 /* Walk over the token list replacing nodes with their expansion.
1561 * Whenever nodes are expanded the walking will walk over the new
1562 * nodes, continuing to expand as necessary. The results are placed in
1566 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1569 token_node_t *node_prev;
1570 token_node_t *node, *last = NULL;
1571 token_list_t *expansion;
1572 active_list_t *active_initial = parser->active;
1577 _token_list_trim_trailing_space (list);
1584 while (parser->active && parser->active->marker == node)
1585 _parser_active_list_pop (parser);
1587 expansion = _glcpp_parser_expand_node (parser, node, &last);
1591 for (n = node; n != last->next; n = n->next)
1592 while (parser->active &&
1593 parser->active->marker == n)
1595 _parser_active_list_pop (parser);
1598 _parser_active_list_push (parser,
1599 node->token->value.str,
1602 /* Splice expansion into list, supporting a
1603 * simple deletion if the expansion is
1605 if (expansion->head) {
1607 node_prev->next = expansion->head;
1609 list->head = expansion->head;
1610 expansion->tail->next = last->next;
1611 if (last == list->tail)
1612 list->tail = expansion->tail;
1615 node_prev->next = last->next;
1617 list->head = last->next;
1618 if (last == list->tail)
1624 node = node_prev ? node_prev->next : list->head;
1627 /* Remove any lingering effects of this invocation on the
1628 * active list. That is, pop until the list looks like it did
1629 * at the beginning of this function. */
1630 while (parser->active && parser->active != active_initial)
1631 _parser_active_list_pop (parser);
1633 list->non_space_tail = list->tail;
1637 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1643 _glcpp_parser_expand_token_list (parser, list);
1645 _token_list_trim_trailing_space (list);
1647 _token_list_print (parser, list);
1651 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1652 const char *identifier)
1654 /* According to the GLSL specification, macro names starting with "__"
1655 * or "GL_" are reserved for future use. So, don't allow them.
1657 if (strncmp(identifier, "__", 2) == 0) {
1658 glcpp_error (loc, parser, "Macro names starting with \"__\" are reserved.\n");
1660 if (strncmp(identifier, "GL_", 3) == 0) {
1661 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1666 _macro_equal (macro_t *a, macro_t *b)
1668 if (a->is_function != b->is_function)
1671 if (a->is_function) {
1672 if (! _string_list_equal (a->parameters, b->parameters))
1676 return _token_list_equal_ignoring_space (a->replacements,
1681 _define_object_macro (glcpp_parser_t *parser,
1683 const char *identifier,
1684 token_list_t *replacements)
1686 macro_t *macro, *previous;
1689 _check_for_reserved_macro_name(parser, loc, identifier);
1691 macro = ralloc (parser, macro_t);
1693 macro->is_function = 0;
1694 macro->parameters = NULL;
1695 macro->identifier = ralloc_strdup (macro, identifier);
1696 macro->replacements = replacements;
1697 ralloc_steal (macro, replacements);
1699 previous = hash_table_find (parser->defines, identifier);
1701 if (_macro_equal (macro, previous)) {
1702 ralloc_free (macro);
1705 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1709 hash_table_insert (parser->defines, macro, identifier);
1713 _define_function_macro (glcpp_parser_t *parser,
1715 const char *identifier,
1716 string_list_t *parameters,
1717 token_list_t *replacements)
1719 macro_t *macro, *previous;
1721 _check_for_reserved_macro_name(parser, loc, identifier);
1723 macro = ralloc (parser, macro_t);
1724 ralloc_steal (macro, parameters);
1725 ralloc_steal (macro, replacements);
1727 macro->is_function = 1;
1728 macro->parameters = parameters;
1729 macro->identifier = ralloc_strdup (macro, identifier);
1730 macro->replacements = replacements;
1731 previous = hash_table_find (parser->defines, identifier);
1733 if (_macro_equal (macro, previous)) {
1734 ralloc_free (macro);
1737 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1741 hash_table_insert (parser->defines, macro, identifier);
1745 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1750 if (parser->lex_from_list == NULL) {
1751 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1753 /* XXX: This ugly block of code exists for the sole
1754 * purpose of converting a NEWLINE token into a SPACE
1755 * token, but only in the case where we have seen a
1756 * function-like macro name, but have not yet seen its
1757 * closing parenthesis.
1759 * There's perhaps a more compact way to do this with
1760 * mid-rule actions in the grammar.
1762 * I'm definitely not pleased with the complexity of
1765 if (parser->newline_as_space)
1768 parser->paren_count++;
1769 } else if (ret == ')') {
1770 parser->paren_count--;
1771 if (parser->paren_count == 0)
1772 parser->newline_as_space = 0;
1773 } else if (ret == NEWLINE) {
1775 } else if (ret != SPACE) {
1776 if (parser->paren_count == 0)
1777 parser->newline_as_space = 0;
1780 else if (parser->in_control_line)
1783 parser->in_control_line = 0;
1785 else if (ret == HASH_DEFINE_OBJ || ret == HASH_DEFINE_FUNC ||
1786 ret == HASH_UNDEF || ret == HASH_IF ||
1787 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1788 ret == HASH_ELIF || ret == HASH_ELSE ||
1789 ret == HASH_ENDIF || ret == HASH)
1791 parser->in_control_line = 1;
1793 else if (ret == IDENTIFIER)
1796 macro = hash_table_find (parser->defines,
1798 if (macro && macro->is_function) {
1799 parser->newline_as_space = 1;
1800 parser->paren_count = 0;
1807 node = parser->lex_from_node;
1810 ralloc_free (parser->lex_from_list);
1811 parser->lex_from_list = NULL;
1815 *yylval = node->token->value;
1816 ret = node->token->type;
1818 parser->lex_from_node = node->next;
1824 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1828 assert (parser->lex_from_list == NULL);
1830 /* Copy list, eliminating any space tokens. */
1831 parser->lex_from_list = _token_list_create (parser);
1833 for (node = list->head; node; node = node->next) {
1834 if (node->token->type == SPACE)
1836 _token_list_append (parser->lex_from_list, node->token);
1841 parser->lex_from_node = parser->lex_from_list->head;
1843 /* It's possible the list consisted of nothing but whitespace. */
1844 if (parser->lex_from_node == NULL) {
1845 ralloc_free (parser->lex_from_list);
1846 parser->lex_from_list = NULL;
1851 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1854 skip_type_t current = SKIP_NO_SKIP;
1857 if (parser->skip_stack)
1858 current = parser->skip_stack->type;
1860 node = ralloc (parser, skip_node_t);
1863 if (current == SKIP_NO_SKIP) {
1865 node->type = SKIP_NO_SKIP;
1867 node->type = SKIP_TO_ELSE;
1869 node->type = SKIP_TO_ENDIF;
1872 node->next = parser->skip_stack;
1873 parser->skip_stack = node;
1877 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
1878 const char *type, int condition)
1880 if (parser->skip_stack == NULL) {
1881 glcpp_error (loc, parser, "%s without #if\n", type);
1885 if (parser->skip_stack->type == SKIP_TO_ELSE) {
1887 parser->skip_stack->type = SKIP_NO_SKIP;
1889 parser->skip_stack->type = SKIP_TO_ENDIF;
1894 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
1898 if (parser->skip_stack == NULL) {
1899 glcpp_error (loc, parser, "#endif without #if\n");
1903 node = parser->skip_stack;
1904 parser->skip_stack = node->next;