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 static G_GNUC_PURE inline unsigned
  46 command_item_apply(void)
  47 {
  48         return command_n_commands;
  49 }
  50
  51 /** the position of the "apply and save" item */
  52 static G_GNUC_PURE inline unsigned
  53 command_item_save(void)
  54 {
  55         return command_item_apply() + 1;
  56 }
  57
  58 /** the number of items in the "command" view */
  59 static G_GNUC_PURE inline unsigned
  60 command_length(void)
  61 {
  62         return command_item_save() + 1;
  63 }
  64
  65
  66 /**
  67  * The command being edited, represented by a array subscript to @cmds, or -1,
  68  * if no command is being edited
  69  */
  70 static int subcmd = -1;
  71
  72 /** The number of keys assigned to the current command */
  73 static unsigned subcmd_n_keys = 0;
  74
  75 /** The position of the up ("[..]") item */
  76 static G_GNUC_CONST inline unsigned
  77 subcmd_item_up(void)
  78 {
  79         return 0;
  80 }
  81
  82 /** The position of the "add a key" item */
  83 static G_GNUC_PURE inline unsigned
  84 subcmd_item_add(void)
  85 {
  86         return subcmd_n_keys + 1;
  87 }
  88
  89 /** The number of items in the list_window, if there's a command being edited */
  90 static G_GNUC_PURE inline unsigned
  91 subcmd_length(void)
  92 {
  93         return subcmd_item_add() + 1;
  94 }
  95
  96 /** Check whether a given item is a key */
  97 static G_GNUC_PURE inline bool
  98 subcmd_item_is_key(unsigned i)
  99 {
 100         return (i > subcmd_item_up() && i < subcmd_item_add());
 101 }
 102
 103 /**
 104  * Convert an item id (as in lw->selected) into a "key id", which is an array
 105  * subscript to cmds[subcmd].keys.
 106  */
 107 static G_GNUC_CONST inline unsigned
 108 subcmd_item_to_key_id(unsigned i)
 109 {
 110         return i - 1;
 111 }
 112
 113
 114 static int
 115 keybindings_changed(void)
 116 {
 117         command_definition_t *orginal_cmds = get_command_definitions();
 118         size_t size = command_n_commands * sizeof(command_definition_t);
 119
 120         return memcmp(orginal_cmds, cmds, size);
 121 }
 122
 123 static void
 124 apply_keys(void)
 125 {
 126         if (keybindings_changed()) {
 127                 command_definition_t *orginal_cmds = get_command_definitions();
 128                 size_t size = command_n_commands * sizeof(command_definition_t);
 129
 130                 memcpy(orginal_cmds, cmds, size);
 131                 screen_status_printf(_("You have new key bindings"));
 132         } else
 133                 screen_status_printf(_("Keybindings unchanged."));
 134 }
 135
 136 static int
 137 save_keys(void)
 138 {
 139         FILE *f;
 140         char *filename;
 141
 142         if (check_user_conf_dir()) {
 143                 screen_status_printf(_("Error: Unable to create directory ~/.ncmpc - %s"),
 144                                      strerror(errno));
 145                 screen_bell();
 146                 return -1;
 147         }
 148
 149         filename = build_user_key_binding_filename();
 150
 151         if ((f = fopen(filename,"w")) == NULL) {
 152                 screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
 153                 screen_bell();
 154                 g_free(filename);
 155                 return -1;
 156         }
 157
 158         if (write_key_bindings(f, KEYDEF_WRITE_HEADER))
 159                 screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
 160         else
 161                 screen_status_printf(_("Wrote %s"), filename);
 162
 163         g_free(filename);
 164         return fclose(f);
 165 }
 166
 167 /* TODO: rename to check_n_keys / subcmd_count_keys? */
 168 static void
 169 check_subcmd_length(void)
 170 {
 171         unsigned i;
 172
 173         /* this loops counts the continous valid keys at the start of the the keys
 174            array, so make sure you don't have gaps */
 175         for (i = 0; i < MAX_COMMAND_KEYS; i++)
 176                 if (cmds[subcmd].keys[i] == 0)
 177                         break;
 178         subcmd_n_keys = i;
 179
 180         list_window_set_length(lw, subcmd_length());
 181 }
 182
 183 static void
 184 keydef_paint(void);
 185
 186 static void
 187 keydef_repaint(void)
 188 {
 189         keydef_paint();
 190         wrefresh(lw->w);
 191 }
 192
 193 /** lw->start the last time switch_to_subcmd_mode() was called */
 194 static unsigned saved_start = 0;
 195
 196 static void
 197 switch_to_subcmd_mode(int cmd)
 198 {
 199         assert(subcmd == -1);
 200
 201         saved_start = lw->start;
 202
 203         subcmd = cmd;
 204         list_window_reset(lw);
 205         check_subcmd_length();
 206
 207         keydef_repaint();
 208 }
 209
 210 static void
 211 switch_to_command_mode(void)
 212 {
 213         assert(subcmd != -1);
 214
 215         list_window_set_length(lw, command_length());
 216         list_window_set_cursor(lw, subcmd);
 217         subcmd = -1;
 218
 219         lw->start = saved_start;
 220
 221         keydef_repaint();
 222 }
 223
 224 /**
 225  * Delete a key from a given command's definition
 226  * @param cmd_index the command
 227  * @param key_index the key (see below)
 228  */
 229 static void
 230 delete_key(int cmd_index, int key_index)
 231 {
 232         /* shift the keys to close the gap that appeared */
 233         int i = key_index+1;
 234         while (i < MAX_COMMAND_KEYS && cmds[cmd_index].keys[i])
 235                 cmds[cmd_index].keys[key_index++] = cmds[cmd_index].keys[i++];
 236
 237         /* As key_index now holds the index of the last key slot that contained
 238            a key, we use it to empty this slot, because this key has been copied
 239            to the previous slot in the loop above */
 240         cmds[cmd_index].keys[key_index] = 0;
 241
 242         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 243         check_subcmd_length();
 244
 245         screen_status_printf(_("Deleted"));
 246
 247         /* repaint */
 248         keydef_repaint();
 249
 250         /* update key conflict flags */
 251         check_key_bindings(cmds, NULL, 0);
 252 }
 253
 254 /* assigns a new key to a key slot */
 255 static void
 256 overwrite_key(int cmd_index, int key_index)
 257 {
 258         int key;
 259         char *buf;
 260         command_t cmd;
 261
 262         assert(key_index < MAX_COMMAND_KEYS);
 263
 264         buf = g_strdup_printf(_("Enter new key for %s: "), cmds[cmd_index].name);
 265         key = screen_getch(buf);
 266         g_free(buf);
 267
 268         if (key == ERR) {
 269                 screen_status_printf(_("Aborted"));
 270                 return;
 271         }
 272
 273         if (key == '\0') {
 274                 screen_status_printf(_("Ctrl-Space can't be used"));
 275                 return;
 276         }
 277
 278         cmd = find_key_command(key, cmds);
 279         if (cmd != CMD_NONE) {
 280                 screen_status_printf(_("Error: key %s is already used for %s"),
 281                                      key2str(key), get_key_command_name(cmd));
 282                 screen_bell();
 283                 return;
 284         }
 285
 286         cmds[cmd_index].keys[key_index] = key;
 287         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 288
 289         screen_status_printf(_("Assigned %s to %s"),
 290                              key2str(key),cmds[cmd_index].name);
 291         check_subcmd_length();
 292
 293         /* repaint */
 294         keydef_repaint();
 295
 296         /* update key conflict flags */
 297         check_key_bindings(cmds, NULL, 0);
 298 }
 299
 300 /* assign a new key to a new slot */
 301 static void
 302 add_key(int cmd_index)
 303 {
 304         if (subcmd_n_keys < MAX_COMMAND_KEYS)
 305                 overwrite_key(cmd_index, subcmd_n_keys);
 306 }
 307
 308 static const char *
 309 list_callback(unsigned idx, G_GNUC_UNUSED void *data)
 310 {
 311         static char buf[256];
 312
 313         if (subcmd == -1) {
 314                 if (idx == command_item_apply())
 315                         return _("===> Apply key bindings ");
 316                 if (idx == command_item_save())
 317                         return _("===> Apply & Save key bindings  ");
 318
 319                 assert(idx < (unsigned) command_n_commands);
 320
 321                 /*
 322                  * Format the lines in two aligned columnes for the key name and
 323                  * the description, like this:
 324                  *
 325                  *      this-command - do this
 326                  *      that-one     - do that
 327                  */
 328                 size_t len = strlen(cmds[idx].name);
 329                 strncpy(buf, cmds[idx].name, sizeof(buf));
 330
 331                 if (len < get_cmds_max_name_width(cmds))
 332                         memset(buf + len, ' ', get_cmds_max_name_width(cmds) - len);
 333
 334                 g_snprintf(buf + get_cmds_max_name_width(cmds),
 335                            sizeof(buf) - get_cmds_max_name_width(cmds),
 336                            " - %s", _(cmds[idx].description));
 337
 338                 return buf;
 339         } else {
 340                 if (idx == subcmd_item_up())
 341                         return "[..]";
 342
 343                 if (idx == subcmd_item_add()) {
 344                         g_snprintf(buf, sizeof(buf), "%d. %s",
 345                                    idx, _("Add new key"));
 346                         return buf;
 347                 }
 348
 349                 assert(subcmd_item_is_key(idx));
 350
 351                 g_snprintf(buf, sizeof(buf),
 352                            "%d. %-20s   (%d) ", idx,
 353                            key2str(cmds[subcmd].keys[subcmd_item_to_key_id(idx)]),
 354                            cmds[subcmd].keys[subcmd_item_to_key_id(idx)]);
 355                 return buf;
 356         }
 357 }
 358
 359 static void
 360 keydef_init(WINDOW *w, int cols, int rows)
 361 {
 362         lw = list_window_init(w, cols, rows);
 363 }
 364
 365 static void
 366 keydef_resize(int cols, int rows)
 367 {
 368         list_window_resize(lw, cols, rows);
 369 }
 370
 371 static void
 372 keydef_exit(void)
 373 {
 374         list_window_free(lw);
 375         if (cmds)
 376                 g_free(cmds);
 377         cmds = NULL;
 378         lw = NULL;
 379 }
 380
 381 static void
 382 keydef_open(G_GNUC_UNUSED struct mpdclient *c)
 383 {
 384         if (cmds == NULL) {
 385                 command_definition_t *current_cmds = get_command_definitions();
 386                 size_t cmds_size;
 387
 388                 command_n_commands = 0;
 389                 while (current_cmds[command_n_commands].name)
 390                         command_n_commands++;
 391
 392                 /* +1 for the terminator element */
 393                 cmds_size = (command_n_commands + 1) * sizeof(command_definition_t);
 394                 cmds = g_malloc0(cmds_size);
 395                 memcpy(cmds, current_cmds, cmds_size);
 396         }
 397
 398         subcmd = -1;
 399         list_window_set_length(lw, command_length());
 400 }
 401
 402 static void
 403 keydef_close(void)
 404 {
 405         if (cmds && !keybindings_changed()) {
 406                 g_free(cmds);
 407                 cmds = NULL;
 408         } else
 409                 screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
 410 }
 411
 412 static const char *
 413 keydef_title(char *str, size_t size)
 414 {
 415         if (subcmd == -1)
 416                 return _("Edit key bindings");
 417
 418         g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
 419         return str;
 420 }
 421
 422 static void
 423 keydef_paint(void)
 424 {
 425         list_window_paint(lw, list_callback, NULL);
 426 }
 427
 428 static bool
 429 keydef_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
 430 {
 431         if (cmd == CMD_LIST_RANGE_SELECT)
 432                 return false;
 433
 434         if (list_window_cmd(lw, cmd)) {
 435                 keydef_repaint();
 436                 return true;
 437         }
 438
 439         switch(cmd) {
 440         case CMD_PLAY:
 441                 if (subcmd == -1) {
 442                         if (lw->selected == command_item_apply()) {
 443                                 apply_keys();
 444                         } else if (lw->selected == command_item_save()) {
 445                                 apply_keys();
 446                                 save_keys();
 447                         } else {
 448                                 switch_to_subcmd_mode(lw->selected);
 449                         }
 450                 } else {
 451                         if (lw->selected == subcmd_item_up()) {
 452                                 switch_to_command_mode();
 453                         } else if (lw->selected == subcmd_item_add()) {
 454                                 add_key(subcmd);
 455                         } else {
 456                                 /* just to be sure ;-) */
 457                                 assert(subcmd_item_is_key(lw->selected));
 458                                 overwrite_key(subcmd, subcmd_item_to_key_id(lw->selected));
 459                         }
 460                 }
 461                 return true;
 462         case CMD_GO_PARENT_DIRECTORY:
 463         case CMD_GO_ROOT_DIRECTORY:
 464                 if (subcmd != -1)
 465                         switch_to_command_mode();
 466                 return true;
 467         case CMD_DELETE:
 468                 if (subcmd != -1 && subcmd_item_is_key(lw->selected))
 469                         delete_key(subcmd, subcmd_item_to_key_id(lw->selected));
 470
 471                 return true;
 472         case CMD_ADD:
 473                 if (subcmd != -1)
 474                         add_key(subcmd);
 475                 return true;
 476         case CMD_SAVE_PLAYLIST:
 477                 apply_keys();
 478                 save_keys();
 479                 return true;
 480         case CMD_LIST_FIND:
 481         case CMD_LIST_RFIND:
 482         case CMD_LIST_FIND_NEXT:
 483         case CMD_LIST_RFIND_NEXT:
 484                 screen_find(lw, cmd, list_callback, NULL);
 485                 keydef_repaint();
 486                 return true;
 487
 488         default:
 489                 return false;
 490         }
 491
 492         /* unreachable */
 493         assert(0);
 494         return false;
 495 }
 496
 497 const struct screen_functions screen_keydef = {
 498         .init = keydef_init,
 499         .exit = keydef_exit,
 500         .open = keydef_open,
 501         .close = keydef_close,
 502         .resize = keydef_resize,
 503         .paint = keydef_paint,
 504         .cmd = keydef_cmd,
 505         .get_title = keydef_title,
 506 };