Mercurial > octave
annotate libinterp/corefcn/variables.cc @ 29958:32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
* mk-opts.pl: Surround emitted function definitions with
OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags.
* mk-builtins.pl: Surround emitted function declarations with
OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags. Emit deprecated
global inline functions.
* __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc,
__expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc,
__lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc,
amd.cc, balance.cc, besselj.cc, bitfcns.cc, bsxfun.cc, call-stack.cc,
ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc,
defun.cc, det.cc, dirfns.cc, display.cc, dlmread.cc, dmperm.cc,
dot.cc, eig.cc, ellipj.cc, environment.cc, error.cc, event-manager.cc,
fcn-info.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc,
graphics.cc, gsvd.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc,
interpreter.cc, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, ordqz.cc, ordschur.cc, pager.cc, pinv.cc, pr-flt-fmt.cc,
pr-output.cc, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.cc, settings.cc, sighandlers.cc, sparse.cc,
spparms.cc, sqrtm.cc, stream-euler.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, symrcm.cc, symtab.cc,
syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc,
typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_gnuplot__.cc, __ode15__.cc,
__voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc,
gzip.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc,
ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc,
octave.cc, lex.ll, oct-parse.yy, profiler.cc, pt-eval.cc: Surround
DEFUN and DEFMETHOD function defnitions with OCTAVE_NAMESPACE_BEGIN
and OCTAVE_NAMESPACE_END tags.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 13 Aug 2021 21:53:51 -0400 |
parents | ce4436d2b206 |
children | 7d6709900da7 |
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:
29032
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 | 25 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21660
diff
changeset
|
26 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21272
diff
changeset
|
27 # include "config.h" |
1 | 28 #endif |
29 | |
1468 | 30 #include <cstdio> |
1343 | 31 #include <cstring> |
605 | 32 |
7336 | 33 #include <iomanip> |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
34 #include <list> |
4207 | 35 #include <set> |
1728 | 36 #include <string> |
37 | |
2926 | 38 #include "file-stat.h" |
39 #include "oct-env.h" | |
4604 | 40 #include "file-ops.h" |
2926 | 41 #include "glob-match.h" |
16940
99122191d3dd
maint: Rename regexp.h to lo-regexp.h, regexp.cc to lo-regexp.cc in liboctave.
Rik <rik@octave.org>
parents:
16892
diff
changeset
|
42 #include "lo-regexp.h" |
1755 | 43 #include "str-vec.h" |
44 | |
4435 | 45 #include "Cell.h" |
1352 | 46 #include "defun.h" |
47 #include "error.h" | |
21100
e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents:
21095
diff
changeset
|
48 #include "errwarn.h" |
27263
99aa1bcb8848
rename octave_link and octave_link_events classes, move inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27261
diff
changeset
|
49 #include "event-manager.h" |
1352 | 50 #include "help.h" |
3165 | 51 #include "input.h" |
23438
d24d01273bd0
eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents:
23332
diff
changeset
|
52 #include "interpreter-private.h" |
22094
9203833cab7d
move new interpreter class to separate file
John W. Eaton <jwe@octave.org>
parents:
22091
diff
changeset
|
53 #include "interpreter.h" |
1352 | 54 #include "lex.h" |
5832 | 55 #include "load-path.h" |
20925
667861ffffab
Extracted header class octave-preserve-stream-state from utils.{cc/h}.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents:
20909
diff
changeset
|
56 #include "octave-preserve-stream-state.h" |
2926 | 57 #include "oct-map.h" |
20940
48b2ad5ee801
maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents:
20939
diff
changeset
|
58 #include "ovl.h" |
2926 | 59 #include "ov.h" |
9240
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9180
diff
changeset
|
60 #include "ov-class.h" |
3933 | 61 #include "ov-usr-fcn.h" |
605 | 62 #include "pager.h" |
1352 | 63 #include "parse.h" |
27016
9b261300a001
move file-scope static autoload map variable and functions to evaluator
John W. Eaton <jwe@octave.org>
parents:
26843
diff
changeset
|
64 #include "pt-eval.h" |
26088
2b92498c111e
move symbol_info and symbol_info_list classes to separate file
John W. Eaton <jwe@octave.org>
parents:
26087
diff
changeset
|
65 #include "syminfo.h" |
2926 | 66 #include "symtab.h" |
26843
f07542e3a9b9
Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents:
26687
diff
changeset
|
67 #include "sysdep.h" |
1352 | 68 #include "unwind-prot.h" |
1 | 69 #include "utils.h" |
1352 | 70 #include "variables.h" |
2205 | 71 |
593 | 72 // Attributes of variables and functions. |
73 | |
2086 | 74 // Is this octave_value a valid function? |
593 | 75 |
2975 | 76 octave_function * |
4345 | 77 is_valid_function (const std::string& fcn_name, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
78 const std::string& warn_for, bool warn) |
593 | 79 { |
23457
21baad6b35c4
maint: Use C++11 nullptr rather than 0 or NULL when possible.
Rik <rik@octave.org>
parents:
23450
diff
changeset
|
80 octave_function *ans = nullptr; |
593 | 81 |
1755 | 82 if (! fcn_name.empty ()) |
3618 | 83 { |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
84 octave::symbol_table& symtab |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
85 = octave::__get_symbol_table__ ("is_valid_function"); |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
86 |
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
87 octave_value val = symtab.find_function (fcn_name); |
7336 | 88 |
89 if (val.is_defined ()) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
90 ans = val.function_value (true); |
3618 | 91 } |
593 | 92 |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
93 // FIXME: Should this be "err" and "error_for", rather than warn? |
7336 | 94 if (! ans && warn) |
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
95 error ("%s: the symbol '%s' is not valid as a function", |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
96 warn_for.c_str (), fcn_name.c_str ()); |
593 | 97 |
98 return ans; | |
99 } | |
100 | |
2975 | 101 octave_function * |
4345 | 102 is_valid_function (const octave_value& arg, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
103 const std::string& warn_for, bool warn) |
3178 | 104 { |
23457
21baad6b35c4
maint: Use C++11 nullptr rather than 0 or NULL when possible.
Rik <rik@octave.org>
parents:
23450
diff
changeset
|
105 octave_function *ans = nullptr; |
3178 | 106 |
3523 | 107 std::string fcn_name; |
3178 | 108 |
109 if (arg.is_string ()) | |
4700 | 110 { |
111 fcn_name = arg.string_value (); | |
3178 | 112 |
19743
67f2c76f9f4d
Remove unnecessary checking of error_state after is_string validation.
Rik <rik@octave.org>
parents:
19718
diff
changeset
|
113 ans = is_valid_function (fcn_name, warn_for, warn); |
4700 | 114 } |
3178 | 115 else if (warn) |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
116 // FIXME: Should this be "err" and "error_for", rather than warn? |
22407
34ce5be04942
maint: Style check C++ code in libinterp/.
Rik <rik@octave.org>
parents:
22333
diff
changeset
|
117 error ("%s: argument must be a string containing function name", |
34ce5be04942
maint: Style check C++ code in libinterp/.
Rik <rik@octave.org>
parents:
22333
diff
changeset
|
118 warn_for.c_str ()); |
3178 | 119 |
120 return ans; | |
121 } | |
122 | |
123 octave_function * | |
3523 | 124 extract_function (const octave_value& arg, const std::string& warn_for, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
125 const std::string& fname, const std::string& header, |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
126 const std::string& trailer) |
2796 | 127 { |
26434
fad593da4b57
variables.cc: Fix static analyzer detected issues (bug #55347).
Rik <rik@octave.org>
parents:
26376
diff
changeset
|
128 octave_function *retval = is_valid_function (arg, warn_for, 0); |
2796 | 129 |
130 if (! retval) | |
131 { | |
24218
3d26a174e143
* variables.cc (extract_function): Omit 'first' from error message.
John W. Eaton <jwe@octave.org>
parents:
24070
diff
changeset
|
132 std::string s = arg.xstring_value ("%s: argument must be a string", |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
133 warn_for.c_str ()); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
134 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
135 std::string cmd = header; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
136 cmd.append (s); |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
137 cmd.append (trailer); |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
138 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
139 int parse_status; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
140 |
26113
8a15f3bace49
move eval_string inside interpreter/evaluator class
John W. Eaton <jwe@octave.org>
parents:
26107
diff
changeset
|
141 octave::interpreter& interp |
8a15f3bace49
move eval_string inside interpreter/evaluator class
John W. Eaton <jwe@octave.org>
parents:
26107
diff
changeset
|
142 = octave::__get_interpreter__ ("extract_function"); |
8a15f3bace49
move eval_string inside interpreter/evaluator class
John W. Eaton <jwe@octave.org>
parents:
26107
diff
changeset
|
143 |
8a15f3bace49
move eval_string inside interpreter/evaluator class
John W. Eaton <jwe@octave.org>
parents:
26107
diff
changeset
|
144 interp.eval_string (cmd, true, parse_status, 0); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
145 |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
146 if (parse_status != 0) |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
147 error ("%s: '%s' is not valid as a function", |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
148 warn_for.c_str (), fname.c_str ()); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
149 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
150 retval = is_valid_function (fname, warn_for, 0); |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
151 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
152 if (! retval) |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
153 error ("%s: '%s' is not valid as a function", |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
154 warn_for.c_str (), fname.c_str ()); |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
155 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
156 warning ("%s: passing function body as a string is obsolete; please use anonymous functions", |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
157 warn_for.c_str ()); |
2796 | 158 } |
159 | |
160 return retval; | |
161 } | |
162 | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
163 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
164 |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
165 DEFMETHOD (isglobal, interp, args, , |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
166 doc: /* -*- texinfo -*- |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
167 @deftypefn {} {} isglobal (@var{name}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
168 Return true if @var{name} is a globally visible variable. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
169 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
170 For example: |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
171 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
172 @example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
173 @group |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
174 global x |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
175 isglobal ("x") |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
176 @result{} 1 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
177 @end group |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
178 @end example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
179 @seealso{isvarname, exist} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
180 @end deftypefn */) |
5930 | 181 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
182 if (args.length () != 1) |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
183 print_usage (); |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
184 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
185 std::string name = args(0).xstring_value ("isglobal: NAME must be a string"); |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
186 |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
187 return ovl (interp.isglobal (name)); |
5930 | 188 } |
189 | |
21389
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
190 /* |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
191 %!test |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
192 %! global x; |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21568
diff
changeset
|
193 %! assert (isglobal ("x"), true); |
25762
97ea2329d5d8
Use nested functions to prevent leaking globals in BIST tests.
Rik <rik@octave.org>
parents:
25646
diff
changeset
|
194 %! clear -global x; # cleanup after test |
21389
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
195 |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
196 %!error isglobal () |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
197 %!error isglobal ("a", "b") |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
198 %!error isglobal (1) |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
199 */ |
64efef931bd0
Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents:
21317
diff
changeset
|
200 |
23143
898c33f4b9c0
declare some functions that are only used once "static"
John W. Eaton <jwe@octave.org>
parents:
23110
diff
changeset
|
201 static int |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
202 symbol_exist (octave::interpreter& interp, const std::string& name, |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
203 const std::string& type = "any") |
593 | 204 { |
26059
da2bbcf1fbcd
Deprecate C++ function is_keyword in favor of iskeyword for readability.
Rik <rik@octave.org>
parents:
25952
diff
changeset
|
205 if (octave::iskeyword (name)) |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
206 return 0; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
207 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
208 bool search_any = type == "any"; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
209 bool search_var = type == "var"; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
210 bool search_dir = type == "dir"; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
211 bool search_file = type == "file"; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
212 bool search_builtin = type == "builtin"; |
20206
3c8260fd0837
Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
213 bool search_class = type == "class"; |
3c8260fd0837
Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
214 |
25951 | 215 if (! (search_any || search_var || search_dir || search_file |
216 || search_builtin || search_class)) | |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
217 error (R"(exist: unrecognized type argument "%s")", type.c_str ()); |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
218 |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
219 octave::symbol_table& symtab = interp.get_symbol_table (); |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
220 |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
221 if (search_any || search_var) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
222 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
223 octave_value val = interp.varval (name); |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
224 |
23587
0c468af9dc00
maint: Deprecate is_object and replace with isobject.
Rik <rik@octave.org>
parents:
23584
diff
changeset
|
225 if (val.is_constant () || val.isobject () |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
226 || val.is_function_handle () |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
227 || val.is_anonymous_function () |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
228 || val.is_inline_function ()) |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
229 return 1; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
230 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
231 if (search_var) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
232 return 0; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
233 } |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
234 |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
235 // We shouldn't need to look in the global symbol table, since any name |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
236 // that is visible in the current scope will be in the local symbol table. |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
237 |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
238 if (search_any || search_file || search_dir) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
239 { |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
240 bool have_fcn_ext = false; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
241 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
242 std::string xname = name; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
243 std::string ext; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
244 |
29654
d13d090cb03a
use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
245 std::size_t pos = name.rfind ('.'); |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
246 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
247 if (pos != std::string::npos) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
248 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
249 ext = name.substr (pos+1); |
27016
9b261300a001
move file-scope static autoload map variable and functions to evaluator
John W. Eaton <jwe@octave.org>
parents:
26843
diff
changeset
|
250 |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
251 if (ext == "m" || ext == "oct" || ext == "mex") |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
252 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
253 xname = name.substr (0, pos); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
254 have_fcn_ext = true; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
255 } |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
256 } |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
257 |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
258 std::string file_name; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
259 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
260 if (search_any || search_file) |
23438
d24d01273bd0
eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents:
23332
diff
changeset
|
261 { |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
262 octave::load_path& lp = interp.get_load_path (); |
23438
d24d01273bd0
eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents:
23332
diff
changeset
|
263 |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
264 // Class constructor. |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
265 file_name = lp.find_method (xname, xname); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
266 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
267 if (have_fcn_ext && ! file_name.empty ()) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
268 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
269 pos = file_name.rfind ('.'); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
270 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
271 if (pos != std::string::npos) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
272 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
273 std::string fext = file_name.substr (pos+1); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
274 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
275 if (ext != fext) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
276 file_name = ""; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
277 } |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
278 } |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
279 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
280 if (search_any && file_name.empty ()) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
281 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
282 // Command line function which Matlab does not support |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
283 octave_value val = symtab.find_cmdline_function (xname); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
284 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
285 if (val.is_defined ()) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
286 return 103; |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
287 } |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
288 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
289 // Autoloads can only have simple names without extensions. |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
290 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
291 if (! have_fcn_ext && file_name.empty ()) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
292 { |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
293 octave::tree_evaluator& tw = interp.get_evaluator (); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
294 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
295 file_name = tw.lookup_autoload (name); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
296 } |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
297 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
298 // Use original name here. |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
299 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
300 if (file_name.empty ()) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
301 file_name = lp.find_fcn (name); |
23438
d24d01273bd0
eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents:
23332
diff
changeset
|
302 } |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
303 |
29654
d13d090cb03a
use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
304 std::size_t len = file_name.length (); |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
305 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
306 if (len > 0) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
307 { |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
308 if (search_any || search_file) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
309 { |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
310 if (len > 4 && (file_name.substr (len-4) == ".oct" |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
311 || file_name.substr (len-4) == ".mex")) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
312 return 3; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
313 else |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
314 return 2; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
315 } |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
316 } |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
317 |
25646
4d565baa475e
move libinterp/utils functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
25464
diff
changeset
|
318 file_name = octave::file_in_path (name, ""); |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
319 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
320 if (file_name.empty ()) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
321 file_name = name; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
322 |
26843
f07542e3a9b9
Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents:
26687
diff
changeset
|
323 // "stat" doesn't work on UNC shares and drive letters. |
f07542e3a9b9
Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents:
26687
diff
changeset
|
324 if ((search_any || search_file) && octave::drive_or_unc_share (file_name)) |
f07542e3a9b9
Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents:
26687
diff
changeset
|
325 return 7; |
f07542e3a9b9
Fix "exist" for drive letters and UNC shares on Windows (bug #55824).
Markus Mützel <markus.muetzel@gmx.de>
parents:
26687
diff
changeset
|
326 |
21736
0504351a45e6
use namespace for file_stat classes
John W. Eaton <jwe@octave.org>
parents:
21733
diff
changeset
|
327 octave::sys::file_stat fs (file_name); |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
328 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
329 if (fs) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
330 { |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
331 if (search_any || search_file) |
19861
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
332 { |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
333 if (fs.is_dir ()) |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
334 return 7; |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
335 |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
336 len = file_name.length (); |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
337 |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
338 if (len > 4 && (file_name.substr (len-4) == ".oct" |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
339 || file_name.substr (len-4) == ".mex")) |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
340 return 3; |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
341 else |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
342 return 2; |
19755f4fc851
maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19750
diff
changeset
|
343 } |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
344 else if (search_dir && fs.is_dir ()) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
345 return 7; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
346 } |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
347 |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
348 if (search_file || search_dir) |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
349 return 0; |
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
350 } |
1277 | 351 |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
352 if ((search_any || search_builtin) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
353 && symtab.is_built_in_function_name (name)) |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
354 return 5; |
4016 | 355 |
17963
2ca3a2f46d93
improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents:
17861
diff
changeset
|
356 return 0; |
593 | 357 } |
358 | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
359 OCTAVE_NAMESPACE_END |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
360 |
23927
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
361 int |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
362 symbol_exist (const std::string& name, const std::string& type) |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
363 { |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
364 octave::interpreter& interp = octave::__get_interpreter__ ("symbol_exist"); |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
365 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
366 return octave::symbol_exist (interp, name, type); |
23927
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
367 } |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
368 |
e3a36f84d01d
provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents:
23829
diff
changeset
|
369 |
22197
e43d83253e28
refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents:
22196
diff
changeset
|
370 #define GET_IDX(LEN) \ |
26372
2d9ae06f621b
Fix static analyzer detected V1003 issues with expansions in macros (bug #55347).
Rik <rik@octave.org>
parents:
26169
diff
changeset
|
371 static_cast<int> (((LEN)-1) * static_cast<double> (rand ()) / RAND_MAX) |
4962 | 372 |
4954 | 373 std::string |
374 unique_symbol_name (const std::string& basename) | |
375 { | |
4962 | 376 static const std::string alpha |
377 = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"; | |
378 | |
29654
d13d090cb03a
use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
379 static std::size_t len = alpha.length (); |
4962 | 380 |
381 std::string nm = basename + alpha[GET_IDX (len)]; | |
382 | |
29654
d13d090cb03a
use std::size_t and std::ptrdiff_t in C++ code (bug #60471)
John W. Eaton <jwe@octave.org>
parents:
29358
diff
changeset
|
383 std::size_t pos = nm.length (); |
4962 | 384 |
385 if (nm.substr (0, 2) == "__") | |
386 nm.append ("__"); | |
387 | |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
388 octave::interpreter& interp |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
389 = octave::__get_interpreter__ ("unique_symbol_name"); |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
390 |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
391 while (symbol_exist (interp, nm, "any")) |
4962 | 392 nm.insert (pos++, 1, alpha[GET_IDX (len)]); |
393 | |
394 return nm; | |
4954 | 395 } |
396 | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
397 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
398 |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
399 DEFMETHOD (exist, interp, args, , |
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
400 doc: /* -*- texinfo -*- |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
401 @deftypefn {} {@var{c} =} exist (@var{name}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
402 @deftypefnx {} {@var{c} =} exist (@var{name}, @var{type}) |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
403 Check for the existence of @var{name} as a variable, function, file, directory, |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
404 or class. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
405 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
406 The return code @var{c} is one of |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
407 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
408 @table @asis |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
409 @item 1 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
410 @var{name} is a variable. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
411 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
412 @item 2 |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
413 @var{name} is an absolute filename, an ordinary file in Octave's @code{path}, |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
414 or (after appending @samp{.m}) a function file in Octave's @code{path}. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
415 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
416 @item 3 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
417 @var{name} is a @samp{.oct} or @samp{.mex} file in Octave's @code{path}. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
418 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
419 @item 5 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
420 @var{name} is a built-in function. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
421 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
422 @item 7 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
423 @var{name} is a directory. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
424 |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
425 @item 8 |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
426 @var{name} is a class. (Note: not currently implemented) |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
427 |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
428 @item 103 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
429 @var{name} is a function not associated with a file (entered on the command |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
430 line). |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
431 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
432 @item 0 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
433 @var{name} does not exist. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
434 @end table |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
435 |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
436 If the optional argument @var{type} is supplied, check only for symbols of the |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
437 specified type. Valid types are |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
438 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
439 @table @asis |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
440 @item @qcode{"var"} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
441 Check only for variables. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
442 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
443 @item @qcode{"builtin"} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
444 Check only for built-in functions. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
445 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
446 @item @qcode{"dir"} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
447 Check only for directories. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
448 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
449 @item @qcode{"file"} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
450 Check only for files and directories. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
451 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
452 @item @qcode{"class"} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
453 Check only for classes. (Note: This option is accepted, but not currently |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
454 implemented) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
455 @end table |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
456 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
457 If no type is given, and there are multiple possible matches for name, |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
458 @code{exist} will return a code according to the following priority list: |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
459 variable, built-in function, oct-file, directory, file, class. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
460 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
461 @code{exist} returns 2 if a regular file called @var{name} is present in |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
462 Octave's search path. For information about other types of files not on the |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
463 search path use some combination of the functions @code{file_in_path} and |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
464 @code{stat} instead. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
465 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
466 Programming Note: If @var{name} is implemented by a buggy .oct/.mex file, |
24485
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
467 calling @var{exist} may cause Octave to crash. To maintain high performance, |
ad04b8055d91
doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents:
24449
diff
changeset
|
468 Octave trusts .oct/.mex files instead of @nospell{sandboxing} them. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
469 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
470 @seealso{file_in_loadpath, file_in_path, dir_in_loadpath, stat} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
471 @end deftypefn */) |
4016 | 472 { |
473 int nargin = args.length (); | |
474 | |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
475 if (nargin < 1 || nargin > 2) |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
476 print_usage (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
477 |
29356
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
478 // For compatibility with undocumented Matlab behavior, return 0 if |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
479 // there is an empty built-in object as the only argument. |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
480 |
29376
107091f22e65
Return 0 if first argument to exist() is empty regardless of nargin value (bug #59950).
Rik <rik@octave.org>
parents:
29359
diff
changeset
|
481 if (args(0).builtin_type () != btyp_unknown && args(0).isempty ()) |
29356
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
482 return ovl (0); |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
483 |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
484 // Also for compatibility, return 0 if the second argument is an empty |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
485 // built-in object. |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
486 |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
487 if (nargin == 2 && args(1).builtin_type () != btyp_unknown |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
488 && args(1).isempty ()) |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
489 return ovl (0); |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
490 |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
491 std::string name = args(0).xstring_value ("exist: NAME must be a string"); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
492 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
493 if (nargin == 2) |
4016 | 494 { |
29356
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
495 std::string type |
65c57984a65e
compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents:
29033
diff
changeset
|
496 = args(1).xstring_value ("exist: TYPE must be a string"); |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
497 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
498 if (type == "class") |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
499 warning (R"(exist: "class" type argument is not implemented)"); |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
500 |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
501 return ovl (symbol_exist (interp, name, type)); |
4016 | 502 } |
503 else | |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
504 return ovl (symbol_exist (interp, name)); |
4016 | 505 } |
506 | |
10975
2d14817353a6
allow exist to work correctly for special files; recognize directories when searching for files
John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
507 /* |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
508 %!shared dirtmp, __var1 |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
509 %! dirtmp = P_tmpdir (); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
510 %! __var1 = 1; |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
511 |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
512 %!assert (exist ("__%Highly_unlikely_name%__"), 0) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
513 %!assert (exist ("__var1"), 1) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
514 %!assert (exist ("__var1", "var"), 1) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
515 %!assert (exist ("__var1", "builtin"), 0) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
516 %!assert (exist ("__var1", "dir"), 0) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
517 %!assert (exist ("__var1", "file"), 0) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
518 |
10975
2d14817353a6
allow exist to work correctly for special files; recognize directories when searching for files
John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
519 %!test |
14429
eff4a5933e28
Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
520 %! if (isunix ()) |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
521 %! assert (exist ("/bin/sh"), 2); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
522 %! assert (exist ("/bin/sh", "file"), 2); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
523 %! assert (exist ("/bin/sh", "dir"), 0); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
524 %! assert (exist ("/dev/null"), 2); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
525 %! assert (exist ("/dev/null", "file"), 2); |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
526 %! assert (exist ("/dev/null", "dir"), 0); |
14429
eff4a5933e28
Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14366
diff
changeset
|
527 %! endif |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
528 |
19750
2111917d34c4
fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents:
19743
diff
changeset
|
529 %!assert (exist ("print_usage"), 2) |
2111917d34c4
fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents:
19743
diff
changeset
|
530 %!assert (exist ("print_usage.m"), 2) |
2111917d34c4
fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents:
19743
diff
changeset
|
531 %!assert (exist ("print_usage", "file"), 2) |
2111917d34c4
fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents:
19743
diff
changeset
|
532 %!assert (exist ("print_usage", "dir"), 0) |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
533 |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
534 ## Don't search path for rooted relative filenames |
21317
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
535 %!assert (exist ("plot.m", "file"), 2) |
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
536 %!assert (exist ("./plot.m", "file"), 0) |
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
537 %!assert (exist ("./%nonexistentfile%", "file"), 0) |
a4faec57f4c8
maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
538 %!assert (exist ("%nonexistentfile%", "file"), 0) |
20181
aa36fb998a4d
maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents:
20178
diff
changeset
|
539 |
20713
2469d78a1d8b
Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents:
20711
diff
changeset
|
540 ## Don't search path for absolute filenames |
19915
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
541 %!test |
26677
33f79d94f21f
Create any BIST temporary files in writable temporary directory (bug #55565).
Rik <rik@octave.org>
parents:
26661
diff
changeset
|
542 %! tname = tempname (); |
19915
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
543 %! unwind_protect |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
544 %! ## open/close file to create it, equivalent of touch |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
545 %! fid = fopen (tname, "w"); |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
546 %! fclose (fid); |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
547 %! [~, fname] = fileparts (tname); |
26679
2b6aa96a5c82
create BIST temporary files in tempdir instead of P_tmpdir (bug #55565)
Mike Miller <mtmiller@octave.org>
parents:
26677
diff
changeset
|
548 %! assert (exist (fullfile (tempdir (), fname), "file"), 2); |
19915
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
549 %! unwind_protect_cleanup |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
550 %! unlink (tname); |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
551 %! end_unwind_protect |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
552 %! assert (exist (fullfile (pwd (), "%nonexistentfile%"), "file"), 0); |
85c5a81c6ddd
Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents:
19864
diff
changeset
|
553 |
28907
11f1207111c5
maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents:
28888
diff
changeset
|
554 %!assert (exist ("fftw"), 3) |
11f1207111c5
maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents:
28888
diff
changeset
|
555 %!assert (exist ("fftw.oct"), 3) |
11f1207111c5
maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents:
28888
diff
changeset
|
556 %!assert (exist ("fftw", "file"), 3) |
11f1207111c5
maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents:
28888
diff
changeset
|
557 %!assert (exist ("fftw", "builtin"), 0) |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
558 |
29032
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
559 %!assert (exist ("ftp"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
560 %!assert (exist ("ftp.m"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
561 %!assert (exist ("@ftp/ftp"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
562 %!assert (exist ("@ftp/ftp.m"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
563 |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
564 %!assert (exist ("inputParser"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
565 %!assert (exist ("inputParser.m"), 2); |
2cbfd91aafb9
improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents:
28504
diff
changeset
|
566 |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
567 %!assert (exist ("sin"), 5) |
18861
da6ffbf75edf
Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents:
18858
diff
changeset
|
568 %!assert (exist ("sin", "builtin"), 5) |
da6ffbf75edf
Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents:
18858
diff
changeset
|
569 %!assert (exist ("sin", "file"), 0) |
18856
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
570 |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
571 %!assert (exist (dirtmp), 7) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
572 %!assert (exist (dirtmp, "dir"), 7) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
573 %!assert (exist (dirtmp, "file"), 7) |
de8c67ba7ac4
Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents:
18282
diff
changeset
|
574 |
18880
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
575 %!error exist () |
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
576 %!error exist (1,2,3) |
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
577 %!warning <"class" type argument is not implemented> exist ("a", "class"); |
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
578 %!error <TYPE must be a string> exist ("a", 1) |
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
579 %!error <NAME must be a string> exist (1) |
20206
3c8260fd0837
Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents:
20181
diff
changeset
|
580 %!error <unrecognized type argument "foobar"> exist ("a", "foobar") |
18880
ca0d9844dfd7
Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents:
18879
diff
changeset
|
581 |
10975
2d14817353a6
allow exist to work correctly for special files; recognize directories when searching for files
John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
582 */ |
2d14817353a6
allow exist to work correctly for special files; recognize directories when searching for files
John W. Eaton <jwe@octave.org>
parents:
10846
diff
changeset
|
583 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
584 OCTAVE_NAMESPACE_END |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
585 |
593 | 586 // Variable values. |
195 | 587 |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
588 static bool |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
589 wants_local_change (const octave_value_list& args, int& nargin) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
590 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
591 bool retval = false; |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
592 |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
593 if (nargin == 2) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
594 { |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
595 if (! args(1).is_string () || args(1).string_value () != "local") |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
596 error_with_cfn (R"(second argument must be "local")"); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
597 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
598 nargin = 1; |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
599 retval = true; |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
600 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
601 |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
602 return retval; |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
603 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
604 |
23704
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
605 static octave::unwind_protect * |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
606 curr_fcn_unwind_protect_frame (void) |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
607 { |
27204
9a3e92d02a03
eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents:
27160
diff
changeset
|
608 octave::tree_evaluator& tw |
9a3e92d02a03
eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents:
27160
diff
changeset
|
609 = octave::__get_evaluator__ ("curr_fcn_unwind_protect_frame"); |
23553
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
610 |
27204
9a3e92d02a03
eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents:
27160
diff
changeset
|
611 return tw.curr_fcn_unwind_protect_frame (); |
23704
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
612 } |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
613 |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
614 template <typename T> |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
615 static bool |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
616 try_local_protect (T& var) |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
617 { |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
618 octave::unwind_protect *frame = curr_fcn_unwind_protect_frame (); |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
619 |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
620 if (frame) |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
621 { |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
622 frame->protect_var (var); |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
623 return true; |
c495549e9a94
refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents:
23703
diff
changeset
|
624 } |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
625 else |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
626 return false; |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
627 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
628 |
5791 | 629 octave_value |
630 set_internal_variable (bool& var, const octave_value_list& args, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
631 int nargout, const char *nm) |
5791 | 632 { |
5794 | 633 octave_value retval; |
634 | |
5800 | 635 int nargin = args.length (); |
636 | |
637 if (nargout > 0 || nargin == 0) | |
5794 | 638 retval = var; |
5791 | 639 |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
640 if (wants_local_change (args, nargin)) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
641 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
642 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
643 warning (R"("local" has no effect outside a function)"); |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
644 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
645 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
646 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
647 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
648 |
5791 | 649 if (nargin == 1) |
650 { | |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
651 bool bval = args(0).xbool_value ("%s: argument must be a logical value", nm); |
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
652 |
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
653 var = bval; |
5791 | 654 } |
655 | |
656 return retval; | |
657 } | |
658 | |
659 octave_value | |
5794 | 660 set_internal_variable (char& var, const octave_value_list& args, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
661 int nargout, const char *nm) |
5791 | 662 { |
5794 | 663 octave_value retval; |
664 | |
5800 | 665 int nargin = args.length (); |
666 | |
667 if (nargout > 0 || nargin == 0) | |
5794 | 668 retval = var; |
5791 | 669 |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
670 if (wants_local_change (args, nargin)) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
671 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
672 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
673 warning (R"("local" has no effect outside a function)"); |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
674 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
675 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
676 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
677 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
678 |
5791 | 679 if (nargin == 1) |
680 { | |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20581
diff
changeset
|
681 std::string sval = args(0).xstring_value ("%s: argument must be a single character", nm); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
682 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
683 switch (sval.length ()) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
684 { |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
685 case 1: |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
686 var = sval[0]; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
687 break; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
688 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
689 case 0: |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
690 var = '\0'; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
691 break; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
692 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
693 default: |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
694 error ("%s: argument must be a single character", nm); |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
695 break; |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
696 } |
5794 | 697 } |
698 | |
699 return retval; | |
700 } | |
701 | |
702 octave_value | |
703 set_internal_variable (int& var, const octave_value_list& args, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
704 int nargout, const char *nm, |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
705 int minval, int maxval) |
5794 | 706 { |
707 octave_value retval; | |
708 | |
5800 | 709 int nargin = args.length (); |
710 | |
711 if (nargout > 0 || nargin == 0) | |
5794 | 712 retval = var; |
713 | |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
714 if (wants_local_change (args, nargin)) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
715 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
716 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
717 warning (R"("local" has no effect outside a function)"); |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
718 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
719 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
720 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
721 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
722 |
5794 | 723 if (nargin == 1) |
724 { | |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
725 int ival = args(0).xint_value ("%s: argument must be an integer value", nm); |
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
726 |
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
727 if (ival < minval) |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
728 error ("%s: arg must be greater than %d", nm, minval); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
729 if (ival > maxval) |
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
21017
diff
changeset
|
730 error ("%s: arg must be less than or equal to %d", nm, maxval); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
731 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
732 var = ival; |
5794 | 733 } |
734 | |
735 return retval; | |
736 } | |
737 | |
738 octave_value | |
739 set_internal_variable (double& var, const octave_value_list& args, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
740 int nargout, const char *nm, |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
741 double minval, double maxval) |
5794 | 742 { |
743 octave_value retval; | |
744 | |
5800 | 745 int nargin = args.length (); |
746 | |
747 if (nargout > 0 || nargin == 0) | |
5794 | 748 retval = var; |
749 | |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
750 if (wants_local_change (args, nargin)) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
751 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
752 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
753 warning (R"("local" has no effect outside a function)"); |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
754 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
755 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
756 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
757 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
758 |
5794 | 759 if (nargin == 1) |
760 { | |
20711
7b608fadc663
Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents:
20704
diff
changeset
|
761 double dval = args(0).xscalar_value ("%s: argument must be a scalar value", nm); |
20704
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
762 |
571508c1ed06
eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20700
diff
changeset
|
763 if (dval < minval) |
26107
05dfcb24ef12
Supply missing arguments to variable length *printf functions (bug #55046).
Rik <rik@octave.org>
parents:
26089
diff
changeset
|
764 error ("%s: argument must be greater than %g", nm, minval); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
765 if (dval > maxval) |
26107
05dfcb24ef12
Supply missing arguments to variable length *printf functions (bug #55046).
Rik <rik@octave.org>
parents:
26089
diff
changeset
|
766 error ("%s: argument must be less than or equal to %g", nm, maxval); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
767 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
768 var = dval; |
5794 | 769 } |
770 | |
771 return retval; | |
772 } | |
773 | |
774 octave_value | |
775 set_internal_variable (std::string& var, const octave_value_list& args, | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
776 int nargout, const char *nm, bool empty_ok) |
5794 | 777 { |
778 octave_value retval; | |
779 | |
5800 | 780 int nargin = args.length (); |
781 | |
782 if (nargout > 0 || nargin == 0) | |
5794 | 783 retval = var; |
784 | |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
785 if (wants_local_change (args, nargin)) |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
786 { |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
787 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
788 warning (R"("local" has no effect outside a function)"); |
10637
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
789 } |
9cd5aa83fa62
implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10521
diff
changeset
|
790 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
791 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
792 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
793 |
5794 | 794 if (nargin == 1) |
795 { | |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20581
diff
changeset
|
796 std::string sval = args(0).xstring_value ("%s: first argument must be a string", nm); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
797 |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
798 if (! empty_ok && sval.empty ()) |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
799 error ("%s: value must not be empty", nm); |
21224
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
800 |
2e64b5899d1f
maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents:
21200
diff
changeset
|
801 var = sval; |
5791 | 802 } |
1 | 803 |
804 return retval; | |
805 } | |
806 | |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
807 octave_value |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
808 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
|
809 int nargout, const char *nm, const char **choices) |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
810 { |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
811 octave_value retval; |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
812 int nchoices = 0; |
23795
980f39c3ab90
Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents:
23704
diff
changeset
|
813 while (choices[nchoices] != nullptr) |
10640
5c594472f75e
determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents:
10638
diff
changeset
|
814 nchoices++; |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
815 |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
816 int nargin = args.length (); |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
817 |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
818 assert (var < nchoices); |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
819 |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
820 if (nargout > 0 || nargin == 0) |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
821 retval = choices[var]; |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
822 |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
823 if (wants_local_change (args, nargin)) |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
824 { |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
825 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
826 warning (R"("local" has no effect outside a function)"); |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
827 } |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
828 |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
829 if (nargin > 1) |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
830 print_usage (); |
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
831 |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
832 if (nargin == 1) |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
833 { |
20700
68e3a747ca02
rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents:
20581
diff
changeset
|
834 std::string sval = args(0).xstring_value ("%s: first argument must be a string", nm); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
835 |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
836 int i = 0; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
837 for (; i < nchoices; i++) |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
838 { |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
839 if (sval == choices[i]) |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
840 { |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
841 var = i; |
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
842 break; |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
843 } |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
844 } |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
845 if (i == nchoices) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
846 error (R"(%s: value not allowed ("%s"))", nm, sval.c_str ()); |
10638
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
847 } |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
848 |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
849 return retval; |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
850 } |
e1559a8a60b4
general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents:
10637
diff
changeset
|
851 |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
852 octave_value |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
853 set_internal_variable (std::string& var, const octave_value_list& args, |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
854 int nargout, const char *nm, const char **choices) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
855 { |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
856 octave_value retval; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
857 int nchoices = 0; |
23795
980f39c3ab90
Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents:
23704
diff
changeset
|
858 while (choices[nchoices] != nullptr) |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
859 nchoices++; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
860 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
861 int nargin = args.length (); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
862 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
863 if (nargout > 0 || nargin == 0) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
864 retval = var; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
865 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
866 if (wants_local_change (args, nargin)) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
867 { |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
868 if (! try_local_protect (var)) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
869 warning (R"("local" has no effect outside a function)"); |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
870 } |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
871 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
872 if (nargin > 1) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
873 print_usage (); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
874 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
875 if (nargin == 1) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
876 { |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
877 std::string sval = args(0).xstring_value ("%s: first argument must be a string", nm); |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
878 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
879 int i = 0; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
880 for (; i < nchoices; i++) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
881 { |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
882 if (sval == choices[i]) |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
883 { |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
884 var = sval; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
885 break; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
886 } |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
887 } |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
888 if (i == nchoices) |
23803
90689bdbe048
Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents:
23795
diff
changeset
|
889 error (R"(%s: value not allowed ("%s"))", nm, sval.c_str ()); |
21272
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
890 } |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
891 |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
892 return retval; |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
893 } |
987c1a79d33f
new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents:
21224
diff
changeset
|
894 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
895 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
896 |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
897 // NOTE: Calling Fmlock directly (without an associated stack frame) |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
898 // will probably not do what you expect because it will lock the calling |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
899 // function. You should use interpreter::mlock directly if you want to |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
900 // lock a .oct function. For .mex, you would normally use mexLock. |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
901 // |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
902 // FIXME: with the current implementation, calling "builtin ('mlock')" |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
903 // will also not do what you expect. Is there any reasonable way to fix |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
904 // that? |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
905 |
23553
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
906 DEFMETHOD (mlock, interp, args, , |
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
907 doc: /* -*- texinfo -*- |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
908 @deftypefn {} {} mlock () |
26168
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
909 Lock the current function into memory so that it can't be removed with |
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
910 @code{clear}. |
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
911 @seealso{munlock, mislocked, persistent, clear} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
912 @end deftypefn */) |
4319 | 913 { |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
914 if (args.length () != 0) |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
915 print_usage (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
916 |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
917 interp.mlock (true); |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20925
diff
changeset
|
918 |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
919 return ovl (); |
4319 | 920 } |
921 | |
23553
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
922 DEFMETHOD (munlock, interp, args, , |
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
923 doc: /* -*- texinfo -*- |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
924 @deftypefn {} {} munlock () |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
925 @deftypefnx {} {} munlock (@var{fcn}) |
26168
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
926 Unlock the named function @var{fcn} so that it may be removed from memory with |
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
927 @code{clear}. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
928 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
929 If no function is named then unlock the current function. |
26168
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
930 @seealso{mlock, mislocked, persistent, clear} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
931 @end deftypefn */) |
4319 | 932 { |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
933 int nargin = args.length (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
934 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
935 if (nargin > 1) |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
936 print_usage (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
937 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
938 if (nargin == 1) |
4319 | 939 { |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
940 std::string name |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
941 = args(0).xstring_value ("munlock: FCN must be a string"); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
942 |
23703
6eb5f6199a5a
move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents:
23702
diff
changeset
|
943 interp.munlock (name); |
4319 | 944 } |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
945 else |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
946 interp.munlock (true); |
4319 | 947 |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
948 return ovl (); |
4319 | 949 } |
950 | |
23553
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
951 DEFMETHOD (mislocked, interp, args, , |
14723784b9f2
don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents:
23466
diff
changeset
|
952 doc: /* -*- texinfo -*- |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
953 @deftypefn {} {} mislocked () |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
954 @deftypefnx {} {} mislocked (@var{fcn}) |
26168
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
955 Return true if the named function @var{fcn} is locked in memory. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
956 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
957 If no function is named then return true if the current function is locked. |
26168
0a3561379dbe
Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents:
26167
diff
changeset
|
958 @seealso{mlock, munlock, persistent, clear} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
959 @end deftypefn */) |
4319 | 960 { |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
961 int nargin = args.length (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
962 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
963 if (nargin > 1) |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
964 print_usage (); |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
965 |
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
966 if (nargin == 1) |
4319 | 967 { |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
968 std::string name |
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
969 = args(0).xstring_value ("mislocked: FCN must be a string"); |
20581
fd0efcdb3718
use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents:
20556
diff
changeset
|
970 |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
971 return ovl (interp.mislocked (name)); |
4319 | 972 } |
20799
c349d4c91ce2
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20769
diff
changeset
|
973 else |
27873
020d0e8f7ac6
reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents:
27479
diff
changeset
|
974 return ovl (interp.mislocked (true)); |
4319 | 975 } |
976 | |
593 | 977 // Deleting names from the symbol tables. |
978 | |
3681 | 979 static inline bool |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11558
diff
changeset
|
980 name_matches_any_pattern (const std::string& nm, const string_vector& argv, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
981 int argc, int idx, bool have_regexp = false) |
3681 | 982 { |
983 bool retval = false; | |
984 | |
985 for (int k = idx; k < argc; k++) | |
986 { | |
987 std::string patstr = argv[k]; | |
988 if (! patstr.empty ()) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
989 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
990 if (have_regexp) |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
991 { |
22333
2758af148ced
move base_list and regexp classes to octave namespace
John W. Eaton <jwe@octave.org>
parents:
22327
diff
changeset
|
992 if (octave::regexp::is_match (patstr, nm)) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
993 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
994 retval = true; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
995 break; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
996 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
997 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
998 else |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
999 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1000 glob_match pattern (patstr); |
7779
791231dac333
Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents:
7761
diff
changeset
|
1001 |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1002 if (pattern.match (nm)) |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1003 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1004 retval = true; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1005 break; |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1006 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1007 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1008 } |
3681 | 1009 } |
1010 | |
1011 return retval; | |
1012 } | |
1013 | |
4009 | 1014 static inline void |
1015 maybe_warn_exclusive (bool exclusive) | |
1016 { | |
1017 if (exclusive) | |
1018 warning ("clear: ignoring --exclusive option"); | |
1019 } | |
1020 | |
7336 | 1021 static void |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1022 do_clear_functions (octave::interpreter& interp, |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
1023 const string_vector& argv, int argc, int idx, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1024 bool exclusive = false) |
4009 | 1025 { |
1026 if (idx == argc) | |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1027 interp.clear_functions (); |
4009 | 1028 else |
1029 { | |
1030 if (exclusive) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1031 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1032 std::list<std::string> fcns = interp.user_function_names (); |
4009 | 1033 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1034 for (const auto& name : fcns) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1035 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1036 if (! name_matches_any_pattern (name, argv, argc, idx)) |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1037 interp.clear_function (name); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1038 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1039 } |
4009 | 1040 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1041 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1042 while (idx < argc) |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1043 interp.clear_function_pattern (argv[idx++]); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1044 } |
4009 | 1045 } |
1046 } | |
1047 | |
7336 | 1048 static void |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1049 do_clear_globals (octave::interpreter& interp, |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
1050 const string_vector& argv, int argc, int idx, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1051 bool exclusive = false) |
4009 | 1052 { |
1053 if (idx == argc) | |
7752
40c428ea3408
initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents:
7626
diff
changeset
|
1054 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1055 std::list<std::string> gvars = interp.global_variable_names (); |
7752
40c428ea3408
initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents:
7626
diff
changeset
|
1056 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1057 for (const auto& name : gvars) |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1058 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1059 interp.clear_variable (name); |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1060 interp.clear_global_variable (name); |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1061 } |
7752
40c428ea3408
initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents:
7626
diff
changeset
|
1062 } |
4009 | 1063 else |
1064 { | |
1065 if (exclusive) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1066 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1067 std::list<std::string> gvars = interp.global_variable_names (); |
4009 | 1068 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1069 for (const auto& name : gvars) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1070 { |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1071 if (! name_matches_any_pattern (name, argv, argc, idx)) |
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1072 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1073 interp.clear_variable (name); |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1074 interp.clear_global_variable (name); |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1075 } |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1076 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1077 } |
4009 | 1078 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1079 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1080 while (idx < argc) |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1081 { |
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1082 std::string pattern = argv[idx++]; |
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1083 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1084 interp.clear_variable_pattern (pattern); |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1085 interp.clear_global_variable_pattern (pattern); |
24352
bff8e3884a88
restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents:
24270
diff
changeset
|
1086 } |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1087 } |
4009 | 1088 } |
1089 } | |
1090 | |
7336 | 1091 static void |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1092 do_clear_variables (octave::interpreter& interp, |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
1093 const string_vector& argv, int argc, int idx, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1094 bool exclusive = false, bool have_regexp = false) |
4009 | 1095 { |
1096 if (idx == argc) | |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1097 interp.clear_variables (); |
4009 | 1098 else |
1099 { | |
1100 if (exclusive) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1101 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1102 std::list<std::string> lvars = interp.variable_names (); |
4009 | 1103 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1104 for (const auto& name : lvars) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1105 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1106 if (! name_matches_any_pattern (name, argv, argc, idx, |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1107 have_regexp)) |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1108 interp.clear_variable (name); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1109 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1110 } |
4009 | 1111 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1112 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1113 if (have_regexp) |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1114 while (idx < argc) |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1115 interp.clear_variable_regexp (argv[idx++]); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1116 else |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1117 while (idx < argc) |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1118 interp.clear_variable_pattern (argv[idx++]); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1119 } |
4009 | 1120 } |
1121 } | |
1122 | |
7336 | 1123 static void |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1124 do_clear_symbols (octave::interpreter& interp, |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
1125 const string_vector& argv, int argc, int idx, |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1126 bool exclusive = false) |
4009 | 1127 { |
1128 if (idx == argc) | |
23611
91c8f006ed8b
remove additional functions from symbol_table class
John W. Eaton <jwe@octave.org>
parents:
23604
diff
changeset
|
1129 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1130 interp.clear_variables (); |
23611
91c8f006ed8b
remove additional functions from symbol_table class
John W. Eaton <jwe@octave.org>
parents:
23604
diff
changeset
|
1131 } |
4009 | 1132 else |
1133 { | |
1134 if (exclusive) | |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1135 { |
17787
175b392e91fe
Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents:
17756
diff
changeset
|
1136 // FIXME: is this really what we want, or do we |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1137 // somehow want to only clear the functions that are not |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1138 // shadowed by local variables? It seems that would be a |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1139 // bit harder to do. |
4009 | 1140 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1141 do_clear_variables (interp, argv, argc, idx, exclusive); |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1142 do_clear_functions (interp, argv, argc, idx, exclusive); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1143 } |
4009 | 1144 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1145 { |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1146 while (idx < argc) |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1147 interp.clear_symbol_pattern (argv[idx++]); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1148 } |
4009 | 1149 } |
1150 } | |
1151 | |
1152 static void | |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1153 do_matlab_compatible_clear (octave::interpreter& interp, |
23701
a6e49930ddd2
avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents:
23699
diff
changeset
|
1154 const string_vector& argv, int argc, int idx) |
4009 | 1155 { |
1156 // This is supposed to be mostly Matlab compatible. | |
1157 | |
1158 for (; idx < argc; idx++) | |
1159 { | |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1160 if (argv[idx] == "all" && ! interp.is_local_variable ("all")) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1161 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1162 interp.clear_all (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1163 } |
7336 | 1164 else if (argv[idx] == "functions" |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1165 && ! interp.is_local_variable ("functions")) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1166 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1167 do_clear_functions (interp, argv, argc, ++idx); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1168 } |
7336 | 1169 else if (argv[idx] == "global" |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1170 && ! interp.is_local_variable ("global")) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1171 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1172 do_clear_globals (interp, argv, argc, ++idx); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1173 } |
7336 | 1174 else if (argv[idx] == "variables" |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1175 && ! interp.is_local_variable ("variables")) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1176 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1177 interp.clear_variables (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1178 } |
9240
f27a8c07f0b2
clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents:
9180
diff
changeset
|
1179 else if (argv[idx] == "classes" |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1180 && ! interp.is_local_variable ("classes")) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1181 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1182 interp.clear_objects (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1183 octave_class::clear_exemplar_map (); |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1184 interp.clear_all (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1185 } |
4009 | 1186 else |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1187 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1188 interp.clear_symbol_pattern (argv[idx]); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1189 } |
4009 | 1190 } |
1191 } | |
1192 | |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1193 DEFMETHOD (clear, interp, args, , |
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1194 doc: /* -*- texinfo -*- |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1195 @deftypefn {} {} clear |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1196 @deftypefnx {} {} clear @var{pattern} @dots{} |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1197 @deftypefnx {} {} clear @var{options} @var{pattern} @dots{} |
28504
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1198 Delete the names matching the given @var{pattern}s thereby freeing memory. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1199 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1200 The @var{pattern} may contain the following special characters: |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1201 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1202 @table @code |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1203 @item ? |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1204 Match any single character. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1205 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1206 @item * |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1207 Match zero or more characters. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1208 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1209 @item [ @var{list} ] |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1210 Match the list of characters specified by @var{list}. If the first character |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1211 is @code{!} or @code{^}, match all characters except those specified by |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1212 @var{list}. For example, the pattern @code{[a-zA-Z]} will match all lowercase |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1213 and uppercase alphabetic characters. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1214 @end table |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1215 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1216 For example, the command |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1217 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1218 @example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1219 clear foo b*r |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1220 @end example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1221 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1222 @noindent |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1223 clears the name @code{foo} and all names that begin with the letter @samp{b} |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1224 and end with the letter @samp{r}. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1225 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1226 If @code{clear} is called without any arguments, all user-defined variables |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1227 are cleared from the current workspace (i.e., local variables). Any global |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1228 variables present will no longer be visible in the current workspace, but they |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1229 will continue to exist in the global workspace. Functions are unaffected by |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1230 this form of @code{clear}. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1231 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1232 The following options are available in both long and short form |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1233 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1234 @table @code |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1235 @item all, -all, -a |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1236 Clear all local and global user-defined variables, and all functions from the |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1237 symbol table. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1238 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1239 @item -exclusive, -x |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1240 Clear variables that do @strong{not} match the following pattern. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1241 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1242 @item functions, -functions, -f |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1243 Clear function names from the function symbol table. Persistent variables |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1244 will be re-initialized to their default value unless the function has been |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1245 locked in memory with @code{mlock}. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1246 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1247 @item global, -global, -g |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1248 Clear global variable names. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1249 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1250 @item variables, -variables, -v |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1251 Clear local variable names. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1252 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1253 @item classes, -classes, -c |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1254 Clear the class structure table and all objects. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1255 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1256 @item -regexp, -r |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1257 The @var{pattern} arguments are treated as regular expressions and any matches |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1258 will be cleared. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1259 @end table |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1260 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1261 With the exception of @option{-exclusive} and @option{-regexp}, all long |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1262 options can be used without the dash as well. Note that, aside from |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1263 @option{-exclusive}, only one other option may appear. All options must |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1264 appear before any patterns. |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1265 |
28504
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1266 Programming Notes: The command @code{clear @var{name}} only clears the variable |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1267 @var{name} when both a variable and a (shadowed) function named @var{name} |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1268 are currently defined. For example, suppose you have defined a function |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1269 @code{foo}, and then hidden it by performing the assignment @code{foo = 2}. |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1270 Executing the command @code{clear foo} once will clear the variable |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1271 definition and restore the definition of @code{foo} as a function. |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1272 Executing @code{clear foo} a second time will clear the function definition. |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1273 |
28504
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1274 When a local variable name, which is linked to a global variable, is cleared |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1275 only the local copy of the variable is removed. The global copy is untouched |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1276 and can be restored with @code{global @var{global_varname}}. Conversely, |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1277 @code{clear -g @var{global_varname}} will remove both the local and global |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1278 variables. |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1279 |
d747d57989e2
doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents:
28024
diff
changeset
|
1280 @seealso{clearvars, who, whos, exist, mlock} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1281 @end deftypefn */) |
529 | 1282 { |
1755 | 1283 int argc = args.length () + 1; |
593 | 1284 |
1968 | 1285 string_vector argv = args.make_argv ("clear"); |
1755 | 1286 |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1287 if (argc == 1) |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1288 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1289 do_clear_variables (interp, argv, argc, true); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1290 |
27263
99aa1bcb8848
rename octave_link and octave_link_events classes, move inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27261
diff
changeset
|
1291 octave::event_manager& evmgr = interp.get_event_manager (); |
27261
dccdc3b001a2
eliminate static functions from octave_link class
John W. Eaton <jwe@octave.org>
parents:
27204
diff
changeset
|
1292 |
27263
99aa1bcb8848
rename octave_link and octave_link_events classes, move inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
27261
diff
changeset
|
1293 evmgr.clear_workspace (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1294 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1295 else |
529 | 1296 { |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1297 int idx = 0; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1298 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1299 bool clear_all = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1300 bool clear_functions = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1301 bool clear_globals = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1302 bool clear_variables = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1303 bool clear_objects = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1304 bool exclusive = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1305 bool have_regexp = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1306 bool have_dash_option = false; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1307 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1308 while (++idx < argc) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1309 { |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1310 if (argv[idx] == "-all" || argv[idx] == "-a") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1311 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1312 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1313 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1314 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1315 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1316 clear_all = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1317 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1318 else if (argv[idx] == "-exclusive" || argv[idx] == "-x") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1319 { |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1320 exclusive = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1321 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1322 else if (argv[idx] == "-functions" || argv[idx] == "-f") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1323 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1324 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1325 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1326 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1327 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1328 clear_functions = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1329 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1330 else if (argv[idx] == "-global" || argv[idx] == "-g") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1331 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1332 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1333 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1334 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1335 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1336 clear_globals = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1337 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1338 else if (argv[idx] == "-variables" || argv[idx] == "-v") |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1339 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1340 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1341 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1342 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1343 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1344 clear_variables = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1345 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1346 else if (argv[idx] == "-classes" || argv[idx] == "-c") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1347 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1348 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1349 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1350 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1351 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1352 clear_objects = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1353 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1354 else if (argv[idx] == "-regexp" || argv[idx] == "-r") |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1355 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1356 if (have_dash_option) |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1357 print_usage (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1358 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1359 have_dash_option = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1360 have_regexp = true; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1361 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1362 else |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1363 break; |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1364 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1365 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1366 if (idx <= argc) |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1367 { |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1368 if (! have_dash_option && ! exclusive) |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1369 do_matlab_compatible_clear (interp, argv, argc, idx); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1370 else |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1371 { |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1372 if (clear_all) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1373 { |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1374 maybe_warn_exclusive (exclusive); |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1375 |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1376 if (++idx < argc) |
20897
9aad16a799c9
maint: Replace argc variable name with nargin in C++ code.
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
1377 warning ("clear: ignoring extra arguments after -all"); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1378 |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1379 interp.clear_all (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1380 } |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1381 else if (have_regexp) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1382 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1383 do_clear_variables (interp, argv, argc, idx, exclusive, true); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1384 } |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1385 else if (clear_functions) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1386 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1387 do_clear_functions (interp, argv, argc, idx, exclusive); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1388 } |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1389 else if (clear_globals) |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1390 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1391 do_clear_globals (interp, argv, argc, idx, exclusive); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1392 } |
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1393 else if (clear_variables) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1394 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1395 do_clear_variables (interp, argv, argc, idx, exclusive); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1396 } |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1397 else if (clear_objects) |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1398 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1399 interp.clear_objects (); |
20556
4bed806ee3d4
eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20535
diff
changeset
|
1400 octave_class::clear_exemplar_map (); |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1401 interp.clear_all (); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1402 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1403 else |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1404 { |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1405 do_clear_symbols (interp, argv, argc, idx, exclusive); |
10315
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1406 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1407 } |
57a59eae83cc
untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents:
10160
diff
changeset
|
1408 } |
593 | 1409 } |
1410 | |
20941
a4f5da7c5463
maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
1411 return ovl (); |
529 | 1412 } |
1413 | |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1414 /* |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1415 ## This test must be wrapped in its own function or the 'clear' command will |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1416 ## break the %!test environment. |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1417 %!function __test_clear_no_args__ () |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1418 %! global x |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1419 %! x = 3; |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1420 %! clear |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1421 %! assert (! exist ("x", "var")); # x is not in the current workspace anymore |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1422 %! global x # but still lives in the global workspace |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1423 %! assert (exist ("x", "var")); |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1424 %!endfunction |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1425 |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1426 %!test |
26678
2c246d188151
variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents:
26434
diff
changeset
|
1427 %! unwind_protect |
2c246d188151
variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents:
26434
diff
changeset
|
1428 %! __test_clear_no_args__ (); |
2c246d188151
variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents:
26434
diff
changeset
|
1429 %! unwind_protect_cleanup |
2c246d188151
variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents:
26434
diff
changeset
|
1430 %! clear -g x |
2c246d188151
variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents:
26434
diff
changeset
|
1431 %! end_unwind_protect |
26169
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1432 |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1433 ## Test that multiple options cannot be given |
096b38cac97f
Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents:
26168
diff
changeset
|
1434 %!error clear -f -g |
26167
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1435 */ |
247126168d23
Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents:
26113
diff
changeset
|
1436 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1437 OCTAVE_NAMESPACE_END |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1438 |
15562
8ed107220a3e
maint: Rename unimplemented.m to __unimplemented__.m.
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents:
15528
diff
changeset
|
1439 static std::string Vmissing_function_hook = "__unimplemented__"; |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1440 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1441 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1442 |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1443 DEFUN (missing_function_hook, args, nargout, |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1444 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1445 @deftypefn {} {@var{val} =} missing_function_hook () |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1446 @deftypefnx {} {@var{old_val} =} missing_function_hook (@var{new_val}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1447 @deftypefnx {} {} missing_function_hook (@var{new_val}, "local") |
27479
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1448 Query or set the internal variable that specifies the function to call |
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1449 to provide extra information when an unknown identifier is referenced. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1450 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1451 When called from inside a function with the @qcode{"local"} option, the |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1452 variable is changed locally for the function and any subroutines it calls. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1453 The original variable value is restored when exiting the function. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1454 @seealso{missing_component_hook} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1455 @end deftypefn */) |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1456 { |
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1457 return SET_INTERNAL_VARIABLE (missing_function_hook); |
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1458 } |
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1459 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1460 OCTAVE_NAMESPACE_END |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1461 |
27479
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1462 std::string |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1463 maybe_missing_function_hook (const std::string& name) |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1464 { |
27160
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1465 octave::interpreter& interp |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1466 = octave::__get_interpreter__ ("maybe_missing_function_hook"); |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1467 |
10444
537d9fbba9c0
don't call missing_function_hook inside try block
Jaroslav Hajek <highegg@gmail.com>
parents:
10443
diff
changeset
|
1468 // Don't do this if we're handling errors. |
27471 | 1469 if (Vmissing_function_hook.empty ()) |
27479
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1470 return ""; |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1471 |
27160
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1472 octave::symbol_table& symtab = interp.get_symbol_table (); |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1473 |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1474 octave_value val = symtab.find_function (Vmissing_function_hook); |
15528
8d2b3db8b5b0
Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents:
15508
diff
changeset
|
1475 |
27160
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1476 if (val.is_defined ()) |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1477 { |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1478 // Ensure auto-restoration. |
28823
26cfccfee9a0
Replace unwind_protect with more efficient constructs (bug #59192).
Rik <rik@octave.org>
parents:
28749
diff
changeset
|
1479 octave::unwind_protect_var<std::string> |
26cfccfee9a0
Replace unwind_protect with more efficient constructs (bug #59192).
Rik <rik@octave.org>
parents:
28749
diff
changeset
|
1480 restore_var (Vmissing_function_hook); |
15528
8d2b3db8b5b0
Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents:
15508
diff
changeset
|
1481 |
27160
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1482 // Clear the variable prior to calling the function. |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1483 const std::string func_name = Vmissing_function_hook; |
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1484 Vmissing_function_hook.clear (); |
15528
8d2b3db8b5b0
Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents:
15508
diff
changeset
|
1485 |
27160
6b0c61a5a0f0
move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents:
27016
diff
changeset
|
1486 // Call. |
27479
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1487 octave_value_list tmp = octave::feval (func_name, octave_value (name), 1); |
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1488 |
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1489 if (tmp.length () == 1 && tmp(0).is_string ()) |
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1490 return tmp(0).string_value (); |
10467
13c1f15c67fa
guard against recursive calls of missing_function_hook
Jaroslav Hajek <highegg@gmail.com>
parents:
10444
diff
changeset
|
1491 } |
27479
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1492 |
e8c417f6ef83
make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents:
27471
diff
changeset
|
1493 return ""; |
10443
34e51d4e199b
implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents:
10350
diff
changeset
|
1494 } |
11558
1e4dfc7a9487
use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents:
11556
diff
changeset
|
1495 |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1496 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1497 |
23599
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1498 DEFMETHOD (__varval__, interp, args, , |
5cb3a2bb5e1e
don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents:
23587
diff
changeset
|
1499 doc: /* -*- texinfo -*- |
28749
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1500 @deftypefn {} {@var{value} =} __varval__ (@var{name}) |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1501 Return the value of the variable @var{name} directly from the symbol table. |
28749
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1502 |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1503 If @var{name} does not exist then nothing is returned, not even an empty matrix |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1504 (@code{[]}), since there would be no way to distinguish between a variable |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1505 not found in the symbol table and a variable who's value was @code{[]}. |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1506 |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1507 A standard usage pattern is to code a @code{try}/@code{catch} block around a |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1508 call to @code{__varval__}. |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1509 |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1510 Example Code |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1511 |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1512 @example |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1513 @group |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1514 try |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1515 @var{val} = __varval__ (@var{name}); |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1516 catch |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1517 ## No variable @var{name} found in symbol table |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1518 @var{val} = NA; # Substitute Not Available (NA) |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1519 error ("@var{name} not found"); # or, throw an error. |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1520 end_try_catch |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1521 @end group |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1522 @end example |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1523 |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1524 Programming Note: The magic @var{name} @qcode{".argn."} will retrieve the text |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1525 of input arguments to a function and is used by @code{inputname} internally. |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1526 @seealso{inputname} |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1527 @end deftypefn */) |
11558
1e4dfc7a9487
use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents:
11556
diff
changeset
|
1528 { |
20760
15eefcabcb31
doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents:
20756
diff
changeset
|
1529 if (args.length () != 1) |
11558
1e4dfc7a9487
use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents:
11556
diff
changeset
|
1530 print_usage (); |
1e4dfc7a9487
use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents:
11556
diff
changeset
|
1531 |
28749
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1532 std::string name = args(0).xstring_value ("__varval__: NAME must be a string"); |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1533 |
28749
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1534 // We need this kluge to implement inputname in a .m file. |
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1535 if (name == ".argn.") |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1536 { |
27204
9a3e92d02a03
eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents:
27160
diff
changeset
|
1537 octave::tree_evaluator& tw = interp.get_evaluator (); |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1538 |
27204
9a3e92d02a03
eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents:
27160
diff
changeset
|
1539 return tw.get_auto_fcn_var (octave::stack_frame::ARG_NAMES); |
26661
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1540 } |
cf9e10ce3351
move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents:
26446
diff
changeset
|
1541 |
28749
4e10e25f0fc6
inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents:
28505
diff
changeset
|
1542 return interp.varval (name); |
11558
1e4dfc7a9487
use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents:
11556
diff
changeset
|
1543 } |
17516
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1544 |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1545 static std::string Vmissing_component_hook; |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1546 |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1547 DEFUN (missing_component_hook, args, nargout, |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1548 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1549 @deftypefn {} {@var{val} =} missing_component_hook () |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1550 @deftypefnx {} {@var{old_val} =} missing_component_hook (@var{new_val}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1551 @deftypefnx {} {} missing_component_hook (@var{new_val}, "local") |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1552 Query or set the internal variable that specifies the function to call when |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1553 a component of Octave is missing. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1554 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1555 This can be useful for packagers that may split the Octave installation into |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1556 multiple sub-packages, for example, to provide a hint to users for how to |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1557 install the missing components. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1558 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1559 When called from inside a function with the @qcode{"local"} option, the |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1560 variable is changed locally for the function and any subroutines it calls. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1561 The original variable value is restored when exiting the function. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1562 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1563 The hook function is expected to be of the form |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1564 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1565 @example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1566 @var{fcn} (@var{component}) |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1567 @end example |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1568 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1569 Octave will call @var{fcn} with the name of the function that requires the |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1570 component and a string describing the missing component. The hook function |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1571 should return an error message to be displayed. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1572 @seealso{missing_function_hook} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21885
diff
changeset
|
1573 @end deftypefn */) |
17516
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1574 { |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1575 return SET_INTERNAL_VARIABLE (missing_component_hook); |
21656a949661
Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents:
17355
diff
changeset
|
1576 } |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1577 |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29657
diff
changeset
|
1578 OCTAVE_NAMESPACE_END |