mirror of
https://github.com/neovim/neovim.git
synced 2026-05-23 21:30:11 +00:00
Problem: Cannot remove a `@conceal` highlight when defined in highlights.scm. Solution: Support a `@noconceal` highlight that works similarly to `@nospell` where it overrides the conceal set on the range to remove it. Additionally, can set the conceal metadata field to false for the same behavior.
276 lines
7.8 KiB
Lua
276 lines
7.8 KiB
Lua
--- @meta _
|
|
-- This file is NOT generated, edit it directly. See also _meta/api_keysets.gen.lua.
|
|
|
|
error('Cannot require a meta file')
|
|
|
|
--- Extra types we don't define keysets for.
|
|
|
|
--- @class vim.api.keyset.extmark_details
|
|
--- @field ns_id integer
|
|
--- @field right_gravity boolean
|
|
---
|
|
--- @field end_row? integer
|
|
--- @field end_col? integer
|
|
--- @field end_right_gravity? integer
|
|
---
|
|
--- @field priority? integer
|
|
---
|
|
--- @field undo_restore? false
|
|
--- @field invalidate? true
|
|
--- @field invalid? true
|
|
---
|
|
--- @field hl_group? string
|
|
--- @field hl_eol? boolean
|
|
---
|
|
--- @field conceal? string|false
|
|
--- @field spell? boolean
|
|
--- @field ui_watched? boolean
|
|
--- @field url? string
|
|
--- @field hl_mode? string
|
|
---
|
|
--- @field virt_text? [string, string][]
|
|
--- @field virt_text_hide? boolean
|
|
--- @field virt_text_repeat_linebreak? boolean
|
|
--- @field virt_text_win_col? integer
|
|
--- @field virt_text_pos? string
|
|
---
|
|
--- @field virt_lines? [string, string][][]
|
|
--- @field virt_lines_above? boolean
|
|
--- @field virt_lines_leftcol? boolean
|
|
---
|
|
--- @field sign_text? string
|
|
--- @field sign_name? string
|
|
--- @field sign_hl_group? string
|
|
--- @field number_hl_group? string
|
|
--- @field line_hl_group? string
|
|
--- @field cursorline_hl_group? string
|
|
|
|
--- @class vim.api.keyset.get_extmark_item_by_id
|
|
--- @field [1] integer row
|
|
--- @field [2] integer col
|
|
--- @field [3] vim.api.keyset.extmark_details?
|
|
|
|
--- @class vim.api.keyset.get_extmark_item
|
|
--- @field [1] integer extmark_id
|
|
--- @field [2] integer row
|
|
--- @field [3] integer col
|
|
--- @field [4] vim.api.keyset.extmark_details?
|
|
|
|
--- @class vim.api.keyset.get_autocmds.ret
|
|
--- @field id? integer
|
|
--- @field group? integer
|
|
--- @field group_name? integer
|
|
--- @field desc? string
|
|
--- @field event? string
|
|
--- @field command? string
|
|
--- @field callback? function
|
|
--- @field once? boolean
|
|
--- @field pattern? string
|
|
--- @field buflocal? boolean
|
|
--- @field buf? integer
|
|
|
|
--- @class vim.api.keyset.create_autocmd.callback_args
|
|
--- @field id integer autocommand id
|
|
--- @field event string name of the triggered event |autocmd-events|
|
|
--- @field group? integer autocommand group id, if any
|
|
--- @field match string expanded value of <amatch>
|
|
--- @field buf integer expanded value of <abuf>
|
|
--- @field file string expanded value of <afile>
|
|
--- @field data? any arbitrary data passed from |nvim_exec_autocmds()|
|
|
|
|
--- @class vim.api.keyset.create_user_command.command_args
|
|
--- @field name string Command name
|
|
---
|
|
--- The args passed to the command, if any <args>
|
|
--- @field args string
|
|
---
|
|
--- The args split by unescaped whitespace
|
|
--- (when more than one argument is allowed), if any <f-args>
|
|
--- @field fargs string[]
|
|
---
|
|
--- Number of arguments |:command-nargs|
|
|
--- @field nargs string
|
|
---
|
|
--- "true" if the command was executed with a ! modifier <bang>
|
|
--- @field bang boolean
|
|
---
|
|
--- The starting line of the command range <line1>
|
|
--- @field line1 integer
|
|
---
|
|
--- The final line of the command range <line2>
|
|
--- @field line2 integer
|
|
---
|
|
--- The number of items in the command range: 0, 1, or 2 <range>
|
|
--- @field range integer
|
|
---
|
|
--- Any count supplied <count>
|
|
--- @field count integer
|
|
--- The optional register, if specified <reg>
|
|
--- @field reg string
|
|
--- Command modifiers, if any <mods>
|
|
--- @field mods string
|
|
---
|
|
--- Command modifiers in a structured format. Has the same structure as the
|
|
--- "mods" key of |nvim_parse_cmd()|.
|
|
--- @field smods vim.api.keyset.cmd_mods
|
|
|
|
--- @class vim.api.keyset.command_info
|
|
--- @field name string
|
|
--- @field definition string
|
|
--- @field script_id integer
|
|
--- @field bang boolean
|
|
--- @field bar boolean
|
|
--- @field register boolean
|
|
--- @field keepscript boolean
|
|
--- @field preview? function
|
|
--- @field nargs string
|
|
--- @field complete? string|function
|
|
--- @field complete_arg? string
|
|
--- @field count? string
|
|
--- @field range? string
|
|
--- @field addr? string
|
|
--- @field callback? function
|
|
|
|
--- @class vim.api.keyset.hl_info.base
|
|
--- @field reverse? true
|
|
--- @field bold? true
|
|
--- @field italic? true
|
|
--- @field underline? true
|
|
--- @field undercurl? true
|
|
--- @field underdouble? true
|
|
--- @field underdotted? true
|
|
--- @field underdashed? true
|
|
--- @field standout? true
|
|
--- @field strikethrough? true
|
|
--- @field altfont? true
|
|
--- @field nocombine? true
|
|
--- @field ctermfg? integer
|
|
--- @field ctermbg? integer
|
|
|
|
--- @class vim.api.keyset.hl_info.cterm : vim.api.keyset.hl_info.base
|
|
--- @field foreground? integer
|
|
--- @field background? integer
|
|
|
|
--- @class vim.api.keyset.get_hl_info : vim.api.keyset.hl_info.base
|
|
--- @field blend? integer
|
|
--- @field bg? integer
|
|
--- @field bg_indexed? boolean
|
|
--- @field cterm? vim.api.keyset.hl_info.cterm
|
|
--- @field default? true
|
|
--- @field fg? integer
|
|
--- @field fg_indexed? boolean
|
|
--- @field link? string
|
|
--- @field sp? integer
|
|
|
|
--- @class vim.api.keyset.set_hl_info : vim.api.keyset.hl_info.base
|
|
--- @field fg? integer|string
|
|
--- @field bg? integer|string
|
|
--- @field sp? integer|string
|
|
--- @field default? true
|
|
--- @field link? string
|
|
--- @field blend? integer
|
|
--- @field force? true
|
|
--- @field cterm? vim.api.keyset.hl_info.cterm
|
|
|
|
--- @class vim.api.keyset.get_keymap
|
|
--- @field abbr? 0|1
|
|
--- @field buf? 0|1
|
|
--- @field callback? function
|
|
--- @field desc? string
|
|
--- @field expr? 0|1
|
|
--- @field lhs? string
|
|
--- @field lhsraw? string
|
|
--- @field lhsrawalt? string
|
|
--- @field lnum? integer
|
|
--- @field mode? string
|
|
--- @field mode_bits? integer
|
|
--- @field noremap? 0|1
|
|
--- @field nowait? 0|1
|
|
--- @field rhs? string
|
|
--- @field script? 0|1
|
|
--- @field scriptversion? integer
|
|
--- @field sid? integer
|
|
--- @field silent? 0|1
|
|
|
|
--- @class vim.api.keyset.get_mode
|
|
--- @field blocking boolean
|
|
--- @field mode string
|
|
|
|
--- @class vim.api.keyset.get_option_info
|
|
--- @field name string
|
|
--- @field shortname string
|
|
--- @field scope 'buf'|'win'|'global'
|
|
--- @field global_local boolean
|
|
--- @field commalist boolean
|
|
--- @field flaglist boolean
|
|
--- @field was_set boolean
|
|
--- @field last_set_sid integer
|
|
--- @field last_set_linenr integer
|
|
--- @field last_set_chan integer
|
|
--- @field type 'string'|'boolean'|'number'
|
|
--- @field default string|boolean|integer
|
|
--- @field allows_duplicates boolean
|
|
|
|
--- @class vim.api.keyset.cmd.mods
|
|
--- @field filter? { force: boolean, pattern: string }
|
|
--- @field silent? boolean
|
|
--- @field emsg_silent? boolean
|
|
--- @field unsilent? boolean
|
|
--- @field sandbox? boolean
|
|
--- @field noautocmd? boolean
|
|
--- @field tab? integer
|
|
--- @field verbose? integer
|
|
--- @field browse? boolean
|
|
--- @field confirm? boolean
|
|
--- @field hide? boolean
|
|
--- @field keepalt? boolean
|
|
--- @field keepjumps? boolean
|
|
--- @field keepmarks? boolean
|
|
--- @field keeppatterns? boolean
|
|
--- @field lockmarks? boolean
|
|
--- @field noswapfile? boolean
|
|
--- @field vertical? boolean
|
|
--- @field horizontal? boolean
|
|
--- @field split? ''|'botright'|'topleft'|'belowright'|'aboveleft'
|
|
|
|
--- @class vim.api.keyset.cmd.magic
|
|
--- @field bar boolean
|
|
--- @field file boolean
|
|
|
|
--- @class vim.api.keyset.eval_statusline_ret.highlight
|
|
--- @field start integer
|
|
--- @field group string
|
|
--- @field groups string[]
|
|
|
|
--- @class vim.api.keyset.eval_statusline_ret
|
|
--- @field str string
|
|
--- @field width integer
|
|
--- @field highlights vim.api.keyset.eval_statusline_ret.highlight[]
|
|
|
|
--- @class vim.api.keyset.win_text_height_ret
|
|
--- @field all integer
|
|
--- @field fill integer
|
|
--- @field end_row integer
|
|
--- @field end_vcol integer
|
|
|
|
-- Inherit from vim.api.keyset.win_config so this type can be passed to nvim_open_win().
|
|
-- Because of this we only need to define the fields with different types (nil or non-nil).
|
|
|
|
--- @class vim.api.keyset.win_config_ret : vim.api.keyset.win_config
|
|
--- @field focusable boolean
|
|
--- @field external boolean
|
|
--- @field hide boolean
|
|
--- @field mouse boolean
|
|
--- @field width integer
|
|
--- @field height integer
|
|
--- @field relative 'cursor'|'editor'|'laststatus'|'mouse'|'tabline'|'win'
|
|
---
|
|
--- @field noautocmd nil
|
|
--- @field title nil
|
|
--- @field title_pos nil
|
|
--- @field footer nil
|
|
--- @field footer_pos nil
|
|
--- @field style nil
|
|
--- @field fixed nil
|
|
--- @field vertical nil
|