|
1
|
1 // variables.h -*- C++ -*- |
|
|
2 /* |
|
|
3 |
|
296
|
4 Copyright (C) 1992, 1993, 1994 John W. Eaton |
|
1
|
5 |
|
|
6 This file is part of Octave. |
|
|
7 |
|
|
8 Octave is free software; you can redistribute it and/or modify it |
|
|
9 under the terms of the GNU General Public License as published by the |
|
|
10 Free Software Foundation; either version 2, or (at your option) any |
|
|
11 later version. |
|
|
12 |
|
|
13 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
16 for more details. |
|
|
17 |
|
|
18 You should have received a copy of the GNU General Public License |
|
|
19 along with Octave; see the file COPYING. If not, write to the Free |
|
|
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. |
|
|
21 |
|
|
22 */ |
|
|
23 |
|
383
|
24 #if !defined (octave_variables_h) |
|
|
25 #define octave_variables_h 1 |
|
1
|
26 |
|
|
27 class istream; |
|
529
|
28 class ostrstream; |
|
1
|
29 class symbol_record; |
|
|
30 class symbol_table; |
|
|
31 class tree; |
|
490
|
32 class tree_fvc; |
|
1
|
33 class tree_constant; |
|
529
|
34 class Octave_object; |
|
1
|
35 |
|
529
|
36 struct builtin_mapper_function; |
|
|
37 struct builtin_function; |
|
|
38 struct builtin_variable; |
|
|
39 |
|
|
40 typedef int (*sv_Function)(void); |
|
195
|
41 |
|
529
|
42 struct builtin_variable |
|
|
43 { |
|
|
44 char *name; |
|
|
45 tree_constant *value; |
|
|
46 int install_as_function; |
|
|
47 int protect; |
|
|
48 int eternal; |
|
|
49 sv_Function sv_function; |
|
|
50 char *help_string; |
|
|
51 }; |
|
|
52 |
|
|
53 typedef Octave_object (*Octave_builtin_fcn)(const Octave_object&, int); |
|
|
54 |
|
|
55 struct builtin_function |
|
|
56 { |
|
|
57 char *name; |
|
|
58 int nargin_max; |
|
|
59 int nargout_max; |
|
|
60 int is_text_fcn; |
|
|
61 Octave_builtin_fcn fcn; |
|
|
62 char *help_string; |
|
|
63 }; |
|
195
|
64 |
|
|
65 extern void initialize_symbol_tables (void); |
|
|
66 |
|
1
|
67 extern int symbol_out_of_date (symbol_record *sr); |
|
195
|
68 |
|
581
|
69 extern int load_fcn_from_file (symbol_record *s, int exec_script = 1); |
|
|
70 |
|
|
71 extern int lookup (symbol_record *s, int exec_script = 1); |
|
|
72 |
|
|
73 extern symbol_record *lookup_by_name (const char *nm, int exec_script = 1); |
|
|
74 |
|
195
|
75 extern void document_symbol (const char *name, const char *help); |
|
|
76 |
|
529
|
77 extern void install_builtin_mapper (builtin_mapper_function *mf); |
|
195
|
78 |
|
529
|
79 extern void install_builtin_function (builtin_function *gf); |
|
195
|
80 |
|
529
|
81 extern void install_builtin_variable (builtin_variable *v); |
|
195
|
82 |
|
|
83 extern void install_builtin_variable_as_function (const char *name, |
|
|
84 tree_constant *val, |
|
|
85 int protect = 0, |
|
529
|
86 int eternal = 0, |
|
|
87 const char *help = 0); |
|
195
|
88 |
|
548
|
89 extern void alias_builtin (const char *alias, const char *name); |
|
|
90 |
|
195
|
91 extern void bind_nargin_and_nargout (symbol_table *sym_tab, |
|
|
92 int nargin, int nargout); |
|
|
93 |
|
|
94 extern void bind_builtin_variable (const char *, tree_constant *, |
|
|
95 int protect = 0, int eternal = 0, |
|
|
96 sv_Function f = (sv_Function) 0, |
|
529
|
97 const char *help = 0); |
|
195
|
98 |
|
|
99 extern char *builtin_string_variable (const char *); |
|
|
100 extern int builtin_real_scalar_variable (const char *, double&); |
|
|
101 |
|
|
102 extern void link_to_global_variable (symbol_record *sr); |
|
|
103 extern void link_to_builtin_variable (symbol_record *sr); |
|
|
104 extern void link_to_builtin_or_function (symbol_record *sr); |
|
|
105 |
|
|
106 extern void force_link_to_function (const char *s); |
|
|
107 |
|
279
|
108 extern char *extract_keyword (istream&, char *); |
|
1
|
109 extern int extract_keyword (istream&, char *, int&); |
|
195
|
110 |
|
1
|
111 extern void skip_comments (istream&); |
|
|
112 extern int valid_identifier (char *); |
|
|
113 extern int identifier_exists (char *); |
|
195
|
114 extern int is_builtin_variable (const char *name); |
|
529
|
115 extern tree_fvc *is_valid_function (const tree_constant&, char *, |
|
|
116 int warn = 0); |
|
490
|
117 extern int takes_correct_nargs (tree_fvc *, int, char *, int warn = 0); |
|
1
|
118 extern char **make_name_list (void); |
|
|
119 |
|
529
|
120 extern int is_text_function_name (const char *s); |
|
|
121 |
|
|
122 extern void install_builtin_variables (void); |
|
|
123 |
|
|
124 extern char *octave_home (void); |
|
|
125 extern char *octave_lib_dir (void); |
|
|
126 extern char *octave_info_dir (void); |
|
|
127 extern char *default_path (void); |
|
|
128 extern char *default_info_file (void); |
|
|
129 extern char *default_editor (void); |
|
|
130 extern char *get_site_defaults (void); |
|
|
131 extern char *default_pager (void); |
|
|
132 |
|
1
|
133 // Symbol table for symbols at the top level. |
|
|
134 extern symbol_table *top_level_sym_tab; |
|
|
135 |
|
|
136 // Symbol table for the current scope. |
|
|
137 extern symbol_table *curr_sym_tab; |
|
|
138 |
|
|
139 // Symbol table for global symbols. |
|
|
140 extern symbol_table *global_sym_tab; |
|
|
141 |
|
|
142 #endif |
|
|
143 |
|
|
144 /* |
|
|
145 ;;; Local Variables: *** |
|
|
146 ;;; mode: C++ *** |
|
|
147 ;;; page-delimiter: "^/\\*" *** |
|
|
148 ;;; End: *** |
|
|
149 */ |
