TIFF.h

/*
 * #%L
 * OME-BIOFORMATS 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_BIOFORMATS_TIFF_TIFF_H
#define OME_BIOFORMATS_TIFF_TIFF_H

#include <string>

#include <boost/iterator/iterator_facade.hpp>

#include <ome/bioformats/tiff/Types.h>

#include <ome/common/filesystem.h>

#include <ome/compat/cstdint.h>
#include <ome/compat/memory.h>

namespace ome
{
  namespace bioformats
  {
    namespace tiff
    {

      class IFD;

      template<typename Value>
      class IFDIterator : public boost::iterator_facade<IFDIterator<Value>,
                                                        ome::compat::shared_ptr<Value>,
                                                        boost::forward_traversal_tag>
      {
      public:
        IFDIterator():
          pos()
        {}

        IFDIterator(ome::compat::shared_ptr<IFD>& ifd):
          pos(ifd)
        {}

        template <class OtherValue>
        IFDIterator(const IFDIterator<OtherValue>& rhs)
          : pos(rhs.pos) {}

      private:
        mutable ome::compat::shared_ptr<Value> pos;

        friend class boost::iterator_core_access;
        template <class> friend class IFDIterator;

        void
        increment();

        bool
        equal(IFDIterator const& rhs) const
        {
          return this->pos == rhs.pos;
        }

        ome::compat::shared_ptr<Value>&
        dereference() const
        {
          return pos;
        }
      };

      class TIFF : public ome::compat::enable_shared_from_this<TIFF>
      {
      private:
        class Impl;
        class wrapped_type;
        ome::compat::shared_ptr<Impl> impl;

      protected:
        TIFF(const boost::filesystem::path& filename,
             const std::string&             mode);

      private:
        TIFF (const TIFF&);

        TIFF&
        operator= (const TIFF&);

      public:
        ~TIFF();

        static ome::compat::shared_ptr<TIFF>
        open(const boost::filesystem::path& filename,
             const std::string&             mode);

        void
        close();

        operator bool ();

        directory_index_type
        directoryCount() const;

        ome::compat::shared_ptr<IFD>
        getDirectoryByIndex(directory_index_type index) const;

        ome::compat::shared_ptr<IFD>
        getDirectoryByOffset(offset_type offset) const;

        ome::compat::shared_ptr<IFD>
        getCurrentDirectory() const;

        void
        writeCurrentDirectory();

        wrapped_type *
        getWrapped() const;

        friend class IFD;

        typedef IFDIterator<IFD> iterator;
        typedef IFDIterator<const IFD> const_iterator;

        iterator
        begin();

        const_iterator
        begin() const;

        iterator
        end();

        const_iterator
        end() const;

      private:
        void
        registerImageJTags();
      };

    }
  }
}

#endif // OME_BIOFORMATS_TIFF_TIFF_H

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