view liboctave/wrappers/signal-wrappers.h @ 31122:46e15523ca06

perms.m: Small cleanups for Octave coding conventions (bug #60364) * perms.m: Wrap long lines in documentation to < 80 characters. Change output in documentation example to match what Octave actually produces. Use true/false for boolean variable "unique_v" rather than 0/1. Cuddle parentheses when doing indexing and use a space when calling a function. Add FIXME notes requesting an explanation of the apparently complicated algorithm being used for permutations and unque permutations. Remove period at end of error() message text per Octave conventions. Change BIST input validation to more precisely check error() message.
author Rik <rik@octave.org>
date Tue, 05 Jul 2022 08:57:15 -0700
parents 796f54d4ddbf
children
line wrap: on
line source

////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2016-2022 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 void octave_block_async_signals (void);

extern OCTAVE_API void octave_unblock_async_signals (void);

extern OCTAVE_API int octave_raise_wrapper (int signum);

extern OCTAVE_API void
octave_create_interrupt_watcher_thread (octave_sig_handler *handler);

// This can be useful for debugging.
extern OCTAVE_API void octave_show_sigmask (const char *);

#if defined __cplusplus
}
#endif

#endif