Code

Documentation update.
[ncmpc.git] / command.h
1 #ifndef COMMAND_H
2 #define COMMAND_H
4 #define MAX_COMMAND_KEYS 3
6 typedef enum
7 {
8   CMD_NONE = 0,
9   CMD_PLAY,
10   CMD_SELECT,
11   CMD_PAUSE,
12   CMD_STOP,
13   CMD_TRACK_NEXT,
14   CMD_TRACK_PREVIOUS,
15   CMD_SEEK_FORWARD,
16   CMD_SEEK_BACKWARD,
17   CMD_SHUFFLE,
18   CMD_RANDOM,
19   CMD_CLEAR,
20   CMD_DELETE,
21   CMD_REPEAT,
22   CMD_CROSSFADE,
23   CMD_VOLUME_UP,
24   CMD_VOLUME_DOWN,
25   CMD_SAVE_PLAYLIST,
26   CMD_TOGGLE_FIND_WRAP,
27   CMD_TOGGLE_AUTOCENTER,
28   CMD_LIST_PREVIOUS,
29   CMD_LIST_NEXT,
30   CMD_LIST_FIRST,
31   CMD_LIST_LAST,
32   CMD_LIST_NEXT_PAGE,
33   CMD_LIST_PREVIOUS_PAGE,
34   CMD_LIST_FIND,
35   CMD_LIST_FIND_NEXT,
36   CMD_LIST_RFIND,
37   CMD_LIST_RFIND_NEXT,
38   CMD_SCREEN_UPDATE,
39   CMD_SCREEN_PREVIOUS,
40   CMD_SCREEN_NEXT,
41   CMD_SCREEN_PLAY,
42   CMD_SCREEN_FILE,
43   CMD_SCREEN_SEARCH,
44   CMD_SCREEN_KEYDEF,
45   CMD_SCREEN_HELP,
46   CMD_QUIT
47 } command_t;
49 typedef struct 
50 {
51   int keys[MAX_COMMAND_KEYS];
52   command_t command;
53   char *name;
54   char *description;
55 } command_definition_t;
57 command_definition_t *get_command_definitions(void);
58 command_t find_key_command(int key, command_definition_t *cmds);
60 void command_dump_keys(void);
61 int  check_key_bindings(void);
62 int  write_key_bindings(FILE *f);
64 char *key2str(int key);
65 char *get_key_description(command_t command);
66 char *get_key_command_name(command_t command);
67 char *get_key_names(command_t command, int all);
68 command_t get_key_command(int key);
69 command_t get_key_command_from_name(char *name);
70 int assign_keys(command_t command, int keys[MAX_COMMAND_KEYS]);
72 command_t get_keyboard_command(void);
74 #endif