/[pcre]/code/trunk/doc/pcre_fullinfo.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_fullinfo.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 678 - (hide annotations) (download)
Sun Aug 28 15:23:03 2011 UTC (3 years, 3 months ago) by ph10
File size: 2724 byte(s)
Documentation for JIT support.

1 nigel 79 .TH PCRE_FULLINFO 3
2 nigel 63 .SH NAME
3     PCRE - Perl-compatible regular expressions
4     .SH SYNOPSIS
5     .rs
6     .sp
7     .B #include <pcre.h>
8     .PP
9     .SM
10 nigel 75 .B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
11 nigel 63 .ti +5n
12 nigel 75 .B int \fIwhat\fP, void *\fIwhere\fP);
13     .
14 nigel 63 .SH DESCRIPTION
15     .rs
16     .sp
17     This function returns information about a compiled pattern. Its arguments are:
18 nigel 75 .sp
19     \fIcode\fP Compiled regular expression
20     \fIextra\fP Result of \fBpcre_study()\fP or NULL
21     \fIwhat\fP What information is required
22     \fIwhere\fP Where to put the information
23     .sp
24 nigel 63 The following information is available:
25 nigel 75 .sp
26     PCRE_INFO_BACKREFMAX Number of highest back reference
27     PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
28     PCRE_INFO_DEFAULT_TABLES Pointer to default tables
29     PCRE_INFO_FIRSTBYTE Fixed first byte for a match, or
30     -1 for start of string
31     or after newline, or
32     -2 otherwise
33 ph10 177 PCRE_INFO_FIRSTTABLE Table of first bytes (after studying)
34 ph10 678 PCRE_INFO_HASCRORLF Return 1 if explicit CR or LF matches exist
35 ph10 278 PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
36 ph10 678 PCRE_INFO_JIT Return 1 after successful JIT compilation
37 nigel 75 PCRE_INFO_LASTLITERAL Literal last byte required
38 ph10 461 PCRE_INFO_MINLENGTH Lower bound length of matching strings
39 nigel 75 PCRE_INFO_NAMECOUNT Number of named subpatterns
40     PCRE_INFO_NAMEENTRYSIZE Size of name table entry
41     PCRE_INFO_NAMETABLE Pointer to name table
42 ph10 182 PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried
43 ph10 426 (always returns 1 after release 8.00)
44 nigel 93 PCRE_INFO_OPTIONS Option bits used for compilation
45 nigel 75 PCRE_INFO_SIZE Size of compiled pattern
46     PCRE_INFO_STUDYSIZE Size of study data
47     .sp
48 ph10 678 The \fIwhere\fP argument must point to an integer variable, except for the
49     following \fIwhat\fP values:
50     .sp
51     PCRE_INFO_DEFAULT_TABLES const unsigned char *
52     PCRE_INFO_FIRSTTABLE const unsigned char *
53     PCRE_INFO_NAMETABLE const unsigned char *
54     PCRE_INFO_OPTIONS unsigned long int
55     PCRE_INFO_SIZE size_t
56     .sp
57 nigel 63 The yield of the function is zero on success or:
58 nigel 75 .sp
59     PCRE_ERROR_NULL the argument \fIcode\fP was NULL
60     the argument \fIwhere\fP was NULL
61     PCRE_ERROR_BADMAGIC the "magic number" was not found
62     PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
63     .P
64     There is a complete description of the PCRE native API in the
65 nigel 63 .\" HREF
66 nigel 75 \fBpcreapi\fP
67 nigel 63 .\"
68 nigel 75 page and a description of the POSIX API in the
69     .\" HREF
70     \fBpcreposix\fP
71     .\"
72 nigel 63 page.

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12