/[pcre]/code/trunk/doc/pcre.txt
ViewVC logotype

Diff of /code/trunk/doc/pcre.txt

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

revision 291 by ph10, Sun Dec 23 12:17:20 2007 UTC revision 292 by ph10, Thu Dec 27 09:27:23 2007 UTC
# Line 1356  COMPILATION ERROR CODES Line 1356  COMPILATION ERROR CODES
1356            9  nothing to repeat            9  nothing to repeat
1357           10  [this code is not in use]           10  [this code is not in use]
1358           11  internal error: unexpected repeat           11  internal error: unexpected repeat
1359           12  unrecognized character after (?           12  unrecognized character after (? or (?-
1360           13  POSIX named classes are supported only within a class           13  POSIX named classes are supported only within a class
1361           14  missing )           14  missing )
1362           15  reference to non-existent subpattern           15  reference to non-existent subpattern
# Line 1364  COMPILATION ERROR CODES Line 1364  COMPILATION ERROR CODES
1364           17  unknown option bit(s) set           17  unknown option bit(s) set
1365           18  missing ) after comment           18  missing ) after comment
1366           19  [this code is not in use]           19  [this code is not in use]
1367           20  regular expression too large           20  regular expression is too large
1368           21  failed to get memory           21  failed to get memory
1369           22  unmatched parentheses           22  unmatched parentheses
1370           23  internal error: code overflow           23  internal error: code overflow
# Line 1393  COMPILATION ERROR CODES Line 1393  COMPILATION ERROR CODES
1393           46  malformed \P or \p sequence           46  malformed \P or \p sequence
1394           47  unknown property name after \P or \p           47  unknown property name after \P or \p
1395           48  subpattern name is too long (maximum 32 characters)           48  subpattern name is too long (maximum 32 characters)
1396           49  too many named subpatterns (maximum 10,000)           49  too many named subpatterns (maximum 10000)
1397           50  [this code is not in use]           50  [this code is not in use]
1398           51  octal value is greater than \377 (not in UTF-8 mode)           51  octal value is greater than \377 (not in UTF-8 mode)
1399           52  internal error: overran compiling workspace           52  internal error: overran compiling workspace
# Line 1405  COMPILATION ERROR CODES Line 1405  COMPILATION ERROR CODES
1405           57  \g is not followed by a braced name or an optionally braced           57  \g is not followed by a braced name or an optionally braced
1406                 non-zero number                 non-zero number
1407           58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number           58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number
1408             59  (*VERB) with an argument is not supported
1409             60  (*VERB) not recognized
1410             61  number is too big
1411             62  subpattern name expected
1412             63  digit expected after (?+
1413    
1414           The numbers 32 and 10000 in errors 48 and 49  are  defaults;  different
1415           values may be used if the limits were changed when PCRE was built.
1416    
1417    
1418  STUDYING A PATTERN  STUDYING A PATTERN
# Line 1412  STUDYING A PATTERN Line 1420  STUDYING A PATTERN
1420         pcre_extra *pcre_study(const pcre *code, int options         pcre_extra *pcre_study(const pcre *code, int options
1421              const char **errptr);              const char **errptr);
1422    
1423         If a compiled pattern is going to be used several times,  it  is  worth         If  a  compiled  pattern is going to be used several times, it is worth
1424         spending more time analyzing it in order to speed up the time taken for         spending more time analyzing it in order to speed up the time taken for
1425         matching. The function pcre_study() takes a pointer to a compiled  pat-         matching.  The function pcre_study() takes a pointer to a compiled pat-
1426         tern as its first argument. If studying the pattern produces additional         tern as its first argument. If studying the pattern produces additional
1427         information that will help speed up matching,  pcre_study()  returns  a         information  that  will  help speed up matching, pcre_study() returns a
1428         pointer  to a pcre_extra block, in which the study_data field points to         pointer to a pcre_extra block, in which the study_data field points  to
1429         the results of the study.         the results of the study.
1430    
1431         The  returned  value  from  pcre_study()  can  be  passed  directly  to         The  returned  value  from  pcre_study()  can  be  passed  directly  to
1432         pcre_exec().  However,  a  pcre_extra  block also contains other fields         pcre_exec(). However, a pcre_extra block  also  contains  other  fields
1433         that can be set by the caller before the block  is  passed;  these  are         that  can  be  set  by the caller before the block is passed; these are
1434         described below in the section on matching a pattern.         described below in the section on matching a pattern.
1435    
1436         If  studying  the  pattern  does not produce any additional information         If studying the pattern does not  produce  any  additional  information
1437         pcre_study() returns NULL. In that circumstance, if the calling program         pcre_study() returns NULL. In that circumstance, if the calling program
1438         wants  to  pass  any of the other fields to pcre_exec(), it must set up         wants to pass any of the other fields to pcre_exec(), it  must  set  up
1439         its own pcre_extra block.         its own pcre_extra block.
1440    
1441         The second argument of pcre_study() contains option bits.  At  present,         The  second  argument of pcre_study() contains option bits. At present,
1442         no options are defined, and this argument should always be zero.         no options are defined, and this argument should always be zero.
1443    
1444         The  third argument for pcre_study() is a pointer for an error message.         The third argument for pcre_study() is a pointer for an error  message.
1445         If studying succeeds (even if no data is  returned),  the  variable  it         If  studying  succeeds  (even  if no data is returned), the variable it
1446         points  to  is  set  to NULL. Otherwise it is set to point to a textual         points to is set to NULL. Otherwise it is set to  point  to  a  textual
1447         error message. This is a static string that is part of the library. You         error message. This is a static string that is part of the library. You
1448         must  not  try  to  free it. You should test the error pointer for NULL         must not try to free it. You should test the  error  pointer  for  NULL
1449         after calling pcre_study(), to be sure that it has run successfully.         after calling pcre_study(), to be sure that it has run successfully.
1450    
1451         This is a typical call to pcre_study():         This is a typical call to pcre_study():
# Line 1449  STUDYING A PATTERN Line 1457  STUDYING A PATTERN
1457             &error);        /* set to NULL or points to a message */             &error);        /* set to NULL or points to a message */
1458    
1459         At present, studying a pattern is useful only for non-anchored patterns         At present, studying a pattern is useful only for non-anchored patterns
1460         that  do not have a single fixed starting character. A bitmap of possi-         that do not have a single fixed starting character. A bitmap of  possi-
1461         ble starting bytes is created.         ble starting bytes is created.
1462    
1463    
1464  LOCALE SUPPORT  LOCALE SUPPORT
1465    
1466         PCRE handles caseless matching, and determines whether  characters  are         PCRE  handles  caseless matching, and determines whether characters are
1467         letters,  digits, or whatever, by reference to a set of tables, indexed         letters, digits, or whatever, by reference to a set of tables,  indexed
1468         by character value. When running in UTF-8 mode, this  applies  only  to         by  character  value.  When running in UTF-8 mode, this applies only to
1469         characters  with  codes  less than 128. Higher-valued codes never match         characters with codes less than 128. Higher-valued  codes  never  match
1470         escapes such as \w or \d, but can be tested with \p if  PCRE  is  built         escapes  such  as  \w or \d, but can be tested with \p if PCRE is built
1471         with  Unicode  character property support. The use of locales with Uni-         with Unicode character property support. The use of locales  with  Uni-
1472         code is discouraged. If you are handling characters with codes  greater         code  is discouraged. If you are handling characters with codes greater
1473         than  128, you should either use UTF-8 and Unicode, or use locales, but         than 128, you should either use UTF-8 and Unicode, or use locales,  but
1474         not try to mix the two.         not try to mix the two.
1475    
1476         PCRE contains an internal set of tables that are used  when  the  final         PCRE  contains  an  internal set of tables that are used when the final
1477         argument  of  pcre_compile()  is  NULL.  These  are sufficient for many         argument of pcre_compile() is  NULL.  These  are  sufficient  for  many
1478         applications.  Normally, the internal tables recognize only ASCII char-         applications.  Normally, the internal tables recognize only ASCII char-
1479         acters. However, when PCRE is built, it is possible to cause the inter-         acters. However, when PCRE is built, it is possible to cause the inter-
1480         nal tables to be rebuilt in the default "C" locale of the local system,         nal tables to be rebuilt in the default "C" locale of the local system,
1481         which may cause them to be different.         which may cause them to be different.
1482    
1483         The  internal tables can always be overridden by tables supplied by the         The internal tables can always be overridden by tables supplied by  the
1484         application that calls PCRE. These may be created in a different locale         application that calls PCRE. These may be created in a different locale
1485         from  the  default.  As more and more applications change to using Uni-         from the default. As more and more applications change  to  using  Uni-
1486         code, the need for this locale support is expected to die away.         code, the need for this locale support is expected to die away.
1487    
1488         External tables are built by calling  the  pcre_maketables()  function,         External  tables  are  built by calling the pcre_maketables() function,
1489         which  has no arguments, in the relevant locale. The result can then be         which has no arguments, in the relevant locale. The result can then  be
1490         passed to pcre_compile() or pcre_exec()  as  often  as  necessary.  For         passed  to  pcre_compile()  or  pcre_exec()  as often as necessary. For
1491         example,  to  build  and use tables that are appropriate for the French         example, to build and use tables that are appropriate  for  the  French
1492         locale (where accented characters with  values  greater  than  128  are         locale  (where  accented  characters  with  values greater than 128 are
1493         treated as letters), the following code could be used:         treated as letters), the following code could be used:
1494    
1495           setlocale(LC_CTYPE, "fr_FR");           setlocale(LC_CTYPE, "fr_FR");
1496           tables = pcre_maketables();           tables = pcre_maketables();
1497           re = pcre_compile(..., tables);           re = pcre_compile(..., tables);
1498    
1499         The  locale  name "fr_FR" is used on Linux and other Unix-like systems;         The locale name "fr_FR" is used on Linux and other  Unix-like  systems;
1500         if you are using Windows, the name for the French locale is "french".         if you are using Windows, the name for the French locale is "french".
1501    
1502         When pcre_maketables() runs, the tables are built  in  memory  that  is         When  pcre_maketables()  runs,  the  tables are built in memory that is
1503         obtained  via  pcre_malloc. It is the caller's responsibility to ensure         obtained via pcre_malloc. It is the caller's responsibility  to  ensure
1504         that the memory containing the tables remains available for as long  as         that  the memory containing the tables remains available for as long as
1505         it is needed.         it is needed.
1506    
1507         The pointer that is passed to pcre_compile() is saved with the compiled         The pointer that is passed to pcre_compile() is saved with the compiled
1508         pattern, and the same tables are used via this pointer by  pcre_study()         pattern,  and the same tables are used via this pointer by pcre_study()
1509         and normally also by pcre_exec(). Thus, by default, for any single pat-         and normally also by pcre_exec(). Thus, by default, for any single pat-
1510         tern, compilation, studying and matching all happen in the same locale,         tern, compilation, studying and matching all happen in the same locale,
1511         but different patterns can be compiled in different locales.         but different patterns can be compiled in different locales.
1512    
1513         It  is  possible to pass a table pointer or NULL (indicating the use of         It is possible to pass a table pointer or NULL (indicating the  use  of
1514         the internal tables) to pcre_exec(). Although  not  intended  for  this         the  internal  tables)  to  pcre_exec(). Although not intended for this
1515         purpose,  this facility could be used to match a pattern in a different         purpose, this facility could be used to match a pattern in a  different
1516         locale from the one in which it was compiled. Passing table pointers at         locale from the one in which it was compiled. Passing table pointers at
1517         run time is discussed below in the section on matching a pattern.         run time is discussed below in the section on matching a pattern.
1518    
# Line 1514  INFORMATION ABOUT A PATTERN Line 1522  INFORMATION ABOUT A PATTERN
1522         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,         int pcre_fullinfo(const pcre *code, const pcre_extra *extra,
1523              int what, void *where);              int what, void *where);
1524    
1525         The  pcre_fullinfo() function returns information about a compiled pat-         The pcre_fullinfo() function returns information about a compiled  pat-
1526         tern. It replaces the obsolete pcre_info() function, which is neverthe-         tern. It replaces the obsolete pcre_info() function, which is neverthe-
1527         less retained for backwards compability (and is documented below).         less retained for backwards compability (and is documented below).
1528    
1529         The  first  argument  for  pcre_fullinfo() is a pointer to the compiled         The first argument for pcre_fullinfo() is a  pointer  to  the  compiled
1530         pattern. The second argument is the result of pcre_study(), or NULL  if         pattern.  The second argument is the result of pcre_study(), or NULL if
1531         the  pattern  was not studied. The third argument specifies which piece         the pattern was not studied. The third argument specifies  which  piece
1532         of information is required, and the fourth argument is a pointer  to  a         of  information  is required, and the fourth argument is a pointer to a
1533         variable  to  receive  the  data. The yield of the function is zero for         variable to receive the data. The yield of the  function  is  zero  for
1534         success, or one of the following negative numbers:         success, or one of the following negative numbers:
1535    
1536           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL       the argument code was NULL
# Line 1530  INFORMATION ABOUT A PATTERN Line 1538  INFORMATION ABOUT A PATTERN
1538           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC   the "magic number" was not found
1539           PCRE_ERROR_BADOPTION  the value of what was invalid           PCRE_ERROR_BADOPTION  the value of what was invalid
1540    
1541         The "magic number" is placed at the start of each compiled  pattern  as         The  "magic  number" is placed at the start of each compiled pattern as
1542         an  simple check against passing an arbitrary memory pointer. Here is a         an simple check against passing an arbitrary memory pointer. Here is  a
1543         typical call of pcre_fullinfo(), to obtain the length of  the  compiled         typical  call  of pcre_fullinfo(), to obtain the length of the compiled
1544         pattern:         pattern:
1545    
1546           int rc;           int rc;
# Line 1543  INFORMATION ABOUT A PATTERN Line 1551  INFORMATION ABOUT A PATTERN
1551             PCRE_INFO_SIZE,   /* what is required */             PCRE_INFO_SIZE,   /* what is required */
1552             &length);         /* where to put the data */             &length);         /* where to put the data */
1553    
1554         The  possible  values for the third argument are defined in pcre.h, and         The possible values for the third argument are defined in  pcre.h,  and
1555         are as follows:         are as follows:
1556    
1557           PCRE_INFO_BACKREFMAX           PCRE_INFO_BACKREFMAX
1558    
1559         Return the number of the highest back reference  in  the  pattern.  The         Return  the  number  of  the highest back reference in the pattern. The
1560         fourth  argument  should  point to an int variable. Zero is returned if         fourth argument should point to an int variable. Zero  is  returned  if
1561         there are no back references.         there are no back references.
1562    
1563           PCRE_INFO_CAPTURECOUNT           PCRE_INFO_CAPTURECOUNT
1564    
1565         Return the number of capturing subpatterns in the pattern.  The  fourth         Return  the  number of capturing subpatterns in the pattern. The fourth
1566         argument should point to an int variable.         argument should point to an int variable.
1567    
1568           PCRE_INFO_DEFAULT_TABLES           PCRE_INFO_DEFAULT_TABLES
1569    
1570         Return  a pointer to the internal default character tables within PCRE.         Return a pointer to the internal default character tables within  PCRE.
1571         The fourth argument should point to an unsigned char *  variable.  This         The  fourth  argument should point to an unsigned char * variable. This
1572         information call is provided for internal use by the pcre_study() func-         information call is provided for internal use by the pcre_study() func-
1573         tion. External callers can cause PCRE to use  its  internal  tables  by         tion.  External  callers  can  cause PCRE to use its internal tables by
1574         passing a NULL table pointer.         passing a NULL table pointer.
1575    
1576           PCRE_INFO_FIRSTBYTE           PCRE_INFO_FIRSTBYTE
1577    
1578         Return  information  about  the first byte of any matched string, for a         Return information about the first byte of any matched  string,  for  a
1579         non-anchored pattern. The fourth argument should point to an int  vari-         non-anchored  pattern. The fourth argument should point to an int vari-
1580         able.  (This option used to be called PCRE_INFO_FIRSTCHAR; the old name         able. (This option used to be called PCRE_INFO_FIRSTCHAR; the old  name
1581         is still recognized for backwards compatibility.)         is still recognized for backwards compatibility.)
1582    
1583         If there is a fixed first byte, for example, from  a  pattern  such  as         If  there  is  a  fixed first byte, for example, from a pattern such as
1584         (cat|cow|coyote), its value is returned. Otherwise, if either         (cat|cow|coyote), its value is returned. Otherwise, if either
1585    
1586         (a)  the pattern was compiled with the PCRE_MULTILINE option, and every         (a) the pattern was compiled with the PCRE_MULTILINE option, and  every
1587         branch starts with "^", or         branch starts with "^", or
1588    
1589         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not         (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not
1590         set (if it were set, the pattern would be anchored),         set (if it were set, the pattern would be anchored),
1591    
1592         -1  is  returned, indicating that the pattern matches only at the start         -1 is returned, indicating that the pattern matches only at  the  start
1593         of a subject string or after any newline within the  string.  Otherwise         of  a  subject string or after any newline within the string. Otherwise
1594         -2 is returned. For anchored patterns, -2 is returned.         -2 is returned. For anchored patterns, -2 is returned.
1595    
1596           PCRE_INFO_FIRSTTABLE           PCRE_INFO_FIRSTTABLE
1597    
1598         If  the pattern was studied, and this resulted in the construction of a         If the pattern was studied, and this resulted in the construction of  a
1599         256-bit table indicating a fixed set of bytes for the first byte in any         256-bit table indicating a fixed set of bytes for the first byte in any
1600         matching  string, a pointer to the table is returned. Otherwise NULL is         matching string, a pointer to the table is returned. Otherwise NULL  is
1601         returned. The fourth argument should point to an unsigned char *  vari-         returned.  The fourth argument should point to an unsigned char * vari-
1602         able.         able.
1603    
1604           PCRE_INFO_HASCRORLF           PCRE_INFO_HASCRORLF
1605    
1606         Return  1  if  the  pattern  contains any explicit matches for CR or LF         Return 1 if the pattern contains any explicit  matches  for  CR  or  LF
1607         characters, otherwise 0. The fourth argument should  point  to  an  int         characters,  otherwise  0.  The  fourth argument should point to an int
1608         variable.  An explicit match is either a literal CR or LF character, or         variable. An explicit match is either a literal CR or LF character,  or
1609         \r or \n.         \r or \n.
1610    
1611           PCRE_INFO_JCHANGED           PCRE_INFO_JCHANGED
1612    
1613         Return 1 if the (?J) or (?-J) option setting is used  in  the  pattern,         Return  1  if  the (?J) or (?-J) option setting is used in the pattern,
1614         otherwise  0. The fourth argument should point to an int variable. (?J)         otherwise 0. The fourth argument should point to an int variable.  (?J)
1615         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.         and (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
1616    
1617           PCRE_INFO_LASTLITERAL           PCRE_INFO_LASTLITERAL
1618    
1619         Return the value of the rightmost literal byte that must exist  in  any         Return  the  value of the rightmost literal byte that must exist in any
1620         matched  string,  other  than  at  its  start,  if such a byte has been         matched string, other than at its  start,  if  such  a  byte  has  been
1621         recorded. The fourth argument should point to an int variable. If there         recorded. The fourth argument should point to an int variable. If there
1622         is  no such byte, -1 is returned. For anchored patterns, a last literal         is no such byte, -1 is returned. For anchored patterns, a last  literal
1623         byte is recorded only if it follows something of variable  length.  For         byte  is  recorded only if it follows something of variable length. For
1624         example, for the pattern /^a\d+z\d+/ the returned value is "z", but for         example, for the pattern /^a\d+z\d+/ the returned value is "z", but for
1625         /^a\dz\d/ the returned value is -1.         /^a\dz\d/ the returned value is -1.
1626    
# Line 1620  INFORMATION ABOUT A PATTERN Line 1628  INFORMATION ABOUT A PATTERN
1628           PCRE_INFO_NAMEENTRYSIZE           PCRE_INFO_NAMEENTRYSIZE
1629           PCRE_INFO_NAMETABLE           PCRE_INFO_NAMETABLE
1630    
1631         PCRE supports the use of named as well as numbered capturing  parenthe-         PCRE  supports the use of named as well as numbered capturing parenthe-
1632         ses.  The names are just an additional way of identifying the parenthe-         ses. The names are just an additional way of identifying the  parenthe-
1633         ses, which still acquire numbers. Several convenience functions such as         ses, which still acquire numbers. Several convenience functions such as
1634         pcre_get_named_substring()  are  provided  for extracting captured sub-         pcre_get_named_substring() are provided for  extracting  captured  sub-
1635         strings by name. It is also possible to extract the data  directly,  by         strings  by  name. It is also possible to extract the data directly, by
1636         first  converting  the  name to a number in order to access the correct         first converting the name to a number in order to  access  the  correct
1637         pointers in the output vector (described with pcre_exec() below). To do         pointers in the output vector (described with pcre_exec() below). To do
1638         the  conversion,  you  need  to  use  the  name-to-number map, which is         the conversion, you need  to  use  the  name-to-number  map,  which  is
1639         described by these three values.         described by these three values.
1640    
1641         The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT         The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT
1642         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size         gives the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size
1643         of each entry; both of these  return  an  int  value.  The  entry  size         of  each  entry;  both  of  these  return  an int value. The entry size
1644         depends  on the length of the longest name. PCRE_INFO_NAMETABLE returns         depends on the length of the longest name. PCRE_INFO_NAMETABLE  returns
1645         a pointer to the first entry of the table  (a  pointer  to  char).  The         a  pointer  to  the  first  entry of the table (a pointer to char). The
1646         first two bytes of each entry are the number of the capturing parenthe-         first two bytes of each entry are the number of the capturing parenthe-
1647         sis, most significant byte first. The rest of the entry is  the  corre-         sis,  most  significant byte first. The rest of the entry is the corre-
1648         sponding  name,  zero  terminated. The names are in alphabetical order.         sponding name, zero terminated. The names are  in  alphabetical  order.
1649         When PCRE_DUPNAMES is set, duplicate names are in order of their paren-         When PCRE_DUPNAMES is set, duplicate names are in order of their paren-
1650         theses  numbers.  For  example,  consider the following pattern (assume         theses numbers. For example, consider  the  following  pattern  (assume
1651         PCRE_EXTENDED is  set,  so  white  space  -  including  newlines  -  is         PCRE_EXTENDED  is  set,  so  white  space  -  including  newlines  - is
1652         ignored):         ignored):
1653    
1654           (?<date> (?<year>(\d\d)?\d\d) -           (?<date> (?<year>(\d\d)?\d\d) -
1655           (?<month>\d\d) - (?<day>\d\d) )           (?<month>\d\d) - (?<day>\d\d) )
1656    
1657         There  are  four  named subpatterns, so the table has four entries, and         There are four named subpatterns, so the table has  four  entries,  and
1658         each entry in the table is eight bytes long. The table is  as  follows,         each  entry  in the table is eight bytes long. The table is as follows,
1659         with non-printing bytes shows in hexadecimal, and undefined bytes shown         with non-printing bytes shows in hexadecimal, and undefined bytes shown
1660         as ??:         as ??:
1661    
# Line 1656  INFORMATION ABOUT A PATTERN Line 1664  INFORMATION ABOUT A PATTERN
1664           00 04 m  o  n  t  h  00           00 04 m  o  n  t  h  00
1665           00 02 y  e  a  r  00 ??           00 02 y  e  a  r  00 ??
1666    
1667         When writing code to extract data  from  named  subpatterns  using  the         When  writing  code  to  extract  data from named subpatterns using the
1668         name-to-number  map,  remember that the length of the entries is likely         name-to-number map, remember that the length of the entries  is  likely
1669         to be different for each compiled pattern.         to be different for each compiled pattern.
1670    
1671           PCRE_INFO_OKPARTIAL           PCRE_INFO_OKPARTIAL
1672    
1673         Return 1 if the pattern can be used for partial matching, otherwise  0.         Return  1 if the pattern can be used for partial matching, otherwise 0.
1674         The  fourth  argument  should point to an int variable. The pcrepartial         The fourth argument should point to an int  variable.  The  pcrepartial
1675         documentation lists the restrictions that apply to patterns  when  par-         documentation  lists  the restrictions that apply to patterns when par-
1676         tial matching is used.         tial matching is used.
1677    
1678           PCRE_INFO_OPTIONS           PCRE_INFO_OPTIONS
1679    
1680         Return  a  copy of the options with which the pattern was compiled. The         Return a copy of the options with which the pattern was  compiled.  The
1681         fourth argument should point to an unsigned long  int  variable.  These         fourth  argument  should  point to an unsigned long int variable. These
1682         option bits are those specified in the call to pcre_compile(), modified         option bits are those specified in the call to pcre_compile(), modified
1683         by any top-level option settings at the start of the pattern itself. In         by any top-level option settings at the start of the pattern itself. In
1684         other  words,  they are the options that will be in force when matching         other words, they are the options that will be in force  when  matching
1685         starts. For example, if the pattern /(?im)abc(?-i)d/ is  compiled  with         starts.  For  example, if the pattern /(?im)abc(?-i)d/ is compiled with
1686         the  PCRE_EXTENDED option, the result is PCRE_CASELESS, PCRE_MULTILINE,         the PCRE_EXTENDED option, the result is PCRE_CASELESS,  PCRE_MULTILINE,
1687         and PCRE_EXTENDED.         and PCRE_EXTENDED.
1688    
1689         A pattern is automatically anchored by PCRE if  all  of  its  top-level         A  pattern  is  automatically  anchored by PCRE if all of its top-level
1690         alternatives begin with one of the following:         alternatives begin with one of the following:
1691    
1692           ^     unless PCRE_MULTILINE is set           ^     unless PCRE_MULTILINE is set
# Line 1692  INFORMATION ABOUT A PATTERN Line 1700  INFORMATION ABOUT A PATTERN
1700    
1701           PCRE_INFO_SIZE           PCRE_INFO_SIZE
1702    
1703         Return the size of the compiled pattern, that is, the  value  that  was         Return  the  size  of the compiled pattern, that is, the value that was
1704         passed as the argument to pcre_malloc() when PCRE was getting memory in         passed as the argument to pcre_malloc() when PCRE was getting memory in
1705         which to place the compiled data. The fourth argument should point to a         which to place the compiled data. The fourth argument should point to a
1706         size_t variable.         size_t variable.
# Line 1700  INFORMATION ABOUT A PATTERN Line 1708  INFORMATION ABOUT A PATTERN
1708           PCRE_INFO_STUDYSIZE           PCRE_INFO_STUDYSIZE
1709    
1710         Return the size of the data block pointed to by the study_data field in         Return the size of the data block pointed to by the study_data field in
1711         a pcre_extra block. That is,  it  is  the  value  that  was  passed  to         a  pcre_extra  block.  That  is,  it  is  the  value that was passed to
1712         pcre_malloc() when PCRE was getting memory into which to place the data         pcre_malloc() when PCRE was getting memory into which to place the data
1713         created by pcre_study(). The fourth argument should point to  a  size_t         created  by  pcre_study(). The fourth argument should point to a size_t
1714         variable.         variable.
1715    
1716    
# Line 1710  OBSOLETE INFO FUNCTION Line 1718  OBSOLETE INFO FUNCTION
1718    
1719         int pcre_info(const pcre *code, int *optptr, int *firstcharptr);         int pcre_info(const pcre *code, int *optptr, int *firstcharptr);
1720    
1721         The  pcre_info()  function is now obsolete because its interface is too         The pcre_info() function is now obsolete because its interface  is  too
1722         restrictive to return all the available data about a compiled  pattern.         restrictive  to return all the available data about a compiled pattern.
1723         New   programs   should  use  pcre_fullinfo()  instead.  The  yield  of         New  programs  should  use  pcre_fullinfo()  instead.  The   yield   of
1724         pcre_info() is the number of capturing subpatterns, or one of the  fol-         pcre_info()  is the number of capturing subpatterns, or one of the fol-
1725         lowing negative numbers:         lowing negative numbers:
1726    
1727           PCRE_ERROR_NULL       the argument code was NULL           PCRE_ERROR_NULL       the argument code was NULL
1728           PCRE_ERROR_BADMAGIC   the "magic number" was not found           PCRE_ERROR_BADMAGIC   the "magic number" was not found
1729    
1730         If  the  optptr  argument is not NULL, a copy of the options with which         If the optptr argument is not NULL, a copy of the  options  with  which
1731         the pattern was compiled is placed in the integer  it  points  to  (see         the  pattern  was  compiled  is placed in the integer it points to (see
1732         PCRE_INFO_OPTIONS above).         PCRE_INFO_OPTIONS above).
1733    
1734         If  the  pattern  is  not anchored and the firstcharptr argument is not         If the pattern is not anchored and the  firstcharptr  argument  is  not
1735         NULL, it is used to pass back information about the first character  of         NULL,  it is used to pass back information about the first character of
1736         any matched string (see PCRE_INFO_FIRSTBYTE above).         any matched string (see PCRE_INFO_FIRSTBYTE above).
1737    
1738    
# Line 1732  REFERENCE COUNTS Line 1740  REFERENCE COUNTS
1740    
1741         int pcre_refcount(pcre *code, int adjust);         int pcre_refcount(pcre *code, int adjust);
1742    
1743         The  pcre_refcount()  function is used to maintain a reference count in         The pcre_refcount() function is used to maintain a reference  count  in
1744         the data block that contains a compiled pattern. It is provided for the         the data block that contains a compiled pattern. It is provided for the
1745         benefit  of  applications  that  operate  in an object-oriented manner,         benefit of applications that  operate  in  an  object-oriented  manner,
1746         where different parts of the application may be using the same compiled         where different parts of the application may be using the same compiled
1747         pattern, but you want to free the block when they are all done.         pattern, but you want to free the block when they are all done.
1748    
1749         When a pattern is compiled, the reference count field is initialized to         When a pattern is compiled, the reference count field is initialized to
1750         zero.  It is changed only by calling this function, whose action is  to         zero.   It is changed only by calling this function, whose action is to
1751         add  the  adjust  value  (which may be positive or negative) to it. The         add the adjust value (which may be positive or  negative)  to  it.  The
1752         yield of the function is the new value. However, the value of the count         yield of the function is the new value. However, the value of the count
1753         is  constrained to lie between 0 and 65535, inclusive. If the new value         is constrained to lie between 0 and 65535, inclusive. If the new  value
1754         is outside these limits, it is forced to the appropriate limit value.         is outside these limits, it is forced to the appropriate limit value.
1755    
1756         Except when it is zero, the reference count is not correctly  preserved         Except  when it is zero, the reference count is not correctly preserved
1757         if  a  pattern  is  compiled on one host and then transferred to a host         if a pattern is compiled on one host and then  transferred  to  a  host
1758         whose byte-order is different. (This seems a highly unlikely scenario.)         whose byte-order is different. (This seems a highly unlikely scenario.)
1759    
1760    
# Line 1756  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1764  MATCHING A PATTERN: THE TRADITIONAL FUNC
1764              const char *subject, int length, int startoffset,              const char *subject, int length, int startoffset,
1765              int options, int *ovector, int ovecsize);              int options, int *ovector, int ovecsize);
1766    
1767         The  function pcre_exec() is called to match a subject string against a         The function pcre_exec() is called to match a subject string against  a
1768         compiled pattern, which is passed in the code argument. If the  pattern         compiled  pattern, which is passed in the code argument. If the pattern
1769         has been studied, the result of the study should be passed in the extra         has been studied, the result of the study should be passed in the extra
1770         argument. This function is the main matching facility of  the  library,         argument.  This  function is the main matching facility of the library,
1771         and it operates in a Perl-like manner. For specialist use there is also         and it operates in a Perl-like manner. For specialist use there is also
1772         an alternative matching function, which is described below in the  sec-         an  alternative matching function, which is described below in the sec-
1773         tion about the pcre_dfa_exec() function.         tion about the pcre_dfa_exec() function.
1774    
1775         In  most applications, the pattern will have been compiled (and option-         In most applications, the pattern will have been compiled (and  option-
1776         ally studied) in the same process that calls pcre_exec().  However,  it         ally  studied)  in the same process that calls pcre_exec(). However, it
1777         is possible to save compiled patterns and study data, and then use them         is possible to save compiled patterns and study data, and then use them
1778         later in different processes, possibly even on different hosts.  For  a         later  in  different processes, possibly even on different hosts. For a
1779         discussion about this, see the pcreprecompile documentation.         discussion about this, see the pcreprecompile documentation.
1780    
1781         Here is an example of a simple call to pcre_exec():         Here is an example of a simple call to pcre_exec():
# Line 1786  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1794  MATCHING A PATTERN: THE TRADITIONAL FUNC
1794    
1795     Extra data for pcre_exec()     Extra data for pcre_exec()
1796    
1797         If  the  extra argument is not NULL, it must point to a pcre_extra data         If the extra argument is not NULL, it must point to a  pcre_extra  data
1798         block. The pcre_study() function returns such a block (when it  doesn't         block.  The pcre_study() function returns such a block (when it doesn't
1799         return  NULL), but you can also create one for yourself, and pass addi-         return NULL), but you can also create one for yourself, and pass  addi-
1800         tional information in it. The pcre_extra block contains  the  following         tional  information  in it. The pcre_extra block contains the following
1801         fields (not necessarily in this order):         fields (not necessarily in this order):
1802    
1803           unsigned long int flags;           unsigned long int flags;
# Line 1799  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1807  MATCHING A PATTERN: THE TRADITIONAL FUNC
1807           void *callout_data;           void *callout_data;
1808           const unsigned char *tables;           const unsigned char *tables;
1809    
1810         The  flags  field  is a bitmap that specifies which of the other fields         The flags field is a bitmap that specifies which of  the  other  fields
1811         are set. The flag bits are:         are set. The flag bits are:
1812    
1813           PCRE_EXTRA_STUDY_DATA           PCRE_EXTRA_STUDY_DATA
# Line 1808  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1816  MATCHING A PATTERN: THE TRADITIONAL FUNC
1816           PCRE_EXTRA_CALLOUT_DATA           PCRE_EXTRA_CALLOUT_DATA
1817           PCRE_EXTRA_TABLES           PCRE_EXTRA_TABLES
1818    
1819         Other flag bits should be set to zero. The study_data field is  set  in         Other  flag  bits should be set to zero. The study_data field is set in
1820         the  pcre_extra  block  that is returned by pcre_study(), together with         the pcre_extra block that is returned by  pcre_study(),  together  with
1821         the appropriate flag bit. You should not set this yourself, but you may         the appropriate flag bit. You should not set this yourself, but you may
1822         add  to  the  block by setting the other fields and their corresponding         add to the block by setting the other fields  and  their  corresponding
1823         flag bits.         flag bits.
1824    
1825         The match_limit field provides a means of preventing PCRE from using up         The match_limit field provides a means of preventing PCRE from using up
1826         a  vast amount of resources when running patterns that are not going to         a vast amount of resources when running patterns that are not going  to
1827         match, but which have a very large number  of  possibilities  in  their         match,  but  which  have  a very large number of possibilities in their
1828         search  trees.  The  classic  example  is  the  use of nested unlimited         search trees. The classic  example  is  the  use  of  nested  unlimited
1829         repeats.         repeats.
1830    
1831         Internally, PCRE uses a function called match() which it calls  repeat-         Internally,  PCRE uses a function called match() which it calls repeat-
1832         edly  (sometimes  recursively). The limit set by match_limit is imposed         edly (sometimes recursively). The limit set by match_limit  is  imposed
1833         on the number of times this function is called during  a  match,  which         on  the  number  of times this function is called during a match, which
1834         has  the  effect  of  limiting the amount of backtracking that can take         has the effect of limiting the amount of  backtracking  that  can  take
1835         place. For patterns that are not anchored, the count restarts from zero         place. For patterns that are not anchored, the count restarts from zero
1836         for each position in the subject string.         for each position in the subject string.
1837    
1838         The  default  value  for  the  limit can be set when PCRE is built; the         The default value for the limit can be set  when  PCRE  is  built;  the
1839         default default is 10 million, which handles all but the  most  extreme         default  default  is 10 million, which handles all but the most extreme
1840         cases.  You  can  override  the  default by suppling pcre_exec() with a         cases. You can override the default  by  suppling  pcre_exec()  with  a
1841         pcre_extra    block    in    which    match_limit    is    set,     and         pcre_extra     block    in    which    match_limit    is    set,    and
1842         PCRE_EXTRA_MATCH_LIMIT  is  set  in  the  flags  field. If the limit is         PCRE_EXTRA_MATCH_LIMIT is set in the  flags  field.  If  the  limit  is
1843         exceeded, pcre_exec() returns PCRE_ERROR_MATCHLIMIT.         exceeded, pcre_exec() returns PCRE_ERROR_MATCHLIMIT.
1844    
1845         The match_limit_recursion field is similar to match_limit, but  instead         The  match_limit_recursion field is similar to match_limit, but instead
1846         of limiting the total number of times that match() is called, it limits         of limiting the total number of times that match() is called, it limits
1847         the depth of recursion. The recursion depth is a  smaller  number  than         the  depth  of  recursion. The recursion depth is a smaller number than
1848         the  total number of calls, because not all calls to match() are recur-         the total number of calls, because not all calls to match() are  recur-
1849         sive.  This limit is of use only if it is set smaller than match_limit.         sive.  This limit is of use only if it is set smaller than match_limit.
1850    
1851         Limiting  the  recursion  depth  limits the amount of stack that can be         Limiting the recursion depth limits the amount of  stack  that  can  be
1852         used, or, when PCRE has been compiled to use memory on the heap instead         used, or, when PCRE has been compiled to use memory on the heap instead
1853         of the stack, the amount of heap memory that can be used.         of the stack, the amount of heap memory that can be used.
1854    
1855         The  default  value  for  match_limit_recursion can be set when PCRE is         The default value for match_limit_recursion can be  set  when  PCRE  is
1856         built; the default default  is  the  same  value  as  the  default  for         built;  the  default  default  is  the  same  value  as the default for
1857         match_limit.  You can override the default by suppling pcre_exec() with         match_limit. You can override the default by suppling pcre_exec()  with
1858         a  pcre_extra  block  in  which  match_limit_recursion  is   set,   and         a   pcre_extra   block  in  which  match_limit_recursion  is  set,  and
1859         PCRE_EXTRA_MATCH_LIMIT_RECURSION  is  set  in  the  flags field. If the         PCRE_EXTRA_MATCH_LIMIT_RECURSION is set in  the  flags  field.  If  the
1860         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.         limit is exceeded, pcre_exec() returns PCRE_ERROR_RECURSIONLIMIT.
1861    
1862         The pcre_callout field is used in conjunction with the  "callout"  fea-         The  pcre_callout  field is used in conjunction with the "callout" fea-
1863         ture, which is described in the pcrecallout documentation.         ture, which is described in the pcrecallout documentation.
1864    
1865         The  tables  field  is  used  to  pass  a  character  tables pointer to         The tables field  is  used  to  pass  a  character  tables  pointer  to
1866         pcre_exec(); this overrides the value that is stored with the  compiled         pcre_exec();  this overrides the value that is stored with the compiled
1867         pattern.  A  non-NULL value is stored with the compiled pattern only if         pattern. A non-NULL value is stored with the compiled pattern  only  if
1868         custom tables were supplied to pcre_compile() via  its  tableptr  argu-         custom  tables  were  supplied to pcre_compile() via its tableptr argu-
1869         ment.  If NULL is passed to pcre_exec() using this mechanism, it forces         ment.  If NULL is passed to pcre_exec() using this mechanism, it forces
1870         PCRE's internal tables to be used. This facility is  helpful  when  re-         PCRE's  internal  tables  to be used. This facility is helpful when re-
1871         using  patterns  that  have been saved after compiling with an external         using patterns that have been saved after compiling  with  an  external
1872         set of tables, because the external tables  might  be  at  a  different         set  of  tables,  because  the  external tables might be at a different
1873         address  when  pcre_exec() is called. See the pcreprecompile documenta-         address when pcre_exec() is called. See the  pcreprecompile  documenta-
1874         tion for a discussion of saving compiled patterns for later use.         tion for a discussion of saving compiled patterns for later use.
1875    
1876     Option bits for pcre_exec()     Option bits for pcre_exec()
1877    
1878         The unused bits of the options argument for pcre_exec() must  be  zero.         The  unused  bits of the options argument for pcre_exec() must be zero.
1879         The  only  bits  that  may  be set are PCRE_ANCHORED, PCRE_NEWLINE_xxx,         The only bits that may  be  set  are  PCRE_ANCHORED,  PCRE_NEWLINE_xxx,
1880         PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,   PCRE_NO_UTF8_CHECK   and         PCRE_NOTBOL,   PCRE_NOTEOL,   PCRE_NOTEMPTY,   PCRE_NO_UTF8_CHECK   and
1881         PCRE_PARTIAL.         PCRE_PARTIAL.
1882    
1883           PCRE_ANCHORED           PCRE_ANCHORED
1884    
1885         The  PCRE_ANCHORED  option  limits pcre_exec() to matching at the first         The PCRE_ANCHORED option limits pcre_exec() to matching  at  the  first
1886         matching position. If a pattern was  compiled  with  PCRE_ANCHORED,  or         matching  position.  If  a  pattern was compiled with PCRE_ANCHORED, or
1887         turned  out to be anchored by virtue of its contents, it cannot be made         turned out to be anchored by virtue of its contents, it cannot be  made
1888         unachored at matching time.         unachored at matching time.
1889    
1890           PCRE_BSR_ANYCRLF           PCRE_BSR_ANYCRLF
1891           PCRE_BSR_UNICODE           PCRE_BSR_UNICODE
1892    
1893         These options (which are mutually exclusive) control what the \R escape         These options (which are mutually exclusive) control what the \R escape
1894         sequence  matches.  The choice is either to match only CR, LF, or CRLF,         sequence matches. The choice is either to match only CR, LF,  or  CRLF,
1895         or to match any Unicode newline sequence. These  options  override  the         or  to  match  any Unicode newline sequence. These options override the
1896         choice that was made or defaulted when the pattern was compiled.         choice that was made or defaulted when the pattern was compiled.
1897    
1898           PCRE_NEWLINE_CR           PCRE_NEWLINE_CR
# Line 1893  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 1901  MATCHING A PATTERN: THE TRADITIONAL FUNC
1901           PCRE_NEWLINE_ANYCRLF           PCRE_NEWLINE_ANYCRLF
1902           PCRE_NEWLINE_ANY           PCRE_NEWLINE_ANY
1903    
1904         These  options  override  the  newline  definition  that  was chosen or         These options override  the  newline  definition  that  was  chosen  or
1905         defaulted when the pattern was compiled. For details, see the  descrip-         defaulted  when the pattern was compiled. For details, see the descrip-
1906         tion  of  pcre_compile()  above.  During  matching,  the newline choice         tion of pcre_compile()  above.  During  matching,  the  newline  choice
1907         affects the behaviour of the dot, circumflex,  and  dollar  metacharac-         affects  the  behaviour  of the dot, circumflex, and dollar metacharac-
1908         ters.  It may also alter the way the match position is advanced after a         ters. It may also alter the way the match position is advanced after  a
1909         match failure for an unanchored pattern.         match failure for an unanchored pattern.
1910    
1911         When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF,  or  PCRE_NEWLINE_ANY  is         When  PCRE_NEWLINE_CRLF,  PCRE_NEWLINE_ANYCRLF,  or PCRE_NEWLINE_ANY is
1912         set,  and a match attempt for an unanchored pattern fails when the cur-         set, and a match attempt for an unanchored pattern fails when the  cur-
1913         rent position is at a  CRLF  sequence,  and  the  pattern  contains  no         rent  position  is  at  a  CRLF  sequence,  and the pattern contains no
1914         explicit  matches  for  CR  or  LF  characters,  the  match position is         explicit matches for  CR  or  LF  characters,  the  match  position  is
1915         advanced by two characters instead of one, in other words, to after the         advanced by two characters instead of one, in other words, to after the
1916         CRLF.         CRLF.
1917    
1918         The above rule is a compromise that makes the most common cases work as         The above rule is a compromise that makes the most common cases work as
1919         expected. For example, if the  pattern  is  .+A  (and  the  PCRE_DOTALL         expected.  For  example,  if  the  pattern  is .+A (and the PCRE_DOTALL
1920         option is not set), it does not match the string "\r\nA" because, after         option is not set), it does not match the string "\r\nA" because, after
1921         failing at the start, it skips both the CR and the LF before  retrying.         failing  at the start, it skips both the CR and the LF before retrying.
1922         However,  the  pattern  [\r\n]A does match that string, because it con-         However, the pattern [\r\n]A does match that string,  because  it  con-
1923         tains an explicit CR or LF reference, and so advances only by one char-         tains an explicit CR or LF reference, and so advances only by one char-
1924         acter after the first failure.         acter after the first failure.
1925    
1926         An explicit match for CR of LF is either a literal appearance of one of         An explicit match for CR of LF is either a literal appearance of one of
1927         those characters, or one of the \r or  \n  escape  sequences.  Implicit         those  characters,  or  one  of the \r or \n escape sequences. Implicit
1928         matches  such  as [^X] do not count, nor does \s (which includes CR and         matches such as [^X] do not count, nor does \s (which includes  CR  and
1929         LF in the characters that it matches).         LF in the characters that it matches).
1930    
1931         Notwithstanding the above, anomalous effects may still occur when  CRLF         Notwithstanding  the above, anomalous effects may still occur when CRLF
1932         is a valid newline sequence and explicit \r or \n escapes appear in the         is a valid newline sequence and explicit \r or \n escapes appear in the
1933         pattern.         pattern.
1934    
1935           PCRE_NOTBOL           PCRE_NOTBOL
1936    
1937         This option specifies that first character of the subject string is not         This option specifies that first character of the subject string is not
1938         the  beginning  of  a  line, so the circumflex metacharacter should not         the beginning of a line, so the  circumflex  metacharacter  should  not
1939         match before it. Setting this without PCRE_MULTILINE (at compile  time)         match  before it. Setting this without PCRE_MULTILINE (at compile time)
1940         causes  circumflex  never to match. This option affects only the behav-         causes circumflex never to match. This option affects only  the  behav-
1941         iour of the circumflex metacharacter. It does not affect \A.         iour of the circumflex metacharacter. It does not affect \A.
1942    
1943           PCRE_NOTEOL           PCRE_NOTEOL
1944    
1945         This option specifies that the end of the subject string is not the end         This option specifies that the end of the subject string is not the end
1946         of  a line, so the dollar metacharacter should not match it nor (except         of a line, so the dollar metacharacter should not match it nor  (except
1947         in multiline mode) a newline immediately before it. Setting this  with-         in  multiline mode) a newline immediately before it. Setting this with-
1948         out PCRE_MULTILINE (at compile time) causes dollar never to match. This         out PCRE_MULTILINE (at compile time) causes dollar never to match. This
1949         option affects only the behaviour of the dollar metacharacter. It  does         option  affects only the behaviour of the dollar metacharacter. It does
1950         not affect \Z or \z.         not affect \Z or \z.
1951    
1952           PCRE_NOTEMPTY           PCRE_NOTEMPTY
1953    
1954         An empty string is not considered to be a valid match if this option is         An empty string is not considered to be a valid match if this option is
1955         set. If there are alternatives in the pattern, they are tried.  If  all         set.  If  there are alternatives in the pattern, they are tried. If all
1956         the  alternatives  match  the empty string, the entire match fails. For         the alternatives match the empty string, the entire  match  fails.  For
1957         example, if the pattern         example, if the pattern
1958    
1959           a?b?           a?b?
1960    
1961         is applied to a string not beginning with "a" or "b",  it  matches  the         is  applied  to  a string not beginning with "a" or "b", it matches the
1962         empty  string at the start of the subject. With PCRE_NOTEMPTY set, this         empty string at the start of the subject. With PCRE_NOTEMPTY set,  this
1963         match is not valid, so PCRE searches further into the string for occur-         match is not valid, so PCRE searches further into the string for occur-
1964         rences of "a" or "b".         rences of "a" or "b".
1965    
1966         Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe-         Perl has no direct equivalent of PCRE_NOTEMPTY, but it does make a spe-
1967         cial case of a pattern match of the empty  string  within  its  split()         cial  case  of  a  pattern match of the empty string within its split()
1968         function,  and  when  using  the /g modifier. It is possible to emulate         function, and when using the /g modifier. It  is  possible  to  emulate
1969         Perl's behaviour after matching a null string by first trying the match         Perl's behaviour after matching a null string by first trying the match
1970         again at the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and then         again at the same offset with PCRE_NOTEMPTY and PCRE_ANCHORED, and then
1971         if that fails by advancing the starting offset (see below)  and  trying         if  that  fails by advancing the starting offset (see below) and trying
1972         an ordinary match again. There is some code that demonstrates how to do         an ordinary match again. There is some code that demonstrates how to do
1973         this in the pcredemo.c sample program.         this in the pcredemo.c sample program.
1974    
1975           PCRE_NO_UTF8_CHECK           PCRE_NO_UTF8_CHECK
1976    
1977         When PCRE_UTF8 is set at compile time, the validity of the subject as a         When PCRE_UTF8 is set at compile time, the validity of the subject as a
1978         UTF-8  string is automatically checked when pcre_exec() is subsequently         UTF-8 string is automatically checked when pcre_exec() is  subsequently
1979         called.  The value of startoffset is also checked  to  ensure  that  it         called.   The  value  of  startoffset is also checked to ensure that it
1980         points  to  the start of a UTF-8 character. There is a discussion about         points to the start of a UTF-8 character. There is a  discussion  about
1981         the validity of UTF-8 strings in the section on UTF-8  support  in  the         the  validity  of  UTF-8 strings in the section on UTF-8 support in the
1982         main  pcre  page.  If  an  invalid  UTF-8  sequence  of bytes is found,         main pcre page. If  an  invalid  UTF-8  sequence  of  bytes  is  found,
1983         pcre_exec() returns the error PCRE_ERROR_BADUTF8. If  startoffset  con-         pcre_exec()  returns  the error PCRE_ERROR_BADUTF8. If startoffset con-
1984         tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.         tains an invalid value, PCRE_ERROR_BADUTF8_OFFSET is returned.
1985    
1986         If  you  already  know that your subject is valid, and you want to skip         If you already know that your subject is valid, and you  want  to  skip
1987         these   checks   for   performance   reasons,   you   can    set    the         these    checks    for   performance   reasons,   you   can   set   the
1988         PCRE_NO_UTF8_CHECK  option  when calling pcre_exec(). You might want to         PCRE_NO_UTF8_CHECK option when calling pcre_exec(). You might  want  to
1989         do this for the second and subsequent calls to pcre_exec() if  you  are         do  this  for the second and subsequent calls to pcre_exec() if you are
1990         making  repeated  calls  to  find  all  the matches in a single subject         making repeated calls to find all  the  matches  in  a  single  subject
1991         string. However, you should be  sure  that  the  value  of  startoffset         string.  However,  you  should  be  sure  that the value of startoffset
1992         points  to  the  start of a UTF-8 character. When PCRE_NO_UTF8_CHECK is         points to the start of a UTF-8 character.  When  PCRE_NO_UTF8_CHECK  is
1993         set, the effect of passing an invalid UTF-8 string as a subject,  or  a         set,  the  effect of passing an invalid UTF-8 string as a subject, or a
1994         value  of startoffset that does not point to the start of a UTF-8 char-         value of startoffset that does not point to the start of a UTF-8  char-
1995         acter, is undefined. Your program may crash.         acter, is undefined. Your program may crash.
1996    
1997           PCRE_PARTIAL           PCRE_PARTIAL
1998    
1999         This option turns on the  partial  matching  feature.  If  the  subject         This  option  turns  on  the  partial  matching feature. If the subject
2000         string  fails to match the pattern, but at some point during the match-         string fails to match the pattern, but at some point during the  match-
2001         ing process the end of the subject was reached (that  is,  the  subject         ing  process  the  end of the subject was reached (that is, the subject
2002         partially  matches  the  pattern and the failure to match occurred only         partially matches the pattern and the failure to  match  occurred  only
2003         because there were not enough subject characters), pcre_exec()  returns         because  there were not enough subject characters), pcre_exec() returns
2004         PCRE_ERROR_PARTIAL  instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL is         PCRE_ERROR_PARTIAL instead of PCRE_ERROR_NOMATCH. When PCRE_PARTIAL  is
2005         used, there are restrictions on what may appear in the  pattern.  These         used,  there  are restrictions on what may appear in the pattern. These
2006         are discussed in the pcrepartial documentation.         are discussed in the pcrepartial documentation.
2007    
2008     The string to be matched by pcre_exec()     The string to be matched by pcre_exec()
2009    
2010         The  subject string is passed to pcre_exec() as a pointer in subject, a         The subject string is passed to pcre_exec() as a pointer in subject,  a
2011         length in length, and a starting byte offset in startoffset.  In  UTF-8         length  in  length, and a starting byte offset in startoffset. In UTF-8
2012         mode,  the  byte  offset  must point to the start of a UTF-8 character.         mode, the byte offset must point to the start  of  a  UTF-8  character.
2013         Unlike the pattern string, the subject may contain binary  zero  bytes.         Unlike  the  pattern string, the subject may contain binary zero bytes.
2014         When  the starting offset is zero, the search for a match starts at the         When the starting offset is zero, the search for a match starts at  the
2015         beginning of the subject, and this is by far the most common case.         beginning of the subject, and this is by far the most common case.
2016    
2017         A non-zero starting offset is useful when searching for  another  match         A  non-zero  starting offset is useful when searching for another match
2018         in  the same subject by calling pcre_exec() again after a previous suc-         in the same subject by calling pcre_exec() again after a previous  suc-
2019         cess.  Setting startoffset differs from just passing over  a  shortened         cess.   Setting  startoffset differs from just passing over a shortened
2020         string  and  setting  PCRE_NOTBOL  in the case of a pattern that begins         string and setting PCRE_NOTBOL in the case of  a  pattern  that  begins
2021         with any kind of lookbehind. For example, consider the pattern         with any kind of lookbehind. For example, consider the pattern
2022    
2023           \Biss\B           \Biss\B
2024    
2025         which finds occurrences of "iss" in the middle of  words.  (\B  matches         which  finds  occurrences  of "iss" in the middle of words. (\B matches
2026         only  if  the  current position in the subject is not a word boundary.)         only if the current position in the subject is not  a  word  boundary.)
2027         When applied to the string "Mississipi" the first call  to  pcre_exec()         When  applied  to the string "Mississipi" the first call to pcre_exec()
2028         finds  the  first  occurrence. If pcre_exec() is called again with just         finds the first occurrence. If pcre_exec() is called  again  with  just
2029         the remainder of the subject,  namely  "issipi",  it  does  not  match,         the  remainder  of  the  subject,  namely  "issipi", it does not match,
2030         because \B is always false at the start of the subject, which is deemed         because \B is always false at the start of the subject, which is deemed
2031         to be a word boundary. However, if pcre_exec()  is  passed  the  entire         to  be  a  word  boundary. However, if pcre_exec() is passed the entire
2032         string again, but with startoffset set to 4, it finds the second occur-         string again, but with startoffset set to 4, it finds the second occur-
2033         rence of "iss" because it is able to look behind the starting point  to         rence  of "iss" because it is able to look behind the starting point to
2034         discover that it is preceded by a letter.         discover that it is preceded by a letter.
2035    
2036         If  a  non-zero starting offset is passed when the pattern is anchored,         If a non-zero starting offset is passed when the pattern  is  anchored,
2037         one attempt to match at the given offset is made. This can only succeed         one attempt to match at the given offset is made. This can only succeed
2038         if  the  pattern  does  not require the match to be at the start of the         if the pattern does not require the match to be at  the  start  of  the
2039         subject.         subject.
2040    
2041     How pcre_exec() returns captured substrings     How pcre_exec() returns captured substrings
2042    
2043         In general, a pattern matches a certain portion of the subject, and  in         In  general, a pattern matches a certain portion of the subject, and in
2044         addition,  further  substrings  from  the  subject may be picked out by         addition, further substrings from the subject  may  be  picked  out  by
2045         parts of the pattern. Following the usage  in  Jeffrey  Friedl's  book,         parts  of  the  pattern.  Following the usage in Jeffrey Friedl's book,
2046         this  is  called "capturing" in what follows, and the phrase "capturing         this is called "capturing" in what follows, and the  phrase  "capturing
2047         subpattern" is used for a fragment of a pattern that picks out  a  sub-         subpattern"  is  used for a fragment of a pattern that picks out a sub-
2048         string.  PCRE  supports several other kinds of parenthesized subpattern         string. PCRE supports several other kinds of  parenthesized  subpattern
2049         that do not cause substrings to be captured.         that do not cause substrings to be captured.
2050    
2051         Captured substrings are returned to the caller via a vector of  integer         Captured  substrings are returned to the caller via a vector of integer
2052         offsets  whose  address is passed in ovector. The number of elements in         offsets whose address is passed in ovector. The number of  elements  in
2053         the vector is passed in ovecsize, which must be a non-negative  number.         the  vector is passed in ovecsize, which must be a non-negative number.
2054         Note: this argument is NOT the size of ovector in bytes.         Note: this argument is NOT the size of ovector in bytes.
2055    
2056         The  first  two-thirds of the vector is used to pass back captured sub-         The first two-thirds of the vector is used to pass back  captured  sub-
2057         strings, each substring using a pair of integers. The  remaining  third         strings,  each  substring using a pair of integers. The remaining third
2058         of  the  vector is used as workspace by pcre_exec() while matching cap-         of the vector is used as workspace by pcre_exec() while  matching  cap-
2059         turing subpatterns, and is not available for passing back  information.         turing  subpatterns, and is not available for passing back information.
2060         The  length passed in ovecsize should always be a multiple of three. If         The length passed in ovecsize should always be a multiple of three.  If
2061         it is not, it is rounded down.         it is not, it is rounded down.
2062    
2063         When a match is successful, information about  captured  substrings  is         When  a  match  is successful, information about captured substrings is
2064         returned  in  pairs  of integers, starting at the beginning of ovector,         returned in pairs of integers, starting at the  beginning  of  ovector,
2065         and continuing up to two-thirds of its length at the  most.  The  first         and  continuing  up  to two-thirds of its length at the most. The first
2066         element of a pair is set to the offset of the first character in a sub-         element of a pair is set to the offset of the first character in a sub-
2067         string, and the second is set to the  offset  of  the  first  character         string,  and  the  second  is  set to the offset of the first character
2068         after  the  end  of  a  substring. The first pair, ovector[0] and ovec-         after the end of a substring. The  first  pair,  ovector[0]  and  ovec-
2069         tor[1], identify the portion of  the  subject  string  matched  by  the         tor[1],  identify  the  portion  of  the  subject string matched by the
2070         entire  pattern.  The next pair is used for the first capturing subpat-         entire pattern. The next pair is used for the first  capturing  subpat-
2071         tern, and so on. The value returned by pcre_exec() is one more than the         tern, and so on. The value returned by pcre_exec() is one more than the
2072         highest numbered pair that has been set. For example, if two substrings         highest numbered pair that has been set. For example, if two substrings
2073         have been captured, the returned value is 3. If there are no  capturing         have  been captured, the returned value is 3. If there are no capturing
2074         subpatterns,  the return value from a successful match is 1, indicating         subpatterns, the return value from a successful match is 1,  indicating
2075         that just the first pair of offsets has been set.         that just the first pair of offsets has been set.
2076    
2077         If a capturing subpattern is matched repeatedly, it is the last portion         If a capturing subpattern is matched repeatedly, it is the last portion
2078         of the string that it matched that is returned.         of the string that it matched that is returned.
2079    
2080         If  the vector is too small to hold all the captured substring offsets,         If the vector is too small to hold all the captured substring  offsets,
2081         it is used as far as possible (up to two-thirds of its length), and the         it is used as far as possible (up to two-thirds of its length), and the
2082         function  returns a value of zero. In particular, if the substring off-         function returns a value of zero. In particular, if the substring  off-
2083         sets are not of interest, pcre_exec() may be called with ovector passed         sets are not of interest, pcre_exec() may be called with ovector passed
2084         as  NULL  and  ovecsize  as zero. However, if the pattern contains back         as NULL and ovecsize as zero. However, if  the  pattern  contains  back
2085         references and the ovector is not big enough to  remember  the  related         references  and  the  ovector is not big enough to remember the related
2086         substrings,  PCRE has to get additional memory for use during matching.         substrings, PCRE has to get additional memory for use during  matching.
2087         Thus it is usually advisable to supply an ovector.         Thus it is usually advisable to supply an ovector.
2088    
2089         The pcre_info() function can be used to find  out  how  many  capturing         The  pcre_info()  function  can  be used to find out how many capturing
2090         subpatterns  there  are  in  a  compiled pattern. The smallest size for         subpatterns there are in a compiled  pattern.  The  smallest  size  for
2091         ovector that will allow for n captured substrings, in addition  to  the         ovector  that  will allow for n captured substrings, in addition to the
2092         offsets of the substring matched by the whole pattern, is (n+1)*3.         offsets of the substring matched by the whole pattern, is (n+1)*3.
2093    
2094         It  is  possible for capturing subpattern number n+1 to match some part         It is possible for capturing subpattern number n+1 to match  some  part
2095         of the subject when subpattern n has not been used at all. For example,         of the subject when subpattern n has not been used at all. For example,
2096         if  the  string  "abc"  is  matched against the pattern (a|(z))(bc) the         if the string "abc" is matched  against  the  pattern  (a|(z))(bc)  the
2097         return from the function is 4, and subpatterns 1 and 3 are matched, but         return from the function is 4, and subpatterns 1 and 3 are matched, but
2098         2  is  not.  When  this happens, both values in the offset pairs corre-         2 is not. When this happens, both values in  the  offset  pairs  corre-
2099         sponding to unused subpatterns are set to -1.         sponding to unused subpatterns are set to -1.
2100    
2101         Offset values that correspond to unused subpatterns at the end  of  the         Offset  values  that correspond to unused subpatterns at the end of the
2102         expression  are  also  set  to  -1. For example, if the string "abc" is         expression are also set to -1. For example,  if  the  string  "abc"  is
2103         matched against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are  not         matched  against the pattern (abc)(x(yz)?)? subpatterns 2 and 3 are not
2104         matched.  The  return  from the function is 2, because the highest used         matched. The return from the function is 2, because  the  highest  used
2105         capturing subpattern number is 1. However, you can refer to the offsets         capturing subpattern number is 1. However, you can refer to the offsets
2106         for  the  second  and third capturing subpatterns if you wish (assuming         for the second and third capturing subpatterns if  you  wish  (assuming
2107         the vector is large enough, of course).         the vector is large enough, of course).
2108    
2109         Some convenience functions are provided  for  extracting  the  captured         Some  convenience  functions  are  provided for extracting the captured
2110         substrings as separate strings. These are described below.         substrings as separate strings. These are described below.
2111    
2112     Error return values from pcre_exec()     Error return values from pcre_exec()
2113    
2114         If  pcre_exec()  fails, it returns a negative number. The following are         If pcre_exec() fails, it returns a negative number. The  following  are
2115         defined in the header file:         defined in the header file:
2116    
2117           PCRE_ERROR_NOMATCH        (-1)           PCRE_ERROR_NOMATCH        (-1)
# Line 2112  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2120  MATCHING A PATTERN: THE TRADITIONAL FUNC
2120    
2121           PCRE_ERROR_NULL           (-2)           PCRE_ERROR_NULL           (-2)
2122    
2123         Either code or subject was passed as NULL,  or  ovector  was  NULL  and         Either  code  or  subject  was  passed as NULL, or ovector was NULL and
2124         ovecsize was not zero.         ovecsize was not zero.
2125    
2126           PCRE_ERROR_BADOPTION      (-3)           PCRE_ERROR_BADOPTION      (-3)
# Line 2121  MATCHING A PATTERN: THE TRADITIONAL FUNC Line 2129  MATCHING A PATTERN: THE TRADITIONAL FUNC
2129    
2130           PCRE_ERROR_BADMAGIC       (-4)           PCRE_ERROR_BADMAGIC       (-4)
2131    
2132         PCRE  stores a 4-byte "magic number" at the start of the compiled code,         PCRE stores a 4-byte "magic number" at the start of the compiled  code,
2133         to catch the case when it is passed a junk pointer and to detect when a         to catch the case when it is passed a junk pointer and to detect when a
2134         pattern that was compiled in an environment of one endianness is run in         pattern that was compiled in an environment of one endianness is run in
2135         an environment with the other endianness. This is the error  that  PCRE         an  environment  with the other endianness. This is the error that PCRE
2136         gives when the magic number is not present.         gives when the magic number is not present.
2137    
2138           PCRE_ERROR_UNKNOWN_OPCODE (-5)           PCRE_ERROR_UNKNOWN_OPCODE (-5)
2139    
2140         While running the pattern match, an unknown item was encountered in the         While running the pattern match, an unknown item was encountered in the
2141         compiled pattern. This error could be caused by a bug  in  PCRE  or  by         compiled  pattern.  This  error  could be caused by a bug in PCRE or by
2142         overwriting of the compiled pattern.         overwriting of the compiled pattern.
2143    
2144           PCRE_ERROR_NOMEMORY       (-6)           PCRE_ERROR_NOMEMORY       (-6)
2145    
2146         If  a  pattern contains back references, but the ovector that is passed         If a pattern contains back references, but the ovector that  is  passed
2147         to pcre_exec() is not big enough to remember the referenced substrings,         to pcre_exec() is not big enough to remember the referenced substrings,
2148         PCRE  gets  a  block of memory at the start of matching to use for this         PCRE gets a block of memory at the start of matching to  use  for  this
2149         purpose. If the call via pcre_malloc() fails, this error is given.  The         purpose.  If the call via pcre_malloc() fails, this error is given. The
2150         memory is automatically freed at the end of matching.         memory is automatically freed at the end of matching.
2151    
2152           PCRE_ERROR_NOSUBSTRING    (-7)           PCRE_ERROR_NOSUBSTRING    (-7)
2153    
2154         This  error is used by the pcre_copy_substring(), pcre_get_substring(),         This error is used by the pcre_copy_substring(),  pcre_get_substring(),
2155         and  pcre_get_substring_list()  functions  (see  below).  It  is  never         and  pcre_get_substring_list()  functions  (see  below).  It  is  never
2156         returned by pcre_exec().         returned by pcre_exec().
2157    
2158           PCRE_ERROR_MATCHLIMIT     (-8)           PCRE_ERROR_MATCHLIMIT     (-8)
2159    
2160         The  backtracking  limit,  as  specified  by the match_limit field in a         The backtracking limit, as specified by  the  match_limit  field  in  a
2161         pcre_extra structure (or defaulted) was reached.  See  the  description         pcre_extra  structure  (or  defaulted) was reached. See the description
2162         above.         above.
2163    
2164           PCRE_ERROR_CALLOUT        (-9)           PCRE_ERROR_CALLOUT        (-9)
2165    
2166         This error is never generated by pcre_exec() itself. It is provided for         This error is never generated by pcre_exec() itself. It is provided for
2167         use by callout functions that want to yield a distinctive  error  code.         use  by  callout functions that want to yield a distinctive error code.
2168         See the pcrecallout documentation for details.         See the pcrecallout documentation for details.
2169    
2170           PCRE_ERROR_BADUTF8        (-10)           PCRE_ERROR_BADUTF8        (-10)
2171    
2172         A  string  that contains an invalid UTF-8 byte sequence was passed as a         A string that contains an invalid UTF-8 byte sequence was passed  as  a
2173         subject.         subject.
2174    
2175           PCRE_ERROR_BADUTF8_OFFSET (-11)           PCRE_ERROR_BADUTF8_OFFSET (-11)
2176    
2177         The UTF-8 byte sequence that was passed as a subject was valid, but the         The UTF-8 byte sequence that was passed as a subject was valid, but the
2178         value  of startoffset did not point to the beginning of a UTF-8 charac-         value of startoffset did not point to the beginning of a UTF-8  charac-
2179         ter.         ter.
2180    
2181           PCRE_ERROR_PARTIAL        (-12)           PCRE_ERROR_PARTIAL        (-12)
2182    
2183         The subject string did not match, but it did match partially.  See  the         The  subject  string did not match, but it did match partially. See the
2184         pcrepartial documentation for details of partial matching.         pcrepartial documentation for details of partial matching.
2185    
2186           PCRE_ERROR_BADPARTIAL     (-13)           PCRE_ERROR_BADPARTIAL     (-13)
2187    
2188         The  PCRE_PARTIAL  option  was  used with a compiled pattern containing         The PCRE_PARTIAL option was used with  a  compiled  pattern  containing
2189         items that are not supported for partial matching. See the  pcrepartial         items  that are not supported for partial matching. See the pcrepartial
2190         documentation for details of partial matching.         documentation for details of partial matching.
2191    
2192           PCRE_ERROR_INTERNAL       (-14)           PCRE_ERROR_INTERNAL       (-14)
2193    
2194         An  unexpected  internal error has occurred. This error could be caused         An unexpected internal error has occurred. This error could  be  caused
2195         by a bug in PCRE or by overwriting of the compiled pattern.         by a bug in PCRE or by overwriting of the compiled pattern.
2196    
2197           PCRE_ERROR_BADCOUNT       (-15)           PCRE_ERROR_BADCOUNT       (-15)
2198    
2199         This error is given if the value of the ovecsize argument is  negative.         This  error is given if the value of the ovecsize argument is negative.
2200    
2201           PCRE_ERROR_RECURSIONLIMIT (-21)           PCRE_ERROR_RECURSIONLIMIT (-21)
2202    
2203         The internal recursion limit, as specified by the match_limit_recursion         The internal recursion limit, as specified by the match_limit_recursion
2204         field in a pcre_extra structure (or defaulted)  was  reached.  See  the         field  in  a  pcre_extra  structure (or defaulted) was reached. See the
2205         description above.         description above.
2206    
2207           PCRE_ERROR_BADNEWLINE     (-23)           PCRE_ERROR_BADNEWLINE     (-23)
# Line 2216  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER Line 2224  EXTRACTING CAPTURED SUBSTRINGS BY NUMBER
2224         int pcre_get_substring_list(const char *subject,         int pcre_get_substring_list(const char *subject,
2225              int *ovector, int stringcount, const char ***listptr);              int *ovector, int stringcount, const char ***listptr);
2226    
2227         Captured  substrings  can  be  accessed  directly  by using the offsets         Captured substrings can be  accessed  directly  by  using  the  offsets
2228         returned by pcre_exec() in  ovector.  For  convenience,  the  functions         returned  by  pcre_exec()  in  ovector.  For convenience, the functions
2229         pcre_copy_substring(),    pcre_get_substring(),    and    pcre_get_sub-         pcre_copy_substring(),    pcre_get_substring(),    and    pcre_get_sub-
2230         string_list() are provided for extracting captured substrings  as  new,         string_list()  are  provided for extracting captured substrings as new,
2231         separate,  zero-terminated strings. These functions identify substrings         separate, zero-terminated strings. These functions identify  substrings
2232         by number. The next section describes functions  for  extracting  named         by  number.  The  next section describes functions for extracting named
2233         substrings.         substrings.
2234    
2235         A  substring that contains a binary zero is correctly extracted and has         A substring that contains a binary zero is correctly extracted and  has
2236         a further zero added on the end, but the result is not, of course, a  C         a  further zero added on the end, but the result is not, of course, a C
2237         string.   However,  you  can  process such a string by referring to the         string.  However, you can process such a string  by  referring  to  the
2238         length that is  returned  by  pcre_copy_substring()  and  pcre_get_sub-         length  that  is  returned  by  pcre_copy_substring() and pcre_get_sub-
2239         string().  Unfortunately, the interface to pcre_get_substring_list() is         string().  Unfortunately, the interface to pcre_get_substring_list() is
2240         not adequate for handling strings containing binary zeros, because  the         not  adequate for handling strings containing binary zeros, because the
2241         end of the final string is not independently indicated.         end of the final string is not independently indicated.
2242    
2243         The  first  three  arguments  are the same for all three of these func-         The first three arguments are the same for all  three  of  these  func-
2244         tions: subject is the subject string that has  just  been  successfully         tions:  subject  is  the subject string that has just been successfully
2245         matched, ovector is a pointer to the vector of integer offsets that was         matched, ovector is a pointer to the vector of integer offsets that was
2246         passed to pcre_exec(), and stringcount is the number of substrings that         passed to pcre_exec(), and stringcount is the number of substrings that
2247         were  captured  by  the match, including the substring that matched the         were captured by the match, including the substring  that  matched  the
2248         entire regular expression. This is the value returned by pcre_exec() if         entire regular expression. This is the value returned by pcre_exec() if
2249         it  is greater than zero. If pcre_exec() returned zero, indicating that         it is greater than zero. If pcre_exec() returned zero, indicating  that
2250         it ran out of space in ovector, the value passed as stringcount  should         it  ran out of space in ovector, the value passed as stringcount should
2251         be the number of elements in the vector divided by three.         be the number of elements in the vector divided by three.
2252    
2253         The  functions pcre_copy_substring() and pcre_get_substring() extract a         The functions pcre_copy_substring() and pcre_get_substring() extract  a
2254         single substring, whose number is given as  stringnumber.  A  value  of         single  substring,  whose  number  is given as stringnumber. A value of
2255         zero  extracts  the  substring that matched the entire pattern, whereas         zero extracts the substring that matched the  entire  pattern,  whereas
2256         higher values  extract  the  captured  substrings.  For  pcre_copy_sub-         higher  values  extract  the  captured  substrings.  For pcre_copy_sub-
2257         string(),  the  string  is  placed  in buffer, whose length is given by         string(), the string is placed in buffer,  whose  length  is  given  by
2258         buffersize, while for pcre_get_substring() a new  block  of  memory  is         buffersize,  while  for  pcre_get_substring()  a new block of memory is
2259         obtained  via  pcre_malloc,  and its address is returned via stringptr.         obtained via pcre_malloc, and its address is  returned  via  stringptr.
2260         The yield of the function is the length of the  string,  not  including         The  yield  of  the function is the length of the string, not including
2261         the terminating zero, or one of these error codes:         the terminating zero, or one of these error codes:
2262    
2263           PCRE_ERROR_NOMEMORY       (-6)           PCRE_ERROR_NOMEMORY       (-6)
2264    
2265         The  buffer  was too small for pcre_copy_substring(), or the attempt to         The buffer was too small for pcre_copy_substring(), or the  attempt  to
2266         get memory failed for pcre_get_substring().         get memory failed for pcre_get_substring().
2267    
2268           PCRE_ERROR_NOSUBSTRING    (-7)           PCRE_ERROR_NOSUBSTRING    (-7)
2269    
2270         There is no substring whose number is stringnumber.         There is no substring whose number is stringnumber.
2271    
2272         The pcre_get_substring_list()  function  extracts  all  available  sub-         The  pcre_get_substring_list()  function  extracts  all  available sub-
2273         strings  and  builds  a list of pointers to them. All this is done in a         strings and builds a list of pointers to them. All this is  done  in  a
2274         single block of memory that is obtained via pcre_malloc. The address of         single block of memory that is obtained via pcre_malloc. The address of
2275         the  memory  block  is returned via listptr, which is also the start of         the memory block is returned via listptr, which is also  the  start  of
2276         the list of string pointers. The end of the list is marked  by  a  NULL         the  list  of  string pointers. The end of the list is marked by a NULL
2277         pointer.  The  yield  of  the function is zero if all went well, or the         pointer. The yield of the function is zero if all  went  well,  or  the
2278         error code         error code
2279    
2280           PCRE_ERROR_NOMEMORY       (-6)           PCRE_ERROR_NOMEMORY       (-6)
2281    
2282         if the attempt to get the memory block failed.         if the attempt to get the memory block failed.
2283    
2284         When any of these functions encounter a substring that is unset,  which         When  any of these functions encounter a substring that is unset, which
2285         can  happen  when  capturing subpattern number n+1 matches some part of         can happen when capturing subpattern number n+1 matches  some  part  of
2286         the subject, but subpattern n has not been used at all, they return  an         the  subject, but subpattern n has not been used at all, they return an
2287         empty string. This can be distinguished from a genuine zero-length sub-         empty string. This can be distinguished from a genuine zero-length sub-
2288         string by inspecting the appropriate offset in ovector, which is  nega-         string  by inspecting the appropriate offset in ovector, which is nega-
2289         tive for unset substrings.         tive for unset substrings.
2290    
2291         The  two convenience functions pcre_free_substring() and pcre_free_sub-         The two convenience functions pcre_free_substring() and  pcre_free_sub-
2292         string_list() can be used to free the memory  returned  by  a  previous         string_list()  can  be  used  to free the memory returned by a previous
2293         call  of  pcre_get_substring()  or  pcre_get_substring_list(),  respec-         call  of  pcre_get_substring()  or  pcre_get_substring_list(),  respec-
2294         tively. They do nothing more than  call  the  function  pointed  to  by         tively.  They  do  nothing  more  than  call the function pointed to by
2295         pcre_free,  which  of course could be called directly from a C program.         pcre_free, which of course could be called directly from a  C  program.
2296         However, PCRE is used in some situations where it is linked via a  spe-         However,  PCRE is used in some situations where it is linked via a spe-
2297         cial   interface  to  another  programming  language  that  cannot  use         cial  interface  to  another  programming  language  that  cannot   use
2298         pcre_free directly; it is for these cases that the functions  are  pro-         pcre_free  directly;  it is for these cases that the functions are pro-
2299         vided.         vided.
2300    
2301    
# Line 2306  EXTRACTING CAPTURED SUBSTRINGS BY NAME Line 2314  EXTRACTING CAPTURED SUBSTRINGS BY NAME
2314              int stringcount, const char *stringname,              int stringcount, const char *stringname,
2315              const char **stringptr);              const char **stringptr);
2316    
2317         To  extract a substring by name, you first have to find associated num-         To extract a substring by name, you first have to find associated  num-
2318         ber.  For example, for this pattern         ber.  For example, for this pattern
2319    
2320           (a+)b(?<xxx>\d+)...           (a+)b(?<xxx>\d+)...
# Line 2315  EXTRACTING CAPTURED SUBSTRINGS BY NAME Line 2323  EXTRACTING CAPTURED SUBSTRINGS BY NAME
2323         be unique (PCRE_DUPNAMES was not set), you can find the number from the         be unique (PCRE_DUPNAMES was not set), you can find the number from the
2324         name by calling pcre_get_stringnumber(). The first argument is the com-         name by calling pcre_get_stringnumber(). The first argument is the com-
2325         piled pattern, and the second is the name. The yield of the function is         piled pattern, and the second is the name. The yield of the function is
2326         the subpattern number, or PCRE_ERROR_NOSUBSTRING (-7) if  there  is  no         the  subpattern  number,  or PCRE_ERROR_NOSUBSTRING (-7) if there is no
2327         subpattern of that name.         subpattern of that name.
2328    
2329         Given the number, you can extract the substring directly, or use one of         Given the number, you can extract the substring directly, or use one of
2330         the functions described in the previous section. For convenience, there         the functions described in the previous section. For convenience, there
2331         are also two functions that do the whole job.         are also two functions that do the whole job.
2332    
2333         Most    of    the    arguments   of   pcre_copy_named_substring()   and         Most   of   the   arguments    of    pcre_copy_named_substring()    and
2334         pcre_get_named_substring() are the same  as  those  for  the  similarly         pcre_get_named_substring()  are  the  same  as  those for the similarly
2335         named  functions  that extract by number. As these are described in the         named functions that extract by number. As these are described  in  the
2336         previous section, they are not re-described here. There  are  just  two         previous  section,  they  are not re-described here. There are just two
2337         differences:         differences:
2338    
2339         First,  instead  of a substring number, a substring name is given. Sec-         First, instead of a substring number, a substring name is  given.  Sec-
2340         ond, there is an extra argument, given at the start, which is a pointer         ond, there is an extra argument, given at the start, which is a pointer
2341         to  the compiled pattern. This is needed in order to gain access to the         to the compiled pattern. This is needed in order to gain access to  the
2342         name-to-number translation table.         name-to-number translation table.
2343    
2344         These functions call pcre_get_stringnumber(), and if it succeeds,  they         These  functions call pcre_get_stringnumber(), and if it succeeds, they
2345         then  call  pcre_copy_substring() or pcre_get_substring(), as appropri-         then call pcre_copy_substring() or pcre_get_substring(),  as  appropri-
2346         ate. NOTE: If PCRE_DUPNAMES is set and there are duplicate  names,  the         ate.  NOTE:  If PCRE_DUPNAMES is set and there are duplicate names, the
2347         behaviour may not be what you want (see the next section).         behaviour may not be what you want (see the next section).
2348    
2349    
# Line 2344  DUPLICATE SUBPATTERN NAMES Line 2352  DUPLICATE SUBPATTERN NAMES
2352         int pcre_get_stringtable_entries(const pcre *code,         int pcre_get_stringtable_entries(const pcre *code,
2353              const char *name, char **first, char **last);              const char *name, char **first, char **last);
2354    
2355         When  a  pattern  is  compiled with the PCRE_DUPNAMES option, names for         When a pattern is compiled with the  PCRE_DUPNAMES  option,  names  for
2356         subpatterns are not required to  be  unique.  Normally,  patterns  with         subpatterns  are  not  required  to  be unique. Normally, patterns with
2357         duplicate  names  are such that in any one match, only one of the named         duplicate names are such that in any one match, only one of  the  named
2358         subpatterns participates. An example is shown in the pcrepattern  docu-         subpatterns  participates. An example is shown in the pcrepattern docu-
2359         mentation.         mentation.
2360    
2361         When    duplicates   are   present,   pcre_copy_named_substring()   and         When   duplicates   are   present,   pcre_copy_named_substring()    and
2362         pcre_get_named_substring() return the first substring corresponding  to         pcre_get_named_substring()  return the first substring corresponding to
2363         the  given  name  that  is set. If none are set, PCRE_ERROR_NOSUBSTRING         the given name that is set. If  none  are  set,  PCRE_ERROR_NOSUBSTRING
2364         (-7) is returned; no  data  is  returned.  The  pcre_get_stringnumber()         (-7)  is  returned;  no  data  is returned. The pcre_get_stringnumber()
2365         function  returns one of the numbers that are associated with the name,         function returns one of the numbers that are associated with the  name,
2366         but it is not defined which it is.         but it is not defined which it is.
2367    
2368         If you want to get full details of all captured substrings for a  given         If  you want to get full details of all captured substrings for a given
2369         name,  you  must  use  the pcre_get_stringtable_entries() function. The         name, you must use  the  pcre_get_stringtable_entries()  function.  The
2370         first argument is the compiled pattern, and the second is the name. The         first argument is the compiled pattern, and the second is the name. The
2371         third  and  fourth  are  pointers to variables which are updated by the         third and fourth are pointers to variables which  are  updated  by  the
2372         function. After it has run, they point to the first and last entries in         function. After it has run, they point to the first and last entries in
2373         the  name-to-number  table  for  the  given  name.  The function itself         the name-to-number table  for  the  given  name.  The  function  itself
2374         returns the length of each entry,  or  PCRE_ERROR_NOSUBSTRING  (-7)  if         returns  the  length  of  each entry, or PCRE_ERROR_NOSUBSTRING (-7) if
2375         there  are none. The format of the table is described above in the sec-         there are none. The format of the table is described above in the  sec-
2376         tion entitled Information about a  pattern.   Given  all  the  relevant         tion  entitled  Information  about  a  pattern.  Given all the relevant
2377         entries  for the name, you can extract each of their numbers, and hence         entries for the name, you can extract each of their numbers, and  hence
2378         the captured data, if any.         the captured data, if any.
2379    
2380    
2381  FINDING ALL POSSIBLE MATCHES  FINDING ALL POSSIBLE MATCHES
2382    
2383         The traditional matching function uses a  similar  algorithm  to  Perl,         The  traditional  matching  function  uses a similar algorithm to Perl,
2384         which stops when it finds the first match, starting at a given point in         which stops when it finds the first match, starting at a given point in
2385         the subject. If you want to find all possible matches, or  the  longest         the  subject.  If you want to find all possible matches, or the longest
2386         possible  match,  consider using the alternative matching function (see         possible match, consider using the alternative matching  function  (see
2387         below) instead. If you cannot use the alternative function,  but  still         below)  instead.  If you cannot use the alternative function, but still
2388         need  to  find all possible matches, you can kludge it up by making use         need to find all possible matches, you can kludge it up by  making  use
2389         of the callout facility, which is described in the pcrecallout documen-         of the callout facility, which is described in the pcrecallout documen-
2390         tation.         tation.
2391    
2392         What you have to do is to insert a callout right at the end of the pat-         What you have to do is to insert a callout right at the end of the pat-
2393         tern.  When your callout function is called, extract and save the  cur-         tern.   When your callout function is called, extract and save the cur-
2394         rent  matched  substring.  Then  return  1, which forces pcre_exec() to         rent matched substring. Then return  1,  which  forces  pcre_exec()  to
2395         backtrack and try other alternatives. Ultimately, when it runs  out  of         backtrack  and  try other alternatives. Ultimately, when it runs out of
2396         matches, pcre_exec() will yield PCRE_ERROR_NOMATCH.         matches, pcre_exec() will yield PCRE_ERROR_NOMATCH.
2397    
2398    
# Line 2395  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2403  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2403              int options, int *ovector, int ovecsize,              int options, int *ovector, int ovecsize,
2404              int *workspace, int wscount);              int *workspace, int wscount);
2405    
2406         The  function  pcre_dfa_exec()  is  called  to  match  a subject string         The function pcre_dfa_exec()  is  called  to  match  a  subject  string
2407         against a compiled pattern, using a matching algorithm that  scans  the         against  a  compiled pattern, using a matching algorithm that scans the
2408         subject  string  just  once, and does not backtrack. This has different         subject string just once, and does not backtrack.  This  has  different
2409         characteristics to the normal algorithm, and  is  not  compatible  with         characteristics  to  the  normal  algorithm, and is not compatible with
2410         Perl.  Some  of the features of PCRE patterns are not supported. Never-         Perl. Some of the features of PCRE patterns are not  supported.  Never-
2411         theless, there are times when this kind of matching can be useful.  For         theless,  there are times when this kind of matching can be useful. For
2412         a discussion of the two matching algorithms, see the pcrematching docu-         a discussion of the two matching algorithms, see the pcrematching docu-
2413         mentation.         mentation.
2414    
2415         The arguments for the pcre_dfa_exec() function  are  the  same  as  for         The  arguments  for  the  pcre_dfa_exec()  function are the same as for
2416         pcre_exec(), plus two extras. The ovector argument is used in a differ-         pcre_exec(), plus two extras. The ovector argument is used in a differ-
2417         ent way, and this is described below. The other  common  arguments  are         ent  way,  and  this is described below. The other common arguments are
2418         used  in  the  same way as for pcre_exec(), so their description is not         used in the same way as for pcre_exec(), so their  description  is  not
2419         repeated here.         repeated here.
2420    
2421         The two additional arguments provide workspace for  the  function.  The         The  two  additional  arguments provide workspace for the function. The
2422         workspace  vector  should  contain at least 20 elements. It is used for         workspace vector should contain at least 20 elements. It  is  used  for
2423         keeping  track  of  multiple  paths  through  the  pattern  tree.  More         keeping  track  of  multiple  paths  through  the  pattern  tree.  More
2424         workspace  will  be  needed for patterns and subjects where there are a         workspace will be needed for patterns and subjects where  there  are  a
2425         lot of potential matches.         lot of potential matches.
2426    
2427         Here is an example of a simple call to pcre_dfa_exec():         Here is an example of a simple call to pcre_dfa_exec():
# Line 2435  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2443  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2443    
2444     Option bits for pcre_dfa_exec()     Option bits for pcre_dfa_exec()
2445    
2446         The unused bits of the options argument  for  pcre_dfa_exec()  must  be         The  unused  bits  of  the options argument for pcre_dfa_exec() must be
2447         zero.  The  only  bits  that  may  be  set are PCRE_ANCHORED, PCRE_NEW-         zero. The only bits  that  may  be  set  are  PCRE_ANCHORED,  PCRE_NEW-
2448         LINE_xxx, PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY,  PCRE_NO_UTF8_CHECK,         LINE_xxx,  PCRE_NOTBOL, PCRE_NOTEOL, PCRE_NOTEMPTY, PCRE_NO_UTF8_CHECK,
2449         PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last         PCRE_PARTIAL, PCRE_DFA_SHORTEST, and PCRE_DFA_RESTART. All but the last
2450         three of these are the same as for pcre_exec(), so their description is         three of these are the same as for pcre_exec(), so their description is
2451         not repeated here.         not repeated here.
2452    
2453           PCRE_PARTIAL           PCRE_PARTIAL
2454    
2455         This  has  the  same general effect as it does for pcre_exec(), but the         This has the same general effect as it does for  pcre_exec(),  but  the
2456         details  are  slightly  different.  When  PCRE_PARTIAL   is   set   for         details   are   slightly   different.  When  PCRE_PARTIAL  is  set  for
2457         pcre_dfa_exec(),  the  return code PCRE_ERROR_NOMATCH is converted into         pcre_dfa_exec(), the return code PCRE_ERROR_NOMATCH is  converted  into
2458         PCRE_ERROR_PARTIAL if the end of the subject  is  reached,  there  have         PCRE_ERROR_PARTIAL  if  the  end  of the subject is reached, there have
2459         been no complete matches, but there is still at least one matching pos-         been no complete matches, but there is still at least one matching pos-
2460         sibility. The portion of the string that provided the partial match  is         sibility.  The portion of the string that provided the partial match is
2461         set as the first matching string.         set as the first matching string.
2462    
2463           PCRE_DFA_SHORTEST           PCRE_DFA_SHORTEST
2464    
2465         Setting  the  PCRE_DFA_SHORTEST option causes the matching algorithm to         Setting the PCRE_DFA_SHORTEST option causes the matching  algorithm  to
2466         stop as soon as it has found one match. Because of the way the alterna-         stop as soon as it has found one match. Because of the way the alterna-
2467         tive  algorithm  works, this is necessarily the shortest possible match         tive algorithm works, this is necessarily the shortest  possible  match
2468         at the first possible matching point in the subject string.         at the first possible matching point in the subject string.
2469    
2470           PCRE_DFA_RESTART           PCRE_DFA_RESTART
2471    
2472         When pcre_dfa_exec()  is  called  with  the  PCRE_PARTIAL  option,  and         When  pcre_dfa_exec()  is  called  with  the  PCRE_PARTIAL  option, and
2473         returns  a  partial  match, it is possible to call it again, with addi-         returns a partial match, it is possible to call it  again,  with  addi-
2474         tional subject characters, and have it continue with  the  same  match.         tional  subject  characters,  and have it continue with the same match.
2475         The  PCRE_DFA_RESTART  option requests this action; when it is set, the         The PCRE_DFA_RESTART option requests this action; when it is  set,  the
2476         workspace and wscount options must reference the same vector as  before         workspace  and wscount options must reference the same vector as before
2477         because  data  about  the  match so far is left in them after a partial         because data about the match so far is left in  them  after  a  partial
2478         match. There is more discussion of this  facility  in  the  pcrepartial         match.  There  is  more  discussion of this facility in the pcrepartial
2479         documentation.         documentation.
2480    
2481     Successful returns from pcre_dfa_exec()     Successful returns from pcre_dfa_exec()
2482    
2483         When  pcre_dfa_exec()  succeeds, it may have matched more than one sub-         When pcre_dfa_exec() succeeds, it may have matched more than  one  sub-
2484         string in the subject. Note, however, that all the matches from one run         string in the subject. Note, however, that all the matches from one run
2485         of  the  function  start  at the same point in the subject. The shorter         of the function start at the same point in  the  subject.  The  shorter
2486         matches are all initial substrings of the longer matches. For  example,         matches  are all initial substrings of the longer matches. For example,
2487         if the pattern         if the pattern
2488    
2489           <.*>           <.*>
# Line 2490  MATCHING A PATTERN: THE ALTERNATIVE FUNC Line 2498  MATCHING A PATTERN: THE ALTERNATIVE FUNC
2498           <something> <something else>           <something> <something else>
2499           <something> <something else> <something further>           <something> <something else> <something further>
2500    
2501         On  success,  the  yield of the function is a number greater than zero,         On success, the yield of the function is a number  greater  than  zero,
2502         which is the number of matched substrings.  The  substrings  themselves         which  is  the  number of matched substrings. The substrings themselves
2503         are  returned  in  ovector. Each string uses two elements; the first is         are returned in ovector. Each string uses two elements;  the  first  is
2504         the offset to the start, and the second is the offset to  the  end.  In         the  offset  to  the start, and the second is the offset to the end. In
2505         fact,  all  the  strings  have the same start offset. (Space could have         fact, all the strings have the same start  offset.  (Space  could  have
2506         been saved by giving this only once, but it was decided to retain  some         been  saved by giving this only once, but it was decided to retain some
2507         compatibility  with  the  way pcre_exec() returns data, even though the         compatibility with the way pcre_exec() returns data,  even  though  the
2508         meaning of the strings is different.)         meaning of the strings is different.)
2509    
2510         The strings are returned in reverse order of length; that is, the long-         The strings are returned in reverse order of length; that is, the long-
2511         est  matching  string is given first. If there were too many matches to         est matching string is given first. If there were too many  matches  to
2512         fit into ovector, the yield of the function is zero, and the vector  is         fit  into ovector, the yield of the function is zero, and the vector is
2513         filled with the longest matches.         filled with the longest matches.
2514    
2515     Error returns from pcre_dfa_exec()     Error returns from pcre_dfa_exec()
2516    
2517         The  pcre_dfa_exec()  function returns a negative number when it fails.         The pcre_dfa_exec() function returns a negative number when  it  fails.
2518         Many of the errors are the same  as  for  pcre_exec(),  and  these  are         Many  of  the  errors  are  the  same as for pcre_exec(), and these are
2519         described  above.   There are in addition the following errors that are         described above.  There are in addition the following errors  that  are
2520         specific to pcre_dfa_exec():         specific to pcre_dfa_exec():
2521    
2522           PCRE_ERROR_DFA_UITEM      (-16)           PCRE_ERROR_DFA_UITEM      (-16)
2523    
2524         This return is given if pcre_dfa_exec() encounters an item in the  pat-         This  return is given if pcre_dfa_exec() encounters an item in the pat-
2525         tern  that  it  does not support, for instance, the use of \C or a back         tern that it does not support, for instance, the use of \C  or  a  back
2526         reference.         reference.
2527    
2528           PCRE_ERROR_DFA_UCOND      (-17)           PCRE_ERROR_DFA_UCOND      (-17)
2529    
2530         This return is given if pcre_dfa_exec()  encounters  a  condition  item         This  return  is  given  if pcre_dfa_exec() encounters a condition item
2531         that  uses  a back reference for the condition, or a test for recursion         that uses a back reference for the condition, or a test  for  recursion
2532         in a specific group. These are not supported.         in a specific group. These are not supported.
2533    
2534           PCRE_ERROR_DFA_UMLIMIT    (-18)           PCRE_ERROR_DFA_UMLIMIT    (-18)
2535    
2536         This return is given if pcre_dfa_exec() is called with an  extra  block         This  return  is given if pcre_dfa_exec() is called with an extra block
2537         that contains a setting of the match_limit field. This is not supported         that contains a setting of the match_limit field. This is not supported
2538         (it is meaningless).         (it is meaningless).
2539    
2540           PCRE_ERROR_DFA_WSSIZE     (-19)           PCRE_ERROR_DFA_WSSIZE     (-19)
2541    
2542         This return is given if  pcre_dfa_exec()  runs  out  of  space  in  the         This  return  is  given  if  pcre_dfa_exec()  runs  out of space in the
2543         workspace vector.         workspace vector.
2544    
2545           PCRE_ERROR_DFA_RECURSE    (-20)           PCRE_ERROR_DFA_RECURSE    (-20)
2546    
2547         When  a  recursive subpattern is processed, the matching function calls         When a recursive subpattern is processed, the matching  function  calls
2548         itself recursively, using private vectors for  ovector  and  workspace.         itself  recursively,  using  private vectors for ovector and workspace.
2549         This  error  is  given  if  the output vector is not large enough. This         This error is given if the output vector  is  not  large  enough.  This
2550         should be extremely rare, as a vector of size 1000 is used.         should be extremely rare, as a vector of size 1000 is used.
2551    
2552    
2553  SEE ALSO  SEE ALSO
2554    
2555         pcrebuild(3), pcrecallout(3), pcrecpp(3)(3), pcrematching(3),  pcrepar-         pcrebuild(3),  pcrecallout(3), pcrecpp(3)(3), pcrematching(3), pcrepar-
2556         tial(3),  pcreposix(3), pcreprecompile(3), pcresample(3), pcrestack(3).         tial(3), pcreposix(3), pcreprecompile(3), pcresample(3),  pcrestack(3).
2557    
2558    
2559  AUTHOR  AUTHOR
# Line 2557  AUTHOR Line 2565  AUTHOR
2565    
2566  REVISION  REVISION
2567    
2568         Last updated: 27 November 2007         Last updated: 26 December 2007
2569         Copyright (c) 1997-2007 University of Cambridge.         Copyright (c) 1997-2007 University of Cambridge.
2570  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
2571    

Legend:
Removed from v.291  
changed lines
  Added in v.292

  ViewVC Help
Powered by ViewVC 1.1.5