mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-09 04:49:39 -10:00
asarium
ebcf686cf7
This adds a Lua API for representing asynchronous operations and running coroutines based on those operations comfortably. This is very similar to features other languages have introduced such as C# or JavaScript. In fact, the whole "promise" thing is derived from how JavaScript represents these operations. This is the initial and very basic system for supporting async coroutines in Lua. There is no native support for running these operations at specific points (they run whenever the awaited promise resolved) or making sure they do not leak through different game states.
77 lines
1.5 KiB
C++
77 lines
1.5 KiB
C++
#pragma once
|
|
|
|
#include "LuaConvert.h"
|
|
#include "LuaTypes.h"
|
|
#include "LuaValue.h"
|
|
#include "LuaFunction.h"
|
|
|
|
#include <iterator>
|
|
|
|
namespace luacpp {
|
|
|
|
/**
|
|
* @brief Class to improve handling of lua threads (aka coroutines).
|
|
*
|
|
* This class provides a high-level interface to lua threads.
|
|
*
|
|
* @see LuaConvert
|
|
*/
|
|
class LuaThread : public LuaValue {
|
|
public:
|
|
using ErrorCallback = std::function<bool(lua_State* mainState, lua_State* thread)>;
|
|
struct ResumeState
|
|
{
|
|
bool completed = false;
|
|
LuaValueList returnVals;
|
|
};
|
|
|
|
/**
|
|
* @brief Creates a new empty thread.
|
|
*/
|
|
static LuaThread create(lua_State* L, const LuaFunction& func);
|
|
|
|
/**
|
|
* @brief Default constructor
|
|
*/
|
|
LuaThread();
|
|
|
|
/**
|
|
* @brief Copy-constructor
|
|
* @param other The other thread.
|
|
*/
|
|
LuaThread(const LuaThread&);
|
|
LuaThread& operator=(const LuaThread&);
|
|
|
|
LuaThread(LuaThread&&) noexcept;
|
|
LuaThread& operator=(LuaThread&&) noexcept;
|
|
|
|
~LuaThread() override;
|
|
|
|
/**
|
|
* @brief Sets a new reference.
|
|
* This overload checks if the passed reference is a thread
|
|
*
|
|
* @param ref The new reference
|
|
* @return void
|
|
*/
|
|
void setReference(const LuaReference& ref) override;
|
|
|
|
void setErrorCallback(ErrorCallback errorCallback);
|
|
|
|
ResumeState resume(const LuaValueList& params) const;
|
|
|
|
lua_State* getThreadHandle() const;
|
|
private:
|
|
LuaThread(lua_State* luaState, lua_State* threadHandle);
|
|
|
|
lua_State* _thread = nullptr;
|
|
ErrorCallback _errorCallback;
|
|
};
|
|
|
|
namespace convert {
|
|
|
|
bool popValue(lua_State* luaState, LuaThread& target, int stackposition = -1, bool remove = true);
|
|
|
|
}
|
|
} // namespace luacpp
|