Merge from gnulib, improving some licensing wording.
[bpt/emacs.git] / lib / signal.in.h
CommitLineData
6db30f83
PE
1/* A GNU-like <signal.h>.
2
3 Copyright (C) 2006-2011 Free Software Foundation, Inc.
4
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
17
18#if __GNUC__ >= 3
19@PRAGMA_SYSTEM_HEADER@
20#endif
21@PRAGMA_COLUMNS@
22
2a84b02d
PE
23#if defined __need_sig_atomic_t || defined __need_sigset_t || defined _GL_ALREADY_INCLUDING_SIGNAL_H || (defined _SIGNAL_H && !defined __SIZEOF_PTHREAD_MUTEX_T)
24/* Special invocation convention:
25 - Inside glibc header files.
26 - On glibc systems we have a sequence of nested includes
27 <signal.h> -> <ucontext.h> -> <signal.h>.
28 In this situation, the functions are not yet declared, therefore we cannot
29 provide the C++ aliases.
30 - On glibc systems with GCC 4.3 we have a sequence of nested includes
31 <csignal> -> </usr/include/signal.h> -> <sys/ucontext.h> -> <signal.h>.
32 In this situation, some of the functions are not yet declared, therefore
33 we cannot provide the C++ aliases. */
6db30f83
PE
34
35# @INCLUDE_NEXT@ @NEXT_SIGNAL_H@
36
37#else
38/* Normal invocation convention. */
39
40#ifndef _@GUARD_PREFIX@_SIGNAL_H
41
2a84b02d
PE
42#define _GL_ALREADY_INCLUDING_SIGNAL_H
43
6db30f83
PE
44/* Define pid_t, uid_t.
45 Also, mingw defines sigset_t not in <signal.h>, but in <sys/types.h>.
46 On Solaris 10, <signal.h> includes <sys/types.h>, which eventually includes
47 us; so include <sys/types.h> now, before the second inclusion guard. */
48#include <sys/types.h>
49
50/* The include_next requires a split double-inclusion guard. */
51#@INCLUDE_NEXT@ @NEXT_SIGNAL_H@
52
2a84b02d
PE
53#undef _GL_ALREADY_INCLUDING_SIGNAL_H
54
6db30f83
PE
55#ifndef _@GUARD_PREFIX@_SIGNAL_H
56#define _@GUARD_PREFIX@_SIGNAL_H
57
2a84b02d
PE
58/* MacOS X 10.3, FreeBSD 6.4, OpenBSD 3.8, OSF/1 4.0, Solaris 2.6 declare
59 pthread_sigmask in <pthread.h>, not in <signal.h>.
60 But avoid namespace pollution on glibc systems.*/
61#if (@GNULIB_PTHREAD_SIGMASK@ || defined GNULIB_POSIXCHECK) \
62 && ((defined __APPLE__ && defined __MACH__) || defined __FreeBSD__ || defined __OpenBSD__ || defined __osf__ || defined __sun) \
63 && ! defined __GLIBC__
64# include <pthread.h>
65#endif
66
6db30f83
PE
67/* The definitions of _GL_FUNCDECL_RPL etc. are copied here. */
68
69/* The definition of _GL_ARG_NONNULL is copied here. */
70
71/* The definition of _GL_WARN_ON_USE is copied here. */
72
73/* On AIX, sig_atomic_t already includes volatile. C99 requires that
74 'volatile sig_atomic_t' ignore the extra modifier, but C89 did not.
75 Hence, redefine this to a non-volatile type as needed. */
76#if ! @HAVE_TYPE_VOLATILE_SIG_ATOMIC_T@
77# if !GNULIB_defined_sig_atomic_t
78typedef int rpl_sig_atomic_t;
79# undef sig_atomic_t
80# define sig_atomic_t rpl_sig_atomic_t
81# define GNULIB_defined_sig_atomic_t 1
82# endif
83#endif
84
85/* A set or mask of signals. */
86#if !@HAVE_SIGSET_T@
87# if !GNULIB_defined_sigset_t
88typedef unsigned int sigset_t;
89# define GNULIB_defined_sigset_t 1
90# endif
91#endif
92
93/* Define sighandler_t, the type of signal handlers. A GNU extension. */
94#if !@HAVE_SIGHANDLER_T@
95# ifdef __cplusplus
96extern "C" {
97# endif
98# if !GNULIB_defined_sighandler_t
99typedef void (*sighandler_t) (int);
100# define GNULIB_defined_sighandler_t 1
101# endif
102# ifdef __cplusplus
103}
104# endif
105#endif
106
107
108#if @GNULIB_SIGNAL_H_SIGPIPE@
109# ifndef SIGPIPE
110/* Define SIGPIPE to a value that does not overlap with other signals. */
111# define SIGPIPE 13
112# define GNULIB_defined_SIGPIPE 1
113/* To actually use SIGPIPE, you also need the gnulib modules 'sigprocmask',
114 'write', 'stdio'. */
115# endif
116#endif
117
118
119/* Maximum signal number + 1. */
120#ifndef NSIG
121# if defined __TANDEM
122# define NSIG 32
123# endif
124#endif
125
126
127#if @GNULIB_PTHREAD_SIGMASK@
128# if @REPLACE_PTHREAD_SIGMASK@
2a84b02d
PE
129# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
130# undef pthread_sigmask
131# define pthread_sigmask rpl_pthread_sigmask
132# endif
133_GL_FUNCDECL_RPL (pthread_sigmask, int,
134 (int how, const sigset_t *new_mask, sigset_t *old_mask));
135_GL_CXXALIAS_RPL (pthread_sigmask, int,
136 (int how, const sigset_t *new_mask, sigset_t *old_mask));
137# else
138# if !@HAVE_PTHREAD_SIGMASK@
139_GL_FUNCDECL_SYS (pthread_sigmask, int,
140 (int how, const sigset_t *new_mask, sigset_t *old_mask));
141# endif
142_GL_CXXALIAS_SYS (pthread_sigmask, int,
143 (int how, const sigset_t *new_mask, sigset_t *old_mask));
6db30f83 144# endif
2a84b02d 145_GL_CXXALIASWARN (pthread_sigmask);
6db30f83
PE
146#elif defined GNULIB_POSIXCHECK
147# undef pthread_sigmask
148# if HAVE_RAW_DECL_PTHREAD_SIGMASK
149_GL_WARN_ON_USE (pthread_sigmask, "pthread_sigmask is not portable - "
150 "use gnulib module pthread_sigmask for portability");
151# endif
152#endif
153
154
316f8af0
PE
155#if @GNULIB_RAISE@
156# if @REPLACE_RAISE@
157# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
158# undef raise
159# define raise rpl_raise
160# endif
161_GL_FUNCDECL_RPL (raise, int, (int sig));
162_GL_CXXALIAS_RPL (raise, int, (int sig));
163# else
164# if !@HAVE_RAISE@
165_GL_FUNCDECL_SYS (raise, int, (int sig));
166# endif
167_GL_CXXALIAS_SYS (raise, int, (int sig));
168# endif
169_GL_CXXALIASWARN (raise);
170#elif defined GNULIB_POSIXCHECK
171# undef raise
172/* Assume raise is always declared. */
173_GL_WARN_ON_USE (raise, "raise can crash on native Windows - "
174 "use gnulib module raise for portability");
175#endif
176
177
6db30f83
PE
178#if @GNULIB_SIGPROCMASK@
179# if !@HAVE_POSIX_SIGNALBLOCKING@
180
181/* Maximum signal number + 1. */
182# ifndef NSIG
183# define NSIG 32
184# endif
185
186/* This code supports only 32 signals. */
187# if !GNULIB_defined_verify_NSIG_constraint
188typedef int verify_NSIG_constraint[NSIG <= 32 ? 1 : -1];
189# define GNULIB_defined_verify_NSIG_constraint 1
190# endif
191
192# endif
193
194/* Test whether a given signal is contained in a signal set. */
195# if @HAVE_POSIX_SIGNALBLOCKING@
196/* This function is defined as a macro on MacOS X. */
197# if defined __cplusplus && defined GNULIB_NAMESPACE
198# undef sigismember
199# endif
200# else
201_GL_FUNCDECL_SYS (sigismember, int, (const sigset_t *set, int sig)
202 _GL_ARG_NONNULL ((1)));
203# endif
204_GL_CXXALIAS_SYS (sigismember, int, (const sigset_t *set, int sig));
205_GL_CXXALIASWARN (sigismember);
206
207/* Initialize a signal set to the empty set. */
208# if @HAVE_POSIX_SIGNALBLOCKING@
209/* This function is defined as a macro on MacOS X. */
210# if defined __cplusplus && defined GNULIB_NAMESPACE
211# undef sigemptyset
212# endif
213# else
214_GL_FUNCDECL_SYS (sigemptyset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
215# endif
216_GL_CXXALIAS_SYS (sigemptyset, int, (sigset_t *set));
217_GL_CXXALIASWARN (sigemptyset);
218
219/* Add a signal to a signal set. */
220# if @HAVE_POSIX_SIGNALBLOCKING@
221/* This function is defined as a macro on MacOS X. */
222# if defined __cplusplus && defined GNULIB_NAMESPACE
223# undef sigaddset
224# endif
225# else
226_GL_FUNCDECL_SYS (sigaddset, int, (sigset_t *set, int sig)
227 _GL_ARG_NONNULL ((1)));
228# endif
229_GL_CXXALIAS_SYS (sigaddset, int, (sigset_t *set, int sig));
230_GL_CXXALIASWARN (sigaddset);
231
232/* Remove a signal from a signal set. */
233# if @HAVE_POSIX_SIGNALBLOCKING@
234/* This function is defined as a macro on MacOS X. */
235# if defined __cplusplus && defined GNULIB_NAMESPACE
236# undef sigdelset
237# endif
238# else
239_GL_FUNCDECL_SYS (sigdelset, int, (sigset_t *set, int sig)
240 _GL_ARG_NONNULL ((1)));
241# endif
242_GL_CXXALIAS_SYS (sigdelset, int, (sigset_t *set, int sig));
243_GL_CXXALIASWARN (sigdelset);
244
245/* Fill a signal set with all possible signals. */
246# if @HAVE_POSIX_SIGNALBLOCKING@
247/* This function is defined as a macro on MacOS X. */
248# if defined __cplusplus && defined GNULIB_NAMESPACE
249# undef sigfillset
250# endif
251# else
252_GL_FUNCDECL_SYS (sigfillset, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
253# endif
254_GL_CXXALIAS_SYS (sigfillset, int, (sigset_t *set));
255_GL_CXXALIASWARN (sigfillset);
256
257/* Return the set of those blocked signals that are pending. */
258# if !@HAVE_POSIX_SIGNALBLOCKING@
259_GL_FUNCDECL_SYS (sigpending, int, (sigset_t *set) _GL_ARG_NONNULL ((1)));
260# endif
261_GL_CXXALIAS_SYS (sigpending, int, (sigset_t *set));
262_GL_CXXALIASWARN (sigpending);
263
264/* If OLD_SET is not NULL, put the current set of blocked signals in *OLD_SET.
265 Then, if SET is not NULL, affect the current set of blocked signals by
266 combining it with *SET as indicated in OPERATION.
267 In this implementation, you are not allowed to change a signal handler
268 while the signal is blocked. */
269# if !@HAVE_POSIX_SIGNALBLOCKING@
270# define SIG_BLOCK 0 /* blocked_set = blocked_set | *set; */
271# define SIG_SETMASK 1 /* blocked_set = *set; */
272# define SIG_UNBLOCK 2 /* blocked_set = blocked_set & ~*set; */
273_GL_FUNCDECL_SYS (sigprocmask, int,
274 (int operation, const sigset_t *set, sigset_t *old_set));
275# endif
276_GL_CXXALIAS_SYS (sigprocmask, int,
277 (int operation, const sigset_t *set, sigset_t *old_set));
278_GL_CXXALIASWARN (sigprocmask);
279
280/* Install the handler FUNC for signal SIG, and return the previous
281 handler. */
282# ifdef __cplusplus
283extern "C" {
284# endif
285# if !GNULIB_defined_function_taking_int_returning_void_t
286typedef void (*_gl_function_taking_int_returning_void_t) (int);
287# define GNULIB_defined_function_taking_int_returning_void_t 1
288# endif
289# ifdef __cplusplus
290}
291# endif
292# if !@HAVE_POSIX_SIGNALBLOCKING@
293# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
294# define signal rpl_signal
295# endif
296_GL_FUNCDECL_RPL (signal, _gl_function_taking_int_returning_void_t,
297 (int sig, _gl_function_taking_int_returning_void_t func));
298_GL_CXXALIAS_RPL (signal, _gl_function_taking_int_returning_void_t,
299 (int sig, _gl_function_taking_int_returning_void_t func));
300# else
301_GL_CXXALIAS_SYS (signal, _gl_function_taking_int_returning_void_t,
302 (int sig, _gl_function_taking_int_returning_void_t func));
303# endif
304_GL_CXXALIASWARN (signal);
305
306/* Raise signal SIG. */
307# if !@HAVE_POSIX_SIGNALBLOCKING@ && GNULIB_defined_SIGPIPE
308# if !(defined __cplusplus && defined GNULIB_NAMESPACE)
309# undef raise
310# define raise rpl_raise
311# endif
312_GL_FUNCDECL_RPL (raise, int, (int sig));
313_GL_CXXALIAS_RPL (raise, int, (int sig));
314# else
315_GL_CXXALIAS_SYS (raise, int, (int sig));
316# endif
317_GL_CXXALIASWARN (raise);
318
319#elif defined GNULIB_POSIXCHECK
320# undef sigaddset
321# if HAVE_RAW_DECL_SIGADDSET
322_GL_WARN_ON_USE (sigaddset, "sigaddset is unportable - "
323 "use the gnulib module sigprocmask for portability");
324# endif
325# undef sigdelset
326# if HAVE_RAW_DECL_SIGDELSET
327_GL_WARN_ON_USE (sigdelset, "sigdelset is unportable - "
328 "use the gnulib module sigprocmask for portability");
329# endif
330# undef sigemptyset
331# if HAVE_RAW_DECL_SIGEMPTYSET
332_GL_WARN_ON_USE (sigemptyset, "sigemptyset is unportable - "
333 "use the gnulib module sigprocmask for portability");
334# endif
335# undef sigfillset
336# if HAVE_RAW_DECL_SIGFILLSET
337_GL_WARN_ON_USE (sigfillset, "sigfillset is unportable - "
338 "use the gnulib module sigprocmask for portability");
339# endif
340# undef sigismember
341# if HAVE_RAW_DECL_SIGISMEMBER
342_GL_WARN_ON_USE (sigismember, "sigismember is unportable - "
343 "use the gnulib module sigprocmask for portability");
344# endif
345# undef sigpending
346# if HAVE_RAW_DECL_SIGPENDING
347_GL_WARN_ON_USE (sigpending, "sigpending is unportable - "
348 "use the gnulib module sigprocmask for portability");
349# endif
350# undef sigprocmask
351# if HAVE_RAW_DECL_SIGPROCMASK
352_GL_WARN_ON_USE (sigprocmask, "sigprocmask is unportable - "
353 "use the gnulib module sigprocmask for portability");
354# endif
355#endif /* @GNULIB_SIGPROCMASK@ */
356
357
358#if @GNULIB_SIGACTION@
359# if !@HAVE_SIGACTION@
360
361# if !@HAVE_SIGINFO_T@
362
363# if !GNULIB_defined_siginfo_types
364
365/* Present to allow compilation, but unsupported by gnulib. */
366union sigval
367{
368 int sival_int;
369 void *sival_ptr;
370};
371
372/* Present to allow compilation, but unsupported by gnulib. */
373struct siginfo_t
374{
375 int si_signo;
376 int si_code;
377 int si_errno;
378 pid_t si_pid;
379 uid_t si_uid;
380 void *si_addr;
381 int si_status;
382 long si_band;
383 union sigval si_value;
384};
385typedef struct siginfo_t siginfo_t;
386
387# define GNULIB_defined_siginfo_types 1
388# endif
389
390# endif /* !@HAVE_SIGINFO_T@ */
391
392/* We assume that platforms which lack the sigaction() function also lack
393 the 'struct sigaction' type, and vice versa. */
394
395# if !GNULIB_defined_struct_sigaction
396
397struct sigaction
398{
399 union
400 {
401 void (*_sa_handler) (int);
402 /* Present to allow compilation, but unsupported by gnulib. POSIX
403 says that implementations may, but not must, make sa_sigaction
404 overlap with sa_handler, but we know of no implementation where
405 they do not overlap. */
406 void (*_sa_sigaction) (int, siginfo_t *, void *);
407 } _sa_func;
408 sigset_t sa_mask;
409 /* Not all POSIX flags are supported. */
410 int sa_flags;
411};
412# define sa_handler _sa_func._sa_handler
413# define sa_sigaction _sa_func._sa_sigaction
414/* Unsupported flags are not present. */
415# define SA_RESETHAND 1
416# define SA_NODEFER 2
417# define SA_RESTART 4
418
419# define GNULIB_defined_struct_sigaction 1
420# endif
421
422_GL_FUNCDECL_SYS (sigaction, int, (int, const struct sigaction *restrict,
423 struct sigaction *restrict));
424
425# elif !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@
426
427# define sa_sigaction sa_handler
428
429# endif /* !@HAVE_SIGACTION@, !@HAVE_STRUCT_SIGACTION_SA_SIGACTION@ */
430
431_GL_CXXALIAS_SYS (sigaction, int, (int, const struct sigaction *restrict,
432 struct sigaction *restrict));
433_GL_CXXALIASWARN (sigaction);
434
435#elif defined GNULIB_POSIXCHECK
436# undef sigaction
437# if HAVE_RAW_DECL_SIGACTION
438_GL_WARN_ON_USE (sigaction, "sigaction is unportable - "
439 "use the gnulib module sigaction for portability");
440# endif
441#endif
442
443/* Some systems don't have SA_NODEFER. */
444#ifndef SA_NODEFER
445# define SA_NODEFER 0
446#endif
447
448
449#endif /* _@GUARD_PREFIX@_SIGNAL_H */
450#endif /* _@GUARD_PREFIX@_SIGNAL_H */
451#endif