HAMMER 60F/Many: Mirroring

[dragonfly.git] / usr.bin / make / shell.c

/*-
 * Copyright (c) 1988, 1989, 1990, 1993
 *      The Regents of the University of California.  All rights reserved.
 * Copyright (c) 1988, 1989 by Adam de Boor
 * Copyright (c) 1989 by Berkeley Softworks
 * All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Adam de Boor.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $DragonFly: src/usr.bin/make/shell.c,v 1.25 2005/09/22 09:13:38 okumoto Exp $
 */

#include <string.h>
#include <stdlib.h>

#include "make.h"
#include "parse.h"
#include "pathnames.h"
#include "shell.h"
#include "str.h"
#include "util.h"

/**
 * Helper function for sorting the builtin list alphabetically.
 */
static int
sort_builtins(const void *p1, const void *p2)
{
        return (strcmp(*(const char* const*)p1, *(const char* const*)p2));
}

/**
 * Free a shell structure and all associated strings.
 */
void
Shell_Destroy(Shell *sh)
{
        if (sh != NULL) {
                free(sh->name);
                free(sh->path);
                free(sh->echoOff);
                free(sh->echoOn);
                free(sh->noPrint);
                free(sh->errCheck);
                free(sh->ignErr);
                free(sh->echo);
                free(sh->exit);
                ArgArray_Done(&sh->builtins);
                free(sh->meta);
                free(sh);
        }
}

/**
 * Dump a shell specification to stderr.
 */
void
Shell_Dump(const Shell *sh)
{
        int i;

        fprintf(stderr, "Shell %p:\n", sh);
        fprintf(stderr, "  name='%s' path='%s'\n", sh->name, sh->path);
        fprintf(stderr, "  hasEchoCtl=%d echoOff='%s' echoOn='%s'\n",
            sh->hasEchoCtl, sh->echoOff, sh->echoOn);
        fprintf(stderr, "  noPrint='%s'\n", sh->noPrint);
        fprintf(stderr, "  hasErrCtl=%d errCheck='%s' ignErr='%s'\n",
            sh->hasErrCtl, sh->errCheck, sh->ignErr);
        fprintf(stderr, "  echo='%s' exit='%s'\n", sh->echo, sh->exit);
        fprintf(stderr, "  builtins=%d\n", sh->builtins.argc - 1);
        for (i = 1; i < sh->builtins.argc; i++)
                fprintf(stderr, " '%s'", sh->builtins.argv[i]);
        fprintf(stderr, "\n  meta='%s'\n", sh->meta);
        fprintf(stderr, "  unsetenv=%d\n", sh->unsetenv);
}

/**
 * Parse a shell specification line and return the new Shell structure.
 * In case of an error a message is printed and NULL is returned.
 *
 * Notes:
 *      A shell specification consists of a .SHELL target, with dependency
 *      operator, followed by a series of blank-separated words. Double
 *      quotes can be used to use blanks in words. A backslash escapes
 *      anything (most notably a double-quote and a space) and
 *      provides the functionality it does in C. Each word consists of
 *      keyword and value separated by an equal sign. There should be no
 *      unnecessary spaces in the word. The keywords are as follows:
 *          name            Name of shell.
 *          path            Location of shell. Overrides "name" if given
 *          quiet           Command to turn off echoing.
 *          echo            Command to turn echoing on
 *          filter          Result of turning off echoing that shouldn't be
 *                          printed.
 *          echoFlag        Flag to turn echoing on at the start
 *          errFlag         Flag to turn error checking on at the start
 *          hasErrCtl       True if shell has error checking control
 *          check           Command to turn on error checking if hasErrCtl
 *                          is true or template of command to echo a command
 *                          for which error checking is off if hasErrCtl is
 *                          false.
 *          ignore          Command to turn off error checking if hasErrCtl
 *                          is true or template of command to execute a
 *                          command so as to ignore any errors it returns if
 *                          hasErrCtl is false.
 *          builtins        A space separated list of builtins. If one
 *                          of these builtins is detected when make wants
 *                          to execute a command line, the command line is
 *                          handed to the shell. Otherwise make may try to
 *                          execute the command directly. If this list is empty
 *                          it is assumed, that the command must always be
 *                          handed over to the shell.
 *          meta            The shell meta characters. If this is not specified
 *                          or empty, commands are alway passed to the shell.
 *                          Otherwise they are not passed when they contain
 *                          neither a meta character nor a builtin command.
 */
static Shell *
ShellParseSpec(const char spec[], bool *fullSpec)
{
        ArgArray        aa;
        Shell           *sh;
        char            *eq;
        char            *keyw;
        int             arg;

        *fullSpec = false;

        sh = emalloc(sizeof(*sh));
        memset(sh, 0, sizeof(*sh));
        ArgArray_Init(&sh->builtins);

        /*
         * Parse the specification by keyword but skip the first word
         */
        brk_string(&aa, spec, true);

        for (arg = 1; arg < aa.argc; arg++) {
                /*
                 * Split keyword and value
                 */
                keyw = aa.argv[arg];
                if ((eq = strchr(keyw, '=')) == NULL) {
                        Parse_Error(PARSE_FATAL, "missing '=' in shell "
                            "specification keyword '%s'", keyw);
                        ArgArray_Done(&aa);
                        Shell_Destroy(sh);
                        return (NULL);
                }
                *eq++ = '\0';

                if (strcmp(keyw, "path") == 0) {
                        free(sh->path);
                        sh->path = estrdup(eq);
                } else if (strcmp(keyw, "name") == 0) {
                        free(sh->name);
                        sh->name = estrdup(eq);
                } else if (strcmp(keyw, "quiet") == 0) {
                        free(sh->echoOff);
                        sh->echoOff = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "echo") == 0) {
                        free(sh->echoOn);
                        sh->echoOn = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "filter") == 0) {
                        free(sh->noPrint);
                        sh->noPrint = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "echoFlag") == 0) {
                        free(sh->echo);
                        sh->echo = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "errFlag") == 0) {
                        free(sh->exit);
                        sh->exit = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "hasErrCtl") == 0) {
                        sh->hasErrCtl = (
                            *eq == 'Y' || *eq == 'y' ||
                            *eq == 'T' || *eq == 't');
                        *fullSpec = true;
                } else if (strcmp(keyw, "check") == 0) {
                        free(sh->errCheck);
                        sh->errCheck = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "ignore") == 0) {
                        free(sh->ignErr);
                        sh->ignErr = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "builtins") == 0) {
                        ArgArray_Done(&sh->builtins);
                        brk_string(&sh->builtins, eq, true);
                        qsort(sh->builtins.argv + 1, sh->builtins.argc - 1,
                            sizeof(char *), sort_builtins);
                        *fullSpec = true;
                } else if (strcmp(keyw, "meta") == 0) {
                        free(sh->meta);
                        sh->meta = estrdup(eq);
                        *fullSpec = true;
                } else if (strcmp(keyw, "unsetenv") == 0) {
                        sh->unsetenv = (
                            *eq == 'Y' || *eq == 'y' ||
                            *eq == 'T' || *eq == 't');
                        *fullSpec = true;
                } else {
                        Parse_Error(PARSE_FATAL, "unknown keyword in shell "
                            "specification '%s'", keyw);
                        ArgArray_Done(&aa);
                        Shell_Destroy(sh);
                        return (NULL);
                }
        }
        ArgArray_Done(&aa);

        /*
         * Some checks (could be more)
         */
        if (*fullSpec) {
                if ((sh->echoOn != NULL) ^ (sh->echoOff != NULL)) {
                        Parse_Error(PARSE_FATAL, "Shell must have either both "
                            "echoOff and echoOn or none of them");
                        Shell_Destroy(sh);
                        return (NULL);
                }

                if (sh->echoOn != NULL && sh->echoOff != NULL)
                        sh->hasEchoCtl = true;
        }

        return (sh);
}

/**
 * Find a matching shell in 'shells' given its final component.
 *
 * Descriptions for various shells. What the list of builtins should contain
 * is debatable: either all builtins or only those which may specified on
 * a single line without use of meta-characters. For correct makefiles that
 * contain only correct command lines there is no difference. But if a command
 * line, for example, is: 'if -foo bar' and there is an executable named 'if'
 * in the path, the first possibility would execute that 'if' while in the
 * second case the shell would give an error. Histerically only a small
 * subset of the builtins and no reserved words where given in the list which
 * corresponds roughly to the first variant. So go with this but add missing
 * words.
 *
 * @result
 *      A pointer to a Shell structure, or NULL if no shell with
 *      the given name is found.
 */
Shell *
Shell_Match(const char name[])
{
        Shell           *shell;
        const char      *shellDir = PATH_DEFSHELLDIR;

        shell = emalloc(sizeof(Shell));

        if (strcmp(name, "csh") == 0) {
                /*
                 * CSH description. The csh can do echo control by playing
                 * with the setting of the 'echo' shell variable. Sadly,
                 * however, it is unable to do error control nicely.
                 */
                shell->name             = strdup(name);
                shell->path             = str_concat(shellDir, '/', name);
                shell->hasEchoCtl       = true;
                shell->echoOff          = strdup("unset verbose");
                shell->echoOn           = strdup("set verbose");
                shell->noPrint          = strdup("unset verbose");
                shell->hasErrCtl        = false;
                shell->errCheck         = strdup("echo \"%s\"\n");
                shell->ignErr           = strdup("csh -c \"%s || exit 0\"");
                shell->echo             = strdup("v");
                shell->exit             = strdup("e");
                shell->meta             = strdup("#=|^(){};&<>*?[]:$`\\@\n");
                brk_string(&shell->builtins,
                    "alias cd eval exec exit read set ulimit unalias "
                    "umask unset wait", true);
                shell->unsetenv         = false;

        } else if (strcmp(name, "sh") == 0) {
                /*
                 * SH description. Echo control is also possible and, under
                 * sun UNIX anyway, one can even control error checking.
                 */

                shell->name             = strdup(name);
                shell->path             = str_concat(shellDir, '/', name);
                shell->hasEchoCtl       = true;
                shell->echoOff          = strdup("set -");
                shell->echoOn           = strdup("set -v");
                shell->noPrint          = strdup("set -");
#ifdef OLDBOURNESHELL
                shell->hasErrCtl        = false;
                shell->errCheck         = strdup("echo \"%s\"\n");
                shell->ignErr           = strdup("sh -c '%s || exit 0'\n");
#else
                shell->hasErrCtl        = true;
                shell->errCheck         = strdup("set -e");
                shell->ignErr           = strdup("set +e");
#endif
                shell->echo             = strdup("v");
                shell->exit             = strdup("e");
                shell->meta             = strdup("#=|^(){};&<>*?[]:$`\\\n");
                brk_string(&shell->builtins,
                    "alias cd eval exec exit read set ulimit unalias "
                    "umask unset wait", true);
                shell->unsetenv         = false;

        } else if (strcmp(name, "ksh") == 0) {
                /*
                 * KSH description. The Korn shell has a superset of
                 * the Bourne shell's functionality.  There are probably
                 * builtins missing here.
                 */
                shell->name             = strdup(name);
                shell->path             = str_concat(shellDir, '/', name);
                shell->hasEchoCtl       = true;
                shell->echoOff          = strdup("set -");
                shell->echoOn           = strdup("set -v");
                shell->noPrint          = strdup("set -");
                shell->hasErrCtl        = true;
                shell->errCheck         = strdup("set -e");
                shell->ignErr           = strdup("set +e");
                shell->echo             = strdup("v");
                shell->exit             = strdup("e");
                shell->meta             = strdup("#=|^(){};&<>*?[]:$`\\\n");
                brk_string(&shell->builtins,
                    "alias cd eval exec exit read set ulimit unalias "
                    "umask unset wait", true);
                shell->unsetenv         = true;

        } else {
                free(shell);
                shell = NULL;
        }

        return (shell);
}

/**
 * Given the line following a .SHELL target, parse it as a shell
 * specification.
 *
 * Results:
 *      A pointer to a Shell structure, or NULL if no the spec was invalid.
 */
Shell *
Shell_Parse(const char line[])
{
        bool    fullSpec;
        Shell   *sh;

        /* parse the specification */
        if ((sh = ShellParseSpec(line, &fullSpec)) == NULL)
                return (NULL);

        if (sh->path == NULL) {
                Shell   *match;
                /*
                 * If no path was given, the user wants one of the pre-defined
                 * shells, yes? So we find the one s/he wants with the help of
                 * ShellMatch and set things up the right way.
                 */
                if (sh->name == NULL) {
                        Parse_Error(PARSE_FATAL,
                            "Neither path nor name specified");
                        Shell_Destroy(sh);
                        return (NULL);
                }
                if (fullSpec) {
                        Parse_Error(PARSE_FATAL, "No path specified");
                        Shell_Destroy(sh);
                        return (NULL);
                }
                if ((match = Shell_Match(sh->name)) == NULL) {
                        Parse_Error(PARSE_FATAL, "%s: no matching shell",
                            sh->name);
                        Shell_Destroy(sh);
                        return (NULL);
                }

                Shell_Destroy(sh);
                return (match);

        } else {
                Shell   *match;

                /*
                 * The user provided a path. If s/he gave nothing else
                 * (fullSpec is false), try and find a matching shell in the
                 * ones we know of. Else we just take the specification at its
                 * word and copy it to a new location. In either case, we need
                 * to record the path the user gave for the shell.
                 */
                if (sh->name == NULL) {
                        /* get the base name as the name */
                        if ((sh->name = strrchr(sh->path, '/')) == NULL) {
                                sh->name = estrdup(sh->path);
                        } else {
                                sh->name = estrdup(sh->name + 1);
                        }
                }
                if (fullSpec) {
                        return (sh);
                }
                if ((match = Shell_Match(sh->name)) == NULL) {
                        Parse_Error(PARSE_FATAL,
                            "%s: no matching shell", sh->name);
                        Shell_Destroy(sh);
                        return (NULL);
                }

                free(match->path);
                match->path = sh->path;
                sh->path = NULL;

                Shell_Destroy(sh);
                return (match);
        }
}