usr.bin/make/shell.h

   1 /*-
   2  * Copyright (c) 1988, 1989, 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1988, 1989 by Adam de Boor
   5  * Copyright (c) 1989 by Berkeley Softworks
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Adam de Boor.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  * $DragonFly: src/usr.bin/make/shell.h,v 1.17 2005/09/22 09:13:38 okumoto Exp $
  40  */
  41
  42 #ifndef shell_h_6002e3b8
  43 #define shell_h_6002e3b8
  44
  45 #include <stdbool.h>
  46
  47 #include "str.h"
  48
  49 /**
  50  * Shell Specifications:
  51  *
  52  * Some special stuff goes on if a shell doesn't have error control. In such
  53  * a case, errCheck becomes a printf template for echoing the command,
  54  * should echoing be on and ignErr becomes another printf template for
  55  * executing the command while ignoring the return status. If either of these
  56  * strings is empty when hasErrCtl is false, the command will be executed
  57  * anyway as is and if it causes an error, so be it.
  58  */
  59 typedef struct Shell {
  60         /*
  61          * the name of the shell. For Bourne and C shells, this is used
  62          * only to find the shell description when used as the single
  63          * source of a .SHELL target. For user-defined shells, this is
  64          * the full path of the shell.
  65          */
  66         char    *name;
  67         char    *path;          /* full path to the shell */
  68
  69         /* True if both echoOff and echoOn defined */
  70         bool    hasEchoCtl;
  71
  72         char    *echoOff;       /* command to turn off echo */
  73         char    *echoOn;        /* command to turn it back on */
  74
  75         /*
  76          * What the shell prints, when given the echo-off command.
  77          * This line will not be printed when received from the shell.
  78          * This is usually the command which was executed to turn off echoing.
  79          */
  80         char    *noPrint;
  81
  82         /* set if can control error checking for individual commands */
  83         bool    hasErrCtl;
  84
  85         /* string to turn error checking on */
  86         char    *errCheck;
  87
  88         /* string to turn off error checking */
  89         char    *ignErr;
  90
  91         char    *echo;  /* command line flag: echo commands */
  92         char    *exit;  /* command line flag: exit on error */
  93
  94         ArgArray builtins;      /* ordered list of shell builtins */
  95         char    *meta;          /* shell meta characters */
  96
  97         bool    unsetenv;       /* unsetenv("ENV") before exec */
  98 } Shell;
  99
 100 Shell   *Shell_Match(const char []);
 101 Shell   *Shell_Parse(const char []);
 102 void    Shell_Destroy(Shell *);
 103 void    Shell_Dump(const struct Shell *);
 104
 105 #endif /* shell_h_6002e3b8 */