X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fscreen_keydef.c;h=9a76c1bf1baf4c2a5a6d8e18eef802a4b1d6248e;hb=HEAD;hp=fbd9905cb4b23ac43762486ea5f5efcf5a7c130d;hpb=1230f84524fc1625e0ff9eda67e2840334d7916f;p=ncmpc.git

diff --git a/src/screen_keydef.c b/src/screen_keydef.c
index fbd9905..9a76c1b 100644
--- a/src/screen_keydef.c
+++ b/src/screen_keydef.c
@@ -1,5 +1,6 @@
-/*
- * (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
@@ -10,55 +11,121 @@
  * 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 "config.h"
-
-#ifndef  DISABLE_KEYDEF_SCREEN
-#include "ncmpc.h"
-#include "mpdclient.h"
-#include "options.h"
+#include "screen_keydef.h"
+#include "screen_interface.h"
+#include "screen_status.h"
+#include "screen_find.h"
+#include "i18n.h"
 #include "conf.h"
-#include "command.h"
 #include "screen.h"
 #include "screen_utils.h"
-#include "gcc.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>
 
-#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;
+
+/** the number of commands */
+static unsigned command_n_commands = 0;
 
-#define LIST_ITEM_SAVE_LABEL  _("===> Apply & Save key bindings  ")
-#define LIST_ITEM_APPLY_LABEL _("===> Apply key bindings ")
+/**
+ * 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;
+}
 
+/** 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 unsigned 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 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);
 }
@@ -68,10 +135,10 @@ 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!"));
+		screen_status_printf(_("You have new key bindings"));
 	} else
 		screen_status_printf(_("Keybindings unchanged."));
 }
@@ -79,90 +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 direcory ~/.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
+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)
 {
+	/* 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();
-	lw->repaint = 1;
+
+	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;
-	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(w, 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 == KEY_RESIZE)
-		screen_resize();
+	if (key == ERR) {
+		screen_status_printf(_("Aborted"));
+		return;
+	}
 
-	if (key==ERR) {
-		screen_status_printf(_("Aborted!"));
+	if (key == '\0') {
+		screen_status_printf(_("Ctrl-Space can't be used"));
 		return;
 	}
 
-	cmd = find_key_command(key, cmds);
-	if (cmd != CMD_NONE && cmd != cmds[cmd_index].command) {
+	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;
 	}
@@ -173,56 +291,83 @@ assign_new_key(WINDOW *w, int cmd_index, int key_index)
 	screen_status_printf(_("Assigned %s to %s"),
 			     key2str(key),cmds[cmd_index].name);
 	check_subcmd_length();
-	lw->repaint = 1;
+
+	/* 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, int *highlight, mpd_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 = 1;
-			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. Add new key "), idx + 1);
+
+		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
-keydef_init(WINDOW *w, int cols, int rows)
+keydef_init(WINDOW *w, unsigned cols, unsigned rows)
 {
 	lw = list_window_init(w, cols, rows);
 }
 
 static void
-keydef_resize(int cols, int rows)
+keydef_resize(unsigned cols, unsigned rows)
 {
-	lw->cols = cols;
-	lw->rows = rows;
+	list_window_resize(lw, cols, rows);
 }
 
 static void
@@ -236,25 +381,23 @@ keydef_exit(void)
 }
 
 static void
-keydef_open(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
+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++;
+		command_n_commands = 0;
+		while (current_cmds[command_n_commands].name)
+			command_n_commands++;
 
-		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;
-		screen_status_printf(_("Welcome to the key editor!"));
 	}
 
 	subcmd = -1;
-	list_window_check_selected(lw, LIST_LENGTH());
+	list_window_set_length(lw, command_length());
 }
 
 static void
@@ -270,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);
@@ -278,74 +421,78 @@ keydef_title(char *str, size_t size)
 }
 
 static void
-keydef_paint(mpd_unused mpdclient_t *c)
+keydef_paint(void)
 {
 	list_window_paint(lw, list_callback, NULL);
 }
 
-static void
-keydef_update(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
-{
-	if (lw->repaint) {
-		list_window_paint(lw, list_callback, NULL);
-		lw->repaint = 0;
-	}
-}
-
-static int
-keydef_cmd(screen_t *screen, mpd_unused mpdclient_t *c, command_t cmd)
+static bool
+keydef_cmd(gcc_unused struct mpdclient *c, command_t cmd)
 {
-	int length = LIST_LENGTH();
+	if (cmd == CMD_LIST_RANGE_SELECT)
+		return false;
 
-	if (subcmd >= 0)
-		length = subcmd_length;
+	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;
-				check_subcmd_length();
+				switch_to_subcmd_mode(lw->selected);
 			}
 		} 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 (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));
+			}
 		}
-		lw->repaint = 1;
-		return 1;
+		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 >= 0 && lw->selected >= STATIC_SUB_ITEMS)
-			delete_key(subcmd, lw->selected - STATIC_SUB_ITEMS);
-		return 1;
-		break;
+		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();
-		break;
+		return true;
 	case CMD_LIST_FIND:
 	case CMD_LIST_RFIND:
 	case CMD_LIST_FIND_NEXT:
 	case CMD_LIST_RFIND_NEXT:
-		return screen_find(screen,
-				   lw,  length,
-				   cmd, list_callback, NULL);
+		screen_find(lw, cmd, list_callback, NULL);
+		keydef_paint();
+		return true;
 
 	default:
-		break;
+		return false;
 	}
 
-	return list_window_cmd(lw, length, cmd);
+	/* unreachable */
+	assert(0);
+	return false;
 }
 
 const struct screen_functions screen_keydef = {
@@ -355,9 +502,6 @@ const struct screen_functions screen_keydef = {
 	.close = keydef_close,
 	.resize = keydef_resize,
 	.paint = keydef_paint,
-	.update = keydef_update,
 	.cmd = keydef_cmd,
 	.get_title = keydef_title,
 };
-
-#endif