view libinterp/corefcn/event-queue.h @ 20569:b70cc4bd8109

begin removal of global error_state variable * gripes.h, gripes.cc (gripe_library_execution_error): Delete. * error.cc (warning_state): Delete unused variable. (reset_error_handler): Don't set warning_state or error_state. (debug_or_throw_exception): New static function. (verror): Don't check error_state. (vmessage): Call debug_or_throw_exception instead of setting error_state. (error_1, error_2): Combine into single function, error_1 that prints error message and ultimately calls debug_or_throw_exception. (verror, verror_with_cfn, verror_with_id_cfn): Call error_1. Don't check or set warning_state. (error): Don't check error_state. (Flasterror, Flasterr): Adapt to not using error_state. (interpreter_try): Don't unwind_protect error_state. * NEWS: Update. * doc/interpreter/external.txi: Explain octave_execution_exception instead of error_state for matrix addition example. * jit-typeinfo.cc (octave_jit_gripe_nan_to_logical_conversion, octave_jit_ginvalid_index, octave_jit_gindex_range, octave_jit_paren_scalar, octave_jit_paren_scalar_subsasgn): Don't catch octave_execution_exception. * cellfun.cc (Fcellfun): Use exceptions instead of error_state. * ls-mat-ascii.cc (save_mat_ascii_data): Likewise. * mex.cc (mexCallMATLAB, mexEvalString): Likewise. * variables.cc (safe_symbol_lookup): Likewise. * svd.cc (Fsvd): Eliminate use of error_state. * __magick_read__.cc (read_file, write_file): Likewise. * variables.cc (generate_struct_completions): Eliminate use of obsolete warning_state variable. * ov-builtin.cc (octave_builtin::do_multi_index_op): Don't catch octave_execution_exception and call gripe_library_execution_error. * ov-class.cc (octave_class::reconstruct_exemplar): Eliminate use of error_state. Catch possible octave_execution_exception in do_multi_index_op. * ov-mex-fcn.cc (octave_mex_function::do_multi_index_op): Eliminate use of error_state. Catch possible octave_execution_exception in call_mex. * ov-fcn-handle.cc (octave_fcn_binder::maybe_binder): Eliminate use of error_state. * ov-oncleanup.cc (octave_oncleanup::~octave_oncleanup): Eliminate use of error_state. Propagate possible octave_execution_exception from do_multi_index_op. * ov.cc (octave_value::assign, do_binary_op, do_unary_op, octave_value::do_non_const_unary_op): Don't catch octave_execution_exception here. * oct-parse.in.yy (octave_base_parser::finish_colon_expression, octave_base_parser::finish_array_list): Eliminate use of warning_state and error_state. (Feval, Fevalin): Use exceptions instead of error_state. * pt-eval.cc, pt-eval.h (tree_evaluator::unwind_protect_exception): New static variable. * (tree_evaluator::visit_statement): Don't catch octave_execution_exception here. (tree_evaluator::visit_try_catch_command, tree_evaluator::do_unwind_protect_cleanup): Eliminate use of error_state. (tree_evaluator::visit_unwind_protect_command): Use unwind_protect_exception to track whether an exception has occurred in the try block.
author John W. Eaton <jwe@octave.org>
date Thu, 01 Oct 2015 16:18:19 -0400
parents 4197fc428c7d
children c547458dc10e
line wrap: on
line source

/*

Copyright (C) 2012-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/>.

*/

#if !defined (octave_event_queue_h)
#define octave_event_queue_h 1

#include <queue>
#include <memory>

#include "action-container.h"

class
event_queue : public action_container
{
public:

  event_queue (void) : fifo () { }

  // Destructor should not raise an exception, so all actions
  // registered should be exception-safe (but setting error_state is
  // allowed). If you're not sure, see event_queue_safe.

  ~event_queue (void) { run (); }

  void add (elem *new_elem)
  {
    fifo.push (new_elem);
  }

  void run_first (void)
  {
    if (! empty ())
      {
        // No leak on exception!
        std::auto_ptr<elem> ptr (fifo.front ());
        fifo.pop ();
        ptr->run ();
      }
  }

  void discard_first (void)
  {
    if (! empty ())
      {
        elem *ptr = fifo.front ();
        fifo.pop ();
        delete ptr;
      }
  }

  size_t size (void) const { return fifo.size (); }

protected:

  std::queue<elem *> fifo;

private:

  // No copying!

  event_queue (const event_queue&);

  event_queue& operator = (const event_queue&);
};

// Like event_queue, but this one will guard against the
// possibility of seeing an exception (or interrupt) in the cleanup
// actions. Not that we can do much about it, but at least we won't
// crash.

class
event_queue_safe : public event_queue
{
private:

  static void gripe_exception (void);

public:

  event_queue_safe (void) : event_queue () { }

  ~event_queue_safe (void)
  {
    while (! empty ())
      {
        try
          {
            run_first ();
          }
        catch (...) // Yes, the black hole. Remember we're in a dtor.
          {
            gripe_exception ();
          }
      }
  }

private:

  // No copying!

  event_queue_safe (const event_queue_safe&);

  event_queue_safe& operator = (const event_queue_safe&);
};

#endif