tui: 'guicursor' #6423

justinmk · 2017-04-01T22:19:06Z

Continues #6044

For now only supports valid hex colors (does not check for the validity the hex color) when termguicolors is set, otherwise it won't attempt to change the cursor color.

Also: update default 'guicursor' to match the documentation.

justinmk · 2017-04-01T22:22:31Z

src/nvim/cursor_shape.c

    modep = p_guicursor;
+    if (*p_guicursor == NUL) {
+      modep = (char_u *)"a:block-blinkon0";


If 'guicursor' is empty default to this. Otherwise the published cursor_style_set UI event would contain the previous values.

justinmk · 2017-04-01T22:25:04Z

src/nvim/options.lua

@@ -1000,7 +1000,7 @@ return {
      deny_duplicates=true,
      vi_def=true,
      varname='p_guicursor',
-      defaults={if_true={vi="n-v-c:block,o:hor50,i-ci:hor15,r-cr:hor30,sm:block"}}
+      defaults={if_true={vi="n-v-c:block-Cursor/lCursor,ve:ver35-Cursor,o:hor50-Cursor,i-ci:ver25-Cursor/lCursor,r-cr:hor20-Cursor/lCursor,sm:block-Cursor-blinkwait175-blinkoff150-blinkon175"}}


This is the default mentioned in the docs. It's really the GUI default, but it doesn't matter since the TUI layer is best-effort.

justinmk · 2017-04-01T22:34:24Z

src/nvim/cursor_shape.c

+  { "vsep_drag", 0, 0, 0,   0L,   0L,   0L, 0, 0, "vd", SHAPE_MOUSE },
+  { "more", 0, 0, 0,   0L,   0L,   0L, 0, 0, "m", SHAPE_MOUSE },
+  { "more_lastline", 0, 0, 0,   0L,   0L,   0L, 0, 0, "ml", SHAPE_MOUSE },
+  { "showmatch", 0, 0, 0, 100L, 100L, 100L, 0, 0, "sm", SHAPE_CURSOR },


Renamed some of the human descriptions from #6044.

justinmk · 2017-04-02T00:32:21Z

Working on another PR that will make this opt-in for cases where terminal support is unknown.

ZyX-I · 2017-04-02T11:47:40Z

src/nvim/tui/tui.c

+      case SHAPE_HOR:   shape = 3; break;
+      default: WLOG("Unknown shape value %d", shape); break;
+    }
+    data->params[0].i = shape + (c.blinkon ==0);


Missing space after ==.

fixed in the PR I'm working on.

bfredl · 2017-04-03T11:22:46Z

I suppose it is a know limitation but this doesn't support all modes listed in help guicursor, for instance not ve (visual-exclusive). On mode change, wouldn't it make sense to transmit the SHAPE_IDX directly, rather than having the TUI (and other GUI:s, presumably) translate the (incomplete) mode enum to the shape IDX ? Also then the SHAPE_IDX would be included in the cursor style dictionary for external gui:s that can't call cursor_mode_str2int.

bfredl · 2017-04-03T11:35:51Z

the missing code from vim would be get_cursor_shape()

justinmk · 2017-04-03T12:30:29Z

I suppose it is a know limitation but this doesn't support all modes listed in help guicursor, for instance not ve (visual-exclusive).

Ah, that requires more ui_mode_change granularity. In general yes, this PR was a "first step" with hopes to improve the support where possible.

On mode change, wouldn't it make sense to transmit the SHAPE_IDX directly, rather than having the TUI (and other GUI:s, presumably) translate the (incomplete) mode enum to the shape IDX ? Also then the SHAPE_IDX would be included in the cursor style dictionary for external gui:s that can't call cursor_mode_str2int.

Good idea.

Closes neovim#6429 Closes neovim#6430

bfredl · 2017-04-03T16:09:14Z

test/functional/ui/cursor_spec.lua

+    -- Event is published ONLY if the cursor style changed.
+    screen._cursor_style = nil
+    command('redraw')
+    screen:expect('', nil, nil, nil, true)  -- Tickle the event-loop.


we have screen:sleep() for this, no need to cargo-cult screen:except()

bfredl · 2017-04-03T16:12:40Z

test/functional/ui/cursor_spec.lua

+    -- Change the cursor style.
+    meths.set_option('guicursor', 'n-v-c:ver35-blinkwait171-blinkoff172-blinkon173,ve:hor35,o:ver50,i-ci:block,r-cr:hor90,sm:ver42')
+    command('redraw')
+    screen:expect('', nil, nil, nil, true)  -- Tickle the event-loop.


Why not

screen:expect('', nil, nil, function() eq('vertical', screen._cursor_style.normal.cursor_shape) .... end, true)

which would be consistent with other screen tests and should be completely non-racy, even without the extra redraw.

FEATURES: bc4a2e1 help, man.vim: "outline" (TOC) feature neovim#5169 58422f1 'guicursor' works in the TUI (and sends info to UIs) neovim#6423 129f107 api: nvim_get_mode() neovim#6247 0b59f98 api/ui: externalize tabline neovim#6583 bc6d868 'listchars': `Whitespace` highlight group neovim#6367 6afa7d6 writefile() obeys 'fsync' option neovim#6427 c60e409 eval.c refactor (also improves some error messages) neovim#5119 9d200cd getcompletion("cmdline") neovim#6376 2ea7bfc terminal: Support extra arguments in 'shell'. neovim#4504 bf51102 DirChanged autocmd neovim#5928 neovim#6262 1743df8 'cpoptions': "_" flag to toggle `cw` behaviour neovim#6235 22337b1 CTRL-R omits trailing ^M when pasting to cmdline neovim#6137 0e44916 :edit allows unescaped spaces in filename neovim#6119 abdbfd2 eval: Add id() function and make printf("%p") useful neovim#6095 bdfa147 findfile(), :find, gf work in :terminal. neovim#6009 2f38ed1 providers: Disable if `g:loaded_*` exists. b5560a6 setpos() can set lowercase marks in other buffers neovim#5753 7c513d6 Throttle :! output, pulse "..." message. neovim#5396 d2e8c76 v:exiting neovim#5651 :terminal improvements neovim#6185 neovim#6142 - cursor keeps position after leaving insert-mode. - 4ceec30 Follows output only if cursor is at end of buffer. - e7bbd35 new option: 'scrollback' - fedb844 quasi-support for undo and 'modifiable' - b45ddf7 disables 'list' by default - disables 'relativenumber' by default :help now contains full API documentation at `:help api`. man.vim saw numerous improvements. Windows support: - Windows is no longer "experimental", it is fully supported. - Windows package includes a GUI, curl.exe and other utilities. "Vim 8" features: partials, lambdas, packages. FIXES: 12fc1de ops: fix i<c-r> with multi-byte text neovim#6524 dd391bf Windows: system() and friends neovim#6497 13352c0 Windows: os_get_hostname() neovim#6413 16babc6 tui: Less-noisy mouse seqs neovim#6411 3a9dd13 (vim bug) folding edge-cases neovim#6207 f6946c6 job-control: set CLOEXEC on pty processes. neovim#5986 d1afd43 rplugin: Call s:LoadRemotePlugins() on startup. 1215084 backtick-expansion works with `shell=fish` neovim#6224 e32ec03 tui: Improved behavior after resize. neovim#6202 86c2adc edit.c: CTRL-SPC: Insert previously-inserted text. neovim#6090 c318d8e b:changedtick now follows VimL rules neovim#6112 34e24cb terminal: Initialize colors in reverse order neovim#6160 e889917 undo: Don't set b_u_curhead in ex_undojoin() neovim#5869 d25649f undo: :earlier, g-: Set b_u_seq_cur correctly. (neovim#6016) 043d8ba 'Visual-mode put from @. register' neovim#5782 42c922b open_buffer(): Do `BufEnter` for directories. 50d0d89 inccommand: Preview :sub commands only after delimiter neovim#5932 1420e10 CheckHealth improvements neovim#5519 c8d5e92 jobstart(): Return -1 if cmd is not executable. neovim#5671 CHANGES: NVIM_TUI_ENABLE_CURSOR_SHAPE was removed. Use 'guicursor' instead. See https://github.com/neovim/neovim/wiki/Following-HEAD#20170402 81525dc 'mouse=a' is no longer the default. (This will probably change again after it is improved.) neovim#6022 0c1f783 defaults: 'showcmd', 'belloff', 'ruler' neovim#6087 eb0e94f api: {get,set}_option update local options as appropriate neovim#6405 bdcb2a3 "Reading from stdin..." message was removed. neovim#6298

FEATURES: bc4a2e1 help, man.vim: "outline" (TOC) feature neovim#5169 58422f1 'guicursor' works in the TUI (and sends info to UIs) neovim#6423 129f107 api: nvim_get_mode() neovim#6247 0b59f98 api/ui: externalize tabline neovim#6583 bc6d868 'listchars': `Whitespace` highlight group neovim#6367 6afa7d6 writefile() obeys 'fsync' option neovim#6427 c60e409 eval.c refactor (also improves some error messages) neovim#5119 9d200cd getcompletion("cmdline") neovim#6376 2ea7bfc terminal: Support extra arguments in 'shell'. neovim#4504 bf51102 DirChanged autocmd neovim#5928 neovim#6262 1743df8 'cpoptions': "_" flag to toggle `cw` behaviour neovim#6235 22337b1 CTRL-R omits trailing ^M when pasting to cmdline neovim#6137 0e44916 :edit allows unescaped spaces in filename neovim#6119 abdbfd2 eval: Add id() function and make printf("%p") useful neovim#6095 bdfa147 findfile(), :find, gf work in :terminal. neovim#6009 2f38ed1 providers: Disable if `g:loaded_*` exists. b5560a6 setpos() can set lowercase marks in other buffers neovim#5753 7c513d6 Throttle :! output, pulse "..." message. neovim#5396 d2e8c76 v:exiting neovim#5651 :terminal improvements neovim#6185 neovim#6142 - cursor keeps position after leaving insert-mode. - 4ceec30 Follows output only if cursor is at end of buffer. - e7bbd35 new option: 'scrollback' - fedb844 quasi-support for undo and 'modifiable' - b45ddf7 disables 'list' by default - disables 'relativenumber' by default :help now contains full API documentation at `:help api`. man.vim saw numerous improvements. Windows support: - Windows is no longer "experimental", it is fully supported. - Windows package includes a GUI, curl.exe and other utilities. "Vim 8" features: partials, lambdas. SECURITY FIXES: CVE-2017-5953 CVE-2017-6349 CVE-2017-6350 neovim#6485 CHANGES: NVIM_TUI_ENABLE_CURSOR_SHAPE was removed. Use 'guicursor' instead. See https://github.com/neovim/neovim/wiki/Following-HEAD#20170402 81525dc 'mouse=a' is no longer the default. (This will probably change again after it is improved.) neovim#6022 0c1f783 defaults: 'showcmd', 'belloff', 'ruler' neovim#6087 eb0e94f api: {get,set}_option update local options as appropriate neovim#6405 bdcb2a3 "Reading from stdin..." message was removed. neovim#6298 FIXES: 12fc1de ops: fix i<c-r> with multi-byte text neovim#6524 dd391bf Windows: system() and friends neovim#6497 13352c0 Windows: os_get_hostname() neovim#6413 16babc6 tui: Less-noisy mouse seqs neovim#6411 3a9dd13 (vim bug) folding edge-cases neovim#6207 f6946c6 job-control: set CLOEXEC on pty processes. neovim#5986 d1afd43 rplugin: Call s:LoadRemotePlugins() on startup. 1215084 backtick-expansion works with `shell=fish` neovim#6224 e32ec03 tui: Improved behavior after resize. neovim#6202 86c2adc edit.c: CTRL-SPC: Insert previously-inserted text. neovim#6090 c318d8e b:changedtick now follows VimL rules neovim#6112 34e24cb terminal: Initialize colors in reverse order neovim#6160 e889917 undo: Don't set b_u_curhead in ex_undojoin() neovim#5869 d25649f undo: :earlier, g-: Set b_u_seq_cur correctly. (neovim#6016) 043d8ba 'Visual-mode put from @. register' neovim#5782 42c922b open_buffer(): Do `BufEnter` for directories. 50d0d89 inccommand: Preview :sub commands only after delimiter neovim#5932 1420e10 CheckHealth improvements neovim#5519 c8d5e92 jobstart(): Return -1 if cmd is not executable. neovim#5671

teto and others added 4 commits April 1, 2017 23:14

tui: 'guicursor' shape neovim#6044

dd4a5fc

Closes neovim#2583

tui: 'guicursor' color

54bab00

For now only supports valid hex colors (does not check for the validity the hex color) when termguicolors is set, otherwise it won't attempt to change the cursor color.

'guicursor': Empty means "block cursor in all modes".

c2826a7

Also: update default 'guicursor' to match the documentation.

api/cursor_style_set: mode descriptions

3a69dbf

justinmk commented Apr 1, 2017

View reviewed changes

justinmk force-pushed the guicursor branch from 0e12978 to 3a69dbf Compare April 1, 2017 22:32

justinmk commented Apr 1, 2017

View reviewed changes

justinmk merged commit 58422f1 into neovim:master Apr 2, 2017

justinmk deleted the guicursor branch April 2, 2017 00:32

ZyX-I reviewed Apr 2, 2017

View reviewed changes

justinmk mentioned this pull request Apr 3, 2017

UI: mode_info_set (cursor) enhancements #6428

Closed

teto referenced this pull request in justinmk/neovim Apr 3, 2017

'guicursor': enabled=false if 'guicursor' is empty

52383d2

Closes neovim#6429 Closes neovim#6430

bfredl reviewed Apr 3, 2017

View reviewed changes

jamessan mentioned this pull request Apr 3, 2017

Preserve cursor shape on suspend/quit #6433

Closed

alok mentioned this pull request Apr 3, 2017

t_xx: Broken hide/show cursor (t_vi / t_ve) #3688

Closed

bfredl mentioned this pull request Apr 17, 2017

[RFC] support more cursor shape modes #6539

Merged

justinmk mentioned this pull request May 1, 2017

NVIM v0.2.0 #6634

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tui: 'guicursor' #6423

tui: 'guicursor' #6423

justinmk commented Apr 1, 2017

justinmk Apr 1, 2017 •

edited

justinmk Apr 1, 2017

justinmk Apr 1, 2017

justinmk commented Apr 2, 2017

ZyX-I Apr 2, 2017

justinmk Apr 2, 2017

bfredl commented Apr 3, 2017

bfredl commented Apr 3, 2017

justinmk commented Apr 3, 2017

bfredl Apr 3, 2017 •

edited

bfredl Apr 3, 2017

tui: 'guicursor' #6423

tui: 'guicursor' #6423

Conversation

justinmk commented Apr 1, 2017

justinmk Apr 1, 2017 • edited

Choose a reason for hiding this comment

justinmk Apr 1, 2017

Choose a reason for hiding this comment

justinmk Apr 1, 2017

Choose a reason for hiding this comment

justinmk commented Apr 2, 2017

ZyX-I Apr 2, 2017

Choose a reason for hiding this comment

justinmk Apr 2, 2017

Choose a reason for hiding this comment

bfredl commented Apr 3, 2017

bfredl commented Apr 3, 2017

justinmk commented Apr 3, 2017

bfredl Apr 3, 2017 • edited

Choose a reason for hiding this comment

bfredl Apr 3, 2017

Choose a reason for hiding this comment

justinmk Apr 1, 2017 •

edited

bfredl Apr 3, 2017 •

edited