Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sakhnik/nvim-gdb
Neovim thin wrapper for GDB, LLDB, PDB/PDB++ and BashDB
https://github.com/sakhnik/nvim-gdb
bashdb gdb lldb neovim nvim-gdb pdb
Last synced: about 2 months ago
JSON representation
Neovim thin wrapper for GDB, LLDB, PDB/PDB++ and BashDB
- Host: GitHub
- URL: https://github.com/sakhnik/nvim-gdb
- Owner: sakhnik
- Created: 2017-08-16T19:53:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-12T06:48:11.000Z (4 months ago)
- Last Synced: 2024-08-12T20:17:07.863Z (4 months ago)
- Topics: bashdb, gdb, lldb, neovim, nvim-gdb, pdb
- Language: Lua
- Homepage:
- Size: 1.24 MB
- Stars: 702
- Watchers: 11
- Forks: 34
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-neovim - sakhnik/nvim-gdb - Thin wrapper for GDB, LLDB, PDB/PDB++ and BashDB. (Debugging / CSV Files)
README
[](https://github.com/sakhnik/nvim-gdb/actions?query=workflow%3ATest+branch%3Amaster)
[](https://www.codacy.com/app/sakhnik/nvim-gdb?utm_source=github.com&utm_medium=referral&utm_content=sakhnik/nvim-gdb&utm_campaign=Badge_Grade)
# GDB for neovim
[Gdb](https://www.gnu.org/software/gdb/), [LLDB](https://lldb.llvm.org/),
[pdb](https://docs.python.org/3/library/pdb.html)/[pdb++](https://github.com/pdbpp/pdbpp)
and [BASHDB](http://bashdb.sourceforge.net/) integration with NeoVim.
## Table of contents
* [Overview](#overview)
* [Installation](#installation)
* [Options](#options)
* [Usage](#usage)
* [Development](#development)
## Overview
Taken from the neovim: [neovim\_gdb.vim](https://github.com/neovim/neovim/blob/master/contrib/gdb/neovim_gdb.vim)
It is instantly usable: type `dd`, edit GDB launching command, hit ``.
Or type `dl` to do the same with LLDB backend.
Or type `dp` to start debugging a python program.
Or type `db` to start debugging a BASH script.
Also you can record the execution of a program with [`rr record`](https://rr-project.org/), and then replay its execution systematically with `dr`.
Supported debuggers and operating systems:
| Debugger | Linux | Darwin | Windows |
|--------------|--------|--------|---------|
| GNU gdb | `✅` | `❌` | `✅` |
| lldb | `✅` | `✅` | `✅` |
| pdb | `✅` | `✅` | `✅` |
| BashDB | `✅` | `✅` | `❌` |
| rr | `✅` | `❌` | `❌` |
[](https://asciinema.org/a/E8sKlS53Dm6UzK2MJjEolOyam?autoplay=1)
## Installation
Check the prerequisites in the script [test/prerequisites.py](https://github.com/sakhnik/nvim-gdb/blob/master/test/prerequisites.py).
Use the branch `master` for NeoVim ≥ 0.7 or the branch `devel` to benefit from the latest NeoVim features.
If you use vim-plug, add the following line to your vimrc file:
```vim
Plug 'sakhnik/nvim-gdb'
```
## Options
To disable the plugin
```vim
let g:loaded_nvimgdb = 1
```
`:GdbStart` and `:GdbStartLLDB` use `find` and the cmake file API to try to
tab-complete the command with the executable for the current file. To disable
this set `g:nvimgdb_use_find_executables` or `g:nvimgdb_use_cmake_to_find_executables` to `0`.
The behaviour of the plugin can be tuned by defining specific variables.
For instance, you could overload some command keymaps:
```vim
" We're going to define single-letter keymaps, so don't try to define them
" in the terminal window. The debugger CLI should continue accepting text commands.
function! NvimGdbNoTKeymaps()
tnoremap
endfunction
let g:nvimgdb_config_override = {
\ 'key_next': 'n',
\ 'key_step': 's',
\ 'key_finish': 'f',
\ 'key_continue': 'c',
\ 'key_until': 'u',
\ 'key_breakpoint': 'b',
\ 'set_tkeymaps': "NvimGdbNoTKeymaps",
\ }
```
Likewise, you could define your own hooks to be called when the source window
is entered and left. Please refer to the online NeoVim help: `:help nvimgdb`.
## Usage
See `:help nvimgdb` for the complete online documentation. Most notable commands:
| Mapping | Command | Description |
|------------------|--------------------------------------|----------------------------------------------------------------------|
| <Leader>dd | `:GdbStart gdb -q ./a.out` | Start debugging session, allows editing the launching command |
| <Leader>dl | `:GdbStartLLDB lldb ./a.out` | Start debugging session, allows editing the launching command |
| <Leader>dp | `:GdbStartPDB python -m pdb main.py` | Start Python debugging session, allows editing the launching command |
| <Leader>db | `:GdbStartBashDB bashdb main.sh` | Start BASH debugging session, allows editing the launching command |
| <Leader>dr | `:GdbStartRR` | Start debugging session with [`rr replay`](https://rr-project.org/). |
| <F8> | `:GdbBreakpointToggle` | Toggle breakpoint in the coursor line |
| <F4> | `:GdbUntil` | Continue execution until a given line (`until` in gdb) |
| <F5> | `:GdbContinue` | Continue execution (`continue` in gdb) |
| <F10> | `:GdbNext` | Step over the next statement (`next` in gdb) |
| <F11> | `:GdbStep` | Step into the next statement (`step` in gdb) |
| <F12> | `:GdbFinish` | Step out the current frame (`finish` in gdb) |
| <c-p> | `:GdbFrameUp` | Navigate one frame up (`up` in gdb) |
| <c-n> | `:GdbFrameDown` | Navigate one frame down (`down` in gdb) |
You can create a watch window evaluating a backend command on every step.
Try `:GdbCreateWatch info locals` in GDB, for istance.
You can open the list of breakpoints or backtrace locations into the location list.
Try `:GdbLopenBacktrace` or `:GdbLopenBreakpoints`.
## Development
The goal is to have a thin wrapper around
GDB, LLDB, pdb/pdb++ and BASHDB, just like the official
[TUI](https://sourceware.org/gdb/onlinedocs/gdb/TUI.html). NeoVim will enhance
debugging with syntax highlighting and source code navigation.
The project uses GitHub actions to run the test suite on every commit automatically.
The plugin, proxy and screen logs can be downloaded as the artifacts to be analyzed
locally.
To ease reproduction of an issue, set the environment variable `CI`, and
launch NeoVim with the auxiliary script `test/nvim.py`. The screen cast will
be written to the log file `spy_ui.log`. Alternatively, consider recording
the terminal script with the ubiquitous command `script`.
To support development, consider donating:
* ₿ [1E5Sny3tC5qdr1owAQqbzfyq1SFjaNBQW4](https://bitref.com/1E5Sny3tC5qdr1owAQqbzfyq1SFjaNBQW4)
## References
* Porting to Moonscript: [2018-11-17](https://sakhnik.com/2018/11/17/nvimgdb-lua.html)
* Overview to the first anniversary: [2018-08-10](https://sakhnik.com/2018/08/10/nvim-gdb-anni.html)
## Showcase
[](https://asciinema.org/a/506942)
[](https://asciinema.org/a/162697)
[](https://asciinema.org/a/397047)