Mercurial > octave
annotate libinterp/corefcn/variables.h @ 21244:1473547f50f5
include octave-config.h in public header files
* mk-opts.pl, mkbuiltins, mk-ops.awk, sparse-mk-ops.awk:
Emit "#include octave-config.h" statement for generated header files.
* build-env.h, builtins.h, Cell.h, base-text-renderer.h,
c-file-ptr-stream.h, cdisplay.h, comment-list.h, data.h, debug.h,
defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h,
dynamic-ld.h, error.h, errwarn.h, event-queue.h, file-io.h,
ft-text-renderer.h, gl-render.h, gl2ps-print.h, graphics.in.h,
gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h,
jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h,
ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h,
ls-utils.h, mex.h, mexproto.h, mxarray.in.h, oct-errno.h, oct-fstrm.h,
oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h,
oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.h,
oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h,
octave-default-image.h, octave-link.h, octave-preserve-stream-state.h,
pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h,
sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h,
sysdep.h, text-renderer.h, toplev.h, txt-eng.h, utils.h, variables.h,
workspace-element.h, xdiv.h, xnorm.h, xpow.h, zfstream.h, oct-qhull.h,
ov-base-diag.h, ov-base-int.h, ov-base-mat.h, ov-base-scalar.h,
ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h,
ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h,
ov-classdef.h, ov-colon.h, ov-complex.h, ov-cs-list.h, ov-cx-diag.h,
ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.h, ov-fcn-handle.h,
ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h,
ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h,
ov-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h,
ov-intx.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.h,
ov-oncleanup.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h,
ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h,
ov-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h,
ov-uint8.h, ov-usr-fcn.h, ov.h, ovl.h, octave.h, op-int.h, ops.h,
options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h,
pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h,
pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h,
pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h,
pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h,
pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h,
pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h,
Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
CRowVector.h, CSparse.h, DiagArray2.h, MArray.h, MDiagArray2.h,
MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h,
boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h,
dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h,
dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h,
fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h,
fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h,
int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h,
uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h,
f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h,
CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h,
CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h,
DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h,
ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, base-aepbal.h, base-dae.h,
base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun.h,
dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h,
dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.h,
fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h,
fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h,
fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h,
floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h,
lo-mappers.h, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h,
oct-rand.h, oct-spparms.h, randgamma.h, randmtzig.h, randpoisson.h,
sparse-chol.h, sparse-dmsolve.h, sparse-lu.h, sparse-qr.h,
Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h,
Sparse-perm-op-defs.h, mx-base.h, mx-defs.h, mx-ext.h, mx-op-decl.h,
mx-op-defs.h, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h,
mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h,
oct-syscalls.h, oct-time.h, oct-uname.h, pathlen.h, sysdir.h,
syswait.h, action-container.h, base-list.h, byte-swap.h,
caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h,
glob-match.h, lo-array-errwarn.h, lo-array-gripes.h, lo-cutils.h,
lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h,
lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h,
oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h,
oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h,
pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h,
statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h:
Include octave-config.h.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Wed, 10 Feb 2016 14:25:53 -0500 |
| parents | 2e5c1f766ac9 |
| children | 987c1a79d33f |
| rev | line source |
|---|---|
| 1 | 1 /* |
| 2 | |
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17787
diff
changeset
|
3 Copyright (C) 1993-2015 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 | |
| 8 under the terms of the GNU General Public License as published by the | |
| 7016 | 9 Free Software Foundation; either version 3 of the License, or (at your |
| 10 option) any later version. | |
| 1 | 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 | |
| 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 |
| 2390 | 31 class tree_identifier; |
| 2086 | 32 class octave_value; |
| 33 class octave_value_list; | |
| 2892 | 34 class octave_builtin; |
| 1755 | 35 class string_vector; |
| 36 | |
| 5794 | 37 #include <cfloat> |
| 38 | |
|
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
39 #include <limits> |
| 1755 | 40 #include <string> |
| 1 | 41 |
|
15215
9020dddc925a
use std::numeric_limits for integer max and min values
John W. Eaton <jwe@octave.org>
parents:
15213
diff
changeset
|
42 #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
|
43 |
| 2390 | 44 #include "ov.h" |
| 2975 | 45 #include "ov-builtin.h" |
| 2953 | 46 #include "symtab.h" |
| 195 | 47 |
| 6109 | 48 extern OCTINTERP_API void clear_mex_functions (void); |
| 195 | 49 |
| 6109 | 50 extern OCTINTERP_API octave_function * |
|
21017
93748bcaec17
maint: Replace emtpy 'std::string ()' calls with "".
Rik <rik@octave.org>
parents:
21012
diff
changeset
|
51 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
|
52 bool warn = false); |
| 593 | 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 std::string&, 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); |
| 3178 | 57 |
| 6109 | 58 extern OCTINTERP_API octave_function * |
| 3523 | 59 extract_function (const octave_value& arg, const std::string& warn_for, |
| 10313 | 60 const std::string& fname, const std::string& header, |
| 61 const std::string& trailer); | |
| 2796 | 62 |
| 6109 | 63 extern OCTINTERP_API string_vector |
| 3523 | 64 get_struct_elts (const std::string& text); |
| 2921 | 65 |
| 6109 | 66 extern OCTINTERP_API string_vector |
| 3523 | 67 generate_struct_completions (const std::string& text, std::string& prefix, |
| 10313 | 68 std::string& hint); |
| 3020 | 69 |
| 6109 | 70 extern OCTINTERP_API bool |
| 3523 | 71 looks_like_struct (const std::string& text); |
| 2921 | 72 |
| 6109 | 73 extern OCTINTERP_API int |
| 4930 | 74 symbol_exist (const std::string& name, const std::string& type = "any"); |
| 4319 | 75 |
| 6109 | 76 extern OCTINTERP_API std::string |
| 4954 | 77 unique_symbol_name (const std::string& basename); |
| 78 | |
|
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
79 extern OCTINTERP_API octave_value |
|
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
80 lookup_function_handle (const std::string& nm); |
| 4988 | 81 |
| 6109 | 82 extern OCTINTERP_API octave_value |
| 5027 | 83 get_global_value (const std::string& nm, bool silent = false); |
| 3020 | 84 |
|
10071
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
85 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
|
86 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
|
87 |
|
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
88 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
|
89 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
|
90 |
|
e42b1bbd1052
variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
91 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
|
92 set_top_level_value (const std::string& nm, const octave_value& val); |
| 3020 | 93 |
| 6109 | 94 extern OCTINTERP_API octave_value |
| 5791 | 95 set_internal_variable (bool& var, const octave_value_list& args, |
| 10313 | 96 int nargout, const char *nm); |
| 5794 | 97 |
| 6109 | 98 extern OCTINTERP_API octave_value |
| 5794 | 99 set_internal_variable (char& 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 (int& var, const octave_value_list& args, |
| 10313 | 104 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
|
105 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
|
106 int maxval = std::numeric_limits<int>::max ()); |
| 5794 | 107 |
| 6109 | 108 extern OCTINTERP_API octave_value |
| 5794 | 109 set_internal_variable (double& var, const octave_value_list& args, |
| 10313 | 110 int nargout, const char *nm, |
|
15213
336f42406671
use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
111 double minval = -octave_Inf, |
|
336f42406671
use numeric_limits functions instead of DBL_MIN, DBL_MAX, etc.
John W. Eaton <jwe@octave.org>
parents:
15195
diff
changeset
|
112 double maxval = octave_Inf); |
| 5791 | 113 |
| 6109 | 114 extern OCTINTERP_API octave_value |
| 5791 | 115 set_internal_variable (std::string& var, const octave_value_list& args, |
| 10313 | 116 int nargout, const char *nm, bool empty_ok = true); |
| 5794 | 117 |
|
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
118 extern OCTINTERP_API octave_value |
|
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
119 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
|
120 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
|
121 |
| 5794 | 122 #define SET_INTERNAL_VARIABLE(NM) \ |
| 123 set_internal_variable (V ## NM, args, nargout, #NM) | |
| 5791 | 124 |
| 5794 | 125 #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \ |
| 126 set_internal_variable (V ## NM, args, nargout, #NM, false) | |
| 127 | |
| 128 #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \ | |
| 129 set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL) | |
| 5791 | 130 |
|
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
131 // in the following, CHOICES must be a C string array terminated by null. |
|
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
132 #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
|
133 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
|
134 |
| 6109 | 135 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
|
136 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
|
137 double&); |
| 6109 | 138 extern OCTINTERP_API octave_value builtin_any_variable (const std::string&); |
| 3020 | 139 |
| 6109 | 140 extern OCTINTERP_API void bind_ans (const octave_value& val, bool print); |
| 1162 | 141 |
|
21134
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
142 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
|
143 OCTINTERP_API extern void |
|
2e5c1f766ac9
provide replacement hints for deprecated C++ functions
John W. Eaton <jwe@octave.org>
parents:
21040
diff
changeset
|
144 bind_internal_variable (const std::string& fname, const octave_value& val); |
| 1406 | 145 |
| 7336 | 146 extern OCTINTERP_API void mlock (void); |
| 6109 | 147 extern OCTINTERP_API void munlock (const std::string&); |
| 148 extern OCTINTERP_API bool mislocked (const std::string&); | |
| 4016 | 149 |
| 7336 | 150 extern OCTINTERP_API void clear_function (const std::string& nm); |
| 151 extern OCTINTERP_API void clear_variable (const std::string& nm); | |
| 152 extern OCTINTERP_API void clear_symbol (const std::string& nm); | |
| 4009 | 153 |
|
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10313
diff
changeset
|
154 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
|
155 |
| 1 | 156 #endif |