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, int 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 {
456 ast_struct_specifier(const char *identifier,
457 ast_declarator_list *declarator_list);
458 virtual void print(void) const;
460 virtual ir_rvalue *hir(exec_list *instructions,
461 struct _mesa_glsl_parse_state *state);
464 /* List of ast_declarator_list * */
465 exec_list declarations;
470 class ast_type_specifier : public ast_node {
472 /** Construct a type specifier from a type name */
473 ast_type_specifier(const char *name)
474 : type_name(name), structure(NULL),
475 is_array(false), array_size(NULL), precision(ast_precision_none),
476 is_precision_statement(false)
481 /** Construct a type specifier from a structure definition */
482 ast_type_specifier(ast_struct_specifier *s)
483 : type_name(s->name), structure(s),
484 is_array(false), array_size(NULL), precision(ast_precision_none),
485 is_precision_statement(false)
490 const struct glsl_type *glsl_type(const char **name,
491 struct _mesa_glsl_parse_state *state)
494 virtual void print(void) const;
496 ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
498 const char *type_name;
499 ast_struct_specifier *structure;
502 ast_expression *array_size;
504 unsigned precision:2;
506 bool is_precision_statement;
510 class ast_fully_specified_type : public ast_node {
512 virtual void print(void) const;
513 bool has_qualifiers() const;
515 ast_type_qualifier qualifier;
516 ast_type_specifier *specifier;
520 class ast_declarator_list : public ast_node {
522 ast_declarator_list(ast_fully_specified_type *);
523 virtual void print(void) const;
525 virtual ir_rvalue *hir(exec_list *instructions,
526 struct _mesa_glsl_parse_state *state);
528 ast_fully_specified_type *type;
529 exec_list declarations;
532 * Special flag for vertex shader "invariant" declarations.
534 * Vertex shaders can contain "invariant" variable redeclarations that do
535 * not include a type. For example, "invariant gl_Position;". This flag
536 * is used to note these cases when no type is specified.
541 * Flag indicating that these declarators are in a uniform block,
542 * allowing UBO type qualifiers.
544 bool ubo_qualifiers_valid;
548 class ast_parameter_declarator : public ast_node {
550 ast_parameter_declarator() :
555 formal_parameter(false),
561 virtual void print(void) const;
563 virtual ir_rvalue *hir(exec_list *instructions,
564 struct _mesa_glsl_parse_state *state);
566 ast_fully_specified_type *type;
567 const char *identifier;
569 ast_expression *array_size;
571 static void parameters_to_hir(exec_list *ast_parameters,
572 bool formal, exec_list *ir_parameters,
573 struct _mesa_glsl_parse_state *state);
576 /** Is this parameter declaration part of a formal parameter list? */
577 bool formal_parameter;
580 * Is this parameter 'void' type?
582 * This field is set by \c ::hir.
588 class ast_function : public ast_node {
592 virtual void print(void) const;
594 virtual ir_rvalue *hir(exec_list *instructions,
595 struct _mesa_glsl_parse_state *state);
597 ast_fully_specified_type *return_type;
598 const char *identifier;
600 exec_list parameters;
604 * Is this prototype part of the function definition?
606 * Used by ast_function_definition::hir to process the parameters, etc.
614 * Function signature corresponding to this function prototype instance
616 * Used by ast_function_definition::hir to process the parameters, etc.
621 class ir_function_signature *signature;
623 friend class ast_function_definition;
627 class ast_expression_statement : public ast_node {
629 ast_expression_statement(ast_expression *);
630 virtual void print(void) const;
632 virtual ir_rvalue *hir(exec_list *instructions,
633 struct _mesa_glsl_parse_state *state);
635 ast_expression *expression;
639 class ast_case_label : public ast_node {
641 ast_case_label(ast_expression *test_value);
642 virtual void print(void) const;
644 virtual ir_rvalue *hir(exec_list *instructions,
645 struct _mesa_glsl_parse_state *state);
648 * An test value of NULL means 'default'.
650 ast_expression *test_value;
654 class ast_case_label_list : public ast_node {
656 ast_case_label_list(void);
657 virtual void print(void) const;
659 virtual ir_rvalue *hir(exec_list *instructions,
660 struct _mesa_glsl_parse_state *state);
663 * A list of case labels.
669 class ast_case_statement : public ast_node {
671 ast_case_statement(ast_case_label_list *labels);
672 virtual void print(void) const;
674 virtual ir_rvalue *hir(exec_list *instructions,
675 struct _mesa_glsl_parse_state *state);
677 ast_case_label_list *labels;
680 * A list of statements.
686 class ast_case_statement_list : public ast_node {
688 ast_case_statement_list(void);
689 virtual void print(void) const;
691 virtual ir_rvalue *hir(exec_list *instructions,
692 struct _mesa_glsl_parse_state *state);
701 class ast_switch_body : public ast_node {
703 ast_switch_body(ast_case_statement_list *stmts);
704 virtual void print(void) const;
706 virtual ir_rvalue *hir(exec_list *instructions,
707 struct _mesa_glsl_parse_state *state);
709 ast_case_statement_list *stmts;
713 class ast_selection_statement : public ast_node {
715 ast_selection_statement(ast_expression *condition,
716 ast_node *then_statement,
717 ast_node *else_statement);
718 virtual void print(void) const;
720 virtual ir_rvalue *hir(exec_list *instructions,
721 struct _mesa_glsl_parse_state *state);
723 ast_expression *condition;
724 ast_node *then_statement;
725 ast_node *else_statement;
729 class ast_switch_statement : public ast_node {
731 ast_switch_statement(ast_expression *test_expression,
733 virtual void print(void) const;
735 virtual ir_rvalue *hir(exec_list *instructions,
736 struct _mesa_glsl_parse_state *state);
738 ast_expression *test_expression;
742 void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
745 class ast_iteration_statement : public ast_node {
747 ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
748 ast_expression *rest_expression, ast_node *body);
750 virtual void print(void) const;
752 virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
754 enum ast_iteration_modes {
761 ast_node *init_statement;
763 ast_expression *rest_expression;
769 * Generate IR from the condition of a loop
771 * This is factored out of ::hir because some loops have the condition
772 * test at the top (for and while), and others have it at the end (do-while).
774 void condition_to_hir(class ir_loop *, struct _mesa_glsl_parse_state *);
778 class ast_jump_statement : public ast_node {
780 ast_jump_statement(int mode, ast_expression *return_value);
781 virtual void print(void) const;
783 virtual ir_rvalue *hir(exec_list *instructions,
784 struct _mesa_glsl_parse_state *state);
786 enum ast_jump_modes {
793 ast_expression *opt_return_value;
797 class ast_function_definition : public ast_node {
799 virtual void print(void) const;
801 virtual ir_rvalue *hir(exec_list *instructions,
802 struct _mesa_glsl_parse_state *state);
804 ast_function *prototype;
805 ast_compound_statement *body;
808 class ast_uniform_block : public ast_node {
810 ast_uniform_block(ast_type_qualifier layout,
811 const char *instance_name,
812 ast_expression *array_size)
813 : layout(layout), block_name(NULL), instance_name(instance_name),
814 array_size(array_size)
819 virtual ir_rvalue *hir(exec_list *instructions,
820 struct _mesa_glsl_parse_state *state);
822 ast_type_qualifier layout;
823 const char *block_name;
826 * Declared name of the block instance, if specified.
828 * If the block does not have an instance name, this field will be
831 const char *instance_name;
833 /** List of ast_declarator_list * */
834 exec_list declarations;
837 * Declared array size of the block instance
839 * If the block is not declared as an array, this field will be \c NULL.
842 * A block can only be an array if it also has an instance name. If this
843 * field is not \c NULL, ::instance_name must also not be \c NULL.
845 ast_expression *array_size;
850 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
853 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
854 exec_list *instructions,
855 struct _mesa_glsl_parse_state *state);
858 _mesa_ast_array_index_to_hir(void *mem_ctx,
859 struct _mesa_glsl_parse_state *state,
860 ir_rvalue *array, ir_rvalue *idx,
861 YYLTYPE &loc, YYLTYPE &idx_loc);
864 emit_function(_mesa_glsl_parse_state *state, ir_function *f);
867 check_builtin_array_max_size(const char *name, unsigned size,
868 YYLTYPE loc, struct _mesa_glsl_parse_state *state);