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