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 glcpp_printf(parser->output, "#version %" PRIiMAX, $2);
330 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
331 $$ = strtoll ($1 + 2, NULL, 16);
332 } else if ($1[0] == '0') {
333 $$ = strtoll ($1, NULL, 8);
335 $$ = strtoll ($1, NULL, 10);
344 | expression OR expression {
347 | expression AND expression {
350 | expression '|' expression {
353 | expression '^' expression {
356 | expression '&' expression {
359 | expression NOT_EQUAL expression {
362 | expression EQUAL expression {
365 | expression GREATER_OR_EQUAL expression {
368 | expression LESS_OR_EQUAL expression {
371 | expression '>' expression {
374 | expression '<' expression {
377 | expression RIGHT_SHIFT expression {
380 | expression LEFT_SHIFT expression {
383 | expression '-' expression {
386 | expression '+' expression {
389 | expression '%' expression {
392 | expression '/' expression {
395 | expression '*' expression {
398 | '!' expression %prec UNARY {
401 | '~' expression %prec UNARY {
404 | '-' expression %prec UNARY {
407 | '+' expression %prec UNARY {
410 | '(' expression ')' {
417 $$ = _string_list_create (parser);
418 _string_list_append_item ($$, $1);
419 talloc_steal ($$, $1);
421 | identifier_list ',' IDENTIFIER {
423 _string_list_append_item ($$, $3);
424 talloc_steal ($$, $3);
429 NEWLINE { $$ = NULL; }
435 yyerror (& @1, parser, "Invalid tokens after #");
440 /* empty */ { $$ = NULL; }
447 glcpp_warning(&@1, parser, "extra tokens at end of directive");
452 /* Handle "defined" operator */
454 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
455 $$ = _token_create_ival (parser, INTEGER, v);
457 | DEFINED '(' IDENTIFIER ')' {
458 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
459 $$ = _token_create_ival (parser, INTEGER, v);
461 | preprocessing_token
465 /* Exactly the same as pp_tokens, but using conditional_token */
467 parser->space_tokens = 1;
468 $$ = _token_list_create (parser);
469 _token_list_append ($$, $1);
470 talloc_unlink (parser, $1);
472 | conditional_tokens conditional_token {
474 _token_list_append ($$, $2);
475 talloc_unlink (parser, $2);
480 preprocessing_token {
481 parser->space_tokens = 1;
482 $$ = _token_list_create (parser);
483 _token_list_append ($$, $1);
484 talloc_unlink (parser, $1);
486 | pp_tokens preprocessing_token {
488 _token_list_append ($$, $2);
489 talloc_unlink (parser, $2);
495 $$ = _token_create_str (parser, IDENTIFIER, $1);
496 $$->location = yylloc;
499 $$ = _token_create_str (parser, INTEGER_STRING, $1);
500 $$->location = yylloc;
503 $$ = _token_create_ival (parser, $1, $1);
504 $$->location = yylloc;
507 $$ = _token_create_str (parser, OTHER, $1);
508 $$->location = yylloc;
511 $$ = _token_create_ival (parser, SPACE, SPACE);
512 $$->location = yylloc;
532 | LEFT_SHIFT { $$ = LEFT_SHIFT; }
533 | RIGHT_SHIFT { $$ = RIGHT_SHIFT; }
536 | LESS_OR_EQUAL { $$ = LESS_OR_EQUAL; }
537 | GREATER_OR_EQUAL { $$ = GREATER_OR_EQUAL; }
538 | EQUAL { $$ = EQUAL; }
539 | NOT_EQUAL { $$ = NOT_EQUAL; }
547 | PASTE { $$ = PASTE; }
553 _string_list_create (void *ctx)
557 list = talloc (ctx, string_list_t);
565 _string_list_append_item (string_list_t *list, const char *str)
569 node = talloc (list, string_node_t);
570 node->str = talloc_strdup (node, str);
574 if (list->head == NULL) {
577 list->tail->next = node;
584 _string_list_contains (string_list_t *list, const char *member, int *index)
592 for (i = 0, node = list->head; node; i++, node = node->next) {
593 if (strcmp (node->str, member) == 0) {
604 _string_list_length (string_list_t *list)
612 for (node = list->head; node; node = node->next)
619 _string_list_equal (string_list_t *a, string_list_t *b)
621 string_node_t *node_a, *node_b;
623 if (a == NULL && b == NULL)
626 if (a == NULL || b == NULL)
629 for (node_a = a->head, node_b = b->head;
631 node_a = node_a->next, node_b = node_b->next)
633 if (strcmp (node_a->str, node_b->str))
637 /* Catch the case of lists being different lengths, (which
638 * would cause the loop above to terminate after the shorter
640 return node_a == node_b;
644 _argument_list_create (void *ctx)
646 argument_list_t *list;
648 list = talloc (ctx, argument_list_t);
656 _argument_list_append (argument_list_t *list, token_list_t *argument)
658 argument_node_t *node;
660 node = talloc (list, argument_node_t);
661 node->argument = argument;
665 if (list->head == NULL) {
668 list->tail->next = node;
675 _argument_list_length (argument_list_t *list)
678 argument_node_t *node;
683 for (node = list->head; node; node = node->next)
690 _argument_list_member_at (argument_list_t *list, int index)
692 argument_node_t *node;
699 for (i = 0; i < index; i++) {
706 return node->argument;
711 /* Note: This function talloc_steal()s the str pointer. */
713 _token_create_str (void *ctx, int type, char *str)
717 token = talloc (ctx, token_t);
719 token->value.str = talloc_steal (token, str);
725 _token_create_ival (void *ctx, int type, int ival)
729 token = talloc (ctx, token_t);
731 token->value.ival = ival;
737 _token_list_create (void *ctx)
741 list = talloc (ctx, token_list_t);
744 list->non_space_tail = NULL;
750 _token_list_append (token_list_t *list, token_t *token)
754 node = talloc (list, token_node_t);
755 node->token = talloc_reference (list, token);
759 if (list->head == NULL) {
762 list->tail->next = node;
766 if (token->type != SPACE)
767 list->non_space_tail = node;
771 _token_list_append_list (token_list_t *list, token_list_t *tail)
773 if (tail == NULL || tail->head == NULL)
776 if (list->head == NULL) {
777 list->head = tail->head;
779 list->tail->next = tail->head;
782 list->tail = tail->tail;
783 list->non_space_tail = tail->non_space_tail;
786 static token_list_t *
787 _token_list_copy (void *ctx, token_list_t *other)
795 copy = _token_list_create (ctx);
796 for (node = other->head; node; node = node->next)
797 _token_list_append (copy, node->token);
803 _token_list_trim_trailing_space (token_list_t *list)
805 token_node_t *tail, *next;
807 if (list->non_space_tail) {
808 tail = list->non_space_tail->next;
809 list->non_space_tail->next = NULL;
810 list->tail = list->non_space_tail;
821 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
823 token_node_t *node_a, *node_b;
830 if (node_a == NULL && node_b == NULL)
833 if (node_a == NULL || node_b == NULL)
836 if (node_a->token->type == SPACE) {
837 node_a = node_a->next;
841 if (node_b->token->type == SPACE) {
842 node_b = node_b->next;
846 if (node_a->token->type != node_b->token->type)
849 switch (node_a->token->type) {
851 if (node_a->token->value.ival !=
852 node_b->token->value.ival)
860 if (strcmp (node_a->token->value.str,
861 node_b->token->value.str))
868 node_a = node_a->next;
869 node_b = node_b->next;
876 _token_print (char **out, token_t *token)
878 if (token->type < 256) {
879 glcpp_printf (*out, "%c", token->type);
883 switch (token->type) {
885 glcpp_printf (*out, "%" PRIiMAX, token->value.ival);
890 glcpp_print (*out, token->value.str);
893 glcpp_print (*out, " ");
896 glcpp_print (*out, "<<");
899 glcpp_print (*out, ">>");
902 glcpp_print (*out, "<=");
904 case GREATER_OR_EQUAL:
905 glcpp_print (*out, ">=");
908 glcpp_print (*out, "==");
911 glcpp_print (*out, "!=");
914 glcpp_print (*out, "&&");
917 glcpp_print (*out, "||");
920 glcpp_print (*out, "##");
923 glcpp_print (*out, ",");
926 /* Nothing to print. */
929 assert(!"Error: Don't know how to print token.");
934 /* Return a new token (talloc()ed off of 'token') formed by pasting
935 * 'token' and 'other'. Note that this function may return 'token' or
936 * 'other' directly rather than allocating anything new.
938 * Caution: Only very cursory error-checking is performed to see if
939 * the final result is a valid single token. */
941 _token_paste (glcpp_parser_t *parser, token_t *token, token_t *other)
943 token_t *combined = NULL;
945 /* Pasting a placeholder onto anything makes no change. */
946 if (other->type == PLACEHOLDER)
949 /* When 'token' is a placeholder, just return 'other'. */
950 if (token->type == PLACEHOLDER)
953 /* A very few single-character punctuators can be combined
954 * with another to form a multi-character punctuator. */
955 switch (token->type) {
957 if (other->type == '<')
958 combined = _token_create_ival (token, LEFT_SHIFT, LEFT_SHIFT);
959 else if (other->type == '=')
960 combined = _token_create_ival (token, LESS_OR_EQUAL, LESS_OR_EQUAL);
963 if (other->type == '>')
964 combined = _token_create_ival (token, RIGHT_SHIFT, RIGHT_SHIFT);
965 else if (other->type == '=')
966 combined = _token_create_ival (token, GREATER_OR_EQUAL, GREATER_OR_EQUAL);
969 if (other->type == '=')
970 combined = _token_create_ival (token, EQUAL, EQUAL);
973 if (other->type == '=')
974 combined = _token_create_ival (token, NOT_EQUAL, NOT_EQUAL);
977 if (other->type == '&')
978 combined = _token_create_ival (token, AND, AND);
981 if (other->type == '|')
982 combined = _token_create_ival (token, OR, OR);
986 if (combined != NULL) {
987 /* Inherit the location from the first token */
988 combined->location = token->location;
992 /* Two string-valued tokens can usually just be mashed
995 * XXX: This isn't actually legitimate. Several things here
996 * should result in a diagnostic since the result cannot be a
997 * valid, single pre-processing token. For example, pasting
998 * "123" and "abc" is not legal, but we don't catch that
1000 if ((token->type == IDENTIFIER || token->type == OTHER || token->type == INTEGER_STRING) &&
1001 (other->type == IDENTIFIER || other->type == OTHER || other->type == INTEGER_STRING))
1005 str = talloc_asprintf (token, "%s%s", token->value.str,
1007 combined = _token_create_str (token, token->type, str);
1008 combined->location = token->location;
1012 glcpp_error (&token->location, parser, "");
1013 glcpp_print (parser->info_log, "Pasting \"");
1014 _token_print (&parser->info_log, token);
1015 glcpp_print (parser->info_log, "\" and \"");
1016 _token_print (&parser->info_log, other);
1017 glcpp_print (parser->info_log, "\" does not give a valid preprocessing token.\n");
1023 _token_list_print (glcpp_parser_t *parser, token_list_t *list)
1030 for (node = list->head; node; node = node->next)
1031 _token_print (&parser->output, node->token);
1035 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error)
1037 glcpp_error(locp, parser, "%s", error);
1040 static void add_builtin_define(glcpp_parser_t *parser,
1041 const char *name, int value)
1046 tok = _token_create_ival (parser, INTEGER, value);
1048 list = _token_list_create(parser);
1049 _token_list_append(list, tok);
1050 _define_object_macro(parser, NULL, name, list);
1052 talloc_unlink(parser, tok);
1056 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1058 glcpp_parser_t *parser;
1059 int language_version;
1061 parser = talloc (NULL, glcpp_parser_t);
1063 glcpp_lex_init_extra (parser, &parser->scanner);
1064 parser->defines = hash_table_ctor (32, hash_table_string_hash,
1065 hash_table_string_compare);
1066 parser->active = NULL;
1067 parser->lexing_if = 0;
1068 parser->space_tokens = 1;
1069 parser->newline_as_space = 0;
1070 parser->in_control_line = 0;
1071 parser->paren_count = 0;
1073 parser->skip_stack = NULL;
1075 parser->lex_from_list = NULL;
1076 parser->lex_from_node = NULL;
1078 parser->output = talloc_strdup(parser, "");
1079 parser->info_log = talloc_strdup(parser, "");
1082 /* Add pre-defined macros. */
1083 add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1084 add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1086 if (api == API_OPENGLES2)
1087 add_builtin_define(parser, "GL_ES", 1);
1089 if (extensions != NULL) {
1090 if (extensions->EXT_texture_array) {
1091 add_builtin_define(parser, "GL_EXT_texture_array", 1);
1094 if (extensions->ARB_fragment_coord_conventions)
1095 add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1098 if (extensions->ARB_explicit_attrib_location)
1099 add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
1102 language_version = 110;
1103 add_builtin_define(parser, "__VERSION__", language_version);
1109 glcpp_parser_parse (glcpp_parser_t *parser)
1111 return yyparse (parser);
1115 glcpp_parser_destroy (glcpp_parser_t *parser)
1117 glcpp_lex_destroy (parser->scanner);
1118 hash_table_dtor (parser->defines);
1119 talloc_free (parser);
1122 typedef enum function_status
1124 FUNCTION_STATUS_SUCCESS,
1125 FUNCTION_NOT_A_FUNCTION,
1126 FUNCTION_UNBALANCED_PARENTHESES
1127 } function_status_t;
1129 /* Find a set of function-like macro arguments by looking for a
1130 * balanced set of parentheses.
1132 * When called, 'node' should be the opening-parenthesis token, (or
1133 * perhaps preceeding SPACE tokens). Upon successful return *last will
1134 * be the last consumed node, (corresponding to the closing right
1139 * FUNCTION_STATUS_SUCCESS:
1141 * Successfully parsed a set of function arguments.
1143 * FUNCTION_NOT_A_FUNCTION:
1145 * Macro name not followed by a '('. This is not an error, but
1146 * simply that the macro name should be treated as a non-macro.
1148 * FUNCTION_UNBALANCED_PARENTHESES
1150 * Macro name is not followed by a balanced set of parentheses.
1152 static function_status_t
1153 _arguments_parse (argument_list_t *arguments,
1155 token_node_t **last)
1157 token_list_t *argument;
1162 /* Ignore whitespace before first parenthesis. */
1163 while (node && node->token->type == SPACE)
1166 if (node == NULL || node->token->type != '(')
1167 return FUNCTION_NOT_A_FUNCTION;
1171 argument = _token_list_create (arguments);
1172 _argument_list_append (arguments, argument);
1174 for (paren_count = 1; node; node = node->next) {
1175 if (node->token->type == '(')
1179 else if (node->token->type == ')')
1182 if (paren_count == 0)
1186 if (node->token->type == ',' &&
1189 _token_list_trim_trailing_space (argument);
1190 argument = _token_list_create (arguments);
1191 _argument_list_append (arguments, argument);
1194 if (argument->head == NULL) {
1195 /* Don't treat initial whitespace as
1196 * part of the arguement. */
1197 if (node->token->type == SPACE)
1200 _token_list_append (argument, node->token);
1205 return FUNCTION_UNBALANCED_PARENTHESES;
1209 return FUNCTION_STATUS_SUCCESS;
1212 static token_list_t *
1213 _token_list_create_with_one_space (void *ctx)
1218 list = _token_list_create (ctx);
1219 space = _token_create_ival (list, SPACE, SPACE);
1220 _token_list_append (list, space);
1226 _glcpp_parser_expand_if (glcpp_parser_t *parser, int type, token_list_t *list)
1228 token_list_t *expanded;
1231 expanded = _token_list_create (parser);
1232 token = _token_create_ival (parser, type, type);
1233 _token_list_append (expanded, token);
1234 _glcpp_parser_expand_token_list (parser, list);
1235 _token_list_append_list (expanded, list);
1236 glcpp_parser_lex_from (parser, expanded);
1239 /* This is a helper function that's essentially part of the
1240 * implementation of _glcpp_parser_expand_node. It shouldn't be called
1241 * except for by that function.
1243 * Returns NULL if node is a simple token with no expansion, (that is,
1244 * although 'node' corresponds to an identifier defined as a
1245 * function-like macro, it is not followed with a parenthesized
1248 * Compute the complete expansion of node (which is a function-like
1249 * macro) and subsequent nodes which are arguments.
1251 * Returns the token list that results from the expansion and sets
1252 * *last to the last node in the list that was consumed by the
1253 * expansion. Specifically, *last will be set as follows: as the
1254 * token of the closing right parenthesis.
1256 static token_list_t *
1257 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1259 token_node_t **last)
1263 const char *identifier;
1264 argument_list_t *arguments;
1265 function_status_t status;
1266 token_list_t *substituted;
1267 int parameter_index;
1269 identifier = node->token->value.str;
1271 macro = hash_table_find (parser->defines, identifier);
1273 assert (macro->is_function);
1275 arguments = _argument_list_create (parser);
1276 status = _arguments_parse (arguments, node, last);
1279 case FUNCTION_STATUS_SUCCESS:
1281 case FUNCTION_NOT_A_FUNCTION:
1283 case FUNCTION_UNBALANCED_PARENTHESES:
1284 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1288 /* Replace a macro defined as empty with a SPACE token. */
1289 if (macro->replacements == NULL) {
1290 talloc_free (arguments);
1291 return _token_list_create_with_one_space (parser);
1294 if (! ((_argument_list_length (arguments) ==
1295 _string_list_length (macro->parameters)) ||
1296 (_string_list_length (macro->parameters) == 0 &&
1297 _argument_list_length (arguments) == 1 &&
1298 arguments->head->argument->head == NULL)))
1300 glcpp_error (&node->token->location, parser,
1301 "Error: macro %s invoked with %d arguments (expected %d)\n",
1303 _argument_list_length (arguments),
1304 _string_list_length (macro->parameters));
1308 /* Perform argument substitution on the replacement list. */
1309 substituted = _token_list_create (arguments);
1311 for (node = macro->replacements->head; node; node = node->next)
1313 if (node->token->type == IDENTIFIER &&
1314 _string_list_contains (macro->parameters,
1315 node->token->value.str,
1318 token_list_t *argument;
1319 argument = _argument_list_member_at (arguments,
1321 /* Before substituting, we expand the argument
1322 * tokens, or append a placeholder token for
1323 * an empty argument. */
1324 if (argument->head) {
1325 token_list_t *expanded_argument;
1326 expanded_argument = _token_list_copy (parser,
1328 _glcpp_parser_expand_token_list (parser,
1330 _token_list_append_list (substituted,
1335 new_token = _token_create_ival (substituted,
1338 _token_list_append (substituted, new_token);
1341 _token_list_append (substituted, node->token);
1345 /* After argument substitution, and before further expansion
1346 * below, implement token pasting. */
1348 _token_list_trim_trailing_space (substituted);
1350 node = substituted->head;
1353 token_node_t *next_non_space;
1355 /* Look ahead for a PASTE token, skipping space. */
1356 next_non_space = node->next;
1357 while (next_non_space && next_non_space->token->type == SPACE)
1358 next_non_space = next_non_space->next;
1360 if (next_non_space == NULL)
1363 if (next_non_space->token->type != PASTE) {
1364 node = next_non_space;
1368 /* Now find the next non-space token after the PASTE. */
1369 next_non_space = next_non_space->next;
1370 while (next_non_space && next_non_space->token->type == SPACE)
1371 next_non_space = next_non_space->next;
1373 if (next_non_space == NULL) {
1374 yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1378 node->token = _token_paste (parser, node->token, next_non_space->token);
1379 node->next = next_non_space->next;
1380 if (next_non_space == substituted->tail)
1381 substituted->tail = node;
1386 substituted->non_space_tail = substituted->tail;
1391 /* Compute the complete expansion of node, (and subsequent nodes after
1392 * 'node' in the case that 'node' is a function-like macro and
1393 * subsequent nodes are arguments).
1395 * Returns NULL if node is a simple token with no expansion.
1397 * Otherwise, returns the token list that results from the expansion
1398 * and sets *last to the last node in the list that was consumed by
1399 * the expansion. Specifically, *last will be set as follows:
1401 * As 'node' in the case of object-like macro expansion.
1403 * As the token of the closing right parenthesis in the case of
1404 * function-like macro expansion.
1406 static token_list_t *
1407 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1409 token_node_t **last)
1411 token_t *token = node->token;
1412 const char *identifier;
1415 /* We only expand identifiers */
1416 if (token->type != IDENTIFIER) {
1417 /* We change any COMMA into a COMMA_FINAL to prevent
1418 * it being mistaken for an argument separator
1420 if (token->type == ',') {
1421 token->type = COMMA_FINAL;
1422 token->value.ival = COMMA_FINAL;
1428 /* Look up this identifier in the hash table. */
1429 identifier = token->value.str;
1430 macro = hash_table_find (parser->defines, identifier);
1432 /* Not a macro, so no expansion needed. */
1436 /* Finally, don't expand this macro if we're already actively
1437 * expanding it, (to avoid infinite recursion). */
1438 if (_active_list_contains (parser->active, identifier)) {
1439 /* We change the token type here from IDENTIFIER to
1440 * OTHER to prevent any future expansion of this
1441 * unexpanded token. */
1443 token_list_t *expansion;
1446 str = talloc_strdup (parser, token->value.str);
1447 final = _token_create_str (parser, OTHER, str);
1448 expansion = _token_list_create (parser);
1449 _token_list_append (expansion, final);
1454 if (! macro->is_function)
1458 /* Replace a macro defined as empty with a SPACE token. */
1459 if (macro->replacements == NULL)
1460 return _token_list_create_with_one_space (parser);
1462 return _token_list_copy (parser, macro->replacements);
1465 return _glcpp_parser_expand_function (parser, node, last);
1468 /* Push a new identifier onto the active list, returning the new list.
1470 * Here, 'marker' is the token node that appears in the list after the
1471 * expansion of 'identifier'. That is, when the list iterator begins
1472 * examinging 'marker', then it is time to pop this node from the
1476 _active_list_push (active_list_t *list,
1477 const char *identifier,
1478 token_node_t *marker)
1480 active_list_t *node;
1482 node = talloc (list, active_list_t);
1483 node->identifier = talloc_strdup (node, identifier);
1484 node->marker = marker;
1491 _active_list_pop (active_list_t *list)
1493 active_list_t *node = list;
1505 _active_list_contains (active_list_t *list, const char *identifier)
1507 active_list_t *node;
1512 for (node = list; node; node = node->next)
1513 if (strcmp (node->identifier, identifier) == 0)
1519 /* Walk over the token list replacing nodes with their expansion.
1520 * Whenever nodes are expanded the walking will walk over the new
1521 * nodes, continuing to expand as necessary. The results are placed in
1525 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1528 token_node_t *node_prev;
1529 token_node_t *node, *last = NULL;
1530 token_list_t *expansion;
1535 _token_list_trim_trailing_space (list);
1542 while (parser->active && parser->active->marker == node)
1543 parser->active = _active_list_pop (parser->active);
1545 /* Find the expansion for node, which will replace all
1546 * nodes from node to last, inclusive. */
1547 expansion = _glcpp_parser_expand_node (parser, node, &last);
1551 for (n = node; n != last->next; n = n->next)
1552 while (parser->active &&
1553 parser->active->marker == n)
1555 parser->active = _active_list_pop (parser->active);
1558 parser->active = _active_list_push (parser->active,
1559 node->token->value.str,
1562 /* Splice expansion into list, supporting a
1563 * simple deletion if the expansion is
1565 if (expansion->head) {
1567 node_prev->next = expansion->head;
1569 list->head = expansion->head;
1570 expansion->tail->next = last->next;
1571 if (last == list->tail)
1572 list->tail = expansion->tail;
1575 node_prev->next = last->next;
1577 list->head = last->next;
1578 if (last == list->tail)
1584 node = node_prev ? node_prev->next : list->head;
1587 while (parser->active)
1588 parser->active = _active_list_pop (parser->active);
1590 list->non_space_tail = list->tail;
1594 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1600 _glcpp_parser_expand_token_list (parser, list);
1602 _token_list_trim_trailing_space (list);
1604 _token_list_print (parser, list);
1608 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1609 const char *identifier)
1611 /* According to the GLSL specification, macro names starting with "__"
1612 * or "GL_" are reserved for future use. So, don't allow them.
1614 if (strncmp(identifier, "__", 2) == 0) {
1615 glcpp_error (loc, parser, "Macro names starting with \"__\" are reserved.\n");
1617 if (strncmp(identifier, "GL_", 3) == 0) {
1618 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1623 _macro_equal (macro_t *a, macro_t *b)
1625 if (a->is_function != b->is_function)
1628 if (a->is_function) {
1629 if (! _string_list_equal (a->parameters, b->parameters))
1633 return _token_list_equal_ignoring_space (a->replacements,
1638 _define_object_macro (glcpp_parser_t *parser,
1640 const char *identifier,
1641 token_list_t *replacements)
1643 macro_t *macro, *previous;
1646 _check_for_reserved_macro_name(parser, loc, identifier);
1648 macro = talloc (parser, macro_t);
1650 macro->is_function = 0;
1651 macro->parameters = NULL;
1652 macro->identifier = talloc_strdup (macro, identifier);
1653 macro->replacements = talloc_steal (macro, replacements);
1655 previous = hash_table_find (parser->defines, identifier);
1657 if (_macro_equal (macro, previous)) {
1658 talloc_free (macro);
1661 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1665 hash_table_insert (parser->defines, macro, identifier);
1669 _define_function_macro (glcpp_parser_t *parser,
1671 const char *identifier,
1672 string_list_t *parameters,
1673 token_list_t *replacements)
1675 macro_t *macro, *previous;
1677 _check_for_reserved_macro_name(parser, loc, identifier);
1679 macro = talloc (parser, macro_t);
1681 macro->is_function = 1;
1682 macro->parameters = talloc_steal (macro, parameters);
1683 macro->identifier = talloc_strdup (macro, identifier);
1684 macro->replacements = talloc_steal (macro, replacements);
1686 previous = hash_table_find (parser->defines, identifier);
1688 if (_macro_equal (macro, previous)) {
1689 talloc_free (macro);
1692 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1696 hash_table_insert (parser->defines, macro, identifier);
1700 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1705 if (parser->lex_from_list == NULL) {
1706 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1708 /* XXX: This ugly block of code exists for the sole
1709 * purpose of converting a NEWLINE token into a SPACE
1710 * token, but only in the case where we have seen a
1711 * function-like macro name, but have not yet seen its
1712 * closing parenthesis.
1714 * There's perhaps a more compact way to do this with
1715 * mid-rule actions in the grammar.
1717 * I'm definitely not pleased with the complexity of
1720 if (parser->newline_as_space)
1723 parser->paren_count++;
1724 } else if (ret == ')') {
1725 parser->paren_count--;
1726 if (parser->paren_count == 0)
1727 parser->newline_as_space = 0;
1728 } else if (ret == NEWLINE) {
1730 } else if (ret != SPACE) {
1731 if (parser->paren_count == 0)
1732 parser->newline_as_space = 0;
1735 else if (parser->in_control_line)
1738 parser->in_control_line = 0;
1740 else if (ret == HASH_DEFINE_OBJ || ret == HASH_DEFINE_FUNC ||
1741 ret == HASH_UNDEF || ret == HASH_IF ||
1742 ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1743 ret == HASH_ELIF || ret == HASH_ELSE ||
1744 ret == HASH_ENDIF || ret == HASH)
1746 parser->in_control_line = 1;
1748 else if (ret == IDENTIFIER)
1751 macro = hash_table_find (parser->defines,
1753 if (macro && macro->is_function) {
1754 parser->newline_as_space = 1;
1755 parser->paren_count = 0;
1762 node = parser->lex_from_node;
1765 talloc_free (parser->lex_from_list);
1766 parser->lex_from_list = NULL;
1770 *yylval = node->token->value;
1771 ret = node->token->type;
1773 parser->lex_from_node = node->next;
1779 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1783 assert (parser->lex_from_list == NULL);
1785 /* Copy list, eliminating any space tokens. */
1786 parser->lex_from_list = _token_list_create (parser);
1788 for (node = list->head; node; node = node->next) {
1789 if (node->token->type == SPACE)
1791 _token_list_append (parser->lex_from_list, node->token);
1796 parser->lex_from_node = parser->lex_from_list->head;
1798 /* It's possible the list consisted of nothing but whitespace. */
1799 if (parser->lex_from_node == NULL) {
1800 talloc_free (parser->lex_from_list);
1801 parser->lex_from_list = NULL;
1806 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1809 skip_type_t current = SKIP_NO_SKIP;
1812 if (parser->skip_stack)
1813 current = parser->skip_stack->type;
1815 node = talloc (parser, skip_node_t);
1818 if (current == SKIP_NO_SKIP) {
1820 node->type = SKIP_NO_SKIP;
1822 node->type = SKIP_TO_ELSE;
1824 node->type = SKIP_TO_ENDIF;
1827 node->next = parser->skip_stack;
1828 parser->skip_stack = node;
1832 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
1833 const char *type, int condition)
1835 if (parser->skip_stack == NULL) {
1836 glcpp_error (loc, parser, "%s without #if\n", type);
1840 if (parser->skip_stack->type == SKIP_TO_ELSE) {
1842 parser->skip_stack->type = SKIP_NO_SKIP;
1844 parser->skip_stack->type = SKIP_TO_ENDIF;
1849 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
1853 if (parser->skip_stack == NULL) {
1854 glcpp_error (loc, parser, "#endif without #if\n");
1858 node = parser->skip_stack;
1859 parser->skip_stack = node->next;