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 #include "glib.h"
  27 #include "glibintl.h"
  28 #include "gregex.h"
  29
  30 #ifdef USE_SYSTEM_PCRE
  31 #include <pcre.h>
  32 #else
  33 #include "pcre/pcre.h"
  34 #endif
  35
  36 /* PCRE 7.3 does not contain the definition of PCRE_ERROR_NULLWSLIMIT */
  37 #ifndef PCRE_ERROR_NULLWSLIMIT
  38 #define PCRE_ERROR_NULLWSLIMIT (-22)
  39 #endif
  40
  41 #include "galias.h"
  42
  43 /* Mask of all the possible values for GRegexCompileFlags. */
  44 #define G_REGEX_COMPILE_MASK (G_REGEX_CASELESS          | \
  45                               G_REGEX_MULTILINE         | \
  46                               G_REGEX_DOTALL            | \
  47                               G_REGEX_EXTENDED          | \
  48                               G_REGEX_ANCHORED          | \
  49                               G_REGEX_DOLLAR_ENDONLY    | \
  50                               G_REGEX_UNGREEDY          | \
  51                               G_REGEX_RAW               | \
  52                               G_REGEX_NO_AUTO_CAPTURE   | \
  53                               G_REGEX_OPTIMIZE          | \
  54                               G_REGEX_DUPNAMES          | \
  55                               G_REGEX_NEWLINE_CR        | \
  56                               G_REGEX_NEWLINE_LF        | \
  57                               G_REGEX_NEWLINE_CRLF)
  58
  59 /* Mask of all the possible values for GRegexMatchFlags. */
  60 #define G_REGEX_MATCH_MASK (G_REGEX_MATCH_ANCHORED      | \
  61                             G_REGEX_MATCH_NOTBOL        | \
  62                             G_REGEX_MATCH_NOTEOL        | \
  63                             G_REGEX_MATCH_NOTEMPTY      | \
  64                             G_REGEX_MATCH_PARTIAL       | \
  65                             G_REGEX_MATCH_NEWLINE_CR    | \
  66                             G_REGEX_MATCH_NEWLINE_LF    | \
  67                             G_REGEX_MATCH_NEWLINE_CRLF  | \
  68                             G_REGEX_MATCH_NEWLINE_ANY)
  69
  70 /* if the string is in UTF-8 use g_utf8_ functions, else use
  71  * use just +/- 1. */
  72 #define NEXT_CHAR(re, s) (((re)->compile_opts & PCRE_UTF8) ? \
  73                                 g_utf8_next_char (s) : \
  74                                 ((s) + 1))
  75 #define PREV_CHAR(re, s) (((re)->compile_opts & PCRE_UTF8) ? \
  76                                 g_utf8_prev_char (s) : \
  77                                 ((s) - 1))
  78
  79 struct _GMatchInfo
  80 {
  81   GRegex *regex;                /* the regex */
  82   GRegexMatchFlags match_opts;  /* options used at match time on the regex */
  83   gint matches;                 /* number of matching sub patterns */
  84   gint pos;                     /* position in the string where last match left off */
  85   gint *offsets;                /* array of offsets paired 0,1 ; 2,3 ; 3,4 etc */
  86   gint n_offsets;               /* number of offsets */
  87   gint *workspace;              /* workspace for pcre_dfa_exec() */
  88   gint n_workspace;             /* number of workspace elements */
  89   const gchar *string;          /* string passed to the match function */
  90   gssize string_len;            /* length of string */
  91 };
  92
  93 struct _GRegex
  94 {
  95   volatile gint ref_count;      /* the ref count for the immutable part */
  96   gchar *pattern;               /* the pattern */
  97   pcre *pcre_re;                /* compiled form of the pattern */
  98   GRegexCompileFlags compile_opts;      /* options used at compile time on the pattern */
  99   GRegexMatchFlags match_opts;  /* options used at match time on the regex */
 100   pcre_extra *extra;            /* data stored when G_REGEX_OPTIMIZE is used */
 101 };
 102
 103 /* TRUE if ret is an error code, FALSE otherwise. */
 104 #define IS_PCRE_ERROR(ret) ((ret) < PCRE_ERROR_NOMATCH && (ret) != PCRE_ERROR_PARTIAL)
 105
 106 typedef struct _InterpolationData InterpolationData;
 107 static gboolean  interpolation_list_needs_match (GList *list);
 108 static gboolean  interpolate_replacement        (const GMatchInfo *match_info,
 109                                                  GString *result,
 110                                                  gpointer data);
 111 static GList    *split_replacement              (const gchar *replacement,
 112                                                  GError **error);
 113 static void      free_interpolation_data        (InterpolationData *data);
 114
 115
 116 static const gchar *
 117 match_error (gint errcode)
 118 {
 119   switch (errcode)
 120     {
 121     case PCRE_ERROR_NOMATCH:
 122       /* not an error */
 123       break;
 124     case PCRE_ERROR_NULL:
 125       /* NULL argument, this should not happen in GRegex */
 126       g_warning ("A NULL argument was passed to PCRE");
 127       break;
 128     case PCRE_ERROR_BADOPTION:
 129       return "bad options";
 130     case PCRE_ERROR_BADMAGIC:
 131       return _("corrupted object");
 132     case PCRE_ERROR_UNKNOWN_OPCODE:
 133       return N_("internal error or corrupted object");
 134     case PCRE_ERROR_NOMEMORY:
 135       return _("out of memory");
 136     case PCRE_ERROR_NOSUBSTRING:
 137       /* not used by pcre_exec() */
 138       break;
 139     case PCRE_ERROR_MATCHLIMIT:
 140       return _("backtracking limit reached");
 141     case PCRE_ERROR_CALLOUT:
 142       /* callouts are not implemented */
 143       break;
 144     case PCRE_ERROR_BADUTF8:
 145     case PCRE_ERROR_BADUTF8_OFFSET:
 146       /* we do not check if strings are valid */
 147       break;
 148     case PCRE_ERROR_PARTIAL:
 149       /* not an error */
 150       break;
 151     case PCRE_ERROR_BADPARTIAL:
 152       return _("the pattern contains items not supported for partial matching");
 153     case PCRE_ERROR_INTERNAL:
 154       return _("internal error");
 155     case PCRE_ERROR_BADCOUNT:
 156       /* negative ovecsize, this should not happen in GRegex */
 157       g_warning ("A negative ovecsize was passed to PCRE");
 158       break;
 159     case PCRE_ERROR_DFA_UITEM:
 160       return _("the pattern contains items not supported for partial matching");
 161     case PCRE_ERROR_DFA_UCOND:
 162       return _("back references as conditions are not supported for partial matching");
 163     case PCRE_ERROR_DFA_UMLIMIT:
 164       /* the match_field field is not used in GRegex */
 165       break;
 166     case PCRE_ERROR_DFA_WSSIZE:
 167       /* handled expanding the workspace */
 168       break;
 169     case PCRE_ERROR_DFA_RECURSE:
 170     case PCRE_ERROR_RECURSIONLIMIT:
 171       return _("recursion limit reached");
 172     case PCRE_ERROR_NULLWSLIMIT:
 173       return _("workspace limit for empty substrings reached");
 174     case PCRE_ERROR_BADNEWLINE:
 175       return _("invalid combination of newline flags");
 176     default:
 177       break;
 178     }
 179   return _("unknown error");
 180 }
 181
 182 static void
 183 translate_compile_error (gint *errcode, const gchar **errmsg)
 184 {
 185   /* Compile errors are created adding 100 to the error code returned
 186    * by PCRE.
 187    * If errcode is known we put the translatable error message in
 188    * erromsg. If errcode is unknown we put the generic
 189    * G_REGEX_ERROR_COMPILE error code in errcode and keep the
 190    * untranslated error message returned by PCRE.
 191    * Note that there can be more PCRE errors with the same GRegexError
 192    * and that some PCRE errors are useless for us.
 193    */
 194   *errcode += 100;
 195
 196   switch (*errcode)
 197     {
 198     case G_REGEX_ERROR_STRAY_BACKSLASH:
 199       *errmsg = _("\\ at end of pattern");
 200       break;
 201     case G_REGEX_ERROR_MISSING_CONTROL_CHAR:
 202       *errmsg = _("\\c at end of pattern");
 203       break;
 204     case G_REGEX_ERROR_UNRECOGNIZED_ESCAPE:
 205       *errmsg = _("unrecognized character follows \\");
 206       break;
 207     case 137:
 208       /* A number of Perl escapes are not handled by PCRE.
 209        * Therefore it explicitly raises ERR37.
 210        */
 211       *errcode = G_REGEX_ERROR_UNRECOGNIZED_ESCAPE;
 212       *errmsg = _("case-changing escapes (\\l, \\L, \\u, \\U) are not allowed here");
 213       break;
 214     case G_REGEX_ERROR_QUANTIFIERS_OUT_OF_ORDER:
 215       *errmsg = _("numbers out of order in {} quantifier");
 216       break;
 217     case G_REGEX_ERROR_QUANTIFIER_TOO_BIG:
 218       *errmsg = _("number too big in {} quantifier");
 219       break;
 220     case G_REGEX_ERROR_UNTERMINATED_CHARACTER_CLASS:
 221       *errmsg = _("missing terminating ] for character class");
 222       break;
 223     case G_REGEX_ERROR_INVALID_ESCAPE_IN_CHARACTER_CLASS:
 224       *errmsg = _("invalid escape sequence in character class");
 225       break;
 226     case G_REGEX_ERROR_RANGE_OUT_OF_ORDER:
 227       *errmsg = _("range out of order in character class");
 228       break;
 229     case G_REGEX_ERROR_NOTHING_TO_REPEAT:
 230       *errmsg = _("nothing to repeat");
 231       break;
 232     case G_REGEX_ERROR_UNRECOGNIZED_CHARACTER:
 233       *errmsg = _("unrecognized character after (?");
 234       break;
 235     case 124:
 236       *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
 237       *errmsg = _("unrecognized character after (?<");
 238       break;
 239     case 141:
 240       *errcode = G_REGEX_ERROR_UNRECOGNIZED_CHARACTER;
 241       *errmsg = _("unrecognized character after (?P");
 242       break;
 243     case G_REGEX_ERROR_POSIX_NAMED_CLASS_OUTSIDE_CLASS:
 244       *errmsg = _("POSIX named classes are supported only within a class");
 245       break;
 246     case G_REGEX_ERROR_UNMATCHED_PARENTHESIS:
 247       *errmsg = _("missing terminating )");
 248       break;
 249     case 122:
 250       *errcode = G_REGEX_ERROR_UNMATCHED_PARENTHESIS;
 251       *errmsg = _(") without opening (");
 252       break;
 253     case 129:
 254       *errcode = G_REGEX_ERROR_UNMATCHED_PARENTHESIS;
 255       /* translators: '(?R' and '(?[+-]digits' are both meant as (groups of)
 256        * sequences here, '(?-54' would be an example for the second group.
 257        */
 258       *errmsg = _("(?R or (?[+-]digits must be followed by )");
 259       break;
 260     case G_REGEX_ERROR_INEXISTENT_SUBPATTERN_REFERENCE:
 261       *errmsg = _("reference to non-existent subpattern");
 262       break;
 263     case G_REGEX_ERROR_UNTERMINATED_COMMENT:
 264       *errmsg = _("missing ) after comment");
 265       break;
 266     case G_REGEX_ERROR_EXPRESSION_TOO_LARGE:
 267       *errmsg = _("regular expression too large");
 268       break;
 269     case G_REGEX_ERROR_MEMORY_ERROR:
 270       *errmsg = _("failed to get memory");
 271       break;
 272     case G_REGEX_ERROR_VARIABLE_LENGTH_LOOKBEHIND:
 273       *errmsg = _("lookbehind assertion is not fixed length");
 274       break;
 275     case G_REGEX_ERROR_MALFORMED_CONDITION:
 276       *errmsg = _("malformed number or name after (?(");
 277       break;
 278     case G_REGEX_ERROR_TOO_MANY_CONDITIONAL_BRANCHES:
 279       *errmsg = _("conditional group contains more than two branches");
 280       break;
 281     case G_REGEX_ERROR_ASSERTION_EXPECTED:
 282       *errmsg = _("assertion expected after (?(");
 283       break;
 284     case G_REGEX_ERROR_UNKNOWN_POSIX_CLASS_NAME:
 285       *errmsg = _("unknown POSIX class name");
 286       break;
 287     case G_REGEX_ERROR_POSIX_COLLATING_ELEMENTS_NOT_SUPPORTED:
 288       *errmsg = _("POSIX collating elements are not supported");
 289       break;
 290     case G_REGEX_ERROR_HEX_CODE_TOO_LARGE:
 291       *errmsg = _("character value in \\x{...} sequence is too large");
 292       break;
 293     case G_REGEX_ERROR_INVALID_CONDITION:
 294       *errmsg = _("invalid condition (?(0)");
 295       break;
 296     case G_REGEX_ERROR_SINGLE_BYTE_MATCH_IN_LOOKBEHIND:
 297       *errmsg = _("\\C not allowed in lookbehind assertion");
 298       break;
 299     case G_REGEX_ERROR_INFINITE_LOOP:
 300       *errmsg = _("recursive call could loop indefinitely");
 301       break;
 302     case G_REGEX_ERROR_MISSING_SUBPATTERN_NAME_TERMINATOR:
 303       *errmsg = _("missing terminator in subpattern name");
 304       break;
 305     case G_REGEX_ERROR_DUPLICATE_SUBPATTERN_NAME:
 306       *errmsg = _("two named subpatterns have the same name");
 307       break;
 308     case G_REGEX_ERROR_MALFORMED_PROPERTY:
 309       *errmsg = _("malformed \\P or \\p sequence");
 310       break;
 311     case G_REGEX_ERROR_UNKNOWN_PROPERTY:
 312       *errmsg = _("unknown property name after \\P or \\p");
 313       break;
 314     case G_REGEX_ERROR_SUBPATTERN_NAME_TOO_LONG:
 315       *errmsg = _("subpattern name is too long (maximum 32 characters)");
 316       break;
 317     case G_REGEX_ERROR_TOO_MANY_SUBPATTERNS:
 318       *errmsg = _("too many named subpatterns (maximum 10,000)");
 319       break;
 320     case G_REGEX_ERROR_INVALID_OCTAL_VALUE:
 321       *errmsg = _("octal value is greater than \\377");
 322       break;
 323     case G_REGEX_ERROR_TOO_MANY_BRANCHES_IN_DEFINE:
 324       *errmsg = _("DEFINE group contains more than one branch");
 325       break;
 326     case G_REGEX_ERROR_DEFINE_REPETION:
 327       *errmsg = _("repeating a DEFINE group is not allowed");
 328       break;
 329     case G_REGEX_ERROR_INCONSISTENT_NEWLINE_OPTIONS:
 330       *errmsg = _("inconsistent NEWLINE options");
 331       break;
 332     case G_REGEX_ERROR_MISSING_BACK_REFERENCE:
 333       *errmsg = _("\\g is not followed by a braced name or an optionally "
 334                  "braced non-zero number");
 335       break;
 336     case 11:
 337       *errcode = G_REGEX_ERROR_INTERNAL;
 338       *errmsg = _("unexpected repeat");
 339       break;
 340     case 23:
 341       *errcode = G_REGEX_ERROR_INTERNAL;
 342       *errmsg = _("code overflow");
 343       break;
 344     case 52:
 345       *errcode = G_REGEX_ERROR_INTERNAL;
 346       *errmsg = _("overran compiling workspace");
 347       break;
 348     case 53:
 349       *errcode = G_REGEX_ERROR_INTERNAL;
 350       *errmsg = _("previously-checked referenced subpattern not found");
 351       break;
 352     case 16:
 353       /* This should not happen as we never pass a NULL erroffset */
 354       g_warning ("erroffset passed as NULL");
 355       *errcode = G_REGEX_ERROR_COMPILE;
 356       break;
 357     case 17:
 358       /* This should not happen as we check options before passing them
 359        * to pcre_compile2() */
 360       g_warning ("unknown option bit(s) set");
 361       *errcode = G_REGEX_ERROR_COMPILE;
 362       break;
 363     case 32:
 364     case 44:
 365     case 45:
 366       /* These errors should not happen as we are using an UTF8-enabled PCRE
 367        * and we do not check if strings are valid */
 368       g_warning ("%s", *errmsg);
 369       *errcode = G_REGEX_ERROR_COMPILE;
 370       break;
 371     default:
 372       *errcode = G_REGEX_ERROR_COMPILE;
 373     }
 374 }
 375
 376 /* GMatchInfo */
 377
 378 static GMatchInfo *
 379 match_info_new (const GRegex *regex,
 380                 const gchar  *string,
 381                 gint          string_len,
 382                 gint          start_position,
 383                 gint          match_options,
 384                 gboolean      is_dfa)
 385 {
 386   GMatchInfo *match_info;
 387
 388   if (string_len < 0)
 389     string_len = strlen (string);
 390
 391   match_info = g_new0 (GMatchInfo, 1);
 392   match_info->regex = g_regex_ref ((GRegex *)regex);
 393   match_info->string = string;
 394   match_info->string_len = string_len;
 395   match_info->matches = PCRE_ERROR_NOMATCH;
 396   match_info->pos = start_position;
 397   match_info->match_opts = match_options;
 398
 399   if (is_dfa)
 400     {
 401       /* These values should be enough for most cases, if they are not
 402        * enough g_regex_match_all_full() will expand them. */
 403       match_info->n_offsets = 24;
 404       match_info->n_workspace = 100;
 405       match_info->workspace = g_new (gint, match_info->n_workspace);
 406     }
 407   else
 408     {
 409       gint capture_count;
 410       pcre_fullinfo (regex->pcre_re, regex->extra,
 411                      PCRE_INFO_CAPTURECOUNT, &capture_count);
 412       match_info->n_offsets = (capture_count + 1) * 3;
 413     }
 414
 415   match_info->offsets = g_new0 (gint, match_info->n_offsets);
 416   /* Set an invalid position for the previous match. */
 417   match_info->offsets[0] = -1;
 418   match_info->offsets[1] = -1;
 419
 420   return match_info;
 421 }
 422
 423 /**
 424  * g_match_info_get_regex:
 425  * @match_info: a #GMatchInfo
 426  *
 427  * Returns #GRegex object used in @match_info. It belongs to Glib
 428  * and must not be freed. Use g_regex_ref() if you need to keep it
 429  * after you free @match_info object.
 430  *
 431  * Returns: #GRegex object used in @match_info
 432  *
 433  * Since: 2.14
 434  */
 435 GRegex *
 436 g_match_info_get_regex (const GMatchInfo *match_info)
 437 {
 438   g_return_val_if_fail (match_info != NULL, NULL);
 439   return match_info->regex;
 440 }
 441
 442 /**
 443  * g_match_info_get_string:
 444  * @match_info: a #GMatchInfo
 445  *
 446  * Returns the string searched with @match_info. This is the
 447  * string passed to g_regex_match() or g_regex_replace() so
 448  * you may not free it before calling this function.
 449  *
 450  * Returns: the string searched with @match_info
 451  *
 452  * Since: 2.14
 453  */
 454 const gchar *
 455 g_match_info_get_string (const GMatchInfo *match_info)
 456 {
 457   g_return_val_if_fail (match_info != NULL, NULL);
 458   return match_info->string;
 459 }
 460
 461 /**
 462  * g_match_info_free:
 463  * @match_info: a #GMatchInfo
 464  *
 465  * Frees all the memory associated with the #GMatchInfo structure.
 466  *
 467  * Since: 2.14
 468  */
 469 void
 470 g_match_info_free (GMatchInfo *match_info)
 471 {
 472   if (match_info)
 473     {
 474       g_regex_unref (match_info->regex);
 475       g_free (match_info->offsets);
 476       g_free (match_info->workspace);
 477       g_free (match_info);
 478     }
 479 }
 480
 481 /**
 482  * g_match_info_next:
 483  * @match_info: a #GMatchInfo structure
 484  * @error: location to store the error occuring, or %NULL to ignore errors
 485  *
 486  * Scans for the next match using the same parameters of the previous
 487  * call to g_regex_match_full() or g_regex_match() that returned
 488  * @match_info.
 489  *
 490  * The match is done on the string passed to the match function, so you
 491  * cannot free it before calling this function.
 492  *
 493  * Returns: %TRUE is the string matched, %FALSE otherwise
 494  *
 495  * Since: 2.14
 496  */
 497 gboolean
 498 g_match_info_next (GMatchInfo  *match_info,
 499                    GError     **error)
 500 {
 501   gint opts;
 502   gint prev_match_start;
 503   gint prev_match_end;
 504
 505   g_return_val_if_fail (match_info != NULL, FALSE);
 506   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
 507   g_return_val_if_fail (match_info->pos >= 0, FALSE);
 508
 509   opts = match_info->regex->match_opts | match_info->match_opts;
 510
 511   prev_match_start = match_info->offsets[0];
 512   prev_match_end = match_info->offsets[1];
 513
 514   match_info->matches = pcre_exec (match_info->regex->pcre_re,
 515                                    match_info->regex->extra,
 516                                    match_info->string,
 517                                    match_info->string_len,
 518                                    match_info->pos,
 519                                    match_info->regex->match_opts |
 520                                    match_info->match_opts,
 521                                    match_info->offsets,
 522                                    match_info->n_offsets);
 523   if (IS_PCRE_ERROR (match_info->matches))
 524     {
 525       g_set_error (error, G_REGEX_ERROR, G_REGEX_ERROR_MATCH,
 526                    _("Error while matching regular expression %s: %s"),
 527                    match_info->regex->pattern, match_error (match_info->matches));
 528       return FALSE;
 529     }
 530
 531   /* avoid infinite loops if the pattern is an empty string or something
 532    * equivalent */
 533   if (match_info->pos == match_info->offsets[1])
 534     {
 535       if (match_info->pos > match_info->string_len)
 536         {
 537           /* we have reached the end of the string */
 538           match_info->pos = -1;
 539           match_info->matches = PCRE_ERROR_NOMATCH;
 540           return FALSE;
 541         }
 542
 543       match_info->pos = NEXT_CHAR (match_info->regex,
 544                                    &match_info->string[match_info->pos]) -
 545                                    match_info->string;
 546     }
 547   else
 548     {
 549       match_info->pos = match_info->offsets[1];
 550     }
 551
 552   /* it's possibile to get two identical matches when we are matching
 553    * empty strings, for instance if the pattern is "(?=[A-Z0-9])" and
 554    * the string is "RegExTest" we have:
 555    *  - search at position 0: match from 0 to 0
 556    *  - search at position 1: match from 3 to 3
 557    *  - search at position 3: match from 3 to 3 (duplicate)
 558    *  - search at position 4: match from 5 to 5
 559    *  - search at position 5: match from 5 to 5 (duplicate)
 560    *  - search at position 6: no match -> stop
 561    * so we have to ignore the duplicates.
 562    * see bug #515944: http://bugzilla.gnome.org/show_bug.cgi?id=515944 */
 563   if (match_info->matches >= 0 &&
 564       prev_match_start == match_info->offsets[0] &&
 565       prev_match_end == match_info->offsets[1])
 566     {
 567       /* ignore this match and search the next one */
 568       return g_match_info_next (match_info, error);
 569     }
 570
 571   return match_info->matches >= 0;
 572 }
 573
 574 /**
 575  * g_match_info_matches:
 576  * @match_info: a #GMatchInfo structure
 577  *
 578  * Returns whether the previous match operation succeeded.
 579  *
 580  * Returns: %TRUE if the previous match operation succeeded,
 581  *   %FALSE otherwise
 582  *
 583  * Since: 2.14
 584  */
 585 gboolean
 586 g_match_info_matches (const GMatchInfo *match_info)
 587 {
 588   g_return_val_if_fail (match_info != NULL, FALSE);
 589
 590   return match_info->matches >= 0;
 591 }
 592
 593 /**
 594  * g_match_info_get_match_count:
 595  * @match_info: a #GMatchInfo structure
 596  *
 597  * Retrieves the number of matched substrings (including substring 0,
 598  * that is the whole matched text), so 1 is returned if the pattern
 599  * has no substrings in it and 0 is returned if the match failed.
 600  *
 601  * If the last match was obtained using the DFA algorithm, that is
 602  * using g_regex_match_all() or g_regex_match_all_full(), the retrieved
 603  * count is not that of the number of capturing parentheses but that of
 604  * the number of matched substrings.
 605  *
 606  * Returns: Number of matched substrings, or -1 if an error occurred
 607  *
 608  * Since: 2.14
 609  */
 610 gint
 611 g_match_info_get_match_count (const GMatchInfo *match_info)
 612 {
 613   g_return_val_if_fail (match_info, -1);
 614
 615   if (match_info->matches == PCRE_ERROR_NOMATCH)
 616     /* no match */
 617     return 0;
 618   else if (match_info->matches < PCRE_ERROR_NOMATCH)
 619     /* error */
 620     return -1;
 621   else
 622     /* match */
 623     return match_info->matches;
 624 }
 625
 626 /**
 627  * g_match_info_is_partial_match:
 628  * @match_info: a #GMatchInfo structure
 629  *
 630  * Usually if the string passed to g_regex_match*() matches as far as
 631  * it goes, but is too short to match the entire pattern, %FALSE is
 632  * returned. There are circumstances where it might be helpful to
 633  * distinguish this case from other cases in which there is no match.
 634  *
 635  * Consider, for example, an application where a human is required to
 636  * type in data for a field with specific formatting requirements. An
 637  * example might be a date in the form ddmmmyy, defined by the pattern
 638  * "^\d?\d(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\d\d$".
 639  * If the application sees the user’s keystrokes one by one, and can
 640  * check that what has been typed so far is potentially valid, it is
 641  * able to raise an error as soon as a mistake is made.
 642  *
 643  * GRegex supports the concept of partial matching by means of the
 644  * #G_REGEX_MATCH_PARTIAL flag. When this is set the return code for
 645  * g_regex_match() or g_regex_match_full() is, as usual, %TRUE
 646  * for a complete match, %FALSE otherwise. But, when these functions
 647  * return %FALSE, you can check if the match was partial calling
 648  * g_match_info_is_partial_match().
 649  *
 650  * When using partial matching you cannot use g_match_info_fetch*().
 651  *
 652  * Because of the way certain internal optimizations are implemented
 653  * the partial matching algorithm cannot be used with all patterns.
 654  * So repeated single characters such as "a{2,4}" and repeated single
 655  * meta-sequences such as "\d+" are not permitted if the maximum number
 656  * of occurrences is greater than one. Optional items such as "\d?"
 657  * (where the maximum is one) are permitted. Quantifiers with any values
 658  * are permitted after parentheses, so the invalid examples above can be
 659  * coded thus "(a){2,4}" and "(\d)+". If #G_REGEX_MATCH_PARTIAL is set
 660  * for a pattern that does not conform to the restrictions, matching
 661  * functions return an error.
 662  *
 663  * Returns: %TRUE if the match was partial, %FALSE otherwise
 664  *
 665  * Since: 2.14
 666  */
 667 gboolean
 668 g_match_info_is_partial_match (const GMatchInfo *match_info)
 669 {
 670   g_return_val_if_fail (match_info != NULL, FALSE);
 671
 672   return match_info->matches == PCRE_ERROR_PARTIAL;
 673 }
 674
 675 /**
 676  * g_match_info_expand_references:
 677  * @match_info: a #GMatchInfo or %NULL
 678  * @string_to_expand: the string to expand
 679  * @error: location to store the error occuring, or %NULL to ignore errors
 680  *
 681  * Returns a new string containing the text in @string_to_expand with
 682  * references and escape sequences expanded. References refer to the last
 683  * match done with @string against @regex and have the same syntax used by
 684  * g_regex_replace().
 685  *
 686  * The @string_to_expand must be UTF-8 encoded even if #G_REGEX_RAW was
 687  * passed to g_regex_new().
 688  *
 689  * The backreferences are extracted from the string passed to the match
 690  * function, so you cannot call this function after freeing the string.
 691  *
 692  * @match_info may be %NULL in which case @string_to_expand must not
 693  * contain references. For instance "foo\n" does not refer to an actual
 694  * pattern and '\n' merely will be replaced with \n character,
 695  * while to expand "\0" (whole match) one needs the result of a match.
 696  * Use g_regex_check_replacement() to find out whether @string_to_expand
 697  * contains references.
 698  *
 699  * Returns: the expanded string, or %NULL if an error occurred
 700  *
 701  * Since: 2.14
 702  */
 703 gchar *
 704 g_match_info_expand_references (const GMatchInfo  *match_info,
 705                                 const gchar       *string_to_expand,
 706                                 GError           **error)
 707 {
 708   GString *result;
 709   GList *list;
 710   GError *tmp_error = NULL;
 711
 712   g_return_val_if_fail (string_to_expand != NULL, NULL);
 713   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
 714
 715   list = split_replacement (string_to_expand, &tmp_error);
 716   if (tmp_error != NULL)
 717     {
 718       g_propagate_error (error, tmp_error);
 719       return NULL;
 720     }
 721
 722   if (!match_info && interpolation_list_needs_match (list))
 723     {
 724       g_critical ("String '%s' contains references to the match, can't "
 725                   "expand references without GMatchInfo object",
 726                   string_to_expand);
 727       return NULL;
 728     }
 729
 730   result = g_string_sized_new (strlen (string_to_expand));
 731   interpolate_replacement (match_info, result, list);
 732
 733   g_list_foreach (list, (GFunc)free_interpolation_data, NULL);
 734   g_list_free (list);
 735
 736   return g_string_free (result, FALSE);
 737 }
 738
 739 /**
 740  * g_match_info_fetch:
 741  * @match_info: #GMatchInfo structure
 742  * @match_num: number of the sub expression
 743  *
 744  * Retrieves the text matching the @match_num<!-- -->'th capturing
 745  * parentheses. 0 is the full text of the match, 1 is the first paren
 746  * set, 2 the second, and so on.
 747  *
 748  * If @match_num is a valid sub pattern but it didn't match anything
 749  * (e.g. sub pattern 1, matching "b" against "(a)?b") then an empty
 750  * string is returned.
 751  *
 752  * If the match was obtained using the DFA algorithm, that is using
 753  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
 754  * string is not that of a set of parentheses but that of a matched
 755  * substring. Substrings are matched in reverse order of length, so
 756  * 0 is the longest match.
 757  *
 758  * The string is fetched from the string passed to the match function,
 759  * so you cannot call this function after freeing the string.
 760  *
 761  * Returns: The matched substring, or %NULL if an error occurred.
 762  *          You have to free the string yourself
 763  *
 764  * Since: 2.14
 765  */
 766 gchar *
 767 g_match_info_fetch (const GMatchInfo *match_info,
 768                     gint              match_num)
 769 {
 770   /* we cannot use pcre_get_substring() because it allocates the
 771    * string using pcre_malloc(). */
 772   gchar *match = NULL;
 773   gint start, end;
 774
 775   g_return_val_if_fail (match_info != NULL, NULL);
 776   g_return_val_if_fail (match_num >= 0, NULL);
 777
 778   /* match_num does not exist or it didn't matched, i.e. matching "b"
 779    * against "(a)?b" then group 0 is empty. */
 780   if (!g_match_info_fetch_pos (match_info, match_num, &start, &end))
 781     match = NULL;
 782   else if (start == -1)
 783     match = g_strdup ("");
 784   else
 785     match = g_strndup (&match_info->string[start], end - start);
 786
 787   return match;
 788 }
 789
 790 /**
 791  * g_match_info_fetch_pos:
 792  * @match_info: #GMatchInfo structure
 793  * @match_num: number of the sub expression
 794  * @start_pos: pointer to location where to store the start position
 795  * @end_pos: pointer to location where to store the end position
 796  *
 797  * Retrieves the position of the @match_num<!-- -->'th capturing
 798  * parentheses. 0 is the full text of the match, 1 is the first
 799  * paren set, 2 the second, and so on.
 800  *
 801  * If @match_num is a valid sub pattern but it didn't match anything
 802  * (e.g. sub pattern 1, matching "b" against "(a)?b") then @start_pos
 803  * and @end_pos are set to -1 and %TRUE is returned.
 804  *
 805  * If the match was obtained using the DFA algorithm, that is using
 806  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
 807  * position is not that of a set of parentheses but that of a matched
 808  * substring. Substrings are matched in reverse order of length, so
 809  * 0 is the longest match.
 810  *
 811  * Returns: %TRUE if the position was fetched, %FALSE otherwise. If
 812  *   the position cannot be fetched, @start_pos and @end_pos are left
 813  *   unchanged
 814  *
 815  * Since: 2.14
 816  */
 817 gboolean
 818 g_match_info_fetch_pos (const GMatchInfo *match_info,
 819                         gint              match_num,
 820                         gint             *start_pos,
 821                         gint             *end_pos)
 822 {
 823   g_return_val_if_fail (match_info != NULL, FALSE);
 824   g_return_val_if_fail (match_num >= 0, FALSE);
 825
 826   /* make sure the sub expression number they're requesting is less than
 827    * the total number of sub expressions that were matched. */
 828   if (match_num >= match_info->matches)
 829     return FALSE;
 830
 831   if (start_pos != NULL)
 832     *start_pos = match_info->offsets[2 * match_num];
 833
 834   if (end_pos != NULL)
 835     *end_pos = match_info->offsets[2 * match_num + 1];
 836
 837   return TRUE;
 838 }
 839
 840 /*
 841  * Returns number of first matched subpattern with name @name.
 842  * There may be more than one in case when DUPNAMES is used,
 843  * and not all subpatterns with that name match;
 844  * pcre_get_stringnumber() does not work in that case.
 845  */
 846 static gint
 847 get_matched_substring_number (const GMatchInfo *match_info,
 848                               const gchar      *name)
 849 {
 850   gint entrysize;
 851   gchar *first, *last;
 852   guchar *entry;
 853
 854   if (!(match_info->regex->compile_opts & G_REGEX_DUPNAMES))
 855     return pcre_get_stringnumber (match_info->regex->pcre_re, name);
 856
 857   /* This code is copied from pcre_get.c: get_first_set() */
 858   entrysize = pcre_get_stringtable_entries (match_info->regex->pcre_re,
 859                                             name,
 860                                             &first,
 861                                             &last);
 862
 863   if (entrysize <= 0)
 864     return entrysize;
 865
 866   for (entry = (guchar*) first; entry <= (guchar*) last; entry += entrysize)
 867     {
 868       gint n = (entry[0] << 8) + entry[1];
 869       if (match_info->offsets[n*2] >= 0)
 870         return n;
 871     }
 872
 873   return (first[0] << 8) + first[1];
 874 }
 875
 876 /**
 877  * g_match_info_fetch_named:
 878  * @match_info: #GMatchInfo structure
 879  * @name: name of the subexpression
 880  *
 881  * Retrieves the text matching the capturing parentheses named @name.
 882  *
 883  * If @name is a valid sub pattern name but it didn't match anything
 884  * (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b")
 885  * then an empty string is returned.
 886  *
 887  * The string is fetched from the string passed to the match function,
 888  * so you cannot call this function after freeing the string.
 889  *
 890  * Returns: The matched substring, or %NULL if an error occurred.
 891  *          You have to free the string yourself
 892  *
 893  * Since: 2.14
 894  */
 895 gchar *
 896 g_match_info_fetch_named (const GMatchInfo *match_info,
 897                           const gchar      *name)
 898 {
 899   /* we cannot use pcre_get_named_substring() because it allocates the
 900    * string using pcre_malloc(). */
 901   gint num;
 902
 903   g_return_val_if_fail (match_info != NULL, NULL);
 904   g_return_val_if_fail (name != NULL, NULL);
 905
 906   num = get_matched_substring_number (match_info, name);
 907   if (num < 0)
 908     return NULL;
 909   else
 910     return g_match_info_fetch (match_info, num);
 911 }
 912
 913 /**
 914  * g_match_info_fetch_named_pos:
 915  * @match_info: #GMatchInfo structure
 916  * @name: name of the subexpression
 917  * @start_pos: pointer to location where to store the start position
 918  * @end_pos: pointer to location where to store the end position
 919  *
 920  * Retrieves the position of the capturing parentheses named @name.
 921  *
 922  * If @name is a valid sub pattern name but it didn't match anything
 923  * (e.g. sub pattern "X", matching "b" against "(?P&lt;X&gt;a)?b")
 924  * then @start_pos and @end_pos are set to -1 and %TRUE is returned.
 925  *
 926  * Returns: %TRUE if the position was fetched, %FALSE otherwise. If
 927  *   the position cannot be fetched, @start_pos and @end_pos are left
 928  *   unchanged
 929  *
 930  * Since: 2.14
 931  */
 932 gboolean
 933 g_match_info_fetch_named_pos (const GMatchInfo *match_info,
 934                               const gchar      *name,
 935                               gint             *start_pos,
 936                               gint             *end_pos)
 937 {
 938   gint num;
 939
 940   g_return_val_if_fail (match_info != NULL, FALSE);
 941   g_return_val_if_fail (name != NULL, FALSE);
 942
 943   num = get_matched_substring_number (match_info, name);
 944   if (num < 0)
 945     return FALSE;
 946
 947   return g_match_info_fetch_pos (match_info, num, start_pos, end_pos);
 948 }
 949
 950 /**
 951  * g_match_info_fetch_all:
 952  * @match_info: a #GMatchInfo structure
 953  *
 954  * Bundles up pointers to each of the matching substrings from a match
 955  * and stores them in an array of gchar pointers. The first element in
 956  * the returned array is the match number 0, i.e. the entire matched
 957  * text.
 958  *
 959  * If a sub pattern didn't match anything (e.g. sub pattern 1, matching
 960  * "b" against "(a)?b") then an empty string is inserted.
 961  *
 962  * If the last match was obtained using the DFA algorithm, that is using
 963  * g_regex_match_all() or g_regex_match_all_full(), the retrieved
 964  * strings are not that matched by sets of parentheses but that of the
 965  * matched substring. Substrings are matched in reverse order of length,
 966  * so the first one is the longest match.
 967  *
 968  * The strings are fetched from the string passed to the match function,
 969  * so you cannot call this function after freeing the string.
 970  *
 971  * Returns: a %NULL-terminated array of gchar * pointers. It must be
 972  *   freed using g_strfreev(). If the previous match failed %NULL is
 973  *   returned
 974  *
 975  * Since: 2.14
 976  */
 977 gchar **
 978 g_match_info_fetch_all (const GMatchInfo *match_info)
 979 {
 980   /* we cannot use pcre_get_substring_list() because the returned value
 981    * isn't suitable for g_strfreev(). */
 982   gchar **result;
 983   gint i;
 984
 985   g_return_val_if_fail (match_info != NULL, NULL);
 986
 987   if (match_info->matches < 0)
 988     return NULL;
 989
 990   result = g_new (gchar *, match_info->matches + 1);
 991   for (i = 0; i < match_info->matches; i++)
 992     result[i] = g_match_info_fetch (match_info, i);
 993   result[i] = NULL;
 994
 995   return result;
 996 }
 997
 998
 999 /* GRegex */
1000
1001 GQuark
1002 g_regex_error_quark (void)
1003 {
1004   static GQuark error_quark = 0;
1005
1006   if (error_quark == 0)
1007     error_quark = g_quark_from_static_string ("g-regex-error-quark");
1008
1009   return error_quark;
1010 }
1011
1012 /**
1013  * g_regex_ref:
1014  * @regex: a #GRegex
1015  *
1016  * Increases reference count of @regex by 1.
1017  *
1018  * Returns: @regex
1019  *
1020  * Since: 2.14
1021  */
1022 GRegex *
1023 g_regex_ref (GRegex *regex)
1024 {
1025   g_return_val_if_fail (regex != NULL, NULL);
1026   g_atomic_int_inc (&regex->ref_count);
1027   return regex;
1028 }
1029
1030 /**
1031  * g_regex_unref:
1032  * @regex: a #GRegex
1033  *
1034  * Decreases reference count of @regex by 1. When reference count drops
1035  * to zero, it frees all the memory associated with the regex structure.
1036  *
1037  * Since: 2.14
1038  */
1039 void
1040 g_regex_unref (GRegex *regex)
1041 {
1042   g_return_if_fail (regex != NULL);
1043
1044   if (g_atomic_int_exchange_and_add (&regex->ref_count, -1) - 1 == 0)
1045     {
1046       g_free (regex->pattern);
1047       if (regex->pcre_re != NULL)
1048         pcre_free (regex->pcre_re);
1049       if (regex->extra != NULL)
1050         pcre_free (regex->extra);
1051       g_free (regex);
1052     }
1053 }
1054
1055 /**
1056  * g_regex_new:
1057  * @pattern: the regular expression
1058  * @compile_options: compile options for the regular expression, or 0
1059  * @match_options: match options for the regular expression, or 0
1060  * @error: return location for a #GError
1061  *
1062  * Compiles the regular expression to an internal form, and does
1063  * the initial setup of the #GRegex structure.
1064  *
1065  * Returns: a #GRegex structure. Call g_regex_unref() when you
1066  *   are done with it
1067  *
1068  * Since: 2.14
1069  */
1070 GRegex *
1071 g_regex_new (const gchar         *pattern,
1072              GRegexCompileFlags   compile_options,
1073              GRegexMatchFlags     match_options,
1074              GError             **error)
1075 {
1076   GRegex *regex;
1077   pcre *re;
1078   const gchar *errmsg;
1079   gint erroffset;
1080   gint errcode;
1081   gboolean optimize = FALSE;
1082   static gboolean initialized = FALSE;
1083   unsigned long int pcre_compile_options;
1084
1085   g_return_val_if_fail (pattern != NULL, NULL);
1086   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1087   g_return_val_if_fail ((compile_options & ~G_REGEX_COMPILE_MASK) == 0, NULL);
1088   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
1089
1090   if (!initialized)
1091     {
1092       gint support;
1093       const gchar *msg;
1094
1095       pcre_config (PCRE_CONFIG_UTF8, &support);
1096       if (!support)
1097         {
1098           msg = N_("PCRE library is compiled without UTF8 support");
1099           g_critical ("%s", msg);
1100           g_set_error_literal (error, G_REGEX_ERROR, G_REGEX_ERROR_COMPILE, gettext (msg));
1101           return NULL;
1102         }
1103
1104       pcre_config (PCRE_CONFIG_UNICODE_PROPERTIES, &support);
1105       if (!support)
1106         {
1107           msg = N_("PCRE library is compiled without UTF8 properties support");
1108           g_critical ("%s", msg);
1109           g_set_error_literal (error, G_REGEX_ERROR, G_REGEX_ERROR_COMPILE, gettext (msg));
1110           return NULL;
1111         }
1112
1113       initialized = TRUE;
1114     }
1115
1116   /* G_REGEX_OPTIMIZE has the same numeric value of PCRE_NO_UTF8_CHECK,
1117    * as we do not need to wrap PCRE_NO_UTF8_CHECK. */
1118   if (compile_options & G_REGEX_OPTIMIZE)
1119     optimize = TRUE;
1120
1121   /* In GRegex the string are, by default, UTF-8 encoded. PCRE
1122    * instead uses UTF-8 only if required with PCRE_UTF8. */
1123   if (compile_options & G_REGEX_RAW)
1124     {
1125       /* disable utf-8 */
1126       compile_options &= ~G_REGEX_RAW;
1127     }
1128   else
1129     {
1130       /* enable utf-8 */
1131       compile_options |= PCRE_UTF8 | PCRE_NO_UTF8_CHECK;
1132       match_options |= PCRE_NO_UTF8_CHECK;
1133     }
1134
1135   /* PCRE_NEWLINE_ANY is the default for the internal PCRE but
1136    * not for the system one. */
1137   if (!(compile_options & G_REGEX_NEWLINE_CR) &&
1138       !(compile_options & G_REGEX_NEWLINE_LF))
1139     {
1140       compile_options |= PCRE_NEWLINE_ANY;
1141     }
1142
1143   /* compile the pattern */
1144   re = pcre_compile2 (pattern, compile_options, &errcode,
1145                       &errmsg, &erroffset, NULL);
1146
1147   /* if the compilation failed, set the error member and return
1148    * immediately */
1149   if (re == NULL)
1150     {
1151       GError *tmp_error;
1152
1153       /* Translate the PCRE error code to GRegexError and use a translated
1154        * error message if possible */
1155       translate_compile_error (&errcode, &errmsg);
1156
1157       /* PCRE uses byte offsets but we want to show character offsets */
1158       erroffset = g_utf8_pointer_to_offset (pattern, &pattern[erroffset]);
1159
1160       tmp_error = g_error_new (G_REGEX_ERROR, errcode,
1161                                _("Error while compiling regular "
1162                                  "expression %s at char %d: %s"),
1163                                pattern, erroffset, errmsg);
1164       g_propagate_error (error, tmp_error);
1165
1166       return NULL;
1167     }
1168
1169   /* For options set at the beginning of the pattern, pcre puts them into
1170    * compile options, e.g. "(?i)foo" will make the pcre structure store
1171    * PCRE_CASELESS even though it wasn't explicitly given for compilation. */
1172   pcre_fullinfo (re, NULL, PCRE_INFO_OPTIONS, &pcre_compile_options);
1173   compile_options = pcre_compile_options;
1174
1175   if (!(compile_options & G_REGEX_DUPNAMES))
1176     {
1177       gboolean jchanged = FALSE;
1178       pcre_fullinfo (re, NULL, PCRE_INFO_JCHANGED, &jchanged);
1179       if (jchanged)
1180         compile_options |= G_REGEX_DUPNAMES;
1181     }
1182
1183   regex = g_new0 (GRegex, 1);
1184   regex->ref_count = 1;
1185   regex->pattern = g_strdup (pattern);
1186   regex->pcre_re = re;
1187   regex->compile_opts = compile_options;
1188   regex->match_opts = match_options;
1189
1190   if (optimize)
1191     {
1192       regex->extra = pcre_study (regex->pcre_re, 0, &errmsg);
1193       if (errmsg != NULL)
1194         {
1195           GError *tmp_error = g_error_new (G_REGEX_ERROR,
1196                                            G_REGEX_ERROR_OPTIMIZE,
1197                                            _("Error while optimizing "
1198                                              "regular expression %s: %s"),
1199                                            regex->pattern,
1200                                            errmsg);
1201           g_propagate_error (error, tmp_error);
1202           return NULL;
1203         }
1204     }
1205
1206   return regex;
1207 }
1208
1209 /**
1210  * g_regex_get_pattern:
1211  * @regex: a #GRegex structure
1212  *
1213  * Gets the pattern string associated with @regex, i.e. a copy of
1214  * the string passed to g_regex_new().
1215  *
1216  * Returns: the pattern of @regex
1217  *
1218  * Since: 2.14
1219  */
1220 const gchar *
1221 g_regex_get_pattern (const GRegex *regex)
1222 {
1223   g_return_val_if_fail (regex != NULL, NULL);
1224
1225   return regex->pattern;
1226 }
1227
1228 /**
1229  * g_regex_get_max_backref:
1230  * @regex: a #GRegex
1231  *
1232  * Returns the number of the highest back reference
1233  * in the pattern, or 0 if the pattern does not contain
1234  * back references.
1235  *
1236  * Returns: the number of the highest back reference
1237  *
1238  * Since: 2.14
1239  */
1240 gint
1241 g_regex_get_max_backref (const GRegex *regex)
1242 {
1243   gint value;
1244
1245   pcre_fullinfo (regex->pcre_re, regex->extra,
1246                  PCRE_INFO_BACKREFMAX, &value);
1247
1248   return value;
1249 }
1250
1251 /**
1252  * g_regex_get_capture_count:
1253  * @regex: a #GRegex
1254  *
1255  * Returns the number of capturing subpatterns in the pattern.
1256  *
1257  * Returns: the number of capturing subpatterns
1258  *
1259  * Since: 2.14
1260  */
1261 gint
1262 g_regex_get_capture_count (const GRegex *regex)
1263 {
1264   gint value;
1265
1266   pcre_fullinfo (regex->pcre_re, regex->extra,
1267                  PCRE_INFO_CAPTURECOUNT, &value);
1268
1269   return value;
1270 }
1271
1272 /**
1273  * g_regex_match_simple:
1274  * @pattern: the regular expression
1275  * @string: the string to scan for matches
1276  * @compile_options: compile options for the regular expression, or 0
1277  * @match_options: match options, or 0
1278  *
1279  * Scans for a match in @string for @pattern.
1280  *
1281  * This function is equivalent to g_regex_match() but it does not
1282  * require to compile the pattern with g_regex_new(), avoiding some
1283  * lines of code when you need just to do a match without extracting
1284  * substrings, capture counts, and so on.
1285  *
1286  * If this function is to be called on the same @pattern more than
1287  * once, it's more efficient to compile the pattern once with
1288  * g_regex_new() and then use g_regex_match().
1289  *
1290  * Returns: %TRUE if the string matched, %FALSE otherwise
1291  *
1292  * Since: 2.14
1293  */
1294 gboolean
1295 g_regex_match_simple (const gchar        *pattern,
1296                       const gchar        *string,
1297                       GRegexCompileFlags  compile_options,
1298                       GRegexMatchFlags    match_options)
1299 {
1300   GRegex *regex;
1301   gboolean result;
1302
1303   regex = g_regex_new (pattern, compile_options, 0, NULL);
1304   if (!regex)
1305     return FALSE;
1306   result = g_regex_match_full (regex, string, -1, 0, match_options, NULL, NULL);
1307   g_regex_unref (regex);
1308   return result;
1309 }
1310
1311 /**
1312  * g_regex_match:
1313  * @regex: a #GRegex structure from g_regex_new()
1314  * @string: the string to scan for matches
1315  * @match_options: match options
1316  * @match_info: pointer to location where to store the #GMatchInfo,
1317  *   or %NULL if you do not need it
1318  *
1319  * Scans for a match in string for the pattern in @regex.
1320  * The @match_options are combined with the match options specified
1321  * when the @regex structure was created, letting you have more
1322  * flexibility in reusing #GRegex structures.
1323  *
1324  * A #GMatchInfo structure, used to get information on the match,
1325  * is stored in @match_info if not %NULL. Note that if @match_info
1326  * is not %NULL then it is created even if the function returns %FALSE,
1327  * i.e. you must free it regardless if regular expression actually matched.
1328  *
1329  * To retrieve all the non-overlapping matches of the pattern in
1330  * string you can use g_match_info_next().
1331  *
1332  * |[
1333  * static void
1334  * print_uppercase_words (const gchar *string)
1335  * {
1336  *   /&ast; Print all uppercase-only words. &ast;/
1337  *   GRegex *regex;
1338  *   GMatchInfo *match_info;
1339  *   &nbsp;
1340  *   regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1341  *   g_regex_match (regex, string, 0, &amp;match_info);
1342  *   while (g_match_info_matches (match_info))
1343  *     {
1344  *       gchar *word = g_match_info_fetch (match_info, 0);
1345  *       g_print ("Found: %s\n", word);
1346  *       g_free (word);
1347  *       g_match_info_next (match_info, NULL);
1348  *     }
1349  *   g_match_info_free (match_info);
1350  *   g_regex_unref (regex);
1351  * }
1352  * ]|
1353  *
1354  * Returns: %TRUE is the string matched, %FALSE otherwise
1355  *
1356  * Since: 2.14
1357  */
1358 gboolean
1359 g_regex_match (const GRegex      *regex,
1360                const gchar       *string,
1361                GRegexMatchFlags   match_options,
1362                GMatchInfo       **match_info)
1363 {
1364   return g_regex_match_full (regex, string, -1, 0, match_options,
1365                              match_info, NULL);
1366 }
1367
1368 /**
1369  * g_regex_match_full:
1370  * @regex: a #GRegex structure from g_regex_new()
1371  * @string: the string to scan for matches
1372  * @string_len: the length of @string, or -1 if @string is nul-terminated
1373  * @start_position: starting index of the string to match
1374  * @match_options: match options
1375  * @match_info: pointer to location where to store the #GMatchInfo,
1376  *   or %NULL if you do not need it
1377  * @error: location to store the error occuring, or %NULL to ignore errors
1378  *
1379  * Scans for a match in string for the pattern in @regex.
1380  * The @match_options are combined with the match options specified
1381  * when the @regex structure was created, letting you have more
1382  * flexibility in reusing #GRegex structures.
1383  *
1384  * Setting @start_position differs from just passing over a shortened
1385  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1386  * that begins with any kind of lookbehind assertion, such as "\b".
1387  *
1388  * A #GMatchInfo structure, used to get information on the match, is
1389  * stored in @match_info if not %NULL. Note that if @match_info is
1390  * not %NULL then it is created even if the function returns %FALSE,
1391  * i.e. you must free it regardless if regular expression actually
1392  * matched.
1393  *
1394  * @string is not copied and is used in #GMatchInfo internally. If
1395  * you use any #GMatchInfo method (except g_match_info_free()) after
1396  * freeing or modifying @string then the behaviour is undefined.
1397  *
1398  * To retrieve all the non-overlapping matches of the pattern in
1399  * string you can use g_match_info_next().
1400  *
1401  * |[
1402  * static void
1403  * print_uppercase_words (const gchar *string)
1404  * {
1405  *   /&ast; Print all uppercase-only words. &ast;/
1406  *   GRegex *regex;
1407  *   GMatchInfo *match_info;
1408  *   GError *error = NULL;
1409  *   &nbsp;
1410  *   regex = g_regex_new ("[A-Z]+", 0, 0, NULL);
1411  *   g_regex_match_full (regex, string, -1, 0, 0, &amp;match_info, &amp;error);
1412  *   while (g_match_info_matches (match_info))
1413  *     {
1414  *       gchar *word = g_match_info_fetch (match_info, 0);
1415  *       g_print ("Found: %s\n", word);
1416  *       g_free (word);
1417  *       g_match_info_next (match_info, &amp;error);
1418  *     }
1419  *   g_match_info_free (match_info);
1420  *   g_regex_unref (regex);
1421  *   if (error != NULL)
1422  *     {
1423  *       g_printerr ("Error while matching: %s\n", error->message);
1424  *       g_error_free (error);
1425  *     }
1426  * }
1427  * ]|
1428  *
1429  * Returns: %TRUE is the string matched, %FALSE otherwise
1430  *
1431  * Since: 2.14
1432  */
1433 gboolean
1434 g_regex_match_full (const GRegex      *regex,
1435                     const gchar       *string,
1436                     gssize             string_len,
1437                     gint               start_position,
1438                     GRegexMatchFlags   match_options,
1439                     GMatchInfo       **match_info,
1440                     GError           **error)
1441 {
1442   GMatchInfo *info;
1443   gboolean match_ok;
1444
1445   g_return_val_if_fail (regex != NULL, FALSE);
1446   g_return_val_if_fail (string != NULL, FALSE);
1447   g_return_val_if_fail (start_position >= 0, FALSE);
1448   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1449   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1450
1451   info = match_info_new (regex, string, string_len, start_position,
1452                          match_options, FALSE);
1453   match_ok = g_match_info_next (info, error);
1454   if (match_info != NULL)
1455     *match_info = info;
1456   else
1457     g_match_info_free (info);
1458
1459   return match_ok;
1460 }
1461
1462 /**
1463  * g_regex_match_all:
1464  * @regex: a #GRegex structure from g_regex_new()
1465  * @string: the string to scan for matches
1466  * @match_options: match options
1467  * @match_info: pointer to location where to store the #GMatchInfo,
1468  *   or %NULL if you do not need it
1469  *
1470  * Using the standard algorithm for regular expression matching only
1471  * the longest match in the string is retrieved. This function uses
1472  * a different algorithm so it can retrieve all the possible matches.
1473  * For more documentation see g_regex_match_all_full().
1474  *
1475  * A #GMatchInfo structure, used to get information on the match, is
1476  * stored in @match_info if not %NULL. Note that if @match_info is
1477  * not %NULL then it is created even if the function returns %FALSE,
1478  * i.e. you must free it regardless if regular expression actually
1479  * matched.
1480  *
1481  * Returns: %TRUE is the string matched, %FALSE otherwise
1482  *
1483  * Since: 2.14
1484  */
1485 gboolean
1486 g_regex_match_all (const GRegex      *regex,
1487                    const gchar       *string,
1488                    GRegexMatchFlags   match_options,
1489                    GMatchInfo       **match_info)
1490 {
1491   return g_regex_match_all_full (regex, string, -1, 0, match_options,
1492                                  match_info, NULL);
1493 }
1494
1495 /**
1496  * g_regex_match_all_full:
1497  * @regex: a #GRegex structure from g_regex_new()
1498  * @string: the string to scan for matches
1499  * @string_len: the length of @string, or -1 if @string is nul-terminated
1500  * @start_position: starting index of the string to match
1501  * @match_options: match options
1502  * @match_info: pointer to location where to store the #GMatchInfo,
1503  *   or %NULL if you do not need it
1504  * @error: location to store the error occuring, or %NULL to ignore errors
1505  *
1506  * Using the standard algorithm for regular expression matching only
1507  * the longest match in the string is retrieved, it is not possibile
1508  * to obtain all the available matches. For instance matching
1509  * "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;"
1510  * you get "&lt;a&gt; &lt;b&gt; &lt;c&gt;".
1511  *
1512  * This function uses a different algorithm (called DFA, i.e. deterministic
1513  * finite automaton), so it can retrieve all the possible matches, all
1514  * starting at the same point in the string. For instance matching
1515  * "&lt;a&gt; &lt;b&gt; &lt;c&gt;" against the pattern "&lt;.*&gt;"
1516  * you would obtain three matches: "&lt;a&gt; &lt;b&gt; &lt;c&gt;",
1517  * "&lt;a&gt; &lt;b&gt;" and "&lt;a&gt;".
1518  *
1519  * The number of matched strings is retrieved using
1520  * g_match_info_get_match_count(). To obtain the matched strings and
1521  * their position you can use, respectively, g_match_info_fetch() and
1522  * g_match_info_fetch_pos(). Note that the strings are returned in
1523  * reverse order of length; that is, the longest matching string is
1524  * given first.
1525  *
1526  * Note that the DFA algorithm is slower than the standard one and it
1527  * is not able to capture substrings, so backreferences do not work.
1528  *
1529  * Setting @start_position differs from just passing over a shortened
1530  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1531  * that begins with any kind of lookbehind assertion, such as "\b".
1532  *
1533  * A #GMatchInfo structure, used to get information on the match, is
1534  * stored in @match_info if not %NULL. Note that if @match_info is
1535  * not %NULL then it is created even if the function returns %FALSE,
1536  * i.e. you must free it regardless if regular expression actually
1537  * matched.
1538  *
1539  * Returns: %TRUE is the string matched, %FALSE otherwise
1540  *
1541  * Since: 2.14
1542  */
1543 gboolean
1544 g_regex_match_all_full (const GRegex      *regex,
1545                         const gchar       *string,
1546                         gssize             string_len,
1547                         gint               start_position,
1548                         GRegexMatchFlags   match_options,
1549                         GMatchInfo       **match_info,
1550                         GError           **error)
1551 {
1552   GMatchInfo *info;
1553   gboolean done;
1554
1555   g_return_val_if_fail (regex != NULL, FALSE);
1556   g_return_val_if_fail (string != NULL, FALSE);
1557   g_return_val_if_fail (start_position >= 0, FALSE);
1558   g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
1559   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, FALSE);
1560
1561   info = match_info_new (regex, string, string_len, start_position,
1562                          match_options, TRUE);
1563
1564   done = FALSE;
1565   while (!done)
1566     {
1567       done = TRUE;
1568       info->matches = pcre_dfa_exec (regex->pcre_re, regex->extra,
1569                                      info->string, info->string_len,
1570                                      info->pos,
1571                                      regex->match_opts | match_options,
1572                                      info->offsets, info->n_offsets,
1573                                      info->workspace, info->n_workspace);
1574       if (info->matches == PCRE_ERROR_DFA_WSSIZE)
1575         {
1576           /* info->workspace is too small. */
1577           info->n_workspace *= 2;
1578           info->workspace = g_realloc (info->workspace,
1579                                        info->n_workspace * sizeof (gint));
1580           done = FALSE;
1581         }
1582       else if (info->matches == 0)
1583         {
1584           /* info->offsets is too small. */
1585           info->n_offsets *= 2;
1586           info->offsets = g_realloc (info->offsets,
1587                                      info->n_offsets * sizeof (gint));
1588           done = FALSE;
1589         }
1590       else if (IS_PCRE_ERROR (info->matches))
1591         {
1592           g_set_error (error, G_REGEX_ERROR, G_REGEX_ERROR_MATCH,
1593                        _("Error while matching regular expression %s: %s"),
1594                        regex->pattern, match_error (info->matches));
1595         }
1596     }
1597
1598   /* set info->pos to -1 so that a call to g_match_info_next() fails. */
1599   info->pos = -1;
1600
1601   if (match_info != NULL)
1602     *match_info = info;
1603   else
1604     g_match_info_free (info);
1605
1606   return info->matches >= 0;
1607 }
1608
1609 /**
1610  * g_regex_get_string_number:
1611  * @regex: #GRegex structure
1612  * @name: name of the subexpression
1613  *
1614  * Retrieves the number of the subexpression named @name.
1615  *
1616  * Returns: The number of the subexpression or -1 if @name
1617  *   does not exists
1618  *
1619  * Since: 2.14
1620  */
1621 gint
1622 g_regex_get_string_number (const GRegex *regex,
1623                            const gchar  *name)
1624 {
1625   gint num;
1626
1627   g_return_val_if_fail (regex != NULL, -1);
1628   g_return_val_if_fail (name != NULL, -1);
1629
1630   num = pcre_get_stringnumber (regex->pcre_re, name);
1631   if (num == PCRE_ERROR_NOSUBSTRING)
1632     num = -1;
1633
1634   return num;
1635 }
1636
1637 /**
1638  * g_regex_split_simple:
1639  * @pattern: the regular expression
1640  * @string: the string to scan for matches
1641  * @compile_options: compile options for the regular expression, or 0
1642  * @match_options: match options, or 0
1643  *
1644  * Breaks the string on the pattern, and returns an array of
1645  * the tokens. If the pattern contains capturing parentheses,
1646  * then the text for each of the substrings will also be returned.
1647  * If the pattern does not match anywhere in the string, then the
1648  * whole string is returned as the first token.
1649  *
1650  * This function is equivalent to g_regex_split() but it does
1651  * not require to compile the pattern with g_regex_new(), avoiding
1652  * some lines of code when you need just to do a split without
1653  * extracting substrings, capture counts, and so on.
1654  *
1655  * If this function is to be called on the same @pattern more than
1656  * once, it's more efficient to compile the pattern once with
1657  * g_regex_new() and then use g_regex_split().
1658  *
1659  * As a special case, the result of splitting the empty string ""
1660  * is an empty vector, not a vector containing a single string.
1661  * The reason for this special case is that being able to represent
1662  * a empty vector is typically more useful than consistent handling
1663  * of empty elements. If you do need to represent empty elements,
1664  * you'll need to check for the empty string before calling this
1665  * function.
1666  *
1667  * A pattern that can match empty strings splits @string into
1668  * separate characters wherever it matches the empty string between
1669  * characters. For example splitting "ab c" using as a separator
1670  * "\s*", you will get "a", "b" and "c".
1671  *
1672  * Returns: a %NULL-terminated array of strings. Free it using g_strfreev()
1673  *
1674  * Since: 2.14
1675  **/
1676 gchar **
1677 g_regex_split_simple (const gchar        *pattern,
1678                       const gchar        *string,
1679                       GRegexCompileFlags  compile_options,
1680                       GRegexMatchFlags    match_options)
1681 {
1682   GRegex *regex;
1683   gchar **result;
1684
1685   regex = g_regex_new (pattern, compile_options, 0, NULL);
1686   if (!regex)
1687     return NULL;
1688   result = g_regex_split_full (regex, string, -1, 0, match_options, 0, NULL);
1689   g_regex_unref (regex);
1690   return result;
1691 }
1692
1693 /**
1694  * g_regex_split:
1695  * @regex: a #GRegex structure
1696  * @string: the string to split with the pattern
1697  * @match_options: match time option flags
1698  *
1699  * Breaks the string on the pattern, and returns an array of the tokens.
1700  * If the pattern contains capturing parentheses, then the text for each
1701  * of the substrings will also be returned. If the pattern does not match
1702  * anywhere in the string, then the whole string is returned as the first
1703  * token.
1704  *
1705  * As a special case, the result of splitting the empty string "" is an
1706  * empty vector, not a vector containing a single string. The reason for
1707  * this special case is that being able to represent a empty vector is
1708  * typically more useful than consistent handling of empty elements. If
1709  * you do need to represent empty elements, you'll need to check for the
1710  * empty string before calling this function.
1711  *
1712  * A pattern that can match empty strings splits @string into separate
1713  * characters wherever it matches the empty string between characters.
1714  * For example splitting "ab c" using as a separator "\s*", you will get
1715  * "a", "b" and "c".
1716  *
1717  * Returns: a %NULL-terminated gchar ** array. Free it using g_strfreev()
1718  *
1719  * Since: 2.14
1720  **/
1721 gchar **
1722 g_regex_split (const GRegex     *regex,
1723                const gchar      *string,
1724                GRegexMatchFlags  match_options)
1725 {
1726   return g_regex_split_full (regex, string, -1, 0,
1727                              match_options, 0, NULL);
1728 }
1729
1730 /**
1731  * g_regex_split_full:
1732  * @regex: a #GRegex structure
1733  * @string: the string to split with the pattern
1734  * @string_len: the length of @string, or -1 if @string is nul-terminated
1735  * @start_position: starting index of the string to match
1736  * @match_options: match time option flags
1737  * @max_tokens: the maximum number of tokens to split @string into.
1738  *   If this is less than 1, the string is split completely
1739  * @error: return location for a #GError
1740  *
1741  * Breaks the string on the pattern, and returns an array of the tokens.
1742  * If the pattern contains capturing parentheses, then the text for each
1743  * of the substrings will also be returned. If the pattern does not match
1744  * anywhere in the string, then the whole string is returned as the first
1745  * token.
1746  *
1747  * As a special case, the result of splitting the empty string "" is an
1748  * empty vector, not a vector containing a single string. The reason for
1749  * this special case is that being able to represent a empty vector is
1750  * typically more useful than consistent handling of empty elements. If
1751  * you do need to represent empty elements, you'll need to check for the
1752  * empty string before calling this function.
1753  *
1754  * A pattern that can match empty strings splits @string into separate
1755  * characters wherever it matches the empty string between characters.
1756  * For example splitting "ab c" using as a separator "\s*", you will get
1757  * "a", "b" and "c".
1758  *
1759  * Setting @start_position differs from just passing over a shortened
1760  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
1761  * that begins with any kind of lookbehind assertion, such as "\b".
1762  *
1763  * Returns: a %NULL-terminated gchar ** array. Free it using g_strfreev()
1764  *
1765  * Since: 2.14
1766  **/
1767 gchar **
1768 g_regex_split_full (const GRegex      *regex,
1769                     const gchar       *string,
1770                     gssize             string_len,
1771                     gint               start_position,
1772                     GRegexMatchFlags   match_options,
1773                     gint               max_tokens,
1774                     GError           **error)
1775 {
1776   GError *tmp_error = NULL;
1777   GMatchInfo *match_info;
1778   GList *list, *last;
1779   gint i;
1780   gint token_count;
1781   gboolean match_ok;
1782   /* position of the last separator. */
1783   gint last_separator_end;
1784   /* was the last match 0 bytes long? */
1785   gboolean last_match_is_empty;
1786   /* the returned array of char **s */
1787   gchar **string_list;
1788
1789   g_return_val_if_fail (regex != NULL, NULL);
1790   g_return_val_if_fail (string != NULL, NULL);
1791   g_return_val_if_fail (start_position >= 0, NULL);
1792   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
1793   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
1794
1795   if (max_tokens <= 0)
1796     max_tokens = G_MAXINT;
1797
1798   if (string_len < 0)
1799     string_len = strlen (string);
1800
1801   /* zero-length string */
1802   if (string_len - start_position == 0)
1803     return g_new0 (gchar *, 1);
1804
1805   if (max_tokens == 1)
1806     {
1807       string_list = g_new0 (gchar *, 2);
1808       string_list[0] = g_strndup (&string[start_position],
1809                                   string_len - start_position);
1810       return string_list;
1811     }
1812
1813   list = NULL;
1814   token_count = 0;
1815   last_separator_end = start_position;
1816   last_match_is_empty = FALSE;
1817
1818   match_ok = g_regex_match_full (regex, string, string_len, start_position,
1819                                  match_options, &match_info, &tmp_error);
1820   while (tmp_error == NULL)
1821     {
1822       if (match_ok)
1823         {
1824           last_match_is_empty =
1825                     (match_info->offsets[0] == match_info->offsets[1]);
1826
1827           /* we need to skip empty separators at the same position of the end
1828            * of another separator. e.g. the string is "a b" and the separator
1829            * is " *", so from 1 to 2 we have a match and at position 2 we have
1830            * an empty match. */
1831           if (last_separator_end != match_info->offsets[1])
1832             {
1833               gchar *token;
1834               gint match_count;
1835
1836               token = g_strndup (string + last_separator_end,
1837                                  match_info->offsets[0] - last_separator_end);
1838               list = g_list_prepend (list, token);
1839               token_count++;
1840
1841               /* if there were substrings, these need to be added to
1842                * the list. */
1843               match_count = g_match_info_get_match_count (match_info);
1844               if (match_count > 1)
1845                 {
1846                   for (i = 1; i < match_count; i++)
1847                     list = g_list_prepend (list, g_match_info_fetch (match_info, i));
1848                 }
1849             }
1850         }
1851       else
1852         {
1853           /* if there was no match, copy to end of string. */
1854           if (!last_match_is_empty)
1855             {
1856               gchar *token = g_strndup (string + last_separator_end,
1857                                         match_info->string_len - last_separator_end);
1858               list = g_list_prepend (list, token);
1859             }
1860           /* no more tokens, end the loop. */
1861           break;
1862         }
1863
1864       /* -1 to leave room for the last part. */
1865       if (token_count >= max_tokens - 1)
1866         {
1867           /* we have reached the maximum number of tokens, so we copy
1868            * the remaining part of the string. */
1869           if (last_match_is_empty)
1870             {
1871               /* the last match was empty, so we have moved one char
1872                * after the real position to avoid empty matches at the
1873                * same position. */
1874               match_info->pos = PREV_CHAR (regex, &string[match_info->pos]) - string;
1875             }
1876           /* the if is needed in the case we have terminated the available
1877            * tokens, but we are at the end of the string, so there are no
1878            * characters left to copy. */
1879           if (string_len > match_info->pos)
1880             {
1881               gchar *token = g_strndup (string + match_info->pos,
1882                                         string_len - match_info->pos);
1883               list = g_list_prepend (list, token);
1884             }
1885           /* end the loop. */
1886           break;
1887         }
1888
1889       last_separator_end = match_info->pos;
1890       if (last_match_is_empty)
1891         /* if the last match was empty, g_match_info_next() has moved
1892          * forward to avoid infinite loops, but we still need to copy that
1893          * character. */
1894         last_separator_end = PREV_CHAR (regex, &string[last_separator_end]) - string;
1895
1896       match_ok = g_match_info_next (match_info, &tmp_error);
1897     }
1898   g_match_info_free (match_info);
1899   if (tmp_error != NULL)
1900     {
1901       g_propagate_error (error, tmp_error);
1902       g_list_foreach (list, (GFunc)g_free, NULL);
1903       g_list_free (list);
1904       match_info->pos = -1;
1905       return NULL;
1906     }
1907
1908   string_list = g_new (gchar *, g_list_length (list) + 1);
1909   i = 0;
1910   for (last = g_list_last (list); last; last = g_list_previous (last))
1911     string_list[i++] = last->data;
1912   string_list[i] = NULL;
1913   g_list_free (list);
1914
1915   return string_list;
1916 }
1917
1918 enum
1919 {
1920   REPL_TYPE_STRING,
1921   REPL_TYPE_CHARACTER,
1922   REPL_TYPE_SYMBOLIC_REFERENCE,
1923   REPL_TYPE_NUMERIC_REFERENCE,
1924   REPL_TYPE_CHANGE_CASE
1925 };
1926
1927 typedef enum
1928 {
1929   CHANGE_CASE_NONE         = 1 << 0,
1930   CHANGE_CASE_UPPER        = 1 << 1,
1931   CHANGE_CASE_LOWER        = 1 << 2,
1932   CHANGE_CASE_UPPER_SINGLE = 1 << 3,
1933   CHANGE_CASE_LOWER_SINGLE = 1 << 4,
1934   CHANGE_CASE_SINGLE_MASK  = CHANGE_CASE_UPPER_SINGLE | CHANGE_CASE_LOWER_SINGLE,
1935   CHANGE_CASE_LOWER_MASK   = CHANGE_CASE_LOWER | CHANGE_CASE_LOWER_SINGLE,
1936   CHANGE_CASE_UPPER_MASK   = CHANGE_CASE_UPPER | CHANGE_CASE_UPPER_SINGLE
1937 } ChangeCase;
1938
1939 struct _InterpolationData
1940 {
1941   gchar     *text;
1942   gint       type;
1943   gint       num;
1944   gchar      c;
1945   ChangeCase change_case;
1946 };
1947
1948 static void
1949 free_interpolation_data (InterpolationData *data)
1950 {
1951   g_free (data->text);
1952   g_free (data);
1953 }
1954
1955 static const gchar *
1956 expand_escape (const gchar        *replacement,
1957                const gchar        *p,
1958                InterpolationData  *data,
1959                GError            **error)
1960 {
1961   const gchar *q, *r;
1962   gint x, d, h, i;
1963   const gchar *error_detail;
1964   gint base = 0;
1965   GError *tmp_error = NULL;
1966
1967   p++;
1968   switch (*p)
1969     {
1970     case 't':
1971       p++;
1972       data->c = '\t';
1973       data->type = REPL_TYPE_CHARACTER;
1974       break;
1975     case 'n':
1976       p++;
1977       data->c = '\n';
1978       data->type = REPL_TYPE_CHARACTER;
1979       break;
1980     case 'v':
1981       p++;
1982       data->c = '\v';
1983       data->type = REPL_TYPE_CHARACTER;
1984       break;
1985     case 'r':
1986       p++;
1987       data->c = '\r';
1988       data->type = REPL_TYPE_CHARACTER;
1989       break;
1990     case 'f':
1991       p++;
1992       data->c = '\f';
1993       data->type = REPL_TYPE_CHARACTER;
1994       break;
1995     case 'a':
1996       p++;
1997       data->c = '\a';
1998       data->type = REPL_TYPE_CHARACTER;
1999       break;
2000     case 'b':
2001       p++;
2002       data->c = '\b';
2003       data->type = REPL_TYPE_CHARACTER;
2004       break;
2005     case '\\':
2006       p++;
2007       data->c = '\\';
2008       data->type = REPL_TYPE_CHARACTER;
2009       break;
2010     case 'x':
2011       p++;
2012       x = 0;
2013       if (*p == '{')
2014         {
2015           p++;
2016           do
2017             {
2018               h = g_ascii_xdigit_value (*p);
2019               if (h < 0)
2020                 {
2021                   error_detail = _("hexadecimal digit or '}' expected");
2022                   goto error;
2023                 }
2024               x = x * 16 + h;
2025               p++;
2026             }
2027           while (*p != '}');
2028           p++;
2029         }
2030       else
2031         {
2032           for (i = 0; i < 2; i++)
2033             {
2034               h = g_ascii_xdigit_value (*p);
2035               if (h < 0)
2036                 {
2037                   error_detail = _("hexadecimal digit expected");
2038                   goto error;
2039                 }
2040               x = x * 16 + h;
2041               p++;
2042             }
2043         }
2044       data->type = REPL_TYPE_STRING;
2045       data->text = g_new0 (gchar, 8);
2046       g_unichar_to_utf8 (x, data->text);
2047       break;
2048     case 'l':
2049       p++;
2050       data->type = REPL_TYPE_CHANGE_CASE;
2051       data->change_case = CHANGE_CASE_LOWER_SINGLE;
2052       break;
2053     case 'u':
2054       p++;
2055       data->type = REPL_TYPE_CHANGE_CASE;
2056       data->change_case = CHANGE_CASE_UPPER_SINGLE;
2057       break;
2058     case 'L':
2059       p++;
2060       data->type = REPL_TYPE_CHANGE_CASE;
2061       data->change_case = CHANGE_CASE_LOWER;
2062       break;
2063     case 'U':
2064       p++;
2065       data->type = REPL_TYPE_CHANGE_CASE;
2066       data->change_case = CHANGE_CASE_UPPER;
2067       break;
2068     case 'E':
2069       p++;
2070       data->type = REPL_TYPE_CHANGE_CASE;
2071       data->change_case = CHANGE_CASE_NONE;
2072       break;
2073     case 'g':
2074       p++;
2075       if (*p != '<')
2076         {
2077           error_detail = _("missing '<' in symbolic reference");
2078           goto error;
2079         }
2080       q = p + 1;
2081       do
2082         {
2083           p++;
2084           if (!*p)
2085             {
2086               error_detail = _("unfinished symbolic reference");
2087               goto error;
2088             }
2089         }
2090       while (*p != '>');
2091       if (p - q == 0)
2092         {
2093           error_detail = _("zero-length symbolic reference");
2094           goto error;
2095         }
2096       if (g_ascii_isdigit (*q))
2097         {
2098           x = 0;
2099           do
2100             {
2101               h = g_ascii_digit_value (*q);
2102               if (h < 0)
2103                 {
2104                   error_detail = _("digit expected");
2105                   p = q;
2106                   goto error;
2107                 }
2108               x = x * 10 + h;
2109               q++;
2110             }
2111           while (q != p);
2112           data->num = x;
2113           data->type = REPL_TYPE_NUMERIC_REFERENCE;
2114         }
2115       else
2116         {
2117           r = q;
2118           do
2119             {
2120               if (!g_ascii_isalnum (*r))
2121                 {
2122                   error_detail = _("illegal symbolic reference");
2123                   p = r;
2124                   goto error;
2125                 }
2126               r++;
2127             }
2128           while (r != p);
2129           data->text = g_strndup (q, p - q);
2130           data->type = REPL_TYPE_SYMBOLIC_REFERENCE;
2131         }
2132       p++;
2133       break;
2134     case '0':
2135       /* if \0 is followed by a number is an octal number representing a
2136        * character, else it is a numeric reference. */
2137       if (g_ascii_digit_value (*g_utf8_next_char (p)) >= 0)
2138         {
2139           base = 8;
2140           p = g_utf8_next_char (p);
2141         }
2142     case '1':
2143     case '2':
2144     case '3':
2145     case '4':
2146     case '5':
2147     case '6':
2148     case '7':
2149     case '8':
2150     case '9':
2151       x = 0;
2152       d = 0;
2153       for (i = 0; i < 3; i++)
2154         {
2155           h = g_ascii_digit_value (*p);
2156           if (h < 0)
2157             break;
2158           if (h > 7)
2159             {
2160               if (base == 8)
2161                 break;
2162               else
2163                 base = 10;
2164             }
2165           if (i == 2 && base == 10)
2166             break;
2167           x = x * 8 + h;
2168           d = d * 10 + h;
2169           p++;
2170         }
2171       if (base == 8 || i == 3)
2172         {
2173           data->type = REPL_TYPE_STRING;
2174           data->text = g_new0 (gchar, 8);
2175           g_unichar_to_utf8 (x, data->text);
2176         }
2177       else
2178         {
2179           data->type = REPL_TYPE_NUMERIC_REFERENCE;
2180           data->num = d;
2181         }
2182       break;
2183     case 0:
2184       error_detail = _("stray final '\\'");
2185       goto error;
2186       break;
2187     default:
2188       error_detail = _("unknown escape sequence");
2189       goto error;
2190     }
2191
2192   return p;
2193
2194  error:
2195   /* G_GSSIZE_FORMAT doesn't work with gettext, so we use %lu */
2196   tmp_error = g_error_new (G_REGEX_ERROR,
2197                            G_REGEX_ERROR_REPLACE,
2198                            _("Error while parsing replacement "
2199                              "text \"%s\" at char %lu: %s"),
2200                            replacement,
2201                            (gulong)(p - replacement),
2202                            error_detail);
2203   g_propagate_error (error, tmp_error);
2204
2205   return NULL;
2206 }
2207
2208 static GList *
2209 split_replacement (const gchar  *replacement,
2210                    GError      **error)
2211 {
2212   GList *list = NULL;
2213   InterpolationData *data;
2214   const gchar *p, *start;
2215
2216   start = p = replacement;
2217   while (*p)
2218     {
2219       if (*p == '\\')
2220         {
2221           data = g_new0 (InterpolationData, 1);
2222           start = p = expand_escape (replacement, p, data, error);
2223           if (p == NULL)
2224             {
2225               g_list_foreach (list, (GFunc)free_interpolation_data, NULL);
2226               g_list_free (list);
2227               free_interpolation_data (data);
2228
2229               return NULL;
2230             }
2231           list = g_list_prepend (list, data);
2232         }
2233       else
2234         {
2235           p++;
2236           if (*p == '\\' || *p == '\0')
2237             {
2238               if (p - start > 0)
2239                 {
2240                   data = g_new0 (InterpolationData, 1);
2241                   data->text = g_strndup (start, p - start);
2242                   data->type = REPL_TYPE_STRING;
2243                   list = g_list_prepend (list, data);
2244                 }
2245             }
2246         }
2247     }
2248
2249   return g_list_reverse (list);
2250 }
2251
2252 /* Change the case of c based on change_case. */
2253 #define CHANGE_CASE(c, change_case) \
2254         (((change_case) & CHANGE_CASE_LOWER_MASK) ? \
2255                 g_unichar_tolower (c) : \
2256                 g_unichar_toupper (c))
2257
2258 static void
2259 string_append (GString     *string,
2260                const gchar *text,
2261                ChangeCase  *change_case)
2262 {
2263   gunichar c;
2264
2265   if (text[0] == '\0')
2266     return;
2267
2268   if (*change_case == CHANGE_CASE_NONE)
2269     {
2270       g_string_append (string, text);
2271     }
2272   else if (*change_case & CHANGE_CASE_SINGLE_MASK)
2273     {
2274       c = g_utf8_get_char (text);
2275       g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2276       g_string_append (string, g_utf8_next_char (text));
2277       *change_case = CHANGE_CASE_NONE;
2278     }
2279   else
2280     {
2281       while (*text != '\0')
2282         {
2283           c = g_utf8_get_char (text);
2284           g_string_append_unichar (string, CHANGE_CASE (c, *change_case));
2285           text = g_utf8_next_char (text);
2286         }
2287     }
2288 }
2289
2290 static gboolean
2291 interpolate_replacement (const GMatchInfo *match_info,
2292                          GString          *result,
2293                          gpointer          data)
2294 {
2295   GList *list;
2296   InterpolationData *idata;
2297   gchar *match;
2298   ChangeCase change_case = CHANGE_CASE_NONE;
2299
2300   for (list = data; list; list = list->next)
2301     {
2302       idata = list->data;
2303       switch (idata->type)
2304         {
2305         case REPL_TYPE_STRING:
2306           string_append (result, idata->text, &change_case);
2307           break;
2308         case REPL_TYPE_CHARACTER:
2309           g_string_append_c (result, CHANGE_CASE (idata->c, change_case));
2310           if (change_case & CHANGE_CASE_SINGLE_MASK)
2311             change_case = CHANGE_CASE_NONE;
2312           break;
2313         case REPL_TYPE_NUMERIC_REFERENCE:
2314           match = g_match_info_fetch (match_info, idata->num);
2315           if (match)
2316             {
2317               string_append (result, match, &change_case);
2318               g_free (match);
2319             }
2320           break;
2321         case REPL_TYPE_SYMBOLIC_REFERENCE:
2322           match = g_match_info_fetch_named (match_info, idata->text);
2323           if (match)
2324             {
2325               string_append (result, match, &change_case);
2326               g_free (match);
2327             }
2328           break;
2329         case REPL_TYPE_CHANGE_CASE:
2330           change_case = idata->change_case;
2331           break;
2332         }
2333     }
2334
2335   return FALSE;
2336 }
2337
2338 /* whether actual match_info is needed for replacement, i.e.
2339  * whether there are references
2340  */
2341 static gboolean
2342 interpolation_list_needs_match (GList *list)
2343 {
2344   while (list != NULL)
2345     {
2346       InterpolationData *data = list->data;
2347
2348       if (data->type == REPL_TYPE_SYMBOLIC_REFERENCE ||
2349           data->type == REPL_TYPE_NUMERIC_REFERENCE)
2350         {
2351           return TRUE;
2352         }
2353
2354       list = list->next;
2355     }
2356
2357   return FALSE;
2358 }
2359
2360 /**
2361  * g_regex_replace:
2362  * @regex: a #GRegex structure
2363  * @string: the string to perform matches against
2364  * @string_len: the length of @string, or -1 if @string is nul-terminated
2365  * @start_position: starting index of the string to match
2366  * @replacement: text to replace each match with
2367  * @match_options: options for the match
2368  * @error: location to store the error occuring, or %NULL to ignore errors
2369  *
2370  * Replaces all occurances of the pattern in @regex with the
2371  * replacement text. Backreferences of the form '\number' or
2372  * '\g&lt;number&gt;' in the replacement text are interpolated by the
2373  * number-th captured subexpression of the match, '\g&lt;name&gt;' refers
2374  * to the captured subexpression with the given name. '\0' refers to the
2375  * complete match, but '\0' followed by a number is the octal representation
2376  * of a character. To include a literal '\' in the replacement, write '\\'.
2377  * There are also escapes that changes the case of the following text:
2378  *
2379  * <variablelist>
2380  * <varlistentry><term>\l</term>
2381  * <listitem>
2382  * <para>Convert to lower case the next character</para>
2383  * </listitem>
2384  * </varlistentry>
2385  * <varlistentry><term>\u</term>
2386  * <listitem>
2387  * <para>Convert to upper case the next character</para>
2388  * </listitem>
2389  * </varlistentry>
2390  * <varlistentry><term>\L</term>
2391  * <listitem>
2392  * <para>Convert to lower case till \E</para>
2393  * </listitem>
2394  * </varlistentry>
2395  * <varlistentry><term>\U</term>
2396  * <listitem>
2397  * <para>Convert to upper case till \E</para>
2398  * </listitem>
2399  * </varlistentry>
2400  * <varlistentry><term>\E</term>
2401  * <listitem>
2402  * <para>End case modification</para>
2403  * </listitem>
2404  * </varlistentry>
2405  * </variablelist>
2406  *
2407  * If you do not need to use backreferences use g_regex_replace_literal().
2408  *
2409  * The @replacement string must be UTF-8 encoded even if #G_REGEX_RAW was
2410  * passed to g_regex_new(). If you want to use not UTF-8 encoded stings
2411  * you can use g_regex_replace_literal().
2412  *
2413  * Setting @start_position differs from just passing over a shortened
2414  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern that
2415  * begins with any kind of lookbehind assertion, such as "\b".
2416  *
2417  * Returns: a newly allocated string containing the replacements
2418  *
2419  * Since: 2.14
2420  */
2421 gchar *
2422 g_regex_replace (const GRegex      *regex,
2423                  const gchar       *string,
2424                  gssize             string_len,
2425                  gint               start_position,
2426                  const gchar       *replacement,
2427                  GRegexMatchFlags   match_options,
2428                  GError           **error)
2429 {
2430   gchar *result;
2431   GList *list;
2432   GError *tmp_error = NULL;
2433
2434   g_return_val_if_fail (regex != NULL, NULL);
2435   g_return_val_if_fail (string != NULL, NULL);
2436   g_return_val_if_fail (start_position >= 0, NULL);
2437   g_return_val_if_fail (replacement != NULL, NULL);
2438   g_return_val_if_fail (error == NULL || *error == NULL, NULL);
2439   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2440
2441   list = split_replacement (replacement, &tmp_error);
2442   if (tmp_error != NULL)
2443     {
2444       g_propagate_error (error, tmp_error);
2445       return NULL;
2446     }
2447
2448   result = g_regex_replace_eval (regex,
2449                                  string, string_len, start_position,
2450                                  match_options,
2451                                  interpolate_replacement,
2452                                  (gpointer)list,
2453                                  &tmp_error);
2454   if (tmp_error != NULL)
2455     g_propagate_error (error, tmp_error);
2456
2457   g_list_foreach (list, (GFunc)free_interpolation_data, NULL);
2458   g_list_free (list);
2459
2460   return result;
2461 }
2462
2463 static gboolean
2464 literal_replacement (const GMatchInfo *match_info,
2465                      GString          *result,
2466                      gpointer          data)
2467 {
2468   g_string_append (result, data);
2469   return FALSE;
2470 }
2471
2472 /**
2473  * g_regex_replace_literal:
2474  * @regex: a #GRegex structure
2475  * @string: the string to perform matches against
2476  * @string_len: the length of @string, or -1 if @string is nul-terminated
2477  * @start_position: starting index of the string to match
2478  * @replacement: text to replace each match with
2479  * @match_options: options for the match
2480  * @error: location to store the error occuring, or %NULL to ignore errors
2481  *
2482  * Replaces all occurances of the pattern in @regex with the
2483  * replacement text. @replacement is replaced literally, to
2484  * include backreferences use g_regex_replace().
2485  *
2486  * Setting @start_position differs from just passing over a
2487  * shortened string and setting #G_REGEX_MATCH_NOTBOL in the
2488  * case of a pattern that begins with any kind of lookbehind
2489  * assertion, such as "\b".
2490  *
2491  * Returns: a newly allocated string containing the replacements
2492  *
2493  * Since: 2.14
2494  */
2495 gchar *
2496 g_regex_replace_literal (const GRegex      *regex,
2497                          const gchar       *string,
2498                          gssize             string_len,
2499                          gint               start_position,
2500                          const gchar       *replacement,
2501                          GRegexMatchFlags   match_options,
2502                          GError           **error)
2503 {
2504   g_return_val_if_fail (replacement != NULL, NULL);
2505   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2506
2507   return g_regex_replace_eval (regex,
2508                                string, string_len, start_position,
2509                                match_options,
2510                                literal_replacement,
2511                                (gpointer)replacement,
2512                                error);
2513 }
2514
2515 /**
2516  * g_regex_replace_eval:
2517  * @regex: a #GRegex structure from g_regex_new()
2518  * @string: string to perform matches against
2519  * @string_len: the length of @string, or -1 if @string is nul-terminated
2520  * @start_position: starting index of the string to match
2521  * @match_options: options for the match
2522  * @eval: a function to call for each match
2523  * @user_data: user data to pass to the function
2524  * @error: location to store the error occuring, or %NULL to ignore errors
2525  *
2526  * Replaces occurances of the pattern in regex with the output of
2527  * @eval for that occurance.
2528  *
2529  * Setting @start_position differs from just passing over a shortened
2530  * string and setting #G_REGEX_MATCH_NOTBOL in the case of a pattern
2531  * that begins with any kind of lookbehind assertion, such as "\b".
2532  *
2533  * The following example uses g_regex_replace_eval() to replace multiple
2534  * strings at once:
2535  * |[
2536  * static gboolean
2537  * eval_cb (const GMatchInfo *info,
2538  *          GString          *res,
2539  *          gpointer          data)
2540  * {
2541  *   gchar *match;
2542  *   gchar *r;
2543  *
2544  *    match = g_match_info_fetch (info, 0);
2545  *    r = g_hash_table_lookup ((GHashTable *)data, match);
2546  *    g_string_append (res, r);
2547  *    g_free (match);
2548  *
2549  *    return FALSE;
2550  * }
2551  *
2552  * /&ast; ... &ast;/
2553  *
2554  * GRegex *reg;
2555  * GHashTable *h;
2556  * gchar *res;
2557  *
2558  * h = g_hash_table_new (g_str_hash, g_str_equal);
2559  *
2560  * g_hash_table_insert (h, "1", "ONE");
2561  * g_hash_table_insert (h, "2", "TWO");
2562  * g_hash_table_insert (h, "3", "THREE");
2563  * g_hash_table_insert (h, "4", "FOUR");
2564  *
2565  * reg = g_regex_new ("1|2|3|4", 0, 0, NULL);
2566  * res = g_regex_replace_eval (reg, text, -1, 0, 0, eval_cb, h, NULL);
2567  * g_hash_table_destroy (h);
2568  *
2569  * /&ast; ... &ast;/
2570  * ]|
2571  *
2572  * Returns: a newly allocated string containing the replacements
2573  *
2574  * Since: 2.14
2575  */
2576 gchar *
2577 g_regex_replace_eval (const GRegex        *regex,
2578                       const gchar         *string,
2579                       gssize               string_len,
2580                       gint                 start_position,
2581                       GRegexMatchFlags     match_options,
2582                       GRegexEvalCallback   eval,
2583                       gpointer             user_data,
2584                       GError             **error)
2585 {
2586   GMatchInfo *match_info;
2587   GString *result;
2588   gint str_pos = 0;
2589   gboolean done = FALSE;
2590   GError *tmp_error = NULL;
2591
2592   g_return_val_if_fail (regex != NULL, NULL);
2593   g_return_val_if_fail (string != NULL, NULL);
2594   g_return_val_if_fail (start_position >= 0, NULL);
2595   g_return_val_if_fail (eval != NULL, NULL);
2596   g_return_val_if_fail ((match_options & ~G_REGEX_MATCH_MASK) == 0, NULL);
2597
2598   if (string_len < 0)
2599     string_len = strlen (string);
2600
2601   result = g_string_sized_new (string_len);
2602
2603   /* run down the string making matches. */
2604   g_regex_match_full (regex, string, string_len, start_position,
2605                       match_options, &match_info, &tmp_error);
2606   while (!done && g_match_info_matches (match_info))
2607     {
2608       g_string_append_len (result,
2609                            string + str_pos,
2610                            match_info->offsets[0] - str_pos);
2611       done = (*eval) (match_info, result, user_data);
2612       str_pos = match_info->offsets[1];
2613       g_match_info_next (match_info, &tmp_error);
2614     }
2615   g_match_info_free (match_info);
2616   if (tmp_error != NULL)
2617     {
2618       g_propagate_error (error, tmp_error);
2619       g_string_free (result, TRUE);
2620       return NULL;
2621     }
2622
2623   g_string_append_len (result, string + str_pos, string_len - str_pos);
2624   return g_string_free (result, FALSE);
2625 }
2626
2627 /**
2628  * g_regex_check_replacement:
2629  * @replacement: the replacement string
2630  * @has_references: location to store information about
2631  *   references in @replacement or %NULL
2632  * @error: location to store error
2633  *
2634  * Checks whether @replacement is a valid replacement string
2635  * (see g_regex_replace()), i.e. that all escape sequences in
2636  * it are valid.
2637  *
2638  * If @has_references is not %NULL then @replacement is checked
2639  * for pattern references. For instance, replacement text 'foo\n'
2640  * does not contain references and may be evaluated without information
2641  * about actual match, but '\0\1' (whole match followed by first
2642  * subpattern) requires valid #GMatchInfo object.
2643  *
2644  * Returns: whether @replacement is a valid replacement string
2645  *
2646  * Since: 2.14
2647  */
2648 gboolean
2649 g_regex_check_replacement (const gchar  *replacement,
2650                            gboolean     *has_references,
2651                            GError      **error)
2652 {
2653   GList *list;
2654   GError *tmp = NULL;
2655
2656   list = split_replacement (replacement, &tmp);
2657
2658   if (tmp)
2659   {
2660     g_propagate_error (error, tmp);
2661     return FALSE;
2662   }
2663
2664   if (has_references)
2665     *has_references = interpolation_list_needs_match (list);
2666
2667   g_list_foreach (list, (GFunc) free_interpolation_data, NULL);
2668   g_list_free (list);
2669
2670   return TRUE;
2671 }
2672
2673 /**
2674  * g_regex_escape_string:
2675  * @string: the string to escape
2676  * @length: the length of @string, or -1 if @string is nul-terminated
2677  *
2678  * Escapes the special characters used for regular expressions
2679  * in @string, for instance "a.b*c" becomes "a\.b\*c". This
2680  * function is useful to dynamically generate regular expressions.
2681  *
2682  * @string can contain nul characters that are replaced with "\0",
2683  * in this case remember to specify the correct length of @string
2684  * in @length.
2685  *
2686  * Returns: a newly-allocated escaped string
2687  *
2688  * Since: 2.14
2689  */
2690 gchar *
2691 g_regex_escape_string (const gchar *string,
2692                        gint         length)
2693 {
2694   GString *escaped;
2695   const char *p, *piece_start, *end;
2696
2697   g_return_val_if_fail (string != NULL, NULL);
2698
2699   if (length < 0)
2700     length = strlen (string);
2701
2702   end = string + length;
2703   p = piece_start = string;
2704   escaped = g_string_sized_new (length + 1);
2705
2706   while (p < end)
2707     {
2708       switch (*p)
2709         {
2710         case '\0':
2711         case '\\':
2712         case '|':
2713         case '(':
2714         case ')':
2715         case '[':
2716         case ']':
2717         case '{':
2718         case '}':
2719         case '^':
2720         case '$':
2721         case '*':
2722         case '+':
2723         case '?':
2724         case '.':
2725           if (p != piece_start)
2726             /* copy the previous piece. */
2727             g_string_append_len (escaped, piece_start, p - piece_start);
2728           g_string_append_c (escaped, '\\');
2729           if (*p == '\0')
2730             g_string_append_c (escaped, '0');
2731           else
2732             g_string_append_c (escaped, *p);
2733           piece_start = ++p;
2734           break;
2735         default:
2736           p = g_utf8_next_char (p);
2737           break;
2738         }
2739   }
2740
2741   if (piece_start < end)
2742     g_string_append_len (escaped, piece_start, end - piece_start);
2743
2744   return g_string_free (escaped, FALSE);
2745 }
2746
2747 #define __G_REGEX_C__
2748 #include "galiasdef.c"