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