/usr/include/xmltooling/XMLObject.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 | /**
* 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/XMLObject.h
*
* Abstract interface to objects that can be manipulated in and out of XML form.
*/
#ifndef __xmltooling_xmlobj_h__
#define __xmltooling_xmlobj_h__
#include <xmltooling/Namespace.h>
#include <xmltooling/util/XMLConstants.h>
#include <set>
#include <list>
#include <vector>
#include <xercesc/dom/DOM.hpp>
#ifndef XMLTOOLING_NO_XMLSEC
namespace xmlsignature {
class XMLTOOL_API Signature;
};
#endif
#if defined (_MSC_VER)
#pragma warning( push )
#pragma warning( disable : 4250 4251 )
#endif
namespace xmltooling {
#ifndef XMLTOOLING_NO_XMLSEC
class XMLTOOL_API Credential;
#endif
class XMLTOOL_API QName;
/**
* Object that represents an XML Element that has been unmarshalled into this C++ object.
*/
class XMLTOOL_API XMLObject
{
public:
virtual ~XMLObject();
/**
* Creates a copy of the object, along with all of its children.
*
* The new object tree will be completely distinct and independent of
* the original in all respects.
*/
virtual XMLObject* clone() const=0;
/**
* Specialized function for detaching a child object from its parent
* <strong>while disposing of the parent</strong>.
*
* This is not a generic way of detaching any child object, but only of
* pruning a single child from the root of an XMLObject tree. If the
* detached XMLObject's parent is itself a child, an exception will be
* thrown. It's mainly useful for turning a child into the new root of
* the tree without having to clone the child.
*/
virtual void detach()=0;
/**
* Gets the QName for this element. This QName <strong>MUST</strong>
* contain the namespace URI, namespace prefix, and local element name.
*
* @return constant reference to the QName for this object
*/
virtual const QName& getElementQName() const=0;
/**
* Gets the namespaces that are scoped to this element.
*
* The caller MUST NOT modify the set returned, but may use any
* non-modifying operations or algorithms on it. Iterators will
* remain valid unless the set member referenced is removed using
* the removeNamespace method.
*
* @return the namespaces that are scoped to this element
*/
virtual const std::set<Namespace>& getNamespaces() const=0;
/**
* Adds a namespace to the ones already scoped to this element
*
* @param ns the namespace to add
*/
virtual void addNamespace(const Namespace& ns) const=0;
/**
* Removes a namespace from this element
*
* @param ns the namespace to remove
*/
virtual void removeNamespace(const Namespace& ns)=0;
/**
* Gets the XML schema type of this element. This translates to contents the xsi:type
* attribute for the element.
*
* @return XML schema type of this element
*/
virtual const QName* getSchemaType() const=0;
/**
* Gets the value of the ID attribute set on this object, if any.
*
* @return an ID value or nullptr
*/
virtual const XMLCh* getXMLID() const=0;
/**
* Returns the xml:lang property of the object, if any.
*
* @return an xml:lang value, or nullptr
*/
virtual const XMLCh* getLang() const;
/**
* Returns the xsi:nil property of the object, or false if not set.
*
* @return the xsi:nil property
*/
bool nil() const {
switch (getNil()) {
case xmlconstants::XML_BOOL_TRUE:
case xmlconstants::XML_BOOL_ONE:
return true;
case xmlconstants::XML_BOOL_FALSE:
case xmlconstants::XML_BOOL_ZERO:
default:
return false;
}
}
/**
* Returns the xsi:nil property as an explicit enumerated value.
*
* @return the xsi:nil property
*/
virtual xmlconstants::xmltooling_bool_t getNil() const=0;
/**
* Sets the xsi:nil property using an enumerated value.
*
* @param value value to set
*/
virtual void nil(xmlconstants::xmltooling_bool_t value)=0;
/**
* Sets the xsi:nil property.
*
* @param value value to set
*/
void nil(bool value) {
nil(value ? xmlconstants::XML_BOOL_ONE : xmlconstants::XML_BOOL_ZERO);
}
/**
* Sets the xsi:nil property using a string constant.
*
* @param value value to set
*/
void setNil(const XMLCh* value);
/**
* Checks to see if this object has a parent.
*
* @return true if the object has a parent, false if not
*/
virtual bool hasParent() const=0;
/**
* Gets the parent of this element or null if there is no parent.
*
* @return the parent of this element or null
*/
virtual XMLObject* getParent() const=0;
/**
* Sets the parent of this element.
*
* @param parent the parent of this element
*/
virtual void setParent(XMLObject* parent)=0;
/**
* Checks if this XMLObject has children.
*
* @return true if this XMLObject has children, false if not
*/
virtual bool hasChildren() const=0;
/**
* Returns an unmodifiable list of child objects in the order that they
* should appear in the serialized representation.
*
* The validity of the returned list is not maintained if any non-const
* operations are performed on the parent object.
*
* @return the list of children
*/
virtual const std::list<XMLObject*>& getOrderedChildren() const=0;
/**
* Used by a child's detach method to isolate the child from
* this parent object in preparation for destroying the parent
* (this object).
*
* @param child the child object to remove
*/
virtual void removeChild(XMLObject* child)=0;
/**
* Returns the text content at the specified position relative to
* any child elements. A zero represents leading text, 1 comes after
* the first child, and so forth.
*
* @param position the relative child element position of the text
* @return the designated text value
*/
virtual const XMLCh* getTextContent(unsigned int position=0) const=0;
/**
* Sets (or clears) text content relative to a child element's position.
*
* @param value value to set, or nullptr to clear
* @param position position relative to child element
*/
virtual void setTextContent(const XMLCh* value, unsigned int position=0)=0;
/**
* Gets the DOM representation of this XMLObject, if one exists.
*
* @return the DOM representation of this XMLObject
*/
virtual xercesc::DOMElement* getDOM() const=0;
/**
* Sets the DOM representation of this XMLObject.
*
* @param dom DOM representation of this XMLObject
* @param bindDocument true if the object should take ownership of the associated Document
*/
virtual void setDOM(xercesc::DOMElement* dom, bool bindDocument=false) const=0;
/**
* Assigns ownership of a DOM document to the XMLObject.
* This binds the lifetime of the document to the lifetime of the object.
*
* @param doc DOM document bound to this object
*/
virtual void setDocument(xercesc::DOMDocument* doc) const=0;
/**
* Releases the DOM representation of this XMLObject, if there is one.
*/
virtual void releaseDOM() const=0;
/**
* Releases the DOM representation of this XMLObject's parent.
*
* @param propagateRelease true if all ancestors of this element should release their DOM
*/
virtual void releaseParentDOM(bool propagateRelease=true) const=0;
/**
* Releases the DOM representation of this XMLObject's children.
*
* @param propagateRelease true if all descendants of this element should release their DOM
*/
virtual void releaseChildrenDOM(bool propagateRelease=true) const=0;
/**
* A convenience method that is equal to calling releaseDOM() then releaseParentDOM(true).
*/
void releaseThisandParentDOM() const;
/**
* A convenience method that is equal to calling releaseChildrenDOM(true) then releaseDOM().
*/
void releaseThisAndChildrenDOM() const;
/**
* Marshalls the XMLObject, and its children, into a DOM element.
* If a document is supplied, then it will be used to create the resulting elements.
* If the document does not have a Document Element set, then the resulting
* element will be set as the Document Element. If no document is supplied, then
* a new document will be created and bound to the lifetime of the root object being
* marshalled, unless an existing DOM can be reused without creating a new document.
*
* @param document the DOM document the marshalled element will be placed in, or nullptr
* @param sigs ordered array of signatures to create after marshalling is complete
* @param credential optional credential to supply signing key and related info
* @return the DOM element representing this XMLObject
*
* @throws MarshallingException thrown if there is a problem marshalling the given object
* @throws SignatureException thrown if a problem occurs during signature creation
*/
virtual xercesc::DOMElement* marshall(
xercesc::DOMDocument* document=nullptr
#ifndef XMLTOOLING_NO_XMLSEC
,const std::vector<xmlsignature::Signature*>* sigs=nullptr
,const Credential* credential=nullptr
#endif
) const=0;
/**
* Marshalls the XMLObject and appends it as a child of the given parent element.
*
* <strong>NOTE:</strong> The given Element must be within a DOM tree rooted in
* the Document owning the given Element.
*
* @param parentElement the parent element to append the resulting DOM tree
* @param sigs ordered array of signatures to create after marshalling is complete
* @param credential optional credential to supply signing key and related info
* @return the marshalled element tree
* @throws MarshallingException thrown if the given XMLObject can not be marshalled.
* @throws SignatureException thrown if a problem occurs during signature creation
*/
virtual xercesc::DOMElement* marshall(
xercesc::DOMElement* parentElement
#ifndef XMLTOOLING_NO_XMLSEC
,const std::vector<xmlsignature::Signature*>* sigs=nullptr
,const Credential* credential=nullptr
#endif
) const=0;
/**
* Unmarshalls the given W3C DOM element into the XMLObject.
* The root of a given XML construct should be unmarshalled with the bindDocument parameter
* set to true.
*
* @param element the DOM element to unmarshall
* @param bindDocument true iff the resulting XMLObject should take ownership of the DOM's Document
*
* @return the unmarshalled XMLObject
*
* @throws UnmarshallingException thrown if an error occurs unmarshalling the DOM element into the XMLObject
*/
virtual XMLObject* unmarshall(xercesc::DOMElement* element, bool bindDocument=false)=0;
protected:
XMLObject();
private:
XMLObject& operator=(const XMLObject& src);
};
};
#if defined (_MSC_VER)
#pragma warning( pop )
#endif
#endif /* __xmltooling_xmlobj_h__ */
|