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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_symtab_h)
#define octave_symtab_h 1
#include "octave-config.h"
#include <deque>
#include <list>
#include <map>
#include <set>
#include <string>
#include "glob-match.h"
#include "lo-regexp.h"
#include "oct-refcount.h"
class tree_argument_list;
class octave_user_function;
#include "fcn-info.h"
#include "ov.h"
#include "ovl.h"
#include "symscope.h"
namespace octave
{
class interpreter;
class OCTINTERP_API symbol_table
{
public:
// Make symbol_table::scope and symbol_table::fcn_info valid type names.
typedef octave::symbol_scope scope;
typedef octave::fcn_info fcn_info;
symbol_table (interpreter& interp);
// No copying!
symbol_table (const symbol_table&) = delete;
symbol_table& operator = (const symbol_table&) = delete;
~symbol_table (void) = default;
symbol_scope current_scope (void) const;
bool is_built_in_function_name (const std::string& name);
octave_value find_scoped_function (const std::string& name,
const symbol_scope& search_scope);
octave_value find_private_function (const std::string& dir_name,
const std::string& name);
// FIXME: this function only finds legacy class methods, not
// classdef methods.
octave_value find_method (const std::string& name,
const std::string& dispatch_type);
octave_value find_built_in_function (const std::string& name);
octave_value find_autoload (const std::string& name);
octave_value
builtin_find (const std::string& name,
const symbol_scope& search_scope = symbol_scope ());
octave_value
fcn_table_find (const std::string& name,
const octave_value_list& args = ovl (),
const symbol_scope& search_scope = symbol_scope ());
// If NAME is of the form @CLASS/FUNCTION, call
//
// find_method (FUNCTION, CLASS)
//
// otherwise call
//
// find_function (NAME, ovl ())
octave_value
find_function (const std::string& name,
const symbol_scope& search_scope = symbol_scope ());
// NAME should just be function name; dispatch type determined
// from types of ARGS.
octave_value
find_function (const std::string& name,
const octave_value_list& args,
const symbol_scope& search_scope = symbol_scope ());
octave_value find_user_function (const std::string& name);
octave_value find_cmdline_function (const std::string& name);
void install_cmdline_function (const std::string& name,
const octave_value& fcn);
// Install local function FCN named NAME. FILE_NAME is the name of
// the file containing the local function.
void install_local_function (const std::string& name,
const octave_value& fcn,
const std::string& file_name);
void install_user_function (const std::string& name,
const octave_value& fcn);
// FIXME: should we ensure that FCN really is a built-in function
// object?
void install_built_in_function (const std::string& name,
const octave_value& fcn);
// This is written as two separate functions instead of a single
// function with default values so that it will work properly with
// unwind_protect.
void clear_functions (bool force = false);
void clear_function (const std::string& name);
void clear_function_pattern (const std::string& pat);
void clear_function_regexp (const std::string& pat);
void clear_user_function (const std::string& name);
// This clears oct and mex files, including autoloads.
void clear_dld_function (const std::string& name);
void clear_mex_functions (void);
bool set_class_relationship (const std::string& sup_class,
const std::string& inf_class);
bool is_superiorto (const std::string& a, const std::string& b);
void alias_built_in_function (const std::string& alias,
const std::string& name);
void install_built_in_dispatch (const std::string& name,
const std::string& klass);
std::list<std::string> user_function_names (void);
std::list<std::string> built_in_function_names (void);
std::list<std::string> cmdline_function_names (void);
octave_value dump (void) const;
void add_to_parent_map (const std::string& classname,
const std::list<std::string>& parent_list);
std::list<std::string> parent_classes (const std::string& dispatch_type);
void cleanup (void);
fcn_info * get_fcn_info (const std::string& name);
// The remaining functions are all provided for backward
// compatibility. New code should use the functions provided by the
// interpreter class.
OCTAVE_DEPRECATED (6, "use 'interpreter::at_top_level' instead")
bool at_top_level (void);
OCTAVE_DEPRECATED (6, "use 'interpreter::varval' instead")
octave_value varval (const std::string& name) const;
OCTAVE_DEPRECATED (6, "use 'interpreter::global_varval' instead")
octave_value global_varval (const std::string& name) const;
OCTAVE_DEPRECATED (6, "use 'interpreter::top_level_varval' instead")
octave_value top_level_varval (const std::string& name) const;
OCTAVE_DEPRECATED (6, "use 'interpreter::global_variable_names' instead")
std::list<std::string> global_variable_names (void);
OCTAVE_DEPRECATED (6, "use 'interpreter::top_level_variable_names' instead")
std::list<std::string> top_level_variable_names (void);
OCTAVE_DEPRECATED (6, "use 'interpreter::variable_names' instead")
std::list<std::string> variable_names (void);
OCTAVE_DEPRECATED (6, "use 'interpreter::assign' instead")
void assign (const std::string& name,
const octave_value& value = octave_value ());
// Note, FORCE_ADD no longer has any meaning.
OCTAVE_DEPRECATED (6, "use 'interpreter::assign' instead")
void assign (const std::string& name, const octave_value& value,
bool /*force_add*/);
OCTAVE_DEPRECATED (6, "use 'interpreter::clear_all' instead")
void clear_all (bool force = false);
OCTAVE_DEPRECATED (6, "use 'interpreter::clear_global' instead")
void clear_global (const std::string& name);
OCTAVE_DEPRECATED (6, "use 'interpreter::clear_global_pattern' instead")
void clear_global_pattern (const std::string& pattern);
OCTAVE_DEPRECATED (6, "use 'interpreter::clear_symbol' instead")
void clear_symbol (const std::string& name);
OCTAVE_DEPRECATED (6, "use 'interpreter::clear_symbol_pattern' instead")
void clear_symbol_pattern (const std::string& pattern);
OCTAVE_DEPRECATED (6, "use 'interpreter::global_assign' instead")
void global_assign (const std::string& name,
const octave_value& value = octave_value ());
OCTAVE_DEPRECATED (6, "use 'interpreter::top_level_assign' instead")
void top_level_assign (const std::string& name,
const octave_value& value = octave_value ());
private:
interpreter& m_interpreter;
typedef std::map<std::string, octave_value>::const_iterator
global_symbols_const_iterator;
typedef std::map<std::string, octave_value>::iterator
global_symbols_iterator;
typedef std::map<std::string, fcn_info>::const_iterator
fcn_table_const_iterator;
typedef std::map<std::string, fcn_info>::iterator
fcn_table_iterator;
// Map from function names to function info (private
// functions, class constructors, class methods, etc.)
// Note that subfunctions are defined in the scope that contains
// them.
std::map<std::string, fcn_info> m_fcn_table;
// Map from class names to set of classes that have lower
// precedence.
std::map<std::string, std::set<std::string>> m_class_precedence_table;
typedef std::map<std::string, std::set<std::string>>::const_iterator
class_precedence_table_const_iterator;
typedef std::map<std::string, std::set<std::string>>::iterator
class_precedence_table_iterator;
// Map from class names to parent class names.
std::map<std::string, std::list<std::string>> m_parent_map;
typedef std::map<std::string, std::list<std::string>>::const_iterator
const_parent_map_iterator;
typedef std::map<std::string, std::list<std::string>>::iterator
parent_map_iterator;
octave_value dump_fcn_table_map (void) const;
// This function is generated automatically by mk-builtins.pl.
void install_builtins (void);
};
}
#endif
|
