1 /* GRegex -- regular expression API wrapper around PCRE.
3 * Copyright (C) 1999, 2000 Scott Wimer
4 * Copyright (C) 2004, Matthias Clasen <mclasen@redhat.com>
5 * Copyright (C) 2005 - 2007, Marco Barisione <marco@barisione.org>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 #ifdef USE_SYSTEM_PCRE
29 #include "pcre/pcre.h"
36 #include "gmessages.h"
37 #include "gstrfuncs.h"
43 * @title: Perl-compatible regular expressions
44 * @short_description: matches strings against regular expressions
45 * @see_also: <xref linkend="glib-regex-syntax"/>
47 * The <function>g_regex_*()</function> functions implement regular
48 * expression pattern matching using syntax and semantics similar to
49 * Perl regular expression.
51 * Some functions accept a @start_position argument, setting it differs
52 * from just passing over a shortened string and setting #G_REGEX_MATCH_NOTBOL
53 * in the case of a pattern that begins with any kind of lookbehind assertion.
54 * For example, consider the pattern "\Biss\B" which finds occurrences of "iss"
55 * in the middle of words. ("\B" matches only if the current position in the
56 * subject is not a word boundary.) When applied to the string "Mississipi"
57 * from the fourth byte, namely "issipi", it does not match, because "\B" is
58 * always false at the start of the subject, which is deemed to be a word
59 * boundary. However, if the entire string is passed , but with
60 * @start_position set to 4, it finds the second occurrence of "iss" because
61 * it is able to look behind the starting point to discover that it is
62 * preceded by a letter.
64 * Note that, unless you set the #G_REGEX_RAW flag, all the strings passed
65 * to these functions must be encoded in UTF-8. The lengths and the positions
66 * inside the strings are in bytes and not in characters, so, for instance,
67 * "\xc3\xa0" (i.e. "à") is two bytes long but it is treated as a
68 * single character. If you set #G_REGEX_RAW the strings can be non-valid
69 * UTF-8 strings and a byte is treated as a character, so "\xc3\xa0" is two
70 * bytes and two characters long.
72 * When matching a pattern, "\n" matches only against a "\n" character in
73 * the string, and "\r" matches only a "\r" character. To match any newline
74 * sequence use "\R". This particular group matches either the two-character
75 * sequence CR + LF ("\r\n"), or one of the single characters LF (linefeed,
76 * U+000A, "\n"), VT vertical tab, U+000B, "\v"), FF (formfeed, U+000C, "\f"),
77 * CR (carriage return, U+000D, "\r"), NEL (next line, U+0085), LS (line
78 * separator, U+2028), or PS (paragraph separator, U+2029).
80 * The behaviour of the dot, circumflex, and dollar metacharacters are
81 * affected by newline characters, the default is to recognize any newline
82 * character (the same characters recognized by "\R"). This can be changed
83 * with #G_REGEX_NEWLINE_CR, #G_REGEX_NEWLINE_LF and #G_REGEX_NEWLINE_CRLF
84 * compile options, and with #G_REGEX_MATCH_NEWLINE_ANY,
85 * #G_REGEX_MATCH_NEWLINE_CR, #G_REGEX_MATCH_NEWLINE_LF and
86 * #G_REGEX_MATCH_NEWLINE_CRLF match options. These settings are also
87 * relevant when compiling a pattern if #G_REGEX_EXTENDED is set, and an
88 * unescaped "#" outside a character class is encountered. This indicates
89 * a comment that lasts until after the next newline.
91 * When setting the %G_REGEX_JAVASCRIPT_COMPAT flag, pattern syntax and pattern
92 * matching is changed to be compatible with the way that regular expressions
93 * work in JavaScript. More precisely, a lonely ']' character in the pattern
94 * is a syntax error; the '\x' escape only allows 0 to 2 hexadecimal digits, and
95 * you must use the '\u' escape sequence with 4 hex digits to specify a unicode
96 * codepoint instead of '\x' or 'x{....}'. If '\x' or '\u' are not followed by
97 * the specified number of hex digits, they match 'x' and 'u' literally; also
98 * '\U' always matches 'U' instead of being an error in the pattern. Finally,
99 * pattern matching is modified so that back references to an unset subpattern
100 * group produces a match with the empty string instead of an error. See
101 * <ulink>man:pcreapi(3)</ulink> for more information.
103 * Creating and manipulating the same #GRegex structure from different
104 * threads is not a problem as #GRegex does not modify its internal
105 * state between creation and destruction, on the other hand #GMatchInfo
108 * The regular expressions low-level functionalities are obtained through
109 * the excellent <ulink url="http://www.pcre.org/">PCRE</ulink> library
110 * written by Philip Hazel.
113 /* Mask of all the possible values for GRegexCompileFlags. */
114 #define G_REGEX_COMPILE_MASK (G_REGEX_CASELESS | \
115 G_REGEX_MULTILINE | \
119 G_REGEX_DOLLAR_ENDONLY | \
122 G_REGEX_NO_AUTO_CAPTURE | \
124 G_REGEX_FIRSTLINE | \
126 G_REGEX_NEWLINE_CR | \
127 G_REGEX_NEWLINE_LF | \
128 G_REGEX_NEWLINE_CRLF | \
129 G_REGEX_NEWLINE_ANYCRLF | \
130 G_REGEX_BSR_ANYCRLF | \
131 G_REGEX_JAVASCRIPT_COMPAT)
133 /* Mask of all GRegexCompileFlags values that are (not) passed trough to PCRE */
134 #define G_REGEX_COMPILE_PCRE_MASK (G_REGEX_COMPILE_MASK & ~G_REGEX_COMPILE_NONPCRE_MASK)
135 #define G_REGEX_COMPILE_NONPCRE_MASK (G_REGEX_RAW | \
138 /* Mask of all the possible values for GRegexMatchFlags. */
139 #define G_REGEX_MATCH_MASK (G_REGEX_MATCH_ANCHORED | \
140 G_REGEX_MATCH_NOTBOL | \
141 G_REGEX_MATCH_NOTEOL | \
142 G_REGEX_MATCH_NOTEMPTY | \
143 G_REGEX_MATCH_PARTIAL | \
144 G_REGEX_MATCH_NEWLINE_CR | \
145 G_REGEX_MATCH_NEWLINE_LF | \
146 G_REGEX_MATCH_NEWLINE_CRLF | \
147 G_REGEX_MATCH_NEWLINE_ANY | \
148 G_REGEX_MATCH_NEWLINE_ANYCRLF | \
149 G_REGEX_MATCH_BSR_ANYCRLF | \
150 G_REGEX_MATCH_BSR_ANY | \
151 G_REGEX_MATCH_PARTIAL_SOFT | \
152 G_REGEX_MATCH_PARTIAL_HARD | \
153 G_REGEX_MATCH_NOTEMPTY_ATSTART)
155 /* we rely on these flags having the same values */
156 G_STATIC_ASSERT (G_REGEX_CASELESS == PCRE_CASELESS);
157 G_STATIC_ASSERT (G_REGEX_MULTILINE == PCRE_MULTILINE);
158 G_STATIC_ASSERT (G_REGEX_DOTALL == PCRE_DOTALL);
159 G_STATIC_ASSERT (G_REGEX_EXTENDED == PCRE_EXTENDED);
160 G_STATIC_ASSERT (G_REGEX_ANCHORED == PCRE_ANCHORED);
161 G_STATIC_ASSERT (G_REGEX_DOLLAR_ENDONLY == PCRE_DOLLAR_ENDONLY);
162 G_STATIC_ASSERT (G_REGEX_UNGREEDY == PCRE_UNGREEDY);
163 G_STATIC_ASSERT (G_REGEX_NO_AUTO_CAPTURE == PCRE_NO_AUTO_CAPTURE);
164 G_STATIC_ASSERT (G_REGEX_FIRSTLINE == PCRE_FIRSTLINE);
165 G_STATIC_ASSERT (G_REGEX_DUPNAMES == PCRE_DUPNAMES);
166 G_STATIC_ASSERT (G_REGEX_NEWLINE_CR == PCRE_NEWLINE_CR);
167 G_STATIC_ASSERT (G_REGEX_NEWLINE_LF == PCRE_NEWLINE_LF);
168 G_STATIC_ASSERT (G_REGEX_NEWLINE_CRLF == PCRE_NEWLINE_CRLF);
169 G_STATIC_ASSERT (G_REGEX_NEWLINE_ANYCRLF == PCRE_NEWLINE_ANYCRLF);
170 G_STATIC_ASSERT (G_REGEX_BSR_ANYCRLF == PCRE_BSR_ANYCRLF);
171 G_STATIC_ASSERT (G_REGEX_JAVASCRIPT_COMPAT == PCRE_JAVASCRIPT_COMPAT);
173 G_STATIC_ASSERT (G_REGEX_MATCH_ANCHORED == PCRE_ANCHORED);
174 G_STATIC_ASSERT (G_REGEX_MATCH_NOTBOL == PCRE_NOTBOL);
175 G_STATIC_ASSERT (G_REGEX_MATCH_NOTEOL == PCRE_NOTEOL);
176 G_STATIC_ASSERT (G_REGEX_MATCH_NOTEMPTY == PCRE_NOTEMPTY);
177 G_STATIC_ASSERT (G_REGEX_MATCH_PARTIAL == PCRE_PARTIAL);
178 G_STATIC_ASSERT (G_REGEX_MATCH_NEWLINE_CR == PCRE_NEWLINE_CR);
179 G_STATIC_ASSERT (G_REGEX_MATCH_NEWLINE_LF == PCRE_NEWLINE_LF);
180 G_STATIC_ASSERT (G_REGEX_MATCH_NEWLINE_CRLF == PCRE_NEWLINE_CRLF);
181 G_STATIC_ASSERT (G_REGEX_MATCH_NEWLINE_ANY == PCRE_NEWLINE_ANY);
182 G_STATIC_ASSERT (G_REGEX_MATCH_NEWLINE_ANYCRLF == PCRE_NEWLINE_ANYCRLF);
183 G_STATIC_ASSERT (G_REGEX_MATCH_BSR_ANYCRLF == PCRE_BSR_ANYCRLF);
184 G_STATIC_ASSERT (G_REGEX_MATCH_BSR_ANY == PCRE_BSR_UNICODE);
185 G_STATIC_ASSERT (G_REGEX_MATCH_PARTIAL_SOFT == PCRE_PARTIAL_SOFT);
186 G_STATIC_ASSERT (G_REGEX_MATCH_PARTIAL_HARD == PCRE_PARTIAL_HARD);
187 G_STATIC_ASSERT (G_REGEX_MATCH_NOTEMPTY_ATSTART == PCRE_NOTEMPTY_ATSTART);
189 /* These PCRE flags are unused or not exposed publically in GRegexFlags, so
190 * it should be ok to reuse them for different things.
192 G_STATIC_ASSERT (G_REGEX_OPTIMIZE == PCRE_NO_UTF8_CHECK);
193 G_STATIC_ASSERT (G_REGEX_RAW == PCRE_UTF8);
195 /* if the string is in UTF-8 use g_utf8_ functions, else use
197 #define NEXT_CHAR(re, s) (((re)->compile_opts & G_REGEX_RAW) ? \
199 g_utf8_next_char (s))
200 #define PREV_CHAR(re, s) (((re)->compile_opts & G_REGEX_RAW) ? \
202 g_utf8_prev_char (s))
206 volatile gint ref_count; /* the ref count */
207 GRegex *regex; /* the regex */
208 GRegexMatchFlags match_opts; /* options used at match time on the regex */
209 gint matches; /* number of matching sub patterns */
210 gint pos; /* position in the string where last match left off */
211 gint n_offsets; /* number of offsets */
212 gint *offsets; /* array of offsets paired 0,1 ; 2,3 ; 3,4 etc */
213 gint *workspace; /* workspace for pcre_dfa_exec() */
214 gint n_workspace; /* number of workspace elements */
215 const gchar *string; /* string passed to the match function */
216 gssize string_len; /* length of string */
221 volatile gint ref_count; /* the ref count for the immutable part */
222 gchar *pattern; /* the pattern */
223 pcre *pcre_re; /* compiled form of the pattern */
224 GRegexCompileFlags compile_opts; /* options used at compile time on the pattern */
225 GRegexMatchFlags match_opts; /* options used at match time on the regex */
226 pcre_extra *extra; /* data stored when G_REGEX_OPTIMIZE is used */
229 /* TRUE if ret is an error code, FALSE otherwise. */
230 #define IS_PCRE_ERROR(ret) ((ret) < PCRE_ERROR_NOMATCH && (ret) != PCRE_ERROR_PARTIAL)
232 typedef struct _InterpolationData InterpolationData;
233 static gboolean interpolation_list_needs_match (GList *list);
234 static gboolean interpolate_replacement (const GMatchInfo *match_info,
237 static GList *split_replacement (const gchar *replacement,
239 static void free_interpolation_data (InterpolationData *data);
243 match_error (gint errcode)
247 case PCRE_ERROR_NOMATCH:
250 case PCRE_ERROR_NULL:
251 /* NULL argument, this should not happen in GRegex */
252 g_warning ("A NULL argument was passed to PCRE");
254 case PCRE_ERROR_BADOPTION:
255 return "bad options";
256 case PCRE_ERROR_BADMAGIC:
257 return _("corrupted object");
258 case PCRE_ERROR_UNKNOWN_OPCODE:
259 return N_("internal error or corrupted object");
260 case PCRE_ERROR_NOMEMORY:
261 return _("out of memory");
262 case PCRE_ERROR_NOSUBSTRING:
263 /* not used by pcre_exec() */
265 case PCRE_ERROR_MATCHLIMIT:
266 return _("backtracking limit reached");
267 case PCRE_ERROR_CALLOUT:
268 /* callouts are not implemented */
270 case PCRE_ERROR_BADUTF8:
271 case PCRE_ERROR_BADUTF8_OFFSET:
272 /* we do not check if strings are valid */
274 case PCRE_ERROR_PARTIAL:
277 case PCRE_ERROR_BADPARTIAL:
278 return _("the pattern contains items not supported for partial matching");
279 case PCRE_ERROR_INTERNAL:
280 return _("internal error");
281 case PCRE_ERROR_BADCOUNT:
282 /* negative ovecsize, this should not happen in GRegex */
283 g_warning ("A negative ovecsize was passed to PCRE");
285 case PCRE_ERROR_DFA_UITEM:
286 return _("the pattern contains items not supported for partial matching");
287 case PCRE_ERROR_DFA_UCOND:
288 return _("back references as conditions are not supported for partial matching");
289 case PCRE_ERROR_DFA_UMLIMIT:
290 /* the match_field field is not used in GRegex */
292 case PCRE_ERROR_DFA_WSSIZE:
293 /* handled expanding the workspace */
295 case PCRE_ERROR_DFA_RECURSE:
296 case PCRE_ERROR_RECURSIONLIMIT:
297 return _("recursion limit reached");
298 case PCRE_ERROR_BADNEWLINE:
299 return _("invalid combination of newline flags");
300 case PCRE_ERROR_BADOFFSET:
301 return _("bad offset");
302 case PCRE_ERROR_SHORTUTF8:
303 return _("short utf8");
304 case PCRE_ERROR_RECURSELOOP:
305 return _("recursion loop");
309 return _("unknown error");
313 translate_compile_error (gint *errcode, const gchar **errmsg)
315 /* Compile errors are created adding 100 to the error code returned
317 * If errcode is known we put the translatable error message in
318 * erromsg. If errcode is unknown we put the generic
319 * G_REGEX_ERROR_COMPILE error code in errcode and keep the
320 * untranslated error message returned by PCRE.
321 * Note that there can be more PCRE errors with the same GRegexError
322 * and that some PCRE errors are useless for us.
328 case G_REGEX_ERROR_STRAY_BACKSLASH:
329 *errmsg = _("\\ at end of pattern");
331 case G_REGEX_ERROR_MISSING_CONTROL_CHAR:
332 *errmsg = _("\\c at end of pattern");
334 case G_REGEX_ERROR_UNRECOGNIZED_ESCAPE:
335 *errmsg = _("unrecognized character following \\");
337 case G_REGEX_ERROR_QUANTIFIERS_OUT_OF_ORDER:
338 *errmsg = _("numbers out of order in {} quantifier");
340 case G_REGEX_ERROR_QUANTIFIER_TOO_BIG:
341 *errmsg = _("number too big in {} quantifier");
343 case G_REGEX_ERROR_UNTERMINATED_CHARACTER_CLASS:
344 *errmsg = _("missing terminating ] for character class");
346 case G_REGEX_ERROR_INVALID_ESCAPE_IN_CHARACTER_CLASS:
347 *errmsg = _("invalid escape sequence in character class");
349 case G_REGEX_ERROR_RANGE_OUT_OF_ORDER:
350 *errmsg = _("range out of order in character class");
352 case G_REGEX_ERROR_NOTHING_TO_REPEAT:
353 *errmsg = _("nothing to repeat");
355 case 111: /* internal error: unexpected repeat */
356 *errcode = G_REGEX_ERROR_INTERNAL;
357 *errmsg = _("unexpected repeat");
359 case G_REGEX_ERROR_UNRECOGNIZED_CHARACTER:
360 *errmsg = _("unrecognized character after (? or (?-");
362 case G_REGEX_ERROR_POSIX_NAMED_CLASS_OUTSIDE_CLASS:
363 *errmsg = _("POSIX named classes are supported only within a class");
365 case G_REGEX_ERROR_UNMATCHED_PARENTHESIS:
366 *errmsg = _("missing terminating )");
368 case G_REGEX_ERROR_INEXISTENT_SUBPATTERN_REFERENCE:
369 *errmsg = _("reference to non-existent subpattern");
371 case G_REGEX_ERROR_UNTERMINATED_COMMENT:
372 *errmsg = _("missing ) after comment");
374 case G_REGEX_ERROR_EXPRESSION_TOO_LARGE:
375 *errmsg = _("regular expression is too large");
377 case G_REGEX_ERROR_MEMORY_ERROR:
378 *errmsg = _("failed to get memory");
380 case 122: /* unmatched parentheses */
381 *errcode = G_REGEX_ERROR_UNMATCHED_PARENTHESIS;
382 *errmsg = _(") without opening (");
384 case 123: /* internal error: code overflow */
385 *errcode = G_REGEX_ERROR_INTERNAL;
386 *errmsg = _("code overflow");
388 case 124: /* "unrecognized character after (?<\0 */
389 *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
390 *errmsg = _("unrecognized character after (?<");
392 case G_REGEX_ERROR_VARIABLE_LENGTH_LOOKBEHIND:
393 *errmsg = _("lookbehind assertion is not fixed length");
395 case G_REGEX_ERROR_MALFORMED_CONDITION:
396 *errmsg = _("malformed number or name after (?(");
398 case G_REGEX_ERROR_TOO_MANY_CONDITIONAL_BRANCHES:
399 *errmsg = _("conditional group contains more than two branches");
401 case G_REGEX_ERROR_ASSERTION_EXPECTED:
402 *errmsg = _("assertion expected after (?(");
405 *errcode = G_REGEX_ERROR_UNMATCHED_PARENTHESIS;
406 /* translators: '(?R' and '(?[+-]digits' are both meant as (groups of)
407 * sequences here, '(?-54' would be an example for the second group.
409 *errmsg = _("(?R or (?[+-]digits must be followed by )");
411 case G_REGEX_ERROR_UNKNOWN_POSIX_CLASS_NAME:
412 *errmsg = _("unknown POSIX class name");
414 case G_REGEX_ERROR_POSIX_COLLATING_ELEMENTS_NOT_SUPPORTED:
415 *errmsg = _("POSIX collating elements are not supported");
417 case G_REGEX_ERROR_HEX_CODE_TOO_LARGE:
418 *errmsg = _("character value in \\x{...} sequence is too large");
420 case G_REGEX_ERROR_INVALID_CONDITION:
421 *errmsg = _("invalid condition (?(0)");
423 case G_REGEX_ERROR_SINGLE_BYTE_MATCH_IN_LOOKBEHIND:
424 *errmsg = _("\\C not allowed in lookbehind assertion");
426 case 137: /* PCRE does not support \\L, \\l, \\N{name}, \\U, or \\u\0 */
427 /* A number of Perl escapes are not handled by PCRE.
428 * Therefore it explicitly raises ERR37.
430 *errcode = G_REGEX_ERROR_UNRECOGNIZED_ESCAPE;
431 *errmsg = _("escapes \\L, \\l, \\N{name}, \\U, and \\u are not supported");
433 case G_REGEX_ERROR_INFINITE_LOOP:
434 *errmsg = _("recursive call could loop indefinitely");
436 case 141: /* unrecognized character after (?P\0 */
437 *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
438 *errmsg = _("unrecognized character after (?P");
440 case G_REGEX_ERROR_MISSING_SUBPATTERN_NAME_TERMINATOR:
441 *errmsg = _("missing terminator in subpattern name");
443 case G_REGEX_ERROR_DUPLICATE_SUBPATTERN_NAME:
444 *errmsg = _("two named subpatterns have the same name");
446 case G_REGEX_ERROR_MALFORMED_PROPERTY:
447 *errmsg = _("malformed \\P or \\p sequence");
449 case G_REGEX_ERROR_UNKNOWN_PROPERTY:
450 *errmsg = _("unknown property name after \\P or \\p");
452 case G_REGEX_ERROR_SUBPATTERN_NAME_TOO_LONG:
453 *errmsg = _("subpattern name is too long (maximum 32 characters)");
455 case G_REGEX_ERROR_TOO_MANY_SUBPATTERNS:
456 *errmsg = _("too many named subpatterns (maximum 10,000)");
458 case G_REGEX_ERROR_INVALID_OCTAL_VALUE:
459 *errmsg = _("octal value is greater than \\377");
461 case 152: /* internal error: overran compiling workspace */
462 *errcode = G_REGEX_ERROR_INTERNAL;
463 *errmsg = _("overran compiling workspace");
465 case 153: /* internal error: previously-checked referenced subpattern not found */
466 *errcode = G_REGEX_ERROR_INTERNAL;
467 *errmsg = _("previously-checked referenced subpattern not found");
469 case G_REGEX_ERROR_TOO_MANY_BRANCHES_IN_DEFINE:
470 *errmsg = _("DEFINE group contains more than one branch");
472 case G_REGEX_ERROR_INCONSISTENT_NEWLINE_OPTIONS:
473 *errmsg = _("inconsistent NEWLINE options");
475 case G_REGEX_ERROR_MISSING_BACK_REFERENCE:
476 *errmsg = _("\\g is not followed by a braced, angle-bracketed, or quoted name or "
477 "number, or by a plain number");
479 case G_REGEX_ERROR_INVALID_RELATIVE_REFERENCE:
480 *errmsg = _("a numbered reference must not be zero");
482 case G_REGEX_ERROR_BACKTRACKING_CONTROL_VERB_ARGUMENT_FORBIDDEN:
483 *errmsg = _("an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)");
485 case G_REGEX_ERROR_UNKNOWN_BACKTRACKING_CONTROL_VERB:
486 *errmsg = _("(*VERB) not recognized");
488 case G_REGEX_ERROR_NUMBER_TOO_BIG:
489 *errmsg = _("number is too big");
491 case G_REGEX_ERROR_MISSING_SUBPATTERN_NAME:
492 *errmsg = _("missing subpattern name after (?&");
494 case G_REGEX_ERROR_MISSING_DIGIT:
495 *errmsg = _("digit expected after (?+");
497 case G_REGEX_ERROR_INVALID_DATA_CHARACTER:
498 *errmsg = _("] is an invalid data character in JavaScript compatibility mode");
500 case G_REGEX_ERROR_EXTRA_SUBPATTERN_NAME:
501 *errmsg = _("different names for subpatterns of the same number are not allowed");
503 case G_REGEX_ERROR_BACKTRACKING_CONTROL_VERB_ARGUMENT_REQUIRED:
504 *errmsg = _("(*MARK) must have an argument");
506 case G_REGEX_ERROR_INVALID_CONTROL_CHAR:
507 *errmsg = _( "\\c must be followed by an ASCII character");
509 case G_REGEX_ERROR_MISSING_NAME:
510 *errmsg = _("\\k is not followed by a braced, angle-bracketed, or quoted name");
512 case G_REGEX_ERROR_NOT_SUPPORTED_IN_CLASS:
513 *errmsg = _("\\N is not supported in a class");
515 case G_REGEX_ERROR_TOO_MANY_FORWARD_REFERENCES:
516 *errmsg = _("too many forward references");
518 case G_REGEX_ERROR_NAME_TOO_LONG:
519 *errmsg = _("name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN)");
521 case G_REGEX_ERROR_CHARACTER_VALUE_TOO_LARGE:
522 *errmsg = _("character value in \\u.... sequence is too large");
525 case 116: /* erroffset passed as NULL */
526 /* This should not happen as we never pass a NULL erroffset */
527 g_warning ("erroffset passed as NULL");
528 *errcode = G_REGEX_ERROR_COMPILE;
530 case 117: /* unknown option bit(s) set */
531 /* This should not happen as we check options before passing them
532 * to pcre_compile2() */
533 g_warning ("unknown option bit(s) set");
534 *errcode = G_REGEX_ERROR_COMPILE;
536 case 132: /* this version of PCRE is compiled without UTF support */
537 case 144: /* invalid UTF-8 string */
538 case 145: /* support for \\P, \\p, and \\X has not been compiled */
539 case 167: /* this version of PCRE is not compiled with Unicode property support */
540 case 173: /* disallowed Unicode code point (>= 0xd800 && <= 0xdfff) */
541 case 174: /* invalid UTF-16 string */
542 /* These errors should not happen as we are using an UTF-8 and UCP-enabled PCRE
543 * and we do not check if strings are valid */
544 case 170: /* internal error: unknown opcode in find_fixedlength() */
545 *errcode = G_REGEX_ERROR_INTERNAL;
549 *errcode = G_REGEX_ERROR_COMPILE;
556 match_info_new (const GRegex *regex,
563 GMatchInfo *match_info;
566 string_len = strlen (string);
568 match_info = g_new0 (GMatchInfo, 1);
569 match_info->ref_count = 1;
570 match_info->regex = g_regex_ref ((GRegex *)regex);
571 match_info->string = string;
572 match_info->string_len = string_len;
573 match_info->matches = PCRE_ERROR_NOMATCH;
574 match_info->pos = start_position;
575 match_info->match_opts = match_options;
579 /* These values should be enough for most cases, if they are not
580 * enough g_regex_match_all_full() will expand them. */
581 match_info->n_offsets = 24;
582 match_info->n_workspace = 100;
583 match_info->workspace = g_new (gint, match_info->n_workspace);
588 pcre_fullinfo (regex->pcre_re, regex->extra,
589 PCRE_INFO_CAPTURECOUNT, &capture_count);
590 match_info->n_offsets = (capture_count + 1) * 3;
593 match_info->offsets = g_new0 (gint, match_info->n_offsets);
594 /* Set an invalid position for the previous match. */
595 match_info->offsets[0] = -1;
596 match_info->offsets[1] = -1;
602 * g_match_info_get_regex:
603 * @match_info: a #GMatchInfo
605 * Returns #GRegex object used in @match_info. It belongs to Glib
606 * and must not be freed. Use g_regex_ref() if you need to keep it
607 * after you free @match_info object.
609 * Returns: #GRegex object used in @match_info
614 g_match_info_get_regex (const GMatchInfo *match_info)
616 g_return_val_if_fail (match_info != NULL, NULL);
617 return match_info->regex;
621 * g_match_info_get_string:
622 * @match_info: a #GMatchInfo
624 * Returns the string searched with @match_info. This is the
625 * string passed to g_regex_match() or g_regex_replace() so
626 * you may not free it before calling this function.
628 * Returns: the string searched with @match_info
633 g_match_info_get_string (const GMatchInfo *match_info)
635 g_return_val_if_fail (match_info != NULL, NULL);
636 return match_info->string;
641 * @match_info: a #GMatchInfo
643 * Increases reference count of @match_info by 1.
645 * Returns: @match_info
650 g_match_info_ref (GMatchInfo *match_info)
652 g_return_val_if_fail (match_info != NULL, NULL);
653 g_atomic_int_inc (&match_info->ref_count);
658 * g_match_info_unref:
659 * @match_info: a #GMatchInfo
661 * Decreases reference count of @match_info by 1. When reference count drops
662 * to zero, it frees all the memory associated with the match_info structure.
667 g_match_info_unref (GMatchInfo *match_info)
669 if (g_atomic_int_dec_and_test (&match_info->ref_count))
671 g_regex_unref (match_info->regex);
672 g_free (match_info->offsets);
673 g_free (match_info->workspace);
680 * @match_info: (allow-none): a #GMatchInfo, or %NULL
682 * If @match_info is not %NULL, calls g_match_info_unref(); otherwise does
688 g_match_info_free (GMatchInfo *match_info)
690 if (match_info == NULL)
693 g_match_info_unref (match_info);
698 * @match_info: a #GMatchInfo structure
699 * @error: location to store the error occurring, or %NULL to ignore errors
701 * Scans for the next match using the same parameters of the previous
702 * call to g_regex_match_full() or g_regex_match() that returned
705 * The match is done on the string passed to the match function, so you
706 * cannot free it before calling this function.
708 * Returns: %TRUE is the string matched, %FALSE otherwise
713 g_match_info_next (GMatchInfo *match_info,
716 gint prev_match_start;
719 g_return_val_if_fail (match_info != NULL, FALSE);
720 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
721 g_return_val_if_fail (match_info->pos >= 0, FALSE);
723 prev_match_start = match_info->offsets[0];
724 prev_match_end = match_info->offsets[1];
726 if (match_info->pos > match_info->string_len)
728 /* we have reached the end of the string */
729 match_info->pos = -1;
730 match_info->matches = PCRE_ERROR_NOMATCH;
734 match_info->matches = pcre_exec (match_info->regex->pcre_re,
735 match_info->regex->extra,
737 match_info->string_len,
739 match_info->regex->match_opts | match_info->match_opts,
741 match_info->n_offsets);
742 if (IS_PCRE_ERROR (match_info->matches))
744 g_set_error (error, G_REGEX_ERROR, G_REGEX_ERROR_MATCH,
745 _("Error while matching regular expression %s: %s"),
746 match_info->regex->pattern, match_error (match_info->matches));
750 /* avoid infinite loops if the pattern is an empty string or something
752 if (match_info->pos == match_info->offsets[1])
754 if (match_info->pos > match_info->string_len)
756 /* we have reached the end of the string */
757 match_info->pos = -1;
758 match_info->matches = PCRE_ERROR_NOMATCH;
762 match_info->pos = NEXT_CHAR (match_info->regex,
763 &match_info->string[match_info->pos]) -
768 match_info->pos = match_info->offsets[1];
771 /* it's possible to get two identical matches when we are matching
772 * empty strings, for instance if the pattern is "(?=[A-Z0-9])" and
773 * the string is "RegExTest" we have:
774 * - search at position 0: match from 0 to 0
775 * - search at position 1: match from 3 to 3
776 * - search at position 3: match from 3 to 3 (duplicate)
777 * - search at position 4: match from 5 to 5
778 * - search at position 5: match from 5 to 5 (duplicate)
779 * - search at position 6: no match -> stop
780 * so we have to ignore the duplicates.
781 * see bug #515944: http://bugzilla.gnome.org/show_bug.cgi?id=515944 */
782 if (match_info->matches >= 0 &&
783 prev_match_start == match_info->offsets[0] &&
784 prev_match_end == match_info->offsets[1])
786 /* ignore this match and search the next one */
787 return g_match_info_next (match_info, error);
790 return match_info->matches >= 0;
794 * g_match_info_matches:
795 * @match_info: a #GMatchInfo structure
797 * Returns whether the previous match operation succeeded.
799 * Returns: %TRUE if the previous match operation succeeded,
805 g_match_info_matches (const GMatchInfo *match_info)
807 g_return_val_if_fail (match_info != NULL, FALSE);
809 return match_info->matches >= 0;
813 * g_match_info_get_match_count:
814 * @match_info: a #GMatchInfo structure
816 * Retrieves the number of matched substrings (including substring 0,
817 * that is the whole matched text), so 1 is returned if the pattern
818 * has no substrings in it and 0 is returned if the match failed.
820 * If the last match was obtained using the DFA algorithm, that is
821 * using g_regex_match_all() or g_regex_match_all_full(), the retrieved
822 * count is not that of the number of capturing parentheses but that of
823 * the number of matched substrings.
825 * Returns: Number of matched substrings, or -1 if an error occurred
830 g_match_info_get_match_count (const GMatchInfo *match_info)
832 g_return_val_if_fail (match_info, -1);
834 if (match_info->matches == PCRE_ERROR_NOMATCH)
837 else if (match_info->matches < PCRE_ERROR_NOMATCH)
842 return match_info->matches;
846 * g_match_info_is_partial_match:
847 * @match_info: a #GMatchInfo structure
849 * Usually if the string passed to g_regex_match*() matches as far as
850 * it goes, but is too short to match the entire pattern, %FALSE is
851 * returned. There are circumstances where it might be helpful to
852 * distinguish this case from other cases in which there is no match.
854 * Consider, for example, an application where a human is required to
855 * type in data for a field with specific formatting requirements. An
856 * example might be a date in the form ddmmmyy, defined by the pattern
857 * "^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$".
858 * If the application sees the user’s keystrokes one by one, and can
859 * check that what has been typed so far is potentially valid, it is
860 * able to raise an error as soon as a mistake is made.
862 * GRegex supports the concept of partial matching by means of the
863 * #G_REGEX_MATCH_PARTIAL_SOFT and #G_REGEX_MATCH_PARTIAL_HARD flags.
864 * When they are used, the return code for
865 * g_regex_match() or g_regex_match_full() is, as usual, %TRUE
866 * for a complete match, %FALSE otherwise. But, when these functions
867 * return %FALSE, you can check if the match was partial calling
868 * g_match_info_is_partial_match().
870 * The difference between #G_REGEX_MATCH_PARTIAL_SOFT and
871 * #G_REGEX_MATCH_PARTIAL_HARD is that when a partial match is encountered
872 * with #G_REGEX_MATCH_PARTIAL_SOFT, matching continues to search for a
873 * possible complete match, while with #G_REGEX_MATCH_PARTIAL_HARD matching
874 * stops at the partial match.
875 * When both #G_REGEX_MATCH_PARTIAL_SOFT and #G_REGEX_MATCH_PARTIAL_HARD
876 * are set, the latter takes precedence.
878 * There were formerly some restrictions on the pattern for partial matching.
879 * The restrictions no longer apply.
881 * See <ulink>man:pcrepartial</ulink> for more information on partial matching.
883 * Returns: %TRUE if the match was partial, %FALSE otherwise
888 g_match_info_is_partial_match (const GMatchInfo *match_info)
890 g_return_val_if_fail (match_info != NULL, FALSE);
892 return match_info->matches == PCRE_ERROR_PARTIAL;
896 * g_match_info_expand_references:
897 * @match_info: (allow-none): a #GMatchInfo or %NULL
898 * @string_to_expand: the string to expand
899 * @error: location to store the error occurring, or %NULL to ignore errors
901 * Returns a new string containing the text in @string_to_expand with
902 * references and escape sequences expanded. References refer to the last
903 * match done with @string against @regex and have the same syntax used by
906 * The @string_to_expand must be UTF-8 encoded even if #G_REGEX_RAW was
907 * passed to g_regex_new().
909 * The backreferences are extracted from the string passed to the match
910 * function, so you cannot call this function after freeing the string.
912 * @match_info may be %NULL in which case @string_to_expand must not
913 * contain references. For instance "foo\n" does not refer to an actual
914 * pattern and '\n' merely will be replaced with \n character,
915 * while to expand "\0" (whole match) one needs the result of a match.
916 * Use g_regex_check_replacement() to find out whether @string_to_expand
917 * contains references.
919 * Returns: (allow-none): the expanded string, or %NULL if an error occurred
924 g_match_info_expand_references (const GMatchInfo *match_info,
925 const gchar *string_to_expand,
930 GError *tmp_error = NULL;
932 g_return_val_if_fail (string_to_expand != NULL, NULL);
933 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
935 list = split_replacement (string_to_expand, &tmp_error);
936 if (tmp_error != NULL)
938 g_propagate_error (error, tmp_error);
942 if (!match_info && interpolation_list_needs_match (list))
944 g_critical ("String '%s' contains references to the match, can't "
945 "expand references without GMatchInfo object",
950 result = g_string_sized_new (strlen (string_to_expand));
951 interpolate_replacement (match_info, result, list);
953 g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
955 return g_string_free (result, FALSE);
959 * g_match_info_fetch:
960 * @match_info: #GMatchInfo structure
961 * @match_num: number of the sub expression
963 * Retrieves the text matching the @match_num<!-- -->'th capturing
964 * parentheses. 0 is the full text of the match, 1 is the first paren
965 * set, 2 the second, and so on.
967 * If @match_num is a valid sub pattern but it didn't match anything
968 * (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty
969 * string is returned.
971 * If the match was obtained using the DFA algorithm, that is using
972 * g_regex_match_all() or g_regex_match_all_full(), the retrieved
973 * string is not that of a set of parentheses but that of a matched
974 * substring. Substrings are matched in reverse order of length, so
975 * 0 is the longest match.
977 * The string is fetched from the string passed to the match function,
978 * so you cannot call this function after freeing the string.
980 * Returns: (allow-none): The matched substring, or %NULL if an error
981 * occurred. You have to free the string yourself
986 g_match_info_fetch (const GMatchInfo *match_info,
989 /* we cannot use pcre_get_substring() because it allocates the
990 * string using pcre_malloc(). */
994 g_return_val_if_fail (match_info != NULL, NULL);
995 g_return_val_if_fail (match_num >= 0, NULL);
997 /* match_num does not exist or it didn't matched, i.e. matching "b"
998 * against "(a)?b" then group 0 is empty. */
999 if (!g_match_info_fetch_pos (match_info, match_num, &start, &end))
1001 else if (start == -1)
1002 match = g_strdup ("");
1004 match = g_strndup (&match_info->string[start], end - start);
1010 * g_match_info_fetch_pos:
1011 * @match_info: #GMatchInfo structure
1012 * @match_num: number of the sub expression
1013 * @start_pos: (out) (allow-none): pointer to location where to store
1014 * the start position, or %NULL
1015 * @end_pos: (out) (allow-none): pointer to location where to store
1016 * the end position, or %NULL
1018 * Retrieves the position in bytes of the @match_num<!-- -->'th capturing
1019 * parentheses. 0 is the full text of the match, 1 is the first
1020 * paren set, 2 the second, and so on.
1022 * If @match_num is a valid sub pattern but it didn't match anything
1023 * (e.g. sub pattern 1, matching "b" against "(a)?b") then @start_pos
1024 * and @end_pos are set to -1 and %TRUE is returned.
1026 * If the match was obtained using the DFA algorithm, that is using
1027 * g_regex_match_all() or g_regex_match_all_full(), the retrieved
1028 * position is not that of a set of parentheses but that of a matched
1029 * substring. Substrings are matched in reverse order of length, so
1030 * 0 is the longest match.
1032 * Returns: %TRUE if the position was fetched, %FALSE otherwise. If
1033 * the position cannot be fetched, @start_pos and @end_pos are left
1039 g_match_info_fetch_pos (const GMatchInfo *match_info,
1044 g_return_val_if_fail (match_info != NULL, FALSE);
1045 g_return_val_if_fail (match_num >= 0, FALSE);
1047 /* make sure the sub expression number they're requesting is less than
1048 * the total number of sub expressions that were matched. */
1049 if (match_num >= match_info->matches)
1052 if (start_pos != NULL)
1053 *start_pos = match_info->offsets[2 * match_num];
1055 if (end_pos != NULL)
1056 *end_pos = match_info->offsets[2 * match_num + 1];
1062 * Returns number of first matched subpattern with name @name.
1063 * There may be more than one in case when DUPNAMES is used,
1064 * and not all subpatterns with that name match;
1065 * pcre_get_stringnumber() does not work in that case.
1068 get_matched_substring_number (const GMatchInfo *match_info,
1072 gchar *first, *last;
1075 if (!(match_info->regex->compile_opts & G_REGEX_DUPNAMES))
1076 return pcre_get_stringnumber (match_info->regex->pcre_re, name);
1078 /* This code is copied from pcre_get.c: get_first_set() */
1079 entrysize = pcre_get_stringtable_entries (match_info->regex->pcre_re,
1087 for (entry = (guchar*) first; entry <= (guchar*) last; entry += entrysize)
1089 gint n = (entry[0] << 8) + entry[1];
1090 if (match_info->offsets[n*2] >= 0)
1094 return (first[0] << 8) + first[1];
1098 * g_match_info_fetch_named:
1099 * @match_info: #GMatchInfo structure
1100 * @name: name of the subexpression
1102 * Retrieves the text matching the capturing parentheses named @name.
1104 * If @name is a valid sub pattern name but it didn't match anything
1105 * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
1106 * then an empty string is returned.
1108 * The string is fetched from the string passed to the match function,
1109 * so you cannot call this function after freeing the string.
1111 * Returns: (allow-none): The matched substring, or %NULL if an error
1112 * occurred. You have to free the string yourself
1117 g_match_info_fetch_named (const GMatchInfo *match_info,
1120 /* we cannot use pcre_get_named_substring() because it allocates the
1121 * string using pcre_malloc(). */
1124 g_return_val_if_fail (match_info != NULL, NULL);
1125 g_return_val_if_fail (name != NULL, NULL);
1127 num = get_matched_substring_number (match_info, name);
1131 return g_match_info_fetch (match_info, num);
1135 * g_match_info_fetch_named_pos:
1136 * @match_info: #GMatchInfo structure
1137 * @name: name of the subexpression
1138 * @start_pos: (out) (allow-none): pointer to location where to store
1139 * the start position, or %NULL
1140 * @end_pos: (out) (allow-none): pointer to location where to store
1141 * the end position, or %NULL
1143 * Retrieves the position in bytes of the capturing parentheses named @name.
1145 * If @name is a valid sub pattern name but it didn't match anything
1146 * (e.g. sub pattern "X", matching "b" against "(?P<X>a)?b")
1147 * then @start_pos and @end_pos are set to -1 and %TRUE is returned.
1149 * Returns: %TRUE if the position was fetched, %FALSE otherwise.
1150 * If the position cannot be fetched, @start_pos and @end_pos
1151 * are left unchanged.
1156 g_match_info_fetch_named_pos (const GMatchInfo *match_info,
1163 g_return_val_if_fail (match_info != NULL, FALSE);
1164 g_return_val_if_fail (name != NULL, FALSE);
1166 num = get_matched_substring_number (match_info, name);
1170 return g_match_info_fetch_pos (match_info, num, start_pos, end_pos);
1174 * g_match_info_fetch_all:
1175 * @match_info: a #GMatchInfo structure
1177 * Bundles up pointers to each of the matching substrings from a match
1178 * and stores them in an array of gchar pointers. The first element in
1179 * the returned array is the match number 0, i.e. the entire matched
1182 * If a sub pattern didn't match anything (e.g. sub pattern 1, matching
1183 * "b" against "(a)?b") then an empty string is inserted.
1185 * If the last match was obtained using the DFA algorithm, that is using
1186 * g_regex_match_all() or g_regex_match_all_full(), the retrieved
1187 * strings are not that matched by sets of parentheses but that of the
1188 * matched substring. Substrings are matched in reverse order of length,
1189 * so the first one is the longest match.
1191 * The strings are fetched from the string passed to the match function,
1192 * so you cannot call this function after freeing the string.
1194 * Returns: (transfer full): a %NULL-terminated array of gchar *
1195 * pointers. It must be freed using g_strfreev(). If the previous
1196 * match failed %NULL is returned
1201 g_match_info_fetch_all (const GMatchInfo *match_info)
1203 /* we cannot use pcre_get_substring_list() because the returned value
1204 * isn't suitable for g_strfreev(). */
1208 g_return_val_if_fail (match_info != NULL, NULL);
1210 if (match_info->matches < 0)
1213 result = g_new (gchar *, match_info->matches + 1);
1214 for (i = 0; i < match_info->matches; i++)
1215 result[i] = g_match_info_fetch (match_info, i);
1224 G_DEFINE_QUARK (g-regex-error-quark, g_regex_error)
1230 * Increases reference count of @regex by 1.
1237 g_regex_ref (GRegex *regex)
1239 g_return_val_if_fail (regex != NULL, NULL);
1240 g_atomic_int_inc (®ex->ref_count);
1248 * Decreases reference count of @regex by 1. When reference count drops
1249 * to zero, it frees all the memory associated with the regex structure.
1254 g_regex_unref (GRegex *regex)
1256 g_return_if_fail (regex != NULL);
1258 if (g_atomic_int_dec_and_test (®ex->ref_count))
1260 g_free (regex->pattern);
1261 if (regex->pcre_re != NULL)
1262 pcre_free (regex->pcre_re);
1263 if (regex->extra != NULL)
1264 pcre_free (regex->extra);
1271 * @pattern: the regular expression
1272 * @compile_options: compile options for the regular expression, or 0
1273 * @match_options: match options for the regular expression, or 0
1274 * @error: return location for a #GError
1276 * Compiles the regular expression to an internal form, and does
1277 * the initial setup of the #GRegex structure.
1279 * Returns: a #GRegex structure. Call g_regex_unref() when you
1285 g_regex_new (const gchar *pattern,
1286 GRegexCompileFlags compile_options,
1287 GRegexMatchFlags match_options,
1292 const gchar *errmsg;
1295 gboolean optimize = FALSE;
1296 static volatile gsize initialised = 0;
1297 unsigned long int pcre_compile_options;
1298 GRegexCompileFlags nonpcre_compile_options;
1300 g_return_val_if_fail (pattern != NULL, NULL);
1301 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1302 g_return_val_if_fail ((compile_options & ~G_REGEX_COMPILE_MASK) == 0, NULL);
1303 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
1305 if (g_once_init_enter (&initialised))
1307 int supports_utf8, supports_ucp;
1309 pcre_config (PCRE_CONFIG_UTF8, &supports_utf8);
1311 g_critical (_("PCRE library is compiled without UTF8 support"));
1313 pcre_config (PCRE_CONFIG_UNICODE_PROPERTIES, &supports_ucp);
1315 g_critical (_("PCRE library is compiled without UTF8 properties support"));
1317 g_once_init_leave (&initialised, supports_utf8 && supports_ucp ? 1 : 2);
1320 if (G_UNLIKELY (initialised != 1))
1322 g_set_error_literal (error, G_REGEX_ERROR, G_REGEX_ERROR_COMPILE,
1323 _("PCRE library is compiled with incompatible options"));
1327 nonpcre_compile_options = compile_options & G_REGEX_COMPILE_NONPCRE_MASK;
1329 /* G_REGEX_OPTIMIZE has the same numeric value of PCRE_NO_UTF8_CHECK,
1330 * as we do not need to wrap PCRE_NO_UTF8_CHECK. */
1331 if (compile_options & G_REGEX_OPTIMIZE)
1334 /* In GRegex the string are, by default, UTF-8 encoded. PCRE
1335 * instead uses UTF-8 only if required with PCRE_UTF8. */
1336 if (compile_options & G_REGEX_RAW)
1339 compile_options &= ~G_REGEX_RAW;
1344 compile_options |= PCRE_UTF8 | PCRE_NO_UTF8_CHECK;
1345 match_options |= PCRE_NO_UTF8_CHECK;
1348 /* PCRE_NEWLINE_ANY is the default for the internal PCRE but
1349 * not for the system one. */
1350 if (!(compile_options & G_REGEX_NEWLINE_CR) &&
1351 !(compile_options & G_REGEX_NEWLINE_LF))
1353 compile_options |= PCRE_NEWLINE_ANY;
1356 compile_options |= PCRE_UCP;
1358 /* PCRE_BSR_UNICODE is the default for the internal PCRE but
1359 * possibly not for the system one.
1361 if (~compile_options & G_REGEX_BSR_ANYCRLF)
1362 compile_options |= PCRE_BSR_UNICODE;
1364 /* compile the pattern */
1365 re = pcre_compile2 (pattern, compile_options, &errcode,
1366 &errmsg, &erroffset, NULL);
1368 /* if the compilation failed, set the error member and return
1374 /* Translate the PCRE error code to GRegexError and use a translated
1375 * error message if possible */
1376 translate_compile_error (&errcode, &errmsg);
1378 /* PCRE uses byte offsets but we want to show character offsets */
1379 erroffset = g_utf8_pointer_to_offset (pattern, &pattern[erroffset]);
1381 tmp_error = g_error_new (G_REGEX_ERROR, errcode,
1382 _("Error while compiling regular "
1383 "expression %s at char %d: %s"),
1384 pattern, erroffset, errmsg);
1385 g_propagate_error (error, tmp_error);
1390 /* For options set at the beginning of the pattern, pcre puts them into
1391 * compile options, e.g. "(?i)foo" will make the pcre structure store
1392 * PCRE_CASELESS even though it wasn't explicitly given for compilation. */
1393 pcre_fullinfo (re, NULL, PCRE_INFO_OPTIONS, &pcre_compile_options);
1394 compile_options = pcre_compile_options & G_REGEX_COMPILE_PCRE_MASK;
1396 /* Don't leak PCRE_NEWLINE_ANY, which is part of PCRE_NEWLINE_ANYCRLF */
1397 if ((pcre_compile_options & PCRE_NEWLINE_ANYCRLF) != PCRE_NEWLINE_ANYCRLF)
1398 compile_options &= ~PCRE_NEWLINE_ANY;
1400 compile_options |= nonpcre_compile_options;
1402 if (!(compile_options & G_REGEX_DUPNAMES))
1404 gboolean jchanged = FALSE;
1405 pcre_fullinfo (re, NULL, PCRE_INFO_JCHANGED, &jchanged);
1407 compile_options |= G_REGEX_DUPNAMES;
1410 regex = g_new0 (GRegex, 1);
1411 regex->ref_count = 1;
1412 regex->pattern = g_strdup (pattern);
1413 regex->pcre_re = re;
1414 regex->compile_opts = compile_options;
1415 regex->match_opts = match_options;
1419 regex->extra = pcre_study (regex->pcre_re, 0, &errmsg);
1422 GError *tmp_error = g_error_new (G_REGEX_ERROR,
1423 G_REGEX_ERROR_OPTIMIZE,
1424 _("Error while optimizing "
1425 "regular expression %s: %s"),
1428 g_propagate_error (error, tmp_error);
1430 g_regex_unref (regex);
1439 * g_regex_get_pattern:
1440 * @regex: a #GRegex structure
1442 * Gets the pattern string associated with @regex, i.e. a copy of
1443 * the string passed to g_regex_new().
1445 * Returns: the pattern of @regex
1450 g_regex_get_pattern (const GRegex *regex)
1452 g_return_val_if_fail (regex != NULL, NULL);
1454 return regex->pattern;
1458 * g_regex_get_max_backref:
1461 * Returns the number of the highest back reference
1462 * in the pattern, or 0 if the pattern does not contain
1465 * Returns: the number of the highest back reference
1470 g_regex_get_max_backref (const GRegex *regex)
1474 pcre_fullinfo (regex->pcre_re, regex->extra,
1475 PCRE_INFO_BACKREFMAX, &value);
1481 * g_regex_get_capture_count:
1484 * Returns the number of capturing subpatterns in the pattern.
1486 * Returns: the number of capturing subpatterns
1491 g_regex_get_capture_count (const GRegex *regex)
1495 pcre_fullinfo (regex->pcre_re, regex->extra,
1496 PCRE_INFO_CAPTURECOUNT, &value);
1502 * g_regex_get_has_cr_or_lf:
1503 * @regex: a #GRegex structure
1505 * Checks whether the pattern contains explicit CR or LF references.
1507 * Returns: %TRUE if the pattern contains explicit CR or LF references
1512 g_regex_get_has_cr_or_lf (const GRegex *regex)
1516 pcre_fullinfo (regex->pcre_re, regex->extra,
1517 PCRE_INFO_HASCRORLF, &value);
1523 * g_regex_get_compile_flags:
1526 * Returns the compile options that @regex was created with.
1528 * Returns: flags from #GRegexCompileFlags
1533 g_regex_get_compile_flags (const GRegex *regex)
1535 g_return_val_if_fail (regex != NULL, 0);
1537 return regex->compile_opts;
1541 * g_regex_get_match_flags:
1544 * Returns the match options that @regex was created with.
1546 * Returns: flags from #GRegexMatchFlags
1551 g_regex_get_match_flags (const GRegex *regex)
1553 g_return_val_if_fail (regex != NULL, 0);
1555 return regex->match_opts & G_REGEX_MATCH_MASK;
1559 * g_regex_match_simple:
1560 * @pattern: the regular expression
1561 * @string: the string to scan for matches
1562 * @compile_options: compile options for the regular expression, or 0
1563 * @match_options: match options, or 0
1565 * Scans for a match in @string for @pattern.
1567 * This function is equivalent to g_regex_match() but it does not
1568 * require to compile the pattern with g_regex_new(), avoiding some
1569 * lines of code when you need just to do a match without extracting
1570 * substrings, capture counts, and so on.
1572 * If this function is to be called on the same @pattern more than
1573 * once, it's more efficient to compile the pattern once with
1574 * g_regex_new() and then use g_regex_match().
1576 * Returns: %TRUE if the string matched, %FALSE otherwise
1581 g_regex_match_simple (const gchar *pattern,
1582 const gchar *string,
1583 GRegexCompileFlags compile_options,
1584 GRegexMatchFlags match_options)
1589 regex = g_regex_new (pattern, compile_options, 0, NULL);
1592 result = g_regex_match_full (regex, string, -1, 0, match_options, NULL, NULL);
1593 g_regex_unref (regex);
1599 * @regex: a #GRegex structure from g_regex_new()
1600 * @string: the string to scan for matches
1601 * @match_options: match options
1602 * @match_info: (out) (allow-none): pointer to location where to store
1603 * the #GMatchInfo, or %NULL if you do not need it
1605 * Scans for a match in string for the pattern in @regex.
1606 * The @match_options are combined with the match options specified
1607 * when the @regex structure was created, letting you have more
1608 * flexibility in reusing #GRegex structures.
1610 * A #GMatchInfo structure, used to get information on the match,
1611 * is stored in @match_info if not %NULL. Note that if @match_info
1612 * is not %NULL then it is created even if the function returns %FALSE,
1613 * i.e. you must free it regardless if regular expression actually matched.
1615 * To retrieve all the non-overlapping matches of the pattern in
1616 * string you can use g_match_info_next().
1620 * print_uppercase_words (const gchar *string)
1622 * /* Print all uppercase-only words. */
1624 * GMatchInfo *match_info;
1626 * regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1627 * g_regex_match (regex, string, 0, &match_info);
1628 * while (g_match_info_matches (match_info))
1630 * gchar *word = g_match_info_fetch (match_info, 0);
1631 * g_print ("Found: %s\n", word);
1633 * g_match_info_next (match_info, NULL);
1635 * g_match_info_free (match_info);
1636 * g_regex_unref (regex);
1640 * @string is not copied and is used in #GMatchInfo internally. If
1641 * you use any #GMatchInfo method (except g_match_info_free()) after
1642 * freeing or modifying @string then the behaviour is undefined.
1644 * Returns: %TRUE is the string matched, %FALSE otherwise
1649 g_regex_match (const GRegex *regex,
1650 const gchar *string,
1651 GRegexMatchFlags match_options,
1652 GMatchInfo **match_info)
1654 return g_regex_match_full (regex, string, -1, 0, match_options,
1659 * g_regex_match_full:
1660 * @regex: a #GRegex structure from g_regex_new()
1661 * @string: (array length=string_len): the string to scan for matches
1662 * @string_len: the length of @string, or -1 if @string is nul-terminated
1663 * @start_position: starting index of the string to match
1664 * @match_options: match options
1665 * @match_info: (out) (allow-none): pointer to location where to store
1666 * the #GMatchInfo, or %NULL if you do not need it
1667 * @error: location to store the error occurring, or %NULL to ignore errors
1669 * Scans for a match in string for the pattern in @regex.
1670 * The @match_options are combined with the match options specified
1671 * when the @regex structure was created, letting you have more
1672 * flexibility in reusing #GRegex structures.
1674 * Setting @start_position differs from just passing over a shortened
1675 * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1676 * that begins with any kind of lookbehind assertion, such as "\b".
1678 * A #GMatchInfo structure, used to get information on the match, is
1679 * stored in @match_info if not %NULL. Note that if @match_info is
1680 * not %NULL then it is created even if the function returns %FALSE,
1681 * i.e. you must free it regardless if regular expression actually
1684 * @string is not copied and is used in #GMatchInfo internally. If
1685 * you use any #GMatchInfo method (except g_match_info_free()) after
1686 * freeing or modifying @string then the behaviour is undefined.
1688 * To retrieve all the non-overlapping matches of the pattern in
1689 * string you can use g_match_info_next().
1693 * print_uppercase_words (const gchar *string)
1695 * /* Print all uppercase-only words. */
1697 * GMatchInfo *match_info;
1698 * GError *error = NULL;
1700 * regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1701 * g_regex_match_full (regex, string, -1, 0, 0, &match_info, &error);
1702 * while (g_match_info_matches (match_info))
1704 * gchar *word = g_match_info_fetch (match_info, 0);
1705 * g_print ("Found: %s\n", word);
1707 * g_match_info_next (match_info, &error);
1709 * g_match_info_free (match_info);
1710 * g_regex_unref (regex);
1711 * if (error != NULL)
1713 * g_printerr ("Error while matching: %s\n", error->message);
1714 * g_error_free (error);
1719 * Returns: %TRUE is the string matched, %FALSE otherwise
1724 g_regex_match_full (const GRegex *regex,
1725 const gchar *string,
1727 gint start_position,
1728 GRegexMatchFlags match_options,
1729 GMatchInfo **match_info,
1735 g_return_val_if_fail (regex != NULL, FALSE);
1736 g_return_val_if_fail (string != NULL, FALSE);
1737 g_return_val_if_fail (start_position >= 0, FALSE);
1738 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1739 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1741 info = match_info_new (regex, string, string_len, start_position,
1742 match_options, FALSE);
1743 match_ok = g_match_info_next (info, error);
1744 if (match_info != NULL)
1747 g_match_info_free (info);
1753 * g_regex_match_all:
1754 * @regex: a #GRegex structure from g_regex_new()
1755 * @string: the string to scan for matches
1756 * @match_options: match options
1757 * @match_info: (out) (allow-none): pointer to location where to store
1758 * the #GMatchInfo, or %NULL if you do not need it
1760 * Using the standard algorithm for regular expression matching only
1761 * the longest match in the string is retrieved. This function uses
1762 * a different algorithm so it can retrieve all the possible matches.
1763 * For more documentation see g_regex_match_all_full().
1765 * A #GMatchInfo structure, used to get information on the match, is
1766 * stored in @match_info if not %NULL. Note that if @match_info is
1767 * not %NULL then it is created even if the function returns %FALSE,
1768 * i.e. you must free it regardless if regular expression actually
1771 * @string is not copied and is used in #GMatchInfo internally. If
1772 * you use any #GMatchInfo method (except g_match_info_free()) after
1773 * freeing or modifying @string then the behaviour is undefined.
1775 * Returns: %TRUE is the string matched, %FALSE otherwise
1780 g_regex_match_all (const GRegex *regex,
1781 const gchar *string,
1782 GRegexMatchFlags match_options,
1783 GMatchInfo **match_info)
1785 return g_regex_match_all_full (regex, string, -1, 0, match_options,
1790 * g_regex_match_all_full:
1791 * @regex: a #GRegex structure from g_regex_new()
1792 * @string: (array length=string_len): the string to scan for matches
1793 * @string_len: the length of @string, or -1 if @string is nul-terminated
1794 * @start_position: starting index of the string to match
1795 * @match_options: match options
1796 * @match_info: (out) (allow-none): pointer to location where to store
1797 * the #GMatchInfo, or %NULL if you do not need it
1798 * @error: location to store the error occurring, or %NULL to ignore errors
1800 * Using the standard algorithm for regular expression matching only
1801 * the longest match in the string is retrieved, it is not possible
1802 * to obtain all the available matches. For instance matching
1803 * "<a> <b> <c>" against the pattern "<.*>"
1804 * you get "<a> <b> <c>".
1806 * This function uses a different algorithm (called DFA, i.e. deterministic
1807 * finite automaton), so it can retrieve all the possible matches, all
1808 * starting at the same point in the string. For instance matching
1809 * "<a> <b> <c>" against the pattern "<.*>"
1810 * you would obtain three matches: "<a> <b> <c>",
1811 * "<a> <b>" and "<a>".
1813 * The number of matched strings is retrieved using
1814 * g_match_info_get_match_count(). To obtain the matched strings and
1815 * their position you can use, respectively, g_match_info_fetch() and
1816 * g_match_info_fetch_pos(). Note that the strings are returned in
1817 * reverse order of length; that is, the longest matching string is
1820 * Note that the DFA algorithm is slower than the standard one and it
1821 * is not able to capture substrings, so backreferences do not work.
1823 * Setting @start_position differs from just passing over a shortened
1824 * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1825 * that begins with any kind of lookbehind assertion, such as "\b".
1827 * A #GMatchInfo structure, used to get information on the match, is
1828 * stored in @match_info if not %NULL. Note that if @match_info is
1829 * not %NULL then it is created even if the function returns %FALSE,
1830 * i.e. you must free it regardless if regular expression actually
1833 * @string is not copied and is used in #GMatchInfo internally. If
1834 * you use any #GMatchInfo method (except g_match_info_free()) after
1835 * freeing or modifying @string then the behaviour is undefined.
1837 * Returns: %TRUE is the string matched, %FALSE otherwise
1842 g_regex_match_all_full (const GRegex *regex,
1843 const gchar *string,
1845 gint start_position,
1846 GRegexMatchFlags match_options,
1847 GMatchInfo **match_info,
1853 g_return_val_if_fail (regex != NULL, FALSE);
1854 g_return_val_if_fail (string != NULL, FALSE);
1855 g_return_val_if_fail (start_position >= 0, FALSE);
1856 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1857 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1859 info = match_info_new (regex, string, string_len, start_position,
1860 match_options, TRUE);
1866 info->matches = pcre_dfa_exec (regex->pcre_re, regex->extra,
1867 info->string, info->string_len,
1869 regex->match_opts | match_options,
1870 info->offsets, info->n_offsets,
1871 info->workspace, info->n_workspace);
1872 if (info->matches == PCRE_ERROR_DFA_WSSIZE)
1874 /* info->workspace is too small. */
1875 info->n_workspace *= 2;
1876 info->workspace = g_realloc (info->workspace,
1877 info->n_workspace * sizeof (gint));
1880 else if (info->matches == 0)
1882 /* info->offsets is too small. */
1883 info->n_offsets *= 2;
1884 info->offsets = g_realloc (info->offsets,
1885 info->n_offsets * sizeof (gint));
1888 else if (IS_PCRE_ERROR (info->matches))
1890 g_set_error (error, G_REGEX_ERROR, G_REGEX_ERROR_MATCH,
1891 _("Error while matching regular expression %s: %s"),
1892 regex->pattern, match_error (info->matches));
1896 /* set info->pos to -1 so that a call to g_match_info_next() fails. */
1899 if (match_info != NULL)
1902 g_match_info_free (info);
1904 return info->matches >= 0;
1908 * g_regex_get_string_number:
1909 * @regex: #GRegex structure
1910 * @name: name of the subexpression
1912 * Retrieves the number of the subexpression named @name.
1914 * Returns: The number of the subexpression or -1 if @name
1920 g_regex_get_string_number (const GRegex *regex,
1925 g_return_val_if_fail (regex != NULL, -1);
1926 g_return_val_if_fail (name != NULL, -1);
1928 num = pcre_get_stringnumber (regex->pcre_re, name);
1929 if (num == PCRE_ERROR_NOSUBSTRING)
1936 * g_regex_split_simple:
1937 * @pattern: the regular expression
1938 * @string: the string to scan for matches
1939 * @compile_options: compile options for the regular expression, or 0
1940 * @match_options: match options, or 0
1942 * Breaks the string on the pattern, and returns an array of
1943 * the tokens. If the pattern contains capturing parentheses,
1944 * then the text for each of the substrings will also be returned.
1945 * If the pattern does not match anywhere in the string, then the
1946 * whole string is returned as the first token.
1948 * This function is equivalent to g_regex_split() but it does
1949 * not require to compile the pattern with g_regex_new(), avoiding
1950 * some lines of code when you need just to do a split without
1951 * extracting substrings, capture counts, and so on.
1953 * If this function is to be called on the same @pattern more than
1954 * once, it's more efficient to compile the pattern once with
1955 * g_regex_new() and then use g_regex_split().
1957 * As a special case, the result of splitting the empty string ""
1958 * is an empty vector, not a vector containing a single string.
1959 * The reason for this special case is that being able to represent
1960 * a empty vector is typically more useful than consistent handling
1961 * of empty elements. If you do need to represent empty elements,
1962 * you'll need to check for the empty string before calling this
1965 * A pattern that can match empty strings splits @string into
1966 * separate characters wherever it matches the empty string between
1967 * characters. For example splitting "ab c" using as a separator
1968 * "\s*", you will get "a", "b" and "c".
1970 * Returns: (transfer full): a %NULL-terminated array of strings. Free
1971 * it using g_strfreev()
1976 g_regex_split_simple (const gchar *pattern,
1977 const gchar *string,
1978 GRegexCompileFlags compile_options,
1979 GRegexMatchFlags match_options)
1984 regex = g_regex_new (pattern, compile_options, 0, NULL);
1988 result = g_regex_split_full (regex, string, -1, 0, match_options, 0, NULL);
1989 g_regex_unref (regex);
1995 * @regex: a #GRegex structure
1996 * @string: the string to split with the pattern
1997 * @match_options: match time option flags
1999 * Breaks the string on the pattern, and returns an array of the tokens.
2000 * If the pattern contains capturing parentheses, then the text for each
2001 * of the substrings will also be returned. If the pattern does not match
2002 * anywhere in the string, then the whole string is returned as the first
2005 * As a special case, the result of splitting the empty string "" is an
2006 * empty vector, not a vector containing a single string. The reason for
2007 * this special case is that being able to represent a empty vector is
2008 * typically more useful than consistent handling of empty elements. If
2009 * you do need to represent empty elements, you'll need to check for the
2010 * empty string before calling this function.
2012 * A pattern that can match empty strings splits @string into separate
2013 * characters wherever it matches the empty string between characters.
2014 * For example splitting "ab c" using as a separator "\s*", you will get
2017 * Returns: (transfer full): a %NULL-terminated gchar ** array. Free
2018 * it using g_strfreev()
2023 g_regex_split (const GRegex *regex,
2024 const gchar *string,
2025 GRegexMatchFlags match_options)
2027 return g_regex_split_full (regex, string, -1, 0,
2028 match_options, 0, NULL);
2032 * g_regex_split_full:
2033 * @regex: a #GRegex structure
2034 * @string: (array length=string_len): the string to split with the pattern
2035 * @string_len: the length of @string, or -1 if @string is nul-terminated
2036 * @start_position: starting index of the string to match
2037 * @match_options: match time option flags
2038 * @max_tokens: the maximum number of tokens to split @string into.
2039 * If this is less than 1, the string is split completely
2040 * @error: return location for a #GError
2042 * Breaks the string on the pattern, and returns an array of the tokens.
2043 * If the pattern contains capturing parentheses, then the text for each
2044 * of the substrings will also be returned. If the pattern does not match
2045 * anywhere in the string, then the whole string is returned as the first
2048 * As a special case, the result of splitting the empty string "" is an
2049 * empty vector, not a vector containing a single string. The reason for
2050 * this special case is that being able to represent a empty vector is
2051 * typically more useful than consistent handling of empty elements. If
2052 * you do need to represent empty elements, you'll need to check for the
2053 * empty string before calling this function.
2055 * A pattern that can match empty strings splits @string into separate
2056 * characters wherever it matches the empty string between characters.
2057 * For example splitting "ab c" using as a separator "\s*", you will get
2060 * Setting @start_position differs from just passing over a shortened
2061 * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
2062 * that begins with any kind of lookbehind assertion, such as "\b".
2064 * Returns: (transfer full): a %NULL-terminated gchar ** array. Free
2065 * it using g_strfreev()
2070 g_regex_split_full (const GRegex *regex,
2071 const gchar *string,
2073 gint start_position,
2074 GRegexMatchFlags match_options,
2078 GError *tmp_error = NULL;
2079 GMatchInfo *match_info;
2084 /* position of the last separator. */
2085 gint last_separator_end;
2086 /* was the last match 0 bytes long? */
2087 gboolean last_match_is_empty;
2088 /* the returned array of char **s */
2089 gchar **string_list;
2091 g_return_val_if_fail (regex != NULL, NULL);
2092 g_return_val_if_fail (string != NULL, NULL);
2093 g_return_val_if_fail (start_position >= 0, NULL);
2094 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2095 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2097 if (max_tokens <= 0)
2098 max_tokens = G_MAXINT;
2101 string_len = strlen (string);
2103 /* zero-length string */
2104 if (string_len - start_position == 0)
2105 return g_new0 (gchar *, 1);
2107 if (max_tokens == 1)
2109 string_list = g_new0 (gchar *, 2);
2110 string_list[0] = g_strndup (&string[start_position],
2111 string_len - start_position);
2117 last_separator_end = start_position;
2118 last_match_is_empty = FALSE;
2120 match_ok = g_regex_match_full (regex, string, string_len, start_position,
2121 match_options, &match_info, &tmp_error);
2123 while (tmp_error == NULL)
2127 last_match_is_empty =
2128 (match_info->offsets[0] == match_info->offsets[1]);
2130 /* we need to skip empty separators at the same position of the end
2131 * of another separator. e.g. the string is "a b" and the separator
2132 * is " *", so from 1 to 2 we have a match and at position 2 we have
2133 * an empty match. */
2134 if (last_separator_end != match_info->offsets[1])
2139 token = g_strndup (string + last_separator_end,
2140 match_info->offsets[0] - last_separator_end);
2141 list = g_list_prepend (list, token);
2144 /* if there were substrings, these need to be added to
2146 match_count = g_match_info_get_match_count (match_info);
2147 if (match_count > 1)
2149 for (i = 1; i < match_count; i++)
2150 list = g_list_prepend (list, g_match_info_fetch (match_info, i));
2156 /* if there was no match, copy to end of string. */
2157 if (!last_match_is_empty)
2159 gchar *token = g_strndup (string + last_separator_end,
2160 match_info->string_len - last_separator_end);
2161 list = g_list_prepend (list, token);
2163 /* no more tokens, end the loop. */
2167 /* -1 to leave room for the last part. */
2168 if (token_count >= max_tokens - 1)
2170 /* we have reached the maximum number of tokens, so we copy
2171 * the remaining part of the string. */
2172 if (last_match_is_empty)
2174 /* the last match was empty, so we have moved one char
2175 * after the real position to avoid empty matches at the
2177 match_info->pos = PREV_CHAR (regex, &string[match_info->pos]) - string;
2179 /* the if is needed in the case we have terminated the available
2180 * tokens, but we are at the end of the string, so there are no
2181 * characters left to copy. */
2182 if (string_len > match_info->pos)
2184 gchar *token = g_strndup (string + match_info->pos,
2185 string_len - match_info->pos);
2186 list = g_list_prepend (list, token);
2192 last_separator_end = match_info->pos;
2193 if (last_match_is_empty)
2194 /* if the last match was empty, g_match_info_next() has moved
2195 * forward to avoid infinite loops, but we still need to copy that
2197 last_separator_end = PREV_CHAR (regex, &string[last_separator_end]) - string;
2199 match_ok = g_match_info_next (match_info, &tmp_error);
2201 g_match_info_free (match_info);
2202 if (tmp_error != NULL)
2204 g_propagate_error (error, tmp_error);
2205 g_list_free_full (list, g_free);
2206 match_info->pos = -1;
2210 string_list = g_new (gchar *, g_list_length (list) + 1);
2212 for (last = g_list_last (list); last; last = g_list_previous (last))
2213 string_list[i++] = last->data;
2214 string_list[i] = NULL;
2223 REPL_TYPE_CHARACTER,
2224 REPL_TYPE_SYMBOLIC_REFERENCE,
2225 REPL_TYPE_NUMERIC_REFERENCE,
2226 REPL_TYPE_CHANGE_CASE
2231 CHANGE_CASE_NONE = 1 << 0,
2232 CHANGE_CASE_UPPER = 1 << 1,
2233 CHANGE_CASE_LOWER = 1 << 2,
2234 CHANGE_CASE_UPPER_SINGLE = 1 << 3,
2235 CHANGE_CASE_LOWER_SINGLE = 1 << 4,
2236 CHANGE_CASE_SINGLE_MASK = CHANGE_CASE_UPPER_SINGLE | CHANGE_CASE_LOWER_SINGLE,
2237 CHANGE_CASE_LOWER_MASK = CHANGE_CASE_LOWER | CHANGE_CASE_LOWER_SINGLE,
2238 CHANGE_CASE_UPPER_MASK = CHANGE_CASE_UPPER | CHANGE_CASE_UPPER_SINGLE
2241 struct _InterpolationData
2247 ChangeCase change_case;
2251 free_interpolation_data (InterpolationData *data)
2253 g_free (data->text);
2257 static const gchar *
2258 expand_escape (const gchar *replacement,
2260 InterpolationData *data,
2265 const gchar *error_detail;
2267 GError *tmp_error = NULL;
2275 data->type = REPL_TYPE_CHARACTER;
2280 data->type = REPL_TYPE_CHARACTER;
2285 data->type = REPL_TYPE_CHARACTER;
2290 data->type = REPL_TYPE_CHARACTER;
2295 data->type = REPL_TYPE_CHARACTER;
2300 data->type = REPL_TYPE_CHARACTER;
2305 data->type = REPL_TYPE_CHARACTER;
2310 data->type = REPL_TYPE_CHARACTER;
2320 h = g_ascii_xdigit_value (*p);
2323 error_detail = _("hexadecimal digit or '}' expected");
2334 for (i = 0; i < 2; i++)
2336 h = g_ascii_xdigit_value (*p);
2339 error_detail = _("hexadecimal digit expected");
2346 data->type = REPL_TYPE_STRING;
2347 data->text = g_new0 (gchar, 8);
2348 g_unichar_to_utf8 (x, data->text);
2352 data->type = REPL_TYPE_CHANGE_CASE;
2353 data->change_case = CHANGE_CASE_LOWER_SINGLE;
2357 data->type = REPL_TYPE_CHANGE_CASE;
2358 data->change_case = CHANGE_CASE_UPPER_SINGLE;
2362 data->type = REPL_TYPE_CHANGE_CASE;
2363 data->change_case = CHANGE_CASE_LOWER;
2367 data->type = REPL_TYPE_CHANGE_CASE;
2368 data->change_case = CHANGE_CASE_UPPER;
2372 data->type = REPL_TYPE_CHANGE_CASE;
2373 data->change_case = CHANGE_CASE_NONE;
2379 error_detail = _("missing '<' in symbolic reference");
2388 error_detail = _("unfinished symbolic reference");
2395 error_detail = _("zero-length symbolic reference");
2398 if (g_ascii_isdigit (*q))
2403 h = g_ascii_digit_value (*q);
2406 error_detail = _("digit expected");
2415 data->type = REPL_TYPE_NUMERIC_REFERENCE;
2422 if (!g_ascii_isalnum (*r))
2424 error_detail = _("illegal symbolic reference");
2431 data->text = g_strndup (q, p - q);
2432 data->type = REPL_TYPE_SYMBOLIC_REFERENCE;
2437 /* if \0 is followed by a number is an octal number representing a
2438 * character, else it is a numeric reference. */
2439 if (g_ascii_digit_value (*g_utf8_next_char (p)) >= 0)
2442 p = g_utf8_next_char (p);
2455 for (i = 0; i < 3; i++)
2457 h = g_ascii_digit_value (*p);
2467 if (i == 2 && base == 10)
2473 if (base == 8 || i == 3)
2475 data->type = REPL_TYPE_STRING;
2476 data->text = g_new0 (gchar, 8);
2477 g_unichar_to_utf8 (x, data->text);
2481 data->type = REPL_TYPE_NUMERIC_REFERENCE;
2486 error_detail = _("stray final '\\'");
2490 error_detail = _("unknown escape sequence");
2497 /* G_GSSIZE_FORMAT doesn't work with gettext, so we use %lu */
2498 tmp_error = g_error_new (G_REGEX_ERROR,
2499 G_REGEX_ERROR_REPLACE,
2500 _("Error while parsing replacement "
2501 "text \"%s\" at char %lu: %s"),
2503 (gulong)(p - replacement),
2505 g_propagate_error (error, tmp_error);
2511 split_replacement (const gchar *replacement,
2515 InterpolationData *data;
2516 const gchar *p, *start;
2518 start = p = replacement;
2523 data = g_new0 (InterpolationData, 1);
2524 start = p = expand_escape (replacement, p, data, error);
2527 g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2528 free_interpolation_data (data);
2532 list = g_list_prepend (list, data);
2537 if (*p == '\\' || *p == '\0')
2541 data = g_new0 (InterpolationData, 1);
2542 data->text = g_strndup (start, p - start);
2543 data->type = REPL_TYPE_STRING;
2544 list = g_list_prepend (list, data);
2550 return g_list_reverse (list);
2553 /* Change the case of c based on change_case. */
2554 #define CHANGE_CASE(c, change_case) \
2555 (((change_case) & CHANGE_CASE_LOWER_MASK) ? \
2556 g_unichar_tolower (c) : \
2557 g_unichar_toupper (c))
2560 string_append (GString *string,
2562 ChangeCase *change_case)
2566 if (text[0] == '\0')
2569 if (*change_case == CHANGE_CASE_NONE)
2571 g_string_append (string, text);
2573 else if (*change_case & CHANGE_CASE_SINGLE_MASK)
2575 c = g_utf8_get_char (text);
2576 g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2577 g_string_append (string, g_utf8_next_char (text));
2578 *change_case = CHANGE_CASE_NONE;
2582 while (*text != '\0')
2584 c = g_utf8_get_char (text);
2585 g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2586 text = g_utf8_next_char (text);
2592 interpolate_replacement (const GMatchInfo *match_info,
2597 InterpolationData *idata;
2599 ChangeCase change_case = CHANGE_CASE_NONE;
2601 for (list = data; list; list = list->next)
2604 switch (idata->type)
2606 case REPL_TYPE_STRING:
2607 string_append (result, idata->text, &change_case);
2609 case REPL_TYPE_CHARACTER:
2610 g_string_append_c (result, CHANGE_CASE (idata->c, change_case));
2611 if (change_case & CHANGE_CASE_SINGLE_MASK)
2612 change_case = CHANGE_CASE_NONE;
2614 case REPL_TYPE_NUMERIC_REFERENCE:
2615 match = g_match_info_fetch (match_info, idata->num);
2618 string_append (result, match, &change_case);
2622 case REPL_TYPE_SYMBOLIC_REFERENCE:
2623 match = g_match_info_fetch_named (match_info, idata->text);
2626 string_append (result, match, &change_case);
2630 case REPL_TYPE_CHANGE_CASE:
2631 change_case = idata->change_case;
2639 /* whether actual match_info is needed for replacement, i.e.
2640 * whether there are references
2643 interpolation_list_needs_match (GList *list)
2645 while (list != NULL)
2647 InterpolationData *data = list->data;
2649 if (data->type == REPL_TYPE_SYMBOLIC_REFERENCE ||
2650 data->type == REPL_TYPE_NUMERIC_REFERENCE)
2663 * @regex: a #GRegex structure
2664 * @string: (array length=string_len): the string to perform matches against
2665 * @string_len: the length of @string, or -1 if @string is nul-terminated
2666 * @start_position: starting index of the string to match
2667 * @replacement: text to replace each match with
2668 * @match_options: options for the match
2669 * @error: location to store the error occurring, or %NULL to ignore errors
2671 * Replaces all occurrences of the pattern in @regex with the
2672 * replacement text. Backreferences of the form '\number' or
2673 * '\g<number>' in the replacement text are interpolated by the
2674 * number-th captured subexpression of the match, '\g<name>' refers
2675 * to the captured subexpression with the given name. '\0' refers to the
2676 * complete match, but '\0' followed by a number is the octal representation
2677 * of a character. To include a literal '\' in the replacement, write '\\'.
2678 * There are also escapes that changes the case of the following text:
2681 * <varlistentry><term>\l</term>
2683 * <para>Convert to lower case the next character</para>
2686 * <varlistentry><term>\u</term>
2688 * <para>Convert to upper case the next character</para>
2691 * <varlistentry><term>\L</term>
2693 * <para>Convert to lower case till \E</para>
2696 * <varlistentry><term>\U</term>
2698 * <para>Convert to upper case till \E</para>
2701 * <varlistentry><term>\E</term>
2703 * <para>End case modification</para>
2708 * If you do not need to use backreferences use g_regex_replace_literal().
2710 * The @replacement string must be UTF-8 encoded even if #G_REGEX_RAW was
2711 * passed to g_regex_new(). If you want to use not UTF-8 encoded stings
2712 * you can use g_regex_replace_literal().
2714 * Setting @start_position differs from just passing over a shortened
2715 * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that
2716 * begins with any kind of lookbehind assertion, such as "\b".
2718 * Returns: a newly allocated string containing the replacements
2723 g_regex_replace (const GRegex *regex,
2724 const gchar *string,
2726 gint start_position,
2727 const gchar *replacement,
2728 GRegexMatchFlags match_options,
2733 GError *tmp_error = NULL;
2735 g_return_val_if_fail (regex != NULL, NULL);
2736 g_return_val_if_fail (string != NULL, NULL);
2737 g_return_val_if_fail (start_position >= 0, NULL);
2738 g_return_val_if_fail (replacement != NULL, NULL);
2739 g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2740 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2742 list = split_replacement (replacement, &tmp_error);
2743 if (tmp_error != NULL)
2745 g_propagate_error (error, tmp_error);
2749 result = g_regex_replace_eval (regex,
2750 string, string_len, start_position,
2752 interpolate_replacement,
2755 if (tmp_error != NULL)
2756 g_propagate_error (error, tmp_error);
2758 g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2764 literal_replacement (const GMatchInfo *match_info,
2768 g_string_append (result, data);
2773 * g_regex_replace_literal:
2774 * @regex: a #GRegex structure
2775 * @string: (array length=string_len): the string to perform matches against
2776 * @string_len: the length of @string, or -1 if @string is nul-terminated
2777 * @start_position: starting index of the string to match
2778 * @replacement: text to replace each match with
2779 * @match_options: options for the match
2780 * @error: location to store the error occurring, or %NULL to ignore errors
2782 * Replaces all occurrences of the pattern in @regex with the
2783 * replacement text. @replacement is replaced literally, to
2784 * include backreferences use g_regex_replace().
2786 * Setting @start_position differs from just passing over a
2787 * shortened string and setting #G_REGEX_MATCH_NOTBOL in the
2788 * case of a pattern that begins with any kind of lookbehind
2789 * assertion, such as "\b".
2791 * Returns: a newly allocated string containing the replacements
2796 g_regex_replace_literal (const GRegex *regex,
2797 const gchar *string,
2799 gint start_position,
2800 const gchar *replacement,
2801 GRegexMatchFlags match_options,
2804 g_return_val_if_fail (replacement != NULL, NULL);
2805 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2807 return g_regex_replace_eval (regex,
2808 string, string_len, start_position,
2810 literal_replacement,
2811 (gpointer)replacement,
2816 * g_regex_replace_eval:
2817 * @regex: a #GRegex structure from g_regex_new()
2818 * @string: (array length=string_len): string to perform matches against
2819 * @string_len: the length of @string, or -1 if @string is nul-terminated
2820 * @start_position: starting index of the string to match
2821 * @match_options: options for the match
2822 * @eval: a function to call for each match
2823 * @user_data: user data to pass to the function
2824 * @error: location to store the error occurring, or %NULL to ignore errors
2826 * Replaces occurrences of the pattern in regex with the output of
2827 * @eval for that occurrence.
2829 * Setting @start_position differs from just passing over a shortened
2830 * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
2831 * that begins with any kind of lookbehind assertion, such as "\b".
2833 * The following example uses g_regex_replace_eval() to replace multiple
2837 * eval_cb (const GMatchInfo *info,
2844 * match = g_match_info_fetch (info, 0);
2845 * r = g_hash_table_lookup ((GHashTable *)data, match);
2846 * g_string_append (res, r);
2858 * h = g_hash_table_new (g_str_hash, g_str_equal);
2860 * g_hash_table_insert (h, "1", "ONE");
2861 * g_hash_table_insert (h, "2", "TWO");
2862 * g_hash_table_insert (h, "3", "THREE");
2863 * g_hash_table_insert (h, "4", "FOUR");
2865 * reg = g_regex_new ("1|2|3|4", 0, 0, NULL);
2866 * res = g_regex_replace_eval (reg, text, -1, 0, 0, eval_cb, h, NULL);
2867 * g_hash_table_destroy (h);
2872 * Returns: a newly allocated string containing the replacements
2877 g_regex_replace_eval (const GRegex *regex,
2878 const gchar *string,
2880 gint start_position,
2881 GRegexMatchFlags match_options,
2882 GRegexEvalCallback eval,
2886 GMatchInfo *match_info;
2889 gboolean done = FALSE;
2890 GError *tmp_error = NULL;
2892 g_return_val_if_fail (regex != NULL, NULL);
2893 g_return_val_if_fail (string != NULL, NULL);
2894 g_return_val_if_fail (start_position >= 0, NULL);
2895 g_return_val_if_fail (eval != NULL, NULL);
2896 g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2899 string_len = strlen (string);
2901 result = g_string_sized_new (string_len);
2903 /* run down the string making matches. */
2904 g_regex_match_full (regex, string, string_len, start_position,
2905 match_options, &match_info, &tmp_error);
2906 while (!done && g_match_info_matches (match_info))
2908 g_string_append_len (result,
2910 match_info->offsets[0] - str_pos);
2911 done = (*eval) (match_info, result, user_data);
2912 str_pos = match_info->offsets[1];
2913 g_match_info_next (match_info, &tmp_error);
2915 g_match_info_free (match_info);
2916 if (tmp_error != NULL)
2918 g_propagate_error (error, tmp_error);
2919 g_string_free (result, TRUE);
2923 g_string_append_len (result, string + str_pos, string_len - str_pos);
2924 return g_string_free (result, FALSE);
2928 * g_regex_check_replacement:
2929 * @replacement: the replacement string
2930 * @has_references: (out) (allow-none): location to store information about
2931 * references in @replacement or %NULL
2932 * @error: location to store error
2934 * Checks whether @replacement is a valid replacement string
2935 * (see g_regex_replace()), i.e. that all escape sequences in
2938 * If @has_references is not %NULL then @replacement is checked
2939 * for pattern references. For instance, replacement text 'foo\n'
2940 * does not contain references and may be evaluated without information
2941 * about actual match, but '\0\1' (whole match followed by first
2942 * subpattern) requires valid #GMatchInfo object.
2944 * Returns: whether @replacement is a valid replacement string
2949 g_regex_check_replacement (const gchar *replacement,
2950 gboolean *has_references,
2956 list = split_replacement (replacement, &tmp);
2960 g_propagate_error (error, tmp);
2965 *has_references = interpolation_list_needs_match (list);
2967 g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2973 * g_regex_escape_nul:
2974 * @string: the string to escape
2975 * @length: the length of @string
2977 * Escapes the nul characters in @string to "\x00". It can be used
2978 * to compile a regex with embedded nul characters.
2980 * For completeness, @length can be -1 for a nul-terminated string.
2981 * In this case the output string will be of course equal to @string.
2983 * Returns: a newly-allocated escaped string
2988 g_regex_escape_nul (const gchar *string,
2992 const gchar *p, *piece_start, *end;
2995 g_return_val_if_fail (string != NULL, NULL);
2998 return g_strdup (string);
3000 end = string + length;
3001 p = piece_start = string;
3002 escaped = g_string_sized_new (length + 1);
3010 if (p != piece_start)
3012 /* copy the previous piece. */
3013 g_string_append_len (escaped, piece_start, p - piece_start);
3015 if ((backslashes & 1) == 0)
3016 g_string_append_c (escaped, '\\');
3017 g_string_append_c (escaped, 'x');
3018 g_string_append_c (escaped, '0');
3019 g_string_append_c (escaped, '0');
3029 p = g_utf8_next_char (p);
3034 if (piece_start < end)
3035 g_string_append_len (escaped, piece_start, end - piece_start);
3037 return g_string_free (escaped, FALSE);
3041 * g_regex_escape_string:
3042 * @string: (array length=length): the string to escape
3043 * @length: the length of @string, or -1 if @string is nul-terminated
3045 * Escapes the special characters used for regular expressions
3046 * in @string, for instance "a.b*c" becomes "a\.b\*c". This
3047 * function is useful to dynamically generate regular expressions.
3049 * @string can contain nul characters that are replaced with "\0",
3050 * in this case remember to specify the correct length of @string
3053 * Returns: a newly-allocated escaped string
3058 g_regex_escape_string (const gchar *string,
3062 const char *p, *piece_start, *end;
3064 g_return_val_if_fail (string != NULL, NULL);
3067 length = strlen (string);
3069 end = string + length;
3070 p = piece_start = string;
3071 escaped = g_string_sized_new (length + 1);
3092 if (p != piece_start)
3093 /* copy the previous piece. */
3094 g_string_append_len (escaped, piece_start, p - piece_start);
3095 g_string_append_c (escaped, '\\');
3097 g_string_append_c (escaped, '0');
3099 g_string_append_c (escaped, *p);
3103 p = g_utf8_next_char (p);
3108 if (piece_start < end)
3109 g_string_append_len (escaped, piece_start, end - piece_start);
3111 return g_string_free (escaped, FALSE);