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