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