// ***************************************************************** -*- C++ -*-

/*

 * Copyright (C) 2004-2018 Exiv2 authors

 * This program is part of the Exiv2 distribution.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.

 */

/*!

  @file    epsimage.hpp

  @brief   EPS image.

           
References:

           
[1] Adobe PostScript Language Document Structuring Conventions Specification, Version 3.0, September 1992

           
[2] Adobe Encapsulated PostScript File Format Specification, Version 3.0, May 1992

           
[3] Adobe XMP Specification Part 3: Storage in Files, July 2010

           
[4] Re: Thumbnail data format in ai file, Dec 2003

  @author  Michael Ulbrich (mul)

           mul@rentapacs.de

  @author  Volker Grabsch (vog)

           vog@notjusthosting.com

  @date    7-Mar-2011, vog: created

 */

#ifndef EPSIMAGE_HPP_

#define EPSIMAGE_HPP_

// *****************************************************************************

#include "exiv2lib_export.h"

// included header files

#include "image.hpp"

// *****************************************************************************

// namespace extensions

namespace Exiv2

{

// *****************************************************************************

// class definitions

    // Add EPS to the supported image formats

    namespace ImageType {

        const int eps = 18;                     //!< EPS image type

    }

    /*!

      @brief Class to access EPS images.

     */

    class EXIV2LIB_DEPRECATED_EXPORT EpsImage : public Image {

    public:

        //! @name Creators

        //@{

        /*!

          @brief Constructor to open a EPS image. Since the

              constructor can't return a result, callers should check the

              good() method after object construction to determine success

              or failure.

          @param io An auto-pointer that owns a BasicIo instance used for

              reading and writing image metadata. \b Important: The constructor

              takes ownership of the passed in BasicIo instance through the

              auto-pointer. Callers should not continue to use the BasicIo

              instance after it is passed to this method.  Use the Image::io()

              method to get a temporary reference.

          @param create Specifies if an existing image should be read (false)

              or if a new file should be created (true).

         */

        EpsImage(BasicIo::AutoPtr io, bool create);

        //@}

        //! @name Manipulators

        //@{

        void readMetadata();

        void writeMetadata();

        /*!

          @brief Not supported.

              Calling this function will throw an instance of Error(kerInvalidSettingForImage).

         */

        void setComment(const std::string& comment);

        //@}

        //! @name Accessors

        //@{

        std::string mimeType() const;

        //@}

    private:

        //! @name NOT Implemented

        //@{

        //! Copy constructor

        EpsImage(const EpsImage& rhs);

        //! Assignment operator

        EpsImage& operator=(const EpsImage& rhs);

        //@}

    }; // class EpsImage

// *****************************************************************************

// template, inline and free functions

    // These could be static private functions on Image subclasses but then

    // ImageFactory needs to be made a friend.

    /*!

      @brief Create a new EpsImage instance and return an auto-pointer to it.

             Caller owns the returned object and the auto-pointer ensures that

             it will be deleted.

     */

    EXIV2LIB_DEPRECATED_EXPORT Image::AutoPtr newEpsInstance(BasicIo::AutoPtr io, bool create);

    //! Check if the file iIo is a EPS image.

    EXIV2LIB_DEPRECATED_EXPORT bool isEpsType(BasicIo& iIo, bool advance);

}                                       // namespace Exiv2

#endif                                  // #ifndef EPSIMAGE_HPP_