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 */
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>
30 #include "config.h"
31 #include "ncmpc.h"
32 #include "command.h"
34 #undef DEBUG_KEYS
36 #ifdef DEBUG_KEYS
37 #define DK(x) x
38 #else
39 #define DK(x)
40 #endif
42 extern void sigstop(void);
43 extern void screen_resize(void);
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 #define F7 KEY_F(7)
67 static command_definition_t cmds[] =
68 {
69 #ifdef ENABLE_KEYDEF_SCREEN
70 { {'K', 0, 0 }, 0, CMD_SCREEN_KEYDEF, "screen-keyedit",
71 N_("Key configuration screen") },
72 #endif
73 { { 'q', 'Q', 3 }, 0, CMD_QUIT, "quit",
74 N_("Quit") },
76 /* movment */
77 { { UP, 'k', 0 }, 0, CMD_LIST_PREVIOUS, "up",
78 N_("Move cursor up") },
79 { { DWN, 'j', 0 }, 0, CMD_LIST_NEXT, "down",
80 N_("Move cursor down") },
81 { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST, "home",
82 N_("Home ") },
83 { { END, 0x05, 0 }, 0, CMD_LIST_LAST, "end",
84 N_("End ") },
85 { { PGUP, 0, 0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
86 N_("Page up") },
87 { { PGDN, 0, 0 }, 0, CMD_LIST_NEXT_PAGE, "pgdn",
88 N_("Page down") },
91 /* basic screens */
92 { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP, "screen-help",
93 N_("Help screen") },
94 { { '2', F2, 0 }, 0, CMD_SCREEN_PLAY, "screen-playlist",
95 N_("Playlist screen") },
96 { { '3', F3, 0 }, 0, CMD_SCREEN_FILE, "screen-browse",
97 N_("Browse screen") },
100 /* player commands */
101 { { 13, 0, 0 }, 0, CMD_PLAY, "play",
102 N_("Play/Enter directory") },
103 { { 'P', 0, 0 }, 0, CMD_PAUSE,"pause",
104 N_("Pause") },
105 { { 's', BS, 0 }, 0, CMD_STOP, "stop",
106 N_("Stop") },
107 { { '>', 0, 0 }, 0, CMD_TRACK_NEXT, "next",
108 N_("Next track") },
109 { { '<', 0, 0 }, 0, CMD_TRACK_PREVIOUS, "prev",
110 N_("Previous track") },
111 { { 'f', 0, 0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
112 N_("Seek forward") },
113 { { 'b', 0, 0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
114 N_("Seek backward") },
115 { { '+', RGHT, 0 }, 0, CMD_VOLUME_UP, "volume-up",
116 N_("Increase volume") },
117 { { '-', LEFT, 0 }, 0, CMD_VOLUME_DOWN, "volume-down",
118 N_("Decrease volume") },
119 { { ' ', 0, 0 }, 0, CMD_SELECT, "select",
120 N_("Select/deselect song in playlist") },
121 { { DEL, 'd', 0 }, 0, CMD_DELETE, "delete",
122 N_("Delete song from playlist") },
123 { { 'Z', 0, 0 }, 0, CMD_SHUFFLE, "shuffle",
124 N_("Shuffle playlist") },
125 { { 'c', 0, 0 }, 0, CMD_CLEAR, "clear",
126 N_("Clear playlist") },
127 { { 'r', 0, 0 }, 0, CMD_REPEAT, "repeat",
128 N_("Toggle repeat mode") },
129 { { 'z', 0, 0 }, 0, CMD_RANDOM, "random",
130 N_("Toggle random mode") },
131 { { 'x', 0, 0 }, 0, CMD_CROSSFADE, "crossfade",
132 N_("Toggle crossfade mode") },
133 { { 21, 0, 0 }, 0, CMD_DB_UPDATE, "db-update",
134 N_("Start a music database update") },
135 { { 'S', 0, 0 }, 0, CMD_SAVE_PLAYLIST, "save",
136 N_("Save playlist") },
137 { { 'a', 0, 0 }, 0, CMD_ADD, "add",
138 N_("Add url/file to playlist") },
141 /* lists */
142 { { 11, 0, 0 }, 0, CMD_LIST_MOVE_UP, "move-up",
143 N_("Move item up") },
144 { { 10, 0, 0 }, 0, CMD_LIST_MOVE_DOWN, "move-down",
145 N_("Move item down") },
146 { { 12, 0, 0 }, 0, CMD_SCREEN_UPDATE, "update",
147 N_("Update screen") },
150 /* ncmpc options */
151 { { 'w', 0, 0 }, 0, CMD_TOGGLE_FIND_WRAP, "wrap-mode",
152 N_("Toggle find mode") },
153 { { 'U', 0, 0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
154 N_("Toggle auto center mode") },
157 /* change screen */
158 { { TAB, 0, 0 }, 0, CMD_SCREEN_NEXT, "screen-next",
159 N_("Next screen") },
160 { { STAB, 0, 0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
161 N_("Previous screen") },
164 /* find */
165 { { '/', 0, 0 }, 0, CMD_LIST_FIND, "find",
166 N_("Forward find") },
167 { { 'n', 0, 0 }, 0, CMD_LIST_FIND_NEXT, "find-next",
168 N_("Forward find next") },
169 { { '?', 0, 0 }, 0, CMD_LIST_RFIND, "rfind",
170 N_("Backward find") },
171 { { 'p', 0, 0 }, 0, CMD_LIST_RFIND_NEXT, "rfind-next",
172 N_("Backward find previous") },
175 /* extra screens */
176 #ifdef ENABLE_ARTIST_SCREEN
177 { {'4', F4, 0 }, 0, CMD_SCREEN_ARTIST, "screen-artist",
178 N_("Artist screen") },
179 #endif
180 #ifdef ENABLE_SEARCH_SCREEN
181 { {'5', F5, 0 }, 0, CMD_SCREEN_SEARCH, "screen-search",
182 N_("Search screen") },
183 { {'m', 0, 0 }, 0, CMD_SEARCH_MODE, "search-mode",
184 N_("Change search mode") },
185 #endif
187 #ifdef ENABLE_CLOCK_SCREEN
188 { {'6', F6, 0 }, 0, CMD_SCREEN_CLOCK, "screen-clock",
189 N_("Clock screen") },
190 #endif
191 #ifdef ENABLE_LYRICS_SCREEN
192 { {'7', F7, 0 }, 0, CMD_SCREEN_LYRICS, "screen-lyrics",
193 N_("Lyrics screen") },
194 { {ESC, 0, 0 }, 0, CMD_INTERRUPT, "lyrics-interrupt",
195 N_("Interrupt action") },
196 { {'u', 0, 0 }, 0, CMD_LYRICS_UPDATE, "lyrics-update",
197 N_("Update Lyrics") },
198 #endif
201 { { -1, -1, -1 }, 0, CMD_NONE, NULL, NULL }
202 };
204 command_definition_t *
205 get_command_definitions(void)
206 {
207 return cmds;
208 }
210 char *
211 key2str(int key)
212 {
213 static char buf[32];
214 int i;
216 buf[0] = 0;
217 switch(key)
218 {
219 case 0:
220 return _("Undefined");
221 case ' ':
222 return _("Space");
223 case 13:
224 return _("Enter");
225 case BS:
226 return _("Backspace");
227 case DEL:
228 return _("Delete");
229 case UP:
230 return _("Up");
231 case DWN:
232 return _("Down");
233 case LEFT:
234 return _("Left");
235 case RGHT:
236 return _("Right");
237 case HOME:
238 return _("Home");
239 case END:
240 return _("End");
241 case PGDN:
242 return _("PageDown");
243 case PGUP:
244 return _("PageUp");
245 case TAB:
246 return _("Tab");
247 case STAB:
248 return _("Shift+Tab");
249 case ESC:
250 return _("Esc");
251 case KEY_IC:
252 return _("Insert");
253 default:
254 for(i=0; i<=63; i++)
255 if( key==KEY_F(i) )
256 {
257 g_snprintf(buf, 32, "F%d", i );
258 return buf;
259 }
260 if( !(key & ~037) )
261 g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
262 else if( (key & ~037) == 224 )
263 g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
264 else if( key>32 && key<256 )
265 g_snprintf(buf, 32, "%c", key);
266 else
267 g_snprintf(buf, 32, "0x%03X", key);
268 }
269 return buf;
270 }
272 void
273 command_dump_keys(void)
274 {
275 int i;
277 i=0;
278 while( cmds[i].description )
279 {
280 if( cmds[i].command != CMD_NONE )
281 printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
282 i++;
283 }
284 }
286 int
287 set_key_flags(command_definition_t *cp, command_t command, int flags)
288 {
289 int i;
291 i=0;
292 while( cp[i].name )
293 {
294 if( cp[i].command == command )
295 {
296 cp[i].flags |= flags;
297 return 0;
298 }
299 i++;
300 }
301 return 1;
302 }
304 char *
305 get_key_names(command_t command, int all)
306 {
307 int i;
309 i=0;
310 while( cmds[i].description )
311 {
312 if( cmds[i].command == command )
313 {
314 int j;
315 static char keystr[80];
317 g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
318 if( !all )
319 return keystr;
320 j=1;
321 while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
322 {
323 g_strlcat(keystr, " ", sizeof(keystr));
324 g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
325 j++;
326 }
327 return keystr;
328 }
329 i++;
330 }
331 return NULL;
332 }
334 char *
335 get_key_description(command_t command)
336 {
337 int i;
339 i=0;
340 while( cmds[i].description )
341 {
342 if( cmds[i].command == command )
343 return _(cmds[i].description);
344 i++;
345 }
346 return NULL;
347 }
349 char *
350 get_key_command_name(command_t command)
351 {
352 int i;
354 i=0;
355 while( cmds[i].name )
356 {
357 if( cmds[i].command == command )
358 return cmds[i].name;
359 i++;
360 }
361 return NULL;
362 }
364 command_t
365 get_key_command_from_name(char *name)
366 {
367 int i;
369 i=0;
370 while( cmds[i].name )
371 {
372 if( strcmp(name, cmds[i].name) == 0 )
373 return cmds[i].command;
374 i++;
375 }
376 return CMD_NONE;
377 }
380 command_t
381 find_key_command(int key, command_definition_t *cmds)
382 {
383 int i;
385 i=0;
386 while( key && cmds && cmds[i].name )
387 {
388 if( cmds[i].keys[0] == key ||
389 cmds[i].keys[1] == key ||
390 cmds[i].keys[2] == key )
391 return cmds[i].command;
392 i++;
393 }
394 return CMD_NONE;
395 }
397 command_t
398 get_key_command(int key)
399 {
400 return find_key_command(key, cmds);
401 }
403 int
404 my_wgetch(WINDOW *w)
405 {
406 int c;
408 c = wgetch(w);
410 /* handle resize event */
411 if( c==KEY_RESIZE )
412 screen_resize();
414 #ifdef ENABLE_RAW_MODE
415 /* handle SIGSTOP (Ctrl-Z) */
416 if( c==26 || c==407 )
417 sigstop();
418 /* handle SIGINT (Ctrl-C) */
419 if( c==3 )
420 exit(EXIT_SUCCESS);
421 #endif
423 return c;
424 }
426 command_t
427 get_keyboard_command_with_timeout(int ms)
428 {
429 int key;
431 if( ms != SCREEN_TIMEOUT)
432 timeout(ms);
433 key = my_wgetch(stdscr);
434 if( ms != SCREEN_TIMEOUT)
435 timeout(SCREEN_TIMEOUT);
437 if( key==ERR )
438 return CMD_NONE;
440 #ifdef HAVE_GETMOUSE
441 if( key==KEY_MOUSE )
442 return CMD_MOUSE_EVENT;
443 #endif
445 return get_key_command(key);
446 }
448 command_t
449 get_keyboard_command(void)
450 {
451 return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
452 }
454 int
455 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
456 {
457 int i;
459 i=0;
460 while( cmds[i].name )
461 {
462 if( cmds[i].command == command )
463 {
464 memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
465 cmds[i].flags |= COMMAND_KEY_MODIFIED;
466 return 0;
467 }
468 i++;
469 }
470 return -1;
471 }
473 int
474 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
475 {
476 int i;
477 int retval = 0;
479 if( cp==NULL )
480 cp = cmds;
482 i=0;
483 while( cp[i].name )
484 {
485 cp[i].flags &= ~COMMAND_KEY_CONFLICT;
486 i++;
487 }
489 i=0;
490 while( cp[i].name )
491 {
492 int j;
493 command_t cmd;
495 for(j=0; j<MAX_COMMAND_KEYS; j++)
496 if( cp[i].keys[j] &&
497 (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
498 {
499 if( buf )
500 #ifdef ENABLE_KEYDEF_SCREEN
501 g_snprintf(buf, bufsize,
502 _("Key %s assigned to %s and %s (press %s for the key editor)"),
503 key2str(cp[i].keys[j]),
504 get_key_command_name(cp[i].command),
505 get_key_command_name(cmd),
506 get_key_names(CMD_SCREEN_KEYDEF,0));
507 #else
508 g_snprintf(buf, bufsize,
509 _("Error: Key %s assigned to %s and %s !!!\n"),
510 key2str(cp[i].keys[j]),
511 get_key_command_name(cp[i].command),
512 get_key_command_name(cmd));
513 #endif
514 else
515 fprintf(stderr,
516 _("Error: Key %s assigned to %s and %s !!!\n"),
517 key2str(cp[i].keys[j]),
518 get_key_command_name(cp[i].command),
519 get_key_command_name(cmd));
520 cp[i].flags |= COMMAND_KEY_CONFLICT;
521 set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
522 retval = -1;
523 }
524 i++;
525 }
526 return retval;
527 }
529 int
530 write_key_bindings(FILE *f, int flags)
531 {
532 int i,j;
534 if( flags & KEYDEF_WRITE_HEADER )
535 fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
537 i=0;
538 while( cmds[i].name && !ferror(f) )
539 {
540 if( cmds[i].flags & COMMAND_KEY_MODIFIED || flags & KEYDEF_WRITE_ALL)
541 {
542 fprintf(f, "## %s\n", cmds[i].description);
543 if( flags & KEYDEF_COMMENT_ALL )
544 fprintf(f, "#");
545 fprintf(f, "key %s = ", cmds[i].name);
546 for(j=0; j<MAX_COMMAND_KEYS; j++)
547 {
548 if( j && cmds[i].keys[j] )
549 fprintf(f, ", ");
550 if( !j || cmds[i].keys[j] )
551 {
552 if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
553 isdigit(cmds[i].keys[j])) )
554 fprintf(f, "\'%c\'", cmds[i].keys[j]);
555 else
556 fprintf(f, "%d", cmds[i].keys[j]);
557 }
558 }
559 fprintf(f,"\n\n");
560 }
561 i++;
562 }
563 return ferror(f);
564 }