src/screen_keydef.c

   1 /* ncmpc (Ncurses MPD Client)
   2  * (c) 2004-2010 The Music Player Daemon Project
   3  * Project homepage: http://musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #include "screen_keydef.h"
  21 #include "screen_interface.h"
  22 #include "screen_status.h"
  23 #include "screen_find.h"
  24 #include "i18n.h"
  25 #include "conf.h"
  26 #include "screen.h"
  27 #include "screen_utils.h"
  28
  29 #include <assert.h>
  30 #include <errno.h>
  31 #include <string.h>
  32 #include <glib.h>
  33
  34 static struct list_window *lw;
  35
  36 static command_definition_t *cmds = NULL;
  37
  38 /** the number of commands */
  39 static unsigned command_n_commands = 0;
  40
  41 /**
  42  * the position of the "apply" item. It's the same as command_n_commands,
  43  * because array subscripts start at 0, while numbers of items start at 1.
  44  */
  45 #define command_item_apply (command_n_commands)
  46
  47 /** the position of the "apply and save" item */
  48 #define command_item_save  (command_item_apply + 1)
  49
  50 /** the number of items on the "command" view */
  51 #define command_length     (command_item_save + 1)
  52
  53
  54 /**
  55  * The command being edited, represented by a array subscript to @cmds, or -1,
  56  * if no command is being edited
  57  */
  58 static int subcmd = -1;
  59
  60 /** The number of keys assigned to the current command */
  61 static unsigned subcmd_n_keys = 0;
  62
  63 /** The position of the up ("[..]") item */
  64 #define subcmd_item_up  0
  65
  66 /** The position of the "add a key" item */
  67 #define subcmd_item_add (subcmd_n_keys + 1)
  68
  69 /** The number of items in the list_window, if there's a command being edited */
  70 #define subcmd_length   (subcmd_item_add + 1)
  71
  72 /** Check whether a given item is a key */
  73 #define subcmd_item_is_key(i) \
  74                         ((i) > subcmd_item_up && (i) < subcmd_item_add)
  75
  76 /**
  77  * Convert an item id (as in lw->selected) into a "key id", which is an array
  78  * subscript to cmds[subcmd].keys.
  79  */
  80 #define subcmd_item_to_key_id(i) ((i) - 1)
  81
  82
  83 static int
  84 keybindings_changed(void)
  85 {
  86         command_definition_t *orginal_cmds = get_command_definitions();
  87         size_t size = command_n_commands * sizeof(command_definition_t);
  88
  89         return memcmp(orginal_cmds, cmds, size);
  90 }
  91
  92 static void
  93 apply_keys(void)
  94 {
  95         if (keybindings_changed()) {
  96                 command_definition_t *orginal_cmds = get_command_definitions();
  97                 size_t size = command_n_commands * sizeof(command_definition_t);
  98
  99                 memcpy(orginal_cmds, cmds, size);
 100                 screen_status_printf(_("You have new key bindings"));
 101         } else
 102                 screen_status_printf(_("Keybindings unchanged."));
 103 }
 104
 105 static int
 106 save_keys(void)
 107 {
 108         FILE *f;
 109         char *filename;
 110
 111         if (check_user_conf_dir()) {
 112                 screen_status_printf(_("Error: Unable to create directory ~/.ncmpc - %s"),
 113                                      strerror(errno));
 114                 screen_bell();
 115                 return -1;
 116         }
 117
 118         filename = get_user_key_binding_filename();
 119
 120         if ((f = fopen(filename,"w")) == NULL) {
 121                 screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
 122                 screen_bell();
 123                 g_free(filename);
 124                 return -1;
 125         }
 126
 127         if (write_key_bindings(f, KEYDEF_WRITE_HEADER))
 128                 screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
 129         else
 130                 screen_status_printf(_("Wrote %s"), filename);
 131
 132         g_free(filename);
 133         return fclose(f);
 134 }
 135
 136 /* TODO: rename to check_n_keys / subcmd_count_keys? */
 137 static void
 138 check_subcmd_length(void)
 139 {
 140         unsigned i;
 141
 142         /* this loops counts the continous valid keys at the start of the the keys
 143            array, so make sure you don't have gaps */
 144         for (i = 0; i < MAX_COMMAND_KEYS; i++)
 145                 if (cmds[subcmd].keys[i] == 0)
 146                         break;
 147         subcmd_n_keys = i;
 148
 149         list_window_set_length(lw, subcmd_length);
 150 }
 151
 152 static void
 153 keydef_paint(void);
 154
 155 static void
 156 keydef_repaint(void)
 157 {
 158         keydef_paint();
 159         wrefresh(lw->w);
 160 }
 161
 162 /**
 163  * Delete a key from a given command's definition
 164  * @param cmd_index the command
 165  * @param key_index the key (see below)
 166  */
 167 static void
 168 delete_key(int cmd_index, int key_index)
 169 {
 170         /* shift the keys to close the gap that appeared */
 171         int i = key_index+1;
 172         while (i < MAX_COMMAND_KEYS && cmds[cmd_index].keys[i])
 173                 cmds[cmd_index].keys[key_index++] = cmds[cmd_index].keys[i++];
 174
 175         /* As key_index now holds the index of the last key slot that contained
 176            a key, we use it to empty this slot, because this key has been copied
 177            to the previous slot in the loop above */
 178         cmds[cmd_index].keys[key_index] = 0;
 179
 180         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 181         check_subcmd_length();
 182
 183         screen_status_printf(_("Deleted"));
 184
 185         /* repaint */
 186         keydef_repaint();
 187
 188         /* update key conflict flags */
 189         check_key_bindings(cmds, NULL, 0);
 190 }
 191
 192 static void
 193 assign_new_key(int cmd_index, int key_index)
 194 {
 195         int key;
 196         char *buf;
 197         command_t cmd;
 198
 199         buf = g_strdup_printf(_("Enter new key for %s: "), cmds[cmd_index].name);
 200         key = screen_getch(buf);
 201         g_free(buf);
 202
 203         if (key==ERR) {
 204                 screen_status_printf(_("Aborted"));
 205                 return;
 206         }
 207
 208         cmd = find_key_command(key, cmds);
 209         if (cmd != CMD_NONE) {
 210                 screen_status_printf(_("Error: key %s is already used for %s"),
 211                                      key2str(key),
 212                                      get_key_command_name(cmd));
 213                 screen_bell();
 214                 return;
 215         }
 216
 217         cmds[cmd_index].keys[key_index] = key;
 218         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 219
 220         screen_status_printf(_("Assigned %s to %s"),
 221                              key2str(key),cmds[cmd_index].name);
 222         check_subcmd_length();
 223
 224         /* repaint */
 225         keydef_repaint();
 226
 227         /* update key conflict flags */
 228         check_key_bindings(cmds, NULL, 0);
 229 }
 230
 231 static const char *
 232 list_callback(unsigned idx, G_GNUC_UNUSED void *data)
 233 {
 234         static char buf[256];
 235
 236         if (subcmd == -1) {
 237                 if (idx == command_item_apply)
 238                         return _("===> Apply key bindings ");
 239                 if (idx == command_item_save)
 240                         return _("===> Apply & Save key bindings  ");
 241
 242                 assert(idx < (unsigned) command_n_commands);
 243
 244                 /*
 245                  * Format the lines in two aligned columnes for the key name and
 246                  * the description, like this:
 247                  *
 248                  *      this-command - do this
 249                  *      that-one     - do that
 250                  */
 251                 size_t len = strlen(cmds[idx].name);
 252                 strncpy(buf, cmds[idx].name, sizeof(buf));
 253
 254                 if (len < get_cmds_max_name_width(cmds))
 255                         memset(buf + len, ' ', get_cmds_max_name_width(cmds) - len);
 256
 257                 g_snprintf(buf + get_cmds_max_name_width(cmds),
 258                            sizeof(buf) - get_cmds_max_name_width(cmds),
 259                            " - %s", _(cmds[idx].description));
 260
 261                 return buf;
 262         } else {
 263                 if (idx == subcmd_item_up)
 264                         return "[..]";
 265
 266                 if (idx == subcmd_item_add) {
 267                         g_snprintf(buf, sizeof(buf), "%d. %s",
 268                                    idx, _("Add new key"));
 269                         return buf;
 270                 }
 271
 272                 assert(subcmd_item_is_key(idx));
 273
 274                 g_snprintf(buf, sizeof(buf),
 275                            "%d. %-20s   (%d) ", idx,
 276                            key2str(cmds[subcmd].keys[subcmd_item_to_key_id(idx)]),
 277                            cmds[subcmd].keys[subcmd_item_to_key_id(idx)]);
 278                 return buf;
 279         }
 280 }
 281
 282 static void
 283 keydef_init(WINDOW *w, int cols, int rows)
 284 {
 285         lw = list_window_init(w, cols, rows);
 286 }
 287
 288 static void
 289 keydef_resize(int cols, int rows)
 290 {
 291         list_window_resize(lw, cols, rows);
 292 }
 293
 294 static void
 295 keydef_exit(void)
 296 {
 297         list_window_free(lw);
 298         if (cmds)
 299                 g_free(cmds);
 300         cmds = NULL;
 301         lw = NULL;
 302 }
 303
 304 static void
 305 keydef_open(G_GNUC_UNUSED struct mpdclient *c)
 306 {
 307         if (cmds == NULL) {
 308                 command_definition_t *current_cmds = get_command_definitions();
 309                 size_t cmds_size;
 310
 311                 command_n_commands = 0;
 312                 while (current_cmds[command_n_commands].name)
 313                         command_n_commands++;
 314
 315                 /* +1 for the terminator element */
 316                 cmds_size = (command_n_commands + 1) * sizeof(command_definition_t);
 317                 cmds = g_malloc0(cmds_size);
 318                 memcpy(cmds, current_cmds, cmds_size);
 319         }
 320
 321         subcmd = -1;
 322         list_window_set_length(lw, command_length);
 323 }
 324
 325 static void
 326 keydef_close(void)
 327 {
 328         if (cmds && !keybindings_changed()) {
 329                 g_free(cmds);
 330                 cmds = NULL;
 331         } else
 332                 screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
 333 }
 334
 335 static const char *
 336 keydef_title(char *str, size_t size)
 337 {
 338         if (subcmd == -1)
 339                 return _("Edit key bindings");
 340
 341         g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
 342         return str;
 343 }
 344
 345 static void
 346 keydef_paint(void)
 347 {
 348         list_window_paint(lw, list_callback, NULL);
 349 }
 350
 351 static bool
 352 keydef_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
 353 {
 354         if (cmd == CMD_LIST_RANGE_SELECT)
 355                 return false;
 356
 357         if (list_window_cmd(lw, cmd)) {
 358                 keydef_repaint();
 359                 return true;
 360         }
 361
 362         switch(cmd) {
 363         case CMD_PLAY:
 364                 if (subcmd == -1) {
 365                         if (lw->selected == command_item_apply) {
 366                                 apply_keys();
 367                         } else if (lw->selected == command_item_save) {
 368                                 apply_keys();
 369                                 save_keys();
 370                         } else {
 371                                 subcmd = lw->selected;
 372                                 list_window_reset(lw);
 373                                 check_subcmd_length();
 374
 375                                 keydef_repaint();
 376                         }
 377                 } else {
 378                         if (lw->selected == subcmd_item_up) {
 379                                 list_window_set_length(lw, command_length);
 380                                 list_window_set_cursor(lw, subcmd);
 381                                 subcmd = -1;
 382
 383                                 keydef_repaint();
 384                         } else {
 385                                 /* TODO: subcmd_item_add should be handled
 386                                    separately, just for clarity */
 387                                 assign_new_key(subcmd, subcmd_item_to_key_id(lw->selected));
 388                         }
 389                 }
 390                 return true;
 391         case CMD_GO_PARENT_DIRECTORY:
 392                 if (subcmd != -1) {
 393                         list_window_set_length(lw, command_length);
 394                         list_window_set_cursor(lw, subcmd);
 395                         subcmd = -1;
 396
 397                         keydef_repaint();
 398                 }
 399                 return true;
 400         case CMD_DELETE:
 401                 if (subcmd != -1 && subcmd_item_is_key(lw->selected))
 402                         delete_key(subcmd, subcmd_item_to_key_id(lw->selected));
 403
 404                 return true;
 405         case CMD_SAVE_PLAYLIST:
 406                 apply_keys();
 407                 save_keys();
 408                 return true;
 409         case CMD_LIST_FIND:
 410         case CMD_LIST_RFIND:
 411         case CMD_LIST_FIND_NEXT:
 412         case CMD_LIST_RFIND_NEXT:
 413                 screen_find(lw, cmd, list_callback, NULL);
 414                 keydef_repaint();
 415                 return true;
 416
 417         default:
 418                 return false;
 419         }
 420
 421         /* unreachable */
 422         assert(0);
 423         return false;
 424 }
 425
 426 const struct screen_functions screen_keydef = {
 427         .init = keydef_init,
 428         .exit = keydef_exit,
 429         .open = keydef_open,
 430         .close = keydef_close,
 431         .resize = keydef_resize,
 432         .paint = keydef_paint,
 433         .cmd = keydef_cmd,
 434         .get_title = keydef_title,
 435 };