1/* shell.h -- The data structures used by the shell */
2
3/* Copyright (C) 1993-2002 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#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
44extern 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/* Special exit statuses used by the shell, internally and externally. */
59#define EX_BINARY_FILE	126
60#define EX_NOEXEC	126
61#define EX_NOINPUT	126
62#define EX_NOTFOUND	127
63
64#define EX_SHERRBASE	256	/* all special error values are > this. */
65
66#define EX_BADSYNTAX	257	/* shell syntax error */
67#define EX_USAGE	258	/* syntax error in usage */
68#define EX_REDIRFAIL	259	/* redirection failed */
69#define EX_BADASSIGN	260	/* variable assignment error */
70#define EX_EXPFAIL	261	/* word expansion failed */
71
72/* Flag values that control parameter pattern substitution. */
73#define MATCH_ANY	0x000
74#define MATCH_BEG	0x001
75#define MATCH_END	0x002
76
77#define MATCH_TYPEMASK	0x003
78
79#define MATCH_GLOBREP	0x010
80#define MATCH_QUOTED	0x020
81#define MATCH_STARSUB	0x040
82
83/* Some needed external declarations. */
84extern char **shell_environment;
85extern WORD_LIST *rest_of_args;
86
87/* Generalized global variables. */
88extern int debugging_mode;
89extern int executing, login_shell;
90extern int interactive, interactive_shell;
91extern int startup_state;
92extern int shell_compatibility_level;
93
94/* Structure to pass around that holds a bitmap of file descriptors
95   to close, and the size of that structure.  Used in execute_cmd.c. */
96struct fd_bitmap {
97  int size;
98  char *bitmap;
99};
100
101#define FD_BITMAP_SIZE 32
102
103#define CTLESC '\001'
104#define CTLNUL '\177'
105
106/* Information about the current user. */
107struct user_info {
108  uid_t uid, euid;
109  gid_t gid, egid;
110  char *user_name;
111  char *shell;		/* shell from the password file */
112  char *home_dir;
113};
114
115extern struct user_info current_user;
116
117/* Force gcc to not clobber X on a longjmp().  Old versions of gcc mangle
118   this badly. */
119#if (__GNUC__ > 2) || (__GNUC__ == 2 && __GNUC_MINOR__ > 8)
120#  define USE_VAR(x)	((void) &(x))
121#else
122#  define USE_VAR(x)
123#endif
124
125/* Structure in which to save partial parsing state when doing things like
126   PROMPT_COMMAND and bash_execute_unix_command execution. */
127
128typedef struct _sh_parser_state_t {
129
130  /* parsing state */
131  int parser_state;
132  int *token_state;
133
134  /* input line state -- line number saved elsewhere */
135  int input_line_terminator;
136  int eof_encountered;
137
138#if defined (HANDLE_MULTIBYTE)
139  /* Nothing right now for multibyte state, but might want something later. */
140#endif
141
142  /* history state affecting or modified by the parser */
143  int current_command_line_count;
144#if defined (HISTORY)
145  int remember_on_history;
146  int history_expansion_inhibited;
147#endif
148
149  /* execution state possibly modified by the parser */
150  int last_command_exit_value;
151#if defined (ARRAY_VARS)
152  ARRAY *pipestatus;
153#endif
154  sh_builtin_func_t *last_shell_builtin, *this_shell_builtin;
155
156  /* flags state affecting the parser */
157  int expand_aliases;
158  int echo_input_at_read;
159
160} sh_parser_state_t;
161
162/* Let's try declaring these here. */
163extern sh_parser_state_t *save_parser_state __P((sh_parser_state_t *));
164extern void restore_parser_state __P((sh_parser_state_t *));
165