annotate libinterp/corefcn/variables.cc @ 18899:a0fd65914811

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