|
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 |
|
3503
|
30 #include <strstream> |
|
1728
|
31 #include <string> |
|
|
32 |
|
1352
|
33 #include "defun.h" |
|
1
|
34 #include "error.h" |
|
1742
|
35 #include "pager.h" |
|
1352
|
36 #include "oct-obj.h" |
|
|
37 #include "utils.h" |
|
2370
|
38 #include "ov.h" |
|
|
39 #include "variables.h" |
|
1
|
40 |
|
2174
|
41 // TRUE means that Octave will try to beep obnoxiously before printing |
|
|
42 // error messages. |
|
|
43 static bool Vbeep_on_error; |
|
|
44 |
|
143
|
45 // Current error state. |
|
672
|
46 int error_state = 0; |
|
|
47 |
|
3489
|
48 // Current warning state. |
|
|
49 int warning_state = 0; |
|
|
50 |
|
1489
|
51 // Tell the error handler whether to print messages, or just store |
|
|
52 // them for later. Used for handling errors in eval() and |
|
|
53 // the `unwind_protect' statement. |
|
3136
|
54 bool buffer_error_messages = false; |
|
1489
|
55 |
|
|
56 // The message buffer |
|
|
57 ostrstream *error_message_buffer = 0; |
|
143
|
58 |
|
3491
|
59 // Warning messages are never buffered. |
|
|
60 // XXX FIXME XXX -- we should provide another way to turn them off... |
|
|
61 |
|
|
62 static void |
|
|
63 vwarning (const char *name, const char *fmt, va_list args) |
|
|
64 { |
|
|
65 flush_octave_stdout (); |
|
|
66 |
|
|
67 ostrstream output_buf; |
|
|
68 |
|
|
69 if (name) |
|
|
70 { |
|
|
71 octave_diary << name << ": "; |
|
|
72 cerr << name << ": "; |
|
|
73 } |
|
|
74 |
|
|
75 octave_diary.vform (fmt, args); |
|
|
76 cerr.vform (fmt, args); |
|
|
77 |
|
|
78 octave_diary << endl; |
|
|
79 cerr << endl; |
|
|
80 } |
|
|
81 |
|
1
|
82 static void |
|
|
83 verror (const char *name, const char *fmt, va_list args) |
|
|
84 { |
|
2095
|
85 flush_octave_stdout (); |
|
914
|
86 |
|
2174
|
87 bool to_beep_or_not_to_beep_p = Vbeep_on_error && ! error_state; |
|
1423
|
88 |
|
581
|
89 ostrstream output_buf; |
|
1
|
90 |
|
2174
|
91 if (to_beep_or_not_to_beep_p) |
|
1423
|
92 output_buf << "\a"; |
|
599
|
93 if (name) |
|
|
94 output_buf << name << ": "; |
|
581
|
95 output_buf.vform (fmt, args); |
|
1165
|
96 output_buf << endl << ends; |
|
581
|
97 |
|
|
98 char *msg = output_buf.str (); |
|
|
99 |
|
1489
|
100 if (buffer_error_messages) |
|
|
101 { |
|
|
102 char *ptr = msg; |
|
|
103 |
|
|
104 if (! error_message_buffer) |
|
|
105 { |
|
|
106 error_message_buffer = new ostrstream; |
|
|
107 |
|
|
108 // XXX FIXME XXX -- this is ugly, but it prevents |
|
|
109 // |
|
|
110 // eval ("error (\"msg\")", "error (__error_text__)"); |
|
|
111 // |
|
|
112 // from printing `error: ' twice. Assumes that the NAME we |
|
|
113 // have been given doesn't contain `:'. |
|
|
114 |
|
3162
|
115 ptr = strchr (msg, ':'); |
|
|
116 |
|
|
117 if (ptr) |
|
|
118 { |
|
|
119 if (*++ptr != '\0') |
|
|
120 ++ptr; |
|
|
121 } |
|
|
122 else |
|
|
123 ptr = msg; |
|
1489
|
124 } |
|
|
125 |
|
|
126 *error_message_buffer << ptr; |
|
|
127 } |
|
|
128 else |
|
|
129 { |
|
2095
|
130 octave_diary << msg; |
|
1489
|
131 cerr << msg; |
|
|
132 } |
|
581
|
133 |
|
|
134 delete [] msg; |
|
1
|
135 } |
|
|
136 |
|
1266
|
137 // Note that we don't actually print any message if the error string |
|
|
138 // is just "" or "\n". This allows error ("") and error ("\n") to |
|
|
139 // just set the error state. |
|
|
140 |
|
1005
|
141 static void |
|
|
142 error_1 (const char *name, const char *fmt, va_list args) |
|
|
143 { |
|
|
144 if (error_state != -2) |
|
|
145 { |
|
1489
|
146 if (fmt) |
|
1005
|
147 { |
|
1489
|
148 if (*fmt) |
|
1005
|
149 { |
|
1489
|
150 int len = strlen (fmt); |
|
|
151 if (fmt[len - 1] == '\n') |
|
1266
|
152 { |
|
1489
|
153 if (len > 1) |
|
1266
|
154 { |
|
1489
|
155 char *tmp_fmt = strsave (fmt); |
|
|
156 tmp_fmt[len - 1] = '\0'; |
|
|
157 verror (name, tmp_fmt, args); |
|
|
158 delete [] tmp_fmt; |
|
|
159 } |
|
1423
|
160 |
|
1489
|
161 error_state = -2; |
|
1266
|
162 } |
|
1489
|
163 else |
|
|
164 verror (name, fmt, args); |
|
1005
|
165 } |
|
|
166 } |
|
1489
|
167 else |
|
|
168 panic ("error_1: invalid format"); |
|
1423
|
169 |
|
|
170 if (! error_state) |
|
|
171 error_state = 1; |
|
1005
|
172 } |
|
|
173 } |
|
|
174 |
|
1
|
175 void |
|
|
176 message (const char *name, const char *fmt, ...) |
|
|
177 { |
|
|
178 va_list args; |
|
|
179 va_start (args, fmt); |
|
|
180 verror (name, fmt, args); |
|
|
181 va_end (args); |
|
|
182 } |
|
|
183 |
|
|
184 void |
|
|
185 usage (const char *fmt, ...) |
|
|
186 { |
|
|
187 va_list args; |
|
|
188 va_start (args, fmt); |
|
905
|
189 error_state = -1; |
|
1
|
190 verror ("usage", fmt, args); |
|
|
191 va_end (args); |
|
|
192 } |
|
|
193 |
|
|
194 void |
|
|
195 warning (const char *fmt, ...) |
|
|
196 { |
|
|
197 va_list args; |
|
|
198 va_start (args, fmt); |
|
3489
|
199 warning_state = 1; |
|
3491
|
200 vwarning ("warning", fmt, args); |
|
1
|
201 va_end (args); |
|
|
202 } |
|
|
203 |
|
|
204 void |
|
|
205 error (const char *fmt, ...) |
|
|
206 { |
|
|
207 va_list args; |
|
|
208 va_start (args, fmt); |
|
1005
|
209 error_1 ("error", fmt, args); |
|
|
210 va_end (args); |
|
|
211 } |
|
436
|
212 |
|
1005
|
213 void |
|
|
214 parse_error (const char *fmt, ...) |
|
|
215 { |
|
|
216 va_list args; |
|
|
217 va_start (args, fmt); |
|
|
218 error_1 (0, fmt, args); |
|
1
|
219 va_end (args); |
|
|
220 } |
|
|
221 |
|
189
|
222 void |
|
1
|
223 panic (const char *fmt, ...) |
|
|
224 { |
|
2095
|
225 flush_octave_stdout (); |
|
169
|
226 |
|
1
|
227 va_list args; |
|
|
228 va_start (args, fmt); |
|
|
229 verror ("panic", fmt, args); |
|
|
230 va_end (args); |
|
|
231 abort (); |
|
|
232 } |
|
|
233 |
|
1489
|
234 typedef void (*error_fun)(const char *, ...); |
|
|
235 |
|
2086
|
236 extern octave_value_list Fsprintf (const octave_value_list&, int); |
|
1489
|
237 |
|
2086
|
238 static octave_value_list |
|
|
239 handle_message (error_fun f, const char *msg, const octave_value_list& args) |
|
528
|
240 { |
|
2086
|
241 octave_value_list retval; |
|
528
|
242 |
|
1728
|
243 string tstr; |
|
|
244 |
|
528
|
245 int nargin = args.length (); |
|
|
246 |
|
2745
|
247 if (nargin > 0) |
|
528
|
248 { |
|
3066
|
249 octave_value arg; |
|
|
250 |
|
|
251 if (nargin > 1) |
|
|
252 { |
|
|
253 octave_value_list tmp = Fsprintf (args, 1); |
|
|
254 arg = tmp(0); |
|
|
255 } |
|
|
256 else |
|
|
257 arg = args(0); |
|
2745
|
258 |
|
|
259 if (arg.is_defined ()) |
|
528
|
260 { |
|
2745
|
261 if (arg.is_string ()) |
|
|
262 { |
|
|
263 tstr = arg.string_value (); |
|
|
264 msg = tstr.c_str (); |
|
|
265 |
|
|
266 if (! msg) |
|
|
267 return retval; |
|
|
268 } |
|
|
269 else if (arg.is_empty ()) |
|
528
|
270 return retval; |
|
|
271 } |
|
|
272 } |
|
|
273 |
|
1489
|
274 // Ugh. |
|
|
275 |
|
|
276 int len = strlen (msg); |
|
|
277 if (msg[len - 1] == '\n') |
|
|
278 { |
|
|
279 if (len > 1) |
|
|
280 { |
|
|
281 char *tmp_msg = strsave (msg); |
|
|
282 tmp_msg[len - 1] = '\0'; |
|
|
283 f ("%s\n", tmp_msg); |
|
|
284 delete [] tmp_msg; |
|
|
285 } |
|
|
286 } |
|
|
287 else |
|
|
288 f ("%s", msg); |
|
528
|
289 |
|
|
290 return retval; |
|
|
291 } |
|
|
292 |
|
1957
|
293 DEFUN (error, args, , |
|
3373
|
294 "-*- texinfo -*-\n\ |
|
|
295 @deftypefn {Built-in Function} {} error (@var{template}, @dots{})\n\ |
|
|
296 The @code{error} function formats the optional arguments under the\n\ |
|
|
297 control of the template string @var{template} using the same rules as\n\ |
|
|
298 the @code{printf} family of functions (@pxref{Formatted Output}).\n\ |
|
|
299 The resulting message is prefixed by the string @samp{error: } and\n\ |
|
|
300 printed on the @code{stderr} stream.\n\ |
|
|
301 \n\ |
|
|
302 Calling @code{error} also sets Octave's internal error state such that\n\ |
|
|
303 control will return to the top level without evaluating any more\n\ |
|
|
304 commands. This is useful for aborting from functions or scripts.\n\ |
|
897
|
305 \n\ |
|
3373
|
306 If the error message does not end with a new line character, Octave will\n\ |
|
|
307 print a traceback of all the function calls leading to the error. For\n\ |
|
|
308 example, given the following function definitions:\n\ |
|
|
309 \n\ |
|
|
310 @example\n\ |
|
|
311 @group\n\ |
|
|
312 function f () g () end\n\ |
|
|
313 function g () h () end\n\ |
|
|
314 function h () nargin == 1 || error (\"nargin != 1\"); end\n\ |
|
|
315 @end group\n\ |
|
|
316 @end example\n\ |
|
1489
|
317 \n\ |
|
3373
|
318 @noindent\n\ |
|
|
319 calling the function @code{f} will result in a list of messages that\n\ |
|
|
320 can help you to quickly locate the exact location of the error:\n\ |
|
1489
|
321 \n\ |
|
3373
|
322 @example\n\ |
|
|
323 @group\n\ |
|
|
324 f ()\n\ |
|
|
325 error: nargin != 1\n\ |
|
|
326 error: evaluating index expression near line 1, column 30\n\ |
|
|
327 error: evaluating binary operator `||' near line 1, column 27\n\ |
|
|
328 error: called from `h'\n\ |
|
|
329 error: called from `g'\n\ |
|
|
330 error: called from `f'\n\ |
|
|
331 @end group\n\ |
|
|
332 @end example\n\ |
|
|
333 \n\ |
|
|
334 If the error message ends in a new line character, Octave will print the\n\ |
|
|
335 message but will not display any traceback messages as it returns\n\ |
|
|
336 control to the top level. For example, modifying the error message\n\ |
|
|
337 in the previous example to end in a new line causes Octave to only print\n\ |
|
|
338 a single message:\n\ |
|
|
339 \n\ |
|
|
340 @example\n\ |
|
|
341 @group\n\ |
|
|
342 function h () nargin == 1 || error (\"nargin != 1\\n\"); end\n\ |
|
|
343 f ()\n\ |
|
|
344 error: nargin != 1\n\ |
|
|
345 @end group\n\ |
|
|
346 @end example\n\ |
|
|
347 @end deftypefn") |
|
897
|
348 { |
|
1489
|
349 return handle_message (error, "unspecified error", args); |
|
|
350 } |
|
897
|
351 |
|
1957
|
352 DEFUN (warning, args, , |
|
3373
|
353 "-*- texinfo -*-\n\ |
|
|
354 @deftypefn {Built-in Function} {} warning (@var{msg})\n\ |
|
|
355 Print a warning message @var{msg} prefixed by the string @samp{warning: }. \n\ |
|
|
356 After printing the warning message, Octave will continue to execute\n\ |
|
|
357 commands. You should use this function should when you want to notify\n\ |
|
|
358 the user of an unusual condition, but only when it makes sense for your\n\ |
|
|
359 program to go on.\n\ |
|
|
360 @end deftypefn") |
|
1489
|
361 { |
|
|
362 return handle_message (warning, "unspecified warning", args); |
|
897
|
363 } |
|
|
364 |
|
1957
|
365 DEFUN (usage, args, , |
|
3373
|
366 "-*- texinfo -*-\n\ |
|
|
367 @deftypefn {Built-in Function} {} usage (@var{msg})\n\ |
|
|
368 Print the message @var{msg}, prefixed by the string @samp{usage: }, and\n\ |
|
|
369 set Octave's internal error state such that control will return to the\n\ |
|
|
370 top level without evaluating any more commands. This is useful for\n\ |
|
|
371 aborting from functions.\n\ |
|
|
372 \n\ |
|
|
373 After @code{usage} is evaluated, Octave will print a traceback of all\n\ |
|
|
374 the function calls leading to the usage message.\n\ |
|
899
|
375 \n\ |
|
3373
|
376 You should use this function for reporting problems errors that result\n\ |
|
|
377 from an improper call to a function, such as calling a function with an\n\ |
|
|
378 incorrect number of arguments, or with arguments of the wrong type. For\n\ |
|
|
379 example, most functions distributed with Octave begin with code like\n\ |
|
|
380 this\n\ |
|
|
381 \n\ |
|
|
382 @example\n\ |
|
|
383 @group\n\ |
|
|
384 if (nargin != 2)\n\ |
|
|
385 usage (\"foo (a, b)\");\n\ |
|
|
386 endif\n\ |
|
|
387 @end group\n\ |
|
|
388 @end example\n\ |
|
|
389 \n\ |
|
|
390 @noindent\n\ |
|
|
391 to check for the proper number of arguments.\n\ |
|
|
392 @end deftypefn") |
|
899
|
393 { |
|
1489
|
394 return handle_message (usage, "unknown", args); |
|
899
|
395 } |
|
|
396 |
|
3018
|
397 void |
|
|
398 bind_global_error_variable (void) |
|
|
399 { |
|
3490
|
400 if (error_message_buffer) |
|
|
401 { |
|
|
402 *error_message_buffer << ends; |
|
3018
|
403 |
|
3490
|
404 char *error_text = error_message_buffer->str (); |
|
3018
|
405 |
|
3490
|
406 bind_builtin_constant ("__error_text__", error_text, true); |
|
3018
|
407 |
|
3490
|
408 delete [] error_text; |
|
|
409 |
|
|
410 delete error_message_buffer; |
|
3018
|
411 |
|
3490
|
412 error_message_buffer = 0; |
|
|
413 } |
|
|
414 else |
|
|
415 bind_builtin_constant ("__error_text__", "", true); |
|
3018
|
416 } |
|
|
417 |
|
|
418 void |
|
|
419 clear_global_error_variable (void *) |
|
|
420 { |
|
|
421 delete error_message_buffer; |
|
|
422 error_message_buffer = 0; |
|
|
423 |
|
3259
|
424 bind_builtin_constant ("__error_text__", "", true); |
|
3018
|
425 } |
|
|
426 |
|
2174
|
427 static int |
|
|
428 beep_on_error (void) |
|
|
429 { |
|
|
430 Vbeep_on_error = check_preference ("beep_on_error"); |
|
|
431 |
|
|
432 return 0; |
|
|
433 } |
|
|
434 |
|
|
435 void |
|
|
436 symbols_of_error (void) |
|
|
437 { |
|
3258
|
438 DEFVAR (beep_on_error, 0.0, beep_on_error, |
|
3373
|
439 "-*- texinfo -*-\n\ |
|
|
440 @defvr {Built-in Variable} beep_on_error\n\ |
|
|
441 If the value of @code{beep_on_error} is nonzero, Octave will try\n\ |
|
|
442 to ring your terminal's bell before printing an error message. The\n\ |
|
|
443 default value is 0.\n\ |
|
|
444 @end defvr"); |
|
3018
|
445 |
|
3141
|
446 DEFCONST (error_text, "", |
|
3373
|
447 "-*- texinfo -*-\n\ |
|
|
448 @defvr {Built-in Variable} error_text\n\ |
|
|
449 This variable contains the text of error messages that would have\n\ |
|
|
450 been printed in the body of the most recent @code{unwind_protect} or\n\ |
|
|
451 @code{try} statement or the @var{try} part of the most recent call to\n\ |
|
|
452 the @code{eval} function. Outside of the @code{unwind_protect} and\n\ |
|
|
453 @code{try} statements or the @code{eval} function, or if no error has\n\ |
|
|
454 occurred within them, the value of @code{error_text} is guaranteed to be\n\ |
|
|
455 the empty string.\n\ |
|
|
456 \n\ |
|
|
457 Note that the message does not include the first @samp{error: } prefix,\n\ |
|
|
458 so that it may easily be passed to the @code{error} function without\n\ |
|
|
459 additional processing@footnote{Yes, it's a kluge, but it seems to be a\n\ |
|
|
460 reasonably useful one.}.\n\ |
|
|
461 \n\ |
|
3402
|
462 @xref{The try Statement}, and @ref{The unwind_protect Statement}.\n\ |
|
3373
|
463 @end defvr"); |
|
2174
|
464 } |
|
|
465 |
|
1
|
466 /* |
|
|
467 ;;; Local Variables: *** |
|
|
468 ;;; mode: C++ *** |
|
|
469 ;;; End: *** |
|
|
470 */ |
