bp-table.cc

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2001-2025 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// 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
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
 
#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif
 
#include <algorithm>
#include <limits>
#include <list>
#include <map>
#include <set>
#include <string>
#include <vector>
 
#include "file-ops.h"
#include "oct-env.h"
 
#include "bp-table.h"
#include "cdef-utils.h"
#include "defun-int.h"
#include "error.h"
#include "event-manager.h"
#include "interpreter.h"
#include "interpreter-private.h"
#include "oct-map.h"
#include "ov-usr-fcn.h"
#include "ov.h"
#include "ovl.h"
#include "pager.h"
#include "parse.h"
#include "pt-eval.h"
#include "pt-exp.h"
#include "pt-stmt.h"
#include "sighandlers.h"
 
OCTAVE_BEGIN_NAMESPACE(octave)
 
class bp_file_info
{
public:
 
  bp_file_info (tree_evaluator& tw, const std::string& file)
    : m_ok (false), m_file (file), m_dir (), m_fcn (), m_class_name ()
  {
    std::string abs_file = sys::env::make_absolute (file);
 
    std::string dir = sys::file_ops::dirname (abs_file);
    std::string fcn = sys::file_ops::tail (abs_file);
    std::size_t len = fcn.length ();
    if (len >= 2 && fcn[len-2] == '.' && fcn[len-1] == 'm')
      fcn = fcn.substr (0, len-2);
 
    std::size_t pos = dir.rfind (sys::file_ops::dir_sep_chars ());
 
    if (pos != std::string::npos && pos < dir.length () - 1)
      {
        if (dir[pos+1] == '@')
          {
            m_class_name = dir.substr (pos+1);
 
            fcn = sys::file_ops::concat (m_class_name, fcn);
 
            dir = dir.substr (0, pos);
          }
      }
 
    m_dir = dir;
    m_fcn = fcn;
 
    interpreter& interp = tw.get_interpreter ();
 
    load_path& lp = interp.get_load_path ();
 
    if (lp.contains_file_in_dir (m_file, m_dir))
      m_ok = true;
  }
 
  std::string file () const { return m_file; }
  std::string dir () const { return m_fcn; }
  std::string fcn () const { return m_fcn; }
  std::string class_name () const { return m_class_name; }
 
  bool ok () const { return m_ok; }
 
private:
 
  bool m_ok;
  std::string m_file;
  std::string m_dir;
  std::string m_fcn;
  std::string m_class_name;
};
 
// Clear all reasons to stop, other than breakpoints.
 
void
bp_table::dbclear_all_signals ()
{
  interpreter& interp = m_evaluator.get_interpreter ();
  error_system& es = interp.get_error_system ();
 
  es.debug_on_error (false);
  bp_table::m_errors_that_stop.clear ();
 
  es.debug_on_caught (false);
  bp_table::m_caught_that_stop.clear ();
 
  es.debug_on_warning (false);
  bp_table::m_warnings_that_stop.clear ();
 
  Vdebug_on_interrupt = false;
}
 
// Process the "warn", "errs", "caught" and "intr" fields for a call of
// "dbstop (p)".
 
void
bp_table::dbstop_process_map_args (const octave_map& mv)
{
  interpreter& interp = m_evaluator.get_interpreter ();
  error_system& es = interp.get_error_system ();
 
  // process errs
  // why so many levels of indirection needed?
  bool fail = false;
  Cell U = mv.contents ("errs");
  if (U.numel () != 1)
    fail = (U.numel () > 1);
  else
    {
      Array<octave_value> W = U.index (0);
      if (W.isempty () || W(0).isempty ())
        es.debug_on_error (true);    // like "dbstop if error" with no identifier
      else if (! W(0).iscell ())
        fail = true;
      else
        {
          Cell V = W(0).cell_value ();
          for (int i = 0; i < V.numel (); i++)
            {
              m_errors_that_stop.insert (V(i).string_value ());
              es.debug_on_error (true);
            }
        }
    }
 
  if (fail)
    error ("dbstop: invalid 'errs' field");
 
  // process caught
  // why so many levels of indirection needed?
  fail = false;
  U = mv.contents ("caught");
  if (U.numel () != 1)
    fail = (U.numel () > 1);
  else
    {
      Array<octave_value> W = U.index (0);
      if (W.isempty () || W(0).isempty ())
        es.debug_on_caught (true);  // like "dbstop if caught error" with no ID
      else if (! W(0).iscell ())
        fail = true;
      else
        {
          Cell V = W(0).cell_value ();
          for (int i = 0; i < V.numel (); i++)
            {
              m_caught_that_stop.insert (V(i).string_value ());
              es.debug_on_caught (true);
            }
        }
    }
 
  if (fail)
    error ("dbstop: invalid 'caught' field");
 
  // process warn
  // why so many levels of indirection needed?
  fail = false;
  U = mv.contents ("warn");
  if (U.numel () != 1)
    fail = (U.numel () > 1);
  else
    {
      Array<octave_value> W = U.index (0);
      if (W.isempty () || W(0).isempty ())
        es.debug_on_warning (true);    // like "dbstop if warning" with no identifier
      else if (! W(0).iscell ())
        fail = true;
      else
        {
          Cell V = W(0).cell_value ();
          for (int i = 0; i < V.numel (); i++)
            {
              m_warnings_that_stop.insert (V(i).string_value ());
              es.debug_on_warning (true);
            }
        }
    }
 
  if (fail)
    error ("dbstop: invalid 'warn' field");
 
  // process interrupt
  if (mv.isfield ("intr"))
    Vdebug_on_interrupt = true;
}
 
// Insert a breakpoint in function fcn at line within file fname,
// to stop only when condition is true.
// Record in m_bp_set that fname contains a breakpoint.
 
bool
bp_table::add_breakpoint_1 (octave_user_code *fcn,
                            const std::string& fcn_ident,
                            const bp_table::bp_lines& line,
                            const std::string& condition,
                            bp_table::bp_lines& retval)
{
  bool found = false;
 
  tree_statement_list *cmds = fcn->body ();
 
  std::string file = fcn->fcn_file_name ();
 
  if (cmds)
    {
      interpreter& interp = m_evaluator.get_interpreter ();
 
      event_manager& evmgr = interp.get_event_manager ();
 
      retval = cmds->add_breakpoint (evmgr, file, line, condition);
 
      for (auto& lineno : retval)
        {
          if (lineno != 0)
            {
              // Normalize to store only the file name.
              // Otherwise, there can be an entry for both
              // file>subfunction and file, which causes a crash on
              // dbclear all
              const char *s = strchr (fcn_ident.c_str (), '>');
              if (s)
                m_bp_set.insert (fcn_ident.substr (0, s - fcn_ident.c_str ()));
              else
                m_bp_set.insert (fcn_ident);
 
              found = true;
              break;
            }
        }
    }
 
  return found;
}
 
// Cursory check that cond is a valid condition to use for a breakpoint.
// Currently allows conditions with side-effects, like 'y+=10' and 'y++';
// it is odd that the former is not flagged by "is_assignment_expression".
// Throws an exception if not valid.
 
bool
bp_table::condition_valid (const std::string& cond)
{
  if (cond.length () > 0)
    {
      // ; to reject partial expr like "y=="
      parser parser (cond + " ;", m_evaluator.get_interpreter ());
      parser.reset ();
      int parse_status = parser.run ();
      if (parse_status)
        error ("dbstop: Cannot parse condition '%s'", cond.c_str ());
      else
        {
          tree_statement *stmt = nullptr;
 
          std::shared_ptr<tree_statement_list> stmt_list
            = parser.statement_list ();
 
          if (! stmt_list)
            error ("dbstop: "
                   "condition is not empty, but has nothing to evaluate");
          else
            {
              if (stmt_list->size () == 1
                  && (stmt = stmt_list->front ())
                  && stmt->is_expression ())
                {
                  tree_expression *expr = stmt->expression ();
                  if (expr->is_assignment_expression ())
                    error ("dbstop: condition cannot be an assignment.  "
                           "Did you mean '=='?");
                }
              else
                error ("dbstop: condition must be an expression");
            }
        }
    }
 
  return true;
}
 
enum dbstop_args
{
  dbstop_in,
  dbstop_at,
  dbstop_if,
  dbstop_none
};
 
// FIXME: This function probably needs to be completely overhauled to
// correctly parse the full syntax of the dbstop command and properly
// reject incorrect forms.
 
// Parse parameters (args) of dbstop and dbclear commands.
// For dbstop, who=="dbstop"; for dbclear, who=="dbclear".
// The syntax is: dbstop [[in] symbol] [[at] [method | line [line [...]]]] [if condition]
// where the form of condition depends on whether or not a file or line has
// been seen.  IF symbol and method are specified, then symbol should
// be a class name.  Otherwise it should be a function name.
// Also execute "if [error|warning|interrupt|naninf]" clauses.
 
void
bp_table::parse_dbfunction_params (const char *who,
                                   const octave_value_list& args,
                                   std::string& fcn_name,
                                   std::string& class_name,
                                   bp_table::bp_lines& lines,
                                   std::string& cond)
{
  int nargin = args.length ();
  fcn_name = "";
  class_name = "";
  lines = bp_table::bp_lines ();
 
  if (nargin == 0 || ! args(0).is_string ())
    print_usage (who);
 
  // elements already processed
  bool seen_in = false;
  bool seen_at = false;
  bool seen_if = false;
  int pos = 0;
  dbstop_args tok = dbstop_none;
  while (pos < nargin)
    {
      // allow "in" and "at" to be implicit
      if (args(pos).is_string ())
        {
          // Default value.
          tok = dbstop_in;
 
          std::string arg = args(pos).string_value ();
          if (arg == "in")
            {
              tok = dbstop_in;
              pos++;
            }
          else if (arg == "at")
            {
              tok = dbstop_at;
              pos++;
            }
          else if (arg == "if")
            {
              tok = dbstop_if;
              pos++;
            }
          else
            {
              try
                {
                  if (std::stoi (args(pos).string_value ()) > 0)
                    tok = dbstop_at;
                }
              catch (const std::invalid_argument&) { }
              catch (const std::out_of_range&) { }
            }
        }
      else
        tok = dbstop_at;
 
      if (pos >= nargin)
        error ("%s: '%s' missing argument", who,
               (tok == dbstop_in
                ? "in" : (tok == dbstop_at ? "at" : "if")));
 
      // process the actual arguments
      switch (tok)
        {
        case dbstop_in:
          fcn_name = args(pos).string_value ();
          if (seen_in)
            error ("%s: Too many function names specified -- %s",
                   who, fcn_name.c_str ());
          else if (seen_at || seen_if)
            error ("%s: function name must come before line number and 'if'",
                   who);
          seen_in = true;
          pos++;
          break;
 
        case dbstop_at:
          if (seen_at)
            error ("%s: Only one 'at' clause is allowed -- %s",
                   who, args(pos).string_value ().c_str ());
          else if (seen_if)
            error ("%s: line number must come before 'if' clause\n", who);
          seen_at = true;
 
          if (seen_if)
            error ("%s: line number must come before 'if' clause\n", who);
          else if (seen_in)
            {
              std::string arg = args(pos).string_value ();
 
              // FIXME: we really want to distinguish number
              // vs. method name here.
 
              // FIXME: I'm not sure what the
 
              bool int_conv_ok = true;
 
              try
                {
                  if (std::stoi (arg) == 0)
                    int_conv_ok = false;
                }
              catch (const std::invalid_argument&)
                {
                  int_conv_ok = false;
                }
              catch (const std::out_of_range&)
                {
                  int_conv_ok = false;
                }
 
              if (! int_conv_ok)
                {
                  // Assume we are looking at a function name.
                  // We have class and function names but already
                  // stored the class name in fcn_name.
                  class_name = fcn_name;
                  fcn_name = arg;
                  pos++;
                  break;
                }
 
            }
          else
            {
              // It was a line number.  Get function name from debugger.
              if (m_evaluator.in_debug_repl ())
                fcn_name = m_evaluator.get_user_code ()->profiler_name ();
              else
                error ("%s: function name must come before line number "
                       "and 'if'", who);
              seen_in = true;
            }
 
          // Read a list of line numbers (or arrays thereof)
          for ( ; pos < nargin; pos++)
            {
              if (args(pos).is_string ())
                {
                  std::string str = args(pos).string_value ();
 
                  try
                    {
                      int line = std::stoi (str);
 
                      if (line > 0)
                        lines.insert (line);
                      else
                        break; // may be "if" or a method name
                    }
                  catch (const std::invalid_argument&)
                    {
                      break; // may be "if" or a method name
                    }
                  catch (const std::out_of_range&)
                    {
                      error ("dbstop: location value out of range '%s'", str.c_str ());
                    }
                }
              else if (args(pos).isnumeric ())
                {
                  const NDArray arg = args(pos).array_value ();
 
                  for (octave_idx_type j = 0; j < arg.numel (); j++)
                    lines.insert (static_cast<int> (arg.elem (j)));
                }
              else
                error ("%s: Invalid argument type %s",
                       who, args(pos).type_name ().c_str ());
            }
          break;
 
        case dbstop_if:
          if (seen_in)    // conditional breakpoint
            {
              cond = "";  // remaining arguments form condition
              for (; pos < nargin; pos++)
                {
                  if (args(pos).is_string ())
                    cond += ' ' + args(pos).string_value ();
                  else
                    error ("%s: arguments to 'if' must all be strings", who);
                }
 
              cond = cond.substr (1);   // omit initial space
            }
          else    // stop on event (error, warning, interrupt, NaN/inf)
            {
              std::string condition = args(pos).string_value ();
              bool on_off = ! strcmp (who, "dbstop");
 
              // FIXME: the following seems a bit messy in the way it
              // duplicates checks on CONDITION.
 
              if (condition == "error")
                process_id_list (who, condition, args, nargin, pos, on_off,
                                 m_errors_that_stop);
              else if (condition == "warning")
                process_id_list (who, condition, args, nargin, pos, on_off,
                                 m_warnings_that_stop);
              else if (condition == "caught" && nargin > pos+1
                       && args(pos+1).string_value () == "error")
                {
                  pos++;
                  process_id_list (who, condition, args, nargin, pos, on_off,
                                   m_caught_that_stop);
                }
              else if (condition == "interrupt")
                {
                  Vdebug_on_interrupt = on_off;
                }
              else if (condition == "naninf")
                {
#if defined (DBSTOP_NANINF)
                  Vdebug_on_naninf = on_off;
                  enable_fpe (on_off);
#else
                  warning ("%s: condition '%s' not yet supported",
                           who, condition.c_str ());
#endif
                }
              else
                error ("%s: invalid condition %s",
                       who, condition.c_str ());
 
              pos = nargin;
            }
          break;
 
        default:      // dbstop_none should never occur
          break;
        }
    }
}
 
/*
%!test
%! if (isguirunning ())
%!   orig_show_dbg = __event_manager_gui_preference__ ("editor/show_dbg_file",
%!                                                     "false");
%! endif
%! unwind_protect
%!   dbclear all;   # Clear out breakpoints before test
%!   dbstop help;
%!   dbstop in ls;
%!   dbstop help at 105;  # 105 is a comment; code line is at 106
%!   dbstop in ls 123;    # 123 is a comment; code line is at 126
%!   dbstop help 204 if a==5;
%!   dbstop if error Octave:undefined-function;
%!   s = dbstatus;
%!   dbclear all;
%!   assert ({s.bkpt(:).name}, {"help", "help", "help>do_contents", "ls", "ls"});
%!   assert ([s.bkpt(:).line], [56, 106, 208, 63, 126]);
%!   assert (s.errs, {"Octave:undefined-function"});
%! unwind_protect_cleanup
%!   if (isguirunning ())
%!     __event_manager_gui_preference__ ("editor/show_dbg_file", orig_show_dbg);
%!   endif
%! end_unwind_protect
*/
 
void
bp_table::set_stop_flag (const char *who, const std::string& condition,
                         bool on_off)
{
  interpreter& interp = m_evaluator.get_interpreter ();
  error_system& es = interp.get_error_system ();
 
  if (condition == "error")
    es.debug_on_error (on_off);
  else if (condition == "warning")
    es.debug_on_warning (on_off);
  else if (condition == "caught")
    es.debug_on_caught (on_off);
  else
    error ("%s: internal error in set_stop_flag", who);
}
 
void
bp_table::process_id_list (const char *who,
                           const std::string& condition,
                           const octave_value_list& args,
                           int nargin, int& pos, bool on_off,
                           std::set<std::string>& id_list)
{
  pos++;
 
  if (nargin > pos)       // only affect a single error ID
    {
      if (! args(pos).is_string () || nargin > pos+1)
        error ("%s: ID must be a single string", who);
      else if (on_off)
        {
          id_list.insert (args(pos).string_value ());
          set_stop_flag (who, condition, true);
        }
      else
        {
          id_list.erase (args(pos).string_value ());
          if (id_list.empty ())
            set_stop_flag (who, condition, false);
        }
    }
  else   // unqualified.  Turn all on or off
    {
      id_list.clear ();
      set_stop_flag (who, condition, on_off);
 
      if (condition == "error")
        {
          // Matlab stops on both.
          Vdebug_on_interrupt = on_off;
        }
    }
}
 
// Return the sub/nested/main function of MAIN_FCN that contains
// line number LINENO of the source file.
// If FOUND_ENDING_LINE != 0, *FOUND_ENDING_LINE is set to last line of the returned function.
 
static octave_user_code *
find_fcn_by_line (octave_user_code *main_fcn, int lineno, int *found_end_line = nullptr)
{
  octave_user_code *retval = nullptr;
  octave_user_code *next_fcn = nullptr;  // 1st function starting after lineno
 
  // Find innermost nested (or parent) function containing lineno.
  int earliest_end = std::numeric_limits<int>::max ();
 
  std::map<std::string, octave_value> subfcns = main_fcn->subfunctions ();
  for (const auto& str_val_p : subfcns)
    {
      if (str_val_p.second.is_user_function ())
        {
          auto *dbg_subfcn = str_val_p.second.user_function_value ();
 
          // Check if lineno is within dbg_subfcn.
          // FIXME: we could break when the beginning line > lineno,
          // but that makes the code "fragile"
          // if the order of walking subfcns changes,
          // for a minor speed improvement in non-critical code.
 
          filepos beg_pos = dbg_subfcn->beg_pos ();
          filepos end_pos = dbg_subfcn->end_pos ();
 
          int beginning_line = beg_pos.line ();
          int ending_line = end_pos.line ();
 
          if (ending_line < earliest_end && ending_line >= lineno && beginning_line <= lineno)
            {
              earliest_end = ending_line;
              retval = find_fcn_by_line (dbg_subfcn, lineno, &earliest_end);
            }
 
          // Find the first fcn starting after lineno.
          // This is used if line is not inside any function.
          if (beginning_line >= lineno && ! next_fcn)
            next_fcn = dbg_subfcn;
        }
    }
 
  // The breakpoint is either in the subfunction found above,
  // or in the main function, which we check now.
  if (main_fcn->is_user_function ())
    {
      filepos end_pos = dynamic_cast<octave_user_function *> (main_fcn)->end_pos ();
 
      int ending_line = end_pos.line ();
 
      if (ending_line >= lineno && ending_line < earliest_end)
        retval = main_fcn;
 
      if (! retval)
        retval = next_fcn;
    }
  else  // main_fcn is a script.
    {
      if (! retval)
        retval = main_fcn;
    }
 
  if (found_end_line && earliest_end < *found_end_line)
    *found_end_line = earliest_end;
 
  return retval;
}
 
// Given function identifier fcn_ident, find the subfunction at line and create
// a breakpoint there.  Put the system into debug_mode.
int
bp_table::add_breakpoint_in_function (const std::string& fcn_ident,
                                      int line,
                                      const std::string& condition)
{
  bp_lines line_info;
  line_info.insert (line);
 
  bp_lines result
    = add_breakpoints_in_function (fcn_ident, line_info, condition);
 
  return result.empty () ? 0 : *(result.begin ());
}
 
// A class that encapsulates the "get_user_code" operation.
// This operation changes depending on the symbol being a function or classdef.
// Octave used to assume everything was a function, one per file.
// Classdefs can have several functions in a single file.
class user_code_provider
{
public:
  user_code_provider (const std::string& who, const std::string& fcn_ident,
                      octave_user_code *pfcn, bool silent = false)
    : m_fcn (nullptr), m_is_valid (false)
  {
    m_fcn = pfcn;
    if (m_fcn && ! (m_fcn->is_classdef_method ()
                    || m_fcn->is_classdef_constructor ()))
      {
        // Already have the usercode, no need to do anything.
        m_is_valid = true;
        return;
      }
 
    // If we get here, try to get a classdef to support getting method by
    // line number.
 
    // Extract class name from function identifier
    std::string class_name = fcn_ident;
    const char *s = strchr (fcn_ident.c_str (), '/');
    if (s && fcn_ident[0] == '@')
      class_name = fcn_ident.substr (1, s - fcn_ident.c_str () - 1);
 
    m_cls = lookup_class (class_name, false);
    m_is_valid = m_cls.ok () && (m_cls.get_name () == class_name);
    if (m_is_valid)
      populate_function_cache ();
    else if (! silent)
      error ("%s: unable to find function '%s'\n", who.c_str (),
             fcn_ident.c_str ());
 
  }
 
  octave_user_code * operator () (int line = 1)
  {
    if (! is_valid ())
      return nullptr;
 
    if (is_function ())
      return find_fcn_by_line (m_fcn, line);
 
    if (line < 0)
      return nullptr;
 
    octave_value method = m_cls.get_method (line);
    if (method.is_function_handle ())
      return method.user_function_value ()->user_code_value (true);
    else
      return method.user_code_value (true);
  }
 
  bool is_function () const { return m_fcn; }
 
  bool is_valid () const { return m_is_valid; }
 
  size_t number_of_functions () const
  {
    if (! is_valid ())
      return 0;
 
    if (is_function ())
      return 1;
 
    return m_methods_cache.size ();
  }
 
  octave_user_code * get_function (const size_t i) const
  {
    if (! is_valid ())
      return nullptr;
 
    if (is_function ())
      return m_fcn;
 
    if (i < m_methods_cache.size ())
      return m_methods_cache[i];
 
    return nullptr;
  }
 
private:
  void populate_function_cache ()
  {
    if (m_methods_cache.empty ())
      {
        // Not the most efficient, but reuses code:
        const std::map<std::string, cdef_method>& map
          = m_cls.get_method_map (false, true);
        for (const auto& meth : map)
          {
            octave_user_code *fcn
              = m_cls.get_method (meth.first).user_code_value (true);
            if (fcn != nullptr)
              m_methods_cache.push_back (fcn);
          }
 
        // Check get and set methods of properties
        const std::map<property_key, cdef_property>& prop_map
          = m_cls.get_property_map (cdef_class::property_all);
        for (const auto& prop : prop_map)
          {
            octave_value get_meth = prop.second.get ("GetMethod");
            if (get_meth.is_function_handle ())
              {
                octave_user_code *fcn
                  = get_meth.user_function_value ()->user_code_value (true);
                if (fcn != nullptr)
                  m_methods_cache.push_back (fcn);
              }
 
            octave_value set_meth = prop.second.get ("SetMethod");
            if (set_meth.is_function_handle ())
              {
                octave_user_code *fcn
                  = set_meth.user_function_value ()->user_code_value (true);
                if (fcn != nullptr)
                  m_methods_cache.push_back (fcn);
              }
          }
      }
  }
 
private:
  std::vector<octave_user_code *> m_methods_cache;
  cdef_class m_cls;
  octave_user_code *m_fcn;
  bool m_is_valid;
};
 
// Given file name fname, find the subfunction at line and create
// a breakpoint there.  Put the system into debug_mode.
bp_table::bp_lines
bp_table::add_breakpoints_in_function (const std::string& fcn_ident,
                                       const bp_table::bp_lines& lines,
                                       const std::string& condition)
{
  user_code_provider user_code ("add_breakpoints_in_function", fcn_ident,
                                m_evaluator.get_user_code (fcn_ident));
 
  condition_valid (condition);  // Throw error if condition not valid.
 
  bp_lines retval;
 
  for (const auto& lineno : lines)
    {
      octave_user_code *dbg_fcn = user_code (lineno);
 
      if (! dbg_fcn)
        error ("add_breakpoints_in_function: unable to find function '%s'\n",
               fcn_ident.c_str ());
 
      // We've found the right (sub)function.  Now insert the breakpoint.
      bp_lines line_info;
      line_info.insert (lineno);
 
      bp_lines ret_one;
 
      std::string ident = fcn_ident;
      if (! user_code.is_function () && fcn_ident[0] != '@')
        {
          // identifier of the form @class_name/method_name
          ident = "@" + fcn_ident + "/" + dbg_fcn->name ();
        }
 
      if (add_breakpoint_1 (dbg_fcn, ident, line_info, condition, ret_one))
        {
          if (! ret_one.empty ())
            {
              int line = *(ret_one.begin ());
 
              if (line)
                retval.insert (line);
            }
        }
    }
 
  m_evaluator.reset_debug_state ();
 
  return retval;
}
 
int
bp_table::add_breakpoint_in_file (const std::string& file,
                                  int line,
                                  const std::string& condition)
{
  // Duplicates what the GUI was doing previously, but this action
  // should not be specific to the GUI.
 
  bp_file_info info (m_evaluator, file);
 
  if (! info.ok ())
    return 0;
 
  std::string fcn_ident;
  if (info.class_name ().empty () || info.fcn ()[0] == '@')
    fcn_ident = info.fcn ();
  else
    fcn_ident = "@" + info.class_name () + "/" + info.fcn ();
 
  return add_breakpoint_in_function (fcn_ident, line, condition);
}
 
bp_table::bp_lines
bp_table::add_breakpoints_in_file (const std::string& file,
                                   const bp_lines& lines,
                                   const std::string& condition)
{
  // Duplicates what the GUI was doing previously, but this action
  // should not be specific to the GUI.
 
  bp_file_info info (m_evaluator, file);
 
  if (! info.ok ())
    return bp_lines ();
 
  std::string fcn_ident;
  if (info.class_name ().empty () || info.fcn ()[0] == '@')
    fcn_ident = info.fcn ();
  else
    fcn_ident = "@" + info.class_name () + "/" + info.fcn ();
 
  return add_breakpoints_in_function (fcn_ident, lines, condition);
}
 
int
bp_table::remove_breakpoint_1 (octave_user_code *fcn,
                               const std::string& fcn_ident,
                               const bp_table::bp_lines& lines)
{
  int retval = 0;
 
  std::string file = fcn->fcn_file_name ();
 
  tree_statement_list *cmds = fcn->body ();
 
  // FIXME: move the operation on cmds to the tree_statement_list class?
 
  if (cmds)
    {
      octave_value_list results = cmds->list_breakpoints ();
 
      if (results.length () > 0)
        {
          interpreter& interp = m_evaluator.get_interpreter ();
 
          event_manager& evmgr = interp.get_event_manager ();
 
          for (const auto& lineno : lines)
            {
              cmds->delete_breakpoint (lineno);
 
              if (! file.empty ())
                evmgr.update_breakpoint (false, file, lineno);
            }
 
          results = cmds->list_breakpoints ();
 
          auto it = m_bp_set.find (fcn_ident);
          if (results.empty () && it != m_bp_set.end ())
            m_bp_set.erase (it);
        }
 
      retval = results.length ();
    }
 
  return retval;
}
 
int
bp_table::remove_breakpoint_from_function (const std::string& fcn_ident,
                                           int line)
{
  bp_lines line_info;
  line_info.insert (line);
 
  return remove_breakpoints_from_function (fcn_ident, line_info);
}
 
int
bp_table::remove_breakpoints_from_function (const std::string& fcn_ident,
                                            const bp_table::bp_lines& lines)
{
  int retval = 0;
 
  if (lines.empty ())
    {
      bp_lines results = remove_all_breakpoints_from_function (fcn_ident);
      retval = results.size ();
    }
  else
    {
      octave_user_code *dbg_fcn = m_evaluator.get_user_code (fcn_ident);
      user_code_provider user_code ("remove_breakpoints_from_function",
                                    fcn_ident, dbg_fcn);
 
      // Remove all breakpoints from all functions
      for (const auto line : lines)
        {
          octave_user_code *fcn = user_code (line);
          std::string file = fcn->fcn_file_name ();
 
          tree_statement_list *cmds = fcn->body ();
          if (cmds)
            {
              octave_value_list results = cmds->list_breakpoints ();
 
              if (results.length () > 0)
                {
                  interpreter& interp = m_evaluator.get_interpreter ();
                  event_manager& evmgr = interp.get_event_manager ();
 
                  cmds->delete_breakpoint (line);
 
                  if (! file.empty ())
                    evmgr.update_breakpoint (false, file, line);
                }
            }
        }
 
      // Remove all breakpoints from all subfunctions
      if (dbg_fcn != nullptr)
        {
          // Search subfunctions in the order they appear in the file.
          const std::list<std::string> subfcn_names
            = dbg_fcn->subfunction_names ();
 
          std::map<std::string, octave_value> subfcns
            = dbg_fcn->subfunctions ();
 
          for (const auto& subf_nm : subfcn_names)
            {
              const auto q = subfcns.find (subf_nm);
 
              if (q != subfcns.end ())
                {
                  octave_user_code *dbg_subfcn
                    = q->second.user_code_value ();
 
                  retval += remove_breakpoint_1 (dbg_subfcn, fcn_ident, lines);
                }
            }
        }
      // Remove file from breakpoint set if no breakpoints remain
      octave_value_list fname_list = {fcn_ident};
      const bool no_breakpoints
        = get_breakpoint_list (fname_list).empty ();
      auto iter = m_bp_set.find (fcn_ident);
      if (no_breakpoints && iter != m_bp_set.end ())
        m_bp_set.erase (iter);
    }
 
  m_evaluator.reset_debug_state ();
 
  return retval;
}
 
// Remove all breakpoints from a file, including those in subfunctions.
 
bp_table::bp_lines
bp_table::remove_all_breakpoints_from_function (const std::string& fcn_ident,
                                                bool silent)
{
  bp_lines retval;
 
  octave_user_code *fcn = m_evaluator.get_user_code (fcn_ident);
  user_code_provider user_code ("remove_all_breakpoints_from_function",
                                fcn_ident, fcn, silent);
 
  if (user_code.is_valid ())
    {
      for (size_t i = 0; i != user_code.number_of_functions (); ++i)
        {
          octave_user_code *dbg_fcn = user_code.get_function (i);
          std::string file = dbg_fcn->fcn_file_name ();
 
          tree_statement_list *cmds = dbg_fcn->body ();
 
          if (cmds)
            {
              interpreter& interp = m_evaluator.get_interpreter ();
 
              event_manager& evmgr = interp.get_event_manager ();
 
              retval = cmds->remove_all_breakpoints (evmgr, file);
            }
        }
 
      auto it = m_bp_set.find (fcn_ident);
      if (it != m_bp_set.end ())
        m_bp_set.erase (it);
    }
 
  m_evaluator.reset_debug_state ();
 
  return retval;
}
 
int
bp_table::remove_breakpoint_from_file (const std::string& file, int line)
{
  // Duplicates what the GUI was doing previously, but this action
  // should not be specific to the GUI.
 
  bp_file_info info (m_evaluator, file);
 
  if (! info.ok ())
    return 0;
 
  return remove_breakpoint_from_function (info.fcn (), line);
}
 
int
bp_table::remove_breakpoints_from_file (const std::string& file,
                                        const bp_lines& lines)
{
  // Duplicates what the GUI was doing previously, but this action
  // should not be specific to the GUI.
 
  bp_file_info info (m_evaluator, file);
 
  if (! info.ok ())
    return 0;
 
  return remove_breakpoints_from_function (info.fcn (), lines);
}
 
bp_table::bp_lines
bp_table::remove_all_breakpoints_from_file (const std::string& file,
                                            bool silent)
{
  // Duplicates what the GUI was doing previously, but this action
  // should not be specific to the GUI.
 
  bp_file_info info (m_evaluator, file);
 
  if (! info.ok ())
    return bp_lines ();
 
  return remove_all_breakpoints_from_function (info.fcn (), silent);
}
 
void
bp_table::remove_all_breakpoints ()
{
  // Odd loop structure required because delete will invalidate
  // m_bp_set iterators.
  for (auto it = m_bp_set.cbegin (), it_next = it;
       it != m_bp_set.cend ();
       it = it_next)
    {
      ++it_next;
      remove_all_breakpoints_from_function (*it);
    }
 
  m_evaluator.reset_debug_state ();
}
 
std::string
find_bkpt_list (octave_value_list slist, std::string match)
{
  std::string retval;
 
  for (int i = 0; i < slist.length (); i++)
    {
      if (slist(i).string_value () == match)
        {
          retval = slist(i).string_value ();
          break;
        }
    }
 
  return retval;
}
 
bp_table::fname_bp_map
bp_table::get_breakpoint_list (const octave_value_list& fname_list)
{
  fname_bp_map retval;
 
  // make copy since changes may invalidate iters of m_bp_set.
  std::set<std::string> tmp_bp_set = m_bp_set;
 
  for (auto& bp_fname : tmp_bp_set)
    {
      if (fname_list.empty ()
          || find_bkpt_list (fname_list, bp_fname) != "")
        {
          octave_user_code *dbg_fcn = m_evaluator.get_user_code (bp_fname);
          user_code_provider user_code ("get_breakpoint_list", bp_fname,
                                        dbg_fcn);
          // Gather breakpoints from all functions in the file
          std::list<bp_type> all_bkpts;
          std::list<bp_type>::iterator it (all_bkpts.begin ());
          for (size_t i = 0; i != user_code.number_of_functions (); ++i)
            {
              octave_user_code *fcn = user_code.get_function (i);
              if (fcn)
                {
                  tree_statement_list *cmds = fcn->body ();
                  // FIXME: move the operation on cmds to the
                  //        tree_statement_list class?
                  if (cmds)
                    {
                      const std::list<bp_type>& bp
                        = cmds->breakpoints_and_conds ();
                      if (!bp.empty())
                        it = all_bkpts.insert (it, bp.cbegin (),
                                               bp.cend ());
                    }
                }
            }
 
          if (! all_bkpts.empty ())
            retval[bp_fname] = all_bkpts;
 
          // look for breakpoints in subfunctions
          // Assuming classdefs can't have subfunctions
          if (dbg_fcn != nullptr)
            {
              const std::list<std::string> subf_nm
                = dbg_fcn->subfunction_names ();
 
              std::map<std::string, octave_value> subfcns
                = dbg_fcn->subfunctions ();
 
              for (const auto& subfcn_nm : subf_nm)
                {
                  const auto q = subfcns.find (subfcn_nm);
 
                  if (q != subfcns.end ())
                    {
                      octave_user_code *dbg_subfcn
                        = q->second.user_code_value ();
 
                      tree_statement_list *cmds = dbg_subfcn->body ();
                      if (cmds)
                        {
                          std::list<bp_type> bkpts
                            = cmds->breakpoints_and_conds ();
 
                          if (! bkpts.empty ())
                            {
                              std::string key
                                = bp_fname + '>' + dbg_subfcn->name ();
 
                              retval[key] = bkpts;
                            }
                        }
                    }
                }
            }
        }
    }
 
  return retval;
}
 
// Report the status of "dbstop if error ..." and "dbstop if warning ..."
// If to_screen is true, the output goes to octave_stdout; otherwise it is
// returned.
// If dbstop if error is true but no explicit IDs are specified, the return
// value will have an empty field called "errs".  If IDs are specified, the
// "errs" field will have a row per ID.  If dbstop if error is false, there
// is no "errs" field.  The "warn" field is set similarly by dbstop if warning
 
octave_map
bp_table::stop_on_err_warn_status (bool to_screen)
{
  octave_map retval;
 
  interpreter& interp = m_evaluator.get_interpreter ();
  error_system& es = interp.get_error_system ();
 
  // print dbstop if error information
  if (es.debug_on_error ())
    {
      if (m_errors_that_stop.empty ())
        {
          if (to_screen)
            octave_stdout << "stop if error\n";
          else
            retval.assign ("errs", octave_value (""));
        }
      else
        {
          Cell errs (dim_vector (bp_table::m_errors_that_stop.size (), 1));
          int i = 0;
 
          for (const auto& e : m_errors_that_stop)
            {
              if (to_screen)
                octave_stdout << "stop if error " << e << "\n";
              else
                errs(i++) = e;
            }
          if (! to_screen)
            retval.assign ("errs", octave_value (errs));
        }
    }
 
  // print dbstop if caught error information
  if (es.debug_on_caught ())
    {
      if (m_caught_that_stop.empty ())
        {
          if (to_screen)
            octave_stdout << "stop if caught error\n";
          else
            retval.assign ("caught", octave_value (""));
        }
      else
        {
          Cell errs (dim_vector (m_caught_that_stop.size (), 1));
          int i = 0;
 
          for (const auto& e : m_caught_that_stop)
            {
              if (to_screen)
                octave_stdout << "stop if caught error " << e << "\n";
              else
                errs(i++) = e;
            }
          if (! to_screen)
            retval.assign ("caught", octave_value (errs));
        }
    }
 
  // print dbstop if warning information
  if (es.debug_on_warning ())
    {
      if (m_warnings_that_stop.empty ())
        {
          if (to_screen)
            octave_stdout << "stop if warning\n";
          else
            retval.assign ("warn", octave_value (""));
        }
      else
        {
          Cell warn (dim_vector (m_warnings_that_stop.size (), 1));
          int i = 0;
 
          for (const auto& w : m_warnings_that_stop)
            {
              if (to_screen)
                octave_stdout << "stop if warning " << w << "\n";
              else
                warn(i++) = w;
            }
          if (! to_screen)
            retval.assign ("warn", octave_value (warn));
        }
    }
 
  // print dbstop if interrupt information
  if (Vdebug_on_interrupt)
    {
      if (to_screen)
        octave_stdout << "stop if interrupt\n";
      else
        retval.assign ("intr", octave_value (""));
    }
 
  return retval;
}
 
OCTAVE_END_NAMESPACE(octave)