annotate libinterp/corefcn/variables.cc @ 20925:667861ffffab

Extracted header class octave-preserve-stream-state from utils.{cc/h}. * libinterp/corefcn/octave-preserve-stream-state.h: extracted class definition. * libinterp/corefcn/module.mk: add octave-preserve-stream-state.h to build system. * libinterp/corefcn/utils.{cc/h}: extracted code of class octave-preserve-stream-state. * libinterp/corefcn/debug.cc: add new header dependency. * libinterp/corefcn/pr-output.cc: add new header dependency. * libinterp/corefcn/variables.cc: add new header dependency. * libinterp/corefcn/ov-base-sparse.cc: add new header dependency.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Thu, 17 Dec 2015 16:19:51 +0100
parents 03e4ddd49396
children b17fda023ca6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
2
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19597
diff changeset
3 Copyright (C) 1993-2015 John W. Eaton
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11431
diff changeset
4 Copyright (C) 2009-2010 VZLU Prague
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
5
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
7
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
11 option) any later version.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
12
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
16 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
17
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
20 <http://www.gnu.org/licenses/>.
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
23
240
a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe]
jwe
parents: 217
diff changeset
24 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1162
diff changeset
25 #include <config.h>
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
26 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
27
1468
cdb87ef617e8 [project @ 1995-09-22 08:09:53 by jwe]
jwe
parents: 1465
diff changeset
28 #include <cstdio>
1343
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe]
jwe
parents: 1315
diff changeset
29 #include <cstring>
605
4f65175911a6 [project @ 1994-08-13 20:10:39 by jwe]
jwe
parents: 598
diff changeset
30
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
31 #include <iomanip>
4207
fa3482b34599 [project @ 2002-12-03 18:22:05 by jwe]
jwe
parents: 4179
diff changeset
32 #include <set>
1728
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1719
diff changeset
33 #include <string>
42b4f904f1af [project @ 1996-01-09 11:36:01 by jwe]
jwe
parents: 1719
diff changeset
34
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
35 #include "file-stat.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
36 #include "oct-env.h"
4604
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe]
jwe
parents: 4587
diff changeset
37 #include "file-ops.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
38 #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
39 #include "lo-regexp.h"
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
40 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
41
2492
06595bc7f2d0 [project @ 1996-11-09 00:13:50 by jwe]
jwe
parents: 2487
diff changeset
42 #include <defaults.h>
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
43 #include "Cell.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
44 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
45 #include "dirfns.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
46 #include "error.h"
2205
bd389b53befa [project @ 1996-05-15 06:15:45 by jwe]
jwe
parents: 2181
diff changeset
47 #include "gripes.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
48 #include "help.h"
3165
e4bbfc196e53 [project @ 1998-04-16 03:01:47 by jwe]
jwe
parents: 3162
diff changeset
49 #include "input.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
50 #include "lex.h"
5832
5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe]
jwe
parents: 5823
diff changeset
51 #include "load-path.h"
16523
62d8aaf6ba8f force update of GUI workspace viewer from clear function
John W. Eaton <jwe@octave.org>
parents: 16442
diff changeset
52 #include "octave-link.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
53 #include "octave-preserve-stream-state.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
54 #include "oct-map.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
55 #include "oct-obj.h"
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
56 #include "ov.h"
9240
f27a8c07f0b2 clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents: 9180
diff changeset
57 #include "ov-class.h"
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3681
diff changeset
58 #include "ov-usr-fcn.h"
605
4f65175911a6 [project @ 1994-08-13 20:10:39 by jwe]
jwe
parents: 598
diff changeset
59 #include "pager.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
60 #include "parse.h"
2926
66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe]
jwe
parents: 2921
diff changeset
61 #include "symtab.h"
2205
bd389b53befa [project @ 1996-05-15 06:15:45 by jwe]
jwe
parents: 2181
diff changeset
62 #include "toplev.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
63 #include "unwind-prot.h"
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
64 #include "utils.h"
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1350
diff changeset
65 #include "variables.h"
2205
bd389b53befa [project @ 1996-05-15 06:15:45 by jwe]
jwe
parents: 2181
diff changeset
66
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
67 // Defines layout for the whos/who -long command
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
68 static std::string Vwhos_line_format
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
69 = " %a:4; %ln:6; %cs:16:6:1; %rb:12; %lc:-1;\n";
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
70
6068
c9f0839c583f [project @ 2006-10-20 16:54:30 by jwe]
jwe
parents: 5930
diff changeset
71 void
6072
4036e6fca790 [project @ 2006-10-24 01:00:12 by jwe]
jwe
parents: 6068
diff changeset
72 clear_mex_functions (void)
6068
c9f0839c583f [project @ 2006-10-20 16:54:30 by jwe]
jwe
parents: 5930
diff changeset
73 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
74 symbol_table::clear_mex_functions ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
75 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
76
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
77 void
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
78 clear_function (const std::string& nm)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
79 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
80 symbol_table::clear_function (nm);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
81 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
82
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
83 void
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
84 clear_variable (const std::string& nm)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
85 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
86 symbol_table::clear_variable (nm);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
87 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
88
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
89 void
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
90 clear_symbol (const std::string& nm)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
91 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
92 symbol_table::clear_symbol (nm);
6068
c9f0839c583f [project @ 2006-10-20 16:54:30 by jwe]
jwe
parents: 5930
diff changeset
93 }
c9f0839c583f [project @ 2006-10-20 16:54:30 by jwe]
jwe
parents: 5930
diff changeset
94
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
95 // Attributes of variables and functions.
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
96
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 2076
diff changeset
97 // Is this octave_value a valid function?
593
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 std::string& fcn_name,
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)
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
102 {
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2963
diff changeset
103 octave_function *ans = 0;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
104
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
105 if (! fcn_name.empty ())
3618
8cea69ad95ae [project @ 2000-03-22 20:51:45 by jwe]
jwe
parents: 3565
diff changeset
106 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
107 octave_value val = symbol_table::find_function (fcn_name);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
108
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
109 if (val.is_defined ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
110 ans = val.function_value (true);
3618
8cea69ad95ae [project @ 2000-03-22 20:51:45 by jwe]
jwe
parents: 3565
diff changeset
111 }
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
112
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
113 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
114 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
115 warn_for.c_str (), fcn_name.c_str ());
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
116
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
117 return ans;
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
118 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
119
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2963
diff changeset
120 octave_function *
4345
4e23bfdd6172 [project @ 2003-02-20 20:45:49 by jwe]
jwe
parents: 4342
diff changeset
121 is_valid_function (const octave_value& arg,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
122 const std::string& warn_for, bool warn)
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
123 {
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
124 octave_function *ans = 0;
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
125
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
126 std::string fcn_name;
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
127
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
128 if (arg.is_string ())
4700
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4604
diff changeset
129 {
ca3a1d687bba [project @ 2004-01-21 03:28:31 by jwe]
jwe
parents: 4604
diff changeset
130 fcn_name = arg.string_value ();
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
131
19743
67f2c76f9f4d Remove unnecessary checking of error_state after is_string validation.
Rik <rik@octave.org>
parents: 19718
diff changeset
132 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
133 }
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
134 else if (warn)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
135 error ("%s: argument must be a string containing function name", warn_for.c_str ());
3178
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
136
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
137 return ans;
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
138 }
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
139
09a3064a3a17 [project @ 1998-06-23 03:46:42 by jwe]
jwe
parents: 3165
diff changeset
140 octave_function *
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
141 extract_function (const octave_value& arg, const std::string& warn_for,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
142 const std::string& fname, const std::string& header,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
143 const std::string& trailer)
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
144 {
2975
b9c107cbe388 [project @ 1997-05-15 20:01:00 by jwe]
jwe
parents: 2963
diff changeset
145 octave_function *retval = 0;
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
146
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
147 retval = is_valid_function (arg, warn_for, 0);
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
148
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
149 if (! retval)
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
150 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
151 std::string s = arg.xstring_value ("%s: first argument must be a string",
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
152 warn_for.c_str ());
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
153
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
154 std::string cmd = header;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
155 cmd.append (s);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
156 cmd.append (trailer);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
157
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
158 int parse_status;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
159
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
160 eval_string (cmd, true, parse_status, 0);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
161
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
162 if (parse_status == 0)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
163 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
164 retval = is_valid_function (fname, warn_for, 0);
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
165
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
166 if (! retval)
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
167 error ("%s: '%s' is not valid as a function",
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
168 warn_for.c_str (), fname.c_str ());
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
169
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
170 warning ("%s: passing function body as a string is obsolete; please use anonymous functions",
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
171 warn_for.c_str ());
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
172 }
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
173 else
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
174 error ("%s: '%s' is not valid as a function",
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
175 warn_for.c_str (), fname.c_str ());
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
176 }
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
177
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
178 return retval;
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
179 }
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
180
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
181 string_vector
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
182 get_struct_elts (const std::string& text)
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
183 {
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
184 int n = 1;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
185
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
186 size_t pos = 0;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
187
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
188 size_t len = text.length ();
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
189
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
190 while ((pos = text.find ('.', pos)) != std::string::npos)
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
191 {
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
192 if (++pos == len)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
193 break;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
194
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
195 n++;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
196 }
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
197
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
198 string_vector retval (n);
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
199
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
200 pos = 0;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
201
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
202 for (int i = 0; i < n; i++)
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
203 {
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 4526
diff changeset
204 len = text.find ('.', pos);
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
205
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
206 if (len != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
207 len -= pos;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
208
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
209 retval[i] = text.substr (pos, len);
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
210
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
211 if (len != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
212 pos += len + 1;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
213 }
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
214
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
215 return retval;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
216 }
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
217
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
218 static inline bool
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
219 is_variable (const std::string& name)
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
220 {
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
221 bool retval = false;
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
222
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
223 if (! name.empty ())
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
224 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
225 octave_value val = symbol_table::varval (name);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
226
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
227 retval = val.is_defined ();
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
228 }
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
229
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
230 return retval;
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
231 }
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
232
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
233 string_vector
3933
f9ea3dcf58ee [project @ 2002-05-15 03:21:00 by jwe]
jwe
parents: 3681
diff changeset
234 generate_struct_completions (const std::string& text,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
235 std::string& prefix, std::string& hint)
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
236 {
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
237 string_vector names;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
238
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
239 size_t pos = text.rfind ('.');
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
240
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
241 if (pos != std::string::npos)
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
242 {
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
243 if (pos == text.length ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
244 hint = "";
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
245 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
246 hint = text.substr (pos+1);
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
247
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
248 prefix = text.substr (0, pos);
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
249
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
250 std::string base_name = prefix;
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
251
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
252 pos = base_name.find_first_of ("{(.");
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
253
8021
85184151822e fix typo in NPOS change
John W. Eaton <jwe@octave.org>
parents: 8019
diff changeset
254 if (pos != std::string::npos)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
255 base_name = base_name.substr (0, pos);
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
256
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
257 if (is_variable (base_name))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
258 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
259 int parse_status;
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
260
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
261 unwind_protect frame;
3935
1ea29376e43e [project @ 2002-05-16 05:30:51 by jwe]
jwe
parents: 3933
diff changeset
262
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
263 frame.protect_var (discard_error_messages);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
264 frame.protect_var (discard_warning_messages);
3935
1ea29376e43e [project @ 2002-05-16 05:30:51 by jwe]
jwe
parents: 3933
diff changeset
265
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
266 discard_error_messages = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
267 discard_warning_messages = true;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
268
20769
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
269 try
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
270 {
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
271 octave_value tmp = eval_string (prefix, true, parse_status);
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
272
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
273 frame.run ();
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
274
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
275 if (tmp.is_defined ()
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
276 && (tmp.is_map () || tmp.is_java () || tmp.is_classdef_object ()))
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
277 names = tmp.map_keys ();
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
278 }
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
279 catch (const octave_execution_exception&)
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
280 {
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
281 recover_from_exception ();
58e79b0078e4 handle exceptions when discarding error messages (bug #46534)
John W. Eaton <jwe@octave.org>
parents: 20760
diff changeset
282 }
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
283 }
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
284 }
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
285
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
286 return names;
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
287 }
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
288
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
289 // FIXME: this will have to be much smarter to work "correctly".
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
290
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
291 bool
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
292 looks_like_struct (const std::string& text)
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
293 {
4604
cba347c642e2 [project @ 2003-11-13 04:38:05 by jwe]
jwe
parents: 4587
diff changeset
294 bool retval = (! text.empty ()
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
295 && text != "."
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
296 && text.find_first_of (file_ops::dir_sep_chars ()) == std::string::npos
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
297 && text.find ("..") == std::string::npos
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
298 && text.rfind ('.') != std::string::npos);
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
299
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
300 #if 0
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
301 symbol_record *sr = curr_sym_tab->lookup (text);
2963
c0c280cda856 [project @ 1997-05-12 03:25:07 by jwe]
jwe
parents: 2956
diff changeset
302
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
303 if (sr && ! sr->is_function ())
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
304 {
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
305 int parse_status;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
306
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9750
diff changeset
307 unwind_protect frame;
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
308
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9750
diff changeset
309 frame.protect_var (discard_error_messages);
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
310
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
311 discard_error_messages = true;
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
312
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
313 octave_value tmp = eval_string (text, true, parse_status);
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
314
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9750
diff changeset
315 frame.run ();
4143
62afb31c1f85 [project @ 2002-11-01 17:27:38 by jwe]
jwe
parents: 4108
diff changeset
316
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
317 retval = (tmp.is_defined () && tmp.is_map ());
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
318 }
4179
8734ba917fea [project @ 2002-11-14 04:31:19 by jwe]
jwe
parents: 4143
diff changeset
319 #endif
3968
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
320
cef0ea4d1b3a [project @ 2002-07-01 19:16:01 by jwe]
jwe
parents: 3935
diff changeset
321 return retval;
2921
64dd86522a1d [project @ 1997-05-02 02:52:54 by jwe]
jwe
parents: 2909
diff changeset
322 }
2796
74bc1ede3c3d [project @ 1997-03-07 06:55:47 by jwe]
jwe
parents: 2790
diff changeset
323
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
324 static octave_value
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
325 do_isglobal (const octave_value_list& args)
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
326 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4224
diff changeset
327 octave_value retval = false;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
328
20819
f428cbe7576f eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents: 20799
diff changeset
329 if (args.length () != 1)
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
330 print_usage ();
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
331
19403
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19152
diff changeset
332 if (! args(0).is_string ())
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
333 error ("isglobal: NAME must be a string");
636
fae2bd91c027 [project @ 1994-08-23 18:39:50 by jwe]
jwe
parents: 628
diff changeset
334
19403
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19152
diff changeset
335 std::string name = args(0).string_value ();
03067dab10ca Use stricter input validation when looking for a string as input (bug #42651).
Rik <rik@octave.org>
parents: 19152
diff changeset
336
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
337 return symbol_table::is_global (name);
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
338 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
339
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
340 DEFUN (isglobal, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
341 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
342 @deftypefn {} {} isglobal (@var{name})\n\
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11151
diff changeset
343 Return true if @var{name} is a globally visible variable.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
344 \n\
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11151
diff changeset
345 For example:\n\
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
346 \n\
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
347 @example\n\
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
348 @group\n\
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
349 global x\n\
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
350 isglobal (\"x\")\n\
14360
97883071e8e4 doc: Correct off-by-1 spacings in all .cc docstrings
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
351 @result{} 1\n\
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
352 @end group\n\
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
353 @end example\n\
11431
0d9640d755b1 Improve docstrings for all isXXX functions.
Rik <octave@nomad.inbox5.com>
parents: 11151
diff changeset
354 @seealso{isvarname, exist}\n\
5930
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
355 @end deftypefn")
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
356 {
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
357 return do_isglobal (args);
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
358 }
a703198cb8b8 [project @ 2006-08-15 06:06:15 by jwe]
jwe
parents: 5929
diff changeset
359
9454
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
360 static octave_value
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
361 safe_symbol_lookup (const std::string& symbol_name)
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
362 {
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
363 octave_value retval;
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
364
10066
2cd940306a06 make unwind_protect frames local
Jaroslav Hajek <highegg@gmail.com>
parents: 9750
diff changeset
365 unwind_protect frame;
11029
4ab04ea74b08 make an internal function for try simulation
Jaroslav Hajek <highegg@gmail.com>
parents: 10975
diff changeset
366 interpreter_try (frame);
9454
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
367
20535
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
368 try
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
369 {
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
370 retval = symbol_table::find (symbol_name);
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
371 }
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
372 catch (const octave_execution_exception&)
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
373 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20727
diff changeset
374 recover_from_exception ();
20535
b70cc4bd8109 begin removal of global error_state variable
John W. Eaton <jwe@octave.org>
parents: 20232
diff changeset
375 }
9454
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
376
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
377 return retval;
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
378 }
c58b8960c7d0 variables.cc (symbol_exist): ignore errors when parsing functions
John W. Eaton <jwe@octave.org>
parents: 9445
diff changeset
379
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
380 int
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
381 symbol_exist (const std::string& name, const std::string& type)
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
382 {
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
383 if (is_keyword (name))
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
384 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
385
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
386 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
387 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
388 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
389 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
390 bool search_builtin = type == "builtin";
20206
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
391 bool search_class = type == "class";
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
392
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
393 if (! (search_any || search_var || search_dir || search_file ||
3c8260fd0837 Validate second option to exist () (bug #42618).
Rik <rik@octave.org>
parents: 20181
diff changeset
394 search_builtin || search_class))
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
395 error ("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
396
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
397 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
398 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
399 octave_value val = symbol_table::varval (name);
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
400
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
401 if (val.is_constant () || val.is_object ()
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
402 || 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
403 || 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
404 || 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
405 return 1;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
406
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
407 if (search_var)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
408 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
409 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
410
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
411 // 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
412 // 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
413
18864
c677d9bd6bac exist: Don't look up name in symbol table if "file" or "dir" specified.
Rik <rik@octave.org>
parents: 18861
diff changeset
414 octave_value val;
c677d9bd6bac exist: Don't look up name in symbol table if "file" or "dir" specified.
Rik <rik@octave.org>
parents: 18861
diff changeset
415
c677d9bd6bac exist: Don't look up name in symbol table if "file" or "dir" specified.
Rik <rik@octave.org>
parents: 18861
diff changeset
416 if (search_any || search_builtin)
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
417 {
18878
d3276190e551 Revert a0fd65914811 which does not truly fix bug #36067.
Rik <rik@octave.org>
parents: 18865
diff changeset
418 // FIXME: safe_symbol_lookup will attempt unsafe load of .oct/.mex file.
d3276190e551 Revert a0fd65914811 which does not truly fix bug #36067.
Rik <rik@octave.org>
parents: 18865
diff changeset
419 // This can cause a segfault. To catch this would require temporarily
d3276190e551 Revert a0fd65914811 which does not truly fix bug #36067.
Rik <rik@octave.org>
parents: 18865
diff changeset
420 // diverting the SIGSEGV exception handler and then restoring it.
d3276190e551 Revert a0fd65914811 which does not truly fix bug #36067.
Rik <rik@octave.org>
parents: 18865
diff changeset
421 // See bug #36067.
d3276190e551 Revert a0fd65914811 which does not truly fix bug #36067.
Rik <rik@octave.org>
parents: 18865
diff changeset
422 val = safe_symbol_lookup (name);
18864
c677d9bd6bac exist: Don't look up name in symbol table if "file" or "dir" specified.
Rik <rik@octave.org>
parents: 18861
diff changeset
423
c677d9bd6bac exist: Don't look up name in symbol table if "file" or "dir" specified.
Rik <rik@octave.org>
parents: 18861
diff changeset
424 if (val.is_defined () && val.is_builtin_function ())
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
425 return 5;
18861
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
426
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
427 if (search_builtin)
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
428 return 0;
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
429 }
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
430
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
431 if (search_any || search_file || search_dir)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
432 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
433 std::string file_name = lookup_autoload (name);
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
434
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
435 if (file_name.empty ())
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
436 file_name = load_path::find_fcn (name);
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
437
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
438 size_t len = file_name.length ();
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
439
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
440 if (len > 0)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
441 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
442 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
443 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
444 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
445 || 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
446 return 3;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
447 else
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
448 return 2;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
449 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
450 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
451
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
452 file_name = file_in_path (name, "");
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
453
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
454 if (file_name.empty ())
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
455 file_name = name;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
456
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
457 file_stat fs (file_name);
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
458
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
459 if (fs)
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
460 {
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
461 if (search_any || search_file)
19861
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
462 {
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
463 if (fs.is_dir ())
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
464 return 7;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
465
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
466 len = file_name.length ();
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
467
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
468 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
469 || file_name.substr (len-4) == ".mex"))
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
470 return 3;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
471 else
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
472 return 2;
19755f4fc851 maint: Cleanup C++ code to follow Octave coding conventions.
Rik <rik@octave.org>
parents: 19750
diff changeset
473 }
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
474 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
475 return 7;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
476 }
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
477
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
478 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
479 return 0;
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
480 }
1277
db4f4009d6e8 [project @ 1995-04-24 20:35:06 by jwe]
jwe
parents: 1271
diff changeset
481
18861
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
482 // Command line function which Matlab does not support
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
483 if (search_any && val.is_defined () && val.is_user_function ())
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
484 return 103;
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
485
17963
2ca3a2f46d93 improve performance of exist when searching for specific items
John W. Eaton <jwe@octave.org>
parents: 17861
diff changeset
486 return 0;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
487 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
488
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
489 #define GET_IDX(LEN) \
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
490 static_cast<int> ((LEN-1) * static_cast<double> (rand ()) / RAND_MAX)
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
491
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
492 std::string
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
493 unique_symbol_name (const std::string& basename)
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
494 {
4962
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
495 static const std::string alpha
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
496 = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
497
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
498 static size_t len = alpha.length ();
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
499
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
500 std::string nm = basename + alpha[GET_IDX (len)];
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
501
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
502 size_t pos = nm.length ();
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
503
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
504 if (nm.substr (0, 2) == "__")
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
505 nm.append ("__");
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
506
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
507 while (symbol_exist (nm, "any"))
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
508 nm.insert (pos++, 1, alpha[GET_IDX (len)]);
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
509
0ab18cbe8b5f [project @ 2004-09-02 16:56:17 by jwe]
jwe
parents: 4954
diff changeset
510 return nm;
4954
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
511 }
ed0f3cb6d3d4 [project @ 2004-09-01 21:24:53 by jwe]
jwe
parents: 4930
diff changeset
512
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
513 DEFUN (exist, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
514 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
515 @deftypefn {} {@var{c} =} exist (@var{name})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
516 @deftypefnx {} {@var{c} =} exist (@var{name}, @var{type})\n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
517 Check for the existence of @var{name} as a variable, function, file,\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
518 directory, or class.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
519 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
520 The return code @var{c} is one of\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
521 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
522 @table @asis\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
523 @item 1\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
524 @var{name} is a variable.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
525 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
526 @item 2\n\
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
527 @var{name} is an absolute filename, an ordinary file in Octave's\n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
528 @code{path}, or (after appending @samp{.m}) a function file in Octave's\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
529 @code{path}.\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
530 \n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
531 @item 3\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
532 @var{name} is a @samp{.oct} or @samp{.mex} file in Octave's @code{path}.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
533 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
534 @item 5\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
535 @var{name} is a built-in function.\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
536 \n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
537 @item 7\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
538 @var{name} is a directory.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
539 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
540 @item 103\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
541 @var{name} is a function not associated with a file (entered on the command\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
542 line).\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
543 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
544 @item 0\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
545 @var{name} does not exist.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
546 @end table\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
547 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
548 If the optional argument @var{type} is supplied, check only for symbols of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
549 the specified type. Valid types are\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
550 \n\
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11591
diff changeset
551 @table @asis\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
552 @item @qcode{\"var\"}\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
553 Check only for variables.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
554 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
555 @item @qcode{\"builtin\"}\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
556 Check only for built-in functions.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
557 \n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
558 @item @qcode{\"dir\"}\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
559 Check only for directories.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
560 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
561 @item @qcode{\"file\"}\n\
15508
cea08e743c2c doc: Clarify that exist (name, "file") also includes directories (bug #37512).
Rik <rik@octave.org>
parents: 15467
diff changeset
562 Check only for files and directories.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
563 \n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
564 @item @qcode{\"class\"}\n\
19152
0f9c5a15c8fa doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19110
diff changeset
565 Check only for classes. (Note: This option is accepted, but not currently\n\
0f9c5a15c8fa doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19110
diff changeset
566 implemented)\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
567 @end table\n\
15007
8f0e3c5bfa5f doc: Periodic grammarcheck of documentation
Rik <rik@octave.org>
parents: 14861
diff changeset
568 \n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
569 If no type is given, and there are multiple possible matches for name,\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
570 @code{exist} will return a code according to the following priority list:\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
571 variable, built-in function, oct-file, directory, file, class.\n\
18879
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
572 \n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
573 @code{exist} returns 2 if a regular file called @var{name} is present in\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
574 Octave's search path. If you want information about other types of files\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
575 not on the search path you should use some combination of the functions\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
576 @code{file_in_path} and @code{stat} instead.\n\
afab3a2f57e7 doc: Update docstring for exist().
Rik <rik@octave.org>
parents: 18878
diff changeset
577 \n\
18074
1e27079409bf Rename function dir_in_path to dir_in_loadpath.
Rik <rik@octave.org>
parents: 18070
diff changeset
578 @seealso{file_in_loadpath, file_in_path, dir_in_loadpath, stat}\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
579 @end deftypefn")
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
580 {
4233
ccfdb55c8156 [project @ 2002-12-20 22:43:54 by jwe]
jwe
parents: 4224
diff changeset
581 octave_value retval = false;
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
582
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
583 int nargin = args.length ();
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
584
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
585 if (nargin < 1 || nargin > 2)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
586 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
587
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
588 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
589
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
590 if (nargin == 2)
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
591 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
592 std::string type = args(1).xstring_value ("exist: TYPE must be a string");
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
593
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
594 if (type == "class")
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
595 warning ("exist: \"class\" type argument is not implemented");
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
596
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
597 retval = symbol_exist (name, type);
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
598 }
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
599 else
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
600 retval = symbol_exist (name);
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
601
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
602 return retval;
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
603 }
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
604
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
605 /*
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
606 %!shared dirtmp, __var1
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
607 %! dirtmp = P_tmpdir ();
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
608 %! __var1 = 1;
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
609
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
610 %!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
611 %!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
612 %!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
613 %!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
614 %!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
615 %!assert (exist ("__var1", "file"), 0)
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
616
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
617 %!test
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
618 %! if (isunix ())
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
619 %! assert (exist ("/bin/sh"), 2);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
620 %! assert (exist ("/bin/sh", "file"), 2);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
621 %! assert (exist ("/bin/sh", "dir"), 0);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
622 %! assert (exist ("/dev/null"), 2);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
623 %! assert (exist ("/dev/null", "file"), 2);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
624 %! assert (exist ("/dev/null", "dir"), 0);
14429
eff4a5933e28 Update %!tests in src/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14366
diff changeset
625 %! endif
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
626
19750
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
627 %!assert (exist ("print_usage"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
628 %!assert (exist ("print_usage.m"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
629 %!assert (exist ("print_usage", "file"), 2)
2111917d34c4 fix tests failing after changeset c913247c85a8
John W. Eaton <jwe@octave.org>
parents: 19743
diff changeset
630 %!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
631
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
632 ## Don't search path for rooted relative filenames
19915
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
633 %!assert (exist ("plot.m", "file"), 2);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
634 %!assert (exist ("./plot.m", "file"), 0);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
635 %!assert (exist ("./%nonexistentfile%", "file"), 0);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
636 %!assert (exist ("%nonexistentfile%", "file"), 0);
20181
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20178
diff changeset
637
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
638 ## 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
639 %!test
20181
aa36fb998a4d maint: Remove unnecessary whitespace at end of lines.
Rik <rik@octave.org>
parents: 20178
diff changeset
640 %! tname = tempname (pwd ());
19915
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
641 %! unwind_protect
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
642 %! ## 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
643 %! fid = fopen (tname, "w");
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
644 %! fclose (fid);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
645 %! [~, fname] = fileparts (tname);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
646 %! assert (exist (fullfile (pwd (), fname), "file"), 2);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
647 %! unwind_protect_cleanup
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
648 %! unlink (tname);
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
649 %! end_unwind_protect
85c5a81c6ddd Rewrite BIST tests for exist to pass on Windows (bug #44445).
Rik <rik@octave.org>
parents: 19864
diff changeset
650 %! 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
651
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
652 %!testif HAVE_CHOLMOD
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
653 %! assert (exist ("chol"), 3);
18858
a1dde4d4c45c Return correct exist code for mex files when .mex extension given (bug #42614).
Rik <rik@octave.org>
parents: 18856
diff changeset
654 %! assert (exist ("chol.oct"), 3);
18856
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
655 %! assert (exist ("chol", "file"), 3);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
656 %! assert (exist ("chol", "builtin"), 0);
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
657
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
658 %!assert (exist ("sin"), 5)
18861
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
659 %!assert (exist ("sin", "builtin"), 5)
da6ffbf75edf Simplify exist() code for recognizing command line functions.
Rik <rik@octave.org>
parents: 18858
diff changeset
660 %!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
661
de8c67ba7ac4 Use Matlab return hierarchy for exist() codes when no type is specified.
Rik <rik@octave.org>
parents: 18282
diff changeset
662 %!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
663 %!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
664 %!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
665
18880
ca0d9844dfd7 Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents: 18879
diff changeset
666 %!error exist ()
ca0d9844dfd7 Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents: 18879
diff changeset
667 %!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
668 %!warning <"class" type argument is not implemented> exist ("a", "class");
ca0d9844dfd7 Fix input validation for exist() which did not error on non-string input.
Rik <rik@octave.org>
parents: 18879
diff changeset
669 %!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
670 %!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
671 %!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
672
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
673 */
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
674
2849
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
675 octave_value
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4962
diff changeset
676 lookup_function_handle (const std::string& nm)
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4962
diff changeset
677 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
678 octave_value val = symbol_table::varval (nm);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
679
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
680 return val.is_function_handle () ? val : octave_value ();
4988
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4962
diff changeset
681 }
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4962
diff changeset
682
352d228d409b [project @ 2004-09-11 13:05:38 by jwe]
jwe
parents: 4962
diff changeset
683 octave_value
5027
da607e9daf12 [project @ 2004-09-23 01:37:57 by jwe]
jwe
parents: 5004
diff changeset
684 get_global_value (const std::string& nm, bool silent)
2849
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
685 {
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
686 octave_value val = symbol_table::global_varval (nm);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
687
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
688 if (val.is_undefined () && ! silent)
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
689 error ("get_global_value: undefined symbol '%s'", nm.c_str ());
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
690
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
691 return val;
2849
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
692 }
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
693
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
694 void
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
695 set_global_value (const std::string& nm, const octave_value& val)
2849
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
696 {
16442
302157614308 deprecate symbol_table::varref functions
John W. Eaton <jwe@octave.org>
parents: 15807
diff changeset
697 symbol_table::global_assign (nm, val);
2849
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
698 }
5338beb20eb9 [project @ 1997-03-28 21:33:27 by jwe]
jwe
parents: 2847
diff changeset
699
10071
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
700 octave_value
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
701 get_top_level_value (const std::string& nm, bool silent)
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
702 {
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
703 octave_value val = symbol_table::top_level_varval (nm);
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
704
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
705 if (val.is_undefined () && ! silent)
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
706 error ("get_top_level_value: undefined symbol '%s'", nm.c_str ());
10071
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
707
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
708 return val;
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
709 }
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
710
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
711 void
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
712 set_top_level_value (const std::string& nm, const octave_value& val)
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
713 {
16442
302157614308 deprecate symbol_table::varref functions
John W. Eaton <jwe@octave.org>
parents: 15807
diff changeset
714 symbol_table::top_level_assign (nm, val);
10071
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
715 }
e42b1bbd1052 variables.cc (get_top_level_value, set_top_level_value): new functions
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
716
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
717 // Variable values.
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
718
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
719 static bool
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
720 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
721 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
722 bool retval = false;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
723
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
724 if (nargin == 2)
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
725 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
726 if (args(1).is_string () && args(1).string_value () == "local")
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
727 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
728 nargin = 1;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
729 retval = true;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
730 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
731 else
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
732 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
733 error_with_cfn ("second argument must be \"local\"");
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
734 nargin = 0;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
735 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
736 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
737
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
738 return retval;
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
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
741 template <class T>
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
742 bool try_local_protect (T& var)
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
743 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
744 octave_user_code *curr_usr_code = octave_call_stack::caller_user_code ();
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
745 octave_user_function *curr_usr_fcn = 0;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
746 if (curr_usr_code && curr_usr_code->is_user_function ())
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
747 curr_usr_fcn = dynamic_cast<octave_user_function *> (curr_usr_code);
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
748
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
749 if (curr_usr_fcn && curr_usr_fcn->local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
750 return true;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
751 else
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
752 return false;
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
753 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
754
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
755 octave_value
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
756 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
757 int nargout, const char *nm)
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
758 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
759 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
760
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
761 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
762
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
763 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
764 retval = var;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
765
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
766 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
767 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
768 if (! try_local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
769 warning ("\"local\" has no effect outside a function");
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
770 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
771
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
772 if (nargin == 1)
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
773 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
774 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
775
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
776 var = bval;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
777 }
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
778 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5814
diff changeset
779 print_usage ();
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
780
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
781 return retval;
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
782 }
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
783
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
784 octave_value
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
785 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
786 int nargout, const char *nm)
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
787 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
788 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
789
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
790 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
791
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
792 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
793 retval = var;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
794
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
795 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
796 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
797 if (! try_local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
798 warning ("\"local\" has no effect outside a function");
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
799 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
800
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
801 if (nargin == 1)
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
802 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
803 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
804
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
805 switch (sval.length ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
806 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
807 case 1:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
808 var = sval[0];
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
809 break;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
810
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
811 case 0:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
812 var = '\0';
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
813 break;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
814
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
815 default:
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
816 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
817 break;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
818 }
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
819 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
820 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5814
diff changeset
821 print_usage ();
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
822
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
823 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
824 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
825
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
826 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
827 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
828 int nargout, const char *nm,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
829 int minval, int maxval)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
830 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
831 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
832
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
833 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
834
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
835 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
836 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
837
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
838 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
839 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
840 if (! try_local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
841 warning ("\"local\" has no effect outside a function");
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
842 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
843
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
844 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
845 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
846 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
847
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
848 if (ival < minval)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
849 error ("%s: arg must be greater than %d", nm, minval);
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
850 else if (ival > maxval)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
851 error ("%s: arg must be less than or equal to %d",
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
852 nm, maxval);
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
853 else
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
854 var = ival;
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
855 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
856 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5814
diff changeset
857 print_usage ();
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
858
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
859 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
860 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
861
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
862 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
863 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
864 int nargout, const char *nm,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
865 double minval, double maxval)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
866 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
867 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
868
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
869 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
870
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
871 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
872 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
873
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
874 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
875 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
876 if (! try_local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
877 warning ("\"local\" has no effect outside a function");
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
878 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
879
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
880 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
881 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
882 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
883
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
884 if (dval < minval)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
885 error ("%s: argument must be greater than %g", minval);
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
886 else if (dval > maxval)
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
887 error ("%s: argument must be less than or equal to %g", maxval);
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
888 else
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20700
diff changeset
889 var = dval;
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
890 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
891 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5814
diff changeset
892 print_usage ();
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
893
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
894 return retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
895 }
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
896
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
897 octave_value
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
898 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
899 int nargout, const char *nm, bool empty_ok)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
900 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
901 octave_value retval;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
902
5800
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
903 int nargin = args.length ();
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
904
e8be7fe586f9 [project @ 2006-05-10 06:50:45 by jwe]
jwe
parents: 5794
diff changeset
905 if (nargout > 0 || nargin == 0)
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
906 retval = var;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
907
10637
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
908 if (wants_local_change (args, nargin))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
909 {
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
910 if (! try_local_protect (var))
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
911 warning ("\"local\" has no effect outside a function");
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
912 }
9cd5aa83fa62 implement 'local' parameter to pseudo-variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10521
diff changeset
913
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
914 if (nargin == 1)
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
915 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
916 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
917
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
918 if (empty_ok || ! sval.empty ())
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
919 var = sval;
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
920 else
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
921 error ("%s: value must not be empty", nm);
5791
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
922 }
70215aff5ccf [project @ 2006-05-04 18:38:45 by jwe]
jwe
parents: 5781
diff changeset
923 else if (nargin > 1)
5823
080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe]
jwe
parents: 5814
diff changeset
924 print_usage ();
1
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
925
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
926 return retval;
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
927 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe]
jwe
parents:
diff changeset
928
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
929 octave_value
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
930 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
931 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
932 {
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
933 octave_value retval;
10640
5c594472f75e determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents: 10638
diff changeset
934 int nchoices = 0;
5c594472f75e determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents: 10638
diff changeset
935 while (choices[nchoices] != 0)
5c594472f75e determine string enum length by trailing null rather than sizeof
Jaroslav Hajek <highegg@gmail.com>
parents: 10638
diff changeset
936 nchoices++;
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
937
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
938 int nargin = args.length ();
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
939
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
940 assert (var < nchoices);
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
941
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
942 if (nargout > 0 || nargin == 0)
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
943 retval = choices[var];
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
944
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
945 if (wants_local_change (args, nargin))
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
946 {
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
947 if (! try_local_protect (var))
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
948 warning ("\"local\" has no effect outside a function");
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
949 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
950
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
951 if (nargin == 1)
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
952 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
953 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
954
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
955 int i = 0;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
956 for (; i < nchoices; i++)
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
957 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
958 if (sval == choices[i])
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
959 {
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
960 var = i;
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
961 break;
10638
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
962 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
963 }
20581
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
964 if (i == nchoices)
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
965 error ("%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
966 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
967 else if (nargin > 1)
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
968 print_usage ();
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
969
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
970 return retval;
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
971 }
e1559a8a60b4 general mechanism for string enum variables
Jaroslav Hajek <highegg@gmail.com>
parents: 10637
diff changeset
972
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
973 struct
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
974 whos_parameter
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
975 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
976 char command;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
977 char modifier;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
978 int parameter_length;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
979 int first_parameter_length;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
980 int balance;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
981 std::string text;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
982 std::string line;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
983 };
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
984
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
985 static void
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
986 print_descriptor (std::ostream& os, std::list<whos_parameter> params)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
987 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
988 // This method prints a line of information on a given symbol
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
989 std::list<whos_parameter>::iterator i = params.begin ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
990 std::ostringstream param_buf;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
991
17818
f1b59ef34eda attempt to avoid setting persistent state on i/o streams (bug #40396)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
992 octave_preserve_stream_state stream_state (os);
f1b59ef34eda attempt to avoid setting persistent state on i/o streams (bug #40396)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
993
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
994 while (i != params.end ())
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
995 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
996 whos_parameter param = *i;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
997
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
998 if (param.command != '\0')
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
999 {
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1000 // Do the actual printing
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1001 switch (param.modifier)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1002 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1003 case 'l':
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1004 os << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1005 << std::setw (param.parameter_length);
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1006 param_buf << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1007 << std::setw (param.parameter_length);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1008 break;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1009
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1010 case 'r':
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1011 os << std::setiosflags (std::ios::right)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1012 << std::setw (param.parameter_length);
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1013 param_buf << std::setiosflags (std::ios::right)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1014 << std::setw (param.parameter_length);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1015 break;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1016
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1017 case 'c':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1018 if (param.command != 's')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1019 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1020 os << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1021 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1022 param_buf << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1023 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1024 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1025 break;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1026
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1027 default:
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1028 os << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1029 << std::setw (param.parameter_length);
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1030 param_buf << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1031 << std::setw (param.parameter_length);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1032 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1033
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1034 if (param.command == 's' && param.modifier == 'c')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1035 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1036 int a, b;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1037
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1038 if (param.modifier == 'c')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1039 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1040 a = param.first_parameter_length - param.balance;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1041 a = (a < 0 ? 0 : a);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1042 b = param.parameter_length - a - param.text . length ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1043 b = (b < 0 ? 0 : b);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1044 os << std::setiosflags (std::ios::left) << std::setw (a)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1045 << "" << std::resetiosflags (std::ios::left) << param.text
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1046 << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1047 << std::setw (b) << ""
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1048 << std::resetiosflags (std::ios::left);
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1049 param_buf << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1050 << std::setw (a)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1051 << "" << std::resetiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1052 << param.line
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1053 << std::setiosflags (std::ios::left)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1054 << std::setw (b) << ""
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1055 << std::resetiosflags (std::ios::left);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1056 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1057 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1058 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1059 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1060 os << param.text;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1061 param_buf << param.line;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1062 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1063 os << std::resetiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1064 << std::resetiosflags (std::ios::right);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1065 param_buf << std::resetiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1066 << std::resetiosflags (std::ios::right);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1067 i++;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1068 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1069 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1070 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1071 os << param.text;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1072 param_buf << param.line;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1073 i++;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1074 }
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
1075 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1076
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1077 os << param_buf.str ();
195
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
1078 }
13c6086c325c [project @ 1993-11-06 10:12:29 by jwe]
jwe
parents: 191
diff changeset
1079
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1080 // FIXME: This is a bit of a kluge. We'd like to just use val.dims()
9704
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1081 // and if val is an object, expect that dims will call size if it is
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1082 // overloaded by a user-defined method. But there are currently some
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1083 // unresolved const issues that prevent that solution from working.
19718
675d92e7d507 Temporary workaround for user-defined object sizes reported as 1x1 in GUI (bug #43096)
Colin Macdonald <cbm@m.fsf.org>
parents: 19697
diff changeset
1084 // This same kluge is done in symtab.cc (do_workspace_info), fix there too.
9704
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1085
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1086 std::string
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1087 get_dims_str (const octave_value& val)
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1088 {
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1089 octave_value tmp = val;
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1090
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1091 Matrix sz = tmp.size ();
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1092
10350
12884915a8e4 merge MArray classes & improve Array interface
Jaroslav Hajek <highegg@gmail.com>
parents: 10315
diff changeset
1093 dim_vector dv = dim_vector::alloc (sz.numel ());
9704
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1094
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1095 for (octave_idx_type i = 0; i < dv.length (); i++)
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1096 dv(i) = sz(i);
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1097
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1098 return dv.str ();
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1099 }
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1100
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1101 class
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1102 symbol_info_list
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1103 {
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1104 private:
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1105 struct symbol_info
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1106 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1107 symbol_info (const symbol_table::symbol_record& sr,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1108 const std::string& expr_str = std::string (),
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1109 const octave_value& expr_val = octave_value ())
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1110 : name (expr_str.empty () ? sr.name () : expr_str),
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1111 varval (expr_val.is_undefined () ? sr.varval () : expr_val),
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1112 is_automatic (sr.is_automatic ()),
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1113 is_complex (varval.is_complex_type ()),
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1114 is_formal (sr.is_formal ()),
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1115 is_global (sr.is_global ()),
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1116 is_persistent (sr.is_persistent ())
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1117 { }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1118
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1119 void display_line (std::ostream& os,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1120 const std::list<whos_parameter>& params) const
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1121 {
9704
bb413c0d0d6d whos: kluge fix to get size right for objects
John W. Eaton <jwe@octave.org>
parents: 9454
diff changeset
1122 std::string dims_str = get_dims_str (varval);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1123
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1124 std::list<whos_parameter>::const_iterator i = params.begin ();
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1125
17818
f1b59ef34eda attempt to avoid setting persistent state on i/o streams (bug #40396)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
1126 octave_preserve_stream_state stream_state (os);
f1b59ef34eda attempt to avoid setting persistent state on i/o streams (bug #40396)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
1127
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1128 while (i != params.end ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1129 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1130 whos_parameter param = *i;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1131
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1132 if (param.command != '\0')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1133 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1134 // Do the actual printing.
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1135
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1136 switch (param.modifier)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1137 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1138 case 'l':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1139 os << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1140 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1141 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1142
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1143 case 'r':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1144 os << std::setiosflags (std::ios::right)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1145 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1146 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1147
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1148 case 'c':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1149 if (param.command == 's')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1150 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1151 int front = param.first_parameter_length
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1152 - dims_str.find ('x');
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1153 int back = param.parameter_length
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1154 - dims_str.length ()
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1155 - front;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1156 front = (front > 0) ? front : 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1157 back = (back > 0) ? back : 0;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1158
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1159 os << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1160 << std::setw (front)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1161 << ""
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1162 << std::resetiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1163 << dims_str
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1164 << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1165 << std::setw (back)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1166 << ""
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1167 << std::resetiosflags (std::ios::left);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1168 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1169 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1170 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1171 os << std::setiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1172 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1173 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1174 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1175
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1176 default:
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
1177 error ("whos_line_format: modifier '%c' unknown",
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1178 param.modifier);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1179
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1180 os << std::setiosflags (std::ios::right)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1181 << std::setw (param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1182 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1183
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1184 switch (param.command)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1185 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1186 case 'a':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1187 {
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1188 char tmp[6];
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1189
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1190 tmp[0] = (is_automatic ? 'a' : ' ');
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1191 tmp[1] = (is_complex ? 'c' : ' ');
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1192 tmp[2] = (is_formal ? 'f' : ' ');
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1193 tmp[3] = (is_global ? 'g' : ' ');
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1194 tmp[4] = (is_persistent ? 'p' : ' ');
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1195 tmp[5] = 0;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1196
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1197 os << tmp;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1198 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1199 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1200
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1201 case 'b':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1202 os << varval.byte_size ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1203 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1204
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1205 case 'c':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1206 os << varval.class_name ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1207 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1208
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1209 case 'e':
20229
5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax().
Carnë Draug <carandraug@octave.org>
parents: 20206
diff changeset
1210 os << varval.numel ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1211 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1212
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1213 case 'n':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1214 os << name;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1215 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1216
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1217 case 's':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1218 if (param.modifier != 'c')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1219 os << dims_str;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1220 break;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1221
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1222 case 't':
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1223 os << varval.type_name ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1224 break;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1225
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1226 default:
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
1227 error ("whos_line_format: command '%c' unknown",
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1228 param.command);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1229 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1230
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1231 os << std::resetiosflags (std::ios::left)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1232 << std::resetiosflags (std::ios::right);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1233 i++;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1234 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1235 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1236 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1237 os << param.text;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1238 i++;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1239 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1240 }
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1241 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1242
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1243 std::string name;
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1244 octave_value varval;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1245 bool is_automatic;
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1246 bool is_complex;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1247 bool is_formal;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1248 bool is_global;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1249 bool is_persistent;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1250 };
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1251
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1252 public:
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1253 symbol_info_list (void) : lst () { }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1254
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1255 symbol_info_list (const symbol_info_list& sil) : lst (sil.lst) { }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1256
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1257 symbol_info_list& operator = (const symbol_info_list& sil)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1258 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1259 if (this != &sil)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1260 lst = sil.lst;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1261
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1262 return *this;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1263 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1264
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1265 ~symbol_info_list (void) { }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1266
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1267 void append (const symbol_table::symbol_record& sr)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1268 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1269 lst.push_back (symbol_info (sr));
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1270 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1271
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1272 void append (const symbol_table::symbol_record& sr,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1273 const std::string& expr_str,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1274 const octave_value& expr_val)
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1275 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1276 lst.push_back (symbol_info (sr, expr_str, expr_val));
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1277 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1278
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1279 size_t size (void) const { return lst.size (); }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1280
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1281 bool empty (void) const { return lst.empty (); }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1282
11069
e40e19761d06 variables.cc: Octave_map to octave_map and octave_scalar_map conversion
John W. Eaton <jwe@octave.org>
parents: 11029
diff changeset
1283 octave_map
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1284 map_value (const std::string& caller_function_name, int nesting_level) const
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1285 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1286 size_t len = lst.size ();
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1287
9732
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1288 Cell name_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1289 Cell size_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1290 Cell bytes_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1291 Cell class_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1292 Cell global_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1293 Cell sparse_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1294 Cell complex_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1295 Cell nesting_info (len, 1);
b4fdfee405b5 remove ArrayN<T> + fix nonhom. diag-scalar ops
Jaroslav Hajek <highegg@gmail.com>
parents: 9727
diff changeset
1296 Cell persistent_info (len, 1);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1297
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1298 std::list<symbol_info>::const_iterator p = lst.begin ();
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1299
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1300 for (size_t j = 0; j < len; j++)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1301 {
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1302 const symbol_info& si = *p++;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1303
11069
e40e19761d06 variables.cc: Octave_map to octave_map and octave_scalar_map conversion
John W. Eaton <jwe@octave.org>
parents: 11029
diff changeset
1304 octave_scalar_map ni;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1305
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1306 ni.assign ("function", caller_function_name);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1307 ni.assign ("level", nesting_level);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1308
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1309 name_info(j) = si.name;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1310 global_info(j) = si.is_global;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1311 persistent_info(j) = si.is_persistent;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1312
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1313 octave_value val = si.varval;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1314
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1315 size_info(j) = val.size ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1316 bytes_info(j) = val.byte_size ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1317 class_info(j) = val.class_name ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1318 sparse_info(j) = val.is_sparse_type ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1319 complex_info(j) = val.is_complex_type ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1320 nesting_info(j) = ni;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1321 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1322
11069
e40e19761d06 variables.cc: Octave_map to octave_map and octave_scalar_map conversion
John W. Eaton <jwe@octave.org>
parents: 11029
diff changeset
1323 octave_map info;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1324
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1325 info.assign ("name", name_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1326 info.assign ("size", size_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1327 info.assign ("bytes", bytes_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1328 info.assign ("class", class_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1329 info.assign ("global", global_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1330 info.assign ("sparse", sparse_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1331 info.assign ("complex", complex_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1332 info.assign ("nesting", nesting_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1333 info.assign ("persistent", persistent_info);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1334
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1335 return info;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1336 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1337
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1338 void display (std::ostream& os)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1339 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1340 if (! lst.empty ())
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1341 {
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1342 size_t bytes = 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1343 size_t elements = 0;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1344
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1345 std::list<whos_parameter> params = parse_whos_line_format ();
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1346
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1347 print_descriptor (os, params);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1348
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1349 octave_stdout << "\n";
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1350
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1351 for (std::list<symbol_info>::const_iterator p = lst.begin ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1352 p != lst.end (); p++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1353 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1354 p->display_line (os, params);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1355
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1356 octave_value val = p->varval;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1357
20229
5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax().
Carnë Draug <carandraug@octave.org>
parents: 20206
diff changeset
1358 elements += val.numel ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1359 bytes += val.byte_size ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1360 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1361
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1362 os << "\nTotal is " << elements
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1363 << (elements == 1 ? " element" : " elements")
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1364 << " using " << bytes << (bytes == 1 ? " byte" : " bytes")
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1365 << "\n";
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1366 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1367 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1368
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1369 // Parse the string whos_line_format, and return a parameter list,
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1370 // containing all information needed to print the given
20727
a5949b3d2332 Preface warning() messages with name of function when possible.
Rik <rik@octave.org>
parents: 20713
diff changeset
1371 // attributes of the symbols.
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1372 std::list<whos_parameter> parse_whos_line_format (void)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1373 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1374 int idx;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1375 size_t format_len = Vwhos_line_format.length ();
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1376 char garbage;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1377 std::list<whos_parameter> params;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1378
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1379 size_t bytes1;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1380 int elements1;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1381
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1382 std::string param_string = "abcenst";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1383 Array<int> param_length (dim_vector (param_string.length (), 1));
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1384 Array<std::string> param_names (dim_vector (param_string.length (), 1));
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1385 size_t pos_a, pos_b, pos_c, pos_e, pos_n, pos_s, pos_t;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1386
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1387 pos_a = param_string.find ('a'); // Attributes
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1388 pos_b = param_string.find ('b'); // Bytes
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1389 pos_c = param_string.find ('c'); // Class
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1390 pos_e = param_string.find ('e'); // Elements
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1391 pos_n = param_string.find ('n'); // Name
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1392 pos_s = param_string.find ('s'); // Size
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1393 pos_t = param_string.find ('t'); // Type
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1394
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1395 param_names(pos_a) = "Attr";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1396 param_names(pos_b) = "Bytes";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1397 param_names(pos_c) = "Class";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1398 param_names(pos_e) = "Elements";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1399 param_names(pos_n) = "Name";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1400 param_names(pos_s) = "Size";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1401 param_names(pos_t) = "Type";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1402
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1403 for (size_t i = 0; i < param_string.length (); i++)
14861
f7afecdd87ef maint: Use Octave coding conventions for cuddling parentheses in src/ directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
1404 param_length(i) = param_names(i).length ();
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1405
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1406 // The attribute column needs size 5.
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1407 param_length(pos_a) = 5;
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1408
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1409 // Calculating necessary spacing for name column,
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1410 // bytes column, elements column and class column
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1411
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1412 for (std::list<symbol_info>::const_iterator p = lst.begin ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1413 p != lst.end (); p++)
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1414 {
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1415 std::stringstream ss1, ss2;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1416 std::string str;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1417
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1418 str = p->name;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1419 param_length(pos_n) = ((str.length ()
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1420 > static_cast<size_t> (param_length(pos_n)))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1421 ? str.length () : param_length(pos_n));
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1422
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1423 octave_value val = p->varval;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1424
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1425 str = val.type_name ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1426 param_length(pos_t) = ((str.length ()
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1427 > static_cast<size_t> (param_length(pos_t)))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1428 ? str.length () : param_length(pos_t));
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1429
20229
5dfaaaae784f Deprecate Array::capacity() and Sparse::capacity() for numel() and nzmax().
Carnë Draug <carandraug@octave.org>
parents: 20206
diff changeset
1430 elements1 = val.numel ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1431 ss1 << elements1;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1432 str = ss1.str ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1433 param_length(pos_e) = ((str.length ()
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1434 > static_cast<size_t> (param_length(pos_e)))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1435 ? str.length () : param_length(pos_e));
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1436
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1437 bytes1 = val.byte_size ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1438 ss2 << bytes1;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1439 str = ss2.str ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1440 param_length(pos_b) = ((str.length ()
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1441 > static_cast<size_t> (param_length(pos_b)))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1442 ? str.length () : param_length (pos_b));
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1443 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1444
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1445 idx = 0;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1446 while (static_cast<size_t> (idx) < format_len)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1447 {
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1448 whos_parameter param;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1449 param.command = '\0';
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1450
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1451 if (Vwhos_line_format[idx] == '%')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1452 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1453 bool error_encountered = false;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1454 param.modifier = 'r';
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1455 param.parameter_length = 0;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1456
18100
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18074
diff changeset
1457 int a = 0;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18074
diff changeset
1458 int b = -1;
6a71e5030df5 Follow coding convention of defining and initializing only 1 variable per line in liboctinterp.
Rik <rik@octave.org>
parents: 18074
diff changeset
1459 int balance = 1;
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1460 unsigned int items;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1461 size_t pos;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1462 std::string cmd;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1463
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1464 // Parse one command from whos_line_format
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1465 cmd = Vwhos_line_format.substr (idx, Vwhos_line_format.length ());
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1466 pos = cmd.find (';');
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1467 if (pos != std::string::npos)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1468 cmd = cmd.substr (0, pos+1);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1469 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1470 error ("parameter without ; in whos_line_format");
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1471
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1472 idx += cmd.length ();
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1473
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1474 // FIXME: use iostream functions instead of sscanf!
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1475
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1476 if (cmd.find_first_of ("crl") != 1)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1477 items = sscanf (cmd.c_str (), "%c%c:%d:%d:%d;",
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1478 &garbage, &param.command, &a, &b, &balance);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1479 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1480 items = sscanf (cmd.c_str (), "%c%c%c:%d:%d:%d;",
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1481 &garbage, &param.modifier, &param.command,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1482 &a, &b, &balance) - 1;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1483
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1484 if (items < 2)
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
1485 error ("whos_line_format: parameter structure without command in whos_line_format");
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1486
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1487 // Insert data into parameter
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1488 param.first_parameter_length = 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1489 pos = param_string.find (param.command);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1490 if (pos != std::string::npos)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1491 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1492 param.parameter_length = param_length(pos);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1493 param.text = param_names(pos);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1494 param.line.assign (param_names(pos).length (), '=');
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1495
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1496 param.parameter_length = (a > param.parameter_length
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1497 ? a : param.parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1498 if (param.command == 's' && param.modifier == 'c' && b > 0)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1499 param.first_parameter_length = b;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1500 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1501 else
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
1502 error ("whos_line_format: '%c' is not a command",
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
1503 param.command);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1504
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1505 if (param.command == 's')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1506 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1507 // Have to calculate space needed for printing
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1508 // matrix dimensions Space needed for Size column is
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1509 // hard to determine in prior, because it depends on
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1510 // dimensions to be shown. That is why it is
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1511 // recalculated for each Size-command int first,
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1512 // rest = 0, total;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1513 int rest = 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1514 int first = param.first_parameter_length;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1515 int total = param.parameter_length;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1516
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1517 for (std::list<symbol_info>::const_iterator p = lst.begin ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1518 p != lst.end (); p++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1519 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1520 octave_value val = p->varval;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1521 std::string dims_str = get_dims_str (val);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1522 int first1 = dims_str.find ('x');
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1523 int total1 = dims_str.length ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1524 int rest1 = total1 - first1;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1525 rest = (rest1 > rest ? rest1 : rest);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1526 first = (first1 > first ? first1 : first);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1527 total = (total1 > total ? total1 : total);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1528 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1529
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1530 if (param.modifier == 'c')
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1531 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1532 if (first < balance)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1533 first += balance - first;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1534 if (rest + balance < param.parameter_length)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1535 rest += param.parameter_length - rest - balance;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1536
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1537 param.parameter_length = first + rest;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1538 param.first_parameter_length = first;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1539 param.balance = balance;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1540 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1541 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1542 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1543 param.parameter_length = total;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1544 param.first_parameter_length = 0;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1545 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1546 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1547 else if (param.modifier == 'c')
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
1548 error ("whos_line_format: modifier 'c' not available for command '%c'",
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20819
diff changeset
1549 param.command);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1550
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1551 // What happens if whos_line_format contains negative numbers
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1552 // at param_length positions?
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1553 param.balance = (b < 0 ? 0 : param.balance);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1554 param.first_parameter_length = (b < 0 ? 0 :
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1555 param.first_parameter_length);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1556 param.parameter_length = (a < 0
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1557 ? 0
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1558 : (param.parameter_length
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1559 < param_length(pos_s)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1560 ? param_length(pos_s)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1561 : param.parameter_length));
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1562
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1563 // Parameter will not be pushed into parameter list if ...
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1564 if (! error_encountered)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1565 params.push_back (param);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1566 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1567 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1568 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1569 // Text string, to be printed as it is ...
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1570 std::string text;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1571 size_t pos;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1572 text = Vwhos_line_format.substr (idx, Vwhos_line_format.length ());
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1573 pos = text.find ('%');
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1574 if (pos != std::string::npos)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1575 text = text.substr (0, pos);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1576
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1577 // Push parameter into list ...
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1578 idx += text.length ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1579 param.text=text;
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14429
diff changeset
1580 param.line.assign (text.length (), ' ');
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1581 params.push_back (param);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1582 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1583 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1584
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1585 return params;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1586 }
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1587
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1588 private:
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1589 std::list<symbol_info> lst;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1590
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1591 };
5659
960f4b9a26af [project @ 2006-03-10 15:35:20 by jwe]
jwe
parents: 5642
diff changeset
1592
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
1593 static octave_value
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1594 do_who (int argc, const string_vector& argv, bool return_list,
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1595 bool verbose = false, std::string msg = std::string ())
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1596 {
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
1597 octave_value retval;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1598
3523
b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe]
jwe
parents: 3476
diff changeset
1599 std::string my_name = argv[0];
584
4057f845c1ee [project @ 1994-08-07 04:40:03 by jwe]
jwe
parents: 581
diff changeset
1600
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1601 bool global_only = false;
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1602 bool have_regexp = false;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1603
1857
99d5b59cb855 [project @ 1996-02-04 08:02:58 by jwe]
jwe
parents: 1827
diff changeset
1604 int i;
99d5b59cb855 [project @ 1996-02-04 08:02:58 by jwe]
jwe
parents: 1827
diff changeset
1605 for (i = 1; i < argc; i++)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1606 {
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1607 if (argv[i] == "-file")
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1608 {
17861
870f3e12e163 maint: Use phrase "FIXME:" for problem areas in code.
Rik <rik@octave.org>
parents: 17818
diff changeset
1609 // FIXME: This is an inefficient manner to implement this as the
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1610 // variables are loaded in to a temporary context and then treated.
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1611 // It would be better to refecat symbol_info_list to not store the
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1612 // symbol records and then use it in load-save.cc (do_load) to
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1613 // implement this option there so that the variables are never
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1614 // stored at all.
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1615 if (i == argc - 1)
20713
2469d78a1d8b Consistently use 'filename' rather than 'file name' throughout code base.
Rik <rik@octave.org>
parents: 20711
diff changeset
1616 error ("whos: -file argument must be followed by a filename");
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1617 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1618 {
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 15007
diff changeset
1619 std::string nm = argv[i + 1];
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1620
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1621 unwind_protect frame;
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1622
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1623 // Set up temporary scope.
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1624
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1625 symbol_table::scope_id tmp_scope = symbol_table::alloc_scope ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1626 frame.add_fcn (symbol_table::erase_scope, tmp_scope);
9144
c6463412aebb eliminate symbol_table::scope_stack; fix scoping issue with evalin
John W. Eaton <jwe@octave.org>
parents: 9037
diff changeset
1627
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1628 symbol_table::set_scope (tmp_scope);
9144
c6463412aebb eliminate symbol_table::scope_stack; fix scoping issue with evalin
John W. Eaton <jwe@octave.org>
parents: 9037
diff changeset
1629
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1630 octave_call_stack::push (tmp_scope, 0);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1631 frame.add_fcn (octave_call_stack::pop);
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1632
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1633 frame.add_fcn (symbol_table::clear_variables);
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1634
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1635 feval ("load", octave_value (nm), 0);
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1636
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1637 std::string newmsg = std::string ("Variables in the file ")
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1638 + nm + ":\n\n";
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1639
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1640 retval = do_who (i, argv, return_list, verbose, newmsg);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1641 }
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1642
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1643 return retval;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1644 }
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1645 else if (argv[i] == "-regexp")
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1646 have_regexp = true;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1647 else if (argv[i] == "global")
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1648 global_only = true;
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
1649 else if (argv[i][0] == '-')
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
1650 warning ("%s: unrecognized option '%s'", my_name.c_str (),
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1651 argv[i].c_str ());
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1652 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1653 break;
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1654 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1655
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1656 int npats = argc - i;
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1657 string_vector pats;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1658 if (npats > 0)
3248
68259f410026 [project @ 1999-07-13 03:34:54 by jwe]
jwe
parents: 3239
diff changeset
1659 {
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1660 pats.resize (npats);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1661 for (int j = 0; j < npats; j++)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1662 pats[j] = argv[i+j];
3248
68259f410026 [project @ 1999-07-13 03:34:54 by jwe]
jwe
parents: 3239
diff changeset
1663 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1664 else
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1665 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1666 pats.resize (++npats);
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1667 pats[0] = "*";
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1668 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1669
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1670 symbol_info_list symbol_stats;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1671 std::list<std::string> symbol_names;
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1672
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1673 for (int j = 0; j < npats; j++)
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1674 {
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1675 std::string pat = pats[j];
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1676
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1677 if (have_regexp)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1678 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1679 std::list<symbol_table::symbol_record> tmp = global_only
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1680 ? symbol_table::regexp_global_variables (pat)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1681 : symbol_table::regexp_variables (pat);
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1682
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1683 for (std::list<symbol_table::symbol_record>::const_iterator
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1684 p = tmp.begin (); p != tmp.end (); p++)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1685 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1686 if (p->is_variable ())
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1687 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1688 if (verbose)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1689 symbol_stats.append (*p);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1690 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1691 symbol_names.push_back (p->name ());
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1692 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1693 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1694 }
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1695 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1696 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1697 size_t pos = pat.find_first_of (".({");
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1698
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1699 if (pos != std::string::npos && pos > 0)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1700 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1701 if (verbose)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1702 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1703 // NOTE: we can only display information for
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1704 // expressions based on global values if the variable is
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1705 // global in the current scope because we currently have
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1706 // no way of looking up the base value in the global
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1707 // scope and then evaluating the arguments in the
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1708 // current scope.
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1709
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1710 std::string base_name = pat.substr (0, pos);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1711
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1712 if (symbol_table::is_variable (base_name))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1713 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1714 symbol_table::symbol_record sr
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1715 = symbol_table::find_symbol (base_name);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1716
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1717 if (! global_only || sr.is_global ())
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1718 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1719 int parse_status;
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1720
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1721 octave_value expr_val
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1722 = eval_string (pat, true, parse_status);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1723
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
1724 symbol_stats.append (sr, pat, expr_val);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1725 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1726 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1727 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1728 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1729 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1730 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1731 std::list<symbol_table::symbol_record> tmp = global_only
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1732 ? symbol_table::glob_global_variables (pat)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1733 : symbol_table::glob_variables (pat);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1734
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1735 for (std::list<symbol_table::symbol_record>::const_iterator
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1736 p = tmp.begin (); p != tmp.end (); p++)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1737 {
9260
9c2349a51218 properly unmark forced variables
John W. Eaton <jwe@octave.org>
parents: 9250
diff changeset
1738 if (p->is_variable ())
9250
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1739 {
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1740 if (verbose)
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1741 symbol_stats.append (*p);
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1742 else
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1743 symbol_names.push_back (p->name ());
80c299c84796 don't print undefined symbols in who
Jaroslav Hajek <highegg@gmail.com>
parents: 9240
diff changeset
1744 }
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1745 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1746 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1747 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1748 }
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1749
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
1750 if (return_list)
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1751 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1752 if (verbose)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1753 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1754 std::string caller_function_name;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1755 octave_function *caller = octave_call_stack::caller ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1756 if (caller)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1757 caller_function_name = caller->name ();
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1758
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1759 retval = symbol_stats.map_value (caller_function_name, 1);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1760 }
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
1761 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1762 retval = Cell (string_vector (symbol_names));
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1763 }
7586
84122fb29c75 whos: handle index expressions
John W. Eaton <jwe@octave.org>
parents: 7531
diff changeset
1764 else if (! (symbol_stats.empty () && symbol_names.empty ()))
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1765 {
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1766 if (msg.length () == 0)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1767 if (global_only)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1768 octave_stdout << "Global variables:\n\n";
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1769 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1770 octave_stdout << "Variables in the current scope:\n\n";
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1771 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1772 octave_stdout << msg;
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1773
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1774 if (verbose)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1775 symbol_stats.display (octave_stdout);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1776 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1777 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1778 string_vector names (symbol_names);
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1779
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1780 names.list_in_columns (octave_stdout);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1781 }
4435
dd7af4fa1942 [project @ 2003-06-23 17:52:36 by jwe]
jwe
parents: 4357
diff changeset
1782
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1783 octave_stdout << "\n";
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1784 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1785
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1786 return retval;
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1787 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1788
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
1789 DEFUN (who, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1790 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1791 @deftypefn {} {} who\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1792 @deftypefnx {} {} who pattern @dots{}\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1793 @deftypefnx {} {} who option pattern @dots{}\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1794 @deftypefnx {} {C =} who (\"pattern\", @dots{})\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1795 List currently defined variables matching the given patterns.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1796 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1797 Valid pattern syntax is the same as described for the @code{clear} command.\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1798 If no patterns are supplied, all variables are listed.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1799 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1800 By default, only variables visible in the local scope are displayed.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1801 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1802 The following are valid options, but may not be combined.\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
1803 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
1804 @table @code\n\
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1805 @item global\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1806 List variables in the global scope rather than the current scope.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1807 \n\
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
1808 @item -regexp\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1809 The patterns are considered to be regular expressions when matching the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1810 variables to display. The same pattern syntax accepted by the @code{regexp}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1811 function is used.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1812 \n\
8131
10b63c4fd413 Add -file option to who/whos
David Bateman <dbateman@free.fr>
parents: 8083
diff changeset
1813 @item -file\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1814 The next argument is treated as a filename. All variables found within the\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1815 specified file are listed. No patterns are accepted when reading variables\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1816 from a file.\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
1817 @end table\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
1818 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1819 If called as a function, return a cell array of defined variable names\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1820 matching the given patterns.\n\
12546
39ca02387a32 Improve docstrings for a number of functions.
Rik <octave@nomad.inbox5.com>
parents: 12483
diff changeset
1821 @seealso{whos, isglobal, isvarname, exist, regexp}\n\
9724
f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros
Rik <rdrider0-list@yahoo.com>
parents: 9704
diff changeset
1822 @end deftypefn")
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1823 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1824 int argc = args.length () + 1;
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1825
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1826 string_vector argv = args.make_argv ("who");
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1827
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1828 return do_who (argc, argv, nargout == 1);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1829 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1830
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
1831 DEFUN (whos, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1832 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1833 @deftypefn {} {} whos\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1834 @deftypefnx {} {} whos pattern @dots{}\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1835 @deftypefnx {} {} whos option pattern @dots{}\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1836 @deftypefnx {} {S =} whos (\"pattern\", @dots{})\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1837 Provide detailed information on currently defined variables matching the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1838 given patterns.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1839 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1840 Options and pattern syntax are the same as for the @code{who} command.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1841 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1842 Extended information about each variable is summarized in a table with the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
1843 following default entries.\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1844 \n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1845 @table @asis\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1846 @item Attr\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1847 Attributes of the listed variable. Possible attributes are:\n\
14366
b76f0740940e doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
1848 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1849 @table @asis\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1850 @item blank\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1851 Variable in local scope\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1852 \n\
11556
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1853 @item @code{a}\n\
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1854 Automatic variable. An automatic variable is one created by the\n\
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1855 interpreter, for example @code{argn}.\n\
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1856 \n\
12651
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1857 @item @code{c}\n\
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1858 Variable of complex type.\n\
332bb3b9600e interpreter: Add new attribute 'complex' in whos (bug #32053)
Daniel Kraft <d@domob.eu>
parents: 12632
diff changeset
1859 \n\
11556
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1860 @item @code{f}\n\
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1861 Formal parameter (function argument).\n\
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1862 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1863 @item @code{g}\n\
11556
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1864 Variable with global scope.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1865 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1866 @item @code{p}\n\
11556
e582adc89d55 update whos help text
Michael Godfrey <godfrey@isl.stanford.edu>
parents: 11547
diff changeset
1867 Persistent variable.\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1868 @end table\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1869 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1870 @item Name\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1871 The name of the variable.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1872 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1873 @item Size\n\
11591
1d13679b587e Use @nospell macro on certain words in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 11590
diff changeset
1874 The logical size of the variable. A scalar is 1x1, a vector is\n\
1d13679b587e Use @nospell macro on certain words in docstrings.
Rik <octave@nomad.inbox5.com>
parents: 11590
diff changeset
1875 @nospell{1xN} or @nospell{Nx1}, a 2-D matrix is @nospell{MxN}.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1876 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1877 @item Bytes\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1878 The amount of memory currently used to store the variable.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
1879 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1880 @item Class\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1881 The class of the variable. Examples include double, single, char, uint16,\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1882 cell, and struct.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1883 @end table\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1884 \n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1885 The table can be customized to display more or less information through\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1886 the function @code{whos_line_format}.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1887 \n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1888 If @code{whos} is called as a function, return a struct array of defined\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1889 variable names matching the given patterns. Fields in the structure\n\
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12632
diff changeset
1890 describing each variable are: name, size, bytes, class, global, sparse,\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1891 complex, nesting, persistent.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
1892 @seealso{who, whos_line_format}\n\
9724
f22bbc5d56e9 Fix various incorrect usages of TeXinfo deffn and deftypefn macros
Rik <rdrider0-list@yahoo.com>
parents: 9704
diff changeset
1893 @end deftypefn")
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1894 {
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1895 int argc = args.length () + 1;
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1896
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1897 string_vector argv = args.make_argv ("whos");
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1898
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1899 return do_who (argc, argv, nargout == 1, true);
581
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1900 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe]
jwe
parents: 572
diff changeset
1901
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1902 // Defining variables.
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1903
1162
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1161
diff changeset
1904 void
2856
8c516da3c1f7 [project @ 1997-03-31 06:37:21 by jwe]
jwe
parents: 2849
diff changeset
1905 bind_ans (const octave_value& val, bool print)
1162
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1161
diff changeset
1906 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1907 static std::string ans = "ans";
1162
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1161
diff changeset
1908
2978
49de01238638 [project @ 1997-05-15 21:13:42 by jwe]
jwe
parents: 2975
diff changeset
1909 if (val.is_defined ())
49de01238638 [project @ 1997-05-15 21:13:42 by jwe]
jwe
parents: 2975
diff changeset
1910 {
7531
c9a476b1e664 correctly set ans for cs-lists and simplify printing them
John W. Eaton <jwe@octave.org>
parents: 7347
diff changeset
1911 if (val.is_cs_list ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1912 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1913 octave_value_list lst = val.list_value ();
7531
c9a476b1e664 correctly set ans for cs-lists and simplify printing them
John W. Eaton <jwe@octave.org>
parents: 7347
diff changeset
1914
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1915 for (octave_idx_type i = 0; i < lst.length (); i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1916 bind_ans (lst(i), print);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1917 }
7531
c9a476b1e664 correctly set ans for cs-lists and simplify printing them
John W. Eaton <jwe@octave.org>
parents: 7347
diff changeset
1918 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1919 {
16442
302157614308 deprecate symbol_table::varref functions
John W. Eaton <jwe@octave.org>
parents: 15807
diff changeset
1920 symbol_table::force_assign (ans, val);
7531
c9a476b1e664 correctly set ans for cs-lists and simplify printing them
John W. Eaton <jwe@octave.org>
parents: 7347
diff changeset
1921
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1922 if (print)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1923 val.print_with_name (octave_stdout, ans);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1924 }
2978
49de01238638 [project @ 1997-05-15 21:13:42 by jwe]
jwe
parents: 2975
diff changeset
1925 }
1162
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1161
diff changeset
1926 }
c210c5a25a48 [project @ 1995-02-27 17:36:16 by jwe]
jwe
parents: 1161
diff changeset
1927
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1928 void
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1929 bind_internal_variable (const std::string& fname, const octave_value& val)
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
1930 {
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1931 octave_value_list args;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1932
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1933 args(0) = val;
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1934
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
1935 feval (fname, args, 0);
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1936 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
1937
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1938 void
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1939 mlock (void)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1940 {
8083
16ab78b816bc variables.cc (mlock): lock current function
John W. Eaton <jwe@octave.org>
parents: 8021
diff changeset
1941 octave_function *fcn = octave_call_stack::current ();
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1942
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1943 if (fcn)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1944 fcn->lock ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1945 else
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1946 error ("mlock: invalid use outside a function");
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1947 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1948
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
1949 void
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1950 munlock (const std::string& nm)
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1951 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1952 octave_value val = symbol_table::find_function (nm);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1953
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1954 if (val.is_defined ())
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1955 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1956 octave_function *fcn = val.function_value ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1957
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1958 if (fcn)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1959 fcn->unlock ();
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1960 }
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1961 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1962
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1963 bool
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1964 mislocked (const std::string& nm)
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1965 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1966 bool retval = false;
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1967
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1968 octave_value val = symbol_table::find_function (nm);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1969
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1970 if (val.is_defined ())
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1971 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1972 octave_function *fcn = val.function_value ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1973
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1974 if (fcn)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
1975 retval = fcn->islocked ();
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1976 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1977
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1978 return retval;
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1979 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1980
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
1981 DEFUN (mlock, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
1982 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1983 @deftypefn {} {} mlock ()\n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
1984 Lock the current function into memory so that it can't be cleared.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
1985 @seealso{munlock, mislocked, persistent}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
1986 @end deftypefn")
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1987 {
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1988 octave_value_list retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1989
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1990 if (args.length () != 0)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1991 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1992
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1993 octave_function *fcn = octave_call_stack::caller ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1994
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1995 if (fcn)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1996 fcn->lock ();
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1997 else
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
1998 error ("mlock: invalid use outside a function");
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
1999
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2000 return retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2001 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2002
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
2003 DEFUN (munlock, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2004 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2005 @deftypefn {} {} munlock ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2006 @deftypefnx {} {} munlock (@var{fcn})\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2007 Unlock the named function @var{fcn}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2008 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2009 If no function is named then unlock the current function.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
2010 @seealso{mlock, mislocked, persistent}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
2011 @end deftypefn")
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2012 {
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2013 octave_value_list retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2014
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2015 int nargin = args.length ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2016
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2017 if (nargin > 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2018 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2019
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2020 if (nargin == 1)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2021 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
2022 std::string name = 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
2023
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
2024 munlock (name);
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2025 }
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2026 else
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2027 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2028 octave_function *fcn = octave_call_stack::caller ();
5743
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5685
diff changeset
2029
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5685
diff changeset
2030 if (fcn)
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2031 fcn->unlock ();
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2032 else
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2033 error ("munlock: invalid use outside a function");
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2034 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2035
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2036 return retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2037 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2038
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2039
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
2040 DEFUN (mislocked, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2041 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2042 @deftypefn {} {} mislocked ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2043 @deftypefnx {} {} mislocked (@var{fcn})\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2044 Return true if the named function @var{fcn} is locked.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2045 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2046 If no function is named then return true if the current function is locked.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
2047 @seealso{mlock, munlock, persistent}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5534
diff changeset
2048 @end deftypefn")
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2049 {
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2050 octave_value retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2051
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2052 int nargin = args.length ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2053
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2054 if (nargin > 1)
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2055 print_usage ();
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2056
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2057 if (nargin == 1)
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2058 {
20700
68e3a747ca02 rename octave_value value extractors that accept error message args
John W. Eaton <jwe@octave.org>
parents: 20581
diff changeset
2059 std::string name = 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
2060
fd0efcdb3718 use new string_value method to handle value extraction errors
John W. Eaton <jwe@octave.org>
parents: 20556
diff changeset
2061 retval = mislocked (name);
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2062 }
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2063 else
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2064 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2065 octave_function *fcn = octave_call_stack::caller ();
5743
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5685
diff changeset
2066
a527e0f77aa5 [project @ 2006-04-06 08:20:21 by jwe]
jwe
parents: 5685
diff changeset
2067 if (fcn)
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2068 retval = fcn->islocked ();
4319
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2069 else
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2070 error ("mislocked: invalid use outside a function");
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2071 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2072
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2073 return retval;
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2074 }
05973ead74eb [project @ 2003-02-13 21:03:04 by jwe]
jwe
parents: 4280
diff changeset
2075
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2076 // Deleting names from the symbol tables.
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2077
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2078 static inline bool
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11558
diff changeset
2079 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
2080 int argc, int idx, bool have_regexp = false)
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2081 {
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2082 bool retval = false;
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2083
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2084 for (int k = idx; k < argc; k++)
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2085 {
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2086 std::string patstr = argv[k];
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2087 if (! patstr.empty ())
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2088 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2089 if (have_regexp)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2090 {
14024
fc9f204faea0 refactor regexp (bug #34440)
John W. Eaton <jwe@octave.org>
parents: 13951
diff changeset
2091 if (is_regexp_match (patstr, nm))
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2092 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2093 retval = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2094 break;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2095 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2096 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2097 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2098 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2099 glob_match pattern (patstr);
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
2100
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2101 if (pattern.match (nm))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2102 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2103 retval = true;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2104 break;
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2105 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2106 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2107 }
3681
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2108 }
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2109
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2110 return retval;
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2111 }
df54d394acc0 [project @ 2000-06-26 17:46:58 by jwe]
jwe
parents: 3618
diff changeset
2112
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2113 static inline void
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2114 maybe_warn_exclusive (bool exclusive)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2115 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2116 if (exclusive)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2117 warning ("clear: ignoring --exclusive option");
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2118 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2119
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2120 static void
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2121 do_clear_functions (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
2122 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2123 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2124 if (idx == argc)
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2125 symbol_table::clear_functions ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2126 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2127 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2128 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2129 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2130 string_vector fcns = symbol_table::user_function_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2131
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20229
diff changeset
2132 int fcount = fcns.numel ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2133
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2134 for (int i = 0; i < fcount; i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2135 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2136 std::string nm = fcns[i];
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2137
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2138 if (! name_matches_any_pattern (nm, argv, argc, idx))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2139 symbol_table::clear_function (nm);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2140 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2141 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2142 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2143 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2144 while (idx < argc)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2145 symbol_table::clear_function_pattern (argv[idx++]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2146 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2147 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2148 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2149
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2150 static void
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2151 do_clear_globals (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
2152 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2153 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2154 if (idx == argc)
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2155 {
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2156 string_vector gvars = symbol_table::global_variable_names ();
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2157
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20229
diff changeset
2158 int gcount = gvars.numel ();
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2159
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2160 for (int i = 0; i < gcount; i++)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2161 symbol_table::clear_global (gvars[i]);
7752
40c428ea3408 initial implementation of dbup and dbdown
John W. Eaton <jwe@octave.org>
parents: 7626
diff changeset
2162 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2163 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2164 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2165 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2166 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2167 string_vector gvars = symbol_table::global_variable_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2168
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20229
diff changeset
2169 int gcount = gvars.numel ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2170
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2171 for (int i = 0; i < gcount; i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2172 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2173 std::string nm = gvars[i];
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2174
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2175 if (! name_matches_any_pattern (nm, argv, argc, idx))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2176 symbol_table::clear_global (nm);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2177 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2178 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2179 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2180 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2181 while (idx < argc)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2182 symbol_table::clear_global_pattern (argv[idx++]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2183 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2184 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2185 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2186
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2187 static void
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2188 do_clear_variables (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
2189 bool exclusive = false, bool have_regexp = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2190 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2191 if (idx == argc)
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2192 symbol_table::clear_variables ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2193 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2194 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2195 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2196 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2197 string_vector lvars = symbol_table::variable_names ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2198
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20229
diff changeset
2199 int lcount = lvars.numel ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2200
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2201 for (int i = 0; i < lcount; i++)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2202 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2203 std::string nm = lvars[i];
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2204
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2205 if (! name_matches_any_pattern (nm, argv, argc, idx, have_regexp))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2206 symbol_table::clear_variable (nm);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2207 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2208 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2209 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2210 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2211 if (have_regexp)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2212 while (idx < argc)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2213 symbol_table::clear_variable_regexp (argv[idx++]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2214 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2215 while (idx < argc)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2216 symbol_table::clear_variable_pattern (argv[idx++]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2217 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2218 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2219 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2220
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2221 static void
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2222 do_clear_symbols (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
2223 bool exclusive = false)
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2224 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2225 if (idx == argc)
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2226 symbol_table::clear_variables ();
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2227 else
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2228 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2229 if (exclusive)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2230 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2231 // 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
2232 // 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
2233 // 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
2234 // bit harder to do.
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2235
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2236 do_clear_variables (argv, argc, idx, exclusive);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2237 do_clear_functions (argv, argc, idx, exclusive);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2238 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2239 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2240 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2241 while (idx < argc)
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2242 symbol_table::clear_symbol_pattern (argv[idx++]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2243 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2244 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2245 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2246
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2247 static void
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2248 do_matlab_compatible_clear (const string_vector& argv, int argc, int idx)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2249 {
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2250 // This is supposed to be mostly Matlab compatible.
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2251
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2252 for (; idx < argc; idx++)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2253 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2254 if (argv[idx] == "all"
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2255 && ! symbol_table::is_local_variable ("all"))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2256 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2257 symbol_table::clear_all ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2258 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2259 else if (argv[idx] == "functions"
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2260 && ! symbol_table::is_local_variable ("functions"))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2261 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2262 do_clear_functions (argv, argc, ++idx);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2263 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2264 else if (argv[idx] == "global"
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2265 && ! symbol_table::is_local_variable ("global"))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2266 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2267 do_clear_globals (argv, argc, ++idx);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2268 }
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2269 else if (argv[idx] == "variables"
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2270 && ! symbol_table::is_local_variable ("variables"))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2271 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2272 symbol_table::clear_variables ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2273 }
9240
f27a8c07f0b2 clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents: 9180
diff changeset
2274 else if (argv[idx] == "classes"
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2275 && ! symbol_table::is_local_variable ("classes"))
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2276 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2277 symbol_table::clear_objects ();
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2278 octave_class::clear_exemplar_map ();
18282
87381dbbe25e Clear all var, functions, globals when clearing classes (bug #41229)
Rik <rik@octave.org>
parents: 18110
diff changeset
2279 symbol_table::clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2280 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2281 else
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2282 {
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2283 symbol_table::clear_symbol_pattern (argv[idx]);
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2284 }
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2285 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2286 }
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2287
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2288 #define CLEAR_OPTION_ERROR(cond) \
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2289 do \
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2290 { \
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2291 if (cond) \
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2292 print_usage (); \
4009
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2293 } \
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2294 while (0)
27e461aed956 [project @ 2002-07-31 09:33:03 by jwe]
jwe
parents: 3968
diff changeset
2295
8746
5dd06f19e9be handle commands in the lexer
John W. Eaton <jwe@octave.org>
parents: 8677
diff changeset
2296 DEFUN (clear, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2297 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2298 @deftypefn {} {} clear [options] pattern @dots{}\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2299 Delete the names matching the given patterns from the symbol table.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2300 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2301 The pattern may contain the following special characters:\n\
4016
139f5273d0f8 [project @ 2002-08-02 22:55:51 by jwe]
jwe
parents: 4010
diff changeset
2302 \n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2303 @table @code\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2304 @item ?\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2305 Match any single character.\n\
668
d63a1354f319 [project @ 1994-09-07 14:39:43 by jwe]
jwe
parents: 666
diff changeset
2306 \n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2307 @item *\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2308 Match zero or more characters.\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2309 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2310 @item [ @var{list} ]\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2311 Match the list of characters specified by @var{list}. If the first\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2312 character is @code{!} or @code{^}, match all characters except those\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2313 specified by @var{list}. For example, the pattern @samp{[a-zA-Z]} will\n\
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12632
diff changeset
2314 match all lowercase and uppercase alphabetic characters.\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2315 @end table\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2316 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2317 For example, the command\n\
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2318 \n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2319 @example\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2320 clear foo b*r\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2321 @end example\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2322 \n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2323 @noindent\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2324 clears the name @code{foo} and all names that begin with the letter\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2325 @code{b} and end with the letter @code{r}.\n\
668
d63a1354f319 [project @ 1994-09-07 14:39:43 by jwe]
jwe
parents: 666
diff changeset
2326 \n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2327 If @code{clear} is called without any arguments, all user-defined\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2328 variables (local and global) are cleared from the symbol table.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2329 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2330 If @code{clear} is called with at least one argument, only the visible\n\
3361
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2331 names matching the arguments are cleared. For example, suppose you have\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2332 defined a function @code{foo}, and then hidden it by performing the\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2333 assignment @code{foo = 2}. Executing the command @kbd{clear foo} once\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2334 will clear the variable definition and restore the definition of\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2335 @code{foo} as a function. Executing @kbd{clear foo} a second time will\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2336 clear the function definition.\n\
4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe]
jwe
parents: 3355
diff changeset
2337 \n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2338 The following options are available in both long and short form\n\
14366
b76f0740940e doc: Periodic grammar check of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14360
diff changeset
2339 \n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2340 @table @code\n\
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2341 @item -all, -a\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2342 Clear all local and global user-defined variables and all functions from the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2343 symbol table.\n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2344 \n\
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2345 @item -exclusive, -x\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2346 Clear the variables that don't match the following pattern.\n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2347 \n\
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2348 @item -functions, -f\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2349 Clear the function names and the built-in symbols names.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2350 \n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2351 @item -global, -g\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2352 Clear global symbol names.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2353 \n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2354 @item -variables, -v\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2355 Clear local variable names.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2356 \n\
9240
f27a8c07f0b2 clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents: 9180
diff changeset
2357 @item -classes, -c\n\
f27a8c07f0b2 clear -classes and support.
Robert T. Short <octave@phaselockedsystems.com>
parents: 9180
diff changeset
2358 Clears the class structure table and clears all objects.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2359 \n\
7779
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
2360 @item -regexp, -r\n\
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
2361 The arguments are treated as regular expressions as any variables that\n\
791231dac333 Add regexp matching to Fwho and Fclear
David Bateman <dbateman@free.fr>
parents: 7761
diff changeset
2362 match will be cleared.\n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2363 @end table\n\
15007
8f0e3c5bfa5f doc: Periodic grammarcheck of documentation
Rik <rik@octave.org>
parents: 14861
diff changeset
2364 \n\
12642
f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 12632
diff changeset
2365 With the exception of @code{exclusive}, all long options can be used\n\
7347
0fa079d04772 [project @ 2008-01-04 21:09:11 by jwe]
jwe
parents: 7336
diff changeset
2366 without the dash as well.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2367 @seealso{who, whos, exist}\n\
11547
e1851653d59c Eliminate @deffn macros.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
2368 @end deftypefn")
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2369 {
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
2370 int argc = args.length () + 1;
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2371
1968
a2e206524aa0 [project @ 1996-02-17 02:54:24 by jwe]
jwe
parents: 1957
diff changeset
2372 string_vector argv = args.make_argv ("clear");
1755
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe]
jwe
parents: 1742
diff changeset
2373
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2374 if (argc == 1)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2375 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2376 do_clear_globals (argv, argc, true);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2377 do_clear_variables (argv, argc, true);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2378
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2379 octave_link::clear_workspace ();
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2380 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2381 else
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2382 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2383 int idx = 0;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2384
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2385 bool clear_all = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2386 bool clear_functions = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2387 bool clear_globals = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2388 bool clear_variables = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2389 bool clear_objects = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2390 bool exclusive = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2391 bool have_regexp = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2392 bool have_dash_option = false;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2393
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2394 while (++idx < argc)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2395 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2396 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
2397 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2398 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2399
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2400 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2401 clear_all = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2402 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2403 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
2404 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2405 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2406 exclusive = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2407 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2408 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
2409 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2410 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2411
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2412 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2413 clear_functions = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2414 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2415 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
2416 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2417 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2418
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2419 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2420 clear_globals = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2421 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2422 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
2423 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2424 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2425
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2426 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2427 clear_variables = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2428 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2429 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
2430 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2431 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2432
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2433 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2434 clear_objects = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2435 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2436 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
2437 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2438 CLEAR_OPTION_ERROR (have_dash_option && ! exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2439
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2440 have_dash_option = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2441 have_regexp = true;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2442 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2443 else
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2444 break;
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2445 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2446
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2447 if (idx <= argc)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2448 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2449 if (! have_dash_option)
20897
9aad16a799c9 maint: Replace argc variable name with nargin in C++ code.
Rik <rik@octave.org>
parents: 20853
diff changeset
2450 do_matlab_compatible_clear (argv, argc, idx);
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2451 else
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2452 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2453 if (clear_all)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2454 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2455 maybe_warn_exclusive (exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2456
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2457 if (++idx < argc)
20897
9aad16a799c9 maint: Replace argc variable name with nargin in C++ code.
Rik <rik@octave.org>
parents: 20853
diff changeset
2458 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
2459
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2460 symbol_table::clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2461 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2462 else if (have_regexp)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2463 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2464 do_clear_variables (argv, argc, idx, exclusive, true);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2465 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2466 else if (clear_functions)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2467 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2468 do_clear_functions (argv, argc, idx, exclusive);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2469 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2470 else if (clear_globals)
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2471 {
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2472 do_clear_globals (argv, argc, idx, exclusive);
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2473 }
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2474 else if (clear_variables)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2475 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2476 do_clear_variables (argv, argc, idx, exclusive);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2477 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2478 else if (clear_objects)
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2479 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2480 symbol_table::clear_objects ();
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2481 octave_class::clear_exemplar_map ();
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2482 symbol_table::clear_all ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2483 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2484 else
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2485 {
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2486 do_clear_symbols (argv, argc, idx, exclusive);
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2487 }
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2488 }
20556
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2489
4bed806ee3d4 eliminate more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
2490 octave_link::set_workspace ();
10315
57a59eae83cc untabify src C++ source files
John W. Eaton <jwe@octave.org>
parents: 10160
diff changeset
2491 }
593
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2492 }
6f948c6251a9 [project @ 1994-08-09 04:29:10 by jwe]
jwe
parents: 584
diff changeset
2493
20897
9aad16a799c9 maint: Replace argc variable name with nargin in C++ code.
Rik <rik@octave.org>
parents: 20853
diff changeset
2494 return octave_value_list ();
529
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2495 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe]
jwe
parents: 506
diff changeset
2496
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2497 DEFUN (whos_line_format, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2498 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2499 @deftypefn {} {@var{val} =} whos_line_format ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2500 @deftypefnx {} {@var{old_val} =} whos_line_format (@var{new_val})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2501 @deftypefnx {} {} whos_line_format (@var{new_val}, \"local\")\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2502 Query or set the format string used by the command @code{whos}.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2503 \n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2504 A full format string is:\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
2505 @c Set example in small font to prevent overfull line\n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2506 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2507 @smallexample\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2508 %[modifier]<command>[:width[:left-min[:balance]]];\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2509 @end smallexample\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2510 \n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2511 The following command sequences are available:\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2512 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2513 @table @code\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2514 @item %a\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2515 Prints attributes of variables (g=global, p=persistent, f=formal parameter,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2516 a=automatic variable).\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2517 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2518 @item %b\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2519 Prints number of bytes occupied by variables.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2520 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2521 @item %c\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2522 Prints class names of variables.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2523 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2524 @item %e\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2525 Prints elements held by variables.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2526 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2527 @item %n\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2528 Prints variable names.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2529 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2530 @item %s\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2531 Prints dimensions of variables.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2532 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2533 @item %t\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2534 Prints type names of variables.\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2535 @end table\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2536 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2537 Every command may also have an alignment modifier:\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2538 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2539 @table @code\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2540 @item l\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2541 Left alignment.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2542 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2543 @item r\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2544 Right alignment (default).\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10640
diff changeset
2545 \n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2546 @item c\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2547 Column-aligned (only applicable to command %s).\n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2548 @end table\n\
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2549 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2550 The @code{width} parameter is a positive integer specifying the minimum\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2551 number of columns used for printing. No maximum is needed as the field will\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2552 auto-expand as required.\n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2553 \n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2554 The parameters @code{left-min} and @code{balance} are only available when the\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2555 column-aligned modifier is used with the command @samp{%s}.\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2556 @code{balance} specifies the column number within the field width which will\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2557 be aligned between entries. Numbering starts from 0 which indicates the\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2558 leftmost column. @code{left-min} specifies the minimum field width to the\n\
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2559 left of the specified balance column.\n\
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2560 \n\
20101
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19915
diff changeset
2561 The default format is:\n\
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19915
diff changeset
2562 \n\
e51473fdb622 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19915
diff changeset
2563 @qcode{\" %a:4; %ln:6; %cs:16:6:1; %rb:12; %lc:-1;@xbackslashchar{}n\"}\n\
13951
79aa00a94e9e doc: Document "local" option for configuration variables.
Rik <octave@nomad.inbox5.com>
parents: 13241
diff changeset
2564 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
2565 When called from inside a function with the @qcode{\"local\"} option, the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2566 variable is changed locally for the function and any subroutines it calls.\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
2567 The original variable value is restored when exiting the function.\n\
9304
b6235c6cfb83 Update documentation for 'who' family of functions.
Rik <rdrider0-list@yahoo.com>
parents: 9260
diff changeset
2568 @seealso{whos}\n\
5794
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
2569 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe]
jwe
parents: 5791
diff changeset
2570 {
7336
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe]
jwe
parents: 7065
diff changeset
2571 return SET_INTERNAL_VARIABLE (whos_line_format);
3016
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe]
jwe
parents: 3013
diff changeset
2572 }
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2573
15562
8ed107220a3e maint: Rename unimplemented.m to __unimplemented__.m.
Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
parents: 15528
diff changeset
2574 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
2575
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2576 DEFUN (missing_function_hook, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2577 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2578 @deftypefn {} {@var{val} =} missing_function_hook ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2579 @deftypefnx {} {@var{old_val} =} missing_function_hook (@var{new_val})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2580 @deftypefnx {} {} missing_function_hook (@var{new_val}, \"local\")\n\
12573
232a90612254 Add new section on parsing to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
2581 Query or set the internal variable that specifies the function to call when\n\
232a90612254 Add new section on parsing to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12546
diff changeset
2582 an unknown identifier is requested.\n\
13951
79aa00a94e9e doc: Document "local" option for configuration variables.
Rik <octave@nomad.inbox5.com>
parents: 13241
diff changeset
2583 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
2584 When called from inside a function with the @qcode{\"local\"} option, the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2585 variable is changed locally for the function and any subroutines it calls.\n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 16940
diff changeset
2586 The original variable value is restored when exiting the function.\n\
17756
9aff1c9fd70f doc: Add missing functions to manual.
Rik <rik@octave.org>
parents: 17744
diff changeset
2587 @seealso{missing_component_hook}\n\
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2588 @end deftypefn")
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2589 {
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2590 return SET_INTERNAL_VARIABLE (missing_function_hook);
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2591 }
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2592
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2593 void maybe_missing_function_hook (const std::string& name)
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2594 {
10444
537d9fbba9c0 don't call missing_function_hook inside try block
Jaroslav Hajek <highegg@gmail.com>
parents: 10443
diff changeset
2595 // Don't do this if we're handling errors.
537d9fbba9c0 don't call missing_function_hook inside try block
Jaroslav Hajek <highegg@gmail.com>
parents: 10443
diff changeset
2596 if (buffer_error_messages == 0 && ! Vmissing_function_hook.empty ())
10467
13c1f15c67fa guard against recursive calls of missing_function_hook
Jaroslav Hajek <highegg@gmail.com>
parents: 10444
diff changeset
2597 {
15528
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2598 octave_value val = symbol_table::find_function (Vmissing_function_hook);
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2599
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2600 if (val.is_defined ())
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2601 {
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2602 // Ensure auto-restoration.
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2603 unwind_protect frame;
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2604 frame.protect_var (Vmissing_function_hook);
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2605
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2606 // Clear the variable prior to calling the function.
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2607 const std::string func_name = Vmissing_function_hook;
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2608 Vmissing_function_hook.clear ();
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2609
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2610 // Call.
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2611 feval (func_name, octave_value (name));
8d2b3db8b5b0 Allow missing_function_hook to fail silently
Mike Miller <mtmiller@ieee.org>
parents: 15508
diff changeset
2612 }
10467
13c1f15c67fa guard against recursive calls of missing_function_hook
Jaroslav Hajek <highegg@gmail.com>
parents: 10444
diff changeset
2613 }
10443
34e51d4e199b implement smart warnings about missing Matlab functionality
Jaroslav Hajek <highegg@gmail.com>
parents: 10350
diff changeset
2614 }
11558
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2615
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2616 DEFUN (__varval__, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2617 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2618 @deftypefn {} {} __varval__ (@var{name})\n\
20760
15eefcabcb31 doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents: 20756
diff changeset
2619 Return the value of the variable @var{name} directly from the symbol table.\n\
11558
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2620 @end deftypefn")
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2621 {
20760
15eefcabcb31 doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents: 20756
diff changeset
2622 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
2623 print_usage ();
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2624
20760
15eefcabcb31 doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents: 20756
diff changeset
2625 std::string name = args(0).xstring_value ("__varval__: first argument must be a variable name");
15eefcabcb31 doc: Add docstring for internal function __varval__.
Rik <rik@octave.org>
parents: 20756
diff changeset
2626
20799
c349d4c91ce2 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20769
diff changeset
2627 return symbol_table::varval (args(0).string_value ());
11558
1e4dfc7a9487 use .argn. to store argument names for inputname function
John W. Eaton <jwe@octave.org>
parents: 11556
diff changeset
2628 }
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2629
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2630 static std::string Vmissing_component_hook;
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2631
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2632 DEFUN (missing_component_hook, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17756
diff changeset
2633 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2634 @deftypefn {} {@var{val} =} missing_component_hook ()\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2635 @deftypefnx {} {@var{old_val} =} missing_component_hook (@var{new_val})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
2636 @deftypefnx {} {} missing_component_hook (@var{new_val}, \"local\")\n\
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2637 Query or set the internal variable that specifies the function to call when\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2638 a component of Octave is missing.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2639 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2640 This can be useful for packagers that may split the Octave installation into\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2641 multiple sub-packages, for example, to provide a hint to users for how to\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2642 install the missing components.\n\
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2643 \n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2644 When called from inside a function with the @qcode{\"local\"} option, the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 20101
diff changeset
2645 variable is changed locally for the function and any subroutines it calls.\n\
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2646 The original variable value is restored when exiting the function.\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2647 \n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2648 The hook function is expected to be of the form\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2649 \n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2650 @example\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2651 @var{fcn} (@var{component})\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2652 @end example\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2653 \n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2654 Octave will call @var{fcn} with the name of the function that requires the\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2655 component and a string describing the missing component. The hook function\n\
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2656 should return an error message to be displayed.\n\
17756
9aff1c9fd70f doc: Add missing functions to manual.
Rik <rik@octave.org>
parents: 17744
diff changeset
2657 @seealso{missing_function_hook}\n\
17516
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2658 @end deftypefn")
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2659 {
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2660 return SET_INTERNAL_VARIABLE (missing_component_hook);
21656a949661 Add hook function to handle missing Octave components
Mike Miller <mtmiller@ieee.org>
parents: 17355
diff changeset
2661 }