wreadln: convert functions to methods
[ncmpc-debian.git] / src / wreadln.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 "wreadln.hxx"
21 #include "Completion.hxx"
22 #include "charset.hxx"
23 #include "screen_utils.hxx"
24 #include "Point.hxx"
25 #include "config.h"
26 #include "util/LocaleString.hxx"
27 #include "util/StringUTF8.hxx"
28
29 #include <string>
30
31 #include <assert.h>
32 #include <stdlib.h>
33 #include <string.h>
34
35 #if (defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)) && !defined(_WIN32)
36 #include <sys/poll.h>
37 #endif
38
39 #define KEY_CTRL_A   1
40 #define KEY_CTRL_B   2
41 #define KEY_CTRL_C   3
42 #define KEY_CTRL_D   4
43 #define KEY_CTRL_E   5
44 #define KEY_CTRL_F   6
45 #define KEY_CTRL_G   7
46 #define KEY_CTRL_K   11
47 #define KEY_CTRL_N   14
48 #define KEY_CTRL_P   16
49 #define KEY_CTRL_U   21
50 #define KEY_CTRL_W   23
51 #define KEY_CTRL_Z   26
52 #define KEY_BCKSPC   8
53 #define TAB          9
54
55 struct wreadln {
56         /** the ncurses window where this field is displayed */
57         WINDOW *const w;
58
59         /** the origin coordinates in the window */
60         Point point;
61
62         /** the screen width of the input field */
63         unsigned width;
64
65         /** is the input masked, i.e. characters displayed as '*'? */
66         const bool masked;
67
68         /** the byte position of the cursor */
69         size_t cursor = 0;
70
71         /** the byte position displayed at the origin (for horizontal
72             scrolling) */
73         size_t start = 0;
74
75         /** the current value */
76         std::string value;
77
78         wreadln(WINDOW *_w, bool _masked)
79                 :w(_w), masked(_masked) {}
80
81         /** draw line buffer and update cursor position */
82         void Paint() const;
83
84         /** returns the screen column where the cursor is located */
85         gcc_pure
86         unsigned GetCursorColumn() const;
87
88         /** move the cursor one step to the right */
89         void MoveCursorRight();
90
91         /** move the cursor one step to the left */
92         void MoveCursorLeft();
93
94         /** move the cursor to the end of the line */
95         void MoveCursorToEnd();
96
97         void InsertByte(int key);
98         void DeleteChar(size_t x);
99         void DeleteChar() {
100                 DeleteChar(cursor);
101         }
102 };
103
104 /** max items stored in the history list */
105 static constexpr std::size_t wrln_max_history_length = 32;
106
107 /** converts a byte position to a screen column */
108 gcc_pure
109 static unsigned
110 byte_to_screen(const char *data, size_t x)
111 {
112 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
113         assert(x <= strlen(data));
114
115         return StringWidthMB(data, x);
116 #else
117         (void)data;
118
119         return (unsigned)x;
120 #endif
121 }
122
123 /** finds the first character which doesn't fit on the screen */
124 gcc_pure
125 static size_t
126 screen_to_bytes(const char *data, unsigned width)
127 {
128 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
129         size_t length = strlen(data);
130
131         while (true) {
132                 unsigned p_width = StringWidthMB(data, length);
133                 if (p_width <= width)
134                         return length;
135
136                 --length;
137         }
138 #else
139         (void)data;
140
141         return (size_t)width;
142 #endif
143 }
144
145 unsigned
146 wreadln::GetCursorColumn() const
147 {
148         return byte_to_screen(value.data() + start, cursor - start);
149 }
150
151 /** returns the offset in the string to align it at the right border
152     of the screen */
153 gcc_pure
154 static inline size_t
155 right_align_bytes(const char *data, size_t right, unsigned width)
156 {
157 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
158         size_t start = 0;
159
160         assert(right <= strlen(data));
161
162         while (start < right) {
163                 if (StringWidthMB(data + start, right - start) < width)
164                         break;
165
166                 start += CharSizeMB(data + start, right - start);
167         }
168
169         return start;
170 #else
171         (void)data;
172
173         return right >= width ? right + 1 - width : 0;
174 #endif
175 }
176
177 void
178 wreadln::MoveCursorRight()
179 {
180         if (cursor == value.length())
181                 return;
182
183         size_t size = CharSizeMB(value.data() + cursor,
184                                  value.length() - cursor);
185         cursor += size;
186         if (GetCursorColumn() >= width)
187                 start = right_align_bytes(value.c_str(), cursor, width);
188 }
189
190 void
191 wreadln::MoveCursorLeft()
192 {
193         const char *v = value.c_str();
194         const char *new_cursor = PrevCharMB(v, v + cursor);
195         cursor = new_cursor - v;
196         if (cursor < start)
197                 start = cursor;
198 }
199
200 void
201 wreadln::MoveCursorToEnd()
202 {
203         cursor = value.length();
204         if (GetCursorColumn() >= width)
205                 start = right_align_bytes(value.c_str(),
206                                               cursor, width);
207 }
208
209 void
210 wreadln::Paint() const
211 {
212         wmove(w, point.y, point.x);
213         /* clear input area */
214         whline(w, ' ', width);
215         /* print visible part of the line buffer */
216         if (masked)
217                 whline(w, '*', utf8_width(value.c_str() + start));
218         else
219                 waddnstr(w, value.c_str() + start,
220                          screen_to_bytes(value.c_str(), width));
221         /* move the cursor to the correct position */
222         wmove(w, point.y, point.x + GetCursorColumn());
223         /* tell ncurses to redraw the screen */
224         doupdate();
225 }
226
227 void
228 wreadln::InsertByte(int key)
229 {
230         size_t length = 1;
231 #if (defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)) && !defined(_WIN32)
232         char buffer[32] = { (char)key };
233         struct pollfd pfd = {
234                 .fd = 0,
235                 .events = POLLIN,
236                 .revents = 0,
237         };
238
239         /* wide version: try to complete the multibyte sequence */
240
241         while (length < sizeof(buffer)) {
242                 if (!IsIncompleteCharMB(buffer, length))
243                         /* sequence is complete */
244                         break;
245
246                 /* poll for more bytes on stdin, without timeout */
247
248                 if (poll(&pfd, 1, 0) <= 0)
249                         /* no more input from keyboard */
250                         break;
251
252                 buffer[length++] = wgetch(w);
253         }
254
255         value.insert(cursor, buffer, length);
256
257 #else
258         value.insert(cursor, key);
259 #endif
260
261         cursor += length;
262         if (GetCursorColumn() >= width)
263                 start = right_align_bytes(value.c_str(), cursor, width);
264 }
265
266 void
267 wreadln::DeleteChar(size_t x)
268 {
269         assert(x < value.length());
270
271         size_t length = CharSizeMB(value.data() + x, value.length() - x);
272         value.erase(x, length);
273 }
274
275 /* libcurses version */
276
277 static std::string
278 _wreadln(WINDOW *w,
279          const char *prompt,
280          const char *initial_value,
281          unsigned x1,
282          History *history,
283          Completion *completion,
284          bool masked)
285 {
286         struct wreadln wr(w, masked);
287         History::iterator hlist, hcurrent;
288
289 #ifdef NCMPC_MINI
290         (void)completion;
291 #endif
292
293         /* turn off echo */
294         noecho();
295         /* make sure the cursor is visible */
296         curs_set(1);
297         /* print prompt string */
298         if (prompt) {
299                 waddstr(w, prompt);
300                 waddstr(w, ": ");
301         }
302         /* retrieve y and x0 position */
303         getyx(w, wr.point.y, wr.point.x);
304         /* check the x1 value */
305         if (x1 <= (unsigned)wr.point.x || x1 > (unsigned)COLS)
306                 x1 = COLS;
307         wr.width = x1 - wr.point.x;
308         /* clear input area */
309         mvwhline(w, wr.point.y, wr.point.x, ' ', wr.width);
310
311         if (history) {
312                 /* append the a new line to our history list */
313                 history->emplace_back();
314                 /* hlist points to the current item in the history list */
315                 hcurrent = hlist = std::prev(history->end());
316         }
317
318         if (initial_value == (char *)-1) {
319                 /* get previous history entry */
320                 if (history && hlist != history->begin()) {
321                         /* get previous line */
322                         --hlist;
323                         wr.value = *hlist;
324                 }
325                 wr.MoveCursorToEnd();
326                 wr.Paint();
327         } else if (initial_value) {
328                 /* copy the initial value to the line buffer */
329                 wr.value = initial_value;
330                 wr.MoveCursorToEnd();
331                 wr.Paint();
332         }
333
334         int key = 0;
335         while (key != 13 && key != '\n') {
336                 key = wgetch(w);
337
338                 /* check if key is a function key */
339                 for (size_t i = 0; i < 63; i++)
340                         if (key == (int)KEY_F(i)) {
341                                 key = KEY_F(1);
342                                 i = 64;
343                         }
344
345                 switch (key) {
346 #ifdef HAVE_GETMOUSE
347                 case KEY_MOUSE: /* ignore mouse events */
348 #endif
349                 case ERR: /* ignore errors */
350                         break;
351
352                 case TAB:
353 #ifndef NCMPC_MINI
354                         if (completion != nullptr) {
355                                 completion->Pre(wr.value.c_str());
356                                 auto r = completion->Complete(wr.value.c_str());
357                                 if (!r.new_prefix.empty()) {
358                                         wr.value = std::move(r.new_prefix);
359                                         wr.MoveCursorToEnd();
360                                 } else
361                                         screen_bell();
362
363                                 completion->Post(wr.value.c_str(), r.range);
364                         }
365 #endif
366                         break;
367
368                 case KEY_CTRL_G:
369                         screen_bell();
370                         if (history) {
371                                 history->pop_back();
372                         }
373                         return {};
374
375                 case KEY_LEFT:
376                 case KEY_CTRL_B:
377                         wr.MoveCursorLeft();
378                         break;
379                 case KEY_RIGHT:
380                 case KEY_CTRL_F:
381                         wr.MoveCursorRight();
382                         break;
383                 case KEY_HOME:
384                 case KEY_CTRL_A:
385                         wr.cursor = 0;
386                         wr.start = 0;
387                         break;
388                 case KEY_END:
389                 case KEY_CTRL_E:
390                         wr.MoveCursorToEnd();
391                         break;
392                 case KEY_CTRL_K:
393                         wr.value.erase(wr.cursor);
394                         break;
395                 case KEY_CTRL_U:
396                         wr.value.erase(0, wr.cursor);
397                         wr.cursor = 0;
398                         break;
399                 case KEY_CTRL_W:
400                         /* Firstly remove trailing spaces. */
401                         for (; wr.cursor > 0 && wr.value[wr.cursor - 1] == ' ';)
402                         {
403                                 wr.MoveCursorLeft();
404                                 wr.DeleteChar();
405                         }
406                         /* Then remove word until next space. */
407                         for (; wr.cursor > 0 && wr.value[wr.cursor - 1] != ' ';)
408                         {
409                                 wr.MoveCursorLeft();
410                                 wr.DeleteChar();
411                         }
412                         break;
413                 case 127:
414                 case KEY_BCKSPC:        /* handle backspace: copy all */
415                 case KEY_BACKSPACE:     /* chars starting from curpos */
416                         if (wr.cursor > 0) { /* - 1 from buf[n+1] to buf   */
417                                 wr.MoveCursorLeft();
418                                 wr.DeleteChar();
419                         }
420                         break;
421                 case KEY_DC:            /* handle delete key. As above */
422                 case KEY_CTRL_D:
423                         if (wr.cursor < wr.value.length())
424                                 wr.DeleteChar();
425                         break;
426                 case KEY_UP:
427                 case KEY_CTRL_P:
428                         /* get previous history entry */
429                         if (history && hlist != history->begin()) {
430                                 if (hlist == hcurrent)
431                                         /* save the current line */
432                                         *hlist = wr.value;
433
434                                 /* get previous line */
435                                 --hlist;
436                                 wr.value = *hlist;
437                         }
438                         wr.MoveCursorToEnd();
439                         break;
440                 case KEY_DOWN:
441                 case KEY_CTRL_N:
442                         /* get next history entry */
443                         if (history && std::next(hlist) != history->end()) {
444                                 /* get next line */
445                                 ++hlist;
446                                 wr.value = *hlist;
447                         }
448                         wr.MoveCursorToEnd();
449                         break;
450
451                 case '\n':
452                 case 13:
453                 case KEY_IC:
454                 case KEY_PPAGE:
455                 case KEY_NPAGE:
456                 case KEY_F(1):
457                         /* ignore char */
458                         break;
459                 default:
460                         if (key >= 32)
461                                 wr.InsertByte(key);
462                 }
463
464                 wr.Paint();
465         }
466
467         /* update history */
468         if (history) {
469                 if (!wr.value.empty()) {
470                         /* update the current history entry */
471                         *hcurrent = wr.value;
472                 } else {
473                         /* the line was empty - remove the current history entry */
474                         history->erase(hcurrent);
475                 }
476
477                 auto history_length = history->size();
478                 while (history_length > wrln_max_history_length) {
479                         history->pop_front();
480                         --history_length;
481                 }
482         }
483
484         return std::move(wr.value);
485 }
486
487 std::string
488 wreadln(WINDOW *w,
489         const char *prompt,
490         const char *initial_value,
491         unsigned x1,
492         History *history,
493         Completion *completion)
494 {
495         return  _wreadln(w, prompt, initial_value, x1,
496                          history, completion, false);
497 }
498
499 std::string
500 wreadln_masked(WINDOW *w,
501                const char *prompt,
502                const char *initial_value,
503                unsigned x1)
504 {
505         return  _wreadln(w, prompt, initial_value, x1, nullptr, nullptr, true);
506 }