annotate src/variables.h @ 5780:cbf717bf8150

[project @ 2006-04-27 20:02:30 by jwe]
author jwe
date Thu, 27 Apr 2006 20:03:48 +0000
parents 40b08b29dd53
children 70215aff5ccf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2796
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
4
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
10 later version.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
11
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5102
diff changeset
19 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5102
diff changeset
20 02110-1301, USA.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
23
383
0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe]
jwe
parents: 296
diff changeset
24 #if !defined (octave_variables_h)
0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe]
jwe
parents: 296
diff changeset
25 #define octave_variables_h 1
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
26
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2954
diff changeset
27 class octave_function;
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4699
diff changeset
28 class octave_user_function;
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
29 class symbol_record;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
30 class symbol_table;
1738
bb9d00aa55fb [project @ 1996-01-12 10:56:22 by jwe]
jwe
parents: 1727
diff changeset
31
2390
c2c1482c34c8 [project @ 1996-10-12 19:13:23 by jwe]
jwe
parents: 2293
diff changeset
32 class tree_identifier;
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
33 class octave_value;
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
34 class octave_value_list;
2892
aef2d43edbc2 [project @ 1997-04-28 02:04:28 by jwe]
jwe
parents: 2878
diff changeset
35 class octave_builtin;
aef2d43edbc2 [project @ 1997-04-28 02:04:28 by jwe]
jwe
parents: 2878
diff changeset
36 class octave_mapper;
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
37 class string_vector;
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
38
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1738
diff changeset
39 #include <string>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
40
2390
c2c1482c34c8 [project @ 1996-10-12 19:13:23 by jwe]
jwe
parents: 2293
diff changeset
41 #include "ov.h"
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2954
diff changeset
42 #include "ov-builtin.h"
2953
ca7d3625ee01 [project @ 1997-05-09 14:56:52 by jwe]
jwe
parents: 2949
diff changeset
43 #include "symtab.h"
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 1
diff changeset
44
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4699
diff changeset
45 extern bool at_top_level (void);
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4699
diff changeset
46
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 1
diff changeset
47 extern void initialize_symbol_tables (void);
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 1
diff changeset
48
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
49 extern bool is_builtin_variable (const std::string&);
4208
e96f52432059 [project @ 2002-12-03 19:48:57 by jwe]
jwe
parents: 4016
diff changeset
50 extern bool is_command_name (const std::string&);
5685
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
51
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
52 // The next three are here temporarily...
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
53 extern bool is_marked_as_rawcommand (const std::string& s);
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
54 extern void mark_as_rawcommand (const std::string& s);
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
55 extern void unmark_rawcommand (const std::string& s);
40b08b29dd53 [project @ 2006-03-16 19:47:14 by jwe]
jwe
parents: 5663
diff changeset
56
5102
b04b30d30c66 [project @ 2004-12-28 01:59:05 by jwe]
jwe
parents: 5027
diff changeset
57 extern bool is_rawcommand_name (const std::string&);
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
58 extern bool is_mapper_function_name (const std::string&);
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
59 extern bool is_builtin_function_name (const std::string&);
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
60 extern bool is_globally_visible (const std::string&);
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 581
diff changeset
61
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2954
diff changeset
62 extern octave_function *
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
63 is_valid_function (const octave_value&, const std::string& = std::string (),
3308
7ae1928ca623 [project @ 1999-10-21 08:57:11 by jwe]
jwe
parents: 3259
diff changeset
64 bool warn = false);
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 581
diff changeset
65
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2954
diff changeset
66 extern octave_function *
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
67 is_valid_function (const std::string&, const std::string& = std::string (),
3308
7ae1928ca623 [project @ 1999-10-21 08:57:11 by jwe]
jwe
parents: 3259
diff changeset
68 bool warn = false);
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3020
diff changeset
69
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3020
diff changeset
70 extern octave_function *
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
71 extract_function (const octave_value& arg, const std::string& warn_for,
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
72 const std::string& fname, const std::string& header,
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
73 const std::string& trailer);
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2447
diff changeset
74
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2907
diff changeset
75 extern string_vector
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
76 get_struct_elts (const std::string& text);
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2907
diff changeset
77
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
78 extern string_vector
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
79 generate_struct_completions (const std::string& text, std::string& prefix,
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
80 std::string& hint);
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
81
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2907
diff changeset
82 extern bool
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
83 looks_like_struct (const std::string& text);
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2907
diff changeset
84
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4245
diff changeset
85 extern int
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4700
diff changeset
86 symbol_exist (const std::string& name, const std::string& type = "any");
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4245
diff changeset
87
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
88 extern std::string
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
89 unique_symbol_name (const std::string& basename);
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
90
5663
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5397
diff changeset
91 extern bool
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5397
diff changeset
92 fcn_out_of_date (octave_function *fcn, const std::string& ff, time_t tp);
775e065f7dc4 [project @ 2006-03-13 21:30:06 by jwe]
jwe
parents: 5397
diff changeset
93
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
94 extern bool lookup (symbol_record *s, bool exec_script = true);
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
95
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
96 extern symbol_record *
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
97 lookup_by_name (const std::string& nm, bool exec_script = true);
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
98
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4700
diff changeset
99 extern octave_value lookup_function (const std::string& nm);
4342
813effe14ee1 [project @ 2003-02-20 08:35:55 by jwe]
jwe
parents: 4319
diff changeset
100
4930
bdb307dc8613 [project @ 2004-08-05 04:55:26 by jwe]
jwe
parents: 4700
diff changeset
101 extern octave_value lookup_user_function (const std::string& nm);
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4699
diff changeset
102
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4954
diff changeset
103 extern octave_value lookup_function_handle (const std::string& nm);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4954
diff changeset
104
5027
da607e9daf12 [project @ 2004-09-23 01:37:57 by jwe]
jwe
parents: 4988
diff changeset
105 extern octave_value
da607e9daf12 [project @ 2004-09-23 01:37:57 by jwe]
jwe
parents: 4988
diff changeset
106 get_global_value (const std::string& nm, bool silent = false);
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
107
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
108 extern void set_global_value (const std::string& nm, const octave_value& val);
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
109
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
110 extern std::string builtin_string_variable (const std::string&);
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
111 extern int builtin_real_scalar_variable (const std::string&, double&);
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
112 extern octave_value builtin_any_variable (const std::string&);
3020
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
113
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
114 extern void link_to_global_variable (symbol_record *sr);
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
115 extern void link_to_builtin_or_function (symbol_record *sr);
f491f232cb09 [project @ 1997-06-03 22:15:08 by jwe]
jwe
parents: 3016
diff changeset
116
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
117 extern void force_link_to_function (const std::string&);
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2907
diff changeset
118
2856
8c516da3c1f7 [project @ 1997-03-31 06:37:21 by jwe]
jwe
parents: 2849
diff changeset
119 extern void bind_ans (const octave_value& val, bool print);
1162
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1160
diff changeset
120
2892
aef2d43edbc2 [project @ 1997-04-28 02:04:28 by jwe]
jwe
parents: 2878
diff changeset
121 extern void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
122 bind_builtin_variable (const std::string&, const octave_value&,
2892
aef2d43edbc2 [project @ 1997-04-28 02:04:28 by jwe]
jwe
parents: 2878
diff changeset
123 bool protect = false, bool eternal = false,
3005
fd2080b2800e [project @ 1997-05-24 17:37:39 by jwe]
jwe
parents: 2975
diff changeset
124 symbol_record::change_function f = 0,
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3308
diff changeset
125 const std::string& help = std::string ());
1406
034a57daf076 [project @ 1995-09-15 06:03:10 by jwe]
jwe
parents: 1405
diff changeset
126
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4245
diff changeset
127 extern void mlock (const std::string&);
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4245
diff changeset
128 extern void munlock (const std::string&);
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4245
diff changeset
129 extern bool mislocked (const std::string&);
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4009
diff changeset
130
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
131 extern bool clear_function (const std::string& nm);
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4954
diff changeset
132 extern bool clear_variable (const std::string& nm);
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4954
diff changeset
133 extern bool clear_symbol (const std::string& nm);
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
134
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
135 // Symbol table for symbols at the top level.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
136 extern symbol_table *top_level_sym_tab;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
137
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
138 // Symbol table for the current scope.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
139 extern symbol_table *curr_sym_tab;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
140
4245
610671be8792 [project @ 2002-12-28 04:02:31 by jwe]
jwe
parents: 4208
diff changeset
141 // Symbol table for the current caller scope.
610671be8792 [project @ 2002-12-28 04:02:31 by jwe]
jwe
parents: 4208
diff changeset
142 extern symbol_table *curr_caller_sym_tab;
610671be8792 [project @ 2002-12-28 04:02:31 by jwe]
jwe
parents: 4208
diff changeset
143
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
144 // Symbol table for global symbols.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
145 extern symbol_table *global_sym_tab;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
146
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3930
diff changeset
147 // Symbol table for functions and built-in symbols.
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3930
diff changeset
148 extern symbol_table *fbi_sym_tab;
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3930
diff changeset
149
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
150 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
151
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
152 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
153 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
154 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
155 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
156 */