ucw-xml/xml.h

   1 /*
   2  *      UCW Library -- A simple XML parser
   3  *
   4  *      (c) 2007--2008 Pavel Charvat <pchar@ucw.cz>
   5  *      (c) 2015 Martin Mares <mj@ucw.cz>
   6  *
   7  *      This software may be freely distributed and used according to the terms
   8  *      of the GNU Lesser General Public License.
   9  */
  10
  11 #ifndef _UCW_XML_XML_H
  12 #define _UCW_XML_XML_H
  13
  14 #include <ucw/clists.h>
  15 #include <ucw/slists.h>
  16 #include <ucw/mempool.h>
  17 #include <ucw/fastbuf.h>
  18
  19 #ifdef CONFIG_UCW_CLEAN_ABI
  20 #define xml_attr_find ucw_xml_attr_find
  21 #define xml_attr_find_ns ucw_xml_attr_find_ns
  22 #define xml_attr_qname ucw_xml_attr_qname
  23 #define xml_attr_value ucw_xml_attr_value
  24 #define xml_attr_value_ns ucw_xml_attr_value_ns
  25 #define xml_cleanup ucw_xml_cleanup
  26 #define xml_def_find_entity ucw_xml_def_find_entity
  27 #define xml_def_resolve_entity ucw_xml_def_resolve_entity
  28 #define xml_error ucw_xml_error
  29 #define xml_fatal ucw_xml_fatal
  30 #define xml_init ucw_xml_init
  31 #define xml_merge_chars ucw_xml_merge_chars
  32 #define xml_merge_dom_chars ucw_xml_merge_dom_chars
  33 #define xml_next ucw_xml_next
  34 #define xml_next_state ucw_xml_next_state
  35 #define xml_node_qname ucw_xml_node_qname
  36 #define xml_normalize_white ucw_xml_normalize_white
  37 #define xml_ns_by_id ucw_xml_ns_by_id
  38 #define xml_ns_by_name ucw_xml_ns_by_name
  39 #define xml_ns_enable ucw_xml_ns_enable
  40 #define xml_parse ucw_xml_parse
  41 #define xml_push_fastbuf ucw_xml_push_fastbuf
  42 #define xml_reset ucw_xml_reset
  43 #define xml_row ucw_xml_row
  44 #define xml_skip_element ucw_xml_skip_element
  45 #define xml_warn ucw_xml_warn
  46 #endif
  47
  48 struct xml_context;
  49 struct xml_dtd_entity;
  50
  51 enum xml_error {
  52   XML_ERR_OK = 0,
  53   XML_ERR_WARN = 1000,                                  /* Warning */
  54   XML_ERR_ERROR = 2000,                                 /* Recoverable error */
  55   XML_ERR_FATAL = 3000,                                 /* Unrecoverable error */
  56   XML_ERR_EOF,
  57 };
  58
  59 enum xml_state {
  60   XML_STATE_EOF,                                        /* EOF or a fatal error */
  61   XML_STATE_START,                                      /* Initial state */
  62   XML_STATE_XML_DECL,                                   /* XML_PULL_XML_DECL */
  63   XML_STATE_DOCTYPE_DECL,                               /* XML_PULL_DOCTYPE_DECL */
  64   XML_STATE_CHARS,                                      /* XML_PULL_CHARS */
  65   XML_STATE_STAG,                                       /* XML_PULL_STAG */
  66   XML_STATE_ETAG,                                       /* XML_PULL_ETAG */
  67   XML_STATE_COMMENT,                                    /* XML_PULL_COMMENT */
  68   XML_STATE_PI,                                         /* XML_PULL_PI */
  69
  70   /* Internal states */
  71   XML_STATE_CHARS_BEFORE_STAG,
  72   XML_STATE_CHARS_BEFORE_ETAG,
  73   XML_STATE_CHARS_BEFORE_CDATA,
  74   XML_STATE_CHARS_BEFORE_COMMENT,
  75   XML_STATE_CHARS_BEFORE_PI,
  76   XML_STATE_PROLOG_COMMENT,
  77   XML_STATE_PROLOG_PI,
  78   XML_STATE_EPILOG_COMMENT,
  79   XML_STATE_EPILOG_PI,
  80 };
  81
  82 enum xml_pull {
  83   XML_PULL_XML_DECL =                   0x00000001,     /* Stop after the XML declaration */
  84   XML_PULL_DOCTYPE_DECL =               0x00000002,     /* Stop in the doctype declaration (before optional internal subset) */
  85   XML_PULL_CHARS =                      0x00000004,
  86   XML_PULL_STAG =                       0x00000008,
  87   XML_PULL_ETAG =                       0x00000010,
  88   XML_PULL_COMMENT =                    0x00000020,
  89   XML_PULL_PI =                         0x00000040,
  90   XML_PULL_ALL =                        0xffffffff,
  91 };
  92
  93 enum xml_flags {
  94   /* Enable reporting of various events via SAX and/or PULL interface */
  95   XML_REPORT_COMMENTS =                 0x00000001,     /* Report comments */
  96   XML_REPORT_PIS =                      0x00000002,     /* Report processing instructions */
  97   XML_REPORT_CHARS =                    0x00000004,     /* Report characters */
  98   XML_REPORT_TAGS =                     0x00000008,     /* Report element starts/ends */
  99   XML_REPORT_MISC = XML_REPORT_COMMENTS | XML_REPORT_PIS,
 100   XML_REPORT_ALL = XML_REPORT_MISC | XML_REPORT_CHARS | XML_REPORT_TAGS,
 101
 102   /* Enable construction of DOM for these types */
 103   XML_ALLOC_COMMENTS =                  0x00000010,     /* Create comment nodes */
 104   XML_ALLOC_PIS =                       0x00000020,     /* Create processing instruction nodes */
 105   XML_ALLOC_CHARS =                     0x00000040,     /* Create character nodes */
 106   XML_ALLOC_TAGS =                      0x00000080,     /* Create element nodes */
 107   XML_ALLOC_MISC = XML_ALLOC_COMMENTS | XML_ALLOC_PIS,
 108   XML_ALLOC_ALL = XML_ALLOC_MISC | XML_ALLOC_CHARS | XML_ALLOC_TAGS,
 109
 110   /* Other parameters */
 111   XML_VALIDATING =                      0x00000100,     /* Validate everything (not fully implemented!) */
 112   XML_PARSE_DTD =                       0x00000200,     /* Enable parsing of DTD */
 113   XML_NO_CHARS =                        0x00000400,     /* The current element must not contain character data (filled automaticaly if using DTD) */
 114   XML_ALLOC_DEFAULT_ATTRS =             0x00000800,     /* Allocate default attribute values so they can be found by XML_ATTR_FOR_EACH */
 115   XML_NAMESPACES =                      0x00001000,     /* Parse namespaces, use xml_ns_enable() to set this */
 116
 117   /* Internals, do not change! */
 118   XML_EMPTY_ELEM_TAG =                  0x00010000,     /* The current element match EmptyElemTag */
 119   XML_VERSION_1_1 =                     0x00020000,     /* XML version is 1.1, otherwise 1.0 */
 120   XML_HAS_EXTERNAL_SUBSET =             0x00040000,     /* The document contains a reference to external DTD subset */
 121   XML_HAS_INTERNAL_SUBSET =             0x00080000,     /* The document contains an internal subset */
 122   XML_HAS_DTD = XML_HAS_EXTERNAL_SUBSET | XML_HAS_INTERNAL_SUBSET,
 123   XML_SRC_EOF =                         0x00100000,     /* EOF reached */
 124   XML_SRC_EXPECTED_DECL =               0x00200000,     /* Just before optional or required XMLDecl/TextDecl */
 125   XML_SRC_DOCUMENT =                    0x00400000,     /* The document entity */
 126   XML_SRC_EXTERNAL =                    0x00800000,     /* An external entity */
 127 };
 128
 129 enum xml_node_type {
 130   XML_NODE_ELEM,
 131   XML_NODE_COMMENT,
 132   XML_NODE_CHARS,
 133   XML_NODE_PI,
 134 };
 135
 136 #define XML_NODE_FOR_EACH(var, node) CLIST_FOR_EACH(struct xml_node *, var, (node)->sons)
 137 #define XML_ATTR_FOR_EACH(var, node) SLIST_FOR_EACH(struct xml_attr *, var, (node)->attrs)
 138
 139 struct xml_node {
 140   cnode n;                                              /* Node for list of parent's sons */
 141   uint type;                                            /* XML_NODE_x */
 142   struct xml_node *parent;                              /* Parent node */
 143   /*
 144    *  If namespaces are enabled, node->name points to the local part of the name
 145    *  and node->ns is the resolved namespace ID.
 146    *
 147    *  However, the namespace prefix is kept in memory just before the local part,
 148    *  so you can use xml_node_qname() to find out the full qualified name.
 149    *  The same applies to attributes, but the function is xml_attr_qname().
 150    */
 151   char *name;                                           /* Element name / PI target */
 152   clist sons;                                           /* Children nodes */
 153   union {
 154     struct {
 155       char *text;                                       /* PI text / Comment / CDATA */
 156       uint len;                                         /* Text length in bytes */
 157     };
 158     struct {
 159       uint ns;                                          /* Namespace ID */
 160       struct xml_dtd_elem *dtd;                         /* Element DTD */
 161       slist attrs;                                      /* Link list of element attributes */
 162     };
 163   };
 164   void *user;                                           /* User-defined (initialized to NULL) */
 165 };
 166
 167 struct xml_attr {
 168   snode n;                                              /* Node for elem->attrs */
 169   uint hash;                                            /* Internal hash of ns + name */
 170   struct xml_node *elem;                                /* Parent element */
 171   struct xml_dtd_attr *dtd;                             /* Attribute DTD */
 172   uint ns;                                              /* Namespace ID */
 173   char *name;                                           /* Attribute name without NS prefix */
 174   char *val;                                            /* Attribute value */
 175   void *user;                                           /* User-defined (initialized to NULL) */
 176 };
 177
 178 #define XML_BUF_SIZE 32                                 /* At least 8 -- hardcoded */
 179
 180 struct xml_source {
 181   struct xml_source *next;                              /* Link list of pending fastbufs (xml_context.sources) */
 182   struct fastbuf *fb;                                   /* Source fastbuf */
 183   struct fastbuf *wrapped_fb;                           /* Original wrapped fastbuf (needed for cleanup) */
 184   struct fastbuf wrap_fb;                               /* Fbmem wrapper */
 185   u32 buf[2 * XML_BUF_SIZE];                            /* Read buffer with Unicode values and categories */
 186   u32 *bptr, *bstop;                                    /* Current state of the buffer */
 187   uint row;                                             /* File position */
 188   char *expected_encoding;                              /* Initial encoding before any transformation has been made (expected in XMLDecl/TextDecl) */
 189   char *fb_encoding;                                    /* Encoding of the source fastbuf */
 190   char *decl_encoding;                                  /* Encoding read from the XMLDecl/TextDecl */
 191   uint refill_cat1;                                     /* Character categories, which should be directly passed to the buffer */
 192   uint refill_cat2;                                     /* Character categories, which should be processed as newlines (possibly in some built-in
 193                                                            sequences) */
 194   void (*refill)(struct xml_context *ctx);              /* Callback to decode source characters to the buffer */
 195   unsigned short *refill_in_to_x;                       /* Libucw-charset input table */
 196   uint saved_depth;                                     /* Saved ctx->depth */
 197   uint pending_0xd;                                     /* The last read character is 0xD */
 198 };
 199
 200 struct xml_context {
 201   /* Error handling */
 202   char *err_msg;                                        /* Last error message */
 203   enum xml_error err_code;                              /* Last error code */
 204   void *throw_buf;                                      /* Where to jump on error */
 205   void (*h_warn)(struct xml_context *ctx);              /* Warning callback */
 206   void (*h_error)(struct xml_context *ctx);             /* Recoverable error callback */
 207   void (*h_fatal)(struct xml_context *ctx);             /* Unrecoverable error callback */
 208
 209   /* Memory management */
 210   struct mempool *pool;                                 /* DOM pool */
 211   struct mempool *stack;                                /* Stack pool (freed as soon as possible) */
 212   struct xml_stack *stack_list;                         /* See xml_push(), xml_pop() */
 213   uint flags;                                           /* XML_FLAG_x (restored on xml_pop()) */
 214   uint depth;                                           /* Nesting level (for checking of valid source nesting -> valid pushes/pops on memory pools) */
 215   struct fastbuf chars;                                 /* Character data / attribute value */
 216   struct mempool_state chars_state;                     /* Mempool state before the current character block has started */
 217   char *chars_trivial;                                  /* If not empty, it will be appended to chars */
 218
 219   /* Input */
 220   struct xml_source *src;                               /* Current source */
 221   u32 *bptr, *bstop;                                    /* Buffer with preprocessed characters (validated UCS-4 + category flags) */
 222   uint cat_chars;                                       /* Unicode range of supported characters (cdata, attribute values, ...) */
 223   uint cat_unrestricted;                                /* Unrestricted characters (may appear in document/external entities) */
 224   uint cat_new_line;                                    /* New line characters */
 225   uint cat_name;                                        /* Characters that may appear in names */
 226   uint cat_sname;                                       /* Characters that may begin a name */
 227
 228   /* SAX-like interface */
 229   void (*h_document_start)(struct xml_context *ctx);    /* Called before entering prolog */
 230   void (*h_document_end)(struct xml_context *ctx);      /* Called after leaving epilog */
 231   void (*h_xml_decl)(struct xml_context *ctx);          /* Called after the XML declaration */
 232   void (*h_doctype_decl)(struct xml_context *ctx);      /* Called in the doctype declaration (before optional internal subset) */
 233   void (*h_comment)(struct xml_context *ctx);           /* Called after a comment (only with XML_REPORT_COMMENTS) */
 234   void (*h_pi)(struct xml_context *ctx);                /* Called after a processing instruction (only with XML_REPORT_PIS) */
 235   void (*h_stag)(struct xml_context *ctx);              /* Called after STag or EmptyElemTag (only with XML_REPORT_TAGS) */
 236   void (*h_etag)(struct xml_context *ctx);              /* Called before ETag or after EmptyElemTag (only with XML_REPORT_TAGS) */
 237   void (*h_chars)(struct xml_context *ctx);             /* Called after some characters (only with XML_REPORT_CHARS) */
 238   void (*h_block)(struct xml_context *ctx, char *text, uint len);       /* Called for each continuous block of characters not reported by h_cdata() (only with XML_REPORT_CHARS) */
 239   void (*h_cdata)(struct xml_context *ctx, char *text, uint len);       /* Called for each CDATA section (only with XML_REPORT_CHARS) */
 240   void (*h_ignorable)(struct xml_context *ctx, char *text, uint len);   /* Called for ignorable whitespace (content in tags without #PCDATA) */
 241   void (*h_dtd_start)(struct xml_context *ctx);         /* Called just after the DTD structure is initialized */
 242   void (*h_dtd_end)(struct xml_context *ctx);           /* Called after DTD subsets subsets */
 243   struct xml_dtd_entity *(*h_find_entity)(struct xml_context *ctx, char *name);         /* Called when needed to resolve a general entity */
 244   void (*h_resolve_entity)(struct xml_context *ctx, struct xml_dtd_entity *ent);        /* User should push source fastbuf for a parsed external entity (either general or parameter) */
 245
 246   /* DOM */
 247   struct xml_node *dom;                                 /* DOM root */
 248   struct xml_node *node;                                /* Current DOM node */
 249
 250   /* Namespaces */
 251   struct mempool *ns_pool;                              /* Memory pool for NS definitions */
 252   const char **ns_by_id;                                /* A growing array translating NS IDs to their names */
 253   void *ns_by_name;                                     /* Hash table translating NS names to their IDs */
 254   void *ns_by_prefix;                                   /* Hash table translating current prefixes to NS IDs, allocated from xml->stack */
 255   struct xml_ns_prefix *ns_prefix_stack;                /* A stack of prefix definitions, allocated from xml->stack */
 256   uint ns_default;                                      /* Current default namespace */
 257
 258   char *version_str;
 259   uint standalone;
 260   char *doctype;                                        /* The document type (or NULL if unknown) */
 261   char *system_id;                                      /* DTD external id */
 262   char *public_id;                                      /* DTD public id */
 263   struct xml_dtd *dtd;                                  /* The DTD structure (or NULL) */
 264   uint state;                                           /* Current state for the PULL interface (XML_STATE_x) */
 265   uint pull;                                            /* Parameters for the PULL interface (XML_PULL_x) */
 266 };
 267
 268 /* Initialize XML context */
 269 void xml_init(struct xml_context *ctx);
 270
 271 /* Clean up all internal structures */
 272 void xml_cleanup(struct xml_context *ctx);
 273
 274 /* Reuse XML context, equivalent to xml_cleanup() and xml_init() */
 275 void xml_reset(struct xml_context *ctx);
 276
 277 /* Add XML source (fastbuf will be automatically closed) */
 278 struct xml_source *xml_push_fastbuf(struct xml_context *ctx, struct fastbuf *fb);
 279
 280 /* Parse without the PULL interface, return XML_ERR_x code (zero on success) */
 281 uint xml_parse(struct xml_context *ctx);
 282
 283 /* Parse with the PULL interface, return XML_STATE_x (zero on EOF or fatal error) */
 284 uint xml_next(struct xml_context *ctx);
 285
 286 /* Equivalent to xml_next, but with temporarily changed ctx->pull value */
 287 uint xml_next_state(struct xml_context *ctx, uint pull);
 288
 289 /* May be called on XML_STATE_STAG to skip it's content; can return XML_STATE_ETAG or XML_STATE_EOF on fatal error */
 290 uint xml_skip_element(struct xml_context *ctx);
 291
 292 /* Returns the current row number in the document entity */
 293 uint xml_row(struct xml_context *ctx);
 294
 295 /* Finds a qualified name (including namespace prefix) of a given element node. */
 296 char *xml_node_qname(struct xml_context *ctx, struct xml_node *node);
 297
 298 /* Finds a qualified name (including namespace prefix) of a given attribute. */
 299 char *xml_attr_qname(struct xml_context *ctx, struct xml_attr *node);
 300
 301 /* Finds a given attribute value in a XML_NODE_ELEM node */
 302 struct xml_attr *xml_attr_find(struct xml_context *ctx, struct xml_node *node, char *name);
 303
 304 /* The same, but namespace-aware */
 305 struct xml_attr *xml_attr_find_ns(struct xml_context *ctx, struct xml_node *node, uint ns, char *name);
 306
 307 /* Similar to xml_attr_find, but it deals also with default values */
 308 char *xml_attr_value(struct xml_context *ctx, struct xml_node *node, char *name);
 309
 310 /* The same, but namespace-aware */
 311 char *xml_attr_value_ns(struct xml_context *ctx, struct xml_node *node, uint ns, char *name);
 312
 313 /* The default value of h_find_entity(), knows &lt;, &gt;, &amp;, &apos; and &quot; */
 314 struct xml_dtd_entity *xml_def_find_entity(struct xml_context *ctx, char *name);
 315
 316 /* The default value of h_resolve_entity(), throws an error */
 317 void xml_def_resolve_entity(struct xml_context *ctx, struct xml_dtd_entity *ent);
 318
 319 /* Remove leading/trailing spaces and replaces sequences of spaces to a single space character (non-CDATA attribute normalization) */
 320 uint xml_normalize_white(struct xml_context *ctx, char *value);
 321
 322 /* Merge character contents of a given element to a single string (not recursive) */
 323 char *xml_merge_chars(struct xml_context *ctx, struct xml_node *node, struct mempool *pool);
 324
 325 /* Merge character contents of a given subtree to a single string */
 326 char *xml_merge_dom_chars(struct xml_context *ctx, struct xml_node *node, struct mempool *pool);
 327
 328 /* Public part of error handling */
 329 void xml_warn(struct xml_context *ctx, const char *format, ...);
 330 void xml_error(struct xml_context *ctx, const char *format, ...);
 331 void NONRET xml_fatal(struct xml_context *ctx, const char *format, ...);
 332
 333 /* Request processing of namespaces */
 334 void xml_ns_enable(struct xml_context *ctx);
 335
 336 /* Looks up namespace by its ID, dies on an invalid ID */
 337 const char *xml_ns_by_id(struct xml_context *ctx, uint ns);
 338
 339 /* Looks up namespace by its name and returns its ID. Creates a new ID if necessary. */
 340 uint xml_ns_by_name(struct xml_context *ctx, const char *name);
 341
 342 /* Well-known namespaces */
 343 #define XML_NS_NONE             0       /* This element has no namespace */
 344 #define XML_NS_XMLNS            1       /* xmlns: */
 345 #define XML_NS_XML              2       /* xml: */
 346
 347 #endif