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   { { ' ',   0,   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   { { 'a',   0,   0 }, CMD_ADD, "add",
 111     N_("Add url/file to playlist") },
 112
 113   { { 0,  0,   0 }, CMD_LIST_MOVE_UP,     "move-up",
 114     N_("Move item up") },
 115   { { 0,  0,   0 }, CMD_LIST_MOVE_DOWN,   "move-down",
 116     N_("Move item down") },
 117
 118   { {  UP,  ',',   0 }, CMD_LIST_PREVIOUS,      "up",
 119     N_("Move cursor up") },
 120   { { DWN,  '.',   0 }, CMD_LIST_NEXT,          "down",
 121     N_("Move cursor down") },
 122   { { HOME, 0x01, 0 }, CMD_LIST_FIRST,          "home",
 123     N_("Home ") },
 124   { { END,  0x05, 0 }, CMD_LIST_LAST,           "end",
 125     N_("End ") },
 126   { { PGUP, 'A',   0 }, CMD_LIST_PREVIOUS_PAGE, "pgup",
 127     N_("Page up") },
 128   { { PGDN, 'B',   0 }, CMD_LIST_NEXT_PAGE,     "pgdn",
 129     N_("Page down") },
 130   { { '/',   0,   0 }, CMD_LIST_FIND,           "find",
 131     N_("Forward find") },
 132   { { 'n',   0,   0 }, CMD_LIST_FIND_NEXT,      "find-next",
 133     N_("Forward find next") },
 134   { { '?',   0,   0 }, CMD_LIST_RFIND,          "rfind",
 135     N_("Backward find") },
 136   { { 'p',   0,   0 }, CMD_LIST_RFIND_NEXT,     "rfind-next",
 137     N_("Backward find previous") },
 138
 139
 140   { { TAB,   0,   0 }, CMD_SCREEN_NEXT,     "screen-next",
 141     N_("Next screen") },
 142
 143   { { STAB,  0,   0 }, CMD_SCREEN_PREVIOUS, "screen-prev",
 144     N_("Previous screen") },
 145
 146   { { '1', F1, 'h' }, CMD_SCREEN_HELP,      "screen-help",
 147     N_("Help screen") },
 148   { { '2', F2,  0 }, CMD_SCREEN_PLAY,      "screen-playlist",
 149     N_("Playlist screen") },
 150   { { '3', F3,  0 }, CMD_SCREEN_FILE,      "screen-browse",
 151     N_("Browse screen") },
 152   { {'u',   0,   0 }, CMD_SCREEN_UPDATE,    "update",
 153     N_("Update screen") },
 154 #ifdef ENABLE_CLOCK_SCREEN
 155   { {'4',  F4,   0 }, CMD_SCREEN_CLOCK,    "screen-clock",
 156     N_("Clock screen") },
 157 #endif
 158 #ifdef ENABLE_KEYDEF_SCREEN
 159   { {'K',   0,   0 }, CMD_SCREEN_KEYDEF,    "screen-keyedit",
 160     N_("Key configuration screen") },
 161 #endif
 162
 163   { { 'q', 'Q',  3 }, CMD_QUIT,   "quit",
 164     N_("Quit") },
 165
 166   { { -1,  -1,  -1 }, CMD_NONE, NULL, NULL }
 167 };
 168
 169 command_definition_t *
 170 get_command_definitions(void)
 171 {
 172   return cmds;
 173 }
 174
 175 char *
 176 key2str(int key)
 177 {
 178   static char buf[32];
 179   int i;
 180
 181   buf[0] = 0;
 182   switch(key)
 183     {
 184     case 0:
 185       return _("Undefined");
 186     case ' ':
 187       return _("Space");
 188     case 13:
 189       return _("Enter");
 190     case BS:
 191       return _("Backspace");
 192     case DEL:
 193       return _("Delete");
 194     case UP:
 195       return _("Up");
 196     case DWN:
 197       return _("Down");
 198     case LEFT:
 199       return _("Left");
 200     case RGHT:
 201       return _("Right");
 202     case HOME:
 203       return _("Home");
 204     case END:
 205       return _("End");
 206     case PGDN:
 207       return _("PageDown");
 208     case PGUP:
 209       return _("PageUp");
 210     case TAB:
 211       return _("Tab");
 212     case STAB:
 213       return _("Shift+Tab");
 214     case ESC:
 215       return _("Esc");
 216     case KEY_IC:
 217       return _("Insert");
 218     default:
 219       for(i=0; i<=63; i++)
 220         if( key==KEY_F(i) )
 221           {
 222             snprintf(buf, 32, "F%d", i );
 223             return buf;
 224           }
 225       if( !(key & ~037) )
 226         snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 227       else if( (key & ~037) == 224 )
 228         snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 229       else if( key>32 &&  key<256 )
 230         snprintf(buf, 32, "%c", key);
 231       else
 232         snprintf(buf, 32, "0x%03X", key);
 233     }
 234   return buf;
 235 }
 236
 237 void
 238 command_dump_keys(void)
 239 {
 240   int i;
 241
 242   i=0;
 243   while( cmds[i].description )
 244     {
 245       if( cmds[i].command != CMD_NONE )
 246         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 247       i++;
 248     }
 249 }
 250
 251 char *
 252 get_key_names(command_t command, int all)
 253 {
 254   int i;
 255
 256   i=0;
 257   while( cmds[i].description )
 258     {
 259       if( cmds[i].command == command )
 260         {
 261           int j;
 262           static char keystr[80];
 263
 264           strncpy(keystr, key2str(cmds[i].keys[0]), 80);
 265           if( !all )
 266             return keystr;
 267           j=1;
 268           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 269             {
 270               strcat(keystr, " ");
 271               strcat(keystr, key2str(cmds[i].keys[j]));
 272               j++;
 273             }
 274           return keystr;
 275         }
 276       i++;
 277     }
 278   return NULL;
 279 }
 280
 281 char *
 282 get_key_description(command_t command)
 283 {
 284   int i;
 285
 286   i=0;
 287   while( cmds[i].description )
 288     {
 289       if( cmds[i].command == command )
 290         return _(cmds[i].description);
 291       i++;
 292     }
 293   return NULL;
 294 }
 295
 296 char *
 297 get_key_command_name(command_t command)
 298 {
 299   int i;
 300
 301   i=0;
 302   while( cmds[i].name )
 303     {
 304       if( cmds[i].command == command )
 305         return cmds[i].name;
 306       i++;
 307     }
 308   return NULL;
 309 }
 310
 311 command_t
 312 get_key_command_from_name(char *name)
 313 {
 314   int i;
 315
 316   i=0;
 317   while( cmds[i].name )
 318     {
 319       if( strcmp(name, cmds[i].name) == 0 )
 320         return cmds[i].command;
 321       i++;
 322     }
 323   return CMD_NONE;
 324 }
 325
 326
 327 command_t
 328 find_key_command(int key, command_definition_t *cmds)
 329 {
 330   int i;
 331
 332   i=0;
 333   while( cmds && cmds[i].name )
 334     {
 335       if( cmds[i].keys[0] == key ||
 336           cmds[i].keys[1] == key ||
 337           cmds[i].keys[2] == key )
 338         return cmds[i].command;
 339       i++;
 340     }
 341   return CMD_NONE;
 342 }
 343
 344 command_t
 345 get_key_command(int key)
 346 {
 347   return find_key_command(key, cmds);
 348 }
 349
 350 command_t
 351 get_keyboard_command_with_timeout(int ms)
 352 {
 353   int key;
 354
 355   if( ms != SCREEN_TIMEOUT)
 356     timeout(ms);
 357   key = wgetch(stdscr);
 358   if( ms != SCREEN_TIMEOUT)
 359     timeout(SCREEN_TIMEOUT);
 360
 361   if( key==KEY_RESIZE )
 362     screen_resize();
 363
 364   if( key==ERR )
 365     return CMD_NONE;
 366
 367   return get_key_command(key);
 368 }
 369
 370 command_t
 371 get_keyboard_command(void)
 372 {
 373   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 374 }
 375
 376 int
 377 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 378 {
 379  int i;
 380
 381   i=0;
 382   while( cmds[i].name )
 383     {
 384       if( cmds[i].command == command )
 385         {
 386           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 387           return 0;
 388         }
 389       i++;
 390     }
 391   return -1;
 392 }
 393
 394 int
 395 check_key_bindings(void)
 396 {
 397   int i;
 398   int retval = 0;
 399
 400   i=0;
 401   while( cmds[i].name )
 402     {
 403       int j;
 404       command_t cmd;
 405
 406       for(j=0; j<MAX_COMMAND_KEYS; j++)
 407         if( cmds[i].keys[j] &&
 408             (cmd=get_key_command(cmds[i].keys[j])) != cmds[i].command )
 409           {
 410             fprintf(stderr, _("Error: Key %s assigned to %s and %s !!!\n"),
 411                     key2str(cmds[i].keys[j]),
 412                     get_key_command_name(cmds[i].command),
 413                     get_key_command_name(cmd));
 414             retval = -1;
 415           }
 416       i++;
 417     }
 418   return retval;
 419 }
 420
 421 int
 422 write_key_bindings(FILE *f)
 423 {
 424   int i,j;
 425
 426   i=0;
 427   while( cmds[i].name && !ferror(f) )
 428     {
 429       fprintf(f, "# %s\n", cmds[i].description);
 430       fprintf(f, "key %s = ", cmds[i].name);
 431       for(j=0; j<MAX_COMMAND_KEYS; j++)
 432         {
 433           if( j && cmds[i].keys[j] )
 434             fprintf(f, ",  ");
 435           if( !j || cmds[i].keys[j] )
 436             {
 437               if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 438                                           isdigit(cmds[i].keys[j])) )
 439                 fprintf(f, "\'%c\'", cmds[i].keys[j]);
 440               else
 441                 fprintf(f, "%d", cmds[i].keys[j]);
 442             }
 443         }
 444       fprintf(f,"\n\n");
 445       i++;
 446     }
 447   return ferror(f);
 448 }