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 Vulkan qualifiers */
 531          unsigned vk_set:1;
 532
 533          /** \name Layout qualifiers for GL_ARB_tessellation_shader */
 534          /** \{ */
 535          /* tess eval input layout */
 536          /* gs prim_type reused for primitive mode */
 537          unsigned vertex_spacing:1;
 538          unsigned ordering:1;
 539          unsigned point_mode:1;
 540          /* tess control output layout */
 541          unsigned vertices:1;
 542          /** \} */
 543
 544          /** \name Qualifiers for GL_ARB_shader_subroutine */
 545          /** \{ */
 546          unsigned subroutine:1;  /**< Is this marked 'subroutine' */
 547          unsigned subroutine_def:1; /**< Is this marked 'subroutine' with a list of types */
 548          /** \} */
 549       }
 550       /** \brief Set of flags, accessed by name. */
 551       q;
 552
 553       /** \brief Set of flags, accessed as a bitmask. */
 554       uint64_t i;
 555    } flags;
 556
 557    /** Precision of the type (highp/medium/lowp). */
 558    unsigned precision:2;
 559
 560    /** Geometry shader invocations for GL_ARB_gpu_shader5. */
 561    int invocations;
 562
 563    /**
 564     * Location specified via GL_ARB_explicit_attrib_location layout
 565     *
 566     * \note
 567     * This field is only valid if \c explicit_location is set.
 568     */
 569    int location;
 570    /**
 571     * Index specified via GL_ARB_explicit_attrib_location layout
 572     *
 573     * \note
 574     * This field is only valid if \c explicit_index is set.
 575     */
 576    int index;
 577
 578    /** Maximum output vertices in GLSL 1.50 geometry shaders. */
 579    int max_vertices;
 580
 581    /** Stream in GLSL 1.50 geometry shaders. */
 582    unsigned stream;
 583
 584    /**
 585     * Input or output primitive type in GLSL 1.50 geometry shaders
 586     * and tessellation shaders.
 587     */
 588    GLenum prim_type;
 589
 590    /**
 591     * Binding specified via GL_ARB_shading_language_420pack's "binding" keyword.
 592     *
 593     * \note
 594     * This field is only valid if \c explicit_binding is set.
 595     */
 596    int binding;
 597
 598    /**
 599     * Offset specified via GL_ARB_shader_atomic_counter's "offset"
 600     * keyword.
 601     *
 602     * \note
 603     * This field is only valid if \c explicit_offset is set.
 604     */
 605    int offset;
 606
 607    /**
 608     * Local size specified via GL_ARB_compute_shader's "local_size_{x,y,z}"
 609     * layout qualifier.  Element i of this array is only valid if
 610     * flags.q.local_size & (1 << i) is set.
 611     */
 612    int local_size[3];
 613
 614    /** Tessellation evaluation shader: vertex spacing (equal, fractional even/odd) */
 615    GLenum vertex_spacing;
 616
 617    /** Tessellation evaluation shader: vertex ordering (CW or CCW) */
 618    GLenum ordering;
 619
 620    /** Tessellation evaluation shader: point mode */
 621    bool point_mode;
 622
 623    /** Tessellation control shader: number of output vertices */
 624    int vertices;
 625
 626    /**
 627     * Image format specified with an ARB_shader_image_load_store
 628     * layout qualifier.
 629     *
 630     * \note
 631     * This field is only valid if \c explicit_image_format is set.
 632     */
 633    GLenum image_format;
 634
 635    /**
 636     * Base type of the data read from or written to this image.  Only
 637     * the following enumerants are allowed: GLSL_TYPE_UINT,
 638     * GLSL_TYPE_INT, GLSL_TYPE_FLOAT.
 639     *
 640     * \note
 641     * This field is only valid if \c explicit_image_format is set.
 642     */
 643    glsl_base_type image_base_type;
 644
 645    /**
 646     * Vulkan descriptor set
 647     */
 648    int set;
 649
 650    /**
 651     * Return true if and only if an interpolation qualifier is present.
 652     */
 653    bool has_interpolation() const;
 654
 655    /**
 656     * Return whether a layout qualifier is present.
 657     */
 658    bool has_layout() const;
 659
 660    /**
 661     * Return whether a storage qualifier is present.
 662     */
 663    bool has_storage() const;
 664
 665    /**
 666     * Return whether an auxiliary storage qualifier is present.
 667     */
 668    bool has_auxiliary_storage() const;
 669
 670    /**
 671     * \brief Return string representation of interpolation qualifier.
 672     *
 673     * If an interpolation qualifier is present, then return that qualifier's
 674     * string representation. Otherwise, return null. For example, if the
 675     * noperspective bit is set, then this returns "noperspective".
 676     *
 677     * If multiple interpolation qualifiers are somehow present, then the
 678     * returned string is undefined but not null.
 679     */
 680    const char *interpolation_string() const;
 681
 682    bool merge_qualifier(YYLTYPE *loc,
 683                         _mesa_glsl_parse_state *state,
 684                         ast_type_qualifier q);
 685
 686    bool merge_out_qualifier(YYLTYPE *loc,
 687                            _mesa_glsl_parse_state *state,
 688                            ast_type_qualifier q,
 689                            ast_node* &node);
 690
 691    bool merge_in_qualifier(YYLTYPE *loc,
 692                            _mesa_glsl_parse_state *state,
 693                            ast_type_qualifier q,
 694                            ast_node* &node);
 695
 696    ast_subroutine_list *subroutine_list;
 697 };
 698
 699 class ast_declarator_list;
 700
 701 class ast_struct_specifier : public ast_node {
 702 public:
 703    ast_struct_specifier(const char *identifier,
 704                         ast_declarator_list *declarator_list);
 705    virtual void print(void) const;
 706
 707    virtual ir_rvalue *hir(exec_list *instructions,
 708                           struct _mesa_glsl_parse_state *state);
 709
 710    const char *name;
 711    /* List of ast_declarator_list * */
 712    exec_list declarations;
 713    bool is_declaration;
 714 };
 715
 716
 717
 718 class ast_type_specifier : public ast_node {
 719 public:
 720    /** Construct a type specifier from a type name */
 721    ast_type_specifier(const char *name)
 722       : type_name(name), structure(NULL), array_specifier(NULL),
 723         default_precision(ast_precision_none)
 724    {
 725       /* empty */
 726    }
 727
 728    /** Construct a type specifier from a structure definition */
 729    ast_type_specifier(ast_struct_specifier *s)
 730       : type_name(s->name), structure(s), array_specifier(NULL),
 731         default_precision(ast_precision_none)
 732    {
 733       /* empty */
 734    }
 735
 736    const struct glsl_type *glsl_type(const char **name,
 737                                      struct _mesa_glsl_parse_state *state)
 738       const;
 739
 740    virtual void print(void) const;
 741
 742    ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 743
 744    const char *type_name;
 745    ast_struct_specifier *structure;
 746
 747    ast_array_specifier *array_specifier;
 748
 749    /** For precision statements, this is the given precision; otherwise none. */
 750    unsigned default_precision:2;
 751 };
 752
 753
 754 class ast_fully_specified_type : public ast_node {
 755 public:
 756    virtual void print(void) const;
 757    bool has_qualifiers() const;
 758
 759    ast_fully_specified_type() : qualifier(), specifier(NULL)
 760    {
 761    }
 762
 763    const struct glsl_type *glsl_type(const char **name,
 764                                      struct _mesa_glsl_parse_state *state)
 765       const;
 766
 767    ast_type_qualifier qualifier;
 768    ast_type_specifier *specifier;
 769 };
 770
 771
 772 class ast_declarator_list : public ast_node {
 773 public:
 774    ast_declarator_list(ast_fully_specified_type *);
 775    virtual void print(void) const;
 776
 777    virtual ir_rvalue *hir(exec_list *instructions,
 778                           struct _mesa_glsl_parse_state *state);
 779
 780    ast_fully_specified_type *type;
 781    /** List of 'ast_declaration *' */
 782    exec_list declarations;
 783
 784    /**
 785     * Flags for redeclarations. In these cases, no type is specified, to
 786     * `type` is allowed to be NULL. In all other cases, this would be an error.
 787     */
 788    int invariant;     /** < `invariant` redeclaration */
 789    int precise;       /** < `precise` redeclaration */
 790 };
 791
 792
 793 class ast_parameter_declarator : public ast_node {
 794 public:
 795    ast_parameter_declarator() :
 796       type(NULL),
 797       identifier(NULL),
 798       array_specifier(NULL),
 799       formal_parameter(false),
 800       is_void(false)
 801    {
 802       /* empty */
 803    }
 804
 805    virtual void print(void) const;
 806
 807    virtual ir_rvalue *hir(exec_list *instructions,
 808                           struct _mesa_glsl_parse_state *state);
 809
 810    ast_fully_specified_type *type;
 811    const char *identifier;
 812    ast_array_specifier *array_specifier;
 813
 814    static void parameters_to_hir(exec_list *ast_parameters,
 815                                  bool formal, exec_list *ir_parameters,
 816                                  struct _mesa_glsl_parse_state *state);
 817
 818 private:
 819    /** Is this parameter declaration part of a formal parameter list? */
 820    bool formal_parameter;
 821
 822    /**
 823     * Is this parameter 'void' type?
 824     *
 825     * This field is set by \c ::hir.
 826     */
 827    bool is_void;
 828 };
 829
 830
 831 class ast_function : public ast_node {
 832 public:
 833    ast_function(void);
 834
 835    virtual void print(void) const;
 836
 837    virtual ir_rvalue *hir(exec_list *instructions,
 838                           struct _mesa_glsl_parse_state *state);
 839
 840    ast_fully_specified_type *return_type;
 841    const char *identifier;
 842
 843    exec_list parameters;
 844
 845 private:
 846    /**
 847     * Is this prototype part of the function definition?
 848     *
 849     * Used by ast_function_definition::hir to process the parameters, etc.
 850     * of the function.
 851     *
 852     * \sa ::hir
 853     */
 854    bool is_definition;
 855
 856    /**
 857     * Function signature corresponding to this function prototype instance
 858     *
 859     * Used by ast_function_definition::hir to process the parameters, etc.
 860     * of the function.
 861     *
 862     * \sa ::hir
 863     */
 864    class ir_function_signature *signature;
 865
 866    friend class ast_function_definition;
 867 };
 868
 869
 870 class ast_expression_statement : public ast_node {
 871 public:
 872    ast_expression_statement(ast_expression *);
 873    virtual void print(void) const;
 874
 875    virtual ir_rvalue *hir(exec_list *instructions,
 876                           struct _mesa_glsl_parse_state *state);
 877
 878    ast_expression *expression;
 879 };
 880
 881
 882 class ast_case_label : public ast_node {
 883 public:
 884    ast_case_label(ast_expression *test_value);
 885    virtual void print(void) const;
 886
 887    virtual ir_rvalue *hir(exec_list *instructions,
 888                           struct _mesa_glsl_parse_state *state);
 889
 890    /**
 891     * An test value of NULL means 'default'.
 892     */
 893    ast_expression *test_value;
 894 };
 895
 896
 897 class ast_case_label_list : public ast_node {
 898 public:
 899    ast_case_label_list(void);
 900    virtual void print(void) const;
 901
 902    virtual ir_rvalue *hir(exec_list *instructions,
 903                           struct _mesa_glsl_parse_state *state);
 904
 905    /**
 906     * A list of case labels.
 907     */
 908    exec_list labels;
 909 };
 910
 911
 912 class ast_case_statement : public ast_node {
 913 public:
 914    ast_case_statement(ast_case_label_list *labels);
 915    virtual void print(void) const;
 916
 917    virtual ir_rvalue *hir(exec_list *instructions,
 918                           struct _mesa_glsl_parse_state *state);
 919
 920    ast_case_label_list *labels;
 921
 922    /**
 923     * A list of statements.
 924     */
 925    exec_list stmts;
 926 };
 927
 928
 929 class ast_case_statement_list : public ast_node {
 930 public:
 931    ast_case_statement_list(void);
 932    virtual void print(void) const;
 933
 934    virtual ir_rvalue *hir(exec_list *instructions,
 935                           struct _mesa_glsl_parse_state *state);
 936
 937    /**
 938     * A list of cases.
 939     */
 940    exec_list cases;
 941 };
 942
 943
 944 class ast_switch_body : public ast_node {
 945 public:
 946    ast_switch_body(ast_case_statement_list *stmts);
 947    virtual void print(void) const;
 948
 949    virtual ir_rvalue *hir(exec_list *instructions,
 950                           struct _mesa_glsl_parse_state *state);
 951
 952    ast_case_statement_list *stmts;
 953 };
 954
 955
 956 class ast_selection_statement : public ast_node {
 957 public:
 958    ast_selection_statement(ast_expression *condition,
 959                            ast_node *then_statement,
 960                            ast_node *else_statement);
 961    virtual void print(void) const;
 962
 963    virtual ir_rvalue *hir(exec_list *instructions,
 964                           struct _mesa_glsl_parse_state *state);
 965
 966    ast_expression *condition;
 967    ast_node *then_statement;
 968    ast_node *else_statement;
 969 };
 970
 971
 972 class ast_switch_statement : public ast_node {
 973 public:
 974    ast_switch_statement(ast_expression *test_expression,
 975                         ast_node *body);
 976    virtual void print(void) const;
 977
 978    virtual ir_rvalue *hir(exec_list *instructions,
 979                           struct _mesa_glsl_parse_state *state);
 980
 981    ast_expression *test_expression;
 982    ast_node *body;
 983
 984 protected:
 985    void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
 986 };
 987
 988 class ast_iteration_statement : public ast_node {
 989 public:
 990    ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
 991                            ast_expression *rest_expression, ast_node *body);
 992
 993    virtual void print(void) const;
 994
 995    virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 996
 997    enum ast_iteration_modes {
 998       ast_for,
 999       ast_while,
1000       ast_do_while
1001    } mode;
1002
1003
1004    ast_node *init_statement;
1005    ast_node *condition;
1006    ast_expression *rest_expression;
1007
1008    ast_node *body;
1009
1010    /**
1011     * Generate IR from the condition of a loop
1012     *
1013     * This is factored out of ::hir because some loops have the condition
1014     * test at the top (for and while), and others have it at the end (do-while).
1015     */
1016    void condition_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
1017 };
1018
1019
1020 class ast_jump_statement : public ast_node {
1021 public:
1022    ast_jump_statement(int mode, ast_expression *return_value);
1023    virtual void print(void) const;
1024
1025    virtual ir_rvalue *hir(exec_list *instructions,
1026                           struct _mesa_glsl_parse_state *state);
1027
1028    enum ast_jump_modes {
1029       ast_continue,
1030       ast_break,
1031       ast_return,
1032       ast_discard
1033    } mode;
1034
1035    ast_expression *opt_return_value;
1036 };
1037
1038
1039 class ast_function_definition : public ast_node {
1040 public:
1041    ast_function_definition() : prototype(NULL), body(NULL)
1042    {
1043    }
1044
1045    virtual void print(void) const;
1046
1047    virtual ir_rvalue *hir(exec_list *instructions,
1048                           struct _mesa_glsl_parse_state *state);
1049
1050    ast_function *prototype;
1051    ast_compound_statement *body;
1052 };
1053
1054 class ast_interface_block : public ast_node {
1055 public:
1056    ast_interface_block(ast_type_qualifier layout,
1057                        const char *instance_name,
1058                        ast_array_specifier *array_specifier)
1059    : layout(layout), block_name(NULL), instance_name(instance_name),
1060      array_specifier(array_specifier)
1061    {
1062    }
1063
1064    virtual ir_rvalue *hir(exec_list *instructions,
1065                           struct _mesa_glsl_parse_state *state);
1066
1067    ast_type_qualifier layout;
1068    const char *block_name;
1069
1070    /**
1071     * Declared name of the block instance, if specified.
1072     *
1073     * If the block does not have an instance name, this field will be
1074     * \c NULL.
1075     */
1076    const char *instance_name;
1077
1078    /** List of ast_declarator_list * */
1079    exec_list declarations;
1080
1081    /**
1082     * Declared array size of the block instance
1083     *
1084     * If the block is not declared as an array or if the block instance array
1085     * is unsized, this field will be \c NULL.
1086     */
1087    ast_array_specifier *array_specifier;
1088 };
1089
1090
1091 /**
1092  * AST node representing a declaration of the output layout for tessellation
1093  * control shaders.
1094  */
1095 class ast_tcs_output_layout : public ast_node
1096 {
1097 public:
1098    ast_tcs_output_layout(const struct YYLTYPE &locp, int vertices)
1099       : vertices(vertices)
1100    {
1101       set_location(locp);
1102    }
1103
1104    virtual ir_rvalue *hir(exec_list *instructions,
1105                           struct _mesa_glsl_parse_state *state);
1106
1107 private:
1108    const int vertices;
1109 };
1110
1111
1112 /**
1113  * AST node representing a declaration of the input layout for geometry
1114  * shaders.
1115  */
1116 class ast_gs_input_layout : public ast_node
1117 {
1118 public:
1119    ast_gs_input_layout(const struct YYLTYPE &locp, GLenum prim_type)
1120       : prim_type(prim_type)
1121    {
1122       set_location(locp);
1123    }
1124
1125    virtual ir_rvalue *hir(exec_list *instructions,
1126                           struct _mesa_glsl_parse_state *state);
1127
1128 private:
1129    const GLenum prim_type;
1130 };
1131
1132
1133 /**
1134  * AST node representing a decalaration of the input layout for compute
1135  * shaders.
1136  */
1137 class ast_cs_input_layout : public ast_node
1138 {
1139 public:
1140    ast_cs_input_layout(const struct YYLTYPE &locp, const unsigned *local_size)
1141    {
1142       memcpy(this->local_size, local_size, sizeof(this->local_size));
1143       set_location(locp);
1144    }
1145
1146    virtual ir_rvalue *hir(exec_list *instructions,
1147                           struct _mesa_glsl_parse_state *state);
1148
1149 private:
1150    unsigned local_size[3];
1151 };
1152
1153 /*@}*/
1154
1155 extern void
1156 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
1157
1158 extern ir_rvalue *
1159 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
1160                                  exec_list *instructions,
1161                                  struct _mesa_glsl_parse_state *state);
1162
1163 extern ir_rvalue *
1164 _mesa_ast_array_index_to_hir(void *mem_ctx,
1165                              struct _mesa_glsl_parse_state *state,
1166                              ir_rvalue *array, ir_rvalue *idx,
1167                              YYLTYPE &loc, YYLTYPE &idx_loc);
1168
1169 extern void
1170 _mesa_ast_set_aggregate_type(const glsl_type *type,
1171                              ast_expression *expr);
1172
1173 void
1174 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
1175
1176 extern void
1177 check_builtin_array_max_size(const char *name, unsigned size,
1178                              YYLTYPE loc, struct _mesa_glsl_parse_state *state);
1179
1180 #endif /* AST_H */