Rationale

Vim9 comes with a builtin :disassemble command which displays the low-level instructions generated for a compiled function. This output cannot be searched, is not syntax highlighted, and does not provide information regarding the meaning of each instruction.

This package provides a custom :Disassemble command whose purpose is to display the output of the builtin :disassemble command in a new window. The code is syntax highlighted, and folded to let you focus on the instructions for a given line of Vim9 script. Hints can be displayed for the instructions; either via a dynamic popup window for the instruction name under the cursor, or via virtual texts for all the instructions at once.

Usage

# display generated instructions for MyCompiledFunction in a new horizontal split window
:Disassemble MyCompiledFunctionName()

# same thing but with the instructions used for profiling and in a vertical split window
:vertical Disassemble profile MyCompiledFunctionName()

# same thing but with the instructions used for debugging and in a new tab page
:tab Disassemble debug MyCompiledFunctionName()

# display a hint popup when the cursor is over an instruction name
:Vim9asmHint

# display hints for all instructions via virtual texts
:Vim9asmHint virtual

# stop displaying hints
:Vim9asmHint!

# automatically open/close folds to only display instructions
# for 1 Vim9 script line of code at a time
:Vim9asmFocus

# stop automatically opening/closing folds
:Vim9asmFocus!

While the cursor is on the name of a function inside a generated instruction, you can press <C-]> to get the instructions for that function. To jump back to the previous one, press <C-T>.

Configuration

The plugin can be customized with g:vim9asm:

# in a Vim9 script
g:vim9asm = {
  # automatically open/close folds
  autofocus: true,
  # automatically display hints about instruction names
  autohint: true,
  # display hints in popup window (to display them as virtual texts, set the key to 'virtual')
  hint_type: 'popup',
  hint: {
    # determine background color of popup
    highlight: 'Pmenu',
    # draw border around popup
    border: [],
    # determine characters used to draw border
    borderchars: ['─', '│', '─', '│', '┌', '┐', '┘', '└'],
  }
}

Requirements

A recent Vim version.

Installation

Linux

Run this shell command:

git clone https://github.com/lacygoill/vim9asm.git ~/.vim/pack/vim9asm/opt/vim9asm

Then, add this line in your vimrc:

packadd! vim9asm

Windows

Run this shell command:

git clone https://github.com/lacygoill/vim9asm.git %USERPROFILE%\vimfiles\pack\vim9asm\opt\vim9asm

Then, add this line in your vimrc:

packadd! vim9asm

License

VIM License

lacygoill / vim9asm