Trans.nvim/lua/Trans/core/buffer.lua

local api, fn = vim.api, vim.fn

---@class TransBuffer
---@field bufnr integer buffer handle
---@field [integer] string|TransNode|TransNode[] buffer[line] content
local buffer = {}

-- INFO : corountine can't invoke C function
---Clear all content in buffer
function buffer:wipe()
    api.nvim_buf_set_lines(self.bufnr, 0, -1, false, {})
end

---Delete buffer [_start, _end] line content [one index]
---@param _start? integer start line index
---@param _end? integer end line index
function buffer:deleteline(_start, _end)
    ---@diagnostic disable-next-line: cast-local-type
    _start = _start and _start - 1 or self:line_count() - 1
    _end = _end or _start + 1 -- because of end exclusive
    api.nvim_buf_set_lines(self.bufnr, _start, _end, false, {})
end

---Set buffer option
---@param name string option name
---@param value any option value
function buffer:set(name, value)
    api.nvim_buf_set_option(self.bufnr, name, value)
end

---Get buffer option
---@param name string option name
---@return any
function buffer:option(name)
    return api.nvim_buf_get_option(self.bufnr, name)
end

---Destory buffer
function buffer:destroy()
    pcall(api.nvim_buf_delete, self.bufnr, { force = true })
end

---Set buffer load keymap
---@param key string
---@param operation function | string
function buffer:map(key, operation)
    vim.keymap.set('n', key, operation, {
        buffer = self.bufnr,
        silent = true,
    })
end

---Execute keycode in normal this buffer[no recursive]
---@param key string key code
function buffer:normal(key)
    api.nvim_buf_call(self.bufnr, function()
        vim.cmd([[normal! ]] .. key)
    end)
end

---@nodiscard
---@return boolean
function buffer:is_valid()
    return api.nvim_buf_is_valid(self.bufnr)
end

---Get buffer [i, j] line content
---@param i integer? start line index
---@param j integer? end line index
---@return string[]
function buffer:lines(i, j)
    i = i and i - 1 or 0
    j = j or -1 -- because of end exclusive
    return api.nvim_buf_get_lines(self.bufnr, i, j, false)
end

---Add highlight to buffer
---@param linenr number line number should be set[one index]
---@param hl_group string highlight group
---@param col_start? number column start [zero index]
---@param col_end? number column end
---@param ns number? highlight namespace
function buffer:add_highlight(linenr, hl_group, col_start, col_end, ns)
    -- vim.print(linenr, hl_group, col_start, col_end, ns)
    linenr = linenr - 1
    col_start = col_start or 0
    api.nvim_buf_add_highlight(self.bufnr, ns or -1, hl_group, linenr, col_start, col_end or -1)
end

---Get buffer line count
---@return integer
function buffer:line_count()
    local line_count = api.nvim_buf_line_count(self.bufnr)
    return line_count == 1 and self[1] == '' and 0 or line_count
end

---Set line content
---@param nodes string|table|table[] string -> as line content | table -> as a node | table[] -> as node[]
---@param one_index number? line number should be set[one index] or let it be nil to append
function buffer:setline(nodes, one_index)
    local append_line_index = self:line_count() + 1
    one_index = one_index or append_line_index
    if one_index > append_line_index then
        for i = append_line_index, one_index - 1 do
            self:setline('', i)
        end
    end


    if type(nodes) == 'string' then
        fn.setbufline(self.bufnr, one_index, nodes)
        return
    end

    if type(nodes[1]) == 'string' then
        ---@diagnostic disable-next-line: assign-type-mismatch, param-type-mismatch
        fn.setbufline(self.bufnr, one_index, nodes[1])
        nodes:render(self, one_index, 0)
        return
    end


    local strs = {}
    local num = #nodes
    for i = 1, num do
        strs[i] = nodes[i][1]
    end

    fn.setbufline(self.bufnr, one_index, table.concat(strs))
    local col = 0
    for i = 1, num do
        local node = nodes[i]
        node:render(self, one_index, col)
        col = col + #node[1]
    end
end

buffer.__index = function(self, key)
    local res = buffer[key]
    if res then
        return res
    elseif type(key) == 'number' then
        -- return fn.getbufoneline(self.bufnr, key) -- Vimscript Function Or Lua API ?? -- INFO :only work on neovim-nightly
        return api.nvim_buf_get_lines(self.bufnr, key - 1, key, true)[1]
    else
        error('invalid key: ' .. key)
    end
end

buffer.__newindex = function(self, key, values)
    if type(key) == 'number' then
        self:setline(values, key)
    else
        rawset(self, key, values)
    end
end

---Init buffer with bufnr
---@param bufnr? integer buffer handle
function buffer:init(bufnr)
    self.bufnr = bufnr or api.nvim_create_buf(false, false)
    self:set('filetype', 'Trans')
    self:set('buftype', 'nofile')
end

---@nodiscard
---TransBuffer constructor
---@param bufnr? integer buffer handle
---@return TransBuffer
function buffer.new(bufnr)
    local new_buf = setmetatable({}, buffer)
    new_buf:init(bufnr)
    return new_buf
end

--- HACK :available options:
--- - id
--- - end_row
--- - end_col
--- - hl_eol
--- - virt_text
--- - virt_text_pos
--- - virt_text_win_col
--- - hl_mode
--- - virt_lines
--- - virt_lines_above
--- - virt_lines_leftcol
--- - ephemeral
--- - right_gravity
--- - end_right_gravity
--- - priority
--- - strict
--- - sign_text
--- - sign_hl_group
--- - number_hl_group
--- - line_hl_group
--- - cursorline_hl_group
--- - conceal
--- - ui_watched

---Add Extmark to buffer
---@param ns number highlight namespace
---@param linenr number line number should be set[one index]
---@param col_start number column start
function buffer:set_extmark(ns, linenr, col_start, opts)
    linenr = linenr and linenr - 1 or -1
    return api.nvim_buf_set_extmark(self.bufnr, ns, linenr, col_start, opts)
end

---@class Trans
---@field buffer TransBuffer
return buffer