fix(statusline): overwriting stl_items with nvim_eval_statusline() {-item #32265

Problem:
When an evaluation {-item calls `nvim_eval_statusline()`, that nested
call may overwrite the same memory used for `stl_items`.

Solution:
Make `curitem` static and use it to compute an offset to avoid
overwriting `stl_items` in nested calls to `build_stl_str_hl()`. Move
miscellaneous statusline tests into `describe()` block.

1 files changed, 250 insertions, 255 deletions

diff --git a/test/functional/ui/statusline_spec.lua b/test/functional/ui/statusline_spec.lua
index 1d0f181244..50e31ac6a9 100644
--- a/test/functional/ui/statusline_spec.lua
+++ b/test/functional/ui/statusline_spec.lua
@@ -507,268 +507,263 @@ describe('global statusline', function()
   end)
 end)
 
-it('statusline does not crash if it has Arabic characters #19447', function()
-  clear()
-  api.nvim_set_option_value('statusline', 'غً', {})
-  api.nvim_set_option_value('laststatus', 2, {})
-  command('redraw!')
-  assert_alive()
-end)
+describe('statusline', function()
+  local screen
+  before_each(function()
+    clear()
+    screen = Screen.new(40, 8)
+    screen:add_extra_attr_ids {
+      [100] = { bold = true, reverse = true, foreground = Screen.colors.Blue },
+      [101] = { reverse = true, bold = true, foreground = Screen.colors.SlateBlue },
+    }
+  end)
 
-it('statusline is redrawn with :resize from <Cmd> mapping #19629', function()
-  clear()
-  local screen = Screen.new(40, 8)
-  exec([[
-    set laststatus=2
-    nnoremap <Up> <cmd>resize -1<CR>
-    nnoremap <Down> <cmd>resize +1<CR>
-  ]])
-  feed('<Up>')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|*4
-    {3:[No Name]                               }|
-                                            |*2
-  ]])
-  feed('<Down>')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|*5
-    {3:[No Name]                               }|
-                                            |
-  ]])
-end)
+  it('does not crash if it has Arabic characters #19447', function()
+    api.nvim_set_option_value('statusline', 'غً', {})
+    api.nvim_set_option_value('laststatus', 2, {})
+    command('redraw!')
+    assert_alive()
+  end)
 
-it('showcmdloc=statusline does not show if statusline is too narrow', function()
-  clear()
-  local screen = Screen.new(40, 8)
-  command('set showcmd')
-  command('set showcmdloc=statusline')
-  command('1vsplit')
-  screen:expect([[
-    ^ │                                      |
-    {1:~}│{1:~                                     }|*5
-    {3:< }{2:[No Name]                             }|
-                                            |
-  ]])
-  feed('1234')
-  screen:expect_unchanged()
-end)
+  it('is redrawn with :resize from <Cmd> mapping #19629', function()
+    exec([[
+      set laststatus=2
+      nnoremap <Up> <cmd>resize -1<CR>
+      nnoremap <Down> <cmd>resize +1<CR>
+    ]])
+    feed('<Up>')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*4
+      {3:[No Name]                               }|
+                                              |*2
+    ]])
+    feed('<Down>')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:[No Name]                               }|
+                                              |
+    ]])
+  end)
 
-it('K_EVENT does not trigger a statusline redraw unnecessarily', function()
-  clear()
-  local _ = Screen.new(40, 8)
-  -- does not redraw on vim.schedule (#17937)
-  command([[
-    set laststatus=2
-    let g:counter = 0
-    func Status()
-      let g:counter += 1
-      lua vim.schedule(function() end)
-      return g:counter
-    endfunc
-    set statusline=%!Status()
-  ]])
-  sleep(50)
-  eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
-  -- also in insert mode
-  feed('i')
-  sleep(50)
-  eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
-  -- does not redraw on timer call (#14303)
-  command([[
-    let g:counter = 0
-    func Timer(timer)
-    endfunc
-    call timer_start(1, 'Timer', {'repeat': 100})
-  ]])
-  sleep(50)
-  eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
-end)
+  it('does not contain showmcd with showcmdloc=statusline when too narrow', function()
+    command('set showcmd')
+    command('set showcmdloc=statusline')
+    command('1vsplit')
+    screen:expect([[
+      ^ │                                      |
+      {1:~}│{1:~                                     }|*5
+      {3:< }{2:[No Name]                             }|
+                                              |
+    ]])
+    feed('1234')
+    screen:expect_unchanged()
+  end)
 
-it('statusline is redrawn on various state changes', function()
-  clear()
-  local screen = Screen.new(40, 4)
-
-  -- recording state change #22683
-  command('set ls=2 stl=%{repeat(reg_recording(),5)}')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:                                        }|
-                                            |
-  ]])
-  feed('qQ')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:QQQQQ                                   }|
-    {5:recording @Q}                            |
-  ]])
-  feed('q')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:                                        }|
-                                            |
-  ]])
-
-  -- Visual mode change #23932
-  command('set ls=2 stl=%{mode(1)}')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:n                                       }|
-                                            |
-  ]])
-  feed('v')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:v                                       }|
-    {5:-- VISUAL --}                            |
-  ]])
-  feed('V')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:V                                       }|
-    {5:-- VISUAL LINE --}                       |
-  ]])
-  feed('<C-V>')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:^V                                      }|
-    {5:-- VISUAL BLOCK --}                      |
-  ]])
-  feed('<Esc>')
-  screen:expect([[
-    ^                                        |
-    {1:~                                       }|
-    {3:n                                       }|
-                                            |
-  ]])
-end)
+  it('does not redraw unnecessarily after K_EVENT', function()
+    -- does not redraw on vim.schedule (#17937)
+    command([[
+      set laststatus=2
+      let g:counter = 0
+      func Status()
+        let g:counter += 1
+        lua vim.schedule(function() end)
+        return g:counter
+      endfunc
+      set statusline=%!Status()
+    ]])
+    sleep(50)
+    eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
+    -- also in insert mode
+    feed('i')
+    sleep(50)
+    eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
+    -- does not redraw on timer call (#14303)
+    command([[
+      let g:counter = 0
+      func Timer(timer)
+      endfunc
+      call timer_start(1, 'Timer', {'repeat': 100})
+    ]])
+    sleep(50)
+    eq(1, eval('g:counter < 50'), 'g:counter=' .. eval('g:counter'))
+  end)
 
-it('ruler is redrawn in cmdline with redrawstatus #22804', function()
-  clear()
-  local screen = Screen.new(40, 2)
-  command([[
-    let g:n = 'initial value'
-    set ls=1 ru ruf=%{g:n}
-    redraw
-    let g:n = 'other value'
-    redrawstatus
-  ]])
-  screen:expect([[
-    ^                                        |
-                          other value       |
-  ]])
-end)
+  it('is redrawn on various state changes', function()
+    -- recording state change #22683
+    command('set ls=2 stl=%{repeat(reg_recording(),5)}')
+    local s1 = [[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:                                        }|
+                                              |
+    ]]
+    screen:expect(s1)
+    feed('qQ')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:QQQQQ                                   }|
+      {5:recording @Q}                            |
+    ]])
+    feed('q')
+    screen:expect(s1)
+
+    -- Visual mode change #23932
+    command('set ls=2 stl=%{mode(1)}')
+    local s2 = [[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:n                                       }|
+                                              |
+    ]]
+    screen:expect(s2)
+    feed('v')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:v                                       }|
+      {5:-- VISUAL --}                            |
+    ]])
+    feed('V')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:V                                       }|
+      {5:-- VISUAL LINE --}                       |
+    ]])
+    feed('<C-V>')
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {3:^V                                      }|
+      {5:-- VISUAL BLOCK --}                      |
+    ]])
+    feed('<Esc>')
+    screen:expect(s2)
+  end)
 
-it('shows correct ruler in cmdline with no statusline', function()
-  clear()
-  local screen = Screen.new(30, 8)
-  -- Use long ruler to check 'ruler' with 'rulerformat' set has correct width.
-  command [[
-    set ruler rulerformat=%{winnr()}longlonglong ls=0 winwidth=10
-    split
-    wincmd b
-    vsplit
-    wincmd t
-    wincmd |
-    mode
-  ]]
-  -- Window 1 is current. It has a statusline, so cmdline should show the
-  -- last window's ruler, which has no statusline.
-  command '1wincmd w'
-  screen:expect [[
-    ^                              |
-    {1:~                             }|*2
-    {3:[No Name]      1longlonglong  }|
-                   │              |
-    {1:~              }│{1:~             }|*2
-                   3longlonglong  |
-  ]]
-  -- Window 2 is current. It has no statusline, so cmdline should show its
-  -- ruler instead.
-  command '2wincmd w'
-  screen:expect [[
-                                  |
-    {1:~                             }|*2
-    {2:[No Name]      1longlonglong  }|
-    ^               │              |
-    {1:~              }│{1:~             }|*2
-                   2longlonglong  |
-  ]]
-  -- Window 3 is current. Cmdline should again show its ruler.
-  command '3wincmd w'
-  screen:expect [[
-                                  |
-    {1:~                             }|*2
-    {2:[No Name]      1longlonglong  }|
-                   │^              |
-    {1:~              }│{1:~             }|*2
-                   3longlonglong  |
-  ]]
-end)
+  it('ruler is redrawn in cmdline with redrawstatus #22804', function()
+    command([[
+      let g:n = 'initial value'
+      set ls=1 ru ruf=%{g:n}
+      redraw
+      let g:n = 'other value'
+      redrawstatus
+    ]])
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*6
+                            other value       |
+    ]])
+  end)
 
-it('uses "stl" and "stlnc" fillchars even if they are the same #19803', function()
-  clear()
-  local screen = Screen.new(53, 4)
-  command('hi clear StatusLine')
-  command('hi clear StatusLineNC')
-  command('vsplit')
-  screen:expect {
-    grid = [[
-    ^                          │                          |
-    {1:~                         }│{1:~                         }|
-    [No Name]                  [No Name]                 |
-                                                         |
-  ]],
-  }
-end)
+  it('hidden moves ruler to cmdline', function()
+    -- Use long ruler to check 'ruler' with 'rulerformat' set has correct width.
+    command [[
+      set ruler rulerformat=%{winnr()}longlonglong ls=0 winwidth=10
+      split
+      wincmd b
+      vsplit
+      wincmd t
+      wincmd |
+      mode
+    ]]
+    -- Window 1 is current. It has a statusline, so cmdline should show the
+    -- last window's ruler, which has no statusline.
+    command '1wincmd w'
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*2
+      {3:[No Name]             1longlonglong     }|
+                          │                   |
+      {1:~                   }│{1:~                  }|*2
+                            3longlonglong     |
+    ]])
+    -- Window 2 is current. It has no statusline, so cmdline should show its
+    -- ruler instead.
+    command '2wincmd w'
+    screen:expect([[
+                                              |
+      {1:~                                       }|*2
+      {2:[No Name]             1longlonglong     }|
+      ^                    │                   |
+      {1:~                   }│{1:~                  }|*2
+                            2longlonglong     |
+    ]])
+    -- Window 3 is current. Cmdline should again show its ruler.
+    command '3wincmd w'
+    screen:expect([[
+                                              |
+      {1:~                                       }|*2
+      {2:[No Name]             1longlonglong     }|
+                          │^                   |
+      {1:~                   }│{1:~                  }|*2
+                            3longlonglong     |
+    ]])
+  end)
 
-it('showcmdloc=statusline works with vertical splits', function()
-  clear()
-  local screen = Screen.new(53, 4)
-  command('rightbelow vsplit')
-  command('set showcmd showcmdloc=statusline')
-  feed('1234')
-  screen:expect([[
-                              │^                          |
-    {1:~                         }│{1:~                         }|
-    {2:[No Name]                  }{3:[No Name]      1234       }|
-                                                         |
-  ]])
-  feed('<Esc>')
-  command('set laststatus=3')
-  feed('1234')
-  screen:expect([[
-                              │^                          |
-    {1:~                         }│{1:~                         }|
-    {3:[No Name]                                 1234       }|
-                                                         |
-  ]])
-end)
+  it('uses "stl" and "stlnc" fillchars even if they are the same #19803', function()
+    command('hi clear StatusLine')
+    command('hi clear StatusLineNC')
+    command('vsplit')
+    screen:expect([[
+      ^                    │                   |
+      {1:~                   }│{1:~                  }|*5
+      [No Name]            [No Name]          |
+                                              |
+    ]])
+  end)
 
-it('keymap is shown with vertical splits #27269', function()
-  clear()
-  local screen = Screen.new(53, 4)
-  command('setlocal keymap=dvorak')
-  command('rightbelow vsplit')
-  screen:expect([[
-                              │^                          |
-    {1:~                         }│{1:~                         }|
-    {2:[No Name]         <en-dv>  }{3:[No Name]         <en-dv> }|
-                                                         |
-  ]])
-  command('set laststatus=3')
-  screen:expect([[
-                              │^                          |
-    {1:~                         }│{1:~                         }|
-    {3:[No Name]                                    <en-dv> }|
-                                                         |
-  ]])
+  it('showcmdloc=statusline works with vertical splits', function()
+    command('rightbelow vsplit')
+    command('set showcmd showcmdloc=statusline')
+    feed('1234')
+    screen:expect([[
+                         │^                    |
+      {1:~                  }│{1:~                   }|*5
+      {2:[No Name]           }{3:[No Name] 1234      }|
+                                              |
+    ]])
+    feed('<Esc>')
+    command('set laststatus=3')
+    feed('1234')
+    screen:expect([[
+                         │^                    |
+      {1:~                  }│{1:~                   }|*5
+      {3:[No Name]                    1234       }|
+                                              |
+    ]])
+  end)
+
+  it('keymap is shown with vertical splits #27269', function()
+    command('setlocal keymap=dvorak')
+    command('rightbelow vsplit')
+    screen:expect([[
+                         │^                    |
+      {1:~                  }│{1:~                   }|*5
+      {2:[No Name]  <en-dv>  }{3:[No Name]   <en-dv> }|
+                                              |
+    ]])
+
+    command('set laststatus=3')
+    screen:expect([[
+                         │^                    |
+      {1:~                  }│{1:~                   }|*5
+      {3:[No Name]                       <en-dv> }|
+                                              |
+    ]])
+  end)
+
+  it("nested call from nvim_eval_statusline() doesn't overwrite items #32259", function()
+    exec_lua('vim.o.laststatus = 2')
+    exec_lua([[vim.o.statusline = '%#Special#B:%{nvim_eval_statusline("%f", []).str}']])
+    screen:expect([[
+      ^                                        |
+      {1:~                                       }|*5
+      {101:B:[No Name]                             }|
+                                              |
+    ]])
+  end)
 end)