path: root/src/command.c

/* 
 * $Id$
 *
 * (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 <ctype.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <glib.h>
#include <signal.h>
#include <ncurses.h>

#include "config.h"
#include "ncmpc.h"
#include "command.h"

#undef DEBUG_KEYS

#ifdef DEBUG_KEYS
#define DK(x) x
#else
#define DK(x)
#endif

extern void sigstop(void);
extern void screen_resize(void);

#define BS   KEY_BACKSPACE
#define DEL  KEY_DC
#define UP   KEY_UP
#define DWN  KEY_DOWN
#define LEFT KEY_LEFT
#define RGHT KEY_RIGHT
#define HOME KEY_HOME
#define END  KEY_END
#define PGDN KEY_NPAGE
#define PGUP KEY_PPAGE
#define TAB  0x09
#define STAB 0x161
#define ESC  0x1B
#define F1   KEY_F(1)
#define F2   KEY_F(2)
#define F3   KEY_F(3)
#define F4   KEY_F(4)
#define F5   KEY_F(5)
#define F6   KEY_F(6)
#define F7   KEY_F(7)


static command_definition_t cmds[] =
{
#ifdef ENABLE_KEYDEF_SCREEN
  { {'K',   0,   0 }, 0, CMD_SCREEN_KEYDEF,    "screen-keyedit",
    N_("Key configuration screen") },
#endif
  { { 'q', 'Q',  3 }, 0, CMD_QUIT,   "quit",
    N_("Quit") },  

  /* movment */
  { {  UP,  'k',   0 }, 0, CMD_LIST_PREVIOUS,      "up",
    N_("Move cursor up") },
  { { DWN,  'j',   0 }, 0, CMD_LIST_NEXT,          "down",
    N_("Move cursor down") },
  { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST,          "home",
    N_("Home ") },
  { { END,  0x05, 0 }, 0, CMD_LIST_LAST,           "end",
    N_("End ") },
  { { PGUP,   0,   0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
    N_("Page up") },
  { { PGDN,   0,   0 }, 0, CMD_LIST_NEXT_PAGE,     "pgdn", 
    N_("Page down") },


  /* basic screens */
  { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP,      "screen-help",
    N_("Help screen") },
  { { '2', F2,  0 }, 0, CMD_SCREEN_PLAY,      "screen-playlist",
    N_("Playlist screen") },
  { { '3', F3,  0 }, 0, CMD_SCREEN_FILE,      "screen-browse",
    N_("Browse screen") },


  /* player commands */
  { {  13,   0,   0 }, 0, CMD_PLAY, "play",  
    N_("Play/Enter directory") },
  { { 'P',   0,   0 }, 0, CMD_PAUSE,"pause", 
    N_("Pause") },
  { { 's',  BS,   0 }, 0, CMD_STOP, "stop",   
    N_("Stop") },
  { { '>',   0,   0 }, 0, CMD_TRACK_NEXT, "next", 
    N_("Next track") },
  { { '<',   0,   0 }, 0, CMD_TRACK_PREVIOUS, "prev", 
    N_("Previous track") },
  { { 'f',   0,   0 }, 0, CMD_SEEK_FORWARD, "seek-forward", 
    N_("Seek forward") },
  { { 'b',   0,   0 }, 0, CMD_SEEK_BACKWARD, "seek-backward", 
    N_("Seek backward") },
  { { '+', RGHT,  0 }, 0, CMD_VOLUME_UP, "volume-up", 
    N_("Increase volume") },
  { { '-', LEFT,  0 }, 0, CMD_VOLUME_DOWN, "volume-down", 
    N_("Decrease volume") },
  { { ' ',   0,   0 }, 0, CMD_SELECT, "select", 
    N_("Select/deselect song in playlist") },
  { { DEL,  'd',  0 }, 0, CMD_DELETE, "delete",
    N_("Delete song from playlist") },
  { { 'Z',   0,   0 }, 0, CMD_SHUFFLE, "shuffle",
    N_("Shuffle playlist") },
  { { 'c',   0,   0 }, 0, CMD_CLEAR, "clear",
    N_("Clear playlist") },
  { { 'r',   0,   0 }, 0, CMD_REPEAT, "repeat",
    N_("Toggle repeat mode") },
  { { 'z',   0,   0 }, 0, CMD_RANDOM, "random",
    N_("Toggle random mode") },
  { { 'x',   0,   0 }, 0, CMD_CROSSFADE, "crossfade",
    N_("Toggle crossfade mode") },
  { { 21,    0,   0 }, 0, CMD_DB_UPDATE,  "db-update",
    N_("Start a music database update") },
  { { 'S',   0,   0 }, 0, CMD_SAVE_PLAYLIST, "save",
    N_("Save playlist") },
  { { 'a',   0,   0 }, 0, CMD_ADD, "add",
    N_("Add url/file to playlist") },

  { { '!',   0,   0 }, 0, CMD_GO_ROOT_DIRECTORY, "go-root-directory",
    N_("Go to root directory") },
  { { '"',   0,   0 }, 0, CMD_GO_PARENT_DIRECTORY, "go-parent-directory",
    N_("Go to parent directory") },

  /* lists */
  { { 11,  0,   0 }, 0, CMD_LIST_MOVE_UP,     "move-up", 
    N_("Move item up") },
  { { 10,  0,   0 }, 0, CMD_LIST_MOVE_DOWN,   "move-down", 
    N_("Move item down") },
  { { 12,  0,   0 }, 0, CMD_SCREEN_UPDATE,    "update",
    N_("Update screen") },


  /* ncmpc options */
  { { 'w',   0,   0 }, 0, CMD_TOGGLE_FIND_WRAP,  "wrap-mode", 
    N_("Toggle find mode") },
  { { 'U',   0,   0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode", 
    N_("Toggle auto center mode") },


  /* change screen */
  { { TAB,   0,   0 }, 0, CMD_SCREEN_NEXT,     "screen-next",
    N_("Next screen") },
  { { STAB,  0,   0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
    N_("Previous screen") },

 
  /* find */
  { { '/',   0,   0 }, 0, CMD_LIST_FIND,           "find",
    N_("Forward find") },
  { { 'n',   0,   0 }, 0, CMD_LIST_FIND_NEXT,      "find-next",
    N_("Forward find next") },
  { { '?',   0,   0 }, 0, CMD_LIST_RFIND,          "rfind",
    N_("Backward find") },
  { { 'p',   0,   0 }, 0, CMD_LIST_RFIND_NEXT,     "rfind-next",
    N_("Backward find previous") },


  /* extra screens */
#ifdef ENABLE_ARTIST_SCREEN
  { {'4',  F4,   0 }, 0, CMD_SCREEN_ARTIST,    "screen-artist",
    N_("Artist screen") },
#endif
#ifdef ENABLE_SEARCH_SCREEN
  { {'5',  F5,   0 }, 0, CMD_SCREEN_SEARCH,    "screen-search",
    N_("Search screen") },
  { {'m',   0,   0 }, 0, CMD_SEARCH_MODE,      "search-mode",
    N_("Change search mode") },
#endif

#ifdef ENABLE_CLOCK_SCREEN
  { {'6',  F6,   0 }, 0, CMD_SCREEN_CLOCK,    "screen-clock",
    N_("Clock screen") },
#endif
#ifdef ENABLE_LYRICS_SCREEN
  { {'7',  F7,   0 }, 0, CMD_SCREEN_LYRICS,    "screen-lyrics",
    N_("Lyrics screen") },
  { {ESC,  0,   0 }, 0, CMD_INTERRUPT,    "lyrics-interrupt",
    N_("Interrupt action") },
  { {'u',  0,   0 }, 0, CMD_LYRICS_UPDATE,    "lyrics-update",
    N_("Update Lyrics") },
#endif


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

command_definition_t *
get_command_definitions(void)
{
  return cmds;
}

char *
key2str(int key)
{
  static char buf[32];
  int i;

  buf[0] = 0;
  switch(key)
    {
    case 0:
      return _("Undefined");
    case ' ':
      return _("Space");
    case 13:
      return _("Enter");
    case BS:
      return _("Backspace");
    case DEL:
      return _("Delete");
    case UP: 
      return _("Up");
    case DWN:
      return _("Down");
    case LEFT:
      return _("Left");
    case RGHT:
      return _("Right");
    case HOME:
      return _("Home");
    case END:
      return _("End");
    case PGDN:
      return _("PageDown");
    case PGUP:
      return _("PageUp");
    case TAB: 
      return _("Tab");
    case STAB:
      return _("Shift+Tab");
    case ESC:
      return _("Esc");
    case KEY_IC:
      return _("Insert");
    default:
      for(i=0; i<=63; i++)
	if( key==KEY_F(i) )
	  {
	    g_snprintf(buf, 32, "F%d", i );
	    return buf;
	  }
      if( !(key & ~037) )
	g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
      else if( (key & ~037) == 224 )
	g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
      else if( key>32 &&  key<256 )
	g_snprintf(buf, 32, "%c", key);
      else
	g_snprintf(buf, 32, "0x%03X", key);
    }
  return buf;
}

void
command_dump_keys(void)
{
  int i;

  i=0;
  while( cmds[i].description )
    {
      if( cmds[i].command != CMD_NONE )
	printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name); 
      i++;
    }
}

int
set_key_flags(command_definition_t *cp, command_t command, int flags)
{
  int i;

  i=0;
  while( cp[i].name )
    {
      if( cp[i].command == command )
	{
	  cp[i].flags |= flags;
	  return 0;
	}
      i++;
    }
  return 1;
}

char *
get_key_names(command_t command, int all)
{
  int i;
  
  i=0;
  while( cmds[i].description )
    {
      if( cmds[i].command == command )
	{
	  int j;
	  static char keystr[80];

	  g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
	  if( !all )
	    return keystr;
	  j=1;
	  while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
	    {
	      g_strlcat(keystr, " ", sizeof(keystr));
	      g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
	      j++;
	    }
	  return keystr;
 	}
      i++;
    }
  return NULL;
}

char *
get_key_description(command_t command)
{
  int i;

  i=0;
  while( cmds[i].description )
    {
      if( cmds[i].command == command )
	return _(cmds[i].description);
      i++;
    }
  return NULL;
}

char *
get_key_command_name(command_t command)
{
  int i;

  i=0;
  while( cmds[i].name )
    {
      if( cmds[i].command == command )
	return cmds[i].name;
      i++;
    }
  return NULL;
}

command_t 
get_key_command_from_name(char *name)
{
  int i;

  i=0;
  while( cmds[i].name )
    {
      if( strcmp(name, cmds[i].name) == 0 )
	return cmds[i].command;
      i++;
    }
  return CMD_NONE;
}


command_t 
find_key_command(int key, command_definition_t *cmds)
{
  int i;

  i=0;
  while( key && cmds && cmds[i].name )
    {
      if( cmds[i].keys[0] == key || 
	  cmds[i].keys[1] == key ||
	  cmds[i].keys[2] == key )
	return cmds[i].command;
      i++;
    }
  return CMD_NONE;
}

command_t 
get_key_command(int key)
{
  return find_key_command(key, cmds);
}

int
my_wgetch(WINDOW *w)
{
  int c;

  c = wgetch(w);

  /* handle resize event */
  if( c==KEY_RESIZE )
    screen_resize();

#ifdef ENABLE_RAW_MODE
  /* handle SIGSTOP (Ctrl-Z) */
  if( c==26 || c==407 )
    sigstop();
  /* handle SIGINT (Ctrl-C) */
  if( c==3 )
    exit(EXIT_SUCCESS);
#endif

  return c;
}

command_t
get_keyboard_command_with_timeout(int ms)
{
  int key;

  if( ms != SCREEN_TIMEOUT)
    timeout(ms);
  key = my_wgetch(stdscr);
  if( ms != SCREEN_TIMEOUT)
    timeout(SCREEN_TIMEOUT);

  if( key==ERR )
    return CMD_NONE;

#ifdef HAVE_GETMOUSE
  if( key==KEY_MOUSE )
    return CMD_MOUSE_EVENT;
#endif

  return get_key_command(key);
}

command_t
get_keyboard_command(void)
{
  return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
}

int
assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
{
 int i;

  i=0;
  while( cmds[i].name )
    {
      if( cmds[i].command == command )
	{
	  memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
	  cmds[i].flags |= COMMAND_KEY_MODIFIED;
	  return 0;
	}
      i++;
    }
  return -1;
}

int 
check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
{
  int i;
  int retval = 0;

  if( cp==NULL )
    cp = cmds;

  i=0;
  while( cp[i].name )
    {
      cp[i].flags &= ~COMMAND_KEY_CONFLICT;
      i++;
    }
  
  i=0;
  while( cp[i].name )
    {
      int j;
      command_t cmd;	  

      for(j=0; j<MAX_COMMAND_KEYS; j++)
	if( cp[i].keys[j] && 
	    (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
	  {
	    if( buf )
#ifdef ENABLE_KEYDEF_SCREEN
	      g_snprintf(buf, bufsize,
			 _("Key %s assigned to %s and %s (press %s for the key editor)"),
			 key2str(cp[i].keys[j]),
			 get_key_command_name(cp[i].command),
			 get_key_command_name(cmd),
			 get_key_names(CMD_SCREEN_KEYDEF,0));
#else
	    g_snprintf(buf, bufsize,
		       _("Error: Key %s assigned to %s and %s !!!\n"),
		       key2str(cp[i].keys[j]),
		       get_key_command_name(cp[i].command),
		       get_key_command_name(cmd));
#endif
	    else
	      fprintf(stderr,
		      _("Error: Key %s assigned to %s and %s !!!\n"),
		      key2str(cp[i].keys[j]),
		      get_key_command_name(cp[i].command),
		      get_key_command_name(cmd));
	    cp[i].flags |= COMMAND_KEY_CONFLICT;
	    set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
	    retval = -1;
	  }	
      i++;
    }
  return retval;
}

int
write_key_bindings(FILE *f, int flags)
{
  int i,j;

  if( flags & KEYDEF_WRITE_HEADER )
    fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");

  i=0;
  while( cmds[i].name && !ferror(f) )
    {
      if( cmds[i].flags & COMMAND_KEY_MODIFIED || flags & KEYDEF_WRITE_ALL)
	{
	  fprintf(f, "## %s\n", cmds[i].description);
	  if( flags & KEYDEF_COMMENT_ALL )
	    fprintf(f, "#");
	  fprintf(f, "key %s = ", cmds[i].name);
	  for(j=0; j<MAX_COMMAND_KEYS; j++)
	    {
	      if( j && cmds[i].keys[j] )
		fprintf(f, ",  ");
	      if( !j || cmds[i].keys[j] )
		{
		  if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) || 
					      isdigit(cmds[i].keys[j])) )
		    fprintf(f, "\'%c\'", cmds[i].keys[j]);
		  else
		    fprintf(f, "%d", cmds[i].keys[j]);
		}
	    }
	  fprintf(f,"\n\n");
	}
      i++;
    }
  return ferror(f);
}