neovim

Neovim text editor
git clone https://git.dasho.dev/neovim.git
Log | Files | Refs | README

api_keysets.lua (13826B)


      1 --- @meta _
      2 -- THIS FILE IS GENERATED
      3 -- DO NOT EDIT
      4 error('Cannot require a meta file')
      5 
      6 --- @class vim.api.keyset.buf_attach
      7 --- @field on_lines? fun(_: "lines", bufnr: integer, changedtick: integer, first: integer, last_old: integer, last_new: integer, byte_count: integer, deleted_codepoints?: integer, deleted_codeunits?: integer): boolean?
      8 --- @field on_bytes? fun(_: "bytes", bufnr: integer, changedtick: integer, start_row: integer, start_col: integer, start_byte: integer, old_end_row: integer, old_end_col: integer, old_end_byte: integer, new_end_row: integer, new_end_col: integer, new_end_byte: integer): boolean?
      9 --- @field on_changedtick? fun(_: "changedtick", bufnr: integer, changedtick: integer)
     10 --- @field on_detach? fun(_: "detach", bufnr: integer)
     11 --- @field on_reload? fun(_: "reload", bufnr: integer)
     12 --- @field utf_sizes? boolean
     13 --- @field preview? boolean
     14 
     15 --- @class vim.api.keyset.buf_delete
     16 --- @field force? boolean
     17 --- @field unload? boolean
     18 
     19 --- @class vim.api.keyset.clear_autocmds
     20 --- @field buffer? integer
     21 --- @field event? vim.api.keyset.events|vim.api.keyset.events[]
     22 --- @field group? integer|string
     23 --- @field pattern? string|string[]
     24 
     25 --- @class vim.api.keyset.cmd
     26 --- @field cmd? string
     27 --- @field range? integer[]
     28 --- @field count? integer
     29 --- @field reg? string
     30 --- @field bang? boolean
     31 --- @field args? string[]
     32 --- @field magic? vim.api.keyset.cmd.magic
     33 --- @field mods? vim.api.keyset.cmd.mods
     34 --- @field nargs? integer|"?"|"+"|"*"
     35 --- @field addr? "line"|"arg"|"buf"|"load"|"win"|"tab"|"qf"|"none"|"?"
     36 --- @field nextcmd? string
     37 
     38 --- @class vim.api.keyset.cmd_magic
     39 --- @field file? boolean
     40 --- @field bar? boolean
     41 
     42 --- @class vim.api.keyset.cmd_mods
     43 --- @field silent? boolean
     44 --- @field emsg_silent? boolean
     45 --- @field unsilent? boolean
     46 --- @field filter? table<string,any>
     47 --- @field sandbox? boolean
     48 --- @field noautocmd? boolean
     49 --- @field browse? boolean
     50 --- @field confirm? boolean
     51 --- @field hide? boolean
     52 --- @field horizontal? boolean
     53 --- @field keepalt? boolean
     54 --- @field keepjumps? boolean
     55 --- @field keepmarks? boolean
     56 --- @field keeppatterns? boolean
     57 --- @field lockmarks? boolean
     58 --- @field noswapfile? boolean
     59 --- @field tab? integer
     60 --- @field verbose? integer
     61 --- @field vertical? boolean
     62 --- @field split? string
     63 
     64 --- @class vim.api.keyset.cmd_mods_filter
     65 --- @field pattern? string
     66 --- @field force? boolean
     67 
     68 --- @class vim.api.keyset.cmd_opts
     69 --- @field output? boolean
     70 
     71 --- @class vim.api.keyset.complete_set
     72 --- @field info? string
     73 
     74 --- @class vim.api.keyset.context
     75 --- @field types? string[]
     76 
     77 --- @class vim.api.keyset.create_augroup
     78 --- @field clear? boolean
     79 
     80 --- @alias vim.api.keyset.events
     81 --- |'BufAdd'
     82 --- |'BufCreate'
     83 --- |'BufDelete'
     84 --- |'BufEnter'
     85 --- |'BufFilePost'
     86 --- |'BufFilePre'
     87 --- |'BufHidden'
     88 --- |'BufLeave'
     89 --- |'BufModifiedSet'
     90 --- |'BufNew'
     91 --- |'BufNewFile'
     92 --- |'BufRead'
     93 --- |'BufReadCmd'
     94 --- |'BufReadPost'
     95 --- |'BufReadPre'
     96 --- |'BufUnload'
     97 --- |'BufWinEnter'
     98 --- |'BufWinLeave'
     99 --- |'BufWipeout'
    100 --- |'BufWrite'
    101 --- |'BufWriteCmd'
    102 --- |'BufWritePost'
    103 --- |'BufWritePre'
    104 --- |'ChanInfo'
    105 --- |'ChanOpen'
    106 --- |'CmdUndefined'
    107 --- |'CmdlineChanged'
    108 --- |'CmdlineEnter'
    109 --- |'CmdlineLeave'
    110 --- |'CmdlineLeavePre'
    111 --- |'CmdwinEnter'
    112 --- |'CmdwinLeave'
    113 --- |'ColorScheme'
    114 --- |'ColorSchemePre'
    115 --- |'CompleteChanged'
    116 --- |'CompleteDone'
    117 --- |'CompleteDonePre'
    118 --- |'CursorHold'
    119 --- |'CursorHoldI'
    120 --- |'CursorMoved'
    121 --- |'CursorMovedC'
    122 --- |'CursorMovedI'
    123 --- |'DiagnosticChanged'
    124 --- |'DiffUpdated'
    125 --- |'DirChanged'
    126 --- |'DirChangedPre'
    127 --- |'EncodingChanged'
    128 --- |'ExitPre'
    129 --- |'FileAppendCmd'
    130 --- |'FileAppendPost'
    131 --- |'FileAppendPre'
    132 --- |'FileChangedRO'
    133 --- |'FileChangedShell'
    134 --- |'FileChangedShellPost'
    135 --- |'FileEncoding'
    136 --- |'FileReadCmd'
    137 --- |'FileReadPost'
    138 --- |'FileReadPre'
    139 --- |'FileType'
    140 --- |'FileWriteCmd'
    141 --- |'FileWritePost'
    142 --- |'FileWritePre'
    143 --- |'FilterReadPost'
    144 --- |'FilterReadPre'
    145 --- |'FilterWritePost'
    146 --- |'FilterWritePre'
    147 --- |'FocusGained'
    148 --- |'FocusLost'
    149 --- |'FuncUndefined'
    150 --- |'GUIEnter'
    151 --- |'GUIFailed'
    152 --- |'InsertChange'
    153 --- |'InsertCharPre'
    154 --- |'InsertEnter'
    155 --- |'InsertLeave'
    156 --- |'InsertLeavePre'
    157 --- |'LspAttach'
    158 --- |'LspDetach'
    159 --- |'LspNotify'
    160 --- |'LspProgress'
    161 --- |'LspRequest'
    162 --- |'LspTokenUpdate'
    163 --- |'MarkSet'
    164 --- |'MenuPopup'
    165 --- |'ModeChanged'
    166 --- |'OptionSet'
    167 --- |'PackChanged'
    168 --- |'PackChangedPre'
    169 --- |'Progress'
    170 --- |'QuickFixCmdPost'
    171 --- |'QuickFixCmdPre'
    172 --- |'QuitPre'
    173 --- |'RecordingEnter'
    174 --- |'RecordingLeave'
    175 --- |'RemoteReply'
    176 --- |'SafeState'
    177 --- |'SearchWrapped'
    178 --- |'SessionLoadPost'
    179 --- |'SessionLoadPre'
    180 --- |'SessionWritePost'
    181 --- |'ShellCmdPost'
    182 --- |'ShellFilterPost'
    183 --- |'Signal'
    184 --- |'SourceCmd'
    185 --- |'SourcePost'
    186 --- |'SourcePre'
    187 --- |'SpellFileMissing'
    188 --- |'StdinReadPost'
    189 --- |'StdinReadPre'
    190 --- |'SwapExists'
    191 --- |'Syntax'
    192 --- |'TabClosed'
    193 --- |'TabClosedPre'
    194 --- |'TabEnter'
    195 --- |'TabLeave'
    196 --- |'TabNew'
    197 --- |'TabNewEntered'
    198 --- |'TermChanged'
    199 --- |'TermClose'
    200 --- |'TermEnter'
    201 --- |'TermLeave'
    202 --- |'TermOpen'
    203 --- |'TermRequest'
    204 --- |'TermResponse'
    205 --- |'TextChanged'
    206 --- |'TextChangedI'
    207 --- |'TextChangedP'
    208 --- |'TextChangedT'
    209 --- |'TextYankPost'
    210 --- |'UIEnter'
    211 --- |'UILeave'
    212 --- |'User'
    213 --- |'VimEnter'
    214 --- |'VimLeave'
    215 --- |'VimLeavePre'
    216 --- |'VimResized'
    217 --- |'VimResume'
    218 --- |'VimSuspend'
    219 --- |'WinClosed'
    220 --- |'WinEnter'
    221 --- |'WinLeave'
    222 --- |'WinNew'
    223 --- |'WinNewPre'
    224 --- |'WinResized'
    225 --- |'WinScrolled'
    226 
    227 --- @class vim.api.keyset.create_autocmd
    228 --- @field buffer? integer
    229 --- @field callback? string|fun(args: vim.api.keyset.create_autocmd.callback_args): boolean?
    230 --- @field command? string
    231 --- @field desc? string
    232 --- @field group? integer|string
    233 --- @field nested? boolean
    234 --- @field once? boolean
    235 --- @field pattern? string|string[]
    236 
    237 --- @class vim.api.keyset.echo_opts
    238 --- @field err? boolean
    239 --- @field verbose? boolean
    240 --- @field kind? string
    241 --- @field id? integer|string
    242 --- @field title? string
    243 --- @field status? string
    244 --- @field percent? integer
    245 --- @field data? table<string,any>
    246 
    247 --- @class vim.api.keyset.empty
    248 
    249 --- @class vim.api.keyset.eval_statusline
    250 --- @field winid? integer
    251 --- @field maxwidth? integer
    252 --- @field fillchar? string
    253 --- @field highlights? boolean
    254 --- @field use_winbar? boolean
    255 --- @field use_tabline? boolean
    256 --- @field use_statuscol_lnum? integer
    257 
    258 --- @class vim.api.keyset.exec_autocmds
    259 --- @field buffer? integer
    260 --- @field group? integer|string
    261 --- @field modeline? boolean
    262 --- @field pattern? string|string[]
    263 --- @field data? any
    264 
    265 --- @class vim.api.keyset.exec_opts
    266 --- @field output? boolean
    267 
    268 --- @class vim.api.keyset.get_autocmds
    269 --- @field event? vim.api.keyset.events|vim.api.keyset.events[]
    270 --- @field group? integer|string
    271 --- @field pattern? string|string[]
    272 --- @field buffer? integer|integer[]
    273 --- @field id? integer
    274 
    275 --- @class vim.api.keyset.get_commands
    276 --- @field builtin? boolean
    277 
    278 --- @class vim.api.keyset.get_extmark
    279 --- @field details? boolean
    280 --- @field hl_name? boolean
    281 
    282 --- @class vim.api.keyset.get_extmarks
    283 --- @field limit? integer
    284 --- @field details? boolean
    285 --- @field hl_name? boolean
    286 --- @field overlap? boolean
    287 --- @field type? string
    288 
    289 --- @class vim.api.keyset.get_highlight
    290 --- @field id? integer
    291 --- @field name? string
    292 --- @field link? boolean
    293 --- @field create? boolean
    294 
    295 --- @class vim.api.keyset.get_ns
    296 --- @field winid? integer
    297 
    298 --- @class vim.api.keyset.highlight
    299 --- @field altfont? boolean
    300 --- @field blink? boolean
    301 --- @field bold? boolean
    302 --- @field conceal? boolean
    303 --- @field dim? boolean
    304 --- @field italic? boolean
    305 --- @field nocombine? boolean
    306 --- @field overline? boolean
    307 --- @field reverse? boolean
    308 --- @field standout? boolean
    309 --- @field strikethrough? boolean
    310 --- @field undercurl? boolean
    311 --- @field underdashed? boolean
    312 --- @field underdotted? boolean
    313 --- @field underdouble? boolean
    314 --- @field underline? boolean
    315 --- @field default? boolean
    316 --- @field cterm? vim.api.keyset.highlight_cterm
    317 --- @field foreground? integer|string
    318 --- @field fg? integer|string
    319 --- @field background? integer|string
    320 --- @field bg? integer|string
    321 --- @field ctermfg? integer|string
    322 --- @field ctermbg? integer|string
    323 --- @field special? integer|string
    324 --- @field sp? integer|string
    325 --- @field link? integer|string
    326 --- @field global_link? integer|string
    327 --- @field fallback? boolean
    328 --- @field blend? integer
    329 --- @field fg_indexed? boolean
    330 --- @field bg_indexed? boolean
    331 --- @field force? boolean
    332 --- @field url? string
    333 
    334 --- @class vim.api.keyset.highlight_cterm
    335 --- @field bold? boolean
    336 --- @field standout? boolean
    337 --- @field strikethrough? boolean
    338 --- @field underline? boolean
    339 --- @field undercurl? boolean
    340 --- @field underdouble? boolean
    341 --- @field underdotted? boolean
    342 --- @field underdashed? boolean
    343 --- @field italic? boolean
    344 --- @field reverse? boolean
    345 --- @field altfont? boolean
    346 --- @field dim? boolean
    347 --- @field blink? boolean
    348 --- @field conceal? boolean
    349 --- @field overline? boolean
    350 --- @field nocombine? boolean
    351 
    352 --- @class vim.api.keyset.keymap
    353 --- @field noremap? boolean
    354 --- @field nowait? boolean
    355 --- @field silent? boolean
    356 --- @field script? boolean
    357 --- @field expr? boolean
    358 --- @field unique? boolean
    359 --- @field callback? function
    360 --- @field desc? string
    361 --- @field replace_keycodes? boolean
    362 
    363 --- @class vim.api.keyset.ns_opts
    364 --- @field wins? any[]
    365 
    366 --- @class vim.api.keyset.open_term
    367 --- @field on_input? fun(_: "input", term: integer, bufnr: integer, data: any)
    368 --- @field force_crlf? boolean
    369 
    370 --- @class vim.api.keyset.option
    371 --- @field scope? string
    372 --- @field win? integer
    373 --- @field buf? integer
    374 --- @field filetype? string
    375 
    376 --- @class vim.api.keyset.redraw
    377 --- @field flush? boolean
    378 --- @field cursor? boolean
    379 --- @field valid? boolean
    380 --- @field statuscolumn? boolean
    381 --- @field statusline? boolean
    382 --- @field tabline? boolean
    383 --- @field winbar? boolean
    384 --- @field range? any[]
    385 --- @field win? integer
    386 --- @field buf? integer
    387 
    388 --- @class vim.api.keyset.runtime
    389 --- @field is_lua? boolean
    390 --- @field do_source? boolean
    391 
    392 --- @class vim.api.keyset.set_decoration_provider
    393 --- @field on_start? fun(_: "start", tick: integer): boolean?
    394 --- @field on_buf? fun(_: "buf", bufnr: integer, tick: integer)
    395 --- @field on_win? fun(_: "win", winid: integer, bufnr: integer, toprow: integer, botrow: integer): boolean?
    396 --- @field on_line? fun(_: "line", winid: integer, bufnr: integer, row: integer): boolean?
    397 --- @field on_range? fun(_: "range", winid: integer, bufnr: integer, start_row: integer, start_col: integer, end_row: integer, end_col: integer): boolean?
    398 --- @field on_end? fun(_: "end", tick: integer)
    399 --- @field _on_hl_def? fun(_: "hl_def")
    400 --- @field _on_spell_nav? fun(_: "spell_nav")
    401 --- @field _on_conceal_line? fun(_: "conceal_line")
    402 
    403 --- @class vim.api.keyset.set_extmark
    404 --- @field id? integer
    405 --- @field end_line? integer
    406 --- @field end_row? integer
    407 --- @field end_col? integer
    408 --- @field hl_group? any
    409 --- @field virt_text? any[]
    410 --- @field virt_text_pos? "eol"|"eol_right_align"|"overlay"|"right_align"|"inline"
    411 --- @field virt_text_win_col? integer
    412 --- @field virt_text_hide? boolean
    413 --- @field virt_text_repeat_linebreak? boolean
    414 --- @field hl_eol? boolean
    415 --- @field hl_mode? "replace"|"combine"|"blend"
    416 --- @field invalidate? boolean
    417 --- @field ephemeral? boolean
    418 --- @field priority? integer
    419 --- @field right_gravity? boolean
    420 --- @field end_right_gravity? boolean
    421 --- @field virt_lines? any[]
    422 --- @field virt_lines_above? boolean
    423 --- @field virt_lines_leftcol? boolean
    424 --- @field virt_lines_overflow? "trunc"|"scroll"
    425 --- @field strict? boolean
    426 --- @field sign_text? string
    427 --- @field sign_hl_group? integer|string
    428 --- @field number_hl_group? integer|string
    429 --- @field line_hl_group? integer|string
    430 --- @field cursorline_hl_group? integer|string
    431 --- @field conceal? string
    432 --- @field conceal_lines? string
    433 --- @field spell? boolean
    434 --- @field ui_watched? boolean
    435 --- @field undo_restore? boolean
    436 --- @field url? string
    437 --- @field scoped? boolean
    438 --- @field _subpriority? integer
    439 
    440 --- @class vim.api.keyset.user_command
    441 --- @field addr? any
    442 --- @field bang? boolean
    443 --- @field bar? boolean
    444 --- @field complete? any
    445 --- @field count? any
    446 --- @field desc? any
    447 --- @field force? boolean
    448 --- @field keepscript? boolean
    449 --- @field nargs? any
    450 --- @field preview? any
    451 --- @field range? any
    452 --- @field register? boolean
    453 
    454 --- @class vim.api.keyset.win_config
    455 --- @field external? boolean
    456 --- @field fixed? boolean
    457 --- @field focusable? boolean
    458 --- @field footer? any
    459 --- @field footer_pos? "center"|"left"|"right"
    460 --- @field hide? boolean
    461 --- @field height? integer
    462 --- @field mouse? boolean
    463 --- @field relative? "cursor"|"editor"|"laststatus"|"mouse"|"tabline"|"win"
    464 --- @field row? number
    465 --- @field style? "minimal"
    466 --- @field noautocmd? boolean
    467 --- @field vertical? boolean
    468 --- @field win? integer
    469 --- @field width? integer
    470 --- @field zindex? integer
    471 --- @field anchor? "NW"|"NE"|"SW"|"SE"
    472 --- @field border? any[]|"none"|"single"|"double"|"rounded"|"solid"|"shadow"
    473 --- @field bufpos? integer[]
    474 --- @field col? number
    475 --- @field split? "left"|"right"|"above"|"below"
    476 --- @field title? any
    477 --- @field title_pos? "center"|"left"|"right"
    478 --- @field _cmdline_offset? integer
    479 
    480 --- @class vim.api.keyset.win_text_height
    481 --- @field start_row? integer
    482 --- @field end_row? integer
    483 --- @field start_vcol? integer
    484 --- @field end_vcol? integer
    485 --- @field max_height? integer
    486 
    487 --- @class vim.api.keyset.xdl_diff
    488 --- @field on_hunk? fun(start_a: integer, count_a: integer, start_b: integer, count_b: integer): integer?
    489 --- @field result_type? string
    490 --- @field algorithm? string
    491 --- @field ctxlen? integer
    492 --- @field interhunkctxlen? integer
    493 --- @field linematch? boolean|integer
    494 --- @field ignore_whitespace? boolean
    495 --- @field ignore_whitespace_change? boolean
    496 --- @field ignore_whitespace_change_at_eol? boolean
    497 --- @field ignore_cr_at_eol? boolean
    498 --- @field ignore_blank_lines? boolean
    499 --- @field indent_heuristic? boolean