XmlTools.hpp

00001 /*
00002 
00003 Copyright (c) 2005-2015, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 #ifndef XMLTOOLS_HPP_
00037 #define XMLTOOLS_HPP_
00038 
00039 #include <string>
00040 #include <vector>
00041 
00042 #include <xercesc/dom/DOMDocument.hpp>
00043 #include <xercesc/dom/DOMNode.hpp>
00044 #include <xercesc/dom/DOMElement.hpp>
00045 #include <xercesc/util/XercesDefs.hpp> // XMLCh
00046 
00047 #include <xsd/cxx/version.hxx>
00048 #include <xsd/cxx/xml/string.hxx>
00049 #include <xsd/cxx/xml/dom/auto-ptr.hxx>
00050 #include <xsd/cxx/tree/error-handler.hxx>
00051 #include <xsd/cxx/tree/elements.hxx>
00052 
00053 #ifndef X //Also used in XSD code for XdmfMeshWriter
00054 
00058 #define X(str) xsd::cxx::xml::string(str).c_str()
00059 #endif //X
00060 
00065 #define X2C(str) xsd::cxx::xml::transcode<char>(str)
00066 
00070 class XmlTools
00071 {
00072 public:
00082     static xsd::cxx::xml::dom::auto_ptr<xercesc::DOMDocument> ReadXmlFile(
00083         const std::string& rFileName,
00084         const ::xsd::cxx::tree::properties<char>& rProps,
00085         bool validate=true);
00086 
00096     static void Finalize();
00097 
00101     class Finalizer
00102     {
00103     public:
00108         Finalizer(bool init);
00109 
00113         ~Finalizer();
00114     };
00115 
00131     static xsd::cxx::xml::dom::auto_ptr<xercesc::DOMDocument> ReadFileToDomDocument(
00132         const std::string& rFileName,
00133         ::xsd::cxx::xml::error_handler<char>& rErrorHandler,
00134         const ::xsd::cxx::tree::properties<char>& rProps,
00135         bool validate=true);
00136 
00144     static void PrintNode(const std::string& rMsg, xercesc::DOMNode* pNode, bool showChildren=false);
00145 
00157     static xercesc::DOMElement* SetNamespace(xercesc::DOMDocument* pDocument,
00158                                              xercesc::DOMElement* pElement,
00159                                              const std::string& rNamespace);
00160 
00172     static xercesc::DOMElement* SetNamespace(xercesc::DOMDocument* pDocument,
00173                                              xercesc::DOMElement* pElement,
00174                                              const XMLCh* pNamespace);
00175 
00187     static void WrapContentInElement(xercesc::DOMDocument* pDocument,
00188                                      xercesc::DOMElement* pElement,
00189                                      const XMLCh* pNewElementLocalName);
00190 
00196     static std::vector<xercesc::DOMElement*> GetChildElements(const xercesc::DOMElement* pElement);
00197 
00204     static std::vector<xercesc::DOMElement*> FindElements(const xercesc::DOMElement* pContextElement,
00205                                                           const std::string& rPath);
00206 
00216     static void FindElements(const xercesc::DOMElement* pContextElement,
00217                              const std::vector<std::string>& rNames,
00218                              std::vector<xercesc::DOMElement*>& rResults,
00219                              unsigned depth=0);
00220 
00229     static std::string EscapeSpaces(const std::string& rPath);
00230 
00231 };
00232 
00233 #endif /* XMLTOOLS_HPP_ */