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