src/glsl/glsl_parser_extras.cpp

   1 /*
   2  * Copyright © 2008, 2009 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  */
  23 #include <stdio.h>
  24 #include <stdarg.h>
  25 #include <string.h>
  26 #include <assert.h>
  27
  28 extern "C" {
  29 #include <talloc.h>
  30 #include "main/mtypes.h"
  31 }
  32
  33 #include "ast.h"
  34 #include "glsl_parser_extras.h"
  35 #include "glsl_parser.h"
  36
  37 _mesa_glsl_parse_state::_mesa_glsl_parse_state(struct __GLcontextRec *ctx,
  38                                                GLenum target, void *mem_ctx)
  39 {
  40    switch (target) {
  41    case GL_VERTEX_SHADER:   this->target = vertex_shader; break;
  42    case GL_FRAGMENT_SHADER: this->target = fragment_shader; break;
  43    case GL_GEOMETRY_SHADER: this->target = geometry_shader; break;
  44    }
  45
  46    this->scanner = NULL;
  47    this->translation_unit.make_empty();
  48    this->symbols = new(mem_ctx) glsl_symbol_table;
  49    this->info_log = talloc_strdup(mem_ctx, "");
  50    this->error = false;
  51    this->loop_or_switch_nesting = NULL;
  52    this->ARB_texture_rectangle_enable = true;
  53
  54    if (ctx != NULL) {
  55       this->extensions = &ctx->Extensions;
  56
  57       this->Const.MaxLights = ctx->Const.MaxLights;
  58       this->Const.MaxClipPlanes = ctx->Const.MaxClipPlanes;
  59       this->Const.MaxTextureUnits = ctx->Const.MaxTextureUnits;
  60       this->Const.MaxTextureCoords = ctx->Const.MaxTextureCoordUnits;
  61       this->Const.MaxVertexAttribs = ctx->Const.VertexProgram.MaxAttribs;
  62       this->Const.MaxVertexUniformComponents = ctx->Const.VertexProgram.MaxUniformComponents;
  63       this->Const.MaxVaryingFloats = ctx->Const.MaxVarying * 4;
  64       this->Const.MaxVertexTextureImageUnits = ctx->Const.MaxVertexTextureImageUnits;
  65       this->Const.MaxCombinedTextureImageUnits = ctx->Const.MaxCombinedTextureImageUnits;
  66       this->Const.MaxTextureImageUnits = ctx->Const.MaxTextureImageUnits;
  67       this->Const.MaxFragmentUniformComponents = ctx->Const.FragmentProgram.MaxUniformComponents;
  68
  69       this->Const.MaxDrawBuffers = ctx->Const.MaxDrawBuffers;
  70    } else {
  71       /* If there is no GL context (standalone compiler), fill in constants
  72        * with the minimum required values.
  73        */
  74       static struct gl_extensions null_extensions;
  75
  76       memset(&null_extensions, 0, sizeof(null_extensions));
  77       this->extensions = &null_extensions;
  78
  79       /* 1.10 minimums. */
  80       this->Const.MaxLights = 8;
  81       this->Const.MaxClipPlanes = 8;
  82       this->Const.MaxTextureUnits = 2;
  83
  84       /* More than the 1.10 minimum to appease parser tests taken from
  85        * apps that (hopefully) already checked the number of coords.
  86        */
  87       this->Const.MaxTextureCoords = 4;
  88
  89       this->Const.MaxVertexAttribs = 16;
  90       this->Const.MaxVertexUniformComponents = 512;
  91       this->Const.MaxVaryingFloats = 32;
  92       this->Const.MaxVertexTextureImageUnits = 0;
  93       this->Const.MaxCombinedTextureImageUnits = 2;
  94       this->Const.MaxTextureImageUnits = 2;
  95       this->Const.MaxFragmentUniformComponents = 64;
  96
  97       this->Const.MaxDrawBuffers = 2;
  98    }
  99 }
 100
 101 const char *
 102 _mesa_glsl_shader_target_name(enum _mesa_glsl_parser_targets target)
 103 {
 104    switch (target) {
 105    case vertex_shader:   return "vertex";
 106    case fragment_shader: return "fragment";
 107    case geometry_shader: return "geometry";
 108    case ir_shader:       break;
 109    }
 110
 111    assert(!"Should not get here.");
 112    return "unknown";
 113 }
 114
 115
 116 void
 117 _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
 118                  const char *fmt, ...)
 119 {
 120    va_list ap;
 121
 122    state->error = true;
 123
 124    assert(state->info_log != NULL);
 125    state->info_log = talloc_asprintf_append(state->info_log,
 126                                             "%u:%u(%u): error: ",
 127                                             locp->source,
 128                                             locp->first_line,
 129                                             locp->first_column);
 130    va_start(ap, fmt);
 131    state->info_log = talloc_vasprintf_append(state->info_log, fmt, ap);
 132    va_end(ap);
 133    state->info_log = talloc_strdup_append(state->info_log, "\n");
 134 }
 135
 136
 137 void
 138 _mesa_glsl_warning(const YYLTYPE *locp, _mesa_glsl_parse_state *state,
 139                    const char *fmt, ...)
 140 {
 141    va_list ap;
 142
 143    assert(state->info_log != NULL);
 144    state->info_log = talloc_asprintf_append(state->info_log,
 145                                             "%u:%u(%u): warning: ",
 146                                             locp->source,
 147                                             locp->first_line,
 148                                             locp->first_column);
 149    va_start(ap, fmt);
 150    state->info_log = talloc_vasprintf_append(state->info_log, fmt, ap);
 151    va_end(ap);
 152    state->info_log = talloc_strdup_append(state->info_log, "\n");
 153 }
 154
 155
 156 bool
 157 _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 158                              const char *behavior, YYLTYPE *behavior_locp,
 159                              _mesa_glsl_parse_state *state)
 160 {
 161    enum {
 162       extension_disable,
 163       extension_enable,
 164       extension_require,
 165       extension_warn
 166    } ext_mode;
 167
 168    if (strcmp(behavior, "warn") == 0) {
 169       ext_mode = extension_warn;
 170    } else if (strcmp(behavior, "require") == 0) {
 171       ext_mode = extension_require;
 172    } else if (strcmp(behavior, "enable") == 0) {
 173       ext_mode = extension_enable;
 174    } else if (strcmp(behavior, "disable") == 0) {
 175       ext_mode = extension_disable;
 176    } else {
 177       _mesa_glsl_error(behavior_locp, state,
 178                        "Unknown extension behavior `%s'",
 179                        behavior);
 180       return false;
 181    }
 182
 183    bool unsupported = false;
 184
 185    if (strcmp(name, "all") == 0) {
 186       if ((ext_mode == extension_enable) || (ext_mode == extension_require)) {
 187          _mesa_glsl_error(name_locp, state, "Cannot %s all extensions",
 188                           (ext_mode == extension_enable)
 189                           ? "enable" : "require");
 190          return false;
 191       }
 192    } else if (strcmp(name, "GL_ARB_draw_buffers") == 0) {
 193       /* This extension is only supported in fragment shaders.
 194        */
 195       if (state->target != fragment_shader) {
 196          unsupported = true;
 197       } else {
 198          state->ARB_draw_buffers_enable = (ext_mode != extension_disable);
 199          state->ARB_draw_buffers_warn = (ext_mode == extension_warn);
 200       }
 201    } else if (strcmp(name, "GL_ARB_fragment_coord_conventions") == 0) {
 202       state->ARB_fragment_coord_conventions_enable =
 203          (ext_mode != extension_disable);
 204       state->ARB_fragment_coord_conventions_warn =
 205          (ext_mode == extension_warn);
 206
 207       unsupported = !state->extensions->ARB_fragment_coord_conventions;
 208    } else if (strcmp(name, "GL_ARB_texture_rectangle") == 0) {
 209       state->ARB_texture_rectangle_enable = (ext_mode != extension_disable);
 210       state->ARB_texture_rectangle_warn = (ext_mode == extension_warn);
 211    } else if (strcmp(name, "GL_EXT_texture_array") == 0) {
 212       state->EXT_texture_array_enable = (ext_mode != extension_disable);
 213       state->EXT_texture_array_warn = (ext_mode == extension_warn);
 214
 215       unsupported = !state->extensions->EXT_texture_array;
 216    } else {
 217       unsupported = true;
 218    }
 219
 220    if (unsupported) {
 221       static const char *const fmt = "extension `%s' unsupported in %s shader";
 222
 223       if (ext_mode == extension_require) {
 224          _mesa_glsl_error(name_locp, state, fmt,
 225                           name, _mesa_glsl_shader_target_name(state->target));
 226          return false;
 227       } else {
 228          _mesa_glsl_warning(name_locp, state, fmt,
 229                             name, _mesa_glsl_shader_target_name(state->target));
 230       }
 231    }
 232
 233    return true;
 234 }
 235
 236 void
 237 _mesa_ast_type_qualifier_print(const struct ast_type_qualifier *q)
 238 {
 239    if (q->constant)
 240       printf("const ");
 241
 242    if (q->invariant)
 243       printf("invariant ");
 244
 245    if (q->attribute)
 246       printf("attribute ");
 247
 248    if (q->varying)
 249       printf("varying ");
 250
 251    if (q->in && q->out)
 252       printf("inout ");
 253    else {
 254       if (q->in)
 255          printf("in ");
 256
 257       if (q->out)
 258          printf("out ");
 259    }
 260
 261    if (q->centroid)
 262       printf("centroid ");
 263    if (q->uniform)
 264       printf("uniform ");
 265    if (q->smooth)
 266       printf("smooth ");
 267    if (q->flat)
 268       printf("flat ");
 269    if (q->noperspective)
 270       printf("noperspective ");
 271 }
 272
 273
 274 void
 275 ast_node::print(void) const
 276 {
 277    printf("unhandled node ");
 278 }
 279
 280
 281 ast_node::ast_node(void)
 282 {
 283    /* empty */
 284 }
 285
 286
 287 static void
 288 ast_opt_array_size_print(bool is_array, const ast_expression *array_size)
 289 {
 290    if (is_array) {
 291       printf("[ ");
 292
 293       if (array_size)
 294          array_size->print();
 295
 296       printf("] ");
 297    }
 298 }
 299
 300
 301 void
 302 ast_compound_statement::print(void) const
 303 {
 304    printf("{\n");
 305
 306    foreach_list_const(n, &this->statements) {
 307       ast_node *ast = exec_node_data(ast_node, n, link);
 308       ast->print();
 309    }
 310
 311    printf("}\n");
 312 }
 313
 314
 315 ast_compound_statement::ast_compound_statement(int new_scope,
 316                                                ast_node *statements)
 317 {
 318    this->new_scope = new_scope;
 319
 320    if (statements != NULL) {
 321       this->statements.push_degenerate_list_at_head(&statements->link);
 322    }
 323 }
 324
 325
 326 void
 327 ast_expression::print(void) const
 328 {
 329    switch (oper) {
 330    case ast_assign:
 331    case ast_mul_assign:
 332    case ast_div_assign:
 333    case ast_mod_assign:
 334    case ast_add_assign:
 335    case ast_sub_assign:
 336    case ast_ls_assign:
 337    case ast_rs_assign:
 338    case ast_and_assign:
 339    case ast_xor_assign:
 340    case ast_or_assign:
 341       subexpressions[0]->print();
 342       printf("%s ", operator_string(oper));
 343       subexpressions[1]->print();
 344       break;
 345
 346    case ast_field_selection:
 347       subexpressions[0]->print();
 348       printf(". %s ", primary_expression.identifier);
 349       break;
 350
 351    case ast_plus:
 352    case ast_neg:
 353    case ast_bit_not:
 354    case ast_logic_not:
 355    case ast_pre_inc:
 356    case ast_pre_dec:
 357       printf("%s ", operator_string(oper));
 358       subexpressions[0]->print();
 359       break;
 360
 361    case ast_post_inc:
 362    case ast_post_dec:
 363       subexpressions[0]->print();
 364       printf("%s ", operator_string(oper));
 365       break;
 366
 367    case ast_conditional:
 368       subexpressions[0]->print();
 369       printf("? ");
 370       subexpressions[1]->print();
 371       printf(": ");
 372       subexpressions[1]->print();
 373       break;
 374
 375    case ast_array_index:
 376       subexpressions[0]->print();
 377       printf("[ ");
 378       subexpressions[1]->print();
 379       printf("] ");
 380       break;
 381
 382    case ast_function_call: {
 383       subexpressions[0]->print();
 384       printf("( ");
 385
 386       foreach_list_const (n, &this->expressions) {
 387          if (n != this->expressions.get_head())
 388             printf(", ");
 389
 390          ast_node *ast = exec_node_data(ast_node, n, link);
 391          ast->print();
 392       }
 393
 394       printf(") ");
 395       break;
 396    }
 397
 398    case ast_identifier:
 399       printf("%s ", primary_expression.identifier);
 400       break;
 401
 402    case ast_int_constant:
 403       printf("%d ", primary_expression.int_constant);
 404       break;
 405
 406    case ast_uint_constant:
 407       printf("%u ", primary_expression.uint_constant);
 408       break;
 409
 410    case ast_float_constant:
 411       printf("%f ", primary_expression.float_constant);
 412       break;
 413
 414    case ast_bool_constant:
 415       printf("%s ",
 416              primary_expression.bool_constant
 417              ? "true" : "false");
 418       break;
 419
 420    case ast_sequence: {
 421       printf("( ");
 422       foreach_list_const(n, & this->expressions) {
 423          if (n != this->expressions.get_head())
 424             printf(", ");
 425
 426          ast_node *ast = exec_node_data(ast_node, n, link);
 427          ast->print();
 428       }
 429       printf(") ");
 430       break;
 431    }
 432
 433    default:
 434       assert(0);
 435       break;
 436    }
 437 }
 438
 439 ast_expression::ast_expression(int oper,
 440                                ast_expression *ex0,
 441                                ast_expression *ex1,
 442                                ast_expression *ex2)
 443 {
 444    this->oper = ast_operators(oper);
 445    this->subexpressions[0] = ex0;
 446    this->subexpressions[1] = ex1;
 447    this->subexpressions[2] = ex2;
 448 }
 449
 450
 451 void
 452 ast_expression_statement::print(void) const
 453 {
 454    if (expression)
 455       expression->print();
 456
 457    printf("; ");
 458 }
 459
 460
 461 ast_expression_statement::ast_expression_statement(ast_expression *ex) :
 462    expression(ex)
 463 {
 464    /* empty */
 465 }
 466
 467
 468 void
 469 ast_function::print(void) const
 470 {
 471    return_type->print();
 472    printf(" %s (", identifier);
 473
 474    foreach_list_const(n, & this->parameters) {
 475       ast_node *ast = exec_node_data(ast_node, n, link);
 476       ast->print();
 477    }
 478
 479    printf(")");
 480 }
 481
 482
 483 ast_function::ast_function(void)
 484    : is_definition(false), signature(NULL)
 485 {
 486    /* empty */
 487 }
 488
 489
 490 void
 491 ast_fully_specified_type::print(void) const
 492 {
 493    _mesa_ast_type_qualifier_print(& qualifier);
 494    specifier->print();
 495 }
 496
 497
 498 void
 499 ast_parameter_declarator::print(void) const
 500 {
 501    type->print();
 502    if (identifier)
 503       printf("%s ", identifier);
 504    ast_opt_array_size_print(is_array, array_size);
 505 }
 506
 507
 508 void
 509 ast_function_definition::print(void) const
 510 {
 511    prototype->print();
 512    body->print();
 513 }
 514
 515
 516 void
 517 ast_declaration::print(void) const
 518 {
 519    printf("%s ", identifier);
 520    ast_opt_array_size_print(is_array, array_size);
 521
 522    if (initializer) {
 523       printf("= ");
 524       initializer->print();
 525    }
 526 }
 527
 528
 529 ast_declaration::ast_declaration(char *identifier, int is_array,
 530                                  ast_expression *array_size,
 531                                  ast_expression *initializer)
 532 {
 533    this->identifier = identifier;
 534    this->is_array = is_array;
 535    this->array_size = array_size;
 536    this->initializer = initializer;
 537 }
 538
 539
 540 void
 541 ast_declarator_list::print(void) const
 542 {
 543    assert(type || invariant);
 544
 545    if (type)
 546       type->print();
 547    else
 548       printf("invariant ");
 549
 550    foreach_list_const (ptr, & this->declarations) {
 551       if (ptr != this->declarations.get_head())
 552          printf(", ");
 553
 554       ast_node *ast = exec_node_data(ast_node, ptr, link);
 555       ast->print();
 556    }
 557
 558    printf("; ");
 559 }
 560
 561
 562 ast_declarator_list::ast_declarator_list(ast_fully_specified_type *type)
 563 {
 564    this->type = type;
 565    this->invariant = false;
 566 }
 567
 568 void
 569 ast_jump_statement::print(void) const
 570 {
 571    switch (mode) {
 572    case ast_continue:
 573       printf("continue; ");
 574       break;
 575    case ast_break:
 576       printf("break; ");
 577       break;
 578    case ast_return:
 579       printf("return ");
 580       if (opt_return_value)
 581          opt_return_value->print();
 582
 583       printf("; ");
 584       break;
 585    case ast_discard:
 586       printf("discard; ");
 587       break;
 588    }
 589 }
 590
 591
 592 ast_jump_statement::ast_jump_statement(int mode, ast_expression *return_value)
 593 {
 594    this->mode = ast_jump_modes(mode);
 595
 596    if (mode == ast_return)
 597       opt_return_value = return_value;
 598 }
 599
 600
 601 void
 602 ast_selection_statement::print(void) const
 603 {
 604    printf("if ( ");
 605    condition->print();
 606    printf(") ");
 607
 608    then_statement->print();
 609
 610    if (else_statement) {
 611       printf("else ");
 612       else_statement->print();
 613    }
 614
 615 }
 616
 617
 618 ast_selection_statement::ast_selection_statement(ast_expression *condition,
 619                                                  ast_node *then_statement,
 620                                                  ast_node *else_statement)
 621 {
 622    this->condition = condition;
 623    this->then_statement = then_statement;
 624    this->else_statement = else_statement;
 625 }
 626
 627
 628 void
 629 ast_iteration_statement::print(void) const
 630 {
 631    switch (mode) {
 632    case ast_for:
 633       printf("for( ");
 634       if (init_statement)
 635          init_statement->print();
 636       printf("; ");
 637
 638       if (condition)
 639          condition->print();
 640       printf("; ");
 641
 642       if (rest_expression)
 643          rest_expression->print();
 644       printf(") ");
 645
 646       body->print();
 647       break;
 648
 649    case ast_while:
 650       printf("while ( ");
 651       if (condition)
 652          condition->print();
 653       printf(") ");
 654       body->print();
 655       break;
 656
 657    case ast_do_while:
 658       printf("do ");
 659       body->print();
 660       printf("while ( ");
 661       if (condition)
 662          condition->print();
 663       printf("); ");
 664       break;
 665    }
 666 }
 667
 668
 669 ast_iteration_statement::ast_iteration_statement(int mode,
 670                                                  ast_node *init,
 671                                                  ast_node *condition,
 672                                                  ast_expression *rest_expression,
 673                                                  ast_node *body)
 674 {
 675    this->mode = ast_iteration_modes(mode);
 676    this->init_statement = init;
 677    this->condition = condition;
 678    this->rest_expression = rest_expression;
 679    this->body = body;
 680 }
 681
 682
 683 void
 684 ast_struct_specifier::print(void) const
 685 {
 686    printf("struct %s { ", name);
 687    foreach_list_const(n, &this->declarations) {
 688       ast_node *ast = exec_node_data(ast_node, n, link);
 689       ast->print();
 690    }
 691    printf("} ");
 692 }
 693
 694
 695 ast_struct_specifier::ast_struct_specifier(char *identifier,
 696                                            ast_node *declarator_list)
 697 {
 698    name = identifier;
 699    this->declarations.push_degenerate_list_at_head(&declarator_list->link);
 700 }