X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fclient%2Fkeybindings.h;h=fa08de16d36c12d47aa170071e0ac350f81d76b6;hb=aa2ca997b919bee3cea9dfaed27e33fb0bc81728;hp=ea09d6582e5e2ab41a7d1fdedd37928d1c167277;hpb=21cac2d976f806643aee1471bcee7b38597ac121;p=plomrogue diff --git a/src/client/keybindings.h b/src/client/keybindings.h index ea09d65..fa08de1 100644 --- a/src/client/keybindings.h +++ b/src/client/keybindings.h @@ -1,4 +1,8 @@ /* src/client/keybindings.h + * + * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3 + * or any later version. For details on its copyright, license, and warranties, + * see the file NOTICE in the root directory of the PlomRogue source package. * * Database of keybindings and functions to read and manipulate it. */ @@ -7,56 +11,45 @@ #define KEYBINDINGS_H #include /* uint8_t, uint16_t */ +struct Command; struct KeyBinding { - struct KeyBinding * next; - uint16_t key; /* keycode */ - char * command; /* name of command / functionality bound to keycode */ + uint16_t keycode; + struct Command * command; /* command in command DB to which key is bound */ }; struct KeyBindingDB { struct KeyBinding * kbs; - uint16_t select; /* linear list index of keybinding selected for editing */ - uint8_t edit; /* 1 if currently editing a keybinding, else 0 */ + uint8_t n_of_kbs; /* how many KeyBinding structs are stored below .kbs? */ + uint8_t select; /* linear list index of keybinding selected for editing */ + uint8_t edit; /* 1 if currently editing a keybinding, else 0 */ }; -/* Return name of command / functionality bound to keycode; NULL on failure. */ -extern char * get_command_to_keycode(struct KeyBinding * kb_p, uint16_t key); - -/* Return keycode bound to "command". */ -extern uint16_t get_keycode_to_command(struct KeyBinding * keybindings, - char * command); +/* Return command bound to "keycode" in "kbdb"; NULL if none found. */ +extern struct Command * get_command_to_keycode(struct KeyBindingDB * kbdb, + uint16_t keycode); /* Return human-readable name (of maximum 9 chars) for "keycode" as matched by - * ncurses.h; if none is found, return "UNKNOWN". + * ncurses.h; if none is found, return "(unknown)". */ extern char * get_keyname_to_keycode(uint16_t keycode); -/* Initialize/save keybindings data from/to file at "path" to/from keybindings - * data pointer "kbd". - */ -extern void init_keybindings(char * path, struct KeyBindingDB * kbd); -extern void save_keybindings(char * path, struct KeyBindingDB * kbd); - -/* Free keybinding chain starting at "kb_start". */ -extern void free_keybindings(struct KeyBinding * kb_start); - -/* Mark keybinding selected for modification as being edited, get user input to - * modify it, then unmark it again. Ensure there are max. three digits in the - * ASCII representation of the keycode read from the user. +/* Mark keybinding in KeybindingDB (char_selected_kb_db()-) selected by "kb_c" + * as being edited, get user input to modify it, then unmark it again. Ensure + * there are max. three digits in the ASCII string of the kecode read from user. */ -extern void mod_selected_keyb(struct KeyBindingDB * kbd); +extern void mod_selected_keyb(char kb_c); -/* Move keybinding modification selection upwards ("dir"=="u") or downwards - * ("dir"=="d") within the limits of the keybindings chain length. +/* Move .select in KeybindingDB (char-selected_kb_db()-) selected by "kb_c" + * upwards ("dir"=="u") or downwards ("dir"=="d") within KeyBindingDB limits. */ -extern void move_keyb_mod_selection(struct KeyBindingDB * kbd, char dir); +extern void move_keyb_selection(char kb_c, char dir);