Chaste  Release::2018.1
XmlTools.hpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #ifndef XMLTOOLS_HPP_
37 #define XMLTOOLS_HPP_
38 
39 #include <string>
40 #include <vector>
41 
42 #include <xercesc/dom/DOMDocument.hpp>
43 #include <xercesc/dom/DOMNode.hpp>
44 #include <xercesc/dom/DOMElement.hpp>
45 #include <xercesc/util/XercesDefs.hpp> // XMLCh
46 
47 #include <xsd/cxx/version.hxx>
48 #include <xsd/cxx/xml/string.hxx>
49 #include <xsd/cxx/xml/dom/auto-ptr.hxx>
50 #include <xsd/cxx/tree/error-handler.hxx>
51 #include <xsd/cxx/tree/elements.hxx>
52 
53 #ifndef X //Also used in XSD code for XdmfMeshWriter
54 
58 #define X(str) xsd::cxx::xml::string(str).c_str()
59 #endif //X
60 
65 #define X2C(str) xsd::cxx::xml::transcode<char>(str)
66 
70 class XmlTools
71 {
72 public:
82  static xsd::cxx::xml::dom::auto_ptr<xercesc::DOMDocument> ReadXmlFile(
83  const std::string& rFileName,
84  const ::xsd::cxx::tree::properties<char>& rProps,
85  bool validate=true);
86 
96  static void Finalize();
97 
101  class Finalizer
102  {
103  public:
108  Finalizer(bool init);
109 
113  ~Finalizer();
114  };
115 
131  static xsd::cxx::xml::dom::auto_ptr<xercesc::DOMDocument> ReadFileToDomDocument(
132  const std::string& rFileName,
133  ::xsd::cxx::xml::error_handler<char>& rErrorHandler,
134  const ::xsd::cxx::tree::properties<char>& rProps,
135  bool validate=true);
136 
144  static void PrintNode(const std::string& rMsg, xercesc::DOMNode* pNode, bool showChildren=false);
145 
157  static xercesc::DOMElement* SetNamespace(xercesc::DOMDocument* pDocument,
158  xercesc::DOMElement* pElement,
159  const std::string& rNamespace);
160 
172  static xercesc::DOMElement* SetNamespace(xercesc::DOMDocument* pDocument,
173  xercesc::DOMElement* pElement,
174  const XMLCh* pNamespace);
175 
187  static void WrapContentInElement(xercesc::DOMDocument* pDocument,
188  xercesc::DOMElement* pElement,
189  const XMLCh* pNewElementLocalName);
190 
196  static std::vector<xercesc::DOMElement*> GetChildElements(const xercesc::DOMElement* pElement);
197 
204  static std::vector<xercesc::DOMElement*> FindElements(const xercesc::DOMElement* pContextElement,
205  const std::string& rPath);
206 
216  static void FindElements(const xercesc::DOMElement* pContextElement,
217  const std::vector<std::string>& rNames,
218  std::vector<xercesc::DOMElement*>& rResults,
219  unsigned depth=0);
220 
229  static std::string EscapeSpaces(const std::string& rPath);
230 };
231 
232 #endif /* XMLTOOLS_HPP_ */
static std::string EscapeSpaces(const std::string &rPath)
Definition: XmlTools.cpp:442
static void PrintNode(const std::string &rMsg, xercesc::DOMNode *pNode, bool showChildren=false)
Definition: XmlTools.cpp:262
static xercesc::DOMElement * SetNamespace(xercesc::DOMDocument *pDocument, xercesc::DOMElement *pElement, const std::string &rNamespace)
Definition: XmlTools.cpp:335
static std::vector< xercesc::DOMElement * > FindElements(const xercesc::DOMElement *pContextElement, const std::string &rPath)
Definition: XmlTools.cpp:384
Finalizer(bool init)
Definition: XmlTools.cpp:108
static xsd::cxx::xml::dom::auto_ptr< xercesc::DOMDocument > ReadFileToDomDocument(const std::string &rFileName,::xsd::cxx::xml::error_handler< char > &rErrorHandler, const ::xsd::cxx::tree::properties< char > &rProps, bool validate=true)
Definition: XmlTools.cpp:125
static std::vector< xercesc::DOMElement * > GetChildElements(const xercesc::DOMElement *pElement)
Definition: XmlTools.cpp:343
static void WrapContentInElement(xercesc::DOMDocument *pDocument, xercesc::DOMElement *pElement, const XMLCh *pNewElementLocalName)
Definition: XmlTools.cpp:409
static xsd::cxx::xml::dom::auto_ptr< xercesc::DOMDocument > ReadXmlFile(const std::string &rFileName, const ::xsd::cxx::tree::properties< char > &rProps, bool validate=true)
Definition: XmlTools.cpp:53
static void Finalize()
Definition: XmlTools.cpp:103