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 static void
 163 switch_to_subcmd_mode(int cmd)
 164 {
 165         assert(subcmd == -1);
 166
 167         subcmd = cmd;
 168         list_window_reset(lw);
 169         check_subcmd_length();
 170
 171         keydef_repaint();
 172 }
 173
 174 static void
 175 switch_to_command_mode(void)
 176 {
 177         assert(subcmd != -1);
 178
 179         list_window_set_length(lw, command_length);
 180         list_window_set_cursor(lw, subcmd);
 181         subcmd = -1;
 182
 183         keydef_repaint();
 184 }
 185
 186 /**
 187  * Delete a key from a given command's definition
 188  * @param cmd_index the command
 189  * @param key_index the key (see below)
 190  */
 191 static void
 192 delete_key(int cmd_index, int key_index)
 193 {
 194         /* shift the keys to close the gap that appeared */
 195         int i = key_index+1;
 196         while (i < MAX_COMMAND_KEYS && cmds[cmd_index].keys[i])
 197                 cmds[cmd_index].keys[key_index++] = cmds[cmd_index].keys[i++];
 198
 199         /* As key_index now holds the index of the last key slot that contained
 200            a key, we use it to empty this slot, because this key has been copied
 201            to the previous slot in the loop above */
 202         cmds[cmd_index].keys[key_index] = 0;
 203
 204         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 205         check_subcmd_length();
 206
 207         screen_status_printf(_("Deleted"));
 208
 209         /* repaint */
 210         keydef_repaint();
 211
 212         /* update key conflict flags */
 213         check_key_bindings(cmds, NULL, 0);
 214 }
 215
 216 /* assigns a new key to a key slot */
 217 static void
 218 overwrite_key(int cmd_index, int key_index)
 219 {
 220         int key;
 221         char *buf;
 222         command_t cmd;
 223
 224         assert(key_index < MAX_COMMAND_KEYS);
 225
 226         buf = g_strdup_printf(_("Enter new key for %s: "), cmds[cmd_index].name);
 227         key = screen_getch(buf);
 228         g_free(buf);
 229
 230         if (key==ERR) {
 231                 screen_status_printf(_("Aborted"));
 232                 return;
 233         }
 234
 235         cmd = find_key_command(key, cmds);
 236         if (cmd != CMD_NONE) {
 237                 screen_status_printf(_("Error: key %s is already used for %s"),
 238                                      key2str(key),
 239                                      get_key_command_name(cmd));
 240                 screen_bell();
 241                 return;
 242         }
 243
 244         cmds[cmd_index].keys[key_index] = key;
 245         cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
 246
 247         screen_status_printf(_("Assigned %s to %s"),
 248                              key2str(key),cmds[cmd_index].name);
 249         check_subcmd_length();
 250
 251         /* repaint */
 252         keydef_repaint();
 253
 254         /* update key conflict flags */
 255         check_key_bindings(cmds, NULL, 0);
 256 }
 257
 258 /* assign a new key to a new slot */
 259 static void
 260 add_key(int cmd_index)
 261 {
 262         if (subcmd_n_keys < MAX_COMMAND_KEYS)
 263                 overwrite_key(cmd_index, subcmd_n_keys);
 264 }
 265
 266 static const char *
 267 list_callback(unsigned idx, G_GNUC_UNUSED void *data)
 268 {
 269         static char buf[256];
 270
 271         if (subcmd == -1) {
 272                 if (idx == command_item_apply)
 273                         return _("===> Apply key bindings ");
 274                 if (idx == command_item_save)
 275                         return _("===> Apply & Save key bindings  ");
 276
 277                 assert(idx < (unsigned) command_n_commands);
 278
 279                 /*
 280                  * Format the lines in two aligned columnes for the key name and
 281                  * the description, like this:
 282                  *
 283                  *      this-command - do this
 284                  *      that-one     - do that
 285                  */
 286                 size_t len = strlen(cmds[idx].name);
 287                 strncpy(buf, cmds[idx].name, sizeof(buf));
 288
 289                 if (len < get_cmds_max_name_width(cmds))
 290                         memset(buf + len, ' ', get_cmds_max_name_width(cmds) - len);
 291
 292                 g_snprintf(buf + get_cmds_max_name_width(cmds),
 293                            sizeof(buf) - get_cmds_max_name_width(cmds),
 294                            " - %s", _(cmds[idx].description));
 295
 296                 return buf;
 297         } else {
 298                 if (idx == subcmd_item_up)
 299                         return "[..]";
 300
 301                 if (idx == subcmd_item_add) {
 302                         g_snprintf(buf, sizeof(buf), "%d. %s",
 303                                    idx, _("Add new key"));
 304                         return buf;
 305                 }
 306
 307                 assert(subcmd_item_is_key(idx));
 308
 309                 g_snprintf(buf, sizeof(buf),
 310                            "%d. %-20s   (%d) ", idx,
 311                            key2str(cmds[subcmd].keys[subcmd_item_to_key_id(idx)]),
 312                            cmds[subcmd].keys[subcmd_item_to_key_id(idx)]);
 313                 return buf;
 314         }
 315 }
 316
 317 static void
 318 keydef_init(WINDOW *w, int cols, int rows)
 319 {
 320         lw = list_window_init(w, cols, rows);
 321 }
 322
 323 static void
 324 keydef_resize(int cols, int rows)
 325 {
 326         list_window_resize(lw, cols, rows);
 327 }
 328
 329 static void
 330 keydef_exit(void)
 331 {
 332         list_window_free(lw);
 333         if (cmds)
 334                 g_free(cmds);
 335         cmds = NULL;
 336         lw = NULL;
 337 }
 338
 339 static void
 340 keydef_open(G_GNUC_UNUSED struct mpdclient *c)
 341 {
 342         if (cmds == NULL) {
 343                 command_definition_t *current_cmds = get_command_definitions();
 344                 size_t cmds_size;
 345
 346                 command_n_commands = 0;
 347                 while (current_cmds[command_n_commands].name)
 348                         command_n_commands++;
 349
 350                 /* +1 for the terminator element */
 351                 cmds_size = (command_n_commands + 1) * sizeof(command_definition_t);
 352                 cmds = g_malloc0(cmds_size);
 353                 memcpy(cmds, current_cmds, cmds_size);
 354         }
 355
 356         subcmd = -1;
 357         list_window_set_length(lw, command_length);
 358 }
 359
 360 static void
 361 keydef_close(void)
 362 {
 363         if (cmds && !keybindings_changed()) {
 364                 g_free(cmds);
 365                 cmds = NULL;
 366         } else
 367                 screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
 368 }
 369
 370 static const char *
 371 keydef_title(char *str, size_t size)
 372 {
 373         if (subcmd == -1)
 374                 return _("Edit key bindings");
 375
 376         g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
 377         return str;
 378 }
 379
 380 static void
 381 keydef_paint(void)
 382 {
 383         list_window_paint(lw, list_callback, NULL);
 384 }
 385
 386 static bool
 387 keydef_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
 388 {
 389         if (cmd == CMD_LIST_RANGE_SELECT)
 390                 return false;
 391
 392         if (list_window_cmd(lw, cmd)) {
 393                 keydef_repaint();
 394                 return true;
 395         }
 396
 397         switch(cmd) {
 398         case CMD_PLAY:
 399                 if (subcmd == -1) {
 400                         if (lw->selected == command_item_apply) {
 401                                 apply_keys();
 402                         } else if (lw->selected == command_item_save) {
 403                                 apply_keys();
 404                                 save_keys();
 405                         } else {
 406                                 switch_to_subcmd_mode(lw->selected);
 407                         }
 408                 } else {
 409                         if (lw->selected == subcmd_item_up) {
 410                                 switch_to_command_mode();
 411                         } else if (lw->selected == subcmd_item_add) {
 412                                 add_key(subcmd);
 413                         } else {
 414                                 /* just to be sure ;-) */
 415                                 assert(subcmd_item_is_key(lw->selected));
 416                                 overwrite_key(subcmd, subcmd_item_to_key_id(lw->selected));
 417                         }
 418                 }
 419                 return true;
 420         case CMD_GO_PARENT_DIRECTORY:
 421                 if (subcmd != -1)
 422                         switch_to_command_mode();
 423                 return true;
 424         case CMD_DELETE:
 425                 if (subcmd != -1 && subcmd_item_is_key(lw->selected))
 426                         delete_key(subcmd, subcmd_item_to_key_id(lw->selected));
 427
 428                 return true;
 429         case CMD_SAVE_PLAYLIST:
 430                 apply_keys();
 431                 save_keys();
 432                 return true;
 433         case CMD_LIST_FIND:
 434         case CMD_LIST_RFIND:
 435         case CMD_LIST_FIND_NEXT:
 436         case CMD_LIST_RFIND_NEXT:
 437                 screen_find(lw, cmd, list_callback, NULL);
 438                 keydef_repaint();
 439                 return true;
 440
 441         default:
 442                 return false;
 443         }
 444
 445         /* unreachable */
 446         assert(0);
 447         return false;
 448 }
 449
 450 const struct screen_functions screen_keydef = {
 451         .init = keydef_init,
 452         .exit = keydef_exit,
 453         .open = keydef_open,
 454         .close = keydef_close,
 455         .resize = keydef_resize,
 456         .paint = keydef_paint,
 457         .cmd = keydef_cmd,
 458         .get_title = keydef_title,
 459 };