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