3 * Copyright © 2009 Intel Corporation
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:
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
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.
30 #include "glsl_parser_extras.h"
32 struct _mesa_glsl_parse_state
;
37 * \defgroup AST Abstract syntax tree node definitions
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.
48 * Base class of all abstract syntax tree nodes
52 /* Callers of this ralloc-based new need not call delete. It's
53 * easier to just ralloc_free 'ctx' (or any of its ancestors). */
54 static void* operator new(size_t size
, void *ctx
)
58 node
= rzalloc_size(ctx
, size
);
64 /* If the user *does* call delete, that's OK, we will just
65 * ralloc_free in that case. */
66 static void operator delete(void *table
)
72 * Print an AST node in something approximating the original GLSL code
74 virtual void print(void) const;
77 * Convert the AST node to the high-level intermediate representation
79 virtual ir_rvalue
*hir(exec_list
*instructions
,
80 struct _mesa_glsl_parse_state
*state
);
83 * Retrieve the source location of an AST node
85 * This function is primarily used to get the source position of an AST node
86 * into a form that can be passed to \c _mesa_glsl_error.
88 * \sa _mesa_glsl_error, ast_node::set_location
90 struct YYLTYPE
get_location(void) const
94 locp
.source
= this->location
.source
;
95 locp
.first_line
= this->location
.line
;
96 locp
.first_column
= this->location
.column
;
97 locp
.last_line
= locp
.first_line
;
98 locp
.last_column
= locp
.first_column
;
104 * Set the source location of an AST node from a parser location
106 * \sa ast_node::get_location
108 void set_location(const struct YYLTYPE
&locp
)
110 this->location
.source
= locp
.source
;
111 this->location
.line
= locp
.first_line
;
112 this->location
.column
= locp
.first_column
;
116 * Source location of the AST node.
119 unsigned source
; /**< GLSL source number. */
120 unsigned line
; /**< Line number within the source string. */
121 unsigned column
; /**< Column in the line. */
128 * The only constructor is protected so that only derived class objects can
136 * Operators for AST expression nodes.
140 ast_plus
, /**< Unary + operator. */
196 * Representation of any sort of expression.
198 class ast_expression
: public ast_node
{
200 ast_expression(int oper
, ast_expression
*,
201 ast_expression
*, ast_expression
*);
203 ast_expression(const char *identifier
) :
206 subexpressions
[0] = NULL
;
207 subexpressions
[1] = NULL
;
208 subexpressions
[2] = NULL
;
209 primary_expression
.identifier
= identifier
;
210 this->non_lvalue_description
= NULL
;
213 static const char *operator_string(enum ast_operators op
);
215 virtual ir_rvalue
*hir(exec_list
*instructions
,
216 struct _mesa_glsl_parse_state
*state
);
218 virtual void print(void) const;
220 enum ast_operators oper
;
222 ast_expression
*subexpressions
[3];
225 const char *identifier
;
227 float float_constant
;
228 unsigned uint_constant
;
230 } primary_expression
;
234 * List of expressions for an \c ast_sequence or parameters for an
235 * \c ast_function_call
237 exec_list expressions
;
240 * For things that can't be l-values, this describes what it is.
242 * This text is used by the code that generates IR for assignments to
243 * detect and emit useful messages for assignments to some things that
244 * can't be l-values. For example, pre- or post-incerement expressions.
247 * This pointer may be \c NULL.
249 const char *non_lvalue_description
;
252 class ast_expression_bin
: public ast_expression
{
254 ast_expression_bin(int oper
, ast_expression
*, ast_expression
*);
256 virtual void print(void) const;
260 * Subclass of expressions for function calls
262 class ast_function_expression
: public ast_expression
{
264 ast_function_expression(ast_expression
*callee
)
265 : ast_expression(ast_function_call
, callee
,
272 ast_function_expression(class ast_type_specifier
*type
)
273 : ast_expression(ast_function_call
, (ast_expression
*) type
,
280 bool is_constructor() const
285 virtual ir_rvalue
*hir(exec_list
*instructions
,
286 struct _mesa_glsl_parse_state
*state
);
290 * Is this function call actually a constructor?
297 * Number of possible operators for an ast_expression
299 * This is done as a define instead of as an additional value in the enum so
300 * that the compiler won't generate spurious messages like "warning:
301 * enumeration value ‘ast_num_operators’ not handled in switch"
303 #define AST_NUM_OPERATORS (ast_sequence + 1)
306 class ast_compound_statement
: public ast_node
{
308 ast_compound_statement(int new_scope
, ast_node
*statements
);
309 virtual void print(void) const;
311 virtual ir_rvalue
*hir(exec_list
*instructions
,
312 struct _mesa_glsl_parse_state
*state
);
315 exec_list statements
;
318 class ast_declaration
: public ast_node
{
320 ast_declaration(const char *identifier
, bool is_array
, ast_expression
*array_size
,
321 ast_expression
*initializer
);
322 virtual void print(void) const;
324 const char *identifier
;
327 ast_expression
*array_size
;
329 ast_expression
*initializer
;
334 ast_precision_none
= 0, /**< Absence of precision qualifier. */
336 ast_precision_medium
,
340 struct ast_type_qualifier
{
341 /* Callers of this ralloc-based new need not call delete. It's
342 * easier to just ralloc_free 'ctx' (or any of its ancestors). */
343 static void* operator new(size_t size
, void *ctx
)
347 node
= rzalloc_size(ctx
, size
);
348 assert(node
!= NULL
);
353 /* If the user *does* call delete, that's OK, we will just
354 * ralloc_free in that case. */
355 static void operator delete(void *table
)
362 unsigned invariant
:1;
364 unsigned attribute
:1;
372 unsigned noperspective
:1;
374 /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
376 unsigned origin_upper_left
:1;
377 unsigned pixel_center_integer
:1;
381 * Flag set if GL_ARB_explicit_attrib_location "location" layout
384 unsigned explicit_location
:1;
386 * Flag set if GL_ARB_explicit_attrib_location "index" layout
389 unsigned explicit_index
:1;
391 /** \name Layout qualifiers for GL_AMD_conservative_depth */
393 unsigned depth_any
:1;
394 unsigned depth_greater
:1;
395 unsigned depth_less
:1;
396 unsigned depth_unchanged
:1;
399 /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
404 unsigned column_major
:1;
405 unsigned row_major
:1;
408 /** \brief Set of flags, accessed by name. */
411 /** \brief Set of flags, accessed as a bitmask. */
416 * Location specified via GL_ARB_explicit_attrib_location layout
419 * This field is only valid if \c explicit_location is set.
423 * Index specified via GL_ARB_explicit_attrib_location layout
426 * This field is only valid if \c explicit_index is set.
431 * Return true if and only if an interpolation qualifier is present.
433 bool has_interpolation() const;
436 * \brief Return string representation of interpolation qualifier.
438 * If an interpolation qualifier is present, then return that qualifier's
439 * string representation. Otherwise, return null. For example, if the
440 * noperspective bit is set, then this returns "noperspective".
442 * If multiple interpolation qualifiers are somehow present, then the
443 * returned string is undefined but not null.
445 const char *interpolation_string() const;
447 bool merge_qualifier(YYLTYPE
*loc
,
448 _mesa_glsl_parse_state
*state
,
449 ast_type_qualifier q
);
452 class ast_declarator_list
;
454 class ast_struct_specifier
: public ast_node
{
457 * \brief Make a shallow copy of an ast_struct_specifier.
459 * Use only if the objects are allocated from the same context and will not
460 * be modified. Zeros the inherited ast_node's fields.
462 ast_struct_specifier(const ast_struct_specifier
& that
):
463 ast_node(), name(that
.name
), declarations(that
.declarations
)
468 ast_struct_specifier(const char *identifier
,
469 ast_declarator_list
*declarator_list
);
470 virtual void print(void) const;
472 virtual ir_rvalue
*hir(exec_list
*instructions
,
473 struct _mesa_glsl_parse_state
*state
);
476 /* List of ast_declarator_list * */
477 exec_list declarations
;
482 class ast_type_specifier
: public ast_node
{
485 * \brief Make a shallow copy of an ast_type_specifier, specifying array
488 * Use only if the objects are allocated from the same context and will not
489 * be modified. Zeros the inherited ast_node's fields.
491 ast_type_specifier(const ast_type_specifier
*that
, bool is_array
,
492 ast_expression
*array_size
)
493 : ast_node(), type_name(that
->type_name
), structure(that
->structure
),
494 is_array(is_array
), array_size(array_size
), precision(that
->precision
),
495 is_precision_statement(that
->is_precision_statement
)
500 /** Construct a type specifier from a type name */
501 ast_type_specifier(const char *name
)
502 : type_name(name
), structure(NULL
),
503 is_array(false), array_size(NULL
), precision(ast_precision_none
),
504 is_precision_statement(false)
509 /** Construct a type specifier from a structure definition */
510 ast_type_specifier(ast_struct_specifier
*s
)
511 : type_name(s
->name
), structure(s
),
512 is_array(false), array_size(NULL
), precision(ast_precision_none
),
513 is_precision_statement(false)
518 const struct glsl_type
*glsl_type(const char **name
,
519 struct _mesa_glsl_parse_state
*state
)
522 virtual void print(void) const;
524 ir_rvalue
*hir(exec_list
*, struct _mesa_glsl_parse_state
*);
526 const char *type_name
;
527 ast_struct_specifier
*structure
;
530 ast_expression
*array_size
;
532 unsigned precision
:2;
534 bool is_precision_statement
;
538 class ast_fully_specified_type
: public ast_node
{
540 virtual void print(void) const;
541 bool has_qualifiers() const;
543 ast_type_qualifier qualifier
;
544 ast_type_specifier
*specifier
;
548 class ast_declarator_list
: public ast_node
{
550 ast_declarator_list(ast_fully_specified_type
*);
551 virtual void print(void) const;
553 virtual ir_rvalue
*hir(exec_list
*instructions
,
554 struct _mesa_glsl_parse_state
*state
);
556 ast_fully_specified_type
*type
;
557 /** List of 'ast_declaration *' */
558 exec_list declarations
;
561 * Special flag for vertex shader "invariant" declarations.
563 * Vertex shaders can contain "invariant" variable redeclarations that do
564 * not include a type. For example, "invariant gl_Position;". This flag
565 * is used to note these cases when no type is specified.
570 * Flag indicating that these declarators are in a uniform block,
571 * allowing UBO type qualifiers.
573 bool ubo_qualifiers_valid
;
577 class ast_parameter_declarator
: public ast_node
{
579 ast_parameter_declarator() :
584 formal_parameter(false),
590 virtual void print(void) const;
592 virtual ir_rvalue
*hir(exec_list
*instructions
,
593 struct _mesa_glsl_parse_state
*state
);
595 ast_fully_specified_type
*type
;
596 const char *identifier
;
598 ast_expression
*array_size
;
600 static void parameters_to_hir(exec_list
*ast_parameters
,
601 bool formal
, exec_list
*ir_parameters
,
602 struct _mesa_glsl_parse_state
*state
);
605 /** Is this parameter declaration part of a formal parameter list? */
606 bool formal_parameter
;
609 * Is this parameter 'void' type?
611 * This field is set by \c ::hir.
617 class ast_function
: public ast_node
{
621 virtual void print(void) const;
623 virtual ir_rvalue
*hir(exec_list
*instructions
,
624 struct _mesa_glsl_parse_state
*state
);
626 ast_fully_specified_type
*return_type
;
627 const char *identifier
;
629 exec_list parameters
;
633 * Is this prototype part of the function definition?
635 * Used by ast_function_definition::hir to process the parameters, etc.
643 * Function signature corresponding to this function prototype instance
645 * Used by ast_function_definition::hir to process the parameters, etc.
650 class ir_function_signature
*signature
;
652 friend class ast_function_definition
;
656 class ast_expression_statement
: public ast_node
{
658 ast_expression_statement(ast_expression
*);
659 virtual void print(void) const;
661 virtual ir_rvalue
*hir(exec_list
*instructions
,
662 struct _mesa_glsl_parse_state
*state
);
664 ast_expression
*expression
;
668 class ast_case_label
: public ast_node
{
670 ast_case_label(ast_expression
*test_value
);
671 virtual void print(void) const;
673 virtual ir_rvalue
*hir(exec_list
*instructions
,
674 struct _mesa_glsl_parse_state
*state
);
677 * An test value of NULL means 'default'.
679 ast_expression
*test_value
;
683 class ast_case_label_list
: public ast_node
{
685 ast_case_label_list(void);
686 virtual void print(void) const;
688 virtual ir_rvalue
*hir(exec_list
*instructions
,
689 struct _mesa_glsl_parse_state
*state
);
692 * A list of case labels.
698 class ast_case_statement
: public ast_node
{
700 ast_case_statement(ast_case_label_list
*labels
);
701 virtual void print(void) const;
703 virtual ir_rvalue
*hir(exec_list
*instructions
,
704 struct _mesa_glsl_parse_state
*state
);
706 ast_case_label_list
*labels
;
709 * A list of statements.
715 class ast_case_statement_list
: public ast_node
{
717 ast_case_statement_list(void);
718 virtual void print(void) const;
720 virtual ir_rvalue
*hir(exec_list
*instructions
,
721 struct _mesa_glsl_parse_state
*state
);
730 class ast_switch_body
: public ast_node
{
732 ast_switch_body(ast_case_statement_list
*stmts
);
733 virtual void print(void) const;
735 virtual ir_rvalue
*hir(exec_list
*instructions
,
736 struct _mesa_glsl_parse_state
*state
);
738 ast_case_statement_list
*stmts
;
742 class ast_selection_statement
: public ast_node
{
744 ast_selection_statement(ast_expression
*condition
,
745 ast_node
*then_statement
,
746 ast_node
*else_statement
);
747 virtual void print(void) const;
749 virtual ir_rvalue
*hir(exec_list
*instructions
,
750 struct _mesa_glsl_parse_state
*state
);
752 ast_expression
*condition
;
753 ast_node
*then_statement
;
754 ast_node
*else_statement
;
758 class ast_switch_statement
: public ast_node
{
760 ast_switch_statement(ast_expression
*test_expression
,
762 virtual void print(void) const;
764 virtual ir_rvalue
*hir(exec_list
*instructions
,
765 struct _mesa_glsl_parse_state
*state
);
767 ast_expression
*test_expression
;
771 void test_to_hir(exec_list
*, struct _mesa_glsl_parse_state
*);
774 class ast_iteration_statement
: public ast_node
{
776 ast_iteration_statement(int mode
, ast_node
*init
, ast_node
*condition
,
777 ast_expression
*rest_expression
, ast_node
*body
);
779 virtual void print(void) const;
781 virtual ir_rvalue
*hir(exec_list
*, struct _mesa_glsl_parse_state
*);
783 enum ast_iteration_modes
{
790 ast_node
*init_statement
;
792 ast_expression
*rest_expression
;
798 * Generate IR from the condition of a loop
800 * This is factored out of ::hir because some loops have the condition
801 * test at the top (for and while), and others have it at the end (do-while).
803 void condition_to_hir(class ir_loop
*, struct _mesa_glsl_parse_state
*);
807 class ast_jump_statement
: public ast_node
{
809 ast_jump_statement(int mode
, ast_expression
*return_value
);
810 virtual void print(void) const;
812 virtual ir_rvalue
*hir(exec_list
*instructions
,
813 struct _mesa_glsl_parse_state
*state
);
815 enum ast_jump_modes
{
822 ast_expression
*opt_return_value
;
826 class ast_function_definition
: public ast_node
{
828 virtual void print(void) const;
830 virtual ir_rvalue
*hir(exec_list
*instructions
,
831 struct _mesa_glsl_parse_state
*state
);
833 ast_function
*prototype
;
834 ast_compound_statement
*body
;
837 class ast_interface_block
: public ast_node
{
839 ast_interface_block(ast_type_qualifier layout
,
840 const char *instance_name
,
841 ast_expression
*array_size
)
842 : layout(layout
), block_name(NULL
), instance_name(instance_name
),
843 array_size(array_size
)
848 virtual ir_rvalue
*hir(exec_list
*instructions
,
849 struct _mesa_glsl_parse_state
*state
);
851 ast_type_qualifier layout
;
852 const char *block_name
;
855 * Declared name of the block instance, if specified.
857 * If the block does not have an instance name, this field will be
860 const char *instance_name
;
862 /** List of ast_declarator_list * */
863 exec_list declarations
;
866 * Declared array size of the block instance
868 * If the block is not declared as an array, this field will be \c NULL.
871 * A block can only be an array if it also has an instance name. If this
872 * field is not \c NULL, ::instance_name must also not be \c NULL.
874 ast_expression
*array_size
;
879 _mesa_ast_to_hir(exec_list
*instructions
, struct _mesa_glsl_parse_state
*state
);
882 _mesa_ast_field_selection_to_hir(const ast_expression
*expr
,
883 exec_list
*instructions
,
884 struct _mesa_glsl_parse_state
*state
);
887 _mesa_ast_array_index_to_hir(void *mem_ctx
,
888 struct _mesa_glsl_parse_state
*state
,
889 ir_rvalue
*array
, ir_rvalue
*idx
,
890 YYLTYPE
&loc
, YYLTYPE
&idx_loc
);
893 emit_function(_mesa_glsl_parse_state
*state
, ir_function
*f
);
896 check_builtin_array_max_size(const char *name
, unsigned size
,
897 YYLTYPE loc
, struct _mesa_glsl_parse_state
*state
);