xref: /src/lib/libcurses/tty.c

/*	$NetBSD: tty.c,v 1.22 2000/06/15 21:20:16 jdc Exp $	*/

/*-
 * Copyright (c) 1992, 1993, 1994
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#include <sys/cdefs.h>
#ifndef lint
#if 0
static char sccsid[] = "@(#)tty.c	8.6 (Berkeley) 1/10/95";
#else
__RCSID("$NetBSD: tty.c,v 1.22 2000/06/15 21:20:16 jdc Exp $");
#endif
#endif				/* not lint */

#include <sys/types.h>

#include <stdlib.h>
#include <termios.h>
#include <unistd.h>
#include <sys/fcntl.h>
#include <sys/ioctl.h>

#include "curses.h"
#include "curses_private.h"

/*
 * In general, curses should leave tty hardware settings alone (speed, parity,
 * word size).  This is most easily done in BSD by using TCSASOFT on all
 * tcsetattr calls.  On other systems, it would be better to get and restore
 * those attributes at each change, or at least when stopped and restarted.
 * See also the comments in getterm().
 */
#ifdef TCSASOFT
int	__tcaction = 1;			/* Ignore hardware settings. */
#else
int	__tcaction = 0;
#endif

struct termios	__orig_termios, __baset;
int		__endwin;
static struct	termios cbreakt, rawt, *curt;
static int	useraw;
static int	ovmin = 1;
static int	ovtime = 0;

#ifndef	OXTABS
#ifdef	XTABS			/* SMI uses XTABS. */
#define	OXTABS	XTABS
#else
#define	OXTABS	0
#endif
#endif

/*
 * gettmode --
 *	Do terminal type initialization.
 */
int
gettmode(void)
{
	useraw = 0;

	if (tcgetattr(STDIN_FILENO, &__orig_termios))
		return (ERR);

	__baset = __orig_termios;
	__baset.c_oflag &= ~OXTABS;

	GT = 0;			/* historical. was used before we wired OXTABS
				 * off */
	NONL = (__baset.c_oflag & ONLCR) == 0;

	/*
	 * XXX
	 * System V and SMI systems overload VMIN and VTIME, such that
	 * VMIN is the same as the VEOF element, and VTIME is the same
	 * as the VEOL element.  This means that, if VEOF was ^D, the
	 * default VMIN is 4.  Majorly stupid.
	 */
	cbreakt = __baset;
	cbreakt.c_lflag &= ~(ECHO | ECHONL | ICANON);
	cbreakt.c_cc[VMIN] = 1;
	cbreakt.c_cc[VTIME] = 0;

	rawt = cbreakt;
	rawt.c_iflag &= ~(IGNBRK | BRKINT | PARMRK | INLCR | IGNCR | ICRNL | IXON);
	rawt.c_oflag &= ~OPOST;
	rawt.c_lflag &= ~(ISIG | IEXTEN);

	/*
	 * In general, curses should leave hardware-related settings alone.
	 * This includes parity and word size.  Older versions set the tty
	 * to 8 bits, no parity in raw(), but this is considered to be an
	 * artifact of the old tty interface.  If it's desired to change
	 * parity and word size, the TCSASOFT bit has to be removed from the
	 * calls that switch to/from "raw" mode.
	 */
	if (!__tcaction) {
		rawt.c_iflag &= ~ISTRIP;
		rawt.c_cflag &= ~(CSIZE | PARENB);
		rawt.c_cflag |= CS8;
	}

	curt = &__baset;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
raw(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	useraw = __pfast = __rawmode = 1;
	curt = &rawt;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
noraw(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	useraw = __pfast = __rawmode = 0;
	curt = &__baset;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
cbreak(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	__rawmode = 1;
	curt = useraw ? &rawt : &cbreakt;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
nocbreak(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	__rawmode = 0;
	curt = useraw ? &rawt : &__baset;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
__delay(void)
 {
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_cc[VMIN] = 1;
	rawt.c_cc[VTIME] = 0;
	cbreakt.c_cc[VMIN] = 1;
	cbreakt.c_cc[VTIME] = 0;
	__baset.c_cc[VMIN] = 1;
	__baset.c_cc[VTIME] = 0;

	return (tcsetattr(STDIN_FILENO, __tcaction ?
		TCSASOFT : TCSANOW, curt) ? ERR : OK);
}

int
__nodelay(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_cc[VMIN] = 0;
	rawt.c_cc[VTIME] = 0;
	cbreakt.c_cc[VMIN] = 0;
	cbreakt.c_cc[VTIME] = 0;
	__baset.c_cc[VMIN] = 0;
	__baset.c_cc[VTIME] = 0;

	return (tcsetattr(STDIN_FILENO, __tcaction ?
		TCSASOFT : TCSANOW, curt) ? ERR : OK);
}

void
__save_termios(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	ovmin = cbreakt.c_cc[VMIN];
	ovtime = cbreakt.c_cc[VTIME];
}

void
__restore_termios(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_cc[VMIN] = ovmin;
	rawt.c_cc[VTIME] = ovtime;
	cbreakt.c_cc[VMIN] = ovmin;
	cbreakt.c_cc[VTIME] = ovtime;
	__baset.c_cc[VMIN] = ovmin;
	__baset.c_cc[VTIME] = ovtime;
}

int
__timeout(int delay)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	ovmin = cbreakt.c_cc[VMIN];
	ovtime = cbreakt.c_cc[VTIME];
	rawt.c_cc[VMIN] = 0;
	rawt.c_cc[VTIME] = delay;
	cbreakt.c_cc[VMIN] = 0;
	cbreakt.c_cc[VTIME] = delay;
	__baset.c_cc[VMIN] = 0;
	__baset.c_cc[VTIME] = delay;

	return (tcsetattr(STDIN_FILENO, __tcaction ?
		TCSASOFT | TCSANOW : TCSANOW, curt) ? ERR : OK);
}

int
__notimeout(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_cc[VMIN] = 1;
	rawt.c_cc[VTIME] = 0;
	cbreakt.c_cc[VMIN] = 1;
	cbreakt.c_cc[VTIME] = 0;
	__baset.c_cc[VMIN] = 1;
	__baset.c_cc[VTIME] = 0;

	return (tcsetattr(STDIN_FILENO, __tcaction ?
		TCSASOFT | TCSANOW : TCSANOW, curt) ? ERR : OK);
}

int
echo(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	__echoit = 1;
	return (OK);
}

int
noecho(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	__echoit = 0;
	return (OK);
}

int
nl(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_iflag |= ICRNL;
	rawt.c_oflag |= ONLCR;
	cbreakt.c_iflag |= ICRNL;
	cbreakt.c_oflag |= ONLCR;
	__baset.c_iflag |= ICRNL;
	__baset.c_oflag |= ONLCR;

	__pfast = __rawmode;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
nonl(void)
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	rawt.c_iflag &= ~ICRNL;
	rawt.c_oflag &= ~ONLCR;
	cbreakt.c_iflag &= ~ICRNL;
	cbreakt.c_oflag &= ~ONLCR;
	__baset.c_iflag &= ~ICRNL;
	__baset.c_oflag &= ~ONLCR;

	__pfast = 1;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

int
intrflush(WINDOW *win, bool bf)	/*ARGSUSED*/
{
	/* Check if we need to restart ... */
	if (__endwin)
		__endwin = 0;

	if (bf) {
		rawt.c_lflag &= ~NOFLSH;
		cbreakt.c_lflag &= ~NOFLSH;
		__baset.c_lflag &= ~NOFLSH;
	} else {
		rawt.c_lflag |= NOFLSH;
		cbreakt.c_lflag |= NOFLSH;
		__baset.c_lflag |= NOFLSH;
	}

	__pfast = 1;
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, curt) ? ERR : OK);
}

void
__startwin(void)
{
	static char *stdbuf;
	static size_t len;

	(void) fflush(stdout);

	/*
	 * Some C libraries default to a 1K buffer when talking to a tty.
	 * With a larger screen, especially across a network, we'd like
	 * to get it to all flush in a single write.  Make it twice as big
	 * as just the characters (so that we have room for cursor motions
	 * and attribute information) but no more than 8K.
	 */
	if (stdbuf == NULL) {
		if ((len = LINES * COLS * 2) > 8192)
			len = 8192;
		if ((stdbuf = malloc(len)) == NULL)
			len = 0;
	}
	(void) setvbuf(stdout, stdbuf, _IOFBF, len);

	tputs(TI, 0, __cputchar);
	tputs(VS, 0, __cputchar);
	if (curscr->flags & __KEYPAD)
		tputs(KS, 0, __cputchar);
	__endwin = 0;
}

int
endwin(void)
{
	return __stopwin();
}

bool
isendwin(void)
{
	return (__endwin ? TRUE : FALSE);
}

int
flushinp(void)
{
	(void) fpurge(stdin);
	return (OK);
}

/*
 * The following routines, savetty and resetty are completely useless and
 * are left in only as stubs.  If people actually use them they will almost
 * certainly screw up the state of the world.
 */
static struct termios savedtty;
int
savetty(void)
{
	return (tcgetattr(STDIN_FILENO, &savedtty) ? ERR : OK);
}

int
resetty(void)
{
	return (tcsetattr(STDIN_FILENO, __tcaction ?
	    TCSASOFT | TCSADRAIN : TCSADRAIN, &savedtty) ? ERR : OK);
}

/*
 * erasechar --
 *     Return the character of the erase key.
 *
 */
char
erasechar(void)
{
	return __baset.c_cc[VERASE];
}

/*
 * killchar --
 *     Return the character of the kill key.
 */
char
killchar(void)
{
	return __baset.c_cc[VKILL];
}