Skip to content

Commit d820a6b

Browse files
PilzAdamPilzAdam
committedSep 10, 2013
Add Settings interface for Lua
·
5.11.00.4.8
1 parent 10a38a3 commit d820a6b

9 files changed

+331
-0
lines changed
 

‎doc/lua_api.txt

+14
Original file line numberDiff line numberDiff line change
@@ -1069,6 +1069,8 @@ minetest.pos_to_string({x=X,y=Y,z=Z}) -> "(X,Y,Z)"
10691069
minetest.string_to_pos(string) -> position
10701070
^ Same but in reverse
10711071
^ escapes characters [ ] \ , ; that can not be used in formspecs
1072+
minetest.is_yes(string)
1073+
^ returns whether string can be interpreted as yes
10721074

10731075
minetest namespace reference
10741076
-----------------------------
@@ -1737,6 +1739,18 @@ methods:
17371739
^ from (minx,miny,minz) to (maxx,maxy,maxz) in the order of [z [y [x]]]
17381740
- iterp(minp, maxp): same as above, except takes a vector
17391741

1742+
Settings: An interface to read config files in the format of minetest.conf
1743+
- Can be created via Settings(filename)
1744+
methods:
1745+
- get(key) -> value
1746+
- get_bool(key) -> boolean
1747+
- set(key, value)
1748+
- remove(key) -> success
1749+
- get_names() -> {key1,...}
1750+
- write() -> success
1751+
^ write changes to file
1752+
- to_table() -> {[key1]=value1,...}
1753+
17401754
Mapgen objects
17411755
---------------
17421756
A mapgen object is a construct used in map generation. Mapgen objects can be used by an on_generate

‎doc/menu_lua_api.txt

+6
Original file line numberDiff line numberDiff line change
@@ -182,3 +182,9 @@ string:split(separator)
182182
^ eg. string:split("a,b", ",") == {"a","b"}
183183
string:trim()
184184
^ eg. string.trim("\n \t\tfoo bar\t ") == "foo bar"
185+
minetest.is_yes(string)
186+
^ returns whether string can be interpreted as yes
187+
188+
Class reference
189+
----------------
190+
Settings: see lua_api.txt

‎src/script/lua_api/CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ set(common_SCRIPT_LUA_API_SRCS
1515
${CMAKE_CURRENT_SOURCE_DIR}/l_server.cpp
1616
${CMAKE_CURRENT_SOURCE_DIR}/l_util.cpp
1717
${CMAKE_CURRENT_SOURCE_DIR}/l_vmanip.cpp
18+
${CMAKE_CURRENT_SOURCE_DIR}/l_settings.cpp
1819
PARENT_SCOPE)
1920

2021
# Used by client only

‎src/script/lua_api/l_settings.cpp

+216
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
/*
2+
Minetest
3+
Copyright (C) 2013 PilzAdam <pilzadam@minetest.net>
4+
5+
This program is free software; you can redistribute it and/or modify
6+
it under the terms of the GNU Lesser General Public License as published by
7+
the Free Software Foundation; either version 2.1 of the License, or
8+
(at your option) any later version.
9+
10+
This program is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
GNU Lesser General Public License for more details.
14+
15+
You should have received a copy of the GNU Lesser General Public License along
16+
with this program; if not, write to the Free Software Foundation, Inc.,
17+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*/
19+
20+
#include "lua_api/l_settings.h"
21+
#include "lua_api/l_internal.h"
22+
#include "settings.h"
23+
#include "log.h"
24+
25+
// garbage collector
26+
int LuaSettings::gc_object(lua_State* L)
27+
{
28+
LuaSettings* o = *(LuaSettings **)(lua_touserdata(L, 1));
29+
delete o;
30+
return 0;
31+
}
32+
33+
// get(self, key) -> value
34+
int LuaSettings::l_get(lua_State* L)
35+
{
36+
NO_MAP_LOCK_REQUIRED;
37+
LuaSettings* o = checkobject(L, 1);
38+
39+
std::string key = std::string(luaL_checkstring(L, 2));
40+
if (o->m_settings->exists(key)) {
41+
std::string value = o->m_settings->get(key);
42+
lua_pushstring(L, value.c_str());
43+
} else {
44+
lua_pushnil(L);
45+
}
46+
47+
return 1;
48+
}
49+
50+
// get_bool(self, key) -> boolean
51+
int LuaSettings::l_get_bool(lua_State* L)
52+
{
53+
NO_MAP_LOCK_REQUIRED;
54+
LuaSettings* o = checkobject(L, 1);
55+
56+
std::string key = std::string(luaL_checkstring(L, 2));
57+
if (o->m_settings->exists(key)) {
58+
bool value = o->m_settings->getBool(key);
59+
lua_pushboolean(L, value);
60+
} else {
61+
lua_pushnil(L);
62+
}
63+
64+
return 1;
65+
}
66+
67+
// set(self, key, value)
68+
int LuaSettings::l_set(lua_State* L)
69+
{
70+
NO_MAP_LOCK_REQUIRED;
71+
LuaSettings* o = checkobject(L, 1);
72+
73+
std::string key = std::string(luaL_checkstring(L, 2));
74+
const char* value = luaL_checkstring(L, 3);
75+
76+
o->m_settings->set(key, value);
77+
78+
return 1;
79+
}
80+
81+
// remove(self, key) -> success
82+
int LuaSettings::l_remove(lua_State* L)
83+
{
84+
NO_MAP_LOCK_REQUIRED;
85+
LuaSettings* o = checkobject(L, 1);
86+
87+
std::string key = std::string(luaL_checkstring(L, 2));
88+
89+
bool success = o->m_settings->remove(key);
90+
lua_pushboolean(L, success);
91+
92+
return 1;
93+
}
94+
95+
// get_names(self) -> {key1, ...}
96+
int LuaSettings::l_get_names(lua_State* L)
97+
{
98+
NO_MAP_LOCK_REQUIRED;
99+
LuaSettings* o = checkobject(L, 1);
100+
101+
std::vector<std::string> keys = o->m_settings->getNames();
102+
103+
lua_newtable(L);
104+
for (unsigned int i=0; i < keys.size(); i++)
105+
{
106+
lua_pushstring(L, keys[i].c_str());
107+
lua_rawseti(L, -2, i + 1);
108+
}
109+
110+
return 1;
111+
}
112+
113+
// write(self) -> success
114+
int LuaSettings::l_write(lua_State* L)
115+
{
116+
NO_MAP_LOCK_REQUIRED;
117+
LuaSettings* o = checkobject(L, 1);
118+
119+
bool success = o->m_settings->updateConfigFile(o->m_filename.c_str());
120+
lua_pushboolean(L, success);
121+
122+
return 1;
123+
}
124+
125+
// to_table(self) -> {[key1]=value1,...}
126+
int LuaSettings::l_to_table(lua_State* L)
127+
{
128+
NO_MAP_LOCK_REQUIRED;
129+
LuaSettings* o = checkobject(L, 1);
130+
131+
std::vector<std::string> keys = o->m_settings->getNames();
132+
133+
lua_newtable(L);
134+
for (unsigned int i=0; i < keys.size(); i++)
135+
{
136+
lua_pushstring(L, o->m_settings->get(keys[i]).c_str());
137+
lua_setfield(L, -2, keys[i].c_str());
138+
}
139+
140+
return 1;
141+
}
142+
143+
LuaSettings::LuaSettings(const char* filename)
144+
{
145+
m_filename = std::string(filename);
146+
147+
m_settings = new Settings();
148+
m_settings->readConfigFile(m_filename.c_str());
149+
}
150+
151+
LuaSettings::~LuaSettings()
152+
{
153+
delete m_settings;
154+
}
155+
156+
void LuaSettings::Register(lua_State* L)
157+
{
158+
lua_newtable(L);
159+
int methodtable = lua_gettop(L);
160+
luaL_newmetatable(L, className);
161+
int metatable = lua_gettop(L);
162+
163+
lua_pushliteral(L, "__metatable");
164+
lua_pushvalue(L, methodtable);
165+
lua_settable(L, metatable); // hide metatable from Lua getmetatable()
166+
167+
lua_pushliteral(L, "__index");
168+
lua_pushvalue(L, methodtable);
169+
lua_settable(L, metatable);
170+
171+
lua_pushliteral(L, "__gc");
172+
lua_pushcfunction(L, gc_object);
173+
lua_settable(L, metatable);
174+
175+
lua_pop(L, 1); // drop metatable
176+
177+
luaL_openlib(L, 0, methods, 0); // fill methodtable
178+
lua_pop(L, 1); // drop methodtable
179+
180+
// Can be created from Lua (Settings(filename))
181+
lua_register(L, className, create_object);
182+
}
183+
184+
// LuaSettings(filename)
185+
// Creates an LuaSettings and leaves it on top of stack
186+
int LuaSettings::create_object(lua_State* L)
187+
{
188+
NO_MAP_LOCK_REQUIRED;
189+
const char* filename = luaL_checkstring(L, 1);
190+
LuaSettings* o = new LuaSettings(filename);
191+
*(void **)(lua_newuserdata(L, sizeof(void *))) = o;
192+
luaL_getmetatable(L, className);
193+
lua_setmetatable(L, -2);
194+
return 1;
195+
}
196+
197+
LuaSettings* LuaSettings::checkobject(lua_State* L, int narg)
198+
{
199+
NO_MAP_LOCK_REQUIRED;
200+
luaL_checktype(L, narg, LUA_TUSERDATA);
201+
void *ud = luaL_checkudata(L, narg, className);
202+
if(!ud) luaL_typerror(L, narg, className);
203+
return *(LuaSettings**)ud; // unbox pointer
204+
}
205+
206+
const char LuaSettings::className[] = "Settings";
207+
const luaL_reg LuaSettings::methods[] = {
208+
luamethod(LuaSettings, get),
209+
luamethod(LuaSettings, get_bool),
210+
luamethod(LuaSettings, set),
211+
luamethod(LuaSettings, remove),
212+
luamethod(LuaSettings, get_names),
213+
luamethod(LuaSettings, write),
214+
luamethod(LuaSettings, to_table),
215+
{0,0}
216+
};

‎src/script/lua_api/l_settings.h

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
/*
2+
Minetest
3+
Copyright (C) 2013 PilzAdam <pilzadam@minetest.net>
4+
5+
This program is free software; you can redistribute it and/or modify
6+
it under the terms of the GNU Lesser General Public License as published by
7+
the Free Software Foundation; either version 2.1 of the License, or
8+
(at your option) any later version.
9+
10+
This program is distributed in the hope that it will be useful,
11+
but WITHOUT ANY WARRANTY; without even the implied warranty of
12+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13+
GNU Lesser General Public License for more details.
14+
15+
You should have received a copy of the GNU Lesser General Public License along
16+
with this program; if not, write to the Free Software Foundation, Inc.,
17+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18+
*/
19+
20+
#ifndef L_SETTINGS_H_
21+
#define L_SETTINGS_H_
22+
23+
#include "lua_api/l_base.h"
24+
25+
class Settings;
26+
27+
class LuaSettings : public ModApiBase {
28+
private:
29+
static const char className[];
30+
static const luaL_reg methods[];
31+
32+
// garbage collector
33+
static int gc_object(lua_State* L);
34+
35+
// get(self, key) -> value
36+
static int l_get(lua_State* L);
37+
38+
// get_bool(self, key) -> boolean
39+
static int l_get_bool(lua_State* L);
40+
41+
// set(self, key, value)
42+
static int l_set(lua_State* L);
43+
44+
// remove(self, key) -> success
45+
static int l_remove(lua_State* L);
46+
47+
// get_names(self) -> {key1, ...}
48+
static int l_get_names(lua_State* L);
49+
50+
// write(self) -> success
51+
static int l_write(lua_State* L);
52+
53+
// to_table(self) -> {[key1]=value1,...}
54+
static int l_to_table(lua_State* L);
55+
56+
Settings* m_settings;
57+
std::string m_filename;
58+
59+
public:
60+
LuaSettings(const char* filename);
61+
~LuaSettings();
62+
63+
// LuaSettings(filename)
64+
// Creates an LuaSettings and leaves it on top of stack
65+
static int create_object(lua_State* L);
66+
67+
static LuaSettings* checkobject(lua_State* L, int narg);
68+
69+
static void Register(lua_State* L);
70+
71+
};
72+
73+
#endif

‎src/script/lua_api/l_util.cpp

+12
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,16 @@ int ModApiUtil::l_get_password_hash(lua_State *L)
220220
return 1;
221221
}
222222

223+
// is_yes(string)
224+
int ModApiUtil::l_is_yes(lua_State *L)
225+
{
226+
NO_MAP_LOCK_REQUIRED;
227+
std::string str = luaL_checkstring(L, 1);
228+
bool yes = is_yes(str);
229+
lua_pushboolean(L, yes);
230+
return 1;
231+
}
232+
223233
void ModApiUtil::Initialize(lua_State *L, int top)
224234
{
225235
API_FCT(debug);
@@ -237,5 +247,7 @@ void ModApiUtil::Initialize(lua_State *L, int top)
237247
API_FCT(get_hit_params);
238248

239249
API_FCT(get_password_hash);
250+
251+
API_FCT(is_yes);
240252
}
241253

‎src/script/lua_api/l_util.h

+3
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,9 @@ class ModApiUtil : public ModApiBase {
7171
// get_password_hash(name, raw_password)
7272
static int l_get_password_hash(lua_State *L);
7373

74+
// is_yes(string)
75+
static int l_is_yes(lua_State *L);
76+
7477
public:
7578
static void Initialize(lua_State *L, int top);
7679

‎src/script/scripting_game.cpp

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
3535
#include "lua_api/l_server.h"
3636
#include "lua_api/l_util.h"
3737
#include "lua_api/l_vmanip.h"
38+
#include "lua_api/l_settings.h"
3839

3940
extern "C" {
4041
#include "lualib.h"
@@ -96,4 +97,5 @@ void GameScripting::InitializeModApi(lua_State *L, int top)
9697
NodeMetaRef::Register(L);
9798
NodeTimerRef::Register(L);
9899
ObjectRef::Register(L);
100+
LuaSettings::Register(L);
99101
}

‎src/script/scripting_mainmenu.cpp

+4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
2424
#include "lua_api/l_base.h"
2525
#include "lua_api/l_mainmenu.h"
2626
#include "lua_api/l_util.h"
27+
#include "lua_api/l_settings.h"
2728

2829
extern "C" {
2930
#include "lualib.h"
@@ -62,4 +63,7 @@ void MainMenuScripting::InitializeModApi(lua_State *L, int top)
6263
// Initialize mod api modules
6364
ModApiMainMenu::Initialize(L, top);
6465
ModApiUtil::Initialize(L, top);
66+
67+
// Register reference classes (userdata)
68+
LuaSettings::Register(L);
6569
}

0 commit comments

Comments
 (0)
Please sign in to comment.