subst.h

   1 /* subst.h -- Names of externally visible functions in subst.c. */
   2
   3 /* Copyright (C) 1993-2010 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 #if !defined (_SUBST_H_)
  22 #define _SUBST_H_
  23
  24 #include "stdc.h"
  25
  26 /* Constants which specify how to handle backslashes and quoting in
  27    expand_word_internal ().  Q_DOUBLE_QUOTES means to use the function
  28    slashify_in_quotes () to decide whether the backslash should be
  29    retained.  Q_HERE_DOCUMENT means slashify_in_here_document () to
  30    decide whether to retain the backslash.  Q_KEEP_BACKSLASH means
  31    to unconditionally retain the backslash.  Q_PATQUOTE means that we're
  32    expanding a pattern ${var%#[#%]pattern} in an expansion surrounded
  33    by double quotes. Q_DOLBRACE means we are expanding a ${...} word, so
  34    backslashes should also escape { and } and be removed. */
  35 #define Q_DOUBLE_QUOTES  0x01
  36 #define Q_HERE_DOCUMENT  0x02
  37 #define Q_KEEP_BACKSLASH 0x04
  38 #define Q_PATQUOTE       0x08
  39 #define Q_QUOTED         0x10
  40 #define Q_ADDEDQUOTES    0x20
  41 #define Q_QUOTEDNULL     0x40
  42 #define Q_DOLBRACE       0x80
  43
  44 /* Flag values controlling how assignment statements are treated. */
  45 #define ASS_APPEND      0x01
  46 #define ASS_MKLOCAL     0x02
  47 #define ASS_MKASSOC     0x04
  48
  49 /* Flags for the string extraction functions. */
  50 #define SX_NOALLOC      0x0001  /* just skip; don't return substring */
  51 #define SX_VARNAME      0x0002  /* variable name; for string_extract () */
  52 #define SX_REQMATCH     0x0004  /* closing/matching delimiter required */
  53 #define SX_COMMAND      0x0008  /* extracting a shell script/command */
  54 #define SX_NOCTLESC     0x0010  /* don't honor CTLESC quoting */
  55 #define SX_NOESCCTLNUL  0x0020  /* don't let CTLESC quote CTLNUL */
  56 #define SX_NOLONGJMP    0x0040  /* don't longjmp on fatal error */
  57 #define SX_ARITHSUB     0x0080  /* extracting $(( ... )) (currently unused) */
  58 #define SX_POSIXEXP     0x0100  /* extracting new Posix pattern removal expansions in extract_dollar_brace_string */
  59
  60 /* Remove backslashes which are quoting backquotes from STRING.  Modifies
  61    STRING, and returns a pointer to it. */
  62 extern char * de_backslash __P((char *));
  63
  64 /* Replace instances of \! in a string with !. */
  65 extern void unquote_bang __P((char *));
  66
  67 /* Extract the $( construct in STRING, and return a new string.
  68    Start extracting at (SINDEX) as if we had just seen "$(".
  69    Make (SINDEX) get the position just after the matching ")".
  70    XFLAGS is additional flags to pass to other extraction functions, */
  71 extern char *extract_command_subst __P((char *, int *, int));
  72
  73 /* Extract the $[ construct in STRING, and return a new string.
  74    Start extracting at (SINDEX) as if we had just seen "$[".
  75    Make (SINDEX) get the position just after the matching "]". */
  76 extern char *extract_arithmetic_subst __P((char *, int *));
  77
  78 #if defined (PROCESS_SUBSTITUTION)
  79 /* Extract the <( or >( construct in STRING, and return a new string.
  80    Start extracting at (SINDEX) as if we had just seen "<(".
  81    Make (SINDEX) get the position just after the matching ")". */
  82 extern char *extract_process_subst __P((char *, char *, int *));
  83 #endif /* PROCESS_SUBSTITUTION */
  84
  85 /* Extract the name of the variable to bind to from the assignment string. */
  86 extern char *assignment_name __P((char *));
  87
  88 /* Return a single string of all the words present in LIST, separating
  89    each word with SEP. */
  90 extern char *string_list_internal __P((WORD_LIST *, char *));
  91
  92 /* Return a single string of all the words present in LIST, separating
  93    each word with a space. */
  94 extern char *string_list __P((WORD_LIST *));
  95
  96 /* Turn $* into a single string, obeying POSIX rules. */
  97 extern char *string_list_dollar_star __P((WORD_LIST *));
  98
  99 /* Expand $@ into a single string, obeying POSIX rules. */
 100 extern char *string_list_dollar_at __P((WORD_LIST *, int));
 101
 102 /* Turn the positional paramters into a string, understanding quoting and
 103    the various subtleties of using the first character of $IFS as the
 104    separator.  Calls string_list_dollar_at, string_list_dollar_star, and
 105    string_list as appropriate. */
 106 extern char *string_list_pos_params __P((int, WORD_LIST *, int));
 107
 108 /* Perform quoted null character removal on each element of LIST.
 109    This modifies LIST. */
 110 extern void word_list_remove_quoted_nulls __P((WORD_LIST *));
 111
 112 /* This performs word splitting and quoted null character removal on
 113    STRING. */
 114 extern WORD_LIST *list_string __P((char *, char *, int));
 115
 116 extern char *ifs_firstchar  __P((int *));
 117 extern char *get_word_from_string __P((char **, char *, char **));
 118 extern char *strip_trailing_ifs_whitespace __P((char *, char *, int));
 119
 120 /* Given STRING, an assignment string, get the value of the right side
 121    of the `=', and bind it to the left side.  If EXPAND is true, then
 122    perform tilde expansion, parameter expansion, command substitution,
 123    and arithmetic expansion on the right-hand side.  Do not perform word
 124    splitting on the result of expansion. */
 125 extern int do_assignment __P((char *));
 126 extern int do_assignment_no_expand __P((char *));
 127 extern int do_word_assignment __P((WORD_DESC *, int));
 128
 129 /* Append SOURCE to TARGET at INDEX.  SIZE is the current amount
 130    of space allocated to TARGET.  SOURCE can be NULL, in which
 131    case nothing happens.  Gets rid of SOURCE by free ()ing it.
 132    Returns TARGET in case the location has changed. */
 133 extern char *sub_append_string __P((char *, char *, int *, int *));
 134
 135 /* Append the textual representation of NUMBER to TARGET.
 136    INDEX and SIZE are as in SUB_APPEND_STRING. */
 137 extern char *sub_append_number __P((intmax_t, char *, int *, int *));
 138
 139 /* Return the word list that corresponds to `$*'. */
 140 extern WORD_LIST *list_rest_of_args __P((void));
 141
 142 /* Make a single large string out of the dollar digit variables,
 143    and the rest_of_args.  If DOLLAR_STAR is 1, then obey the special
 144    case of "$*" with respect to IFS. */
 145 extern char *string_rest_of_args __P((int));
 146
 147 extern int number_of_args __P((void));
 148
 149 /* Expand STRING by performing parameter expansion, command substitution,
 150    and arithmetic expansion.  Dequote the resulting WORD_LIST before
 151    returning it, but do not perform word splitting.  The call to
 152    remove_quoted_nulls () is made here because word splitting normally
 153    takes care of quote removal. */
 154 extern WORD_LIST *expand_string_unsplit __P((char *, int));
 155
 156 /* Expand the rhs of an assignment statement. */
 157 extern WORD_LIST *expand_string_assignment __P((char *, int));
 158
 159 /* Expand a prompt string. */
 160 extern WORD_LIST *expand_prompt_string __P((char *, int, int));
 161
 162 /* Expand STRING just as if you were expanding a word.  This also returns
 163    a list of words.  Note that filename globbing is *NOT* done for word
 164    or string expansion, just when the shell is expanding a command.  This
 165    does parameter expansion, command substitution, arithmetic expansion,
 166    and word splitting.  Dequote the resultant WORD_LIST before returning. */
 167 extern WORD_LIST *expand_string __P((char *, int));
 168
 169 /* Convenience functions that expand strings to strings, taking care of
 170    converting the WORD_LIST * returned by the expand_string* functions
 171    to a string and deallocating the WORD_LIST *. */
 172 extern char *expand_string_to_string __P((char *, int));
 173 extern char *expand_string_unsplit_to_string __P((char *, int));
 174 extern char *expand_assignment_string_to_string __P((char *, int));
 175
 176 /* Expand an arithmetic expression string */
 177 extern char *expand_arith_string __P((char *, int));
 178
 179 /* De-quote quoted characters in STRING. */
 180 extern char *dequote_string __P((char *));
 181
 182 /* De-quote CTLESC-escaped CTLESC or CTLNUL characters in STRING. */
 183 extern char *dequote_escapes __P((char *));
 184
 185 /* De-quote quoted characters in each word in LIST. */
 186 extern WORD_LIST *dequote_list __P((WORD_LIST *));
 187
 188 /* Expand WORD, performing word splitting on the result.  This does
 189    parameter expansion, command substitution, arithmetic expansion,
 190    word splitting, and quote removal. */
 191 extern WORD_LIST *expand_word __P((WORD_DESC *, int));
 192
 193 /* Expand WORD, but do not perform word splitting on the result.  This
 194    does parameter expansion, command substitution, arithmetic expansion,
 195    and quote removal. */
 196 extern WORD_LIST *expand_word_unsplit __P((WORD_DESC *, int));
 197 extern WORD_LIST *expand_word_leave_quoted __P((WORD_DESC *, int));
 198
 199 /* Return the value of a positional parameter.  This handles values > 10. */
 200 extern char *get_dollar_var_value __P((intmax_t));
 201
 202 /* Quote a string to protect it from word splitting. */
 203 extern char *quote_string __P((char *));
 204
 205 /* Quote escape characters (characters special to interals of expansion)
 206    in a string. */
 207 extern char *quote_escapes __P((char *));
 208
 209 /* And remove such quoted special characters. */
 210 extern char *remove_quoted_escapes __P((char *));
 211
 212 /* Remove CTLNUL characters from STRING unless they are quoted with CTLESC. */
 213 extern char *remove_quoted_nulls __P((char *));
 214
 215 /* Perform quote removal on STRING.  If QUOTED > 0, assume we are obeying the
 216    backslash quoting rules for within double quotes. */
 217 extern char *string_quote_removal __P((char *, int));
 218
 219 /* Perform quote removal on word WORD.  This allocates and returns a new
 220    WORD_DESC *. */
 221 extern WORD_DESC *word_quote_removal __P((WORD_DESC *, int));
 222
 223 /* Perform quote removal on all words in LIST.  If QUOTED is non-zero,
 224    the members of the list are treated as if they are surrounded by
 225    double quotes.  Return a new list, or NULL if LIST is NULL. */
 226 extern WORD_LIST *word_list_quote_removal __P((WORD_LIST *, int));
 227
 228 /* Called when IFS is changed to maintain some private variables. */
 229 extern void setifs __P((SHELL_VAR *));
 230
 231 /* Return the value of $IFS, or " \t\n" if IFS is unset. */
 232 extern char *getifs __P((void));
 233
 234 /* This splits a single word into a WORD LIST on $IFS, but only if the word
 235    is not quoted.  list_string () performs quote removal for us, even if we
 236    don't do any splitting. */
 237 extern WORD_LIST *word_split __P((WORD_DESC *, char *));
 238
 239 /* Take the list of words in LIST and do the various substitutions.  Return
 240    a new list of words which is the expanded list, and without things like
 241    variable assignments. */
 242 extern WORD_LIST *expand_words __P((WORD_LIST *));
 243
 244 /* Same as expand_words (), but doesn't hack variable or environment
 245    variables. */
 246 extern WORD_LIST *expand_words_no_vars __P((WORD_LIST *));
 247
 248 /* Perform the `normal shell expansions' on a WORD_LIST.  These are
 249    brace expansion, tilde expansion, parameter and variable substitution,
 250    command substitution, arithmetic expansion, and word splitting. */
 251 extern WORD_LIST *expand_words_shellexp __P((WORD_LIST *));
 252
 253 extern WORD_DESC *command_substitute __P((char *, int));
 254 extern char *pat_subst __P((char *, char *, char *, int));
 255
 256 extern int fifos_pending __P((void));
 257 extern int num_fifos __P((void));
 258 extern void unlink_fifo_list __P((void));
 259 extern void unlink_fifo __P((int));
 260
 261 extern char *copy_fifo_list __P((int *));
 262 extern void unlink_new_fifos __P((char *, int));
 263 extern void close_new_fifos __P((char *, int));
 264
 265 extern WORD_LIST *list_string_with_quotes __P((char *));
 266
 267 #if defined (ARRAY_VARS)
 268 extern char *extract_array_assignment_list __P((char *, int *));
 269 #endif
 270
 271 #if defined (COND_COMMAND)
 272 extern char *remove_backslashes __P((char *));
 273 extern char *cond_expand_word __P((WORD_DESC *, int));
 274 #endif
 275
 276 /* Flags for skip_to_delim */
 277 #define SD_NOJMP        0x01    /* don't longjmp on fatal error. */
 278 #define SD_INVERT       0x02    /* look for chars NOT in passed set */
 279 #define SD_NOQUOTEDELIM 0x04    /* don't let single or double quotes act as delimiters */
 280 #define SD_NOSKIPCMD    0x08    /* don't skip over $(, <(, or >( command/process substitution */
 281 #define SD_EXTGLOB      0x10    /* skip over extended globbing patterns if appropriate */
 282
 283 extern int skip_to_delim __P((char *, int, char *, int));
 284
 285 #if defined (READLINE)
 286 extern int char_is_quoted __P((char *, int));
 287 extern int unclosed_pair __P((char *, int, char *));
 288 extern WORD_LIST *split_at_delims __P((char *, int, char *, int, int, int *, int *));
 289 #endif
 290
 291 /* Variables used to keep track of the characters in IFS. */
 292 extern SHELL_VAR *ifs_var;
 293 extern char *ifs_value;
 294 extern unsigned char ifs_cmap[];
 295
 296 #if defined (HANDLE_MULTIBYTE)
 297 extern unsigned char ifs_firstc[];
 298 extern size_t ifs_firstc_len;
 299 #else
 300 extern unsigned char ifs_firstc;
 301 #endif
 302
 303 /* Evaluates to 1 if C is a character in $IFS. */
 304 #define isifs(c)        (ifs_cmap[(unsigned char)(c)] != 0)
 305
 306 /* How to determine the quoted state of the character C. */
 307 #define QUOTED_CHAR(c)  ((c) == CTLESC)
 308
 309 /* Is the first character of STRING a quoted NULL character? */
 310 #define QUOTED_NULL(string) ((string)[0] == CTLNUL && (string)[1] == '\0')
 311
 312 #endif /* !_SUBST_H_ */