mirror of
https://github.com/scp-fs2open/fs2open.github.com.git
synced 2026-11-07 22:56:30 -10:00
asarium
016c07dc3a
This adds a mechanism for running generic operations at specific points of the frame execution. This can be used by any part of the code an not just Lua since it simply executes std::functions. It also adds an "execution context" concept that specifies in which situation an operation should be executed. This is then used by the Lua Coroutines code for resuming coroutines at specific points instead of always when the awaited promise resolves.
79 lines
2.0 KiB
C++
79 lines
2.0 KiB
C++
#pragma once
|
|
|
|
#include "scripting/lua/LuaTypes.h"
|
|
|
|
namespace scripting {
|
|
namespace api {
|
|
|
|
/**
|
|
* @brief A context that manages an asynchronous operation
|
|
*
|
|
* This is the interface used by a LuaPromise for running pending promises. It gets passed a callback that should be
|
|
* called when a promise has resolved.
|
|
*/
|
|
class resolve_context {
|
|
public:
|
|
virtual ~resolve_context();
|
|
|
|
using Resolver = std::function<void(bool error, const luacpp::LuaValueList& resolveVals)>;
|
|
|
|
/**
|
|
* @brief Sets the function which is called when an asynchronous operation finishes
|
|
*
|
|
* @note For future compatibility, the operation represented by a subclass of this should not start executing until
|
|
* this function is called.
|
|
*
|
|
* @param resolver The function to call to resolve a coroutine
|
|
*/
|
|
virtual void setResolver(Resolver resolver) = 0;
|
|
};
|
|
|
|
class LuaPromise {
|
|
public:
|
|
using ContinuationFunction = std::function<luacpp::LuaValueList(const luacpp::LuaValueList& resolveVals)>;
|
|
|
|
/**
|
|
* @brief Initializes an invalid promise
|
|
*/
|
|
LuaPromise();
|
|
virtual ~LuaPromise();
|
|
|
|
/**
|
|
* @brief Creates a pending promise
|
|
* @param resolveContext The context to register on
|
|
*/
|
|
explicit LuaPromise(const std::shared_ptr<resolve_context>& resolveContext);
|
|
|
|
LuaPromise(const LuaPromise&);
|
|
LuaPromise& operator=(const LuaPromise&);
|
|
|
|
LuaPromise(LuaPromise&&) noexcept;
|
|
LuaPromise& operator=(LuaPromise&&) noexcept;
|
|
|
|
LuaPromise then(ContinuationFunction continuation);
|
|
|
|
LuaPromise catchError(ContinuationFunction continuation);
|
|
|
|
bool isValid() const;
|
|
|
|
bool isResolved() const;
|
|
|
|
bool isErrored() const;
|
|
|
|
const luacpp::LuaValueList& resolveValue() const;
|
|
|
|
const luacpp::LuaValueList& errorValue() const;
|
|
|
|
static LuaPromise resolved(luacpp::LuaValueList resolveValue);
|
|
|
|
static LuaPromise errored(luacpp::LuaValueList resolveValue);
|
|
private:
|
|
LuaPromise registerContinuation(bool catchErrors, ContinuationFunction continuation);
|
|
|
|
struct internal_state;
|
|
std::shared_ptr<internal_state> m_state;
|
|
};
|
|
|
|
} // namespace api
|
|
} // namespace scripting
|