summaryrefslogtreecommitdiff
path: root/plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3
diff options
context:
space:
mode:
authorKirill Volinsky <mataes2007@gmail.com>2014-08-02 14:17:32 +0000
committerKirill Volinsky <mataes2007@gmail.com>2014-08-02 14:17:32 +0000
commit844c971d8aeb2693bc01739963f5da675b989d03 (patch)
treee32898f45b61f668ad805fdb4e9c9c2ea50c43bd /plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3
parentad8bc05808c6d1f45fb1d62500b4b30f0d654ed7 (diff)
added pcre16 project
git-svn-id: http://svn.miranda-ng.org/main/trunk@10019 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c
Diffstat (limited to 'plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3')
-rw-r--r--plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.343
1 files changed, 43 insertions, 0 deletions
diff --git a/plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3 b/plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3
new file mode 100644
index 0000000000..11c97a0fc8
--- /dev/null
+++ b/plugins/Pcre16/docs/doc/pcre_jit_stack_alloc.3
@@ -0,0 +1,43 @@
+.TH PCRE_JIT_STACK_ALLOC 3 "24 June 2012" "PCRE 8.30"
+.SH NAME
+PCRE - Perl-compatible regular expressions
+.SH SYNOPSIS
+.rs
+.sp
+.B #include <pcre.h>
+.PP
+.nf
+.B pcre_jit_stack *pcre_jit_stack_alloc(int \fIstartsize\fP,
+.B " int \fImaxsize\fP);"
+.sp
+.B pcre16_jit_stack *pcre16_jit_stack_alloc(int \fIstartsize\fP,
+.B " int \fImaxsize\fP);"
+.sp
+.B pcre32_jit_stack *pcre32_jit_stack_alloc(int \fIstartsize\fP,
+.B " int \fImaxsize\fP);"
+.fi
+.
+.SH DESCRIPTION
+.rs
+.sp
+This function is used to create a stack for use by the code compiled by the JIT
+optimization of \fBpcre[16|32]_study()\fP. The arguments are a starting size for
+the stack, and a maximum size to which it is allowed to grow. The result can be
+passed to the JIT run-time code by \fBpcre[16|32]_assign_jit_stack()\fP, or that
+function can set up a callback for obtaining a stack. A maximum stack size of
+512K to 1M should be more than enough for any pattern. For more details, see
+the
+.\" HREF
+\fBpcrejit\fP
+.\"
+page.
+.P
+There is a complete description of the PCRE native API in the
+.\" HREF
+\fBpcreapi\fP
+.\"
+page and a description of the POSIX API in the
+.\" HREF
+\fBpcreposix\fP
+.\"
+page.