[RFC] Port of the termdebug.vim plugin to neovim terminal feature. #8364

kwon-young · 2018-05-05T15:06:56Z

Port of the termdebug.vim plugin to neovim terminal feature as requested in #7379.
For neovim compatibility, the vim specific calls were replaced with neovim specific calls:

term_start -> term_open
term_sendkeys -> jobsend
term_getline -> getbufline

This is a linux port only of the plugin, because I don't have a windows to test on.
There is still a bug with the Evaluate command.
It always trigger the following error: E15: Invalid expression: <range>, ''

I think that before merging this PR, some other feature should make it into neovim:

[RPC] Add methods to enumerate channels and clients to identify themselves #6743 for getting the tty and buffer of a job using nvim_get_chan_info
merge patch 8.0.1089 for the evaluation feature: vim-patch:8.0.1089: cannot get range count in user command #8946. Closed in d0c8dfc
merge patch 8.0.1090 for <cexpr> evaluation: 3d71366
[RFC] Floating windows in TUI and Remote UI #6619 for having the same floating window evaluation feature when cursor on a variable

janlazo · 2018-05-05T19:59:53Z

Can you list all related vim-patches that create/modify termdebug.vim and resolve them first?

kwon-young · 2018-05-06T12:04:05Z

I've compiled the following list of related vim-patches from the history of termdebug.vim here: https://github.com/vim/vim/commits/master/runtime/pack/dist/opt/termdebug/plugin/termdebug.vim
In reverse chronological order:

patch 8.0.1725: terminal debugger doesn't handle command arguments
patch 8.0.1713: terminal debugger doesn't handle arguments
patch 8.0.1668: terminal debugger: can't re-open source code window
patch 8.0.1655: outdated gdb message in terminal debugger unclear
patch 8.0.1599: no error message when gdb does not support debugger
patch 8.0.1562: the terminal debugger can't set a breakpoint with the…
patch 8.0.1318: terminal balloon only shows one line
patch 8.0.1309: cannot use 'balloonexpr' in a terminal
patch 8.0.1293: setting a breakpoint in the terminal debugger sometim…
patch 8.0.1264: terminal debugger gets stuck in small window
patch 8.0.1123: cannot define a toolbar for a window
patch 8.0.1107: terminal debugger jumps to non-existing file
patch 8.0.1092: terminal debugger can't evaluate expressions
patch 8.0.1085: terminal debugger can't set breakpoints
patch 8.0.1077: no debugger making use of the terminal window

There is also the patch introducing the range argument for the Evaluate function:

patch 8.0.1089: cannot get range count in user command

I'll try to resolve them but I have no idea on how to do that.

janlazo · 2018-06-02T21:20:08Z

Excluding the runtime/ changes, are any of those patches N/A to Neovim? Vim 8.0 +terminal starts at patch 8.0.0693.

kwon-young · 2018-06-04T14:18:32Z

N/A: do you mean Not Applicable ?

Maybe the patch 8.0.1089 for the range argument. This modifies some c code in neovim.
I've tried to apply it, but couldn't make it work successfully.

Vim 8.0 +terminal starts at patch 8.0.0693.

... I suppose, but I don't think this is relevant for this pull request.
The whole point is to use the neovim terminal feature instead of the vim built-in one.

phcerdan · 2018-09-01T23:32:27Z

Thanks for working on this @kwon-young 👍

Author: Kwon-Young Choi <[email protected]> Date: Sat May 5 16:57:45 2018 +0200 Port of the termdebug.vim plugin to neovim terminal feature. For neovim compatibility, The vim specific calls were replaced with neovim specific calls: term_start -> term_open term_sendkeys -> jobsend term_getline -> getbufline job_info && term_getjob -> using linux command ps to get the tty fix1: forgot to port EndDebug callback to neovim fix2: use nvim_get_chan_info to get pty of job remove the use of communication buffer by using jobstart instead of termopen fix3: get gdbbuf using nvim_get_chan_info

kwon-young · 2019-05-13T09:05:40Z

I don't really know how packadd works, but in the meantime, you can just download the termdebug.vim file from my branch and do a: source termdebug.vim and you should have the Termdebug command available.

By the way, I'm waiting for an official release of neovim 4.0 to finish porting the termdebug plugin, so I can use floating windows when evaluating variables.

I'm also wondering if I should make a proper plugin out of this ...

mcepl · 2019-05-13T10:04:52Z

Right, so I have a solution for myself. For :packadd the configuration option is &packpath (not &rtp), so make sure it has correct value (I had set packpath=~/.vim in my ~/.config/nvim/init.vim). With the correct value of the option, packadd termdebug|Termdebug works.

justinmk · 2019-05-13T10:09:06Z

Is there any reason we can't just merge what's here, in the meantime? (just need conflicts to be resolved)

mcepl · 2019-05-13T11:24:12Z

+1 from me. I haven't made any real testing, but when I start :Termdebug (with packages from my openSUSE/Fedora repository) I get something, which looks correct:

My patch (against the https://github.com/neovim/neovim/tree/master ) is in OBS.

mcepl · 2019-05-13T11:28:43Z

@kwon-young do you plan to push this patch back to vim (with all those if has("nvim"), it feels so)?

kwon-young · 2019-05-13T12:14:42Z

@kwon-young do you plan to push this patch back to vim (with all those if has("nvim"), it feels so)?

No, I don't think bram is interested in supporting neovim for termdebug ...

I think the reason I put these if has("nvim") was because I wasn't sure if I wanted to make a plugin out of this, to extend its feature set. In that case it would have been a shame to just loose vim support.

Is there any reason we can't just merge what's here, in the meantime? (just need conflicts to be resolved)

I've noticed that neovim merged the vim patches related to termdebug.
@justinmk I'll rebase my pull request to the most recent neovim to resolve the merge conflicts.
Apart from this, I would be super excited to make my first contribution to neovim!

wsdjeg · 2019-05-13T13:34:50Z

@kwon-young if this is built-in runtime file of neovim, I think this is no need to check if has('nvim'), because this file will not be used in vim. just modified this plugin based on neovim's job api will be better.

mcepl · 2019-05-13T15:56:26Z

@kwon-young if this is built-in runtime file of neovim, I think this is no need to check if has('nvim'), because this file will not be used in vim. just modified this plugin based on neovim's job api will be better.

+1 this in the end IS internal neovim implementation. Unless @brammool accepts your compromise (which I don't expect), we will have just to live with two independent implementations, and then KISS principle leads to elimination of those ifs.

added neovim floating window support for expression evaluation

floating window feature is not available

justinmk · 2019-05-16T09:21:15Z

Thank you @kwon-young !

bfredl · 2019-05-16T09:58:54Z

runtime/pack/dist/opt/termdebug/plugin/termdebug.vim

+
+        execute 'noswapfile edit!' bufname
+
+        setlocal winhl=Normal:CursorLine


Not sure we want this, NormalFloat will be automatically used and should be set to something reasonable for hover popups etc. In some configs CursorLine is just a underline with no background change.

Okay, I agree that the colourscheme should put a sensible default for NormalFloat.

bfredl · 2019-05-16T10:02:03Z

runtime/pack/dist/opt/termdebug/plugin/termdebug.vim

+        return
+    endif
+    autocmd! plugin-LC-neovim-close-hover
+    execute winnr . 'wincmd c'


call nvim_win_close(a:win_id) is more robust, it works even if the user switched tab.

thanks, this makes me think that I should also change the name of that autocmd so that it does not clash with languageclient-neovim...

bfredl · 2019-05-16T11:38:08Z

runtime/pack/dist/opt/termdebug/plugin/termdebug.vim

+
+        " Give margin
+        let width += 1
+        let lines = [''] + lines + ['']


Vertical margin of an entire screen row consumes quite a lot of screen space. Maybe we can remove this for now, and soon we can make this configurable by user with the 'margin' option.

mcepl · 2019-05-16T12:26:43Z

Just that this probably needs to be a new pull request. This one has been merged.

bfredl · 2019-05-16T12:55:29Z

@mcepl #10015 is the follow-up.

This release represents ~2700 commits since v0.3.4, the previous non-maintenance release. Besides the highlights listed below, this release features vast improvements to documentation, internal subsystems and test/CI infrastructure, and 700+ patches merged from Vim. FEATURES: New API functions: nvim_create_buf: create various kinds of buffers nvim_get_context, nvim_load_context 8e6b0a7 #10619 API: Context: save/restore/inspect editor state nvim_input_mouse: perform mouse actions nvim_open_win: create floating windows (and external, for supporting UIs) nvim_paste: paste text at cursor nvim_put: put text at cursor nvim_select_popupmenu_item: perform popupmenu actions nvim_set_keymap: create/delete mappings nvim_set_vvar: set v: variables nvim_ui_pum_set_height nvim_ui_try_resize_grid nvim_win_close: close windows nvim_win_get_config: get window configuration nvim_win_set_config: reconfigure windows New UI events: redraw.grid_destroy redraw.hl_group_set 8a3f858 #10504 UI/highlight: expose builtin highlight groups using hl_group_set event redraw.msg_clear redraw.msg_history_show redraw.msg_ruler redraw.msg_set_pos redraw.msg_show redraw.msg_showcmd redraw.msg_showmode redraw.win_close redraw.win_external_pos redraw.win_float_pos redraw.win_hide redraw.win_pos API f5c56f0 #9170 API/Lua: nvim_buf_attach: support Lua callback 82d48c0 #9896 API: emit nvim_error_event on failed async request b9ad12e #9992 UI/nvim_ui_attach(): add `override` option 3d1ed7c #9993 UI/ext_messages: learn more message kinds 8ed54bb #9547 proper multiline error message for rpcrequest, API wrappers Lua This release introduces "Nvim-Lua standard library". See ":help lua-stdlib". 89d7e24 #9463 Lua stdlib: vim.inspect, string functions 8e941c5 #9740 Lua: generate documentation from docstrings 1cbe014 #9301 lua/stdlib: Introduce vim.shared c83926c #10123 Lua: introduce vim.loop (expose libuv event-loop) 81e1dbc #10120 Lua: vim.schedule(cb) 1f54f68 #10688 Lua: minimal UTF-16 support needed for LSP 6fb0020 #10513 Lua encoding support c0993ed Lua: support getting UTF-32 and UTF-16 sizes of replaced text b0e2619 Lua: add {old_byte_size} to on_lines buffer change event UI: - The Nvim 0.3.4 UI protocol introduced line-based updates instead of legacy char-based updates. Nvim 0.4 continues to evolve the UI protocol. See ":help ui". Legacy UI clients are supported. See ":help api-contract". 9a1675b #6619 Floating windows - Can be (re)positioned, anchored, external. - Are real windows showing real buffers. No shortcuts, hacks, or compromises. - Support all features and API of normal windows, plus more. 6427894 #8455 Multigrid: "windows drawn on separate grids" - Windows are logically isolated internally. - Windows are sent to UIs as distinct objects, so that UIs can control layout instead of being stuck with the classic TUI layout. - Per-window font-size, dimenions, line-spacing. - Compositor: Internal subsystem for composing grids. 3855204 #6917 UIEnter, UILeave 788bcbb #9923 ui: ":syn blend=", 'winblend' 7cf7c0a #9575 ui: 'redrawdebug' option for flexible debugging of redrawing 5c836d2 #9607 wildoptions=pum (enabled by default) 37f8df8 #9571 UI: 'pumblend' option for semi-transparent popupmenu c403a95 #9446 Visual: highlight char-at-cursor - Traditionally Vim's visual selection does "reverse mode", which perhaps conflicts with the non-blinking block cursor. But 'guicursor' defaults to a vertical bar for selection=exclusive, and this confuses users who expect to see the text highlighted. :terminal fc27dc9 #8550 autocmds: TermEnter, TermLeave d13803f #9810 keymap, terminal: more keycodes 3b56f59 #9535 :terminal : Fix F1-F4 key codes 2d4a37e #10370 :ls : show "R", "F" for terminal-jobs fd0fd75 #9966 terminal: swap priority of terminal, editor highlights 7bb858c #9494 libvterm 0.1 TUI 3afb397 syntax, TUI: support "strikethrough" ccbcd39 #9408 TUI: "title stacking" unconditionally 298608f #9509 TUI: detect background color, set bg=dark/light 42f492a #9097 TUI: handle Smulx extension capability (extended underline) 424ddd0 #10205 TUI: support rgba background detection 9b43832 #9601 TUI: italics in tmux, Terminal.app f6fb370 #9793 keymap: support more (keypad) keycodes 3340e08 #9423 TUI: Konsole DECSCUSR fixup :checkhealth d0fd66b health/provider.vim: check curl HTTPS support c38862a #10490 checkhealth: try yarn if npm is missing 43356a4 #9929 health: check if tmux enabled true colors ec5a4d8 #9548 checkhealth: validate locale providers (clipboard, python, etc.): 96be8a2 #10161 Allow reloading providers (useful for UIs/clients) db3c797 #9487 provider: improve error message if provider is missing Various: 36762a0 #9295 signs: support multiple columns 801fe79 #10382 eval: wait() (wait for any condition) 9df3a67 #10400 MsgArea highlight; message grid a9bea8c #10790 keymap: allow modifiers to multibyte chars, like <m-ä> 25e0a44 #10878 #4448 paste: redesign (10x+ faster pasting; extensible vim.paste Lua hook) ef5037e #9706 autocmd: introduce "++once" feature 175398f #9616 add CompleteChanged autocmd 7fcf2f9 #9717 TextYankPost: add v:event["inclusive"] 3a699a7 #8364 termdebug.vim plugin ca1ce59 #9709 performance: use os_copy to create backups ed0e96c man.vim: set 'linebreak' 70f6939 #9564 events: add "Signal" event f89d0d8 #9568 inccommand: auto-disable if folding is slow FIXES: 41bb68b #10584 process_stop: uv: do not close stdin first/explicitly e50aa2a #10117 normal: Don't exit CTRL-O mode after processing K_EVENT 95fa71c #9504 :recover : Fix crash on non-existent *.swp 5a836d4 #9507 screen: don't unconditionally clear messages on window scroll 149dcbf #10021 channel: refactor events, prevent recursive invocation of events d19ff73 #10107 Fix multiple c_CTRL-D showing statusline b65a7b7 #10103 Fix wildmode=list,full and display+=msgsep interaction 0be6d3c #9634 fsync: Ignore ENOTSUP. Fix writing to SMB. b247c6f #10025 kbtree: pointer UB and unitialized value fixes 018e0d5 #9643 API/buffer-updates: always detach on buf-reload 400ee59 #9961 API: fix cursor position when lines are added 769f44e #9911 win/defaults: Use "…/nvim-data/site" in 'runtimepath' 83d5716 #9911 spellfile.vim: store files in stdpath('data') 8dbf231 #9887 RPC: conform message-id type to msgpack-RPC spec 5f996e3 #9894 options: properly reset directories on 'autochdir' 4c4a570 #9807 various CursorMoved fixes 943bedf #9853 event-loop: do not set CA_COMMAND_BUSY 9d207fd #9693 dictwatcheradd(): support b:changedtick 2d50bf3 #9789 mac: fix locale detection c563133 #9754 :mksession : restore tab-local working directories 092e7e6 #9703 #9703 executable(): return false if user is not owner 11a481f #9686 env var fixes/improvements 8e54847 #9666 #7920 os/env: Fix completion of multibyte env var names 5193826 #10468 Fix is_executable_in_path() on Windows 8eaa452 #9516 win: exepath(), executable() fixes f55c1e4 #10544 reltimefloat(): allow negative result b08dc3e #10561 win: jobstart(), system(): $PATHEXT-resolve exe 7cc2b72 #10392 TextYankPost: spurious/too-early dispatch during delete 6e01ed6 OpenBSD: stop jobs/processes properly 58dd5fc #10522 jobstop(): close channel before process_stop() 8363202 #10959 improved resize behavior (all UIs) c6eb1f4 #10830 API: fix nvim_command_output buffer overflow cbfd18c #10763 startup: handle 'guicursor' after user config b8f2436 #10915 jobwait(): fix race if job exits quickly 2fafed6 #10765 clipboard: handle/avoid SIGTERM with previous owner 8aca932 #9954 clipboard: setreg("*") with clipboard=unnamed 3f10c5b #9480 performance: clipboard/macOS: assume that pbcopy works 48efafc #10398 screen: disable redrawing inside VimResized 5e4b93a #10389 API/Lua: make nvim_execute_lua use native lua floats, not special tables 8c6f5b7 #9934 Spurious quote mark in command line when typing <C-R> a8a38f3 Lua 5.2/5.3 compat :terminal 47b7b47 #10700 :terminal : update buffer when switching tabpage 5225c1e #9605 terminal: Fix potential invalid local 'scrollback' 894f6be #8325 :terminal : set topline based on window height 8171e96 #9551 Improve :terminal resize d928b03 #9856 :stopinsert should leave terminal-mode 3f71218 #9926 :terminal : fix: Using `:stopinsert` while in normal mode 5020daa #9883 ui/terminal: make terminal state redraw like any other state TUI: 9f19e8d #9443 TUI: Do not disable BCE for builtin terminfos a4076e5 #9474 win/TUI: fix text overrides line numbers 533d4a3 #9645 TUI: do not resize host-terminal on startup b51e5d8 #9688 tui_tk_ti_getstr: handle weird value 1f5eac1 #10785 TUI: fix data-race during resize CHANGES: 9697c7f #8194 fix menu_get() 7f2e43c #9520 improve Lua error messages c234318 #9526 Remove jemalloc baf93d9 #9581 UI: always use concrete colors for default_colors_set 91688b4 #9563 defaults: set 'scrollback' to -1 by default bb24fec #10136 defaults: exclude "S" from 'shortmess' ddd0eb6 #8540 startup: -es/-Es (silent/batch mode): skip swapfile 3536249 #9805 jumplist: avoid extra tail entry 939d905 #10573 channels: reflect exit due to signals in exit status code 45c34bd #10689 :doautocmd : Never show "No matching autocommands" fb19aee #9110 API: make nvim_win_set_option() set window-global, not buffer-local abfc8b3 #10778 emsg_multiline: log Vim errors 06d9cc7 #10657 exists("$FOO"): return false for empty env var 6616d1d #10743 win/env: Vim-compat: Empty string deletes env var 7d66483 #10662 win: expand nested env var in $HOME 2816bc8 #8349 edit.c: Disable indent during completion 58f505d #9829 startup: remove TUI init special-case Historically Vim/Nvim does backflips to handle input and show messages before a UI is available. This logical contradiction was already fixed for remote UIs (#9024 c236e80). Fixing it also for the TUI avoids problems on Windows, simplifies the logic, and avoids races like #9959.

marvim added the RFC label May 5, 2018

kwon-young force-pushed the master branch 2 times, most recently from 45f49ac to 85f5ab1 Compare May 7, 2018 08:31

bfredl mentioned this pull request Jun 14, 2018

Consider implementing Vim 8 jobs and channels API #8547

Closed

kwon-young force-pushed the master branch from 8cf82d1 to 4c26dc2 Compare September 2, 2018 01:31

kwon-young closed this Sep 2, 2018

kwon-young force-pushed the master branch from 4c26dc2 to bcc9a74 Compare September 2, 2018 01:48

justinmk removed the RFC label Sep 2, 2018

kwon-young reopened this Sep 2, 2018

marvim added the RFC label Sep 2, 2018

kwon-young force-pushed the master branch from c6e6048 to badf31e Compare September 2, 2018 06:31

kwon-young force-pushed the master branch from badf31e to ad8adf8 Compare September 13, 2018 18:54

This comment has been minimized.

Sign in to view

justinmk added the runtime funtime label May 13, 2019

Merge remote-tracking branch 'upstream/master'

d3b776e

kwon-young and others added 2 commits May 15, 2019 20:41

cleaned up if has('nvim') to remove vim support.

9a64ae1

added neovim floating window support for expression evaluation

improvred documentation, cleaned up vim menu code, fixed bug when

d2185fe

floating window feature is not available

justinmk merged commit 3a699a7 into neovim:master May 16, 2019

bfredl reviewed May 16, 2019

View reviewed changes

kwon-young mentioned this pull request May 16, 2019

[RFC] Port of the termdebug.vim plugin to neovim terminal feature (Part 2). #10015

Merged

2 tasks

bfredl reviewed May 16, 2019

View reviewed changes

mcepl mentioned this pull request May 17, 2019

Support for :Termdebug or any gdb integration #7379

Closed

janlazo mentioned this pull request Aug 28, 2019

vim-patch:8.1.0193 #10874

Merged

sakuraiyuta mentioned this pull request Jan 1, 2020

:LspInstallServer in Neovim gives an error mattn/vim-lsp-settings#31

Closed

janlazo mentioned this pull request May 18, 2020

vim-patch:8.1.2228,8.2.{36,37,766,810} #12327

Merged

janlazo mentioned this pull request Jun 30, 2020

[Abandoned] Port of Vim's flatten #12557

Closed


		execute 'noswapfile edit!' bufname

		setlocal winhl=Normal:CursorLine

Uh oh!

[RFC] Port of the termdebug.vim plugin to neovim terminal feature. #8364

[RFC] Port of the termdebug.vim plugin to neovim terminal feature. #8364

Uh oh!

Conversation

kwon-young commented May 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

janlazo commented May 5, 2018

Uh oh!

kwon-young commented May 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

janlazo commented Jun 2, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kwon-young commented Jun 4, 2018

Uh oh!

phcerdan commented Sep 1, 2018

Uh oh!

This comment has been minimized.

kwon-young commented May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

mcepl commented May 13, 2019

Uh oh!

justinmk commented May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcepl commented May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcepl commented May 13, 2019

Uh oh!

kwon-young commented May 13, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wsdjeg commented May 13, 2019

Uh oh!

mcepl commented May 13, 2019

Uh oh!

justinmk commented May 16, 2019

Uh oh!

bfredl May 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kwon-young May 16, 2019

Choose a reason for hiding this comment

Uh oh!

bfredl May 16, 2019

Choose a reason for hiding this comment

Uh oh!

kwon-young May 16, 2019

Choose a reason for hiding this comment

Uh oh!

bfredl May 16, 2019

Choose a reason for hiding this comment

Uh oh!

mcepl commented May 16, 2019

Uh oh!

bfredl commented May 16, 2019

Uh oh!

Uh oh!

kwon-young commented May 5, 2018 •

edited

Loading

kwon-young commented May 6, 2018 •

edited

Loading

janlazo commented Jun 2, 2018 •

edited

Loading

kwon-young commented May 13, 2019 •

edited

Loading

justinmk commented May 13, 2019 •

edited

Loading

mcepl commented May 13, 2019 •

edited

Loading

kwon-young commented May 13, 2019 •

edited

Loading

bfredl May 16, 2019 •

edited

Loading