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