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 <ncurses.h>
  28
  29 #include "config.h"
  30 #include "ncmpc.h"
  31 #include "command.h"
  32
  33 #undef DEBUG_KEYS
  34
  35 #ifdef DEBUG_KEYS
  36 #define DK(x) x
  37 #else
  38 #define DK(x)
  39 #endif
  40
  41 extern void screen_resize(void);
  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
  63
  64 static command_definition_t cmds[] =
  65 {
  66 #ifdef ENABLE_KEYDEF_SCREEN
  67   { {'K',   0,   0 }, CMD_SCREEN_KEYDEF,    "screen-keyedit",
  68     N_("Key configuration screen") },
  69 #endif
  70   { { 'q', 'Q',  3 }, CMD_QUIT,   "quit",
  71     N_("Quit") },
  72
  73   /* movment */
  74   { {  UP,  'k',   0 }, CMD_LIST_PREVIOUS,      "up",
  75     N_("Move cursor up") },
  76   { { DWN,  'j',   0 }, CMD_LIST_NEXT,          "down",
  77     N_("Move cursor down") },
  78   { { HOME, 0x01, 0 }, CMD_LIST_FIRST,          "home",
  79     N_("Home ") },
  80   { { END,  0x05, 0 }, CMD_LIST_LAST,           "end",
  81     N_("End ") },
  82   { { PGUP,   0,   0 }, CMD_LIST_PREVIOUS_PAGE, "pgup",
  83     N_("Page up") },
  84   { { PGDN,   0,   0 }, CMD_LIST_NEXT_PAGE,     "pgdn",
  85     N_("Page down") },
  86
  87
  88   /* basic screens */
  89   { { '1', F1, 'h' }, CMD_SCREEN_HELP,      "screen-help",
  90     N_("Help screen") },
  91   { { '2', F2,  0 }, CMD_SCREEN_PLAY,      "screen-playlist",
  92     N_("Playlist screen") },
  93   { { '3', F3,  0 }, CMD_SCREEN_FILE,      "screen-browse",
  94     N_("Browse screen") },
  95
  96
  97   /* player commands */
  98   { {  13,   0,   0 }, CMD_PLAY, "play",
  99     N_("Play/Enter directory") },
 100   { { 'P',   0,   0 }, CMD_PAUSE,"pause",
 101     N_("Pause") },
 102   { { 's',  BS,   0 }, CMD_STOP, "stop",
 103     N_("Stop") },
 104   { { '>',   0,   0 }, CMD_TRACK_NEXT, "next",
 105     N_("Next track") },
 106   { { '<',   0,   0 }, CMD_TRACK_PREVIOUS, "prev",
 107     N_("Previous track") },
 108   { { 'f',   0,   0 }, CMD_SEEK_FORWARD, "seek-forward",
 109     N_("Seek forward") },
 110   { { 'b',   0,   0 }, CMD_SEEK_BACKWARD, "seek-backward",
 111     N_("Seek backward") },
 112   { { '+', RGHT,  0 }, CMD_VOLUME_UP, "volume-up",
 113     N_("Increase volume") },
 114   { { '-', LEFT,  0 }, CMD_VOLUME_DOWN, "volume-down",
 115     N_("Decrease volume") },
 116   { { ' ',   0,   0 }, CMD_SELECT, "select",
 117     N_("Select/deselect song in playlist") },
 118   { { DEL,  'd',  0 }, CMD_DELETE, "delete",
 119     N_("Delete song from playlist") },
 120   { { 'Z',   0,   0 }, CMD_SHUFFLE, "shuffle",
 121     N_("Shuffle playlist") },
 122   { { 'c',   0,   0 }, CMD_CLEAR, "clear",
 123     N_("Clear playlist") },
 124   { { 'r',   0,   0 }, CMD_REPEAT, "repeat",
 125     N_("Toggle repeat mode") },
 126   { { 'z',   0,   0 }, CMD_RANDOM, "random",
 127     N_("Toggle random mode") },
 128   { { 'x',   0,   0 }, CMD_CROSSFADE, "crossfade",
 129     N_("Toggle crossfade mode") },
 130   { { 21,    0,   0 }, CMD_DB_UPDATE,  "db-update",
 131     N_("Start a music database update") },
 132   { { 'S',   0,   0 }, CMD_SAVE_PLAYLIST, "save",
 133     N_("Save playlist") },
 134   { { 'a',   0,   0 }, CMD_ADD, "add",
 135     N_("Add url/file to playlist") },
 136
 137
 138   /* lists */
 139   { { 0,  0,   0 }, CMD_LIST_MOVE_UP,     "move-up",
 140     N_("Move item up") },
 141   { { 0,  0,   0 }, CMD_LIST_MOVE_DOWN,   "move-down",
 142     N_("Move item down") },
 143   { {'u',   0,   0 }, CMD_SCREEN_UPDATE,    "update",
 144     N_("Update screen") },
 145
 146
 147   /* ncmpc options */
 148   { { 'w',   0,   0 }, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
 149     N_("Toggle find mode") },
 150   { { 'U',   0,   0 }, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 151     N_("Toggle auto center mode") },
 152
 153
 154   /* change screen */
 155   { { TAB,   0,   0 }, CMD_SCREEN_NEXT,     "screen-next",
 156     N_("Next screen") },
 157   { { STAB,  0,   0 }, CMD_SCREEN_PREVIOUS, "screen-prev",
 158     N_("Previous screen") },
 159
 160
 161   /* find */
 162   { { '/',   0,   0 }, CMD_LIST_FIND,           "find",
 163     N_("Forward find") },
 164   { { 'n',   0,   0 }, CMD_LIST_FIND_NEXT,      "find-next",
 165     N_("Forward find next") },
 166   { { '?',   0,   0 }, CMD_LIST_RFIND,          "rfind",
 167     N_("Backward find") },
 168   { { 'p',   0,   0 }, CMD_LIST_RFIND_NEXT,     "rfind-next",
 169     N_("Backward find previous") },
 170
 171
 172   /* extra screens */
 173 #ifdef ENABLE_CLOCK_SCREEN
 174   { {'4',  F4,   0 }, CMD_SCREEN_CLOCK,    "screen-clock",
 175     N_("Clock screen") },
 176 #endif
 177
 178
 179
 180   { { -1,  -1,  -1 }, 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 char *
 266 get_key_names(command_t command, int all)
 267 {
 268   int i;
 269
 270   i=0;
 271   while( cmds[i].description )
 272     {
 273       if( cmds[i].command == command )
 274         {
 275           int j;
 276           static char keystr[80];
 277
 278           strncpy(keystr, key2str(cmds[i].keys[0]), 80);
 279           if( !all )
 280             return keystr;
 281           j=1;
 282           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 283             {
 284               strcat(keystr, " ");
 285               strcat(keystr, key2str(cmds[i].keys[j]));
 286               j++;
 287             }
 288           return keystr;
 289         }
 290       i++;
 291     }
 292   return NULL;
 293 }
 294
 295 char *
 296 get_key_description(command_t command)
 297 {
 298   int i;
 299
 300   i=0;
 301   while( cmds[i].description )
 302     {
 303       if( cmds[i].command == command )
 304         return _(cmds[i].description);
 305       i++;
 306     }
 307   return NULL;
 308 }
 309
 310 char *
 311 get_key_command_name(command_t command)
 312 {
 313   int i;
 314
 315   i=0;
 316   while( cmds[i].name )
 317     {
 318       if( cmds[i].command == command )
 319         return cmds[i].name;
 320       i++;
 321     }
 322   return NULL;
 323 }
 324
 325 command_t
 326 get_key_command_from_name(char *name)
 327 {
 328   int i;
 329
 330   i=0;
 331   while( cmds[i].name )
 332     {
 333       if( strcmp(name, cmds[i].name) == 0 )
 334         return cmds[i].command;
 335       i++;
 336     }
 337   return CMD_NONE;
 338 }
 339
 340
 341 command_t
 342 find_key_command(int key, command_definition_t *cmds)
 343 {
 344   int i;
 345
 346   i=0;
 347   while( cmds && cmds[i].name )
 348     {
 349       if( cmds[i].keys[0] == key ||
 350           cmds[i].keys[1] == key ||
 351           cmds[i].keys[2] == key )
 352         return cmds[i].command;
 353       i++;
 354     }
 355   return CMD_NONE;
 356 }
 357
 358 command_t
 359 get_key_command(int key)
 360 {
 361   return find_key_command(key, cmds);
 362 }
 363
 364 command_t
 365 get_keyboard_command_with_timeout(int ms)
 366 {
 367   int key;
 368
 369   if( ms != SCREEN_TIMEOUT)
 370     timeout(ms);
 371   key = wgetch(stdscr);
 372   if( ms != SCREEN_TIMEOUT)
 373     timeout(SCREEN_TIMEOUT);
 374
 375   if( key==KEY_RESIZE )
 376     screen_resize();
 377
 378   if( key==ERR )
 379     return CMD_NONE;
 380
 381   return get_key_command(key);
 382 }
 383
 384 command_t
 385 get_keyboard_command(void)
 386 {
 387   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 388 }
 389
 390 int
 391 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 392 {
 393  int i;
 394
 395   i=0;
 396   while( cmds[i].name )
 397     {
 398       if( cmds[i].command == command )
 399         {
 400           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 401           return 0;
 402         }
 403       i++;
 404     }
 405   return -1;
 406 }
 407
 408 int
 409 check_key_bindings(char *buf, size_t bufsize)
 410 {
 411   int i;
 412   int retval = 0;
 413
 414   i=0;
 415   while( cmds[i].name )
 416     {
 417       int j;
 418       command_t cmd;
 419
 420       for(j=0; j<MAX_COMMAND_KEYS; j++)
 421         if( cmds[i].keys[j] &&
 422             (cmd=get_key_command(cmds[i].keys[j])) != cmds[i].command )
 423           {
 424             if( buf )
 425 #ifdef ENABLE_KEYDEF_SCREEN
 426               snprintf(buf, bufsize,
 427                        _("Key %s assigned to %s and %s (press %s for the key editor)"),
 428                        key2str(cmds[i].keys[j]),
 429                        get_key_command_name(cmds[i].command),
 430                        get_key_command_name(cmd),
 431                        get_key_names(CMD_SCREEN_KEYDEF,0));
 432 #else
 433             snprintf(buf, bufsize,
 434                        _("Error: Key %s assigned to %s and %s !!!\n"),
 435                        key2str(cmds[i].keys[j]),
 436                        get_key_command_name(cmds[i].command),
 437                        get_key_command_name(cmd));
 438 #endif
 439             else
 440               fprintf(stderr,
 441                       _("Error: Key %s assigned to %s and %s !!!\n"),
 442                       key2str(cmds[i].keys[j]),
 443                       get_key_command_name(cmds[i].command),
 444                       get_key_command_name(cmd));
 445             retval = -1;
 446           }
 447       i++;
 448     }
 449   return retval;
 450 }
 451
 452 int
 453 write_key_bindings(FILE *f)
 454 {
 455   int i,j;
 456
 457   i=0;
 458   while( cmds[i].name && !ferror(f) )
 459     {
 460       fprintf(f, "# %s\n", cmds[i].description);
 461       fprintf(f, "key %s = ", cmds[i].name);
 462       for(j=0; j<MAX_COMMAND_KEYS; j++)
 463         {
 464           if( j && cmds[i].keys[j] )
 465             fprintf(f, ",  ");
 466           if( !j || cmds[i].keys[j] )
 467             {
 468               if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 469                                           isdigit(cmds[i].keys[j])) )
 470                 fprintf(f, "\'%c\'", cmds[i].keys[j]);
 471               else
 472                 fprintf(f, "%d", cmds[i].keys[j]);
 473             }
 474         }
 475       fprintf(f,"\n\n");
 476       i++;
 477     }
 478   return ferror(f);
 479 }