feat: add statusline & winbar hint

Author: s1n7ax

lua/window-picker/config.lua

@@ -11,12 +11,28 @@ local config = {
 	-- following letters on them so you can use that letter to select the window
 	selection_chars = 'FJDKSLA;CMRUEIWOQP',
 
+	-- You can change the display string in status bar.
+	-- It supports '%' printf style. Such as `return char .. ': %f'` to display
+	-- buffer filepath. See :h 'stl' for details.
+	selection_display = function(char, windowid)
+		return '%=' .. char .. '%='
+	end,
+
+	-- whether you want to use winbar instead of the statusline
+	-- "always" means to always use winbar,
+	-- "never" means to never use winbar
+	-- "smart" means to use winbar if cmdheight=0 and statusline if cmdheight > 0
+	use_winbar = 'smart', -- "always" | "never" | "smart"
+
+	-- whether to show 'Pick window:' prompt
+	show_prompt = true,
+
 	-- if you want to manually filter out the windows, pass in a function that
-	-- takes two parameters. you should return window ids that should be
+	-- takes two parameters. You should return window ids that should be
 	-- included in the selection
 	-- EX:-
 	-- function(window_ids, filters)
-	--    -- filder the window_ids
+	--    -- folder the window_ids
 	--    -- return only the ones you want to include
 	--    return {1000, 1001}
 	-- end
@@ -47,6 +63,9 @@ local config = {
 		file_name_contains = {},
 	},
 
+	-- the foreground (text) color of the picker
+	fg_color = '#ededed',
+
 	-- if you have include_current_win == true, then current_win_hl_color will
 	-- be highlighted using this background color
 	current_win_hl_color = '#e35e4f',

lua/window-picker/hints/statusline-hint.lua

@@ -2,91 +2,98 @@
 ---@field window_options table<string, any> window options
 ---@field global_options table<string, any> global options
 ---@field laststatus string current value of the laststatus
+---@field chars string[] list of chars to hint
+---@field selection_display function function to customize the hint
 local M = {}
 
 function M:new()
 	local o = {
 		window_options = {},
 		global_options = {},
-		laststatus = vim.o.laststatus,
 	}
 
-	setmetatable(o, M)
+	setmetatable(o, self)
 	self.__index = self
 
 	return o
 end
 
 function M:set_config(config)
 	self.chars = config.chars
-	self.current_win_hl_color = config.current_win_hl_color
-	self.other_win_hl_color = config.other_win_hl_color
+	self.selection_display = config.selection_display
+
+	vim.api.nvim_set_hl(0, 'WindowPickerStatusLine', {
+		fg = '#ededed',
+		bg = config.current_win_hl_color,
+		bold = true,
+	})
+
+	vim.api.nvim_set_hl(0, 'WindowPickerStatusLineNC', {
+		fg = '#ededed',
+		bg = config.other_win_hl_color,
+		bold = true,
+	})
 end
 
--- M:_set_highlight_groups sets highlight groups
--- @param { any } config passes colors
-function M:_set_highlight_groups()
-	vim.cmd(
-		'highlight NvimWindoSwitch gui=bold guifg=#ededed guibg='
-			.. self.current_win_hl_color
-	)
-	vim.cmd(
-		'highlight NvimWindoSwitchNC gui=bold guifg=#ededed guibg='
-			.. self.other_win_hl_color
-	)
-end
+--- M:_save_window_options saves the initial window options later will be changed
+--- @param windows number[]
+function M:save_window_options(windows, win_opt_to_cap)
+	self.window_options = {}
 
--- M:_save_window_options saves the initial window options later will be changed
--- @param { Array<number> } window_ids list of window IDs
-function M:_save_window_options(windows)
 	for _, window in ipairs(windows) do
-		self.window_options[window] = {
-			statusline = vim.wo[window].statusline,
-			winhl = vim.wo[window].winhl,
-		}
-	end
+		self.window_options[window] = {}
 
-	self.global_options['cmdheight'] = vim.o.cmdheight
+		for _, opt_key in ipairs(win_opt_to_cap) do
+			self.window_options[window][opt_key] = vim.wo[window][opt_key]
+		end
+	end
 end
 
--- M:print shows the characters in status line
--- @param { table } data window-letter mapping to show on status line
+--- Shows the characters in status line
+--- @param windows number[] windows to draw the hints on
 function M:draw(windows)
-	self:_save_window_options(windows)
-	self:_set_highlight_groups()
+	local win_opt_to_cap = { 'statusline', 'winhl' }
+
+	if vim.o.cmdheight < 1 then
+		self.global_options['cmdheight'] = vim.o['cmdheight']
+		vim.o.cmdheight = 1
+	end
+
+	if vim.o.laststatus ~= 2 then
+		self.global_options['laststatus'] = vim.o['laststatus']
+		vim.o.laststatus = 2
+	end
 
-	-- make sure every window has status line
-	vim.o.laststatus = 2
+	self:save_window_options(windows, win_opt_to_cap)
 
 	for index, window in ipairs(windows) do
 		local char = self.chars[index]
-		vim.wo[window].statusline = '%=' .. char .. '%='
-		vim.wo[window].winhl =
-			'StatusLine:NvimWindoSwitch,StatusLineNC:NvimWindoSwitchNC'
-	end
 
-	if self.global_options.cmdheight == 0 then
-		vim.o.cmdheight = 1
+		vim.wo[window].statusline = self.selection_display
+				and self.selection_display(char, window)
+			or '%=' .. char .. '%='
+
+		vim.wo[window].winhl =
+			'StatusLine:WindowPickerStatusLine,StatusLineNC:WindowPickerStatusLineNC'
 	end
 
-	vim.cmd('redraw')
+	vim.cmd.redraw()
 end
 
--- M:clear the screen after print
+--- clear the screen after print
 function M:clear()
-	vim.o.laststatus = self.laststatus
-
 	for window, options in pairs(self.window_options) do
 		for opt_key, opt_value in pairs(options) do
 			vim.wo[window][opt_key] = opt_value
 		end
 	end
 
-	self.window_options = {}
-
 	for key, value in pairs(self.global_options) do
 		vim.o[key] = value
 	end
+
+	self.window_options = {}
+	self.global_options = {}
 end
 
 return M

lua/window-picker/hints/statusline-winbar-hint.lua

@@ -0,0 +1,92 @@
+local StatuslineHint = require('window-picker.hints.statusline-hint')
+
+---@class StatuslineWinbarHint
+---@field window_options table<string, any> window options
+---@field global_options table<string, any> global options
+---@field chars string[] list of chars to hint
+---@field selection_display function function to customize the hint
+local M = StatuslineHint:new()
+
+function M:set_config(config)
+	self.chars = config.chars
+	self.selection_display = config.selection_display
+	self.use_winbar = config.use_winbar
+	self.show_prompt = config.show_prompt
+
+	vim.api.nvim_set_hl(0, 'WindowPickerStatusLine', {
+		fg = '#ededed',
+		bg = config.current_win_hl_color,
+		bold = true,
+	})
+
+	vim.api.nvim_set_hl(0, 'WindowPickerStatusLineNC', {
+		fg = '#ededed',
+		bg = config.other_win_hl_color,
+		bold = true,
+	})
+
+	vim.api.nvim_set_hl(0, 'WindowPickerWinBar', {
+		fg = '#ededed',
+		bg = config.current_win_hl_color,
+		bold = true,
+	})
+
+	vim.api.nvim_set_hl(0, 'WindowPickerWinBarNC', {
+		fg = '#ededed',
+		bg = config.other_win_hl_color,
+		bold = true,
+	})
+end
+
+--- Shows the characters in status line
+--- @param windows number[] windows to draw the hints on
+function M:draw(windows)
+	local use_winbar = false
+
+	-- calculate if we should use winbar or not
+	if self.use_winbar == 'always' then
+		use_winbar = true
+	elseif self.use_winbar == 'never' then
+		use_winbar = false
+	elseif self.use_winbar == 'smart' then
+		use_winbar = vim.o.cmdheight == 0
+	end
+
+	local indicator_setting = use_winbar and 'winbar' or 'statusline'
+	local indicator_hl = use_winbar and 'WinBar' or 'StatusLine'
+
+	if not use_winbar then
+		if vim.o.laststatus ~= 2 then
+			self.global_options['laststatus'] = vim.o['laststatus']
+			vim.o.laststatus = 2
+		end
+
+		if self.show_prompt and vim.o.cmdheight < 1 then
+			self.global_options['cmdheight'] = vim.o['cmdheight']
+			vim.o.cmdheight = 1
+		end
+	end
+
+	local win_opt_to_cap = { indicator_setting, 'winhl' }
+	self:save_window_options(windows, win_opt_to_cap)
+
+	for index, window in ipairs(windows) do
+		local char = self.chars[index]
+
+		vim.wo[window][indicator_setting] = self.selection_display
+				and self.selection_display(char, window)
+			or '%=' .. char .. '%='
+
+		vim.wo[window].winhl = string.format(
+			'%s:WindowPicker%s,%sNC:WindowPicker%sNC',
+			indicator_hl,
+			indicator_hl,
+			indicator_hl,
+			indicator_hl
+		)
+	end
+
+	vim.cmd.redraw()
+end
+
+return M