bin/sh/parser.h

   1 /*-
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Kenneth Almquist.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)parser.h    8.3 (Berkeley) 5/4/95
  37  * $FreeBSD: head/bin/sh/parser.h 253650 2013-07-25 15:08:41Z jilles $
  38  */
  39
  40 /* control characters in argument strings */
  41 #define CTLESC '\300'
  42 #define CTLVAR '\301'
  43 #define CTLENDVAR '\371'
  44 #define CTLBACKQ '\372'
  45 #define CTLQUOTE 01             /* ored with CTLBACKQ code if in quotes */
  46 /*      CTLBACKQ | CTLQUOTE == '\373' */
  47 #define CTLARI  '\374'
  48 #define CTLENDARI '\375'
  49 #define CTLQUOTEMARK '\376'
  50 #define CTLQUOTEEND '\377' /* only for ${v+-...} */
  51
  52 /* variable substitution byte (follows CTLVAR) */
  53 #define VSTYPE          0x0f    /* type of variable substitution */
  54 #define VSNUL           0x10    /* colon--treat the empty string as unset */
  55 #define VSLINENO        0x20    /* expansion of $LINENO, the line number \
  56                                    follows immediately */
  57 #define VSQUOTE         0x80    /* inside double quotes--suppress splitting */
  58
  59 /* values of VSTYPE field */
  60 #define VSNORMAL        0x1             /* normal variable:  $var or ${var} */
  61 #define VSMINUS         0x2             /* ${var-text} */
  62 #define VSPLUS          0x3             /* ${var+text} */
  63 #define VSQUESTION      0x4             /* ${var?message} */
  64 #define VSASSIGN        0x5             /* ${var=text} */
  65 #define VSTRIMLEFT      0x6             /* ${var#pattern} */
  66 #define VSTRIMLEFTMAX   0x7             /* ${var##pattern} */
  67 #define VSTRIMRIGHT     0x8             /* ${var%pattern} */
  68 #define VSTRIMRIGHTMAX  0x9             /* ${var%%pattern} */
  69 #define VSLENGTH        0xa             /* ${#var} */
  70 #define VSERROR         0xb             /* Syntax error, issue when expanded */
  71
  72
  73 /*
  74  * NEOF is returned by parsecmd when it encounters an end of file.  It
  75  * must be distinct from NULL, so we use the address of a variable that
  76  * happens to be handy.
  77  */
  78 extern int tokpushback;
  79 #define NEOF ((union node *)&tokpushback)
  80 extern int whichprompt;         /* 1 == PS1, 2 == PS2 */
  81 extern const char *const parsekwd[];
  82
  83
  84 union node *parsecmd(int);
  85 void fixredir(union node *, const char *, int);
  86 void resetparser(void);
  87 int goodname(const char *);
  88 int isassignment(const char *);
  89 const char *getprompt(void *);
  90 const char *expandstr(const char *);