Imported from ../bash-4.0-rc1.tar.gz.
[platform/upstream/bash.git] / subst.h
diff --git a/subst.h b/subst.h
index 3c3828f..b0149cc 100644 (file)
--- a/subst.h
+++ b/subst.h
@@ -1,22 +1,22 @@
 /* subst.h -- Names of externally visible functions in subst.c. */
 
-/* Copyright (C) 1993-2004 Free Software Foundation, Inc.
+/* Copyright (C) 1993-2009 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 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 3 of the License, 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.
+   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, 59 Temple Place, Suite 330, Boston, MA 02111 USA. */
+   You should have received a copy of the GNU General Public License
+   along with Bash.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
 #if !defined (_SUBST_H_)
 #define _SUBST_H_
 /* Flag values controlling how assignment statements are treated. */
 #define ASS_APPEND     0x01
 #define ASS_MKLOCAL    0x02
+#define ASS_MKASSOC    0x04
+
+/* Flags for the string extraction functions. */
+#define SX_NOALLOC     0x01    /* just skip; don't return substring */
+#define SX_VARNAME     0x02    /* variable name; for string_extract () */
+#define SX_REQMATCH    0x04    /* closing/matching delimiter required */
+#define SX_COMMAND     0x08    /* extracting a shell script/command */
+#define SX_NOCTLESC    0x10    /* don't honor CTLESC quoting */
+#define SX_NOESCCTLNUL 0x20    /* don't let CTLESC quote CTLNUL */
+#define SX_NOLONGJMP   0x40    /* don't longjmp on fatal error */
 
 /* Remove backslashes which are quoting backquotes from STRING.  Modifies
    STRING, and returns a pointer to it. */
@@ -52,8 +62,9 @@ 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 *));
+   Make (SINDEX) get the position just after the matching ")".
+   XFLAGS is additional flags to pass to other extraction functions, */
+extern char *extract_command_subst __P((char *, int *, int));
 
 /* Extract the $[ construct in STRING, and return a new string.
    Start extracting at (SINDEX) as if we had just seen "$[".
@@ -84,6 +95,12 @@ extern char *string_list_dollar_star __P((WORD_LIST *));
 /* Expand $@ into a single string, obeying POSIX rules. */
 extern char *string_list_dollar_at __P((WORD_LIST *, int));
 
+/* Turn the positional paramters into a string, understanding quoting and
+   the various subtleties of using the first character of $IFS as the
+   separator.  Calls string_list_dollar_at, string_list_dollar_star, and
+   string_list as appropriate. */
+extern char *string_list_pos_params __P((int, WORD_LIST *, int));
+
 /* Perform quoted null character removal on each element of LIST.
    This modifies LIST. */
 extern void word_list_remove_quoted_nulls __P((WORD_LIST *));
@@ -92,6 +109,7 @@ extern void word_list_remove_quoted_nulls __P((WORD_LIST *));
    STRING. */
 extern WORD_LIST *list_string __P((char *, char *, int));
 
+extern char *ifs_firstchar  __P((int *));
 extern char *get_word_from_string __P((char **, char *, char **));
 extern char *strip_trailing_ifs_whitespace __P((char *, char *, int));
 
@@ -157,6 +175,9 @@ extern char *expand_arith_string __P((char *, int));
 /* De-quote quoted characters in STRING. */
 extern char *dequote_string __P((char *));
 
+/* De-quote CTLESC-escaped CTLESC or CTLNUL characters in STRING. */
+extern char *dequote_escapes __P((char *));
+
 /* De-quote quoted characters in each word in LIST. */
 extern WORD_LIST *dequote_list __P((WORD_LIST *));
 
@@ -181,6 +202,12 @@ extern char *quote_string __P((char *));
    in a string. */
 extern char *quote_escapes __P((char *));
 
+/* And remove such quoted special characters. */
+extern char *remove_quoted_escapes __P((char *));
+
+/* Remove CTLNUL characters from STRING unless they are quoted with CTLESC. */
+extern char *remove_quoted_nulls __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));
@@ -219,7 +246,7 @@ extern WORD_LIST *expand_words_no_vars __P((WORD_LIST *));
    command substitution, arithmetic expansion, and word splitting. */
 extern WORD_LIST *expand_words_shellexp __P((WORD_LIST *));
 
-extern char *command_substitute __P((char *, int));
+extern WORD_DESC *command_substitute __P((char *, int));
 extern char *pat_subst __P((char *, char *, char *, int));
 
 extern int fifos_pending __P((void));
@@ -236,10 +263,15 @@ extern char *remove_backslashes __P((char *));
 extern char *cond_expand_word __P((WORD_DESC *, int));
 #endif
 
+/* Flags for skip_to_delim */
+#define SD_NOJMP       0x01    /* don't longjmp on fatal error. */
+#define SD_INVERT      0x02    /* look for chars NOT in passed set */
+
+extern int skip_to_delim __P((char *, int, char *, int));
+
 #if defined (READLINE)
 extern int char_is_quoted __P((char *, int));
 extern int unclosed_pair __P((char *, int, char *));
-extern int skip_to_delim __P((char *, int, char *));
 extern WORD_LIST *split_at_delims __P((char *, int, char *, int, int *, int *));
 #endif