4 |
.SH SYNOPSIS |
.SH SYNOPSIS |
5 |
.rs |
.rs |
6 |
.sp |
.sp |
7 |
.B pcretest "[-C] [-d] [-dfa] [-i] [-m] [-o osize] [-p] [-t] [source]" |
.B pcretest "[options] [source] [destination]" |
8 |
.ti +5n |
.sp |
|
.B "[destination]" |
|
|
.P |
|
9 |
\fBpcretest\fP was written as a test program for the PCRE regular expression |
\fBpcretest\fP was written as a test program for the PCRE regular expression |
10 |
library itself, but it can also be used for experimenting with regular |
library itself, but it can also be used for experimenting with regular |
11 |
expressions. This document describes the features of the test program; for |
expressions. This document describes the features of the test program; for |
24 |
.SH OPTIONS |
.SH OPTIONS |
25 |
.rs |
.rs |
26 |
.TP 10 |
.TP 10 |
27 |
|
\fB-b\fP |
28 |
|
Behave as if each regex has the \fB/B\fP (show bytecode) modifier; the internal |
29 |
|
form is output after compilation. |
30 |
|
.TP 10 |
31 |
\fB-C\fP |
\fB-C\fP |
32 |
Output the version number of the PCRE library, and all available information |
Output the version number of the PCRE library, and all available information |
33 |
about the optional features that are included, and then exit. |
about the optional features that are included, and then exit. |
34 |
.TP 10 |
.TP 10 |
35 |
\fB-d\fP |
\fB-d\fP |
36 |
Behave as if each regex has the \fB/D\fP (debug) modifier; the internal |
Behave as if each regex has the \fB/D\fP (debug) modifier; the internal |
37 |
form is output after compilation. |
form and information about the compiled pattern is output after compilation; |
38 |
|
\fB-d\fP is equivalent to \fB-b -i\fP. |
39 |
.TP 10 |
.TP 10 |
40 |
\fB-dfa\fP |
\fB-dfa\fP |
41 |
Behave as if each data line contains the \eD escape sequence; this causes the |
Behave as if each data line contains the \eD escape sequence; this causes the |
42 |
alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the |
alternative matching function, \fBpcre_dfa_exec()\fP, to be used instead of the |
43 |
standard \fBpcre_exec()\fP function (more detail is given below). |
standard \fBpcre_exec()\fP function (more detail is given below). |
44 |
.TP 10 |
.TP 10 |
45 |
|
\fB-help\fP |
46 |
|
Output a brief summary these options and then exit. |
47 |
|
.TP 10 |
48 |
\fB-i\fP |
\fB-i\fP |
49 |
Behave as if each regex has the \fB/I\fP modifier; information about the |
Behave as if each regex has the \fB/I\fP modifier; information about the |
50 |
compiled pattern is given after compilation. |
compiled pattern is given after compilation. |
51 |
.TP 10 |
.TP 10 |
52 |
|
\fB-M\fP |
53 |
|
Behave as if each data line contains the \eM escape sequence; this causes |
54 |
|
PCRE to discover the minimum MATCH_LIMIT and MATCH_LIMIT_RECURSION settings by |
55 |
|
calling \fBpcre_exec()\fP repeatedly with different limits. |
56 |
|
.TP 10 |
57 |
\fB-m\fP |
\fB-m\fP |
58 |
Output the size of each compiled pattern after it has been compiled. This is |
Output the size of each compiled pattern after it has been compiled. This is |
59 |
equivalent to adding \fB/M\fP to each regular expression. For compatibility |
equivalent to adding \fB/M\fP to each regular expression. For compatibility |
61 |
.TP 10 |
.TP 10 |
62 |
\fB-o\fP \fIosize\fP |
\fB-o\fP \fIosize\fP |
63 |
Set the number of elements in the output vector that is used when calling |
Set the number of elements in the output vector that is used when calling |
64 |
\fBpcre_exec()\fP to be \fIosize\fP. The default value is 45, which is enough |
\fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP to be \fIosize\fP. The default value |
65 |
for 14 capturing subexpressions. The vector size can be changed for individual |
is 45, which is enough for 14 capturing subexpressions for \fBpcre_exec()\fP or |
66 |
matching calls by including \eO in the data line (see below). |
22 different matches for \fBpcre_dfa_exec()\fP. The vector size can be |
67 |
|
changed for individual matching calls by including \eO in the data line (see |
68 |
|
below). |
69 |
.TP 10 |
.TP 10 |
70 |
\fB-p\fP |
\fB-p\fP |
71 |
Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is |
Behave as if each regex has the \fB/P\fP modifier; the POSIX wrapper API is |
72 |
used to call PCRE. None of the other options has any effect when \fB-p\fP is |
used to call PCRE. None of the other options has any effect when \fB-p\fP is |
73 |
set. |
set. |
74 |
.TP 10 |
.TP 10 |
75 |
\fP-q\fP |
\fB-q\fP |
76 |
Do not output the version number of \fBpcretest\fP at the start of execution. |
Do not output the version number of \fBpcretest\fP at the start of execution. |
77 |
.TP 10 |
.TP 10 |
78 |
|
\fB-S\fP \fIsize\fP |
79 |
|
On Unix-like systems, set the size of the runtime stack to \fIsize\fP |
80 |
|
megabytes. |
81 |
|
.TP 10 |
82 |
\fB-t\fP |
\fB-t\fP |
83 |
Run each compile, study, and match many times with a timer, and output |
Run each compile, study, and match many times with a timer, and output |
84 |
resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with |
resulting time per compile or match (in milliseconds). Do not set \fB-m\fP with |
85 |
\fB-t\fP, because you will then get the size output a zillion times, and the |
\fB-t\fP, because you will then get the size output a zillion times, and the |
86 |
timing will be distorted. |
timing will be distorted. You can control the number of iterations that are |
87 |
|
used for timing by following \fB-t\fP with a number (as a separate item on the |
88 |
|
command line). For example, "-t 1000" would iterate 1000 times. The default is |
89 |
|
to iterate 500000 times. |
90 |
|
.TP 10 |
91 |
|
\fB-tm\fP |
92 |
|
This is like \fB-t\fP except that it times only the matching phase, not the |
93 |
|
compile or study phases. |
94 |
. |
. |
95 |
. |
. |
96 |
.SH DESCRIPTION |
.SH DESCRIPTION |
102 |
stdout, and prompts for each line of input, using "re>" to prompt for regular |
stdout, and prompts for each line of input, using "re>" to prompt for regular |
103 |
expressions, and "data>" to prompt for data lines. |
expressions, and "data>" to prompt for data lines. |
104 |
.P |
.P |
105 |
|
When \fBpcretest\fP is built, a configuration option can specify that it should |
106 |
|
be linked with the \fBlibreadline\fP library. When this is done, if the input |
107 |
|
is from a terminal, it is read using the \fBreadline()\fP function. This |
108 |
|
provides line-editing and history facilities. The output from the \fB-help\fP |
109 |
|
option states whether or not \fBreadline()\fP will be used. |
110 |
|
.P |
111 |
The program handles any number of sets of input on a single input file. Each |
The program handles any number of sets of input on a single input file. Each |
112 |
set starts with a regular expression, and continues with any number of data |
set starts with a regular expression, and continues with any number of data |
113 |
lines to be matched against the pattern. |
lines to be matched against the pattern. |
114 |
.P |
.P |
115 |
Each data line is matched separately and independently. If you want to do |
Each data line is matched separately and independently. If you want to do |
116 |
multiple-line matches, you have to use the \en escape sequence in a single line |
multi-line matches, you have to use the \en escape sequence (or \er or \er\en, |
117 |
of input to encode the newline characters. The maximum length of data line is |
etc., depending on the newline setting) in a single line of input to encode the |
118 |
30,000 characters. |
newline sequences. There is no limit on the length of data lines; the input |
119 |
|
buffer is automatically extended if it is too small. |
120 |
.P |
.P |
121 |
An empty line signals the end of the data lines, at which point a new regular |
An empty line signals the end of the data lines, at which point a new regular |
122 |
expression is read. The regular expressions are given enclosed in any |
expression is read. The regular expressions are given enclosed in any |
123 |
non-alphanumeric delimiters other than backslash, for example |
non-alphanumeric delimiters other than backslash, for example: |
124 |
.sp |
.sp |
125 |
/(a|bc)x+yz/ |
/(a|bc)x+yz/ |
126 |
.sp |
.sp |
165 |
.sp |
.sp |
166 |
/caseless/i |
/caseless/i |
167 |
.sp |
.sp |
168 |
The following table shows additional modifiers for setting PCRE options that do |
The following table shows additional modifiers for setting PCRE compile-time |
169 |
not correspond to anything in Perl: |
options that do not correspond to anything in Perl: |
170 |
.sp |
.sp |
171 |
\fB/A\fP PCRE_ANCHORED |
\fB/8\fP PCRE_UTF8 |
172 |
\fB/C\fP PCRE_AUTO_CALLOUT |
\fB/?\fP PCRE_NO_UTF8_CHECK |
173 |
\fB/E\fP PCRE_DOLLAR_ENDONLY |
\fB/A\fP PCRE_ANCHORED |
174 |
\fB/f\fP PCRE_FIRSTLINE |
\fB/C\fP PCRE_AUTO_CALLOUT |
175 |
\fB/N\fP PCRE_NO_AUTO_CAPTURE |
\fB/E\fP PCRE_DOLLAR_ENDONLY |
176 |
\fB/U\fP PCRE_UNGREEDY |
\fB/f\fP PCRE_FIRSTLINE |
177 |
\fB/X\fP PCRE_EXTRA |
\fB/J\fP PCRE_DUPNAMES |
178 |
|
\fB/N\fP PCRE_NO_AUTO_CAPTURE |
179 |
|
\fB/U\fP PCRE_UNGREEDY |
180 |
|
\fB/W\fP PCRE_UCP |
181 |
|
\fB/X\fP PCRE_EXTRA |
182 |
|
\fB/<JS>\fP PCRE_JAVASCRIPT_COMPAT |
183 |
|
\fB/<cr>\fP PCRE_NEWLINE_CR |
184 |
|
\fB/<lf>\fP PCRE_NEWLINE_LF |
185 |
|
\fB/<crlf>\fP PCRE_NEWLINE_CRLF |
186 |
|
\fB/<anycrlf>\fP PCRE_NEWLINE_ANYCRLF |
187 |
|
\fB/<any>\fP PCRE_NEWLINE_ANY |
188 |
|
\fB/<bsr_anycrlf>\fP PCRE_BSR_ANYCRLF |
189 |
|
\fB/<bsr_unicode>\fP PCRE_BSR_UNICODE |
190 |
|
.sp |
191 |
|
The modifiers that are enclosed in angle brackets are literal strings as shown, |
192 |
|
including the angle brackets, but the letters can be in either case. This |
193 |
|
example sets multiline matching with CRLF as the line ending sequence: |
194 |
|
.sp |
195 |
|
/^abc/m<crlf> |
196 |
|
.sp |
197 |
|
As well as turning on the PCRE_UTF8 option, the \fB/8\fP modifier also causes |
198 |
|
any non-printing characters in output strings to be printed using the |
199 |
|
\ex{hh...} notation if they are valid UTF-8 sequences. Full details of the PCRE |
200 |
|
options are given in the |
201 |
|
.\" HREF |
202 |
|
\fBpcreapi\fP |
203 |
|
.\" |
204 |
|
documentation. |
205 |
|
. |
206 |
|
. |
207 |
|
.SS "Finding all matches in a string" |
208 |
|
.rs |
209 |
.sp |
.sp |
210 |
Searching for all possible matches within each subject string can be requested |
Searching for all possible matches within each subject string can be requested |
211 |
by the \fB/g\fP or \fB/G\fP modifier. After finding a match, PCRE is called |
by the \fB/g\fP or \fB/G\fP modifier. After finding a match, PCRE is called |
217 |
begins with a lookbehind assertion (including \eb or \eB). |
begins with a lookbehind assertion (including \eb or \eB). |
218 |
.P |
.P |
219 |
If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an |
If any call to \fBpcre_exec()\fP in a \fB/g\fP or \fB/G\fP sequence matches an |
220 |
empty string, the next call is done with the PCRE_NOTEMPTY and PCRE_ANCHORED |
empty string, the next call is done with the PCRE_NOTEMPTY_ATSTART and |
221 |
flags set in order to search for another, non-empty, match at the same point. |
PCRE_ANCHORED flags set in order to search for another, non-empty, match at the |
222 |
If this second match fails, the start offset is advanced by one, and the normal |
same point. If this second match fails, the start offset is advanced by one |
223 |
match is retried. This imitates the way Perl handles such cases when using the |
character, and the normal match is retried. This imitates the way Perl handles |
224 |
\fB/g\fP modifier or the \fBsplit()\fP function. |
such cases when using the \fB/g\fP modifier or the \fBsplit()\fP function. |
225 |
.P |
. |
226 |
|
. |
227 |
|
.SS "Other modifiers" |
228 |
|
.rs |
229 |
|
.sp |
230 |
There are yet more modifiers for controlling the way \fBpcretest\fP |
There are yet more modifiers for controlling the way \fBpcretest\fP |
231 |
operates. |
operates. |
232 |
.P |
.P |
235 |
the subject string. This is useful for tests where the subject contains |
the subject string. This is useful for tests where the subject contains |
236 |
multiple copies of the same substring. |
multiple copies of the same substring. |
237 |
.P |
.P |
238 |
The \fB/L\fP modifier must be followed directly by the name of a locale, for |
The \fB/B\fP modifier is a debugging feature. It requests that \fBpcretest\fP |
239 |
example, |
output a representation of the compiled byte code after compilation. Normally |
240 |
.sp |
this information contains length and offset values; however, if \fB/Z\fP is |
241 |
/pattern/Lfr_FR |
also present, this data is replaced by spaces. This is a special feature for |
242 |
.sp |
use in the automatic test scripts; it ensures that the same output is generated |
243 |
For this reason, it must be the last modifier. The given locale is set, |
for different internal link sizes. |
|
\fBpcre_maketables()\fP is called to build a set of character tables for the |
|
|
locale, and this is then passed to \fBpcre_compile()\fP when compiling the |
|
|
regular expression. Without an \fB/L\fP modifier, NULL is passed as the tables |
|
|
pointer; that is, \fB/L\fP applies only to the expression on which it appears. |
|
244 |
.P |
.P |
245 |
The \fB/I\fP modifier requests that \fBpcretest\fP output information about the |
The \fB/D\fP modifier is a PCRE debugging feature, and is equivalent to |
246 |
compiled pattern (whether it is anchored, has a fixed first character, and |
\fB/BI\fP, that is, both the \fB/B\fP and the \fB/I\fP modifiers. |
|
so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a |
|
|
pattern. If the pattern is studied, the results of that are also output. |
|
|
.P |
|
|
The \fB/D\fP modifier is a PCRE debugging feature, which also assumes \fB/I\fP. |
|
|
It causes the internal form of compiled regular expressions to be output after |
|
|
compilation. If the pattern was studied, the information returned is also |
|
|
output. |
|
247 |
.P |
.P |
248 |
The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the |
The \fB/F\fP modifier causes \fBpcretest\fP to flip the byte order of the |
249 |
fields in the compiled pattern that contain 2-byte and 4-byte numbers. This |
fields in the compiled pattern that contain 2-byte and 4-byte numbers. This |
253 |
\fB/P\fP pattern modifier is specified. See also the section about saving and |
\fB/P\fP pattern modifier is specified. See also the section about saving and |
254 |
reloading compiled patterns below. |
reloading compiled patterns below. |
255 |
.P |
.P |
256 |
The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the |
The \fB/I\fP modifier requests that \fBpcretest\fP output information about the |
257 |
expression has been compiled, and the results used when the expression is |
compiled pattern (whether it is anchored, has a fixed first character, and |
258 |
matched. |
so on). It does this by calling \fBpcre_fullinfo()\fP after compiling a |
259 |
|
pattern. If the pattern is studied, the results of that are also output. |
260 |
|
.P |
261 |
|
The \fB/K\fP modifier requests \fBpcretest\fP to show names from backtracking |
262 |
|
control verbs that are returned from calls to \fBpcre_exec()\fP. It causes |
263 |
|
\fBpcretest\fP to create a \fBpcre_extra\fP block if one has not already been |
264 |
|
created by a call to \fBpcre_study()\fP, and to set the PCRE_EXTRA_MARK flag |
265 |
|
and the \fBmark\fP field within it, every time that \fBpcre_exec()\fP is |
266 |
|
called. If the variable that the \fBmark\fP field points to is non-NULL for a |
267 |
|
match, non-match, or partial match, \fBpcretest\fP prints the string to which |
268 |
|
it points. For a match, this is shown on a line by itself, tagged with "MK:". |
269 |
|
For a non-match it is added to the message. |
270 |
|
.P |
271 |
|
The \fB/L\fP modifier must be followed directly by the name of a locale, for |
272 |
|
example, |
273 |
|
.sp |
274 |
|
/pattern/Lfr_FR |
275 |
|
.sp |
276 |
|
For this reason, it must be the last modifier. The given locale is set, |
277 |
|
\fBpcre_maketables()\fP is called to build a set of character tables for the |
278 |
|
locale, and this is then passed to \fBpcre_compile()\fP when compiling the |
279 |
|
regular expression. Without an \fB/L\fP (or \fB/T\fP) modifier, NULL is passed |
280 |
|
as the tables pointer; that is, \fB/L\fP applies only to the expression on |
281 |
|
which it appears. |
282 |
.P |
.P |
283 |
The \fB/M\fP modifier causes the size of memory block used to hold the compiled |
The \fB/M\fP modifier causes the size of memory block used to hold the compiled |
284 |
pattern to be output. |
pattern to be output. |
285 |
.P |
.P |
286 |
|
The \fB/S\fP modifier causes \fBpcre_study()\fP to be called after the |
287 |
|
expression has been compiled, and the results used when the expression is |
288 |
|
matched. |
289 |
|
.P |
290 |
|
The \fB/T\fP modifier must be followed by a single digit. It causes a specific |
291 |
|
set of built-in character tables to be passed to \fBpcre_compile()\fP. It is |
292 |
|
used in the standard PCRE tests to check behaviour with different character |
293 |
|
tables. The digit specifies the tables as follows: |
294 |
|
.sp |
295 |
|
0 the default ASCII tables, as distributed in |
296 |
|
pcre_chartables.c.dist |
297 |
|
1 a set of tables defining ISO 8859 characters |
298 |
|
.sp |
299 |
|
In table 1, some characters whose codes are greater than 128 are identified as |
300 |
|
letters, digits, spaces, etc. |
301 |
|
. |
302 |
|
. |
303 |
|
.SS "Using the POSIX wrapper API" |
304 |
|
.rs |
305 |
|
.sp |
306 |
The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper |
The \fB/P\fP modifier causes \fBpcretest\fP to call PCRE via the POSIX wrapper |
307 |
API rather than its native API. When this is done, all other modifiers except |
API rather than its native API. When \fB/P\fP is set, the following modifiers |
308 |
\fB/i\fP, \fB/m\fP, and \fB/+\fP are ignored. REG_ICASE is set if \fB/i\fP is |
set options for the \fBregcomp()\fP function: |
309 |
present, and REG_NEWLINE is set if \fB/m\fP is present. The wrapper functions |
.sp |
310 |
force PCRE_DOLLAR_ENDONLY always, and PCRE_DOTALL unless REG_NEWLINE is set. |
/i REG_ICASE |
311 |
.P |
/m REG_NEWLINE |
312 |
The \fB/8\fP modifier causes \fBpcretest\fP to call PCRE with the PCRE_UTF8 |
/N REG_NOSUB |
313 |
option set. This turns on support for UTF-8 character handling in PCRE, |
/s REG_DOTALL ) |
314 |
provided that it was compiled with this support enabled. This modifier also |
/U REG_UNGREEDY ) These options are not part of |
315 |
causes any non-printing characters in output strings to be printed using the |
/W REG_UCP ) the POSIX standard |
316 |
\ex{hh...} notation if they are valid UTF-8 sequences. |
/8 REG_UTF8 ) |
317 |
.P |
.sp |
318 |
If the \fB/?\fP modifier is used with \fB/8\fP, it causes \fBpcretest\fP to |
The \fB/+\fP modifier works as described above. All other modifiers are |
319 |
call \fBpcre_compile()\fP with the PCRE_NO_UTF8_CHECK option, to suppress the |
ignored. |
|
checking of the string for UTF-8 validity. |
|
320 |
. |
. |
321 |
. |
. |
322 |
.SH "DATA LINES" |
.SH "DATA LINES" |
329 |
expressions, you probably don't need any of these. The following escapes are |
expressions, you probably don't need any of these. The following escapes are |
330 |
recognized: |
recognized: |
331 |
.sp |
.sp |
332 |
\ea alarm (= BEL) |
\ea alarm (BEL, \ex07) |
333 |
\eb backspace |
\eb backspace (\ex08) |
334 |
\ee escape |
\ee escape (\ex27) |
335 |
\ef formfeed |
\ef formfeed (\ex0c) |
336 |
\en newline |
\en newline (\ex0a) |
337 |
\er carriage return |
.\" JOIN |
338 |
\et tab |
\eqdd set the PCRE_MATCH_LIMIT limit to dd |
339 |
\ev vertical tab |
(any number of digits) |
340 |
|
\er carriage return (\ex0d) |
341 |
|
\et tab (\ex09) |
342 |
|
\ev vertical tab (\ex0b) |
343 |
\ennn octal character (up to 3 octal digits) |
\ennn octal character (up to 3 octal digits) |
344 |
\exhh hexadecimal character (up to 2 hex digits) |
\exhh hexadecimal character (up to 2 hex digits) |
345 |
.\" JOIN |
.\" JOIN |
346 |
\ex{hh...} hexadecimal character, any number of digits |
\ex{hh...} hexadecimal character, any number of digits |
347 |
in UTF-8 mode |
in UTF-8 mode |
348 |
|
.\" JOIN |
349 |
\eA pass the PCRE_ANCHORED option to \fBpcre_exec()\fP |
\eA pass the PCRE_ANCHORED option to \fBpcre_exec()\fP |
350 |
|
or \fBpcre_dfa_exec()\fP |
351 |
|
.\" JOIN |
352 |
\eB pass the PCRE_NOTBOL option to \fBpcre_exec()\fP |
\eB pass the PCRE_NOTBOL option to \fBpcre_exec()\fP |
353 |
|
or \fBpcre_dfa_exec()\fP |
354 |
.\" JOIN |
.\" JOIN |
355 |
\eCdd call pcre_copy_substring() for substring dd |
\eCdd call pcre_copy_substring() for substring dd |
356 |
after a successful match (number less than 32) |
after a successful match (number less than 32) |
383 |
.\" JOIN |
.\" JOIN |
384 |
\eL call pcre_get_substringlist() after a |
\eL call pcre_get_substringlist() after a |
385 |
successful match |
successful match |
386 |
|
.\" JOIN |
387 |
\eM discover the minimum MATCH_LIMIT and |
\eM discover the minimum MATCH_LIMIT and |
388 |
MATCH_LIMIT_RECURSION settings |
MATCH_LIMIT_RECURSION settings |
389 |
|
.\" JOIN |
390 |
\eN pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP |
\eN pass the PCRE_NOTEMPTY option to \fBpcre_exec()\fP |
391 |
|
or \fBpcre_dfa_exec()\fP; if used twice, pass the |
392 |
|
PCRE_NOTEMPTY_ATSTART option |
393 |
.\" JOIN |
.\" JOIN |
394 |
\eOdd set the size of the output vector passed to |
\eOdd set the size of the output vector passed to |
395 |
\fBpcre_exec()\fP to dd (any number of digits) |
\fBpcre_exec()\fP to dd (any number of digits) |
396 |
.\" JOIN |
.\" JOIN |
397 |
\eP pass the PCRE_PARTIAL option to \fBpcre_exec()\fP |
\eP pass the PCRE_PARTIAL_SOFT option to \fBpcre_exec()\fP |
398 |
or \fBpcre_dfa_exec()\fP |
or \fBpcre_dfa_exec()\fP; if used twice, pass the |
399 |
|
PCRE_PARTIAL_HARD option |
400 |
|
.\" JOIN |
401 |
|
\eQdd set the PCRE_MATCH_LIMIT_RECURSION limit to dd |
402 |
|
(any number of digits) |
403 |
\eR pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP |
\eR pass the PCRE_DFA_RESTART option to \fBpcre_dfa_exec()\fP |
404 |
\eS output details of memory get/free calls during matching |
\eS output details of memory get/free calls during matching |
405 |
|
.\" JOIN |
406 |
|
\eY pass the PCRE_NO_START_OPTIMIZE option to \fBpcre_exec()\fP |
407 |
|
or \fBpcre_dfa_exec()\fP |
408 |
|
.\" JOIN |
409 |
\eZ pass the PCRE_NOTEOL option to \fBpcre_exec()\fP |
\eZ pass the PCRE_NOTEOL option to \fBpcre_exec()\fP |
410 |
|
or \fBpcre_dfa_exec()\fP |
411 |
.\" JOIN |
.\" JOIN |
412 |
\e? pass the PCRE_NO_UTF8_CHECK option to |
\e? pass the PCRE_NO_UTF8_CHECK option to |
413 |
\fBpcre_exec()\fP |
\fBpcre_exec()\fP or \fBpcre_dfa_exec()\fP |
414 |
\e>dd start the match at offset dd (any number of digits); |
\e>dd start the match at offset dd (any number of digits); |
415 |
|
.\" JOIN |
416 |
this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP |
this sets the \fIstartoffset\fP argument for \fBpcre_exec()\fP |
417 |
|
or \fBpcre_dfa_exec()\fP |
418 |
|
.\" JOIN |
419 |
|
\e<cr> pass the PCRE_NEWLINE_CR option to \fBpcre_exec()\fP |
420 |
|
or \fBpcre_dfa_exec()\fP |
421 |
|
.\" JOIN |
422 |
|
\e<lf> pass the PCRE_NEWLINE_LF option to \fBpcre_exec()\fP |
423 |
|
or \fBpcre_dfa_exec()\fP |
424 |
|
.\" JOIN |
425 |
|
\e<crlf> pass the PCRE_NEWLINE_CRLF option to \fBpcre_exec()\fP |
426 |
|
or \fBpcre_dfa_exec()\fP |
427 |
|
.\" JOIN |
428 |
|
\e<anycrlf> pass the PCRE_NEWLINE_ANYCRLF option to \fBpcre_exec()\fP |
429 |
|
or \fBpcre_dfa_exec()\fP |
430 |
|
.\" JOIN |
431 |
|
\e<any> pass the PCRE_NEWLINE_ANY option to \fBpcre_exec()\fP |
432 |
|
or \fBpcre_dfa_exec()\fP |
433 |
.sp |
.sp |
434 |
A backslash followed by anything else just escapes the anything else. If the |
The escapes that specify line ending sequences are literal strings, exactly as |
435 |
very last character is a backslash, it is ignored. This gives a way of passing |
shown. No more than one newline setting should be present in any data line. |
436 |
an empty line as data, since a real empty line terminates the data input. |
.P |
437 |
|
A backslash followed by anything else just escapes the anything else. If |
438 |
|
the very last character is a backslash, it is ignored. This gives a way of |
439 |
|
passing an empty line as data, since a real empty line terminates the data |
440 |
|
input. |
441 |
.P |
.P |
442 |
If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with |
If \eM is present, \fBpcretest\fP calls \fBpcre_exec()\fP several times, with |
443 |
different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP |
different values in the \fImatch_limit\fP and \fImatch_limit_recursion\fP |
456 |
the call of \fBpcre_exec()\fP for the line in which it appears. |
the call of \fBpcre_exec()\fP for the line in which it appears. |
457 |
.P |
.P |
458 |
If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper |
If the \fB/P\fP modifier was present on the pattern, causing the POSIX wrapper |
459 |
API to be used, the only option-setting sequences that have any effect are \eB |
API to be used, the only option-setting sequences that have any effect are \eB, |
460 |
and \eZ, causing REG_NOTBOL and REG_NOTEOL, respectively, to be passed to |
\eN, and \eZ, causing REG_NOTBOL, REG_NOTEMPTY, and REG_NOTEOL, respectively, |
461 |
\fBregexec()\fP. |
to be passed to \fBregexec()\fP. |
462 |
.P |
.P |
463 |
The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use |
The use of \ex{hh...} to represent UTF-8 characters is not dependent on the use |
464 |
of the \fB/8\fP modifier on the pattern. It is recognized always. There may be |
of the \fB/8\fP modifier on the pattern. It is recognized always. There may be |
465 |
any number of hexadecimal digits inside the braces. The result is from one to |
any number of hexadecimal digits inside the braces. The result is from one to |
466 |
six bytes, encoded according to the UTF-8 rules. |
six bytes, encoded according to the original UTF-8 rules of RFC 2279. This |
467 |
|
allows for values in the range 0 to 0x7FFFFFFF. Note that not all of those are |
468 |
|
valid Unicode code points, or indeed valid UTF-8 characters according to the |
469 |
|
later rules in RFC 3629. |
470 |
. |
. |
471 |
. |
. |
472 |
.SH "THE ALTERNATIVE MATCHING FUNCTION" |
.SH "THE ALTERNATIVE MATCHING FUNCTION" |
497 |
.P |
.P |
498 |
When a match succeeds, pcretest outputs the list of captured substrings that |
When a match succeeds, pcretest outputs the list of captured substrings that |
499 |
\fBpcre_exec()\fP returns, starting with number 0 for the string that matched |
\fBpcre_exec()\fP returns, starting with number 0 for the string that matched |
500 |
the whole pattern. Otherwise, it outputs "No match" or "Partial match" |
the whole pattern. Otherwise, it outputs "No match" when the return is |
501 |
when \fBpcre_exec()\fP returns PCRE_ERROR_NOMATCH or PCRE_ERROR_PARTIAL, |
PCRE_ERROR_NOMATCH, and "Partial match:" followed by the partially matching |
502 |
respectively, and otherwise the PCRE negative error number. Here is an example |
substring when \fBpcre_exec()\fP returns PCRE_ERROR_PARTIAL. For any other |
503 |
of an interactive \fBpcretest\fP run. |
returns, it outputs the PCRE negative error number. Here is an example of an |
504 |
|
interactive \fBpcretest\fP run. |
505 |
.sp |
.sp |
506 |
$ pcretest |
$ pcretest |
507 |
PCRE version 5.00 07-Sep-2004 |
PCRE version 7.0 30-Nov-2006 |
508 |
.sp |
.sp |
509 |
re> /^abc(\ed+)/ |
re> /^abc(\ed+)/ |
510 |
data> abc123 |
data> abc123 |
513 |
data> xyz |
data> xyz |
514 |
No match |
No match |
515 |
.sp |
.sp |
516 |
|
Note that unset capturing substrings that are not followed by one that is set |
517 |
|
are not returned by \fBpcre_exec()\fP, and are not shown by \fBpcretest\fP. In |
518 |
|
the following example, there are two capturing substrings, but when the first |
519 |
|
data line is matched, the second, unset substring is not shown. An "internal" |
520 |
|
unset substring is shown as "<unset>", as for the second data line. |
521 |
|
.sp |
522 |
|
re> /(a)|(b)/ |
523 |
|
data> a |
524 |
|
0: a |
525 |
|
1: a |
526 |
|
data> b |
527 |
|
0: b |
528 |
|
1: <unset> |
529 |
|
2: b |
530 |
|
.sp |
531 |
If the strings contain any non-printing characters, they are output as \e0x |
If the strings contain any non-printing characters, they are output as \e0x |
532 |
escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the |
escapes, or as \ex{...} escapes if the \fB/8\fP modifier was present on the |
533 |
pattern. If the pattern has the \fB/+\fP modifier, the output for substring 0 |
pattern. See below for the definition of non-printing characters. If the |
534 |
is followed by the the rest of the subject string, identified by "0+" like |
pattern has the \fB/+\fP modifier, the output for substring 0 is followed by |
535 |
this: |
the the rest of the subject string, identified by "0+" like this: |
536 |
.sp |
.sp |
537 |
re> /cat/+ |
re> /cat/+ |
538 |
data> cataract |
data> cataract |
560 |
length (that is, the return from the extraction function) is given in |
length (that is, the return from the extraction function) is given in |
561 |
parentheses after each string for \fB\eC\fP and \fB\eG\fP. |
parentheses after each string for \fB\eC\fP and \fB\eG\fP. |
562 |
.P |
.P |
563 |
Note that while patterns can be continued over several lines (a plain ">" |
Note that whereas patterns can be continued over several lines (a plain ">" |
564 |
prompt is used for continuations), data lines may not. However newlines can be |
prompt is used for continuations), data lines may not. However newlines can be |
565 |
included in data by means of the \en escape. |
included in data by means of the \en escape (or \er, \er\en, etc., depending on |
566 |
|
the newline sequence setting). |
567 |
|
. |
568 |
. |
. |
569 |
. |
. |
570 |
.SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION" |
.SH "OUTPUT FROM THE ALTERNATIVE MATCHING FUNCTION" |
582 |
2: tan |
2: tan |
583 |
.sp |
.sp |
584 |
(Using the normal matching function on this data finds only "tang".) The |
(Using the normal matching function on this data finds only "tang".) The |
585 |
longest matching string is always given first (and numbered zero). |
longest matching string is always given first (and numbered zero). After a |
586 |
|
PCRE_ERROR_PARTIAL return, the output is "Partial match:", followed by the |
587 |
|
partially matching substring. |
588 |
.P |
.P |
589 |
If \fB/g\P is present on the pattern, the search for further matches resumes |
If \fB/g\fP is present on the pattern, the search for further matches resumes |
590 |
at the end of the longest match. For example: |
at the end of the longest match. For example: |
591 |
.sp |
.sp |
592 |
re> /(tang|tangerine|tan)/g |
re> /(tang|tangerine|tan)/g |
610 |
match with additional subject data by means of the \eR escape sequence. For |
match with additional subject data by means of the \eR escape sequence. For |
611 |
example: |
example: |
612 |
.sp |
.sp |
613 |
re> /^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$/ |
re> /^\ed?\ed(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\ed\ed$/ |
614 |
data> 23ja\eP\eD |
data> 23ja\eP\eD |
615 |
Partial match: 23ja |
Partial match: 23ja |
616 |
data> n05\eR\eD |
data> n05\eR\eD |
667 |
documentation. |
documentation. |
668 |
. |
. |
669 |
. |
. |
670 |
|
. |
671 |
|
.SH "NON-PRINTING CHARACTERS" |
672 |
|
.rs |
673 |
|
.sp |
674 |
|
When \fBpcretest\fP is outputting text in the compiled version of a pattern, |
675 |
|
bytes other than 32-126 are always treated as non-printing characters are are |
676 |
|
therefore shown as hex escapes. |
677 |
|
.P |
678 |
|
When \fBpcretest\fP is outputting text that is a matched part of a subject |
679 |
|
string, it behaves in the same way, unless a different locale has been set for |
680 |
|
the pattern (using the \fB/L\fP modifier). In this case, the \fBisprint()\fP |
681 |
|
function to distinguish printing and non-printing characters. |
682 |
|
. |
683 |
|
. |
684 |
|
. |
685 |
.SH "SAVING AND RELOADING COMPILED PATTERNS" |
.SH "SAVING AND RELOADING COMPILED PATTERNS" |
686 |
.rs |
.rs |
687 |
.sp |
.sp |
742 |
result is undefined. |
result is undefined. |
743 |
. |
. |
744 |
. |
. |
745 |
|
.SH "SEE ALSO" |
746 |
|
.rs |
747 |
|
.sp |
748 |
|
\fBpcre\fP(3), \fBpcreapi\fP(3), \fBpcrecallout\fP(3), \fBpcrematching\fP(3), |
749 |
|
\fBpcrepartial\fP(d), \fBpcrepattern\fP(3), \fBpcreprecompile\fP(3). |
750 |
|
. |
751 |
|
. |
752 |
.SH AUTHOR |
.SH AUTHOR |
753 |
.rs |
.rs |
754 |
.sp |
.sp |
755 |
|
.nf |
756 |
Philip Hazel |
Philip Hazel |
757 |
.br |
University Computing Service |
758 |
University Computing Service, |
Cambridge CB2 3QH, England. |
759 |
.br |
.fi |
760 |
Cambridge CB2 3QG, England. |
. |
761 |
.P |
. |
762 |
.in 0 |
.SH REVISION |
763 |
Last updated: 18 January 2006 |
.rs |
764 |
.br |
.sp |
765 |
Copyright (c) 1997-2006 University of Cambridge. |
.nf |
766 |
|
Last updated: 14 June 2010 |
767 |
|
Copyright (c) 1997-2010 University of Cambridge. |
768 |
|
.fi |