Apache Portable Runtime Utility Library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_xml.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
20 #ifndef APR_XML_H
21 #define APR_XML_H
22 
28 #include "apr_pools.h"
29 #include "apr_tables.h"
30 #include "apr_file_io.h"
31 
32 #include "apu.h"
33 #if APR_CHARSET_EBCDIC
34 #include "apr_xlate.h"
35 #endif
36 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40 
45 /* -------------------------------------------------------------------- */
46 
47 /* ### these will need to move at some point to a more logical spot */
48 
50 typedef struct apr_text apr_text;
51 
53 struct apr_text {
55  const char *text;
57  struct apr_text *next;
58 };
59 
62 
69 };
70 
77 APU_DECLARE(void) apr_text_append(apr_pool_t *p, apr_text_header *hdr,
78  const char *text);
79 
80 
81 /* --------------------------------------------------------------------
82 **
83 ** XML PARSING
84 */
85 
86 /*
87 ** Qualified namespace values
88 **
89 ** APR_XML_NS_DAV_ID
90 ** We always insert the "DAV:" namespace URI at the head of the
91 ** namespace array. This means that it will always be at ID==0,
92 ** making it much easier to test for.
93 **
94 ** APR_XML_NS_NONE
95 ** This special ID is used for two situations:
96 **
97 ** 1) The namespace prefix begins with "xml" (and we do not know
98 ** what it means). Namespace prefixes with "xml" (any case) as
99 ** their first three characters are reserved by the XML Namespaces
100 ** specification for future use. mod_dav will pass these through
101 ** unchanged. When this identifier is used, the prefix is LEFT in
102 ** the element/attribute name. Downstream processing should not
103 ** prepend another prefix.
104 **
105 ** 2) The element/attribute does not have a namespace.
106 **
107 ** a) No prefix was used, and a default namespace has not been
108 ** defined.
109 ** b) No prefix was used, and the default namespace was specified
110 ** to mean "no namespace". This is done with a namespace
111 ** declaration of: xmlns=""
112 ** (this declaration is typically used to override a previous
113 ** specification for the default namespace)
114 **
115 ** In these cases, we need to record that the elem/attr has no
116 ** namespace so that we will not attempt to prepend a prefix.
117 ** All namespaces that are used will have a prefix assigned to
118 ** them -- mod_dav will never set or use the default namespace
119 ** when generating XML. This means that "no prefix" will always
120 ** mean "no namespace".
121 **
122 ** In both cases, the XML generation will avoid prepending a prefix.
123 ** For the first case, this means the original prefix/name will be
124 ** inserted into the output stream. For the latter case, it means
125 ** the name will have no prefix, and since we never define a default
126 ** namespace, this means it will have no namespace.
127 **
128 ** Note: currently, mod_dav understands the "xmlns" prefix and the
129 ** "xml:lang" attribute. These are handled specially (they aren't
130 ** left within the XML tree), so the APR_XML_NS_NONE value won't ever
131 ** really apply to these values.
132 */
133 #define APR_XML_NS_DAV_ID 0
134 #define APR_XML_NS_NONE -10
136 #define APR_XML_NS_ERROR_BASE -100
138 #define APR_XML_NS_IS_ERROR(e) ((e) <= APR_XML_NS_ERROR_BASE)
139 
141 typedef struct apr_xml_attr apr_xml_attr;
143 typedef struct apr_xml_elem apr_xml_elem;
145 typedef struct apr_xml_doc apr_xml_doc;
146 
148 struct apr_xml_attr {
150  const char *name;
152  int ns;
153 
155  const char *value;
156 
159 };
160 
162 struct apr_xml_elem {
164  const char *name;
166  int ns;
168  const char *lang;
169 
174 
178  struct apr_xml_elem *next;
182  struct apr_xml_attr *attr;
183 
184  /* used only during parsing */
188  struct apr_xml_ns_scope *ns_scope;
189 
190  /* used by modules during request processing */
192  void *priv;
193 };
194 
196 #define APR_XML_ELEM_IS_EMPTY(e) ((e)->first_child == NULL && \
197  (e)->first_cdata.first == NULL)
198 
200 struct apr_xml_doc {
204  apr_array_header_t *namespaces;
205 };
206 
209 
215 APU_DECLARE(apr_xml_parser *) apr_xml_parser_create(apr_pool_t *pool);
216 
227 APU_DECLARE(apr_status_t) apr_xml_parse_file(apr_pool_t *p,
228  apr_xml_parser **parser,
229  apr_xml_doc **ppdoc,
230  apr_file_t *xmlfd,
231  apr_size_t buffer_length);
232 
233 
242 APU_DECLARE(apr_status_t) apr_xml_parser_feed(apr_xml_parser *parser,
243  const char *data,
244  apr_size_t len);
245 
254 APU_DECLARE(apr_status_t) apr_xml_parser_done(apr_xml_parser *parser,
255  apr_xml_doc **pdoc);
256 
264 APU_DECLARE(char *) apr_xml_parser_geterror(apr_xml_parser *parser,
265  char *errbuf,
266  apr_size_t errbufsize);
267 
268 
285 APU_DECLARE(void) apr_xml_to_text(apr_pool_t *p, const apr_xml_elem *elem,
286  int style, apr_array_header_t *namespaces,
287  int *ns_map, const char **pbuf,
288  apr_size_t *psize);
289 
290 /* style argument values: */
291 #define APR_XML_X2T_FULL 0
292 #define APR_XML_X2T_INNER 1
293 #define APR_XML_X2T_LANG_INNER 2
294 #define APR_XML_X2T_FULL_NS_LANG 3
302 APU_DECLARE(const char *) apr_xml_empty_elem(apr_pool_t *p,
303  const apr_xml_elem *elem);
304 
315 APU_DECLARE(const char *) apr_xml_quote_string(apr_pool_t *p, const char *s,
316  int quotes);
317 
323 APU_DECLARE(void) apr_xml_quote_elem(apr_pool_t *p, apr_xml_elem *elem);
324 
325 /* manage an array of unique URIs: apr_xml_insert_uri() and APR_XML_URI_ITEM() */
326 
333 APU_DECLARE(int) apr_xml_insert_uri(apr_array_header_t *uri_array,
334  const char *uri);
335 
337 #define APR_XML_GET_URI_ITEM(ary, i) (((const char * const *)(ary)->elts)[i])
338 
339 #if APR_CHARSET_EBCDIC
340 
347 APU_DECLARE(apr_status_t) apr_xml_parser_convert_doc(apr_pool_t *p,
348  apr_xml_doc *pdoc,
349  apr_xlate_t *convset);
350 #endif
351 
352 #ifdef __cplusplus
353 }
354 #endif
355 
356 #endif /* APR_XML_H */