SkipTokens (StringTokenizer subroutine) - Revision history

JAL: /* Examples */

2012-11-14T23:04:41Z

Examples

← Older revision		Revision as of 23:04, 14 November 2012
Line 50:		Line 50:
	printText {~} = {%tok:currentToken}		printText {~} = {%tok:currentToken}
	end		end
			</p>


	~~</p>~~
	The result is:		The result is:
	<p class="output">%tok:string = 'Here is the skipTokens example.'		<p class="output">%tok:string = 'Here is the skipTokens example.'
Line 62:		Line 61:
	%tok:nextPosition = 32		%tok:nextPosition = 32
	</p>		</p>

	==See also==		==See also==
	{{Template:StringTokenizer:SkipTokens footer}}		{{Template:StringTokenizer:SkipTokens footer}}

JALWiccan: 1 revision

2012-07-05T21:20:39Z

1 revision

← Older revision	Revision as of 21:20, 5 July 2012
(No difference)

JALWiccan: 1 revision

2012-07-05T21:20:38Z

1 revision

← Older revision		Revision as of 21:20, 5 July 2012
Line 4:		Line 4:
	tokenizer string the number of tokens specified in the method argument.		tokenizer string the number of tokens specified in the method argument.
	Skipping one token is equivalent to executing <var>[[NextToken (StringTokenizer function)\|NextToken]]</var>;		Skipping one token is equivalent to executing <var>[[NextToken (StringTokenizer function)\|NextToken]]</var>;
	skipping three tokens is equivalent to executing NextToken three times consecutively.		skipping three tokens is equivalent to executing <var>NextToken</var> three times consecutively.

	If a token is found after advancing the designated number of tokens, the		If a token is found after advancing the designated number of tokens, the

JALWiccan: 1 revision

2011-05-24T22:31:14Z

1 revision

New page

{{Template:StringTokenizer:SkipTokens subtitle}}

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 <var>[[NextToken (StringTokenizer function)|NextToken]]</var>;
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
<var>[[CurrentToken (StringTokenizer function)|CurrentToken]]</var> will return the found token.
If the end of the string occurs before the specified number of tokens,
the request is cancelled.

The <var>SkipTokens</var> subroutine is available as of version 7.7 of the <var class="product">Sirius Mods</var>.
==Syntax==
{{Template:StringTokenizer:SkipTokens syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression. </td></tr>
<tr><th>number</th>
<td>A numeric variable that is the number of tokens to skip. The value of <var class="term">number</var> must be greater than 0 and less than the number of tokens remaining in the tokenizer string.</td></tr>
</table>
==Usage notes==
<ul>
<li>For a new <var>StringTokenizer</var> instance, issuing <var>NextToken</var>, <var>SkipTokens</var>,
or <var>[[FindToken (StringTokenizer function)|FindToken]]</var> is required before
<var>CurrentToken</var> may be issued without error.
</ul>

==Examples==

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

<p class="code">begin
%tok is object stringTokenizer
%tok = new
%tok:string = 'Here is the skipTokens example.'
[[Targeted Text statements|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

</p>
The result is:
<p class="output">%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
</p>
==See also==
{{Template:StringTokenizer:SkipTokens footer}}

Dme at 17:22, 15 February 2011

2011-02-15T17:22:36Z

Dme: /* Usage notes */

2011-02-15T17:20:42Z

Usage notes

← Older revision		Revision as of 17:20, 15 February 2011
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>For a new <var>StringTokenizer</var> instance, issuing NextToken, <var>SkipTokens</var>,		<li>For a new <var>StringTokenizer</var> instance, issuing <var>NextToken</var>, <var>SkipTokens</var>,
	or [[FindToken (StringTokenizer function)\|FindToken]] is required before		or <var>[[FindToken (StringTokenizer function)\|FindToken]]</var> is required before
	[[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.		<var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var> may be issued without error.
	</ul>		</ul>

	==Examples==		==Examples==

Wiccan: 1 revision

2011-02-06T21:48:05Z

1 revision

← Older revision	Revision as of 21:48, 6 February 2011
(No difference)

Wiccan: 1 revision

2011-02-06T21:48:03Z

1 revision

← Older revision		Revision as of 21:48, 6 February 2011
Line 34:		Line 34:
	to the middle of the initial token in the tokenizer string.		to the middle of the initial token in the tokenizer string.

	begin		<p class="code">begin
	%tok is object stringTokenizer		%tok is object stringTokenizer
	%tok = new		%tok = new
	%tok:string = 'Here is the skipTokens example.'		%tok:string = 'Here is the skipTokens example.'
	[[Targeted Text statements\|printText]] {~} = '{%tok:string}'		[[Targeted Text statements\|printText]] {~} = '{%tok:string}'
	%tok:skipTokens(3)		%tok:skipTokens(3)
	printText {~} = {%tok:currentToken}		printText {~} = {%tok:currentToken}
	printText {~} = {%tok:nextPosition}		printText {~} = {%tok:nextPosition}
	%tok:nextPosition = 3		%tok:nextPosition = 3
	%tok:skipTokens(1)		%tok:skipTokens(1)
	printText {~} = {%tok:currentToken}		printText {~} = {%tok:currentToken}
	printText {~} = {%tok:nextPosition}		printText {~} = {%tok:nextPosition}
	%tok:skipTokens(4)		%tok:skipTokens(4)
	printText {~} = {%tok:currentToken}		printText {~} = {%tok:currentToken}
	end		end


			</p>
	The result is:		The result is:
	<~~pre~~>		<p class="output">%tok:string = 'Here is the skipTokens example.'
	%tok:string = 'Here is the skipTokens example.'		%tok:currentToken = the
	%tok:currentToken = the		%tok:nextPosition = 12
	%tok:nextPosition = 12		%tok:currentToken = re
	%tok:currentToken = re		%tok:nextPosition = 5
	%tok:nextPosition = 5		%tok:currentToken = example.
	%tok:currentToken = example.		%tok:nextPosition = 32
	%tok:nextPosition = 32		</p>
	</~~pre~~>
	==See also==		==See also==
	{{Template:StringTokenizer:SkipTokens footer}}		{{Template:StringTokenizer:SkipTokens footer}}

Wiccan: 1 revision

2011-02-06T21:47:22Z

1 revision

← Older revision	Revision as of 21:47, 6 February 2011
(No difference)

Wiccan: 1 revision

2011-02-06T21:47:18Z

1 revision

← Older revision		Revision as of 21:47, 6 February 2011
Line 12:		Line 12:
	the request is cancelled.		the request is cancelled.

	The SkipTokens subroutine is available as of version 7.7 of the ''Sirius Mods''.		The <var>SkipTokens</var> subroutine is available as of version 7.7 of the ''Sirius Mods''.
	==Syntax==		==Syntax==
	{{Template:StringTokenizer:SkipTokens syntax}}		{{Template:StringTokenizer:SkipTokens syntax}}
Line 18:		Line 18:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%tok</th>		<tr><th>%tok</th>
	<td>A StringTokenizer object variable. </td></tr>		<td>A <var>StringTokenizer</var> object variable. </td></tr>
	<tr><th>num</th>		<tr><th>num</th>
	<td>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.</td></tr>		<td>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.</td></tr>
Line 24:		Line 24:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>For a new StringTokenizer instance, issuing NextToken, SkipTokens,		<li>For a new <var>StringTokenizer</var> instance, issuing NextToken, <var>SkipTokens</var>,
	or [[FindToken (StringTokenizer function)\|FindToken]] is required before		or [[FindToken (StringTokenizer function)\|FindToken]] is required before
	[[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.		[[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.
Line 30:		Line 30:
	==Examples==		==Examples==

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

← Older revision		Revision as of 17:22, 15 February 2011
Line 3:		Line 3:
	This method moves the current token and tokenizing position forward in the		This method moves the current token and tokenizing position forward in the
	tokenizer string the number of tokens specified in the method argument.		tokenizer string the number of tokens specified in the method argument.
	Skipping one token is equivalent to executing [[NextToken (StringTokenizer function)\|NextToken]];		Skipping one token is equivalent to executing <var>[[NextToken (StringTokenizer function)\|NextToken]]</var>;
	skipping three tokens is equivalent to executing NextToken three times consecutively.		skipping three tokens is equivalent to executing NextToken three times consecutively.

	If a token is found after advancing the designated number of tokens, the		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		tokenizing position in the string is moved after the found token, and
	[[CurrentToken (StringTokenizer function)\|CurrentToken]] will return the found token.		<var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var> will return the found token.
	If the end of the string occurs before the specified number of tokens,		If the end of the string occurs before the specified number of tokens,
	the request is cancelled.		the request is cancelled.
Line 26:		Line 26:
	<li>For a new <var>StringTokenizer</var> instance, issuing <var>NextToken</var>, <var>SkipTokens</var>,		<li>For a new <var>StringTokenizer</var> instance, issuing <var>NextToken</var>, <var>SkipTokens</var>,
	or <var>[[FindToken (StringTokenizer function)\|FindToken]]</var> is required before		or <var>[[FindToken (StringTokenizer function)\|FindToken]]</var> is required before
	<var>[[CurrentToken ~~(StringTokenizer function)\|CurrentToken]]~~</var> may be issued without error.		<var>CurrentToken</var> may be issued without error.
	</ul>		</ul>