|
1
|
1 /* |
|
|
2 |
|
2847
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
1
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
1315
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
1
|
20 |
|
|
21 */ |
|
|
22 |
|
240
|
23 #ifdef HAVE_CONFIG_H |
|
1192
|
24 #include <config.h> |
|
1
|
25 #endif |
|
|
26 |
|
1343
|
27 #include <cstdarg> |
|
1633
|
28 #include <cstring> |
|
1343
|
29 |
|
1728
|
30 #include <string> |
|
|
31 |
|
4051
|
32 #include "lo-sstream.h" |
|
|
33 |
|
1352
|
34 #include "defun.h" |
|
1
|
35 #include "error.h" |
|
3707
|
36 #include "input.h" |
|
1742
|
37 #include "pager.h" |
|
1352
|
38 #include "oct-obj.h" |
|
|
39 #include "utils.h" |
|
2370
|
40 #include "ov.h" |
|
3707
|
41 #include "ov-usr-fcn.h" |
|
|
42 #include "pt-pr-code.h" |
|
|
43 #include "pt-stmt.h" |
|
|
44 #include "toplev.h" |
|
|
45 #include "unwind-prot.h" |
|
2370
|
46 #include "variables.h" |
|
1
|
47 |
|
2174
|
48 // TRUE means that Octave will try to beep obnoxiously before printing |
|
|
49 // error messages. |
|
|
50 static bool Vbeep_on_error; |
|
|
51 |
|
3707
|
52 // TRUE means that Octave will try to enter the debugger when an error |
|
|
53 // is encountered. This will also inhibit printing of the normal |
|
|
54 // traceback message (you will only see the top-level error message). |
|
|
55 static bool Vdebug_on_error; |
|
|
56 |
|
|
57 // TRUE means that Octave will try to enter the debugger when a warning |
|
|
58 // is encountered. |
|
|
59 static bool Vdebug_on_warning; |
|
|
60 |
|
3935
|
61 // The text of the last error message. |
|
|
62 static std::string Vlast_error_message; |
|
|
63 |
|
3934
|
64 // The text of the last warning message. |
|
|
65 static std::string Vlast_warning_message; |
|
|
66 |
|
|
67 // The warning frequency for Matlab handle graphics backwards |
|
|
68 // compatibility warnings (currently not used). |
|
|
69 static std::string Vwarning_frequency = "once"; |
|
|
70 |
|
|
71 // The current warning state. Valid values are "on", "off", |
|
|
72 // "backtrace", or "debug". |
|
3935
|
73 std::string Vwarning_option = "backtrace"; |
|
3934
|
74 |
|
143
|
75 // Current error state. |
|
3935
|
76 // |
|
|
77 // Valid values: |
|
|
78 // |
|
|
79 // -2: an error has occurred, but don't print any messages. |
|
|
80 // -1: an error has occurred, we are printing a traceback |
|
|
81 // 0: no error |
|
|
82 // 1: an error has occurred |
|
|
83 // |
|
672
|
84 int error_state = 0; |
|
|
85 |
|
3489
|
86 // Current warning state. |
|
3935
|
87 // |
|
|
88 // Valid values: |
|
|
89 // |
|
|
90 // 0: no warning |
|
|
91 // 1: a warning has occurred |
|
|
92 // |
|
3489
|
93 int warning_state = 0; |
|
|
94 |
|
1489
|
95 // Tell the error handler whether to print messages, or just store |
|
|
96 // them for later. Used for handling errors in eval() and |
|
|
97 // the `unwind_protect' statement. |
|
4699
|
98 int buffer_error_messages = 0; |
|
1489
|
99 |
|
3815
|
100 // TRUE means error messages are turned off. |
|
|
101 bool discard_error_messages = false; |
|
|
102 |
|
4452
|
103 // TRUE means warning messages are turned off. |
|
|
104 bool discard_warning_messages = false; |
|
|
105 |
|
3811
|
106 // The message buffer. |
|
4051
|
107 static OSSTREAM *error_message_buffer = 0; |
|
143
|
108 |
|
4318
|
109 void |
|
|
110 reset_error_handler (void) |
|
|
111 { |
|
|
112 error_state = 0; |
|
|
113 warning_state = 0; |
|
4699
|
114 buffer_error_messages = 0; |
|
4318
|
115 discard_error_messages = false; |
|
|
116 } |
|
|
117 |
|
3491
|
118 // Warning messages are never buffered. |
|
|
119 |
|
|
120 static void |
|
|
121 vwarning (const char *name, const char *fmt, va_list args) |
|
|
122 { |
|
4452
|
123 if (discard_warning_messages) |
|
|
124 return; |
|
|
125 |
|
3491
|
126 flush_octave_stdout (); |
|
|
127 |
|
4051
|
128 OSSTREAM output_buf; |
|
3491
|
129 |
|
|
130 if (name) |
|
3761
|
131 output_buf << name << ": "; |
|
|
132 |
|
|
133 octave_vformat (output_buf, fmt, args); |
|
|
134 |
|
4051
|
135 output_buf << std::endl << OSSTREAM_ENDS; |
|
3491
|
136 |
|
3935
|
137 // XXX FIXME XXX -- we really want to capture the message before it |
|
|
138 // has all the formatting goop attached to it. We probably also |
|
|
139 // want just the message, not the traceback information. |
|
|
140 |
|
4051
|
141 std::string msg_string = OSSTREAM_STR (output_buf); |
|
3761
|
142 |
|
4051
|
143 OSSTREAM_FREEZE (output_buf); |
|
3934
|
144 |
|
3935
|
145 if (! warning_state) |
|
|
146 { |
|
|
147 // This is the first warning in a possible series. |
|
|
148 Vlast_warning_message = msg_string; |
|
|
149 } |
|
3934
|
150 |
|
3935
|
151 octave_diary << msg_string; |
|
|
152 |
|
|
153 std::cerr << msg_string; |
|
3491
|
154 } |
|
|
155 |
|
1
|
156 static void |
|
|
157 verror (const char *name, const char *fmt, va_list args) |
|
|
158 { |
|
3815
|
159 if (discard_error_messages) |
|
|
160 return; |
|
|
161 |
|
3585
|
162 if (! buffer_error_messages) |
|
|
163 flush_octave_stdout (); |
|
914
|
164 |
|
2174
|
165 bool to_beep_or_not_to_beep_p = Vbeep_on_error && ! error_state; |
|
1423
|
166 |
|
4051
|
167 OSSTREAM output_buf; |
|
1
|
168 |
|
2174
|
169 if (to_beep_or_not_to_beep_p) |
|
1423
|
170 output_buf << "\a"; |
|
3620
|
171 |
|
599
|
172 if (name) |
|
|
173 output_buf << name << ": "; |
|
3620
|
174 |
|
|
175 octave_vformat (output_buf, fmt, args); |
|
|
176 |
|
4051
|
177 output_buf << std::endl << OSSTREAM_ENDS; |
|
581
|
178 |
|
3935
|
179 // XXX FIXME XXX -- we really want to capture the message before it |
|
|
180 // has all the formatting goop attached to it. We probably also |
|
|
181 // want just the message, not the traceback information. |
|
|
182 |
|
4051
|
183 std::string msg_string = OSSTREAM_STR (output_buf); |
|
3935
|
184 |
|
4051
|
185 OSSTREAM_FREEZE (output_buf); |
|
3935
|
186 |
|
|
187 if (! error_state && name && ! strcmp (name, "error")) |
|
|
188 { |
|
|
189 // This is the first error in a possible series. |
|
|
190 Vlast_error_message = msg_string; |
|
|
191 } |
|
|
192 |
|
1489
|
193 if (buffer_error_messages) |
|
|
194 { |
|
3941
|
195 std::string tmp = msg_string; |
|
1489
|
196 |
|
|
197 if (! error_message_buffer) |
|
|
198 { |
|
4051
|
199 error_message_buffer = new OSSTREAM; |
|
1489
|
200 |
|
|
201 // XXX FIXME XXX -- this is ugly, but it prevents |
|
|
202 // |
|
4699
|
203 // eval ("error (\"msg\")", "error (lasterr ())"); |
|
1489
|
204 // |
|
|
205 // from printing `error: ' twice. Assumes that the NAME we |
|
|
206 // have been given doesn't contain `:'. |
|
|
207 |
|
3935
|
208 size_t pos = msg_string.find (':'); |
|
3162
|
209 |
|
3935
|
210 if (pos != NPOS && pos < Vlast_error_message.length () - 2) |
|
|
211 tmp = msg_string.substr (pos+2); |
|
1489
|
212 } |
|
|
213 |
|
3935
|
214 *error_message_buffer << tmp; |
|
1489
|
215 } |
|
|
216 else |
|
|
217 { |
|
3935
|
218 octave_diary << msg_string; |
|
|
219 std::cerr << msg_string; |
|
1489
|
220 } |
|
1
|
221 } |
|
|
222 |
|
1266
|
223 // Note that we don't actually print any message if the error string |
|
|
224 // is just "" or "\n". This allows error ("") and error ("\n") to |
|
|
225 // just set the error state. |
|
|
226 |
|
1005
|
227 static void |
|
|
228 error_1 (const char *name, const char *fmt, va_list args) |
|
|
229 { |
|
|
230 if (error_state != -2) |
|
|
231 { |
|
1489
|
232 if (fmt) |
|
1005
|
233 { |
|
1489
|
234 if (*fmt) |
|
1005
|
235 { |
|
1489
|
236 int len = strlen (fmt); |
|
|
237 if (fmt[len - 1] == '\n') |
|
1266
|
238 { |
|
1489
|
239 if (len > 1) |
|
1266
|
240 { |
|
1489
|
241 char *tmp_fmt = strsave (fmt); |
|
|
242 tmp_fmt[len - 1] = '\0'; |
|
|
243 verror (name, tmp_fmt, args); |
|
|
244 delete [] tmp_fmt; |
|
|
245 } |
|
1423
|
246 |
|
1489
|
247 error_state = -2; |
|
1266
|
248 } |
|
1489
|
249 else |
|
|
250 verror (name, fmt, args); |
|
1005
|
251 } |
|
|
252 } |
|
1489
|
253 else |
|
|
254 panic ("error_1: invalid format"); |
|
1423
|
255 |
|
|
256 if (! error_state) |
|
|
257 error_state = 1; |
|
1005
|
258 } |
|
|
259 } |
|
|
260 |
|
1
|
261 void |
|
|
262 message (const char *name, const char *fmt, ...) |
|
|
263 { |
|
|
264 va_list args; |
|
|
265 va_start (args, fmt); |
|
|
266 verror (name, fmt, args); |
|
|
267 va_end (args); |
|
|
268 } |
|
|
269 |
|
|
270 void |
|
|
271 usage (const char *fmt, ...) |
|
|
272 { |
|
|
273 va_list args; |
|
|
274 va_start (args, fmt); |
|
905
|
275 error_state = -1; |
|
1
|
276 verror ("usage", fmt, args); |
|
|
277 va_end (args); |
|
|
278 } |
|
|
279 |
|
3707
|
280 static void |
|
3719
|
281 pr_where_2 (const char *fmt, va_list args) |
|
|
282 { |
|
|
283 if (fmt) |
|
|
284 { |
|
|
285 if (*fmt) |
|
|
286 { |
|
|
287 int len = strlen (fmt); |
|
|
288 if (fmt[len - 1] == '\n') |
|
|
289 { |
|
|
290 if (len > 1) |
|
|
291 { |
|
|
292 char *tmp_fmt = strsave (fmt); |
|
|
293 tmp_fmt[len - 1] = '\0'; |
|
|
294 verror (0, tmp_fmt, args); |
|
|
295 delete [] tmp_fmt; |
|
|
296 } |
|
|
297 } |
|
|
298 else |
|
|
299 verror (0, fmt, args); |
|
|
300 } |
|
|
301 } |
|
|
302 else |
|
|
303 panic ("pr_where_2: invalid format"); |
|
|
304 } |
|
|
305 |
|
|
306 static void |
|
3707
|
307 pr_where_1 (const char *fmt, ...) |
|
|
308 { |
|
|
309 va_list args; |
|
|
310 va_start (args, fmt); |
|
3719
|
311 pr_where_2 (fmt, args); |
|
3707
|
312 va_end (args); |
|
|
313 } |
|
|
314 |
|
|
315 static void |
|
4719
|
316 pr_where (const char *name, bool print_code = true) |
|
3707
|
317 { |
|
|
318 if (curr_statement) |
|
|
319 { |
|
3708
|
320 const char *f_nm = 0; |
|
3707
|
321 |
|
3708
|
322 if (curr_function) |
|
|
323 { |
|
|
324 std::string fcn_name = curr_function->function_name (); |
|
|
325 std::string file_name = curr_function->fcn_file_name (); |
|
|
326 |
|
|
327 f_nm = file_name.empty () ? fcn_name.c_str () : file_name.c_str (); |
|
|
328 } |
|
3707
|
329 |
|
|
330 int l = curr_statement->line (); |
|
|
331 int c = curr_statement->column (); |
|
|
332 |
|
3708
|
333 if (f_nm) |
|
|
334 pr_where_1 ("%s: in %s near line %d, column %d:", name, f_nm, l, c); |
|
|
335 else |
|
|
336 pr_where_1 ("%s: near line %d, column %d:", name, l, c); |
|
3707
|
337 |
|
4719
|
338 if (print_code) |
|
|
339 { |
|
|
340 // XXX FIXME XXX -- Note that the column number is probably |
|
|
341 // not going to mean much here since the code is being |
|
|
342 // reproduced from the parse tree, and we are only showing |
|
|
343 // one statement even if there were multiple statements on |
|
|
344 // the original source line. |
|
3707
|
345 |
|
4719
|
346 OSSTREAM output_buf; |
|
3708
|
347 |
|
4719
|
348 output_buf << std::endl; |
|
3707
|
349 |
|
4719
|
350 tree_print_code tpc (output_buf, ">>> "); |
|
|
351 |
|
|
352 curr_statement->accept (tpc); |
|
3707
|
353 |
|
4719
|
354 output_buf << std::endl << OSSTREAM_ENDS; |
|
3707
|
355 |
|
4719
|
356 pr_where_1 ("%s", OSSTREAM_C_STR (output_buf)); |
|
3707
|
357 |
|
4719
|
358 OSSTREAM_FREEZE (output_buf); |
|
|
359 } |
|
3707
|
360 } |
|
|
361 } |
|
|
362 |
|
1
|
363 void |
|
|
364 warning (const char *fmt, ...) |
|
|
365 { |
|
3934
|
366 if (Vwarning_option != "off") |
|
|
367 { |
|
4014
|
368 if (curr_sym_tab != top_level_sym_tab |
|
|
369 && Vwarning_option == "backtrace" |
|
4452
|
370 && ! warning_state |
|
|
371 && ! discard_warning_messages) |
|
4719
|
372 pr_where ("warning", false); |
|
3986
|
373 |
|
3934
|
374 va_list args; |
|
|
375 va_start (args, fmt); |
|
|
376 vwarning ("warning", fmt, args); |
|
|
377 va_end (args); |
|
3707
|
378 |
|
3935
|
379 warning_state = 1; |
|
|
380 |
|
3934
|
381 if ((interactive || forced_interactive) |
|
|
382 && Vdebug_on_warning && curr_function) |
|
|
383 { |
|
|
384 unwind_protect_bool (Vdebug_on_warning); |
|
|
385 Vdebug_on_warning = false; |
|
3707
|
386 |
|
3934
|
387 do_keyboard (octave_value_list ()); |
|
3707
|
388 |
|
3934
|
389 unwind_protect::run (); |
|
|
390 } |
|
3707
|
391 } |
|
1
|
392 } |
|
|
393 |
|
|
394 void |
|
|
395 error (const char *fmt, ...) |
|
|
396 { |
|
3707
|
397 int init_state = error_state; |
|
|
398 |
|
1
|
399 va_list args; |
|
|
400 va_start (args, fmt); |
|
1005
|
401 error_1 ("error", fmt, args); |
|
|
402 va_end (args); |
|
3707
|
403 |
|
|
404 if ((interactive || forced_interactive) |
|
|
405 && Vdebug_on_error && init_state == 0 && curr_function) |
|
|
406 { |
|
|
407 unwind_protect_bool (Vdebug_on_error); |
|
|
408 Vdebug_on_error = false; |
|
|
409 |
|
3708
|
410 pr_where ("error"); |
|
3707
|
411 |
|
|
412 error_state = 0; |
|
|
413 |
|
|
414 do_keyboard (octave_value_list ()); |
|
|
415 |
|
|
416 unwind_protect::run (); |
|
|
417 } |
|
1005
|
418 } |
|
436
|
419 |
|
1005
|
420 void |
|
|
421 parse_error (const char *fmt, ...) |
|
|
422 { |
|
|
423 va_list args; |
|
|
424 va_start (args, fmt); |
|
|
425 error_1 (0, fmt, args); |
|
1
|
426 va_end (args); |
|
|
427 } |
|
|
428 |
|
189
|
429 void |
|
1
|
430 panic (const char *fmt, ...) |
|
|
431 { |
|
|
432 va_list args; |
|
|
433 va_start (args, fmt); |
|
4699
|
434 buffer_error_messages = 0; |
|
3815
|
435 discard_error_messages = false; |
|
1
|
436 verror ("panic", fmt, args); |
|
|
437 va_end (args); |
|
|
438 abort (); |
|
|
439 } |
|
|
440 |
|
1489
|
441 typedef void (*error_fun)(const char *, ...); |
|
|
442 |
|
2086
|
443 extern octave_value_list Fsprintf (const octave_value_list&, int); |
|
1489
|
444 |
|
3934
|
445 static std::string |
|
2086
|
446 handle_message (error_fun f, const char *msg, const octave_value_list& args) |
|
528
|
447 { |
|
3934
|
448 std::string retval; |
|
528
|
449 |
|
3523
|
450 std::string tstr; |
|
1728
|
451 |
|
528
|
452 int nargin = args.length (); |
|
|
453 |
|
2745
|
454 if (nargin > 0) |
|
528
|
455 { |
|
3066
|
456 octave_value arg; |
|
|
457 |
|
|
458 if (nargin > 1) |
|
|
459 { |
|
|
460 octave_value_list tmp = Fsprintf (args, 1); |
|
|
461 arg = tmp(0); |
|
|
462 } |
|
|
463 else |
|
|
464 arg = args(0); |
|
2745
|
465 |
|
|
466 if (arg.is_defined ()) |
|
528
|
467 { |
|
2745
|
468 if (arg.is_string ()) |
|
|
469 { |
|
|
470 tstr = arg.string_value (); |
|
|
471 msg = tstr.c_str (); |
|
|
472 |
|
|
473 if (! msg) |
|
|
474 return retval; |
|
|
475 } |
|
|
476 else if (arg.is_empty ()) |
|
528
|
477 return retval; |
|
|
478 } |
|
|
479 } |
|
|
480 |
|
1489
|
481 // Ugh. |
|
|
482 |
|
|
483 int len = strlen (msg); |
|
|
484 if (msg[len - 1] == '\n') |
|
|
485 { |
|
|
486 if (len > 1) |
|
|
487 { |
|
|
488 char *tmp_msg = strsave (msg); |
|
|
489 tmp_msg[len - 1] = '\0'; |
|
|
490 f ("%s\n", tmp_msg); |
|
3934
|
491 retval = tmp_msg; |
|
1489
|
492 delete [] tmp_msg; |
|
|
493 } |
|
|
494 } |
|
|
495 else |
|
3934
|
496 { |
|
|
497 f ("%s", msg); |
|
|
498 retval = msg; |
|
|
499 } |
|
528
|
500 |
|
|
501 return retval; |
|
|
502 } |
|
|
503 |
|
1957
|
504 DEFUN (error, args, , |
|
3373
|
505 "-*- texinfo -*-\n\ |
|
|
506 @deftypefn {Built-in Function} {} error (@var{template}, @dots{})\n\ |
|
|
507 The @code{error} function formats the optional arguments under the\n\ |
|
|
508 control of the template string @var{template} using the same rules as\n\ |
|
|
509 the @code{printf} family of functions (@pxref{Formatted Output}).\n\ |
|
|
510 The resulting message is prefixed by the string @samp{error: } and\n\ |
|
|
511 printed on the @code{stderr} stream.\n\ |
|
|
512 \n\ |
|
|
513 Calling @code{error} also sets Octave's internal error state such that\n\ |
|
|
514 control will return to the top level without evaluating any more\n\ |
|
|
515 commands. This is useful for aborting from functions or scripts.\n\ |
|
897
|
516 \n\ |
|
3373
|
517 If the error message does not end with a new line character, Octave will\n\ |
|
|
518 print a traceback of all the function calls leading to the error. For\n\ |
|
|
519 example, given the following function definitions:\n\ |
|
|
520 \n\ |
|
|
521 @example\n\ |
|
|
522 @group\n\ |
|
|
523 function f () g () end\n\ |
|
|
524 function g () h () end\n\ |
|
|
525 function h () nargin == 1 || error (\"nargin != 1\"); end\n\ |
|
|
526 @end group\n\ |
|
|
527 @end example\n\ |
|
1489
|
528 \n\ |
|
3373
|
529 @noindent\n\ |
|
|
530 calling the function @code{f} will result in a list of messages that\n\ |
|
|
531 can help you to quickly locate the exact location of the error:\n\ |
|
1489
|
532 \n\ |
|
3373
|
533 @example\n\ |
|
|
534 @group\n\ |
|
|
535 f ()\n\ |
|
|
536 error: nargin != 1\n\ |
|
|
537 error: evaluating index expression near line 1, column 30\n\ |
|
|
538 error: evaluating binary operator `||' near line 1, column 27\n\ |
|
|
539 error: called from `h'\n\ |
|
|
540 error: called from `g'\n\ |
|
|
541 error: called from `f'\n\ |
|
|
542 @end group\n\ |
|
|
543 @end example\n\ |
|
|
544 \n\ |
|
|
545 If the error message ends in a new line character, Octave will print the\n\ |
|
|
546 message but will not display any traceback messages as it returns\n\ |
|
|
547 control to the top level. For example, modifying the error message\n\ |
|
|
548 in the previous example to end in a new line causes Octave to only print\n\ |
|
|
549 a single message:\n\ |
|
|
550 \n\ |
|
|
551 @example\n\ |
|
|
552 @group\n\ |
|
|
553 function h () nargin == 1 || error (\"nargin != 1\\n\"); end\n\ |
|
|
554 f ()\n\ |
|
|
555 error: nargin != 1\n\ |
|
|
556 @end group\n\ |
|
|
557 @end example\n\ |
|
|
558 @end deftypefn") |
|
897
|
559 { |
|
3934
|
560 octave_value_list retval; |
|
|
561 handle_message (error, "unspecified error", args); |
|
|
562 return retval; |
|
1489
|
563 } |
|
897
|
564 |
|
3934
|
565 static inline octave_value_list |
|
|
566 set_warning_option (const std::string& state, |
|
3935
|
567 const std::string& frequency, int nargout) |
|
3934
|
568 { |
|
|
569 octave_value_list retval; |
|
|
570 |
|
|
571 if (nargout > 1) |
|
|
572 retval(1) = Vwarning_frequency; |
|
|
573 |
|
3935
|
574 if (nargout >= 0) |
|
3934
|
575 retval(0) = Vwarning_option; |
|
|
576 |
|
|
577 if (! state.empty ()) |
|
|
578 Vwarning_option = state; |
|
|
579 |
|
|
580 if (! frequency.empty ()) |
|
|
581 Vwarning_frequency = frequency; |
|
|
582 |
|
|
583 return retval; |
|
|
584 } |
|
|
585 |
|
3935
|
586 DEFUN (warning, args, nargout, |
|
3373
|
587 "-*- texinfo -*-\n\ |
|
|
588 @deftypefn {Built-in Function} {} warning (@var{msg})\n\ |
|
|
589 Print a warning message @var{msg} prefixed by the string @samp{warning: }. \n\ |
|
|
590 After printing the warning message, Octave will continue to execute\n\ |
|
3600
|
591 commands. You should use this function when you want to notify the user\n\ |
|
|
592 of an unusual condition, but only when it makes sense for your program\n\ |
|
|
593 to go on.\n\ |
|
3373
|
594 @end deftypefn") |
|
1489
|
595 { |
|
3934
|
596 octave_value_list retval; |
|
|
597 |
|
|
598 int argc = args.length () + 1; |
|
|
599 |
|
3935
|
600 bool done = false; |
|
3934
|
601 |
|
3935
|
602 if (args.all_strings_p ()) |
|
|
603 { |
|
|
604 string_vector argv = args.make_argv ("warning"); |
|
|
605 |
|
|
606 if (! error_state) |
|
3934
|
607 { |
|
3935
|
608 if (argc == 1) |
|
3934
|
609 { |
|
|
610 retval = set_warning_option ("", "", nargout); |
|
|
611 done = true; |
|
|
612 } |
|
3935
|
613 else if (argc == 2) |
|
|
614 { |
|
|
615 std::string arg = argv(1); |
|
3934
|
616 |
|
3935
|
617 if (arg == "on" || arg == "off" || arg == "backtrace") |
|
|
618 { |
|
|
619 retval = set_warning_option (arg, "", nargout); |
|
|
620 done = true; |
|
|
621 } |
|
|
622 else if (arg == "once" || arg == "always") |
|
|
623 { |
|
|
624 retval = set_warning_option ("", arg, nargout); |
|
|
625 done = true; |
|
|
626 } |
|
|
627 else if (arg == "debug") |
|
|
628 { |
|
4324
|
629 bind_builtin_variable ("debug_on_warning", true); |
|
3935
|
630 retval = set_warning_option ("", "", nargout); |
|
|
631 done = true; |
|
|
632 } |
|
|
633 } |
|
3934
|
634 } |
|
|
635 } |
|
|
636 |
|
3935
|
637 if (! done) |
|
|
638 { |
|
|
639 std::string prev_msg = Vlast_warning_message; |
|
|
640 |
|
|
641 std::string curr_msg |
|
|
642 = handle_message (warning, "unspecified warning", args); |
|
|
643 |
|
|
644 if (nargout > 0) |
|
|
645 retval(0) = Vlast_warning_message; |
|
|
646 } |
|
|
647 |
|
3934
|
648 return retval; |
|
|
649 } |
|
|
650 |
|
3935
|
651 DEFUN (lasterr, args, , |
|
|
652 "-*- texinfo -*-\n\ |
|
|
653 @deftypefn {Built-in Function} {} lasterr ()\n\ |
|
|
654 @deftypefnx {Built-in Function} {} lasterr (@var{msg})\n\ |
|
|
655 Without any arguments, return the last error message. With one\n\ |
|
|
656 argument, set the last warning message to @var{msg}.\n\ |
|
|
657 @end deftypefn") |
|
|
658 { |
|
|
659 octave_value_list retval; |
|
|
660 |
|
|
661 int argc = args.length () + 1; |
|
|
662 |
|
|
663 string_vector argv = args.make_argv ("lasterr"); |
|
|
664 |
|
|
665 if (argc == 1) |
|
|
666 retval(0) = Vlast_error_message; |
|
|
667 else if (argc == 2) |
|
|
668 Vlast_error_message = argv(1); |
|
|
669 else |
|
|
670 print_usage ("lasterr"); |
|
|
671 |
|
|
672 return retval; |
|
|
673 } |
|
|
674 |
|
4699
|
675 // For backward compatibility. |
|
|
676 DEFALIAS (error_text, lasterr); |
|
|
677 DEFALIAS (__error_text__, lasterr); |
|
|
678 |
|
3934
|
679 DEFUN (lastwarn, args, , |
|
|
680 "-*- texinfo -*-\n\ |
|
|
681 @deftypefn {Built-in Function} {} lastwarn ()\n\ |
|
|
682 @deftypefnx {Built-in Function} {} lastwarn (@var{msg})\n\ |
|
3935
|
683 Without any arguments, return the last warning message. With one\n\ |
|
|
684 argument, set the last error message to @var{msg}.\n\ |
|
3934
|
685 @end deftypefn") |
|
|
686 { |
|
|
687 octave_value_list retval; |
|
|
688 |
|
|
689 int argc = args.length () + 1; |
|
|
690 |
|
|
691 string_vector argv = args.make_argv ("lastwarn"); |
|
|
692 |
|
|
693 if (argc == 1) |
|
|
694 retval(0) = Vlast_warning_message; |
|
|
695 else if (argc == 2) |
|
|
696 Vlast_warning_message = argv(1); |
|
|
697 else |
|
|
698 print_usage ("lastwarn"); |
|
|
699 |
|
|
700 return retval; |
|
897
|
701 } |
|
|
702 |
|
1957
|
703 DEFUN (usage, args, , |
|
3373
|
704 "-*- texinfo -*-\n\ |
|
|
705 @deftypefn {Built-in Function} {} usage (@var{msg})\n\ |
|
|
706 Print the message @var{msg}, prefixed by the string @samp{usage: }, and\n\ |
|
|
707 set Octave's internal error state such that control will return to the\n\ |
|
|
708 top level without evaluating any more commands. This is useful for\n\ |
|
|
709 aborting from functions.\n\ |
|
|
710 \n\ |
|
|
711 After @code{usage} is evaluated, Octave will print a traceback of all\n\ |
|
|
712 the function calls leading to the usage message.\n\ |
|
899
|
713 \n\ |
|
3373
|
714 You should use this function for reporting problems errors that result\n\ |
|
|
715 from an improper call to a function, such as calling a function with an\n\ |
|
|
716 incorrect number of arguments, or with arguments of the wrong type. For\n\ |
|
|
717 example, most functions distributed with Octave begin with code like\n\ |
|
|
718 this\n\ |
|
|
719 \n\ |
|
|
720 @example\n\ |
|
|
721 @group\n\ |
|
|
722 if (nargin != 2)\n\ |
|
|
723 usage (\"foo (a, b)\");\n\ |
|
|
724 endif\n\ |
|
|
725 @end group\n\ |
|
|
726 @end example\n\ |
|
|
727 \n\ |
|
|
728 @noindent\n\ |
|
|
729 to check for the proper number of arguments.\n\ |
|
|
730 @end deftypefn") |
|
899
|
731 { |
|
3934
|
732 octave_value_list retval; |
|
|
733 handle_message (usage, "unknown", args); |
|
|
734 return retval; |
|
899
|
735 } |
|
|
736 |
|
2174
|
737 static int |
|
|
738 beep_on_error (void) |
|
|
739 { |
|
|
740 Vbeep_on_error = check_preference ("beep_on_error"); |
|
|
741 |
|
|
742 return 0; |
|
|
743 } |
|
|
744 |
|
3707
|
745 static int |
|
|
746 debug_on_error (void) |
|
|
747 { |
|
|
748 Vdebug_on_error = check_preference ("debug_on_error"); |
|
|
749 |
|
|
750 return 0; |
|
|
751 } |
|
|
752 |
|
|
753 static int |
|
|
754 debug_on_warning (void) |
|
|
755 { |
|
|
756 Vdebug_on_warning = check_preference ("debug_on_warning"); |
|
|
757 |
|
|
758 return 0; |
|
|
759 } |
|
|
760 |
|
2174
|
761 void |
|
|
762 symbols_of_error (void) |
|
|
763 { |
|
4233
|
764 DEFVAR (beep_on_error, false, beep_on_error, |
|
3373
|
765 "-*- texinfo -*-\n\ |
|
|
766 @defvr {Built-in Variable} beep_on_error\n\ |
|
|
767 If the value of @code{beep_on_error} is nonzero, Octave will try\n\ |
|
|
768 to ring your terminal's bell before printing an error message. The\n\ |
|
|
769 default value is 0.\n\ |
|
|
770 @end defvr"); |
|
3018
|
771 |
|
4233
|
772 DEFVAR (debug_on_error, false, debug_on_error, |
|
3707
|
773 "-*- texinfo -*-\n\ |
|
|
774 @defvr {Built-in Variable} debug_on_error\n\ |
|
|
775 If the value of @code{debug_on_error} is nonzero, Octave will try\n\ |
|
|
776 to enter the debugger when an error is encountered. This will also\n\ |
|
|
777 inhibit printing of the normal traceback message (you will only see\n\ |
|
|
778 the top-level error message). The default value is 0.\n\ |
|
|
779 @end defvr"); |
|
|
780 |
|
4233
|
781 DEFVAR (debug_on_warning, false, debug_on_warning, |
|
3707
|
782 "-*- texinfo -*-\n\ |
|
|
783 @defvr {Built-in Variable} debug_on_warning\n\ |
|
|
784 If the value of @code{debug_on_warning} is nonzero, Octave will try\n\ |
|
|
785 to enter the debugger when a warning is encountered. The default\n\ |
|
|
786 value is 0.\n\ |
|
|
787 @end defvr"); |
|
2174
|
788 } |
|
|
789 |
|
1
|
790 /* |
|
|
791 ;;; Local Variables: *** |
|
|
792 ;;; mode: C++ *** |
|
|
793 ;;; End: *** |
|
|
794 */ |
