1 /*
2 * (c) 2004 by Kalle Wallin <kaw@linux.se>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 */
19 #include "config.h"
20 #include "i18n.h"
21 #include "mpdclient.h"
22 #include "command.h"
23 #include "screen.h"
24 #include "screen_utils.h"
26 #include <stdlib.h>
27 #include <string.h>
28 #include <glib.h>
30 typedef struct {
31 signed char highlight;
32 command_t command;
33 const char *text;
34 } help_text_row_t;
36 static help_text_row_t help_text[] = {
37 { 1, CMD_NONE, N_("Keys - Movement") },
38 { 2, CMD_NONE, NULL },
39 { 0, CMD_LIST_PREVIOUS, NULL },
40 { 0, CMD_LIST_NEXT, NULL },
41 { 0, CMD_LIST_PREVIOUS_PAGE, NULL },
42 { 0, CMD_LIST_NEXT_PAGE, NULL },
43 { 0, CMD_LIST_FIRST, NULL },
44 { 0, CMD_LIST_LAST, NULL },
45 { 0, CMD_NONE, NULL },
46 { 0, CMD_SCREEN_PREVIOUS,NULL },
47 { 0, CMD_SCREEN_NEXT, NULL },
48 { 0, CMD_SCREEN_HELP, NULL },
49 { 0, CMD_SCREEN_PLAY, NULL },
50 { 0, CMD_SCREEN_FILE, NULL },
51 #ifdef ENABLE_ARTIST_SCREEN
52 { 0, CMD_SCREEN_ARTIST, NULL },
53 #endif
54 #ifdef ENABLE_SEARCH_SCREEN
55 { 0, CMD_SCREEN_SEARCH, NULL },
56 #endif
57 #ifdef ENABLE_KEYDEF_SCREEN
58 { 0, CMD_SCREEN_KEYDEF, NULL },
59 #endif
61 { 0, CMD_NONE, NULL },
62 { 0, CMD_NONE, NULL },
63 { 1, CMD_NONE, N_("Keys - Global") },
64 { 2, CMD_NONE, NULL },
65 { 0, CMD_STOP, NULL },
66 { 0, CMD_PAUSE, NULL },
67 { 0, CMD_CROP, NULL },
68 { 0, CMD_TRACK_NEXT, NULL },
69 { 0, CMD_TRACK_PREVIOUS, NULL },
70 { 0, CMD_SEEK_FORWARD, NULL },
71 { 0, CMD_SEEK_BACKWARD, NULL },
72 { 0, CMD_VOLUME_DOWN, NULL },
73 { 0, CMD_VOLUME_UP, NULL },
74 { 0, CMD_NONE, NULL },
75 { 0, CMD_REPEAT, NULL },
76 { 0, CMD_RANDOM, NULL },
77 { 0, CMD_CROSSFADE, NULL },
78 { 0, CMD_SHUFFLE, NULL },
79 { 0, CMD_DB_UPDATE, NULL },
80 { 0, CMD_NONE, NULL },
81 { 0, CMD_LIST_FIND, NULL },
82 { 0, CMD_LIST_RFIND, NULL },
83 { 0, CMD_LIST_FIND_NEXT, NULL },
84 { 0, CMD_LIST_RFIND_NEXT, NULL },
85 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
86 { 0, CMD_LOCATE, NULL },
87 { 0, CMD_VIEW, NULL },
88 { 0, CMD_NONE, NULL },
89 { 0, CMD_QUIT, NULL },
91 { 0, CMD_NONE, NULL },
92 { 0, CMD_NONE, NULL },
93 { 1, CMD_NONE, N_("Keys - Playlist screen") },
94 { 2, CMD_NONE, NULL },
95 { 0, CMD_PLAY, N_("Play") },
96 { 0, CMD_DELETE, NULL },
97 { 0, CMD_CLEAR, NULL },
98 { 1, CMD_LIST_MOVE_UP, N_("Move song up") },
99 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
100 { 0, CMD_ADD, NULL },
101 { 0, CMD_SAVE_PLAYLIST, NULL },
102 { 0, CMD_SCREEN_UPDATE, N_("Center") },
103 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
105 { 0, CMD_NONE, NULL },
106 { 0, CMD_NONE, NULL },
107 { 1, CMD_NONE, N_("Keys - Browse screen") },
108 { 2, CMD_NONE, NULL },
109 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
110 { 0, CMD_SELECT, NULL },
111 { 0, CMD_ADD, N_("Append song to playlist") },
112 { 0, CMD_SAVE_PLAYLIST, NULL },
113 { 0, CMD_DELETE, N_("Delete playlist") },
114 { 0, CMD_GO_PARENT_DIRECTORY, NULL },
115 { 0, CMD_GO_ROOT_DIRECTORY, NULL },
116 { 0, CMD_SCREEN_UPDATE, NULL },
118 #ifdef ENABLE_SEARCH_SCREEN
119 { 0, CMD_NONE, NULL },
120 { 0, CMD_NONE, NULL },
121 { 1, CMD_NONE, N_("Keys - Search screen") },
122 { 2, CMD_NONE, NULL },
123 { 0, CMD_SCREEN_SEARCH, N_("Search") },
124 { 0, CMD_PLAY, N_("Select and play") },
125 { 0, CMD_SELECT, NULL },
126 { 0, CMD_ADD, N_("Append song to playlist") },
127 { 0, CMD_SELECT_ALL, NULL },
128 { 0, CMD_SEARCH_MODE, NULL },
129 #endif
130 #ifdef ENABLE_LYRICS_SCREEN
131 { 0, CMD_NONE, NULL },
132 { 0, CMD_NONE, NULL },
133 { 1, CMD_NONE, N_("Keys - Lyrics screen") },
134 { 2, CMD_NONE, NULL },
135 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
136 { 0, CMD_SELECT, N_("(Re)load lyrics") },
137 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
138 { 0, CMD_LYRICS_UPDATE, N_("Explicitly download lyrics") },
139 { 0, CMD_ADD, N_("Save lyrics") },
140 #endif
141 #ifdef ENABLE_OUTPUTS_SCREEN
142 { 0, CMD_NONE, NULL },
143 { 0, CMD_NONE, NULL },
144 { 1, CMD_NONE, N_("Keys - Outputs screen") },
145 { 2, CMD_NONE, NULL },
146 { 0, CMD_PLAY, N_("Enable/disable output") },
147 #endif
148 };
150 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
152 static list_window_t *lw;
154 static const char *
155 list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED void *data)
156 {
157 static char buf[512];
159 if (idx >= help_text_rows)
160 return NULL;
162 if (help_text[idx].highlight)
163 *highlight = true;
165 if (help_text[idx].command == CMD_NONE) {
166 if (help_text[idx].text)
167 g_snprintf(buf, sizeof(buf), " %s", _(help_text[idx].text));
168 else if (help_text[idx].highlight == 2) {
169 int i;
171 for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
172 buf[i] = '-';
173 buf[i] = '\0';
174 } else
175 g_strlcpy(buf, " ", sizeof(buf));
176 return buf;
177 }
179 if (help_text[idx].text)
180 g_snprintf(buf, sizeof(buf),
181 "%20s : %s ",
182 get_key_names(help_text[idx].command, TRUE),
183 _(help_text[idx].text));
184 else
185 g_snprintf(buf, sizeof(buf),
186 "%20s : %s ",
187 get_key_names(help_text[idx].command, TRUE),
188 get_key_description(help_text[idx].command));
189 return buf;
190 }
192 static void
193 help_init(WINDOW *w, int cols, int rows)
194 {
195 lw = list_window_init(w, cols, rows);
196 lw->hide_cursor = true;
197 }
199 static void
200 help_resize(int cols, int rows)
201 {
202 lw->cols = cols;
203 lw->rows = rows;
204 }
206 static void
207 help_exit(void)
208 {
209 list_window_free(lw);
210 }
213 static const char *
214 help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
215 {
216 return _("Help");
217 }
219 static void
220 help_paint(void)
221 {
222 list_window_paint(lw, list_callback, NULL);
223 }
225 static bool
226 help_cmd(G_GNUC_UNUSED mpdclient_t *c, command_t cmd)
227 {
228 if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
229 list_window_paint(lw, list_callback, NULL);
230 wrefresh(lw->w);
231 return true;
232 }
234 lw->selected = lw->start+lw->rows;
235 if (screen_find(lw, help_text_rows,
236 cmd, list_callback, NULL)) {
237 /* center the row */
238 list_window_center(lw, help_text_rows, lw->selected);
239 list_window_paint(lw, list_callback, NULL);
240 wrefresh(lw->w);
241 return true;
242 }
244 return false;
245 }
247 const struct screen_functions screen_help = {
248 .init = help_init,
249 .exit = help_exit,
250 .resize = help_resize,
251 .paint = help_paint,
252 .cmd = help_cmd,
253 .get_title = help_title,
254 };