test(statusline): add test with control characters (#24197)

test/functional/ui/statusline_spec.lua

@@ -21,6 +21,10 @@ for _, model in ipairs(mousemodels) do
     before_each(function()
       clear()
       screen = Screen.new(40, 8)
+      screen:set_default_attr_ids({
+        [0] = {bold = true, foreground = Screen.colors.Blue};  -- NonText
+        [1] = {bold = true, reverse = true};  -- StatusLine
+      })
       screen:attach()
       command('set laststatus=2 mousemodel=' .. model)
       exec([=[
@@ -30,163 +34,190 @@ for _, model in ipairs(mousemodels) do
             let g:testvar ..= '(' .. a:mods .. ')'
           endif
         endfunction
+        let g:testvar = ''
       ]=])
-      end)
-
-      it('works', function()
-        meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 2 l', eval("g:testvar"))
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 3 l', eval("g:testvar"))
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 4 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 1 r', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 2 r', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 3 r', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 4 r', eval("g:testvar"))
-      end)
-
-      it('works for winbar', function()
-        meths.set_option_value('winbar',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        meths.input_mouse('left', 'press', '', 0, 0, 17)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 0, 17)
-        eq('0 1 r', eval("g:testvar"))
-      end)
-
-      it('works for winbar in floating window', function()
-        meths.open_win(0, true, { width=30, height=4, relative='editor', row=1, col=5,
-        border = "single" })
-        meths.set_option_value('winbar', 'Not clicky stuff %0@MyClickFunc@Clicky stuff%T',
-        { scope = 'local' })
-        meths.input_mouse('left', 'press', '', 0, 2, 23)
-        eq('0 1 l', eval("g:testvar"))
-      end)
-
-      it('works when there are multiple windows', function()
-        command('split')
-        meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        meths.set_option_value('winbar',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        meths.input_mouse('left', 'press', '', 0, 0, 17)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 4, 17)
-        eq('0 1 r', eval("g:testvar"))
-        meths.input_mouse('middle', 'press', '', 0, 3, 17)
-        eq('0 1 m', eval("g:testvar"))
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 1 l', eval("g:testvar"))
-      end)
-
-      it('works with Lua function', function()
-        exec_lua([[
-        function clicky_func(minwid, clicks, button, mods)
-          vim.g.testvar = string.format("%d %d %s", minwid, clicks, button)
-        end
-        ]])
-        meths.set_option_value('statusline',  'Not clicky stuff %0@v:lua.clicky_func@Clicky stuff%T', {})
-        meths.input_mouse('left', 'press', '', 0, 6, 17)
-        eq('0 1 l', eval("g:testvar"))
-      end)
-
-      it('ignores unsupported click items', function()
-        command('tabnew | tabprevious')
-        meths.set_option_value('statusline',  '%2TNot clicky stuff%T', {})
-        meths.input_mouse('left', 'press', '', 0, 6, 0)
-        eq(1, meths.get_current_tabpage().id)
-        meths.set_option_value('statusline',  '%2XNot clicky stuff%X', {})
-        meths.input_mouse('left', 'press', '', 0, 6, 0)
-        eq(2, #meths.list_tabpages())
-      end)
-
-      it("right click works when statusline isn't focused #18994", function()
-        meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 1 r', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 17)
-        eq('0 2 r', eval("g:testvar"))
-      end)
-
-      it("works with modifiers #18994", function()
-        meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
-        -- Note: alternate between left and right mouse buttons to avoid triggering multiclicks
-        meths.input_mouse('left', 'press', 'S', 0, 6, 17)
-        eq('0 1 l(s   )', eval("g:testvar"))
-        meths.input_mouse('right', 'press', 'S', 0, 6, 17)
-        eq('0 1 r(s   )', eval("g:testvar"))
-        meths.input_mouse('left', 'press', 'A', 0, 6, 17)
-        eq('0 1 l(  a )', eval("g:testvar"))
-        meths.input_mouse('right', 'press', 'A', 0, 6, 17)
-        eq('0 1 r(  a )', eval("g:testvar"))
-        meths.input_mouse('left', 'press', 'AS', 0, 6, 17)
-        eq('0 1 l(s a )', eval("g:testvar"))
-        meths.input_mouse('right', 'press', 'AS', 0, 6, 17)
-        eq('0 1 r(s a )', eval("g:testvar"))
-        meths.input_mouse('left', 'press', 'T', 0, 6, 17)
-        eq('0 1 l(   m)', eval("g:testvar"))
-        meths.input_mouse('right', 'press', 'T', 0, 6, 17)
-        eq('0 1 r(   m)', eval("g:testvar"))
-        meths.input_mouse('left', 'press', 'TS', 0, 6, 17)
-        eq('0 1 l(s  m)', eval("g:testvar"))
-        meths.input_mouse('right', 'press', 'TS', 0, 6, 17)
-        eq('0 1 r(s  m)', eval("g:testvar"))
-        meths.input_mouse('left', 'press', 'C', 0, 6, 17)
-        eq('0 1 l( c  )', eval("g:testvar"))
-        -- <C-RightMouse> is for tag jump
-      end)
-
-      it("works for global statusline with vertical splits #19186", function()
-        command('set laststatus=3')
-        meths.set_option_value('statusline',  '%0@MyClickFunc@Clicky stuff%T %= %0@MyClickFunc@Clicky stuff%T', {})
-        command('vsplit')
-        screen:expect([[
-        ^                    │                   |
-        ~                   │~                  |
-        ~                   │~                  |
-        ~                   │~                  |
-        ~                   │~                  |
-        ~                   │~                  |
-        Clicky stuff                Clicky stuff|
-                                                |
-        ]])
-
-        -- clickable area on the right
-        meths.input_mouse('left', 'press', '', 0, 6, 35)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 35)
-        eq('0 1 r', eval("g:testvar"))
-
-        -- clickable area on the left
-        meths.input_mouse('left', 'press', '', 0, 6, 5)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 5)
-        eq('0 1 r', eval("g:testvar"))
-      end)
-
-      it('no memory leak with zero-width click labels', function()
-        command([[
-        let &stl = '%@Test@%T%@MyClickFunc@%=%T%@Test@'
-        ]])
-        meths.input_mouse('left', 'press', '', 0, 6, 0)
-        eq('0 1 l', eval("g:testvar"))
-        meths.input_mouse('right', 'press', '', 0, 6, 39)
-        eq('0 1 r', eval("g:testvar"))
-      end)
-
-      it('no memory leak with truncated click labels', function()
-        command([[
-        let &stl = '%@MyClickFunc@foo%X' .. repeat('a', 40) .. '%<t%@Test@bar%X%@Test@baz'
-        ]])
-        meths.input_mouse('left', 'press', '', 0, 6, 2)
-        eq('0 1 l', eval("g:testvar"))
-      end)
     end)
+
+    it('works', function()
+      meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      meths.input_mouse('left', 'press', '', 0, 6, 16)
+      eq('', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 29)
+      eq('', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 2 l', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 3 l', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 4 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 28)
+      eq('0 1 r', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 28)
+      eq('0 2 r', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 28)
+      eq('0 3 r', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 28)
+      eq('0 4 r', eval("g:testvar"))
+    end)
+
+    it('works with control characters and highlight', function()
+      meths.set_option_value('statusline',  '\t%#NonText#\1%0@MyClickFunc@\t\1%T\t%##\1', {})
+      screen:expect{grid=[[
+        ^                                        |
+        {0:~                                       }|
+        {0:~                                       }|
+        {0:~                                       }|
+        {0:~                                       }|
+        {0:~                                       }|
+        {1:^I}{0:^A^I^A^I}{1:^A                            }|
+                                                |
+      ]]}
+      meths.input_mouse('right', 'press', '', 0, 6, 3)
+      eq('', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 8)
+      eq('', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 4)
+      eq('0 1 r', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 7)
+      eq('0 1 l', eval("g:testvar"))
+    end)
+
+    it('works for winbar', function()
+      meths.set_option_value('winbar',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      meths.input_mouse('left', 'press', '', 0, 0, 17)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 0, 17)
+      eq('0 1 r', eval("g:testvar"))
+    end)
+
+    it('works for winbar in floating window', function()
+      meths.open_win(0, true, { width=30, height=4, relative='editor', row=1, col=5,
+      border = "single" })
+      meths.set_option_value('winbar', 'Not clicky stuff %0@MyClickFunc@Clicky stuff%T',
+      { scope = 'local' })
+      meths.input_mouse('left', 'press', '', 0, 2, 23)
+      eq('0 1 l', eval("g:testvar"))
+    end)
+
+    it('works when there are multiple windows', function()
+      command('split')
+      meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      meths.set_option_value('winbar',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      meths.input_mouse('left', 'press', '', 0, 0, 17)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 4, 17)
+      eq('0 1 r', eval("g:testvar"))
+      meths.input_mouse('middle', 'press', '', 0, 3, 17)
+      eq('0 1 m', eval("g:testvar"))
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 1 l', eval("g:testvar"))
+    end)
+
+    it('works with Lua function', function()
+      exec_lua([[
+      function clicky_func(minwid, clicks, button, mods)
+        vim.g.testvar = string.format("%d %d %s", minwid, clicks, button)
+      end
+      ]])
+      meths.set_option_value('statusline',  'Not clicky stuff %0@v:lua.clicky_func@Clicky stuff%T', {})
+      meths.input_mouse('left', 'press', '', 0, 6, 17)
+      eq('0 1 l', eval("g:testvar"))
+    end)
+
+    it('ignores unsupported click items', function()
+      command('tabnew | tabprevious')
+      meths.set_option_value('statusline',  '%2TNot clicky stuff%T', {})
+      meths.input_mouse('left', 'press', '', 0, 6, 0)
+      eq(1, meths.get_current_tabpage().id)
+      meths.set_option_value('statusline',  '%2XNot clicky stuff%X', {})
+      meths.input_mouse('left', 'press', '', 0, 6, 0)
+      eq(2, #meths.list_tabpages())
+    end)
+
+    it("right click works when statusline isn't focused #18994", function()
+      meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      meths.input_mouse('right', 'press', '', 0, 6, 17)
+      eq('0 1 r', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 17)
+      eq('0 2 r', eval("g:testvar"))
+    end)
+
+    it("works with modifiers #18994", function()
+      meths.set_option_value('statusline',  'Not clicky stuff %0@MyClickFunc@Clicky stuff%T', {})
+      -- Note: alternate between left and right mouse buttons to avoid triggering multiclicks
+      meths.input_mouse('left', 'press', 'S', 0, 6, 17)
+      eq('0 1 l(s   )', eval("g:testvar"))
+      meths.input_mouse('right', 'press', 'S', 0, 6, 17)
+      eq('0 1 r(s   )', eval("g:testvar"))
+      meths.input_mouse('left', 'press', 'A', 0, 6, 17)
+      eq('0 1 l(  a )', eval("g:testvar"))
+      meths.input_mouse('right', 'press', 'A', 0, 6, 17)
+      eq('0 1 r(  a )', eval("g:testvar"))
+      meths.input_mouse('left', 'press', 'AS', 0, 6, 17)
+      eq('0 1 l(s a )', eval("g:testvar"))
+      meths.input_mouse('right', 'press', 'AS', 0, 6, 17)
+      eq('0 1 r(s a )', eval("g:testvar"))
+      meths.input_mouse('left', 'press', 'T', 0, 6, 17)
+      eq('0 1 l(   m)', eval("g:testvar"))
+      meths.input_mouse('right', 'press', 'T', 0, 6, 17)
+      eq('0 1 r(   m)', eval("g:testvar"))
+      meths.input_mouse('left', 'press', 'TS', 0, 6, 17)
+      eq('0 1 l(s  m)', eval("g:testvar"))
+      meths.input_mouse('right', 'press', 'TS', 0, 6, 17)
+      eq('0 1 r(s  m)', eval("g:testvar"))
+      meths.input_mouse('left', 'press', 'C', 0, 6, 17)
+      eq('0 1 l( c  )', eval("g:testvar"))
+      -- <C-RightMouse> is for tag jump
+    end)
+
+    it("works for global statusline with vertical splits #19186", function()
+      command('set laststatus=3')
+      meths.set_option_value('statusline',  '%0@MyClickFunc@Clicky stuff%T %= %0@MyClickFunc@Clicky stuff%T', {})
+      command('vsplit')
+      screen:expect{grid=[[
+        ^                    │                   |
+        {0:~                   }│{0:~                  }|
+        {0:~                   }│{0:~                  }|
+        {0:~                   }│{0:~                  }|
+        {0:~                   }│{0:~                  }|
+        {0:~                   }│{0:~                  }|
+        {1:Clicky stuff                Clicky stuff}|
+                                                |
+      ]]}
+
+      -- clickable area on the right
+      meths.input_mouse('left', 'press', '', 0, 6, 35)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 35)
+      eq('0 1 r', eval("g:testvar"))
+
+      -- clickable area on the left
+      meths.input_mouse('left', 'press', '', 0, 6, 5)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 5)
+      eq('0 1 r', eval("g:testvar"))
+    end)
+
+    it('no memory leak with zero-width click labels', function()
+      command([[
+      let &stl = '%@Test@%T%@MyClickFunc@%=%T%@Test@'
+      ]])
+      meths.input_mouse('left', 'press', '', 0, 6, 0)
+      eq('0 1 l', eval("g:testvar"))
+      meths.input_mouse('right', 'press', '', 0, 6, 39)
+      eq('0 1 r', eval("g:testvar"))
+    end)
+
+    it('no memory leak with truncated click labels', function()
+      command([[
+      let &stl = '%@MyClickFunc@foo%X' .. repeat('a', 40) .. '%<t%@Test@bar%X%@Test@baz'
+      ]])
+      meths.input_mouse('left', 'press', '', 0, 6, 2)
+      eq('0 1 l', eval("g:testvar"))
+    end)
+  end)
 end
 
 describe('global statusline', function()