Float window always use relative="editor" even I set relative to "cursor"/"win" in winopts?

[linrongbin16]

I want to configure the floating window looks like glance.nvim plugin, when using fzf-lua LSP goto commands. I configured it with:

local function get_cursor_winopts()
  local winnr = vim.api.nvim_get_current_win()
  local win_first_lineno = vim.fn.line("w0")
  local win_height = vim.api.nvim_win_get_height(winnr)
  -- local win_width = vim.api.nvim_win_get_width(winnr)
  local border = constants.window.border

  local height = vim.fn.max({ 5, math.floor(win_height * 0.4) })
  local width = 1.0

  local cursor_pos = vim.api.nvim_win_get_cursor(winnr)
  local cursor_row = vim.fn.max({ 2, cursor_pos[1] - win_first_lineno + 1 })
  -- local cursor_col = cursor_pos[2]
  local cursor_col = 0.0

  local row = 1
  local col = 0

  local expected_end_row = cursor_row + height
  local expected_reversed_cursor_row = cursor_row - 1 - height
  if expected_end_row > win_height and expected_reversed_cursor_row >= 1 then
    -- cursor_row = expected_reversed_cursor_row
    row = -height
  end

  local result = {
    height = height,
    width = width,
    row = row,
    col = col,
    border = "none",
    relative = "cursor",
    win = winnr,
    style = "minimal",
    preview = {
      default = "bat",
      border = border,
      horizontal = "left:66%",
    },
  }
  -- print(string.format("3-res:%s", vim.inspect(result)))
  return result
end


  vim.keymap.set("n", "gd", function()
    require("fzf-lua").lsp_definitions({
      winopts = get_cursor_winopts(),
      prompt = "Definitions> ",
    })
  end, { desc = "Go to definitions" })
  vim.keymap.set("n", "gr", function()
    require("fzf-lua").lsp_references({
      winopts = get_cursor_winopts(),
      prompt = "References> ",
    })
  end, { desc = "Go to references" })
  vim.keymap.set("n", "gt", function()
    require("fzf-lua").lsp_typedefs({
      winopts = get_cursor_winopts(),
      prompt = "Type Definitions> ",
    })
  end, { desc = "Go to type definitions" })
  vim.keymap.set("n", "gi", function()
    require("fzf-lua").lsp_implementations({
      winopts = get_cursor_winopts(),
      prompt = "Implementations> ",
    })
  end, { desc = "Go to implementations" })

And now it looks:

But I want to make the floating window just inside the "current window" where my cursor is inside. Here is the look of glance.nvim:

[ibhagwan]

You can do that in two ways:

1. Use winopts.split with a split command that opens always inside the current win
2. If you insist on float you can return integers instead of fractions in row/col/height/width for absolute position/size without the neovim window

[linrongbin16]

Thank you, I will have a try

[linrongbin16]

Share my "glance.nvim" style lsp goto configurations here, incase people also want it:

local function clamp(v, min_val, max_val)
  local res = v
  if max_val ~= nil then
    res = vim.fn.min({ res, max_val })
  end
  if min_val ~= nil then
    res = vim.fn.max({ res, min_val })
  end
  return res
end

local function get_cursor_winopts()
  local winnr = vim.api.nvim_get_current_win()
  local win_first_lineno = vim.fn.line("w0")
  local win_height = vim.api.nvim_win_get_height(winnr)
  local win_width = vim.api.nvim_win_get_width(winnr)
  local win_pos = vim.api.nvim_win_get_position(winnr)
  -- local win_y = win_pos[1]
  local win_x = win_pos[2]
  local border = constants.window.border

  local height = clamp(win_height, 3, 18)
  local width = win_width

  local cursor_pos = vim.api.nvim_win_get_cursor(winnr)
  local cursor_row = clamp(cursor_pos[1] - win_first_lineno + 2, 2)
  -- local cursor_col = cursor_pos[2]
  local cursor_col = win_x

  local expected_end_row = cursor_row + height
  local expected_reversed_cursor_row = cursor_row - 1 - height
  if expected_end_row > win_height and expected_reversed_cursor_row >= 1 then
    cursor_row = expected_reversed_cursor_row
  end

  local result = {
    height = height,
    width = width,
    row = cursor_row,
    col = cursor_col,
    border = "none",
    win = winnr,
    style = "minimal",
    preview = {
      default = "bat",
      border = border,
      horizontal = "left:66%",
    },
  }
  -- print(string.format("3-res:%s", vim.inspect(result)))
  return result
end

vim.keymap.set("n", "gd", function()
  require("fzf-lua").lsp_definitions({
    winopts = get_cursor_winopts(),
    prompt = "Definitions> ",
  })
end, { desc = "Go to definitions" })

Demo:

lsp-goto-demo.mp4

[linrongbin16]

One more thing that can be improved is: the vim.api.nvim_win_get_cursor(window_id) API is based on buffer's lines/columns (rows/columns), not window's X/Y coordinates. This can lead to wrong row/col calculation if a line is too long and it is wrapped into 2 rows in the window, and thus the floating window's position can be wrong (offset by 1 or even 2 lines).

[ibhagwan]

Looks very nice @linrongbin16!

One more thing that can be improved is: the vim.api.nvim_win_get_cursor(window_id) API is based on buffer's lines/columns (rows/columns), not window's X/Y coordinates. This can lead to wrong row/col calculation if a line is too long and it is wrapped into 2 rows in the window, and thus the floating window's position can be wrong (offset by 1 or even 2 lines).

What about any of the ‘vim.fn.XXXpos` functions?

[linrongbin16]

will take a look