14 releases (7 breaking)
0.9.0 | Sep 4, 2024 |
---|---|
0.7.4 | Jul 30, 2024 |
0.6.0 | Nov 26, 2023 |
0.3.2 | Mar 30, 2023 |
0.2.0 | Jul 27, 2020 |
#184 in Development tools
1,934 downloads per month
3.5MB
7K
SLoC
Language Server for GAS/GO Assembly
Goal
Provide hovering, autocompletion, signature help, go to definition, and view references for assembly files written in the GAS/NASM or GO assembly flavors. It supports assembly files for the x86, x86_64, ARM, RISCV, and z80 instruction sets.
This tool can serve as reference when reading the assembly output of a program. This way you can query what each command exactly does and deliberate about whether the compiler is producing the desired output or whether you have to tweak your code for optimisation.
Installation
Using cargo
Install using the cargo package manager, either from crates.io
or from github:
cargo install asm-lsp
# or to get the latest version from github
cargo install --git https://github.com/bergercookie/asm-lsp
Set up as a language server
Add a section like the following in your settings.json
file:
"asm-lsp": {
"command": "asm-lsp",
"filetypes": [
"asm", "s", "S"
]
}
[OPTIONAL] Configure via .asm-lsp.toml
Add a .asm-lsp.toml
file like the following to your project's root directory
and/or ~/.config/asm-lsp/
(project configs will override global configs) to
selectively target specific assemblers and/or instruction sets. Omitting an item
from the assemblers
or instruction_sets
sections is equivalent to setting it
to false
. Be default, diagnostics are enabled and the server attempts to invoke
gcc
(and then clang
) to generate them. If the compiler
config field is specified,
the server will attempt to use the specified path to generate diagnostics.
version = "0.1"
[assemblers]
gas = true
go = false
z80 = false
masm = false
nasm = false
[instruction_sets]
x86 = false
x86_64 = true
z80 = false
arm = false
riscv = false
[opts]
#compiler = "gcc"
diagnostics = true
default_diagnostics = true
[OPTIONAL] Extend functionality via compile_commands.json
/compile_flags.txt
Add a compile_commands.json
or compile_flags.txt
file to your project's root or root build
directory to enable inline diagnostic
features, as well as to specify additional include directories for use in hover
features. If a compile_commands.json
or compile_flags.txt
file isn't provided,
the server will attempt to provide diagnostics with a default compile command.
This feature can be disabled by setting the default_diagnostics
config field
to false
.
VSCode Support
The project has not published any VSCode extension package yet. However, there is
a development extension in the editors/code
directory with setup instructions.
Root directory must contain .git
The lsp searches for a .git
directory to locate the root of your project.
Please be sure to run git init
if your project is not already configured as a
git repository.
Demos / Features Documentation
Hovering / Documentation support
Autocomplete
Diagnostics
Goto Definition
View References
Signature Help
- Triggering signature help is dependent on your editor and LSP client.
- Using Neovim's built in LSP client, this can be done via the command
:lua vim.lsp.buf.signature_help()
. - Using coc, this issue comment
suggests the remap
inoremap <silent> ,s <C-r>=CocActionAsync('showSignatureHelp')<CR>
to trigger signature help in insert mode.
- Using Neovim's built in LSP client, this can be done via the command
Acknowledgements / Sources
-
x86 and x86-64 instruction documentation builds on top of the opcodes python package
-
x86 and x86-64 register documentation sourced from:
- OS Dev's x86 and x86-64 pages
- Various Wikipedia pages for SIMD specifics
-
GAS directives sourced from SourceWare's pseudo-ops page
-
MASM and NASM directives sourced from the asm-dude Visual Studio extension project. Additions sourced from Microsoft and NASM documentation.
-
ARM instruction documentation builds on top of ARM's official Exploration tools documentation
-
RISCV instruction and register documentation builds on top of the riscv-isadoc project
Dependencies
~13–27MB
~426K SLoC