sherlock/xml/parse.c

   1 /*
   2  *      Sherlock Library -- A simple XML parser
   3  *
   4  *      (c) 2007--2008 Pavel Charvat <pchar@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #undef LOCAL_DEBUG
  11
  12 #include "sherlock/sherlock.h"
  13 #include "sherlock/xml/xml.h"
  14 #include "sherlock/xml/dtd.h"
  15 #include "sherlock/xml/internals.h"
  16 #include "lib/fastbuf.h"
  17 #include "lib/ff-unicode.h"
  18 #include "lib/unicode.h"
  19 #include "lib/chartype.h"
  20 #include "lib/hashfunc.h"
  21
  22 #include <setjmp.h>
  23
  24 /*** Basic parsing ***/
  25
  26 void NONRET
  27 xml_fatal_expected(struct xml_context *ctx, uns c)
  28 {
  29   if (c >= 32 && c < 128)
  30     xml_fatal(ctx, "Expected '%c'", c);
  31   else
  32     xml_fatal(ctx, "Expected U+%04x", c);
  33 }
  34
  35 void NONRET
  36 xml_fatal_expected_white(struct xml_context *ctx)
  37 {
  38   xml_fatal(ctx, "Expected a white space");
  39 }
  40
  41 void NONRET
  42 xml_fatal_expected_quot(struct xml_context *ctx)
  43 {
  44   xml_fatal(ctx, "Expected a quotation mark");
  45 }
  46
  47 void
  48 xml_parse_eq(struct xml_context *ctx)
  49 {
  50   /* Eq ::= S? '=' S? */
  51   xml_parse_white(ctx, 0);
  52   xml_parse_char(ctx, '=');
  53   xml_parse_white(ctx, 0);
  54 }
  55
  56 /*** Names and nmtokens ***/
  57
  58 static char *
  59 xml_parse_string(struct xml_context *ctx, struct mempool *pool, uns first_cat, uns next_cat, char *err)
  60 {
  61   char *p = mp_start_noalign(pool, 1);
  62   if (unlikely(!(xml_peek_cat(ctx) & first_cat)))
  63     xml_fatal(ctx, "%s", err);
  64   do
  65     {
  66       p = mp_spread(pool, p, 5);
  67       p = utf8_32_put(p, xml_skip_char(ctx));
  68     }
  69   while (xml_peek_cat(ctx) & next_cat);
  70   *p++ = 0;
  71   return mp_end(pool, p);
  72 }
  73
  74 static void
  75 xml_skip_string(struct xml_context *ctx, uns first_cat, uns next_cat, char *err)
  76 {
  77   if (unlikely(!(xml_get_cat(ctx) & first_cat)))
  78     xml_fatal(ctx, "%s", err);
  79   while (xml_peek_cat(ctx) & next_cat)
  80     xml_skip_char(ctx);
  81 }
  82
  83 char *
  84 xml_parse_name(struct xml_context *ctx, struct mempool *pool)
  85 {
  86   /* Name ::= NameStartChar (NameChar)* */
  87   return xml_parse_string(ctx, pool, ctx->cat_sname, ctx->cat_name, "Expected a name");
  88 }
  89
  90 void
  91 xml_skip_name(struct xml_context *ctx)
  92 {
  93   xml_skip_string(ctx, ctx->cat_sname, ctx->cat_name, "Expected a name");
  94 }
  95
  96 char *
  97 xml_parse_nmtoken(struct xml_context *ctx, struct mempool *pool)
  98 {
  99   /* Nmtoken ::= (NameChar)+ */
 100   return xml_parse_string(ctx, pool, ctx->cat_name, ctx->cat_name, "Expected a nmtoken");
 101 }
 102
 103 /*** Simple literals ***/
 104
 105 char *
 106 xml_parse_system_literal(struct xml_context *ctx, struct mempool *pool)
 107 {
 108   /* SystemLiteral ::= ('"' [^"]* '"') | ("'" [^']* "'") */
 109   char *p = mp_start_noalign(pool, 1);
 110   uns q = xml_parse_quote(ctx), c;
 111   while ((c = xml_get_char(ctx)) != q)
 112     {
 113       p = mp_spread(pool, p, 5);
 114       p = utf8_32_put(p, c);
 115     }
 116   *p++ = 0;
 117   return mp_end(pool, p);
 118 }
 119
 120 char *
 121 xml_parse_pubid_literal(struct xml_context *ctx, struct mempool *pool)
 122 {
 123   /* PubidLiteral ::= '"' PubidChar* '"' | "'" (PubidChar - "'")* "'" */
 124   char *p = mp_start_noalign(pool, 1);
 125   uns q = xml_parse_quote(ctx), c;
 126   while ((c = xml_get_char(ctx)) != q)
 127     {
 128       if (unlikely(!(xml_last_cat(ctx) & XML_CHAR_PUBID)))
 129         xml_fatal(ctx, "Expected a pubid character");
 130       p = mp_spread(pool, p, 2);
 131       *p++ = c;
 132     }
 133   *p++ = 0;
 134   return mp_end(pool, p);
 135 }
 136
 137 /*** Comments ***/
 138
 139 void
 140 xml_push_comment(struct xml_context *ctx)
 141 {
 142   TRACE(ctx, "push_comment");
 143   /* Comment ::= '<!--' ((Char - '-') | ('-' (Char - '-')))* '-->'
 144    * Already parsed: '<!-' */
 145   xml_parse_char(ctx, '-');
 146   struct xml_node *n = xml_push_dom(ctx, NULL);
 147   n->type = XML_NODE_COMMENT;
 148   char *p = mp_start_noalign(ctx->pool, 6);
 149   while (1)
 150     {
 151       if (xml_get_char(ctx) == '-')
 152         if (xml_get_char(ctx) == '-')
 153           break;
 154         else
 155           *p++ = '-';
 156       p = utf8_32_put(p, xml_last_char(ctx));
 157       p = mp_spread(ctx->pool, p, 6);
 158     }
 159   xml_parse_char(ctx, '>');
 160   *p = 0;
 161   n->len = p - (char *)mp_ptr(ctx->pool);
 162   n->text = mp_end(ctx->pool, p + 1);
 163   if ((ctx->flags & XML_REPORT_COMMENTS) && ctx->h_comment)
 164     ctx->h_comment(ctx);
 165 }
 166
 167 void
 168 xml_pop_comment(struct xml_context *ctx)
 169 {
 170   xml_pop_dom(ctx, !(ctx->flags & XML_ALLOC_COMMENTS));
 171   xml_dec(ctx);
 172   TRACE(ctx, "pop_comment");
 173 }
 174
 175 void
 176 xml_skip_comment(struct xml_context *ctx)
 177 {
 178   TRACE(ctx, "skip_comment");
 179   xml_parse_char(ctx, '-');
 180   while (xml_get_char(ctx) != '-' || xml_get_char(ctx) != '-');
 181   xml_parse_char(ctx, '>');
 182   xml_dec(ctx);
 183 }
 184
 185 /*** Processing instructions ***/
 186
 187 void
 188 xml_push_pi(struct xml_context *ctx)
 189 {
 190   TRACE(ctx, "push_pi");
 191   /* Parses a PI to ctx->value and ctx->name:
 192    *   PI ::= '<?' PITarget (S (Char* - (Char* '?>' Char*)))? '?>'
 193    *   PITarget ::= Name - (('X' | 'x') ('M' | 'm') ('L' | 'l'))
 194    * Already parsed: '<?' */
 195   struct xml_node *n = xml_push_dom(ctx, NULL);
 196   n->type = XML_NODE_PI;
 197   n->name = xml_parse_name(ctx, ctx->pool);
 198   if (unlikely(!strcasecmp(n->name, "xml")))
 199     xml_error(ctx, "Reserved PI target");
 200   char *p = mp_start_noalign(ctx->pool, 5);
 201   if (!xml_parse_white(ctx, 0))
 202     xml_parse_seq(ctx, "?>");
 203   else
 204     while (1)
 205       {
 206         if (xml_get_char(ctx) == '?')
 207           if (xml_peek_char(ctx) == '>')
 208             {
 209               xml_skip_char(ctx);
 210               break;
 211             }
 212           else
 213             *p++ = '?';
 214         else
 215           p = utf8_32_put(p, xml_last_char(ctx));
 216         p = mp_spread(ctx->pool, p, 5);
 217       }
 218   *p = 0;
 219   n->len = p - (char *)mp_ptr(ctx->pool);
 220   n->text = mp_end(ctx->pool, p + 1);
 221   if ((ctx->flags & XML_REPORT_PIS) && ctx->h_pi)
 222     ctx->h_pi(ctx);
 223 }
 224
 225 void
 226 xml_pop_pi(struct xml_context *ctx)
 227 {
 228   xml_pop_dom(ctx, !(ctx->flags & XML_ALLOC_PIS));
 229   xml_dec(ctx);
 230   TRACE(ctx, "pop_pi");
 231 }
 232
 233 void
 234 xml_skip_pi(struct xml_context *ctx)
 235 {
 236   TRACE(ctx, "skip_pi");
 237   if (ctx->flags & XML_VALIDATING)
 238     {
 239       struct mempool_state state;
 240       mp_save(ctx->stack, &state);
 241       if (unlikely(!strcasecmp(xml_parse_name(ctx, ctx->stack), "xml")))
 242         xml_error(ctx, "Reserved PI target");
 243       mp_restore(ctx->stack, &state);
 244       if (!xml_parse_white(ctx, 0))
 245         {
 246           xml_parse_seq(ctx, "?>");
 247           xml_dec(ctx);
 248           return;
 249         }
 250     }
 251   while (1)
 252     if (xml_get_char(ctx) == '?')
 253       if (xml_peek_char(ctx) == '>')
 254         break;
 255   xml_skip_char(ctx);
 256   xml_dec(ctx);
 257 }
 258
 259 /*** Character references ***/
 260
 261 uns
 262 xml_parse_char_ref(struct xml_context *ctx)
 263 {
 264   TRACE(ctx, "parse_char_ref");
 265   /* CharRef ::= '&#' [0-9]+ ';' | '&#x' [0-9a-fA-F]+ ';'
 266    * Already parsed: '&#' */
 267   uns v = 0;
 268   if (xml_get_char(ctx) == 'x')
 269     {
 270       if (!(xml_get_cat(ctx) & XML_CHAR_XDIGIT))
 271         {
 272           xml_error(ctx, "Expected a hexadecimal value of character reference");
 273           goto recover;
 274         }
 275       do
 276         {
 277           v = (v << 4) + Cxvalue(xml_last_char(ctx));
 278         }
 279       while (v < 0x110000 && (xml_get_cat(ctx) & XML_CHAR_XDIGIT));
 280     }
 281   else
 282     {
 283       if (!(xml_last_cat(ctx) & XML_CHAR_DIGIT))
 284         {
 285           xml_error(ctx, "Expected a numeric value of character reference");
 286           goto recover;
 287         }
 288       do
 289         {
 290           v = v * 10 + xml_last_char(ctx) - '0';
 291         }
 292       while (v < 0x110000 && (xml_get_cat(ctx) & XML_CHAR_DIGIT));
 293     }
 294   uns cat = xml_char_cat(v);
 295   if (!(cat & ctx->cat_unrestricted))
 296     {
 297       xml_error(ctx, "Character reference out of range");
 298       goto recover;
 299     }
 300   if (xml_last_char(ctx) == ';')
 301     {
 302       xml_dec(ctx);
 303       return v;
 304     }
 305   xml_error(ctx, "Expected ';'");
 306 recover:
 307   while (xml_last_char(ctx) != ';')
 308     xml_get_char(ctx);
 309   xml_dec(ctx);
 310   return UNI_REPLACEMENT;
 311 }
 312
 313 /*** References to general entities ***/
 314
 315 static void
 316 xml_parse_ref(struct xml_context *ctx)
 317 {
 318   /* Reference ::= EntityRef | CharRef
 319    * EntityRef ::= '&' Name ';'
 320    * Already parsed: '&' */
 321   struct fastbuf *out = &ctx->chars;
 322   if (xml_peek_char(ctx) == '#')
 323     {
 324       xml_skip_char(ctx);
 325       bput_utf8_32(out, xml_parse_char_ref(ctx));
 326     }
 327   else
 328     {
 329       TRACE(ctx, "parse_ge_ref");
 330       struct mempool_state state;
 331       mp_save(ctx->stack, &state);
 332       char *name = xml_parse_name(ctx, ctx->stack);
 333       xml_parse_char(ctx, ';');
 334       struct xml_dtd_entity *ent = xml_dtd_find_entity(ctx, name);
 335       if (!ent)
 336         {
 337           xml_error(ctx, "Unknown entity &%s;", name);
 338           bputc(out, '&');
 339           bputs(out, name);
 340           bputc(out, ';');
 341         }
 342       else if (ent->flags & XML_DTD_ENTITY_TRIVIAL)
 343         {
 344           TRACE(ctx, "Trivial entity &%s;", name);
 345           bputs(out, ent->text);
 346         }
 347       else
 348         {
 349           TRACE(ctx, "Pushed entity &%s;", name);
 350           mp_restore(ctx->stack, &state);
 351           xml_dec(ctx);
 352           xml_push_entity(ctx, ent);
 353           return;
 354         }
 355       mp_restore(ctx->stack, &state);
 356       xml_dec(ctx);
 357     }
 358 }
 359
 360 /*** Character data ***/
 361
 362 void
 363 xml_spout_chars(struct fastbuf *fb)
 364 {
 365   if (fb->bptr < fb->bufend)
 366     return;
 367   struct xml_context *ctx = SKIP_BACK(struct xml_context, chars, fb);
 368   struct mempool *pool = ctx->pool;
 369   if (fb->bufend != fb->buffer)
 370     {
 371       TRACE(ctx, "growing chars");
 372       uns len = fb->bufend - fb->buffer;
 373       uns reported = fb->bstop - fb->buffer;
 374       fb->buffer = mp_expand(pool);
 375       fb->bufend = fb->buffer + mp_avail(pool);
 376       fb->bptr = fb->buffer + len;
 377       fb->bstop = fb->buffer + reported;
 378     }
 379   else
 380     {
 381       TRACE(ctx, "starting chars");
 382       mp_save(pool, &ctx->chars_state);
 383       fb->bptr = fb->buffer = fb->bstop = mp_start_noalign(pool, 2);
 384       fb->bufend = fb->buffer + mp_avail(pool) - 1;
 385     }
 386 }
 387
 388 static inline uns
 389 xml_end_chars(struct xml_context *ctx, char **out)
 390 {
 391   struct fastbuf *fb = &ctx->chars;
 392   uns len = fb->bptr - fb->buffer;
 393   if (len)
 394     {
 395       TRACE(ctx, "ending chars");
 396       *fb->bptr = 0;
 397       *out = mp_end(ctx->pool, fb->bptr + 1);
 398       fb->bufend = fb->bstop = fb->bptr = fb->buffer;
 399     }
 400   return len;
 401 }
 402
 403 static inline uns
 404 xml_report_chars(struct xml_context *ctx, char **out)
 405 {
 406   struct fastbuf *fb = &ctx->chars;
 407   uns len = fb->bptr - fb->buffer;
 408   if (len)
 409     {
 410       *fb->bptr = 0;
 411       *out = fb->bstop;
 412       fb->bstop = fb->bptr;
 413     }
 414   return len;
 415 }
 416
 417 static inline uns
 418 xml_flush_chars(struct xml_context *ctx)
 419 {
 420   char *text, *rtext;
 421   uns len = xml_end_chars(ctx, &text), rlen;
 422   if (len)
 423     {
 424       if (ctx->flags & XML_NO_CHARS)
 425         {
 426           if ((ctx->flags & XML_REPORT_CHARS) && ctx->h_ignorable)
 427             ctx->h_ignorable(ctx, text, len);
 428           mp_restore(ctx->pool, &ctx->chars_state);
 429           return 0;
 430         }
 431       if ((ctx->flags & XML_REPORT_CHARS) && ctx->h_block && (rlen = xml_report_chars(ctx, &rtext)))
 432         ctx->h_block(ctx, rtext, rlen);
 433       if (!(ctx->flags & XML_ALLOC_CHARS) && !(ctx->flags & XML_REPORT_CHARS))
 434         {
 435           mp_restore(ctx->pool, &ctx->chars_state);
 436           return 0;
 437         }
 438       struct xml_node *n = xml_push_dom(ctx, &ctx->chars_state);
 439       n->type = XML_NODE_CHARS;
 440       n->text = text;
 441       n->len = len;
 442       if ((ctx->flags & XML_REPORT_CHARS) && ctx->h_chars)
 443         ctx->h_chars(ctx);
 444     }
 445   return len;
 446 }
 447
 448 static inline void
 449 xml_pop_chars(struct xml_context *ctx)
 450 {
 451   xml_pop_dom(ctx, !(ctx->flags & XML_ALLOC_CHARS));
 452   TRACE(ctx, "pop_chars");
 453 }
 454
 455 static inline void
 456 xml_append_chars(struct xml_context *ctx)
 457 {
 458   TRACE(ctx, "append_chars");
 459   struct fastbuf *out = &ctx->chars;
 460   if (ctx->flags & XML_NO_CHARS)
 461     while (xml_get_char(ctx) != '<')
 462       if (xml_last_cat(ctx) & XML_CHAR_WHITE)
 463         bput_utf8_32(out, xml_last_char(ctx));
 464       else
 465         {
 466           xml_error(ctx, "This element must not contain character data");
 467           while (xml_get_char(ctx) != '<');
 468           break;
 469         }
 470   else
 471     while (xml_get_char(ctx) != '<')
 472       if (xml_last_char(ctx) == '&')
 473         {
 474           xml_inc(ctx);
 475           xml_parse_ref(ctx);
 476         }
 477       else
 478         bput_utf8_32(out, xml_last_char(ctx));
 479   xml_unget_char(ctx);
 480 }
 481
 482 /*** CDATA sections ***/
 483
 484 static void
 485 xml_skip_cdata(struct xml_context *ctx)
 486 {
 487   TRACE(ctx, "skip_cdata");
 488   xml_parse_seq(ctx, "CDATA[");
 489   while (xml_get_char(ctx) != ']' || xml_get_char(ctx) != ']' || xml_get_char(ctx) != '>');
 490   xml_dec(ctx);
 491 }
 492
 493 static void
 494 xml_append_cdata(struct xml_context *ctx)
 495 {
 496   /* CDSect :== '<![CDATA[' (Char* - (Char* ']]>' Char*)) ']]>'
 497    * Already parsed: '<![' */
 498   TRACE(ctx, "append_cdata");
 499   if (ctx->flags & XML_NO_CHARS)
 500     {
 501       xml_error(ctx, "This element must not contain CDATA");
 502       xml_skip_cdata(ctx);
 503       return;
 504     }
 505   xml_parse_seq(ctx, "CDATA[");
 506   struct fastbuf *out = &ctx->chars;
 507   uns rlen;
 508   char *rtext;
 509   if ((ctx->flags & XML_REPORT_CHARS) && ctx->h_block && (rlen = xml_report_chars(ctx, &rtext)))
 510     ctx->h_block(ctx, rtext, rlen);
 511   while (1)
 512     {
 513       if (xml_get_char(ctx) == ']')
 514         {
 515           if (xml_get_char(ctx) == ']')
 516             if (xml_get_char(ctx) == '>')
 517               break;
 518             else
 519               bputc(out, ']');
 520           bputc(out, ']');
 521         }
 522       bput_utf8_32(out, xml_last_char(ctx));
 523     }
 524   if ((ctx->flags & XML_REPORT_CHARS) && ctx->h_cdata && (rlen = xml_report_chars(ctx, &rtext)))
 525     ctx->h_cdata(ctx, rtext, rlen);
 526   xml_dec(ctx);
 527 }
 528
 529 /*** Attribute values ***/
 530
 531 char *
 532 xml_parse_attr_value(struct xml_context *ctx, struct xml_dtd_attr *attr UNUSED)
 533 {
 534   TRACE(ctx, "parse_attr_value");
 535   /* AttValue ::= '"' ([^<&"] | Reference)* '"' | "'" ([^<&'] | Reference)* "'" */
 536   /* FIXME: -- check value constrains / normalize leading/trailing WS and repeated WS */
 537   struct mempool_state state;
 538   uns quote = xml_parse_quote(ctx);
 539   mp_save(ctx->stack, &state);
 540   struct fastbuf *out = &ctx->chars;
 541   struct xml_source *src = ctx->src;
 542   while (1)
 543     {
 544       uns c = xml_get_char(ctx);
 545       if (c == '&')
 546         {
 547           xml_inc(ctx);
 548           xml_parse_ref(ctx);
 549         }
 550       else if (c == quote && src == ctx->src)
 551         break;
 552       else if (c == '<')
 553         xml_error(ctx, "Attribute value must not contain '<'");
 554       else if (xml_last_cat(ctx) & XML_CHAR_WHITE)
 555         bputc(out, ' ');
 556       else
 557         bput_utf8_32(out, c);
 558     }
 559   mp_restore(ctx->stack, &state);
 560   char *text;
 561   return xml_end_chars(ctx, &text) ? text : "";
 562 }
 563
 564 uns
 565 xml_normalize_white(struct xml_context *ctx UNUSED, char *text)
 566 {
 567   char *s = text, *d = text;
 568   while (*s == 0x20)
 569     s++;
 570   while (1)
 571     {
 572       while (*s & ~0x20)
 573         *d++ = *s++;
 574       if (!*s)
 575         break;
 576       while (*++s == 0x20);
 577       *d++ = 0x20;
 578     }
 579   if (d != text && d[-1] == 0x20)
 580     d--;
 581   *d = 0;
 582   return d - text;
 583 }
 584
 585 /*** Attributes ***/
 586
 587 struct xml_attrs_table;
 588
 589 static inline uns
 590 xml_attrs_hash(struct xml_attrs_table *t UNUSED, struct xml_node *e, char *n)
 591 {
 592   return hash_pointer(e) ^ hash_string(n);
 593 }
 594
 595 static inline int
 596 xml_attrs_eq(struct xml_attrs_table *t UNUSED, struct xml_node *e1, char *n1, struct xml_node *e2, char *n2)
 597 {
 598   return (e1 == e2) && !strcmp(n1, n2);
 599 }
 600
 601 static inline void
 602 xml_attrs_init_key(struct xml_attrs_table *t UNUSED, struct xml_attr *a, struct xml_node *e, char *name)
 603 {
 604   a->elem = e;
 605   a->name = name;
 606   a->val = NULL;
 607   a->user = NULL;
 608   slist_add_tail(&e->attrs, &a->n);
 609 }
 610
 611 #define HASH_PREFIX(x) xml_attrs_##x
 612 #define HASH_NODE struct xml_attr
 613 #define HASH_KEY_COMPLEX(x) x elem, x name
 614 #define HASH_KEY_DECL struct xml_node *elem, char *name
 615 #define HASH_TABLE_DYNAMIC
 616 #define HASH_GIVE_EQ
 617 #define HASH_GIVE_HASHFN
 618 #define HASH_GIVE_INIT_KEY
 619 #define HASH_WANT_CLEANUP
 620 #define HASH_WANT_REMOVE
 621 #define HASH_WANT_LOOKUP
 622 #define HASH_WANT_FIND
 623 #define HASH_GIVE_ALLOC
 624 XML_HASH_GIVE_ALLOC
 625 #include "lib/hashtable.h"
 626
 627 static void
 628 xml_parse_attr(struct xml_context *ctx)
 629 {
 630   TRACE(ctx, "parse_attr");
 631   /* Attribute ::= Name Eq AttValue */
 632   struct xml_node *e = ctx->node;
 633   char *n = xml_parse_name(ctx, ctx->pool);
 634   struct xml_attr *a = xml_attrs_lookup(ctx->tab_attrs, e, n);
 635   xml_parse_eq(ctx);
 636   char *v = xml_parse_attr_value(ctx, NULL);
 637   if (a->val)
 638     {
 639       xml_error(ctx, "Attribute %s is not unique in element <%s>", n, e->name);
 640       return;
 641     }
 642   a->val = v;
 643   if (!e->dtd)
 644     a->dtd = NULL;
 645   else if (!(a->dtd = xml_dtd_find_attr(ctx, e->dtd, a->name)))
 646     xml_error(ctx, "Undefined attribute %s in element <%s>", n, e->name);
 647   else
 648     xml_validate_attr(ctx, a->dtd, a->val);
 649 }
 650
 651 struct xml_attr *
 652 xml_attr_find(struct xml_context *ctx, struct xml_node *node, char *name)
 653 {
 654   return xml_attrs_find(ctx->tab_attrs, node, name);
 655 }
 656
 657 void
 658 xml_attrs_table_init(struct xml_context *ctx)
 659 {
 660   xml_attrs_init(ctx->tab_attrs = xml_hash_new(ctx->pool, sizeof(struct xml_attrs_table)));
 661 }
 662
 663 void
 664 xml_attrs_table_cleanup(struct xml_context *ctx)
 665 {
 666   xml_attrs_cleanup(ctx->tab_attrs);
 667 }
 668
 669 /*** Elements ***/
 670
 671 static void
 672 xml_push_element(struct xml_context *ctx)
 673 {
 674   TRACE(ctx, "push_element");
 675   /* EmptyElemTag | STag
 676    * EmptyElemTag ::= '<' Name (S  Attribute)* S? '/>'
 677    * STag ::= '<' Name (S  Attribute)* S? '>'
 678    * Already parsed: '<' */
 679   struct xml_node *e = xml_push_dom(ctx, NULL);
 680   clist_init(&e->sons);
 681   e->type = XML_NODE_ELEM;
 682   e->name = xml_parse_name(ctx, ctx->pool);
 683   slist_init(&e->attrs);
 684   if (!e->parent)
 685     {
 686       ctx->dom = e;
 687       if (ctx->doctype && strcmp(e->name, ctx->doctype))
 688         xml_error(ctx, "The root element <%s> does not match the document type <%s>", e->name, ctx->doctype);
 689     }
 690   if (!ctx->dtd)
 691     e->dtd = NULL;
 692   else if (!(e->dtd = xml_dtd_find_elem(ctx, e->name)))
 693     xml_error(ctx, "Undefined element <%s>", e->name);
 694   else
 695     {
 696       if (e->dtd->type == XML_DTD_ELEM_MIXED)
 697         ctx->flags &= ~XML_NO_CHARS;
 698       else
 699         ctx->flags |= XML_NO_CHARS;
 700
 701       // FIXME: validate regular expressions
 702     }
 703   while (1)
 704     {
 705       uns white = xml_parse_white(ctx, 0);
 706       uns c = xml_get_char(ctx);
 707       if (c == '/')
 708         {
 709           xml_parse_char(ctx, '>');
 710           ctx->flags |= XML_EMPTY_ELEM_TAG;
 711           break;
 712         }
 713       else if (c == '>')
 714         break;
 715       else if (!white)
 716         xml_fatal_expected_white(ctx);
 717       xml_unget_char(ctx);
 718       xml_parse_attr(ctx);
 719     }
 720   if ((ctx->flags & XML_REPORT_TAGS) && ctx->h_stag)
 721     ctx->h_stag(ctx);
 722 }
 723
 724 static void
 725 xml_pop_element(struct xml_context *ctx)
 726 {
 727   TRACE(ctx, "pop_element");
 728   if ((ctx->flags & XML_REPORT_TAGS) && ctx->h_etag)
 729     ctx->h_etag(ctx);
 730   struct xml_node *e = ctx->node;
 731   uns free = !(ctx->flags & XML_ALLOC_TAGS);
 732   if (free)
 733     {
 734       if (!e->parent)
 735         ctx->dom = NULL;
 736       /* Restore hash table of attributes */
 737       SLIST_FOR_EACH(struct xml_attr *, a, e->attrs)
 738         xml_attrs_remove(ctx->tab_attrs, a);
 739       struct xml_node *n;
 740       while (n = clist_head(&e->sons))
 741         {
 742           if (n->type == XML_NODE_ELEM)
 743             {
 744               SLIST_FOR_EACH(struct xml_attr *, a, n->attrs)
 745                 xml_attrs_remove(ctx->tab_attrs, a);
 746               clist_insert_list_after(&n->sons, &n->n);
 747             }
 748           clist_remove(&n->n);
 749         }
 750     }
 751   xml_pop_dom(ctx, free);
 752   xml_dec(ctx);
 753 }
 754
 755 static void
 756 xml_parse_etag(struct xml_context *ctx)
 757 {
 758  /* ETag ::= '</' Name S? '>'
 759   * Already parsed: '<' */
 760   struct xml_node *e = ctx->node;
 761   ASSERT(e);
 762   char *n = e->name;
 763   while (*n)
 764     {
 765       uns c;
 766       n = utf8_32_get(n, &c);
 767       if (xml_get_char(ctx) != c)
 768         goto recover;
 769     }
 770   xml_parse_white(ctx, 0);
 771   if (xml_get_char(ctx) != '>')
 772     {
 773 recover:
 774       xml_error(ctx, "Invalid ETag, expected </%s>", e->name);
 775       while (xml_get_char(ctx) != '>');
 776     }
 777   xml_dec(ctx);
 778 }
 779
 780 /*** Document type declaration ***/
 781
 782 static void
 783 xml_parse_doctype_decl(struct xml_context *ctx)
 784 {
 785   TRACE(ctx, "parse_doctype_decl");
 786   /* doctypedecl ::= '<!DOCTYPE' S  Name (S  ExternalID)? S? ('[' intSubset ']' S?)? '>'
 787    * Already parsed: '<!'
 788    * Terminated before '[' or '>' */
 789   if (ctx->doctype)
 790     xml_fatal(ctx, "Multiple document types not allowed");
 791   xml_parse_seq(ctx, "DOCTYPE");
 792   xml_parse_white(ctx, 1);
 793   ctx->doctype = xml_parse_name(ctx, ctx->pool);
 794   TRACE(ctx, "doctype=%s", ctx->doctype);
 795   uns c;
 796   if (xml_parse_white(ctx, 0) && ((c = xml_peek_char(ctx)) == 'S' || c == 'P'))
 797     {
 798       if (c == 'S')
 799         {
 800           xml_parse_seq(ctx, "SYSTEM");
 801           xml_parse_white(ctx, 1);
 802           ctx->system_id = xml_parse_system_literal(ctx, ctx->pool);
 803         }
 804       else
 805         {
 806           xml_parse_seq(ctx, "PUBLIC");
 807           xml_parse_white(ctx, 1);
 808           ctx->public_id = xml_parse_pubid_literal(ctx, ctx->pool);
 809           xml_parse_white(ctx, 1);
 810           ctx->system_id = xml_parse_system_literal(ctx, ctx->pool);
 811         }
 812       xml_parse_white(ctx, 0);
 813       ctx->flags |= XML_HAS_EXTERNAL_SUBSET;
 814     }
 815   if (xml_peek_char(ctx) == '[')
 816     ctx->flags |= XML_HAS_INTERNAL_SUBSET;
 817   if (ctx->h_doctype_decl)
 818     ctx->h_doctype_decl(ctx);
 819 }
 820
 821
 822
 823 ///////////////////////////////////////////////////////////////////////////////////////////////////////////
 824
 825 /* DTD: Internal subset */
 826
 827 static void
 828 xml_parse_internal_subset(struct xml_context *ctx)
 829 {
 830   // FIXME: comments/pi have no parent
 831   /* '[' intSubset ']'
 832    * intSubset :== (markupdecl | DeclSep)
 833    * Already parsed: ']' */
 834   while (1)
 835     {
 836       xml_parse_white(ctx, 0);
 837       uns c = xml_get_char(ctx);
 838       xml_inc(ctx);
 839       if (c == '<')
 840         if ((c = xml_get_char(ctx)) == '!')
 841           switch (c = xml_get_char(ctx))
 842             {
 843               case '-':
 844                 xml_push_comment(ctx);
 845                 xml_pop_comment(ctx);
 846                 break;
 847               case 'N':
 848                 xml_parse_seq(ctx, "OTATION");
 849                 xml_parse_notation_decl(ctx);
 850                 break;
 851               case 'E':
 852                 if ((c = xml_get_char(ctx)) == 'N')
 853                   {
 854                     xml_parse_seq(ctx, "TITY");
 855                     xml_parse_entity_decl(ctx);
 856                   }
 857                 else if (c == 'L')
 858                   {
 859                     xml_parse_seq(ctx, "EMENT");
 860                     xml_parse_element_decl(ctx);
 861                   }
 862                 else
 863                   goto invalid_markup;
 864                 break;
 865               case 'A':
 866                 xml_parse_seq(ctx, "TTLIST");
 867                 xml_parse_attr_list_decl(ctx);
 868                 break;
 869               default:
 870                 goto invalid_markup;
 871             }
 872         else if (c == '?')
 873           {
 874             xml_push_pi(ctx);
 875             xml_pop_pi(ctx);
 876           }
 877         else
 878           goto invalid_markup;
 879       else if (c == '%')
 880         xml_parse_pe_ref(ctx);
 881       else if (c == ']')
 882         break;
 883       else
 884         goto invalid_markup;
 885     }
 886   xml_dec(ctx);
 887   xml_dec(ctx);
 888   return;
 889 invalid_markup:
 890   xml_fatal(ctx, "Invalid markup in the internal subset");
 891 }
 892
 893 /*** The State Machine ***/
 894
 895 uns
 896 xml_next(struct xml_context *ctx)
 897 {
 898   /* A nasty state machine */
 899
 900 #define PULL(x) do { if (ctx->pull & XML_PULL_##x) return ctx->state = XML_STATE_##x; case XML_STATE_##x: ; } while (0)
 901 #define PULL_STATE(x, s) do { if (ctx->pull & XML_PULL_##x) return ctx->state = XML_STATE_##s, XML_STATE_##x; case XML_STATE_##s: ; } while (0)
 902
 903   TRACE(ctx, "xml_next (state=%u)", ctx->state);
 904   jmp_buf throw_buf;
 905   ctx->throw_buf = &throw_buf;
 906   if (setjmp(throw_buf))
 907     {
 908 error:
 909       if (ctx->err_code == XML_ERR_EOF && ctx->h_fatal)
 910         ctx->h_fatal(ctx);
 911       TRACE(ctx, "raised fatal error");
 912       return ctx->state = XML_STATE_EOF;
 913     }
 914   uns c;
 915   switch (ctx->state)
 916     {
 917       case XML_STATE_START:
 918         TRACE(ctx, "entering prolog");
 919         ctx->flags |= XML_SRC_DOCUMENT | XML_SRC_EXPECTED_DECL;
 920         if (ctx->h_document_start)
 921           ctx->h_document_start(ctx);
 922         /* XMLDecl */
 923         xml_refill(ctx);
 924         if (ctx->h_xml_decl)
 925           ctx->h_xml_decl(ctx);
 926         PULL(XML_DECL);
 927
 928         /* Misc* (doctypedecl Misc*)? */
 929         while (1)
 930           {
 931             xml_parse_white(ctx, 0);
 932             xml_parse_char(ctx, '<');
 933             xml_inc(ctx);
 934             if ((c = xml_get_char(ctx)) == '?')
 935               /* Processing intruction */
 936               if (!(ctx->flags & XML_REPORT_PIS))
 937                 xml_skip_pi(ctx);
 938               else
 939                 {
 940                   xml_push_pi(ctx);
 941                   PULL_STATE(PI, PROLOG_PI);
 942                   xml_pop_pi(ctx);
 943                 }
 944             else if (c != '!')
 945               {
 946                 /* Found the root tag */
 947                 xml_unget_char(ctx);
 948                 goto first_tag;
 949               }
 950             else if (xml_get_char(ctx) == '-')
 951               if (!(ctx->flags & XML_REPORT_COMMENTS))
 952                 xml_skip_comment(ctx);
 953               else
 954                 {
 955                   xml_push_comment(ctx);
 956                   PULL_STATE(COMMENT, PROLOG_COMMENT);
 957                   xml_pop_comment(ctx);
 958                 }
 959             else
 960               {
 961                 /* DocTypeDecl */
 962                 xml_unget_char(ctx);
 963                 xml_parse_doctype_decl(ctx);
 964                 PULL(DOCTYPE_DECL);
 965                 if (xml_peek_char(ctx) == '[')
 966                   {
 967                     xml_skip_char(ctx);
 968                     xml_inc(ctx);
 969                     if (ctx->flags & XML_PARSE_DTD)
 970                       {
 971                         xml_dtd_init(ctx);
 972                         if (ctx->h_dtd_start)
 973                           ctx->h_dtd_start(ctx);
 974                         // FIXME: pull iface?
 975                         xml_parse_internal_subset(ctx);
 976                         // FIXME: external subset
 977                         if (ctx->h_dtd_end)
 978                           ctx->h_dtd_end(ctx);
 979                       }
 980                     else
 981                       xml_skip_internal_subset(ctx);
 982                   }
 983                 xml_parse_white(ctx, 0);
 984                 xml_parse_char(ctx, '>');
 985                 xml_dec(ctx);
 986               }
 987           }
 988
 989       case XML_STATE_CHARS:
 990
 991         while (1)
 992           {
 993             if (xml_peek_char(ctx) != '<')
 994               {
 995                 /* CharData */
 996                 xml_append_chars(ctx);
 997                 continue;
 998               }
 999             else
1000               xml_skip_char(ctx);
1001             xml_inc(ctx);
1002 first_tag:
1003
1004             if ((c = xml_get_char(ctx)) == '?')
1005               {
1006                 /* PI */
1007                 if (!(ctx->flags & (XML_REPORT_PIS | XML_ALLOC_PIS)))
1008                   xml_skip_pi(ctx);
1009                 else
1010                   {
1011                     if (xml_flush_chars(ctx))
1012                       {
1013                         PULL_STATE(CHARS, CHARS_BEFORE_PI);
1014                         xml_pop_chars(ctx);
1015                       }
1016                     xml_push_pi(ctx);
1017                     PULL(PI);
1018                     xml_pop_pi(ctx);
1019                   }
1020               }
1021
1022             else if (c == '!')
1023               if ((c = xml_get_char(ctx)) == '-')
1024                 {
1025                   /* Comment */
1026                   if (!(ctx->flags & (XML_REPORT_COMMENTS | XML_ALLOC_COMMENTS)))
1027                     xml_skip_comment(ctx);
1028                   else
1029                     {
1030                       if (xml_flush_chars(ctx))
1031                         {
1032                           PULL_STATE(CHARS, CHARS_BEFORE_COMMENT);
1033                           xml_pop_chars(ctx);
1034                         }
1035                       xml_push_comment(ctx);
1036                       PULL(COMMENT);
1037                       xml_pop_comment(ctx);
1038                     }
1039                 }
1040               else if (c == '[')
1041                 {
1042                   /* CDATA */
1043                   xml_append_cdata(ctx);
1044                 }
1045               else
1046                 xml_fatal(ctx, "Unexpected character after '<!'");
1047
1048             else if (c != '/')
1049               {
1050                 /* STag | EmptyElemTag */
1051                 xml_unget_char(ctx);
1052                 if (xml_flush_chars(ctx))
1053                   {
1054                     PULL_STATE(CHARS, CHARS_BEFORE_STAG);
1055                     xml_pop_chars(ctx);
1056                   }
1057
1058                 xml_push_element(ctx);
1059                 PULL(STAG);
1060                 if (ctx->flags & XML_EMPTY_ELEM_TAG)
1061                   goto pop_element;
1062               }
1063
1064             else
1065               {
1066                 /* ETag */
1067                 if (xml_flush_chars(ctx))
1068                   {
1069                     PULL_STATE(CHARS, CHARS_BEFORE_ETAG);
1070                     xml_pop_chars(ctx);
1071                   }
1072
1073                 xml_parse_etag(ctx);
1074 pop_element:
1075                 PULL(ETAG);
1076                 xml_pop_element(ctx);
1077                 if (!ctx->node)
1078                   goto epilog;
1079               }
1080           }
1081
1082 epilog:
1083         /* Misc* */
1084         TRACE(ctx, "entering epilog");
1085         while (1)
1086           {
1087             /* Epilog whitespace is the only place, where a valid document can reach EOF */
1088             if (setjmp(throw_buf))
1089               if (ctx->err_code == XML_ERR_EOF)
1090                 {
1091                   TRACE(ctx, "reached EOF");
1092                   ctx->state = XML_STATE_EOF;
1093                   if (ctx->h_document_end)
1094                     ctx->h_document_end(ctx);
1095       case XML_STATE_EOF:
1096                   ctx->err_code = 0;
1097                   ctx->err_msg = NULL;
1098                   return XML_STATE_EOF;
1099                 }
1100               else
1101                 goto error;
1102             xml_parse_white(ctx, 0);
1103             if (setjmp(throw_buf))
1104               goto error;
1105
1106             /* Misc */
1107             xml_parse_char(ctx, '<');
1108             xml_inc(ctx);
1109             if ((c = xml_get_char(ctx)) == '?')
1110               /* Processing instruction */
1111               if (!(ctx->flags & XML_REPORT_PIS))
1112                 xml_skip_pi(ctx);
1113               else
1114                 {
1115                   xml_push_pi(ctx);
1116                   PULL_STATE(PI, EPILOG_PI);
1117                   xml_pop_pi(ctx);
1118                 }
1119             else if (c == '!')
1120               {
1121                 xml_parse_char(ctx, '-');
1122                 /* Comment */
1123                 if (!(ctx->flags & XML_REPORT_COMMENTS))
1124                   xml_skip_comment(ctx);
1125                 else
1126                   {
1127                     xml_push_comment(ctx);
1128                     PULL_STATE(COMMENT, EPILOG_COMMENT);
1129                     xml_pop_comment(ctx);
1130                   }
1131               }
1132             else
1133               xml_fatal(ctx, "Syntax error in the epilog");
1134           }
1135
1136     }
1137   ASSERT(0);
1138 }
1139
1140 uns
1141 xml_parse(struct xml_context *ctx)
1142 {
1143   /* This cycle should run only once unless the user overrides the value of ctx->pull in a SAX handler */
1144   do
1145     {
1146       ctx->pull = 0;
1147     }
1148   while (xml_next(ctx));
1149   return ctx->err_code;
1150 }