/[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 1055 - (show annotations)
Tue Oct 16 15:53:30 2012 UTC (8 years, 6 months ago) by chpe
File size: 3245 byte(s)
Error occurred while calculating annotation data.
pcre32: Add 32-bit library

Create libpcre32 that operates on 32-bit characters (UTF-32).

This turned out to be surprisingly simple after the UTF-16 support
was introduced; mostly just extra ifdefs and adjusting and adding
some tests.
1 .TH PCRE_FULLINFO 3 "24 June 2012" "PCRE 8.30"
2 .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 .B int pcre_fullinfo(const pcre *\fIcode\fP, "const pcre_extra *\fIextra\fP,"
11 .ti +5n
12 .B int \fIwhat\fP, void *\fIwhere\fP);
13 .PP
14 .B int pcre16_fullinfo(const pcre16 *\fIcode\fP, "const pcre16_extra *\fIextra\fP,"
15 .ti +5n
16 .B int \fIwhat\fP, void *\fIwhere\fP);
17 .PP
18 .B int pcre32_fullinfo(const pcre32 *\fIcode\fP, "const pcre32_extra *\fIextra\fP,"
19 .ti +5n
20 .B int \fIwhat\fP, void *\fIwhere\fP);
21 .
22 .SH DESCRIPTION
23 .rs
24 .sp
25 This function returns information about a compiled pattern. Its arguments are:
26 .sp
27 \fIcode\fP Compiled regular expression
28 \fIextra\fP Result of \fBpcre[16|32]_study()\fP or NULL
29 \fIwhat\fP What information is required
30 \fIwhere\fP Where to put the information
31 .sp
32 The following information is available:
33 .sp
34 PCRE_INFO_BACKREFMAX Number of highest back reference
35 PCRE_INFO_CAPTURECOUNT Number of capturing subpatterns
36 PCRE_INFO_DEFAULT_TABLES Pointer to default tables
37 PCRE_INFO_FIRSTBYTE Fixed first data unit for a match, or
38 -1 for start of string
39 or after newline, or
40 -2 otherwise
41 PCRE_INFO_FIRSTTABLE Table of first data units (after studying)
42 PCRE_INFO_HASCRORLF Return 1 if explicit CR or LF matches exist
43 PCRE_INFO_JCHANGED Return 1 if (?J) or (?-J) was used
44 PCRE_INFO_JIT Return 1 after successful JIT compilation
45 PCRE_INFO_JITSIZE Size of JIT compiled code
46 PCRE_INFO_LASTLITERAL Literal last data unit required
47 PCRE_INFO_MINLENGTH Lower bound length of matching strings
48 PCRE_INFO_NAMECOUNT Number of named subpatterns
49 PCRE_INFO_NAMEENTRYSIZE Size of name table entry
50 PCRE_INFO_NAMETABLE Pointer to name table
51 PCRE_INFO_OKPARTIAL Return 1 if partial matching can be tried
52 (always returns 1 after release 8.00)
53 PCRE_INFO_OPTIONS Option bits used for compilation
54 PCRE_INFO_SIZE Size of compiled pattern
55 PCRE_INFO_STUDYSIZE Size of study data
56 .sp
57 The \fIwhere\fP argument must point to an integer variable, except for the
58 following \fIwhat\fP values:
59 .sp
60 PCRE_INFO_DEFAULT_TABLES const unsigned char *
61 PCRE_INFO_FIRSTTABLE const unsigned char *
62 PCRE_INFO_NAMETABLE PCRE_SPTR16 (16-bit library)
63 PCRE_INFO_NAMETABLE PCRE_SPTR32 (32-bit library)
64 PCRE_INFO_NAMETABLE const unsigned char * (8-bit library)
65 PCRE_INFO_OPTIONS unsigned long int
66 PCRE_INFO_SIZE size_t
67 .sp
68 The yield of the function is zero on success or:
69 .sp
70 PCRE_ERROR_NULL the argument \fIcode\fP was NULL
71 the argument \fIwhere\fP was NULL
72 PCRE_ERROR_BADMAGIC the "magic number" was not found
73 PCRE_ERROR_BADOPTION the value of \fIwhat\fP was invalid
74 .P
75 There is a complete description of the PCRE native API in the
76 .\" HREF
77 \fBpcreapi\fP
78 .\"
79 page and a description of the POSIX API in the
80 .\" HREF
81 \fBpcreposix\fP
82 .\"
83 page.

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.5