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   { 0, 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_SCREEN_UPDATE,  NULL },
 117
 118 #ifdef ENABLE_SEARCH_SCREEN
 119   { 0, CMD_NONE,           NULL },
 120   { 0, CMD_NONE,           NULL },
 121   { 1, CMD_NONE,           N_("Keys - Search screen") },
 122   { 2, CMD_NONE,           NULL },
 123   { 0, CMD_SCREEN_SEARCH,  N_("Search") },
 124   { 0, CMD_PLAY,           N_("Select and play") },
 125   { 0, CMD_SELECT,         NULL },
 126   { 0, CMD_SEARCH_MODE,    NULL },
 127 #endif
 128 #ifdef ENABLE_LYRICS_SCREEN
 129   { 0, CMD_NONE,           NULL },
 130   { 0, CMD_NONE,           NULL },
 131   { 1, CMD_NONE,           N_("Keys - Lyrics screen") },
 132   { 2, CMD_NONE,           NULL },
 133   { 0, CMD_SCREEN_LYRICS,  N_("View Lyrics") },
 134   { 0, CMD_SELECT,         N_("(Re)load lyrics") },
 135   { 0, CMD_INTERRUPT,         N_("Interrupt retrieval") },
 136 #endif
 137   { 0, CMD_NONE, NULL },
 138   {-1, CMD_NONE, NULL }
 139 };
 140
 141 static int help_text_rows = -1;
 142 static list_window_t *lw = NULL;
 143
 144
 145 static char *
 146 list_callback(int index, int *highlight, void *data)
 147 {
 148   static char buf[512];
 149
 150   if( help_text_rows<0 )
 151     {
 152       help_text_rows = 0;
 153       while( help_text[help_text_rows].highlight != -1 )
 154         help_text_rows++;
 155     }
 156
 157   *highlight = 0;
 158   if( index<help_text_rows )
 159     {
 160       *highlight = help_text[index].highlight > 0;
 161       if( help_text[index].command == CMD_NONE )
 162         {
 163           if( help_text[index].text )
 164             g_snprintf(buf, sizeof(buf), "      %s", _(help_text[index].text));
 165           else
 166             if( help_text[index].highlight == 2 )
 167               {
 168                 int i;
 169
 170                 for(i=3; i<COLS-3 && i<sizeof(buf); i++)
 171                   buf[i]='-';
 172                 buf[i] = '\0';
 173               }
 174             else
 175               g_strlcpy(buf, " ", sizeof(buf));
 176           return buf;
 177         }
 178       if( help_text[index].text )
 179         g_snprintf(buf, sizeof(buf),
 180                    "%20s : %s   ",
 181                    get_key_names(help_text[index].command, TRUE),
 182                    _(help_text[index].text));
 183       else
 184         g_snprintf(buf, sizeof(buf),
 185                    "%20s : %s   ",
 186                    get_key_names(help_text[index].command, TRUE),
 187                    get_key_description(help_text[index].command));
 188       return buf;
 189     }
 190
 191   return NULL;
 192 }
 193
 194 static void
 195 help_init(WINDOW *w, int cols, int rows)
 196 {
 197   lw = list_window_init(w, cols, rows);
 198   lw->flags = LW_HIDE_CURSOR;
 199 }
 200
 201 static void
 202 help_resize(int cols, int rows)
 203 {
 204   lw->cols = cols;
 205   lw->rows = rows;
 206 }
 207
 208 static void
 209 help_exit(void)
 210 {
 211   list_window_free(lw);
 212 }
 213
 214
 215 static char *
 216 help_title(char *str, size_t size)
 217 {
 218   return _("Help");
 219 }
 220
 221 static void
 222 help_paint(screen_t *screen, mpdclient_t *c)
 223 {
 224   lw->clear = 1;
 225   list_window_paint(lw, list_callback, NULL);
 226   wrefresh(lw->w);
 227 }
 228
 229 static void
 230 help_update(screen_t *screen, mpdclient_t *c)
 231 {
 232   if( lw->repaint )
 233     {
 234       list_window_paint(lw, list_callback, NULL);
 235       wrefresh(lw->w);
 236       lw->repaint = 0;
 237     }
 238 }
 239
 240
 241 static int
 242 help_cmd(screen_t *screen, mpdclient_t *c, command_t cmd)
 243 {
 244   lw->repaint=1;
 245   switch(cmd)
 246     {
 247     case CMD_LIST_NEXT:
 248       if( lw->start+lw->rows < help_text_rows )
 249         lw->start++;
 250       return 1;
 251     case CMD_LIST_PREVIOUS:
 252       if( lw->start >0 )
 253         lw->start--;
 254       return 1;
 255     case CMD_LIST_FIRST:
 256       lw->start = 0;
 257       return 1;
 258     case CMD_LIST_LAST:
 259       lw->start = help_text_rows-lw->rows;
 260       if( lw->start<0 )
 261         lw->start = 0;
 262       return 1;
 263     case CMD_LIST_NEXT_PAGE:
 264       lw->start = lw->start + lw->rows;
 265       if( lw->start+lw->rows >= help_text_rows )
 266         lw->start = help_text_rows-lw->rows;
 267       if( lw->start<0 )
 268         lw->start = 0;
 269        return 1;
 270     case CMD_LIST_PREVIOUS_PAGE:
 271       lw->start = lw->start - lw->rows;
 272       if( lw->start<0 )
 273         lw->start = 0;
 274       return 1;
 275     default:
 276       break;
 277     }
 278
 279   lw->selected = lw->start+lw->rows;
 280   if( screen_find(screen, c,
 281                   lw,  help_text_rows,
 282                   cmd, list_callback, NULL) )
 283     {
 284       /* center the row */
 285       lw->start = lw->selected-(lw->rows/2);
 286       if( lw->start+lw->rows > help_text_rows )
 287         lw->start = help_text_rows-lw->rows;
 288       if( lw->start<0 )
 289         lw->start=0;
 290       return 1;
 291     }
 292
 293   return 0;
 294 }
 295
 296 static list_window_t *
 297 help_lw(void)
 298 {
 299   return lw;
 300 }
 301
 302 screen_functions_t *
 303 get_screen_help(void)
 304 {
 305   static screen_functions_t functions;
 306
 307   memset(&functions, 0, sizeof(screen_functions_t));
 308   functions.init   = help_init;
 309   functions.exit   = help_exit;
 310   functions.open   = NULL;
 311   functions.close  = NULL;
 312   functions.resize = help_resize;
 313   functions.paint  = help_paint;
 314   functions.update = help_update;
 315   functions.cmd    = help_cmd;
 316   functions.get_lw = help_lw;
 317   functions.get_title = help_title;
 318
 319   return &functions;
 320 }