xref: /illumos-gate/usr/src/lib/libxcurses/src/libc/xcurses/private.h (revision 1da57d55)

/*
 * 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) 1996, by Sun Microsystems, Inc.
 * All rights reserved.
 */

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

#include <mks.h>
#include <curses.h>

#ifndef M_CURSES_VERSION
#define M_CURSES_VERSION        "MKS XCurses"
#endif

#ifndef M_TERM_NAME
#define M_TERM_NAME             "dumb"
#endif

#ifndef M_TERMINFO_DIR
#define M_TERMINFO_DIR          "/usr/lib/terminfo"
#endif

/*
 * Interbyte timer value used for processing multibyte function keys.
 */
#ifndef M_CURSES_INTERBYTE_TIME
#define M_CURSES_INTERBYTE_TIME		10
#endif

/*
 * Maximum number of lines that can be ripped off.
 */
#ifndef M_CURSES_MAX_RIPOFFLINE
#define M_CURSES_MAX_RIPOFFLINE		5
#endif

/*
 * See copywin() and wrefresh() case 4.  It is unclear whether XPG4 V2
 * disallows supporting case 4 (expanding characters straddling a window
 * boundary).
 */
#define M_CURSES_SENSIBLE_WINDOWS

/*
 * Enable typeahead() support.
 */
#define M_CURSES_TYPEAHEAD

/*
 * Not everyone supports the latest version of the (draft) MSE.
 */
#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 199409L
#undef wcrtomb
#define wcrtomb(mb, wc, state)		wctomb(mb, wc)
#undef mbrtowc
#define mbrtowc(wc, mb, n, state)	mbtowc(wc, mb, n)
#endif

/***
 *** END OF CONFIGURABLE SECTION
 ***/

/*
 * Constant WINDOW definition attributes.
 */
#define W_IS_PAD	0x0001	/* Window is a pad. */
#define W_END_LINE	0x0002	/* End of line is the margin. */
#define W_FULL_LINE	0x0004	/* Line spans screen width. */
#define W_FULL_WINDOW	0x0008	/* Window is full screen. */
#define W_SCROLL_WINDOW	0x0010	/* Touches bottom-right corner */

/*
 * WINDOW state.
 */
#define W_CLEAR_WINDOW	0x0020	/* clearok() clear screen next update. */
#define W_REDRAW_WINDOW 0x0040	/* wredrawln() use simple() next update. */

/*
 * Configurable WINDOW options.
 */
#define W_FLUSH		0x0080	/* immedok() update when window changes. */
#define W_CAN_SCROLL	0x0100	/* scrollok() window can software scroll. */
#define W_LEAVE_CURSOR	0x0200	/* leaveok() don't fuss with the cursor. */
#define W_SYNC_UP	0x0400	/* syncok() update ancestors when changed. */
#define W_USE_KEYPAD	0x0800	/* keypad() enbles KEY_ processing. */
#define W_USE_TIMEOUT	0x1000	/* notimeout() disables the interbyte timer. */
#define W_CONFIG_MASK	0x1f80 	/* Mask of configurable flags. */

/*
 * Flags used in SCREEN.
 */
#define S_ECHO		0x0001	/* Software echo enbled. */
#define S_ENDWIN	0x0002	/* Curses is in "shell" mode. */
#define S_INS_DEL_CHAR	0x0004	/* idcok() enabled for terminal (future). */
#define S_INS_DEL_LINE	0x0008	/* idlok() enabled for terminal. */
#define S_ISATTY	0x0010	/* _kfd is a terminal. */
#define S_USE_META	0x0020	/* meta() enabled. */

typedef struct t_decode {
	struct t_decode *sibling;
	struct t_decode *child;
	short key;			/* KEY_ value or 0. */
	int ch;				/* Character found by this node. */
} t_decode;

typedef struct {
	int top;			/* # of lines off the top. */
	int bottom;			/* # of lines off the bottom (-ve). */
	struct {
		int dy;			/* Distance from screen top/bottom. */
		int (*init)(WINDOW *, int);	/* Init. function for window. */
	} line[M_CURSES_MAX_RIPOFFLINE];
} t_rip;

extern SCREEN *__m_screen;
extern int __m_slk_format;
extern short __m_keyindex[][2];

#define ATTR_STATE	cur_term->_at

extern void __m_trace(const char *, ...);

#ifdef M_CURSES_TRACE
extern int __m_return_code(const char *, int);
extern int __m_return_int(const char *, int);
extern chtype __m_return_chtype(const char *, chtype);
extern void *__m_return_pointer(const char *, const void *);
extern void __m_return_void(const char *);
#else
#define __m_return_code(s, c)		(c)
#define __m_return_int(s, c)		(c)
#define __m_return_chtype(s, c)		(c)
#define __m_return_pointer(s, p)	(p)
#define __m_return_void(s)
#endif /* M_CURSES_TRACE */

extern int __m_wc_cc(wint_t, cchar_t *);
extern int __m_mbs_cc(const char *, attr_t, short, cchar_t *);
extern int __m_wcs_cc(const wchar_t *, attr_t, short, cchar_t *);
extern int __m_acs_cc(chtype, cchar_t *);
extern int __m_wacs_cc(const cchar_t *, cchar_t *);
extern int __m_cc_mbs(const cchar_t *, char *, int);

extern int __m_cc_sort(cchar_t *);
extern int __m_cc_width(const cchar_t *);
extern int __m_cc_write(const cchar_t *);
extern int __m_cc_first(WINDOW *, int, int);
extern int __m_cc_next(WINDOW *, int, int);
extern int __m_cc_islast(WINDOW *, int, int);
extern int __m_cc_expand(WINDOW *, int, int, int);
extern int __m_cc_erase(WINDOW *, int, int, int, int);
extern int __m_cc_compare(const cchar_t *, const cchar_t *, int);
extern int __m_cc_replace(WINDOW *, int, int, const cchar_t *, int);
extern int __m_cc_add(WINDOW *, int, int, const cchar_t *, int, int *, int *);
extern void __m_cc_hash(WINDOW *, unsigned long *, int);

extern int __m_set_echo(int);
extern int __m_tty_get(struct termios *);
extern int __m_tty_set(struct termios *);
extern int __m_decode_init(t_decode **);
extern void __m_decode_free(t_decode **);
extern int __m_do_scroll(WINDOW *, int, int, int *, int *);
extern int __m_ptr_move(void **, unsigned, unsigned, unsigned, unsigned);

extern int __m_doupdate_init(void);
extern int __m_wins_wch(WINDOW *, int, int, const cchar_t *, int *, int *);
extern int __m_cc_ins(WINDOW *, int, int, const cchar_t *);
extern void __m_mvcur_cost(void);

/*
 * Unique callback functions to initialize a SCREEN's wide_io_t structure,
 * which is used by __m_wio_get().   The __xc_ denotes XCurses and is used
 * instead of __m_ to avoid possible name conflicts else-where in MKS
 * libraries and applications.  Note that wgetch() is used for the get
 * function.
 */
extern int __xc_feof(void *);
extern int __xc_ferror(void *);
extern void __xc_clearerr(void *);
extern int __xc_ungetc(int, void *);

/*
 * Input stack macros.
 */
#define ISFULL()	(__m_screen->_unget._size <= __m_screen->_unget._count)
#define ISEMPTY()	(__m_screen->_unget._count <= 0)
#define DEC()		--__m_screen->_unget._count
#define INC()		__m_screen->_unget._count++
#define RESET()		__m_screen->_unget._count = 0
#define POP()		__m_screen->_unget._stack[DEC()]
#define PUSH(x)		(__m_screen->_unget._stack[INC()] = (x))

#define WSYNC(w)	(((w)->_flags & W_SYNC_UP) ? wsyncup(w) : (void) OK)
#define WFLUSH(w)	(((w)->_flags & W_FLUSH) ? wrefresh(w) : OK)

/* end */