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 #endif
 195
 196
 197   { { -1,  -1,  -1 }, 0, CMD_NONE, NULL, NULL }
 198 };
 199
 200 command_definition_t *
 201 get_command_definitions(void)
 202 {
 203   return cmds;
 204 }
 205
 206 char *
 207 key2str(int key)
 208 {
 209   static char buf[32];
 210   int i;
 211
 212   buf[0] = 0;
 213   switch(key)
 214     {
 215     case 0:
 216       return _("Undefined");
 217     case ' ':
 218       return _("Space");
 219     case 13:
 220       return _("Enter");
 221     case BS:
 222       return _("Backspace");
 223     case DEL:
 224       return _("Delete");
 225     case UP:
 226       return _("Up");
 227     case DWN:
 228       return _("Down");
 229     case LEFT:
 230       return _("Left");
 231     case RGHT:
 232       return _("Right");
 233     case HOME:
 234       return _("Home");
 235     case END:
 236       return _("End");
 237     case PGDN:
 238       return _("PageDown");
 239     case PGUP:
 240       return _("PageUp");
 241     case TAB:
 242       return _("Tab");
 243     case STAB:
 244       return _("Shift+Tab");
 245     case ESC:
 246       return _("Esc");
 247     case KEY_IC:
 248       return _("Insert");
 249     default:
 250       for(i=0; i<=63; i++)
 251         if( key==KEY_F(i) )
 252           {
 253             g_snprintf(buf, 32, "F%d", i );
 254             return buf;
 255           }
 256       if( !(key & ~037) )
 257         g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 258       else if( (key & ~037) == 224 )
 259         g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 260       else if( key>32 &&  key<256 )
 261         g_snprintf(buf, 32, "%c", key);
 262       else
 263         g_snprintf(buf, 32, "0x%03X", key);
 264     }
 265   return buf;
 266 }
 267
 268 void
 269 command_dump_keys(void)
 270 {
 271   int i;
 272
 273   i=0;
 274   while( cmds[i].description )
 275     {
 276       if( cmds[i].command != CMD_NONE )
 277         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 278       i++;
 279     }
 280 }
 281
 282 int
 283 set_key_flags(command_definition_t *cp, command_t command, int flags)
 284 {
 285   int i;
 286
 287   i=0;
 288   while( cp[i].name )
 289     {
 290       if( cp[i].command == command )
 291         {
 292           cp[i].flags |= flags;
 293           return 0;
 294         }
 295       i++;
 296     }
 297   return 1;
 298 }
 299
 300 char *
 301 get_key_names(command_t command, int all)
 302 {
 303   int i;
 304
 305   i=0;
 306   while( cmds[i].description )
 307     {
 308       if( cmds[i].command == command )
 309         {
 310           int j;
 311           static char keystr[80];
 312
 313           g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
 314           if( !all )
 315             return keystr;
 316           j=1;
 317           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 318             {
 319               g_strlcat(keystr, " ", sizeof(keystr));
 320               g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
 321               j++;
 322             }
 323           return keystr;
 324         }
 325       i++;
 326     }
 327   return NULL;
 328 }
 329
 330 char *
 331 get_key_description(command_t command)
 332 {
 333   int i;
 334
 335   i=0;
 336   while( cmds[i].description )
 337     {
 338       if( cmds[i].command == command )
 339         return _(cmds[i].description);
 340       i++;
 341     }
 342   return NULL;
 343 }
 344
 345 char *
 346 get_key_command_name(command_t command)
 347 {
 348   int i;
 349
 350   i=0;
 351   while( cmds[i].name )
 352     {
 353       if( cmds[i].command == command )
 354         return cmds[i].name;
 355       i++;
 356     }
 357   return NULL;
 358 }
 359
 360 command_t
 361 get_key_command_from_name(char *name)
 362 {
 363   int i;
 364
 365   i=0;
 366   while( cmds[i].name )
 367     {
 368       if( strcmp(name, cmds[i].name) == 0 )
 369         return cmds[i].command;
 370       i++;
 371     }
 372   return CMD_NONE;
 373 }
 374
 375
 376 command_t
 377 find_key_command(int key, command_definition_t *cmds)
 378 {
 379   int i;
 380
 381   i=0;
 382   while( key && cmds && cmds[i].name )
 383     {
 384       if( cmds[i].keys[0] == key ||
 385           cmds[i].keys[1] == key ||
 386           cmds[i].keys[2] == key )
 387         return cmds[i].command;
 388       i++;
 389     }
 390   return CMD_NONE;
 391 }
 392
 393 command_t
 394 get_key_command(int key)
 395 {
 396   return find_key_command(key, cmds);
 397 }
 398
 399 int
 400 my_wgetch(WINDOW *w)
 401 {
 402   int c;
 403
 404   c = wgetch(w);
 405
 406   /* handle resize event */
 407   if( c==KEY_RESIZE )
 408     screen_resize();
 409
 410 #ifdef ENABLE_RAW_MODE
 411   /* handle SIGSTOP (Ctrl-Z) */
 412   if( c==26 || c==407 )
 413     sigstop();
 414   /* handle SIGINT (Ctrl-C) */
 415   if( c==3 )
 416     exit(EXIT_SUCCESS);
 417 #endif
 418
 419   return c;
 420 }
 421
 422 command_t
 423 get_keyboard_command_with_timeout(int ms)
 424 {
 425   int key;
 426
 427   if( ms != SCREEN_TIMEOUT)
 428     timeout(ms);
 429   key = my_wgetch(stdscr);
 430   if( ms != SCREEN_TIMEOUT)
 431     timeout(SCREEN_TIMEOUT);
 432
 433   if( key==ERR )
 434     return CMD_NONE;
 435
 436 #ifdef HAVE_GETMOUSE
 437   if( key==KEY_MOUSE )
 438     return CMD_MOUSE_EVENT;
 439 #endif
 440
 441   return get_key_command(key);
 442 }
 443
 444 command_t
 445 get_keyboard_command(void)
 446 {
 447   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 448 }
 449
 450 int
 451 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 452 {
 453  int i;
 454
 455   i=0;
 456   while( cmds[i].name )
 457     {
 458       if( cmds[i].command == command )
 459         {
 460           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 461           cmds[i].flags |= COMMAND_KEY_MODIFIED;
 462           return 0;
 463         }
 464       i++;
 465     }
 466   return -1;
 467 }
 468
 469 int
 470 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 471 {
 472   int i;
 473   int retval = 0;
 474
 475   if( cp==NULL )
 476     cp = cmds;
 477
 478   i=0;
 479   while( cp[i].name )
 480     {
 481       cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 482       i++;
 483     }
 484
 485   i=0;
 486   while( cp[i].name )
 487     {
 488       int j;
 489       command_t cmd;
 490
 491       for(j=0; j<MAX_COMMAND_KEYS; j++)
 492         if( cp[i].keys[j] &&
 493             (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
 494           {
 495             if( buf )
 496 #ifdef ENABLE_KEYDEF_SCREEN
 497               g_snprintf(buf, bufsize,
 498                          _("Key %s assigned to %s and %s (press %s for the key editor)"),
 499                          key2str(cp[i].keys[j]),
 500                          get_key_command_name(cp[i].command),
 501                          get_key_command_name(cmd),
 502                          get_key_names(CMD_SCREEN_KEYDEF,0));
 503 #else
 504             g_snprintf(buf, bufsize,
 505                        _("Error: Key %s assigned to %s and %s !!!\n"),
 506                        key2str(cp[i].keys[j]),
 507                        get_key_command_name(cp[i].command),
 508                        get_key_command_name(cmd));
 509 #endif
 510             else
 511               fprintf(stderr,
 512                       _("Error: Key %s assigned to %s and %s !!!\n"),
 513                       key2str(cp[i].keys[j]),
 514                       get_key_command_name(cp[i].command),
 515                       get_key_command_name(cmd));
 516             cp[i].flags |= COMMAND_KEY_CONFLICT;
 517             set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 518             retval = -1;
 519           }
 520       i++;
 521     }
 522   return retval;
 523 }
 524
 525 int
 526 write_key_bindings(FILE *f, int flags)
 527 {
 528   int i,j;
 529
 530   if( flags & KEYDEF_WRITE_HEADER )
 531     fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
 532
 533   i=0;
 534   while( cmds[i].name && !ferror(f) )
 535     {
 536       if( cmds[i].flags & COMMAND_KEY_MODIFIED || flags & KEYDEF_WRITE_ALL)
 537         {
 538           fprintf(f, "## %s\n", cmds[i].description);
 539           if( flags & KEYDEF_COMMENT_ALL )
 540             fprintf(f, "#");
 541           fprintf(f, "key %s = ", cmds[i].name);
 542           for(j=0; j<MAX_COMMAND_KEYS; j++)
 543             {
 544               if( j && cmds[i].keys[j] )
 545                 fprintf(f, ",  ");
 546               if( !j || cmds[i].keys[j] )
 547                 {
 548                   if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 549                                               isdigit(cmds[i].keys[j])) )
 550                     fprintf(f, "\'%c\'", cmds[i].keys[j]);
 551                   else
 552                     fprintf(f, "%d", cmds[i].keys[j]);
 553                 }
 554             }
 555           fprintf(f,"\n\n");
 556         }
 557       i++;
 558     }
 559   return ferror(f);
 560 }