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

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

1 files changed, 180 insertions, 0 deletions

diff --git a/test/functional/ui/cursor_spec.lua b/test/functional/ui/cursor_spec.lua
new file mode 100644
index 0000000000..6f5fd244d5
--- /dev/null
+++ b/test/functional/ui/cursor_spec.lua
@@ -0,0 +1,180 @@
+local helpers = require('test.functional.helpers')(after_each)
+local Screen = require('test.functional.ui.screen')
+local clear, feed, meths = helpers.clear, helpers.feed, helpers.meths
+local insert, execute = helpers.insert, helpers.execute
+local eq, funcs = helpers.eq, helpers.funcs
+local command = helpers.command
+
+if helpers.pending_win32(pending) then return end
+
+describe('ui/cursor', function()
+  local screen
+
+  before_each(function()
+    clear()
+    screen = Screen.new(25, 5)
+    screen:attach()
+  end)
+
+  after_each(function()
+    screen:detach()
+  end)
+
+  it("'guicursor' is published as a UI event", function()
+    command('redraw')
+    screen:expect('', nil, nil, nil, true)  -- Tickle the event-loop.
+    local expected_cursor_style = {
+      cmd_insert = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 25,
+        cursor_shape = 'vertical',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'ci' },
+      cmd_line = {
+        mouse_shape = 0,
+        short_name = 'e' },
+      cmd_normal = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'c' },
+      cmd_replace = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 20,
+        cursor_shape = 'horizontal',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'cr' },
+      drag_statusline = {
+        mouse_shape = 0,
+        short_name = 'sd' },
+      insert = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 25,
+        cursor_shape = 'vertical',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'i' },
+      match_paren = {
+        blinkoff = 150,
+        blinkon = 175,
+        blinkwait = 175,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 45,
+        id_lm = 45,
+        short_name = 'sm' },
+      more = {
+        mouse_shape = 0,
+        short_name = 'm' },
+      more_lastline = {
+        mouse_shape = 0,
+        short_name = 'ml' },
+      normal = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'n' },
+      pending = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 50,
+        cursor_shape = 'horizontal',
+        hl_id = 45,
+        id_lm = 45,
+        mouse_shape = 0,
+        short_name = 'o' },
+      replace = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 20,
+        cursor_shape = 'horizontal',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'r' },
+      statusline = {
+        mouse_shape = 0,
+        short_name = 's' },
+      vdrag = {
+        mouse_shape = 0,
+        short_name = 'vd' },
+      visual = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 45,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'v' },
+      visual_select = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 35,
+        cursor_shape = 'vertical',
+        hl_id = 45,
+        id_lm = 45,
+        mouse_shape = 0,
+        short_name = 've' },
+      vsep = {
+        mouse_shape = 0,
+        short_name = 'vs' }
+      }
+    -- Default 'guicursor' published on startup.
+    eq(expected_cursor_style, screen._cursor_style)
+    eq('normal', screen.mode)
+
+    -- 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.
+    eq(nil, screen._cursor_style)
+
+    -- 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.
+    eq('vertical', screen._cursor_style.normal.cursor_shape)
+    eq('horizontal', screen._cursor_style.visual_select.cursor_shape)
+    eq('vertical', screen._cursor_style.pending.cursor_shape)
+    eq('block', screen._cursor_style.insert.cursor_shape)
+    eq('vertical', screen._cursor_style.match_paren.cursor_shape)
+  end)
+
+  it("empty 'guicursor' sets cursor_shape=block in all modes", function()
+    meths.set_option('guicursor', '')
+    command('redraw')
+    screen:expect('', nil, nil, nil, true)  -- Tickle the event-loop.
+    for _, m in ipairs({ 'cmd_insert', 'cmd_normal', 'cmd_replace', 'insert',
+                         'match_paren', 'normal', 'replace', 'visual',
+                         'visual_select', }) do
+      eq('block', screen._cursor_style[m].cursor_shape)
+    end
+  end)
+
+end)