/vendor/pcre/doc/html/pcreapi.html

http://github.com/feyeleanor/RubyGoLightly · HTML · 1985 lines · 1985 code · 0 blank · 0 comment · 0 complexity · 2a29757d96575a3e7260f91b4efec45a MD5 · raw file

Large files are truncated click here to view the full file

    

  1. <html>
    2. 

  2. <head>
    3. 

  3. <title>pcreapi specification</title>
    4. 

  4. </head>
    5. 

  5. <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
    6. 

  6. <h1>pcreapi man page</h1>
    7. 

  7. <p>
    8. 

  8. Return to the <a href="index.html">PCRE index page</a>.
    9. 

  9. </p>
    10. 

  10. <p>
    11. 

  11. This page is part of the PCRE HTML documentation. It was generated automatically
    12. 

  12. from the original man page. If there is any nonsense in it, please consult the
    13. 

  13. man page, in case the conversion went wrong.
    14. 

  14. <br>
    15. 

  15. <ul>
    16. 

  16. <li><a name="TOC1" href="#SEC1">PCRE NATIVE API</a>
    17. 

  17. <li><a name="TOC2" href="#SEC2">PCRE API OVERVIEW</a>
    18. 

  18. <li><a name="TOC3" href="#SEC3">NEWLINES</a>
    19. 

  19. <li><a name="TOC4" href="#SEC4">MULTITHREADING</a>
    20. 

  20. <li><a name="TOC5" href="#SEC5">SAVING PRECOMPILED PATTERNS FOR LATER USE</a>
    21. 

  21. <li><a name="TOC6" href="#SEC6">CHECKING BUILD-TIME OPTIONS</a>
    22. 

  22. <li><a name="TOC7" href="#SEC7">COMPILING A PATTERN</a>
    23. 

  23. <li><a name="TOC8" href="#SEC8">COMPILATION ERROR CODES</a>
    24. 

  24. <li><a name="TOC9" href="#SEC9">STUDYING A PATTERN</a>
    25. 

  25. <li><a name="TOC10" href="#SEC10">LOCALE SUPPORT</a>
    26. 

  26. <li><a name="TOC11" href="#SEC11">INFORMATION ABOUT A PATTERN</a>
    27. 

  27. <li><a name="TOC12" href="#SEC12">OBSOLETE INFO FUNCTION</a>
    28. 

  28. <li><a name="TOC13" href="#SEC13">REFERENCE COUNTS</a>
    29. 

  29. <li><a name="TOC14" href="#SEC14">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a>
    30. 

  30. <li><a name="TOC15" href="#SEC15">EXTRACTING CAPTURED SUBSTRINGS BY NUMBER</a>
    31. 

  31. <li><a name="TOC16" href="#SEC16">EXTRACTING CAPTURED SUBSTRINGS BY NAME</a>
    32. 

  32. <li><a name="TOC17" href="#SEC17">DUPLICATE SUBPATTERN NAMES</a>
    33. 

  33. <li><a name="TOC18" href="#SEC18">FINDING ALL POSSIBLE MATCHES</a>
    34. 

  34. <li><a name="TOC19" href="#SEC19">MATCHING A PATTERN: THE ALTERNATIVE FUNCTION</a>
    35. 

  35. <li><a name="TOC20" href="#SEC20">SEE ALSO</a>
    36. 

  36. <li><a name="TOC21" href="#SEC21">AUTHOR</a>
    37. 

  37. <li><a name="TOC22" href="#SEC22">REVISION</a>
    38. 

  38. </ul>
    39. 

  39. <br><a name="SEC1" href="#TOC1">PCRE NATIVE API</a><br>
    40. 

  40. <P>
    41. 

  41. <b>#include &#60;pcre.h&#62;</b>
    42. 

  42. </P>
    43. 

  43. <P>
    44. 

  44. <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
    45. 

  45. <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
    46. 

  46. <b>const unsigned char *<i>tableptr</i>);</b>
    47. 

  47. </P>
    48. 

  48. <P>
    49. 

  49. <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b>
    50. 

  50. <b>int *<i>errorcodeptr</i>,</b>
    51. 

  51. <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
    52. 

  52. <b>const unsigned char *<i>tableptr</i>);</b>
    53. 

  53. </P>
    54. 

  54. <P>
    55. 

  55. <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i>,</b>
    56. 

  56. <b>const char **<i>errptr</i>);</b>
    57. 

  57. </P>
    58. 

  58. <P>
    59. 

  59. <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
    60. 

  60. <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
    61. 

  61. <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>);</b>
    62. 

  62. </P>
    63. 

  63. <P>
    64. 

  64. <b>int pcre_dfa_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
    65. 

  65. <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i>,</b>
    66. 

  66. <b>int <i>options</i>, int *<i>ovector</i>, int <i>ovecsize</i>,</b>
    67. 

  67. <b>int *<i>workspace</i>, int <i>wscount</i>);</b>
    68. 

  68. </P>
    69. 

  69. <P>
    70. 

  70. <b>int pcre_copy_named_substring(const pcre *<i>code</i>,</b>
    71. 

  71. <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
    72. 

  72. <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
    73. 

  73. <b>char *<i>buffer</i>, int <i>buffersize</i>);</b>
    74. 

  74. </P>
    75. 

  75. <P>
    76. 

  76. <b>int pcre_copy_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
    77. 

  77. <b>int <i>stringcount</i>, int <i>stringnumber</i>, char *<i>buffer</i>,</b>
    78. 

  78. <b>int <i>buffersize</i>);</b>
    79. 

  79. </P>
    80. 

  80. <P>
    81. 

  81. <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b>
    82. 

  82. <b>const char *<i>subject</i>, int *<i>ovector</i>,</b>
    83. 

  83. <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b>
    84. 

  84. <b>const char **<i>stringptr</i>);</b>
    85. 

  85. </P>
    86. 

  86. <P>
    87. 

  87. <b>int pcre_get_stringnumber(const pcre *<i>code</i>,</b>
    88. 

  88. <b>const char *<i>name</i>);</b>
    89. 

  89. </P>
    90. 

  90. <P>
    91. 

  91. <b>int pcre_get_stringtable_entries(const pcre *<i>code</i>,</b>
    92. 

  92. <b>const char *<i>name</i>, char **<i>first</i>, char **<i>last</i>);</b>
    93. 

  93. </P>
    94. 

  94. <P>
    95. 

  95. <b>int pcre_get_substring(const char *<i>subject</i>, int *<i>ovector</i>,</b>
    96. 

  96. <b>int <i>stringcount</i>, int <i>stringnumber</i>,</b>
    97. 

  97. <b>const char **<i>stringptr</i>);</b>
    98. 

  98. </P>
    99. 

  99. <P>
    100. 

  100. <b>int pcre_get_substring_list(const char *<i>subject</i>,</b>
    101. 

  101. <b>int *<i>ovector</i>, int <i>stringcount</i>, const char ***<i>listptr</i>);</b>
    102. 

  102. </P>
    103. 

  103. <P>
    104. 

  104. <b>void pcre_free_substring(const char *<i>stringptr</i>);</b>
    105. 

  105. </P>
    106. 

  106. <P>
    107. 

  107. <b>void pcre_free_substring_list(const char **<i>stringptr</i>);</b>
    108. 

  108. </P>
    109. 

  109. <P>
    110. 

  110. <b>const unsigned char *pcre_maketables(void);</b>
    111. 

  111. </P>
    112. 

  112. <P>
    113. 

  113. <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
    114. 

  114. <b>int <i>what</i>, void *<i>where</i>);</b>
    115. 

  115. </P>
    116. 

  116. <P>
    117. 

  117. <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>
    118. 

  118. <b>*<i>firstcharptr</i>);</b>
    119. 

  119. </P>
    120. 

  120. <P>
    121. 

  121. <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>
    122. 

  122. </P>
    123. 

  123. <P>
    124. 

  124. <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
    125. 

  125. </P>
    126. 

  126. <P>
    127. 

  127. <b>char *pcre_version(void);</b>
    128. 

  128. </P>
    129. 

  129. <P>
    130. 

  130. <b>void *(*pcre_malloc)(size_t);</b>
    131. 

  131. </P>
    132. 

  132. <P>
    133. 

  133. <b>void (*pcre_free)(void *);</b>
    134. 

  134. </P>
    135. 

  135. <P>
    136. 

  136. <b>void *(*pcre_stack_malloc)(size_t);</b>
    137. 

  137. </P>
    138. 

  138. <P>
    139. 

  139. <b>void (*pcre_stack_free)(void *);</b>
    140. 

  140. </P>
    141. 

  141. <P>
    142. 

  142. <b>int (*pcre_callout)(pcre_callout_block *);</b>
    143. 

  143. </P>
    144. 

  144. <br><a name="SEC2" href="#TOC1">PCRE API OVERVIEW</a><br>
    145. 

  145. <P>
    146. 

  146. PCRE has its own native API, which is described in this document. There are
    147. 

  147. also some wrapper functions that correspond to the POSIX regular expression
    148. 

  148. API. These are described in the
    149. 

  149. <a href="pcreposix.html"><b>pcreposix</b></a>
    150. 

  150. documentation. Both of these APIs define a set of C function calls. A C++
    151. 

  151. wrapper is distributed with PCRE. It is documented in the
    152. 

  152. <a href="pcrecpp.html"><b>pcrecpp</b></a>
    153. 

  153. page.
    154. 

  154. </P>
    155. 

  155. <P>
    156. 

  156. The native API C function prototypes are defined in the header file
    157. 

  157. <b>pcre.h</b>, and on Unix systems the library itself is called <b>libpcre</b>.
    158. 

  158. It can normally be accessed by adding <b>-lpcre</b> to the command for linking
    159. 

  159. an application that uses PCRE. The header file defines the macros PCRE_MAJOR
    160. 

  160. and PCRE_MINOR to contain the major and minor release numbers for the library.
    161. 

  161. Applications can use these to include support for different releases of PCRE.
    162. 

  162. </P>
    163. 

  163. <P>
    164. 

  164. The functions <b>pcre_compile()</b>, <b>pcre_compile2()</b>, <b>pcre_study()</b>,
    165. 

  165. and <b>pcre_exec()</b> are used for compiling and matching regular expressions
    166. 

  166. in a Perl-compatible manner. A sample program that demonstrates the simplest
    167. 

  167. way of using them is provided in the file called <i>pcredemo.c</i> in the source
    168. 

  168. distribution. The
    169. 

  169. <a href="pcresample.html"><b>pcresample</b></a>
    170. 

  170. documentation describes how to compile and run it.
    171. 

  171. </P>
    172. 

  172. <P>
    173. 

  173. A second matching function, <b>pcre_dfa_exec()</b>, which is not
    174. 

  174. Perl-compatible, is also provided. This uses a different algorithm for the
    175. 

  175. matching. The alternative algorithm finds all possible matches (at a given
    176. 

  176. point in the subject), and scans the subject just once. However, this algorithm
    177. 

  177. does not return captured substrings. A description of the two matching
    178. 

  178. algorithms and their advantages and disadvantages is given in the
    179. 

  179. <a href="pcrematching.html"><b>pcrematching</b></a>
    180. 

  180. documentation.
    181. 

  181. </P>
    182. 

  182. <P>
    183. 

  183. In addition to the main compiling and matching functions, there are convenience
    184. 

  184. functions for extracting captured substrings from a subject string that is
    185. 

  185. matched by <b>pcre_exec()</b>. They are:
    186. 

  186. <pre>
    187. 

  187.   <b>pcre_copy_substring()</b>
    188. 

  188.   <b>pcre_copy_named_substring()</b>
    189. 

  189.   <b>pcre_get_substring()</b>
    190. 

  190.   <b>pcre_get_named_substring()</b>
    191. 

  191.   <b>pcre_get_substring_list()</b>
    192. 

  192.   <b>pcre_get_stringnumber()</b>
    193. 

  193.   <b>pcre_get_stringtable_entries()</b>
    194. 

  194. </pre>
    195. 

  195. <b>pcre_free_substring()</b> and <b>pcre_free_substring_list()</b> are also
    196. 

  196. provided, to free the memory used for extracted strings.
    197. 

  197. </P>
    198. 

  198. <P>
    199. 

  199. The function <b>pcre_maketables()</b> is used to build a set of character tables
    200. 

  200. in the current locale for passing to <b>pcre_compile()</b>, <b>pcre_exec()</b>,
    201. 

  201. or <b>pcre_dfa_exec()</b>. This is an optional facility that is provided for
    202. 

  202. specialist use. Most commonly, no special tables are passed, in which case
    203. 

  203. internal tables that are generated when PCRE is built are used.
    204. 

  204. </P>
    205. 

  205. <P>
    206. 

  206. The function <b>pcre_fullinfo()</b> is used to find out information about a
    207. 

  207. compiled pattern; <b>pcre_info()</b> is an obsolete version that returns only
    208. 

  208. some of the available information, but is retained for backwards compatibility.
    209. 

  209. The function <b>pcre_version()</b> returns a pointer to a string containing the
    210. 

  210. version of PCRE and its date of release.
    211. 

  211. </P>
    212. 

  212. <P>
    213. 

  213. The function <b>pcre_refcount()</b> maintains a reference count in a data block
    214. 

  214. containing a compiled pattern. This is provided for the benefit of
    215. 

  215. object-oriented applications.
    216. 

  216. </P>
    217. 

  217. <P>
    218. 

  218. The global variables <b>pcre_malloc</b> and <b>pcre_free</b> initially contain
    219. 

  219. the entry points of the standard <b>malloc()</b> and <b>free()</b> functions,
    220. 

  220. respectively. PCRE calls the memory management functions via these variables,
    221. 

  221. so a calling program can replace them if it wishes to intercept the calls. This
    222. 

  222. should be done before calling any PCRE functions.
    223. 

  223. </P>
    224. 

  224. <P>
    225. 

  225. The global variables <b>pcre_stack_malloc</b> and <b>pcre_stack_free</b> are also
    226. 

  226. indirections to memory management functions. These special functions are used
    227. 

  227. only when PCRE is compiled to use the heap for remembering data, instead of
    228. 

  228. recursive function calls, when running the <b>pcre_exec()</b> function. See the
    229. 

  229. <a href="pcrebuild.html"><b>pcrebuild</b></a>
    230. 

  230. documentation for details of how to do this. It is a non-standard way of
    231. 

  231. building PCRE, for use in environments that have limited stacks. Because of the
    232. 

  232. greater use of memory management, it runs more slowly. Separate functions are
    233. 

  233. provided so that special-purpose external code can be used for this case. When
    234. 

  234. used, these functions are always called in a stack-like manner (last obtained,
    235. 

  235. first freed), and always for memory blocks of the same size. There is a
    236. 

  236. discussion about PCRE's stack usage in the
    237. 

  237. <a href="pcrestack.html"><b>pcrestack</b></a>
    238. 

  238. documentation.
    239. 

  239. </P>
    240. 

  240. <P>
    241. 

  241. The global variable <b>pcre_callout</b> initially contains NULL. It can be set
    242. 

  242. by the caller to a "callout" function, which PCRE will then call at specified
    243. 

  243. points during a matching operation. Details are given in the
    244. 

  244. <a href="pcrecallout.html"><b>pcrecallout</b></a>
    245. 

  245. documentation.
    246. 

  246. <a name="newlines"></a></P>
    247. 

  247. <br><a name="SEC3" href="#TOC1">NEWLINES</a><br>
    248. 

  248. <P>
    249. 

  249. PCRE supports five different conventions for indicating line breaks in
    250. 

  250. strings: a single CR (carriage return) character, a single LF (linefeed)
    251. 

  251. character, the two-character sequence CRLF, any of the three preceding, or any
    252. 

  252. Unicode newline sequence. The Unicode newline sequences are the three just
    253. 

  253. mentioned, plus the single characters VT (vertical tab, U+000B), FF (formfeed,
    254. 

  254. U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS
    255. 

  255. (paragraph separator, U+2029).
    256. 

  256. </P>
    257. 

  257. <P>
    258. 

  258. Each of the first three conventions is used by at least one operating system as
    259. 

  259. its standard newline sequence. When PCRE is built, a default can be specified.
    260. 

  260. The default default is LF, which is the Unix standard. When PCRE is run, the
    261. 

  261. default can be overridden, either when a pattern is compiled, or when it is
    262. 

  262. matched.
    263. 

  263. </P>
    264. 

  264. <P>
    265. 

  265. At compile time, the newline convention can be specified by the <i>options</i>
    266. 

  266. argument of <b>pcre_compile()</b>, or it can be specified by special text at the
    267. 

  267. start of the pattern itself; this overrides any other settings. See the
    268. 

  268. <a href="pcrepattern.html"><b>pcrepattern</b></a>
    269. 

  269. page for details of the special character sequences.
    270. 

  270. </P>
    271. 

  271. <P>
    272. 

  272. In the PCRE documentation the word "newline" is used to mean "the character or
    273. 

  273. pair of characters that indicate a line break". The choice of newline
    274. 

  274. convention affects the handling of the dot, circumflex, and dollar
    275. 

  275. metacharacters, the handling of #-comments in /x mode, and, when CRLF is a
    276. 

  276. recognized line ending sequence, the match position advancement for a
    277. 

  277. non-anchored pattern. There is more detail about this in the
    278. 

  278. <a href="#execoptions">section on <b>pcre_exec()</b> options</a>
    279. 

  279. below.
    280. 

  280. </P>
    281. 

  281. <P>
    282. 

  282. The choice of newline convention does not affect the interpretation of
    283. 

  283. the \n or \r escape sequences, nor does it affect what \R matches, which is
    284. 

  284. controlled in a similar way, but by separate options.
    285. 

  285. </P>
    286. 

  286. <br><a name="SEC4" href="#TOC1">MULTITHREADING</a><br>
    287. 

  287. <P>
    288. 

  288. The PCRE functions can be used in multi-threading applications, with the
    289. 

  289. proviso that the memory management functions pointed to by <b>pcre_malloc</b>,
    290. 

  290. <b>pcre_free</b>, <b>pcre_stack_malloc</b>, and <b>pcre_stack_free</b>, and the
    291. 

  291. callout function pointed to by <b>pcre_callout</b>, are shared by all threads.
    292. 

  292. </P>
    293. 

  293. <P>
    294. 

  294. The compiled form of a regular expression is not altered during matching, so
    295. 

  295. the same compiled pattern can safely be used by several threads at once.
    296. 

  296. </P>
    297. 

  297. <br><a name="SEC5" href="#TOC1">SAVING PRECOMPILED PATTERNS FOR LATER USE</a><br>
    298. 

  298. <P>
    299. 

  299. The compiled form of a regular expression can be saved and re-used at a later
    300. 

  300. time, possibly by a different program, and even on a host other than the one on
    301. 

  301. which it was compiled. Details are given in the
    302. 

  302. <a href="pcreprecompile.html"><b>pcreprecompile</b></a>
    303. 

  303. documentation. However, compiling a regular expression with one version of PCRE
    304. 

  304. for use with a different version is not guaranteed to work and may cause
    305. 

  305. crashes.
    306. 

  306. </P>
    307. 

  307. <br><a name="SEC6" href="#TOC1">CHECKING BUILD-TIME OPTIONS</a><br>
    308. 

  308. <P>
    309. 

  309. <b>int pcre_config(int <i>what</i>, void *<i>where</i>);</b>
    310. 

  310. </P>
    311. 

  311. <P>
    312. 

  312. The function <b>pcre_config()</b> makes it possible for a PCRE client to
    313. 

  313. discover which optional features have been compiled into the PCRE library. The
    314. 

  314. <a href="pcrebuild.html"><b>pcrebuild</b></a>
    315. 

  315. documentation has more details about these optional features.
    316. 

  316. </P>
    317. 

  317. <P>
    318. 

  318. The first argument for <b>pcre_config()</b> is an integer, specifying which
    319. 

  319. information is required; the second argument is a pointer to a variable into
    320. 

  320. which the information is placed. The following information is available:
    321. 

  321. <pre>
    322. 

  322.   PCRE_CONFIG_UTF8
    323. 

  323. </pre>
    324. 

  324. The output is an integer that is set to one if UTF-8 support is available;
    325. 

  325. otherwise it is set to zero.
    326. 

  326. <pre>
    327. 

  327.   PCRE_CONFIG_UNICODE_PROPERTIES
    328. 

  328. </pre>
    329. 

  329. The output is an integer that is set to one if support for Unicode character
    330. 

  330. properties is available; otherwise it is set to zero.
    331. 

  331. <pre>
    332. 

  332.   PCRE_CONFIG_NEWLINE
    333. 

  333. </pre>
    334. 

  334. The output is an integer whose value specifies the default character sequence
    335. 

  335. that is recognized as meaning "newline". The four values that are supported
    336. 

  336. are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. The
    337. 

  337. default should normally be the standard sequence for your operating system.
    338. 

  338. <pre>
    339. 

  339.   PCRE_CONFIG_BSR
    340. 

  340. </pre>
    341. 

  341. The output is an integer whose value indicates what character sequences the \R
    342. 

  342. escape sequence matches by default. A value of 0 means that \R matches any
    343. 

  343. Unicode line ending sequence; a value of 1 means that \R matches only CR, LF,
    344. 

  344. or CRLF. The default can be overridden when a pattern is compiled or matched.
    345. 

  345. <pre>
    346. 

  346.   PCRE_CONFIG_LINK_SIZE
    347. 

  347. </pre>
    348. 

  348. The output is an integer that contains the number of bytes used for internal
    349. 

  349. linkage in compiled regular expressions. The value is 2, 3, or 4. Larger values
    350. 

  350. allow larger regular expressions to be compiled, at the expense of slower
    351. 

  351. matching. The default value of 2 is sufficient for all but the most massive
    352. 

  352. patterns, since it allows the compiled pattern to be up to 64K in size.
    353. 

  353. <pre>
    354. 

  354.   PCRE_CONFIG_POSIX_MALLOC_THRESHOLD
    355. 

  355. </pre>
    356. 

  356. The output is an integer that contains the threshold above which the POSIX
    357. 

  357. interface uses <b>malloc()</b> for output vectors. Further details are given in
    358. 

  358. the
    359. 

  359. <a href="pcreposix.html"><b>pcreposix</b></a>
    360. 

  360. documentation.
    361. 

  361. <pre>
    362. 

  362.   PCRE_CONFIG_MATCH_LIMIT
    363. 

  363. </pre>
    364. 

  364. The output is an integer that gives the default limit for the number of
    365. 

  365. internal matching function calls in a <b>pcre_exec()</b> execution. Further
    366. 

  366. details are given with <b>pcre_exec()</b> below.
    367. 

  367. <pre>
    368. 

  368.   PCRE_CONFIG_MATCH_LIMIT_RECURSION
    369. 

  369. </pre>
    370. 

  370. The output is an integer that gives the default limit for the depth of
    371. 

  371. recursion when calling the internal matching function in a <b>pcre_exec()</b>
    372. 

  372. execution. Further details are given with <b>pcre_exec()</b> below.
    373. 

  373. <pre>
    374. 

  374.   PCRE_CONFIG_STACKRECURSE
    375. 

  375. </pre>
    376. 

  376. The output is an integer that is set to one if internal recursion when running
    377. 

  377. <b>pcre_exec()</b> is implemented by recursive function calls that use the stack
    378. 

  378. to remember their state. This is the usual way that PCRE is compiled. The
    379. 

  379. output is zero if PCRE was compiled to use blocks of data on the heap instead
    380. 

  380. of recursive function calls. In this case, <b>pcre_stack_malloc</b> and
    381. 

  381. <b>pcre_stack_free</b> are called to manage memory blocks on the heap, thus
    382. 

  382. avoiding the use of the stack.
    383. 

  383. </P>
    384. 

  384. <br><a name="SEC7" href="#TOC1">COMPILING A PATTERN</a><br>
    385. 

  385. <P>
    386. 

  386. <b>pcre *pcre_compile(const char *<i>pattern</i>, int <i>options</i>,</b>
    387. 

  387. <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
    388. 

  388. <b>const unsigned char *<i>tableptr</i>);</b>
    389. 

  389. <b>pcre *pcre_compile2(const char *<i>pattern</i>, int <i>options</i>,</b>
    390. 

  390. <b>int *<i>errorcodeptr</i>,</b>
    391. 

  391. <b>const char **<i>errptr</i>, int *<i>erroffset</i>,</b>
    392. 

  392. <b>const unsigned char *<i>tableptr</i>);</b>
    393. 

  393. </P>
    394. 

  394. <P>
    395. 

  395. Either of the functions <b>pcre_compile()</b> or <b>pcre_compile2()</b> can be
    396. 

  396. called to compile a pattern into an internal form. The only difference between
    397. 

  397. the two interfaces is that <b>pcre_compile2()</b> has an additional argument,
    398. 

  398. <i>errorcodeptr</i>, via which a numerical error code can be returned.
    399. 

  399. </P>
    400. 

  400. <P>
    401. 

  401. The pattern is a C string terminated by a binary zero, and is passed in the
    402. 

  402. <i>pattern</i> argument. A pointer to a single block of memory that is obtained
    403. 

  403. via <b>pcre_malloc</b> is returned. This contains the compiled code and related
    404. 

  404. data. The <b>pcre</b> type is defined for the returned block; this is a typedef
    405. 

  405. for a structure whose contents are not externally defined. It is up to the
    406. 

  406. caller to free the memory (via <b>pcre_free</b>) when it is no longer required.
    407. 

  407. </P>
    408. 

  408. <P>
    409. 

  409. Although the compiled code of a PCRE regex is relocatable, that is, it does not
    410. 

  410. depend on memory location, the complete <b>pcre</b> data block is not
    411. 

  411. fully relocatable, because it may contain a copy of the <i>tableptr</i>
    412. 

  412. argument, which is an address (see below).
    413. 

  413. </P>
    414. 

  414. <P>
    415. 

  415. The <i>options</i> argument contains various bit settings that affect the
    416. 

  416. compilation. It should be zero if no options are required. The available
    417. 

  417. options are described below. Some of them, in particular, those that are
    418. 

  418. compatible with Perl, can also be set and unset from within the pattern (see
    419. 

  419. the detailed description in the
    420. 

  420. <a href="pcrepattern.html"><b>pcrepattern</b></a>
    421. 

  421. documentation). For these options, the contents of the <i>options</i> argument
    422. 

  422. specifies their initial settings at the start of compilation and execution. The
    423. 

  423. PCRE_ANCHORED and PCRE_NEWLINE_<i>xxx</i> options can be set at the time of
    424. 

  424. matching as well as at compile time.
    425. 

  425. </P>
    426. 

  426. <P>
    427. 

  427. If <i>errptr</i> is NULL, <b>pcre_compile()</b> returns NULL immediately.
    428. 

  428. Otherwise, if compilation of a pattern fails, <b>pcre_compile()</b> returns
    429. 

  429. NULL, and sets the variable pointed to by <i>errptr</i> to point to a textual
    430. 

  430. error message. This is a static string that is part of the library. You must
    431. 

  431. not try to free it. The offset from the start of the pattern to the character
    432. 

  432. where the error was discovered is placed in the variable pointed to by
    433. 

  433. <i>erroffset</i>, which must not be NULL. If it is, an immediate error is given.
    434. 

  434. </P>
    435. 

  435. <P>
    436. 

  436. If <b>pcre_compile2()</b> is used instead of <b>pcre_compile()</b>, and the
    437. 

  437. <i>errorcodeptr</i> argument is not NULL, a non-zero error code number is
    438. 

  438. returned via this argument in the event of an error. This is in addition to the
    439. 

  439. textual error message. Error codes and messages are listed below.
    440. 

  440. </P>
    441. 

  441. <P>
    442. 

  442. If the final argument, <i>tableptr</i>, is NULL, PCRE uses a default set of
    443. 

  443. character tables that are built when PCRE is compiled, using the default C
    444. 

  444. locale. Otherwise, <i>tableptr</i> must be an address that is the result of a
    445. 

  445. call to <b>pcre_maketables()</b>. This value is stored with the compiled
    446. 

  446. pattern, and used again by <b>pcre_exec()</b>, unless another table pointer is
    447. 

  447. passed to it. For more discussion, see the section on locale support below.
    448. 

  448. </P>
    449. 

  449. <P>
    450. 

  450. This code fragment shows a typical straightforward call to <b>pcre_compile()</b>:
    451. 

  451. <pre>
    452. 

  452.   pcre *re;
    453. 

  453.   const char *error;
    454. 

  454.   int erroffset;
    455. 

  455.   re = pcre_compile(
    456. 

  456.     "^A.*Z",          /* the pattern */
    457. 

  457.     0,                /* default options */
    458. 

  458.     &error,           /* for error message */
    459. 

  459.     &erroffset,       /* for error offset */
    460. 

  460.     NULL);            /* use default character tables */
    461. 

  461. </pre>
    462. 

  462. The following names for option bits are defined in the <b>pcre.h</b> header
    463. 

  463. file:
    464. 

  464. <pre>
    465. 

  465.   PCRE_ANCHORED
    466. 

  466. </pre>
    467. 

  467. If this bit is set, the pattern is forced to be "anchored", that is, it is
    468. 

  468. constrained to match only at the first matching point in the string that is
    469. 

  469. being searched (the "subject string"). This effect can also be achieved by
    470. 

  470. appropriate constructs in the pattern itself, which is the only way to do it in
    471. 

  471. Perl.
    472. 

  472. <pre>
    473. 

  473.   PCRE_AUTO_CALLOUT
    474. 

  474. </pre>
    475. 

  475. If this bit is set, <b>pcre_compile()</b> automatically inserts callout items,
    476. 

  476. all with number 255, before each pattern item. For discussion of the callout
    477. 

  477. facility, see the
    478. 

  478. <a href="pcrecallout.html"><b>pcrecallout</b></a>
    479. 

  479. documentation.
    480. 

  480. <pre>
    481. 

  481.   PCRE_BSR_ANYCRLF
    482. 

  482.   PCRE_BSR_UNICODE
    483. 

  483. </pre>
    484. 

  484. These options (which are mutually exclusive) control what the \R escape
    485. 

  485. sequence matches. The choice is either to match only CR, LF, or CRLF, or to
    486. 

  486. match any Unicode newline sequence. The default is specified when PCRE is
    487. 

  487. built. It can be overridden from within the pattern, or by setting an option
    488. 

  488. when a compiled pattern is matched.
    489. 

  489. <pre>
    490. 

  490.   PCRE_CASELESS
    491. 

  491. </pre>
    492. 

  492. If this bit is set, letters in the pattern match both upper and lower case
    493. 

  493. letters. It is equivalent to Perl's /i option, and it can be changed within a
    494. 

  494. pattern by a (?i) option setting. In UTF-8 mode, PCRE always understands the
    495. 

  495. concept of case for characters whose values are less than 128, so caseless
    496. 

  496. matching is always possible. For characters with higher values, the concept of
    497. 

  497. case is supported if PCRE is compiled with Unicode property support, but not
    498. 

  498. otherwise. If you want to use caseless matching for characters 128 and above,
    499. 

  499. you must ensure that PCRE is compiled with Unicode property support as well as
    500. 

  500. with UTF-8 support.
    501. 

  501. <pre>
    502. 

  502.   PCRE_DOLLAR_ENDONLY
    503. 

  503. </pre>
    504. 

  504. If this bit is set, a dollar metacharacter in the pattern matches only at the
    505. 

  505. end of the subject string. Without this option, a dollar also matches
    506. 

  506. immediately before a newline at the end of the string (but not before any other
    507. 

  507. newlines). The PCRE_DOLLAR_ENDONLY option is ignored if PCRE_MULTILINE is set.
    508. 

  508. There is no equivalent to this option in Perl, and no way to set it within a
    509. 

  509. pattern.
    510. 

  510. <pre>
    511. 

  511.   PCRE_DOTALL
    512. 

  512. </pre>
    513. 

  513. If this bit is set, a dot metacharater in the pattern matches all characters,
    514. 

  514. including those that indicate newline. Without it, a dot does not match when
    515. 

  515. the current position is at a newline. This option is equivalent to Perl's /s
    516. 

  516. option, and it can be changed within a pattern by a (?s) option setting. A
    517. 

  517. negative class such as [^a] always matches newline characters, independent of
    518. 

  518. the setting of this option.
    519. 

  519. <pre>
    520. 

  520.   PCRE_DUPNAMES
    521. 

  521. </pre>
    522. 

  522. If this bit is set, names used to identify capturing subpatterns need not be
    523. 

  523. unique. This can be helpful for certain types of pattern when it is known that
    524. 

  524. only one instance of the named subpattern can ever be matched. There are more
    525. 

  525. details of named subpatterns below; see also the
    526. 

  526. <a href="pcrepattern.html"><b>pcrepattern</b></a>
    527. 

  527. documentation.
    528. 

  528. <pre>
    529. 

  529.   PCRE_EXTENDED
    530. 

  530. </pre>
    531. 

  531. If this bit is set, whitespace data characters in the pattern are totally
    532. 

  532. ignored except when escaped or inside a character class. Whitespace does not
    533. 

  533. include the VT character (code 11). In addition, characters between an
    534. 

  534. unescaped # outside a character class and the next newline, inclusive, are also
    535. 

  535. ignored. This is equivalent to Perl's /x option, and it can be changed within a
    536. 

  536. pattern by a (?x) option setting.
    537. 

  537. </P>
    538. 

  538. <P>
    539. 

  539. This option makes it possible to include comments inside complicated patterns.
    540. 

  540. Note, however, that this applies only to data characters. Whitespace characters
    541. 

  541. may never appear within special character sequences in a pattern, for example
    542. 

  542. within the sequence (?( which introduces a conditional subpattern.
    543. 

  543. <pre>
    544. 

  544.   PCRE_EXTRA
    545. 

  545. </pre>
    546. 

  546. This option was invented in order to turn on additional functionality of PCRE
    547. 

  547. that is incompatible with Perl, but it is currently of very little use. When
    548. 

  548. set, any backslash in a pattern that is followed by a letter that has no
    549. 

  549. special meaning causes an error, thus reserving these combinations for future
    550. 

  550. expansion. By default, as in Perl, a backslash followed by a letter with no
    551. 

  551. special meaning is treated as a literal. (Perl can, however, be persuaded to
    552. 

  552. give a warning for this.) There are at present no other features controlled by
    553. 

  553. this option. It can also be set by a (?X) option setting within a pattern.
    554. 

  554. <pre>
    555. 

  555.   PCRE_FIRSTLINE
    556. 

  556. </pre>
    557. 

  557. If this option is set, an unanchored pattern is required to match before or at
    558. 

  558. the first newline in the subject string, though the matched text may continue
    559. 

  559. over the newline.
    560. 

  560. <pre>
    561. 

  561.   PCRE_JAVASCRIPT_COMPAT
    562. 

  562. </pre>
    563. 

  563. If this option is set, PCRE's behaviour is changed in some ways so that it is
    564. 

  564. compatible with JavaScript rather than Perl. The changes are as follows:
    565. 

  565. </P>
    566. 

  566. <P>
    567. 

  567. (1) A lone closing square bracket in a pattern causes a compile-time error,
    568. 

  568. because this is illegal in JavaScript (by default it is treated as a data
    569. 

  569. character). Thus, the pattern AB]CD becomes illegal when this option is set.
    570. 

  570. </P>
    571. 

  571. <P>
    572. 

  572. (2) At run time, a back reference to an unset subpattern group matches an empty
    573. 

  573. string (by default this causes the current matching alternative to fail). A
    574. 

  574. pattern such as (\1)(a) succeeds when this option is set (assuming it can find
    575. 

  575. an "a" in the subject), whereas it fails by default, for Perl compatibility.
    576. 

  576. <pre>
    577. 

  577.   PCRE_MULTILINE
    578. 

  578. </pre>
    579. 

  579. By default, PCRE treats the subject string as consisting of a single line of
    580. 

  580. characters (even if it actually contains newlines). The "start of line"
    581. 

  581. metacharacter (^) matches only at the start of the string, while the "end of
    582. 

  582. line" metacharacter ($) matches only at the end of the string, or before a
    583. 

  583. terminating newline (unless PCRE_DOLLAR_ENDONLY is set). This is the same as
    584. 

  584. Perl.
    585. 

  585. </P>
    586. 

  586. <P>
    587. 

  587. When PCRE_MULTILINE it is set, the "start of line" and "end of line" constructs
    588. 

  588. match immediately following or immediately before internal newlines in the
    589. 

  589. subject string, respectively, as well as at the very start and end. This is
    590. 

  590. equivalent to Perl's /m option, and it can be changed within a pattern by a
    591. 

  591. (?m) option setting. If there are no newlines in a subject string, or no
    592. 

  592. occurrences of ^ or $ in a pattern, setting PCRE_MULTILINE has no effect.
    593. 

  593. <pre>
    594. 

  594.   PCRE_NEWLINE_CR
    595. 

  595.   PCRE_NEWLINE_LF
    596. 

  596.   PCRE_NEWLINE_CRLF
    597. 

  597.   PCRE_NEWLINE_ANYCRLF
    598. 

  598.   PCRE_NEWLINE_ANY
    599. 

  599. </pre>
    600. 

  600. These options override the default newline definition that was chosen when PCRE
    601. 

  601. was built. Setting the first or the second specifies that a newline is
    602. 

  602. indicated by a single character (CR or LF, respectively). Setting
    603. 

  603. PCRE_NEWLINE_CRLF specifies that a newline is indicated by the two-character
    604. 

  604. CRLF sequence. Setting PCRE_NEWLINE_ANYCRLF specifies that any of the three
    605. 

  605. preceding sequences should be recognized. Setting PCRE_NEWLINE_ANY specifies
    606. 

  606. that any Unicode newline sequence should be recognized. The Unicode newline
    607. 

  607. sequences are the three just mentioned, plus the single characters VT (vertical
    608. 

  608. tab, U+000B), FF (formfeed, U+000C), NEL (next line, U+0085), LS (line
    609. 

  609. separator, U+2028), and PS (paragraph separator, U+2029). The last two are
    610. 

  610. recognized only in UTF-8 mode.
    611. 

  611. </P>
    612. 

  612. <P>
    613. 

  613. The newline setting in the options word uses three bits that are treated
    614. 

  614. as a number, giving eight possibilities. Currently only six are used (default
    615. 

  615. plus the five values above). This means that if you set more than one newline
    616. 

  616. option, the combination may or may not be sensible. For example,
    617. 

  617. PCRE_NEWLINE_CR with PCRE_NEWLINE_LF is equivalent to PCRE_NEWLINE_CRLF, but
    618. 

  618. other combinations may yield unused numbers and cause an error.
    619. 

  619. </P>
    620. 

  620. <P>
    621. 

  621. The only time that a line break is specially recognized when compiling a
    622. 

  622. pattern is if PCRE_EXTENDED is set, and an unescaped # outside a character
    623. 

  623. class is encountered. This indicates a comment that lasts until after the next
    624. 

  624. line break sequence. In other circumstances, line break sequences are treated
    625. 

  625. as literal data, except that in PCRE_EXTENDED mode, both CR and LF are treated
    626. 

  626. as whitespace characters and are therefore ignored.
    627. 

  627. </P>
    628. 

  628. <P>
    629. 

  629. The newline option that is set at compile time becomes the default that is used
    630. 

  630. for <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, but it can be overridden.
    631. 

  631. <pre>
    632. 

  632.   PCRE_NO_AUTO_CAPTURE
    633. 

  633. </pre>
    634. 

  634. If this option is set, it disables the use of numbered capturing parentheses in
    635. 

  635. the pattern. Any opening parenthesis that is not followed by ? behaves as if it
    636. 

  636. were followed by ?: but named parentheses can still be used for capturing (and
    637. 

  637. they acquire numbers in the usual way). There is no equivalent of this option
    638. 

  638. in Perl.
    639. 

  639. <pre>
    640. 

  640.   PCRE_UNGREEDY
    641. 

  641. </pre>
    642. 

  642. This option inverts the "greediness" of the quantifiers so that they are not
    643. 

  643. greedy by default, but become greedy if followed by "?". It is not compatible
    644. 

  644. with Perl. It can also be set by a (?U) option setting within the pattern.
    645. 

  645. <pre>
    646. 

  646.   PCRE_UTF8
    647. 

  647. </pre>
    648. 

  648. This option causes PCRE to regard both the pattern and the subject as strings
    649. 

  649. of UTF-8 characters instead of single-byte character strings. However, it is
    650. 

  650. available only when PCRE is built to include UTF-8 support. If not, the use
    651. 

  651. of this option provokes an error. Details of how this option changes the
    652. 

  652. behaviour of PCRE are given in the
    653. 

  653. <a href="pcre.html#utf8support">section on UTF-8 support</a>
    654. 

  654. in the main
    655. 

  655. <a href="pcre.html"><b>pcre</b></a>
    656. 

  656. page.
    657. 

  657. <pre>
    658. 

  658.   PCRE_NO_UTF8_CHECK
    659. 

  659. </pre>
    660. 

  660. When PCRE_UTF8 is set, the validity of the pattern as a UTF-8 string is
    661. 

  661. automatically checked. There is a discussion about the
    662. 

  662. <a href="pcre.html#utf8strings">validity of UTF-8 strings</a>
    663. 

  663. in the main
    664. 

  664. <a href="pcre.html"><b>pcre</b></a>
    665. 

  665. page. If an invalid UTF-8 sequence of bytes is found, <b>pcre_compile()</b>
    666. 

  666. returns an error. If you already know that your pattern is valid, and you want
    667. 

  667. to skip this check for performance reasons, you can set the PCRE_NO_UTF8_CHECK
    668. 

  668. option. When it is set, the effect of passing an invalid UTF-8 string as a
    669. 

  669. pattern is undefined. It may cause your program to crash. Note that this option
    670. 

  670. can also be passed to <b>pcre_exec()</b> and <b>pcre_dfa_exec()</b>, to suppress
    671. 

  671. the UTF-8 validity checking of subject strings.
    672. 

  672. </P>
    673. 

  673. <br><a name="SEC8" href="#TOC1">COMPILATION ERROR CODES</a><br>
    674. 

  674. <P>
    675. 

  675. The following table lists the error codes than may be returned by
    676. 

  676. <b>pcre_compile2()</b>, along with the error messages that may be returned by
    677. 

  677. both compiling functions. As PCRE has developed, some error codes have fallen
    678. 

  678. out of use. To avoid confusion, they have not been re-used.
    679. 

  679. <pre>
    680. 

  680.    0  no error
    681. 

  681.    1  \ at end of pattern
    682. 

  682.    2  \c at end of pattern
    683. 

  683.    3  unrecognized character follows \
    684. 

  684.    4  numbers out of order in {} quantifier
    685. 

  685.    5  number too big in {} quantifier
    686. 

  686.    6  missing terminating ] for character class
    687. 

  687.    7  invalid escape sequence in character class
    688. 

  688.    8  range out of order in character class
    689. 

  689.    9  nothing to repeat
    690. 

  690.   10  [this code is not in use]
    691. 

  691.   11  internal error: unexpected repeat
    692. 

  692.   12  unrecognized character after (? or (?-
    693. 

  693.   13  POSIX named classes are supported only within a class
    694. 

  694.   14  missing )
    695. 

  695.   15  reference to non-existent subpattern
    696. 

  696.   16  erroffset passed as NULL
    697. 

  697.   17  unknown option bit(s) set
    698. 

  698.   18  missing ) after comment
    699. 

  699.   19  [this code is not in use]
    700. 

  700.   20  regular expression is too large
    701. 

  701.   21  failed to get memory
    702. 

  702.   22  unmatched parentheses
    703. 

  703.   23  internal error: code overflow
    704. 

  704.   24  unrecognized character after (?&#60;
    705. 

  705.   25  lookbehind assertion is not fixed length
    706. 

  706.   26  malformed number or name after (?(
    707. 

  707.   27  conditional group contains more than two branches
    708. 

  708.   28  assertion expected after (?(
    709. 

  709.   29  (?R or (?[+-]digits must be followed by )
    710. 

  710.   30  unknown POSIX class name
    711. 

  711.   31  POSIX collating elements are not supported
    712. 

  712.   32  this version of PCRE is not compiled with PCRE_UTF8 support
    713. 

  713.   33  [this code is not in use]
    714. 

  714.   34  character value in \x{...} sequence is too large
    715. 

  715.   35  invalid condition (?(0)
    716. 

  716.   36  \C not allowed in lookbehind assertion
    717. 

  717.   37  PCRE does not support \L, \l, \N, \U, or \u
    718. 

  718.   38  number after (?C is &#62; 255
    719. 

  719.   39  closing ) for (?C expected
    720. 

  720.   40  recursive call could loop indefinitely
    721. 

  721.   41  unrecognized character after (?P
    722. 

  722.   42  syntax error in subpattern name (missing terminator)
    723. 

  723.   43  two named subpatterns have the same name
    724. 

  724.   44  invalid UTF-8 string
    725. 

  725.   45  support for \P, \p, and \X has not been compiled
    726. 

  726.   46  malformed \P or \p sequence
    727. 

  727.   47  unknown property name after \P or \p
    728. 

  728.   48  subpattern name is too long (maximum 32 characters)
    729. 

  729.   49  too many named subpatterns (maximum 10000)
    730. 

  730.   50  [this code is not in use]
    731. 

  731.   51  octal value is greater than \377 (not in UTF-8 mode)
    732. 

  732.   52  internal error: overran compiling workspace
    733. 

  733.   53  internal error: previously-checked referenced subpattern not found
    734. 

  734.   54  DEFINE group contains more than one branch
    735. 

  735.   55  repeating a DEFINE group is not allowed
    736. 

  736.   56  inconsistent NEWLINE options
    737. 

  737.   57  \g is not followed by a braced, angle-bracketed, or quoted
    738. 

  738.         name/number or by a plain number
    739. 

  739.   58  a numbered reference must not be zero
    740. 

  740.   59  (*VERB) with an argument is not supported
    741. 

  741.   60  (*VERB) not recognized
    742. 

  742.   61  number is too big
    743. 

  743.   62  subpattern name expected
    744. 

  744.   63  digit expected after (?+
    745. 

  745.   64  ] is an invalid data character in JavaScript compatibility mode
    746. 

  746. </pre>
    747. 

  747. The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
    748. 

  748. be used if the limits were changed when PCRE was built.
    749. 

  749. </P>
    750. 

  750. <br><a name="SEC9" href="#TOC1">STUDYING A PATTERN</a><br>
    751. 

  751. <P>
    752. 

  752. <b>pcre_extra *pcre_study(const pcre *<i>code</i>, int <i>options</i></b>
    753. 

  753. <b>const char **<i>errptr</i>);</b>
    754. 

  754. </P>
    755. 

  755. <P>
    756. 

  756. If a compiled pattern is going to be used several times, it is worth spending
    757. 

  757. more time analyzing it in order to speed up the time taken for matching. The
    758. 

  758. function <b>pcre_study()</b> takes a pointer to a compiled pattern as its first
    759. 

  759. argument. If studying the pattern produces additional information that will
    760. 

  760. help speed up matching, <b>pcre_study()</b> returns a pointer to a
    761. 

  761. <b>pcre_extra</b> block, in which the <i>study_data</i> field points to the
    762. 

  762. results of the study.
    763. 

  763. </P>
    764. 

  764. <P>
    765. 

  765. The returned value from <b>pcre_study()</b> can be passed directly to
    766. 

  766. <b>pcre_exec()</b>. However, a <b>pcre_extra</b> block also contains other
    767. 

  767. fields that can be set by the caller before the block is passed; these are
    768. 

  768. described
    769. 

  769. <a href="#extradata">below</a>
    770. 

  770. in the section on matching a pattern.
    771. 

  771. </P>
    772. 

  772. <P>
    773. 

  773. If studying the pattern does not produce any additional information
    774. 

  774. <b>pcre_study()</b> returns NULL. In that circumstance, if the calling program
    775. 

  775. wants to pass any of the other fields to <b>pcre_exec()</b>, it must set up its
    776. 

  776. own <b>pcre_extra</b> block.
    777. 

  777. </P>
    778. 

  778. <P>
    779. 

  779. The second argument of <b>pcre_study()</b> contains option bits. At present, no
    780. 

  780. options are defined, and this argument should always be zero.
    781. 

  781. </P>
    782. 

  782. <P>
    783. 

  783. The third argument for <b>pcre_study()</b> is a pointer for an error message. If
    784. 

  784. studying succeeds (even if no data is returned), the variable it points to is
    785. 

  785. set to NULL. Otherwise it is set to point to a textual error message. This is a
    786. 

  786. static string that is part of the library. You must not try to free it. You
    787. 

  787. should test the error pointer for NULL after calling <b>pcre_study()</b>, to be
    788. 

  788. sure that it has run successfully.
    789. 

  789. </P>
    790. 

  790. <P>
    791. 

  791. This is a typical call to <b>pcre_study</b>():
    792. 

  792. <pre>
    793. 

  793.   pcre_extra *pe;
    794. 

  794.   pe = pcre_study(
    795. 

  795.     re,             /* result of pcre_compile() */
    796. 

  796.     0,              /* no options exist */
    797. 

  797.     &error);        /* set to NULL or points to a message */
    798. 

  798. </pre>
    799. 

  799. At present, studying a pattern is useful only for non-anchored patterns that do
    800. 

  800. not have a single fixed starting character. A bitmap of possible starting
    801. 

  801. bytes is created.
    802. 

  802. <a name="localesupport"></a></P>
    803. 

  803. <br><a name="SEC10" href="#TOC1">LOCALE SUPPORT</a><br>
    804. 

  804. <P>
    805. 

  805. PCRE handles caseless matching, and determines whether characters are letters,
    806. 

  806. digits, or whatever, by reference to a set of tables, indexed by character
    807. 

  807. value. When running in UTF-8 mode, this applies only to characters with codes
    808. 

  808. less than 128. Higher-valued codes never match escapes such as \w or \d, but
    809. 

  809. can be tested with \p if PCRE is built with Unicode character property
    810. 

  810. support. The use of locales with Unicode is discouraged. If you are handling
    811. 

  811. characters with codes greater than 128, you should either use UTF-8 and
    812. 

  812. Unicode, or use locales, but not try to mix the two.
    813. 

  813. </P>
    814. 

  814. <P>
    815. 

  815. PCRE contains an internal set of tables that are used when the final argument
    816. 

  816. of <b>pcre_compile()</b> is NULL. These are sufficient for many applications.
    817. 

  817. Normally, the internal tables recognize only ASCII characters. However, when
    818. 

  818. PCRE is built, it is possible to cause the internal tables to be rebuilt in the
    819. 

  819. default "C" locale of the local system, which may cause them to be different.
    820. 

  820. </P>
    821. 

  821. <P>
    822. 

  822. The internal tables can always be overridden by tables supplied by the
    823. 

  823. application that calls PCRE. These may be created in a different locale from
    824. 

  824. the default. As more and more applications change to using Unicode, the need
    825. 

  825. for this locale support is expected to die away.
    826. 

  826. </P>
    827. 

  827. <P>
    828. 

  828. External tables are built by calling the <b>pcre_maketables()</b> function,
    829. 

  829. which has no arguments, in the relevant locale. The result can then be passed
    830. 

  830. to <b>pcre_compile()</b> or <b>pcre_exec()</b> as often as necessary. For
    831. 

  831. example, to build and use tables that are appropriate for the French locale
    832. 

  832. (where accented characters with values greater than 128 are treated as letters),
    833. 

  833. the following code could be used:
    834. 

  834. <pre>
    835. 

  835.   setlocale(LC_CTYPE, "fr_FR");
    836. 

  836.   tables = pcre_maketables();
    837. 

  837.   re = pcre_compile(..., tables);
    838. 

  838. </pre>
    839. 

  839. The locale name "fr_FR" is used on Linux and other Unix-like systems; if you
    840. 

  840. are using Windows, the name for the French locale is "french".
    841. 

  841. </P>
    842. 

  842. <P>
    843. 

  843. When <b>pcre_maketables()</b> runs, the tables are built in memory that is
    844. 

  844. obtained via <b>pcre_malloc</b>. It is the caller's responsibility to ensure
    845. 

  845. that the memory containing the tables remains available for as long as it is
    846. 

  846. needed.
    847. 

  847. </P>
    848. 

  848. <P>
    849. 

  849. The pointer that is passed to <b>pcre_compile()</b> is saved with the compiled
    850. 

  850. pattern, and the same tables are used via this pointer by <b>pcre_study()</b>
    851. 

  851. and normally also by <b>pcre_exec()</b>. Thus, by default, for any single
    852. 

  852. pattern, compilation, studying and matching all happen in the same locale, but
    853. 

  853. different patterns can be compiled in different locales.
    854. 

  854. </P>
    855. 

  855. <P>
    856. 

  856. It is possible to pass a table pointer or NULL (indicating the use of the
    857. 

  857. internal tables) to <b>pcre_exec()</b>. Although not intended for this purpose,
    858. 

  858. this facility could be used to match a pattern in a different locale from the
    859. 

  859. one in which it was compiled. Passing table pointers at run time is discussed
    860. 

  860. below in the section on matching a pattern.
    861. 

  861. </P>
    862. 

  862. <br><a name="SEC11" href="#TOC1">INFORMATION ABOUT A PATTERN</a><br>
    863. 

  863. <P>
    864. 

  864. <b>int pcre_fullinfo(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
    865. 

  865. <b>int <i>what</i>, void *<i>where</i>);</b>
    866. 

  866. </P>
    867. 

  867. <P>
    868. 

  868. The <b>pcre_fullinfo()</b> function returns information about a compiled
    869. 

  869. pattern. It replaces the obsolete <b>pcre_info()</b> function, which is
    870. 

  870. nevertheless retained for backwards compability (and is documented below).
    871. 

  871. </P>
    872. 

  872. <P>
    873. 

  873. The first argument for <b>pcre_fullinfo()</b> is a pointer to the compiled
    874. 

  874. pattern. The second argument is the result of <b>pcre_study()</b>, or NULL if
    875. 

  875. the pattern was not studied. The third argument specifies which piece of
    876. 

  876. information is required, and the fourth argument is a pointer to a variable
    877. 

  877. to receive the data. The yield of the function is zero for success, or one of
    878. 

  878. the following negative numbers:
    879. 

  879. <pre>
    880. 

  880.   PCRE_ERROR_NULL       the argument <i>code</i> was NULL
    881. 

  881.                         the argument <i>where</i> was NULL
    882. 

  882.   PCRE_ERROR_BADMAGIC   the "magic number" was not found
    883. 

  883.   PCRE_ERROR_BADOPTION  the value of <i>what</i> was invalid
    884. 

  884. </pre>
    885. 

  885. The "magic number" is placed at the start of each compiled pattern as an simple
    886. 

  886. check against passing an arbitrary memory pointer. Here is a typical call of
    887. 

  887. <b>pcre_fullinfo()</b>, to obtain the length of the compiled pattern:
    888. 

  888. <pre>
    889. 

  889.   int rc;
    890. 

  890.   size_t length;
    891. 

  891.   rc = pcre_fullinfo(
    892. 

  892.     re,               /* result of pcre_compile() */
    893. 

  893.     pe,               /* result of pcre_study(), or NULL */
    894. 

  894.     PCRE_INFO_SIZE,   /* what is required */
    895. 

  895.     &length);         /* where to put the data */
    896. 

  896. </pre>
    897. 

  897. The possible values for the third argument are defined in <b>pcre.h</b>, and are
    898. 

  898. as follows:
    899. 

  899. <pre>
    900. 

  900.   PCRE_INFO_BACKREFMAX
    901. 

  901. </pre>
    902. 

  902. Return the number of the highest back reference in the pattern. The fourth
    903. 

  903. argument should point to an <b>int</b> variable. Zero is returned if there are
    904. 

  904. no back references.
    905. 

  905. <pre>
    906. 

  906.   PCRE_INFO_CAPTURECOUNT
    907. 

  907. </pre>
    908. 

  908. Return the number of capturing subpatterns in the pattern. The fourth argument
    909. 

  909. should point to an <b>int</b> variable.
    910. 

  910. <pre>
    911. 

  911.   PCRE_INFO_DEFAULT_TABLES
    912. 

  912. </pre>
    913. 

  913. Return a pointer to the internal default character tables within PCRE. The
    914. 

  914. fourth argument should point to an <b>unsigned char *</b> variable. This
    915. 

  915. information call is provided for internal use by the <b>pcre_study()</b>
    916. 

  916. function. External callers can cause PCRE to use its internal tables by passing
    917. 

  917. a NULL table pointer.
    918. 

  918. <pre>
    919. 

  919.   PCRE_INFO_FIRSTBYTE
    920. 

  920. </pre>
    921. 

  921. Return information about the first byte of any matched string, for a
    922. 

  922. non-anchored pattern. The fourth argument should point to an <b>int</b>
    923. 

  923. variable. (This option used to be called PCRE_INFO_FIRSTCHAR; the old name is
    924. 

  924. still recognized for backwards compatibility.)
    925. 

  925. </P>
    926. 

  926. <P>
    927. 

  927. If there is a fixed first byte, for example, from a pattern such as
    928. 

  928. (cat|cow|coyote), its value is returned. Otherwise, if either
    929. 

  929. <br>
    930. 

  930. <br>
    931. 

  931. (a) the pattern was compiled with the PCRE_MULTILINE option, and every branch
    932. 

  932. starts with "^", or
    933. 

  933. <br>
    934. 

  934. <br>
    935. 

  935. (b) every branch of the pattern starts with ".*" and PCRE_DOTALL is not set
    936. 

  936. (if it were set, the pattern would be anchored),
    937. 

  937. <br>
    938. 

  938. <br>
    939. 

  939. -1 is returned, indicating that the pattern matches only at the start of a
    940. 

  940. subject string or after any newline within the string. Otherwise -2 is
    941. 

  941. returned. For anchored patterns, -2 is returned.
    942. 

  942. <pre>
    943. 

  943.   PCRE_INFO_FIRSTTABLE
    944. 

  944. </pre>
    945. 

  945. If the pattern was studied, and this resulted in the construction of a 256-bit
    946. 

  946. table indicating a fixed set of bytes for the first byte in any matching
    947. 

  947. string, a pointer to the table is returned. Otherwise NULL is returned. The
    948. 

  948. fourth argument should point to an <b>unsigned char *</b> variable.
    949. 

  949. <pre>
    950. 

  950.   PCRE_INFO_HASCRORLF
    951. 

  951. </pre>
    952. 

  952. Return 1 if the pattern contains any explicit matches for CR or LF characters,
    953. 

  953. otherwise 0. The fourth argument should point to an <b>int</b> variable. An
    954. 

  954. explicit match is either a literal CR or LF character, or \r or \n.
    955. 

  955. <pre>
    956. 

  956.   PCRE_INFO_JCHANGED
    957. 

  957. </pre>
    958. 

  958. Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
    959. 

  959. 0. The fourth argument should point to an <b>int</b> variable. (?J) and
    960. 

  960. (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
    961. 

  961. <pre>
    962. 

  962.   PCRE_INFO_LASTLITERAL
    963. 

  963. </pre>
    964. 

  964. Return the value of the rightmost literal byte that must exist in any matched
    965. 

  965. string, other than at its start, if such a byte has been recorded. The fourth
    966. 

  966. argument should point to an <b>int</b> variable. If there is no such byte, -1 is
    967. 

  967. returned. For anchored patterns, a last literal byte is recorded only if it
    968. 

  968. follows something of variable length. For example, for the pattern
    969. 

  969. /^a\d+z\d+/ the returned value is "z", but for /^a\dz\d/ the returned value
    970. 

  970. is -1.
    971. 

  971. <pre>
    972. 

  972.   PCRE_INFO_NAMECOUNT
    973. 

  973.   PCRE_INFO_NAMEENTRYSIZE
    974. 

  974.   PCRE_INFO_NAMETABLE
    975. 

  975. </pre>
    976. 

  976. PCRE supports the use of named as well as numbered capturing parentheses. The
    977. 

  977. names are just an additional way of identifying the parentheses, which still
    978. 

  978. acquire numbers. Several convenience functions such as
    979. 

  979. <b>pcre_get_named_substring()</b> are provided for extracting captured
    980. 

  980. substrings by name. It is also possible to extract the data directly, by first
    981. 

  981. converting the name to a number in order to access the correct pointers in the
    982. 

  982. output vector (described with <b>pcre_exec()</b> below). To do the conversion,
    983. 

  983. you need to use the name-to-number map, which is described by these three
    984. 

  984. values.
    985. 

  985. </P>
    986. 

  986. <P>
    987. 

  987. The map consists of a number of fixed-size entries. PCRE_INFO_NAMECOUNT gives
    988. 

  988. the number of entries, and PCRE_INFO_NAMEENTRYSIZE gives the size of each
    989. 

  989. entry; both of these return an <b>int</b> value. The entry size depends on the
    990. 

  990. length of the longest name. PCRE_INFO_NAMETABLE returns a pointer to the first
    991. 

  991. entry of the table (a pointer to <b>char</b>). The first two bytes of each entry
    992. 

  992. are the number of the capturing parenthesis, most significant byte first. The
    993. 

  993. rest of the entry is the corresponding name, zero terminated. The names are in
    994. 

  994. alphabetical order. When PCRE_DUPNAMES is set, duplicate names are in order of
    995. 

  995. their parentheses numbers. For example, consider the following pattern (assume
    996. 

  996. PCRE_EXTENDED is set, so white space - including newlines - is ignored):
    997. 

  997. <pre>
    998. 

  998.   (?&#60;date&#62; (?&#60;year&#62;(\d\d)?\d\d) - (?&#60;month&#62;\d\d) - (?&#60;day&#62;\d\d) )
    999. 

  999. </pre>
    1000. 

  1000. There are four named subpatterns, so the table has four entries, and each entry
    1001. 

  1001. in the table is eight bytes long. The table is as follows, with non-printing
    1002. 

  1002. bytes shows in hexadecimal, and undefined bytes shown as ??:
    1003. 

  1003. <pre>
    1004. 

  1004.   00 01 d  a  t  e  00 ??
    1005. 

  1005.   00 05 d  a  y  00 ?? ??
    1006. 

  1006.   00 04 m  o  n  t  h  00
    1007. 

  1007.   00 02 y  e  a  r  00 ??
    1008. 

  1008. </pre>
    1009. 

  1009. When writing code to extract data from named subpatterns using the
    1010. 

  1010. name-to-number map, remember that the length of the entries is likely to be
    1011. 

  1011. different for each compiled pattern.
    1012. 

  1012. <pre>
    1013. 

  1013.   PCRE_INFO_OKPARTIAL
    1014. 

  1014. </pre>
    1015. 

  1015. Return 1 if the pattern can be used for partial matching, otherwise 0. The
    1016. 

  1016. fourth argument should point to an <b>int</b> variable. The
    1017. 

  1017. <a href="pcrepartial.html"><b>pcrepartial</b></a>
    1018. 

  1018. documentation lists the restrictions that apply to patterns when partial
    1019. 

  1019. matching is used.
    1020. 

  1020. <pre>
    1021. 

  1021.   PCRE_INFO_OPTIONS
    1022. 

  1022. </pre>
    1023. 

  1023. Return a copy of the options with which the pattern was compiled. The fourth
    1024. 

  1024. argument should point to an <b>unsigned long int</b> variable. These option bits
    1025. 

  1025. are those specified in the call to <b>pcre_compile()</b>, modified by any
    1026. 

  1026. top-level option settings at the start of the pattern itself. In other words,
    1027. 

  1027. they are the options that will be in force when matching starts. For example,
    1028. 

  1028. if the pattern /(?im)abc(?-i)d/ is compiled with the PCRE_EXTENDED option, the
    1029. 

  1029. result is PCRE_CASELESS, PCRE_MULTILINE, and PCRE_EXTENDED.
    1030. 

  1030. </P>
    1031. 

  1031. <P>
    1032. 

  1032. A pattern is automatically anchored by PCRE if all of its top-level
    1033. 

  1033. alternatives begin with one of the following:
    1034. 

  1034. <pre>
    1035. 

  1035.   ^     unless PCRE_MULTILINE is set
    1036. 

  1036.   \A    always
    1037. 

  1037.   \G    always
    1038. 

  1038.   .*    if PCRE_DOTALL is set and there are no back references to the subpattern in which .* appears
    1039. 

  1039. </pre>
    1040. 

  1040. For such patterns, the PCRE_ANCHORED bit is set in the options returned by
    1041. 

  1041. <b>pcre_fullinfo()</b>.
    1042. 

  1042. <pre>
    1043. 

  1043.   PCRE_INFO_SIZE
    1044. 

  1044. </pre>
    1045. 

  1045. Return the size of the compiled pattern, that is, the value that was passed as
    1046. 

  1046. the argument to <b>pcre_malloc()</b> when PCRE was getting memory in which to
    1047. 

  1047. place the compiled data. The fourth argument should point to a <b>size_t</b>
    1048. 

  1048. variable.
    1049. 

  1049. <pre>
    1050. 

  1050.   PCRE_INFO_STUDYSIZE
    1051. 

  1051. </pre>
    1052. 

  1052. Return the size of the data block pointed to by the <i>study_data</i> field in
    1053. 

  1053. a <b>pcre_extra</b> block. That is, it is the value that was passed to
    1054. 

  1054. <b>pcre_malloc()</b> when PCRE was getting memory into which to place the data
    1055. 

  1055. created by <b>pcre_study()</b>. The fourth argument should point to a
    1056. 

  1056. <b>size_t</b> variable.
    1057. 

  1057. </P>
    1058. 

  1058. <br><a name="SEC12" href="#TOC1">OBSOLETE INFO FUNCTION</a><br>
    1059. 

  1059. <P>
    1060. 

  1060. <b>int pcre_info(const pcre *<i>code</i>, int *<i>optptr</i>, int</b>
    1061. 

  1061. <b>*<i>firstcharptr</i>);</b>
    1062. 

  1062. </P>
    1063. 

  1063. <P>
    1064. 

  1064. The <b>pcre_info()</b> function is now obsolete because its interface is too
    1065. 

  1065. restrictive to return all the available data about a compiled pattern. New
    1066. 

  1066. programs should use <b>pcre_fullinfo()</b> instead. The yield of
    1067. 

  1067. <b>pcre_info()</b> is the number of capturing subpatterns, or one of the
    1068. 

  1068. following negative numbers:
    1069. 

  1069. <pre>
    1070. 

  1070.   PCRE_ERROR_NULL       the argument <i>code</i> was NULL
    1071. 

  1071.   PCRE_ERROR_BADMAGIC   the "magic number" was not found
    1072. 

  1072. </pre>
    1073. 

  1073. If the <i>optptr</i> argument is not NULL, a copy of the options with which the
    1074. 

  1074. pattern was compiled is placed in the integer it points to (see
    1075. 

  1075. PCRE_INFO_OPTIONS above).
    1076. 

  1076. </P>
    1077. 

  1077. <P>
    1078. 

  1078. If the pattern is not anchored and the <i>firstcharptr</i> argument is not NULL,
    1079. 

  1079. it is used to pass back information about the first character of any matched
    1080. 

  1080. string (see PCRE_INFO_FIRSTBYTE above).
    1081. 

  1081. </P>
    1082. 

  1082. <br><a name="SEC13" href="#TOC1">REFERENCE COUNTS</a><br>
    1083. 

  1083. <P>
    1084. 

  1084. <b>int pcre_refcount(pcre *<i>code</i>, int <i>adjust</i>);</b>
    1085. 

  1085. </P>
    1086. 

  1086. <P>
    1087. 

  1087. The <b>pcre_refcount()</b> function is used to maintain a reference count in the
    1088. 

  1088. data block that contains a compiled pattern. It is provided for the benefit of
    1089. 

  1089. applications that operate in an object-oriented manner, where different parts
    1090. 

  1090. of the application may be using the same compiled pattern, but you want to free
    1091. 

  1091. the block when they are all done.
    1092. 

  1092. </P>
    1093. 

  1093. <P>
    1094. 

  1094. When a pattern is compiled, the reference count field is initialized to zero.
    1095. 

  1095. It is changed only by calling this function, whose action is to add the
    1096. 

  1096. <i>adjust</i> value (which may be positive or negative) to it. The yield of the
    1097. 

  1097. function is the new value. However, the value of the count is constrained to
    1098. 

  1098. lie between 0 and 65535, inclusive. If the new value is outside these limits,
    1099. 

  1099. it is forced to the appropriate limit value.
    1100. 

  1100. </P>
    1101. 

  1101. <P>
    1102. 

  1102. Except when it is zero, the reference count is not correctly preserved if a
    1103. 

  1103. pattern is compiled on one host and then transferred to a host whose byte-order
    1104. 

  1104. is different. (This seems a highly unlikely scenario.)
    1105. 

  1105. </P>
    1106. 

  1106. <br><a name="SEC14" href="#TOC1">MATCHING A PATTERN: THE TRADITIONAL FUNCTION</a><br>
    1107. 

  1107. <P>
    1108. 

  1108. <b>int pcre_exec(const pcre *<i>code</i>, const pcre_extra *<i>extra</i>,</b>
    1109. 

  1109. <b>const char *<i>subject</i>, int <i>length</i>, int <i>startoffset</i…
    1110.