1 /* Copyright (c) 2007, 2008 by Adalin B.V.
2 * Copyright (c) 2007, 2008 by Erik Hofman
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of (any of) the copyrightholder(s) nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
17 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
18 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
19 * THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #define __XML_CONFIG 1
32 * Open an XML file for processing.
34 * @param fname path to the file
35 * @return XML-id which is used for further processing
37 void *xmlOpen(const char *);
40 * Close the XML file after which no further processing is possible.
44 void xmlClose(void *);
48 * Locate a subsection of the xml tree for further processing.
49 * This adds processing speed since the reuired nodes will only be searched
52 * The memory allocated for the XML-subsection-id has to be freed by the
56 * @param node path to the node containing the subsection
57 * @return XML-subsection-id for further processing
59 void *xmlNodeGet(const void *, const char *);
62 * Copy a subsection of the xml tree for further processing.
63 * This is useful when it's required to process a section of the XML code
64 * after the file has been closed. The drawback is the added memory
67 * The memory allocated for the XML-subsection-id has to be freed by the
71 * @param node path to the node containing the subsection
72 * @return XML-subsection-id for further processing
74 void *xmlNodeCopy(const void *, const char *);
78 * Return the name of this node.
79 * The returned string has to be freed by the calling process.
82 * @return a newly alocated string containing the node name
84 char *xmlNodeGetName(const void *);
87 * Copy the name of this node in a pre-allocated buffer.
90 * @param buffer the buffer to copy the string to
91 * @param buflen length of the destination buffer
92 * @return the length of the node name
94 size_t xmlNodeCopyName(const void *, char *, size_t);
98 * Create a marker XML-id that starts out with the same settings as the
101 * Marker id's are required when xmlNodeGetNum() and xmlNodeGetPos() are used
102 * to walk a number of nodes. The xmlNodeGetPos function adjusts the contents
103 * of the provided XML-id to keep track of it's position within the xml section.
104 * The returned XML-id is limited to the boundaries of the requested XML tag
105 * and has to be freed by the calling process.
107 * @param xid reference XML-id
108 * @return a copy of the reference XML-id
110 void *xmlMarkId(const void *);
113 * Get the number of nodes with the same name from a specified xml path.
116 * @param path path to the xml node
117 * @return the number count of the nodename
119 unsigned int xmlNodeGetNum(const void *, const char *);
122 * Get the nth occurrence of node in the parent node.
123 * The return value should never be altered or freed by the caller.
125 * @param pid XML-id of the parent node of this node
127 * @param node name of the node to search for
128 * @param num specify which occurence to return
129 * @return XML-subsection-id for further processing or NULL if unsuccessful
131 void *xmlNodeGetPos(const void *, void *, const char *, int);
135 * Get a string of characters from the current node.
136 * The returned string has to be freed by the calling process.
139 * @return a newly alocated string containing the contents of the node
141 char *xmlGetString(const void *);
144 * Get a string of characters from the current node.
145 * This function has the advantage of not allocating its own return buffer,
146 * keeping the memory management to an absolute minimum but the disadvantage
147 * is that it's unreliable in multithread environments.
150 * @param buffer the buffer to copy the string to
151 * @param buflen length of the destination buffer
152 * @return the length of the string
154 size_t xmlCopyString(const void *, char *, size_t);
157 * Compare the value of this node to a reference string.
158 * Comparing is done in a case insensitive way.
161 * @param str the string to compare to
162 * @return an integer less than, equal to, ro greater than zero if the value
163 * of the node is found, respectively, to be less than, to match, or be greater
166 int xmlCompareString(const void *, const char *);
169 * Get a string of characters from a specified xml path.
170 * The returned string has to be freed by the calling process.
173 * @param path path to the xml node
174 * @return a newly alocated string containing the contents of the node
176 char *xmlNodeGetString(const void *, const char *);
179 * Get a string of characters from a specified xml path.
180 * This function has the advantage of not allocating its own return buffer,
181 * keeping the memory management to an absolute minimum but the disadvantage
182 * is that it's unreliable in multithread environments.
185 * @param path path to the xml node
186 * @param buffer the buffer to copy the string to
187 * @param buflen length of the destination buffer
188 * @return the length of the string
190 size_t xmlNodeCopyString(const void *, const char *, char *, size_t);
193 * Compare the value of a node to a reference string.
194 * Comparing is done in a case insensitive way.
197 * @param path path to the xml node to compare to
198 * @param str the string to compare to
199 * @return an integer less than, equal to, ro greater than zero if the value
200 * of the node is found, respectively, to be less than, to match, or be greater
203 int xmlNodeCompareString(const void *, const char *, const char *);
206 * Get a string of characters from a named attribute.
207 * The returned string has to be freed by the calling process.
210 * @param name name of the attribute to acquire
211 * @return the contents of the node converted to an integer value
213 char *xmlAttributeGetString(const void *, const char *);
216 * Get a string of characters from a named attribute.
217 * This function has the advantage of not allocating its own return buffer,
218 * keeping the memory management to an absolute minimum but the disadvantage
219 * is that it's unreliable in multithread environments.
222 * @param name name of the attribute to acquire.
223 * @param buffer the buffer to copy the string to
224 * @param buflen length of the destination buffer
225 * @return the length of the string
226 size_t xmlAttributeCopyString(const void *, const char *, const char *, size_t);
229 * Compare the value of an attribute to a reference string.
230 * Comparing is done in a case insensitive way.
233 * @param name name of the attribute to acquire.
234 * @param str the string to compare to
235 * @return an integer less than, equal to, ro greater than zero if the value
236 * of the node is found, respectively, to be less than, to match, or be greater
238 int xmlAttributeCompareString(const void *, const char *, const char *);
242 * Get the integer value from the current node/
245 * @return the contents of the node converted to an integer value
247 long int xmlGetInt(const void *);
250 * Get an integer value from a specified xml path.
253 * @param path path to the xml node
254 * @return the contents of the node converted to an integer value
256 long int xmlNodeGetInt(const void *, const char *);
259 * Get the integer value from the named attribute.
262 * @param name name of the attribute to acquire
263 * @return the contents of the node converted to an integer value
265 long int xmlAttributeGetInt(const void *, const char *);
269 * Get the double value from the curent node/
272 * @return the contents of the node converted to a double value
274 double xmlGetDouble(const void *);
277 * Get a double value from a specified xml path/
280 * @param path path to the xml node
281 * @return the contents of the node converted to a double value
283 double xmlNodeGetDouble(const void *, const char *);
287 * Get the double value from the named attribute.
290 * @param name name of the attribute to acquire
291 * @return the contents of the node converted to an integer value
293 double xmlAttributeGetDouble(const void *, const char *);
295 #endif /* __XML_CONFIG */