xref: /netbsd-src/lib/libedit/el.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: el.c,v 1.21 2001/01/05 22:45:30 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. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  */
38 
39 #include <sys/cdefs.h>
40 #if !defined(lint) && !defined(SCCSID)
41 #if 0
42 static char sccsid[] = "@(#)el.c	8.2 (Berkeley) 1/3/94";
43 #else
44 __RCSID("$NetBSD: el.c,v 1.21 2001/01/05 22:45:30 christos Exp $");
45 #endif
46 #endif /* not lint && not SCCSID */
47 
48 /*
49  * el.c: EditLine interface functions
50  */
51 #include "sys.h"
52 
53 #include <sys/types.h>
54 #include <sys/param.h>
55 #include <string.h>
56 #include <stdlib.h>
57 #include <stdarg.h>
58 #include "el.h"
59 
60 /* el_init():
61  *	Initialize editline and set default parameters.
62  */
63 public EditLine *
64 el_init(const char *prog, FILE *fin, FILE *fout, FILE *ferr)
65 {
66 
67 	EditLine *el = (EditLine *) el_malloc(sizeof(EditLine));
68 #ifdef DEBUG
69 	char *tty;
70 #endif
71 
72 	if (el == NULL)
73 		return (NULL);
74 
75 	memset(el, 0, sizeof(EditLine));
76 
77 	el->el_infd = fileno(fin);
78 	el->el_outfile = fout;
79 	el->el_errfile = ferr;
80 	el->el_prog = strdup(prog);
81 
82 	/*
83          * Initialize all the modules. Order is important!!!
84          */
85 	el->el_flags = 0;
86 
87 	(void) term_init(el);
88 	(void) key_init(el);
89 	(void) map_init(el);
90 	if (tty_init(el) == -1)
91 		el->el_flags |= NO_TTY;
92 	(void) ch_init(el);
93 	(void) search_init(el);
94 	(void) hist_init(el);
95 	(void) prompt_init(el);
96 	(void) sig_init(el);
97 
98 	return (el);
99 }
100 
101 
102 /* el_end():
103  *	Clean up.
104  */
105 public void
106 el_end(EditLine *el)
107 {
108 
109 	if (el == NULL)
110 		return;
111 
112 	el_reset(el);
113 
114 	term_end(el);
115 	key_end(el);
116 	map_end(el);
117 	tty_end(el);
118 	ch_end(el);
119 	search_end(el);
120 	hist_end(el);
121 	prompt_end(el);
122 	sig_end(el);
123 
124 	el_free((ptr_t) el->el_prog);
125 	el_free((ptr_t) el);
126 }
127 
128 
129 /* el_reset():
130  *	Reset the tty and the parser
131  */
132 public void
133 el_reset(EditLine *el)
134 {
135 
136 	tty_cookedmode(el);
137 	ch_reset(el);		/* XXX: Do we want that? */
138 }
139 
140 
141 /* el_set():
142  *	set the editline parameters
143  */
144 public int
145 el_set(EditLine *el, int op, ...)
146 {
147 	va_list va;
148 	int rv;
149 	va_start(va, op);
150 
151 	if (el == NULL)
152 		return (-1);
153 	switch (op) {
154 	case EL_PROMPT:
155 	case EL_RPROMPT:
156 		rv = prompt_set(el, va_arg(va, el_pfunc_t), op);
157 		break;
158 
159 	case EL_TERMINAL:
160 		rv = term_set(el, va_arg(va, char *));
161 		break;
162 
163 	case EL_EDITOR:
164 		rv = map_set_editor(el, va_arg(va, char *));
165 		break;
166 
167 	case EL_SIGNAL:
168 		if (va_arg(va, int))
169 			el->el_flags |= HANDLE_SIGNALS;
170 		else
171 			el->el_flags &= ~HANDLE_SIGNALS;
172 		rv = 0;
173 		break;
174 
175 	case EL_BIND:
176 	case EL_TELLTC:
177 	case EL_SETTC:
178 	case EL_ECHOTC:
179 	case EL_SETTY:
180 	{
181 		char *argv[20];
182 		int i;
183 
184 		for (i = 1; i < 20; i++)
185 			if ((argv[i] = va_arg(va, char *)) == NULL)
186 				break;
187 
188 		switch (op) {
189 		case EL_BIND:
190 			argv[0] = "bind";
191 			rv = map_bind(el, i, argv);
192 			break;
193 
194 		case EL_TELLTC:
195 			argv[0] = "telltc";
196 			rv = term_telltc(el, i, argv);
197 			break;
198 
199 		case EL_SETTC:
200 			argv[0] = "settc";
201 			rv = term_settc(el, i, argv);
202 			break;
203 
204 		case EL_ECHOTC:
205 			argv[0] = "echotc";
206 			rv = term_echotc(el, i, argv);
207 			break;
208 
209 		case EL_SETTY:
210 			argv[0] = "setty";
211 			rv = tty_stty(el, i, argv);
212 			break;
213 
214 		default:
215 			rv = -1;
216 			EL_ABORT((el->el_errfile, "Bad op %d\n", op));
217 			break;
218 		}
219 		break;
220 	}
221 
222 	case EL_ADDFN:
223 	{
224 		char *name = va_arg(va, char *);
225 		char *help = va_arg(va, char *);
226 		el_func_t func = va_arg(va, el_func_t);
227 
228 		rv = map_addfunc(el, name, help, func);
229 		break;
230 	}
231 
232 	case EL_HIST:
233 	{
234 		hist_fun_t func = va_arg(va, hist_fun_t);
235 		ptr_t ptr = va_arg(va, char *);
236 
237 		rv = hist_set(el, func, ptr);
238 		break;
239 	}
240 
241 	case EL_EDITMODE:
242 		if (va_arg(va, int))
243 			el->el_flags &= ~EDIT_DISABLED;
244 		else
245 			el->el_flags |= EDIT_DISABLED;
246 		rv = 0;
247 		break;
248 
249 	default:
250 		rv = -1;
251 	}
252 
253 	va_end(va);
254 	return (rv);
255 }
256 
257 
258 /* el_get():
259  *	retrieve the editline parameters
260  */
261 public int
262 el_get(EditLine *el, int op, void *ret)
263 {
264 	int rv;
265 
266 	if (el == NULL || ret == NULL)
267 		return (-1);
268 	switch (op) {
269 	case EL_PROMPT:
270 	case EL_RPROMPT:
271 		rv = prompt_get(el, (el_pfunc_t *) & ret, op);
272 		break;
273 
274 	case EL_EDITOR:
275 		rv = map_get_editor(el, (const char **) &ret);
276 		break;
277 
278 	case EL_SIGNAL:
279 		*((int *) ret) = (el->el_flags & HANDLE_SIGNALS);
280 		rv = 0;
281 		break;
282 
283 	case EL_EDITMODE:
284 		*((int *) ret) = (!(el->el_flags & EDIT_DISABLED));
285 		rv = 0;
286 		break;
287 
288 #if 0				/* XXX */
289 	case EL_TERMINAL:
290 		rv = term_get(el, (const char *) &ret);
291 		break;
292 
293 	case EL_BIND:
294 	case EL_TELLTC:
295 	case EL_SETTC:
296 	case EL_ECHOTC:
297 	case EL_SETTY:
298 	{
299 		char *argv[20];
300 		int i;
301 
302 		for (i = 1; i < 20; i++)
303 			if ((argv[i] = va_arg(va, char *)) == NULL)
304 				break;
305 
306 		switch (op) {
307 		case EL_BIND:
308 			argv[0] = "bind";
309 			rv = map_bind(el, i, argv);
310 			break;
311 
312 		case EL_TELLTC:
313 			argv[0] = "telltc";
314 			rv = term_telltc(el, i, argv);
315 			break;
316 
317 		case EL_SETTC:
318 			argv[0] = "settc";
319 			rv = term_settc(el, i, argv);
320 			break;
321 
322 		case EL_ECHOTC:
323 			argv[0] = "echotc";
324 			rv = term_echotc(el, i, argv);
325 			break;
326 
327 		case EL_SETTY:
328 			argv[0] = "setty";
329 			rv = tty_stty(el, i, argv);
330 			break;
331 
332 		default:
333 			rv = -1;
334 			EL_ABORT((el->errfile, "Bad op %d\n", op));
335 			break;
336 		}
337 		break;
338 	}
339 
340 	case EL_ADDFN:
341 	{
342 		char *name = va_arg(va, char *);
343 		char *help = va_arg(va, char *);
344 		el_func_t func = va_arg(va, el_func_t);
345 
346 		rv = map_addfunc(el, name, help, func);
347 		break;
348 	}
349 
350 	case EL_HIST:
351 		{
352 			hist_fun_t func = va_arg(va, hist_fun_t);
353 			ptr_t ptr = va_arg(va, char *);
354 			rv = hist_set(el, func, ptr);
355 		}
356 		break;
357 #endif /* XXX */
358 
359 	default:
360 		rv = -1;
361 	}
362 
363 	return (rv);
364 }
365 
366 
367 /* el_line():
368  *	Return editing info
369  */
370 public const LineInfo *
371 el_line(EditLine *el)
372 {
373 
374 	return (const LineInfo *) (void *) &el->el_line;
375 }
376 
377 static const char elpath[] = "/.editrc";
378 
379 /* el_source():
380  *	Source a file
381  */
382 public int
383 el_source(EditLine *el, const char *fname)
384 {
385 	FILE *fp;
386 	size_t len;
387 	char *ptr, path[MAXPATHLEN];
388 
389 	fp = NULL;
390 	if (fname == NULL) {
391 		if (issetugid())
392 			return (-1);
393 		if ((ptr = getenv("HOME")) == NULL)
394 			return (-1);
395 		if (strlcpy(path, ptr, sizeof(path)) >= sizeof(path))
396 			return (-1);
397 		if (strlcat(path, elpath, sizeof(path)) >= sizeof(path))
398 			return (-1);
399 		fname = path;
400 	}
401 	if (fp == NULL)
402 		fp = fopen(fname, "r");
403 	if (fp == NULL)
404 		return (-1);
405 
406 	while ((ptr = fgetln(fp, &len)) != NULL) {
407 		if (len > 0 && ptr[len - 1] == '\n')
408 			--len;
409 		ptr[len] = '\0';
410 		if (parse_line(el, ptr) == -1) {
411 			(void) fclose(fp);
412 			return (-1);
413 		}
414 	}
415 
416 	(void) fclose(fp);
417 	return (0);
418 }
419 
420 
421 /* el_resize():
422  *	Called from program when terminal is resized
423  */
424 public void
425 el_resize(EditLine *el)
426 {
427 	int lins, cols;
428 	sigset_t oset, nset;
429 
430 	(void) sigemptyset(&nset);
431 	(void) sigaddset(&nset, SIGWINCH);
432 	(void) sigprocmask(SIG_BLOCK, &nset, &oset);
433 
434 	/* get the correct window size */
435 	if (term_get_size(el, &lins, &cols))
436 		term_change_size(el, lins, cols);
437 
438 	(void) sigprocmask(SIG_SETMASK, &oset, NULL);
439 }
440 
441 
442 /* el_beep():
443  *	Called from the program to beep
444  */
445 public void
446 el_beep(EditLine *el)
447 {
448 
449 	term_beep(el);
450 }
451 
452 
453 /* el_editmode()
454  *	Set the state of EDIT_DISABLED from the `edit' command.
455  */
456 protected int
457 /*ARGSUSED*/
458 el_editmode(EditLine *el, int argc, char **argv)
459 {
460 	const char *how;
461 
462 	if (argv == NULL || argc != 2 || argv[1] == NULL)
463 		return (-1);
464 
465 	how = argv[1];
466 	if (strcmp(how, "on") == 0)
467 		el->el_flags &= ~EDIT_DISABLED;
468 	else if (strcmp(how, "off") == 0)
469 		el->el_flags |= EDIT_DISABLED;
470 	else {
471 		(void) fprintf(el->el_errfile, "edit: Bad value `%s'.\n", how);
472 		return (-1);
473 	}
474 	return (0);
475 }
476