1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2010 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "screen_help.h"
21 #include "screen_interface.h"
22 #include "screen_find.h"
32 struct help_text_row
{
33 signed char highlight
;
38 static const struct help_text_row help_text
[] = {
39 { 1, CMD_NONE
, N_("Movement") },
40 { 2, CMD_NONE
, NULL
},
41 { 0, CMD_LIST_PREVIOUS
, NULL
},
42 { 0, CMD_LIST_NEXT
, NULL
},
43 { 0, CMD_LIST_TOP
, NULL
},
44 { 0, CMD_LIST_MIDDLE
, NULL
},
45 { 0, CMD_LIST_BOTTOM
, NULL
},
46 { 0, CMD_LIST_PREVIOUS_PAGE
, NULL
},
47 { 0, CMD_LIST_NEXT_PAGE
, NULL
},
48 { 0, CMD_LIST_FIRST
, NULL
},
49 { 0, CMD_LIST_LAST
, NULL
},
50 { 0, CMD_LIST_RANGE_SELECT
, NULL
},
51 { 0, CMD_LIST_SCROLL_UP_LINE
, NULL
},
52 { 0, CMD_LIST_SCROLL_DOWN_LINE
, NULL
},
53 { 0, CMD_LIST_SCROLL_UP_HALF
, NULL
},
54 { 0, CMD_LIST_SCROLL_DOWN_HALF
, NULL
},
55 { 0, CMD_NONE
, NULL
},
57 { 0, CMD_SCREEN_PREVIOUS
,NULL
},
58 { 0, CMD_SCREEN_NEXT
, NULL
},
59 { 0, CMD_SCREEN_SWAP
, NULL
},
60 { 0, CMD_SCREEN_HELP
, NULL
},
61 { 0, CMD_SCREEN_PLAY
, NULL
},
62 { 0, CMD_SCREEN_FILE
, NULL
},
63 #ifdef ENABLE_ARTIST_SCREEN
64 { 0, CMD_SCREEN_ARTIST
, NULL
},
66 #ifdef ENABLE_SEARCH_SCREEN
67 { 0, CMD_SCREEN_SEARCH
, NULL
},
69 #ifdef ENABLE_LYRICS_SCREEN
70 { 0, CMD_SCREEN_LYRICS
, NULL
},
72 #ifdef ENABLE_OUTPUTS_SCREEN
73 { 0, CMD_SCREEN_OUTPUTS
, NULL
},
75 #ifdef ENABLE_KEYDEF_SCREEN
76 { 0, CMD_SCREEN_KEYDEF
, NULL
},
79 { 0, CMD_NONE
, NULL
},
80 { 0, CMD_NONE
, NULL
},
81 { 1, CMD_NONE
, N_("Global") },
82 { 2, CMD_NONE
, NULL
},
83 { 0, CMD_STOP
, NULL
},
84 { 0, CMD_PAUSE
, NULL
},
85 { 0, CMD_CROP
, NULL
},
86 { 0, CMD_TRACK_NEXT
, NULL
},
87 { 0, CMD_TRACK_PREVIOUS
, NULL
},
88 { 0, CMD_SEEK_FORWARD
, NULL
},
89 { 0, CMD_SEEK_BACKWARD
, NULL
},
90 { 0, CMD_VOLUME_DOWN
, NULL
},
91 { 0, CMD_VOLUME_UP
, NULL
},
92 { 0, CMD_NONE
, NULL
},
93 { 0, CMD_REPEAT
, NULL
},
94 { 0, CMD_RANDOM
, NULL
},
95 { 0, CMD_SINGLE
, NULL
},
96 { 0, CMD_CONSUME
, NULL
},
97 { 0, CMD_CROSSFADE
, NULL
},
98 { 0, CMD_SHUFFLE
, NULL
},
99 { 0, CMD_DB_UPDATE
, NULL
},
100 { 0, CMD_NONE
, NULL
},
101 { 0, CMD_LIST_FIND
, NULL
},
102 { 0, CMD_LIST_RFIND
, NULL
},
103 { 0, CMD_LIST_FIND_NEXT
, NULL
},
104 { 0, CMD_LIST_RFIND_NEXT
, NULL
},
105 { 0, CMD_LIST_JUMP
, NULL
},
106 { 0, CMD_TOGGLE_FIND_WRAP
, NULL
},
107 { 0, CMD_LOCATE
, NULL
},
108 #ifdef ENABLE_SONG_SCREEN
109 { 0, CMD_SCREEN_SONG
, NULL
},
111 { 0, CMD_NONE
, NULL
},
112 { 0, CMD_QUIT
, NULL
},
114 { 0, CMD_NONE
, NULL
},
115 { 0, CMD_NONE
, NULL
},
116 { 1, CMD_NONE
, N_("Playlist screen") },
117 { 2, CMD_NONE
, NULL
},
118 { 0, CMD_PLAY
, N_("Play") },
119 { 0, CMD_DELETE
, NULL
},
120 { 0, CMD_CLEAR
, NULL
},
121 { 0, CMD_LIST_MOVE_UP
, N_("Move song up") },
122 { 0, CMD_LIST_MOVE_DOWN
, N_("Move song down") },
123 { 0, CMD_ADD
, NULL
},
124 { 0, CMD_SAVE_PLAYLIST
, NULL
},
125 { 0, CMD_SCREEN_UPDATE
, N_("Center") },
126 { 0, CMD_SELECT_PLAYING
, NULL
},
127 { 0, CMD_TOGGLE_AUTOCENTER
, NULL
},
129 { 0, CMD_NONE
, NULL
},
130 { 0, CMD_NONE
, NULL
},
131 { 1, CMD_NONE
, N_("Browse screen") },
132 { 2, CMD_NONE
, NULL
},
133 { 0, CMD_PLAY
, N_("Enter directory/Select and play song") },
134 { 0, CMD_SELECT
, NULL
},
135 { 0, CMD_ADD
, N_("Append song to playlist") },
136 { 0, CMD_SAVE_PLAYLIST
, NULL
},
137 { 0, CMD_DELETE
, N_("Delete playlist") },
138 { 0, CMD_GO_PARENT_DIRECTORY
, NULL
},
139 { 0, CMD_GO_ROOT_DIRECTORY
, NULL
},
140 { 0, CMD_SCREEN_UPDATE
, NULL
},
142 #ifdef ENABLE_SEARCH_SCREEN
143 { 0, CMD_NONE
, NULL
},
144 { 0, CMD_NONE
, NULL
},
145 { 1, CMD_NONE
, N_("Search screen") },
146 { 2, CMD_NONE
, NULL
},
147 { 0, CMD_SCREEN_SEARCH
, N_("Search") },
148 { 0, CMD_PLAY
, N_("Select and play") },
149 { 0, CMD_SELECT
, NULL
},
150 { 0, CMD_ADD
, N_("Append song to playlist") },
151 { 0, CMD_SELECT_ALL
, NULL
},
152 { 0, CMD_SEARCH_MODE
, NULL
},
154 #ifdef ENABLE_LYRICS_SCREEN
155 { 0, CMD_NONE
, NULL
},
156 { 0, CMD_NONE
, NULL
},
157 { 1, CMD_NONE
, N_("Lyrics screen") },
158 { 2, CMD_NONE
, NULL
},
159 { 0, CMD_SCREEN_LYRICS
, N_("View Lyrics") },
160 { 0, CMD_SELECT
, N_("(Re)load lyrics") },
161 /* to translators: this hotkey aborts the retrieval of lyrics
163 { 0, CMD_INTERRUPT
, N_("Interrupt retrieval") },
164 { 0, CMD_LYRICS_UPDATE
, N_("Download lyrics for currently playing song") },
165 { 0, CMD_SAVE_PLAYLIST
, N_("Save lyrics") },
166 { 0, CMD_DELETE
, N_("Delete saved lyrics") },
168 #ifdef ENABLE_OUTPUTS_SCREEN
169 { 0, CMD_NONE
, NULL
},
170 { 0, CMD_NONE
, NULL
},
171 { 1, CMD_NONE
, N_("Outputs screen") },
172 { 2, CMD_NONE
, NULL
},
173 { 0, CMD_PLAY
, N_("Enable/disable output") },
175 #ifdef ENABLE_KEYDEF_SCREEN
176 { 0, CMD_NONE
, NULL
},
177 { 0, CMD_NONE
, NULL
},
178 { 1, CMD_NONE
, N_("Keydef screen") },
179 { 2, CMD_NONE
, NULL
},
180 { 0, CMD_PLAY
, N_("Edit keydefs for selected command") },
181 { 0, CMD_DELETE
, N_("Remove selected keydef") },
182 { 0, CMD_GO_PARENT_DIRECTORY
, N_("Go up a level") },
183 { 0, CMD_SAVE_PLAYLIST
, N_("Apply and save changes") },
187 static struct list_window
*lw
;
190 list_callback(unsigned i
, G_GNUC_UNUSED
void *data
)
192 const struct help_text_row
*row
= &help_text
[i
];
194 assert(i
< G_N_ELEMENTS(help_text
));
196 if (row
->text
!= NULL
)
199 if (row
->command
!= CMD_NONE
)
200 return get_key_description(row
->command
);
206 help_init(WINDOW
*w
, int cols
, int rows
)
208 lw
= list_window_init(w
, cols
, rows
);
209 lw
->hide_cursor
= true;
210 list_window_set_length(lw
, G_N_ELEMENTS(help_text
));
214 help_resize(int cols
, int rows
)
216 list_window_resize(lw
, cols
, rows
);
222 list_window_free(lw
);
227 help_title(G_GNUC_UNUSED
char *str
, G_GNUC_UNUSED
size_t size
)
233 screen_help_paint_callback(WINDOW
*w
, unsigned i
,
234 unsigned y
, unsigned width
,
235 G_GNUC_UNUSED
bool selected
,
236 G_GNUC_UNUSED
void *data
)
238 const struct help_text_row
*row
= &help_text
[i
];
240 assert(i
< G_N_ELEMENTS(help_text
));
242 row_color(w
, row
->highlight
? COLOR_LIST_BOLD
: COLOR_LIST
, false);
246 if (row
->command
== CMD_NONE
) {
247 if (row
->text
!= NULL
)
248 mvwaddstr(w
, y
, 6, _(row
->text
));
249 else if (row
->highlight
== 2)
250 mvwhline(w
, y
, 3, '-', width
- 6);
252 const char *key
= get_key_names(row
->command
, true);
254 if (utf8_width(key
) < 20)
255 wmove(w
, y
, 20 - utf8_width(key
));
257 mvwaddch(w
, y
, 21, ':');
261 : get_key_description(row
->command
));
268 list_window_paint2(lw
, screen_help_paint_callback
, NULL
);
272 help_cmd(G_GNUC_UNUSED
struct mpdclient
*c
, command_t cmd
)
274 if (list_window_scroll_cmd(lw
, cmd
)) {
280 list_window_set_cursor(lw
, lw
->start
);
281 if (screen_find(lw
, cmd
, list_callback
, NULL
)) {
283 list_window_center(lw
, lw
->selected
);
292 const struct screen_functions screen_help
= {
295 .resize
= help_resize
,
298 .get_title
= help_title
,