$RegexReplace

Replace matching strings

Note: Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $RegexReplace function is the RegexReplace String function.

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.

Matches are obtained according to the "rules" of regular expression matching (information about the rules observed is provided in Regex rules).

$RegexReplace accepts three required and two optional arguments, and it returns a string. It is also callable. Specifying an invalid argument results in request cancellation.

Syntax

outStr = $RegexReplace(inStr, regex, replacement, [options], [%status])

Syntax terms

outStr	A string set to the value of inStr with each matched substring replaced by the value of replacement.
inStr	the input string, to which the regular expression regex is applied. This is a required argument.
regex	a string that is interpreted as a regular expression and that is applied to the inStr argument to find the one or more inStr substrings matched by regex. This is a required argument.
replacement	The string that replaces the substrings of inStr that regex matches. This is a required argument. Except when the A option is specified (as described below for the options argument), you can include markers in the replacement value to indicate where to insert corresponding captured strings — strings matched by capturing groups (parenthesized subexpressions) in regex, if any. As in Perl, these markers are in the form $n, 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. If a capturing group makes no matches (is positional, for example), or if there was no nth capture group corresponding to the $n marker in a replacement string, the value of $n used in the replacement string is the empty string. xxx$1 is an example of a valid replacement string, and $0yyy is an example of a non-valid one. Or you can use the format $mn, where m is one of the following modifiers: U or u Specifies that the specified captured string should be uppercased when inserted. L or l Indicates that the captured string should be lowercased when inserted. The only characters you can escape in a replacement string are dollar sign ($), backslash (\), and the digits 0 through 9. So only these escapes are respected: .\\, \$, and \0 through \9. No other escapes are allowed in a replacement string — this includes "shorthand" escapes like \d — and an "unaccompanied" backslash (\) is an error. For example, since the scan for the number that accompanies the meta-$ stops at the first non-numeric, you use 1$1\2 to indicate that the first captured string should go between the numbers 1 and 2 in the replacement string.
options	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 Common regex options.
%status	An optional, integer status code. These values are possible: n The number of replacements made. 0 No match: inStr was not matched by regex. -5 An invalid replacement string. For example, an invalid escape sequence, or a $ followed by a non-number, by a 0 or by no digits, or by more than 9 digits. -1nnn The pattern in regex is invalid. nnn, 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 %status value is to be returned, the run is cancelled.

Usage notes

• It is strongly recommended that you protect your environment from regex processing demands on PDL and STBL space by setting, say, UTABLE LPDLST 3000 and UTABLE LSTBL 9000. For further discussion of this,
• $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,
• 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 (?). A capturing group that is nested within a non-capturing subexpression is still a capturing group.
• In Perl, $n markers ($1, for example) enclosed in single quotes are treated as literals instead of as "that which was captured by the first capturing parentheses." $RegexReplace uses the A option of the Option argument for this purpose.
• A regex may "succeed" but match no characters. For example, a quantifier like ? is allowed by definition to match no characters, though it tries to match one. $RegexReplace 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 9? globally applied to the string abc with a comma-comma (,,) replacement string results in this output string: ,,a,,b,,c,,.
• Say you want to supply end tags to items of of the form <img foo="bar">, converting them to <img foo="bar"></img>. You decide to use the following regex to capture img tags that have attributes:

  (<img .*>)

  And you use the following replacement string to replace the captured string with the captured string plus an appended </img>:

  $1</img>

  However, if the regex above is applied to the string <body><img src="foo" width="24"></body>, the end tag </img> is not inserted after the first closing angle bracket (>) after "24" as you want. Instead, the matched string greedily extends to the second closing angle bracket, and the tag </img> is positioned at the end:

  <body><img src="foo" width="24"></body></img>

  One remedy for this situation is to use the following regex, which employs a negated character class to match non-closing-bracket characters:

  (<img [ˆ>]*>)

  This regex does not extend beyond the first closing angle bracket in the target input string, and the resulting output string is:

  <body><img src="foo" width="24"></img></body>

• For information about additional methods and $functions that support regular expressions, see Regex processing.

Examples

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

Begin %regex Longstring %inStr Longstring %replacement Longstring %outStr Longstring %opt string len 10 %status float %inStr='5A5B5C5D5E' %regex='(5.)' %replacement='$L1' %opt='g' %outStr = $RegexReplace (%inStr, %regex, %replacement, - %opt, %status) Print '%RegexReplace: status = ' %status Print 'OutputString: ' %outStr End

The example result is:

%RegexReplace: status = 5 OutputString: 5a5b5c5d5e

The non-capturing regex 5. matches and replaces the same substrings as the capturing group (5.), but (5.) is used above to take advantage of the self-referring marker for the replacement string, $L1, which is valid only for capturing groups.

Products authorizing $RegexReplace

• Sirius Functions