Provided by: tcl9.0-doc_9.0.1+dfsg-2_all 
NAME
regsub - Perform substitutions based on regular expression pattern matching
SYNOPSIS
regsub ?switches? exp string subSpec ?varName?
________________________________________________________________________________________________________________
DESCRIPTION
This command matches the regular expression exp against string, and either copies string to the variable
whose name is given by varName or returns string if varName is not present. (Regular expression matching
is described in the re_syntax reference page.) If there is a match, then while copying string to varName
(or to the result of this command if varName is not present) the portion of string that matched exp is
replaced with subSpec. If subSpec contains a “&” or “\0”, then it is replaced in the substitution with
the portion of string that matched exp. If subSpec contains a “\n”, where n is a digit between 1 and 9,
then it is replaced in the substitution with the portion of string that matched the n'th parenthesized
subexpression of exp. Additional backslashes may be used in subSpec to prevent special interpretation of
“&”, “\0”, “\n” and backslashes. The use of backslashes in subSpec tends to interact badly with the Tcl
parser's use of backslashes, so it is generally safest to enclose subSpec in braces if it includes
backslashes.
If the initial arguments to regsub start with - then they are treated as switches. The following
switches are currently supported:
-all All ranges in string that match exp are found and substitution is performed for each of these
ranges. Without this switch only the first matching range is found and substituted. If -all is
specified, then “&” and “\n” sequences are handled for each substitution using the information
from the corresponding match.
-command
Changes the handling of subSpec so that it is not treated as a template for a substitution string 2
and the substrings “&” and “\n” no longer have special meaning. Instead subSpec must be a command 2
prefix, that is, a non-empty list. The substring of string that matches exp, and then each 2
substring that matches each capturing sub-RE within exp are appended as additional elements to 2
that list. (The items appended to the list are much like what regexp -inline would return). The 2
completed list is then evaluated as a Tcl command, and the result of that command is the 2
substitution string. Any error or exception from command evaluation becomes an error or exception 2
from the regsub command. 2
If -all is not also given, the command callback will be invoked at most once (exactly when the 2
regular expression matches). If -all is given, the command callback will be invoked for each 2
matched location, in sequence. The exact location indices that matched are not made available to 2
the script. 2
See EXAMPLES below for illustrative cases. 2
-expanded
Enables use of the expanded regular expression syntax where whitespace and comments are ignored.
This is the same as specifying the (?x) embedded option (see the re_syntax manual page).
-line Enables newline-sensitive matching. By default, newline is a completely ordinary character with
no special meaning. With this flag, “[^” bracket expressions and “.” never match newline, “^”
matches an empty string after any newline in addition to its normal function, and “$” matches an
empty string before any newline in addition to its normal function. This flag is equivalent to
specifying both -linestop and -lineanchor, or the (?n) embedded option (see the re_syntax manual
page).
-linestop
Changes the behavior of “[^” bracket expressions and “.” so that they stop at newlines. This is
the same as specifying the (?p) embedded option (see the re_syntax manual page).
-lineanchor
Changes the behavior of “^” and “$” (the “anchors”) so they match the beginning and end of a line
respectively. This is the same as specifying the (?w) embedded option (see the re_syntax manual
page).
-nocase
Upper-case characters in string will be converted to lower-case before matching against exp;
however, substitutions specified by subSpec use the original unconverted form of string.
-start index
Specifies a character index offset into the string to start matching the regular expression at.
The index value is interpreted in the same manner as the index argument to string index. When
using this switch, “^” will not match the beginning of the line, and \A will still match the start
of the string at index. index will be constrained to the bounds of the input string.
-- Marks the end of switches. The argument following this one will be treated as exp even if it
starts with a -.
If varName is supplied, the command returns a count of the number of matching ranges that were found and
replaced, otherwise the string after replacement is returned. See the manual entry for regexp for
details on the interpretation of regular expressions.
EXAMPLES
Replace (in the string in variable string) every instance of foo which is a word by itself with bar:
regsub -all {\mfoo\M} $string bar string
or (using the “basic regular expression” syntax):
regsub -all {(?b)\<foo\>} $string bar string
Insert double-quotes around the first instance of the word interesting, however it is capitalized.
regsub -nocase {\yinteresting\y} $string {"&"} string
Convert all non-ASCII and Tcl-significant characters into \u escape sequences by using regsub and subst
in combination:
# This RE is just a character class for almost everything "bad"
set RE {[][{};#\\\$ \r\t\u0080-\uffff]}
# We will substitute with a fragment of Tcl script in brackets
set substitution {[format \\\\u%04x [scan "\\&" %c]]}
# Now we apply the substitution to get a subst-string that
# will perform the computational parts of the conversion. Note
# that newline is handled specially through string map since
# backslash-newline is a special sequence.
set quoted [subst [string map {\n {\\u000a}} \
[regsub -all $RE $string $substitution]]]
The above operation can be done using regsub -command instead, which is often faster. (A full pre- 2
computed string map would be faster still, but the cost of computing the map for a transformation as 2
complex as this can be quite large.) 2
# This RE is just a character class for everything "bad" 2
set RE {[][{};#\\\$\s\u0080-\uffff]} 2
# This encodes what the RE described above matches 2
proc encodeChar {ch} { 2
# newline is handled specially since backslash-newline is a 2
# special sequence. 2
if {$ch eq "\n"} { 2
return "\\u000a" 2
} 2
# No point in writing this as a one-liner 2
scan $ch %c charNumber 2
format "\\u%04x" $charNumber 2
} 2
set quoted [regsub -all -command $RE $string encodeChar] 2
Decoding a URL-encoded string using regsub -command, a lambda term and the apply command. 2
# Match one of the sequences in a URL-encoded string that needs 2
# fixing, converting + to space and %XX to the right character 2
# (e.g., %7e becomes ~) 2
set RE {(\+)|%([0-9A-Fa-f]{2})} 2
# Note that -command uses a command prefix, not a command name 2
set decoded [regsub -all -command $RE $string {apply {{- p h} { 2
# + is a special case; handle directly 2
if {$p eq "+"} { 2
return " " 2
} 2
# convert hex to a char 2
scan $h %x charNumber 2
format %c $charNumber 2
}}}] 2
The -command option can also be useful for restricting the range of commands such as string totitle: 2
set message "the quIck broWn fOX JUmped oVer the laZy dogS..." 2
puts [regsub -all -command {\w+} $message {string totitle}] 2
# → The Quick Brown Fox Jumped Over The Lazy Dogs.. 2
SEE ALSO
regexp(3tcl), re_syntax(3tcl), subst(3tcl), string(3tcl)
KEYWORDS
match, pattern, quoting, regular expression, substitution
Tcl 8.3 regsub(3tcl)