UI/ext_messages: learn more message kinds

ref #6201

2 files changed, 139 insertions, 20 deletions

diff --git a/test/functional/ui/messages_spec.lua b/test/functional/ui/messages_spec.lua
index 697ddc1887..d49d2f0316 100644
--- a/test/functional/ui/messages_spec.lua
+++ b/test/functional/ui/messages_spec.lua
@@ -22,8 +22,129 @@ describe('ui/ext_messages', function()
       [6] = {bold = true, reverse = true},
     })
   end)
+  after_each(function()
+    os.remove('Xtest')
+  end)
+
+  it('msg_show kind=confirm,confirm_sub,emsg,wmsg', function()
+    feed('iline 1\nline 2<esc>')
+
+    -- kind=confirm
+    feed(':echo confirm("test")<cr>')
+    screen:expect{grid=[[
+      line 1                   |
+      line ^2                   |
+      {1:~                        }|
+      {1:~                        }|
+      {1:~                        }|
+    ]], messages={ {
+      content = {{"\ntest\n[O]k: ", 4}},
+      kind = 'confirm',
+    }}}
+    feed('<cr><cr>')
+    screen:expect{grid=[[
+      line 1                   |
+      line ^2                   |
+      {1:~                        }|
+      {1:~                        }|
+      {1:~                        }|
+    ]], messages={ {
+        content = { { "\ntest\n[O]k: ", 4 } },
+        kind = "confirm"
+      }, {
+        content = { { "1" } },
+        kind = "echo"
+      }, {
+        content = { { "Press ENTER or type command to continue", 4 } },
+        kind = "return_prompt"
+    } }}
+    feed('<cr><cr>')
+
+    -- kind=confirm_sub
+    feed(':%s/i/X/gc<cr>')
+    screen:expect{grid=[[
+      l{7:i}ne 1                   |
+      l{8:i}ne ^2                   |
+      {1:~                        }|
+      {1:~                        }|
+      {1:~                        }|
+    ]], attr_ids={
+      [1] = {bold = true, foreground = Screen.colors.Blue1},
+      [2] = {foreground = Screen.colors.Grey100, background = Screen.colors.Red},
+      [3] = {bold = true},
+      [4] = {bold = true, foreground = Screen.colors.SeaGreen4},
+      [5] = {foreground = Screen.colors.Blue1},
+      [6] = {bold = true, reverse = true},
+      [7] = {reverse = true},
+      [8] = {background = Screen.colors.Yellow},
+    }, messages={ {
+        content = { { "replace with X (y/n/a/q/l/^E/^Y)?", 4 } },
+        kind = "confirm_sub"
+      } }}
+    feed('nq')
+
+    -- kind=wmsg (editing readonly file)
+    command('write Xtest')
+    command('set readonly nohls')
+    feed('G$x')
+    screen:expect{grid=[[
+        line 1                   |
+        {IGNORE}|
+        {1:~                        }|
+        {1:~                        }|
+        {1:~                        }|
+      ]], attr_ids={
+      [1] = {bold = true, foreground = Screen.colors.Blue1},
+      [7] = {foreground = Screen.colors.Red},
+      }, messages={ {
+        content = { { "W10: Warning: Changing a readonly file", 7 } },
+        kind = "wmsg"
+      }
+    }}
+
+    -- kind=wmsg ('wrapscan' after search reaches EOF)
+    feed('uG$/i<cr>')
+    screen:expect{grid=[[
+      l^ine 1                   |
+      line 2                   |
+      {1:~                        }|
+      {1:~                        }|
+      {1:~                        }|
+    ]], attr_ids={
+      [1] = {bold = true, foreground = Screen.colors.Blue1},
+      [2] = {foreground = Screen.colors.Grey100, background = Screen.colors.Red},
+      [3] = {bold = true},
+      [4] = {bold = true, foreground = Screen.colors.SeaGreen4},
+      [5] = {foreground = Screen.colors.Blue1},
+      [6] = {bold = true, reverse = true},
+      [7] = {foreground = Screen.colors.Red},
+    }, messages={ {
+        content = { { "search hit BOTTOM, continuing at TOP", 7 } },
+        kind = "wmsg"
+      } }}
+
+    -- kind=emsg after :throw
+    feed(':throw "foo"<cr>')
+    screen:expect{grid=[[
+      l^ine 1                   |
+      line 2                   |
+      {1:~                        }|
+      {1:~                        }|
+      {1:~                        }|
+    ]], messages={ {
+        content = { { "Error detected while processing :", 2 } },
+        kind = "emsg"
+      }, {
+        content = { { "E605: Exception not caught: foo", 2 } },
+        kind = ""
+      }, {
+        content = { { "Press ENTER or type command to continue", 4 } },
+        kind = "return_prompt"
+      } }
+    }
+  end)
 
-  it('supports :echoerr', function()
+  it(':echoerr', function()
     feed(':echoerr "raa"<cr>')
     screen:expect{grid=[[
       ^                         |
@@ -142,7 +263,7 @@ describe('ui/ext_messages', function()
     }}
   end)
 
-  it('supports showmode', function()
+  it('&showmode', function()
     command('imap <f2> <cmd>echomsg "stuff"<cr>')
     feed('i')
     screen:expect{grid=[[
@@ -230,7 +351,7 @@ describe('ui/ext_messages', function()
     }}
   end)
 
-  it('supports showmode with recording message', function()
+  it('&showmode with macro-recording message', function()
     feed('qq')
     screen:expect{grid=[[
       ^                         |
@@ -268,7 +389,7 @@ describe('ui/ext_messages', function()
     ]])
   end)
 
-  it('shows recording message with noshowmode', function()
+  it('shows macro-recording message with &noshowmode', function()
     command("set noshowmode")
     feed('qq')
     -- also check mode to avoid immediate success
@@ -308,7 +429,7 @@ describe('ui/ext_messages', function()
     ]], mode="normal"}
   end)
 
-  it('supports showcmd and ruler', function()
+  it('supports &showcmd and &ruler', function()
     command('set showcmd ruler')
     screen:expect{grid=[[
       ^                         |
diff --git a/test/functional/ui/screen.lua b/test/functional/ui/screen.lua
index 983a2f3d40..53b6642207 100644
--- a/test/functional/ui/screen.lua
+++ b/test/functional/ui/screen.lua
@@ -74,6 +74,7 @@
 local global_helpers = require('test.helpers')
 local deepcopy = global_helpers.deepcopy
 local shallowcopy = global_helpers.shallowcopy
+local concat_tables = global_helpers.concat_tables
 local helpers = require('test.functional.helpers')(nil)
 local request, run_session = helpers.request, helpers.run_session
 local eq = helpers.eq
@@ -413,26 +414,23 @@ screen:redraw_debug() to show all intermediate screen states.  ]])
       end
     end
 
-    -- Extension features. The default expectations should cover the case of
+    -- UI extensions. The default expectations should cover the case of
     -- the ext_ feature being disabled, or the feature currently not activated
-    -- (for instance no external cmdline visible). Some extensions require
+    -- (e.g. no external cmdline visible). Some extensions require
     -- preprocessing to represent highlights in a reproducible way.
     local extstate = self:_extstate_repr(attr_state)
-
-    -- convert assertion errors into invalid screen state descriptions
-    local status, res = pcall(function()
-      for _, k in ipairs(ext_keys) do
-        -- Empty states is considered the default and need not be mentioned
-        if not (expected[k] == nil and isempty(extstate[k])) then
-          eq(expected[k], extstate[k], k)
+    if expected['mode'] ~= nil then
+      extstate['mode'] = self.mode
+    end
+    -- Convert assertion errors into invalid screen state descriptions.
+    for _, k in ipairs(concat_tables(ext_keys, {'mode'})) do
+      -- Empty states are considered the default and need not be mentioned.
+      if (not (expected[k] == nil and isempty(extstate[k]))) then
+        local status, res = pcall(eq, expected[k], extstate[k], k)
+        if not status then
+          return (tostring(res)..'\nHint: full state of "'..k..'":\n  '..inspect(extstate[k]))
         end
       end
-      if expected.mode ~= nil then
-        eq(expected.mode, self.mode, "mode")
-      end
-    end)
-    if not status then
-      return tostring(res)
     end
   end, expected)
 end