Simple debug adapter for AutoHotKey implemented by AutoHotKey.
Features
Basic debug functions. Step into, step out, breakpoints etc.
Show call stack and varibles.
Change varibles in debugging
Debug ahkv2 or H version since debug protocol do not change.(by set AhkExecutable path to corresponding runtime path in launch.json)
Support port range. Adepter will choose the smallest available port in the range (Thanks to @mahmoudimus)
Experimental Feature
Conditional breakpoint
Hit Count(how many hits of the breakpoint are ignored)
Debug adapter will auto skip breakpoint until script hits breakpoint of a given count.
Exception breakpoint
Watch Expression
Attach Script
Support request type attach
Using
Open an AutoHotKey source file.
For most simple way, press f5 to debug it.
If you want to start at a specific setting. Switch to the debug viewlet.
Press the green 'play' button, if vs code doesn't find launch.json, it will creat one for you. Save it and switch back to ahk file you open.
Press the green button again, debugger will start.
Rule of change varibles
Basically, it is the same grammar with ahk
quoted string: such as "This is a quoted string."
=> type "string"
number: support int, float and hex.
eg. 12,12.123, 0xff => type "integer"(12), "float"(12.123), "integer"(255)
others: any other string is treated like that it assign to a varible with = in AHKv1.
=> type "string"
Supported Settings of Launch.json
type: always ahkdbg.
request: launch or attach.
name: name of a specific setting.
program: script file to be debugged(by default is file under editing).
stopOnEntry: stop on entry or not.
captureStreams: capture io streams or not.
AhkExecutable: change Default Execute Path. If left blank(use "" as value), the value of the item is automatically filled by the language support extension (by default is automaticlly acquired through registry, usually is C:\Program Files\Autohotkey\AutoHotkey.exe).
port: The port on which to listen for XDebug (default: 9005) can be an interger or range (example: "9000-9005").
args: Command line arguments passed to the program.
Known Issues
An early version which needs test. Use it at you own risk.
The max number of object children to be display is 99.
Development
How to run this in debug mode
Copy an Autohotkey interpreter(v1.37^) into extension_path\bin\AutoHotkey.exe. This is hard coded in extension.ts and used to run uncompiled version adapter.
Build
From 0.7.0 version, extension use a compiled version of debug adapter for a better experence. If any changes of DA is needed, the extension must be built again.
This project use yarn, so first step is: yarn install
Set ahk2exe compile option Base File to autohotkey v1.36 or above v1 version.
yarn run package
or if just compile debug adapter (located in bin\debugAdapter.exe). yarn run precompile
