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