Mercurial > octave
view liboctave/util/quit.h @ 25054:6652d3823428 stable
maint: Update copyright dates in all source files.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 30 Mar 2018 09:19:05 -0400 |
parents | 194eb4bd202b |
children | 5960fd1b56f1 |
line wrap: on
line source
/* Copyright (C) 2002-2018 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 <https://www.gnu.org/licenses/>. */ #if ! defined (octave_quit_h) #define octave_quit_h 1 #include "octave-config.h" /* The signal header is just needed for the sig_atomic_t type. */ #if defined (__cplusplus) # include <csignal> # include <string> extern "C" { #else # include <signal.h> #endif #if defined (__cplusplus) namespace octave { class execution_exception { public: execution_exception (void) : m_stack_trace () { } execution_exception (const execution_exception& x) : m_stack_trace (x.m_stack_trace) { } execution_exception& operator = (const execution_exception& x) { if (&x != this) m_stack_trace = x.m_stack_trace; return *this; } ~execution_exception (void) = default; virtual void set_stack_trace (const std::string& st) { m_stack_trace = st; } virtual void set_stack_trace (void) { m_stack_trace = ""; } virtual std::string info (void) const { return m_stack_trace; } private: std::string m_stack_trace; }; class exit_exception { public: exit_exception (int exit_status = 0, bool safe_to_return = false) : m_exit_status (exit_status), m_safe_to_return (safe_to_return) { } exit_exception (const exit_exception& ex) : m_exit_status (ex.m_exit_status), m_safe_to_return (ex.m_safe_to_return) { } exit_exception& operator = (exit_exception& ex) { if (this != &ex) { m_exit_status = ex.m_exit_status; m_safe_to_return = ex.m_safe_to_return; } return *this; } ~exit_exception (void) = default; int exit_status (void) const { return m_exit_status; } bool safe_to_return (void) const { return m_safe_to_return; } private: int m_exit_status; bool m_safe_to_return; }; class interrupt_exception { }; } OCTAVE_DEPRECATED (4.2, "use 'octave::execution_exception' instead") typedef octave::execution_exception octave_execution_exception; OCTAVE_DEPRECATED (4.2, "use 'octave::exit_exception' instead") typedef octave::exit_exception octave_exit_exception; OCTAVE_DEPRECATED (4.2, "use 'octave::interrupt_exception' instead") typedef octave::interrupt_exception octave_interrupt_exception; #endif enum octave_exception { octave_no_exception = 0, octave_exec_exception = 1, octave_alloc_exception = 3, octave_quit_exception = 4 }; /* > 0: interrupt pending 0: no interrupt pending < 0: handling interrupt */ OCTAVE_API extern sig_atomic_t octave_interrupt_state; OCTAVE_API extern sig_atomic_t octave_exception_state; OCTAVE_DEPRECATED (4.4, "see the Octave documentation for other options") OCTAVE_API extern sig_atomic_t octave_exit_exception_status; OCTAVE_DEPRECATED (4.4, "see the Octave documentation for other options") OCTAVE_API extern sig_atomic_t octave_exit_exception_safe_to_return; OCTAVE_API extern volatile sig_atomic_t octave_signal_caught; OCTAVE_API extern void octave_handle_signal (void); OCTAVE_NORETURN OCTAVE_API extern void octave_throw_interrupt_exception (void); OCTAVE_NORETURN OCTAVE_API extern void octave_throw_execution_exception (void); OCTAVE_NORETURN OCTAVE_API extern void octave_throw_bad_alloc (void); OCTAVE_DEPRECATED (4.4, "see the Octave documentation for other options") OCTAVE_NORETURN OCTAVE_API extern void octave_throw_exit_exception (int exit_status, int safe_to_return); OCTAVE_API extern void octave_rethrow_exception (void); #if defined (__cplusplus) OCTAVE_DEPRECATED (4.4, "see the Octave documentation for other options") extern OCTAVE_API void clean_up_and_exit (int exit_status, bool safe_to_return = false); inline void octave_quit (void) { if (octave_signal_caught) { octave_signal_caught = 0; octave_handle_signal (); } }; #define OCTAVE_QUIT octave_quit () #else #define OCTAVE_QUIT \ do \ { \ if (octave_signal_caught) \ { \ octave_signal_caught = 0; \ octave_handle_signal (); \ } \ } \ while (0) #endif /* The following macros are obsolete. Interrupting immediately by calling siglongjmp or similar from a signal handler is asking for trouble. We need another way to handle that situation. Rather than remove them, however, please leave them in place until we can either find a replacement or determine that a given block of code does not need special treatment. They are defined to create a dummy do-while block to match the previous definitions. */ #define BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE \ do \ { #define END_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE \ } \ while (0) #if defined (__cplusplus) /* Likewise, these are obsolete. They are defined to create a dummy scope to match the previous versions that created a try-catch block. */ #define BEGIN_INTERRUPT_WITH_EXCEPTIONS \ { #define END_INTERRUPT_WITH_EXCEPTIONS \ } #endif #if defined (__cplusplus) } /* These should only be declared for C++ code, and should also be outside of any extern "C" block. */ extern OCTAVE_API void (*octave_signal_hook) (void); extern OCTAVE_API void (*octave_interrupt_hook) (void); extern OCTAVE_API void (*octave_bad_alloc_hook) (void); #endif #endif