$RegexReplace - Revision history

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

2022-01-21T17:06:32Z

Products authorizing {{PAGENAMEE}}

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

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

Alex at 17:00, 21 January 2022

2022-01-21T17:00:35Z

@@ Line 49: / Line 49: @@
 <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]].
+<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>
+</td></tr>
 <tr><th>%status</th>
@@ Line 162: / Line 144: @@
 [[Category:$Functions|$RegexReplace]]

JAL: misc formatting

2018-08-07T20:08:02Z

misc formatting

Show changes

ELowell at 23:06, 11 November 2014

2014-11-11T23:06:09Z

← Older revision		Revision as of 23:06, 11 November 2014
Line 29:		Line 29:
	Except when the <tt>A</tt> option is specified (as described below for the <var class="term">options</var> argument), you can include markers in the <var class="term">replacement</var> value to indicate where to insert corresponding captured strings — strings matched by capturing groups (parenthesized subexpressions) in <var class="term">regex</var>, if any.		Except when the <tt>A</tt> option is specified (as described below for the <var class="term">options</var> argument), you can include markers in the <var class="term">replacement</var> value to indicate where to insert corresponding captured strings — strings matched by capturing groups (parenthesized subexpressions) in <var class="term">regex</var>, if any.

	As in Perl, these markers are in the form <code>$n</code>, where ''n'' is the number of the capture group, and 1 is the number of the first capture group. ''n'' must not be 0 or contain more than 9 digits.		As in Perl, these markers are in the form <code>$n</code>, where <i>n</i> is the number of the capture group, and 1 is the number of the first capture group. <i>n</i> must not be 0 or contain more than 9 digits.

	If a capturing group makes no matches (is positional, for example), or if there was no ~~'''~~n~~'''~~th capture group corresponding to the <tt>$n</tt> marker in a replacement string, the value of <tt>$n</tt> used in the replacement string is the empty string.		If a capturing group makes no matches (is positional, for example), or if there was no <i>n</i>th capture group corresponding to the <tt>$n</tt> marker in a replacement string, the value of <tt>$n</tt> used in the replacement string is the empty string.

	<code>xxx$1</code> is an example of a valid replacement string, and <code>$0yyy</code> is an example of a ~~'''~~non~~'''~~-valid one.		<code>xxx$1</code> is an example of a valid replacement string, and <code>$0yyy</code> is an example of a <strong>non-valid</strong> one.
	Or you can use the format <code>$mn</code>, where ''m'' is one of the following modifiers:		Or you can use the format <code>$mn</code>, where <i>m</i> is one of the following modifiers:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>U</var> or <var class="camel">u</var></th>		<tr><th><var>U</var> or <var class="camel">u</var></th>
Line 58:		Line 58:

	<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 <strong>wherever</strong> 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>
Line 67:		Line 67:

	<tr><th><var>A</var></th>		<tr><th><var>A</var></th>
	<td>Copy the <var class="term">replacement</var> string as is. Do not recognize escapes; interpret a <code>$n</code> combination as a literal and ~~'''~~not~~'''~~ as a special marker; and so on.</td></tr>		<td>Copy the <var class="term">replacement</var> string as is. Do not recognize escapes; interpret a <code>$n</code> combination as a literal and <strong>not</strong> as a special marker; and so on.</td></tr>
	</table></td></tr>		</table></td></tr>

Line 87:		Line 87:
	</table>		</table>

	~~'''~~Note:~~'''~~ If you omit this argument and a negative <var class="term">%status</var> value is to be returned, the run is cancelled.</td></tr>		<p class="note"><b>Note:</b> 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>
	</table>		</table>

Line 95:		Line 95:
	<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <tt>UTABLE LPDLST 3000</tt> and <tt>UTABLE LSTBL 9000</tt>. For further discussion of this,		<li>It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, <tt>UTABLE LPDLST 3000</tt> and <tt>UTABLE LSTBL 9000</tt>. For further discussion of this,
	<li>$RegexReplace is Longstring-capable. Its string inputs and outputs are considered Longstrings for expression-compilation purposes, and they have standard Longstring truncation behavior: truncation by assignment results in request cancellation. For more information,		<li>$RegexReplace is Longstring-capable. Its string inputs and outputs are considered Longstrings for expression-compilation purposes, and they have standard Longstring truncation behavior: truncation by assignment results in request cancellation. For more information,
	<li>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 ~~'''~~not~~'''~~ followed by a question mark (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.		<li>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 <strong>not</strong> followed by a question mark (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.
	<li>In Perl, <tt>$n</tt> markers (<tt>$1</tt>, for example) enclosed in single quotes are treated as literals instead of as "that which was captured by the first capturing parentheses." <var>$RegexReplace</var> uses the <tt>A</tt> option of the Option argument for this purpose.		<li>In Perl, <tt>$n</tt> markers (<tt>$1</tt>, for example) enclosed in single quotes are treated as literals instead of as "that which was captured by the first capturing parentheses." <var>$RegexReplace</var> uses the <tt>A</tt> option of the Option argument for this purpose.
	<li>A regex may "succeed" but match no characters. For example, a quantifier like <tt>?</tt> is allowed by definition to match no characters, though it tries to match one. <var>$RegexReplace</var> honors such a zero-length match by substituting the specified replacement string at the current position. If the global option is in effect, the regex is then applied again one position to the right in the input string, and again, until the end of the string. The regex <tt>9?</tt> globally applied to the string <tt>abc</tt> with a comma-comma (<tt>,,</tt>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.		<li>A regex may "succeed" but match no characters. For example, a quantifier like <tt>?</tt> is allowed by definition to match no characters, though it tries to match one. <var>$RegexReplace</var> honors such a zero-length match by substituting the specified replacement string at the current position. If the global option is in effect, the regex is then applied again one position to the right in the input string, and again, until the end of the string. The regex <tt>9?</tt> globally applied to the string <tt>abc</tt> with a comma-comma (<tt>,,</tt>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.
Line 128:		Line 128:

	==Examples==		==Examples==
	In the following example, the regex <code>(5.)</code> is applied repeatedly (global option) to the string <code>5A5B5C5D5E</code> to replace the uppercase letters with their lowercase counterparts. The <tt>$L1</tt> ~~'''~~%~~relacement'''~~ value makes the replacement string equal to whatever is matched by the capturing group, <tt>(5.)</tt>, in the regex (the <tt>L</tt> causes the lowercase versions of the captured letters to be used).		In the following example, the regex <code>(5.)</code> is applied repeatedly (global option) to the string <code>5A5B5C5D5E</code> to replace the uppercase letters with their lowercase counterparts. The <tt>$L1</tt> <strong>%replacement</strong> value makes the replacement string equal to whatever is matched by the capturing group, <tt>(5.)</tt>, in the regex (the <tt>L</tt> causes the lowercase versions of the captured letters to be used).

	<p class="code"> Begin		<p class="code"> Begin

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 158:		Line 158:
	==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:56, 19 July 2013

2013-07-19T18:56:35Z

← Older revision		Revision as of 18:56, 19 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Replace matching strings</span>		<span class="pageSubtitle">Replace matching strings</span>

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

	This function searches a given string for matches of a regular expression, and it replaces found matches with or according to a specified replacement string. The function stops after the first match and replace, or it can continue searching and replacing until no more matches are found. The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function searches a given string for matches of a regular expression, and it replaces found matches with or according to a specified replacement string. The function stops after the first match and replace, or it can continue searching and replacing until no more matches are found. 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">Replace matching strings</span>		<span class="pageSubtitle">Replace matching strings</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexReplace function is the [[RegexReplace (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 $RegexReplace function is the [[RegexReplace (String function)]].</p>

	This function searches a given string for matches of a regular expression, and it replaces found matches with or according to a specified replacement string. The function stops after the first match and replace, or it can continue searching and replacing until no more matches are found. The function is available as of Version 6.9 of the <var class="product">[[Sirius Mods]]</var>.		This function searches a given string for matches of a regular expression, and it replaces found matches with or according to a specified replacement string. The function stops after the first match and replace, or it can continue searching and replacing until no more matches are found. 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 11:		Line 11:

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

	===Syntax terms===		===Syntax terms===
Line 44:		Line 44:

	The only characters you can escape in a replacement string are dollar sign (<tt>$</tt>), backslash (<tt>\</tt>), and the digits <tt>0</tt> through <tt>9</tt>. So only these escapes are respected:		The only characters you can escape in a replacement string are dollar sign (<tt>$</tt>), backslash (<tt>\</tt>), and the digits <tt>0</tt> through <tt>9</tt>. So only these escapes are respected:
	<tt>.\\</tt>, <tt>\$</tt>, and <tt>\0</tt> through <tt>\9</tt>. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like <tt>\d</tt> — and an "unaccompanied" backslash (<tt>\</tt>) is an error.		<tt>.\\</tt>, <tt>\$</tt>, and <tt>\0</tt> through <tt>\9</tt>. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like <tt>\d</tt> — and an "unaccompanied" backslash (<tt>\</tt>) is an error.

	For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use <tt>1$1\2</tt> to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string. </td></tr>		For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use <tt>1$1\2</tt> to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string. </td></tr>

DmeWiccan: 1 revision

2012-11-07T21:32:55Z

1 revision

← Older revision	Revision as of 21:32, 7 November 2012
(No difference)

JAL: /* Syntax */

2012-11-07T21:32:39Z

Syntax

← Older revision		Revision as of 21:32, 7 November 2012
Line 156:		Line 156:
	The non-capturing regex <tt>5.</tt> matches and replaces the same substrings as the capturing group <tt>(5.)</tt>, but <tt>(5.)</tt> is used above to take advantage of the self-referring marker for the replacement string, <tt>$L1</tt>, which is valid only for capturing groups.		The non-capturing regex <tt>5.</tt> matches and replaces the same substrings as the capturing group <tt>(5.)</tt>, but <tt>(5.)</tt> is used above to take advantage of the self-referring marker for the replacement string, <tt>$L1</tt>, which is valid only for capturing groups.

	~~<h2>~~Products authorizing {{PAGENAMEE}}~~</h2>~~<ul class="smallAndTightList">		==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
	<li>[[Sirius functions]]		<li>[[Sirius functions]]
	</ul>		</ul>