1 /* $NetBSD: getstr.c,v 1.30 2024/12/23 02:58:03 blymn Exp $ */ 2 3 /* 4 * Copyright (c) 1981, 1993, 1994 5 * The Regents of the University of California. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. Neither the name of the University nor the names of its contributors 16 * may be used to endorse or promote products derived from this software 17 * without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29 * SUCH DAMAGE. 30 */ 31 32 #include <assert.h> 33 #include <sys/cdefs.h> 34 #ifndef lint 35 #if 0 36 static char sccsid[] = "@(#)getstr.c 8.2 (Berkeley) 5/4/94"; 37 #else 38 __RCSID("$NetBSD: getstr.c,v 1.30 2024/12/23 02:58:03 blymn Exp $"); 39 #endif 40 #endif /* not lint */ 41 42 #include <ctype.h> 43 #include "curses.h" 44 #include "curses_private.h" 45 46 #ifndef _CURSES_USE_MACROS 47 48 /* 49 * getnstr -- 50 * Get a string (of maximum n) characters from stdscr starting at 51 * (cury, curx). 52 */ 53 int 54 getnstr(char *str, int n) 55 { 56 return wgetnstr(stdscr, str, n); 57 } 58 59 /* 60 * getstr -- 61 * Get a string from stdscr starting at (cury, curx). 62 */ 63 __warn_references(getstr, 64 "warning: this program uses getstr(), which is unsafe.") 65 int 66 getstr(char *str) 67 { 68 return wgetstr(stdscr, str); 69 } 70 71 /* 72 * mvgetnstr -- 73 * Get a string (of maximum n) characters from stdscr starting at (y, x). 74 */ 75 int 76 mvgetnstr(int y, int x, char *str, int n) 77 { 78 return mvwgetnstr(stdscr, y, x, str, n); 79 } 80 81 /* 82 * mvgetstr -- 83 * Get a string from stdscr starting at (y, x). 84 */ 85 __warn_references(mvgetstr, 86 "warning: this program uses mvgetstr(), which is unsafe.") 87 int 88 mvgetstr(int y, int x, char *str) 89 { 90 return mvwgetstr(stdscr, y, x, str); 91 } 92 93 /* 94 * mvwgetnstr -- 95 * Get a string (of maximum n) characters from the given window starting 96 * at (y, x). 97 */ 98 int 99 mvwgetnstr(WINDOW *win, int y, int x, char *str, int n) 100 { 101 if (wmove(win, y, x) == ERR) 102 return ERR; 103 104 return wgetnstr(win, str, n); 105 } 106 107 /* 108 * mvwgetstr -- 109 * Get a string from the given window starting at (y, x). 110 */ 111 __warn_references(mvgetstr, 112 "warning: this program uses mvgetstr(), which is unsafe.") 113 int 114 mvwgetstr(WINDOW *win, int y, int x, char *str) 115 { 116 if (wmove(win, y, x) == ERR) 117 return ERR; 118 119 return wgetstr(win, str); 120 } 121 122 #endif 123 124 /* 125 * wgetstr -- 126 * Get a string starting at (cury, curx). 127 */ 128 __warn_references(wgetstr, 129 "warning: this program uses wgetstr(), which is unsafe.") 130 int 131 wgetstr(WINDOW *win, char *str) 132 { 133 return __wgetnstr(win, str, -1); 134 } 135 136 /* 137 * wgetnstr -- 138 * Get a string starting at (cury, curx). 139 * Note that n < 2 means that we return ERR (SUSv2 specification). 140 */ 141 int 142 wgetnstr(WINDOW *win, char *str, int n) 143 { 144 if (n < 1) 145 return ERR; 146 if (n == 1) { 147 str[0] = '\0'; 148 return ERR; 149 } 150 return __wgetnstr(win, str, n); 151 } 152 153 /* 154 * __wgetnstr -- 155 * The actual implementation. 156 * Note that we include a trailing '\0' for safety, so str will contain 157 * at most n - 1 other characters. 158 * XXX: character deletion from screen is based on how the characters 159 * are displayed by wgetch(). 160 */ 161 int 162 __wgetnstr(WINDOW *win, char *str, int n) 163 { 164 char *ostr, ec, kc; 165 int c, xpos, oldx, remain; 166 167 if (__predict_false(win == NULL)) 168 return ERR; 169 170 ostr = str; 171 ec = erasechar(); 172 kc = killchar(); 173 xpos = oldx = win->curx; 174 _DIAGASSERT(n == -1 || n > 1); 175 remain = n - 1; 176 177 while ((c = wgetch(win)) != ERR && c != '\n' && c != '\r') { 178 __CTRACE(__CTRACE_INPUT, 179 "__wgetnstr: win %p, char 0x%x, remain %d\n", 180 win, c, remain); 181 *str = c; 182 __touchline(win, win->cury, 0, (int) win->maxx - 1); 183 if (c == ec || c == KEY_BACKSPACE || c == KEY_LEFT) { 184 *str = '\0'; 185 if (str != ostr) { 186 if ((char) c == ec) { 187 mvwaddch(win, win->cury, xpos, ' '); 188 if (xpos > oldx) 189 mvwaddch(win, win->cury, 190 xpos - 1, ' '); 191 if (win->curx > xpos - 1) 192 wmove(win, win->cury, xpos - 1); 193 xpos--; 194 } 195 if (c == KEY_BACKSPACE || c == KEY_LEFT) { 196 /* getch() displays the key sequence */ 197 mvwaddch(win, win->cury, win->curx, 198 ' '); 199 mvwaddch(win, win->cury, win->curx - 1, 200 ' '); 201 if (win->curx > xpos) 202 wmove(win, win->cury, xpos - 1); 203 xpos--; 204 } 205 str--; 206 if (n != -1) { 207 /* We're counting chars */ 208 remain++; 209 } 210 } else { /* str == ostr */ 211 /* getch() displays the other keys */ 212 if (win->curx > oldx) 213 mvwaddch(win, win->cury, win->curx - 1, 214 ' '); 215 wmove(win, win->cury, oldx); 216 xpos = oldx; 217 } 218 } else if (c == kc) { 219 *str = '\0'; 220 if (str != ostr) { 221 /* getch() displays the kill character */ 222 mvwaddch(win, win->cury, win->curx - 1, ' '); 223 /* Clear the characters from screen and str */ 224 while (str != ostr) { 225 mvwaddch(win, win->cury, win->curx - 1, 226 ' '); 227 wmove(win, win->cury, win->curx - 1); 228 str--; 229 if (n != -1) 230 /* We're counting chars */ 231 remain++; 232 } 233 mvwaddch(win, win->cury, win->curx - 1, ' '); 234 wmove(win, win->cury, win->curx - 1); 235 } else 236 /* getch() displays the kill character */ 237 mvwaddch(win, win->cury, oldx, ' '); 238 wmove(win, win->cury, oldx); 239 } else if (c >= KEY_MIN && c <= KEY_MAX) { 240 /* getch() displays these characters */ 241 mvwaddch(win, win->cury, xpos, ' '); 242 wmove(win, win->cury, xpos); 243 } else { 244 if (remain) { 245 if (iscntrl((unsigned char)c)) 246 mvwaddch(win, win->cury, xpos, ' '); 247 str++; 248 xpos++; 249 remain--; 250 } else 251 mvwaddch(win, win->cury, xpos, ' '); 252 wmove(win, win->cury, xpos); 253 } 254 } 255 256 if (c == ERR) { 257 *str = '\0'; 258 return ERR; 259 } 260 *str = '\0'; 261 return OK; 262 } 263