command.h

   1 /* command.h -- The structures used internally to represent commands, and
   2    the extern declarations of the functions used to create them. */
   3
   4 /* Copyright (C) 1993-2010 Free Software Foundation, Inc.
   5
   6    This file is part of GNU Bash, the Bourne Again SHell.
   7
   8    Bash is free software: you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation, either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    Bash is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bash.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #if !defined (_COMMAND_H_)
  23 #define _COMMAND_H_
  24
  25 #include "stdc.h"
  26
  27 /* Instructions describing what kind of thing to do for a redirection. */
  28 enum r_instruction {
  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,
  35   r_append_err_and_out
  36 };
  37
  38 /* Redirection flags; values for rflags */
  39 #define REDIR_VARASSIGN         0x01
  40
  41 /* Redirection errors. */
  42 #define AMBIGUOUS_REDIRECT  -1
  43 #define NOCLOBBER_REDIRECT  -2
  44 #define RESTRICTED_REDIRECT -3  /* can only happen in restricted shells. */
  45 #define HEREDOC_REDIRECT    -4  /* here-doc temp file can't be created */
  46 #define BADVAR_REDIRECT     -5  /* something wrong with {varname}redir */
  47
  48 #define CLOBBERING_REDIRECT(ri) \
  49   (ri == r_output_direction || ri == r_err_and_out)
  50
  51 #define OUTPUT_REDIRECT(ri) \
  52   (ri == r_output_direction || ri == r_input_output || ri == r_err_and_out || ri == r_append_err_and_out)
  53
  54 #define INPUT_REDIRECT(ri) \
  55   (ri == r_input_direction || ri == r_inputa_direction || ri == r_input_output)
  56
  57 #define WRITE_REDIRECT(ri) \
  58   (ri == r_output_direction || \
  59         ri == r_input_output || \
  60         ri == r_err_and_out || \
  61         ri == r_appending_to || \
  62         ri == r_append_err_and_out || \
  63         ri == r_output_force)
  64
  65 /* redirection needs translation */
  66 #define TRANSLATE_REDIRECT(ri) \
  67   (ri == r_duplicating_input_word || ri == r_duplicating_output_word || \
  68    ri == r_move_input_word || ri == r_move_output_word)
  69
  70 /* Command Types: */
  71 enum command_type { cm_for, cm_case, cm_while, cm_if, cm_simple, cm_select,
  72                     cm_connection, cm_function_def, cm_until, cm_group,
  73                     cm_arith, cm_cond, cm_arith_for, cm_subshell, cm_coproc };
  74
  75 /* Possible values for the `flags' field of a WORD_DESC. */
  76 #define W_HASDOLLAR     0x000001        /* Dollar sign present. */
  77 #define W_QUOTED        0x000002        /* Some form of quote character is present. */
  78 #define W_ASSIGNMENT    0x000004        /* This word is a variable assignment. */
  79 #define W_GLOBEXP       0x000008        /* This word is the result of a glob expansion. */
  80 #define W_NOSPLIT       0x000010        /* Do not perform word splitting on this word because ifs is empty string. */
  81 #define W_NOGLOB        0x000020        /* Do not perform globbing on this word. */
  82 #define W_NOSPLIT2      0x000040        /* Don't split word except for $@ expansion (using spaces) because context does not allow it. */
  83 #define W_TILDEEXP      0x000080        /* Tilde expand this assignment word */
  84 #define W_DOLLARAT      0x000100        /* $@ and its special handling */
  85 #define W_DOLLARSTAR    0x000200        /* $* and its special handling */
  86 #define W_NOCOMSUB      0x000400        /* Don't perform command substitution on this word */
  87 #define W_ASSIGNRHS     0x000800        /* Word is rhs of an assignment statement */
  88 #define W_NOTILDE       0x001000        /* Don't perform tilde expansion on this word */
  89 #define W_ITILDE        0x002000        /* Internal flag for word expansion */
  90 #define W_NOEXPAND      0x004000        /* Don't expand at all -- do quote removal */
  91 #define W_COMPASSIGN    0x008000        /* Compound assignment */
  92 #define W_ASSNBLTIN     0x010000        /* word is a builtin command that takes assignments */
  93 #define W_ASSIGNARG     0x020000        /* word is assignment argument to command */
  94 #define W_HASQUOTEDNULL 0x040000        /* word contains a quoted null character */
  95 #define W_DQUOTE        0x080000        /* word should be treated as if double-quoted */
  96 #define W_NOPROCSUB     0x100000        /* don't perform process substitution */
  97 #define W_HASCTLESC     0x200000        /* word contains literal CTLESC characters */
  98 #define W_ASSIGNASSOC   0x400000        /* word looks like associative array assignment */
  99 #define W_ARRAYIND      0x800000        /* word is an array index being expanded */
 100 #define W_ASSNGLOBAL    0x1000000       /* word is a global assignment to declare (declare/typeset -g) */
 101
 102 /* Possible values for subshell_environment */
 103 #define SUBSHELL_ASYNC  0x01    /* subshell caused by `command &' */
 104 #define SUBSHELL_PAREN  0x02    /* subshell caused by ( ... ) */
 105 #define SUBSHELL_COMSUB 0x04    /* subshell caused by `command` or $(command) */
 106 #define SUBSHELL_FORK   0x08    /* subshell caused by executing a disk command */
 107 #define SUBSHELL_PIPE   0x10    /* subshell from a pipeline element */
 108 #define SUBSHELL_PROCSUB 0x20   /* subshell caused by <(command) or >(command) */
 109 #define SUBSHELL_COPROC 0x40    /* subshell from a coproc pipeline */
 110 #define SUBSHELL_RESETTRAP 0x80 /* subshell needs to reset trap strings on first call to trap */
 111
 112 /* A structure which represents a word. */
 113 typedef struct word_desc {
 114   char *word;           /* Zero terminated string. */
 115   int flags;            /* Flags associated with this word. */
 116 } WORD_DESC;
 117
 118 /* A linked list of words. */
 119 typedef struct word_list {
 120   struct word_list *next;
 121   WORD_DESC *word;
 122 } WORD_LIST;
 123
 124
 125 /* **************************************************************** */
 126 /*                                                                  */
 127 /*                      Shell Command Structs                       */
 128 /*                                                                  */
 129 /* **************************************************************** */
 130
 131 /* What a redirection descriptor looks like.  If the redirection instruction
 132    is ri_duplicating_input or ri_duplicating_output, use DEST, otherwise
 133    use the file in FILENAME.  Out-of-range descriptors are identified by a
 134    negative DEST. */
 135
 136 typedef union {
 137   int dest;                     /* Place to redirect REDIRECTOR to, or ... */
 138   WORD_DESC *filename;          /* filename to redirect to. */
 139 } REDIRECTEE;
 140
 141 /* Structure describing a redirection.  If REDIRECTOR is negative, the parser
 142    (or translator in redir.c) encountered an out-of-range file descriptor. */
 143 typedef struct redirect {
 144   struct redirect *next;        /* Next element, or NULL. */
 145   REDIRECTEE redirector;        /* Descriptor or varname to be redirected. */
 146   int rflags;                   /* Private flags for this redirection */
 147   int flags;                    /* Flag value for `open'. */
 148   enum r_instruction  instruction; /* What to do with the information. */
 149   REDIRECTEE redirectee;        /* File descriptor or filename */
 150   char *here_doc_eof;           /* The word that appeared in <<foo. */
 151 } REDIRECT;
 152
 153 /* An element used in parsing.  A single word or a single redirection.
 154    This is an ephemeral construct. */
 155 typedef struct element {
 156   WORD_DESC *word;
 157   REDIRECT *redirect;
 158 } ELEMENT;
 159
 160 /* Possible values for command->flags. */
 161 #define CMD_WANT_SUBSHELL  0x01 /* User wants a subshell: ( command ) */
 162 #define CMD_FORCE_SUBSHELL 0x02 /* Shell needs to force a subshell. */
 163 #define CMD_INVERT_RETURN  0x04 /* Invert the exit value. */
 164 #define CMD_IGNORE_RETURN  0x08 /* Ignore the exit value.  For set -e. */
 165 #define CMD_NO_FUNCTIONS   0x10 /* Ignore functions during command lookup. */
 166 #define CMD_INHIBIT_EXPANSION 0x20 /* Do not expand the command words. */
 167 #define CMD_NO_FORK        0x40 /* Don't fork; just call execve */
 168 #define CMD_TIME_PIPELINE  0x80 /* Time a pipeline */
 169 #define CMD_TIME_POSIX     0x100 /* time -p; use POSIX.2 time output spec. */
 170 #define CMD_AMPERSAND      0x200 /* command & */
 171 #define CMD_STDIN_REDIR    0x400 /* async command needs implicit </dev/null */
 172 #define CMD_COMMAND_BUILTIN 0x0800 /* command executed by `command' builtin */
 173 #define CMD_COPROC_SUBSHELL 0x1000
 174 #define CMD_LASTPIPE        0x2000
 175
 176 /* What a command looks like. */
 177 typedef struct command {
 178   enum command_type type;       /* FOR CASE WHILE IF CONNECTION or SIMPLE. */
 179   int flags;                    /* Flags controlling execution environment. */
 180   int line;                     /* line number the command starts on */
 181   REDIRECT *redirects;          /* Special redirects for FOR CASE, etc. */
 182   union {
 183     struct for_com *For;
 184     struct case_com *Case;
 185     struct while_com *While;
 186     struct if_com *If;
 187     struct connection *Connection;
 188     struct simple_com *Simple;
 189     struct function_def *Function_def;
 190     struct group_com *Group;
 191 #if defined (SELECT_COMMAND)
 192     struct select_com *Select;
 193 #endif
 194 #if defined (DPAREN_ARITHMETIC)
 195     struct arith_com *Arith;
 196 #endif
 197 #if defined (COND_COMMAND)
 198     struct cond_com *Cond;
 199 #endif
 200 #if defined (ARITH_FOR_COMMAND)
 201     struct arith_for_com *ArithFor;
 202 #endif
 203     struct subshell_com *Subshell;
 204     struct coproc_com *Coproc;
 205   } value;
 206 } COMMAND;
 207
 208 /* Structure used to represent the CONNECTION type. */
 209 typedef struct connection {
 210   int ignore;                   /* Unused; simplifies make_command (). */
 211   COMMAND *first;               /* Pointer to the first command. */
 212   COMMAND *second;              /* Pointer to the second command. */
 213   int connector;                /* What separates this command from others. */
 214 } CONNECTION;
 215
 216 /* Structures used to represent the CASE command. */
 217
 218 /* Values for FLAGS word in a PATTERN_LIST */
 219 #define CASEPAT_FALLTHROUGH     0x01
 220 #define CASEPAT_TESTNEXT        0x02
 221
 222 /* Pattern/action structure for CASE_COM. */
 223 typedef struct pattern_list {
 224   struct pattern_list *next;    /* Clause to try in case this one failed. */
 225   WORD_LIST *patterns;          /* Linked list of patterns to test. */
 226   COMMAND *action;              /* Thing to execute if a pattern matches. */
 227   int flags;
 228 } PATTERN_LIST;
 229
 230 /* The CASE command. */
 231 typedef struct case_com {
 232   int flags;                    /* See description of CMD flags. */
 233   int line;                     /* line number the `case' keyword appears on */
 234   WORD_DESC *word;              /* The thing to test. */
 235   PATTERN_LIST *clauses;        /* The clauses to test against, or NULL. */
 236 } CASE_COM;
 237
 238 /* FOR command. */
 239 typedef struct for_com {
 240   int flags;            /* See description of CMD flags. */
 241   int line;             /* line number the `for' keyword appears on */
 242   WORD_DESC *name;      /* The variable name to get mapped over. */
 243   WORD_LIST *map_list;  /* The things to map over.  This is never NULL. */
 244   COMMAND *action;      /* The action to execute.
 245                            During execution, NAME is bound to successive
 246                            members of MAP_LIST. */
 247 } FOR_COM;
 248
 249 #if defined (ARITH_FOR_COMMAND)
 250 typedef struct arith_for_com {
 251   int flags;
 252   int line;     /* generally used for error messages */
 253   WORD_LIST *init;
 254   WORD_LIST *test;
 255   WORD_LIST *step;
 256   COMMAND *action;
 257 } ARITH_FOR_COM;
 258 #endif
 259
 260 #if defined (SELECT_COMMAND)
 261 /* KSH SELECT command. */
 262 typedef struct select_com {
 263   int flags;            /* See description of CMD flags. */
 264   int line;             /* line number the `select' keyword appears on */
 265   WORD_DESC *name;      /* The variable name to get mapped over. */
 266   WORD_LIST *map_list;  /* The things to map over.  This is never NULL. */
 267   COMMAND *action;      /* The action to execute.
 268                            During execution, NAME is bound to the member of
 269                            MAP_LIST chosen by the user. */
 270 } SELECT_COM;
 271 #endif /* SELECT_COMMAND */
 272
 273 /* IF command. */
 274 typedef struct if_com {
 275   int flags;                    /* See description of CMD flags. */
 276   COMMAND *test;                /* Thing to test. */
 277   COMMAND *true_case;           /* What to do if the test returned non-zero. */
 278   COMMAND *false_case;          /* What to do if the test returned zero. */
 279 } IF_COM;
 280
 281 /* WHILE command. */
 282 typedef struct while_com {
 283   int flags;                    /* See description of CMD flags. */
 284   COMMAND *test;                /* Thing to test. */
 285   COMMAND *action;              /* Thing to do while test is non-zero. */
 286 } WHILE_COM;
 287
 288 #if defined (DPAREN_ARITHMETIC)
 289 /* The arithmetic evaluation command, ((...)).  Just a set of flags and
 290    a WORD_LIST, of which the first element is the only one used, for the
 291    time being. */
 292 typedef struct arith_com {
 293   int flags;
 294   int line;
 295   WORD_LIST *exp;
 296 } ARITH_COM;
 297 #endif /* DPAREN_ARITHMETIC */
 298
 299 /* The conditional command, [[...]].  This is a binary tree -- we slippped
 300    a recursive-descent parser into the YACC grammar to parse it. */
 301 #define COND_AND        1
 302 #define COND_OR         2
 303 #define COND_UNARY      3
 304 #define COND_BINARY     4
 305 #define COND_TERM       5
 306 #define COND_EXPR       6
 307
 308 typedef struct cond_com {
 309   int flags;
 310   int line;
 311   int type;
 312   WORD_DESC *op;
 313   struct cond_com *left, *right;
 314 } COND_COM;
 315
 316 /* The "simple" command.  Just a collection of words and redirects. */
 317 typedef struct simple_com {
 318   int flags;                    /* See description of CMD flags. */
 319   int line;                     /* line number the command starts on */
 320   WORD_LIST *words;             /* The program name, the arguments,
 321                                    variable assignments, etc. */
 322   REDIRECT *redirects;          /* Redirections to perform. */
 323 } SIMPLE_COM;
 324
 325 /* The "function definition" command. */
 326 typedef struct function_def {
 327   int flags;                    /* See description of CMD flags. */
 328   int line;                     /* Line number the function def starts on. */
 329   WORD_DESC *name;              /* The name of the function. */
 330   COMMAND *command;             /* The parsed execution tree. */
 331   char *source_file;            /* file in which function was defined, if any */
 332 } FUNCTION_DEF;
 333
 334 /* A command that is `grouped' allows pipes and redirections to affect all
 335    commands in the group. */
 336 typedef struct group_com {
 337   int ignore;                   /* See description of CMD flags. */
 338   COMMAND *command;
 339 } GROUP_COM;
 340
 341 typedef struct subshell_com {
 342   int flags;
 343   COMMAND *command;
 344 } SUBSHELL_COM;
 345
 346 #define COPROC_RUNNING  0x01
 347 #define COPROC_DEAD     0x02
 348
 349 typedef struct coproc {
 350   char *c_name;
 351   pid_t c_pid;
 352   int c_rfd;
 353   int c_wfd;
 354   int c_rsave;
 355   int c_wsave;
 356   int c_flags;
 357   int c_status;
 358 } Coproc;
 359
 360 typedef struct coproc_com {
 361   int flags;
 362   char *name;
 363   COMMAND *command;
 364 } COPROC_COM;
 365
 366 extern COMMAND *global_command;
 367 extern Coproc sh_coproc;
 368
 369 /* Possible command errors */
 370 #define CMDERR_DEFAULT  0
 371 #define CMDERR_BADTYPE  1
 372 #define CMDERR_BADCONN  2
 373 #define CMDERR_BADJUMP  3
 374
 375 #define CMDERR_LAST     3
 376
 377 /* Forward declarations of functions declared in copy_cmd.c. */
 378
 379 extern FUNCTION_DEF *copy_function_def_contents __P((FUNCTION_DEF *, FUNCTION_DEF *));
 380 extern FUNCTION_DEF *copy_function_def __P((FUNCTION_DEF *));
 381
 382 extern WORD_DESC *copy_word __P((WORD_DESC *));
 383 extern WORD_LIST *copy_word_list __P((WORD_LIST *));
 384 extern REDIRECT *copy_redirect __P((REDIRECT *));
 385 extern REDIRECT *copy_redirects __P((REDIRECT *));
 386 extern COMMAND *copy_command __P((COMMAND *));
 387
 388 #endif /* _COMMAND_H_ */