home · contact · privacy
Client: Restructure passing of keybinding manipulation commands.
[plomrogue] / src / client / control.c
1 /* src/client/control.c
2  *
3  * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
4  * or any later version. For details on its copyright, license, and warranties,
5  * see the file NOTICE in the root directory of the PlomRogue source package.
6  */
7
8 #include "control.h"
9 #include <stdint.h> /* uint8_t, uint16_t, uint32_t, UINT32_MAX */
10 #include <stdlib.h> /* free() */
11 #include <stdio.h> /* sprintf() */
12 #include <string.h> /* strlen(), strcmp(), strncmp() */
13 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
14 #include "../common/try_malloc.h" /* try_malloc() */
15 #include "interface_conf.h" /* reload_interface_conf(), save_interface_conf() */
16 #include "io.h" /* send() */
17 #include "keybindings.h" /* get_command_to_keycode(), get_keycode_to_command(),
18                           * mod_selected_keyb(), move_keyb_selection()
19                           */
20 #include "map.h" /* map_scroll(), map_center(), toggle_autofocus() */
21 #include "wincontrol.h" /* shift_active_win(), resize_active_win(),
22                          * toggle_win_size_type(), toggle_window(),
23                          * cycle_active_win(), scroll_v_screen(),
24                          * toggle_linebreak_type(), toggle_winconfig()
25                          */
26 #include "windows.h" /* get_win_by_id() */
27 #include "world.h" /* world */
28
29
30
31 /* Move world.inventory_sel up ("dir"="u") or down (else) as far as possible. */
32 static void nav_inventory(char dir);
33
34 /* If "command"'s .dsc_short fits "match", apply "f" with provided char
35  * arguments and return 1; else, return 0.
36  */
37 static uint8_t try_0args(struct Command * command, char * match, void (* f) ());
38 static uint8_t try_1args(struct Command * command, char * match,
39                          void (* f) (char), char c);
40
41 /* If "command" fits pattern "keyb_XY" with Y a proper keybinding list ID char
42  * and X one of "u" (for "up"), "d" (for "down") or "m" (for "modify"), move up
43  * or down or modify entry in the selected keybinding list.
44  */
45 static uint8_t try_kb_manip(char * command);
46
47 /* Try if "command" matches a hard-coded list of client-only commands and, if
48  * successful, execute the match and return 1. Else, return 0.
49  */
50 static uint8_t try_client_commands(struct Command * command);
51
52 /* If c == c_to_match, set "string" to "string_to_set". */
53 static uint8_t set_string_if_char_match(char c, char c_to_match,
54                                         char ** string, char * string_to_set);
55
56 /* Transform "command" to server command + argument string (free externally). */
57 static char * build_server_message_with_argument(struct Command * command);
58
59 /* Try out "command" as one for server messaging; sending is .server_msg,
60  * followed by either a string representing "command"'s .arg, or, if .arg is
61  * 'i', world.player_inventory_select, or, if .arg is '0', nothing. Return 1 on
62  * success, 0 on failure.
63  */
64 static uint8_t try_server_commands(struct Command * command);
65
66
67
68 static void nav_inventory(char dir)
69 {
70     if ('u' == dir)
71     {
72         world.player_inventory_select = world.player_inventory_select
73                                         - (world.player_inventory_select > 0);
74         return;
75     }
76     uint8_t n_elems = 0;
77     uint32_t i;
78     char * err = "Inventory string is too large.";
79     exit_err(UINT32_MAX <= strlen(world.player_inventory), err);
80     for (i = 0; '\0' != world.player_inventory[i]; i++)
81     {
82         n_elems = n_elems + ('\n' == world.player_inventory[i]);
83     }
84     world.player_inventory_select = world.player_inventory_select
85                                     + (world.player_inventory_select < n_elems);
86 }
87
88
89
90 static uint8_t try_0args(struct Command * command, char * match, void (* f) ())
91 {
92     if (!strcmp(command->dsc_short, match))
93     {
94         f();
95         return 1;
96     }
97     return 0;
98 }
99
100 static uint8_t try_1args(struct Command * command, char * match,
101                              void (* f) (char), char c)
102 {
103     if (!strcmp(command->dsc_short, match))
104     {
105         f(c);
106         return 1;
107     }
108     return 0;
109 }
110
111
112
113 /* If "command" fits pattern "keyb_XY" with Y a proper keybinding list ID char
114  * and X one of "u" (for "up"), "d" (for "down") or "m" (for "modify"), move up
115  * or down or modify entry in the selected keybinding list.
116  */
117 static uint8_t try_kb_manip(char * command)
118 {
119     char * cmp = "keyb_";
120     if (strlen(command) == strlen(cmp)+2 && !strncmp(command, cmp, strlen(cmp)))
121     {
122         if ('m' == command[strlen(cmp)])
123         {
124             mod_selected_keyb(command[strlen(cmp) + 1]);
125         }
126         else if ('u' == command[strlen(cmp)] || 'd' == command[strlen(cmp)])
127         {
128             move_keyb_selection(command[strlen(cmp) + 1], command[strlen(cmp)]);
129         }
130         return 1;
131     }
132     return 0;
133 }
134
135
136
137 static uint8_t try_client_commands(struct Command * command)
138 {
139     return (   try_0args(command, "map_c", map_center)
140             || try_0args(command, "to_autofocus", toggle_autofocus)
141             || try_1args(command, "map_u", map_scroll, '8')
142             || try_1args(command, "map_d", map_scroll, '2')
143             || try_1args(command, "map_r", map_scroll, '6')
144             || try_1args(command, "map_l", map_scroll, '4')
145             || try_1args(command, "inv_u", nav_inventory, 'u')
146             || try_1args(command, "inv_d", nav_inventory, 'd')
147             || try_1args(command, "cyc_win_f", cycle_active_win, 'f')
148             || try_1args(command, "cyc_win_b", cycle_active_win, 'b')
149             || try_1args(command, "scrl_r", scroll_v_screen, '+')
150             || try_1args(command, "scrl_l", scroll_v_screen, '-')
151             || try_1args(command, "to_a_keywin", toggle_window, 'a')
152             || try_1args(command, "to_g_keywin", toggle_window, '0')
153             || try_1args(command, "to_wg_keywin", toggle_window, '1')
154             || try_1args(command, "to_wk_keywin", toggle_window, '2')
155             || try_1args(command, "to_mapwin", toggle_window, 'm')
156             || try_1args(command, "to_infowin", toggle_window, 'i')
157             || try_1args(command, "to_inv", toggle_window, 'c')
158             || try_1args(command, "to_logwin", toggle_window, 'l')
159             || try_0args(command, "winconf", toggle_winconfig)
160             || try_1args(command, "grow_h", resize_active_win, '*')
161             || try_1args(command, "shri_h", resize_active_win, '_')
162             || try_1args(command, "grow_v", resize_active_win, '+')
163             || try_1args(command, "shri_v", resize_active_win, '-')
164             || try_0args(command, "to_break", toggle_linebreak_type)
165             || try_1args(command, "to_height_t", toggle_win_size_type, 'y')
166             || try_1args(command, "to_width_t", toggle_win_size_type, 'x')
167             || try_1args(command, "shift_f", shift_active_win, 'f')
168             || try_1args(command, "shift_b", shift_active_win, 'b')
169             || try_0args(command, "reload_conf", reload_interface_conf)
170             || try_0args(command, "save_conf", save_interface_conf)
171             || try_kb_manip(command->dsc_short));
172 }
173
174
175
176 static uint8_t set_string_if_char_match(char c, char c_to_match,
177                                         char ** string, char * string_to_set)
178 {
179     if (c == c_to_match)
180     {
181         *string = string_to_set;
182         return 1;
183     }
184     return 0;
185 }
186
187
188
189 static char * build_server_message_with_argument(struct Command * cmd)
190 {
191     uint8_t command_size = strlen(cmd->server_msg);
192     char * arg_str = "";
193     uint8_t arg_size = 0;
194     if ('i' == cmd->arg)
195     {
196         arg_size = 3;
197         arg_str = try_malloc(arg_size + 1, __func__);
198         int test = sprintf(arg_str, "%d",world.player_inventory_select);
199         exit_trouble(test < 0, __func__, "sprintf");
200     }
201     else if (   set_string_if_char_match(cmd->arg, 'd', &arg_str, "east")
202              || set_string_if_char_match(cmd->arg, 'c', &arg_str, "south-east")
203              || set_string_if_char_match(cmd->arg, 'x', &arg_str, "south-west")
204              || set_string_if_char_match(cmd->arg, 's', &arg_str, "west")
205              || set_string_if_char_match(cmd->arg, 'w', &arg_str, "north-west")
206              || set_string_if_char_match(cmd->arg, 'e', &arg_str, "north-east"))
207     {
208         arg_size = strlen(arg_str);
209     }
210     else
211     {
212         exit_err(1, "Illegal server command argument.");
213     }
214     char * msg = try_malloc(command_size + 1 + arg_size + 1, __func__);
215     int test = sprintf(msg, "%s %s", cmd->server_msg, arg_str);
216     exit_trouble(test < 0, __func__, "sprintf");
217     if ('i' == cmd->arg)
218     {
219         free(arg_str);
220     }
221     return msg;
222 }
223
224
225
226 static uint8_t try_server_commands(struct Command * command)
227 {
228     if (command->server_msg)
229     {
230         if ('0' == command->arg)
231         {
232             send(command->server_msg);
233         }
234         else
235         {
236             char * msg = build_server_message_with_argument(command);
237             send(msg);
238             free(msg);
239         }
240         return 1;
241     }
242     return 0;
243 }
244
245
246
247 extern uint8_t try_key(uint16_t key)
248 {
249     struct Command * command = get_command_to_keycode(&world.kb_global, key);
250     if (!command && world.winDB.active)
251     {
252         struct Win * w = get_win_by_id(world.winDB.active);
253         if      (0 == w->view)
254         {
255             command = get_command_to_keycode(&w->kb, key);
256         }
257         else if (1 == w->view)
258         {
259             command = get_command_to_keycode(&world.kb_wingeom, key);
260         }
261         else if (2 == w->view)
262         {
263             command = get_command_to_keycode(&world.kb_winkeys, key);
264         }
265     }
266     if (command)
267     {
268         if      (try_server_commands(command))
269         {
270             return 1;
271         }
272         else if (try_client_commands(command))
273         {
274             return 1;
275         }
276         else if (!strcmp("quit", command->dsc_short))
277         {
278             return 2;
279         }
280     }
281     return 0;
282 }