X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=src%2Fscreen_help.c;h=c1a592f253a269995b77b77425789551114b98a7;hb=e52df3dd5be37471c4fceceb683479bd81bdec27;hp=d225b3d6d396b08b6afab88ea450191c127a7b22;hpb=079548617d3c321dd4051709c3a31717fd80238d;p=ncmpc.git

diff --git a/src/screen_help.c b/src/screen_help.c
index d225b3d..c1a592f 100644
--- a/src/screen_help.c
+++ b/src/screen_help.c
@@ -1,7 +1,6 @@
-/* 
- * $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
@@ -12,316 +11,299 @@
  * 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_help.h"
+#include "screen_interface.h"
+#include "screen_find.h"
+#include "paint.h"
+#include "charset.h"
 #include "config.h"
-#include "ncmpc.h"
-#include "mpdclient.h"
-#include "command.h"
-#include "screen.h"
-#include "screen_utils.h"
-#include "gcc.h"
-
-#include <stdlib.h>
-#include <string.h>
+#include "i18n.h"
+
 #include <glib.h>
-#include <ncurses.h>
 
+#include <assert.h>
 
-typedef struct {
+struct help_text_row {
 	signed char highlight;
 	command_t command;
 	const char *text;
-} help_text_row_t;
+};
 
-static help_text_row_t help_text[] = 
-{
-  { 1, CMD_NONE,           N_("Keys - Movement") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_LIST_PREVIOUS,  NULL },
-  { 0, CMD_LIST_NEXT,      NULL },
-  { 0, CMD_LIST_PREVIOUS_PAGE, NULL }, 
-  { 0, CMD_LIST_NEXT_PAGE, NULL },
-  { 0, CMD_LIST_FIRST,     NULL },
-  { 0, CMD_LIST_LAST,      NULL },
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_SCREEN_PREVIOUS,NULL },
-  { 0, CMD_SCREEN_NEXT,    NULL },
-  { 0, CMD_SCREEN_HELP,    NULL },
-  { 0, CMD_SCREEN_PLAY,    NULL },
-  { 0, CMD_SCREEN_FILE,    NULL },
+static const struct help_text_row help_text[] = {
+	{ 1, CMD_NONE, N_("Movement") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_LIST_PREVIOUS, NULL },
+	{ 0, CMD_LIST_NEXT, NULL },
+	{ 0, CMD_LIST_TOP, NULL },
+	{ 0, CMD_LIST_MIDDLE, NULL },
+	{ 0, CMD_LIST_BOTTOM, NULL },
+	{ 0, CMD_LIST_PREVIOUS_PAGE, NULL },
+	{ 0, CMD_LIST_NEXT_PAGE, NULL },
+	{ 0, CMD_LIST_FIRST, NULL },
+	{ 0, CMD_LIST_LAST, NULL },
+	{ 0, CMD_LIST_RANGE_SELECT, NULL },
+	{ 0, CMD_LIST_SCROLL_UP_LINE, NULL},
+	{ 0, CMD_LIST_SCROLL_DOWN_LINE, NULL},
+	{ 0, CMD_LIST_SCROLL_UP_HALF, NULL},
+	{ 0, CMD_LIST_SCROLL_DOWN_HALF, NULL},
+	{ 0, CMD_NONE, NULL },
+
+	{ 0, CMD_SCREEN_PREVIOUS,NULL },
+	{ 0, CMD_SCREEN_NEXT, NULL },
+	{ 0, CMD_SCREEN_SWAP, NULL },
+	{ 0, CMD_SCREEN_HELP, NULL },
+	{ 0, CMD_SCREEN_PLAY, NULL },
+	{ 0, CMD_SCREEN_FILE, NULL },
+#ifdef ENABLE_ARTIST_SCREEN
+	{ 0, CMD_SCREEN_ARTIST, NULL },
+#endif
 #ifdef ENABLE_SEARCH_SCREEN
-  { 0, CMD_SCREEN_SEARCH,  NULL },
+	{ 0, CMD_SCREEN_SEARCH, NULL },
+#endif
+#ifdef ENABLE_LYRICS_SCREEN
+	{ 0, CMD_SCREEN_LYRICS, NULL },
 #endif
-#ifdef ENABLE_CLOCK_SCREEN
-  { 0, CMD_SCREEN_CLOCK,   NULL },
+#ifdef ENABLE_OUTPUTS_SCREEN
+	{ 0, CMD_SCREEN_OUTPUTS, NULL },
+#endif
+#ifdef ENABLE_CHAT_SCREEN
+	{ 0, CMD_SCREEN_CHAT, NULL },
 #endif
 #ifdef ENABLE_KEYDEF_SCREEN
-  { 0, CMD_SCREEN_KEYDEF,  NULL },
+	{ 0, CMD_SCREEN_KEYDEF, NULL },
 #endif
 
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_NONE,           NULL },
-  { 1, CMD_NONE,           N_("Keys - Global") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_STOP,           NULL },
-  { 0, CMD_PAUSE,          NULL },
-  { 0, CMD_TRACK_NEXT,     NULL },
-  { 0, CMD_TRACK_PREVIOUS, NULL },
-  { 0, CMD_SEEK_FORWARD,   NULL },
-  { 0, CMD_SEEK_BACKWARD,  NULL },
-  { 0, CMD_VOLUME_DOWN,    NULL },
-  { 0, CMD_VOLUME_UP,      NULL },
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_REPEAT,         NULL },
-  { 0, CMD_RANDOM,         NULL },
-  { 0, CMD_CROSSFADE,      NULL },
-  { 0, CMD_SHUFFLE,        NULL },
-  { 0, CMD_DB_UPDATE,      NULL },
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_LIST_FIND,      NULL },
-  { 0, CMD_LIST_RFIND,     NULL },
-  { 0, CMD_LIST_FIND_NEXT, NULL },
-  { 0, CMD_LIST_RFIND_NEXT,  NULL },
-  { 0, CMD_TOGGLE_FIND_WRAP, NULL },
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_QUIT,           NULL },
-
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_NONE,           NULL },
-  { 1, CMD_NONE,           N_("Keys - Playlist screen") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_PLAY,           N_("Play") },
-  { 0, CMD_DELETE,         NULL },
-  { 0, CMD_CLEAR,          NULL },
-  { 1, CMD_LIST_MOVE_UP,   N_("Move song up") },
-  { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
-  { 0, CMD_ADD,            NULL },
-  { 0, CMD_SAVE_PLAYLIST,  NULL },
-  { 0, CMD_SCREEN_UPDATE,  N_("Center") },
-  { 0, CMD_TOGGLE_AUTOCENTER, NULL },
-
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_NONE,           NULL },
-  { 1, CMD_NONE,           N_("Keys - Browse screen") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_PLAY,           N_("Enter directory/Select and play song") },
-  { 0, CMD_SELECT,         NULL },
-  { 0, CMD_SAVE_PLAYLIST,  NULL },
-  { 0, CMD_DELETE,         N_("Delete playlist") },
-  { 0, CMD_GO_PARENT_DIRECTORY, NULL },
-  { 0, CMD_GO_ROOT_DIRECTORY, NULL },
-  { 0, CMD_SCREEN_UPDATE,  NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Global") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_STOP, NULL },
+	{ 0, CMD_PAUSE, NULL },
+	{ 0, CMD_CROP, NULL },
+	{ 0, CMD_TRACK_NEXT, NULL },
+	{ 0, CMD_TRACK_PREVIOUS, NULL },
+	{ 0, CMD_SEEK_FORWARD, NULL },
+	{ 0, CMD_SEEK_BACKWARD, NULL },
+	{ 0, CMD_VOLUME_DOWN, NULL },
+	{ 0, CMD_VOLUME_UP, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_REPEAT, NULL },
+	{ 0, CMD_RANDOM, NULL },
+	{ 0, CMD_SINGLE, NULL },
+	{ 0, CMD_CONSUME, NULL },
+	{ 0, CMD_CROSSFADE, NULL },
+	{ 0, CMD_SHUFFLE, NULL },
+	{ 0, CMD_DB_UPDATE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_LIST_FIND, NULL },
+	{ 0, CMD_LIST_RFIND, NULL },
+	{ 0, CMD_LIST_FIND_NEXT, NULL },
+	{ 0, CMD_LIST_RFIND_NEXT, NULL },
+	{ 0, CMD_LIST_JUMP, NULL },
+	{ 0, CMD_TOGGLE_FIND_WRAP, NULL },
+	{ 0, CMD_LOCATE, NULL },
+#ifdef ENABLE_SONG_SCREEN
+	{ 0, CMD_SCREEN_SONG, NULL },
+#endif
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_QUIT, NULL },
+
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Queue screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_PLAY, N_("Play") },
+	{ 0, CMD_DELETE, NULL },
+	{ 0, CMD_CLEAR, NULL },
+	{ 0, CMD_LIST_MOVE_UP, N_("Move song up") },
+	{ 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
+	{ 0, CMD_ADD, NULL },
+	{ 0, CMD_SAVE_PLAYLIST, NULL },
+	{ 0, CMD_SCREEN_UPDATE, N_("Center") },
+	{ 0, CMD_SELECT_PLAYING, NULL },
+	{ 0, CMD_TOGGLE_AUTOCENTER, NULL },
+
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Browse screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_PLAY, N_("Enter directory/Select and play song") },
+	{ 0, CMD_SELECT, NULL },
+	{ 0, CMD_ADD, N_("Append song to queue") },
+	{ 0, CMD_SAVE_PLAYLIST, NULL },
+	{ 0, CMD_DELETE, N_("Delete playlist") },
+	{ 0, CMD_GO_PARENT_DIRECTORY, NULL },
+	{ 0, CMD_GO_ROOT_DIRECTORY, NULL },
+	{ 0, CMD_SCREEN_UPDATE, NULL },
 
 #ifdef ENABLE_SEARCH_SCREEN
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_NONE,           NULL },
-  { 1, CMD_NONE,           N_("Keys - Search screen") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_SCREEN_SEARCH,  N_("Search") },
-  { 0, CMD_PLAY,           N_("Select and play") },
-  { 0, CMD_SELECT,         NULL },
-  { 0, CMD_SELECT_ALL,	   NULL },
-  { 0, CMD_SEARCH_MODE,    NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Search screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_SCREEN_SEARCH, N_("Search") },
+	{ 0, CMD_PLAY, N_("Select and play") },
+	{ 0, CMD_SELECT, NULL },
+	{ 0, CMD_ADD, N_("Append song to queue") },
+	{ 0, CMD_SELECT_ALL,	 NULL },
+	{ 0, CMD_SEARCH_MODE, NULL },
 #endif
 #ifdef ENABLE_LYRICS_SCREEN
-  { 0, CMD_NONE,           NULL },
-  { 0, CMD_NONE,           NULL },
-  { 1, CMD_NONE,           N_("Keys - Lyrics screen") },
-  { 2, CMD_NONE,           NULL },
-  { 0, CMD_SCREEN_LYRICS,  N_("View Lyrics") },
-  { 0, CMD_SELECT,         N_("(Re)load lyrics") },
-  { 0, CMD_INTERRUPT,         N_("Interrupt retrieval") },
-  { 0, CMD_LYRICS_UPDATE,         N_("Explicitly download lyrics") },
-  { 0, CMD_ADD,         N_("Save lyrics") }, 
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Lyrics screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
+	{ 0, CMD_SELECT, N_("(Re)load lyrics") },
+	/* to translators: this hotkey aborts the retrieval of lyrics
+	   from the server */
+	{ 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
+	{ 0, CMD_LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
+	{ 0, CMD_EDIT, N_("Add or edit lyrics") },
+	{ 0, CMD_SAVE_PLAYLIST, N_("Save lyrics") },
+	{ 0, CMD_DELETE, N_("Delete saved lyrics") },
+#endif
+#ifdef ENABLE_OUTPUTS_SCREEN
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Outputs screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_PLAY, N_("Enable/disable output") },
+#endif
+#ifdef ENABLE_CHAT_SCREEN
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Chat screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_PLAY, N_("Write a message") },
+#endif
+#ifdef ENABLE_KEYDEF_SCREEN
+	{ 0, CMD_NONE, NULL },
+	{ 0, CMD_NONE, NULL },
+	{ 1, CMD_NONE, N_("Keydef screen") },
+	{ 2, CMD_NONE, NULL },
+	{ 0, CMD_PLAY, N_("Edit keydefs for selected command") },
+	{ 0, CMD_DELETE, N_("Remove selected keydef") },
+	{ 0, CMD_ADD, N_("Add a keydef") },
+	{ 0, CMD_GO_PARENT_DIRECTORY, N_("Go up a level") },
+	{ 0, CMD_SAVE_PLAYLIST, N_("Apply and save changes") },
 #endif
-  { 0, CMD_NONE, NULL },
-  {-1, CMD_NONE, NULL }
 };
 
-static int help_text_rows = -1;
-static list_window_t *lw = NULL;
-
+static struct list_window *lw;
 
 static const char *
-list_callback(unsigned idx, int *highlight, mpd_unused void *data)
+list_callback(unsigned i, gcc_unused void *data)
 {
-	static char buf[512];
+	const struct help_text_row *row = &help_text[i];
 
-	if (help_text_rows < 0) {
-		help_text_rows = 0;
-		while (help_text[help_text_rows].highlight != -1)
-			help_text_rows++;
-	}
+	assert(i < G_N_ELEMENTS(help_text));
 
-	*highlight = 0;
-	if (idx < (unsigned)help_text_rows) {
-		*highlight = help_text[idx].highlight > 0;
-		if (help_text[idx].command == CMD_NONE) {
-			if (help_text[idx].text)
-				g_snprintf(buf, sizeof(buf), "      %s", _(help_text[idx].text));
-			else if (help_text[idx].highlight == 2) {
-				int i;
-
-				for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
-					buf[i] = '-';
-				buf[i] = '\0';
-			} else
-				g_strlcpy(buf, " ", sizeof(buf));
-			return buf;
-		}
-
-		if (help_text[idx].text)
-			g_snprintf(buf, sizeof(buf),
-				   "%20s : %s   ",
-				   get_key_names(help_text[idx].command, TRUE),
-				   _(help_text[idx].text));
-		else
-			g_snprintf(buf, sizeof(buf),
-				   "%20s : %s   ",
-				   get_key_names(help_text[idx].command, TRUE),
-				   get_key_description(help_text[idx].command));
-		return buf;
-	}
+	if (row->text != NULL)
+		return _(row->text);
+
+	if (row->command != CMD_NONE)
+		return get_key_description(row->command);
 
-	return NULL;
+	return "";
 }
 
 static void
 help_init(WINDOW *w, int cols, int rows)
 {
-  lw = list_window_init(w, cols, rows);
-  lw->flags = LW_HIDE_CURSOR;
+	lw = list_window_init(w, cols, rows);
+	lw->hide_cursor = true;
+	list_window_set_length(lw, G_N_ELEMENTS(help_text));
 }
 
 static void
 help_resize(int cols, int rows)
 {
-  lw->cols = cols;
-  lw->rows = rows;
+	list_window_resize(lw, cols, rows);
 }
 
 static void
 help_exit(void)
 {
-  list_window_free(lw);
+	list_window_free(lw);
 }
 
 
 static const char *
-help_title(mpd_unused char *str, mpd_unused size_t size)
+help_title(gcc_unused char *str, gcc_unused size_t size)
 {
 	return _("Help");
 }
 
 static void
-help_paint(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
+screen_help_paint_callback(WINDOW *w, unsigned i,
+			   unsigned y, unsigned width,
+			   gcc_unused bool selected,
+			   gcc_unused const void *data)
 {
-	lw->clear = 1;
-	list_window_paint(lw, list_callback, NULL);
-	wrefresh(lw->w);
+	const struct help_text_row *row = &help_text[i];
+
+	assert(i < G_N_ELEMENTS(help_text));
+
+	row_color(w, row->highlight ? COLOR_LIST_BOLD : COLOR_LIST, false);
+
+	wclrtoeol(w);
+
+	if (row->command == CMD_NONE) {
+		if (row->text != NULL)
+			mvwaddstr(w, y, 6, _(row->text));
+		else if (row->highlight == 2)
+			mvwhline(w, y, 3, '-', width - 6);
+	} else {
+		const char *key = get_key_names(row->command, true);
+
+		if (utf8_width(key) < 20)
+			wmove(w, y, 20 - utf8_width(key));
+		waddstr(w, key);
+		mvwaddch(w, y, 21, ':');
+		mvwaddstr(w, y, 23,
+			  row->text != NULL
+			  ? _(row->text)
+			  : get_key_description(row->command));
+	}
 }
 
 static void
-help_update(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
+help_paint(void)
 {
-	if (lw->repaint) {
-		list_window_paint(lw, list_callback, NULL);
-		wrefresh(lw->w);
-		lw->repaint = 0;
-	}
+	list_window_paint2(lw, screen_help_paint_callback, NULL);
 }
 
-
-static int
-help_cmd(screen_t *screen, mpd_unused mpdclient_t *c, command_t cmd)
+static bool
+help_cmd(gcc_unused struct mpdclient *c, command_t cmd)
 {
-	lw->repaint=1;
-	lw->clear=1;
-	switch(cmd) {
-	case CMD_LIST_NEXT:
-		if (lw->start + lw->rows < (unsigned)help_text_rows)
-			lw->start++;
-		return 1;
-	case CMD_LIST_PREVIOUS:
-		if (lw->start > 0)
-			lw->start--;
-		return 1;
-	case CMD_LIST_FIRST:
-		lw->start = 0;
-		return 1;
-	case CMD_LIST_LAST:
-		if ((unsigned)help_text_rows > lw->rows)
-			lw->start = help_text_rows - lw->rows;
-		else
-			lw->start = 0;
-		return 1;
-	case CMD_LIST_NEXT_PAGE:
-		lw->start = lw->start + lw->rows;
-		if (lw->start + lw->rows >= (unsigned)help_text_rows) {
-			if ((unsigned)help_text_rows > lw->rows)
-				lw->start = help_text_rows - lw->rows;
-			else
-				lw->start = 0;
-		}
-		return 1;
-	case CMD_LIST_PREVIOUS_PAGE:
-		if (lw->start > lw->rows)
-			lw->start -= lw->rows;
-		else
-			lw->start = 0;
-		return 1;
-	default:
-		break;
+	if (list_window_scroll_cmd(lw, cmd)) {
+		help_paint();
+		return true;
 	}
 
-	lw->selected = lw->start+lw->rows;
-	if (screen_find(screen,
-			lw,  help_text_rows,
-			cmd, list_callback, NULL)) {
+	list_window_set_cursor(lw, lw->start);
+	if (screen_find(lw,  cmd, list_callback, NULL)) {
 		/* center the row */
-		if (lw->selected > lw->rows / 2)
-			lw->start = lw->selected - lw->rows / 2;
-		else
-			lw->start = 0;
-		if (lw->start + lw->rows > (unsigned)help_text_rows) {
-			if (lw->rows < (unsigned)help_text_rows)
-				lw->start = help_text_rows - lw->rows;
-			else
-				lw->start = 0;
-		}
-		return 1;
+		list_window_center(lw, lw->selected);
+		help_paint();
+		return true;
 	}
 
-	return 0;
+	return false;
 }
 
-static list_window_t *
-help_lw(void)
-{
-	return lw;
-}
-
-screen_functions_t *
-get_screen_help(void)
-{
-	static screen_functions_t functions;
-
-	memset(&functions, 0, sizeof(screen_functions_t));
-	functions.init   = help_init;
-	functions.exit   = help_exit;
-	functions.open   = NULL;
-	functions.close  = NULL;
-	functions.resize = help_resize;
-	functions.paint  = help_paint;
-	functions.update = help_update;
-	functions.cmd    = help_cmd;
-	functions.get_lw = help_lw;
-	functions.get_title = help_title;
-
-	return &functions;
-}
+const struct screen_functions screen_help = {
+	.init = help_init,
+	.exit = help_exit,
+	.resize = help_resize,
+	.paint = help_paint,
+	.cmd = help_cmd,
+	.get_title = help_title,
+};