sherlock/xml/xml.h

   1 /*
   2  *      Sherlock Library -- A simple XML parser
   3  *
   4  *      (c) 2007 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 #ifndef _SHERLOCK_XML_XML_H
  11 #define _SHERLOCK_XML_XML_H
  12
  13 #include "lib/clists.h"
  14 #include "lib/slists.h"
  15 #include "lib/mempool.h"
  16
  17 enum xml_error {
  18   XML_ERR_OK = 0,
  19   XML_ERR_WARN = 1000,                          /* Warning */
  20   XML_ERR_ERROR = 2000,                         /* Recoverable error */
  21   XML_ERR_FATAL = 3000,                         /* Unrecoverable error */
  22   XML_ERR_EOF,
  23 };
  24
  25 enum xml_state {
  26   XML_STATE_START = 0,
  27   XML_STATE_DECL,
  28   XML_STATE_DOCUMENT_TYPE,
  29   XML_STATE_CHARS,
  30   XML_STATE_WHITE,
  31   XML_STATE_CDATA,
  32   XML_STATE_STAG,
  33   XML_STATE_ETAG,
  34   XML_STATE_COMMENT,
  35   XML_STATE_PI,
  36   XML_STATE_EOF,
  37   XML_STATE_FATAL,
  38
  39   /* Internal states */
  40   XML_STATE_CHARS_BEFORE_STAG,
  41   XML_STATE_CHARS_BEFORE_ETAG,
  42   XML_STATE_CHARS_BEFORE_CDATA,
  43   XML_STATE_CHARS_BEFORE_PI,
  44   XML_STATE_CHARS_BEFORE_COMMENT,
  45   XML_STATE_PROLOG_PI,
  46   XML_STATE_PROLOG_COMMENT,
  47   XML_STATE_EPILOG_PI,
  48   XML_STATE_EPILOG_COMMENT,
  49 };
  50
  51 enum xml_want {
  52   XML_WANT_DECL = 1 << XML_STATE_DECL,
  53   XML_WANT_DOCUMENT_TYPE = 1 << XML_STATE_DOCUMENT_TYPE,
  54   XML_WANT_CHARS = 1 << XML_STATE_CHARS,
  55   XML_WANT_WHITE = 1 << XML_STATE_WHITE,
  56   XML_WANT_CDATA = 1 << XML_STATE_CDATA,
  57   XML_WANT_STAG = 1 << XML_STATE_STAG,
  58   XML_WANT_ETAG = 1 << XML_STATE_ETAG,
  59   XML_WANT_COMMENT = 1 << XML_STATE_COMMENT,
  60   XML_WANT_PI = 1 << XML_STATE_PI,
  61   XML_WANT_EOF = 1 << XML_STATE_EOF,
  62   XML_WANT_ALL = ~0U,
  63 };
  64
  65 enum xml_flags {
  66   XML_FLAG_VALIDATING = 0x1,
  67   XML_FLAG_VERSION_1_1 = 0x2,                   /* XML version 1.1, otherwise 1.0 */
  68   XML_FLAG_HAS_EXTERNAL_SUBSET = 0x4,           /* The document contains a reference to external DTD subset */
  69   XML_FLAG_HAS_INTERNAL_SUBSET = 0x8,           /* The document contains an internal subset */
  70
  71   XML_FLAG_SRC_EOF = 0x10,                      /* EOF reached */
  72   XML_FLAG_SRC_EXPECTED_DECL = 0x20,            /* Just before optional or required XMLDecl/TextDecl */
  73   XML_FLAG_SRC_NEW_LINE = 0x40,                 /* The last read character is 0xD */
  74   XML_FLAG_SRC_SURROUND = 0x80,                 /* Surround the text with 0x20 (references to parameter entities) */
  75   XML_FLAG_SRC_DOCUMENT = 0x100,                /* The document entity */
  76   XML_FLAG_SRC_EXTERNAL = 0x200,                /* An external entity */
  77
  78   XML_DOM_SKIP = 0x1000,                        /* Do not report DOM nodes */
  79   XML_DOM_FREE = 0x2000,                        /* Free the subtree when leaving */
  80   XML_DOM_IGNORE = XML_DOM_SKIP | XML_DOM_FREE, /* Completely ignore the subtree */
  81
  82   XML_FLAG_EMPTY_ELEM = 0x100000,
  83 };
  84
  85 struct xml_ext_id {
  86   char *system_id;
  87   char *public_id;
  88 };
  89
  90 enum xml_node_type {
  91   XML_NODE_ELEM,
  92   XML_NODE_COMMENT,
  93   XML_NODE_CDATA,
  94   XML_NODE_PI,
  95 };
  96
  97 struct xml_node {
  98   cnode n;                                      /* Node for list of parent's sons */
  99   uns type;                                     /* XML_NODE_x */
 100   struct xml_node *parent;                      /* Parent node */
 101 };
 102
 103 struct xml_elem {
 104   struct xml_node node;
 105   char *name;                                   /* Element name */
 106   clist sons;                                   /* List of subnodes */
 107   struct xml_dtd_elem *dtd;                     /* Element DTD */
 108   slist attrs;                                  /* Link list of attributes */
 109 };
 110
 111 struct xml_attr {
 112   snode n;
 113   struct xml_elem *elem;
 114   char *name;
 115   char *val;
 116 };
 117
 118 struct xml_context;
 119
 120 struct xml_stack {
 121   struct xml_stack *next;                       /* Link list of stack records */
 122   uns saved_flags;                              /* Saved ctx->flags */
 123   struct mempool_state saved_pool;              /* Saved ctx->pool state */
 124 };
 125
 126 #define XML_BUF_SIZE 32                         /* At least 16 -- hardcoded */
 127
 128 struct xml_source {
 129   struct xml_source *next;                      /* Link list of pending fastbufs (xml_context.sources) */
 130   struct fastbuf *fb;                           /* Source fastbuf */
 131   struct fastbuf wrap_fb;                       /* Libcharset or fbmem wrapper */
 132   u32 buf[2 * XML_BUF_SIZE];                    /* Read buffer with Unicode values and categories */
 133   u32 *bptr, *bstop;                            /* Current state of the buffer */
 134   uns row;                                      /* File position */
 135   char *expected_encoding;                      /* Initial encoding before any transformation has been made (expected in XMLDecl/TextDecl) */
 136   char *fb_encoding;                            /* Encoding of the source fastbuf */
 137   char *decl_encoding;                          /* Encoding read from the XMLDecl/TextDecl */
 138   uns refill_cat1;                              /* Character categories, which should be directly passed to the buffer */
 139   uns refill_cat2;                              /* Character categories, which should be processed as newlines (possibly in some built-in sequences) */
 140   void (*refill)(struct xml_context *ctx);      /* Callback to decode source characters to the buffer */
 141   unsigned short *refill_in_to_x;               /* Libcharset input table */
 142   uns saved_depth;                              /* Saved ctx->depth */
 143 };
 144
 145 struct xml_context {
 146   /* Error handling */
 147   char *err_msg;                                        /* Last error message */
 148   enum xml_error err_code;                              /* Last error code */
 149   void *throw_buf;                                      /* Where to jump on error */
 150   void (*h_warn)(struct xml_context *ctx);              /* Warning callback */
 151   void (*h_error)(struct xml_context *ctx);             /* Recoverable error callback */
 152   void (*h_fatal)(struct xml_context *ctx);             /* Unrecoverable error callback */
 153
 154   /* Memory management */
 155   struct mempool *pool;                                 /* Most data */
 156   struct fastbuf *chars;                                /* Character data */
 157   struct fastbuf *value;                                /* Attribute value / comment / processing instruction data */
 158   char *name;                                           /* Attribute name, processing instruction target */
 159   void *tab_attrs;
 160
 161   /* Stack */
 162   struct xml_stack *stack;                              /* See xml_push(), xml_pop() */
 163   uns flags;                                            /* XML_FLAG_x (restored on xml_pop()) */
 164   uns depth;                                            /* Nesting level */
 165
 166   /* Input */
 167   struct xml_source *src;                               /* Current source */
 168   u32 *bptr, *bstop;                                    /* Character buffer */
 169
 170   /* SAX-like interface */
 171   void (*h_document_start)(struct xml_context *ctx);    /* Called before entering prolog */
 172   void (*h_document_end)(struct xml_context *ctx);      /* Called after leaving epilog */
 173   void (*h_xml_decl)(struct xml_context *ctx);          /* Called after the XML declaration */
 174   void (*h_doctype_decl)(struct xml_context *ctx);      /* Called in the doctype declaration just before internal subset */
 175   void (*h_pi)(struct xml_context *ctx);                /* Called after a processing instruction */
 176   void (*h_comment)(struct xml_context *ctx);           /* Called after a comment */
 177   void (*h_element_start)(struct xml_context *ctx);     /* Called after STag or EmptyElemTag */
 178   void (*h_element_end)(struct xml_context *ctx);       /* Called before ETag or after EmptyElemTag */
 179
 180   /* DOM */
 181   struct xml_elem *root;                                /* DOM root */
 182   union {
 183     struct xml_node *node;                              /* Current DOM node */
 184     struct xml_elem *elem;                              /* Current element */
 185   };
 186
 187   char *version_str;
 188   uns standalone;
 189   char *document_type;
 190   struct xml_dtd *dtd;
 191   struct xml_ext_id eid;
 192   uns state;
 193   uns want;
 194
 195   void (*start_dtd)(struct xml_context *ctx);
 196   void (*end_dtd)(struct xml_context *ctx);
 197   void (*start_cdata)(struct xml_context *ctx);
 198   void (*end_cdata)(struct xml_context *ctx);
 199   void (*start_entity)(struct xml_context *ctx);
 200   void (*end_entity)(struct xml_context *ctx);
 201   void (*chacacters)(struct xml_context *ctx);
 202   struct fastbuf *(*resolve_entity)(struct xml_context *ctx);
 203   void (*notation_decl)(struct xml_context *ctx);
 204   void (*unparsed_entity_decl)(struct xml_context *ctx);
 205 };
 206
 207 void xml_init(struct xml_context *ctx);
 208 void xml_cleanup(struct xml_context *ctx);
 209 void xml_set_source(struct xml_context *ctx, struct fastbuf *fb);
 210 int xml_next(struct xml_context *ctx);
 211
 212 #endif