1 #ifndef _MBXMLUTILSHELPER_DOM_H_ 2 #define _MBXMLUTILSHELPER_DOM_H_ 4 #include <fmatvec/atom.h> 11 #include <boost/filesystem.hpp> 12 #include <xercesc/dom/DOMErrorHandler.hpp> 13 #include <xercesc/dom/DOMElement.hpp> 14 #include <xercesc/dom/DOMText.hpp> 15 #include <xercesc/dom/DOMLSParser.hpp> 16 #include <xercesc/dom/DOMLocator.hpp> 17 #include <xercesc/dom/DOMUserDataHandler.hpp> 18 #include <xercesc/dom/DOMDocument.hpp> 19 #include <xercesc/util/TransService.hpp> 20 #include <xercesc/util/XMLEntityResolver.hpp> 21 #include <xercesc/framework/psvi/PSVIHandler.hpp> 22 #include <boost/lexical_cast.hpp> 23 #include <boost/container/small_vector.hpp> 24 #include <fmatvec/toString.h> 26 namespace XERCES_CPP_NAMESPACE {
27 class DOMProcessingInstruction;
28 class DOMImplementation;
29 class AbstractDOMParser;
33 template<> std::vector<double> lexical_cast(
const std::string& str);
34 template<> std::vector<std::vector<double>> lexical_cast(
const std::string& str);
35 template<> std::vector<int> lexical_cast(
const std::string& str);
36 template<> std::vector<std::vector<int>> lexical_cast(
const std::string& str);
37 template<>
bool lexical_cast<bool>(
const std::string& arg);
44 static void check(
const xercesc::DOMElement *me,
const T &value,
int r,
int c);
47 struct CheckSize<std::vector<T>> {
48 static void check(
const xercesc::DOMElement *me,
const std::vector<T> &value,
int r,
int c);
51 struct CheckSize<std::vector<std::vector<T>>> {
52 static void check(
const xercesc::DOMElement *me,
const std::vector<std::vector<T>> &value,
int r,
int c);
57 namespace MBXMLUtils {
61 template<
class T>
using XercesUniquePtr = std::unique_ptr<T, XercesUniquePtrDeleter<T>>;
64 template<
typename DOMDocumentType>
66 template<
typename DOMDocumentType>
68 template<
typename DOMElementType>
70 template<
typename DOMElementType>
77 xercesc::XMLPlatformUtils::Initialize();
80 xercesc::XMLPlatformUtils::Terminate();
88 const XMLCh *operator%(
const std::string &str) {
90 return &xercesc::chNull;
91 const XMLCh *unicode=xercesc::TranscodeFromStr(reinterpret_cast<const XMLByte*>(str.c_str()), str.length(),
"UTF8").adopt();
92 store.emplace_back(unicode, &releaseXMLCh);
95 const XMLCh *operator()(
const std::string &str) {
return operator%(str); }
96 std::string operator%(
const XMLCh *unicode) {
97 if(!unicode || unicode[0]==0)
99 return reinterpret_cast<const char*>(xercesc::TranscodeToStr(unicode,
"UTF8").str());
101 std::string operator()(
const XMLCh *unicode) {
return operator%(unicode); }
102 static void releaseXMLCh(
const XMLCh *s) { xercesc::XMLPlatformUtils::fgMemoryManager->deallocate(const_cast<XMLCh*>(s)); }
104 boost::container::small_vector<std::unique_ptr<
const XMLCh, decltype(&releaseXMLCh)>, 1> store;
109 class FQN :
public std::pair<std::string, std::string> {
114 FQN(
const std::string &name) : std::pair<std::string, std::string>(
"", name) {}
116 FQN(
const char *name) : std::pair<std::string, std::string>(
"", name) {}
118 FQN(
const std::string &ns,
const std::string &name) : std::pair<std::string, std::string>(ns, name) {}
124 NamespaceURI(std::string nsuri_) : nsuri(std::move(nsuri_)) {}
125 FQN operator%(
const std::string &localName)
const {
return {nsuri, localName}; }
126 const std::string& getNamespaceURI()
const {
return nsuri; }
132 const NamespaceURI XINCLUDE(
"http://www.w3.org/2001/XInclude");
134 const NamespaceURI XMLNS(
"http://www.w3.org/2000/xmlns/");
136 const NamespaceURI PV(
"http://www.mbsim-env.de/MBXMLUtils");
138 const NamespaceURI XMLCATALOG(
"urn:oasis:names:tc:entity:xmlns:xml:catalog");
144 EmbedDOMLocator(
const boost::filesystem::path &file_,
int row_,
int embedCount_, std::string xpath_) : DOMLocator(),
145 file(x%file_.string()), row(row_), embedCount(embedCount_), xpath(std::move(xpath_)) {}
147 file(x%(
X()%src.file)), row(src.row), embedCount(src.embedCount), xpath(src.xpath) {}
149 file=x%(
X()%src.file);
151 embedCount=src.embedCount;
158 XMLFileLoc getLineNumber()
const override {
return row; }
159 XMLFileLoc getColumnNumber()
const override {
return 0; }
160 XMLFilePos getByteOffset()
const override {
return ~(XMLFilePos(0)); }
161 XMLFilePos getUtf16Offset()
const override {
return ~(XMLFilePos(0)); }
162 xercesc::DOMNode *getRelatedNode()
const override {
return nullptr; }
163 const XMLCh *getURI()
const override {
return file; }
164 int getEmbedCount()
const {
return embedCount; }
165 const std::string& getRootXPathExpression()
const {
return xpath; }
176 #define RETHROW_AS_DOMEVALEXCEPTION(e) \ 177 catch(MBXMLUtils::DOMEvalException &ex) { \ 180 catch(const std::exception &ex) { \ 181 throw DOMEvalException(ex.what(), e); \ 191 DOMEvalException(
const std::string &errorMsg_,
const xercesc::DOMLocator &loc);
193 locationStack(src.locationStack) {}
195 errorMsg=src.errorMsg; locationStack=src.locationStack;
199 void appendContext(
const xercesc::DOMNode *n,
int lineNr=0);
200 const std::string& getMessage()
const {
return errorMsg; }
201 void setMessage(
const std::string& errorMsg_) { errorMsg=errorMsg_; }
202 void setSubsequentError(
bool sse) { subsequentError=sse; }
203 const char* what()
const noexcept
override;
233 bool subsequentError{
false};
234 std::string errorMsg;
235 std::vector<EmbedDOMLocator> locationStack;
236 mutable std::string whatStr;
244 bool handleError(
const xercesc::DOMError&)
override;
245 bool hasError() {
return errorSet; }
247 void resetError() { errorSet=
false; }
249 bool errorSet{
false};
254 template<
typename DOMElementType>
288 template<
class T> T
getText(
int r=0,
int c=0)
const {
290 auto textEle=E(me)->getFirstTextChild();
291 auto text=textEle ?
X()%textEle->getData() :
"";
292 auto ret=boost::lexical_cast<T>(text);
293 CheckSize<T>::check(me, ret, r, c);
296 catch(
const boost::bad_lexical_cast &ex) {
299 catch(
const std::exception &ex) {
304 template<
class T>
void addElementText(
const FQN &name,
const T &value) {
305 xercesc::DOMElement *ele=D(me->getOwnerDocument())->createElement(name);
306 ele->insertBefore(me->getOwnerDocument()->createTextNode(
MBXMLUtils::X()%fmatvec::toString(value)),
nullptr);
307 me->insertBefore(ele,
nullptr);
318 const xercesc::DOMElement *&found=DOMElementWrapper<DOMElementType>::dummyArg)
const;
326 boost::filesystem::path
convertPath(
const boost::filesystem::path &relPath)
const;
360 me->setAttributeNS(
X()%name.first,
X()%name.second,
X()%fmatvec::toString(value));
371 typename std::conditional<std::is_same<DOMElementType, const xercesc::DOMElement>::value,
375 static const xercesc::DOMElement *dummyArg;
380 template<
typename DOMElementType>
381 DOMElementWrapper<DOMElementType> E(DOMElementType *me) {
return DOMElementWrapper<DOMElementType>(me); }
383 template<
typename DOMElementType>
384 DOMElementWrapper<DOMElementType> E(
const std::shared_ptr<DOMElementType> &me) {
return DOMElementWrapper<DOMElementType>(me.get()); }
386 template<
typename DOMElementType>
387 DOMElementWrapper<DOMElementType> E(
const XercesUniquePtr<DOMElementType> &me) {
return DOMElementWrapper<DOMElementType>(me.get()); }
389 template<>
const xercesc::DOMElement *DOMElementWrapper< xercesc::DOMElement>::dummyArg;
390 template<>
const xercesc::DOMElement *DOMElementWrapper<const xercesc::DOMElement>::dummyArg;
393 template<
typename DOMAttrType>
405 typename std::conditional<std::is_same<DOMAttrType, const xercesc::DOMAttr>::value,
413 template<
typename DOMAttrType>
414 DOMAttrWrapper<DOMAttrType> A(DOMAttrType *me) {
return DOMAttrWrapper<DOMAttrType>(me); }
416 template<
typename DOMAttrType>
417 DOMAttrWrapper<DOMAttrType> A(
const std::shared_ptr<DOMAttrType> &me) {
return DOMAttrWrapper<DOMAttrType>(me.get()); }
419 template<
typename DOMAttrType>
420 DOMAttrWrapper<DOMAttrType> A(
const XercesUniquePtr<DOMAttrType> &me) {
return DOMAttrWrapper<DOMAttrType>(me.get()); }
425 template<
typename DOMDocumentType>
426 class DOMDocumentWrapper {
438 std::shared_ptr<DOMParser>
getParser()
const;
447 typename std::conditional<std::is_same<DOMDocumentType, const xercesc::DOMDocument>::value,
455 template<
typename DOMDocumentType>
456 DOMDocumentWrapper<DOMDocumentType> D(DOMDocumentType *me) {
return DOMDocumentWrapper<DOMDocumentType>(me); }
458 template<
typename DOMDocumentType>
459 DOMDocumentWrapper<DOMDocumentType> D(
const std::shared_ptr<DOMDocumentType> &me) {
return DOMDocumentWrapper<DOMDocumentType>(me.get()); }
461 template<
typename DOMDocumentType>
462 DOMDocumentWrapper<DOMDocumentType> D(
const XercesUniquePtr<DOMDocumentType> &me) {
return DOMDocumentWrapper<DOMDocumentType>(me.get()); }
466 void setParser(
DOMParser *parser_) { parser=parser_; }
467 xercesc::DOMLSParserFilter::FilterAction acceptNode(xercesc::DOMNode *n)
override;
468 xercesc::DOMLSParserFilter::FilterAction startElement(xercesc::DOMElement *e)
override;
469 xercesc::DOMNodeFilter::ShowType getWhatToShow()
const override;
472 static const std::string lineNumberKey;
477 void setParser(
DOMParser *parser_) { parser=parser_; }
478 void handleElementPSVI(
const XMLCh *localName,
const XMLCh *uri, xercesc::PSVIElement *info)
override;
479 void handleAttributesPSVI(
const XMLCh *localName,
const XMLCh *uri, xercesc::PSVIAttributeList *psviAttributes)
override;
486 void handle(DOMOperationType operation,
const XMLCh* key,
void *data,
const xercesc::DOMNode *src, xercesc::DOMNode *dst)
override;
491 void setParser(
DOMParser *parser_) { parser=parser_; }
492 xercesc::InputSource* resolveEntity(xercesc::XMLResourceIdentifier *resourceIdentifier)
override;
498 class DOMParser :
public std::enable_shared_from_this<DOMParser> {
499 friend bool isDerivedFrom(
const xercesc::DOMNode *me,
const FQN &baseTypeName);
509 static std::shared_ptr<DOMParser>
create(
const std::variant<boost::filesystem::path, xercesc::DOMElement*> &xmlCatalog=
nullptr);
513 std::shared_ptr<xercesc::DOMDocument>
parse(
const boost::filesystem::path &inputSource,
514 std::vector<boost::filesystem::path> *dependencies=
nullptr,
bool doXInclude=
true);
517 static void serialize(xercesc::DOMNode *n,
const boost::filesystem::path &outputSource,
bool prettyPrint=
true);
520 static void serializeToString(xercesc::DOMNode *n, std::string &outputData,
bool prettyPrint=
true);
526 static const std::string domParserKey;
528 xercesc::DOMImplementation *domImpl;
529 DOMParser(
const std::variant<boost::filesystem::path, xercesc::DOMElement*> &xmlCatalog);
530 std::shared_ptr<xercesc::DOMLSParser> parser;
531 std::map<FQN, xercesc::XSTypeDefinition*> typeMap;
537 std::map<std::string, boost::filesystem::path> registeredGrammar;
539 static void handleXInclude(xercesc::DOMElement *&e, std::vector<boost::filesystem::path> *dependencies);
547 void CheckSize<T>::check(
const xercesc::DOMElement *me,
const T &value,
int r,
int c) {}
549 void CheckSize<std::vector<T>>::check(
const xercesc::DOMElement *me,
const std::vector<T> &value,
int r,
int c) {
550 if(r!=0 && r!=static_cast<int>(value.size()))
552 " but got vector of size "+fmatvec::toString(value.size())+
".", me);
555 void CheckSize<std::vector<std::vector<T>>>::check(
const xercesc::DOMElement *me,
const std::vector<std::vector<T>> &value,
int r,
int c) {
556 if(r!=0 && r!=static_cast<int>(value.size()))
558 " but got matrix of row-size "+fmatvec::toString(value.size())+
".", me);
559 if(!value.empty() && c!=0 && c!=static_cast<int>(value[0].size()))
561 " but got matrix of col-size "+fmatvec::toString(value[0].size())+
".", me);
const xercesc::DOMText * getFirstTextChild() const
Definition: dom.cc:267
xercesc::DOMElement * createElement(const FQN &name)
Definition: dom.cc:615
void validate()
(re)validate the document using the parser this document was created
Definition: dom.cc:584
FQN(const char *name)
Anonymous FQN (required for implicit casting of string literals to anonymous FQNs)
Definition: dom.h:116
int getOriginalElementLineNumber() const
Get the line number of the original element.
Definition: dom.cc:507
std::string getRootXPathExpression() const
Definition: dom.cc:463
FQN getTagName() const
Get full qualified tag name.
Definition: dom.h:260
void workaroundDefaultAttributesOnImportNode()
Workaround: convert default attributes to normal attributes (must be used before importNode to also i...
Definition: dom.cc:524
xercesc::DOMNode * evalRootXPathExpression(std::string xpathExpression, xercesc::DOMElement *context=nullptr)
Definition: dom.cc:670
void setEmbedCountNumber(int embedCount)
Definition: dom.cc:438
std::conditional< std::is_same< DOMElementType, const xercesc::DOMElement >::value, const DOMElementWrapper *, DOMElementWrapper * >::type operator->()
Treat this object as a pointer (like DOMElement*)
Definition: dom.h:372
const xercesc::DOMComment * getFirstCommentChild() const
Get first child comment.
Definition: dom.cc:248
Helper class to easily construct full qualified XML names (FQN) using XML namespace prefixes.
Definition: dom.h:122
FQN(const std::string &ns, const std::string &name)
FQN.
Definition: dom.h:118
const xercesc::DOMAttr * getAttributeNode(const FQN &name) const
Get attribute node named name.
Definition: dom.cc:369
FQN(const std::string &name)
Anonymous FQN.
Definition: dom.h:114
void setAttribute(const FQN &name, const T &value)
Set attribute.
Definition: dom.h:359
bool isDerivedFrom(const FQN &baseTypeName) const
Definition: dom.cc:569
Helper class for extending DOMDocument (use the function D(...)).
Definition: dom.h:65
DOMElementWrapper(DOMElementType *me_)
Wrap DOMElement to my special element.
Definition: dom.h:258
T getText(int r=0, int c=0) const
Get the child text as type T.
Definition: dom.h:288
void setEmbedXPathCount(int xPathCount)
Definition: dom.cc:455
bool isDerivedFrom(const FQN &baseTypeName) const
Definition: dom.cc:560
FQN getAttributeQName(const FQN &name) const
Get attribute named name of type QName.
Definition: dom.cc:358
bool hasAttribute(const FQN &name) const
check if this element has a attibute named name.
Definition: dom.cc:538
std::shared_ptr< xercesc::DOMDocument > createDocument()
create a empty document
Definition: dom.cc:1155
int getLineNumber() const
Definition: dom.cc:415
Initialize Xerces on load and terminate it on unload of the library/program.
Definition: dom.h:74
boost::filesystem::path convertPath(const boost::filesystem::path &relPath) const
Definition: dom.cc:344
std::string getRootXPathExpression() const
Definition: dom.cc:575
const xercesc::DOMElement * getNextElementSiblingNamed(const FQN &name) const
Get next sibling element of the specified full qualified name.
Definition: dom.cc:208
const xercesc::DOMElement * getFirstElementChildNamed(const FQN &name) const
Get first child element of the specified full qualified name.
Definition: dom.cc:191
void normalizeDocument()
Just calls normalizeDocument of the DOMDocument but with a workaround for a xerces-c bug,...
Definition: dom.cc:623
Helper class for extending DOMAttr (use the function A(...)).
Definition: dom.h:394
void setOriginalElementLineNumber(int lineNr)
Set the line number of the original element.
Definition: dom.cc:516
static std::string convertToString(const EmbedDOMLocator &loc, const std::string &message, bool subsequentError=false)
Definition: dom.cc:787
boost::filesystem::path getOriginalFilename(bool skipThis=false, const xercesc::DOMElement *&found=DOMElementWrapper< DOMElementType >::dummyArg) const
Definition: dom.cc:308
void resetCachedGrammarPool()
reset all loaded grammars
Definition: dom.cc:1150
Print DOM error messages.
Definition: dom.h:240
Helper class for extending DOMElement (use the function E(...)).
Definition: dom.h:69
boost::filesystem::path getDocumentFilename() const
Definition: dom.cc:645
void removeAttribute(const FQN &name)
remove from this element the attibute named name.
Definition: dom.cc:424
std::shared_ptr< DOMParser > getParser() const
Get full qualified tag name.
Definition: dom.cc:639
A XML DOM parser.
Definition: dom.h:498
const xercesc::DOMProcessingInstruction * getFirstProcessingInstructionChildNamed(const std::string &target) const
Get first child processing instruction of the specified target.
Definition: dom.cc:225
std::conditional< std::is_same< DOMAttrType, const xercesc::DOMAttr >::value, const DOMAttrWrapper *, DOMAttrWrapper * >::type operator->()
Treat this object as a pointer (like DOMAttr*)
Definition: dom.h:406
static std::shared_ptr< DOMParser > create(const std::variant< boost::filesystem::path, xercesc::DOMElement * > &xmlCatalog=nullptr)
Definition: dom.cc:924
std::shared_ptr< xercesc::DOMDocument > parse(const boost::filesystem::path &inputSource, std::vector< boost::filesystem::path > *dependencies=nullptr, bool doXInclude=true)
Definition: dom.cc:1046
DOMAttrWrapper(DOMAttrType *me_)
Wrap DOMAttr to my special element.
Definition: dom.h:397
DOMDocumentWrapper(DOMDocumentType *me_)
Wrap DOMDocument to my special element.
Definition: dom.h:429
static void serialize(xercesc::DOMNode *n, const boost::filesystem::path &outputSource, bool prettyPrint=true)
Definition: dom.cc:1108
static void serializeToString(xercesc::DOMNode *n, std::string &outputData, bool prettyPrint=true)
Definition: dom.cc:1126
std::conditional< std::is_same< DOMDocumentType, const xercesc::DOMDocument >::value, const DOMDocumentWrapper *, DOMDocumentWrapper * >::type operator->()
Treat this object as a pointer (like DOMDocument*)
Definition: dom.h:448
void setOriginalFilename(boost::filesystem::path orgFileName=boost::filesystem::path())
Definition: dom.cc:335
int getEmbedCountNumber() const
Definition: dom.cc:429
int getEmbedXPathCount() const
Definition: dom.cc:446
std::string getAttribute(const FQN &name) const
Get attribute named name.
Definition: dom.cc:352