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   { { 't',   0,   0 }, 0, CMD_SELECT_ALL, "select_all",
 122     N_("Select all listed items") },
 123   { { DEL,  'd',  0 }, 0, CMD_DELETE, "delete",
 124     N_("Delete song from playlist") },
 125   { { 'Z',   0,   0 }, 0, CMD_SHUFFLE, "shuffle",
 126     N_("Shuffle playlist") },
 127   { { 'c',   0,   0 }, 0, CMD_CLEAR, "clear",
 128     N_("Clear playlist") },
 129   { { 'r',   0,   0 }, 0, CMD_REPEAT, "repeat",
 130     N_("Toggle repeat mode") },
 131   { { 'z',   0,   0 }, 0, CMD_RANDOM, "random",
 132     N_("Toggle random mode") },
 133   { { 'x',   0,   0 }, 0, CMD_CROSSFADE, "crossfade",
 134     N_("Toggle crossfade mode") },
 135   { { 21,    0,   0 }, 0, CMD_DB_UPDATE,  "db-update",
 136     N_("Start a music database update") },
 137   { { 'S',   0,   0 }, 0, CMD_SAVE_PLAYLIST, "save",
 138     N_("Save playlist") },
 139   { { 'a',   0,   0 }, 0, CMD_ADD, "add",
 140     N_("Add url/file to playlist") },
 141
 142   { { '!',   0,   0 }, 0, CMD_GO_ROOT_DIRECTORY, "go-root-directory",
 143     N_("Go to root directory") },
 144   { { '"',   0,   0 }, 0, CMD_GO_PARENT_DIRECTORY, "go-parent-directory",
 145     N_("Go to parent directory") },
 146
 147   /* lists */
 148   { { 11,  0,   0 }, 0, CMD_LIST_MOVE_UP,     "move-up",
 149     N_("Move item up") },
 150   { { 10,  0,   0 }, 0, CMD_LIST_MOVE_DOWN,   "move-down",
 151     N_("Move item down") },
 152   { { 12,  0,   0 }, 0, CMD_SCREEN_UPDATE,    "update",
 153     N_("Update screen") },
 154
 155
 156   /* ncmpc options */
 157   { { 'w',   0,   0 }, 0, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
 158     N_("Toggle find mode") },
 159   { { 'U',   0,   0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 160     N_("Toggle auto center mode") },
 161
 162
 163   /* change screen */
 164   { { TAB,   0,   0 }, 0, CMD_SCREEN_NEXT,     "screen-next",
 165     N_("Next screen") },
 166   { { STAB,  0,   0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
 167     N_("Previous screen") },
 168
 169
 170   /* find */
 171   { { '/',   0,   0 }, 0, CMD_LIST_FIND,           "find",
 172     N_("Forward find") },
 173   { { 'n',   0,   0 }, 0, CMD_LIST_FIND_NEXT,      "find-next",
 174     N_("Forward find next") },
 175   { { '?',   0,   0 }, 0, CMD_LIST_RFIND,          "rfind",
 176     N_("Backward find") },
 177   { { 'p',   0,   0 }, 0, CMD_LIST_RFIND_NEXT,     "rfind-next",
 178     N_("Backward find previous") },
 179
 180
 181   /* extra screens */
 182 #ifdef ENABLE_ARTIST_SCREEN
 183   { {'4',  F4,   0 }, 0, CMD_SCREEN_ARTIST,    "screen-artist",
 184     N_("Artist screen") },
 185 #endif
 186 #ifdef ENABLE_SEARCH_SCREEN
 187   { {'5',  F5,   0 }, 0, CMD_SCREEN_SEARCH,    "screen-search",
 188     N_("Search screen") },
 189   { {'m',   0,   0 }, 0, CMD_SEARCH_MODE,      "search-mode",
 190     N_("Change search mode") },
 191 #endif
 192
 193 #ifdef ENABLE_CLOCK_SCREEN
 194   { {'6',  F6,   0 }, 0, CMD_SCREEN_CLOCK,    "screen-clock",
 195     N_("Clock screen") },
 196 #endif
 197 #ifdef ENABLE_LYRICS_SCREEN
 198   { {'7',  F7,   0 }, 0, CMD_SCREEN_LYRICS,    "screen-lyrics",
 199     N_("Lyrics screen") },
 200   { {ESC,  0,   0 }, 0, CMD_INTERRUPT,    "lyrics-interrupt",
 201     N_("Interrupt action") },
 202   { {'u',  0,   0 }, 0, CMD_LYRICS_UPDATE,    "lyrics-update",
 203     N_("Update Lyrics") },
 204 #endif
 205
 206
 207   { { -1,  -1,  -1 }, 0, CMD_NONE, NULL, NULL }
 208 };
 209
 210 command_definition_t *
 211 get_command_definitions(void)
 212 {
 213   return cmds;
 214 }
 215
 216 char *
 217 key2str(int key)
 218 {
 219   static char buf[32];
 220   int i;
 221
 222   buf[0] = 0;
 223   switch(key)
 224     {
 225     case 0:
 226       return _("Undefined");
 227     case ' ':
 228       return _("Space");
 229     case 13:
 230       return _("Enter");
 231     case BS:
 232       return _("Backspace");
 233     case DEL:
 234       return _("Delete");
 235     case UP:
 236       return _("Up");
 237     case DWN:
 238       return _("Down");
 239     case LEFT:
 240       return _("Left");
 241     case RGHT:
 242       return _("Right");
 243     case HOME:
 244       return _("Home");
 245     case END:
 246       return _("End");
 247     case PGDN:
 248       return _("PageDown");
 249     case PGUP:
 250       return _("PageUp");
 251     case TAB:
 252       return _("Tab");
 253     case STAB:
 254       return _("Shift+Tab");
 255     case ESC:
 256       return _("Esc");
 257     case KEY_IC:
 258       return _("Insert");
 259     default:
 260       for(i=0; i<=63; i++)
 261         if( key==KEY_F(i) )
 262           {
 263             g_snprintf(buf, 32, "F%d", i );
 264             return buf;
 265           }
 266       if( !(key & ~037) )
 267         g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 268       else if( (key & ~037) == 224 )
 269         g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 270       else if( key>32 &&  key<256 )
 271         g_snprintf(buf, 32, "%c", key);
 272       else
 273         g_snprintf(buf, 32, "0x%03X", key);
 274     }
 275   return buf;
 276 }
 277
 278 void
 279 command_dump_keys(void)
 280 {
 281   int i;
 282
 283   i=0;
 284   while( cmds[i].description )
 285     {
 286       if( cmds[i].command != CMD_NONE )
 287         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 288       i++;
 289     }
 290 }
 291
 292 int
 293 set_key_flags(command_definition_t *cp, command_t command, int flags)
 294 {
 295   int i;
 296
 297   i=0;
 298   while( cp[i].name )
 299     {
 300       if( cp[i].command == command )
 301         {
 302           cp[i].flags |= flags;
 303           return 0;
 304         }
 305       i++;
 306     }
 307   return 1;
 308 }
 309
 310 char *
 311 get_key_names(command_t command, int all)
 312 {
 313   int i;
 314
 315   i=0;
 316   while( cmds[i].description )
 317     {
 318       if( cmds[i].command == command )
 319         {
 320           int j;
 321           static char keystr[80];
 322
 323           g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
 324           if( !all )
 325             return keystr;
 326           j=1;
 327           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 328             {
 329               g_strlcat(keystr, " ", sizeof(keystr));
 330               g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
 331               j++;
 332             }
 333           return keystr;
 334         }
 335       i++;
 336     }
 337   return NULL;
 338 }
 339
 340 char *
 341 get_key_description(command_t command)
 342 {
 343   int i;
 344
 345   i=0;
 346   while( cmds[i].description )
 347     {
 348       if( cmds[i].command == command )
 349         return _(cmds[i].description);
 350       i++;
 351     }
 352   return NULL;
 353 }
 354
 355 char *
 356 get_key_command_name(command_t command)
 357 {
 358   int i;
 359
 360   i=0;
 361   while( cmds[i].name )
 362     {
 363       if( cmds[i].command == command )
 364         return cmds[i].name;
 365       i++;
 366     }
 367   return NULL;
 368 }
 369
 370 command_t
 371 get_key_command_from_name(char *name)
 372 {
 373   int i;
 374
 375   i=0;
 376   while( cmds[i].name )
 377     {
 378       if( strcmp(name, cmds[i].name) == 0 )
 379         return cmds[i].command;
 380       i++;
 381     }
 382   return CMD_NONE;
 383 }
 384
 385
 386 command_t
 387 find_key_command(int key, command_definition_t *cmds)
 388 {
 389   int i;
 390
 391   i=0;
 392   while( key && cmds && cmds[i].name )
 393     {
 394       if( cmds[i].keys[0] == key ||
 395           cmds[i].keys[1] == key ||
 396           cmds[i].keys[2] == key )
 397         return cmds[i].command;
 398       i++;
 399     }
 400   return CMD_NONE;
 401 }
 402
 403 command_t
 404 get_key_command(int key)
 405 {
 406   return find_key_command(key, cmds);
 407 }
 408
 409 int
 410 my_wgetch(WINDOW *w)
 411 {
 412   int c;
 413
 414   c = wgetch(w);
 415
 416   /* handle resize event */
 417   if( c==KEY_RESIZE )
 418     screen_resize();
 419
 420 #ifdef ENABLE_RAW_MODE
 421   /* handle SIGSTOP (Ctrl-Z) */
 422   if( c==26 || c==407 )
 423     sigstop();
 424   /* handle SIGINT (Ctrl-C) */
 425   if( c==3 )
 426     exit(EXIT_SUCCESS);
 427 #endif
 428
 429   return c;
 430 }
 431
 432 command_t
 433 get_keyboard_command_with_timeout(int ms)
 434 {
 435   int key;
 436
 437   if( ms != SCREEN_TIMEOUT)
 438     timeout(ms);
 439   key = my_wgetch(stdscr);
 440   if( ms != SCREEN_TIMEOUT)
 441     timeout(SCREEN_TIMEOUT);
 442
 443   if( key==ERR )
 444     return CMD_NONE;
 445
 446 #ifdef HAVE_GETMOUSE
 447   if( key==KEY_MOUSE )
 448     return CMD_MOUSE_EVENT;
 449 #endif
 450
 451   return get_key_command(key);
 452 }
 453
 454 command_t
 455 get_keyboard_command(void)
 456 {
 457   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 458 }
 459
 460 int
 461 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 462 {
 463  int i;
 464
 465   i=0;
 466   while( cmds[i].name )
 467     {
 468       if( cmds[i].command == command )
 469         {
 470           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 471           cmds[i].flags |= COMMAND_KEY_MODIFIED;
 472           return 0;
 473         }
 474       i++;
 475     }
 476   return -1;
 477 }
 478
 479 int
 480 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 481 {
 482   int i;
 483   int retval = 0;
 484
 485   if( cp==NULL )
 486     cp = cmds;
 487
 488   i=0;
 489   while( cp[i].name )
 490     {
 491       cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 492       i++;
 493     }
 494
 495   i=0;
 496   while( cp[i].name )
 497     {
 498       int j;
 499       command_t cmd;
 500
 501       for(j=0; j<MAX_COMMAND_KEYS; j++)
 502         if( cp[i].keys[j] &&
 503             (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
 504           {
 505             if( buf )
 506 #ifdef ENABLE_KEYDEF_SCREEN
 507               g_snprintf(buf, bufsize,
 508                          _("Key %s assigned to %s and %s (press %s for the key editor)"),
 509                          key2str(cp[i].keys[j]),
 510                          get_key_command_name(cp[i].command),
 511                          get_key_command_name(cmd),
 512                          get_key_names(CMD_SCREEN_KEYDEF,0));
 513 #else
 514             g_snprintf(buf, bufsize,
 515                        _("Error: Key %s assigned to %s and %s !!!\n"),
 516                        key2str(cp[i].keys[j]),
 517                        get_key_command_name(cp[i].command),
 518                        get_key_command_name(cmd));
 519 #endif
 520             else
 521               fprintf(stderr,
 522                       _("Error: Key %s assigned to %s and %s !!!\n"),
 523                       key2str(cp[i].keys[j]),
 524                       get_key_command_name(cp[i].command),
 525                       get_key_command_name(cmd));
 526             cp[i].flags |= COMMAND_KEY_CONFLICT;
 527             set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 528             retval = -1;
 529           }
 530       i++;
 531     }
 532   return retval;
 533 }
 534
 535 int
 536 write_key_bindings(FILE *f, int flags)
 537 {
 538   int i,j;
 539
 540   if( flags & KEYDEF_WRITE_HEADER )
 541     fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
 542
 543   i=0;
 544   while( cmds[i].name && !ferror(f) )
 545     {
 546       if( cmds[i].flags & COMMAND_KEY_MODIFIED || flags & KEYDEF_WRITE_ALL)
 547         {
 548           fprintf(f, "## %s\n", cmds[i].description);
 549           if( flags & KEYDEF_COMMENT_ALL )
 550             fprintf(f, "#");
 551           fprintf(f, "key %s = ", cmds[i].name);
 552           for(j=0; j<MAX_COMMAND_KEYS; j++)
 553             {
 554               if( j && cmds[i].keys[j] )
 555                 fprintf(f, ",  ");
 556               if( !j || cmds[i].keys[j] )
 557                 {
 558                   if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 559                                               isdigit(cmds[i].keys[j])) )
 560                     fprintf(f, "\'%c\'", cmds[i].keys[j]);
 561                   else
 562                     fprintf(f, "%d", cmds[i].keys[j]);
 563                 }
 564             }
 565           fprintf(f,"\n\n");
 566         }
 567       i++;
 568     }
 569   return ferror(f);
 570 }