src/compiler/glsl/ast.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2009 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 #pragma once
  26 #ifndef AST_H
  27 #define AST_H
  28
  29 #include "list.h"
  30 #include "glsl_parser_extras.h"
  31
  32 struct _mesa_glsl_parse_state;
  33
  34 struct YYLTYPE;
  35
  36 /**
  37  * \defgroup AST Abstract syntax tree node definitions
  38  *
  39  * An abstract syntax tree is generated by the parser.  This is a fairly
  40  * direct representation of the gramma derivation for the source program.
  41  * No symantic checking is done during the generation of the AST.  Only
  42  * syntactic checking is done.  Symantic checking is performed by a later
  43  * stage that converts the AST to a more generic intermediate representation.
  44  *
  45  *@{
  46  */
  47 /**
  48  * Base class of all abstract syntax tree nodes
  49  */
  50 class ast_node {
  51 public:
  52    DECLARE_LINEAR_ZALLOC_CXX_OPERATORS(ast_node);
  53
  54    /**
  55     * Print an AST node in something approximating the original GLSL code
  56     */
  57    virtual void print(void) const;
  58
  59    /**
  60     * Convert the AST node to the high-level intermediate representation
  61     */
  62    virtual ir_rvalue *hir(exec_list *instructions,
  63                           struct _mesa_glsl_parse_state *state);
  64
  65    virtual bool has_sequence_subexpression() const;
  66
  67    /**
  68     * Retrieve the source location of an AST node
  69     *
  70     * This function is primarily used to get the source position of an AST node
  71     * into a form that can be passed to \c _mesa_glsl_error.
  72     *
  73     * \sa _mesa_glsl_error, ast_node::set_location
  74     */
  75    struct YYLTYPE get_location(void) const
  76    {
  77       struct YYLTYPE locp;
  78
  79       locp.source = this->location.source;
  80       locp.first_line = this->location.first_line;
  81       locp.first_column = this->location.first_column;
  82       locp.last_line = this->location.last_line;
  83       locp.last_column = this->location.last_column;
  84
  85       return locp;
  86    }
  87
  88    /**
  89     * Set the source location of an AST node from a parser location
  90     *
  91     * \sa ast_node::get_location
  92     */
  93    void set_location(const struct YYLTYPE &locp)
  94    {
  95       this->location.source = locp.source;
  96       this->location.first_line = locp.first_line;
  97       this->location.first_column = locp.first_column;
  98       this->location.last_line = locp.last_line;
  99       this->location.last_column = locp.last_column;
 100    }
 101
 102    /**
 103     * Set the source location range of an AST node using two location nodes
 104     *
 105     * \sa ast_node::set_location
 106     */
 107    void set_location_range(const struct YYLTYPE &begin, const struct YYLTYPE &end)
 108    {
 109       this->location.source = begin.source;
 110       this->location.first_line = begin.first_line;
 111       this->location.last_line = end.last_line;
 112       this->location.first_column = begin.first_column;
 113       this->location.last_column = end.last_column;
 114    }
 115
 116    /**
 117     * Source location of the AST node.
 118     */
 119    struct {
 120       unsigned source;          /**< GLSL source number. */
 121       unsigned first_line;      /**< First line number within the source string. */
 122       unsigned first_column;    /**< First column in the first line. */
 123       unsigned last_line;       /**< Last line number within the source string. */
 124       unsigned last_column;     /**< Last column in the last line. */
 125    } location;
 126
 127    exec_node link;
 128
 129    virtual void set_is_lhs(bool);
 130
 131 protected:
 132    /**
 133     * The only constructor is protected so that only derived class objects can
 134     * be created.
 135     */
 136    ast_node(void);
 137 };
 138
 139
 140 /**
 141  * Operators for AST expression nodes.
 142  */
 143 enum ast_operators {
 144    ast_assign,
 145    ast_plus,        /**< Unary + operator. */
 146    ast_neg,
 147    ast_add,
 148    ast_sub,
 149    ast_mul,
 150    ast_div,
 151    ast_mod,
 152    ast_lshift,
 153    ast_rshift,
 154    ast_less,
 155    ast_greater,
 156    ast_lequal,
 157    ast_gequal,
 158    ast_equal,
 159    ast_nequal,
 160    ast_bit_and,
 161    ast_bit_xor,
 162    ast_bit_or,
 163    ast_bit_not,
 164    ast_logic_and,
 165    ast_logic_xor,
 166    ast_logic_or,
 167    ast_logic_not,
 168
 169    ast_mul_assign,
 170    ast_div_assign,
 171    ast_mod_assign,
 172    ast_add_assign,
 173    ast_sub_assign,
 174    ast_ls_assign,
 175    ast_rs_assign,
 176    ast_and_assign,
 177    ast_xor_assign,
 178    ast_or_assign,
 179
 180    ast_conditional,
 181
 182    ast_pre_inc,
 183    ast_pre_dec,
 184    ast_post_inc,
 185    ast_post_dec,
 186    ast_field_selection,
 187    ast_array_index,
 188    ast_unsized_array_dim,
 189
 190    ast_function_call,
 191
 192    ast_identifier,
 193    ast_int_constant,
 194    ast_uint_constant,
 195    ast_float_constant,
 196    ast_bool_constant,
 197    ast_double_constant,
 198
 199    ast_sequence,
 200    ast_aggregate
 201
 202    /**
 203     * Number of possible operators for an ast_expression
 204     *
 205     * This is done as a define instead of as an additional value in the enum so
 206     * that the compiler won't generate spurious messages like "warning:
 207     * enumeration value ‘ast_num_operators’ not handled in switch"
 208     */
 209    #define AST_NUM_OPERATORS (ast_aggregate + 1)
 210 };
 211
 212 /**
 213  * Representation of any sort of expression.
 214  */
 215 class ast_expression : public ast_node {
 216 public:
 217    ast_expression(int oper, ast_expression *,
 218                   ast_expression *, ast_expression *);
 219
 220    ast_expression(const char *identifier) :
 221       oper(ast_identifier)
 222    {
 223       subexpressions[0] = NULL;
 224       subexpressions[1] = NULL;
 225       subexpressions[2] = NULL;
 226       primary_expression.identifier = identifier;
 227       this->non_lvalue_description = NULL;
 228       this->is_lhs = false;
 229    }
 230
 231    static const char *operator_string(enum ast_operators op);
 232
 233    virtual ir_rvalue *hir(exec_list *instructions,
 234                           struct _mesa_glsl_parse_state *state);
 235
 236    virtual void hir_no_rvalue(exec_list *instructions,
 237                               struct _mesa_glsl_parse_state *state);
 238
 239    virtual bool has_sequence_subexpression() const;
 240
 241    ir_rvalue *do_hir(exec_list *instructions,
 242                      struct _mesa_glsl_parse_state *state,
 243                      bool needs_rvalue);
 244
 245    virtual void print(void) const;
 246
 247    enum ast_operators oper;
 248
 249    ast_expression *subexpressions[3];
 250
 251    union {
 252       const char *identifier;
 253       int int_constant;
 254       float float_constant;
 255       unsigned uint_constant;
 256       int bool_constant;
 257       double double_constant;
 258    } primary_expression;
 259
 260
 261    /**
 262     * List of expressions for an \c ast_sequence or parameters for an
 263     * \c ast_function_call
 264     */
 265    exec_list expressions;
 266
 267    /**
 268     * For things that can't be l-values, this describes what it is.
 269     *
 270     * This text is used by the code that generates IR for assignments to
 271     * detect and emit useful messages for assignments to some things that
 272     * can't be l-values.  For example, pre- or post-incerement expressions.
 273     *
 274     * \note
 275     * This pointer may be \c NULL.
 276     */
 277    const char *non_lvalue_description;
 278
 279    void set_is_lhs(bool new_value);
 280
 281 private:
 282    bool is_lhs;
 283 };
 284
 285 class ast_expression_bin : public ast_expression {
 286 public:
 287    ast_expression_bin(int oper, ast_expression *, ast_expression *);
 288
 289    virtual void print(void) const;
 290 };
 291
 292 /**
 293  * Subclass of expressions for function calls
 294  */
 295 class ast_function_expression : public ast_expression {
 296 public:
 297    ast_function_expression(ast_expression *callee)
 298       : ast_expression(ast_function_call, callee,
 299                        NULL, NULL),
 300         cons(false)
 301    {
 302       /* empty */
 303    }
 304
 305    ast_function_expression(class ast_type_specifier *type)
 306       : ast_expression(ast_function_call, (ast_expression *) type,
 307                        NULL, NULL),
 308         cons(true)
 309    {
 310       /* empty */
 311    }
 312
 313    bool is_constructor() const
 314    {
 315       return cons;
 316    }
 317
 318    virtual ir_rvalue *hir(exec_list *instructions,
 319                           struct _mesa_glsl_parse_state *state);
 320
 321    virtual void hir_no_rvalue(exec_list *instructions,
 322                               struct _mesa_glsl_parse_state *state);
 323
 324    virtual bool has_sequence_subexpression() const;
 325
 326 private:
 327    /**
 328     * Is this function call actually a constructor?
 329     */
 330    bool cons;
 331    ir_rvalue *
 332    handle_method(exec_list *instructions,
 333                  struct _mesa_glsl_parse_state *state);
 334 };
 335
 336 class ast_subroutine_list : public ast_node
 337 {
 338 public:
 339    virtual void print(void) const;
 340    exec_list declarations;
 341 };
 342
 343 class ast_array_specifier : public ast_node {
 344 public:
 345    ast_array_specifier(const struct YYLTYPE &locp, ast_expression *dim)
 346    {
 347       set_location(locp);
 348       array_dimensions.push_tail(&dim->link);
 349    }
 350
 351    void add_dimension(ast_expression *dim)
 352    {
 353       array_dimensions.push_tail(&dim->link);
 354    }
 355
 356    bool is_single_dimension() const
 357    {
 358       return this->array_dimensions.get_tail_raw()->prev != NULL &&
 359              this->array_dimensions.get_tail_raw()->prev->is_head_sentinel();
 360    }
 361
 362    virtual void print(void) const;
 363
 364    /* This list contains objects of type ast_node containing the
 365     * array dimensions in outermost-to-innermost order.
 366     */
 367    exec_list array_dimensions;
 368 };
 369
 370 class ast_layout_expression : public ast_node {
 371 public:
 372    ast_layout_expression(const struct YYLTYPE &locp, ast_expression *expr)
 373    {
 374       set_location(locp);
 375       layout_const_expressions.push_tail(&expr->link);
 376    }
 377
 378    bool process_qualifier_constant(struct _mesa_glsl_parse_state *state,
 379                                    const char *qual_indentifier,
 380                                    unsigned *value, bool can_be_zero);
 381
 382    void merge_qualifier(ast_layout_expression *l_expr)
 383    {
 384       layout_const_expressions.append_list(&l_expr->layout_const_expressions);
 385    }
 386
 387    exec_list layout_const_expressions;
 388 };
 389
 390 /**
 391  * C-style aggregate initialization class
 392  *
 393  * Represents C-style initializers of vectors, matrices, arrays, and
 394  * structures. E.g., vec3 pos = {1.0, 0.0, -1.0} is equivalent to
 395  * vec3 pos = vec3(1.0, 0.0, -1.0).
 396  *
 397  * Specified in GLSL 4.20 and GL_ARB_shading_language_420pack.
 398  *
 399  * \sa _mesa_ast_set_aggregate_type
 400  */
 401 class ast_aggregate_initializer : public ast_expression {
 402 public:
 403    ast_aggregate_initializer()
 404       : ast_expression(ast_aggregate, NULL, NULL, NULL),
 405         constructor_type(NULL)
 406    {
 407       /* empty */
 408    }
 409
 410    /**
 411     * glsl_type of the aggregate, which is inferred from the LHS of whatever
 412     * the aggregate is being used to initialize.  This can't be inferred at
 413     * parse time (since the parser deals with ast_type_specifiers, not
 414     * glsl_types), so the parser leaves it NULL.  However, the ast-to-hir
 415     * conversion code makes sure to fill it in with the appropriate type
 416     * before hir() is called.
 417     */
 418    const glsl_type *constructor_type;
 419
 420    virtual ir_rvalue *hir(exec_list *instructions,
 421                           struct _mesa_glsl_parse_state *state);
 422
 423    virtual void hir_no_rvalue(exec_list *instructions,
 424                               struct _mesa_glsl_parse_state *state);
 425 };
 426
 427
 428 class ast_compound_statement : public ast_node {
 429 public:
 430    ast_compound_statement(int new_scope, ast_node *statements);
 431    virtual void print(void) const;
 432
 433    virtual ir_rvalue *hir(exec_list *instructions,
 434                           struct _mesa_glsl_parse_state *state);
 435
 436    int new_scope;
 437    exec_list statements;
 438 };
 439
 440 class ast_declaration : public ast_node {
 441 public:
 442    ast_declaration(const char *identifier,
 443                    ast_array_specifier *array_specifier,
 444                    ast_expression *initializer);
 445    virtual void print(void) const;
 446
 447    const char *identifier;
 448
 449    ast_array_specifier *array_specifier;
 450
 451    ast_expression *initializer;
 452 };
 453
 454
 455 enum {
 456    ast_precision_none = 0, /**< Absence of precision qualifier. */
 457    ast_precision_high,
 458    ast_precision_medium,
 459    ast_precision_low
 460 };
 461
 462 struct ast_type_qualifier {
 463    DECLARE_RALLOC_CXX_OPERATORS(ast_type_qualifier);
 464
 465    union {
 466       struct {
 467          unsigned invariant:1;
 468          unsigned precise:1;
 469          unsigned constant:1;
 470          unsigned attribute:1;
 471          unsigned varying:1;
 472          unsigned in:1;
 473          unsigned out:1;
 474          unsigned centroid:1;
 475          unsigned sample:1;
 476          unsigned patch:1;
 477          unsigned uniform:1;
 478          unsigned buffer:1;
 479          unsigned shared_storage:1;
 480          unsigned smooth:1;
 481          unsigned flat:1;
 482          unsigned noperspective:1;
 483
 484          /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
 485          /*@{*/
 486          unsigned origin_upper_left:1;
 487          unsigned pixel_center_integer:1;
 488          /*@}*/
 489
 490          /**
 491           * Flag set if GL_ARB_enhanced_layouts "align" layout qualifier is
 492           * used.
 493           */
 494          unsigned explicit_align:1;
 495
 496          /**
 497           * Flag set if GL_ARB_explicit_attrib_location "location" layout
 498           * qualifier is used.
 499           */
 500          unsigned explicit_location:1;
 501          /**
 502           * Flag set if GL_ARB_explicit_attrib_location "index" layout
 503           * qualifier is used.
 504           */
 505          unsigned explicit_index:1;
 506
 507          /**
 508           * Flag set if GL_ARB_enhanced_layouts "component" layout
 509           * qualifier is used.
 510           */
 511          unsigned explicit_component:1;
 512
 513          /**
 514           * Flag set if GL_ARB_shading_language_420pack "binding" layout
 515           * qualifier is used.
 516           */
 517          unsigned explicit_binding:1;
 518
 519          /**
 520           * Flag set if GL_ARB_shader_atomic counter "offset" layout
 521           * qualifier is used.
 522           */
 523          unsigned explicit_offset:1;
 524
 525          /** \name Layout qualifiers for GL_AMD_conservative_depth */
 526          /** \{ */
 527          unsigned depth_any:1;
 528          unsigned depth_greater:1;
 529          unsigned depth_less:1;
 530          unsigned depth_unchanged:1;
 531          /** \} */
 532
 533          /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
 534          /** \{ */
 535          unsigned std140:1;
 536          unsigned std430:1;
 537          unsigned shared:1;
 538          unsigned packed:1;
 539          unsigned column_major:1;
 540          unsigned row_major:1;
 541          /** \} */
 542
 543          /** \name Layout qualifiers for GLSL 1.50 geometry shaders */
 544          /** \{ */
 545          unsigned prim_type:1;
 546          unsigned max_vertices:1;
 547          /** \} */
 548
 549          /**
 550           * local_size_{x,y,z} flags for compute shaders.  Bit 0 represents
 551           * local_size_x, and so on.
 552           */
 553          unsigned local_size:3;
 554
 555          /** \name Layout qualifiers for ARB_compute_variable_group_size. */
 556          /** \{ */
 557          unsigned local_size_variable:1;
 558          /** \} */
 559
 560          /** \name Layout and memory qualifiers for ARB_shader_image_load_store. */
 561          /** \{ */
 562          unsigned early_fragment_tests:1;
 563          unsigned explicit_image_format:1;
 564          unsigned coherent:1;
 565          unsigned _volatile:1;
 566          unsigned restrict_flag:1;
 567          unsigned read_only:1; /**< "readonly" qualifier. */
 568          unsigned write_only:1; /**< "writeonly" qualifier. */
 569          /** \} */
 570
 571          /** \name Layout qualifiers for GL_ARB_gpu_shader5 */
 572          /** \{ */
 573          unsigned invocations:1;
 574          unsigned stream:1; /**< Has stream value assigned  */
 575          unsigned explicit_stream:1; /**< stream value assigned explicitly by shader code */
 576          /** \} */
 577
 578          /** \name Layout qualifiers for GL_ARB_enhanced_layouts */
 579          /** \{ */
 580          unsigned explicit_xfb_offset:1; /**< xfb_offset value assigned explicitly by shader code */
 581          unsigned xfb_buffer:1; /**< Has xfb_buffer value assigned  */
 582          unsigned explicit_xfb_buffer:1; /**< xfb_buffer value assigned explicitly by shader code */
 583          unsigned xfb_stride:1; /**< Is xfb_stride value yet to be merged with global values  */
 584          unsigned explicit_xfb_stride:1; /**< xfb_stride value assigned explicitly by shader code */
 585          /** \} */
 586
 587          /** \name Layout qualifiers for GL_ARB_tessellation_shader */
 588          /** \{ */
 589          /* tess eval input layout */
 590          /* gs prim_type reused for primitive mode */
 591          unsigned vertex_spacing:1;
 592          unsigned ordering:1;
 593          unsigned point_mode:1;
 594          /* tess control output layout */
 595          unsigned vertices:1;
 596          /** \} */
 597
 598          /** \name Qualifiers for GL_ARB_shader_subroutine */
 599          /** \{ */
 600          unsigned subroutine:1;  /**< Is this marked 'subroutine' */
 601          unsigned subroutine_def:1; /**< Is this marked 'subroutine' with a list of types */
 602          /** \} */
 603
 604          /** \name Qualifiers for GL_KHR_blend_equation_advanced */
 605          /** \{ */
 606          unsigned blend_support:1; /**< Are there any blend_support_ qualifiers */
 607          /** \} */
 608
 609          /**
 610           * Flag set if GL_ARB_post_depth_coverage layout qualifier is used.
 611           */
 612          unsigned post_depth_coverage:1;
 613       }
 614       /** \brief Set of flags, accessed by name. */
 615       q;
 616
 617       /** \brief Set of flags, accessed as a bitmask. */
 618       uint64_t i;
 619    } flags;
 620
 621    /** Precision of the type (highp/medium/lowp). */
 622    unsigned precision:2;
 623
 624    /**
 625     * Alignment specified via GL_ARB_enhanced_layouts "align" layout qualifier
 626     */
 627    ast_expression *align;
 628
 629    /** Geometry shader invocations for GL_ARB_gpu_shader5. */
 630    ast_layout_expression *invocations;
 631
 632    /**
 633     * Location specified via GL_ARB_explicit_attrib_location layout
 634     *
 635     * \note
 636     * This field is only valid if \c explicit_location is set.
 637     */
 638    ast_expression *location;
 639    /**
 640     * Index specified via GL_ARB_explicit_attrib_location layout
 641     *
 642     * \note
 643     * This field is only valid if \c explicit_index is set.
 644     */
 645    ast_expression *index;
 646
 647    /**
 648     * Component specified via GL_ARB_enhaced_layouts
 649     *
 650     * \note
 651     * This field is only valid if \c explicit_component is set.
 652     */
 653    ast_expression *component;
 654
 655    /** Maximum output vertices in GLSL 1.50 geometry shaders. */
 656    ast_layout_expression *max_vertices;
 657
 658    /** Stream in GLSL 1.50 geometry shaders. */
 659    ast_expression *stream;
 660
 661    /** xfb_buffer specified via the GL_ARB_enhanced_layouts keyword. */
 662    ast_expression *xfb_buffer;
 663
 664    /** xfb_stride specified via the GL_ARB_enhanced_layouts keyword. */
 665    ast_expression *xfb_stride;
 666
 667    /** global xfb_stride values for each buffer */
 668    ast_layout_expression *out_xfb_stride[MAX_FEEDBACK_BUFFERS];
 669
 670    /**
 671     * Input or output primitive type in GLSL 1.50 geometry shaders
 672     * and tessellation shaders.
 673     */
 674    GLenum prim_type;
 675
 676    /**
 677     * Binding specified via GL_ARB_shading_language_420pack's "binding" keyword.
 678     *
 679     * \note
 680     * This field is only valid if \c explicit_binding is set.
 681     */
 682    ast_expression *binding;
 683
 684    /**
 685     * Offset specified via GL_ARB_shader_atomic_counter's or
 686     * GL_ARB_enhanced_layouts "offset" keyword, or by GL_ARB_enhanced_layouts
 687     * "xfb_offset" keyword.
 688     *
 689     * \note
 690     * This field is only valid if \c explicit_offset is set.
 691     */
 692    ast_expression *offset;
 693
 694    /**
 695     * Local size specified via GL_ARB_compute_shader's "local_size_{x,y,z}"
 696     * layout qualifier.  Element i of this array is only valid if
 697     * flags.q.local_size & (1 << i) is set.
 698     */
 699    ast_layout_expression *local_size[3];
 700
 701    /** Tessellation evaluation shader: vertex spacing (equal, fractional even/odd) */
 702    GLenum vertex_spacing;
 703
 704    /** Tessellation evaluation shader: vertex ordering (CW or CCW) */
 705    GLenum ordering;
 706
 707    /** Tessellation evaluation shader: point mode */
 708    bool point_mode;
 709
 710    /** Tessellation control shader: number of output vertices */
 711    ast_layout_expression *vertices;
 712
 713    /**
 714     * Image format specified with an ARB_shader_image_load_store
 715     * layout qualifier.
 716     *
 717     * \note
 718     * This field is only valid if \c explicit_image_format is set.
 719     */
 720    GLenum image_format;
 721
 722    /**
 723     * Base type of the data read from or written to this image.  Only
 724     * the following enumerants are allowed: GLSL_TYPE_UINT,
 725     * GLSL_TYPE_INT, GLSL_TYPE_FLOAT.
 726     *
 727     * \note
 728     * This field is only valid if \c explicit_image_format is set.
 729     */
 730    glsl_base_type image_base_type;
 731
 732    /**
 733     * Return true if and only if an interpolation qualifier is present.
 734     */
 735    bool has_interpolation() const;
 736
 737    /**
 738     * Return whether a layout qualifier is present.
 739     */
 740    bool has_layout() const;
 741
 742    /**
 743     * Return whether a storage qualifier is present.
 744     */
 745    bool has_storage() const;
 746
 747    /**
 748     * Return whether an auxiliary storage qualifier is present.
 749     */
 750    bool has_auxiliary_storage() const;
 751
 752    /**
 753     * Return true if and only if a memory qualifier is present.
 754     */
 755    bool has_memory() const;
 756
 757    bool merge_qualifier(YYLTYPE *loc,
 758                         _mesa_glsl_parse_state *state,
 759                         const ast_type_qualifier &q,
 760                         bool is_single_layout_merge,
 761                         bool is_multiple_layouts_merge = false);
 762
 763    /**
 764     * Validate current qualifier against the global out one.
 765     */
 766    bool validate_out_qualifier(YYLTYPE *loc,
 767                                _mesa_glsl_parse_state *state);
 768
 769    /**
 770     * Merge current qualifier into the global out one.
 771     */
 772    bool merge_into_out_qualifier(YYLTYPE *loc,
 773                                  _mesa_glsl_parse_state *state,
 774                                  ast_node* &node);
 775
 776    /**
 777     * Validate current qualifier against the global in one.
 778     */
 779    bool validate_in_qualifier(YYLTYPE *loc,
 780                               _mesa_glsl_parse_state *state);
 781
 782    /**
 783     * Merge current qualifier into the global in one.
 784     */
 785    bool merge_into_in_qualifier(YYLTYPE *loc,
 786                                 _mesa_glsl_parse_state *state,
 787                                 ast_node* &node);
 788
 789    /**
 790     * Push pending layout qualifiers to the global values.
 791     */
 792    bool push_to_global(YYLTYPE *loc,
 793                        _mesa_glsl_parse_state *state);
 794
 795    bool validate_flags(YYLTYPE *loc,
 796                        _mesa_glsl_parse_state *state,
 797                        const ast_type_qualifier &allowed_flags,
 798                        const char *message, const char *name);
 799
 800    ast_subroutine_list *subroutine_list;
 801 };
 802
 803 class ast_declarator_list;
 804
 805 class ast_struct_specifier : public ast_node {
 806 public:
 807    ast_struct_specifier(void *lin_ctx, const char *identifier,
 808                         ast_declarator_list *declarator_list);
 809    virtual void print(void) const;
 810
 811    virtual ir_rvalue *hir(exec_list *instructions,
 812                           struct _mesa_glsl_parse_state *state);
 813
 814    const char *name;
 815    ast_type_qualifier *layout;
 816    /* List of ast_declarator_list * */
 817    exec_list declarations;
 818    bool is_declaration;
 819 };
 820
 821
 822
 823 class ast_type_specifier : public ast_node {
 824 public:
 825    /** Construct a type specifier from a type name */
 826    ast_type_specifier(const char *name)
 827       : type_name(name), structure(NULL), array_specifier(NULL),
 828         default_precision(ast_precision_none)
 829    {
 830       /* empty */
 831    }
 832
 833    /** Construct a type specifier from a structure definition */
 834    ast_type_specifier(ast_struct_specifier *s)
 835       : type_name(s->name), structure(s), array_specifier(NULL),
 836         default_precision(ast_precision_none)
 837    {
 838       /* empty */
 839    }
 840
 841    const struct glsl_type *glsl_type(const char **name,
 842                                      struct _mesa_glsl_parse_state *state)
 843       const;
 844
 845    virtual void print(void) const;
 846
 847    ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 848
 849    const char *type_name;
 850    ast_struct_specifier *structure;
 851
 852    ast_array_specifier *array_specifier;
 853
 854    /** For precision statements, this is the given precision; otherwise none. */
 855    unsigned default_precision:2;
 856 };
 857
 858
 859 class ast_fully_specified_type : public ast_node {
 860 public:
 861    virtual void print(void) const;
 862    bool has_qualifiers(_mesa_glsl_parse_state *state) const;
 863
 864    ast_fully_specified_type() : qualifier(), specifier(NULL)
 865    {
 866    }
 867
 868    const struct glsl_type *glsl_type(const char **name,
 869                                      struct _mesa_glsl_parse_state *state)
 870       const;
 871
 872    ast_type_qualifier qualifier;
 873    ast_type_specifier *specifier;
 874 };
 875
 876
 877 class ast_declarator_list : public ast_node {
 878 public:
 879    ast_declarator_list(ast_fully_specified_type *);
 880    virtual void print(void) const;
 881
 882    virtual ir_rvalue *hir(exec_list *instructions,
 883                           struct _mesa_glsl_parse_state *state);
 884
 885    ast_fully_specified_type *type;
 886    /** List of 'ast_declaration *' */
 887    exec_list declarations;
 888
 889    /**
 890     * Flags for redeclarations. In these cases, no type is specified, to
 891     * `type` is allowed to be NULL. In all other cases, this would be an error.
 892     */
 893    int invariant;     /** < `invariant` redeclaration */
 894    int precise;       /** < `precise` redeclaration */
 895 };
 896
 897
 898 class ast_parameter_declarator : public ast_node {
 899 public:
 900    ast_parameter_declarator() :
 901       type(NULL),
 902       identifier(NULL),
 903       array_specifier(NULL),
 904       formal_parameter(false),
 905       is_void(false)
 906    {
 907       /* empty */
 908    }
 909
 910    virtual void print(void) const;
 911
 912    virtual ir_rvalue *hir(exec_list *instructions,
 913                           struct _mesa_glsl_parse_state *state);
 914
 915    ast_fully_specified_type *type;
 916    const char *identifier;
 917    ast_array_specifier *array_specifier;
 918
 919    static void parameters_to_hir(exec_list *ast_parameters,
 920                                  bool formal, exec_list *ir_parameters,
 921                                  struct _mesa_glsl_parse_state *state);
 922
 923 private:
 924    /** Is this parameter declaration part of a formal parameter list? */
 925    bool formal_parameter;
 926
 927    /**
 928     * Is this parameter 'void' type?
 929     *
 930     * This field is set by \c ::hir.
 931     */
 932    bool is_void;
 933 };
 934
 935
 936 class ast_function : public ast_node {
 937 public:
 938    ast_function(void);
 939
 940    virtual void print(void) const;
 941
 942    virtual ir_rvalue *hir(exec_list *instructions,
 943                           struct _mesa_glsl_parse_state *state);
 944
 945    ast_fully_specified_type *return_type;
 946    const char *identifier;
 947
 948    exec_list parameters;
 949
 950 private:
 951    /**
 952     * Is this prototype part of the function definition?
 953     *
 954     * Used by ast_function_definition::hir to process the parameters, etc.
 955     * of the function.
 956     *
 957     * \sa ::hir
 958     */
 959    bool is_definition;
 960
 961    /**
 962     * Function signature corresponding to this function prototype instance
 963     *
 964     * Used by ast_function_definition::hir to process the parameters, etc.
 965     * of the function.
 966     *
 967     * \sa ::hir
 968     */
 969    class ir_function_signature *signature;
 970
 971    friend class ast_function_definition;
 972 };
 973
 974
 975 class ast_expression_statement : public ast_node {
 976 public:
 977    ast_expression_statement(ast_expression *);
 978    virtual void print(void) const;
 979
 980    virtual ir_rvalue *hir(exec_list *instructions,
 981                           struct _mesa_glsl_parse_state *state);
 982
 983    ast_expression *expression;
 984 };
 985
 986
 987 class ast_case_label : public ast_node {
 988 public:
 989    ast_case_label(ast_expression *test_value);
 990    virtual void print(void) const;
 991
 992    virtual ir_rvalue *hir(exec_list *instructions,
 993                           struct _mesa_glsl_parse_state *state);
 994
 995    /**
 996     * An test value of NULL means 'default'.
 997     */
 998    ast_expression *test_value;
 999 };
1000
1001
1002 class ast_case_label_list : public ast_node {
1003 public:
1004    ast_case_label_list(void);
1005    virtual void print(void) const;
1006
1007    virtual ir_rvalue *hir(exec_list *instructions,
1008                           struct _mesa_glsl_parse_state *state);
1009
1010    /**
1011     * A list of case labels.
1012     */
1013    exec_list labels;
1014 };
1015
1016
1017 class ast_case_statement : public ast_node {
1018 public:
1019    ast_case_statement(ast_case_label_list *labels);
1020    virtual void print(void) const;
1021
1022    virtual ir_rvalue *hir(exec_list *instructions,
1023                           struct _mesa_glsl_parse_state *state);
1024
1025    ast_case_label_list *labels;
1026
1027    /**
1028     * A list of statements.
1029     */
1030    exec_list stmts;
1031 };
1032
1033
1034 class ast_case_statement_list : public ast_node {
1035 public:
1036    ast_case_statement_list(void);
1037    virtual void print(void) const;
1038
1039    virtual ir_rvalue *hir(exec_list *instructions,
1040                           struct _mesa_glsl_parse_state *state);
1041
1042    /**
1043     * A list of cases.
1044     */
1045    exec_list cases;
1046 };
1047
1048
1049 class ast_switch_body : public ast_node {
1050 public:
1051    ast_switch_body(ast_case_statement_list *stmts);
1052    virtual void print(void) const;
1053
1054    virtual ir_rvalue *hir(exec_list *instructions,
1055                           struct _mesa_glsl_parse_state *state);
1056
1057    ast_case_statement_list *stmts;
1058 };
1059
1060
1061 class ast_selection_statement : public ast_node {
1062 public:
1063    ast_selection_statement(ast_expression *condition,
1064                            ast_node *then_statement,
1065                            ast_node *else_statement);
1066    virtual void print(void) const;
1067
1068    virtual ir_rvalue *hir(exec_list *instructions,
1069                           struct _mesa_glsl_parse_state *state);
1070
1071    ast_expression *condition;
1072    ast_node *then_statement;
1073    ast_node *else_statement;
1074 };
1075
1076
1077 class ast_switch_statement : public ast_node {
1078 public:
1079    ast_switch_statement(ast_expression *test_expression,
1080                         ast_node *body);
1081    virtual void print(void) const;
1082
1083    virtual ir_rvalue *hir(exec_list *instructions,
1084                           struct _mesa_glsl_parse_state *state);
1085
1086    ast_expression *test_expression;
1087    ast_node *body;
1088
1089 protected:
1090    void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1091 };
1092
1093 class ast_iteration_statement : public ast_node {
1094 public:
1095    ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
1096                            ast_expression *rest_expression, ast_node *body);
1097
1098    virtual void print(void) const;
1099
1100    virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
1101
1102    enum ast_iteration_modes {
1103       ast_for,
1104       ast_while,
1105       ast_do_while
1106    } mode;
1107
1108
1109    ast_node *init_statement;
1110    ast_node *condition;
1111    ast_expression *rest_expression;
1112
1113    ast_node *body;
1114
1115    /**
1116     * Generate IR from the condition of a loop
1117     *
1118     * This is factored out of ::hir because some loops have the condition
1119     * test at the top (for and while), and others have it at the end (do-while).
1120     */
1121    void condition_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1122 };
1123
1124
1125 class ast_jump_statement : public ast_node {
1126 public:
1127    ast_jump_statement(int mode, ast_expression *return_value);
1128    virtual void print(void) const;
1129
1130    virtual ir_rvalue *hir(exec_list *instructions,
1131                           struct _mesa_glsl_parse_state *state);
1132
1133    enum ast_jump_modes {
1134       ast_continue,
1135       ast_break,
1136       ast_return,
1137       ast_discard
1138    } mode;
1139
1140    ast_expression *opt_return_value;
1141 };
1142
1143
1144 class ast_function_definition : public ast_node {
1145 public:
1146    ast_function_definition() : prototype(NULL), body(NULL)
1147    {
1148    }
1149
1150    virtual void print(void) const;
1151
1152    virtual ir_rvalue *hir(exec_list *instructions,
1153                           struct _mesa_glsl_parse_state *state);
1154
1155    ast_function *prototype;
1156    ast_compound_statement *body;
1157 };
1158
1159 class ast_interface_block : public ast_node {
1160 public:
1161    ast_interface_block(const char *instance_name,
1162                        ast_array_specifier *array_specifier)
1163    : block_name(NULL), instance_name(instance_name),
1164      array_specifier(array_specifier)
1165    {
1166    }
1167
1168    virtual ir_rvalue *hir(exec_list *instructions,
1169                           struct _mesa_glsl_parse_state *state);
1170
1171    ast_type_qualifier default_layout;
1172    ast_type_qualifier layout;
1173    const char *block_name;
1174
1175    /**
1176     * Declared name of the block instance, if specified.
1177     *
1178     * If the block does not have an instance name, this field will be
1179     * \c NULL.
1180     */
1181    const char *instance_name;
1182
1183    /** List of ast_declarator_list * */
1184    exec_list declarations;
1185
1186    /**
1187     * Declared array size of the block instance
1188     *
1189     * If the block is not declared as an array or if the block instance array
1190     * is unsized, this field will be \c NULL.
1191     */
1192    ast_array_specifier *array_specifier;
1193 };
1194
1195
1196 /**
1197  * AST node representing a declaration of the output layout for tessellation
1198  * control shaders.
1199  */
1200 class ast_tcs_output_layout : public ast_node
1201 {
1202 public:
1203    ast_tcs_output_layout(const struct YYLTYPE &locp)
1204    {
1205       set_location(locp);
1206    }
1207
1208    virtual ir_rvalue *hir(exec_list *instructions,
1209                           struct _mesa_glsl_parse_state *state);
1210 };
1211
1212
1213 /**
1214  * AST node representing a declaration of the input layout for geometry
1215  * shaders.
1216  */
1217 class ast_gs_input_layout : public ast_node
1218 {
1219 public:
1220    ast_gs_input_layout(const struct YYLTYPE &locp, GLenum prim_type)
1221       : prim_type(prim_type)
1222    {
1223       set_location(locp);
1224    }
1225
1226    virtual ir_rvalue *hir(exec_list *instructions,
1227                           struct _mesa_glsl_parse_state *state);
1228
1229 private:
1230    const GLenum prim_type;
1231 };
1232
1233
1234 /**
1235  * AST node representing a decalaration of the input layout for compute
1236  * shaders.
1237  */
1238 class ast_cs_input_layout : public ast_node
1239 {
1240 public:
1241    ast_cs_input_layout(const struct YYLTYPE &locp,
1242                        ast_layout_expression *const *local_size)
1243    {
1244       for (int i = 0; i < 3; i++) {
1245          this->local_size[i] = local_size[i];
1246       }
1247       set_location(locp);
1248    }
1249
1250    virtual ir_rvalue *hir(exec_list *instructions,
1251                           struct _mesa_glsl_parse_state *state);
1252
1253 private:
1254    ast_layout_expression *local_size[3];
1255 };
1256
1257 /*@}*/
1258
1259 extern void
1260 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
1261
1262 extern ir_rvalue *
1263 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
1264                                  exec_list *instructions,
1265                                  struct _mesa_glsl_parse_state *state);
1266
1267 extern ir_rvalue *
1268 _mesa_ast_array_index_to_hir(void *mem_ctx,
1269                              struct _mesa_glsl_parse_state *state,
1270                              ir_rvalue *array, ir_rvalue *idx,
1271                              YYLTYPE &loc, YYLTYPE &idx_loc);
1272
1273 extern void
1274 _mesa_ast_set_aggregate_type(const glsl_type *type,
1275                              ast_expression *expr);
1276
1277 void
1278 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
1279
1280 extern void
1281 check_builtin_array_max_size(const char *name, unsigned size,
1282                              YYLTYPE loc, struct _mesa_glsl_parse_state *state);
1283
1284 extern void _mesa_ast_process_interface_block(YYLTYPE *locp,
1285                                               _mesa_glsl_parse_state *state,
1286                                               ast_interface_block *const block,
1287                                               const struct ast_type_qualifier &q);
1288
1289 extern bool
1290 process_qualifier_constant(struct _mesa_glsl_parse_state *state,
1291                            YYLTYPE *loc,
1292                            const char *qual_indentifier,
1293                            ast_expression *const_expression,
1294                            unsigned *value);
1295 #endif /* AST_H */