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