slang: Check return value from new_instruction().
[mesa.git] / src / mesa / shader / slang / slang_compile_operation.h
1 /*
2 * Mesa 3-D graphics library
3 * Version: 6.5.2
4 *
5 * Copyright (C) 2005-2006 Brian Paul All Rights Reserved.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25 #ifndef SLANG_COMPILE_OPERATION_H
26 #define SLANG_COMPILE_OPERATION_H
27
28
29 /**
30 * Types of slang operations.
31 * These are the types of the AST (abstract syntax tree) nodes.
32 * [foo] indicates a sub-tree or reference to another type of node
33 */
34 typedef enum slang_operation_type_
35 {
36 SLANG_OPER_NONE,
37 SLANG_OPER_BLOCK_NO_NEW_SCOPE, /* "{" sequence "}" */
38 SLANG_OPER_BLOCK_NEW_SCOPE, /* "{" sequence "}" */
39 SLANG_OPER_VARIABLE_DECL, /* [type] [var] or [var] = [expr] */
40 SLANG_OPER_ASM,
41 SLANG_OPER_BREAK, /* "break" statement */
42 SLANG_OPER_CONTINUE, /* "continue" statement */
43 SLANG_OPER_DISCARD, /* "discard" (kill fragment) statement */
44 SLANG_OPER_RETURN, /* "return" [expr] */
45 SLANG_OPER_RETURN_INLINED, /* "return" [expr] from inlined function */
46 SLANG_OPER_LABEL, /* a jump target */
47 SLANG_OPER_EXPRESSION, /* [expr] */
48 SLANG_OPER_IF, /* "if" [0] then [1] else [2] */
49 SLANG_OPER_WHILE, /* "while" [cond] [body] */
50 SLANG_OPER_DO, /* "do" [body] "while" [cond] */
51 SLANG_OPER_FOR, /* "for" [init] [while] [incr] [body] */
52 SLANG_OPER_VOID, /* nop */
53 SLANG_OPER_LITERAL_BOOL, /* "true" or "false" */
54 SLANG_OPER_LITERAL_INT, /* integer literal */
55 SLANG_OPER_LITERAL_FLOAT, /* float literal */
56 SLANG_OPER_IDENTIFIER, /* var name, func name, etc */
57 SLANG_OPER_SEQUENCE, /* [expr] "," [expr] "," etc */
58 SLANG_OPER_ASSIGN, /* [var] "=" [expr] */
59 SLANG_OPER_ADDASSIGN, /* [var] "+=" [expr] */
60 SLANG_OPER_SUBASSIGN, /* [var] "-=" [expr] */
61 SLANG_OPER_MULASSIGN, /* [var] "*=" [expr] */
62 SLANG_OPER_DIVASSIGN, /* [var] "/=" [expr] */
63 /*SLANG_OPER_MODASSIGN, */
64 /*SLANG_OPER_LSHASSIGN, */
65 /*SLANG_OPER_RSHASSIGN, */
66 /*SLANG_OPER_ORASSIGN, */
67 /*SLANG_OPER_XORASSIGN, */
68 /*SLANG_OPER_ANDASSIGN, */
69 SLANG_OPER_SELECT, /* [expr] "?" [expr] ":" [expr] */
70 SLANG_OPER_LOGICALOR, /* [expr] "||" [expr] */
71 SLANG_OPER_LOGICALXOR, /* [expr] "^^" [expr] */
72 SLANG_OPER_LOGICALAND, /* [expr] "&&" [expr] */
73 /*SLANG_OPER_BITOR, */
74 /*SLANG_OPER_BITXOR, */
75 /*SLANG_OPER_BITAND, */
76 SLANG_OPER_EQUAL, /* [expr] "==" [expr] */
77 SLANG_OPER_NOTEQUAL, /* [expr] "!=" [expr] */
78 SLANG_OPER_LESS, /* [expr] "<" [expr] */
79 SLANG_OPER_GREATER, /* [expr] ">" [expr] */
80 SLANG_OPER_LESSEQUAL, /* [expr] "<=" [expr] */
81 SLANG_OPER_GREATEREQUAL, /* [expr] ">=" [expr] */
82 /*SLANG_OPER_LSHIFT, */
83 /*SLANG_OPER_RSHIFT, */
84 SLANG_OPER_ADD, /* [expr] "+" [expr] */
85 SLANG_OPER_SUBTRACT, /* [expr] "-" [expr] */
86 SLANG_OPER_MULTIPLY, /* [expr] "*" [expr] */
87 SLANG_OPER_DIVIDE, /* [expr] "/" [expr] */
88 /*SLANG_OPER_MODULUS, */
89 SLANG_OPER_PREINCREMENT, /* "++" [var] */
90 SLANG_OPER_PREDECREMENT, /* "--" [var] */
91 SLANG_OPER_PLUS, /* "-" [expr] */
92 SLANG_OPER_MINUS, /* "+" [expr] */
93 /*SLANG_OPER_COMPLEMENT, */
94 SLANG_OPER_NOT, /* "!" [expr] */
95 SLANG_OPER_SUBSCRIPT, /* [expr] "[" [expr] "]" */
96 SLANG_OPER_CALL, /* [func name] [param] [param] [...] */
97 SLANG_OPER_NON_INLINED_CALL, /* a real function call */
98 SLANG_OPER_METHOD, /* method call, such as v.length() */
99 SLANG_OPER_FIELD, /* i.e.: ".next" or ".xzy" or ".xxx" etc */
100 SLANG_OPER_POSTINCREMENT, /* [var] "++" */
101 SLANG_OPER_POSTDECREMENT /* [var] "--" */
102 } slang_operation_type;
103
104
105 /**
106 * A slang_operation is basically a compiled instruction (such as assignment,
107 * a while-loop, a conditional, a multiply, a function call, etc).
108 * The AST (abstract syntax tree) is built from these nodes.
109 * NOTE: This structure could have been implemented as a union of simpler
110 * structs which would correspond to the operation types above.
111 */
112 typedef struct slang_operation_
113 {
114 slang_operation_type type;
115 struct slang_operation_ *children;
116 GLuint num_children;
117 GLfloat literal[4]; /**< Used for float, int and bool values */
118 GLuint literal_size; /**< 1, 2, 3, or 4 */
119 slang_atom a_id; /**< type: asm, identifier, call, field */
120 slang_atom a_obj; /**< object in a method call */
121 slang_variable_scope *locals; /**< local vars for scope */
122 struct slang_function_ *fun; /**< If type == SLANG_OPER_CALL */
123 struct slang_variable_ *var; /**< If type == slang_oper_identier */
124 struct slang_label_ *label; /**< If type == SLANG_OPER_LABEL */
125 /** If type==SLANG_OPER_CALL and we're calling an array constructor,
126 * for which there's no real function, we need to have a flag to
127 * indicate such. num_children indicates number of elements.
128 */
129 GLboolean array_constructor;
130 double x;
131 } slang_operation;
132
133
134 extern GLboolean
135 slang_operation_construct(slang_operation *);
136
137 extern void
138 slang_operation_destruct(slang_operation *);
139
140 extern void
141 slang_replace_scope(slang_operation *oper,
142 slang_variable_scope *oldScope,
143 slang_variable_scope *newScope);
144
145 extern GLboolean
146 slang_operation_copy(slang_operation *, const slang_operation *);
147
148 extern slang_operation *
149 slang_operation_new(GLuint count);
150
151 extern void
152 slang_operation_delete(slang_operation *oper);
153
154 extern void
155 slang_operation_free_children(slang_operation *oper);
156
157 extern slang_operation *
158 slang_operation_grow(GLuint *numChildren, slang_operation **children);
159
160 extern slang_operation *
161 slang_operation_insert(GLuint *numChildren, slang_operation **children,
162 GLuint pos);
163
164 extern slang_operation *
165 slang_operation_insert_child(slang_operation *oper, GLuint pos);
166
167 extern void
168 _slang_operation_swap(slang_operation *oper0, slang_operation *oper1);
169
170
171 extern void
172 slang_operation_add_children(slang_operation *oper, GLuint num_children);
173
174
175 /** Return number of children of given node */
176 static INLINE GLuint
177 slang_oper_num_children(const slang_operation *oper)
178 {
179 return oper->num_children;
180 }
181
182 /** Return child of given operation node */
183 static INLINE slang_operation *
184 slang_oper_child(slang_operation *oper, GLuint child)
185 {
186 assert(child < oper->num_children);
187 return &oper->children[child];
188 }
189
190
191 /** Return child of given operation node, const version */
192 static INLINE const slang_operation *
193 slang_oper_child_const(const slang_operation *oper, GLuint child)
194 {
195 assert(child < oper->num_children);
196 return &oper->children[child];
197 }
198
199
200 /** Init oper to a boolean literal. */
201 static INLINE void
202 slang_operation_literal_bool(slang_operation *oper, GLboolean value)
203 {
204 oper->type = SLANG_OPER_LITERAL_BOOL;
205 oper->literal[0] =
206 oper->literal[1] =
207 oper->literal[2] =
208 oper->literal[3] = (float) value;
209 oper->literal_size = 1;
210 }
211
212
213 /** Init oper to an int literal. */
214 static INLINE void
215 slang_operation_literal_int(slang_operation *oper, GLint value)
216 {
217 oper->type = SLANG_OPER_LITERAL_INT;
218 oper->literal[0] =
219 oper->literal[1] =
220 oper->literal[2] =
221 oper->literal[3] = (float) value;
222 oper->literal_size = 1;
223 }
224
225
226 #endif /* SLANG_COMPILE_OPERATION_H */