Magic_Game/src/kiwano/core/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/RefCounter.h>
#include <kiwano/core/SmartPtr.hpp>

namespace kiwano
{
	KGE_DECLARE_SMART_PTR(ObjectBase);

	/**
	* \~chinese
	* @brief <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
	*/
	class KGE_API ObjectBase
		: public virtual RefCounter
	{
	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(String const& 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(String const& name) const;

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

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

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

		/// \~chinese
		/// @brief <20><><EFBFBD>л<EFBFBD><D0BB><EFBFBD><EFBFBD><EFBFBD>
		String DumpObject();

	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:
		bool	tracing_leak_;
		Any		user_data_;
		String*	name_;

		const uint32_t id_;
	};

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

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

	inline uint32_t	ObjectBase::GetObjectID() const					{ return id_; }
}