Mercurial > octave

annotate libinterp/corefcn/variables.cc @ 33250:40fde86be9b0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
replace calls to error_* with corresponding panic_* functions in libinterp Affected files: __isprimelarge__.cc, cellfun.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, graphics.cc, kron.cc, mex.cc, oct-map.cc, oct-stream.cc, pr-output.cc, schur.cc, variables.cc, and ops.h.
author John W. Eaton <jwe@octave.org>
date Mon, 25 Mar 2024 00:42:04 -0400
parents 2e484f9f1f18
children 737ab816cb7b fb44a9db1bc6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 //
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 32572
diff changeset
3 // Copyright (C) 1993-2024 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
25
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
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
28 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
29
1468
cdb87ef617e8 [project @ 1995-09-22 08:09:53 by jwe]
jwe
parents: 1465
diff changeset
30 #include <cstdio>
1343
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe]
jwe
parents: 1315
diff changeset
31 #include <cstring>
605
4f65175911a6 [project @ 1994-08-13 20:10:39 by jwe]
jwe
parents: 598
diff changeset
32
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
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
fa3482b34599 [project @ 2002-12-03 18:22:05 by jwe]
jwe
parents: 4179
diff changeset
35 #include <set>
1728
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1719
diff changeset
36 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1719
diff changeset
37
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
38 #include "file-stat.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
39 #include "oct-env.h"
4604
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe]
jwe
parents: 4587
diff changeset
40 #include "file-ops.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
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
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
43 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
44
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
45 #include "Cell.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
46 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
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
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
50 #include "help.h"
3165
e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe]
jwe
parents: 3162
diff changeset
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
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
54 #include "lex.h"
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
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
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
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
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
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
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3681
diff changeset
61 #include "ov-usr-fcn.h"
605
4f65175911a6 [project @ 1994-08-13 20:10:39 by jwe]
jwe
parents: 598
diff changeset
62 #include "pager.h"
27016
9b261300a001 move file-scope static autoload map variable and functions to evaluator
John W. Eaton <jwe@octave.org>
parents: 26843
diff changeset
63 #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
64 #include "syminfo.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
65 #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
66 #include "sysdep.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
67 #include "unwind-prot.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
68 #include "utils.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
69 #include "variables.h"
2205
bd389b53befa [project @ 1996-05-15 06:15:45 by jwe]
jwe
parents: 2181
diff changeset
70
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
71 // Attributes of variables and functions.
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
72
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 2076
diff changeset
73 // Is this octave_value a valid function?
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
74
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2963
diff changeset
75 octave_function *
4345
4e23bfdd6172 [project @ 2003-02-20 20:45:49 by jwe]
jwe
parents: 4342
diff changeset
76 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
77 const std::string& warn_for, bool warn)
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
78 {
23457
21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible.
Rik <rik@octave.org>
parents: 23450
diff changeset
79 octave_function *ans = nullptr;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
80
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
81 if (! fcn_name.empty ())
3618
8cea69ad95ae [project @ 2000-03-22 20:51:45 by jwe]
jwe
parents: 3565
diff changeset
82 {
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30896
diff changeset
83 octave::symbol_table& symtab = octave::__get_symbol_table__ ();
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
84
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
85 octave_value val = symtab.find_function (fcn_name);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
86
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
87 if (val.is_defined ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
88 ans = val.function_value (true);
3618
8cea69ad95ae [project @ 2000-03-22 20:51:45 by jwe]
jwe
parents: 3565
diff changeset
89 }
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
90
21224
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
91 // FIXME: Should this be "err" and "error_for", rather than warn?
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
92 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
93 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
94 warn_for.c_str (), fcn_name.c_str ());
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
95
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
96 return ans;
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
97 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
98
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2963
diff changeset
99 octave_function *
4345
4e23bfdd6172 [project @ 2003-02-20 20:45:49 by jwe]
jwe
parents: 4342
diff changeset
100 is_valid_function (const octave_value& arg,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
101 const std::string& warn_for, bool warn)
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
102 {
23457
21baad6b35c4 maint: Use C++11 nullptr rather than 0 or NULL when possible.
Rik <rik@octave.org>
parents: 23450
diff changeset
103 octave_function *ans = nullptr;
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
104
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
105 std::string fcn_name;
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
106
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
107 if (arg.is_string ())
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4604
diff changeset
108 {
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4604
diff changeset
109 fcn_name = arg.string_value ();
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
110
19743
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation.
Rik <rik@octave.org>
parents: 19718
diff changeset
111 ans = is_valid_function (fcn_name, warn_for, warn);
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4604
diff changeset
112 }
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
113 else if (warn)
21224
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
114 // 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
115 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
116 warn_for.c_str ());
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
117
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
118 return ans;
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
119 }
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
120
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 31564
diff changeset
121 OCTAVE_BEGIN_NAMESPACE(octave)
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29657
diff changeset
122
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
123 DEFMETHOD (isglobal, interp, args, ,
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
124 doc: /* -*- texinfo -*-
30559
841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory.
Rik <rik@octave.org>
parents: 30337
diff changeset
125 @deftypefn {} {@var{tf} =} isglobal (@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
126 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
127
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
128 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
129
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
130 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
131 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
132 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
133 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
134 @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
135 @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
136 @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
137 @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
138 @end deftypefn */)
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
139 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
140 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
141 print_usage ();
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
142
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
143 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
144
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
145 return ovl (interp.isglobal (name));
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
146 }
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
147
21389
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
148 /*
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
149 %!test
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
150 %! global x;
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21568
diff changeset
151 %! assert (isglobal ("x"), true);
25762
97ea2329d5d8 Use nested functions to prevent leaking globals in BIST tests.
Rik <rik@octave.org>
parents: 25646
diff changeset
152 %! 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
153
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
154 %!error isglobal ()
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
155 %!error isglobal ("a", "b")
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
156 %!error isglobal (1)
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
157 */
64efef931bd0 Add BIST tests for bitpack, bitunpack, isglobal, and typecast
Mike Miller <mtmiller@octave.org>
parents: 21317
diff changeset
158
23143
898c33f4b9c0 declare some functions that are only used once "static"
John W. Eaton <jwe@octave.org>
parents: 23110
diff changeset
159 static int
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
160 symbol_exist (interpreter& interp, const std::string& name,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
161 const std::string& type = "any")
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
162 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
163 if (iskeyword (name))
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
164 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
165
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
166 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
167 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
168 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
169 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
170 bool search_builtin = type == "builtin";
20206
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
171 bool search_class = type == "class";
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
172
25951
7a507e71d922 style fixes
John W. Eaton <jwe@octave.org>
parents: 25463
diff changeset
173 if (! (search_any || search_var || search_dir || search_file
7a507e71d922 style fixes
John W. Eaton <jwe@octave.org>
parents: 25463
diff changeset
174 || 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
175 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
176
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
177 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
178 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
179 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
180
23587
0c468af9dc00 maint: Deprecate is_object and replace with isobject.
Rik <rik@octave.org>
parents: 23584
diff changeset
181 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
182 || 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
183 || 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
184 || 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
185 return 1;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
186
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
187 if (search_var)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
188 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
189 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
190
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
191 symbol_table& symtab = interp.get_symbol_table ();
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
192
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
193 // 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
194 // 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
195
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
196 if (search_any || search_file || search_dir || search_class)
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
197 {
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
198 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
199
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
200 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
201 std::string ext;
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
202
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
203 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
204
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
205 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
206 {
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
207 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
208
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
209 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
210 {
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
211 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
212 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
213 }
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
214 }
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
215
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
216 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
217
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
218 if (search_any || search_file || search_class)
23438
d24d01273bd0 eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents: 23332
diff changeset
219 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
220 load_path& lp = interp.get_load_path ();
23438
d24d01273bd0 eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents: 23332
diff changeset
221
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
222 // Look for class constructor first
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
223 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
224
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
225 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
226 {
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
227 // Verify extension of file_name found matches ext of name.
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
228 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
229
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
230 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
231 {
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
232 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
233
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
234 if (ext != fext)
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
235 file_name = "";
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
236 }
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
237 }
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
238
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
239 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
240 {
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
241 // 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
242 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
243
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
244 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
245 return 103;
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
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
248 // 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
249 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
250 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
251 tree_evaluator& tw = interp.get_evaluator ();
29032
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 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
254 }
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
255
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
256 // If nothing found, look for function using original name.
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
257 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
258 file_name = lp.find_fcn (name);
23438
d24d01273bd0 eliminate load-path singleton
John W. Eaton <jwe@octave.org>
parents: 23332
diff changeset
259 }
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
260
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
261 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
262
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
263 if (len > 0 && (search_any || search_file || search_class))
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
264 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
265 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
266 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
267 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
268 || 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
269 return 3;
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
270 }
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
271
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
272 if (search_class)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
273 {
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
274 octave_value oval = symtab.find_function (name);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
275 if (oval.is_defined () && oval.is_classdef_meta ())
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
276 return 8;
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
277 else
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
278 return 0;
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
279 }
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
280
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
281 return 2;
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
282 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
283
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
284 // Nothing found in symbol table, try searching in path
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
285 file_name = 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
286
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
287 if (file_name.empty ())
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
288 file_name = name;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
289
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
290 // "stat" doesn't work on UNC shares and drive letters.
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
291 if ((search_any || search_file) && drive_or_unc_share (file_name))
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
292 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
293
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
294 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
295
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
296 if (fs)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
297 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
298 if (search_any || search_file)
19861
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
299 {
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
300 if (fs.is_dir ())
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
301 return 7;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
302
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
303 len = file_name.length ();
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
304
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
305 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
306 || file_name.substr (len-4) == ".mex"))
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
307 return 3;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
308 else
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
309 return 2;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
310 }
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
311 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
312 return 7;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
313 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
314
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
315 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
316 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
317 }
1277
db4f4009d6e8 [project @ 1995-04-24 20:35:06 by jwe]
jwe
parents: 1271
diff changeset
318
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
319 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
320 && 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
321 return 5;
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
322
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
323 return 0;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
324 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
325
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23829
diff changeset
326 int
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23829
diff changeset
327 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
328 {
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30896
diff changeset
329 octave::interpreter& interp = octave::__get_interpreter__ ();
23927
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23829
diff changeset
330
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29657
diff changeset
331 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
332 }
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23829
diff changeset
333
e3a36f84d01d provide variable-editor widget for the GUI
Michael Barnes <mjbcode@runbox.com>
parents: 23829
diff changeset
334
22197
e43d83253e28 refill multi-line macro definitions
John W. Eaton <jwe@octave.org>
parents: 22196
diff changeset
335 #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
336 static_cast<int> (((LEN)-1) * static_cast<double> (rand ()) / RAND_MAX)
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
337
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
338 std::string
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
339 unique_symbol_name (const std::string& basename)
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
340 {
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
341 static const std::string alpha
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
342 = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
343
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
344 static std::size_t len = alpha.length ();
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
345
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
346 std::string nm = basename + alpha[GET_IDX (len)];
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
347
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
348 std::size_t pos = nm.length ();
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
349
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
350 if (nm.substr (0, 2) == "__")
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
351 nm.append ("__");
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
352
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30896
diff changeset
353 octave::interpreter& interp = octave::__get_interpreter__ ();
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
354
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
355 while (symbol_exist (interp, nm, "any"))
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
356 nm.insert (pos++, 1, alpha[GET_IDX (len)]);
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
357
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
358 return nm;
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
359 }
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
360
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
361 DEFMETHOD (exist, interp, args, ,
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
362 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
363 @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
364 @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
365 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
366 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
367
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
368 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
369
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
370 @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
371 @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
372 @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
373
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
374 @item 2
24485
ad04b8055d91 doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents: 24449
diff changeset
375 @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
376 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
377
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
378 @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
379 @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
380
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
381 @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
382 @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
383
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
384 @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
385 @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
386
24485
ad04b8055d91 doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents: 24449
diff changeset
387 @item 8
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
388 @var{name} is a classdef class.
24485
ad04b8055d91 doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents: 24449
diff changeset
389
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
390 @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
391 @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
392 line).
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
393
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
394 @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
395 @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
396 @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
397
24485
ad04b8055d91 doc: Note that return code 8 (class) is not implemented for exist().
Rik <rik@octave.org>
parents: 24449
diff changeset
398 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
399 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
400
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
401 @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
402 @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
403 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
404
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
405 @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
406 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
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 @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
409 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
410
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
411 @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
412 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
413
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
414 @item @qcode{"class"}
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
415 Check only for classdef classes.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
416 @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
417
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
418 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
419 @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
420 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
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 @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
423 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
424 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
425 @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
426
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
427 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
428 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
429 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
430
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
431 @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
432 @end deftypefn */)
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
433 {
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
434 int nargin = args.length ();
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
435
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
436 if (nargin < 1 || nargin > 2)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
437 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
438
29356
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
439 // 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
440 // there is an empty built-in object as the only argument.
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
441 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
442 return ovl (0);
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
443
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
444 // 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
445 // built-in object.
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
446 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
447 && args(1).isempty ())
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
448 return ovl (0);
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
449
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
450 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
451
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
452 if (nargin == 2)
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
453 {
29356
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
454 std::string type
65c57984a65e compatibility with undocumented Matlab behavior for exist function (bug #59950)
John W. Eaton <jwe@octave.org>
parents: 29033
diff changeset
455 = 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
456
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
457 return ovl (symbol_exist (interp, name, type));
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
458 }
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
459 else
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
460 return ovl (symbol_exist (interp, name));
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
461 }
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
462
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
463 /*
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
464 %!shared dirtmp, __var1
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
465 %! dirtmp = P_tmpdir ();
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
466 %! __var1 = 1;
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
467
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
468 %!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
469 %!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
470 %!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
471 %!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
472 %!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
473 %!assert (exist ("__var1", "file"), 0)
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
474 %!assert (exist ("__var1", "class"), 0)
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
475
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
476 %!testif ; isunix ()
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
477 %! assert (exist ("/bin/sh"), 2);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
478 %! assert (exist ("/bin/sh", "file"), 2);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
479 %! assert (exist ("/bin/sh", "dir"), 0);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
480 %! assert (exist ("/dev/null"), 2);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
481 %! assert (exist ("/dev/null", "file"), 2);
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
482 %! assert (exist ("/dev/null", "dir"), 0);
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
483
19750
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
484 %!assert (exist ("print_usage"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
485 %!assert (exist ("print_usage.m"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
486 %!assert (exist ("print_usage", "file"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
487 %!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
488
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
489 ## 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
490 %!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
491 %!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
492 %!assert (exist ("./%nonexistentfile%", "file"), 0)
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions.
Rik <rik@octave.org>
parents: 21301
diff changeset
493 %!assert (exist ("%nonexistentfile%", "file"), 0)
20181
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20178
diff changeset
494
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
495 ## 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
496 %!test
26677
33f79d94f21f Create any BIST temporary files in writable temporary directory (bug #55565).
Rik <rik@octave.org>
parents: 26661
diff changeset
497 %! tname = tempname ();
19915
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
498 %! unwind_protect
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
499 %! ## 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
500 %! fid = fopen (tname, "w");
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
501 %! fclose (fid);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
502 %! [~, 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
503 %! 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
504 %! unwind_protect_cleanup
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
505 %! unlink (tname);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
506 %! end_unwind_protect
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
507 %! 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
508
28907
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents: 28888
diff changeset
509 %!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
510 %!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
511 %!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
512 %!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
513
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
514 %!assert (exist ("ftp"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
515 %!assert (exist ("ftp.m"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
516 %!assert (exist ("@ftp/ftp"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
517 %!assert (exist ("@ftp/ftp.m"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
518 %!assert (exist ("ftp", "class"), 0)
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
519
30304
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
520 %!assert (exist ("inputParser"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
521 %!assert (exist ("inputParser.m"), 2)
b568c29bb5be Add support for "class" option to exist() function (bug #46260)
Rik <rik@octave.org>
parents: 30001
diff changeset
522 %!assert (exist ("inputParser", "class"), 8)
29032
2cbfd91aafb9 improve behavior of exist for finding class constructors (bug #59304)
John W. Eaton <jwe@octave.org>
parents: 28504
diff changeset
523
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
524 %!assert (exist ("sin"), 5)
18861
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
525 %!assert (exist ("sin", "builtin"), 5)
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
526 %!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
527
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
528 %!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
529 %!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
530 %!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
531
18880
ca0d9844dfd7 Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents: 18879
diff changeset
532 %!error exist ()
ca0d9844dfd7 Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents: 18879
diff changeset
533 %!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
534 %!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
535 %!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
536 %!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
537
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
538 */
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
539
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
540 // Variable values.
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
541
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
542 static bool
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
543 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
544 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
545 bool retval = false;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
546
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
547 if (nargin == 2)
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
548 {
21224
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
549 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
550 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
551
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
552 nargin = 1;
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
553 retval = true;
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
554 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
555
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
556 return retval;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
557 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
558
23704
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
559 static octave::unwind_protect *
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31730
diff changeset
560 curr_fcn_unwind_protect_frame ()
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
561 {
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30896
diff changeset
562 octave::tree_evaluator& tw = octave::__get_evaluator__ ();
23553
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
563
27204
9a3e92d02a03 eliminate direct access to call stack in variables functions
John W. Eaton <jwe@octave.org>
parents: 27160
diff changeset
564 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
565 }
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
566
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
567 template <typename T>
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
568 static bool
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
569 try_local_protect (T& var)
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
570 {
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
571 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
572
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
573 if (frame)
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
574 {
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
575 frame->protect_var (var);
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
576 return true;
c495549e9a94 refactor local protection for internal variables
John W. Eaton <jwe@octave.org>
parents: 23703
diff changeset
577 }
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
578 else
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
579 return false;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
580 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
581
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
582 octave_value
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
583 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
584 int nargout, const char *nm)
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
585 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
586 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
587
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
588 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
589
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
590 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
591 retval = var;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
592
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
593 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
594 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
595 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
596 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
597 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
598
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
599 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
600 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
601
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
602 if (nargin == 1)
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
603 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
604 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
605
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
606 var = bval;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
607 }
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
608
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
609 return retval;
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
610 }
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
611
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
612 octave_value
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
613 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
614 int nargout, const char *nm)
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
615 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
616 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
617
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
618 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
619
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
620 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
621 retval = var;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
622
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
623 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
624 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
625 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
626 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
627 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
628
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
629 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
630 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
631
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
632 if (nargin == 1)
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
633 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
634 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
635
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
636 switch (sval.length ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
637 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
638 case 1:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
639 var = sval[0];
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
640 break;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
641
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
642 case 0:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
643 var = '\0';
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
644 break;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
645
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
646 default:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
647 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
648 break;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
649 }
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
650 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
651
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
652 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
653 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
654
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
655 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
656 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
657 int nargout, const char *nm,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
658 int minval, int maxval)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
659 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
660 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
661
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
662 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
663
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
664 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
665 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
666
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
667 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
668 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
669 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
670 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
671 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
672
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
673 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
674 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
675
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
676 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
677 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
678 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
679
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
680 if (ival < minval)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
681 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
682 if (ival > maxval)
21055
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 21017
diff changeset
683 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
684
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
685 var = ival;
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
686 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
687
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
688 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
689 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
690
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
691 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
692 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
693 int nargout, const char *nm,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
694 double minval, double maxval)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
695 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
696 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
697
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
698 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
699
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
700 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
701 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
702
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
703 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
704 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
705 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
706 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
707 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
708
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
709 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
710 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
711
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
712 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
713 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
714 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
715
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
716 if (dval < minval)
26107
05dfcb24ef12 Supply missing arguments to variable length *printf functions (bug #55046).
Rik <rik@octave.org>
parents: 26089
diff changeset
717 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
718 if (dval > maxval)
26107
05dfcb24ef12 Supply missing arguments to variable length *printf functions (bug #55046).
Rik <rik@octave.org>
parents: 26089
diff changeset
719 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
720
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
721 var = dval;
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
722 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
723
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
724 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
725 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
726
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
727 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
728 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
729 int nargout, const char *nm, bool empty_ok)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
730 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
731 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
732
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
733 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
734
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
735 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
736 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
737
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
738 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
739 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
740 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
741 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
742 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
743
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
744 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
745 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
746
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
747 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
748 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
749 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
750
21224
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
751 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
752 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
753
2e64b5899d1f maint: invert if/else/error pattern in variables.cc
Rik <rik@octave.org>
parents: 21200
diff changeset
754 var = sval;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
755 }
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
756
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
757 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
758 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
759
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
760 octave_value
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
761 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
762 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
763 {
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
764 octave_value retval;
10640
5c594472f75e determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents: 10638
diff changeset
765 int nchoices = 0;
23795
980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23704
diff changeset
766 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
767 nchoices++;
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
768
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
769 int nargin = args.length ();
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
770
33250
40fde86be9b0 replace calls to error_* with corresponding panic_* functions in libinterp
John W. Eaton <jwe@octave.org>
parents: 32632
diff changeset
771 panic_unless (var < nchoices);
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
772
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
773 if (nargout > 0 || nargin == 0)
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
774 retval = choices[var];
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
775
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
776 if (wants_local_change (args, nargin))
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
777 {
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
778 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
779 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
780 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
781
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
782 if (nargin > 1)
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
783 print_usage ();
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
784
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
785 if (nargin == 1)
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
786 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
787 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
788
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
789 int i = 0;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
790 for (; i < nchoices; i++)
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
791 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
792 if (sval == choices[i])
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
793 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
794 var = i;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
795 break;
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
796 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
797 }
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
798 if (i == nchoices)
23803
90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents: 23795
diff changeset
799 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
800 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
801
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
802 return retval;
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
803 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
804
21272
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
805 octave_value
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
806 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
807 int nargout, const char *nm, const char **choices)
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
808 {
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
809 octave_value retval;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
810 int nchoices = 0;
23795
980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents: 23704
diff changeset
811 while (choices[nchoices] != nullptr)
21272
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
812 nchoices++;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
813
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
814 int nargin = args.length ();
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
815
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
816 if (nargout > 0 || nargin == 0)
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
817 retval = var;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
818
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
819 if (wants_local_change (args, nargin))
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
820 {
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
821 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
822 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
823 }
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
824
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
825 if (nargin > 1)
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
826 print_usage ();
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
827
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
828 if (nargin == 1)
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
829 {
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
830 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
831
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
832 int i = 0;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
833 for (; i < nchoices; i++)
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
834 {
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
835 if (sval == choices[i])
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
836 {
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
837 var = sval;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
838 break;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
839 }
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
840 }
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
841 if (i == nchoices)
23803
90689bdbe048 Use C++11 raw string literals to avoid escaping double quotes.
Rik <rik@octave.org>
parents: 23795
diff changeset
842 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
843 }
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
844
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
845 return retval;
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
846 }
987c1a79d33f new set_internal_variable variant
John W. Eaton <jwe@octave.org>
parents: 21224
diff changeset
847
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
848 // 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
849 // 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
850 // 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
851 // 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
852 //
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
853 // 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
854 // 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
855 // that?
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
856
23553
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
857 DEFMETHOD (mlock, interp, args, ,
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
858 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
859 @deftypefn {} {} mlock ()
26168
0a3561379dbe Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents: 26167
diff changeset
860 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
861 @code{clear}.
0a3561379dbe Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents: 26167
diff changeset
862 @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
863 @end deftypefn */)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
864 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
865 if (args.length () != 0)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
866 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
867
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
868 interp.mlock (true);
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20925
diff changeset
869
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
870 return ovl ();
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
871 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
872
23553
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
873 DEFMETHOD (munlock, interp, args, ,
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
874 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
875 @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
876 @deftypefnx {} {} munlock (@var{fcn})
26168
0a3561379dbe Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents: 26167
diff changeset
877 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
878 @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
879
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
880 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
881 @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
882 @end deftypefn */)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
883 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
884 int nargin = args.length ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
885
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
886 if (nargin > 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
887 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
888
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
889 if (nargin == 1)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
890 {
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
891 std::string name
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
892 = 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
893
23703
6eb5f6199a5a move mlock, munlock, and mislocked to interpreter class
John W. Eaton <jwe@octave.org>
parents: 23702
diff changeset
894 interp.munlock (name);
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
895 }
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
896 else
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
897 interp.munlock (true);
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
898
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
899 return ovl ();
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
900 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
901
23553
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
902 DEFMETHOD (mislocked, interp, args, ,
14723784b9f2 don't use singleton for call_stack
John W. Eaton <jwe@octave.org>
parents: 23466
diff changeset
903 doc: /* -*- texinfo -*-
30888
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30723
diff changeset
904 @deftypefn {} {@var{tf} =} mislocked ()
32d2b6604a9f doc: Ensure documentation lists output argument when it exists for functions in libinterp/
Rik <rik@octave.org>
parents: 30723
diff changeset
905 @deftypefnx {} {@var{tf} =} mislocked (@var{fcn})
26168
0a3561379dbe Clarify documentation around locking functions and clear.
Rik <rik@octave.org>
parents: 26167
diff changeset
906 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
907
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
908 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
909 @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
910 @end deftypefn */)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
911 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
912 int nargin = args.length ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
913
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
914 if (nargin > 1)
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
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
917 if (nargin == 1)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
918 {
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
919 std::string name
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
920 = 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
921
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
922 return ovl (interp.mislocked (name));
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
923 }
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
924 else
27873
020d0e8f7ac6 reafactor mlock, munlock, and mislocked functions
John W. Eaton <jwe@octave.org>
parents: 27479
diff changeset
925 return ovl (interp.mislocked (true));
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
926 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
927
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
928 // Deleting names from the symbol tables.
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
929
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
930 static inline bool
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
931 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
932 int argc, int idx, bool have_regexp = false)
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
933 {
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
934 bool retval = false;
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
935
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
936 for (int k = idx; k < argc; k++)
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
937 {
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
938 std::string patstr = argv[k];
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
939 if (! patstr.empty ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
940 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
941 if (have_regexp)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
942 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
943 if (regexp::is_match (patstr, nm))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
944 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
945 retval = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
946 break;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
947 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
948 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
949 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
950 {
32572
e424a55bc9fb Use own function for symbol name matching on Windows (bug #64975).
Markus Mützel <markus.muetzel@gmx.de>
parents: 32546
diff changeset
951 symbol_match pattern (patstr);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
952
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
953 if (pattern.match (nm))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
954 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
955 retval = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
956 break;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
957 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
958 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
959 }
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
960 }
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
961
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
962 return retval;
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
963 }
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
964
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
965 static inline void
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
966 maybe_warn_exclusive (bool exclusive)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
967 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
968 if (exclusive)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
969 warning ("clear: ignoring --exclusive option");
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
970 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
971
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
972 static void
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
973 do_clear_functions (interpreter& interp,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
974 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
975 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
976 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
977 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
978 interp.clear_functions ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
979 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
980 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
981 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
982 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
983 std::list<std::string> fcns = interp.user_function_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
984
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
985 for (const auto& name : fcns)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
986 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
987 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
988 interp.clear_function (name);
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 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
991 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
992 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
993 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
994 interp.clear_function_pattern (argv[idx++]);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
995 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
996 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
997 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
998
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
999 static void
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1000 do_clear_globals (interpreter& interp,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
1001 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
1002 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1003 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1004 if (idx == argc)
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
1005 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1006 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
1007
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1008 for (const auto& name : gvars)
24352
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1009 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1010 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
1011 interp.clear_global_variable (name);
24352
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1012 }
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
1013 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1014 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1015 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1016 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1017 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1018 std::list<std::string> gvars = interp.global_variable_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1019
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1020 for (const auto& name : gvars)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1021 {
24352
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1022 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
1023 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1024 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
1025 interp.clear_global_variable (name);
24352
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1026 }
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1027 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1028 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1029 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1030 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1031 while (idx < argc)
24352
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1032 {
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1033 std::string pattern = argv[idx++];
bff8e3884a88 restructure global variable handling in symbol table
John W. Eaton <jwe@octave.org>
parents: 24270
diff changeset
1034
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1035 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
1036 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
1037 }
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1038 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1039 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1040 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1041
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1042 static void
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1043 do_clear_variables (interpreter& interp,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
1044 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
1045 bool exclusive = false, bool have_regexp = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1046 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1047 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
1048 interp.clear_variables ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1049 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1050 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1051 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1052 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1053 std::list<std::string> lvars = interp.variable_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
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 for (const auto& name : lvars)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
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 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
1058 have_regexp))
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);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1060 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1061 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1062 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1063 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1064 if (have_regexp)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1065 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
1066 interp.clear_variable_regexp (argv[idx++]);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1067 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1068 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
1069 interp.clear_variable_pattern (argv[idx++]);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1070 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1071 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1072 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1073
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1074 static void
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1075 do_clear_symbols (interpreter& interp,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
1076 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
1077 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1078 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1079 if (idx == argc)
23611
91c8f006ed8b remove additional functions from symbol_table class
John W. Eaton <jwe@octave.org>
parents: 23604
diff changeset
1080 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1081 interp.clear_variables ();
23611
91c8f006ed8b remove additional functions from symbol_table class
John W. Eaton <jwe@octave.org>
parents: 23604
diff changeset
1082 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1083 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1084 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1085 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1086 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1087 // 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
1088 // 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
1089 // 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
1090 // bit harder to do.
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1091
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 (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
1093 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
1094 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1095 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1096 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1097 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
1098 interp.clear_symbol_pattern (argv[idx++]);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1099 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1100 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1101 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1102
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1103 static void
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1104 do_matlab_compatible_clear (interpreter& interp,
23701
a6e49930ddd2 avoid some global access to interpreter and symbol table
John W. Eaton <jwe@octave.org>
parents: 23699
diff changeset
1105 const string_vector& argv, int argc, int idx)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1106 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1107 // This is supposed to be mostly Matlab compatible.
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1108
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1109 for (; idx < argc; idx++)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1110 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1111 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
1112 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1113 interp.clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1114 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1115 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
1116 && ! interp.is_local_variable ("functions"))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1117 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1118 do_clear_functions (interp, argv, argc, ++idx);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1119 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1120 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
1121 && ! interp.is_local_variable ("global"))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1122 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1123 do_clear_globals (interp, argv, argc, ++idx);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1124 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1125 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
1126 && ! interp.is_local_variable ("variables"))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1127 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1128 interp.clear_variables ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1129 }
9240
f27a8c07f0b2 clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents: 9180
diff changeset
1130 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
1131 && ! interp.is_local_variable ("classes"))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1132 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1133 interp.clear_objects ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1134 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
1135 interp.clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1136 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1137 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1138 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1139 interp.clear_symbol_pattern (argv[idx]);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1140 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1141 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1142 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
1143
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1144 DEFMETHOD (clear, interp, args, ,
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1145 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
1146 @deftypefn {} {} clear
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1147 @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
1148 @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
1149 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
1150
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1151 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
1152
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1153 @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
1154 @item ?
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1155 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
1156
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1157 @item *
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1158 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
1159
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1160 @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
1161 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
1162 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
1163 @var{list}. For example, the pattern @code{[a-zA-Z]} will match all lowercase
32572
e424a55bc9fb Use own function for symbol name matching on Windows (bug #64975).
Markus Mützel <markus.muetzel@gmx.de>
parents: 32546
diff changeset
1164 and uppercase alphabetic characters. On Windows, square brackets are matched
e424a55bc9fb Use own function for symbol name matching on Windows (bug #64975).
Markus Mützel <markus.muetzel@gmx.de>
parents: 32546
diff changeset
1165 literally and are not used to group 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
1166 @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
1167
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1168 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
1169
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1170 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1171 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
1172 @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
1173
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1174 @noindent
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1175 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
1176 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
1177
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1178 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
1179 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
1180 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
1181 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
1182 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
1183
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1184 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
1185
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1186 @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
1187 @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
1188 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
1189 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
1190
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1191 @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
1192 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
1193
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1194 @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
1195 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
1196 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
1197 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
1198
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1199 @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
1200 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
1201
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1202 @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
1203 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
1204
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1205 @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
1206 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
1207
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1208 @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
1209 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
1210 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
1211 @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
1212
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1213 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
1214 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
1215 @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
1216 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
1217
28504
d747d57989e2 doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents: 28024
diff changeset
1218 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
1219 @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
1220 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
1221 @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
1222 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
1223 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
1224 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
1225
28504
d747d57989e2 doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents: 28024
diff changeset
1226 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
1227 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
1228 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
1229 @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
1230 variables.
d747d57989e2 doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents: 28024
diff changeset
1231
d747d57989e2 doc: Better document how global variables and clear() interact (bug #57604).
Rik <rik@octave.org>
parents: 28024
diff changeset
1232 @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
1233 @end deftypefn */)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1234 {
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
1235 int argc = args.length () + 1;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1236
1968
a2e206524aa0 [project @ 1996-02-17 02:54:24 by jwe]
jwe
parents: 1957
diff changeset
1237 string_vector argv = args.make_argv ("clear");
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
1238
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1239 if (argc == 1)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1240 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1241 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
1242
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1243 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
1244
27263
99aa1bcb8848 rename octave_link and octave_link_events classes, move inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27261
diff changeset
1245 evmgr.clear_workspace ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1246 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1247 else
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1248 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1249 int idx = 0;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1250
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1251 bool clear_all = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1252 bool clear_functions = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1253 bool clear_globals = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1254 bool clear_variables = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1255 bool clear_objects = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1256 bool exclusive = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1257 bool have_regexp = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1258 bool have_dash_option = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1259
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1260 while (++idx < argc)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1261 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1262 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
1263 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1264 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1265 print_usage ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1266
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1267 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1268 clear_all = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1269 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1270 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
1271 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1272 exclusive = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1273 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1274 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
1275 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1276 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1277 print_usage ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1278
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1279 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1280 clear_functions = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1281 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1282 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
1283 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1284 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1285 print_usage ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1286
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1287 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1288 clear_globals = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1289 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1290 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
1291 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1292 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1293 print_usage ();
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 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1296 clear_variables = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1297 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1298 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
1299 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1300 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1301 print_usage ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1302
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1303 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1304 clear_objects = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1305 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1306 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
1307 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1308 if (have_dash_option)
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1309 print_usage ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1310
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1311 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1312 have_regexp = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1313 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1314 else
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1315 break;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1316 }
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 if (idx <= argc)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1319 {
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1320 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
1321 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
1322 else
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1323 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1324 if (clear_all)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1325 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1326 maybe_warn_exclusive (exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1327
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1328 if (++idx < argc)
20897
9aad16a799c9 maint: Replace argc variable name with nargin in C++ code.
Rik <rik@octave.org>
parents: 20853
diff changeset
1329 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
1330
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1331 interp.clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1332 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1333 else if (have_regexp)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1334 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1335 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
1336 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1337 else if (clear_functions)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1338 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1339 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
1340 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1341 else if (clear_globals)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1342 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1343 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
1344 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1345 else if (clear_variables)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1346 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1347 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
1348 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1349 else if (clear_objects)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1350 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1351 interp.clear_objects ();
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1352 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
1353 interp.clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1354 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1355 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1356 {
26661
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1357 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
1358 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1359 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1360 }
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1361 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1362
20941
a4f5da7c5463 maint: Replace "octave_value_list ()" with "ovl ()".
Rik <rik@octave.org>
parents: 20940
diff changeset
1363 return ovl ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1364 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1365
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1366 /*
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1367 ## 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
1368 ## break the %!test environment.
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1369 %!function __test_clear_no_args__ ()
31564
332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions.
Rik <rik@octave.org>
parents: 31105
diff changeset
1370 %! global x;
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1371 %! x = 3;
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1372 %! clear
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1373 %! assert (! exist ("x", "var")); # x is not in the current workspace anymore
31564
332a6ccac881 maint: cleanup code in BIST tests to use Octave coding conventions.
Rik <rik@octave.org>
parents: 31105
diff changeset
1374 %! global x; # but still lives in the global workspace
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1375 %! assert (exist ("x", "var"));
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1376 %!endfunction
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1377
26167
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1378 %!test
26678
2c246d188151 variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents: 26434
diff changeset
1379 %! unwind_protect
2c246d188151 variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents: 26434
diff changeset
1380 %! __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
1381 %! unwind_protect_cleanup
2c246d188151 variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents: 26434
diff changeset
1382 %! clear -g x
2c246d188151 variables.cc: Don't leak variables into global namespace from BIST tests.
Rik <rik@octave.org>
parents: 26434
diff changeset
1383 %! end_unwind_protect
26169
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1384
096b38cac97f Improve input validation to reject multiple options for clear (bug #53565).
Rik <rik@octave.org>
parents: 26168
diff changeset
1385 ## 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
1386 %!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
1387 */
247126168d23 Don't remove globals when 'clear' called without arguments (bug #39790).
Julien Bect <julien.bect@supelec.fr>
parents: 26113
diff changeset
1388
15562
8ed107220a3e maint: Rename unimplemented.m to __unimplemented__.m.
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15528
diff changeset
1389 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
1390
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
1391 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
1392 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
1393 @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
1394 @deftypefnx {} {@var{old_val} =} missing_function_hook (@var{new_val})
30588
ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681)
Rik <rik@octave.org>
parents: 30565
diff changeset
1395 @deftypefnx {} {@var{old_val} =} 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
1396 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
1397 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
1398
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1399 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
1400 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
1401 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
1402 @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
1403 @end deftypefn */)
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
1404 {
30001
428cccc75cc9 move most functions in variables.cc to octave namespace
John W. Eaton <jwe@octave.org>
parents: 29961
diff changeset
1405 return set_internal_variable (Vmissing_function_hook, args, nargout,
428cccc75cc9 move most functions in variables.cc to octave namespace
John W. Eaton <jwe@octave.org>
parents: 29961
diff changeset
1406 "missing_function_hook");
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
1407 }
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
1408
27479
e8c417f6ef83 make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents: 27471
diff changeset
1409 std::string
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1410 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
1411 {
31105
670a0d878af1 eliminate WHO arguments from interpreter-private functions
John W. Eaton <jwe@octave.org>
parents: 30896
diff changeset
1412 octave::interpreter& interp = octave::__get_interpreter__ ();
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1413
10444
537d9fbba9c0 don't call missing_function_hook inside try block
Jaroslav Hajek <highegg@gmail.com>
parents: 10443
diff changeset
1414 // Don't do this if we're handling errors.
27471
fd32c1a9b1bd revamp error handling
John W. Eaton <jwe@octave.org>
parents: 27408
diff changeset
1415 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
1416 return "";
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1417
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1418 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
1419
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1420 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
1421
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1422 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
1423 {
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1424 // Ensure auto-restoration.
28823
26cfccfee9a0 Replace unwind_protect with more efficient constructs (bug #59192).
Rik <rik@octave.org>
parents: 28749
diff changeset
1425 octave::unwind_protect_var<std::string>
31607
aac27ad79be6 maint: Re-indent code after switch to using namespace macros.
Rik <rik@octave.org>
parents: 31605
diff changeset
1426 restore_var (Vmissing_function_hook);
15528
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
1427
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1428 // Clear the variable prior to calling the function.
30896
c9788d7f6e65 maint: Use "fcn" as preferred abbreviation for "function" in libinterp/.
Rik <rik@octave.org>
parents: 30888
diff changeset
1429 const std::string fcn_name = Vmissing_function_hook;
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1430 Vmissing_function_hook.clear ();
15528
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
1431
27160
6b0c61a5a0f0 move global error configuration and status variables inside a class
John W. Eaton <jwe@octave.org>
parents: 27016
diff changeset
1432 // Call.
31730
610a85b0ff62 use interpreter::feval instead of global feval function
John W. Eaton <jwe@octave.org>
parents: 31706
diff changeset
1433 octave_value_list tmp = interp.feval (fcn_name, octave_value (name), 1);
27479
e8c417f6ef83 make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents: 27471
diff changeset
1434
e8c417f6ef83 make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents: 27471
diff changeset
1435 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
1436 return tmp(0).string_value ();
10467
13c1f15c67fa guard against recursive calls of missing_function_hook
Jaroslav Hajek <highegg@gmail.com>
parents: 10444
diff changeset
1437 }
27479
e8c417f6ef83 make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents: 27471
diff changeset
1438
e8c417f6ef83 make unimplmented message an error and append to undefined identifier error
John W. Eaton <jwe@octave.org>
parents: 27471
diff changeset
1439 return "";
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
1440 }
11558
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
1441
23599
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1442 DEFMETHOD (__varval__, interp, args, ,
5cb3a2bb5e1e don't use singleton for symbol_table
John W. Eaton <jwe@octave.org>
parents: 23587
diff changeset
1443 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
1444 @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
1445 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
1446
4e10e25f0fc6 inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents: 28505
diff changeset
1447 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
1448 (@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
1449 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
1450
4e10e25f0fc6 inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents: 28505
diff changeset
1451 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
1452 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
1453
4e10e25f0fc6 inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents: 28505
diff changeset
1454 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
1455
4e10e25f0fc6 inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents: 28505
diff changeset
1456 @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
1457 @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
1458 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
1459 @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
1460 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
1461 ## 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
1462 @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
1463 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
1464 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
1465 @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
1466 @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
1467
4e10e25f0fc6 inputname.m: Closer compatibility with Matlab for special values (i,j,NaN,Inf) (bug #59103)
Rik <rik@octave.org>
parents: 28505
diff changeset
1468 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
1469 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
1470 @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
1471 @end deftypefn */)
11558
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
1472 {
20760
15eefcabcb31 doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents: 20756
diff changeset
1473 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
1474 print_usage ();
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
1475
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
1476 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
1477
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
1478 // 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
1479 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
1480 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1481 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
1482
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
1483 return tw.get_auto_fcn_var (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
1484 }
cf9e10ce3351 move variable values from symbol_record objects to stack_frame objects
John W. Eaton <jwe@octave.org>
parents: 26446
diff changeset
1485
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
1486 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
1487 }
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1488
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1489 static std::string Vmissing_component_hook;
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1490
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1491 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
1492 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
1493 @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
1494 @deftypefnx {} {@var{old_val} =} missing_component_hook (@var{new_val})
30588
ed17822e7662 doc: Always have a return value for functions which set internal variables (bug #61681)
Rik <rik@octave.org>
parents: 30565
diff changeset
1495 @deftypefnx {} {@var{old_val} =} missing_component_hook (@var{new_val}, "local")
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1496 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
1497 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
1498
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1499 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
1500 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
1501 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
1502
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1503 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
1504 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
1505 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
1506
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1507 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
1508
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1509 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1510 @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
1511 @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
1512
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21885
diff changeset
1513 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
1514 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
1515 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
1516 @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
1517 @end deftypefn */)
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1518 {
30001
428cccc75cc9 move most functions in variables.cc to octave namespace
John W. Eaton <jwe@octave.org>
parents: 29961
diff changeset
1519 return set_internal_variable (Vmissing_component_hook, args, nargout,
428cccc75cc9 move most functions in variables.cc to octave namespace
John W. Eaton <jwe@octave.org>
parents: 29961
diff changeset
1520 "missing_component_hook");
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
1521 }
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29657
diff changeset
1522
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 31564
diff changeset
1523 OCTAVE_END_NAMESPACE(octave)