$RegexMatch - Revision history

Alex: /* Products authorizing {{PAGENAMEE}} */

2022-01-21T17:06:59Z

Products authorizing {{PAGENAMEE}}

← Older revision		Revision as of 17:06, 21 January 2022
Line 98:		Line 98:

	[[Category:$Functions\|$RegexMatch]]		[[Category:$Functions\|$RegexMatch]]
	[[Category:Regular ~~Expression Processing~~]]		[[Category:Regular expression processing]]

Alex at 16:56, 21 January 2022

2022-01-21T16:56:03Z

@@ Line 25: / Line 25: @@
 <tr><th>options</th>
 <td>An optional string of options. The options are single letters, which may be specified in uppercase or lowercase, in any combination, and separated by blanks or not separated. For more information about these options, see [[Regex processing#Common regex options|Common regex options]].
 </td></tr>
@@ Line 112: / Line 98: @@
 [[Category:$Functions|$RegexMatch]]

JAL: minor formatting

2018-08-07T19:51:53Z

minor formatting

← Older revision		Revision as of 19:51, 7 August 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Whether string matches regex</span>		<span class="pageSubtitle">Whether string matches regex</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$RegexMatch</var> function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>

	This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching. (Information about the rules observed is provided in [[Regex_processing#Regex_rules\|Regex rules]])~~. The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>~~.		This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching. (Information about the rules observed is provided in [[Regex_processing#Regex_rules\|Regex rules]]).

	<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.		<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.
Line 24:		Line 24:

	<tr><th>options</th>		<tr><th>options</th>
	<td>An optional string of options. The options are single letters, which may be specified in uppercase or lowercase, in any combination, and separated by blanks or not separated. For more information about these options, see [[Regex processing#Common regex options\|"Common regex options"]].		<td>An optional string of options. The options are single letters, which may be specified in uppercase or lowercase, in any combination, and separated by blanks or not separated. For more information about these options, see [[Regex processing#Common regex options\|Common regex options]].

	<table ~~class="syntaxTable"~~>		<table>
	<tr><th><var>I</var></th>		<tr><th><var>I</var></th>
	<td>Do case-insensitive matching between <var class="term">instr</var> and <var class="term">regex</var>.</td></tr>		<td>Do case-insensitive matching between <var class="term">instr</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 dot (<tt>.</tt>) can match any character, including carriage return and linefeed.</td></tr>		<td>Dot-All mode: a dot (<tt>.</tt>) 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 '''wherever''' 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 '''wherever''' 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 XML Schema regex rules. Each regex is implicitly anchored at the beginning and end, and no characters serve as anchors. For more information, see [[Regex processing#XML Schema mode\|"XML Schema mode"]].		<td>Do the match according to XML Schema regex rules. Each regex is implicitly anchored at the beginning and end, and no characters serve as anchors. For more information, see [[Regex processing#XML Schema mode\|XML Schema mode]].
	</td></tr></table>		</td></tr></table>
	</td></tr>		</td></tr>
Line 40:		Line 43:
	<tr><th>%status</th>		<tr><th>%status</th>
	<td>The fourth argument is optional; if specified, it is set to an integer status value. These values are possible:		<td>The fourth argument is optional; if specified, it is set to an integer status value. These values are possible:
	<table class="~~syntaxTable~~">		<table class="thJustBold">
	<tr><th>1</th>		<tr><th>1</th>
	<td>A successful match was obtained.</td></tr>		<td>A successful match was obtained.</td></tr>

	<tr><th>0</th>		<tr><th>0</th>
	<td>No match: ~~'''~~inStr~~'''~~ was not matched by ~~'''~~regex~~'''~~.</td></tr>		<td>No match: <var class="term">inStr</var> was not matched by <var class="term">regex</var>. </td></tr>
	<tr><th>-1<i>nnn</i></th>
	<td>The pattern in ~~'''~~regex~~'''~~ 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 regex results in a <var~~ class="~~term~~">~~%status</var> value of <tt>-1</tt>.~~		<tr><th>-1<i>nnn</i></th>'
	~~<p>~~		<td>The pattern in <var class="term">regex</var> is invalid. <var class="term">nnn</var>, 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.
	'''Note:''' If you omit this argument and a negative <var class="term">%status</var> value is to be returned, the run is cancelled. </p>		<p class="note"> '''Note:''' If you omit this argument and a negative <var class="term">%status</var> value is to be returned, the run is cancelled. </p></td></tr>
	</td></tr></table>		</table>
	</td></tr>		</td></tr>
	</table>		</table>
Line 55:		Line 59:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. For further discussion of this, see [[Regex processing#SOUL programming considerations\|SOUL programming considerations]].		<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. For further discussion of this, see [[Regex processing#SOUL programming considerations\|SOUL programming considerations]]. </li>

	<li><var>$RegexMatch</var> is considered <var>Longstring</var>-capable. Its string inputs and outputs are considered <var>[[Longstrings]]</var> for expression-compilation purposes, and they have standard <var>Longstring</var> truncation behavior: truncation by assignment results in request cancellation. For more information, see [[Longstrings#Longstrings and $functions\|"Longstrings and $functions"]].

	<li>If <var ~~class="term"~~>~~%rc~~</var> is ~~zero, either~~ <var ~~class="term"~~>~~regex~~</var> ~~did not match~~ <var ~~class="term"~~>~~inStr~~</var>, ~~or there was an error in the regex. The~~ <var ~~class="term"~~>~~%status~~</var> ~~argument returns 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><var>$RegexMatch</var> is considered <var>Longstring</var>-capable. Its string inputs and outputs are considered <var>[[Longstrings]]</var> for expression-compilation purposes, and they have standard <var>Longstring</var> truncation behavior: truncation by assignment results in request cancellation. For more information, see [[Longstrings#Longstrings and $functions\|Longstrings and $functions]]. </li>

	<li>~~For information about additional methods and $functions that support regular expressions~~, ~~see [[Regex processing\|~~"~~Regex processing~~"]].		<li>If <var class="term">%rc</var> is zero, either <var class="term">regex</var> did not match <var class="term">inStr</var>, or there was an error in the regex. The <var class="term">%status</var> argument returns 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>

	<li>~~<var>~~$~~RegexMatch~~</~~var~~> ~~is available as of Version 6.9.~~		<li>For information about additional methods and $functions that support regular expressions, see [[Regex processing]]. </li>
	</ul>		</ul>

Line 95:		Line 97:
	This regex demonstrates the following:		This regex demonstrates the following:
	<ul>		<ul>
	<li>To match a string, a regex pattern must merely "fit" a substring of the string.		<li>To match a string, a regex pattern must merely "fit" a substring of the string. </li>
	<li>Metacharacters, in this case star (<code>*</code>), must be escaped.
	<li>An optional character (<code>c?</code>) may fail to find a match, but this does not prevent the success of the overall match.		<li>Metacharacters, in this case star (<code>*</code>), must be escaped. </li>
	<li>The character class range (<code>[5-8]</code>) matches the <tt>6</tt> in the input string.
			<li>An optional character (<code>c?</code>) may fail to find a match, but this does not prevent the success of the overall match. </li>

			<li>The character class range (<code>[5-8]</code>) matches the <code>6</code> in the input string. </li>
	</ul>		</ul>

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[~~List of $functions\|~~Sirius ~~functions~~]]		<li>[[Sirius Functions]] </li>
	</ul>		</ul>

	~~<p>~~
	~~</p>~~


	[[Category:$Functions\|$RegexMatch]]		[[Category:$Functions\|$RegexMatch]]

ELowell at 15:51, 7 August 2018

2018-08-07T15:51:34Z

← Older revision		Revision as of 15:51, 7 August 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>

	This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (~~information~~ about the rules observed is provided in [[Regex_processing#Regex_rules\|~~regex~~ rules]] ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching. (Information about the rules observed is provided in [[Regex_processing#Regex_rules\|Regex rules]]). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.

	<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.		<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.

DCameron at 13:04, 7 August 2018

2018-08-07T13:04:04Z

← Older revision		Revision as of 13:04, 7 August 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>

	This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in [[Regex_processing#Regex_rules\|regex rules]] ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.

	<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.		<var>$RegexMatch</var> accepts two required and two optional arguments, and it returns a numeric value. It is also callable. Specifying an invalid argument results in request cancellation.

JAL: link repair

2016-05-11T22:37:50Z

link repair

← Older revision		Revision as of 22:37, 11 May 2016
Line 55:		Line 55:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. For further discussion of this, see [[Regex processing#~~User Language~~ programming considerations\|~~"User Language~~ programming considerations"]].		<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <code>UTABLE LPDLST 3000</code> and <code>UTABLE LSTBL 9000</code>. For further discussion of this, see [[Regex processing#SOUL programming considerations\|SOUL programming considerations]].

	<li><var>$RegexMatch</var> is considered <var>Longstring</var>-capable. Its string inputs and outputs are considered <var>[[Longstrings]]</var> for expression-compilation purposes, and they have standard <var>Longstring</var> truncation behavior: truncation by assignment results in request cancellation. For more information, see [[Longstrings#Longstrings and $functions\|"Longstrings and $functions"]].		<li><var>$RegexMatch</var> is considered <var>Longstring</var>-capable. Its string inputs and outputs are considered <var>[[Longstrings]]</var> for expression-compilation purposes, and they have standard <var>Longstring</var> truncation behavior: truncation by assignment results in request cancellation. For more information, see [[Longstrings#Longstrings and $functions\|"Longstrings and $functions"]].

JALWiccan: Automatically generated page update

2014-08-01T22:08:18Z

Automatically generated page update

← Older revision		Revision as of 22:08, 1 August 2014
Line 103:		Line 103:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius functions]]		<li>[[List of $functions\|Sirius functions]]
	</ul>		</ul>

JAL at 18:55, 19 July 2013

2013-07-19T18:55:17Z

← Older revision		Revision as of 18:55, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Whether string matches regex</span>		<span class="pageSubtitle">Whether string matches regex</span>

	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the [[RegexMatch (String function)]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the <var>[[RegexMatch (String function)\|RegexMatch]]</var> <var>String</var> function.</p>

	This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.

JALWiccan: Automatically generated page update

2013-07-19T18:49:16Z

Automatically generated page update

← Older revision		Revision as of 18:49, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Whether string matches regex</span>		<span class="pageSubtitle">Whether string matches regex</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the [[RegexMatch (String function)]].</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexMatch function is the [[RegexMatch (String function)]].</p>

	This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function determines whether a given pattern (regular expression, or "regex") matches within a given string according to the "rules" of regular expression matching (information about the rules observed is provided in ). The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.

JALWiccan: Automatically generated page update

2013-04-10T18:17:29Z

Automatically generated page update

← Older revision		Revision as of 18:17, 10 April 2013
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"~~><section begin="syntax" /~~>[%rc =] $RegexMatch(inStr, regex, [options], [%status])		<p class="syntax">[%rc =] $RegexMatch(inStr, regex, [options], [%status])
	~~<section end="syntax" />~~</p>		</p>

	===Syntax terms===		===Syntax terms===