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