home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277247_apr_xml.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  12KB  |  340 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15. /**
  16.  * @file apr_xml.h
  17.  * @brief APR-UTIL XML Library
  18.  */
  19. #ifndef APR_XML_H
  20. #define APR_XML_H
  21.  
  22. /**
  23.  * @defgroup APR_Util_XML XML 
  24.  * @ingroup APR_Util
  25.  * @{
  26.  */
  27. #include "apr_pools.h"
  28. #include "apr_tables.h"
  29. #include "apr_file_io.h"
  30.  
  31. #include "apu.h"
  32.  
  33. #ifdef __cplusplus
  34. extern "C" {
  35. #endif
  36.  
  37. /**
  38.  * @package Apache XML library
  39.  */
  40.  
  41. /* -------------------------------------------------------------------- */
  42.  
  43. /* ### these will need to move at some point to a more logical spot */
  44.  
  45. /** @see apr_text */
  46. typedef struct apr_text apr_text;
  47.  
  48. /** Structure to keep a linked list of pieces of text */
  49. struct apr_text {
  50.     /** The current piece of text */
  51.     const char *text;
  52.     /** a pointer to the next piece of text */
  53.     struct apr_text *next;
  54. };
  55.  
  56. /** @see apr_text_header */
  57. typedef struct apr_text_header apr_text_header;
  58.  
  59. /** A list of pieces of text */
  60. struct apr_text_header {
  61.     /** The first piece of text in the list */
  62.     apr_text *first;
  63.     /** The last piece of text in the list */
  64.     apr_text *last;
  65. };
  66.  
  67. /**
  68.  * Append a piece of text to the end of a list
  69.  * @param p The pool to allocate out of
  70.  * @param hdr The text header to append to
  71.  * @param text The new text to append
  72.  */
  73. APU_DECLARE(void) apr_text_append(apr_pool_t *p, apr_text_header *hdr,
  74.                                   const char *text);
  75.  
  76.  
  77. /* --------------------------------------------------------------------
  78. **
  79. ** XML PARSING
  80. */
  81.  
  82. /*
  83. ** Qualified namespace values
  84. **
  85. ** APR_XML_NS_DAV_ID
  86. **    We always insert the "DAV:" namespace URI at the head of the
  87. **    namespace array. This means that it will always be at ID==0,
  88. **    making it much easier to test for.
  89. **
  90. ** APR_XML_NS_NONE
  91. **    This special ID is used for two situations:
  92. **
  93. **    1) The namespace prefix begins with "xml" (and we do not know
  94. **       what it means). Namespace prefixes with "xml" (any case) as
  95. **       their first three characters are reserved by the XML Namespaces
  96. **       specification for future use. mod_dav will pass these through
  97. **       unchanged. When this identifier is used, the prefix is LEFT in
  98. **       the element/attribute name. Downstream processing should not
  99. **       prepend another prefix.
  100. **
  101. **    2) The element/attribute does not have a namespace.
  102. **
  103. **       a) No prefix was used, and a default namespace has not been
  104. **          defined.
  105. **       b) No prefix was used, and the default namespace was specified
  106. **          to mean "no namespace". This is done with a namespace
  107. **          declaration of:  xmlns=""
  108. **          (this declaration is typically used to override a previous
  109. **          specification for the default namespace)
  110. **
  111. **       In these cases, we need to record that the elem/attr has no
  112. **       namespace so that we will not attempt to prepend a prefix.
  113. **       All namespaces that are used will have a prefix assigned to
  114. **       them -- mod_dav will never set or use the default namespace
  115. **       when generating XML. This means that "no prefix" will always
  116. **       mean "no namespace".
  117. **
  118. **    In both cases, the XML generation will avoid prepending a prefix.
  119. **    For the first case, this means the original prefix/name will be
  120. **    inserted into the output stream. For the latter case, it means
  121. **    the name will have no prefix, and since we never define a default
  122. **    namespace, this means it will have no namespace.
  123. **
  124. ** Note: currently, mod_dav understands the "xmlns" prefix and the
  125. **     "xml:lang" attribute. These are handled specially (they aren't
  126. **     left within the XML tree), so the APR_XML_NS_NONE value won't ever
  127. **     really apply to these values.
  128. */
  129. #define APR_XML_NS_DAV_ID    0    /**< namespace ID for "DAV:" */
  130. #define APR_XML_NS_NONE        -10    /**< no namespace for this elem/attr */
  131.  
  132. #define APR_XML_NS_ERROR_BASE    -100    /**< used only during processing */
  133. /** Is this namespace an error? */
  134. #define APR_XML_NS_IS_ERROR(e)    ((e) <= APR_XML_NS_ERROR_BASE)
  135.  
  136. /** @see apr_xml_attr */
  137. typedef struct apr_xml_attr apr_xml_attr;
  138. /** @see apr_xml_elem */
  139. typedef struct apr_xml_elem apr_xml_elem;
  140. /** @see apr_xml_doc */
  141. typedef struct apr_xml_doc apr_xml_doc;
  142.  
  143. /** apr_xml_attr: holds a parsed XML attribute */
  144. struct apr_xml_attr {
  145.     /** attribute name */
  146.     const char *name;
  147.     /** index into namespace array */
  148.     int ns;
  149.  
  150.     /** attribute value */
  151.     const char *value;
  152.  
  153.     /** next attribute */
  154.     struct apr_xml_attr *next;
  155. };
  156.  
  157. /** apr_xml_elem: holds a parsed XML element */
  158. struct apr_xml_elem {
  159.     /** element name */
  160.     const char *name;
  161.     /** index into namespace array */
  162.     int ns;
  163.     /** xml:lang for attrs/contents */
  164.     const char *lang;
  165.  
  166.     /** cdata right after start tag */
  167.     apr_text_header first_cdata;
  168.     /** cdata after MY end tag */
  169.     apr_text_header following_cdata;
  170.  
  171.     /** parent element */
  172.     struct apr_xml_elem *parent;    
  173.     /** next (sibling) element */
  174.     struct apr_xml_elem *next;    
  175.     /** first child element */
  176.     struct apr_xml_elem *first_child;
  177.     /** first attribute */
  178.     struct apr_xml_attr *attr;        
  179.  
  180.     /* used only during parsing */
  181.     /** last child element */
  182.     struct apr_xml_elem *last_child;
  183.     /** namespaces scoped by this elem */
  184.     struct apr_xml_ns_scope *ns_scope;
  185.  
  186.     /* used by modules during request processing */
  187.     /** Place for modules to store private data */
  188.     void *priv;
  189. };
  190.  
  191. /** Is this XML element empty? */
  192. #define APR_XML_ELEM_IS_EMPTY(e) ((e)->first_child == NULL && \
  193.                                   (e)->first_cdata.first == NULL)
  194.  
  195. /** apr_xml_doc: holds a parsed XML document */
  196. struct apr_xml_doc {
  197.     /** root element */
  198.     apr_xml_elem *root;    
  199.     /** array of namespaces used */
  200.     apr_array_header_t *namespaces;
  201. };
  202.  
  203. /** Opaque XML parser structure */
  204. typedef struct apr_xml_parser apr_xml_parser;
  205.  
  206. /**
  207.  * Create an XML parser
  208.  * @param pool The pool for allocating the parser and the parse results.
  209.  * @return The new parser.
  210.  */
  211. APU_DECLARE(apr_xml_parser *) apr_xml_parser_create(apr_pool_t *pool);
  212.  
  213. /**
  214.  * Parse a File, producing a xml_doc
  215.  * @param p      The pool for allocating the parse results.
  216.  * @param parser A pointer to *parser (needed so calling function can get
  217.  *               errors), will be set to NULL on successfull completion.
  218.  * @param ppdoc  A pointer to *apr_xml_doc (which has the parsed results in it)
  219.  * @param xmlfd  A file to read from.
  220.  * @param buffer_length Buffer length which would be suitable 
  221.  * @return Any errors found during parsing.
  222.  */
  223. APU_DECLARE(apr_status_t) apr_xml_parse_file(apr_pool_t *p,
  224.                                              apr_xml_parser **parser,
  225.                                              apr_xml_doc **ppdoc,
  226.                                              apr_file_t *xmlfd,
  227.                                              apr_size_t buffer_length);
  228.  
  229.  
  230. /**
  231.  * Feed input into the parser
  232.  * @param parser The XML parser for parsing this data.
  233.  * @param data The data to parse.
  234.  * @param len The length of the data.
  235.  * @return Any errors found during parsing.
  236.  * @remark Use apr_xml_parser_geterror() to get more error information.
  237.  */
  238. APU_DECLARE(apr_status_t) apr_xml_parser_feed(apr_xml_parser *parser,
  239.                                               const char *data,
  240.                                               apr_size_t len);
  241.  
  242. /**
  243.  * Terminate the parsing and return the result
  244.  * @param parser The XML parser for parsing this data.
  245.  * @param pdoc The resulting parse information. May be NULL to simply
  246.  *             terminate the parsing without fetching the info.
  247.  * @return Any errors found during the final stage of parsing.
  248.  * @remark Use apr_xml_parser_geterror() to get more error information.
  249.  */
  250. APU_DECLARE(apr_status_t) apr_xml_parser_done(apr_xml_parser *parser,
  251.                                               apr_xml_doc **pdoc);
  252.  
  253. /**
  254.  * Fetch additional error information from the parser.
  255.  * @param parser The XML parser to query for errors.
  256.  * @param errbuf A buffer for storing error text.
  257.  * @param errbufsize The length of the error text buffer.
  258.  * @return The error buffer
  259.  */
  260. APU_DECLARE(char *) apr_xml_parser_geterror(apr_xml_parser *parser,
  261.                                             char *errbuf,
  262.                                             apr_size_t errbufsize);
  263.  
  264.  
  265. /**
  266.  * Converts an XML element tree to flat text 
  267.  * @param p The pool to allocate out of
  268.  * @param elem The XML element to convert
  269.  * @param style How to covert the XML.  One of:
  270.  * <PRE>
  271.  *     APR_XML_X2T_FULL                start tag, contents, end tag 
  272.  *     APR_XML_X2T_INNER               contents only 
  273.  *     APR_XML_X2T_LANG_INNER          xml:lang + inner contents 
  274.  *     APR_XML_X2T_FULL_NS_LANG        FULL + ns defns + xml:lang 
  275.  * </PRE>
  276.  * @param namespaces The namespace of the current XML element
  277.  * @param ns_map Namespace mapping
  278.  * @param pbuf Buffer to put the converted text into
  279.  * @param psize Size of the converted text
  280.  */
  281. APU_DECLARE(void) apr_xml_to_text(apr_pool_t *p, const apr_xml_elem *elem,
  282.                                   int style, apr_array_header_t *namespaces,
  283.                                   int *ns_map, const char **pbuf,
  284.                                   apr_size_t *psize);
  285.  
  286. /* style argument values: */
  287. #define APR_XML_X2T_FULL         0    /**< start tag, contents, end tag */
  288. #define APR_XML_X2T_INNER        1    /**< contents only */
  289. #define APR_XML_X2T_LANG_INNER   2    /**< xml:lang + inner contents */
  290. #define APR_XML_X2T_FULL_NS_LANG 3    /**< FULL + ns defns + xml:lang */
  291.  
  292. /**
  293.  * empty XML element
  294.  * @param p The pool to allocate out of
  295.  * @param elem The XML element to empty
  296.  * @return the string that was stored in the XML element
  297.  */
  298. APU_DECLARE(const char *) apr_xml_empty_elem(apr_pool_t *p,
  299.                                              const apr_xml_elem *elem);
  300.  
  301. /**
  302.  * quote an XML string
  303.  * Replace '<', '>', and '&' with '<', '>', and '&'.
  304.  * @param p The pool to allocate out of
  305.  * @param s The string to quote
  306.  * @param quotes If quotes is true, then replace '"' with '"'.
  307.  * @return The quoted string
  308.  * @note If the string does not contain special characters, it is not
  309.  * duplicated into the pool and the original string is returned.
  310.  */
  311. APU_DECLARE(const char *) apr_xml_quote_string(apr_pool_t *p, const char *s,
  312.                                                int quotes);
  313.  
  314. /**
  315.  * Quote an XML element
  316.  * @param p The pool to allocate out of
  317.  * @param elem The element to quote
  318.  */
  319. APU_DECLARE(void) apr_xml_quote_elem(apr_pool_t *p, apr_xml_elem *elem);
  320.  
  321. /* manage an array of unique URIs: apr_xml_insert_uri() and APR_XML_URI_ITEM() */
  322.  
  323. /**
  324.  * return the URI's (existing) index, or insert it and return a new index 
  325.  * @param uri_array array to insert into
  326.  * @param uri The uri to insert
  327.  * @return int The uri's index
  328.  */
  329. APU_DECLARE(int) apr_xml_insert_uri(apr_array_header_t *uri_array,
  330.                                     const char *uri);
  331.  
  332. /** Get the URI item for this XML element */
  333. #define APR_XML_GET_URI_ITEM(ary, i) (((const char * const *)(ary)->elts)[i])
  334.  
  335. #ifdef __cplusplus
  336. }
  337. #endif
  338. /** @} */
  339. #endif /* APR_XML_H */
  340.