glib/gregex.c

   1 /* GRegex -- regular expression API wrapper around PCRE.
   2  *
   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>
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 #include "config.h"
  23
  24 #include <string.h>
  25
  26 #ifdef USE_SYSTEM_PCRE
  27 #include <pcre.h>
  28 #else
  29 #include "pcre/pcre.h"
  30 #endif
  31
  32 #include "gtypes.h"
  33 #include "gregex.h"
  34 #include "glibintl.h"
  35 #include "glist.h"
  36 #include "gmessages.h"
  37 #include "gstrfuncs.h"
  38 #include "gatomic.h"
  39 #include "gthread.h"
  40
  41 /**
  42  * SECTION:gregex
  43  * @title: Perl-compatible regular expressions
  44  * @short_description: matches strings against regular expressions
  45  * @see_also: <xref linkend="glib-regex-syntax"/>
  46  *
  47  * The <function>g_regex_*()</function> functions implement regular
  48  * expression pattern matching using syntax and semantics similar to
  49  * Perl regular expression.
  50  *
  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.
  63  *
  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. "&agrave;") 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.
  71  *
  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).
  79  *
  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.
  90  *
  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.
 102  *
 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
 106  * is not threadsafe.
 107  *
 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.
 111  */
 112
 113 /* Mask of all the possible values for GRegexCompileFlags. */
 114 #define G_REGEX_COMPILE_MASK (G_REGEX_CASELESS          | \
 115                               G_REGEX_MULTILINE         | \
 116                               G_REGEX_DOTALL            | \
 117                               G_REGEX_EXTENDED          | \
 118                               G_REGEX_ANCHORED          | \
 119                               G_REGEX_DOLLAR_ENDONLY    | \
 120                               G_REGEX_UNGREEDY          | \
 121                               G_REGEX_RAW               | \
 122                               G_REGEX_NO_AUTO_CAPTURE   | \
 123                               G_REGEX_OPTIMIZE          | \
 124                               G_REGEX_FIRSTLINE         | \
 125                               G_REGEX_DUPNAMES          | \
 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)
 132
 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              | \
 136                                       G_REGEX_OPTIMIZE)
 137
 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)
 154
 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);
 172
 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);
 188
 189 /* These PCRE flags are unused or not exposed publically in GRegexFlags, so
 190  * it should be ok to reuse them for different things.
 191  */
 192 G_STATIC_ASSERT (G_REGEX_OPTIMIZE          == PCRE_NO_UTF8_CHECK);
 193 G_STATIC_ASSERT (G_REGEX_RAW               == PCRE_UTF8);
 194
 195 /* if the string is in UTF-8 use g_utf8_ functions, else use
 196  * use just +/- 1. */
 197 #define NEXT_CHAR(re, s) (((re)->compile_opts & G_REGEX_RAW) ? \
 198                                 ((s) + 1) : \
 199                                 g_utf8_next_char (s))
 200 #define PREV_CHAR(re, s) (((re)->compile_opts & G_REGEX_RAW) ? \
 201                                 ((s) - 1) : \
 202                                 g_utf8_prev_char (s))
 203
 204 struct _GMatchInfo
 205 {
 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 */
 217 };
 218
 219 struct _GRegex
 220 {
 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 */
 227 };
 228
 229 /* TRUE if ret is an error code, FALSE otherwise. */
 230 #define IS_PCRE_ERROR(ret) ((ret) < PCRE_ERROR_NOMATCH && (ret) != PCRE_ERROR_PARTIAL)
 231
 232 typedef struct _InterpolationData InterpolationData;
 233 static gboolean  interpolation_list_needs_match (GList *list);
 234 static gboolean  interpolate_replacement        (const GMatchInfo *match_info,
 235                                                  GString *result,
 236                                                  gpointer data);
 237 static GList    *split_replacement              (const gchar *replacement,
 238                                                  GError **error);
 239 static void      free_interpolation_data        (InterpolationData *data);
 240
 241
 242 static const gchar *
 243 match_error (gint errcode)
 244 {
 245   switch (errcode)
 246     {
 247     case PCRE_ERROR_NOMATCH:
 248       /* not an error */
 249       break;
 250     case PCRE_ERROR_NULL:
 251       /* NULL argument, this should not happen in GRegex */
 252       g_warning ("A NULL argument was passed to PCRE");
 253       break;
 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() */
 264       break;
 265     case PCRE_ERROR_MATCHLIMIT:
 266       return _("backtracking limit reached");
 267     case PCRE_ERROR_CALLOUT:
 268       /* callouts are not implemented */
 269       break;
 270     case PCRE_ERROR_BADUTF8:
 271     case PCRE_ERROR_BADUTF8_OFFSET:
 272       /* we do not check if strings are valid */
 273       break;
 274     case PCRE_ERROR_PARTIAL:
 275       /* not an error */
 276       break;
 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");
 284       break;
 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 */
 291       break;
 292     case PCRE_ERROR_DFA_WSSIZE:
 293       /* handled expanding the workspace */
 294       break;
 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");
 306     default:
 307       break;
 308     }
 309   return _("unknown error");
 310 }
 311
 312 static void
 313 translate_compile_error (gint *errcode, const gchar **errmsg)
 314 {
 315   /* Compile errors are created adding 100 to the error code returned
 316    * by PCRE.
 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.
 323    */
 324   *errcode += 100;
 325
 326   switch (*errcode)
 327     {
 328     case G_REGEX_ERROR_STRAY_BACKSLASH:
 329       *errmsg = _("\\ at end of pattern");
 330       break;
 331     case G_REGEX_ERROR_MISSING_CONTROL_CHAR:
 332       *errmsg = _("\\c at end of pattern");
 333       break;
 334     case G_REGEX_ERROR_UNRECOGNIZED_ESCAPE:
 335       *errmsg = _("unrecognized character following \\");
 336       break;
 337     case G_REGEX_ERROR_QUANTIFIERS_OUT_OF_ORDER:
 338       *errmsg = _("numbers out of order in {} quantifier");
 339       break;
 340     case G_REGEX_ERROR_QUANTIFIER_TOO_BIG:
 341       *errmsg = _("number too big in {} quantifier");
 342       break;
 343     case G_REGEX_ERROR_UNTERMINATED_CHARACTER_CLASS:
 344       *errmsg = _("missing terminating ] for character class");
 345       break;
 346     case G_REGEX_ERROR_INVALID_ESCAPE_IN_CHARACTER_CLASS:
 347       *errmsg = _("invalid escape sequence in character class");
 348       break;
 349     case G_REGEX_ERROR_RANGE_OUT_OF_ORDER:
 350       *errmsg = _("range out of order in character class");
 351       break;
 352     case G_REGEX_ERROR_NOTHING_TO_REPEAT:
 353       *errmsg = _("nothing to repeat");
 354       break;
 355     case 111: /* internal error: unexpected repeat */
 356       *errcode = G_REGEX_ERROR_INTERNAL;
 357       *errmsg = _("unexpected repeat");
 358       break;
 359     case G_REGEX_ERROR_UNRECOGNIZED_CHARACTER:
 360       *errmsg = _("unrecognized character after (? or (?-");
 361       break;
 362     case G_REGEX_ERROR_POSIX_NAMED_CLASS_OUTSIDE_CLASS:
 363       *errmsg = _("POSIX named classes are supported only within a class");
 364       break;
 365     case G_REGEX_ERROR_UNMATCHED_PARENTHESIS:
 366       *errmsg = _("missing terminating )");
 367       break;
 368     case G_REGEX_ERROR_INEXISTENT_SUBPATTERN_REFERENCE:
 369       *errmsg = _("reference to non-existent subpattern");
 370       break;
 371     case G_REGEX_ERROR_UNTERMINATED_COMMENT:
 372       *errmsg = _("missing ) after comment");
 373       break;
 374     case G_REGEX_ERROR_EXPRESSION_TOO_LARGE:
 375       *errmsg = _("regular expression is too large");
 376       break;
 377     case G_REGEX_ERROR_MEMORY_ERROR:
 378       *errmsg = _("failed to get memory");
 379       break;
 380     case 122: /* unmatched parentheses */
 381       *errcode = G_REGEX_ERROR_UNMATCHED_PARENTHESIS;
 382       *errmsg = _(") without opening (");
 383       break;
 384     case 123: /* internal error: code overflow */
 385       *errcode = G_REGEX_ERROR_INTERNAL;
 386       *errmsg = _("code overflow");
 387       break;
 388     case 124: /* "unrecognized character after (?<\0 */
 389       *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
 390       *errmsg = _("unrecognized character after (?<");
 391       break;
 392     case G_REGEX_ERROR_VARIABLE_LENGTH_LOOKBEHIND:
 393       *errmsg = _("lookbehind assertion is not fixed length");
 394       break;
 395     case G_REGEX_ERROR_MALFORMED_CONDITION:
 396       *errmsg = _("malformed number or name after (?(");
 397       break;
 398     case G_REGEX_ERROR_TOO_MANY_CONDITIONAL_BRANCHES:
 399       *errmsg = _("conditional group contains more than two branches");
 400       break;
 401     case G_REGEX_ERROR_ASSERTION_EXPECTED:
 402       *errmsg = _("assertion expected after (?(");
 403       break;
 404     case 129:
 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.
 408        */
 409       *errmsg = _("(?R or (?[+-]digits must be followed by )");
 410       break;
 411     case G_REGEX_ERROR_UNKNOWN_POSIX_CLASS_NAME:
 412       *errmsg = _("unknown POSIX class name");
 413       break;
 414     case G_REGEX_ERROR_POSIX_COLLATING_ELEMENTS_NOT_SUPPORTED:
 415       *errmsg = _("POSIX collating elements are not supported");
 416       break;
 417     case G_REGEX_ERROR_HEX_CODE_TOO_LARGE:
 418       *errmsg = _("character value in \\x{...} sequence is too large");
 419       break;
 420     case G_REGEX_ERROR_INVALID_CONDITION:
 421       *errmsg = _("invalid condition (?(0)");
 422       break;
 423     case G_REGEX_ERROR_SINGLE_BYTE_MATCH_IN_LOOKBEHIND:
 424       *errmsg = _("\\C not allowed in lookbehind assertion");
 425       break;
 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.
 429        */
 430       *errcode = G_REGEX_ERROR_UNRECOGNIZED_ESCAPE;
 431       *errmsg = _("escapes \\L, \\l, \\N{name}, \\U, and \\u are not supported");
 432       break;
 433     case G_REGEX_ERROR_INFINITE_LOOP:
 434       *errmsg = _("recursive call could loop indefinitely");
 435       break;
 436     case 141: /* unrecognized character after (?P\0 */
 437       *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
 438       *errmsg = _("unrecognized character after (?P");
 439       break;
 440     case G_REGEX_ERROR_MISSING_SUBPATTERN_NAME_TERMINATOR:
 441       *errmsg = _("missing terminator in subpattern name");
 442       break;
 443     case G_REGEX_ERROR_DUPLICATE_SUBPATTERN_NAME:
 444       *errmsg = _("two named subpatterns have the same name");
 445       break;
 446     case G_REGEX_ERROR_MALFORMED_PROPERTY:
 447       *errmsg = _("malformed \\P or \\p sequence");
 448       break;
 449     case G_REGEX_ERROR_UNKNOWN_PROPERTY:
 450       *errmsg = _("unknown property name after \\P or \\p");
 451       break;
 452     case G_REGEX_ERROR_SUBPATTERN_NAME_TOO_LONG:
 453       *errmsg = _("subpattern name is too long (maximum 32 characters)");
 454       break;
 455     case G_REGEX_ERROR_TOO_MANY_SUBPATTERNS:
 456       *errmsg = _("too many named subpatterns (maximum 10,000)");
 457       break;
 458     case G_REGEX_ERROR_INVALID_OCTAL_VALUE:
 459       *errmsg = _("octal value is greater than \\377");
 460       break;
 461     case 152: /* internal error: overran compiling workspace */
 462       *errcode = G_REGEX_ERROR_INTERNAL;
 463       *errmsg = _("overran compiling workspace");
 464       break;
 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");
 468       break;
 469     case G_REGEX_ERROR_TOO_MANY_BRANCHES_IN_DEFINE:
 470       *errmsg = _("DEFINE group contains more than one branch");
 471       break;
 472     case G_REGEX_ERROR_INCONSISTENT_NEWLINE_OPTIONS:
 473       *errmsg = _("inconsistent NEWLINE options");
 474       break;
 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");
 478       break;
 479     case G_REGEX_ERROR_INVALID_RELATIVE_REFERENCE:
 480       *errmsg = _("a numbered reference must not be zero");
 481       break;
 482     case G_REGEX_ERROR_BACKTRACKING_CONTROL_VERB_ARGUMENT_FORBIDDEN:
 483       *errmsg = _("an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT)");
 484       break;
 485     case G_REGEX_ERROR_UNKNOWN_BACKTRACKING_CONTROL_VERB:
 486       *errmsg = _("(*VERB) not recognized");
 487       break;
 488     case G_REGEX_ERROR_NUMBER_TOO_BIG:
 489       *errmsg = _("number is too big");
 490       break;
 491     case G_REGEX_ERROR_MISSING_SUBPATTERN_NAME:
 492       *errmsg = _("missing subpattern name after (?&");
 493       break;
 494     case G_REGEX_ERROR_MISSING_DIGIT:
 495       *errmsg = _("digit expected after (?+");
 496       break;
 497     case G_REGEX_ERROR_INVALID_DATA_CHARACTER:
 498       *errmsg = _("] is an invalid data character in JavaScript compatibility mode");
 499       break;
 500     case G_REGEX_ERROR_EXTRA_SUBPATTERN_NAME:
 501       *errmsg = _("different names for subpatterns of the same number are not allowed");
 502       break;
 503     case G_REGEX_ERROR_BACKTRACKING_CONTROL_VERB_ARGUMENT_REQUIRED:
 504       *errmsg = _("(*MARK) must have an argument");
 505       break;
 506     case G_REGEX_ERROR_INVALID_CONTROL_CHAR:
 507       *errmsg = _( "\\c must be followed by an ASCII character");
 508       break;
 509     case G_REGEX_ERROR_MISSING_NAME:
 510       *errmsg = _("\\k is not followed by a braced, angle-bracketed, or quoted name");
 511       break;
 512     case G_REGEX_ERROR_NOT_SUPPORTED_IN_CLASS:
 513       *errmsg = _("\\N is not supported in a class");
 514       break;
 515     case G_REGEX_ERROR_TOO_MANY_FORWARD_REFERENCES:
 516       *errmsg = _("too many forward references");
 517       break;
 518     case G_REGEX_ERROR_NAME_TOO_LONG:
 519       *errmsg = _("name is too long in (*MARK), (*PRUNE), (*SKIP), or (*THEN)");
 520       break;
 521     case G_REGEX_ERROR_CHARACTER_VALUE_TOO_LARGE:
 522       *errmsg = _("character value in \\u.... sequence is too large");
 523       break;
 524
 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;
 529       break;
 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;
 535       break;
 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;
 546       break;
 547
 548     default:
 549       *errcode = G_REGEX_ERROR_COMPILE;
 550     }
 551 }
 552
 553 /* GMatchInfo */
 554
 555 static GMatchInfo *
 556 match_info_new (const GRegex *regex,
 557                 const gchar  *string,
 558                 gint          string_len,
 559                 gint          start_position,
 560                 gint          match_options,
 561                 gboolean      is_dfa)
 562 {
 563   GMatchInfo *match_info;
 564
 565   if (string_len < 0)
 566     string_len = strlen (string);
 567
 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;
 576
 577   if (is_dfa)
 578     {
 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);
 584     }
 585   else
 586     {
 587       gint capture_count;
 588       pcre_fullinfo (regex->pcre_re, regex->extra,
 589                      PCRE_INFO_CAPTURECOUNT, &capture_count);
 590       match_info->n_offsets = (capture_count + 1) * 3;
 591     }
 592
 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;
 597
 598   return match_info;
 599 }
 600
 601 /**
 602  * g_match_info_get_regex:
 603  * @match_info: a #GMatchInfo
 604  *
 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.
 608  *
 609  * Returns: #GRegex object used in @match_info
 610  *
 611  * Since: 2.14
 612  */
 613 GRegex *
 614 g_match_info_get_regex (const GMatchInfo *match_info)
 615 {
 616   g_return_val_if_fail (match_info != NULL, NULL);
 617   return match_info->regex;
 618 }
 619
 620 /**
 621  * g_match_info_get_string:
 622  * @match_info: a #GMatchInfo
 623  *
 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.
 627  *
 628  * Returns: the string searched with @match_info
 629  *
 630  * Since: 2.14
 631  */
 632 const gchar *
 633 g_match_info_get_string (const GMatchInfo *match_info)
 634 {
 635   g_return_val_if_fail (match_info != NULL, NULL);
 636   return match_info->string;
 637 }
 638
 639 /**
 640  * g_match_info_ref:
 641  * @match_info: a #GMatchInfo
 642  *
 643  * Increases reference count of @match_info by 1.
 644  *
 645  * Returns: @match_info
 646  *
 647  * Since: 2.30
 648  */
 649 GMatchInfo       *
 650 g_match_info_ref (GMatchInfo *match_info)
 651 {
 652   g_return_val_if_fail (match_info != NULL, NULL);
 653   g_atomic_int_inc (&match_info->ref_count);
 654   return match_info;
 655 }
 656
 657 /**
 658  * g_match_info_unref:
 659  * @match_info: a #GMatchInfo
 660  *
 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.
 663  *
 664  * Since: 2.30
 665  */
 666 void
 667 g_match_info_unref (GMatchInfo *match_info)
 668 {
 669   if (g_atomic_int_dec_and_test (&match_info->ref_count))
 670     {
 671       g_regex_unref (match_info->regex);
 672       g_free (match_info->offsets);
 673       g_free (match_info->workspace);
 674       g_free (match_info);
 675     }
 676 }
 677
 678 /**
 679  * g_match_info_free:
 680  * @match_info: (allow-none): a #GMatchInfo, or %NULL
 681  *
 682  * If @match_info is not %NULL, calls g_match_info_unref(); otherwise does
 683  * nothing.
 684  *
 685  * Since: 2.14
 686  */
 687 void
 688 g_match_info_free (GMatchInfo *match_info)
 689 {
 690   if (match_info == NULL)
 691     return;
 692
 693   g_match_info_unref (match_info);
 694 }
 695
 696 /**
 697  * g_match_info_next:
 698  * @match_info: a #GMatchInfo structure
 699  * @error: location to store the error occurring, or %NULL to ignore errors
 700  *
 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
 703  * @match_info.
 704  *
 705  * The match is done on the string passed to the match function, so you
 706  * cannot free it before calling this function.
 707  *
 708  * Returns: %TRUE is the string matched, %FALSE otherwise
 709  *
 710  * Since: 2.14
 711  */
 712 gboolean
 713 g_match_info_next (GMatchInfo  *match_info,
 714                    GError     **error)
 715 {
 716   gint prev_match_start;
 717   gint prev_match_end;
 718
 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);
 722
 723   prev_match_start = match_info->offsets[0];
 724   prev_match_end = match_info->offsets[1];
 725
 726   if (match_info->pos > match_info->string_len)
 727     {
 728       /* we have reached the end of the string */
 729       match_info->pos = -1;
 730       match_info->matches = PCRE_ERROR_NOMATCH;
 731       return FALSE;
 732     }
 733
 734   match_info->matches = pcre_exec (match_info->regex->pcre_re,
 735                                    match_info->regex->extra,
 736                                    match_info->string,
 737                                    match_info->string_len,
 738                                    match_info->pos,
 739                                    match_info->regex->match_opts | match_info->match_opts,
 740                                    match_info->offsets,
 741                                    match_info->n_offsets);
 742   if (IS_PCRE_ERROR (match_info->matches))
 743     {
 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));
 747       return FALSE;
 748     }
 749
 750   /* avoid infinite loops if the pattern is an empty string or something
 751    * equivalent */
 752   if (match_info->pos == match_info->offsets[1])
 753     {
 754       if (match_info->pos > match_info->string_len)
 755         {
 756           /* we have reached the end of the string */
 757           match_info->pos = -1;
 758           match_info->matches = PCRE_ERROR_NOMATCH;
 759           return FALSE;
 760         }
 761
 762       match_info->pos = NEXT_CHAR (match_info->regex,
 763                                    &match_info->string[match_info->pos]) -
 764                                    match_info->string;
 765     }
 766   else
 767     {
 768       match_info->pos = match_info->offsets[1];
 769     }
 770
 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])
 785     {
 786       /* ignore this match and search the next one */
 787       return g_match_info_next (match_info, error);
 788     }
 789
 790   return match_info->matches >= 0;
 791 }
 792
 793 /**
 794  * g_match_info_matches:
 795  * @match_info: a #GMatchInfo structure
 796  *
 797  * Returns whether the previous match operation succeeded.
 798  *
 799  * Returns: %TRUE if the previous match operation succeeded,
 800  *   %FALSE otherwise
 801  *
 802  * Since: 2.14
 803  */
 804 gboolean
 805 g_match_info_matches (const GMatchInfo *match_info)
 806 {
 807   g_return_val_if_fail (match_info != NULL, FALSE);
 808
 809   return match_info->matches >= 0;
 810 }
 811
 812 /**
 813  * g_match_info_get_match_count:
 814  * @match_info: a #GMatchInfo structure
 815  *
 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.
 819  *
 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.
 824  *
 825  * Returns: Number of matched substrings, or -1 if an error occurred
 826  *
 827  * Since: 2.14
 828  */
 829 gint
 830 g_match_info_get_match_count (const GMatchInfo *match_info)
 831 {
 832   g_return_val_if_fail (match_info, -1);
 833
 834   if (match_info->matches == PCRE_ERROR_NOMATCH)
 835     /* no match */
 836     return 0;
 837   else if (match_info->matches < PCRE_ERROR_NOMATCH)
 838     /* error */
 839     return -1;
 840   else
 841     /* match */
 842     return match_info->matches;
 843 }
 844
 845 /**
 846  * g_match_info_is_partial_match:
 847  * @match_info: a #GMatchInfo structure
 848  *
 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.
 853  *
 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.
 861  *
 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().
 869  *
 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.
 877  * See <ulink>man:pcrepartial</ulink> for more information on partial matching.
 878  *
 879  * Because of the way certain internal optimizations are implemented
 880  * the partial matching algorithm cannot be used with all patterns.
 881  * So repeated single characters such as "a{2,4}" and repeated single
 882  * meta-sequences such as "\d+" are not permitted if the maximum number
 883  * of occurrences is greater than one. Optional items such as "\d?"
 884  * (where the maximum is one) are permitted. Quantifiers with any values
 885  * are permitted after parentheses, so the invalid examples above can be
 886  * coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL or
 887  * #G_REGEX_MATCH_PARTIAL_HARD is set
 888  * for a pattern that does not conform to the restrictions, matching
 889  * functions return an error.
 890  *
 891  * Returns: %TRUE if the match was partial, %FALSE otherwise
 892  *
 893  * Since: 2.14
 894  */
 895 gboolean
 896 g_match_info_is_partial_match (const GMatchInfo *match_info)
 897 {
 898   g_return_val_if_fail (match_info != NULL, FALSE);
 899
 900   return match_info->matches == PCRE_ERROR_PARTIAL;
 901 }
 902
 903 /**
 904  * g_match_info_expand_references:
 905  * @match_info: (allow-none): a #GMatchInfo or %NULL
 906  * @string_to_expand: the string to expand
 907  * @error: location to store the error occurring, or %NULL to ignore errors
 908  *
 909  * Returns a new string containing the text in @string_to_expand with
 910  * references and escape sequences expanded. References refer to the last
 911  * match done with @string against @regex and have the same syntax used by
 912  * g_regex_replace().
 913  *
 914  * The @string_to_expand must be UTF-8 encoded even if #G_REGEX_RAW was
 915  * passed to g_regex_new().
 916  *
 917  * The backreferences are extracted from the string passed to the match
 918  * function, so you cannot call this function after freeing the string.
 919  *
 920  * @match_info may be %NULL in which case @string_to_expand must not
 921  * contain references. For instance "foo\n" does not refer to an actual
 922  * pattern and '\n' merely will be replaced with \n character,
 923  * while to expand "\0" (whole match) one needs the result of a match.
 924  * Use g_regex_check_replacement() to find out whether @string_to_expand
 925  * contains references.
 926  *
 927  * Returns: (allow-none): the expanded string, or %NULL if an error occurred
 928  *
 929  * Since: 2.14
 930  */
 931 gchar *
 932 g_match_info_expand_references (const GMatchInfo  *match_info,
 933                                 const gchar       *string_to_expand,
 934                                 GError           **error)
 935 {
 936   GString *result;
 937   GList *list;
 938   GError *tmp_error = NULL;
 939
 940   g_return_val_if_fail (string_to_expand != NULL, NULL);
 941   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 942
 943   list = split_replacement (string_to_expand, &tmp_error);
 944   if (tmp_error != NULL)
 945     {
 946       g_propagate_error (error, tmp_error);
 947       return NULL;
 948     }
 949
 950   if (!match_info && interpolation_list_needs_match (list))
 951     {
 952       g_critical ("String '%s' contains references to the match, can't "
 953                   "expand references without GMatchInfo object",
 954                   string_to_expand);
 955       return NULL;
 956     }
 957
 958   result = g_string_sized_new (strlen (string_to_expand));
 959   interpolate_replacement (match_info, result, list);
 960
 961   g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
 962
 963   return g_string_free (result, FALSE);
 964 }
 965
 966 /**
 967  * g_match_info_fetch:
 968  * @match_info: #GMatchInfo structure
 969  * @match_num: number of the sub expression
 970  *
 971  * Retrieves the text matching the @match_num<!-- -->'th capturing
 972  * parentheses. 0 is the full text of the match, 1 is the first paren
 973  * set, 2 the second, and so on.
 974  *
 975  * If @match_num is a valid sub pattern but it didn't match anything
 976  * (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty
 977  * string is returned.
 978  *
 979  * If the match was obtained using the DFA algorithm, that is using
 980  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
 981  * string is not that of a set of parentheses but that of a matched
 982  * substring. Substrings are matched in reverse order of length, so
 983  * 0 is the longest match.
 984  *
 985  * The string is fetched from the string passed to the match function,
 986  * so you cannot call this function after freeing the string.
 987  *
 988  * Returns: (allow-none): The matched substring, or %NULL if an error
 989  *     occurred. You have to free the string yourself
 990  *
 991  * Since: 2.14
 992  */
 993 gchar *
 994 g_match_info_fetch (const GMatchInfo *match_info,
 995                     gint              match_num)
 996 {
 997   /* we cannot use pcre_get_substring() because it allocates the
 998    * string using pcre_malloc(). */
 999   gchar *match = NULL;
1000   gint start, end;
1001
1002   g_return_val_if_fail (match_info != NULL, NULL);
1003   g_return_val_if_fail (match_num >= 0, NULL);
1004
1005   /* match_num does not exist or it didn't matched, i.e. matching "b"
1006    * against "(a)?b" then group 0 is empty. */
1007   if (!g_match_info_fetch_pos (match_info, match_num, &start, &end))
1008     match = NULL;
1009   else if (start == -1)
1010     match = g_strdup ("");
1011   else
1012     match = g_strndup (&match_info->string[start], end - start);
1013
1014   return match;
1015 }
1016
1017 /**
1018  * g_match_info_fetch_pos:
1019  * @match_info: #GMatchInfo structure
1020  * @match_num: number of the sub expression
1021  * @start_pos: (out) (allow-none): pointer to location where to store
1022  *     the start position, or %NULL
1023  * @end_pos: (out) (allow-none): pointer to location where to store
1024  *     the end position, or %NULL
1025  *
1026  * Retrieves the position in bytes of the @match_num<!-- -->'th capturing
1027  * parentheses. 0 is the full text of the match, 1 is the first
1028  * paren set, 2 the second, and so on.
1029  *
1030  * If @match_num is a valid sub pattern but it didn't match anything
1031  * (e.g. sub pattern 1, matching "b" against "(a)?b") then @start_pos
1032  * and @end_pos are set to -1 and %TRUE is returned.
1033  *
1034  * If the match was obtained using the DFA algorithm, that is using
1035  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
1036  * position is not that of a set of parentheses but that of a matched
1037  * substring. Substrings are matched in reverse order of length, so
1038  * 0 is the longest match.
1039  *
1040  * Returns: %TRUE if the position was fetched, %FALSE otherwise. If
1041  *   the position cannot be fetched, @start_pos and @end_pos are left
1042  *   unchanged
1043  *
1044  * Since: 2.14
1045  */
1046 gboolean
1047 g_match_info_fetch_pos (const GMatchInfo *match_info,
1048                         gint              match_num,
1049                         gint             *start_pos,
1050                         gint             *end_pos)
1051 {
1052   g_return_val_if_fail (match_info != NULL, FALSE);
1053   g_return_val_if_fail (match_num >= 0, FALSE);
1054
1055   /* make sure the sub expression number they're requesting is less than
1056    * the total number of sub expressions that were matched. */
1057   if (match_num >= match_info->matches)
1058     return FALSE;
1059
1060   if (start_pos != NULL)
1061     *start_pos = match_info->offsets[2 * match_num];
1062
1063   if (end_pos != NULL)
1064     *end_pos = match_info->offsets[2 * match_num + 1];
1065
1066   return TRUE;
1067 }
1068
1069 /*
1070  * Returns number of first matched subpattern with name @name.
1071  * There may be more than one in case when DUPNAMES is used,
1072  * and not all subpatterns with that name match;
1073  * pcre_get_stringnumber() does not work in that case.
1074  */
1075 static gint
1076 get_matched_substring_number (const GMatchInfo *match_info,
1077                               const gchar      *name)
1078 {
1079   gint entrysize;
1080   gchar *first, *last;
1081   guchar *entry;
1082
1083   if (!(match_info->regex->compile_opts & G_REGEX_DUPNAMES))
1084     return pcre_get_stringnumber (match_info->regex->pcre_re, name);
1085
1086   /* This code is copied from pcre_get.c: get_first_set() */
1087   entrysize = pcre_get_stringtable_entries (match_info->regex->pcre_re,
1088                                             name,
1089                                             &first,
1090                                             &last);
1091
1092   if (entrysize <= 0)
1093     return entrysize;
1094
1095   for (entry = (guchar*) first; entry <= (guchar*) last; entry += entrysize)
1096     {
1097       gint n = (entry[0] << 8) + entry[1];
1098       if (match_info->offsets[n*2] >= 0)
1099         return n;
1100     }
1101
1102   return (first[0] << 8) + first[1];
1103 }
1104
1105 /**
1106  * g_match_info_fetch_named:
1107  * @match_info: #GMatchInfo structure
1108  * @name: name of the subexpression
1109  *
1110  * Retrieves the text matching the capturing parentheses named @name.
1111  *
1112  * If @name is a valid sub pattern name but it didn't match anything
1113  * (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b")
1114  * then an empty string is returned.
1115  *
1116  * The string is fetched from the string passed to the match function,
1117  * so you cannot call this function after freeing the string.
1118  *
1119  * Returns: (allow-none): The matched substring, or %NULL if an error
1120  *     occurred. You have to free the string yourself
1121  *
1122  * Since: 2.14
1123  */
1124 gchar *
1125 g_match_info_fetch_named (const GMatchInfo *match_info,
1126                           const gchar      *name)
1127 {
1128   /* we cannot use pcre_get_named_substring() because it allocates the
1129    * string using pcre_malloc(). */
1130   gint num;
1131
1132   g_return_val_if_fail (match_info != NULL, NULL);
1133   g_return_val_if_fail (name != NULL, NULL);
1134
1135   num = get_matched_substring_number (match_info, name);
1136   if (num < 0)
1137     return NULL;
1138   else
1139     return g_match_info_fetch (match_info, num);
1140 }
1141
1142 /**
1143  * g_match_info_fetch_named_pos:
1144  * @match_info: #GMatchInfo structure
1145  * @name: name of the subexpression
1146  * @start_pos: (out) (allow-none): pointer to location where to store
1147  *     the start position, or %NULL
1148  * @end_pos: (out) (allow-none): pointer to location where to store
1149  *     the end position, or %NULL
1150  *
1151  * Retrieves the position in bytes of the capturing parentheses named @name.
1152  *
1153  * If @name is a valid sub pattern name but it didn't match anything
1154  * (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b")
1155  * then @start_pos and @end_pos are set to -1 and %TRUE is returned.
1156  *
1157  * Returns: %TRUE if the position was fetched, %FALSE otherwise.
1158  *     If the position cannot be fetched, @start_pos and @end_pos
1159  *     are left unchanged.
1160  *
1161  * Since: 2.14
1162  */
1163 gboolean
1164 g_match_info_fetch_named_pos (const GMatchInfo *match_info,
1165                               const gchar      *name,
1166                               gint             *start_pos,
1167                               gint             *end_pos)
1168 {
1169   gint num;
1170
1171   g_return_val_if_fail (match_info != NULL, FALSE);
1172   g_return_val_if_fail (name != NULL, FALSE);
1173
1174   num = get_matched_substring_number (match_info, name);
1175   if (num < 0)
1176     return FALSE;
1177
1178   return g_match_info_fetch_pos (match_info, num, start_pos, end_pos);
1179 }
1180
1181 /**
1182  * g_match_info_fetch_all:
1183  * @match_info: a #GMatchInfo structure
1184  *
1185  * Bundles up pointers to each of the matching substrings from a match
1186  * and stores them in an array of gchar pointers. The first element in
1187  * the returned array is the match number 0, i.e. the entire matched
1188  * text.
1189  *
1190  * If a sub pattern didn't match anything (e.g. sub pattern 1, matching
1191  * "b" against "(a)?b") then an empty string is inserted.
1192  *
1193  * If the last match was obtained using the DFA algorithm, that is using
1194  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
1195  * strings are not that matched by sets of parentheses but that of the
1196  * matched substring. Substrings are matched in reverse order of length,
1197  * so the first one is the longest match.
1198  *
1199  * The strings are fetched from the string passed to the match function,
1200  * so you cannot call this function after freeing the string.
1201  *
1202  * Returns: (transfer full): a %NULL-terminated array of gchar *
1203  *     pointers.  It must be freed using g_strfreev(). If the previous
1204  *     match failed %NULL is returned
1205  *
1206  * Since: 2.14
1207  */
1208 gchar **
1209 g_match_info_fetch_all (const GMatchInfo *match_info)
1210 {
1211   /* we cannot use pcre_get_substring_list() because the returned value
1212    * isn't suitable for g_strfreev(). */
1213   gchar **result;
1214   gint i;
1215
1216   g_return_val_if_fail (match_info != NULL, NULL);
1217
1218   if (match_info->matches < 0)
1219     return NULL;
1220
1221   result = g_new (gchar *, match_info->matches + 1);
1222   for (i = 0; i < match_info->matches; i++)
1223     result[i] = g_match_info_fetch (match_info, i);
1224   result[i] = NULL;
1225
1226   return result;
1227 }
1228
1229
1230 /* GRegex */
1231
1232 G_DEFINE_QUARK (g-regex-error-quark, g_regex_error)
1233
1234 /**
1235  * g_regex_ref:
1236  * @regex: a #GRegex
1237  *
1238  * Increases reference count of @regex by 1.
1239  *
1240  * Returns: @regex
1241  *
1242  * Since: 2.14
1243  */
1244 GRegex *
1245 g_regex_ref (GRegex *regex)
1246 {
1247   g_return_val_if_fail (regex != NULL, NULL);
1248   g_atomic_int_inc (&regex->ref_count);
1249   return regex;
1250 }
1251
1252 /**
1253  * g_regex_unref:
1254  * @regex: a #GRegex
1255  *
1256  * Decreases reference count of @regex by 1. When reference count drops
1257  * to zero, it frees all the memory associated with the regex structure.
1258  *
1259  * Since: 2.14
1260  */
1261 void
1262 g_regex_unref (GRegex *regex)
1263 {
1264   g_return_if_fail (regex != NULL);
1265
1266   if (g_atomic_int_dec_and_test (&regex->ref_count))
1267     {
1268       g_free (regex->pattern);
1269       if (regex->pcre_re != NULL)
1270         pcre_free (regex->pcre_re);
1271       if (regex->extra != NULL)
1272         pcre_free (regex->extra);
1273       g_free (regex);
1274     }
1275 }
1276
1277 /**
1278  * g_regex_new:
1279  * @pattern: the regular expression
1280  * @compile_options: compile options for the regular expression, or 0
1281  * @match_options: match options for the regular expression, or 0
1282  * @error: return location for a #GError
1283  *
1284  * Compiles the regular expression to an internal form, and does
1285  * the initial setup of the #GRegex structure.
1286  *
1287  * Returns: a #GRegex structure. Call g_regex_unref() when you
1288  *   are done with it
1289  *
1290  * Since: 2.14
1291  */
1292 GRegex *
1293 g_regex_new (const gchar         *pattern,
1294              GRegexCompileFlags   compile_options,
1295              GRegexMatchFlags     match_options,
1296              GError             **error)
1297 {
1298   GRegex *regex;
1299   pcre *re;
1300   const gchar *errmsg;
1301   gint erroffset;
1302   gint errcode;
1303   gboolean optimize = FALSE;
1304   static volatile gsize initialised = 0;
1305   unsigned long int pcre_compile_options;
1306   GRegexCompileFlags nonpcre_compile_options;
1307
1308   g_return_val_if_fail (pattern != NULL, NULL);
1309   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1310   g_return_val_if_fail ((compile_options & ~G_REGEX_COMPILE_MASK) == 0, NULL);
1311   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
1312
1313   if (g_once_init_enter (&initialised))
1314     {
1315       int supports_utf8, supports_ucp;
1316
1317       pcre_config (PCRE_CONFIG_UTF8, &supports_utf8);
1318       if (!supports_utf8)
1319         g_critical (_("PCRE library is compiled without UTF8 support"));
1320
1321       pcre_config (PCRE_CONFIG_UNICODE_PROPERTIES, &supports_ucp);
1322       if (!supports_ucp)
1323         g_critical (_("PCRE library is compiled without UTF8 properties support"));
1324
1325       g_once_init_leave (&initialised, supports_utf8 && supports_ucp ? 1 : 2);
1326     }
1327
1328   if (G_UNLIKELY (initialised != 1))
1329     {
1330       g_set_error_literal (error, G_REGEX_ERROR, G_REGEX_ERROR_COMPILE,
1331                            _("PCRE library is compiled with incompatible options"));
1332       return NULL;
1333     }
1334
1335   nonpcre_compile_options = compile_options & G_REGEX_COMPILE_NONPCRE_MASK;
1336
1337   /* G_REGEX_OPTIMIZE has the same numeric value of PCRE_NO_UTF8_CHECK,
1338    * as we do not need to wrap PCRE_NO_UTF8_CHECK. */
1339   if (compile_options & G_REGEX_OPTIMIZE)
1340     optimize = TRUE;
1341
1342   /* In GRegex the string are, by default, UTF-8 encoded. PCRE
1343    * instead uses UTF-8 only if required with PCRE_UTF8. */
1344   if (compile_options & G_REGEX_RAW)
1345     {
1346       /* disable utf-8 */
1347       compile_options &= ~G_REGEX_RAW;
1348     }
1349   else
1350     {
1351       /* enable utf-8 */
1352       compile_options |= PCRE_UTF8 | PCRE_NO_UTF8_CHECK;
1353       match_options |= PCRE_NO_UTF8_CHECK;
1354     }
1355
1356   /* PCRE_NEWLINE_ANY is the default for the internal PCRE but
1357    * not for the system one. */
1358   if (!(compile_options & G_REGEX_NEWLINE_CR) &&
1359       !(compile_options & G_REGEX_NEWLINE_LF))
1360     {
1361       compile_options |= PCRE_NEWLINE_ANY;
1362     }
1363
1364   compile_options |= PCRE_UCP;
1365
1366   /* PCRE_BSR_UNICODE is the default for the internal PCRE but
1367    * possibly not for the system one.
1368    */
1369   if (~compile_options & G_REGEX_BSR_ANYCRLF)
1370     compile_options |= PCRE_BSR_UNICODE;
1371
1372   /* compile the pattern */
1373   re = pcre_compile2 (pattern, compile_options, &errcode,
1374                       &errmsg, &erroffset, NULL);
1375
1376   /* if the compilation failed, set the error member and return
1377    * immediately */
1378   if (re == NULL)
1379     {
1380       GError *tmp_error;
1381
1382       /* Translate the PCRE error code to GRegexError and use a translated
1383        * error message if possible */
1384       translate_compile_error (&errcode, &errmsg);
1385
1386       /* PCRE uses byte offsets but we want to show character offsets */
1387       erroffset = g_utf8_pointer_to_offset (pattern, &pattern[erroffset]);
1388
1389       tmp_error = g_error_new (G_REGEX_ERROR, errcode,
1390                                _("Error while compiling regular "
1391                                  "expression %s at char %d: %s"),
1392                                pattern, erroffset, errmsg);
1393       g_propagate_error (error, tmp_error);
1394
1395       return NULL;
1396     }
1397
1398   /* For options set at the beginning of the pattern, pcre puts them into
1399    * compile options, e.g. "(?i)foo" will make the pcre structure store
1400    * PCRE_CASELESS even though it wasn't explicitly given for compilation. */
1401   pcre_fullinfo (re, NULL, PCRE_INFO_OPTIONS, &pcre_compile_options);
1402   compile_options = pcre_compile_options & G_REGEX_COMPILE_PCRE_MASK;
1403
1404   /* Don't leak PCRE_NEWLINE_ANY, which is part of PCRE_NEWLINE_ANYCRLF */
1405   if ((pcre_compile_options & PCRE_NEWLINE_ANYCRLF) != PCRE_NEWLINE_ANYCRLF)
1406     compile_options &= ~PCRE_NEWLINE_ANY;
1407
1408   compile_options |= nonpcre_compile_options;
1409
1410   if (!(compile_options & G_REGEX_DUPNAMES))
1411     {
1412       gboolean jchanged = FALSE;
1413       pcre_fullinfo (re, NULL, PCRE_INFO_JCHANGED, &jchanged);
1414       if (jchanged)
1415         compile_options |= G_REGEX_DUPNAMES;
1416     }
1417
1418   regex = g_new0 (GRegex, 1);
1419   regex->ref_count = 1;
1420   regex->pattern = g_strdup (pattern);
1421   regex->pcre_re = re;
1422   regex->compile_opts = compile_options;
1423   regex->match_opts = match_options;
1424
1425   if (optimize)
1426     {
1427       regex->extra = pcre_study (regex->pcre_re, 0, &errmsg);
1428       if (errmsg != NULL)
1429         {
1430           GError *tmp_error = g_error_new (G_REGEX_ERROR,
1431                                            G_REGEX_ERROR_OPTIMIZE,
1432                                            _("Error while optimizing "
1433                                              "regular expression %s: %s"),
1434                                            regex->pattern,
1435                                            errmsg);
1436           g_propagate_error (error, tmp_error);
1437
1438           g_regex_unref (regex);
1439           return NULL;
1440         }
1441     }
1442
1443   return regex;
1444 }
1445
1446 /**
1447  * g_regex_get_pattern:
1448  * @regex: a #GRegex structure
1449  *
1450  * Gets the pattern string associated with @regex, i.e. a copy of
1451  * the string passed to g_regex_new().
1452  *
1453  * Returns: the pattern of @regex
1454  *
1455  * Since: 2.14
1456  */
1457 const gchar *
1458 g_regex_get_pattern (const GRegex *regex)
1459 {
1460   g_return_val_if_fail (regex != NULL, NULL);
1461
1462   return regex->pattern;
1463 }
1464
1465 /**
1466  * g_regex_get_max_backref:
1467  * @regex: a #GRegex
1468  *
1469  * Returns the number of the highest back reference
1470  * in the pattern, or 0 if the pattern does not contain
1471  * back references.
1472  *
1473  * Returns: the number of the highest back reference
1474  *
1475  * Since: 2.14
1476  */
1477 gint
1478 g_regex_get_max_backref (const GRegex *regex)
1479 {
1480   gint value;
1481
1482   pcre_fullinfo (regex->pcre_re, regex->extra,
1483                  PCRE_INFO_BACKREFMAX, &value);
1484
1485   return value;
1486 }
1487
1488 /**
1489  * g_regex_get_capture_count:
1490  * @regex: a #GRegex
1491  *
1492  * Returns the number of capturing subpatterns in the pattern.
1493  *
1494  * Returns: the number of capturing subpatterns
1495  *
1496  * Since: 2.14
1497  */
1498 gint
1499 g_regex_get_capture_count (const GRegex *regex)
1500 {
1501   gint value;
1502
1503   pcre_fullinfo (regex->pcre_re, regex->extra,
1504                  PCRE_INFO_CAPTURECOUNT, &value);
1505
1506   return value;
1507 }
1508
1509 /**
1510  * g_regex_get_has_cr_or_lf:
1511  * @regex: a #GRegex structure
1512  *
1513  * Checks whether the pattern contains explicit CR or LF references.
1514  *
1515  * Returns: %TRUE if the pattern contains explicit CR or LF references
1516  *
1517  * Since: 2.34
1518  */
1519 gboolean
1520 g_regex_get_has_cr_or_lf (const GRegex *regex)
1521 {
1522   gint value;
1523
1524   pcre_fullinfo (regex->pcre_re, regex->extra,
1525                  PCRE_INFO_HASCRORLF, &value);
1526
1527   return !!value;
1528 }
1529
1530 /**
1531  * g_regex_get_compile_flags:
1532  * @regex: a #GRegex
1533  *
1534  * Returns the compile options that @regex was created with.
1535  *
1536  * Returns: flags from #GRegexCompileFlags
1537  *
1538  * Since: 2.26
1539  */
1540 GRegexCompileFlags
1541 g_regex_get_compile_flags (const GRegex *regex)
1542 {
1543   g_return_val_if_fail (regex != NULL, 0);
1544
1545   return regex->compile_opts;
1546 }
1547
1548 /**
1549  * g_regex_get_match_flags:
1550  * @regex: a #GRegex
1551  *
1552  * Returns the match options that @regex was created with.
1553  *
1554  * Returns: flags from #GRegexMatchFlags
1555  *
1556  * Since: 2.26
1557  */
1558 GRegexMatchFlags
1559 g_regex_get_match_flags (const GRegex *regex)
1560 {
1561   g_return_val_if_fail (regex != NULL, 0);
1562
1563   return regex->match_opts & G_REGEX_MATCH_MASK;
1564 }
1565
1566 /**
1567  * g_regex_match_simple:
1568  * @pattern: the regular expression
1569  * @string: the string to scan for matches
1570  * @compile_options: compile options for the regular expression, or 0
1571  * @match_options: match options, or 0
1572  *
1573  * Scans for a match in @string for @pattern.
1574  *
1575  * This function is equivalent to g_regex_match() but it does not
1576  * require to compile the pattern with g_regex_new(), avoiding some
1577  * lines of code when you need just to do a match without extracting
1578  * substrings, capture counts, and so on.
1579  *
1580  * If this function is to be called on the same @pattern more than
1581  * once, it's more efficient to compile the pattern once with
1582  * g_regex_new() and then use g_regex_match().
1583  *
1584  * Returns: %TRUE if the string matched, %FALSE otherwise
1585  *
1586  * Since: 2.14
1587  */
1588 gboolean
1589 g_regex_match_simple (const gchar        *pattern,
1590                       const gchar        *string,
1591                       GRegexCompileFlags  compile_options,
1592                       GRegexMatchFlags    match_options)
1593 {
1594   GRegex *regex;
1595   gboolean result;
1596
1597   regex = g_regex_new (pattern, compile_options, 0, NULL);
1598   if (!regex)
1599     return FALSE;
1600   result = g_regex_match_full (regex, string, -1, 0, match_options, NULL, NULL);
1601   g_regex_unref (regex);
1602   return result;
1603 }
1604
1605 /**
1606  * g_regex_match:
1607  * @regex: a #GRegex structure from g_regex_new()
1608  * @string: the string to scan for matches
1609  * @match_options: match options
1610  * @match_info: (out) (allow-none): pointer to location where to store
1611  *     the #GMatchInfo, or %NULL if you do not need it
1612  *
1613  * Scans for a match in string for the pattern in @regex.
1614  * The @match_options are combined with the match options specified
1615  * when the @regex structure was created, letting you have more
1616  * flexibility in reusing #GRegex structures.
1617  *
1618  * A #GMatchInfo structure, used to get information on the match,
1619  * is stored in @match_info if not %NULL. Note that if @match_info
1620  * is not %NULL then it is created even if the function returns %FALSE,
1621  * i.e. you must free it regardless if regular expression actually matched.
1622  *
1623  * To retrieve all the non-overlapping matches of the pattern in
1624  * string you can use g_match_info_next().
1625  *
1626  * |[
1627  * static void
1628  * print_uppercase_words (const gchar *string)
1629  * {
1630  *   /&ast; Print all uppercase-only words. &ast;/
1631  *   GRegex *regex;
1632  *   GMatchInfo *match_info;
1633  *   &nbsp;
1634  *   regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1635  *   g_regex_match (regex, string, 0, &amp;match_info);
1636  *   while (g_match_info_matches (match_info))
1637  *     {
1638  *       gchar *word = g_match_info_fetch (match_info, 0);
1639  *       g_print ("Found: %s\n", word);
1640  *       g_free (word);
1641  *       g_match_info_next (match_info, NULL);
1642  *     }
1643  *   g_match_info_free (match_info);
1644  *   g_regex_unref (regex);
1645  * }
1646  * ]|
1647  *
1648  * @string is not copied and is used in #GMatchInfo internally. If
1649  * you use any #GMatchInfo method (except g_match_info_free()) after
1650  * freeing or modifying @string then the behaviour is undefined.
1651  *
1652  * Returns: %TRUE is the string matched, %FALSE otherwise
1653  *
1654  * Since: 2.14
1655  */
1656 gboolean
1657 g_regex_match (const GRegex      *regex,
1658                const gchar       *string,
1659                GRegexMatchFlags   match_options,
1660                GMatchInfo       **match_info)
1661 {
1662   return g_regex_match_full (regex, string, -1, 0, match_options,
1663                              match_info, NULL);
1664 }
1665
1666 /**
1667  * g_regex_match_full:
1668  * @regex: a #GRegex structure from g_regex_new()
1669  * @string: (array length=string_len): the string to scan for matches
1670  * @string_len: the length of @string, or -1 if @string is nul-terminated
1671  * @start_position: starting index of the string to match
1672  * @match_options: match options
1673  * @match_info: (out) (allow-none): pointer to location where to store
1674  *     the #GMatchInfo, or %NULL if you do not need it
1675  * @error: location to store the error occurring, or %NULL to ignore errors
1676  *
1677  * Scans for a match in string for the pattern in @regex.
1678  * The @match_options are combined with the match options specified
1679  * when the @regex structure was created, letting you have more
1680  * flexibility in reusing #GRegex structures.
1681  *
1682  * Setting @start_position differs from just passing over a shortened
1683  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1684  * that begins with any kind of lookbehind assertion, such as "\b".
1685  *
1686  * A #GMatchInfo structure, used to get information on the match, is
1687  * stored in @match_info if not %NULL. Note that if @match_info is
1688  * not %NULL then it is created even if the function returns %FALSE,
1689  * i.e. you must free it regardless if regular expression actually
1690  * matched.
1691  *
1692  * @string is not copied and is used in #GMatchInfo internally. If
1693  * you use any #GMatchInfo method (except g_match_info_free()) after
1694  * freeing or modifying @string then the behaviour is undefined.
1695  *
1696  * To retrieve all the non-overlapping matches of the pattern in
1697  * string you can use g_match_info_next().
1698  *
1699  * |[
1700  * static void
1701  * print_uppercase_words (const gchar *string)
1702  * {
1703  *   /&ast; Print all uppercase-only words. &ast;/
1704  *   GRegex *regex;
1705  *   GMatchInfo *match_info;
1706  *   GError *error = NULL;
1707  *   &nbsp;
1708  *   regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1709  *   g_regex_match_full (regex, string, -1, 0, 0, &amp;match_info, &amp;error);
1710  *   while (g_match_info_matches (match_info))
1711  *     {
1712  *       gchar *word = g_match_info_fetch (match_info, 0);
1713  *       g_print ("Found: %s\n", word);
1714  *       g_free (word);
1715  *       g_match_info_next (match_info, &amp;error);
1716  *     }
1717  *   g_match_info_free (match_info);
1718  *   g_regex_unref (regex);
1719  *   if (error != NULL)
1720  *     {
1721  *       g_printerr ("Error while matching: %s\n", error->message);
1722  *       g_error_free (error);
1723  *     }
1724  * }
1725  * ]|
1726  *
1727  * Returns: %TRUE is the string matched, %FALSE otherwise
1728  *
1729  * Since: 2.14
1730  */
1731 gboolean
1732 g_regex_match_full (const GRegex      *regex,
1733                     const gchar       *string,
1734                     gssize             string_len,
1735                     gint               start_position,
1736                     GRegexMatchFlags   match_options,
1737                     GMatchInfo       **match_info,
1738                     GError           **error)
1739 {
1740   GMatchInfo *info;
1741   gboolean match_ok;
1742
1743   g_return_val_if_fail (regex != NULL, FALSE);
1744   g_return_val_if_fail (string != NULL, FALSE);
1745   g_return_val_if_fail (start_position >= 0, FALSE);
1746   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1747   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1748
1749   info = match_info_new (regex, string, string_len, start_position,
1750                          match_options, FALSE);
1751   match_ok = g_match_info_next (info, error);
1752   if (match_info != NULL)
1753     *match_info = info;
1754   else
1755     g_match_info_free (info);
1756
1757   return match_ok;
1758 }
1759
1760 /**
1761  * g_regex_match_all:
1762  * @regex: a #GRegex structure from g_regex_new()
1763  * @string: the string to scan for matches
1764  * @match_options: match options
1765  * @match_info: (out) (allow-none): pointer to location where to store
1766  *     the #GMatchInfo, or %NULL if you do not need it
1767  *
1768  * Using the standard algorithm for regular expression matching only
1769  * the longest match in the string is retrieved. This function uses
1770  * a different algorithm so it can retrieve all the possible matches.
1771  * For more documentation see g_regex_match_all_full().
1772  *
1773  * A #GMatchInfo structure, used to get information on the match, is
1774  * stored in @match_info if not %NULL. Note that if @match_info is
1775  * not %NULL then it is created even if the function returns %FALSE,
1776  * i.e. you must free it regardless if regular expression actually
1777  * matched.
1778  *
1779  * @string is not copied and is used in #GMatchInfo internally. If
1780  * you use any #GMatchInfo method (except g_match_info_free()) after
1781  * freeing or modifying @string then the behaviour is undefined.
1782  *
1783  * Returns: %TRUE is the string matched, %FALSE otherwise
1784  *
1785  * Since: 2.14
1786  */
1787 gboolean
1788 g_regex_match_all (const GRegex      *regex,
1789                    const gchar       *string,
1790                    GRegexMatchFlags   match_options,
1791                    GMatchInfo       **match_info)
1792 {
1793   return g_regex_match_all_full (regex, string, -1, 0, match_options,
1794                                  match_info, NULL);
1795 }
1796
1797 /**
1798  * g_regex_match_all_full:
1799  * @regex: a #GRegex structure from g_regex_new()
1800  * @string: (array length=string_len): the string to scan for matches
1801  * @string_len: the length of @string, or -1 if @string is nul-terminated
1802  * @start_position: starting index of the string to match
1803  * @match_options: match options
1804  * @match_info: (out) (allow-none): pointer to location where to store
1805  *     the #GMatchInfo, or %NULL if you do not need it
1806  * @error: location to store the error occurring, or %NULL to ignore errors
1807  *
1808  * Using the standard algorithm for regular expression matching only
1809  * the longest match in the string is retrieved, it is not possible
1810  * to obtain all the available matches. For instance matching
1811  * "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;"
1812  * you get "&lt;a&gt; &lt;b&gt; &lt;c&gt;".
1813  *
1814  * This function uses a different algorithm (called DFA, i.e. deterministic
1815  * finite automaton), so it can retrieve all the possible matches, all
1816  * starting at the same point in the string. For instance matching
1817  * "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;"
1818  * you would obtain three matches: "&lt;a&gt; &lt;b&gt; &lt;c&gt;",
1819  * "&lt;a&gt; &lt;b&gt;" and "&lt;a&gt;".
1820  *
1821  * The number of matched strings is retrieved using
1822  * g_match_info_get_match_count(). To obtain the matched strings and
1823  * their position you can use, respectively, g_match_info_fetch() and
1824  * g_match_info_fetch_pos(). Note that the strings are returned in
1825  * reverse order of length; that is, the longest matching string is
1826  * given first.
1827  *
1828  * Note that the DFA algorithm is slower than the standard one and it
1829  * is not able to capture substrings, so backreferences do not work.
1830  *
1831  * Setting @start_position differs from just passing over a shortened
1832  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1833  * that begins with any kind of lookbehind assertion, such as "\b".
1834  *
1835  * A #GMatchInfo structure, used to get information on the match, is
1836  * stored in @match_info if not %NULL. Note that if @match_info is
1837  * not %NULL then it is created even if the function returns %FALSE,
1838  * i.e. you must free it regardless if regular expression actually
1839  * matched.
1840  *
1841  * @string is not copied and is used in #GMatchInfo internally. If
1842  * you use any #GMatchInfo method (except g_match_info_free()) after
1843  * freeing or modifying @string then the behaviour is undefined.
1844  *
1845  * Returns: %TRUE is the string matched, %FALSE otherwise
1846  *
1847  * Since: 2.14
1848  */
1849 gboolean
1850 g_regex_match_all_full (const GRegex      *regex,
1851                         const gchar       *string,
1852                         gssize             string_len,
1853                         gint               start_position,
1854                         GRegexMatchFlags   match_options,
1855                         GMatchInfo       **match_info,
1856                         GError           **error)
1857 {
1858   GMatchInfo *info;
1859   gboolean done;
1860
1861   g_return_val_if_fail (regex != NULL, FALSE);
1862   g_return_val_if_fail (string != NULL, FALSE);
1863   g_return_val_if_fail (start_position >= 0, FALSE);
1864   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1865   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1866
1867   info = match_info_new (regex, string, string_len, start_position,
1868                          match_options, TRUE);
1869
1870   done = FALSE;
1871   while (!done)
1872     {
1873       done = TRUE;
1874       info->matches = pcre_dfa_exec (regex->pcre_re, regex->extra,
1875                                      info->string, info->string_len,
1876                                      info->pos,
1877                                      regex->match_opts | match_options,
1878                                      info->offsets, info->n_offsets,
1879                                      info->workspace, info->n_workspace);
1880       if (info->matches == PCRE_ERROR_DFA_WSSIZE)
1881         {
1882           /* info->workspace is too small. */
1883           info->n_workspace *= 2;
1884           info->workspace = g_realloc (info->workspace,
1885                                        info->n_workspace * sizeof (gint));
1886           done = FALSE;
1887         }
1888       else if (info->matches == 0)
1889         {
1890           /* info->offsets is too small. */
1891           info->n_offsets *= 2;
1892           info->offsets = g_realloc (info->offsets,
1893                                      info->n_offsets * sizeof (gint));
1894           done = FALSE;
1895         }
1896       else if (IS_PCRE_ERROR (info->matches))
1897         {
1898           g_set_error (error, G_REGEX_ERROR, G_REGEX_ERROR_MATCH,
1899                        _("Error while matching regular expression %s: %s"),
1900                        regex->pattern, match_error (info->matches));
1901         }
1902     }
1903
1904   /* set info->pos to -1 so that a call to g_match_info_next() fails. */
1905   info->pos = -1;
1906
1907   if (match_info != NULL)
1908     *match_info = info;
1909   else
1910     g_match_info_free (info);
1911
1912   return info->matches >= 0;
1913 }
1914
1915 /**
1916  * g_regex_get_string_number:
1917  * @regex: #GRegex structure
1918  * @name: name of the subexpression
1919  *
1920  * Retrieves the number of the subexpression named @name.
1921  *
1922  * Returns: The number of the subexpression or -1 if @name
1923  *   does not exists
1924  *
1925  * Since: 2.14
1926  */
1927 gint
1928 g_regex_get_string_number (const GRegex *regex,
1929                            const gchar  *name)
1930 {
1931   gint num;
1932
1933   g_return_val_if_fail (regex != NULL, -1);
1934   g_return_val_if_fail (name != NULL, -1);
1935
1936   num = pcre_get_stringnumber (regex->pcre_re, name);
1937   if (num == PCRE_ERROR_NOSUBSTRING)
1938     num = -1;
1939
1940   return num;
1941 }
1942
1943 /**
1944  * g_regex_split_simple:
1945  * @pattern: the regular expression
1946  * @string: the string to scan for matches
1947  * @compile_options: compile options for the regular expression, or 0
1948  * @match_options: match options, or 0
1949  *
1950  * Breaks the string on the pattern, and returns an array of
1951  * the tokens. If the pattern contains capturing parentheses,
1952  * then the text for each of the substrings will also be returned.
1953  * If the pattern does not match anywhere in the string, then the
1954  * whole string is returned as the first token.
1955  *
1956  * This function is equivalent to g_regex_split() but it does
1957  * not require to compile the pattern with g_regex_new(), avoiding
1958  * some lines of code when you need just to do a split without
1959  * extracting substrings, capture counts, and so on.
1960  *
1961  * If this function is to be called on the same @pattern more than
1962  * once, it's more efficient to compile the pattern once with
1963  * g_regex_new() and then use g_regex_split().
1964  *
1965  * As a special case, the result of splitting the empty string ""
1966  * is an empty vector, not a vector containing a single string.
1967  * The reason for this special case is that being able to represent
1968  * a empty vector is typically more useful than consistent handling
1969  * of empty elements. If you do need to represent empty elements,
1970  * you'll need to check for the empty string before calling this
1971  * function.
1972  *
1973  * A pattern that can match empty strings splits @string into
1974  * separate characters wherever it matches the empty string between
1975  * characters. For example splitting "ab c" using as a separator
1976  * "\s*", you will get "a", "b" and "c".
1977  *
1978  * Returns: (transfer full): a %NULL-terminated array of strings. Free
1979  * it using g_strfreev()
1980  *
1981  * Since: 2.14
1982  **/
1983 gchar **
1984 g_regex_split_simple (const gchar        *pattern,
1985                       const gchar        *string,
1986                       GRegexCompileFlags  compile_options,
1987                       GRegexMatchFlags    match_options)
1988 {
1989   GRegex *regex;
1990   gchar **result;
1991
1992   regex = g_regex_new (pattern, compile_options, 0, NULL);
1993   if (!regex)
1994     return NULL;
1995
1996   result = g_regex_split_full (regex, string, -1, 0, match_options, 0, NULL);
1997   g_regex_unref (regex);
1998   return result;
1999 }
2000
2001 /**
2002  * g_regex_split:
2003  * @regex: a #GRegex structure
2004  * @string: the string to split with the pattern
2005  * @match_options: match time option flags
2006  *
2007  * Breaks the string on the pattern, and returns an array of the tokens.
2008  * If the pattern contains capturing parentheses, then the text for each
2009  * of the substrings will also be returned. If the pattern does not match
2010  * anywhere in the string, then the whole string is returned as the first
2011  * token.
2012  *
2013  * As a special case, the result of splitting the empty string "" is an
2014  * empty vector, not a vector containing a single string. The reason for
2015  * this special case is that being able to represent a empty vector is
2016  * typically more useful than consistent handling of empty elements. If
2017  * you do need to represent empty elements, you'll need to check for the
2018  * empty string before calling this function.
2019  *
2020  * A pattern that can match empty strings splits @string into separate
2021  * characters wherever it matches the empty string between characters.
2022  * For example splitting "ab c" using as a separator "\s*", you will get
2023  * "a", "b" and "c".
2024  *
2025  * Returns: (transfer full): a %NULL-terminated gchar ** array. Free
2026  * it using g_strfreev()
2027  *
2028  * Since: 2.14
2029  **/
2030 gchar **
2031 g_regex_split (const GRegex     *regex,
2032                const gchar      *string,
2033                GRegexMatchFlags  match_options)
2034 {
2035   return g_regex_split_full (regex, string, -1, 0,
2036                              match_options, 0, NULL);
2037 }
2038
2039 /**
2040  * g_regex_split_full:
2041  * @regex: a #GRegex structure
2042  * @string: (array length=string_len): the string to split with the pattern
2043  * @string_len: the length of @string, or -1 if @string is nul-terminated
2044  * @start_position: starting index of the string to match
2045  * @match_options: match time option flags
2046  * @max_tokens: the maximum number of tokens to split @string into.
2047  *   If this is less than 1, the string is split completely
2048  * @error: return location for a #GError
2049  *
2050  * Breaks the string on the pattern, and returns an array of the tokens.
2051  * If the pattern contains capturing parentheses, then the text for each
2052  * of the substrings will also be returned. If the pattern does not match
2053  * anywhere in the string, then the whole string is returned as the first
2054  * token.
2055  *
2056  * As a special case, the result of splitting the empty string "" is an
2057  * empty vector, not a vector containing a single string. The reason for
2058  * this special case is that being able to represent a empty vector is
2059  * typically more useful than consistent handling of empty elements. If
2060  * you do need to represent empty elements, you'll need to check for the
2061  * empty string before calling this function.
2062  *
2063  * A pattern that can match empty strings splits @string into separate
2064  * characters wherever it matches the empty string between characters.
2065  * For example splitting "ab c" using as a separator "\s*", you will get
2066  * "a", "b" and "c".
2067  *
2068  * Setting @start_position differs from just passing over a shortened
2069  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
2070  * that begins with any kind of lookbehind assertion, such as "\b".
2071  *
2072  * Returns: (transfer full): a %NULL-terminated gchar ** array. Free
2073  * it using g_strfreev()
2074  *
2075  * Since: 2.14
2076  **/
2077 gchar **
2078 g_regex_split_full (const GRegex      *regex,
2079                     const gchar       *string,
2080                     gssize             string_len,
2081                     gint               start_position,
2082                     GRegexMatchFlags   match_options,
2083                     gint               max_tokens,
2084                     GError           **error)
2085 {
2086   GError *tmp_error = NULL;
2087   GMatchInfo *match_info;
2088   GList *list, *last;
2089   gint i;
2090   gint token_count;
2091   gboolean match_ok;
2092   /* position of the last separator. */
2093   gint last_separator_end;
2094   /* was the last match 0 bytes long? */
2095   gboolean last_match_is_empty;
2096   /* the returned array of char **s */
2097   gchar **string_list;
2098
2099   g_return_val_if_fail (regex != NULL, NULL);
2100   g_return_val_if_fail (string != NULL, NULL);
2101   g_return_val_if_fail (start_position >= 0, NULL);
2102   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2103   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2104
2105   if (max_tokens <= 0)
2106     max_tokens = G_MAXINT;
2107
2108   if (string_len < 0)
2109     string_len = strlen (string);
2110
2111   /* zero-length string */
2112   if (string_len - start_position == 0)
2113     return g_new0 (gchar *, 1);
2114
2115   if (max_tokens == 1)
2116     {
2117       string_list = g_new0 (gchar *, 2);
2118       string_list[0] = g_strndup (&string[start_position],
2119                                   string_len - start_position);
2120       return string_list;
2121     }
2122
2123   list = NULL;
2124   token_count = 0;
2125   last_separator_end = start_position;
2126   last_match_is_empty = FALSE;
2127
2128   match_ok = g_regex_match_full (regex, string, string_len, start_position,
2129                                  match_options, &match_info, &tmp_error);
2130
2131   while (tmp_error == NULL)
2132     {
2133       if (match_ok)
2134         {
2135           last_match_is_empty =
2136                     (match_info->offsets[0] == match_info->offsets[1]);
2137
2138           /* we need to skip empty separators at the same position of the end
2139            * of another separator. e.g. the string is "a b" and the separator
2140            * is " *", so from 1 to 2 we have a match and at position 2 we have
2141            * an empty match. */
2142           if (last_separator_end != match_info->offsets[1])
2143             {
2144               gchar *token;
2145               gint match_count;
2146
2147               token = g_strndup (string + last_separator_end,
2148                                  match_info->offsets[0] - last_separator_end);
2149               list = g_list_prepend (list, token);
2150               token_count++;
2151
2152               /* if there were substrings, these need to be added to
2153                * the list. */
2154               match_count = g_match_info_get_match_count (match_info);
2155               if (match_count > 1)
2156                 {
2157                   for (i = 1; i < match_count; i++)
2158                     list = g_list_prepend (list, g_match_info_fetch (match_info, i));
2159                 }
2160             }
2161         }
2162       else
2163         {
2164           /* if there was no match, copy to end of string. */
2165           if (!last_match_is_empty)
2166             {
2167               gchar *token = g_strndup (string + last_separator_end,
2168                                         match_info->string_len - last_separator_end);
2169               list = g_list_prepend (list, token);
2170             }
2171           /* no more tokens, end the loop. */
2172           break;
2173         }
2174
2175       /* -1 to leave room for the last part. */
2176       if (token_count >= max_tokens - 1)
2177         {
2178           /* we have reached the maximum number of tokens, so we copy
2179            * the remaining part of the string. */
2180           if (last_match_is_empty)
2181             {
2182               /* the last match was empty, so we have moved one char
2183                * after the real position to avoid empty matches at the
2184                * same position. */
2185               match_info->pos = PREV_CHAR (regex, &string[match_info->pos]) - string;
2186             }
2187           /* the if is needed in the case we have terminated the available
2188            * tokens, but we are at the end of the string, so there are no
2189            * characters left to copy. */
2190           if (string_len > match_info->pos)
2191             {
2192               gchar *token = g_strndup (string + match_info->pos,
2193                                         string_len - match_info->pos);
2194               list = g_list_prepend (list, token);
2195             }
2196           /* end the loop. */
2197           break;
2198         }
2199
2200       last_separator_end = match_info->pos;
2201       if (last_match_is_empty)
2202         /* if the last match was empty, g_match_info_next() has moved
2203          * forward to avoid infinite loops, but we still need to copy that
2204          * character. */
2205         last_separator_end = PREV_CHAR (regex, &string[last_separator_end]) - string;
2206
2207       match_ok = g_match_info_next (match_info, &tmp_error);
2208     }
2209   g_match_info_free (match_info);
2210   if (tmp_error != NULL)
2211     {
2212       g_propagate_error (error, tmp_error);
2213       g_list_free_full (list, g_free);
2214       match_info->pos = -1;
2215       return NULL;
2216     }
2217
2218   string_list = g_new (gchar *, g_list_length (list) + 1);
2219   i = 0;
2220   for (last = g_list_last (list); last; last = g_list_previous (last))
2221     string_list[i++] = last->data;
2222   string_list[i] = NULL;
2223   g_list_free (list);
2224
2225   return string_list;
2226 }
2227
2228 enum
2229 {
2230   REPL_TYPE_STRING,
2231   REPL_TYPE_CHARACTER,
2232   REPL_TYPE_SYMBOLIC_REFERENCE,
2233   REPL_TYPE_NUMERIC_REFERENCE,
2234   REPL_TYPE_CHANGE_CASE
2235 };
2236
2237 typedef enum
2238 {
2239   CHANGE_CASE_NONE         = 1 << 0,
2240   CHANGE_CASE_UPPER        = 1 << 1,
2241   CHANGE_CASE_LOWER        = 1 << 2,
2242   CHANGE_CASE_UPPER_SINGLE = 1 << 3,
2243   CHANGE_CASE_LOWER_SINGLE = 1 << 4,
2244   CHANGE_CASE_SINGLE_MASK  = CHANGE_CASE_UPPER_SINGLE | CHANGE_CASE_LOWER_SINGLE,
2245   CHANGE_CASE_LOWER_MASK   = CHANGE_CASE_LOWER | CHANGE_CASE_LOWER_SINGLE,
2246   CHANGE_CASE_UPPER_MASK   = CHANGE_CASE_UPPER | CHANGE_CASE_UPPER_SINGLE
2247 } ChangeCase;
2248
2249 struct _InterpolationData
2250 {
2251   gchar     *text;
2252   gint       type;
2253   gint       num;
2254   gchar      c;
2255   ChangeCase change_case;
2256 };
2257
2258 static void
2259 free_interpolation_data (InterpolationData *data)
2260 {
2261   g_free (data->text);
2262   g_free (data);
2263 }
2264
2265 static const gchar *
2266 expand_escape (const gchar        *replacement,
2267                const gchar        *p,
2268                InterpolationData  *data,
2269                GError            **error)
2270 {
2271   const gchar *q, *r;
2272   gint x, d, h, i;
2273   const gchar *error_detail;
2274   gint base = 0;
2275   GError *tmp_error = NULL;
2276
2277   p++;
2278   switch (*p)
2279     {
2280     case 't':
2281       p++;
2282       data->c = '\t';
2283       data->type = REPL_TYPE_CHARACTER;
2284       break;
2285     case 'n':
2286       p++;
2287       data->c = '\n';
2288       data->type = REPL_TYPE_CHARACTER;
2289       break;
2290     case 'v':
2291       p++;
2292       data->c = '\v';
2293       data->type = REPL_TYPE_CHARACTER;
2294       break;
2295     case 'r':
2296       p++;
2297       data->c = '\r';
2298       data->type = REPL_TYPE_CHARACTER;
2299       break;
2300     case 'f':
2301       p++;
2302       data->c = '\f';
2303       data->type = REPL_TYPE_CHARACTER;
2304       break;
2305     case 'a':
2306       p++;
2307       data->c = '\a';
2308       data->type = REPL_TYPE_CHARACTER;
2309       break;
2310     case 'b':
2311       p++;
2312       data->c = '\b';
2313       data->type = REPL_TYPE_CHARACTER;
2314       break;
2315     case '\\':
2316       p++;
2317       data->c = '\\';
2318       data->type = REPL_TYPE_CHARACTER;
2319       break;
2320     case 'x':
2321       p++;
2322       x = 0;
2323       if (*p == '{')
2324         {
2325           p++;
2326           do
2327             {
2328               h = g_ascii_xdigit_value (*p);
2329               if (h < 0)
2330                 {
2331                   error_detail = _("hexadecimal digit or '}' expected");
2332                   goto error;
2333                 }
2334               x = x * 16 + h;
2335               p++;
2336             }
2337           while (*p != '}');
2338           p++;
2339         }
2340       else
2341         {
2342           for (i = 0; i < 2; i++)
2343             {
2344               h = g_ascii_xdigit_value (*p);
2345               if (h < 0)
2346                 {
2347                   error_detail = _("hexadecimal digit expected");
2348                   goto error;
2349                 }
2350               x = x * 16 + h;
2351               p++;
2352             }
2353         }
2354       data->type = REPL_TYPE_STRING;
2355       data->text = g_new0 (gchar, 8);
2356       g_unichar_to_utf8 (x, data->text);
2357       break;
2358     case 'l':
2359       p++;
2360       data->type = REPL_TYPE_CHANGE_CASE;
2361       data->change_case = CHANGE_CASE_LOWER_SINGLE;
2362       break;
2363     case 'u':
2364       p++;
2365       data->type = REPL_TYPE_CHANGE_CASE;
2366       data->change_case = CHANGE_CASE_UPPER_SINGLE;
2367       break;
2368     case 'L':
2369       p++;
2370       data->type = REPL_TYPE_CHANGE_CASE;
2371       data->change_case = CHANGE_CASE_LOWER;
2372       break;
2373     case 'U':
2374       p++;
2375       data->type = REPL_TYPE_CHANGE_CASE;
2376       data->change_case = CHANGE_CASE_UPPER;
2377       break;
2378     case 'E':
2379       p++;
2380       data->type = REPL_TYPE_CHANGE_CASE;
2381       data->change_case = CHANGE_CASE_NONE;
2382       break;
2383     case 'g':
2384       p++;
2385       if (*p != '<')
2386         {
2387           error_detail = _("missing '<' in symbolic reference");
2388           goto error;
2389         }
2390       q = p + 1;
2391       do
2392         {
2393           p++;
2394           if (!*p)
2395             {
2396               error_detail = _("unfinished symbolic reference");
2397               goto error;
2398             }
2399         }
2400       while (*p != '>');
2401       if (p - q == 0)
2402         {
2403           error_detail = _("zero-length symbolic reference");
2404           goto error;
2405         }
2406       if (g_ascii_isdigit (*q))
2407         {
2408           x = 0;
2409           do
2410             {
2411               h = g_ascii_digit_value (*q);
2412               if (h < 0)
2413                 {
2414                   error_detail = _("digit expected");
2415                   p = q;
2416                   goto error;
2417                 }
2418               x = x * 10 + h;
2419               q++;
2420             }
2421           while (q != p);
2422           data->num = x;
2423           data->type = REPL_TYPE_NUMERIC_REFERENCE;
2424         }
2425       else
2426         {
2427           r = q;
2428           do
2429             {
2430               if (!g_ascii_isalnum (*r))
2431                 {
2432                   error_detail = _("illegal symbolic reference");
2433                   p = r;
2434                   goto error;
2435                 }
2436               r++;
2437             }
2438           while (r != p);
2439           data->text = g_strndup (q, p - q);
2440           data->type = REPL_TYPE_SYMBOLIC_REFERENCE;
2441         }
2442       p++;
2443       break;
2444     case '0':
2445       /* if \0 is followed by a number is an octal number representing a
2446        * character, else it is a numeric reference. */
2447       if (g_ascii_digit_value (*g_utf8_next_char (p)) >= 0)
2448         {
2449           base = 8;
2450           p = g_utf8_next_char (p);
2451         }
2452     case '1':
2453     case '2':
2454     case '3':
2455     case '4':
2456     case '5':
2457     case '6':
2458     case '7':
2459     case '8':
2460     case '9':
2461       x = 0;
2462       d = 0;
2463       for (i = 0; i < 3; i++)
2464         {
2465           h = g_ascii_digit_value (*p);
2466           if (h < 0)
2467             break;
2468           if (h > 7)
2469             {
2470               if (base == 8)
2471                 break;
2472               else
2473                 base = 10;
2474             }
2475           if (i == 2 && base == 10)
2476             break;
2477           x = x * 8 + h;
2478           d = d * 10 + h;
2479           p++;
2480         }
2481       if (base == 8 || i == 3)
2482         {
2483           data->type = REPL_TYPE_STRING;
2484           data->text = g_new0 (gchar, 8);
2485           g_unichar_to_utf8 (x, data->text);
2486         }
2487       else
2488         {
2489           data->type = REPL_TYPE_NUMERIC_REFERENCE;
2490           data->num = d;
2491         }
2492       break;
2493     case 0:
2494       error_detail = _("stray final '\\'");
2495       goto error;
2496       break;
2497     default:
2498       error_detail = _("unknown escape sequence");
2499       goto error;
2500     }
2501
2502   return p;
2503
2504  error:
2505   /* G_GSSIZE_FORMAT doesn't work with gettext, so we use %lu */
2506   tmp_error = g_error_new (G_REGEX_ERROR,
2507                            G_REGEX_ERROR_REPLACE,
2508                            _("Error while parsing replacement "
2509                              "text \"%s\" at char %lu: %s"),
2510                            replacement,
2511                            (gulong)(p - replacement),
2512                            error_detail);
2513   g_propagate_error (error, tmp_error);
2514
2515   return NULL;
2516 }
2517
2518 static GList *
2519 split_replacement (const gchar  *replacement,
2520                    GError      **error)
2521 {
2522   GList *list = NULL;
2523   InterpolationData *data;
2524   const gchar *p, *start;
2525
2526   start = p = replacement;
2527   while (*p)
2528     {
2529       if (*p == '\\')
2530         {
2531           data = g_new0 (InterpolationData, 1);
2532           start = p = expand_escape (replacement, p, data, error);
2533           if (p == NULL)
2534             {
2535               g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2536               free_interpolation_data (data);
2537
2538               return NULL;
2539             }
2540           list = g_list_prepend (list, data);
2541         }
2542       else
2543         {
2544           p++;
2545           if (*p == '\\' || *p == '\0')
2546             {
2547               if (p - start > 0)
2548                 {
2549                   data = g_new0 (InterpolationData, 1);
2550                   data->text = g_strndup (start, p - start);
2551                   data->type = REPL_TYPE_STRING;
2552                   list = g_list_prepend (list, data);
2553                 }
2554             }
2555         }
2556     }
2557
2558   return g_list_reverse (list);
2559 }
2560
2561 /* Change the case of c based on change_case. */
2562 #define CHANGE_CASE(c, change_case) \
2563         (((change_case) & CHANGE_CASE_LOWER_MASK) ? \
2564                 g_unichar_tolower (c) : \
2565                 g_unichar_toupper (c))
2566
2567 static void
2568 string_append (GString     *string,
2569                const gchar *text,
2570                ChangeCase  *change_case)
2571 {
2572   gunichar c;
2573
2574   if (text[0] == '\0')
2575     return;
2576
2577   if (*change_case == CHANGE_CASE_NONE)
2578     {
2579       g_string_append (string, text);
2580     }
2581   else if (*change_case & CHANGE_CASE_SINGLE_MASK)
2582     {
2583       c = g_utf8_get_char (text);
2584       g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2585       g_string_append (string, g_utf8_next_char (text));
2586       *change_case = CHANGE_CASE_NONE;
2587     }
2588   else
2589     {
2590       while (*text != '\0')
2591         {
2592           c = g_utf8_get_char (text);
2593           g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2594           text = g_utf8_next_char (text);
2595         }
2596     }
2597 }
2598
2599 static gboolean
2600 interpolate_replacement (const GMatchInfo *match_info,
2601                          GString          *result,
2602                          gpointer          data)
2603 {
2604   GList *list;
2605   InterpolationData *idata;
2606   gchar *match;
2607   ChangeCase change_case = CHANGE_CASE_NONE;
2608
2609   for (list = data; list; list = list->next)
2610     {
2611       idata = list->data;
2612       switch (idata->type)
2613         {
2614         case REPL_TYPE_STRING:
2615           string_append (result, idata->text, &change_case);
2616           break;
2617         case REPL_TYPE_CHARACTER:
2618           g_string_append_c (result, CHANGE_CASE (idata->c, change_case));
2619           if (change_case & CHANGE_CASE_SINGLE_MASK)
2620             change_case = CHANGE_CASE_NONE;
2621           break;
2622         case REPL_TYPE_NUMERIC_REFERENCE:
2623           match = g_match_info_fetch (match_info, idata->num);
2624           if (match)
2625             {
2626               string_append (result, match, &change_case);
2627               g_free (match);
2628             }
2629           break;
2630         case REPL_TYPE_SYMBOLIC_REFERENCE:
2631           match = g_match_info_fetch_named (match_info, idata->text);
2632           if (match)
2633             {
2634               string_append (result, match, &change_case);
2635               g_free (match);
2636             }
2637           break;
2638         case REPL_TYPE_CHANGE_CASE:
2639           change_case = idata->change_case;
2640           break;
2641         }
2642     }
2643
2644   return FALSE;
2645 }
2646
2647 /* whether actual match_info is needed for replacement, i.e.
2648  * whether there are references
2649  */
2650 static gboolean
2651 interpolation_list_needs_match (GList *list)
2652 {
2653   while (list != NULL)
2654     {
2655       InterpolationData *data = list->data;
2656
2657       if (data->type == REPL_TYPE_SYMBOLIC_REFERENCE ||
2658           data->type == REPL_TYPE_NUMERIC_REFERENCE)
2659         {
2660           return TRUE;
2661         }
2662
2663       list = list->next;
2664     }
2665
2666   return FALSE;
2667 }
2668
2669 /**
2670  * g_regex_replace:
2671  * @regex: a #GRegex structure
2672  * @string: (array length=string_len): the string to perform matches against
2673  * @string_len: the length of @string, or -1 if @string is nul-terminated
2674  * @start_position: starting index of the string to match
2675  * @replacement: text to replace each match with
2676  * @match_options: options for the match
2677  * @error: location to store the error occurring, or %NULL to ignore errors
2678  *
2679  * Replaces all occurrences of the pattern in @regex with the
2680  * replacement text. Backreferences of the form '\number' or
2681  * '\g&lt;number&gt;' in the replacement text are interpolated by the
2682  * number-th captured subexpression of the match, '\g&lt;name&gt;' refers
2683  * to the captured subexpression with the given name. '\0' refers to the
2684  * complete match, but '\0' followed by a number is the octal representation
2685  * of a character. To include a literal '\' in the replacement, write '\\'.
2686  * There are also escapes that changes the case of the following text:
2687  *
2688  * <variablelist>
2689  * <varlistentry><term>\l</term>
2690  * <listitem>
2691  * <para>Convert to lower case the next character</para>
2692  * </listitem>
2693  * </varlistentry>
2694  * <varlistentry><term>\u</term>
2695  * <listitem>
2696  * <para>Convert to upper case the next character</para>
2697  * </listitem>
2698  * </varlistentry>
2699  * <varlistentry><term>\L</term>
2700  * <listitem>
2701  * <para>Convert to lower case till \E</para>
2702  * </listitem>
2703  * </varlistentry>
2704  * <varlistentry><term>\U</term>
2705  * <listitem>
2706  * <para>Convert to upper case till \E</para>
2707  * </listitem>
2708  * </varlistentry>
2709  * <varlistentry><term>\E</term>
2710  * <listitem>
2711  * <para>End case modification</para>
2712  * </listitem>
2713  * </varlistentry>
2714  * </variablelist>
2715  *
2716  * If you do not need to use backreferences use g_regex_replace_literal().
2717  *
2718  * The @replacement string must be UTF-8 encoded even if #G_REGEX_RAW was
2719  * passed to g_regex_new(). If you want to use not UTF-8 encoded stings
2720  * you can use g_regex_replace_literal().
2721  *
2722  * Setting @start_position differs from just passing over a shortened
2723  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that
2724  * begins with any kind of lookbehind assertion, such as "\b".
2725  *
2726  * Returns: a newly allocated string containing the replacements
2727  *
2728  * Since: 2.14
2729  */
2730 gchar *
2731 g_regex_replace (const GRegex      *regex,
2732                  const gchar       *string,
2733                  gssize             string_len,
2734                  gint               start_position,
2735                  const gchar       *replacement,
2736                  GRegexMatchFlags   match_options,
2737                  GError           **error)
2738 {
2739   gchar *result;
2740   GList *list;
2741   GError *tmp_error = NULL;
2742
2743   g_return_val_if_fail (regex != NULL, NULL);
2744   g_return_val_if_fail (string != NULL, NULL);
2745   g_return_val_if_fail (start_position >= 0, NULL);
2746   g_return_val_if_fail (replacement != NULL, NULL);
2747   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2748   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2749
2750   list = split_replacement (replacement, &tmp_error);
2751   if (tmp_error != NULL)
2752     {
2753       g_propagate_error (error, tmp_error);
2754       return NULL;
2755     }
2756
2757   result = g_regex_replace_eval (regex,
2758                                  string, string_len, start_position,
2759                                  match_options,
2760                                  interpolate_replacement,
2761                                  (gpointer)list,
2762                                  &tmp_error);
2763   if (tmp_error != NULL)
2764     g_propagate_error (error, tmp_error);
2765
2766   g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2767
2768   return result;
2769 }
2770
2771 static gboolean
2772 literal_replacement (const GMatchInfo *match_info,
2773                      GString          *result,
2774                      gpointer          data)
2775 {
2776   g_string_append (result, data);
2777   return FALSE;
2778 }
2779
2780 /**
2781  * g_regex_replace_literal:
2782  * @regex: a #GRegex structure
2783  * @string: (array length=string_len): the string to perform matches against
2784  * @string_len: the length of @string, or -1 if @string is nul-terminated
2785  * @start_position: starting index of the string to match
2786  * @replacement: text to replace each match with
2787  * @match_options: options for the match
2788  * @error: location to store the error occurring, or %NULL to ignore errors
2789  *
2790  * Replaces all occurrences of the pattern in @regex with the
2791  * replacement text. @replacement is replaced literally, to
2792  * include backreferences use g_regex_replace().
2793  *
2794  * Setting @start_position differs from just passing over a
2795  * shortened string and setting #G_REGEX_MATCH_NOTBOL in the
2796  * case of a pattern that begins with any kind of lookbehind
2797  * assertion, such as "\b".
2798  *
2799  * Returns: a newly allocated string containing the replacements
2800  *
2801  * Since: 2.14
2802  */
2803 gchar *
2804 g_regex_replace_literal (const GRegex      *regex,
2805                          const gchar       *string,
2806                          gssize             string_len,
2807                          gint               start_position,
2808                          const gchar       *replacement,
2809                          GRegexMatchFlags   match_options,
2810                          GError           **error)
2811 {
2812   g_return_val_if_fail (replacement != NULL, NULL);
2813   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2814
2815   return g_regex_replace_eval (regex,
2816                                string, string_len, start_position,
2817                                match_options,
2818                                literal_replacement,
2819                                (gpointer)replacement,
2820                                error);
2821 }
2822
2823 /**
2824  * g_regex_replace_eval:
2825  * @regex: a #GRegex structure from g_regex_new()
2826  * @string: (array length=string_len): string to perform matches against
2827  * @string_len: the length of @string, or -1 if @string is nul-terminated
2828  * @start_position: starting index of the string to match
2829  * @match_options: options for the match
2830  * @eval: a function to call for each match
2831  * @user_data: user data to pass to the function
2832  * @error: location to store the error occurring, or %NULL to ignore errors
2833  *
2834  * Replaces occurrences of the pattern in regex with the output of
2835  * @eval for that occurrence.
2836  *
2837  * Setting @start_position differs from just passing over a shortened
2838  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
2839  * that begins with any kind of lookbehind assertion, such as "\b".
2840  *
2841  * The following example uses g_regex_replace_eval() to replace multiple
2842  * strings at once:
2843  * |[
2844  * static gboolean
2845  * eval_cb (const GMatchInfo *info,
2846  *          GString          *res,
2847  *          gpointer          data)
2848  * {
2849  *   gchar *match;
2850  *   gchar *r;
2851  *
2852  *    match = g_match_info_fetch (info, 0);
2853  *    r = g_hash_table_lookup ((GHashTable *)data, match);
2854  *    g_string_append (res, r);
2855  *    g_free (match);
2856  *
2857  *    return FALSE;
2858  * }
2859  *
2860  * /&ast; ... &ast;/
2861  *
2862  * GRegex *reg;
2863  * GHashTable *h;
2864  * gchar *res;
2865  *
2866  * h = g_hash_table_new (g_str_hash, g_str_equal);
2867  *
2868  * g_hash_table_insert (h, "1", "ONE");
2869  * g_hash_table_insert (h, "2", "TWO");
2870  * g_hash_table_insert (h, "3", "THREE");
2871  * g_hash_table_insert (h, "4", "FOUR");
2872  *
2873  * reg = g_regex_new ("1|2|3|4", 0, 0, NULL);
2874  * res = g_regex_replace_eval (reg, text, -1, 0, 0, eval_cb, h, NULL);
2875  * g_hash_table_destroy (h);
2876  *
2877  * /&ast; ... &ast;/
2878  * ]|
2879  *
2880  * Returns: a newly allocated string containing the replacements
2881  *
2882  * Since: 2.14
2883  */
2884 gchar *
2885 g_regex_replace_eval (const GRegex        *regex,
2886                       const gchar         *string,
2887                       gssize               string_len,
2888                       gint                 start_position,
2889                       GRegexMatchFlags     match_options,
2890                       GRegexEvalCallback   eval,
2891                       gpointer             user_data,
2892                       GError             **error)
2893 {
2894   GMatchInfo *match_info;
2895   GString *result;
2896   gint str_pos = 0;
2897   gboolean done = FALSE;
2898   GError *tmp_error = NULL;
2899
2900   g_return_val_if_fail (regex != NULL, NULL);
2901   g_return_val_if_fail (string != NULL, NULL);
2902   g_return_val_if_fail (start_position >= 0, NULL);
2903   g_return_val_if_fail (eval != NULL, NULL);
2904   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2905
2906   if (string_len < 0)
2907     string_len = strlen (string);
2908
2909   result = g_string_sized_new (string_len);
2910
2911   /* run down the string making matches. */
2912   g_regex_match_full (regex, string, string_len, start_position,
2913                       match_options, &match_info, &tmp_error);
2914   while (!done && g_match_info_matches (match_info))
2915     {
2916       g_string_append_len (result,
2917                            string + str_pos,
2918                            match_info->offsets[0] - str_pos);
2919       done = (*eval) (match_info, result, user_data);
2920       str_pos = match_info->offsets[1];
2921       g_match_info_next (match_info, &tmp_error);
2922     }
2923   g_match_info_free (match_info);
2924   if (tmp_error != NULL)
2925     {
2926       g_propagate_error (error, tmp_error);
2927       g_string_free (result, TRUE);
2928       return NULL;
2929     }
2930
2931   g_string_append_len (result, string + str_pos, string_len - str_pos);
2932   return g_string_free (result, FALSE);
2933 }
2934
2935 /**
2936  * g_regex_check_replacement:
2937  * @replacement: the replacement string
2938  * @has_references: (out) (allow-none): location to store information about
2939  *   references in @replacement or %NULL
2940  * @error: location to store error
2941  *
2942  * Checks whether @replacement is a valid replacement string
2943  * (see g_regex_replace()), i.e. that all escape sequences in
2944  * it are valid.
2945  *
2946  * If @has_references is not %NULL then @replacement is checked
2947  * for pattern references. For instance, replacement text 'foo\n'
2948  * does not contain references and may be evaluated without information
2949  * about actual match, but '\0\1' (whole match followed by first
2950  * subpattern) requires valid #GMatchInfo object.
2951  *
2952  * Returns: whether @replacement is a valid replacement string
2953  *
2954  * Since: 2.14
2955  */
2956 gboolean
2957 g_regex_check_replacement (const gchar  *replacement,
2958                            gboolean     *has_references,
2959                            GError      **error)
2960 {
2961   GList *list;
2962   GError *tmp = NULL;
2963
2964   list = split_replacement (replacement, &tmp);
2965
2966   if (tmp)
2967   {
2968     g_propagate_error (error, tmp);
2969     return FALSE;
2970   }
2971
2972   if (has_references)
2973     *has_references = interpolation_list_needs_match (list);
2974
2975   g_list_free_full (list, (GDestroyNotify) free_interpolation_data);
2976
2977   return TRUE;
2978 }
2979
2980 /**
2981  * g_regex_escape_nul:
2982  * @string: the string to escape
2983  * @length: the length of @string
2984  *
2985  * Escapes the nul characters in @string to "\x00".  It can be used
2986  * to compile a regex with embedded nul characters.
2987  *
2988  * For completeness, @length can be -1 for a nul-terminated string.
2989  * In this case the output string will be of course equal to @string.
2990  *
2991  * Returns: a newly-allocated escaped string
2992  *
2993  * Since: 2.30
2994  */
2995 gchar *
2996 g_regex_escape_nul (const gchar *string,
2997                     gint         length)
2998 {
2999   GString *escaped;
3000   const gchar *p, *piece_start, *end;
3001   gint backslashes;
3002
3003   g_return_val_if_fail (string != NULL, NULL);
3004
3005   if (length < 0)
3006     return g_strdup (string);
3007
3008   end = string + length;
3009   p = piece_start = string;
3010   escaped = g_string_sized_new (length + 1);
3011
3012   backslashes = 0;
3013   while (p < end)
3014     {
3015       switch (*p)
3016         {
3017         case '\0':
3018           if (p != piece_start)
3019             {
3020               /* copy the previous piece. */
3021               g_string_append_len (escaped, piece_start, p - piece_start);
3022             }
3023           if ((backslashes & 1) == 0)
3024             g_string_append_c (escaped, '\\');
3025           g_string_append_c (escaped, 'x');
3026           g_string_append_c (escaped, '0');
3027           g_string_append_c (escaped, '0');
3028           piece_start = ++p;
3029           backslashes = 0;
3030           break;
3031         case '\\':
3032           backslashes++;
3033           ++p;
3034           break;
3035         default:
3036           backslashes = 0;
3037           p = g_utf8_next_char (p);
3038           break;
3039         }
3040     }
3041
3042   if (piece_start < end)
3043     g_string_append_len (escaped, piece_start, end - piece_start);
3044
3045   return g_string_free (escaped, FALSE);
3046 }
3047
3048 /**
3049  * g_regex_escape_string:
3050  * @string: (array length=length): the string to escape
3051  * @length: the length of @string, or -1 if @string is nul-terminated
3052  *
3053  * Escapes the special characters used for regular expressions
3054  * in @string, for instance "a.b*c" becomes "a\.b\*c". This
3055  * function is useful to dynamically generate regular expressions.
3056  *
3057  * @string can contain nul characters that are replaced with "\0",
3058  * in this case remember to specify the correct length of @string
3059  * in @length.
3060  *
3061  * Returns: a newly-allocated escaped string
3062  *
3063  * Since: 2.14
3064  */
3065 gchar *
3066 g_regex_escape_string (const gchar *string,
3067                        gint         length)
3068 {
3069   GString *escaped;
3070   const char *p, *piece_start, *end;
3071
3072   g_return_val_if_fail (string != NULL, NULL);
3073
3074   if (length < 0)
3075     length = strlen (string);
3076
3077   end = string + length;
3078   p = piece_start = string;
3079   escaped = g_string_sized_new (length + 1);
3080
3081   while (p < end)
3082     {
3083       switch (*p)
3084         {
3085         case '\0':
3086         case '\\':
3087         case '|':
3088         case '(':
3089         case ')':
3090         case '[':
3091         case ']':
3092         case '{':
3093         case '}':
3094         case '^':
3095         case '$':
3096         case '*':
3097         case '+':
3098         case '?':
3099         case '.':
3100           if (p != piece_start)
3101             /* copy the previous piece. */
3102             g_string_append_len (escaped, piece_start, p - piece_start);
3103           g_string_append_c (escaped, '\\');
3104           if (*p == '\0')
3105             g_string_append_c (escaped, '0');
3106           else
3107             g_string_append_c (escaped, *p);
3108           piece_start = ++p;
3109           break;
3110         default:
3111           p = g_utf8_next_char (p);
3112           break;
3113         }
3114   }
3115
3116   if (piece_start < end)
3117     g_string_append_len (escaped, piece_start, end - piece_start);
3118
3119   return g_string_free (escaped, FALSE);
3120 }