ncurses/base/lib_getstr.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
  31  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
  32  ****************************************************************************/
  33
  34 /*
  35 **      lib_getstr.c
  36 **
  37 **      The routine wgetstr().
  38 **
  39 */
  40
  41 #include <curses.priv.h>
  42 #include <term.h>
  43
  44 MODULE_ID("$Id: lib_getstr.c,v 1.27 2008/08/16 19:20:04 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, bool 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)"), win, str, maxlen));
  88
  89     if (!win)
  90         returnCode(ERR);
  91
  92     _nc_get_tty_mode(&buf);
  93
  94     oldnl = sp->_nl;
  95     oldecho = sp->_echo;
  96     oldraw = sp->_raw;
  97     oldcbreak = sp->_cbreak;
  98     nl();
  99     noecho();
 100     noraw();
 101     cbreak();
 102
 103     erasec = erasechar();
 104     killc = killchar();
 105
 106     oldstr = str;
 107     getyx(win, y, x);
 108
 109     if (is_wintouched(win) || (win->_flags & _HASMOVED))
 110         wrefresh(win);
 111
 112     while ((ch = wgetch_events(win, evl)) != ERR) {
 113         /*
 114          * Some terminals (the Wyse-50 is the most common) generate
 115          * a \n from the down-arrow key.  With this logic, it's the
 116          * user's choice whether to set kcud=\n for wgetch();
 117          * terminating *getstr() with \n should work either way.
 118          */
 119         if (ch == '\n'
 120             || ch == '\r'
 121             || ch == KEY_DOWN
 122             || ch == KEY_ENTER) {
 123             if (oldecho == TRUE
 124                 && win->_cury == win->_maxy
 125                 && win->_scroll)
 126                 wechochar(win, (chtype) '\n');
 127             break;
 128         }
 129 #ifdef KEY_EVENT
 130         if (ch == KEY_EVENT)
 131             break;
 132 #endif
 133 #ifdef KEY_RESIZE
 134         if (ch == KEY_RESIZE)
 135             break;
 136 #endif
 137         if (ch == erasec || ch == KEY_LEFT || ch == KEY_BACKSPACE) {
 138             if (str > oldstr) {
 139                 str = WipeOut(win, y, x, oldstr, str, oldecho);
 140             }
 141         } else if (ch == killc) {
 142             while (str > oldstr) {
 143                 str = WipeOut(win, y, x, oldstr, str, oldecho);
 144             }
 145         } else if (ch >= KEY_MIN
 146                    || (maxlen >= 0 && str - oldstr >= maxlen)) {
 147             beep();
 148         } else {
 149             *str++ = (char) ch;
 150             if (oldecho == TRUE) {
 151                 int oldy = win->_cury;
 152                 if (waddch(win, (chtype) ch) == ERR) {
 153                     /*
 154                      * We can't really use the lower-right
 155                      * corner for input, since it'll mess
 156                      * up bookkeeping for erases.
 157                      */
 158                     win->_flags &= ~_WRAPPED;
 159                     waddch(win, (chtype) ' ');
 160                     str = WipeOut(win, y, x, oldstr, str, oldecho);
 161                     continue;
 162                 } else if (win->_flags & _WRAPPED) {
 163                     /*
 164                      * If the last waddch forced a wrap &
 165                      * scroll, adjust our reference point
 166                      * for erasures.
 167                      */
 168                     if (win->_scroll
 169                         && oldy == win->_maxy
 170                         && win->_cury == win->_maxy) {
 171                         if (--y <= 0) {
 172                             y = 0;
 173                         }
 174                     }
 175                     win->_flags &= ~_WRAPPED;
 176                 }
 177                 wrefresh(win);
 178             }
 179         }
 180     }
 181
 182     win->_curx = 0;
 183     win->_flags &= ~_WRAPPED;
 184     if (win->_cury < win->_maxy)
 185         win->_cury++;
 186     wrefresh(win);
 187
 188     /* Restore with a single I/O call, to fix minor asymmetry between
 189      * raw/noraw, etc.
 190      */
 191     sp->_nl = oldnl;
 192     sp->_echo = oldecho;
 193     sp->_raw = oldraw;
 194     sp->_cbreak = oldcbreak;
 195
 196     _nc_set_tty_mode(&buf);
 197
 198     *str = '\0';
 199     if (ch == ERR)
 200         returnCode(ch);
 201
 202     T(("wgetnstr returns %s", _nc_visbuf(oldstr)));
 203
 204 #ifdef KEY_EVENT
 205     if (ch == KEY_EVENT)
 206         returnCode(ch);
 207 #endif
 208 #ifdef KEY_RESIZE
 209     if (ch == KEY_RESIZE)
 210         returnCode(ch);
 211 #endif
 212
 213     returnCode(OK);
 214 }
 215
 216 #ifdef NCURSES_WGETCH_EVENTS
 217 NCURSES_EXPORT(int)
 218 wgetnstr(WINDOW *win, char *str, int maxlen)
 219 {
 220     returnCode(wgetnstr_events(win,
 221                                str,
 222                                maxlen,
 223                                EVENTLIST_1st((_nc_eventlist *) 0)));
 224 }
 225 #endif