Set up the key bindings. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <strings.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "ncrypt/lib.h"

Include dependency graph for init.c:

Go to the source code of this file.

Data Structures
struct	Extkey
	Map key names from NeoMutt's style to Curses style. More...

Functions
static const char *	find_ext_name (const char *key)
	Find the curses name for a key.

void	init_extended_keys (void)
	Initialise map of ncurses extended keys.

static void	create_bindings (const struct MenuOpSeq *map, enum MenuType mtype)
	Attach a set of keybindings to a Menu.

void	km_init (void)
	Initialise all the menu keybindings.

static void	mutt_keymaplist_free (struct KeymapList *km_list)
	Free a List of Keymaps.

void	mutt_keys_cleanup (void)
	Free the key maps.

void	mutt_init_abort_key (void)
	Parse the abort_key config string.

int	main_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.

Variables
const struct MenuOpSeq	AliasDefaultBindings []
	Key bindings for the Alias Menu.

const struct MenuOpSeq	AttachmentDefaultBindings []
	Key bindings for the Attachment Menu.

const struct MenuOpSeq	AutocryptDefaultBindings []
	Key bindings for the Autocrypt Account.

const struct MenuOpSeq	BrowserDefaultBindings []
	Key bindings for the file Browser Menu.

const struct MenuOpSeq	ComposeDefaultBindings []
	Key bindings for the Compose Menu.

const struct MenuOpSeq	EditorDefaultBindings []
	Key bindings for the Editor Menu.

const struct MenuOpSeq	IndexDefaultBindings []
	Key bindings for the Index Menu.

const struct MenuOpSeq	MixmasterDefaultBindings []
	Key bindings for the Mixmaster Menu.

const struct MenuOpSeq	PagerDefaultBindings []
	Key bindings for the Pager Menu.

const struct MenuOpSeq	PgpDefaultBindings []
	Key bindings for the Pgp Menu.

const struct MenuOpSeq	PostponedDefaultBindings []
	Key bindings for the Postpone Menu.

const struct MenuOpSeq	QueryDefaultBindings []
	Key bindings for the external Query Menu.

const struct MenuOpSeq	SmimeDefaultBindings []
	Key bindings for the Smime Menu.

static const struct Extkey	ExtKeys []
	Mapping between NeoMutt and Curses key names.

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

◆ find_ext_name()

static const char * find_ext_name ( const char * key )

static

Find the curses name for a key.

Parameters

key Key name

Return values

ptr	Curses name

Look up NeoMutt's name for a key and find the ncurses extended name for it.

Note: This returns a static string.

Definition at line 117 of file init.c.

{
  for (int j = 0; ExtKeys[j].name; j++)
  {
    if (strcasecmp(key, ExtKeys[j].name) == 0)
      return ExtKeys[j].sym;
  }
  return 0;
}

Here is the caller graph for this function:

◆ init_extended_keys()

void init_extended_keys ( void )

Initialise map of ncurses extended keys.

Determine the keycodes for ncurses extended keys and fill in the KeyNames array.

This function must be called after initscr(), or mutt_tigetstr() fails. This creates a bit of a chicken-and-egg problem because km_init() is called prior to start_curses(). This means that the default keybindings can't include any of the extended keys because they won't be defined until later.

Definition at line 137 of file init.c.

{
#ifdef HAVE_USE_EXTENDED_NAMES
  use_extended_names(true);
 
  for (int j = 0; KeyNames[j].name; j++)
  {
    if (KeyNames[j].value == -1)
    {
      const char *keyname = find_ext_name(KeyNames[j].name);
 
      if (keyname)
      {
        const char *s = mutt_tigetstr((char *) keyname);
        if (s && ((long) (s) != -1))
        {
          int code = key_defined(s);
          if (code > 0)
            KeyNames[j].value = code;
        }
      }
    }
  }
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create_bindings()

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

static

Attach a set of keybindings to a Menu.

Parameters

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

Definition at line 168 of file init.c.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ km_init()

void km_init ( void )

Initialise all the menu keybindings.

Definition at line 180 of file init.c.

{
  memset(Keymaps, 0, sizeof(struct KeymapList) * MENU_MAX);
 
  create_bindings(AliasDefaultBindings, MENU_ALIAS);
  create_bindings(AttachmentDefaultBindings, MENU_ATTACHMENT);
#ifdef USE_AUTOCRYPT
  create_bindings(AutocryptDefaultBindings, MENU_AUTOCRYPT);
#endif
  create_bindings(BrowserDefaultBindings, MENU_FOLDER);
  create_bindings(DialogDefaultBindings, MENU_DIALOG);
  create_bindings(ComposeDefaultBindings, MENU_COMPOSE);
  create_bindings(EditorDefaultBindings, MENU_EDITOR);
  create_bindings(GenericDefaultBindings, MENU_GENERIC);
  create_bindings(IndexDefaultBindings, MENU_INDEX);
#ifdef MIXMASTER
  create_bindings(MixmasterDefaultBindings, MENU_MIXMASTER);
#endif
  create_bindings(PagerDefaultBindings, MENU_PAGER);
  create_bindings(PostponedDefaultBindings, MENU_POSTPONED);
  create_bindings(QueryDefaultBindings, MENU_QUERY);
 
  if (WithCrypto & APPLICATION_PGP)
    create_bindings(PgpDefaultBindings, MENU_PGP);
  if (WithCrypto & APPLICATION_SMIME)
    create_bindings(SmimeDefaultBindings, MENU_SMIME);
 
#ifdef CRYPT_BACKEND_GPGME
  create_bindings(PgpDefaultBindings, MENU_KEY_SELECT_PGP);
  create_bindings(SmimeDefaultBindings, MENU_KEY_SELECT_SMIME);
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_keymaplist_free()

static void mutt_keymaplist_free ( struct KeymapList * km_list )

static

Free a List of Keymaps.

Parameters

km_list List of Keymaps to free

Definition at line 217 of file init.c.

{
  struct Keymap *np = NULL, *tmp = NULL;
  STAILQ_FOREACH_SAFE(np, km_list, entries, tmp)
  {
    STAILQ_REMOVE(km_list, np, Keymap, entries);
    mutt_keymap_free(&np);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_keys_cleanup()

void mutt_keys_cleanup ( void )

Free the key maps.

Definition at line 230 of file init.c.

{
  for (enum MenuType i = 1; i < MENU_MAX; i++)
  {
    mutt_keymaplist_free(&Keymaps[i]);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mutt_init_abort_key()

void mutt_init_abort_key ( void )

Parse the abort_key config string.

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

Definition at line 243 of file init.c.

{
  keycode_t buf[2];
  const char *const c_abort_key = cs_subset_string(NeoMutt->sub, "abort_key");
  size_t len = parsekeys(c_abort_key, buf, mutt_array_size(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];
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ AliasDefaultBindings

const struct MenuOpSeq AliasDefaultBindings[]

extern

Key bindings for the Alias Menu.

Definition at line 88 of file functions.c.

◆ AttachmentDefaultBindings

const struct MenuOpSeq AttachmentDefaultBindings[]

extern

Key bindings for the Attachment Menu.

Definition at line 100 of file functions.c.

◆ AutocryptDefaultBindings

const struct MenuOpSeq AutocryptDefaultBindings[]

extern

Key bindings for the Autocrypt Account.

Definition at line 66 of file functions.c.

◆ BrowserDefaultBindings

const struct MenuOpSeq BrowserDefaultBindings[]

extern

Key bindings for the file Browser Menu.

Definition at line 108 of file functions.c.

◆ ComposeDefaultBindings

const struct MenuOpSeq ComposeDefaultBindings[]

extern

Key bindings for the Compose Menu.

Definition at line 159 of file functions.c.

◆ EditorDefaultBindings

const struct MenuOpSeq EditorDefaultBindings[]

extern

Key bindings for the Editor Menu.

Definition at line 88 of file functions.c.

◆ IndexDefaultBindings

const struct MenuOpSeq IndexDefaultBindings[]

extern

Key bindings for the Index Menu.

Definition at line 239 of file functions.c.

◆ MixmasterDefaultBindings

const struct MenuOpSeq MixmasterDefaultBindings[]

extern

Key bindings for the Mixmaster Menu.

Definition at line 65 of file functions.c.

◆ PagerDefaultBindings

const struct MenuOpSeq PagerDefaultBindings[]

extern

Key bindings for the Pager Menu.

Definition at line 229 of file functions.c.

◆ PgpDefaultBindings

const struct MenuOpSeq PgpDefaultBindings[]

extern

Key bindings for the Pgp Menu.

Definition at line 64 of file functions.c.

◆ PostponedDefaultBindings

const struct MenuOpSeq PostponedDefaultBindings[]

extern

Key bindings for the Postpone Menu.

Definition at line 62 of file functions.c.

◆ QueryDefaultBindings

const struct MenuOpSeq QueryDefaultBindings[]

extern

Key bindings for the external Query Menu.

Definition at line 103 of file functions.c.

◆ SmimeDefaultBindings

const struct MenuOpSeq SmimeDefaultBindings[]

extern

Key bindings for the Smime Menu.

Definition at line 74 of file functions.c.

◆ ExtKeys

const struct Extkey ExtKeys[]

static

Mapping between NeoMutt and Curses key names.

Definition at line 72 of file init.c.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ find_ext_name()

◆ init_extended_keys()

◆ create_bindings()

◆ km_init()

◆ mutt_keymaplist_free()

◆ mutt_keys_cleanup()

◆ mutt_init_abort_key()

Variable Documentation

◆ AliasDefaultBindings

◆ AttachmentDefaultBindings

◆ AutocryptDefaultBindings

◆ BrowserDefaultBindings

◆ ComposeDefaultBindings

◆ EditorDefaultBindings

◆ IndexDefaultBindings

◆ MixmasterDefaultBindings

◆ PagerDefaultBindings

◆ PgpDefaultBindings

◆ PostponedDefaultBindings

◆ QueryDefaultBindings

◆ SmimeDefaultBindings

◆ ExtKeys