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