-
Notifications
You must be signed in to change notification settings - Fork 1
/
xmlsd.h
223 lines (199 loc) · 8.33 KB
/
xmlsd.h
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*
* Copyright (c) 2010 Marco Peereboom <marco@peereboom.us>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef XMLSD_H
#define XMLSD_H
#ifdef NEED_LIBCLENS
#include <clens.h>
#endif
#include <stdio.h>
#include <stdlib.h>
#include <inttypes.h>
#include <sys/queue.h>
/* versioning */
#define XMLSD_STRINGIFY(x) #x
#define XMLSD_STR(x) XMLSD_STRINGIFY(x)
#define XMLSD_VERSION_MAJOR 0
#define XMLSD_VERSION_MINOR 10
#define XMLSD_VERSION_PATCH 1
#define XMLSD_VERSION XMLSD_STR(XMLSD_VERSION_MAJOR) "." \
XMLSD_STR(XMLSD_VERSION_MINOR) "." \
XMLSD_STR(XMLSD_VERSION_PATCH)
const char *xmlsd_verstring(void);
void xmlsd_version(int *major, int *minor, int *patch);
#define XMLSD_ERR_UNKNOWN (-1)
#define XMLSD_ERR_SUCCES (0)
#define XMLSD_ERR_PARSER (1)
#define XMLSD_ERR_RESOURCE (2)
#define XMLSD_ERR_EXTERNAL (3)
#define XMLSD_ERR_OVERFLOW (4)
#define XMLSD_ERR_INTEGRITY (5)
#define XMLSD_TIMEOUT (5 * 1000) /* 5 seconds */
/* validation structures */
struct xmlsd_v_attr {
char *name;
int flags;
#define XMLSD_V_ATTR_F_REQUIRED 0x0001
};
struct xmlsd_v_elem {
char *element;
char *path;
struct xmlsd_v_attr *attr; /* array of attributes */
int min_occurs; /* Appear at least min times. */
int max_occurs; /* 0 for unbounded. */
};
struct xmlsd_v_elements {
char *name;
struct xmlsd_v_elem *cmd;
};
struct xmlsd_validate_failure {
struct xmlsd_element *xvf_elem;
struct xmlsd_attribute *xvf_attr;
struct xmlsd_v_elem *xvf_velem;
struct xmlsd_v_attr *xvf_vattr;
enum xmlsd_validate_reason {
XMLSD_VALIDATE_NO_ERROR = 0,
XMLSD_VALIDATE_UNRECOGNISED_ELEMENT,
XMLSD_VALIDATE_UNRECOGNISED_ATTRIBUTE,
XMLSD_VALIDATE_TOO_MANY_OCCURRENCES,
XMLSD_VALIDATE_TOO_FEW_OCCURRENCES,
XMLSD_VALIDATE_MISSING_REQUIRED_ATTRIBUTE,
XMLSD_VALIDATE_PATH_TOO_LONG,
XMLSD_VALIDATE_EMPTY_XML,
XMLSD_VALIDATE_ROOT_HAS_PARENT,
XMLSD_VALIDATE_UNRECOGNISED_COMMAND,
} xvf_reason;
};
struct xmlsd_v_elements_validation {
struct xmlsd_v_elements *xvev_elements;
struct xmlsd_v_elem *xvev_elem;
struct xmlsd_v_attr *xvev_attr;
enum xmlsd_validate_v_elements_failure {
XMLSD_VALIDATE_ELEMENTS_NO_ERROR = 0,
XMLSD_VALIDATE_ELEMENTS_NO_CMD,
XMLSD_VALIDATE_ELEMENTS_ROOT_PATH,
XMLSD_VALIDATE_ELEMENTS_NO_PATH,
XMLSD_VALIDATE_ELEMENTS_INVALID_PATH,
XMLSD_VALIDATE_ELEMENTS_UNRECOGNISED_ATTR_FLAG,
XMLSD_VALIDATE_ELEMENTS_MIN_OCCURS_NEGATIVE,
XMLSD_VALIDATE_ELEMENTS_MAX_OCCURS_NEGATIVE,
XMLSD_VALIDATE_ELEMENTS_MAX_LESS_THAN_MIN,
} xvev_reason;
};
/* regular structures */
/* XML attribute */
struct xmlsd_attribute;
const char *xmlsd_attr_get_name(struct xmlsd_attribute *);
const char *xmlsd_attr_get_value(struct xmlsd_attribute *);
/*
* XML element inteface definition
*/
struct xmlsd_element;
/* element get and iteration interface */
const char *xmlsd_elem_get_name(struct xmlsd_element *);
const char *xmlsd_elem_get_value(struct xmlsd_element *);
long long xmlsd_elem_get_value_strtonum(struct xmlsd_element *,
long long, long long, const char **);
unsigned long long xmlsd_elem_get_value_hexnum(struct xmlsd_element *,
unsigned long long, unsigned long long,
const char **);
int xmlsd_elem_get_value_boolean(struct xmlsd_element *,
int *, int);
int xmlsd_elem_get_depth(struct xmlsd_element *);
struct xmlsd_element *xmlsd_elem_get_parent(struct xmlsd_element *);
struct xmlsd_attribute *xmlsd_elem_find_attr(struct xmlsd_element *,
const char *);
struct xmlsd_attribute *xmlsd_elem_get_first_attr(struct xmlsd_element *);
struct xmlsd_attribute *xmlsd_elem_get_next_attr(struct xmlsd_element *,
struct xmlsd_attribute *);
struct xmlsd_attribute *xmlsd_elem_get_last_attr(struct xmlsd_element *);
struct xmlsd_attribute *xmlsd_elem_get_previous_attr(struct xmlsd_element *,
struct xmlsd_attribute *);
#define XMLSD_ELEM_FOREACH_ATTR(attr, elem) \
for ((attr) = xmlsd_elem_get_first_attr(elem); \
(attr) != NULL; (attr) = xmlsd_elem_get_next_attr(elem, attr))
struct xmlsd_element *xmlsd_elem_find_child(struct xmlsd_element *,
const char *);
struct xmlsd_element *xmlsd_elem_get_first_child(struct xmlsd_element *);
struct xmlsd_element *xmlsd_elem_get_next_child(struct xmlsd_element *,
struct xmlsd_element *);
struct xmlsd_element *xmlsd_elem_get_last_child(struct xmlsd_element *);
struct xmlsd_element *xmlsd_elem_get_previous_child(struct xmlsd_element *,
struct xmlsd_element *);
#define XMLSD_ELEM_FOREACH_CHILDREN(child, elem) \
for ((child) = xmlsd_elem_get_first_child(elem); \
(child) != NULL; (child) = xmlsd_elem_get_next_child(elem, child))
/* attribute getting interface */
const char *xmlsd_elem_get_attr(struct xmlsd_element *,
const char *);
long long xmlsd_elem_get_attr_strtonum(struct xmlsd_element *,
const char *, long long, long long, const char **);
unsigned long long xmlsd_elem_get_attr_hexnum(struct xmlsd_element *,
const char *, unsigned long long,
unsigned long long, const char **);
/* XXX real bool? */
int xmlsd_elem_get_attr_boolean(struct xmlsd_element *,
const char *, int *, int);
/* element setting interface */
int xmlsd_elem_set_attr(struct xmlsd_element *, const char *, const char *);
int xmlsd_elem_set_attr_int32(struct xmlsd_element *, const char *, int32_t);
int xmlsd_elem_set_attr_uint32(struct xmlsd_element *, const char *, uint32_t);
int xmlsd_elem_set_attr_int64(struct xmlsd_element *, const char *, int64_t);
int xmlsd_elem_set_attr_uint64(struct xmlsd_element *, const char *, uint64_t);
int xmlsd_elem_set_attr_x32(struct xmlsd_element *, const char *, uint32_t);
int xmlsd_elem_set_attr_x64(struct xmlsd_element *, const char *, uint64_t);
int xmlsd_elem_set_value(struct xmlsd_element *, const char *);
int xmlsd_elem_set_value_int32(struct xmlsd_element *, int32_t);
int xmlsd_elem_set_value_uint32(struct xmlsd_element *, uint32_t);
int xmlsd_elem_set_value_int64(struct xmlsd_element *, int64_t);
int xmlsd_elem_set_value_uint64(struct xmlsd_element *, uint64_t);
int xmlsd_elem_set_value_x32(struct xmlsd_element *, uint32_t);
int xmlsd_elem_set_value_x64(struct xmlsd_element *, uint64_t);
void xmlsd_elem_free(struct xmlsd_element *);
/* not a fully qualified search */
/* XML document parsing and creation */
struct xmlsd_document;
int xmlsd_doc_alloc(struct xmlsd_document **);
void xmlsd_doc_clear(struct xmlsd_document *);
void xmlsd_doc_free(struct xmlsd_document *);
int xmlsd_doc_is_empty(struct xmlsd_document *);
struct xmlsd_element *xmlsd_doc_get_root(struct xmlsd_document *);
#define xmlsd_doc_get_first_elem(doc) xmlsd_doc_get_root(doc)
int xmlsd_parse_fileds(int, struct xmlsd_document *);
int xmlsd_parse_file(FILE *, struct xmlsd_document *);
int xmlsd_parse_mem(const char *, size_t,
struct xmlsd_document *);
#define XMLSD_GEN_ADD_HEADER 1
char *xmlsd_generate(struct xmlsd_document *xl, void *(*alloc_fn)(size_t),
size_t *, int);
struct xmlsd_element *xmlsd_doc_add_elem(struct xmlsd_document *,
struct xmlsd_element *, const char *);
void xmlsd_doc_remove_elem(struct xmlsd_document *,
struct xmlsd_element *);
/* validation */
int xmlsd_validate(struct xmlsd_document *,
struct xmlsd_v_elements *);
int xmlsd_validate_info(struct xmlsd_document *,
struct xmlsd_v_elements *,
struct xmlsd_validate_failure *);
char *xmlsd_get_validate_failure_string(
struct xmlsd_validate_failure *xvf);
enum xmlsd_validate_v_elements_failure
xmlsd_validate_v_elements(struct xmlsd_v_elements *cmds,
struct xmlsd_v_elements_validation *xvev);
char *
xmlsd_get_validate_v_elements_failure_string(
struct xmlsd_v_elements_validation *xvev);
#endif /* XMLSD_H */