src/command.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 <ctype.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <ctype.h>
  26 #include <glib.h>
  27 #include <ncurses.h>
  28
  29 #include "config.h"
  30 #include "ncmpc.h"
  31 #include "command.h"
  32
  33 #undef DEBUG_KEYS
  34
  35 #ifdef DEBUG_KEYS
  36 #define DK(x) x
  37 #else
  38 #define DK(x)
  39 #endif
  40
  41 extern void screen_resize(void);
  42
  43 #define BS   KEY_BACKSPACE
  44 #define DEL  KEY_DC
  45 #define UP   KEY_UP
  46 #define DWN  KEY_DOWN
  47 #define LEFT KEY_LEFT
  48 #define RGHT KEY_RIGHT
  49 #define HOME KEY_HOME
  50 #define END  KEY_END
  51 #define PGDN KEY_NPAGE
  52 #define PGUP KEY_PPAGE
  53 #define TAB  0x09
  54 #define STAB 0x161
  55 #define ESC  0x1B
  56 #define F1   KEY_F(1)
  57 #define F2   KEY_F(2)
  58 #define F3   KEY_F(3)
  59 #define F4   KEY_F(4)
  60 #define F5   KEY_F(5)
  61 #define F6   KEY_F(6)
  62
  63
  64 static command_definition_t cmds[] =
  65 {
  66   { {  13,   0,   0 }, CMD_PLAY, "play",
  67     N_("Play/Enter directory") },
  68   { { 'P',   0,   0 }, CMD_PAUSE,"pause",
  69     N_("Pause") },
  70   { { 's',  BS,   0 }, CMD_STOP, "stop",
  71     N_("Stop") },
  72   { { '>',   0,   0 }, CMD_TRACK_NEXT, "next",
  73     N_("Next track") },
  74   { { '<',   0,   0 }, CMD_TRACK_PREVIOUS, "prev",
  75     N_("Previous track") },
  76   { { 'f',   0,   0 }, CMD_SEEK_FORWARD, "seek-forward",
  77     N_("Seek forward") },
  78   { { 'b',   0,   0 }, CMD_SEEK_BACKWARD, "seek-backward",
  79     N_("Seek backward") },
  80
  81   { { '+', RGHT,  0 }, CMD_VOLUME_UP, "volume-up",
  82     N_("Increase volume") },
  83   { { '-', LEFT,  0 }, CMD_VOLUME_DOWN, "volume-down",
  84     N_("Decrease volume") },
  85
  86   { { 'w',   0,   0 }, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
  87     N_("Toggle find mode") },
  88   { { 'U',   0,   0 }, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
  89     N_("Toggle auto center mode") },
  90
  91   { { ' ',  'a',   0 }, CMD_SELECT, "select",
  92     N_("Select/deselect song in playlist") },
  93   { { DEL,  'd',  0 }, CMD_DELETE, "delete",
  94     N_("Delete song from playlist") },
  95   { { 'Z',   0,   0 }, CMD_SHUFFLE, "shuffle",
  96     N_("Shuffle playlist") },
  97   { { 'c',   0,   0 }, CMD_CLEAR, "clear",
  98     N_("Clear playlist") },
  99   { { 'r',   0,   0 }, CMD_REPEAT, "repeat",
 100     N_("Toggle repeat mode") },
 101   { { 'z',   0,   0 }, CMD_RANDOM, "random",
 102     N_("Toggle random mode") },
 103   { { 'x',   0,   0 }, CMD_CROSSFADE, "crossfade",
 104     N_("Toggle crossfade mode") },
 105   { { 21,   0,   0 }, CMD_DB_UPDATE,  "db-update",
 106     N_("Start a music database update") },
 107
 108   { { 'S',   0,   0 }, CMD_SAVE_PLAYLIST, "save",
 109     N_("Save playlist") },
 110
 111   { { 0,  0,   0 }, CMD_LIST_MOVE_UP,     "move-up",
 112     N_("Move item up") },
 113   { { 0,  0,   0 }, CMD_LIST_MOVE_DOWN,   "move-down",
 114     N_("Move item down") },
 115
 116   { {  UP,  ',',   0 }, CMD_LIST_PREVIOUS,      "up",
 117     N_("Move cursor up") },
 118   { { DWN,  '.',   0 }, CMD_LIST_NEXT,          "down",
 119     N_("Move cursor down") },
 120   { { HOME, 0x01, 0 }, CMD_LIST_FIRST,          "home",
 121     N_("Home ") },
 122   { { END,  0x05, 0 }, CMD_LIST_LAST,           "end",
 123     N_("End ") },
 124   { { PGUP, 'A',   0 }, CMD_LIST_PREVIOUS_PAGE, "pgup",
 125     N_("Page up") },
 126   { { PGDN, 'B',   0 }, CMD_LIST_NEXT_PAGE,     "pgdn",
 127     N_("Page down") },
 128   { { '/',   0,   0 }, CMD_LIST_FIND,           "find",
 129     N_("Forward find") },
 130   { { 'n',   0,   0 }, CMD_LIST_FIND_NEXT,      "find-next",
 131     N_("Forward find next") },
 132   { { '?',   0,   0 }, CMD_LIST_RFIND,          "rfind",
 133     N_("Backward find") },
 134   { { 'p',   0,   0 }, CMD_LIST_RFIND_NEXT,     "rfind-next",
 135     N_("Backward find previous") },
 136
 137
 138   { { TAB,   0,   0 }, CMD_SCREEN_NEXT,     "screen-next",
 139     N_("Next screen") },
 140
 141   { { STAB,  0,   0 }, CMD_SCREEN_PREVIOUS, "screen-prev",
 142     N_("Previous screen") },
 143
 144   { { '1', F1, 'h' }, CMD_SCREEN_HELP,      "screen-help",
 145     N_("Help screen") },
 146   { { '2', F2,  0 }, CMD_SCREEN_PLAY,      "screen-playlist",
 147     N_("Playlist screen") },
 148   { { '3', F3,  0 }, CMD_SCREEN_FILE,      "screen-browse",
 149     N_("Browse screen") },
 150   { {'u',   0,   0 }, CMD_SCREEN_UPDATE,    "update",
 151     N_("Update screen") },
 152 #ifdef ENABLE_CLOCK_SCREEN
 153   { {'4',  F4,   0 }, CMD_SCREEN_CLOCK,    "screen-clock",
 154     N_("Clock screen") },
 155 #endif
 156 #ifdef ENABLE_KEYDEF_SCREEN
 157   { {'K',   0,   0 }, CMD_SCREEN_KEYDEF,    "screen-keyedit",
 158     N_("Key configuration screen") },
 159 #endif
 160
 161   { { 'q',  0,   0 }, CMD_QUIT,   "quit",
 162     N_("Quit") },
 163
 164   { { -1,  -1,  -1 }, CMD_NONE, NULL, NULL }
 165 };
 166
 167 command_definition_t *
 168 get_command_definitions(void)
 169 {
 170   return cmds;
 171 }
 172
 173 char *
 174 key2str(int key)
 175 {
 176   static char buf[32];
 177   int i;
 178
 179   buf[0] = 0;
 180   switch(key)
 181     {
 182     case 0:
 183       return _("Undefined");
 184     case ' ':
 185       return _("Space");
 186     case 13:
 187       return _("Enter");
 188     case BS:
 189       return _("Backspace");
 190     case DEL:
 191       return _("Delete");
 192     case UP:
 193       return _("Up");
 194     case DWN:
 195       return _("Down");
 196     case LEFT:
 197       return _("Left");
 198     case RGHT:
 199       return _("Right");
 200     case HOME:
 201       return _("Home");
 202     case END:
 203       return _("End");
 204     case PGDN:
 205       return _("PageDown");
 206     case PGUP:
 207       return _("PageUp");
 208     case TAB:
 209       return _("Tab");
 210     case STAB:
 211       return _("Shift+Tab");
 212     case ESC:
 213       return _("Esc");
 214     case KEY_IC:
 215       return _("Insert");
 216     default:
 217       for(i=0; i<=63; i++)
 218         if( key==KEY_F(i) )
 219           {
 220             snprintf(buf, 32, "F%d", i );
 221             return buf;
 222           }
 223       if( !(key & ~037) )
 224         snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 225       else if( (key & ~037) == 224 )
 226         snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 227       else if( key>32 &&  key<256 )
 228         snprintf(buf, 32, "%c", key);
 229       else
 230         snprintf(buf, 32, "0x%03X", key);
 231     }
 232   return buf;
 233 }
 234
 235 void
 236 command_dump_keys(void)
 237 {
 238   int i;
 239
 240   i=0;
 241   while( cmds[i].description )
 242     {
 243       if( cmds[i].command != CMD_NONE )
 244         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 245       i++;
 246     }
 247 }
 248
 249 char *
 250 get_key_names(command_t command, int all)
 251 {
 252   int i;
 253
 254   i=0;
 255   while( cmds[i].description )
 256     {
 257       if( cmds[i].command == command )
 258         {
 259           int j;
 260           static char keystr[80];
 261
 262           strncpy(keystr, key2str(cmds[i].keys[0]), 80);
 263           if( !all )
 264             return keystr;
 265           j=1;
 266           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 267             {
 268               strcat(keystr, " ");
 269               strcat(keystr, key2str(cmds[i].keys[j]));
 270               j++;
 271             }
 272           return keystr;
 273         }
 274       i++;
 275     }
 276   return NULL;
 277 }
 278
 279 char *
 280 get_key_description(command_t command)
 281 {
 282   int i;
 283
 284   i=0;
 285   while( cmds[i].description )
 286     {
 287       if( cmds[i].command == command )
 288         return _(cmds[i].description);
 289       i++;
 290     }
 291   return NULL;
 292 }
 293
 294 char *
 295 get_key_command_name(command_t command)
 296 {
 297   int i;
 298
 299   i=0;
 300   while( cmds[i].name )
 301     {
 302       if( cmds[i].command == command )
 303         return cmds[i].name;
 304       i++;
 305     }
 306   return NULL;
 307 }
 308
 309 command_t
 310 get_key_command_from_name(char *name)
 311 {
 312   int i;
 313
 314   i=0;
 315   while( cmds[i].name )
 316     {
 317       if( strcmp(name, cmds[i].name) == 0 )
 318         return cmds[i].command;
 319       i++;
 320     }
 321   return CMD_NONE;
 322 }
 323
 324
 325 command_t
 326 find_key_command(int key, command_definition_t *cmds)
 327 {
 328   int i;
 329
 330   i=0;
 331   while( cmds && cmds[i].name )
 332     {
 333       if( cmds[i].keys[0] == key ||
 334           cmds[i].keys[1] == key ||
 335           cmds[i].keys[2] == key )
 336         return cmds[i].command;
 337       i++;
 338     }
 339   return CMD_NONE;
 340 }
 341
 342 command_t
 343 get_key_command(int key)
 344 {
 345   return find_key_command(key, cmds);
 346 }
 347
 348
 349 command_t
 350 get_keyboard_command(void)
 351 {
 352   int key;
 353
 354   key = wgetch(stdscr);
 355
 356   if( key==KEY_RESIZE )
 357     screen_resize();
 358
 359   if( key==ERR )
 360     return CMD_NONE;
 361
 362   DK(fprintf(stderr, "key = 0x%02X\t", key));
 363
 364   return get_key_command(key);
 365 }
 366
 367 int
 368 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 369 {
 370  int i;
 371
 372   i=0;
 373   while( cmds[i].name )
 374     {
 375       if( cmds[i].command == command )
 376         {
 377           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 378           return 0;
 379         }
 380       i++;
 381     }
 382   return -1;
 383 }
 384
 385 int
 386 check_key_bindings(void)
 387 {
 388   int i;
 389   int retval = 0;
 390
 391   i=0;
 392   while( cmds[i].name )
 393     {
 394       int j;
 395       command_t cmd;
 396
 397       for(j=0; j<MAX_COMMAND_KEYS; j++)
 398         if( cmds[i].keys[j] &&
 399             (cmd=get_key_command(cmds[i].keys[j])) != cmds[i].command )
 400           {
 401             fprintf(stderr, _("Error: Key %s assigned to %s and %s !!!\n"),
 402                     key2str(cmds[i].keys[j]),
 403                     get_key_command_name(cmds[i].command),
 404                     get_key_command_name(cmd));
 405             retval = -1;
 406           }
 407       i++;
 408     }
 409   return retval;
 410 }
 411
 412 int
 413 write_key_bindings(FILE *f)
 414 {
 415   int i,j;
 416
 417   i=0;
 418   while( cmds[i].name && !ferror(f) )
 419     {
 420       fprintf(f, "# %s\n", cmds[i].description);
 421       fprintf(f, "key %s = ", cmds[i].name);
 422       for(j=0; j<MAX_COMMAND_KEYS; j++)
 423         {
 424           if( j && cmds[i].keys[j] )
 425             fprintf(f, ",  ");
 426           if( !j || cmds[i].keys[j] )
 427             {
 428               if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 429                                           isdigit(cmds[i].keys[j])) )
 430                 fprintf(f, "\'%c\'", cmds[i].keys[j]);
 431               else
 432                 fprintf(f, "%d", cmds[i].keys[j]);
 433             }
 434         }
 435       fprintf(f,"\n\n");
 436       i++;
 437     }
 438   return ferror(f);
 439 }