Code

screen_*: eliminate redundant wrefresh() calls
[ncmpc.git] / src / screen_help.c
index bf7411c5c854c6155a1b06143554b38cc4d2be1c..c1a592f253a269995b77b77425789551114b98a7 100644 (file)
@@ -1,40 +1,41 @@
 /* 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_help.h"
+#include "screen_interface.h"
+#include "screen_find.h"
+#include "paint.h"
+#include "charset.h"
 #include "config.h"
 #include "i18n.h"
-#include "mpdclient.h"
-#include "command.h"
-#include "screen.h"
-#include "screen_utils.h"
 
-#include <stdlib.h>
-#include <string.h>
 #include <glib.h>
 
-typedef struct {
+#include <assert.h>
+
+struct help_text_row {
        signed char highlight;
        command_t command;
        const char *text;
-} help_text_row_t;
+};
 
-static help_text_row_t help_text[] = {
+static const struct help_text_row help_text[] = {
        { 1, CMD_NONE, N_("Movement") },
        { 2, CMD_NONE, NULL },
        { 0, CMD_LIST_PREVIOUS, NULL },
@@ -52,8 +53,10 @@ static help_text_row_t help_text[] = {
        { 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 },
@@ -69,6 +72,9 @@ static help_text_row_t help_text[] = {
 #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 },
 #endif
@@ -90,6 +96,7 @@ static help_text_row_t help_text[] = {
        { 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 },
@@ -101,13 +108,15 @@ static help_text_row_t help_text[] = {
        { 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_("Playlist screen") },
+       { 1, CMD_NONE, N_("Queue screen") },
        { 2, CMD_NONE, NULL },
        { 0, CMD_PLAY, N_("Play") },
        { 0, CMD_DELETE, NULL },
@@ -117,6 +126,7 @@ static help_text_row_t help_text[] = {
        { 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 },
@@ -125,7 +135,7 @@ static help_text_row_t help_text[] = {
        { 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 playlist") },
+       { 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 },
@@ -140,7 +150,7 @@ static help_text_row_t help_text[] = {
        { 0, CMD_SCREEN_SEARCH, N_("Search") },
        { 0, CMD_PLAY, N_("Select and play") },
        { 0, CMD_SELECT, NULL },
-       { 0, CMD_ADD, N_("Append song to playlist") },
+       { 0, CMD_ADD, N_("Append song to queue") },
        { 0, CMD_SELECT_ALL,     NULL },
        { 0, CMD_SEARCH_MODE, NULL },
 #endif
@@ -151,9 +161,13 @@ static help_text_row_t help_text[] = {
        { 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 },
@@ -162,6 +176,13 @@ static help_text_row_t help_text[] = {
        { 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 },
@@ -169,102 +190,109 @@ static help_text_row_t help_text[] = {
        { 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
 };
 
-#define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
-
-static list_window_t *lw;
+static struct list_window *lw;
 
 static const char *
-list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED void *data)
+list_callback(unsigned i, gcc_unused void *data)
 {
-       static char buf[512];
-
-       if (idx >= help_text_rows)
-               return NULL;
-
-       if (help_text[idx].highlight)
-               *highlight = true;
-
-       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;
-       }
+       const struct help_text_row *row = &help_text[i];
 
-       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;
+       assert(i < G_N_ELEMENTS(help_text));
+
+       if (row->text != NULL)
+               return _(row->text);
+
+       if (row->command != CMD_NONE)
+               return get_key_description(row->command);
+
+       return "";
 }
 
 static void
 help_init(WINDOW *w, int cols, int rows)
 {
-  lw = list_window_init(w, cols, rows);
+       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(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
+help_title(gcc_unused char *str, gcc_unused size_t size)
 {
        return _("Help");
 }
 
+static void
+screen_help_paint_callback(WINDOW *w, unsigned i,
+                          unsigned y, unsigned width,
+                          gcc_unused bool selected,
+                          gcc_unused const void *data)
+{
+       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_paint(void)
 {
-       list_window_paint(lw, list_callback, NULL);
+       list_window_paint2(lw, screen_help_paint_callback, NULL);
 }
 
 static bool
-help_cmd(G_GNUC_UNUSED mpdclient_t *c, command_t cmd)
+help_cmd(gcc_unused struct mpdclient *c, command_t cmd)
 {
-       if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
-               list_window_paint(lw, list_callback, NULL);
-               wrefresh(lw->w);
+       if (list_window_scroll_cmd(lw, cmd)) {
+               help_paint();
                return true;
        }
 
-       lw->selected = lw->start;
-       if (screen_find(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 */
-               list_window_center(lw, help_text_rows, lw->selected);
-               list_window_paint(lw, list_callback, NULL);
-               wrefresh(lw->w);
+               list_window_center(lw, lw->selected);
+               help_paint();
                return true;
        }