Doc: update documentation for on_bytes

This commit is contained in:
chentau 2021-02-15 00:26:34 -08:00
parent dc3ca16a99
commit d966e0142d
2 changed files with 55 additions and 0 deletions

View File

@ -1148,6 +1148,18 @@ nvim_load_context({dict}) *nvim_load_context()*
Parameters: ~
{dict} |Context| map.
nvim_notify({msg}, {log_level}, {opts}) *nvim_notify()*
Notify the user with a message
Relays the call to vim.notify . By default forwards your
message in the echo area but can be overriden to trigger
desktop notifications.
Parameters: ~
{msg} Message to display to the user
{log_level} The log level
{opts} Reserved for future use.
nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
Open a new window.
@ -1800,6 +1812,25 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• deleted_codeunits (if `utf_sizes` is
true)
• on_bytes: lua callback invoked on change.
This callback receives more granular
information about the change compared to
on_lines. Return`true`to detach. Args:
• the string "bytes"
• buffer handle
• b:changedtick
• start row of the changed text
(zero-indexed)
• start column of the changed text
• byte offset of the changed text (from
the start of the buffer)
• old end row of the changed text
• old end column of the changed text
• old end byte length of the changed text
• new end row of the changed text
• new end column of the changed text
• new end byte length of the changed text
• on_changedtick: Lua callback invoked on
changedtick increment without text
change. Args:
@ -1812,6 +1843,12 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()*
• the string "detach"
• buffer handle
• on_reload: Lua callback invoked on
reload. The entire buffer content should
be considered changed. Args:
• the string "detach"
• buffer handle
• utf_sizes: include UTF-32 and UTF-16 size
of the replaced region, as args to
`on_lines` .

View File

@ -111,6 +111,24 @@ Integer nvim_buf_line_count(Buffer buffer, Error *err)
/// - byte count of previous contents
/// - deleted_codepoints (if `utf_sizes` is true)
/// - deleted_codeunits (if `utf_sizes` is true)
/// - on_bytes: lua callback invoked on change.
/// This callback receives more granular information about the
/// change compared to on_lines.
/// Return `true` to detach.
/// Args:
/// - the string "bytes"
/// - buffer handle
/// - b:changedtick
/// - start row of the changed text (zero-indexed)
/// - start column of the changed text
/// - byte offset of the changed text (from the start of
/// the buffer)
/// - old end row of the changed text
/// - old end column of the changed text
/// - old end byte length of the changed text
/// - new end row of the changed text
/// - new end column of the changed text
/// - new end byte length of the changed text
/// - on_changedtick: Lua callback invoked on changedtick
/// increment without text change. Args:
/// - the string "changedtick"