|
2974
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
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 |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #ifdef HAVE_CONFIG_H |
|
|
24 #include <config.h> |
|
|
25 #endif |
|
|
26 |
|
3014
|
27 #include <string> |
|
|
28 |
|
2974
|
29 #include "defun-int.h" |
|
3014
|
30 #include "error.h" |
|
|
31 #include "help.h" |
|
2974
|
32 #include "ov.h" |
|
|
33 #include "ov-builtin.h" |
|
|
34 #include "ov-mapper.h" |
|
3014
|
35 #include "pager.h" |
|
2974
|
36 #include "symtab.h" |
|
|
37 #include "variables.h" |
|
|
38 |
|
3014
|
39 void |
|
|
40 print_usage (const string& nm, bool just_usage) |
|
|
41 { |
|
|
42 symbol_record *sym_rec = global_sym_tab->lookup (nm); |
|
|
43 |
|
|
44 if (sym_rec) |
|
|
45 { |
|
|
46 string h = sym_rec->help (); |
|
|
47 |
|
|
48 if (h.length () > 0) |
|
|
49 { |
|
|
50 octave_stdout << "\n*** " << nm << ":\n\n" |
|
|
51 << h << "\n"; |
|
|
52 |
|
|
53 if (! just_usage) |
|
|
54 additional_help_message (octave_stdout); |
|
|
55 } |
|
|
56 } |
|
|
57 else |
|
|
58 warning ("no usage message found for `%s'", nm.c_str ()); |
|
|
59 } |
|
|
60 |
|
3015
|
61 void |
|
|
62 check_version (const string& version, const string& fcn) |
|
|
63 { |
|
|
64 if (version != OCTAVE_VERSION) |
|
|
65 warning ("incompatible version %s found in function `%s'", |
|
|
66 version.c_str (), fcn.c_str ()); |
|
|
67 } |
|
|
68 |
|
2974
|
69 // Install variables and functions in the symbol tables. |
|
|
70 |
|
|
71 void |
|
|
72 install_builtin_mapper (void *mf_arg) |
|
|
73 { |
|
|
74 octave_mapper *mf = static_cast<octave_mapper *> (mf_arg); |
|
|
75 |
|
|
76 symbol_record *sym_rec = global_sym_tab->lookup (mf->name (), true); |
|
|
77 |
|
|
78 unsigned int t |
|
3010
|
79 = symbol_record::BUILTIN_FUNCTION | symbol_record::MAPPER_FUNCTION; |
|
2974
|
80 |
|
|
81 sym_rec->unprotect (); |
|
|
82 sym_rec->define (mf, t); |
|
|
83 sym_rec->document (mf->doc_string ()); |
|
|
84 sym_rec->make_eternal (); |
|
|
85 sym_rec->protect (); |
|
|
86 } |
|
|
87 |
|
|
88 void |
|
|
89 install_builtin_function (void *f_arg, const string& name, |
|
|
90 const string& doc, bool is_text_fcn) |
|
|
91 { |
|
|
92 octave_builtin::fcn f = static_cast<octave_builtin::fcn> (f_arg); |
|
|
93 |
|
|
94 symbol_record *sym_rec = global_sym_tab->lookup (name, true); |
|
|
95 |
|
3010
|
96 unsigned int t = symbol_record::BUILTIN_FUNCTION; |
|
2974
|
97 |
|
|
98 if (is_text_fcn) |
|
3010
|
99 t |= symbol_record::TEXT_FUNCTION; |
|
2974
|
100 |
|
|
101 sym_rec->unprotect (); |
|
|
102 sym_rec->define (new octave_builtin (f, name, doc), t); |
|
|
103 sym_rec->document (doc); |
|
|
104 sym_rec->make_eternal (); |
|
|
105 sym_rec->protect (); |
|
|
106 } |
|
|
107 |
|
|
108 static void |
|
|
109 install_builtin_variable_as_function (const string& name, |
|
|
110 const octave_value& val, |
|
|
111 bool protect, bool eternal, |
|
|
112 const string& help) |
|
|
113 { |
|
|
114 symbol_record *sym_rec = global_sym_tab->lookup (name, true); |
|
|
115 sym_rec->unprotect (); |
|
|
116 |
|
|
117 string tmp_help = help.empty () ? sym_rec->help () : help; |
|
|
118 |
|
|
119 sym_rec->define_as_fcn (val); |
|
|
120 |
|
|
121 sym_rec->document (tmp_help); |
|
|
122 |
|
|
123 if (protect) |
|
|
124 sym_rec->protect (); |
|
|
125 |
|
|
126 if (eternal) |
|
|
127 sym_rec->make_eternal (); |
|
|
128 } |
|
|
129 |
|
|
130 void |
|
|
131 install_builtin_variable (const string& name, const octave_value& value, |
|
|
132 bool install_as_function, bool protect, |
|
3005
|
133 bool eternal, void *chg_fcn_arg, |
|
2974
|
134 const string& help_string) |
|
|
135 { |
|
3005
|
136 symbol_record::change_function chg_fcn |
|
|
137 = static_cast<symbol_record::change_function> (chg_fcn_arg); |
|
2974
|
138 |
|
|
139 if (install_as_function) |
|
|
140 install_builtin_variable_as_function (name, value, protect, |
|
|
141 eternal, help_string); |
|
|
142 else |
|
|
143 bind_builtin_variable (name, value, protect, eternal, |
|
3005
|
144 chg_fcn, help_string); |
|
2974
|
145 } |
|
|
146 |
|
|
147 void |
|
|
148 alias_builtin (const string& alias, const string& name) |
|
|
149 { |
|
|
150 symbol_record *sr_name = global_sym_tab->lookup (name); |
|
|
151 |
|
|
152 if (! sr_name) |
|
|
153 panic ("can't alias to undefined name!"); |
|
|
154 |
|
|
155 symbol_record *sr_alias = global_sym_tab->lookup (alias, true); |
|
|
156 |
|
|
157 if (sr_alias) |
|
|
158 sr_alias->alias (sr_name); |
|
|
159 else |
|
|
160 panic ("can't find symbol record for builtin function `%s'", |
|
|
161 alias.c_str ()); |
|
|
162 } |
|
|
163 |
|
|
164 /* |
|
|
165 ;;; Local Variables: *** |
|
|
166 ;;; mode: C++ *** |
|
|
167 ;;; End: *** |
|
|
168 */ |
