error.h

   1 /* error.h -- External declarations of functions appearing in error.c. */
   2
   3 /* Copyright (C) 1993-2020 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 (_ERROR_H_)
  22 #define _ERROR_H_
  23
  24 #include "stdc.h"
  25
  26 /* Get the name of the shell or shell script for an error message. */
  27 extern char *get_name_for_error PARAMS((void));
  28
  29 /* Report an error having to do with FILENAME. */
  30 extern void file_error PARAMS((const char *));
  31
  32 /* Report a programmer's error, and abort.  Pass REASON, and ARG1 ... ARG5. */
  33 extern void programming_error PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  34
  35 /* General error reporting.  Pass FORMAT and ARG1 ... ARG5. */
  36 extern void report_error PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  37
  38 /* Error messages for parts of the parser that don't call report_syntax_error */
  39 extern void parser_error PARAMS((int, const char *, ...))  __attribute__((__format__ (printf, 2, 3)));
  40
  41 /* Report an unrecoverable error and exit.  Pass FORMAT and ARG1 ... ARG5. */
  42 extern void fatal_error PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  43
  44 /* Report a system error, like BSD warn(3). */
  45 extern void sys_error PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  46
  47 /* Report an internal error. */
  48 extern void internal_error PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  49
  50 /* Report an internal warning. */
  51 extern void internal_warning PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  52
  53 /* Report an internal warning for debugging purposes. */
  54 extern void internal_debug PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  55
  56 /* Report an internal informational notice. */
  57 extern void internal_inform PARAMS((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  58
  59 /* Debugging functions, not enabled in released version. */
  60 extern char *strescape PARAMS((const char *));
  61 extern void itrace PARAMS((const char *, ...)) __attribute__ ((__format__ (printf, 1, 2)));
  62 extern void trace PARAMS((const char *, ...)) __attribute__ ((__format__ (printf, 1, 2)));
  63
  64 /* Report an error having to do with command parsing or execution. */
  65 extern void command_error PARAMS((const char *, int, int, int));
  66
  67 extern char *command_errstr PARAMS((int));
  68
  69 /* Specific error message functions that eventually call report_error or
  70    internal_error. */
  71
  72 extern void err_badarraysub PARAMS((const char *));
  73 extern void err_unboundvar PARAMS((const char *));
  74 extern void err_readonly PARAMS((const char *));
  75
  76 #ifdef DEBUG
  77 #  define INTERNAL_DEBUG(x)     internal_debug x
  78 #else
  79 #  define INTERNAL_DEBUG(x)
  80 #endif
  81
  82 #endif /* !_ERROR_H_ */