NetBSD/usr.bin/make/var.c
rillig 5850837c3b make: fix documentation for ModChain
The outer ModChain can be interrupted by an inner ModChain, but it
continues to exist.

No functional change.
2021-03-16 16:21:27 +00:00

4627 lines
110 KiB
C

/* $NetBSD: var.c,v 1.892 2021/03/16 16:21:27 rillig Exp $ */
/*
* Copyright (c) 1988, 1989, 1990, 1993
* The Regents of the University of California. 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. 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.
*/
/*
* 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.
*/
/*
* Handling of variables and the expressions formed from them.
*
* Variables are set using lines of the form VAR=value. Both the variable
* name and the value can contain references to other variables, by using
* expressions like ${VAR}, ${VAR:Modifiers}, ${${VARNAME}} or ${VAR:${MODS}}.
*
* Interface:
* Var_Init Initialize this module.
*
* Var_End Clean up the module.
*
* Var_Set
* Var_SetExpand
* Set the value of the variable, creating it if
* necessary.
*
* Var_Append
* Var_AppendExpand
* Append more characters to the variable, creating it if
* necessary. A space is placed between the old value and
* the new one.
*
* Var_Exists
* Var_ExistsExpand
* See if a variable exists.
*
* Var_Value Return the unexpanded value of a variable, or NULL if
* the variable is undefined.
*
* Var_Subst Substitute all variable expressions in a string.
*
* Var_Parse Parse a variable expression such as ${VAR:Mpattern}.
*
* Var_Delete
* Var_DeleteExpand
* Delete a variable.
*
* Var_ReexportVars
* Export some or even all variables to the environment
* of this process and its child processes.
*
* Var_Export Export the variable to the environment of this process
* and its child processes.
*
* Var_UnExport Don't export the variable anymore.
*
* Debugging:
* Var_Stats Print out hashing statistics if in -dh mode.
*
* Var_Dump Print out all variables defined in the given scope.
*
* XXX: There's a lot of almost duplicate code in these functions that only
* differs in subtle details that are not mentioned in the manual page.
*/
#include <sys/stat.h>
#ifndef NO_REGEX
#include <sys/types.h>
#include <regex.h>
#endif
#include <errno.h>
#include <inttypes.h>
#include <limits.h>
#include <time.h>
#include "make.h"
#include "dir.h"
#include "job.h"
#include "metachar.h"
/* "@(#)var.c 8.3 (Berkeley) 3/19/94" */
MAKE_RCSID("$NetBSD: var.c,v 1.892 2021/03/16 16:21:27 rillig Exp $");
typedef enum VarFlags {
VFL_NONE = 0,
/*
* The variable's value is currently being used by Var_Parse or
* Var_Subst. This marker is used to avoid endless recursion.
*/
VFL_IN_USE = 1 << 0,
/*
* The variable comes from the environment.
* These variables are not registered in any GNode, therefore they
* must be freed as soon as they are not used anymore.
*/
VFL_FROM_ENV = 1 << 1,
/*
* The variable is exported to the environment, to be used by child
* processes.
*/
VFL_EXPORTED = 1 << 2,
/*
* At the point where this variable was exported, it contained an
* unresolved reference to another variable. Before any child
* process is started, it needs to be exported again, in the hope
* that the referenced variable can then be resolved.
*/
VFL_REEXPORT = 1 << 3,
/* The variable came from the command line. */
VFL_FROM_CMD = 1 << 4,
/*
* The variable value cannot be changed anymore, and the variable
* cannot be deleted. Any attempts to do so are silently ignored,
* they are logged with -dv though.
*
* See VAR_SET_READONLY.
*/
VFL_READONLY = 1 << 5
} VarFlags;
/*
* Variables are defined using one of the VAR=value assignments. Their
* value can be queried by expressions such as $V, ${VAR}, or with modifiers
* such as ${VAR:S,from,to,g:Q}.
*
* There are 3 kinds of variables: scope variables, environment variables,
* undefined variables.
*
* Scope variables are stored in a GNode.scope. The only way to undefine
* a scope variable is using the .undef directive. In particular, it must
* not be possible to undefine a variable during the evaluation of an
* expression, or Var.name might point nowhere.
*
* Environment variables are temporary. They are returned by VarFind, and
* after using them, they must be freed using VarFreeEnv.
*
* Undefined variables occur during evaluation of variable expressions such
* as ${UNDEF:Ufallback} in Var_Parse and ApplyModifiers.
*/
typedef struct Var {
/*
* The name of the variable, once set, doesn't change anymore.
* For scope variables, it aliases the corresponding HashEntry name.
* For environment and undefined variables, it is allocated.
*/
FStr name;
/* The unexpanded value of the variable. */
Buffer val;
/* Miscellaneous status flags. */
VarFlags flags;
} Var;
/*
* Exporting variables is expensive and may leak memory, so skip it if we
* can.
*
* To avoid this, it might be worth encapsulating the environment variables
* in a separate data structure called EnvVars.
*/
typedef enum VarExportedMode {
VAR_EXPORTED_NONE,
VAR_EXPORTED_SOME,
VAR_EXPORTED_ALL
} VarExportedMode;
typedef enum UnexportWhat {
/* Unexport the variables given by name. */
UNEXPORT_NAMED,
/*
* Unexport all globals previously exported, but keep the environment
* inherited from the parent.
*/
UNEXPORT_ALL,
/*
* Unexport all globals previously exported and clear the environment
* inherited from the parent.
*/
UNEXPORT_ENV
} UnexportWhat;
/* Flags for pattern matching in the :S and :C modifiers */
typedef struct VarPatternFlags {
/* Replace as often as possible ('g') */
Boolean subGlobal: 1;
/* Replace only once ('1') */
Boolean subOnce: 1;
/* Match at start of word ('^') */
Boolean anchorStart: 1;
/* Match at end of word ('$') */
Boolean anchorEnd: 1;
} VarPatternFlags;
/* SepBuf builds a string from words interleaved with separators. */
typedef struct SepBuf {
Buffer buf;
Boolean needSep;
/* Usually ' ', but see the ':ts' modifier. */
char sep;
} SepBuf;
static const char *
VarEvalFlags_ToString(VarEvalFlags eflags)
{
if (!eflags.wantRes) {
assert(!eflags.undefErr);
assert(!eflags.keepDollar && !eflags.keepUndef);
return "parse-only";
}
if (eflags.undefErr) {
assert(!eflags.keepDollar && !eflags.keepUndef);
return "eval-defined";
}
if (eflags.keepDollar && eflags.keepUndef)
return "eval-keep-dollar-and-undefined";
if (eflags.keepDollar)
return "eval-keep-dollar";
if (eflags.keepUndef)
return "eval-keep-undefined";
return "eval";
}
/*
* This lets us tell if we have replaced the original environ
* (which we cannot free).
*/
char **savedEnv = NULL;
/*
* Special return value for Var_Parse, indicating a parse error. It may be
* caused by an undefined variable, a syntax error in a modifier or
* something entirely different.
*/
char var_Error[] = "";
/*
* Special return value for Var_Parse, indicating an undefined variable in
* a case where VarEvalFlags.undefErr is not set. This undefined variable is
* typically a dynamic variable such as ${.TARGET}, whose expansion needs to
* be deferred until it is defined in an actual target.
*
* See VarEvalFlags.keepUndef.
*/
static char varUndefined[] = "";
/*
* Traditionally this make consumed $$ during := like any other expansion.
* Other make's do not, and this make follows straight since 2016-01-09.
*
* This knob allows controlling the behavior.
* FALSE to consume $$ during := assignment.
* TRUE to preserve $$ during := assignment.
*/
#define MAKE_SAVE_DOLLARS ".MAKE.SAVE_DOLLARS"
static Boolean save_dollars = TRUE;
/*
* A scope collects variable names and their values.
*
* The main scope is SCOPE_GLOBAL, which contains the variables that are set
* in the makefiles. SCOPE_INTERNAL acts as a fallback for SCOPE_GLOBAL and
* contains some internal make variables. These internal variables can thus
* be overridden, they can also be restored by undefining the overriding
* variable.
*
* SCOPE_CMDLINE contains variables from the command line arguments. These
* override variables from SCOPE_GLOBAL.
*
* There is no scope for environment variables, these are generated on-the-fly
* whenever they are referenced. If there were such a scope, each change to
* environment variables would have to be reflected in that scope, which may
* be simpler or more complex than the current implementation.
*
* Each target has its own scope, containing the 7 target-local variables
* .TARGET, .ALLSRC, etc. No other variables are in these scopes.
*/
GNode *SCOPE_CMDLINE;
GNode *SCOPE_GLOBAL;
GNode *SCOPE_INTERNAL;
ENUM_FLAGS_RTTI_6(VarFlags,
VFL_IN_USE, VFL_FROM_ENV,
VFL_EXPORTED, VFL_REEXPORT, VFL_FROM_CMD, VFL_READONLY);
static VarExportedMode var_exportedVars = VAR_EXPORTED_NONE;
static Var *
VarNew(FStr name, const char *value, VarFlags flags)
{
size_t value_len = strlen(value);
Var *var = bmake_malloc(sizeof *var);
var->name = name;
Buf_InitSize(&var->val, value_len + 1);
Buf_AddBytes(&var->val, value, value_len);
var->flags = flags;
return var;
}
static const char *
CanonicalVarname(const char *name)
{
if (*name == '.' && ch_isupper(name[1])) {
switch (name[1]) {
case 'A':
if (strcmp(name, ".ALLSRC") == 0)
name = ALLSRC;
if (strcmp(name, ".ARCHIVE") == 0)
name = ARCHIVE;
break;
case 'I':
if (strcmp(name, ".IMPSRC") == 0)
name = IMPSRC;
break;
case 'M':
if (strcmp(name, ".MEMBER") == 0)
name = MEMBER;
break;
case 'O':
if (strcmp(name, ".OODATE") == 0)
name = OODATE;
break;
case 'P':
if (strcmp(name, ".PREFIX") == 0)
name = PREFIX;
break;
case 'S':
if (strcmp(name, ".SHELL") == 0) {
if (shellPath == NULL)
Shell_Init();
}
break;
case 'T':
if (strcmp(name, ".TARGET") == 0)
name = TARGET;
break;
}
}
/* GNU make has an additional alias $^ == ${.ALLSRC}. */
return name;
}
static Var *
GNode_FindVar(GNode *scope, const char *varname, unsigned int hash)
{
return HashTable_FindValueHash(&scope->vars, varname, hash);
}
/*
* Find the variable in the scope, and maybe in other scopes as well.
*
* Input:
* name name to find, is not expanded any further
* scope scope in which to look first
* elsewhere TRUE to look in other scopes as well
*
* Results:
* The found variable, or NULL if the variable does not exist.
* If the variable is an environment variable, it must be freed using
* VarFreeEnv after use.
*/
static Var *
VarFind(const char *name, GNode *scope, Boolean elsewhere)
{
Var *var;
unsigned int nameHash;
/* Replace '.TARGET' with '@', likewise for other local variables. */
name = CanonicalVarname(name);
nameHash = Hash_Hash(name);
var = GNode_FindVar(scope, name, nameHash);
if (!elsewhere)
return var;
if (var == NULL && scope != SCOPE_CMDLINE)
var = GNode_FindVar(SCOPE_CMDLINE, name, nameHash);
if (!opts.checkEnvFirst && var == NULL && scope != SCOPE_GLOBAL) {
var = GNode_FindVar(SCOPE_GLOBAL, name, nameHash);
if (var == NULL && scope != SCOPE_INTERNAL) {
/* SCOPE_INTERNAL is subordinate to SCOPE_GLOBAL */
var = GNode_FindVar(SCOPE_INTERNAL, name, nameHash);
}
}
if (var == NULL) {
char *env;
if ((env = getenv(name)) != NULL) {
char *varname = bmake_strdup(name);
return VarNew(FStr_InitOwn(varname), env, VFL_FROM_ENV);
}
if (opts.checkEnvFirst && scope != SCOPE_GLOBAL) {
var = GNode_FindVar(SCOPE_GLOBAL, name, nameHash);
if (var == NULL && scope != SCOPE_INTERNAL)
var = GNode_FindVar(SCOPE_INTERNAL, name,
nameHash);
return var;
}
return NULL;
}
return var;
}
/* If the variable is an environment variable, free it, including its value. */
static void
VarFreeEnv(Var *v)
{
if (!(v->flags & VFL_FROM_ENV))
return;
FStr_Done(&v->name);
Buf_Done(&v->val);
free(v);
}
/* Add a new variable of the given name and value to the given scope. */
static Var *
VarAdd(const char *name, const char *value, GNode *scope, VarSetFlags flags)
{
HashEntry *he = HashTable_CreateEntry(&scope->vars, name, NULL);
Var *v = VarNew(FStr_InitRefer(/* aliased to */ he->key), value,
flags & VAR_SET_READONLY ? VFL_READONLY : VFL_NONE);
HashEntry_Set(he, v);
DEBUG3(VAR, "%s:%s = %s\n", scope->name, name, value);
return v;
}
/*
* Remove a variable from a scope, freeing all related memory as well.
* The variable name is kept as-is, it is not expanded.
*/
void
Var_Delete(GNode *scope, const char *varname)
{
HashEntry *he = HashTable_FindEntry(&scope->vars, varname);
Var *v;
if (he == NULL) {
DEBUG2(VAR, "%s:delete %s (not found)\n", scope->name, varname);
return;
}
DEBUG2(VAR, "%s:delete %s\n", scope->name, varname);
v = he->value;
if (v->flags & VFL_EXPORTED)
unsetenv(v->name.str);
if (strcmp(v->name.str, MAKE_EXPORTED) == 0)
var_exportedVars = VAR_EXPORTED_NONE;
assert(v->name.freeIt == NULL);
HashTable_DeleteEntry(&scope->vars, he);
Buf_Done(&v->val);
free(v);
}
/*
* Remove a variable from a scope, freeing all related memory as well.
* The variable name is expanded once.
*/
void
Var_DeleteExpand(GNode *scope, const char *name)
{
FStr varname = FStr_InitRefer(name);
if (strchr(varname.str, '$') != NULL) {
char *expanded;
(void)Var_Subst(varname.str, SCOPE_GLOBAL, VARE_WANTRES,
&expanded);
/* TODO: handle errors */
varname = FStr_InitOwn(expanded);
}
Var_Delete(scope, varname.str);
FStr_Done(&varname);
}
/*
* Undefine one or more variables from the global scope.
* The argument is expanded exactly once and then split into words.
*/
void
Var_Undef(const char *arg)
{
VarParseResult vpr;
char *expanded;
Words varnames;
size_t i;
if (arg[0] == '\0') {
Parse_Error(PARSE_FATAL,
"The .undef directive requires an argument");
return;
}
vpr = Var_Subst(arg, SCOPE_GLOBAL, VARE_WANTRES, &expanded);
if (vpr != VPR_OK) {
Parse_Error(PARSE_FATAL,
"Error in variable names to be undefined");
return;
}
varnames = Str_Words(expanded, FALSE);
if (varnames.len == 1 && varnames.words[0][0] == '\0')
varnames.len = 0;
for (i = 0; i < varnames.len; i++) {
const char *varname = varnames.words[i];
Global_Delete(varname);
}
Words_Free(varnames);
free(expanded);
}
static Boolean
MayExport(const char *name)
{
if (name[0] == '.')
return FALSE; /* skip internals */
if (name[0] == '-')
return FALSE; /* skip misnamed variables */
if (name[1] == '\0') {
/*
* A single char.
* If it is one of the variables that should only appear in
* local scope, skip it, else we can get Var_Subst
* into a loop.
*/
switch (name[0]) {
case '@':
case '%':
case '*':
case '!':
return FALSE;
}
}
return TRUE;
}
static Boolean
ExportVarEnv(Var *v)
{
const char *name = v->name.str;
char *val = v->val.data;
char *expr;
if ((v->flags & VFL_EXPORTED) && !(v->flags & VFL_REEXPORT))
return FALSE; /* nothing to do */
if (strchr(val, '$') == NULL) {
if (!(v->flags & VFL_EXPORTED))
setenv(name, val, 1);
return TRUE;
}
if (v->flags & VFL_IN_USE) {
/*
* We recursed while exporting in a child.
* This isn't going to end well, just skip it.
*/
return FALSE;
}
/* XXX: name is injected without escaping it */
expr = str_concat3("${", name, "}");
(void)Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES, &val);
/* TODO: handle errors */
setenv(name, val, 1);
free(val);
free(expr);
return TRUE;
}
static Boolean
ExportVarPlain(Var *v)
{
if (strchr(v->val.data, '$') == NULL) {
setenv(v->name.str, v->val.data, 1);
v->flags |= VFL_EXPORTED;
v->flags &= ~(unsigned)VFL_REEXPORT;
return TRUE;
}
/*
* Flag the variable as something we need to re-export.
* No point actually exporting it now though,
* the child process can do it at the last minute.
* Avoid calling setenv more often than necessary since it can leak.
*/
v->flags |= VFL_EXPORTED | VFL_REEXPORT;
return TRUE;
}
static Boolean
ExportVarLiteral(Var *v)
{
if ((v->flags & VFL_EXPORTED) && !(v->flags & VFL_REEXPORT))
return FALSE;
if (!(v->flags & VFL_EXPORTED))
setenv(v->name.str, v->val.data, 1);
return TRUE;
}
/*
* Mark a single variable to be exported later for subprocesses.
*
* Internal variables (those starting with '.') are not exported.
*/
static Boolean
ExportVar(const char *name, VarExportMode mode)
{
Var *v;
if (!MayExport(name))
return FALSE;
v = VarFind(name, SCOPE_GLOBAL, FALSE);
if (v == NULL)
return FALSE;
if (mode == VEM_ENV)
return ExportVarEnv(v);
else if (mode == VEM_PLAIN)
return ExportVarPlain(v);
else
return ExportVarLiteral(v);
}
/*
* Actually export the variables that have been marked as needing to be
* re-exported.
*/
void
Var_ReexportVars(void)
{
char *xvarnames;
/*
* Several make implementations support this sort of mechanism for
* tracking recursion - but each uses a different name.
* We allow the makefiles to update MAKELEVEL and ensure
* children see a correctly incremented value.
*/
char tmp[21];
snprintf(tmp, sizeof tmp, "%d", makelevel + 1);
setenv(MAKE_LEVEL_ENV, tmp, 1);
if (var_exportedVars == VAR_EXPORTED_NONE)
return;
if (var_exportedVars == VAR_EXPORTED_ALL) {
HashIter hi;
/* Ouch! Exporting all variables at once is crazy. */
HashIter_Init(&hi, &SCOPE_GLOBAL->vars);
while (HashIter_Next(&hi) != NULL) {
Var *var = hi.entry->value;
ExportVar(var->name.str, VEM_ENV);
}
return;
}
(void)Var_Subst("${" MAKE_EXPORTED ":O:u}", SCOPE_GLOBAL, VARE_WANTRES,
&xvarnames);
/* TODO: handle errors */
if (xvarnames[0] != '\0') {
Words varnames = Str_Words(xvarnames, FALSE);
size_t i;
for (i = 0; i < varnames.len; i++)
ExportVar(varnames.words[i], VEM_ENV);
Words_Free(varnames);
}
free(xvarnames);
}
static void
ExportVars(const char *varnames, Boolean isExport, VarExportMode mode)
/* TODO: try to combine the parameters 'isExport' and 'mode'. */
{
Words words = Str_Words(varnames, FALSE);
size_t i;
if (words.len == 1 && words.words[0][0] == '\0')
words.len = 0;
for (i = 0; i < words.len; i++) {
const char *varname = words.words[i];
if (!ExportVar(varname, mode))
continue;
if (var_exportedVars == VAR_EXPORTED_NONE)
var_exportedVars = VAR_EXPORTED_SOME;
if (isExport && mode == VEM_PLAIN)
Global_Append(MAKE_EXPORTED, varname);
}
Words_Free(words);
}
static void
ExportVarsExpand(const char *uvarnames, Boolean isExport, VarExportMode mode)
{
char *xvarnames;
(void)Var_Subst(uvarnames, SCOPE_GLOBAL, VARE_WANTRES, &xvarnames);
/* TODO: handle errors */
ExportVars(xvarnames, isExport, mode);
free(xvarnames);
}
/* Export the named variables, or all variables. */
void
Var_Export(VarExportMode mode, const char *varnames)
{
if (mode == VEM_PLAIN && varnames[0] == '\0') {
var_exportedVars = VAR_EXPORTED_ALL; /* use with caution! */
return;
}
ExportVarsExpand(varnames, TRUE, mode);
}
void
Var_ExportVars(const char *varnames)
{
ExportVarsExpand(varnames, FALSE, VEM_PLAIN);
}
extern char **environ;
static void
ClearEnv(void)
{
const char *cp;
char **newenv;
cp = getenv(MAKE_LEVEL_ENV); /* we should preserve this */
if (environ == savedEnv) {
/* we have been here before! */
newenv = bmake_realloc(environ, 2 * sizeof(char *));
} else {
if (savedEnv != NULL) {
free(savedEnv);
savedEnv = NULL;
}
newenv = bmake_malloc(2 * sizeof(char *));
}
/* Note: we cannot safely free() the original environ. */
environ = savedEnv = newenv;
newenv[0] = NULL;
newenv[1] = NULL;
if (cp != NULL && *cp != '\0')
setenv(MAKE_LEVEL_ENV, cp, 1);
}
static void
GetVarnamesToUnexport(Boolean isEnv, const char *arg,
FStr *out_varnames, UnexportWhat *out_what)
{
UnexportWhat what;
FStr varnames = FStr_InitRefer("");
if (isEnv) {
if (arg[0] != '\0') {
Parse_Error(PARSE_FATAL,
"The directive .unexport-env does not take "
"arguments");
/* continue anyway */
}
what = UNEXPORT_ENV;
} else {
what = arg[0] != '\0' ? UNEXPORT_NAMED : UNEXPORT_ALL;
if (what == UNEXPORT_NAMED)
varnames = FStr_InitRefer(arg);
}
if (what != UNEXPORT_NAMED) {
char *expanded;
/* Using .MAKE.EXPORTED */
(void)Var_Subst("${" MAKE_EXPORTED ":O:u}", SCOPE_GLOBAL,
VARE_WANTRES, &expanded);
/* TODO: handle errors */
varnames = FStr_InitOwn(expanded);
}
*out_varnames = varnames;
*out_what = what;
}
static void
UnexportVar(const char *varname, UnexportWhat what)
{
Var *v = VarFind(varname, SCOPE_GLOBAL, FALSE);
if (v == NULL) {
DEBUG1(VAR, "Not unexporting \"%s\" (not found)\n", varname);
return;
}
DEBUG1(VAR, "Unexporting \"%s\"\n", varname);
if (what != UNEXPORT_ENV &&
(v->flags & VFL_EXPORTED) && !(v->flags & VFL_REEXPORT))
unsetenv(v->name.str);
v->flags &= ~(unsigned)(VFL_EXPORTED | VFL_REEXPORT);
if (what == UNEXPORT_NAMED) {
/* Remove the variable names from .MAKE.EXPORTED. */
/* XXX: v->name is injected without escaping it */
char *expr = str_concat3("${" MAKE_EXPORTED ":N",
v->name.str, "}");
char *cp;
(void)Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES, &cp);
/* TODO: handle errors */
Global_Set(MAKE_EXPORTED, cp);
free(cp);
free(expr);
}
}
static void
UnexportVars(FStr *varnames, UnexportWhat what)
{
size_t i;
Words words;
if (what == UNEXPORT_ENV)
ClearEnv();
words = Str_Words(varnames->str, FALSE);
for (i = 0; i < words.len; i++) {
const char *varname = words.words[i];
UnexportVar(varname, what);
}
Words_Free(words);
if (what != UNEXPORT_NAMED)
Global_Delete(MAKE_EXPORTED);
}
/*
* This is called when .unexport[-env] is seen.
*
* str must have the form "unexport[-env] varname...".
*/
void
Var_UnExport(Boolean isEnv, const char *arg)
{
UnexportWhat what;
FStr varnames;
GetVarnamesToUnexport(isEnv, arg, &varnames, &what);
UnexportVars(&varnames, what);
FStr_Done(&varnames);
}
/*
* When there is a variable of the same name in the command line scope, the
* global variable would not be visible anywhere. Therefore there is no
* point in setting it at all.
*
* See 'scope == SCOPE_CMDLINE' in Var_SetWithFlags.
*/
static Boolean
ExistsInCmdline(const char *name, const char *val)
{
Var *v;
v = VarFind(name, SCOPE_CMDLINE, FALSE);
if (v == NULL)
return FALSE;
if (v->flags & VFL_FROM_CMD) {
DEBUG3(VAR, "%s:%s = %s ignored!\n",
SCOPE_GLOBAL->name, name, val);
return TRUE;
}
VarFreeEnv(v);
return FALSE;
}
/* Set the variable to the value; the name is not expanded. */
void
Var_SetWithFlags(GNode *scope, const char *name, const char *val,
VarSetFlags flags)
{
Var *v;
assert(val != NULL);
if (name[0] == '\0') {
DEBUG0(VAR, "SetVar: variable name is empty - ignored\n");
return;
}
if (scope == SCOPE_GLOBAL && ExistsInCmdline(name, val))
return;
/*
* Only look for a variable in the given scope since anything set
* here will override anything in a lower scope, so there's not much
* point in searching them all.
*/
v = VarFind(name, scope, FALSE);
if (v == NULL) {
if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT)) {
/*
* This var would normally prevent the same name being
* added to SCOPE_GLOBAL, so delete it from there if
* needed. Otherwise -V name may show the wrong value.
*
* See ExistsInCmdline.
*/
Var_Delete(SCOPE_GLOBAL, name);
}
v = VarAdd(name, val, scope, flags);
} else {
if ((v->flags & VFL_READONLY) && !(flags & VAR_SET_READONLY)) {
DEBUG3(VAR, "%s:%s = %s ignored (read-only)\n",
scope->name, name, val);
return;
}
Buf_Empty(&v->val);
Buf_AddStr(&v->val, val);
DEBUG3(VAR, "%s:%s = %s\n", scope->name, name, val);
if (v->flags & VFL_EXPORTED)
ExportVar(name, VEM_PLAIN);
}
/*
* Any variables given on the command line are automatically exported
* to the environment (as per POSIX standard), except for internals.
*/
if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT) &&
name[0] != '.') {
v->flags |= VFL_FROM_CMD;
/*
* If requested, don't export these in the environment
* individually. We still put them in MAKEOVERRIDES so
* that the command-line settings continue to override
* Makefile settings.
*/
if (!opts.varNoExportEnv)
setenv(name, val, 1);
/* XXX: What about .MAKE.EXPORTED? */
/* XXX: Why not just mark the variable for needing export,
* as in ExportVarPlain? */
Global_Append(MAKEOVERRIDES, name);
}
if (name[0] == '.' && strcmp(name, MAKE_SAVE_DOLLARS) == 0)
save_dollars = ParseBoolean(val, save_dollars);
if (v != NULL)
VarFreeEnv(v);
}
/* See Var_Set for documentation. */
void
Var_SetExpandWithFlags(GNode *scope, const char *name, const char *val,
VarSetFlags flags)
{
const char *unexpanded_name = name;
FStr varname = FStr_InitRefer(name);
assert(val != NULL);
if (strchr(varname.str, '$') != NULL) {
char *expanded;
(void)Var_Subst(varname.str, scope, VARE_WANTRES, &expanded);
/* TODO: handle errors */
varname = FStr_InitOwn(expanded);
}
if (varname.str[0] == '\0') {
DEBUG2(VAR, "Var_Set(\"%s\", \"%s\", ...) "
"name expands to empty string - ignored\n",
unexpanded_name, val);
} else
Var_SetWithFlags(scope, varname.str, val, flags);
FStr_Done(&varname);
}
void
Var_Set(GNode *scope, const char *name, const char *val)
{
Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
}
/*
* Set the variable name to the value val in the given scope.
*
* If the variable doesn't yet exist, it is created.
* Otherwise the new value overwrites and replaces the old value.
*
* Input:
* name name of the variable to set, is expanded once
* val value to give to the variable
* scope scope in which to set it
*/
void
Var_SetExpand(GNode *scope, const char *name, const char *val)
{
Var_SetExpandWithFlags(scope, name, val, VAR_SET_NONE);
}
void
Global_Set(const char *name, const char *value)
{
Var_Set(SCOPE_GLOBAL, name, value);
}
void
Global_SetExpand(const char *name, const char *value)
{
Var_SetExpand(SCOPE_GLOBAL, name, value);
}
void
Global_Delete(const char *name)
{
Var_Delete(SCOPE_GLOBAL, name);
}
/*
* Append the value to the named variable.
*
* If the variable doesn't exist, it is created. Otherwise a single space
* and the given value are appended.
*/
void
Var_Append(GNode *scope, const char *name, const char *val)
{
Var *v;
v = VarFind(name, scope, scope == SCOPE_GLOBAL);
if (v == NULL) {
Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
} else if (v->flags & VFL_READONLY) {
DEBUG1(VAR, "Ignoring append to %s since it is read-only\n",
name);
} else if (scope == SCOPE_CMDLINE || !(v->flags & VFL_FROM_CMD)) {
Buf_AddByte(&v->val, ' ');
Buf_AddStr(&v->val, val);
DEBUG3(VAR, "%s:%s = %s\n", scope->name, name, v->val.data);
if (v->flags & VFL_FROM_ENV) {
/*
* If the original variable came from the environment,
* we have to install it in the global scope (we
* could place it in the environment, but then we
* should provide a way to export other variables...)
*/
v->flags &= ~(unsigned)VFL_FROM_ENV;
/*
* This is the only place where a variable is
* created whose v->name is not the same as
* scope->vars->key.
*/
HashTable_Set(&scope->vars, name, v);
}
}
}
/*
* The variable of the given name has the given value appended to it in the
* given scope.
*
* If the variable doesn't exist, it is created. Otherwise the strings are
* concatenated, with a space in between.
*
* Input:
* name name of the variable to modify, is expanded once
* val string to append to it
* scope scope in which this should occur
*
* Notes:
* Only if the variable is being sought in the global scope is the
* environment searched.
* XXX: Knows its calling circumstances in that if called with scope
* an actual target, it will only search that scope since only
* a local variable could be being appended to. This is actually
* a big win and must be tolerated.
*/
void
Var_AppendExpand(GNode *scope, const char *name, const char *val)
{
FStr xname = FStr_InitRefer(name);
assert(val != NULL);
if (strchr(name, '$') != NULL) {
char *expanded;
(void)Var_Subst(name, scope, VARE_WANTRES, &expanded);
/* TODO: handle errors */
xname = FStr_InitOwn(expanded);
if (expanded[0] == '\0') {
/* TODO: update function name in the debug message */
DEBUG2(VAR, "Var_Append(\"%s\", \"%s\", ...) "
"name expands to empty string - ignored\n",
name, val);
FStr_Done(&xname);
return;
}
}
Var_Append(scope, xname.str, val);
FStr_Done(&xname);
}
void
Global_Append(const char *name, const char *value)
{
Var_Append(SCOPE_GLOBAL, name, value);
}
Boolean
Var_Exists(GNode *scope, const char *name)
{
Var *v = VarFind(name, scope, TRUE);
if (v == NULL)
return FALSE;
VarFreeEnv(v);
return TRUE;
}
/*
* See if the given variable exists, in the given scope or in other
* fallback scopes.
*
* Input:
* name Variable to find, is expanded once
* scope Scope in which to start search
*/
Boolean
Var_ExistsExpand(GNode *scope, const char *name)
{
FStr varname = FStr_InitRefer(name);
Boolean exists;
if (strchr(varname.str, '$') != NULL) {
char *expanded;
(void)Var_Subst(varname.str, scope, VARE_WANTRES, &expanded);
/* TODO: handle errors */
varname = FStr_InitOwn(expanded);
}
exists = Var_Exists(scope, varname.str);
FStr_Done(&varname);
return exists;
}
/*
* Return the unexpanded value of the given variable in the given scope,
* or the usual scopes.
*
* Input:
* name name to find, is not expanded any further
* scope scope in which to search for it
*
* Results:
* The value if the variable exists, NULL if it doesn't.
* The value is valid until the next modification to any variable.
*/
FStr
Var_Value(GNode *scope, const char *name)
{
Var *v = VarFind(name, scope, TRUE);
char *value;
if (v == NULL)
return FStr_InitRefer(NULL);
if (!(v->flags & VFL_FROM_ENV))
return FStr_InitRefer(v->val.data);
/* Since environment variables are short-lived, free it now. */
FStr_Done(&v->name);
value = Buf_DoneData(&v->val);
free(v);
return FStr_InitOwn(value);
}
/*
* Return the unexpanded variable value from this node, without trying to look
* up the variable in any other scope.
*/
const char *
GNode_ValueDirect(GNode *gn, const char *name)
{
Var *v = VarFind(name, gn, FALSE);
return v != NULL ? v->val.data : NULL;
}
static void
SepBuf_Init(SepBuf *buf, char sep)
{
Buf_InitSize(&buf->buf, 32);
buf->needSep = FALSE;
buf->sep = sep;
}
static void
SepBuf_Sep(SepBuf *buf)
{
buf->needSep = TRUE;
}
static void
SepBuf_AddBytes(SepBuf *buf, const char *mem, size_t mem_size)
{
if (mem_size == 0)
return;
if (buf->needSep && buf->sep != '\0') {
Buf_AddByte(&buf->buf, buf->sep);
buf->needSep = FALSE;
}
Buf_AddBytes(&buf->buf, mem, mem_size);
}
static void
SepBuf_AddBytesBetween(SepBuf *buf, const char *start, const char *end)
{
SepBuf_AddBytes(buf, start, (size_t)(end - start));
}
static void
SepBuf_AddStr(SepBuf *buf, const char *str)
{
SepBuf_AddBytes(buf, str, strlen(str));
}
static char *
SepBuf_DoneData(SepBuf *buf)
{
return Buf_DoneData(&buf->buf);
}
/*
* This callback for ModifyWords gets a single word from a variable expression
* and typically adds a modification of this word to the buffer. It may also
* do nothing or add several words.
*
* For example, when evaluating the modifier ':M*b' in ${:Ua b c:M*b}, the
* callback is called 3 times, once for "a", "b" and "c".
*/
typedef void (*ModifyWordProc)(const char *word, SepBuf *buf, void *data);
/*
* Callback for ModifyWords to implement the :H modifier.
* Add the dirname of the given word to the buffer.
*/
/*ARGSUSED*/
static void
ModifyWord_Head(const char *word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
{
const char *slash = strrchr(word, '/');
if (slash != NULL)
SepBuf_AddBytesBetween(buf, word, slash);
else
SepBuf_AddStr(buf, ".");
}
/*
* Callback for ModifyWords to implement the :T modifier.
* Add the basename of the given word to the buffer.
*/
/*ARGSUSED*/
static void
ModifyWord_Tail(const char *word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
{
SepBuf_AddStr(buf, str_basename(word));
}
/*
* Callback for ModifyWords to implement the :E modifier.
* Add the filename suffix of the given word to the buffer, if it exists.
*/
/*ARGSUSED*/
static void
ModifyWord_Suffix(const char *word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
{
const char *lastDot = strrchr(word, '.');
if (lastDot != NULL)
SepBuf_AddStr(buf, lastDot + 1);
}
/*
* Callback for ModifyWords to implement the :R modifier.
* Add the filename without extension of the given word to the buffer.
*/
/*ARGSUSED*/
static void
ModifyWord_Root(const char *word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
{
const char *lastDot = strrchr(word, '.');
size_t len = lastDot != NULL ? (size_t)(lastDot - word) : strlen(word);
SepBuf_AddBytes(buf, word, len);
}
/*
* Callback for ModifyWords to implement the :M modifier.
* Place the word in the buffer if it matches the given pattern.
*/
static void
ModifyWord_Match(const char *word, SepBuf *buf, void *data)
{
const char *pattern = data;
DEBUG2(VAR, "VarMatch [%s] [%s]\n", word, pattern);
if (Str_Match(word, pattern))
SepBuf_AddStr(buf, word);
}
/*
* Callback for ModifyWords to implement the :N modifier.
* Place the word in the buffer if it doesn't match the given pattern.
*/
static void
ModifyWord_NoMatch(const char *word, SepBuf *buf, void *data)
{
const char *pattern = data;
if (!Str_Match(word, pattern))
SepBuf_AddStr(buf, word);
}
#ifdef SYSVVARSUB
/*
* Check word against pattern for a match (% is a wildcard).
*
* Input:
* word Word to examine
* pattern Pattern to examine against
*
* Results:
* Returns the start of the match, or NULL.
* out_match_len returns the length of the match, if any.
* out_hasPercent returns whether the pattern contains a percent.
*/
static const char *
SysVMatch(const char *word, const char *pattern,
size_t *out_match_len, Boolean *out_hasPercent)
{
const char *p = pattern;
const char *w = word;
const char *percent;
size_t w_len;
size_t p_len;
const char *w_tail;
*out_hasPercent = FALSE;
percent = strchr(p, '%');
if (percent != NULL) { /* ${VAR:...%...=...} */
*out_hasPercent = TRUE;
if (w[0] == '\0')
return NULL; /* empty word does not match pattern */
/* check that the prefix matches */
for (; p != percent && *w != '\0' && *w == *p; w++, p++)
continue;
if (p != percent)
return NULL; /* No match */
p++; /* Skip the percent */
if (*p == '\0') {
/* No more pattern, return the rest of the string */
*out_match_len = strlen(w);
return w;
}
}
/* Test whether the tail matches */
w_len = strlen(w);
p_len = strlen(p);
if (w_len < p_len)
return NULL;
w_tail = w + w_len - p_len;
if (memcmp(p, w_tail, p_len) != 0)
return NULL;
*out_match_len = (size_t)(w_tail - w);
return w;
}
struct ModifyWord_SYSVSubstArgs {
GNode *scope;
const char *lhs;
const char *rhs;
};
/* Callback for ModifyWords to implement the :%.from=%.to modifier. */
static void
ModifyWord_SYSVSubst(const char *word, SepBuf *buf, void *data)
{
const struct ModifyWord_SYSVSubstArgs *args = data;
char *rhs_expanded;
const char *rhs;
const char *percent;
size_t match_len;
Boolean lhsPercent;
const char *match = SysVMatch(word, args->lhs, &match_len, &lhsPercent);
if (match == NULL) {
SepBuf_AddStr(buf, word);
return;
}
/*
* Append rhs to the buffer, substituting the first '%' with the
* match, but only if the lhs had a '%' as well.
*/
(void)Var_Subst(args->rhs, args->scope, VARE_WANTRES, &rhs_expanded);
/* TODO: handle errors */
rhs = rhs_expanded;
percent = strchr(rhs, '%');
if (percent != NULL && lhsPercent) {
/* Copy the prefix of the replacement pattern */
SepBuf_AddBytesBetween(buf, rhs, percent);
rhs = percent + 1;
}
if (percent != NULL || !lhsPercent)
SepBuf_AddBytes(buf, match, match_len);
/* Append the suffix of the replacement pattern */
SepBuf_AddStr(buf, rhs);
free(rhs_expanded);
}
#endif
struct ModifyWord_SubstArgs {
const char *lhs;
size_t lhsLen;
const char *rhs;
size_t rhsLen;
VarPatternFlags pflags;
Boolean matched;
};
/*
* Callback for ModifyWords to implement the :S,from,to, modifier.
* Perform a string substitution on the given word.
*/
static void
ModifyWord_Subst(const char *word, SepBuf *buf, void *data)
{
size_t wordLen = strlen(word);
struct ModifyWord_SubstArgs *args = data;
const char *match;
if (args->pflags.subOnce && args->matched)
goto nosub;
if (args->pflags.anchorStart) {
if (wordLen < args->lhsLen ||
memcmp(word, args->lhs, args->lhsLen) != 0)
goto nosub;
if (args->pflags.anchorEnd && wordLen != args->lhsLen)
goto nosub;
/* :S,^prefix,replacement, or :S,^whole$,replacement, */
SepBuf_AddBytes(buf, args->rhs, args->rhsLen);
SepBuf_AddBytesBetween(buf,
word + args->lhsLen, word + wordLen);
args->matched = TRUE;
return;
}
if (args->pflags.anchorEnd) {
const char *start;
if (wordLen < args->lhsLen)
goto nosub;
start = word + (wordLen - args->lhsLen);
if (memcmp(start, args->lhs, args->lhsLen) != 0)
goto nosub;
/* :S,suffix$,replacement, */
SepBuf_AddBytesBetween(buf, word, start);
SepBuf_AddBytes(buf, args->rhs, args->rhsLen);
args->matched = TRUE;
return;
}
if (args->lhs[0] == '\0')
goto nosub;
/* unanchored case, may match more than once */
while ((match = strstr(word, args->lhs)) != NULL) {
SepBuf_AddBytesBetween(buf, word, match);
SepBuf_AddBytes(buf, args->rhs, args->rhsLen);
args->matched = TRUE;
wordLen -= (size_t)(match - word) + args->lhsLen;
word += (size_t)(match - word) + args->lhsLen;
if (wordLen == 0 || !args->pflags.subGlobal)
break;
}
nosub:
SepBuf_AddBytes(buf, word, wordLen);
}
#ifndef NO_REGEX
/* Print the error caused by a regcomp or regexec call. */
static void
VarREError(int reerr, const regex_t *pat, const char *str)
{
size_t errlen = regerror(reerr, pat, NULL, 0);
char *errbuf = bmake_malloc(errlen);
regerror(reerr, pat, errbuf, errlen);
Error("%s: %s", str, errbuf);
free(errbuf);
}
struct ModifyWord_SubstRegexArgs {
regex_t re;
size_t nsub;
char *replace;
VarPatternFlags pflags;
Boolean matched;
};
/*
* Callback for ModifyWords to implement the :C/from/to/ modifier.
* Perform a regex substitution on the given word.
*/
static void
ModifyWord_SubstRegex(const char *word, SepBuf *buf, void *data)
{
struct ModifyWord_SubstRegexArgs *args = data;
int xrv;
const char *wp = word;
char *rp;
int flags = 0;
regmatch_t m[10];
if (args->pflags.subOnce && args->matched)
goto nosub;
tryagain:
xrv = regexec(&args->re, wp, args->nsub, m, flags);
switch (xrv) {
case 0:
args->matched = TRUE;
SepBuf_AddBytes(buf, wp, (size_t)m[0].rm_so);
/*
* Replacement of regular expressions is not specified by
* POSIX, therefore implement it here.
*/
for (rp = args->replace; *rp != '\0'; rp++) {
if (*rp == '\\' && (rp[1] == '&' || rp[1] == '\\')) {
SepBuf_AddBytes(buf, rp + 1, 1);
rp++;
continue;
}
if (*rp == '&') {
SepBuf_AddBytesBetween(buf,
wp + m[0].rm_so, wp + m[0].rm_eo);
continue;
}
if (*rp != '\\' || !ch_isdigit(rp[1])) {
SepBuf_AddBytes(buf, rp, 1);
continue;
}
{ /* \0 to \9 backreference */
size_t n = (size_t)(rp[1] - '0');
rp++;
if (n >= args->nsub) {
Error("No subexpression \\%u",
(unsigned)n);
} else if (m[n].rm_so == -1) {
Error(
"No match for subexpression \\%u",
(unsigned)n);
} else {
SepBuf_AddBytesBetween(buf,
wp + m[n].rm_so, wp + m[n].rm_eo);
}
}
}
wp += m[0].rm_eo;
if (args->pflags.subGlobal) {
flags |= REG_NOTBOL;
if (m[0].rm_so == 0 && m[0].rm_eo == 0) {
SepBuf_AddBytes(buf, wp, 1);
wp++;
}
if (*wp != '\0')
goto tryagain;
}
if (*wp != '\0')
SepBuf_AddStr(buf, wp);
break;
default:
VarREError(xrv, &args->re, "Unexpected regex error");
/* FALLTHROUGH */
case REG_NOMATCH:
nosub:
SepBuf_AddStr(buf, wp);
break;
}
}
#endif
struct ModifyWord_LoopArgs {
GNode *scope;
char *tvar; /* name of temporary variable */
char *str; /* string to expand */
VarEvalFlags eflags;
};
/* Callback for ModifyWords to implement the :@var@...@ modifier of ODE make. */
static void
ModifyWord_Loop(const char *word, SepBuf *buf, void *data)
{
const struct ModifyWord_LoopArgs *args;
char *s;
if (word[0] == '\0')
return;
args = data;
/* XXX: The variable name should not be expanded here. */
Var_SetExpandWithFlags(args->scope, args->tvar, word,
VAR_SET_NO_EXPORT);
(void)Var_Subst(args->str, args->scope, args->eflags, &s);
/* TODO: handle errors */
DEBUG4(VAR, "ModifyWord_Loop: "
"in \"%s\", replace \"%s\" with \"%s\" to \"%s\"\n",
word, args->tvar, args->str, s);
if (s[0] == '\n' || Buf_EndsWith(&buf->buf, '\n'))
buf->needSep = FALSE;
SepBuf_AddStr(buf, s);
free(s);
}
/*
* The :[first..last] modifier selects words from the expression.
* It can also reverse the words.
*/
static char *
VarSelectWords(const char *str, int first, int last,
char sep, Boolean oneBigWord)
{
Words words;
int len, start, end, step;
int i;
SepBuf buf;
SepBuf_Init(&buf, sep);
if (oneBigWord) {
/* fake what Str_Words() would do if there were only one word */
words.len = 1;
words.words = bmake_malloc(
(words.len + 1) * sizeof(words.words[0]));
words.freeIt = bmake_strdup(str);
words.words[0] = words.freeIt;
words.words[1] = NULL;
} else {
words = Str_Words(str, FALSE);
}
/*
* Now sanitize the given range. If first or last are negative,
* convert them to the positive equivalents (-1 gets converted to len,
* -2 gets converted to (len - 1), etc.).
*/
len = (int)words.len;
if (first < 0)
first += len + 1;
if (last < 0)
last += len + 1;
/* We avoid scanning more of the list than we need to. */
if (first > last) {
start = (first > len ? len : first) - 1;
end = last < 1 ? 0 : last - 1;
step = -1;
} else {
start = first < 1 ? 0 : first - 1;
end = last > len ? len : last;
step = 1;
}
for (i = start; (step < 0) == (i >= end); i += step) {
SepBuf_AddStr(&buf, words.words[i]);
SepBuf_Sep(&buf);
}
Words_Free(words);
return SepBuf_DoneData(&buf);
}
/*
* Callback for ModifyWords to implement the :tA modifier.
* Replace each word with the result of realpath() if successful.
*/
/*ARGSUSED*/
static void
ModifyWord_Realpath(const char *word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
{
struct stat st;
char rbuf[MAXPATHLEN];
const char *rp = cached_realpath(word, rbuf);
if (rp != NULL && *rp == '/' && stat(rp, &st) == 0)
word = rp;
SepBuf_AddStr(buf, word);
}
static char *
Words_JoinFree(Words words)
{
Buffer buf;
size_t i;
Buf_Init(&buf);
for (i = 0; i < words.len; i++) {
if (i != 0) {
/* XXX: Use ch->sep instead of ' ', for consistency. */
Buf_AddByte(&buf, ' ');
}
Buf_AddStr(&buf, words.words[i]);
}
Words_Free(words);
return Buf_DoneData(&buf);
}
/* Remove adjacent duplicate words. */
static char *
VarUniq(const char *str)
{
Words words = Str_Words(str, FALSE);
if (words.len > 1) {
size_t i, j;
for (j = 0, i = 1; i < words.len; i++)
if (strcmp(words.words[i], words.words[j]) != 0 &&
(++j != i))
words.words[j] = words.words[i];
words.len = j + 1;
}
return Words_JoinFree(words);
}
/*
* Quote shell meta-characters and space characters in the string.
* If quoteDollar is set, also quote and double any '$' characters.
*/
static char *
VarQuote(const char *str, Boolean quoteDollar)
{
Buffer buf;
Buf_Init(&buf);
for (; *str != '\0'; str++) {
if (*str == '\n') {
const char *newline = Shell_GetNewline();
if (newline == NULL)
newline = "\\\n";
Buf_AddStr(&buf, newline);
continue;
}
if (ch_isspace(*str) || is_shell_metachar((unsigned char)*str))
Buf_AddByte(&buf, '\\');
Buf_AddByte(&buf, *str);
if (quoteDollar && *str == '$')
Buf_AddStr(&buf, "\\$");
}
return Buf_DoneData(&buf);
}
/*
* Compute the 32-bit hash of the given string, using the MurmurHash3
* algorithm. Output is encoded as 8 hex digits, in Little Endian order.
*/
static char *
VarHash(const char *str)
{
static const char hexdigits[16] = "0123456789abcdef";
const unsigned char *ustr = (const unsigned char *)str;
uint32_t h = 0x971e137bU;
uint32_t c1 = 0x95543787U;
uint32_t c2 = 0x2ad7eb25U;
size_t len2 = strlen(str);
char *buf;
size_t i;
size_t len;
for (len = len2; len != 0;) {
uint32_t k = 0;
switch (len) {
default:
k = ((uint32_t)ustr[3] << 24) |
((uint32_t)ustr[2] << 16) |
((uint32_t)ustr[1] << 8) |
(uint32_t)ustr[0];
len -= 4;
ustr += 4;
break;
case 3:
k |= (uint32_t)ustr[2] << 16;
/* FALLTHROUGH */
case 2:
k |= (uint32_t)ustr[1] << 8;
/* FALLTHROUGH */
case 1:
k |= (uint32_t)ustr[0];
len = 0;
}
c1 = c1 * 5 + 0x7b7d159cU;
c2 = c2 * 5 + 0x6bce6396U;
k *= c1;
k = (k << 11) ^ (k >> 21);
k *= c2;
h = (h << 13) ^ (h >> 19);
h = h * 5 + 0x52dce729U;
h ^= k;
}
h ^= (uint32_t)len2;
h *= 0x85ebca6b;
h ^= h >> 13;
h *= 0xc2b2ae35;
h ^= h >> 16;
buf = bmake_malloc(9);
for (i = 0; i < 8; i++) {
buf[i] = hexdigits[h & 0x0f];
h >>= 4;
}
buf[8] = '\0';
return buf;
}
static char *
VarStrftime(const char *fmt, Boolean zulu, time_t tim)
{
char buf[BUFSIZ];
if (tim == 0)
time(&tim);
if (*fmt == '\0')
fmt = "%c";
strftime(buf, sizeof buf, fmt, zulu ? gmtime(&tim) : localtime(&tim));
buf[sizeof buf - 1] = '\0';
return bmake_strdup(buf);
}
/*
* The ApplyModifier functions take an expression that is being evaluated.
* Their task is to apply a single modifier to the expression. This involves
* parsing the modifier, evaluating it and finally updating the value of the
* expression.
*
* Parsing the modifier
*
* If parsing succeeds, the parsing position *pp is updated to point to the
* first character following the modifier, which typically is either ':' or
* ch->endc. The modifier doesn't have to check for this delimiter character,
* this is done by ApplyModifiers.
*
* XXX: As of 2020-11-15, some modifiers such as :S, :C, :P, :L do not
* need to be followed by a ':' or endc; this was an unintended mistake.
*
* If parsing fails because of a missing delimiter (as in the :S, :C or :@
* modifiers), return AMR_CLEANUP.
*
* If parsing fails because the modifier is unknown, return AMR_UNKNOWN to
* try the SysV modifier ${VAR:from=to} as fallback. This should only be
* done as long as there have been no side effects from evaluating nested
* variables, to avoid evaluating them more than once. In this case, the
* parsing position may or may not be updated. (XXX: Why not? The original
* parsing position is well-known in ApplyModifiers.)
*
* If parsing fails and the SysV modifier ${VAR:from=to} should not be used
* as a fallback, either issue an error message using Error or Parse_Error
* and then return AMR_CLEANUP, or return AMR_BAD for the default error
* message. Both of these return values will stop processing the variable
* expression. (XXX: As of 2020-08-23, evaluation of the whole string
* continues nevertheless after skipping a few bytes, which essentially is
* undefined behavior. Not in the sense of C, but still the resulting string
* is garbage.)
*
* Evaluating the modifier
*
* After parsing, the modifier is evaluated. The side effects from evaluating
* nested variable expressions in the modifier text often already happen
* during parsing though. For most modifiers this doesn't matter since their
* only noticeable effect is that the update the value of the expression.
* Some modifiers such as ':sh' or '::=' have noticeable side effects though.
*
* Evaluating the modifier usually takes the current value of the variable
* expression from ch->expr->value, or the variable name from ch->var->name
* and stores the result back in expr->value via Expr_SetValueOwn or
* Expr_SetValueRefer.
*
* If evaluating fails (as of 2020-08-23), an error message is printed using
* Error. This function has no side-effects, it really just prints the error
* message. Processing the expression continues as if everything were ok.
* XXX: This should be fixed by adding proper error handling to Var_Subst,
* Var_Parse, ApplyModifiers and ModifyWords.
*
* Housekeeping
*
* Some modifiers such as :D and :U turn undefined expressions into defined
* expressions (see Expr_Define).
*
* Some modifiers need to free some memory.
*/
typedef enum ExprDefined {
/* The variable expression is based on a regular, defined variable. */
DEF_REGULAR,
/* The variable expression is based on an undefined variable. */
DEF_UNDEF,
/*
* The variable expression started as an undefined expression, but one
* of the modifiers (such as ':D' or ':U') has turned the expression
* from undefined to defined.
*/
DEF_DEFINED
} ExprDefined;
static const char *const ExprDefined_Name[] = {
"regular",
"undefined",
"defined"
};
/* A variable expression such as $@ or ${VAR:Mpattern:Q}. */
typedef struct Expr {
Var *var;
FStr value;
VarEvalFlags const eflags;
GNode *const scope;
ExprDefined defined;
} Expr;
/*
* The status of applying a chain of modifiers to an expression.
*
* The modifiers of an expression are broken into chains of modifiers,
* starting a new nested chain whenever an indirect modifier starts. There
* are at most 2 nesting levels: the outer one for the direct modifiers, and
* the inner one for the indirect modifiers.
*
* For example, the expression ${VAR:M*:${IND1}:${IND2}:O:u} has 3 chains of
* modifiers:
*
* Chain 1 starts with the single modifier ':M*'.
* Chain 2 starts with all modifiers from ${IND1}.
* Chain 2 ends at the ':' between ${IND1} and ${IND2}.
* Chain 3 starts with all modifiers from ${IND1}.
* Chain 2 ends at the ':' after ${IND2}.
* Chain 1 continues with the the 2 modifiers ':O' and ':u'.
* Chain 1 ends at the final '}' of the expression.
*
* After such a chain ends, its properties no longer have any effect.
*
* It may or may not have been intended that 'defined' has scope Expr while
* 'sep' and 'oneBigWord' have smaller scope.
*
* See varmod-indirect.mk.
*/
typedef struct ModChain {
Expr *expr;
/* '\0' or '{' or '(' */
const char startc;
/* '\0' or '}' or ')' */
const char endc;
/* Word separator in expansions (see the :ts modifier). */
char sep;
/*
* TRUE if some modifiers that otherwise split the variable value
* into words, like :S and :C, treat the variable value as a single
* big word, possibly containing spaces.
*/
Boolean oneBigWord;
} ModChain;
static void
Expr_Define(Expr *expr)
{
if (expr->defined == DEF_UNDEF)
expr->defined = DEF_DEFINED;
}
static void
Expr_SetValueOwn(Expr *expr, char *value)
{
FStr_Done(&expr->value);
expr->value = FStr_InitOwn(value);
}
static void
Expr_SetValueRefer(Expr *expr, const char *value)
{
FStr_Done(&expr->value);
expr->value = FStr_InitRefer(value);
}
typedef enum ApplyModifierResult {
/* Continue parsing */
AMR_OK,
/* Not a match, try other modifiers as well. */
AMR_UNKNOWN,
/* Error out with "Bad modifier" message. */
AMR_BAD,
/* Error out without the standard error message. */
AMR_CLEANUP
} ApplyModifierResult;
/*
* Allow backslashes to escape the delimiter, $, and \, but don't touch other
* backslashes.
*/
static Boolean
IsEscapedModifierPart(const char *p, char delim,
struct ModifyWord_SubstArgs *subst)
{
if (p[0] != '\\')
return FALSE;
if (p[1] == delim || p[1] == '\\' || p[1] == '$')
return TRUE;
return p[1] == '&' && subst != NULL;
}
/* See ParseModifierPart */
static VarParseResult
ParseModifierPartSubst(
const char **pp,
char delim,
VarEvalFlags eflags,
ModChain *ch,
char **out_part,
/* Optionally stores the length of the returned string, just to save
* another strlen call. */
size_t *out_length,
/* For the first part of the :S modifier, sets the VARP_ANCHOR_END flag
* if the last character of the pattern is a $. */
VarPatternFlags *out_pflags,
/* For the second part of the :S modifier, allow ampersands to be
* escaped and replace unescaped ampersands with subst->lhs. */
struct ModifyWord_SubstArgs *subst
)
{
Buffer buf;
const char *p;
Buf_Init(&buf);
/*
* Skim through until the matching delimiter is found; pick up
* variable expressions on the way.
*/
p = *pp;
while (*p != '\0' && *p != delim) {
const char *varstart;
if (IsEscapedModifierPart(p, delim, subst)) {
Buf_AddByte(&buf, p[1]);
p += 2;
continue;
}
if (*p != '$') { /* Unescaped, simple text */
if (subst != NULL && *p == '&')
Buf_AddBytes(&buf, subst->lhs, subst->lhsLen);
else
Buf_AddByte(&buf, *p);
p++;
continue;
}
if (p[1] == delim) { /* Unescaped $ at end of pattern */
if (out_pflags != NULL)
out_pflags->anchorEnd = TRUE;
else
Buf_AddByte(&buf, *p);
p++;
continue;
}
if (eflags.wantRes) { /* Nested variable, evaluated */
const char *nested_p = p;
FStr nested_val;
VarEvalFlags nested_eflags = eflags;
nested_eflags.keepDollar = FALSE;
(void)Var_Parse(&nested_p, ch->expr->scope,
nested_eflags, &nested_val);
/* TODO: handle errors */
Buf_AddStr(&buf, nested_val.str);
FStr_Done(&nested_val);
p += nested_p - p;
continue;
}
/*
* XXX: This whole block is very similar to Var_Parse without
* VarEvalFlags.wantRes. There may be subtle edge cases
* though that are not yet covered in the unit tests and that
* are parsed differently, depending on whether they are
* evaluated or not.
*
* This subtle difference is not documented in the manual
* page, neither is the difference between parsing :D and
* :M documented. No code should ever depend on these
* details, but who knows.
*/
varstart = p; /* Nested variable, only parsed */
if (p[1] == '(' || p[1] == '{') {
/*
* Find the end of this variable reference
* and suck it in without further ado.
* It will be interpreted later.
*/
char startc = p[1];
int endc = startc == '(' ? ')' : '}';
int depth = 1;
for (p += 2; *p != '\0' && depth > 0; p++) {
if (p[-1] != '\\') {
if (*p == startc)
depth++;
if (*p == endc)
depth--;
}
}
Buf_AddBytesBetween(&buf, varstart, p);
} else {
Buf_AddByte(&buf, *varstart);
p++;
}
}
if (*p != delim) {
*pp = p;
Error("Unfinished modifier for \"%s\" ('%c' missing)",
ch->expr->var->name.str, delim);
*out_part = NULL;
return VPR_ERR;
}
*pp = p + 1;
if (out_length != NULL)
*out_length = buf.len;
*out_part = Buf_DoneData(&buf);
DEBUG1(VAR, "Modifier part: \"%s\"\n", *out_part);
return VPR_OK;
}
/*
* Parse a part of a modifier such as the "from" and "to" in :S/from/to/ or
* the "var" or "replacement ${var}" in :@var@replacement ${var}@, up to and
* including the next unescaped delimiter. The delimiter, as well as the
* backslash or the dollar, can be escaped with a backslash.
*
* Return the parsed (and possibly expanded) string, or NULL if no delimiter
* was found. On successful return, the parsing position pp points right
* after the delimiter. The delimiter is not included in the returned
* value though.
*/
static VarParseResult
ParseModifierPart(
/* The parsing position, updated upon return */
const char **pp,
/* Parsing stops at this delimiter */
char delim,
/* Flags for evaluating nested variables. */
VarEvalFlags eflags,
ModChain *ch,
char **out_part
)
{
return ParseModifierPartSubst(pp, delim, eflags, ch, out_part,
NULL, NULL, NULL);
}
MAKE_INLINE Boolean
IsDelimiter(char c, const ModChain *ch)
{
return c == ':' || c == ch->endc;
}
/* Test whether mod starts with modname, followed by a delimiter. */
MAKE_INLINE Boolean
ModMatch(const char *mod, const char *modname, const ModChain *ch)
{
size_t n = strlen(modname);
return strncmp(mod, modname, n) == 0 && IsDelimiter(mod[n], ch);
}
/* Test whether mod starts with modname, followed by a delimiter or '='. */
MAKE_INLINE Boolean
ModMatchEq(const char *mod, const char *modname, const ModChain *ch)
{
size_t n = strlen(modname);
return strncmp(mod, modname, n) == 0 &&
(IsDelimiter(mod[n], ch) || mod[n] == '=');
}
static Boolean
TryParseIntBase0(const char **pp, int *out_num)
{
char *end;
long n;
errno = 0;
n = strtol(*pp, &end, 0);
if (end == *pp)
return FALSE;
if ((n == LONG_MIN || n == LONG_MAX) && errno == ERANGE)
return FALSE;
if (n < INT_MIN || n > INT_MAX)
return FALSE;
*pp = end;
*out_num = (int)n;
return TRUE;
}
static Boolean
TryParseSize(const char **pp, size_t *out_num)
{
char *end;
unsigned long n;
if (!ch_isdigit(**pp))
return FALSE;
errno = 0;
n = strtoul(*pp, &end, 10);
if (n == ULONG_MAX && errno == ERANGE)
return FALSE;
if (n > SIZE_MAX)
return FALSE;
*pp = end;
*out_num = (size_t)n;
return TRUE;
}
static Boolean
TryParseChar(const char **pp, int base, char *out_ch)
{
char *end;
unsigned long n;
if (!ch_isalnum(**pp))
return FALSE;
errno = 0;
n = strtoul(*pp, &end, base);
if (n == ULONG_MAX && errno == ERANGE)
return FALSE;
if (n > UCHAR_MAX)
return FALSE;
*pp = end;
*out_ch = (char)n;
return TRUE;
}
/*
* Modify each word of the expression using the given function and place the
* result back in the expression.
*/
static void
ModifyWords(ModChain *ch,
ModifyWordProc modifyWord, void *modifyWord_args,
Boolean oneBigWord)
{
Expr *expr = ch->expr;
const char *val = expr->value.str;
SepBuf result;
Words words;
size_t i;
if (oneBigWord) {
SepBuf_Init(&result, ch->sep);
modifyWord(val, &result, modifyWord_args);
goto done;
}
words = Str_Words(val, FALSE);
DEBUG2(VAR, "ModifyWords: split \"%s\" into %u words\n",
val, (unsigned)words.len);
SepBuf_Init(&result, ch->sep);
for (i = 0; i < words.len; i++) {
modifyWord(words.words[i], &result, modifyWord_args);
if (result.buf.len > 0)
SepBuf_Sep(&result);
}
Words_Free(words);
done:
Expr_SetValueOwn(expr, SepBuf_DoneData(&result));
}
/* :@var@...${var}...@ */
static ApplyModifierResult
ApplyModifier_Loop(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
struct ModifyWord_LoopArgs args;
char prev_sep;
VarParseResult res;
args.scope = expr->scope;
(*pp)++; /* Skip the first '@' */
res = ParseModifierPart(pp, '@', VARE_PARSE_ONLY, ch, &args.tvar);
if (res != VPR_OK)
return AMR_CLEANUP;
if (opts.strict && strchr(args.tvar, '$') != NULL) {
Parse_Error(PARSE_FATAL,
"In the :@ modifier of \"%s\", the variable name \"%s\" "
"must not contain a dollar.",
expr->var->name.str, args.tvar);
return AMR_CLEANUP;
}
res = ParseModifierPart(pp, '@', VARE_PARSE_ONLY, ch, &args.str);
if (res != VPR_OK)
return AMR_CLEANUP;
if (!expr->eflags.wantRes)
goto done;
args.eflags = expr->eflags;
args.eflags.keepDollar = FALSE;
prev_sep = ch->sep;
ch->sep = ' '; /* XXX: should be ch->sep for consistency */
ModifyWords(ch, ModifyWord_Loop, &args, ch->oneBigWord);
ch->sep = prev_sep;
/* XXX: Consider restoring the previous variable instead of deleting. */
/*
* XXX: The variable name should not be expanded here, see
* ModifyWord_Loop.
*/
Var_DeleteExpand(expr->scope, args.tvar);
done:
free(args.tvar);
free(args.str);
return AMR_OK;
}
/* :Ddefined or :Uundefined */
static ApplyModifierResult
ApplyModifier_Defined(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
Buffer buf;
const char *p;
VarEvalFlags eflags = VARE_PARSE_ONLY;
if (expr->eflags.wantRes)
if ((**pp == 'D') == (expr->defined == DEF_REGULAR))
eflags = expr->eflags;
Buf_Init(&buf);
p = *pp + 1;
while (!IsDelimiter(*p, ch) && *p != '\0') {
/* XXX: This code is similar to the one in Var_Parse.
* See if the code can be merged.
* See also ApplyModifier_Match and ParseModifierPart. */
/* Escaped delimiter or other special character */
/* See Buf_AddEscaped in for.c. */
if (*p == '\\') {
char c = p[1];
if (IsDelimiter(c, ch) || c == '$' || c == '\\') {
Buf_AddByte(&buf, c);
p += 2;
continue;
}
}
/* Nested variable expression */
if (*p == '$') {
FStr nested_val;
(void)Var_Parse(&p, expr->scope, eflags, &nested_val);
/* TODO: handle errors */
if (expr->eflags.wantRes)
Buf_AddStr(&buf, nested_val.str);
FStr_Done(&nested_val);
continue;
}
/* Ordinary text */
Buf_AddByte(&buf, *p);
p++;
}
*pp = p;
Expr_Define(expr);
if (eflags.wantRes)
Expr_SetValueOwn(expr, Buf_DoneData(&buf));
else
Buf_Done(&buf);
return AMR_OK;
}
/* :L */
static ApplyModifierResult
ApplyModifier_Literal(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
(*pp)++;
if (expr->eflags.wantRes) {
Expr_Define(expr);
Expr_SetValueOwn(expr, bmake_strdup(expr->var->name.str));
}
return AMR_OK;
}
static Boolean
TryParseTime(const char **pp, time_t *out_time)
{
char *end;
unsigned long n;
if (!ch_isdigit(**pp))
return FALSE;
errno = 0;
n = strtoul(*pp, &end, 10);
if (n == ULONG_MAX && errno == ERANGE)
return FALSE;
*pp = end;
*out_time = (time_t)n; /* ignore possible truncation for now */
return TRUE;
}
/* :gmtime */
static ApplyModifierResult
ApplyModifier_Gmtime(const char **pp, ModChain *ch)
{
time_t utc;
const char *mod = *pp;
if (!ModMatchEq(mod, "gmtime", ch))
return AMR_UNKNOWN;
if (mod[6] == '=') {
const char *p = mod + 7;
if (!TryParseTime(&p, &utc)) {
Parse_Error(PARSE_FATAL,
"Invalid time value: %s", mod + 7);
return AMR_CLEANUP;
}
*pp = p;
} else {
utc = 0;
*pp = mod + 6;
}
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(ch->expr,
VarStrftime(ch->expr->value.str, TRUE, utc));
return AMR_OK;
}
/* :localtime */
static ApplyModifierResult
ApplyModifier_Localtime(const char **pp, ModChain *ch)
{
time_t utc;
const char *mod = *pp;
if (!ModMatchEq(mod, "localtime", ch))
return AMR_UNKNOWN;
if (mod[9] == '=') {
const char *p = mod + 10;
if (!TryParseTime(&p, &utc)) {
Parse_Error(PARSE_FATAL,
"Invalid time value: %s", mod + 10);
return AMR_CLEANUP;
}
*pp = p;
} else {
utc = 0;
*pp = mod + 9;
}
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(ch->expr,
VarStrftime(ch->expr->value.str, FALSE, utc));
return AMR_OK;
}
/* :hash */
static ApplyModifierResult
ApplyModifier_Hash(const char **pp, ModChain *ch)
{
if (!ModMatch(*pp, "hash", ch))
return AMR_UNKNOWN;
*pp += 4;
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(ch->expr, VarHash(ch->expr->value.str));
return AMR_OK;
}
/* :P */
static ApplyModifierResult
ApplyModifier_Path(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
GNode *gn;
char *path;
(*pp)++;
if (!ch->expr->eflags.wantRes)
return AMR_OK;
Expr_Define(expr);
gn = Targ_FindNode(expr->var->name.str);
if (gn == NULL || gn->type & OP_NOPATH) {
path = NULL;
} else if (gn->path != NULL) {
path = bmake_strdup(gn->path);
} else {
SearchPath *searchPath = Suff_FindPath(gn);
path = Dir_FindFile(expr->var->name.str, searchPath);
}
if (path == NULL)
path = bmake_strdup(expr->var->name.str);
Expr_SetValueOwn(expr, path);
return AMR_OK;
}
/* :!cmd! */
static ApplyModifierResult
ApplyModifier_ShellCommand(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
char *cmd;
const char *errfmt;
VarParseResult res;
(*pp)++;
res = ParseModifierPart(pp, '!', expr->eflags, ch, &cmd);
if (res != VPR_OK)
return AMR_CLEANUP;
errfmt = NULL;
if (expr->eflags.wantRes)
Expr_SetValueOwn(expr, Cmd_Exec(cmd, &errfmt));
else
Expr_SetValueRefer(expr, "");
if (errfmt != NULL)
Error(errfmt, cmd); /* XXX: why still return AMR_OK? */
free(cmd);
Expr_Define(expr);
return AMR_OK;
}
/*
* The :range modifier generates an integer sequence as long as the words.
* The :range=7 modifier generates an integer sequence from 1 to 7.
*/
static ApplyModifierResult
ApplyModifier_Range(const char **pp, ModChain *ch)
{
size_t n;
Buffer buf;
size_t i;
const char *mod = *pp;
if (!ModMatchEq(mod, "range", ch))
return AMR_UNKNOWN;
if (mod[5] == '=') {
const char *p = mod + 6;
if (!TryParseSize(&p, &n)) {
Parse_Error(PARSE_FATAL,
"Invalid number \"%s\" for ':range' modifier",
mod + 6);
return AMR_CLEANUP;
}
*pp = p;
} else {
n = 0;
*pp = mod + 5;
}
if (!ch->expr->eflags.wantRes)
return AMR_OK;
if (n == 0) {
Words words = Str_Words(ch->expr->value.str, FALSE);
n = words.len;
Words_Free(words);
}
Buf_Init(&buf);
for (i = 0; i < n; i++) {
if (i != 0) {
/* XXX: Use ch->sep instead of ' ', for consistency. */
Buf_AddByte(&buf, ' ');
}
Buf_AddInt(&buf, 1 + (int)i);
}
Expr_SetValueOwn(ch->expr, Buf_DoneData(&buf));
return AMR_OK;
}
/* Parse a ':M' or ':N' modifier. */
static void
ParseModifier_Match(const char **pp, const ModChain *ch,
char **out_pattern)
{
const char *mod = *pp;
Expr *expr = ch->expr;
Boolean copy = FALSE; /* pattern should be, or has been, copied */
Boolean needSubst = FALSE;
const char *endpat;
char *pattern;
/*
* In the loop below, ignore ':' unless we are at (or back to) the
* original brace level.
* XXX: This will likely not work right if $() and ${} are intermixed.
*/
/*
* XXX: This code is similar to the one in Var_Parse.
* See if the code can be merged.
* See also ApplyModifier_Defined.
*/
int nest = 0;
const char *p;
for (p = mod + 1; *p != '\0' && !(*p == ':' && nest == 0); p++) {
if (*p == '\\' &&
(IsDelimiter(p[1], ch) || p[1] == ch->startc)) {
if (!needSubst)
copy = TRUE;
p++;
continue;
}
if (*p == '$')
needSubst = TRUE;
if (*p == '(' || *p == '{')
nest++;
if (*p == ')' || *p == '}') {
nest--;
if (nest < 0)
break;
}
}
*pp = p;
endpat = p;
if (copy) {
char *dst;
const char *src;
/* Compress the \:'s out of the pattern. */
pattern = bmake_malloc((size_t)(endpat - (mod + 1)) + 1);
dst = pattern;
src = mod + 1;
for (; src < endpat; src++, dst++) {
if (src[0] == '\\' && src + 1 < endpat &&
/* XXX: ch->startc is missing here; see above */
IsDelimiter(src[1], ch))
src++;
*dst = *src;
}
*dst = '\0';
} else {
pattern = bmake_strsedup(mod + 1, endpat);
}
if (needSubst) {
char *old_pattern = pattern;
(void)Var_Subst(pattern, expr->scope, expr->eflags, &pattern);
/* TODO: handle errors */
free(old_pattern);
}
DEBUG3(VAR, "Pattern[%s] for [%s] is [%s]\n",
expr->var->name.str, expr->value.str, pattern);
*out_pattern = pattern;
}
/* :Mpattern or :Npattern */
static ApplyModifierResult
ApplyModifier_Match(const char **pp, ModChain *ch)
{
const char mod = **pp;
char *pattern;
ParseModifier_Match(pp, ch, &pattern);
if (ch->expr->eflags.wantRes) {
ModifyWordProc modifyWord =
mod == 'M' ? ModifyWord_Match : ModifyWord_NoMatch;
ModifyWords(ch, modifyWord, pattern, ch->oneBigWord);
}
free(pattern);
return AMR_OK;
}
static void
ParsePatternFlags(const char **pp, VarPatternFlags *pflags, Boolean *oneBigWord)
{
for (;; (*pp)++) {
if (**pp == 'g')
pflags->subGlobal = TRUE;
else if (**pp == '1')
pflags->subOnce = TRUE;
else if (**pp == 'W')
*oneBigWord = TRUE;
else
break;
}
}
/* :S,from,to, */
static ApplyModifierResult
ApplyModifier_Subst(const char **pp, ModChain *ch)
{
struct ModifyWord_SubstArgs args;
char *lhs, *rhs;
Boolean oneBigWord;
VarParseResult res;
char delim = (*pp)[1];
if (delim == '\0') {
Error("Missing delimiter for modifier ':S'");
(*pp)++;
return AMR_CLEANUP;
}
*pp += 2;
args.pflags = (VarPatternFlags){ FALSE, FALSE, FALSE, FALSE };
args.matched = FALSE;
if (**pp == '^') {
args.pflags.anchorStart = TRUE;
(*pp)++;
}
res = ParseModifierPartSubst(pp, delim, ch->expr->eflags, ch, &lhs,
&args.lhsLen, &args.pflags, NULL);
if (res != VPR_OK)
return AMR_CLEANUP;
args.lhs = lhs;
res = ParseModifierPartSubst(pp, delim, ch->expr->eflags, ch, &rhs,
&args.rhsLen, NULL, &args);
if (res != VPR_OK)
return AMR_CLEANUP;
args.rhs = rhs;
oneBigWord = ch->oneBigWord;
ParsePatternFlags(pp, &args.pflags, &oneBigWord);
ModifyWords(ch, ModifyWord_Subst, &args, oneBigWord);
free(lhs);
free(rhs);
return AMR_OK;
}
#ifndef NO_REGEX
/* :C,from,to, */
static ApplyModifierResult
ApplyModifier_Regex(const char **pp, ModChain *ch)
{
char *re;
struct ModifyWord_SubstRegexArgs args;
Boolean oneBigWord;
int error;
VarParseResult res;
char delim = (*pp)[1];
if (delim == '\0') {
Error("Missing delimiter for :C modifier");
(*pp)++;
return AMR_CLEANUP;
}
*pp += 2;
res = ParseModifierPart(pp, delim, ch->expr->eflags, ch, &re);
if (res != VPR_OK)
return AMR_CLEANUP;
res = ParseModifierPart(pp, delim, ch->expr->eflags, ch, &args.replace);
if (args.replace == NULL) {
free(re);
return AMR_CLEANUP;
}
args.pflags = (VarPatternFlags){ FALSE, FALSE, FALSE, FALSE };
args.matched = FALSE;
oneBigWord = ch->oneBigWord;
ParsePatternFlags(pp, &args.pflags, &oneBigWord);
if (!(ch->expr->eflags.wantRes)) {
free(args.replace);
free(re);
return AMR_OK;
}
error = regcomp(&args.re, re, REG_EXTENDED);
free(re);
if (error != 0) {
VarREError(error, &args.re, "Regex compilation error");
free(args.replace);
return AMR_CLEANUP;
}
args.nsub = args.re.re_nsub + 1;
if (args.nsub > 10)
args.nsub = 10;
ModifyWords(ch, ModifyWord_SubstRegex, &args, oneBigWord);
regfree(&args.re);
free(args.replace);
return AMR_OK;
}
#endif
/* :Q, :q */
static ApplyModifierResult
ApplyModifier_Quote(const char **pp, ModChain *ch)
{
Boolean quoteDollar = **pp == 'q';
if (!IsDelimiter((*pp)[1], ch))
return AMR_UNKNOWN;
(*pp)++;
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(ch->expr,
VarQuote(ch->expr->value.str, quoteDollar));
return AMR_OK;
}
/*ARGSUSED*/
static void
ModifyWord_Copy(const char *word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
{
SepBuf_AddStr(buf, word);
}
/* :ts<separator> */
static ApplyModifierResult
ApplyModifier_ToSep(const char **pp, ModChain *ch)
{
const char *sep = *pp + 2;
/*
* Even in parse-only mode, proceed as normal since there is
* neither any observable side effect nor a performance penalty.
* Checking for wantRes for every single piece of code in here
* would make the code in this function too hard to read.
*/
/* ":ts<any><endc>" or ":ts<any>:" */
if (sep[0] != ch->endc && IsDelimiter(sep[1], ch)) {
*pp = sep + 1;
ch->sep = sep[0];
goto ok;
}
/* ":ts<endc>" or ":ts:" */
if (IsDelimiter(sep[0], ch)) {
*pp = sep;
ch->sep = '\0'; /* no separator */
goto ok;
}
/* ":ts<unrecognised><unrecognised>". */
if (sep[0] != '\\') {
(*pp)++; /* just for backwards compatibility */
return AMR_BAD;
}
/* ":ts\n" */
if (sep[1] == 'n') {
*pp = sep + 2;
ch->sep = '\n';
goto ok;
}
/* ":ts\t" */
if (sep[1] == 't') {
*pp = sep + 2;
ch->sep = '\t';
goto ok;
}
/* ":ts\x40" or ":ts\100" */
{
const char *p = sep + 1;
int base = 8; /* assume octal */
if (sep[1] == 'x') {
base = 16;
p++;
} else if (!ch_isdigit(sep[1])) {
(*pp)++; /* just for backwards compatibility */
return AMR_BAD; /* ":ts<backslash><unrecognised>". */
}
if (!TryParseChar(&p, base, &ch->sep)) {
Parse_Error(PARSE_FATAL,
"Invalid character number: %s", p);
return AMR_CLEANUP;
}
if (!IsDelimiter(*p, ch)) {
(*pp)++; /* just for backwards compatibility */
return AMR_BAD;
}
*pp = p;
}
ok:
ModifyWords(ch, ModifyWord_Copy, NULL, ch->oneBigWord);
return AMR_OK;
}
static char *
str_toupper(const char *str)
{
char *res;
size_t i, len;
len = strlen(str);
res = bmake_malloc(len + 1);
for (i = 0; i < len + 1; i++)
res[i] = ch_toupper(str[i]);
return res;
}
static char *
str_tolower(const char *str)
{
char *res;
size_t i, len;
len = strlen(str);
res = bmake_malloc(len + 1);
for (i = 0; i < len + 1; i++)
res[i] = ch_tolower(str[i]);
return res;
}
/* :tA, :tu, :tl, :ts<separator>, etc. */
static ApplyModifierResult
ApplyModifier_To(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
const char *mod = *pp;
assert(mod[0] == 't');
if (IsDelimiter(mod[1], ch) || mod[1] == '\0') {
*pp = mod + 1;
return AMR_BAD; /* Found ":t<endc>" or ":t:". */
}
if (mod[1] == 's')
return ApplyModifier_ToSep(pp, ch);
if (!IsDelimiter(mod[2], ch)) { /* :t<unrecognized> */
*pp = mod + 1;
return AMR_BAD;
}
if (mod[1] == 'A') { /* :tA */
*pp = mod + 2;
ModifyWords(ch, ModifyWord_Realpath, NULL, ch->oneBigWord);
return AMR_OK;
}
if (mod[1] == 'u') { /* :tu */
*pp = mod + 2;
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(expr, str_toupper(expr->value.str));
return AMR_OK;
}
if (mod[1] == 'l') { /* :tl */
*pp = mod + 2;
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(expr, str_tolower(expr->value.str));
return AMR_OK;
}
if (mod[1] == 'W' || mod[1] == 'w') { /* :tW, :tw */
*pp = mod + 2;
ch->oneBigWord = mod[1] == 'W';
return AMR_OK;
}
/* Found ":t<unrecognised>:" or ":t<unrecognised><endc>". */
*pp = mod + 1; /* XXX: unnecessary but observable */
return AMR_BAD;
}
/* :[#], :[1], :[-1..1], etc. */
static ApplyModifierResult
ApplyModifier_Words(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
char *estr;
int first, last;
VarParseResult res;
const char *p;
(*pp)++; /* skip the '[' */
res = ParseModifierPart(pp, ']', expr->eflags, ch, &estr);
if (res != VPR_OK)
return AMR_CLEANUP;
if (!IsDelimiter(**pp, ch))
goto bad_modifier; /* Found junk after ']' */
if (!(expr->eflags.wantRes))
goto ok;
if (estr[0] == '\0')
goto bad_modifier; /* Found ":[]". */
if (estr[0] == '#' && estr[1] == '\0') { /* Found ":[#]" */
if (ch->oneBigWord) {
Expr_SetValueRefer(expr, "1");
} else {
Buffer buf;
Words words = Str_Words(expr->value.str, FALSE);
size_t ac = words.len;
Words_Free(words);
/* 3 digits + '\0' is usually enough */
Buf_InitSize(&buf, 4);
Buf_AddInt(&buf, (int)ac);
Expr_SetValueOwn(expr, Buf_DoneData(&buf));
}
goto ok;
}
if (estr[0] == '*' && estr[1] == '\0') { /* Found ":[*]" */
ch->oneBigWord = TRUE;
goto ok;
}
if (estr[0] == '@' && estr[1] == '\0') { /* Found ":[@]" */
ch->oneBigWord = FALSE;
goto ok;
}
/*
* We expect estr to contain a single integer for :[N], or two
* integers separated by ".." for :[start..end].
*/
p = estr;
if (!TryParseIntBase0(&p, &first))
goto bad_modifier; /* Found junk instead of a number */
if (p[0] == '\0') { /* Found only one integer in :[N] */
last = first;
} else if (p[0] == '.' && p[1] == '.' && p[2] != '\0') {
/* Expecting another integer after ".." */
p += 2;
if (!TryParseIntBase0(&p, &last) || *p != '\0')
goto bad_modifier; /* Found junk after ".." */
} else
goto bad_modifier; /* Found junk instead of ".." */
/*
* Now first and last are properly filled in, but we still have to
* check for 0 as a special case.
*/
if (first == 0 && last == 0) {
/* ":[0]" or perhaps ":[0..0]" */
ch->oneBigWord = TRUE;
goto ok;
}
/* ":[0..N]" or ":[N..0]" */
if (first == 0 || last == 0)
goto bad_modifier;
/* Normal case: select the words described by first and last. */
Expr_SetValueOwn(expr,
VarSelectWords(expr->value.str, first, last,
ch->sep, ch->oneBigWord));
ok:
free(estr);
return AMR_OK;
bad_modifier:
free(estr);
return AMR_BAD;
}
static int
str_cmp_asc(const void *a, const void *b)
{
return strcmp(*(const char *const *)a, *(const char *const *)b);
}
static int
str_cmp_desc(const void *a, const void *b)
{
return strcmp(*(const char *const *)b, *(const char *const *)a);
}
static void
ShuffleStrings(char **strs, size_t n)
{
size_t i;
for (i = n - 1; i > 0; i--) {
size_t rndidx = (size_t)random() % (i + 1);
char *t = strs[i];
strs[i] = strs[rndidx];
strs[rndidx] = t;
}
}
/* :O (order ascending) or :Or (order descending) or :Ox (shuffle) */
static ApplyModifierResult
ApplyModifier_Order(const char **pp, ModChain *ch)
{
const char *mod = (*pp)++; /* skip past the 'O' in any case */
Words words;
enum SortMode {
ASC, DESC, SHUFFLE
} mode;
if (IsDelimiter(mod[1], ch)) {
mode = ASC;
} else if ((mod[1] == 'r' || mod[1] == 'x') &&
IsDelimiter(mod[2], ch)) {
(*pp)++;
mode = mod[1] == 'r' ? DESC : SHUFFLE;
} else
return AMR_BAD;
if (!ch->expr->eflags.wantRes)
return AMR_OK;
words = Str_Words(ch->expr->value.str, FALSE);
if (mode == SHUFFLE)
ShuffleStrings(words.words, words.len);
else
qsort(words.words, words.len, sizeof words.words[0],
mode == ASC ? str_cmp_asc : str_cmp_desc);
Expr_SetValueOwn(ch->expr, Words_JoinFree(words));
return AMR_OK;
}
/* :? then : else */
static ApplyModifierResult
ApplyModifier_IfElse(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
char *then_expr, *else_expr;
VarParseResult res;
Boolean value = FALSE;
VarEvalFlags then_eflags = VARE_PARSE_ONLY;
VarEvalFlags else_eflags = VARE_PARSE_ONLY;
int cond_rc = COND_PARSE; /* anything other than COND_INVALID */
if (expr->eflags.wantRes) {
cond_rc = Cond_EvalCondition(expr->var->name.str, &value);
if (cond_rc != COND_INVALID && value)
then_eflags = expr->eflags;
if (cond_rc != COND_INVALID && !value)
else_eflags = expr->eflags;
}
(*pp)++; /* skip past the '?' */
res = ParseModifierPart(pp, ':', then_eflags, ch, &then_expr);
if (res != VPR_OK)
return AMR_CLEANUP;
res = ParseModifierPart(pp, ch->endc, else_eflags, ch, &else_expr);
if (res != VPR_OK)
return AMR_CLEANUP;
(*pp)--; /* Go back to the ch->endc. */
if (cond_rc == COND_INVALID) {
Error("Bad conditional expression `%s' in %s?%s:%s",
expr->var->name.str, expr->var->name.str,
then_expr, else_expr);
return AMR_CLEANUP;
}
if (!expr->eflags.wantRes) {
free(then_expr);
free(else_expr);
} else if (value) {
Expr_SetValueOwn(expr, then_expr);
free(else_expr);
} else {
Expr_SetValueOwn(expr, else_expr);
free(then_expr);
}
Expr_Define(expr);
return AMR_OK;
}
/*
* The ::= modifiers are special in that they do not read the variable value
* but instead assign to that variable. They always expand to an empty
* string.
*
* Their main purpose is in supporting .for loops that generate shell commands
* since an ordinary variable assignment at that point would terminate the
* dependency group for these targets. For example:
*
* list-targets: .USE
* .for i in ${.TARGET} ${.TARGET:R}.gz
* @${t::=$i}
* @echo 'The target is ${t:T}.'
* .endfor
*
* ::=<str> Assigns <str> as the new value of variable.
* ::?=<str> Assigns <str> as value of variable if
* it was not already set.
* ::+=<str> Appends <str> to variable.
* ::!=<cmd> Assigns output of <cmd> as the new value of
* variable.
*/
static ApplyModifierResult
ApplyModifier_Assign(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
GNode *scope;
char *val;
VarParseResult res;
const char *mod = *pp;
const char *op = mod + 1;
if (op[0] == '=')
goto ok;
if ((op[0] == '!' || op[0] == '+' || op[0] == '?') && op[1] == '=')
goto ok;
return AMR_UNKNOWN; /* "::<unrecognised>" */
ok:
if (expr->var->name.str[0] == '\0') {
*pp = mod + 1;
return AMR_BAD;
}
switch (op[0]) {
case '+':
case '?':
case '!':
*pp = mod + 3;
break;
default:
*pp = mod + 2;
break;
}
res = ParseModifierPart(pp, ch->endc, expr->eflags, ch, &val);
if (res != VPR_OK)
return AMR_CLEANUP;
(*pp)--; /* Go back to the ch->endc. */
if (!expr->eflags.wantRes)
goto done;
scope = expr->scope; /* scope where v belongs */
if (expr->defined == DEF_REGULAR && expr->scope != SCOPE_GLOBAL) {
Var *gv = VarFind(expr->var->name.str, expr->scope, FALSE);
if (gv == NULL)
scope = SCOPE_GLOBAL;
else
VarFreeEnv(gv);
}
switch (op[0]) {
case '+':
Var_Append(scope, expr->var->name.str, val);
break;
case '!': {
const char *errfmt;
char *cmd_output = Cmd_Exec(val, &errfmt);
if (errfmt != NULL)
Error(errfmt, val);
else
Var_Set(scope, expr->var->name.str, cmd_output);
free(cmd_output);
break;
}
case '?':
if (expr->defined == DEF_REGULAR)
break;
/* FALLTHROUGH */
default:
Var_Set(scope, expr->var->name.str, val);
break;
}
Expr_SetValueRefer(expr, "");
done:
free(val);
return AMR_OK;
}
/*
* :_=...
* remember current value
*/
static ApplyModifierResult
ApplyModifier_Remember(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
const char *mod = *pp;
FStr name;
if (!ModMatchEq(mod, "_", ch))
return AMR_UNKNOWN;
name = FStr_InitRefer("_");
if (mod[1] == '=') {
/*
* XXX: This ad-hoc call to strcspn deviates from the usual
* behavior defined in ParseModifierPart. This creates an
* unnecessary, undocumented inconsistency in make.
*/
const char *arg = mod + 2;
size_t argLen = strcspn(arg, ":)}");
*pp = arg + argLen;
name = FStr_InitOwn(bmake_strldup(arg, argLen));
} else
*pp = mod + 1;
if (expr->eflags.wantRes)
Var_Set(expr->scope, name.str, expr->value.str);
FStr_Done(&name);
return AMR_OK;
}
/*
* Apply the given function to each word of the variable value,
* for a single-letter modifier such as :H, :T.
*/
static ApplyModifierResult
ApplyModifier_WordFunc(const char **pp, ModChain *ch,
ModifyWordProc modifyWord)
{
if (!IsDelimiter((*pp)[1], ch))
return AMR_UNKNOWN;
(*pp)++;
if (ch->expr->eflags.wantRes)
ModifyWords(ch, modifyWord, NULL, ch->oneBigWord);
return AMR_OK;
}
static ApplyModifierResult
ApplyModifier_Unique(const char **pp, ModChain *ch)
{
if (!IsDelimiter((*pp)[1], ch))
return AMR_UNKNOWN;
(*pp)++;
if (ch->expr->eflags.wantRes)
Expr_SetValueOwn(ch->expr, VarUniq(ch->expr->value.str));
return AMR_OK;
}
#ifdef SYSVVARSUB
/* :from=to */
static ApplyModifierResult
ApplyModifier_SysV(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
char *lhs, *rhs;
VarParseResult res;
const char *mod = *pp;
Boolean eqFound = FALSE;
/*
* First we make a pass through the string trying to verify it is a
* SysV-make-style translation. It must be: <lhs>=<rhs>
*/
int depth = 1;
const char *p = mod;
while (*p != '\0' && depth > 0) {
if (*p == '=') { /* XXX: should also test depth == 1 */
eqFound = TRUE;
/* continue looking for ch->endc */
} else if (*p == ch->endc)
depth--;
else if (*p == ch->startc)
depth++;
if (depth > 0)
p++;
}
if (*p != ch->endc || !eqFound)
return AMR_UNKNOWN;
res = ParseModifierPart(pp, '=', expr->eflags, ch, &lhs);
if (res != VPR_OK)
return AMR_CLEANUP;
/* The SysV modifier lasts until the end of the variable expression. */
res = ParseModifierPart(pp, ch->endc, expr->eflags, ch, &rhs);
if (res != VPR_OK)
return AMR_CLEANUP;
(*pp)--; /* Go back to the ch->endc. */
if (lhs[0] == '\0' && expr->value.str[0] == '\0') {
/* Do not turn an empty expression into non-empty. */
} else {
struct ModifyWord_SYSVSubstArgs args = {
expr->scope, lhs, rhs
};
ModifyWords(ch, ModifyWord_SYSVSubst, &args, ch->oneBigWord);
}
free(lhs);
free(rhs);
return AMR_OK;
}
#endif
#ifdef SUNSHCMD
/* :sh */
static ApplyModifierResult
ApplyModifier_SunShell(const char **pp, ModChain *ch)
{
Expr *expr = ch->expr;
const char *p = *pp;
if (!(p[1] == 'h' && IsDelimiter(p[2], ch)))
return AMR_UNKNOWN;
*pp = p + 2;
if (expr->eflags.wantRes) {
const char *errfmt;
char *output = Cmd_Exec(expr->value.str, &errfmt);
if (errfmt != NULL)
Error(errfmt, expr->value.str);
Expr_SetValueOwn(expr, output);
}
return AMR_OK;
}
#endif
static void
LogBeforeApply(const ModChain *ch, const char *mod)
{
const Expr *expr = ch->expr;
char vflags_str[VarFlags_ToStringSize];
Boolean is_single_char = mod[0] != '\0' && IsDelimiter(mod[1], ch);
/* At this point, only the first character of the modifier can
* be used since the end of the modifier is not yet known. */
debug_printf("Applying ${%s:%c%s} to \"%s\" (%s, %s, %s)\n",
expr->var->name.str, mod[0], is_single_char ? "" : "...",
expr->value.str,
VarEvalFlags_ToString(expr->eflags),
VarFlags_ToString(vflags_str, expr->var->flags),
ExprDefined_Name[expr->defined]);
}
static void
LogAfterApply(const ModChain *ch, const char *p, const char *mod)
{
const Expr *expr = ch->expr;
const char *value = expr->value.str;
char vflags_str[VarFlags_ToStringSize];
const char *quot = value == var_Error ? "" : "\"";
debug_printf("Result of ${%s:%.*s} is %s%s%s (%s, %s, %s)\n",
expr->var->name.str, (int)(p - mod), mod,
quot, value == var_Error ? "error" : value, quot,
VarEvalFlags_ToString(expr->eflags),
VarFlags_ToString(vflags_str, expr->var->flags),
ExprDefined_Name[expr->defined]);
}
static ApplyModifierResult
ApplyModifier(const char **pp, ModChain *ch)
{
switch (**pp) {
case '!':
return ApplyModifier_ShellCommand(pp, ch);
case ':':
return ApplyModifier_Assign(pp, ch);
case '?':
return ApplyModifier_IfElse(pp, ch);
case '@':
return ApplyModifier_Loop(pp, ch);
case '[':
return ApplyModifier_Words(pp, ch);
case '_':
return ApplyModifier_Remember(pp, ch);
#ifndef NO_REGEX
case 'C':
return ApplyModifier_Regex(pp, ch);
#endif
case 'D':
return ApplyModifier_Defined(pp, ch);
case 'E':
return ApplyModifier_WordFunc(pp, ch, ModifyWord_Suffix);
case 'g':
return ApplyModifier_Gmtime(pp, ch);
case 'H':
return ApplyModifier_WordFunc(pp, ch, ModifyWord_Head);
case 'h':
return ApplyModifier_Hash(pp, ch);
case 'L':
return ApplyModifier_Literal(pp, ch);
case 'l':
return ApplyModifier_Localtime(pp, ch);
case 'M':
case 'N':
return ApplyModifier_Match(pp, ch);
case 'O':
return ApplyModifier_Order(pp, ch);
case 'P':
return ApplyModifier_Path(pp, ch);
case 'Q':
case 'q':
return ApplyModifier_Quote(pp, ch);
case 'R':
return ApplyModifier_WordFunc(pp, ch, ModifyWord_Root);
case 'r':
return ApplyModifier_Range(pp, ch);
case 'S':
return ApplyModifier_Subst(pp, ch);
#ifdef SUNSHCMD
case 's':
return ApplyModifier_SunShell(pp, ch);
#endif
case 'T':
return ApplyModifier_WordFunc(pp, ch, ModifyWord_Tail);
case 't':
return ApplyModifier_To(pp, ch);
case 'U':
return ApplyModifier_Defined(pp, ch);
case 'u':
return ApplyModifier_Unique(pp, ch);
default:
return AMR_UNKNOWN;
}
}
static void ApplyModifiers(Expr *, const char **, char, char);
typedef enum ApplyModifiersIndirectResult {
/* The indirect modifiers have been applied successfully. */
AMIR_CONTINUE,
/* Fall back to the SysV modifier. */
AMIR_SYSV,
/* Error out. */
AMIR_OUT
} ApplyModifiersIndirectResult;
/*
* While expanding a variable expression, expand and apply indirect modifiers,
* such as in ${VAR:${M_indirect}}.
*
* All indirect modifiers of a group must come from a single variable
* expression. ${VAR:${M1}} is valid but ${VAR:${M1}${M2}} is not.
*
* Multiple groups of indirect modifiers can be chained by separating them
* with colons. ${VAR:${M1}:${M2}} contains 2 indirect modifiers.
*
* If the variable expression is not followed by ch->endc or ':', fall
* back to trying the SysV modifier, such as in ${VAR:${FROM}=${TO}}.
*/
static ApplyModifiersIndirectResult
ApplyModifiersIndirect(ModChain *ch, const char **pp)
{
Expr *expr = ch->expr;
const char *p = *pp;
FStr mods;
(void)Var_Parse(&p, expr->scope, expr->eflags, &mods);
/* TODO: handle errors */
if (mods.str[0] != '\0' && *p != '\0' && !IsDelimiter(*p, ch)) {
FStr_Done(&mods);
return AMIR_SYSV;
}
DEBUG3(VAR, "Indirect modifier \"%s\" from \"%.*s\"\n",
mods.str, (int)(p - *pp), *pp);
if (mods.str[0] != '\0') {
const char *modsp = mods.str;
ApplyModifiers(expr, &modsp, '\0', '\0');
if (expr->value.str == var_Error || *modsp != '\0') {
FStr_Done(&mods);
*pp = p;
return AMIR_OUT; /* error already reported */
}
}
FStr_Done(&mods);
if (*p == ':')
p++;
else if (*p == '\0' && ch->endc != '\0') {
Error("Unclosed variable expression after indirect "
"modifier, expecting '%c' for variable \"%s\"",
ch->endc, expr->var->name.str);
*pp = p;
return AMIR_OUT;
}
*pp = p;
return AMIR_CONTINUE;
}
static ApplyModifierResult
ApplySingleModifier(const char **pp, ModChain *ch)
{
ApplyModifierResult res;
const char *mod = *pp;
const char *p = *pp;
if (DEBUG(VAR))
LogBeforeApply(ch, mod);
res = ApplyModifier(&p, ch);
#ifdef SYSVVARSUB
if (res == AMR_UNKNOWN) {
assert(p == mod);
res = ApplyModifier_SysV(&p, ch);
}
#endif
if (res == AMR_UNKNOWN) {
/*
* Guess the end of the current modifier.
* XXX: Skipping the rest of the modifier hides
* errors and leads to wrong results.
* Parsing should rather stop here.
*/
for (p++; !IsDelimiter(*p, ch) && *p != '\0'; p++)
continue;
Parse_Error(PARSE_FATAL, "Unknown modifier \"%.*s\"",
(int)(p - mod), mod);
Expr_SetValueRefer(ch->expr, var_Error);
}
if (res == AMR_CLEANUP || res == AMR_BAD) {
*pp = p;
return res;
}
if (DEBUG(VAR))
LogAfterApply(ch, p, mod);
if (*p == '\0' && ch->endc != '\0') {
Error(
"Unclosed variable expression, expecting '%c' for "
"modifier \"%.*s\" of variable \"%s\" with value \"%s\"",
ch->endc,
(int)(p - mod), mod,
ch->expr->var->name.str, ch->expr->value.str);
} else if (*p == ':') {
p++;
} else if (opts.strict && *p != '\0' && *p != ch->endc) {
Parse_Error(PARSE_FATAL,
"Missing delimiter ':' after modifier \"%.*s\"",
(int)(p - mod), mod);
/*
* TODO: propagate parse error to the enclosing
* expression
*/
}
*pp = p;
return AMR_OK;
}
/* Apply any modifiers (such as :Mpattern or :@var@loop@ or :Q or ::=value). */
static void
ApplyModifiers(
Expr *expr,
const char **pp, /* the parsing position, updated upon return */
char startc, /* '(' or '{'; or '\0' for indirect modifiers */
char endc /* ')' or '}'; or '\0' for indirect modifiers */
)
{
ModChain ch = {
expr,
startc,
endc,
' ', /* .sep */
FALSE /* .oneBigWord */
};
const char *p;
const char *mod;
assert(startc == '(' || startc == '{' || startc == '\0');
assert(endc == ')' || endc == '}' || endc == '\0');
assert(expr->value.str != NULL);
p = *pp;
if (*p == '\0' && endc != '\0') {
Error(
"Unclosed variable expression (expecting '%c') for \"%s\"",
ch.endc, expr->var->name.str);
goto cleanup;
}
while (*p != '\0' && *p != endc) {
ApplyModifierResult res;
if (*p == '$') {
ApplyModifiersIndirectResult amir =
ApplyModifiersIndirect(&ch, &p);
if (amir == AMIR_CONTINUE)
continue;
if (amir == AMIR_OUT)
break;
/*
* It's neither '${VAR}:' nor '${VAR}}'. Try to parse
* it as a SysV modifier, as that is the only modifier
* that can start with '$'.
*/
}
mod = p;
res = ApplySingleModifier(&p, &ch);
if (res == AMR_CLEANUP)
goto cleanup;
if (res == AMR_BAD)
goto bad_modifier;
}
*pp = p;
assert(expr->value.str != NULL); /* Use var_Error or varUndefined. */
return;
bad_modifier:
/* XXX: The modifier end is only guessed. */
Error("Bad modifier \":%.*s\" for variable \"%s\"",
(int)strcspn(mod, ":)}"), mod, expr->var->name.str);
cleanup:
/*
* TODO: Use p + strlen(p) instead, to stop parsing immediately.
*
* In the unit tests, this generates a few unterminated strings in the
* shell commands though. Instead of producing these unfinished
* strings, commands with evaluation errors should not be run at all.
*
* To make that happen, Var_Subst must report the actual errors
* instead of returning VPR_OK unconditionally.
*/
*pp = p;
Expr_SetValueRefer(expr, var_Error);
}
/*
* Only four of the local variables are treated specially as they are the
* only four that will be set when dynamic sources are expanded.
*/
static Boolean
VarnameIsDynamic(const char *name, size_t len)
{
if (len == 1 || (len == 2 && (name[1] == 'F' || name[1] == 'D'))) {
switch (name[0]) {
case '@':
case '%':
case '*':
case '!':
return TRUE;
}
return FALSE;
}
if ((len == 7 || len == 8) && name[0] == '.' && ch_isupper(name[1])) {
return strcmp(name, ".TARGET") == 0 ||
strcmp(name, ".ARCHIVE") == 0 ||
strcmp(name, ".PREFIX") == 0 ||
strcmp(name, ".MEMBER") == 0;
}
return FALSE;
}
static const char *
UndefinedShortVarValue(char varname, const GNode *scope)
{
if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL) {
/*
* If substituting a local variable in a non-local scope,
* assume it's for dynamic source stuff. We have to handle
* this specially and return the longhand for the variable
* with the dollar sign escaped so it makes it back to the
* caller. Only four of the local variables are treated
* specially as they are the only four that will be set
* when dynamic sources are expanded.
*/
switch (varname) {
case '@':
return "$(.TARGET)";
case '%':
return "$(.MEMBER)";
case '*':
return "$(.PREFIX)";
case '!':
return "$(.ARCHIVE)";
}
}
return NULL;
}
/*
* Parse a variable name, until the end character or a colon, whichever
* comes first.
*/
static char *
ParseVarname(const char **pp, char startc, char endc,
GNode *scope, VarEvalFlags eflags,
size_t *out_varname_len)
{
Buffer buf;
const char *p = *pp;
int depth = 0; /* Track depth so we can spot parse errors. */
Buf_Init(&buf);
while (*p != '\0') {
if ((*p == endc || *p == ':') && depth == 0)
break;
if (*p == startc)
depth++;
if (*p == endc)
depth--;
/* A variable inside a variable, expand. */
if (*p == '$') {
FStr nested_val;
(void)Var_Parse(&p, scope, eflags, &nested_val);
/* TODO: handle errors */
Buf_AddStr(&buf, nested_val.str);
FStr_Done(&nested_val);
} else {
Buf_AddByte(&buf, *p);
p++;
}
}
*pp = p;
*out_varname_len = buf.len;
return Buf_DoneData(&buf);
}
static VarParseResult
ValidShortVarname(char varname, const char *start)
{
if (varname != '$' && varname != ':' && varname != '}' &&
varname != ')' && varname != '\0')
return VPR_OK;
if (!opts.strict)
return VPR_ERR; /* XXX: Missing error message */
if (varname == '$')
Parse_Error(PARSE_FATAL,
"To escape a dollar, use \\$, not $$, at \"%s\"", start);
else if (varname == '\0')
Parse_Error(PARSE_FATAL, "Dollar followed by nothing");
else
Parse_Error(PARSE_FATAL,
"Invalid variable name '%c', at \"%s\"", varname, start);
return VPR_ERR;
}
/*
* Parse a single-character variable name such as in $V or $@.
* Return whether to continue parsing.
*/
static Boolean
ParseVarnameShort(char varname, const char **pp, GNode *scope,
VarEvalFlags eflags,
VarParseResult *out_FALSE_res, const char **out_FALSE_val,
Var **out_TRUE_var)
{
char name[2];
Var *v;
VarParseResult vpr;
vpr = ValidShortVarname(varname, *pp);
if (vpr != VPR_OK) {
(*pp)++;
*out_FALSE_res = vpr;
*out_FALSE_val = var_Error;
return FALSE;
}
name[0] = varname;
name[1] = '\0';
v = VarFind(name, scope, TRUE);
if (v == NULL) {
const char *val;
*pp += 2;
val = UndefinedShortVarValue(varname, scope);
if (val == NULL)
val = eflags.undefErr ? var_Error : varUndefined;
if (opts.strict && val == var_Error) {
Parse_Error(PARSE_FATAL,
"Variable \"%s\" is undefined", name);
*out_FALSE_res = VPR_ERR;
*out_FALSE_val = val;
return FALSE;
}
/*
* XXX: This looks completely wrong.
*
* If undefined expressions are not allowed, this should
* rather be VPR_ERR instead of VPR_UNDEF, together with an
* error message.
*
* If undefined expressions are allowed, this should rather
* be VPR_UNDEF instead of VPR_OK.
*/
*out_FALSE_res = eflags.undefErr ? VPR_UNDEF : VPR_OK;
*out_FALSE_val = val;
return FALSE;
}
*out_TRUE_var = v;
return TRUE;
}
/* Find variables like @F or <D. */
static Var *
FindLocalLegacyVar(const char *varname, size_t namelen, GNode *scope,
const char **out_extraModifiers)
{
/* Only resolve these variables if scope is a "real" target. */
if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL)
return NULL;
if (namelen != 2)
return NULL;
if (varname[1] != 'F' && varname[1] != 'D')
return NULL;
if (strchr("@%?*!<>", varname[0]) == NULL)
return NULL;
{
char name[] = { varname[0], '\0' };
Var *v = VarFind(name, scope, FALSE);
if (v != NULL) {
if (varname[1] == 'D') {
*out_extraModifiers = "H:";
} else { /* F */
*out_extraModifiers = "T:";
}
}
return v;
}
}
static VarParseResult
EvalUndefined(Boolean dynamic, const char *start, const char *p, char *varname,
VarEvalFlags eflags,
FStr *out_val)
{
if (dynamic) {
*out_val = FStr_InitOwn(bmake_strsedup(start, p));
free(varname);
return VPR_OK;
}
if (eflags.undefErr && opts.strict) {
Parse_Error(PARSE_FATAL,
"Variable \"%s\" is undefined", varname);
free(varname);
*out_val = FStr_InitRefer(var_Error);
return VPR_ERR;
}
if (eflags.undefErr) {
free(varname);
*out_val = FStr_InitRefer(var_Error);
return VPR_UNDEF; /* XXX: Should be VPR_ERR instead. */
}
free(varname);
*out_val = FStr_InitRefer(varUndefined);
return VPR_OK;
}
/*
* Parse a long variable name enclosed in braces or parentheses such as $(VAR)
* or ${VAR}, up to the closing brace or parenthesis, or in the case of
* ${VAR:Modifiers}, up to the ':' that starts the modifiers.
* Return whether to continue parsing.
*/
static Boolean
ParseVarnameLong(
const char *p,
char startc,
GNode *scope,
VarEvalFlags eflags,
const char **out_FALSE_pp,
VarParseResult *out_FALSE_res,
FStr *out_FALSE_val,
char *out_TRUE_endc,
const char **out_TRUE_p,
Var **out_TRUE_v,
Boolean *out_TRUE_haveModifier,
const char **out_TRUE_extraModifiers,
Boolean *out_TRUE_dynamic,
ExprDefined *out_TRUE_exprDefined
)
{
size_t namelen;
char *varname;
Var *v;
Boolean haveModifier;
Boolean dynamic = FALSE;
const char *const start = p;
char endc = startc == '(' ? ')' : '}';
p += 2; /* skip "${" or "$(" or "y(" */
varname = ParseVarname(&p, startc, endc, scope, eflags, &namelen);
if (*p == ':') {
haveModifier = TRUE;
} else if (*p == endc) {
haveModifier = FALSE;
} else {
Parse_Error(PARSE_FATAL, "Unclosed variable \"%s\"", varname);
free(varname);
*out_FALSE_pp = p;
*out_FALSE_val = FStr_InitRefer(var_Error);
*out_FALSE_res = VPR_ERR;
return FALSE;
}
v = VarFind(varname, scope, TRUE);
/* At this point, p points just after the variable name,
* either at ':' or at endc. */
if (v == NULL) {
v = FindLocalLegacyVar(varname, namelen, scope,
out_TRUE_extraModifiers);
}
if (v == NULL) {
/*
* Defer expansion of dynamic variables if they appear in
* non-local scope since they are not defined there.
*/
dynamic = VarnameIsDynamic(varname, namelen) &&
(scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL);
if (!haveModifier) {
p++; /* skip endc */
*out_FALSE_pp = p;
*out_FALSE_res = EvalUndefined(dynamic, start, p,
varname, eflags, out_FALSE_val);
return FALSE;
}
/*
* The variable expression is based on an undefined variable.
* Nevertheless it needs a Var, for modifiers that access the
* variable name, such as :L or :?.
*
* Most modifiers leave this expression in the "undefined"
* state (VES_UNDEF), only a few modifiers like :D, :U, :L,
* :P turn this undefined expression into a defined
* expression (VES_DEF).
*
* In the end, after applying all modifiers, if the expression
* is still undefined, Var_Parse will return an empty string
* instead of the actually computed value.
*/
v = VarNew(FStr_InitOwn(varname), "", VFL_NONE);
*out_TRUE_exprDefined = DEF_UNDEF;
} else
free(varname);
*out_TRUE_endc = endc;
*out_TRUE_p = p;
*out_TRUE_v = v;
*out_TRUE_haveModifier = haveModifier;
*out_TRUE_dynamic = dynamic;
return TRUE;
}
/* Free the environment variable now since we own it. */
static void
FreeEnvVar(Var *v, FStr *inout_val)
{
char *varValue = Buf_DoneData(&v->val);
if (inout_val->str == varValue)
inout_val->freeIt = varValue;
else
free(varValue);
FStr_Done(&v->name);
free(v);
}
/*
* Given the start of a variable expression (such as $v, $(VAR),
* ${VAR:Mpattern}), extract the variable name and value, and the modifiers,
* if any. While doing that, apply the modifiers to the value of the
* expression, forming its final value. A few of the modifiers such as :!cmd!
* or ::= have side effects.
*
* Input:
* *pp The string to parse.
* When parsing a condition in ParseEmptyArg, it may also
* point to the "y" of "empty(VARNAME:Modifiers)", which
* is syntactically the same.
* scope The scope for finding variables
* eflags Control the exact details of parsing
*
* Output:
* *pp The position where to continue parsing.
* TODO: After a parse error, the value of *pp is
* unspecified. It may not have been updated at all,
* point to some random character in the string, to the
* location of the parse error, or at the end of the
* string.
* *out_val The value of the variable expression, never NULL.
* *out_val var_Error if there was a parse error.
* *out_val var_Error if the base variable of the expression was
* undefined, eflags has undefErr set, and none of
* the modifiers turned the undefined expression into a
* defined expression.
* XXX: It is not guaranteed that an error message has
* been printed.
* *out_val varUndefined if the base variable of the expression
* was undefined, eflags did not have undefErr set,
* and none of the modifiers turned the undefined
* expression into a defined expression.
* XXX: It is not guaranteed that an error message has
* been printed.
*/
VarParseResult
Var_Parse(const char **pp, GNode *scope, VarEvalFlags eflags, FStr *out_val)
{
const char *p = *pp;
const char *const start = p;
/* TRUE if have modifiers for the variable. */
Boolean haveModifier;
/* Starting character if variable in parens or braces. */
char startc;
/* Ending character if variable in parens or braces. */
char endc;
/*
* TRUE if the variable is local and we're expanding it in a
* non-local scope. This is done to support dynamic sources.
* The result is just the expression, unaltered.
*/
Boolean dynamic;
const char *extramodifiers;
Var *v;
Expr expr = {
NULL,
#if defined(lint)
/* NetBSD lint cannot fully parse C99 struct initializers. */
{ NULL, NULL },
#else
FStr_InitRefer(NULL),
#endif
eflags,
scope,
DEF_REGULAR
};
DEBUG2(VAR, "Var_Parse: %s (%s)\n", start,
VarEvalFlags_ToString(eflags));
*out_val = FStr_InitRefer(NULL);
extramodifiers = NULL; /* extra modifiers to apply first */
dynamic = FALSE;
/*
* Appease GCC, which thinks that the variable might not be
* initialized.
*/
endc = '\0';
startc = p[1];
if (startc != '(' && startc != '{') {
VarParseResult res;
if (!ParseVarnameShort(startc, pp, scope, eflags, &res,
&out_val->str, &expr.var))
return res;
haveModifier = FALSE;
p++;
} else {
VarParseResult res;
if (!ParseVarnameLong(p, startc, scope, eflags,
pp, &res, out_val,
&endc, &p, &expr.var, &haveModifier, &extramodifiers,
&dynamic, &expr.defined))
return res;
}
v = expr.var;
if (v->flags & VFL_IN_USE)
Fatal("Variable %s is recursive.", v->name.str);
/*
* XXX: This assignment creates an alias to the current value of the
* variable. This means that as long as the value of the expression
* stays the same, the value of the variable must not change.
* Using the '::=' modifier, it could be possible to do exactly this.
* At the bottom of this function, the resulting value is compared to
* the then-current value of the variable. This might also invoke
* undefined behavior.
*/
expr.value = FStr_InitRefer(v->val.data);
/*
* Before applying any modifiers, expand any nested expressions from
* the variable value.
*/
if (strchr(expr.value.str, '$') != NULL && eflags.wantRes) {
char *expanded;
VarEvalFlags nested_eflags = eflags;
if (opts.strict)
nested_eflags.undefErr = FALSE;
v->flags |= VFL_IN_USE;
(void)Var_Subst(expr.value.str, scope, nested_eflags,
&expanded);
v->flags &= ~(unsigned)VFL_IN_USE;
/* TODO: handle errors */
Expr_SetValueOwn(&expr, expanded);
}
if (extramodifiers != NULL) {
const char *em = extramodifiers;
ApplyModifiers(&expr, &em, '\0', '\0');
}
if (haveModifier) {
p++; /* Skip initial colon. */
ApplyModifiers(&expr, &p, startc, endc);
}
if (*p != '\0') /* Skip past endc if possible. */
p++;
*pp = p;
if (v->flags & VFL_FROM_ENV) {
FreeEnvVar(v, &expr.value);
} else if (expr.defined != DEF_REGULAR) {
if (expr.defined == DEF_UNDEF) {
if (dynamic) {
Expr_SetValueOwn(&expr,
bmake_strsedup(start, p));
} else {
/*
* The expression is still undefined,
* therefore discard the actual value and
* return an error marker instead.
*/
Expr_SetValueRefer(&expr,
eflags.undefErr
? var_Error : varUndefined);
}
}
/* XXX: This is not standard memory management. */
if (expr.value.str != v->val.data)
Buf_Done(&v->val);
FStr_Done(&v->name);
free(v);
}
*out_val = expr.value;
return VPR_OK; /* XXX: Is not correct in all cases */
}
static void
VarSubstDollarDollar(const char **pp, Buffer *res, VarEvalFlags eflags)
{
/* A dollar sign may be escaped with another dollar sign. */
if (save_dollars && eflags.keepDollar)
Buf_AddByte(res, '$');
Buf_AddByte(res, '$');
*pp += 2;
}
static void
VarSubstExpr(const char **pp, Buffer *buf, GNode *scope,
VarEvalFlags eflags, Boolean *inout_errorReported)
{
const char *p = *pp;
const char *nested_p = p;
FStr val;
(void)Var_Parse(&nested_p, scope, eflags, &val);
/* TODO: handle errors */
if (val.str == var_Error || val.str == varUndefined) {
if (!eflags.keepUndef) {
p = nested_p;
} else if (eflags.undefErr || val.str == var_Error) {
/*
* XXX: This condition is wrong. If val == var_Error,
* this doesn't necessarily mean there was an undefined
* variable. It could equally well be a parse error;
* see unit-tests/varmod-order.exp.
*/
/*
* If variable is undefined, complain and skip the
* variable. The complaint will stop us from doing
* anything when the file is parsed.
*/
if (!*inout_errorReported) {
Parse_Error(PARSE_FATAL,
"Undefined variable \"%.*s\"",
(int)(size_t)(nested_p - p), p);
}
p = nested_p;
*inout_errorReported = TRUE;
} else {
/* Copy the initial '$' of the undefined expression,
* thereby deferring expansion of the expression, but
* expand nested expressions if already possible.
* See unit-tests/varparse-undef-partial.mk. */
Buf_AddByte(buf, *p);
p++;
}
} else {
p = nested_p;
Buf_AddStr(buf, val.str);
}
FStr_Done(&val);
*pp = p;
}
/*
* Skip as many characters as possible -- either to the end of the string
* or to the next dollar sign (variable expression).
*/
static void
VarSubstPlain(const char **pp, Buffer *res)
{
const char *p = *pp;
const char *start = p;
for (p++; *p != '$' && *p != '\0'; p++)
continue;
Buf_AddBytesBetween(res, start, p);
*pp = p;
}
/*
* Expand all variable expressions like $V, ${VAR}, $(VAR:Modifiers) in the
* given string.
*
* Input:
* str The string in which the variable expressions are
* expanded.
* scope The scope in which to start searching for
* variables. The other scopes are searched as well.
* eflags Special effects during expansion.
*/
VarParseResult
Var_Subst(const char *str, GNode *scope, VarEvalFlags eflags, char **out_res)
{
const char *p = str;
Buffer res;
/* Set true if an error has already been reported,
* to prevent a plethora of messages when recursing */
/* XXX: Why is the 'static' necessary here? */
static Boolean errorReported;
Buf_Init(&res);
errorReported = FALSE;
while (*p != '\0') {
if (p[0] == '$' && p[1] == '$')
VarSubstDollarDollar(&p, &res, eflags);
else if (p[0] == '$')
VarSubstExpr(&p, &res, scope, eflags, &errorReported);
else
VarSubstPlain(&p, &res);
}
*out_res = Buf_DoneDataCompact(&res);
return VPR_OK;
}
/* Initialize the variables module. */
void
Var_Init(void)
{
SCOPE_INTERNAL = GNode_New("Internal");
SCOPE_GLOBAL = GNode_New("Global");
SCOPE_CMDLINE = GNode_New("Command");
}
/* Clean up the variables module. */
void
Var_End(void)
{
Var_Stats();
}
void
Var_Stats(void)
{
HashTable_DebugStats(&SCOPE_GLOBAL->vars, "Global variables");
}
/* Print all variables in a scope, sorted by name. */
void
Var_Dump(GNode *scope)
{
Vector /* of const char * */ vec;
HashIter hi;
size_t i;
const char **varnames;
Vector_Init(&vec, sizeof(const char *));
HashIter_Init(&hi, &scope->vars);
while (HashIter_Next(&hi) != NULL)
*(const char **)Vector_Push(&vec) = hi.entry->key;
varnames = vec.items;
qsort(varnames, vec.len, sizeof varnames[0], str_cmp_asc);
for (i = 0; i < vec.len; i++) {
const char *varname = varnames[i];
Var *var = HashTable_FindValue(&scope->vars, varname);
debug_printf("%-16s = %s\n", varname, var->val.data);
}
Vector_Done(&vec);
}