Code

list_window: added attribute "length"
[ncmpc.git] / src / screen_help.c
index 07e3375fe5b4ffc4a272ff4aef773be9c468c114..eb738c360ce76d4df4a85227791289b5b40c1331 100644 (file)
@@ -1,36 +1,29 @@
-/* 
- * $Id$
- *
- * (c) 2004 by Kalle Wallin <kaw@linux.se>
- *
+/* ncmpc (Ncurses MPD Client)
+ * (c) 2004-2009 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., 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 "config.h"
-#include "ncmpc.h"
-#include "mpdclient.h"
-#include "command.h"
-#include "screen.h"
-#include "screen_utils.h"
-#include "gcc.h"
+#include "i18n.h"
 
-#include <stdlib.h>
-#include <string.h>
 #include <glib.h>
-#include <ncurses.h>
-
 
 typedef struct {
        signed char highlight;
@@ -38,113 +31,158 @@ 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 },
+static help_text_row_t 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_OUTPUTS_SCREEN
+       { 0, CMD_SCREEN_OUTPUTS, 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_("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 },
+       { 0, CMD_SCREEN_SONG, 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_("Playlist 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_("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_("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_("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_("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_SAVE_PLAYLIST, N_("Save 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_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_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 = NULL;
-
+static struct list_window *lw;
 
 static const char *
-list_callback(unsigned idx, int *highlight, mpd_unused void *data)
+list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED char** second_column, G_GNUC_UNUSED void *data)
 {
        static char buf[512];
 
@@ -152,7 +190,7 @@ list_callback(unsigned idx, int *highlight, mpd_unused void *data)
                return NULL;
 
        if (help_text[idx].highlight)
-               *highlight = 1;
+               *highlight = true;
 
        if (help_text[idx].command == CMD_NONE) {
                if (help_text[idx].text)
@@ -185,7 +223,8 @@ 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;
+       list_window_set_length(lw, G_N_ELEMENTS(help_text));
 }
 
 static void
@@ -203,46 +242,36 @@ help_exit(void)
 
 
 static const char *
-help_title(mpd_unused char *str, mpd_unused size_t size)
+help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
 {
        return _("Help");
 }
 
 static void
-help_paint(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
+help_paint(void)
 {
-       lw->clear = 1;
        list_window_paint(lw, list_callback, NULL);
-       wrefresh(lw->w);
 }
 
-static void
-help_update(mpd_unused screen_t *screen, mpd_unused mpdclient_t *c)
+static bool
+help_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
 {
-       if (lw->repaint) {
+       if (list_window_scroll_cmd(lw, cmd)) {
                list_window_paint(lw, list_callback, NULL);
                wrefresh(lw->w);
-               lw->repaint = 0;
+               return true;
        }
-}
 
-
-static int
-help_cmd(screen_t *screen, mpd_unused mpdclient_t *c, command_t cmd)
-{
-       if (list_window_scroll_cmd(lw, help_text_rows, cmd))
-               return 1;
-
-       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 */
-               list_window_center(lw, help_text_rows, lw->selected);
-               return 1;
+               list_window_center(lw, lw->selected);
+               list_window_paint(lw, list_callback, NULL);
+               wrefresh(lw->w);
+               return true;
        }
 
-       return 0;
+       return false;
 }
 
 const struct screen_functions screen_help = {
@@ -250,7 +279,6 @@ const struct screen_functions screen_help = {
        .exit = help_exit,
        .resize = help_resize,
        .paint = help_paint,
-       .update = help_update,
        .cmd = help_cmd,
        .get_title = help_title,
 };