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