1/*	$NetBSD: terminal.h,v 1.7 2016/02/16 15:53:48 christos Exp $	*/
2
3/*-
4 * Copyright (c) 1992, 1993
5 *	The Regents of the University of California.  All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * Christos Zoulas of Cornell University.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	@(#)term.h	8.1 (Berkeley) 6/4/93
35 * $FreeBSD: stable/11/lib/libedit/terminal.h 313981 2017-02-20 03:33:59Z pfg $
36 */
37
38/*
39 * el.term.h: Termcap header
40 */
41#ifndef _h_el_terminal
42#define	_h_el_terminal
43
44typedef struct {		/* Symbolic function key bindings	*/
45	const Char	*name;	/* name of the key			*/
46	int		 key;	/* Index in termcap table		*/
47	keymacro_value_t	 fun;	/* Function bound to it			*/
48	int		 type;	/* Type of function			*/
49} funckey_t;
50
51typedef struct {
52	const char *t_name;		/* the terminal name	*/
53	coord_t	  t_size;		/* # lines and cols	*/
54	int	  t_flags;
55#define	TERM_CAN_INSERT		0x001	/* Has insert cap	*/
56#define	TERM_CAN_DELETE		0x002	/* Has delete cap	*/
57#define	TERM_CAN_CEOL		0x004	/* Has CEOL cap		*/
58#define	TERM_CAN_TAB		0x008	/* Can use tabs		*/
59#define	TERM_CAN_ME		0x010	/* Can turn all attrs.	*/
60#define	TERM_CAN_UP		0x020	/* Can move up		*/
61#define	TERM_HAS_META		0x040	/* Has a meta key	*/
62#define	TERM_HAS_AUTO_MARGINS	0x080	/* Has auto margins	*/
63#define	TERM_HAS_MAGIC_MARGINS	0x100	/* Has magic margins	*/
64	char	 *t_buf;		/* Termcap buffer	*/
65	size_t	  t_loc;		/* location used	*/
66	char	**t_str;		/* termcap strings	*/
67	int	 *t_val;		/* termcap values	*/
68	char	 *t_cap;		/* Termcap buffer	*/
69	funckey_t	 *t_fkey;		/* Array of keys	*/
70} el_terminal_t;
71
72/*
73 * fKey indexes
74 */
75#define	A_K_DN		0
76#define	A_K_UP		1
77#define	A_K_LT		2
78#define	A_K_RT		3
79#define	A_K_HO		4
80#define	A_K_EN		5
81#define	A_K_DE		6
82#define	A_K_NKEYS	7
83
84protected void	terminal_move_to_line(EditLine *, int);
85protected void	terminal_move_to_char(EditLine *, int);
86protected void	terminal_clear_EOL(EditLine *, int);
87protected void	terminal_overwrite(EditLine *, const Char *, size_t);
88protected void	terminal_insertwrite(EditLine *, Char *, int);
89protected void	terminal_deletechars(EditLine *, int);
90protected void	terminal_clear_screen(EditLine *);
91protected void	terminal_beep(EditLine *);
92protected int	terminal_change_size(EditLine *, int, int);
93protected int	terminal_get_size(EditLine *, int *, int *);
94protected int	terminal_init(EditLine *);
95protected void	terminal_bind_arrow(EditLine *);
96protected void	terminal_print_arrow(EditLine *, const Char *);
97protected int	terminal_clear_arrow(EditLine *, const Char *);
98protected int	terminal_set_arrow(EditLine *, const Char *, keymacro_value_t *, int);
99protected void	terminal_end(EditLine *);
100protected void	terminal_get(EditLine *, const char **);
101protected int	terminal_set(EditLine *, const char *);
102protected int	terminal_settc(EditLine *, int, const Char **);
103protected int	terminal_gettc(EditLine *, int, char **);
104protected int	terminal_telltc(EditLine *, int, const Char **);
105protected int	terminal_echotc(EditLine *, int, const Char **);
106protected void	terminal_writec(EditLine *, wint_t);
107protected int	terminal__putc(EditLine *, wint_t);
108protected void	terminal__flush(EditLine *);
109
110/*
111 * Easy access macros
112 */
113#define	EL_FLAGS	(el)->el_terminal.t_flags
114
115#define	EL_CAN_INSERT		(EL_FLAGS & TERM_CAN_INSERT)
116#define	EL_CAN_DELETE		(EL_FLAGS & TERM_CAN_DELETE)
117#define	EL_CAN_CEOL		(EL_FLAGS & TERM_CAN_CEOL)
118#define	EL_CAN_TAB		(EL_FLAGS & TERM_CAN_TAB)
119#define	EL_CAN_ME		(EL_FLAGS & TERM_CAN_ME)
120#define EL_CAN_UP		(EL_FLAGS & TERM_CAN_UP)
121#define	EL_HAS_META		(EL_FLAGS & TERM_HAS_META)
122#define	EL_HAS_AUTO_MARGINS	(EL_FLAGS & TERM_HAS_AUTO_MARGINS)
123#define	EL_HAS_MAGIC_MARGINS	(EL_FLAGS & TERM_HAS_MAGIC_MARGINS)
124
125#endif /* _h_el_terminal */
126