terminal.h revision 63948 
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. All advertising materials mentioning features or use of this software
17 *    must display the following acknowledgement:
18 *	This product includes software developed by the University of
19 *	California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 *	@(#)term.h	8.1 (Berkeley) 6/4/93
37 *
38 * $FreeBSD: head/lib/libedit/term.h 63948 2000-07-28 00:42:54Z ache $
39 */
40
41/*
42 * el.term.h: Termcap header
43 */
44#ifndef _h_el_term
45#define _h_el_term
46
47#include "histedit.h"
48
49typedef struct {	/* Symbolic function key bindings	*/
50    char       *name;	/* name of the key			*/
51    int     	key;	/* Index in termcap table		*/
52    key_value_t fun;	/* Function bound to it			*/
53    int	        type;	/* Type of function			*/
54} fkey_t;
55
56typedef struct {
57    coord_t t_size;			/* # lines and cols	*/
58    bool_t  t_flags;
59#define TERM_CAN_INSERT		0x01	/* Has insert cap	*/
60#define TERM_CAN_DELETE		0x02	/* Has delete cap	*/
61#define TERM_CAN_CEOL		0x04	/* Has CEOL cap		*/
62#define TERM_CAN_TAB		0x08	/* Can use tabs		*/
63#define TERM_CAN_ME		0x10	/* Can turn all attrs.	*/
64#define TERM_CAN_UP		0x20	/* Can move up		*/
65#define TERM_HAS_META		0x40	/* Has a meta key	*/
66    char   *t_buf;			/* Termcap buffer	*/
67    int	    t_loc;			/* location used	*/
68    char  **t_str;			/* termcap strings	*/
69    int	   *t_val;			/* termcap values	*/
70    char   *t_cap;			/* Termcap buffer	*/
71    fkey_t *t_fkey;			/* Array of keys	*/
72} el_term_t;
73
74/*
75 * fKey indexes
76 */
77#define A_K_DN		0
78#define A_K_UP		1
79#define A_K_LT		2
80#define A_K_RT		3
81#define A_K_HO		4
82#define A_K_EN		5
83#define A_K_NKEYS	6
84
85protected void term_move_to_line	__P((EditLine *, int));
86protected void term_move_to_char	__P((EditLine *, int));
87protected void term_clear_EOL		__P((EditLine *, int));
88protected void term_overwrite		__P((EditLine *, char *, int));
89protected void term_insertwrite		__P((EditLine *, char *, int));
90protected void term_deletechars		__P((EditLine *, int));
91protected void term_clear_screen	__P((EditLine *));
92protected void term_beep		__P((EditLine *));
93protected void term_change_size		__P((EditLine *, int, int));
94protected int  term_get_size		__P((EditLine *, int *, int *));
95protected int  term_init		__P((EditLine *));
96protected void term_bind_arrow		__P((EditLine *));
97protected void term_print_arrow		__P((EditLine *, char *));
98protected int  term_clear_arrow		__P((EditLine *, char *));
99protected int  term_set_arrow		__P((EditLine *, char *,
100					     key_value_t *, int));
101protected void term_end			__P((EditLine *));
102protected int  term_set			__P((EditLine *, char *));
103protected int  term_settc		__P((EditLine *, int, char **));
104protected int  term_telltc		__P((EditLine *, int, char **));
105protected int  term_echotc		__P((EditLine *, int, char **));
106
107protected int  term__putc		__P((int));
108protected void term__flush		__P((void));
109
110/*
111 * Easy access macros
112 */
113#define EL_FLAGS	(el)->el_term.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_HAS_META	(EL_FLAGS & TERM_HAS_META)
121
122#endif /* _h_el_term */
123