Mercurial > octave
annotate libinterp/corefcn/variables.h @ 23075:4e3d47dc7e25
move parse tree classes inside octave namespace
* lex.h, lex.ll, oct-parse.in.yy, parse.h, pt-all.h, pt-arg-list.cc,
pt-arg-list.h, pt-array-list.cc, pt-array-list.h, pt-assign.cc,
pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h, pt-cbinop.cc,
pt-cbinop.h, pt.cc, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.cc, pt-cmd.h, pt-colon.cc,
pt-colon.h, pt-const.cc, pt-const.h, pt-decl.cc, pt-decl.h,
pt-eval.cc, pt-eval.h, pt-except.cc, pt-except.h, pt-exp.cc, pt-exp.h,
pt-fcn-handle.cc, pt-fcn-handle.h, pt-funcall.cc, pt-funcall.h, pt.h,
pt-id.cc, pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.cc, pt-jump.h,
pt-loop.cc, pt-loop.h, pt-mat.cc, pt-mat.h, pt-misc.cc, pt-misc.h,
pt-pr-code.cc, pt-pr-code.h, pt-select.cc, pt-select.h, pt-stmt.cc,
pt-stmt.h, pt-unop.cc, pt-unop.h, pt-walk.h, token.cc, token.h:
Move classes and most functions inside octave namespace.
Change all uses.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 19 Jan 2017 23:41:54 -0500 |
parents | 3a2b891d0b33 |
children | ef4d915df748 |
rev | line source |
---|---|
1 | 1 /* |
2 | |
22323
bac0d6f07a3e
maint: Update copyright notices for 2016.
John W. Eaton <jwe@octave.org>
parents:
22197
diff
changeset
|
3 Copyright (C) 1993-2016 John W. Eaton |
1 | 4 |
5 This file is part of Octave. | |
6 | |
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 |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
9 the Free Software Foundation; either version 3 of the License, or |
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 |
19 <http://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 |
5794 | 41 #include <cfloat> |
42 | |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
43 #include <limits> |
1755 | 44 #include <string> |
1 | 45 |
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
46 #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
|
47 |
2390 | 48 #include "ov.h" |
2975 | 49 #include "ov-builtin.h" |
2953 | 50 #include "symtab.h" |
195 | 51 |
6109 | 52 extern OCTINTERP_API void clear_mex_functions (void); |
195 | 53 |
6109 | 54 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
55 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
|
56 bool warn = false); |
593 | 57 |
6109 | 58 extern OCTINTERP_API octave_function * |
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
59 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
|
60 bool warn = false); |
3178 | 61 |
6109 | 62 extern OCTINTERP_API octave_function * |
3523 | 63 extract_function (const octave_value& arg, const std::string& warn_for, |
10313 | 64 const std::string& fname, const std::string& header, |
65 const std::string& trailer); | |
2796 | 66 |
6109 | 67 extern OCTINTERP_API string_vector |
3523 | 68 get_struct_elts (const std::string& text); |
2921 | 69 |
6109 | 70 extern OCTINTERP_API string_vector |
3523 | 71 generate_struct_completions (const std::string& text, std::string& prefix, |
10313 | 72 std::string& hint); |
3020 | 73 |
6109 | 74 extern OCTINTERP_API bool |
22171
0a4c5a90f286
Allow tab completion of arrays of structures.
Lachlan Andrew <lachlanbis@gmail.com>
parents:
21723
diff
changeset
|
75 looks_like_struct (const std::string& text, char prev_char); |
2921 | 76 |
6109 | 77 extern OCTINTERP_API int |
4930 | 78 symbol_exist (const std::string& name, const std::string& type = "any"); |
4319 | 79 |
6109 | 80 extern OCTINTERP_API std::string |
4954 | 81 unique_symbol_name (const std::string& basename); |
82 | |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
83 extern OCTINTERP_API octave_value |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
84 lookup_function_handle (const std::string& nm); |
4988 | 85 |
6109 | 86 extern OCTINTERP_API octave_value |
5027 | 87 get_global_value (const std::string& nm, bool silent = false); |
3020 | 88 |
10071
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
89 extern OCTINTERP_API void |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
90 set_global_value (const std::string& nm, const octave_value& val); |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
91 |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
92 extern OCTINTERP_API octave_value |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
93 get_top_level_value (const std::string& nm, bool silent = false); |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
94 |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
95 extern OCTINTERP_API void |
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
96 set_top_level_value (const std::string& nm, const octave_value& val); |
3020 | 97 |
6109 | 98 extern OCTINTERP_API octave_value |
5791 | 99 set_internal_variable (bool& var, const octave_value_list& args, |
10313 | 100 int nargout, const char *nm); |
5794 | 101 |
6109 | 102 extern OCTINTERP_API octave_value |
5794 | 103 set_internal_variable (char& var, const octave_value_list& args, |
10313 | 104 int nargout, const char *nm); |
5794 | 105 |
6109 | 106 extern OCTINTERP_API octave_value |
5794 | 107 set_internal_variable (int& var, const octave_value_list& args, |
10313 | 108 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
|
109 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
|
110 int maxval = std::numeric_limits<int>::max ()); |
5794 | 111 |
6109 | 112 extern OCTINTERP_API octave_value |
5794 | 113 set_internal_variable (double& var, const octave_value_list& args, |
10313 | 114 int nargout, const char *nm, |
21723
bae585228161
use namespace for numeric_limits
John W. Eaton <jwe@octave.org>
parents:
21721
diff
changeset
|
115 double minval = -octave::numeric_limits<double>::Inf (), |
bae585228161
use namespace for numeric_limits
John W. Eaton <jwe@octave.org>
parents:
21721
diff
changeset
|
116 double maxval = octave::numeric_limits<double>::Inf ()); |
5791 | 117 |
6109 | 118 extern OCTINTERP_API octave_value |
5791 | 119 set_internal_variable (std::string& var, const octave_value_list& args, |
10313 | 120 int nargout, const char *nm, bool empty_ok = true); |
5794 | 121 |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
122 extern OCTINTERP_API octave_value |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
123 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
|
124 int nargout, const char *nm, const char **choices); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
125 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21244
diff
changeset
|
126 extern OCTINTERP_API octave_value |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
127 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
|
128 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
|
129 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
130 #define SET_INTERNAL_VARIABLE(NM) \ |
5794 | 131 set_internal_variable (V ## NM, args, nargout, #NM) |
5791 | 132 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
133 #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \ |
5794 | 134 set_internal_variable (V ## NM, args, nargout, #NM, false) |
135 | |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22171
diff
changeset
|
136 #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \ |
5794 | 137 set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL) |
5791 | 138 |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
139 // 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
|
140 #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
|
141 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
|
142 |
6109 | 143 extern OCTINTERP_API std::string builtin_string_variable (const std::string&); |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
144 extern OCTINTERP_API int builtin_real_scalar_variable (const std::string&, |
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
145 double&); |
6109 | 146 extern OCTINTERP_API octave_value builtin_any_variable (const std::string&); |
3020 | 147 |
6109 | 148 extern OCTINTERP_API void bind_ans (const octave_value& val, bool print); |
1162 | 149 |
21134
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
150 OCTAVE_DEPRECATED ("note: internal variables have been replaced by functions; use 'feval' instead") |
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
151 OCTINTERP_API extern void |
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
152 bind_internal_variable (const std::string& fname, const octave_value& val); |
1406 | 153 |
7336 | 154 extern OCTINTERP_API void mlock (void); |
6109 | 155 extern OCTINTERP_API void munlock (const std::string&); |
156 extern OCTINTERP_API bool mislocked (const std::string&); | |
4016 | 157 |
7336 | 158 extern OCTINTERP_API void clear_function (const std::string& nm); |
159 extern OCTINTERP_API void clear_variable (const std::string& nm); | |
160 extern OCTINTERP_API void clear_symbol (const std::string& nm); | |
4009 | 161 |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
162 extern OCTINTERP_API void maybe_missing_function_hook (const std::string& name); |
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
163 |
1 | 164 #endif |
22407
34ce5be04942
maint: Style check C++ code in libinterp/.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
165 |