error.h

   1 /* error.h -- External declarations of functions appearing in error.c. */
   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
  19    Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
  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 __P((void));
  28
  29 /* Report an error having to do with FILENAME. */
  30 extern void file_error __P((const char *));
  31
  32 /* Report a programmer's error, and abort.  Pass REASON, and ARG1 ... ARG5. */
  33 extern void programming_error __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  34
  35 /* General error reporting.  Pass FORMAT and ARG1 ... ARG5. */
  36 extern void report_error __P((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 __P((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 __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  43
  44 /* Report a system error, like BSD warn(3). */
  45 extern void sys_error __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  46
  47 /* Report an internal error. */
  48 extern void internal_error __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  49
  50 /* Report an internal warning. */
  51 extern void internal_warning __P((const char *, ...))  __attribute__((__format__ (printf, 1, 2)));
  52
  53 /* Debugging function, not enabled in released version. */
  54 extern void itrace __P((const char *, ...)) __attribute__ ((__format__ (printf, 1, 2)));
  55
  56 /* Report an error having to do with command parsing or execution. */
  57 extern void command_error __P((const char *, int, int, int));
  58
  59 extern char *command_errstr __P((int));
  60
  61 /* Specific errror message functions that eventually call report_error or
  62    internal_error. */
  63
  64 extern void err_badarraysub __P((const char *));
  65 extern void err_unboundvar __P((const char *));
  66 extern void err_readonly __P((const char *));
  67
  68 #endif /* !_ERROR_H_ */