src/command.c

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