Mercurial > pidgin
comparison libgaim/xmlnode.h @ 14192:60b1bc8dbf37
[gaim-migrate @ 16863]
Renamed 'core' to 'libgaim'
committer: Tailor Script <tailor@pidgin.im>
author | Evan Schoenberg <evan.s@dreskin.net> |
---|---|
date | Sat, 19 Aug 2006 01:50:10 +0000 |
parents | |
children | 2d7086454b08 |
comparison
equal
deleted
inserted
replaced
14191:009db0b357b5 | 14192:60b1bc8dbf37 |
---|---|
1 /** | |
2 * @file xmlnode.h XML DOM functions | |
3 * @ingroup core | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_XMLNODE_H_ | |
26 #define _GAIM_XMLNODE_H_ | |
27 | |
28 /** | |
29 * The valid types for an xmlnode | |
30 */ | |
31 typedef enum _XMLNodeType | |
32 { | |
33 XMLNODE_TYPE_TAG, /**< Just a tag */ | |
34 XMLNODE_TYPE_ATTRIB, /**< Has attributes */ | |
35 XMLNODE_TYPE_DATA /**< Has data */ | |
36 } XMLNodeType; | |
37 | |
38 /** | |
39 * An xmlnode. | |
40 */ | |
41 typedef struct _xmlnode | |
42 { | |
43 char *name; /**< The name of the node. */ | |
44 #ifdef HAVE_LIBXML | |
45 char *namespace; /**< The namespace of the node */ | |
46 #endif | |
47 XMLNodeType type; /**< The type of the node. */ | |
48 char *data; /**< The data for the node. */ | |
49 size_t data_sz; /**< The size of the data. */ | |
50 struct _xmlnode *parent; /**< The parent node or @c NULL.*/ | |
51 struct _xmlnode *child; /**< The child node or @c NULL.*/ | |
52 struct _xmlnode *lastchild; /**< The last child node or @c NULL.*/ | |
53 struct _xmlnode *next; /**< The next node or @c NULL. */ | |
54 } xmlnode; | |
55 | |
56 /** | |
57 * Creates a new xmlnode. | |
58 * | |
59 * @param name The name of the node. | |
60 * | |
61 * @return The new node. | |
62 */ | |
63 xmlnode *xmlnode_new(const char *name); | |
64 | |
65 /** | |
66 * Creates a new xmlnode child. | |
67 * | |
68 * @param parent The parent node. | |
69 * @param name The name of the child node. | |
70 * | |
71 * @return The new child node. | |
72 */ | |
73 xmlnode *xmlnode_new_child(xmlnode *parent, const char *name); | |
74 | |
75 /** | |
76 * Inserts a node into a node as a child. | |
77 * | |
78 * @param parent The parent node to insert child into. | |
79 * @param child The child node to insert into parent. | |
80 */ | |
81 void xmlnode_insert_child(xmlnode *parent, xmlnode *child); | |
82 | |
83 /** | |
84 * Gets a child node named name. | |
85 * | |
86 * @param parent The parent node. | |
87 * @param name The child's name. | |
88 * | |
89 * @return The child or NULL. | |
90 */ | |
91 xmlnode *xmlnode_get_child(const xmlnode *parent, const char *name); | |
92 | |
93 /** | |
94 * Gets a child node named name in a namespace. | |
95 * | |
96 * @param parent The parent node. | |
97 * @param name The child's name. | |
98 * @param xmlns The namespace. | |
99 * | |
100 * @return The child or NULL. | |
101 */ | |
102 xmlnode *xmlnode_get_child_with_namespace(const xmlnode *parent, const char *name, const char *xmlns); | |
103 | |
104 /** | |
105 * Gets the next node with the same name as node. | |
106 * | |
107 * @param node The node of a twin to find. | |
108 * | |
109 * @return The twin of node or NULL. | |
110 */ | |
111 xmlnode *xmlnode_get_next_twin(xmlnode *node); | |
112 | |
113 /** | |
114 * Inserts data into a node. | |
115 * | |
116 * @param node The node to insert data into. | |
117 * @param data The data to insert. | |
118 * @param size The size of the data to insert. If data is | |
119 * null-terminated you can pass in -1. | |
120 */ | |
121 void xmlnode_insert_data(xmlnode *node, const char *data, gssize size); | |
122 | |
123 /** | |
124 * Gets data from a node. | |
125 * | |
126 * @param node The node to get data from. | |
127 * | |
128 * @return The data from the node. You must g_free | |
129 * this string when finished using it. | |
130 */ | |
131 char *xmlnode_get_data(xmlnode *node); | |
132 | |
133 /** | |
134 * Sets an attribute for a node. | |
135 * | |
136 * @param node The node to set an attribute for. | |
137 * @param attr The name of the attribute. | |
138 * @param value The value of the attribute. | |
139 */ | |
140 void xmlnode_set_attrib(xmlnode *node, const char *attr, const char *value); | |
141 | |
142 /** | |
143 * Gets an attribute from a node. | |
144 * | |
145 * @param node The node to get an attribute from. | |
146 * @param attr The attribute to get. | |
147 * | |
148 * @return The value of the attribute. | |
149 */ | |
150 const char *xmlnode_get_attrib(xmlnode *node, const char *attr); | |
151 | |
152 /** | |
153 * Removes an attribute from a node. | |
154 * | |
155 * @param node The node to remove an attribute from. | |
156 * @param attr The attribute to remove. | |
157 */ | |
158 void xmlnode_remove_attrib(xmlnode *node, const char *attr); | |
159 | |
160 /** | |
161 * Sets the namespace of a node | |
162 * | |
163 * @param node The node to qualify | |
164 * @param xmlns The namespace of the node | |
165 */ | |
166 void xmlnode_set_namespace(xmlnode *node, const char *xmlns); | |
167 | |
168 /** | |
169 * Returns the namespace of a node | |
170 * | |
171 * @param node The node to get the namepsace from | |
172 * @return The namespace of this node | |
173 */ | |
174 const char *xmlnode_get_namespace(xmlnode *node); | |
175 | |
176 /** | |
177 * Returns the node in a string of xml. | |
178 * | |
179 * @param node The starting node to output. | |
180 * @param len Address for the size of the string. | |
181 * | |
182 * @return The node represented as a string. You must | |
183 * g_free this string when finished using it. | |
184 */ | |
185 char *xmlnode_to_str(xmlnode *node, int *len); | |
186 | |
187 /** | |
188 * Returns the node in a string of human readable xml. | |
189 * | |
190 * @param node The starting node to output. | |
191 * @param len Address for the size of the string. | |
192 * | |
193 * @return The node as human readable string including | |
194 * tab and new line characters. You must | |
195 * g_free this string when finished using it. | |
196 */ | |
197 char *xmlnode_to_formatted_str(xmlnode *node, int *len); | |
198 | |
199 /** | |
200 * Creates a node from a string of XML. Calling this on the | |
201 * root node of an XML document will parse the entire document | |
202 * into a tree of nodes, and return the xmlnode of the root. | |
203 * | |
204 * @param str The string of xml. | |
205 * @param size The size of the string, or -1 if @a str is | |
206 * NUL-terminated. | |
207 * | |
208 * @return The new node. | |
209 */ | |
210 xmlnode *xmlnode_from_str(const char *str, gssize size); | |
211 | |
212 /** | |
213 * Creates a new node from the source node. | |
214 * | |
215 * @param src The node to copy. | |
216 * | |
217 * @return A new copy of the src node. | |
218 */ | |
219 xmlnode *xmlnode_copy(xmlnode *src); | |
220 | |
221 /** | |
222 * Frees a node and all of it's children. | |
223 * | |
224 * @param node The node to free. | |
225 */ | |
226 void xmlnode_free(xmlnode *node); | |
227 | |
228 #endif /* _GAIM_XMLNODE_H_ */ |