/bin/sh/histedit.c

  1/*-
  2 * Copyright (c) 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 * Kenneth Almquist.
  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 * 4. 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
 33#ifndef lint
 34#if 0
 35static char sccsid[] = "@(#)histedit.c	8.2 (Berkeley) 5/4/95";
 36#endif
 37#endif /* not lint */
 38#include <sys/cdefs.h>
 39__FBSDID("$FreeBSD$");
 40
 41#include <sys/param.h>
 42#include <limits.h>
 43#include <paths.h>
 44#include <stdio.h>
 45#include <stdlib.h>
 46#include <unistd.h>
 47/*
 48 * Editline and history functions (and glue).
 49 */
 50#include "shell.h"
 51#include "parser.h"
 52#include "var.h"
 53#include "options.h"
 54#include "main.h"
 55#include "output.h"
 56#include "mystring.h"
 57#ifndef NO_HISTORY
 58#include "myhistedit.h"
 59#include "error.h"
 60#include "eval.h"
 61#include "memalloc.h"
 62#include "builtins.h"
 63
 64#define MAXHISTLOOPS	4	/* max recursions through fc */
 65#define DEFEDITOR	"ed"	/* default editor *should* be $EDITOR */
 66
 67History *hist;	/* history cookie */
 68EditLine *el;	/* editline cookie */
 69int displayhist;
 70static FILE *el_in, *el_out, *el_err;
 71
 72static char *fc_replace(const char *, char *, char *);
 73static int not_fcnumber(const char *);
 74static int str_to_event(const char *, int);
 75
 76/*
 77 * Set history and editing status.  Called whenever the status may
 78 * have changed (figures out what to do).
 79 */
 80void
 81histedit(void)
 82{
 83
 84#define editing (Eflag || Vflag)
 85
 86	if (iflag) {
 87		if (!hist) {
 88			/*
 89			 * turn history on
 90			 */
 91			INTOFF;
 92			hist = history_init();
 93			INTON;
 94
 95			if (hist != NULL)
 96				sethistsize(histsizeval());
 97			else
 98				out2fmt_flush("sh: can't initialize history\n");
 99		}
100		if (editing && !el && isatty(0)) { /* && isatty(2) ??? */
101			/*
102			 * turn editing on
103			 */
104			char *term;
105
106			INTOFF;
107			if (el_in == NULL)
108				el_in = fdopen(0, "r");
109			if (el_err == NULL)
110				el_err = fdopen(1, "w");
111			if (el_out == NULL)
112				el_out = fdopen(2, "w");
113			if (el_in == NULL || el_err == NULL || el_out == NULL)
114				goto bad;
115			term = lookupvar("TERM");
116			if (term)
117				setenv("TERM", term, 1);
118			else
119				unsetenv("TERM");
120			el = el_init(arg0, el_in, el_out, el_err);
121			if (el != NULL) {
122				if (hist)
123					el_set(el, EL_HIST, history, hist);
124				el_set(el, EL_PROMPT, getprompt);
125				el_set(el, EL_ADDFN, "sh-complete",
126				    "Filename completion",
127				    _el_fn_sh_complete);
128			} else {
129bad:
130				out2fmt_flush("sh: can't initialize editing\n");
131			}
132			INTON;
133		} else if (!editing && el) {
134			INTOFF;
135			el_end(el);
136			el = NULL;
137			INTON;
138		}
139		if (el) {
140			if (Vflag)
141				el_set(el, EL_EDITOR, "vi");
142			else if (Eflag)
143				el_set(el, EL_EDITOR, "emacs");
144			el_set(el, EL_BIND, "^I", "sh-complete", NULL);
145			el_source(el, NULL);
146		}
147	} else {
148		INTOFF;
149		if (el) {	/* no editing if not interactive */
150			el_end(el);
151			el = NULL;
152		}
153		if (hist) {
154			history_end(hist);
155			hist = NULL;
156		}
157		INTON;
158	}
159}
160
161
162void
163sethistsize(const char *hs)
164{
165	int histsize;
166	HistEvent he;
167
168	if (hist != NULL) {
169		if (hs == NULL || *hs == '\0' ||
170		   (histsize = atoi(hs)) < 0)
171			histsize = 100;
172		history(hist, &he, H_SETSIZE, histsize);
173		history(hist, &he, H_SETUNIQUE, 1);
174	}
175}
176
177void
178setterm(const char *term)
179{
180	if (rootshell && el != NULL && term != NULL)
181		el_set(el, EL_TERMINAL, term);
182}
183
184int
185histcmd(int argc, char **argv __unused)
186{
187	int ch;
188	const char *editor = NULL;
189	HistEvent he;
190	int lflg = 0, nflg = 0, rflg = 0, sflg = 0;
191	int i, retval;
192	const char *firststr, *laststr;
193	int first, last, direction;
194	char *pat = NULL, *repl = NULL;
195	static int active = 0;
196	struct jmploc jmploc;
197	struct jmploc *savehandler;
198	char editfilestr[PATH_MAX];
199	char *volatile editfile;
200	FILE *efp = NULL;
201	int oldhistnum;
202
203	if (hist == NULL)
204		error("history not active");
205
206	if (argc == 1)
207		error("missing history argument");
208
209	while (not_fcnumber(*argptr) && (ch = nextopt("e:lnrs")) != '\0')
210		switch ((char)ch) {
211		case 'e':
212			editor = shoptarg;
213			break;
214		case 'l':
215			lflg = 1;
216			break;
217		case 'n':
218			nflg = 1;
219			break;
220		case 'r':
221			rflg = 1;
222			break;
223		case 's':
224			sflg = 1;
225			break;
226		}
227
228	savehandler = handler;
229	/*
230	 * If executing...
231	 */
232	if (lflg == 0 || editor || sflg) {
233		lflg = 0;	/* ignore */
234		editfile = NULL;
235		/*
236		 * Catch interrupts to reset active counter and
237		 * cleanup temp files.
238		 */
239		if (setjmp(jmploc.loc)) {
240			active = 0;
241			if (editfile)
242				unlink(editfile);
243			handler = savehandler;
244			longjmp(handler->loc, 1);
245		}
246		handler = &jmploc;
247		if (++active > MAXHISTLOOPS) {
248			active = 0;
249			displayhist = 0;
250			error("called recursively too many times");
251		}
252		/*
253		 * Set editor.
254		 */
255		if (sflg == 0) {
256			if (editor == NULL &&
257			    (editor = bltinlookup("FCEDIT", 1)) == NULL &&
258			    (editor = bltinlookup("EDITOR", 1)) == NULL)
259				editor = DEFEDITOR;
260			if (editor[0] == '-' && editor[1] == '\0') {
261				sflg = 1;	/* no edit */
262				editor = NULL;
263			}
264		}
265	}
266
267	/*
268	 * If executing, parse [old=new] now
269	 */
270	if (lflg == 0 && *argptr != NULL &&
271	     ((repl = strchr(*argptr, '=')) != NULL)) {
272		pat = *argptr;
273		*repl++ = '\0';
274		argptr++;
275	}
276	/*
277	 * determine [first] and [last]
278	 */
279	if (*argptr == NULL) {
280		firststr = lflg ? "-16" : "-1";
281		laststr = "-1";
282	} else if (argptr[1] == NULL) {
283		firststr = argptr[0];
284		laststr = lflg ? "-1" : argptr[0];
285	} else if (argptr[2] == NULL) {
286		firststr = argptr[0];
287		laststr = argptr[1];
288	} else
289		error("too many arguments");
290	/*
291	 * Turn into event numbers.
292	 */
293	first = str_to_event(firststr, 0);
294	last = str_to_event(laststr, 1);
295
296	if (rflg) {
297		i = last;
298		last = first;
299		first = i;
300	}
301	/*
302	 * XXX - this should not depend on the event numbers
303	 * always increasing.  Add sequence numbers or offset
304	 * to the history element in next (diskbased) release.
305	 */
306	direction = first < last ? H_PREV : H_NEXT;
307
308	/*
309	 * If editing, grab a temp file.
310	 */
311	if (editor) {
312		int fd;
313		INTOFF;		/* easier */
314		sprintf(editfilestr, "%s/_shXXXXXX", _PATH_TMP);
315		if ((fd = mkstemp(editfilestr)) < 0)
316			error("can't create temporary file %s", editfile);
317		editfile = editfilestr;
318		if ((efp = fdopen(fd, "w")) == NULL) {
319			close(fd);
320			error("Out of space");
321		}
322	}
323
324	/*
325	 * Loop through selected history events.  If listing or executing,
326	 * do it now.  Otherwise, put into temp file and call the editor
327	 * after.
328	 *
329	 * The history interface needs rethinking, as the following
330	 * convolutions will demonstrate.
331	 */
332	history(hist, &he, H_FIRST);
333	retval = history(hist, &he, H_NEXT_EVENT, first);
334	for (;retval != -1; retval = history(hist, &he, direction)) {
335		if (lflg) {
336			if (!nflg)
337				out1fmt("%5d ", he.num);
338			out1str(he.str);
339		} else {
340			char *s = pat ?
341			   fc_replace(he.str, pat, repl) : (char *)he.str;
342
343			if (sflg) {
344				if (displayhist) {
345					out2str(s);
346					flushout(out2);
347				}
348				evalstring(s, 0);
349				if (displayhist && hist) {
350					/*
351					 *  XXX what about recursive and
352					 *  relative histnums.
353					 */
354					oldhistnum = he.num;
355					history(hist, &he, H_ENTER, s);
356					/*
357					 * XXX H_ENTER moves the internal
358					 * cursor, set it back to the current
359					 * entry.
360					 */
361					retval = history(hist, &he,
362					    H_NEXT_EVENT, oldhistnum);
363				}
364			} else
365				fputs(s, efp);
366		}
367		/*
368		 * At end?  (if we were to lose last, we'd sure be
369		 * messed up).
370		 */
371		if (he.num == last)
372			break;
373	}
374	if (editor) {
375		char *editcmd;
376
377		fclose(efp);
378		editcmd = stalloc(strlen(editor) + strlen(editfile) + 2);
379		sprintf(editcmd, "%s %s", editor, editfile);
380		evalstring(editcmd, 0);	/* XXX - should use no JC command */
381		INTON;
382		readcmdfile(editfile);	/* XXX - should read back - quick tst */
383		unlink(editfile);
384	}
385
386	if (lflg == 0 && active > 0)
387		--active;
388	if (displayhist)
389		displayhist = 0;
390	handler = savehandler;
391	return 0;
392}
393
394static char *
395fc_replace(const char *s, char *p, char *r)
396{
397	char *dest;
398	int plen = strlen(p);
399
400	STARTSTACKSTR(dest);
401	while (*s) {
402		if (*s == *p && strncmp(s, p, plen) == 0) {
403			STPUTS(r, dest);
404			s += plen;
405			*p = '\0';	/* so no more matches */
406		} else
407			STPUTC(*s++, dest);
408	}
409	STPUTC('\0', dest);
410	dest = grabstackstr(dest);
411
412	return (dest);
413}
414
415static int
416not_fcnumber(const char *s)
417{
418	if (s == NULL)
419		return (0);
420	if (*s == '-')
421		s++;
422	return (!is_number(s));
423}
424
425static int
426str_to_event(const char *str, int last)
427{
428	HistEvent he;
429	const char *s = str;
430	int relative = 0;
431	int i, retval;
432
433	retval = history(hist, &he, H_FIRST);
434	switch (*s) {
435	case '-':
436		relative = 1;
437		/*FALLTHROUGH*/
438	case '+':
439		s++;
440	}
441	if (is_number(s)) {
442		i = atoi(s);
443		if (relative) {
444			while (retval != -1 && i--) {
445				retval = history(hist, &he, H_NEXT);
446			}
447			if (retval == -1)
448				retval = history(hist, &he, H_LAST);
449		} else {
450			retval = history(hist, &he, H_NEXT_EVENT, i);
451			if (retval == -1) {
452				/*
453				 * the notion of first and last is
454				 * backwards to that of the history package
455				 */
456				retval = history(hist, &he, last ? H_FIRST : H_LAST);
457			}
458		}
459		if (retval == -1)
460			error("history number %s not found (internal error)",
461			       str);
462	} else {
463		/*
464		 * pattern
465		 */
466		retval = history(hist, &he, H_PREV_STR, str);
467		if (retval == -1)
468			error("history pattern not found: %s", str);
469	}
470	return (he.num);
471}
472
473int
474bindcmd(int argc, char **argv)
475{
476
477	if (el == NULL)
478		error("line editing is disabled");
479	return (el_parse(el, argc, (const char **)argv));
480}
481
482#else
483#include "error.h"
484
485int
486histcmd(int argc, char **argv)
487{
488
489	error("not compiled with history support");
490	/*NOTREACHED*/
491	return (0);
492}
493
494int
495bindcmd(int argc, char **argv)
496{
497
498	error("not compiled with line editing support");
499	return (0);
500}
501#endif