EntityResolver.h

/*
 * #%L
 * OME-XERCES C++ library for working with Xerces C++.
 * %%
 * Copyright © 2006 - 2015 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_ENTITYRESOLVER_H
#define OME_COMMON_XML_ENTITYRESOLVER_H

#include <map>
#include <string>

#include <ome/common/filesystem.h>
#include <ome/compat/memory.h>

#include <xercesc/util/XMLEntityResolver.hpp>

namespace ome
{
  namespace common
  {
    namespace xml
    {

      class EntityResolver : public xercesc::XMLEntityResolver
      {
      public:
        EntityResolver();

        ~EntityResolver();

        xercesc::InputSource *
        resolveEntity(xercesc::XMLResourceIdentifier* resource);

      private:
        typedef std::pair<boost::filesystem::path, std::string> entity_cache;
        typedef std::map<std::string, entity_cache> entity_map_type;

        xercesc::InputSource *
        getSource(const std::string& resource);

        static
        entity_map_type&
        entities();

        class AutoRegisterEntity
        {
        public:
          AutoRegisterEntity(const std::string& id,
                             const std::string& data);

          AutoRegisterEntity(const std::string&             id,
                             const boost::filesystem::path& file);

          ~AutoRegisterEntity();

        private:
          AutoRegisterEntity (const AutoRegisterEntity&);

          AutoRegisterEntity&
          operator= (const AutoRegisterEntity&);

          std::string id;
        };

        class AutoRegisterCatalog
        {
        public:
          AutoRegisterCatalog(const boost::filesystem::path& catalog);

          ~AutoRegisterCatalog();

        private:
          AutoRegisterCatalog (const AutoRegisterCatalog&);

          AutoRegisterCatalog&
          operator= (const AutoRegisterCatalog&);

          std::vector<ome::compat::shared_ptr<AutoRegisterEntity> > registration;
        };

      public:
        class RegisterEntity
        {
        public:
          RegisterEntity(const std::string& id,
                         const std::string& data);

          RegisterEntity(const std::string&             id,
                         const boost::filesystem::path& file);

          ~RegisterEntity();

        private:
          ome::compat::shared_ptr<AutoRegisterEntity> registration;
        };

        class RegisterCatalog
        {
        public:
          RegisterCatalog(const boost::filesystem::path& catalog);

          ~RegisterCatalog();

        private:
          ome::compat::shared_ptr<AutoRegisterCatalog> registration;
        };

        friend class RegisterEntity;
        friend class RegisterCatalog;
      };

    }
  }
}

#endif // OME_COMMON_XML_ENTITYRESOLVER_H

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