[thirdparty/bash.git] / trap.h

/* trap.h -- data structures used in the trap mechanism. */

/* Copyright (C) 1993 Free Software Foundation, Inc.

   This file is part of GNU Bash, the Bourne Again SHell.

   Bash 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 2, or (at your option) any later
   version.

   Bash 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 Bash; see the file COPYING.  If not, write to the Free Software
   Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */

#if !defined (_TRAP_H_)
#define _TRAP_H_

#include "stdc.h"

#if !defined (SIG_DFL)
#include "bashtypes.h"
#include <signal.h>
#endif /* SIG_DFL */

#if !defined (NSIG)
#define NSIG 64
#endif /* !NSIG */

#define NO_SIG -1
#define DEFAULT_SIG	SIG_DFL
#define IGNORE_SIG	SIG_IGN

/* Special shell trap names. */
#define DEBUG_TRAP	NSIG
#define ERROR_TRAP	NSIG+1
#define RETURN_TRAP	NSIG+2
#define EXIT_TRAP 	0

/* system signals plus special bash traps */
#define BASH_NSIG	NSIG+3

/* Flags values for decode_signal() */
#define DSIG_SIGPREFIX	0x01		/* don't alllow `SIG' PREFIX */
#define DSIG_NOCASE	0x02		/* case-insensitive comparison */

#define signal_object_p(x,f) (decode_signal (x,f) != NO_SIG)

#define TRAP_STRING(s) \
  (signal_is_trapped (s) && signal_is_ignored (s) == 0) ? trap_list[s] \
							: (char *)NULL

extern char *trap_list[];

/* Externally-visible functions declared in trap.c. */
extern void initialize_traps __P((void));

extern void run_pending_traps __P((void));

extern void maybe_set_sigchld_trap __P((char *));
extern void set_sigchld_trap __P((char *));

extern void set_debug_trap __P((char *));
extern void set_error_trap __P((char *));
extern void set_return_trap __P((char *));

extern void set_sigint_trap __P((char *));
extern void set_signal __P((int, char *));

extern void restore_default_signal __P((int));
extern void ignore_signal __P((int));
extern int run_exit_trap __P((void));
extern void run_trap_cleanup __P((int));
extern int run_debug_trap __P((void));
extern void run_error_trap __P((void));
extern void run_return_trap __P((void));

extern void free_trap_strings __P((void));
extern void reset_signal_handlers __P((void));
extern void restore_original_signals __P((void));

extern char *signal_name __P((int));

extern int decode_signal __P((char *, int));
extern void run_interrupt_trap __P((void));
extern int maybe_call_trap_handler __P((int));
extern int signal_is_trapped __P((int));
extern int signal_is_ignored __P((int));
extern int signal_is_special __P((int));
extern void set_signal_ignored __P((int));
extern int signal_in_progress __P((int));

#endif /* _TRAP_H_ */
Commit	Line	Data
726f6388 JA	1	/* trap.h -- data structures used in the trap mechanism. */
	2
	3	/* Copyright (C) 1993 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 it under
	8	the terms of the GNU General Public License as published by the Free
	9	Software Foundation; either version 2, or (at your option) any later
	10	version.
	11
	12	Bash is distributed in the hope that it will be useful, but WITHOUT ANY
	13	WARRANTY; without even the implied warranty of MERCHANTABILITY or
	14	FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	15	for more details.
	16
	17	You should have received a copy of the GNU General Public License along
	18	with Bash; see the file COPYING. If not, write to the Free Software
bb70624e	19	Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
726f6388	20
ccc6cda3 JA	21	#if !defined (_TRAP_H_)
ccc6cda3 JA	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
b80f6443 JA	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
	52	#define signal_object_p(x,f) (decode_signal (x,f) != NO_SIG)
726f6388	53
f73dda09 JA	54	#define TRAP_STRING(s) \
	55	(signal_is_trapped (s) && signal_is_ignored (s) == 0) ? trap_list[s] \
	56	: (char *)NULL
	57
ccc6cda3	58	extern char *trap_list[];
726f6388 JA	59
	60	/* Externally-visible functions declared in trap.c. */
	61	extern void initialize_traps __P((void));
b80f6443	62
726f6388	63	extern void run_pending_traps __P((void));
b80f6443	64
726f6388 JA	65	extern void maybe_set_sigchld_trap __P((char *));
726f6388 JA	66	extern void set_sigchld_trap __P((char *));
b80f6443	67
ccc6cda3	68	extern void set_debug_trap __P((char *));
f73dda09	69	extern void set_error_trap __P((char *));
b80f6443 JA	70	extern void set_return_trap __P((char *));
b80f6443 JA	71
ccc6cda3	72	extern void set_sigint_trap __P((char *));
726f6388	73	extern void set_signal __P((int, char *));
b80f6443	74
726f6388 JA	75	extern void restore_default_signal __P((int));
	76	extern void ignore_signal __P((int));
	77	extern int run_exit_trap __P((void));
ccc6cda3	78	extern void run_trap_cleanup __P((int));
b80f6443	79	extern int run_debug_trap __P((void));
f73dda09	80	extern void run_error_trap __P((void));
b80f6443 JA	81	extern void run_return_trap __P((void));
b80f6443 JA	82
726f6388 JA	83	extern void free_trap_strings __P((void));
	84	extern void reset_signal_handlers __P((void));
	85	extern void restore_original_signals __P((void));
	86
	87	extern char *signal_name __P((int));
	88
b80f6443	89	extern int decode_signal __P((char *, int));
726f6388 JA	90	extern void run_interrupt_trap __P((void));
	91	extern int maybe_call_trap_handler __P((int));
	92	extern int signal_is_trapped __P((int));
726f6388	93	extern int signal_is_ignored __P((int));
ccc6cda3 JA	94	extern int signal_is_special __P((int));
ccc6cda3 JA	95	extern void set_signal_ignored __P((int));
95732b49	96	extern int signal_in_progress __P((int));
726f6388	97
ccc6cda3	98	#endif /* _TRAP_H_ */