quit.h File Reference

#include "octave-config.h"
#include <signal.h>

Include dependency graph for quit.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE
#define	END_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE
#define	OCTAVE_QUIT

Enumerations
enum	octave_exception { octave_no_exception = 0 , octave_exec_exception = 1 , octave_alloc_exception = 3 , octave_quit_exception = 4 }

Functions
OCTAVE_API void	octave_handle_signal (void)
OCTAVE_API void	octave_rethrow_exception (void)
OCTAVE_NORETURN OCTAVE_API void	octave_throw_bad_alloc (void)
OCTAVE_NORETURN OCTAVE_API void	octave_throw_execution_exception (void)
OCTAVE_NORETURN OCTAVE_API void	octave_throw_interrupt_exception (void)

Variables
OCTAVE_API sig_atomic_t	octave_exception_state
OCTAVE_API sig_atomic_t	octave_interrupt_state
OCTAVE_API volatile sig_atomic_t	octave_signal_caught

Macro Definition Documentation

BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE

#define BEGIN_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE

Value:

  do                                                    \
    {

Definition at line 280 of file quit.h.

END_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE

#define END_INTERRUPT_IMMEDIATELY_IN_FOREIGN_CODE

Value:

    }                                                   \
  while (0)

Definition at line 284 of file quit.h.

OCTAVE_QUIT

#define OCTAVE_QUIT

Value:

  do                                            \
    {                                           \
      if (octave_signal_caught)                 \
        {                                       \
          octave_signal_caught = 0;             \
          octave_handle_signal ();              \
        }                                       \
    }                                           \
  while (0)

Definition at line 261 of file quit.h.

Enumeration Type Documentation

octave_exception

enum octave_exception

Enumerator
octave_no_exception
octave_exec_exception
octave_alloc_exception
octave_quit_exception

Definition at line 211 of file quit.h.

Function Documentation

octave_handle_signal()

OCTAVE_API void octave_handle_signal

(

void

)

Definition at line 121 of file quit.cc.

References octave_interrupt_state, and octave_signal_hook.

octave_rethrow_exception()

OCTAVE_API void octave_rethrow_exception

(

void

)

Definition at line 166 of file quit.cc.

References internal_exception_state, octave_internal_alloc_exception, octave_internal_exec_exception, and octave_interrupt_state.

octave_throw_bad_alloc()

OCTAVE_NORETURN OCTAVE_API void octave_throw_bad_alloc

(

void

)

Definition at line 157 of file quit.cc.

References internal_exception_state, and octave_internal_alloc_exception.

octave_throw_execution_exception()

OCTAVE_NORETURN OCTAVE_API void octave_throw_execution_exception

(

void

)

Definition at line 146 of file quit.cc.

References internal_exception_state, and octave_internal_exec_exception.

octave_throw_interrupt_exception()

OCTAVE_NORETURN OCTAVE_API void octave_throw_interrupt_exception

(

void

)

Definition at line 136 of file quit.cc.

References octave_interrupt_hook.

Variable Documentation

octave_exception_state

OCTAVE_API sig_atomic_t octave_exception_state

extern

Definition at line 42 of file quit.cc.

octave_interrupt_state

OCTAVE_API sig_atomic_t octave_interrupt_state

extern

Definition at line 38 of file quit.cc.

Referenced by octave::jit_typeinfo::jit_typeinfo(), octave_oncleanup::call_object_destructor(), octave::tree_evaluator::do_unwind_protect_cleanup_code(), octave::command_editor::event_handler(), octave::generic_sig_handler(), octave_handle_signal(), octave_rethrow_exception(), octave::interpreter::recover_from_exception(), octave::cdef_object_rep::release(), octave::respond_to_pending_signals(), and octave::terminal_dock_widget::terminal_interrupt().

octave_signal_caught

OCTAVE_API volatile sig_atomic_t octave_signal_caught

extern

Definition at line 47 of file quit.cc.

Referenced by octave::generic_sig_handler(), octave::interpreter::recover_from_exception(), and octave::terminal_dock_widget::terminal_interrupt().