使用SOL3在C++中捕获Lua执行输出至std::string遇困

1. 解决ExecuteLua返回nil的问题 #

如果你的ExecuteLua方法执行Lua代码后返回nil，通常是因为执行的代码块没有显式返回值，或者sol的调用方式未正确处理返回结果。

• 确保Lua代码最后包含return语句（比如执行表达式时）；
• 使用sol的script_result类型接收执行结果，判断是否为nil并处理：

sol::state lua;
lua.open_libraries(sol::lib::base);

std::vector<char> editor_content = ...; // 编辑器内容
std::string lua_code(editor_content.begin(), editor_content.end());

sol::script_result result = lua.script(lua_code, sol::script_pass_on_error);
if (result.valid()) {
    if (!result.is_nil()) {
        // 处理非nil结果，比如转换为std::string或其他类型
        std::string res_str = result.get<std::string>();
    }
}

2. 捕获Lua输出到std::string（替代stdout） #

要捕获Lua的print输出，需要替换Lua的全局print函数，将输出写入自定义的缓冲区：

#include <sol/sol.hpp>
#include <string>

std::string lua_output_buffer;

void custom_lua_print(sol::variadic_args va) {
    for (auto v : va) {
        lua_output_buffer += v.as<std::string>();
        lua_output_buffer += " ";
    }
    lua_output_buffer += "\n";
}

// 在初始化Lua状态时注册自定义print
sol::state lua;
lua.open_libraries(sol::lib::base);
lua["print"] = &custom_lua_print;

// 执行代码后，lua_output_buffer就保存了所有print输出
lua.script(lua_code);
// 可以清空缓冲区复用
lua_output_buffer.clear();

如果需要更完整的IO重定向（包括io.write），可以替换Lua的io库相关函数，自定义print是最直接的方案。

3. 处理sol.hpp的异常（避免崩溃） #

sol在执行错误的Lua代码时会抛出sol::error异常，必须用try-catch块捕获并处理：

try {
    sol::script_result result = lua.script(lua_code);
    // 处理正常结果
} catch (const sol::error& e) {
    std::string error_msg = e.what();
    // 将错误信息显示到ImGui编辑器或日志中
    // 比如：ImGui::TextColored(ImVec4(1,0,0,1), "%s", error_msg.c_str());
}

如果不想在执行脚本时立即抛出异常，可以使用sol::script_pass_on_error参数，之后通过result.valid()判断是否出错，再获取错误信息：

sol::script_result result = lua.script(lua_code, sol::script_pass_on_error);
if (!result.valid()) {
    sol::error err = result;
    std::string error_msg = err.what();
    // 处理错误
}

内容的提问来源于stack exchange，提问作者FoxMaccloud