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 <stdlib.h>
  35 #include "glsl_symbol_table.h"
  36
  37 enum _mesa_glsl_parser_targets {
  38    vertex_shader,
  39    geometry_shader,
  40    fragment_shader
  41 };
  42
  43 struct gl_context;
  44
  45 struct glsl_switch_state {
  46    /** Temporary variables needed for switch statement. */
  47    ir_variable *test_var;
  48    ir_variable *is_fallthru_var;
  49    ir_variable *is_break_var;
  50    class ast_switch_statement *switch_nesting_ast;
  51
  52    /** Table of constant values already used in case labels */
  53    struct hash_table *labels_ht;
  54
  55    bool is_switch_innermost; // if switch stmt is closest to break, ...
  56 };
  57
  58 struct _mesa_glsl_parse_state {
  59    _mesa_glsl_parse_state(struct gl_context *ctx, GLenum target,
  60                           void *mem_ctx);
  61
  62    /* Callers of this ralloc-based new need not call delete. It's
  63     * easier to just ralloc_free 'ctx' (or any of its ancestors). */
  64    static void* operator new(size_t size, void *ctx)
  65    {
  66       void *mem = rzalloc_size(ctx, size);
  67       assert(mem != NULL);
  68
  69       return mem;
  70    }
  71
  72    /* If the user *does* call delete, that's OK, we will just
  73     * ralloc_free in that case. */
  74    static void operator delete(void *mem)
  75    {
  76       ralloc_free(mem);
  77    }
  78
  79    void *scanner;
  80    exec_list translation_unit;
  81    glsl_symbol_table *symbols;
  82
  83    bool es_shader;
  84    unsigned language_version;
  85    const char *version_string;
  86    enum _mesa_glsl_parser_targets target;
  87
  88    /**
  89     * Printable list of GLSL versions supported by the current context
  90     *
  91     * \note
  92     * This string should probably be generated per-context instead of per
  93     * invokation of the compiler.  This should be changed when the method of
  94     * tracking supported GLSL versions changes.
  95     */
  96    const char *supported_version_string;
  97
  98    /**
  99     * Implementation defined limits that affect built-in variables, etc.
 100     *
 101     * \sa struct gl_constants (in mtypes.h)
 102     */
 103    struct {
 104       /* 1.10 */
 105       unsigned MaxLights;
 106       unsigned MaxClipPlanes;
 107       unsigned MaxTextureUnits;
 108       unsigned MaxTextureCoords;
 109       unsigned MaxVertexAttribs;
 110       unsigned MaxVertexUniformComponents;
 111       unsigned MaxVaryingFloats;
 112       unsigned MaxVertexTextureImageUnits;
 113       unsigned MaxCombinedTextureImageUnits;
 114       unsigned MaxTextureImageUnits;
 115       unsigned MaxFragmentUniformComponents;
 116
 117       /* ARB_draw_buffers */
 118       unsigned MaxDrawBuffers;
 119
 120       /**
 121        * Set of GLSL versions supported by the current context
 122        *
 123        * Knowing that version X is supported doesn't mean that versions before
 124        * X are also supported.  Version 1.00 is only supported in an ES2
 125        * context or when GL_ARB_ES2_compatibility is supported.  In an OpenGL
 126        * 3.0 "forward compatible" context, GLSL 1.10 and 1.20 are \b not
 127        * supported.
 128        */
 129       /*@{*/
 130       unsigned GLSL_100ES:1;
 131       unsigned GLSL_110:1;
 132       unsigned GLSL_120:1;
 133       unsigned GLSL_130:1;
 134       /*@}*/
 135    } Const;
 136
 137    /**
 138     * During AST to IR conversion, pointer to current IR function
 139     *
 140     * Will be \c NULL whenever the AST to IR conversion is not inside a
 141     * function definition.
 142     */
 143    class ir_function_signature *current_function;
 144
 145    /**
 146     * During AST to IR conversion, pointer to the toplevel IR
 147     * instruction list being generated.
 148     */
 149    exec_list *toplevel_ir;
 150
 151    /** Have we found a return statement in this function? */
 152    bool found_return;
 153
 154    /** Was there an error during compilation? */
 155    bool error;
 156
 157    /**
 158     * Are all shader inputs / outputs invariant?
 159     *
 160     * This is set when the 'STDGL invariant(all)' pragma is used.
 161     */
 162    bool all_invariant;
 163
 164    /** Loop or switch statement containing the current instructions. */
 165    class ast_iteration_statement *loop_nesting_ast;
 166
 167    struct glsl_switch_state switch_state;
 168
 169    /** List of structures defined in user code. */
 170    const glsl_type **user_structures;
 171    unsigned num_user_structures;
 172
 173    char *info_log;
 174
 175    /**
 176     * \name Enable bits for GLSL extensions
 177     */
 178    /*@{*/
 179    bool ARB_draw_buffers_enable;
 180    bool ARB_draw_buffers_warn;
 181    bool ARB_draw_instanced_enable;
 182    bool ARB_draw_instanced_warn;
 183    bool ARB_explicit_attrib_location_enable;
 184    bool ARB_explicit_attrib_location_warn;
 185    bool ARB_fragment_coord_conventions_enable;
 186    bool ARB_fragment_coord_conventions_warn;
 187    bool ARB_texture_rectangle_enable;
 188    bool ARB_texture_rectangle_warn;
 189    bool EXT_texture_array_enable;
 190    bool EXT_texture_array_warn;
 191    bool ARB_shader_texture_lod_enable;
 192    bool ARB_shader_texture_lod_warn;
 193    bool ARB_shader_stencil_export_enable;
 194    bool ARB_shader_stencil_export_warn;
 195    bool AMD_conservative_depth_enable;
 196    bool AMD_conservative_depth_warn;
 197    bool ARB_conservative_depth_enable;
 198    bool ARB_conservative_depth_warn;
 199    bool AMD_shader_stencil_export_enable;
 200    bool AMD_shader_stencil_export_warn;
 201    bool OES_texture_3D_enable;
 202    bool OES_texture_3D_warn;
 203    bool OES_EGL_image_external_enable;
 204    bool OES_EGL_image_external_warn;
 205    /*@}*/
 206
 207    /** Extensions supported by the OpenGL implementation. */
 208    const struct gl_extensions *extensions;
 209
 210    /** Shaders containing built-in functions that are used for linking. */
 211    struct gl_shader *builtins_to_link[16];
 212    unsigned num_builtins_to_link;
 213 };
 214
 215 typedef struct YYLTYPE {
 216    int first_line;
 217    int first_column;
 218    int last_line;
 219    int last_column;
 220    unsigned source;
 221 } YYLTYPE;
 222 # define YYLTYPE_IS_DECLARED 1
 223 # define YYLTYPE_IS_TRIVIAL 1
 224
 225 # define YYLLOC_DEFAULT(Current, Rhs, N)                        \
 226 do {                                                            \
 227    if (N)                                                       \
 228    {                                                            \
 229       (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;     \
 230       (Current).first_column = YYRHSLOC(Rhs, 1).first_column;   \
 231       (Current).last_line    = YYRHSLOC(Rhs, N).last_line;      \
 232       (Current).last_column  = YYRHSLOC(Rhs, N).last_column;    \
 233    }                                                            \
 234    else                                                         \
 235    {                                                            \
 236       (Current).first_line   = (Current).last_line =            \
 237          YYRHSLOC(Rhs, 0).last_line;                            \
 238       (Current).first_column = (Current).last_column =          \
 239          YYRHSLOC(Rhs, 0).last_column;                          \
 240    }                                                            \
 241    (Current).source = 0;                                        \
 242 } while (0)
 243
 244 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
 245                              const char *fmt, ...);
 246
 247 /**
 248  * Emit a warning to the shader log
 249  *
 250  * \sa _mesa_glsl_error
 251  */
 252 extern void _mesa_glsl_warning(const YYLTYPE *locp,
 253                                _mesa_glsl_parse_state *state,
 254                                const char *fmt, ...);
 255
 256 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
 257                                   const char *string);
 258
 259 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
 260
 261 union YYSTYPE;
 262 extern int _mesa_glsl_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
 263                           void *scanner);
 264
 265 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
 266
 267 /**
 268  * Process elements of the #extension directive
 269  *
 270  * \return
 271  * If \c name and \c behavior are valid, \c true is returned.  Otherwise
 272  * \c false is returned.
 273  */
 274 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 275                                          const char *behavior,
 276                                          YYLTYPE *behavior_locp,
 277                                          _mesa_glsl_parse_state *state);
 278
 279 /**
 280  * Get the textual name of the specified shader target
 281  */
 282 extern const char *
 283 _mesa_glsl_shader_target_name(enum _mesa_glsl_parser_targets target);
 284
 285
 286 #endif /* __cplusplus */
 287
 288
 289 /*
 290  * These definitions apply to C and C++
 291  */
 292 #ifdef __cplusplus
 293 extern "C" {
 294 #endif
 295
 296 extern int preprocess(void *ctx, const char **shader, char **info_log,
 297                       const struct gl_extensions *extensions, int api);
 298
 299 extern void _mesa_destroy_shader_compiler(void);
 300 extern void _mesa_destroy_shader_compiler_caches(void);
 301
 302 #ifdef __cplusplus
 303 }
 304 #endif
 305
 306
 307 #endif /* GLSL_PARSER_EXTRAS_H */