| /* subst.h -- Names of externally visible functions in subst.c. */ |
| |
| /* Copyright (C) 1993 Free Software Foundation, Inc. |
| |
| This file is part of GNU Bash, the Bourne Again SHell. |
| |
| Bash is free software; you can redistribute it and/or modify it under |
| the terms of the GNU General Public License as published by the Free |
| Software Foundation; either version 2, or (at your option) any later |
| version. |
| |
| Bash is distributed in the hope that it will be useful, but WITHOUT ANY |
| WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| for more details. |
| |
| You should have received a copy of the GNU General Public License along |
| with Bash; see the file COPYING. If not, write to the Free Software |
| Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ |
| |
| #if !defined (_SUBST_H_) |
| #define _SUBST_H_ |
| |
| #include "stdc.h" |
| |
| /* Cons a new string from STRING starting at START and ending at END, |
| not including END. */ |
| extern char *substring __P((char *, int, int)); |
| |
| /* Remove backslashes which are quoting backquotes from STRING. Modifies |
| STRING, and returns a pointer to it. */ |
| extern char * de_backslash __P((char *)); |
| |
| /* Replace instances of \! in a string with !. */ |
| extern void unquote_bang __P((char *)); |
| |
| /* Extract the $( construct in STRING, and return a new string. |
| Start extracting at (SINDEX) as if we had just seen "$(". |
| Make (SINDEX) get the position just after the matching ")". */ |
| extern char *extract_command_subst __P((char *, int *)); |
| |
| /* Extract the $[ construct in STRING, and return a new string. |
| Start extracting at (SINDEX) as if we had just seen "$[". |
| Make (SINDEX) get the position just after the matching "]". */ |
| extern char *extract_arithmetic_subst __P((char *, int *)); |
| |
| #if defined (PROCESS_SUBSTITUTION) |
| /* Extract the <( or >( construct in STRING, and return a new string. |
| Start extracting at (SINDEX) as if we had just seen "<(". |
| Make (SINDEX) get the position just after the matching ")". */ |
| extern char *extract_process_subst __P((char *, char *, int *)); |
| #endif /* PROCESS_SUBSTITUTION */ |
| |
| /* Extract the name of the variable to bind to from the assignment string. */ |
| extern char *assignment_name __P((char *)); |
| |
| /* Return a single string of all the words present in LIST, separating |
| each word with a space. */ |
| extern char *string_list __P((WORD_LIST *)); |
| |
| /* Perform quoted null character removal on each element of LIST. |
| This modifies LIST. */ |
| extern void word_list_remove_quoted_nulls __P((WORD_LIST *)); |
| |
| /* This performs word splitting and quoted null character removal on |
| STRING. */ |
| extern WORD_LIST *list_string __P((char *, char *, int)); |
| |
| extern char *get_word_from_string __P((char **, char *, char **)); |
| extern char *strip_trailing_ifs_whitespace __P((char *, char *, int)); |
| |
| /* Given STRING, an assignment string, get the value of the right side |
| of the `=', and bind it to the left side. If EXPAND is true, then |
| perform parameter expansion, command substitution, and arithmetic |
| expansion on the right-hand side. Perform tilde expansion in any |
| case. Do not perform word splitting on the result of expansion. */ |
| extern int do_assignment __P((char *)); |
| extern int do_assignment_no_expand __P((char *)); |
| |
| #if defined (ARRAY_VARS) |
| extern SHELL_VAR *do_array_element_assignment __P((char *, char *)); |
| #endif |
| |
| /* Append SOURCE to TARGET at INDEX. SIZE is the current amount |
| of space allocated to TARGET. SOURCE can be NULL, in which |
| case nothing happens. Gets rid of SOURCE by free ()ing it. |
| Returns TARGET in case the location has changed. */ |
| extern char *sub_append_string __P((char *, char *, int *, int *)); |
| |
| /* Append the textual representation of NUMBER to TARGET. |
| INDEX and SIZE are as in SUB_APPEND_STRING. */ |
| extern char *sub_append_number __P((int, char *, int *, int *)); |
| |
| /* Return the word list that corresponds to `$*'. */ |
| extern WORD_LIST *list_rest_of_args __P((void)); |
| |
| /* Make a single large string out of the dollar digit variables, |
| and the rest_of_args. If DOLLAR_STAR is 1, then obey the special |
| case of "$*" with respect to IFS. */ |
| extern char *string_rest_of_args __P((int)); |
| |
| extern int number_of_args __P((void)); |
| |
| /* Expand STRING by performing parameter expansion, command substitution, |
| and arithmetic expansion. Dequote the resulting WORD_LIST before |
| returning it, but do not perform word splitting. The call to |
| remove_quoted_nulls () is in here because word splitting normally |
| takes care of quote removal. */ |
| extern WORD_LIST *expand_string_unsplit __P((char *, int)); |
| |
| /* Expand STRING just as if you were expanding a word. This also returns |
| a list of words. Note that filename globbing is *NOT* done for word |
| or string expansion, just when the shell is expanding a command. This |
| does parameter expansion, command substitution, arithmetic expansion, |
| and word splitting. Dequote the resultant WORD_LIST before returning. */ |
| extern WORD_LIST *expand_string __P((char *, int)); |
| |
| /* De-quoted quoted characters in STRING. */ |
| extern char *dequote_string __P((char *)); |
| |
| /* Expand WORD, performing word splitting on the result. This does |
| parameter expansion, command substitution, arithmetic expansion, |
| word splitting, and quote removal. */ |
| extern WORD_LIST *expand_word __P((WORD_DESC *, int)); |
| |
| /* Expand WORD, but do not perform word splitting on the result. This |
| does parameter expansion, command substitution, arithmetic expansion, |
| and quote removal. */ |
| extern WORD_LIST *expand_word_no_split __P((WORD_DESC *, int)); |
| extern WORD_LIST *expand_word_leave_quoted __P((WORD_DESC *, int)); |
| |
| /* Return the value of a positional parameter. This handles values > 10. */ |
| extern char *get_dollar_var_value __P((int)); |
| |
| /* Quote a string to protect it from word splitting. */ |
| extern char *quote_string __P((char *)); |
| |
| /* Perform quote removal on STRING. If QUOTED > 0, assume we are obeying the |
| backslash quoting rules for within double quotes. */ |
| extern char *string_quote_removal __P((char *, int)); |
| |
| /* Perform quote removal on word WORD. This allocates and returns a new |
| WORD_DESC *. */ |
| extern WORD_DESC *word_quote_removal __P((WORD_DESC *, int)); |
| |
| /* Perform quote removal on all words in LIST. If QUOTED is non-zero, |
| the members of the list are treated as if they are surrounded by |
| double quotes. Return a new list, or NULL if LIST is NULL. */ |
| extern WORD_LIST *word_list_quote_removal __P((WORD_LIST *, int)); |
| |
| /* This splits a single word into a WORD LIST on $IFS, but only if the word |
| is not quoted. list_string () performs quote removal for us, even if we |
| don't do any splitting. */ |
| extern WORD_LIST *word_split __P((WORD_DESC *)); |
| |
| /* Take the list of words in LIST and do the various substitutions. Return |
| a new list of words which is the expanded list, and without things like |
| variable assignments. */ |
| extern WORD_LIST *expand_words __P((WORD_LIST *)); |
| |
| /* Same as expand_words (), but doesn't hack variable or environment |
| variables. */ |
| extern WORD_LIST *expand_words_no_vars __P((WORD_LIST *)); |
| |
| /* Perform the `normal shell expansions' on a WORD_LIST. These are |
| brace expansion, tilde expansion, parameter and variable substitution, |
| command substitution, arithmetic expansion, and word splitting. */ |
| extern WORD_LIST *expand_words_shellexp __P((WORD_LIST *)); |
| |
| extern char *pat_subst __P((char *, char *, char *, int)); |
| |
| extern void unlink_fifo_list __P((void)); |
| |
| #if defined (ARRAY_VARS) |
| extern int array_expand_index __P((char *, int)); |
| extern int valid_array_reference __P((char *)); |
| extern char *get_array_value __P((char *, int)); |
| extern SHELL_VAR *array_variable_part __P((char *, char **, int *)); |
| extern WORD_LIST *list_string_with_quotes __P((char *)); |
| extern char *extract_array_assignment_list __P((char *, int *)); |
| #endif |
| |
| #if defined (COND_COMMAND) |
| extern char *remove_backslashes __P((char *)); |
| extern char *cond_expand_word __P((WORD_DESC *, int)); |
| #endif |
| |
| /* How to determine the quoted state of the character C. */ |
| #define QUOTED_CHAR(c) ((c) == CTLESC) |
| |
| /* Is the first character of STRING a quoted NULL character? */ |
| #define QUOTED_NULL(string) ((string)[0] == CTLNUL && (string)[1] == '\0') |
| |
| #endif /* !_SUBST_H_ */ |