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