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