keymap.c File Reference

Keymap handling. More...

#include "config.h"
#include <ctype.h>
#include <limits.h>
#include <stdbool.h>
#include <stdlib.h>
#include <string.h>
#include "mutt/lib.h"
#include "gui/lib.h"
#include "keymap.h"

Include dependency graph for keymap.c:

Go to the source code of this file.

Functions
struct Keymap *	keymap_alloc (size_t len, keycode_t *keys)
	Allocate space for a sequence of keys.
void	keymap_free (struct Keymap **pptr)
	Free a Keymap.
void	keymaplist_free (struct KeymapList *kml)
	Free a List of Keymaps.
struct Keymap *	keymap_compare (struct Keymap *km1, struct Keymap *km2, size_t *pos)
	Compare two keymaps' keyscodes and return the bigger one.
void	keymap_get_name (int c, struct Buffer *buf)
	Get the human name for a key.
bool	keymap_expand_key (struct Keymap *km, struct Buffer *buf)
	Get the key string bound to a Keymap.
void	keymap_expand_string (const char *str, struct Buffer *buf)
	Get a human-readable key string.
int	parse_fkey (char *str)
	Parse a function key string.
int	parse_keycode (const char *str)
	Parse a numeric keycode.
size_t	parse_keys (const char *str, keycode_t *d, size_t max)
	Parse a key string into key codes.

Variables
struct Mapping	KeyNames []
	Key name lookup table.

Detailed Description

Keymap handling.

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 keymap.c.

Function Documentation

keymap_alloc()

struct Keymap * keymap_alloc	(	size_t	len,
		keycode_t *	keys )

Allocate space for a sequence of keys.

Parameters

len	Number of keys
keys	Array of keys

Return values

ptr	Sequence of keys

Definition at line 112 of file keymap.c.

{
  struct Keymap *km = MUTT_MEM_CALLOC(1, struct Keymap);
 
  km->len = len;
  km->keys = MUTT_MEM_CALLOC(len, keycode_t);
  memcpy(km->keys, keys, len * sizeof(keycode_t));
 
  return km;
}

Here is the caller graph for this function:

keymap_free()

void keymap_free

(

struct Keymap **

pptr

)

Free a Keymap.

Parameters

pptr	Keymap to free

Definition at line 127 of file keymap.c.

{
  if (!pptr || !*pptr)
    return;
 
  struct Keymap *km = *pptr;
  FREE(&km->macro);
  FREE(&km->desc);
  FREE(&km->keys);
 
  FREE(pptr);
}

Here is the caller graph for this function:

keymaplist_free()

void keymaplist_free

(

struct KeymapList *

kml

)

Free a List of Keymaps.

Parameters

kml	List of Keymaps to free

Definition at line 144 of file keymap.c.

{
  struct Keymap *km = NULL;
  struct Keymap *km_tmp = NULL;
  STAILQ_FOREACH_SAFE(km, kml, entries, km_tmp)
  {
    STAILQ_REMOVE(kml, km, Keymap, entries);
    keymap_free(&km);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

keymap_compare()

struct Keymap * keymap_compare	(	struct Keymap *	km1,
		struct Keymap *	km2,
		size_t *	pos )

Compare two keymaps' keyscodes and return the bigger one.

Parameters

[in]	km1	First keymap to compare
[in]	km2	Second keymap to compare
[out]	pos	Position where the two keycodes differ

Return values

ptr	Keymap with a bigger ASCII keycode

Definition at line 162 of file keymap.c.

{
  *pos = 0;
 
  while ((*pos < km1->len) && (*pos < km2->len))
  {
    if (km1->keys[*pos] < km2->keys[*pos])
      return km2;
 
    if (km1->keys[*pos] > km2->keys[*pos])
      return km1;
 
    *pos = *pos + 1;
  }
 
  return NULL;
}

Here is the caller graph for this function:

keymap_get_name()

void keymap_get_name	(	int	c,
		struct Buffer *	buf )

Get the human name for a key.

Parameters

[in]	c	Key code
[out]	buf	Buffer for the result

Definition at line 185 of file keymap.c.

{
  const char *name = mutt_map_get_name(c, KeyNames);
  if (name)
  {
    buf_addstr(buf, name);
    return;
  }
 
  if ((c < 256) && (c > -128) && iscntrl((unsigned char) c))
  {
    if (c < 0)
      c += 256;
 
    if (c < 128)
    {
      buf_addch(buf, '^');
      buf_addch(buf, (c + '@') & 0x7f);
    }
    else
    {
      buf_add_printf(buf, "\\%d%d%d", c >> 6, (c >> 3) & 7, c & 7);
    }
  }
  else if ((c >= KEY_F0) && (c < KEY_F(256))) /* this maximum is just a guess */
  {
    buf_add_printf(buf, "<F%d>", c - KEY_F0);
  }
  else if ((c < 256) && (c >= -128) && IsPrint(c))
  {
    buf_add_printf(buf, "%c", (unsigned char) c);
  }
  else
  {
    buf_add_printf(buf, "<%ho>", (unsigned short) c);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

keymap_expand_key()

bool keymap_expand_key	(	struct Keymap *	km,
		struct Buffer *	buf )

Get the key string bound to a Keymap.

Parameters

[in]	km	Keybinding map
[out]	buf	Buffer for the result

Return values

true

Success

Definition at line 229 of file keymap.c.

{
  if (!km || !buf)
    return false;
 
  for (int i = 0; i < km->len; i++)
  {
    keymap_get_name(km->keys[i], buf);
  }
 
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

keymap_expand_string()

void keymap_expand_string	(	const char *	str,
		struct Buffer *	buf )

Get a human-readable key string.

Parameters

[in]	str	Raw key string
[out]	buf	Buffer for the key string

Definition at line 247 of file keymap.c.

{
  for (; *str; str++)
  {
    keymap_get_name(*str, buf);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_fkey()

int parse_fkey

(

char *

str

)

Parse a function key string.

Parameters

str	String to parse

Return values

num	Number of the key
-1	Error

Given "<f8>", it will return 8.

Definition at line 263 of file keymap.c.

{
  char *t = NULL;
  int n = 0;
 
  if ((str[0] != '<') || (mutt_tolower(str[1]) != 'f'))
    return -1;
 
  for (t = str + 2; *t && mutt_isdigit(*t); t++)
  {
    n *= 10;
    n += *t - '0';
  }
 
  if (*t != '>')
    return -1;
  return n;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_keycode()

int parse_keycode

(

const char *

str

)

Parse a numeric keycode.

Parameters

str	String to parse

Return values

num	Number of the key

This function parses the string <NNN> and uses the octal value as the key to bind.

Definition at line 290 of file keymap.c.

{
  char *end_char = NULL;
  long int result = strtol(str + 1, &end_char, 8);
 
  /* allow trailing whitespace, eg.  < 1001 > */
  while (mutt_isspace(*end_char))
    end_char++;
 
  /* negative keycodes don't make sense, also detect overflow */
  if ((*end_char != '>') || (result < 0) || (result == LONG_MAX))
  {
    return -1;
  }
 
  return result;
}

Here is the call graph for this function:

Here is the caller graph for this function:

parse_keys()

size_t parse_keys	(	const char *	str,
		keycode_t *	d,
		size_t	max )

Parse a key string into key codes.

Parameters

str	Key string
d	Array for key codes
max	Maximum length of key sequence

Return values

num	Length of key sequence

Definition at line 315 of file keymap.c.

{
  int n;
  size_t len = max;
  char buf[128] = { 0 };
  char c;
  char *t = NULL;
 
  mutt_str_copy(buf, str, sizeof(buf));
  char *s = buf;
 
  while (*s && len)
  {
    *d = '\0';
    if ((*s == '<') && (t = strchr(s, '>')))
    {
      t++;
      c = *t;
      *t = '\0';
 
      n = mutt_map_get_value(s, KeyNames);
      if (n != -1)
      {
        s = t;
        *d = n;
      }
      else if ((n = parse_fkey(s)) > 0)
      {
        s = t;
        *d = KEY_F(n);
      }
      else if ((n = parse_keycode(s)) > 0)
      {
        s = t;
        *d = n;
      }
 
      *t = c;
    }
 
    if (!*d)
    {
      *d = (unsigned char) *s;
      s++;
    }
    d++;
    len--;
  }
 
  return max - len;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

KeyNames

struct Mapping KeyNames[]

Key name lookup table.

Definition at line 42 of file keymap.c.

                            {
  // clang-format off
  { "<PageUp>",      KEY_PPAGE },
  { "<PageDown>",    KEY_NPAGE },
  { "<Up>",          KEY_UP },
  { "<Down>",        KEY_DOWN },
  { "<Right>",       KEY_RIGHT },
  { "<Left>",        KEY_LEFT },
  { "<Delete>",      KEY_DC },
  { "<BackSpace>",   KEY_BACKSPACE },
  { "<Insert>",      KEY_IC },
  { "<Home>",        KEY_HOME },
  { "<End>",         KEY_END },
  { "<Enter>",       '\n' },
  { "<Return>",      '\r' },
#ifdef KEY_ENTER
  { "<KeypadEnter>", KEY_ENTER },
#else
  { "<KeypadEnter>", '\n' },
#endif
  { "<Esc>",         '\033' }, // Escape
  { "<Tab>",         '\t' },
  { "<Space>",       ' ' },
#ifdef KEY_BTAB
  { "<BackTab>",     KEY_BTAB },
#endif
#ifdef KEY_NEXT
  { "<Next>",        KEY_NEXT },
#endif
  /* extensions supported by ncurses.  values are filled in during initialization */
 
  /* CTRL+key */
  { "<C-Up>",    -1 },
  { "<C-Down>",  -1 },
  { "<C-Left>",  -1 },
  { "<C-Right>", -1 },
  { "<C-Home>",  -1 },
  { "<C-End>",   -1 },
  { "<C-Next>",  -1 },
  { "<C-Prev>",  -1 },
 
  /* SHIFT+key */
  { "<S-Up>",    -1 },
  { "<S-Down>",  -1 },
  { "<S-Left>",  -1 },
  { "<S-Right>", -1 },
  { "<S-Home>",  -1 },
  { "<S-End>",   -1 },
  { "<S-Next>",  -1 },
  { "<S-Prev>",  -1 },
 
  /* ALT+key */
  { "<A-Up>",    -1 },
  { "<A-Down>",  -1 },
  { "<A-Left>",  -1 },
  { "<A-Right>", -1 },
  { "<A-Home>",  -1 },
  { "<A-End>",   -1 },
  { "<A-Next>",  -1 },
  { "<A-Prev>",  -1 },
  { NULL, 0 },
  // clang-format off
};