6f4850b60f0978c78e71a3eecdbea2cbb054c475
1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2009 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.
18 */
20 #include "screen_help.h"
21 #include "screen_interface.h"
22 #include "screen_find.h"
23 #include "config.h"
24 #include "i18n.h"
26 #include <glib.h>
28 typedef struct {
29 signed char highlight;
30 command_t command;
31 const char *text;
32 } help_text_row_t;
34 static help_text_row_t help_text[] = {
35 { 1, CMD_NONE, N_("Movement") },
36 { 2, CMD_NONE, NULL },
37 { 0, CMD_LIST_PREVIOUS, NULL },
38 { 0, CMD_LIST_NEXT, NULL },
39 { 0, CMD_LIST_TOP, NULL },
40 { 0, CMD_LIST_MIDDLE, NULL },
41 { 0, CMD_LIST_BOTTOM, NULL },
42 { 0, CMD_LIST_PREVIOUS_PAGE, NULL },
43 { 0, CMD_LIST_NEXT_PAGE, NULL },
44 { 0, CMD_LIST_FIRST, NULL },
45 { 0, CMD_LIST_LAST, NULL },
46 { 0, CMD_LIST_RANGE_SELECT, NULL },
47 { 0, CMD_LIST_SCROLL_UP_LINE, NULL},
48 { 0, CMD_LIST_SCROLL_DOWN_LINE, NULL},
49 { 0, CMD_LIST_SCROLL_UP_HALF, NULL},
50 { 0, CMD_LIST_SCROLL_DOWN_HALF, NULL},
51 { 0, CMD_NONE, NULL },
53 { 0, CMD_SCREEN_PREVIOUS,NULL },
54 { 0, CMD_SCREEN_NEXT, NULL },
55 { 0, CMD_SCREEN_SWAP, NULL },
56 { 0, CMD_SCREEN_HELP, NULL },
57 { 0, CMD_SCREEN_PLAY, NULL },
58 { 0, CMD_SCREEN_FILE, NULL },
59 #ifdef ENABLE_ARTIST_SCREEN
60 { 0, CMD_SCREEN_ARTIST, NULL },
61 #endif
62 #ifdef ENABLE_SEARCH_SCREEN
63 { 0, CMD_SCREEN_SEARCH, NULL },
64 #endif
65 #ifdef ENABLE_LYRICS_SCREEN
66 { 0, CMD_SCREEN_LYRICS, NULL },
67 #endif
68 #ifdef ENABLE_OUTPUTS_SCREEN
69 { 0, CMD_SCREEN_OUTPUTS, NULL },
70 #endif
71 #ifdef ENABLE_KEYDEF_SCREEN
72 { 0, CMD_SCREEN_KEYDEF, NULL },
73 #endif
75 { 0, CMD_NONE, NULL },
76 { 0, CMD_NONE, NULL },
77 { 1, CMD_NONE, N_("Global") },
78 { 2, CMD_NONE, NULL },
79 { 0, CMD_STOP, NULL },
80 { 0, CMD_PAUSE, NULL },
81 { 0, CMD_CROP, NULL },
82 { 0, CMD_TRACK_NEXT, NULL },
83 { 0, CMD_TRACK_PREVIOUS, NULL },
84 { 0, CMD_SEEK_FORWARD, NULL },
85 { 0, CMD_SEEK_BACKWARD, NULL },
86 { 0, CMD_VOLUME_DOWN, NULL },
87 { 0, CMD_VOLUME_UP, NULL },
88 { 0, CMD_NONE, NULL },
89 { 0, CMD_REPEAT, NULL },
90 { 0, CMD_RANDOM, NULL },
91 { 0, CMD_SINGLE, NULL },
92 { 0, CMD_CONSUME, NULL },
93 { 0, CMD_CROSSFADE, NULL },
94 { 0, CMD_SHUFFLE, NULL },
95 { 0, CMD_DB_UPDATE, NULL },
96 { 0, CMD_NONE, NULL },
97 { 0, CMD_LIST_FIND, NULL },
98 { 0, CMD_LIST_RFIND, NULL },
99 { 0, CMD_LIST_FIND_NEXT, NULL },
100 { 0, CMD_LIST_RFIND_NEXT, NULL },
101 { 0, CMD_LIST_JUMP, NULL },
102 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
103 { 0, CMD_LOCATE, NULL },
104 { 0, CMD_SCREEN_SONG, NULL },
105 { 0, CMD_NONE, NULL },
106 { 0, CMD_QUIT, NULL },
108 { 0, CMD_NONE, NULL },
109 { 0, CMD_NONE, NULL },
110 { 1, CMD_NONE, N_("Playlist screen") },
111 { 2, CMD_NONE, NULL },
112 { 0, CMD_PLAY, N_("Play") },
113 { 0, CMD_DELETE, NULL },
114 { 0, CMD_CLEAR, NULL },
115 { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
116 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
117 { 0, CMD_ADD, NULL },
118 { 0, CMD_SAVE_PLAYLIST, NULL },
119 { 0, CMD_SCREEN_UPDATE, N_("Center") },
120 { 0, CMD_SELECT_PLAYING, NULL },
121 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
123 { 0, CMD_NONE, NULL },
124 { 0, CMD_NONE, NULL },
125 { 1, CMD_NONE, N_("Browse screen") },
126 { 2, CMD_NONE, NULL },
127 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
128 { 0, CMD_SELECT, NULL },
129 { 0, CMD_ADD, N_("Append song to playlist") },
130 { 0, CMD_SAVE_PLAYLIST, NULL },
131 { 0, CMD_DELETE, N_("Delete playlist") },
132 { 0, CMD_GO_PARENT_DIRECTORY, NULL },
133 { 0, CMD_GO_ROOT_DIRECTORY, NULL },
134 { 0, CMD_SCREEN_UPDATE, NULL },
136 #ifdef ENABLE_SEARCH_SCREEN
137 { 0, CMD_NONE, NULL },
138 { 0, CMD_NONE, NULL },
139 { 1, CMD_NONE, N_("Search screen") },
140 { 2, CMD_NONE, NULL },
141 { 0, CMD_SCREEN_SEARCH, N_("Search") },
142 { 0, CMD_PLAY, N_("Select and play") },
143 { 0, CMD_SELECT, NULL },
144 { 0, CMD_ADD, N_("Append song to playlist") },
145 { 0, CMD_SELECT_ALL, NULL },
146 { 0, CMD_SEARCH_MODE, NULL },
147 #endif
148 #ifdef ENABLE_LYRICS_SCREEN
149 { 0, CMD_NONE, NULL },
150 { 0, CMD_NONE, NULL },
151 { 1, CMD_NONE, N_("Lyrics screen") },
152 { 2, CMD_NONE, NULL },
153 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
154 { 0, CMD_SELECT, N_("(Re)load lyrics") },
155 /* to translators: this hotkey aborts the retrieval of lyrics
156 from the server */
157 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
158 { 0, CMD_LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
159 { 0, CMD_SAVE_PLAYLIST, N_("Save lyrics") },
160 #endif
161 #ifdef ENABLE_OUTPUTS_SCREEN
162 { 0, CMD_NONE, NULL },
163 { 0, CMD_NONE, NULL },
164 { 1, CMD_NONE, N_("Outputs screen") },
165 { 2, CMD_NONE, NULL },
166 { 0, CMD_PLAY, N_("Enable/disable output") },
167 #endif
168 #ifdef ENABLE_KEYDEF_SCREEN
169 { 0, CMD_NONE, NULL },
170 { 0, CMD_NONE, NULL },
171 { 1, CMD_NONE, N_("Keydef screen") },
172 { 2, CMD_NONE, NULL },
173 { 0, CMD_PLAY, N_("Edit keydefs for selected command") },
174 { 0, CMD_DELETE, N_("Remove selected keydef") },
175 { 0, CMD_GO_PARENT_DIRECTORY, N_("Go up a level") },
176 { 0, CMD_SAVE_PLAYLIST, N_("Apply and save changes") },
177 #endif
178 };
180 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
182 static list_window_t *lw;
184 static const char *
185 list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED char** second_column, G_GNUC_UNUSED void *data)
186 {
187 static char buf[512];
189 if (idx >= help_text_rows)
190 return NULL;
192 if (help_text[idx].highlight)
193 *highlight = true;
195 if (help_text[idx].command == CMD_NONE) {
196 if (help_text[idx].text)
197 g_snprintf(buf, sizeof(buf), " %s", _(help_text[idx].text));
198 else if (help_text[idx].highlight == 2) {
199 int i;
201 for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
202 buf[i] = '-';
203 buf[i] = '\0';
204 } else
205 g_strlcpy(buf, " ", sizeof(buf));
206 return buf;
207 }
209 if (help_text[idx].text)
210 g_snprintf(buf, sizeof(buf),
211 "%20s : %s ",
212 get_key_names(help_text[idx].command, TRUE),
213 _(help_text[idx].text));
214 else
215 g_snprintf(buf, sizeof(buf),
216 "%20s : %s ",
217 get_key_names(help_text[idx].command, TRUE),
218 get_key_description(help_text[idx].command));
219 return buf;
220 }
222 static void
223 help_init(WINDOW *w, int cols, int rows)
224 {
225 lw = list_window_init(w, cols, rows);
226 lw->hide_cursor = true;
227 }
229 static void
230 help_resize(int cols, int rows)
231 {
232 lw->cols = cols;
233 lw->rows = rows;
234 }
236 static void
237 help_exit(void)
238 {
239 list_window_free(lw);
240 }
243 static const char *
244 help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
245 {
246 return _("Help");
247 }
249 static void
250 help_paint(void)
251 {
252 list_window_paint(lw, list_callback, NULL);
253 }
255 static bool
256 help_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
257 {
258 if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
259 list_window_paint(lw, list_callback, NULL);
260 wrefresh(lw->w);
261 return true;
262 }
264 lw->selected = lw->start;
265 if (screen_find(lw, help_text_rows,
266 cmd, list_callback, NULL)) {
267 /* center the row */
268 list_window_center(lw, help_text_rows, lw->selected);
269 list_window_paint(lw, list_callback, NULL);
270 wrefresh(lw->w);
271 return true;
272 }
274 return false;
275 }
277 const struct screen_functions screen_help = {
278 .init = help_init,
279 .exit = help_exit,
280 .resize = help_resize,
281 .paint = help_paint,
282 .cmd = help_cmd,
283 .get_title = help_title,
284 };