Object.h

Go to the documentation of this file.

//-
//*****************************************************************************
// Copyright (c) 2024 Autodesk, Inc.
// All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// =============================================================================
//+
//
 
#ifndef BIFROST_OBJECT_H
#define BIFROST_OBJECT_H
 
#include "ObjectExport.h"
#include "ObjectFwd.h"
 
#include <Amino/Core/Any.h>
#include <Amino/Core/ArrayFwd.h>
#include <Amino/Core/Ptr.h>
#include <Amino/Core/String.h>
#include <Amino/Core/StringView.h>
#include <Amino/Cpp/Annotate.h>
 
//==============================================================================
// NAMESPACE Bifrost
//==============================================================================
 
//------------------------------------------------------------------------------
#define BIFROST_IGNORE_NAMESPACE AMINO_ANNOTATE("Amino::Namespace ignore")
namespace Bifrost BIFROST_IGNORE_NAMESPACE {
#undef BIFROST_IGNORE_NAMESPACE
 
 
class AMINO_ANNOTATE("Amino::Class metadata=[{type_kind, dictionary}]") OBJECT_DECL Object {
public:
    /*----- static member functions -----*/
 
    static bool isA(Object const& object, Object const& prototype);
 
    /*----- types -----*/
 
    struct Property {
        template <typename T>
        Property(Amino::String key, T&& value);
 
        Amino::String m_key;
        Amino::Any    m_value;
    };
 
    /*----- member functions -----*/
 
    Object();
 
    virtual ~Object();
 
 
 
    virtual size_t size() const noexcept = 0;
 
    virtual bool empty() const noexcept = 0;
 
    virtual bool hasProperty(Amino::StringView key) const noexcept = 0;
 
    virtual Amino::Any getProperty(Amino::StringView key) const noexcept = 0;
 
    virtual Amino::Any extractProperty(Amino::StringView key) noexcept = 0;
 
    virtual bool eraseProperty(Amino::StringView key) noexcept = 0;
 
    virtual void eraseAllProperties() noexcept = 0;
 
    virtual Amino::Ptr<Amino::Array<Amino::String>> keys() const noexcept = 0;
 
 
    template <typename T>
    bool setProperty(Amino::StringView key, T&& value) noexcept;
 
    template <typename S, typename T>
    typename std::enable_if<std::is_same<std::decay_t<S>,Amino::String>::value,bool>::type
    setProperty(S&& key, T&& value) noexcept;
 
protected:
    Object(Object&&) noexcept = default;
    Object(Object const&)     = default;
    Object& operator=(Object&&) noexcept = default;
    Object& operator=(Object const&) = default;
 
    virtual bool setPropertyAny(Amino::StringView key, Amino::Any value) noexcept    = 0;
    virtual bool setPropertyAny(Amino::String const& key, Amino::Any value) noexcept = 0;
};
 
//==============================================================================
// GLOBAL FUNCTIONS
//==============================================================================
 
//------------------------------------------------------------------------------
//
OBJECT_DECL
Amino::MutablePtr<Object> createObject();
 
//------------------------------------------------------------------------------
//
OBJECT_DECL
Amino::MutablePtr<Object> createObject(
    std::initializer_list<Object::Property> properties);
 
 
//==============================================================================
// Implementation details
//==============================================================================
 
//------------------------------------------------------------------------------
//
namespace Internal {
template <typename T>
inline Amino::Any makeAny(T&& v) {
    return Amino::Any{std::forward<T>(v)};
}
inline Amino::Any makeAny(Amino::Any v) { return v; }
inline Amino::Any makeAny(const char* v) {
    return Amino::Any{Amino::String(v)};
}
inline Amino::Any makeAny(Amino::StringView v) {
    return Amino::Any{Amino::String(v)};
}   
template <typename T>
inline Amino::Any makeAny(Amino::MutablePtr<T> v) {
    return Amino::Any{Amino::Ptr<T>{std::move(v)}};
}
} // namespace Internal
 
//==============================================================================
// CLASS Object::Property
//==============================================================================
 
template <typename T>
Object::Property::Property(Amino::String key, T&& value)
    : m_key(std::move(key)),
      m_value(Internal::makeAny(std::forward<T>(value))) // LCOV_EXCL_BR_LINE
{}
 
//==============================================================================
// CLASS Object
//==============================================================================
 
template <typename T>
bool Object::setProperty(Amino::StringView key, T&& value) noexcept {
    // LCOV_EXCL_BR_START
    if (key.empty()) {
        return false; // keys not allowed to be empty strings
    }
    return setPropertyAny(key, Internal::makeAny(std::forward<T>(value)));
    // LCOV_EXCL_BR_STOP
}
 
template <typename S, typename T>
typename std::enable_if<std::is_same<std::decay_t<S>, Amino::String>::value, bool>::type
Object::setProperty(S&& key, T&& value) noexcept {
    // LCOV_EXCL_BR_START
    if (key.empty()) {
        return false; // keys not allowed to be empty strings
    }
    return setPropertyAny(key, Internal::makeAny(std::forward<T>(value)));
    // LCOV_EXCL_BR_STOP
}
 
 
} // namespace Bifrost BIFROST_IGNORE_NAMESPACE
 
#endif // BIFROST_OBJECT_H