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 {
314 add_builtin_define (parser, "GL_ES", 1);
316 macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
318 hash_table_remove (parser->defines, "__VERSION__");
321 add_builtin_define (parser, "__VERSION__", $2);
322 glcpp_printf(parser->output, "#version %" PRIiMAX, $2);
329 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
330 $$ = strtoll ($1 + 2, NULL, 16);
331 } else if ($1[0] == '0') {
332 $$ = strtoll ($1, NULL, 8);
334 $$ = strtoll ($1, NULL, 10);
343 | expression OR expression {
346 | expression AND expression {
349 | expression '|' expression {
352 | expression '^' expression {
355 | expression '&' expression {
358 | expression NOT_EQUAL expression {
361 | expression EQUAL expression {
364 | expression GREATER_OR_EQUAL expression {
367 | expression LESS_OR_EQUAL expression {
370 | expression '>' expression {
373 | expression '<' expression {
376 | expression RIGHT_SHIFT expression {
379 | expression LEFT_SHIFT expression {
382 | expression '-' expression {
385 | expression '+' expression {
388 | expression '%' expression {
391 | expression '/' expression {
394 | expression '*' expression {
397 | '!' expression %prec UNARY {
400 | '~' expression %prec UNARY {
403 | '-' expression %prec UNARY {
406 | '+' expression %prec UNARY {
409 | '(' expression ')' {
416 $$ = _string_list_create (parser);
417 _string_list_append_item ($$, $1);
418 talloc_steal ($$, $1);
420 | identifier_list ',' IDENTIFIER {
422 _string_list_append_item ($$, $3);
423 talloc_steal ($$, $3);
428 NEWLINE { $$ = NULL; }
434 yyerror (& @1, parser, "Invalid tokens after #");
439 /* empty */ { $$ = NULL; }
446 glcpp_warning(&@1, parser, "extra tokens at end of directive");
451 /* Handle "defined" operator */
453 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
454 $$ = _token_create_ival (parser, INTEGER, v);
456 | DEFINED '(' IDENTIFIER ')' {
457 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
458 $$ = _token_create_ival (parser, INTEGER, v);
460 | preprocessing_token
464 /* Exactly the same as pp_tokens, but using conditional_token */
466 parser->space_tokens = 1;
467 $$ = _token_list_create (parser);
468 _token_list_append ($$, $1);
469 talloc_unlink (parser, $1);
471 | conditional_tokens conditional_token {
473 _token_list_append ($$, $2);
474 talloc_unlink (parser, $2);
479 preprocessing_token {
480 parser->space_tokens = 1;
481 $$ = _token_list_create (parser);
482 _token_list_append ($$, $1);
483 talloc_unlink (parser, $1);
485 | pp_tokens preprocessing_token {
487 _token_list_append ($$, $2);
488 talloc_unlink (parser, $2);
494 $$ = _token_create_str (parser, IDENTIFIER, $1);
495 $$->location = yylloc;
498 $$ = _token_create_str (parser, INTEGER_STRING, $1);
499 $$->location = yylloc;
502 $$ = _token_create_ival (parser, $1, $1);
503 $$->location = yylloc;
506 $$ = _token_create_str (parser, OTHER, $1);
507 $$->location = yylloc;
510 $$ = _token_create_ival (parser, SPACE, SPACE);
511 $$->location = yylloc;
531 | LEFT_SHIFT { $$ = LEFT_SHIFT; }
532 | RIGHT_SHIFT { $$ = RIGHT_SHIFT; }
535 | LESS_OR_EQUAL { $$ = LESS_OR_EQUAL; }
536 | GREATER_OR_EQUAL { $$ = GREATER_OR_EQUAL; }
537 | EQUAL { $$ = EQUAL; }
538 | NOT_EQUAL { $$ = NOT_EQUAL; }
546 | PASTE { $$ = PASTE; }
552 _string_list_create (void *ctx)
556 list = talloc (ctx, string_list_t);
564 _string_list_append_item (string_list_t *list, const char *str)
568 node = talloc (list, string_node_t);
569 node->str = talloc_strdup (node, str);
573 if (list->head == NULL) {
576 list->tail->next = node;
583 _string_list_contains (string_list_t *list, const char *member, int *index)
591 for (i = 0, node = list->head; node; i++, node = node->next) {
592 if (strcmp (node->str, member) == 0) {
603 _string_list_length (string_list_t *list)
611 for (node = list->head; node; node = node->next)
618 _string_list_equal (string_list_t *a, string_list_t *b)
620 string_node_t *node_a, *node_b;
622 if (a == NULL && b == NULL)
625 if (a == NULL || b == NULL)
628 for (node_a = a->head, node_b = b->head;
630 node_a = node_a->next, node_b = node_b->next)
632 if (strcmp (node_a->str, node_b->str))
636 /* Catch the case of lists being different lengths, (which
637 * would cause the loop above to terminate after the shorter
639 return node_a == node_b;
643 _argument_list_create (void *ctx)
645 argument_list_t *list;
647 list = talloc (ctx, argument_list_t);
655 _argument_list_append (argument_list_t *list, token_list_t *argument)
657 argument_node_t *node;
659 node = talloc (list, argument_node_t);
660 node->argument = argument;
664 if (list->head == NULL) {
667 list->tail->next = node;
674 _argument_list_length (argument_list_t *list)
677 argument_node_t *node;
682 for (node = list->head; node; node = node->next)
689 _argument_list_member_at (argument_list_t *list, int index)
691 argument_node_t *node;
698 for (i = 0; i < index; i++) {
705 return node->argument;
710 /* Note: This function talloc_steal()s the str pointer. */
712 _token_create_str (void *ctx, int type, char *str)
716 token = talloc (ctx, token_t);
718 token->value.str = talloc_steal (token, str);
724 _token_create_ival (void *ctx, int type, int ival)
728 token = talloc (ctx, token_t);
730 token->value.ival = ival;
736 _token_list_create (void *ctx)
740 list = talloc (ctx, token_list_t);
743 list->non_space_tail = NULL;
749 _token_list_append (token_list_t *list, token_t *token)
753 node = talloc (list, token_node_t);
754 node->token = talloc_reference (list, token);
758 if (list->head == NULL) {
761 list->tail->next = node;
765 if (token->type != SPACE)
766 list->non_space_tail = node;
770 _token_list_append_list (token_list_t *list, token_list_t *tail)
772 if (tail == NULL || tail->head == NULL)
775 if (list->head == NULL) {
776 list->head = tail->head;
778 list->tail->next = tail->head;
781 list->tail = tail->tail;
782 list->non_space_tail = tail->non_space_tail;
785 static token_list_t *
786 _token_list_copy (void *ctx, token_list_t *other)
794 copy = _token_list_create (ctx);
795 for (node = other->head; node; node = node->next)
796 _token_list_append (copy, node->token);
802 _token_list_trim_trailing_space (token_list_t *list)
804 token_node_t *tail, *next;
806 if (list->non_space_tail) {
807 tail = list->non_space_tail->next;
808 list->non_space_tail->next = NULL;
809 list->tail = list->non_space_tail;
820 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
822 token_node_t *node_a, *node_b;
829 if (node_a == NULL && node_b == NULL)
832 if (node_a == NULL || node_b == NULL)
835 if (node_a->token->type == SPACE) {
836 node_a = node_a->next;
840 if (node_b->token->type == SPACE) {
841 node_b = node_b->next;
845 if (node_a->token->type != node_b->token->type)
848 switch (node_a->token->type) {
850 if (node_a->token->value.ival !=
851 node_b->token->value.ival)
859 if (strcmp (node_a->token->value.str,
860 node_b->token->value.str))
867 node_a = node_a->next;
868 node_b = node_b->next;
875 _token_print (char **out, token_t *token)
877 if (token->type < 256) {
878 glcpp_printf (*out, "%c", token->type);
882 switch (token->type) {
884 glcpp_printf (*out, "%" PRIiMAX, token->value.ival);
889 glcpp_print (*out, token->value.str);
892 glcpp_print (*out, " ");
895 glcpp_print (*out, "<<");
898 glcpp_print (*out, ">>");
901 glcpp_print (*out, "<=");
903 case GREATER_OR_EQUAL:
904 glcpp_print (*out, ">=");
907 glcpp_print (*out, "==");
910 glcpp_print (*out, "!=");
913 glcpp_print (*out, "&&");
916 glcpp_print (*out, "||");
919 glcpp_print (*out, "##");
922 glcpp_print (*out, ",");
925 /* Nothing to print. */
928 assert(!"Error: Don't know how to print token.");
933 /* Return a new token (talloc()ed off of 'token') formed by pasting
934 * 'token' and 'other'. Note that this function may return 'token' or
935 * 'other' directly rather than allocating anything new.
937 * Caution: Only very cursory error-checking is performed to see if
938 * the final result is a valid single token. */
940 _token_paste (glcpp_parser_t *parser, token_t *token, token_t *other)
942 token_t *combined = NULL;
944 /* Pasting a placeholder onto anything makes no change. */
945 if (other->type == PLACEHOLDER)
948 /* When 'token' is a placeholder, just return 'other'. */
949 if (token->type == PLACEHOLDER)
952 /* A very few single-character punctuators can be combined
953 * with another to form a multi-character punctuator. */
954 switch (token->type) {
956 if (other->type == '<')
957 combined = _token_create_ival (token, LEFT_SHIFT, LEFT_SHIFT);
958 else if (other->type == '=')
959 combined = _token_create_ival (token, LESS_OR_EQUAL, LESS_OR_EQUAL);
962 if (other->type == '>')
963 combined = _token_create_ival (token, RIGHT_SHIFT, RIGHT_SHIFT);
964 else if (other->type == '=')
965 combined = _token_create_ival (token, GREATER_OR_EQUAL, GREATER_OR_EQUAL);
968 if (other->type == '=')
969 combined = _token_create_ival (token, EQUAL, EQUAL);
972 if (other->type == '=')
973 combined = _token_create_ival (token, NOT_EQUAL, NOT_EQUAL);
976 if (other->type == '&')
977 combined = _token_create_ival (token, AND, AND);
980 if (other->type == '|')
981 combined = _token_create_ival (token, OR, OR);
985 if (combined != NULL) {
986 /* Inherit the location from the first token */
987 combined->location = token->location;
991 /* Two string-valued tokens can usually just be mashed
994 * XXX: This isn't actually legitimate. Several things here
995 * should result in a diagnostic since the result cannot be a
996 * valid, single pre-processing token. For example, pasting
997 * "123" and "abc" is not legal, but we don't catch that
999 if ((token->type == IDENTIFIER || token->type == OTHER || token->type == INTEGER_STRING) &&
1000 (other->type == IDENTIFIER || other->type == OTHER || other->type == INTEGER_STRING))
1004 str = talloc_asprintf (token, "%s%s", token->value.str,
1006 combined = _token_create_str (token, token->type, str);
1007 combined->location = token->location;
1011 glcpp_error (&token->location, parser, "");
1012 glcpp_print (parser->info_log, "Pasting \"");
1013 _token_print (&parser->info_log, token);
1014 glcpp_print (parser->info_log, "\" and \"");
1015 _token_print (&parser->info_log, other);
1016 glcpp_print (parser->info_log, "\" does not give a valid preprocessing token.\n");
1022 _token_list_print (glcpp_parser_t *parser, token_list_t *list)
1029 for (node = list->head; node; node = node->next)
1030 _token_print (&parser->output, node->token);
1034 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error)
1036 glcpp_error(locp, parser, "%s", error);
1039 static void add_builtin_define(glcpp_parser_t *parser,
1040 const char *name, int value)
1045 tok = _token_create_ival (parser, INTEGER, value);
1047 list = _token_list_create(parser);
1048 _token_list_append(list, tok);
1049 _define_object_macro(parser, NULL, name, list);
1051 talloc_unlink(parser, tok);
1055 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1057 glcpp_parser_t *parser;
1058 int language_version;
1060 parser = talloc (NULL, glcpp_parser_t);
1062 glcpp_lex_init_extra (parser, &parser->scanner);
1063 parser->defines = hash_table_ctor (32, hash_table_string_hash,
1064 hash_table_string_compare);
1065 parser->active = NULL;
1066 parser->lexing_if = 0;
1067 parser->space_tokens = 1;
1068 parser->newline_as_space = 0;
1069 parser->in_control_line = 0;
1070 parser->paren_count = 0;
1072 parser->skip_stack = NULL;
1074 parser->lex_from_list = NULL;
1075 parser->lex_from_node = NULL;
1077 parser->output = talloc_strdup(parser, "");
1078 parser->info_log = talloc_strdup(parser, "");
1081 /* Add pre-defined macros. */
1082 add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1083 add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1085 if (api == API_OPENGLES2)
1086 add_builtin_define(parser, "GL_ES", 1);
1088 if (extensions != NULL) {
1089 if (extensions->EXT_texture_array) {
1090 add_builtin_define(parser, "GL_EXT_texture_array", 1);
1093 if (extensions->ARB_fragment_coord_conventions)
1094 add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1098 language_version = 110;
1099 add_builtin_define(parser, "__VERSION__", language_version);
1105 glcpp_parser_parse (glcpp_parser_t *parser)
1107 return yyparse (parser);
1111 glcpp_parser_destroy (glcpp_parser_t *parser)
1113 glcpp_lex_destroy (parser->scanner);
1114 hash_table_dtor (parser->defines);
1115 talloc_free (parser);
1118 typedef enum function_status
1120 FUNCTION_STATUS_SUCCESS,
1121 FUNCTION_NOT_A_FUNCTION,
1122 FUNCTION_UNBALANCED_PARENTHESES
1123 } function_status_t;
1125 /* Find a set of function-like macro arguments by looking for a
1126 * balanced set of parentheses.
1128 * When called, 'node' should be the opening-parenthesis token, (or
1129 * perhaps preceeding SPACE tokens). Upon successful return *last will
1130 * be the last consumed node, (corresponding to the closing right
1135 * FUNCTION_STATUS_SUCCESS:
1137 * Successfully parsed a set of function arguments.
1139 * FUNCTION_NOT_A_FUNCTION:
1141 * Macro name not followed by a '('. This is not an error, but
1142 * simply that the macro name should be treated as a non-macro.
1144 * FUNCTION_UNBALANCED_PARENTHESES
1146 * Macro name is not followed by a balanced set of parentheses.
1148 static function_status_t
1149 _arguments_parse (argument_list_t *arguments,
1151 token_node_t **last)
1153 token_list_t *argument;
1158 /* Ignore whitespace before first parenthesis. */
1159 while (node && node->token->type == SPACE)
1162 if (node == NULL || node->token->type != '(')
1163 return FUNCTION_NOT_A_FUNCTION;
1167 argument = _token_list_create (arguments);
1168 _argument_list_append (arguments, argument);
1170 for (paren_count = 1; node; node = node->next) {
1171 if (node->token->type == '(')
1175 else if (node->token->type == ')')
1178 if (paren_count == 0)
1182 if (node->token->type == ',' &&
1185 _token_list_trim_trailing_space (argument);
1186 argument = _token_list_create (arguments);
1187 _argument_list_append (arguments, argument);
1190 if (argument->head == NULL) {
1191 /* Don't treat initial whitespace as
1192 * part of the arguement. */
1193 if (node->token->type == SPACE)
1196 _token_list_append (argument, node->token);
1201 return FUNCTION_UNBALANCED_PARENTHESES;
1205 return FUNCTION_STATUS_SUCCESS;
1208 static token_list_t *
1209 _token_list_create_with_one_space (void *ctx)
1214 list = _token_list_create (ctx);
1215 space = _token_create_ival (list, SPACE, SPACE);
1216 _token_list_append (list, space);
1222 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list)
1224 token_list_t *expanded;
1227 expanded = _token_list_create (parser);
1228 token = _token_create_ival (parser, type, type);
1229 _token_list_append (expanded, token);
1230 _glcpp_parser_expand_token_list (parser, list);
1231 _token_list_append_list (expanded, list);
1232 glcpp_parser_lex_from (parser, expanded);
1235 /* This is a helper function that's essentially part of the
1236 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1237 * except for by that function.
1239 * Returns NULL if node is a simple token with no expansion, (that is,
1240 * although 'node' corresponds to an identifier defined as a
1241 * function-like macro, it is not followed with a parenthesized
1244 * Compute the complete expansion of node (which is a function-like
1245 * macro) and subsequent nodes which are arguments.
1247 * Returns the token list that results from the expansion and sets
1248 * *last to the last node in the list that was consumed by the
1249 * expansion. Specifically, *last will be set as follows: as the
1250 * token of the closing right parenthesis.
1252 static token_list_t *
1253 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1255 token_node_t **last)
1259 const char *identifier;
1260 argument_list_t *arguments;
1261 function_status_t status;
1262 token_list_t *substituted;
1263 int parameter_index;
1265 identifier = node->token->value.str;
1267 macro = hash_table_find (parser->defines, identifier);
1269 assert (macro->is_function);
1271 arguments = _argument_list_create (parser);
1272 status = _arguments_parse (arguments, node, last);
1275 case FUNCTION_STATUS_SUCCESS:
1277 case FUNCTION_NOT_A_FUNCTION:
1279 case FUNCTION_UNBALANCED_PARENTHESES:
1280 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1284 /* Replace a macro defined as empty with a SPACE token. */
1285 if (macro->replacements == NULL) {
1286 talloc_free (arguments);
1287 return _token_list_create_with_one_space (parser);
1290 if (! ((_argument_list_length (arguments) ==
1291 _string_list_length (macro->parameters)) ||
1292 (_string_list_length (macro->parameters) == 0 &&
1293 _argument_list_length (arguments) == 1 &&
1294 arguments->head->argument->head == NULL)))
1296 glcpp_error (&node->token->location, parser,
1297 "Error: macro %s invoked with %d arguments (expected %d)\n",
1299 _argument_list_length (arguments),
1300 _string_list_length (macro->parameters));
1304 /* Perform argument substitution on the replacement list. */
1305 substituted = _token_list_create (arguments);
1307 for (node = macro->replacements->head; node; node = node->next)
1309 if (node->token->type == IDENTIFIER &&
1310 _string_list_contains (macro->parameters,
1311 node->token->value.str,
1314 token_list_t *argument;
1315 argument = _argument_list_member_at (arguments,
1317 /* Before substituting, we expand the argument
1318 * tokens, or append a placeholder token for
1319 * an empty argument. */
1320 if (argument->head) {
1321 token_list_t *expanded_argument;
1322 expanded_argument = _token_list_copy (parser,
1324 _glcpp_parser_expand_token_list (parser,
1326 _token_list_append_list (substituted,
1331 new_token = _token_create_ival (substituted,
1334 _token_list_append (substituted, new_token);
1337 _token_list_append (substituted, node->token);
1341 /* After argument substitution, and before further expansion
1342 * below, implement token pasting. */
1344 _token_list_trim_trailing_space (substituted);
1346 node = substituted->head;
1349 token_node_t *next_non_space;
1351 /* Look ahead for a PASTE token, skipping space. */
1352 next_non_space = node->next;
1353 while (next_non_space && next_non_space->token->type == SPACE)
1354 next_non_space = next_non_space->next;
1356 if (next_non_space == NULL)
1359 if (next_non_space->token->type != PASTE) {
1360 node = next_non_space;
1364 /* Now find the next non-space token after the PASTE. */
1365 next_non_space = next_non_space->next;
1366 while (next_non_space && next_non_space->token->type == SPACE)
1367 next_non_space = next_non_space->next;
1369 if (next_non_space == NULL) {
1370 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1374 node->token = _token_paste (parser, node->token, next_non_space->token);
1375 node->next = next_non_space->next;
1376 if (next_non_space == substituted->tail)
1377 substituted->tail = node;
1382 substituted->non_space_tail = substituted->tail;
1387 /* Compute the complete expansion of node, (and subsequent nodes after
1388 * 'node' in the case that 'node' is a function-like macro and
1389 * subsequent nodes are arguments).
1391 * Returns NULL if node is a simple token with no expansion.
1393 * Otherwise, returns the token list that results from the expansion
1394 * and sets *last to the last node in the list that was consumed by
1395 * the expansion. Specifically, *last will be set as follows:
1397 * As 'node' in the case of object-like macro expansion.
1399 * As the token of the closing right parenthesis in the case of
1400 * function-like macro expansion.
1402 static token_list_t *
1403 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1405 token_node_t **last)
1407 token_t *token = node->token;
1408 const char *identifier;
1411 /* We only expand identifiers */
1412 if (token->type != IDENTIFIER) {
1413 /* We change any COMMA into a COMMA_FINAL to prevent
1414 * it being mistaken for an argument separator
1416 if (token->type == ',') {
1417 token->type = COMMA_FINAL;
1418 token->value.ival = COMMA_FINAL;
1424 /* Look up this identifier in the hash table. */
1425 identifier = token->value.str;
1426 macro = hash_table_find (parser->defines, identifier);
1428 /* Not a macro, so no expansion needed. */
1432 /* Finally, don't expand this macro if we're already actively
1433 * expanding it, (to avoid infinite recursion). */
1434 if (_active_list_contains (parser->active, identifier)) {
1435 /* We change the token type here from IDENTIFIER to
1436 * OTHER to prevent any future expansion of this
1437 * unexpanded token. */
1439 token_list_t *expansion;
1442 str = talloc_strdup (parser, token->value.str);
1443 final = _token_create_str (parser, OTHER, str);
1444 expansion = _token_list_create (parser);
1445 _token_list_append (expansion, final);
1450 if (! macro->is_function)
1454 /* Replace a macro defined as empty with a SPACE token. */
1455 if (macro->replacements == NULL)
1456 return _token_list_create_with_one_space (parser);
1458 return _token_list_copy (parser, macro->replacements);
1461 return _glcpp_parser_expand_function (parser, node, last);
1464 /* Push a new identifier onto the active list, returning the new list.
1466 * Here, 'marker' is the token node that appears in the list after the
1467 * expansion of 'identifier'. That is, when the list iterator begins
1468 * examinging 'marker', then it is time to pop this node from the
1472 _active_list_push (active_list_t *list,
1473 const char *identifier,
1474 token_node_t *marker)
1476 active_list_t *node;
1478 node = talloc (list, active_list_t);
1479 node->identifier = talloc_strdup (node, identifier);
1480 node->marker = marker;
1487 _active_list_pop (active_list_t *list)
1489 active_list_t *node = list;
1501 _active_list_contains (active_list_t *list, const char *identifier)
1503 active_list_t *node;
1508 for (node = list; node; node = node->next)
1509 if (strcmp (node->identifier, identifier) == 0)
1515 /* Walk over the token list replacing nodes with their expansion.
1516 * Whenever nodes are expanded the walking will walk over the new
1517 * nodes, continuing to expand as necessary. The results are placed in
1521 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1524 token_node_t *node_prev;
1525 token_node_t *node, *last = NULL;
1526 token_list_t *expansion;
1531 _token_list_trim_trailing_space (list);
1538 while (parser->active && parser->active->marker == node)
1539 parser->active = _active_list_pop (parser->active);
1541 /* Find the expansion for node, which will replace all
1542 * nodes from node to last, inclusive. */
1543 expansion = _glcpp_parser_expand_node (parser, node, &last);
1547 for (n = node; n != last->next; n = n->next)
1548 while (parser->active &&
1549 parser->active->marker == n)
1551 parser->active = _active_list_pop (parser->active);
1554 parser->active = _active_list_push (parser->active,
1555 node->token->value.str,
1558 /* Splice expansion into list, supporting a
1559 * simple deletion if the expansion is
1561 if (expansion->head) {
1563 node_prev->next = expansion->head;
1565 list->head = expansion->head;
1566 expansion->tail->next = last->next;
1567 if (last == list->tail)
1568 list->tail = expansion->tail;
1571 node_prev->next = last->next;
1573 list->head = last->next;
1574 if (last == list->tail)
1580 node = node_prev ? node_prev->next : list->head;
1583 while (parser->active)
1584 parser->active = _active_list_pop (parser->active);
1586 list->non_space_tail = list->tail;
1590 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1596 _glcpp_parser_expand_token_list (parser, list);
1598 _token_list_trim_trailing_space (list);
1600 _token_list_print (parser, list);
1604 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1605 const char *identifier)
1607 /* According to the GLSL specification, macro names starting with "__"
1608 * or "GL_" are reserved for future use. So, don't allow them.
1610 if (strncmp(identifier, "__", 2) == 0) {
1611 glcpp_error (loc, parser, "Macro names starting with \"__\" are reserved.\n");
1613 if (strncmp(identifier, "GL_", 3) == 0) {
1614 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1619 _macro_equal (macro_t *a, macro_t *b)
1621 if (a->is_function != b->is_function)
1624 if (a->is_function) {
1625 if (! _string_list_equal (a->parameters, b->parameters))
1629 return _token_list_equal_ignoring_space (a->replacements,
1634 _define_object_macro (glcpp_parser_t *parser,
1636 const char *identifier,
1637 token_list_t *replacements)
1639 macro_t *macro, *previous;
1642 _check_for_reserved_macro_name(parser, loc, identifier);
1644 macro = talloc (parser, macro_t);
1646 macro->is_function = 0;
1647 macro->parameters = NULL;
1648 macro->identifier = talloc_strdup (macro, identifier);
1649 macro->replacements = talloc_steal (macro, replacements);
1651 previous = hash_table_find (parser->defines, identifier);
1653 if (_macro_equal (macro, previous)) {
1654 talloc_free (macro);
1657 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1661 hash_table_insert (parser->defines, macro, identifier);
1665 _define_function_macro (glcpp_parser_t *parser,
1667 const char *identifier,
1668 string_list_t *parameters,
1669 token_list_t *replacements)
1671 macro_t *macro, *previous;
1673 _check_for_reserved_macro_name(parser, loc, identifier);
1675 macro = talloc (parser, macro_t);
1677 macro->is_function = 1;
1678 macro->parameters = talloc_steal (macro, parameters);
1679 macro->identifier = talloc_strdup (macro, identifier);
1680 macro->replacements = talloc_steal (macro, replacements);
1682 previous = hash_table_find (parser->defines, identifier);
1684 if (_macro_equal (macro, previous)) {
1685 talloc_free (macro);
1688 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1692 hash_table_insert (parser->defines, macro, identifier);
1696 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1701 if (parser->lex_from_list == NULL) {
1702 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1704 /* XXX: This ugly block of code exists for the sole
1705 * purpose of converting a NEWLINE token into a SPACE
1706 * token, but only in the case where we have seen a
1707 * function-like macro name, but have not yet seen its
1708 * closing parenthesis.
1710 * There's perhaps a more compact way to do this with
1711 * mid-rule actions in the grammar.
1713 * I'm definitely not pleased with the complexity of
1716 if (parser->newline_as_space)
1719 parser->paren_count++;
1720 } else if (ret == ')') {
1721 parser->paren_count--;
1722 if (parser->paren_count == 0)
1723 parser->newline_as_space = 0;
1724 } else if (ret == NEWLINE) {
1726 } else if (ret != SPACE) {
1727 if (parser->paren_count == 0)
1728 parser->newline_as_space = 0;
1731 else if (parser->in_control_line)
1734 parser->in_control_line = 0;
1736 else if (ret == HASH_DEFINE_OBJ || ret == HASH_DEFINE_FUNC ||
1737 ret == HASH_UNDEF || ret == HASH_IF ||
1738 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1739 ret == HASH_ELIF || ret == HASH_ELSE ||
1740 ret == HASH_ENDIF || ret == HASH)
1742 parser->in_control_line = 1;
1744 else if (ret == IDENTIFIER)
1747 macro = hash_table_find (parser->defines,
1749 if (macro && macro->is_function) {
1750 parser->newline_as_space = 1;
1751 parser->paren_count = 0;
1758 node = parser->lex_from_node;
1761 talloc_free (parser->lex_from_list);
1762 parser->lex_from_list = NULL;
1766 *yylval = node->token->value;
1767 ret = node->token->type;
1769 parser->lex_from_node = node->next;
1775 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1779 assert (parser->lex_from_list == NULL);
1781 /* Copy list, eliminating any space tokens. */
1782 parser->lex_from_list = _token_list_create (parser);
1784 for (node = list->head; node; node = node->next) {
1785 if (node->token->type == SPACE)
1787 _token_list_append (parser->lex_from_list, node->token);
1792 parser->lex_from_node = parser->lex_from_list->head;
1794 /* It's possible the list consisted of nothing but whitespace. */
1795 if (parser->lex_from_node == NULL) {
1796 talloc_free (parser->lex_from_list);
1797 parser->lex_from_list = NULL;
1802 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1805 skip_type_t current = SKIP_NO_SKIP;
1808 if (parser->skip_stack)
1809 current = parser->skip_stack->type;
1811 node = talloc (parser, skip_node_t);
1814 if (current == SKIP_NO_SKIP) {
1816 node->type = SKIP_NO_SKIP;
1818 node->type = SKIP_TO_ELSE;
1820 node->type = SKIP_TO_ENDIF;
1823 node->next = parser->skip_stack;
1824 parser->skip_stack = node;
1828 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
1829 const char *type, int condition)
1831 if (parser->skip_stack == NULL) {
1832 glcpp_error (loc, parser, "%s without #if\n", type);
1836 if (parser->skip_stack->type == SKIP_TO_ELSE) {
1838 parser->skip_stack->type = SKIP_NO_SKIP;
1840 parser->skip_stack->type = SKIP_TO_ENDIF;
1845 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
1849 if (parser->skip_stack == NULL) {
1850 glcpp_error (loc, parser, "#endif without #if\n");
1854 node = parser->skip_stack;
1855 parser->skip_stack = node->next;