ncurses/widechar/lib_get_wstr.c

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