UnicodePositionIn and UnicodePositionOf (Unicode functions) - Revision history

JAL at 17:28, 6 November 2012

2012-11-06T17:28:53Z

← Older revision		Revision as of 17:28, 6 November 2012
Line 6:		Line 6:
	{{Template:Unicode:UnicodePositionIn syntax}}		{{Template:Unicode:UnicodePositionIn syntax}}
	{{Template:Unicode:UnicodePositionOf syntax}}		{{Template:Unicode:UnicodePositionOf 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 character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in the "haystack," <var class="term">%position</var> is set to 0. Whether the method object or the first argument is the "needle" or "haystack" depends on the method that is called.</td></tr>		<td>A variable to receive the character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in the "haystack," <var class="term">%position</var> is set to 0. Whether the method object or the first argument is the "needle" or "haystack" depends on the method that is called.</td></tr>

	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>The method object <var>Unicode</var> string; either:		<td>The method object <var>Unicode</var> string; either:
	<ul><li>the search target "needle," when called as <var>UnicodePositionIn</var>		<ul>
	<li>the search space "haystack," when called as <var>UnicodePositionOf</var></ul></td></tr>		<li>the search target "needle," when called as <var>UnicodePositionIn</var>
			<li>the search space "haystack," when called as <var>UnicodePositionOf</var>
			</ul></td></tr>

	<tr><th>haystack</th>		<tr><th>haystack</th>
	<td>In <var>UnicodePositionIn</var>, the search space <var>Unicode</var> string within which to look for the <var class="term">unicode</var> method object (the "needle").</td></tr>		<td>In <var>UnicodePositionIn</var>, the search space <var>Unicode</var> string within which to look for the <var class="term">unicode</var> method object (the "needle").</td></tr>

	<tr><th>needle</th>		<tr><th>needle</th>
	<td>In <var>UnicodePositionOf</var>, the search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</td></tr>		<td>In <var>UnicodePositionOf</var>, the search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</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 character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>		<td>An optional, [[Notation conventions for methods#Named parameters\|name required]], number specifying the character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>
	</table>		</table>

Line 25:		Line 32:
	<ul>		<ul>
	<li>The <var>Start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var>Start</var> position greater than the length of the "haystack" plus one, minus the length of <var class="term">needle</var> returns a zero, because there are not enough characters in the "haystack" to satisfy the search criteria.		<li>The <var>Start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var>Start</var> position greater than the length of the "haystack" plus one, minus the length of <var class="term">needle</var> returns a zero, because there are not enough characters in the "haystack" to satisfy the search criteria.
	<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.5.		<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">Sirius Mods</var> Version 7.5.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>		<ol>
			<li>
	The following fragment contains three calls to <var>UnicodePositionOf</var>:		The following fragment contains three calls to <var>UnicodePositionOf</var>:
	<p class="code">%s is unicode initial('This is a test')		<p class="code">%s is unicode initial('This is a test')
Line 41:		Line 49:
	0		0
	</p>		</p>

	<li>The following fragment contains three calls to <var>UnicodePositionIn</var>:		<li>The following fragment contains three calls to <var>UnicodePositionIn</var>:
	<p class="code">%s is unicode initial('spl')		<p class="code">%s is unicode initial('spl')
Line 53:		Line 62:
	0		0
	</p>		</p>

	<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.		<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.
	<p class="code">%u is unicode initial('Model 204&~~amp;amp;~~amp;#x2122;':[[U (String_function)\|U]])		<p class="code">%u is unicode initial('Model 204&#x2122;':[[U (String_function)\|U]])
	%posTM = %u:PositionOf('&~~amp;amp;~~amp;#x2122;':U)		%posTM = %u:PositionOf('&#x2122;':U)
	print %posTM		print %posTM
	</p>		</p>
Line 61:		Line 71:
	<p class="code">%pos is float		<p class="code">%pos is float
	%pos = %u:[[UnicodeUntranslatablePosition (Unicode function)\|UnicodeUntranslatablePosition]]		%pos = %u:[[UnicodeUntranslatablePosition (Unicode function)\|UnicodeUntranslatablePosition]]
	printtext {~} is: -		printtext {~} is: {%u:[[UnicodeChar (Unicode function)\|unicodeChar]](%pos):[[UnicodeToUtf16 (Unicode function)\|unicodeToUtf16]]:[[StringToHex (String function)\|stringToHex]]}
	{%u:[[UnicodeChar (Unicode function)\|unicodeChar]](%pos):[[UnicodeToUtf16 (Unicode function)\|unicodeToUtf16]]:[[StringToHex (String function)\|stringToHex]]}
	</p>		</p>

Line 71:		Line 80:

	==See also==		==See also==
	<ul><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are analogous to the <var>[[PositionIn and PositionOf (String functions)\|PositionIn]]</var> and <var>[[PositionIn and PositionOf (String functions)\|PositionOf]]</var> <var>String</var> methods.</ul>		<ul>
			<var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are analogous to the <var>[[PositionIn and PositionOf (String functions)\|PositionIn]]</var> and <var>[[PositionIn and PositionOf (String functions)\|PositionOf]]</var> <var>String</var> methods.
			</ul>

	{{Template:Unicode:UnicodePositionIn and UnicodePositionOf footer}}		{{Template:Unicode:UnicodePositionIn and UnicodePositionOf footer}}

JALWiccan: 1 revision

2011-05-04T17:46:36Z

1 revision

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

JAL2 at 17:46, 4 May 2011

2011-05-04T17:46:35Z

← Older revision		Revision as of 17:46, 4 May 2011
Line 25:		Line 25:
	<ul>		<ul>
	<li>The <var>Start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var>Start</var> position greater than the length of the "haystack" plus one, minus the length of <var class="term">needle</var> returns a zero, because there are not enough characters in the "haystack" to satisfy the search criteria.		<li>The <var>Start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var>Start</var> position greater than the length of the "haystack" plus one, minus the length of <var class="term">needle</var> returns a zero, because there are not enough characters in the "haystack" to satisfy the search criteria.
	<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.		<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Line 54:		Line 54:
	</p>		</p>
	<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.		<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.
	<p class="code">%u is unicode initial('Model 204&amp;#x2122;':[[U (String_function)\|U]])		<p class="code">%u is unicode initial('Model 204&amp;amp;#x2122;':[[U (String_function)\|U]])
	%posTM = %u:PositionOf('&amp;#x2122;':U)		%posTM = %u:PositionOf('&amp;amp;#x2122;':U)
	print %posTM		print %posTM
	</p>		</p>

JAL2 at 18:24, 27 April 2011

2011-04-27T18:24:29Z

New page

{{Template:Unicode:UnicodePositionIn and UnicodePositionOf subtitle}}

The <var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> functions return the numeric position of the first occurrence of one character string (the "needle") inside another ("the haystack"). The search respects character case. The difference between the two methods is that for <var>UnicodePositionIn</var>, the method object string is the "needle" and the first argument is the "haystack," whereas for <var>UnicodePositionOf</var>, the first argument string is the "needle" and the method object string is the "haystack." Which method is more convenient to use will be application dependent.

==Syntax==
{{Template:Unicode:UnicodePositionIn syntax}}
{{Template:Unicode:UnicodePositionOf syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%position</th>
<td>A variable to receive the character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in the "haystack," <var class="term">%position</var> is set to 0. Whether the method object or the first argument is the "needle" or "haystack" depends on the method that is called.</td></tr>
<tr><th>unicode</th>
<td>The method object <var>Unicode</var> string; either:
<ul><li>the search target "needle," when called as <var>UnicodePositionIn</var>
<li>the search space "haystack," when called as <var>UnicodePositionOf</var></ul></td></tr>
<tr><th>haystack</th>
<td>In <var>UnicodePositionIn</var>, the search space <var>Unicode</var> string within which to look for the <var class="term">unicode</var> method object (the "needle").</td></tr>
<tr><th>needle</th>
<td>In <var>UnicodePositionOf</var>, the search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</td></tr>
<tr><th><var>Start</var></th>
<td>An optional, but <var>[[Methods#Named parameters|NameRequired]]</var>, number specifying the character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>
</table>

==Usage notes==
<ul>
<li>The <var>Start</var> position must be a positive number. A zero or negative number results in request cancellation. Specifying a <var>Start</var> position greater than the length of the "haystack" plus one, minus the length of <var class="term">needle</var> returns a zero, because there are not enough characters in the "haystack" to satisfy the search criteria.
<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 7.5.
</ul>

==Examples==
<ol><li>
The following fragment contains three calls to <var>UnicodePositionOf</var>:
%s is unicode initial('This is a test')
[[PrintText statement|printText]] {%s:unicodePositionOf('is')}
printText {%s:unicodePositionOf('is', start=4)}
printText {%s:unicodePositionOf('is', start=7)}

The result is:
3
6
0

<li>The following fragment contains three calls to <var>UnicodePositionIn</var>:
%s is unicode initial('spl')
printText {%s:unicodePositionIn('splish splash')}
printText {%s:unicodePositionIn('splish splash', start=4)}
printText {%s:unicodePositionIn('splish splash', start=9)}


The result is:
1
8
0

<li>The following sequence, which uses the [[U (String function)|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.
%u is unicode initial('Model 204&amp;#x2122;':[[U (String_function)|U]])
%posTM = %u:PositionOf('&amp;#x2122;':U)
print %posTM

However, given <code>%u</code> as defined above, here is an alternative solution that uses other [[Intrinsic classes|intrinsic]] methods to return the hex value of the trademark character:
%pos is float
%pos = %u:[[UnicodeUntranslatablePosition (Unicode function)|UnicodeUntranslatablePosition]]
printtext {~} is: -
{%u:[[UnicodeChar (Unicode function)|unicodeChar]](%pos):[[UnicodeToUtf16 (Unicode function)|unicodeToUtf16]]:[[StringToHex (String function)|stringToHex]]}


The result is:
%u:unicodeChar(%pos):unicodeToUtf16:stringToHex is: 2122

</ol>

==See also==
<ul><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are analogous to the <var>[[PositionIn and PositionOf (String functions)|PositionIn]]</var> and <var>[[PositionIn and PositionOf (String functions)|PositionOf]]</var> <var>String</var> methods.</ul>
{{Template:Unicode:UnicodePositionIn and UnicodePositionOf footer}}

JALWiccan: 1 revision

2011-04-13T00:55:36Z

1 revision

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

Goff: see also. Sirius Mods

2011-04-13T00:55:35Z

Goff: see also. Sirius Mods

2011-03-14T00:19:51Z

JAL: /* Syntax terms */

2011-03-09T02:58:39Z

Syntax terms

← Older revision		Revision as of 02:58, 9 March 2011
Line 9:		Line 9:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%position</th>		<tr><th>%position</th>
	<td>A variable to receive the character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in "haystack", <var class="term">%position</var> is set to 0. </td></tr>		<td>A variable to receive the character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in the "haystack," <var class="term">%position</var> is set to 0. Whether the method object or the first argument is the "needle" or "haystack" depends on the method that is called.</td></tr>
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>The method object <var>Unicode</var> string; either:		<td>The method object <var>Unicode</var> string; either:

JAL at 02:47, 9 March 2011

2011-03-09T02:47:15Z

← Older revision		Revision as of 02:47, 9 March 2011
Line 9:		Line 9:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%position</th>		<tr><th>%position</th>
	<td>A variable to receive the character 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 character 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 character position of the first occurrence of the "needle" <var>Unicode</var> string in the "haystack" <var>Unicode</var> string, starting at the implicit or explicit starting character position. If the "needle" is not found in "haystack", <var class="term">%position</var> is set to 0. </td></tr>
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>The method object <var>Unicode</var> string; either:		<td>The method object <var>Unicode</var> string; either:

JAL at 02:44, 9 March 2011

2011-03-09T02:44:01Z

← Older revision		Revision as of 02:44, 9 March 2011
Line 19:		Line 19:
	<td>The search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</td></tr>		<td>The search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</td></tr>
	<tr><th>Start</th>		<tr><th>Start</th>
	<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the character position in the ~~search space <var class=~~"~~term~~"~~>haystack</var>~~ <var>Unicode</var> string at which to start searching for the ~~search target <var class=~~"~~term~~"~~>needle</var>~~ <var>Unicode</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 character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>
	</table>		</table>

← Older revision		Revision as of 00:55, 13 April 2011
Line 18:		Line 18:
	<tr><th>needle</th>		<tr><th>needle</th>
	<td>The search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</td></tr>		<td>The search target <var>Unicode</var> string to be searched for within the <var class="term">unicode</var> method object (the "haystack").</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 character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>		<td>An optional, but <var>[[Methods#Named parameters\|NameRequired]]</var>, number specifying the character position in the "haystack" <var>Unicode</var> string at which to start searching for the "needle" <var>Unicode</var> string. <var>Start</var> defaults to 1, meaning that the search begins at the first character in the "haystack."</td></tr>
	</table>		</table>
Line 56:		Line 56:
	</p>		</p>
	<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.		<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.
	<p class="code">%u is unicode initial('Model 204&#x2122;':[[U (String_function)\|U]])		<p class="code">%u is unicode initial('Model 204&amp;#x2122;':[[U (String_function)\|U]])
	%posTM = %u:PositionOf('&#x2122;':U)		%posTM = %u:PositionOf('&amp;#x2122;':U)
	print %posTM		print %posTM
	</p>		</p>

← Older revision		Revision as of 00:19, 14 March 2011
Line 27:		Line 27:
	<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> do exactly the same thing. The only difference between them is that in <var>UnicodePositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">unicode</var> and the <var class="term">needle</var> is the first argument. In <var>UnicodePositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">unicode</var> and the <var class="term">haystack</var> is the first argument.		<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> do exactly the same thing. The only difference between them is that in <var>UnicodePositionOf</var>, the <var class="term">haystack</var> is the method object <var class="term">unicode</var> and the <var class="term">needle</var> is the first argument. In <var>UnicodePositionIn</var>, these roles are reversed: the <var class="term">needle</var> is the method object <var class="term">unicode</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.		Which method is preferable will depend on the application, and, in many cases, it will be quite arbitrary which one is used.
	<li>~~Available as of <var class="product">[[Sirius Mods]]</var> Version 7.5,~~ <var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are ~~analogous to the~~ <var>[[~~PositionIn and PositionOf (String functions)~~\|~~PositionIn~~]]</var> ~~and <var>[[PositionIn and PositionOf (String functions)\|PositionOf]]</var> <var>String</var> methods~~.		<li><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.
	</ul>		</ul>

Line 56:		Line 56:
	</p>		</p>
	<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.		<li>The following sequence, which uses the [[U (String function)\|U function]] to specify the Unicode trademark character (U+2122), produces a conversion error. The second statement fails when the method attempts to implicitly convert the <var>Unicode</var> <var class="term">needle</var> character to EBCDIC. The Unicode trademark character has no valid translation to EBCDIC.
	<p class="code">%u is unicode initial('Model 204&#x2122;':U)		<p class="code">%u is unicode initial('Model 204&#x2122;':[[U (String_function)\|U]])
	%posTM = %u:PositionOf('&#x2122;':U)		%posTM = %u:PositionOf('&#x2122;':U)
	print %posTM		print %posTM
Line 73:		Line 73:

	==See also==		==See also==
			<ul><var>UnicodePositionIn</var> and <var>UnicodePositionOf</var> are analogous to the <var>[[PositionIn and PositionOf (String functions)\|PositionIn]]</var> and <var>[[PositionIn and PositionOf (String functions)\|PositionOf]]</var> <var>String</var> methods.</ul>
	{{Template:Unicode:UnicodePositionIn and UnicodePositionOf footer}}		{{Template:Unicode:UnicodePositionIn and UnicodePositionOf footer}}