xref: /dflybsd-src/contrib/wpa_supplicant/src/utils/xml-utils.h (revision 3a84a4273475ed07d0ab1c2dfeffdfedef35d9cd)
1*a1157835SDaniel Fojt /*
2*a1157835SDaniel Fojt  * Generic XML helper functions
3*a1157835SDaniel Fojt  * Copyright (c) 2012-2013, Qualcomm Atheros, Inc.
4*a1157835SDaniel Fojt  *
5*a1157835SDaniel Fojt  * This software may be distributed under the terms of the BSD license.
6*a1157835SDaniel Fojt  * See README for more details.
7*a1157835SDaniel Fojt  */
8*a1157835SDaniel Fojt 
9*a1157835SDaniel Fojt #ifndef XML_UTILS_H
10*a1157835SDaniel Fojt #define XML_UTILS_H
11*a1157835SDaniel Fojt 
12*a1157835SDaniel Fojt struct xml_node_ctx;
13*a1157835SDaniel Fojt typedef struct xml_node xml_node_t;
14*a1157835SDaniel Fojt typedef struct xml_namespace_foo xml_namespace_t;
15*a1157835SDaniel Fojt 
16*a1157835SDaniel Fojt /* XML library wrappers */
17*a1157835SDaniel Fojt 
18*a1157835SDaniel Fojt int xml_validate(struct xml_node_ctx *ctx, xml_node_t *node,
19*a1157835SDaniel Fojt 		 const char *xml_schema_fname, char **ret_err);
20*a1157835SDaniel Fojt int xml_validate_dtd(struct xml_node_ctx *ctx, xml_node_t *node,
21*a1157835SDaniel Fojt 		     const char *dtd_fname, char **ret_err);
22*a1157835SDaniel Fojt void xml_node_free(struct xml_node_ctx *ctx, xml_node_t *node);
23*a1157835SDaniel Fojt xml_node_t * xml_node_get_parent(struct xml_node_ctx *ctx, xml_node_t *node);
24*a1157835SDaniel Fojt xml_node_t * xml_node_from_buf(struct xml_node_ctx *ctx, const char *buf);
25*a1157835SDaniel Fojt const char * xml_node_get_localname(struct xml_node_ctx *ctx,
26*a1157835SDaniel Fojt 				    xml_node_t *node);
27*a1157835SDaniel Fojt char * xml_node_to_str(struct xml_node_ctx *ctx, xml_node_t *node);
28*a1157835SDaniel Fojt void xml_node_detach(struct xml_node_ctx *ctx, xml_node_t *node);
29*a1157835SDaniel Fojt void xml_node_add_child(struct xml_node_ctx *ctx, xml_node_t *parent,
30*a1157835SDaniel Fojt 			xml_node_t *child);
31*a1157835SDaniel Fojt xml_node_t * xml_node_create_root(struct xml_node_ctx *ctx, const char *ns_uri,
32*a1157835SDaniel Fojt 				  const char *ns_prefix,
33*a1157835SDaniel Fojt 				  xml_namespace_t **ret_ns, const char *name);
34*a1157835SDaniel Fojt xml_node_t * xml_node_create(struct xml_node_ctx *ctx, xml_node_t *parent,
35*a1157835SDaniel Fojt 			     xml_namespace_t *ns, const char *name);
36*a1157835SDaniel Fojt xml_node_t * xml_node_create_text(struct xml_node_ctx *ctx,
37*a1157835SDaniel Fojt 				  xml_node_t *parent, xml_namespace_t *ns,
38*a1157835SDaniel Fojt 				  const char *name, const char *value);
39*a1157835SDaniel Fojt xml_node_t * xml_node_create_text_ns(struct xml_node_ctx *ctx,
40*a1157835SDaniel Fojt 				     xml_node_t *parent, const char *ns_uri,
41*a1157835SDaniel Fojt 				     const char *name, const char *value);
42*a1157835SDaniel Fojt void xml_node_set_text(struct xml_node_ctx *ctx, xml_node_t *node,
43*a1157835SDaniel Fojt 		       const char *value);
44*a1157835SDaniel Fojt int xml_node_add_attr(struct xml_node_ctx *ctx, xml_node_t *node,
45*a1157835SDaniel Fojt 		      xml_namespace_t *ns, const char *name, const char *value);
46*a1157835SDaniel Fojt char * xml_node_get_attr_value(struct xml_node_ctx *ctx, xml_node_t *node,
47*a1157835SDaniel Fojt 			       char *name);
48*a1157835SDaniel Fojt char * xml_node_get_attr_value_ns(struct xml_node_ctx *ctx, xml_node_t *node,
49*a1157835SDaniel Fojt 				  const char *ns_uri, char *name);
50*a1157835SDaniel Fojt void xml_node_get_attr_value_free(struct xml_node_ctx *ctx, char *val);
51*a1157835SDaniel Fojt xml_node_t * xml_node_first_child(struct xml_node_ctx *ctx,
52*a1157835SDaniel Fojt 				  xml_node_t *parent);
53*a1157835SDaniel Fojt xml_node_t * xml_node_next_sibling(struct xml_node_ctx *ctx,
54*a1157835SDaniel Fojt 				   xml_node_t *node);
55*a1157835SDaniel Fojt int xml_node_is_element(struct xml_node_ctx *ctx, xml_node_t *node);
56*a1157835SDaniel Fojt char * xml_node_get_text(struct xml_node_ctx *ctx, xml_node_t *node);
57*a1157835SDaniel Fojt void xml_node_get_text_free(struct xml_node_ctx *ctx, char *val);
58*a1157835SDaniel Fojt char * xml_node_get_base64_text(struct xml_node_ctx *ctx, xml_node_t *node,
59*a1157835SDaniel Fojt 				int *ret_len);
60*a1157835SDaniel Fojt xml_node_t * xml_node_copy(struct xml_node_ctx *ctx, xml_node_t *node);
61*a1157835SDaniel Fojt 
62*a1157835SDaniel Fojt #define xml_node_for_each_child(ctx, child, parent) \
63*a1157835SDaniel Fojt for (child = xml_node_first_child(ctx, parent); \
64*a1157835SDaniel Fojt      child; \
65*a1157835SDaniel Fojt      child = xml_node_next_sibling(ctx, child))
66*a1157835SDaniel Fojt 
67*a1157835SDaniel Fojt #define xml_node_for_each_sibling(ctx, node) \
68*a1157835SDaniel Fojt for (; \
69*a1157835SDaniel Fojt      node; \
70*a1157835SDaniel Fojt      node = xml_node_next_sibling(ctx, node))
71*a1157835SDaniel Fojt 
72*a1157835SDaniel Fojt #define xml_node_for_each_check(ctx, child) \
73*a1157835SDaniel Fojt if (!xml_node_is_element(ctx, child)) \
74*a1157835SDaniel Fojt 	continue
75*a1157835SDaniel Fojt 
76*a1157835SDaniel Fojt 
77*a1157835SDaniel Fojt struct xml_node_ctx * xml_node_init_ctx(void *upper_ctx,
78*a1157835SDaniel Fojt 					const void *env);
79*a1157835SDaniel Fojt void xml_node_deinit_ctx(struct xml_node_ctx *ctx);
80*a1157835SDaniel Fojt 
81*a1157835SDaniel Fojt 
82*a1157835SDaniel Fojt xml_node_t * get_node_uri(struct xml_node_ctx *ctx, xml_node_t *root,
83*a1157835SDaniel Fojt 			  const char *uri);
84*a1157835SDaniel Fojt xml_node_t * get_node(struct xml_node_ctx *ctx, xml_node_t *root,
85*a1157835SDaniel Fojt 		      const char *path);
86*a1157835SDaniel Fojt xml_node_t * get_child_node(struct xml_node_ctx *ctx, xml_node_t *root,
87*a1157835SDaniel Fojt 			    const char *path);
88*a1157835SDaniel Fojt xml_node_t * node_from_file(struct xml_node_ctx *ctx, const char *name);
89*a1157835SDaniel Fojt int node_to_file(struct xml_node_ctx *ctx, const char *fname, xml_node_t *node);
90*a1157835SDaniel Fojt xml_node_t * mo_to_tnds(struct xml_node_ctx *ctx, xml_node_t *mo,
91*a1157835SDaniel Fojt 			int use_path, const char *urn, const char *ns_uri);
92*a1157835SDaniel Fojt xml_node_t * tnds_to_mo(struct xml_node_ctx *ctx, xml_node_t *tnds);
93*a1157835SDaniel Fojt 
94*a1157835SDaniel Fojt xml_node_t * soap_build_envelope(struct xml_node_ctx *ctx, xml_node_t *node);
95*a1157835SDaniel Fojt xml_node_t * soap_get_body(struct xml_node_ctx *ctx, xml_node_t *soap);
96*a1157835SDaniel Fojt 
97*a1157835SDaniel Fojt #endif /* XML_UTILS_H */
98