shell.h

   1 /* shell.h -- The data structures used by the shell */
   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 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include "bashjmp.h"
  26
  27 #include "command.h"
  28 #include "syntax.h"
  29 #include "general.h"
  30 #include "error.h"
  31 #include "variables.h"
  32 #include "arrayfunc.h"
  33 #include "quit.h"
  34 #include "maxpath.h"
  35 #include "unwind_prot.h"
  36 #include "dispose_cmd.h"
  37 #include "make_cmd.h"
  38 #include "ocache.h"
  39 #include "subst.h"
  40 #include "sig.h"
  41 #include "pathnames.h"
  42 #include "externs.h"
  43
  44 extern int EOF_Reached;
  45
  46 #define NO_PIPE -1
  47 #define REDIRECT_BOTH -2
  48
  49 #define NO_VARIABLE -1
  50
  51 /* Values that can be returned by execute_command (). */
  52 #define EXECUTION_FAILURE 1
  53 #define EXECUTION_SUCCESS 0
  54
  55 /* Usage messages by builtins result in a return status of 2. */
  56 #define EX_BADUSAGE     2
  57
  58 #define EX_MISCERROR    2
  59
  60 /* Special exit statuses used by the shell, internally and externally. */
  61 #define EX_RETRYFAIL    124
  62 #define EX_WEXPCOMSUB   125
  63 #define EX_BINARY_FILE  126
  64 #define EX_NOEXEC       126
  65 #define EX_NOINPUT      126
  66 #define EX_NOTFOUND     127
  67
  68 #define EX_SHERRBASE    256     /* all special error values are > this. */
  69
  70 #define EX_BADSYNTAX    257     /* shell syntax error */
  71 #define EX_USAGE        258     /* syntax error in usage */
  72 #define EX_REDIRFAIL    259     /* redirection failed */
  73 #define EX_BADASSIGN    260     /* variable assignment error */
  74 #define EX_EXPFAIL      261     /* word expansion failed */
  75
  76 /* Flag values that control parameter pattern substitution. */
  77 #define MATCH_ANY       0x000
  78 #define MATCH_BEG       0x001
  79 #define MATCH_END       0x002
  80
  81 #define MATCH_TYPEMASK  0x003
  82
  83 #define MATCH_GLOBREP   0x010
  84 #define MATCH_QUOTED    0x020
  85 #define MATCH_ASSIGNRHS 0x040
  86 #define MATCH_STARSUB   0x080
  87
  88 /* Some needed external declarations. */
  89 extern char **shell_environment;
  90 extern WORD_LIST *rest_of_args;
  91
  92 /* Generalized global variables. */
  93 extern int debugging_mode;
  94 extern int executing, login_shell;
  95 extern int interactive, interactive_shell;
  96 extern int startup_state;
  97 extern int subshell_environment;
  98 extern int shell_compatibility_level;
  99
 100 extern int locale_mb_cur_max;
 101
 102 /* Structure to pass around that holds a bitmap of file descriptors
 103    to close, and the size of that structure.  Used in execute_cmd.c. */
 104 struct fd_bitmap {
 105   int size;
 106   char *bitmap;
 107 };
 108
 109 #define FD_BITMAP_SIZE 32
 110
 111 #define CTLESC '\001'
 112 #define CTLNUL '\177'
 113
 114 /* Information about the current user. */
 115 struct user_info {
 116   uid_t uid, euid;
 117   gid_t gid, egid;
 118   char *user_name;
 119   char *shell;          /* shell from the password file */
 120   char *home_dir;
 121 };
 122
 123 extern struct user_info current_user;
 124
 125 /* Force gcc to not clobber X on a longjmp().  Old versions of gcc mangle
 126    this badly. */
 127 #if (__GNUC__ > 2) || (__GNUC__ == 2 && __GNUC_MINOR__ > 8)
 128 #  define USE_VAR(x)    ((void) &(x))
 129 #else
 130 #  define USE_VAR(x)
 131 #endif
 132
 133 #define HEREDOC_MAX 16
 134
 135 /* Structure in which to save partial parsing state when doing things like
 136    PROMPT_COMMAND and bash_execute_unix_command execution. */
 137
 138 typedef struct _sh_parser_state_t {
 139
 140   /* parsing state */
 141   int parser_state;
 142   int *token_state;
 143
 144   char *token;
 145   int token_buffer_size;
 146
 147   /* input line state -- line number saved elsewhere */
 148   int input_line_terminator;
 149   int eof_encountered;
 150
 151 #if defined (HANDLE_MULTIBYTE)
 152   /* Nothing right now for multibyte state, but might want something later. */
 153 #endif
 154
 155   char **prompt_string_pointer;
 156
 157   /* history state affecting or modified by the parser */
 158   int current_command_line_count;
 159 #if defined (HISTORY)
 160   int remember_on_history;
 161   int history_expansion_inhibited;
 162 #endif
 163
 164   /* execution state possibly modified by the parser */
 165   int last_command_exit_value;
 166 #if defined (ARRAY_VARS)
 167   ARRAY *pipestatus;
 168 #endif
 169   sh_builtin_func_t *last_shell_builtin, *this_shell_builtin;
 170
 171   /* flags state affecting the parser */
 172   int expand_aliases;
 173   int echo_input_at_read;
 174   int need_here_doc;
 175   int here_doc_first_line;
 176
 177   /* structures affecting the parser */
 178   REDIRECT *redir_stack[HEREDOC_MAX];
 179 } sh_parser_state_t;
 180
 181 typedef struct _sh_input_line_state_t {
 182   char *input_line;
 183   size_t input_line_index;
 184   size_t input_line_size;
 185   size_t input_line_len;
 186 } sh_input_line_state_t;
 187
 188 /* Let's try declaring these here. */
 189 extern char *parser_remaining_input __P((void));
 190
 191 extern sh_parser_state_t *save_parser_state __P((sh_parser_state_t *));
 192 extern void restore_parser_state __P((sh_parser_state_t *));
 193
 194 extern sh_input_line_state_t *save_input_line_state __P((sh_input_line_state_t *));
 195 extern void restore_input_line_state __P((sh_input_line_state_t *));