properties.hpp

// SPDX-License-Identifier: GPL-2.0-or-later
 
#ifndef PROPERTIES_HPP_
#define PROPERTIES_HPP_
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include <mutex>
 
#include "datasets.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 {
    std::string prefix_;
  };
  struct 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 {
 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 std::mutex mutex_;
 
  static void unregisterNs();
  using NsRegistry = std::map<std::string, XmpNsInfo>;
  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:
  using UniquePtr = std::unique_ptr<XmpKey>;
 
 
 
  explicit XmpKey(const std::string& key);
  XmpKey(const std::string& prefix, const std::string& property);
  XmpKey(const XmpKey& rhs);
  ~XmpKey() override;
 
 
 
  XmpKey& operator=(const XmpKey& rhs);
 
 
  [[nodiscard]] std::string key() const override;
  [[nodiscard]] const char* familyName() const override;
  [[nodiscard]] std::string groupName() const override;
  [[nodiscard]] std::string tagName() const override;
  [[nodiscard]] std::string tagLabel() const override;
  [[nodiscard]] std::string tagDesc() const override;
  [[nodiscard]] uint16_t tag() const override;
 
  [[nodiscard]] UniquePtr clone() const;
 
  // Todo: Should this be removed? What about tagLabel then?
  [[nodiscard]] std::string ns() const;
 
 private:
  [[nodiscard]] XmpKey* clone_() const override;
 
  // Pimpl idiom
  struct Impl;
  std::unique_ptr<Impl> p_;
 
};  // class XmpKey
 
// *****************************************************************************
// free functions
 
EXIV2API std::ostream& operator<<(std::ostream& os, const XmpPropertyInfo& propertyInfo);
 
}  // namespace Exiv2
 
#endif  // #ifndef PROPERTIES_HPP_