src/screen_help.c

   1 /*
   2  * (c) 2004 by Kalle Wallin <kaw@linux.se>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  16  *
  17  */
  18
  19 #include "config.h"
  20 #include "i18n.h"
  21 #include "mpdclient.h"
  22 #include "command.h"
  23 #include "screen.h"
  24 #include "screen_utils.h"
  25 #include "gcc.h"
  26
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <glib.h>
  30
  31 typedef struct {
  32         signed char highlight;
  33         command_t command;
  34         const char *text;
  35 } help_text_row_t;
  36
  37 static help_text_row_t help_text[] = {
  38         { 1, CMD_NONE, N_("Keys - Movement") },
  39         { 2, CMD_NONE, NULL },
  40         { 0, CMD_LIST_PREVIOUS, NULL },
  41         { 0, CMD_LIST_NEXT, NULL },
  42         { 0, CMD_LIST_PREVIOUS_PAGE, NULL },
  43         { 0, CMD_LIST_NEXT_PAGE, NULL },
  44         { 0, CMD_LIST_FIRST, NULL },
  45         { 0, CMD_LIST_LAST, NULL },
  46         { 0, CMD_NONE, NULL },
  47         { 0, CMD_SCREEN_PREVIOUS,NULL },
  48         { 0, CMD_SCREEN_NEXT, NULL },
  49         { 0, CMD_SCREEN_HELP, NULL },
  50         { 0, CMD_SCREEN_PLAY, NULL },
  51         { 0, CMD_SCREEN_FILE, NULL },
  52 #ifdef ENABLE_SEARCH_SCREEN
  53         { 0, CMD_SCREEN_SEARCH, NULL },
  54 #endif
  55 #ifdef ENABLE_KEYDEF_SCREEN
  56         { 0, CMD_SCREEN_KEYDEF, NULL },
  57 #endif
  58
  59         { 0, CMD_NONE, NULL },
  60         { 0, CMD_NONE, NULL },
  61         { 1, CMD_NONE, N_("Keys - Global") },
  62         { 2, CMD_NONE, NULL },
  63         { 0, CMD_STOP, NULL },
  64         { 0, CMD_PAUSE, NULL },
  65         { 0, CMD_CROP, NULL },
  66         { 0, CMD_TRACK_NEXT, NULL },
  67         { 0, CMD_TRACK_PREVIOUS, NULL },
  68         { 0, CMD_SEEK_FORWARD, NULL },
  69         { 0, CMD_SEEK_BACKWARD, NULL },
  70         { 0, CMD_VOLUME_DOWN, NULL },
  71         { 0, CMD_VOLUME_UP, NULL },
  72         { 0, CMD_NONE, NULL },
  73         { 0, CMD_REPEAT, NULL },
  74         { 0, CMD_RANDOM, NULL },
  75         { 0, CMD_CROSSFADE, NULL },
  76         { 0, CMD_SHUFFLE, NULL },
  77         { 0, CMD_DB_UPDATE, NULL },
  78         { 0, CMD_NONE, NULL },
  79         { 0, CMD_LIST_FIND, NULL },
  80         { 0, CMD_LIST_RFIND, NULL },
  81         { 0, CMD_LIST_FIND_NEXT, NULL },
  82         { 0, CMD_LIST_RFIND_NEXT, NULL },
  83         { 0, CMD_TOGGLE_FIND_WRAP, NULL },
  84         { 0, CMD_NONE, NULL },
  85         { 0, CMD_QUIT, NULL },
  86
  87         { 0, CMD_NONE, NULL },
  88         { 0, CMD_NONE, NULL },
  89         { 1, CMD_NONE, N_("Keys - Playlist screen") },
  90         { 2, CMD_NONE, NULL },
  91         { 0, CMD_PLAY, N_("Play") },
  92         { 0, CMD_DELETE, NULL },
  93         { 0, CMD_CLEAR, NULL },
  94         { 1, CMD_LIST_MOVE_UP, N_("Move song up") },
  95         { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
  96         { 0, CMD_ADD, NULL },
  97         { 0, CMD_SAVE_PLAYLIST, NULL },
  98         { 0, CMD_SCREEN_UPDATE, N_("Center") },
  99         { 0, CMD_TOGGLE_AUTOCENTER, NULL },
 100
 101         { 0, CMD_NONE, NULL },
 102         { 0, CMD_NONE, NULL },
 103         { 1, CMD_NONE, N_("Keys - Browse screen") },
 104         { 2, CMD_NONE, NULL },
 105         { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
 106         { 0, CMD_SELECT, NULL },
 107         { 0, CMD_ADD, N_("Append song to playlist") },
 108         { 0, CMD_SAVE_PLAYLIST, NULL },
 109         { 0, CMD_DELETE, N_("Delete playlist") },
 110         { 0, CMD_GO_PARENT_DIRECTORY, NULL },
 111         { 0, CMD_GO_ROOT_DIRECTORY, NULL },
 112         { 0, CMD_SCREEN_UPDATE, NULL },
 113
 114 #ifdef ENABLE_SEARCH_SCREEN
 115         { 0, CMD_NONE, NULL },
 116         { 0, CMD_NONE, NULL },
 117         { 1, CMD_NONE, N_("Keys - Search screen") },
 118         { 2, CMD_NONE, NULL },
 119         { 0, CMD_SCREEN_SEARCH, N_("Search") },
 120         { 0, CMD_PLAY, N_("Select and play") },
 121         { 0, CMD_SELECT, NULL },
 122         { 0, CMD_ADD, N_("Append song to playlist") },
 123         { 0, CMD_SELECT_ALL,     NULL },
 124         { 0, CMD_SEARCH_MODE, NULL },
 125 #endif
 126 #ifdef ENABLE_LYRICS_SCREEN
 127         { 0, CMD_NONE, NULL },
 128         { 0, CMD_NONE, NULL },
 129         { 1, CMD_NONE, N_("Keys - Lyrics screen") },
 130         { 2, CMD_NONE, NULL },
 131         { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
 132         { 0, CMD_SELECT, N_("(Re)load lyrics") },
 133         { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
 134         { 0, CMD_LYRICS_UPDATE, N_("Explicitly download lyrics") },
 135         { 0, CMD_ADD, N_("Save lyrics") },
 136 #endif
 137 };
 138
 139 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
 140
 141 static list_window_t *lw;
 142
 143 static const char *
 144 list_callback(unsigned idx, int *highlight, mpd_unused void *data)
 145 {
 146         static char buf[512];
 147
 148         if (idx >= help_text_rows)
 149                 return NULL;
 150
 151         if (help_text[idx].highlight)
 152                 *highlight = 1;
 153
 154         if (help_text[idx].command == CMD_NONE) {
 155                 if (help_text[idx].text)
 156                         g_snprintf(buf, sizeof(buf), "      %s", _(help_text[idx].text));
 157                 else if (help_text[idx].highlight == 2) {
 158                         int i;
 159
 160                         for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
 161                                 buf[i] = '-';
 162                         buf[i] = '\0';
 163                 } else
 164                         g_strlcpy(buf, " ", sizeof(buf));
 165                 return buf;
 166         }
 167
 168         if (help_text[idx].text)
 169                 g_snprintf(buf, sizeof(buf),
 170                            "%20s : %s   ",
 171                            get_key_names(help_text[idx].command, TRUE),
 172                            _(help_text[idx].text));
 173         else
 174                 g_snprintf(buf, sizeof(buf),
 175                            "%20s : %s   ",
 176                            get_key_names(help_text[idx].command, TRUE),
 177                            get_key_description(help_text[idx].command));
 178         return buf;
 179 }
 180
 181 static void
 182 help_init(WINDOW *w, int cols, int rows)
 183 {
 184   lw = list_window_init(w, cols, rows);
 185   lw->flags = LW_HIDE_CURSOR;
 186 }
 187
 188 static void
 189 help_resize(int cols, int rows)
 190 {
 191   lw->cols = cols;
 192   lw->rows = rows;
 193 }
 194
 195 static void
 196 help_exit(void)
 197 {
 198   list_window_free(lw);
 199 }
 200
 201
 202 static const char *
 203 help_title(mpd_unused char *str, mpd_unused size_t size)
 204 {
 205         return _("Help");
 206 }
 207
 208 static void
 209 help_paint(void)
 210 {
 211         list_window_paint(lw, list_callback, NULL);
 212 }
 213
 214 static int
 215 help_cmd(mpd_unused mpdclient_t *c, command_t cmd)
 216 {
 217         if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
 218                 list_window_paint(lw, list_callback, NULL);
 219                 wrefresh(lw->w);
 220                 return 1;
 221         }
 222
 223         lw->selected = lw->start+lw->rows;
 224         if (screen_find(lw,  help_text_rows,
 225                         cmd, list_callback, NULL)) {
 226                 /* center the row */
 227                 list_window_center(lw, help_text_rows, lw->selected);
 228                 list_window_paint(lw, list_callback, NULL);
 229                 wrefresh(lw->w);
 230                 return 1;
 231         }
 232
 233         return 0;
 234 }
 235
 236 const struct screen_functions screen_help = {
 237         .init = help_init,
 238         .exit = help_exit,
 239         .resize = help_resize,
 240         .paint = help_paint,
 241         .cmd = help_cmd,
 242         .get_title = help_title,
 243 };