Code

screen_help: added the artist screen hotkey
[ncmpc.git] / src / screen_help.c
index 681bc6cfe5198d81ee65ee39630dfef28b3a54eb..8804c950bd22735da8b7be9a28af74797c3cb085 100644 (file)
@@ -1,6 +1,4 @@
-/* 
- * $Id$
- *
+/*
  * (c) 2004 by Kalle Wallin <kaw@linux.se>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -19,7 +17,7 @@
  */
 
 #include "config.h"
-#include "ncmpc.h"
+#include "i18n.h"
 #include "mpdclient.h"
 #include "command.h"
 #include "screen.h"
@@ -28,8 +26,6 @@
 #include <stdlib.h>
 #include <string.h>
 #include <glib.h>
-#include <ncurses.h>
-
 
 typedef struct {
        signed char highlight;
@@ -37,164 +33,160 @@ typedef struct {
        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 },
-#ifdef ENABLE_SEARCH_SCREEN
-  { 0, CMD_SCREEN_SEARCH,  NULL },
+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 },
+#ifdef ENABLE_ARTIST_SCREEN
+       { 0, CMD_SCREEN_ARTIST, NULL },
 #endif
-#ifdef ENABLE_CLOCK_SCREEN
-  { 0, CMD_SCREEN_CLOCK,   NULL },
+#ifdef ENABLE_SEARCH_SCREEN
+       { 0, CMD_SCREEN_SEARCH, 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_("Keys - 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_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_LOCATE, NULL },
+       { 0, CMD_VIEW, 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_ADD, N_("Append song to playlist") },
+       { 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_("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_ADD, N_("Append song to playlist") },
+       { 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_("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") },
 #endif
-  { 0, CMD_NONE, NULL },
-  {-1, CMD_NONE, NULL }
 };
 
-static int help_text_rows = -1;
-static list_window_t *lw = NULL;
+#define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
 
+static list_window_t *lw;
 
 static const char *
-list_callback(unsigned idx, int *highlight, void *data)
+list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED void *data)
 {
        static char buf[512];
 
-       if (help_text_rows < 0) {
-               help_text_rows = 0;
-               while (help_text[help_text_rows].highlight != -1)
-                       help_text_rows++;
-       }
-
-       *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;
+       if (idx >= help_text_rows)
+               return NULL;
 
-                               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].highlight)
+               *highlight = true;
 
+       if (help_text[idx].command == CMD_NONE) {
                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));
+                       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;
        }
 
-       return NULL;
+       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;
 }
 
 static void
 help_init(WINDOW *w, int cols, int rows)
 {
   lw = list_window_init(w, cols, rows);
-  lw->flags = LW_HIDE_CURSOR;
+       lw->hide_cursor = true;
 }
 
 static void
@@ -212,115 +204,44 @@ help_exit(void)
 
 
 static const char *
-help_title(char *str, size_t size)
+help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
 {
        return _("Help");
 }
 
 static void
-help_paint(screen_t *screen, mpdclient_t *c)
+help_paint(void)
 {
-       lw->clear = 1;
        list_window_paint(lw, list_callback, NULL);
-       wrefresh(lw->w);
 }
 
-static void
-help_update(screen_t *screen, mpdclient_t *c)
+static bool
+help_cmd(G_GNUC_UNUSED mpdclient_t *c, command_t cmd)
 {
-       if (lw->repaint) {
+       if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
                list_window_paint(lw, list_callback, NULL);
                wrefresh(lw->w);
-               lw->repaint = 0;
-       }
-}
-
-
-static int
-help_cmd(screen_t *screen, mpdclient_t *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;
+               return true;
        }
 
        lw->selected = lw->start+lw->rows;
-       if (screen_find(screen,
-                       lw,  help_text_rows,
+       if (screen_find(lw,  help_text_rows,
                        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, help_text_rows, lw->selected);
+               list_window_paint(lw, list_callback, NULL);
+               wrefresh(lw->w);
+               return true;
        }
 
-       return 0;
-}
-
-static list_window_t *
-help_lw(void)
-{
-       return lw;
+       return false;
 }
 
-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,
+};