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