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 };
  42
  43 struct gl_context;
  44
  45 struct _mesa_glsl_parse_state {
  46    _mesa_glsl_parse_state(struct gl_context *ctx, GLenum target,
  47                           void *mem_ctx);
  48
  49    /* Callers of this talloc-based new need not call delete. It's
  50     * easier to just talloc_free 'ctx' (or any of its ancestors). */
  51    static void* operator new(size_t size, void *ctx)
  52    {
  53       void *mem = talloc_zero_size(ctx, size);
  54       assert(mem != NULL);
  55
  56       return mem;
  57    }
  58
  59    /* If the user *does* call delete, that's OK, we will just
  60     * talloc_free in that case. */
  61    static void operator delete(void *mem)
  62    {
  63       talloc_free(mem);
  64    }
  65
  66    void *scanner;
  67    exec_list translation_unit;
  68    glsl_symbol_table *symbols;
  69
  70    bool es_shader;
  71    unsigned language_version;
  72    const char *version_string;
  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    /**
 113     * Are all shader inputs / outputs invariant?
 114     *
 115     * This is set when the 'STDGL invariant(all)' pragma is used.
 116     */
 117    bool all_invariant;
 118
 119    /** Loop or switch statement containing the current instructions. */
 120    class ir_instruction *loop_or_switch_nesting;
 121    class ast_iteration_statement *loop_or_switch_nesting_ast;
 122
 123    /** List of structures defined in user code. */
 124    const glsl_type **user_structures;
 125    unsigned num_user_structures;
 126
 127    char *info_log;
 128
 129    /**
 130     * \name Enable bits for GLSL extensions
 131     */
 132    /*@{*/
 133    unsigned ARB_draw_buffers_enable:1;
 134    unsigned ARB_draw_buffers_warn:1;
 135    unsigned ARB_draw_instanced_enable:1;
 136    unsigned ARB_draw_instanced_warn:1;
 137    unsigned ARB_explicit_attrib_location_enable:1;
 138    unsigned ARB_explicit_attrib_location_warn:1;
 139    unsigned ARB_fragment_coord_conventions_enable:1;
 140    unsigned ARB_fragment_coord_conventions_warn:1;
 141    unsigned ARB_texture_rectangle_enable:1;
 142    unsigned ARB_texture_rectangle_warn:1;
 143    unsigned EXT_texture_array_enable:1;
 144    unsigned EXT_texture_array_warn:1;
 145    unsigned ARB_shader_stencil_export_enable:1;
 146    unsigned ARB_shader_stencil_export_warn:1;
 147    /*@}*/
 148
 149    /** Extensions supported by the OpenGL implementation. */
 150    const struct gl_extensions *extensions;
 151
 152    /** Shaders containing built-in functions that are used for linking. */
 153    struct gl_shader *builtins_to_link[16];
 154    unsigned num_builtins_to_link;
 155 };
 156
 157 typedef struct YYLTYPE {
 158    int first_line;
 159    int first_column;
 160    int last_line;
 161    int last_column;
 162    unsigned source;
 163 } YYLTYPE;
 164 # define YYLTYPE_IS_DECLARED 1
 165 # define YYLTYPE_IS_TRIVIAL 1
 166
 167 # define YYLLOC_DEFAULT(Current, Rhs, N)                        \
 168 do {                                                            \
 169    if (N)                                                       \
 170    {                                                            \
 171       (Current).first_line   = YYRHSLOC(Rhs, 1).first_line;     \
 172       (Current).first_column = YYRHSLOC(Rhs, 1).first_column;   \
 173       (Current).last_line    = YYRHSLOC(Rhs, N).last_line;      \
 174       (Current).last_column  = YYRHSLOC(Rhs, N).last_column;    \
 175    }                                                            \
 176    else                                                         \
 177    {                                                            \
 178       (Current).first_line   = (Current).last_line =            \
 179          YYRHSLOC(Rhs, 0).last_line;                            \
 180       (Current).first_column = (Current).last_column =          \
 181          YYRHSLOC(Rhs, 0).last_column;                          \
 182    }                                                            \
 183    (Current).source = 0;                                        \
 184 } while (0)
 185
 186 extern void _mesa_glsl_error(YYLTYPE *locp, _mesa_glsl_parse_state *state,
 187                              const char *fmt, ...);
 188
 189 /**
 190  * Emit a warning to the shader log
 191  *
 192  * \sa _mesa_glsl_error
 193  */
 194 extern void _mesa_glsl_warning(const YYLTYPE *locp,
 195                                _mesa_glsl_parse_state *state,
 196                                const char *fmt, ...);
 197
 198 extern void _mesa_glsl_lexer_ctor(struct _mesa_glsl_parse_state *state,
 199                                   const char *string);
 200
 201 extern void _mesa_glsl_lexer_dtor(struct _mesa_glsl_parse_state *state);
 202
 203 union YYSTYPE;
 204 extern int _mesa_glsl_lex(union YYSTYPE *yylval, YYLTYPE *yylloc,
 205                           void *scanner);
 206
 207 extern int _mesa_glsl_parse(struct _mesa_glsl_parse_state *);
 208
 209 /**
 210  * Process elements of the #extension directive
 211  *
 212  * \return
 213  * If \c name and \c behavior are valid, \c true is returned.  Otherwise
 214  * \c false is returned.
 215  */
 216 extern bool _mesa_glsl_process_extension(const char *name, YYLTYPE *name_locp,
 217                                          const char *behavior,
 218                                          YYLTYPE *behavior_locp,
 219                                          _mesa_glsl_parse_state *state);
 220
 221 /**
 222  * Get the textual name of the specified shader target
 223  */
 224 extern const char *
 225 _mesa_glsl_shader_target_name(enum _mesa_glsl_parser_targets target);
 226
 227
 228 #endif /* __cplusplus */
 229
 230
 231 /*
 232  * These definitions apply to C and C++
 233  */
 234 #ifdef __cplusplus
 235 extern "C" {
 236 #endif
 237
 238 extern int preprocess(void *ctx, const char **shader, char **info_log,
 239                       const struct gl_extensions *extensions, int api);
 240
 241 extern void _mesa_destroy_shader_compiler();
 242 extern void _mesa_destroy_shader_compiler_caches();
 243
 244 #ifdef __cplusplus
 245 }
 246 #endif
 247
 248
 249 #endif /* GLSL_PARSER_EXTRAS_H */