Magic_Game/src/kiwano/base/ObjectBase.h

// Copyright (c) 2016-2018 Kiwano - Nomango
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

#pragma once
#include <kiwano/macros.h>
#include <kiwano/core/Common.h>
#include <kiwano/core/Exception.h>
#include <kiwano/core/Serializable.h>
#include <kiwano/base/RefObject.h>
#include <kiwano/base/RefPtr.h>

namespace kiwano
{
KGE_DECLARE_SMART_PTR(ObjectBase);

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬
 */
struct ObjectStatus
{
    int    code = 0;  ///< ״̬<D7B4>룬<EFBFBD><EBA3AC><EFBFBD><EFBFBD> 0 ʱΪ<CAB1>ɹ<EFBFBD>״̬<D7B4><CCAC><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊʧ<CEAA><CAA7>״̬
    String msg;       ///< ״̬<D7B4><CCAC>Ϣ

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>״̬<D7B4>Ƿ<EFBFBD><C7B7>ɹ<EFBFBD>
    inline bool Success() const
    {
        return this->code == 0;
    }

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD>ʧ<EFBFBD><CAA7>״̬
    static const int fail = -1;
};

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʧ<EFBFBD><EFBFBD>״̬<EFBFBD>쳣
 */
class ObjectFailException : public Exception
{
public:
    ObjectFailException(ObjectBase* obj, const ObjectStatus& status);

    /// \~chinese
    /// @brief <20><>ȡʧ<C8A1>ܵĶ<DCB5><C4B6><EFBFBD>ָ<EFBFBD><D6B8>
    inline ObjectBase* GetObj() const
    {
        return obj_;
    }

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>״̬
    inline ObjectStatus GetStatus() const
    {
        return status_;
    }

    virtual char const* what() const override;

private:
    ObjectBase*  obj_;
    ObjectStatus status_;
};

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Է<EFBFBD><EFBFBD><EFBFBD>
 */
typedef Function<void(ObjectBase*, const ObjectStatus&)> ObjectPolicyFunc;

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
struct ObjectPolicy
{
    /// \~chinese
    /// @brief <20><><EFBFBD>Զ<EFBFBD><D4B6><EFBFBD>ʧ<EFBFBD><CAA7>״̬
    static inline ObjectPolicyFunc Ignore()
    {
        return nullptr;
    }

    /// \~chinese
    /// @brief <20>ڶ<EFBFBD><DAB6><EFBFBD>״̬<D7B4><CCAC>Ϊʧ<CEAA><CAA7>ʱ<EFBFBD><CAB1>ӡ<EFBFBD><D3A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>־
    static ObjectPolicyFunc WarnLog();

    /// \~chinese
    /// @brief <20>ڶ<EFBFBD><DAB6><EFBFBD>״̬<D7B4><CCAC>Ϊʧ<CEAA><CAA7>ʱ<EFBFBD><CAB1>ӡ<EFBFBD><D3A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>־<EFBFBD><D6BE>Ĭ<EFBFBD>ϲ<EFBFBD><CFB2>ԣ<EFBFBD>
    static ObjectPolicyFunc ErrorLog();

    /// \~chinese
    /// @brief <20>ڶ<EFBFBD><DAB6><EFBFBD>״̬<D7B4><CCAC>Ϊʧ<CEAA><CAA7>ʱ<EFBFBD>׳<EFBFBD> ObjectFailException
    static ObjectPolicyFunc Exception();
};

/**
 * \~chinese
 * @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
 */
class KGE_API ObjectBase
    : public RefObject
    , public Serializable
{
public:
    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    ObjectBase();

    virtual ~ObjectBase();

    /// \~chinese
    /// @brief <20><><EFBFBD>ö<EFBFBD><C3B6><EFBFBD><EFBFBD><EFBFBD>
    void SetName(const String& name);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    String GetName() const;

    /// \~chinese
    /// @brief <20>ж϶<D0B6><CFB6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7><EFBFBD>ͬ
    /// @param name <20><>Ҫ<EFBFBD>жϵ<D0B6><CFB5><EFBFBD><EFBFBD><EFBFBD>
    bool IsName(const String& name) const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD>û<EFBFBD><C3BB><EFBFBD><EFBFBD><EFBFBD>
    void* GetUserData() const;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>û<EFBFBD><C3BB><EFBFBD><EFBFBD><EFBFBD>
    void SetUserData(void* data);

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>ID
    uint64_t GetObjectID() const;

    /// \~chinese
    /// @brief <20><><EFBFBD>л<EFBFBD>
    void DoSerialize(Serializer* serializer) const override;

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD>л<EFBFBD>
    void DoDeserialize(Deserializer* deserializer) override;

    /// \~chinese
    /// @brief <20>ж϶<D0B6><CFB6><EFBFBD><EFBFBD>Ƿ<EFBFBD><C7B7><EFBFBD>Ч
    virtual bool IsValid() const;

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>״̬
    ObjectStatus GetStatus() const;

    /// \~chinese
    /// @brief <20><><EFBFBD>ö<EFBFBD><C3B6><EFBFBD>״̬
    void SetStatus(const ObjectStatus& status);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊʧ<CEAA><CAA7>״̬
    void Fail(const String& msg, int code = ObjectStatus::fail);

    /// \~chinese
    /// @brief <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬
    void ClearStatus();

    /// \~chinese
    /// @brief <20><><EFBFBD>ö<EFBFBD><C3B6><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
    static void SetObjectPolicy(const ObjectPolicyFunc& policy);

public:
    /// \~chinese
    /// @brief <20>Ƿ<EFBFBD><C7B7><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ڴ<EFBFBD>й©׷<C2A9><D7B7>
    static bool IsTracingLeaks();

    /// \~chinese
    /// @brief <20><>ʼ׷<CABC><D7B7><EFBFBD>ڴ<EFBFBD>й©
    static void StartTracingLeaks();

    /// \~chinese
    /// @brief ֹͣ׷<D6B9><D7B7><EFBFBD>ڴ<EFBFBD>й©
    static void StopTracingLeaks();

    /// \~chinese
    /// @brief <20><>ӡ<EFBFBD><D3A1><EFBFBD><EFBFBD>׷<EFBFBD><D7B7><EFBFBD>еĶ<D0B5><C4B6><EFBFBD><EFBFBD><EFBFBD>Ϣ
    static void DumpTracingObjects();

    /// \~chinese
    /// @brief <20><>ȡ<EFBFBD><C8A1><EFBFBD><EFBFBD>׷<EFBFBD><D7B7><EFBFBD>еĶ<D0B5><C4B6><EFBFBD>
    static Vector<ObjectBase*>& GetTracingObjects();

private:
    static void AddObjectToTracingList(ObjectBase*);

    static void RemoveObjectFromTracingList(ObjectBase*);

private:
    const uint64_t id_;

    bool    tracing_leak_;
    String* name_;
    void*   user_data_;

    ObjectStatus status_;
};

inline String ObjectBase::GetName() const
{
    if (name_)
        return *name_;
    return String();
}

inline bool ObjectBase::IsName(const String& name) const
{
    return name_ ? (*name_ == name) : name.empty();
}

inline uint64_t ObjectBase::GetObjectID() const
{
    return id_;
}
}  // namespace kiwano