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 <signal.h>
  28 #include <ncurses.h>
  29
  30 #include "config.h"
  31 #include "ncmpc.h"
  32 #include "command.h"
  33
  34 #undef DEBUG_KEYS
  35
  36 #ifdef DEBUG_KEYS
  37 #define DK(x) x
  38 #else
  39 #define DK(x)
  40 #endif
  41
  42 extern void sigstop(void);
  43 extern void screen_resize(void);
  44
  45 #define BS   KEY_BACKSPACE
  46 #define DEL  KEY_DC
  47 #define UP   KEY_UP
  48 #define DWN  KEY_DOWN
  49 #define LEFT KEY_LEFT
  50 #define RGHT KEY_RIGHT
  51 #define HOME KEY_HOME
  52 #define END  KEY_END
  53 #define PGDN KEY_NPAGE
  54 #define PGUP KEY_PPAGE
  55 #define TAB  0x09
  56 #define STAB 0x161
  57 #define ESC  0x1B
  58 #define F1   KEY_F(1)
  59 #define F2   KEY_F(2)
  60 #define F3   KEY_F(3)
  61 #define F4   KEY_F(4)
  62 #define F5   KEY_F(5)
  63 #define F6   KEY_F(6)
  64 #define F7   KEY_F(7)
  65
  66
  67 static command_definition_t cmds[] =
  68 {
  69 #ifdef ENABLE_KEYDEF_SCREEN
  70   { {'K',   0,   0 }, 0, CMD_SCREEN_KEYDEF,    "screen-keyedit",
  71     N_("Key configuration screen") },
  72 #endif
  73   { { 'q', 'Q',  3 }, 0, CMD_QUIT,   "quit",
  74     N_("Quit") },
  75
  76   /* movment */
  77   { {  UP,  'k',   0 }, 0, CMD_LIST_PREVIOUS,      "up",
  78     N_("Move cursor up") },
  79   { { DWN,  'j',   0 }, 0, CMD_LIST_NEXT,          "down",
  80     N_("Move cursor down") },
  81   { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST,          "home",
  82     N_("Home ") },
  83   { { END,  0x05, 0 }, 0, CMD_LIST_LAST,           "end",
  84     N_("End ") },
  85   { { PGUP,   0,   0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
  86     N_("Page up") },
  87   { { PGDN,   0,   0 }, 0, CMD_LIST_NEXT_PAGE,     "pgdn",
  88     N_("Page down") },
  89
  90
  91   /* basic screens */
  92   { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP,      "screen-help",
  93     N_("Help screen") },
  94   { { '2', F2,  0 }, 0, CMD_SCREEN_PLAY,      "screen-playlist",
  95     N_("Playlist screen") },
  96   { { '3', F3,  0 }, 0, CMD_SCREEN_FILE,      "screen-browse",
  97     N_("Browse screen") },
  98
  99
 100   /* player commands */
 101   { {  13,   0,   0 }, 0, CMD_PLAY, "play",
 102     N_("Play/Enter directory") },
 103   { { 'P',   0,   0 }, 0, CMD_PAUSE,"pause",
 104     N_("Pause") },
 105   { { 's',  BS,   0 }, 0, CMD_STOP, "stop",
 106     N_("Stop") },
 107   { { '>',   0,   0 }, 0, CMD_TRACK_NEXT, "next",
 108     N_("Next track") },
 109   { { '<',   0,   0 }, 0, CMD_TRACK_PREVIOUS, "prev",
 110     N_("Previous track") },
 111   { { 'f',   0,   0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
 112     N_("Seek forward") },
 113   { { 'b',   0,   0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
 114     N_("Seek backward") },
 115   { { '+', RGHT,  0 }, 0, CMD_VOLUME_UP, "volume-up",
 116     N_("Increase volume") },
 117   { { '-', LEFT,  0 }, 0, CMD_VOLUME_DOWN, "volume-down",
 118     N_("Decrease volume") },
 119   { { ' ',   0,   0 }, 0, CMD_SELECT, "select",
 120     N_("Select/deselect song in playlist") },
 121   { { DEL,  'd',  0 }, 0, CMD_DELETE, "delete",
 122     N_("Delete song from playlist") },
 123   { { 'Z',   0,   0 }, 0, CMD_SHUFFLE, "shuffle",
 124     N_("Shuffle playlist") },
 125   { { 'c',   0,   0 }, 0, CMD_CLEAR, "clear",
 126     N_("Clear playlist") },
 127   { { 'r',   0,   0 }, 0, CMD_REPEAT, "repeat",
 128     N_("Toggle repeat mode") },
 129   { { 'z',   0,   0 }, 0, CMD_RANDOM, "random",
 130     N_("Toggle random mode") },
 131   { { 'x',   0,   0 }, 0, CMD_CROSSFADE, "crossfade",
 132     N_("Toggle crossfade mode") },
 133   { { 21,    0,   0 }, 0, CMD_DB_UPDATE,  "db-update",
 134     N_("Start a music database update") },
 135   { { 'S',   0,   0 }, 0, CMD_SAVE_PLAYLIST, "save",
 136     N_("Save playlist") },
 137   { { 'a',   0,   0 }, 0, CMD_ADD, "add",
 138     N_("Add url/file to playlist") },
 139
 140
 141   /* lists */
 142   { { 11,  0,   0 }, 0, CMD_LIST_MOVE_UP,     "move-up",
 143     N_("Move item up") },
 144   { { 10,  0,   0 }, 0, CMD_LIST_MOVE_DOWN,   "move-down",
 145     N_("Move item down") },
 146   { { 12,  0,   0 }, 0, CMD_SCREEN_UPDATE,    "update",
 147     N_("Update screen") },
 148
 149
 150   /* ncmpc options */
 151   { { 'w',   0,   0 }, 0, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
 152     N_("Toggle find mode") },
 153   { { 'U',   0,   0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 154     N_("Toggle auto center mode") },
 155
 156
 157   /* change screen */
 158   { { TAB,   0,   0 }, 0, CMD_SCREEN_NEXT,     "screen-next",
 159     N_("Next screen") },
 160   { { STAB,  0,   0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
 161     N_("Previous screen") },
 162
 163
 164   /* find */
 165   { { '/',   0,   0 }, 0, CMD_LIST_FIND,           "find",
 166     N_("Forward find") },
 167   { { 'n',   0,   0 }, 0, CMD_LIST_FIND_NEXT,      "find-next",
 168     N_("Forward find next") },
 169   { { '?',   0,   0 }, 0, CMD_LIST_RFIND,          "rfind",
 170     N_("Backward find") },
 171   { { 'p',   0,   0 }, 0, CMD_LIST_RFIND_NEXT,     "rfind-next",
 172     N_("Backward find previous") },
 173
 174
 175   /* extra screens */
 176 #ifdef ENABLE_ARTIST_SCREEN
 177   { {'4',  F4,   0 }, 0, CMD_SCREEN_ARTIST,    "screen-artist",
 178     N_("Artist screen") },
 179 #endif
 180 #ifdef ENABLE_SEARCH_SCREEN
 181   { {'5',  F5,   0 }, 0, CMD_SCREEN_SEARCH,    "screen-search",
 182     N_("Search screen") },
 183   { {'m',   0,   0 }, 0, CMD_SEARCH_MODE,      "search-mode",
 184     N_("Change search mode") },
 185 #endif
 186
 187 #ifdef ENABLE_CLOCK_SCREEN
 188   { {'6',  F6,   0 }, 0, CMD_SCREEN_CLOCK,    "screen-clock",
 189     N_("Clock screen") },
 190 #endif
 191 #ifdef ENABLE_LYRICS_SCREEN
 192   { {'7',  F7,   0 }, 0, CMD_SCREEN_LYRICS,    "screen-lyrics",
 193     N_("Lyrics screen") },
 194   { {ESC,  0,   0 }, 0, CMD_INTERRUPT,    "screen-lyrics",
 195     N_("Interrupt action") },
 196 #endif
 197
 198
 199   { { -1,  -1,  -1 }, 0, CMD_NONE, NULL, NULL }
 200 };
 201
 202 command_definition_t *
 203 get_command_definitions(void)
 204 {
 205   return cmds;
 206 }
 207
 208 char *
 209 key2str(int key)
 210 {
 211   static char buf[32];
 212   int i;
 213
 214   buf[0] = 0;
 215   switch(key)
 216     {
 217     case 0:
 218       return _("Undefined");
 219     case ' ':
 220       return _("Space");
 221     case 13:
 222       return _("Enter");
 223     case BS:
 224       return _("Backspace");
 225     case DEL:
 226       return _("Delete");
 227     case UP:
 228       return _("Up");
 229     case DWN:
 230       return _("Down");
 231     case LEFT:
 232       return _("Left");
 233     case RGHT:
 234       return _("Right");
 235     case HOME:
 236       return _("Home");
 237     case END:
 238       return _("End");
 239     case PGDN:
 240       return _("PageDown");
 241     case PGUP:
 242       return _("PageUp");
 243     case TAB:
 244       return _("Tab");
 245     case STAB:
 246       return _("Shift+Tab");
 247     case ESC:
 248       return _("Esc");
 249     case KEY_IC:
 250       return _("Insert");
 251     default:
 252       for(i=0; i<=63; i++)
 253         if( key==KEY_F(i) )
 254           {
 255             g_snprintf(buf, 32, "F%d", i );
 256             return buf;
 257           }
 258       if( !(key & ~037) )
 259         g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 260       else if( (key & ~037) == 224 )
 261         g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 262       else if( key>32 &&  key<256 )
 263         g_snprintf(buf, 32, "%c", key);
 264       else
 265         g_snprintf(buf, 32, "0x%03X", key);
 266     }
 267   return buf;
 268 }
 269
 270 void
 271 command_dump_keys(void)
 272 {
 273   int i;
 274
 275   i=0;
 276   while( cmds[i].description )
 277     {
 278       if( cmds[i].command != CMD_NONE )
 279         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 280       i++;
 281     }
 282 }
 283
 284 int
 285 set_key_flags(command_definition_t *cp, command_t command, int flags)
 286 {
 287   int i;
 288
 289   i=0;
 290   while( cp[i].name )
 291     {
 292       if( cp[i].command == command )
 293         {
 294           cp[i].flags |= flags;
 295           return 0;
 296         }
 297       i++;
 298     }
 299   return 1;
 300 }
 301
 302 char *
 303 get_key_names(command_t command, int all)
 304 {
 305   int i;
 306
 307   i=0;
 308   while( cmds[i].description )
 309     {
 310       if( cmds[i].command == command )
 311         {
 312           int j;
 313           static char keystr[80];
 314
 315           g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
 316           if( !all )
 317             return keystr;
 318           j=1;
 319           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 320             {
 321               g_strlcat(keystr, " ", sizeof(keystr));
 322               g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
 323               j++;
 324             }
 325           return keystr;
 326         }
 327       i++;
 328     }
 329   return NULL;
 330 }
 331
 332 char *
 333 get_key_description(command_t command)
 334 {
 335   int i;
 336
 337   i=0;
 338   while( cmds[i].description )
 339     {
 340       if( cmds[i].command == command )
 341         return _(cmds[i].description);
 342       i++;
 343     }
 344   return NULL;
 345 }
 346
 347 char *
 348 get_key_command_name(command_t command)
 349 {
 350   int i;
 351
 352   i=0;
 353   while( cmds[i].name )
 354     {
 355       if( cmds[i].command == command )
 356         return cmds[i].name;
 357       i++;
 358     }
 359   return NULL;
 360 }
 361
 362 command_t
 363 get_key_command_from_name(char *name)
 364 {
 365   int i;
 366
 367   i=0;
 368   while( cmds[i].name )
 369     {
 370       if( strcmp(name, cmds[i].name) == 0 )
 371         return cmds[i].command;
 372       i++;
 373     }
 374   return CMD_NONE;
 375 }
 376
 377
 378 command_t
 379 find_key_command(int key, command_definition_t *cmds)
 380 {
 381   int i;
 382
 383   i=0;
 384   while( key && cmds && cmds[i].name )
 385     {
 386       if( cmds[i].keys[0] == key ||
 387           cmds[i].keys[1] == key ||
 388           cmds[i].keys[2] == key )
 389         return cmds[i].command;
 390       i++;
 391     }
 392   return CMD_NONE;
 393 }
 394
 395 command_t
 396 get_key_command(int key)
 397 {
 398   return find_key_command(key, cmds);
 399 }
 400
 401 int
 402 my_wgetch(WINDOW *w)
 403 {
 404   int c;
 405
 406   c = wgetch(w);
 407
 408   /* handle resize event */
 409   if( c==KEY_RESIZE )
 410     screen_resize();
 411
 412 #ifdef ENABLE_RAW_MODE
 413   /* handle SIGSTOP (Ctrl-Z) */
 414   if( c==26 || c==407 )
 415     sigstop();
 416   /* handle SIGINT (Ctrl-C) */
 417   if( c==3 )
 418     exit(EXIT_SUCCESS);
 419 #endif
 420
 421   return c;
 422 }
 423
 424 command_t
 425 get_keyboard_command_with_timeout(int ms)
 426 {
 427   int key;
 428
 429   if( ms != SCREEN_TIMEOUT)
 430     timeout(ms);
 431   key = my_wgetch(stdscr);
 432   if( ms != SCREEN_TIMEOUT)
 433     timeout(SCREEN_TIMEOUT);
 434
 435   if( key==ERR )
 436     return CMD_NONE;
 437
 438 #ifdef HAVE_GETMOUSE
 439   if( key==KEY_MOUSE )
 440     return CMD_MOUSE_EVENT;
 441 #endif
 442
 443   return get_key_command(key);
 444 }
 445
 446 command_t
 447 get_keyboard_command(void)
 448 {
 449   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 450 }
 451
 452 int
 453 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 454 {
 455  int i;
 456
 457   i=0;
 458   while( cmds[i].name )
 459     {
 460       if( cmds[i].command == command )
 461         {
 462           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 463           cmds[i].flags |= COMMAND_KEY_MODIFIED;
 464           return 0;
 465         }
 466       i++;
 467     }
 468   return -1;
 469 }
 470
 471 int
 472 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 473 {
 474   int i;
 475   int retval = 0;
 476
 477   if( cp==NULL )
 478     cp = cmds;
 479
 480   i=0;
 481   while( cp[i].name )
 482     {
 483       cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 484       i++;
 485     }
 486
 487   i=0;
 488   while( cp[i].name )
 489     {
 490       int j;
 491       command_t cmd;
 492
 493       for(j=0; j<MAX_COMMAND_KEYS; j++)
 494         if( cp[i].keys[j] &&
 495             (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
 496           {
 497             if( buf )
 498 #ifdef ENABLE_KEYDEF_SCREEN
 499               g_snprintf(buf, bufsize,
 500                          _("Key %s assigned to %s and %s (press %s for the key editor)"),
 501                          key2str(cp[i].keys[j]),
 502                          get_key_command_name(cp[i].command),
 503                          get_key_command_name(cmd),
 504                          get_key_names(CMD_SCREEN_KEYDEF,0));
 505 #else
 506             g_snprintf(buf, bufsize,
 507                        _("Error: Key %s assigned to %s and %s !!!\n"),
 508                        key2str(cp[i].keys[j]),
 509                        get_key_command_name(cp[i].command),
 510                        get_key_command_name(cmd));
 511 #endif
 512             else
 513               fprintf(stderr,
 514                       _("Error: Key %s assigned to %s and %s !!!\n"),
 515                       key2str(cp[i].keys[j]),
 516                       get_key_command_name(cp[i].command),
 517                       get_key_command_name(cmd));
 518             cp[i].flags |= COMMAND_KEY_CONFLICT;
 519             set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 520             retval = -1;
 521           }
 522       i++;
 523     }
 524   return retval;
 525 }
 526
 527 int
 528 write_key_bindings(FILE *f, int flags)
 529 {
 530   int i,j;
 531
 532   if( flags & KEYDEF_WRITE_HEADER )
 533     fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
 534
 535   i=0;
 536   while( cmds[i].name && !ferror(f) )
 537     {
 538       if( cmds[i].flags & COMMAND_KEY_MODIFIED || flags & KEYDEF_WRITE_ALL)
 539         {
 540           fprintf(f, "## %s\n", cmds[i].description);
 541           if( flags & KEYDEF_COMMENT_ALL )
 542             fprintf(f, "#");
 543           fprintf(f, "key %s = ", cmds[i].name);
 544           for(j=0; j<MAX_COMMAND_KEYS; j++)
 545             {
 546               if( j && cmds[i].keys[j] )
 547                 fprintf(f, ",  ");
 548               if( !j || cmds[i].keys[j] )
 549                 {
 550                   if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 551                                               isdigit(cmds[i].keys[j])) )
 552                     fprintf(f, "\'%c\'", cmds[i].keys[j]);
 553                   else
 554                     fprintf(f, "%d", cmds[i].keys[j]);
 555                 }
 556             }
 557           fprintf(f,"\n\n");
 558         }
 559       i++;
 560     }
 561   return ferror(f);
 562 }