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