diff options
Diffstat (limited to 'doc/RegExp.3')
| -rw-r--r-- | doc/RegExp.3 | 15 |
1 files changed, 3 insertions, 12 deletions
diff --git a/doc/RegExp.3 b/doc/RegExp.3 index 836126d..31b8330 100644 --- a/doc/RegExp.3 +++ b/doc/RegExp.3 @@ -6,7 +6,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: RegExp.3,v 1.15 2004/09/18 17:01:06 dkf Exp $ +'\" RCS: @(#) $Id: RegExp.3,v 1.16 2004/10/07 14:44:33 dkf Exp $ '\" .so man.macros .TH Tcl_RegExpMatch 3 8.1 Tcl "Tcl Library Procedures" @@ -30,7 +30,6 @@ int \fBTcl_RegExpExec\fR(\fIinterp\fR, \fIregexp\fR, \fIstring\fR, \fIstart\fR) .sp \fBTcl_RegExpRange\fR(\fIregexp\fR, \fIindex\fR, \fIstartPtr\fR, \fIendPtr\fR) -.VS 8.1 .sp Tcl_RegExp \fBTcl_GetRegExpFromObj\fR(\fIinterp\fR, \fIpatObj\fR, \fIcflags\fR) @@ -39,14 +38,12 @@ int \fBTcl_RegExpExecObj\fR(\fIinterp\fR, \fIregexp\fR, \fIobjPtr\fR, \fIoffset\fR, \fInmatches\fR, \fIeflags\fR) .sp \fBTcl_RegExpGetInfo\fR(\fIregexp\fR, \fIinfoPtr\fR) -.VE 8.1 .SH ARGUMENTS -.AS Tcl_Interp *interp +.AS Tcl_RegExpInfo *interp in/out .AP Tcl_Interp *interp in Tcl interpreter to use for error reporting. The interpreter may be NULL if no error reporting is desired. -.VS 8.1 .AP Tcl_Obj *strObj in/out Refers to the object from which to get the string to search. The internal representation of the object may be converted to a form that @@ -54,7 +51,6 @@ can be efficiently searched. .AP Tcl_Obj *patObj in/out Refers to the object from which to get a regular expression. The compiled regular expression is cached in the object. -.VE 8.1 .AP char *string in String to check for a match with a regular expression. .AP "CONST char" *pattern in @@ -79,7 +75,6 @@ NULL if there is no such range. The address of the character just after the last one in the range is stored here, or NULL if there is no such range. .VE 8.4 -.VS 8.1 .AP int cflags in OR-ed combination of compilation flags. See below for more information. .AP Tcl_Obj *objPtr in/out @@ -102,7 +97,6 @@ See below for more information. .AP Tcl_RegExpInfo *infoPtr out The address of the location where information about a previous match should be stored by \fBTcl_RegExpGetInfo\fR. -.VE 8.1 .BE .SH DESCRIPTION @@ -116,13 +110,11 @@ If there is no match then \fBTcl_RegExpMatch\fR returns 0. If an error occurs in the matching process (e.g. \fIpattern\fR is not a valid regular expression) then \fBTcl_RegExpMatch\fR returns \-1 and leaves an error message in the interpreter result. -.VS 8.1.2 \fBTcl_RegExpMatchObj\fR is similar to \fBTcl_RegExpMatch\fR except it operates on the Tcl objects \fIstrObj\fR and \fIpatObj\fR instead of UTF strings. \fBTcl_RegExpMatchObj\fR is generally more efficient than \fBTcl_RegExpMatch\fR, so it is the preferred interface. -.VE 8.1.2 .PP \fBTcl_RegExpCompile\fR, \fBTcl_RegExpExec\fR, and \fBTcl_RegExpRange\fR provide lower-level access to the regular expression pattern matcher. @@ -170,7 +162,6 @@ information is returned about the range of characters that matched the If there is no range corresponding to \fIindex\fR then NULL is stored in \fI*startPtr\fR and \fI*endPtr\fR. .PP -.VS 8.1 \fBTcl_GetRegExpFromObj\fR, \fBTcl_RegExpExecObj\fR, and \fBTcl_RegExpGetInfo\fR are object interfaces that provide the most direct control of Henry Spencer's regular expression library. For @@ -343,7 +334,7 @@ If no match was found, then it indicates the earliest point at which a match might occur if additional text is appended to the string. If it is no match is possible even with further text, this field will be set to -1. -.VE 8.1 + .SH "SEE ALSO" re_syntax(n) .SH KEYWORDS |