Quotes (StringTokenizer property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span style="font-size:120%; color:black"><b>Characters which are quotation characters</b></span>
{{Template:StringTokenizer:Quotes subtitle}}
[[Category:StringTokenizer methods|Quotes property]]
<!--DPL?? Category:StringTokenizer methods|Quotes property: Characters which are quotation characters-->
<!--DPL?? Category:System methods|Quotes (StringTokenizer property): Characters which are quotation characters-->
<p>
Quotes is a member of the [[StringTokenizer class]].
</p>


This readWrite property returns or sets
This readWrite property returns or sets
the characters that are recognized as quotation characters.
the characters that are recognized as quotation characters.
The text between each disjoint pair of identical quotation characters
The text between each disjoint pair of identical quotation characters
(a &ldquo;quoted region&rdquo;) is treated as a single token, and any
(a "quoted region") is treated as a single token, and any
delimiter characters (Quote, Space, or TokenChar)
delimiter characters (Quote, Space, or TokenChar)
within a quoted region are treated as non-delimiters.
within a quoted region are treated as non-delimiters.


===Syntax===
==Syntax==
  %chars = %tok:Quotes
{{Template:StringTokenizer:Quotes syntax}}
 
  %tok:Quotes = %chars
===Syntax terms===
===Syntax terms===
<dl>
<dl>
Line 32: Line 24:


</dl>
</dl>
===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>No character can be one of the Quotes characters and also be
<li>No character can be one of the Quotes characters and also be
Line 46: Line 38:
quotes are removed from the returned values of quoted tokens.
quotes are removed from the returned values of quoted tokens.
</ul>
</ul>
===Examples===
==Examples==


The following request fragment employs two quotation characters, and
The following request fragment employs two quotation characters, and
Line 66: Line 58:
     "trivial"
     "trivial"
</pre>
</pre>
==See also==
{{Template:StringTokenizer:Quotes footer}}

Revision as of 19:54, 6 February 2011

Characters to be interpreted as quotes (StringTokenizer class)


This readWrite property returns or sets the characters that are recognized as quotation characters. The text between each disjoint pair of identical quotation characters (a "quoted region") is treated as a single token, and any delimiter characters (Quote, Space, or TokenChar) within a quoted region are treated as non-delimiters.

Syntax

%currentString = stringTokenizer:Quotes stringTokenizer:Quotes = newString

Syntax terms

%chars
A string variable to contain the returned value of the current quotation characters or to be set as the new value. The default value for a new tokenizer is a null string. If you are setting Quotes, each character in the string is a quotation character — that is, you may not separate characters — and no character may repeat (except for apostrophe, which may be doubled).
%tok
A StringTokenizer object variable.

Usage notes

  • No character can be one of the Quotes characters and also be one of either the Spaces characters or the TokenChars characters.
  • The Quotes characters are initially settable in the New call that creates the tokenizer instance.
  • A quotation character may participate in only one quoted region. The first quotation character from the beginning of the tokenization string is paired with the following identical quotation character in the string. An unpaired quotation character causes a request cancellation.
  • A quoted region is not affected by the TokensToLower and TokensToUpper properties.
  • The RemoveQuotes property controls whether quotes are removed from the returned values of quoted tokens.

Examples

The following request fragment employs two quotation characters, and it uses the RemoveQuotes method to include the quotation characters in the returned tokens:

    %tok = new(Quotes='"+')
    %tok:string = '+This  Quotes  example+ is "trivial"'
    %tok:removeQuotes = False
    Print %tok:nextToken
    Print %tok:nextToken
    Print %tok:nextToken

The result is:

    +This  Quotes  example+
    is
    "trivial"

See also