1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/**
* Copyright (c) 2012 ooxi/xml.c
* https://github.com/ooxi/xml.c
*
* This software is provided 'as-is', without any express or implied warranty.
* In no event will the authors be held liable for any damages arising from the
* use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software in a
* product, an acknowledgment in the product documentation would be
* appreciated but is not required.
*
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
*
* 3. This notice may not be removed or altered from any source distribution.
*/
#ifndef HEADER_XML
#define HEADER_XML
/**
* Includes
*/
#include <stdint.h>
#include <string.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* Opaque structure holding the parsed xml document
*/
struct xml_document;
struct xml_node;
struct xml_attribute;
/**
* Internal character sequence representation
*/
struct xml_string;
/**
* Tries to parse the XML fragment in buffer
*
* @param buffer Chunk to parse
* @param length Size of the buffer
*
* @warning `buffer` will be referenced by the document, you may not free it
* until you free the xml_document
* @warning You have to call xml_document_free after you finished using the
* document
*
* @return The parsed xml fragment iff parsing was successful, 0 otherwise
*/
struct xml_document* xml_parse_document(uint8_t* buffer, size_t length);
/**
* Tries to read an XML document from disk
*
* @param source File that will be read into an xml document. Will be closed
*
* @warning You have to call xml_document_free with free_buffer = true after you
* finished using the document
*
* @return The parsed xml fragment iff parsing was successful, 0 otherwise
*/
struct xml_document* xml_open_document(FILE* source);
/**
* Frees all resources associated with the document. All xml_node and xml_string
* references obtained through the document will be invalidated
*
* @param document xml_document to free
* @param free_buffer iff true the internal buffer supplied via xml_parse_buffer
* will be freed with the `free` system call
*/
void xml_document_free(struct xml_document* document, bool free_buffer);
/**
* @return xml_node representing the document root
*/
struct xml_node* xml_document_root(struct xml_document* document);
/**
* @return The xml_node's tag name
*/
struct xml_string* xml_node_name(struct xml_node* node);
/**
* @return The xml_node's string content (if available, otherwise NULL)
*/
struct xml_string* xml_node_content(struct xml_node* node);
/**
* @return Number of child nodes
*/
size_t xml_node_children(struct xml_node* node);
/**
* @return The n-th child or 0 if out of range
*/
struct xml_node* xml_node_child(struct xml_node* node, size_t child);
/**
* @return Number of attribute nodes
*/
size_t xml_node_attributes(struct xml_node* node);
/**
* @return the n-th attribute name or 0 if out of range
*/
struct xml_string* xml_node_attribute_name(struct xml_node* node, size_t attribute);
/**
* @return the n-th attribute content or 0 if out of range
*/
struct xml_string* xml_node_attribute_content(struct xml_node* node, size_t attribute);
/**
* @return The node described by the path or 0 if child cannot be found
* @warning Each element on the way must be unique
* @warning Last argument must be 0
*/
struct xml_node* xml_easy_child(struct xml_node* node, uint8_t const* child, ...);
/**
* @return 0-terminated copy of node name
* @warning User must free the result
*/
uint8_t* xml_easy_name(struct xml_node* node);
/**
* @return 0-terminated copy of node content
* @warning User must free the result
*/
uint8_t* xml_easy_content(struct xml_node* node);
/**
* @return Length of the string
*/
size_t xml_string_length(struct xml_string* string);
/**
* Copies the string into the supplied buffer
*
* @warning String will not be 0-terminated
* @warning Will write at most length bytes, even if the string is longer
*/
void xml_string_copy(struct xml_string* string, uint8_t* buffer, size_t length);
int xml_node_name_cmp(struct xml_node* node, const char *name);
#ifdef __cplusplus
}
#endif
#endif
|
