signal-wrappers.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2016-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 (octave_signal_wrappers_h)
#define octave_signal_wrappers_h 1
 
#if ! defined (__cplusplus)
#  include <stdbool.h>
#endif
 
#include <sys/types.h>
 
#if defined (__cplusplus)
extern "C" {
#endif
 
typedef void octave_sig_handler (int);
 
extern OCTAVE_API int octave_kill_wrapper (pid_t pid, int signum);
 
extern OCTAVE_API char * octave_strsignal_wrapper (int signum);
 
extern OCTAVE_API bool octave_have_kill (void);
 
extern OCTAVE_API bool octave_get_sig_number (const char *signame, int *signum);
 
extern OCTAVE_API octave_sig_handler *
octave_set_signal_handler_internal (int sig, octave_sig_handler *handler,
                                    bool restart_syscalls);
 
extern OCTAVE_API octave_sig_handler *
octave_set_signal_handler_by_name (const char *signame,
                                   octave_sig_handler *handler,
                                   bool restart_syscalls);
 
extern OCTAVE_API octave_sig_handler *
octave_set_default_signal_handler (int sig);
 
extern OCTAVE_API octave_sig_handler *
octave_set_default_signal_handler_by_name (const char *signame);
 
extern OCTAVE_API int octave_num_signals (void);
 
extern OCTAVE_API void * octave_block_child (void);
 
extern OCTAVE_API void octave_unblock_child (void *context);
 
extern OCTAVE_API void octave_block_interrupt_signal (void);
 
extern OCTAVE_API void octave_unblock_interrupt_signal (void);
 
extern OCTAVE_API void octave_block_signal_by_name (const char *signame);
 
extern OCTAVE_API void octave_unblock_signal_by_name (const char *signame);
 
extern OCTAVE_API void octave_save_signal_mask (void);
 
extern OCTAVE_API void octave_restore_signal_mask (void);
 
extern OCTAVE_API void * octave_alloc_signal_mask (void);
 
extern OCTAVE_API void octave_free_signal_mask (void *mask);
 
extern OCTAVE_API void octave_get_signal_mask (void *mask);
 
extern OCTAVE_API void octave_set_signal_mask (void *mask);
 
extern OCTAVE_API int octave_raise_wrapper (int signum);
 
// This function can be useful for debugging.
 
extern OCTAVE_API void octave_show_sigmask (const char *);
 
// The next three functions are defined in cxx-signal-helpers.cc.
 
extern OCTAVE_API void
octave_create_interrupt_watcher_thread (octave_sig_handler *handler);
 
extern OCTAVE_API void octave_block_async_signals (void);
 
extern OCTAVE_API void octave_unblock_async_signals (void);
 
#if defined (__cplusplus)
}
#endif
 
#endif