SkipTokens (StringTokenizer subroutine): 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>Move current token forward a specified number of tokens</b></span>
{{Template:StringTokenizer:SkipTokens subtitle}}
[[Category:StringTokenizer methods|SkipTokens subroutine]]
<!--DPL?? Category:StringTokenizer methods|SkipTokens subroutine: Move current token forward a specified number of tokens-->
<!--DPL?? Category:System methods|SkipTokens (StringTokenizer subroutine): Move current token forward a specified number of tokens-->
<p>
SkipTokens is a member of the [[StringTokenizer class]].
</p>


This method moves the current token and tokenizing position forward in the
This method moves the current token and tokenizing position forward in the
Line 19: Line 13:


The SkipTokens subroutine is available as of version 7.7  of the ''Sirius Mods''.
The SkipTokens subroutine is available as of version 7.7  of the ''Sirius Mods''.
===Syntax===
==Syntax==
  %tok:SkipTokens(num)
{{Template:StringTokenizer:SkipTokens syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<dl>
Line 31: Line 25:


</dl>
</dl>
===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>For a new StringTokenizer instance, issuing NextToken, SkipTokens,
<li>For a new StringTokenizer instance, issuing NextToken, SkipTokens,
Line 37: Line 31:
[[CurrentToken (StringTokenizer function)|CurrentToken]] may be issued without error.
[[CurrentToken (StringTokenizer function)|CurrentToken]] may be issued without error.
</ul>
</ul>
===Examples===
==Examples==


The following code fragment shows multiple SkipTokens calls.
The following code fragment shows multiple SkipTokens calls.
Line 70: Line 64:
     %tok:nextPosition = 32
     %tok:nextPosition = 32
</pre>
</pre>
==See also==
{{Template:StringTokenizer:SkipTokens footer}}

Revision as of 19:54, 6 February 2011

Move current token forward a specified number of tokens (StringTokenizer class)

[Introduced in Sirius Mods 7.7]


This method moves the current token and tokenizing position forward in the tokenizer string the number of tokens specified in the method argument. Skipping one token is equivalent to executing NextToken; skipping three tokens is equivalent to executing NextToken three times consecutively.

If a token is found after advancing the designated number of tokens, the tokenizing position in the string is moved after the found token, and CurrentToken will return the found token. If the end of the string occurs before the specified number of tokens, the request is cancelled.

The SkipTokens subroutine is available as of version 7.7 of the Sirius Mods.

Syntax

stringTokenizer:SkipTokens( number) Throws MismatchedQuote, OutOfBounds

Syntax terms

%tok
A StringTokenizer object variable.
num
A numeric variable that is the number of tokens to skip. The value of num must be greater than 0 and less than the number of tokens remaining in the tokenizer string.

Usage notes

  • For a new StringTokenizer instance, issuing NextToken, SkipTokens, or FindToken is required before CurrentToken may be issued without error.

Examples

The following code fragment shows multiple SkipTokens calls. The second call follows a move of the tokenizing position to the middle of the initial token in the tokenizer string.

   begin
     %tok is object stringTokenizer
     %tok = new
     %tok:string = 'Here is the skipTokens example.'
     printText {~} = '{%tok:string}'
     %tok:skipTokens(3)
     printText {~} = {%tok:currentToken}
     printText {~} = {%tok:nextPosition}
     %tok:nextPosition = 3
     %tok:skipTokens(1)
     printText {~} = {%tok:currentToken}
     printText {~} = {%tok:nextPosition}
     %tok:skipTokens(4)
     printText {~} = {%tok:currentToken}
   end


The result is:

    %tok:string = 'Here is the skipTokens example.'
    %tok:currentToken = the
    %tok:nextPosition = 12
    %tok:currentToken = re
    %tok:nextPosition = 5
    %tok:currentToken = example.
    %tok:nextPosition = 32

See also