如何改进 Lua 内部错误消息以包含行号？答案

【问题标题】：How do I improve Lua internal error messages to include line numbers?如何改进 Lua 内部错误消息以包含行号？
【发布时间】：2020-08-25 00:53:47
【问题描述】：

如何改进错误记录以包含行号？这是因为我在读取 Lua 文件时引发的内部错误。我收到的唯一错误消息是attempt to index a function value，没有行号或文件名。

void handleLuaError(lua_State* L, const char* msg, const char* filename) {
  handleError("%s %s: %s", msg, filename, lua_tostring(luaState, -1));
  lua_pop(L, 1);
  luaL_traceback (L, L, msg, 2);
  char* result = 0;
  if (lua_isstring(L, -1)) result = strdup_s(lua_tostring(L, -1));
  lua_pop(L, 1);
  SPDLOG_WARN("traceback: {}", result);
}

void readLua(const char *filename) {
  SPDLOG_INFO("readLua {}", filename);
  if (luaL_loadfile(luaState, filename) || lua_pcall(luaState, 0, 0, 0)) {
    handleLuaError(luaState, "Reading file", filename);
  }
}

如您所见，我尝试添加 luaL_traceback，但我从 luaL_traceback 得到的唯一消息是 stack traceback:，没有实际的回溯。我读到 lua_pcall 可以丢弃堆栈，并且我需要在错误发生时进行一些调试日志记录，例如在错误处理程序中，而不是在 lua_pcall 返回之后。有人建议我需要使用 xpcall 并提供自定义错误处理程序，但我找不到任何关于如何在 C++ 中调用 xpcall 的文档或示例代码。

如何设置自定义错误处理程序？或者有没有办法告诉 Lua 在内部错误中加入更多信息？当我在其他人的 StackOverflow 帖子中看到我的特定错误消息时，错误消息 (attempt to index ...) 会显示文件名和行号，因此应该可以通过此错误获取文件名和行号。

这是导致错误的 Lua 文件：

addAchievement({
  code = "AchNewCity",
  name = "A New City",
  text = "Welcome to NewCity. " ..
  "Your first task is to " ..
  "build some roads. Click " ..
  "on the Transportation Tool in the " ..
  "bottom left corner.",
  condition = "true",
  effect = "FRoadTool,FRoadStreet",
  hint = ""
});

【问题讨论】：

no line number or filename 你运行的是 Lua 脚本还是带有调试信息的 Lua 字节码？
这是一个脚本，而不是字节码。 if (luaL_loadfile(luaState, filename) || lua_pcall(luaState, 0, 0, 0)) {

标签： c++ lua

【解决方案1】：

如果有疑问，请检查原始源代码中的示例。 Lua 有一个解释器lua.c，它完全可以完成您想要完成的工作。您对msghandler、docall 和report 感兴趣。

lua_pcall 接受消息处理程序的索引作为第四个参数。它可用于检索有关错误环境等的信息。在lua_pcall 返回后，您将无法这样做（届时堆栈会展开）。

您的代码应该看起来更像：

int handleLuaError(lua_State* L) {
  const char * msg = lua_tostring(L, -1);
  luaL_traceback(L, L, msg, 2);
  lua_remove(L, -2); // Remove error/"msg" from stack.
  return 1; // Traceback is returned.
}

void readLua(const char *filename) {
  SPDLOG_INFO("readLua {}", filename);
  lua_pushcfunction(luaState, handleLuaError);
  if (LUA_OK != (luaL_loadfile(luaState, filename) || lua_pcall(luaState, 0, 0, -2))) {
     //                                                 handleLuaError's index ^^^
     handleError("Reading file %s: %s", filename, lua_tostring(luaState, -1));
     lua_pop(luaState, 1); // Pop traceback from stack.
  }
  lua_pop(luaState, 1); // Pop handleLuaError from stack.
}

现在，这是一个相当简单的实现。您应该考虑拆分 luaL_loadfile 和 lua_pcall 以对与加载文件直接相关的错误做出相应的反应。同样，您可以参考解释器的源代码：dofile，然后是dochunk。

此外，上面的示例缺少大部分重要的检查，尤其是测试lua_tostring 是否成功，除非您100% 以上确定返回的错误总是可以轻松转换为字符串。

您似乎有两种状态并存：luaState，有时L。我建议研究一下，它可能会在将来为您解决一些问题。

还有一点，除了luaL_traceback，你可能还对luaL_where感兴趣。它在内部与luaL_error 一起使用。

【讨论】：