Replace (Regex function) - Revision history

Alex at 15:06, 24 March 2022

2022-03-24T15:06:24Z

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

	This function replaces the parts of a string that match the regular expression in the <var>Regex</var> object and returns the string with the replacements.		This function replaces the parts of a string that match the regular expression in the <var>Regex</var> object and returns the string with the replacements. This provides similar functionality to [[RegexReplace (String function)\|RegexReplace]] and [[UnicodeRegexReplace (Unicode function)\|UnicodeRegexReplace]].
	==Syntax==		==Syntax==
	{{Template:Regex:Replace syntax}}		{{Template:Regex:Replace syntax}}

Alex: /* Syntax terms */

2022-03-24T14:56:16Z

Syntax terms

← Older revision		Revision as of 14:56, 24 March 2022
Line 25:		Line 25:
	The only characters you can escape in a replacement string are dollar sign (<code>$</code>), backslash (<code>\</code>), and the digits <code>0</code> through <code>9</code>. So only these escapes are respected: <code>\\</code>, <code>\$</code>, and <code>\0</code> through <code>\9</code>. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like <code>\d</code> — and an "unaccompanied" backslash (<code>\</code>) is an error. For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use <code>1$1\2</code> to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string.		The only characters you can escape in a replacement string are dollar sign (<code>$</code>), backslash (<code>\</code>), and the digits <code>0</code> through <code>9</code>. So only these escapes are respected: <code>\\</code>, <code>\$</code>, and <code>\0</code> through <code>\9</code>. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like <code>\d</code> — and an "unaccompanied" backslash (<code>\</code>) is an error. For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use <code>1$1\2</code> to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string.
	<p>An invalid replacement string results in request cancellation.</p></td></tr>		<p>An invalid replacement string results in request cancellation.</p></td></tr>
	<tr><th><var>~~options~~</var></th>		<tr><th><var>Options</var></th>
	<td>		<td>
	A string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not. These options are a subset of [[Regex_processing#Common_regex_options\|Common regex options]]. The only acceptable options (case-independent) are <code>A</code> for "as-is", <code>G</code> for "global" (replace all occurrences), and <code>T</code> for trace.</td></tr>		A string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not. These options are a subset of [[Regex_processing#Common_regex_options\|Common regex options]]. The only acceptable options (case-independent) are <code>A</code> for "as-is", <code>G</code> for "global" (replace all occurrences), and <code>T</code> for trace.</td></tr>
	</table>		</table>

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

Alex at 23:15, 23 March 2022

2022-03-23T23:15:03Z

← Older revision		Revision as of 23:15, 23 March 2022
Line 26:		Line 26:
	<p>An invalid replacement string results in request cancellation.</p></td></tr>		<p>An invalid replacement string results in request cancellation.</p></td></tr>
	<tr><th><var>options</var></th>		<tr><th><var>options</var></th>
			<td>
	A string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not. These options are a subset of [[Regex_processing#Common_regex_options\|Common regex options]]. The only acceptable options (case-independent) are <code>A</code> for "as-is", <code>G</code> for "global" (replace all occurrences), and <code>T</code> for trace.</td></tr>		A string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not. These options are a subset of [[Regex_processing#Common_regex_options\|Common regex options]]. The only acceptable options (case-independent) are <code>A</code> for "as-is", <code>G</code> for "global" (replace all occurrences), and <code>T</code> for trace.</td></tr>
	</table>		</table>
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the regular ~~expresion~~ specified in the constructor call was Unicode, this method causes request cancellation. To test if a <var>Regex</var> object was created with a Unicode regular expression check the [[IsUnicode (Regex property)\|IsUnicode property]].</li>		<li>If the regular expression specified in the constructor call was Unicode, this method causes request cancellation. To test if a <var>Regex</var> object was created with a Unicode regular expression check the [[IsUnicode (Regex property)\|IsUnicode property]].</li>
	<li>There is no way to undo the <code>A</code>, <code>G</code>, and <code>T</code> options if they were specified on the constructor so if a <var>Regex</var> objects sometimes needs these options and sometimes not, they should be specified on each <var>Replace</var> call.</li>		<li>There is no way to undo the <code>A</code>, <code>G</code>, and <code>T</code> options if they were specified on the constructor so if a <var>Regex</var> objects sometimes needs these options and sometimes not, they should be specified on each <var>Replace</var> call.</li>
	</ul>		</ul>
	==Examples==		==Examples==
			For example:
			<p class="code">b
			%regex is object regex
			%regex = new("([A-Z]{3,})(\d{3,})", replace="$2-$1")
			print %regex:unicodeReplace("My license plate says EYE2020")
			print %regex:unicodeReplace("My license plate says EYE2020", "nothing")
			end
			</p>
			displays:
			<p class="code">My license plate says 2020-EYE
			My license plate says nothing
			</p>
	==See also==		==See also==
	{{Template:Regex:Replace footer}}		{{Template:Regex:Replace footer}}

	[[Category:Regular expression processing]]		[[Category:Regular expression processing]]

Alex at 21:11, 23 March 2022

2022-03-23T21:11:45Z

← Older revision		Revision as of 21:11, 23 March 2022
Line 12:		Line 12:
	<td>The string to test against the Regex object.</td></tr>		<td>The string to test against the Regex object.</td></tr>
	<tr><th>replacement</th>		<tr><th>replacement</th>
	<td>The string that replaces the substrings of <var class="term">string</var> that <var class="term">regex</var> matches. Except when the <code>A</code> option is specified (as described at [[Regex_processing#Common_regex_options\|Common regex options]]), 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 the ~~reular~~ expression, if any.		<td>The string that replaces the substrings of <var class="term">string</var> that <var class="term">regex</var> matches. Except when the <code>A</code> option is specified (as described at [[Regex_processing#Common_regex_options\|Common regex options]]), 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 the regular expression, if any.
	<p>		<p>
	These markers are in the form <var class="term">$n</var>, 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 there was no <i>n</i>th capture group corresponding to the <var class="term">$n</var> marker in a replacement string, the (literal) value of <var class="term">$n</var> is used in the replacement string instead of the empty string. <code>xxx$1</code> is an example of a valid replacement string, and <code>$0yyy</code> is an example of an invalid one. Or you can use the format <var class="term">$mn</var>, where <i>m</i> is one of the following modifiers:		These markers are in the form <var class="term">$n</var>, 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 there was no <i>n</i>th capture group corresponding to the <var class="term">$n</var> marker in a replacement string, the (literal) value of <var class="term">$n</var> is used in the replacement string instead of the empty string. <code>xxx$1</code> is an example of a valid replacement string, and <code>$0yyy</code> is an example of an invalid one. Or you can use the format <var class="term">$mn</var>, where <i>m</i> is one of the following modifiers:

Alex at 20:48, 23 March 2022

2022-03-23T20:48:57Z

← Older revision		Revision as of 20:48, 23 March 2022
Line 1:		Line 1:
	{{Template:Regex:Replace subtitle}}		{{Template:Regex:Replace subtitle}}

	This ~~page is [[under construction]]~~.		This function replaces the parts of a string that match the regular expression in the <var>Regex</var> object and returns the string with the replacements.
	==Syntax==		==Syntax==
	{{Template:Regex:Replace syntax}}		{{Template:Regex:Replace syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%string</th><td>string</td></tr>		<tr><th>%string</th><td>A copy of the input string after matches are replaced using the appropriate replacement string.</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>string</th>		<tr><th>string</th>
	<td>string</td></tr>		<td>The string to test against the Regex object.</td></tr>
	<tr><th>replacement</th>		<tr><th>replacement</th>
	<td>string<br/>~~The default value of this argument~~ is [[??]].</td></tr>		<td>The string that replaces the substrings of <var class="term">string</var> that <var class="term">regex</var> matches. Except when the <code>A</code> option is specified (as described at [[Regex_processing#Common_regex_options\|Common regex options]]), 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 the reular expression, if any.
	<tr><th><var>~~Options~~</var></th>		<p>
	<td>string<br/>The ~~default value of~~ this ~~argument~~ is [[??]].</td></tr>		These markers are in the form <var class="term">$n</var>, 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 there was no <i>n</i>th capture group corresponding to the <var class="term">$n</var> marker in a replacement string, the (literal) value of <var class="term">$n</var> is used in the replacement string instead of the empty string. <code>xxx$1</code> is an example of a valid replacement string, and <code>$0yyy</code> is an example of an invalid one. Or you can use the format <var class="term">$mn</var>, where <i>m</i> is one of the following modifiers:
			</p>
			<table class="syntaxNested">
			<tr><th><var>U</var> or <var class="camel">u</var></th>
			<td>Specifies that the specified captured string should be uppercased when inserted.</td></tr>

			<tr><th><var>L</var> or <var class="camel">l</var></th>
			<td>Indicates that the captured string should be lowercased when inserted.</td></tr>
			</table>
			The only characters you can escape in a replacement string are dollar sign (<code>$</code>), backslash (<code>\</code>), and the digits <code>0</code> through <code>9</code>. So only these escapes are respected: <code>\\</code>, <code>\$</code>, and <code>\0</code> through <code>\9</code>. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like <code>\d</code> — and an "unaccompanied" backslash (<code>\</code>) is an error. For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use <code>1$1\2</code> to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string.
			<p>An invalid replacement string results in request cancellation.</p></td></tr>
			<tr><th><var>options</var></th>
			A string of single letter options, which may be specified in uppercase or lowercase, in any combination, and blank separated or not. These options are a subset of [[Regex_processing#Common_regex_options\|Common regex options]]. The only acceptable options (case-independent) are <code>A</code> for "as-is", <code>G</code> for "global" (replace all occurrences), and <code>T</code> for trace.</td></tr>
	</table>		</table>
	==Usage notes==		==Usage notes==
			<ul>
			<li>If the regular expresion specified in the constructor call was Unicode, this method causes request cancellation. To test if a <var>Regex</var> object was created with a Unicode regular expression check the [[IsUnicode (Regex property)\|IsUnicode property]].</li>
			<li>There is no way to undo the <code>A</code>, <code>G</code>, and <code>T</code> options if they were specified on the constructor so if a <var>Regex</var> objects sometimes needs these options and sometimes not, they should be specified on each <var>Replace</var> call.</li>
			</ul>
	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:Regex:Replace footer}}		{{Template:Regex:Replace footer}}

			[[Category:Regular expression processing]]

Wiccan: Automatically generated page update

2022-03-23T18:47:26Z

Automatically generated page update

New page

{{Template:Regex:Replace subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Regex:Replace syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th><td>string</td></tr>
<tr><th>regex</th>
<td><var>Regex</var> object</td></tr>
<tr><th>string</th>
<td>string</td></tr>
<tr><th>replacement</th>
<td>string<br/>The default value of this argument is [[??]].</td></tr>
<tr><th><var>Options</var></th>
<td>string<br/>The default value of this argument is [[??]].</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Regex:Replace footer}}