bin/sh/error.h

   1 /*      $NetBSD: error.h,v 1.16 2003/08/07 09:05:30 agc Exp $   */
   2
   3 /*-
   4  * Copyright (c) 1991, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Kenneth Almquist.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)error.h     8.2 (Berkeley) 5/4/95
  35  */
  36
  37 #include <stdarg.h>
  38
  39 /*
  40  * Types of operations (passed to the errmsg routine).
  41  */
  42
  43 #define E_OPEN 01       /* opening a file */
  44 #define E_CREAT 02      /* creating a file */
  45 #define E_EXEC 04       /* executing a program */
  46
  47
  48 /*
  49  * We enclose jmp_buf in a structure so that we can declare pointers to
  50  * jump locations.  The global variable handler contains the location to
  51  * jump to when an exception occurs, and the global variable exception
  52  * contains a code identifying the exeception.  To implement nested
  53  * exception handlers, the user should save the value of handler on entry
  54  * to an inner scope, set handler to point to a jmploc structure for the
  55  * inner scope, and restore handler on exit from the scope.
  56  */
  57
  58 #include <setjmp.h>
  59
  60 struct jmploc {
  61         jmp_buf loc;
  62 };
  63
  64 extern struct jmploc *handler;
  65 extern int exception;
  66 extern int exerrno;     /* error for EXEXEC */
  67
  68 /* exceptions */
  69 #define EXINT 0         /* SIGINT received */
  70 #define EXERROR 1       /* a generic error */
  71 #define EXSHELLPROC 2   /* execute a shell procedure */
  72 #define EXEXEC 3        /* command execution failed */
  73
  74
  75 /*
  76  * These macros allow the user to suspend the handling of interrupt signals
  77  * over a period of time.  This is similar to SIGHOLD to or sigblock, but
  78  * much more efficient and portable.  (But hacking the kernel is so much
  79  * more fun than worrying about efficiency and portability. :-))
  80  */
  81
  82 extern volatile int suppressint;
  83 extern volatile int intpending;
  84
  85 #define INTOFF suppressint++
  86 #define INTON { if (--suppressint == 0 && intpending) onint(); }
  87 #define FORCEINTON {suppressint = 0; if (intpending) onint();}
  88 #define CLEAR_PENDING_INT intpending = 0
  89 #define int_pending() intpending
  90
  91 #if ! defined(SHELL_BUILTIN)
  92 void exraise(int) __attribute__((__noreturn__));
  93 void onint(void);
  94 void error(const char *, ...) __attribute__((__noreturn__));
  95 void exerror(int, const char *, ...) __attribute__((__noreturn__));
  96 const char *errmsg(int, int);
  97 #endif /* ! SHELL_BUILTIN */
  98
  99 void sh_err(int, const char *, ...) __attribute__((__noreturn__));
 100 void sh_verr(int, const char *, va_list) __attribute__((__noreturn__));
 101 void sh_errx(int, const char *, ...) __attribute__((__noreturn__));
 102 void sh_verrx(int, const char *, va_list) __attribute__((__noreturn__));
 103 void sh_warn(const char *, ...);
 104 void sh_vwarn(const char *, va_list);
 105 void sh_warnx(const char *, ...);
 106 void sh_vwarnx(const char *, va_list);
 107
 108 void sh_exit(int) __attribute__((__noreturn__));
 109
 110
 111 /*
 112  * BSD setjmp saves the signal mask, which violates ANSI C and takes time,
 113  * so we use _setjmp instead.
 114  */
 115
 116 #if defined(BSD) && !defined(__SVR4)
 117 #define setjmp(jmploc)  _setjmp(jmploc)
 118 #define longjmp(jmploc, val)    _longjmp(jmploc, val)
 119 #endif