RegexCapture (Stringlist function) - Revision history

Alex at 22:17, 21 January 2022

2022-01-21T22:17:18Z

← Older revision		Revision as of 22:17, 21 January 2022
Line 23:		Line 23:

	<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]].
	</td></tr>		</td></tr>

Alex at 22:12, 21 January 2022

2022-01-21T22:12:50Z

@@ Line 24: / Line 24: @@
 <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"]].
-<table class="syntaxNested">
+</td></tr>
 <tr><th><var>Status</var></th>
@@ Line 158: / Line 145: @@
 ==See also==
 {{Template:Stringlist:RegexCapture footer}}

JAL: link repair

2016-05-11T22:44:49Z

link repair

← Older revision		Revision as of 22:44, 11 May 2016
Line 59:		Line 59:
	<li>All errors in <var>RegexCapture</var>, including invalid argument(s) result in request cancellation.		<li>All errors in <var>RegexCapture</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>If <var class="term">%rc</var> is 0, either <var class="term">regex</var> did not match <var class="term">string</var>, or there was an error in the regex. See the <var>Status</var> argument for additional information: If it is negative, it indicates an error. If it is zero, it indicates there was no error, but the regex did not match.		<li>If <var class="term">%rc</var> is 0, either <var class="term">regex</var> did not match <var class="term">string</var>, or there was an error in the regex. See the <var>Status</var> argument for additional information: If it is negative, it indicates an error. If it is zero, it indicates there was no error, but the regex did not match.
Line 67:		Line 67:
	<li>It is indistinguishable whether an empty item in the output <var>Stringlist</var> represents a capturing group in the regex that was applied but matched no characters, or represents a capturing group that was not applied for some reason (for example, an earlier alternative made the match).		<li>It is indistinguishable whether an empty item in the output <var>Stringlist</var> represents a capturing group in the regex that was applied but matched no characters, or represents a capturing group that was not applied for some reason (for example, an earlier alternative made the match).

	<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]].
			</ul>
	~~<li><var>RegexCapture</var> is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 6.9.~~</ul>

	==Examples==		==Examples==

Glw: /* Syntax terms */

2016-03-16T10:36:05Z

Syntax terms

← Older revision		Revision as of 10:36, 16 March 2016
Line 52:		Line 52:
	<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 Version 7.0 of the <var class="product">Sirius Mods</var>, an invalid <var class="term">regex</var> results in a Status 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 Version 7.0 of the <var class="product">Sirius Mods</var>, an invalid <var class="term">regex</var> results in a Status value of <code>-1</code>. </td></tr>
	</table>		</table>
	<b>Note:</b> If you omit this argument and a negative status value is to be returned, the ~~run~~ is cancelled.</td></tr>		<b>Note:</b> If you omit this argument and a negative status value is to be returned, the request is cancelled.</td></tr>
	</table>		</table>

Dme: /* Examples */

2012-11-11T05:11:31Z

Examples

← Older revision		Revision as of 05:11, 11 November 2012
Line 75:		Line 75:
	In the following code fragment, the <var class="term">regex</var>, which has three groups, matches the <var class="term">string</var>. Two items are added to the method <var>Stringlist</var>, only one of which is non-null:		In the following code fragment, the <var class="term">regex</var>, which has three groups, matches the <var class="term">string</var>. Two items are added to the method <var>Stringlist</var>, only one of which is non-null:

	<p class="code">		<p class="code">...
	...
	%sl = new		%sl = new
	%regex = 'a(b)(?:c)(d?)'		%regex = 'a(b)(?:c)(d?)'

Dme at 05:11, 11 November 2012

2012-11-11T05:11:05Z

← Older revision		Revision as of 05:11, 11 November 2012
Line 75:		Line 75:
	In the following code fragment, the <var class="term">regex</var>, which has three groups, matches the <var class="term">string</var>. Two items are added to the method <var>Stringlist</var>, only one of which is non-null:		In the following code fragment, the <var class="term">regex</var>, which has three groups, matches the <var class="term">string</var>. Two items are added to the method <var>Stringlist</var>, only one of which is non-null:

	<p class="code"> ...		<p class="code">
			...
	%sl = new		%sl = new
	%regex = 'a(b)(?:c)(d?)'		%regex = 'a(b)(?:c)(d?)'
Line 106:		Line 107:
	The order of the capturing groups is determined by the order of the open parenthesis corresponding to the capturing group in the regular expression. So, if the above example is changed to the following:		The order of the capturing groups is determined by the order of the open parenthesis corresponding to the capturing group in the regular expression. So, if the above example is changed to the following:

	<p class="code"> ...		<p class="code">...
	%sl = new		%sl = new
	%regex = '(a(b)(?:c)(d?))'		%regex = '(a(b)(?:c)(d?))'
Line 123:		Line 124:
	This results because a new capturing group that contained the entire <var class="term">regex</var> from the previous example was added. Since there are no extra match conditions in this group, the <var class="term">string</var> still matches in exactly the same way, but all the matching parts are now part of this group. Since this outermost group's left-most parenthesis comes before the others, its matching string is first on the <var>Stringlist</var>.		This results because a new capturing group that contained the entire <var class="term">regex</var> from the previous example was added. Since there are no extra match conditions in this group, the <var class="term">string</var> still matches in exactly the same way, but all the matching parts are now part of this group. Since this outermost group's left-most parenthesis comes before the others, its matching string is first on the <var>Stringlist</var>.
	<li>If a capturing group matches more than one set of characters, all the matched characters are output onto the <var>Stringlist</var> item corresponding with that group. For example, if this is the <var class="term">regex</var> and input string:		<li>If a capturing group matches more than one set of characters, all the matched characters are output onto the <var>Stringlist</var> item corresponding with that group. For example, if this is the <var class="term">regex</var> and input string:
	<p class="code"> ...		<p class="code">...
	%sl = new		%sl = new
	%regex = '(.(.))+'		%regex = '(.(.))+'

JAL at 19:50, 31 October 2012

2012-10-31T19:50:19Z

Show changes

JALWiccan: 1 revision

2012-10-30T22:02:47Z

1 revision

← Older revision	Revision as of 22:02, 30 October 2012
(No difference)

JAL2 at 22:02, 30 October 2012

2012-10-30T22:02:32Z

← Older revision		Revision as of 22:02, 30 October 2012
Line 119:		Line 119:
	This results because the regular expression <code>(.(.))+</code> matches any number of pairs of characters (the dot "." matches any character), each pair being associated with the capturing group <code>(.(.))</code> formed by the outer parentheses. Every other character is also in the capturing group <code>(.)</code> formed by the inner parentheses. The matches are concatenated on to the <var>Stringlist</var> item associated with the capturing group, so all pairs of characters (and so all characters) are concatenated on to the first <var>Stringlist</var> item, and every other character is concatenated on to the second <var>Stringlist</var> item.		This results because the regular expression <code>(.(.))+</code> matches any number of pairs of characters (the dot "." matches any character), each pair being associated with the capturing group <code>(.(.))</code> formed by the outer parentheses. Every other character is also in the capturing group <code>(.)</code> formed by the inner parentheses. The matches are concatenated on to the <var>Stringlist</var> item associated with the capturing group, so all pairs of characters (and so all characters) are concatenated on to the first <var>Stringlist</var> item, and every other character is concatenated on to the second <var>Stringlist</var> item.

	This concatenation is somewhat different from Perl -- Perl outputs only the <b><i>last</i></b> match for each capturing group, In this example, Perl would set <code>$1</code> (corresponding to <var>Stringlist</var> item 1) to <code>yz</code> and <code>$2</code> to <code>z</code>.		This concatenation is somewhat different from Perl — Perl outputs only the <b><i>last</i></b> match for each capturing group, In this example, Perl would set <code>$1</code> (corresponding to <var>Stringlist</var> item 1) to <code>yz</code> and <code>$2</code> to <code>z</code>.

	<LI>On a match, <var>RegexCapture</var> returns the position after the matching string, making it easy to split the <var class="term">string</var> at the point of the match. For example, the following statements:		<LI>On a match, <var>RegexCapture</var> returns the position after the matching string, making it easy to split the <var class="term">string</var> at the point of the match. For example, the following statements:

JAL2 at 19:26, 12 June 2012

2012-06-12T19:26:22Z

← Older revision		Revision as of 19:26, 12 June 2012
Line 3:		Line 3:
	This method applies a regular expression, or "regex," to a given input string, obtains those characters in the string that match the "capturing groups" in the regex, and appends these captured strings to the method <var>Stringlist</var>.		This method applies a regular expression, or "regex," to a given input string, obtains those characters in the string that match the "capturing groups" in the regex, and appends these captured strings to the method <var>Stringlist</var>.

	Within a regex, characters enclosed by a pair of unescaped parentheses form a "subexpression". A subexpression is a capturing group if the opening parenthesis is <b><i>not</i></b> followed by a question mark (<code>?</code>). Each set of characters matched (captured) by a <var>RegexCapture</var> capturing group is appended to the method object <var>Stringlist</var> as a separate item. <var>RegexCapture</var> uses the rules of regular expression matching (information about which is provided in ~~<var>~~[[Regex_processing#Regex_rules\|"Regex processing rules"]]~~</var>~~). <var>RegexCapture</var> accepts two required and two optional arguments and, optionally, returns a numeric value. <var>RegexCapture</var> is a callable method.		Within a regex, characters enclosed by a pair of unescaped parentheses form a "subexpression". A subexpression is a capturing group if the opening parenthesis is <b><i>not</i></b> followed by a question mark (<code>?</code>). Each set of characters matched (captured) by a <var>RegexCapture</var> capturing group is appended to the method object <var>Stringlist</var> as a separate item. <var>RegexCapture</var> uses the rules of regular expression matching (information about which is provided in [[Regex_processing#Regex_rules\|"Regex processing rules"]]). <var>RegexCapture</var> accepts two required and two optional arguments and, optionally, returns a numeric value. <var>RegexCapture</var> is a callable method.

	==Syntax==		==Syntax==