annotate liboctave/wrappers/signal-wrappers.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
1 /*
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 Copyright (C) 2016-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
7
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 This file is part of Octave.
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24520
diff changeset
11 Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
12 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24520
diff changeset
13 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
14 (at your option) any later version.
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
16 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22402
diff changeset
19 GNU General Public License for more details.
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
20
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 You should have received a copy of the GNU General Public License
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
22 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24520
diff changeset
23 <https://www.gnu.org/licenses/>.
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
24
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
25 */
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
27 #if ! defined (octave_signal_wrappers_h)
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
28 #define octave_signal_wrappers_h 1
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
29
21940
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
30 #if ! defined (__cplusplus)
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
31 # include <stdbool.h>
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
32 #endif
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
33
24104
0d96215c6e7d add standard system includes needed in wrapper headers
Mike Miller <mtmiller@octave.org>
parents: 23446
diff changeset
34 #include <sys/types.h>
0d96215c6e7d add standard system includes needed in wrapper headers
Mike Miller <mtmiller@octave.org>
parents: 23446
diff changeset
35
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 #if defined __cplusplus
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 extern "C" {
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38 #endif
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
40 typedef void octave_sig_handler (int);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
41
21940
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
42 extern int octave_kill_wrapper (pid_t pid, int signum);
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
43
23446
cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents: 23220
diff changeset
44 extern char * octave_strsignal_wrapper (int signum);
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
45
21940
70824a0dd009 provide wrapper for kill
John W. Eaton <jwe@octave.org>
parents: 21938
diff changeset
46 extern bool octave_have_kill (void);
21992
03c692adf563 maint: strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 21941
diff changeset
47
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
48 extern bool octave_get_sig_number (const char *signame, int *signum);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
49
24520
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
50 octave_sig_handler *
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
51 octave_set_signal_handler_internal (int sig, octave_sig_handler *handler,
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
52 bool restart_syscalls);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
53
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
54 extern octave_sig_handler *
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
55 octave_set_signal_handler_by_name (const char *signame,
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
56 octave_sig_handler *handler,
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
57 bool restart_syscalls);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
58
24520
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
59 extern octave_sig_handler *
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
60 octave_set_default_signal_handler (int sig);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
61
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
62 extern octave_sig_handler *
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
63 octave_set_default_signal_handler_by_name (const char *signame);
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
64
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
65 extern int octave_num_signals (void);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
66
23446
cd4e1ee28716 maint: Use convention 'void * fcn ()' for functions which return pointers.
Rik <rik@octave.org>
parents: 23220
diff changeset
67 extern void * octave_block_child (void);
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
68
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
69 extern void octave_unblock_child (void *context);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
70
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
71 extern void octave_block_interrupt_signal (void);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
72
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
73 extern void octave_unblock_interrupt_signal (void);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
74
24520
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
75 extern void octave_block_signal_by_name (const char *signame);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
76
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
77 extern void octave_unblock_signal_by_name (const char *signame);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
78
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
79 extern void octave_save_signal_mask (void);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
80
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
81 extern void octave_restore_signal_mask (void);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
82
25284
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
83 extern void * octave_alloc_signal_mask (void);
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
84
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
85 extern void octave_free_signal_mask (void *mask);
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
86
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
87 extern void octave_get_signal_mask (void *mask);
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
88
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
89 extern void octave_set_signal_mask (void *mask);
78fb24bdd8bb unblock async signals before executing subprocess (bug #53635)
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
90
24520
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
91 extern void octave_block_async_signals (void);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
92
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
93 extern void octave_unblock_async_signals (void);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
94
21941
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
95 extern int octave_raise_wrapper (int signum);
1d23b75cbcd1 hide signal.h from C++ sources
John W. Eaton <jwe@octave.org>
parents: 21940
diff changeset
96
24520
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
97 extern void
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
98 octave_create_interrupt_watcher_thread (octave_sig_handler *handler);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
99
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
100 // This can be useful for debugging.
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
101 extern void octave_show_sigmask (const char *);
c5c11b07598a refactor signal handling (bug #52757)
John W. Eaton <jwe@octave.org>
parents: 24104
diff changeset
102
21938
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
103 #if defined __cplusplus
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
104 }
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
105 #endif
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
106
da9b960b1b2d use gnulib strsignal module
John W. Eaton <jwe@octave.org>
parents:
diff changeset
107 #endif