home · contact · privacy
Add "look" mode to query things on any cell via new THINGS_HERE command.
[plomrogue] / src / client / control.c
index 1ccaf453a5bd9ab8d19300e7840b4dd296b0ce12..76d69ac4562b9b0dc39211fffd1d47767815f9ac 100644 (file)
@@ -1,73 +1,99 @@
-/* src/client/control.c */
+/* src/client/control.c
+ *
+ * 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.
+ */
 
 #include "control.h"
-#include <stdint.h> /* uint8_t, uint16_t */
+#include <stdint.h> /* uint8_t, uint16_t, uint32_t, UINT32_MAX */
+#include <stdlib.h> /* free() */
 #include <stdio.h> /* sprintf() */
-#include <string.h> /* strlen() */
-#include "command_db.h" /* get_command_id(), is_command_id_shortdsc() */
-#include "io.h" /* try_send() */
-#include "keybindings.h" /* struct KeyBindingDB, get_actionname_to_keycode(),
-                         * get_keycode_to_action(), mod_selected_keyb(),
-                          * move_keyb_mod_selection()
+#include <string.h> /* strlen(), strcmp(), strncmp() */
+#include "../common/rexit.h" /* exit_err(), exit_trouble() */
+#include "../common/try_malloc.h" /* try_malloc() */
+#include "interface_conf.h" /* reload_interface_conf(), save_interface_conf() */
+#include "io.h" /* send() */
+#include "keybindings.h" /* get_command_to_keycode(), get_keycode_to_command(),
+                          * mod_selected_keyb(), move_keyb_selection()
                           */
-#include "map_window.h" /* for map_scroll(), map_center() */
-#include "misc.h" /* reload_interface_conf(), save_interface_conf(),
-                   * nav_inventory()
-                   */
-#include "wincontrol.h" /* struct WinConf, toggle_window(), toggle_winconfig(),
-                         * scroll_pad(), get_winconf_by_win(),
-                         * growshrink_active_window(), toggle_win_size_type()
+#include "map.h" /* map_scroll(), map_center(), toggle_autofocus(),
+                  * toggle_lookmode(), lookmode_nav()
+                  */
+#include "wincontrol.h" /* shift_active_win(), resize_active_win(),
+                         * toggle_win_size_type(), toggle_window(),
+                         * cycle_active_win(), scroll_v_screen(),
+                         * toggle_linebreak_type(), toggle_winconfig()
                          */
-#include "windows.h" /* for cycle_active_win(), shift_active_win() */
-#include "world.h" /* for global world */
+#include "windows.h" /* get_win_by_id() */
+#include "world.h" /* world */
 
 
 
-/* If "cmd" matches "match" in get_available_keycode_to_action(), execute "f"
- * with provided char arguments and return 1; else only return 0.
- */
-static uint8_t try_cmd_0args(int cmd, char * match, void (* f) ());
-static uint8_t try_cmd_1args(int cmd, char * match, void (* f) (char), char c);
-static uint8_t try_cmd_2args(int cmd, char * match,
-                             void (* f) (char, char), char c1, char c2);
+/* Move world.inventory_sel up ("dir"="u") or down (else) as far as possible. */
+static void nav_inventory(char dir);
 
-/* If "action" is id of command named "match", send (via try_send()) a string
- * of "match" + " " + the string representation of "arg" to the server.
+/* If "command"'s .dsc_short fits "match", apply "f" with provided char
+ * arguments and return 1; else, return 0.
  */
-static uint8_t try_player_cmd(int action, char * match, char * command,
-                              uint8_t arg);
+static uint8_t try_0args(struct Command * command, char * match, void (* f) ());
+static uint8_t try_1args(struct Command * command, char * match,
+                         void (* f) (char), char c);
 
-/* Return keycode to action of "name" if available in current window config. */
-static uint16_t get_available_keycode_to_action(char * name);
+/* If "command" fits pattern "keyb_XY" with Y a proper keybinding list ID char
+ * and X one of "u" (for "up"), "d" (for "down") or "m" (for "modify"), move up
+ * or down or modify entry in the selected keybinding list.
+ */
+static uint8_t try_kb_manip(char * command);
 
-/* Return pointer to global keybindings or to keybindings for wingeometry config
- * (c = "g") or winkeys config (c = "k") or active window's keybindings ("w").
+/* Try if "command" matches a hard-coded list of client-only commands and, if
+ * successful, execute the match and return 1. Else, return 0.
  */
-static struct KeyBindingDB * select_keybindingdb_pointer(char c);
+static uint8_t try_client_commands(struct Command * command);
+
+/* If c == c_to_match, set "string" to "string_to_set". */
+static uint8_t set_string_if_char_match(char c, char c_to_match,
+                                        char ** string, char * string_to_set);
+
+/* Transform "command" to server command + argument string (free externally). */
+static char * build_server_message_with_argument(struct Command * command);
 
-/* Wrappers to make some functions compatible to try_cmd_* single char args. */
-static void wrap_mod_selected_keyb(char c);
-static void wrap_mv_kb_mod(char c1, char c2);
+/* Try out "command" as one for server messaging; sending is .server_msg,
+ * followed by either a string representing "command"'s .arg, or, if .arg is
+ * 'i', world.player_inventory_select, or, if .arg is '0', nothing. Return 1 on
+ * success, 0 on failure.
+ */
+static uint8_t try_server_commands(struct Command * command);
 
 
 
-static uint8_t try_cmd_0args(int cmd, char * match, void (* f) ())
+static void nav_inventory(char dir)
 {
-    if (cmd == get_available_keycode_to_action(match))
+    if ('u' == dir)
     {
-        f();
-        return 1;
+        world.player_inventory_select = world.player_inventory_select
+                                        - (world.player_inventory_select > 0);
+        return;
     }
-    return 0;
+    uint8_t n_elems = 0;
+    uint32_t i;
+    char * err = "Inventory string is too large.";
+    exit_err(UINT32_MAX <= strlen(world.player_inventory), err);
+    for (i = 0; '\0' != world.player_inventory[i]; i++)
+    {
+        n_elems = n_elems + ('\n' == world.player_inventory[i]);
+    }
+    world.player_inventory_select = world.player_inventory_select
+                                    + (world.player_inventory_select < n_elems);
 }
 
 
 
-static uint8_t try_cmd_1args(int cmd, char * match, void (* f) (char), char c)
+static uint8_t try_0args(struct Command * command, char * match, void (* f) ())
 {
-    if (cmd == get_available_keycode_to_action(match))
+    if (!strcmp(command->dsc_short, match))
     {
-        f(c);
+        f();
         return 1;
     }
     return 0;
@@ -75,12 +101,12 @@ static uint8_t try_cmd_1args(int cmd, char * match, void (* f) (char), char c)
 
 
 
-static uint8_t try_cmd_2args(int cmd, char * match,
-                             void (* f) (char, char), char c1, char c2)
+static uint8_t try_1args(struct Command * command, char * match,
+                             void (* f) (char), char c)
 {
-    if (cmd == get_available_keycode_to_action(match))
+    if (!strcmp(command->dsc_short, match))
     {
-        f(c1, c2);
+        f(c);
         return 1;
     }
     return 0;
@@ -88,16 +114,19 @@ static uint8_t try_cmd_2args(int cmd, char * match,
 
 
 
-static uint8_t try_player_cmd(int action, char * match, char * command,
-                              uint8_t arg)
+static uint8_t try_kb_manip(char * command)
 {
-    if (is_command_id_shortdsc(action, match))
+    char * cmp = "keyb_";
+    if (strlen(command) == strlen(cmp)+2 && !strncmp(command, cmp, strlen(cmp)))
     {
-        uint8_t command_size = strlen(command);
-        uint8_t arg_size = 3;
-        char msg[command_size + 1 + arg_size + 1];
-        sprintf(msg, "%s %d", command, arg);
-        try_send(msg);
+        if ('m' == command[strlen(cmp)])
+        {
+            mod_selected_keyb(command[strlen(cmp) + 1]);
+        }
+        else if ('u' == command[strlen(cmp)] || 'd' == command[strlen(cmp)])
+        {
+            move_keyb_selection(command[strlen(cmp) + 1], command[strlen(cmp)]);
+        }
         return 1;
     }
     return 0;
@@ -105,119 +134,110 @@ static uint8_t try_player_cmd(int action, char * match, char * command,
 
 
 
-static uint16_t get_available_keycode_to_action(char * name)
+static uint8_t try_client_commands(struct Command * command)
 {
-    uint16_t keycode = get_keycode_to_action(world.kb_global.kbs, name);
-    if (0 != keycode || 0 == world.wmeta.active)
-    {
-        return keycode;
-    }
-    struct WinConf * wc = get_winconf_by_win(world.wmeta.active);
-    if (0 == wc->view)
-    {
-        keycode = get_keycode_to_action(wc->kb.kbs, name);
-    }
-    else if (1 == wc->view)
-    {
-        keycode = get_keycode_to_action(world.kb_wingeom.kbs, name);
-    }
-    else if (2 == wc->view)
-    {
-        keycode = get_keycode_to_action(world.kb_winkeys.kbs, name);
-    }
-    return keycode;
+    return (   try_0args(command, "map_c", map_center)
+            || try_0args(command, "to_autofocus", toggle_autofocus)
+            || try_1args(command, "map_u", map_scroll, '8')
+            || try_1args(command, "map_d", map_scroll, '2')
+            || try_1args(command, "map_r", map_scroll, '6')
+            || try_1args(command, "map_l", map_scroll, '4')
+            || try_1args(command, "inv_u", nav_inventory, 'u')
+            || try_1args(command, "inv_d", nav_inventory, 'd')
+            || try_1args(command, "cyc_win_f", cycle_active_win, 'f')
+            || try_1args(command, "cyc_win_b", cycle_active_win, 'b')
+            || try_1args(command, "scrl_r", scroll_v_screen, '+')
+            || try_1args(command, "scrl_l", scroll_v_screen, '-')
+            || try_1args(command, "to_g_keywin", toggle_window, '0')
+            || try_1args(command, "to_wg_keywin", toggle_window, '1')
+            || try_1args(command, "to_wk_keywin", toggle_window, '2')
+            || try_1args(command, "to_mapwin", toggle_window, 'm')
+            || try_1args(command, "to_infowin", toggle_window, 'i')
+            || try_1args(command, "to_inv", toggle_window, 'c')
+            || try_1args(command, "to_logwin", toggle_window, 'l')
+            || try_1args(command, "to_terrain", toggle_window, 's')
+            || try_0args(command, "winconf", toggle_winconfig)
+            || try_1args(command, "grow_h", resize_active_win, '*')
+            || try_1args(command, "shri_h", resize_active_win, '_')
+            || try_1args(command, "grow_v", resize_active_win, '+')
+            || try_1args(command, "shri_v", resize_active_win, '-')
+            || try_0args(command, "to_break", toggle_linebreak_type)
+            || try_1args(command, "to_height_t", toggle_win_size_type, 'y')
+            || try_1args(command, "to_width_t", toggle_win_size_type, 'x')
+            || try_1args(command, "shift_f", shift_active_win, 'f')
+            || try_1args(command, "shift_b", shift_active_win, 'b')
+            || try_0args(command, "reload_conf", reload_interface_conf)
+            || try_0args(command, "save_conf", save_interface_conf)
+            || try_0args(command, "to_look", toggle_lookmode)
+            || try_kb_manip(command->dsc_short));
 }
 
 
 
-static struct KeyBindingDB * select_keybindingdb_pointer(char c)
+static uint8_t set_string_if_char_match(char c, char c_to_match,
+                                        char ** string, char * string_to_set)
 {
-    struct KeyBindingDB * kbd;
-    kbd = &world.kb_global;
-    if      ('g' == c)
-    {
-        kbd = &world.kb_wingeom;
-    }
-    else if ('k' == c)
-    {
-        kbd = &world.kb_winkeys;
-    }
-    else if ('w' == c)
+    if (c == c_to_match)
     {
-        struct WinConf * wc = get_winconf_by_win(world.wmeta.active);
-        kbd = &wc->kb;
+        *string = string_to_set;
+        return 1;
     }
-    return kbd;
-}
-
-
-
-static void wrap_mod_selected_keyb(char c)
-{
-        mod_selected_keyb(select_keybindingdb_pointer(c));
-}
-
-
-
-static void wrap_mv_kb_mod(char c1, char c2)
-{
-        move_keyb_mod_selection(select_keybindingdb_pointer(c1), c2);
+    return 0;
 }
 
 
 
-extern uint8_t player_control(int key)
+static char * build_server_message_with_argument(struct Command * cmd)
 {
-    char * action_name = get_actionname_to_keycode(world.kb_global.kbs, key);
-    if (NULL == action_name && 0 != world.wmeta.active)
+    uint8_t command_size = strlen(cmd->server_msg);
+    char * arg_str = "";
+    uint8_t arg_size = 0;
+    if ('i' == cmd->arg)
     {
-        struct WinConf * wc = get_winconf_by_win(world.wmeta.active);
-        action_name = get_actionname_to_keycode(wc->kb.kbs, key);
+        arg_size = 3;
+        arg_str = try_malloc(arg_size + 1, __func__);
+        int test = sprintf(arg_str, "%d",world.player_inventory_select);
+        exit_trouble(test < 0, __func__, "sprintf");
     }
-    if (NULL != action_name)
+    else if (   set_string_if_char_match(cmd->arg, 'd', &arg_str, "east")
+             || set_string_if_char_match(cmd->arg, 'c', &arg_str, "south-east")
+             || set_string_if_char_match(cmd->arg, 'x', &arg_str, "south-west")
+             || set_string_if_char_match(cmd->arg, 's', &arg_str, "west")
+             || set_string_if_char_match(cmd->arg, 'w', &arg_str, "north-west")
+             || set_string_if_char_match(cmd->arg, 'e', &arg_str, "north-east"))
     {
-        uint8_t id = get_command_id(action_name);
-        if (   try_player_cmd(id, "wait", "wait", 0)
-            || try_player_cmd(id, "drop", "drop", world.player_inventory_select)
-            || try_player_cmd(id, "pick", "pick_up", 0)
-            || try_player_cmd(id, "use", "use", world.player_inventory_select)
-            || try_player_cmd(id, "player_u", "move", 'N')
-            || try_player_cmd(id, "player_d", "move", 'S')
-            || try_player_cmd(id, "player_r", "move", 'E')
-            || try_player_cmd(id, "player_l", "move", 'W'))
-        {
-            return 1;
-        }
+        arg_size = strlen(arg_str);
     }
-    return 0;
-}
-
-
-
-extern uint8_t wingeom_control(int key)
-{
-    if (   try_cmd_1args(key, "to_height_t", toggle_win_size_type, 'y')
-        || try_cmd_1args(key, "to_width_t", toggle_win_size_type, 'x')
-        || try_cmd_1args(key, "grow_h", growshrink_active_window, '*')
-        || try_cmd_1args(key, "shri_h", growshrink_active_window, '_')
-        || try_cmd_1args(key, "grow_v", growshrink_active_window, '+')
-        || try_cmd_1args(key, "shri_v", growshrink_active_window, '-')
-        || try_cmd_1args(key, "shift_f", shift_active_win, 'f')
-        || try_cmd_1args(key, "shift_b", shift_active_win, 'b'))
+    else
     {
-        return 1;
+        exit_err(1, "Illegal server command argument.");
     }
-    return 0;
+    char * msg = try_malloc(command_size + 1 + arg_size + 1, __func__);
+    int test = sprintf(msg, "%s %s", cmd->server_msg, arg_str);
+    exit_trouble(test < 0, __func__, "sprintf");
+    if ('i' == cmd->arg)
+    {
+        free(arg_str);
+    }
+    return msg;
 }
 
 
 
-extern uint8_t winkeyb_control(int key)
+static uint8_t try_server_commands(struct Command * command)
 {
-    if (   try_cmd_1args(key, "w_keys_m", wrap_mod_selected_keyb, 'w')
-        || try_cmd_2args(key, "w_keys_u", wrap_mv_kb_mod, 'w', 'u')
-        || try_cmd_2args(key, "w_keys_d", wrap_mv_kb_mod, 'w', 'd'))
+    if (command->server_msg)
     {
+        if ('0' == command->arg)
+        {
+            send(command->server_msg);
+        }
+        else
+        {
+            char * msg = build_server_message_with_argument(command);
+            send(msg);
+            free(msg);
+        }
         return 1;
     }
     return 0;
@@ -225,43 +245,43 @@ extern uint8_t winkeyb_control(int key)
 
 
 
-extern uint8_t meta_control(int key)
+extern uint8_t try_key(uint16_t key)
 {
-    uint8_t ret = 2 * (key == get_available_keycode_to_action("quit"));
-    if (   (0 == ret)
-        && (   try_cmd_0args(key, "winconf", toggle_winconfig)
-            || try_cmd_0args(key, "reload_conf", reload_interface_conf)
-            || try_cmd_0args(key, "save_conf", save_interface_conf)
-            || try_cmd_0args(key, "map_c", map_center)
-            || try_cmd_1args(key, "scrl_r", scroll_pad, '+')
-            || try_cmd_1args(key, "scrl_l", scroll_pad, '-')
-            || try_cmd_1args(key, "to_a_keywin", toggle_window, 'k')
-            || try_cmd_1args(key, "to_g_keywin", toggle_window, '0')
-            || try_cmd_1args(key, "to_wg_keywin", toggle_window, '1')
-            || try_cmd_1args(key, "to_wk_keywin", toggle_window, '2')
-            || try_cmd_1args(key, "to_mapwin", toggle_window, 'm')
-            || try_cmd_1args(key, "to_infowin", toggle_window, 'i')
-            || try_cmd_1args(key, "to_inv", toggle_window, 'c')
-            || try_cmd_1args(key, "to_logwin", toggle_window, 'l')
-            || try_cmd_1args(key, "cyc_win_f", cycle_active_win, 'f')
-            || try_cmd_1args(key, "cyc_win_b", cycle_active_win, 'b')
-            || try_cmd_1args(key, "g_keys_m", wrap_mod_selected_keyb, 'G')
-            || try_cmd_1args(key, "wg_keys_m", wrap_mod_selected_keyb, 'g')
-            || try_cmd_1args(key, "wk_keys_m", wrap_mod_selected_keyb, 'k')
-            || try_cmd_1args(key, "inv_u", nav_inventory, 'u')
-            || try_cmd_1args(key, "inv_d", nav_inventory, 'd')
-            || try_cmd_1args(key, "map_u", map_scroll, 'N')
-            || try_cmd_1args(key, "map_d", map_scroll, 'S')
-            || try_cmd_1args(key, "map_r", map_scroll, 'E')
-            || try_cmd_1args(key, "map_l", map_scroll, 'W')
-            || try_cmd_2args(key, "g_keys_u", wrap_mv_kb_mod, 'G', 'u')
-            || try_cmd_2args(key, "g_keys_d", wrap_mv_kb_mod, 'G', 'd')
-            || try_cmd_2args(key, "wg_keys_u", wrap_mv_kb_mod, 'g', 'u')
-            || try_cmd_2args(key, "wg_keys_d", wrap_mv_kb_mod, 'g', 'd')
-            || try_cmd_2args(key, "wk_keys_u", wrap_mv_kb_mod, 'k', 'u')
-            || try_cmd_2args(key, "wk_keys_d", wrap_mv_kb_mod, 'k', 'd')))
+    struct Command * command = get_command_to_keycode(&world.kb_global, key);
+    if (!command && world.winDB.active)
     {
-        ret = 1;
+        struct Win * w = get_win_by_id(world.winDB.active);
+        if      (0 == w->view)
+        {
+            command = get_command_to_keycode(&w->kb, key);
+        }
+        else if (1 == w->view)
+        {
+            command = get_command_to_keycode(&world.kb_wingeom, key);
+        }
+        else if (2 == w->view)
+        {
+            command = get_command_to_keycode(&world.kb_winkeys, key);
+        }
     }
-    return ret;
+    if (command)
+    {
+        if (world.look && lookmode_nav(command->dsc_short))
+        {
+            return 1;
+        }
+        else if (try_client_commands(command))
+        {
+            return 1;
+        }
+        else if (try_server_commands(command))
+        {
+            return 1;
+        }
+        else if (!strcmp("quit", command->dsc_short))
+        {
+            return 2;
+        }
+    }
+    return 0;
 }