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