metadatum.hpp

// SPDX-License-Identifier: GPL-2.0-or-later
 
#ifndef METADATUM_HPP_
#define METADATUM_HPP_
 
// *****************************************************************************
#include "exiv2lib_export.h"
 
// included header files
#include "value.hpp"
 
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
// *****************************************************************************
// class declarations
class ExifData;
 
// *****************************************************************************
// class definitions
 
class EXIV2API Key {
 public:
  using UniquePtr = std::unique_ptr<Key>;
 
 
 
  virtual ~Key() = default;
  Key(Key&&) = delete;
  Key& operator=(Key&&) = delete;
 
 
  [[nodiscard]] virtual std::string key() const = 0;
  [[nodiscard]] virtual const char* familyName() const = 0;
  [[nodiscard]] virtual std::string groupName() const = 0;
  [[nodiscard]] virtual std::string tagName() const = 0;
  [[nodiscard]] virtual std::string tagLabel() const = 0;
  [[nodiscard]] virtual std::string tagDesc() const = 0;
  [[nodiscard]] virtual uint16_t tag() const = 0;
  [[nodiscard]] UniquePtr clone() const;
  std::ostream& write(std::ostream& os) const {
    return os << key();
  }
 
 protected:
  Key() = default;
  Key(const Key&) = default;
 
 
  Key& operator=(const Key&) = default;
 
 private:
  [[nodiscard]] virtual Key* clone_() const = 0;
 
};  // class Key
 
inline std::ostream& operator<<(std::ostream& os, const Key& key) {
  return key.write(os);
}
 
class EXIV2API Metadatum {
 public:
 
 
  virtual ~Metadatum() = default;
 
 
 
  virtual void setValue(const Value* pValue) = 0;
  virtual int setValue(const std::string& buf) = 0;
 
 
 
  std::string print(const ExifData* pMetadata = nullptr) const;
  virtual size_t copy(byte* buf, ByteOrder byteOrder) const = 0;
  virtual std::ostream& write(std::ostream& os, const ExifData* pMetadata = nullptr) const = 0;
  [[nodiscard]] virtual std::string key() const = 0;
  [[nodiscard]] virtual const char* familyName() const = 0;
  [[nodiscard]] virtual std::string groupName() const = 0;
  [[nodiscard]] virtual std::string tagName() const = 0;
  [[nodiscard]] virtual std::string tagLabel() const = 0;
  [[nodiscard]] virtual std::string tagDesc() const = 0;
  [[nodiscard]] virtual uint16_t tag() const = 0;
  [[nodiscard]] virtual TypeId typeId() const = 0;
  [[nodiscard]] virtual const char* typeName() const = 0;
  [[nodiscard]] virtual size_t typeSize() const = 0;
  [[nodiscard]] virtual size_t count() const = 0;
  [[nodiscard]] virtual size_t size() const = 0;
  [[nodiscard]] virtual std::string toString() const = 0;
  [[nodiscard]] virtual std::string toString(size_t n) const = 0;
  [[nodiscard]] virtual int64_t toInt64(size_t n = 0) const = 0;
  [[nodiscard]] uint32_t toUint32(size_t n = 0) const;
  [[nodiscard]] virtual float toFloat(size_t n = 0) const = 0;
  [[nodiscard]] virtual Rational toRational(size_t n = 0) const = 0;
  [[nodiscard]] virtual Value::UniquePtr getValue() const = 0;
  [[nodiscard]] virtual const Value& value() const = 0;
 
 protected:
  Metadatum() = default;
  Metadatum(const Metadatum&) = default;
 
 
  Metadatum& operator=(const Metadatum&) = default;
 
};  // class Metadatum
 
inline std::ostream& operator<<(std::ostream& os, const Metadatum& md) {
  return md.write(os);
}
 
EXIV2API bool cmpMetadataByTag(const Metadatum& lhs, const Metadatum& rhs);
EXIV2API bool cmpMetadataByKey(const Metadatum& lhs, const Metadatum& rhs);
 
}  // namespace Exiv2
 
#endif  // #ifndef METADATUM_HPP_