Document.h

/*
 * #%L
 * OME-XERCES C++ library for working with Xerces C++.
 * %%
 * Copyright © 2006 - 2016 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_COMMON_XML_DOM_DOCUMENT_H
#define OME_COMMON_XML_DOM_DOCUMENT_H

#include <ome/common/config.h>

#include <cassert>
#include <functional>
#include <istream>
#include <memory>
#include <string>
#include <ostream>

#include <boost/filesystem/path.hpp>

#include <xercesc/dom/DOMComment.hpp>
#include <xercesc/dom/DOMDocument.hpp>
#include <xercesc/dom/DOMNode.hpp>
#include <xercesc/parsers/XercesDOMParser.hpp>

#include <ome/common/filesystem.h>

#include <ome/common/xml/dom/Element.h>
#include <ome/common/xml/dom/NodeList.h>
#include <ome/common/xml/dom/Wrapper.h>
#include <ome/common/xml/EntityResolver.h>
#include <ome/common/xml/String.h>

namespace ome
{
  namespace common
  {
    namespace xml
    {
      namespace dom
      {

        class Document : public Wrapper<xercesc::DOMDocument, Node>
        {
        public:
          Document ():
            Wrapper<xercesc::DOMDocument, Node>()
          {
          }

          Document (const Document& document):
            Wrapper<xercesc::DOMDocument, Node>(document)
          {
          }

          Document (const Wrapper<xercesc::DOMDocument, Node>::base_type& base):
            Wrapper<xercesc::DOMDocument, Node>(base)
          {
          }

          Document (Wrapper<xercesc::DOMDocument, Node>::element_type *document,
                    bool                                               managed):
            Wrapper<xercesc::DOMDocument, Node>(managed ?
                                                Wrapper<xercesc::DOMDocument, Node>(document, std::mem_fun(&base_element_type::release)) :
                                                Wrapper<xercesc::DOMDocument, Node>(document, &ome::common::xml::dom::detail::unmanaged<base_element_type>))
          {
          }

          Document (Wrapper<xercesc::DOMDocument, Node>::base_element_type *base,
                    bool                                                    managed):
            Wrapper<xercesc::DOMDocument, Node>(managed ?
                                                Wrapper<xercesc::DOMDocument, Node>(base, std::mem_fun(&base_element_type::release)) :
                                                Wrapper<xercesc::DOMDocument, Node>(base, &ome::common::xml::dom::detail::unmanaged<base_element_type>))
          {
          }

          ~Document ()
          {
          }

          Document&
          operator= (const Document& wrapped)
          {
            Wrapper<xercesc::DOMDocument, Node>::operator=(wrapped);
            return *this;
          }

          Element
          createElementNS(const std::string& ns,
                          const std::string& name)
          {
            common::xml::String xns(ns);
            common::xml::String xname(name);

            return Element((*this)->createElementNS(xns, xname), false);
          }

          Node
          createComment(const std::string& comment)
          {
            common::xml::String text(comment);

            xercesc::DOMNode *node = dynamic_cast<xercesc::DOMNode *>((*this)->createComment(text));
            return Node(node, false);
          }

          Element
          createElement(const std::string& name)
          {
            common::xml::String xname(name);

            return Element((*this)->createElement(xname), false);
          }

          Element
          getDocumentElement()
          {
            return Element((*this)->getDocumentElement(), false);
          }

          NodeList
          getElementsByTagName(const std::string& name)
          {
            return (*this)->getElementsByTagName(String(name));
          }
        };

        struct ParseParameters
        {
          xercesc::XercesDOMParser::ValSchemes validationScheme;
          bool doNamespaces;
          bool doSchema;
          bool handleMultipleImports;
          bool validationSchemaFullChecking;
          bool createEntityReferenceNodes;

          ParseParameters():
            validationScheme(xercesc::XercesDOMParser::Val_Auto),
            doNamespaces(true),
            doSchema(true),
            handleMultipleImports(true),
            validationSchemaFullChecking(true),
            createEntityReferenceNodes(true)
          {
          }
        };

        Document
        createEmptyDocument(const std::string& qualifiedName);

        Document
        createEmptyDocument(const std::string& namespaceURI,
                            const std::string& qualifiedName);

        Document
        createDocument(const boost::filesystem::path& file,
                       EntityResolver&                resolver,
                       const ParseParameters&         params = ParseParameters());

        Document
        createDocument(const std::string&     text,
                       EntityResolver&        resolver,
                       const ParseParameters& params = ParseParameters(),
                       const std::string&     id = "membuf");

        Document
        createDocument(std::istream&          stream,
                       EntityResolver&        resolver,
                       const ParseParameters& params = ParseParameters(),
                       const std::string&     id = "streambuf");

        struct WriteParameters
        {
          bool canonicalForm;
          bool CDATASections;
          bool comments;
          bool datatypeNormalization;
          bool discardDefaultContent;
          bool entities;
          bool namespaces;
          bool namespaceDeclarations;
          bool normalizeCharacters;
          bool prettyPrint;
          bool splitCDATASections;
          bool validate;
          bool whitespace;
          bool xmlDeclaration;

          WriteParameters():
            canonicalForm(false),
            CDATASections(true),
            comments(true),
            datatypeNormalization(false),
            discardDefaultContent(true),
            entities(false),
            namespaces(true),
            namespaceDeclarations(true),
            normalizeCharacters(false),
            prettyPrint(false),
            splitCDATASections(true),
            validate(true),
            whitespace(false),
            xmlDeclaration(true)
          {
          }
        };

        void
        writeNode(xercesc::DOMNode&              node,
                  const boost::filesystem::path& file,
                  const WriteParameters& params = WriteParameters());

        void
        writeNode(xercesc::DOMNode&      node,
                  std::ostream&          stream,
                  const WriteParameters& params = WriteParameters());

        void
        writeNode(xercesc::DOMNode&      node,
                  std::string&           text,
                  const WriteParameters& params = WriteParameters());

        void
        writeNode(Node&                          node,
                  const boost::filesystem::path& file,
                  const WriteParameters&         params = WriteParameters());

        void
        writeNode(Node&                  node,
                  std::ostream&          stream,
                  const WriteParameters& params = WriteParameters());

        void
        writeNode(Node&                  node,
                  std::string&           text,
                  const WriteParameters& params = WriteParameters());

        void
        writeDocument(Document&                      document,
                      const boost::filesystem::path& file,
                      const WriteParameters&         params = WriteParameters());

        void
        writeDocument(Document&              document,
                      std::ostream&          stream,
                      const WriteParameters& params = WriteParameters());

        void
        writeDocument(Document&              document,
                      std::string&           text,
                      const WriteParameters& params = WriteParameters());

      }
    }
  }
}

#endif // OME_COMMON_XML_DOM_DOCUMENT_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */