GitHub/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim synced 2025-07-15 16:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(api): memory leaks in vim.api.nvim_*get_option #32390

Browse Source 
Problem: `get_option_value` returns caller owned `Object`s but the
corresponding C apis do not marked `FUNC_API_RET_ALLOC` properly.

Solution: add `FUNC_API_RET_ALLOC` to the C apis.
This commit is contained in:
Cai Rijun (Richard)
2025-02-11 01:37:36 +08:00
committed by GitHub
parent 524cdd35c2
commit ad60b3fb48
2 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/nvim/api/deprecated.c
View File

@ -633,6 +633,7 @@ void nvim_set_option(uint64_t channel_id, String name, Object value, Error *err)
Object nvim_get_option(String name, Error *err)
FUNC_API_SINCE(1)
FUNC_API_DEPRECATED_SINCE(11)
FUNC_API_RET_ALLOC
{
return get_option_from(NULL, kOptScopeGlobal, name, err);
}
@ -647,6 +648,7 @@ Object nvim_get_option(String name, Error *err)
Object nvim_buf_get_option(Buffer buffer, String name, Error *err)
FUNC_API_SINCE(1)
FUNC_API_DEPRECATED_SINCE(11)
FUNC_API_RET_ALLOC
{
buf_T *buf = find_buffer_by_handle(buffer, err);
@ -689,6 +691,7 @@ void nvim_buf_set_option(uint64_t channel_id, Buffer buffer, String name, Object
Object nvim_win_get_option(Window window, String name, Error *err)
FUNC_API_SINCE(1)
FUNC_API_DEPRECATED_SINCE(11)
FUNC_API_RET_ALLOC
{
win_T *win = find_window_by_handle(window, err);
@ -728,7 +731,7 @@ void nvim_win_set_option(uint64_t channel_id, Window window, String name, Object
/// @param name The option name.
/// @param[out] err Details of an error that may have occurred.
///
/// @return the option value.
/// @return the option value. Must be freed by caller.
static Object get_option_from(void *from, OptScope scope, String name, Error *err)
{
VALIDATE_S(name.size > 0, "option name", "<empty>", {

11
test/functional/api/deprecated_spec.lua
View File

@ -18,4 +18,15 @@ describe('deprecated', function()
n.api.nvim_notify('hello world', 4, {})
end)
end)
describe('nvim_*get_option functions', function()
it('does not leak memory', function()
-- String opts caused memory leaks in these functions in Github#32361
n.exec_lua([[
vim.api.nvim_get_option('rtp')
vim.api.nvim_win_get_option(vim.api.nvim_get_current_win(), 'foldmethod')
vim.api.nvim_buf_get_option(0, 'fileformat')
]])
end)
end)
end)