From cf75d7b2c5e57c614ccbcb0a6ad3a87bd20090d8 Mon Sep 17 00:00:00 2001
From: peterbell10 <peterbell10@live.co.uk>
Date: Tue, 20 Feb 2018 10:43:28 +0000
Subject: cBlockInfo: Deprecate direct access to variables. (#4184)

---
 src/Bindings/DeprecatedBindings.cpp | 64 +++++++++++++++++++++++++++++++------
 1 file changed, 55 insertions(+), 9 deletions(-)

(limited to 'src/Bindings')

diff --git a/src/Bindings/DeprecatedBindings.cpp b/src/Bindings/DeprecatedBindings.cpp
index a4e5c372b..a297179f0 100644
--- a/src/Bindings/DeprecatedBindings.cpp
+++ b/src/Bindings/DeprecatedBindings.cpp
@@ -291,6 +291,32 @@ tolua_lerror:
 
 
 
+static int tolua_cBlockInfo_Get(lua_State * tolua_S)
+{
+	cLuaState L(tolua_S);
+	if (
+		!L.CheckParamStaticSelf("cBlockInfo") ||
+		!L.CheckParamNumber(2)
+	)
+	{
+		return 0;
+	}
+
+	BLOCKTYPE BlockType{};
+	L.GetStackValue(2, BlockType);
+
+	LOGWARNING("cBlockInfo:Get() is deprecated, use the static querying functions instead");
+	L.LogStackTrace(0);
+
+	cBlockInfo & BlockInfo = const_cast<cBlockInfo &>(cBlockInfo::Get(BlockType));
+	L.Push(&BlockInfo);
+	return 1;
+}
+
+
+
+
+
 static int tolua_cBlockInfo_GetPlaceSound(lua_State * tolua_S)
 {
 	cLuaState L(tolua_S);
@@ -347,7 +373,11 @@ static int tolua_set_cBlockInfo_m_PlaceSound(lua_State * tolua_S)
 
 
 
-static int tolua_get_cBlockInfo_m_IsSnowable(lua_State * tolua_S)
+/** cBlockInfo variables: access the corresponding getter function instead of the variable.
+\tparam VariableType The type of the variable being accessed.
+\tparam GetterFunction The function called to get the value returned to lua. */
+template <typename VariableType, VariableType (*GetterFunction)(BLOCKTYPE)>
+static int tolua_get_cBlockInfo(lua_State * tolua_S)
 {
 	cLuaState L(tolua_S);
 	if (!L.CheckParamSelf("const cBlockInfo"))
@@ -358,9 +388,10 @@ static int tolua_get_cBlockInfo_m_IsSnowable(lua_State * tolua_S)
 	const cBlockInfo * Self = nullptr;
 	L.GetStackValue(1, Self);
 
-	L.Push(cBlockInfo::IsSnowable(Self->m_BlockType));
-	LOGWARNING("cBlockInfo.m_IsSnowable is deprecated");
+	L.Push(GetterFunction(Self->m_BlockType));
+	LOGWARNING("cBlockInfo variables are deprecated, use the static functions instead.");
 	L.LogStackTrace(0);
+
 	return 1;
 }
 
@@ -368,7 +399,8 @@ static int tolua_get_cBlockInfo_m_IsSnowable(lua_State * tolua_S)
 
 
 
-static int tolua_set_cBlockInfo_m_IsSnowable(lua_State * tolua_S)
+/** cBlockInfo variables: Print deprecation message on assignment. */
+static int tolua_set_cBlockInfo(lua_State * tolua_S)
 {
 	cLuaState L(tolua_S);
 	if (!L.CheckParamSelf("cBlockInfo"))
@@ -376,7 +408,7 @@ static int tolua_set_cBlockInfo_m_IsSnowable(lua_State * tolua_S)
 		return 0;
 	}
 
-	LOGWARNING("cBlockInfo.m_IsSnowable is deprecated in favour of cBlockInfo::IsSnowable()");
+	LOGWARNING("cBlockInfo variables are deprecated in favour of the static functions.");
 	L.LogStackTrace(0);
 	return 0;
 }
@@ -417,7 +449,7 @@ static int tolua_set_cItem_m_Lore(lua_State * tolua_S)
 	if (
 		!L.CheckParamSelf("cItem") ||
 		!L.CheckParamString(2)
-		)
+	)
 	{
 		return 0;
 	}
@@ -586,9 +618,23 @@ void DeprecatedBindings::Bind(lua_State * tolua_S)
 	tolua_function(tolua_S, "StringToMobType", tolua_AllToLua_StringToMobType00);
 
 	tolua_beginmodule(tolua_S, "cBlockInfo");
-		tolua_function(tolua_S, "GetPlaceSound", tolua_cBlockInfo_GetPlaceSound);
-		tolua_variable(tolua_S, "m_PlaceSound", tolua_get_cBlockInfo_m_PlaceSound, tolua_set_cBlockInfo_m_PlaceSound);
-		tolua_variable(tolua_S, "m_IsSnowable", tolua_get_cBlockInfo_m_IsSnowable, tolua_set_cBlockInfo_m_IsSnowable);
+		tolua_function(tolua_S, "Get",                    tolua_cBlockInfo_Get);
+		tolua_function(tolua_S, "GetPlaceSound",          tolua_cBlockInfo_GetPlaceSound);
+		tolua_variable(tolua_S, "m_PlaceSound",           tolua_get_cBlockInfo_m_PlaceSound, tolua_set_cBlockInfo_m_PlaceSound);
+		tolua_variable(tolua_S, "m_LightValue",           tolua_get_cBlockInfo<NIBBLETYPE, cBlockInfo::GetLightValue        >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_SpreadLightFalloff",   tolua_get_cBlockInfo<NIBBLETYPE, cBlockInfo::GetSpreadLightFalloff>, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_Transparent",          tolua_get_cBlockInfo<bool,       cBlockInfo::IsTransparent        >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_OneHitDig",            tolua_get_cBlockInfo<bool,       cBlockInfo::IsOneHitDig          >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_PistonBreakable",      tolua_get_cBlockInfo<bool,       cBlockInfo::IsPistonBreakable    >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_IsRainBlocker",        tolua_get_cBlockInfo<bool,       cBlockInfo::IsRainBlocker        >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_IsSkylightDispersant", tolua_get_cBlockInfo<bool,       cBlockInfo::IsSkylightDispersant >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_IsSnowable",           tolua_get_cBlockInfo<bool,       cBlockInfo::IsSnowable           >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_IsSolid",              tolua_get_cBlockInfo<bool,       cBlockInfo::IsSolid              >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_UseableBySpectator",   tolua_get_cBlockInfo<bool,       cBlockInfo::IsUseableBySpectator >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_FullyOccupiesVoxel",   tolua_get_cBlockInfo<bool,       cBlockInfo::FullyOccupiesVoxel   >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_CanBeTerraformed",     tolua_get_cBlockInfo<bool,       cBlockInfo::CanBeTerraformed     >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_BlockHeight",          tolua_get_cBlockInfo<float,      cBlockInfo::GetBlockHeight       >, tolua_set_cBlockInfo);
+		tolua_variable(tolua_S, "m_Hardness",             tolua_get_cBlockInfo<float,      cBlockInfo::GetHardness          >, tolua_set_cBlockInfo);
 	tolua_endmodule(tolua_S);
 
 	tolua_beginmodule(tolua_S, "cItem");
-- 
cgit v1.2.3