NeoMutt  2019-12-07-168-gc45f47
Teaching an old dog new tricks
DOXYGEN
keymap.h File Reference

Manage keymappings. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "mutt_commands.h"
+ Include dependency graph for keymap.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  Keymap
 A keyboard mapping. More...
 
struct  KeyEvent
 An event such as a keypress. More...
 
struct  Binding
 Mapping between a user key and a function. More...
 

Macros

#define MUTT_UNBIND   1<<0
 
#define MUTT_UNMACRO   1<<1
 
#define MAX_SEQ   8
 

Typedefs

typedef short keycode_t
 

Enumerations

enum  MenuType {
  MENU_ALIAS, MENU_ATTACH, MENU_COMPOSE, MENU_EDITOR,
  MENU_FOLDER, MENU_GENERIC, MENU_MAIN, MENU_PAGER,
  MENU_POSTPONE, MENU_QUERY, MENU_PGP, MENU_SMIME,
  MENU_MIX, MENU_AUTOCRYPT_ACCT, MENU_MAX
}
 Types of GUI selections. More...
 

Functions

void init_extended_keys (void)
 Initialise map of ncurses extended keys. More...
 
int km_expand_key (char *s, size_t len, struct Keymap *map)
 Get the key string bound to a Keymap. More...
 
struct Keymapkm_find_func (enum MenuType menu, int func)
 Find a function's mapping in a Menu. More...
 
void km_init (void)
 Initialise all the menu keybindings. More...
 
void km_error_key (enum MenuType menu)
 Handle an unbound key sequence. More...
 
void mutt_what_key (void)
 Ask the user to press a key. More...
 
enum CommandResult km_bind (char *s, enum MenuType menu, int op, char *macro, char *desc)
 Bind a key to a macro. More...
 
int km_dokey (enum MenuType menu)
 Determine what a keypress should do. More...
 
const struct Bindingkm_get_table (enum MenuType menu)
 Lookup a menu's keybindings. More...
 
const char * mutt_get_func (const struct Binding *bindings, int op)
 Get the name of a function. More...
 
void mutt_keys_free (void)
 Free the key maps. More...
 
enum CommandResult mutt_parse_bind (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'bind' command - Implements command_t. More...
 
enum CommandResult mutt_parse_exec (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'exec' command - Implements command_t. More...
 
enum CommandResult mutt_parse_macro (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'macro' command - Implements command_t. More...
 
enum CommandResult mutt_parse_push (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'push' command - Implements command_t. More...
 
enum CommandResult mutt_parse_unbind (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 Parse the 'unbind' command - Implements command_t. More...
 
enum CommandResult mutt_parse_unmacro (struct Buffer *buf, struct Buffer *s, unsigned long data, struct Buffer *err)
 

Variables

struct KeymapKeymaps []
 Array of Keymap keybindings, one for each Menu. More...
 
int LastKey
 Last real key pressed, recorded by dokey() More...
 
const struct Mapping Menus []
 Menu name lookup table. More...
 

Detailed Description

Manage keymappings.

Authors
  • Michael R. Elkins

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

Macro Definition Documentation

◆ MUTT_UNBIND

#define MUTT_UNBIND   1<<0

Definition at line 31 of file keymap.h.

◆ MUTT_UNMACRO

#define MUTT_UNMACRO   1<<1

Definition at line 32 of file keymap.h.

◆ MAX_SEQ

#define MAX_SEQ   8

Definition at line 34 of file keymap.h.

Typedef Documentation

◆ keycode_t

typedef short keycode_t

Definition at line 37 of file keymap.h.

Enumeration Type Documentation

◆ MenuType

enum MenuType

Types of GUI selections.

Enumerator
MENU_ALIAS 

Select an email address by its alias.

MENU_ATTACH 

Select an attachment.

MENU_COMPOSE 

Compose an email.

MENU_EDITOR 

Text entry area.

MENU_FOLDER 

General file/mailbox browser.

MENU_GENERIC 

Generic selection list.

MENU_MAIN 

Index panel (list of emails)

MENU_PAGER 

Pager pager (email viewer)

MENU_POSTPONE 

Select a postponed email.

MENU_QUERY 

Select from results of external query.

MENU_PGP 

PGP encryption menu.

MENU_SMIME 

SMIME encryption menu.

MENU_MIX 

Create/edit a Mixmaster chain.

MENU_AUTOCRYPT_ACCT 
MENU_MAX 

Definition at line 69 of file keymap.h.

70 {
71  MENU_ALIAS,
72  MENU_ATTACH,
73  MENU_COMPOSE,
74  MENU_EDITOR,
75  MENU_FOLDER,
76  MENU_GENERIC,
77  MENU_MAIN,
78  MENU_PAGER,
80  MENU_QUERY,
81  MENU_PGP,
82  MENU_SMIME,
83 #ifdef CRYPT_BACKEND_GPGME
84  MENU_KEY_SELECT_PGP,
85  MENU_KEY_SELECT_SMIME,
86 #endif
87 #ifdef MIXMASTER
88  MENU_MIX,
89 #endif
90 #ifdef USE_AUTOCRYPT
92 #endif
93  MENU_MAX,
94 };
PGP encryption menu.
Definition: keymap.h:81
General file/mailbox browser.
Definition: keymap.h:75
Compose an email.
Definition: keymap.h:73
Index panel (list of emails)
Definition: keymap.h:77
SMIME encryption menu.
Definition: keymap.h:82
Pager pager (email viewer)
Definition: keymap.h:78
Select from results of external query.
Definition: keymap.h:80
Select an attachment.
Definition: keymap.h:72
Select an email address by its alias.
Definition: keymap.h:71
Create/edit a Mixmaster chain.
Definition: keymap.h:88
Text entry area.
Definition: keymap.h:74
Select a postponed email.
Definition: keymap.h:79
Generic selection list.
Definition: keymap.h:76

Function Documentation

◆ 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 tigetstr() returns -1. 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 895 of file keymap.c.

896 {
897 #ifdef NCURSES_VERSION
898 
899  use_extended_names(true);
900 
901  for (int j = 0; KeyNames[j].name; j++)
902  {
903  if (KeyNames[j].value == -1)
904  {
905  const char *keyname = find_ext_name(KeyNames[j].name);
906 
907  if (keyname)
908  {
909  char *s = tigetstr((char *) keyname);
910  if (s && ((long) (s) != -1))
911  {
912  int code = key_defined(s);
913  if (code > 0)
914  KeyNames[j].value = code;
915  }
916  }
917  }
918  }
919 #endif
920 }
int value
Definition: mapping.h:32
const char * name
Definition: pgpmicalg.c:46
static struct Mapping KeyNames[]
Key name lookup table.
Definition: keymap.c:86
const char * name
Definition: mapping.h:31
+ Here is the caller graph for this function:

◆ km_expand_key()

int km_expand_key ( char *  s,
size_t  len,
struct Keymap map 
)

Get the key string bound to a Keymap.

Parameters
sBuffer for the key string
lenLength of buffer
mapKeybinding map
Return values
1Success
0Error

Definition at line 826 of file keymap.c.

827 {
828  if (!map)
829  return 0;
830 
831  int p = 0;
832 
833  while (true)
834  {
835  mutt_str_strfcpy(s, km_keyname(map->keys[p]), len);
836  const size_t l = mutt_str_strlen(s);
837  len -= l;
838 
839  if ((++p >= map->len) || !len)
840  return 1;
841 
842  s += l;
843  }
844 
845  /* not reached */
846 }
static const char * km_keyname(int c)
Get the human name for a key.
Definition: keymap.c:787
keycode_t * keys
key sequence
Definition: keymap.h:54
size_t mutt_str_strlen(const char *a)
Calculate the length of a string, safely.
Definition: string.c:689
size_t mutt_str_strfcpy(char *dest, const char *src, size_t dsize)
Copy a string into a buffer (guaranteeing NUL-termination)
Definition: string.c:773
short len
length of key sequence (unit: sizeof (keycode_t))
Definition: keymap.h:53
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ km_find_func()

struct Keymap* km_find_func ( enum MenuType  menu,
int  func 
)

Find a function's mapping in a Menu.

Parameters
menuMenu id, e.g. MENU_PAGER
funcFunction, e.g. OP_DELETE
Return values
ptrKeymap for the function

Definition at line 854 of file keymap.c.

855 {
856  struct Keymap *map = Keymaps[menu];
857 
858  for (; map; map = map->next)
859  if (map->op == func)
860  break;
861  return map;
862 }
struct Keymap * Keymaps[MENU_MAX]
Array of Keymap keybindings, one for each Menu.
Definition: keymap.c:147
short op
operation to perform
Definition: keymap.h:51
struct Keymap * next
next key in map
Definition: keymap.h:50
A keyboard mapping.
Definition: keymap.h:46
+ Here is the caller graph for this function:

◆ km_init()

void km_init ( void  )

Initialise all the menu keybindings.

Definition at line 925 of file keymap.c.

926 {
927  memset(Keymaps, 0, sizeof(struct Keymap *) * MENU_MAX);
928 
937 
940 
943 
944 #ifdef CRYPT_BACKEND_GPGME
945  create_bindings(OpPgp, MENU_KEY_SELECT_PGP);
946  create_bindings(OpSmime, MENU_KEY_SELECT_SMIME);
947 #endif
948 
949 #ifdef MIXMASTER
951 
952  km_bindkey("<space>", MENU_MIX, OP_GENERIC_SELECT_ENTRY);
953  km_bindkey("h", MENU_MIX, OP_MIX_CHAIN_PREV);
954  km_bindkey("l", MENU_MIX, OP_MIX_CHAIN_NEXT);
955 #endif
956 
957 #ifdef USE_AUTOCRYPT
959 #endif
960 
961  /* bindings for the line editor */
963 
964  km_bindkey("<up>", MENU_EDITOR, OP_EDITOR_HISTORY_UP);
965  km_bindkey("<down>", MENU_EDITOR, OP_EDITOR_HISTORY_DOWN);
966  km_bindkey("<left>", MENU_EDITOR, OP_EDITOR_BACKWARD_CHAR);
967  km_bindkey("<right>", MENU_EDITOR, OP_EDITOR_FORWARD_CHAR);
968  km_bindkey("<home>", MENU_EDITOR, OP_EDITOR_BOL);
969  km_bindkey("<end>", MENU_EDITOR, OP_EDITOR_EOL);
970  km_bindkey("<backspace>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
971  km_bindkey("<delete>", MENU_EDITOR, OP_EDITOR_DELETE_CHAR);
972  km_bindkey("\177", MENU_EDITOR, OP_EDITOR_BACKSPACE);
973 
974  /* generic menu keymap */
976 
977  km_bindkey("<home>", MENU_GENERIC, OP_FIRST_ENTRY);
978  km_bindkey("<end>", MENU_GENERIC, OP_LAST_ENTRY);
979  km_bindkey("<pagedown>", MENU_GENERIC, OP_NEXT_PAGE);
980  km_bindkey("<pageup>", MENU_GENERIC, OP_PREV_PAGE);
981  km_bindkey("<right>", MENU_GENERIC, OP_NEXT_PAGE);
982  km_bindkey("<left>", MENU_GENERIC, OP_PREV_PAGE);
983  km_bindkey("<up>", MENU_GENERIC, OP_PREV_ENTRY);
984  km_bindkey("<down>", MENU_GENERIC, OP_NEXT_ENTRY);
985  km_bindkey("1", MENU_GENERIC, OP_JUMP);
986  km_bindkey("2", MENU_GENERIC, OP_JUMP);
987  km_bindkey("3", MENU_GENERIC, OP_JUMP);
988  km_bindkey("4", MENU_GENERIC, OP_JUMP);
989  km_bindkey("5", MENU_GENERIC, OP_JUMP);
990  km_bindkey("6", MENU_GENERIC, OP_JUMP);
991  km_bindkey("7", MENU_GENERIC, OP_JUMP);
992  km_bindkey("8", MENU_GENERIC, OP_JUMP);
993  km_bindkey("9", MENU_GENERIC, OP_JUMP);
994 
995  km_bindkey("<return>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
996  km_bindkey("<enter>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
997 
998  /* Miscellaneous extra bindings */
999 
1000  km_bindkey(" ", MENU_MAIN, OP_DISPLAY_MESSAGE);
1001  km_bindkey("<up>", MENU_MAIN, OP_MAIN_PREV_UNDELETED);
1002  km_bindkey("<down>", MENU_MAIN, OP_MAIN_NEXT_UNDELETED);
1003  km_bindkey("J", MENU_MAIN, OP_NEXT_ENTRY);
1004  km_bindkey("K", MENU_MAIN, OP_PREV_ENTRY);
1005  km_bindkey("x", MENU_MAIN, OP_EXIT);
1006 
1007  km_bindkey("<return>", MENU_MAIN, OP_DISPLAY_MESSAGE);
1008  km_bindkey("<enter>", MENU_MAIN, OP_DISPLAY_MESSAGE);
1009 
1010  km_bindkey("x", MENU_PAGER, OP_EXIT);
1011  km_bindkey("i", MENU_PAGER, OP_EXIT);
1012  km_bindkey("<backspace>", MENU_PAGER, OP_PREV_LINE);
1013  km_bindkey("<pagedown>", MENU_PAGER, OP_NEXT_PAGE);
1014  km_bindkey("<pageup>", MENU_PAGER, OP_PREV_PAGE);
1015  km_bindkey("<up>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
1016  km_bindkey("<right>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
1017  km_bindkey("<down>", MENU_PAGER, OP_MAIN_NEXT_UNDELETED);
1018  km_bindkey("<left>", MENU_PAGER, OP_MAIN_PREV_UNDELETED);
1019  km_bindkey("<home>", MENU_PAGER, OP_PAGER_TOP);
1020  km_bindkey("<end>", MENU_PAGER, OP_PAGER_BOTTOM);
1021  km_bindkey("1", MENU_PAGER, OP_JUMP);
1022  km_bindkey("2", MENU_PAGER, OP_JUMP);
1023  km_bindkey("3", MENU_PAGER, OP_JUMP);
1024  km_bindkey("4", MENU_PAGER, OP_JUMP);
1025  km_bindkey("5", MENU_PAGER, OP_JUMP);
1026  km_bindkey("6", MENU_PAGER, OP_JUMP);
1027  km_bindkey("7", MENU_PAGER, OP_JUMP);
1028  km_bindkey("8", MENU_PAGER, OP_JUMP);
1029  km_bindkey("9", MENU_PAGER, OP_JUMP);
1030 
1031  km_bindkey("<return>", MENU_PAGER, OP_NEXT_LINE);
1032  km_bindkey("<enter>", MENU_PAGER, OP_NEXT_LINE);
1033 
1034  km_bindkey("<return>", MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
1035  km_bindkey("<enter>", MENU_ALIAS, OP_GENERIC_SELECT_ENTRY);
1036  km_bindkey("<space>", MENU_ALIAS, OP_TAG);
1037 
1038  km_bindkey("<return>", MENU_ATTACH, OP_VIEW_ATTACH);
1039  km_bindkey("<enter>", MENU_ATTACH, OP_VIEW_ATTACH);
1040  km_bindkey("<return>", MENU_COMPOSE, OP_VIEW_ATTACH);
1041  km_bindkey("<enter>", MENU_COMPOSE, OP_VIEW_ATTACH);
1042 
1043  /* edit-to (default "t") hides generic tag-entry in Compose menu
1044  * This will bind tag-entry to "T" in the Compose menu */
1045  km_bindkey("T", MENU_COMPOSE, OP_TAG);
1046 }
const struct Binding OpPager[]
Key bindings for the pager menu.
Definition: functions.c:262
PGP encryption menu.
Definition: keymap.h:81
#define WithCrypto
Definition: lib.h:161
const struct Binding OpPgp[]
Key bindings for the pgp menu.
Definition: functions.c:636
struct Keymap * Keymaps[MENU_MAX]
Array of Keymap keybindings, one for each Menu.
Definition: keymap.c:147
General file/mailbox browser.
Definition: keymap.h:75
Compose an email.
Definition: keymap.h:73
Index panel (list of emails)
Definition: keymap.h:77
const struct Binding OpCompose[]
Key bindings for the compose menu.
Definition: functions.c:452
const struct Binding OpSmime[]
Key bindings for the smime menu.
Definition: functions.c:645
static enum CommandResult km_bindkey(const char *s, enum MenuType menu, int op)
Bind a key in a Menu to an operation.
Definition: keymap.c:464
SMIME encryption menu.
Definition: keymap.h:82
Pager pager (email viewer)
Definition: keymap.h:78
Select from results of external query.
Definition: keymap.h:80
const struct Binding OpMix[]
Key bindings for the mixmaster menu.
Definition: functions.c:657
const struct Binding OpAlias[]
Key bindings for the alias menu.
Definition: functions.c:531
const struct Binding OpGeneric[]
Key bindings for the generic menu.
Definition: functions.c:55
const struct Binding OpPost[]
Key bindings for the postpone menu.
Definition: functions.c:522
#define APPLICATION_SMIME
Use SMIME to encrypt/sign.
Definition: lib.h:136
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:135
Select an attachment.
Definition: keymap.h:72
static void create_bindings(const struct Binding *map, enum MenuType menu)
Attach a set of keybindings to a Menu.
Definition: keymap.c:773
const struct Binding OpQuery[]
Key bindings for the external query menu.
Definition: functions.c:593
Select an email address by its alias.
Definition: keymap.h:71
A keyboard mapping.
Definition: keymap.h:46
const struct Binding OpEditor[]
Key bindings for the editor menu.
Definition: functions.c:604
Create/edit a Mixmaster chain.
Definition: keymap.h:88
Text entry area.
Definition: keymap.h:74
const struct Binding OpMain[]
Key bindings for the index menu.
Definition: functions.c:104
const struct Binding OpAutocryptAcct[]
Key bindings for the autocrypt account.
Definition: functions.c:673
const struct Binding OpBrowser[]
Key bindings for the file browser menu.
Definition: functions.c:540
Select a postponed email.
Definition: keymap.h:79
const struct Binding OpAttach[]
Key bindings for the attachment menu.
Definition: functions.c:416
Generic selection list.
Definition: keymap.h:76
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ km_error_key()

void km_error_key ( enum MenuType  menu)

Handle an unbound key sequence.

Parameters
menuMenu id, e.g. MENU_PAGER

Definition at line 1052 of file keymap.c.

1053 {
1054  char buf[128];
1055  int p, op;
1056 
1057  struct Keymap *key = km_find_func(menu, OP_HELP);
1058  if (!key && (menu != MENU_EDITOR) && (menu != MENU_PAGER))
1059  key = km_find_func(MENU_GENERIC, OP_HELP);
1060  if (!key)
1061  {
1062  mutt_error(_("Key is not bound"));
1063  return;
1064  }
1065 
1066  /* Make sure the key is really the help key in this menu.
1067  *
1068  * OP_END_COND is used as a barrier to ensure nothing extra
1069  * is left in the unget buffer.
1070  *
1071  * Note that km_expand_key() + tokenize_unget_string() should
1072  * not be used here: control sequences are expanded to a form
1073  * (e.g. "^H") not recognized by km_dokey(). */
1074  mutt_unget_event(0, OP_END_COND);
1075  p = key->len;
1076  while (p--)
1077  mutt_unget_event(key->keys[p], 0);
1078 
1079  /* Note, e.g. for the index menu:
1080  * bind generic ? noop
1081  * bind generic ,a help
1082  * bind index ,ab quit
1083  * The index keybinding shadows the generic binding.
1084  * OP_END_COND will be read and returned as the op.
1085  *
1086  * bind generic ? noop
1087  * bind generic dq help
1088  * bind index d delete-message
1089  * OP_DELETE will be returned as the op, leaving "q" + OP_END_COND
1090  * in the unget buffer.
1091  */
1092  op = km_dokey(menu);
1093  if (op != OP_END_COND)
1095  if (op != OP_HELP)
1096  {
1097  mutt_error(_("Key is not bound"));
1098  return;
1099  }
1100 
1101  km_expand_key(buf, sizeof(buf), key);
1102  mutt_error(_("Key is not bound. Press '%s' for help."), buf);
1103 }
int km_dokey(enum MenuType menu)
Determine what a keypress should do.
Definition: keymap.c:617
keycode_t * keys
key sequence
Definition: keymap.h:54
void mutt_unget_event(int ch, int op)
Return a keystroke to the input buffer.
Definition: curs_lib.c:807
#define _(a)
Definition: message.h:28
Pager pager (email viewer)
Definition: keymap.h:78
short op
operation to perform
Definition: keymap.h:51
struct Keymap * km_find_func(enum MenuType menu, int func)
Find a function&#39;s mapping in a Menu.
Definition: keymap.c:854
int km_expand_key(char *s, size_t len, struct Keymap *map)
Get the key string bound to a Keymap.
Definition: keymap.c:826
A keyboard mapping.
Definition: keymap.h:46
short len
length of key sequence (unit: sizeof (keycode_t))
Definition: keymap.h:53
#define mutt_error(...)
Definition: logging.h:84
void mutt_flush_unget_to_endcond(void)
Clear entries from UngetKeyEvents.
Definition: curs_lib.c:880
Text entry area.
Definition: keymap.h:74
Generic selection list.
Definition: keymap.h:76
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_what_key()

void mutt_what_key ( void  )

Ask the user to press a key.

Displays the octal value back to the user.

Definition at line 1578 of file keymap.c.

1579 {
1580  int ch;
1581 
1582  mutt_window_mvprintw(MuttMessageWindow, 0, 0, _("Enter keys (^G to abort): "));
1583  do
1584  {
1585  ch = getch();
1586  if ((ch != ERR) && (ch != ctrl('G')))
1587  {
1588  mutt_message(_("Char = %s, Octal = %o, Decimal = %d"), km_keyname(ch), ch, ch);
1589  }
1590  } while (ch != ERR && ch != ctrl('G'));
1591 
1592  mutt_flushinp();
1593  mutt_clear_error();
1594 }
static const char * km_keyname(int c)
Get the human name for a key.
Definition: keymap.c:787
#define mutt_message(...)
Definition: logging.h:83
void mutt_flushinp(void)
Empty all the keyboard buffers.
Definition: curs_lib.c:892
#define _(a)
Definition: message.h:28
#define ctrl(ch)
Definition: mutt_curses.h:67
void mutt_clear_error(void)
Clear the message line (bottom line of screen)
Definition: mutt_logging.c:113
int mutt_window_mvprintw(struct MuttWindow *win, int row, int col, const char *fmt,...)
Move the cursor and write a formatted string to a Window.
Definition: mutt_window.c:312
struct MuttWindow * MuttMessageWindow
Message Window.
Definition: mutt_window.c:47
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ km_bind()

enum CommandResult km_bind ( char *  s,
enum MenuType  menu,
int  op,
char *  macro,
char *  desc 
)

Bind a key to a macro.

Parameters
sKey string
menuMenu id, e.g. MENU_EDITOR
opOperation, e.g. OP_DELETE
macroMacro string
descDescription of macro (OPTIONAL)
Return values
CommandResultResult e.g. MUTT_CMD_SUCCESS

Definition at line 438 of file keymap.c.

439 {
440  return km_bind_err(s, menu, op, macro, desc, NULL);
441 }
short op
operation to perform
Definition: keymap.h:51
static enum CommandResult km_bind_err(const char *s, enum MenuType menu, int op, char *macro, char *desc, struct Buffer *err)
Set up a key binding.
Definition: keymap.c:333
char * macro
macro expansion (op == OP_MACRO)
Definition: keymap.h:48
char * desc
description of a macro for the help menu
Definition: keymap.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ km_dokey()

int km_dokey ( enum MenuType  menu)

Determine what a keypress should do.

Parameters
menuMenu ID, e.g. MENU_EDITOR
Return values
>0Function to execute
OP_NULLNo function bound to key sequence
-1Error occurred while reading input
-2A timeout or sigwinch occurred

Definition at line 617 of file keymap.c.

618 {
619  struct KeyEvent tmp;
620  struct Keymap *map = Keymaps[menu];
621  int pos = 0;
622  int n = 0;
623 
624  if (!map && (menu != MENU_EDITOR))
625  return retry_generic(menu, NULL, 0, 0);
626 
627  while (true)
628  {
629  int i = (C_Timeout > 0) ? C_Timeout : 60;
630 #ifdef USE_IMAP
631  /* keepalive may need to run more frequently than C_Timeout allows */
632  if (C_ImapKeepalive)
633  {
634  if (C_ImapKeepalive >= i)
635  imap_keepalive();
636  else
637  {
638  while (C_ImapKeepalive && (C_ImapKeepalive < i))
639  {
641  tmp = mutt_getch();
642  mutt_getch_timeout(-1);
643  /* If a timeout was not received, or the window was resized, exit the
644  * loop now. Otherwise, continue to loop until reaching a total of
645  * $timeout seconds. */
646  if ((tmp.ch != -2) || SigWinch)
647  goto gotkey;
648 #ifdef USE_INOTIFY
650  goto gotkey;
651 #endif
652  i -= C_ImapKeepalive;
653  imap_keepalive();
654  }
655  }
656  }
657 #endif
658 
659  mutt_getch_timeout(i * 1000);
660  tmp = mutt_getch();
661  mutt_getch_timeout(-1);
662 
663 #ifdef USE_IMAP
664  gotkey:
665 #endif
666  /* hide timeouts, but not window resizes, from the line editor. */
667  if ((menu == MENU_EDITOR) && (tmp.ch == -2) && !SigWinch)
668  continue;
669 
670  LastKey = tmp.ch;
671  if (LastKey < 0)
672  return LastKey;
673 
674  /* do we have an op already? */
675  if (tmp.op)
676  {
677  const char *func = NULL;
678  const struct Binding *bindings = NULL;
679 
680  /* is this a valid op for this menu? */
681  if ((bindings = km_get_table(menu)) && (func = mutt_get_func(bindings, tmp.op)))
682  return tmp.op;
683 
684  if ((menu == MENU_EDITOR) && mutt_get_func(OpEditor, tmp.op))
685  return tmp.op;
686 
687  if ((menu != MENU_EDITOR) && (menu != MENU_PAGER))
688  {
689  /* check generic menu */
690  bindings = OpGeneric;
691  func = mutt_get_func(bindings, tmp.op);
692  if (func)
693  return tmp.op;
694  }
695 
696  /* Sigh. Valid function but not in this context.
697  * Find the literal string and push it back */
698  for (i = 0; Menus[i].name; i++)
699  {
700  bindings = km_get_table(Menus[i].value);
701  if (bindings)
702  {
703  func = mutt_get_func(bindings, tmp.op);
704  if (func)
705  {
706  mutt_unget_event('>', 0);
707  mutt_unget_string(func);
708  mutt_unget_event('<', 0);
709  break;
710  }
711  }
712  }
713  /* continue to chew */
714  if (func)
715  continue;
716  }
717 
718  if (!map)
719  return tmp.op;
720 
721  /* Nope. Business as usual */
722  while (LastKey > map->keys[pos])
723  {
724  if ((pos > map->eq) || !map->next)
725  return retry_generic(menu, map->keys, pos, LastKey);
726  map = map->next;
727  }
728 
729  if (LastKey != map->keys[pos])
730  return retry_generic(menu, map->keys, pos, LastKey);
731 
732  if (++pos == map->len)
733  {
734  if (map->op != OP_MACRO)
735  return map->op;
736 
737  /* OptIgnoreMacroEvents turns off processing the MacroEvents buffer
738  * in mutt_getch(). Generating new macro events during that time would
739  * result in undesired behavior once the option is turned off.
740  *
741  * Originally this returned -1, however that results in an unbuffered
742  * username or password prompt being aborted. Returning OP_NULL allows
743  * mutt_enter_string_full() to display the keybinding pressed instead.
744  *
745  * It may be unexpected for a macro's keybinding to be returned,
746  * but less so than aborting the prompt. */
748  {
749  return OP_NULL;
750  }
751 
752  if (n++ == 10)
753  {
754  mutt_flushinp();
755  mutt_error(_("Macro loop detected"));
756  return -1;
757  }
758 
760  map = Keymaps[menu];
761  pos = 0;
762  }
763  }
764 
765  /* not reached */
766 }
short eq
number of leading keys equal to next entry
Definition: keymap.h:52
void mutt_push_macro_event(int ch, int op)
Add the character/operation to the macro buffer.
Definition: curs_lib.c:844
int op
function id number
Definition: keymap.h:117
void imap_keepalive(void)
poll the current folder to keep the connection alive
Definition: util.c:1093
void mutt_flushinp(void)
Empty all the keyboard buffers.
Definition: curs_lib.c:892
struct Keymap * Keymaps[MENU_MAX]
Array of Keymap keybindings, one for each Menu.
Definition: keymap.c:147
keycode_t * keys
key sequence
Definition: keymap.h:54
void mutt_unget_event(int ch, int op)
Return a keystroke to the input buffer.
Definition: curs_lib.c:807
#define _(a)
Definition: message.h:28
WHERE bool OptIgnoreMacroEvents
(pseudo) don&#39;t process macro/push/exec events while set
Definition: options.h:36
bool MonitorFilesChanged
true after a monitored file has changed
Definition: monitor.c:50
Pager pager (email viewer)
Definition: keymap.h:78
const char * mutt_get_func(const struct Binding *bindings, int op)
Get the name of a function.
Definition: keymap.c:499
const struct Binding OpGeneric[]
Key bindings for the generic menu.
Definition: functions.c:55
int LastKey
contains the last key the user pressed
Definition: keymap.c:145
short op
operation to perform
Definition: keymap.h:51
WHERE SIG_ATOMIC_VOLATILE_T SigWinch
true after SIGWINCH is received
Definition: globals.h:80
WHERE short C_ImapKeepalive
Config: (imap) Time to wait before polling an open IMAP connection.
Definition: globals.h:155
const struct Mapping Menus[]
Menu name lookup table.
Definition: keymap.c:60
struct Keymap * next
next key in map
Definition: keymap.h:50
char * macro
macro expansion (op == OP_MACRO)
Definition: keymap.h:48
WHERE short C_Timeout
Config: Time to wait for user input in menus.
Definition: globals.h:151
static void generic_tokenize_push_string(char *s, void(*generic_push)(int, int))
Parse and queue a &#39;push&#39; command.
Definition: keymap.c:519
An event such as a keypress.
Definition: keymap.h:60
struct KeyEvent mutt_getch(void)
Read a character from the input buffer.
Definition: curs_lib.c:187
A keyboard mapping.
Definition: keymap.h:46
short len
length of key sequence (unit: sizeof (keycode_t))
Definition: keymap.h:53
static int retry_generic(enum MenuType menu, keycode_t *keys, int keyslen, int lastkey)
Try to find the key in the generic menu bindings.
Definition: keymap.c:591
#define mutt_error(...)
Definition: logging.h:84
void mutt_getch_timeout(int delay)
Set the getch() timeout.
Definition: curs_lib.c:144
const struct Binding OpEditor[]
Key bindings for the editor menu.
Definition: functions.c:604
const struct Binding * km_get_table(enum MenuType menu)
Lookup a menu&#39;s keybindings.
Definition: keymap.c:1221
void mutt_unget_string(const char *s)
Return a string to the input buffer.
Definition: curs_lib.c:826
Text entry area.
Definition: keymap.h:74
const char * name
Definition: mapping.h:31
Mapping between a user key and a function.
Definition: keymap.h:114
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ km_get_table()

const struct Binding* km_get_table ( enum MenuType  menu)

Lookup a menu's keybindings.

Parameters
menuMenu id, e.g. MENU_EDITOR
Return values
ptrArray of keybindings

Definition at line 1221 of file keymap.c.

1222 {
1223  switch (menu)
1224  {
1225  case MENU_ALIAS:
1226  return OpAlias;
1227  case MENU_ATTACH:
1228  return OpAttach;
1229 #ifdef USE_AUTOCRYPT
1230  case MENU_AUTOCRYPT_ACCT:
1231  return OpAutocryptAcct;
1232 #endif
1233  case MENU_COMPOSE:
1234  return OpCompose;
1235  case MENU_EDITOR:
1236  return OpEditor;
1237  case MENU_FOLDER:
1238  return OpBrowser;
1239  case MENU_GENERIC:
1240  return OpGeneric;
1241 #ifdef CRYPT_BACKEND_GPGME
1242  case MENU_KEY_SELECT_PGP:
1243  return OpPgp;
1244  case MENU_KEY_SELECT_SMIME:
1245  return OpSmime;
1246 #endif
1247  case MENU_MAIN:
1248  return OpMain;
1249 #ifdef MIXMASTER
1250  case MENU_MIX:
1251  return OpMix;
1252 #endif
1253  case MENU_PAGER:
1254  return OpPager;
1255  case MENU_PGP:
1256  return (WithCrypto & APPLICATION_PGP) ? OpPgp : NULL;
1257  case MENU_POSTPONE:
1258  return OpPost;
1259  case MENU_QUERY:
1260  return OpQuery;
1261  default:
1262  return NULL;
1263  }
1264 }
const struct Binding OpPager[]
Key bindings for the pager menu.
Definition: functions.c:262
PGP encryption menu.
Definition: keymap.h:81
#define WithCrypto
Definition: lib.h:161
const struct Binding OpPgp[]
Key bindings for the pgp menu.
Definition: functions.c:636
General file/mailbox browser.
Definition: keymap.h:75
Compose an email.
Definition: keymap.h:73
Index panel (list of emails)
Definition: keymap.h:77
const struct Binding OpCompose[]
Key bindings for the compose menu.
Definition: functions.c:452
const struct Binding OpSmime[]
Key bindings for the smime menu.
Definition: functions.c:645
Pager pager (email viewer)
Definition: keymap.h:78
Select from results of external query.
Definition: keymap.h:80
const struct Binding OpMix[]
Key bindings for the mixmaster menu.
Definition: functions.c:657
const struct Binding OpAlias[]
Key bindings for the alias menu.
Definition: functions.c:531
const struct Binding OpGeneric[]
Key bindings for the generic menu.
Definition: functions.c:55
const struct Binding OpPost[]
Key bindings for the postpone menu.
Definition: functions.c:522
#define APPLICATION_PGP
Use PGP to encrypt/sign.
Definition: lib.h:135
Select an attachment.
Definition: keymap.h:72
const struct Binding OpQuery[]
Key bindings for the external query menu.
Definition: functions.c:593
Select an email address by its alias.
Definition: keymap.h:71
const struct Binding OpEditor[]
Key bindings for the editor menu.
Definition: functions.c:604
Create/edit a Mixmaster chain.
Definition: keymap.h:88
Text entry area.
Definition: keymap.h:74
const struct Binding OpMain[]
Key bindings for the index menu.
Definition: functions.c:104
const struct Binding OpAutocryptAcct[]
Key bindings for the autocrypt account.
Definition: functions.c:673
const struct Binding OpBrowser[]
Key bindings for the file browser menu.
Definition: functions.c:540
Select a postponed email.
Definition: keymap.h:79
const struct Binding OpAttach[]
Key bindings for the attachment menu.
Definition: functions.c:416
Generic selection list.
Definition: keymap.h:76
+ Here is the caller graph for this function:

◆ mutt_get_func()

const char* mutt_get_func ( const struct Binding bindings,
int  op 
)

Get the name of a function.

Parameters
bindingsKey bindings table
opOperation, e.g. OP_DELETE
Return values
ptrName of function
NULLOperation not found
Note
This returns a static string.

Definition at line 499 of file keymap.c.

500 {
501  for (int i = 0; bindings[i].name; i++)
502  {
503  if (bindings[i].op == op)
504  return bindings[i].name;
505  }
506 
507  return NULL;
508 }
int op
function id number
Definition: keymap.h:117
const char * name
name of the function
Definition: keymap.h:116
+ Here is the caller graph for this function:

◆ mutt_keys_free()

void mutt_keys_free ( void  )

Free the key maps.

Definition at line 1599 of file keymap.c.

1600 {
1601  struct Keymap *map = NULL;
1602  struct Keymap *next = NULL;
1603 
1604  for (int i = 0; i < MENU_MAX; i++)
1605  {
1606  for (map = Keymaps[i]; map; map = next)
1607  {
1608  next = map->next;
1609 
1610  FREE(&map->macro);
1611  FREE(&map->desc);
1612  FREE(&map->keys);
1613  FREE(&map);
1614  }
1615 
1616  Keymaps[i] = NULL;
1617  }
1618 }
struct Keymap * Keymaps[MENU_MAX]
Array of Keymap keybindings, one for each Menu.
Definition: keymap.c:147
keycode_t * keys
key sequence
Definition: keymap.h:54
struct Keymap * next
next key in map
Definition: keymap.h:50
char * macro
macro expansion (op == OP_MACRO)
Definition: keymap.h:48
char * desc
description of a macro for the help menu
Definition: keymap.h:49
A keyboard mapping.
Definition: keymap.h:46
#define FREE(x)
Definition: memory.h:40
+ Here is the caller graph for this function:

◆ mutt_parse_bind()

enum CommandResult mutt_parse_bind ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'bind' command - Implements command_t.

bind menu-name <key_sequence> function-name

Definition at line 1271 of file keymap.c.

1273 {
1274  const struct Binding *bindings = NULL;
1275  enum MenuType menu[sizeof(Menus) / sizeof(struct Mapping) - 1];
1276  int num_menus = 0;
1277  enum CommandResult rc = MUTT_CMD_SUCCESS;
1278 
1279  char *key = parse_keymap(menu, s, mutt_array_size(menu), &num_menus, err, true);
1280  if (!key)
1281  return MUTT_CMD_ERROR;
1282 
1283  /* function to execute */
1285  if (MoreArgs(s))
1286  {
1287  mutt_buffer_printf(err, _("%s: too many arguments"), "bind");
1288  rc = MUTT_CMD_ERROR;
1289  }
1290  else if (mutt_str_strcasecmp("noop", buf->data) == 0)
1291  {
1292  for (int i = 0; i < num_menus; i++)
1293  {
1294  km_bindkey(key, menu[i], OP_NULL); /* the 'unbind' command */
1295  }
1296  }
1297  else
1298  {
1299  for (int i = 0; i < num_menus; i++)
1300  {
1301  /* The pager and editor menus don't use the generic map,
1302  * however for other menus try generic first. */
1303  if ((menu[i] != MENU_PAGER) && (menu[i] != MENU_EDITOR) && (menu[i] != MENU_GENERIC))
1304  {
1305  rc = try_bind(key, menu[i], buf->data, OpGeneric, err);
1306  if (rc == 0)
1307  continue;
1308  if (rc == -2)
1309  break;
1310  }
1311 
1312  /* Clear any error message, we're going to try again */
1313  err->data[0] = '\0';
1314  bindings = km_get_table(menu[i]);
1315  if (bindings)
1316  {
1317  rc = try_bind(key, menu[i], buf->data, bindings, err);
1318  }
1319  }
1320  }
1321  FREE(&key);
1322  return rc;
1323 }
CommandResult
Error codes for command_t parse functions.
Definition: mutt_commands.h:33
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
MenuType
Types of GUI selections.
Definition: keymap.h:69
#define _(a)
Definition: message.h:28
static char * parse_keymap(enum MenuType *menu, struct Buffer *s, int max_menus, int *num_menus, struct Buffer *err, bool bind)
Parse a user-config key binding.
Definition: keymap.c:1136
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
#define mutt_array_size(x)
Definition: memory.h:33
static enum CommandResult km_bindkey(const char *s, enum MenuType menu, int op)
Bind a key in a Menu to an operation.
Definition: keymap.c:464
Pager pager (email viewer)
Definition: keymap.h:78
#define MoreArgs(buf)
Definition: buffer.h:43
const struct Binding OpGeneric[]
Key bindings for the generic menu.
Definition: functions.c:55
const struct Mapping Menus[]
Menu name lookup table.
Definition: keymap.c:60
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:426
char * data
Pointer to data.
Definition: buffer.h:35
static enum CommandResult try_bind(char *key, enum MenuType menu, char *func, const struct Binding *bindings, struct Buffer *err)
Try to make a key binding.
Definition: keymap.c:1198
Success: Command worked.
Definition: mutt_commands.h:37
int mutt_str_strcasecmp(const char *a, const char *b)
Compare two strings ignoring case, safely.
Definition: string.c:651
const struct Binding * km_get_table(enum MenuType menu)
Lookup a menu&#39;s keybindings.
Definition: keymap.c:1221
#define FREE(x)
Definition: memory.h:40
Mapping between user-readable string and a constant.
Definition: mapping.h:29
Text entry area.
Definition: keymap.h:74
Mapping between a user key and a function.
Definition: keymap.h:114
#define MUTT_TOKEN_NO_FLAGS
No flags are set.
Definition: mutt.h:76
Generic selection list.
Definition: keymap.h:76
+ Here is the call graph for this function:

◆ mutt_parse_exec()

enum CommandResult mutt_parse_exec ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'exec' command - Implements command_t.

Definition at line 1531 of file keymap.c.

1533 {
1534  int ops[128];
1535  int nops = 0;
1536  const struct Binding *bindings = NULL;
1537  char *function = NULL;
1538 
1539  if (!MoreArgs(s))
1540  {
1541  mutt_buffer_strcpy(err, _("exec: no arguments"));
1542  return MUTT_CMD_ERROR;
1543  }
1544 
1545  do
1546  {
1548  function = buf->data;
1549 
1550  bindings = km_get_table(CurrentMenu);
1551  if (!bindings && (CurrentMenu != MENU_PAGER))
1552  bindings = OpGeneric;
1553 
1554  ops[nops] = get_op(bindings, function, mutt_str_strlen(function));
1555  if ((ops[nops] == OP_NULL) && (CurrentMenu != MENU_PAGER))
1556  ops[nops] = get_op(OpGeneric, function, mutt_str_strlen(function));
1557 
1558  if (ops[nops] == OP_NULL)
1559  {
1560  mutt_flushinp();
1561  mutt_error(_("%s: no such function"), function);
1562  return MUTT_CMD_ERROR;
1563  }
1564  nops++;
1565  } while (MoreArgs(s) && nops < mutt_array_size(ops));
1566 
1567  while (nops)
1568  mutt_push_macro_event(0, ops[--nops]);
1569 
1570  return MUTT_CMD_SUCCESS;
1571 }
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
void mutt_push_macro_event(int ch, int op)
Add the character/operation to the macro buffer.
Definition: curs_lib.c:844
void mutt_flushinp(void)
Empty all the keyboard buffers.
Definition: curs_lib.c:892
WHERE enum MenuType CurrentMenu
Current Menu, e.g. MENU_PAGER.
Definition: globals.h:82
#define _(a)
Definition: message.h:28
size_t mutt_str_strlen(const char *a)
Calculate the length of a string, safely.
Definition: string.c:689
#define mutt_array_size(x)
Definition: memory.h:33
Pager pager (email viewer)
Definition: keymap.h:78
#define MoreArgs(buf)
Definition: buffer.h:43
const struct Binding OpGeneric[]
Key bindings for the generic menu.
Definition: functions.c:55
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:426
char * data
Pointer to data.
Definition: buffer.h:35
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
Success: Command worked.
Definition: mutt_commands.h:37
#define mutt_error(...)
Definition: logging.h:84
const struct Binding * km_get_table(enum MenuType menu)
Lookup a menu&#39;s keybindings.
Definition: keymap.c:1221
static int get_op(const struct Binding *bindings, const char *start, size_t len)
Get the function by its name.
Definition: keymap.c:476
Mapping between a user key and a function.
Definition: keymap.h:114
#define MUTT_TOKEN_NO_FLAGS
No flags are set.
Definition: mutt.h:76
+ Here is the call graph for this function:

◆ mutt_parse_macro()

enum CommandResult mutt_parse_macro ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'macro' command - Implements command_t.

macro <menu> <key> <macro> <description>

Definition at line 1477 of file keymap.c.

1479 {
1480  enum MenuType menu[sizeof(Menus) / sizeof(struct Mapping) - 1];
1481  int num_menus = 0;
1482  enum CommandResult rc = MUTT_CMD_ERROR;
1483  char *seq = NULL;
1484 
1485  char *key = parse_keymap(menu, s, mutt_array_size(menu), &num_menus, err, false);
1486  if (!key)
1487  return MUTT_CMD_ERROR;
1488 
1490  /* make sure the macro sequence is not an empty string */
1491  if (buf->data[0] == '\0')
1492  {
1493  mutt_buffer_strcpy(err, _("macro: empty key sequence"));
1494  }
1495  else
1496  {
1497  if (MoreArgs(s))
1498  {
1499  seq = mutt_str_strdup(buf->data);
1501 
1502  if (MoreArgs(s))
1503  {
1504  mutt_buffer_printf(err, _("%s: too many arguments"), "macro");
1505  }
1506  else
1507  {
1508  for (int i = 0; i < num_menus; i++)
1509  {
1510  rc = km_bind(key, menu[i], OP_MACRO, seq, buf->data);
1511  }
1512  }
1513 
1514  FREE(&seq);
1515  }
1516  else
1517  {
1518  for (int i = 0; i < num_menus; i++)
1519  {
1520  rc = km_bind(key, menu[i], OP_MACRO, buf->data, NULL);
1521  }
1522  }
1523  }
1524  FREE(&key);
1525  return rc;
1526 }
CommandResult
Error codes for command_t parse functions.
Definition: mutt_commands.h:33
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
MenuType
Types of GUI selections.
Definition: keymap.h:69
#define _(a)
Definition: message.h:28
static char * parse_keymap(enum MenuType *menu, struct Buffer *s, int max_menus, int *num_menus, struct Buffer *err, bool bind)
Parse a user-config key binding.
Definition: keymap.c:1136
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
#define mutt_array_size(x)
Definition: memory.h:33
#define MoreArgs(buf)
Definition: buffer.h:43
#define MUTT_TOKEN_CONDENSE
^(char) to control chars (macros)
Definition: mutt.h:78
const struct Mapping Menus[]
Menu name lookup table.
Definition: keymap.c:60
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:426
char * data
Pointer to data.
Definition: buffer.h:35
size_t mutt_buffer_strcpy(struct Buffer *buf, const char *s)
Copy a string into a Buffer.
Definition: buffer.c:312
char * mutt_str_strdup(const char *str)
Copy a string, safely.
Definition: string.c:380
const char * seq
default key binding
Definition: keymap.h:118
#define FREE(x)
Definition: memory.h:40
Mapping between user-readable string and a constant.
Definition: mapping.h:29
enum CommandResult km_bind(char *s, enum MenuType menu, int op, char *macro, char *desc)
Bind a key to a macro.
Definition: keymap.c:438
+ Here is the call graph for this function:

◆ mutt_parse_push()

enum CommandResult mutt_parse_push ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'push' command - Implements command_t.

Definition at line 1108 of file keymap.c.

1110 {
1112  if (MoreArgs(s))
1113  {
1114  mutt_buffer_printf(err, _("%s: too many arguments"), "push");
1115  return MUTT_CMD_ERROR;
1116  }
1117 
1119  return MUTT_CMD_SUCCESS;
1120 }
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
void mutt_push_macro_event(int ch, int op)
Add the character/operation to the macro buffer.
Definition: curs_lib.c:844
#define _(a)
Definition: message.h:28
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
#define MoreArgs(buf)
Definition: buffer.h:43
#define MUTT_TOKEN_CONDENSE
^(char) to control chars (macros)
Definition: mutt.h:78
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:426
char * data
Pointer to data.
Definition: buffer.h:35
static void generic_tokenize_push_string(char *s, void(*generic_push)(int, int))
Parse and queue a &#39;push&#39; command.
Definition: keymap.c:519
Success: Command worked.
Definition: mutt_commands.h:37
+ Here is the call graph for this function:

◆ mutt_parse_unbind()

enum CommandResult mutt_parse_unbind ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Parse the 'unbind' command - Implements command_t.

Command unbinds:

  • one binding in one menu-name
  • one binding in all menu-names
  • all bindings in all menu-names

unbind <menu-name[,...]|*> [<key_sequence>]

Definition at line 1412 of file keymap.c.

1414 {
1415  bool menu[MENU_MAX] = { 0 };
1416  bool all_keys = false;
1417  char *key = NULL;
1418 
1420  if (mutt_str_strcmp(buf->data, "*") == 0)
1421  {
1422  for (enum MenuType i = 0; i < MENU_MAX; i++)
1423  menu[i] = true;
1424  }
1425  else
1426  parse_menu(menu, buf->data, err);
1427 
1428  if (MoreArgs(s))
1429  {
1431  key = buf->data;
1432  }
1433  else
1434  all_keys = true;
1435 
1436  if (MoreArgs(s))
1437  {
1438  const char *cmd = (data & MUTT_UNMACRO) ? "unmacro" : "unbind";
1439 
1440  mutt_buffer_printf(err, _("%s: too many arguments"), cmd);
1441  return MUTT_CMD_ERROR;
1442  }
1443 
1444  for (enum MenuType i = 0; i < MENU_MAX; i++)
1445  {
1446  if (!menu[i])
1447  continue;
1448  if (all_keys)
1449  {
1450  km_unbind_all(&Keymaps[i], data);
1451  km_bindkey("<enter>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
1452  km_bindkey("<return>", MENU_GENERIC, OP_GENERIC_SELECT_ENTRY);
1453  km_bindkey("<enter>", MENU_MAIN, OP_DISPLAY_MESSAGE);
1454  km_bindkey("<return>", MENU_MAIN, OP_DISPLAY_MESSAGE);
1455  km_bindkey("<backspace>", MENU_EDITOR, OP_EDITOR_BACKSPACE);
1456  km_bindkey("\177", MENU_EDITOR, OP_EDITOR_BACKSPACE);
1457  km_bindkey(":", MENU_GENERIC, OP_ENTER_COMMAND);
1458  km_bindkey(":", MENU_PAGER, OP_ENTER_COMMAND);
1459  if (i != MENU_EDITOR)
1460  {
1461  km_bindkey("?", i, OP_HELP);
1462  km_bindkey("q", i, OP_EXIT);
1463  }
1464  }
1465  else
1466  km_bindkey(key, i, OP_NULL);
1467  }
1468 
1469  return MUTT_CMD_SUCCESS;
1470 }
Error: Can&#39;t help the user.
Definition: mutt_commands.h:35
MenuType
Types of GUI selections.
Definition: keymap.h:69
struct Keymap * Keymaps[MENU_MAX]
Array of Keymap keybindings, one for each Menu.
Definition: keymap.c:147
#define _(a)
Definition: message.h:28
static void km_unbind_all(struct Keymap **map, unsigned long mode)
Free all the keys in the supplied Keymap.
Definition: keymap.c:1362
Index panel (list of emails)
Definition: keymap.h:77
#define MUTT_UNMACRO
Definition: keymap.h:32
int mutt_buffer_printf(struct Buffer *buf, const char *fmt,...)
Format a string overwriting a Buffer.
Definition: buffer.c:160
static enum CommandResult km_bindkey(const char *s, enum MenuType menu, int op)
Bind a key in a Menu to an operation.
Definition: keymap.c:464
Pager pager (email viewer)
Definition: keymap.h:78
#define MoreArgs(buf)
Definition: buffer.h:43
int mutt_extract_token(struct Buffer *dest, struct Buffer *tok, TokenFlags flags)
Extract one token from a string.
Definition: init.c:426
char * data
Pointer to data.
Definition: buffer.h:35
Success: Command worked.
Definition: mutt_commands.h:37
static void * parse_menu(bool *menu, char *s, struct Buffer *err)
Parse menu-names into an array.
Definition: keymap.c:1333
Text entry area.
Definition: keymap.h:74
int mutt_str_strcmp(const char *a, const char *b)
Compare two strings, safely.
Definition: string.c:638
#define MUTT_TOKEN_NO_FLAGS
No flags are set.
Definition: mutt.h:76
Generic selection list.
Definition: keymap.h:76
+ Here is the call graph for this function:

◆ mutt_parse_unmacro()

enum CommandResult mutt_parse_unmacro ( struct Buffer buf,
struct Buffer s,
unsigned long  data,
struct Buffer err 
)

Variable Documentation

◆ Keymaps

struct Keymap* Keymaps[]

Array of Keymap keybindings, one for each Menu.

Definition at line 147 of file keymap.c.

◆ LastKey

int LastKey

Last real key pressed, recorded by dokey()

Last real key pressed, recorded by dokey()

Definition at line 145 of file keymap.c.

◆ Menus

const struct Mapping Menus[]

Menu name lookup table.

Definition at line 60 of file keymap.c.