Add GAppInfoMonitor
[platform/upstream/glib.git] / docs / reference / glib / regex-syntax.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3                "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 ]>
5 <refentry id="glib-regex-syntax" revision="11 Jul 2006">
6  <refmeta>
7   <refentrytitle>Regular expression syntax</refentrytitle>
8  </refmeta>
9
10
11 <!--
12 Based on the man page for pcrepattern.
13
14 Remember to sync this document with the file docs/pcrepattern.3 in the
15 pcre package when upgrading to a newer version of pcre.
16
17 In sync with PCRE 7.0
18 -->
19
20 <refnamediv>
21 <refname>Regular expression syntax</refname>
22 <refpurpose>
23 syntax and semantics of regular expressions supported by GRegex
24 </refpurpose>
25 </refnamediv>
26
27 <refsect1>
28 <title>GRegex regular expression details</title>
29 <para>
30 A regular expression is a pattern that is matched against a
31 string from left to right. Most characters stand for themselves in a
32 pattern, and match the corresponding characters in the string. As a
33 trivial example, the pattern
34 </para>
35
36 <programlisting>
37 The quick brown fox
38 </programlisting>
39
40 <para>
41 matches a portion of a string that is identical to itself. When
42 caseless matching is specified (the <varname>G_REGEX_CASELESS</varname> flag), letters are
43 matched independently of case.
44 </para>
45
46 <para>
47 The power of regular expressions comes from the ability to include
48 alternatives and repetitions in the pattern. These are encoded in the
49 pattern by the use of metacharacters, which do not stand for themselves
50 but instead are interpreted in some special way.
51 </para>
52
53 <para>
54 There are two different sets of metacharacters: those that are recognized
55 anywhere in the pattern except within square brackets, and those
56 that are recognized in square brackets. Outside square brackets, the
57 metacharacters are as follows:
58 </para>
59
60 <table frame="all" colsep="1" rowsep="1">
61 <title>Metacharacters outside square brackets</title>
62 <tgroup cols="2">
63 <colspec colnum="1" align="center"/>
64 <thead>
65   <row>
66     <entry>Character</entry>
67     <entry>Meaning</entry>
68   </row>
69 </thead>
70 <tbody>
71   <row>
72     <entry>\</entry>
73     <entry>general escape character with several uses</entry>
74   </row>
75   <row>
76     <entry>^</entry>
77     <entry>assert start of string (or line, in multiline mode)</entry>
78   </row>
79   <row>
80     <entry>$</entry>
81     <entry>assert end of string (or line, in multiline mode)</entry>
82   </row>
83   <row>
84     <entry>.</entry>
85     <entry>match any character except newline (by default)</entry>
86   </row>
87   <row>
88     <entry>[</entry>
89     <entry>start character class definition</entry>
90   </row>
91   <row>
92     <entry>|</entry>
93     <entry>start of alternative branch</entry>
94   </row>
95   <row>
96     <entry>(</entry>
97     <entry>start subpattern</entry>
98   </row>
99   <row>
100     <entry>)</entry>
101     <entry>end subpattern</entry>
102   </row>
103   <row>
104     <entry>?</entry>
105     <entry>extends the meaning of (, or 0/1 quantifier, or quantifier minimizer</entry>
106   </row>
107   <row>
108     <entry>*</entry>
109     <entry>0 or more quantifier</entry>
110   </row>
111   <row>
112     <entry>+</entry>
113     <entry>1 or more quantifier, also "possessive quantifier"</entry>
114   </row>
115   <row>
116     <entry>{</entry>
117     <entry>start min/max quantifier</entry>
118   </row>
119 </tbody>
120 </tgroup>
121 </table>
122
123 <para>
124 Part of a pattern that is in square brackets is called a "character
125 class". In a character class the only metacharacters are:
126 </para>
127
128 <table frame="all" colsep="1" rowsep="1">
129 <title>Metacharacters inside square brackets</title>
130 <tgroup cols="2">
131 <colspec colnum="1" align="center"/>
132 <thead>
133   <row>
134     <entry>Character</entry>
135     <entry>Meaning</entry>
136   </row>
137 </thead>
138 <tbody>
139   <row>
140     <entry>\</entry>
141     <entry>general escape character</entry>
142   </row>
143   <row>
144     <entry>^</entry>
145     <entry>negate the class, but only if the first character</entry>
146   </row>
147   <row>
148     <entry>-</entry>
149     <entry>indicates character range</entry>
150   </row>
151   <row>
152     <entry>[</entry>
153     <entry>POSIX character class (only if followed by POSIX syntax)</entry>
154   </row>
155   <row>
156     <entry>]</entry>
157     <entry>terminates the character class</entry>
158   </row>
159 </tbody>
160 </tgroup>
161 </table>
162 </refsect1>
163
164 <refsect1>
165 <title>Backslash</title>
166 <para>
167 The backslash character has several uses. Firstly, if it is followed by
168 a non-alphanumeric character, it takes away any special meaning that
169 character may have. This use of backslash as an escape character
170 applies both inside and outside character classes.
171 </para>
172
173 <para>
174 For example, if you want to match a * character, you write \* in the
175 pattern. This escaping action applies whether or not the following
176 character would otherwise be interpreted as a metacharacter, so it is
177 always safe to precede a non-alphanumeric with backslash to specify
178 that it stands for itself. In particular, if you want to match a
179 backslash, you write \\.
180 </para>
181
182 <para>
183 If a pattern is compiled with the <varname>G_REGEX_EXTENDED</varname>
184 option, whitespace in the pattern (other than in a character class) and
185 characters between a # outside a character class and the next newline
186 are ignored.
187 An escaping backslash can be used to include a whitespace or # character
188 as part of the pattern.
189 </para>
190
191 <para>
192 Note that the C compiler interprets backslash in strings itself, therefore
193 you need to duplicate all \ characters when you put a regular expression
194 in a C string, like "\\d{3}".
195 </para>
196
197 <para>
198 If you want to remove the special meaning from a sequence of characters,
199 you can do so by putting them between \Q and \E.
200 The \Q...\E sequence is recognized both inside and outside character
201 classes.
202 </para>
203
204 <refsect2>
205 <title>Non-printing characters</title>
206 <para>
207 A second use of backslash provides a way of encoding non-printing
208 characters in patterns in a visible manner. There is no restriction on the
209 appearance of non-printing characters, apart from the binary zero that
210 terminates a pattern, but when a pattern is being prepared by text
211 editing, it is usually easier to use one of the following escape
212 sequences than the binary character it represents:
213 </para>
214
215 <table frame="all" colsep="1" rowsep="1">
216 <title>Non-printing characters</title>
217 <tgroup cols="2">
218 <colspec colnum="1" align="center"/>
219 <thead>
220   <row>
221     <entry>Escape</entry>
222     <entry>Meaning</entry>
223   </row>
224 </thead>
225 <tbody>
226   <row>
227     <entry>\a</entry>
228     <entry>alarm, that is, the BEL character (hex 07)</entry>
229   </row>
230   <row>
231     <entry>\cx</entry>
232     <entry>"control-x", where x is any character</entry>
233   </row>
234   <row>
235     <entry>\e</entry>
236     <entry>escape (hex 1B)</entry>
237   </row>
238   <row>
239     <entry>\f</entry>
240     <entry>formfeed (hex 0C)</entry>
241   </row>
242   <row>
243     <entry>\n</entry>
244     <entry>newline (hex 0A)</entry>
245   </row>
246   <row>
247     <entry>\r</entry>
248     <entry>carriage return (hex 0D)</entry>
249   </row>
250   <row>
251     <entry>\t</entry>
252     <entry>tab (hex 09)</entry>
253   </row>
254   <row>
255     <entry>\ddd</entry>
256     <entry>character with octal code ddd, or backreference</entry>
257   </row>
258   <row>
259     <entry>\xhh</entry>
260     <entry>character with hex code hh</entry>
261   </row>
262   <row>
263     <entry>\x{hhh..}</entry>
264     <entry>character with hex code hhh..</entry>
265   </row>
266 </tbody>
267 </tgroup>
268 </table>
269
270 <para>
271 The precise effect of \cx is as follows: if x is a lower case letter,
272 it is converted to upper case. Then bit 6 of the character (hex 40) is
273 inverted. Thus \cz becomes hex 1A, but \c{ becomes hex 3B, while \c;
274 becomes hex 7B.
275 </para>
276
277 <para>
278 After \x, from zero to two hexadecimal digits are read (letters can be
279 in upper or lower case). Any number of hexadecimal digits may appear
280 between \x{ and }, but the value of the character code
281 must be less than 2**31 (that is, the maximum hexadecimal value is
282 7FFFFFFF). If characters other than hexadecimal digits appear between
283 \x{ and }, or if there is no terminating }, this form of escape is not
284 recognized. Instead, the initial \x will be interpreted as a basic hexadecimal
285 escape, with no following digits, giving a character whose
286 value is zero.
287 </para>
288
289 <para>
290 Characters whose value is less than 256 can be defined by either of the
291 two syntaxes for \x. There is no difference
292 in the way they are handled. For example, \xdc is exactly the same as
293 \x{dc}.
294 </para>
295
296 <para>
297 After \0 up to two further octal digits are read. If there are fewer
298 than two digits, just those that are present are used.
299 Thus the sequence \0\x\07 specifies two binary zeros followed by a BEL
300 character (code value 7). Make sure you supply two digits after the
301 initial zero if the pattern character that follows is itself an octal
302 digit.
303 </para>
304
305 <para>
306 The handling of a backslash followed by a digit other than 0 is complicated.
307 Outside a character class, GRegex reads it and any following digits as a
308 decimal number. If the number is less than 10, or if there
309 have been at least that many previous capturing left parentheses in the
310 expression, the entire sequence is taken as a back reference. A
311 description of how this works is given later, following the discussion
312 of parenthesized subpatterns.
313 </para>
314
315 <para>
316 Inside a character class, or if the decimal number is greater than 9
317 and there have not been that many capturing subpatterns, GRegex re-reads
318 up to three octal digits following the backslash, and uses them to generate
319 a data character. Any subsequent digits stand for themselves. For example:
320 </para>
321
322 <table frame="all" colsep="1" rowsep="1">
323 <title>Non-printing characters</title>
324 <tgroup cols="2">
325 <colspec colnum="1" align="center"/>
326 <thead>
327   <row>
328     <entry>Escape</entry>
329     <entry>Meaning</entry>
330   </row>
331 </thead>
332 <tbody>
333   <row>
334     <entry>\040</entry>
335     <entry>is another way of writing a space</entry>
336   </row>
337   <row>
338     <entry>\40</entry>
339     <entry>is the same, provided there are fewer than 40 previous capturing subpatterns</entry>
340   </row>
341   <row>
342     <entry>\7</entry>
343     <entry>is always a back reference</entry>
344   </row>
345   <row>
346     <entry>\11</entry>
347     <entry>might be a back reference, or another way of writing a tab</entry>
348   </row>
349   <row>
350     <entry>\011</entry>
351     <entry>is always a tab</entry>
352   </row>
353   <row>
354     <entry>\0113</entry>
355     <entry>is a tab followed by the character "3"</entry>
356   </row>
357   <row>
358     <entry>\113</entry>
359     <entry>might be a back reference, otherwise the character with octal code 113</entry>
360   </row>
361   <row>
362     <entry>\377</entry>
363     <entry>might be a back reference, otherwise the byte consisting entirely of 1 bits</entry>
364   </row>
365   <row>
366     <entry>\81</entry>
367     <entry>is either a back reference, or a binary zero followed by the two characters "8" and "1"</entry>
368   </row>
369 </tbody>
370 </tgroup>
371 </table>
372
373 <para>
374 Note that octal values of 100 or greater must not be introduced by a
375 leading zero, because no more than three octal digits are ever read.
376 </para>
377
378 <para>
379 All the sequences that define a single character can be used both inside
380 and outside character classes. In addition, inside a character class, the
381 sequence \b is interpreted as the backspace character (hex 08), and the
382 sequences \R and \X are interpreted as the characters "R" and "X", respectively.
383 Outside a character class, these sequences have different meanings (see below).
384 </para>
385 </refsect2>
386
387 <refsect2>
388 <title>Absolute and relative back references</title>
389 <para>
390 The sequence \g followed by a positive or negative number, optionally enclosed
391 in braces, is an absolute or relative back reference. Back references are
392 discussed later, following the discussion of parenthesized subpatterns.
393 </para>
394 </refsect2>
395
396 <refsect2>
397 <title>Generic character types</title>
398
399 <para>
400 Another use of backslash is for specifying generic character types.
401 The following are always recognized:
402 </para>
403
404 <table frame="all" colsep="1" rowsep="1">
405 <title>Generic characters</title>
406 <tgroup cols="2">
407 <colspec colnum="1" align="center"/>
408 <thead>
409   <row>
410     <entry>Escape</entry>
411     <entry>Meaning</entry>
412   </row>
413 </thead>
414 <tbody>
415   <row>
416     <entry>\d</entry>
417     <entry>any decimal digit</entry>
418   </row>
419   <row>
420     <entry>\D</entry>
421     <entry>any character that is not a decimal digit</entry>
422   </row>
423   <row>
424     <entry>\s</entry>
425     <entry>any whitespace character</entry>
426   </row>
427   <row>
428     <entry>\S</entry>
429     <entry>any character that is not a whitespace character</entry>
430   </row>
431   <row>
432     <entry>\w</entry>
433     <entry>any "word" character</entry>
434   </row>
435   <row>
436     <entry>\W</entry>
437     <entry>any "non-word" character</entry>
438   </row>
439 </tbody>
440 </tgroup>
441 </table>
442
443 <para>
444 Each pair of escape sequences partitions the complete set of characters
445 into two disjoint sets. Any given character matches one, and only one,
446 of each pair.
447 </para>
448
449 <para>
450 These character type sequences can appear both inside and outside character
451 classes. They each match one character of the appropriate type.
452 If the current matching point is at the end of the passed string, all
453 of them fail, since there is no character to match.
454 </para>
455
456 <para>
457 For compatibility with Perl, \s does not match the VT character (code
458 11). This makes it different from the the POSIX "space" class. The \s
459 characters are HT (9), LF (10), FF (12), CR (13), and space (32).
460 </para>
461
462 <para>
463 A "word" character is an underscore or any character less than 256 that
464 is a letter or digit.</para>
465
466 <para>
467 Characters with values greater than 128 never match \d,
468 \s, or \w, and always match \D, \S, and \W.
469 </para>
470 </refsect2>
471
472 <refsect2>
473 <title>Newline sequences</title>
474 <para>Outside a character class, the escape sequence \R matches any Unicode
475 newline sequence.
476 This particular group matches either the two-character sequence CR followed by
477 LF, or one of the single characters LF (linefeed, U+000A), VT (vertical tab,
478 U+000B), FF (formfeed, U+000C), CR (carriage return, U+000D), NEL (next
479 line, U+0085), LS (line separator, U+2028), or PS (paragraph separator, U+2029).
480 The two-character sequence is treated as a single unit that
481 cannot be split. Inside a character class, \R matches the letter "R".</para>
482 </refsect2>
483
484 <refsect2>
485 <title>Unicode character properties</title>
486 <para>
487 To support generic character types there are three additional escape
488 sequences, they are:
489 </para>
490
491 <table frame="all" colsep="1" rowsep="1">
492 <title>Generic character types</title>
493 <tgroup cols="2">
494 <colspec colnum="1" align="center"/>
495 <thead>
496   <row>
497     <entry>Escape</entry>
498     <entry>Meaning</entry>
499   </row>
500 </thead>
501 <tbody>
502   <row>
503     <entry>\p{xx}</entry>
504     <entry>a character with the xx property</entry>
505   </row>
506   <row>
507     <entry>\P{xx}</entry>
508     <entry>a character without the xx property</entry>
509   </row>
510   <row>
511     <entry>\X</entry>
512     <entry>an extended Unicode sequence</entry>
513   </row>
514 </tbody>
515 </tgroup>
516 </table>
517
518 <para>
519 The property names represented by xx above are limited to the Unicode
520 script names, the general category properties, and "Any", which matches
521 any character (including newline). Other properties such as "InMusicalSymbols"
522 are not currently supported. Note that \P{Any} does not match any characters,
523 so always causes a match failure.
524 </para>
525
526 <para>
527 Sets of Unicode characters are defined as belonging to certain scripts. A
528 character from one of these sets can be matched using a script name. For
529 example, \p{Greek} or \P{Han}.
530 </para>
531
532 <para>
533 Those that are not part of an identified script are lumped together as
534 "Common". The current list of scripts can be found in the documentation for
535 the #GUnicodeScript enumeration. Script names for use with \p{} can be
536 found by replacing all spaces with underscores, e.g. for Linear B use
537 \p{Linear_B}.
538 </para>
539
540 <para>
541 Each character has exactly one general category property, specified by a
542 two-letter abbreviation. For compatibility with Perl, negation can be specified
543 by including a circumflex between the opening brace and the property name. For
544 example, \p{^Lu} is the same as \P{Lu}.
545 </para>
546
547 <para>
548 If only one letter is specified with \p or \P, it includes all the general
549 category properties that start with that letter. In this case, in the absence
550 of negation, the curly brackets in the escape sequence are optional; these two
551 examples have the same effect:
552 </para>
553
554 <programlisting>
555 \p{L}
556 \pL
557 </programlisting>
558
559 <para>
560 In addition to the two-letter category codes listed in the
561 documentation for the #GUnicodeType enumeration, the following
562 general category property codes are supported:
563 </para>
564
565 <table frame="all" colsep="1" rowsep="1">
566 <title>Property codes</title>
567 <tgroup cols="2">
568 <colspec colnum="1" align="center"/>
569 <thead>
570   <row>
571     <entry>Code</entry>
572     <entry>Meaning</entry>
573   </row>
574 </thead>
575 <tbody>
576   <row>
577     <entry>C</entry>
578     <entry>Other</entry>
579   </row>
580   <row>
581     <entry>L</entry>
582     <entry>Letter</entry>
583   </row>
584   <row>
585     <entry>M</entry>
586     <entry>Mark</entry>
587   </row>
588   <row>
589     <entry>N</entry>
590     <entry>Number</entry>
591   </row>
592   <row>
593     <entry>P</entry>
594     <entry>Punctuation</entry>
595   </row>
596   <row>
597     <entry>S</entry>
598     <entry>Symbol</entry>
599   </row>
600   <row>
601     <entry>Z</entry>
602     <entry>Separator</entry>
603   </row>
604 </tbody>
605 </tgroup>
606 </table>
607
608 <para>
609 The special property L&amp; is also supported: it matches a character that has
610 the Lu, Ll, or Lt property, in other words, a letter that is not classified as
611 a modifier or "other".
612 </para>
613
614 <para>
615 The long synonyms for these properties that Perl supports (such as \ep{Letter})
616 are not supported by GRegex, nor is it permitted to prefix any of these
617 properties with "Is".
618 </para>
619
620 <para>
621 No character that is in the Unicode table has the Cn (unassigned) property.
622 Instead, this property is assumed for any code point that is not in the
623 Unicode table.
624 </para>
625
626 <para>
627 Specifying caseless matching does not affect these escape sequences.
628 For example, \p{Lu} always matches only upper case letters.
629 </para>
630
631 <para>
632 The \X escape matches any number of Unicode characters that form an
633 extended Unicode sequence. \X is equivalent to
634 </para>
635
636 <programlisting>
637 (?&gt;\PM\pM*)
638 </programlisting>
639
640 <para>
641 That is, it matches a character without the "mark" property, followed
642 by zero or more characters with the "mark" property, and treats the
643 sequence as an atomic group (see below). Characters with the "mark"
644 property are typically accents that affect the preceding character.
645 </para>
646
647 <para>
648 Matching characters by Unicode property is not fast, because GRegex has
649 to search a structure that contains data for over fifteen thousand
650 characters. That is why the traditional escape sequences such as \d and
651 \w do not use Unicode properties.
652 </para>
653 </refsect2>
654
655 <refsect2>
656 <title>Simple assertions</title>
657 <para>
658 The final use of backslash is for certain simple assertions. An
659 assertion specifies a condition that has to be met at a particular point in
660 a match, without consuming any characters from the string. The
661 use of subpatterns for more complicated assertions is described below.
662 The backslashed assertions are:
663 </para>
664
665 <table frame="all" colsep="1" rowsep="1">
666 <title>Simple assertions</title>
667 <tgroup cols="2">
668 <colspec colnum="1" align="center"/>
669 <thead>
670   <row>
671     <entry>Escape</entry>
672     <entry>Meaning</entry>
673   </row>
674 </thead>
675 <tbody>
676   <row>
677     <entry>\b</entry>
678     <entry>matches at a word boundary</entry>
679   </row>
680   <row>
681     <entry>\B</entry>
682     <entry>matches when not at a word boundary</entry>
683   </row>
684   <row>
685     <entry>\A</entry>
686     <entry>matches at the start of the string</entry>
687   </row>
688   <row>
689     <entry>\Z</entry>
690     <entry>matches at the end of the string or before a newline at the end of the string</entry>
691   </row>
692   <row>
693     <entry>\z</entry>
694     <entry>matches only at the end of the string</entry>
695   </row>
696   <row>
697     <entry>\G</entry>
698     <entry>matches at first matching position in the string</entry>
699   </row>
700 </tbody>
701 </tgroup>
702 </table>
703
704 <para>
705 These assertions may not appear in character classes (but note that \b
706 has a different meaning, namely the backspace character, inside a
707 character class).
708 </para>
709
710 <para>
711 A word boundary is a position in the string where the current
712 character and the previous character do not both match \w or \W (i.e.
713 one matches \w and the other matches \W), or the start or end of the
714 string if the first or last character matches \w, respectively.
715 </para>
716
717 <para>
718 The \A, \Z, and \z assertions differ from the traditional circumflex
719 and dollar (described in the next section) in that they only ever match
720 at the very start and end of the string, whatever options are
721 set. Thus, they are independent of multiline mode. These three assertions
722 are not affected by the <varname>G_REGEX_MATCH_NOTBOL</varname> or <varname>G_REGEX_MATCH_NOTEOL</varname> options,
723 which affect only the behaviour of the circumflex and dollar metacharacters.
724 However, if the start_position argument of a matching function is non-zero,
725 indicating that matching is to start at a point other than the beginning of
726 the string, \A can never match. The difference between \Z and \z is
727 that \Z matches before a newline at the end of the string as well at the
728 very end, whereas \z matches only at the end.
729 </para>
730
731 <para>
732 The \G assertion is true only when the current matching position is at
733 the start point of the match, as specified by the start_position argument
734 to the matching functions. It differs from \A when the value of startoffset is
735 non-zero.
736 </para>
737
738 <para>
739 Note, however, that the interpretation of \G, as the start of the
740 current match, is subtly different from Perl’s, which defines it as the
741 end of the previous match. In Perl, these can be different when the
742 previously matched string was empty.
743 </para>
744
745 <para>
746 If all the alternatives of a pattern begin with \G, the expression is
747 anchored to the starting match position, and the "anchored" flag is set
748 in the compiled regular expression.
749 </para>
750 </refsect2>
751 </refsect1>
752
753 <refsect1>
754 <title>Circumflex and dollar</title>
755 <para>
756 Outside a character class, in the default matching mode, the circumflex
757 character is an assertion that is true only if the current matching
758 point is at the start of the string. If the start_position argument to
759 the matching functions is non-zero, circumflex can never match if the
760 <varname>G_REGEX_MULTILINE</varname> option is unset. Inside a character class, circumflex
761 has an entirely different meaning (see below).
762 </para>
763
764 <para>
765 Circumflex need not be the first character of the pattern if a number
766 of alternatives are involved, but it should be the first thing in each
767 alternative in which it appears if the pattern is ever to match that
768 branch. If all possible alternatives start with a circumflex, that is,
769 if the pattern is constrained to match only at the start of the string,
770 it is said to be an "anchored" pattern. (There are also other
771 constructs that can cause a pattern to be anchored.)
772 </para>
773
774 <para>
775 A dollar character is an assertion that is true only if the current
776 matching point is at the end of the string, or immediately
777 before a newline at the end of the string (by default). Dollar need not
778 be the last character of the pattern if a number of alternatives are
779 involved, but it should be the last item in any branch in which it
780 appears. Dollar has no special meaning in a character class.
781 </para>
782
783 <para>
784 The meaning of dollar can be changed so that it matches only at the
785 very end of the string, by setting the <varname>G_REGEX_DOLLAR_ENDONLY</varname> option at
786 compile time. This does not affect the \Z assertion.
787 </para>
788
789 <para>
790 The meanings of the circumflex and dollar characters are changed if the
791 <varname>G_REGEX_MULTILINE</varname> option is set. When this is the case,
792 a circumflex matches immediately after internal newlines as well as at the
793 start of the string. It does not match after a newline that ends the string.
794 A dollar matches before any newlines in the string, as well as at the very
795 end, when <varname>G_REGEX_MULTILINE</varname> is set. When newline is
796 specified as the two-character sequence CRLF, isolated CR and LF characters
797 do not indicate newlines.
798 </para>
799
800 <para>
801 For example, the pattern /^abc$/ matches the string "def\nabc" (where
802 \n represents a newline) in multiline mode, but not otherwise. Consequently,
803 patterns that are anchored in single line mode because all branches start with
804 ^ are not anchored in multiline mode, and a match for circumflex is possible
805 when the <varname>start_position</varname> argument of a matching function
806 is non-zero. The <varname>G_REGEX_DOLLAR_ENDONLY</varname> option is ignored
807 if <varname>G_REGEX_MULTILINE</varname> is set.
808 </para>
809
810 <para>
811 Note that the sequences \A, \Z, and \z can be used to match the start and
812 end of the string in both modes, and if all branches of a pattern start with
813 \A it is always anchored, whether or not <varname>G_REGEX_MULTILINE</varname>
814 is set.
815 </para>
816 </refsect1>
817
818 <refsect1>
819 <title>Full stop (period, dot)</title>
820 <para>
821 Outside a character class, a dot in the pattern matches any one character
822 in the string, including a non-printing character, but not (by
823 default) newline. In UTF-8 a character might be more than one byte long.
824 </para>
825
826 <para>
827 When a line ending is defined as a single character, dot never matches that
828 character; when the two-character sequence CRLF is used, dot does not match CR
829 if it is immediately followed by LF, but otherwise it matches all characters
830 (including isolated CRs and LFs). When any Unicode line endings are being
831 recognized, dot does not match CR or LF or any of the other line ending
832 characters.
833 </para>
834
835 <para>
836 If the <varname>G_REGEX_DOTALL</varname> flag is set, dots match newlines
837 as well. The handling of dot is entirely independent of the handling of circumflex
838 and dollar, the only relationship being that they both involve newline
839 characters. Dot has no special meaning in a character class.
840 </para>
841
842 <para>
843 The behaviour of dot with regard to newlines can be changed. If the
844 <varname>G_REGEX_DOTALL</varname> option is set, a dot matches any one
845 character, without exception. If newline is defined as the two-character
846 sequence CRLF, it takes two dots to match it.
847 </para>
848
849 <para>
850 The handling of dot is entirely independent of the handling of circumflex and
851 dollar, the only relationship being that they both involve newlines. Dot has no
852 special meaning in a character class.
853 </para>
854 </refsect1>
855
856 <refsect1>
857 <title>Matching a single byte</title>
858 <para>
859 Outside a character class, the escape sequence \C matches any one byte,
860 both in and out of UTF-8 mode. Unlike a dot, it always matches any line
861 ending characters.
862 The feature is provided in Perl in order to match individual bytes in
863 UTF-8 mode. Because it breaks up UTF-8 characters into individual
864 bytes, what remains in the string may be a malformed UTF-8 string. For
865 this reason, the \C escape sequence is best avoided.
866 </para>
867
868 <para>
869 GRegex does not allow \C to appear in lookbehind assertions (described
870 below), because in UTF-8 mode this would make it impossible to calculate
871 the length of the lookbehind.
872 </para>
873 </refsect1>
874
875 <refsect1>
876 <title>Square brackets and character classes</title>
877 <para>
878 An opening square bracket introduces a character class, terminated by a
879 closing square bracket. A closing square bracket on its own is not special. If a closing square bracket is required as a member of the class,
880 it should be the first data character in the class (after an initial
881 circumflex, if present) or escaped with a backslash.
882 </para>
883
884 <para>
885 A character class matches a single character in the string.  A matched character
886 must be in the set of characters defined by the class, unless the first
887 character in the class definition is a circumflex, in which case the
888 string character must not be in the set defined by the class. If a
889 circumflex is actually required as a member of the class, ensure it is
890 not the first character, or escape it with a backslash.
891 </para>
892
893 <para>
894 For example, the character class [aeiou] matches any lower case vowel,
895 while [^aeiou] matches any character that is not a lower case vowel.
896 Note that a circumflex is just a convenient notation for specifying the
897 characters that are in the class by enumerating those that are not. A
898 class that starts with a circumflex is not an assertion: it still consumes
899 a character from the string, and therefore it fails if the current pointer
900 is at the end of the string.
901 </para>
902
903 <para>
904 In UTF-8 mode, characters with values greater than 255 can be included
905 in a class as a literal string of bytes, or by using the \x{ escaping
906 mechanism.
907 </para>
908
909 <para>
910 When caseless matching is set, any letters in a class represent both
911 their upper case and lower case versions, so for example, a caseless
912 [aeiou] matches "A" as well as "a", and a caseless [^aeiou] does not
913 match "A", whereas a caseful version would.
914 </para>
915
916 <para>
917 Characters that might indicate line breaks are never treated
918 in any special way when matching character classes, whatever line-ending
919 sequence is in use, and whatever setting of the <varname>G_REGEX_DOTALL</varname>
920 and <varname>G_REGEX_MULTILINE</varname> options is used. A class such as [^a]
921 always matches one of these characters.
922 </para>
923
924 <para>
925 The minus (hyphen) character can be used to specify a range of characters in
926 a character class. For example, [d-m] matches any letter
927 between d and m, inclusive. If a minus character is required in a
928 class, it must be escaped with a backslash or appear in a position
929 where it cannot be interpreted as indicating a range, typically as the
930 first or last character in the class.
931 </para>
932
933 <para>
934 It is not possible to have the literal character "]" as the end character
935 of a range. A pattern such as [W-]46] is interpreted as a class of
936 two characters ("W" and "-") followed by a literal string "46]", so it
937 would match "W46]" or "-46]". However, if the "]" is escaped with a
938 backslash it is interpreted as the end of range, so [W-\]46] is interpreted
939 as a class containing a range followed by two other characters.
940 The octal or hexadecimal representation of "]" can also be used to end
941 a range.
942 </para>
943
944 <para>
945 Ranges operate in the collating sequence of character values. They can
946 also be used for characters specified numerically, for example
947 [\000-\037]. In UTF-8 mode, ranges can include characters whose values
948 are greater than 255, for example [\x{100}-\x{2ff}].
949 </para>
950
951 <para>
952 The character types \d, \D, \p, \P, \s, \S, \w, and \W may also appear
953 in a character class, and add the characters that they match to the
954 class. For example, [\dABCDEF] matches any hexadecimal digit. A
955 circumflex can conveniently be used with the upper case character types to
956 specify a more restricted set of characters than the matching lower
957 case type. For example, the class [^\W_] matches any letter or digit,
958 but not underscore.
959 </para>
960
961 <para>
962 The only metacharacters that are recognized in character classes are
963 backslash, hyphen (only where it can be interpreted as specifying a
964 range), circumflex (only at the start), opening square bracket (only
965 when it can be interpreted as introducing a POSIX class name - see the
966 next section), and the terminating closing square bracket. However,
967 escaping other non-alphanumeric characters does no harm.
968 </para>
969 </refsect1>
970
971 <refsect1>
972 <title>Posix character classes</title>
973 <para>
974 GRegex supports the POSIX notation for character classes. This uses names
975 enclosed by [: and :] within the enclosing square brackets. For example,
976 </para>
977
978 <programlisting>
979 [01[:alpha:]%]
980 </programlisting>
981
982 <para>
983 matches "0", "1", any alphabetic character, or "%". The supported class
984 names are
985 </para>
986
987 <table frame="all" colsep="1" rowsep="1">
988 <title>Posix classes</title>
989 <tgroup cols="2">
990 <colspec colnum="1" align="center"/>
991 <thead>
992   <row>
993     <entry>Name</entry>
994     <entry>Meaning</entry>
995   </row>
996 </thead>
997 <tbody>
998   <row>
999     <entry>alnum</entry>
1000     <entry>letters and digits</entry>
1001   </row>
1002   <row>
1003     <entry>alpha</entry>
1004     <entry>letters</entry>
1005   </row>
1006   <row>
1007     <entry>ascii</entry>
1008     <entry>character codes 0 - 127</entry>
1009   </row>
1010   <row>
1011     <entry>blank</entry>
1012     <entry>space or tab only</entry>
1013   </row>
1014   <row>
1015     <entry>cntrl</entry>
1016     <entry>control characters</entry>
1017   </row>
1018   <row>
1019     <entry>digit</entry>
1020     <entry>decimal digits (same as \d)</entry>
1021   </row>
1022   <row>
1023     <entry>graph</entry>
1024     <entry>printing characters, excluding space</entry>
1025   </row>
1026   <row>
1027     <entry>lower</entry>
1028     <entry>lower case letters</entry>
1029   </row>
1030   <row>
1031     <entry>print</entry>
1032     <entry>printing characters, including space</entry>
1033   </row>
1034   <row>
1035     <entry>punct</entry>
1036     <entry>printing characters, excluding letters and digits</entry>
1037   </row>
1038   <row>
1039     <entry>space</entry>
1040     <entry>white space (not quite the same as \s)</entry>
1041   </row>
1042   <row>
1043     <entry>upper</entry>
1044     <entry>upper case letters</entry>
1045   </row>
1046   <row>
1047     <entry>word</entry>
1048     <entry>"word" characters (same as \w)</entry>
1049   </row>
1050   <row>
1051     <entry>xdigit</entry>
1052     <entry>hexadecimal digits</entry>
1053   </row>
1054 </tbody>
1055 </tgroup>
1056 </table>
1057
1058 <para>
1059 The "space" characters are HT (9), LF (10), VT (11), FF (12), CR (13),
1060 and space (32). Notice that this list includes the VT character (code
1061 11). This makes "space" different to \s, which does not include VT (for
1062 Perl compatibility).
1063 </para>
1064
1065 <para>
1066 The name "word" is a Perl extension, and "blank" is a GNU extension.
1067 Another Perl extension is negation, which is indicated by a ^ character
1068 after the colon. For example,
1069 </para>
1070
1071 <programlisting>
1072 [12[:^digit:]]
1073 </programlisting>
1074
1075 <para>
1076 matches "1", "2", or any non-digit. GRegex also recognize the
1077 POSIX syntax [.ch.] and [=ch=] where "ch" is a "collating element", but
1078 these are not supported, and an error is given if they are encountered.
1079 </para>
1080
1081 <para>
1082 In UTF-8 mode, characters with values greater than 128 do not match any
1083 of the POSIX character classes.
1084 </para>
1085 </refsect1>
1086
1087 <refsect1>
1088 <title>Vertical bar</title>
1089 <para>
1090 Vertical bar characters are used to separate alternative patterns. For
1091 example, the pattern
1092 </para>
1093
1094 <programlisting>
1095  gilbert|sullivan
1096 </programlisting>
1097
1098 <para>
1099 matches either "gilbert" or "sullivan". Any number of alternatives may
1100 appear, and an empty alternative is permitted (matching the empty
1101 string). The matching process tries each alternative in turn, from
1102 left to right, and the first one that succeeds is used. If the alternatives are within a subpattern (defined below), "succeeds" means matching the rest of the main pattern as well as the alternative in the subpattern.
1103 </para>
1104 </refsect1>
1105
1106 <refsect1>
1107 <title>Internal option setting</title>
1108 <para>
1109 The settings of the <varname>G_REGEX_CASELESS</varname>, <varname>G_REGEX_MULTILINE</varname>, <varname>G_REGEX_MULTILINE</varname>,
1110 and <varname>G_REGEX_EXTENDED</varname> options can be changed from within the pattern by a
1111 sequence of Perl-style option letters enclosed between "(?" and ")". The
1112 option letters are
1113 </para>
1114
1115 <table frame="all" colsep="1" rowsep="1">
1116 <title>Option settings</title>
1117 <tgroup cols="2">
1118 <colspec colnum="1" align="center"/>
1119 <thead>
1120   <row>
1121     <entry>Option</entry>
1122     <entry>Flag</entry>
1123   </row>
1124 </thead>
1125 <tbody>
1126   <row>
1127     <entry>i</entry>
1128     <entry><varname>G_REGEX_CASELESS</varname></entry>
1129   </row>
1130   <row>
1131     <entry>m</entry>
1132     <entry><varname>G_REGEX_MULTILINE</varname></entry>
1133   </row>
1134   <row>
1135     <entry>s</entry>
1136     <entry><varname>G_REGEX_DOTALL</varname></entry>
1137   </row>
1138   <row>
1139     <entry>x</entry>
1140     <entry><varname>G_REGEX_EXTENDED</varname></entry>
1141   </row>
1142 </tbody>
1143 </tgroup>
1144 </table>
1145
1146 <para>
1147 For example, (?im) sets caseless, multiline matching. It is also
1148 possible to unset these options by preceding the letter with a hyphen, and a
1149 combined setting and unsetting such as (?im-sx), which sets <varname>G_REGEX_CASELESS</varname>
1150 and <varname>G_REGEX_MULTILINE</varname> while unsetting <varname>G_REGEX_DOTALL</varname> and <varname>G_REGEX_EXTENDED</varname>,
1151 is also permitted. If a letter appears both before and after the
1152 hyphen, the option is unset.
1153 </para>
1154
1155 <para>
1156 When an option change occurs at top level (that is, not inside subpattern
1157 parentheses), the change applies to the remainder of the pattern
1158 that follows.
1159 </para>
1160
1161 <para>
1162 An option change within a subpattern (see below for a description of subpatterns)
1163 affects only that part of the current pattern that follows it, so
1164 </para>
1165
1166 <programlisting>
1167 (a(?i)b)c
1168 </programlisting>
1169
1170 <para>
1171 matches abc and aBc and no other strings (assuming <varname>G_REGEX_CASELESS</varname> is not
1172 used). By this means, options can be made to have different settings
1173 in different parts of the pattern. Any changes made in one alternative
1174 do carry on into subsequent branches within the same subpattern. For
1175 example,
1176 </para>
1177
1178 <programlisting>
1179 (a(?i)b|c)
1180 </programlisting>
1181
1182 <para>
1183 matches "ab", "aB", "c", and "C", even though when matching "C" the
1184 first branch is abandoned before the option setting. This is because
1185 the effects of option settings happen at compile time. There would be
1186 some very weird behaviour otherwise.
1187 </para>
1188
1189 <para>
1190 The options <varname>G_REGEX_UNGREEDY</varname> and
1191 <varname>G_REGEX_EXTRA</varname> and <varname>G_REGEX_DUPNAMES</varname>
1192 can be changed in the same way as the Perl-compatible options by using
1193 the characters U, X and J respectively.
1194 </para>
1195 </refsect1>
1196
1197 <refsect1>
1198 <title>Subpatterns</title>
1199 <para>
1200 Subpatterns are delimited by parentheses (round brackets), which can be
1201 nested. Turning part of a pattern into a subpattern does two things:
1202 </para>
1203
1204 <itemizedlist>
1205 <listitem><para>
1206 It localizes a set of alternatives. For example, the pattern
1207 cat(aract|erpillar|) matches one of the words "cat", "cataract", or
1208 "caterpillar". Without the parentheses, it would match "cataract",
1209 "erpillar" or an empty string.
1210 </para></listitem>
1211 <listitem><para>
1212 It sets up the subpattern as a capturing subpattern. This means
1213 that, when the whole pattern matches, that portion of the
1214 string that matched the subpattern can be obtained using <function>g_match_info_fetch()</function>.
1215 Opening parentheses are counted from left to right (starting from 1, as
1216 subpattern 0 is the whole matched string) to obtain numbers for the
1217 capturing subpatterns.
1218 </para></listitem>
1219 </itemizedlist>
1220
1221 <para>
1222 For example, if the string "the red king" is matched against the pattern
1223 </para>
1224
1225 <programlisting>
1226 the ((red|white) (king|queen))
1227 </programlisting>
1228
1229 <para>
1230 the captured substrings are "red king", "red", and "king", and are numbered 1, 2, and 3, respectively.
1231 </para>
1232
1233 <para>
1234 The fact that plain parentheses fulfil two functions is not always
1235 helpful. There are often times when a grouping subpattern is required
1236 without a capturing requirement. If an opening parenthesis is followed
1237 by a question mark and a colon, the subpattern does not do any capturing,
1238 and is not counted when computing the number of any subsequent
1239 capturing subpatterns. For example, if the string "the white queen" is
1240 matched against the pattern
1241 </para>
1242
1243 <programlisting>
1244 the ((?:red|white) (king|queen))
1245 </programlisting>
1246
1247 <para>
1248 the captured substrings are "white queen" and "queen", and are numbered
1249 1 and 2. The maximum number of capturing subpatterns is 65535.
1250 </para>
1251
1252 <para>
1253 As a convenient shorthand, if any option settings are required at the
1254 start of a non-capturing subpattern, the option letters may appear
1255 between the "?" and the ":". Thus the two patterns
1256 </para>
1257
1258 <programlisting>
1259 (?i:saturday|sunday)
1260 (?:(?i)saturday|sunday)
1261 </programlisting>
1262
1263 <para>
1264 match exactly the same set of strings. Because alternative branches are
1265 tried from left to right, and options are not reset until the end of
1266 the subpattern is reached, an option setting in one branch does affect
1267 subsequent branches, so the above patterns match "SUNDAY" as well as
1268 "Saturday".
1269 </para>
1270 </refsect1>
1271
1272 <refsect1>
1273 <title>Named subpatterns</title>
1274 <para>
1275 Identifying capturing parentheses by number is simple, but it can be
1276 very hard to keep track of the numbers in complicated regular expressions.
1277 Furthermore, if an expression is modified, the numbers may
1278 change. To help with this difficulty, GRegex supports the naming of
1279 subpatterns.  A subpattern can be named in one of three ways: (?&lt;name&gt;...) or
1280 (?'name'...) as in Perl, or (?P&lt;name&gt;...) as in Python.
1281 References to capturing parentheses from other
1282 parts of the pattern, such as backreferences, recursion, and conditions,
1283 can be made by name as well as by number.
1284 </para>
1285
1286 <para>
1287 Names consist of up to 32 alphanumeric characters and underscores. Named
1288 capturing parentheses are still allocated numbers as well as names, exactly as
1289 if the names were not present.
1290 By default, a name must be unique within a pattern, but it is possible to relax
1291 this constraint by setting the <varname>G_REGEX_DUPNAMES</varname> option at
1292 compile time. This can be useful for patterns where only one instance of the
1293 named parentheses can match. Suppose you want to match the name of a weekday,
1294 either as a 3-letter abbreviation or as the full name, and in both cases you
1295 want to extract the abbreviation. This pattern (ignoring the line breaks) does
1296 the job:
1297 </para>
1298
1299 <programlisting>
1300 (?&lt;DN&gt;Mon|Fri|Sun)(?:day)?|
1301 (?&lt;DN&gt;Tue)(?:sday)?|
1302 (?&lt;DN&gt;Wed)(?:nesday)?|
1303 (?&lt;DN&gt;Thu)(?:rsday)?|
1304 (?&lt;DN&gt;Sat)(?:urday)?
1305 </programlisting>
1306
1307 <para>
1308 There are five capturing substrings, but only one is ever set after a match.
1309 The function for extracting the data by name returns the substring
1310 for the first (and in this example, the only) subpattern of that name that
1311 matched. This saves searching to find which numbered subpattern it was. If you
1312 make a reference to a non-unique named subpattern from elsewhere in the
1313 pattern, the one that corresponds to the lowest number is used.
1314 </para>
1315 </refsect1>
1316
1317 <refsect1>
1318 <title>Repetition</title>
1319 <para>
1320 Repetition is specified by quantifiers, which can follow any of the
1321 following items:
1322 </para>
1323
1324 <itemizedlist>
1325 <listitem><para>a literal data character</para></listitem>
1326 <listitem><para>the dot metacharacter</para></listitem>
1327 <listitem><para>the \C escape sequence</para></listitem>
1328 <listitem><para>the \X escape sequence (in UTF-8 mode)</para></listitem>
1329 <listitem><para>the \R escape sequence</para></listitem>
1330 <listitem><para>an escape such as \d that matches a single character</para></listitem>
1331 <listitem><para>a character class</para></listitem>
1332 <listitem><para>a back reference (see next section)</para></listitem>
1333 <listitem><para>a parenthesized subpattern (unless it is an assertion)</para></listitem>
1334 </itemizedlist>
1335
1336 <para>
1337 The general repetition quantifier specifies a minimum and maximum number
1338 of permitted matches, by giving the two numbers in curly brackets
1339 (braces), separated by a comma. The numbers must be less than 65536,
1340 and the first must be less than or equal to the second. For example:
1341 </para>
1342
1343 <programlisting>
1344 z{2,4}
1345 </programlisting>
1346
1347 <para>
1348 matches "zz", "zzz", or "zzzz". A closing brace on its own is not a
1349 special character. If the second number is omitted, but the comma is
1350 present, there is no upper limit; if the second number and the comma
1351 are both omitted, the quantifier specifies an exact number of required
1352 matches. Thus
1353 </para>
1354
1355 <programlisting>
1356 [aeiou]{3,}
1357 </programlisting>
1358
1359 <para>
1360 matches at least 3 successive vowels, but may match many more, while
1361 </para>
1362
1363 <programlisting>
1364 \d{8}
1365 </programlisting>
1366
1367 <para>
1368 matches exactly 8 digits. An opening curly bracket that appears in a
1369 position where a quantifier is not allowed, or one that does not match
1370 the syntax of a quantifier, is taken as a literal character. For example,
1371 {,6} is not a quantifier, but a literal string of four characters.
1372 </para>
1373
1374 <para>
1375 In UTF-8 mode, quantifiers apply to UTF-8 characters rather than to
1376 individual bytes. Thus, for example, \x{100}{2} matches two UTF-8
1377 characters, each of which is represented by a two-byte sequence. Similarly,
1378 \X{3} matches three Unicode extended sequences, each of which may be
1379 several bytes long (and they may be of different lengths).
1380 </para>
1381
1382 <para>
1383 The quantifier {0} is permitted, causing the expression to behave as if
1384 the previous item and the quantifier were not present.
1385 </para>
1386
1387 <para>
1388 For convenience, the three most common quantifiers have single-character
1389 abbreviations:
1390 </para>
1391
1392 <table frame="all" colsep="1" rowsep="1">
1393 <title>Abbreviations for quantifiers</title>
1394 <tgroup cols="2">
1395 <colspec colnum="1" align="center"/>
1396 <thead>
1397   <row>
1398     <entry>Abbreviation</entry>
1399     <entry>Meaning</entry>
1400   </row>
1401 </thead>
1402 <tbody>
1403   <row>
1404     <entry>*</entry>
1405     <entry>is equivalent to {0,}</entry>
1406   </row>
1407   <row>
1408     <entry>+</entry>
1409     <entry>is equivalent to {1,}</entry>
1410   </row>
1411   <row>
1412     <entry>?</entry>
1413     <entry>is equivalent to {0,1}</entry>
1414   </row>
1415 </tbody>
1416 </tgroup>
1417 </table>
1418
1419 <para>
1420 It is possible to construct infinite loops by following a subpattern
1421 that can match no characters with a quantifier that has no upper limit,
1422 for example:
1423 </para>
1424
1425 <programlisting>
1426 (a?)*
1427 </programlisting>
1428
1429 <para>
1430 Because there are cases where this can be useful, such patterns are
1431 accepted, but if any repetition of the subpattern does in fact match
1432 no characters, the loop is forcibly broken.
1433 </para>
1434
1435 <para>
1436 By default, the quantifiers are "greedy", that is, they match as much
1437 as possible (up to the maximum number of permitted times), without
1438 causing the rest of the pattern to fail. The classic example of where
1439 this gives problems is in trying to match comments in C programs. These
1440 appear between /* and */ and within the comment, individual * and /
1441 characters may appear. An attempt to match C comments by applying the
1442 pattern
1443 </para>
1444
1445 <programlisting>
1446 /\*.*\*/
1447 </programlisting>
1448
1449 <para>
1450 to the string
1451 </para>
1452
1453 <programlisting>
1454 /* first comment */  not comment  /* second comment */
1455 </programlisting>
1456
1457 <para>
1458 fails, because it matches the entire string owing to the greediness of
1459 the .* item.
1460 </para>
1461
1462 <para>
1463 However, if a quantifier is followed by a question mark, it ceases to
1464 be greedy, and instead matches the minimum number of times possible, so
1465 the pattern
1466 </para>
1467
1468 <programlisting>
1469 /\*.*?\*/
1470 </programlisting>
1471
1472 <para>
1473 does the right thing with the C comments. The meaning of the various
1474 quantifiers is not otherwise changed, just the preferred number of
1475 matches. Do not confuse this use of question mark with its use as a
1476 quantifier in its own right. Because it has two uses, it can sometimes
1477 appear doubled, as in
1478 </para>
1479
1480 <programlisting>
1481 \d??\d
1482 </programlisting>
1483
1484 <para>
1485 which matches one digit by preference, but can match two if that is the
1486 only way the rest of the pattern matches.
1487 </para>
1488
1489 <para>
1490 If the <varname>G_REGEX_UNGREEDY</varname> flag is set, the quantifiers are not greedy
1491 by default, but individual ones can be made greedy by following them with
1492 a question mark. In other words, it inverts the default behaviour.
1493 </para>
1494
1495 <para>
1496 When a parenthesized subpattern is quantified with a minimum repeat
1497 count that is greater than 1 or with a limited maximum, more memory is
1498 required for the compiled pattern, in proportion to the size of the
1499 minimum or maximum.
1500 </para>
1501
1502 <para>
1503 If a pattern starts with .* or .{0,} and the <varname>G_REGEX_DOTALL</varname> flag
1504 is set, thus allowing the dot to match newlines, the
1505 pattern is implicitly anchored, because whatever follows will be tried
1506 against every character position in the string, so there is no
1507 point in retrying the overall match at any position after the first.
1508 GRegex normally treats such a pattern as though it were preceded by \A.
1509 </para>
1510
1511 <para>
1512 In cases where it is known that the string contains no newlines, it
1513 is worth setting <varname>G_REGEX_DOTALL</varname> in order to obtain this optimization,
1514 or alternatively using ^ to indicate anchoring explicitly.
1515 </para>
1516
1517 <para>
1518 However, there is one situation where the optimization cannot be used.
1519 When .* is inside capturing parentheses that are the subject of a
1520 backreference elsewhere in the pattern, a match at the start may fail
1521 where a later one succeeds. Consider, for example:
1522 </para>
1523
1524 <programlisting>
1525 (.*)abc\1
1526 </programlisting>
1527
1528 <para>
1529 If the string is "xyz123abc123" the match point is the fourth character.
1530 For this reason, such a pattern is not implicitly anchored.
1531 </para>
1532
1533 <para>
1534 When a capturing subpattern is repeated, the value captured is the
1535 substring that matched the final iteration. For example, after
1536 </para>
1537
1538 <programlisting>
1539 (tweedle[dume]{3}\s*)+
1540 </programlisting>
1541
1542 <para>
1543 has matched "tweedledum tweedledee" the value of the captured substring
1544 is "tweedledee". However, if there are nested capturing subpatterns,
1545 the corresponding captured values may have been set in previous iterations.
1546 For example, after
1547 </para>
1548
1549 <programlisting>
1550 /(a|(b))+/
1551 </programlisting>
1552
1553 <para>
1554 matches "aba" the value of the second captured substring is "b".
1555 </para>
1556 </refsect1>
1557
1558 <refsect1>
1559 <title>Atomic grouping and possessive quantifiers</title>
1560 <para>
1561 With both maximizing ("greedy") and minimizing ("ungreedy" or "lazy")
1562 repetition, failure of what follows normally causes the repeated
1563 item to be re-evaluated to see if a different number
1564 of repeats allows the rest of the pattern to match. Sometimes it
1565 is useful to prevent this, either to change the nature of the
1566 match, or to cause it fail earlier than it otherwise might, when the
1567 author of the pattern knows there is no point in carrying on.
1568 </para>
1569
1570 <para>
1571 Consider, for example, the pattern \d+foo when applied to the string
1572 </para>
1573
1574 <programlisting>
1575 123456bar
1576 </programlisting>
1577
1578 <para>
1579 After matching all 6 digits and then failing to match "foo", the normal
1580 action of the matcher is to try again with only 5 digits matching the
1581 \d+ item, and then with 4, and so on, before ultimately failing.
1582 "Atomic grouping" (a term taken from Jeffrey Friedl’s book) provides
1583 the means for specifying that once a subpattern has matched, it is not
1584 to be re-evaluated in this way.
1585 </para>
1586
1587 <para>
1588 If we use atomic grouping for the previous example, the matcher
1589 give up immediately on failing to match "foo" the first time. The notation
1590 is a kind of special parenthesis, starting with (?&gt; as in this
1591 example:
1592 </para>
1593
1594 <programlisting>
1595 (?>\d+)foo
1596 </programlisting>
1597
1598 <para>
1599 This kind of parenthesis "locks up" the part of the pattern it contains
1600 once it has matched, and a failure further into the pattern is
1601 prevented from backtracking into it. Backtracking past it to previous
1602 items, however, works as normal.
1603 </para>
1604
1605 <para>
1606 An alternative description is that a subpattern of this type matches
1607 the string of characters that an identical standalone pattern would
1608 match, if anchored at the current point in the string.
1609 </para>
1610
1611 <para>
1612 Atomic grouping subpatterns are not capturing subpatterns. Simple cases
1613 such as the above example can be thought of as a maximizing repeat that
1614 must swallow everything it can. So, while both \d+ and \d+? are prepared
1615 to adjust the number of digits they match in order to make the
1616 rest of the pattern match, (?>\d+) can only match an entire sequence of
1617 digits.
1618 </para>
1619
1620 <para>
1621 Atomic groups in general can of course contain arbitrarily complicated
1622 subpatterns, and can be nested. However, when the subpattern for an
1623 atomic group is just a single repeated item, as in the example above, a
1624 simpler notation, called a "possessive quantifier" can be used. This
1625 consists of an additional + character following a quantifier. Using
1626 this notation, the previous example can be rewritten as
1627 </para>
1628
1629 <programlisting>
1630 \d++foo
1631 </programlisting>
1632
1633 <para>
1634 Possessive quantifiers are always greedy; the setting of the
1635 <varname>G_REGEX_UNGREEDY</varname> option is ignored. They are a convenient notation for the
1636 simpler forms of atomic group. However, there is no difference in the
1637 meaning of a possessive quantifier and the equivalent
1638 atomic group, though there may be a performance difference;
1639 possessive quantifiers should be slightly faster.
1640 </para>
1641
1642 <para>
1643 The possessive quantifier syntax is an extension to the Perl syntax.
1644 It was invented by Jeffrey Friedl in the first edition of his book and
1645 then implemented by Mike McCloskey in Sun's Java package.
1646 It ultimately found its way into Perl at release 5.10.
1647 </para>
1648
1649 <para>
1650 GRegex has an optimization that automatically "possessifies" certain simple
1651 pattern constructs. For example, the sequence A+B is treated as A++B because
1652 there is no point in backtracking into a sequence of A's when B must follow.
1653 </para>
1654
1655 <para>
1656 When a pattern contains an unlimited repeat inside a subpattern that
1657 can itself be repeated an unlimited number of times, the use of an
1658 atomic group is the only way to avoid some failing matches taking a
1659 very long time indeed. The pattern
1660 </para>
1661  
1662 <programlisting>
1663 (\D+|&lt;\d+&gt;)*[!?]
1664 </programlisting>
1665
1666 <para>
1667 matches an unlimited number of substrings that either consist of non-
1668 digits, or digits enclosed in &lt;&gt;, followed by either ! or ?. When it
1669 matches, it runs quickly. However, if it is applied to
1670 </para>
1671
1672 <programlisting>
1673 aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
1674 </programlisting>
1675
1676 <para>
1677 it takes a long time before reporting failure. This is because the
1678 string can be divided between the internal \D+ repeat and the external
1679 * repeat in a large number of ways, and all have to be tried. (The
1680 example uses [!?] rather than a single character at the end, because
1681 GRegex has an optimization that allows for fast failure
1682 when a single character is used. It remember the last single character
1683 that is required for a match, and fail early if it is not present
1684 in the string.) If the pattern is changed so that it uses an atomic
1685 group, like this:
1686 </para>
1687
1688 <programlisting>
1689 ((?>\D+)|&lt;\d+&gt;)*[!?]
1690 </programlisting>
1691
1692 <para>
1693 sequences of non-digits cannot be broken, and failure happens quickly.
1694 </para>
1695 </refsect1>
1696
1697 <refsect1>
1698 <title>Back references</title>
1699 <para>
1700 Outside a character class, a backslash followed by a digit greater than
1701 0 (and possibly further digits) is a back reference to a capturing subpattern
1702 earlier (that is, to its left) in the pattern, provided there have been that
1703 many previous capturing left parentheses.
1704 </para>
1705
1706 <para>
1707 However, if the decimal number following the backslash is less than 10,
1708 it is always taken as a back reference, and causes an error only if
1709 there are not that many capturing left parentheses in the entire pattern.
1710 In other words, the parentheses that are referenced need not be
1711 to the left of the reference for numbers less than 10. A "forward back
1712 reference" of this type can make sense when a repetition is involved and
1713 the subpattern to the right has participated in an earlier iteration.
1714 </para>
1715
1716 <para>
1717 It is not possible to have a numerical "forward back reference" to subpattern
1718 whose number is 10 or more using this syntax because a sequence such as \e50 is
1719 interpreted as a character defined in octal. See the subsection entitled
1720 "Non-printing characters" above for further details of the handling of digits
1721 following a backslash. There is no such problem when named parentheses are used.
1722 A back reference to any subpattern is possible using named parentheses (see below).
1723 </para>
1724
1725 <para>
1726 Another way of avoiding the ambiguity inherent in the use of digits following a
1727 backslash is to use the \g escape sequence (introduced in Perl 5.10.)
1728 This escape must be followed by a positive or a negative number,
1729 optionally enclosed in braces.
1730 </para>
1731
1732 <para>
1733 A positive number specifies an absolute reference without the ambiguity that is
1734 present in the older syntax. It is also useful when literal digits follow the
1735 reference. A negative number is a relative reference. Consider "(abc(def)ghi)\g{-1}",
1736 the sequence \g{-1} is a reference to the most recently started capturing
1737 subpattern before \g, that is, is it equivalent to \2. Similarly, \g{-2}
1738 would be equivalent to \1. The use of relative references can be helpful in
1739 long patterns, and also in patterns that are created by joining together
1740 fragments that contain references within themselves.
1741 </para>
1742
1743 <para>
1744 A back reference matches whatever actually matched the capturing subpattern
1745 in the current string, rather than anything matching
1746 the subpattern itself (see "Subpatterns as subroutines" below for a way
1747 of doing that). So the pattern
1748 </para>
1749
1750 <programlisting>
1751 (sens|respons)e and \1ibility
1752 </programlisting>
1753
1754 <para>
1755 matches "sense and sensibility" and "response and responsibility", but
1756 not "sense and responsibility". If caseful matching is in force at the
1757 time of the back reference, the case of letters is relevant. For example,
1758 </para>
1759
1760 <programlisting>
1761 ((?i)rah)\s+\1
1762 </programlisting>
1763
1764 <para>
1765 matches "rah rah" and "RAH RAH", but not "RAH rah", even though the
1766 original capturing subpattern is matched caselessly.
1767 </para>
1768
1769 <para>
1770 Back references to named subpatterns use the Perl syntax \k&lt;name&gt; or \k'name'
1771 or the Python syntax (?P=name). We could rewrite the above example in either of
1772 the following ways:
1773 </para>
1774
1775 <programlisting>
1776 (?&lt;p1&gt;(?i)rah)\s+\k&lt;p1&gt;
1777 (?P&lt;p1&gt;(?i)rah)\s+(?P=p1)
1778 </programlisting>
1779
1780 <para>
1781 A subpattern that is referenced by name may appear in the pattern before or
1782 after the reference.
1783 </para>
1784
1785 <para>
1786 There may be more than one back reference to the same subpattern. If a
1787 subpattern has not actually been used in a particular match, any back
1788 references to it always fail. For example, the pattern
1789 </para>
1790
1791 <programlisting>
1792 (a|(bc))\2
1793 </programlisting>
1794
1795 <para>
1796 always fails if it starts to match "a" rather than "bc". Because there
1797 may be many capturing parentheses in a pattern, all digits following
1798 the backslash are taken as part of a potential back reference number.
1799 If the pattern continues with a digit character, some delimiter must be
1800 used to terminate the back reference. If the <varname>G_REGEX_EXTENDED</varname> flag is
1801 set, this can be whitespace. Otherwise an empty comment (see "Comments" below) can be used.
1802 </para>
1803
1804 <para>
1805 A back reference that occurs inside the parentheses to which it refers
1806 fails when the subpattern is first used, so, for example, (a\1) never
1807 matches. However, such references can be useful inside repeated subpatterns.
1808 For example, the pattern
1809 </para>
1810
1811 <programlisting>
1812 (a|b\1)+
1813 </programlisting>
1814
1815 <para>
1816 matches any number of "a"s and also "aba", "ababbaa" etc. At each iteration
1817 of the subpattern, the back reference matches the character
1818 string corresponding to the previous iteration. In order for this to
1819 work, the pattern must be such that the first iteration does not need
1820 to match the back reference. This can be done using alternation, as in
1821 the example above, or by a quantifier with a minimum of zero.
1822 </para>
1823 </refsect1>
1824
1825 <refsect1>
1826 <title>Assertions</title>
1827 <para>
1828 An assertion is a test on the characters following or preceding the
1829 current matching point that does not actually consume any characters.
1830 The simple assertions coded as \b, \B, \A, \G, \Z, \z, ^ and $ are
1831 described above.
1832 </para>
1833
1834 <para>
1835 More complicated assertions are coded as subpatterns. There are two
1836 kinds: those that look ahead of the current position in the
1837 string, and those that look behind it. An assertion subpattern is
1838 matched in the normal way, except that it does not cause the current
1839 matching position to be changed.
1840 </para>
1841
1842 <para>
1843 Assertion subpatterns are not capturing subpatterns, and may not be
1844 repeated, because it makes no sense to assert the same thing several
1845 times. If any kind of assertion contains capturing subpatterns within
1846 it, these are counted for the purposes of numbering the capturing
1847 subpatterns in the whole pattern. However, substring capturing is carried
1848 out only for positive assertions, because it does not make sense for
1849 negative assertions.
1850 </para>
1851
1852 <refsect2>
1853 <title>Lookahead assertions</title>
1854 <para>
1855 Lookahead assertions start with (?= for positive assertions and (?! for
1856 negative assertions. For example,
1857 </para>
1858
1859 <programlisting>
1860 \w+(?=;)
1861 </programlisting>
1862
1863 <para>
1864 matches a word followed by a semicolon, but does not include the semicolon
1865 in the match, and
1866 </para>
1867
1868 <programlisting>
1869 foo(?!bar)
1870 </programlisting>
1871
1872 <para>
1873 matches any occurrence of "foo" that is not followed by "bar". Note
1874 that the apparently similar pattern
1875 </para>
1876
1877 <programlisting>
1878 (?!foo)bar
1879 </programlisting>
1880
1881 <para>
1882 does not find an occurrence of "bar" that is preceded by something
1883 other than "foo"; it finds any occurrence of "bar" whatsoever, because
1884 the assertion (?!foo) is always true when the next three characters are
1885 "bar". A lookbehind assertion is needed to achieve the other effect.
1886 </para>
1887
1888 <para>
1889 If you want to force a matching failure at some point in a pattern, the
1890 most convenient way to do it is with (?!) because an empty string
1891 always matches, so an assertion that requires there not to be an empty
1892 string must always fail.
1893 </para>
1894 </refsect2>
1895
1896 <refsect2>
1897 <title>Lookbehind assertions</title>
1898 <para>
1899 Lookbehind assertions start with (?&lt;= for positive assertions and (?&lt;!
1900 for negative assertions. For example,
1901 </para>
1902
1903 <programlisting>
1904 (?&lt;!foo)bar
1905 </programlisting>
1906
1907 <para>
1908 does find an occurrence of "bar" that is not preceded by "foo". The
1909 contents of a lookbehind assertion are restricted such that all the
1910 strings it matches must have a fixed length. However, if there are
1911 several top-level alternatives, they do not all have to have the same
1912 fixed length. Thus
1913 </para>
1914
1915 <programlisting>
1916 (?&lt;=bullock|donkey)
1917 </programlisting>
1918
1919 <para>
1920 is permitted, but
1921 </para>
1922
1923 <programlisting>
1924 (?&lt;!dogs?|cats?)
1925 </programlisting>
1926
1927 <para>
1928 causes an error at compile time. Branches that match different length
1929 strings are permitted only at the top level of a lookbehind assertion.
1930 An assertion such as
1931 </para>
1932
1933 <programlisting>
1934 (?&lt;=ab(c|de))
1935 </programlisting>
1936
1937 <para>
1938 is not permitted, because its single top-level branch can match two
1939 different lengths, but it is acceptable if rewritten to use two top-
1940 level branches:
1941 </para>
1942
1943 <programlisting>
1944 (?&lt;=abc|abde)
1945 </programlisting>
1946
1947 <para>
1948 The implementation of lookbehind assertions is, for each alternative,
1949 to temporarily move the current position back by the fixed length and
1950 then try to match. If there are insufficient characters before the
1951 current position, the assertion fails.
1952 </para>
1953
1954 <para>
1955 GRegex does not allow the \C escape (which matches a single byte in UTF-8
1956 mode) to appear in lookbehind assertions, because it makes it impossible
1957 to calculate the length of the lookbehind. The \X and \R escapes, which can
1958 match different numbers of bytes, are also not permitted.
1959 </para>
1960
1961 <para>
1962 Possessive quantifiers can be used in conjunction with lookbehind assertions to
1963 specify efficient matching at the end of the subject string. Consider a simple
1964 pattern such as
1965 </para>
1966
1967 <programlisting>
1968 abcd$
1969 </programlisting>
1970
1971 <para>
1972 when applied to a long string that does not match. Because matching
1973 proceeds from left to right, GRegex will look for each "a" in the string
1974 and then see if what follows matches the rest of the pattern. If the
1975 pattern is specified as
1976 </para>
1977
1978 <programlisting>
1979 ^.*abcd$
1980 </programlisting>
1981
1982 <para>
1983 the initial .* matches the entire string at first, but when this fails
1984 (because there is no following "a"), it backtracks to match all but the
1985 last character, then all but the last two characters, and so on. Once
1986 again the search for "a" covers the entire string, from right to left,
1987 so we are no better off. However, if the pattern is written as
1988 </para>
1989
1990 <programlisting>
1991 ^.*+(?&lt;=abcd)
1992 </programlisting>
1993
1994 <para>
1995 there can be no backtracking for the .*+ item; it can match only the
1996 entire string. The subsequent lookbehind assertion does a single test
1997 on the last four characters. If it fails, the match fails immediately.
1998 For long strings, this approach makes a significant difference to the
1999 processing time.
2000 </para>
2001 </refsect2>
2002
2003 <refsect2>
2004 <title>Using multiple assertions</title>
2005 <para>
2006 Several assertions (of any sort) may occur in succession. For example,
2007 </para>
2008
2009 <programlisting>
2010 (?&lt;=\d{3})(?&lt;!999)foo
2011 </programlisting>
2012
2013 <para>
2014 matches "foo" preceded by three digits that are not "999". Notice that
2015 each of the assertions is applied independently at the same point in
2016 the string. First there is a check that the previous three
2017 characters are all digits, and then there is a check that the same
2018 three characters are not "999". This pattern does not match "foo" preceded
2019 by six characters, the first of which are digits and the last
2020 three of which are not "999". For example, it doesn’t match "123abcfoo".
2021 A pattern to do that is
2022 </para>
2023
2024 <programlisting>
2025 (?&lt;=\d{3}...)(?&lt;!999)foo
2026 </programlisting>
2027
2028 <para>
2029 This time the first assertion looks at the preceding six characters,
2030 checking that the first three are digits, and then the second assertion
2031 checks that the preceding three characters are not "999".
2032 </para>
2033
2034 <para>
2035 Assertions can be nested in any combination. For example,
2036 </para>
2037
2038 <programlisting>
2039 (?&lt;=(?&lt;!foo)bar)baz
2040 </programlisting>
2041
2042 <para>
2043 matches an occurrence of "baz" that is preceded by "bar" which in turn
2044 is not preceded by "foo", while
2045 </para>
2046
2047 <programlisting>
2048 (?&lt;=\d{3}(?!999)...)foo
2049 </programlisting>
2050
2051 <para>
2052 is another pattern that matches "foo" preceded by three digits and any
2053 three characters that are not "999".
2054 </para>
2055 </refsect2>
2056 </refsect1>
2057
2058 <refsect1>
2059 <title>Conditional subpatterns</title>
2060 <para>
2061 It is possible to cause the matching process to obey a subpattern
2062 conditionally or to choose between two alternative subpatterns, depending
2063 on the result of an assertion, or whether a previous capturing subpattern
2064 matched or not. The two possible forms of conditional subpattern are
2065 </para>
2066
2067 <programlisting>
2068 (?(condition)yes-pattern)
2069 (?(condition)yes-pattern|no-pattern)
2070 </programlisting>
2071
2072 <para>
2073 If the condition is satisfied, the yes-pattern is used; otherwise the
2074 no-pattern (if present) is used. If there are more than two alternatives
2075 in the subpattern, a compile-time error occurs.
2076 </para>
2077
2078 <para>
2079 There are four kinds of condition: references to subpatterns, references to
2080 recursion, a pseudo-condition called DEFINE, and assertions.
2081 </para>
2082
2083 <refsect2>
2084 <title>Checking for a used subpattern by number</title>
2085 <para>
2086 If the text between the parentheses consists of a sequence of digits, the
2087 condition is true if the capturing subpattern of that number has previously
2088 matched.
2089 </para>
2090
2091 <para>
2092 Consider the following pattern, which contains non-significant white space
2093 to make it more readable (assume the <varname>G_REGEX_EXTENDED</varname>)
2094 and to divide it into three parts for ease of discussion:
2095 </para>
2096
2097 <programlisting>
2098 ( \( )?    [^()]+    (?(1) \) )
2099 </programlisting>
2100
2101 <para>
2102 The first part matches an optional opening parenthesis, and if that
2103 character is present, sets it as the first captured substring. The second
2104 part matches one or more characters that are not parentheses. The
2105 third part is a conditional subpattern that tests whether the first set
2106 of parentheses matched or not. If they did, that is, if string started
2107 with an opening parenthesis, the condition is true, and so the yes-pattern
2108 is executed and a closing parenthesis is required. Otherwise,
2109 since no-pattern is not present, the subpattern matches nothing. In
2110 other words, this pattern matches a sequence of non-parentheses,
2111 optionally enclosed in parentheses.
2112 </para>
2113 </refsect2>
2114
2115 <refsect2>
2116 <title>Checking for a used subpattern by name</title>
2117 <para>
2118 Perl uses the syntax (?(&lt;name&gt;)...) or (?('name')...) to test for a used
2119 subpattern by name, the Python syntax (?(name)...) is also recognized. However,
2120 there is a possible ambiguity with this syntax, because subpattern names may
2121 consist entirely of digits. GRegex looks first for a named subpattern; if it
2122 cannot find one and the name consists entirely of digits, GRegex looks for a
2123 subpattern of that number, which must be greater than zero. Using subpattern
2124 names that consist entirely of digits is not recommended.
2125 </para>
2126
2127 <para>
2128 Rewriting the above example to use a named subpattern gives this:
2129 </para>
2130
2131 <programlisting>
2132 (?&lt;OPEN&gt; \( )?    [^()]+    (?(&lt;OPEN&gt;) \) )
2133 </programlisting>
2134 </refsect2>
2135
2136 <refsect2>
2137 <title>Checking for pattern recursion</title>
2138 <para>
2139 If the condition is the string (R), and there is no subpattern with the name R,
2140 the condition is true if a recursive call to the whole pattern or any
2141 subpattern has been made. If digits or a name preceded by ampersand follow the
2142 letter R, for example:
2143 </para>
2144
2145 <programlisting>
2146 (?(R3)...)
2147 (?(R&amp;name)...)
2148 </programlisting>
2149
2150 <para>
2151 the condition is true if the most recent recursion is into the subpattern whose
2152 number or name is given. This condition does not check the entire recursion
2153 stack.
2154 </para>
2155
2156 <para>
2157 At "top level", all these recursion test conditions are false. Recursive
2158 patterns are described below.
2159 </para>
2160 </refsect2>
2161
2162 <refsect2>
2163 <title>Defining subpatterns for use by reference only</title>
2164 <para>
2165 If the condition is the string (DEFINE), and there is no subpattern with the
2166 name DEFINE, the condition is always false. In this case, there may be only one
2167 alternative in the subpattern. It is always skipped if control reaches this
2168 point in the pattern; the idea of DEFINE is that it can be used to define
2169 "subroutines" that can be referenced from elsewhere. (The use of "subroutines"
2170 is described below.) For example, a pattern to match an IPv4 address could be
2171 written like this (ignore whitespace and line breaks):
2172 </para>
2173
2174 <programlisting>
2175 (?(DEFINE) (?&lt;byte&gt; 2[0-4]\d | 25[0-5] | 1\d\d | [1-9]?\d) )
2176 \b (?&amp;byte) (\.(?&amp;byte)){3} \b
2177 </programlisting>
2178
2179 <para>
2180 The first part of the pattern is a DEFINE group inside which a another group
2181 named "byte" is defined. This matches an individual component of an IPv4
2182 address (a number less than 256). When matching takes place, this part of the
2183 pattern is skipped because DEFINE acts like a false condition.
2184 </para>
2185
2186 <para>
2187 The rest of the pattern uses references to the named group to match the four
2188 dot-separated components of an IPv4 address, insisting on a word boundary at
2189 each end.
2190 </para>
2191 </refsect2>
2192
2193 <refsect2>
2194 <title>Assertion conditions</title>
2195 <para>
2196 If the condition is not in any of the above formats, it must be an
2197 assertion. This may be a positive or negative lookahead or lookbehind
2198 assertion. Consider this pattern, again containing non-significant
2199 white space, and with the two alternatives on the second line:
2200 </para>
2201
2202 <programlisting>
2203 (?(?=[^a-z]*[a-z])
2204 \d{2}-[a-z]{3}-\d{2}  |  \d{2}-\d{2}-\d{2} )
2205 </programlisting>
2206
2207 <para>
2208 The condition is a positive lookahead assertion that matches an
2209 optional sequence of non-letters followed by a letter. In other words,
2210 it tests for the presence of at least one letter in the string. If a
2211 letter is found, the string is matched against the first alternative;
2212 otherwise it is matched against the second. This pattern matches
2213 strings in one of the two forms dd-aaa-dd or dd-dd-dd, where aaa are
2214 letters and dd are digits.
2215 </para>
2216 </refsect2>
2217 </refsect1>
2218
2219 <refsect1>
2220 <title>Comments</title>
2221 <para>
2222 The sequence (?# marks the start of a comment that continues up to the
2223 next closing parenthesis. Nested parentheses are not permitted. The
2224 characters that make up a comment play no part in the pattern matching
2225 at all.
2226 </para>
2227
2228 <para>
2229 If the <varname>G_REGEX_EXTENDED</varname> option is set, an unescaped #
2230 character outside a character class introduces a comment that continues to
2231 immediately after the next newline in the pattern.
2232 </para>
2233 </refsect1>
2234
2235 <refsect1>
2236 <title>Recursive patterns</title>
2237 <para>
2238 Consider the problem of matching a string in parentheses, allowing for
2239 unlimited nested parentheses. Without the use of recursion, the best
2240 that can be done is to use a pattern that matches up to some fixed
2241 depth of nesting. It is not possible to handle an arbitrary nesting
2242 depth.
2243 </para>
2244
2245 <para>
2246 For some time, Perl has provided a facility that allows regular expressions to
2247 recurse (amongst other things). It does this by interpolating Perl code in the
2248 expression at run time, and the code can refer to the expression itself. A Perl
2249 pattern using code interpolation to solve the parentheses problem can be
2250 created like this:
2251 </para>
2252
2253 <programlisting>
2254 $re = qr{\( (?: (?&gt;[^()]+) | (?p{$re}) )* \)}x;
2255 </programlisting>
2256
2257 <para>
2258 The (?p{...}) item interpolates Perl code at run time, and in this case refers
2259 recursively to the pattern in which it appears.
2260 </para>
2261
2262 <para>
2263 Obviously, GRegex cannot support the interpolation of Perl code. Instead, it
2264 supports special syntax for recursion of the entire pattern, and also for
2265 individual subpattern recursion. This kind of recursion was introduced into
2266 Perl at release 5.10.
2267 </para>
2268
2269 <para>
2270 A special item that consists of (? followed by a number greater than zero and a
2271 closing parenthesis is a recursive call of the subpattern of the given number,
2272 provided that it occurs inside that subpattern. (If not, it is a "subroutine"
2273 call, which is described in the next section.) The special item (?R) or (?0) is
2274 a recursive call of the entire regular expression.
2275 </para>
2276
2277 <para>
2278 In GRegex (like Python, but unlike Perl), a recursive subpattern call is always
2279 treated as an atomic group. That is, once it has matched some of the subject
2280 string, it is never re-entered, even if it contains untried alternatives and
2281 there is a subsequent matching failure.
2282 </para>
2283
2284 <para>
2285 This pattern solves the nested parentheses problem (assume the
2286 <varname>G_REGEX_EXTENDED</varname> option is set so that white space is
2287 ignored):
2288 </para>
2289
2290 <programlisting>
2291 \( ( (?&gt;[^()]+) | (?R) )* \)
2292 </programlisting>
2293
2294 <para>
2295 First it matches an opening parenthesis. Then it matches any number of
2296 substrings which can either be a sequence of non-parentheses, or a
2297 recursive match of the pattern itself (that is, a correctly parenthesized
2298 substring). Finally there is a closing parenthesis.
2299 </para>
2300
2301 <para>
2302 If this were part of a larger pattern, you would not want to recurse
2303 the entire pattern, so instead you could use this:
2304 </para>
2305
2306 <programlisting>
2307 ( \( ( (?&gt;[^()]+) | (?1) )* \) )
2308 </programlisting>
2309
2310 <para>
2311 We have put the pattern into parentheses, and caused the recursion to
2312 refer to them instead of the whole pattern. In a larger pattern, keeping
2313 track of parenthesis numbers can be tricky. It may be more convenient to
2314 use named parentheses instead.
2315 The Perl syntax for this is (?&amp;name); GRegex also supports the(?P>name)
2316 syntac. We could rewrite the above example as follows:
2317 </para>
2318
2319 <programlisting>
2320 (?&lt;pn&gt; \( ( (?&gt;[^()]+) | (?&amp;pn) )* \) )
2321 </programlisting>
2322
2323 <para>
2324 If there is more than one subpattern with the same name, the earliest one is
2325 used. This particular example pattern contains nested unlimited repeats, and so
2326 the use of atomic grouping for matching strings of non-parentheses is important
2327 when applying the pattern to strings that do not match.
2328 For example, when this pattern is applied to
2329 </para>
2330
2331 <programlisting>
2332 (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()
2333 </programlisting>
2334
2335 <para>
2336 it yields "no match" quickly. However, if atomic grouping is not used,
2337 the match runs for a very long time indeed because there are so many
2338 different ways the + and * repeats can carve up the string, and all
2339 have to be tested before failure can be reported.
2340 </para>
2341
2342 <para>
2343 At the end of a match, the values set for any capturing subpatterns are
2344 those from the outermost level of the recursion at which the subpattern
2345 value is set.
2346
2347 <!-- Callouts are not supported by GRegex
2348 If you want to obtain intermediate values, a callout
2349 function can be used (see below and the pcrecallout documentation). -->
2350
2351 If the pattern above is matched against
2352 </para>
2353
2354 <programlisting>
2355 (ab(cd)ef)
2356 </programlisting>
2357
2358 <para>
2359 the value for the capturing parentheses is "ef", which is the last
2360 value taken on at the top level. If additional parentheses are added,
2361 giving
2362 </para>
2363
2364 <programlisting>
2365 \( ( ( (?&gt;[^()]+) | (?R) )* ) \)
2366    ^                        ^
2367    ^                        ^
2368 </programlisting>
2369
2370 <para>
2371 the string they capture is "ab(cd)ef", the contents of the top level
2372 parentheses.
2373 </para>
2374
2375 <para>
2376 Do not confuse the (?R) item with the condition (R), which tests for
2377 recursion. Consider this pattern, which matches text in angle brackets,
2378 allowing for arbitrary nesting. Only digits are allowed in nested
2379 brackets (that is, when recursing), whereas any characters are permitted
2380 at the outer level.
2381 </para>
2382
2383 <programlisting>
2384 &lt; (?: (?(R) \d++ | [^&lt;&gt;]*+) | (?R)) * &gt;
2385 </programlisting>
2386
2387 <para>
2388 In this pattern, (?(R) is the start of a conditional subpattern, with
2389 two different alternatives for the recursive and non-recursive cases.
2390 The (?R) item is the actual recursive call.
2391 </para>
2392 </refsect1>
2393
2394 <refsect1>
2395 <title>Subpatterns as subroutines</title>
2396 <para>
2397 If the syntax for a recursive subpattern reference (either by number or
2398 by name) is used outside the parentheses to which it refers, it operates
2399 like a subroutine in a programming language. The "called" subpattern may
2400 be defined before or after the reference. An earlier example pointed out
2401 that the pattern
2402 </para>
2403
2404 <programlisting>
2405 (sens|respons)e and \1ibility
2406 </programlisting>
2407
2408 <para>
2409 matches "sense and sensibility" and "response and responsibility", but
2410 not "sense and responsibility". If instead the pattern
2411 </para>
2412
2413 <programlisting>
2414 (sens|respons)e and (?1)ibility
2415 </programlisting>
2416
2417 <para>
2418 is used, it does match "sense and responsibility" as well as the other
2419 two strings. Another example is given in the discussion of DEFINE above.
2420 </para>
2421
2422 <para>
2423 Like recursive subpatterns, a "subroutine" call is always treated as an atomic
2424 group. That is, once it has matched some of the string, it is never
2425 re-entered, even if it contains untried alternatives and there is a subsequent
2426 matching failure.
2427 </para>
2428
2429 <para>
2430 When a subpattern is used as a subroutine, processing options such as
2431 case-independence are fixed when the subpattern is defined. They cannot be
2432 changed for different calls. For example, consider this pattern:
2433 </para>
2434
2435 <programlisting>
2436 (abc)(?i:(?1))
2437 </programlisting>
2438
2439 <para>
2440 It matches "abcabc". It does not match "abcABC" because the change of
2441 processing option does not affect the called subpattern.
2442 </para>
2443 </refsect1>
2444
2445 <!-- Callouts are not supported by GRegex
2446 <refsect1>
2447 <title>Callouts</title>
2448 <para>
2449 Perl has a feature whereby using the sequence (?{...}) causes arbitrary
2450 Perl code to be obeyed in the middle of matching a regular expression.
2451 This makes it possible, amongst other things, to extract different substrings that match the same pair of parentheses when there is a repetition.
2452 </para>
2453
2454 <para>
2455 PCRE provides a similar feature, but of course it cannot obey arbitrary
2456 Perl code. The feature is called "callout". The caller of PCRE provides
2457 an external function by putting its entry point in the global variable
2458 pcre_callout. By default, this variable contains NULL, which disables
2459 all calling out.
2460 </para>
2461
2462 <para>
2463 Within a regular expression, (?C) indicates the points at which the
2464 external function is to be called. If you want to identify different
2465 callout points, you can put a number less than 256 after the letter C.
2466 The default value is zero. For example, this pattern has two callout
2467 points:
2468 </para>
2469
2470 <programlisting>
2471 (?C1)abc(?C2)def
2472 </programlisting>
2473
2474 <para>
2475 If the PCRE_AUTO_CALLOUT flag is passed to pcre_compile(), callouts are
2476 automatically installed before each item in the pattern. They are all
2477 numbered 255.
2478 </para>
2479
2480 <para>
2481 During matching, when PCRE reaches a callout point (and pcre_callout is
2482 set), the external function is called. It is provided with the number
2483 of the callout, the position in the pattern, and, optionally, one item
2484 of data originally supplied by the caller of pcre_exec(). The callout
2485 function may cause matching to proceed, to backtrack, or to fail altogether. A complete description of the interface to the callout function
2486 is given in the pcrecallout documentation.
2487 </para>
2488 </refsect1>
2489 -->
2490
2491 <refsect1>
2492 <title>Copyright</title>
2493 <para>
2494 This document was copied and adapted from the PCRE documentation,
2495 specifically from the man page for pcrepattern.
2496 The original copyright note is:
2497 </para>
2498
2499 <programlisting>
2500 Copyright (c) 1997-2006 University of Cambridge.
2501
2502 Redistribution and use in source and binary forms, with or without
2503 modification, are permitted provided that the following conditions are met:
2504
2505     * Redistributions of source code must retain the above copyright notice,
2506       this list of conditions and the following disclaimer.
2507
2508     * Redistributions in binary form must reproduce the above copyright
2509       notice, this list of conditions and the following disclaimer in the
2510       documentation and/or other materials provided with the distribution.
2511
2512     * Neither the name of the University of Cambridge nor the name of Google
2513       Inc. nor the names of their contributors may be used to endorse or
2514       promote products derived from this software without specific prior
2515       written permission.
2516
2517 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
2518 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2519 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2520 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
2521 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
2522 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
2523 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
2524 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
2525 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
2526 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2527 POSSIBILITY OF SUCH DAMAGE.
2528 </programlisting>
2529 </refsect1>
2530
2531 </refentry>