1 /* command.h -- The structures used internally to represent commands, and
2 the extern declarations of the functions used to create them. */
4 /* Copyright (C) 1993-2008 Free Software Foundation, Inc.
6 This file is part of GNU Bash, the Bourne Again SHell.
8 Bash is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 Bash is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License along
19 with Bash; see the file COPYING. If not, write to the Free Software
20 Foundation, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
22 #if !defined (_COMMAND_H_)
27 /* Instructions describing what kind of thing to do for a redirection. */
29 r_output_direction
, r_input_direction
, r_inputa_direction
,
30 r_appending_to
, r_reading_until
, r_reading_string
,
31 r_duplicating_input
, r_duplicating_output
, r_deblank_reading_until
,
32 r_close_this
, r_err_and_out
, r_input_output
, r_output_force
,
33 r_duplicating_input_word
, r_duplicating_output_word
,
34 r_move_input
, r_move_output
, r_move_input_word
, r_move_output_word
,
38 /* Redirection errors. */
39 #define AMBIGUOUS_REDIRECT -1
40 #define NOCLOBBER_REDIRECT -2
41 #define RESTRICTED_REDIRECT -3 /* can only happen in restricted shells. */
42 #define HEREDOC_REDIRECT -4 /* here-doc temp file can't be created */
44 #define CLOBBERING_REDIRECT(ri) \
45 (ri == r_output_direction || ri == r_err_and_out)
47 #define OUTPUT_REDIRECT(ri) \
48 (ri == r_output_direction || ri == r_input_output || ri == r_err_and_out || ri == r_append_err_and_out)
50 #define INPUT_REDIRECT(ri) \
51 (ri == r_input_direction || ri == r_inputa_direction || ri == r_input_output)
53 #define WRITE_REDIRECT(ri) \
54 (ri == r_output_direction || \
55 ri == r_input_output || \
56 ri == r_err_and_out || \
57 ri == r_appending_to || \
58 ri == r_append_err_and_out || \
61 /* redirection needs translation */
62 #define TRANSLATE_REDIRECT(ri) \
63 (ri == r_duplicating_input_word || ri == r_duplicating_output_word || \
64 ri == r_move_input_word || ri == r_move_output_word)
67 enum command_type
{ cm_for
, cm_case
, cm_while
, cm_if
, cm_simple
, cm_select
,
68 cm_connection
, cm_function_def
, cm_until
, cm_group
,
69 cm_arith
, cm_cond
, cm_arith_for
, cm_subshell
, cm_coproc
};
71 /* Possible values for the `flags' field of a WORD_DESC. */
72 #define W_HASDOLLAR 0x000001 /* Dollar sign present. */
73 #define W_QUOTED 0x000002 /* Some form of quote character is present. */
74 #define W_ASSIGNMENT 0x000004 /* This word is a variable assignment. */
75 #define W_GLOBEXP 0x000008 /* This word is the result of a glob expansion. */
76 #define W_NOSPLIT 0x000010 /* Do not perform word splitting on this word. */
77 #define W_NOGLOB 0x000020 /* Do not perform globbing on this word. */
78 #define W_NOSPLIT2 0x000040 /* Don't split word except for $@ expansion. */
79 #define W_TILDEEXP 0x000080 /* Tilde expand this assignment word */
80 #define W_DOLLARAT 0x000100 /* $@ and its special handling */
81 #define W_DOLLARSTAR 0x000200 /* $* and its special handling */
82 #define W_NOCOMSUB 0x000400 /* Don't perform command substitution on this word */
83 #define W_ASSIGNRHS 0x000800 /* Word is rhs of an assignment statement */
84 #define W_NOTILDE 0x001000 /* Don't perform tilde expansion on this word */
85 #define W_ITILDE 0x002000 /* Internal flag for word expansion */
86 #define W_NOEXPAND 0x004000 /* Don't expand at all -- do quote removal */
87 #define W_COMPASSIGN 0x008000 /* Compound assignment */
88 #define W_ASSNBLTIN 0x010000 /* word is a builtin command that takes assignments */
89 #define W_ASSIGNARG 0x020000 /* word is assignment argument to command */
90 #define W_HASQUOTEDNULL 0x040000 /* word contains a quoted null character */
91 #define W_DQUOTE 0x080000 /* word should be treated as if double-quoted */
92 #define W_NOPROCSUB 0x100000 /* don't perform process substitution */
93 #define W_HASCTLESC 0x200000 /* word contains literal CTLESC characters */
94 #define W_ASSIGNASSOC 0x400000 /* word looks like associative array assignment */
96 /* Possible values for subshell_environment */
97 #define SUBSHELL_ASYNC 0x01 /* subshell caused by `command &' */
98 #define SUBSHELL_PAREN 0x02 /* subshell caused by ( ... ) */
99 #define SUBSHELL_COMSUB 0x04 /* subshell caused by `command` or $(command) */
100 #define SUBSHELL_FORK 0x08 /* subshell caused by executing a disk command */
101 #define SUBSHELL_PIPE 0x10 /* subshell from a pipeline element */
102 #define SUBSHELL_PROCSUB 0x20 /* subshell caused by <(command) or >(command) */
103 #define SUBSHELL_COPROC 0x40 /* subshell from a coproc pipeline */
105 /* A structure which represents a word. */
106 typedef struct word_desc
{
107 char *word
; /* Zero terminated string. */
108 int flags
; /* Flags associated with this word. */
111 /* A linked list of words. */
112 typedef struct word_list
{
113 struct word_list
*next
;
118 /* **************************************************************** */
120 /* Shell Command Structs */
122 /* **************************************************************** */
124 /* What a redirection descriptor looks like. If the redirection instruction
125 is ri_duplicating_input or ri_duplicating_output, use DEST, otherwise
126 use the file in FILENAME. Out-of-range descriptors are identified by a
130 int dest
; /* Place to redirect REDIRECTOR to, or ... */
131 WORD_DESC
*filename
; /* filename to redirect to. */
134 /* Structure describing a redirection. If REDIRECTOR is negative, the parser
135 (or translator in redir.c) encountered an out-of-range file descriptor. */
136 typedef struct redirect
{
137 struct redirect
*next
; /* Next element, or NULL. */
138 int redirector
; /* Descriptor to be redirected. */
139 int flags
; /* Flag value for `open'. */
140 enum r_instruction instruction
; /* What to do with the information. */
141 REDIRECTEE redirectee
; /* File descriptor or filename */
142 char *here_doc_eof
; /* The word that appeared in <<foo. */
145 /* An element used in parsing. A single word or a single redirection.
146 This is an ephemeral construct. */
147 typedef struct element
{
152 /* Possible values for command->flags. */
153 #define CMD_WANT_SUBSHELL 0x01 /* User wants a subshell: ( command ) */
154 #define CMD_FORCE_SUBSHELL 0x02 /* Shell needs to force a subshell. */
155 #define CMD_INVERT_RETURN 0x04 /* Invert the exit value. */
156 #define CMD_IGNORE_RETURN 0x08 /* Ignore the exit value. For set -e. */
157 #define CMD_NO_FUNCTIONS 0x10 /* Ignore functions during command lookup. */
158 #define CMD_INHIBIT_EXPANSION 0x20 /* Do not expand the command words. */
159 #define CMD_NO_FORK 0x40 /* Don't fork; just call execve */
160 #define CMD_TIME_PIPELINE 0x80 /* Time a pipeline */
161 #define CMD_TIME_POSIX 0x100 /* time -p; use POSIX.2 time output spec. */
162 #define CMD_AMPERSAND 0x200 /* command & */
163 #define CMD_STDIN_REDIR 0x400 /* async command needs implicit </dev/null */
164 #define CMD_COMMAND_BUILTIN 0x0800 /* command executed by `command' builtin */
165 #define CMD_COPROC_SUBSHELL 0x1000
167 /* What a command looks like. */
168 typedef struct command
{
169 enum command_type type
; /* FOR CASE WHILE IF CONNECTION or SIMPLE. */
170 int flags
; /* Flags controlling execution environment. */
171 int line
; /* line number the command starts on */
172 REDIRECT
*redirects
; /* Special redirects for FOR CASE, etc. */
175 struct case_com
*Case
;
176 struct while_com
*While
;
178 struct connection
*Connection
;
179 struct simple_com
*Simple
;
180 struct function_def
*Function_def
;
181 struct group_com
*Group
;
182 #if defined (SELECT_COMMAND)
183 struct select_com
*Select
;
185 #if defined (DPAREN_ARITHMETIC)
186 struct arith_com
*Arith
;
188 #if defined (COND_COMMAND)
189 struct cond_com
*Cond
;
191 #if defined (ARITH_FOR_COMMAND)
192 struct arith_for_com
*ArithFor
;
194 struct subshell_com
*Subshell
;
195 struct coproc_com
*Coproc
;
199 /* Structure used to represent the CONNECTION type. */
200 typedef struct connection
{
201 int ignore
; /* Unused; simplifies make_command (). */
202 COMMAND
*first
; /* Pointer to the first command. */
203 COMMAND
*second
; /* Pointer to the second command. */
204 int connector
; /* What separates this command from others. */
207 /* Structures used to represent the CASE command. */
209 /* Values for FLAGS word in a PATTERN_LIST */
210 #define CASEPAT_FALLTHROUGH 0x01
211 #define CASEPAT_TESTNEXT 0x02
213 /* Pattern/action structure for CASE_COM. */
214 typedef struct pattern_list
{
215 struct pattern_list
*next
; /* Clause to try in case this one failed. */
216 WORD_LIST
*patterns
; /* Linked list of patterns to test. */
217 COMMAND
*action
; /* Thing to execute if a pattern matches. */
221 /* The CASE command. */
222 typedef struct case_com
{
223 int flags
; /* See description of CMD flags. */
224 int line
; /* line number the `case' keyword appears on */
225 WORD_DESC
*word
; /* The thing to test. */
226 PATTERN_LIST
*clauses
; /* The clauses to test against, or NULL. */
230 typedef struct for_com
{
231 int flags
; /* See description of CMD flags. */
232 int line
; /* line number the `for' keyword appears on */
233 WORD_DESC
*name
; /* The variable name to get mapped over. */
234 WORD_LIST
*map_list
; /* The things to map over. This is never NULL. */
235 COMMAND
*action
; /* The action to execute.
236 During execution, NAME is bound to successive
237 members of MAP_LIST. */
240 #if defined (ARITH_FOR_COMMAND)
241 typedef struct arith_for_com
{
243 int line
; /* generally used for error messages */
251 #if defined (SELECT_COMMAND)
252 /* KSH SELECT command. */
253 typedef struct select_com
{
254 int flags
; /* See description of CMD flags. */
255 int line
; /* line number the `select' keyword appears on */
256 WORD_DESC
*name
; /* The variable name to get mapped over. */
257 WORD_LIST
*map_list
; /* The things to map over. This is never NULL. */
258 COMMAND
*action
; /* The action to execute.
259 During execution, NAME is bound to the member of
260 MAP_LIST chosen by the user. */
262 #endif /* SELECT_COMMAND */
265 typedef struct if_com
{
266 int flags
; /* See description of CMD flags. */
267 COMMAND
*test
; /* Thing to test. */
268 COMMAND
*true_case
; /* What to do if the test returned non-zero. */
269 COMMAND
*false_case
; /* What to do if the test returned zero. */
273 typedef struct while_com
{
274 int flags
; /* See description of CMD flags. */
275 COMMAND
*test
; /* Thing to test. */
276 COMMAND
*action
; /* Thing to do while test is non-zero. */
279 #if defined (DPAREN_ARITHMETIC)
280 /* The arithmetic evaluation command, ((...)). Just a set of flags and
281 a WORD_LIST, of which the first element is the only one used, for the
283 typedef struct arith_com
{
288 #endif /* DPAREN_ARITHMETIC */
290 /* The conditional command, [[...]]. This is a binary tree -- we slippped
291 a recursive-descent parser into the YACC grammar to parse it. */
295 #define COND_BINARY 4
299 typedef struct cond_com
{
304 struct cond_com
*left
, *right
;
307 /* The "simple" command. Just a collection of words and redirects. */
308 typedef struct simple_com
{
309 int flags
; /* See description of CMD flags. */
310 int line
; /* line number the command starts on */
311 WORD_LIST
*words
; /* The program name, the arguments,
312 variable assignments, etc. */
313 REDIRECT
*redirects
; /* Redirections to perform. */
316 /* The "function definition" command. */
317 typedef struct function_def
{
318 int flags
; /* See description of CMD flags. */
319 int line
; /* Line number the function def starts on. */
320 WORD_DESC
*name
; /* The name of the function. */
321 COMMAND
*command
; /* The parsed execution tree. */
322 char *source_file
; /* file in which function was defined, if any */
325 /* A command that is `grouped' allows pipes and redirections to affect all
326 commands in the group. */
327 typedef struct group_com
{
328 int ignore
; /* See description of CMD flags. */
332 typedef struct subshell_com
{
337 typedef struct coproc
{
348 typedef struct coproc_com
{
354 extern COMMAND
*global_command
;
355 extern Coproc sh_coproc
;
357 /* Possible command errors */
358 #define CMDERR_DEFAULT 0
359 #define CMDERR_BADTYPE 1
360 #define CMDERR_BADCONN 2
361 #define CMDERR_BADJUMP 3
363 #define CMDERR_LAST 3
365 /* Forward declarations of functions declared in copy_cmd.c. */
367 extern FUNCTION_DEF
*copy_function_def_contents
__P((FUNCTION_DEF
*, FUNCTION_DEF
*));
368 extern FUNCTION_DEF
*copy_function_def
__P((FUNCTION_DEF
*));
370 extern WORD_DESC
*copy_word
__P((WORD_DESC
*));
371 extern WORD_LIST
*copy_word_list
__P((WORD_LIST
*));
372 extern REDIRECT
*copy_redirect
__P((REDIRECT
*));
373 extern REDIRECT
*copy_redirects
__P((REDIRECT
*));
374 extern COMMAND
*copy_command
__P((COMMAND
*));
376 #endif /* _COMMAND_H_ */