You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
45 lines
1.7 KiB
45 lines
1.7 KiB
Ravi Debug Adapter for VSCode
|
|
=============================
|
|
|
|
The aim is to provide a debug adapter that allows Microsoft's Visual Studio Code to step through Ravi or
|
|
Lua code.
|
|
|
|
Implementation Notes
|
|
--------------------
|
|
The approach is to create a standalone executable that can be invoked by VSCode. VSCode communicates
|
|
with the adapter via stdin/stdout. This means that Lua cannot use stdin/stdout - but for now nothing is done
|
|
to prevent Lua access to these.
|
|
|
|
VSCode communicates with the adapter using a JSON wire protocol.
|
|
|
|
Status
|
|
------
|
|
This is work in progress but the basic debugger is working with following features.
|
|
|
|
* Launch a Ravi/Lua program and stop on entry
|
|
* Step through code
|
|
* Set breakpoints at line/source level
|
|
|
|
Only source files that are available on disk can be debugged
|
|
Only tested on Windows 10 so far.
|
|
|
|
Installation
|
|
------------
|
|
To install first build Ravi.
|
|
You should see a binary named `ravidebug.exe` built.
|
|
|
|
Install the debugger extension as follows:
|
|
|
|
1. Create a directory named `.vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1/bin` under the home directory.
|
|
2. Copy the `ravidebug` executable to the bin folder.
|
|
3. Copy the file `vscode-debugger/vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1/package.json` to the directory `.vscode/extensions/dibyendumajumdar.ravi-debug-0.0.1`.
|
|
|
|
Now when you open a directory containing Lua programs VSCode should allow you to launch a debug session. You will need to change the launch parameters as required but note that right now `LUA_PATH` and `LUA_CPATH` are not passed on to the debugger.
|
|
|
|
Screenshots
|
|
-----------
|
|
|
|
.. figure:: ../readthedocs/debugger-screenshot1.jpg
|
|
:alt: Ravi Debugger screenshot
|
|
|