el.h revision 276881 
1/*	$NetBSD: el.h,v 1.25 2011/07/29 23:44:44 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 *	@(#)el.h	8.1 (Berkeley) 6/4/93
35 * $FreeBSD: head/lib/libedit/el.h 276881 2015-01-09 07:40:56Z bapt $
36 */
37
38/*
39 * el.h: Internal structures.
40 */
41#ifndef _h_el
42#define	_h_el
43/*
44 * Local defaults
45 */
46#define	KSHVI
47#define	VIDEFAULT
48#define	ANCHOR
49
50#include "histedit.h"
51#include "chartype.h"
52#include <stdio.h>
53#include <sys/types.h>
54
55#define	EL_BUFSIZ	((size_t)1024)	/* Maximum line size		*/
56
57#define	HANDLE_SIGNALS	0x01
58#define	NO_TTY		0x02
59#define	EDIT_DISABLED	0x04
60#define	UNBUFFERED	0x08
61#define	CHARSET_IS_UTF8 0x10
62#define	IGNORE_EXTCHARS 0x20            /* Ignore characters read > 0xff */
63#define	NARROW_HISTORY	0x40
64#define	NARROW_READ	0x80
65
66typedef int bool_t;			/* True or not			*/
67
68typedef unsigned char el_action_t;	/* Index to command array	*/
69
70typedef struct coord_t {		/* Position on the screen	*/
71	int	h;
72	int	v;
73} coord_t;
74
75typedef struct el_line_t {
76	Char 		*buffer;	/* Input line			*/
77	Char	        *cursor;	/* Cursor position		*/
78	Char	        *lastchar;	/* Last character		*/
79	const Char	*limit;		/* Max position			*/
80} el_line_t;
81
82/*
83 * Editor state
84 */
85typedef struct el_state_t {
86	int		inputmode;	/* What mode are we in?		*/
87	int		doingarg;	/* Are we getting an argument?	*/
88	int		argument;	/* Numeric argument		*/
89	int		metanext;	/* Is the next char a meta char */
90	el_action_t	lastcmd;	/* Previous command		*/
91	el_action_t	thiscmd;	/* this command 		*/
92	Char		thisch;		/* char that generated it	*/
93} el_state_t;
94
95/*
96 * Until we come up with something better...
97 */
98#define	el_malloc(a)	malloc(a)
99#define	el_realloc(a,b)	realloc(a, b)
100#define	el_free(a)	free(a)
101
102#include "tty.h"
103#include "prompt.h"
104#include "keymacro.h"
105#include "terminal.h"
106#include "refresh.h"
107#include "chared.h"
108#include "common.h"
109#include "search.h"
110#include "hist.h"
111#include "map.h"
112#include "parse.h"
113#include "sig.h"
114#include "help.h"
115#include "read.h"
116
117struct editline {
118	Char		 *el_prog;	/* the program name		*/
119	FILE		 *el_infile;	/* Stdio stuff			*/
120	FILE		 *el_outfile;	/* Stdio stuff			*/
121	FILE		 *el_errfile;	/* Stdio stuff			*/
122	int		  el_infd;	/* Input file descriptor	*/
123	int		  el_outfd;	/* Output file descriptor	*/
124	int		  el_errfd;	/* Error file descriptor	*/
125	int		  el_flags;	/* Various flags.		*/
126	int		  el_errno;	/* Local copy of errno		*/
127	coord_t		  el_cursor;	/* Cursor location		*/
128	Char		**el_display;	/* Real screen image = what is there */
129	Char		**el_vdisplay;	/* Virtual screen image = what we see */
130	void		 *el_data;	/* Client data			*/
131	el_line_t	  el_line;	/* The current line information	*/
132	el_state_t	  el_state;	/* Current editor state		*/
133	el_terminal_t	  el_terminal;	/* Terminal dependent stuff	*/
134	el_tty_t	  el_tty;	/* Tty dependent stuff		*/
135	el_refresh_t	  el_refresh;	/* Refresh stuff		*/
136	el_prompt_t	  el_prompt;	/* Prompt stuff			*/
137	el_prompt_t	  el_rprompt;	/* Prompt stuff			*/
138	el_chared_t	  el_chared;	/* Characted editor stuff	*/
139	el_map_t	  el_map;	/* Key mapping stuff		*/
140	el_keymacro_t	  el_keymacro;	/* Key binding stuff		*/
141	el_history_t	  el_history;	/* History stuff		*/
142	el_search_t	  el_search;	/* Search stuff			*/
143	el_signal_t	  el_signal;	/* Signal handling stuff	*/
144	el_read_t	  el_read;	/* Character reading stuff	*/
145#ifdef WIDECHAR
146	ct_buffer_t       el_scratch;   /* Scratch conversion buffer    */
147	ct_buffer_t       el_lgcyconv;  /* Buffer for legacy wrappers   */
148	LineInfo          el_lgcylinfo; /* Legacy LineInfo buffer       */
149#endif
150};
151
152protected int	el_editmode(EditLine *, int, const Char **);
153
154#ifdef DEBUG
155#define	EL_ABORT(a)	do { \
156				fprintf(el->el_errfile, "%s, %d: ", \
157					 __FILE__, __LINE__); \
158				fprintf a; \
159				abort(); \
160			} while( /*CONSTCOND*/0);
161#else
162#define EL_ABORT(a)	abort()
163#endif
164#endif /* _h_el */
165