SquirrelBinding.h

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
#include "common/Result.h"
#include "common/Value.h"
 
#include <squirrel.h>
#include <simplesquirrel/simplesquirrel.hpp>
 
#include <cstddef>
#include <functional>
#include <string>
#include <utility>
 
namespace eve::script {
 
struct EVENGINE_API_FOUNDATION_INLINE SquirrelValueOptions {
    std::size_t maxDepth    = 64;
    std::size_t maxElements = 100000;
    std::string source      = "squirrel.binding";
};
 
[[nodiscard]] EVENGINE_API_FOUNDATION Result<Value> valueFromSquirrel(HSQUIRRELVM vm, SQInteger index,
                                                                      const SquirrelValueOptions& options = {});
 
[[nodiscard]] EVENGINE_API_FOUNDATION Result<Value> valueFromSquirrel(const ssq::Object&          object,
                                                                      const SquirrelValueOptions& options = {});
 
[[nodiscard]] EVENGINE_API_FOUNDATION Result<void> pushValue(HSQUIRRELVM vm, const Value& value,
                                                             const SquirrelValueOptions& options = {});
 
[[nodiscard]] EVENGINE_API_FOUNDATION ssq::Table projectDiagnostic(HSQUIRRELVM vm, const Diagnostic& diagnostic);
 
[[nodiscard]] EVENGINE_API_FOUNDATION ssq::Table projectStatus(HSQUIRRELVM vm, const Status& status);
 
[[nodiscard]] EVENGINE_API ssq::Table projectStatusResult(HSQUIRRELVM vm, const Status& status);
 
[[nodiscard]] EVENGINE_API_FOUNDATION ssq::Table projectStatusResult(HSQUIRRELVM vm, const Status& status,
                                                                     const Value& value);
 
[[nodiscard]] EVENGINE_API_FOUNDATION ssq::Table projectStatusResult(HSQUIRRELVM vm, const Status& status,
                                                                     ssq::Object value);
 
EVENGINE_API_FOUNDATION void markResultHasValue(ssq::Table& result);
 
template <class T, class Projector>
[[nodiscard]] ssq::Table projectResult(HSQUIRRELVM vm, Result<T>&& result, Projector&& projector) {
    if (!result.ok()) return projectStatusResult(vm, result.status());
 
    const Status status  = result.status();
    T            payload = std::move(result).takeValue();
    return projectStatusResult(vm, status, std::invoke(std::forward<Projector>(projector), std::move(payload)));
}
 
[[nodiscard]] EVENGINE_API_FOUNDATION ssq::Table projectResult(HSQUIRRELVM vm, Result<void>&& result);
 
[[nodiscard]] EVENGINE_API_FOUNDATION bool ignoreResult(const ssq::Object& result, const std::string& reason);
 
EVENGINE_API_FOUNDATION void exposeResultBindings(ssq::Table& eveTable);
 
}  // namespace eve::script