aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/termcap.lua
blob: 862cc5214986b0c1d856eeaedbd662d4a5a07901 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
local M = {}

--- Query the host terminal emulator for terminfo capabilities.
---
--- This function sends the XTGETTCAP DCS sequence to the host terminal emulator asking the terminal
--- to send us its terminal capabilities. These are strings that are normally taken from a terminfo
--- file, however an up to date terminfo database is not always available (particularly on remote
--- machines), and many terminals continue to misidentify themselves or do not provide their own
--- terminfo file, making the terminfo database unreliable.
---
--- Querying the terminal guarantees that we get a truthful answer, but only if the host terminal
--- emulator supports the XTGETTCAP sequence.
---
--- @param caps string|table A terminal capability or list of capabilities to query
--- @param cb function(cap:string, seq:string) Function to call when a response is received
function M.query(caps, cb)
  vim.validate({
    caps = { caps, { 'string', 'table' } },
    cb = { cb, 'f' },
  })

  if type(caps) ~= 'table' then
    caps = { caps }
  end

  local count = #caps

  vim.api.nvim_create_autocmd('TermResponse', {
    callback = function(args)
      local resp = args.data ---@type string
      local k, v = resp:match('^\027P1%+r(%x+)=(%x+)$')
      if k and v then
        local cap = vim.text.hexdecode(k)
        local seq =
          vim.text.hexdecode(v):gsub('\\E', '\027'):gsub('%%p%d', ''):gsub('\\(%d+)', string.char)

        cb(cap, seq)

        count = count - 1
        if count == 0 then
          return true
        end
      end
    end,
  })

  local encoded = {} ---@type string[]
  for i = 1, #caps do
    encoded[i] = vim.text.hexencode(caps[i])
  end

  local query = string.format('\027P+q%s\027\\', table.concat(encoded, ';'))

  -- If running in tmux, wrap with the passthrough sequence
  if os.getenv('TMUX') then
    query = string.format('\027Ptmux;%s\027\\', query:gsub('\027', '\027\027'))
  end

  io.stdout:write(query)
end

return M