Mercurial > octave
annotate libinterp/corefcn/variables.h @ 25054:6652d3823428 stable
maint: Update copyright dates in all source files.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 30 Mar 2018 09:19:05 -0400 |
parents | 194eb4bd202b |
children | ab10403a0b50 |
rev | line source |
---|---|
1 | 1 /* |
2 | |
25054
6652d3823428
maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents:
24534
diff
changeset
|
3 Copyright (C) 1993-2018 John W. Eaton |
1 | 4 |
5 This file is part of Octave. | |
6 | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24362
diff
changeset
|
7 Octave is free software: you can redistribute it and/or modify it |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
8 under the terms of the GNU General Public License as published by |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24362
diff
changeset
|
9 the Free Software Foundation, either version 3 of the License, or |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
10 (at your option) any later version. |
1 | 11 |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
12 Octave is distributed in the hope that it will be useful, but |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
13 WITHOUT ANY WARRANTY; without even the implied warranty of |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
15 GNU General Public License for more details. |
1 | 16 |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
24362
diff
changeset
|
19 <https://www.gnu.org/licenses/>. |
1 | 20 |
21 */ | |
22 | |
20791
f7084eae3318
maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
23 #if ! defined (octave_variables_h) |
383 | 24 #define octave_variables_h 1 |
1 | 25 |
21244
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21134
diff
changeset
|
26 #include "octave-config.h" |
1473547f50f5
include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents:
21134
diff
changeset
|
27 |
2975 | 28 class octave_function; |
4700 | 29 class octave_user_function; |
1738 | 30 |
2086 | 31 class octave_value; |
32 class octave_value_list; | |
2892 | 33 class octave_builtin; |
1755 | 34 class string_vector; |
35 | |
23075
4e3d47dc7e25
move parse tree classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
36 namespace octave |
4e3d47dc7e25
move parse tree classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
37 { |
4e3d47dc7e25
move parse tree classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
38 class tree_identifier; |
4e3d47dc7e25
move parse tree classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
39 } |
4e3d47dc7e25
move parse tree classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
22755
diff
changeset
|
40 |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
41 #include <limits> |
1755 | 42 #include <string> |
1 | 43 |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
44 #include "lo-ieee.h" |
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
45 |
2975 | 46 #include "ov-builtin.h" |
195 | 47 |
6109 | 48 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
49 is_valid_function (const octave_value&, const std::string& = "", |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
50 bool warn = false); |
593 | 51 |
6109 | 52 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
53 is_valid_function (const std::string&, const std::string& = "", |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
54 bool warn = false); |
3178 | 55 |
6109 | 56 extern OCTINTERP_API octave_function * |
3523 | 57 extract_function (const octave_value& arg, const std::string& warn_for, |
10313 | 58 const std::string& fname, const std::string& header, |
59 const std::string& trailer); | |
2796 | 60 |
6109 | 61 extern OCTINTERP_API string_vector |
3523 | 62 get_struct_elts (const std::string& text); |
2921 | 63 |
6109 | 64 extern OCTINTERP_API string_vector |
3523 | 65 generate_struct_completions (const std::string& text, std::string& prefix, |
10313 | 66 std::string& hint); |
3020 | 67 |
6109 | 68 extern OCTINTERP_API bool |
22171
0a4c5a90f286
Allow tab completion of arrays of structures.
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21723
diff
changeset
|
69 looks_like_struct (const std::string& text, char prev_char); |
2921 | 70 |
23927
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23703
diff
changeset
|
71 extern OCTINTERP_API int |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23703
diff
changeset
|
72 symbol_exist (const std::string& name, const std::string& type = "any"); |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23703
diff
changeset
|
73 |
6109 | 74 extern OCTINTERP_API std::string |
4954 | 75 unique_symbol_name (const std::string& basename); |
76 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
77 extern OCTINTERP_API octave_value |
5791 | 78 set_internal_variable (bool& var, const octave_value_list& args, |
10313 | 79 int nargout, const char *nm); |
5794 | 80 |
6109 | 81 extern OCTINTERP_API octave_value |
5794 | 82 set_internal_variable (char& var, const octave_value_list& args, |
10313 | 83 int nargout, const char *nm); |
5794 | 84 |
6109 | 85 extern OCTINTERP_API octave_value |
5794 | 86 set_internal_variable (int& var, const octave_value_list& args, |
10313 | 87 int nargout, const char *nm, |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
88 int minval = std::numeric_limits<int>::min (), |
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
89 int maxval = std::numeric_limits<int>::max ()); |
5794 | 90 |
6109 | 91 extern OCTINTERP_API octave_value |
5794 | 92 set_internal_variable (double& var, const octave_value_list& args, |
10313 | 93 int nargout, const char *nm, |
21723
bae585228161
use namespace for numeric_limits
John W. Eaton <jwe@octave.org>
parents:
21721
diff
changeset
|
94 double minval = -octave::numeric_limits<double>::Inf (), |
bae585228161
use namespace for numeric_limits
John W. Eaton <jwe@octave.org>
parents:
21721
diff
changeset
|
95 double maxval = octave::numeric_limits<double>::Inf ()); |
5791 | 96 |
6109 | 97 extern OCTINTERP_API octave_value |
5791 | 98 set_internal_variable (std::string& var, const octave_value_list& args, |
10313 | 99 int nargout, const char *nm, bool empty_ok = true); |
5794 | 100 |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
101 extern OCTINTERP_API octave_value |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
102 set_internal_variable (std::string& var, const octave_value_list& args, |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
103 int nargout, const char *nm, const char **choices); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
104 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
105 extern OCTINTERP_API octave_value |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
106 set_internal_variable (int& var, const octave_value_list& args, |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
107 int nargout, const char *nm, const char **choices); |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
108 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
109 #define SET_INTERNAL_VARIABLE(NM) \ |
5794 | 110 set_internal_variable (V ## NM, args, nargout, #NM) |
5791 | 111 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
112 #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \ |
5794 | 113 set_internal_variable (V ## NM, args, nargout, #NM, false) |
114 | |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
115 #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \ |
5794 | 116 set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL) |
5791 | 117 |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
118 // in the following, CHOICES must be a C string array terminated by null. |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
119 #define SET_INTERNAL_VARIABLE_CHOICES(NM, CHOICES) \ |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
120 set_internal_variable (V ## NM, args, nargout, #NM, CHOICES) |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
121 |
23703
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
122 extern OCTINTERP_API void maybe_missing_function_hook (const std::string& name); |
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
123 |
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
124 OCTAVE_DEPRECATED (4.4, "use 'interpreter::mlock' instead") |
7336 | 125 extern OCTINTERP_API void mlock (void); |
23703
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
126 |
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
127 OCTAVE_DEPRECATED (4.4, "use 'interpreter::munlock' instead") |
6109 | 128 extern OCTINTERP_API void munlock (const std::string&); |
23703
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
129 |
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
130 OCTAVE_DEPRECATED (4.4, "use 'interpreter::mislocked' instead") |
6109 | 131 extern OCTINTERP_API bool mislocked (const std::string&); |
4016 | 132 |
23702
d396b5fd9199
move bind_ans to tree_evaluator class
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
133 OCTAVE_DEPRECATED (4.4, "use 'tree_evaluator::bind_ans' instead") |
d396b5fd9199
move bind_ans to tree_evaluator class
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
134 extern OCTINTERP_API void bind_ans (const octave_value& val, bool print); |
d396b5fd9199
move bind_ans to tree_evaluator class
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
135 |
23699
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
136 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::clear_mex_functions' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
137 extern OCTINTERP_API void clear_mex_functions (void); |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
138 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
139 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::clear_function' instead") |
7336 | 140 extern OCTINTERP_API void clear_function (const std::string& nm); |
23699
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
141 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
142 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::clear_variable' instead") |
7336 | 143 extern OCTINTERP_API void clear_variable (const std::string& nm); |
23699
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
144 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
145 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::clear_symbol' instead") |
7336 | 146 extern OCTINTERP_API void clear_symbol (const std::string& nm); |
4009 | 147 |
23699
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
148 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::varval' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
149 extern OCTINTERP_API octave_value |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
150 lookup_function_handle (const std::string& nm); |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
151 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
152 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::global_varval' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
153 extern OCTINTERP_API octave_value |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
154 get_global_value (const std::string& nm, bool silent = false); |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
155 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
156 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::global_assign' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
157 extern OCTINTERP_API void |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
158 set_global_value (const std::string& nm, const octave_value& val); |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
159 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
160 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::top_level_varval' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
161 extern OCTINTERP_API octave_value |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
162 get_top_level_value (const std::string& nm, bool silent = false); |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
163 |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
164 OCTAVE_DEPRECATED (4.4, "use 'symbol_table::top_level_assign' instead") |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
165 extern OCTINTERP_API void |
b29904962d2d
deprecate some global functions that access the symbol table
John W. Eaton <jwe@octave.org>
parents:
23614
diff
changeset
|
166 set_top_level_value (const std::string& nm, const octave_value& val); |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
167 |
1 | 168 #endif |