Files
neovim/src/nvim/lua/stdlib.c
tao d73cfefed5 fix(folds): error when deleting lines at end of buffer #35396
Problem:
with `foldmethod=expr foldexpr=v:lua.vim.treesitter.foldexpr()
foldminlines=0`, deleting lines at the end of the buffer always
reports an invalid top error, because the top value (i.e. the
start line number of the deletion) is always 1 greater than
the total line number of the modified buffer.

Solution:
remove the ml_line_count validation
2025-08-21 19:55:45 -07:00

789 lines
20 KiB
C

#include <assert.h>
#include <lauxlib.h>
#include <lua.h>
#include <stdarg.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <uv.h>
#ifdef NVIM_VENDOR_BIT
# include "bit.h"
#endif
#include "cjson/lua_cjson.h"
#include "mpack/lmpack.h"
#include "nvim/api/private/defs.h"
#include "nvim/api/private/helpers.h"
#include "nvim/ascii_defs.h"
#include "nvim/autocmd.h"
#include "nvim/autocmd_defs.h"
#include "nvim/buffer_defs.h"
#include "nvim/eval/typval.h"
#include "nvim/eval/typval_defs.h"
#include "nvim/eval/vars.h"
#include "nvim/eval/window.h"
#include "nvim/ex_cmds_defs.h"
#include "nvim/ex_docmd.h"
#include "nvim/ex_eval.h"
#include "nvim/fold.h"
#include "nvim/globals.h"
#include "nvim/lua/base64.h"
#include "nvim/lua/converter.h"
#include "nvim/lua/spell.h"
#include "nvim/lua/stdlib.h"
#include "nvim/lua/xdiff.h"
#include "nvim/map_defs.h"
#include "nvim/mbyte.h"
#include "nvim/mbyte_defs.h"
#include "nvim/memline.h"
#include "nvim/memory.h"
#include "nvim/pos_defs.h"
#include "nvim/regexp.h"
#include "nvim/regexp_defs.h"
#include "nvim/runtime.h"
#include "nvim/strings.h"
#include "nvim/types_defs.h"
#include "nvim/window.h"
#include "lua/stdlib.c.generated.h"
static int regex_match(lua_State *lstate, regprog_T **prog, char *str)
{
regmatch_T rm;
rm.regprog = *prog;
rm.rm_ic = false;
bool match = vim_regexec(&rm, str, 0);
*prog = rm.regprog;
if (match) {
lua_pushinteger(lstate, (lua_Integer)(rm.startp[0] - str));
lua_pushinteger(lstate, (lua_Integer)(rm.endp[0] - str));
return 2;
}
return 0;
}
static int regex_match_str(lua_State *lstate)
{
regprog_T **prog = regex_check(lstate);
const char *str = luaL_checkstring(lstate, 2);
int nret = regex_match(lstate, prog, (char *)str);
if (!*prog) {
return luaL_error(lstate, "regex: internal error");
}
return nret;
}
static int regex_match_line(lua_State *lstate)
{
regprog_T **prog = regex_check(lstate);
int narg = lua_gettop(lstate);
if (narg < 3) {
return luaL_error(lstate, "not enough args");
}
handle_T bufnr = (handle_T)luaL_checkinteger(lstate, 2);
linenr_T rownr = (linenr_T)luaL_checkinteger(lstate, 3);
int start = 0;
int end = -1;
if (narg >= 4) {
start = (int)luaL_checkinteger(lstate, 4);
}
if (narg >= 5) {
end = (int)luaL_checkinteger(lstate, 5);
if (end < 0) {
return luaL_error(lstate, "invalid end");
}
}
buf_T *buf = bufnr ? handle_get_buffer(bufnr) : curbuf;
if (!buf || buf->b_ml.ml_mfp == NULL) {
return luaL_error(lstate, "invalid buffer");
}
if (rownr >= buf->b_ml.ml_line_count) {
return luaL_error(lstate, "invalid row");
}
char *line = ml_get_buf(buf, rownr + 1);
colnr_T len = ml_get_buf_len(buf, rownr + 1);
if (start < 0 || start > len) {
return luaL_error(lstate, "invalid start");
}
char save = NUL;
if (end >= 0) {
if (end > len || end < start) {
return luaL_error(lstate, "invalid end");
}
save = line[end];
line[end] = NUL;
}
int nret = regex_match(lstate, prog, line + start);
if (end >= 0) {
line[end] = save;
}
if (!*prog) {
return luaL_error(lstate, "regex: internal error");
}
return nret;
}
static regprog_T **regex_check(lua_State *L)
{
return luaL_checkudata(L, 1, "nvim_regex");
}
static int regex_gc(lua_State *lstate)
{
regprog_T **prog = regex_check(lstate);
vim_regfree(*prog);
return 0;
}
static int regex_tostring(lua_State *lstate)
{
lua_pushstring(lstate, "<regex>");
return 1;
}
static struct luaL_Reg regex_meta[] = {
{ "__gc", regex_gc },
{ "__tostring", regex_tostring },
{ "match_str", regex_match_str },
{ "match_line", regex_match_line },
{ NULL, NULL }
};
/// convert byte index to UTF-32 and UTF-16 indices
///
/// Expects a string and an optional index. If no index is supplied, the length
/// of the string is returned.
///
/// Returns two values: the UTF-32 and UTF-16 indices.
int nlua_str_utfindex(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
intptr_t idx;
if (lua_isnoneornil(lstate, 2)) {
idx = (intptr_t)s1_len;
} else {
idx = luaL_checkinteger(lstate, 2);
if (idx < 0 || idx > (intptr_t)s1_len) {
lua_pushnil(lstate);
lua_pushnil(lstate);
return 2;
}
}
size_t codepoints = 0;
size_t codeunits = 0;
mb_utflen(s1, (size_t)idx, &codepoints, &codeunits);
lua_pushinteger(lstate, (lua_Integer)codepoints);
lua_pushinteger(lstate, (lua_Integer)codeunits);
return 2;
}
/// return byte indices of codepoints in a string (only supports utf-8 currently).
///
/// Expects a string.
///
/// Returns a list of codepoints.
static int nlua_str_utf_pos(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
lua_newtable(lstate);
size_t idx = 1;
size_t clen;
for (size_t i = 0; i < s1_len && s1[i] != NUL; i += clen) {
clen = (size_t)utf_ptr2len_len(s1 + i, (int)(s1_len - i));
lua_pushinteger(lstate, (lua_Integer)i + 1);
lua_rawseti(lstate, -2, (int)idx);
idx++;
}
return 1;
}
/// Return the offset from the 1-indexed byte position to the first byte of the
/// current character.
///
/// Expects a string and an int.
///
/// Returns the byte offset to the first byte of the current character
/// pointed into by the offset.
static int nlua_str_utf_start(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
ptrdiff_t offset = luaL_checkinteger(lstate, 2);
if (offset <= 0 || offset > (intptr_t)s1_len) {
return luaL_error(lstate, "index out of range");
}
size_t const off = (size_t)(offset - 1);
int head_off = -utf_cp_bounds_len(s1, s1 + off, (int)(s1_len - off)).begin_off;
lua_pushinteger(lstate, head_off);
return 1;
}
/// Return the offset from the 1-indexed byte position to the last
/// byte of the current character.
///
/// Expects a string and an int.
///
/// Returns the byte offset to the last byte of the current character
/// pointed into by the offset.
static int nlua_str_utf_end(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
ptrdiff_t offset = luaL_checkinteger(lstate, 2);
if (offset <= 0 || offset > (intptr_t)s1_len) {
return luaL_error(lstate, "index out of range");
}
size_t const off = (size_t)(offset - 1);
int tail_off = utf_cp_bounds_len(s1, s1 + off, (int)(s1_len - off)).end_off - 1;
lua_pushinteger(lstate, tail_off);
return 1;
}
/// convert UTF-32 or UTF-16 indices to byte index.
///
/// Expects up to three args: string, index and use_utf16.
/// If use_utf16 is not supplied it defaults to false (use UTF-32)
///
/// Returns the byte index.
int nlua_str_byteindex(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
intptr_t idx = luaL_checkinteger(lstate, 2);
if (idx < 0) {
lua_pushnil(lstate);
return 1;
}
bool use_utf16 = false;
if (lua_gettop(lstate) >= 3) {
use_utf16 = lua_toboolean(lstate, 3);
}
ssize_t byteidx = mb_utf_index_to_bytes(s1, s1_len, (size_t)idx, use_utf16);
if (byteidx == -1) {
lua_pushnil(lstate);
return 1;
}
lua_pushinteger(lstate, (lua_Integer)byteidx);
return 1;
}
int nlua_regex(lua_State *lstate)
{
Error err = ERROR_INIT;
const char *text = luaL_checkstring(lstate, 1);
regprog_T *prog = NULL;
TRY_WRAP(&err, {
prog = vim_regcomp(text, RE_AUTO | RE_MAGIC | RE_STRICT);
});
if (ERROR_SET(&err)) {
nlua_push_errstr(lstate, "couldn't parse regex: %s", err.msg);
api_clear_error(&err);
return lua_error(lstate);
} else if (prog == NULL) {
nlua_push_errstr(lstate, "couldn't parse regex");
return lua_error(lstate);
}
regprog_T **p = lua_newuserdata(lstate, sizeof(regprog_T *));
*p = prog;
lua_getfield(lstate, LUA_REGISTRYINDEX, "nvim_regex"); // [udata, meta]
lua_setmetatable(lstate, -2); // [udata]
return 1;
}
static dict_T *nlua_get_var_scope(lua_State *lstate)
{
const char *scope = luaL_checkstring(lstate, 1);
handle_T handle = (handle_T)luaL_checkinteger(lstate, 2);
dict_T *dict = NULL;
Error err = ERROR_INIT;
if (strequal(scope, "g")) {
dict = &globvardict;
} else if (strequal(scope, "v")) {
dict = &vimvardict;
} else if (strequal(scope, "b")) {
buf_T *buf = find_buffer_by_handle(handle, &err);
if (buf) {
dict = buf->b_vars;
}
} else if (strequal(scope, "w")) {
win_T *win = find_window_by_handle(handle, &err);
if (win) {
dict = win->w_vars;
}
} else if (strequal(scope, "t")) {
tabpage_T *tabpage = find_tab_by_handle(handle, &err);
if (tabpage) {
dict = tabpage->tp_vars;
}
} else {
luaL_error(lstate, "invalid scope");
return NULL;
}
if (ERROR_SET(&err)) {
nlua_push_errstr(lstate, "scoped variable: %s", err.msg);
api_clear_error(&err);
lua_error(lstate);
return NULL;
}
return dict;
}
int nlua_setvar(lua_State *lstate)
{
// non-local return if not found
dict_T *dict = nlua_get_var_scope(lstate);
String key;
key.data = (char *)luaL_checklstring(lstate, 3, &key.size);
bool del = (lua_gettop(lstate) < 4) || lua_isnil(lstate, 4);
Error err = ERROR_INIT;
dictitem_T *di = dict_check_writable(dict, key, del, &err);
if (ERROR_SET(&err)) {
nlua_push_errstr(lstate, "%s", err.msg);
api_clear_error(&err);
lua_error(lstate);
return 0;
}
bool watched = tv_dict_is_watched(dict);
if (del) {
// Delete the key
if (di == NULL) {
// Doesn't exist, nothing to do
return 0;
}
// Notify watchers
if (watched) {
tv_dict_watcher_notify(dict, key.data, NULL, &di->di_tv);
}
// Delete the entry
tv_dict_item_remove(dict, di);
} else {
// Update the key
typval_T tv;
// Convert the lua value to a vimscript type in the temporary variable
lua_pushvalue(lstate, 4);
if (!nlua_pop_typval(lstate, &tv)) {
return luaL_error(lstate, "Couldn't convert lua value");
}
typval_T oldtv = TV_INITIAL_VALUE;
if (di == NULL) {
// Need to create an entry
di = tv_dict_item_alloc_len(key.data, key.size);
tv_dict_add(dict, di);
} else {
bool type_error = false;
if (dict == &vimvardict
&& !before_set_vvar(key.data, di, &tv, true, watched, &type_error)) {
tv_clear(&tv);
if (type_error) {
return luaL_error(lstate, "Setting v:%s to value with wrong type", key.data);
}
return 0;
}
if (watched) {
tv_copy(&di->di_tv, &oldtv);
}
// Clear the old value
tv_clear(&di->di_tv);
}
// Update the value
tv_copy(&tv, &di->di_tv);
// Notify watchers
if (watched) {
tv_dict_watcher_notify(dict, key.data, &tv, &oldtv);
tv_clear(&oldtv);
}
// Clear the temporary variable
tv_clear(&tv);
}
return 0;
}
int nlua_getvar(lua_State *lstate)
{
// non-local return if not found
dict_T *dict = nlua_get_var_scope(lstate);
size_t len;
const char *name = luaL_checklstring(lstate, 3, &len);
dictitem_T *di = tv_dict_find(dict, name, (ptrdiff_t)len);
if (di == NULL && dict == &globvardict) { // try to autoload script
if (!script_autoload(name, len, false) || aborting()) {
return 0; // nil
}
di = tv_dict_find(dict, name, (ptrdiff_t)len);
}
if (di == NULL) {
return 0; // nil
}
nlua_push_typval(lstate, &di->di_tv, 0);
return 1;
}
/// Compare two strings, ignoring case
///
/// Expects two values on the stack: compared strings. Returns one of the
/// following numbers: 0, -1 or 1.
///
/// Does no error handling: never call it with non-string or with some arguments
/// omitted.
static int nlua_stricmp(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
size_t s1_len;
size_t s2_len;
const char *s1 = luaL_checklstring(lstate, 1, &s1_len);
const char *s2 = luaL_checklstring(lstate, 2, &s2_len);
char *nul1;
char *nul2;
int ret = 0;
assert(s1[s1_len] == NUL);
assert(s2[s2_len] == NUL);
while (true) {
nul1 = memchr(s1, NUL, s1_len);
nul2 = memchr(s2, NUL, s2_len);
ret = STRICMP(s1, s2);
if (ret == 0) {
// Compare "a\0" greater then "a".
if ((nul1 == NULL) != (nul2 == NULL)) {
ret = ((nul1 != NULL) - (nul2 != NULL));
break;
}
if (nul1 != NULL) {
assert(nul2 != NULL);
// Can't shift both strings by the same amount of bytes: lowercase
// letter may have different byte-length than uppercase.
s1_len -= (size_t)(nul1 - s1) + 1;
s2_len -= (size_t)(nul2 - s2) + 1;
s1 = nul1 + 1;
s2 = nul2 + 1;
} else {
break;
}
} else {
break;
}
}
lua_pop(lstate, 2);
lua_pushnumber(lstate, (lua_Number)((ret > 0) - (ret < 0)));
return 1;
}
/// Convert string from one encoding to another
static int nlua_iconv(lua_State *lstate)
{
int narg = lua_gettop(lstate);
if (narg < 3) {
return luaL_error(lstate, "Expected at least 3 arguments");
}
for (int i = 1; i <= 3; i++) {
if (lua_type(lstate, i) != LUA_TSTRING) {
return luaL_argerror(lstate, i, "expected string");
}
}
size_t str_len = 0;
const char *str = lua_tolstring(lstate, 1, &str_len);
char *from = enc_canonize(enc_skip((char *)lua_tolstring(lstate, 2, NULL)));
char *to = enc_canonize(enc_skip((char *)lua_tolstring(lstate, 3, NULL)));
vimconv_T vimconv;
vimconv.vc_type = CONV_NONE;
convert_setup_ext(&vimconv, from, false, to, false);
char *ret = string_convert(&vimconv, (char *)str, &str_len);
convert_setup(&vimconv, NULL, NULL);
xfree(from);
xfree(to);
if (ret == NULL) {
lua_pushnil(lstate);
} else {
lua_pushlstring(lstate, ret, str_len);
xfree(ret);
}
return 1;
}
// Update foldlevels (e.g., by evaluating 'foldexpr') for the given line range in the given window,
// without invoking other side effects. Unlike `zx`, it does not close manually opened folds and
// does not open folds under the cursor.
static int nlua_foldupdate(lua_State *lstate)
{
handle_T window = (handle_T)luaL_checkinteger(lstate, 1);
win_T *win = handle_get_window(window);
if (!win) {
return luaL_error(lstate, "invalid window");
}
// input is zero-based end-exclusive range
linenr_T top = (linenr_T)luaL_checkinteger(lstate, 2) + 1;
if (top < 1) {
return luaL_error(lstate, "invalid top");
}
linenr_T bot = (linenr_T)luaL_checkinteger(lstate, 3);
if (top > bot) {
return luaL_error(lstate, "invalid bot");
}
foldUpdate(win, top, bot);
return 0;
}
static int nlua_with(lua_State *L)
{
int flags = 0;
buf_T *buf = NULL;
win_T *win = NULL;
#define APPLY_FLAG(key, flag) \
if (strequal((key), k) && (v)) { \
flags |= (flag); \
}
luaL_argcheck(L, lua_istable(L, 1), 1, "table expected");
lua_pushnil(L); // [dict, ..., nil]
while (lua_next(L, 1)) {
// [dict, ..., key, value]
if (lua_type(L, -2) == LUA_TSTRING) {
const char *k = lua_tostring(L, -2);
bool v = lua_toboolean(L, -1);
if (strequal("buf", k)) { \
buf = handle_get_buffer((int)luaL_checkinteger(L, -1));
} else if (strequal("win", k)) { \
win = handle_get_window((int)luaL_checkinteger(L, -1));
} else {
APPLY_FLAG("sandbox", CMOD_SANDBOX);
APPLY_FLAG("silent", CMOD_SILENT);
APPLY_FLAG("emsg_silent", CMOD_ERRSILENT);
APPLY_FLAG("unsilent", CMOD_UNSILENT);
APPLY_FLAG("noautocmd", CMOD_NOAUTOCMD);
APPLY_FLAG("hide", CMOD_HIDE);
APPLY_FLAG("keepalt", CMOD_KEEPALT);
APPLY_FLAG("keepmarks", CMOD_KEEPMARKS);
APPLY_FLAG("keepjumps", CMOD_KEEPJUMPS);
APPLY_FLAG("lockmarks", CMOD_LOCKMARKS);
APPLY_FLAG("keeppatterns", CMOD_KEEPPATTERNS);
}
}
// pop the value; lua_next will pop the key.
lua_pop(L, 1); // [dict, ..., key]
}
int status = 0;
int rets = 0;
cmdmod_T save_cmdmod = cmdmod;
CLEAR_FIELD(cmdmod);
cmdmod.cmod_flags = flags;
apply_cmdmod(&cmdmod);
Error err = ERROR_INIT;
TRY_WRAP(&err, {
aco_save_T aco;
win_execute_T win_execute_args;
if (win) {
tabpage_T *tabpage = win_find_tabpage(win);
if (!win_execute_before(&win_execute_args, win, tabpage)) {
goto end;
}
} else if (buf) {
aucmd_prepbuf(&aco, buf);
}
int s = lua_gettop(L);
lua_pushvalue(L, 2);
status = lua_pcall(L, 0, LUA_MULTRET, 0);
rets = lua_gettop(L) - s;
if (win) {
win_execute_after(&win_execute_args);
} else if (buf) {
aucmd_restbuf(&aco);
}
end:;
});
undo_cmdmod(&cmdmod);
cmdmod = save_cmdmod;
if (status) {
return lua_error(L);
} else if (ERROR_SET(&err)) {
nlua_push_errstr(L, "%s", err.msg);
api_clear_error(&err);
return lua_error(L);
}
return rets;
}
// Access to internal functions. For use in runtime/
static void nlua_state_add_internal(lua_State *const lstate)
{
// _getvar
lua_pushcfunction(lstate, &nlua_getvar);
lua_setfield(lstate, -2, "_getvar");
// _setvar
lua_pushcfunction(lstate, &nlua_setvar);
lua_setfield(lstate, -2, "_setvar");
// _updatefolds
lua_pushcfunction(lstate, &nlua_foldupdate);
lua_setfield(lstate, -2, "_foldupdate");
lua_pushcfunction(lstate, &nlua_with);
lua_setfield(lstate, -2, "_with_c");
}
void nlua_state_add_stdlib(lua_State *const lstate, bool is_thread)
{
if (!is_thread) {
// TODO(bfredl): some of basic string functions should already be
// (or be easy to make) threadsafe
// stricmp
lua_pushcfunction(lstate, &nlua_stricmp);
lua_setfield(lstate, -2, "stricmp");
// str_utfindex
lua_pushcfunction(lstate, &nlua_str_utfindex);
lua_setfield(lstate, -2, "_str_utfindex");
// str_byteindex
lua_pushcfunction(lstate, &nlua_str_byteindex);
lua_setfield(lstate, -2, "_str_byteindex");
// str_utf_pos
lua_pushcfunction(lstate, &nlua_str_utf_pos);
lua_setfield(lstate, -2, "str_utf_pos");
// str_utf_start
lua_pushcfunction(lstate, &nlua_str_utf_start);
lua_setfield(lstate, -2, "str_utf_start");
// str_utf_end
lua_pushcfunction(lstate, &nlua_str_utf_end);
lua_setfield(lstate, -2, "str_utf_end");
// regex
lua_pushcfunction(lstate, &nlua_regex);
lua_setfield(lstate, -2, "regex");
luaL_newmetatable(lstate, "nvim_regex");
luaL_register(lstate, NULL, regex_meta);
lua_pushvalue(lstate, -1); // [meta, meta]
lua_setfield(lstate, -2, "__index"); // [meta]
lua_pop(lstate, 1); // don't use metatable now
// vim.spell
luaopen_spell(lstate);
lua_setfield(lstate, -2, "spell");
// vim.iconv
// depends on p_ambw, p_emoji
lua_pushcfunction(lstate, &nlua_iconv);
lua_setfield(lstate, -2, "iconv");
// vim.base64
luaopen_base64(lstate);
lua_setfield(lstate, -2, "base64");
nlua_state_add_internal(lstate);
}
// vim.mpack
luaopen_mpack(lstate);
lua_pushvalue(lstate, -1);
lua_setfield(lstate, -3, "mpack");
// package.loaded.mpack = vim.mpack
// otherwise luv will be reinitialized when require'mpack'
lua_getglobal(lstate, "package");
lua_getfield(lstate, -1, "loaded");
lua_pushvalue(lstate, -3);
lua_setfield(lstate, -2, "mpack");
lua_pop(lstate, 3);
// vim.lpeg
int luaopen_lpeg(lua_State *);
luaopen_lpeg(lstate);
lua_pushvalue(lstate, -1);
lua_setfield(lstate, -4, "lpeg");
// package.loaded.lpeg = vim.lpeg
lua_getglobal(lstate, "package");
lua_getfield(lstate, -1, "loaded");
lua_pushvalue(lstate, -3);
lua_setfield(lstate, -2, "lpeg");
lua_pop(lstate, 4);
// vim.text.diff
lua_pushcfunction(lstate, &nlua_xdl_diff);
// TODO(justinmk): set vim.text.diff here, or rename this to "_diff". goddamnit.
lua_setfield(lstate, -2, "diff");
// vim.json
lua_cjson_new(lstate);
lua_setfield(lstate, -2, "json");
#ifdef NVIM_VENDOR_BIT
// if building with puc lua, use internal fallback for require'bit'
int top = lua_gettop(lstate);
luaopen_bit(lstate);
lua_settop(lstate, top);
#endif
}
/// like luaL_error, but allow cleanup
void nlua_push_errstr(lua_State *L, const char *fmt, ...)
{
va_list argp;
va_start(argp, fmt);
luaL_where(L, 1);
lua_pushvfstring(L, fmt, argp);
va_end(argp);
lua_concat(L, 2);
}