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