X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fscreen_keydef.c;h=44b191c26d0a40672473faf6c94b7193b66ca8f7;hb=e52df3dd5be37471c4fceceb683479bd81bdec27;hp=b92ebe39d584453f7fa6d61d3a3bdc6f96ad230c;hpb=2079b3df712c6cd8f1f953b77261024432daf7c0;p=ncmpc.git diff --git a/src/screen_keydef.c b/src/screen_keydef.c index b92ebe3..44b191c 100644 --- a/src/screen_keydef.c +++ b/src/screen_keydef.c @@ -1,60 +1,131 @@ /* ncmpc (Ncurses MPD Client) - * (c) 2004-2009 The Music Player Daemon Project + * (c) 2004-2017 The Music Player Daemon Project * Project homepage: http://musicpd.org - + * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. - + * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. - + * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -*/ + */ +#include "screen_keydef.h" +#include "screen_interface.h" +#include "screen_status.h" +#include "screen_find.h" #include "i18n.h" -#include "mpdclient.h" -#include "options.h" #include "conf.h" -#include "command.h" #include "screen.h" #include "screen_utils.h" +#include "options.h" +#include "Compiler.h" +#include #include -#include #include #include -#define STATIC_ITEMS 0 -#define STATIC_SUB_ITEMS 1 -#define BUFSIZE 256 +static struct list_window *lw; -#define LIST_ITEM_APPLY() ((unsigned)command_list_length) -#define LIST_ITEM_SAVE() (LIST_ITEM_APPLY()+1) -#define LIST_LENGTH() (LIST_ITEM_SAVE()+1) +static command_definition_t *cmds = NULL; -#define LIST_ITEM_SAVE_LABEL _("===> Apply & Save key bindings ") -#define LIST_ITEM_APPLY_LABEL _("===> Apply key bindings ") +/** the number of commands */ +static unsigned command_n_commands = 0; +/** + * the position of the "apply" item. It's the same as command_n_commands, + * because array subscripts start at 0, while numbers of items start at 1. + */ +gcc_pure +static inline unsigned +command_item_apply(void) +{ + return command_n_commands; +} -static list_window_t *lw = NULL; -static unsigned command_list_length = 0; -static command_definition_t *cmds = NULL; +/** the position of the "apply and save" item */ +gcc_pure +static inline unsigned +command_item_save(void) +{ + return command_item_apply() + 1; +} +/** the number of items in the "command" view */ +gcc_pure +static inline unsigned +command_length(void) +{ + return command_item_save() + 1; +} + + +/** + * The command being edited, represented by a array subscript to @cmds, or -1, + * if no command is being edited + */ static int subcmd = -1; -static unsigned subcmd_length = 0; -static unsigned subcmd_addpos = 0; + +/** The number of keys assigned to the current command */ +static unsigned subcmd_n_keys = 0; + +/** The position of the up ("[..]") item */ +gcc_const +static inline unsigned +subcmd_item_up(void) +{ + return 0; +} + +/** The position of the "add a key" item */ +gcc_pure +static inline unsigned +subcmd_item_add(void) +{ + return subcmd_n_keys + 1; +} + +/** The number of items in the list_window, if there's a command being edited */ +gcc_pure +static inline unsigned +subcmd_length(void) +{ + return subcmd_item_add() + 1; +} + +/** Check whether a given item is a key */ +gcc_pure +static inline bool +subcmd_item_is_key(unsigned i) +{ + return (i > subcmd_item_up() && i < subcmd_item_add()); +} + +/** + * Convert an item id (as in lw->selected) into a "key id", which is an array + * subscript to cmds[subcmd].keys. + */ +gcc_const +static inline unsigned +subcmd_item_to_key_id(unsigned i) +{ + return i - 1; +} + static int keybindings_changed(void) { command_definition_t *orginal_cmds = get_command_definitions(); - size_t size = command_list_length * sizeof(command_definition_t); + size_t size = command_n_commands * sizeof(command_definition_t); return memcmp(orginal_cmds, cmds, size); } @@ -64,7 +135,7 @@ apply_keys(void) { if (keybindings_changed()) { command_definition_t *orginal_cmds = get_command_definitions(); - size_t size = command_list_length * sizeof(command_definition_t); + size_t size = command_n_commands * sizeof(command_definition_t); memcpy(orginal_cmds, cmds, size); screen_status_printf(_("You have new key bindings")); @@ -75,100 +146,141 @@ apply_keys(void) static int save_keys(void) { - FILE *f; - char *filename; + char *allocated = NULL; + const char *filename = options.key_file; + if (filename == NULL) { + if (!check_user_conf_dir()) { + screen_status_printf(_("Error: Unable to create directory ~/.ncmpc - %s"), + strerror(errno)); + screen_bell(); + return -1; + } - if (check_user_conf_dir()) { - screen_status_printf(_("Error: Unable to create directory ~/.ncmpc - %s"), - strerror(errno)); - screen_bell(); - return -1; + filename = allocated = build_user_key_binding_filename(); } - filename = get_user_key_binding_filename(); - - if ((f = fopen(filename,"w")) == NULL) { + FILE *f = fopen(filename, "w"); + if (f == NULL) { screen_status_printf(_("Error: %s - %s"), filename, strerror(errno)); screen_bell(); - g_free(filename); + g_free(allocated); return -1; } if (write_key_bindings(f, KEYDEF_WRITE_HEADER)) - screen_status_printf(_("Error: %s - %s"), filename, strerror(errno)); - else screen_status_printf(_("Wrote %s"), filename); + else + screen_status_printf(_("Error: %s - %s"), filename, strerror(errno)); - g_free(filename); + g_free(allocated); return fclose(f); } +/* TODO: rename to check_n_keys / subcmd_count_keys? */ static void check_subcmd_length(void) { - subcmd_length = 0; - while (subcmd_length < MAX_COMMAND_KEYS && - cmds[subcmd].keys[subcmd_length] > 0) - ++subcmd_length; - - if (subcmd_length < MAX_COMMAND_KEYS) { - subcmd_addpos = subcmd_length; - subcmd_length++; - } else - subcmd_addpos = 0; - subcmd_length += STATIC_SUB_ITEMS; + unsigned i; + + /* this loops counts the continous valid keys at the start of the the keys + array, so make sure you don't have gaps */ + for (i = 0; i < MAX_COMMAND_KEYS; i++) + if (cmds[subcmd].keys[i] == 0) + break; + subcmd_n_keys = i; + + list_window_set_length(lw, subcmd_length()); } static void keydef_paint(void); +/** lw->start the last time switch_to_subcmd_mode() was called */ +static unsigned saved_start = 0; + +static void +switch_to_subcmd_mode(int cmd) +{ + assert(subcmd == -1); + + saved_start = lw->start; + + subcmd = cmd; + list_window_reset(lw); + check_subcmd_length(); + + keydef_paint(); +} + static void -keydef_repaint(void) +switch_to_command_mode(void) { + assert(subcmd != -1); + + list_window_set_length(lw, command_length()); + list_window_set_cursor(lw, subcmd); + subcmd = -1; + + lw->start = saved_start; + keydef_paint(); - wrefresh(lw->w); } +/** + * Delete a key from a given command's definition + * @param cmd_index the command + * @param key_index the key (see below) + */ static void delete_key(int cmd_index, int key_index) { + /* shift the keys to close the gap that appeared */ int i = key_index+1; - - screen_status_printf(_("Deleted")); while (i < MAX_COMMAND_KEYS && cmds[cmd_index].keys[i]) cmds[cmd_index].keys[key_index++] = cmds[cmd_index].keys[i++]; + + /* As key_index now holds the index of the last key slot that contained + a key, we use it to empty this slot, because this key has been copied + to the previous slot in the loop above */ cmds[cmd_index].keys[key_index] = 0; + cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED; check_subcmd_length(); + screen_status_printf(_("Deleted")); + /* repaint */ - keydef_repaint(); + keydef_paint(); /* update key conflict flags */ check_key_bindings(cmds, NULL, 0); } +/* assigns a new key to a key slot */ static void -assign_new_key(int cmd_index, int key_index) +overwrite_key(int cmd_index, int key_index) { - int key; - char *buf; - command_t cmd; + assert(key_index < MAX_COMMAND_KEYS); - buf = g_strdup_printf(_("Enter new key for %s: "), cmds[cmd_index].name); - key = screen_getch(buf); + char *buf = g_strdup_printf(_("Enter new key for %s: "), + cmds[cmd_index].name); + const int key = screen_getch(buf); g_free(buf); - if (key==ERR) { + if (key == ERR) { screen_status_printf(_("Aborted")); return; } - cmd = find_key_command(key, cmds); - if (cmd != CMD_NONE && cmd != cmds[cmd_index].command) { + if (key == '\0') { + screen_status_printf(_("Ctrl-Space can't be used")); + return; + } + + const command_t cmd = find_key_command(key, cmds); + if (cmd != CMD_NONE) { screen_status_printf(_("Error: key %s is already used for %s"), - key2str(key), - get_key_command_name(cmd)); + key2str(key), get_key_command_name(cmd)); screen_bell(); return; } @@ -181,45 +293,69 @@ assign_new_key(int cmd_index, int key_index) check_subcmd_length(); /* repaint */ - keydef_repaint(); + keydef_paint(); /* update key conflict flags */ check_key_bindings(cmds, NULL, 0); } +/* assign a new key to a new slot */ +static void +add_key(int cmd_index) +{ + if (subcmd_n_keys < MAX_COMMAND_KEYS) + overwrite_key(cmd_index, subcmd_n_keys); +} + static const char * -list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED char** sc, G_GNUC_UNUSED void *data) +list_callback(unsigned idx, gcc_unused void *data) { - static char buf[BUFSIZE]; - - if (subcmd < 0) { - if (idx < (unsigned)command_list_length) { - if (cmds[idx].flags & COMMAND_KEY_CONFLICT) - *highlight = true; - return cmds[idx].name; - } else if (idx == LIST_ITEM_APPLY()) - return LIST_ITEM_APPLY_LABEL; - else if (idx == LIST_ITEM_SAVE()) - return LIST_ITEM_SAVE_LABEL; + static char buf[256]; + + if (subcmd == -1) { + if (idx == command_item_apply()) + return _("===> Apply key bindings "); + if (idx == command_item_save()) + return _("===> Apply & Save key bindings "); + + assert(idx < (unsigned) command_n_commands); + + /* + * Format the lines in two aligned columnes for the key name and + * the description, like this: + * + * this-command - do this + * that-one - do that + */ + size_t len = strlen(cmds[idx].name); + strncpy(buf, cmds[idx].name, sizeof(buf)); + + if (len < get_cmds_max_name_width(cmds)) + memset(buf + len, ' ', get_cmds_max_name_width(cmds) - len); + + g_snprintf(buf + get_cmds_max_name_width(cmds), + sizeof(buf) - get_cmds_max_name_width(cmds), + " - %s", _(cmds[idx].description)); + + return buf; } else { - if (idx == 0) + if (idx == subcmd_item_up()) return "[..]"; - idx--; - if (idx < MAX_COMMAND_KEYS && cmds[subcmd].keys[idx] > 0) { - g_snprintf(buf, - BUFSIZE, "%d. %-20s (%d) ", - idx + 1, - key2str(cmds[subcmd].keys[idx]), - cmds[subcmd].keys[idx]); - return buf; - } else if (idx == subcmd_addpos) { - g_snprintf(buf, BUFSIZE, "%d. %s", - idx + 1, _("Add new key")); + + if (idx == subcmd_item_add()) { + g_snprintf(buf, sizeof(buf), "%d. %s", + idx, _("Add new key")); return buf; } - } - return NULL; + assert(subcmd_item_is_key(idx)); + + g_snprintf(buf, sizeof(buf), + "%d. %-20s (%d) ", idx, + key2str(cmds[subcmd].keys[subcmd_item_to_key_id(idx)]), + cmds[subcmd].keys[subcmd_item_to_key_id(idx)]); + return buf; + } } static void @@ -231,8 +367,7 @@ keydef_init(WINDOW *w, int cols, int rows) static void keydef_resize(int cols, int rows) { - lw->cols = cols; - lw->rows = rows; + list_window_resize(lw, cols, rows); } static void @@ -246,24 +381,23 @@ keydef_exit(void) } static void -keydef_open(G_GNUC_UNUSED struct mpdclient *c) +keydef_open(gcc_unused struct mpdclient *c) { if (cmds == NULL) { command_definition_t *current_cmds = get_command_definitions(); - size_t cmds_size; + command_n_commands = 0; + while (current_cmds[command_n_commands].name) + command_n_commands++; - command_list_length = 0; - while (current_cmds[command_list_length].name) - command_list_length++; - - cmds_size = (command_list_length+1) * sizeof(command_definition_t); + /* +1 for the terminator element */ + size_t cmds_size = (command_n_commands + 1) + * sizeof(command_definition_t); cmds = g_malloc0(cmds_size); memcpy(cmds, current_cmds, cmds_size); - command_list_length += STATIC_ITEMS; } subcmd = -1; - list_window_check_selected(lw, LIST_LENGTH()); + list_window_set_length(lw, command_length()); } static void @@ -279,7 +413,7 @@ keydef_close(void) static const char * keydef_title(char *str, size_t size) { - if (subcmd < 0) + if (subcmd == -1) return _("Edit key bindings"); g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name); @@ -293,83 +427,71 @@ keydef_paint(void) } static bool -keydef_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd) +keydef_cmd(gcc_unused struct mpdclient *c, command_t cmd) { - int length = LIST_LENGTH(); - - if (subcmd >= 0) - length = subcmd_length; - if (cmd == CMD_LIST_RANGE_SELECT) return false; - if (list_window_cmd(lw, length, cmd)) { - keydef_repaint(); + if (list_window_cmd(lw, cmd)) { + keydef_paint(); return true; } switch(cmd) { case CMD_PLAY: - if (subcmd < 0) { - if (lw->selected == LIST_ITEM_APPLY()) + if (subcmd == -1) { + if (lw->selected == command_item_apply()) { apply_keys(); - else if (lw->selected == LIST_ITEM_SAVE()) { + } else if (lw->selected == command_item_save()) { apply_keys(); save_keys(); } else { - subcmd = lw->selected; - lw->selected=0; - lw->selected_start = lw->selected; - lw->selected_end = lw->selected; - check_subcmd_length(); - - keydef_repaint(); + switch_to_subcmd_mode(lw->selected); } } else { - if (lw->selected == 0) { /* up */ - lw->selected = subcmd; - lw->selected_start = lw->selected; - lw->selected_end = lw->selected; - subcmd = -1; - - keydef_repaint(); - } else - assign_new_key(subcmd, - lw->selected - STATIC_SUB_ITEMS); + if (lw->selected == subcmd_item_up()) { + switch_to_command_mode(); + } else if (lw->selected == subcmd_item_add()) { + add_key(subcmd); + } else { + /* just to be sure ;-) */ + assert(subcmd_item_is_key(lw->selected)); + overwrite_key(subcmd, subcmd_item_to_key_id(lw->selected)); + } } return true; case CMD_GO_PARENT_DIRECTORY: - if (subcmd >=0) { - lw->selected = subcmd; - lw->selected_start = lw->selected; - lw->selected_end = lw->selected; - subcmd = -1; - - keydef_repaint(); - } - break; + case CMD_GO_ROOT_DIRECTORY: + if (subcmd != -1) + switch_to_command_mode(); + return true; case CMD_DELETE: - if (subcmd >= 0 && lw->selected >= STATIC_SUB_ITEMS) - delete_key(subcmd, lw->selected - STATIC_SUB_ITEMS); + if (subcmd != -1 && subcmd_item_is_key(lw->selected)) + delete_key(subcmd, subcmd_item_to_key_id(lw->selected)); + + return true; + case CMD_ADD: + if (subcmd != -1) + add_key(subcmd); return true; - break; case CMD_SAVE_PLAYLIST: apply_keys(); save_keys(); - break; + return true; case CMD_LIST_FIND: case CMD_LIST_RFIND: case CMD_LIST_FIND_NEXT: case CMD_LIST_RFIND_NEXT: - screen_find(lw, length, - cmd, list_callback, NULL); - keydef_repaint(); + screen_find(lw, cmd, list_callback, NULL); + keydef_paint(); return true; default: - break; + return false; } + /* unreachable */ + assert(0); return false; }