src/command.c

   1 /* ncmpc (Ncurses MPD Client)
   2  * (c) 2004-2009 The Music Player Daemon Project
   3  * Project homepage: http://musicpd.org
   4
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include "command.h"
  21 #include "config.h"
  22 #include "ncmpc.h"
  23 #include "i18n.h"
  24 #include "mpdclient.h"
  25 #include "screen.h"
  26
  27 #include <ctype.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <ctype.h>
  31 #include <glib.h>
  32 #include <signal.h>
  33 #include <unistd.h>
  34
  35 #undef DEBUG_KEYS
  36
  37 #ifdef DEBUG_KEYS
  38 #define DK(x) x
  39 #else
  40 #define DK(x)
  41 #endif
  42
  43 #define BS KEY_BACKSPACE
  44 #define DEL KEY_DC
  45 #define UP KEY_UP
  46 #define DWN KEY_DOWN
  47 #define LEFT KEY_LEFT
  48 #define RGHT KEY_RIGHT
  49 #define HOME KEY_HOME
  50 #define END KEY_END
  51 #define PGDN KEY_NPAGE
  52 #define PGUP KEY_PPAGE
  53 #define TAB 0x09
  54 #define STAB 0x161
  55 #define ESC 0x1B
  56 #define F1 KEY_F(1)
  57 #define F2 KEY_F(2)
  58 #define F3 KEY_F(3)
  59 #define F4 KEY_F(4)
  60 #define F5 KEY_F(5)
  61 #define F6 KEY_F(6)
  62 #define F7 KEY_F(7)
  63 #define F8 KEY_F(8)
  64
  65
  66 static command_definition_t cmds[] = {
  67 #ifdef ENABLE_KEYDEF_SCREEN
  68         { {'K', 0, 0 }, 0, CMD_SCREEN_KEYDEF, "screen-keyedit",
  69           N_("Key configuration screen") },
  70 #endif
  71         { { 'q', 'Q', 3 }, 0, CMD_QUIT, "quit",
  72           N_("Quit") },
  73
  74         /* movement */
  75         { { UP, 'k', 0 }, 0, CMD_LIST_PREVIOUS, "up",
  76           N_("Move cursor up") },
  77         { { DWN, 'j', 0 }, 0, CMD_LIST_NEXT, "down",
  78           N_("Move cursor down") },
  79         { { 'H', 0, 0 }, 0, CMD_LIST_TOP, "top",
  80           N_("Move cursor to top of screen") },
  81         { { 'M', 0, 0 }, 0, CMD_LIST_MIDDLE, "middle",
  82           N_("Move cursor to middle of screen") },
  83         { { 'L', 0, 0 }, 0, CMD_LIST_BOTTOM, "bottom",
  84           N_("Move cursor to bottom of screen") },
  85         { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST, "home",
  86           N_("Home") },
  87         { { END, 0x05, 0 }, 0, CMD_LIST_LAST, "end",
  88           N_("End") },
  89         { { PGUP, 0, 0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
  90           N_("Page up") },
  91         { { PGDN, 0, 0 }, 0, CMD_LIST_NEXT_PAGE, "pgdn",
  92           N_("Page down") },
  93         { { 'v',  0, 0 }, 0, CMD_LIST_RANGE_SELECT, "range-select",
  94           N_("Range selection") },
  95         { { 14,  0, 0 }, 0, CMD_LIST_SCROLL_DOWN_LINE, "scroll-down-line",
  96           N_("Scroll up one line") },
  97         { { 2,  0, 0 }, 0, CMD_LIST_SCROLL_UP_LINE, "scroll-up-line",
  98           N_("Scroll down one line") },
  99         { { 'N',  0, 0 }, 0, CMD_LIST_SCROLL_DOWN_HALF, "scroll-down-half",
 100           N_("Scroll up half a screen") },
 101         { { 'B',  0, 0 }, 0, CMD_LIST_SCROLL_UP_HALF, "scroll-up-half",
 102           N_("Scroll down half a screen") },
 103
 104
 105         /* basic screens */
 106         { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP, "screen-help",
 107           N_("Help screen") },
 108         { { '2', F2, 0 }, 0, CMD_SCREEN_PLAY, "screen-playlist",
 109           N_("Playlist screen") },
 110         { { '3', F3, 0 }, 0, CMD_SCREEN_FILE, "screen-browse",
 111           N_("Browse screen") },
 112
 113
 114         /* player commands */
 115         { { 13, 0, 0 }, 0, CMD_PLAY, "play",
 116           N_("Play/Enter directory") },
 117         { { 'P', 0, 0 }, 0, CMD_PAUSE,"pause",
 118           N_("Pause") },
 119         { { 's', BS, 0 }, 0, CMD_STOP, "stop",
 120           N_("Stop") },
 121         { { 'o', 0, 0 }, 0, CMD_CROP, "crop",
 122           N_("Crop") },
 123         { { '>', 0, 0 }, 0, CMD_TRACK_NEXT, "next",
 124           N_("Next track") },
 125         { { '<', 0, 0 }, 0, CMD_TRACK_PREVIOUS, "prev",
 126           N_("Previous track") },
 127         { { 'f', 0, 0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
 128           N_("Seek forward") },
 129         { { 'b', 0, 0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
 130           N_("Seek backward") },
 131         { { '+', RGHT, 0 }, 0, CMD_VOLUME_UP, "volume-up",
 132           N_("Increase volume") },
 133         { { '-', LEFT, 0 }, 0, CMD_VOLUME_DOWN, "volume-down",
 134           N_("Decrease volume") },
 135         { { ' ', 0, 0 }, 0, CMD_SELECT, "select",
 136           N_("Select/deselect song in playlist") },
 137         { { 't', 0, 0 }, 0, CMD_SELECT_ALL, "select_all",
 138           N_("Select all listed items") },
 139         { { DEL, 'd', 0 }, 0, CMD_DELETE, "delete",
 140           N_("Delete song from playlist") },
 141         { { 'Z', 0, 0 }, 0, CMD_SHUFFLE, "shuffle",
 142           N_("Shuffle playlist") },
 143         { { 'c', 0, 0 }, 0, CMD_CLEAR, "clear",
 144           N_("Clear playlist") },
 145         { { 'r', 0, 0 }, 0, CMD_REPEAT, "repeat",
 146           N_("Toggle repeat mode") },
 147         { { 'z', 0, 0 }, 0, CMD_RANDOM, "random",
 148           N_("Toggle random mode") },
 149         { { 'x', 0, 0 }, 0, CMD_CROSSFADE, "crossfade",
 150           N_("Toggle crossfade mode") },
 151         { { 21, 0, 0 }, 0, CMD_DB_UPDATE, "db-update",
 152           N_("Start a music database update") },
 153         { { 'S', 0, 0 }, 0, CMD_SAVE_PLAYLIST, "save",
 154           N_("Save playlist") },
 155         { { 'a', 0, 0 }, 0, CMD_ADD, "add",
 156           N_("Add url/file to playlist") },
 157
 158         { { '!', 0, 0 }, 0, CMD_GO_ROOT_DIRECTORY, "go-root-directory",
 159           N_("Go to root directory") },
 160         { { '"', 0, 0 }, 0, CMD_GO_PARENT_DIRECTORY, "go-parent-directory",
 161           N_("Go to parent directory") },
 162
 163         { { 'G', 0, 0 }, 0, CMD_LOCATE, "locate",
 164           N_("Locate song in browser") },
 165
 166         /* lists */
 167         { { 11, 0, 0 }, 0, CMD_LIST_MOVE_UP, "move-up",
 168           N_("Move item up") },
 169         { { 10, 0, 0 }, 0, CMD_LIST_MOVE_DOWN, "move-down",
 170           N_("Move item down") },
 171         { { 12, 0, 0 }, 0, CMD_SCREEN_UPDATE, "update",
 172           N_("Refresh screen") },
 173
 174
 175         /* ncmpc options */
 176         { { 'w', 0, 0 }, 0, CMD_TOGGLE_FIND_WRAP, "wrap-mode",
 177           /* translators: toggle between wrapping and non-wrapping
 178              search */
 179           N_("Toggle find mode") },
 180         { { 'U', 0, 0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 181           /* translators: the auto center mode always centers the song
 182              currently being played */
 183           N_("Toggle auto center mode") },
 184
 185
 186         /* change screen */
 187         { { TAB, 0, 0 }, 0, CMD_SCREEN_NEXT, "screen-next",
 188           N_("Next screen") },
 189         { { STAB, 0, 0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
 190           N_("Previous screen") },
 191     { { '`', 0, 0 }, 0, CMD_SCREEN_SWAP, "screen-swap",
 192           N_("Swap to most recent screen") },
 193
 194
 195         /* find */
 196         { { '/', 0, 0 }, 0, CMD_LIST_FIND, "find",
 197           N_("Forward find") },
 198         { { 'n', 0, 0 }, 0, CMD_LIST_FIND_NEXT, "find-next",
 199           N_("Forward find next") },
 200         { { '?', 0, 0 }, 0, CMD_LIST_RFIND, "rfind",
 201           N_("Backward find") },
 202         { { 'p', 0, 0 }, 0, CMD_LIST_RFIND_NEXT, "rfind-next",
 203           N_("Backward find previous") },
 204         { { '.', 0, 0 }, 0, CMD_LIST_JUMP, "jump",
 205                 /* translators: this queries the user for a string
 206                  * and jumps directly (while the user is typing)
 207                  * to the entry which begins with this string */
 208           N_("Jump to") },
 209
 210
 211         /* extra screens */
 212 #ifdef ENABLE_ARTIST_SCREEN
 213         { {'4', F4, 0 }, 0, CMD_SCREEN_ARTIST, "screen-artist",
 214           N_("Artist screen") },
 215 #endif
 216 #ifdef ENABLE_SEARCH_SCREEN
 217         { {'5', F5, 0 }, 0, CMD_SCREEN_SEARCH, "screen-search",
 218           N_("Search screen") },
 219         { {'m', 0, 0 }, 0, CMD_SEARCH_MODE, "search-mode",
 220           N_("Change search mode") },
 221 #endif
 222 #ifdef ENABLE_SONG_SCREEN
 223         { { 'i', 0, 0 }, 0, CMD_SCREEN_SONG, "view",
 224           N_("View the selected and the currently playing song") },
 225 #endif
 226 #ifdef ENABLE_LYRICS_SCREEN
 227         { {'7', F7, 0 }, 0, CMD_SCREEN_LYRICS, "screen-lyrics",
 228           N_("Lyrics screen") },
 229         { {ESC, 0, 0 }, 0, CMD_INTERRUPT, "lyrics-interrupt",
 230           /* translators: interrupt the current background action,
 231              e.g. stop loading lyrics from the internet */
 232           N_("Interrupt action") },
 233         { {'u', 0, 0 }, 0, CMD_LYRICS_UPDATE, "lyrics-update",
 234           N_("Update Lyrics") },
 235 #endif
 236
 237 #ifdef ENABLE_OUTPUTS_SCREEN
 238         { {'8', F8, 0 }, 0, CMD_SCREEN_OUTPUTS, "screen-outputs",
 239           N_("Outputs screen") },
 240 #endif
 241
 242
 243         { { -1, -1, -1 }, 0, CMD_NONE, NULL, NULL }
 244 };
 245
 246 #ifdef ENABLE_KEYDEF_SCREEN
 247 command_definition_t *
 248 get_command_definitions(void)
 249 {
 250         return cmds;
 251 }
 252 #endif
 253
 254 const char *
 255 key2str(int key)
 256 {
 257         static char buf[32];
 258         int i;
 259
 260         buf[0] = 0;
 261         switch(key) {
 262         case 0:
 263                 return _("Undefined");
 264         case ' ':
 265                 return _("Space");
 266         case 13:
 267                 return _("Enter");
 268         case BS:
 269                 return _("Backspace");
 270         case DEL:
 271                 return _("Delete");
 272         case UP:
 273                 return _("Up");
 274         case DWN:
 275                 return _("Down");
 276         case LEFT:
 277                 return _("Left");
 278         case RGHT:
 279                 return _("Right");
 280         case HOME:
 281                 return _("Home");
 282         case END:
 283                 return _("End");
 284         case PGDN:
 285                 return _("PageDown");
 286         case PGUP:
 287                 return _("PageUp");
 288         case TAB:
 289                 return _("Tab");
 290         case STAB:
 291                 return _("Shift+Tab");
 292         case ESC:
 293                 return _("Esc");
 294         case KEY_IC:
 295                 return _("Insert");
 296         default:
 297                 for (i = 0; i <= 63; i++)
 298                         if (key == KEY_F(i)) {
 299                                 g_snprintf(buf, 32, "F%d", i );
 300                                 return buf;
 301                         }
 302                 if (!(key & ~037))
 303                         g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 304                 else if ((key & ~037) == 224)
 305                         g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 306                 else if (key > 32 && key < 256)
 307                         g_snprintf(buf, 32, "%c", key);
 308                 else
 309                         g_snprintf(buf, 32, "0x%03X", key);
 310         }
 311
 312         return buf;
 313 }
 314
 315 void
 316 command_dump_keys(void)
 317 {
 318         int i;
 319
 320         i = 0;
 321         while (cmds[i].description) {
 322                 if (cmds[i].command != CMD_NONE)
 323                         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 324                 i++;
 325         }
 326 }
 327
 328 #ifndef NCMPC_MINI
 329
 330 static int
 331 set_key_flags(command_definition_t *cp, command_t command, int flags)
 332 {
 333         int i;
 334
 335         i = 0;
 336         while (cp[i].name) {
 337                 if (cp[i].command == command) {
 338                         cp[i].flags |= flags;
 339                         return 0;
 340                 }
 341                 i++;
 342         }
 343
 344         return 1;
 345 }
 346
 347 #endif
 348
 349 const char *
 350 get_key_names(command_t command, int all)
 351 {
 352   int i;
 353
 354   i=0;
 355   while (cmds[i].description) {
 356           if (cmds[i].command == command) {
 357                   int j;
 358                   static char keystr[80];
 359
 360                   g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
 361                   if (!all)
 362                           return keystr;
 363                   j=1;
 364                   while (j < MAX_COMMAND_KEYS && cmds[i].keys[j] > 0) {
 365                           g_strlcat(keystr, " ", sizeof(keystr));
 366                           g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
 367                           j++;
 368                   }
 369                   return keystr;
 370           }
 371           i++;
 372   }
 373   return NULL;
 374 }
 375
 376 const char *
 377 get_key_description(command_t command)
 378 {
 379         int i;
 380
 381         i=0;
 382         while (cmds[i].description) {
 383                 if (cmds[i].command == command)
 384                         return _(cmds[i].description);
 385                 i++;
 386         }
 387
 388         return NULL;
 389 }
 390
 391 const char *
 392 get_key_command_name(command_t command)
 393 {
 394         int i;
 395
 396         i=0;
 397         while (cmds[i].name) {
 398                 if (cmds[i].command == command)
 399                         return cmds[i].name;
 400                 i++;
 401         }
 402         return NULL;
 403 }
 404
 405 command_t
 406 get_key_command_from_name(char *name)
 407 {
 408         int i;
 409
 410         i=0;
 411         while (cmds[i].name) {
 412                 if (strcmp(name, cmds[i].name) == 0)
 413                         return cmds[i].command;
 414                 i++;
 415         }
 416
 417         return CMD_NONE;
 418 }
 419
 420 command_t
 421 find_key_command(int key, command_definition_t *c)
 422 {
 423         int i;
 424
 425         i=0;
 426         while (key && c && c[i].name) {
 427                 if (c[i].keys[0] == key ||
 428                     c[i].keys[1] == key ||
 429                     c[i].keys[2] == key)
 430                         return c[i].command;
 431                 i++;
 432         }
 433
 434         return CMD_NONE;
 435 }
 436
 437 command_t
 438 get_key_command(int key)
 439 {
 440         return find_key_command(key, cmds);
 441 }
 442
 443 command_t
 444 get_keyboard_command(void)
 445 {
 446         int key;
 447
 448         key = wgetch(stdscr);
 449         if (key == ERR)
 450                 return CMD_NONE;
 451
 452 #ifdef HAVE_GETMOUSE
 453         if (key == KEY_MOUSE)
 454                 return CMD_MOUSE_EVENT;
 455 #endif
 456
 457         return get_key_command(key);
 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                 if (cmds[i].command == command) {
 468                         memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 469 #ifndef NCMPC_MINI
 470                         cmds[i].flags |= COMMAND_KEY_MODIFIED;
 471 #endif
 472                         return 0;
 473                 }
 474                 i++;
 475         }
 476         return -1;
 477 }
 478
 479 #ifndef NCMPC_MINI
 480
 481 int
 482 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 483 {
 484         int i;
 485         int retval = 0;
 486
 487         if (cp == NULL)
 488                 cp = cmds;
 489
 490         i=0;
 491         while (cp[i].name) {
 492                 cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 493                 i++;
 494         }
 495
 496         i=0;
 497         while (cp[i].name) {
 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                                 if (buf) {
 505                                         g_snprintf(buf, bufsize,
 506                                                    _("Key %s assigned to %s and %s"),
 507                                                    key2str(cp[i].keys[j]),
 508                                                    get_key_command_name(cp[i].command),
 509                                                    get_key_command_name(cmd));
 510                                 } else {
 511                                         fprintf(stderr,
 512                                                 _("Key %s assigned to %s and %s"),
 513                                                 key2str(cp[i].keys[j]),
 514                                                 get_key_command_name(cp[i].command),
 515                                                 get_key_command_name(cmd));
 516                                         fputc('\n', stderr);
 517                                 }
 518                                 cp[i].flags |= COMMAND_KEY_CONFLICT;
 519                                 set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 520                                 retval = -1;
 521                         }
 522                 i++;
 523         }
 524         return retval;
 525 }
 526
 527 int
 528 write_key_bindings(FILE *f, int flags)
 529 {
 530         int i,j;
 531
 532         if (flags & KEYDEF_WRITE_HEADER)
 533                 fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
 534
 535         i = 0;
 536         while (cmds[i].name && !ferror(f)) {
 537                 if (cmds[i].flags & COMMAND_KEY_MODIFIED ||
 538                     flags & KEYDEF_WRITE_ALL) {
 539                         fprintf(f, "## %s\n", cmds[i].description);
 540                         if (flags & KEYDEF_COMMENT_ALL)
 541                                 fprintf(f, "#");
 542                         fprintf(f, "key %s = ", cmds[i].name);
 543                         for (j = 0; j < MAX_COMMAND_KEYS; j++) {
 544                                 if (j && cmds[i].keys[j])
 545                                         fprintf(f, ",  ");
 546                                 if (!j || cmds[i].keys[j]) {
 547                                         if (cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 548                                                                     isdigit(cmds[i].keys[j])))
 549                                                 fprintf(f, "\'%c\'", cmds[i].keys[j]);
 550                                         else
 551                                                 fprintf(f, "%d", cmds[i].keys[j]);
 552                                 }
 553                         }
 554                         fprintf(f,"\n\n");
 555                 }
 556                 i++;
 557         }
 558
 559         return ferror(f);
 560 }
 561
 562 #endif