a746733a837d0925d5f90a4f505bd3010a56cf88
[ncmpc-debian.git] / src / screen_help.cxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2018 The Music Player Daemon Project
3  * Project homepage: http://musicpd.org
4  *
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.
9  *
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.
14  *
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  */
19
20 #include "screen_help.hxx"
21 #include "screen_interface.hxx"
22 #include "ListPage.hxx"
23 #include "screen_find.hxx"
24 #include "paint.hxx"
25 #include "charset.hxx"
26 #include "config.h"
27 #include "i18n.h"
28
29 #include <glib.h>
30
31 #include <assert.h>
32
33 struct help_text_row {
34         signed char highlight;
35         command_t command;
36         const char *text;
37 };
38
39 static const struct help_text_row help_text[] = {
40         { 1, CMD_NONE, N_("Movement") },
41         { 2, CMD_NONE, nullptr },
42         { 0, CMD_LIST_PREVIOUS, nullptr },
43         { 0, CMD_LIST_NEXT, nullptr },
44         { 0, CMD_LIST_TOP, nullptr },
45         { 0, CMD_LIST_MIDDLE, nullptr },
46         { 0, CMD_LIST_BOTTOM, nullptr },
47         { 0, CMD_LIST_PREVIOUS_PAGE, nullptr },
48         { 0, CMD_LIST_NEXT_PAGE, nullptr },
49         { 0, CMD_LIST_FIRST, nullptr },
50         { 0, CMD_LIST_LAST, nullptr },
51         { 0, CMD_LIST_RANGE_SELECT, nullptr },
52         { 0, CMD_LIST_SCROLL_UP_LINE, nullptr},
53         { 0, CMD_LIST_SCROLL_DOWN_LINE, nullptr},
54         { 0, CMD_LIST_SCROLL_UP_HALF, nullptr},
55         { 0, CMD_LIST_SCROLL_DOWN_HALF, nullptr},
56         { 0, CMD_NONE, nullptr },
57
58         { 0, CMD_SCREEN_PREVIOUS,nullptr },
59         { 0, CMD_SCREEN_NEXT, nullptr },
60         { 0, CMD_SCREEN_SWAP, nullptr },
61         { 0, CMD_SCREEN_HELP, nullptr },
62         { 0, CMD_SCREEN_PLAY, nullptr },
63         { 0, CMD_SCREEN_FILE, nullptr },
64 #ifdef ENABLE_ARTIST_SCREEN
65         { 0, CMD_SCREEN_ARTIST, nullptr },
66 #endif
67 #ifdef ENABLE_SEARCH_SCREEN
68         { 0, CMD_SCREEN_SEARCH, nullptr },
69 #endif
70 #ifdef ENABLE_LYRICS_SCREEN
71         { 0, CMD_SCREEN_LYRICS, nullptr },
72 #endif
73 #ifdef ENABLE_OUTPUTS_SCREEN
74         { 0, CMD_SCREEN_OUTPUTS, nullptr },
75 #endif
76 #ifdef ENABLE_CHAT_SCREEN
77         { 0, CMD_SCREEN_CHAT, nullptr },
78 #endif
79 #ifdef ENABLE_KEYDEF_SCREEN
80         { 0, CMD_SCREEN_KEYDEF, nullptr },
81 #endif
82
83         { 0, CMD_NONE, nullptr },
84         { 0, CMD_NONE, nullptr },
85         { 1, CMD_NONE, N_("Global") },
86         { 2, CMD_NONE, nullptr },
87         { 0, CMD_STOP, nullptr },
88         { 0, CMD_PAUSE, nullptr },
89         { 0, CMD_CROP, nullptr },
90         { 0, CMD_TRACK_NEXT, nullptr },
91         { 0, CMD_TRACK_PREVIOUS, nullptr },
92         { 0, CMD_SEEK_FORWARD, nullptr },
93         { 0, CMD_SEEK_BACKWARD, nullptr },
94         { 0, CMD_VOLUME_DOWN, nullptr },
95         { 0, CMD_VOLUME_UP, nullptr },
96         { 0, CMD_NONE, nullptr },
97         { 0, CMD_REPEAT, nullptr },
98         { 0, CMD_RANDOM, nullptr },
99         { 0, CMD_SINGLE, nullptr },
100         { 0, CMD_CONSUME, nullptr },
101         { 0, CMD_CROSSFADE, nullptr },
102         { 0, CMD_SHUFFLE, nullptr },
103         { 0, CMD_DB_UPDATE, nullptr },
104         { 0, CMD_NONE, nullptr },
105         { 0, CMD_LIST_FIND, nullptr },
106         { 0, CMD_LIST_RFIND, nullptr },
107         { 0, CMD_LIST_FIND_NEXT, nullptr },
108         { 0, CMD_LIST_RFIND_NEXT, nullptr },
109         { 0, CMD_LIST_JUMP, nullptr },
110         { 0, CMD_TOGGLE_FIND_WRAP, nullptr },
111         { 0, CMD_LOCATE, nullptr },
112 #ifdef ENABLE_SONG_SCREEN
113         { 0, CMD_SCREEN_SONG, nullptr },
114 #endif
115         { 0, CMD_NONE, nullptr },
116         { 0, CMD_QUIT, nullptr },
117
118         { 0, CMD_NONE, nullptr },
119         { 0, CMD_NONE, nullptr },
120         { 1, CMD_NONE, N_("Queue screen") },
121         { 2, CMD_NONE, nullptr },
122         { 0, CMD_PLAY, N_("Play") },
123         { 0, CMD_DELETE, nullptr },
124         { 0, CMD_CLEAR, nullptr },
125         { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
126         { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
127         { 0, CMD_ADD, nullptr },
128         { 0, CMD_SAVE_PLAYLIST, nullptr },
129         { 0, CMD_SCREEN_UPDATE, N_("Center") },
130         { 0, CMD_SELECT_PLAYING, nullptr },
131         { 0, CMD_TOGGLE_AUTOCENTER, nullptr },
132
133         { 0, CMD_NONE, nullptr },
134         { 0, CMD_NONE, nullptr },
135         { 1, CMD_NONE, N_("Browse screen") },
136         { 2, CMD_NONE, nullptr },
137         { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
138         { 0, CMD_SELECT, nullptr },
139         { 0, CMD_ADD, N_("Append song to queue") },
140         { 0, CMD_SAVE_PLAYLIST, nullptr },
141         { 0, CMD_DELETE, N_("Delete playlist") },
142         { 0, CMD_GO_PARENT_DIRECTORY, nullptr },
143         { 0, CMD_GO_ROOT_DIRECTORY, nullptr },
144         { 0, CMD_SCREEN_UPDATE, nullptr },
145
146 #ifdef ENABLE_SEARCH_SCREEN
147         { 0, CMD_NONE, nullptr },
148         { 0, CMD_NONE, nullptr },
149         { 1, CMD_NONE, N_("Search screen") },
150         { 2, CMD_NONE, nullptr },
151         { 0, CMD_SCREEN_SEARCH, N_("Search") },
152         { 0, CMD_PLAY, N_("Select and play") },
153         { 0, CMD_SELECT, nullptr },
154         { 0, CMD_ADD, N_("Append song to queue") },
155         { 0, CMD_SELECT_ALL,     nullptr },
156         { 0, CMD_SEARCH_MODE, nullptr },
157 #endif
158 #ifdef ENABLE_LYRICS_SCREEN
159         { 0, CMD_NONE, nullptr },
160         { 0, CMD_NONE, nullptr },
161         { 1, CMD_NONE, N_("Lyrics screen") },
162         { 2, CMD_NONE, nullptr },
163         { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
164         { 0, CMD_SELECT, N_("(Re)load lyrics") },
165         /* to translators: this hotkey aborts the retrieval of lyrics
166            from the server */
167         { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
168         { 0, CMD_LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
169         { 0, CMD_EDIT, N_("Add or edit lyrics") },
170         { 0, CMD_SAVE_PLAYLIST, N_("Save lyrics") },
171         { 0, CMD_DELETE, N_("Delete saved lyrics") },
172 #endif
173 #ifdef ENABLE_OUTPUTS_SCREEN
174         { 0, CMD_NONE, nullptr },
175         { 0, CMD_NONE, nullptr },
176         { 1, CMD_NONE, N_("Outputs screen") },
177         { 2, CMD_NONE, nullptr },
178         { 0, CMD_PLAY, N_("Enable/disable output") },
179 #endif
180 #ifdef ENABLE_CHAT_SCREEN
181         { 0, CMD_NONE, nullptr },
182         { 0, CMD_NONE, nullptr },
183         { 1, CMD_NONE, N_("Chat screen") },
184         { 2, CMD_NONE, nullptr },
185         { 0, CMD_PLAY, N_("Write a message") },
186 #endif
187 #ifdef ENABLE_KEYDEF_SCREEN
188         { 0, CMD_NONE, nullptr },
189         { 0, CMD_NONE, nullptr },
190         { 1, CMD_NONE, N_("Keydef screen") },
191         { 2, CMD_NONE, nullptr },
192         { 0, CMD_PLAY, N_("Edit keydefs for selected command") },
193         { 0, CMD_DELETE, N_("Remove selected keydef") },
194         { 0, CMD_ADD, N_("Add a keydef") },
195         { 0, CMD_GO_PARENT_DIRECTORY, N_("Go up a level") },
196         { 0, CMD_SAVE_PLAYLIST, N_("Apply and save changes") },
197 #endif
198 };
199
200 class HelpPage final : public ListPage {
201         ScreenManager &screen;
202
203 public:
204         HelpPage(ScreenManager &_screen, WINDOW *w, Size size)
205                 :ListPage(w, size), screen(_screen) {
206                 lw.hide_cursor = true;
207                 lw.SetLength(G_N_ELEMENTS(help_text));
208         }
209
210 public:
211         /* virtual methods from class Page */
212         void Paint() const override;
213         bool OnCommand(struct mpdclient &c, command_t cmd) override;
214
215         const char *GetTitle(char *, size_t) const override {
216                 return _("Help");
217         }
218 };
219
220 static const char *
221 list_callback(unsigned i, gcc_unused void *data)
222 {
223         const struct help_text_row *row = &help_text[i];
224
225         assert(i < G_N_ELEMENTS(help_text));
226
227         if (row->text != nullptr)
228                 return _(row->text);
229
230         if (row->command != CMD_NONE)
231                 return get_key_description(row->command);
232
233         return "";
234 }
235
236 static Page *
237 help_init(ScreenManager &screen, WINDOW *w, Size size)
238 {
239         return new HelpPage(screen, w, size);
240 }
241
242 static void
243 screen_help_paint_callback(WINDOW *w, unsigned i,
244                            unsigned y, unsigned width,
245                            gcc_unused bool selected,
246                            gcc_unused const void *data)
247 {
248         const struct help_text_row *row = &help_text[i];
249
250         assert(i < G_N_ELEMENTS(help_text));
251
252         row_color(w, row->highlight ? COLOR_LIST_BOLD : COLOR_LIST, false);
253
254         wclrtoeol(w);
255
256         if (row->command == CMD_NONE) {
257                 if (row->text != nullptr)
258                         mvwaddstr(w, y, 6, _(row->text));
259                 else if (row->highlight == 2)
260                         mvwhline(w, y, 3, '-', width - 6);
261         } else {
262                 const char *key = get_key_names(row->command, true);
263
264                 if (utf8_width(key) < 20)
265                         wmove(w, y, 20 - utf8_width(key));
266                 waddstr(w, key);
267                 mvwaddch(w, y, 21, ':');
268                 mvwaddstr(w, y, 23,
269                           row->text != nullptr
270                           ? _(row->text)
271                           : get_key_description(row->command));
272         }
273 }
274
275 void
276 HelpPage::Paint() const
277 {
278         lw.Paint(screen_help_paint_callback, nullptr);
279 }
280
281 bool
282 HelpPage::OnCommand(struct mpdclient &c, command_t cmd)
283 {
284         if (ListPage::OnCommand(c, cmd))
285                 return true;
286
287         lw.SetCursor(lw.start);
288         if (screen_find(screen, &lw, cmd, list_callback, nullptr)) {
289                 /* center the row */
290                 lw.Center(lw.selected);
291                 SetDirty();
292                 return true;
293         }
294
295         return false;
296 }
297
298 const struct screen_functions screen_help = {
299         "help",
300         help_init,
301 };