Locate and LocateUp (Regex function) - Revision history

Alex at 21:07, 24 March 2022

2022-03-24T21:07:52Z

← Older revision		Revision as of 21:07, 24 March 2022
Line 15:		Line 15:
	<td>The item number at which to start searching. If 0 (the default), searching begins from the first item for <var>Locate</var> and the last item for <var>LocateUp</var>. Otherwise, <var>startItem</var> must be a number from 1 to the number of items in the <var>Stringlist</var>, inclusive.</td></tr>		<td>The item number at which to start searching. If 0 (the default), searching begins from the first item for <var>Locate</var> and the last item for <var>LocateUp</var>. Otherwise, <var>startItem</var> must be a number from 1 to the number of items in the <var>Stringlist</var>, inclusive.</td></tr>
	<tr><th><var>StartCol</var></th>		<tr><th><var>StartCol</var></th>
	<td~~>number<br/~~>The ~~first~~ column to ~~include in~~ the ~~attempted~~ match. The default value is 1.</td></tr>		<td>The starting column number (position in stringlist items) to which to limit the match. The default value of this argument is 1. This value must be greater than or equal to 1 and less than or equal to 6124.</td></tr>
	<tr><th><var>EndCol</var></th>		<tr><th><var>EndCol</var></th>
	<td~~>number<br/~~>The ~~last~~ column to ~~include in~~ the ~~attempted~~ match. ~~The~~ default value is ~~effectively~~ the value ~~of the [MaxItemLength (Stringlist property)\|Stringlist MaxItemLength property]~~.</td></tr>		<td>The ending column number (position in stringlist items) to which to limit the match. There is no default value of this argument so essentially matching is done to the end of each item. This value must be greater than or equal to <var>StartCol</var> and less than or equal to 6124.</td></tr>
	</table>		</table>

Line 24:		Line 24:
	<li>These functions have identical functionality to the ][RegexLocate and RegexLocateUp (Stringlist functions)\|Stringlist RegexLocate and RegexLocateUp]] functions.</li>		<li>These functions have identical functionality to the ][RegexLocate and RegexLocateUp (Stringlist functions)\|Stringlist RegexLocate and RegexLocateUp]] functions.</li>
	<li>Invalid values for parameters (such as start column greater than end column) result in request cancellation.</li>		<li>Invalid values for parameters (such as start column greater than end column) result in request cancellation.</li>
			<li>If <var>EndCol</var> was not specified and a <var>Stringlist</var> item longer than 6124 bytes is encountered, the request is canceled.</li>
	</ul>		</ul>
	==Examples==		==Examples==

Alex at 15:04, 24 March 2022

2022-03-24T15:04:05Z

← Older revision		Revision as of 15:04, 24 March 2022
Line 1:		Line 1:
	{{Template:Regex:Locate subtitle}}		{{Template:Regex:Locate subtitle}}

	These functions search a [[Stringlist_class\|Stringlist]] for an item that matches the regular expression in the <var>Regex</var> object. <var>Locate</var> searches forward (low to high item number) in the <var>Stringlist</var> while <var>LocateUp</var> searches backward.		These functions search a [[Stringlist_class\|Stringlist]] for an item that matches the regular expression in the <var>Regex</var> object. <var>Locate</var> searches forward (low to high item number) in the <var>Stringlist</var> while <var>LocateUp</var> searches backward. These provide similary functionality to [[RegexLocate and RegexLocateUp (Stringlist functions)\|RegexLocate and RegexLocateUp]].
	==Syntax==		==Syntax==
	{{Template:Regex:Locate syntax}}		{{Template:Regex:Locate syntax}}

Alex: /* Syntax terms */

2022-03-24T14:54:11Z

Syntax terms

← Older revision		Revision as of 14:54, 24 March 2022
Line 10:		Line 10:
	<tr><th>regex</th>		<tr><th>regex</th>
	<td>The <var>Regex</var> object</td></tr>		<td>The <var>Regex</var> object</td></tr>
	<tr><th>~~stringlist~~</th>		<tr><th>sl</th>
	<td>The <var>Stringlist</var> to be searched</td></tr>		<td>The <var>Stringlist</var> to be searched</td></tr>
	<tr><th>startItem</th>		<tr><th>startItem</th>
Line 19:		Line 19:
	<td>number<br/>The last column to include in the attempted match. The default value is effectively the value of the [MaxItemLength (Stringlist property)\|Stringlist MaxItemLength property].</td></tr>		<td>number<br/>The last column to include in the attempted match. The default value is effectively the value of the [MaxItemLength (Stringlist property)\|Stringlist MaxItemLength property].</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>

Alex at 14:57, 19 March 2022

2022-03-19T14:57:05Z

← Older revision		Revision as of 14:57, 19 March 2022
Line 1:		Line 1:
	{{Template:Regex:Locate subtitle}}		{{Template:Regex:Locate subtitle}}

	These functions search a [Stringlist_class\|Stringlist] for an item that matches the regular expression in the <var>Regex</var> object. <var>Locate</var> searches forward (low to high item number) in the <var>Stringlist</var> while <var>LocateUp</var> searches backward.		These functions search a [[Stringlist_class\|Stringlist]] for an item that matches the regular expression in the <var>Regex</var> object. <var>Locate</var> searches forward (low to high item number) in the <var>Stringlist</var> while <var>LocateUp</var> searches backward.
	==Syntax==		==Syntax==
	{{Template:Regex:Locate syntax}}		{{Template:Regex:Locate syntax}}

Alex at 02:00, 14 March 2022

2022-03-14T02:00:17Z

← Older revision		Revision as of 02:00, 14 March 2022
Line 1:		Line 1:
	{{Template:Regex:Locate subtitle}}		{{Template:Regex:Locate subtitle}}

	~~This page is~~ [~~[under construction]~~].		These functions search a [Stringlist_class\|Stringlist] for an item that matches the regular expression in the <var>Regex</var> object. <var>Locate</var> searches forward (low to high item number) in the <var>Stringlist</var> while <var>LocateUp</var> searches backward.
	==Syntax==		==Syntax==
	{{Template:Regex:Locate syntax}}		{{Template:Regex:Locate syntax}}
			{{Template:Regex:LocateUp syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%itemNum</th><td>number</td></tr>		<tr><th>%itemNum</th><td>The first matching item number. If no items match, 0 (zero) is returned.</td></tr>
	<tr><th>regex</th>		<tr><th>regex</th>
	<td><var>Regex</var> object</td></tr>		<td>The <var>Regex</var> object</td></tr>
	<tr><th>stringlist</th>		<tr><th>stringlist</th>
	<td><var>Stringlist</var> ~~object~~</td></tr>		<td>The <var>Stringlist</var> to be searched</td></tr>
	<tr><th>startItem</th>		<tr><th>startItem</th>
	<td>number<br/>~~The default value~~ of ~~this argument is [[??]]~~.</td></tr>		<td>The item number at which to start searching. If 0 (the default), searching begins from the first item for <var>Locate</var> and the last item for <var>LocateUp</var>. Otherwise, <var>startItem</var> must be a number from 1 to the number of items in the <var>Stringlist</var>, inclusive.</td></tr>
	<tr><th><var>StartCol</var></th>		<tr><th><var>StartCol</var></th>
	<td>number<br/>The default value ~~of this argument~~ is ~~[[??]]~~.</td></tr>		<td>number<br/>The first column to include in the attempted match. The default value is 1.</td></tr>
	<tr><th><var>EndCol</var></th>		<tr><th><var>EndCol</var></th>
	<td>number<br/>The default value of ~~this argument is [~~[~~??]~~].</td></tr>		<td>number<br/>The last column to include in the attempted match. The default value is effectively the value of the [MaxItemLength (Stringlist property)\|Stringlist MaxItemLength property].</td></tr>
	</table>		</table>
	==Usage notes==		==Usage notes==
			<ul>
			<li>These functions have identical functionality to the ][RegexLocate and RegexLocateUp (Stringlist functions)\|Stringlist RegexLocate and RegexLocateUp]] functions.</li>
			<li>Invalid values for parameters (such as start column greater than end column) result in request cancellation.</li>
			</ul>
	==Examples==		==Examples==
			The following example removes all items that match regular expression <code>"(foo\|fu)bar"</code> (case insensitive) from a <var>Stringlist</var>:
			<p class="code">%num is float
			%regex is object regex
			%sl is object stringlist
			...
			%regex = new("(fu\|foo)bar", options="i")
			%num = 1
			repeat while %num le %sl:count
			%num = %regex:locate(%sl, %num)
			if %num eq 0 then loop end; end if
			%sl:removeItem(%num)
			end repeat
			</p>
	==See also==		==See also==
	{{Template:Regex:Locate footer}}		{{Template:Regex:Locate footer}}
			[[Category:Regular expression processing]]

Alex: Alex moved page Locate (Regex function) to Locate and LocateUp (Regex function)

2022-03-13T22:46:08Z

Alex moved page Locate (Regex function) to Locate and LocateUp (Regex function)

← Older revision	Revision as of 22:46, 13 March 2022
(No difference)

Wiccan: Automatically generated page update

2022-03-13T22:37:06Z

Automatically generated page update

New page

{{Template:Regex:Locate subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Regex:Locate syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%itemNum</th><td>number</td></tr>
<tr><th>regex</th>
<td><var>Regex</var> object</td></tr>
<tr><th>stringlist</th>
<td><var>Stringlist</var> object</td></tr>
<tr><th>startItem</th>
<td>number<br/>The default value of this argument is [[??]].</td></tr>
<tr><th><var>StartCol</var></th>
<td>number<br/>The default value of this argument is [[??]].</td></tr>
<tr><th><var>EndCol</var></th>
<td>number<br/>The default value of this argument is [[??]].</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Regex:Locate footer}}