root/usr/src/lib/libxcurses/src/libc/xcurses/newterm.c
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */
/*
 * Copyright (c) 1995, by Sun Microsystems, Inc.
 * All rights reserved.
 */

/*
 * newterm.c
 *
 * XCurses Library
 *
 * Copyright 1990, 1995 by Mortice Kern Systems Inc.  All rights reserved.
 *
 */

#ifdef M_RCSID
#ifndef lint
static char const rcsID[] = "$Header: /rd/src/libc/xcurses/rcs/newterm.c 1.15 1995/07/25 19:54:00 ant Exp $";
#endif
#endif

#include <private.h>
#include <m_wio.h>
#include <errno.h>
#include <signal.h>
#include <stdlib.h>
#include <string.h>

int LINES, COLS;
int COLORS, COLOR_PAIRS;

WINDOW *curscr;
WINDOW *stdscr;
SCREEN *__m_screen;

static short assume_one_line = FALSE;

/*
 * Assume terminal has only one screen line by restricting those
 * capabilities that assume more than one line.  This function must
 * be called before initscr() or newterm().
 *
 * This flag will reset after initscr() or newterm() so that subsequent
 * calls to newterm(), without a preceding call to filter(), will load
 * an unmodified terminal.  THIS IS NOT HISTORICAL PRACTICE, BUT DEEMED
 * USEFUL.
 */
void
filter(void)
{
#ifdef M_CURSES_TRACE
        __m_trace("filter(void)");
#endif
        assume_one_line = TRUE;
        __m_return_void("filter");
}

/*f
 * SIGTSTP Handler.
 */
void
tstp(signo)
int signo;
{
#ifdef SIGTSTP
        /* Only permit SIGTSTP if the curent process is the process
         * group leader.  If the process is not the current group
         * leader, then suspending the current process will suspend
         * other members of the process group, such as the parent
         * process.
         */
        if (getpid() == getpgrp()) {
                (void) endwin();

#ifdef SIG_UNBLOCK
{
                sigset_t unblock;

                (void) sigemptyset(&unblock);
                (void) sigaddset(&unblock, SIGTSTP);
                (void) sigprocmask(SIG_UNBLOCK, &unblock, (sigset_t *) 0);
}
#endif /* SIG_UNBLOCK */
                (void) signal(SIGTSTP, SIG_DFL);
                (void) kill(0, SIGTSTP);
        } else {
                (void) beep();
        }

        (void) signal(SIGTSTP, tstp);
        (void) wrefresh(curscr);
#else /* no SIGTSTP */
        (void) beep();
#endif /* SIGTSTP */
}

int __m_slk_format = -1;

/*
 * Do real soft label key initialisation once setupterm() have been called
 * to load the current terminal.  Determine whether the terminal supplies
 * soft label keys, or whether we have to fake it by using the last line
 * of a terminal screen.
 */
int
__m_slk_init(SCREEN *sp, int style)
{
        int code;

#ifdef M_CURSES_TRACE
        __m_trace("__m_slk_init(%d)", style );
#endif

        code = ERR;

        /* Does the terminal have a method to program the soft label key? */
        if (plab_norm != (char *) 0 || pkey_plab  != (char *) 0) {
                code = OK;
                goto done;
        }

        /* We have to fake it. */
        if (lines < 2)
                goto done;

        sp->_slk._w = subwin(sp->_newscr, 1, 0, --lines, 0);
        if (sp->_slk._w == (WINDOW *) 0)
                goto done;

        code = OK;
done:
        return __m_return_code("__m_slk_init", code);
}

/*
 * The XCurses specification is unclear how ripoffline() would
 * affect newterm().  We assume that it can't be used with newterm()
 * and that it only affects initscr(), which is responsible for
 * creating stdscr.
 */
static t_rip rip = { 0 };

/*
 * If line is positive (1), one line is removed from the beginning of
 * stdscr; else if line is negative (-1), one line is removed from the end.
 */
int
ripoffline(int line, int (*init)(WINDOW *, int))
{
        int i;

#ifdef M_CURSES_TRACE
        __m_trace("ripoffline(%d, %p)", line, init);
#endif

        i = rip.top - rip.bottom;

        if (line != 0 && i + 1 < M_CURSES_MAX_RIPOFFLINE) {
                rip.line[i].init = init;
                if (line < 0)
                        rip.line[i].dy = --rip.bottom;
                else
                        rip.line[i].dy = ++rip.top;
        }

        return __m_return_code("ripoffline", OK);
}

/*f
 * Create a new terminal screen.  Used if a program is going to be sending
 * output to more than one terminal.  It returns a SCREEN* for the terminal.
 * The parameters are a terminal name, output FILE*, and input FILE*.  If
 * the terminal name is null then $TERM is used.  The program must also
 * call endwin() for each terminal being used before exiting from curses.
 * If newterm() is called more than once for the same terminal, the first
 * terminal referred to must be the last one for which endwin() is called.
 */
SCREEN *
newterm(term, out_fp, in_fp)
char *term;
FILE *out_fp, *in_fp;
{
        WINDOW *w;
        t_wide_io *wio;
        SCREEN *sp, *osp;
        int i, n, y, errret;

#ifdef M_CURSES_TRACE
        __m_trace(
                "newterm(%s, %p, %p)",
                term == (char *) 0 ? "NULL" : term, out_fp, in_fp
        );
#endif

        /* Input stream should be unbuffered so that m_tfgetc() works
         * correctly on BSD and SUN systems.
         */
        (void) SETVBUF(in_fp, (char *) 0, _IONBF, BUFSIZ);
#if 0
/*
 * Not sure whether we really want to concern ourselves with the output
 * buffer scheme.  Might be best to leave it upto the application to
 * deal with buffer schemes and when to perform flushes.
 *
 * MKS Vi uses MKS Curses and so must support the ability to switch in
 * and out of Curses mode when switching from Vi to Ex and back.
 * Problem is that in Vi mode you would prefer full buffered output to
 * give updates a smoother appearance and Ex mode you require line
 * buffered in order to see prompts and messages.
 */
        (void) SETVBUF(out_fp, (char *) 0, _IOLBF, BUFSIZ);
#endif
        errno = 0;

        if (__m_setupterm(term, fileno(in_fp), fileno(out_fp), &errret)==ERR) {
                switch (errret) {
                case -1:
                        errno = ENOMEM;
                        break;
                case 2:
                        errno = ENAMETOOLONG;
                        break;
                case 0:
                default:
                        errno = ENOENT;
                        break;
                }
                goto error1;
        }

        if (__m_doupdate_init())
                goto error1;

        if ((sp = (SCREEN *) calloc(1, sizeof *sp)) == (SCREEN *) 0)
                goto error1;

        sp->_if = in_fp;
        sp->_of = out_fp;
        sp->_term = cur_term;

        sp->_unget._size = __m_decode_init((t_decode **) &sp->_decode);

        /* Maximum length of a multbyte key sequence, including
         * multibyte characters and terminal function keys.
         */
        if (sp->_unget._size < MB_LEN_MAX)
                sp->_unget._size = MB_LEN_MAX;

        sp->_unget._stack = calloc(
                (size_t) sp->_unget._size,  sizeof *sp->_unget._stack
        );
        if (sp->_unget._stack == (void *) 0)
                goto error2;

        if ((wio = (t_wide_io *) calloc(1, sizeof *wio)) == (t_wide_io *) 0)
                goto error2;

        /* Setup wide input for XCurses. */
        wio->get = (int (*)(void *)) wgetch;
        wio->unget = __xc_ungetc;
        wio->reset = __xc_clearerr;
        wio->iserror = __xc_ferror;
        wio->iseof = __xc_feof;
        sp->_in = wio;

        if (assume_one_line) {
                /* Assume only one line. */
                lines = 1;

                /* Disable capabilities that assume more than one line. */
                clear_screen =
                clr_eos =
                cursor_up =
                cursor_down =
                cursor_home =
                cursor_to_ll =
                cursor_address =
                row_address =
                parm_up_cursor =
                parm_down_cursor = (char *) 0;

                /* Re-evaluate the cursor motion costs. */
                __m_mvcur_cost();

                /* Reset flag for subsequent calls to newterm(). */
                assume_one_line = FALSE;
        }

        if ((sp->_curscr = newwin(lines, columns, 0, 0)) == (WINDOW *) 0)
                goto error2;

        if ((sp->_newscr = newwin(lines, columns, 0, 0)) == (WINDOW *) 0)
                goto error2;

        sp->_hash = (unsigned long *) calloc(lines, sizeof *sp->_hash);
        if (sp->_hash == (unsigned long *) 0)
                goto error2;

        if (0 <= __m_slk_format && __m_slk_init(sp, __m_slk_format) == ERR)
                goto error2;

        /* doupdate() will perform the final screen preparations like
         * enter_ca_mode, reset_prog_mode() (to assert the termios
         * changes), etc.
         */
        sp->_flags |= S_ENDWIN;

#ifdef SIGTSTP
        (void) signal(SIGTSTP, tstp);
#endif
        /* Assert that __m_screen is set to the new terminal. */
        osp = set_term(sp);

        /* Disable echo in tty driver, Curses does software echo. */
        cur_term->_prog.c_lflag &= ~ECHO;

        /* Enable mappnig of cr -> nl on input and nl -> crlf on output. */
        cur_term->_prog.c_iflag |= ICRNL;
        cur_term->_prog.c_oflag |= OPOST;
#ifdef ONLCR
        cur_term->_prog.c_oflag |= ONLCR;
#endif
        cur_term->_flags |= __TERM_NL_IS_CRLF;

#ifdef TAB0
        /* Use real tabs. */
        cur_term->_prog.c_oflag &= ~(TAB1|TAB2|TAB3);
#endif

        (void) __m_tty_set(&cur_term->_prog);
        (void) __m_set_echo(1);
        (void) typeahead(fileno(in_fp));

        if (stdscr == (WINDOW *) 0) {
                n = rip.top - rip.bottom;
                stdscr = newwin(lines - n, 0, rip.top, 0);
                if (stdscr == (WINDOW *) 0)
                        goto error3;

                /* Create and initialise ripped off line windows.
                 * It is the application's responsiblity to free the
                 * windows when the application terminates.
                 */
                for (i = 0; i < n; ++i) {
                        y = rip.line[i].dy;
                        if (y < 0)
                                y += lines;

                        w = newwin(1, 0, y, 0);
                        if (rip.line[i].init != (int (*)(WINDOW *, int)) 0)
                                (void) (*rip.line[i].init)(w, columns);
                }
        }

        return __m_return_pointer("newterm", sp);
error3:
        (void) set_term(osp);
error2:
        delscreen(sp);
error1:
        return __m_return_pointer("newterm", (SCREEN *) 0);
}

/*f
 * Free storage associated with a screen structure.
 * NOTE endwin() does not do this.
 */
void
delscreen(sp)
SCREEN *sp;
{
#ifdef M_CURSES_TRACE
        __m_trace("delscreen(%p)", sp);
#endif

        if (sp != (SCREEN *) 0) {
                if (sp->_slk._w != (WINDOW *) 0)
                        (void) delwin(sp->_slk._w);

                (void) delwin(sp->_newscr);
                (void) delwin(sp->_curscr);
                (void) del_curterm(sp->_term);

                __m_decode_free((t_decode **) &sp->_decode);

                if (sp->_hash != (unsigned long *) 0)
                        free(sp->_hash);

                if (sp->_unget._stack != (int *) 0)
                        free(sp->_unget._stack);

                if (sp->_in != (void *) 0)
                        free(sp->_in);

                free(sp);
        }

        __m_return_void("delscreen");
}

/*f
 * Switch current terminal for Curses layer.
 */
SCREEN *
set_term(screen)
SCREEN *screen;
{
        SCREEN *osp = __m_screen;

#ifdef M_CURSES_TRACE
        __m_trace("set_term(%p)", screen);
#endif
        if (screen != (SCREEN *) 0) {
                (void) set_curterm(screen->_term);
                curscr = screen->_curscr;
                __m_screen = screen;

                LINES = lines;
                COLS = columns;
                COLORS = max_colors;
                COLOR_PAIRS = max_pairs;
        }

        return __m_return_pointer("set_term", osp);
}

int
typeahead(fd)
int fd;
{
#ifdef M_CURSES_TRACE
        __m_trace("typeahead(%d)", fd);
#endif

        __m_screen->_kfd = fd;
        __m_screen->_flags &= ~S_ISATTY;

        if (fd != -1 && isatty(fd))
                __m_screen->_flags |= S_ISATTY;

        return __m_return_code("typeahead", OK);
}

int
__m_set_echo(bf)
int bf;
{
        int old;

        old = (__m_screen->_flags & S_ECHO) == S_ECHO;

        __m_screen->_flags &= ~S_ECHO;
        if (bf)
                __m_screen->_flags |= S_ECHO;

        return old;
}