init.c File Reference

Set up the key bindings. More...

#include "config.h"
#include <string.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "init.h"
#include "commands.h"
#include "keymap.h"
#include "menu.h"
#include "menudef.h"
#include "module_data.h"

Include dependency graph for init.c:

Go to the source code of this file.

Functions
struct SubMenu *	km_register_submenu (const struct MenuFuncOp functions[])
	Register a submenu.
struct MenuDefinition *	km_register_menu (int menu, const char *name)
	Register a menu.
void	km_menu_add_submenu (struct MenuDefinition *md, struct SubMenu *sm)
	Add a SubMenu to a Menu Definition.
void	km_menu_add_bindings (struct MenuDefinition *md, const struct MenuOpSeq bindings[])
	Add Keybindings to a Menu.
int	km_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
void	km_init (struct KeyModuleData *mod_data)
	Initialise all the menu keybindings.
static int	menu_defs_sort (const void *a, const void *b, void *sdata)
	Compare two MenuDefinitions by their names - Implements sort_t -.
void	km_sort (void)
	Sort all the menu keybindings.
void	km_cleanup (struct KeyModuleData *mod_data)
	Free the key maps.
void	km_set_abort_key (keycode_t *abort_key)
	Parse the abort_key config string.

Variables
const struct Command	KeyCommands []
	All the registered Menus - moved to KeyModuleData All the registered SubMenus - moved to KeyModuleData AbortKey - moved to KeyModuleData.

Detailed Description

Set up the key bindings.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file init.c.

Function Documentation

km_register_submenu()

struct SubMenu * km_register_submenu

(

const struct MenuFuncOp

functions[]

)

Register a submenu.

Parameters

functions

Function definitions

Return values

ptr

SubMenu

Register a set of functions. The result can be used in multiple Menus.

Definition at line 88 of file init.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  struct SubMenu *sm = submenu_new();
  sm->functions = functions;
  ARRAY_INIT(&sm->keymaps);
 
  ARRAY_ADD(&mod_data->sub_menus, sm);
  return *ARRAY_LAST(&mod_data->sub_menus);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_register_menu()

struct MenuDefinition * km_register_menu	(	int	menu,
		const char *	name )

Register a menu.

Parameters

menu	Menu Type, e.g. MENU_INDEX
name	Menu name, e.g. "index"

Return values

ptr	Menu Definition

Definition at line 105 of file init.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
 
  struct MenuDefinition *md = menudef_new();
  md->id = menu;
  md->name = mutt_str_dup(name);
  ARRAY_INIT(&md->submenus);
 
  ARRAY_ADD(&mod_data->menu_defs, md);
  return *ARRAY_LAST(&mod_data->menu_defs);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_menu_add_submenu()

void km_menu_add_submenu	(	struct MenuDefinition *	md,
		struct SubMenu *	sm )

Add a SubMenu to a Menu Definition.

Parameters

md	Menu Definition
sm	SubMenu to add

Definition at line 123 of file init.c.

{
  if (!sm->parent)
    sm->parent = md;
 
  ARRAY_ADD(&md->submenus, sm);
}

Here is the caller graph for this function:

km_menu_add_bindings()

void km_menu_add_bindings	(	struct MenuDefinition *	md,
		const struct MenuOpSeq	bindings[] )

Add Keybindings to a Menu.

Parameters

md	Menu Definition
bindings	Keybindings to add

Definition at line 136 of file init.c.

{
  for (int i = 0; bindings[i].op != OP_NULL; i++)
  {
    if (bindings[i].seq)
    {
      km_bind(md, bindings[i].seq, bindings[i].op, NULL, NULL, NULL);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_init()

void km_init

(

struct KeyModuleData *

mod_data

)

Initialise all the menu keybindings.

Parameters

mod_data

Key module data

Definition at line 172 of file init.c.

{
  ARRAY_INIT(&mod_data->menu_defs);
  ARRAY_INIT(&mod_data->sub_menus);
  mod_data->key_names = keymap_get_key_names();
 
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, km_config_observer, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_sort()

void km_sort

(

void

)

Sort all the menu keybindings.

Definition at line 195 of file init.c.

{
  struct KeyModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_KEY);
  ARRAY_SORT(&mod_data->menu_defs, menu_defs_sort, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_cleanup()

void km_cleanup

(

struct KeyModuleData *

mod_data

)

Free the key maps.

Parameters

mod_data

Key module data

Definition at line 205 of file init.c.

{
  if (NeoMutt && NeoMutt->sub)
    notify_observer_remove(NeoMutt->sub->notify, km_config_observer, NULL);
 
  struct MenuDefinition **mdp = NULL;
  ARRAY_FOREACH(mdp, &mod_data->menu_defs)
  {
    menudef_free(mdp);
  }
  ARRAY_FREE(&mod_data->menu_defs);
 
  struct SubMenu **smp = NULL;
  ARRAY_FOREACH(smp, &mod_data->sub_menus)
  {
    submenu_free(smp);
  }
  ARRAY_FREE(&mod_data->sub_menus);
 
  ARRAY_FREE(&mod_data->macro_events);
  ARRAY_FREE(&mod_data->unget_key_events);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_set_abort_key()

void km_set_abort_key

(

keycode_t *

abort_key

)

Parse the abort_key config string.

Parameters

abort_key

Pointer to the abort key variable to set

Parse the string into $abort_key and put the keycode into AbortKey.

Definition at line 234 of file init.c.

{
  keycode_t buf[4] = { 0 };
  const char *const c_abort_key = cs_subset_string(NeoMutt->sub, "abort_key");
 
  size_t len = parse_keys(c_abort_key, buf, countof(buf));
  if (len == 0)
  {
    mutt_error(_("Abort key is not set, defaulting to Ctrl-G"));
    *abort_key = ctrl('G');
    return;
  }
 
  if (len > 1)
  {
    mutt_warning(_("Specified abort key sequence (%s) will be truncated to first key"),
                 c_abort_key);
  }
  *abort_key = buf[0];
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

KeyCommands

const struct Command KeyCommands[]

Initial value:

= {
  
  { "bind", CMD_BIND, parse_bind,
        N_("Bind a key to a function"),
        N_("bind <map>[,<map> ... ] <key> <function>"),
        "configuration.html#bind" },
  { "exec", CMD_EXEC, parse_exec,
        N_("Execute a function"),
        N_("exec <function> [ <function> ... ]"),
        "configuration.html#exec" },
  { "macro", CMD_MACRO, parse_macro,
        N_("Define a keyboard macro"),
        N_("macro <map>[,<map> ... ] <key> <sequence> [ <description> ]"),
        "configuration.html#macro" },
  { "push", CMD_PUSH, parse_push,
        N_("Push a string into NeoMutt's input queue (simulate typing)"),
        N_("push <string>"),
        "configuration.html#push" },
  { "unbind", CMD_UNBIND, parse_unbind,
        N_("Remove a key binding"),
        N_("unbind { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unbind" },
  { "unmacro", CMD_UNMACRO, parse_unbind,
        N_("Remove a keyboard `macro`"),
        N_("unmacro { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unmacro" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  
}

All the registered Menus - moved to KeyModuleData All the registered SubMenus - moved to KeyModuleData AbortKey - moved to KeyModuleData.

Key Binding Commands

Definition at line 49 of file init.c.

                                     {
  // clang-format off
  { "bind", CMD_BIND, parse_bind,
        N_("Bind a key to a function"),
        N_("bind <map>[,<map> ... ] <key> <function>"),
        "configuration.html#bind" },
  { "exec", CMD_EXEC, parse_exec,
        N_("Execute a function"),
        N_("exec <function> [ <function> ... ]"),
        "configuration.html#exec" },
  { "macro", CMD_MACRO, parse_macro,
        N_("Define a keyboard macro"),
        N_("macro <map>[,<map> ... ] <key> <sequence> [ <description> ]"),
        "configuration.html#macro" },
  { "push", CMD_PUSH, parse_push,
        N_("Push a string into NeoMutt's input queue (simulate typing)"),
        N_("push <string>"),
        "configuration.html#push" },
  { "unbind", CMD_UNBIND, parse_unbind,
        N_("Remove a key binding"),
        N_("unbind { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unbind" },
  { "unmacro", CMD_UNMACRO, parse_unbind,
        N_("Remove a keyboard `macro`"),
        N_("unmacro { * | <map>[,<map> ... ] } [ <key> ]"),
        "configuration.html#unmacro" },
 
  { NULL, CMD_NONE, NULL, NULL, NULL, NULL, CF_NONE },
  // clang-format on
};