mirrors/zsh
1
0
Fork 0
mirror of git://git.code.sf.net/p/zsh/code synced 2025-09-15 02:11:07 +02:00
Code Releases Activity

users/17305: fix doc of ordering of word splitting

Browse source 
improve (z) and (Z) doc
This commit is contained in:
Peter Stephenson 2012-10-03 18:12:47 +00:00
parent 61b9529ff8
commit 325c3864c6
2 changed files with 48 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
ChangeLog
View file

@ -1,5 +1,8 @@
2012-10-03 Peter Stephenson <p.w.stephenson@ntlworld.com> 2012-10-03 Peter Stephenson <p.w.stephenson@ntlworld.com>
* users/17305: Doc/Zsh/expn.yo: fix documentation for ordering
of word splitting and improve (z) and (Z) documentation.
* users/17310: Doc/Zsh/params.yo, Src/lex.c, Test/A04redirect.ztst, * users/17310: Doc/Zsh/params.yo, Src/lex.c, Test/A04redirect.ztst,
Test/D06subscript.ztst: back off users/17304 owing to problem Test/D06subscript.ztst: back off users/17304 owing to problem
with [ command, document problem, and test the case that needs with [ command, document problem, and test the case that needs
@ -214,5 +217,5 @@
***************************************************** *****************************************************
* This is used by the shell to define $ZSH_PATCHLEVEL * This is used by the shell to define $ZSH_PATCHLEVEL
* $Revision: 1.5732 $ * $Revision: 1.5733 $
***************************************************** *****************************************************

81
Doc/Zsh/expn.yo
View file

@ -1051,12 +1051,13 @@ item(tt(z))(
Split the result of the expansion into words using shell parsing to Split the result of the expansion into words using shell parsing to
find the words, i.e. taking into account any quoting in the value. find the words, i.e. taking into account any quoting in the value.
Comments are not treated specially but as ordinary strings, similar Comments are not treated specially but as ordinary strings, similar
to interactive shells with the tt(INTERACTIVE_COMMENTS) option unset. to interactive shells with the tt(INTERACTIVE_COMMENTS) option unset
(however, see the tt(Z) flag below for related options)
Note that this is done very late, as for the `tt((s))' flag. So to Note that this is done very late, even later than the `tt((s))' flag. So to
access single words in the result, one has to use nested expansions as access single words in the result use nested expansions as
in `tt(${${(z)foo}[2]})'. Likewise, to remove the quotes in the in `tt(${${(z)foo}[2]})'. Likewise, to remove the quotes in the
resulting words one would do: `tt(${(Q)${(z)foo}})'. resulting words use `tt(${(Q)${(z)foo}})'.
) )
item(tt(0))( item(tt(0))(
Split the result of the expansion on null bytes. This is a shorthand Split the result of the expansion on null bytes. This is a shorthand
@ -1165,7 +1166,8 @@ i.e. tt("${(@s.:.)line}").
) )
item(tt(Z:)var(opts)tt(:))( item(tt(Z:)var(opts)tt(:))(
As tt(z) but takes a combination of option letters between a following As tt(z) but takes a combination of option letters between a following
pair of delimiter characters. tt(LPAR()Z+PLUS()c+PLUS()RPAR()) pair of delimiter characters. With no options the effect is identical
to tt(z). tt(LPAR()Z+PLUS()c+PLUS()RPAR())
causes comments to be parsed as a string and retained; any field in the causes comments to be parsed as a string and retained; any field in the
resulting array beginning with an unquoted comment character is a resulting array beginning with an unquoted comment character is a
comment. tt(LPAR()Z+PLUS()C+PLUS()RPAR()) causes comments to be parsed comment. tt(LPAR()Z+PLUS()C+PLUS()RPAR()) causes comments to be parsed
@ -1248,7 +1250,7 @@ em(no responsibility) for any brain damage which may occur during the
reading of the following rules. reading of the following rules.
startitem() startitem()
item(tt(1.) em(Nested Substitution))( item(tt(1.) em(Nested substitution))(
If multiple nested tt(${...}) forms are present, substitution is If multiple nested tt(${...}) forms are present, substitution is
performed from the inside outwards. At each level, the substitution takes performed from the inside outwards. At each level, the substitution takes
account of whether the current value is a scalar or an array, whether the account of whether the current value is a scalar or an array, whether the
@ -1272,12 +1274,12 @@ which is expanded by filename expansion to a full path; the outer
substitution then applies the modifier tt(:h) and takes the directory part substitution then applies the modifier tt(:h) and takes the directory part
of the path.) of the path.)
) )
item(tt(2.) em(Internal Parameter Flags))( item(tt(2.) em(Internal parameter flags))(
Any parameter flags set by one of the tt(typeset) family of commands, Any parameter flags set by one of the tt(typeset) family of commands,
in particular the tt(L), tt(R), tt(Z), tt(u) and tt(l) flags for padding in particular the tt(L), tt(R), tt(Z), tt(u) and tt(l) flags for padding
and capitalization, are applied directly to the parameter value. and capitalization, are applied directly to the parameter value.
) )
item(tt(3.) em(Parameter Subscripting))( item(tt(3.) em(Parameter subscripting))(
If the value is a raw parameter reference with a subscript, such as If the value is a raw parameter reference with a subscript, such as
tt(${)var(var)tt([3]}), the effect of subscripting is applied directly to tt(${)var(var)tt([3]}), the effect of subscripting is applied directly to
the parameter. Subscripts are evaluated left to right; subsequent the parameter. Subscripts are evaluated left to right; subsequent
@ -1287,11 +1289,11 @@ character of the first word, but tt(${var[2,4][2]}) is the entire third
word (the second word of the range of words two through four of the word (the second word of the range of words two through four of the
original array). Any number of subscripts may appear. original array). Any number of subscripts may appear.
) )
item(tt(4.) em(Parameter Name Replacement))( item(tt(4.) em(Parameter name replacement))(
The effect of any tt((P)) flag, which treats the value so far as a The effect of any tt((P)) flag, which treats the value so far as a
parameter name and replaces it with the corresponding value, is applied. parameter name and replaces it with the corresponding value, is applied.
) )
item(tt(5.) em(Double-Quoted Joining))( item(tt(5.) em(Double-quoted joining))(
If the value after this process is an array, and the substitution If the value after this process is an array, and the substitution
appears in double quotes, and no tt((@)) flag is present at the current appears in double quotes, and no tt((@)) flag is present at the current
level, the words of the value are joined with the first character of the level, the words of the value are joined with the first character of the
@ -1299,7 +1301,7 @@ parameter tt($IFS), by default a space, between each word (single word
arrays are not modified). If the tt((j)) flag is present, that is used for arrays are not modified). If the tt((j)) flag is present, that is used for
joining instead of tt($IFS). joining instead of tt($IFS).
) )
item(tt(6.) em(Nested Subscripting))( item(tt(6.) em(Nested subscripting))(
Any remaining subscripts (i.e. of a nested substitution) are evaluated at Any remaining subscripts (i.e. of a nested substitution) are evaluated at
this point, based on whether the value is an array or a scalar. As with this point, based on whether the value is an array or a scalar. As with
tt(3.), multiple subscripts can appear. Note that tt(${foo[2,4][2]}) is tt(3.), multiple subscripts can appear. Note that tt(${foo[2,4][2]}) is
@ -1322,7 +1324,7 @@ item(tt(9.) em(Length))(
Any initial tt(#) modifier, i.e. in the form tt(${#)var(var)tt(}), is Any initial tt(#) modifier, i.e. in the form tt(${#)var(var)tt(}), is
used to evaluate the length of the expression so far. used to evaluate the length of the expression so far.
) )
item(tt(10.) em(Forced Joining))( item(tt(10.) em(Forced joining))(
If the `tt((j))' flag is present, or no `tt((j))' flag is present but If the `tt((j))' flag is present, or no `tt((j))' flag is present but
the string is to be split as given by rules tt(16.) or tt(17.), and joining the string is to be split as given by rules tt(16.) or tt(17.), and joining
did not take place at step tt(5.), any words in the value are joined did not take place at step tt(5.), any words in the value are joined
@ -1330,37 +1332,42 @@ together using the given string or the first character of tt($IFS) if none.
Note that the `tt((F))' flag implicitly supplies a string for joining in this Note that the `tt((F))' flag implicitly supplies a string for joining in this
manner. manner.
) )
item(tt(11.) em(Case modification))( item(tt(11.) em(Simple word splitting))(
Any case modification from one of the flags tt((L)), tt((U)) or tt((C)) If one of the `tt((s))' or `tt((f))' flags are present, or the `tt(=)'
is applied.
)
item(tt(12.) em(Escape sequence replacement))(
First any replacements from the tt((g)) flag are performed, then any
prompt-style formatting from the tt((%)) family of flags is applied.
)
item(tt(13.) em(Quote application))(
Any quoting or unquoting using tt((q)) and tt((Q)) and related flags
is applied.
)
item(tt(14.) em(Directory naming))(
Any directory name substitution using tt((D)) flag is applied.
)
item(tt(15.) em(Visibility enhancment))(
Any modifications to make characters visible using the tt((V)) flag
are applied.
)
item(tt(16.) em(Forced Splitting))(
If one of the `tt((s))', `tt((f))' or `tt((z))' flags are present, or the `tt(=)'
specifier was present (e.g. tt(${=)var(var)tt(})), the word is split on specifier was present (e.g. tt(${=)var(var)tt(})), the word is split on
occurrences of the specified string, or (for tt(=) with neither of the two occurrences of the specified string, or (for tt(=) with neither of the two
flags present) any of the characters in tt($IFS). flags present) any of the characters in tt($IFS).
)
item(tt(17.) em(Shell Word Splitting))(
If no `tt((s))', `tt((f))' or `tt(=)' was given, but the word is not If no `tt((s))', `tt((f))' or `tt(=)' was given, but the word is not
quoted and the option tt(SH_WORD_SPLIT) is set, the word is split on quoted and the option tt(SH_WORD_SPLIT) is set, the word is split on
occurrences of any of the characters in tt($IFS). Note this step, too, occurrences of any of the characters in tt($IFS). Note this step, too,
takes place at all levels of a nested substitution. takes place at all levels of a nested substitution.
) )
item(tt(12.) em(Case modification))(
Any case modification from one of the flags tt((L)), tt((U)) or tt((C))
is applied.
)
item(tt(13.) em(Escape sequence replacement))(
First any replacements from the tt((g)) flag are performed, then any
prompt-style formatting from the tt((%)) family of flags is applied.
)
item(tt(14.) em(Quote application))(
Any quoting or unquoting using tt((q)) and tt((Q)) and related flags
is applied.
)
item(tt(15.) em(Directory naming))(
Any directory name substitution using tt((D)) flag is applied.
)
item(tt(16.) em(Visibility enhancment))(
Any modifications to make characters visible using the tt((V)) flag
are applied.
)
item(tt(17.) em(Lexical word splitting))(
If the 'tt((z))' flag or one of the forms of the 'tt((Z))' flag is
present, the word is split as if it were a shell command line, so that
quotation marks and other metacharacters are used to decide what
constitutes a word.
)
item(tt(18.) em(Uniqueness))( item(tt(18.) em(Uniqueness))(
If the result is an array and the `tt((u))' flag was present, duplicate If the result is an array and the `tt((u))' flag was present, duplicate
elements are removed from the array. elements are removed from the array.
@ -1369,7 +1376,7 @@ item(tt(19.) em(Ordering))(
If the result is still an array and one of the `tt((o))' or `tt((O))' flags If the result is still an array and one of the `tt((o))' or `tt((O))' flags
was present, the array is reordered. was present, the array is reordered.
) )
item(tt(20.) em(Re-Evaluation))( item(tt(20.) em(Re-evaluation))(
Any `tt((e))' flag is applied to the value, forcing it to be re-examined Any `tt((e))' flag is applied to the value, forcing it to be re-examined
for new parameter substitutions, but also for command and arithmetic for new parameter substitutions, but also for command and arithmetic
substitutions. substitutions.
@ -1378,7 +1385,7 @@ item(tt(21.) em(Padding))(
Any padding of the value by the `tt(LPAR()l.)var(fill)tt(.RPAR())' or Any padding of the value by the `tt(LPAR()l.)var(fill)tt(.RPAR())' or
`tt(LPAR()r.)var(fill)tt(.RPAR())' flags is applied. `tt(LPAR()r.)var(fill)tt(.RPAR())' flags is applied.
) )
item(tt(22.) em(Semantic Joining))( item(tt(22.) em(Semantic joining))(
In contexts where expansion semantics requires a single word to In contexts where expansion semantics requires a single word to
result, all words are rejoined with the first character of tt(IFS) result, all words are rejoined with the first character of tt(IFS)
between. So in `tt(${LPAR()P)tt(RPAR()${LPAR()f)tt(RPAR()lines}})' between. So in `tt(${LPAR()P)tt(RPAR()${LPAR()f)tt(RPAR()lines}})'