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 talloc-based new need not call delete. It's
53 * easier to just talloc_free 'ctx' (or any of its ancestors). */
54 static void* operator new(size_t size
, void *ctx
)
58 node
= talloc_zero_size(ctx
, size
);
64 /* If the user *does* call delete, that's OK, we will just
65 * talloc_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
= (char *) identifier
;
212 static const char *operator_string(enum ast_operators op
);
214 virtual ir_rvalue
*hir(exec_list
*instructions
,
215 struct _mesa_glsl_parse_state
*state
);
217 virtual void print(void) const;
219 enum ast_operators oper
;
221 ast_expression
*subexpressions
[3];
226 float float_constant
;
227 unsigned uint_constant
;
229 } primary_expression
;
233 * List of expressions for an \c ast_sequence or parameters for an
234 * \c ast_function_call
236 exec_list expressions
;
239 class ast_expression_bin
: public ast_expression
{
241 ast_expression_bin(int oper
, ast_expression
*, ast_expression
*);
243 virtual void print(void) const;
247 * Subclass of expressions for function calls
249 class ast_function_expression
: public ast_expression
{
251 ast_function_expression(ast_expression
*callee
)
252 : ast_expression(ast_function_call
, callee
,
259 ast_function_expression(class ast_type_specifier
*type
)
260 : ast_expression(ast_function_call
, (ast_expression
*) type
,
267 bool is_constructor() const
272 virtual ir_rvalue
*hir(exec_list
*instructions
,
273 struct _mesa_glsl_parse_state
*state
);
277 * Is this function call actually a constructor?
284 * Number of possible operators for an ast_expression
286 * This is done as a define instead of as an additional value in the enum so
287 * that the compiler won't generate spurious messages like "warning:
288 * enumeration value ‘ast_num_operators’ not handled in switch"
290 #define AST_NUM_OPERATORS (ast_sequence + 1)
293 class ast_compound_statement
: public ast_node
{
295 ast_compound_statement(int new_scope
, ast_node
*statements
);
296 virtual void print(void) const;
298 virtual ir_rvalue
*hir(exec_list
*instructions
,
299 struct _mesa_glsl_parse_state
*state
);
302 exec_list statements
;
305 class ast_declaration
: public ast_node
{
307 ast_declaration(char *identifier
, int is_array
, ast_expression
*array_size
,
308 ast_expression
*initializer
);
309 virtual void print(void) const;
314 ast_expression
*array_size
;
316 ast_expression
*initializer
;
321 ast_precision_high
= 0, /**< Default precision. */
322 ast_precision_medium
,
326 struct ast_type_qualifier
{
329 unsigned invariant
:1;
331 unsigned attribute
:1;
339 unsigned noperspective
:1;
341 /** \name Layout qualifiers for GL_ARB_fragment_coord_conventions */
343 unsigned origin_upper_left
:1;
344 unsigned pixel_center_integer
:1;
348 * Flag set if GL_ARB_explicit_attrib_location "location" layout
351 unsigned explicit_location
:1;
357 * Location specified via GL_ARB_explicit_attrib_location layout
360 * This field is only valid if \c explicit_location is set.
365 class ast_struct_specifier
: public ast_node
{
367 ast_struct_specifier(char *identifier
, ast_node
*declarator_list
);
368 virtual void print(void) const;
370 virtual ir_rvalue
*hir(exec_list
*instructions
,
371 struct _mesa_glsl_parse_state
*state
);
374 exec_list declarations
;
412 ast_sampler2drectshadow
,
413 ast_samplercubeshadow
,
416 ast_sampler1darrayshadow
,
417 ast_sampler2darrayshadow
,
436 class ast_type_specifier
: public ast_node
{
438 ast_type_specifier(int specifier
);
440 /** Construct a type specifier from a type name */
441 ast_type_specifier(const char *name
)
442 : type_specifier(ast_type_name
), type_name(name
), structure(NULL
),
443 is_array(false), array_size(NULL
), precision(ast_precision_high
)
448 /** Construct a type specifier from a structure definition */
449 ast_type_specifier(ast_struct_specifier
*s
)
450 : type_specifier(ast_struct
), type_name(s
->name
), structure(s
),
451 is_array(false), array_size(NULL
), precision(ast_precision_high
)
456 const struct glsl_type
*glsl_type(const char **name
,
457 struct _mesa_glsl_parse_state
*state
)
460 virtual void print(void) const;
462 ir_rvalue
*hir(exec_list
*, struct _mesa_glsl_parse_state
*);
464 enum ast_types type_specifier
;
466 const char *type_name
;
467 ast_struct_specifier
*structure
;
470 ast_expression
*array_size
;
472 unsigned precision
:2;
476 class ast_fully_specified_type
: public ast_node
{
478 virtual void print(void) const;
479 bool has_qualifiers() const;
481 ast_type_qualifier qualifier
;
482 ast_type_specifier
*specifier
;
486 class ast_declarator_list
: public ast_node
{
488 ast_declarator_list(ast_fully_specified_type
*);
489 virtual void print(void) const;
491 virtual ir_rvalue
*hir(exec_list
*instructions
,
492 struct _mesa_glsl_parse_state
*state
);
494 ast_fully_specified_type
*type
;
495 exec_list declarations
;
498 * Special flag for vertex shader "invariant" declarations.
500 * Vertex shaders can contain "invariant" variable redeclarations that do
501 * not include a type. For example, "invariant gl_Position;". This flag
502 * is used to note these cases when no type is specified.
508 class ast_parameter_declarator
: public ast_node
{
510 ast_parameter_declarator()
512 this->identifier
= NULL
;
513 this->is_array
= false;
514 this->array_size
= 0;
517 virtual void print(void) const;
519 virtual ir_rvalue
*hir(exec_list
*instructions
,
520 struct _mesa_glsl_parse_state
*state
);
522 ast_fully_specified_type
*type
;
525 ast_expression
*array_size
;
527 static void parameters_to_hir(exec_list
*ast_parameters
,
528 bool formal
, exec_list
*ir_parameters
,
529 struct _mesa_glsl_parse_state
*state
);
532 /** Is this parameter declaration part of a formal parameter list? */
533 bool formal_parameter
;
536 * Is this parameter 'void' type?
538 * This field is set by \c ::hir.
544 class ast_function
: public ast_node
{
548 virtual void print(void) const;
550 virtual ir_rvalue
*hir(exec_list
*instructions
,
551 struct _mesa_glsl_parse_state
*state
);
553 ast_fully_specified_type
*return_type
;
556 exec_list parameters
;
560 * Is this prototype part of the function definition?
562 * Used by ast_function_definition::hir to process the parameters, etc.
570 * Function signature corresponding to this function prototype instance
572 * Used by ast_function_definition::hir to process the parameters, etc.
577 class ir_function_signature
*signature
;
579 friend class ast_function_definition
;
583 class ast_declaration_statement
: public ast_node
{
585 ast_declaration_statement(void);
594 class ast_function
*function
;
595 ast_declarator_list
*declarator
;
596 ast_type_specifier
*type
;
602 class ast_expression_statement
: public ast_node
{
604 ast_expression_statement(ast_expression
*);
605 virtual void print(void) const;
607 virtual ir_rvalue
*hir(exec_list
*instructions
,
608 struct _mesa_glsl_parse_state
*state
);
610 ast_expression
*expression
;
614 class ast_case_label
: public ast_node
{
618 * An expression of NULL means 'default'.
620 ast_expression
*expression
;
623 class ast_selection_statement
: public ast_node
{
625 ast_selection_statement(ast_expression
*condition
,
626 ast_node
*then_statement
,
627 ast_node
*else_statement
);
628 virtual void print(void) const;
630 virtual ir_rvalue
*hir(exec_list
*instructions
,
631 struct _mesa_glsl_parse_state
*state
);
633 ast_expression
*condition
;
634 ast_node
*then_statement
;
635 ast_node
*else_statement
;
639 class ast_switch_statement
: public ast_node
{
641 ast_expression
*expression
;
642 exec_list statements
;
645 class ast_iteration_statement
: public ast_node
{
647 ast_iteration_statement(int mode
, ast_node
*init
, ast_node
*condition
,
648 ast_expression
*rest_expression
, ast_node
*body
);
650 virtual void print(void) const;
652 virtual ir_rvalue
*hir(exec_list
*, struct _mesa_glsl_parse_state
*);
654 enum ast_iteration_modes
{
661 ast_node
*init_statement
;
663 ast_expression
*rest_expression
;
669 * Generate IR from the condition of a loop
671 * This is factored out of ::hir because some loops have the condition
672 * test at the top (for and while), and others have it at the end (do-while).
674 void condition_to_hir(class ir_loop
*, struct _mesa_glsl_parse_state
*);
678 class ast_jump_statement
: public ast_node
{
680 ast_jump_statement(int mode
, ast_expression
*return_value
);
681 virtual void print(void) const;
683 virtual ir_rvalue
*hir(exec_list
*instructions
,
684 struct _mesa_glsl_parse_state
*state
);
686 enum ast_jump_modes
{
693 ast_expression
*opt_return_value
;
697 class ast_function_definition
: public ast_node
{
699 virtual void print(void) const;
701 virtual ir_rvalue
*hir(exec_list
*instructions
,
702 struct _mesa_glsl_parse_state
*state
);
704 ast_function
*prototype
;
705 ast_compound_statement
*body
;
710 _mesa_ast_to_hir(exec_list
*instructions
, struct _mesa_glsl_parse_state
*state
);
713 _mesa_ast_field_selection_to_hir(const ast_expression
*expr
,
714 exec_list
*instructions
,
715 struct _mesa_glsl_parse_state
*state
);
718 emit_function(_mesa_glsl_parse_state
*state
, exec_list
*instructions
,