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