feat: add "default" field to maparg() return value #28527
Conversation
With so many default mappings, plugins are not able to detect if an existing mapping is one created by the user or one created by Nvim. Add a "default" field to the dict return value of maparg() that plugins can use to determine if a mapping is a default mapping provided by Nvim (which they can safely override).
| /// Whether new mappings should be marked as "default". This is modified only in map_set_default(). | ||
| static bool create_default_maps; | ||
|
|
||
| /// Enable or disable creationg of default mappings. |
The reason for choosing to set default mappings instead of creating builtins was because this shouldn't matter. Builtin default mappings are just like any other plugin default mappings.
And what would the plugin do with that information? Users can |
How could it not matter? A mapping created by the user and a mapping that comes bundled with Neovim are different. Well-behaved plugins use
Plugins use this information to determine if a mapping was set by the user or not. A plugin can override a default Nvim mapping harmlessly, but a plugin should not override a user's own mapping. |
There was a problem hiding this comment.
This may not be a good idea. For default autocommands their augroups have a common nvim_ prefix. For mappings there is a proposal for namespaced mappings. If namespaced mappings are implemented, default mappings can be in namespaces with specific names, and this field will become redundant again.
src/nvim/mapping.c
Outdated
| @@ -2118,6 +2130,7 @@ static Dictionary mapblock_fill_dict(const mapblock_T *const mp, const char *lhs | |||
| PUT_C(dict, "mode", CSTR_AS_OBJ(mapmode)); | |||
| PUT_C(dict, "abbr", INTEGER_OBJ(abbr ? 1 : 0)); | |||
| PUT_C(dict, "mode_bits", INTEGER_OBJ(mp->m_mode)); | |||
| PUT_C(dict, "default", BOOLEAN_OBJ(mp->m_default)); | |||
There was a problem hiding this comment.
It may be a bit inconsistent for this to be a boolean as there are no other boolean fields. For consistency this should be an integer, but that's inconvenient for Lua plugins. Since this is mostly likely to be used by Lua plugins, maybe it should be like this:
| PUT_C(dict, "default", BOOLEAN_OBJ(mp->m_default)); | |
| if (mp->m_default) { | |
| PUT_C(dict, "default", INTEGER_OBJ(1)); | |
| } |
In future it may also be possible for the default field to have a different type (e.g. string) to provide more information, in which case a missing default field indicating a non-default mapping makes more sense.
There was a problem hiding this comment.
Changed as suggested d72a4be.
Even with namespaces, we would need a way to designate that a mapping is "bundled" with Nvim, since anybody (including a plugin) could just add a new mapping to the "defaults" namespace. |
|
what about other default mappings, e.g. |
With so many default mappings, plugins are not able to detect if an existing mapping is one created by the user or one created by Nvim.
Add a "default" field to the dict return value of maparg() that plugins can use to determine if a mapping is a default mapping provided by Nvim (which they can safely override).