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 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 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
  11    version.
  12
  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
  16    for more details.
  17
  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, 675 Mass Ave, Cambridge, MA 02139, USA. */
  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_duplicating_input,
  31   r_duplicating_output, r_deblank_reading_until, r_close_this,
  32   r_err_and_out, r_input_output, r_output_force,
  33   r_duplicating_input_word, r_duplicating_output_word
  34 };
  35
  36 /* Redirection errors. */
  37 #define AMBIGUOUS_REDIRECT  -1
  38 #define NOCLOBBER_REDIRECT  -2
  39 #define RESTRICTED_REDIRECT -3  /* can only happen in restricted shells. */
  40
  41 #define OUTPUT_REDIRECT(ri) \
  42   (ri == r_output_direction || ri == r_input_output || ri == r_err_and_out)
  43
  44 #define INPUT_REDIRECT(ri) \
  45   (ri == r_input_direction || ri == r_inputa_direction || ri == r_input_output)
  46
  47 #define WRITE_REDIRECT(ri) \
  48   (ri == r_output_direction || \
  49         ri == r_input_output || \
  50         ri == r_err_and_out || \
  51         ri == r_appending_to || \
  52         ri == r_output_force)
  53
  54 /* Command Types: */
  55 enum command_type { cm_for, cm_case, cm_while, cm_if, cm_simple, cm_select,
  56                     cm_connection, cm_function_def, cm_until, cm_group };
  57
  58 /* Possible values for the `flags' field of a WORD_DESC. */
  59 #define W_HASDOLLAR     0x01    /* Dollar sign present. */
  60 #define W_QUOTED        0x02    /* Some form of quote character is present. */
  61 #define W_ASSIGNMENT    0x04    /* This word is a variable assignment. */
  62 #define W_GLOBEXP       0x08    /* This word is the result of a glob expansion. */
  63 #define W_NOSPLIT       0x10    /* Do not perform word splitting on this word. */
  64
  65 /* Possible values for subshell_environment */
  66 #define SUBSHELL_ASYNC  0x01    /* subshell caused by `command &' */
  67 #define SUBSHELL_PAREN  0x02    /* subshell caused by ( ... ) */
  68 #define SUBSHELL_COMSUB 0x04    /* subshell caused by `command` or $(command) */
  69 #define SUBSHELL_FORK   0x08    /* subshell caused by executing a disk command */
  70
  71 /* A structure which represents a word. */
  72 typedef struct word_desc {
  73   char *word;           /* Zero terminated string. */
  74   int flags;            /* Flags associated with this word. */
  75 } WORD_DESC;
  76
  77 /* A linked list of words. */
  78 typedef struct word_list {
  79   struct word_list *next;
  80   WORD_DESC *word;
  81 } WORD_LIST;
  82
  83
  84 /* **************************************************************** */
  85 /*                                                                  */
  86 /*                      Shell Command Structs                       */
  87 /*                                                                  */
  88 /* **************************************************************** */
  89
  90 /* What a redirection descriptor looks like.  If FLAGS is IS_DESCRIPTOR,
  91    then we use REDIRECTEE.DEST, else we use the file specified. */
  92
  93 typedef union {
  94   long dest;                    /* Place to redirect REDIRECTOR to, or ... */
  95   WORD_DESC *filename;          /* filename to redirect to. */
  96 } REDIRECTEE;
  97
  98 typedef struct redirect {
  99   struct redirect *next;        /* Next element, or NULL. */
 100   int redirector;               /* Descriptor to be redirected. */
 101   int flags;                    /* Flag value for `open'. */
 102   enum r_instruction  instruction; /* What to do with the information. */
 103   REDIRECTEE redirectee;        /* File descriptor or filename */
 104   char *here_doc_eof;           /* The word that appeared in <<foo. */
 105 } REDIRECT;
 106
 107 /* An element used in parsing.  A single word or a single redirection.
 108    This is an ephemeral construct. */
 109 typedef struct element {
 110   WORD_DESC *word;
 111   REDIRECT *redirect;
 112 } ELEMENT;
 113
 114 /* Possible values for command->flags. */
 115 #define CMD_WANT_SUBSHELL  0x01 /* User wants a subshell: ( command ) */
 116 #define CMD_FORCE_SUBSHELL 0x02 /* Shell needs to force a subshell. */
 117 #define CMD_INVERT_RETURN  0x04 /* Invert the exit value. */
 118 #define CMD_IGNORE_RETURN  0x08 /* Ignore the exit value.  For set -e. */
 119 #define CMD_NO_FUNCTIONS   0x10 /* Ignore functions during command lookup. */
 120 #define CMD_INHIBIT_EXPANSION 0x20 /* Do not expand the command words. */
 121 #define CMD_NO_FORK        0x40 /* Don't fork; just call execve */
 122 #define CMD_TIME_PIPELINE  0x80 /* Time a pipeline */
 123 #define CMD_TIME_POSIX     0x100 /* time -p; use POSIX.2 time output spec. */
 124
 125 /* What a command looks like. */
 126 typedef struct command {
 127   enum command_type type;       /* FOR CASE WHILE IF CONNECTION or SIMPLE. */
 128   int flags;                    /* Flags controlling execution environment. */
 129   int line;                     /* line number the command starts on */
 130   REDIRECT *redirects;          /* Special redirects for FOR CASE, etc. */
 131   union {
 132     struct for_com *For;
 133     struct case_com *Case;
 134     struct while_com *While;
 135     struct if_com *If;
 136     struct connection *Connection;
 137     struct simple_com *Simple;
 138     struct function_def *Function_def;
 139     struct group_com *Group;
 140 #if defined (SELECT_COMMAND)
 141     struct select_com *Select;
 142 #endif
 143   } value;
 144 } COMMAND;
 145
 146 /* Structure used to represent the CONNECTION type. */
 147 typedef struct connection {
 148   int ignore;                   /* Unused; simplifies make_command (). */
 149   COMMAND *first;               /* Pointer to the first command. */
 150   COMMAND *second;              /* Pointer to the second command. */
 151   int connector;                /* What separates this command from others. */
 152 } CONNECTION;
 153
 154 /* Structures used to represent the CASE command. */
 155
 156 /* Pattern/action structure for CASE_COM. */
 157 typedef struct pattern_list {
 158   struct pattern_list *next;    /* Clause to try in case this one failed. */
 159   WORD_LIST *patterns;          /* Linked list of patterns to test. */
 160   COMMAND *action;              /* Thing to execute if a pattern matches. */
 161 } PATTERN_LIST;
 162
 163 /* The CASE command. */
 164 typedef struct case_com {
 165   int flags;                    /* See description of CMD flags. */
 166   WORD_DESC *word;              /* The thing to test. */
 167   PATTERN_LIST *clauses;        /* The clauses to test against, or NULL. */
 168 } CASE_COM;
 169
 170 /* FOR command. */
 171 typedef struct for_com {
 172   int flags;            /* See description of CMD flags. */
 173   WORD_DESC *name;      /* The variable name to get mapped over. */
 174   WORD_LIST *map_list;  /* The things to map over.  This is never NULL. */
 175   COMMAND *action;      /* The action to execute.
 176                            During execution, NAME is bound to successive
 177                            members of MAP_LIST. */
 178 } FOR_COM;
 179
 180 #if defined (SELECT_COMMAND)
 181 /* KSH SELECT command. */
 182 typedef struct select_com {
 183   int flags;            /* See description of CMD flags. */
 184   WORD_DESC *name;      /* The variable name to get mapped over. */
 185   WORD_LIST *map_list;  /* The things to map over.  This is never NULL. */
 186   COMMAND *action;      /* The action to execute.
 187                            During execution, NAME is bound to the member of
 188                            MAP_LIST chosen by the user. */
 189 } SELECT_COM;
 190 #endif /* SELECT_COMMAND */
 191
 192 /* IF command. */
 193 typedef struct if_com {
 194   int flags;                    /* See description of CMD flags. */
 195   COMMAND *test;                /* Thing to test. */
 196   COMMAND *true_case;           /* What to do if the test returned non-zero. */
 197   COMMAND *false_case;          /* What to do if the test returned zero. */
 198 } IF_COM;
 199
 200 /* WHILE command. */
 201 typedef struct while_com {
 202   int flags;                    /* See description of CMD flags. */
 203   COMMAND *test;                /* Thing to test. */
 204   COMMAND *action;              /* Thing to do while test is non-zero. */
 205 } WHILE_COM;
 206
 207 /* The "simple" command.  Just a collection of words and redirects. */
 208 typedef struct simple_com {
 209   int flags;                    /* See description of CMD flags. */
 210   WORD_LIST *words;             /* The program name, the arguments,
 211                                    variable assignments, etc. */
 212   REDIRECT *redirects;          /* Redirections to perform. */
 213   int line;                     /* line number the command starts on */
 214 } SIMPLE_COM;
 215
 216 /* The "function definition" command. */
 217 typedef struct function_def {
 218   int ignore;                   /* See description of CMD flags. */
 219   WORD_DESC *name;              /* The name of the function. */
 220   COMMAND *command;             /* The parsed execution tree. */
 221   int line;                     /* Line number the function def starts on. */
 222 } FUNCTION_DEF;
 223
 224 /* A command that is `grouped' allows pipes and redirections to affect all
 225    commands in the group. */
 226 typedef struct group_com {
 227   int ignore;                   /* See description of CMD flags. */
 228   COMMAND *command;
 229 } GROUP_COM;
 230
 231 extern COMMAND *global_command;
 232
 233 /* Forward declarations of functions declared in copy_cmd.c. */
 234
 235 extern WORD_DESC *copy_word __P((WORD_DESC *));
 236 extern WORD_LIST *copy_word_list __P((WORD_LIST *));
 237 extern REDIRECT *copy_redirect __P((REDIRECT *));
 238 extern REDIRECT *copy_redirects __P((REDIRECT *));
 239 extern COMMAND *copy_command __P((COMMAND *));
 240
 241 #endif /* _COMMAND_H_ */