lua_details.h

Go to the documentation of this file.

 
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#ifndef TASKOLIB_LUA_DETAILS_H_
#define TASKOLIB_LUA_DETAILS_H_
 
#include <chrono>
#include <functional>
#include <string>
#include <variant>
 
#include "sol/sol.hpp"
#include "taskolib/CommChannel.h"
#include "taskolib/Context.h"
#include "taskolib/TimeoutTrigger.h"
 
namespace task {
 
// Check that the lua lib has been build with the expected types
static_assert(std::is_same<LuaFloat, double>::value, "Unexpected Lua-internal floating point type");
static_assert(std::is_same<LuaInteger, long long>::value, "Unexpected Lua-internal integer type");
 
// Abort the execution of the script by raising a Lua error with the given error message.
void abort_script_with_error(lua_State* lua_state, const std::string& msg);
 
// Check if immediate termination has been requested via the CommChannel. If so, raise a
// Lua error.
void check_immediate_termination_request(lua_State* lua_state);
 
// Check if the step timeout has expired and raise a Lua error if that is the case.
void check_script_timeout(lua_State* lua_state);
 
CommChannel* get_comm_channel_ptr_from_registry(lua_State* lua_state);
 
const Context& get_context_from_registry(lua_State* lua_state);
 
OptionalStepIndex get_step_idx_from_registry(lua_State* lua_state);
 
// Return a time point in milliseconds since the epoch, calculated from a time point t0
// plus a duration dt. In case of overflow, the maximum representable time point is
// returned.
LuaInteger get_ms_since_epoch(TimePoint t0, std::chrono::milliseconds dt);
 
// A Lua hook that stops the execution of the script by raising a Lua error.
// This hook reinstalls itself so that it is called immediately if the execution should
// resume. This helps to break out of pcalls.
void hook_abort_with_error(lua_State* lua_state, lua_Debug*);
 
// Check if the step timeout has expired or if immediate termination has been requested
// via the comm channel. If so, raise a Lua error.
void hook_check_timeout_and_termination_request(lua_State* lua_state, lua_Debug*);
 
void install_custom_commands(sol::state& lua);
 
// Install hooks that check for timeouts and immediate termination requests while a Lua
// script is being executed. If one of both occurs, the script terminates with an error
// message that contains the abort marker.
void install_timeout_and_termination_request_hook(sol::state& lua, TimePoint now,
    std::chrono::milliseconds timeout, OptionalStepIndex step_idx, const Context& context,
    CommChannel* comm_channel, TimeoutTrigger* sequence_timeout);
 
// Open a safe subset of the Lua standard libraries in the given Lua state.
//
// This opens the math, string, table, and UTF8 libraries. The base library is also
// opened, but the following potentially dangerous commands are removed:
// \code
// collectgarbage, debug, dofile, load, loadfile, print, require
// \endcode
void open_safe_library_subset(sol::state& lua);
 
// An equivalent to Lua's print() function that stringifies and concatenates its arguments
// and finally sends a message of type Message::Type::output with the result.
void print_fct(sol::this_state, sol::variadic_args);
 
// Pause execution for the specified time, observing timeouts and termination requests.
void sleep_fct(double seconds, sol::this_state sol);
 
} // namespace task
 
#endif