path: root/Runtime/Lua/LuaBind/LuaBindClass.hpp

#ifndef __LUA_BIND_CLASS_H__
#define __LUA_BIND_CLASS_H__

#include "LuaBindConfig.h"

#if LUA_BIND_PROFILER 
#include <unordered_set>
#endif

#include <vector>

#include "LuaBindRef.h"
#include "LuaBindMemberRef.h"
#include "LuaBindCFunctions.h"
#include "LuaBindWatchDog.h"
#include "LuaBindUtility.h"

namespace LuaBind
{

	class VM;

	//
	// 虚基类，为了实现多态。需要访问下面这些接口的外部基类需要虚继承此类，之后再派生链中就会
	// 调用对应实体的方法。注意继承此类时不能实现下面的方法，实现在NativeClass中，实现会
	// 导致二义性。
	// 
	// 依据Effective C++条款40，如果在必须使用virtual base基类情况下，应该尽可能避免向其中放
	// 置数据成员，规避数据成员初始化造成的一些隐性问题。依据这一点，vpb基类更加接近C#和Java中
	// 的Interface。所以，在这里把类用I开头标识这是一个接口。
	//
	class Object
	{
	public:
		Object() {};
		virtual ~Object() {};

		//
		// 成员引用管理，在实例的ref table里。设置、取、清除。
		//
		virtual bool PushMemberRef(State& state, int refID) = 0;
		virtual bool PushUserdata(State& state) = 0;
		virtual bool PushMemberTable(State& state) = 0;
		virtual bool PushRefTable(State& state) = 0;

		//
		// 被NativeClass实现。保持和释放native资源。
		//
		virtual void Retain() = 0;
		virtual void Release() = 0;

	};

	// TODO: 将公共部分提取出来，不要重复生成代码
	//class NativeClassBase
	//{
	//}

	//
	// 需要暴露给lua的native class需要继承此类。通过lua管理的实例要确保引用计数的正确性，在多个线程中需要确
	// 定不会误释放。
	//
	template<class TYPE, class BASE = Object>
	class NativeClass : public BASE
	{
	public:

		//
		// 将userdata作为key，在ref table里对userdata添加一个引用，以维持userdata的生命周期。
		// 相比较member ref，这个用在实体会被多次被不同其他实体引用的情况，并频繁销毁这些实体，
		// 避免lua频繁的调用gc检测。
		//
		template<class DATATYPE> void Retain(State& state, DATATYPE* userdata);

		//
		// 对userdata减少一个引用在ref table里，以尝试回收userdata。
		// 
		template<class DATATYPE> void Release(State& state, DATATYPE* userdata);

		//
		// 将userdata push到栈顶，如果没有初始化mUserdata，初始化设置好元表并把初始化好的
		// userdata留在栈顶。并添加一个引用。这是一个将native对象所有权移交给lua控制的方法。
		//
		bool PushMemberRef(State& state, int refID) override;
		bool PushUserdata(State& state) override;
		bool PushMemberTable(State& state) override;
		bool PushRefTable(State& state) override;

		//
		// WatchDog添加一个native引用。luaVM引用不会提供外部接口。继承此类的派生类不能直接使用
		// delete方法，应该使用Release释放。一般情况下这个操作由虚拟机__gc进行，但是允许用户
		// 程序在native中隔绝虚拟机情况下释放，这种情况下要使用Release。
		// 
		// 这两个函数是native接口。
		//
		void Retain() override final;
		void Release() override final;

#if LUA_BIND_PROFILER
		// 对堆上创建的实例进行delete保险检查
		static void operator delete(void* pdead, size_t size);
#endif

	protected:

		NativeClass();
		virtual ~NativeClass();

		//
		// 成员引用管理，在实例的ref table里。设置、取、清除
		//
		void SetMemberRef(State& state, MemberRef& memRef, int idx);
		bool PushMemberRef(State& state, MemberRef& memRef);
		void ClearMemberRef(State& state, MemberRef& memRef);

	private:

		friend class State;

		static void RegisterClassShared(State& state);
		static void RegisterFactoryClass(State& state);
		static void RegisterSingletonClass(State& state);

		static void SetClassTableRef(State& state, int idx);
		static void PushClassTable(State& state);

		//
		// 创建userdata，绑定实例到state。
		//
		void BindToLua(State& state);

		//------------------------------------------------------------------------------//

		// 公共内容
		static int __tostring       (lua_State*);
		static int _GetClass        (lua_State*);
		static int _GetClassName    (lua_State*);
														   
		// 工厂类相关
		static int __gc             (lua_State*);
		static int _GetRefTable     (lua_State*);

#if LUA_BIND_ENABLE_NATIVE_EXTEND
        static int _New(lua_State*);

		static int _ExtendFactory   (lua_State*);
		static int _ExtendSingleton (lua_State*);
#endif

		//--------------------------------------------------------------------------------//

		//
		// class table，工厂和单例都有。
		//
		static StrongRef mClassTable;

		//
		// 如果类是单例，这个用来保存singleton的引用关系，以保证不会被回收类似普通类的ref table。
		// 单例的成员是全生命周期的，所以直接在_LUA_BIND_STRONGREF_TABLE。单例对userdata进行
		// Retain\Release和member ref操作时和工厂实例不同，是存在下面这个ref table里
		// 的，这个table在_LUA_BIND_STRONGREF_TABLE里。
		//
		static StrongRef mSingletonRefTable;

		//
		// 通过userdata可以拿到:
		//     1: ref table 
		//     2: member table 
		//     3: class table
		//
		WeakRef mUserdata;

		// 通过后才能删除
		WatchDog mWatchDog;

#if LUA_BIND_PROFILER
		// 托管此对象的虚拟机
		std::unordered_set<VM*> mRefVMs;
		// 保险，此类的派生类不能在外部使用delete直接删除，而应该使用Release
		bool mSafer;
#endif

	};

#if LUA_BIND_ENABLE_PLAIN_CLASS
	//
	// 纯lua类
	//
	class PlainClass
	{
	public:

		//
		// 用来注册类的入口函数。可以通过registry(类名)注册类。
		//
		static int registry(lua_State* L);

		LUA_BIND_DECL_METHOD(__tostring);
		LUA_BIND_DECL_METHOD(_Extend);
		LUA_BIND_DECL_METHOD(_New);
		LUA_BIND_DECL_METHOD(_TypeOf);

	};
#endif

	//--------------------------------------------------------------------------------//

	//
	// 对不同类型，通过调用GetLuaClassName获得类型名，如果是派生类，GetClassName会被覆盖，指向luax_c_getupvalue。
	//
	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_GetClassName(lua_State* L)
	{
		LUA_BIND_SETUP(L, "*");

		cc8* type = TYPE::GetClassName();
		state.Push(type);
		return 1;
	}

	//--------------------------------------------------------------------------------//

	//
	// 注册工厂和单例共有的类成员
	// 
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::RegisterClassShared(State& state)
	{
		luaL_Reg regTable[] = {
			{ "GetClass",     _GetClass     },
			{ "GetClassName", _GetClassName },
			{ NULL,           NULL           }
		};

		state.RegisterMethods(regTable);
	}

	//
	// 工厂类的成员，注册在class table
	//
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::RegisterFactoryClass(State& state)
	{
		luaL_Reg regTable[] = {
			{ "GetRefTable", _GetRefTable },
			{ NULL,          NULL          }
		};

		state.RegisterMethods(regTable);
	}

	//
	// 单例类的成员，注册在class table
	//
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::RegisterSingletonClass(State& state)
	{
		luaL_Reg regTable[] = {
			{ NULL, NULL }
		};

		state.RegisterMethods(regTable);
	}

	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::PushClassTable(State& state)
	{
		assert(mClassTable);

		mClassTable.PushRef(state);
	}

	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::SetClassTableRef(State& state, int idx)
	{
		mClassTable.SetRef(state, idx);
	}

	template<class TYPE, class BASE>
	NativeClass<TYPE, BASE>::NativeClass()
		: mWatchDog()
#if LUA_BIND_PROFILER 
		, mSafer(false)
#endif
	{
	}

	template<class TYPE, class BASE>
	NativeClass<TYPE, BASE>::~NativeClass()
	{
	}

#if LUA_BIND_PROFILER
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::operator delete(void* pdead, size_t size)
	{
		if (pdead == nullptr)
			return;
		// 堆上创建的实例必须使用Release释放。
		TYPE* p = static_cast<TYPE*>(pdead);
		assert(p->mSafer);
		::operator delete(pdead, size);
	}
#endif

	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::Retain()
	{
		++mWatchDog.mNativeRef;
	}

	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::Release()
	{
		if (mWatchDog.mNativeRef > 0)
			--mWatchDog.mNativeRef;
		if (mWatchDog)
		{
#if LUA_BIND_PROFILER
			mSafer = true;
#endif
			delete this;
		}
	}

	template<class TYPE, class BASE>
	template<typename U>
	void NativeClass<TYPE, BASE>::Retain(State& state, U* userdata)
	{
		if (PushRefTable(state))
		{
			if (userdata->PushUserdata(state))
			{
				lua_pushvalue(state, -1); // copy the userdata
				lua_gettable(state, -3); // get the count (or nil)
				u32 count = state.GetValue<u32>(-1, 0); // get the count (or 0)
				lua_pop(state, 1); // pop the old count
				lua_pushnumber(state, count + 1); // push the new count
				lua_settable(state, -3); // save it in the table: reftable[userdata] = count
			}
		}
	}

	template<class TYPE, class BASE>
	template<typename U>
	void NativeClass<TYPE, BASE>::Release(State& state, U* userdata)
	{
		if (PushRefTable(state))
		{
			if (userdata->PushUserdata(state))
			{
				lua_pushvalue(state, -1); // copy the userdata
				lua_gettable(state, -3); // get the count (or nil)
				u32 count = state.GetValue<u32>(-1, 0); // get the count (or 0)
				lua_pop(state, 1); // pop the old count

				// no such reference
				if (count == 0)
				{
					state.Pop(2); // userdata, reftable
					return; // nothing to do
				}

				if (count > 1) {
					lua_pushnumber(state, count - 1); // push the new count
				}
				else {
					lua_pushnil(state); // maybe cause gc
				}
				lua_settable(state, -3); // save it in the table

				state.Pop(1); // reftable 
				return;
			}
			state.Pop(2); // nil, reftable
			return;
		}
	}

	template<class TYPE, class BASE>
	bool NativeClass<TYPE, BASE>::PushUserdata(State& state)
	{
		assert(!TYPE::IsClassSingleton());
		if (!mUserdata)
		{
			BindToLua(state);
			return true;
		}
		return mUserdata.PushRef(state);
	}

	template<class TYPE, class BASE>
	bool NativeClass<TYPE, BASE>::PushMemberTable(State& state)
	{
		int top = state.GetTop();
		if (this->PushUserdata(state))
		{
			if (lua_getmetatable(state, -1))  // ref table 
			{
				lua_replace(state, -2);
				if (lua_getmetatable(state, -1)) // member table
				{
					lua_replace(state, -2);
					return true;
				}
			}
		}
		lua_settop(state, top);
		lua_pushnil(state);
		return false;
	}

	template<class TYPE, class BASE>
	bool NativeClass<TYPE, BASE>::PushRefTable(State& state)
	{
		// Singleton 
		if (TYPE::IsClassSingleton())
		{
			if (!this->mSingletonRefTable) {
				lua_newtable(state);
				this->mSingletonRefTable.SetRef(state, -1); // strong ref to member table won't be garbage collected
			}
			else {
				this->mSingletonRefTable.PushRef(state);
			}
			return true;
		}
		// Factory
		else
		{
			if (this->PushUserdata(state))
			{
				if (lua_getmetatable(state, -1))
				{
					lua_replace(state, -2);
					return true;
				}
			}
		}
		return false;
	}

	// 创建userdata，并以此添加ref table，member table和class table。
	//     ref table    是kv强引用table，保存对其他userdata的引用计数（通过userdata作为key，
	//                  计数为value），以及成员引用
	//     member table 保存lua创建的实例的成员
	//     class table  所有本类型的实例共有的函数表
	//
	// BindToLua只会在第一次注册给Lua虚拟机时调用。
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::BindToLua(State& state)
	{
		// 单例不能绑定userdata
		assert(!TYPE::IsClassSingleton());
		assert(!mUserdata);

		// 创建userdata并留在栈顶，注意地址要转换为TYPE*，直接用this可能会导致多重继承的类丧失多态。
		// 如果直接传this进去，在多重继承情况下，是拿不到另一头的虚函数表的。所以这里需要将this
		// 转换为整个对象的低地址，这样可以拿到另一个基类的虚函数表，通过另一个基类实现多态。
		TYPE* p = static_cast<TYPE*>(this);
		state.PushPtrUserdata(p);

		lua_newtable(state); // ref table，无法在lua处访问，用来管理C对象的生命周期
		lua_newtable(state); // member table，lua中创建的对象成员都保存在这里
		PushClassTable(state); // class table

		// stack:
		// -1: class table
		// -2: member table
		// -3: ref table
		// -4: userdata

		int top = state.GetTop();
		int memberTable = top - 1;
		int refTable = top - 2;

		// ref table 注册 __tostring 和 __gc
		lua_pushcfunction(state, __tostring);
		lua_setfield(state, refTable, "__tostring");

		lua_pushcfunction(state, __gc);
		lua_setfield(state, refTable, "__gc");

		// ref table 的 __index 和 __newindex 设为 member table
		lua_pushvalue(state, memberTable);
		lua_setfield(state, refTable, "__index");

		lua_pushvalue(state, memberTable);
		lua_setfield(state, refTable, "__newindex");

		// 设置元表
		lua_setmetatable(state, -2); // class is meta of member
		lua_setmetatable(state, -2); // member is meta of ref
		lua_setmetatable(state, -2); // ref is meta of userdata

		// 设置一个userdata的弱引用，方便通过PushLuaUserdata方法返回lua对象
		mUserdata.SetRef(state, -1);
		assert(mUserdata);

		// 增加一个虚拟机引用，在GC时-1
		++mWatchDog.mVMRef;
#if LUA_BIND_PROFILER
		mRefVMs.insert(state.GetVM());
#endif
	}

	//
	// 成员引用管理
	//
	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::SetMemberRef(State& state, MemberRef& memRef, int idx)
	{
		ClearMemberRef(state, memRef);
		if (!lua_isnil(state, idx))
		{
			idx = state.AbsIndex(idx);
			if (PushRefTable(state))
			{
				lua_pushvalue(state, idx);
				memRef.refID = luaL_ref(state, -2);
				state.Pop(); // ref table
			}
		}
	}

	template<class TYPE, class BASE>
	bool NativeClass<TYPE, BASE>::PushMemberRef(State& state, MemberRef& memRef)
	{
		if (memRef)
		{
			if (PushRefTable(state))
			{
				lua_rawgeti(state, -1, memRef.refID);
				lua_replace(state, -2); // ref table
				if (lua_isnil(state, -1))
					goto failed;
				return true;
			}
		}
		lua_pushnil(state);
	failed:
		memRef.refID = LUA_NOREF;
		return false;
	}

	template<class TYPE, class BASE>
	bool NativeClass<TYPE, BASE>::PushMemberRef(State& state, int refID)
	{
		if (PushRefTable(state))
		{
			lua_rawgeti(state, -1, refID);
			lua_replace(state, -2); // ref table
			if (lua_isnil(state, -1))
				goto failed;
			return true;
		}
		lua_pushnil(state);
	failed:
		return false;
	}

	template<class TYPE, class BASE>
	void NativeClass<TYPE, BASE>::ClearMemberRef(State& state, MemberRef& memRef)
	{
		if (memRef)
		{
			if (PushRefTable(state))
			{
				luaL_unref(state, -1, memRef.refID);
				state.Pop(); // ref table
			}
			memRef.refID = LUA_NOREF;
		}
	}

	//--------------------------------------------------------------------------------//

	//
	// 释放工厂创建的实例
	//
	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::__gc(lua_State* L)
	{
		LUA_BIND_STATE(L);

		TYPE* self = state.GetUserdata<TYPE>(1);
		assert(self);

#if LUA_BIND_PROFILER 
		std::cout << ": GC<" << TYPE::GetClassName() << ">\n";
#endif

		if (self->mWatchDog.mVMRef > 0)
			--self->mWatchDog.mVMRef;

		self->Release();

		return 0;
	}

	//
	// 输出格式如下:
	// 地址 类名
	//
	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::__tostring(lua_State* L)
	{
		// params: 
		// 1: userdata

		LUA_BIND_STATE(L);
		TYPE* self = state.GetUserdata<TYPE>(1);
		if (self)
		{
			cc8* classname = "";
			lua_getfield(state, 1, "GetClassName");
			if (state.IsType(-1, LUA_TFUNCTION))
			{
				lua_pushvalue(L, 1); // userdata 
				state.Call(1, 1); // 派生类的GetClassName函数
				classname = state.GetValue<cc8*>(-1, "");
			}
			else
			{
				classname = TYPE::GetClassName();
			}
			lua_pushfstring(L, "%s: %p", classname, self);
			return 1;
		}
		return 0;
	}

#if LUA_BIND_ENABLE_NATIVE_EXTEND
	// 派生出子类，在lua里对派生类的成员和行为进行重新设计，但是保证了userdata的统一。Native class的派生提供__init支持，在
	// native实体创建后可以使用__init进行初始化，派生类拥有和基类一样的New参数列表，且native对象是一样的类型。
	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_ExtendFactory(lua_State* L)
	{
		// upvalues:
		// 1: base class 

		// params: 
		// 1: class name 

		int baseClass = lua_upvalueindex(1);

		lua_newtable(L); // class table 

		int inheritClass = lua_gettop(L);

		// .GetClassName()
		cc8* type = lua_tostring(L, 1);
		lua_pushstring(L, type);
		lua_pushcclosure(L, luax_c_getupvalue, 1);
		lua_setfield(L, -2, "GetClassName");

		// .GetClass()
		lua_pushvalue(L, inheritClass);
		lua_pushcclosure(L, luax_c_getupvalue, 1);
		lua_setfield(L, -2, "GetClass");

		// .Extend()
		lua_pushvalue(L, inheritClass);
		lua_pushcclosure(L, _ExtendFactory, 1);
		lua_setfield(L, -2, "Extend");

		// .New() 
		lua_pushvalue(L, inheritClass);
		lua_getfield(L, baseClass, "New");
		lua_pushcclosure(L, _New, 2);
		lua_setfield(L, -2, "New");

		// __base = baseClass
		lua_pushvalue(L, baseClass);
		lua_setfield(L, -2, "__base");

		// __index = inheritClass
		lua_pushvalue(L, inheritClass);
		lua_setfield(L, -2, "__index");

		// metatable is baseClass
		lua_pushvalue(L, baseClass);
		lua_setmetatable(L, inheritClass);

		return 1;
	}

	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_ExtendSingleton(lua_State* L)
	{
		// upvalues:
		// 1: base class 

		// params: 
		// 1: class name 

		int baseClass = lua_upvalueindex(1);

		lua_newtable(L); // class name 

		int inheritClass = lua_gettop(L);

		// .GetClassName()
		cc8* type = lua_tostring(L, 1);
		lua_pushstring(L, type);
		lua_pushcclosure(L, luax_c_getupvalue, 1);
		lua_setfield(L, -2, "GetClassName");

		// .GetClass()
		lua_pushvalue(L, inheritClass);
		lua_pushcclosure(L, luax_c_getupvalue, 1);
		lua_setfield(L, -2, "GetClass");

		// .Extend()
		lua_pushvalue(L, inheritClass);
		lua_pushcclosure(L, _ExtendFactory, 1);
		lua_setfield(L, -2, "Extend");

		// __base = baseClass
		lua_pushvalue(L, baseClass);
		lua_setfield(L, -2, "__base");

		// __index = inheritClass
		lua_pushvalue(L, inheritClass);
		lua_setfield(L, -2, "__index");

		// metatable is baseClass
		lua_pushvalue(L, baseClass);
		lua_setmetatable(L, inheritClass);

		return 1;
	}

	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_New(lua_State* L)
	{
		LUA_BIND_STATE(L);

		// upvalues:
		// 1: class table 
		// 2: original New()

		// stack:
		// -1~-n: args

		int n = lua_gettop(L); // n args

		lua_pushvalue(L, lua_upvalueindex(2));
		if (state.IsType(-1, LUA_TFUNCTION))
		{
			// stack:
			// -1: New
			// -2~-1-n: args

			state.PushValues(-1 - n, n);

			// stack:
			// -1~-n: args
			// -n-1: New
			// -n-2~-1-2n: args

			state.Call(n, 1);

			// stack: 
			// -1: userdata 
			// -2~-1-n: args

			// reset member table's metatable to class table
			if (state.IsType(-1, LUA_TUSERDATA))
			{
				if (lua_getmetatable(L, -1)) // ref table
				{
					if (lua_getmetatable(L, -1)) // member table
					{
						lua_pushvalue(L, lua_upvalueindex(1)); // class table 
						lua_setmetatable(L, -2);
						state.Pop(); // member table
					}
					state.Pop(); // ref table
				}

				// stack: 
				// -1: userdata
				// -2~-1-n: args

				int args = state.AbsIndex(-1 - n);

				// 尝试调用__init函数
				lua_getfield(L, lua_upvalueindex(1), "__init");

				if (state.IsType(-1, LUA_TFUNCTION))
				{
					lua_pushvalue(L, -2); // userdata
					state.PushValues(args, n);
					state.Call(n + 1, 0);
				}
				else
					state.Pop();

			}

			return 1;
		}
		return 0;
	}

#endif /*LUA_BIND_ENABLE_NATIVE_EXTEND*/

	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_GetClass(lua_State* L)
	{
		LUA_BIND_STATE(L);
		if (!mClassTable)
			lua_pushnil(L);
		else
			mClassTable.PushRef(state);
		return 1;
	}

	template<class TYPE, class BASE>
	int NativeClass<TYPE, BASE>::_GetRefTable(lua_State* L)
	{
		LUA_BIND_STATE(L);
		TYPE* self = state.GetUserdata<TYPE>(1);
		bool success = self->PushRefTable(state);
		if (!success)
			lua_pushnil(L);
		return 1;
	}

	template<class TYPE, class BASE> StrongRef NativeClass<TYPE, BASE>::mClassTable;        // class table
	template<class TYPE, class BASE> StrongRef NativeClass<TYPE, BASE>::mSingletonRefTable; // 单例



}

#endif