xref: /src/usr.bin/make/suff.c

/*	$NetBSD: suff.c,v 1.287 2020/11/22 10:22:23 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.
 */

/*
 * Maintain suffix lists and find implicit dependents using suffix
 * transformation rules such as ".c.o".
 *
 * Interface:
 *	Suff_Init	Initialize the module.
 *
 *	Suff_End	Clean up the module.
 *
 *	Suff_DoPaths	Extend the search path of each suffix to include the
 *			default search path.
 *
 *	Suff_ClearSuffixes
 *			Clear out all the suffixes and transformations.
 *
 *	Suff_IsTransform
 *			See if the passed string is a transformation rule.
 *
 *	Suff_AddSuffix	Add the passed string as another known suffix.
 *
 *	Suff_GetPath	Return the search path for the given suffix.
 *
 *	Suff_AddInclude
 *			Mark the given suffix as denoting an include file.
 *
 *	Suff_AddLib	Mark the given suffix as denoting a library.
 *
 *	Suff_AddTransform
 *			Add another transformation to the suffix graph.
 *
 *	Suff_SetNull	Define the suffix to consider the suffix of
 *			any file that doesn't have a known one.
 *
 *	Suff_FindDeps	Find implicit sources for and the location of
 *			a target based on its suffix. Returns the
 *			bottom-most node added to the graph or NULL
 *			if the target had no implicit sources.
 *
 *	Suff_FindPath	Return the appropriate path to search in order to
 *			find the node.
 */

#include "make.h"
#include "dir.h"

/*	"@(#)suff.c	8.4 (Berkeley) 3/21/94"	*/
MAKE_RCSID("$NetBSD: suff.c,v 1.287 2020/11/22 10:22:23 rillig Exp $");

#define SUFF_DEBUG0(text) DEBUG0(SUFF, text)
#define SUFF_DEBUG1(fmt, arg1) DEBUG1(SUFF, fmt, arg1)
#define SUFF_DEBUG2(fmt, arg1, arg2) DEBUG2(SUFF, fmt, arg1, arg2)

typedef List SuffixList;
typedef ListNode SuffixListNode;

typedef List CandidateList;
typedef ListNode CandidateListNode;

static SuffixList *sufflist;	/* List of suffixes */
#ifdef CLEANUP
static SuffixList *suffClean;	/* List of suffixes to be cleaned */
#endif

/* List of transformation rules, such as ".c.o" */
static GNodeList *transforms;

static int sNum = 0;		/* Counter for assigning suffix numbers */

typedef enum SuffixFlags {
    SUFF_INCLUDE	= 0x01,	/* One which is #include'd */
    SUFF_LIBRARY	= 0x02,	/* One which contains a library */
    SUFF_NULL		= 0x04	/* The empty suffix */
    /* XXX: Why is SUFF_NULL needed? Wouldn't nameLen == 0 mean the same? */
} SuffixFlags;

ENUM_FLAGS_RTTI_3(SuffixFlags,
		  SUFF_INCLUDE, SUFF_LIBRARY, SUFF_NULL);

typedef List SuffixListList;

/*
 * A suffix such as ".c" or ".o" that is used in suffix transformation rules
 * such as ".c.o:".
 */
typedef struct Suffix {
    /* The suffix itself, such as ".c" */
    char *name;
    /* Length of the name, to avoid strlen calls */
    size_t nameLen;
    /* Type of suffix */
    SuffixFlags flags;
    /* The path along which files of this suffix may be found */
    SearchPath *searchPath;
    /* The suffix number; TODO: document the purpose of this number */
    int sNum;
    /* Reference count of list membership and several other places */
    int refCount;
    /* Suffixes we have a transformation to */
    SuffixList *parents;
    /* Suffixes we have a transformation from */
    SuffixList *children;

    /* Lists in which this suffix is referenced.
     * XXX: These lists are used nowhere, they are just appended to, for no
     * apparent reason.  They do have the side effect of increasing refCount
     * though. */
    SuffixListList *ref;
} Suffix;

/*
 * A candidate when searching for implied sources.
 *
 * For example, when "src.o" is to be made, a typical candidate is "src.c"
 * via the transformation rule ".c.o".  If that doesn't exist, maybe there is
 * another transformation rule ".pas.c" that would make "src.pas" an indirect
 * candidate as well.  The first such chain that leads to an existing file or
 * node is finally chosen to be made.
 */
typedef struct Candidate {
    char *file;			/* The file to look for */
    char *pref;			/* Prefix from which file was formed */
    Suffix *suff;		/* The suffix on the file */
    struct Candidate *parent;	/* The candidate for which this is a source */
    GNode *node;		/* The node describing the file */
    int numChildren;		/* Count of existing children (so we don't free
				 * this thing too early or never nuke it) */
#ifdef DEBUG_SRC
    CandidateList *childrenList;
#endif
} Candidate;


/* TODO: Document the difference between nullSuff and emptySuff. */
/* The NULL suffix for this run */
static Suffix *nullSuff;
/* The empty suffix required for POSIX single-suffix transformation rules */
static Suffix *emptySuff;


static Suffix *
Suffix_Ref(Suffix *suff)
{
    suff->refCount++;
    return suff;
}

/* Change the value of a Suffix variable, adjusting the reference counts. */
static void
Suffix_Reassign(Suffix **var, Suffix *suff)
{
    if (*var != NULL)
	(*var)->refCount--;
    *var = suff;
    suff->refCount++;
}

/* Set a Suffix variable to NULL, adjusting the reference count. */
static void
Suffix_Unassign(Suffix **var)
{
    if (*var != NULL)
	(*var)->refCount--;
    *var = NULL;
}

/*
 * See if pref is a prefix of str.
 * Return NULL if it ain't, pointer to character in str after prefix if so.
 */
static const char *
StrIsPrefix(const char *pref, const char *str)
{
    while (*str && *pref == *str) {
	pref++;
	str++;
    }

    return *pref != '\0' ? NULL : str;
}

/*
 * See if suff is a suffix of name, and if so, return a pointer to the suffix
 * in the given name, thereby marking the point where the prefix ends.
 */
static const char *
Suffix_GetSuffix(const Suffix *suff, size_t nameLen, const char *nameEnd)
{
    size_t suffLen = suff->nameLen;
    const char *suffInName;

    if (nameLen < suffLen)
	return NULL;

    suffInName = nameEnd - suffLen;
    for (size_t i = 0; i < suffLen; i++) {
	if (suff->name[i] != suffInName[i])
	    return NULL;
    }
    return suffInName;
}

static Boolean
Suffix_IsSuffix(const Suffix *suff, size_t nameLen, const char *nameEnd)
{
    return Suffix_GetSuffix(suff, nameLen, nameEnd) != NULL;
}

static Suffix *
FindSuffixByNameLen(const char *name, size_t nameLen)
{
    SuffixListNode *ln;

    for (ln = sufflist->first; ln != NULL; ln = ln->next) {
	Suffix *suff = ln->datum;
	if (suff->nameLen == nameLen && memcmp(suff->name, name, nameLen) == 0)
	    return suff;
    }
    return NULL;
}

static Suffix *
FindSuffixByName(const char *name)
{
    return FindSuffixByNameLen(name, strlen(name));
}

static GNode *
FindTransformByName(const char *name)
{
    GNodeListNode *ln;
    for (ln = transforms->first; ln != NULL; ln = ln->next) {
	GNode *gn = ln->datum;
	if (strcmp(gn->name, name) == 0)
	    return gn;
    }
    return NULL;
}

static void
SuffixList_Unref(SuffixList *list, Suffix *suff)
{
    SuffixListNode *ln = Lst_FindDatum(list, suff);
    if (ln != NULL) {
	Lst_Remove(list, ln);
	suff->refCount--;
    }
}

/* Free up all memory associated with the given suffix structure. */
static void
Suffix_Free(Suffix *suff)
{

    if (suff == nullSuff)
	nullSuff = NULL;

    if (suff == emptySuff)
	emptySuff = NULL;

#if 0
    /* We don't delete suffixes in order, so we cannot use this */
    if (suff->refCount != 0)
	Punt("Internal error deleting suffix `%s' with refcount = %d",
	     suff->name, suff->refCount);
#endif

    Lst_Free(suff->ref);
    Lst_Free(suff->children);
    Lst_Free(suff->parents);
    Lst_Destroy(suff->searchPath, Dir_Destroy);

    free(suff->name);
    free(suff);
}

static void
SuffFree(void *p)
{
    Suffix_Free(p);
}

/* Remove the suffix from the list, and free if it is otherwise unused. */
static void
SuffixList_Remove(SuffixList *list, Suffix *suff)
{
    SuffixList_Unref(list, suff);
    if (suff->refCount == 0) {
	/* XXX: can lead to suff->refCount == -1 */
	SuffixList_Unref(sufflist, suff);
	DEBUG1(SUFF, "Removing suffix \"%s\"\n", suff->name);
	SuffFree(suff);
    }
}

/* Insert the suffix into the list, keeping the list ordered by suffix
 * number. */
static void
SuffixList_Insert(SuffixList *list, Suffix *suff)
{
    SuffixListNode *ln;
    Suffix *listSuff = NULL;

    for (ln = list->first; ln != NULL; ln = ln->next) {
	listSuff = ln->datum;
	if (listSuff->sNum >= suff->sNum)
	    break;
    }

    if (ln == NULL) {
	SUFF_DEBUG2("inserting \"%s\" (%d) at end of list\n",
		    suff->name, suff->sNum);
	Lst_Append(list, Suffix_Ref(suff));
	Lst_Append(suff->ref, list);
    } else if (listSuff->sNum != suff->sNum) {
	DEBUG4(SUFF, "inserting \"%s\" (%d) before \"%s\" (%d)\n",
	       suff->name, suff->sNum, listSuff->name, listSuff->sNum);
	Lst_InsertBefore(list, ln, Suffix_Ref(suff));
	Lst_Append(suff->ref, list);
    } else {
	SUFF_DEBUG2("\"%s\" (%d) is already there\n", suff->name, suff->sNum);
    }
}

static void
Relate(Suffix *srcSuff, Suffix *targSuff)
{
    SuffixList_Insert(targSuff->children, srcSuff);
    SuffixList_Insert(srcSuff->parents, targSuff);
}

static Suffix *
Suffix_New(const char *name)
{
    Suffix *suff = bmake_malloc(sizeof *suff);

    suff->name = bmake_strdup(name);
    suff->nameLen = strlen(suff->name);
    suff->searchPath = Lst_New();
    suff->children = Lst_New();
    suff->parents = Lst_New();
    suff->ref = Lst_New();
    suff->sNum = sNum++;
    suff->flags = 0;
    suff->refCount = 1; /* XXX: why 1? It's not assigned anywhere yet. */

    return suff;
}

/*
 * Nuke the list of suffixes but keep all transformation rules around. The
 * transformation graph is destroyed in this process, but we leave the list
 * of rules so when a new graph is formed, the rules will remain. This
 * function is called when a line '.SUFFIXES:' with an empty suffixes list is
 * encountered in a makefile.
 */
void
Suff_ClearSuffixes(void)
{
#ifdef CLEANUP
    Lst_MoveAll(suffClean, sufflist);
#endif
    DEBUG0(SUFF, "Clearing all suffixes\n");
    sufflist = Lst_New();
    sNum = 0;
    if (nullSuff != NULL)
	SuffFree(nullSuff);
    emptySuff = nullSuff = Suffix_New("");

    Dir_Concat(nullSuff->searchPath, dirSearchPath);
    nullSuff->flags = SUFF_NULL;
}

/* Parse a transformation string such as ".c.o" to find its two component
 * suffixes (the source ".c" and the target ".o").  If there are no such
 * suffixes, try a single-suffix transformation as well.
 *
 * Return TRUE if the string is a valid transformation.
 */
static Boolean
ParseTransform(const char *str, Suffix **out_src, Suffix **out_targ)
{
    SuffixListNode *ln;
    Suffix *singleSrc = NULL;

    /*
     * Loop looking first for a suffix that matches the start of the
     * string and then for one that exactly matches the rest of it. If
     * we can find two that meet these criteria, we've successfully
     * parsed the string.
     */
    for (ln = sufflist->first; ln != NULL; ln = ln->next) {
	Suffix *src = ln->datum;

	if (StrIsPrefix(src->name, str) == NULL)
	    continue;

	if (str[src->nameLen] == '\0') {
	    singleSrc = src;
	} else {
	    Suffix *targ = FindSuffixByName(str + src->nameLen);
	    if (targ != NULL) {
		*out_src = src;
		*out_targ = targ;
		return TRUE;
	    }
	}
    }

    if (singleSrc != NULL) {
	/*
	 * There was a suffix that encompassed the entire string, so we
	 * assume it was a transformation to the null suffix (thank you
	 * POSIX; search for "single suffix" or "single-suffix").
	 *
	 * We still prefer to find a double rule over a singleton,
	 * hence we leave this check until the end.
	 *
	 * XXX: Use emptySuff over nullSuff?
	 */
	*out_src = singleSrc;
	*out_targ = nullSuff;
	return TRUE;
    }
    return FALSE;
}

/* Return TRUE if the given string is a transformation rule, that is, a
 * concatenation of two known suffixes such as ".c.o" or a single suffix
 * such as ".o". */
Boolean
Suff_IsTransform(const char *str)
{
    Suffix *src, *targ;

    return ParseTransform(str, &src, &targ);
}

/* Add the transformation rule to the list of rules and place the
 * transformation itself in the graph.
 *
 * The transformation is linked to the two suffixes mentioned in the name.
 *
 * Input:
 *	name		must have the form ".from.to" or just ".from"
 *
 * Results:
 *	The created or existing transformation node in the transforms list
 */
GNode *
Suff_AddTransform(const char *name)
{
    Suffix *srcSuff;
    Suffix *targSuff;

    GNode *gn = FindTransformByName(name);
    if (gn == NULL) {
	/*
	 * Make a new graph node for the transformation. It will be filled in
	 * by the Parse module.
	 */
	gn = GNode_New(name);
	Lst_Append(transforms, gn);
    } else {
	/*
	 * New specification for transformation rule. Just nuke the old list
	 * of commands so they can be filled in again... We don't actually
	 * free the commands themselves, because a given command can be
	 * attached to several different transformations.
	 */
	Lst_Free(gn->commands);
	Lst_Free(gn->children);
	gn->commands = Lst_New();
	gn->children = Lst_New();
    }

    gn->type = OP_TRANSFORM;

    {
	Boolean ok = ParseTransform(name, &srcSuff, &targSuff);
	assert(ok);
	(void)ok;
    }

    /*
     * link the two together in the proper relationship and order
     */
    SUFF_DEBUG2("defining transformation from `%s' to `%s'\n",
		srcSuff->name, targSuff->name);
    Relate(srcSuff, targSuff);

    return gn;
}

/* Handle the finish of a transformation definition, removing the
 * transformation from the graph if it has neither commands nor sources.
 *
 * If the node has no commands or children, the children and parents lists
 * of the affected suffixes are altered.
 *
 * Input:
 *	gn		Node for transformation
 */
void
Suff_EndTransform(GNode *gn)
{
    Suffix *srcSuff, *targSuff;
    SuffixList *srcSuffParents;

    if ((gn->type & OP_DOUBLEDEP) && !Lst_IsEmpty(gn->cohorts))
	gn = gn->cohorts->last->datum;

    if (!(gn->type & OP_TRANSFORM))
	return;

    if (!Lst_IsEmpty(gn->commands) || !Lst_IsEmpty(gn->children)) {
	SUFF_DEBUG1("transformation %s complete\n", gn->name);
	return;
    }

    /*
     * SuffParseTransform() may fail for special rules which are not
     * actual transformation rules. (e.g. .DEFAULT)
     */
    if (!ParseTransform(gn->name, &srcSuff, &targSuff))
	return;

    SUFF_DEBUG2("deleting incomplete transformation from `%s' to `%s'\n",
		srcSuff->name, targSuff->name);

    /* Remember parents since srcSuff could be deleted in SuffixList_Remove. */
    srcSuffParents = srcSuff->parents;
    SuffixList_Remove(targSuff->children, srcSuff);
    SuffixList_Remove(srcSuffParents, targSuff);
}

/* Called from Suff_AddSuffix to search through the list of
 * existing transformation rules and rebuild the transformation graph when
 * it has been destroyed by Suff_ClearSuffixes. If the given rule is a
 * transformation involving this suffix and another, existing suffix, the
 * proper relationship is established between the two.
 *
 * The appropriate links will be made between this suffix and others if
 * transformation rules exist for it.
 *
 * Input:
 *	transform	Transformation to test
 *	suff		Suffix to rebuild
 */
static void
RebuildGraph(GNode *transform, Suffix *suff)
{
    const char *name = transform->name;
    size_t nameLen = strlen(name);
    const char *toName;

    /*
     * First see if it is a transformation from this suffix.
     */
    toName = StrIsPrefix(suff->name, name);
    if (toName != NULL) {
	Suffix *to = FindSuffixByName(toName);
	if (to != NULL) {
	    /* Link in and return, since it can't be anything else. */
	    Relate(suff, to);
	    return;
	}
    }

    /*
     * Not from, maybe to?
     */
    toName = Suffix_GetSuffix(suff, nameLen, name + nameLen);
    if (toName != NULL) {
	Suffix *from = FindSuffixByNameLen(name, (size_t)(toName - name));
	if (from != NULL)
	    Relate(from, suff);
    }
}

/* During Suff_AddSuffix, search through the list of existing targets and find
 * if any of the existing targets can be turned into a transformation rule.
 *
 * If such a target is found and the target is the current main target, the
 * main target is set to NULL and the next target examined (if that exists)
 * becomes the main target.
 *
 * Results:
 *	TRUE iff a new main target has been selected.
 */
static Boolean
UpdateTarget(GNode *target, GNode **inout_main, Suffix *suff,
		 Boolean *inout_removedMain)
{
    Suffix *srcSuff, *targSuff;
    char *ptr;

    if (*inout_main == NULL && *inout_removedMain &&
	!(target->type & OP_NOTARGET)) {
	*inout_main = target;
	Targ_SetMain(target);
	/*
	 * XXX: Why could it be a good idea to return TRUE here?
	 * The main task of this function is to turn ordinary nodes into
	 * transformations, no matter whether or not a new .MAIN node
	 * has been found.
	 */
	return TRUE;
    }

    if (target->type == OP_TRANSFORM)
	return FALSE;

    /*
     * XXX: What about a transformation ".cpp.c"?  If ".c" is added as a new
     * suffix, it seems wrong that this transformation would be skipped just
     * because ".c" happens to be a prefix of ".cpp".
     */
    ptr = strstr(target->name, suff->name);
    if (ptr == NULL)
	return FALSE;

    /*
     * XXX: In suff-rebuild.mk, in the line '.SUFFIXES: .c .b .a', this
     * condition prevents the rule '.b.c' from being added again during
     * Suff_AddSuffix(".b").
     *
     * XXX: Removing this paragraph makes suff-add-later.mk use massive
     * amounts of memory.
     */
    if (ptr == target->name)
	return FALSE;

    if (ParseTransform(target->name, &srcSuff, &targSuff)) {
	if (*inout_main == target) {
	    *inout_removedMain = TRUE;
	    *inout_main = NULL;
	    Targ_SetMain(NULL);
	}
	Lst_Free(target->children);
	target->children = Lst_New();
	target->type = OP_TRANSFORM;
	/*
	 * link the two together in the proper relationship and order
	 */
	SUFF_DEBUG2("defining transformation from `%s' to `%s'\n",
		    srcSuff->name, targSuff->name);
	Relate(srcSuff, targSuff);
    }
    return FALSE;
}

/* Look at all existing targets to see if adding this suffix will make one
 * of the current targets mutate into a suffix rule.
 *
 * This is ugly, but other makes treat all targets that start with a '.' as
 * suffix rules. */
static void
UpdateTargets(GNode **inout_main, Suffix *suff)
{
    Boolean r = FALSE;
    GNodeListNode *ln;
    for (ln = Targ_List()->first; ln != NULL; ln = ln->next) {
	GNode *gn = ln->datum;
	if (UpdateTarget(gn, inout_main, suff, &r))
	    break;
    }
}

/* Add the suffix to the end of the list of known suffixes.
 * Should we restructure the suffix graph? Make doesn't...
 *
 * A GNode is created for the suffix and a Suffix structure is created and
 * added to the suffixes list unless the suffix was already known.
 * The mainNode passed can be modified if a target mutated into a
 * transform and that target happened to be the main target.
 *
 * Input:
 *	name		the name of the suffix to add
 */
void
Suff_AddSuffix(const char *name, GNode **inout_main)
{
    GNodeListNode *ln;

    Suffix *suff = FindSuffixByName(name);
    if (suff != NULL)
	return;

    suff = Suffix_New(name);
    Lst_Append(sufflist, suff);
    DEBUG1(SUFF, "Adding suffix \"%s\"\n", suff->name);

    UpdateTargets(inout_main, suff);

    /*
     * Look for any existing transformations from or to this suffix.
     * XXX: Only do this after a Suff_ClearSuffixes?
     */
    for (ln = transforms->first; ln != NULL; ln = ln->next)
	RebuildGraph(ln->datum, suff);
}

/* Return the search path for the given suffix, or NULL. */
SearchPath *
Suff_GetPath(const char *sname)
{
    Suffix *suff = FindSuffixByName(sname);
    return suff != NULL ? suff->searchPath : NULL;
}

/*
 * Extend the search paths for all suffixes to include the default search
 * path (dirSearchPath).
 *
 * The default search path can be defined using the special target '.PATH'.
 * The search path of each suffix can be defined using the special target
 * '.PATH<suffix>'.
 *
 * If paths were specified for the ".h" suffix, the directories are stuffed
 * into a global variable called ".INCLUDES" with each directory preceded by
 * '-I'. The same is done for the ".a" suffix, except the variable is called
 * ".LIBS" and the flag is '-L'.
 */
void
Suff_DoPaths(void)
{
    SuffixListNode *ln;
    char *ptr;
    SearchPath *inIncludes; /* Cumulative .INCLUDES path */
    SearchPath *inLibs;	    /* Cumulative .LIBS path */

    inIncludes = Lst_New();
    inLibs = Lst_New();

    for (ln = sufflist->first; ln != NULL; ln = ln->next) {
	Suffix *suff = ln->datum;
	if (!Lst_IsEmpty(suff->searchPath)) {
#ifdef INCLUDES
	    if (suff->flags & SUFF_INCLUDE)
		Dir_Concat(inIncludes, suff->searchPath);
#endif
#ifdef LIBRARIES
	    if (suff->flags & SUFF_LIBRARY)
		Dir_Concat(inLibs, suff->searchPath);
#endif
	    Dir_Concat(suff->searchPath, dirSearchPath);
	} else {
	    Lst_Destroy(suff->searchPath, Dir_Destroy);
	    suff->searchPath = Dir_CopyDirSearchPath();
	}
    }

    Var_Set(".INCLUDES", ptr = Dir_MakeFlags("-I", inIncludes), VAR_GLOBAL);
    free(ptr);
    Var_Set(".LIBS", ptr = Dir_MakeFlags("-L", inLibs), VAR_GLOBAL);
    free(ptr);

    Lst_Destroy(inIncludes, Dir_Destroy);
    Lst_Destroy(inLibs, Dir_Destroy);
}

/*
 * Add the given suffix as a type of file which gets included.
 * Called when a '.INCLUDES: .h' line is parsed.
 * To have an effect, the suffix must already exist.
 * This affects the magic variable '.INCLUDES'.
 */
void
Suff_AddInclude(const char *suffName)
{
    Suffix *suff = FindSuffixByName(suffName);
    if (suff != NULL)
	suff->flags |= SUFF_INCLUDE;
}

/*
 * Add the given suffix as a type of file which is a library.
 * Called when a '.LIBS: .a' line is parsed.
 * To have an effect, the suffix must already exist.
 * This affects the magic variable '.LIBS'.
 */
void
Suff_AddLib(const char *suffName)
{
    Suffix *suff = FindSuffixByName(suffName);
    if (suff != NULL)
	suff->flags |= SUFF_LIBRARY;
}

	  /********** Implicit Source Search Functions *********/

#ifdef DEBUG_SRC
static void
CandidateList_PrintAddrs(CandidateList *list)
{
    CandidateListNode *ln;

    for (ln = list->first; ln != NULL; ln = ln->next)
	debug_printf(" %p", ln->datum);
    debug_printf("\n");
}
#endif

static Candidate *
Candidate_New(char *name, char *pref, Suffix *suff, Candidate *parent,
	      GNode *gn)
{
    Candidate *cand = bmake_malloc(sizeof *cand);

    cand->file = name;
    cand->pref = pref;
    cand->suff = Suffix_Ref(suff);
    cand->parent = parent;
    cand->node = gn;
    cand->numChildren = 0;
#ifdef DEBUG_SRC
    cand->childrenList = Lst_New();
#endif

    return cand;
}

/* Add a new candidate to the list. */
static void
CandidateList_Add(CandidateList *list, char *srcName, Candidate *targ,
		  Suffix *suff, const char *debug_tag)
{
    Candidate *cand = Candidate_New(srcName, targ->pref, suff, targ, NULL);
    targ->numChildren++;
    Lst_Append(list, cand);

#ifdef DEBUG_SRC
    Lst_Append(targ->childrenList, cand);
    debug_printf("%s add suff %p candidate %p to list %p:",
		 debug_tag, targ, cand, list);
    CandidateList_PrintAddrs(list);
#endif
}

/* Add all candidates to the list that can be formed by applying a suffix to
 * the candidate. */
static void
CandidateList_AddCandidatesFor(CandidateList *list, Candidate *cand)
{
    SuffixListNode *ln;
    for (ln = cand->suff->children->first; ln != NULL; ln = ln->next) {
	Suffix *suff = ln->datum;

	if ((suff->flags & SUFF_NULL) && suff->name[0] != '\0') {
	    /*
	     * If the suffix has been marked as the NULL suffix, also
	     * create a candidate for a file with no suffix attached.
	     */
	    CandidateList_Add(list, bmake_strdup(cand->pref),
		       cand, suff, "1");
	}

	CandidateList_Add(list, str_concat2(cand->pref, suff->name),
			  cand, suff, "2");
    }
}

/* Free the first candidate in the list that is not referenced anymore.
 * Return whether a candidate was removed. */
static Boolean
RemoveSrc(CandidateList *srcs)
{
    CandidateListNode *ln;

#ifdef DEBUG_SRC
    debug_printf("cleaning list %p:", srcs);
    CandidateList_PrintAddrs(srcs);
#endif

    for (ln = srcs->first; ln != NULL; ln = ln->next) {
	Candidate *src = ln->datum;

	if (src->numChildren == 0) {
	    free(src->file);
	    if (src->parent == NULL)
		free(src->pref);
	    else {
#ifdef DEBUG_SRC
	        /* XXX: Lst_RemoveDatum */
		CandidateListNode *ln2;
		ln2 = Lst_FindDatum(src->parent->childrenList, src);
		if (ln2 != NULL)
		    Lst_Remove(src->parent->childrenList, ln2);
#endif
		src->parent->numChildren--;
	    }
#ifdef DEBUG_SRC
	    debug_printf("free: list %p src %p children %d\n",
			 srcs, src, src->numChildren);
	    Lst_Free(src->childrenList);
#endif
	    Lst_Remove(srcs, ln);
	    free(src);
	    return TRUE;
	}
#ifdef DEBUG_SRC
	else {
	    debug_printf("keep: list %p src %p children %d:",
			 srcs, src, src->numChildren);
	    CandidateList_PrintAddrs(src->childrenList);
	}
#endif
    }

    return FALSE;
}

/* Find the first existing file/target in srcs. */
/* XXX: The parameter names are too similar. */
static Candidate *
FindThem(CandidateList *srcs, CandidateList *slst)
{
    Candidate *retsrc = NULL;

    while (!Lst_IsEmpty(srcs)) {
	Candidate *src = Lst_Dequeue(srcs);

	SUFF_DEBUG1("\ttrying %s...", src->file);

	/*
	 * A file is considered to exist if either a node exists in the
	 * graph for it or the file actually exists.
	 */
	if (Targ_FindNode(src->file) != NULL) {
#ifdef DEBUG_SRC
	    debug_printf("remove from list %p src %p\n", srcs, src);
#endif
	    retsrc = src;
	    break;
	}

	{
	    char *file = Dir_FindFile(src->file, src->suff->searchPath);
	    if (file != NULL) {
		retsrc = src;
#ifdef DEBUG_SRC
		debug_printf("remove from list %p src %p\n", srcs, src);
#endif
		free(file);
		break;
	    }
	}

	SUFF_DEBUG0("not there\n");

	CandidateList_AddCandidatesFor(srcs, src);
	Lst_Append(slst, src);
    }

    if (retsrc) {
	SUFF_DEBUG0("got it\n");
    }
    return retsrc;
}

/*
 * See if any of the children of the candidate's GNode is one from which the
 * target can be transformed. If there is one, a candidate is put together
 * for it and returned.
 */
static Candidate *
FindCmds(Candidate *targ, CandidateList *slst)
{
    GNodeListNode *gln;
    GNode *tgn;			/* Target GNode */
    GNode *sgn;			/* Source GNode */
    size_t prefLen;		/* The length of the defined prefix */
    Suffix *suff;		/* Suffix on matching beastie */
    Candidate *ret;		/* Return value */
    char *cp;

    tgn = targ->node;
    prefLen = strlen(targ->pref);

    for (gln = tgn->children->first; gln != NULL; gln = gln->next) {
	sgn = gln->datum;

	if (sgn->type & OP_OPTIONAL && Lst_IsEmpty(tgn->commands)) {
	    /*
	     * We haven't looked to see if .OPTIONAL files exist yet, so
	     * don't use one as the implicit source.
	     * This allows us to use .OPTIONAL in .depend files so make won't
	     * complain "don't know how to make xxx.h' when a dependent file
	     * has been moved/deleted.
	     */
	    continue;
	}

	cp = strrchr(sgn->name, '/');
	if (cp == NULL) {
	    cp = sgn->name;
	} else {
	    cp++;
	}
	if (strncmp(cp, targ->pref, prefLen) != 0)
	    continue;
	/* The node matches the prefix ok, see if it has a known suffix. */
	suff = FindSuffixByName(cp + prefLen);
	if (suff == NULL)
	    continue;

	/*
	 * It even has a known suffix, see if there's a transformation
	 * defined between the node's suffix and the target's suffix.
	 *
	 * XXX: Handle multi-stage transformations here, too.
	 */

	if (Lst_FindDatum(suff->parents, targ->suff) != NULL)
	    break;
    }

    if (gln == NULL)
	return NULL;

    ret = Candidate_New(bmake_strdup(sgn->name), targ->pref, suff, targ, sgn);
    targ->numChildren++;
#ifdef DEBUG_SRC
    debug_printf("3 add targ %p ret %p\n", targ, ret);
    Lst_Append(targ->childrenList, ret);
#endif
    Lst_Append(slst, ret);
    SUFF_DEBUG1("\tusing existing source %s\n", sgn->name);
    return ret;
}

static void
ExpandWildcards(GNodeListNode *cln, GNode *pgn)
{
    GNode *cgn = cln->datum;
    StringList *expansions;

    if (!Dir_HasWildcards(cgn->name))
	return;

    /*
     * Expand the word along the chosen path
     */
    expansions = Lst_New();
    Dir_Expand(cgn->name, Suff_FindPath(cgn), expansions);

    while (!Lst_IsEmpty(expansions)) {
	GNode	*gn;
	/*
	 * Fetch next expansion off the list and find its GNode
	 */
	char *cp = Lst_Dequeue(expansions);

	SUFF_DEBUG1("%s...", cp);
	gn = Targ_GetNode(cp);

	/* Add gn to the parents child list before the original child */
	Lst_InsertBefore(pgn->children, cln, gn);
	Lst_Append(gn->parents, pgn);
	pgn->unmade++;
    }

    Lst_Free(expansions);

    SUFF_DEBUG0("\n");

    /*
     * Now the source is expanded, remove it from the list of children to
     * keep it from being processed.
     */
    pgn->unmade--;
    Lst_Remove(pgn->children, cln);
    Lst_Remove(cgn->parents, Lst_FindDatum(cgn->parents, pgn));
}

/* Expand the names of any children of a given node that contain variable
 * expressions or file wildcards into actual targets.
 *
 * The expanded node is removed from the parent's list of children, and the
 * parent's unmade counter is decremented, but other nodes may be added.
 *
 * Input:
 *	cln		Child to examine
 *	pgn		Parent node being processed
 */
static void
ExpandChildren(GNodeListNode *cln, GNode *pgn)
{
    GNode *cgn = cln->datum;
    GNode *gn;			/* New source 8) */
    char *cp;			/* Expanded value */

    if (!Lst_IsEmpty(cgn->order_pred) || !Lst_IsEmpty(cgn->order_succ))
	/* It is all too hard to process the result of .ORDER */
	return;

    if (cgn->type & OP_WAIT)
	/* Ignore these (& OP_PHONY ?) */
	return;

    /*
     * First do variable expansion -- this takes precedence over
     * wildcard expansion. If the result contains wildcards, they'll be gotten
     * to later since the resulting words are tacked on to the end of
     * the children list.
     */
    if (strchr(cgn->name, '$') == NULL) {
	ExpandWildcards(cln, pgn);
	return;
    }

    SUFF_DEBUG1("Expanding \"%s\"...", cgn->name);
    (void)Var_Subst(cgn->name, pgn, VARE_WANTRES | VARE_UNDEFERR, &cp);
    /* TODO: handle errors */

    {
	GNodeList *members = Lst_New();

	if (cgn->type & OP_ARCHV) {
	    /*
	     * Node was an archive(member) target, so we want to call
	     * on the Arch module to find the nodes for us, expanding
	     * variables in the parent's context.
	     */
	    char	*sacrifice = cp;

	    (void)Arch_ParseArchive(&sacrifice, members, pgn);
	} else {
	    /*
	     * Break the result into a vector of strings whose nodes
	     * we can find, then add those nodes to the members list.
	     * Unfortunately, we can't use Str_Words because it
	     * doesn't understand about variable specifications with
	     * spaces in them...
	     */
	    char	    *start;
	    char	    *initcp = cp;   /* For freeing... */

	    start = cp;
	    pp_skip_hspace(&start);
	    cp = start;
	    while (*cp != '\0') {
		if (*cp == ' ' || *cp == '\t') {
		    /*
		     * White-space -- terminate element, find the node,
		     * add it, skip any further spaces.
		     */
		    *cp++ = '\0';
		    gn = Targ_GetNode(start);
		    Lst_Append(members, gn);
		    pp_skip_hspace(&cp);
		    start = cp;		/* Continue at the next non-space. */
		} else if (*cp == '$') {
		    /* Skip over the variable expression. */
		    const char *nested_p = cp;
		    const char	*junk;
		    void	*freeIt;

		    (void)Var_Parse(&nested_p, pgn, VARE_NONE, &junk, &freeIt);
		    /* TODO: handle errors */
		    if (junk == var_Error) {
			Parse_Error(PARSE_FATAL,
				    "Malformed variable expression at \"%s\"",
				    cp);
			cp++;
		    } else {
			cp += nested_p - cp;
		    }

		    free(freeIt);
		} else if (cp[0] == '\\' && cp[1] != '\0') {
		    /*
		     * Escaped something -- skip over it
		     */
		    /* XXX: In other places, escaping at this syntactical
		     * position is done by a '$', not a '\'.  The '\' is only
		     * used in variable modifiers. */
		    cp += 2;
		} else {
		    cp++;
		}
	    }

	    if (cp != start) {
		/*
		 * Stuff left over -- add it to the list too
		 */
		gn = Targ_GetNode(start);
		Lst_Append(members, gn);
	    }
	    /*
	     * Point cp back at the beginning again so the variable value
	     * can be freed.
	     */
	    cp = initcp;
	}

	/*
	 * Add all elements of the members list to the parent node.
	 */
	while(!Lst_IsEmpty(members)) {
	    gn = Lst_Dequeue(members);

	    SUFF_DEBUG1("%s...", gn->name);
	    /* Add gn to the parents child list before the original child */
	    Lst_InsertBefore(pgn->children, cln, gn);
	    Lst_Append(gn->parents, pgn);
	    pgn->unmade++;
	    /* Expand wildcards on new node */
	    ExpandWildcards(cln->prev, pgn);
	}
	Lst_Free(members);

	/*
	 * Free the result
	 */
	free(cp);
    }

    SUFF_DEBUG0("\n");

    /*
     * Now the source is expanded, remove it from the list of children to
     * keep it from being processed.
     */
    pgn->unmade--;
    Lst_Remove(pgn->children, cln);
    Lst_Remove(cgn->parents, Lst_FindDatum(cgn->parents, pgn));
}

/* Find a path along which to expand the node.
 *
 * If the node has a known suffix, use that path.
 * If it has no known suffix, use the default system search path.
 *
 * Input:
 *	gn		Node being examined
 *
 * Results:
 *	The appropriate path to search for the GNode.
 */
SearchPath *
Suff_FindPath(GNode* gn)
{
    Suffix *suff = gn->suffix;

    if (suff == NULL) {
	char *name = gn->name;
	size_t nameLen = strlen(gn->name);
	SuffixListNode *ln;
	for (ln = sufflist->first; ln != NULL; ln = ln->next)
	    if (Suffix_IsSuffix(ln->datum, nameLen, name + nameLen))
		break;

	SUFF_DEBUG1("Wildcard expanding \"%s\"...", gn->name);
	if (ln != NULL)
	    suff = ln->datum;
	/* XXX: Here we can save the suffix so we don't have to do this again */
    }

    if (suff != NULL) {
	SUFF_DEBUG1("suffix is \"%s\"...\n", suff->name);
	return suff->searchPath;
    } else {
	SUFF_DEBUG0("\n");
	return dirSearchPath;	/* Use default search path */
    }
}

/* Apply a transformation rule, given the source and target nodes and
 * suffixes.
 *
 * The source and target are linked and the commands from the transformation
 * are added to the target node's commands list. The target also inherits all
 * the sources for the transformation rule.
 *
 * Results:
 *	TRUE if successful, FALSE if not.
 */
static Boolean
ApplyTransform(GNode *tgn, GNode *sgn, Suffix *tsuff, Suffix *ssuff)
{
    GNodeListNode *ln;
    char *tname;		/* Name of transformation rule */
    GNode *gn;			/* Node for same */

    /*
     * Form the proper links between the target and source.
     */
    Lst_Append(tgn->children, sgn);
    Lst_Append(sgn->parents, tgn);
    tgn->unmade++;

    /*
     * Locate the transformation rule itself
     */
    tname = str_concat2(ssuff->name, tsuff->name);
    gn = FindTransformByName(tname);
    free(tname);

    if (gn == NULL) {
	/* This can happen when linking an OP_MEMBER and OP_ARCHV node. */
	return FALSE;
    }

    DEBUG3(SUFF,"\tapplying %s -> %s to \"%s\"\n",
		ssuff->name, tsuff->name, tgn->name);

    /* Record last child; Make_HandleUse may add child nodes. */
    ln = tgn->children->last;

    /* Apply the rule. */
    Make_HandleUse(gn, tgn);

    /* Deal with wildcards and variables in any acquired sources. */
    ln = ln != NULL ? ln->next : NULL;
    while (ln != NULL) {
	GNodeListNode *nln = ln->next;
	ExpandChildren(ln, tgn);
	ln = nln;
    }

    /*
     * Keep track of another parent to which this node is transformed so
     * the .IMPSRC variable can be set correctly for the parent.
     */
    Lst_Append(sgn->implicitParents, tgn);

    return TRUE;
}


static void FindDeps(GNode *, CandidateList *);

/* Locate dependencies for an OP_ARCHV node.
 *
 * Input:
 *	gn		Node for which to locate dependencies
 *
 * Side Effects:
 *	Same as Suff_FindDeps
 */
static void
FindDepsArchive(GNode *gn, CandidateList *slst)
{
    char *eoarch;		/* End of archive portion */
    char *eoname;		/* End of member portion */
    GNode *mem;			/* Node for member */
    SuffixListNode *ln, *nln;	/* Next suffix node to check */
    Suffix *ms;			/* Suffix descriptor for member */
    char *name;			/* Start of member's name */

    /*
     * The node is an archive(member) pair. so we must find a
     * suffix for both of them.
     */
    eoarch = strchr(gn->name, '(');
    eoname = strchr(eoarch, ')');

    /*
     * Caller guarantees the format `libname(member)', via
     * Arch_ParseArchive.
     */
    assert(eoarch != NULL);
    assert(eoname != NULL);

    *eoname = '\0';	  /* Nuke parentheses during suffix search */
    *eoarch = '\0';	  /* So a suffix can be found */

    name = eoarch + 1;

    /*
     * To simplify things, call Suff_FindDeps recursively on the member now,
     * so we can simply compare the member's .PREFIX and .TARGET variables
     * to locate its suffix. This allows us to figure out the suffix to
     * use for the archive without having to do a quadratic search over the
     * suffix list, backtracking for each one...
     */
    mem = Targ_GetNode(name);
    FindDeps(mem, slst);

    /*
     * Create the link between the two nodes right off
     */
    Lst_Append(gn->children, mem);
    Lst_Append(mem->parents, gn);
    gn->unmade++;

    /*
     * Copy in the variables from the member node to this one.
     */
    Var_Set(PREFIX, GNode_VarPrefix(mem), gn);
    Var_Set(TARGET, GNode_VarTarget(mem), gn);

    ms = mem->suffix;
    if (ms == NULL) {		/* Didn't know what it was. */
	SUFF_DEBUG0("using null suffix\n");
	ms = nullSuff;
    }


    /*
     * Set the other two local variables required for this target.
     */
    Var_Set(MEMBER, name, gn);
    Var_Set(ARCHIVE, gn->name, gn);

    /*
     * Set $@ for compatibility with other makes
     */
    Var_Set(TARGET, gn->name, gn);

    /*
     * Now we've got the important local variables set, expand any sources
     * that still contain variables or wildcards in their names.
     */
    for (ln = gn->children->first; ln != NULL; ln = nln) {
	nln = ln->next;
	ExpandChildren(ln, gn);
    }

    if (ms != NULL) {
	/*
	 * Member has a known suffix, so look for a transformation rule from
	 * it to a possible suffix of the archive. Rather than searching
	 * through the entire list, we just look at suffixes to which the
	 * member's suffix may be transformed...
	 */
	size_t nameLen = (size_t)(eoarch - gn->name);

	/* Use first matching suffix... */
	for (ln = ms->parents->first; ln != NULL; ln = ln->next)
	    if (Suffix_IsSuffix(ln->datum, nameLen, eoarch))
		break;

	if (ln != NULL) {
	    /*
	     * Got one -- apply it
	     */
	    Suffix *suff = ln->datum;
	    if (!ApplyTransform(gn, mem, suff, ms)) {
		SUFF_DEBUG2("\tNo transformation from %s -> %s\n",
			    ms->name, suff->name);
	    }
	}
    }

    /*
     * Replace the opening and closing parens now we've no need of the separate
     * pieces.
     */
    *eoarch = '(';
    *eoname = ')';

    /*
     * Pretend gn appeared to the left of a dependency operator so
     * the user needn't provide a transformation from the member to the
     * archive.
     */
    if (!GNode_IsTarget(gn))
	gn->type |= OP_DEPENDS;

    /*
     * Flag the member as such so we remember to look in the archive for
     * its modification time. The OP_JOIN | OP_MADE is needed because this
     * target should never get made.
     */
    mem->type |= OP_MEMBER | OP_JOIN | OP_MADE;
}

static void
FindDepsRegularKnown(const char *name, size_t nameLen, GNode *gn,
		     CandidateList *srcs, CandidateList *targs)
{
    SuffixListNode *ln;
    Candidate *targ;
    char *pref;

    for (ln = sufflist->first; ln != NULL; ln = ln->next) {
	Suffix *suff = ln->datum;
	if (!Suffix_IsSuffix(suff, nameLen, name + nameLen))
	    continue;

	pref = bmake_strldup(name, (size_t)(nameLen - suff->nameLen));
	targ = Candidate_New(bmake_strdup(gn->name), pref, suff, NULL, gn);

	CandidateList_AddCandidatesFor(srcs, targ);

	/*
	 * Record the target so we can nuke it
	 */
	Lst_Append(targs, targ);
    }
}

static void
FindDepsRegularUnknown(GNode *gn, const char *sopref,
		       CandidateList *srcs, CandidateList *targs)
{
    Candidate *targ;

    if (!Lst_IsEmpty(targs) || nullSuff == NULL)
	return;

    SUFF_DEBUG1("\tNo known suffix on %s. Using .NULL suffix\n", gn->name);

    targ = Candidate_New(bmake_strdup(gn->name), bmake_strdup(sopref),
		  nullSuff, NULL, gn);

    /*
     * Only use the default suffix rules if we don't have commands
     * defined for this gnode; traditional make programs used to
     * not define suffix rules if the gnode had children but we
     * don't do this anymore.
     */
    if (Lst_IsEmpty(gn->commands))
	CandidateList_AddCandidatesFor(srcs, targ);
    else {
	SUFF_DEBUG0("not ");
    }

    SUFF_DEBUG0("adding suffix rules\n");

    Lst_Append(targs, targ);
}

/*
 * Deal with finding the thing on the default search path. We
 * always do that, not only if the node is only a source (not
 * on the lhs of a dependency operator or [XXX] it has neither
 * children or commands) as the old pmake did.
 */
static void
FindDepsRegularPath(GNode *gn, Candidate *targ)
{
    if (gn->type & (OP_PHONY | OP_NOPATH))
	return;

    free(gn->path);
    gn->path = Dir_FindFile(gn->name,
			    (targ == NULL ? dirSearchPath :
			     targ->suff->searchPath));
    if (gn->path == NULL)
	return;

    Var_Set(TARGET, gn->path, gn);

    if (targ != NULL) {
	/*
	 * Suffix known for the thing -- trim the suffix off
	 * the path to form the proper .PREFIX variable.
	 */
	size_t savep = strlen(gn->path) - targ->suff->nameLen;
	char savec;
	char *ptr;

	Suffix_Reassign(&gn->suffix, targ->suff);

	savec = gn->path[savep];
	gn->path[savep] = '\0';

	if ((ptr = strrchr(gn->path, '/')) != NULL)
	    ptr++;
	else
	    ptr = gn->path;

	Var_Set(PREFIX, ptr, gn);

	gn->path[savep] = savec;
    } else {
	char *ptr;

	/* The .PREFIX gets the full path if the target has no known suffix. */
	Suffix_Unassign(&gn->suffix);

	if ((ptr = strrchr(gn->path, '/')) != NULL)
	    ptr++;
	else
	    ptr = gn->path;

	Var_Set(PREFIX, ptr, gn);
    }
}

/* Locate implicit dependencies for regular targets.
 *
 * Input:
 *	gn		Node for which to find sources
 *
 * Side Effects:
 *	Same as Suff_FindDeps
 */
static void
FindDepsRegular(GNode *gn, CandidateList *slst)
{
    CandidateList *srcs;	/* List of sources at which to look */
    CandidateList *targs;	/* List of targets to which things can be
				 * transformed. They all have the same file,
				 * but different suff and pref fields */
    Candidate *bottom;		/* Start of found transformation path */
    Candidate *src;
    char *pref;			/* Prefix to use */
    Candidate *targ;

    const char *name = gn->name;
    size_t nameLen = strlen(name);

    /*
     * Begin at the beginning...
     */
    srcs = Lst_New();
    targs = Lst_New();

    /*
     * We're caught in a catch-22 here. On the one hand, we want to use any
     * transformation implied by the target's sources, but we can't examine
     * the sources until we've expanded any variables/wildcards they may hold,
     * and we can't do that until we've set up the target's local variables
     * and we can't do that until we know what the proper suffix for the
     * target is (in case there are two suffixes one of which is a suffix of
     * the other) and we can't know that until we've found its implied
     * source, which we may not want to use if there's an existing source
     * that implies a different transformation.
     *
     * In an attempt to get around this, which may not work all the time,
     * but should work most of the time, we look for implied sources first,
     * checking transformations to all possible suffixes of the target,
     * use what we find to set the target's local variables, expand the
     * children, then look for any overriding transformations they imply.
     * Should we find one, we discard the one we found before.
     */
    bottom = NULL;
    targ = NULL;

    if (!(gn->type & OP_PHONY)) {

	FindDepsRegularKnown(name, nameLen, gn, srcs, targs);

	/* Handle target of unknown suffix... */
	FindDepsRegularUnknown(gn, name, srcs, targs);

	/*
	 * Using the list of possible sources built up from the target
	 * suffix(es), try and find an existing file/target that matches.
	 */
	bottom = FindThem(srcs, slst);

	if (bottom == NULL) {
	    /*
	     * No known transformations -- use the first suffix found
	     * for setting the local variables.
	     */
	    if (targs->first != NULL)
		targ = targs->first->datum;
	    else
		targ = NULL;
	} else {
	    /*
	     * Work up the transformation path to find the suffix of the
	     * target to which the transformation was made.
	     */
	    for (targ = bottom; targ->parent != NULL; targ = targ->parent)
		continue;
	}
    }

    Var_Set(TARGET, GNode_Path(gn), gn);

    pref = targ != NULL ? targ->pref : gn->name;
    Var_Set(PREFIX, pref, gn);

    /*
     * Now we've got the important local variables set, expand any sources
     * that still contain variables or wildcards in their names.
     */
    {
	SuffixListNode *ln, *nln;
	for (ln = gn->children->first; ln != NULL; ln = nln) {
	    nln = ln->next;
	    ExpandChildren(ln, gn);
	}
    }

    if (targ == NULL) {
	SUFF_DEBUG1("\tNo valid suffix on %s\n", gn->name);

sfnd_abort:
	FindDepsRegularPath(gn, targ);
	goto sfnd_return;
    }

    /*
     * If the suffix indicates that the target is a library, mark that in
     * the node's type field.
     */
    if (targ->suff->flags & SUFF_LIBRARY)
	gn->type |= OP_LIB;

    /*
     * Check for overriding transformation rule implied by sources
     */
    if (!Lst_IsEmpty(gn->children)) {
	src = FindCmds(targ, slst);

	if (src != NULL) {
	    /*
	     * Free up all the candidates in the transformation path,
	     * up to but not including the parent node.
	     */
	    while (bottom != NULL && bottom->parent != NULL) {
		if (Lst_FindDatum(slst, bottom) == NULL)
		    Lst_Append(slst, bottom);
		bottom = bottom->parent;
	    }
	    bottom = src;
	}
    }

    if (bottom == NULL) {
	/*
	 * No idea from where it can come -- return now.
	 */
	goto sfnd_abort;
    }

    /*
     * We now have a list of candidates headed by 'bottom' and linked via
     * their 'parent' pointers. What we do next is create links between
     * source and target nodes (which may or may not have been created)
     * and set the necessary local variables in each target.
     *
     * The commands for each target are set from the commands of the
     * transformation rule used to get from the src suffix to the targ
     * suffix. Note that this causes the commands list of the original
     * node, gn, to be replaced with the commands of the final
     * transformation rule.
     */
    if (bottom->node == NULL)
	bottom->node = Targ_GetNode(bottom->file);

    for (src = bottom; src->parent != NULL; src = src->parent) {
	targ = src->parent;

	Suffix_Reassign(&src->node->suffix, src->suff);

	if (targ->node == NULL)
	    targ->node = Targ_GetNode(targ->file);

	ApplyTransform(targ->node, src->node,
			   targ->suff, src->suff);

	if (targ->node != gn) {
	    /*
	     * Finish off the dependency-search process for any nodes
	     * between bottom and gn (no point in questing around the
	     * filesystem for their implicit source when it's already
	     * known). Note that the node can't have any sources that
	     * need expanding, since SuffFindThem will stop on an existing
	     * node, so all we need to do is set the standard variables.
	     */
	    targ->node->type |= OP_DEPS_FOUND;
	    Var_Set(PREFIX, targ->pref, targ->node);
	    Var_Set(TARGET, targ->node->name, targ->node);
	}
    }

    Suffix_Reassign(&gn->suffix, src->suff);

    /*
     * Nuke the transformation path and the candidates left over in the
     * two lists.
     */
sfnd_return:
    if (bottom != NULL && Lst_FindDatum(slst, bottom) == NULL)
	Lst_Append(slst, bottom);

    while (RemoveSrc(srcs) || RemoveSrc(targs))
	continue;

    Lst_MoveAll(slst, srcs);
    Lst_MoveAll(slst, targs);
}


/* Find implicit sources for the target.
 *
 * Nodes are added to the graph below the passed-in node. The nodes are
 * marked to have their IMPSRC variable filled in. The PREFIX variable is set
 * for the given node and all its implied children.
 *
 * The path found by this target is the shortest path in the transformation
 * graph, which may pass through non-existent targets, to an existing target.
 * The search continues on all paths from the root suffix until a file is
 * found. I.e. if there's a path .o -> .c -> .l -> .l,v from the root and the
 * .l,v file exists but the .c and .l files don't, the search will branch out
 * in all directions from .o and again from all the nodes on the next level
 * until the .l,v node is encountered.
 */
void
Suff_FindDeps(GNode *gn)
{
    CandidateList *srcs = Lst_New();

    FindDeps(gn, srcs);

    while (RemoveSrc(srcs))
	continue;

    assert(Lst_IsEmpty(srcs));
    Lst_Free(srcs);
}

static void
FindDeps(GNode *gn, CandidateList *slst)
{
    if (gn->type & OP_DEPS_FOUND)
	return;
    gn->type |= OP_DEPS_FOUND;

    /*
     * Make sure we have these set, may get revised below.
     */
    Var_Set(TARGET, GNode_Path(gn), gn);
    Var_Set(PREFIX, gn->name, gn);

    SUFF_DEBUG1("SuffFindDeps (%s)\n", gn->name);

    if (gn->type & OP_ARCHV) {
	FindDepsArchive(gn, slst);
    } else if (gn->type & OP_LIB) {
	/*
	 * If the node is a library, it is the arch module's job to find it
	 * and set the TARGET variable accordingly. We merely provide the
	 * search path, assuming all libraries end in ".a" (if the suffix
	 * hasn't been defined, there's nothing we can do for it, so we just
	 * set the TARGET variable to the node's name in order to give it a
	 * value).
	 */
	Suffix *suff = FindSuffixByName(LIBSUFF);
	if (suff != NULL) {
	    Suffix_Reassign(&gn->suffix, suff);
	    Arch_FindLib(gn, suff->searchPath);
	} else {
	    Suffix_Unassign(&gn->suffix);
	    Var_Set(TARGET, gn->name, gn);
	}
	/*
	 * Because a library (-lfoo) target doesn't follow the standard
	 * filesystem conventions, we don't set the regular variables for
	 * the thing. .PREFIX is simply made empty...
	 */
	Var_Set(PREFIX, "", gn);
    } else {
	FindDepsRegular(gn, slst);
    }
}

/* Define which suffix is the null suffix.
 *
 * Need to handle the changing of the null suffix gracefully so the old
 * transformation rules don't just go away.
 *
 * Input:
 *	name		Name of null suffix
 */
void
Suff_SetNull(const char *name)
{
    Suffix *suff = FindSuffixByName(name);
    if (suff == NULL) {
	Parse_Error(PARSE_WARNING, "Desired null suffix %s not defined.",
		    name);
	return;
    }

    if (nullSuff != NULL)
	nullSuff->flags &= ~(unsigned)SUFF_NULL;
    suff->flags |= SUFF_NULL;
    /*
     * XXX: Here's where the transformation mangling would take place
     */
    nullSuff = suff;
}

/* Initialize the suffixes module. */
void
Suff_Init(void)
{
#ifdef CLEANUP
    suffClean = Lst_New();
    sufflist = Lst_New();
#endif
    transforms = Lst_New();

    /*
     * Create null suffix for single-suffix rules (POSIX). The thing doesn't
     * actually go on the suffix list or everyone will think that's its
     * suffix.
     */
    Suff_ClearSuffixes();
}


/* Clean up the suffixes module. */
void
Suff_End(void)
{
#ifdef CLEANUP
    Lst_Destroy(sufflist, SuffFree);
    Lst_Destroy(suffClean, SuffFree);
    if (nullSuff != NULL)
	SuffFree(nullSuff);
    Lst_Free(transforms);
#endif
}


static void
PrintSuffNames(const char *prefix, SuffixList *suffs)
{
    SuffixListNode *ln;

    debug_printf("#\t%s: ", prefix);
    for (ln = suffs->first; ln != NULL; ln = ln->next) {
	Suffix *suff = ln->datum;
	debug_printf("%s ", suff->name);
    }
    debug_printf("\n");
}

static void
Suffix_Print(Suffix *suff)
{
    debug_printf("# \"%s\" (num %d, ref %d)",
		 suff->name, suff->sNum, suff->refCount);
    if (suff->flags != 0) {
	char flags_buf[SuffixFlags_ToStringSize];

	debug_printf(" (%s)",
		     Enum_FlagsToString(flags_buf, sizeof flags_buf,
					suff->flags,
					SuffixFlags_ToStringSpecs));
    }
    debug_printf("\n");

    PrintSuffNames("To", suff->parents);
    PrintSuffNames("From", suff->children);

    debug_printf("#\tSearch Path: ");
    Dir_PrintPath(suff->searchPath);
    debug_printf("\n");
}

static void
PrintTransformation(GNode *t)
{
    debug_printf("%-16s:", t->name);
    Targ_PrintType(t->type);
    debug_printf("\n");
    Targ_PrintCmds(t);
    debug_printf("\n");
}

void
Suff_PrintAll(void)
{
    debug_printf("#*** Suffixes:\n");
    {
	SuffixListNode *ln;
	for (ln = sufflist->first; ln != NULL; ln = ln->next)
	    Suffix_Print(ln->datum);
    }

    debug_printf("#*** Transformations:\n");
    {
	GNodeListNode *ln;
	for (ln = transforms->first; ln != NULL; ln = ln->next)
	    PrintTransformation(ln->datum);
    }
}