path: root/screen_help.c

/* 
 * (c) 2004 by Kalle Wallin (kaw@linux.se)
 *
 * 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
 *
 */

#include <stdlib.h>
#include <string.h>
#include <glib.h>
#include <ncurses.h>

#include "config.h"
#include "libmpdclient.h"
#include "mpc.h"
#include "command.h"
#include "screen.h"
#include "screen_utils.h"
#include "screen_help.h"


typedef struct
{
  signed char highlight;
  command_t command;
  char *text;
} help_text_row_t;

static help_text_row_t help_text[] = 
{
  { 1, CMD_NONE,  "          Movement keys  " },
  { 0, CMD_NONE,  "        -----------------" },
  { 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_NEXT,    NULL },
  { 0, CMD_SCREEN_HELP,    NULL },
  { 0, CMD_SCREEN_PLAY,    NULL },
  { 0, CMD_SCREEN_FILE,    NULL },
#ifdef ENABLE_KEYDEF_SCREEN
  { 0, CMD_SCREEN_KEYDEF,  NULL },
#endif

  { 0, CMD_NONE,           NULL },
  { 0, CMD_NONE,           NULL },
  { 1, CMD_NONE, "          General keys " },
  { 0, CMD_NONE, "        ----------------" },
  { 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_SHUFFLE,        NULL },
  { 0, CMD_REPEAT,         NULL },
  { 0, CMD_RANDOM,         NULL },
  { 0, CMD_CROSSFADE,      NULL },
  { 0, CMD_NONE,           NULL },
  { 0, CMD_QUIT,           NULL },

  { 0, CMD_NONE,           NULL },
  { 0, CMD_NONE,           NULL },
  { 1, CMD_NONE, "          Keys - Playlist screen " },
  { 0, CMD_NONE, "        --------------------------" },
  { 0, CMD_PLAY,           "Play" },
  { 0, CMD_DELETE,         NULL },
  { 0, CMD_CLEAR,          NULL },
  { 0, CMD_SAVE_PLAYLIST,  NULL },
  { 0, CMD_SCREEN_UPDATE,  "Center" },
  { 0, CMD_TOGGLE_AUTOCENTER, NULL },

  { 0, CMD_NONE,           NULL },
  { 0, CMD_NONE,           NULL },
  { 1, CMD_NONE, "          Keys - Browse screen " },
  { 0, CMD_NONE, "        ------------------------" },
  { 0, CMD_PLAY,            "Enter directory" },
  { 0, CMD_SELECT,          NULL },
  { 0, CMD_DELETE,          NULL },
  { 0, CMD_SCREEN_UPDATE,   NULL },

  { 0, CMD_NONE,           NULL },
  { 0, CMD_NONE,           NULL },
  { 1, CMD_NONE, "               Find keys " },
  { 0, CMD_NONE, "              -------------" },
  { 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_NONE, NULL },
  { 1, CMD_NONE, "          ncmpc build information " },
  { 0, CMD_NONE, "         ---------------------------" },
  { 0, CMD_NONE, "             Version : " VERSION },
  { 0, CMD_NONE, "  Configuration dirs : ~/.ncmpc, " SYSCONFDIR "/" PACKAGE },
#ifdef ENABLE_KEYDEF_SCREEN
  { 0, CMD_NONE, "          Key Editor : yes" },
#else
  { 0, CMD_NONE, "          Key Editor : no" },
#endif

  { 0, CMD_NONE, NULL },
  {-1, CMD_NONE, NULL }
};

static int help_text_rows = -1;
static list_window_t *lw = NULL;


static char *
list_callback(int index, int *highlight, void *data)
{
  static char buf[256];

  if( help_text_rows<0 )
    {
      help_text_rows = 0;
      while( help_text[help_text_rows].highlight != -1 )
	help_text_rows++;
    }

  *highlight = 0;
  if( index<help_text_rows )
    {
      *highlight = help_text[index].highlight > 0;
      if( help_text[index].command == CMD_NONE )
	{
	  if( help_text[index].text )
	    return help_text[index].text;
	  else
	    return "  ";
	}
      if( help_text[index].text )
	snprintf(buf, 256, 
		 "%20s : %s   ", 
		 get_key_names(help_text[index].command, TRUE),
		 help_text[index].text);
      else
	snprintf(buf, 256, 
		 "%20s : %s   ", 
		 get_key_names(help_text[index].command, TRUE),
		 get_key_description(help_text[index].command));
      return buf;
    }

  return NULL;
}

static void
help_init(WINDOW *w, int cols, int rows)
{
  lw = list_window_init(w, cols, rows);
}

static void
help_exit(void)
{
  list_window_free(lw);
}


static char *
help_title(void)
{
  return (TOP_HEADER_PREFIX "Help");
}

static void 
help_paint(screen_t *screen, mpd_client_t *c)
{
  lw->clear = 1;
  list_window_paint(lw, list_callback, NULL);
  wrefresh(lw->w);
}

static void 
help_update(screen_t *screen, mpd_client_t *c)
{  
  if( lw->repaint )
    {
      list_window_paint(lw, list_callback, NULL);
      wrefresh(lw->w);
      lw->repaint = 0;
    }
}


static int 
help_cmd(screen_t *screen, mpd_client_t *c, command_t cmd)
{
  int retval;

  retval = list_window_cmd(lw, help_text_rows, cmd);
  if( !retval )
    return screen_find(screen, c, 
		       lw,  help_text_rows,
		       cmd, list_callback);

  return retval;
}

static list_window_t *
help_lw(void)
{
  return lw;
}

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.paint  = help_paint;
  functions.update = help_update;
  functions.cmd    = help_cmd;
  functions.get_lw = help_lw;
  functions.get_title = help_title;

  return &functions;
}