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 */
35 #define glcpp_print(stream, str) stream = talloc_strdup_append(stream, str)
36 #define glcpp_printf(stream, fmt, args, ...) \
37 stream = talloc_asprintf_append(stream, fmt, args)
40 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error);
43 _define_object_macro (glcpp_parser_t *parser,
46 token_list_t *replacements);
49 _define_function_macro (glcpp_parser_t *parser,
52 string_list_t *parameters,
53 token_list_t *replacements);
55 static string_list_t *
56 _string_list_create (void *ctx);
59 _string_list_append_item (string_list_t *list, const char *str);
62 _string_list_contains (string_list_t *list, const char *member, int *index);
65 _string_list_length (string_list_t *list);
68 _string_list_equal (string_list_t *a, string_list_t *b);
70 static argument_list_t *
71 _argument_list_create (void *ctx);
74 _argument_list_append (argument_list_t *list, token_list_t *argument);
77 _argument_list_length (argument_list_t *list);
80 _argument_list_member_at (argument_list_t *list, int index);
82 /* Note: This function talloc_steal()s the str pointer. */
84 _token_create_str (void *ctx, int type, char *str);
87 _token_create_ival (void *ctx, int type, int ival);
90 _token_list_create (void *ctx);
92 /* Note: This function adds a talloc_reference() to token.
94 * You may want to talloc_unlink any current reference if you no
97 _token_list_append (token_list_t *list, token_t *token);
100 _token_list_append_list (token_list_t *list, token_list_t *tail);
103 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b);
105 static active_list_t *
106 _active_list_push (active_list_t *list,
107 const char *identifier,
108 token_node_t *marker);
110 static active_list_t *
111 _active_list_pop (active_list_t *list);
114 _active_list_contains (active_list_t *list, const char *identifier);
117 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list);
120 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
124 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
128 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
132 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
133 const char *type, int condition);
136 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc);
138 #define yylex glcpp_parser_lex
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 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
169 %type <ival> expression INTEGER operator SPACE integer_constant
170 %type <str> 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 glcpp_print(parser->output, "\n");
198 _glcpp_parser_print_expanded_token_list (parser, $1);
199 glcpp_print(parser->output, "\n");
207 IF_EXPANDED expression NEWLINE {
208 _glcpp_parser_skip_stack_push_if (parser, & @1, $2);
210 | ELIF_EXPANDED expression NEWLINE {
211 _glcpp_parser_skip_stack_change_if (parser, & @1, "elif", $2);
216 HASH_DEFINE_OBJ IDENTIFIER replacement_list NEWLINE {
217 _define_object_macro (parser, & @2, $2, $3);
219 | HASH_DEFINE_FUNC IDENTIFIER '(' ')' replacement_list NEWLINE {
220 _define_function_macro (parser, & @2, $2, NULL, $5);
222 | HASH_DEFINE_FUNC IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
223 _define_function_macro (parser, & @2, $2, $4, $6);
225 | HASH_UNDEF IDENTIFIER NEWLINE {
226 macro_t *macro = hash_table_find (parser->defines, $2);
228 hash_table_remove (parser->defines, $2);
233 | HASH_IF conditional_tokens NEWLINE {
234 /* Be careful to only evaluate the 'if' expression if
235 * we are not skipping. When we are skipping, we
236 * simply push a new 0-valued 'if' onto the skip
239 * This avoids generating diagnostics for invalid
240 * expressions that are being skipped. */
241 if (parser->skip_stack == NULL ||
242 parser->skip_stack->type == SKIP_NO_SKIP)
244 _glcpp_parser_expand_if (parser, IF_EXPANDED, $2);
248 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
249 parser->skip_stack->type = SKIP_TO_ENDIF;
253 /* #if without an expression is only an error if we
254 * are not skipping */
255 if (parser->skip_stack == NULL ||
256 parser->skip_stack->type == SKIP_NO_SKIP)
258 glcpp_error(& @1, parser, "#if with no expression");
260 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
262 | HASH_IFDEF IDENTIFIER junk NEWLINE {
263 macro_t *macro = hash_table_find (parser->defines, $2);
265 _glcpp_parser_skip_stack_push_if (parser, & @1, macro != NULL);
267 | HASH_IFNDEF IDENTIFIER junk NEWLINE {
268 macro_t *macro = hash_table_find (parser->defines, $2);
270 _glcpp_parser_skip_stack_push_if (parser, & @1, macro == NULL);
272 | HASH_ELIF conditional_tokens NEWLINE {
273 /* Be careful to only evaluate the 'elif' expression
274 * if we are not skipping. When we are skipping, we
275 * simply change to a 0-valued 'elif' on the skip
278 * This avoids generating diagnostics for invalid
279 * expressions that are being skipped. */
280 if (parser->skip_stack &&
281 parser->skip_stack->type == SKIP_TO_ELSE)
283 _glcpp_parser_expand_if (parser, ELIF_EXPANDED, $2);
287 _glcpp_parser_skip_stack_change_if (parser, & @1,
291 | HASH_ELIF NEWLINE {
292 /* #elif without an expression is an error unless we
294 if (parser->skip_stack &&
295 parser->skip_stack->type == SKIP_TO_ELSE)
297 glcpp_error(& @1, parser, "#elif with no expression");
301 _glcpp_parser_skip_stack_change_if (parser, & @1,
303 glcpp_warning(& @1, parser, "ignoring illegal #elif without expression");
306 | HASH_ELSE NEWLINE {
307 _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
309 | HASH_ENDIF NEWLINE {
310 _glcpp_parser_skip_stack_pop (parser, & @1);
312 | HASH_VERSION integer_constant NEWLINE {
313 macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
315 hash_table_remove (parser->defines, "__VERSION__");
318 add_builtin_define (parser, "__VERSION__", $2);
321 add_builtin_define (parser, "GL_ES", 1);
323 /* Currently, all ES2 implementations support highp in the
324 * fragment shader, so we always define this macro in ES2.
325 * If we ever get a driver that doesn't support highp, we'll
326 * need to add a flag to the gl_context and check that here.
328 if ($2 >= 130 || $2 == 100)
329 add_builtin_define (parser, "GL_FRAGMENT_PRECISION_HIGH", 1);
331 glcpp_printf(parser->output, "#version %" PRIiMAX, $2);
338 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
339 $$ = strtoll ($1 + 2, NULL, 16);
340 } else if ($1[0] == '0') {
341 $$ = strtoll ($1, NULL, 8);
343 $$ = strtoll ($1, NULL, 10);
352 | expression OR expression {
355 | expression AND expression {
358 | expression '|' expression {
361 | expression '^' expression {
364 | expression '&' expression {
367 | expression NOT_EQUAL expression {
370 | expression EQUAL expression {
373 | expression GREATER_OR_EQUAL expression {
376 | expression LESS_OR_EQUAL expression {
379 | expression '>' expression {
382 | expression '<' expression {
385 | expression RIGHT_SHIFT expression {
388 | expression LEFT_SHIFT expression {
391 | expression '-' expression {
394 | expression '+' expression {
397 | expression '%' expression {
400 | expression '/' expression {
402 yyerror (& @1, parser,
403 "division by 0 in preprocessor directive");
408 | expression '*' expression {
411 | '!' expression %prec UNARY {
414 | '~' expression %prec UNARY {
417 | '-' expression %prec UNARY {
420 | '+' expression %prec UNARY {
423 | '(' expression ')' {
430 $$ = _string_list_create (parser);
431 _string_list_append_item ($$, $1);
432 talloc_steal ($$, $1);
434 | identifier_list ',' IDENTIFIER {
436 _string_list_append_item ($$, $3);
437 talloc_steal ($$, $3);
442 NEWLINE { $$ = NULL; }
448 yyerror (& @1, parser, "Invalid tokens after #");
453 /* empty */ { $$ = NULL; }
460 glcpp_warning(&@1, parser, "extra tokens at end of directive");
465 /* Handle "defined" operator */
467 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
468 $$ = _token_create_ival (parser, INTEGER, v);
470 | DEFINED '(' IDENTIFIER ')' {
471 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
472 $$ = _token_create_ival (parser, INTEGER, v);
474 | preprocessing_token
478 /* Exactly the same as pp_tokens, but using conditional_token */
480 $$ = _token_list_create (parser);
481 _token_list_append ($$, $1);
482 talloc_unlink (parser, $1);
484 | conditional_tokens conditional_token {
486 _token_list_append ($$, $2);
487 talloc_unlink (parser, $2);
492 preprocessing_token {
493 parser->space_tokens = 1;
494 $$ = _token_list_create (parser);
495 _token_list_append ($$, $1);
496 talloc_unlink (parser, $1);
498 | pp_tokens preprocessing_token {
500 _token_list_append ($$, $2);
501 talloc_unlink (parser, $2);
507 $$ = _token_create_str (parser, IDENTIFIER, $1);
508 $$->location = yylloc;
511 $$ = _token_create_str (parser, INTEGER_STRING, $1);
512 $$->location = yylloc;
515 $$ = _token_create_ival (parser, $1, $1);
516 $$->location = yylloc;
519 $$ = _token_create_str (parser, OTHER, $1);
520 $$->location = yylloc;
523 $$ = _token_create_ival (parser, SPACE, SPACE);
524 $$->location = yylloc;
544 | LEFT_SHIFT { $$ = LEFT_SHIFT; }
545 | RIGHT_SHIFT { $$ = RIGHT_SHIFT; }
548 | LESS_OR_EQUAL { $$ = LESS_OR_EQUAL; }
549 | GREATER_OR_EQUAL { $$ = GREATER_OR_EQUAL; }
550 | EQUAL { $$ = EQUAL; }
551 | NOT_EQUAL { $$ = NOT_EQUAL; }
559 | PASTE { $$ = PASTE; }
565 _string_list_create (void *ctx)
569 list = talloc (ctx, string_list_t);
577 _string_list_append_item (string_list_t *list, const char *str)
581 node = talloc (list, string_node_t);
582 node->str = talloc_strdup (node, str);
586 if (list->head == NULL) {
589 list->tail->next = node;
596 _string_list_contains (string_list_t *list, const char *member, int *index)
604 for (i = 0, node = list->head; node; i++, node = node->next) {
605 if (strcmp (node->str, member) == 0) {
616 _string_list_length (string_list_t *list)
624 for (node = list->head; node; node = node->next)
631 _string_list_equal (string_list_t *a, string_list_t *b)
633 string_node_t *node_a, *node_b;
635 if (a == NULL && b == NULL)
638 if (a == NULL || b == NULL)
641 for (node_a = a->head, node_b = b->head;
643 node_a = node_a->next, node_b = node_b->next)
645 if (strcmp (node_a->str, node_b->str))
649 /* Catch the case of lists being different lengths, (which
650 * would cause the loop above to terminate after the shorter
652 return node_a == node_b;
656 _argument_list_create (void *ctx)
658 argument_list_t *list;
660 list = talloc (ctx, argument_list_t);
668 _argument_list_append (argument_list_t *list, token_list_t *argument)
670 argument_node_t *node;
672 node = talloc (list, argument_node_t);
673 node->argument = argument;
677 if (list->head == NULL) {
680 list->tail->next = node;
687 _argument_list_length (argument_list_t *list)
690 argument_node_t *node;
695 for (node = list->head; node; node = node->next)
702 _argument_list_member_at (argument_list_t *list, int index)
704 argument_node_t *node;
711 for (i = 0; i < index; i++) {
718 return node->argument;
723 /* Note: This function talloc_steal()s the str pointer. */
725 _token_create_str (void *ctx, int type, char *str)
729 token = talloc (ctx, token_t);
731 token->value.str = talloc_steal (token, str);
737 _token_create_ival (void *ctx, int type, int ival)
741 token = talloc (ctx, token_t);
743 token->value.ival = ival;
749 _token_list_create (void *ctx)
753 list = talloc (ctx, token_list_t);
756 list->non_space_tail = NULL;
762 _token_list_append (token_list_t *list, token_t *token)
766 node = talloc (list, token_node_t);
767 node->token = talloc_reference (list, token);
771 if (list->head == NULL) {
774 list->tail->next = node;
778 if (token->type != SPACE)
779 list->non_space_tail = node;
783 _token_list_append_list (token_list_t *list, token_list_t *tail)
785 if (tail == NULL || tail->head == NULL)
788 if (list->head == NULL) {
789 list->head = tail->head;
791 list->tail->next = tail->head;
794 list->tail = tail->tail;
795 list->non_space_tail = tail->non_space_tail;
798 static token_list_t *
799 _token_list_copy (void *ctx, token_list_t *other)
807 copy = _token_list_create (ctx);
808 for (node = other->head; node; node = node->next)
809 _token_list_append (copy, node->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 glcpp_printf (*out, "%c", token->type);
916 switch (token->type) {
918 glcpp_printf (*out, "%" PRIiMAX, token->value.ival);
923 glcpp_print (*out, token->value.str);
926 glcpp_print (*out, " ");
929 glcpp_print (*out, "<<");
932 glcpp_print (*out, ">>");
935 glcpp_print (*out, "<=");
937 case GREATER_OR_EQUAL:
938 glcpp_print (*out, ">=");
941 glcpp_print (*out, "==");
944 glcpp_print (*out, "!=");
947 glcpp_print (*out, "&&");
950 glcpp_print (*out, "||");
953 glcpp_print (*out, "##");
956 glcpp_print (*out, ",");
959 /* Nothing to print. */
962 assert(!"Error: Don't know how to print token.");
967 /* Return a new token (talloc()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 = talloc_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 glcpp_print (parser->info_log, "Pasting \"");
1047 _token_print (&parser->info_log, token);
1048 glcpp_print (parser->info_log, "\" and \"");
1049 _token_print (&parser->info_log, other);
1050 glcpp_print (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);
1085 talloc_unlink(parser, tok);
1089 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1091 glcpp_parser_t *parser;
1092 int language_version;
1094 parser = talloc (NULL, glcpp_parser_t);
1096 glcpp_lex_init_extra (parser, &parser->scanner);
1097 parser->defines = hash_table_ctor (32, hash_table_string_hash,
1098 hash_table_string_compare);
1099 parser->active = NULL;
1100 parser->lexing_if = 0;
1101 parser->space_tokens = 1;
1102 parser->newline_as_space = 0;
1103 parser->in_control_line = 0;
1104 parser->paren_count = 0;
1106 parser->skip_stack = NULL;
1108 parser->lex_from_list = NULL;
1109 parser->lex_from_node = NULL;
1111 parser->output = talloc_strdup(parser, "");
1112 parser->info_log = talloc_strdup(parser, "");
1115 /* Add pre-defined macros. */
1116 add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1117 add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1119 if (api == API_OPENGLES2)
1120 add_builtin_define(parser, "GL_ES", 1);
1122 if (extensions != NULL) {
1123 if (extensions->EXT_texture_array) {
1124 add_builtin_define(parser, "GL_EXT_texture_array", 1);
1127 if (extensions->ARB_fragment_coord_conventions)
1128 add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1131 if (extensions->ARB_explicit_attrib_location)
1132 add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
1135 language_version = 110;
1136 add_builtin_define(parser, "__VERSION__", language_version);
1142 glcpp_parser_parse (glcpp_parser_t *parser)
1144 return yyparse (parser);
1148 glcpp_parser_destroy (glcpp_parser_t *parser)
1150 glcpp_lex_destroy (parser->scanner);
1151 hash_table_dtor (parser->defines);
1152 talloc_free (parser);
1155 typedef enum function_status
1157 FUNCTION_STATUS_SUCCESS,
1158 FUNCTION_NOT_A_FUNCTION,
1159 FUNCTION_UNBALANCED_PARENTHESES
1160 } function_status_t;
1162 /* Find a set of function-like macro arguments by looking for a
1163 * balanced set of parentheses.
1165 * When called, 'node' should be the opening-parenthesis token, (or
1166 * perhaps preceeding SPACE tokens). Upon successful return *last will
1167 * be the last consumed node, (corresponding to the closing right
1172 * FUNCTION_STATUS_SUCCESS:
1174 * Successfully parsed a set of function arguments.
1176 * FUNCTION_NOT_A_FUNCTION:
1178 * Macro name not followed by a '('. This is not an error, but
1179 * simply that the macro name should be treated as a non-macro.
1181 * FUNCTION_UNBALANCED_PARENTHESES
1183 * Macro name is not followed by a balanced set of parentheses.
1185 static function_status_t
1186 _arguments_parse (argument_list_t *arguments,
1188 token_node_t **last)
1190 token_list_t *argument;
1195 /* Ignore whitespace before first parenthesis. */
1196 while (node && node->token->type == SPACE)
1199 if (node == NULL || node->token->type != '(')
1200 return FUNCTION_NOT_A_FUNCTION;
1204 argument = _token_list_create (arguments);
1205 _argument_list_append (arguments, argument);
1207 for (paren_count = 1; node; node = node->next) {
1208 if (node->token->type == '(')
1212 else if (node->token->type == ')')
1215 if (paren_count == 0)
1219 if (node->token->type == ',' &&
1222 _token_list_trim_trailing_space (argument);
1223 argument = _token_list_create (arguments);
1224 _argument_list_append (arguments, argument);
1227 if (argument->head == NULL) {
1228 /* Don't treat initial whitespace as
1229 * part of the arguement. */
1230 if (node->token->type == SPACE)
1233 _token_list_append (argument, node->token);
1238 return FUNCTION_UNBALANCED_PARENTHESES;
1242 return FUNCTION_STATUS_SUCCESS;
1245 static token_list_t *
1246 _token_list_create_with_one_space (void *ctx)
1251 list = _token_list_create (ctx);
1252 space = _token_create_ival (list, SPACE, SPACE);
1253 _token_list_append (list, space);
1259 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list)
1261 token_list_t *expanded;
1264 expanded = _token_list_create (parser);
1265 token = _token_create_ival (parser, type, type);
1266 _token_list_append (expanded, token);
1267 _glcpp_parser_expand_token_list (parser, list);
1268 _token_list_append_list (expanded, list);
1269 glcpp_parser_lex_from (parser, expanded);
1272 /* This is a helper function that's essentially part of the
1273 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1274 * except for by that function.
1276 * Returns NULL if node is a simple token with no expansion, (that is,
1277 * although 'node' corresponds to an identifier defined as a
1278 * function-like macro, it is not followed with a parenthesized
1281 * Compute the complete expansion of node (which is a function-like
1282 * macro) and subsequent nodes which are arguments.
1284 * Returns the token list that results from the expansion and sets
1285 * *last to the last node in the list that was consumed by the
1286 * expansion. Specifically, *last will be set as follows: as the
1287 * token of the closing right parenthesis.
1289 static token_list_t *
1290 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1292 token_node_t **last)
1296 const char *identifier;
1297 argument_list_t *arguments;
1298 function_status_t status;
1299 token_list_t *substituted;
1300 int parameter_index;
1302 identifier = node->token->value.str;
1304 macro = hash_table_find (parser->defines, identifier);
1306 assert (macro->is_function);
1308 arguments = _argument_list_create (parser);
1309 status = _arguments_parse (arguments, node, last);
1312 case FUNCTION_STATUS_SUCCESS:
1314 case FUNCTION_NOT_A_FUNCTION:
1316 case FUNCTION_UNBALANCED_PARENTHESES:
1317 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1321 /* Replace a macro defined as empty with a SPACE token. */
1322 if (macro->replacements == NULL) {
1323 talloc_free (arguments);
1324 return _token_list_create_with_one_space (parser);
1327 if (! ((_argument_list_length (arguments) ==
1328 _string_list_length (macro->parameters)) ||
1329 (_string_list_length (macro->parameters) == 0 &&
1330 _argument_list_length (arguments) == 1 &&
1331 arguments->head->argument->head == NULL)))
1333 glcpp_error (&node->token->location, parser,
1334 "Error: macro %s invoked with %d arguments (expected %d)\n",
1336 _argument_list_length (arguments),
1337 _string_list_length (macro->parameters));
1341 /* Perform argument substitution on the replacement list. */
1342 substituted = _token_list_create (arguments);
1344 for (node = macro->replacements->head; node; node = node->next)
1346 if (node->token->type == IDENTIFIER &&
1347 _string_list_contains (macro->parameters,
1348 node->token->value.str,
1351 token_list_t *argument;
1352 argument = _argument_list_member_at (arguments,
1354 /* Before substituting, we expand the argument
1355 * tokens, or append a placeholder token for
1356 * an empty argument. */
1357 if (argument->head) {
1358 token_list_t *expanded_argument;
1359 expanded_argument = _token_list_copy (parser,
1361 _glcpp_parser_expand_token_list (parser,
1363 _token_list_append_list (substituted,
1368 new_token = _token_create_ival (substituted,
1371 _token_list_append (substituted, new_token);
1374 _token_list_append (substituted, node->token);
1378 /* After argument substitution, and before further expansion
1379 * below, implement token pasting. */
1381 _token_list_trim_trailing_space (substituted);
1383 node = substituted->head;
1386 token_node_t *next_non_space;
1388 /* Look ahead for a PASTE token, skipping space. */
1389 next_non_space = node->next;
1390 while (next_non_space && next_non_space->token->type == SPACE)
1391 next_non_space = next_non_space->next;
1393 if (next_non_space == NULL)
1396 if (next_non_space->token->type != PASTE) {
1397 node = next_non_space;
1401 /* Now find the next non-space token after the PASTE. */
1402 next_non_space = next_non_space->next;
1403 while (next_non_space && next_non_space->token->type == SPACE)
1404 next_non_space = next_non_space->next;
1406 if (next_non_space == NULL) {
1407 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1411 node->token = _token_paste (parser, node->token, next_non_space->token);
1412 node->next = next_non_space->next;
1413 if (next_non_space == substituted->tail)
1414 substituted->tail = node;
1419 substituted->non_space_tail = substituted->tail;
1424 /* Compute the complete expansion of node, (and subsequent nodes after
1425 * 'node' in the case that 'node' is a function-like macro and
1426 * subsequent nodes are arguments).
1428 * Returns NULL if node is a simple token with no expansion.
1430 * Otherwise, returns the token list that results from the expansion
1431 * and sets *last to the last node in the list that was consumed by
1432 * the expansion. Specifically, *last will be set as follows:
1434 * As 'node' in the case of object-like macro expansion.
1436 * As the token of the closing right parenthesis in the case of
1437 * function-like macro expansion.
1439 static token_list_t *
1440 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1442 token_node_t **last)
1444 token_t *token = node->token;
1445 const char *identifier;
1448 /* We only expand identifiers */
1449 if (token->type != IDENTIFIER) {
1450 /* We change any COMMA into a COMMA_FINAL to prevent
1451 * it being mistaken for an argument separator
1453 if (token->type == ',') {
1454 token->type = COMMA_FINAL;
1455 token->value.ival = COMMA_FINAL;
1461 /* Look up this identifier in the hash table. */
1462 identifier = token->value.str;
1463 macro = hash_table_find (parser->defines, identifier);
1465 /* Not a macro, so no expansion needed. */
1469 /* Finally, don't expand this macro if we're already actively
1470 * expanding it, (to avoid infinite recursion). */
1471 if (_active_list_contains (parser->active, identifier)) {
1472 /* We change the token type here from IDENTIFIER to
1473 * OTHER to prevent any future expansion of this
1474 * unexpanded token. */
1476 token_list_t *expansion;
1479 str = talloc_strdup (parser, token->value.str);
1480 final = _token_create_str (parser, OTHER, str);
1481 expansion = _token_list_create (parser);
1482 _token_list_append (expansion, final);
1487 if (! macro->is_function)
1491 /* Replace a macro defined as empty with a SPACE token. */
1492 if (macro->replacements == NULL)
1493 return _token_list_create_with_one_space (parser);
1495 return _token_list_copy (parser, macro->replacements);
1498 return _glcpp_parser_expand_function (parser, node, last);
1501 /* Push a new identifier onto the active list, returning the new list.
1503 * Here, 'marker' is the token node that appears in the list after the
1504 * expansion of 'identifier'. That is, when the list iterator begins
1505 * examinging 'marker', then it is time to pop this node from the
1509 _active_list_push (active_list_t *list,
1510 const char *identifier,
1511 token_node_t *marker)
1513 active_list_t *node;
1515 node = talloc (list, active_list_t);
1516 node->identifier = talloc_strdup (node, identifier);
1517 node->marker = marker;
1524 _active_list_pop (active_list_t *list)
1526 active_list_t *node = list;
1538 _active_list_contains (active_list_t *list, const char *identifier)
1540 active_list_t *node;
1545 for (node = list; node; node = node->next)
1546 if (strcmp (node->identifier, identifier) == 0)
1552 /* Walk over the token list replacing nodes with their expansion.
1553 * Whenever nodes are expanded the walking will walk over the new
1554 * nodes, continuing to expand as necessary. The results are placed in
1558 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1561 token_node_t *node_prev;
1562 token_node_t *node, *last = NULL;
1563 token_list_t *expansion;
1568 _token_list_trim_trailing_space (list);
1575 while (parser->active && parser->active->marker == node)
1576 parser->active = _active_list_pop (parser->active);
1578 /* Find the expansion for node, which will replace all
1579 * nodes from node to last, inclusive. */
1580 expansion = _glcpp_parser_expand_node (parser, node, &last);
1584 for (n = node; n != last->next; n = n->next)
1585 while (parser->active &&
1586 parser->active->marker == n)
1588 parser->active = _active_list_pop (parser->active);
1591 parser->active = _active_list_push (parser->active,
1592 node->token->value.str,
1595 /* Splice expansion into list, supporting a
1596 * simple deletion if the expansion is
1598 if (expansion->head) {
1600 node_prev->next = expansion->head;
1602 list->head = expansion->head;
1603 expansion->tail->next = last->next;
1604 if (last == list->tail)
1605 list->tail = expansion->tail;
1608 node_prev->next = last->next;
1610 list->head = last->next;
1611 if (last == list->tail)
1617 node = node_prev ? node_prev->next : list->head;
1620 while (parser->active)
1621 parser->active = _active_list_pop (parser->active);
1623 list->non_space_tail = list->tail;
1627 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1633 _glcpp_parser_expand_token_list (parser, list);
1635 _token_list_trim_trailing_space (list);
1637 _token_list_print (parser, list);
1641 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1642 const char *identifier)
1644 /* According to the GLSL specification, macro names starting with "__"
1645 * or "GL_" are reserved for future use. So, don't allow them.
1647 if (strncmp(identifier, "__", 2) == 0) {
1648 glcpp_error (loc, parser, "Macro names starting with \"__\" are reserved.\n");
1650 if (strncmp(identifier, "GL_", 3) == 0) {
1651 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1656 _macro_equal (macro_t *a, macro_t *b)
1658 if (a->is_function != b->is_function)
1661 if (a->is_function) {
1662 if (! _string_list_equal (a->parameters, b->parameters))
1666 return _token_list_equal_ignoring_space (a->replacements,
1671 _define_object_macro (glcpp_parser_t *parser,
1673 const char *identifier,
1674 token_list_t *replacements)
1676 macro_t *macro, *previous;
1679 _check_for_reserved_macro_name(parser, loc, identifier);
1681 macro = talloc (parser, macro_t);
1683 macro->is_function = 0;
1684 macro->parameters = NULL;
1685 macro->identifier = talloc_strdup (macro, identifier);
1686 macro->replacements = talloc_steal (macro, replacements);
1688 previous = hash_table_find (parser->defines, identifier);
1690 if (_macro_equal (macro, previous)) {
1691 talloc_free (macro);
1694 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1698 hash_table_insert (parser->defines, macro, identifier);
1702 _define_function_macro (glcpp_parser_t *parser,
1704 const char *identifier,
1705 string_list_t *parameters,
1706 token_list_t *replacements)
1708 macro_t *macro, *previous;
1710 _check_for_reserved_macro_name(parser, loc, identifier);
1712 macro = talloc (parser, macro_t);
1714 macro->is_function = 1;
1715 macro->parameters = talloc_steal (macro, parameters);
1716 macro->identifier = talloc_strdup (macro, identifier);
1717 macro->replacements = talloc_steal (macro, replacements);
1719 previous = hash_table_find (parser->defines, identifier);
1721 if (_macro_equal (macro, previous)) {
1722 talloc_free (macro);
1725 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1729 hash_table_insert (parser->defines, macro, identifier);
1733 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1738 if (parser->lex_from_list == NULL) {
1739 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1741 /* XXX: This ugly block of code exists for the sole
1742 * purpose of converting a NEWLINE token into a SPACE
1743 * token, but only in the case where we have seen a
1744 * function-like macro name, but have not yet seen its
1745 * closing parenthesis.
1747 * There's perhaps a more compact way to do this with
1748 * mid-rule actions in the grammar.
1750 * I'm definitely not pleased with the complexity of
1753 if (parser->newline_as_space)
1756 parser->paren_count++;
1757 } else if (ret == ')') {
1758 parser->paren_count--;
1759 if (parser->paren_count == 0)
1760 parser->newline_as_space = 0;
1761 } else if (ret == NEWLINE) {
1763 } else if (ret != SPACE) {
1764 if (parser->paren_count == 0)
1765 parser->newline_as_space = 0;
1768 else if (parser->in_control_line)
1771 parser->in_control_line = 0;
1773 else if (ret == HASH_DEFINE_OBJ || ret == HASH_DEFINE_FUNC ||
1774 ret == HASH_UNDEF || ret == HASH_IF ||
1775 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1776 ret == HASH_ELIF || ret == HASH_ELSE ||
1777 ret == HASH_ENDIF || ret == HASH)
1779 parser->in_control_line = 1;
1781 else if (ret == IDENTIFIER)
1784 macro = hash_table_find (parser->defines,
1786 if (macro && macro->is_function) {
1787 parser->newline_as_space = 1;
1788 parser->paren_count = 0;
1795 node = parser->lex_from_node;
1798 talloc_free (parser->lex_from_list);
1799 parser->lex_from_list = NULL;
1803 *yylval = node->token->value;
1804 ret = node->token->type;
1806 parser->lex_from_node = node->next;
1812 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1816 assert (parser->lex_from_list == NULL);
1818 /* Copy list, eliminating any space tokens. */
1819 parser->lex_from_list = _token_list_create (parser);
1821 for (node = list->head; node; node = node->next) {
1822 if (node->token->type == SPACE)
1824 _token_list_append (parser->lex_from_list, node->token);
1829 parser->lex_from_node = parser->lex_from_list->head;
1831 /* It's possible the list consisted of nothing but whitespace. */
1832 if (parser->lex_from_node == NULL) {
1833 talloc_free (parser->lex_from_list);
1834 parser->lex_from_list = NULL;
1839 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1842 skip_type_t current = SKIP_NO_SKIP;
1845 if (parser->skip_stack)
1846 current = parser->skip_stack->type;
1848 node = talloc (parser, skip_node_t);
1851 if (current == SKIP_NO_SKIP) {
1853 node->type = SKIP_NO_SKIP;
1855 node->type = SKIP_TO_ELSE;
1857 node->type = SKIP_TO_ENDIF;
1860 node->next = parser->skip_stack;
1861 parser->skip_stack = node;
1865 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
1866 const char *type, int condition)
1868 if (parser->skip_stack == NULL) {
1869 glcpp_error (loc, parser, "%s without #if\n", type);
1873 if (parser->skip_stack->type == SKIP_TO_ELSE) {
1875 parser->skip_stack->type = SKIP_NO_SKIP;
1877 parser->skip_stack->type = SKIP_TO_ENDIF;
1882 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
1886 if (parser->skip_stack == NULL) {
1887 glcpp_error (loc, parser, "#endif without #if\n");
1891 node = parser->skip_stack;
1892 parser->skip_stack = node->next;