QuotesBreak (StringTokenizer property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 8: Line 8:
==Syntax==
==Syntax==
{{Template:StringTokenizer:QuotesBreak syntax}}
{{Template:StringTokenizer:QuotesBreak syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%currentBoolean</th>
<tr><th>%currentBoolean</th>
<td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>CurrentQuoted</var>. The default value is <var>True</var>.
<td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>QuotesBreak</var>. The default value is <var>True</var>.


For more information about <var>Boolean</var> enumerations, see [[Enumerations#Using_Boolean_enumerations|"Using Boolean Enumerations"]].</td></tr>
For more information about <var>Boolean</var> enumerations, see [[Enumerations#Using_Boolean_enumerations|"Using Boolean Enumerations"]].</td></tr>
Line 18: Line 19:
<td>A <var>StringTokenizer</var> object expression.</td></tr>
<td>A <var>StringTokenizer</var> object expression.</td></tr>


<tr><th>%currentBoolean</th>
<tr><th>newBoolean</th>
<td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>CurrentQuoted</var>. The default value is <var>True</var>.
<td>A <var>Boolean</var> enumeration value.
</table>
</table>



Revision as of 00:06, 5 July 2012

Do quotes break the current token? (StringTokenizer class)

[Introduced in Sirius Mods 7.8]


QuotesBreak determines whether quotes are considered boundaries of tokens. The string peanut"butter" will tokenize to peanut and butter when QuotesBreak is true. Otherwise it will tokenize to peanutbutter (assuming RemoveQuotes is set).

Syntax

%currentBoolean = stringTokenizer:QuotesBreak stringTokenizer:QuotesBreak = newBoolean

Syntax terms

%currentBoolean An enumeration object of type Boolean to contain the returned value of QuotesBreak. The default value is True. For more information about Boolean enumerations, see "Using Boolean Enumerations".
stringTokenizer A StringTokenizer object expression.
newBoolean A Boolean enumeration value.

Usage notes

  • The Quotes characters are initially settable in the New call that creates the tokenizer instance.
  • The RemoveQuotes property controls whether quotes are removed from the returned values of quoted tokens.

Examples

In this example, the string fire"works" is either one or two tokens, depending on the setting of QuotesBreak:

b %tok is object StringTokenizer %tok = new(quotes='"') %tok:string = 'fire"works"' PrintText {~} is: {%tok:quotesbreak} repeat while %tok:notAtEnd printtext {~} = {%tok:nextToken} end repeat %tok:string = 'fire"works"' %tok:quotesbreak = False PrintText {~} is: {%tok:quotesbreak} repeat while %tok:notAtEnd printtext {~} = {%tok:nextToken} end repeat end

The result is:

%tok:quotesbreak is: True %tok:nextToken = fire %tok:nextToken = works %tok:quotesbreak is: False %tok:nextToken = fireworks

See also