xref: /original-bsd/bin/csh/csh.h (revision c7ef4596)
1 /*-
2  * Copyright (c) 1980, 1991 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * %sccs.include.redist.c%
6  *
7  *	@(#)csh.h	5.23 (Berkeley) 05/28/92
8  */
9 
10 /*
11  * Fundamental definitions which may vary from system to system.
12  *
13  *	BUFSIZ		The i/o buffering size; also limits word size
14  *	MAILINTVL	How often to mailcheck; more often is more expensive
15  */
16 #ifndef BUFSIZ
17 #define	BUFSIZ	1024		/* default buffer size */
18 #endif				/* BUFSIZ */
19 
20 #define FORKSLEEP	10	/* delay loop on non-interactive fork failure */
21 #define	MAILINTVL	600	/* 10 minutes */
22 
23 /*
24  * The shell moves std in/out/diag and the old std input away from units
25  * 0, 1, and 2 so that it is easy to set up these standards for invoked
26  * commands.
27  */
28 #define	FSHTTY	15		/* /dev/tty when manip pgrps */
29 #define	FSHIN	16		/* Preferred desc for shell input */
30 #define	FSHOUT	17		/* ... shell output */
31 #define	FSHERR	18		/* ... shell diagnostics */
32 #define	FOLDSTD	19		/* ... old std input */
33 
34 #ifdef PROF
35 #define	xexit(n)	done(n)
36 #endif
37 
38 #ifdef SHORT_STRINGS
39 typedef short Char;
40 
41 #define SAVE(a) (Strsave(str2short(a)))
42 #else
43 typedef char Char;
44 
45 #define SAVE(a) (strsave(a))
46 #endif
47 
48 typedef void *ioctl_t;		/* Third arg of ioctl */
49 
50 typedef void *ptr_t;
51 
52 #include "const.h"
53 #include "char.h"
54 #include "err.h"
55 
56 #define xmalloc(i)	Malloc(i)
57 #define xrealloc(p, i)	Realloc(p, i)
58 #define xcalloc(n, s)	Calloc(n, s)
59 #define xfree(p)	Free(p)
60 
61 #include <stdio.h>
62 FILE *cshin, *cshout, *csherr;
63 
64 #define	isdir(d)	((d.st_mode & S_IFMT) == S_IFDIR)
65 
66 typedef int bool;
67 
68 #define	eq(a, b)	(Strcmp(a, b) == 0)
69 
70 /* globone() flags */
71 #define G_ERROR		0	/* default action: error if multiple words */
72 #define G_IGNORE	1	/* ignore the rest of the words */
73 #define G_APPEND	2	/* make a sentence by cat'ing the words */
74 
75 /*
76  * Global flags
77  */
78 bool    chkstop;		/* Warned of stopped jobs... allow exit */
79 bool    didfds;			/* Have setup i/o fd's for child */
80 bool    doneinp;		/* EOF indicator after reset from readc */
81 bool    exiterr;		/* Exit if error or non-zero exit status */
82 bool    child;			/* Child shell ... errors cause exit */
83 bool    haderr;			/* Reset was because of an error */
84 bool    intty;			/* Input is a tty */
85 bool    intact;			/* We are interactive... therefore prompt */
86 bool    justpr;			/* Just print because of :p hist mod */
87 bool    loginsh;		/* We are a loginsh -> .login/.logout */
88 bool    neednote;		/* Need to pnotify() */
89 bool    noexec;			/* Don't execute, just syntax check */
90 bool    pjobs;			/* want to print jobs if interrupted */
91 bool    setintr;		/* Set interrupts on/off -> Wait intr... */
92 bool    timflg;			/* Time the next waited for command */
93 bool    havhash;		/* path hashing is available */
94 
95 #ifdef FILEC
96 bool    filec;			/* doing filename expansion */
97 #endif
98 
99 /*
100  * Global i/o info
101  */
102 Char   *arginp;			/* Argument input for sh -c and internal `xx` */
103 int     onelflg;		/* 2 -> need line for -t, 1 -> exit on read */
104 Char   *ffile;			/* Name of shell file for $0 */
105 
106 char   *seterr;			/* Error message from scanner/parser */
107 Char   *shtemp;			/* Temp name for << shell files in /tmp */
108 
109 #include <sys/types.h>
110 #include <sys/time.h>
111 #include <sys/resource.h>
112 
113 struct timeval time0;		/* Time at which the shell started */
114 struct rusage ru0;
115 
116 /*
117  * Miscellany
118  */
119 Char   *doldol;			/* Character pid for $$ */
120 int	backpid;		/* Pid of the last background process */
121 int     uid, euid;		/* Invokers uid */
122 int     gid, egid;		/* Invokers gid */
123 time_t  chktim;			/* Time mail last checked */
124 int     shpgrp;			/* Pgrp of shell */
125 int     tpgrp;			/* Terminal process group */
126 
127 /* If tpgrp is -1, leave tty alone! */
128 int     opgrp;			/* Initial pgrp and tty pgrp */
129 
130 
131 /*
132  * To be able to redirect i/o for builtins easily, the shell moves the i/o
133  * descriptors it uses away from 0,1,2.
134  * Ideally these should be in units which are closed across exec's
135  * (this saves work) but for version 6, this is not usually possible.
136  * The desired initial values for these descriptors are defined in
137  * local.h.
138  */
139 int   SHIN;			/* Current shell input (script) */
140 int   SHOUT;			/* Shell output */
141 int   SHERR;			/* Diagnostic output... shell errs go here */
142 int   OLDSTD;			/* Old standard input (def for cmds) */
143 
144 /*
145  * Error control
146  *
147  * Errors in scanning and parsing set up an error message to be printed
148  * at the end and complete.  Other errors always cause a reset.
149  * Because of source commands and .cshrc we need nested error catches.
150  */
151 
152 #include <setjmp.h>
153 jmp_buf reslab;
154 
155 #define	setexit()	(setjmp(reslab))
156 #define	reset()		longjmp(reslab, 1)
157  /* Should use structure assignment here */
158 #define	getexit(a)	bcopy((char *)reslab, ((char *)(a)), sizeof reslab)
159 #define	resexit(a)	bcopy((char *)(a), (char *)reslab, sizeof reslab)
160 
161 Char   *gointr;			/* Label for an onintr transfer */
162 
163 #include <signal.h>
164 sig_t parintr;			/* Parents interrupt catch */
165 sig_t parterm;			/* Parents terminate catch */
166 
167 /*
168  * Lexical definitions.
169  *
170  * All lexical space is allocated dynamically.
171  * The eighth/sixteenth bit of characters is used to prevent recognition,
172  * and eventually stripped.
173  */
174 #define	META		0200
175 #define	ASCII		0177
176 #ifdef SHORT_STRINGS
177 #define	CHAR		0377
178 #define	QUOTE 		0100000	/* 16nth char bit used for 'ing */
179 #define	TRIM		0077777	/* Mask to strip quote bit */
180 #else
181 #define	CHAR		0177
182 #define	QUOTE 		0200	/* Eighth char bit used for 'ing */
183 #define	TRIM		0177	/* Mask to strip quote bit */
184 #endif
185 
186 int     AsciiOnly;		/* If set only 7 bits is expected in characters */
187 
188 /*
189  * Each level of input has a buffered input structure.
190  * There are one or more blocks of buffered input for each level,
191  * exactly one if the input is seekable and tell is available.
192  * In other cases, the shell buffers enough blocks to keep all loops
193  * in the buffer.
194  */
195 struct Bin {
196     off_t   Bfseekp;		/* Seek pointer */
197     off_t   Bfbobp;		/* Seekp of beginning of buffers */
198     off_t   Bfeobp;		/* Seekp of end of buffers */
199     int     Bfblocks;		/* Number of buffer blocks */
200     Char  **Bfbuf;		/* The array of buffer blocks */
201 }       B;
202 
203 /*
204  * This structure allows us to seek inside aliases
205  */
206 struct Ain {
207     int type;
208 #define I_SEEK -1		/* Invalid seek */
209 #define A_SEEK	0		/* Alias seek */
210 #define F_SEEK	1		/* File seek */
211 #define E_SEEK	2		/* Eval seek */
212     off_t f_seek;
213     Char **a_seek;
214 } ;
215 extern int aret;		/* What was the last character returned */
216 #define SEEKEQ(a, b) ((a)->type == (b)->type && \
217 		      (a)->f_seek == (b)->f_seek && \
218 		      (a)->a_seek == (b)->a_seek)
219 
220 #define	fseekp	B.Bfseekp
221 #define	fbobp	B.Bfbobp
222 #define	feobp	B.Bfeobp
223 #define	fblocks	B.Bfblocks
224 #define	fbuf	B.Bfbuf
225 
226 /*
227  * The shell finds commands in loops by reseeking the input
228  * For whiles, in particular, it reseeks to the beginning of the
229  * line the while was on; hence the while placement restrictions.
230  */
231 struct Ain lineloc;
232 
233 bool    cantell;		/* Is current source tellable ? */
234 
235 /*
236  * Input lines are parsed into doubly linked circular
237  * lists of words of the following form.
238  */
239 struct wordent {
240     Char   *word;
241     struct wordent *prev;
242     struct wordent *next;
243 };
244 
245 /*
246  * During word building, both in the initial lexical phase and
247  * when expanding $ variable substitutions, expansion by `!' and `$'
248  * must be inhibited when reading ahead in routines which are themselves
249  * processing `!' and `$' expansion or after characters such as `\' or in
250  * quotations.  The following flags are passed to the getC routines
251  * telling them which of these substitutions are appropriate for the
252  * next character to be returned.
253  */
254 #define	DODOL	1
255 #define	DOEXCL	2
256 #define	DOALL	DODOL|DOEXCL
257 
258 /*
259  * Labuf implements a general buffer for lookahead during lexical operations.
260  * Text which is to be placed in the input stream can be stuck here.
261  * We stick parsed ahead $ constructs during initial input,
262  * process id's from `$$', and modified variable values (from qualifiers
263  * during expansion in sh.dol.c) here.
264  */
265 Char   *lap;
266 
267 /*
268  * Parser structure
269  *
270  * Each command is parsed to a tree of command structures and
271  * flags are set bottom up during this process, to be propagated down
272  * as needed during the semantics/exeuction pass (sh.sem.c).
273  */
274 struct command {
275     short   t_dtyp;		/* Type of node 		 */
276 #define	NODE_COMMAND	1	/* t_dcom <t_dlef >t_drit	 */
277 #define	NODE_PAREN	2	/* ( t_dspr ) <t_dlef >t_drit	 */
278 #define	NODE_PIPE	3	/* t_dlef | t_drit		 */
279 #define	NODE_LIST	4	/* t_dlef ; t_drit		 */
280 #define	NODE_OR		5	/* t_dlef || t_drit		 */
281 #define	NODE_AND	6	/* t_dlef && t_drit		 */
282     short   t_dflg;		/* Flags, e.g. F_AMPERSAND|... 	 */
283 #define	F_SAVE	(F_NICE|F_TIME|F_NOHUP)	/* save these when re-doing 	 */
284 
285 #define	F_AMPERSAND	(1<<0)	/* executes in background	 */
286 #define	F_APPEND	(1<<1)	/* output is redirected >>	 */
287 #define	F_PIPEIN	(1<<2)	/* input is a pipe		 */
288 #define	F_PIPEOUT	(1<<3)	/* output is a pipe		 */
289 #define	F_NOFORK	(1<<4)	/* don't fork, last ()ized cmd	 */
290 #define	F_NOINTERRUPT	(1<<5)	/* should be immune from intr's */
291 /* spare */
292 #define	F_STDERR	(1<<7)	/* redirect unit 2 with unit 1	 */
293 #define	F_OVERWRITE	(1<<8)	/* output was !			 */
294 #define	F_READ		(1<<9)	/* input redirection is <<	 */
295 #define	F_REPEAT	(1<<10)	/* reexec aft if, repeat,...	 */
296 #define	F_NICE		(1<<11)	/* t_nice is meaningful 	 */
297 #define	F_NOHUP		(1<<12)	/* nohup this command 		 */
298 #define	F_TIME		(1<<13)	/* time this command 		 */
299     union {
300 	Char   *T_dlef;		/* Input redirect word 		 */
301 	struct command *T_dcar;	/* Left part of list/pipe 	 */
302     }       L;
303     union {
304 	Char   *T_drit;		/* Output redirect word 	 */
305 	struct command *T_dcdr;	/* Right part of list/pipe 	 */
306     }       R;
307 #define	t_dlef	L.T_dlef
308 #define	t_dcar	L.T_dcar
309 #define	t_drit	R.T_drit
310 #define	t_dcdr	R.T_dcdr
311     Char  **t_dcom;		/* Command/argument vector 	 */
312     struct command *t_dspr;	/* Pointer to ()'d subtree 	 */
313     int   t_nice;
314 };
315 
316 
317 /*
318  * These are declared here because they want to be
319  * initialized in sh.init.c (to allow them to be made readonly)
320  */
321 
322 extern struct biltins {
323     char   *bname;
324     void    (*bfunct) __P((Char **, struct command *));
325     short   minargs, maxargs;
326 }       bfunc[];
327 extern int nbfunc;
328 
329 extern struct srch {
330     char   *s_name;
331     short   s_value;
332 }       srchn[];
333 extern int nsrchn;
334 
335 /*
336  * The keywords for the parser
337  */
338 #define	T_BREAK		0
339 #define	T_BRKSW		1
340 #define	T_CASE		2
341 #define	T_DEFAULT 	3
342 #define	T_ELSE		4
343 #define	T_END		5
344 #define	T_ENDIF		6
345 #define	T_ENDSW		7
346 #define	T_EXIT		8
347 #define	T_FOREACH	9
348 #define	T_GOTO		10
349 #define	T_IF		11
350 #define	T_LABEL		12
351 #define	T_LET		13
352 #define	T_SET		14
353 #define	T_SWITCH	15
354 #define	T_TEST		16
355 #define	T_THEN		17
356 #define	T_WHILE		18
357 
358 /*
359  * Structure defining the existing while/foreach loops at this
360  * source level.  Loops are implemented by seeking back in the
361  * input.  For foreach (fe), the word list is attached here.
362  */
363 struct whyle {
364     struct Ain   w_start;	/* Point to restart loop */
365     struct Ain   w_end;		/* End of loop (0 if unknown) */
366     Char  **w_fe, **w_fe0;	/* Current/initial wordlist for fe */
367     Char   *w_fename;		/* Name for fe */
368     struct whyle *w_next;	/* Next (more outer) loop */
369 }      *whyles;
370 
371 /*
372  * Variable structure
373  *
374  * Aliases and variables are stored in AVL balanced binary trees.
375  */
376 struct varent {
377     Char  **vec;		/* Array of words which is the value */
378     Char   *v_name;		/* Name of variable/alias */
379     struct varent *v_link[3];	/* The links, see below */
380     int     v_bal;		/* Balance factor */
381 }       shvhed, aliases;
382 
383 #define v_left		v_link[0]
384 #define v_right		v_link[1]
385 #define v_parent	v_link[2]
386 
387 struct varent *adrof1();
388 
389 #define adrof(v)	adrof1(v, &shvhed)
390 #define value(v)	value1(v, &shvhed)
391 
392 /*
393  * The following are for interfacing redo substitution in
394  * aliases to the lexical routines.
395  */
396 struct wordent *alhistp;	/* Argument list (first) */
397 struct wordent *alhistt;	/* Node after last in arg list */
398 Char  **alvec, *alvecp;		/* The (remnants of) alias vector */
399 
400 /*
401  * Filename/command name expansion variables
402  */
403 int   gflag;			/* After tglob -> is globbing needed? */
404 
405 #define MAXVARLEN 30		/* Maximum number of char in a variable name */
406 
407 /*
408  * Variables for filename expansion
409  */
410 extern Char **gargv;		/* Pointer to the (stack) arglist */
411 extern long gargc;		/* Number args in gargv */
412 
413 /*
414  * Variables for command expansion.
415  */
416 extern Char **pargv;		/* Pointer to the argv list space */
417 extern long pargc;		/* Count of arguments in pargv */
418 Char   *pargs;			/* Pointer to start current word */
419 long    pnleft;			/* Number of chars left in pargs */
420 Char   *pargcp;			/* Current index into pargs */
421 
422 /*
423  * History list
424  *
425  * Each history list entry contains an embedded wordlist
426  * from the scanner, a number for the event, and a reference count
427  * to aid in discarding old entries.
428  *
429  * Essentially "invisible" entries are put on the history list
430  * when history substitution includes modifiers, and thrown away
431  * at the next discarding since their event numbers are very negative.
432  */
433 struct Hist {
434     struct wordent Hlex;
435     int     Hnum;
436     int     Href;
437     struct Hist *Hnext;
438 }       Histlist;
439 
440 struct wordent paraml;		/* Current lexical word list */
441 int     eventno;		/* Next events number */
442 int     lastev;			/* Last event reference (default) */
443 
444 Char    HIST;			/* history invocation character */
445 Char    HISTSUB;		/* auto-substitute character */
446 
447 /*
448  * strings.h:
449  */
450 #ifndef SHORT_STRINGS
451 #define Strchr(a, b)		strchr(a, b)
452 #define Strrchr(a, b)		strrchr(a, b)
453 #define Strcat(a, b)		strcat(a, b)
454 #define Strncat(a, b, c) 	strncat(a, b, c)
455 #define Strcpy(a, b)		strcpy(a, b)
456 #define Strncpy(a, b, c) 	strncpy(a, b, c)
457 #define Strlen(a)		strlen(a)
458 #define Strcmp(a, b)		strcmp(a, b)
459 #define Strncmp(a, b, c)	strncmp(a, b, c)
460 
461 #define Strspl(a, b)		strspl(a, b)
462 #define Strsave(a)		strsave(a)
463 #define Strend(a)		strend(a)
464 #define Strstr(a, b)		strstr(a, b)
465 
466 #define str2short(a) 		(a)
467 #define blk2short(a) 		saveblk(a)
468 #define short2blk(a) 		saveblk(a)
469 #define short2str(a) 		strip(a)
470 #else
471 #define Strchr(a, b)		s_strchr(a, b)
472 #define Strrchr(a, b) 		s_strrchr(a, b)
473 #define Strcat(a, b)		s_strcat(a, b)
474 #define Strncat(a, b, c) 	s_strncat(a, b, c)
475 #define Strcpy(a, b)		s_strcpy(a, b)
476 #define Strncpy(a, b, c)	s_strncpy(a, b, c)
477 #define Strlen(a)		s_strlen(a)
478 #define Strcmp(a, b)		s_strcmp(a, b)
479 #define Strncmp(a, b, c)	s_strncmp(a, b, c)
480 
481 #define Strspl(a, b)		s_strspl(a, b)
482 #define Strsave(a)		s_strsave(a)
483 #define Strend(a)		s_strend(a)
484 #define Strstr(a, b)		s_strstr(a, b)
485 #endif
486 
487 /*
488  * setname is a macro to save space (see sh.err.c)
489  */
490 char   *bname;
491 
492 #define	setname(a)	(bname = (a))
493 
494 Char   *Vsav;
495 Char   *Vdp;
496 Char   *Vexpath;
497 char  **Vt;
498 
499 Char  **evalvec;
500 Char   *evalp;
501 
502 /* word_chars is set by default to WORD_CHARS but can be overridden by
503    the worchars variable--if unset, reverts to WORD_CHARS */
504 
505 Char   *word_chars;
506 
507 #define WORD_CHARS "*?_-.[]~="	/* default chars besides alnums in words */
508 
509 Char   *STR_SHELLPATH;
510 
511 #include <paths.h>
512 #ifdef _PATH_BSHELL
513 Char   *STR_BSHELL;
514 #endif
515 Char   *STR_WORD_CHARS;
516 Char  **STR_environ;
517