Load pcre-5.0 into code/trunk.

git-svn-id: svn://vcs.exim.org/pcre/code/trunk@75 2f5784b3-3f2a-0410-8824-cb99058d5e15

1 files changed, 97 insertions, 90 deletions

diff --git a/doc/pcreposix.3 b/doc/pcreposix.3
index 5198630..321dcd7 100644
--- a/doc/pcreposix.3
+++ b/doc/pcreposix.3
@@ -1,184 +1,191 @@
 .TH PCRE 3
 .SH NAME
 PCRE - Perl-compatible regular expressions.
-.SH SYNOPSIS OF POSIX API
+.SH "SYNOPSIS OF POSIX API"
+.rs
+.sp
 .B #include <pcreposix.h>
 .PP
 .SM
 .br
-.B int regcomp(regex_t *\fIpreg\fR, const char *\fIpattern\fR,
+.B int regcomp(regex_t *\fIpreg\fP, const char *\fIpattern\fP,
 .ti +5n
-.B int \fIcflags\fR);
+.B int \fIcflags\fP);
 .PP
 .br
-.B int regexec(regex_t *\fIpreg\fR, const char *\fIstring\fR,
+.B int regexec(regex_t *\fIpreg\fP, const char *\fIstring\fP,
 .ti +5n
-.B size_t \fInmatch\fR, regmatch_t \fIpmatch\fR[], int \fIeflags\fR);
+.B size_t \fInmatch\fP, regmatch_t \fIpmatch\fP[], int \fIeflags\fP);
 .PP
 .br
-.B size_t regerror(int \fIerrcode\fR, const regex_t *\fIpreg\fR,
+.B size_t regerror(int \fIerrcode\fP, const regex_t *\fIpreg\fP,
 .ti +5n
-.B char *\fIerrbuf\fR, size_t \fIerrbuf_size\fR);
+.B char *\fIerrbuf\fP, size_t \fIerrbuf_size\fP);
 .PP
 .br
-.B void regfree(regex_t *\fIpreg\fR);
-
+.B void regfree(regex_t *\fIpreg\fP);
+.
 .SH DESCRIPTION
 .rs
 .sp
 This set of functions provides a POSIX-style API to the PCRE regular expression
 package. See the
 .\" HREF
-\fBpcreapi\fR
+\fBpcreapi\fP
 .\"
-documentation for a description of the native API, which contains additional
+documentation for a description of PCRE's native API, which contains additional
 functionality.
-
+.P
 The functions described here are just wrapper functions that ultimately call
-the PCRE native API. Their prototypes are defined in the \fBpcreposix.h\fR
+the PCRE native API. Their prototypes are defined in the \fBpcreposix.h\fP
 header file, and on Unix systems the library itself is called
-\fBpcreposix.a\fR, so can be accessed by adding \fB-lpcreposix\fR to the
-command for linking an application which uses them. Because the POSIX functions
-call the native ones, it is also necessary to add \fR-lpcre\fR.
-
+\fBpcreposix.a\fP, so can be accessed by adding \fB-lpcreposix\fP to the
+command for linking an application that uses them. Because the POSIX functions
+call the native ones, it is also necessary to add \fB-lpcre\fP.
+.P
 I have implemented only those option bits that can be reasonably mapped to PCRE
 native options. In addition, the options REG_EXTENDED and REG_NOSUB are defined
 with the value zero. They have no effect, but since programs that are written
 to the POSIX interface often use them, this makes it easier to slot in PCRE as
 a replacement library. Other POSIX options are not even defined.
-
+.P
 When PCRE is called via these functions, it is only the API that is POSIX-like
 in style. The syntax and semantics of the regular expressions themselves are
 still those of Perl, subject to the setting of various PCRE options, as
 described below. "POSIX-like in style" means that the API approximates to the
 POSIX definition; it is not fully POSIX-compatible, and in multi-byte encoding
 domains it is probably even less compatible.
-
-The header for these functions is supplied as \fBpcreposix.h\fR to avoid any
+.P
+The header for these functions is supplied as \fBpcreposix.h\fP to avoid any
 potential clash with other POSIX libraries. It can, of course, be renamed or
-aliased as \fBregex.h\fR, which is the "correct" name. It provides two
-structure types, \fIregex_t\fR for compiled internal forms, and
-\fIregmatch_t\fR for returning captured substrings. It also defines some
+aliased as \fBregex.h\fP, which is the "correct" name. It provides two
+structure types, \fIregex_t\fP for compiled internal forms, and
+\fIregmatch_t\fP for returning captured substrings. It also defines some
 constants whose names start with "REG_"; these are used for setting options and
 identifying error codes.
-
-.SH COMPILING A PATTERN
+.P
+.SH "COMPILING A PATTERN"
 .rs
 .sp
-The function \fBregcomp()\fR is called to compile a pattern into an
+The function \fBregcomp()\fP is called to compile a pattern into an
 internal form. The pattern is a C string terminated by a binary zero, and
-is passed in the argument \fIpattern\fR. The \fIpreg\fR argument is a pointer
-to a regex_t structure which is used as a base for storing information about
-the compiled expression.
-
-The argument \fIcflags\fR is either zero, or contains one or more of the bits
+is passed in the argument \fIpattern\fP. The \fIpreg\fP argument is a pointer
+to a \fBregex_t\fP structure that is used as a base for storing information
+about the compiled expression.
+.P
+The argument \fIcflags\fP is either zero, or contains one or more of the bits
 defined by the following macros:
-
+.sp
   REG_ICASE
-
+.sp
 The PCRE_CASELESS option is set when the expression is passed for compilation
 to the native function.
-
+.sp
   REG_NEWLINE
-
+.sp
 The PCRE_MULTILINE option is set when the expression is passed for compilation
-to the native function. Note that this does \fInot\fR mimic the defined POSIX
+to the native function. Note that this does \fInot\fP mimic the defined POSIX
 behaviour for REG_NEWLINE (see the following section).
-
+.P
 In the absence of these flags, no options are passed to the native function.
 This means the the regex is compiled with PCRE default semantics. In
 particular, the way it handles newline characters in the subject string is the
 Perl way, not the POSIX way. Note that setting PCRE_MULTILINE has only
-\fIsome\fR of the effects specified for REG_NEWLINE. It does not affect the way
+\fIsome\fP of the effects specified for REG_NEWLINE. It does not affect the way
 newlines are matched by . (they aren't) or by a negative class such as [^a]
 (they are).
-
-The yield of \fBregcomp()\fR is zero on success, and non-zero otherwise. The
-\fIpreg\fR structure is filled in on success, and one member of the structure
-is public: \fIre_nsub\fR contains the number of capturing subpatterns in
+.P
+The yield of \fBregcomp()\fP is zero on success, and non-zero otherwise. The
+\fIpreg\fP structure is filled in on success, and one member of the structure
+is public: \fIre_nsub\fP contains the number of capturing subpatterns in
 the regular expression. Various error codes are defined in the header file.
-
-.SH MATCHING NEWLINE CHARACTERS
+.
+.
+.SH "MATCHING NEWLINE CHARACTERS"
 .rs
 .sp
 This area is not simple, because POSIX and Perl take different views of things.
 It is not possible to get PCRE to obey POSIX semantics, but then PCRE was never
 intended to be a POSIX engine. The following table lists the different
 possibilities for matching newline characters in PCRE:
-
+.sp
                           Default   Change with
-
+.sp
   . matches newline          no     PCRE_DOTALL
   newline matches [^a]       yes    not changeable
-  $ matches \\n at end        yes    PCRE_DOLLARENDONLY
-  $ matches \\n in middle     no     PCRE_MULTILINE
-  ^ matches \\n in middle     no     PCRE_MULTILINE
-
+  $ matches \en at end        yes    PCRE_DOLLARENDONLY
+  $ matches \en in middle     no     PCRE_MULTILINE
+  ^ matches \en in middle     no     PCRE_MULTILINE
+.sp
 This is the equivalent table for POSIX:
-
+.sp
                           Default   Change with
-
-  . matches newline          yes      REG_NEWLINE
-  newline matches [^a]       yes      REG_NEWLINE
-  $ matches \\n at end        no       REG_NEWLINE
-  $ matches \\n in middle     no       REG_NEWLINE
-  ^ matches \\n in middle     no       REG_NEWLINE
-
+.sp
+  . matches newline          yes    REG_NEWLINE
+  newline matches [^a]       yes    REG_NEWLINE
+  $ matches \en at end        no     REG_NEWLINE
+  $ matches \en in middle     no     REG_NEWLINE
+  ^ matches \en in middle     no     REG_NEWLINE
+.sp
 PCRE's behaviour is the same as Perl's, except that there is no equivalent for
-PCRE_DOLLARENDONLY in Perl. In both PCRE and Perl, there is no way to stop
+PCRE_DOLLAR_ENDONLY in Perl. In both PCRE and Perl, there is no way to stop
 newline from matching [^a].
-
+.P
 The default POSIX newline handling can be obtained by setting PCRE_DOTALL and
-PCRE_DOLLARENDONLY, but there is no way to make PCRE behave exactly as for the
+PCRE_DOLLAR_ENDONLY, but there is no way to make PCRE behave exactly as for the
 REG_NEWLINE action.
-
-.SH MATCHING A PATTERN
+.
+.
+.SH "MATCHING A PATTERN"
 .rs
 .sp
-The function \fBregexec()\fR is called to match a pre-compiled pattern
-\fIpreg\fR against a given \fIstring\fR, which is terminated by a zero byte,
-subject to the options in \fIeflags\fR. These can be:
-
+The function \fBregexec()\fP is called to match a compiled pattern \fIpreg\fP
+against a given \fIstring\fP, which is terminated by a zero byte, subject to
+the options in \fIeflags\fP. These can be:
+.sp
   REG_NOTBOL
-
+.sp
 The PCRE_NOTBOL option is set when calling the underlying PCRE matching
 function.
-
+.sp
   REG_NOTEOL
-
+.sp
 The PCRE_NOTEOL option is set when calling the underlying PCRE matching
 function.
-
+.P
 The portion of the string that was matched, and also any captured substrings,
-are returned via the \fIpmatch\fR argument, which points to an array of
-\fInmatch\fR structures of type \fIregmatch_t\fR, containing the members
-\fIrm_so\fR and \fIrm_eo\fR. These contain the offset to the first character of
+are returned via the \fIpmatch\fP argument, which points to an array of
+\fInmatch\fP structures of type \fIregmatch_t\fP, containing the members
+\fIrm_so\fP and \fIrm_eo\fP. These contain the offset to the first character of
 each substring and the offset to the first character after the end of each
 substring, respectively. The 0th element of the vector relates to the entire
-portion of \fIstring\fR that was matched; subsequent elements relate to the
+portion of \fIstring\fP that was matched; subsequent elements relate to the
 capturing subpatterns of the regular expression. Unused entries in the array
 have both structure members set to -1.
-
+.P
 A successful match yields a zero return; various error codes are defined in the
 header file, of which REG_NOMATCH is the "expected" failure code.
-
-.SH ERROR MESSAGES
+.
+.
+.SH "ERROR MESSAGES"
 .rs
 .sp
-The \fBregerror()\fR function maps a non-zero errorcode from either
-\fBregcomp()\fR or \fBregexec()\fR to a printable message. If \fIpreg\fR is not
+The \fBregerror()\fP function maps a non-zero errorcode from either
+\fBregcomp()\fP or \fBregexec()\fP to a printable message. If \fIpreg\fP is not
 NULL, the error should have arisen from the use of that structure. A message
-terminated by a binary zero is placed in \fIerrbuf\fR. The length of the
-message, including the zero, is limited to \fIerrbuf_size\fR. The yield of the
+terminated by a binary zero is placed in \fIerrbuf\fP. The length of the
+message, including the zero, is limited to \fIerrbuf_size\fP. The yield of the
 function is the size of buffer needed to hold the whole message.
-
-.SH STORAGE
+.
+.
+.SH MEMORY USAGE
 .rs
 .sp
 Compiling a regular expression causes memory to be allocated and associated
-with the \fIpreg\fR structure. The function \fBregfree()\fR frees all such
-memory, after which \fIpreg\fR may no longer be used as a compiled expression.
-
+with the \fIpreg\fP structure. The function \fBregfree()\fP frees all such
+memory, after which \fIpreg\fP may no longer be used as a compiled expression.
+.
+.
 .SH AUTHOR
 .rs
 .sp
@@ -187,8 +194,8 @@ Philip Hazel <ph10@cam.ac.uk>
 University Computing Service,
 .br
 Cambridge CB2 3QG, England.
-
+.P
 .in 0
-Last updated: 03 February 2003
+Last updated: 07 September 2004
 .br
-Copyright (c) 1997-2003 University of Cambridge.
+Copyright (c) 1997-2004 University of Cambridge.