2 * Copyright 2001-2007 Internet2
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 * A helper class for working with W3C DOM objects.
24 #include "exceptions.h"
25 #include "util/XMLHelper.h"
26 #include "util/XMLConstants.h"
28 #include <xercesc/framework/MemBufFormatTarget.hpp>
29 #include <xercesc/util/XMLUniDefs.hpp>
31 using namespace xmltooling;
34 static const XMLCh type[]={chLatin_t, chLatin_y, chLatin_p, chLatin_e, chNull };
36 bool XMLHelper::hasXSIType(const DOMElement* e)
39 if (e->hasAttributeNS(xmlconstants::XSI_NS, type)) {
47 QName* XMLHelper::getXSIType(const DOMElement* e)
49 DOMAttr* attribute = e->getAttributeNodeNS(xmlconstants::XSI_NS, type);
51 const XMLCh* attributeValue = attribute->getTextContent();
52 if (attributeValue && *attributeValue) {
54 if ((i=XMLString::indexOf(attributeValue,chColon))>0) {
55 XMLCh* prefix=new XMLCh[i+1];
56 XMLString::subString(prefix,attributeValue,0,i);
58 QName* ret=new QName(e->lookupNamespaceURI(prefix), attributeValue + i + 1, prefix);
63 return new QName(e->lookupNamespaceURI(&chNull), attributeValue);
71 DOMAttr* XMLHelper::getIdAttribute(const DOMElement* domElement)
73 if(!domElement->hasAttributes()) {
77 DOMNamedNodeMap* attributes = domElement->getAttributes();
79 for(XMLSize_t i = 0; i < attributes->getLength(); i++) {
80 attribute = static_cast<DOMAttr*>(attributes->item(i));
81 if(attribute->isId()) {
89 const XMLObject* XMLHelper::getXMLObjectById(const XMLObject& tree, const XMLCh* id)
91 if (XMLString::equals(id, tree.getXMLID()))
95 const list<XMLObject*>& children = tree.getOrderedChildren();
96 for (list<XMLObject*>::const_iterator i=children.begin(); i!=children.end(); ++i) {
98 ret = getXMLObjectById(*(*i), id);
107 QName* XMLHelper::getNodeQName(const DOMNode* domNode)
110 return new QName(domNode->getNamespaceURI(), domNode->getLocalName(), domNode->getPrefix());
114 QName* XMLHelper::getAttributeValueAsQName(const DOMAttr* attribute)
120 const XMLCh* attributeValue=attribute->getTextContent();
121 if (attributeValue && (i=XMLString::indexOf(attributeValue,chColon))>0) {
122 XMLCh* prefix=new XMLCh[i+1];
123 XMLString::subString(prefix,attributeValue,0,i);
125 QName* ret=new QName(attribute->lookupNamespaceURI(prefix), attributeValue + i + 1, prefix);
130 return new QName(attribute->lookupNamespaceURI(NULL), attributeValue);
133 DOMElement* XMLHelper::appendChildElement(DOMElement* parentElement, DOMElement* childElement)
135 DOMDocument* parentDocument = parentElement->getOwnerDocument();
136 if (childElement->getOwnerDocument() != parentDocument) {
137 childElement = static_cast<DOMElement*>(parentDocument->importNode(childElement, true));
140 parentElement->appendChild(childElement);
144 const XMLCh* XMLHelper::getTextContent(const DOMElement* e)
146 DOMNode* child=e->getFirstChild();
148 if (child->getNodeType()==DOMNode::TEXT_NODE)
149 return child->getNodeValue();
150 child=child->getNextSibling();
155 DOMElement* XMLHelper::getFirstChildElement(const DOMNode* n, const XMLCh* localName)
157 DOMNode* child = n->getFirstChild();
158 while (child && child->getNodeType() != DOMNode::ELEMENT_NODE)
159 child = child->getNextSibling();
160 if (child && localName) {
161 if (!XMLString::equals(localName,child->getLocalName()))
162 return getNextSiblingElement(child, localName);
164 return static_cast<DOMElement*>(child);
167 DOMElement* XMLHelper::getLastChildElement(const DOMNode* n, const XMLCh* localName)
169 DOMNode* child = n->getLastChild();
170 while (child && child->getNodeType() != DOMNode::ELEMENT_NODE)
171 child = child->getPreviousSibling();
172 if (child && localName) {
173 if (!XMLString::equals(localName,child->getLocalName()))
174 return getPreviousSiblingElement(child, localName);
176 return static_cast<DOMElement*>(child);
179 DOMElement* XMLHelper::getFirstChildElement(const DOMNode* n, const XMLCh* ns, const XMLCh* localName)
181 DOMElement* e = getFirstChildElement(n, localName);
182 while (e && !XMLString::equals(e->getNamespaceURI(),ns))
183 e = getNextSiblingElement(e, localName);
187 DOMElement* XMLHelper::getLastChildElement(const DOMNode* n, const XMLCh* ns, const XMLCh* localName)
189 DOMElement* e = getLastChildElement(n, localName);
190 while (e && !XMLString::equals(e->getNamespaceURI(),ns))
191 e = getPreviousSiblingElement(e, localName);
195 DOMElement* XMLHelper::getNextSiblingElement(const DOMNode* n, const XMLCh* localName)
197 DOMNode* sib = n->getNextSibling();
198 while (sib && sib->getNodeType() != DOMNode::ELEMENT_NODE)
199 sib = sib->getNextSibling();
200 if (sib && localName) {
201 if (!XMLString::equals(localName,sib->getLocalName()))
202 return getNextSiblingElement(sib, localName);
204 return static_cast<DOMElement*>(sib);
207 DOMElement* XMLHelper::getPreviousSiblingElement(const DOMNode* n, const XMLCh* localName)
209 DOMNode* sib = n->getPreviousSibling();
210 while (sib && sib->getNodeType() != DOMNode::ELEMENT_NODE)
211 sib = sib->getPreviousSibling();
212 if (sib && localName) {
213 if (!XMLString::equals(localName,sib->getLocalName()))
214 return getPreviousSiblingElement(sib, localName);
216 return static_cast<DOMElement*>(sib);
219 DOMElement* XMLHelper::getNextSiblingElement(const DOMNode* n, const XMLCh* ns, const XMLCh* localName)
221 DOMElement* e = getNextSiblingElement(n, localName);
222 while (e && !XMLString::equals(e->getNamespaceURI(),ns))
223 e = getNextSiblingElement(e, localName);
227 DOMElement* XMLHelper::getPreviousSiblingElement(const DOMNode* n, const XMLCh* ns, const XMLCh* localName)
229 DOMElement* e = getPreviousSiblingElement(n, localName);
230 while (e && !XMLString::equals(e->getNamespaceURI(),ns))
231 e = getPreviousSiblingElement(e, localName);
235 void XMLHelper::serialize(const DOMNode* n, std::string& buf)
237 static const XMLCh impltype[] = { chLatin_L, chLatin_S, chNull };
238 static const XMLCh UTF8[]={ chLatin_U, chLatin_T, chLatin_F, chDigit_8, chNull };
239 DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(impltype);
240 DOMWriter* serializer=(static_cast<DOMImplementationLS*>(impl))->createDOMWriter();
241 XercesJanitor<DOMWriter> janitor(serializer);
242 serializer->setEncoding(UTF8);
243 MemBufFormatTarget target;
244 if (!serializer->writeNode(&target,*n))
245 throw XMLParserException("unable to serialize XML");
247 buf.append(reinterpret_cast<const char*>(target.getRawBuffer()),target.getLen());
251 class StreamFormatTarget : public XMLFormatTarget
254 StreamFormatTarget(std::ostream& out) : m_out(out) {}
255 ~StreamFormatTarget() {}
257 void writeChars(const XMLByte *const toWrite, const unsigned int count, XMLFormatter *const formatter) {
258 m_out.write(reinterpret_cast<const char*>(toWrite),count);
270 ostream& XMLHelper::serialize(const DOMNode* n, ostream& out)
272 static const XMLCh impltype[] = { chLatin_L, chLatin_S, chNull };
273 static const XMLCh UTF8[]={ chLatin_U, chLatin_T, chLatin_F, chDigit_8, chNull };
274 DOMImplementation* impl=DOMImplementationRegistry::getDOMImplementation(impltype);
275 DOMWriter* serializer=(static_cast<DOMImplementationLS*>(impl))->createDOMWriter();
276 XercesJanitor<DOMWriter> janitor(serializer);
277 serializer->setEncoding(UTF8);
278 StreamFormatTarget target(out);
279 if (!serializer->writeNode(&target,*n))
280 throw XMLParserException("unable to serialize XML");
284 ostream& xmltooling::operator<<(ostream& ostr, const DOMNode& node)
286 return XMLHelper::serialize(&node, ostr);
289 ostream& xmltooling::operator<<(ostream& ostr, const XMLObject& obj)
291 return ostr << *(obj.marshall());