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