octave: libinterp/corefcn/variables.h annotate

annotate libinterp/corefcn/variables.h @ 30390:a61e1a0f6024 stable

maint: style check C++ files in libinterp/ ahead of 7.1 release. * Cell.cc, __eigs__.cc, __ichol__.cc, __ilu__.cc, __magick_read__.cc, __qp__.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.h, ccolamd.cc, cellfun.cc, data.cc, debug.cc, defun-int.h, dlmread.cc, event-manager.cc, fftn.cc, file-io.cc, ft-text-renderer.cc, gl2ps-print.cc, graphics.cc, graphics.in.h, gzfstream.cc, gzfstream.h, jsondecode.cc, jsonencode.cc, latex-text-renderer.cc, ls-mat5.cc, lu.cc, mex.cc, oct-stream.cc, oct-strstrm.cc, ordqz.cc, pager.h, pr-output.cc, qz.cc, schur.cc, sparse-xdiv.cc, sparse-xpow.cc, sparse.cc, stack-frame.h, strfns.cc, svd.cc, symrcm.cc, symscope.h, sysdep.cc, text-engine.h, text-renderer.h, tril.cc, variables.h, xdiv.h, __glpk__.cc, __init_fltk__.cc, __init_gnuplot__.cc, __voronoi__.cc, audiodevinfo.cc, cdef-class.cc, cdef-class.h, cdef-manager.cc, cdef-manager.h, cdef-method.cc, cdef-object.cc, ov-base-diag.cc, ov-base-diag.h, ov-base-int.cc, ov-base-int.h, ov-base-mat.cc, ov-base-mat.h, ov-base-scalar.h, ov-base-sparse.cc, ov-base-sparse.h, ov-base.h, ov-bool-mat.cc, ov-cell.cc, ov-cell.h, ov-class.cc, ov-class.h, ov-dld-fcn.cc, ov-intx.h, ov-lazy-idx.cc, ov-lazy-idx.h, ov-mex-fcn.h, ov-perm.cc, ov-perm.h, ov-range.cc, ov-re-mat.cc, ov-re-mat.h, ov-str-mat.h, ov-struct.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov.h, parse.h, pt-cell.cc, pt-stmt.cc, pt-tm-const.cc, pt-walk.cc: Style check C++ files in libinterp/ ahead of 7.1 release.

author	Rik <rik@octave.org>
date	Sun, 28 Nov 2021 21:52:08 -0800
parents	428cccc75cc9
children	fe6d1711feea 796f54d4ddbf

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
29358 0a5b15007766 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27923 diff changeset	3 // Copyright (C) 1993-2021 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #if ! defined (octave_variables_h)
383 0b52c68ec81f [project @ 1994-03-09 21:19:44 by jwe] jwe parents: 296 diff changeset	27 #define octave_variables_h 1
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21134 diff changeset	30
2975 b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe] jwe parents: 2954 diff changeset	31 class octave_function;
4700 ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe] jwe parents: 4699 diff changeset	32 class octave_user_function;
1738 bb9d00aa55fb [project @ 1996-01-12 10:56:22 by jwe] jwe parents: 1727 diff changeset	33
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	34 class octave_value;
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	35 class octave_value_list;
2892 aef2d43edbc2 [project @ 1997-04-28 02:04:28 by jwe] jwe parents: 2878 diff changeset	36 class octave_builtin;
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
23075 4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	39 namespace octave
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	40 {
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	41 class tree_identifier;
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	42 }
4e3d47dc7e25 move parse tree classes inside octave namespace John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	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 <limits>
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1738 diff changeset	45 #include <string>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	46
15215 9020dddc925a use std::numeric_limits for integer max and min values John W. Eaton <jwe@octave.org> parents: 15213 diff changeset	47 #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	48
2975 b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe] jwe parents: 2954 diff changeset	49 #include "ov-builtin.h"
195 13c6086c325c [project @ 1993-11-06 10:12:29 by jwe] jwe parents: 1 diff changeset	50
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	51 // The following two functions should be removed or the return type
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	52 // should be changed when we remove octave_function from the interpreter
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	53 // interface. See the discussion about this topic here:
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	54 // https://octave.discourse.group/t/refactoring-octave-value-function-objects-backward-incompatible-change/971
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	55
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	56 extern OCTINTERP_API octave_function *
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 21012 diff changeset	57 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	58 bool warn = false);
593 6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe] jwe parents: 581 diff changeset	59
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	60 extern OCTINTERP_API octave_function *
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 21012 diff changeset	61 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	62 bool warn = false);
3178 09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe] jwe parents: 3020 diff changeset	63
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	64 OCTAVE_NAMESPACE_BEGIN
2796 74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe] jwe parents: 2447 diff changeset	65
23927 e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23703 diff changeset	66 extern OCTINTERP_API int
e3a36f84d01d provide variable-editor widget for the GUI Michael Barnes <mjbcode@runbox.com> parents: 23703 diff changeset	67 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	68
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	69 extern OCTINTERP_API std::string
4954 ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4930 diff changeset	70 unique_symbol_name (const std::string& basename);
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe] jwe parents: 4930 diff changeset	71
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	72 extern OCTINTERP_API octave_value
5791 70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe] jwe parents: 5780 diff changeset	73 set_internal_variable (bool& var, const octave_value_list& args,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	74 int nargout, const char *nm);
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	75
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	76 extern OCTINTERP_API octave_value
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	77 set_internal_variable (char& var, const octave_value_list& args,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	78 int nargout, const char *nm);
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	79
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	80 extern OCTINTERP_API octave_value
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	81 set_internal_variable (int& var, const octave_value_list& args,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	82 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	83 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	84 int maxval = std::numeric_limits<int>::max ());
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	85
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	86 extern OCTINTERP_API octave_value
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	87 set_internal_variable (double& var, const octave_value_list& args,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	88 int nargout, const char *nm,
21723 bae585228161 use namespace for numeric_limits John W. Eaton <jwe@octave.org> parents: 21721 diff changeset	89 double minval = -octave::numeric_limits<double>::Inf (),
bae585228161 use namespace for numeric_limits John W. Eaton <jwe@octave.org> parents: 21721 diff changeset	90 double maxval = octave::numeric_limits<double>::Inf ());
5791 70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe] jwe parents: 5780 diff changeset	91
6109 c68896f193e3 [project @ 2006-10-27 02:16:18 by jwe] jwe parents: 6072 diff changeset	92 extern OCTINTERP_API octave_value
5791 70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe] jwe parents: 5780 diff changeset	93 set_internal_variable (std::string& var, const octave_value_list& args,
10313 f3b65e1ae355 untabify src header files John W. Eaton <jwe@octave.org> parents: 10160 diff changeset	94 int nargout, const char *nm, bool empty_ok = true);
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	95
10638 e1559a8a60b4 general mechanism for string enum variables Jaroslav Hajek <highegg@gmail.com> parents: 10443 diff changeset	96 extern OCTINTERP_API octave_value
21272 987c1a79d33f new set_internal_variable variant John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	97 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	98 int nargout, const char nm, const char *choices);
987c1a79d33f new set_internal_variable variant John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	99
987c1a79d33f new set_internal_variable variant John W. Eaton <jwe@octave.org> parents: 21244 diff changeset	100 extern OCTINTERP_API octave_value
10638 e1559a8a60b4 general mechanism for string enum variables Jaroslav Hajek <highegg@gmail.com> parents: 10443 diff changeset	101 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	102 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	103
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	104 extern OCTINTERP_API std::string
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	105 maybe_missing_function_hook (const std::string& name);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	106
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	107 OCTAVE_NAMESPACE_END
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	108
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	109 #if defined (OCTAVE_PROVIDE_DEPRECATED_SYMBOLS)
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	110
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	111 OCTAVE_DEPRECATED (7, "use 'octave::symbol_exist' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	112 inline int
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	113 symbol_exist (const std::string& name, const std::string& type = "any")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	114 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	115 return octave::symbol_exist (name, type);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	116 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	117
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	118 OCTAVE_DEPRECATED (7, "use 'octave::unique_symbol_name' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	119 inline std::string
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	120 unique_symbol_name (const std::string& basename)
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	121 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	122 return octave::unique_symbol_name (basename);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	123 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	124
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	125 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	126 inline octave_value
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	127 set_internal_variable (bool& var, const octave_value_list& args, int nargout, const char *nm)
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	128 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	129 return octave::set_internal_variable (var, args, nargout, nm);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	130 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	131
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	132 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	133 inline octave_value
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	134 set_internal_variable (char& var, const octave_value_list& args, int nargout, const char *nm)
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	135 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	136 return octave::set_internal_variable (var, args, nargout, nm);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	137 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	138
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	139 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	140 inline octave_value
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	141 set_internal_variable (int& var, const octave_value_list& args, int nargout, const char *nm,
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	142 int minval = std::numeric_limits<int>::min (), int maxval = std::numeric_limits<int>::max ())
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	143 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	144 return octave::set_internal_variable (var, args, nargout, nm, minval, maxval);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	145 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	146
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	147 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	148 inline octave_value
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	149 set_internal_variable (double& var, const octave_value_list& args, int nargout, const char *nm,
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	150 double minval = -octave::numeric_limits<double>::Inf (),
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	151 double maxval = octave::numeric_limits<double>::Inf ())
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	152 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	153 return octave::set_internal_variable (var, args, nargout, nm, minval, maxval);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	154 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	155
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	156 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	157 inline octave_value
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	158 set_internal_variable (std::string& var, const octave_value_list& args, int nargout, const char *nm,
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	159 bool empty_ok = true)
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	160 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	161 return octave::set_internal_variable (var, args, nargout, nm, empty_ok);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	162 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	163
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	164 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	165 inline octave_value
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	166 set_internal_variable (std::string& var, const octave_value_list& args, int nargout, const char *nm,
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	167 const char **choices)
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	168 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	169 return octave::set_internal_variable (var, args, nargout, nm, choices);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	170 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	171
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	172 OCTAVE_DEPRECATED (7, "use 'octave::set_internal_variable' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	173 inline octave_value
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	174 set_internal_variable (int& var, const octave_value_list& args, int nargout, const char *nm,
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30001 diff changeset	175 const char **choices)
30001 428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	176 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	177 return octave::set_internal_variable (var, args, nargout, nm, choices);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	178 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	179
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	180 OCTAVE_DEPRECATED (7, "use 'octave::maybe_missing_function_hook' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	181 inline std::string
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	182 maybe_missing_function_hook (const std::string& name)
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	183 {
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	184 return octave::maybe_missing_function_hook (name);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	185 }
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	186
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	187 OCTAVE_DEPRECATED (6, "use 'octave::get_function_handle' instead")
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	188 extern OCTINTERP_API octave_function *
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	189 extract_function (const octave_value& arg, const std::string& warn_for,
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	190 const std::string& fname, const std::string& header,
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	191 const std::string& trailer);
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	192
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	193 #endif
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	194
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	195 // The following macros should also be considered obsolete.
428cccc75cc9 move most functions in variables.cc to octave namespace John W. Eaton <jwe@octave.org> parents: 29954 diff changeset	196
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22171 diff changeset	197 #define SET_INTERNAL_VARIABLE(NM) \
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	198 set_internal_variable (V ## NM, args, nargout, #NM)
5791 70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe] jwe parents: 5780 diff changeset	199
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22171 diff changeset	200 #define SET_NONEMPTY_INTERNAL_STRING_VARIABLE(NM) \
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	201 set_internal_variable (V ## NM, args, nargout, #NM, false)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	202
22197 e43d83253e28 refill multi-line macro definitions John W. Eaton <jwe@octave.org> parents: 22171 diff changeset	203 #define SET_INTERNAL_VARIABLE_WITH_LIMITS(NM, MINVAL, MAXVAL) \
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5791 diff changeset	204 set_internal_variable (V ## NM, args, nargout, #NM, MINVAL, MAXVAL)
5791 70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe] jwe parents: 5780 diff changeset	205
10640 5c594472f75e determine string enum length by trailing null rather than sizeof Jaroslav Hajek <highegg@gmail.com> parents: 10638 diff changeset	206 // 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	207 #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	208 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	209
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	210 #endif

Mercurial > octave

annotate libinterp/corefcn/variables.h @ 30390:a61e1a0f6024 stable