RegexReplace (String function) - Revision history

ATitelbaum: /* Examples */

2022-03-26T01:43:47Z

Examples

← Older revision		Revision as of 01:43, 26 March 2022
Line 67:		Line 67:
	%replacement='$L1'		%replacement='$L1'
	%opt='g'		%opt='g'
	%outStr = %inStr:~~Regexreplace~~(%regex, %replacement, options=%opt)		%outStr = %inStr:regexReplace(%regex, %replacement, options=%opt)
	[[PrintText statement\|printText]] OutputString: '{%outStr}'		[[PrintText statement\|printText]] OutputString: '{%outStr}'
	end		end
Line 77:		Line 77:

	<div id="greedy"></div>		<div id="greedy"></div>
	<li>Say you want to supply end tags to items of of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:		<li>Say you want to supply end tags to items of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:
	<p class="code">(<img .*>)</p>		<p class="code">(<img .*>)</p>
	And you use the following replacement string to replace the captured string with the captured string plus an appended <code></img></code>:		And you use the following replacement string to replace the captured string with the captured string plus an appended <code></img></code>:

Alex: /* Syntax terms */

2022-01-21T22:08:41Z

Syntax terms

← Older revision		Revision as of 22:08, 21 January 2022
Line 36:		Line 36:

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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 optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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>
	</table>		</table>

Alex: /* See also */

2022-01-21T17:05:32Z

Alex at 17:03, 21 January 2022

2022-01-21T17:03:40Z

@@ Line 37: / Line 37: @@
 <tr><th><var>Options</var></th>
 <td>This optional, [[Notation conventions for methods#Named parameters|name required]], parameter is 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>
 </table>
@@ Line 109: / Line 90: @@
 ==See also==
 {{Template:String:RegexReplace footer}}

JAL: link repair

2016-05-11T23:00:38Z

link repair

← Older revision		Revision as of 23:00, 11 May 2016
Line 36:		Line 36:

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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 optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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">

Line 58:		Line 58:
	</table></td></tr>		</table></td></tr>
	</table>		</table>

	~~==Exceptions==~~
	~~<var>RegexReplace</var> can throw the following exceptions:~~
	~~<dl>~~
	~~<dt><var>[[InvalidRegex_class\|InvalidRegex]]</var>~~
	<dd>If the <var class="term">regex</var> parameter does not contain a valid regular expression. The exception object indicates the position of the character in the <var class="term">regex</var> parameter where it was determined that the regular expression is invalid, and a description of the nature of the error.
	~~</dl>~~

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<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>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.		<li>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.

JAL: minor formatting

2016-05-11T22:58:25Z

minor formatting

← Older revision		Revision as of 22:58, 11 May 2016
Line 68:		Line 68:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<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>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>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.		<li>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.

JAL: link repair

2016-05-11T22:48:41Z

link repair

← Older revision		Revision as of 22:48, 11 May 2016
Line 68:		Line 68:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<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>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.		<li>Within a regular expression, 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 (<tt>?</tt>). A capturing group that is nested within a non-capturing subexpression is still a capturing group.
Line 76:		Line 76:
	<li>Matching of <var class="term">regex</var> may "succeed" but yet match no characters. For example, a quantifier like <code>?</code> 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 <var class="term">regex</var> is then applied again one position to the right in the input string, and again, until the end of the string. The regex <code>9?</code> globally applied to the string <code>abc</code> with a comma-comma (<tt>,,</tt>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.		<li>Matching of <var class="term">regex</var> may "succeed" but yet match no characters. For example, a quantifier like <code>?</code> 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 <var class="term">regex</var> is then applied again one position to the right in the input string, and again, until the end of the string. The regex <code>9?</code> globally applied to the string <code>abc</code> with a comma-comma (<tt>,,</tt>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.

	<li>For information about additional methods that support regular expressions, see [[~~Regex_processing\|"~~Regex ~~Processing"~~]].		<li>For information about additional methods that support regular expressions, see [[Regex processing]].

	~~<li><var>RegexReplace</var> is available as of <var class="product">Sirius Mods</var> Version 7.2~~.
	</ul>		</ul>

JAL at 17:47, 5 November 2012

2012-11-05T17:47:11Z

← Older revision		Revision as of 17:47, 5 November 2012
Line 13:		Line 13:
	<tr><th>%outString</th>		<tr><th>%outString</th>
	<td>A string set to the value of method object <var class="term">string</var> with each matched substring replaced by the value of <var class="term">replacement</var>. </td></tr>		<td>A string set to the value of method object <var class="term">string</var> with each matched substring replaced by the value of <var class="term">replacement</var>. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>The method object string, within which matches for <var class="term">regex</var> are sought.</td>		<td>The method object string, within which matches for <var class="term">regex</var> are sought.</td>

	<tr><th>regex</th>		<tr><th>regex</th>
	<td>A string that is interpreted as a regular expression and that is applied to the method object <var class="term">string</var> to find the one or more substrings matched by <var class="term">regex</var> </td></tr>		<td>A string that is interpreted as a regular expression and that is applied to the method object <var class="term">string</var> to find the one or more substrings matched by <var class="term">regex</var> </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 below for the <var>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.		<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 below for the <var>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.
	<p>As in Perl, 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 a capturing group makes no matches (is positional, for example), or 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>
			As in Perl, 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 a capturing group makes no matches (is positional, for example), or 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>		</p>
	<table class="syntaxNested"><tr><th><var>U or u</var></th>		<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>		<td>Specifies that the specified captured string should be uppercased when inserted.</td></tr>
	<tr><th><var>L or l</var></th>
			<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>		<td>Indicates that the captured string should be lowercased when inserted.</td></tr>
	</table>		</table>
Line 32:		Line 38:
	<td>This optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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 optional, [[Notation conventions for methods#Named parameters\|name required]], parameter is 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 (<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>
Line 67:		Line 74:
	<li>In Perl, <var class="term">$n</var> markers (<code>$1</code>, 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 <code>A</code> option of the <var>Options</var> argument for this purpose.		<li>In Perl, <var class="term">$n</var> markers (<code>$1</code>, 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 <code>A</code> option of the <var>Options</var> argument for this purpose.

	<li>Matching of <var class="term">regex</var> may "succeed" but yet match no characters. For example, a quantifier like <code>?</code> 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 <var class="term">regex</var> is then applied again one position to the right in the input string, and again, until the end of the string. The regex <code>9?</code> globally applied to the string <code>abc</code> with a comma-comma (<~~code~~>,,</~~code~~>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.		<li>Matching of <var class="term">regex</var> may "succeed" but yet match no characters. For example, a quantifier like <code>?</code> 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 <var class="term">regex</var> is then applied again one position to the right in the input string, and again, until the end of the string. The regex <code>9?</code> globally applied to the string <code>abc</code> with a comma-comma (<tt>,,</tt>) replacement string results in this output string: <code>,,a,,b,,c,,</code>.

	<li>For information about additional methods that support regular expressions, see [[Regex_processing\|"Regex Processing"]].		<li>For information about additional methods that support regular expressions, see [[Regex_processing\|"Regex Processing"]].
Line 75:		Line 82:

	==Examples==		==Examples==
	<ol><li>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 <code>$L1</code> <var class="term">replacement</var> value makes the replacement string equal to whatever is matched by the capturing group, <code>(5.)</code>, in the <var class="term">regex</var> (the <code>L</code> causes the lowercase versions of the captured letters to be used).		<ol>
			<li>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 <code>$L1</code> <var class="term">replacement</var> value makes the replacement string equal to whatever is matched by the capturing group, <code>(5.)</code>, in the <var class="term">regex</var> (the <code>L</code> causes the lowercase versions of the captured letters to be used).
	<p class="code">begin		<p class="code">begin
	%regex longstring		%regex longstring
Line 95:		Line 103:
	</p>		</p>
	The non-capturing regex <code>5.</code> matches and replaces the same substrings as the capturing group <code>(5.)</code>, but <code>(5.)</code> is used above to take advantage of the self-referring marker for the replacement string, <code>$L1</code>, which is valid only for capturing groups.		The non-capturing regex <code>5.</code> matches and replaces the same substrings as the capturing group <code>(5.)</code>, but <code>(5.)</code> is used above to take advantage of the self-referring marker for the replacement string, <code>$L1</code>, which is valid only for capturing groups.

	<div id="greedy"></div>		<div id="greedy"></div>
	<li>Say you want to supply end tags to items of of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:		<li>Say you want to supply end tags to items of of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:
Line 103:		Line 112:
	<p class="code"><body><img src="foo" width="24"></body></img></p>		<p class="code"><body><img src="foo" width="24"></body></img></p>
	One remedy for this situation is to use the following <var class="term">regex</var>, which employs a negated character class to match non-closing-bracket characters:		One remedy for this situation is to use the following <var class="term">regex</var>, which employs a negated character class to match non-closing-bracket characters:
	<p class="code">(<img [&~~circ~~;>]*>)</p>		<p class="code">(<img [^>]*>)</p>
	This <var class="term">regex</var> does not extend beyond the first closing angle bracket in the target input string, and the resulting output string is:		This <var class="term">regex</var> does not extend beyond the first closing angle bracket in the target input string, and the resulting output string is:
	<p class="output"><body><img src="foo" width="24"></img></body></p></ol>		<p class="output"><body><img src="foo" width="24"></img></body></p></ol>

JAL2 at 21:54, 7 August 2012

2012-08-07T21:54:42Z

← Older revision		Revision as of 21:54, 7 August 2012
Line 39:		Line 39:

	<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 ~~class="term"~~>M</var> mode is ignored if <var ~~class="term"~~>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>
Line 45:		Line 45:

	<tr><th><var>G</var></th>		<tr><th><var>G</var></th>
	<td>Replace every occurrence of the match, not just (as in non-<var ~~class="term"~~>G</var> mode) the first matched substring only. </td></tr>		<td>Replace every occurrence of the match, not just (as in non-<var>G</var> mode) the first matched substring only. </td></tr>

	<tr><th><var>A</var></th>		<tr><th><var>A</var></th>

Dme at 01:36, 19 June 2012

2012-06-19T01:36:07Z

← Older revision		Revision as of 01:36, 19 June 2012
Line 95:		Line 95:
	</p>		</p>
	The non-capturing regex <code>5.</code> matches and replaces the same substrings as the capturing group <code>(5.)</code>, but <code>(5.)</code> is used above to take advantage of the self-referring marker for the replacement string, <code>$L1</code>, which is valid only for capturing groups.		The non-capturing regex <code>5.</code> matches and replaces the same substrings as the capturing group <code>(5.)</code>, but <code>(5.)</code> is used above to take advantage of the self-referring marker for the replacement string, <code>$L1</code>, which is valid only for capturing groups.
			<div id="greedy"></div>
	<li>Say you want to supply end tags to items of of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:		<li>Say you want to supply end tags to items of of the form <code><img foo="bar"></code>, converting them to <code><img foo="bar"></img></code>. You decide to use the following regex to capture <code>img</code> tags that have attributes:
	<p class="code">(<img .*>)</p>		<p class="code">(<img .*>)</p>

← Older revision		Revision as of 17:05, 21 January 2022
Line 90:		Line 90:
	==See also==		==See also==
	{{Template:String:RegexReplace footer}}		{{Template:String:RegexReplace footer}}
	[[Category:Regular ~~Expression Processing~~]]		[[Category:Regular expression processing]]