summaryrefslogtreecommitdiffstats
path: root/glsl_symbol_table.h
blob: 26b90fdb7c69346ca5c3af717bb9a938e24e517b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* -*- c++ -*- */
/*
 * Copyright © 2010 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

#pragma once
#ifndef GLSL_SYMBOL_TABLE
#define GLSL_SYMBOL_TABLE

#include "symbol_table.h"
#include "ir.h"
#include "glsl_types.h"

/**
 * Facade class for _mesa_symbol_table
 *
 * Wraps the existing \c _mesa_symbol_table data structure to enforce some
 * type safe and some symbol table invariants.
 */
class glsl_symbol_table {
private:
   enum glsl_symbol_name_space {
      glsl_variable_name_space = 0,
      glsl_type_name_space = 1,
      glsl_function_name_space = 2
   };

public:
   glsl_symbol_table()
   {
      table = _mesa_symbol_table_ctor();
   }

   ~glsl_symbol_table()
   {
      _mesa_symbol_table_dtor(table);
   }

   void push_scope()
   {
      _mesa_symbol_table_push_scope(table);
   }

   void pop_scope()
   {
      _mesa_symbol_table_pop_scope(table);
   }

   /**
    * Determine whether a name was declared at the current scope
    */
   bool name_declared_this_scope(const char *name)
   {
      return _mesa_symbol_table_symbol_scope(table, -1, name) == 0;
   }

   /**
    * \name Methods to add symbols to the table
    *
    * There is some temptation to rename all these functions to \c add_symbol
    * or similar.  However, this breaks symmetry with the getter functions and
    * reduces the clarity of the intention of code that uses these methods.
    */
   /*@{*/
   bool add_variable(const char *name, ir_variable *v)
   {
      return _mesa_symbol_table_add_symbol(table, glsl_variable_name_space,
					   name, v) == 0;
   }

   bool add_type(const char *name, const glsl_type *t)
   {
      return _mesa_symbol_table_add_symbol(table, glsl_type_name_space,
					   name, (void *) t) == 0;
   }

   bool add_function(const char *name, ir_function *f)
   {
      return _mesa_symbol_table_add_symbol(table, glsl_function_name_space,
					   name, f) == 0;
   }
   /*@}*/

   /**
    * \name Methods to get symbols from the table
    */
   /*@{*/
   ir_variable *get_variable(const char *name)
   {
      return (ir_variable *)
	 _mesa_symbol_table_find_symbol(table, glsl_variable_name_space, name);
   }

   glsl_type *get_type(const char *name)
   {
      return (glsl_type *)
	 _mesa_symbol_table_find_symbol(table, glsl_type_name_space, name);
   }

   ir_function *get_function(const char *name)
   {
      return (ir_function *)
	 _mesa_symbol_table_find_symbol(table, glsl_function_name_space, name);
   }
   /*@}*/

private:
   struct _mesa_symbol_table *table;
};

#endif /* GLSL_SYMBOL_TABLE */