xref: /aosp_15_r20/external/pcre/doc/html/pcre2_config.html (revision 22dc650d8ae982c6770746019a6f94af92b0f024)
1*22dc650dSSadaf Ebrahimi<html>
2*22dc650dSSadaf Ebrahimi<head>
3*22dc650dSSadaf Ebrahimi<title>pcre2_config specification</title>
4*22dc650dSSadaf Ebrahimi</head>
5*22dc650dSSadaf Ebrahimi<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
6*22dc650dSSadaf Ebrahimi<h1>pcre2_config man page</h1>
7*22dc650dSSadaf Ebrahimi<p>
8*22dc650dSSadaf EbrahimiReturn to the <a href="index.html">PCRE2 index page</a>.
9*22dc650dSSadaf Ebrahimi</p>
10*22dc650dSSadaf Ebrahimi<p>
11*22dc650dSSadaf EbrahimiThis page is part of the PCRE2 HTML documentation. It was generated
12*22dc650dSSadaf Ebrahimiautomatically from the original man page. If there is any nonsense in it,
13*22dc650dSSadaf Ebrahimiplease consult the man page, in case the conversion went wrong.
14*22dc650dSSadaf Ebrahimi<br>
15*22dc650dSSadaf Ebrahimi<br><b>
16*22dc650dSSadaf EbrahimiSYNOPSIS
17*22dc650dSSadaf Ebrahimi</b><br>
18*22dc650dSSadaf Ebrahimi<P>
19*22dc650dSSadaf Ebrahimi<b>#include &#60;pcre2.h&#62;</b>
20*22dc650dSSadaf Ebrahimi</P>
21*22dc650dSSadaf Ebrahimi<P>
22*22dc650dSSadaf Ebrahimi<b>int pcre2_config(uint32_t <i>what</i>, void *<i>where</i>);</b>
23*22dc650dSSadaf Ebrahimi</P>
24*22dc650dSSadaf Ebrahimi<br><b>
25*22dc650dSSadaf EbrahimiDESCRIPTION
26*22dc650dSSadaf Ebrahimi</b><br>
27*22dc650dSSadaf Ebrahimi<P>
28*22dc650dSSadaf EbrahimiThis function makes it possible for a client program to find out which optional
29*22dc650dSSadaf Ebrahimifeatures are available in the version of the PCRE2 library it is using. The
30*22dc650dSSadaf Ebrahimiarguments are as follows:
31*22dc650dSSadaf Ebrahimi<pre>
32*22dc650dSSadaf Ebrahimi  <i>what</i>     A code specifying what information is required
33*22dc650dSSadaf Ebrahimi  <i>where</i>    Points to where to put the information
34*22dc650dSSadaf Ebrahimi</pre>
35*22dc650dSSadaf EbrahimiIf <i>where</i> is NULL, the function returns the amount of memory needed for
36*22dc650dSSadaf Ebrahimithe requested information. When the information is a string, the value is in
37*22dc650dSSadaf Ebrahimicode units; for other types of data it is in bytes.
38*22dc650dSSadaf Ebrahimi</P>
39*22dc650dSSadaf Ebrahimi<P>
40*22dc650dSSadaf EbrahimiIf <b>where</b> is not NULL, for PCRE2_CONFIG_JITTARGET,
41*22dc650dSSadaf EbrahimiPCRE2_CONFIG_UNICODE_VERSION, and PCRE2_CONFIG_VERSION it must point to a
42*22dc650dSSadaf Ebrahimibuffer that is large enough to hold the string. For all other codes it must
43*22dc650dSSadaf Ebrahimipoint to a uint32_t integer variable. The available codes are:
44*22dc650dSSadaf Ebrahimi<pre>
45*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_BSR             Indicates what \R matches by default:
46*22dc650dSSadaf Ebrahimi                                 PCRE2_BSR_UNICODE
47*22dc650dSSadaf Ebrahimi                                 PCRE2_BSR_ANYCRLF
48*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_COMPILED_WIDTHS Which of 8/16/32 support was compiled
49*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_DEPTHLIMIT      Default backtracking depth limit
50*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_HEAPLIMIT       Default heap memory limit
51*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_JIT             Availability of just-in-time compiler support (1=yes 0=no)
52*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_JITTARGET       Information (a string) about the target architecture for the JIT compiler
53*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_LINKSIZE        Configured internal link size (2, 3, 4)
54*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_MATCHLIMIT      Default internal resource limit
55*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_NEVER_BACKSLASH_C  Whether or not \C is disabled
56*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_NEWLINE         Code for the default newline sequence:
57*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_CR
58*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_LF
59*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_CRLF
60*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_ANY
61*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_ANYCRLF
62*22dc650dSSadaf Ebrahimi                                 PCRE2_NEWLINE_NUL
63*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_PARENSLIMIT     Default parentheses nesting limit
64*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_RECURSIONLIMIT  Obsolete: use PCRE2_CONFIG_DEPTHLIMIT
65*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_STACKRECURSE    Obsolete: always returns 0
66*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_UNICODE         Availability of Unicode support (1=yes 0=no)
67*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_UNICODE_VERSION The Unicode version (a string)
68*22dc650dSSadaf Ebrahimi  PCRE2_CONFIG_VERSION         The PCRE2 version (a string)
69*22dc650dSSadaf Ebrahimi</pre>
70*22dc650dSSadaf EbrahimiThe function yields a non-negative value on success or the negative value
71*22dc650dSSadaf EbrahimiPCRE2_ERROR_BADOPTION otherwise. This is also the result for the
72*22dc650dSSadaf EbrahimiPCRE2_CONFIG_JITTARGET code if JIT support is not available. When a string is
73*22dc650dSSadaf Ebrahimirequested, the function returns the number of code units used, including the
74*22dc650dSSadaf Ebrahimiterminating zero.
75*22dc650dSSadaf Ebrahimi</P>
76*22dc650dSSadaf Ebrahimi<P>
77*22dc650dSSadaf EbrahimiThere is a complete description of the PCRE2 native API in the
78*22dc650dSSadaf Ebrahimi<a href="pcre2api.html"><b>pcre2api</b></a>
79*22dc650dSSadaf Ebrahimipage and a description of the POSIX API in the
80*22dc650dSSadaf Ebrahimi<a href="pcre2posix.html"><b>pcre2posix</b></a>
81*22dc650dSSadaf Ebrahimipage.
82*22dc650dSSadaf Ebrahimi<p>
83*22dc650dSSadaf EbrahimiReturn to the <a href="index.html">PCRE2 index page</a>.
84*22dc650dSSadaf Ebrahimi</p>
85