Meh I'll figure out submodules later
This commit is contained in:
mustard
parent
4ca9d44a90
commit
8cb281f436
352 changed files with 66107 additions and 0 deletions
141
.config/nvim/pack/tree/start/nui.nvim/lua/nui/text/README.md
Normal file
141
.config/nvim/pack/tree/start/nui.nvim/lua/nui/text/README.md
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
# NuiText
|
||||
|
||||
NuiText is an abstraction layer on top of the following native functions:
|
||||
|
||||
- `vim.api.nvim_buf_set_text` (check `:h nvim_buf_set_text()`)
|
||||
- `vim.api.nvim_buf_set_extmark` (check `:h nvim_buf_set_extmark()`)
|
||||
|
||||
It helps you set text and add highlight for it on the buffer.
|
||||
|
||||
_Signature:_ `NuiText(content, extmark?)`
|
||||
|
||||
**Examples**
|
||||
|
||||
```lua
|
||||
local NuiText = require("nui.text")
|
||||
|
||||
local text = NuiText("Something Went Wrong!", "Error")
|
||||
|
||||
local bufnr, ns_id, linenr_start, byte_start = 0, -1, 1, 0
|
||||
|
||||
text:render(bufnr, ns_id, linenr_start, byte_start)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### `content`
|
||||
|
||||
**Type:** `string` or `table`
|
||||
|
||||
Text content or `NuiText` object.
|
||||
|
||||
If `NuiText` object is passed, a copy of it is created.
|
||||
|
||||
### `extmark`
|
||||
|
||||
**Type:** `string` or `table`
|
||||
|
||||
Highlight group name or extmark options.
|
||||
|
||||
If a `string` is passed, it is used as the highlight group name.
|
||||
|
||||
If a `table` is passed it is used as extmark data. It can have the
|
||||
following keys:
|
||||
|
||||
| Key | Description |
|
||||
| ------------ | -------------------- |
|
||||
| `"hl_group"` | highlight group name |
|
||||
|
||||
For more, check `:help nvim_buf_set_extmark()`.
|
||||
|
||||
## Methods
|
||||
|
||||
### `text:set`
|
||||
|
||||
_Signature:_ `text:set(content, extmark?)`
|
||||
|
||||
Sets the text content and highlight information.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --------- | ------------------- | --------------------------------------- |
|
||||
| `content` | `string` | text content |
|
||||
| `extmark` | `string` or `table` | highlight group name or extmark options |
|
||||
|
||||
This `extmark` parameter is exactly the same as `NuiText`'s `extmark` parameter.
|
||||
|
||||
### `text:content`
|
||||
|
||||
_Signature:_ `text:content()`
|
||||
|
||||
Returns the text content.
|
||||
|
||||
### `text:length`
|
||||
|
||||
_Signature:_ `text:length()`
|
||||
|
||||
Returns the byte length of the text.
|
||||
|
||||
### `text:width`
|
||||
|
||||
_Signature:_ `text:width()`
|
||||
|
||||
Returns the character length of the text.
|
||||
|
||||
### `text:highlight`
|
||||
|
||||
_Signature:_ `text:highlight(bufnr, ns_id, linenr, byte_start)`
|
||||
|
||||
Applies highlight for the text.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ------------ | -------- | -------------------------------------------------- |
|
||||
| `bufnr` | `number` | buffer number |
|
||||
| `ns_id` | `number` | namespace id (use `-1` for fallback namespace) |
|
||||
| `linenr` | `number` | line number (1-indexed) |
|
||||
| `byte_start` | `number` | start position of the text on the line (0-indexed) |
|
||||
|
||||
### `text:render`
|
||||
|
||||
_Signature:_ `text:render(bufnr, ns_id, linenr_start, byte_start, linenr_end?, byte_end?)`
|
||||
|
||||
Sets the text on buffer and applies highlight.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| -------------- | -------- | -------------------------------------------------- |
|
||||
| `bufnr` | `number` | buffer number |
|
||||
| `ns_id` | `number` | namespace id (use `-1` for fallback namespace) |
|
||||
| `linenr_start` | `number` | start line number (1-indexed) |
|
||||
| `byte_start` | `number` | start position of the text on the line (0-indexed) |
|
||||
| `linenr_end` | `number` | end line number (1-indexed) |
|
||||
| `byte_end` | `number` | end position of the text on the line (0-indexed) |
|
||||
|
||||
### `text:render_char`
|
||||
|
||||
_Signature:_ `text:render_char(bufnr, ns_id, linenr_start, char_start, linenr_end?, char_end?)`
|
||||
|
||||
Sets the text on buffer and applies highlight.
|
||||
|
||||
This does the thing as `text:render` method, but you can use character count
|
||||
instead of byte count. It will convert multibyte character count to appropriate
|
||||
byte count for you.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| -------------- | -------- | -------------------------------------------------- |
|
||||
| `bufnr` | `number` | buffer number |
|
||||
| `ns_id` | `number` | namespace id (use `-1` for fallback namespace) |
|
||||
| `linenr_start` | `number` | start line number (1-indexed) |
|
||||
| `char_start` | `number` | start position of the text on the line (0-indexed) |
|
||||
| `linenr_end` | `number` | end line number (1-indexed) |
|
||||
| `char_end` | `number` | end position of the text on the line (0-indexed) |
|
||||
|
||||
## Wiki Page
|
||||
|
||||
You can find additional documentation/examples/guides/tips-n-tricks in [nui.text wiki page](https://github.com/MunifTanjim/nui.nvim/wiki/nui.text).
|
||||
114
.config/nvim/pack/tree/start/nui.nvim/lua/nui/text/init.lua
Normal file
114
.config/nvim/pack/tree/start/nui.nvim/lua/nui/text/init.lua
Normal file
|
|
@ -0,0 +1,114 @@
|
|||
local Object = require("nui.object")
|
||||
local _ = require("nui.utils")._
|
||||
local is_type = require("nui.utils").is_type
|
||||
|
||||
---@class nui_text_extmark
|
||||
---@field id? integer
|
||||
---@field hl_group? string
|
||||
---@field [string] any
|
||||
|
||||
---@class NuiText
|
||||
---@field protected extmark? nui_text_extmark
|
||||
local Text = Object("NuiText")
|
||||
|
||||
---@param content string|NuiText text content or NuiText object
|
||||
---@param extmark? string|nui_text_extmark highlight group name or extmark options
|
||||
function Text:init(content, extmark)
|
||||
if type(content) == "string" then
|
||||
self:set(content, extmark)
|
||||
else
|
||||
-- cloning
|
||||
self:set(content._content, extmark or content.extmark)
|
||||
end
|
||||
end
|
||||
|
||||
---@param content string text content
|
||||
---@param extmark? string|nui_text_extmark highlight group name or extmark options
|
||||
---@return NuiText
|
||||
function Text:set(content, extmark)
|
||||
if self._content ~= content then
|
||||
self._content = content
|
||||
self._length = vim.fn.strlen(content)
|
||||
self._width = vim.api.nvim_strwidth(content)
|
||||
end
|
||||
|
||||
if extmark then
|
||||
-- preserve self.extmark.id
|
||||
local id = self.extmark and self.extmark.id or nil
|
||||
self.extmark = is_type("string", extmark) and { hl_group = extmark } or vim.deepcopy(extmark)
|
||||
self.extmark.id = id
|
||||
end
|
||||
|
||||
return self
|
||||
end
|
||||
|
||||
---@return string
|
||||
function Text:content()
|
||||
return self._content
|
||||
end
|
||||
|
||||
---@return number
|
||||
function Text:length()
|
||||
return self._length
|
||||
end
|
||||
|
||||
---@return number
|
||||
function Text:width()
|
||||
return self._width
|
||||
end
|
||||
|
||||
---@param bufnr number buffer number
|
||||
---@param ns_id number namespace id
|
||||
---@param linenr number line number (1-indexed)
|
||||
---@param byte_start number start byte position (0-indexed)
|
||||
---@return nil
|
||||
function Text:highlight(bufnr, ns_id, linenr, byte_start)
|
||||
if not self.extmark then
|
||||
return
|
||||
end
|
||||
|
||||
self.extmark.end_col = byte_start + self:length()
|
||||
|
||||
self.extmark.id =
|
||||
vim.api.nvim_buf_set_extmark(bufnr, _.ensure_namespace_id(ns_id), linenr - 1, byte_start, self.extmark)
|
||||
end
|
||||
|
||||
---@param bufnr number buffer number
|
||||
---@param ns_id number namespace id
|
||||
---@param linenr_start number start line number (1-indexed)
|
||||
---@param byte_start number start byte position (0-indexed)
|
||||
---@param linenr_end? number end line number (1-indexed)
|
||||
---@param byte_end? number end byte position (0-indexed)
|
||||
---@return nil
|
||||
function Text:render(bufnr, ns_id, linenr_start, byte_start, linenr_end, byte_end)
|
||||
local row_start = linenr_start - 1
|
||||
local row_end = linenr_end and linenr_end - 1 or row_start
|
||||
|
||||
local col_start = byte_start
|
||||
local col_end = byte_end or byte_start + self:length()
|
||||
|
||||
local content = self:content()
|
||||
|
||||
vim.api.nvim_buf_set_text(bufnr, row_start, col_start, row_end, col_end, { content })
|
||||
|
||||
self:highlight(bufnr, ns_id, linenr_start, byte_start)
|
||||
end
|
||||
|
||||
---@param bufnr number buffer number
|
||||
---@param ns_id number namespace id
|
||||
---@param linenr_start number start line number (1-indexed)
|
||||
---@param char_start number start character position (0-indexed)
|
||||
---@param linenr_end? number end line number (1-indexed)
|
||||
---@param char_end? number end character position (0-indexed)
|
||||
---@return nil
|
||||
function Text:render_char(bufnr, ns_id, linenr_start, char_start, linenr_end, char_end)
|
||||
char_end = char_end or char_start + self:width()
|
||||
local byte_range = _.char_to_byte_range(bufnr, linenr_start, char_start, char_end)
|
||||
self:render(bufnr, ns_id, linenr_start, byte_range[1], linenr_end, byte_range[2])
|
||||
end
|
||||
|
||||
---@alias NuiText.constructor fun(content: string|NuiText, extmark?: string|nui_text_extmark): NuiText
|
||||
---@type NuiText|NuiText.constructor
|
||||
local NuiText = Text
|
||||
|
||||
return NuiText
|
||||
Loading…
Add table
Add a link
Reference in a new issue