src/glsl/glcpp/glcpp-parse.y

   1 %{
   2 /*
   3  * Copyright © 2010 Intel Corporation
   4  *
   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:
  11  *
  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
  14  * Software.
  15  *
  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.
  23  */
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <assert.h>
  29 #include <inttypes.h>
  30
  31 #include "glcpp.h"
  32 #include "main/core.h" /* for struct gl_extensions */
  33 #include "main/mtypes.h" /* for gl_api enum */
  34
  35 static void
  36 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error);
  37
  38 static void
  39 _define_object_macro (glcpp_parser_t *parser,
  40                       YYLTYPE *loc,
  41                       const char *macro,
  42                       token_list_t *replacements);
  43
  44 static void
  45 _define_function_macro (glcpp_parser_t *parser,
  46                         YYLTYPE *loc,
  47                         const char *macro,
  48                         string_list_t *parameters,
  49                         token_list_t *replacements);
  50
  51 static string_list_t *
  52 _string_list_create (void *ctx);
  53
  54 static void
  55 _string_list_append_item (string_list_t *list, const char *str);
  56
  57 static int
  58 _string_list_contains (string_list_t *list, const char *member, int *index);
  59
  60 static int
  61 _string_list_length (string_list_t *list);
  62
  63 static int
  64 _string_list_equal (string_list_t *a, string_list_t *b);
  65
  66 static argument_list_t *
  67 _argument_list_create (void *ctx);
  68
  69 static void
  70 _argument_list_append (argument_list_t *list, token_list_t *argument);
  71
  72 static int
  73 _argument_list_length (argument_list_t *list);
  74
  75 static token_list_t *
  76 _argument_list_member_at (argument_list_t *list, int index);
  77
  78 /* Note: This function ralloc_steal()s the str pointer. */
  79 static token_t *
  80 _token_create_str (void *ctx, int type, char *str);
  81
  82 static token_t *
  83 _token_create_ival (void *ctx, int type, int ival);
  84
  85 static token_list_t *
  86 _token_list_create (void *ctx);
  87
  88 static void
  89 _token_list_append (token_list_t *list, token_t *token);
  90
  91 static void
  92 _token_list_append_list (token_list_t *list, token_list_t *tail);
  93
  94 static int
  95 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b);
  96
  97 static void
  98 _parser_active_list_push (glcpp_parser_t *parser,
  99                           const char *identifier,
 100                           token_node_t *marker);
 101
 102 static void
 103 _parser_active_list_pop (glcpp_parser_t *parser);
 104
 105 static int
 106 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier);
 107
 108 /* Expand list, and begin lexing from the result (after first
 109  * prefixing a token of type 'head_token_type').
 110  */
 111 static void
 112 _glcpp_parser_expand_and_lex_from (glcpp_parser_t *parser,
 113                                    int head_token_type,
 114                                    token_list_t *list);
 115
 116 /* Perform macro expansion in-place on the given list. */
 117 static void
 118 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
 119                                  token_list_t *list);
 120
 121 static void
 122 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
 123                                          token_list_t *list);
 124
 125 static void
 126 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
 127                                   int condition);
 128
 129 static void
 130 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
 131                                     const char *type, int condition);
 132
 133 static void
 134 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc);
 135
 136 static void
 137 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
 138                                          const char *ident);
 139
 140 static int
 141 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser);
 142
 143 static void
 144 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list);
 145
 146 static void
 147 add_builtin_define(glcpp_parser_t *parser, const char *name, int value);
 148
 149 %}
 150
 151 %pure-parser
 152 %error-verbose
 153
 154 %locations
 155 %initial-action {
 156         @$.first_line = 1;
 157         @$.first_column = 1;
 158         @$.last_line = 1;
 159         @$.last_column = 1;
 160         @$.source = 0;
 161 }
 162
 163 %parse-param {glcpp_parser_t *parser}
 164 %lex-param {glcpp_parser_t *parser}
 165
 166 %expect 0
 167 %token COMMA_FINAL DEFINED ELIF_EXPANDED HASH HASH_DEFINE FUNC_IDENTIFIER OBJ_IDENTIFIER HASH_ELIF HASH_ELSE HASH_ENDIF HASH_IF HASH_IFDEF HASH_IFNDEF HASH_LINE HASH_UNDEF HASH_VERSION IDENTIFIER IF_EXPANDED INTEGER INTEGER_STRING LINE_EXPANDED NEWLINE OTHER PLACEHOLDER SPACE
 168 %token PASTE
 169 %type <ival> expression INTEGER operator SPACE integer_constant
 170 %type <str> IDENTIFIER FUNC_IDENTIFIER OBJ_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
 174 %left OR
 175 %left AND
 176 %left '|'
 177 %left '^'
 178 %left '&'
 179 %left EQUAL NOT_EQUAL
 180 %left '<' '>' LESS_OR_EQUAL GREATER_OR_EQUAL
 181 %left LEFT_SHIFT RIGHT_SHIFT
 182 %left '+' '-'
 183 %left '*' '/' '%'
 184 %right UNARY
 185
 186 %%
 187
 188 input:
 189         /* empty */
 190 |       input line
 191 ;
 192
 193 line:
 194         control_line {
 195                 ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length, "\n");
 196         }
 197 |       HASH_LINE pp_tokens NEWLINE {
 198                 if (parser->skip_stack == NULL ||
 199                     parser->skip_stack->type == SKIP_NO_SKIP)
 200                 {
 201                         _glcpp_parser_expand_and_lex_from (parser,
 202                                                            LINE_EXPANDED, $2);
 203                 }
 204         }
 205 |       text_line {
 206                 _glcpp_parser_print_expanded_token_list (parser, $1);
 207                 ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length, "\n");
 208                 ralloc_free ($1);
 209         }
 210 |       expanded_line
 211 |       HASH non_directive
 212 ;
 213
 214 expanded_line:
 215         IF_EXPANDED expression NEWLINE {
 216                 _glcpp_parser_skip_stack_push_if (parser, & @1, $2);
 217         }
 218 |       ELIF_EXPANDED expression NEWLINE {
 219                 _glcpp_parser_skip_stack_change_if (parser, & @1, "elif", $2);
 220         }
 221 |       LINE_EXPANDED integer_constant NEWLINE {
 222                 parser->has_new_line_number = 1;
 223                 parser->new_line_number = $2;
 224                 ralloc_asprintf_rewrite_tail (&parser->output,
 225                                               &parser->output_length,
 226                                               "#line %" PRIiMAX "\n",
 227                                               $2);
 228         }
 229 |       LINE_EXPANDED integer_constant integer_constant NEWLINE {
 230                 parser->has_new_line_number = 1;
 231                 parser->new_line_number = $2;
 232                 parser->has_new_source_number = 1;
 233                 parser->new_source_number = $3;
 234                 ralloc_asprintf_rewrite_tail (&parser->output,
 235                                               &parser->output_length,
 236                                               "#line %" PRIiMAX " %" PRIiMAX "\n",
 237                                               $2, $3);
 238         }
 239 ;
 240
 241 control_line:
 242         HASH_DEFINE OBJ_IDENTIFIER replacement_list NEWLINE {
 243                 _define_object_macro (parser, & @2, $2, $3);
 244         }
 245 |       HASH_DEFINE FUNC_IDENTIFIER '(' ')' replacement_list NEWLINE {
 246                 _define_function_macro (parser, & @2, $2, NULL, $5);
 247         }
 248 |       HASH_DEFINE FUNC_IDENTIFIER '(' identifier_list ')' replacement_list NEWLINE {
 249                 _define_function_macro (parser, & @2, $2, $4, $6);
 250         }
 251 |       HASH_UNDEF IDENTIFIER NEWLINE {
 252                 macro_t *macro = hash_table_find (parser->defines, $2);
 253                 if (macro) {
 254                         hash_table_remove (parser->defines, $2);
 255                         ralloc_free (macro);
 256                 }
 257                 ralloc_free ($2);
 258         }
 259 |       HASH_IF conditional_tokens NEWLINE {
 260                 /* Be careful to only evaluate the 'if' expression if
 261                  * we are not skipping. When we are skipping, we
 262                  * simply push a new 0-valued 'if' onto the skip
 263                  * stack.
 264                  *
 265                  * This avoids generating diagnostics for invalid
 266                  * expressions that are being skipped. */
 267                 if (parser->skip_stack == NULL ||
 268                     parser->skip_stack->type == SKIP_NO_SKIP)
 269                 {
 270                         _glcpp_parser_expand_and_lex_from (parser,
 271                                                            IF_EXPANDED, $2);
 272                 }
 273                 else
 274                 {
 275                         _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
 276                         parser->skip_stack->type = SKIP_TO_ENDIF;
 277                 }
 278         }
 279 |       HASH_IF NEWLINE {
 280                 /* #if without an expression is only an error if we
 281                  *  are not skipping */
 282                 if (parser->skip_stack == NULL ||
 283                     parser->skip_stack->type == SKIP_NO_SKIP)
 284                 {
 285                         glcpp_error(& @1, parser, "#if with no expression");
 286                 }
 287                 _glcpp_parser_skip_stack_push_if (parser, & @1, 0);
 288         }
 289 |       HASH_IFDEF IDENTIFIER junk NEWLINE {
 290                 macro_t *macro = hash_table_find (parser->defines, $2);
 291                 ralloc_free ($2);
 292                 _glcpp_parser_skip_stack_push_if (parser, & @1, macro != NULL);
 293         }
 294 |       HASH_IFNDEF IDENTIFIER junk NEWLINE {
 295                 macro_t *macro = hash_table_find (parser->defines, $2);
 296                 ralloc_free ($2);
 297                 _glcpp_parser_skip_stack_push_if (parser, & @1, macro == NULL);
 298         }
 299 |       HASH_ELIF conditional_tokens NEWLINE {
 300                 /* Be careful to only evaluate the 'elif' expression
 301                  * if we are not skipping. When we are skipping, we
 302                  * simply change to a 0-valued 'elif' on the skip
 303                  * stack.
 304                  *
 305                  * This avoids generating diagnostics for invalid
 306                  * expressions that are being skipped. */
 307                 if (parser->skip_stack &&
 308                     parser->skip_stack->type == SKIP_TO_ELSE)
 309                 {
 310                         _glcpp_parser_expand_and_lex_from (parser,
 311                                                            ELIF_EXPANDED, $2);
 312                 }
 313                 else
 314                 {
 315                         _glcpp_parser_skip_stack_change_if (parser, & @1,
 316                                                             "elif", 0);
 317                 }
 318         }
 319 |       HASH_ELIF NEWLINE {
 320                 /* #elif without an expression is an error unless we
 321                  * are skipping. */
 322                 if (parser->skip_stack &&
 323                     parser->skip_stack->type == SKIP_TO_ELSE)
 324                 {
 325                         glcpp_error(& @1, parser, "#elif with no expression");
 326                 }
 327                 else
 328                 {
 329                         _glcpp_parser_skip_stack_change_if (parser, & @1,
 330                                                             "elif", 0);
 331                         glcpp_warning(& @1, parser, "ignoring illegal #elif without expression");
 332                 }
 333         }
 334 |       HASH_ELSE {
 335                 _glcpp_parser_skip_stack_change_if (parser, & @1, "else", 1);
 336         } NEWLINE
 337 |       HASH_ENDIF {
 338                 _glcpp_parser_skip_stack_pop (parser, & @1);
 339         } NEWLINE
 340 |       HASH_VERSION integer_constant NEWLINE {
 341                 _glcpp_parser_handle_version_declaration(parser, $2, NULL);
 342         }
 343 |       HASH_VERSION integer_constant IDENTIFIER NEWLINE {
 344                 _glcpp_parser_handle_version_declaration(parser, $2, $3);
 345         }
 346 |       HASH NEWLINE
 347 ;
 348
 349 integer_constant:
 350         INTEGER_STRING {
 351                 if (strlen ($1) >= 3 && strncmp ($1, "0x", 2) == 0) {
 352                         $$ = strtoll ($1 + 2, NULL, 16);
 353                 } else if ($1[0] == '0') {
 354                         $$ = strtoll ($1, NULL, 8);
 355                 } else {
 356                         $$ = strtoll ($1, NULL, 10);
 357                 }
 358         }
 359 |       INTEGER {
 360                 $$ = $1;
 361         }
 362
 363 expression:
 364         integer_constant
 365 |       IDENTIFIER {
 366                 if (parser->is_gles)
 367                         glcpp_error(& @1, parser, "undefined macro %s in expression (illegal in GLES)", $1);
 368                 $$ = 0;
 369         }
 370 |       expression OR expression {
 371                 $$ = $1 || $3;
 372         }
 373 |       expression AND expression {
 374                 $$ = $1 && $3;
 375         }
 376 |       expression '|' expression {
 377                 $$ = $1 | $3;
 378         }
 379 |       expression '^' expression {
 380                 $$ = $1 ^ $3;
 381         }
 382 |       expression '&' expression {
 383                 $$ = $1 & $3;
 384         }
 385 |       expression NOT_EQUAL expression {
 386                 $$ = $1 != $3;
 387         }
 388 |       expression EQUAL expression {
 389                 $$ = $1 == $3;
 390         }
 391 |       expression GREATER_OR_EQUAL expression {
 392                 $$ = $1 >= $3;
 393         }
 394 |       expression LESS_OR_EQUAL expression {
 395                 $$ = $1 <= $3;
 396         }
 397 |       expression '>' expression {
 398                 $$ = $1 > $3;
 399         }
 400 |       expression '<' expression {
 401                 $$ = $1 < $3;
 402         }
 403 |       expression RIGHT_SHIFT expression {
 404                 $$ = $1 >> $3;
 405         }
 406 |       expression LEFT_SHIFT expression {
 407                 $$ = $1 << $3;
 408         }
 409 |       expression '-' expression {
 410                 $$ = $1 - $3;
 411         }
 412 |       expression '+' expression {
 413                 $$ = $1 + $3;
 414         }
 415 |       expression '%' expression {
 416                 if ($3 == 0) {
 417                         yyerror (& @1, parser,
 418                                  "zero modulus in preprocessor directive");
 419                 } else {
 420                         $$ = $1 % $3;
 421                 }
 422         }
 423 |       expression '/' expression {
 424                 if ($3 == 0) {
 425                         yyerror (& @1, parser,
 426                                  "division by 0 in preprocessor directive");
 427                 } else {
 428                         $$ = $1 / $3;
 429                 }
 430         }
 431 |       expression '*' expression {
 432                 $$ = $1 * $3;
 433         }
 434 |       '!' expression %prec UNARY {
 435                 $$ = ! $2;
 436         }
 437 |       '~' expression %prec UNARY {
 438                 $$ = ~ $2;
 439         }
 440 |       '-' expression %prec UNARY {
 441                 $$ = - $2;
 442         }
 443 |       '+' expression %prec UNARY {
 444                 $$ = + $2;
 445         }
 446 |       '(' expression ')' {
 447                 $$ = $2;
 448         }
 449 ;
 450
 451 identifier_list:
 452         IDENTIFIER {
 453                 $$ = _string_list_create (parser);
 454                 _string_list_append_item ($$, $1);
 455                 ralloc_steal ($$, $1);
 456         }
 457 |       identifier_list ',' IDENTIFIER {
 458                 $$ = $1;
 459                 _string_list_append_item ($$, $3);
 460                 ralloc_steal ($$, $3);
 461         }
 462 ;
 463
 464 text_line:
 465         NEWLINE { $$ = NULL; }
 466 |       pp_tokens NEWLINE
 467 ;
 468
 469 non_directive:
 470         pp_tokens NEWLINE {
 471                 yyerror (& @1, parser, "Invalid tokens after #");
 472         }
 473 ;
 474
 475 replacement_list:
 476         /* empty */ { $$ = NULL; }
 477 |       pp_tokens
 478 ;
 479
 480 junk:
 481         /* empty */
 482 |       pp_tokens {
 483                 glcpp_warning(&@1, parser, "extra tokens at end of directive");
 484         }
 485 ;
 486
 487 conditional_token:
 488         /* Handle "defined" operator */
 489         DEFINED IDENTIFIER {
 490                 int v = hash_table_find (parser->defines, $2) ? 1 : 0;
 491                 $$ = _token_create_ival (parser, INTEGER, v);
 492         }
 493 |       DEFINED '(' IDENTIFIER ')' {
 494                 int v = hash_table_find (parser->defines, $3) ? 1 : 0;
 495                 $$ = _token_create_ival (parser, INTEGER, v);
 496         }
 497 |       preprocessing_token
 498 ;
 499
 500 conditional_tokens:
 501         /* Exactly the same as pp_tokens, but using conditional_token */
 502         conditional_token {
 503                 $$ = _token_list_create (parser);
 504                 _token_list_append ($$, $1);
 505         }
 506 |       conditional_tokens conditional_token {
 507                 $$ = $1;
 508                 _token_list_append ($$, $2);
 509         }
 510 ;
 511
 512 pp_tokens:
 513         preprocessing_token {
 514                 parser->space_tokens = 1;
 515                 $$ = _token_list_create (parser);
 516                 _token_list_append ($$, $1);
 517         }
 518 |       pp_tokens preprocessing_token {
 519                 $$ = $1;
 520                 _token_list_append ($$, $2);
 521         }
 522 ;
 523
 524 preprocessing_token:
 525         IDENTIFIER {
 526                 $$ = _token_create_str (parser, IDENTIFIER, $1);
 527                 $$->location = yylloc;
 528         }
 529 |       INTEGER_STRING {
 530                 $$ = _token_create_str (parser, INTEGER_STRING, $1);
 531                 $$->location = yylloc;
 532         }
 533 |       operator {
 534                 $$ = _token_create_ival (parser, $1, $1);
 535                 $$->location = yylloc;
 536         }
 537 |       OTHER {
 538                 $$ = _token_create_str (parser, OTHER, $1);
 539                 $$->location = yylloc;
 540         }
 541 |       SPACE {
 542                 $$ = _token_create_ival (parser, SPACE, SPACE);
 543                 $$->location = yylloc;
 544         }
 545 ;
 546
 547 operator:
 548         '['                     { $$ = '['; }
 549 |       ']'                     { $$ = ']'; }
 550 |       '('                     { $$ = '('; }
 551 |       ')'                     { $$ = ')'; }
 552 |       '{'                     { $$ = '{'; }
 553 |       '}'                     { $$ = '}'; }
 554 |       '.'                     { $$ = '.'; }
 555 |       '&'                     { $$ = '&'; }
 556 |       '*'                     { $$ = '*'; }
 557 |       '+'                     { $$ = '+'; }
 558 |       '-'                     { $$ = '-'; }
 559 |       '~'                     { $$ = '~'; }
 560 |       '!'                     { $$ = '!'; }
 561 |       '/'                     { $$ = '/'; }
 562 |       '%'                     { $$ = '%'; }
 563 |       LEFT_SHIFT              { $$ = LEFT_SHIFT; }
 564 |       RIGHT_SHIFT             { $$ = RIGHT_SHIFT; }
 565 |       '<'                     { $$ = '<'; }
 566 |       '>'                     { $$ = '>'; }
 567 |       LESS_OR_EQUAL           { $$ = LESS_OR_EQUAL; }
 568 |       GREATER_OR_EQUAL        { $$ = GREATER_OR_EQUAL; }
 569 |       EQUAL                   { $$ = EQUAL; }
 570 |       NOT_EQUAL               { $$ = NOT_EQUAL; }
 571 |       '^'                     { $$ = '^'; }
 572 |       '|'                     { $$ = '|'; }
 573 |       AND                     { $$ = AND; }
 574 |       OR                      { $$ = OR; }
 575 |       ';'                     { $$ = ';'; }
 576 |       ','                     { $$ = ','; }
 577 |       '='                     { $$ = '='; }
 578 |       PASTE                   { $$ = PASTE; }
 579 ;
 580
 581 %%
 582
 583 string_list_t *
 584 _string_list_create (void *ctx)
 585 {
 586         string_list_t *list;
 587
 588         list = ralloc (ctx, string_list_t);
 589         list->head = NULL;
 590         list->tail = NULL;
 591
 592         return list;
 593 }
 594
 595 void
 596 _string_list_append_item (string_list_t *list, const char *str)
 597 {
 598         string_node_t *node;
 599
 600         node = ralloc (list, string_node_t);
 601         node->str = ralloc_strdup (node, str);
 602
 603         node->next = NULL;
 604
 605         if (list->head == NULL) {
 606                 list->head = node;
 607         } else {
 608                 list->tail->next = node;
 609         }
 610
 611         list->tail = node;
 612 }
 613
 614 int
 615 _string_list_contains (string_list_t *list, const char *member, int *index)
 616 {
 617         string_node_t *node;
 618         int i;
 619
 620         if (list == NULL)
 621                 return 0;
 622
 623         for (i = 0, node = list->head; node; i++, node = node->next) {
 624                 if (strcmp (node->str, member) == 0) {
 625                         if (index)
 626                                 *index = i;
 627                         return 1;
 628                 }
 629         }
 630
 631         return 0;
 632 }
 633
 634 int
 635 _string_list_length (string_list_t *list)
 636 {
 637         int length = 0;
 638         string_node_t *node;
 639
 640         if (list == NULL)
 641                 return 0;
 642
 643         for (node = list->head; node; node = node->next)
 644                 length++;
 645
 646         return length;
 647 }
 648
 649 int
 650 _string_list_equal (string_list_t *a, string_list_t *b)
 651 {
 652         string_node_t *node_a, *node_b;
 653
 654         if (a == NULL && b == NULL)
 655                 return 1;
 656
 657         if (a == NULL || b == NULL)
 658                 return 0;
 659
 660         for (node_a = a->head, node_b = b->head;
 661              node_a && node_b;
 662              node_a = node_a->next, node_b = node_b->next)
 663         {
 664                 if (strcmp (node_a->str, node_b->str))
 665                         return 0;
 666         }
 667
 668         /* Catch the case of lists being different lengths, (which
 669          * would cause the loop above to terminate after the shorter
 670          * list). */
 671         return node_a == node_b;
 672 }
 673
 674 argument_list_t *
 675 _argument_list_create (void *ctx)
 676 {
 677         argument_list_t *list;
 678
 679         list = ralloc (ctx, argument_list_t);
 680         list->head = NULL;
 681         list->tail = NULL;
 682
 683         return list;
 684 }
 685
 686 void
 687 _argument_list_append (argument_list_t *list, token_list_t *argument)
 688 {
 689         argument_node_t *node;
 690
 691         node = ralloc (list, argument_node_t);
 692         node->argument = argument;
 693
 694         node->next = NULL;
 695
 696         if (list->head == NULL) {
 697                 list->head = node;
 698         } else {
 699                 list->tail->next = node;
 700         }
 701
 702         list->tail = node;
 703 }
 704
 705 int
 706 _argument_list_length (argument_list_t *list)
 707 {
 708         int length = 0;
 709         argument_node_t *node;
 710
 711         if (list == NULL)
 712                 return 0;
 713
 714         for (node = list->head; node; node = node->next)
 715                 length++;
 716
 717         return length;
 718 }
 719
 720 token_list_t *
 721 _argument_list_member_at (argument_list_t *list, int index)
 722 {
 723         argument_node_t *node;
 724         int i;
 725
 726         if (list == NULL)
 727                 return NULL;
 728
 729         node = list->head;
 730         for (i = 0; i < index; i++) {
 731                 node = node->next;
 732                 if (node == NULL)
 733                         break;
 734         }
 735
 736         if (node)
 737                 return node->argument;
 738
 739         return NULL;
 740 }
 741
 742 /* Note: This function ralloc_steal()s the str pointer. */
 743 token_t *
 744 _token_create_str (void *ctx, int type, char *str)
 745 {
 746         token_t *token;
 747
 748         token = ralloc (ctx, token_t);
 749         token->type = type;
 750         token->value.str = str;
 751
 752         ralloc_steal (token, str);
 753
 754         return token;
 755 }
 756
 757 token_t *
 758 _token_create_ival (void *ctx, int type, int ival)
 759 {
 760         token_t *token;
 761
 762         token = ralloc (ctx, token_t);
 763         token->type = type;
 764         token->value.ival = ival;
 765
 766         return token;
 767 }
 768
 769 token_list_t *
 770 _token_list_create (void *ctx)
 771 {
 772         token_list_t *list;
 773
 774         list = ralloc (ctx, token_list_t);
 775         list->head = NULL;
 776         list->tail = NULL;
 777         list->non_space_tail = NULL;
 778
 779         return list;
 780 }
 781
 782 void
 783 _token_list_append (token_list_t *list, token_t *token)
 784 {
 785         token_node_t *node;
 786
 787         node = ralloc (list, token_node_t);
 788         node->token = token;
 789         node->next = NULL;
 790
 791         if (list->head == NULL) {
 792                 list->head = node;
 793         } else {
 794                 list->tail->next = node;
 795         }
 796
 797         list->tail = node;
 798         if (token->type != SPACE)
 799                 list->non_space_tail = node;
 800 }
 801
 802 void
 803 _token_list_append_list (token_list_t *list, token_list_t *tail)
 804 {
 805         if (tail == NULL || tail->head == NULL)
 806                 return;
 807
 808         if (list->head == NULL) {
 809                 list->head = tail->head;
 810         } else {
 811                 list->tail->next = tail->head;
 812         }
 813
 814         list->tail = tail->tail;
 815         list->non_space_tail = tail->non_space_tail;
 816 }
 817
 818 static token_list_t *
 819 _token_list_copy (void *ctx, token_list_t *other)
 820 {
 821         token_list_t *copy;
 822         token_node_t *node;
 823
 824         if (other == NULL)
 825                 return NULL;
 826
 827         copy = _token_list_create (ctx);
 828         for (node = other->head; node; node = node->next) {
 829                 token_t *new_token = ralloc (copy, token_t);
 830                 *new_token = *node->token;
 831                 _token_list_append (copy, new_token);
 832         }
 833
 834         return copy;
 835 }
 836
 837 static void
 838 _token_list_trim_trailing_space (token_list_t *list)
 839 {
 840         token_node_t *tail, *next;
 841
 842         if (list->non_space_tail) {
 843                 tail = list->non_space_tail->next;
 844                 list->non_space_tail->next = NULL;
 845                 list->tail = list->non_space_tail;
 846
 847                 while (tail) {
 848                         next = tail->next;
 849                         ralloc_free (tail);
 850                         tail = next;
 851                 }
 852         }
 853 }
 854
 855 static int
 856 _token_list_is_empty_ignoring_space (token_list_t *l)
 857 {
 858         token_node_t *n;
 859
 860         if (l == NULL)
 861                 return 1;
 862
 863         n = l->head;
 864         while (n != NULL && n->token->type == SPACE)
 865                 n = n->next;
 866
 867         return n == NULL;
 868 }
 869
 870 int
 871 _token_list_equal_ignoring_space (token_list_t *a, token_list_t *b)
 872 {
 873         token_node_t *node_a, *node_b;
 874
 875         if (a == NULL || b == NULL) {
 876                 int a_empty = _token_list_is_empty_ignoring_space(a);
 877                 int b_empty = _token_list_is_empty_ignoring_space(b);
 878                 return a_empty == b_empty;
 879         }
 880
 881         node_a = a->head;
 882         node_b = b->head;
 883
 884         while (1)
 885         {
 886                 if (node_a == NULL && node_b == NULL)
 887                         break;
 888
 889                 if (node_a == NULL || node_b == NULL)
 890                         return 0;
 891
 892                 if (node_a->token->type == SPACE) {
 893                         node_a = node_a->next;
 894                         continue;
 895                 }
 896
 897                 if (node_b->token->type == SPACE) {
 898                         node_b = node_b->next;
 899                         continue;
 900                 }
 901
 902                 if (node_a->token->type != node_b->token->type)
 903                         return 0;
 904
 905                 switch (node_a->token->type) {
 906                 case INTEGER:
 907                         if (node_a->token->value.ival !=
 908                             node_b->token->value.ival)
 909                         {
 910                                 return 0;
 911                         }
 912                         break;
 913                 case IDENTIFIER:
 914                 case INTEGER_STRING:
 915                 case OTHER:
 916                         if (strcmp (node_a->token->value.str,
 917                                     node_b->token->value.str))
 918                         {
 919                                 return 0;
 920                         }
 921                         break;
 922                 }
 923
 924                 node_a = node_a->next;
 925                 node_b = node_b->next;
 926         }
 927
 928         return 1;
 929 }
 930
 931 static void
 932 _token_print (char **out, size_t *len, token_t *token)
 933 {
 934         if (token->type < 256) {
 935                 ralloc_asprintf_rewrite_tail (out, len, "%c", token->type);
 936                 return;
 937         }
 938
 939         switch (token->type) {
 940         case INTEGER:
 941                 ralloc_asprintf_rewrite_tail (out, len, "%" PRIiMAX, token->value.ival);
 942                 break;
 943         case IDENTIFIER:
 944         case INTEGER_STRING:
 945         case OTHER:
 946                 ralloc_asprintf_rewrite_tail (out, len, "%s", token->value.str);
 947                 break;
 948         case SPACE:
 949                 ralloc_asprintf_rewrite_tail (out, len, " ");
 950                 break;
 951         case LEFT_SHIFT:
 952                 ralloc_asprintf_rewrite_tail (out, len, "<<");
 953                 break;
 954         case RIGHT_SHIFT:
 955                 ralloc_asprintf_rewrite_tail (out, len, ">>");
 956                 break;
 957         case LESS_OR_EQUAL:
 958                 ralloc_asprintf_rewrite_tail (out, len, "<=");
 959                 break;
 960         case GREATER_OR_EQUAL:
 961                 ralloc_asprintf_rewrite_tail (out, len, ">=");
 962                 break;
 963         case EQUAL:
 964                 ralloc_asprintf_rewrite_tail (out, len, "==");
 965                 break;
 966         case NOT_EQUAL:
 967                 ralloc_asprintf_rewrite_tail (out, len, "!=");
 968                 break;
 969         case AND:
 970                 ralloc_asprintf_rewrite_tail (out, len, "&&");
 971                 break;
 972         case OR:
 973                 ralloc_asprintf_rewrite_tail (out, len, "||");
 974                 break;
 975         case PASTE:
 976                 ralloc_asprintf_rewrite_tail (out, len, "##");
 977                 break;
 978         case COMMA_FINAL:
 979                 ralloc_asprintf_rewrite_tail (out, len, ",");
 980                 break;
 981         case PLACEHOLDER:
 982                 /* Nothing to print. */
 983                 break;
 984         default:
 985                 assert(!"Error: Don't know how to print token.");
 986                 break;
 987         }
 988 }
 989
 990 /* Return a new token (ralloc()ed off of 'token') formed by pasting
 991  * 'token' and 'other'. Note that this function may return 'token' or
 992  * 'other' directly rather than allocating anything new.
 993  *
 994  * Caution: Only very cursory error-checking is performed to see if
 995  * the final result is a valid single token. */
 996 static token_t *
 997 _token_paste (glcpp_parser_t *parser, token_t *token, token_t *other)
 998 {
 999         token_t *combined = NULL;
1000
1001         /* Pasting a placeholder onto anything makes no change. */
1002         if (other->type == PLACEHOLDER)
1003                 return token;
1004
1005         /* When 'token' is a placeholder, just return 'other'. */
1006         if (token->type == PLACEHOLDER)
1007                 return other;
1008
1009         /* A very few single-character punctuators can be combined
1010          * with another to form a multi-character punctuator. */
1011         switch (token->type) {
1012         case '<':
1013                 if (other->type == '<')
1014                         combined = _token_create_ival (token, LEFT_SHIFT, LEFT_SHIFT);
1015                 else if (other->type == '=')
1016                         combined = _token_create_ival (token, LESS_OR_EQUAL, LESS_OR_EQUAL);
1017                 break;
1018         case '>':
1019                 if (other->type == '>')
1020                         combined = _token_create_ival (token, RIGHT_SHIFT, RIGHT_SHIFT);
1021                 else if (other->type == '=')
1022                         combined = _token_create_ival (token, GREATER_OR_EQUAL, GREATER_OR_EQUAL);
1023                 break;
1024         case '=':
1025                 if (other->type == '=')
1026                         combined = _token_create_ival (token, EQUAL, EQUAL);
1027                 break;
1028         case '!':
1029                 if (other->type == '=')
1030                         combined = _token_create_ival (token, NOT_EQUAL, NOT_EQUAL);
1031                 break;
1032         case '&':
1033                 if (other->type == '&')
1034                         combined = _token_create_ival (token, AND, AND);
1035                 break;
1036         case '|':
1037                 if (other->type == '|')
1038                         combined = _token_create_ival (token, OR, OR);
1039                 break;
1040         }
1041
1042         if (combined != NULL) {
1043                 /* Inherit the location from the first token */
1044                 combined->location = token->location;
1045                 return combined;
1046         }
1047
1048         /* Two string-valued (or integer) tokens can usually just be
1049          * mashed together. (We also handle a string followed by an
1050          * integer here as well.)
1051          *
1052          * There are some exceptions here. Notably, if the first token
1053          * is an integer (or a string representing an integer), then
1054          * the second token must also be an integer or must be a
1055          * string representing an integer that begins with a digit.
1056          */
1057         if ((token->type == IDENTIFIER || token->type == OTHER || token->type == INTEGER_STRING || token->type == INTEGER) &&
1058             (other->type == IDENTIFIER || other->type == OTHER || other->type == INTEGER_STRING || other->type == INTEGER))
1059         {
1060                 char *str;
1061                 int combined_type;
1062
1063                 /* Check that pasting onto an integer doesn't create a
1064                  * non-integer, (that is, only digits can be
1065                  * pasted. */
1066                 if (token->type == INTEGER_STRING || token->type == INTEGER)
1067                 {
1068                         switch (other->type) {
1069                         case INTEGER_STRING:
1070                                 if (other->value.str[0] < '0' ||
1071                                     other->value.str[0] > '9')
1072                                         goto FAIL;
1073                                 break;
1074                         case INTEGER:
1075                                 if (other->value.ival < 0)
1076                                         goto FAIL;
1077                                 break;
1078                         default:
1079                                 goto FAIL;
1080                         }
1081                 }
1082
1083                 if (token->type == INTEGER)
1084                         str = ralloc_asprintf (token, "%" PRIiMAX,
1085                                                token->value.ival);
1086                 else
1087                         str = ralloc_strdup (token, token->value.str);
1088
1089
1090                 if (other->type == INTEGER)
1091                         ralloc_asprintf_append (&str, "%" PRIiMAX,
1092                                                 other->value.ival);
1093                 else
1094                         ralloc_strcat (&str, other->value.str);
1095
1096                 /* New token is same type as original token, unless we
1097                  * started with an integer, in which case we will be
1098                  * creating an integer-string. */
1099                 combined_type = token->type;
1100                 if (combined_type == INTEGER)
1101                         combined_type = INTEGER_STRING;
1102
1103                 combined = _token_create_str (token, combined_type, str);
1104                 combined->location = token->location;
1105                 return combined;
1106         }
1107
1108     FAIL:
1109         glcpp_error (&token->location, parser, "");
1110         ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "Pasting \"");
1111         _token_print (&parser->info_log, &parser->info_log_length, token);
1112         ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "\" and \"");
1113         _token_print (&parser->info_log, &parser->info_log_length, other);
1114         ralloc_asprintf_rewrite_tail (&parser->info_log, &parser->info_log_length, "\" does not give a valid preprocessing token.\n");
1115
1116         return token;
1117 }
1118
1119 static void
1120 _token_list_print (glcpp_parser_t *parser, token_list_t *list)
1121 {
1122         token_node_t *node;
1123
1124         if (list == NULL)
1125                 return;
1126
1127         for (node = list->head; node; node = node->next)
1128                 _token_print (&parser->output, &parser->output_length, node->token);
1129 }
1130
1131 void
1132 yyerror (YYLTYPE *locp, glcpp_parser_t *parser, const char *error)
1133 {
1134         glcpp_error(locp, parser, "%s", error);
1135 }
1136
1137 static void add_builtin_define(glcpp_parser_t *parser,
1138                                const char *name, int value)
1139 {
1140    token_t *tok;
1141    token_list_t *list;
1142
1143    tok = _token_create_ival (parser, INTEGER, value);
1144
1145    list = _token_list_create(parser);
1146    _token_list_append(list, tok);
1147    _define_object_macro(parser, NULL, name, list);
1148 }
1149
1150 glcpp_parser_t *
1151 glcpp_parser_create (const struct gl_extensions *extensions, int api)
1152 {
1153         glcpp_parser_t *parser;
1154         int language_version;
1155
1156         parser = ralloc (NULL, glcpp_parser_t);
1157
1158         glcpp_lex_init_extra (parser, &parser->scanner);
1159         parser->defines = hash_table_ctor (32, hash_table_string_hash,
1160                                            hash_table_string_compare);
1161         parser->active = NULL;
1162         parser->lexing_if = 0;
1163         parser->space_tokens = 1;
1164         parser->newline_as_space = 0;
1165         parser->in_control_line = 0;
1166         parser->paren_count = 0;
1167
1168         parser->skip_stack = NULL;
1169
1170         parser->lex_from_list = NULL;
1171         parser->lex_from_node = NULL;
1172
1173         parser->output = ralloc_strdup(parser, "");
1174         parser->output_length = 0;
1175         parser->info_log = ralloc_strdup(parser, "");
1176         parser->info_log_length = 0;
1177         parser->error = 0;
1178
1179         parser->has_new_line_number = 0;
1180         parser->new_line_number = 1;
1181         parser->has_new_source_number = 0;
1182         parser->new_source_number = 0;
1183
1184         parser->is_gles = false;
1185
1186         /* Add pre-defined macros. */
1187         if (extensions != NULL) {
1188            if (extensions->OES_EGL_image_external)
1189               add_builtin_define(parser, "GL_OES_EGL_image_external", 1);
1190         }
1191
1192         if (api == API_OPENGLES2) {
1193                 parser->is_gles = true;
1194                 add_builtin_define(parser, "GL_ES", 1);
1195         } else {
1196            add_builtin_define(parser, "GL_ARB_draw_buffers", 1);
1197            add_builtin_define(parser, "GL_ARB_texture_rectangle", 1);
1198
1199            if (extensions != NULL) {
1200               if (extensions->EXT_texture_array) {
1201                  add_builtin_define(parser, "GL_EXT_texture_array", 1);
1202               }
1203
1204               if (extensions->ARB_fragment_coord_conventions)
1205                  add_builtin_define(parser, "GL_ARB_fragment_coord_conventions",
1206                                     1);
1207
1208               if (extensions->ARB_explicit_attrib_location)
1209                  add_builtin_define(parser, "GL_ARB_explicit_attrib_location", 1);
1210
1211               if (extensions->ARB_shader_texture_lod)
1212                  add_builtin_define(parser, "GL_ARB_shader_texture_lod", 1);
1213
1214               if (extensions->ARB_draw_instanced)
1215                  add_builtin_define(parser, "GL_ARB_draw_instanced", 1);
1216
1217               if (extensions->ARB_conservative_depth) {
1218                  add_builtin_define(parser, "GL_AMD_conservative_depth", 1);
1219                  add_builtin_define(parser, "GL_ARB_conservative_depth", 1);
1220               }
1221
1222               if (extensions->ARB_shader_bit_encoding)
1223                  add_builtin_define(parser, "GL_ARB_shader_bit_encoding", 1);
1224
1225               if (extensions->ARB_uniform_buffer_object)
1226                  add_builtin_define(parser, "GL_ARB_uniform_buffer_object", 1);
1227
1228               if (extensions->ARB_texture_cube_map_array)
1229                  add_builtin_define(parser, "GL_ARB_texture_cube_map_array", 1);
1230            }
1231         }
1232
1233         language_version = 110;
1234         add_builtin_define(parser, "__VERSION__", language_version);
1235
1236         return parser;
1237 }
1238
1239 void
1240 glcpp_parser_destroy (glcpp_parser_t *parser)
1241 {
1242         glcpp_lex_destroy (parser->scanner);
1243         hash_table_dtor (parser->defines);
1244         ralloc_free (parser);
1245 }
1246
1247 typedef enum function_status
1248 {
1249         FUNCTION_STATUS_SUCCESS,
1250         FUNCTION_NOT_A_FUNCTION,
1251         FUNCTION_UNBALANCED_PARENTHESES
1252 } function_status_t;
1253
1254 /* Find a set of function-like macro arguments by looking for a
1255  * balanced set of parentheses.
1256  *
1257  * When called, 'node' should be the opening-parenthesis token, (or
1258  * perhaps preceeding SPACE tokens). Upon successful return *last will
1259  * be the last consumed node, (corresponding to the closing right
1260  * parenthesis).
1261  *
1262  * Return values:
1263  *
1264  *   FUNCTION_STATUS_SUCCESS:
1265  *
1266  *      Successfully parsed a set of function arguments.
1267  *
1268  *   FUNCTION_NOT_A_FUNCTION:
1269  *
1270  *      Macro name not followed by a '('. This is not an error, but
1271  *      simply that the macro name should be treated as a non-macro.
1272  *
1273  *   FUNCTION_UNBALANCED_PARENTHESES
1274  *
1275  *      Macro name is not followed by a balanced set of parentheses.
1276  */
1277 static function_status_t
1278 _arguments_parse (argument_list_t *arguments,
1279                   token_node_t *node,
1280                   token_node_t **last)
1281 {
1282         token_list_t *argument;
1283         int paren_count;
1284
1285         node = node->next;
1286
1287         /* Ignore whitespace before first parenthesis. */
1288         while (node && node->token->type == SPACE)
1289                 node = node->next;
1290
1291         if (node == NULL || node->token->type != '(')
1292                 return FUNCTION_NOT_A_FUNCTION;
1293
1294         node = node->next;
1295
1296         argument = _token_list_create (arguments);
1297         _argument_list_append (arguments, argument);
1298
1299         for (paren_count = 1; node; node = node->next) {
1300                 if (node->token->type == '(')
1301                 {
1302                         paren_count++;
1303                 }
1304                 else if (node->token->type == ')')
1305                 {
1306                         paren_count--;
1307                         if (paren_count == 0)
1308                                 break;
1309                 }
1310
1311                 if (node->token->type == ',' &&
1312                          paren_count == 1)
1313                 {
1314                         _token_list_trim_trailing_space (argument);
1315                         argument = _token_list_create (arguments);
1316                         _argument_list_append (arguments, argument);
1317                 }
1318                 else {
1319                         if (argument->head == NULL) {
1320                                 /* Don't treat initial whitespace as
1321                                  * part of the arguement. */
1322                                 if (node->token->type == SPACE)
1323                                         continue;
1324                         }
1325                         _token_list_append (argument, node->token);
1326                 }
1327         }
1328
1329         if (paren_count)
1330                 return FUNCTION_UNBALANCED_PARENTHESES;
1331
1332         *last = node;
1333
1334         return FUNCTION_STATUS_SUCCESS;
1335 }
1336
1337 static token_list_t *
1338 _token_list_create_with_one_ival (void *ctx, int type, int ival)
1339 {
1340         token_list_t *list;
1341         token_t *node;
1342
1343         list = _token_list_create (ctx);
1344         node = _token_create_ival (list, type, ival);
1345         _token_list_append (list, node);
1346
1347         return list;
1348 }
1349
1350 static token_list_t *
1351 _token_list_create_with_one_space (void *ctx)
1352 {
1353         return _token_list_create_with_one_ival (ctx, SPACE, SPACE);
1354 }
1355
1356 static token_list_t *
1357 _token_list_create_with_one_integer (void *ctx, int ival)
1358 {
1359         return _token_list_create_with_one_ival (ctx, INTEGER, ival);
1360 }
1361
1362 /* Perform macro expansion on 'list', placing the resulting tokens
1363  * into a new list which is initialized with a first token of type
1364  * 'head_token_type'. Then begin lexing from the resulting list,
1365  * (return to the current lexing source when this list is exhausted).
1366  */
1367 static void
1368 _glcpp_parser_expand_and_lex_from (glcpp_parser_t *parser,
1369                                    int head_token_type,
1370                                    token_list_t *list)
1371 {
1372         token_list_t *expanded;
1373         token_t *token;
1374
1375         expanded = _token_list_create (parser);
1376         token = _token_create_ival (parser, head_token_type, head_token_type);
1377         _token_list_append (expanded, token);
1378         _glcpp_parser_expand_token_list (parser, list);
1379         _token_list_append_list (expanded, list);
1380         glcpp_parser_lex_from (parser, expanded);
1381 }
1382
1383 static void
1384 _glcpp_parser_apply_pastes (glcpp_parser_t *parser, token_list_t *list)
1385 {
1386         token_node_t *node;
1387
1388         node = list->head;
1389         while (node)
1390         {
1391                 token_node_t *next_non_space;
1392
1393                 /* Look ahead for a PASTE token, skipping space. */
1394                 next_non_space = node->next;
1395                 while (next_non_space && next_non_space->token->type == SPACE)
1396                         next_non_space = next_non_space->next;
1397
1398                 if (next_non_space == NULL)
1399                         break;
1400
1401                 if (next_non_space->token->type != PASTE) {
1402                         node = next_non_space;
1403                         continue;
1404                 }
1405
1406                 /* Now find the next non-space token after the PASTE. */
1407                 next_non_space = next_non_space->next;
1408                 while (next_non_space && next_non_space->token->type == SPACE)
1409                         next_non_space = next_non_space->next;
1410
1411                 if (next_non_space == NULL) {
1412                         yyerror (&node->token->location, parser, "'##' cannot appear at either end of a macro expansion\n");
1413                         return;
1414                 }
1415
1416                 node->token = _token_paste (parser, node->token, next_non_space->token);
1417                 node->next = next_non_space->next;
1418                 if (next_non_space == list->tail)
1419                         list->tail = node;
1420         }
1421
1422         list->non_space_tail = list->tail;
1423 }
1424
1425 /* This is a helper function that's essentially part of the
1426  * implementation of _glcpp_parser_expand_node. It shouldn't be called
1427  * except for by that function.
1428  *
1429  * Returns NULL if node is a simple token with no expansion, (that is,
1430  * although 'node' corresponds to an identifier defined as a
1431  * function-like macro, it is not followed with a parenthesized
1432  * argument list).
1433  *
1434  * Compute the complete expansion of node (which is a function-like
1435  * macro) and subsequent nodes which are arguments.
1436  *
1437  * Returns the token list that results from the expansion and sets
1438  * *last to the last node in the list that was consumed by the
1439  * expansion. Specifically, *last will be set as follows: as the
1440  * token of the closing right parenthesis.
1441  */
1442 static token_list_t *
1443 _glcpp_parser_expand_function (glcpp_parser_t *parser,
1444                                token_node_t *node,
1445                                token_node_t **last)
1446
1447 {
1448         macro_t *macro;
1449         const char *identifier;
1450         argument_list_t *arguments;
1451         function_status_t status;
1452         token_list_t *substituted;
1453         int parameter_index;
1454
1455         identifier = node->token->value.str;
1456
1457         macro = hash_table_find (parser->defines, identifier);
1458
1459         assert (macro->is_function);
1460
1461         arguments = _argument_list_create (parser);
1462         status = _arguments_parse (arguments, node, last);
1463
1464         switch (status) {
1465         case FUNCTION_STATUS_SUCCESS:
1466                 break;
1467         case FUNCTION_NOT_A_FUNCTION:
1468                 return NULL;
1469         case FUNCTION_UNBALANCED_PARENTHESES:
1470                 glcpp_error (&node->token->location, parser, "Macro %s call has unbalanced parentheses\n", identifier);
1471                 return NULL;
1472         }
1473
1474         /* Replace a macro defined as empty with a SPACE token. */
1475         if (macro->replacements == NULL) {
1476                 ralloc_free (arguments);
1477                 return _token_list_create_with_one_space (parser);
1478         }
1479
1480         if (! ((_argument_list_length (arguments) ==
1481                 _string_list_length (macro->parameters)) ||
1482                (_string_list_length (macro->parameters) == 0 &&
1483                 _argument_list_length (arguments) == 1 &&
1484                 arguments->head->argument->head == NULL)))
1485         {
1486                 glcpp_error (&node->token->location, parser,
1487                               "Error: macro %s invoked with %d arguments (expected %d)\n",
1488                               identifier,
1489                               _argument_list_length (arguments),
1490                               _string_list_length (macro->parameters));
1491                 return NULL;
1492         }
1493
1494         /* Perform argument substitution on the replacement list. */
1495         substituted = _token_list_create (arguments);
1496
1497         for (node = macro->replacements->head; node; node = node->next)
1498         {
1499                 if (node->token->type == IDENTIFIER &&
1500                     _string_list_contains (macro->parameters,
1501                                            node->token->value.str,
1502                                            &parameter_index))
1503                 {
1504                         token_list_t *argument;
1505                         argument = _argument_list_member_at (arguments,
1506                                                              parameter_index);
1507                         /* Before substituting, we expand the argument
1508                          * tokens, or append a placeholder token for
1509                          * an empty argument. */
1510                         if (argument->head) {
1511                                 token_list_t *expanded_argument;
1512                                 expanded_argument = _token_list_copy (parser,
1513                                                                       argument);
1514                                 _glcpp_parser_expand_token_list (parser,
1515                                                                  expanded_argument);
1516                                 _token_list_append_list (substituted,
1517                                                          expanded_argument);
1518                         } else {
1519                                 token_t *new_token;
1520
1521                                 new_token = _token_create_ival (substituted,
1522                                                                 PLACEHOLDER,
1523                                                                 PLACEHOLDER);
1524                                 _token_list_append (substituted, new_token);
1525                         }
1526                 } else {
1527                         _token_list_append (substituted, node->token);
1528                 }
1529         }
1530
1531         /* After argument substitution, and before further expansion
1532          * below, implement token pasting. */
1533
1534         _token_list_trim_trailing_space (substituted);
1535
1536         _glcpp_parser_apply_pastes (parser, substituted);
1537
1538         return substituted;
1539 }
1540
1541 /* Compute the complete expansion of node, (and subsequent nodes after
1542  * 'node' in the case that 'node' is a function-like macro and
1543  * subsequent nodes are arguments).
1544  *
1545  * Returns NULL if node is a simple token with no expansion.
1546  *
1547  * Otherwise, returns the token list that results from the expansion
1548  * and sets *last to the last node in the list that was consumed by
1549  * the expansion. Specifically, *last will be set as follows:
1550  *
1551  *      As 'node' in the case of object-like macro expansion.
1552  *
1553  *      As the token of the closing right parenthesis in the case of
1554  *      function-like macro expansion.
1555  */
1556 static token_list_t *
1557 _glcpp_parser_expand_node (glcpp_parser_t *parser,
1558                            token_node_t *node,
1559                            token_node_t **last)
1560 {
1561         token_t *token = node->token;
1562         const char *identifier;
1563         macro_t *macro;
1564
1565         /* We only expand identifiers */
1566         if (token->type != IDENTIFIER) {
1567                 /* We change any COMMA into a COMMA_FINAL to prevent
1568                  * it being mistaken for an argument separator
1569                  * later. */
1570                 if (token->type == ',') {
1571                         token->type = COMMA_FINAL;
1572                         token->value.ival = COMMA_FINAL;
1573                 }
1574
1575                 return NULL;
1576         }
1577
1578         *last = node;
1579         identifier = token->value.str;
1580
1581         /* Special handling for __LINE__ and __FILE__, (not through
1582          * the hash table). */
1583         if (strcmp(identifier, "__LINE__") == 0)
1584                 return _token_list_create_with_one_integer (parser, node->token->location.first_line);
1585
1586         if (strcmp(identifier, "__FILE__") == 0)
1587                 return _token_list_create_with_one_integer (parser, node->token->location.source);
1588
1589         /* Look up this identifier in the hash table. */
1590         macro = hash_table_find (parser->defines, identifier);
1591
1592         /* Not a macro, so no expansion needed. */
1593         if (macro == NULL)
1594                 return NULL;
1595
1596         /* Finally, don't expand this macro if we're already actively
1597          * expanding it, (to avoid infinite recursion). */
1598         if (_parser_active_list_contains (parser, identifier)) {
1599                 /* We change the token type here from IDENTIFIER to
1600                  * OTHER to prevent any future expansion of this
1601                  * unexpanded token. */
1602                 char *str;
1603                 token_list_t *expansion;
1604                 token_t *final;
1605
1606                 str = ralloc_strdup (parser, token->value.str);
1607                 final = _token_create_str (parser, OTHER, str);
1608                 expansion = _token_list_create (parser);
1609                 _token_list_append (expansion, final);
1610                 return expansion;
1611         }
1612
1613         if (! macro->is_function)
1614         {
1615                 token_list_t *replacement;
1616
1617                 /* Replace a macro defined as empty with a SPACE token. */
1618                 if (macro->replacements == NULL)
1619                         return _token_list_create_with_one_space (parser);
1620
1621                 replacement = _token_list_copy (parser, macro->replacements);
1622                 _glcpp_parser_apply_pastes (parser, replacement);
1623                 return replacement;
1624         }
1625
1626         return _glcpp_parser_expand_function (parser, node, last);
1627 }
1628
1629 /* Push a new identifier onto the parser's active list.
1630  *
1631  * Here, 'marker' is the token node that appears in the list after the
1632  * expansion of 'identifier'. That is, when the list iterator begins
1633  * examining 'marker', then it is time to pop this node from the
1634  * active stack.
1635  */
1636 static void
1637 _parser_active_list_push (glcpp_parser_t *parser,
1638                           const char *identifier,
1639                           token_node_t *marker)
1640 {
1641         active_list_t *node;
1642
1643         node = ralloc (parser->active, active_list_t);
1644         node->identifier = ralloc_strdup (node, identifier);
1645         node->marker = marker;
1646         node->next = parser->active;
1647
1648         parser->active = node;
1649 }
1650
1651 static void
1652 _parser_active_list_pop (glcpp_parser_t *parser)
1653 {
1654         active_list_t *node = parser->active;
1655
1656         if (node == NULL) {
1657                 parser->active = NULL;
1658                 return;
1659         }
1660
1661         node = parser->active->next;
1662         ralloc_free (parser->active);
1663
1664         parser->active = node;
1665 }
1666
1667 static int
1668 _parser_active_list_contains (glcpp_parser_t *parser, const char *identifier)
1669 {
1670         active_list_t *node;
1671
1672         if (parser->active == NULL)
1673                 return 0;
1674
1675         for (node = parser->active; node; node = node->next)
1676                 if (strcmp (node->identifier, identifier) == 0)
1677                         return 1;
1678
1679         return 0;
1680 }
1681
1682 /* Walk over the token list replacing nodes with their expansion.
1683  * Whenever nodes are expanded the walking will walk over the new
1684  * nodes, continuing to expand as necessary. The results are placed in
1685  * 'list' itself;
1686  */
1687 static void
1688 _glcpp_parser_expand_token_list (glcpp_parser_t *parser,
1689                                  token_list_t *list)
1690 {
1691         token_node_t *node_prev;
1692         token_node_t *node, *last = NULL;
1693         token_list_t *expansion;
1694         active_list_t *active_initial = parser->active;
1695
1696         if (list == NULL)
1697                 return;
1698
1699         _token_list_trim_trailing_space (list);
1700
1701         node_prev = NULL;
1702         node = list->head;
1703
1704         while (node) {
1705
1706                 while (parser->active && parser->active->marker == node)
1707                         _parser_active_list_pop (parser);
1708
1709                 expansion = _glcpp_parser_expand_node (parser, node, &last);
1710                 if (expansion) {
1711                         token_node_t *n;
1712
1713                         for (n = node; n != last->next; n = n->next)
1714                                 while (parser->active &&
1715                                        parser->active->marker == n)
1716                                 {
1717                                         _parser_active_list_pop (parser);
1718                                 }
1719
1720                         _parser_active_list_push (parser,
1721                                                   node->token->value.str,
1722                                                   last->next);
1723
1724                         /* Splice expansion into list, supporting a
1725                          * simple deletion if the expansion is
1726                          * empty. */
1727                         if (expansion->head) {
1728                                 if (node_prev)
1729                                         node_prev->next = expansion->head;
1730                                 else
1731                                         list->head = expansion->head;
1732                                 expansion->tail->next = last->next;
1733                                 if (last == list->tail)
1734                                         list->tail = expansion->tail;
1735                         } else {
1736                                 if (node_prev)
1737                                         node_prev->next = last->next;
1738                                 else
1739                                         list->head = last->next;
1740                                 if (last == list->tail)
1741                                         list->tail = NULL;
1742                         }
1743                 } else {
1744                         node_prev = node;
1745                 }
1746                 node = node_prev ? node_prev->next : list->head;
1747         }
1748
1749         /* Remove any lingering effects of this invocation on the
1750          * active list. That is, pop until the list looks like it did
1751          * at the beginning of this function. */
1752         while (parser->active && parser->active != active_initial)
1753                 _parser_active_list_pop (parser);
1754
1755         list->non_space_tail = list->tail;
1756 }
1757
1758 void
1759 _glcpp_parser_print_expanded_token_list (glcpp_parser_t *parser,
1760                                          token_list_t *list)
1761 {
1762         if (list == NULL)
1763                 return;
1764
1765         _glcpp_parser_expand_token_list (parser, list);
1766
1767         _token_list_trim_trailing_space (list);
1768
1769         _token_list_print (parser, list);
1770 }
1771
1772 static void
1773 _check_for_reserved_macro_name (glcpp_parser_t *parser, YYLTYPE *loc,
1774                                 const char *identifier)
1775 {
1776         /* According to the GLSL specification, macro names starting with "__"
1777          * or "GL_" are reserved for future use.  So, don't allow them.
1778          */
1779         if (strstr(identifier, "__")) {
1780                 glcpp_error (loc, parser, "Macro names containing \"__\" are reserved.\n");
1781         }
1782         if (strncmp(identifier, "GL_", 3) == 0) {
1783                 glcpp_error (loc, parser, "Macro names starting with \"GL_\" are reserved.\n");
1784         }
1785 }
1786
1787 static int
1788 _macro_equal (macro_t *a, macro_t *b)
1789 {
1790         if (a->is_function != b->is_function)
1791                 return 0;
1792
1793         if (a->is_function) {
1794                 if (! _string_list_equal (a->parameters, b->parameters))
1795                         return 0;
1796         }
1797
1798         return _token_list_equal_ignoring_space (a->replacements,
1799                                                  b->replacements);
1800 }
1801
1802 void
1803 _define_object_macro (glcpp_parser_t *parser,
1804                       YYLTYPE *loc,
1805                       const char *identifier,
1806                       token_list_t *replacements)
1807 {
1808         macro_t *macro, *previous;
1809
1810         if (loc != NULL)
1811                 _check_for_reserved_macro_name(parser, loc, identifier);
1812
1813         macro = ralloc (parser, macro_t);
1814
1815         macro->is_function = 0;
1816         macro->parameters = NULL;
1817         macro->identifier = ralloc_strdup (macro, identifier);
1818         macro->replacements = replacements;
1819         ralloc_steal (macro, replacements);
1820
1821         previous = hash_table_find (parser->defines, identifier);
1822         if (previous) {
1823                 if (_macro_equal (macro, previous)) {
1824                         ralloc_free (macro);
1825                         return;
1826                 }
1827                 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1828                              identifier);
1829         }
1830
1831         hash_table_insert (parser->defines, macro, identifier);
1832 }
1833
1834 void
1835 _define_function_macro (glcpp_parser_t *parser,
1836                         YYLTYPE *loc,
1837                         const char *identifier,
1838                         string_list_t *parameters,
1839                         token_list_t *replacements)
1840 {
1841         macro_t *macro, *previous;
1842
1843         _check_for_reserved_macro_name(parser, loc, identifier);
1844
1845         macro = ralloc (parser, macro_t);
1846         ralloc_steal (macro, parameters);
1847         ralloc_steal (macro, replacements);
1848
1849         macro->is_function = 1;
1850         macro->parameters = parameters;
1851         macro->identifier = ralloc_strdup (macro, identifier);
1852         macro->replacements = replacements;
1853         previous = hash_table_find (parser->defines, identifier);
1854         if (previous) {
1855                 if (_macro_equal (macro, previous)) {
1856                         ralloc_free (macro);
1857                         return;
1858                 }
1859                 glcpp_error (loc, parser, "Redefinition of macro %s\n",
1860                              identifier);
1861         }
1862
1863         hash_table_insert (parser->defines, macro, identifier);
1864 }
1865
1866 static int
1867 glcpp_parser_lex (YYSTYPE *yylval, YYLTYPE *yylloc, glcpp_parser_t *parser)
1868 {
1869         token_node_t *node;
1870         int ret;
1871
1872         if (parser->lex_from_list == NULL) {
1873                 ret = glcpp_lex (yylval, yylloc, parser->scanner);
1874
1875                 /* XXX: This ugly block of code exists for the sole
1876                  * purpose of converting a NEWLINE token into a SPACE
1877                  * token, but only in the case where we have seen a
1878                  * function-like macro name, but have not yet seen its
1879                  * closing parenthesis.
1880                  *
1881                  * There's perhaps a more compact way to do this with
1882                  * mid-rule actions in the grammar.
1883                  *
1884                  * I'm definitely not pleased with the complexity of
1885                  * this code here.
1886                  */
1887                 if (parser->newline_as_space)
1888                 {
1889                         if (ret == '(') {
1890                                 parser->paren_count++;
1891                         } else if (ret == ')') {
1892                                 parser->paren_count--;
1893                                 if (parser->paren_count == 0)
1894                                         parser->newline_as_space = 0;
1895                         } else if (ret == NEWLINE) {
1896                                 ret = SPACE;
1897                         } else if (ret != SPACE) {
1898                                 if (parser->paren_count == 0)
1899                                         parser->newline_as_space = 0;
1900                         }
1901                 }
1902                 else if (parser->in_control_line)
1903                 {
1904                         if (ret == NEWLINE)
1905                                 parser->in_control_line = 0;
1906                 }
1907                 else if (ret == HASH_DEFINE ||
1908                            ret == HASH_UNDEF || ret == HASH_IF ||
1909                            ret == HASH_IFDEF || ret == HASH_IFNDEF ||
1910                            ret == HASH_ELIF || ret == HASH_ELSE ||
1911                            ret == HASH_ENDIF || ret == HASH)
1912                 {
1913                         parser->in_control_line = 1;
1914                 }
1915                 else if (ret == IDENTIFIER)
1916                 {
1917                         macro_t *macro;
1918                         macro = hash_table_find (parser->defines,
1919                                                  yylval->str);
1920                         if (macro && macro->is_function) {
1921                                 parser->newline_as_space = 1;
1922                                 parser->paren_count = 0;
1923                         }
1924                 }
1925
1926                 return ret;
1927         }
1928
1929         node = parser->lex_from_node;
1930
1931         if (node == NULL) {
1932                 ralloc_free (parser->lex_from_list);
1933                 parser->lex_from_list = NULL;
1934                 return NEWLINE;
1935         }
1936
1937         *yylval = node->token->value;
1938         ret = node->token->type;
1939
1940         parser->lex_from_node = node->next;
1941
1942         return ret;
1943 }
1944
1945 static void
1946 glcpp_parser_lex_from (glcpp_parser_t *parser, token_list_t *list)
1947 {
1948         token_node_t *node;
1949
1950         assert (parser->lex_from_list == NULL);
1951
1952         /* Copy list, eliminating any space tokens. */
1953         parser->lex_from_list = _token_list_create (parser);
1954
1955         for (node = list->head; node; node = node->next) {
1956                 if (node->token->type == SPACE)
1957                         continue;
1958                 _token_list_append (parser->lex_from_list, node->token);
1959         }
1960
1961         ralloc_free (list);
1962
1963         parser->lex_from_node = parser->lex_from_list->head;
1964
1965         /* It's possible the list consisted of nothing but whitespace. */
1966         if (parser->lex_from_node == NULL) {
1967                 ralloc_free (parser->lex_from_list);
1968                 parser->lex_from_list = NULL;
1969         }
1970 }
1971
1972 static void
1973 _glcpp_parser_skip_stack_push_if (glcpp_parser_t *parser, YYLTYPE *loc,
1974                                   int condition)
1975 {
1976         skip_type_t current = SKIP_NO_SKIP;
1977         skip_node_t *node;
1978
1979         if (parser->skip_stack)
1980                 current = parser->skip_stack->type;
1981
1982         node = ralloc (parser, skip_node_t);
1983         node->loc = *loc;
1984
1985         if (current == SKIP_NO_SKIP) {
1986                 if (condition)
1987                         node->type = SKIP_NO_SKIP;
1988                 else
1989                         node->type = SKIP_TO_ELSE;
1990         } else {
1991                 node->type = SKIP_TO_ENDIF;
1992         }
1993
1994         node->next = parser->skip_stack;
1995         parser->skip_stack = node;
1996 }
1997
1998 static void
1999 _glcpp_parser_skip_stack_change_if (glcpp_parser_t *parser, YYLTYPE *loc,
2000                                     const char *type, int condition)
2001 {
2002         if (parser->skip_stack == NULL) {
2003                 glcpp_error (loc, parser, "%s without #if\n", type);
2004                 return;
2005         }
2006
2007         if (parser->skip_stack->type == SKIP_TO_ELSE) {
2008                 if (condition)
2009                         parser->skip_stack->type = SKIP_NO_SKIP;
2010         } else {
2011                 parser->skip_stack->type = SKIP_TO_ENDIF;
2012         }
2013 }
2014
2015 static void
2016 _glcpp_parser_skip_stack_pop (glcpp_parser_t *parser, YYLTYPE *loc)
2017 {
2018         skip_node_t *node;
2019
2020         if (parser->skip_stack == NULL) {
2021                 glcpp_error (loc, parser, "#endif without #if\n");
2022                 return;
2023         }
2024
2025         node = parser->skip_stack;
2026         parser->skip_stack = node->next;
2027         ralloc_free (node);
2028 }
2029
2030 static void
2031 _glcpp_parser_handle_version_declaration(glcpp_parser_t *parser, intmax_t version,
2032                                          const char *es_identifier)
2033 {
2034         macro_t *macro = hash_table_find (parser->defines, "__VERSION__");
2035         if (macro) {
2036                 hash_table_remove (parser->defines, "__VERSION__");
2037                 ralloc_free (macro);
2038         }
2039         add_builtin_define (parser, "__VERSION__", version);
2040
2041         /* If we didn't have a GLES context to begin with, (indicated
2042          * by parser->api), then the version declaration here might
2043          * indicate GLES. */
2044         if (! parser->is_gles &&
2045             (version == 100 ||
2046              (es_identifier && (strcmp(es_identifier, "es") == 0))))
2047         {
2048                 parser->is_gles = true;
2049                 add_builtin_define (parser, "GL_ES", 1);
2050         }
2051
2052         /* Currently, all ES2/ES3 implementations support highp in the
2053          * fragment shader, so we always define this macro in ES2/ES3.
2054          * If we ever get a driver that doesn't support highp, we'll
2055          * need to add a flag to the gl_context and check that here.
2056          */
2057         if (version >= 130 || parser->is_gles)
2058                 add_builtin_define (parser, "GL_FRAGMENT_PRECISION_HIGH", 1);
2059
2060         ralloc_asprintf_rewrite_tail (&parser->output, &parser->output_length,
2061                                       "#version %" PRIiMAX "%s%s", version,
2062                                       es_identifier ? " " : "",
2063                                       es_identifier ? es_identifier : "");
2064 }