/usr/include/xmltooling/util/XMLHelper.h is in libxmltooling-dev 1.6.4-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | /**
* Licensed to the University Corporation for Advanced Internet
* Development, Inc. (UCAID) under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* UCAID licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the
* License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*/
/**
* @file xmltooling/util/XMLHelper.h
*
* A helper class for working with W3C DOM objects.
*/
#ifndef __xmltooling_xmlhelper_h__
#define __xmltooling_xmlhelper_h__
#include <xmltooling/unicode.h>
#include <map>
#include <iostream>
#include <xercesc/dom/DOM.hpp>
namespace xmltooling {
class XMLTOOL_API QName;
class XMLTOOL_API XMLObject;
/**
* RAII wrapper for Xerces resources.
*/
template<class T> class XercesJanitor
{
MAKE_NONCOPYABLE(XercesJanitor);
T* m_held;
public:
/**
* Constructor
*
* @param resource object to release when leaving scope
*/
XercesJanitor(T* resource) : m_held(resource) {}
~XercesJanitor() {
if (m_held)
m_held->release();
}
/**
* Returns resource held by this object.
*
* @return the resource held or nullptr
*/
T* get() {
return m_held;
}
/**
* Returns resource held by this object.
*
* @return the resource held or nullptr
*/
T* operator->() {
return m_held;
}
/**
* Returns resource held by this object and releases it to the caller.
*
* @return the resource held or nullptr
*/
T* release() {
T* ret=m_held;
m_held=nullptr;
return ret;
}
};
/**
* A helper class for working with W3C DOM objects.
*/
class XMLTOOL_API XMLHelper
{
public:
/**
* Checks if the given element has an xsi:type defined for it
*
* @param e the DOM element
* @return true if there is a type, false if not
*/
static bool hasXSIType(const xercesc::DOMElement* e);
/**
* Gets the XSI type for a given element if it has one.
* <p>The caller is responsible for freeing the result.
*
* @param e the element
* @return the type or null
*/
static QName* getXSIType(const xercesc::DOMElement* e);
/**
* Gets the ID attribute of a DOM element.
*
* @param domElement the DOM element
* @return the ID attribute or null if there isn't one
*/
static xercesc::DOMAttr* getIdAttribute(const xercesc::DOMElement* domElement);
/**
* Attempts to locate an XMLObject from this point downward in the tree whose
* XML ID matches the supplied value.
*
* @param tree root of tree to search
* @param id ID value to locate
* @return XMLObject in the tree with a matching ID value, or nullptr
*/
static const XMLObject* getXMLObjectById(const XMLObject& tree, const XMLCh* id);
/**
* Attempts to locate an XMLObject from this point downward in the tree whose
* XML ID matches the supplied value.
*
* @param tree root of tree to search
* @param id ID value to locate
* @return XMLObject in the tree with a matching ID value, or nullptr
*/
static XMLObject* getXMLObjectById(XMLObject& tree, const XMLCh* id);
/**
* Returns the set of non-visibly-used namespace declarations found in a tree.
* <p>Each member of the set is a prefix/URI pair.
*
* @param tree root of tree to search
* @param prefixes container to store declarations
*/
static void getNonVisiblyUsedPrefixes(const XMLObject& tree, std::map<xstring,xstring>& prefixes);
/**
* Gets the QName for the given DOM node.
*
* @param domNode the DOM node
* @return the QName for the element or null if the element was null
*/
static QName* getNodeQName(const xercesc::DOMNode* domNode);
/**
* @deprecated
* Constructs a QName from an attribute's value.
* <p>The caller is responsible for freeing the result.
*
* @param attribute the attribute with a QName value
* @return a QName from an attribute's value, or null if the given attribute is null
*/
static QName* getAttributeValueAsQName(const xercesc::DOMAttr* attribute);
/**
* Constructs a QName from a node's value.
* <p>The caller is responsible for freeing the result.
*
* @param domNode the DOM node with a QName value
* @return a QName from a node's value, or null if the given node has no value
*/
static QName* getNodeValueAsQName(const xercesc::DOMNode* domNode);
/**
* Returns a boolean based on a node's value.
*
* @param domNode the DOM node with a boolean (1/0/true/false) value
* @param def value to return if the node is null/missing
* @return a bool value based on the node's value, or a default value
*/
static bool getNodeValueAsBool(const xercesc::DOMNode* domNode, bool def);
/**
* Appends the child Element to the parent Element,
* importing the child Element into the parent's Document if needed.
*
* @param parentElement the parent Element
* @param childElement the child Element
* @return the child Element that was added (may be an imported copy)
*/
static xercesc::DOMElement* appendChildElement(xercesc::DOMElement* parentElement, xercesc::DOMElement* childElement);
/**
* Checks the qualified name of a node.
*
* @param n node to check
* @param ns namespace to compare with
* @param local local name to compare with
* @return true iff the node's qualified name matches the other parameters
*/
static bool isNodeNamed(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* local);
/**
* Returns the first matching child element of the node if any.
*
* @param n node to check
* @param localName local name to compare with or nullptr for any match
* @return the first matching child node of type Element, or nullptr
*/
static xercesc::DOMElement* getFirstChildElement(const xercesc::DOMNode* n, const XMLCh* localName=nullptr);
/**
* Returns the last matching child element of the node if any.
*
* @param n node to check
* @param localName local name to compare with or nullptr for any match
* @return the last matching child node of type Element, or nullptr
*/
static xercesc::DOMElement* getLastChildElement(const xercesc::DOMNode* n, const XMLCh* localName=nullptr);
/**
* Returns the next matching sibling element of the node if any.
*
* @param n node to check
* @param localName local name to compare with or nullptr for any match
* @return the next matching sibling node of type Element, or nullptr
*/
static xercesc::DOMElement* getNextSiblingElement(const xercesc::DOMNode* n, const XMLCh* localName=nullptr);
/**
* Returns the previous matching sibling element of the node if any.
*
* @param n node to check
* @param localName local name to compare with or nullptr for any match
* @return the previous matching sibling node of type Element, or nullptr
*/
static xercesc::DOMElement* getPreviousSiblingElement(const xercesc::DOMNode* n, const XMLCh* localName=nullptr);
/**
* Returns the first matching child element of the node if any.
*
* @param n node to check
* @param ns namespace to compare with
* @param localName local name to compare with
* @return the first matching child node of type Element, or nullptr
*/
static xercesc::DOMElement* getFirstChildElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
/**
* Returns the last matching child element of the node if any.
*
* @param n node to check
* @param ns namespace to compare with
* @param localName local name to compare with
* @return the last matching child node of type Element, or nullptr
*/
static xercesc::DOMElement* getLastChildElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
/**
* Returns the next matching sibling element of the node if any.
*
* @param n node to check
* @param ns namespace to compare with
* @param localName local name to compare with
* @return the next matching sibling node of type Element, or nullptr
*/
static xercesc::DOMElement* getNextSiblingElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
/**
* Returns the previous matching sibling element of the node if any.
*
* @param n node to check
* @param ns namespace to compare with
* @param localName local name to compare with
* @return the previous matching sibling node of type Element, or nullptr
*/
static xercesc::DOMElement* getPreviousSiblingElement(const xercesc::DOMNode* n, const XMLCh* ns, const XMLCh* localName);
/**
* Returns the content of the first Text node found in the element, if any.
* This is roughly similar to the DOM getTextContent function, but only
* examines the immediate children of the element.
*
* @param e element to examine
* @return the content of the first Text node found, or nullptr
*/
static const XMLCh* getTextContent(const xercesc::DOMElement* e);
/**
* Returns the content of the specified attribute node as a string,
* or the default value, if the attribute is not present.
*
* @param e element to examine (may be nullptr)
* @param defValue default value to return
* @param localName local name of attribute
* @param ns namespace of attribute
* @return the specified attribute's value, or the specified default
*/
static std::string getAttrString(
const xercesc::DOMElement* e, const char* defValue, const XMLCh* localName, const XMLCh* ns=nullptr
);
/**
* Returns the content of the specified attribute node as an integer,
* or the default value, if the attribute is not present.
*
* @param e element to examine (may be nullptr)
* @param defValue default value to return
* @param localName local name of attribute
* @param ns namespace of attribute
* @return the specified attribute's value, or the specified default
*/
static int getAttrInt(
const xercesc::DOMElement* e, int defValue, const XMLCh* localName, const XMLCh* ns=nullptr
);
/**
* Returns the content of the specified attribute node as a boolean,
* or the default value, if the attribute is not present.
*
* @param e element to examine (may be nullptr)
* @param defValue default value to return
* @param localName local name of attribute
* @param ns namespace of attribute
* @return the specified attribute's value, or the specified default
*/
static bool getAttrBool(
const xercesc::DOMElement* e, bool defValue, const XMLCh* localName, const XMLCh* ns=nullptr
);
/**
*
* Returns the value of the attribute "caseSensitive" (if present). Also interogates
* the (deprecated) "ignoreCase" attribute, warning if it is encountered.
*
* @param e element to examine (may be nullptr)
* @param defValue default value to return
* @param ns namespace of attribute
* @return whatever "caseSensitive" or "ignoreCase" specifies, or the specified default
*/
static bool getCaseSensitive(
const xercesc::DOMElement* e, bool defValue, const XMLCh* ns=nullptr
);
/**
* Serializes the DOM node provided into a buffer using UTF-8 encoding and
* the default XML serializer available. No manipulation or formatting is applied.
*
* @param n node to serialize
* @param buf buffer to serialize element into
* @param pretty enable pretty printing if supported
*/
static void serialize(const xercesc::DOMNode* n, std::string& buf, bool pretty=false);
/**
* Serializes the DOM node provided to a stream using UTF-8 encoding and
* the default XML serializer available. No manipulation or formatting is applied.
*
* @param n node to serialize
* @param out stream to serialize element into
* @param pretty enable pretty printing if supported
* @return reference to output stream
*/
static std::ostream& serialize(const xercesc::DOMNode* n, std::ostream& out, bool pretty=false);
};
/**
* Serializes the DOM node provided to a stream using UTF-8 encoding and
* the default XML serializer available. No manipulation or formatting is applied.
*
* @param n node to serialize
* @param ostr stream to serialize element into
* @return reference to output stream
*/
extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const xercesc::DOMNode& n);
/**
* Marshalls and serializes the XMLObject provided to a stream using UTF-8 encoding and
* the default XML serializer available. No manipulation or formatting is applied.
*
* <p>The marshaller operation takes no parameters.
*
* @param obj object to serialize
* @param ostr stream to serialize object into
* @return reference to output stream
*/
extern XMLTOOL_API std::ostream& operator<<(std::ostream& ostr, const XMLObject& obj);
};
#endif /* __xmltooling_xmlhelper_h__ */
|