Quotes (StringTokenizer property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 11: Line 11:
{{Template:StringTokenizer:Quotes syntax}}
{{Template:StringTokenizer:Quotes syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt><i>%chars</i>
<tr><th><i>%chars</i></th>
<dd>A string variable to contain the returned value of the current quotation
<td>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.
characters or to be set as the new value.
If you are setting Quotes, each character in the string is a quotation character &mdash; that is, you may not separate characters &mdash; and no character may repeat (except for apostrophe, which may be doubled). </td></tr>
The default value for a new tokenizer is a null string.
<tr><th><i>%tok</i></th>
 
<td>A StringTokenizer object variable.</td></tr>
If you are setting Quotes, each character in the string is a quotation
</table>
character &mdash; that is, you may not separate characters &mdash; and no character
may repeat (except for apostrophe, which may be doubled).
<dt><i>%tok</i>
<dd>A StringTokenizer object variable.
 
</dl>
==Usage notes==
==Usage notes==
<ul>
<ul>

Revision as of 19:55, 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