RegexSubset (Stringlist function) - Revision history

Alex at 22:18, 21 January 2022

2022-01-21T22:18:15Z

@@ Line 17: / Line 17: @@
 <tr><th><var>Options</var></th>
-<td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options|"Common regex options"]].
+<td>This is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options|Common regex options]].
 </td></tr>
 <tr><th><var>Status</var></th>
@@ Line 108: / Line 95: @@
 ==See also==
 {{Template:Stringlist:RegexSubset footer}}

JAL: link repair

2016-05-11T22:40:09Z

link repair

← Older revision		Revision as of 22:40, 11 May 2016
Line 62:		Line 62:
	<li>All errors in <var>RegexSubset</var>, including invalid argument(s) result in request cancellation.		<li>All errors in <var>RegexSubset</var>, including invalid argument(s) result in request cancellation.

	<li>It is strongly recommended that you protect your environment from regular expression processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. See [[~~Regex_processing~~#~~User_Language_programming_considerations~~\|~~"User Language~~ programming considerations"]].		<li>It is strongly recommended that you protect your environment from regular expression processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. See [[Regex processing#SOUL programming considerations\|SOUL programming considerations]].

	<li>The regex matching is limited to the first 6124 bytes of each item, but a matched item is copied in its entirety to the output subset.<li>Prior to copying matched items to <var class="term">%subsetList</var>, any preexisting contents of that <var>Stringlist</var> are deleted.		<li>The regex matching is limited to the first 6124 bytes of each item, but a matched item is copied in its entirety to the output subset.<li>Prior to copying matched items to <var class="term">%subsetList</var>, any preexisting contents of that <var>Stringlist</var> are deleted.

JAL at 21:12, 31 October 2012

2012-10-31T21:12:08Z

← Older revision		Revision as of 21:12, 31 October 2012
Line 1:		Line 1:
	{{Template:Stringlist:RegexSubset subtitle}}		{{Template:Stringlist:RegexSubset subtitle}}
	<p>This method returns a <var>Stringlist</var> that is a subset of the method <var>Stringlist</var>. The subset contains copies of all the items in the method <var>Stringlist</var> that are matched by a specified regex. Information about the regular expression matching rules observed is provided in ~~<var>~~[[Regex_processing#Regex_rules\|"Regex processing rules"]]~~</var>.</p><p><var>RegexSubset</var> accepts one required and four optional arguments, and it returns a <var>Stringlist</var>~~.</p>		<p>This method returns a <var>Stringlist</var> that is a subset of the method <var>Stringlist</var>. The subset contains copies of all the items in the method <var>Stringlist</var> that are matched by a specified regex. Information about the regular expression matching rules observed is provided in [[Regex_processing#Regex_rules\|"Regex processing rules"]].</p>

	==Syntax==		==Syntax==
	{{Template:Stringlist:RegexSubset syntax}}		{{Template:Stringlist:RegexSubset syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%subsetList</th>		<tr><th>%subsetList</th>
	<td>A <var>Stringlist</var> that contains the <var class="term">sl</var> items matched by <var class="term">regex</var>.</td></tr>		<td>A <var>Stringlist</var> that contains the <var class="term">sl</var> items matched by <var class="term">regex</var>.</td></tr>

	<tr><th>sl</th>		<tr><th>sl</th>
	<td>A <var>Stringlist</var> object.</td></tr>		<td>A <var>Stringlist</var> object.</td></tr>

	<tr><th>regex</th>		<tr><th>regex</th>
	<td>A string that is interpreted as a regular expression and is applied to the <var class="term">sl</var> method <var>Stringlist</var> items to determine whether the <var class="term">regex</var> finds a match.</td></tr>		<td>A string that is interpreted as a regular expression and is applied to the <var class="term">sl</var> method <var>Stringlist</var> items to determine whether the <var class="term">regex</var> finds a match.</td></tr>

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options\|"Common regex options"]].		<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options\|"Common regex options"]].

	<table class="syntaxNested">		<table class="syntaxNested">
	<tr><th><var>I</var></th>		<tr><th><var>I</var></th>
	<td>Do case-insensitive matching between <var class="term">string</var> and <var class="term">regex</var>.</td></tr>		<td>Do case-insensitive matching between <var class="term">string</var> and <var class="term">regex</var>.</td></tr>

	<tr><th><var>S</var></th>		<tr><th><var>S</var></th>
	<td>Dot-All mode: a period (<code>.</code>) can match any character, including carriage return and linefeed.</td></tr>		<td>Dot-All mode: a period (<code>.</code>) can match any character, including carriage return and linefeed.</td></tr>

	<tr><th><var>M</var></th>		<tr><th><var>M</var></th>
	<td>Multi-line mode: let anchor characters match end-of-line indicators <b><i>wherever</i></b> the indicator appears in the input string. <var>M</var> mode is ignored if <var>C</var> (XML Schema) mode is specified.</td></tr>		<td>Multi-line mode: let anchor characters match end-of-line indicators <b><i>wherever</i></b> the indicator appears in the input string. <var>M</var> mode is ignored if <var>C</var> (XML Schema) mode is specified.</td></tr>

	<tr><th><var>C</var></th>		<tr><th><var>C</var></th>
	<td>Do the match according to [[Regex_processing#XML_Schema_mode\|"XML Schema regex rules"]]. Each <var class="term">regex</var> is implicitly anchored at the beginning and end, and no characters serve as anchors.</td></tr>		<td>Do the match according to [[Regex_processing#XML_Schema_mode\|"XML Schema regex rules"]]. Each <var class="term">regex</var> is implicitly anchored at the beginning and end, and no characters serve as anchors.</td></tr>
	</table></td></tr>		</table></td></tr>

	<tr><th><var>Status</var></th>		<tr><th><var>Status</var></th>
	<td>The <var>Status</var> argument (name required) is optional; if specified, it is set to an integer code. These values are possible:		<td>The <var>Status</var> argument (name required) is optional; if specified, it is set to an integer code. These values are possible:

	<table class="syntaxNested">		<table class="syntaxNested">
	<tr><th>n</th>		<tr><th>n</th>
	<td>The number of <var class="term">sl</var> items that are matched.</td></tr>		<td>The number of <var class="term">sl</var> items that are matched.</td></tr>

	<tr><th><var>0</var></th>		<tr><th><var>0</var></th>
	<td>No match: no items in <var class="term">sl</var> were matched by <var class="term">regex</var>.</td></tr>		<td>No match: no items in <var class="term">sl</var> were matched by <var class="term">regex</var>.</td></tr>

	<tr><th><var>-2</var></th>		<tr><th><var>-2</var></th>
	<td>Invalid <var>StartCol</var> or <var>EndCol</var> argument value.</td></tr>		<td>Invalid <var>StartCol</var> or <var>EndCol</var> argument value.</td></tr>

	<tr><th><var>-1</var>nnn</th>		<tr><th><var>-1</var>nnn</th>
	<td>The pattern in <var class="term">regex</var> is invalid. <i>nnn</i> (the absolute value of the return minus 1000) gives the 1-based position of the character being scanned when the error was discovered. The value for an error occurring at end-of-string is the length of the string + 1. Prior to <var class="product">Sirius Mods</var> Version 7.0, an invalid <var class="term">regex</var> results in a <var>Status</var> value of <code>-1</code>.</td></tr>		<td>The pattern in <var class="term">regex</var> is invalid. <i>nnn</i> (the absolute value of the return minus 1000) gives the 1-based position of the character being scanned when the error was discovered. The value for an error occurring at end-of-string is the length of the string + 1. Prior to <var class="product">Sirius Mods</var> Version 7.0, an invalid <var class="term">regex</var> results in a <var>Status</var> value of <code>-1</code>.</td></tr>
	</table>		</table>
	If you omit this argument and a negative Status value is to be returned, the run is cancelled.</td></tr>		If you omit this argument and a negative Status value is to be returned, the run is cancelled.</td></tr>

	<tr><th><var>StartCol</var></th>		<tr><th><var>StartCol</var></th>
	<td>The <var>StartCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the starting column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1 and less than or equal to the <var>EndCol</var> argument value. If the argument is omitted, its default value is 1. If you specify a <var class="term">number</var> value that is greater than the length of a particular <var class="term">sl</var> item, the <var class="term">regex</var> is matched against the empty string for that item.</td>		<td>The <var>StartCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the starting column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1 and less than or equal to the <var>EndCol</var> argument value. If the argument is omitted, its default value is 1. If you specify a <var class="term">number</var> value that is greater than the length of a particular <var class="term">sl</var> item, the <var class="term">regex</var> is matched against the empty string for that item.</td>

	<tr><th><var>EndCol</var></th>		<tr><th><var>EndCol</var></th>
	<td>The <var>EndCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the ending column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1, and greater than or equal to the <var>StartCol</var> argument value, and less than or equal to the lesser of 6124 or the length of <var class="term">sl</var> item. If the <var>EndCol</var> argument is omitted, its default value is 6124.<p>If the <var>EndCol</var> argument is omitted and a <var class="term">sl</var> item exceeds 6124 bytes, the request is cancelled.</p></td>		<td>The <var>EndCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the ending column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1, and greater than or equal to the <var>StartCol</var> argument value, and less than or equal to the lesser of 6124 or the length of <var class="term">sl</var> item. If the <var>EndCol</var> argument is omitted, its default value is 6124.<p>If the <var>EndCol</var> argument is omitted and a <var class="term">sl</var> item exceeds 6124 bytes, the request is cancelled.</p></td>
Line 44:		Line 59:

	==Usage notes==		==Usage notes==
	<ul><li>All errors in <var>RegexSubset</var>, including invalid argument(s) result in request cancellation.		<ul>
			<li>All errors in <var>RegexSubset</var>, including invalid argument(s) result in request cancellation.

	<li>It is strongly recommended that you protect your environment from regular expression processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. See [[Regex_processing#User_Language_programming_considerations\|"User Language programming considerations"]].		<li>It is strongly recommended that you protect your environment from regular expression processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. See [[Regex_processing#User_Language_programming_considerations\|"User Language programming considerations"]].

	<li>The regex matching is limited to the first 6124 bytes of each item, but a matched item is copied in its entirety to the output subset.<li>Prior to copying matched items to <var class="term">%subsetList</var>, any preexisting contents of that <var>Stringlist</var> are deleted.		<li>The regex matching is limited to the first 6124 bytes of each item, but a matched item is copied in its entirety to the output subset.<li>Prior to copying matched items to <var class="term">%subsetList</var>, any preexisting contents of that <var>Stringlist</var> are deleted.

	<li>For information about additional methods and $functions that support regular expressions, see [[Regex_processing\|"Regex Processing"]].		<li>For information about additional methods and $functions that support regular expressions, see [[Regex_processing\|"Regex Processing"]].
	<li><var>RegexSubset</var> is available as of <var class="product">[[Sirius Mods~~\|"sirius Mods"]]~~</var> Version 6.9.</ul>
			<li><var>RegexSubset</var> is available as of <var class="product">Sirius Mods</var> Version 6.9.
			</ul>

	==Examples==		==Examples==
	~~<ol><li>~~In the following code fragment, <var>RegexSubset</var> is applied to the method <var>Stringlist</var> <code>%sl</code> to find the <code>%sl</code> items that are matched by the regex <code>%$[a-z]*$</code>. The regex is designed to find items that contain shared methods whose class names contain only upper and lowercase letters.		In the following code fragment, <var>RegexSubset</var> is applied to the method <var>Stringlist</var> <code>%sl</code> to find the <code>%sl</code> items that are matched by the regex <code>%$[a-z]*$</code>. The regex is designed to find items that contain shared methods whose class names contain only upper and lowercase letters.

	<p class="code">...		<p class="code">...
Line 83:		Line 104:
	Matching item 1 is: %(daemon):getInputObject(%doc)		Matching item 1 is: %(daemon):getInputObject(%doc)
	Matching item 2 is: %(daemon):returnObject(%doc)		Matching item 2 is: %(daemon):returnObject(%doc)
	</p~~></ol~~>		</p>

	==See also==		==See also==
	{{Template:Stringlist:RegexSubset footer}}		{{Template:Stringlist:RegexSubset footer}}

JALWiccan: 1 revision

2012-06-10T22:34:08Z

1 revision

← Older revision	Revision as of 22:34, 10 June 2012
(No difference)

JALWiccan: 1 revision

2012-06-10T22:34:07Z

1 revision

← Older revision		Revision as of 22:34, 10 June 2012
Line 13:		Line 13:
	<td>A string that is interpreted as a regular expression and is applied to the <var class="term">sl</var> method <var>Stringlist</var> items to determine whether the <var class="term">regex</var> finds a match.</td></tr>		<td>A string that is interpreted as a regular expression and is applied to the <var class="term">sl</var> method <var>Stringlist</var> items to determine whether the <var class="term">regex</var> finds a match.</td></tr>
	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>This is an optional, ~~but~~ [[Notation conventions for methods#Named parameters\|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options\|"Common regex options"]].		<td>This is an optional, [[Notation conventions for methods#Named parameters\|name required]], parameter supplying a string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not as you prefer. For more information about these options, see [[Regex_processing#Common_regex_options\|"Common regex options"]].
	<table class="syntaxNested">		<table class="syntaxNested">
	<tr><th><var>I</var></th>		<tr><th><var>I</var></th>

JALWiccan: 1 revision

2011-04-14T19:42:48Z

1 revision

← Older revision	Revision as of 19:42, 14 April 2011
(No difference)

JALWiccan: 1 revision

2011-04-14T19:42:47Z

1 revision

← Older revision		Revision as of 19:42, 14 April 2011
Line 37:		Line 37:
	</table>		</table>
	If you omit this argument and a negative Status value is to be returned, the run is cancelled.</td></tr>		If you omit this argument and a negative Status value is to be returned, the run is cancelled.</td></tr>
	<tr><th><b>StartCol</b></th>		<tr><th><var>StartCol</var></th>
	<td>The <var>StartCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the starting column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1 and less than or equal to the <var>EndCol</var> argument value. If the argument is omitted, its default value is 1. If you specify a <var class="term">number</var> value that is greater than the length of a particular <var class="term">sl</var> item, the <var class="term">regex</var> is matched against the empty string for that item.</td>		<td>The <var>StartCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the starting column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1 and less than or equal to the <var>EndCol</var> argument value. If the argument is omitted, its default value is 1. If you specify a <var class="term">number</var> value that is greater than the length of a particular <var class="term">sl</var> item, the <var class="term">regex</var> is matched against the empty string for that item.</td>
	<tr><th><b>EndCol</b></th>		<tr><th><var>EndCol</var></th>
	<td>The <var>EndCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the ending column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1, and greater than or equal to the <var>StartCol</var> argument value, and less than or equal to the lesser of 6124 or the length of <var class="term">sl</var> item. If the <var>EndCol</var> argument is omitted, its default value is 6124.<p>If the <var>EndCol</var> argument is omitted and a <var class="term">sl</var> item exceeds 6124 bytes, the request is cancelled.</p></td>		<td>The <var>EndCol</var> argument (name required) is an optional <var class="term">number</var> that specifies the ending column of the range of columns in which the matched string must be located. If specified, <var class="term">number</var> must be greater than or equal to 1, and greater than or equal to the <var>StartCol</var> argument value, and less than or equal to the lesser of 6124 or the length of <var class="term">sl</var> item. If the <var>EndCol</var> argument is omitted, its default value is 6124.<p>If the <var>EndCol</var> argument is omitted and a <var class="term">sl</var> item exceeds 6124 bytes, the request is cancelled.</p></td>
	</table>		</table>

JALWiccan: 1 revision

2011-04-14T19:33:23Z

1 revision

← Older revision	Revision as of 19:33, 14 April 2011
(No difference)

Tom at 19:33, 14 April 2011

2011-04-14T19:33:22Z

← Older revision		Revision as of 19:33, 14 April 2011
Line 24:		Line 24:
	<td>Do the match according to [[Regex_processing#XML_Schema_mode\|"XML Schema regex rules"]]. Each <var class="term">regex</var> is implicitly anchored at the beginning and end, and no characters serve as anchors.</td></tr>		<td>Do the match according to [[Regex_processing#XML_Schema_mode\|"XML Schema regex rules"]]. Each <var class="term">regex</var> is implicitly anchored at the beginning and end, and no characters serve as anchors.</td></tr>
	</table></td></tr>		</table></td></tr>
	<tr><th>Status</th>		<tr><th><var>Status</var></th>
	<td>The <var>Status</var> argument (name required) is optional; if specified, it is set to an integer code. These values are possible:		<td>The <var>Status</var> argument (name required) is optional; if specified, it is set to an integer code. These values are possible:
	<table class="syntaxNested">		<table class="syntaxNested">

Tom at 16:58, 14 April 2011

2011-04-14T16:58:30Z

← Older revision		Revision as of 16:58, 14 April 2011
Line 29:		Line 29:
	<tr><th>n</th>		<tr><th>n</th>
	<td>The number of <var class="term">sl</var> items that are matched.</td></tr>		<td>The number of <var class="term">sl</var> items that are matched.</td></tr>
	<tr><th>0</th>		<tr><th><var>0</var></th>
	<td>No match: no items in <var class="term">sl</var> were matched by <var class="term">regex</var>.</td></tr>		<td>No match: no items in <var class="term">sl</var> were matched by <var class="term">regex</var>.</td></tr>
	<tr><th>-2</th>		<tr><th><var>-2</var></th>
	<td>Invalid <var>StartCol</var> or <var>EndCol</var> argument value.</td></tr>		<td>Invalid <var>StartCol</var> or <var>EndCol</var> argument value.</td></tr>
	<tr><th>-~~1nnn~~</th>		<tr><th><var>-1</var>nnn</th>
	<td>The pattern in <var class="term">regex</var> is invalid. <i>nnn</i> (the absolute value of the return minus 1000) gives the 1-based position of the character being scanned when the error was discovered. The value for an error occurring at end-of-string is the length of the string + 1. Prior to <var class="product">Sirius Mods</var> Version 7.0, an invalid <var class="term">regex</var> results in a <var>Status</var> value of <code>-1</code>.</td></tr>		<td>The pattern in <var class="term">regex</var> is invalid. <i>nnn</i> (the absolute value of the return minus 1000) gives the 1-based position of the character being scanned when the error was discovered. The value for an error occurring at end-of-string is the length of the string + 1. Prior to <var class="product">Sirius Mods</var> Version 7.0, an invalid <var class="term">regex</var> results in a <var>Status</var> value of <code>-1</code>.</td></tr>
	</table>		</table>