|
8
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
8
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
8
|
20 |
|
|
21 */ |
|
|
22 |
|
383
|
23 #if !defined (octave_symtab_h) |
|
|
24 #define octave_symtab_h 1 |
|
8
|
25 |
|
1297
|
26 #if defined (__GNUG__) |
|
|
27 #pragma interface |
|
|
28 #endif |
|
|
29 |
|
3011
|
30 #include <cassert> |
|
|
31 |
|
1755
|
32 #include <string> |
|
|
33 |
|
220
|
34 #include "SLStack.h" |
|
|
35 |
|
3011
|
36 #include "oct-alloc.h" |
|
1755
|
37 #include "str-vec.h" |
|
|
38 |
|
2975
|
39 #include "ov.h" |
|
|
40 |
|
2979
|
41 class octave_lvalue; |
|
8
|
42 |
|
1755
|
43 class string_vector; |
|
|
44 |
|
8
|
45 class symbol_record; |
|
|
46 class symbol_table; |
|
|
47 |
|
3011
|
48 // Individual records in a symbol table. |
|
8
|
49 |
|
3011
|
50 class |
|
|
51 symbol_record |
|
|
52 { |
|
|
53 public: |
|
8
|
54 |
|
3258
|
55 // If you add or delete an entry here, you'll also need to change |
|
3325
|
56 // the width parameter in the declaration for symbol_type below... |
|
3258
|
57 |
|
195
|
58 enum TYPE |
|
|
59 { |
|
|
60 UNKNOWN = 0, |
|
|
61 USER_FUNCTION = 1, |
|
|
62 USER_VARIABLE = 2, |
|
3325
|
63 DLD_FUNCTION = 4, |
|
|
64 BUILTIN_FUNCTION = 8, |
|
|
65 TEXT_FUNCTION = 16, |
|
|
66 MAPPER_FUNCTION = 32, |
|
|
67 BUILTIN_VARIABLE = 64, |
|
|
68 BUILTIN_CONSTANT = 128 |
|
195
|
69 }; |
|
|
70 |
|
8
|
71 private: |
|
|
72 |
|
3011
|
73 // Variables or functions. |
|
|
74 |
|
|
75 class symbol_def |
|
|
76 { |
|
|
77 public: |
|
|
78 |
|
|
79 symbol_def (const octave_value& val = octave_value (), |
|
|
80 unsigned int sym_type = 0) |
|
|
81 : symbol_type (sym_type), eternal (0), read_only (0), help_string (), |
|
|
82 definition (val), next_elem (0), count (1) { } |
|
|
83 |
|
|
84 ~symbol_def (void) { } |
|
|
85 |
|
3258
|
86 bool is_constant (void) const |
|
|
87 { return (symbol_type & symbol_record::BUILTIN_CONSTANT); } |
|
|
88 |
|
3011
|
89 bool is_variable (void) const |
|
|
90 { |
|
|
91 return (symbol_type & symbol_record::USER_VARIABLE |
|
|
92 || symbol_type & symbol_record::BUILTIN_VARIABLE); |
|
|
93 } |
|
|
94 |
|
|
95 bool is_function (void) const |
|
|
96 { |
|
|
97 return (symbol_type & symbol_record::USER_FUNCTION |
|
3325
|
98 || symbol_type & symbol_record::DLD_FUNCTION |
|
3011
|
99 || symbol_type & symbol_record::BUILTIN_FUNCTION); |
|
|
100 } |
|
|
101 |
|
|
102 bool is_user_variable (void) const |
|
|
103 { return (symbol_type & symbol_record::USER_VARIABLE); } |
|
195
|
104 |
|
3011
|
105 bool is_text_function (void) const |
|
|
106 { return (symbol_type & symbol_record::TEXT_FUNCTION); } |
|
|
107 |
|
|
108 bool is_mapper_function (void) const |
|
|
109 { return (symbol_type & symbol_record::MAPPER_FUNCTION); } |
|
|
110 |
|
|
111 bool is_user_function (void) const |
|
|
112 { return (symbol_type & symbol_record::USER_FUNCTION); } |
|
|
113 |
|
3258
|
114 bool is_builtin_constant (void) const |
|
|
115 { return (symbol_type & symbol_record::BUILTIN_CONSTANT); } |
|
|
116 |
|
3011
|
117 bool is_builtin_variable (void) const |
|
|
118 { return (symbol_type & symbol_record::BUILTIN_VARIABLE); } |
|
195
|
119 |
|
3011
|
120 bool is_builtin_function (void) const |
|
|
121 { return (symbol_type & symbol_record::BUILTIN_FUNCTION); } |
|
|
122 |
|
3325
|
123 bool is_dld_function (void) const |
|
|
124 { return (symbol_type & symbol_record::DLD_FUNCTION); } |
|
|
125 |
|
3011
|
126 // XXX FIXME XXX |
|
|
127 bool is_map_element (const string& /* elts */) const |
|
|
128 { return false; } |
|
|
129 |
|
|
130 bool is_defined (void) const |
|
|
131 { return definition.is_defined (); } |
|
|
132 |
|
|
133 bool is_read_only (void) const |
|
|
134 { return read_only; } |
|
|
135 |
|
|
136 bool is_eternal (void) const |
|
|
137 { return eternal; } |
|
8
|
138 |
|
3013
|
139 int rows (void) const { return definition.rows (); } |
|
|
140 int columns (void) const { return definition.columns (); } |
|
|
141 |
|
|
142 string type_name (void) const { return definition.type_name (); } |
|
|
143 |
|
3355
|
144 string type_as_string (void) const; |
|
|
145 |
|
|
146 string which (const string& name); |
|
|
147 |
|
|
148 void which (ostream& os, const string& name); |
|
|
149 |
|
3011
|
150 void define (const octave_value& val, unsigned int sym_type) |
|
|
151 { |
|
|
152 definition = val; |
|
|
153 symbol_type = sym_type; |
|
|
154 } |
|
|
155 |
|
|
156 void protect (void) { read_only = 1; } |
|
|
157 |
|
|
158 void unprotect (void) { read_only = 0; } |
|
|
159 |
|
|
160 void make_eternal (void) { eternal = 1; } |
|
|
161 |
|
|
162 octave_value& def (void) { return definition; } |
|
|
163 |
|
|
164 string help (void) const { return help_string; } |
|
|
165 |
|
|
166 void document (const string& h) { help_string = h; } |
|
|
167 |
|
|
168 unsigned int type (void) { return symbol_type; } |
|
|
169 |
|
|
170 void *operator new (size_t size) |
|
|
171 { return allocator.alloc (size); } |
|
|
172 |
|
|
173 void operator delete (void *p, size_t size) |
|
|
174 { allocator.free (p, size); } |
|
|
175 |
|
|
176 static octave_allocator allocator; |
|
8
|
177 |
|
3011
|
178 // The type of this symbol (see the enum above). |
|
3325
|
179 unsigned int symbol_type : 8; |
|
3011
|
180 |
|
|
181 // Nonzero means this variable cannot be cleared. |
|
|
182 unsigned int eternal : 1; |
|
|
183 |
|
|
184 // Nonzero means this variable cannot be given a new value. |
|
|
185 unsigned int read_only : 1; |
|
|
186 |
|
|
187 // The doc string associated with this variable. |
|
|
188 string help_string; |
|
|
189 |
|
|
190 // The value of this definition. See ov.h and related files. |
|
|
191 octave_value definition; |
|
767
|
192 |
|
3011
|
193 // Pointer to next definition in chain. This is used so that |
|
|
194 // variables can hide function definitions, and so that the function |
|
|
195 // definitions can reappear if the variable is cleared. |
|
|
196 symbol_def *next_elem; |
|
|
197 |
|
|
198 // Reference count. |
|
|
199 int count; |
|
|
200 |
|
3239
|
201 void dump_symbol_info (void); |
|
|
202 |
|
3011
|
203 // No copying! |
|
|
204 |
|
|
205 symbol_def (const symbol_def& sd); |
|
|
206 |
|
|
207 symbol_def& operator = (const symbol_def& sd); |
|
|
208 }; |
|
8
|
209 |
|
|
210 public: |
|
2953
|
211 |
|
3011
|
212 typedef int (*change_function) (void); |
|
2953
|
213 |
|
3011
|
214 symbol_record (void) |
|
|
215 : formal_param (0), linked_to_global (0), tagged_static (0), |
|
|
216 nm (), chg_fcn (0), definition (new symbol_def ()), |
|
|
217 next_elem (0) { } |
|
|
218 |
|
|
219 symbol_record (const string& n, symbol_record *nxt) |
|
|
220 : formal_param (0), linked_to_global (0), tagged_static (0), |
|
|
221 nm (n), chg_fcn (0), definition (new symbol_def ()), |
|
|
222 next_elem (nxt) { } |
|
8
|
223 |
|
1755
|
224 ~symbol_record (void) { } |
|
8
|
225 |
|
3011
|
226 string name (void) const { return nm; } |
|
2975
|
227 |
|
3011
|
228 string help (void) const { return definition->help (); } |
|
|
229 |
|
|
230 octave_value& def (void) { return definition->def (); } |
|
8
|
231 |
|
1755
|
232 void rename (const string& new_name); |
|
195
|
233 |
|
3011
|
234 bool is_function (void) const |
|
|
235 { return definition->is_function (); } |
|
|
236 |
|
|
237 bool is_text_function (void) const |
|
|
238 { return definition->is_text_function (); } |
|
|
239 |
|
|
240 bool is_mapper_function (void) const |
|
|
241 { return definition->is_mapper_function (); } |
|
|
242 |
|
|
243 bool is_user_function (void) const |
|
|
244 { return definition->is_user_function (); } |
|
195
|
245 |
|
3011
|
246 bool is_builtin_function (void) const |
|
|
247 { return definition->is_builtin_function (); } |
|
|
248 |
|
3325
|
249 bool is_dld_function (void) const |
|
|
250 { return definition->is_dld_function (); } |
|
|
251 |
|
3258
|
252 bool is_constant (void) const |
|
|
253 { return definition->is_constant (); } |
|
|
254 |
|
|
255 bool is_builtin_constant (void) const |
|
|
256 { return definition->is_builtin_constant (); } |
|
|
257 |
|
3011
|
258 bool is_variable (void) const |
|
|
259 { return definition->is_variable (); } |
|
8
|
260 |
|
3011
|
261 bool is_user_variable (void) const |
|
|
262 { return definition->is_user_variable (); } |
|
|
263 |
|
|
264 bool is_builtin_variable (void) const |
|
|
265 { return definition->is_builtin_variable (); } |
|
|
266 |
|
|
267 bool is_map_element (const string& elts) const |
|
|
268 { return definition->is_map_element (elts); } |
|
8
|
269 |
|
3011
|
270 unsigned int type (void) const { return definition->type (); } |
|
|
271 |
|
|
272 bool is_defined (void) const { return definition->is_defined (); } |
|
|
273 |
|
|
274 bool is_read_only (void) const { return definition->is_read_only (); } |
|
8
|
275 |
|
3011
|
276 bool is_eternal (void) const { return definition->is_eternal (); } |
|
|
277 |
|
|
278 void protect (void) { definition->protect (); } |
|
195
|
279 |
|
3011
|
280 void unprotect (void) { definition->unprotect (); } |
|
|
281 |
|
|
282 void make_eternal (void) { definition->make_eternal (); } |
|
2893
|
283 |
|
3011
|
284 void set_change_function (change_function f) { chg_fcn = f; } |
|
2893
|
285 |
|
3011
|
286 void define (const octave_value& v, unsigned int sym_type = USER_VARIABLE); |
|
|
287 |
|
|
288 void define_builtin_var (const octave_value& v); |
|
195
|
289 |
|
3258
|
290 bool define_builtin_const (const octave_value& v); |
|
3011
|
291 |
|
|
292 bool define (octave_function *f, unsigned int sym_type); |
|
2893
|
293 |
|
3011
|
294 void document (const string& h) { definition->document (h); } |
|
195
|
295 |
|
3011
|
296 void clear (void); |
|
195
|
297 |
|
2856
|
298 void alias (symbol_record *s, bool force = false); |
|
8
|
299 |
|
|
300 void mark_as_formal_parameter (void); |
|
3011
|
301 bool is_formal_parameter (void) const { return formal_param; } |
|
8
|
302 |
|
195
|
303 void mark_as_linked_to_global (void); |
|
3011
|
304 bool is_linked_to_global (void) const { return linked_to_global; } |
|
8
|
305 |
|
2846
|
306 void mark_as_static (void); |
|
3011
|
307 bool is_static (void) const { return tagged_static; } |
|
2846
|
308 |
|
3013
|
309 bool hides_fcn (void) const; |
|
|
310 bool hides_builtin (void) const; |
|
|
311 |
|
|
312 int rows (void) const { return definition->rows (); } |
|
|
313 int columns (void) const { return definition->columns (); } |
|
|
314 |
|
|
315 string type_name (void) const { return definition->type_name (); } |
|
|
316 |
|
3355
|
317 string type_as_string (void) const |
|
|
318 { return definition->type_as_string (); } |
|
|
319 |
|
|
320 string which (void) { return definition->which (name ()); } |
|
|
321 |
|
|
322 void which (ostream& os) { definition->which (os, name ()); } |
|
|
323 |
|
2975
|
324 octave_value& variable_value (void); |
|
2979
|
325 octave_lvalue variable_reference (void); |
|
2390
|
326 |
|
3011
|
327 symbol_record *next (void) const { return next_elem; } |
|
8
|
328 |
|
3011
|
329 void chain (symbol_record *s) { next_elem = s; } |
|
195
|
330 |
|
220
|
331 void push_context (void); |
|
3011
|
332 |
|
220
|
333 void pop_context (void); |
|
|
334 |
|
3013
|
335 void print_symbol_info_line (ostream& os); |
|
|
336 |
|
3239
|
337 void dump_symbol_info (void); |
|
|
338 |
|
8
|
339 private: |
|
|
340 |
|
2893
|
341 unsigned int formal_param : 1; |
|
|
342 unsigned int linked_to_global : 1; |
|
|
343 unsigned int tagged_static : 1; |
|
195
|
344 |
|
1755
|
345 string nm; |
|
3011
|
346 change_function chg_fcn; |
|
195
|
347 symbol_def *definition; |
|
8
|
348 symbol_record *next_elem; |
|
395
|
349 |
|
3011
|
350 // This should maybe be one stack with a structure containing all the |
|
|
351 // items we need to save for recursive calls... |
|
220
|
352 SLStack <symbol_def *> context; |
|
2893
|
353 SLStack <unsigned int> global_link_context; |
|
8
|
354 |
|
3011
|
355 bool read_only_error (const char *action); |
|
195
|
356 |
|
|
357 void push_def (symbol_def *sd); |
|
3011
|
358 |
|
|
359 void remove_top_def (void); |
|
|
360 |
|
|
361 void replace_all_defs (symbol_def *sd); |
|
|
362 |
|
3258
|
363 void link_to_builtin_variable (void); |
|
|
364 |
|
3011
|
365 // No copying! |
|
|
366 |
|
|
367 symbol_record (const symbol_record& s); |
|
195
|
368 |
|
8
|
369 symbol_record& operator = (const symbol_record& s); |
|
|
370 }; |
|
|
371 |
|
767
|
372 // A symbol table. |
|
200
|
373 |
|
|
374 #define SYMTAB_LOCAL_SCOPE 1 |
|
|
375 #define SYMTAB_GLOBAL_SCOPE 2 |
|
|
376 |
|
|
377 #define SYMTAB_ALL_SCOPES (SYMTAB_LOCAL_SCOPE | SYMTAB_GLOBAL_SCOPE) |
|
|
378 |
|
3011
|
379 #define SYMTAB_ALL_TYPES (symbol_record::USER_FUNCTION \ |
|
|
380 | symbol_record::USER_VARIABLE \ |
|
3325
|
381 | symbol_record::DLD_FUNCTION \ |
|
3011
|
382 | symbol_record::BUILTIN_FUNCTION \ |
|
|
383 | symbol_record::TEXT_FUNCTION \ |
|
|
384 | symbol_record::MAPPER_FUNCTION \ |
|
3258
|
385 | symbol_record::BUILTIN_VARIABLE \ |
|
|
386 | symbol_record::BUILTIN_CONSTANT) |
|
200
|
387 |
|
3011
|
388 #define SYMTAB_VARIABLES (symbol_record::USER_VARIABLE \ |
|
|
389 | symbol_record::BUILTIN_VARIABLE) |
|
1412
|
390 |
|
8
|
391 class |
|
|
392 symbol_table |
|
|
393 { |
|
|
394 public: |
|
|
395 |
|
3011
|
396 symbol_table (unsigned int tab_size = 128) |
|
|
397 : table_size (tab_size), table (new symbol_record [table_size]) |
|
|
398 { |
|
|
399 assert ((tab_size % 2) == 0); |
|
|
400 } |
|
|
401 |
|
|
402 ~symbol_table (void) |
|
|
403 { |
|
|
404 delete [] table; |
|
|
405 } |
|
8
|
406 |
|
2856
|
407 symbol_record *lookup (const string& nm, bool insert = false, |
|
|
408 bool warn = false); |
|
8
|
409 |
|
1755
|
410 void rename (const string& old_name, const string& new_name); |
|
572
|
411 |
|
2856
|
412 void clear (bool clear_user_functions = true); |
|
3011
|
413 bool clear (const string& nm, bool clear_user_functions = true); |
|
8
|
414 |
|
164
|
415 int size (void) const; |
|
8
|
416 |
|
3013
|
417 Array<symbol_record *> |
|
3355
|
418 symbol_list (const string_vector& pats = string_vector (), |
|
3013
|
419 unsigned int type = SYMTAB_ALL_TYPES, |
|
|
420 unsigned int scope = SYMTAB_ALL_SCOPES) const; |
|
|
421 |
|
195
|
422 |
|
1755
|
423 string_vector |
|
3355
|
424 name_list (const string_vector& pats = string_vector (), |
|
3013
|
425 bool sort = false, unsigned int type = SYMTAB_ALL_TYPES, |
|
|
426 unsigned int scope = SYMTAB_ALL_SCOPES) const; |
|
605
|
427 |
|
3011
|
428 |
|
|
429 int maybe_list (const char *header, const string_vector& argv, |
|
3013
|
430 ostream& os, bool show_verbose, |
|
3011
|
431 unsigned type, unsigned scope); |
|
|
432 |
|
3355
|
433 Array<symbol_record *> glob (const string& pat = string ("*"), |
|
|
434 unsigned int type = SYMTAB_ALL_TYPES, |
|
|
435 unsigned int scope = SYMTAB_ALL_SCOPES) const; |
|
8
|
436 |
|
220
|
437 void push_context (void); |
|
3011
|
438 |
|
220
|
439 void pop_context (void); |
|
|
440 |
|
3011
|
441 void print_stats (void); |
|
|
442 |
|
8
|
443 private: |
|
|
444 |
|
3011
|
445 unsigned int table_size; |
|
|
446 |
|
|
447 symbol_record *table; |
|
|
448 |
|
1755
|
449 unsigned int hash (const string& s); |
|
8
|
450 |
|
3011
|
451 // No copying! |
|
8
|
452 |
|
3011
|
453 symbol_table (const symbol_table&); |
|
1962
|
454 |
|
3011
|
455 symbol_table& operator = (const symbol_table&); |
|
|
456 }; |
|
2790
|
457 |
|
8
|
458 #endif |
|
|
459 |
|
|
460 /* |
|
|
461 ;;; Local Variables: *** |
|
|
462 ;;; mode: C++ *** |
|
|
463 ;;; End: *** |
|
|
464 */ |
