src/external/pcre2-10.32/doc/pcre2_set_compile_recursion_guard.3

   1 .TH PCRE2_SET_COMPILE_RECURSION_GUARD 3 "22 October 2014" "PCRE2 10.00"
   2 .SH NAME
   3 PCRE2 - Perl-compatible regular expressions (revised API)
   4 .SH SYNOPSIS
   5 .rs
   6 .sp
   7 .B #include <pcre2.h>
   8 .PP
   9 .nf
  10 .B int pcre2_set_compile_recursion_guard(pcre2_compile_context *\fIccontext\fP,
  11 .B "  int (*\fIguard_function\fP)(uint32_t, void *), void *\fIuser_data\fP);"
  12 .fi
  13 .
  14 .SH DESCRIPTION
  15 .rs
  16 .sp
  17 This function defines, within a compile context, a function that is called
  18 whenever \fBpcre2_compile()\fP starts to compile a parenthesized part of a
  19 pattern. The first argument to the function gives the current depth of
  20 parenthesis nesting, and the second is user data that is supplied when the
  21 function is set up. The callout function should return zero if all is well, or
  22 non-zero to force an error. This feature is provided so that applications can
  23 check the available system stack space, in order to avoid running out. The
  24 result of \fBpcre2_set_compile_recursion_guard()\fP is always zero.
  25 .P
  26 There is a complete description of the PCRE2 native API in the
  27 .\" HREF
  28 \fBpcre2api\fP
  29 .\"
  30 page and a description of the POSIX API in the
  31 .\" HREF
  32 \fBpcre2posix\fP
  33 .\"
  34 page.