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.line;
  79       locp.first_column = this->location.column;
  80       locp.last_line = locp.first_line;
  81       locp.last_column = locp.first_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.line = locp.first_line;
  95       this->location.column = locp.first_column;
  96    }
  97
  98    /**
  99     * Source location of the AST node.
 100     */
 101    struct {
 102       unsigned source;    /**< GLSL source number. */
 103       unsigned line;      /**< Line number within the source string. */
 104       unsigned column;    /**< Column in the line. */
 105    } location;
 106
 107    exec_node link;
 108
 109 protected:
 110    /**
 111     * The only constructor is protected so that only derived class objects can
 112     * be created.
 113     */
 114    ast_node(void);
 115 };
 116
 117
 118 /**
 119  * Operators for AST expression nodes.
 120  */
 121 enum ast_operators {
 122    ast_assign,
 123    ast_plus,        /**< Unary + operator. */
 124    ast_neg,
 125    ast_add,
 126    ast_sub,
 127    ast_mul,
 128    ast_div,
 129    ast_mod,
 130    ast_lshift,
 131    ast_rshift,
 132    ast_less,
 133    ast_greater,
 134    ast_lequal,
 135    ast_gequal,
 136    ast_equal,
 137    ast_nequal,
 138    ast_bit_and,
 139    ast_bit_xor,
 140    ast_bit_or,
 141    ast_bit_not,
 142    ast_logic_and,
 143    ast_logic_xor,
 144    ast_logic_or,
 145    ast_logic_not,
 146
 147    ast_mul_assign,
 148    ast_div_assign,
 149    ast_mod_assign,
 150    ast_add_assign,
 151    ast_sub_assign,
 152    ast_ls_assign,
 153    ast_rs_assign,
 154    ast_and_assign,
 155    ast_xor_assign,
 156    ast_or_assign,
 157
 158    ast_conditional,
 159
 160    ast_pre_inc,
 161    ast_pre_dec,
 162    ast_post_inc,
 163    ast_post_dec,
 164    ast_field_selection,
 165    ast_array_index,
 166
 167    ast_function_call,
 168
 169    ast_identifier,
 170    ast_int_constant,
 171    ast_uint_constant,
 172    ast_float_constant,
 173    ast_bool_constant,
 174
 175    ast_sequence,
 176    ast_aggregate
 177 };
 178
 179 /**
 180  * Representation of any sort of expression.
 181  */
 182 class ast_expression : public ast_node {
 183 public:
 184    ast_expression(int oper, ast_expression *,
 185                   ast_expression *, ast_expression *);
 186
 187    ast_expression(const char *identifier) :
 188       oper(ast_identifier)
 189    {
 190       subexpressions[0] = NULL;
 191       subexpressions[1] = NULL;
 192       subexpressions[2] = NULL;
 193       primary_expression.identifier = identifier;
 194       this->non_lvalue_description = NULL;
 195    }
 196
 197    static const char *operator_string(enum ast_operators op);
 198
 199    virtual ir_rvalue *hir(exec_list *instructions,
 200                           struct _mesa_glsl_parse_state *state);
 201
 202    virtual void print(void) const;
 203
 204    enum ast_operators oper;
 205
 206    ast_expression *subexpressions[3];
 207
 208    union {
 209       const char *identifier;
 210       int int_constant;
 211       float float_constant;
 212       unsigned uint_constant;
 213       int bool_constant;
 214    } primary_expression;
 215
 216
 217    /**
 218     * List of expressions for an \c ast_sequence or parameters for an
 219     * \c ast_function_call
 220     */
 221    exec_list expressions;
 222
 223    /**
 224     * For things that can't be l-values, this describes what it is.
 225     *
 226     * This text is used by the code that generates IR for assignments to
 227     * detect and emit useful messages for assignments to some things that
 228     * can't be l-values.  For example, pre- or post-incerement expressions.
 229     *
 230     * \note
 231     * This pointer may be \c NULL.
 232     */
 233    const char *non_lvalue_description;
 234 };
 235
 236 class ast_expression_bin : public ast_expression {
 237 public:
 238    ast_expression_bin(int oper, ast_expression *, ast_expression *);
 239
 240    virtual void print(void) const;
 241 };
 242
 243 /**
 244  * Subclass of expressions for function calls
 245  */
 246 class ast_function_expression : public ast_expression {
 247 public:
 248    ast_function_expression(ast_expression *callee)
 249       : ast_expression(ast_function_call, callee,
 250                        NULL, NULL),
 251         cons(false)
 252    {
 253       /* empty */
 254    }
 255
 256    ast_function_expression(class ast_type_specifier *type)
 257       : ast_expression(ast_function_call, (ast_expression *) type,
 258                        NULL, NULL),
 259         cons(true)
 260    {
 261       /* empty */
 262    }
 263
 264    bool is_constructor() const
 265    {
 266       return cons;
 267    }
 268
 269    virtual ir_rvalue *hir(exec_list *instructions,
 270                           struct _mesa_glsl_parse_state *state);
 271
 272 private:
 273    /**
 274     * Is this function call actually a constructor?
 275     */
 276    bool cons;
 277 };
 278
 279 /**
 280  * C-style aggregate initialization class
 281  *
 282  * Represents C-style initializers of vectors, matrices, arrays, and
 283  * structures. E.g., vec3 pos = {1.0, 0.0, -1.0} is equivalent to
 284  * vec3 pos = vec3(1.0, 0.0, -1.0).
 285  *
 286  * Specified in GLSL 4.20 and GL_ARB_shading_language_420pack.
 287  *
 288  * \sa _mesa_ast_set_aggregate_type
 289  */
 290 class ast_aggregate_initializer : public ast_expression {
 291 public:
 292    ast_aggregate_initializer()
 293       : ast_expression(ast_aggregate, NULL, NULL, NULL),
 294         constructor_type(NULL)
 295    {
 296       /* empty */
 297    }
 298
 299    ast_type_specifier *constructor_type;
 300    virtual ir_rvalue *hir(exec_list *instructions,
 301                           struct _mesa_glsl_parse_state *state);
 302 };
 303
 304 /**
 305  * Number of possible operators for an ast_expression
 306  *
 307  * This is done as a define instead of as an additional value in the enum so
 308  * that the compiler won't generate spurious messages like "warning:
 309  * enumeration value ‘ast_num_operators’ not handled in switch"
 310  */
 311 #define AST_NUM_OPERATORS (ast_sequence + 1)
 312
 313
 314 class ast_compound_statement : public ast_node {
 315 public:
 316    ast_compound_statement(int new_scope, ast_node *statements);
 317    virtual void print(void) const;
 318
 319    virtual ir_rvalue *hir(exec_list *instructions,
 320                           struct _mesa_glsl_parse_state *state);
 321
 322    int new_scope;
 323    exec_list statements;
 324 };
 325
 326 class ast_declaration : public ast_node {
 327 public:
 328    ast_declaration(const char *identifier, bool is_array, ast_expression *array_size,
 329                    ast_expression *initializer);
 330    virtual void print(void) const;
 331
 332    const char *identifier;
 333
 334    bool is_array;
 335    ast_expression *array_size;
 336
 337    ast_expression *initializer;
 338 };
 339
 340
 341 enum {
 342    ast_precision_none = 0, /**< Absence of precision qualifier. */
 343    ast_precision_high,
 344    ast_precision_medium,
 345    ast_precision_low
 346 };
 347
 348 struct ast_type_qualifier {
 349    DECLARE_RALLOC_CXX_OPERATORS(ast_type_qualifier);
 350
 351    union {
 352       struct {
 353          unsigned invariant:1;
 354          unsigned constant:1;
 355          unsigned attribute:1;
 356          unsigned varying:1;
 357          unsigned in:1;
 358          unsigned out:1;
 359          unsigned centroid:1;
 360          unsigned uniform:1;
 361          unsigned smooth:1;
 362          unsigned flat:1;
 363          unsigned noperspective:1;
 364
 365          /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
 366          /*@{*/
 367          unsigned origin_upper_left:1;
 368          unsigned pixel_center_integer:1;
 369          /*@}*/
 370
 371          /**
 372           * Flag set if GL_ARB_explicit_attrib_location "location" layout
 373           * qualifier is used.
 374           */
 375          unsigned explicit_location:1;
 376          /**
 377           * Flag set if GL_ARB_explicit_attrib_location "index" layout
 378           * qualifier is used.
 379           */
 380          unsigned explicit_index:1;
 381
 382          /**
 383           * Flag set if GL_ARB_shading_language_420pack "binding" layout
 384           * qualifier is used.
 385           */
 386          unsigned explicit_binding:1;
 387
 388          /** \name Layout qualifiers for GL_AMD_conservative_depth */
 389          /** \{ */
 390          unsigned depth_any:1;
 391          unsigned depth_greater:1;
 392          unsigned depth_less:1;
 393          unsigned depth_unchanged:1;
 394          /** \} */
 395
 396          /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
 397          /** \{ */
 398          unsigned std140:1;
 399          unsigned shared:1;
 400          unsigned packed:1;
 401          unsigned column_major:1;
 402          unsigned row_major:1;
 403          /** \} */
 404
 405          /** \name Layout qualifiers for GLSL 1.50 geometry shaders */
 406          /** \{ */
 407          unsigned prim_type:1;
 408          unsigned max_vertices:1;
 409          /** \} */
 410       }
 411       /** \brief Set of flags, accessed by name. */
 412       q;
 413
 414       /** \brief Set of flags, accessed as a bitmask. */
 415       unsigned i;
 416    } flags;
 417
 418    /** Precision of the type (highp/medium/lowp). */
 419    unsigned precision:2;
 420
 421    /**
 422     * Location specified via GL_ARB_explicit_attrib_location layout
 423     *
 424     * \note
 425     * This field is only valid if \c explicit_location is set.
 426     */
 427    int location;
 428    /**
 429     * Index specified via GL_ARB_explicit_attrib_location layout
 430     *
 431     * \note
 432     * This field is only valid if \c explicit_index is set.
 433     */
 434    int index;
 435
 436    /** Maximum output vertices in GLSL 1.50 geometry shaders. */
 437    int max_vertices;
 438
 439    /** Input or output primitive type in GLSL 1.50 geometry shaders */
 440    GLenum prim_type;
 441
 442    /**
 443     * Binding specified via GL_ARB_shading_language_420pack's "binding" keyword.
 444     *
 445     * \note
 446     * This field is only valid if \c explicit_binding is set.
 447     */
 448    int binding;
 449
 450    /**
 451     * Return true if and only if an interpolation qualifier is present.
 452     */
 453    bool has_interpolation() const;
 454
 455    /**
 456     * Return whether a layout qualifier is present.
 457     */
 458    bool has_layout() const;
 459
 460    /**
 461     * Return whether a storage qualifier is present.
 462     */
 463    bool has_storage() const;
 464
 465    /**
 466     * Return whether an auxiliary storage qualifier is present.
 467     */
 468    bool has_auxiliary_storage() const;
 469
 470    /**
 471     * \brief Return string representation of interpolation qualifier.
 472     *
 473     * If an interpolation qualifier is present, then return that qualifier's
 474     * string representation. Otherwise, return null. For example, if the
 475     * noperspective bit is set, then this returns "noperspective".
 476     *
 477     * If multiple interpolation qualifiers are somehow present, then the
 478     * returned string is undefined but not null.
 479     */
 480    const char *interpolation_string() const;
 481
 482    bool merge_qualifier(YYLTYPE *loc,
 483                         _mesa_glsl_parse_state *state,
 484                         ast_type_qualifier q);
 485 };
 486
 487 class ast_declarator_list;
 488
 489 class ast_struct_specifier : public ast_node {
 490 public:
 491    /**
 492     * \brief Make a shallow copy of an ast_struct_specifier.
 493     *
 494     * Use only if the objects are allocated from the same context and will not
 495     * be modified. Zeros the inherited ast_node's fields.
 496     */
 497    ast_struct_specifier(const ast_struct_specifier& that):
 498       ast_node(), name(that.name), declarations(that.declarations),
 499       is_declaration(that.is_declaration)
 500    {
 501       /* empty */
 502    }
 503
 504    ast_struct_specifier(const char *identifier,
 505                         ast_declarator_list *declarator_list);
 506    virtual void print(void) const;
 507
 508    virtual ir_rvalue *hir(exec_list *instructions,
 509                           struct _mesa_glsl_parse_state *state);
 510
 511    const char *name;
 512    /* List of ast_declarator_list * */
 513    exec_list declarations;
 514    bool is_declaration;
 515 };
 516
 517
 518
 519 class ast_type_specifier : public ast_node {
 520 public:
 521    /**
 522     * \brief Make a shallow copy of an ast_type_specifier, specifying array
 523     *        fields.
 524     *
 525     * Use only if the objects are allocated from the same context and will not
 526     * be modified. Zeros the inherited ast_node's fields.
 527     */
 528    ast_type_specifier(const ast_type_specifier *that, bool is_array,
 529                       ast_expression *array_size)
 530       : ast_node(), type_name(that->type_name), structure(that->structure),
 531         is_array(is_array), array_size(array_size),
 532         default_precision(that->default_precision)
 533    {
 534       /* empty */
 535    }
 536
 537    /** Construct a type specifier from a type name */
 538    ast_type_specifier(const char *name)
 539       : type_name(name), structure(NULL),
 540         is_array(false), array_size(NULL),
 541         default_precision(ast_precision_none)
 542    {
 543       /* empty */
 544    }
 545
 546    /** Construct a type specifier from a structure definition */
 547    ast_type_specifier(ast_struct_specifier *s)
 548       : type_name(s->name), structure(s),
 549         is_array(false), array_size(NULL),
 550         default_precision(ast_precision_none)
 551    {
 552       /* empty */
 553    }
 554
 555    const struct glsl_type *glsl_type(const char **name,
 556                                      struct _mesa_glsl_parse_state *state)
 557       const;
 558
 559    virtual void print(void) const;
 560
 561    ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 562
 563    const char *type_name;
 564    ast_struct_specifier *structure;
 565
 566    bool is_array;
 567    ast_expression *array_size;
 568
 569    /** For precision statements, this is the given precision; otherwise none. */
 570    unsigned default_precision:2;
 571 };
 572
 573
 574 class ast_fully_specified_type : public ast_node {
 575 public:
 576    virtual void print(void) const;
 577    bool has_qualifiers() const;
 578
 579    ast_fully_specified_type() : qualifier(), specifier(NULL)
 580    {
 581    }
 582
 583    const struct glsl_type *glsl_type(const char **name,
 584                                      struct _mesa_glsl_parse_state *state)
 585       const;
 586
 587    ast_type_qualifier qualifier;
 588    ast_type_specifier *specifier;
 589 };
 590
 591
 592 class ast_declarator_list : public ast_node {
 593 public:
 594    ast_declarator_list(ast_fully_specified_type *);
 595    virtual void print(void) const;
 596
 597    virtual ir_rvalue *hir(exec_list *instructions,
 598                           struct _mesa_glsl_parse_state *state);
 599
 600    ast_fully_specified_type *type;
 601    /** List of 'ast_declaration *' */
 602    exec_list declarations;
 603
 604    /**
 605     * Special flag for vertex shader "invariant" declarations.
 606     *
 607     * Vertex shaders can contain "invariant" variable redeclarations that do
 608     * not include a type.  For example, "invariant gl_Position;".  This flag
 609     * is used to note these cases when no type is specified.
 610     */
 611    int invariant;
 612 };
 613
 614
 615 class ast_parameter_declarator : public ast_node {
 616 public:
 617    ast_parameter_declarator() :
 618       type(NULL),
 619       identifier(NULL),
 620       is_array(false),
 621       array_size(NULL),
 622       formal_parameter(false),
 623       is_void(false)
 624    {
 625       /* empty */
 626    }
 627
 628    virtual void print(void) const;
 629
 630    virtual ir_rvalue *hir(exec_list *instructions,
 631                           struct _mesa_glsl_parse_state *state);
 632
 633    ast_fully_specified_type *type;
 634    const char *identifier;
 635    bool is_array;
 636    ast_expression *array_size;
 637
 638    static void parameters_to_hir(exec_list *ast_parameters,
 639                                  bool formal, exec_list *ir_parameters,
 640                                  struct _mesa_glsl_parse_state *state);
 641
 642 private:
 643    /** Is this parameter declaration part of a formal parameter list? */
 644    bool formal_parameter;
 645
 646    /**
 647     * Is this parameter 'void' type?
 648     *
 649     * This field is set by \c ::hir.
 650     */
 651    bool is_void;
 652 };
 653
 654
 655 class ast_function : public ast_node {
 656 public:
 657    ast_function(void);
 658
 659    virtual void print(void) const;
 660
 661    virtual ir_rvalue *hir(exec_list *instructions,
 662                           struct _mesa_glsl_parse_state *state);
 663
 664    ast_fully_specified_type *return_type;
 665    const char *identifier;
 666
 667    exec_list parameters;
 668
 669 private:
 670    /**
 671     * Is this prototype part of the function definition?
 672     *
 673     * Used by ast_function_definition::hir to process the parameters, etc.
 674     * of the function.
 675     *
 676     * \sa ::hir
 677     */
 678    bool is_definition;
 679
 680    /**
 681     * Function signature corresponding to this function prototype instance
 682     *
 683     * Used by ast_function_definition::hir to process the parameters, etc.
 684     * of the function.
 685     *
 686     * \sa ::hir
 687     */
 688    class ir_function_signature *signature;
 689
 690    friend class ast_function_definition;
 691 };
 692
 693
 694 class ast_expression_statement : public ast_node {
 695 public:
 696    ast_expression_statement(ast_expression *);
 697    virtual void print(void) const;
 698
 699    virtual ir_rvalue *hir(exec_list *instructions,
 700                           struct _mesa_glsl_parse_state *state);
 701
 702    ast_expression *expression;
 703 };
 704
 705
 706 class ast_case_label : public ast_node {
 707 public:
 708    ast_case_label(ast_expression *test_value);
 709    virtual void print(void) const;
 710
 711    virtual ir_rvalue *hir(exec_list *instructions,
 712                           struct _mesa_glsl_parse_state *state);
 713
 714    /**
 715     * An test value of NULL means 'default'.
 716     */
 717    ast_expression *test_value;
 718 };
 719
 720
 721 class ast_case_label_list : public ast_node {
 722 public:
 723    ast_case_label_list(void);
 724    virtual void print(void) const;
 725
 726    virtual ir_rvalue *hir(exec_list *instructions,
 727                           struct _mesa_glsl_parse_state *state);
 728
 729    /**
 730     * A list of case labels.
 731     */
 732    exec_list labels;
 733 };
 734
 735
 736 class ast_case_statement : public ast_node {
 737 public:
 738    ast_case_statement(ast_case_label_list *labels);
 739    virtual void print(void) const;
 740
 741    virtual ir_rvalue *hir(exec_list *instructions,
 742                           struct _mesa_glsl_parse_state *state);
 743
 744    ast_case_label_list *labels;
 745
 746    /**
 747     * A list of statements.
 748     */
 749    exec_list stmts;
 750 };
 751
 752
 753 class ast_case_statement_list : public ast_node {
 754 public:
 755    ast_case_statement_list(void);
 756    virtual void print(void) const;
 757
 758    virtual ir_rvalue *hir(exec_list *instructions,
 759                           struct _mesa_glsl_parse_state *state);
 760
 761    /**
 762     * A list of cases.
 763     */
 764    exec_list cases;
 765 };
 766
 767
 768 class ast_switch_body : public ast_node {
 769 public:
 770    ast_switch_body(ast_case_statement_list *stmts);
 771    virtual void print(void) const;
 772
 773    virtual ir_rvalue *hir(exec_list *instructions,
 774                           struct _mesa_glsl_parse_state *state);
 775
 776    ast_case_statement_list *stmts;
 777 };
 778
 779
 780 class ast_selection_statement : public ast_node {
 781 public:
 782    ast_selection_statement(ast_expression *condition,
 783                            ast_node *then_statement,
 784                            ast_node *else_statement);
 785    virtual void print(void) const;
 786
 787    virtual ir_rvalue *hir(exec_list *instructions,
 788                           struct _mesa_glsl_parse_state *state);
 789
 790    ast_expression *condition;
 791    ast_node *then_statement;
 792    ast_node *else_statement;
 793 };
 794
 795
 796 class ast_switch_statement : public ast_node {
 797 public:
 798    ast_switch_statement(ast_expression *test_expression,
 799                         ast_node *body);
 800    virtual void print(void) const;
 801
 802    virtual ir_rvalue *hir(exec_list *instructions,
 803                           struct _mesa_glsl_parse_state *state);
 804
 805    ast_expression *test_expression;
 806    ast_node *body;
 807
 808 protected:
 809    void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
 810 };
 811
 812 class ast_iteration_statement : public ast_node {
 813 public:
 814    ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
 815                            ast_expression *rest_expression, ast_node *body);
 816
 817    virtual void print(void) const;
 818
 819    virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
 820
 821    enum ast_iteration_modes {
 822       ast_for,
 823       ast_while,
 824       ast_do_while
 825    } mode;
 826
 827
 828    ast_node *init_statement;
 829    ast_node *condition;
 830    ast_expression *rest_expression;
 831
 832    ast_node *body;
 833
 834 private:
 835    /**
 836     * Generate IR from the condition of a loop
 837     *
 838     * This is factored out of ::hir because some loops have the condition
 839     * test at the top (for and while), and others have it at the end (do-while).
 840     */
 841    void condition_to_hir(class ir_loop *, struct _mesa_glsl_parse_state *);
 842 };
 843
 844
 845 class ast_jump_statement : public ast_node {
 846 public:
 847    ast_jump_statement(int mode, ast_expression *return_value);
 848    virtual void print(void) const;
 849
 850    virtual ir_rvalue *hir(exec_list *instructions,
 851                           struct _mesa_glsl_parse_state *state);
 852
 853    enum ast_jump_modes {
 854       ast_continue,
 855       ast_break,
 856       ast_return,
 857       ast_discard
 858    } mode;
 859
 860    ast_expression *opt_return_value;
 861 };
 862
 863
 864 class ast_function_definition : public ast_node {
 865 public:
 866    ast_function_definition() : prototype(NULL), body(NULL)
 867    {
 868    }
 869
 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_function *prototype;
 876    ast_compound_statement *body;
 877 };
 878
 879 class ast_interface_block : public ast_node {
 880 public:
 881    ast_interface_block(ast_type_qualifier layout,
 882                        const char *instance_name,
 883                        bool is_array,
 884                        ast_expression *array_size)
 885    : layout(layout), block_name(NULL), instance_name(instance_name),
 886      is_array(is_array), array_size(array_size)
 887    {
 888       if (!is_array)
 889          assert(array_size == NULL);
 890    }
 891
 892    virtual ir_rvalue *hir(exec_list *instructions,
 893                           struct _mesa_glsl_parse_state *state);
 894
 895    ast_type_qualifier layout;
 896    const char *block_name;
 897
 898    /**
 899     * Declared name of the block instance, if specified.
 900     *
 901     * If the block does not have an instance name, this field will be
 902     * \c NULL.
 903     */
 904    const char *instance_name;
 905
 906    /** List of ast_declarator_list * */
 907    exec_list declarations;
 908
 909    /**
 910     * True if the block is declared as an array
 911     *
 912     * \note
 913     * A block can only be an array if it also has an instance name.  If this
 914     * field is true, ::instance_name must also not be \c NULL.
 915     */
 916    bool is_array;
 917
 918    /**
 919     * Declared array size of the block instance
 920     *
 921     * If the block is not declared as an array or if the block instance array
 922     * is unsized, this field will be \c NULL.
 923     */
 924    ast_expression *array_size;
 925 };
 926
 927
 928 /**
 929  * AST node representing a declaration of the input layout for geometry
 930  * shaders.
 931  */
 932 class ast_gs_input_layout : public ast_node
 933 {
 934 public:
 935    ast_gs_input_layout(const struct YYLTYPE &locp, GLenum prim_type)
 936       : prim_type(prim_type)
 937    {
 938       set_location(locp);
 939    }
 940
 941    virtual ir_rvalue *hir(exec_list *instructions,
 942                           struct _mesa_glsl_parse_state *state);
 943
 944 private:
 945    const GLenum prim_type;
 946 };
 947
 948 /*@}*/
 949
 950 extern void
 951 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
 952
 953 extern ir_rvalue *
 954 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
 955                                  exec_list *instructions,
 956                                  struct _mesa_glsl_parse_state *state);
 957
 958 extern ir_rvalue *
 959 _mesa_ast_array_index_to_hir(void *mem_ctx,
 960                              struct _mesa_glsl_parse_state *state,
 961                              ir_rvalue *array, ir_rvalue *idx,
 962                              YYLTYPE &loc, YYLTYPE &idx_loc);
 963
 964 extern void
 965 _mesa_ast_set_aggregate_type(const ast_type_specifier *type,
 966                              ast_expression *expr,
 967                              _mesa_glsl_parse_state *state);
 968
 969 void
 970 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
 971
 972 extern void
 973 check_builtin_array_max_size(const char *name, unsigned size,
 974                              YYLTYPE loc, struct _mesa_glsl_parse_state *state);
 975
 976 #endif /* AST_H */