glib/gmarkup.c

   1 /* gmarkup.c - Simple XML-like parser
   2  *
   3  *  Copyright 2000, 2003 Red Hat, Inc.
   4  *  Copyright 2007, 2008 Ryan Lortie <desrt@desrt.ca>
   5  *
   6  * GLib is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU Lesser General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * GLib is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with GLib; see the file COPYING.LIB.  If not,
  18  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  *   Boston, MA 02111-1307, USA.
  20  */
  21
  22 #include "config.h"
  23
  24 #include <stdarg.h>
  25 #include <string.h>
  26 #include <stdio.h>
  27 #include <stdlib.h>
  28 #include <errno.h>
  29
  30 #include "gmarkup.h"
  31
  32 #include "gslice.h"
  33 #include "galloca.h"
  34 #include "gstrfuncs.h"
  35 #include "gstring.h"
  36 #include "gtestutils.h"
  37 #include "glibintl.h"
  38
  39 /**
  40  * SECTION:markup
  41  * @Title: Simple XML Subset Parser
  42  * @Short_description: parses a subset of XML
  43  * @See_also: <ulink url="http://www.w3.org/TR/REC-xml/">XML
  44  *     Specification</ulink>
  45  *
  46  * The "GMarkup" parser is intended to parse a simple markup format
  47  * that's a subset of XML. This is a small, efficient, easy-to-use
  48  * parser. It should not be used if you expect to interoperate with
  49  * other applications generating full-scale XML. However, it's very
  50  * useful for application data files, config files, etc. where you
  51  * know your application will be the only one writing the file.
  52  * Full-scale XML parsers should be able to parse the subset used by
  53  * GMarkup, so you can easily migrate to full-scale XML at a later
  54  * time if the need arises.
  55  *
  56  * GMarkup is not guaranteed to signal an error on all invalid XML;
  57  * the parser may accept documents that an XML parser would not.
  58  * However, XML documents which are not well-formed<footnote
  59  * id="wellformed">Being wellformed is a weaker condition than being
  60  * valid. See the <ulink url="http://www.w3.org/TR/REC-xml/">XML
  61  * specification</ulink> for definitions of these terms.</footnote>
  62  * are not considered valid GMarkup documents.
  63  *
  64  * Simplifications to XML include:
  65  * <itemizedlist>
  66  * <listitem>Only UTF-8 encoding is allowed</listitem>
  67  * <listitem>No user-defined entities</listitem>
  68  * <listitem>Processing instructions, comments and the doctype declaration
  69  * are "passed through" but are not interpreted in any way</listitem>
  70  * <listitem>No DTD or validation.</listitem>
  71  * </itemizedlist>
  72  *
  73  * The markup format does support:
  74  * <itemizedlist>
  75  * <listitem>Elements</listitem>
  76  * <listitem>Attributes</listitem>
  77  * <listitem>5 standard entities:
  78  *   <literal>&amp;amp; &amp;lt; &amp;gt; &amp;quot; &amp;apos;</literal>
  79  * </listitem>
  80  * <listitem>Character references</listitem>
  81  * <listitem>Sections marked as CDATA</listitem>
  82  * </itemizedlist>
  83  */
  84
  85 GQuark
  86 g_markup_error_quark (void)
  87 {
  88   return g_quark_from_static_string ("g-markup-error-quark");
  89 }
  90
  91 typedef enum
  92 {
  93   STATE_START,
  94   STATE_AFTER_OPEN_ANGLE,
  95   STATE_AFTER_CLOSE_ANGLE,
  96   STATE_AFTER_ELISION_SLASH, /* the slash that obviates need for end element */
  97   STATE_INSIDE_OPEN_TAG_NAME,
  98   STATE_INSIDE_ATTRIBUTE_NAME,
  99   STATE_AFTER_ATTRIBUTE_NAME,
 100   STATE_BETWEEN_ATTRIBUTES,
 101   STATE_AFTER_ATTRIBUTE_EQUALS_SIGN,
 102   STATE_INSIDE_ATTRIBUTE_VALUE_SQ,
 103   STATE_INSIDE_ATTRIBUTE_VALUE_DQ,
 104   STATE_INSIDE_TEXT,
 105   STATE_AFTER_CLOSE_TAG_SLASH,
 106   STATE_INSIDE_CLOSE_TAG_NAME,
 107   STATE_AFTER_CLOSE_TAG_NAME,
 108   STATE_INSIDE_PASSTHROUGH,
 109   STATE_ERROR
 110 } GMarkupParseState;
 111
 112 typedef struct
 113 {
 114   const char *prev_element;
 115   const GMarkupParser *prev_parser;
 116   gpointer prev_user_data;
 117 } GMarkupRecursionTracker;
 118
 119 struct _GMarkupParseContext
 120 {
 121   const GMarkupParser *parser;
 122
 123   GMarkupParseFlags flags;
 124
 125   gint line_number;
 126   gint char_number;
 127
 128   GMarkupParseState state;
 129
 130   gpointer user_data;
 131   GDestroyNotify dnotify;
 132
 133   /* A piece of character data or an element that
 134    * hasn't "ended" yet so we haven't yet called
 135    * the callback for it.
 136    */
 137   GString *partial_chunk;
 138   GSList *spare_chunks;
 139
 140   GSList *tag_stack;
 141   GSList *tag_stack_gstr;
 142   GSList *spare_list_nodes;
 143
 144   GString **attr_names;
 145   GString **attr_values;
 146   gint cur_attr;
 147   gint alloc_attrs;
 148
 149   const gchar *current_text;
 150   gssize       current_text_len;
 151   const gchar *current_text_end;
 152
 153   /* used to save the start of the last interesting thingy */
 154   const gchar *start;
 155
 156   const gchar *iter;
 157
 158   guint document_empty : 1;
 159   guint parsing : 1;
 160   guint awaiting_pop : 1;
 161   gint balance;
 162
 163   /* subparser support */
 164   GSList *subparser_stack; /* (GMarkupRecursionTracker *) */
 165   const char *subparser_element;
 166   gpointer held_user_data;
 167 };
 168
 169 /*
 170  * Helpers to reduce our allocation overhead, we have
 171  * a well defined allocation lifecycle.
 172  */
 173 static GSList *
 174 get_list_node (GMarkupParseContext *context, gpointer data)
 175 {
 176   GSList *node;
 177   if (context->spare_list_nodes != NULL)
 178     {
 179       node = context->spare_list_nodes;
 180       context->spare_list_nodes = g_slist_remove_link (context->spare_list_nodes, node);
 181     }
 182   else
 183     node = g_slist_alloc();
 184   node->data = data;
 185   return node;
 186 }
 187
 188 static void
 189 free_list_node (GMarkupParseContext *context, GSList *node)
 190 {
 191   node->data = NULL;
 192   context->spare_list_nodes = g_slist_concat (node, context->spare_list_nodes);
 193 }
 194
 195 static inline void
 196 string_blank (GString *string)
 197 {
 198   string->str[0] = '\0';
 199   string->len = 0;
 200 }
 201
 202 /**
 203  * g_markup_parse_context_new:
 204  * @parser: a #GMarkupParser
 205  * @flags: one or more #GMarkupParseFlags
 206  * @user_data: user data to pass to #GMarkupParser functions
 207  * @user_data_dnotify: user data destroy notifier called when
 208  *     the parse context is freed
 209  *
 210  * Creates a new parse context. A parse context is used to parse
 211  * marked-up documents. You can feed any number of documents into
 212  * a context, as long as no errors occur; once an error occurs,
 213  * the parse context can't continue to parse text (you have to
 214  * free it and create a new parse context).
 215  *
 216  * Return value: a new #GMarkupParseContext
 217  **/
 218 GMarkupParseContext *
 219 g_markup_parse_context_new (const GMarkupParser *parser,
 220                             GMarkupParseFlags    flags,
 221                             gpointer             user_data,
 222                             GDestroyNotify       user_data_dnotify)
 223 {
 224   GMarkupParseContext *context;
 225
 226   g_return_val_if_fail (parser != NULL, NULL);
 227
 228   context = g_new (GMarkupParseContext, 1);
 229
 230   context->parser = parser;
 231   context->flags = flags;
 232   context->user_data = user_data;
 233   context->dnotify = user_data_dnotify;
 234
 235   context->line_number = 1;
 236   context->char_number = 1;
 237
 238   context->partial_chunk = NULL;
 239   context->spare_chunks = NULL;
 240   context->spare_list_nodes = NULL;
 241
 242   context->state = STATE_START;
 243   context->tag_stack = NULL;
 244   context->tag_stack_gstr = NULL;
 245   context->attr_names = NULL;
 246   context->attr_values = NULL;
 247   context->cur_attr = -1;
 248   context->alloc_attrs = 0;
 249
 250   context->current_text = NULL;
 251   context->current_text_len = -1;
 252   context->current_text_end = NULL;
 253
 254   context->start = NULL;
 255   context->iter = NULL;
 256
 257   context->document_empty = TRUE;
 258   context->parsing = FALSE;
 259
 260   context->awaiting_pop = FALSE;
 261   context->subparser_stack = NULL;
 262   context->subparser_element = NULL;
 263
 264   /* this is only looked at if awaiting_pop = TRUE.  initialise anyway. */
 265   context->held_user_data = NULL;
 266
 267   context->balance = 0;
 268
 269   return context;
 270 }
 271
 272 static void
 273 string_full_free (gpointer ptr)
 274 {
 275   g_string_free (ptr, TRUE);
 276 }
 277
 278 static void clear_attributes (GMarkupParseContext *context);
 279
 280 /**
 281  * g_markup_parse_context_free:
 282  * @context: a #GMarkupParseContext
 283  *
 284  * Frees a #GMarkupParseContext.
 285  *
 286  * This function can't be called from inside one of the
 287  * #GMarkupParser functions or while a subparser is pushed.
 288  */
 289 void
 290 g_markup_parse_context_free (GMarkupParseContext *context)
 291 {
 292   g_return_if_fail (context != NULL);
 293   g_return_if_fail (!context->parsing);
 294   g_return_if_fail (!context->subparser_stack);
 295   g_return_if_fail (!context->awaiting_pop);
 296
 297   if (context->dnotify)
 298     (* context->dnotify) (context->user_data);
 299
 300   clear_attributes (context);
 301   g_free (context->attr_names);
 302   g_free (context->attr_values);
 303
 304   g_slist_free_full (context->tag_stack_gstr, string_full_free);
 305   g_slist_free (context->tag_stack);
 306
 307   g_slist_free_full (context->spare_chunks, string_full_free);
 308   g_slist_free (context->spare_list_nodes);
 309
 310   if (context->partial_chunk)
 311     g_string_free (context->partial_chunk, TRUE);
 312
 313   g_free (context);
 314 }
 315
 316 static void pop_subparser_stack (GMarkupParseContext *context);
 317
 318 static void
 319 mark_error (GMarkupParseContext *context,
 320             GError              *error)
 321 {
 322   context->state = STATE_ERROR;
 323
 324   if (context->parser->error)
 325     (*context->parser->error) (context, error, context->user_data);
 326
 327   /* report the error all the way up to free all the user-data */
 328   while (context->subparser_stack)
 329     {
 330       pop_subparser_stack (context);
 331       context->awaiting_pop = FALSE; /* already been freed */
 332
 333       if (context->parser->error)
 334         (*context->parser->error) (context, error, context->user_data);
 335     }
 336 }
 337
 338 static void
 339 set_error (GMarkupParseContext  *context,
 340            GError              **error,
 341            GMarkupError          code,
 342            const gchar          *format,
 343            ...) G_GNUC_PRINTF (4, 5);
 344
 345 static void
 346 set_error_literal (GMarkupParseContext  *context,
 347                    GError              **error,
 348                    GMarkupError          code,
 349                    const gchar          *message)
 350 {
 351   GError *tmp_error;
 352
 353   tmp_error = g_error_new_literal (G_MARKUP_ERROR, code, message);
 354
 355   g_prefix_error (&tmp_error,
 356                   _("Error on line %d char %d: "),
 357                   context->line_number,
 358                   context->char_number);
 359
 360   mark_error (context, tmp_error);
 361
 362   g_propagate_error (error, tmp_error);
 363 }
 364
 365 static void
 366 set_error (GMarkupParseContext  *context,
 367            GError              **error,
 368            GMarkupError          code,
 369            const gchar          *format,
 370            ...)
 371 {
 372   gchar *s;
 373   gchar *s_valid;
 374   va_list args;
 375
 376   va_start (args, format);
 377   s = g_strdup_vprintf (format, args);
 378   va_end (args);
 379
 380   /* Make sure that the GError message is valid UTF-8
 381    * even if it is complaining about invalid UTF-8 in the markup
 382    */
 383   s_valid = _g_utf8_make_valid (s);
 384   set_error_literal (context, error, code, s);
 385
 386   g_free (s);
 387   g_free (s_valid);
 388 }
 389
 390 static void
 391 propagate_error (GMarkupParseContext  *context,
 392                  GError              **dest,
 393                  GError               *src)
 394 {
 395   if (context->flags & G_MARKUP_PREFIX_ERROR_POSITION)
 396     g_prefix_error (&src,
 397                     _("Error on line %d char %d: "),
 398                     context->line_number,
 399                     context->char_number);
 400
 401   mark_error (context, src);
 402
 403   g_propagate_error (dest, src);
 404 }
 405
 406 #define IS_COMMON_NAME_END_CHAR(c) \
 407   ((c) == '=' || (c) == '/' || (c) == '>' || (c) == ' ')
 408
 409 static gboolean
 410 slow_name_validate (GMarkupParseContext  *context,
 411                     const gchar          *name,
 412                     GError              **error)
 413 {
 414   const gchar *p = name;
 415
 416   if (!g_utf8_validate (name, strlen (name), NULL))
 417     {
 418       set_error (context, error, G_MARKUP_ERROR_BAD_UTF8,
 419                  _("Invalid UTF-8 encoded text in name - not valid '%s'"), name);
 420       return FALSE;
 421     }
 422
 423   if (!(g_ascii_isalpha (*p) ||
 424         (!IS_COMMON_NAME_END_CHAR (*p) &&
 425          (*p == '_' ||
 426           *p == ':' ||
 427           g_unichar_isalpha (g_utf8_get_char (p))))))
 428     {
 429       set_error (context, error, G_MARKUP_ERROR_PARSE,
 430                  _("'%s' is not a valid name "), name);
 431       return FALSE;
 432     }
 433
 434   for (p = g_utf8_next_char (name); *p != '\0'; p = g_utf8_next_char (p))
 435     {
 436       /* is_name_char */
 437       if (!(g_ascii_isalnum (*p) ||
 438             (!IS_COMMON_NAME_END_CHAR (*p) &&
 439              (*p == '.' ||
 440               *p == '-' ||
 441               *p == '_' ||
 442               *p == ':' ||
 443               g_unichar_isalpha (g_utf8_get_char (p))))))
 444         {
 445           set_error (context, error, G_MARKUP_ERROR_PARSE,
 446                      _("'%s' is not a valid name: '%c' "), name, *p);
 447           return FALSE;
 448         }
 449     }
 450   return TRUE;
 451 }
 452
 453 /*
 454  * Use me for elements, attributes etc.
 455  */
 456 static gboolean
 457 name_validate (GMarkupParseContext  *context,
 458                const gchar          *name,
 459                GError              **error)
 460 {
 461   char mask;
 462   const char *p;
 463
 464   /* name start char */
 465   p = name;
 466   if (G_UNLIKELY (IS_COMMON_NAME_END_CHAR (*p) ||
 467                   !(g_ascii_isalpha (*p) || *p == '_' || *p == ':')))
 468     goto slow_validate;
 469
 470   for (mask = *p++; *p != '\0'; p++)
 471     {
 472       mask |= *p;
 473
 474       /* is_name_char */
 475       if (G_UNLIKELY (!(g_ascii_isalnum (*p) ||
 476                         (!IS_COMMON_NAME_END_CHAR (*p) &&
 477                          (*p == '.' ||
 478                           *p == '-' ||
 479                           *p == '_' ||
 480                           *p == ':')))))
 481         goto slow_validate;
 482     }
 483
 484   if (mask & 0x80) /* un-common / non-ascii */
 485     goto slow_validate;
 486
 487   return TRUE;
 488
 489  slow_validate:
 490   return slow_name_validate (context, name, error);
 491 }
 492
 493 static gboolean
 494 text_validate (GMarkupParseContext  *context,
 495                const gchar          *p,
 496                gint                  len,
 497                GError              **error)
 498 {
 499   if (!g_utf8_validate (p, len, NULL))
 500     {
 501       set_error (context, error, G_MARKUP_ERROR_BAD_UTF8,
 502                  _("Invalid UTF-8 encoded text in name - not valid '%s'"), p);
 503       return FALSE;
 504     }
 505   else
 506     return TRUE;
 507 }
 508
 509 static gchar*
 510 char_str (gunichar c,
 511           gchar   *buf)
 512 {
 513   memset (buf, 0, 8);
 514   g_unichar_to_utf8 (c, buf);
 515   return buf;
 516 }
 517
 518 static gchar*
 519 utf8_str (const gchar *utf8,
 520           gchar       *buf)
 521 {
 522   char_str (g_utf8_get_char (utf8), buf);
 523   return buf;
 524 }
 525
 526 static void
 527 set_unescape_error (GMarkupParseContext  *context,
 528                     GError              **error,
 529                     const gchar          *remaining_text,
 530                     GMarkupError          code,
 531                     const gchar          *format,
 532                     ...)
 533 {
 534   GError *tmp_error;
 535   gchar *s;
 536   va_list args;
 537   gint remaining_newlines;
 538   const gchar *p;
 539
 540   remaining_newlines = 0;
 541   p = remaining_text;
 542   while (*p != '\0')
 543     {
 544       if (*p == '\n')
 545         ++remaining_newlines;
 546       ++p;
 547     }
 548
 549   va_start (args, format);
 550   s = g_strdup_vprintf (format, args);
 551   va_end (args);
 552
 553   tmp_error = g_error_new (G_MARKUP_ERROR,
 554                            code,
 555                            _("Error on line %d: %s"),
 556                            context->line_number - remaining_newlines,
 557                            s);
 558
 559   g_free (s);
 560
 561   mark_error (context, tmp_error);
 562
 563   g_propagate_error (error, tmp_error);
 564 }
 565
 566 /*
 567  * re-write the GString in-place, unescaping anything that escaped.
 568  * most XML does not contain entities, or escaping.
 569  */
 570 static gboolean
 571 unescape_gstring_inplace (GMarkupParseContext  *context,
 572                           GString              *string,
 573                           gboolean             *is_ascii,
 574                           GError              **error)
 575 {
 576   char mask, *to;
 577   int line_num = 1;
 578   const char *from;
 579   gboolean normalize_attribute;
 580
 581   *is_ascii = FALSE;
 582
 583   /* are we unescaping an attribute or not ? */
 584   if (context->state == STATE_INSIDE_ATTRIBUTE_VALUE_SQ ||
 585       context->state == STATE_INSIDE_ATTRIBUTE_VALUE_DQ)
 586     normalize_attribute = TRUE;
 587   else
 588     normalize_attribute = FALSE;
 589
 590   /*
 591    * Meeks' theorum: unescaping can only shrink text.
 592    * for &lt; etc. this is obvious, for &#xffff; more
 593    * thought is required, but this is patently so.
 594    */
 595   mask = 0;
 596   for (from = to = string->str; *from != '\0'; from++, to++)
 597     {
 598       *to = *from;
 599
 600       mask |= *to;
 601       if (*to == '\n')
 602         line_num++;
 603       if (normalize_attribute && (*to == '\t' || *to == '\n'))
 604         *to = ' ';
 605       if (*to == '\r')
 606         {
 607           *to = normalize_attribute ? ' ' : '\n';
 608           if (from[1] == '\n')
 609             from++;
 610         }
 611       if (*from == '&')
 612         {
 613           from++;
 614           if (*from == '#')
 615             {
 616               gboolean is_hex = FALSE;
 617               gulong l;
 618               gchar *end = NULL;
 619
 620               from++;
 621
 622               if (*from == 'x')
 623                 {
 624                   is_hex = TRUE;
 625                   from++;
 626                 }
 627
 628               /* digit is between start and p */
 629               errno = 0;
 630               if (is_hex)
 631                 l = strtoul (from, &end, 16);
 632               else
 633                 l = strtoul (from, &end, 10);
 634
 635               if (end == from || errno != 0)
 636                 {
 637                   set_unescape_error (context, error,
 638                                       from, G_MARKUP_ERROR_PARSE,
 639                                       _("Failed to parse '%-.*s', which "
 640                                         "should have been a digit "
 641                                         "inside a character reference "
 642                                         "(&#234; for example) - perhaps "
 643                                         "the digit is too large"),
 644                                       end - from, from);
 645                   return FALSE;
 646                 }
 647               else if (*end != ';')
 648                 {
 649                   set_unescape_error (context, error,
 650                                       from, G_MARKUP_ERROR_PARSE,
 651                                       _("Character reference did not end with a "
 652                                         "semicolon; "
 653                                         "most likely you used an ampersand "
 654                                         "character without intending to start "
 655                                         "an entity - escape ampersand as &amp;"));
 656                   return FALSE;
 657                 }
 658               else
 659                 {
 660                   /* characters XML 1.1 permits */
 661                   if ((0 < l && l <= 0xD7FF) ||
 662                       (0xE000 <= l && l <= 0xFFFD) ||
 663                       (0x10000 <= l && l <= 0x10FFFF))
 664                     {
 665                       gchar buf[8];
 666                       char_str (l, buf);
 667                       strcpy (to, buf);
 668                       to += strlen (buf) - 1;
 669                       from = end;
 670                       if (l >= 0x80) /* not ascii */
 671                         mask |= 0x80;
 672                     }
 673                   else
 674                     {
 675                       set_unescape_error (context, error,
 676                                           from, G_MARKUP_ERROR_PARSE,
 677                                           _("Character reference '%-.*s' does not "
 678                                             "encode a permitted character"),
 679                                           end - from, from);
 680                       return FALSE;
 681                     }
 682                 }
 683             }
 684
 685           else if (strncmp (from, "lt;", 3) == 0)
 686             {
 687               *to = '<';
 688               from += 2;
 689             }
 690           else if (strncmp (from, "gt;", 3) == 0)
 691             {
 692               *to = '>';
 693               from += 2;
 694             }
 695           else if (strncmp (from, "amp;", 4) == 0)
 696             {
 697               *to = '&';
 698               from += 3;
 699             }
 700           else if (strncmp (from, "quot;", 5) == 0)
 701             {
 702               *to = '"';
 703               from += 4;
 704             }
 705           else if (strncmp (from, "apos;", 5) == 0)
 706             {
 707               *to = '\'';
 708               from += 4;
 709             }
 710           else
 711             {
 712               if (*from == ';')
 713                 set_unescape_error (context, error,
 714                                     from, G_MARKUP_ERROR_PARSE,
 715                                     _("Empty entity '&;' seen; valid "
 716                                       "entities are: &amp; &quot; &lt; &gt; &apos;"));
 717               else
 718                 {
 719                   const char *end = strchr (from, ';');
 720                   if (end)
 721                     set_unescape_error (context, error,
 722                                         from, G_MARKUP_ERROR_PARSE,
 723                                         _("Entity name '%-.*s' is not known"),
 724                                         end-from, from);
 725                   else
 726                     set_unescape_error (context, error,
 727                                         from, G_MARKUP_ERROR_PARSE,
 728                                         _("Entity did not end with a semicolon; "
 729                                           "most likely you used an ampersand "
 730                                           "character without intending to start "
 731                                           "an entity - escape ampersand as &amp;"));
 732                 }
 733               return FALSE;
 734             }
 735         }
 736     }
 737
 738   g_assert (to - string->str <= string->len);
 739   if (to - string->str != string->len)
 740     g_string_truncate (string, to - string->str);
 741
 742   *is_ascii = !(mask & 0x80);
 743
 744   return TRUE;
 745 }
 746
 747 static inline gboolean
 748 advance_char (GMarkupParseContext *context)
 749 {
 750   context->iter++;
 751   context->char_number++;
 752
 753   if (G_UNLIKELY (context->iter == context->current_text_end))
 754       return FALSE;
 755
 756   else if (G_UNLIKELY (*context->iter == '\n'))
 757     {
 758       context->line_number++;
 759       context->char_number = 1;
 760     }
 761
 762   return TRUE;
 763 }
 764
 765 static inline gboolean
 766 xml_isspace (char c)
 767 {
 768   return c == ' ' || c == '\t' || c == '\n' || c == '\r';
 769 }
 770
 771 static void
 772 skip_spaces (GMarkupParseContext *context)
 773 {
 774   do
 775     {
 776       if (!xml_isspace (*context->iter))
 777         return;
 778     }
 779   while (advance_char (context));
 780 }
 781
 782 static void
 783 advance_to_name_end (GMarkupParseContext *context)
 784 {
 785   do
 786     {
 787       if (IS_COMMON_NAME_END_CHAR (*(context->iter)))
 788         return;
 789       if (xml_isspace (*(context->iter)))
 790         return;
 791     }
 792   while (advance_char (context));
 793 }
 794
 795 static void
 796 release_chunk (GMarkupParseContext *context, GString *str)
 797 {
 798   GSList *node;
 799   if (!str)
 800     return;
 801   if (str->allocated_len > 256)
 802     { /* large strings are unusual and worth freeing */
 803       g_string_free (str, TRUE);
 804       return;
 805     }
 806   string_blank (str);
 807   node = get_list_node (context, str);
 808   context->spare_chunks = g_slist_concat (node, context->spare_chunks);
 809 }
 810
 811 static void
 812 add_to_partial (GMarkupParseContext *context,
 813                 const gchar         *text_start,
 814                 const gchar         *text_end)
 815 {
 816   if (context->partial_chunk == NULL)
 817     { /* allocate a new chunk to parse into */
 818
 819       if (context->spare_chunks != NULL)
 820         {
 821           GSList *node = context->spare_chunks;
 822           context->spare_chunks = g_slist_remove_link (context->spare_chunks, node);
 823           context->partial_chunk = node->data;
 824           free_list_node (context, node);
 825         }
 826       else
 827         context->partial_chunk = g_string_sized_new (MAX (28, text_end - text_start));
 828     }
 829
 830   if (text_start != text_end)
 831     g_string_insert_len (context->partial_chunk, -1,
 832                          text_start, text_end - text_start);
 833 }
 834
 835 static inline void
 836 truncate_partial (GMarkupParseContext *context)
 837 {
 838   if (context->partial_chunk != NULL)
 839     string_blank (context->partial_chunk);
 840 }
 841
 842 static inline const gchar*
 843 current_element (GMarkupParseContext *context)
 844 {
 845   return context->tag_stack->data;
 846 }
 847
 848 static void
 849 pop_subparser_stack (GMarkupParseContext *context)
 850 {
 851   GMarkupRecursionTracker *tracker;
 852
 853   g_assert (context->subparser_stack);
 854
 855   tracker = context->subparser_stack->data;
 856
 857   context->awaiting_pop = TRUE;
 858   context->held_user_data = context->user_data;
 859
 860   context->user_data = tracker->prev_user_data;
 861   context->parser = tracker->prev_parser;
 862   context->subparser_element = tracker->prev_element;
 863   g_slice_free (GMarkupRecursionTracker, tracker);
 864
 865   context->subparser_stack = g_slist_delete_link (context->subparser_stack,
 866                                                   context->subparser_stack);
 867 }
 868
 869 static void
 870 push_partial_as_tag (GMarkupParseContext *context)
 871 {
 872   GString *str = context->partial_chunk;
 873   /* sadly, this is exported by gmarkup_get_element_stack as-is */
 874   context->tag_stack = g_slist_concat (get_list_node (context, str->str), context->tag_stack);
 875   context->tag_stack_gstr = g_slist_concat (get_list_node (context, str), context->tag_stack_gstr);
 876   context->partial_chunk = NULL;
 877 }
 878
 879 static void
 880 pop_tag (GMarkupParseContext *context)
 881 {
 882   GSList *nodea, *nodeb;
 883
 884   nodea = context->tag_stack;
 885   nodeb = context->tag_stack_gstr;
 886   release_chunk (context, nodeb->data);
 887   context->tag_stack = g_slist_remove_link (context->tag_stack, nodea);
 888   context->tag_stack_gstr = g_slist_remove_link (context->tag_stack_gstr, nodeb);
 889   free_list_node (context, nodea);
 890   free_list_node (context, nodeb);
 891 }
 892
 893 static void
 894 possibly_finish_subparser (GMarkupParseContext *context)
 895 {
 896   if (current_element (context) == context->subparser_element)
 897     pop_subparser_stack (context);
 898 }
 899
 900 static void
 901 ensure_no_outstanding_subparser (GMarkupParseContext *context)
 902 {
 903   if (context->awaiting_pop)
 904     g_critical ("During the first end_element call after invoking a "
 905                 "subparser you must pop the subparser stack and handle "
 906                 "the freeing of the subparser user_data.  This can be "
 907                 "done by calling the end function of the subparser.  "
 908                 "Very probably, your program just leaked memory.");
 909
 910   /* let valgrind watch the pointer disappear... */
 911   context->held_user_data = NULL;
 912   context->awaiting_pop = FALSE;
 913 }
 914
 915 static const gchar*
 916 current_attribute (GMarkupParseContext *context)
 917 {
 918   g_assert (context->cur_attr >= 0);
 919   return context->attr_names[context->cur_attr]->str;
 920 }
 921
 922 static void
 923 add_attribute (GMarkupParseContext *context, GString *str)
 924 {
 925   if (context->cur_attr + 2 >= context->alloc_attrs)
 926     {
 927       context->alloc_attrs += 5; /* silly magic number */
 928       context->attr_names = g_realloc (context->attr_names, sizeof(GString*)*context->alloc_attrs);
 929       context->attr_values = g_realloc (context->attr_values, sizeof(GString*)*context->alloc_attrs);
 930     }
 931   context->cur_attr++;
 932   context->attr_names[context->cur_attr] = str;
 933   context->attr_values[context->cur_attr] = NULL;
 934   context->attr_names[context->cur_attr+1] = NULL;
 935   context->attr_values[context->cur_attr+1] = NULL;
 936 }
 937
 938 static void
 939 clear_attributes (GMarkupParseContext *context)
 940 {
 941   /* Go ahead and free the attributes. */
 942   for (; context->cur_attr >= 0; context->cur_attr--)
 943     {
 944       int pos = context->cur_attr;
 945       release_chunk (context, context->attr_names[pos]);
 946       release_chunk (context, context->attr_values[pos]);
 947       context->attr_names[pos] = context->attr_values[pos] = NULL;
 948     }
 949   g_assert (context->cur_attr == -1);
 950   g_assert (context->attr_names == NULL ||
 951             context->attr_names[0] == NULL);
 952   g_assert (context->attr_values == NULL ||
 953             context->attr_values[0] == NULL);
 954 }
 955
 956 /* This has to be a separate function to ensure the alloca's
 957  * are unwound on exit - otherwise we grow & blow the stack
 958  * with large documents
 959  */
 960 static inline void
 961 emit_start_element (GMarkupParseContext  *context,
 962                     GError              **error)
 963 {
 964   int i;
 965   const gchar *start_name;
 966   const gchar **attr_names;
 967   const gchar **attr_values;
 968   GError *tmp_error;
 969
 970   attr_names = g_newa (const gchar *, context->cur_attr + 2);
 971   attr_values = g_newa (const gchar *, context->cur_attr + 2);
 972   for (i = 0; i < context->cur_attr + 1; i++)
 973     {
 974       attr_names[i] = context->attr_names[i]->str;
 975       attr_values[i] = context->attr_values[i]->str;
 976     }
 977   attr_names[i] = NULL;
 978   attr_values[i] = NULL;
 979
 980   /* Call user callback for element start */
 981   tmp_error = NULL;
 982   start_name = current_element (context);
 983
 984   if (context->parser->start_element &&
 985       name_validate (context, start_name, error))
 986     (* context->parser->start_element) (context,
 987                                         start_name,
 988                                         (const gchar **)attr_names,
 989                                         (const gchar **)attr_values,
 990                                         context->user_data,
 991                                         &tmp_error);
 992   clear_attributes (context);
 993
 994   if (tmp_error != NULL)
 995     propagate_error (context, error, tmp_error);
 996 }
 997
 998 /**
 999  * g_markup_parse_context_parse:
1000  * @context: a #GMarkupParseContext
1001  * @text: chunk of text to parse
1002  * @text_len: length of @text in bytes
1003  * @error: return location for a #GError
1004  *
1005  * Feed some data to the #GMarkupParseContext.
1006  *
1007  * The data need not be valid UTF-8; an error will be signaled if
1008  * it's invalid. The data need not be an entire document; you can
1009  * feed a document into the parser incrementally, via multiple calls
1010  * to this function. Typically, as you receive data from a network
1011  * connection or file, you feed each received chunk of data into this
1012  * function, aborting the process if an error occurs. Once an error
1013  * is reported, no further data may be fed to the #GMarkupParseContext;
1014  * all errors are fatal.
1015  *
1016  * Return value: %FALSE if an error occurred, %TRUE on success
1017  */
1018 gboolean
1019 g_markup_parse_context_parse (GMarkupParseContext  *context,
1020                               const gchar          *text,
1021                               gssize                text_len,
1022                               GError              **error)
1023 {
1024   g_return_val_if_fail (context != NULL, FALSE);
1025   g_return_val_if_fail (text != NULL, FALSE);
1026   g_return_val_if_fail (context->state != STATE_ERROR, FALSE);
1027   g_return_val_if_fail (!context->parsing, FALSE);
1028
1029   if (text_len < 0)
1030     text_len = strlen (text);
1031
1032   if (text_len == 0)
1033     return TRUE;
1034
1035   context->parsing = TRUE;
1036
1037
1038   context->current_text = text;
1039   context->current_text_len = text_len;
1040   context->current_text_end = context->current_text + text_len;
1041   context->iter = context->current_text;
1042   context->start = context->iter;
1043
1044   while (context->iter != context->current_text_end)
1045     {
1046       switch (context->state)
1047         {
1048         case STATE_START:
1049           /* Possible next state: AFTER_OPEN_ANGLE */
1050
1051           g_assert (context->tag_stack == NULL);
1052
1053           /* whitespace is ignored outside of any elements */
1054           skip_spaces (context);
1055
1056           if (context->iter != context->current_text_end)
1057             {
1058               if (*context->iter == '<')
1059                 {
1060                   /* Move after the open angle */
1061                   advance_char (context);
1062
1063                   context->state = STATE_AFTER_OPEN_ANGLE;
1064
1065                   /* this could start a passthrough */
1066                   context->start = context->iter;
1067
1068                   /* document is now non-empty */
1069                   context->document_empty = FALSE;
1070                 }
1071               else
1072                 {
1073                   set_error_literal (context,
1074                                      error,
1075                                      G_MARKUP_ERROR_PARSE,
1076                                      _("Document must begin with an element (e.g. <book>)"));
1077                 }
1078             }
1079           break;
1080
1081         case STATE_AFTER_OPEN_ANGLE:
1082           /* Possible next states: INSIDE_OPEN_TAG_NAME,
1083            *  AFTER_CLOSE_TAG_SLASH, INSIDE_PASSTHROUGH
1084            */
1085           if (*context->iter == '?' ||
1086               *context->iter == '!')
1087             {
1088               /* include < in the passthrough */
1089               const gchar *openangle = "<";
1090               add_to_partial (context, openangle, openangle + 1);
1091               context->start = context->iter;
1092               context->balance = 1;
1093               context->state = STATE_INSIDE_PASSTHROUGH;
1094             }
1095           else if (*context->iter == '/')
1096             {
1097               /* move after it */
1098               advance_char (context);
1099
1100               context->state = STATE_AFTER_CLOSE_TAG_SLASH;
1101             }
1102           else if (!IS_COMMON_NAME_END_CHAR (*(context->iter)))
1103             {
1104               context->state = STATE_INSIDE_OPEN_TAG_NAME;
1105
1106               /* start of tag name */
1107               context->start = context->iter;
1108             }
1109           else
1110             {
1111               gchar buf[8];
1112
1113               set_error (context,
1114                          error,
1115                          G_MARKUP_ERROR_PARSE,
1116                          _("'%s' is not a valid character following "
1117                            "a '<' character; it may not begin an "
1118                            "element name"),
1119                          utf8_str (context->iter, buf));
1120             }
1121           break;
1122
1123           /* The AFTER_CLOSE_ANGLE state is actually sort of
1124            * broken, because it doesn't correspond to a range
1125            * of characters in the input stream as the others do,
1126            * and thus makes things harder to conceptualize
1127            */
1128         case STATE_AFTER_CLOSE_ANGLE:
1129           /* Possible next states: INSIDE_TEXT, STATE_START */
1130           if (context->tag_stack == NULL)
1131             {
1132               context->start = NULL;
1133               context->state = STATE_START;
1134             }
1135           else
1136             {
1137               context->start = context->iter;
1138               context->state = STATE_INSIDE_TEXT;
1139             }
1140           break;
1141
1142         case STATE_AFTER_ELISION_SLASH:
1143           /* Possible next state: AFTER_CLOSE_ANGLE */
1144
1145           {
1146             /* We need to pop the tag stack and call the end_element
1147              * function, since this is the close tag
1148              */
1149             GError *tmp_error = NULL;
1150
1151             g_assert (context->tag_stack != NULL);
1152
1153             possibly_finish_subparser (context);
1154
1155             tmp_error = NULL;
1156             if (context->parser->end_element)
1157               (* context->parser->end_element) (context,
1158                                                 current_element (context),
1159                                                 context->user_data,
1160                                                 &tmp_error);
1161
1162             ensure_no_outstanding_subparser (context);
1163
1164             if (tmp_error)
1165               {
1166                 mark_error (context, tmp_error);
1167                 g_propagate_error (error, tmp_error);
1168               }
1169             else
1170               {
1171                 if (*context->iter == '>')
1172                   {
1173                     /* move after the close angle */
1174                     advance_char (context);
1175                     context->state = STATE_AFTER_CLOSE_ANGLE;
1176                   }
1177                 else
1178                   {
1179                     gchar buf[8];
1180
1181                     set_error (context,
1182                                error,
1183                                G_MARKUP_ERROR_PARSE,
1184                                _("Odd character '%s', expected a '>' character "
1185                                  "to end the empty-element tag '%s'"),
1186                                utf8_str (context->iter, buf),
1187                                current_element (context));
1188                   }
1189               }
1190             pop_tag (context);
1191           }
1192           break;
1193
1194         case STATE_INSIDE_OPEN_TAG_NAME:
1195           /* Possible next states: BETWEEN_ATTRIBUTES */
1196
1197           /* if there's a partial chunk then it's the first part of the
1198            * tag name. If there's a context->start then it's the start
1199            * of the tag name in current_text, the partial chunk goes
1200            * before that start though.
1201            */
1202           advance_to_name_end (context);
1203
1204           if (context->iter == context->current_text_end)
1205             {
1206               /* The name hasn't necessarily ended. Merge with
1207                * partial chunk, leave state unchanged.
1208                */
1209               add_to_partial (context, context->start, context->iter);
1210             }
1211           else
1212             {
1213               /* The name has ended. Combine it with the partial chunk
1214                * if any; push it on the stack; enter next state.
1215                */
1216               add_to_partial (context, context->start, context->iter);
1217               push_partial_as_tag (context);
1218
1219               context->state = STATE_BETWEEN_ATTRIBUTES;
1220               context->start = NULL;
1221             }
1222           break;
1223
1224         case STATE_INSIDE_ATTRIBUTE_NAME:
1225           /* Possible next states: AFTER_ATTRIBUTE_NAME */
1226
1227           advance_to_name_end (context);
1228           add_to_partial (context, context->start, context->iter);
1229
1230           /* read the full name, if we enter the equals sign state
1231            * then add the attribute to the list (without the value),
1232            * otherwise store a partial chunk to be prepended later.
1233            */
1234           if (context->iter != context->current_text_end)
1235             context->state = STATE_AFTER_ATTRIBUTE_NAME;
1236           break;
1237
1238         case STATE_AFTER_ATTRIBUTE_NAME:
1239           /* Possible next states: AFTER_ATTRIBUTE_EQUALS_SIGN */
1240
1241           skip_spaces (context);
1242
1243           if (context->iter != context->current_text_end)
1244             {
1245               /* The name has ended. Combine it with the partial chunk
1246                * if any; push it on the stack; enter next state.
1247                */
1248               if (!name_validate (context, context->partial_chunk->str, error))
1249                 break;
1250
1251               add_attribute (context, context->partial_chunk);
1252
1253               context->partial_chunk = NULL;
1254               context->start = NULL;
1255
1256               if (*context->iter == '=')
1257                 {
1258                   advance_char (context);
1259                   context->state = STATE_AFTER_ATTRIBUTE_EQUALS_SIGN;
1260                 }
1261               else
1262                 {
1263                   gchar buf[8];
1264
1265                   set_error (context,
1266                              error,
1267                              G_MARKUP_ERROR_PARSE,
1268                              _("Odd character '%s', expected a '=' after "
1269                                "attribute name '%s' of element '%s'"),
1270                              utf8_str (context->iter, buf),
1271                              current_attribute (context),
1272                              current_element (context));
1273
1274                 }
1275             }
1276           break;
1277
1278         case STATE_BETWEEN_ATTRIBUTES:
1279           /* Possible next states: AFTER_CLOSE_ANGLE,
1280            * AFTER_ELISION_SLASH, INSIDE_ATTRIBUTE_NAME
1281            */
1282           skip_spaces (context);
1283
1284           if (context->iter != context->current_text_end)
1285             {
1286               if (*context->iter == '/')
1287                 {
1288                   advance_char (context);
1289                   context->state = STATE_AFTER_ELISION_SLASH;
1290                 }
1291               else if (*context->iter == '>')
1292                 {
1293                   advance_char (context);
1294                   context->state = STATE_AFTER_CLOSE_ANGLE;
1295                 }
1296               else if (!IS_COMMON_NAME_END_CHAR (*(context->iter)))
1297                 {
1298                   context->state = STATE_INSIDE_ATTRIBUTE_NAME;
1299                   /* start of attribute name */
1300                   context->start = context->iter;
1301                 }
1302               else
1303                 {
1304                   gchar buf[8];
1305
1306                   set_error (context,
1307                              error,
1308                              G_MARKUP_ERROR_PARSE,
1309                              _("Odd character '%s', expected a '>' or '/' "
1310                                "character to end the start tag of "
1311                                "element '%s', or optionally an attribute; "
1312                                "perhaps you used an invalid character in "
1313                                "an attribute name"),
1314                              utf8_str (context->iter, buf),
1315                              current_element (context));
1316                 }
1317
1318               /* If we're done with attributes, invoke
1319                * the start_element callback
1320                */
1321               if (context->state == STATE_AFTER_ELISION_SLASH ||
1322                   context->state == STATE_AFTER_CLOSE_ANGLE)
1323                 emit_start_element (context, error);
1324             }
1325           break;
1326
1327         case STATE_AFTER_ATTRIBUTE_EQUALS_SIGN:
1328           /* Possible next state: INSIDE_ATTRIBUTE_VALUE_[SQ/DQ] */
1329
1330           skip_spaces (context);
1331
1332           if (context->iter != context->current_text_end)
1333             {
1334               if (*context->iter == '"')
1335                 {
1336                   advance_char (context);
1337                   context->state = STATE_INSIDE_ATTRIBUTE_VALUE_DQ;
1338                   context->start = context->iter;
1339                 }
1340               else if (*context->iter == '\'')
1341                 {
1342                   advance_char (context);
1343                   context->state = STATE_INSIDE_ATTRIBUTE_VALUE_SQ;
1344                   context->start = context->iter;
1345                 }
1346               else
1347                 {
1348                   gchar buf[8];
1349
1350                   set_error (context,
1351                              error,
1352                              G_MARKUP_ERROR_PARSE,
1353                              _("Odd character '%s', expected an open quote mark "
1354                                "after the equals sign when giving value for "
1355                                "attribute '%s' of element '%s'"),
1356                              utf8_str (context->iter, buf),
1357                              current_attribute (context),
1358                              current_element (context));
1359                 }
1360             }
1361           break;
1362
1363         case STATE_INSIDE_ATTRIBUTE_VALUE_SQ:
1364         case STATE_INSIDE_ATTRIBUTE_VALUE_DQ:
1365           /* Possible next states: BETWEEN_ATTRIBUTES */
1366           {
1367             gchar delim;
1368
1369             if (context->state == STATE_INSIDE_ATTRIBUTE_VALUE_SQ)
1370               {
1371                 delim = '\'';
1372               }
1373             else
1374               {
1375                 delim = '"';
1376               }
1377
1378             do
1379               {
1380                 if (*context->iter == delim)
1381                   break;
1382               }
1383             while (advance_char (context));
1384           }
1385           if (context->iter == context->current_text_end)
1386             {
1387               /* The value hasn't necessarily ended. Merge with
1388                * partial chunk, leave state unchanged.
1389                */
1390               add_to_partial (context, context->start, context->iter);
1391             }
1392           else
1393             {
1394               gboolean is_ascii;
1395               /* The value has ended at the quote mark. Combine it
1396                * with the partial chunk if any; set it for the current
1397                * attribute.
1398                */
1399               add_to_partial (context, context->start, context->iter);
1400
1401               g_assert (context->cur_attr >= 0);
1402
1403               if (unescape_gstring_inplace (context, context->partial_chunk, &is_ascii, error) &&
1404                   (is_ascii || text_validate (context, context->partial_chunk->str,
1405                                               context->partial_chunk->len, error)))
1406                 {
1407                   /* success, advance past quote and set state. */
1408                   context->attr_values[context->cur_attr] = context->partial_chunk;
1409                   context->partial_chunk = NULL;
1410                   advance_char (context);
1411                   context->state = STATE_BETWEEN_ATTRIBUTES;
1412                   context->start = NULL;
1413                 }
1414
1415               truncate_partial (context);
1416             }
1417           break;
1418
1419         case STATE_INSIDE_TEXT:
1420           /* Possible next states: AFTER_OPEN_ANGLE */
1421           do
1422             {
1423               if (*context->iter == '<')
1424                 break;
1425             }
1426           while (advance_char (context));
1427
1428           /* The text hasn't necessarily ended. Merge with
1429            * partial chunk, leave state unchanged.
1430            */
1431
1432           add_to_partial (context, context->start, context->iter);
1433
1434           if (context->iter != context->current_text_end)
1435             {
1436               gboolean is_ascii;
1437
1438               /* The text has ended at the open angle. Call the text
1439                * callback.
1440                */
1441               if (unescape_gstring_inplace (context, context->partial_chunk, &is_ascii, error) &&
1442                   (is_ascii || text_validate (context, context->partial_chunk->str,
1443                                               context->partial_chunk->len, error)))
1444                 {
1445                   GError *tmp_error = NULL;
1446
1447                   if (context->parser->text)
1448                     (*context->parser->text) (context,
1449                                               context->partial_chunk->str,
1450                                               context->partial_chunk->len,
1451                                               context->user_data,
1452                                               &tmp_error);
1453
1454                   if (tmp_error == NULL)
1455                     {
1456                       /* advance past open angle and set state. */
1457                       advance_char (context);
1458                       context->state = STATE_AFTER_OPEN_ANGLE;
1459                       /* could begin a passthrough */
1460                       context->start = context->iter;
1461                     }
1462                   else
1463                     propagate_error (context, error, tmp_error);
1464                 }
1465
1466               truncate_partial (context);
1467             }
1468           break;
1469
1470         case STATE_AFTER_CLOSE_TAG_SLASH:
1471           /* Possible next state: INSIDE_CLOSE_TAG_NAME */
1472           if (!IS_COMMON_NAME_END_CHAR (*(context->iter)))
1473             {
1474               context->state = STATE_INSIDE_CLOSE_TAG_NAME;
1475
1476               /* start of tag name */
1477               context->start = context->iter;
1478             }
1479           else
1480             {
1481               gchar buf[8];
1482
1483               set_error (context,
1484                          error,
1485                          G_MARKUP_ERROR_PARSE,
1486                          _("'%s' is not a valid character following "
1487                            "the characters '</'; '%s' may not begin an "
1488                            "element name"),
1489                          utf8_str (context->iter, buf),
1490                          utf8_str (context->iter, buf));
1491             }
1492           break;
1493
1494         case STATE_INSIDE_CLOSE_TAG_NAME:
1495           /* Possible next state: AFTER_CLOSE_TAG_NAME */
1496           advance_to_name_end (context);
1497           add_to_partial (context, context->start, context->iter);
1498
1499           if (context->iter != context->current_text_end)
1500             context->state = STATE_AFTER_CLOSE_TAG_NAME;
1501           break;
1502
1503         case STATE_AFTER_CLOSE_TAG_NAME:
1504           /* Possible next state: AFTER_CLOSE_TAG_SLASH */
1505
1506           skip_spaces (context);
1507
1508           if (context->iter != context->current_text_end)
1509             {
1510               GString *close_name;
1511
1512               close_name = context->partial_chunk;
1513               context->partial_chunk = NULL;
1514
1515               if (*context->iter != '>')
1516                 {
1517                   gchar buf[8];
1518
1519                   set_error (context,
1520                              error,
1521                              G_MARKUP_ERROR_PARSE,
1522                              _("'%s' is not a valid character following "
1523                                "the close element name '%s'; the allowed "
1524                                "character is '>'"),
1525                              utf8_str (context->iter, buf),
1526                              close_name->str);
1527                 }
1528               else if (context->tag_stack == NULL)
1529                 {
1530                   set_error (context,
1531                              error,
1532                              G_MARKUP_ERROR_PARSE,
1533                              _("Element '%s' was closed, no element "
1534                                "is currently open"),
1535                              close_name->str);
1536                 }
1537               else if (strcmp (close_name->str, current_element (context)) != 0)
1538                 {
1539                   set_error (context,
1540                              error,
1541                              G_MARKUP_ERROR_PARSE,
1542                              _("Element '%s' was closed, but the currently "
1543                                "open element is '%s'"),
1544                              close_name->str,
1545                              current_element (context));
1546                 }
1547               else
1548                 {
1549                   GError *tmp_error;
1550                   advance_char (context);
1551                   context->state = STATE_AFTER_CLOSE_ANGLE;
1552                   context->start = NULL;
1553
1554                   possibly_finish_subparser (context);
1555
1556                   /* call the end_element callback */
1557                   tmp_error = NULL;
1558                   if (context->parser->end_element)
1559                     (* context->parser->end_element) (context,
1560                                                       close_name->str,
1561                                                       context->user_data,
1562                                                       &tmp_error);
1563
1564                   ensure_no_outstanding_subparser (context);
1565                   pop_tag (context);
1566
1567                   if (tmp_error)
1568                     propagate_error (context, error, tmp_error);
1569                 }
1570               context->partial_chunk = close_name;
1571               truncate_partial (context);
1572             }
1573           break;
1574
1575         case STATE_INSIDE_PASSTHROUGH:
1576           /* Possible next state: AFTER_CLOSE_ANGLE */
1577           do
1578             {
1579               if (*context->iter == '<')
1580                 context->balance++;
1581               if (*context->iter == '>')
1582                 {
1583                   gchar *str;
1584                   gsize len;
1585
1586                   context->balance--;
1587                   add_to_partial (context, context->start, context->iter);
1588                   context->start = context->iter;
1589
1590                   str = context->partial_chunk->str;
1591                   len = context->partial_chunk->len;
1592
1593                   if (str[1] == '?' && str[len - 1] == '?')
1594                     break;
1595                   if (strncmp (str, "<!--", 4) == 0 &&
1596                       strcmp (str + len - 2, "--") == 0)
1597                     break;
1598                   if (strncmp (str, "<![CDATA[", 9) == 0 &&
1599                       strcmp (str + len - 2, "]]") == 0)
1600                     break;
1601                   if (strncmp (str, "<!DOCTYPE", 9) == 0 &&
1602                       context->balance == 0)
1603                     break;
1604                 }
1605             }
1606           while (advance_char (context));
1607
1608           if (context->iter == context->current_text_end)
1609             {
1610               /* The passthrough hasn't necessarily ended. Merge with
1611                * partial chunk, leave state unchanged.
1612                */
1613                add_to_partial (context, context->start, context->iter);
1614             }
1615           else
1616             {
1617               /* The passthrough has ended at the close angle. Combine
1618                * it with the partial chunk if any. Call the passthrough
1619                * callback. Note that the open/close angles are
1620                * included in the text of the passthrough.
1621                */
1622               GError *tmp_error = NULL;
1623
1624               advance_char (context); /* advance past close angle */
1625               add_to_partial (context, context->start, context->iter);
1626
1627               if (context->flags & G_MARKUP_TREAT_CDATA_AS_TEXT &&
1628                   strncmp (context->partial_chunk->str, "<![CDATA[", 9) == 0)
1629                 {
1630                   if (context->parser->text &&
1631                       text_validate (context,
1632                                      context->partial_chunk->str + 9,
1633                                      context->partial_chunk->len - 12,
1634                                      error))
1635                     (*context->parser->text) (context,
1636                                               context->partial_chunk->str + 9,
1637                                               context->partial_chunk->len - 12,
1638                                               context->user_data,
1639                                               &tmp_error);
1640                 }
1641               else if (context->parser->passthrough &&
1642                        text_validate (context,
1643                                       context->partial_chunk->str,
1644                                       context->partial_chunk->len,
1645                                       error))
1646                 (*context->parser->passthrough) (context,
1647                                                  context->partial_chunk->str,
1648                                                  context->partial_chunk->len,
1649                                                  context->user_data,
1650                                                  &tmp_error);
1651
1652               truncate_partial (context);
1653
1654               if (tmp_error == NULL)
1655                 {
1656                   context->state = STATE_AFTER_CLOSE_ANGLE;
1657                   context->start = context->iter; /* could begin text */
1658                 }
1659               else
1660                 propagate_error (context, error, tmp_error);
1661             }
1662           break;
1663
1664         case STATE_ERROR:
1665           goto finished;
1666           break;
1667
1668         default:
1669           g_assert_not_reached ();
1670           break;
1671         }
1672     }
1673
1674  finished:
1675   context->parsing = FALSE;
1676
1677   return context->state != STATE_ERROR;
1678 }
1679
1680 /**
1681  * g_markup_parse_context_end_parse:
1682  * @context: a #GMarkupParseContext
1683  * @error: return location for a #GError
1684  *
1685  * Signals to the #GMarkupParseContext that all data has been
1686  * fed into the parse context with g_markup_parse_context_parse().
1687  *
1688  * This function reports an error if the document isn't complete,
1689  * for example if elements are still open.
1690  *
1691  * Return value: %TRUE on success, %FALSE if an error was set
1692  */
1693 gboolean
1694 g_markup_parse_context_end_parse (GMarkupParseContext  *context,
1695                                   GError              **error)
1696 {
1697   g_return_val_if_fail (context != NULL, FALSE);
1698   g_return_val_if_fail (!context->parsing, FALSE);
1699   g_return_val_if_fail (context->state != STATE_ERROR, FALSE);
1700
1701   if (context->partial_chunk != NULL)
1702     {
1703       g_string_free (context->partial_chunk, TRUE);
1704       context->partial_chunk = NULL;
1705     }
1706
1707   if (context->document_empty)
1708     {
1709       set_error_literal (context, error, G_MARKUP_ERROR_EMPTY,
1710                          _("Document was empty or contained only whitespace"));
1711       return FALSE;
1712     }
1713
1714   context->parsing = TRUE;
1715
1716   switch (context->state)
1717     {
1718     case STATE_START:
1719       /* Nothing to do */
1720       break;
1721
1722     case STATE_AFTER_OPEN_ANGLE:
1723       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1724                          _("Document ended unexpectedly just after an open angle bracket '<'"));
1725       break;
1726
1727     case STATE_AFTER_CLOSE_ANGLE:
1728       if (context->tag_stack != NULL)
1729         {
1730           /* Error message the same as for INSIDE_TEXT */
1731           set_error (context, error, G_MARKUP_ERROR_PARSE,
1732                      _("Document ended unexpectedly with elements still open - "
1733                        "'%s' was the last element opened"),
1734                      current_element (context));
1735         }
1736       break;
1737
1738     case STATE_AFTER_ELISION_SLASH:
1739       set_error (context, error, G_MARKUP_ERROR_PARSE,
1740                  _("Document ended unexpectedly, expected to see a close angle "
1741                    "bracket ending the tag <%s/>"), current_element (context));
1742       break;
1743
1744     case STATE_INSIDE_OPEN_TAG_NAME:
1745       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1746                          _("Document ended unexpectedly inside an element name"));
1747       break;
1748
1749     case STATE_INSIDE_ATTRIBUTE_NAME:
1750     case STATE_AFTER_ATTRIBUTE_NAME:
1751       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1752                          _("Document ended unexpectedly inside an attribute name"));
1753       break;
1754
1755     case STATE_BETWEEN_ATTRIBUTES:
1756       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1757                          _("Document ended unexpectedly inside an element-opening "
1758                            "tag."));
1759       break;
1760
1761     case STATE_AFTER_ATTRIBUTE_EQUALS_SIGN:
1762       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1763                          _("Document ended unexpectedly after the equals sign "
1764                            "following an attribute name; no attribute value"));
1765       break;
1766
1767     case STATE_INSIDE_ATTRIBUTE_VALUE_SQ:
1768     case STATE_INSIDE_ATTRIBUTE_VALUE_DQ:
1769       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1770                          _("Document ended unexpectedly while inside an attribute "
1771                            "value"));
1772       break;
1773
1774     case STATE_INSIDE_TEXT:
1775       g_assert (context->tag_stack != NULL);
1776       set_error (context, error, G_MARKUP_ERROR_PARSE,
1777                  _("Document ended unexpectedly with elements still open - "
1778                    "'%s' was the last element opened"),
1779                  current_element (context));
1780       break;
1781
1782     case STATE_AFTER_CLOSE_TAG_SLASH:
1783     case STATE_INSIDE_CLOSE_TAG_NAME:
1784     case STATE_AFTER_CLOSE_TAG_NAME:
1785       set_error (context, error, G_MARKUP_ERROR_PARSE,
1786                  _("Document ended unexpectedly inside the close tag for "
1787                    "element '%s'"), current_element (context));
1788       break;
1789
1790     case STATE_INSIDE_PASSTHROUGH:
1791       set_error_literal (context, error, G_MARKUP_ERROR_PARSE,
1792                          _("Document ended unexpectedly inside a comment or "
1793                            "processing instruction"));
1794       break;
1795
1796     case STATE_ERROR:
1797     default:
1798       g_assert_not_reached ();
1799       break;
1800     }
1801
1802   context->parsing = FALSE;
1803
1804   return context->state != STATE_ERROR;
1805 }
1806
1807 /**
1808  * g_markup_parse_context_get_element:
1809  * @context: a #GMarkupParseContext
1810  *
1811  * Retrieves the name of the currently open element.
1812  *
1813  * If called from the start_element or end_element handlers this will
1814  * give the element_name as passed to those functions. For the parent
1815  * elements, see g_markup_parse_context_get_element_stack().
1816  *
1817  * Returns: the name of the currently open element, or %NULL
1818  *
1819  * Since: 2.2
1820  */
1821 const gchar *
1822 g_markup_parse_context_get_element (GMarkupParseContext *context)
1823 {
1824   g_return_val_if_fail (context != NULL, NULL);
1825
1826   if (context->tag_stack == NULL)
1827     return NULL;
1828   else
1829     return current_element (context);
1830 }
1831
1832 /**
1833  * g_markup_parse_context_get_element_stack:
1834  * @context: a #GMarkupParseContext
1835  *
1836  * Retrieves the element stack from the internal state of the parser.
1837  *
1838  * The returned #GSList is a list of strings where the first item is
1839  * the currently open tag (as would be returned by
1840  * g_markup_parse_context_get_element()) and the next item is its
1841  * immediate parent.
1842  *
1843  * This function is intended to be used in the start_element and
1844  * end_element handlers where g_markup_parse_context_get_element()
1845  * would merely return the name of the element that is being
1846  * processed.
1847  *
1848  * Returns: the element stack, which must not be modified
1849  *
1850  * Since: 2.16
1851  */
1852 const GSList *
1853 g_markup_parse_context_get_element_stack (GMarkupParseContext *context)
1854 {
1855   g_return_val_if_fail (context != NULL, NULL);
1856   return context->tag_stack;
1857 }
1858
1859 /**
1860  * g_markup_parse_context_get_position:
1861  * @context: a #GMarkupParseContext
1862  * @line_number: (allow-none): return location for a line number, or %NULL
1863  * @char_number: (allow-none): return location for a char-on-line number, or %NULL
1864  *
1865  * Retrieves the current line number and the number of the character on
1866  * that line. Intended for use in error messages; there are no strict
1867  * semantics for what constitutes the "current" line number other than
1868  * "the best number we could come up with for error messages."
1869  */
1870 void
1871 g_markup_parse_context_get_position (GMarkupParseContext *context,
1872                                      gint                *line_number,
1873                                      gint                *char_number)
1874 {
1875   g_return_if_fail (context != NULL);
1876
1877   if (line_number)
1878     *line_number = context->line_number;
1879
1880   if (char_number)
1881     *char_number = context->char_number;
1882 }
1883
1884 /**
1885  * g_markup_parse_context_get_user_data:
1886  * @context: a #GMarkupParseContext
1887  *
1888  * Returns the user_data associated with @context.
1889  *
1890  * This will either be the user_data that was provided to
1891  * g_markup_parse_context_new() or to the most recent call
1892  * of g_markup_parse_context_push().
1893  *
1894  * Returns: the provided user_data. The returned data belongs to
1895  *     the markup context and will be freed when
1896  *     g_markup_parse_context_free() is called.
1897  *
1898  * Since: 2.18
1899  */
1900 gpointer
1901 g_markup_parse_context_get_user_data (GMarkupParseContext *context)
1902 {
1903   return context->user_data;
1904 }
1905
1906 /**
1907  * g_markup_parse_context_push:
1908  * @context: a #GMarkupParseContext
1909  * @parser: a #GMarkupParser
1910  * @user_data: user data to pass to #GMarkupParser functions
1911  *
1912  * Temporarily redirects markup data to a sub-parser.
1913  *
1914  * This function may only be called from the start_element handler of
1915  * a #GMarkupParser. It must be matched with a corresponding call to
1916  * g_markup_parse_context_pop() in the matching end_element handler
1917  * (except in the case that the parser aborts due to an error).
1918  *
1919  * All tags, text and other data between the matching tags is
1920  * redirected to the subparser given by @parser. @user_data is used
1921  * as the user_data for that parser. @user_data is also passed to the
1922  * error callback in the event that an error occurs. This includes
1923  * errors that occur in subparsers of the subparser.
1924  *
1925  * The end tag matching the start tag for which this call was made is
1926  * handled by the previous parser (which is given its own user_data)
1927  * which is why g_markup_parse_context_pop() is provided to allow "one
1928  * last access" to the @user_data provided to this function. In the
1929  * case of error, the @user_data provided here is passed directly to
1930  * the error callback of the subparser and g_markup_parse_context_pop()
1931  * should not be called. In either case, if @user_data was allocated
1932  * then it ought to be freed from both of these locations.
1933  *
1934  * This function is not intended to be directly called by users
1935  * interested in invoking subparsers. Instead, it is intended to be
1936  * used by the subparsers themselves to implement a higher-level
1937  * interface.
1938  *
1939  * As an example, see the following implementation of a simple
1940  * parser that counts the number of tags encountered.
1941  *
1942  * |[
1943  * typedef struct
1944  * {
1945  *   gint tag_count;
1946  * } CounterData;
1947  *
1948  * static void
1949  * counter_start_element (GMarkupParseContext  *context,
1950  *                        const gchar          *element_name,
1951  *                        const gchar         **attribute_names,
1952  *                        const gchar         **attribute_values,
1953  *                        gpointer              user_data,
1954  *                        GError              **error)
1955  * {
1956  *   CounterData *data = user_data;
1957  *
1958  *   data->tag_count++;
1959  * }
1960  *
1961  * static void
1962  * counter_error (GMarkupParseContext *context,
1963  *                GError              *error,
1964  *                gpointer             user_data)
1965  * {
1966  *   CounterData *data = user_data;
1967  *
1968  *   g_slice_free (CounterData, data);
1969  * }
1970  *
1971  * static GMarkupParser counter_subparser =
1972  * {
1973  *   counter_start_element,
1974  *   NULL,
1975  *   NULL,
1976  *   NULL,
1977  *   counter_error
1978  * };
1979  * ]|
1980  *
1981  * In order to allow this parser to be easily used as a subparser, the
1982  * following interface is provided:
1983  *
1984  * |[
1985  * void
1986  * start_counting (GMarkupParseContext *context)
1987  * {
1988  *   CounterData *data = g_slice_new (CounterData);
1989  *
1990  *   data->tag_count = 0;
1991  *   g_markup_parse_context_push (context, &counter_subparser, data);
1992  * }
1993  *
1994  * gint
1995  * end_counting (GMarkupParseContext *context)
1996  * {
1997  *   CounterData *data = g_markup_parse_context_pop (context);
1998  *   int result;
1999  *
2000  *   result = data->tag_count;
2001  *   g_slice_free (CounterData, data);
2002  *
2003  *   return result;
2004  * }
2005  * ]|
2006  *
2007  * The subparser would then be used as follows:
2008  *
2009  * |[
2010  * static void start_element (context, element_name, ...)
2011  * {
2012  *   if (strcmp (element_name, "count-these") == 0)
2013  *     start_counting (context);
2014  *
2015  *   /&ast; else, handle other tags... &ast;/
2016  * }
2017  *
2018  * static void end_element (context, element_name, ...)
2019  * {
2020  *   if (strcmp (element_name, "count-these") == 0)
2021  *     g_print ("Counted %d tags\n", end_counting (context));
2022  *
2023  *   /&ast; else, handle other tags... &ast;/
2024  * }
2025  * ]|
2026  *
2027  * Since: 2.18
2028  **/
2029 void
2030 g_markup_parse_context_push (GMarkupParseContext *context,
2031                              const GMarkupParser *parser,
2032                              gpointer             user_data)
2033 {
2034   GMarkupRecursionTracker *tracker;
2035
2036   tracker = g_slice_new (GMarkupRecursionTracker);
2037   tracker->prev_element = context->subparser_element;
2038   tracker->prev_parser = context->parser;
2039   tracker->prev_user_data = context->user_data;
2040
2041   context->subparser_element = current_element (context);
2042   context->parser = parser;
2043   context->user_data = user_data;
2044
2045   context->subparser_stack = g_slist_prepend (context->subparser_stack,
2046                                               tracker);
2047 }
2048
2049 /**
2050  * g_markup_parse_context_pop:
2051  * @context: a #GMarkupParseContext
2052  *
2053  * Completes the process of a temporary sub-parser redirection.
2054  *
2055  * This function exists to collect the user_data allocated by a
2056  * matching call to g_markup_parse_context_push(). It must be called
2057  * in the end_element handler corresponding to the start_element
2058  * handler during which g_markup_parse_context_push() was called.
2059  * You must not call this function from the error callback -- the
2060  * @user_data is provided directly to the callback in that case.
2061  *
2062  * This function is not intended to be directly called by users
2063  * interested in invoking subparsers. Instead, it is intended to
2064  * be used by the subparsers themselves to implement a higher-level
2065  * interface.
2066  *
2067  * Returns: the user data passed to g_markup_parse_context_push()
2068  *
2069  * Since: 2.18
2070  */
2071 gpointer
2072 g_markup_parse_context_pop (GMarkupParseContext *context)
2073 {
2074   gpointer user_data;
2075
2076   if (!context->awaiting_pop)
2077     possibly_finish_subparser (context);
2078
2079   g_assert (context->awaiting_pop);
2080
2081   context->awaiting_pop = FALSE;
2082
2083   /* valgrind friendliness */
2084   user_data = context->held_user_data;
2085   context->held_user_data = NULL;
2086
2087   return user_data;
2088 }
2089
2090 static void
2091 append_escaped_text (GString     *str,
2092                      const gchar *text,
2093                      gssize       length)
2094 {
2095   const gchar *p;
2096   const gchar *end;
2097   gunichar c;
2098
2099   p = text;
2100   end = text + length;
2101
2102   while (p != end)
2103     {
2104       const gchar *next;
2105       next = g_utf8_next_char (p);
2106
2107       switch (*p)
2108         {
2109         case '&':
2110           g_string_append (str, "&amp;");
2111           break;
2112
2113         case '<':
2114           g_string_append (str, "&lt;");
2115           break;
2116
2117         case '>':
2118           g_string_append (str, "&gt;");
2119           break;
2120
2121         case '\'':
2122           g_string_append (str, "&apos;");
2123           break;
2124
2125         case '"':
2126           g_string_append (str, "&quot;");
2127           break;
2128
2129         default:
2130           c = g_utf8_get_char (p);
2131           if ((0x1 <= c && c <= 0x8) ||
2132               (0xb <= c && c  <= 0xc) ||
2133               (0xe <= c && c <= 0x1f) ||
2134               (0x7f <= c && c <= 0x84) ||
2135               (0x86 <= c && c <= 0x9f))
2136             g_string_append_printf (str, "&#x%x;", c);
2137           else
2138             g_string_append_len (str, p, next - p);
2139           break;
2140         }
2141
2142       p = next;
2143     }
2144 }
2145
2146 /**
2147  * g_markup_escape_text:
2148  * @text: some valid UTF-8 text
2149  * @length: length of @text in bytes, or -1 if the text is nul-terminated
2150  *
2151  * Escapes text so that the markup parser will parse it verbatim.
2152  * Less than, greater than, ampersand, etc. are replaced with the
2153  * corresponding entities. This function would typically be used
2154  * when writing out a file to be parsed with the markup parser.
2155  *
2156  * Note that this function doesn't protect whitespace and line endings
2157  * from being processed according to the XML rules for normalization
2158  * of line endings and attribute values.
2159  *
2160  * Note also that this function will produce character references in
2161  * the range of &amp;#x1; ... &amp;#x1f; for all control sequences
2162  * except for tabstop, newline and carriage return.  The character
2163  * references in this range are not valid XML 1.0, but they are
2164  * valid XML 1.1 and will be accepted by the GMarkup parser.
2165  *
2166  * Return value: a newly allocated string with the escaped text
2167  */
2168 gchar*
2169 g_markup_escape_text (const gchar *text,
2170                       gssize       length)
2171 {
2172   GString *str;
2173
2174   g_return_val_if_fail (text != NULL, NULL);
2175
2176   if (length < 0)
2177     length = strlen (text);
2178
2179   /* prealloc at least as long as original text */
2180   str = g_string_sized_new (length);
2181   append_escaped_text (str, text, length);
2182
2183   return g_string_free (str, FALSE);
2184 }
2185
2186 /*
2187  * find_conversion:
2188  * @format: a printf-style format string
2189  * @after: location to store a pointer to the character after
2190  *     the returned conversion. On a %NULL return, returns the
2191  *     pointer to the trailing NUL in the string
2192  *
2193  * Find the next conversion in a printf-style format string.
2194  * Partially based on code from printf-parser.c,
2195  * Copyright (C) 1999-2000, 2002-2003 Free Software Foundation, Inc.
2196  *
2197  * Return value: pointer to the next conversion in @format,
2198  *  or %NULL, if none.
2199  */
2200 static const char *
2201 find_conversion (const char  *format,
2202                  const char **after)
2203 {
2204   const char *start = format;
2205   const char *cp;
2206
2207   while (*start != '\0' && *start != '%')
2208     start++;
2209
2210   if (*start == '\0')
2211     {
2212       *after = start;
2213       return NULL;
2214     }
2215
2216   cp = start + 1;
2217
2218   if (*cp == '\0')
2219     {
2220       *after = cp;
2221       return NULL;
2222     }
2223
2224   /* Test for positional argument.  */
2225   if (*cp >= '0' && *cp <= '9')
2226     {
2227       const char *np;
2228
2229       for (np = cp; *np >= '0' && *np <= '9'; np++)
2230         ;
2231       if (*np == '$')
2232         cp = np + 1;
2233     }
2234
2235   /* Skip the flags.  */
2236   for (;;)
2237     {
2238       if (*cp == '\'' ||
2239           *cp == '-' ||
2240           *cp == '+' ||
2241           *cp == ' ' ||
2242           *cp == '#' ||
2243           *cp == '0')
2244         cp++;
2245       else
2246         break;
2247     }
2248
2249   /* Skip the field width.  */
2250   if (*cp == '*')
2251     {
2252       cp++;
2253
2254       /* Test for positional argument.  */
2255       if (*cp >= '0' && *cp <= '9')
2256         {
2257           const char *np;
2258
2259           for (np = cp; *np >= '0' && *np <= '9'; np++)
2260             ;
2261           if (*np == '$')
2262             cp = np + 1;
2263         }
2264     }
2265   else
2266     {
2267       for (; *cp >= '0' && *cp <= '9'; cp++)
2268         ;
2269     }
2270
2271   /* Skip the precision.  */
2272   if (*cp == '.')
2273     {
2274       cp++;
2275       if (*cp == '*')
2276         {
2277           /* Test for positional argument.  */
2278           if (*cp >= '0' && *cp <= '9')
2279             {
2280               const char *np;
2281
2282               for (np = cp; *np >= '0' && *np <= '9'; np++)
2283                 ;
2284               if (*np == '$')
2285                 cp = np + 1;
2286             }
2287         }
2288       else
2289         {
2290           for (; *cp >= '0' && *cp <= '9'; cp++)
2291             ;
2292         }
2293     }
2294
2295   /* Skip argument type/size specifiers.  */
2296   while (*cp == 'h' ||
2297          *cp == 'L' ||
2298          *cp == 'l' ||
2299          *cp == 'j' ||
2300          *cp == 'z' ||
2301          *cp == 'Z' ||
2302          *cp == 't')
2303     cp++;
2304
2305   /* Skip the conversion character.  */
2306   cp++;
2307
2308   *after = cp;
2309   return start;
2310 }
2311
2312 /**
2313  * g_markup_vprintf_escaped:
2314  * @format: printf() style format string
2315  * @args: variable argument list, similar to vprintf()
2316  *
2317  * Formats the data in @args according to @format, escaping
2318  * all string and character arguments in the fashion
2319  * of g_markup_escape_text(). See g_markup_printf_escaped().
2320  *
2321  * Return value: newly allocated result from formatting
2322  *  operation. Free with g_free().
2323  *
2324  * Since: 2.4
2325  */
2326 gchar *
2327 g_markup_vprintf_escaped (const gchar *format,
2328                           va_list      args)
2329 {
2330   GString *format1;
2331   GString *format2;
2332   GString *result = NULL;
2333   gchar *output1 = NULL;
2334   gchar *output2 = NULL;
2335   const char *p, *op1, *op2;
2336   va_list args2;
2337
2338   /* The technique here, is that we make two format strings that
2339    * have the identical conversions in the identical order to the
2340    * original strings, but differ in the text in-between. We
2341    * then use the normal g_strdup_vprintf() to format the arguments
2342    * with the two new format strings. By comparing the results,
2343    * we can figure out what segments of the output come from
2344    * the the original format string, and what from the arguments,
2345    * and thus know what portions of the string to escape.
2346    *
2347    * For instance, for:
2348    *
2349    *  g_markup_printf_escaped ("%s ate %d apples", "Susan & Fred", 5);
2350    *
2351    * We form the two format strings "%sX%dX" and %sY%sY". The results
2352    * of formatting with those two strings are
2353    *
2354    * "%sX%dX" => "Susan & FredX5X"
2355    * "%sY%dY" => "Susan & FredY5Y"
2356    *
2357    * To find the span of the first argument, we find the first position
2358    * where the two arguments differ, which tells us that the first
2359    * argument formatted to "Susan & Fred". We then escape that
2360    * to "Susan &amp; Fred" and join up with the intermediate portions
2361    * of the format string and the second argument to get
2362    * "Susan &amp; Fred ate 5 apples".
2363    */
2364
2365   /* Create the two modified format strings
2366    */
2367   format1 = g_string_new (NULL);
2368   format2 = g_string_new (NULL);
2369   p = format;
2370   while (TRUE)
2371     {
2372       const char *after;
2373       const char *conv = find_conversion (p, &after);
2374       if (!conv)
2375         break;
2376
2377       g_string_append_len (format1, conv, after - conv);
2378       g_string_append_c (format1, 'X');
2379       g_string_append_len (format2, conv, after - conv);
2380       g_string_append_c (format2, 'Y');
2381
2382       p = after;
2383     }
2384
2385   /* Use them to format the arguments
2386    */
2387   G_VA_COPY (args2, args);
2388
2389   output1 = g_strdup_vprintf (format1->str, args);
2390   if (!output1)
2391     {
2392       va_end (args2);
2393       goto cleanup;
2394     }
2395
2396   output2 = g_strdup_vprintf (format2->str, args2);
2397   va_end (args2);
2398   if (!output2)
2399     goto cleanup;
2400
2401   result = g_string_new (NULL);
2402
2403   /* Iterate through the original format string again,
2404    * copying the non-conversion portions and the escaped
2405    * converted arguments to the output string.
2406    */
2407   op1 = output1;
2408   op2 = output2;
2409   p = format;
2410   while (TRUE)
2411     {
2412       const char *after;
2413       const char *output_start;
2414       const char *conv = find_conversion (p, &after);
2415       char *escaped;
2416
2417       if (!conv)        /* The end, after points to the trailing \0 */
2418         {
2419           g_string_append_len (result, p, after - p);
2420           break;
2421         }
2422
2423       g_string_append_len (result, p, conv - p);
2424       output_start = op1;
2425       while (*op1 == *op2)
2426         {
2427           op1++;
2428           op2++;
2429         }
2430
2431       escaped = g_markup_escape_text (output_start, op1 - output_start);
2432       g_string_append (result, escaped);
2433       g_free (escaped);
2434
2435       p = after;
2436       op1++;
2437       op2++;
2438     }
2439
2440  cleanup:
2441   g_string_free (format1, TRUE);
2442   g_string_free (format2, TRUE);
2443   g_free (output1);
2444   g_free (output2);
2445
2446   if (result)
2447     return g_string_free (result, FALSE);
2448   else
2449     return NULL;
2450 }
2451
2452 /**
2453  * g_markup_printf_escaped:
2454  * @format: printf() style format string
2455  * @...: the arguments to insert in the format string
2456  *
2457  * Formats arguments according to @format, escaping
2458  * all string and character arguments in the fashion
2459  * of g_markup_escape_text(). This is useful when you
2460  * want to insert literal strings into XML-style markup
2461  * output, without having to worry that the strings
2462  * might themselves contain markup.
2463  *
2464  * |[
2465  * const char *store = "Fortnum &amp; Mason";
2466  * const char *item = "Tea";
2467  * char *output;
2468  * &nbsp;
2469  * output = g_markup_printf_escaped ("&lt;purchase&gt;"
2470  *                                   "&lt;store&gt;&percnt;s&lt;/store&gt;"
2471  *                                   "&lt;item&gt;&percnt;s&lt;/item&gt;"
2472  *                                   "&lt;/purchase&gt;",
2473  *                                   store, item);
2474  * ]|
2475  *
2476  * Return value: newly allocated result from formatting
2477  *    operation. Free with g_free().
2478  *
2479  * Since: 2.4
2480  */
2481 gchar *
2482 g_markup_printf_escaped (const gchar *format, ...)
2483 {
2484   char *result;
2485   va_list args;
2486
2487   va_start (args, format);
2488   result = g_markup_vprintf_escaped (format, args);
2489   va_end (args);
2490
2491   return result;
2492 }
2493
2494 static gboolean
2495 g_markup_parse_boolean (const char  *string,
2496                         gboolean    *value)
2497 {
2498   char const * const falses[] = { "false", "f", "no", "n", "0" };
2499   char const * const trues[] = { "true", "t", "yes", "y", "1" };
2500   int i;
2501
2502   for (i = 0; i < G_N_ELEMENTS (falses); i++)
2503     {
2504       if (g_ascii_strcasecmp (string, falses[i]) == 0)
2505         {
2506           if (value != NULL)
2507             *value = FALSE;
2508
2509           return TRUE;
2510         }
2511     }
2512
2513   for (i = 0; i < G_N_ELEMENTS (trues); i++)
2514     {
2515       if (g_ascii_strcasecmp (string, trues[i]) == 0)
2516         {
2517           if (value != NULL)
2518             *value = TRUE;
2519
2520           return TRUE;
2521         }
2522     }
2523
2524   return FALSE;
2525 }
2526
2527 /**
2528  * GMarkupCollectType:
2529  * @G_MARKUP_COLLECT_INVALID: used to terminate the list of attributes
2530  *     to collect
2531  * @G_MARKUP_COLLECT_STRING: collect the string pointer directly from
2532  *     the attribute_values[] array. Expects a parameter of type (const
2533  *     char **). If %G_MARKUP_COLLECT_OPTIONAL is specified and the
2534  *     attribute isn't present then the pointer will be set to %NULL
2535  * @G_MARKUP_COLLECT_STRDUP: as with %G_MARKUP_COLLECT_STRING, but
2536  *     expects a parameter of type (char **) and g_strdup()s the
2537  *     returned pointer. The pointer must be freed with g_free()
2538  * @G_MARKUP_COLLECT_BOOLEAN: expects a parameter of type (gboolean *)
2539  *     and parses the attribute value as a boolean. Sets %FALSE if the
2540  *     attribute isn't present. Valid boolean values consist of
2541  *     (case-insensitive) "false", "f", "no", "n", "0" and "true", "t",
2542  *     "yes", "y", "1"
2543  * @G_MARKUP_COLLECT_TRISTATE: as with %G_MARKUP_COLLECT_BOOLEAN, but
2544  *     in the case of a missing attribute a value is set that compares
2545  *     equal to neither %FALSE nor %TRUE G_MARKUP_COLLECT_OPTIONAL is
2546  *     implied
2547  * @G_MARKUP_COLLECT_OPTIONAL: can be bitwise ORed with the other fields.
2548  *     If present, allows the attribute not to appear. A default value
2549  *     is set depending on what value type is used
2550  *
2551  * A mixed enumerated type and flags field. You must specify one type
2552  * (string, strdup, boolean, tristate).  Additionally, you may  optionally
2553  * bitwise OR the type with the flag %G_MARKUP_COLLECT_OPTIONAL.
2554  *
2555  * It is likely that this enum will be extended in the future to
2556  * support other types.
2557  */
2558
2559 /**
2560  * g_markup_collect_attributes:
2561  * @element_name: the current tag name
2562  * @attribute_names: the attribute names
2563  * @attribute_values: the attribute values
2564  * @error: a pointer to a #GError or %NULL
2565  * @first_type: the #GMarkupCollectType of the first attribute
2566  * @first_attr: the name of the first attribute
2567  * @...: a pointer to the storage location of the first attribute
2568  *     (or %NULL), followed by more types names and pointers, ending
2569  *     with %G_MARKUP_COLLECT_INVALID
2570  *
2571  * Collects the attributes of the element from the data passed to the
2572  * #GMarkupParser start_element function, dealing with common error
2573  * conditions and supporting boolean values.
2574  *
2575  * This utility function is not required to write a parser but can save
2576  * a lot of typing.
2577  *
2578  * The @element_name, @attribute_names, @attribute_values and @error
2579  * parameters passed to the start_element callback should be passed
2580  * unmodified to this function.
2581  *
2582  * Following these arguments is a list of "supported" attributes to collect.
2583  * It is an error to specify multiple attributes with the same name. If any
2584  * attribute not in the list appears in the @attribute_names array then an
2585  * unknown attribute error will result.
2586  *
2587  * The #GMarkupCollectType field allows specifying the type of collection
2588  * to perform and if a given attribute must appear or is optional.
2589  *
2590  * The attribute name is simply the name of the attribute to collect.
2591  *
2592  * The pointer should be of the appropriate type (see the descriptions
2593  * under #GMarkupCollectType) and may be %NULL in case a particular
2594  * attribute is to be allowed but ignored.
2595  *
2596  * This function deals with issuing errors for missing attributes
2597  * (of type %G_MARKUP_ERROR_MISSING_ATTRIBUTE), unknown attributes
2598  * (of type %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE) and duplicate
2599  * attributes (of type %G_MARKUP_ERROR_INVALID_CONTENT) as well
2600  * as parse errors for boolean-valued attributes (again of type
2601  * %G_MARKUP_ERROR_INVALID_CONTENT). In all of these cases %FALSE
2602  * will be returned and @error will be set as appropriate.
2603  *
2604  * Return value: %TRUE if successful
2605  *
2606  * Since: 2.16
2607  **/
2608 gboolean
2609 g_markup_collect_attributes (const gchar         *element_name,
2610                              const gchar        **attribute_names,
2611                              const gchar        **attribute_values,
2612                              GError             **error,
2613                              GMarkupCollectType   first_type,
2614                              const gchar         *first_attr,
2615                              ...)
2616 {
2617   GMarkupCollectType type;
2618   const gchar *attr;
2619   guint64 collected;
2620   int written;
2621   va_list ap;
2622   int i;
2623
2624   type = first_type;
2625   attr = first_attr;
2626   collected = 0;
2627   written = 0;
2628
2629   va_start (ap, first_attr);
2630   while (type != G_MARKUP_COLLECT_INVALID)
2631     {
2632       gboolean mandatory;
2633       const gchar *value;
2634
2635       mandatory = !(type & G_MARKUP_COLLECT_OPTIONAL);
2636       type &= (G_MARKUP_COLLECT_OPTIONAL - 1);
2637
2638       /* tristate records a value != TRUE and != FALSE
2639        * for the case where the attribute is missing
2640        */
2641       if (type == G_MARKUP_COLLECT_TRISTATE)
2642         mandatory = FALSE;
2643
2644       for (i = 0; attribute_names[i]; i++)
2645         if (i >= 40 || !(collected & (G_GUINT64_CONSTANT(1) << i)))
2646           if (!strcmp (attribute_names[i], attr))
2647             break;
2648
2649       /* ISO C99 only promises that the user can pass up to 127 arguments.
2650        * Subtracting the first 4 arguments plus the final NULL and dividing
2651        * by 3 arguments per collected attribute, we are left with a maximum
2652        * number of supported attributes of (127 - 5) / 3 = 40.
2653        *
2654        * In reality, nobody is ever going to call us with anywhere close to
2655        * 40 attributes to collect, so it is safe to assume that if i > 40
2656        * then the user has given some invalid or repeated arguments.  These
2657        * problems will be caught and reported at the end of the function.
2658        *
2659        * We know at this point that we have an error, but we don't know
2660        * what error it is, so just continue...
2661        */
2662       if (i < 40)
2663         collected |= (G_GUINT64_CONSTANT(1) << i);
2664
2665       value = attribute_values[i];
2666
2667       if (value == NULL && mandatory)
2668         {
2669           g_set_error (error, G_MARKUP_ERROR,
2670                        G_MARKUP_ERROR_MISSING_ATTRIBUTE,
2671                        "element '%s' requires attribute '%s'",
2672                        element_name, attr);
2673
2674           va_end (ap);
2675           goto failure;
2676         }
2677
2678       switch (type)
2679         {
2680         case G_MARKUP_COLLECT_STRING:
2681           {
2682             const char **str_ptr;
2683
2684             str_ptr = va_arg (ap, const char **);
2685
2686             if (str_ptr != NULL)
2687               *str_ptr = value;
2688           }
2689           break;
2690
2691         case G_MARKUP_COLLECT_STRDUP:
2692           {
2693             char **str_ptr;
2694
2695             str_ptr = va_arg (ap, char **);
2696
2697             if (str_ptr != NULL)
2698               *str_ptr = g_strdup (value);
2699           }
2700           break;
2701
2702         case G_MARKUP_COLLECT_BOOLEAN:
2703         case G_MARKUP_COLLECT_TRISTATE:
2704           if (value == NULL)
2705             {
2706               gboolean *bool_ptr;
2707
2708               bool_ptr = va_arg (ap, gboolean *);
2709
2710               if (bool_ptr != NULL)
2711                 {
2712                   if (type == G_MARKUP_COLLECT_TRISTATE)
2713                     /* constructivists rejoice!
2714                      * neither false nor true...
2715                      */
2716                     *bool_ptr = -1;
2717
2718                   else /* G_MARKUP_COLLECT_BOOLEAN */
2719                     *bool_ptr = FALSE;
2720                 }
2721             }
2722           else
2723             {
2724               if (!g_markup_parse_boolean (value, va_arg (ap, gboolean *)))
2725                 {
2726                   g_set_error (error, G_MARKUP_ERROR,
2727                                G_MARKUP_ERROR_INVALID_CONTENT,
2728                                "element '%s', attribute '%s', value '%s' "
2729                                "cannot be parsed as a boolean value",
2730                                element_name, attr, value);
2731
2732                   va_end (ap);
2733                   goto failure;
2734                 }
2735             }
2736
2737           break;
2738
2739         default:
2740           g_assert_not_reached ();
2741         }
2742
2743       type = va_arg (ap, GMarkupCollectType);
2744       attr = va_arg (ap, const char *);
2745       written++;
2746     }
2747   va_end (ap);
2748
2749   /* ensure we collected all the arguments */
2750   for (i = 0; attribute_names[i]; i++)
2751     if ((collected & (G_GUINT64_CONSTANT(1) << i)) == 0)
2752       {
2753         /* attribute not collected:  could be caused by two things.
2754          *
2755          * 1) it doesn't exist in our list of attributes
2756          * 2) it existed but was matched by a duplicate attribute earlier
2757          *
2758          * find out.
2759          */
2760         int j;
2761
2762         for (j = 0; j < i; j++)
2763           if (strcmp (attribute_names[i], attribute_names[j]) == 0)
2764             /* duplicate! */
2765             break;
2766
2767         /* j is now the first occurrence of attribute_names[i] */
2768         if (i == j)
2769           g_set_error (error, G_MARKUP_ERROR,
2770                        G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
2771                        "attribute '%s' invalid for element '%s'",
2772                        attribute_names[i], element_name);
2773         else
2774           g_set_error (error, G_MARKUP_ERROR,
2775                        G_MARKUP_ERROR_INVALID_CONTENT,
2776                        "attribute '%s' given multiple times for element '%s'",
2777                        attribute_names[i], element_name);
2778
2779         goto failure;
2780       }
2781
2782   return TRUE;
2783
2784 failure:
2785   /* replay the above to free allocations */
2786   type = first_type;
2787   attr = first_attr;
2788
2789   va_start (ap, first_attr);
2790   while (type != G_MARKUP_COLLECT_INVALID)
2791     {
2792       gpointer ptr;
2793
2794       ptr = va_arg (ap, gpointer);
2795
2796       if (ptr != NULL)
2797         {
2798           switch (type & (G_MARKUP_COLLECT_OPTIONAL - 1))
2799             {
2800             case G_MARKUP_COLLECT_STRDUP:
2801               if (written)
2802                 g_free (*(char **) ptr);
2803
2804             case G_MARKUP_COLLECT_STRING:
2805               *(char **) ptr = NULL;
2806               break;
2807
2808             case G_MARKUP_COLLECT_BOOLEAN:
2809               *(gboolean *) ptr = FALSE;
2810               break;
2811
2812             case G_MARKUP_COLLECT_TRISTATE:
2813               *(gboolean *) ptr = -1;
2814               break;
2815             }
2816         }
2817
2818       type = va_arg (ap, GMarkupCollectType);
2819       attr = va_arg (ap, const char *);
2820     }
2821   va_end (ap);
2822
2823   return FALSE;
2824 }