tags.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 TAGS_HPP_
#define TAGS_HPP_

// *****************************************************************************
#include "exiv2lib_export.h"

// included header files
#include "metadatum.hpp"

// + standard includes
#include <string>
#include <iosfwd>
#include <memory>

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

// *****************************************************************************
// class declarations
    class ExifData;
    class ExifKey;
    class Value;
    struct TagInfo;

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

    typedef std::ostream& (*PrintFct)(std::ostream&, const Value&, const ExifData* pExifData);
    typedef const TagInfo* (*TagListFct)();

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

    struct EXIV2API GroupInfo {
        struct GroupName;
        bool operator==(int ifdId) const;        
        bool operator==(const GroupName& groupName) const; 
        int ifdId_;                              
        const char* ifdName_;                    
        const char* groupName_;                  
        TagListFct tagList_;                     
    };

    struct EXIV2API GroupInfo::GroupName {
        explicit GroupName(const std::string& groupName);
        std::string g_;                          
    };

    struct EXIV2API TagInfo {
        TagInfo(
            uint16_t tag,
            const char* name,
            const char* title,
            const char* desc,
            int ifdId,
            int sectionId,
            TypeId typeId,
            int16_t count,
            PrintFct printFct
        );
        uint16_t tag_;                          
        const char* name_;                      
        const char* title_;                     
        const char* desc_;                      
        int ifdId_;                             
        int sectionId_;                         
        TypeId typeId_;                         
        int16_t count_;                         
        PrintFct printFct_;                     
    }; // struct TagInfo

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

    public:
        static const GroupInfo* groupList();
        static const TagInfo* tagList(const std::string& groupName);
        static void taglist(std::ostream& os);
        static void taglist(std::ostream& os, const std::string& groupName);

        static const char* sectionName(const ExifKey& key);
        static uint16_t defaultCount(const ExifKey& key);
        static const char* ifdName(const std::string& groupName);

        static bool isMakerGroup(const std::string& groupName);
        static bool isExifGroup(const std::string& groupName);

    }; // class ExifTags

    class EXIV2API ExifKey : public Key {
    public:
        typedef std::auto_ptr<ExifKey> AutoPtr;



        explicit ExifKey(const std::string& key);
        ExifKey(uint16_t tag, const std::string& groupName);
        explicit ExifKey(const TagInfo& ti);

        ExifKey(const ExifKey& rhs);
        virtual ~ExifKey();



        ExifKey& operator=(const ExifKey& rhs);
        void setIdx(int idx);


        virtual std::string key() const;
        virtual const char* familyName() const;
        virtual std::string groupName() const;
        int ifdId() const;
        virtual std::string tagName() const;
        virtual uint16_t tag() const;
        virtual std::string tagLabel() const;
        std::string tagDesc() const;        // Todo: should be in the base class
        TypeId defaultTypeId() const;       // Todo: should be in the base class

        AutoPtr clone() const;
        int idx() const;

    private:
        virtual ExifKey* clone_() const;

    private:
        // Pimpl idiom
        struct Impl;
        std::auto_ptr<Impl> p_;

    }; // class ExifKey

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

    EXIV2API std::ostream& operator<<(std::ostream& os, const TagInfo& ti);

}                                       // namespace Exiv2

#endif                                  // #ifndef TAGS_HPP_