types.hpp

Go to the documentation of this file.

// ***************************************************************** -*- 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.
 */
#ifndef TYPES_HPP_
#define TYPES_HPP_

#include "exiv2lib_export.h"

// included header files
#include "config.h"
#include "slice.hpp"

// + standard includes
#include <string>
#include <vector>
#include <limits>
#include <algorithm>
#include <sstream>

#ifdef _MSC_VER
// Visual Studio 2010 and later has stdint.h
# if   _MSC_VER >= _MSC_VER_2010
#  include <stdint.h>
# else
// Earlier compilers have MS C99 equivalents such as __int8
   typedef unsigned __int8  uint8_t;
   typedef unsigned __int16 uint16_t;
   typedef unsigned __int32 uint32_t;
   typedef unsigned __int64 uint64_t;
   typedef          __int8  int8_t;
   typedef          __int16 int16_t;
   typedef          __int32 int32_t;
   typedef          __int64 int64_t;
# endif
#else
  #ifdef EXV_HAVE_STDINT_H
  # include <stdint.h>
  #endif
#endif


// MSVC macro to convert a string to a wide string
#ifdef EXV_UNICODE_PATH
# define EXV_WIDEN(t) L ## t
#endif

#define EXV_CALL_MEMBER_FN(object,ptrToMember)  ((object).*(ptrToMember))

// Simple min and max macros
#define EXV_MIN(a,b) ((a) < (b) ? (a) : (b))
#define EXV_MAX(a,b) ((a) > (b) ? (a) : (b))

#if defined(__GNUC__) && (__GNUC__ >= 4) || defined(__clang__)
#define EXV_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
#elif defined(_MSC_VER) && (_MSC_VER >= 1700)
#define EXV_WARN_UNUSED_RESULT _Check_return_
#else
#define EXV_WARN_UNUSED_RESULT
#endif

// *****************************************************************************
// forward declarations
struct tm;

// *****************************************************************************
// namespace extensions
namespace Exiv2 {

// *****************************************************************************
// type definitions

    typedef uint8_t byte;

    typedef std::pair<uint32_t, uint32_t> URational;
    typedef std::pair<int32_t, int32_t> Rational;

    enum ByteOrder { invalidByteOrder, littleEndian, bigEndian };

    enum WriteMethod { wmIntrusive, wmNonIntrusive };

    enum MetadataId { mdNone=0, mdExif=1, mdIptc=2, mdComment=4, mdXmp=8, mdIccProfile=16 };

    enum AccessMode { amNone=0, amRead=1, amWrite=2, amReadWrite=3 };

    enum TypeId {
        unsignedByte       = 1, 
        asciiString        = 2, 
        unsignedShort      = 3, 
        unsignedLong       = 4, 
        unsignedRational   = 5, 
        signedByte         = 6, 
        undefined          = 7, 
        signedShort        = 8, 
        signedLong         = 9, 
        signedRational     =10, 
        tiffFloat          =11, 
        tiffDouble         =12, 
        tiffIfd            =13, 
        unsignedLongLong   =16, 
        signedLongLong     =17, 
        tiffIfd8           =18, 
        string        =0x10000, 
        date          =0x10001, 
        time          =0x10002, 
        comment       =0x10003, 
        directory     =0x10004, 
        xmpText       =0x10005, 
        xmpAlt        =0x10006, 
        xmpBag        =0x10007, 
        xmpSeq        =0x10008, 
        langAlt       =0x10009, 
        invalidTypeId =0x1fffe, 
        lastTypeId    =0x1ffff  
    };

    typedef std::vector<byte> Blob;

// *****************************************************************************
// class definitions

    class EXIV2API TypeInfo {
        TypeInfo();
        TypeInfo(const TypeInfo& rhs);
        TypeInfo& operator=(const TypeInfo& rhs);

    public:
        static const char* typeName(TypeId typeId);
        static TypeId typeId(const std::string& typeName);
        static long typeSize(TypeId typeId);

    };

    struct EXIV2API DataBufRef {
        explicit DataBufRef(std::pair<byte*, long> rhs) : p(rhs) {}
        std::pair<byte*, long> p;
    };

    class EXIV2API DataBuf {
    public:

        DataBuf();
        explicit DataBuf(long size);
        DataBuf(const byte* pData, long size);
        DataBuf(DataBuf& rhs);
        ~DataBuf();



        DataBuf& operator=(DataBuf& rhs);
        void alloc(long size);
        EXV_WARN_UNUSED_RESULT std::pair<byte*, long> release();

        void free();

        void reset(std::pair<byte*, long> =std::make_pair((byte*)(0),long(0)));

        DataBuf(const DataBufRef& rhs);
        DataBuf& operator=(DataBufRef rhs);
        operator DataBufRef();

        // DATA
        byte* pData_;
        long size_;
    }; // class DataBuf

    EXIV2API Slice<byte*> makeSlice(DataBuf& buf, size_t begin, size_t end);

    EXIV2API Slice<const byte*> makeSlice(const DataBuf& buf, size_t begin, size_t end);

// *****************************************************************************
// free functions

    EXIV2API uint16_t getUShort(const byte* buf, ByteOrder byteOrder);
    template <typename T>
    uint16_t getUShort(const Slice<T>& buf, ByteOrder byteOrder)
    {
        if (byteOrder == littleEndian) {
            return static_cast<byte>(buf.at(1)) << 8 | static_cast<byte>(buf.at(0));
        } else {
            return static_cast<byte>(buf.at(0)) << 8 | static_cast<byte>(buf.at(1));
        }
    }

    EXIV2API uint32_t getULong(const byte* buf, ByteOrder byteOrder);
    EXIV2API uint64_t getULongLong(const byte* buf, ByteOrder byteOrder);
    EXIV2API URational getURational(const byte* buf, ByteOrder byteOrder);
    EXIV2API int16_t getShort(const byte* buf, ByteOrder byteOrder);
    EXIV2API int32_t getLong(const byte* buf, ByteOrder byteOrder);
    EXIV2API Rational getRational(const byte* buf, ByteOrder byteOrder);
    EXIV2API float getFloat(const byte* buf, ByteOrder byteOrder);
    EXIV2API double getDouble(const byte* buf, ByteOrder byteOrder);

    EXIV2API std::ostream& operator<<(std::ostream& os, const Rational& r);
    EXIV2API std::istream& operator>>(std::istream& is, Rational& r);
    EXIV2API std::ostream& operator<<(std::ostream& os, const URational& r);
    EXIV2API std::istream& operator>>(std::istream& is, URational& r);

    EXIV2API long us2Data(byte* buf, uint16_t s, ByteOrder byteOrder);
    EXIV2API long ul2Data(byte* buf, uint32_t l, ByteOrder byteOrder);
    EXIV2API long ur2Data(byte* buf, URational l, ByteOrder byteOrder);
    EXIV2API long s2Data(byte* buf, int16_t s, ByteOrder byteOrder);
    EXIV2API long l2Data(byte* buf, int32_t l, ByteOrder byteOrder);
    EXIV2API long r2Data(byte* buf, Rational l, ByteOrder byteOrder);
    EXIV2API long f2Data(byte* buf, float f, ByteOrder byteOrder);
    EXIV2API long d2Data(byte* buf, double d, ByteOrder byteOrder);

    EXIV2API void hexdump(std::ostream& os, const byte* buf, long len, long offset =0);

    EXIV2API bool isHex(const std::string& str,
               size_t size =0,
               const std::string& prefix ="");

    EXIV2API int exifTime(const char* buf, struct tm* tm);

    EXIV2API const char* exvGettext(const char* str);

#ifdef EXV_UNICODE_PATH
    EXIV2API std::wstring s2ws(const std::string& s);
    EXIV2API std::string ws2s(const std::wstring& s);
#endif

    EXIV2API long parseLong(const std::string& s, bool& ok);

    EXIV2API float parseFloat(const std::string& s, bool& ok);

    EXIV2API Rational parseRational(const std::string& s, bool& ok);

    EXIV2API Rational floatToRationalCast(float f);

// *****************************************************************************
// template and inline definitions

    template<typename T, typename K, int N>
    const T* find(T (&src)[N], const K& key)
    {
        const T* rc = std::find(src, src + N, key);
        return rc == src + N ? 0 : rc;
    }

    template <typename T, int N> char (&sizer(T (&)[N]))[N];
#define EXV_COUNTOF(a) (sizeof(Exiv2::sizer(a)))

    template<typename T>
    std::string toString(const T& arg)
    {
        std::ostringstream os;
        os << arg;
        return os.str();
    }

    template<typename T>
    T stringTo(const std::string& s, bool& ok)
    {
        std::istringstream is(s);
        T tmp;
        ok = (is >> tmp) ? true : false;
        std::string rest;
        is >> std::skipws >> rest;
        if (!rest.empty()) ok = false;
        return tmp;
    }

    template<>
    bool stringTo<bool>(const std::string& s, bool& ok);

    template <typename IntType>
    IntType gcd(IntType n, IntType m)
    {
        // Avoid repeated construction
        IntType zero(0);

        // This is abs() - given the existence of broken compilers with Koenig
        // lookup issues and other problems, I code this explicitly. (Remember,
        // IntType may be a user-defined type).
#ifdef _MSC_VER
#pragma warning( disable : 4146 )
#undef max
#undef min
#endif
        if (n < zero) {
            if (n == std::numeric_limits<IntType>::min()) {
                n = std::numeric_limits<IntType>::max();
            } else {
                n = -n;
            }
        }
        if (m < zero)
            m = -m;
#ifdef _MSC_VER
#pragma warning( default : 4146 )
#endif

        // As n and m are now positive, we can be sure that %= returns a
        // positive value (the standard guarantees this for built-in types,
        // and we require it of user-defined types).
        for(;;) {
            if(m == zero)
                return n;
            n %= m;
            if(n == zero)
                return m;
            m %= n;
        }
    }

}                                       // namespace Exiv2

#endif                                  // #ifndef TYPES_HPP_