sh: Allow EV_EXIT through function calls.
[dragonfly.git] / bin / sh / error.h
1 /*-
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Kenneth Almquist.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)error.h     8.2 (Berkeley) 5/4/95
37  * $FreeBSD: src/bin/sh/error.h,v 1.22 2011/04/23 22:28:56 jilles Exp $
38  */
39
40 /*
41  * We enclose jmp_buf in a structure so that we can declare pointers to
42  * jump locations.  The global variable handler contains the location to
43  * jump to when an exception occurs, and the global variable exception
44  * contains a code identifying the exception.  To implement nested
45  * exception handlers, the user should save the value of handler on entry
46  * to an inner scope, set handler to point to a jmploc structure for the
47  * inner scope, and restore handler on exit from the scope.
48  */
49
50 #include <setjmp.h>
51 #include <signal.h>
52
53 struct jmploc {
54         jmp_buf loc;
55 };
56
57 extern struct jmploc *handler;
58 extern volatile sig_atomic_t exception;
59
60 /* exceptions */
61 #define EXINT 0         /* SIGINT received */
62 #define EXERROR 1       /* a generic error */
63 #define EXEXEC 2        /* command execution failed */
64 #define EXEXIT 3        /* call exitshell(exitstatus) */
65
66
67 /*
68  * These macros allow the user to suspend the handling of interrupt signals
69  * over a period of time.  This is similar to SIGHOLD to or sigblock, but
70  * much more efficient and portable.  (But hacking the kernel is so much
71  * more fun than worrying about efficiency and portability. :-))
72  */
73
74 extern volatile sig_atomic_t suppressint;
75 extern volatile sig_atomic_t intpending;
76
77 #define INTOFF suppressint++
78 #define INTON { if (--suppressint == 0 && intpending) onint(); }
79 #define is_int_on() suppressint
80 #define SETINTON(s) suppressint = (s)
81 #define FORCEINTON {suppressint = 0; if (intpending) onint();}
82 #define CLEAR_PENDING_INT intpending = 0
83 #define int_pending() intpending
84
85 void exraise(int) __dead2;
86 void onint(void);
87 void warning(const char *, ...) __printflike(1, 2);
88 void error(const char *, ...) __printf0like(1, 2) __dead2;
89 void exerror(int, const char *, ...) __printf0like(2, 3) __dead2;
90
91
92 /*
93  * BSD setjmp saves the signal mask, which violates ANSI C and takes time,
94  * so we use _setjmp instead.
95  */
96
97 #define setjmp(jmploc)  _setjmp(jmploc)
98 #define longjmp(jmploc, val)    _longjmp(jmploc, val)