properties.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 PROPERTIES_HPP_
#define PROPERTIES_HPP_

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

// included header files
#include "datasets.hpp"
#include "rwlock.hpp"

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

// *****************************************************************************
// class declarations
    class XmpKey;

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

    enum XmpCategory { xmpInternal, xmpExternal };

    struct EXIV2API XmpPropertyInfo {
        bool operator==(const std::string& name) const;

        const char*   name_;            
        const char*   title_;           
        const char*   xmpValueType_;    
        TypeId        typeId_;          
        XmpCategory   xmpCategory_;     
        const char*   desc_;            
    };

    struct EXIV2API XmpNsInfo {
        struct Prefix {
            explicit Prefix(const std::string& prefix);
            std::string prefix_;
        };
        struct Ns {
            explicit Ns(const std::string& ns);
            std::string ns_;
        };
        bool operator==(const Ns& ns) const;
        bool operator==(const Prefix& prefix) const;

        const char* ns_;                
        const char* prefix_;            
        const XmpPropertyInfo* xmpPropertyInfo_; 
        const char* desc_;              
    };

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

      private:
        static const XmpNsInfo* nsInfoUnsafe(const std::string& prefix);
        static void unregisterNsUnsafe(const std::string& ns);
        static const XmpNsInfo* lookupNsRegistryUnsafe(const XmpNsInfo::Prefix& prefix);

    public:
        static const char* propertyTitle(const XmpKey& key);
        static const char* propertyDesc(const XmpKey& key);
        static TypeId propertyType(const XmpKey& key);
        static const XmpPropertyInfo* propertyInfo(const XmpKey& key);
        static std::string ns(const std::string& prefix);
        static const char* nsDesc(const std::string& prefix);
        static const XmpPropertyInfo* propertyList(const std::string& prefix);
        static const XmpNsInfo* nsInfo(const std::string& prefix);

        static std::string prefix(const std::string& ns);
        static void printProperties(std::ostream& os, const std::string& prefix);

        static std::ostream& printProperty(std::ostream& os,
                                           const std::string& key,
                                           const Value& value);
        static void registerNs(const std::string& ns, const std::string& prefix);
        static void unregisterNs(const std::string& ns);

        static Exiv2::RWLock rwLock_;

        static void unregisterNs();
        typedef std::map<std::string, XmpNsInfo> NsRegistry;
        static const XmpNsInfo* lookupNsRegistry(const XmpNsInfo::Prefix& prefix);

        // DATA
        static NsRegistry nsRegistry_;          

        static void registeredNamespaces(Exiv2::Dictionary& nsDict);

    }; // class XmpProperties

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



        explicit XmpKey(const std::string& key);
        XmpKey(const std::string& prefix, const std::string& property);
        XmpKey(const XmpKey& rhs);
        virtual ~XmpKey();


        XmpKey& operator=(const XmpKey& rhs);


        virtual std::string key() const;
        virtual const char* familyName() const;
        virtual std::string groupName() const;
        virtual std::string tagName() const;
        virtual std::string tagLabel() const;
        virtual uint16_t tag() const;

        AutoPtr clone() const;

        // Todo: Should this be removed? What about tagLabel then?
        std::string ns() const;

    private:
        virtual XmpKey* clone_() const;

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

    };  // class XmpKey

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

    EXIV2API std::ostream& operator<<(std::ostream& os, const XmpPropertyInfo& propertyInfo);

}                                       // namespace Exiv2

#endif                                  // #ifndef PROPERTIES_HPP_