src/glsl/glsl_symbol_table.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright © 2010 Intel Corporation
   4  *
   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:
  11  *
  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
  14  * Software.
  15  *
  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.
  23  */
  24
  25 #pragma once
  26 #ifndef GLSL_SYMBOL_TABLE
  27 #define GLSL_SYMBOL_TABLE
  28
  29 #include <new>
  30
  31 extern "C" {
  32 #include "program/symbol_table.h"
  33 }
  34 #include "ir.h"
  35 #include "glsl_types.h"
  36
  37 class symbol_table_entry;
  38
  39 /**
  40  * Facade class for _mesa_symbol_table
  41  *
  42  * Wraps the existing \c _mesa_symbol_table data structure to enforce some
  43  * type safe and some symbol table invariants.
  44  */
  45 struct glsl_symbol_table {
  46 private:
  47    static int
  48    _glsl_symbol_table_destructor (glsl_symbol_table *table)
  49    {
  50       table->~glsl_symbol_table();
  51
  52       return 0;
  53    }
  54
  55 public:
  56    /* Callers of this talloc-based new need not call delete. It's
  57     * easier to just talloc_free 'ctx' (or any of its ancestors). */
  58    static void* operator new(size_t size, void *ctx)
  59    {
  60       void *table;
  61
  62       table = talloc_size(ctx, size);
  63       assert(table != NULL);
  64
  65       talloc_set_destructor(table, (int (*)(void*)) _glsl_symbol_table_destructor);
  66
  67       return table;
  68    }
  69
  70    /* If the user *does* call delete, that's OK, we will just
  71     * talloc_free in that case. Here, C++ will have already called the
  72     * destructor so tell talloc not to do that again. */
  73    static void operator delete(void *table)
  74    {
  75       talloc_set_destructor(table, NULL);
  76       talloc_free(table);
  77    }
  78
  79    glsl_symbol_table();
  80    ~glsl_symbol_table();
  81
  82    unsigned int language_version;
  83
  84    void push_scope();
  85    void pop_scope();
  86
  87    /**
  88     * Determine whether a name was declared at the current scope
  89     */
  90    bool name_declared_this_scope(const char *name);
  91
  92    /**
  93     * \name Methods to add symbols to the table
  94     *
  95     * There is some temptation to rename all these functions to \c add_symbol
  96     * or similar.  However, this breaks symmetry with the getter functions and
  97     * reduces the clarity of the intention of code that uses these methods.
  98     */
  99    /*@{*/
 100    bool add_variable(const char *name, ir_variable *v);
 101    bool add_type(const char *name, const glsl_type *t);
 102    bool add_function(const char *name, ir_function *f);
 103    /*@}*/
 104
 105    /**
 106     * \name Methods to get symbols from the table
 107     */
 108    /*@{*/
 109    ir_variable *get_variable(const char *name);
 110    const glsl_type *get_type(const char *name);
 111    ir_function *get_function(const char *name);
 112    /*@}*/
 113
 114 private:
 115    symbol_table_entry *get_entry(const char *name);
 116
 117    struct _mesa_symbol_table *table;
 118    void *mem_ctx;
 119 };
 120
 121 #endif /* GLSL_SYMBOL_TABLE */