[WIP] Add nvim_add_autocommand API #10844
Conversation
| @@ -2250,6 +2250,56 @@ Array nvim_get_proc_children(Integer pid, Error *err) | |||
| return rvobj; | |||
| } | |||
|
|
|||
| Boolean nvim_add_autocommand( | |||
| uint64_t channel_id, | |||
| String event, String pat, DictionaryOf(LuaRef) opts, Error *err | |||
There was a problem hiding this comment.
Here we'd like to use just plain callback as the last argument. We are missing API harness for LuaRef though right now.
| char_u *next_ev; | ||
| LuaRef cb = LUA_NOREF; | ||
|
|
||
| event_T event_nr = event_name2nr((char_u *)event.data, &next_ev); |
There was a problem hiding this comment.
next_ev is only needed for event_name2nr but not used here. Maybe we can have better API for converting names to event_T enum.
| @@ -2250,6 +2250,56 @@ Array nvim_get_proc_children(Integer pid, Error *err) | |||
| return rvobj; | |||
| } | |||
|
|
|||
| Boolean nvim_add_autocommand( | |||
There was a problem hiding this comment.
Need to support buffer local, once, multiple events.
| AUGROUP_ALL | ||
| ); | ||
|
|
||
| return retval != FAIL; |
There was a problem hiding this comment.
Should we do api_set_error here as well?
| @@ -5427,7 +5429,11 @@ static void show_autocmd(AutoPat *ap, event_T event) | |||
| msg_col = 14; | |||
| if (got_int) | |||
| return; | |||
| msg_outtrans(ac->cmd); | |||
| if (ac->lua_cmd != LUA_NOREF) { | |||
| // TODO: what to print here? | |||
There was a problem hiding this comment.
Need to figure out what to print here.
| XFREE_CLEAR(ac->cmd); | ||
| } | ||
| au_need_clean = true; | ||
| } | ||
|
|
||
| // Delete one command from an autocmd pattern. | ||
| static void au_del_cmd(AutoCmd *ac) |
There was a problem hiding this comment.
This function was used only in a single place, I've figure out it's better w/o this indirection.
| assert(ac->lua_cmd != LUA_NOREF); | ||
| Array args = ARRAY_DICT_INIT; | ||
| executor_exec_lua_cb(ac->lua_cmd, "autocommand", args, false); | ||
| if (ac->once) { |
There was a problem hiding this comment.
That's slightly different semantics here — with VimL we mark command as removed before executing but here we are marking it as removed after we execute the callback.
I think I'm confused how cleanup of aucmds works now.
There was a problem hiding this comment.
It could make difference with both ++once and ++nested at the same time. I would suggest to "take" the reference, by saving ac->lua_cmd to a local varable and (when ++once ) setting ac->lua_cmd = LUA_NOREF before calling.
There was a problem hiding this comment.
Done, I've left code which frees lua ref in au_cleanup for "just in case" but my understanding is that it should free it at the moment of marking as deleted.
|
@andreypopp Do you have any desire to continue this PR? I think it would be a great feature to get merged. |
|
Unfortunately don’t have time to work on that right now, so if anyone could pick this up — that’d be great, the feature is very useful indeed. |
|
If nobody else can I try it? However, I'm not so familiar with C, so it may take some time. |
|
@h-michael wait a week and see if I can finish it :) If I can't, ping me again and you should try. I have started a little bit of work on it today. |
|
Working on this in #12378 . Will complete there. |
This PR adds new API
nvim_add_autocommandto register autocommands in Lua by provinding a Lua callback.