xref: /freebsd/bin/sh/input.c (revision 3a31b7eb32ad60e1e05b2b2e184ff47e4afbb874)
1 /*-
2  * Copyright (c) 1991, 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  * 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 
37 #ifndef lint
38 #if 0
39 static char sccsid[] = "@(#)input.c	8.3 (Berkeley) 6/9/95";
40 #endif
41 static const char rcsid[] =
42   "$FreeBSD$";
43 #endif /* not lint */
44 
45 #include <stdio.h>	/* defines BUFSIZ */
46 #include <fcntl.h>
47 #include <errno.h>
48 #include <unistd.h>
49 #include <stdlib.h>
50 #include <string.h>
51 
52 /*
53  * This file implements the input routines used by the parser.
54  */
55 
56 #include "shell.h"
57 #include "redir.h"
58 #include "syntax.h"
59 #include "input.h"
60 #include "output.h"
61 #include "options.h"
62 #include "memalloc.h"
63 #include "error.h"
64 #include "alias.h"
65 #include "parser.h"
66 #include "myhistedit.h"
67 
68 #define EOF_NLEFT -99		/* value of parsenleft when EOF pushed back */
69 
70 MKINIT
71 struct strpush {
72 	struct strpush *prev;	/* preceding string on stack */
73 	char *prevstring;
74 	int prevnleft;
75 	int prevlleft;
76 	struct alias *ap;	/* if push was associated with an alias */
77 };
78 
79 /*
80  * The parsefile structure pointed to by the global variable parsefile
81  * contains information about the current file being read.
82  */
83 
84 MKINIT
85 struct parsefile {
86 	struct parsefile *prev;	/* preceding file on stack */
87 	int linno;		/* current line */
88 	int fd;			/* file descriptor (or -1 if string) */
89 	int nleft;		/* number of chars left in this line */
90 	int lleft;		/* number of lines left in this buffer */
91 	char *nextc;		/* next char in buffer */
92 	char *buf;		/* input buffer */
93 	struct strpush *strpush; /* for pushing strings at this level */
94 	struct strpush basestrpush; /* so pushing one is fast */
95 };
96 
97 
98 int plinno = 1;			/* input line number */
99 MKINIT int parsenleft;		/* copy of parsefile->nleft */
100 MKINIT int parselleft;		/* copy of parsefile->lleft */
101 char *parsenextc;		/* copy of parsefile->nextc */
102 MKINIT struct parsefile basepf;	/* top level input file */
103 char basebuf[BUFSIZ];		/* buffer for top level input file */
104 struct parsefile *parsefile = &basepf;	/* current input file */
105 int init_editline = 0;		/* editline library initialized? */
106 int whichprompt;		/* 1 == PS1, 2 == PS2 */
107 
108 EditLine *el;			/* cookie for editline package */
109 
110 STATIC void pushfile __P((void));
111 static int preadfd __P((void));
112 
113 #ifdef mkinit
114 INCLUDE "input.h"
115 INCLUDE "error.h"
116 
117 INIT {
118 	extern char basebuf[];
119 
120 	basepf.nextc = basepf.buf = basebuf;
121 }
122 
123 RESET {
124 	if (exception != EXSHELLPROC)
125 		parselleft = parsenleft = 0;	/* clear input buffer */
126 	popallfiles();
127 }
128 
129 SHELLPROC {
130 	popallfiles();
131 }
132 #endif
133 
134 
135 /*
136  * Read a line from the script.
137  */
138 
139 char *
140 pfgets(line, len)
141 	char *line;
142 	int len;
143 {
144 	char *p = line;
145 	int nleft = len;
146 	int c;
147 
148 	while (--nleft > 0) {
149 		c = pgetc_macro();
150 		if (c == PEOF) {
151 			if (p == line)
152 				return NULL;
153 			break;
154 		}
155 		*p++ = c;
156 		if (c == '\n')
157 			break;
158 	}
159 	*p = '\0';
160 	return line;
161 }
162 
163 
164 
165 /*
166  * Read a character from the script, returning PEOF on end of file.
167  * Nul characters in the input are silently discarded.
168  */
169 
170 int
171 pgetc()
172 {
173 	return pgetc_macro();
174 }
175 
176 
177 static int
178 preadfd()
179 {
180 	int nr;
181 	parsenextc = parsefile->buf;
182 
183 retry:
184 #ifndef NO_HISTORY
185 	if (parsefile->fd == 0 && el) {
186 		const char *rl_cp;
187 
188 		rl_cp = el_gets(el, &nr);
189 		if (rl_cp == NULL)
190 			nr = 0;
191 		else {
192 			/* XXX - BUFSIZE should redesign so not necessary */
193 			(void) strcpy(parsenextc, rl_cp);
194 		}
195 	} else
196 #endif
197 		nr = read(parsefile->fd, parsenextc, BUFSIZ - 1);
198 
199 	if (nr <= 0) {
200                 if (nr < 0) {
201                         if (errno == EINTR)
202                                 goto retry;
203                         if (parsefile->fd == 0 && errno == EWOULDBLOCK) {
204                                 int flags = fcntl(0, F_GETFL, 0);
205                                 if (flags >= 0 && flags & O_NONBLOCK) {
206                                         flags &=~ O_NONBLOCK;
207                                         if (fcntl(0, F_SETFL, flags) >= 0) {
208 						out2str("sh: turning off NDELAY mode\n");
209                                                 goto retry;
210                                         }
211                                 }
212                         }
213                 }
214                 nr = -1;
215 	}
216 	return nr;
217 }
218 
219 /*
220  * Refill the input buffer and return the next input character:
221  *
222  * 1) If a string was pushed back on the input, pop it;
223  * 2) If an EOF was pushed back (parsenleft == EOF_NLEFT) or we are reading
224  *    from a string so we can't refill the buffer, return EOF.
225  * 3) If there is more in this buffer, use it else call read to fill it.
226  * 4) Process input up to the next newline, deleting nul characters.
227  */
228 
229 int
230 preadbuffer()
231 {
232 	char *p, *q;
233 	int more;
234 	int something;
235 	char savec;
236 
237 	if (parsefile->strpush) {
238 		popstring();
239 		if (--parsenleft >= 0)
240 			return (*parsenextc++);
241 	}
242 	if (parsenleft == EOF_NLEFT || parsefile->buf == NULL)
243 		return PEOF;
244 	flushout(&output);
245 	flushout(&errout);
246 
247 again:
248 	if (parselleft <= 0) {
249 		if ((parselleft = preadfd()) == -1) {
250 			parselleft = parsenleft = EOF_NLEFT;
251 			return PEOF;
252 		}
253 	}
254 
255 	q = p = parsenextc;
256 
257 	/* delete nul characters */
258 	something = 0;
259 	for (more = 1; more;) {
260 		switch (*p) {
261 		case '\0':
262 			p++;	/* Skip nul */
263 			goto check;
264 
265 		case '\t':
266 		case ' ':
267 			break;
268 
269 		case '\n':
270 			parsenleft = q - parsenextc;
271 			more = 0; /* Stop processing here */
272 			break;
273 
274 		default:
275 			something = 1;
276 			break;
277 		}
278 
279 		*q++ = *p++;
280 check:
281 		if (--parselleft <= 0) {
282 			parsenleft = q - parsenextc - 1;
283 			if (parsenleft < 0)
284 				goto again;
285 			*q = '\0';
286 			more = 0;
287 		}
288 	}
289 
290 	savec = *q;
291 	*q = '\0';
292 
293 #ifndef NO_HISTORY
294 	if (parsefile->fd == 0 && hist && something) {
295 		HistEvent he;
296 		INTOFF;
297 		history(hist, &he, whichprompt == 1 ? H_ENTER : H_ADD,
298 		    parsenextc);
299 		INTON;
300 	}
301 #endif
302 
303 	if (vflag) {
304 		out2str(parsenextc);
305 		flushout(out2);
306 	}
307 
308 	*q = savec;
309 
310 	return *parsenextc++;
311 }
312 
313 /*
314  * Undo the last call to pgetc.  Only one character may be pushed back.
315  * PEOF may be pushed back.
316  */
317 
318 void
319 pungetc() {
320 	parsenleft++;
321 	parsenextc--;
322 }
323 
324 /*
325  * Push a string back onto the input at this current parsefile level.
326  * We handle aliases this way.
327  */
328 void
329 pushstring(s, len, ap)
330 	char *s;
331 	int len;
332 	void *ap;
333 	{
334 	struct strpush *sp;
335 
336 	INTOFF;
337 /*dprintf("*** calling pushstring: %s, %d\n", s, len);*/
338 	if (parsefile->strpush) {
339 		sp = ckmalloc(sizeof (struct strpush));
340 		sp->prev = parsefile->strpush;
341 		parsefile->strpush = sp;
342 	} else
343 		sp = parsefile->strpush = &(parsefile->basestrpush);
344 	sp->prevstring = parsenextc;
345 	sp->prevnleft = parsenleft;
346 	sp->prevlleft = parselleft;
347 	sp->ap = (struct alias *)ap;
348 	if (ap)
349 		((struct alias *)ap)->flag |= ALIASINUSE;
350 	parsenextc = s;
351 	parsenleft = len;
352 	INTON;
353 }
354 
355 void
356 popstring()
357 {
358 	struct strpush *sp = parsefile->strpush;
359 
360 	INTOFF;
361 	parsenextc = sp->prevstring;
362 	parsenleft = sp->prevnleft;
363 	parselleft = sp->prevlleft;
364 /*dprintf("*** calling popstring: restoring to '%s'\n", parsenextc);*/
365 	if (sp->ap)
366 		sp->ap->flag &= ~ALIASINUSE;
367 	parsefile->strpush = sp->prev;
368 	if (sp != &(parsefile->basestrpush))
369 		ckfree(sp);
370 	INTON;
371 }
372 
373 /*
374  * Set the input to take input from a file.  If push is set, push the
375  * old input onto the stack first.
376  */
377 
378 void
379 setinputfile(fname, push)
380 	char *fname;
381 	int push;
382 {
383 	int fd;
384 	int fd2;
385 
386 	INTOFF;
387 	if ((fd = open(fname, O_RDONLY)) < 0)
388 		error("Can't open %s: %s", fname, strerror(errno));
389 	if (fd < 10) {
390 		fd2 = copyfd(fd, 10);
391 		close(fd);
392 		if (fd2 < 0)
393 			error("Out of file descriptors");
394 		fd = fd2;
395 	}
396 	setinputfd(fd, push);
397 	INTON;
398 }
399 
400 
401 /*
402  * Like setinputfile, but takes an open file descriptor.  Call this with
403  * interrupts off.
404  */
405 
406 void
407 setinputfd(fd, push)
408 	int fd, push;
409 {
410 	(void)fcntl(fd, F_SETFD, FD_CLOEXEC);
411 	if (push) {
412 		pushfile();
413 		parsefile->buf = ckmalloc(BUFSIZ);
414 	}
415 	if (parsefile->fd > 0)
416 		close(parsefile->fd);
417 	parsefile->fd = fd;
418 	if (parsefile->buf == NULL)
419 		parsefile->buf = ckmalloc(BUFSIZ);
420 	parselleft = parsenleft = 0;
421 	plinno = 1;
422 }
423 
424 
425 /*
426  * Like setinputfile, but takes input from a string.
427  */
428 
429 void
430 setinputstring(string, push)
431 	char *string;
432 	int push;
433 	{
434 	INTOFF;
435 	if (push)
436 		pushfile();
437 	parsenextc = string;
438 	parselleft = parsenleft = strlen(string);
439 	parsefile->buf = NULL;
440 	plinno = 1;
441 	INTON;
442 }
443 
444 
445 
446 /*
447  * To handle the "." command, a stack of input files is used.  Pushfile
448  * adds a new entry to the stack and popfile restores the previous level.
449  */
450 
451 STATIC void
452 pushfile() {
453 	struct parsefile *pf;
454 
455 	parsefile->nleft = parsenleft;
456 	parsefile->lleft = parselleft;
457 	parsefile->nextc = parsenextc;
458 	parsefile->linno = plinno;
459 	pf = (struct parsefile *)ckmalloc(sizeof (struct parsefile));
460 	pf->prev = parsefile;
461 	pf->fd = -1;
462 	pf->strpush = NULL;
463 	pf->basestrpush.prev = NULL;
464 	parsefile = pf;
465 }
466 
467 
468 void
469 popfile() {
470 	struct parsefile *pf = parsefile;
471 
472 	INTOFF;
473 	if (pf->fd >= 0)
474 		close(pf->fd);
475 	if (pf->buf)
476 		ckfree(pf->buf);
477 	while (pf->strpush)
478 		popstring();
479 	parsefile = pf->prev;
480 	ckfree(pf);
481 	parsenleft = parsefile->nleft;
482 	parselleft = parsefile->lleft;
483 	parsenextc = parsefile->nextc;
484 	plinno = parsefile->linno;
485 	INTON;
486 }
487 
488 
489 /*
490  * Return to top level.
491  */
492 
493 void
494 popallfiles() {
495 	while (parsefile != &basepf)
496 		popfile();
497 }
498 
499 
500 
501 /*
502  * Close the file(s) that the shell is reading commands from.  Called
503  * after a fork is done.
504  */
505 
506 void
507 closescript() {
508 	popallfiles();
509 	if (parsefile->fd > 0) {
510 		close(parsefile->fd);
511 		parsefile->fd = 0;
512 	}
513 }
514