[CSM] Add minimap API modifiers (#5399)

* Rename Mapper (too generic) to Minimap
* Add lua functions to get/set position, angle, mode for minimap
* Client: rename m_mapper to m_minimap
* Add minimap to core.ui namespace (core.ui.minimap)
* Add various functions to manage minimap (show, hide, toggle_shape)
* Cleanup trivial declaration in client

4 files changed, 268 insertions, 0 deletions

diff --git a/src/script/clientscripting.cpp b/src/script/clientscripting.cpp
index ccdcb928d..1b73fdf0d 100644
--- a/src/script/clientscripting.cpp
+++ b/src/script/clientscripting.cpp
@@ -22,6 +22,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "client.h"
 #include "cpp_api/s_internal.h"
 #include "lua_api/l_client.h"
+#include "lua_api/l_minimap.h"
 #include "lua_api/l_storage.h"
 #include "lua_api/l_sound.h"
 #include "lua_api/l_util.h"
@@ -40,9 +41,14 @@ ClientScripting::ClientScripting(Client *client):
 	lua_getglobal(L, "core");
 	int top = lua_gettop(L);
 
+	lua_newtable(L);
+	lua_setfield(L, -2, "ui");
+
 	InitializeModApi(L, top);
 	lua_pop(L, 1);
 
+	LuaMinimap::create(L, client->getMinimap());
+
 	// Push builtin initialization type
 	lua_pushstring(L, "client");
 	lua_setglobal(L, "INIT");
@@ -59,4 +65,5 @@ void ClientScripting::InitializeModApi(lua_State *L, int top)
 
 	LuaItemStack::Register(L);
 	StorageRef::Register(L);
+  LuaMinimap::Register(L);
 }
diff --git a/src/script/lua_api/CMakeLists.txt b/src/script/lua_api/CMakeLists.txt
index 2d25d845c..f7f22870e 100644
--- a/src/script/lua_api/CMakeLists.txt
+++ b/src/script/lua_api/CMakeLists.txt
@@ -25,6 +25,7 @@ set(common_SCRIPT_LUA_API_SRCS
 set(client_SCRIPT_LUA_API_SRCS
 	${CMAKE_CURRENT_SOURCE_DIR}/l_client.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/l_mainmenu.cpp
+	${CMAKE_CURRENT_SOURCE_DIR}/l_minimap.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/l_storage.cpp
 	${CMAKE_CURRENT_SOURCE_DIR}/l_sound.cpp
 	PARENT_SCOPE)
diff --git a/src/script/lua_api/l_minimap.cpp b/src/script/lua_api/l_minimap.cpp
new file mode 100644
index 000000000..bbe9aef82
--- /dev/null
+++ b/src/script/lua_api/l_minimap.cpp
@@ -0,0 +1,196 @@
+/*
+Minetest
+Copyright (C) 2017 Loic Blot <loic.blot@unix-experience.fr>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+
+#include "lua_api/l_minimap.h"
+#include "lua_api/l_internal.h"
+#include "common/c_converter.h"
+#include "minimap.h"
+
+LuaMinimap::LuaMinimap(Minimap *m)
+{
+	m_minimap = m;
+}
+
+void LuaMinimap::create(lua_State *L, Minimap *m)
+{
+	LuaMinimap *o = new LuaMinimap(m);
+	*(void **)(lua_newuserdata(L, sizeof(void *))) = o;
+	luaL_getmetatable(L, className);
+	lua_setmetatable(L, -2);
+
+	// Keep minimap object stack id
+	int minimap_object = lua_gettop(L);
+
+	lua_getglobal(L, "core");
+	lua_getfield(L, -1, "ui");
+	luaL_checktype(L, -1, LUA_TTABLE);
+	int uitable = lua_gettop(L);
+
+	lua_pushvalue(L, minimap_object); // Copy object to top of stack
+	lua_setfield(L, uitable, "minimap");
+}
+
+int LuaMinimap::l_get_pos(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	push_v3s16(L, m->getPos());
+	return 1;
+}
+
+int LuaMinimap::l_set_pos(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	m->setPos(read_v3s16(L, 2));
+	return 1;
+}
+
+int LuaMinimap::l_get_angle(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	lua_pushinteger(L, m->getAngle());
+	return 1;
+}
+
+int LuaMinimap::l_set_angle(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	m->setAngle(lua_tointeger(L, 2));
+	return 1;
+}
+
+int LuaMinimap::l_get_mode(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	lua_pushinteger(L, m->getMinimapMode());
+	return 1;
+}
+
+int LuaMinimap::l_set_mode(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	s32 mode = lua_tointeger(L, 2);
+	if (mode < MINIMAP_MODE_OFF ||
+		mode >= MINIMAP_MODE_COUNT) {
+		return 0;
+	}
+
+	m->setMinimapMode((MinimapMode) mode);
+	return 1;
+}
+
+int LuaMinimap::l_toggle_shape(lua_State *L)
+{
+	LuaMinimap *ref = checkobject(L, 1);
+	Minimap *m = getobject(ref);
+
+	m->toggleMinimapShape();
+	return 1;
+}
+
+int LuaMinimap::l_show(lua_State *L)
+{
+	Client *client = getClient(L);
+	assert(client);
+	client->setMinimapShownByMod(true);
+	return 1;
+}
+
+int LuaMinimap::l_hide(lua_State *L)
+{
+	Client *client = getClient(L);
+	assert(client);
+	client->setMinimapShownByMod(false);
+	return 1;
+}
+
+LuaMinimap *LuaMinimap::checkobject(lua_State *L, int narg)
+{
+	NO_MAP_LOCK_REQUIRED;
+
+	luaL_checktype(L, narg, LUA_TUSERDATA);
+
+	void *ud = luaL_checkudata(L, narg, className);
+	if (!ud)
+		luaL_typerror(L, narg, className);
+
+	return *(LuaMinimap **)ud;  // unbox pointer
+}
+
+Minimap* LuaMinimap::getobject(LuaMinimap *ref)
+{
+	return ref->m_minimap;
+}
+
+int LuaMinimap::gc_object(lua_State *L) {
+	LuaMinimap *o = *(LuaMinimap **)(lua_touserdata(L, 1));
+	delete o;
+	return 0;
+}
+
+void LuaMinimap::Register(lua_State *L)
+{
+	lua_newtable(L);
+	int methodtable = lua_gettop(L);
+	luaL_newmetatable(L, className);
+	int metatable = lua_gettop(L);
+
+	lua_pushliteral(L, "__metatable");
+	lua_pushvalue(L, methodtable);
+	lua_settable(L, metatable);  // hide metatable from Lua getmetatable()
+
+	lua_pushliteral(L, "__index");
+	lua_pushvalue(L, methodtable);
+	lua_settable(L, metatable);
+
+	lua_pushliteral(L, "__gc");
+	lua_pushcfunction(L, gc_object);
+	lua_settable(L, metatable);
+
+	lua_pop(L, 1);  // drop metatable
+
+	luaL_openlib(L, 0, methods, 0);  // fill methodtable
+	lua_pop(L, 1);  // drop methodtable
+}
+
+const char LuaMinimap::className[] = "Minimap";
+const luaL_reg LuaMinimap::methods[] = {
+	luamethod(LuaMinimap, show),
+	luamethod(LuaMinimap, hide),
+	luamethod(LuaMinimap, get_pos),
+	luamethod(LuaMinimap, set_pos),
+	luamethod(LuaMinimap, get_angle),
+	luamethod(LuaMinimap, set_angle),
+	luamethod(LuaMinimap, get_mode),
+	luamethod(LuaMinimap, set_mode),
+	luamethod(LuaMinimap, toggle_shape),
+	{0,0}
+};
diff --git a/src/script/lua_api/l_minimap.h b/src/script/lua_api/l_minimap.h
new file mode 100644
index 000000000..d9bb8842c
--- /dev/null
+++ b/src/script/lua_api/l_minimap.h
@@ -0,0 +1,64 @@
+/*
+Minetest
+Copyright (C) 2017 Loic Blot <loic.blot@unix-experience.fr>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+*/
+
+#ifndef L_MINIMAP_H_
+#define L_MINIMAP_H_
+
+#include "l_base.h"
+
+
+class Minimap;
+
+class LuaMinimap : public ModApiBase {
+private:
+
+	static const char className[];
+	static const luaL_reg methods[];
+
+	// garbage collector
+	static int gc_object(lua_State *L);
+
+	static int l_get_pos(lua_State *L);
+	static int l_set_pos(lua_State *L);
+
+	static int l_get_angle(lua_State *L);
+	static int l_set_angle(lua_State *L);
+
+	static int l_get_mode(lua_State *L);
+	static int l_set_mode(lua_State *L);
+
+	static int l_show(lua_State *L);
+	static int l_hide(lua_State *L);
+
+	static int l_toggle_shape(lua_State *L);
+
+	Minimap *m_minimap;
+public:
+	LuaMinimap(Minimap *m);
+	~LuaMinimap() {}
+
+	static void create(lua_State *L, Minimap *object);
+
+	static LuaMinimap *checkobject(lua_State *L, int narg);
+	static Minimap* getobject(LuaMinimap *ref);
+
+	static void Register(lua_State *L);
+};
+
+#endif // L_MINIMAP_H_