PositionIn and PositionOf (String functions) - Revision history

Dme: /* Syntax terms */

2012-11-27T17:28:05Z

Syntax terms

← Older revision		Revision as of 17:28, 27 November 2012
Line 10:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%position</th>		<tr><th>%position</th>
	<td>A variable to receive the position of the first occurrence of the <var class="term">needle</var> string in the <var class="term">haystack</var> string, starting at the implicit or explicit starting position. If <var class="term">needle</var> is not found in <var class="term">haystack</var>, <var class="term">%position</var> is set to 0. </td></tr>		<td>A variable to receive the position of the first occurrence of the <var class="term">needle</var> string in the <var class="term">haystack</var> string, starting at the implicit or explicit starting position. If <var class="term">needle</var> is not found in <var class="term">haystack</var> or <var class="term">needle</var> is the null string, <var class="term">%position</var> is set to 0. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>

JAL at 21:49, 2 November 2012

2012-11-02T21:49:36Z

← Older revision		Revision as of 21:49, 2 November 2012
Line 6:		Line 6:
	{{Template:String:PositionIn syntax}}		{{Template:String:PositionIn syntax}}
	{{Template:String:PositionOf syntax}}		{{Template:String:PositionOf syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%position</th>		<tr><th>%position</th>
	<td>A variable to receive the position of the first occurrence of the <var class="term">needle</var> string in the <var class="term">haystack</var> string, starting at the implicit or explicit starting position. If <var class="term">needle</var> is not found in <var class="term">haystack</var>, <var class="term">%position</var> is set to 0. </td></tr>		<td>A variable to receive the position of the first occurrence of the <var class="term">needle</var> string in the <var class="term">haystack</var> string, starting at the implicit or explicit starting position. If <var class="term">needle</var> is not found in <var class="term">haystack</var>, <var class="term">%position</var> is set to 0. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>The method object string. Depending upon whether the <var>PositionIn</var> or <var>PositionOf</var> method is being used, <var class="term">string</var> may be either the:		<td>The method object string. Depending upon whether the <var>PositionIn</var> or <var>PositionOf</var> method is being used, <var class="term">string</var> may be either the:
	<ul><li>search target <var class="term">needle</var>, when called as <var>PositionIn</var>		<ul>
			<li>search target <var class="term">needle</var>, when called as <var>PositionIn</var>
	<li>the search space <var class="term">haystack</var>, when called as <var>PositionOf</var></ul></td></tr>		<li>the search space <var class="term">haystack</var>, when called as <var>PositionOf</var></ul></td></tr>

	<tr><th>haystack</th>		<tr><th>haystack</th>
	<td>The search space string in which the search target <var class="term">needle</var> is to be located.</td></tr>		<td>The search space string in which the search target <var class="term">needle</var> is to be located.</td></tr>

	<tr><th>needle</th>		<tr><th>needle</th>
	<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>		<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>

	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>An optional, but ~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>		<td>An optional, but [[Notation conventions for methods#Named parameters\|name required]], number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul><li>The <var class="term">start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var class="term">start</var> position greater than the length of (<var class="term">haystack</var> plus one minus the length of <var class="term">needle</var>) returns a zero, because there are not enough characters in <var class="term">haystack</var> to satisfy the search.		<ul>
			<li>The <var class="term">start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var class="term">start</var> position greater than the length of (<var class="term">haystack</var> plus one minus the length of <var class="term">needle</var>) returns a zero, because there are not enough characters in <var class="term">haystack</var> to satisfy the search.

	<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.		<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.
	<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the <var class="product">User Language</var> <var>$Index</var> function.
	<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">~~[[Sirius Mods\|~~Sirius Mods]]</var> Version 7.2.</ul>		<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the <var class="product">User Language</var> <var>[[$Index]]</var> function.

			<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">Sirius Mods</var> Version 7.2.</ul>

	==Examples==		==Examples==
	<ol><li>If <code>%s</code> contains <code>This is a test</code>, the following statements		<ol>
			<li>If <code>%s</code> contains <code>This is a test</code>, the following statements
	<p class="code">[[PrintText statement\|printText]] {%s:positionOf('is')}		<p class="code">[[PrintText statement\|printText]] {%s:positionOf('is')}
	printText {%s:positionOf('is', start=4)}		printText {%s:positionOf('is', start=4)}
Line 39:		Line 50:
	0		0
	</p>		</p>

	<li>If <code>%s</code> contains <code>ver</code>, the following statements		<li>If <code>%s</code> contains <code>ver</code>, the following statements
	<p class="code">printText {%s:positionIn('Never say never')}		<p class="code">printText {%s:positionIn('Never say never')}
Line 48:		Line 60:
	13		13
	0		0
	</p></ol>		</p>
			</ol>

	==See also==		==See also==
	{{Template:String:PositionIn and PositionOf footer}}		{{Template:String:PositionIn and PositionOf footer}}

JAL: /* Examples */

2012-10-10T20:50:33Z

Examples

← Older revision		Revision as of 20:50, 10 October 2012
Line 30:		Line 30:
	==Examples==		==Examples==
	<ol><li>If <code>%s</code> contains <code>This is a test</code>, the following statements		<ol><li>If <code>%s</code> contains <code>This is a test</code>, the following statements
	<p class="code"> [[PrintText statement\|printText]] {%s:positionOf('is')}		<p class="code">[[PrintText statement\|printText]] {%s:positionOf('is')}
	printText {%s:positionOf('is', start=4)}		printText {%s:positionOf('is', start=4)}
	printText {%s:positionOf('is', start=7)}		printText {%s:positionOf('is', start=7)}
	</p>		</p>
	will display		will display
	<p class="code"> 3		<p class="code"> 3
	6		6
	0		0
	</p>		</p>
	<li>If <code>%s</code> contains <code>ver</code>, the following statements		<li>If <code>%s</code> contains <code>ver</code>, the following statements
	<p class="code"> printText {%s:positionIn('Never say never')}		<p class="code">printText {%s:positionIn('Never say never')}
	printText {%s:positionIn('Never say never', start=4)}		printText {%s:positionIn('Never say never', start=4)}
	printText {%s:positionIn('Never say never', start=14)}		printText {%s:positionIn('Never say never', start=14)}
	</p>		</p>
	will display		will display
	<p class="code"> 3		<p class="code">3
	13		13
	0		0
	</p></ol>		</p></ol>

	==See also==		==See also==
	{{Template:String:PositionIn and PositionOf footer}}		{{Template:String:PositionIn and PositionOf footer}}

JAL: /* Usage notes */

2012-10-10T20:48:37Z

Usage notes

← Older revision		Revision as of 20:48, 10 October 2012
Line 25:		Line 25:
	<ul><li>The <var class="term">start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var class="term">start</var> position greater than the length of (<var class="term">haystack</var> plus one minus the length of <var class="term">needle</var>) returns a zero, because there are not enough characters in <var class="term">haystack</var> to satisfy the search.		<ul><li>The <var class="term">start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var class="term">start</var> position greater than the length of (<var class="term">haystack</var> plus one minus the length of <var class="term">needle</var>) returns a zero, because there are not enough characters in <var class="term">haystack</var> to satisfy the search.
	<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.		<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.
	<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the User Language $~~index~~ function.		<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the <var class="product">User Language</var> <var>$Index</var> function.
	<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2.</ul>		<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2.</ul>

JAL2 at 21:49, 7 August 2012

2012-08-07T21:49:04Z

← Older revision		Revision as of 21:49, 7 August 2012
Line 19:		Line 19:
	<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>		<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>
	<tr><th><var>Start</var></th>		<tr><th><var>Start</var></th>
	<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var ~~class="term"~~>Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>		<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-05-04T17:46:27Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T17:46:25Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 26:		Line 26:
	<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.		<li><var>PositionIn</var> / <var>PositionOf</var> do exactly the same thing. The only difference between them is that in <var>PositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">string</var> and the <var class="term">needle</var> is the first argument. In <var>PositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">string</var> and the <var class="term">haystack</var> is the first argument. Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.
	<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the User Language $index function.		<li><var>PositionIn</var> / <var>PositionOf</var> are the object-oriented equivalents of the User Language $index function.
	<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.2.</ul>		<li><var>PositionIn</var> / <var>PositionOf</var> are available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.2.</ul>

	==Examples==		==Examples==

JALWiccan: 1 revision

2011-04-13T00:21:18Z

1 revision

← Older revision	Revision as of 00:21, 13 April 2011
(No difference)

Dme: /* Syntax terms */

2011-04-13T00:21:16Z

Syntax terms

← Older revision		Revision as of 00:21, 13 April 2011
Line 18:		Line 18:
	<tr><th>needle</th>		<tr><th>needle</th>
	<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>		<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>
	<tr><th>Start</th>		<tr><th><var>Start</var></th>
	<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var class="term">Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>		<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var class="term">Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>
	</table>		</table>

Dme: /* Syntax terms */

2011-03-02T03:30:56Z

Syntax terms

← Older revision		Revision as of 03:30, 2 March 2011
Line 19:		Line 19:
	<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>		<td>The search target string to be located in the search space <var class="term">haystack</var> string.</td></tr>
	<tr><th>Start</th>		<tr><th>Start</th>
	<td>~~Is an~~ optional, but <var ~~class="term"~~>~~nameRequired~~</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var class="term">Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>		<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the position in the search space <var class="term">haystack</var> string at which to start searching for the search target <var class="term">needle</var> string. <var class="term">Start</var> defaults to 1, meaning that the search begins at the first character in <var class="term">haystack</var>.</td></tr>
	</table>		</table>