1 /* shell.h -- The data structures used by the shell */
3 /* Copyright (C) 1993-2009 Free Software Foundation, Inc.
5 This file is part of GNU Bash, the Bourne Again SHell.
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.
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.
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/>.
31 #include "variables.h"
32 #include "arrayfunc.h"
35 #include "unwind_prot.h"
36 #include "dispose_cmd.h"
41 #include "pathnames.h"
44 extern int EOF_Reached;
47 #define REDIRECT_BOTH -2
49 #define NO_VARIABLE -1
51 /* Values that can be returned by execute_command (). */
52 #define EXECUTION_FAILURE 1
53 #define EXECUTION_SUCCESS 0
55 /* Usage messages by builtins result in a return status of 2. */
58 /* Special exit statuses used by the shell, internally and externally. */
59 #define EX_RETRYFAIL 124
60 #define EX_WEXPCOMSUB 125
61 #define EX_BINARY_FILE 126
63 #define EX_NOINPUT 126
64 #define EX_NOTFOUND 127
66 #define EX_SHERRBASE 256 /* all special error values are > this. */
68 #define EX_BADSYNTAX 257 /* shell syntax error */
69 #define EX_USAGE 258 /* syntax error in usage */
70 #define EX_REDIRFAIL 259 /* redirection failed */
71 #define EX_BADASSIGN 260 /* variable assignment error */
72 #define EX_EXPFAIL 261 /* word expansion failed */
74 /* Flag values that control parameter pattern substitution. */
75 #define MATCH_ANY 0x000
76 #define MATCH_BEG 0x001
77 #define MATCH_END 0x002
79 #define MATCH_TYPEMASK 0x003
81 #define MATCH_GLOBREP 0x010
82 #define MATCH_QUOTED 0x020
83 #define MATCH_STARSUB 0x040
85 /* Some needed external declarations. */
86 extern char **shell_environment;
87 extern WORD_LIST *rest_of_args;
89 /* Generalized global variables. */
90 extern int debugging_mode;
91 extern int executing, login_shell;
92 extern int interactive, interactive_shell;
93 extern int startup_state;
94 extern int subshell_environment;
95 extern int shell_compatibility_level;
97 /* Structure to pass around that holds a bitmap of file descriptors
98 to close, and the size of that structure. Used in execute_cmd.c. */
104 #define FD_BITMAP_SIZE 32
106 #define CTLESC '\001'
107 #define CTLNUL '\177'
109 /* Information about the current user. */
114 char *shell; /* shell from the password file */
118 extern struct user_info current_user;
120 /* Force gcc to not clobber X on a longjmp(). Old versions of gcc mangle
122 #if (__GNUC__ > 2) || (__GNUC__ == 2 && __GNUC_MINOR__ > 8)
123 # define USE_VAR(x) ((void) &(x))
128 /* Structure in which to save partial parsing state when doing things like
129 PROMPT_COMMAND and bash_execute_unix_command execution. */
131 typedef struct _sh_parser_state_t {
137 /* input line state -- line number saved elsewhere */
138 int input_line_terminator;
141 #if defined (HANDLE_MULTIBYTE)
142 /* Nothing right now for multibyte state, but might want something later. */
145 /* history state affecting or modified by the parser */
146 int current_command_line_count;
147 #if defined (HISTORY)
148 int remember_on_history;
149 int history_expansion_inhibited;
152 /* execution state possibly modified by the parser */
153 int last_command_exit_value;
154 #if defined (ARRAY_VARS)
157 sh_builtin_func_t *last_shell_builtin, *this_shell_builtin;
159 /* flags state affecting the parser */
161 int echo_input_at_read;
165 /* Let's try declaring these here. */
166 extern sh_parser_state_t *save_parser_state __P((sh_parser_state_t *));
167 extern void restore_parser_state __P((sh_parser_state_t *));