1 /**************************************************************************** 2 * Copyright 2018,2020 Thomas E. Dickey * 3 * Copyright 1998-2011,2017 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 * 32 * and: Eric S. Raymond <esr@snark.thyrsus.com> * 33 ****************************************************************************/ 34 35 /* 36 ** lib_getstr.c 37 ** 38 ** The routine wgetstr(). 39 ** 40 */ 41 42 #include <curses.priv.h> 43 44 MODULE_ID("$Id: lib_getstr.c,v 1.34 2020/02/02 23:34:34 tom Exp $") 45 46 /* 47 * This wipes out the last character, no matter whether it was a tab, control 48 * or other character, and handles reverse wraparound. 49 */ 50 static char * 51 WipeOut(WINDOW *win, int y, int x, char *first, char *last, int echoed) 52 { 53 if (last > first) { 54 *--last = '\0'; 55 if (echoed) { 56 int y1 = win->_cury; 57 int x1 = win->_curx; 58 59 wmove(win, y, x); 60 waddstr(win, first); 61 getyx(win, y, x); 62 while (win->_cury < y1 63 || (win->_cury == y1 && win->_curx < x1)) 64 waddch(win, (chtype) ' '); 65 66 wmove(win, y, x); 67 } 68 } 69 return last; 70 } 71 72 NCURSES_EXPORT(int) 73 wgetnstr_events(WINDOW *win, 74 char *str, 75 int maxlen, 76 EVENTLIST_1st(_nc_eventlist * evl)) 77 { 78 SCREEN *sp = _nc_screen_of(win); 79 TTY buf; 80 bool oldnl, oldecho, oldraw, oldcbreak; 81 char erasec; 82 char killc; 83 char *oldstr; 84 int ch; 85 int y, x; 86 87 T((T_CALLED("wgetnstr(%p,%p,%d)"), (void *) win, (void *) str, maxlen)); 88 89 if (!win || !str) 90 returnCode(ERR); 91 92 maxlen = _nc_getstr_limit(maxlen); 93 94 NCURSES_SP_NAME(_nc_get_tty_mode) (NCURSES_SP_ARGx &buf); 95 96 oldnl = sp->_nl; 97 oldecho = sp->_echo; 98 oldraw = sp->_raw; 99 oldcbreak = sp->_cbreak; 100 NCURSES_SP_NAME(nl) (NCURSES_SP_ARG); 101 NCURSES_SP_NAME(noecho) (NCURSES_SP_ARG); 102 NCURSES_SP_NAME(noraw) (NCURSES_SP_ARG); 103 NCURSES_SP_NAME(cbreak) (NCURSES_SP_ARG); 104 105 erasec = NCURSES_SP_NAME(erasechar) (NCURSES_SP_ARG); 106 killc = NCURSES_SP_NAME(killchar) (NCURSES_SP_ARG); 107 108 oldstr = str; 109 getyx(win, y, x); 110 111 if (is_wintouched(win) || (win->_flags & _HASMOVED)) 112 wrefresh(win); 113 114 while ((ch = wgetch_events(win, evl)) != ERR) { 115 /* 116 * Some terminals (the Wyse-50 is the most common) generate 117 * a \n from the down-arrow key. With this logic, it's the 118 * user's choice whether to set kcud=\n for wgetch(); 119 * terminating *getstr() with \n should work either way. 120 */ 121 if (ch == '\n' 122 || ch == '\r' 123 || ch == KEY_DOWN 124 || ch == KEY_ENTER) { 125 if (oldecho == TRUE 126 && win->_cury == win->_maxy 127 && win->_scroll) 128 wechochar(win, (chtype) '\n'); 129 break; 130 } 131 #ifdef KEY_EVENT 132 if (ch == KEY_EVENT) 133 break; 134 #endif 135 #ifdef KEY_RESIZE 136 if (ch == KEY_RESIZE) 137 break; 138 #endif 139 if (ch == erasec || ch == KEY_LEFT || ch == KEY_BACKSPACE) { 140 if (str > oldstr) { 141 str = WipeOut(win, y, x, oldstr, str, oldecho); 142 } 143 } else if (ch == killc) { 144 while (str > oldstr) { 145 str = WipeOut(win, y, x, oldstr, str, oldecho); 146 } 147 } else if (ch >= KEY_MIN 148 || (str - oldstr >= maxlen)) { 149 NCURSES_SP_NAME(beep) (NCURSES_SP_ARG); 150 } else { 151 *str++ = (char) ch; 152 if (oldecho == TRUE) { 153 int oldy = win->_cury; 154 if (waddch(win, (chtype) ch) == ERR) { 155 /* 156 * We can't really use the lower-right 157 * corner for input, since it'll mess 158 * up bookkeeping for erases. 159 */ 160 win->_flags &= ~_WRAPPED; 161 waddch(win, (chtype) ' '); 162 str = WipeOut(win, y, x, oldstr, str, oldecho); 163 continue; 164 } else if (win->_flags & _WRAPPED) { 165 /* 166 * If the last waddch forced a wrap & 167 * scroll, adjust our reference point 168 * for erasures. 169 */ 170 if (win->_scroll 171 && oldy == win->_maxy 172 && win->_cury == win->_maxy) { 173 if (--y <= 0) { 174 y = 0; 175 } 176 } 177 win->_flags &= ~_WRAPPED; 178 } 179 wrefresh(win); 180 } 181 } 182 } 183 184 win->_curx = 0; 185 win->_flags &= ~_WRAPPED; 186 if (win->_cury < win->_maxy) 187 win->_cury++; 188 wrefresh(win); 189 190 /* Restore with a single I/O call, to fix minor asymmetry between 191 * raw/noraw, etc. 192 */ 193 sp->_nl = oldnl; 194 sp->_echo = oldecho; 195 sp->_raw = oldraw; 196 sp->_cbreak = oldcbreak; 197 198 NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf); 199 200 *str = '\0'; 201 if (ch == ERR) 202 returnCode(ch); 203 204 T(("wgetnstr returns %s", _nc_visbuf(oldstr))); 205 206 #ifdef KEY_EVENT 207 if (ch == KEY_EVENT) 208 returnCode(ch); 209 #endif 210 #ifdef KEY_RESIZE 211 if (ch == KEY_RESIZE) 212 returnCode(ch); 213 #endif 214 215 returnCode(OK); 216 } 217 218 #ifdef NCURSES_WGETCH_EVENTS 219 NCURSES_EXPORT(int) 220 wgetnstr(WINDOW *win, char *str, int maxlen) 221 { 222 returnCode(wgetnstr_events(win, 223 str, 224 maxlen, 225 EVENTLIST_1st((_nc_eventlist *) 0))); 226 } 227 #endif 228