summaryrefslogtreecommitdiffstats
path: root/src/uscxml/util/DOM.h
blob: 1f2ced2a6e257f98ea0c8dac9b936c6b0b78c88e (plain)
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
/**
 *  @file
 *  @author     2012-2013 Stefan Radomski (stefan.radomski@cs.tu-darmstadt.de)
 *  @copyright  Simplified BSD
 *
 *  @cond
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the FreeBSD license as published by the FreeBSD
 *  project.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 *  You should have received a copy of the FreeBSD license along with this
 *  program. If not, see <http://www.opensource.org/licenses/bsd-license>.
 *  @endcond
 */

#ifndef DOMUTILS_H_WK0WAEA7
#define DOMUTILS_H_WK0WAEA7

#include <set>
#include <list>
#include <iostream>

#include "uscxml/Common.h"
#include <xercesc/util/XMLString.hpp>
#include <xercesc/dom/DOM.hpp>


/*
#define TAGNAME_CAST(elem) ((Arabica::DOM::Element<std::string>)elem).getTagName()
#define LOCALNAME_CAST(elem) ((Arabica::DOM::Element<std::string>)elem).getLocalName()
#define ATTR_CAST(elem, attr) ((Arabica::DOM::Element<std::string>)elem).getAttribute(attr)
#define ATTR_NODE_CAST(elem, attr) ((Arabica::DOM::Element<std::string>)elem).getAttributeNode(attr)
#define HAS_ATTR_CAST(elem, attr) ((Arabica::DOM::Element<std::string>)elem).hasAttribute(attr)

#define TAGNAME(elem) elem.getTagName()
#define LOCALNAME(elem) elem.getLocalName()
#define ATTR(elem, attr) elem.getAttribute(attr)
#define ATTR_NODE(elem, attr) elem.getAttributeNode(attr)
*/

#define HAS_ATTR(elem, attr) (elem)->hasAttribute(X(attr))
#define HAS_ATTR_CAST(elem, attr) HAS_ATTR(static_cast<const DOMElement*>(elem), attr)
#define ATTR(elem, attr) std::string(X((elem)->getAttribute(X(attr))))
#define ATTR_CAST(elem, attr) ATTR(static_cast<const DOMElement*>(elem), attr)
#define TAGNAME(elem) std::string(X((elem)->getTagName()))
#define TAGNAME_CAST(elem) TAGNAME(static_cast<const DOMElement*>(elem))
#define LOCALNAME(elem) std::string(X((elem)->getLocalName()))
#define LOCALNAME_CAST(elem) LOCALNAME(static_cast<const DOMElement*>(elem))



namespace uscxml {

class USCXML_API DOMUtils {
public:

	static const xercesc::DOMNode* getNearestAncestor(const xercesc::DOMNode* node, const std::string tagName);
	static bool isDescendant(const xercesc::DOMNode* s1, const xercesc::DOMNode* s2);


	static bool hasIntersection(const std::list<xercesc::DOMElement*>& l1,
	                            const std::list<xercesc::DOMElement*>& l2);
	static bool isMember(const xercesc::DOMElement* node, const std::list<xercesc::DOMElement*>& list);
	static bool isMember(const xercesc::DOMNode* node, const std::list<xercesc::DOMNode*>& list);
	static bool isMember(const xercesc::DOMNode* node, const xercesc::DOMNodeList* list);

	static std::string xPathForNode(const xercesc::DOMNode* node,
	                                const std::string& ns = "");
	static std::string idForNode(const xercesc::DOMNode* node);

	static std::list<xercesc::DOMNode*> getElementsByType(const xercesc::DOMNode* root,
	        xercesc::DOMNode::NodeType type);

	static std::list<xercesc::DOMElement*> inPostFixOrder(const std::set<std::string>& elements,
	        const xercesc::DOMElement* root,
	        const bool includeEmbeddedDoc = false);

	static std::list<xercesc::DOMElement*> inDocumentOrder(const std::set<std::string>& elements,
	        const xercesc::DOMElement* root,
	        const bool includeEmbeddedDoc = false);

	static std::list<xercesc::DOMElement*> filterChildElements(const std::string& tagName,
	        const xercesc::DOMElement* node,
	        bool recurse = false);

	static std::list<xercesc::DOMElement*> filterChildElements(const std::string& tagName,
	        const std::list<xercesc::DOMElement*>& nodeSet,
	        bool recurse = false);

	static std::list<xercesc::DOMNode*> filterChildType(const xercesc::DOMNode::NodeType type,
	        const xercesc::DOMNode* node,
	        bool recurse = false);

	static std::list<xercesc::DOMNode*> filterChildType(const xercesc::DOMNode::NodeType type,
	        const std::list<xercesc::DOMNode*>& nodeSet,
	        bool recurse = false);

protected:
	static void inPostFixOrder(const std::set<std::string>& elements,
	                           const xercesc::DOMElement* root,
	                           const bool includeEmbeddedDoc,
	                           std::list<xercesc::DOMElement*>& nodes);

	static void inDocumentOrder(const std::set<std::string>& elements,
	                            const xercesc::DOMElement* root,
	                            const bool includeEmbeddedDoc,
	                            std::list<xercesc::DOMElement*>& nodes);


};

// create a prefix from a given element - useful for copying namespace information
#define XML_PREFIX(element) X(element->getPrefix() ? X(element->getPrefix()).str() + ":" : "")

class USCXML_API X {
public :

	X(X const &other) {
		_localForm = other._localForm;
		_otherForm = xercesc::XMLString::replicate(other._otherForm);
		_deallocOther = true;
	}
	void operator=(X const &other) { // did we maybe leak before?
		_localForm = other._localForm;
		_otherForm = xercesc::XMLString::replicate(other._otherForm);
		_deallocOther = true;
	}

	X(const XMLCh* const toTranscode) {
		if (toTranscode != NULL) {
			// Call the private transcoding method
			char* tmp = xercesc::XMLString::transcode(toTranscode);
			_localForm = std::string(tmp);
			xercesc::XMLString::release(&tmp);
		}
		_otherForm = NULL;
		_deallocOther = false;
	}

	X(const std::string& fromTranscode) {
		// Call the private transcoding method
		_localForm = fromTranscode;
		_otherForm = xercesc::XMLString::transcode(fromTranscode.c_str());
		_deallocOther = true;
	}

	X(const char* const fromTranscode) {
		// Call the private transcoding method
		_localForm = fromTranscode;
		_otherForm = xercesc::XMLString::transcode(fromTranscode);
		_deallocOther = true;
	}

	X(char* fromTranscode) {
		// Call the private transcoding method
		_localForm = fromTranscode;
		_otherForm = xercesc::XMLString::transcode(fromTranscode);
		_deallocOther = true;
	}

	X() {
		_otherForm = NULL;
		_deallocOther = false;
	}

	~X() {
		if (_deallocOther)
			xercesc::XMLString::release(&_otherForm);
	}

	const std::string& str() const {
		return _localForm;
	}

	operator const XMLCh* () {
		assert(_otherForm != NULL); // constructor with XMLCh
		return _otherForm;
	}

	operator bool () {
		return _localForm.size() > 0;
	}

	operator std::string () {
		return _localForm;
	}

protected:
	friend USCXML_API std::ostream& operator<< (std::ostream& os, const X& data);

private:
	bool _deallocOther;
	std::string _localForm;
	XMLCh* _otherForm;
};

USCXML_API std::ostream& operator<< (std::ostream& os, const X& xmlString);
USCXML_API std::ostream& operator<< (std::ostream& os, const xercesc::DOMNode& node);

}


#endif /* end of include guard: DOMUTILS_H_WK0WAEA7 */