home · contact · privacy
License everything (GPL).
[plomrogue] / src / client / keybindings.h
index ff89a4cadee19b87a7ae641546f58de613d2e245..fa08de16d36c12d47aa170071e0ac350f81d76b6 100644 (file)
@@ -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.
  */
 #define KEYBINDINGS_H
 
 #include <stdint.h> /* uint8_t, uint16_t */
-#include <stdio.h> /* FILE */
 struct Command;
 
 
 
 struct KeyBinding
 {
-  struct KeyBinding * next;
-  uint16_t key; /* 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 command bound to keycode; NULL on failure. */
-extern struct Command * get_command_to_keycode(struct KeyBinding * kb_p,
-                                               uint16_t key);
+/* 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);
 
-/* Read/write from/to "file" "kbd", delimited by world.delim. */
-extern void write_keybindings_to_file(FILE * file, struct KeyBindingDB * kbd);
-extern void read_keybindings_from_file(char * line, uint32_t linemax,
-                                       FILE * file, struct KeyBindingDB * kbd);
-
-/* Free keybinding chain starting at "kb_start". */
-extern void free_keybindings(struct KeyBinding * kb_start);
-
 /* 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.