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

Diff of /code/trunk/doc/pcreapi.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1031 by ph10, Sat Sep 8 15:59:01 2012 UTC revision 1113 by chpe, Tue Oct 16 15:57:12 2012 UTC
# Line 134  PCRE - Perl-compatible regular expressio Line 134  PCRE - Perl-compatible regular expressio
134  .B int (*pcre_callout)(pcre_callout_block *);  .B int (*pcre_callout)(pcre_callout_block *);
135  .  .
136  .  .
137  .SH "PCRE 8-BIT AND 16-BIT LIBRARIES"  .SH "PCRE 8-BIT, 16-BIT AND 32-BIT LIBRARIES"
138  .rs  .rs
139  .sp  .sp
140  From release 8.30, PCRE can be compiled as a library for handling 16-bit  From release 8.30, PCRE can be compiled as a library for handling 16-bit
141  character strings as well as, or instead of, the original library that handles  character strings as well as, or instead of, the original library that handles
142  8-bit character strings. To avoid too much complication, this document  8-bit character strings. From release 8.32, PCRE can also be compiled as a
143  describes the 8-bit versions of the functions, with only occasional references  library for handling 32-bit character strings. To avoid too much complication,
144  to the 16-bit library.  this document describes the 8-bit versions of the functions, with only
145    occasional references to the 16-bit and 32-bit libraries.
146  .P  .P
147  The 16-bit functions operate in the same way as their 8-bit counterparts; they  The 16-bit functions operate in the same way as their 8-bit counterparts; they
148  just use different data types for their arguments and results, and their names  just use different data types for their arguments and results, and their names
# Line 150  in its name (for example, PCRE_UTF8), th Line 151  in its name (for example, PCRE_UTF8), th
151  UTF8 replaced by UTF16. This facility is in fact just cosmetic; the 16-bit  UTF8 replaced by UTF16. This facility is in fact just cosmetic; the 16-bit
152  option names define the same bit values.  option names define the same bit values.
153  .P  .P
154    The 32-bit functions operate in the same way as their 8-bit counterparts; they
155    just use different data types for their arguments and results, and their names
156    start with \fBpcre32_\fP instead of \fBpcre_\fP. For every option that has UTF8
157    in its name (for example, PCRE_UTF8), there is a corresponding 32-bit name with
158    UTF8 replaced by UTF32. This facility is in fact just cosmetic; the 32-bit
159    option names define the same bit values.
160    .P
161  References to bytes and UTF-8 in this document should be read as references to  References to bytes and UTF-8 in this document should be read as references to
162  16-bit data quantities and UTF-16 when using the 16-bit library, unless  16-bit data quantities and UTF-16 when using the 16-bit library, unless
163  specified otherwise. More details of the specific differences for the 16-bit  specified otherwise. More details of the specific differences for the 16-bit
# Line 159  library are given in the Line 167  library are given in the
167  .\"  .\"
168  page.  page.
169  .  .
170    .P
171    References to bytes and UTF-8 in this document should be read as references to
172    32-bit data quantities and UTF-32 when using the 32-bit library, unless
173    specified otherwise. More details of the specific differences for the 32-bit
174    library are given in the
175    .\" HREF
176    \fBpcre32\fP
177    .\"
178    page.
179    .
180  .  .
181  .SH "PCRE API OVERVIEW"  .SH "PCRE API OVERVIEW"
182  .rs  .rs
# Line 392  not recognized. The following informatio Line 410  not recognized. The following informatio
410    PCRE_CONFIG_UTF8    PCRE_CONFIG_UTF8
411  .sp  .sp
412  The output is an integer that is set to one if UTF-8 support is available;  The output is an integer that is set to one if UTF-8 support is available;
413  otherwise it is set to zero. If this option is given to the 16-bit version of  otherwise it is set to zero. This value should normally be given to the 8-bit
414  this function, \fBpcre16_config()\fP, the result is PCRE_ERROR_BADOPTION.  version of this function, \fBpcre_config()\fP. If it is given to the 16-bit
415    or 32-bit version of this function, the result is PCRE_ERROR_BADOPTION.
416  .sp  .sp
417    PCRE_CONFIG_UTF16    PCRE_CONFIG_UTF16
418  .sp  .sp
419  The output is an integer that is set to one if UTF-16 support is available;  The output is an integer that is set to one if UTF-16 support is available;
420  otherwise it is set to zero. This value should normally be given to the 16-bit  otherwise it is set to zero. This value should normally be given to the 16-bit
421  version of this function, \fBpcre16_config()\fP. If it is given to the 8-bit  version of this function, \fBpcre16_config()\fP. If it is given to the 8-bit
422  version of this function, the result is PCRE_ERROR_BADOPTION.  or 32-bit version of this function, the result is PCRE_ERROR_BADOPTION.
423    .sp
424      PCRE_CONFIG_UTF32
425    .sp
426    The output is an integer that is set to one if UTF-32 support is available;
427    otherwise it is set to zero. This value should normally be given to the 32-bit
428    version of this function, \fBpcre32_config()\fP. If it is given to the 8-bit
429    or 16-bit version of this function, the result is PCRE_ERROR_BADOPTION.
430  .sp  .sp
431    PCRE_CONFIG_UNICODE_PROPERTIES    PCRE_CONFIG_UNICODE_PROPERTIES
432  .sp  .sp
# Line 442  or CRLF. The default can be overridden w Line 468  or CRLF. The default can be overridden w
468  The output is an integer that contains the number of bytes used for internal  The output is an integer that contains the number of bytes used for internal
469  linkage in compiled regular expressions. For the 8-bit library, the value can  linkage in compiled regular expressions. For the 8-bit library, the value can
470  be 2, 3, or 4. For the 16-bit library, the value is either 2 or 4 and is still  be 2, 3, or 4. For the 16-bit library, the value is either 2 or 4 and is still
471  a number of bytes. The default value of 2 is sufficient for all but the most  a number of bytes. For the 32-bit library, the value is either 2 or 4 and is
472  massive patterns, since it allows the compiled pattern to be up to 64K in size.  still a number of bytes. The default value of 2 is sufficient for all but the
473  Larger values allow larger regular expressions to be compiled, at the expense  most massive patterns, since it allows the compiled pattern to be up to 64K in
474  of slower matching.  size. Larger values allow larger regular expressions to be compiled, at the
475    expense of slower matching.
476  .sp  .sp
477    PCRE_CONFIG_POSIX_MALLOC_THRESHOLD    PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
478  .sp  .sp
# Line 858  validity checking of subject strings. Line 885  validity checking of subject strings.
885  The following table lists the error codes than may be returned by  The following table lists the error codes than may be returned by
886  \fBpcre_compile2()\fP, along with the error messages that may be returned by  \fBpcre_compile2()\fP, along with the error messages that may be returned by
887  both compiling functions. Note that error messages are always 8-bit ASCII  both compiling functions. Note that error messages are always 8-bit ASCII
888  strings, even in 16-bit mode. As PCRE has developed, some error codes have  strings, even in 16-bit or 32-bit mode. As PCRE has developed, some error codes
889  fallen out of use. To avoid confusion, they have not been re-used.  have fallen out of use. To avoid confusion, they have not been re-used.
890  .sp  .sp
891     0  no error     0  no error
892     1  \e at end of pattern     1  \e at end of pattern
# Line 942  fallen out of use. To avoid confusion, t Line 969  fallen out of use. To avoid confusion, t
969    74  invalid UTF-16 string (specifically UTF-16)    74  invalid UTF-16 string (specifically UTF-16)
970    75  name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN)    75  name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN)
971    76  character value in \eu.... sequence is too large    76  character value in \eu.... sequence is too large
972      77  invalid UTF-32 string (specifically UTF-32)
973  .sp  .sp
974  The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may  The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
975  be used if the limits were changed when PCRE was built.  be used if the limits were changed when PCRE was built.
# Line 1047  find out the value in a calling program Line 1075  find out the value in a calling program
1075  Studying a pattern is also useful for non-anchored patterns that do not have a  Studying a pattern is also useful for non-anchored patterns that do not have a
1076  single fixed starting character. A bitmap of possible starting bytes is  single fixed starting character. A bitmap of possible starting bytes is
1077  created. This speeds up finding a position in the subject at which to start  created. This speeds up finding a position in the subject at which to start
1078  matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256.)  matching. (In 16-bit mode, the bitmap is used for 16-bit values less than 256.
1079    In 32-bit mode, the bitmap is used for 32-bit values less than 256.)
1080  .P  .P
1081  These two optimizations apply to both \fBpcre_exec()\fP and  These two optimizations apply to both \fBpcre_exec()\fP and
1082  \fBpcre_dfa_exec()\fP, and the information is also used by the JIT compiler.  \fBpcre_dfa_exec()\fP, and the information is also used by the JIT compiler.
# Line 1192  variable. Line 1221  variable.
1221  .P  .P
1222  If there is a fixed first value, for example, the letter "c" from a pattern  If there is a fixed first value, for example, the letter "c" from a pattern
1223  such as (cat|cow|coyote), its value is returned. In the 8-bit library, the  such as (cat|cow|coyote), its value is returned. In the 8-bit library, the
1224  value is always less than 256; in the 16-bit library the value can be up to  value is always less than 256. In the 16-bit library the value can be up to
1225  0xffff.  0xffff. In the 32-bit library the value can be up to 0x10ffff.
1226  .P  .P
1227  If there is no fixed first value, and if either  If there is no fixed first value, and if either
1228  .sp  .sp
# Line 1206  starts with "^", or Line 1235  starts with "^", or
1235  -1 is returned, indicating that the pattern matches only at the start of a  -1 is returned, indicating that the pattern matches only at the start of a
1236  subject string or after any newline within the string. Otherwise -2 is  subject string or after any newline within the string. Otherwise -2 is
1237  returned. For anchored patterns, -2 is returned.  returned. For anchored patterns, -2 is returned.
1238    .P
1239    Since for the 32-bit library using the non-UTF-32 mode, this function is unable
1240    to return the full 32-bit range of the character, this value is deprecated;
1241    instead the PCRE_INFO_FIRSTCHARACTERFLAGS and PCRE_INFO_FIRSTCHARACTER values should
1242    be used.
1243  .sp  .sp
1244    PCRE_INFO_FIRSTTABLE    PCRE_INFO_FIRSTTABLE
1245  .sp  .sp
# Line 1253  value, -1 is returned. For anchored patt Line 1287  value, -1 is returned. For anchored patt
1287  only if it follows something of variable length. For example, for the pattern  only if it follows something of variable length. For example, for the pattern
1288  /^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value  /^a\ed+z\ed+/ the returned value is "z", but for /^a\edz\ed/ the returned value
1289  is -1.  is -1.
1290    .P
1291    Since for the 32-bit library using the non-UTF-32 mode, this function is unable
1292    to return the full 32-bit range of the character, this value is deprecated;
1293    instead the PCRE_INFO_REQUIREDCHARFLAGS and PCRE_INFO_REQUIREDCHAR values should
1294    be used.
1295  .sp  .sp
1296    PCRE_INFO_MAXLOOKBEHIND    PCRE_INFO_MAXLOOKBEHIND
1297  .sp  .sp
# Line 1292  length of the longest name. PCRE_INFO_NA Line 1331  length of the longest name. PCRE_INFO_NA
1331  entry of the table. This is a pointer to \fBchar\fP in the 8-bit library, where  entry of the table. This is a pointer to \fBchar\fP in the 8-bit library, where
1332  the first two bytes of each entry are the number of the capturing parenthesis,  the first two bytes of each entry are the number of the capturing parenthesis,
1333  most significant byte first. In the 16-bit library, the pointer points to  most significant byte first. In the 16-bit library, the pointer points to
1334  16-bit data units, the first of which contains the parenthesis number. The rest  16-bit data units, the first of which contains the parenthesis number.
1335    In the 32-bit library, the pointer points to 32-bit data units, the first of
1336    which contains the parenthesis number. The rest
1337  of the entry is the corresponding name, zero terminated.  of the entry is the corresponding name, zero terminated.
1338  .P  .P
1339  The names are in alphabetical order. Duplicate names may appear if (?| is used  The names are in alphabetical order. Duplicate names may appear if (?| is used
# Line 1394  is made available via this option so tha Line 1435  is made available via this option so tha
1435  \fBpcreprecompile\fP  \fBpcreprecompile\fP
1436  .\"  .\"
1437  documentation for details).  documentation for details).
1438    .sp
1439      PCRE_INFO_FIRSTCHARACTERFLAGS
1440    .sp
1441    Return information about the first data unit of any matched string, for a
1442    non-anchored pattern. The fourth argument should point to an \fBint\fP
1443    variable.
1444    .P
1445    If there is a fixed first value, for example, the letter "c" from a pattern
1446    such as (cat|cow|coyote), 1 is returned, and the character value can be
1447    retrieved using PCRE_INFO_FIRSTCHARACTER.
1448    .P
1449    If there is no fixed first value, and if either
1450    .sp
1451    (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
1452    starts with "^", or
1453    .sp
1454    (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set
1455    (if it were set, the pattern would be anchored),
1456    .sp
1457    2 is returned, indicating that the pattern matches only at the start of a
1458    subject string or after any newline within the string. Otherwise 0 is
1459    returned. For anchored patterns, 0 is returned.
1460    .sp
1461      PCRE_INFO_FIRSTCHARACTER
1462    .sp
1463    Return the fixed first character value, if PCRE_INFO_FIRSTCHARACTERFLAGS returned 1;
1464    otherwise returns 0. The fourth argument should point to an \fBuint_t\fP
1465    variable.
1466    .P
1467    In the 8-bit library, the value is always less than 256. In the 16-bit library
1468    the value can be up to 0xffff. In the 32-bit library in UTF-32 mode the value
1469    can be up to 0x10ffff, and up to 0xffffffff when not using UTF-32 mode.
1470    .P
1471    If there is no fixed first value, and if either
1472    .sp
1473    (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
1474    starts with "^", or
1475    .sp
1476    (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set
1477    (if it were set, the pattern would be anchored),
1478    .sp
1479    -1 is returned, indicating that the pattern matches only at the start of a
1480    subject string or after any newline within the string. Otherwise -2 is
1481    returned. For anchored patterns, -2 is returned.
1482    .sp
1483      PCRE_INFO_REQUIREDCHARFLAGS
1484    .sp
1485    Returns 1 if there is a rightmost literal data unit that must exist in any matched
1486    string, other than at its start. The fourth argument should  point to an \fBint\fP
1487    variable. If there is no such value, 0 is returned. If returning 1, the character
1488    value itself can be retrieved using PCRE_INFO_REQUIREDCHAR.
1489    .P
1490    For anchored patterns, a last literal value is recorded only if it follows something
1491    of variable length. For example, for the pattern /^a\ed+z\ed+/ the returned value
1492    1 (with "z" returned from PCRE_INFO_REQUIREDCHAR), but for /^a\edz\ed/ the returned
1493    value is 0.
1494    .sp
1495      PCRE_INFO_REQUIREDCHAR
1496    .sp
1497    Return the value of the rightmost literal data unit that must exist in any
1498    matched string, other than at its start, if such a value has been recorded. The
1499    fourth argument should point to an \fBuint32_t\fP variable. If there is no such
1500    value, 0 is returned.
1501  .  .
1502  .  .
1503  .SH "REFERENCE COUNTS"  .SH "REFERENCE COUNTS"
# Line 1490  fields (not necessarily in this order): Line 1594  fields (not necessarily in this order):
1594  .sp  .sp
1595  In the 16-bit version of this structure, the \fImark\fP field has type  In the 16-bit version of this structure, the \fImark\fP field has type
1596  "PCRE_UCHAR16 **".  "PCRE_UCHAR16 **".
1597    .sp
1598    In the 32-bit version of this structure, the \fImark\fP field has type
1599    "PCRE_UCHAR32 **".
1600  .P  .P
1601  The \fIflags\fP field is used to specify which of the other fields are set. The  The \fIflags\fP field is used to specify which of the other fields are set. The
1602  flag bits are:  flag bits are:
# Line 2126  documentation for more details. Line 2233  documentation for more details.
2233    PCRE_ERROR_BADMODE        (-28)    PCRE_ERROR_BADMODE        (-28)
2234  .sp  .sp
2235  This error is given if a pattern that was compiled by the 8-bit library is  This error is given if a pattern that was compiled by the 8-bit library is
2236  passed to a 16-bit library function, or vice versa.  passed to a 16-bit or 32-bit library function, or vice versa.
2237  .sp  .sp
2238    PCRE_ERROR_BADENDIANNESS  (-29)    PCRE_ERROR_BADENDIANNESS  (-29)
2239  .sp  .sp
# Line 2147  for the 16-bit library is given in the Line 2254  for the 16-bit library is given in the
2254  .\" HREF  .\" HREF
2255  \fBpcre16\fP  \fBpcre16\fP
2256  .\"  .\"
2257    page. The corresponding information for the 32-bit library is given in the
2258    .\" HREF
2259    \fBpcre32\fP
2260    .\"
2261  page.  page.
2262  .P  .P
2263  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or  When \fBpcre_exec()\fP returns either PCRE_ERROR_BADUTF8 or
# Line 2217  character. Line 2328  character.
2328  .sp  .sp
2329  The first byte of a character has the value 0xfe or 0xff. These values can  The first byte of a character has the value 0xfe or 0xff. These values can
2330  never occur in a valid UTF-8 string.  never occur in a valid UTF-8 string.
2331    .sp
2332      PCRE_UTF8_ERR2
2333    .sp
2334    Non-character. These are the last two characters in each plane (0xfffe, 0xffff,
2335    0x1fffe, 0x1ffff .. 0x10fffe, 0x10ffff), and the characters 0xfdd0..0xfdef.
2336  .  .
2337  .  .
2338  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"  .SH "EXTRACTING CAPTURED SUBSTRINGS BY NUMBER"
# Line 2665  fail, this error is given. Line 2781  fail, this error is given.
2781  .SH "SEE ALSO"  .SH "SEE ALSO"
2782  .rs  .rs
2783  .sp  .sp
2784  \fBpcre16\fP(3), \fBpcrebuild\fP(3), \fBpcrecallout\fP(3), \fBpcrecpp(3)\fP(3),  \fBpcre16\fP(3), \fBpcre32\fP(3), \fBpcrebuild\fP(3), \fBpcrecallout\fP(3),
2785  \fBpcrematching\fP(3), \fBpcrepartial\fP(3), \fBpcreposix\fP(3),  \fBpcrecpp(3)\fP(3), \fBpcrematching\fP(3), \fBpcrepartial\fP(3),
2786  \fBpcreprecompile\fP(3), \fBpcresample\fP(3), \fBpcrestack\fP(3).  \fBpcreposix\fP(3), \fBpcreprecompile\fP(3), \fBpcresample\fP(3),
2787    \fBpcrestack\fP(3).
2788  .  .
2789  .  .
2790  .SH AUTHOR  .SH AUTHOR

Legend:
Removed from v.1031  
changed lines
  Added in v.1113

  ViewVC Help
Powered by ViewVC 1.1.5