ncurses/tinfo/lib_raw.c

   1 /****************************************************************************
   2  * Copyright 2020-2023,2024 Thomas E. Dickey                                *
   3  * Copyright 1998-2016,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  *     and: Thomas E. Dickey                        1998-on                 *
  34  *     and: Juergen Pfeifer                         2009                    *
  35  ****************************************************************************/
  36
  37 /*
  38  *      raw.c
  39  *
  40  *      Routines:
  41  *              raw()
  42  *              cbreak()
  43  *              noraw()
  44  *              nocbreak()
  45  *              qiflush()
  46  *              noqiflush()
  47  *              intrflush()
  48  *
  49  */
  50
  51 #include <curses.priv.h>
  52
  53 MODULE_ID("$Id: lib_raw.c,v 1.30 2024/03/30 15:54:17 tom Exp $")
  54
  55 #if HAVE_SYS_TERMIO_H
  56 #include <sys/termio.h>         /* needed for ISC */
  57 #endif
  58
  59 #ifdef __EMX__
  60 #include <io.h>
  61 #define _nc_setmode(mode) setmode(SP_PARM->_ifd, mode)
  62 #else
  63 #define _nc_setmode(mode)       /* nothing */
  64 #endif
  65
  66 #if USE_KLIBC_KBD
  67 #define INCL_KBD
  68 #include <os2.h>
  69 #endif
  70
  71 #define COOKED_INPUT    (IXON|BRKINT|PARMRK)
  72
  73 #ifdef TRACE
  74 #define BEFORE(N)       if (USE_TRACEF(TRACE_BITS)) _nc_locked_tracef("%s before bits: %s", N, _nc_tracebits())
  75 #define AFTER(N)        if (USE_TRACEF(TRACE_BITS)) _nc_locked_tracef("%s after bits: %s", N, _nc_tracebits())
  76 #else
  77 #define BEFORE(s)
  78 #define AFTER(s)
  79 #endif /* TRACE */
  80
  81 NCURSES_EXPORT(int)
  82 NCURSES_SP_NAME(raw) (NCURSES_SP_DCL0)
  83 {
  84     int result = ERR;
  85     TERMINAL *termp;
  86
  87     T((T_CALLED("raw(%p)"), (void *) SP_PARM));
  88     if ((termp = TerminalOf(SP_PARM)) != 0) {
  89         TTY buf;
  90
  91         BEFORE("raw");
  92         _nc_setmode(O_BINARY);
  93
  94         buf = termp->Nttyb;
  95 #ifdef TERMIOS
  96         buf.c_lflag &= (unsigned) ~(ICANON | ISIG | IEXTEN);
  97         buf.c_iflag &= (unsigned) ~(COOKED_INPUT);
  98         buf.c_cc[VMIN] = 1;
  99         buf.c_cc[VTIME] = 0;
 100 #elif defined(EXP_WIN32_DRIVER)
 101         buf.dwFlagIn &= (unsigned long) ~CONMODE_NORAW;
 102 #else
 103         buf.sg_flags |= RAW;
 104 #endif
 105         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 106         if (result == OK) {
 107 #if USE_KLIBC_KBD
 108             KBDINFO kbdinfo;
 109
 110             kbdinfo.cb = sizeof(kbdinfo);
 111             KbdGetStatus(&kbdinfo, 0);
 112
 113             kbdinfo.cb = sizeof(kbdinfo);
 114             kbdinfo.fsMask &= ~KEYBOARD_ASCII_MODE;
 115             kbdinfo.fsMask |= KEYBOARD_BINARY_MODE;
 116             KbdSetStatus(&kbdinfo, 0);
 117 #endif
 118             if (SP_PARM) {
 119                 IsRaw(SP_PARM) = TRUE;
 120                 IsCbreak(SP_PARM) = 1;
 121             }
 122             termp->Nttyb = buf;
 123         }
 124         AFTER("raw");
 125     }
 126     returnCode(result);
 127 }
 128
 129 #if NCURSES_SP_FUNCS
 130 NCURSES_EXPORT(int)
 131 raw(void)
 132 {
 133     return NCURSES_SP_NAME(raw) (CURRENT_SCREEN);
 134 }
 135 #endif
 136
 137 NCURSES_EXPORT(int)
 138 NCURSES_SP_NAME(cbreak) (NCURSES_SP_DCL0)
 139 {
 140     int result = ERR;
 141     TERMINAL *termp;
 142
 143     T((T_CALLED("cbreak(%p)"), (void *) SP_PARM));
 144     if ((termp = TerminalOf(SP_PARM)) != 0) {
 145         TTY buf;
 146
 147         BEFORE("cbreak");
 148         _nc_setmode(O_BINARY);
 149
 150         buf = termp->Nttyb;
 151 #ifdef TERMIOS
 152         buf.c_lflag &= (unsigned) ~ICANON;
 153         buf.c_iflag &= (unsigned) ~ICRNL;
 154         buf.c_cc[VMIN] = 1;
 155         buf.c_cc[VTIME] = 0;
 156 #elif defined(EXP_WIN32_DRIVER)
 157         buf.dwFlagIn |= CONMODE_NORAW;
 158         buf.dwFlagIn &= (unsigned long) ~CONMODE_NOCBREAK;
 159 #else
 160         buf.sg_flags |= CBREAK;
 161 #endif
 162         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 163         if (result == OK) {
 164             if (SP_PARM) {
 165                 IsCbreak(SP_PARM) = 1;
 166             }
 167             termp->Nttyb = buf;
 168         }
 169         AFTER("cbreak");
 170     }
 171     returnCode(result);
 172 }
 173
 174 #if NCURSES_SP_FUNCS
 175 NCURSES_EXPORT(int)
 176 cbreak(void)
 177 {
 178     return NCURSES_SP_NAME(cbreak) (CURRENT_SCREEN);
 179 }
 180 #endif
 181
 182 /*
 183  * Note:
 184  * this implementation may be wrong.  See the comment under intrflush().
 185  */
 186 NCURSES_EXPORT(void)
 187 NCURSES_SP_NAME(qiflush) (NCURSES_SP_DCL0)
 188 {
 189     TERMINAL *termp;
 190
 191     T((T_CALLED("qiflush(%p)"), (void *) SP_PARM));
 192     if ((termp = TerminalOf(SP_PARM)) != 0) {
 193         TTY buf;
 194         int result;
 195
 196         BEFORE("qiflush");
 197         buf = termp->Nttyb;
 198 #ifdef TERMIOS
 199         buf.c_lflag &= (unsigned) ~(NOFLSH);
 200         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 201 #else
 202         result = ERR;
 203         /* FIXME */
 204 #endif
 205         if (result == OK)
 206             termp->Nttyb = buf;
 207         AFTER("qiflush");
 208     }
 209     returnVoid;
 210 }
 211
 212 #if NCURSES_SP_FUNCS
 213 NCURSES_EXPORT(void)
 214 qiflush(void)
 215 {
 216     NCURSES_SP_NAME(qiflush) (CURRENT_SCREEN);
 217 }
 218 #endif
 219
 220 NCURSES_EXPORT(int)
 221 NCURSES_SP_NAME(noraw) (NCURSES_SP_DCL0)
 222 {
 223     int result = ERR;
 224     TERMINAL *termp;
 225
 226     T((T_CALLED("noraw(%p)"), (void *) SP_PARM));
 227     if ((termp = TerminalOf(SP_PARM)) != 0) {
 228         TTY buf;
 229
 230         BEFORE("noraw");
 231         _nc_setmode(O_TEXT);
 232
 233         buf = termp->Nttyb;
 234 #ifdef TERMIOS
 235         buf.c_lflag |= ISIG | ICANON |
 236             (termp->Ottyb.c_lflag & IEXTEN);
 237         buf.c_iflag |= COOKED_INPUT;
 238 #elif defined(EXP_WIN32_DRIVER)
 239         buf.dwFlagIn |= CONMODE_NORAW;
 240 #else
 241         buf.sg_flags &= ~(RAW | CBREAK);
 242 #endif
 243         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 244         if (result == OK) {
 245 #if USE_KLIBC_KBD
 246             KBDINFO kbdinfo;
 247
 248             kbdinfo.cb = sizeof(kbdinfo);
 249             KbdGetStatus(&kbdinfo, 0);
 250
 251             kbdinfo.cb = sizeof(kbdinfo);
 252             kbdinfo.fsMask &= ~KEYBOARD_BINARY_MODE;
 253             kbdinfo.fsMask |= KEYBOARD_ASCII_MODE;
 254             KbdSetStatus(&kbdinfo, 0);
 255 #endif
 256             if (SP_PARM) {
 257                 IsRaw(SP_PARM) = FALSE;
 258                 IsCbreak(SP_PARM) = 0;
 259             }
 260             termp->Nttyb = buf;
 261         }
 262         AFTER("noraw");
 263     }
 264     returnCode(result);
 265 }
 266
 267 #if NCURSES_SP_FUNCS
 268 NCURSES_EXPORT(int)
 269 noraw(void)
 270 {
 271     return NCURSES_SP_NAME(noraw) (CURRENT_SCREEN);
 272 }
 273 #endif
 274
 275 NCURSES_EXPORT(int)
 276 NCURSES_SP_NAME(nocbreak) (NCURSES_SP_DCL0)
 277 {
 278     int result = ERR;
 279     TERMINAL *termp;
 280
 281     T((T_CALLED("nocbreak(%p)"), (void *) SP_PARM));
 282     if ((termp = TerminalOf(SP_PARM)) != 0) {
 283         TTY buf;
 284
 285         BEFORE("nocbreak");
 286         _nc_setmode(O_TEXT);
 287
 288         buf = termp->Nttyb;
 289 #ifdef TERMIOS
 290         buf.c_lflag |= ICANON;
 291         buf.c_iflag |= ICRNL;
 292 #elif defined(EXP_WIN32_DRIVER)
 293         buf.dwFlagIn |= (CONMODE_NOCBREAK | CONMODE_NORAW);
 294 #else
 295         buf.sg_flags &= ~CBREAK;
 296 #endif
 297         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 298         if (result == OK) {
 299             if (SP_PARM) {
 300                 IsCbreak(SP_PARM) = 0;
 301             }
 302             termp->Nttyb = buf;
 303         }
 304         AFTER("nocbreak");
 305     }
 306     returnCode(result);
 307 }
 308
 309 #if NCURSES_SP_FUNCS
 310 NCURSES_EXPORT(int)
 311 nocbreak(void)
 312 {
 313     return NCURSES_SP_NAME(nocbreak) (CURRENT_SCREEN);
 314 }
 315 #endif
 316
 317 NCURSES_EXPORT(void)
 318 NCURSES_SP_NAME(noqiflush) (NCURSES_SP_DCL0)
 319 {
 320     TERMINAL *termp;
 321
 322     T((T_CALLED("noqiflush(%p)"), (void *) SP_PARM));
 323     if ((termp = TerminalOf(SP_PARM)) != 0) {
 324         TTY buf;
 325         int result;
 326
 327         BEFORE("noqiflush");
 328         buf = termp->Nttyb;
 329 #ifdef TERMIOS
 330         buf.c_lflag |= NOFLSH;
 331         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 332 #else
 333         /* FIXME */
 334         result = ERR;
 335 #endif
 336         if (result == OK)
 337             termp->Nttyb = buf;
 338         AFTER("noqiflush");
 339     }
 340     returnVoid;
 341 }
 342
 343 #if NCURSES_SP_FUNCS
 344 NCURSES_EXPORT(void)
 345 noqiflush(void)
 346 {
 347     NCURSES_SP_NAME(noqiflush) (CURRENT_SCREEN);
 348 }
 349 #endif
 350
 351 /*
 352  * This call does the same thing as the qiflush()/noqiflush() pair.  We know
 353  * for certain that SVr3 intrflush() tweaks the NOFLSH bit; on the other hand,
 354  * the match (in the SVr4 man pages) between the language describing NOFLSH in
 355  * termio(7) and the language describing qiflush()/noqiflush() in
 356  * curs_inopts(3x) is too exact to be coincidence.
 357  */
 358 NCURSES_EXPORT(int)
 359 NCURSES_SP_NAME(intrflush) (NCURSES_SP_DCLx WINDOW *win GCC_UNUSED, bool flag)
 360 {
 361     int result = ERR;
 362     TERMINAL *termp;
 363
 364     T((T_CALLED("intrflush(%p,%d)"), (void *) SP_PARM, flag));
 365     if (SP_PARM == 0)
 366         returnCode(ERR);
 367
 368     if ((termp = TerminalOf(SP_PARM)) != 0) {
 369         TTY buf;
 370
 371         BEFORE("intrflush");
 372         buf = termp->Nttyb;
 373 #ifdef TERMIOS
 374         if (flag)
 375             buf.c_lflag &= (unsigned) ~(NOFLSH);
 376         else
 377             buf.c_lflag |= (NOFLSH);
 378         result = NCURSES_SP_NAME(_nc_set_tty_mode) (NCURSES_SP_ARGx &buf);
 379 #else
 380         /* FIXME */
 381 #endif
 382         if (result == OK) {
 383             termp->Nttyb = buf;
 384         }
 385         AFTER("intrflush");
 386     }
 387     returnCode(result);
 388 }
 389
 390 #if NCURSES_SP_FUNCS
 391 NCURSES_EXPORT(int)
 392 intrflush(WINDOW *win GCC_UNUSED, bool flag)
 393 {
 394     return NCURSES_SP_NAME(intrflush) (CURRENT_SCREEN, win, flag);
 395 }
 396 #endif
 397
 398 #if NCURSES_EXT_FUNCS
 399 /* *INDENT-OFF* */
 400
 401 /*
 402  * SCREEN is always opaque, but nl/raw/cbreak/echo set properties in it.
 403  * As an extension, provide a way to query the properties.
 404  *
 405  * There are other properties which could be queried, e.g., filter, keypad,
 406  * use_env, use_meta, but these particular properties are saved/restored within
 407  * the wgetnstr() and wgetn_wstr() functions, which requires that the higher
 408  * level curses library knows about the internal state of the lower level
 409  * terminfo library.
 410  */
 411
 412 #define is_TEST(show,what) \
 413     NCURSES_EXPORT(int) \
 414     NCURSES_SP_NAME(show) (NCURSES_SP_DCL0) \
 415     { \
 416         return ((SP_PARM != NULL) ? (what(SP_PARM) ? 1 : 0) : -1); \
 417     }
 418
 419 is_TEST(is_nl, IsNl)
 420 is_TEST(is_raw, IsRaw)
 421 is_TEST(is_cbreak, IsCbreak)
 422 is_TEST(is_echo, IsEcho)
 423
 424 #if NCURSES_SP_FUNCS
 425 #undef is_TEST
 426 #define is_TEST(show) \
 427     NCURSES_EXPORT(int) \
 428     show(void) \
 429     { \
 430         return NCURSES_SP_NAME(show) (CURRENT_SCREEN); \
 431     }
 432 is_TEST(is_nl)
 433 is_TEST(is_raw)
 434 is_TEST(is_cbreak)
 435 is_TEST(is_echo)
 436 #endif
 437
 438 /* *INDENT-ON* */
 439 #endif /* extensions */