b573831d5f0010bc1a520c3e5594a1b439669c8a
[mesa.git] / src / glsl / glsl_parser_extras.h
1 /*
2 * Copyright © 2010 Intel Corporation
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 */
23
24 #pragma once
25 #ifndef GLSL_PARSER_EXTRAS_H
26 #define GLSL_PARSER_EXTRAS_H
27
28 /*
29 * Most of the definitions here only apply to C++
30 */
31 #ifdef __cplusplus
32
33
34 #include <cstdlib>
35 #include "glsl_symbol_table.h"
36
37 enum _mesa_glsl_parser_targets {
38 vertex_shader,
39 geometry_shader,
40 fragment_shader,
41 ir_shader
42 };
43
44 struct __GLcontextRec;
45
46 struct _mesa_glsl_parse_state {
47 _mesa_glsl_parse_state(struct __GLcontextRec *ctx, GLenum target,
48 void *mem_ctx);
49
50 /* Callers of this talloc-based new need not call delete. It's
51 * easier to just talloc_free 'ctx' (or any of its ancestors). */
52 static void* operator new(size_t size, void *ctx)
53 {
54 void *mem = talloc_zero_size(ctx, size);
55 assert(mem != NULL);
56
57 return mem;
58 }
59
60 /* If the user *does* call delete, that's OK, we will just
61 * talloc_free in that case. */
62 static void operator delete(void *mem)
63 {
64 talloc_free(mem);
65 }
66
67 void *scanner;
68 exec_list translation_unit;
69 glsl_symbol_table *symbols;
70
71 bool es_shader;
72 unsigned language_version;
73 enum _mesa_glsl_parser_targets target;
74
75 /**
76 * Implementation defined limits that affect built-in variables, etc.
77 *
78 * \sa struct gl_constants (in mtypes.h)
79 */
80 struct {
81 /* 1.10 */
82 unsigned MaxLights;
83 unsigned MaxClipPlanes;
84 unsigned MaxTextureUnits;
85 unsigned MaxTextureCoords;
86 unsigned MaxVertexAttribs;
87 unsigned MaxVertexUniformComponents;
88 unsigned MaxVaryingFloats;
89 unsigned MaxVertexTextureImageUnits;
90 unsigned MaxCombinedTextureImageUnits;
91 unsigned MaxTextureImageUnits;
92 unsigned MaxFragmentUniformComponents;
93
94 /* ARB_draw_buffers */
95 unsigned MaxDrawBuffers;
96 } Const;
97
98 /**
99 * During AST to IR conversion, pointer to current IR function
100 *
101 * Will be \c NULL whenever the AST to IR conversion is not inside a
102 * function definition.
103 */
104 class ir_function_signature *current_function;
105
106 /** Have we found a return statement in this function? */
107 bool found_return;
108
109 /** Was there an error during compilation? */
110 bool error;
111
112 /** Loop or switch statement containing the current instructions. */
113 class ir_instruction *loop_or_switch_nesting;
114 class ast_iteration_statement *loop_or_switch_nesting_ast;
115
116 /** List of structures defined in user code. */
117 const glsl_type **user_structures;
118 unsigned num_user_structures;
119
120 char *info_log;
121
122 /**
123 * \name Enable bits for GLSL extensions
124 */
125 /*@{*/
126 unsigned ARB_draw_buffers_enable:1;
127 unsigned ARB_draw_buffers_warn:1;
128 unsigned ARB_explicit_attrib_location_enable:1;
129 unsigned ARB_explicit_attrib_location_warn:1;
130 unsigned ARB_fragment_coord_conventions_enable:1;
131 unsigned ARB_fragment_coord_conventions_warn:1;
132 unsigned ARB_texture_rectangle_enable:1;
133 unsigned ARB_texture_rectangle_warn:1;
134 unsigned EXT_texture_array_enable:1;
135 unsigned EXT_texture_array_warn:1;
136 /*@}*/
137
138 /** Extensions supported by the OpenGL implementation. */
139 const struct gl_extensions *extensions;
140
141 /** Shaders containing built-in functions that are used for linking. */
142 struct gl_shader *builtins_to_link[16];
143 unsigned num_builtins_to_link;
144 };
145
146 typedef struct YYLTYPE {
147 int first_line;
148 int first_column;
149 int last_line;
150 int last_column;
151 unsigned source;
152 } YYLTYPE;
153 # define YYLTYPE_IS_DECLARED 1
154 # define YYLTYPE_IS_TRIVIAL 1
155
156 # define YYLLOC_DEFAULT(Current, Rhs, N) \
157 do { \
158 if (N) \
159 { \
160 (Current).first_line = YYRHSLOC(Rhs, 1).first_line; \
161 (Current).first_column = YYRHSLOC(Rhs, 1).first_column; \
162 (Current).last_line = YYRHSLOC(Rhs, N).last_line; \
163 (Current).last_column = YYRHSLOC(Rhs, N).last_column; \
164 } \
165 else \
166 { \
167 (Current).first_line = (Current).last_line = \
168 YYRHSLOC(Rhs, 0).last_line; \
169 (Current).first_column = (Current).last_column = \
170 YYRHSLOC(Rhs, 0).last_column; \
171 } \
172 (Current).source = 0; \
173 } while (0)
174
175 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
176 const char *fmt, ...);
177
178 /**
179 * Emit a warning to the shader log
180 *
181 * \sa _mesa_glsl_error
182 */
183 extern void _mesa_glsl_warning(const YYLTYPE *locp,
184 _mesa_glsl_parse_state *state,
185 const char *fmt, ...);
186
187 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
188 const char *string);
189
190 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
191
192 union YYSTYPE;
193 extern int _mesa_glsl_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
194 void *scanner);
195
196 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
197
198 /**
199 * Process elements of the #extension directive
200 *
201 * \return
202 * If \c name and \c behavior are valid, \c true is returned. Otherwise
203 * \c false is returned.
204 */
205 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
206 const char *behavior,
207 YYLTYPE *behavior_locp,
208 _mesa_glsl_parse_state *state);
209
210 /**
211 * Get the textual name of the specified shader target
212 */
213 extern const char *
214 _mesa_glsl_shader_target_name(enum _mesa_glsl_parser_targets target);
215
216
217 #endif /* __cplusplus */
218
219
220 /*
221 * These definitions apply to C and C++
222 */
223 #ifdef __cplusplus
224 extern "C" {
225 #endif
226
227 extern int preprocess(void *ctx, const char **shader, char **info_log,
228 const struct gl_extensions *extensions, int api);
229
230 extern void _mesa_destroy_shader_compiler();
231 extern void _mesa_destroy_shader_compiler_caches();
232
233 #ifdef __cplusplus
234 }
235 #endif
236
237
238 #endif /* GLSL_PARSER_EXTRAS_H */