| '\" |
| '\" Copyright (c) 1998 Sun Microsystems, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: regexp.n,v 1.12 2002/10/10 14:46:57 dgp Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .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) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" 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. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" 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. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" 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. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" 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. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .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 |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" 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 |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH regexp n 8.3 Tcl "Tcl Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| regexp \- Match a regular expression against a string |
| |
| .SH SYNOPSIS |
| \fBregexp \fR?\fIswitches\fR? \fIexp string \fR?\fImatchVar\fR? ?\fIsubMatchVar subMatchVar ...\fR? |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| Determines whether the regular expression \fIexp\fR matches part or |
| all of \fIstring\fR and returns 1 if it does, 0 if it doesn't, unless |
| \fB-inline\fR is specified (see below). |
| (Regular expression matching is described in the \fBre_syntax\fR |
| reference page.) |
| .LP |
| If additional arguments are specified after \fIstring\fR then they |
| are treated as the names of variables in which to return |
| information about which part(s) of \fIstring\fR matched \fIexp\fR. |
| \fIMatchVar\fR will be set to the range of \fIstring\fR that |
| matched all of \fIexp\fR. The first \fIsubMatchVar\fR will contain |
| the characters in \fIstring\fR that matched the leftmost parenthesized |
| subexpression within \fIexp\fR, the next \fIsubMatchVar\fR will |
| contain the characters that matched the next parenthesized |
| subexpression to the right in \fIexp\fR, and so on. |
| .PP |
| If the initial arguments to \fBregexp\fR start with \fB\-\fR then |
| they are treated as switches. The following switches are |
| currently supported: |
| .TP 15 |
| \fB\-about\fR |
| Instead of attempting to match the regular expression, returns a list |
| containing information about the regular expression. The first |
| element of the list is a subexpression count. The second element is a |
| list of property names that describe various attributes of the regular |
| expression. This switch is primarily intended for debugging purposes. |
| .TP 15 |
| \fB\-expanded\fR |
| Enables use of the expanded regular expression syntax where |
| whitespace and comments are ignored. This is the same as specifying |
| the \fB(?x)\fR embedded option (see the \fBre_syntax\fR manual page). |
| .TP 15 |
| \fB\-indices\fR |
| Changes what is stored in the \fIsubMatchVar\fRs. |
| Instead of storing the matching characters from \fIstring\fR, |
| each variable |
| will contain a list of two decimal strings giving the indices |
| in \fIstring\fR of the first and last characters in the matching |
| range of characters. |
| .TP 15 |
| \fB\-line\fR |
| 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 \fB\-linestop\fR and \fB\-lineanchor\fR, or the |
| \fB(?n)\fR embedded option (see the \fBre_syntax\fR manual page). |
| .TP 15 |
| \fB\-linestop\fR |
| Changes the behavior of `[^' bracket expressions and `.' so that they |
| stop at newlines. This is the same as specifying the \fB(?p)\fR |
| embedded option (see the \fBre_syntax\fR manual page). |
| .TP 15 |
| \fB\-lineanchor\fR |
| 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 \fB(?w)\fR embedded option (see the \fBre_syntax\fR |
| manual page). |
| .TP 15 |
| \fB\-nocase\fR |
| Causes upper-case characters in \fIstring\fR to be treated as |
| lower case during the matching process. |
| .VS 8.3 |
| .TP 15 |
| \fB\-all\fR |
| Causes the regular expression to be matched as many times as possible |
| in the string, returning the total number of matches found. If this |
| is specified with match variables, they will contain information for |
| the last match only. |
| .TP 15 |
| \fB\-inline\fR |
| Causes the command to return, as a list, the data that would otherwise |
| be placed in match variables. When using \fB-inline\fR, |
| match variables may not be specified. If used with \fB-all\fR, the |
| list will be concatenated at each iteration, such that a flat list is |
| always returned. For each match iteration, the command will append the |
| overall match data, plus one element for each subexpression in the |
| regular expression. Examples are: |
| .CS |
| regexp -inline -- {\\w(\\w)} " inlined " |
| => {in n} |
| regexp -all -inline -- {\\w(\\w)} " inlined " |
| => {in n li i ne e} |
| .CE |
| .TP 15 |
| \fB\-start\fR \fIindex\fR |
| Specifies a character index offset into the string to start |
| matching the regular expression at. When using this switch, `^' |
| will not match the beginning of the line, and \\A will still |
| match the start of the string at \fIindex\fR. If \fB\-indices\fR |
| is specified, the indices will be indexed starting from the |
| absolute beginning of the input string. |
| \fIindex\fR will be constrained to the bounds of the input string. |
| .VE 8.3 |
| .TP 15 |
| \fB\-\|\-\fR |
| Marks the end of switches. The argument following this one will |
| be treated as \fIexp\fR even if it starts with a \fB\-\fR. |
| .PP |
| If there are more \fIsubMatchVar\fR's than parenthesized |
| subexpressions within \fIexp\fR, or if a particular subexpression |
| in \fIexp\fR doesn't match the string (e.g. because it was in a |
| portion of the expression that wasn't matched), then the corresponding |
| \fIsubMatchVar\fR will be set to ``\fB\-1 \-1\fR'' if \fB\-indices\fR |
| has been specified or to an empty string otherwise. |
| |
| .SH "SEE ALSO" |
| re_syntax(n), regsub(n) |
| |
| .SH KEYWORDS |
| match, regular expression, string |