3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
26 #include <unordered_map>
27 #include "common/helper.h"
28 #include "util/basic_macros.h"
35 #include "irrlichttypes.h"
36 #include "common/c_types.h"
37 #include "common/c_internal.h"
41 #define SCRIPTAPI_LOCK_DEBUG
42 #define SCRIPTAPI_DEBUG
44 // MUST be an invalid mod name so that mods can't
45 // use that name to bypass security!
46 #define BUILTIN_MOD_NAME "*builtin*"
48 #define PCALL_RES(RES) { \
49 int result_ = (RES); \
51 scriptError(result_, __FUNCTION__); \
55 #define runCallbacks(nargs, mode) \
56 runCallbacksRaw((nargs), (mode), __FUNCTION__)
58 #define setOriginFromTable(index) \
59 setOriginFromTableRaw(index, __FUNCTION__)
61 enum class ScriptingType: u8 {
75 class ServerActiveObject;
76 struct PlayerHPChangeReason;
78 class ScriptApiBase : protected LuaHelper {
80 ScriptApiBase(ScriptingType type);
81 // fake constructor to allow script API classes (e.g ScriptApiEnv) to virtually inherit from this one.
84 FATAL_ERROR("ScriptApiBase created without ScriptingType!");
86 virtual ~ScriptApiBase();
87 DISABLE_CLASS_COPY(ScriptApiBase);
89 // These throw a ModError on failure
90 void loadMod(const std::string &script_path, const std::string &mod_name);
91 void loadScript(const std::string &script_path);
94 void loadModFromMemory(const std::string &mod_name);
97 void runCallbacksRaw(int nargs,
98 RunCallbacksMode mode, const char *fxn);
101 void addObjectReference(ServerActiveObject *cobj);
102 void removeObjectReference(ServerActiveObject *cobj);
104 IGameDef *getGameDef() { return m_gamedef; }
106 ScriptingType getType() { return m_type; }
111 std::string getOrigin() { return m_last_run_mod; }
112 void setOriginDirect(const char *origin);
113 void setOriginFromTableRaw(int index, const char *fxn);
115 void clientOpenLibs(lua_State *L);
121 friend class ObjectRef;
122 friend class NodeMetaRef;
123 friend class ModApiBase;
124 friend class ModApiEnvMod;
125 friend class LuaVoxelManip;
127 lua_State* getStack()
128 { return m_luastack; }
131 void scriptError(int result, const char *fxn);
132 void stackDump(std::ostream &o);
134 void setGameDef(IGameDef* gamedef) { m_gamedef = gamedef; }
136 Environment* getEnv() { return m_environment; }
137 void setEnv(Environment* env) { m_environment = env; }
139 GUIEngine* getGuiEngine() { return m_guiengine; }
140 void setGuiEngine(GUIEngine* guiengine) { m_guiengine = guiengine; }
142 void objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj);
144 void pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason& reason);
146 std::recursive_mutex m_luastackmutex;
147 std::string m_last_run_mod;
148 bool m_secure = false;
149 #ifdef SCRIPTAPI_LOCK_DEBUG
150 int m_lock_recursion_count{};
151 std::thread::id m_owning_thread;
155 static int luaPanic(lua_State *L);
157 lua_State *m_luastack = nullptr;
159 IGameDef *m_gamedef = nullptr;
160 Environment *m_environment = nullptr;
161 GUIEngine *m_guiengine = nullptr;
162 ScriptingType m_type;