FormatHandler.h

/*
 * #%L
 * OME-FILES C++ library for image IO.
 * 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_FILES_FORMATHANDLER_H
#define OME_FILES_FORMATHANDLER_H

#include <algorithm>
#include <iterator>
#include <stdexcept>
#include <string>
#include <vector>

#include <boost/filesystem/path.hpp>
#include <boost/format.hpp>
#include <boost/optional.hpp>
#include <boost/version.hpp>

namespace ome
{
  namespace files
  {

    class FormatHandler
    {
    protected:
      FormatHandler()
      {}

      FormatHandler (const FormatHandler&) = delete;

      FormatHandler&
      operator= (const FormatHandler&) = delete;

    public:
      virtual
      ~FormatHandler()
      {}

      virtual
      bool
      isThisType(const boost::filesystem::path& name,
                 bool                           open = true) const = 0;

      virtual
      const std::string&
      getFormat() const = 0;

      virtual
      const std::string&
      getFormatDescription() const = 0;

      virtual
      const std::vector<boost::filesystem::path>&
      getSuffixes() const = 0;

      virtual
      const std::vector<boost::filesystem::path>&
      getCompressionSuffixes() const = 0;

      virtual void
      setId(const boost::filesystem::path& id) = 0;

      virtual
      void
      close(bool fileOnly = false) = 0;

      // -- Utility methods --

      static bool
      checkSuffix(const boost::filesystem::path& name,
                  const boost::filesystem::path& suffix)
      {
        bool match = true;

        boost::filesystem::path filename(name);
#if !defined(BOOST_VERSION) || BOOST_VERSION >= 105000 // Boost >= 1.50
        boost::filesystem::path ext;
        ext.replace_extension(suffix); // Adds leading dot if missing
#else // Boost < 1.50
        // replace_extension doesn't work nicely with older Boost versions.
        boost::filesystem::path ext(suffix);
        std::string suffixString(ext.string());
        if (!suffixString.empty() && suffixString[0] != '.')
          ext = boost::filesystem::path(std::string(".") + suffixString);
#endif // Boost version

        while(true)
          {
            boost::filesystem::path filename_ext = filename.extension();
            boost::filesystem::path current_ext = ext.extension();
            filename.replace_extension();
            ext.replace_extension();

            if (filename_ext.empty() && current_ext.empty())
              break; // End of matches
            else if (!filename_ext.empty() && !current_ext.empty() &&
                     filename_ext == current_ext) // Match OK
              continue;

            // Unbalanced or unequal extensions.
            match = false;
            break;
          }

        return match;
      }

      static bool
      checkSuffix(const boost::filesystem::path&              name,
                  const std::vector<boost::filesystem::path>& suffixes)
      {
        for (const auto& suffix : suffixes)
          {
            if (checkSuffix(name, suffix))
              return true;
          }

        return false;
      }

      static bool
      checkSuffix(const boost::filesystem::path&              name,
                  const std::vector<boost::filesystem::path>& suffixes,
                  const std::vector<boost::filesystem::path>& compression_suffixes)
      {
        if (checkSuffix(name, suffixes))
          return true;

        for (const auto& suffix : suffixes)
          {
            for (const auto& compsuffix : compression_suffixes)
              {
                boost::filesystem::path fullsuffix(suffix);
                fullsuffix += boost::filesystem::path(".");
                fullsuffix += compsuffix;

                if (checkSuffix(name, fullsuffix))
                  return true;
              }
          }
        return false;
      }

      static void
      assertId(const boost::optional<boost::filesystem::path>& id,
               bool                                            notNull = true)
      {
        if (!id && notNull)
          {
            throw std::logic_error("Current file should not be null; call setId() first");
          }
        else if (id && !notNull)
          {
            boost::format fmt("Current file should be null, but is '%1%'; call close() first");
            fmt % id.get();
            throw std::logic_error(fmt.str());
          }
      }
    };


  }
}

#endif // OME_FILES_FORMATHANDLER_H

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