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 {
343 unsigned invariant:1;
345 unsigned attribute:1;
353 unsigned noperspective:1;
355 /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
357 unsigned origin_upper_left:1;
358 unsigned pixel_center_integer:1;
362 * Flag set if GL_ARB_explicit_attrib_location "location" layout
365 unsigned explicit_location:1;
367 * Flag set if GL_ARB_explicit_attrib_location "index" layout
370 unsigned explicit_index:1;
372 /** \name Layout qualifiers for GL_AMD_conservative_depth */
374 unsigned depth_any:1;
375 unsigned depth_greater:1;
376 unsigned depth_less:1;
377 unsigned depth_unchanged:1;
380 /** \name Layout qualifiers for GL_ARB_uniform_buffer_object */
385 unsigned column_major:1;
386 unsigned row_major:1;
389 /** \brief Set of flags, accessed by name. */
392 /** \brief Set of flags, accessed as a bitmask. */
397 * Location specified via GL_ARB_explicit_attrib_location layout
400 * This field is only valid if \c explicit_location is set.
404 * Index specified via GL_ARB_explicit_attrib_location layout
407 * This field is only valid if \c explicit_index is set.
412 * Return true if and only if an interpolation qualifier is present.
414 bool has_interpolation() const;
417 * \brief Return string representation of interpolation qualifier.
419 * If an interpolation qualifier is present, then return that qualifier's
420 * string representation. Otherwise, return null. For example, if the
421 * noperspective bit is set, then this returns "noperspective".
423 * If multiple interpolation qualifiers are somehow present, then the
424 * returned string is undefined but not null.
426 const char *interpolation_string() const;
429 class ast_declarator_list;
431 class ast_struct_specifier : public ast_node {
433 ast_struct_specifier(const char *identifier,
434 ast_declarator_list *declarator_list);
435 virtual void print(void) const;
437 virtual ir_rvalue *hir(exec_list *instructions,
438 struct _mesa_glsl_parse_state *state);
441 /* List of ast_declarator_list * */
442 exec_list declarations;
447 class ast_type_specifier : public ast_node {
449 /** Construct a type specifier from a type name */
450 ast_type_specifier(const char *name)
451 : type_name(name), structure(NULL),
452 is_array(false), array_size(NULL), precision(ast_precision_none),
453 is_precision_statement(false)
458 /** Construct a type specifier from a structure definition */
459 ast_type_specifier(ast_struct_specifier *s)
460 : type_name(s->name), structure(s),
461 is_array(false), array_size(NULL), precision(ast_precision_none),
462 is_precision_statement(false)
467 const struct glsl_type *glsl_type(const char **name,
468 struct _mesa_glsl_parse_state *state)
471 virtual void print(void) const;
473 ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
475 const char *type_name;
476 ast_struct_specifier *structure;
479 ast_expression *array_size;
481 unsigned precision:2;
483 bool is_precision_statement;
487 class ast_fully_specified_type : public ast_node {
489 virtual void print(void) const;
490 bool has_qualifiers() const;
492 ast_type_qualifier qualifier;
493 ast_type_specifier *specifier;
497 class ast_declarator_list : public ast_node {
499 ast_declarator_list(ast_fully_specified_type *);
500 virtual void print(void) const;
502 virtual ir_rvalue *hir(exec_list *instructions,
503 struct _mesa_glsl_parse_state *state);
505 ast_fully_specified_type *type;
506 exec_list declarations;
509 * Special flag for vertex shader "invariant" declarations.
511 * Vertex shaders can contain "invariant" variable redeclarations that do
512 * not include a type. For example, "invariant gl_Position;". This flag
513 * is used to note these cases when no type is specified.
518 * Flag indicating that these declarators are in a uniform block,
519 * allowing UBO type qualifiers.
521 bool ubo_qualifiers_valid;
525 class ast_parameter_declarator : public ast_node {
527 ast_parameter_declarator()
529 this->identifier = NULL;
530 this->is_array = false;
531 this->array_size = 0;
534 virtual void print(void) const;
536 virtual ir_rvalue *hir(exec_list *instructions,
537 struct _mesa_glsl_parse_state *state);
539 ast_fully_specified_type *type;
540 const char *identifier;
542 ast_expression *array_size;
544 static void parameters_to_hir(exec_list *ast_parameters,
545 bool formal, exec_list *ir_parameters,
546 struct _mesa_glsl_parse_state *state);
549 /** Is this parameter declaration part of a formal parameter list? */
550 bool formal_parameter;
553 * Is this parameter 'void' type?
555 * This field is set by \c ::hir.
561 class ast_function : public ast_node {
565 virtual void print(void) const;
567 virtual ir_rvalue *hir(exec_list *instructions,
568 struct _mesa_glsl_parse_state *state);
570 ast_fully_specified_type *return_type;
571 const char *identifier;
573 exec_list parameters;
577 * Is this prototype part of the function definition?
579 * Used by ast_function_definition::hir to process the parameters, etc.
587 * Function signature corresponding to this function prototype instance
589 * Used by ast_function_definition::hir to process the parameters, etc.
594 class ir_function_signature *signature;
596 friend class ast_function_definition;
600 class ast_expression_statement : public ast_node {
602 ast_expression_statement(ast_expression *);
603 virtual void print(void) const;
605 virtual ir_rvalue *hir(exec_list *instructions,
606 struct _mesa_glsl_parse_state *state);
608 ast_expression *expression;
612 class ast_case_label : public ast_node {
614 ast_case_label(ast_expression *test_value);
615 virtual void print(void) const;
617 virtual ir_rvalue *hir(exec_list *instructions,
618 struct _mesa_glsl_parse_state *state);
621 * An test value of NULL means 'default'.
623 ast_expression *test_value;
627 class ast_case_label_list : public ast_node {
629 ast_case_label_list(void);
630 virtual void print(void) const;
632 virtual ir_rvalue *hir(exec_list *instructions,
633 struct _mesa_glsl_parse_state *state);
636 * A list of case labels.
642 class ast_case_statement : public ast_node {
644 ast_case_statement(ast_case_label_list *labels);
645 virtual void print(void) const;
647 virtual ir_rvalue *hir(exec_list *instructions,
648 struct _mesa_glsl_parse_state *state);
650 ast_case_label_list *labels;
653 * A list of statements.
659 class ast_case_statement_list : public ast_node {
661 ast_case_statement_list(void);
662 virtual void print(void) const;
664 virtual ir_rvalue *hir(exec_list *instructions,
665 struct _mesa_glsl_parse_state *state);
674 class ast_switch_body : public ast_node {
676 ast_switch_body(ast_case_statement_list *stmts);
677 virtual void print(void) const;
679 virtual ir_rvalue *hir(exec_list *instructions,
680 struct _mesa_glsl_parse_state *state);
682 ast_case_statement_list *stmts;
686 class ast_selection_statement : public ast_node {
688 ast_selection_statement(ast_expression *condition,
689 ast_node *then_statement,
690 ast_node *else_statement);
691 virtual void print(void) const;
693 virtual ir_rvalue *hir(exec_list *instructions,
694 struct _mesa_glsl_parse_state *state);
696 ast_expression *condition;
697 ast_node *then_statement;
698 ast_node *else_statement;
702 class ast_switch_statement : public ast_node {
704 ast_switch_statement(ast_expression *test_expression,
706 virtual void print(void) const;
708 virtual ir_rvalue *hir(exec_list *instructions,
709 struct _mesa_glsl_parse_state *state);
711 ast_expression *test_expression;
715 void test_to_hir(exec_list *, struct _mesa_glsl_parse_state *);
718 class ast_iteration_statement : public ast_node {
720 ast_iteration_statement(int mode, ast_node *init, ast_node *condition,
721 ast_expression *rest_expression, ast_node *body);
723 virtual void print(void) const;
725 virtual ir_rvalue *hir(exec_list *, struct _mesa_glsl_parse_state *);
727 enum ast_iteration_modes {
734 ast_node *init_statement;
736 ast_expression *rest_expression;
742 * Generate IR from the condition of a loop
744 * This is factored out of ::hir because some loops have the condition
745 * test at the top (for and while), and others have it at the end (do-while).
747 void condition_to_hir(class ir_loop *, struct _mesa_glsl_parse_state *);
751 class ast_jump_statement : public ast_node {
753 ast_jump_statement(int mode, ast_expression *return_value);
754 virtual void print(void) const;
756 virtual ir_rvalue *hir(exec_list *instructions,
757 struct _mesa_glsl_parse_state *state);
759 enum ast_jump_modes {
766 ast_expression *opt_return_value;
770 class ast_function_definition : public ast_node {
772 virtual void print(void) const;
774 virtual ir_rvalue *hir(exec_list *instructions,
775 struct _mesa_glsl_parse_state *state);
777 ast_function *prototype;
778 ast_compound_statement *body;
781 class ast_uniform_block : public ast_node {
783 ast_uniform_block(ast_type_qualifier layout,
784 const char *block_name,
785 ast_declarator_list *member_list)
786 : layout(layout), block_name(block_name)
788 declarations.push_degenerate_list_at_head(&member_list->link);
791 virtual ir_rvalue *hir(exec_list *instructions,
792 struct _mesa_glsl_parse_state *state);
794 ast_type_qualifier layout;
795 const char *block_name;
796 /** List of ast_declarator_list * */
797 exec_list declarations;
802 _mesa_ast_to_hir(exec_list *instructions, struct _mesa_glsl_parse_state *state);
805 _mesa_ast_field_selection_to_hir(const ast_expression *expr,
806 exec_list *instructions,
807 struct _mesa_glsl_parse_state *state);
810 emit_function(_mesa_glsl_parse_state *state, ir_function *f);