'\" Copyright (c) 1998 Sun Microsystems, Inc.
'\" Copyright (c) 1999 Scriptics Corporation
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" RCS: @(#) $Id: re_syntax.n,v 1.3 1999/07/14 19:09:36 jpeek Exp $
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\" End of box enclosure.
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\" End of vertical sidebar.
'\" Begin an indented unfilled display.
'\" End of indented unfilled display.
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" End of list of standard options for a Tk widget.
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\" Print arg1 underlined, then print arg2 normally.
'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
'\" # Start an argument description
. ie !"\\$2"" .TP \\n()Cu
\&\\$1 \\fI\\$2\\fP (\\$3)
'\" # define tabbing values for .AP
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
.AS Tcl_Interp Tcl_CreateInterp in/out
'\" # BS - start boxed text
'\" # ^y = starting y location
'\" # BE - end boxed text (draw box now)
.\" Draw four-sided box normally, but don't draw top of
.\" box if the box started on an earlier page.
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
'\" # VS - start vertical sidebar
'\" # ^Y = starting y location
'\" # ^v = 1 (for troff; for nroff this doesn't matter)
'\" # VE - end of vertical sidebar
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
'\" # Special macro to handle page bottom: finish off current
'\" # box/sidebar if in box/sidebar mode, then invoked standard
.\" Draw three-sided box if this is the box's first page,
.\" draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
'\" # SO - start of list of standard options
'\" # SE - end of list of standard options
See the \\fBoptions\\fR manual entry for details on the standard options.
'\" # OP - start of full description for a single option
Command-Line Name: \\fB\\$1\\fR
Database Name: \\fB\\$2\\fR
Database Class: \\fB\\$3\\fR
'\" # CS - begin code excerpt
'\" # CE - end code excerpt
.TH re_syntax n "8.1" Tcl "Tcl Built-In Commands"
re_syntax \- Syntax of Tcl regular expressions.
A \fIregular expression\fR describes strings of characters.
It's a pattern that matches certain strings and doesn't match others.
.SH "DIFFERENT FLAVORS OF REs"
Regular expressions (``RE''s), as defined by POSIX, come in two
flavors: \fIextended\fR REs (``EREs'') and \fIbasic\fR REs (``BREs'').
EREs are roughly those of the traditional \fIegrep\fR, while BREs are
roughly those of the traditional \fIed\fR. This implementation adds
a third flavor, \fIadvanced\fR REs (``AREs''), basically EREs with
some significant extensions.
This manual page primarily describes AREs. BREs mostly exist for
backward compatibility in some old programs; they will be discussed at
the end. POSIX EREs are almost an exact subset of AREs. Features of
AREs that are not present in EREs will be indicated.
.SH "REGULAR EXPRESSION SYNTAX"
Tcl regular expressions are implemented using the package written by
Henry Spencer, based on the 1003.2 spec and some (not quite all) of
the Perl5 extensions (thanks, Henry!). Much of the description of
regular expressions below is copied verbatim from his manual entry.
An ARE is one or more \fIbranches\fR,
matching anything that matches any of the branches.
A branch is zero or more \fIconstraints\fR or \fIquantified atoms\fR,
It matches a match for the first, followed by a match for the second, etc;
an empty branch matches the empty string.
A quantified atom is an \fIatom\fR possibly followed
by a single \fIquantifier\fR.
Without a quantifier, it matches a match for the atom.
and what a so-quantified atom matches, are:
a sequence of 0 or more matches of the atom
a sequence of 1 or more matches of the atom
a sequence of 0 or 1 matches of the atom
a sequence of exactly \fIm\fR matches of the atom
a sequence of \fIm\fR or more matches of the atom
a sequence of \fIm\fR through \fIn\fR (inclusive) matches of the atom;
\fIm\fR may not exceed \fIn\fR
\fB*? +? ?? {\fIm\fB}? {\fIm\fB,}? {\fIm\fB,\fIn\fB}?\fR
\fInon-greedy\fR quantifiers,
which match the same possibilities,
but prefer the smallest number rather than the largest number
of matches (see MATCHING)
are known as \fIbound\fRs.
\fIm\fR and \fIn\fR are unsigned decimal integers
with permissible values from 0 to 255 inclusive.
(where \fIre\fR is any regular expression)
\fIre\fR, with the match noted for possible reporting
(a ``non-capturing'' set of parentheses)
noted for possible reporting
a \fIbracket expression\fR,
matching any one of the \fIchars\fR (see BRACKET EXPRESSIONS for more detail)
matches any single character
(where \fIk\fR is a non-alphanumeric character)
matches that character taken as an ordinary character,
e.g. \e\e matches a backslash character
where \fIc\fR is alphanumeric
(possibly followed by other characters),
an \fIescape\fR (AREs only),
when followed by a character other than a digit,
matches the left-brace character `\fB{\fR';
when followed by a digit, it is the beginning of a
a single character with no other significance, matches that character.
A \fIconstraint\fR matches an empty string when specific conditions
A constraint may not be followed by a quantifier.
The simple constraints are as follows; some more constraints are
described later, under ESCAPES.
matches at the beginning of a line
matches at the end of a line
\fIpositive lookahead\fR (AREs only), matches at any point
where a substring matching \fIre\fR begins
\fInegative lookahead\fR (AREs only), matches at any point
where no substring matching \fIre\fR begins
The lookahead constraints may not contain back references (see later),
and all parentheses within them are considered non-capturing.
An RE may not end with `\fB\e\fR'.
.SH "BRACKET EXPRESSIONS"
A \fIbracket expression\fR is a list of characters enclosed in `\fB[\|]\fR'.
It normally matches any single character from the list (but see below).
If the list begins with `\fB^\fR',
it matches any single character
(but see below) \fInot\fR from the rest of the list.
If two characters in the list are separated by `\fB\-\fR',
for the full \fIrange\fR of characters between those two (inclusive) in the
in ASCII matches any decimal digit.
Two ranges may not share an
Ranges are very collating-sequence-dependent,
and portable programs should avoid relying on them.
the simplest method is to
to make it a collating element (see below).
make it the first character
(following a possible `\fB^\fR'),
or (AREs only) precede it with `\fB\e\fR'.
Alternatively, for `\fB\-\fR',
make it the last character,
or the second endpoint of a range.
as the first endpoint of a range,
make it a collating element
or (AREs only) precede it with `\fB\e\fR'.
With the exception of these, some combinations using
paragraphs), and escapes,
all other special characters lose their
special significance within a bracket expression.
Within a bracket expression, a collating element (a character,
a multi-character sequence that collates as if it were a single character,
or a collating-sequence name for either)
sequence of characters of that collating element.
The sequence is a single element of the bracket expression's list.
A bracket expression in a locale that has
multi-character collating elements
can thus match more than one character.
So (insidiously), a bracket expression that starts with \fB^\fR
can match multi-character collating elements even if none of them
appear in the bracket expression!
(\fINote:\fR Tcl currently has no multi-character collating elements.
This information is only for illustration.)
For example, assume the collating sequence includes a \fBch\fR
multi-character collating element.
Then the RE \fB[[.ch.]]*c\fR (zero or more \fBch\fP's followed by \fBc\fP)
matches the first five characters of `\fBchchcc\fR'.
Also, the RE \fB[^c]b\fR matches all of `\fBchb\fR'
(because \fB[^c]\fR matches the multi-character \fBch\fR).
Within a bracket expression, a collating element enclosed in
is an equivalence class, standing for the sequences of characters
of all collating elements equivalent to that one, including itself.
(If there are no other equivalent collating elements,
the treatment is as if the enclosing delimiters were `\fB[.\fR'\&
are the members of an equivalence class,
then `\fB[[=o=]]\fR', `\fB[[=\o'o^'=]]\fR',
An equivalence class may not be an endpoint
Tcl currently implements only the Unicode locale.
It doesn't define any equivalence classes.
The examples above are just illustrations.)
Within a bracket expression, the name of a \fIcharacter class\fR enclosed
stands for the list of all characters
(not all collating elements!)
Standard character classes are:
\fBupper\fR An upper-case letter.
\fBlower\fR A lower-case letter.
\fBdigit\fR A decimal digit.
\fBxdigit\fR A hexadecimal digit.
\fBalnum\fR An alphanumeric (letter or digit).
\fBprint\fR An alphanumeric (same as alnum).
\fBblank\fR A space or tab character.
\fBspace\fR A character producing white space in displayed text.
\fBpunct\fR A punctuation character.
\fBgraph\fR A character with a visible representation.
\fBcntrl\fR A control character.
A locale may provide others.
(Note that the current Tcl implementation has only one locale:
A character class may not be used as an endpoint of a range.
There are two special cases of bracket expressions:
are constraints, matching empty strings at
the beginning and end of a word respectively.
'\" note, discussion of escapes below references this definition of word
A word is defined as a sequence of
that is neither preceded nor followed by
These special bracket expressions are deprecated;
users of AREs should use constraint escapes instead (see below).
Escapes (AREs only), which begin with a
followed by an alphanumeric character,
come in several varieties:
character entry, class shorthands, constraint escapes, and back references.
followed by an alphanumeric character but not constituting
a valid escape is illegal in AREs.
In EREs, there are no escapes:
outside a bracket expression,
followed by an alphanumeric character merely stands for that
character as an ordinary character,
and inside a bracket expression,
is an ordinary character.
(The latter is the one actual incompatibility between EREs and AREs.)
Character-entry escapes (AREs only) exist to make it easier to specify
non-printing and otherwise inconvenient characters in REs:
alert (bell) character, as in C
to help reduce backslash doubling in some
applications where there are multiple levels of backslash processing
(where X is any character) the character whose
low-order 5 bits are the same as those of
and whose other bits are all zero
the character whose collating-sequence name
or failing that, the character with octal value 033
is exactly four hexadecimal digits)
in the local byte ordering
is exactly eight hexadecimal digits)
reserved for a somewhat-hypothetical Unicode extension to 32 bits
is any sequence of hexadecimal digits)
the character whose hexadecimal value is
(a single character no matter how many hexadecimal digits are used).
the character whose value is
is exactly two octal digits,
\fIback reference\fR (see below))
the character whose octal value is
is exactly three octal digits,
back reference (see below))
the character whose octal value is
Hexadecimal digits are `\fB0\fR'-`\fB9\fR', `\fBa\fR'-`\fBf\fR',
Octal digits are `\fB0\fR'-`\fB7\fR'.
The character-entry escapes are always taken as ordinary characters.
does not terminate a bracket expression.
Beware, however, that some applications (e.g., C compilers) interpret
such sequences themselves before the regular-expression package
gets to see them, which may require doubling (quadrupling, etc.) the `\fB\e\fR'.
Class-shorthand escapes (AREs only) provide shorthands for certain commonly-used
Within bracket expressions, `\fB\ed\fR', `\fB\es\fR',
lose their outer brackets,
and `\fB\eD\fR', `\fB\eS\fR',
(So, for example, \fB[a-c\ed]\fR is equivalent to \fB[a-c[:digit:]]\fR.
Also, \fB[a-c\eD]\fR, which is equivalent to \fB[a-c^[:digit:]]\fR, is illegal.)
A constraint escape (AREs only) is a constraint,
matching the empty string if specific conditions are met,
matches only at the beginning of the string
(see MATCHING, below, for how this differs from `\fB^\fR')
matches only at the beginning of a word
matches only at the end of a word
matches only at the beginning or end of a word
matches only at a point that is not the beginning or end of a word
matches only at the end of the string
(see MATCHING, below, for how this differs from `\fB$\fR')
is a nonzero digit) a \fIback reference\fR, see below
is not greater than the number of closing capturing parentheses seen so far)
a \fIback reference\fR, see below
A word is defined as in the specification of
Constraint escapes are illegal within bracket expressions.
A back reference (AREs only) matches the same string matched by the parenthesized
subexpression specified by the number,
The subexpression must entirely precede the back reference in the RE.
Subexpressions are numbered in the order of their leading parentheses.
Non-capturing parentheses do not define subexpressions.
There is an inherent historical ambiguity between octal character-entry
escapes and back references, which is resolved by heuristics,
A leading zero always indicates an octal escape.
A single non-zero digit, not followed by another digit,
is always taken as a back reference.
A multi-digit sequence not starting with a zero is taken as a back
reference if it comes after a suitable subexpression
(i.e. the number is in the legal range for a back reference),
and otherwise is taken as octal.
In addition to the main syntax described above, there are some special
forms and miscellaneous syntactic facilities available.
Normally the flavor of RE being used is specified by
application-dependent means.
However, this can be overridden by a \fIdirector\fR.
If an RE of any flavor begins with `\fB***:\fR',
the rest of the RE is an ARE.
If an RE of any flavor begins with `\fB***=\fR',
the rest of the RE is taken to be a literal string,
with all characters considered ordinary characters.
An ARE may begin with \fIembedded options\fR:
is one or more alphabetic characters)
specifies options affecting the rest of the RE.
These supplement, and can override,
any options specified by the application.
The available option letters are:
case-sensitive matching (usual default)
case-insensitive matching (see MATCHING, below)
newline-sensitive matching (see MATCHING, below)
partial newline-sensitive matching (see MATCHING, below)
rest of RE is a literal (``quoted'') string, all ordinary characters
non-newline-sensitive matching (usual default)
tight syntax (usual default; see below)
inverse partial newline-sensitive (``weird'') matching (see MATCHING, below)
expanded syntax (see below)
Embedded options take effect at the
terminating the sequence.
They are available only at the start of an ARE,
and may not be used later within it.
In addition to the usual (\fItight\fR) RE syntax, in which all characters are
significant, there is an \fIexpanded\fR syntax,
available in all flavors of RE
with the \fB-expanded\fR switch, or in AREs with the embedded x option.
white-space characters are ignored
and all characters between a
and the following newline (or the end of the RE) are ignored,
permitting paragraphing and commenting a complex RE.
There are three exceptions to that basic rule:
a white-space character or `\fB#\fR' preceded by `\fB\e\fR' is retained
white space or `\fB#\fR' within a bracket expression is retained
white space and comments are illegal within multi-character symbols
like the ARE `\fB(?:\fR' or the BRE `\fB\e(\fR'
Expanded-syntax white-space characters are blank, tab, newline, and
any character that belongs to the \fIspace\fR character class.
outside bracket expressions, the sequence `\fB(?#\fIttt\fB)\fR'
is any text not containing a `\fB)\fR')
Again, this is not allowed between the characters of
multi-character symbols like `\fB(?:\fR'.
Such comments are more a historical artifact than a useful facility,
and their use is deprecated;
use the expanded syntax instead.
\fINone\fR of these metasyntax extensions is available if the application
has specified that the user's input be treated as a literal string
In the event that an RE could match more than one substring of a given
the RE matches the one starting earliest in the string.
If the RE could match more than one substring starting at that point,
its choice is determined by its \fIpreference\fR:
either the longest substring, or the shortest.
Most atoms, and all constraints, have no preference.
A parenthesized RE has the same preference (possibly none) as the RE.
A quantified atom with quantifier
has the same preference (possibly none) as the atom itself.
A quantified atom with other normal quantifiers (including
A quantified atom with other non-greedy quantifiers (including
A branch has the same preference as the first quantified atom in it
An RE consisting of two or more branches connected by the
operator prefers longest match.
Subject to the constraints imposed by the rules for matching the whole RE,
subexpressions also match the longest or shortest possible substrings,
based on their preferences,
with subexpressions starting earlier in the RE taking priority over
Note that outer subexpressions thus take priority over
their component subexpressions.
Note that the quantifiers
can be used to force longest and shortest preference, respectively,
on a subexpression or a whole RE.
Match lengths are measured in characters, not collating elements.
An empty string is considered longer than no match at all.
matches the three middle characters of `\fBabbbc\fR',
\fB(week|wee)(night|knights)\fR
matches all ten characters of `\fBweeknights\fR',
the parenthesized subexpression
matches all three characters, and
both the whole RE and the parenthesized
subexpression match an empty string.
If case-independent matching is specified,
the effect is much as if all case distinctions had vanished from the
When an alphabetic that exists in multiple cases appears as an
ordinary character outside a bracket expression, it is effectively
transformed into a bracket expression containing both cases,
When it appears inside a bracket expression, all case counterparts
of it are added to the bracket expression, so that
If newline-sensitive matching is specified, \fB.\fR
and bracket expressions using
will never match the newline character
(so that matches will never cross newlines unless the RE
will match the empty string after and before a newline
respectively, in addition to matching at beginning and end of string
continue to match beginning or end of string \fIonly\fR.
If partial newline-sensitive matching is specified,
as with newline-sensitive matching, but not
If inverse partial newline-sensitive matching is specified,
newline-sensitive matching,
This isn't very useful but is provided for symmetry.
.SH "LIMITS AND COMPATIBILITY"
No particular limit is imposed on the length of REs.
Programs intended to be highly portable should not employ REs longer
as a POSIX-compliant implementation can refuse to accept such REs.
The only feature of AREs that is actually incompatible with
does not lose its special
significance inside bracket expressions.
All other ARE features use syntax which is illegal or has
undefined or unspecified effects in POSIX EREs;
syntax of directors likewise is outside the POSIX
syntax for both BREs and EREs.
Many of the ARE extensions are borrowed from Perl, but some have
been changed to clean them up, and a few Perl extensions are not present.
Incompatibilities of note include `\fB\eb\fR', `\fB\eB\fR',
the lack of special treatment for a trailing newline,
the addition of complemented bracket expressions to the things
affected by newline-sensitive matching,
the restrictions on parentheses and back references in lookahead constraints,
and the longest/shortest-match (rather than first-match) matching semantics.
The matching rules for REs containing both normal and non-greedy quantifiers
have changed since early beta-test versions of this package.
(The new rules are much simpler and cleaner,
but don't work as hard at guessing the user's real intentions.)
Henry Spencer's original 1986 \fIregexp\fR package,
still in widespread use (e.g., in pre-8.1 releases of Tcl),
implemented an early version of today's EREs.
There are four incompatibilities between \fIregexp\fR's near-EREs
(`RREs' for short) and AREs.
In roughly increasing order of significance:
followed by an alphanumeric character is either an
while in RREs, it was just another way of writing the
This should not be a problem because there was no reason to write
followed by a digit in an ARE is the beginning of a bound,
was always an ordinary character.
Such sequences should be rare,
and will often result in an error because following characters
will not look like a valid bound.
remains a special character within `\fB[\|]\fR',
must be written `\fB\e\e\fR'.
but only truly paranoid programmers routinely doubled the backslash.
AREs report the longest/shortest match for the RE,
rather than the first found in a specified search order.
This may affect some RREs which were written in the expectation that
the first match would be reported.
(The careful crafting of RREs to optimize the search order for fast
matching is obsolete (AREs examine all possible matches
in parallel, and their performance is largely insensitive to their
complexity) but cases where the search order was exploited to deliberately
find a match which was \fInot\fR the longest/shortest will need rewriting.)
.SH "BASIC REGULAR EXPRESSIONS"
BREs differ from EREs in several respects. `\fB|\fR', `\fB+\fR',
are ordinary characters and there is no equivalent
The delimiters for bounds are
by themselves ordinary characters.
The parentheses for nested subexpressions are
by themselves ordinary characters.
is an ordinary character except at the beginning of the
RE or the beginning of a parenthesized subexpression,
is an ordinary character except at the end of the
RE or the end of a parenthesized subexpression,
is an ordinary character if it appears at the beginning of the
RE or the beginning of a parenthesized subexpression
(after a possible leading `\fB^\fR').
single-digit back references are available,
no other escapes are available.
RegExp(3), regexp(n), regsub(n), lsearch(n), switch(n), text(n)
match, regular expression, string