* feat: completion menu borders (#472)
* feat(custom_entries_view): pass custom border option
* feat(window): calculate offset needed for borders
* fix(window): adjust window height w/ too many results
* fix(window): center scrollbar with borders
* ref(custom_entries_view): use `FloatBorder` for borders
* fix(window): offset at bottom of window
* ref(window): move height adjustment to more logical place
* fix(window): improve popup placement
* fix(window): `border_offset` always `0` first time
* feat(window): support compact scrollbar with border
* fix(window): completion popup on cursorline
* perf(window): simplify offset calculation
String indexing will result in the same thing as if I gated it behind
`type()` calls here.
* docs(window): add `border` to `cmp.WindowStyle`
* docs(window): correct `border_offset_scrollbar`
* perf(window): calulated row -> `screenrow`
This will also be more accurate since it accounts for wrapped lines, as
well as buffers.
* fix(window): edge case with multiple splits
* ref(winhighlight): don't specify defaults by default
`NormalFloat:NormalFloat` isn't needed, since `NormalFloat` defaults to
`NormalFloat`. As for `FloatBorder`, that should be set to `Floatborder`
rather than `NormalFloat` or else you get unintended artifacts on the
edges of borders.
* fix(window): popup covers cursor when scrollbar disappears
* ref(window): calc `border_offset_col` on `set_style`
* perf(window): remove unecessary `col` calculation
Taking it out didn't change anything about the popup behavior.
* feat: add `CmpItemMenuThumb` group
* feat(window): improve scrollbar appearance
* chore(window): remove references to unused property
* docs: document new option `thin_scrollbar`
* ref(plugin): remove background from `thin_scrollbar`
* feat(view): pass `thin_scrollbar` option to window
* feat(window): gate new `thin_scrollbar` behind option
* fix(window): cmdline bugging out
* fix(cmp): docs_view pops up overlapped when using borders
This is related to 1cfe2f7dfd. The
calculation for how the popup position is calculated was changed, and
so it needed to be reworked to include borders in order to be able to
work.
* ref: `thin_scrollbar` flag -> `scrollbar` option
This change allows users to define which character they will use for
their scrollbar.
* fix(window): use `scrollbar` setting for scrollbar character
Thanks @Astrantia for pointing this one out.
* docs(README): add completion appearance options to FAQ
* fix(): account for `border_offset_row` with `has_bottom_space`
* style(custom_entries_view): group offset with `row`/`col`
* fix(window): scrollbar at full view height
Because the `bar_height` variable must be whole number, and must be rounded up
from a percent, there is a change that we will end up with the maximum
height as a number.
For example, `info.height` = 24 and `total` = 25.
* feat(window): allow scrollbar to be disabled
* fix(window): scrollbar size < 1
* ref(cmp): move border logic to `window.info`
* ref!: window highlighting based on borders
BREAKING CHANGE: `documentation.winhighlight` does not determine the
highlighting of the `documentation` view— `CmpWindow`
or `CmpBorderedWindow` depending on whether it has a
border.
* ref!: float appearance opts -> `cmp.setup.window`
`cmp.setup.completion.border` and `.scrollbar` were both moved to
`cmp.setup.window.completion.border` and `.scrollbar`
BREAKING CHANGE: `cmp.setup.documentation` has been moved to
`cmp.window.documentation`, as all of the pertaining
options were cosmetic.
TODO: document the change
* fix(window): attempt to get scrollbar's border
* fix(cmp): restore `view.menu.hl_group`
* fix(window): wrong scrollbar position
* ref: get default `CmpItemMenu` from border existence
* chore(cmp): remove old PR comments
* fix(window): scrollbar sometimes too big
* fix(window): docs far away with complete menu scrollbar
* perf(docs_view): reuse `border_width` value
* rev(cmp): restore `CmpItemMenu`
* ref(cmp): distinguish between `ScrollBar` and `ScrollThumb`
* fix(plugin): consistently refer to `Thumb` as `Thumb`
* rev(window): `Pmenu`-style scrollbar when no border
* fix(window): docs_view size wrong when first shown
* fix(window): docs_view scrollbar not responding to size
* fix(window): scrollbar sometimes to small, take 2
* fix(window): scrollbar bg not hiding
* ref(docs_view): put docs closer to completion menu
* fix(window): scrollbar position wrong with right border
* ref(config): add default border to documentation
* fix(window): scrollbar too close without border
* ref(plugin): link `CmpWindow` to `Pmenu`
I set `CmpWindow` to `NormalFloat`, because that is what you would
expect a floating window to use for a highlight group. However at
request I changed it to `Pmenu`.
* ref(plugin): link `CmpWindowBorder` to `CmpWindow`
* fix(window): scrollbar following thumb while scrolling
* ref: add more highlight groups
There just weren't enough highlight groups to satisfy the demands of the
project. If you change `CmpWindow` to `Pmenu`, then the `docs_view`
becomes `Pmenu` as well when on `main` it is `NormalFloat`.
* fix(window): scrollbar overlapping `docs_view` by default
* ref: remove `Bordered` highlight variants
* ref(utils): extract whitespace check to func
* feat: `window.completion.zindex` setting
* ref: `maxwidth|height` -> `max_`
* ref: simplify highlight groups
* feat: `window.*.winhighlight` setting
* ref(utils): `is_whitespace_char` -> `is_visible`
As hrsh7th noted, `''` is not a whitespace character. Yet, it is
necessary to group `''` and `' '` together for certain border behaviors
that are based on visibility. Thus I have renamed the function
* feat: specify `window.*.winhighlight` for un/bordered
* fix(custom_entries_view): set `winhighlight` on `open`
* ref: remove `Cmp*Scroll*` variants
There's no way for `window` to know which kind of window it is drawing a
scrollbar on. Simpler to just have one kind of scrollbar
* feat: distinguish between bordered and unbordered
* ref(cmp): `is_visible` -> `is_invisible`
That's what the function was checking for.
* fix(default): mislabeling of `default` and `bordered`
* chore: rebase fixup
* Change default highlight
* Add misc.rep
* Fix left-side docs_view with scrollbar
* Fix scrollbar
* Fix sbar/thumb win
Improve highlights
* Remove scrollbar cutomization for now
* Remove scrollbar option
* Simplify implementation
* Fix doc width
* Fix outdated docs
* Add comments
* Fix configuration schema
* fmt
* Fix for lint
Co-authored-by: Iron-E <36409591+Iron-E@users.noreply.github.com>
Co-authored-by: hrsh7th <>
254 lines
4.9 KiB
Lua
254 lines
4.9 KiB
Lua
local misc = {}
|
|
|
|
---Create once callback
|
|
---@param callback function
|
|
---@return function
|
|
misc.once = function(callback)
|
|
local done = false
|
|
return function(...)
|
|
if done then
|
|
return
|
|
end
|
|
done = true
|
|
callback(...)
|
|
end
|
|
end
|
|
|
|
---Return concatenated list
|
|
---@param list1 any[]
|
|
---@param list2 any[]
|
|
---@return any[]
|
|
misc.concat = function(list1, list2)
|
|
local new_list = {}
|
|
for _, v in ipairs(list1) do
|
|
table.insert(new_list, v)
|
|
end
|
|
for _, v in ipairs(list2) do
|
|
table.insert(new_list, v)
|
|
end
|
|
return new_list
|
|
end
|
|
|
|
---Repeat values
|
|
---@generic T
|
|
---@param str_or_tbl T
|
|
---@param count number
|
|
---@return T
|
|
misc.rep = function(str_or_tbl, count)
|
|
if type(str_or_tbl) == 'string' then
|
|
return string.rep(str_or_tbl, count)
|
|
end
|
|
local rep = {}
|
|
for _ = 1, count do
|
|
for _, v in ipairs(str_or_tbl) do
|
|
table.insert(rep, v)
|
|
end
|
|
end
|
|
return rep
|
|
end
|
|
|
|
---Return the valu is empty or not.
|
|
---@param v any
|
|
---@return boolean
|
|
misc.empty = function(v)
|
|
if not v then
|
|
return true
|
|
end
|
|
if v == vim.NIL then
|
|
return true
|
|
end
|
|
if type(v) == 'string' and v == '' then
|
|
return true
|
|
end
|
|
if type(v) == 'table' and vim.tbl_isempty(v) then
|
|
return true
|
|
end
|
|
if type(v) == 'number' and v == 0 then
|
|
return true
|
|
end
|
|
return false
|
|
end
|
|
|
|
---The symbol to remove key in misc.merge.
|
|
misc.none = vim.NIL
|
|
|
|
---Merge two tables recursively
|
|
---@generic T
|
|
---@param v1 T
|
|
---@param v2 T
|
|
---@return T
|
|
misc.merge = function(v1, v2)
|
|
local merge1 = type(v1) == 'table' and (not vim.tbl_islist(v1) or vim.tbl_isempty(v1))
|
|
local merge2 = type(v2) == 'table' and (not vim.tbl_islist(v2) or vim.tbl_isempty(v2))
|
|
if merge1 and merge2 then
|
|
local new_tbl = {}
|
|
for k, v in pairs(v2) do
|
|
new_tbl[k] = misc.merge(v1[k], v)
|
|
end
|
|
for k, v in pairs(v1) do
|
|
if v2[k] == nil and v ~= misc.none then
|
|
new_tbl[k] = v
|
|
end
|
|
end
|
|
return new_tbl
|
|
end
|
|
if v1 == misc.none then
|
|
return nil
|
|
end
|
|
if v1 == nil then
|
|
if v2 == misc.none then
|
|
return nil
|
|
else
|
|
return v2
|
|
end
|
|
end
|
|
if v1 == true then
|
|
if merge2 then
|
|
return v2
|
|
end
|
|
return {}
|
|
end
|
|
|
|
return v1
|
|
end
|
|
|
|
---Generate id for group name
|
|
misc.id = setmetatable({
|
|
group = {},
|
|
}, {
|
|
__call = function(_, group)
|
|
misc.id.group[group] = misc.id.group[group] or 0
|
|
misc.id.group[group] = misc.id.group[group] + 1
|
|
return misc.id.group[group]
|
|
end,
|
|
})
|
|
|
|
---Check the value is nil or not.
|
|
---@param v boolean
|
|
---@return boolean
|
|
misc.safe = function(v)
|
|
if v == nil or v == vim.NIL then
|
|
return nil
|
|
end
|
|
return v
|
|
end
|
|
|
|
---Treat 1/0 as bool value
|
|
---@param v boolean|"1"|"0"
|
|
---@param def boolean
|
|
---@return boolean
|
|
misc.bool = function(v, def)
|
|
if misc.safe(v) == nil then
|
|
return def
|
|
end
|
|
return v == true or v == 1
|
|
end
|
|
|
|
---Set value to deep object
|
|
---@param t table
|
|
---@param keys string[]
|
|
---@param v any
|
|
misc.set = function(t, keys, v)
|
|
local c = t
|
|
for i = 1, #keys - 1 do
|
|
local key = keys[i]
|
|
c[key] = misc.safe(c[key]) or {}
|
|
c = c[key]
|
|
end
|
|
c[keys[#keys]] = v
|
|
end
|
|
|
|
---Copy table
|
|
---@generic T
|
|
---@param tbl T
|
|
---@return T
|
|
misc.copy = function(tbl)
|
|
if type(tbl) ~= 'table' then
|
|
return tbl
|
|
end
|
|
|
|
if vim.tbl_islist(tbl) then
|
|
local copy = {}
|
|
for i, value in ipairs(tbl) do
|
|
copy[i] = misc.copy(value)
|
|
end
|
|
return copy
|
|
end
|
|
|
|
local copy = {}
|
|
for key, value in pairs(tbl) do
|
|
copy[key] = misc.copy(value)
|
|
end
|
|
return copy
|
|
end
|
|
|
|
---Safe version of vim.str_utfindex
|
|
---@param text string
|
|
---@param vimindex number|nil
|
|
---@return number
|
|
misc.to_utfindex = function(text, vimindex)
|
|
vimindex = vimindex or #text + 1
|
|
return vim.str_utfindex(text, math.max(0, math.min(vimindex - 1, #text)))
|
|
end
|
|
|
|
---Safe version of vim.str_byteindex
|
|
---@param text string
|
|
---@param utfindex number
|
|
---@return number
|
|
misc.to_vimindex = function(text, utfindex)
|
|
utfindex = utfindex or #text
|
|
for i = utfindex, 1, -1 do
|
|
local s, v = pcall(function()
|
|
return vim.str_byteindex(text, i) + 1
|
|
end)
|
|
if s then
|
|
return v
|
|
end
|
|
end
|
|
return utfindex + 1
|
|
end
|
|
|
|
---Mark the function as deprecated
|
|
misc.deprecated = function(fn, msg)
|
|
local printed = false
|
|
return function(...)
|
|
if not printed then
|
|
print(msg)
|
|
printed = true
|
|
end
|
|
return fn(...)
|
|
end
|
|
end
|
|
|
|
--Redraw
|
|
misc.redraw = setmetatable({
|
|
doing = false,
|
|
force = false,
|
|
termcode = vim.api.nvim_replace_termcodes('<C-r><Esc>', true, true, true),
|
|
}, {
|
|
__call = function(self, force)
|
|
if vim.tbl_contains({ '/', '?' }, vim.fn.getcmdtype()) then
|
|
if vim.o.incsearch then
|
|
return vim.api.nvim_feedkeys(self.termcode, 'in', true)
|
|
end
|
|
end
|
|
|
|
if self.doing then
|
|
return
|
|
end
|
|
self.doing = true
|
|
self.force = not not force
|
|
vim.schedule(function()
|
|
if self.force then
|
|
vim.cmd([[redraw!]])
|
|
else
|
|
vim.cmd([[redraw]])
|
|
end
|
|
self.doing = false
|
|
self.force = false
|
|
end)
|
|
end,
|
|
})
|
|
|
|
return misc
|