ncurses 6.2 - patch 20200301
[ncurses.git] / ncurses / widechar / lib_get_wch.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 2002-2011,2016 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Thomas E. Dickey 2002-on                                        *
32  ****************************************************************************/
33
34 /*
35 **      lib_get_wch.c
36 **
37 **      The routine get_wch().
38 **
39 */
40
41 #include <curses.priv.h>
42 #include <ctype.h>
43
44 MODULE_ID("$Id: lib_get_wch.c,v 1.25 2020/02/02 23:34:34 tom Exp $")
45
46 NCURSES_EXPORT(int)
47 wget_wch(WINDOW *win, wint_t *result)
48 {
49     SCREEN *sp;
50     int code;
51     int value = 0;
52     wchar_t wch;
53 #ifndef state_unused
54     mbstate_t state;
55 #endif
56
57     T((T_CALLED("wget_wch(%p)"), (void *) win));
58
59     /*
60      * We can get a stream of single-byte characters and KEY_xxx codes from
61      * _nc_wgetch(), while we want to return a wide character or KEY_xxx code.
62      */
63     _nc_lock_global(curses);
64     sp = _nc_screen_of(win);
65
66     if (sp != 0) {
67         size_t count = 0;
68
69         for (;;) {
70             char buffer[(MB_LEN_MAX * 9) + 1];  /* allow some redundant shifts */
71
72             T(("reading %d of %d", (int) count + 1, (int) sizeof(buffer)));
73             code = _nc_wgetch(win, &value, TRUE EVENTLIST_2nd((_nc_eventlist
74                                                                *) 0));
75             if (code == ERR) {
76                 break;
77             } else if (code == KEY_CODE_YES) {
78                 /*
79                  * If we were processing an incomplete multibyte character,
80                  * return an error since we have a KEY_xxx code which
81                  * interrupts it.  For some cases, we could improve this by
82                  * writing a new version of lib_getch.c(!), but it is not clear
83                  * whether the improvement would be worth the effort.
84                  */
85                 if (count != 0) {
86                     safe_ungetch(SP_PARM, value);
87                     code = ERR;
88                 }
89                 break;
90             } else if (count + 1 >= sizeof(buffer)) {
91                 safe_ungetch(SP_PARM, value);
92                 code = ERR;
93                 break;
94             } else {
95                 int status;
96
97                 buffer[count++] = (char) UChar(value);
98                 reset_mbytes(state);
99                 status = count_mbytes(buffer, count, state);
100                 if (status >= 0) {
101                     reset_mbytes(state);
102                     if (check_mbytes(wch, buffer, count, state) != status) {
103                         code = ERR;     /* the two calls should match */
104                         safe_ungetch(SP_PARM, value);
105                     }
106                     value = wch;
107                     break;
108                 }
109             }
110         }
111     } else {
112         code = ERR;
113     }
114
115     if (result != 0)
116         *result = (wint_t) value;
117
118     _nc_unlock_global(curses);
119     T(("result %#o", value));
120     returnCode(code);
121 }