]> git.ipfire.org Git - thirdparty/bash.git/blame - trap.h
Bash-4.2 distribution sources and documentation
[thirdparty/bash.git] / trap.h
CommitLineData
726f6388
JA
1/* trap.h -- data structures used in the trap mechanism. */
2
495aee44 3/* Copyright (C) 1993-2010 Free Software Foundation, Inc.
726f6388
JA
4
5 This file is part of GNU Bash, the Bourne Again SHell.
6
3185942a
JA
7 Bash is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
726f6388 11
3185942a
JA
12 Bash is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
726f6388 16
3185942a
JA
17 You should have received a copy of the GNU General Public License
18 along with Bash. If not, see <http://www.gnu.org/licenses/>.
19*/
726f6388 20
ccc6cda3
JA
21#if !defined (_TRAP_H_)
22#define _TRAP_H_
726f6388
JA
23
24#include "stdc.h"
25
26#if !defined (SIG_DFL)
d166f048 27#include "bashtypes.h"
726f6388
JA
28#include <signal.h>
29#endif /* SIG_DFL */
30
31#if !defined (NSIG)
32#define NSIG 64
33#endif /* !NSIG */
34
35#define NO_SIG -1
b80f6443
JA
36#define DEFAULT_SIG SIG_DFL
37#define IGNORE_SIG SIG_IGN
726f6388 38
ccc6cda3 39/* Special shell trap names. */
b80f6443
JA
40#define DEBUG_TRAP NSIG
41#define ERROR_TRAP NSIG+1
42#define RETURN_TRAP NSIG+2
43#define EXIT_TRAP 0
ccc6cda3 44
f73dda09 45/* system signals plus special bash traps */
b80f6443 46#define BASH_NSIG NSIG+3
f73dda09 47
b80f6443
JA
48/* Flags values for decode_signal() */
49#define DSIG_SIGPREFIX 0x01 /* don't alllow `SIG' PREFIX */
50#define DSIG_NOCASE 0x02 /* case-insensitive comparison */
51
495aee44
CR
52/* A value which can never be the target of a trap handler. */
53#define IMPOSSIBLE_TRAP_HANDLER (SigHandler *)initialize_traps
54
b80f6443 55#define signal_object_p(x,f) (decode_signal (x,f) != NO_SIG)
726f6388 56
f73dda09
JA
57#define TRAP_STRING(s) \
58 (signal_is_trapped (s) && signal_is_ignored (s) == 0) ? trap_list[s] \
59 : (char *)NULL
60
ccc6cda3 61extern char *trap_list[];
726f6388
JA
62
63/* Externally-visible functions declared in trap.c. */
64extern void initialize_traps __P((void));
b80f6443 65
726f6388 66extern void run_pending_traps __P((void));
b80f6443 67
726f6388 68extern void maybe_set_sigchld_trap __P((char *));
3185942a 69extern void set_impossible_sigchld_trap __P((void));
726f6388 70extern void set_sigchld_trap __P((char *));
b80f6443 71
ccc6cda3 72extern void set_debug_trap __P((char *));
f73dda09 73extern void set_error_trap __P((char *));
b80f6443
JA
74extern void set_return_trap __P((char *));
75
ccc6cda3 76extern void set_sigint_trap __P((char *));
726f6388 77extern void set_signal __P((int, char *));
b80f6443 78
726f6388
JA
79extern void restore_default_signal __P((int));
80extern void ignore_signal __P((int));
81extern int run_exit_trap __P((void));
ccc6cda3 82extern void run_trap_cleanup __P((int));
b80f6443 83extern int run_debug_trap __P((void));
f73dda09 84extern void run_error_trap __P((void));
b80f6443
JA
85extern void run_return_trap __P((void));
86
726f6388
JA
87extern void free_trap_strings __P((void));
88extern void reset_signal_handlers __P((void));
89extern void restore_original_signals __P((void));
90
495aee44
CR
91extern void get_all_original_signals __P((void));
92
726f6388
JA
93extern char *signal_name __P((int));
94
b80f6443 95extern int decode_signal __P((char *, int));
726f6388
JA
96extern void run_interrupt_trap __P((void));
97extern int maybe_call_trap_handler __P((int));
495aee44 98extern int signal_is_special __P((int));
726f6388 99extern int signal_is_trapped __P((int));
726f6388 100extern int signal_is_ignored __P((int));
495aee44 101extern int signal_is_hard_ignored __P((int));
ccc6cda3 102extern void set_signal_ignored __P((int));
95732b49 103extern int signal_in_progress __P((int));
726f6388 104
ccc6cda3 105#endif /* _TRAP_H_ */