【ZeloEngine】Lua调试器

【ZeloEngine】Lua调试器

Lua没有非常强势的IDE和调试器方案，基本上都是专用方案造的轮子

尝试了几个方案（按时间顺序）

• Decoda
• LuaPerfect
• EmmyLua（Clion）
• ZeroBrane
• LuaPanda

调试器核心的实现都是一样的Remote Debug，被调试代码是一个客户端，调试器IDE是一个服务端，两端用socket连接

基本上都会选择luasocket+mobdebug作为调试器核心

有几个可以考量的地方：

• 调试器接入，有没有遇到卡点？
• 启动步骤和启动速度，是否太繁琐，或者太慢？
• 界面，是否美观，是否使用熟悉已有的IDE？
• 调试器功能，是否有BUG？

根据这几点，评估一下这几个方案的使用体验

Decoda

最早的Lua调试器方案

Decoda是做《自然选择2》游戏的工作室开发时自研的IDE

IDE总体非常简陋

创建一个工程，指定启动的exe，一键调试

不需要装依赖，它的方法是自己动态hook进lua API，根据loadbuffer的参数识别lua文件名来调试

这个思路和其他调试器都不一样

支持和Visual Studio联调C++和Lua，两个IDE一个Attach Debug即可

界面功能上，比较特别的是可以看多个VM

实现细节

• Decoda根据Lua C API的名字hook注入来实现
  • 所以可以魔改Lua源码，不影响Decoda
  • 需要符号表，用lua.dll或者pdb

LuaPerfect

LuaPrefect是我前一段时间开发UI时一直用的调试器，因为他成功接入了，并且能调试

LuaPerfect的设置步骤是最方便的，他自己编了一个LuaDebugee.dll，IDE创建工程时选择exe，就会把dll拷贝过去，就可以直接调试了，没有其他IDE缺luasocket的问题

LuaDebuggee.dll has been copied to General directory: "C:/Users/xxx/ZeloEngine/cmake-build-debug/".

Start debugging by executing:
require('LuaDebuggee').StartDebug('127.0.0.1', 9826)

编辑器是一个全新开发的界面（挺厉害的），风格类似Visual Studio

界面的美观度，调试器界面功能还是有些欠缺的

BUG方面，遇到过strict.lua的问题，开调试器到debug.getinfo会有问题

EmmyLua

EmmyLua是插件形式，搭配JetBrain或者VS Code

一直使用他作为代码编辑插件，配合Clion开发C++和Lua，编辑体验统一

debugger很长一段时间没有解决，卡在mobdebug需要luasocket上，今天终于解决了

BUG 代码跳转有问题，同一个文件内的方法定义和引用没有办法识别

BUG 断点前隔了一段C++代码就无法停下了，只有main第一次进入脚本时断点有效，这个很致命，废了

ZeroBraneStudio

同样是mobdebug的问题

一套全新的Lua IDE，界面功能和美观度比较完善

但是我并没有太多使用它编辑代码

Lua Panda

VSCode插件，依赖luasocket，要自己装

启动有点慢，10s

但是VSCode比较熟悉

安装luasocket

Windows上搞很麻烦。

luasocket，luarocks等一套lua的环境，在linux上编译搭建非常方便

luasocket没有cmake

ZeloEngine之前的理念是统一使用静态链接，包括lua

这是不会有幺蛾子的方法，lua脚本引用的第三方库，也可以静态链接，启动时调用luaopen_xxx来加载

但是luasocket没有cmake，蛋疼

那走dll，然后发现socket.core.dll依赖lua51.dll

所以需要lua编译成dll动态链接

动态链接要注意一个问题，就是name mangling

lua我是从源码编译链接到ZeloEngine的，Zelo是C++，lua是C

之前偷懒，把lua所有.c改成.cpp用C++编译，静态链接，自己写没问题

但是编译成lua.dll就有问题了，因为dll是基于符号名字去找引用的，C++的name mangling改了符号名字导致还是无法加载dll

非常坑，这种都是系统错误，不是C++层面的，没有很好的调试方法，只能靠猜

启动代码汇总

LuaPerfect

require('LuaDebuggee').StartDebug('127.0.0.1', 9826)

ZeroBraneStudio & EmmyLua

local ZBS = "D:\\Installed\\ZeroBraneStudio"
package.path = package.path .. ";" .. ZBS .. "\\lualibs\\?\\?.lua;" .. ZBS .. "\\lualibs\\?.lua"
package.cpath = package.cpath .. ";" .. ZBS .. "\\bin\\?.dll;" .. ZBS .. "\\bin\\clibs\\?.dll"

print("package.path", package.path)
print("package.cpath", package.cpath)

require("mobdebug").start()

LuaPanda

require("LuaPanda").start("127.0.0.1",8818);