Merge branch 'master' into luaviml'/lua

5 files changed, 271 insertions, 117 deletions

diff --git a/test/functional/ui/cursor_spec.lua b/test/functional/ui/cursor_spec.lua
new file mode 100644
index 0000000000..02e9422781
--- /dev/null
+++ b/test/functional/ui/cursor_spec.lua
@@ -0,0 +1,192 @@
+local helpers = require('test.functional.helpers')(after_each)
+local Screen = require('test.functional.ui.screen')
+local clear, meths = helpers.clear, helpers.meths
+local eq = helpers.eq
+local command = helpers.command
+
+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()
+    local expected_cursor_style = {
+      cmdline_hover = {
+        mouse_shape = 0,
+        short_name = 'e' },
+      cmdline_insert = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 25,
+        cursor_shape = 'vertical',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'ci' },
+      cmdline_normal = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'c' },
+      cmdline_replace = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 20,
+        cursor_shape = 'horizontal',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'cr' },
+      insert = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 25,
+        cursor_shape = 'vertical',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'i' },
+      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 = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'n' },
+      operator = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 50,
+        cursor_shape = 'horizontal',
+        hl_id = 46,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 'o' },
+      replace = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 20,
+        cursor_shape = 'horizontal',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'r' },
+      showmatch = {
+        blinkoff = 150,
+        blinkon = 175,
+        blinkwait = 175,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 46,
+        id_lm = 46,
+        short_name = 'sm' },
+      statusline_drag = {
+        mouse_shape = 0,
+        short_name = 'sd' },
+      statusline_hover = {
+        mouse_shape = 0,
+        short_name = 's' },
+      visual = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 0,
+        cursor_shape = 'block',
+        hl_id = 46,
+        id_lm = 47,
+        mouse_shape = 0,
+        short_name = 'v' },
+      visual_select = {
+        blinkoff = 250,
+        blinkon = 400,
+        blinkwait = 700,
+        cell_percentage = 35,
+        cursor_shape = 'vertical',
+        hl_id = 46,
+        id_lm = 46,
+        mouse_shape = 0,
+        short_name = 've' },
+      vsep_drag = {
+        mouse_shape = 0,
+        short_name = 'vd' },
+      vsep_hover = {
+        mouse_shape = 0,
+        short_name = 'vs' }
+    }
+
+    screen:expect(function()
+      -- Default 'guicursor' published on startup.
+      eq(expected_cursor_style, screen._cursor_style)
+      eq(true, screen._cursor_style_enabled)
+      eq('normal', screen.mode)
+    end)
+
+    -- Event is published ONLY if the cursor style changed.
+    screen._cursor_style = nil
+    command("echo 'test'")
+    screen:expect([[
+      ^                         |
+      ~                        |
+      ~                        |
+      ~                        |
+      test                     |
+    ]], nil, nil, function()
+      eq(nil, screen._cursor_style)
+    end)
+
+    -- 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')
+    screen:expect(function()
+      eq('vertical', screen._cursor_style.normal.cursor_shape)
+      eq('horizontal', screen._cursor_style.visual_select.cursor_shape)
+      eq('vertical', screen._cursor_style.operator.cursor_shape)
+      eq('block', screen._cursor_style.insert.cursor_shape)
+      eq('vertical', screen._cursor_style.showmatch.cursor_shape)
+      eq(171, screen._cursor_style.normal.blinkwait)
+      eq(172, screen._cursor_style.normal.blinkoff)
+      eq(173, screen._cursor_style.normal.blinkon)
+    end)
+  end)
+
+  it("empty 'guicursor' sets cursor_shape=block in all modes", function()
+    meths.set_option('guicursor', '')
+    screen:expect(function()
+      -- Empty 'guicursor' sets enabled=false.
+      eq(false, screen._cursor_style_enabled)
+      for _, m in ipairs({ 'cmdline_insert', 'cmdline_normal', 'cmdline_replace', 'insert',
+                           'showmatch', 'normal', 'replace', 'visual',
+                           'visual_select', }) do
+        eq('block', screen._cursor_style[m].cursor_shape)
+        eq(0, screen._cursor_style[m].blinkon)
+      end
+    end)
+  end)
+
+end)
diff --git a/test/functional/ui/highlight_spec.lua b/test/functional/ui/highlight_spec.lua
index 7a1b8c91e7..05cf3231ea 100644
--- a/test/functional/ui/highlight_spec.lua
+++ b/test/functional/ui/highlight_spec.lua
@@ -200,58 +200,31 @@ describe('Default highlight groups', function()
 
   it('insert mode text', function()
     feed('i')
+    screen:try_resize(53, 4)
     screen:expect([[
       ^                                                     |
       {0:~                                                    }|
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
       {1:-- INSERT --}                                         |
     ]], {[0] = {bold=true, foreground=Screen.colors.Blue},
     [1] = {bold = true}})
   end)
 
   it('end of file markers', function()
+    screen:try_resize(53, 4)
     screen:expect([[
       ^                                                     |
       {1:~                                                    }|
       {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
-      {1:~                                                    }|
                                                            |
     ]], {[1] = {bold = true, foreground = Screen.colors.Blue}})
   end)
 
   it('"wait return" text', function()
+    screen:try_resize(53, 4)
     feed(':ls<cr>')
     screen:expect([[
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
       :ls                                                  |
         1 %a   "[No Name]"                    line 1       |
       {1:Press ENTER or type command to continue}^              |
@@ -259,23 +232,15 @@ describe('Default highlight groups', function()
     [1] = {bold = true, foreground = Screen.colors.SeaGreen}})
     feed('<cr>') --  skip the "Press ENTER..." state or tests will hang
   end)
+
   it('can be cleared and linked to other highlight groups', function()
+    screen:try_resize(53, 4)
     execute('highlight clear ModeMsg')
     feed('i')
     screen:expect([[
       ^                                                     |
       {0:~                                                    }|
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
       -- INSERT --                                         |
     ]], {[0] = {bold=true, foreground=Screen.colors.Blue},
     [1] = {bold=true}})
@@ -287,21 +252,13 @@ describe('Default highlight groups', function()
       ^                                                     |
       {0:~                                                    }|
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
       {1:-- INSERT --}                                         |
     ]], {[0] = {bold=true, foreground=Screen.colors.Blue},
     [1] = {foreground = Screen.colors.Red, background = Screen.colors.Green}})
   end)
+
   it('can be cleared by assigning NONE', function()
+    screen:try_resize(53, 4)
     execute('syn keyword TmpKeyword neovim')
     execute('hi link TmpKeyword ErrorMsg')
     insert('neovim')
@@ -309,16 +266,6 @@ describe('Default highlight groups', function()
       {1:neovi^m}                                               |
       {0:~                                                    }|
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
                                                            |
     ]], {
       [0] = {bold=true, foreground=Screen.colors.Blue},
@@ -330,18 +277,34 @@ describe('Default highlight groups', function()
       neovi^m                                               |
       {0:~                                                    }|
       {0:~                                                    }|
+                                                           |
+    ]], {[0] = {bold=true, foreground=Screen.colors.Blue}})
+  end)
+
+  it('Whitespace highlight', function()
+    screen:try_resize(53, 4)
+    execute('highlight NonText gui=NONE guifg=#FF0000')
+    execute('set listchars=space:.,tab:>-,trail:*,eol:¬ list')
+    insert('   ne \t o\tv  im  ')
+    screen:expect([[
+      ne{0:.>----.}o{0:>-----}v{0:..}im{0:*^*¬}                             |
       {0:~                                                    }|
       {0:~                                                    }|
+                                                           |
+    ]], {
+      [0] = {foreground=Screen.colors.Red},
+      [1] = {foreground=Screen.colors.Blue},
+    })
+    execute('highlight Whitespace gui=NONE guifg=#0000FF')
+    screen:expect([[
+      ne{1:.>----.}o{1:>-----}v{1:..}im{1:*^*}{0:¬}                             |
       {0:~                                                    }|
       {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-      {0:~                                                    }|
-                                                           |
-    ]], {[0] = {bold=true, foreground=Screen.colors.Blue}})
+      :highlight Whitespace gui=NONE guifg=#0000FF         |
+    ]], {
+      [0] = {foreground=Screen.colors.Red},
+      [1] = {foreground=Screen.colors.Blue},
+    })
   end)
 end)
 
@@ -510,7 +473,7 @@ describe("'listchars' highlight", function()
       },
     })
     execute('highlight clear ModeMsg')
-    execute('highlight SpecialKey guifg=#FF0000')
+    execute('highlight Whitespace guifg=#FF0000')
     execute('set cursorline')
     execute('set tabstop=8')
     execute('set listchars=space:.,eol:¬,tab:>-,extends:>,precedes:<,trail:* list')
@@ -606,7 +569,7 @@ describe("'listchars' highlight", function()
       },
     })
     execute('highlight clear ModeMsg')
-    execute('highlight SpecialKey guifg=#FF0000')
+    execute('highlight Whitespace guifg=#FF0000')
     execute('set cursorline')
     execute('set tabstop=8')
     execute('set nowrap')
@@ -653,7 +616,7 @@ describe("'listchars' highlight", function()
       [3] = {foreground=Screen.colors.Green1},
     })
     execute('highlight clear ModeMsg')
-    execute('highlight SpecialKey guifg=#FF0000')
+    execute('highlight Whitespace guifg=#FF0000')
     execute('highlight Error guifg=#00FF00')
     execute('set nowrap')
     feed('ia \t bc \t  <esc>')
diff --git a/test/functional/ui/mouse_spec.lua b/test/functional/ui/mouse_spec.lua
index b2fbedfb5e..ecbd5642d1 100644
--- a/test/functional/ui/mouse_spec.lua
+++ b/test/functional/ui/mouse_spec.lua
@@ -6,7 +6,7 @@ local eq, funcs = helpers.eq, helpers.funcs
 
 if helpers.pending_win32(pending) then return end
 
-describe('Mouse input', function()
+describe('ui/mouse/input', function()
   local screen
 
   before_each(function()
diff --git a/test/functional/ui/screen.lua b/test/functional/ui/screen.lua
index 54f43387dc..2f2cc85dab 100644
--- a/test/functional/ui/screen.lua
+++ b/test/functional/ui/screen.lua
@@ -181,6 +181,7 @@ end
 -- expected:    Expected screen state (string). Each line represents a screen
 --              row. Last character of each row (typically "|") is stripped.
 --              Common indentation is stripped.
+--              Used as `condition` if NOT a string; must be the ONLY arg then.
 -- attr_ids:    Expected text attributes. Screen rows are transformed according
 --              to this table, as follows: each substring S composed of
 --              characters having the same attributes will be substituted by
@@ -191,18 +192,23 @@ end
 -- any:         true: Succeed if `expected` matches ANY screen line(s).
 --              false (default): `expected` must match screen exactly.
 function Screen:expect(expected, attr_ids, attr_ignore, condition, any)
-  -- remove the last line and dedent
-  expected = dedent(expected:gsub('\n[ ]+$', ''))
   local expected_rows = {}
-  for row in expected:gmatch('[^\n]+') do
-    -- the last character should be the screen delimiter
-    row = row:sub(1, #row - 1)
-    table.insert(expected_rows, row)
-  end
-  if not any then
-    assert(self._height == #expected_rows,
-      "Expected screen state's row count(" .. #expected_rows
-      .. ') differs from configured height(' .. self._height .. ') of Screen.')
+  if type(expected) ~= "string" then
+    assert(not (attr_ids or attr_ignore or condition or any))
+    condition = expected
+    expected = nil
+  else
+    -- Remove the last line and dedent.
+    expected = dedent(expected:gsub('\n[ ]+$', ''))
+    for row in expected:gmatch('[^\n]+') do
+      row = row:sub(1, #row - 1) -- Last char must be the screen delimiter.
+      table.insert(expected_rows, row)
+    end
+    if not any then
+      assert(self._height == #expected_rows,
+        "Expected screen state's row count(" .. #expected_rows
+        .. ') differs from configured height(' .. self._height .. ') of Screen.')
+    end
   end
   local ids = attr_ids or self._default_attr_ids
   local ignore = attr_ignore or self._default_attr_ignore
@@ -218,7 +224,9 @@ function Screen:expect(expected, attr_ids, attr_ignore, condition, any)
       actual_rows[i] = self:_row_repr(self._rows[i], ids, ignore)
     end
 
-    if any then
+    if expected == nil then
+      return
+    elseif any then
       -- Search for `expected` anywhere in the screen lines.
       local actual_screen_str = table.concat(actual_rows, '\n')
       if nil == string.find(actual_screen_str, expected) then
@@ -313,6 +321,8 @@ function Screen:_redraw(updates)
       if handler ~= nil then
         handler(self, unpack(update[i]))
       else
+        assert(self._on_event,
+          "Add Screen:_handle_XXX method or call Screen:set_on_event_handler")
         self._on_event(method, update[i])
       end
     end
@@ -343,6 +353,11 @@ function Screen:_handle_resize(width, height)
   }
 end
 
+function Screen:_handle_cursor_style_set(enabled, style)
+  self._cursor_style_enabled = enabled
+  self._cursor_style = style
+end
+
 function Screen:_handle_clear()
   self:_clear_block(self._scroll_region.top, self._scroll_region.bot,
                     self._scroll_region.left, self._scroll_region.right)
diff --git a/test/functional/ui/screen_basic_spec.lua b/test/functional/ui/screen_basic_spec.lua
index e511234e5e..21953ba294 100644
--- a/test/functional/ui/screen_basic_spec.lua
+++ b/test/functional/ui/screen_basic_spec.lua
@@ -73,33 +73,29 @@ describe('Screen', function()
   describe(':suspend', function()
     it('is forwarded to the UI', function()
       local function check()
-        if not screen.suspended then
-          return 'Screen was not suspended'
-        end
+        eq(true, screen.suspended)
       end
       execute('suspend')
-      screen:wait(check)
+      screen:expect(check)
       screen.suspended = false
       feed('<c-z>')
-      screen:wait(check)
+      screen:expect(check)
     end)
   end)
 
   describe('bell/visual bell', function()
     it('is forwarded to the UI', function()
       feed('<left>')
-      screen:wait(function()
-        if not screen.bell or screen.visual_bell then
-          return 'Bell was not sent'
-        end
+      screen:expect(function()
+        eq(true, screen.bell)
+        eq(false, screen.visual_bell)
       end)
       screen.bell = false
       execute('set visualbell')
       feed('<left>')
-      screen:wait(function()
-        if not screen.visual_bell or screen.bell then
-          return 'Visual bell was not sent'
-        end
+      screen:expect(function()
+        eq(true, screen.visual_bell)
+        eq(false, screen.bell)
       end)
     end)
   end)
@@ -109,22 +105,16 @@ describe('Screen', function()
       local expected = 'test-title'
       execute('set titlestring='..expected)
       execute('set title')
-      screen:wait(function()
-        local actual = screen.title
-        if actual ~= expected then
-          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
-        end
+      screen:expect(function()
+        eq(expected, screen.title)
       end)
     end)
 
     it('has correct default title with unnamed file', function()
       local expected = '[No Name] - NVIM'
       execute('set title')
-      screen:wait(function()
-        local actual = screen.title
-        if actual ~= expected then
-          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
-        end
+      screen:expect(function()
+        eq(expected, screen.title)
       end)
     end)
 
@@ -132,11 +122,8 @@ describe('Screen', function()
       local expected = 'myfile (/mydir) - NVIM'
       execute('set title')
       execute('file /mydir/myfile')
-      screen:wait(function()
-        local actual = screen.title
-        if actual ~= expected then
-          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
-        end
+      screen:expect(function()
+        eq(expected, screen.title)
       end)
     end)
   end)
@@ -146,11 +133,8 @@ describe('Screen', function()
       local expected = 'test-icon'
       execute('set iconstring='..expected)
       execute('set icon')
-      screen:wait(function()
-        local actual = screen.icon
-        if actual ~= expected then
-          return 'Expected title to be "'..expected..'" but was "'..actual..'"'
-        end
+      screen:expect(function()
+        eq(expected, screen.icon)
       end)
     end)
   end)