vim-patch:9.0.1397: highlight for popupmenu kind and extra cannot be set (#22619)

Problem:    Highlight for popupmenu kind and extra cannot be set.
Solution:   Add PmenuKind, PmenuKindSel, PmenuExtra and PmenuExtraSel
            highlight groups and use them. (Gianmaria Bajo, closes vim/vim#12114)

https://github.com/vim/vim/commit/6a7c7749204b256e779c245b1e999bf852ad7b64

Co-authored-by: Gianmaria Bajo <mg1979.git@gmail.com>

3 files changed, 126 insertions, 2 deletions

diff --git a/test/functional/ui/cursor_spec.lua b/test/functional/ui/cursor_spec.lua
index e261f0dfab..7e28caea04 100644
--- a/test/functional/ui/cursor_spec.lua
+++ b/test/functional/ui/cursor_spec.lua
@@ -212,10 +212,10 @@ describe('ui/cursor', function()
         if m.blinkwait then m.blinkwait = 700 end
       end
       if m.hl_id then
-          m.hl_id = 60
+          m.hl_id = 64
           m.attr = {background = Screen.colors.DarkGray}
       end
-      if m.id_lm then m.id_lm = 62 end
+      if m.id_lm then m.id_lm = 66 end
     end
 
     -- Assert the new expectation.
diff --git a/test/functional/ui/popupmenu_spec.lua b/test/functional/ui/popupmenu_spec.lua
index c681453294..944319c443 100644
--- a/test/functional/ui/popupmenu_spec.lua
+++ b/test/functional/ui/popupmenu_spec.lua
@@ -3490,6 +3490,68 @@ describe('builtin popupmenu', function()
       pasted                          |
     ]])
   end)
+
+  describe('"kind" and "menu"', function()
+    before_each(function()
+      screen:try_resize(30, 8)
+      exec([[
+        func CompleteFunc( findstart, base )
+          if a:findstart
+            return 0
+          endif
+          return {
+                \ 'words': [
+                \ { 'word': 'aword1', 'menu': 'extra text 1', 'kind': 'W', },
+                \ { 'word': 'aword2', 'menu': 'extra text 2', 'kind': 'W', },
+                \ { 'word': 'aword3', 'menu': 'extra text 3', 'kind': 'W', },
+                \]}
+        endfunc
+        set completeopt=menu
+        set completefunc=CompleteFunc
+      ]])
+    end)
+
+    -- oldtest: Test_pum_highlights_default()
+    it('default highlight groups', function()
+      feed('iaw<C-X><C-u>')
+      screen:expect([[
+        aword1^                        |
+        {s:aword1 W extra text 1 }{1:        }|
+        {n:aword2 W extra text 2 }{1:        }|
+        {n:aword3 W extra text 3 }{1:        }|
+        {1:~                             }|
+        {1:~                             }|
+        {1:~                             }|
+        {2:-- }{5:match 1 of 3}               |
+      ]])
+    end)
+
+    -- oldtest: Test_pum_highlights_custom()
+    it('custom highlight groups', function()
+      exec([[
+        hi PmenuKind      guifg=Red guibg=Magenta
+        hi PmenuKindSel   guifg=Red guibg=Grey
+        hi PmenuExtra     guifg=White guibg=Magenta
+        hi PmenuExtraSel  guifg=Black guibg=Grey
+      ]])
+      local attrs = screen:get_default_attr_ids()
+      attrs.kn = {foreground = Screen.colors.Red, background = Screen.colors.Magenta}
+      attrs.ks = {foreground = Screen.colors.Red, background = Screen.colors.Grey}
+      attrs.xn = {foreground = Screen.colors.White, background = Screen.colors.Magenta}
+      attrs.xs = {foreground = Screen.colors.Black, background = Screen.colors.Grey}
+      feed('iaw<C-X><C-u>')
+      screen:expect([[
+        aword1^                        |
+        {s:aword1 }{ks:W }{xs:extra text 1 }{1:        }|
+        {n:aword2 }{kn:W }{xn:extra text 2 }{1:        }|
+        {n:aword3 }{kn:W }{xn:extra text 3 }{1:        }|
+        {1:~                             }|
+        {1:~                             }|
+        {1:~                             }|
+        {2:-- }{5:match 1 of 3}               |
+      ]], attrs)
+    end)
+  end)
 end)
 
 describe('builtin popupmenu with ui/ext_multigrid', function()
diff --git a/test/old/testdir/test_popup.vim b/test/old/testdir/test_popup.vim
index 791cce4431..2cc676fb6d 100644
--- a/test/old/testdir/test_popup.vim
+++ b/test/old/testdir/test_popup.vim
@@ -1260,4 +1260,66 @@ func Test_pum_scrollbar()
   call delete('Xtest1')
 endfunc
 
+" Test default highlight groups for popup menu
+func Test_pum_highlights_default()
+  CheckScreendump
+  let lines =<< trim END
+    func CompleteFunc( findstart, base )
+      if a:findstart
+        return 0
+      endif
+      return {
+            \ 'words': [
+            \ { 'word': 'aword1', 'menu': 'extra text 1', 'kind': 'W', },
+            \ { 'word': 'aword2', 'menu': 'extra text 2', 'kind': 'W', },
+            \ { 'word': 'aword3', 'menu': 'extra text 3', 'kind': 'W', },
+            \]}
+    endfunc
+    set completeopt=menu
+    set completefunc=CompleteFunc
+  END
+  call writefile(lines, 'Xscript', 'D')
+  let buf = RunVimInTerminal('-S Xscript', {})
+  call TermWait(buf)
+  call term_sendkeys(buf, "iaw\<C-X>\<C-u>")
+  call TermWait(buf, 50)
+  call VerifyScreenDump(buf, 'Test_pum_highlights_01', {})
+  call term_sendkeys(buf, "\<C-E>\<Esc>u")
+  call TermWait(buf)
+  call StopVimInTerminal(buf)
+endfunc
+
+" Test custom highlight groups for popup menu
+func Test_pum_highlights_custom()
+  CheckScreendump
+  let lines =<< trim END
+    func CompleteFunc( findstart, base )
+      if a:findstart
+        return 0
+      endif
+      return {
+            \ 'words': [
+            \ { 'word': 'aword1', 'menu': 'extra text 1', 'kind': 'W', },
+            \ { 'word': 'aword2', 'menu': 'extra text 2', 'kind': 'W', },
+            \ { 'word': 'aword3', 'menu': 'extra text 3', 'kind': 'W', },
+            \]}
+    endfunc
+    set completeopt=menu
+    set completefunc=CompleteFunc
+    hi PmenuKind      ctermfg=1 ctermbg=225
+    hi PmenuKindSel   ctermfg=1 ctermbg=7
+    hi PmenuExtra     ctermfg=243 ctermbg=225
+    hi PmenuExtraSel  ctermfg=0 ctermbg=7
+  END
+  call writefile(lines, 'Xscript', 'D')
+  let buf = RunVimInTerminal('-S Xscript', {})
+  call TermWait(buf)
+  call term_sendkeys(buf, "iaw\<C-X>\<C-u>")
+  call TermWait(buf, 50)
+  call VerifyScreenDump(buf, 'Test_pum_highlights_02', {})
+  call term_sendkeys(buf, "\<C-E>\<Esc>u")
+  call TermWait(buf)
+  call StopVimInTerminal(buf)
+endfunc
+
 " vim: shiftwidth=2 sts=2 expandtab