Code

command: added CMD_LOCATE to locate song in database
[ncmpc.git] / src / command.h
1 #ifndef COMMAND_H
2 #define COMMAND_H
4 #include "config.h"
6 #include <stddef.h>
7 #include <stdio.h>
9 #define MAX_COMMAND_KEYS 3
11 /* commands */
12 typedef enum {
13         CMD_NONE = 0,
14         CMD_PLAY,
15         CMD_SELECT,
16         CMD_SELECT_ALL,
17         CMD_PAUSE,
18         CMD_STOP,
19         CMD_CROP,
20         CMD_TRACK_NEXT,
21         CMD_TRACK_PREVIOUS,
22         CMD_SEEK_FORWARD,
23         CMD_SEEK_BACKWARD,
24         CMD_SHUFFLE,
25         CMD_RANDOM,
26         CMD_CLEAR,
27         CMD_DELETE,
28         CMD_REPEAT,
29         CMD_CROSSFADE,
30         CMD_DB_UPDATE,
31         CMD_VOLUME_UP,
32         CMD_VOLUME_DOWN,
33         CMD_ADD,
34         CMD_SAVE_PLAYLIST,
35         CMD_TOGGLE_FIND_WRAP,
36         CMD_TOGGLE_AUTOCENTER,
37         CMD_SEARCH_MODE,
38         CMD_LIST_PREVIOUS,
39         CMD_LIST_NEXT,
40         CMD_LIST_FIRST,
41         CMD_LIST_LAST,
42         CMD_LIST_NEXT_PAGE,
43         CMD_LIST_PREVIOUS_PAGE,
44         CMD_LIST_FIND,
45         CMD_LIST_FIND_NEXT,
46         CMD_LIST_RFIND,
47         CMD_LIST_RFIND_NEXT,
48         CMD_LIST_MOVE_UP,
49         CMD_LIST_MOVE_DOWN,
50         CMD_MOUSE_EVENT,
51         CMD_SCREEN_UPDATE,
52         CMD_SCREEN_PREVIOUS,
53         CMD_SCREEN_NEXT,
54         CMD_SCREEN_PLAY,
55         CMD_SCREEN_FILE,
56         CMD_SCREEN_ARTIST,
57         CMD_SCREEN_SEARCH,
58         CMD_SCREEN_KEYDEF,
59         CMD_SCREEN_HELP,
60         CMD_SCREEN_LYRICS,
61         CMD_LYRICS_UPDATE,
62         CMD_INTERRUPT,
63         CMD_GO_ROOT_DIRECTORY,
64         CMD_GO_PARENT_DIRECTORY,
65         CMD_LOCATE,
66         CMD_QUIT
67 } command_t;
70 /* command definition flags */
71 #define COMMAND_KEY_MODIFIED  0x01
72 #define COMMAND_KEY_CONFLICT  0x02
74 /* write key bindings flags */
75 #define KEYDEF_WRITE_HEADER  0x01
76 #define KEYDEF_WRITE_ALL     0x02
77 #define KEYDEF_COMMENT_ALL   0x04
79 typedef struct  {
80         int keys[MAX_COMMAND_KEYS];
81         char flags;
82         command_t command;
83         const char *name;
84         const char *description;
85 } command_definition_t;
87 #ifdef ENABLE_KEYDEF_SCREEN
88 command_definition_t *get_command_definitions(void);
89 #endif
91 command_t find_key_command(int key, command_definition_t *cmds);
93 void command_dump_keys(void);
94 int check_key_bindings(command_definition_t *cmds, char *buf, size_t size);
95 int write_key_bindings(FILE *f, int all);
97 const char *key2str(int key);
98 const char *get_key_description(command_t command);
99 const char *get_key_command_name(command_t command);
100 const char *get_key_names(command_t command, int all);
101 command_t get_key_command(int key);
102 command_t get_key_command_from_name(char *name);
103 int assign_keys(command_t command, int keys[MAX_COMMAND_KEYS]);
105 command_t get_keyboard_command(void);
107 #endif