src/screen_help.c

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