/libinterp/corefcn/error.cc
C++ | 2145 lines | 1679 code | 353 blank | 113 comment | 334 complexity | b8a79e0833412213a5f07ea4e6bb19cb MD5 | raw file
Possible License(s): GPL-3.0, LGPL-2.0
Large files files are truncated, but you can click here to view the full file
- /*
- Copyright (C) 1993-2015 John W. Eaton
- This file is part of Octave.
- Octave is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; either version 3 of the License, or (at your
- option) any later version.
- Octave is distributed in the hope that it will be useful, but WITHOUT
- ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- for more details.
- You should have received a copy of the GNU General Public License
- along with Octave; see the file COPYING. If not, see
- <http://www.gnu.org/licenses/>.
- */
- #ifdef HAVE_CONFIG_H
- #include <config.h>
- #endif
- #include <cstdarg>
- #include <cstring>
- #include <iomanip>
- #include <iostream>
- #include <sstream>
- #include <string>
- #include "defun.h"
- #include "error.h"
- #include "input.h"
- #include "pager.h"
- #include "oct-obj.h"
- #include "oct-map.h"
- #include "utils.h"
- #include "ov.h"
- #include "ov-usr-fcn.h"
- #include "pt-eval.h"
- #include "pt-pr-code.h"
- #include "pt-stmt.h"
- #include "toplev.h"
- #include "unwind-prot.h"
- #include "variables.h"
- // TRUE means that Octave will try to beep obnoxiously before printing
- // error messages.
- static bool Vbeep_on_error = false;
- // TRUE means that Octave will try to enter the debugger when an error
- // is encountered. This will also inhibit printing of the normal
- // traceback message (you will only see the top-level error message).
- bool Vdebug_on_error = false;
- // TRUE means that Octave will try to enter the debugger when a warning
- // is encountered.
- bool Vdebug_on_warning = false;
- // TRUE means that Octave will try to display a stack trace when a
- // warning is encountered.
- static bool Vbacktrace_on_warning = true;
- // TRUE means that Octave will print a verbose warning. Currently unused.
- static bool Vverbose_warning;
- // TRUE means that Octave will print no warnings, but lastwarn will be updated
- static bool Vquiet_warning = false;
- // A structure containing (most of) the current state of warnings.
- static octave_map warning_options;
- // The text of the last error message.
- static std::string Vlast_error_message;
- // The text of the last warning message.
- static std::string Vlast_warning_message;
- // The last warning message id.
- static std::string Vlast_warning_id;
- // The last error message id.
- static std::string Vlast_error_id;
- // The last file in which an error occured
- static octave_map Vlast_error_stack;
- // Current error state.
- //
- // Valid values:
- //
- // -2: an error has occurred, but don't print any messages.
- // -1: an error has occurred, we are printing a traceback
- // 0: no error
- // 1: an error has occurred
- //
- int error_state = 0;
- // Current warning state.
- //
- // Valid values:
- //
- // 0: no warning
- // 1: a warning has occurred
- //
- int warning_state = 0;
- // Tell the error handler whether to print messages, or just store
- // them for later. Used for handling errors in eval() and
- // the 'unwind_protect' statement.
- int buffer_error_messages = 0;
- // TRUE means error messages are turned off.
- bool discard_error_messages = false;
- // TRUE means warning messages are turned off.
- bool discard_warning_messages = false;
- void
- reset_error_handler (void)
- {
- error_state = 0;
- warning_state = 0;
- buffer_error_messages = 0;
- discard_error_messages = false;
- }
- static void
- initialize_warning_options (const std::string& state)
- {
- octave_scalar_map initw;
- initw.setfield ("identifier", "all");
- initw.setfield ("state", state);
- warning_options = initw;
- }
- static octave_map
- initialize_last_error_stack (void)
- {
- return octave_call_stack::empty_backtrace ();
- }
- // Warning messages are never buffered.
- static void
- vwarning (const char *name, const char *id, const char *fmt, va_list args)
- {
- if (discard_warning_messages)
- return;
- flush_octave_stdout ();
- std::ostringstream output_buf;
- if (name)
- output_buf << name << ": ";
- octave_vformat (output_buf, fmt, args);
- output_buf << std::endl;
- // FIXME: we really want to capture the message before it has all the
- // formatting goop attached to it. We probably also want just the
- // message, not the traceback information.
- std::string msg_string = output_buf.str ();
- Vlast_warning_id = id;
- Vlast_warning_message = msg_string;
- if (! Vquiet_warning)
- {
- octave_diary << msg_string;
- std::cerr << msg_string;
- }
- }
- static void
- verror (bool save_last_error, std::ostream& os,
- const char *name, const char *id, const char *fmt, va_list args,
- bool with_cfn = false)
- {
- if (discard_error_messages)
- return;
- if (! buffer_error_messages)
- flush_octave_stdout ();
- // FIXME: we really want to capture the message before it has all the
- // formatting goop attached to it. We probably also want just the
- // message, not the traceback information.
- std::ostringstream output_buf;
- octave_vformat (output_buf, fmt, args);
- std::string base_msg = output_buf.str ();
- bool to_beep_or_not_to_beep_p = Vbeep_on_error && ! error_state;
- std::string msg_string;
- if (to_beep_or_not_to_beep_p)
- msg_string = "\a";
- if (name)
- msg_string += std::string (name) + ": ";
- // If with_fcn is specified, we'll attempt to prefix the message with the name
- // of the current executing function. But we'll do so only if:
- // 1. the name is not empty (anonymous function)
- // 2. it is not already there (including the following colon)
- if (with_cfn)
- {
- octave_function *curfcn = octave_call_stack::current ();
- if (curfcn)
- {
- std::string cfn = curfcn->name ();
- if (! cfn.empty ())
- {
- cfn += ':';
- if (cfn.length () > base_msg.length ()
- || base_msg.compare (0, cfn.length (), cfn) != 0)
- {
- msg_string += cfn + ' ';
- }
- }
- }
- }
- msg_string += base_msg + "\n";
- if (! error_state && save_last_error)
- {
- // This is the first error in a possible series.
- Vlast_error_id = id;
- Vlast_error_message = base_msg;
- octave_user_code *fcn = octave_call_stack::caller_user_code ();
- if (fcn)
- {
- octave_idx_type curr_frame = -1;
- Vlast_error_stack = octave_call_stack::backtrace (0, curr_frame);
- }
- else
- Vlast_error_stack = initialize_last_error_stack ();
- }
- if (! buffer_error_messages)
- {
- octave_diary << msg_string;
- os << msg_string;
- }
- }
- static void
- pr_where_2 (const char *fmt, va_list args)
- {
- if (fmt)
- {
- if (*fmt)
- {
- size_t len = strlen (fmt);
- if (len > 0)
- {
- if (fmt[len - 1] == '\n')
- {
- if (len > 1)
- {
- char *tmp_fmt = strsave (fmt);
- tmp_fmt[len - 1] = '\0';
- verror (false, std::cerr, 0, "", tmp_fmt, args);
- delete [] tmp_fmt;
- }
- }
- else
- verror (false, std::cerr, 0, "", fmt, args);
- }
- }
- }
- else
- panic ("pr_where_2: invalid format");
- }
- static void
- pr_where_1 (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- pr_where_2 (fmt, args);
- va_end (args);
- }
- static void
- pr_where (const char *who)
- {
- std::list<octave_call_stack::stack_frame> frames
- = octave_call_stack::backtrace_frames ();
- size_t nframes = frames.size ();
- if (nframes > 0)
- pr_where_1 ("%s: called from\n", who);
- for (std::list<octave_call_stack::stack_frame>::const_iterator p = frames.begin ();
- p != frames.end (); p++)
- {
- const octave_call_stack::stack_frame& elt = *p;
- std::string fcn_name = elt.fcn_name ();
- int line = elt.line ();
- int column = elt.column ();
- pr_where_1 (" %s at line %d column %d\n",
- fcn_name.c_str (), line, column);
- }
- }
- // Note that we don't actually print any message if the error string
- // is just "" or "\n". This allows error ("") and error ("\n") to
- // just set the error state.
- static void
- error_1 (std::ostream& os, const char *name, const char *id,
- const char *fmt, va_list args, bool with_cfn = false)
- {
- if (error_state != -2)
- {
- if (fmt)
- {
- if (*fmt)
- {
- size_t len = strlen (fmt);
- if (len > 0)
- {
- if (fmt[len - 1] == '\n')
- {
- if (len > 1)
- {
- char *tmp_fmt = strsave (fmt);
- tmp_fmt[len - 1] = '\0';
- verror (true, os, name, id, tmp_fmt, args, with_cfn);
- delete [] tmp_fmt;
- }
- error_state = -2;
- }
- else
- {
- verror (true, os, name, id, fmt, args, with_cfn);
- if (! error_state)
- error_state = 1;
- }
- }
- }
- }
- else
- panic ("error_1: invalid format");
- }
- }
- void
- vmessage (const char *name, const char *fmt, va_list args)
- {
- verror (false, std::cerr, name, "", fmt, args);
- }
- void
- message (const char *name, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vmessage (name, fmt, args);
- va_end (args);
- }
- void
- vmessage_with_id (const char *name, const char *id, const char *fmt,
- va_list args)
- {
- verror (false, std::cerr, name, id, fmt, args);
- }
- void
- message_with_id (const char *name, const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vmessage_with_id (name, id, fmt, args);
- va_end (args);
- }
- void
- usage_1 (const char *id, const char *fmt, va_list args)
- {
- verror (true, std::cerr, "usage", id, fmt, args);
- error_state = -1;
- }
- void
- vusage (const char *fmt, va_list args)
- {
- usage_1 ("", fmt, args);
- }
- void
- usage (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vusage (fmt, args);
- va_end (args);
- }
- void
- vusage_with_id (const char *id, const char *fmt, va_list args)
- {
- usage_1 (id, fmt, args);
- }
- void
- usage_with_id (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vusage_with_id (id, fmt, args);
- va_end (args);
- }
- static void
- error_2 (const char *id, const char *fmt, va_list args, bool with_cfn = false)
- {
- int init_state = error_state;
- error_1 (std::cerr, "error", id, fmt, args, with_cfn);
- if (error_state != -2 && ! symbol_table::at_top_level ()
- && ! discard_error_messages)
- pr_where ("error");
- if ((interactive || forced_interactive)
- && Vdebug_on_error && init_state == 0
- && octave_call_stack::caller_user_code ())
- {
- unwind_protect frame;
- frame.protect_var (Vdebug_on_error);
- Vdebug_on_error = false;
- error_state = 0;
- tree_evaluator::debug_mode = true;
- tree_evaluator::current_frame = octave_call_stack::current_frame ();
- do_keyboard (octave_value_list ());
- }
- }
- void
- verror (const char *fmt, va_list args)
- {
- error_2 ("", fmt, args);
- }
- void
- error (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- verror (fmt, args);
- va_end (args);
- }
- void
- verror_with_cfn (const char *fmt, va_list args)
- {
- error_2 ("", fmt, args, true);
- }
- void
- error_with_cfn (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- verror_with_cfn (fmt, args);
- va_end (args);
- }
- void
- verror_with_id (const char *id, const char *fmt, va_list args)
- {
- error_2 (id, fmt, args);
- }
- void
- error_with_id (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- verror_with_id (id, fmt, args);
- va_end (args);
- }
- void
- verror_with_id_cfn (const char *id, const char *fmt, va_list args)
- {
- error_2 (id, fmt, args, true);
- }
- void
- error_with_id_cfn (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- verror_with_id_cfn (id, fmt, args);
- va_end (args);
- }
- static int
- check_state (const std::string& state)
- {
- // -1: not found
- // 0: found, "off"
- // 1: found, "on"
- // 2: found, "error"
- if (state == "off")
- return 0;
- else if (state == "on")
- return 1;
- else if (state == "error")
- return 2;
- else
- return -1;
- }
- // For given warning ID, return 0 if warnings are disabled, 1 if
- // enabled, and 2 if the given ID should be an error instead of a
- // warning.
- int
- warning_enabled (const std::string& id)
- {
- int retval = 0;
- int all_state = -1;
- int id_state = -1;
- octave_idx_type nel = warning_options.numel ();
- if (nel > 0)
- {
- Cell identifier = warning_options.contents ("identifier");
- Cell state = warning_options.contents ("state");
- bool all_found = false;
- bool id_found = false;
- for (octave_idx_type i = 0; i < nel; i++)
- {
- octave_value ov = identifier(i);
- std::string ovs = ov.string_value ();
- if (! all_found && ovs == "all")
- {
- all_state = check_state (state(i).string_value ());
- if (all_state >= 0)
- all_found = true;
- }
- if (! id_found && ovs == id)
- {
- id_state = check_state (state(i).string_value ());
- if (id_state >= 0)
- id_found = true;
- }
- if (all_found && id_found)
- break;
- }
- }
- // If "all" is not present, assume warnings are enabled.
- if (all_state == -1)
- all_state = 1;
- if (all_state == 0)
- {
- if (id_state >= 0)
- retval = id_state;
- }
- else if (all_state == 1)
- {
- if (id_state == 0 || id_state == 2)
- retval = id_state;
- else
- retval = all_state;
- }
- else if (all_state == 2)
- {
- if (id_state == 0)
- retval= id_state;
- else
- retval = all_state;
- }
- return retval;
- }
- static void
- warning_1 (const char *id, const char *fmt, va_list args)
- {
- int warn_opt = warning_enabled (id);
- if (warn_opt == 2)
- {
- // Handle this warning as an error.
- error_2 (id, fmt, args);
- }
- else if (warn_opt == 1)
- {
- vwarning ("warning", id, fmt, args);
- if (! symbol_table::at_top_level ()
- && Vbacktrace_on_warning
- && ! warning_state
- && ! discard_warning_messages)
- pr_where ("warning");
- warning_state = 1;
- if ((interactive || forced_interactive)
- && Vdebug_on_warning
- && octave_call_stack::caller_user_code ())
- {
- unwind_protect frame;
- frame.protect_var (Vdebug_on_warning);
- Vdebug_on_warning = false;
- tree_evaluator::debug_mode = true;
- tree_evaluator::current_frame = octave_call_stack::current_frame ();
- do_keyboard (octave_value_list ());
- }
- }
- }
- void
- vwarning (const char *fmt, va_list args)
- {
- warning_1 ("", fmt, args);
- }
- void
- warning (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vwarning (fmt, args);
- va_end (args);
- }
- void
- vwarning_with_id (const char *id, const char *fmt, va_list args)
- {
- warning_1 (id, fmt, args);
- }
- void
- warning_with_id (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vwarning_with_id (id, fmt, args);
- va_end (args);
- }
- void
- vparse_error (const char *fmt, va_list args)
- {
- error_1 (std::cerr, 0, "", fmt, args);
- }
- void
- parse_error (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vparse_error (fmt, args);
- va_end (args);
- }
- void
- vparse_error_with_id (const char *id, const char *fmt, va_list args)
- {
- error_1 (std::cerr, 0, id, fmt, args);
- }
- void
- parse_error_with_id (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- vparse_error_with_id (id, fmt, args);
- va_end (args);
- }
- void
- rethrow_error (const char *id, const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- error_1 (std::cerr, 0, id, fmt, args);
- va_end (args);
- }
- void
- panic (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- buffer_error_messages = 0;
- discard_error_messages = false;
- verror (false, std::cerr, "panic", "", fmt, args);
- va_end (args);
- abort ();
- }
- static void
- defun_usage_message_1 (const char *fmt, ...)
- {
- va_list args;
- va_start (args, fmt);
- error_1 (octave_stdout, 0, "", fmt, args);
- va_end (args);
- }
- void
- defun_usage_message (const std::string& msg)
- {
- defun_usage_message_1 ("%s", msg.c_str ());
- }
- typedef void (*error_fun)(const char *, const char *, ...);
- extern octave_value_list Fsprintf (const octave_value_list&, int);
- static std::string
- handle_message (error_fun f, const char *id, const char *msg,
- const octave_value_list& args, bool have_fmt)
- {
- std::string retval;
- std::string tstr;
- int nargin = args.length ();
- if (nargin > 0)
- {
- octave_value arg;
- if (have_fmt)
- {
- octave_value_list tmp = Fsprintf (args, 1);
- arg = tmp(0);
- }
- else
- arg = args(0);
- if (arg.is_defined ())
- {
- if (arg.is_string ())
- {
- tstr = arg.string_value ();
- msg = tstr.c_str ();
- if (! msg)
- return retval;
- }
- else if (arg.is_empty ())
- return retval;
- }
- }
- // Ugh.
- size_t len = strlen (msg);
- if (len > 0)
- {
- if (msg[len - 1] == '\n')
- {
- if (len > 1)
- {
- char *tmp_msg = strsave (msg);
- tmp_msg[len - 1] = '\0';
- f (id, "%s\n", tmp_msg);
- retval = tmp_msg;
- delete [] tmp_msg;
- }
- }
- else
- {
- f (id, "%s", msg);
- retval = msg;
- }
- }
- return retval;
- }
- DEFUN (rethrow, args, ,
- "-*- texinfo -*-\n\
- @deftypefn {Built-in Function} {} rethrow (@var{err})\n\
- Reissue a previous error as defined by @var{err}. @var{err} is a structure\n\
- that must contain at least the @qcode{\"message\"} and @qcode{\"identifier\"}\n\
- fields. @var{err} can also contain a field @qcode{\"stack\"} that gives\n\
- information on the assumed location of the error. Typically @var{err} is\n\
- returned from @code{lasterror}.\n\
- @seealso{lasterror, lasterr, error}\n\
- @end deftypefn")
- {
- octave_value retval;
- int nargin = args.length ();
- if (nargin != 1)
- print_usage ();
- else
- {
- const octave_scalar_map err = args(0).scalar_map_value ();
- if (! error_state)
- {
- if (err.contains ("message") && err.contains ("identifier"))
- {
- std::string msg = err.contents ("message").string_value ();
- std::string id = err.contents ("identifier").string_value ();
- int len = msg.length ();
- std::string file;
- std::string nm;
- int l = -1;
- int c = -1;
- octave_map err_stack = initialize_last_error_stack ();
- if (err.contains ("stack"))
- {
- err_stack = err.contents ("stack").map_value ();
- if (err_stack.numel () > 0)
- {
- if (err_stack.contains ("file"))
- file = err_stack.contents ("file")(0).string_value ();
- if (err_stack.contains ("name"))
- nm = err_stack.contents ("name")(0).string_value ();
- if (err_stack.contains ("line"))
- l = err_stack.contents ("line")(0).nint_value ();
- if (err_stack.contains ("column"))
- c = err_stack.contents ("column")(0).nint_value ();
- }
- }
- // Ugh.
- char *tmp_msg = strsave (msg.c_str ());
- if (tmp_msg[len-1] == '\n')
- {
- if (len > 1)
- {
- tmp_msg[len - 1] = '\0';
- rethrow_error (id.c_str (), "%s\n", tmp_msg);
- }
- }
- else
- rethrow_error (id.c_str (), "%s", tmp_msg);
- delete [] tmp_msg;
- // FIXME: is this the right thing to do for Vlast_error_stack?
- // Should it be saved and restored with unwind_protect?
- Vlast_error_stack = err_stack;
- if (err.contains ("stack"))
- {
- if (file.empty ())
- {
- if (nm.empty ())
- {
- if (l > 0)
- {
- if (c > 0)
- pr_where_1 ("error: near line %d, column %d",
- l, c);
- else
- pr_where_1 ("error: near line %d", l);
- }
- }
- else
- {
- if (l > 0)
- {
- if (c > 0)
- pr_where_1 ("error: called from '%s' near line %d, column %d",
- nm.c_str (), l, c);
- else
- pr_where_1 ("error: called from '%d' near line %d",
- nm.c_str (), l);
- }
- }
- }
- else
- {
- if (nm.empty ())
- {
- if (l > 0)
- {
- if (c > 0)
- pr_where_1 ("error: in file %s near line %d, column %d",
- file.c_str (), l, c);
- else
- pr_where_1 ("error: in file %s near line %d",
- file.c_str (), l);
- }
- }
- else
- {
- if (l > 0)
- {
- if (c > 0)
- pr_where_1 ("error: called from '%s' in file %s near line %d, column %d",
- nm.c_str (), file.c_str (), l, c);
- else
- pr_where_1 ("error: called from '%d' in file %s near line %d",
- nm.c_str (), file.c_str (), l);
- }
- }
- }
- }
- }
- else
- error ("rethrow: ERR structure must contain the fields 'message and 'identifier'");
- }
- }
- return retval;
- }
- // Determine whether the first argument to error or warning function
- // should be handled as the message identifier or as the format string.
- static bool
- maybe_extract_message_id (const std::string& caller,
- const octave_value_list& args,
- octave_value_list& nargs,
- std::string& id)
- {
- nargs = args;
- id = std::string ();
- int nargin = args.length ();
- bool have_fmt = nargin > 1;
- if (nargin > 0)
- {
- std::string arg1 = args(0).string_value ();
- if (! error_state)
- {
- // For compatibility with Matlab, an identifier must contain
- // ':', but not at the beginning or the end, and it must not
- // contain '%' (even if it is not a valid conversion
- // operator) or whitespace.
- if (arg1.find_first_of ("% \f\n\r\t\v") == std::string::npos
- && arg1.find (':') != std::string::npos
- && arg1[0] != ':'
- && arg1[arg1.length ()-1] != ':')
- {
- if (nargin > 1)
- {
- id = arg1;
- nargs.resize (nargin-1);
- for (int i = 1; i < nargin; i++)
- nargs(i-1) = args(i);
- }
- else
- nargs(0) = "call to " + caller
- + " with message identifier requires message";
- }
- }
- }
- return have_fmt;
- }
- DEFUN (error, args, ,
- "-*- texinfo -*-\n\
- @deftypefn {Built-in Function} {} error (@var{template}, @dots{})\n\
- @deftypefnx {Built-in Function} {} error (@var{id}, @var{template}, @dots{})\n\
- Format the optional arguments under the control of the template string\n\
- @var{template} using the same rules as the @code{printf} family of\n\
- functions (@pxref{Formatted Output}) and print the resulting message\n\
- on the @code{stderr} stream. The message is prefixed by the character\n\
- string @samp{error: }.\n\
- \n\
- Calling @code{error} also sets Octave's internal error state such that\n\
- control will return to the top level without evaluating any more\n\
- commands. This is useful for aborting from functions or scripts.\n\
- \n\
- If the error message does not end with a newline character, Octave will\n\
- print a traceback of all the function calls leading to the error. For\n\
- example, given the following function definitions:\n\
- \n\
- @example\n\
- @group\n\
- function f () g (); end\n\
- function g () h (); end\n\
- function h () nargin == 1 || error (\"nargin != 1\"); end\n\
- @end group\n\
- @end example\n\
- \n\
- @noindent\n\
- calling the function @code{f} will result in a list of messages that\n\
- can help you to quickly locate the exact location of the error:\n\
- \n\
- @example\n\
- @group\n\
- f ()\n\
- error: nargin != 1\n\
- error: called from:\n\
- error: error at line -1, column -1\n\
- error: h at line 1, column 27\n\
- error: g at line 1, column 15\n\
- error: f at line 1, column 15\n\
- @end group\n\
- @end example\n\
- \n\
- If the error message ends in a newline character, Octave will print the\n\
- message but will not display any traceback messages as it returns\n\
- control to the top level. For example, modifying the error message\n\
- in the previous example to end in a newline causes Octave to only print\n\
- a single message:\n\
- \n\
- @example\n\
- @group\n\
- function h () nargin == 1 || error (\"nargin != 1\\n\"); end\n\
- f ()\n\
- error: nargin != 1\n\
- @end group\n\
- @end example\n\
- \n\
- A null string (\"\") input to @code{error} will be ignored and the code\n\
- will continue running as if the statement were a NOP@. This is for\n\
- compatibility with @sc{matlab}. It also makes it possible to write code such\n\
- as\n\
- \n\
- @example\n\
- @group\n\
- err_msg = \"\";\n\
- if (CONDITION 1)\n\
- err_msg = \"CONDITION 1 found\";\n\
- elseif (CONDITION2)\n\
- err_msg = \"CONDITION 2 found\";\n\
- @dots{}\n\
- endif\n\
- error (err_msg);\n\
- @end group\n\
- @end example\n\
- \n\
- @noindent\n\
- which will only stop execution if an error has been found.\n\
- \n\
- Implementation Note: For compatibility with @sc{matlab}, escape\n\
- sequences (e.g., \"\\n\" => newline) are processed in @var{template}\n\
- regardless of whether @var{template} has been defined within single quotes\n\
- as long as there are two or more input arguments.\n\
- Use a second backslash to stop interpolation of the escape sequence (e.g.,\n\
- \"\\\\n\") or use the @code{regexptranslate} function.\n\
- @seealso{warning, lasterror}\n\
- @end deftypefn")
- {
- octave_value retval;
- int nargin = args.length ();
- octave_value_list nargs = args;
- std::string id;
- if (nargin == 0)
- print_usage ();
- else
- {
- bool have_fmt = false;
- if (nargin == 1 && args(0).is_map ())
- {
- // empty struct is not an error. return and resume calling function.
- if (args(0).is_empty ())
- return retval;
- octave_value_list tmp;
- octave_scalar_map m = args(0).scalar_map_value ();
- // empty struct is not an error. return and resume calling function.
- if (m.nfields () == 0)
- return retval;
- if (m.contains ("message"))
- {
- octave_value c = m.getfield ("message");
- if (c.is_string ())
- nargs(0) = c.string_value ();
- }
- if (m.contains ("identifier"))
- {
- octave_value c = m.getfield ("identifier");
- if (c.is_string ())
- id = c.string_value ();
- }
- // FIXME: also need to handle "stack" field in error structure,
- // but that will require some more significant surgery on
- // handle_message, error_with_id, etc.
- }
- else
- {
- have_fmt = maybe_extract_message_id ("error", args, nargs, id);
- if (error_state)
- return retval;
- }
- handle_message (error_with_id, id.c_str (), "unspecified error",
- nargs, have_fmt);
- }
- return retval;
- }
- static octave_scalar_map
- warning_query (const std::string& id_arg)
- {
- octave_scalar_map retval;
- std::string id = id_arg;
- if (id == "last")
- id = Vlast_warning_id;
- Cell ident = warning_options.contents ("identifier");
- Cell state = warning_options.contents ("state");
- octave_idx_type nel = ident.numel ();
- bool found = false;
- std::string val;
- for (octave_idx_type i = 0; i < nel; i++)
- {
- if (ident(i).string_value () == id)
- {
- val = state(i).string_value ();
- found = true;
- break;
- }
- }
- if (! found)
- {
- for (octave_idx_type i = 0; i < nel; i++)
- {
- if (ident(i).string_value () == "all")
- {
- val = state(i).string_value ();
- found = true;
- break;
- }
- }
- }
- if (found)
- {
- retval.assign ("identifier", id);
- retval.assign ("state", val);
- }
- else
- error ("warning: unable to find default warning state!");
- return retval;
- }
- static std::string
- default_warning_state (void)
- {
- std::string retval = "on";
- Cell ident = warning_options.contents ("identifier");
- Cell state = warning_options.contents ("state");
- octave_idx_type nel = ident.numel ();
- for (octave_idx_type i = 0; i < nel; i++)
- {
- if (ident(i).string_value () == "all")
- {
- retval = state(i).string_value ();
- break;
- }
- }
- return retval;
- }
- static void
- display_warning_options (std::ostream& os)
- {
- Cell ident = warning_options.contents ("identifier");
- Cell state = warning_options.contents ("state");
- octave_idx_type nel = ident.numel ();
- std::string all_state = default_warning_state ();
- if (all_state == "on")
- os << "By default, warnings are enabled.";
- else if (all_state == "off")
- os << "By default, warnings are disabled.";
- else if (all_state == "error")
- os << "By default, warnings are treated as errors.";
- else
- panic_impossible ();
- if (nel > 1)
- os << "\n\n";
- // The state for all is always supposed to be first in the list.
- for (octave_idx_type i = 1; i < nel; i++)
- {
- std::string tid = ident(i).string_value ();
- std::string tst = state(i).string_value ();
- os << std::setw (7) << tst << " " << tid << "\n";
- }
- os << std::endl;
- }
- static void
- set_warning_option (const std::string& state, const std::string& ident)
- {
- if (ident == "all")
- {
- initialize_warning_options (state);
- return;
- }
- std::string all_state = default_warning_state ();
- if (state != "on" && state != "off" && state != "error")
- error ("invalid warning state: %s", state.c_str ());
- Cell tid = warning_options.contents ("identifier");
- Cell tst = warning_options.contents ("state");
- octave_idx_type nel = tid.numel ();
- for (octave_idx_type i = 0; i < nel; i++)
- {
- if (tid(i).string_value () == ident)
- {
- // We found it in the current list of options. If the state
- // for "all" is same as arg1, we can simply remove the item
- // from the list.
- if (state == all_state)
- {
- for (i = i + 1; i < nel; i++)
- {
- tid(i-1) = tid(i);
- tst(i-1) = tst(i);
- }
- tid.resize (dim_vector (1, nel-1));
- tst.resize (dim_vector (1, nel-1));
- }
- else
- tst(i) = state;
- warning_options.clear ();
- warning_options.assign ("identifier", tid);
- warning_options.assign ("state", tst);
- return;
- }
- }
- // The option wasn't already in the list. Append it.
- tid.resize (dim_vector (1, nel+1));
- tst.resize (dim_vector (1, nel+1));
- tid(nel) = ident;
- tst(nel) = state;
- warning_options.clear ();
- warning_options.assign ("identifier", tid);
- warning_options.assign ("state", tst);
- }
- DEFUN (warning, args, nargout,
- "-*- texinfo -*-\n\
- @deftypefn {Built-in Function} {} warning (@var{template}, @dots{})\n\
- @deftypefnx {Built-in Function} {} warning (@var{id}, @var{template}, @dots{})\n\
- @deftypefnx {Built-in Function} {} warning (\"on\", @var{id})\n\
- @deftypefnx {Built-in Function} {} warning (\"off\", @var{id})\n\
- @deftypefnx {Built-in Function} {} warning (\"query\", @var{id})\n\
- @deftypefnx {Built-in Function} {} warning (\"error\", @var{id})\n\
- @deftypefnx {Built-in Function} {} warning (@var{state}, \"backtrace\")\n\
- @deftypefnx {Built-in Function} {} warning (@var{state}, @var{id}, \"local\")\n\
- Format the optional arguments under the control of the template string\n\
- @var{template} using the same rules as the @code{printf} family of\n\
- functions (@pxref{Formatted Output}) and print the resulting message\n\
- on the @code{stderr} stream. The message is prefixed by the character\n\
- string @samp{warning: }.\n\
- You should use this function when you want to notify the user\n\
- of an unusual condition, but only when it makes sense for your program\n\
- to go on.\n\
- \n\
- The optional message identifier allows users to enable or disable\n\
- warnings tagged by @var{id}. A message identifier is of the form\n\
- \"NAMESPACE:WARNING-NAME\". Octave's own warnings use the @qcode{\"Octave\"}\n\
- namespace (@pxref{XREFwarning_ids}). The special identifier @qcode{\"all\"}\n\
- may be used to set the state of all warnings.\n\
- \n\
- If the first argument is @qcode{\"on\"} or @qcode{\"off\"},\n\
- set the state of a particular warning using the identifier @var{id}. If the\n\
- first argument is @qcode{\"query\"}, query the state of this warning\n\
- instead. If the identifier is omitted, a value of @qcode{\"all\"} is\n\
- assumed. If you set the state of a warning to @qcode{\"error\"}, the\n\
- warning named by @var{id} is handled as if it were an error instead. So,\n\
- for example, the following handles all warnings as errors:\n\
- \n\
- @example\n\
- @group\n\
- warning (\"error\");\n\
- @end group\n\
- @end example\n\
- \n\
- If the state is @qcode{\"on\"} or @qcode{\"off\"} and the third argument\n\
- is @qcode{\"backtrace\"}, then a stack trace is printed along with the\n\
- warning message when warnings occur inside function calls. This option\n\
- is enabled by default.\n\
- \n\
- If the state is @qcode{\"on\"}, @qcode{\"off\"}, or @qcode{\"error\"}\n\
- and the third argument is @qcode{\"local\"}, then the warning state\n\
- will be set temporarily, until the end of the current function.\n\
- Changes to warning states that are set locally affect the current\n\
- function and all functions called from the current scope. The\n\
- previous warning state is restored on return from the current\n\
- function. The @qcode{\"local\"} option is ignored if used in the top-level\n\
- workspace.\n\
- \n\
- Implementation Note: For compatibility with @sc{matlab}, escape\n\
- sequences (e.g., \"\\n\" => newline) are processed in @var{template}\n\
- regardless of whether @var{template} has been defined within single quotes\n\
- as long as there are two or more input arguments.\n\
- Use a second backslash to stop interpolation of the escape sequence (e.g.,\n\
- \"\\\\n\") or use the @code{regexptranslate} function.\n\
- @seealso{warning_ids, lastwarn, error}\n\
- @end deftypefn")
- {
- octave_value retval;
- int nargin = args.length ();
- int argc = nargin + 1;
- bool done = false;
- if (argc > 1 && args.all_strings_p ())
- {
- string_vector argv = args.make_argv ("warning");
- if (! error_state)
- {
- std::string arg1 = argv(1);
- std::string arg2 = "all";
- if (argc >= 3)
- arg2 = argv(2);
- if (arg1 == "on" || arg1 == "off" || arg1 == "error")
- {
- octave_map old_warning_options = warning_options;
- if (argc == 4 && argv(3) == "local"
- && ! symbol_table::at_top_level ())
- {
- symbol_table::scope_id scope
- = octave_call_stack::current_scope ();
- symbol_table::context_id context
- = octave_call_stack::current_context ();
- octave_scalar_map val = warning_query (arg2);
- octave_value curr_state = val.contents ("state");
- // FIXME: this might be better with a dictionary object.
- octave_value curr_warning_states
- = symbol_table::varval (".saved_warning_states.",
- scope, context);
- octave_map m;
- if (curr_warning_states.is_defined ())
- m = curr_warning_states.map_value ();
- else
- {
- string_vector fields (2);
- fields(0) = "identifier";
- fields(1) = "state";
- m = octave_map (dim_vector (0, 1), fields);
- }
- if (error_state)
- panic_impossible ();
- Cell ids = m.contents ("identifier");
- Cell states = m.contents ("state");
- octave_idx_type nel = states.numel ();
- bool found = false;
- octave_idx_type i;
- for (i = 0; i < nel; i++)
- {
- std::string id = ids(i).string_value ();
- if (error_state)
- panic_impossible ();
- if (id == arg2)
- {
- states(i) = curr_state;
- found = true;
- break;
- }
- }
- if (! found)
- {
- m.resize (dim_vector (nel+1, 1));
- ids.resize (dim_vector (nel+1, 1));
- states.resize (dim_vector (nel+1, 1));
- ids(nel) = arg2;
- states(nel) = curr_state;
- }
- m.contents ("identifier") = ids;
- m.contents ("state") = states;
- symbol_table::assign
- (".saved_warning_states.", m, scope, context);
- // Now ignore the "local" argument and continue to
- // handle the current setting.
- argc--;
- }
- if (arg2 == "all")
- {
- octave_map tmp;
- Cell id (1, 1);
- Cell st (1, 1);
- id(0) = arg2;
- st(0) = arg1;
- // Since internal Octave functions are not
- // compatible, turning all warnings into errors
- // should leave the state of
- // Octave:matlab-incompatible alone.
- if (arg1 == "error"
- && warning_options.contains ("identifier"))
- {
- octave_idx_type n = 1;
- Cell tid = warning_options.contents ("identifier");
- Cell tst = warning_options.contents ("state");
- for (octave_idx_type i = 0; i < tid.numel (); i++)
- {
- octave_value vid = tid(i);
- if (vid.is_string ())
- {
- std::string key = vid.string_value ();
- if (key == "Octave:matlab-incompatible"
- || key == "Octave:single-quote-string")
- {
- id.resize (dim_vector (1, n+1));
- st.resize (dim_vector (1, n+1));
- id(n) = tid(i);
- st(n) = tst(i);
- n++;
- }
- }
- }
- }
- tmp.assign ("identifier", id);
- tmp.assign ("state", st);
- warning_options = tmp;
- done = true;
- }
- else if (arg2 == "backtrace")
- {
- if (arg1 != "error")
- {
- Vbacktrace_on_warning = (arg1 == "on");
- done = true;
- }
- }
- else if (arg2 == "debug")
- {
- if (arg1 != "error")
- {
- Vdebug_on_warning = (arg1 == "on");
- done = true;
- }
- }
- else if (arg2 == "verbose")
- {
- if (arg1 != "error")
- {
- Vverbose_warning = (arg1 == "on");
- done = true;
- }
- }
- else if (arg2 == "quiet")
- {
- if (arg1 != "error")
- {
- Vquiet_warning = (arg1 == "on");
- done = true;
- }
- }
- else
- {
- if (arg2 == "last")
- arg2 = Vlast_warning_id;
- set_warning_option (arg1, arg2);
- done = true;
- }
- if (done && nargout > 0)
- retval = old_warning_options;
- }
- else if (arg1 == "query")
- {
- if (arg2 == "all")
- retval = warning_options;
- else if (arg2 == "backtrace" || arg2 == "debug"
- || arg2 == "verbose" || arg2 == "quiet")
- {
- octave_scalar_map tmp;
- tmp.assign ("identifier", arg2);
- if (arg2 == "backtrace")
- tmp.assign ("state", Vbacktrace_on_warning ? "on" : "off");
- else if (arg2 == "debug")
- tmp.assign ("state", Vdebug_on_warning ? "on" : "off");
- else if (arg2 == "verbose")
- tmp.assign ("state", Vverbose_warning ? "on" : "off");
- else
- tmp.assign ("state", Vquiet_warning ? "on" : "off");
- retval = tmp;
- }
- else
- retval = warning_query (arg2);
- done = true;
- }
- }
- }
- else if (argc == 1)
- {
- if (nargout > 0)
- retval = warning_options;
- else
- display_warning_options (octave_stdout);
- done = true;
- }
- else if (argc == 2)
- {
- octave_value arg = args(0);
- octave_map old_warning_options = warning_options;
- if (arg.is_map ())
- {
- octave_map m = arg.map_value ();
- if (m.contains ("identifier") && m.contains ("state"))
- {
- // Simply step through the struct elements one at a time.
- Cell ident = m.contents ("identifier");
- Cell state = m.contents ("state");
- octave_idx_type nel = ident.numel ();
- for (octave_idx_type i = 0; i < nel; i++)
- {
- std::string tst = state(i).string_value ();
- std::string tid = ident(i).string_value ();
- if (error_state)
- return retval;
- set_warning_option (tst, tid);
- }
- }
- else
- error ("warning: expecting structure with fields 'identifier' and 'state'");
- done = true;
- if (nargout > 0)
- retval = old_warning_options;
- }
- }
- if (! (error_state || done))
- {
- octave_value_list nargs = args;
- std::string id;
- bool have_fmt = maybe_extract_message_id ("warning", args, nargs, id);
- if (error_state)
- return retval;
- std::string prev_msg = Vlast_warning_message;
- std::string curr_msg = handle_message (warning_with_id, id.c_str (),
- "unspecified warning", nargs,
- have_fmt);
- if (nargout > 0)
- retval = prev_msg;
- }
- return retval;
- }
- octave_value_list
- set_warning_state (const std::string& id, const std::string& state)
- {
- octave_value_list args;
- args(1) = id;
- args(0) = state;
- return Fwarning (args, 1);
- }
- octave_value_list
- set_warning_state (const octave_value_list& args)
- {
- return Fwarning (args, 1);
- }
- void
- disable_warning (const std::string& id)
- {
- set_warning_option ("off", id);
- }
- void
- initialize_default_warning_state (void)
- {
- initialize_warning_options ("on");
- // Most people will want to have the following disabled.
- disable_warning ("Octave:array-to-scalar");
- disable_warning ("Octave:array-to-vector");
- disable_warning ("Octave:imag-to-real");
- disable_warning ("Octave:matlab-incompatible");
- disable_warning ("Octave:missing-semicolon");
- disable_warning ("Octave:neg-dim-as-zero");
- disable_warning ("Octave:resize-on-range-error");
- disable_warning ("Octave:separator-insert");
- disable_warning ("Octave:single-quote-string");
- disable_warning ("Octave:str-to-num");
- disable_warning ("Octave:mixed-string-concat");
- disable_warning ("Octave:variable-switch-label");
- }
- DEFUN (lasterror, args, ,
- "-*- texinfo -*-\n\
- @deftypefn {Built-in Function} {@var{lasterr} =} lasterror ()\n\
- @deftypefnx {Built-in Function} {} lasterror (@var{err})\n\
- @deftypefnx {Built-in Function} {} lasterror (\"reset\")\n\
- Query or set the last error message structure. When called without\n\
- arguments, return a structure containing the last error message and other\n\
- information related to this error. The elements of the structure are:\n\
- \n\
- @table @code\n\
- @item message\n\
- The text of the last error message\n\
- \n\
- @item identifier\n\
- The message identifier of this error message\n\
- \n\
- @item stack\n\
- A structure containing information on where the message occurred. This may\n\
- be an empty structure if the information cannot\n\
- be obtained. The fields of the structure are:\n\
- \n\
- @table @code\n\
- @item file\n\
- The name of the file where the error occurred\n\
- \n\
- @item name\n\
- The name of function in which the error occurred\n\
- \n\
- @item line\n\
- The line number at which the error occurred\n\
- \n\
- @item column\n\
- An optional field with the column number at which the error occurred\n\
- @end table\n\
- @end table\n\
- \n\
- The last error structure may be set by passing a scalar structure, @var{err},\n\
- as input. Any fields of @var{err} that match those above are set while any\n\
- unspecified fields are initialized with default values.\n\
- \n\
- If @code{lasterror} is called with the argument @qcode{\"reset\"}, all\n\
- fields are set to their default values.\n\
- @seealso{lasterr, error, lastwarn}\n\
- @end deftypefn")
- {
- octave_value retval;
- int nargin = args.length ();
- unwind_protect frame;
- frame.protect_var (error_state);
- error_state = 0;
- if (nargin < 2)
- {
- octave_scalar_map err;
- err.assign ("message", Vlast_error_message);
- err.assign ("identifier", Vlast_error_id);
- err.assign ("stack", octave_value (Vlast_error_stack));
- if (nargin == 1)
- {
- if (args(0).is_string ())
- {
- if (args(0).string_value () == "reset")
- {
- Vlast_error_message = std::string ();
- Vlast_error_id = std::string ();
- Vlast_error_stack = initialize_last_error_stack ();
- }
- else
- error ("lasterror: unrecognized string argument");
- }
- else if (args(0).is_map ())
- {
- octave_scalar_map new_err = args(0).scalar_map_value ();
- octave_scalar_map new_err_stack;
- std::string new_error_message;
- std::string new_error_id;
- std::string new_error_file;
- std::string new_error_name;
- int new_error_line = -1;
- int new_error_column = -1;
- if (! error_state && new_err.contains ("message"))
- {
- const std::string tmp =
- new_err.getfield ("message").string_value ();
- new_error_message = tmp;
- }
- if (! error_state && new_err.contains ("identifier"))
- {
- const std::string tmp =
- new_err.getfield ("identifier").string_value ();
- new_error_id = tmp;
- }
- if (! error_state && new_err.contains ("stack"))
- {
- new_err_stack =
- …
Large files files are truncated, but you can click here to view the full file