Luanti 5.19.0-dev
Loading...
Searching...
No Matches
s_base.h
Go to the documentation of this file.
1// Luanti
2// SPDX-License-Identifier: LGPL-2.1-or-later
3// Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
5#pragma once
6
7#include <iostream>
8#include <string>
9#include <mutex>
10#include "common/helper.h"
11#include "util/basic_macros.h"
12
13extern "C" {
14#include <lua.h>
15#include <lualib.h>
16}
17
18#include "irrlichttypes.h"
19#include "common/c_internal.h"
20#include "debug.h"
21#include "config.h"
22
23#ifndef NDEBUG
24#include <thread>
25
26#define SCRIPTAPI_LOCK_DEBUG
27#endif
28
29// MUST be an invalid mod name so that mods can't
30// use that name to bypass security!
31#define BUILTIN_MOD_NAME "*builtin*"
32
33#define PCALL_RES(RES) { \
34 int result_ = (RES); \
35 if (result_ != 0) { \
36 scriptError(result_, __FUNCTION__); \
37 } \
38}
39
40#define runCallbacks(nargs, mode) \
41 runCallbacksRaw((nargs), (mode), __FUNCTION__)
42
43#define setOriginFromTable(index) \
44 setOriginFromTableRaw(index, __FUNCTION__)
45
46enum class ScriptingType: u8 {
47 Async, // either mainmenu (client) or ingame (server)
48 Client, // CPCSM
54};
55
56class Server;
57#if CHECK_CLIENT_BUILD()
58class Client;
59#endif
60class EmergeThread;
61class IGameDef;
62class Environment;
63class GUIEngine;
67struct ModVFS;
68
69class ScriptApiBase : protected LuaHelper {
70public:
72 // fake constructor to allow script API classes (e.g ScriptApiEnv) to virtually inherit from this one.
74 {
75 FATAL_ERROR("ScriptApiBase created without ScriptingType!");
76 }
77 virtual ~ScriptApiBase();
79
80 // These throw a ModError on failure
81 void loadMod(const std::string &script_path, const std::string &mod_name);
82 void loadScript(const std::string &script_path);
83
84#if CHECK_CLIENT_BUILD()
85 void loadModFromMemory(const std::string &mod_name, std::string init_path = "");
86#endif
87
88 void runCallbacksRaw(int nargs,
89 RunCallbacksMode mode, const char *fxn);
90
91 /* object */
94
96
99#if CHECK_CLIENT_BUILD()
100 Client *getClient();
101 ModVFS *getModVFS();
102#endif
103
104 // IMPORTANT: These cannot be used for any security-related uses, they exist
105 // only to enrich error messages.
106 const std::string &getOrigin() { return m_last_run_mod; }
107 void setOriginDirect(const char *origin);
108 void setOriginFromTableRaw(int index, const char *fxn);
109
118 static std::string getCurrentModNameInsecure(lua_State *L);
119
120#if !CHECK_CLIENT_BUILD()
121 inline void clientOpenLibs(lua_State *L) { assert(false); }
122#else
123 void clientOpenLibs(lua_State *L);
124#endif
125
126 // Check things that should be set by the builtin mod.
127 void checkSetByBuiltin();
128
129protected:
130 friend class LuaABM;
131 friend class LuaLBM;
132 friend class InvRef;
133 friend class ObjectRef;
134 friend class NodeMetaRef;
135 friend class ModApiBase;
136 friend class ModApiEnv;
137 friend class LuaVoxelManip;
138 friend class TestMoveAction; // needs getStack()
139
140 /*
141 Subtle edge case with coroutines: If for whatever reason you have a
142 method in a subclass that's called from an existing lua_CFunction
143 (any of the l_*.cpp files) then make it static and take the lua_State*
144 as an argument. This is REQUIRED because getStack() will not return the
145 correct state if called inside coroutines.
146 */
147 lua_State* getStack()
148 { return m_luastack; }
149
150 // Checks that stack size is sane
151 void realityCheck();
152 // Takes an error from lua_pcall and throws it as a LuaError
153 void scriptError(int result, const char *fxn);
154 // Dumps stack contents for debugging
155 void stackDump(std::ostream &o);
156
157 void setGameDef(IGameDef* gamedef) { m_gamedef = gamedef; }
158
160 void setEnv(Environment* env) { m_environment = env; }
161
162#if CHECK_CLIENT_BUILD()
163 GUIEngine* getGuiEngine() { return m_guiengine; }
164 void setGuiEngine(GUIEngine* guiengine) { m_guiengine = guiengine; }
165
166 SSCSMEnvironment *getSSCSMEnv() { return m_sscsm_environment; }
167 void setSSCSMEnv(SSCSMEnvironment *env) { m_sscsm_environment = env; }
168#endif
169
171 void setEmergeThread(EmergeThread *emerge) { m_emerge = emerge; }
172
173 void objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj);
174
175 void pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason& reason);
176
177 std::recursive_mutex m_luastackmutex;
178 std::string m_last_run_mod;
179
180#ifdef SCRIPTAPI_LOCK_DEBUG
182 std::thread::id m_owning_thread;
183#endif
184
185private:
186 static int luaPanic(lua_State *L);
187
188 lua_State *m_luastack = nullptr;
189
190 IGameDef *m_gamedef = nullptr;
192#if CHECK_CLIENT_BUILD()
193 GUIEngine *m_guiengine = nullptr;
194 SSCSMEnvironment *m_sscsm_environment = nullptr;
195#endif
197
199};
RunCallbacksMode
Definition c_internal.h:87
Definition client.h:108
Definition emerge_internal.h:25
Definition environment.h:32
implementation of main menu based upon formspecs
Definition guiEngine.h:115
Definition gamedef.h:26
Definition helper.h:15
The thread that runs SSCSM code.
Definition sscsm_environment.h:26
Definition s_base.h:69
static std::string getCurrentModNameInsecure(lua_State *L)
Returns the currently running mod, only during init time.
Definition s_base.cpp:265
void setOriginDirect(const char *origin)
Definition s_base.cpp:436
void addObjectReference(ServerActiveObject *cobj)
Definition s_base.cpp:458
friend class InvRef
Definition s_base.h:132
std::recursive_mutex m_luastackmutex
Definition s_base.h:177
void setEnv(Environment *env)
Definition s_base.h:160
void stackDump(std::ostream &o)
Definition s_base.cpp:408
friend class ModApiBase
Definition s_base.h:135
void pushPlayerHPChangeReason(lua_State *L, const PlayerHPChangeReason &reason)
Definition s_base.cpp:560
friend class ModApiEnv
Definition s_base.h:136
Environment * getEnv()
Definition s_base.h:159
IGameDef * getGameDef()
Definition s_base.h:97
EmergeThread * m_emerge
Definition s_base.h:196
IGameDef * m_gamedef
Definition s_base.h:190
void realityCheck()
Definition s_base.cpp:393
friend class LuaLBM
Definition s_base.h:131
ScriptingType getType()
Definition s_base.h:95
DISABLE_CLASS_COPY(ScriptApiBase)
friend class TestMoveAction
Definition s_base.h:138
EmergeThread * getEmergeThread()
Definition s_base.h:170
int m_lock_recursion_count
Definition s_base.h:181
friend class ObjectRef
Definition s_base.h:133
void clientOpenLibs(lua_State *L)
Definition s_base.h:121
friend class NodeMetaRef
Definition s_base.h:134
friend class LuaVoxelManip
Definition s_base.h:137
void setEmergeThread(EmergeThread *emerge)
Definition s_base.h:171
ScriptApiBase()
Definition s_base.h:73
ScriptingType m_type
Definition s_base.h:198
std::string m_last_run_mod
Definition s_base.h:178
void loadScript(const std::string &script_path)
Definition s_base.cpp:281
void loadMod(const std::string &script_path, const std::string &mod_name)
Definition s_base.cpp:273
void removeObjectReference(ServerActiveObject *cobj)
Definition s_base.cpp:510
friend class LuaABM
Definition s_base.h:130
Server * getServer()
Definition s_base.cpp:592
lua_State * m_luastack
Definition s_base.h:188
void setGameDef(IGameDef *gamedef)
Definition s_base.h:157
ScriptApiBase(ScriptingType type)
Definition s_base.cpp:83
static int luaPanic(lua_State *L)
Definition s_base.cpp:202
const std::string & getOrigin()
Definition s_base.h:106
lua_State * getStack()
Definition s_base.h:147
void runCallbacksRaw(int nargs, RunCallbacksMode mode, const char *fxn)
Definition s_base.cpp:352
void checkSetByBuiltin()
Definition s_base.cpp:240
std::thread::id m_owning_thread
Definition s_base.h:182
void scriptError(int result, const char *fxn)
Definition s_base.cpp:403
void setOriginFromTableRaw(int index, const char *fxn)
Definition s_base.cpp:441
Environment * m_environment
Definition s_base.h:191
void objectrefGetOrCreate(lua_State *L, ServerActiveObject *cobj)
Definition s_base.cpp:543
Definition serveractiveobject.h:42
Definition server.h:179
#define FATAL_ERROR(msg)
Definition debug.h:51
ScriptingType
Definition s_base.h:46
@ SSCSM
Definition s_base.h:53
@ Async
Definition s_base.h:47
@ Emerge
Definition s_base.h:51
@ PauseMenu
Definition s_base.h:52
@ MainMenu
Definition s_base.h:49
Definition mod_vfs.h:11
Definition player_sao.h:235