![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/src/screen_keydef.c b/src/screen_keydef.c
index 7ea8c3fdb03589141c6ee7256b65ed09f9edf525..44b191c26d0a40672473faf6c94b7193b66ca8f7 100644 (file)
--- a/src/screen_keydef.c
+++ b/src/screen_keydef.c
-/*
- * $Id$
- *
- * (c) 2004 by Kalle Wallin <kaw@linux.se>
+/* ncmpc (Ncurses MPD Client)
+ * (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
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
+ * 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 "conf.h"
+#include "screen.h"
+#include "screen_utils.h"
+#include "options.h"
+#include "Compiler.h"
+
+#include <assert.h>
#include <errno.h>
-#include <stdlib.h>
#include <string.h>
#include <glib.h>
-#include <ncurses.h>
-#include "config.h"
+static struct list_window *lw;
-#ifdef ENABLE_KEYDEF_SCREEN
-#include "ncmpc.h"
-#include "mpdclient.h"
-#include "options.h"
-#include "conf.h"
-#include "command.h"
-#include "screen.h"
-#include "screen_utils.h"
+static command_definition_t *cmds = NULL;
-#define STATIC_ITEMS 0
-#define STATIC_SUB_ITEMS 1
-#define BUFSIZE 256
+/** the number of commands */
+static unsigned command_n_commands = 0;
-#define LIST_ITEM_APPLY() (command_list_length)
-#define LIST_ITEM_SAVE() (LIST_ITEM_APPLY()+1)
-#define LIST_LENGTH() (LIST_ITEM_SAVE()+1)
+/**
+ * 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;
+}
-#define LIST_ITEM_SAVE_LABEL _("===> Apply & Save key bindings ")
-#define LIST_ITEM_APPLY_LABEL _("===> Apply key bindings ")
+/** 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;
+}
-static list_window_t *lw = NULL;
-static int command_list_length = 0;
-static command_definition_t *cmds = NULL;
+/**
+ * The command being edited, represented by a array subscript to @cmds, or -1,
+ * if no command is being edited
+ */
static int subcmd = -1;
-static int subcmd_length = 0;
-static int 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);
-
- return memcmp(orginal_cmds, cmds, size);
+ command_definition_t *orginal_cmds = get_command_definitions();
+ size_t size = command_n_commands * sizeof(command_definition_t);
+
+ return memcmp(orginal_cmds, cmds, size);
}
static void
apply_keys(void)
{
- if( keybindings_changed() )
- {
- command_definition_t *orginal_cmds = get_command_definitions();
- size_t size = command_list_length*sizeof(command_definition_t);
-
- memcpy(orginal_cmds, cmds, size);
- screen_status_printf(_("You have new key bindings!"));
- }
- else
- screen_status_printf(_("Keybindings unchanged."));
+ if (keybindings_changed()) {
+ command_definition_t *orginal_cmds = get_command_definitions();
+ size_t size = command_n_commands * sizeof(command_definition_t);
+
+ memcpy(orginal_cmds, cmds, size);
+ screen_status_printf(_("You have new key bindings"));
+ } else
+ screen_status_printf(_("Keybindings unchanged."));
}
static int
save_keys(void)
{
- FILE *f;
- char *filename;
-
- if( check_user_conf_dir() )
- {
- screen_status_printf(_("Error: Unable to create direcory ~/.ncmpc - %s"),
- strerror(errno));
- screen_bell();
- return -1;
- }
-
- filename = get_user_key_binding_filename();
-
- if( (f=fopen(filename,"w")) == NULL )
- {
- screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
- screen_bell();
- g_free(filename);
- return -1;
- }
- if( write_key_bindings(f) )
- screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
- else
- screen_status_printf(_("Wrote %s"), filename);
-
- g_free(filename);
- return fclose(f);
+ 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;
+ }
+
+ filename = allocated = build_user_key_binding_filename();
+ }
+
+ FILE *f = fopen(filename, "w");
+ if (f == NULL) {
+ screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
+ screen_bell();
+ g_free(allocated);
+ return -1;
+ }
+
+ if (write_key_bindings(f, KEYDEF_WRITE_HEADER))
+ screen_status_printf(_("Wrote %s"), filename);
+ else
+ screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
+
+ 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
+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();
+}
+
+/**
+ * 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)
{
- 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++];
- cmds[cmd_index].keys[key_index] = 0;
- cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
- check_subcmd_length();
- lw->clear = 1;
- lw->repaint = 1;
- /* update key conflict flags */
- check_key_bindings(cmds, NULL, 0);
+ /* shift the keys to close the gap that appeared */
+ int i = key_index+1;
+ 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_paint();
+
+ /* update key conflict flags */
+ check_key_bindings(cmds, NULL, 0);
}
+/* assigns a new key to a key slot */
static void
-assign_new_key(WINDOW *w, int cmd_index, int key_index)
+overwrite_key(int cmd_index, int key_index)
{
- int key;
- char buf[BUFSIZE];
- command_t cmd;
-
- snprintf(buf, BUFSIZE, _("Enter new key for %s: "), cmds[cmd_index].name);
- key = screen_getch(w, buf);
- if( key==KEY_RESIZE )
- screen_resize();
- if( key==ERR )
- {
- screen_status_printf(_("Aborted!"));
- return;
- }
- cmd = find_key_command(key, cmds);
- if( cmd!=CMD_NONE && cmd!= cmds[cmd_index].command )
- {
- screen_status_printf(_("Error: key %s is already used for %s"),
- key2str(key),
- get_key_command_name(cmd));
- screen_bell();
- return;
- }
- cmds[cmd_index].keys[key_index] = key;
- cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
-
- screen_status_printf(_("Assigned %s to %s"),
- key2str(key),cmds[cmd_index].name);
- check_subcmd_length();
- lw->repaint = 1;
- /* update key conflict flags */
- check_key_bindings(cmds, NULL, 0);
+ assert(key_index < MAX_COMMAND_KEYS);
+
+ 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) {
+ screen_status_printf(_("Aborted"));
+ return;
+ }
+
+ 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));
+ screen_bell();
+ return;
+ }
+
+ cmds[cmd_index].keys[key_index] = key;
+ cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
+
+ screen_status_printf(_("Assigned %s to %s"),
+ key2str(key),cmds[cmd_index].name);
+ check_subcmd_length();
+
+ /* 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 char *
-list_callback(int index, int *highlight, void *data)
+static const char *
+list_callback(unsigned idx, gcc_unused void *data)
{
- static char buf[BUFSIZE];
-
- *highlight = 0;
- if( subcmd <0 )
- {
- if( index<command_list_length )
- {
- if( cmds[index].flags & COMMAND_KEY_CONFLICT )
- *highlight = 1;
- return cmds[index].name;
+ 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 == subcmd_item_up())
+ return "[..]";
+
+ if (idx == subcmd_item_add()) {
+ g_snprintf(buf, sizeof(buf), "%d. %s",
+ idx, _("Add new key"));
+ return buf;
+ }
+
+ 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;
}
- else if( index==LIST_ITEM_APPLY() )
- return LIST_ITEM_APPLY_LABEL;
- else if( index==LIST_ITEM_SAVE() )
- return LIST_ITEM_SAVE_LABEL;
- }
- else
- {
- if( index== 0 )
- return "[..]";
- index--;
- if( index<MAX_COMMAND_KEYS && cmds[subcmd].keys[index]>0 )
- {
- snprintf(buf,
- BUFSIZE, "%d. %-20s (%d) ",
- index+1,
- key2str(cmds[subcmd].keys[index]),
- cmds[subcmd].keys[index]);
- return buf;
- }
- else if ( index==subcmd_addpos )
- {
- snprintf(buf, BUFSIZE, _("%d. Add new key "), index+1 );
- return buf;
- }
- }
-
- return NULL;
}
-static void
+static void
keydef_init(WINDOW *w, int cols, int rows)
{
- lw = list_window_init(w, cols, rows);
+ lw = list_window_init(w, cols, rows);
}
static void
keydef_resize(int cols, int rows)
{
- lw->cols = cols;
- lw->rows = rows;
+ list_window_resize(lw, cols, rows);
}
-static void
+static void
keydef_exit(void)
{
- list_window_free(lw);
- if( cmds )
- g_free(cmds);
- cmds = NULL;
- lw = NULL;
+ list_window_free(lw);
+ if (cmds)
+ g_free(cmds);
+ cmds = NULL;
+ lw = NULL;
}
-static void
-keydef_open(screen_t *screen, mpdclient_t *c)
+static void
+keydef_open(gcc_unused struct mpdclient *c)
{
- if( cmds == NULL )
- {
- command_definition_t *current_cmds = get_command_definitions();
- size_t cmds_size;
-
- command_list_length = 0;
- while( current_cmds[command_list_length].name )
- command_list_length++;
-
- cmds_size = (command_list_length+1)*sizeof(command_definition_t);
- cmds = g_malloc0(cmds_size);
- memcpy(cmds, current_cmds, cmds_size);
- command_list_length += STATIC_ITEMS;
- screen_status_printf(_("Welcome to the key editor!"));
- }
-
- subcmd = -1;
- list_window_check_selected(lw, LIST_LENGTH());
+ if (cmds == NULL) {
+ command_definition_t *current_cmds = get_command_definitions();
+ command_n_commands = 0;
+ while (current_cmds[command_n_commands].name)
+ command_n_commands++;
+
+ /* +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);
+ }
+
+ subcmd = -1;
+ list_window_set_length(lw, command_length());
}
-static void
+static void
keydef_close(void)
{
- if( cmds && !keybindings_changed() )
- {
- g_free(cmds);
- cmds = NULL;
- }
- else
- screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
+ if (cmds && !keybindings_changed()) {
+ g_free(cmds);
+ cmds = NULL;
+ } else
+ screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
}
-static char *
+static const char *
keydef_title(char *str, size_t size)
{
- if( subcmd<0 )
- return _("Edit key bindings");
-
- snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
- return str;
-}
+ if (subcmd == -1)
+ return _("Edit key bindings");
-static void
-keydef_paint(screen_t *screen, mpdclient_t *c)
-{
- lw->clear = 1;
- list_window_paint(lw, list_callback, NULL);
- wrefresh(lw->w);
+ g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
+ return str;
}
-static void
-keydef_update(screen_t *screen, mpdclient_t *c)
-{
- if( lw->repaint )
- {
- list_window_paint(lw, list_callback, NULL);
- wrefresh(lw->w);
- lw->repaint = 0;
- }
+static void
+keydef_paint(void)
+{
+ list_window_paint(lw, list_callback, NULL);
}
-static int
-keydef_cmd(screen_t *screen, mpdclient_t *c, command_t cmd)
+static bool
+keydef_cmd(gcc_unused struct mpdclient *c, command_t cmd)
{
- int length = LIST_LENGTH();
-
- if( subcmd>=0 )
- length = subcmd_length;
-
- switch(cmd)
- {
- case CMD_PLAY:
- if( subcmd<0 )
- {
- if( lw->selected == LIST_ITEM_APPLY() )
- apply_keys();
- else if( lw->selected == LIST_ITEM_SAVE() )
- {
- apply_keys();
- save_keys();
- }
- else
- {
- subcmd = lw->selected;
- lw->selected=0;
- check_subcmd_length();
- }
- }
- else
- {
- if( lw->selected == 0 ) /* up */
- {
- lw->selected = subcmd;
- subcmd = -1;
- }
- else
- assign_new_key(screen->status_window.w,
- subcmd,
- lw->selected-STATIC_SUB_ITEMS);
+ if (cmd == CMD_LIST_RANGE_SELECT)
+ return false;
+
+ if (list_window_cmd(lw, cmd)) {
+ keydef_paint();
+ return true;
}
- lw->repaint = 1;
- lw->clear = 1;
- return 1;
- case CMD_DELETE:
- if( subcmd>=0 && lw->selected-STATIC_SUB_ITEMS>=0 )
- delete_key(subcmd, lw->selected-STATIC_SUB_ITEMS);
- return 1;
- break;
- case CMD_SAVE_PLAYLIST:
- apply_keys();
- save_keys();
- break;
- case CMD_LIST_FIND:
- case CMD_LIST_RFIND:
- case CMD_LIST_FIND_NEXT:
- case CMD_LIST_RFIND_NEXT:
- return screen_find(screen, c,
- lw, length,
- cmd, list_callback);
-
- default:
- break;
- }
-
- return list_window_cmd(lw, length, cmd);
-}
-static list_window_t *
-keydef_lw(void)
-{
- return lw;
-}
+ switch(cmd) {
+ case CMD_PLAY:
+ if (subcmd == -1) {
+ if (lw->selected == command_item_apply()) {
+ apply_keys();
+ } else if (lw->selected == command_item_save()) {
+ apply_keys();
+ save_keys();
+ } else {
+ switch_to_subcmd_mode(lw->selected);
+ }
+ } else {
+ 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:
+ case CMD_GO_ROOT_DIRECTORY:
+ if (subcmd != -1)
+ switch_to_command_mode();
+ return true;
+ case CMD_DELETE:
+ 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;
+ case CMD_SAVE_PLAYLIST:
+ apply_keys();
+ save_keys();
+ return true;
+ case CMD_LIST_FIND:
+ case CMD_LIST_RFIND:
+ case CMD_LIST_FIND_NEXT:
+ case CMD_LIST_RFIND_NEXT:
+ screen_find(lw, cmd, list_callback, NULL);
+ keydef_paint();
+ return true;
+
+ default:
+ return false;
+ }
-screen_functions_t *
-get_screen_keydef(void)
-{
- static screen_functions_t functions;
-
- memset(&functions, 0, sizeof(screen_functions_t));
- functions.init = keydef_init;
- functions.exit = keydef_exit;
- functions.open = keydef_open;
- functions.close = keydef_close;
- functions.resize = keydef_resize;
- functions.paint = keydef_paint;
- functions.update = keydef_update;
- functions.cmd = keydef_cmd;
- functions.get_lw = keydef_lw;
- functions.get_title = keydef_title;
-
- return &functions;
+ /* unreachable */
+ assert(0);
+ return false;
}
-
-#endif
+const struct screen_functions screen_keydef = {
+ .init = keydef_init,
+ .exit = keydef_exit,
+ .open = keydef_open,
+ .close = keydef_close,
+ .resize = keydef_resize,
+ .paint = keydef_paint,
+ .cmd = keydef_cmd,
+ .get_title = keydef_title,
+};