init.h File Reference

Set up the key bindings. More...

#include "keymap.h"
#include "menu.h"

Include dependency graph for init.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	km_init (void)
	Initialise all the menu keybindings.
void	km_menu_add_bindings (const struct MenuOpSeq *map, enum MenuType mtype)
	Attach a set of keybindings to a Menu.
void	km_set_abort_key (void)
	Parse the abort_key config string.
void	km_cleanup (void)
	Free the key maps.

Variables
keycode_t	AbortKey
	key to abort edits etc, normally Ctrl-G

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.h.

Function Documentation

km_init()

void km_init

(

void

)

Initialise all the menu keybindings.

Definition at line 91 of file init.c.

{
  memset(Keymaps, 0, sizeof(struct KeymapList) * MENU_MAX);
 
  commands_register(&NeoMutt->commands, KeyCommands);
}

Here is the call graph for this function:

Here is the caller graph for this function:

km_menu_add_bindings()

void km_menu_add_bindings	(	const struct MenuOpSeq *	map,
		enum MenuType	mtype )

Attach a set of keybindings to a Menu.

Parameters

map	Key bindings
mtype	Menu type, e.g. MENU_PAGER

Definition at line 45 of file init.c.

{
  STAILQ_INIT(&Keymaps[mtype]);
 
  for (int i = 0; map[i].op != OP_NULL; i++)
    if (map[i].seq)
      km_bind(map[i].seq, mtype, map[i].op, NULL, NULL, NULL);
}

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

(

void

)

Parse the abort_key config string.

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

Definition at line 137 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"));
    AbortKey = ctrl('G');
    return;
  }
 
  if (len > 1)
  {
    mutt_warning(_("Specified abort key sequence (%s) will be truncated to first key"),
                 c_abort_key);
  }
  AbortKey = buf[0];
 
  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_cleanup()

void km_cleanup

(

void

)

Free the key maps.

Definition at line 121 of file init.c.

{
  for (enum MenuType i = 1; i < MENU_MAX; i++)
  {
    keymaplist_free(&Keymaps[i]);
  }
 
  if (NeoMutt && NeoMutt->sub)
    notify_observer_remove(NeoMutt->sub->notify, km_config_observer, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

AbortKey

keycode_t AbortKey

extern

key to abort edits etc, normally Ctrl-G

key to abort edits etc, normally Ctrl-G

Definition at line 38 of file init.c.