src/parser.h

   1 /*-
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1997-2005
   5  *      Herbert Xu <herbert@gondor.apana.org.au>.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Kenneth Almquist.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)parser.h    8.3 (Berkeley) 5/4/95
  35  */
  36
  37 /* control characters in argument strings */
  38 #define CTL_FIRST -127          /* first 'special' character */
  39 #define CTLESC -127             /* escape next character */
  40 #define CTLVAR -126             /* variable defn */
  41 #define CTLENDVAR -125
  42 #define CTLBACKQ -124
  43 #define CTLARI -122             /* arithmetic expression */
  44 #define CTLENDARI -121
  45 #define CTLQUOTEMARK -120
  46 #define CTL_LAST -120           /* last 'special' character */
  47
  48 /* variable substitution byte (follows CTLVAR) */
  49 #define VSTYPE  0x0f            /* type of variable substitution */
  50 #define VSNUL   0x10            /* colon--treat the empty string as unset */
  51
  52 /* values of VSTYPE field */
  53 #define VSNORMAL        0x1             /* normal variable:  $var or ${var} */
  54 #define VSMINUS         0x2             /* ${var-text} */
  55 #define VSPLUS          0x3             /* ${var+text} */
  56 #define VSQUESTION      0x4             /* ${var?message} */
  57 #define VSASSIGN        0x5             /* ${var=text} */
  58 #define VSTRIMRIGHT     0x6             /* ${var%pattern} */
  59 #define VSTRIMRIGHTMAX  0x7             /* ${var%%pattern} */
  60 #define VSTRIMLEFT      0x8             /* ${var#pattern} */
  61 #define VSTRIMLEFTMAX   0x9             /* ${var##pattern} */
  62 #define VSLENGTH        0xa             /* ${#var} */
  63
  64 /* values of checkkwd variable */
  65 #define CHKALIAS        0x1
  66 #define CHKKWD          0x2
  67 #define CHKNL           0x4
  68 #define CHKEOFMARK      0x8
  69
  70
  71 /*
  72  * NEOF is returned by parsecmd when it encounters an end of file.  It
  73  * must be distinct from NULL, so we use the address of a variable that
  74  * happens to be handy.
  75  */
  76 extern int tokpushback;
  77 #define NEOF ((union node *)&tokpushback)
  78 extern int whichprompt;         /* 1 == PS1, 2 == PS2 */
  79 extern int checkkwd;
  80
  81
  82 union node *parsecmd(int);
  83 void fixredir(union node *, const char *, int);
  84 const char *getprompt(void *);
  85 const char *const *findkwd(const char *);
  86 char *endofname(const char *);
  87 const char *expandstr(const char *);
  88
  89 static inline int
  90 goodname(const char *p)
  91 {
  92         return !*endofname(p);
  93 }