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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
|
//
// Node get functions for Mini-XML, a small XML file parsing library.
//
// https://www.msweet.org/mxml
//
// Copyright © 2014-2024 by Michael R Sweet.
//
// Licensed under Apache License v2.0. See the file "LICENSE" for more
// information.
//
#include "mxml-private.h"
//
// 'mxmlGetCDATA()' - Get the value for a CDATA node.
//
// This function gets the string value of a CDATA node. `NULL` is returned if
// the node is not a CDATA element.
//
const char * // O - CDATA value or `NULL`
mxmlGetCDATA(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node || node->type != MXML_TYPE_CDATA)
return (NULL);
// Return the CDATA string...
return (node->value.cdata);
}
//
// 'mxmlGetComment()' - Get the value for a comment node.
//
// This function gets the string value of a comment node. `NULL` is returned
// if the node is not a comment.
//
const char * // O - Comment value or `NULL`
mxmlGetComment(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node || node->type != MXML_TYPE_COMMENT)
return (NULL);
// Return the comment string...
return (node->value.comment);
}
//
// 'mxmlGetCustom()' - Get the value for a custom node.
//
// This function gets the binary value of a custom node. `NULL` is returned if
// the node (or its first child) is not a custom value node.
//
const void * // O - Custom value or `NULL`
mxmlGetCustom(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (NULL);
// Return the custom value...
if (node->type == MXML_TYPE_CUSTOM)
return (node->value.custom.data);
else if (node->type == MXML_TYPE_ELEMENT && node->child && node->child->type == MXML_TYPE_CUSTOM)
return (node->child->value.custom.data);
else
return (NULL);
}
//
// 'mxmlGetDeclaration()' - Get the value for a declaration node.
//
// This function gets the string value of a declaraction node. `NULL` is
// returned if the node is not a declaration.
//
const char * // O - Declaraction value or `NULL`
mxmlGetDeclaration(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node || node->type != MXML_TYPE_DECLARATION)
return (NULL);
// Return the comment string...
return (node->value.declaration);
}
//
// 'mxmlGetDirective()' - Get the value for a processing instruction node.
//
// This function gets the string value of a processing instruction. `NULL` is
// returned if the node is not a processing instruction.
//
const char * // O - Comment value or `NULL`
mxmlGetDirective(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node || node->type != MXML_TYPE_DIRECTIVE)
return (NULL);
// Return the comment string...
return (node->value.directive);
}
//
// 'mxmlGetElement()' - Get the name for an element node.
//
// This function gets the name of an element node. `NULL` is returned if the
// node is not an element node.
//
const char * // O - Element name or `NULL`
mxmlGetElement(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node || node->type != MXML_TYPE_ELEMENT)
return (NULL);
// Return the element name...
return (node->value.element.name);
}
//
// 'mxmlGetFirstChild()' - Get the first child of a node.
//
// This function gets the first child of a node. `NULL` is returned if the node
// has no children.
//
mxml_node_t * // O - First child or `NULL`
mxmlGetFirstChild(mxml_node_t *node) // I - Node to get
{
// Return the first child node...
return (node ? node->child : NULL);
}
//
// 'mxmlGetInteger()' - Get the integer value from the specified node or its
// first child.
//
// This function gets the value of an integer node. `0` is returned if the node
// (or its first child) is not an integer value node.
//
long // O - Integer value or `0`
mxmlGetInteger(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (0);
// Return the integer value...
if (node->type == MXML_TYPE_INTEGER)
return (node->value.integer);
else if (node->type == MXML_TYPE_ELEMENT && node->child && node->child->type == MXML_TYPE_INTEGER)
return (node->child->value.integer);
else
return (0);
}
//
// 'mxmlGetLastChild()' - Get the last child of a node.
//
// This function gets the last child of a node. `NULL` is returned if the node
// has no children.
//
mxml_node_t * // O - Last child or `NULL`
mxmlGetLastChild(mxml_node_t *node) // I - Node to get
{
return (node ? node->last_child : NULL);
}
//
// 'mxmlGetNextSibling()' - Get the next node for the current parent.
//
// This function gets the next node for the current parent. `NULL` is returned
// if this is the last child for the current parent.
//
mxml_node_t *
mxmlGetNextSibling(mxml_node_t *node) // I - Node to get
{
return (node ? node->next : NULL);
}
//
// 'mxmlGetOpaque()' - Get an opaque string value for a node or its first child.
//
// This function gets the string value of an opaque node. `NULL` is returned if
// the node (or its first child) is not an opaque value node.
//
const char * // O - Opaque string or `NULL`
mxmlGetOpaque(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (NULL);
// Return the opaque value...
if (node->type == MXML_TYPE_OPAQUE)
return (node->value.opaque);
else if (node->type == MXML_TYPE_ELEMENT && node->child && node->child->type == MXML_TYPE_OPAQUE)
return (node->child->value.opaque);
else
return (NULL);
}
//
// 'mxmlGetParent()' - Get the parent node.
//
// This function gets the parent of a node. `NULL` is returned for a root node.
//
mxml_node_t * // O - Parent node or `NULL`
mxmlGetParent(mxml_node_t *node) // I - Node to get
{
return (node ? node->parent : NULL);
}
//
// 'mxmlGetPrevSibling()' - Get the previous node for the current parent.
//
// This function gets the previous node for the current parent. `NULL` is
// returned if this is the first child for the current parent.
//
mxml_node_t * // O - Previous node or `NULL`
mxmlGetPrevSibling(mxml_node_t *node) // I - Node to get
{
return (node ? node->prev : NULL);
}
//
// 'mxmlGetReal()' - Get the real value for a node or its first child.
//
// This function gets the value of a real value node. `0.0` is returned if the
// node (or its first child) is not a real value node.
//
double // O - Real value or 0.0
mxmlGetReal(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (0.0);
// Return the real value...
if (node->type == MXML_TYPE_REAL)
return (node->value.real);
else if (node->type == MXML_TYPE_ELEMENT && node->child && node->child->type == MXML_TYPE_REAL)
return (node->child->value.real);
else
return (0.0);
}
//
// 'mxmlGetText()' - Get the text value for a node or its first child.
//
// This function gets the string and whitespace values of a text node. `NULL`
// and `false` are returned if the node (or its first child) is not a text node.
// The `whitespace` argument can be `NULL` if you don't want to know the
// whitespace value.
//
// Note: Text nodes consist of whitespace-delimited words. You will only get
// single words of text when reading an XML file with `MXML_TYPE_TEXT` nodes.
// If you want the entire string between elements in the XML file, you MUST read
// the XML file with `MXML_TYPE_OPAQUE` nodes and get the resulting strings
// using the @link mxmlGetOpaque@ function instead.
//
const char * // O - Text string or `NULL`
mxmlGetText(mxml_node_t *node, // I - Node to get
bool *whitespace) // O - `true` if string is preceded by whitespace, `false` otherwise
{
// Range check input...
if (!node)
{
if (whitespace)
*whitespace = false;
return (NULL);
}
// Return the integer value...
if (node->type == MXML_TYPE_TEXT)
{
if (whitespace)
*whitespace = node->value.text.whitespace;
return (node->value.text.string);
}
else if (node->type == MXML_TYPE_ELEMENT && node->child && node->child->type == MXML_TYPE_TEXT)
{
if (whitespace)
*whitespace = node->child->value.text.whitespace;
return (node->child->value.text.string);
}
else
{
if (whitespace)
*whitespace = false;
return (NULL);
}
}
//
// 'mxmlGetType()' - Get the node type.
//
// This function gets the type of `node`. `MXML_TYPE_IGNORE` is returned if
// `node` is `NULL`.
//
mxml_type_t // O - Type of node
mxmlGetType(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (MXML_TYPE_IGNORE);
// Return the node type...
return (node->type);
}
//
// 'mxmlGetUserData()' - Get the user data pointer for a node.
//
// This function gets the user data pointer associated with `node`.
//
void * // O - User data pointer
mxmlGetUserData(mxml_node_t *node) // I - Node to get
{
// Range check input...
if (!node)
return (NULL);
// Return the user data pointer...
return (node->user_data);
}
|