1 /* trap.h -- data structures used in the trap mechanism. */
2 
3 /* Copyright (C) 1993-2013 Free Software Foundation, Inc.
4 
5    This file is part of GNU Bash, the Bourne Again SHell.
6 
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.
11 
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.
16 
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 */
20 
21 #if !defined (_TRAP_H_)
22 #define _TRAP_H_
23 
24 #include "stdc.h"
25 
26 #if !defined (SIG_DFL)
27 #include "bashtypes.h"
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
36 #define DEFAULT_SIG	SIG_DFL
37 #define IGNORE_SIG	SIG_IGN
38 
39 /* Special shell trap names. */
40 #define DEBUG_TRAP	NSIG
41 #define ERROR_TRAP	NSIG+1
42 #define RETURN_TRAP	NSIG+2
43 #define EXIT_TRAP 	0
44 
45 /* system signals plus special bash traps */
46 #define BASH_NSIG	NSIG+3
47 
48 /* Flags values for decode_signal() */
49 #define DSIG_SIGPREFIX	0x01		/* don't allow `SIG' PREFIX */
50 #define DSIG_NOCASE	0x02		/* case-insensitive comparison */
51 
52 /* A value which can never be the target of a trap handler. */
53 #define IMPOSSIBLE_TRAP_HANDLER (SigHandler *)initialize_traps
54 
55 #define signal_object_p(x,f) (decode_signal (x,f) != NO_SIG)
56 
57 #define TRAP_STRING(s) \
58   (signal_is_trapped (s) && signal_is_ignored (s) == 0) ? trap_list[s] \
59 							: (char *)NULL
60 
61 extern char *trap_list[];
62 
63 extern int trapped_signal_received;
64 extern int wait_signal_received;
65 extern int running_trap;
66 extern int trap_saved_exit_value;
67 extern int suppress_debug_trap_verbose;
68 
69 /* Externally-visible functions declared in trap.c. */
70 extern void initialize_traps PARAMS((void));
71 
72 extern void run_pending_traps PARAMS((void));
73 
74 extern void queue_sigchld_trap PARAMS((int));
75 extern void maybe_set_sigchld_trap PARAMS((char *));
76 extern void set_impossible_sigchld_trap PARAMS((void));
77 extern void set_sigchld_trap PARAMS((char *));
78 
79 extern void set_debug_trap PARAMS((char *));
80 extern void set_error_trap PARAMS((char *));
81 extern void set_return_trap PARAMS((char *));
82 
83 extern void maybe_set_debug_trap PARAMS((char *));
84 extern void maybe_set_error_trap PARAMS((char *));
85 extern void maybe_set_return_trap PARAMS((char *));
86 
87 extern void set_sigint_trap PARAMS((char *));
88 extern void set_signal PARAMS((int, char *));
89 
90 extern void restore_default_signal PARAMS((int));
91 extern void ignore_signal PARAMS((int));
92 extern int run_exit_trap PARAMS((void));
93 extern void run_trap_cleanup PARAMS((int));
94 extern int run_debug_trap PARAMS((void));
95 extern void run_error_trap PARAMS((void));
96 extern void run_return_trap PARAMS((void));
97 
98 extern void free_trap_strings PARAMS((void));
99 extern void reset_signal_handlers PARAMS((void));
100 extern void restore_original_signals PARAMS((void));
101 
102 extern void get_original_signal PARAMS((int));
103 extern void get_all_original_signals PARAMS((void));
104 
105 extern char *signal_name PARAMS((int));
106 
107 extern int decode_signal PARAMS((char *, int));
108 extern void run_interrupt_trap PARAMS((int));
109 extern int maybe_call_trap_handler PARAMS((int));
110 extern int signal_is_special PARAMS((int));
111 extern int signal_is_trapped PARAMS((int));
112 extern int signal_is_pending PARAMS((int));
113 extern int signal_is_ignored PARAMS((int));
114 extern int signal_is_hard_ignored PARAMS((int));
115 extern void set_signal_hard_ignored PARAMS((int));
116 extern void set_signal_ignored PARAMS((int));
117 extern int signal_in_progress PARAMS((int));
118 
119 extern void set_trap_state PARAMS((int));
120 
121 extern int next_pending_trap PARAMS((int));
122 extern int first_pending_trap PARAMS((void));
123 extern void clear_pending_traps PARAMS((void));
124 extern int any_signals_trapped PARAMS((void));
125 extern void check_signals PARAMS((void));
126 extern void check_signals_and_traps PARAMS((void));
127 
128 #endif /* _TRAP_H_ */
129