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