plomlompom.com Git - plomrogue/blob - src/client/keybindings.h

   1 /* src/client/keybindings.h
   2  *
   3  * Database of keybindings and functions to read and manipulate it.
   4  */
   5
   6 #ifndef KEYBINDINGS_H
   7 #define KEYBINDINGS_H
   8
   9 #include <stdint.h> /* uint8_t, uint16_t */
  10 #include <stdio.h> /* FILE */
  11 struct Command;
  12
  13
  14
  15 struct KeyBinding
  16 {
  17   struct KeyBinding * next;
  18   uint16_t key; /* keycode */
  19   struct Command * command; /* command in command DB to which key is bound */
  20 };
  21
  22 struct KeyBindingDB
  23 {
  24     struct KeyBinding * kbs;
  25     uint16_t select; /* linear list index of keybinding selected for editing */
  26     uint8_t edit;    /* 1 if currently editing a keybinding, else 0 */
  27 };
  28
  29
  30
  31 /* Return command bound to keycode; NULL on failure. */
  32 extern struct Command * get_command_to_keycode(struct KeyBinding * kb_p,
  33                                                uint16_t key);
  34
  35 /* Return human-readable name (of maximum 9 chars) for "keycode" as matched by
  36  * ncurses.h; if none is found, return "UNKNOWN".
  37  */
  38 extern char * get_keyname_to_keycode(uint16_t keycode);
  39
  40 /* Read/write from/to "file" "kbd", delimited by "delim". */
  41 extern void write_keybindings_to_file(FILE * file, struct KeyBindingDB * kbd,
  42                                       char * delim);
  43 extern void read_keybindings_from_file(char * line, uint32_t linemax,
  44                                        FILE * file, struct KeyBindingDB * kbd);
  45
  46 /* Free keybinding chain starting at "kb_start". */
  47 extern void free_keybindings(struct KeyBinding * kb_start);
  48
  49 /* Mark keybinding in KeybindingDB (char_selected_kb_db()-) selected by "kb_c"
  50  * as being edited, get user input to modify it, then unmark it again. Ensure
  51  * there are max. three digits in the ASCII string of the kecode read from user.
  52  */
  53 extern void mod_selected_keyb(char kb_c);
  54
  55 /* Move .select in KeybindingDB (char-selected_kb_db()-) selected by "kb_c"
  56  * upwards ("dir"=="u") or downwards ("dir"=="d") within KeyBindingDB limits.
  57  */
  58 extern void move_keyb_selection(char kb_c, char dir);
  59
  60
  61
  62 #endif