Move ProcExec() into proc.c
[dragonfly.git] / usr.bin / make / suff.c
1 /*-
2  * Copyright (c) 1988, 1989, 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * Copyright (c) 1989 by Berkeley Softworks
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  * @(#)suff.c   8.4 (Berkeley) 3/21/94
39  * $FreeBSD: src/usr.bin/make/suff.c,v 1.43 2005/02/04 13:23:39 harti Exp $
40  * $DragonFly: src/usr.bin/make/suff.c,v 1.60 2005/05/20 11:48:55 okumoto Exp $
41  */
42
43 /*-
44  * suff.c --
45  *      Functions to maintain suffix lists and find implicit dependents
46  *      using suffix transformation rules
47  *
48  * Interface:
49  *      Suff_Init               Initialize all things to do with suffixes.
50  *
51  *      Suff_DoPaths            This function is used to make life easier
52  *                              when searching for a file according to its
53  *                              suffix. It takes the global search path,
54  *                              as defined using the .PATH: target, and appends
55  *                              its directories to the path of each of the
56  *                              defined suffixes, as specified using
57  *                              .PATH<suffix>: targets. In addition, all
58  *                              directories given for suffixes labeled as
59  *                              include files or libraries, using the .INCLUDES
60  *                              or .LIBS targets, are played with using
61  *                              Dir_MakeFlags to create the .INCLUDES and
62  *                              .LIBS global variables.
63  *
64  *      Suff_ClearSuffixes      Clear out all the suffixes and defined
65  *                              transformations.
66  *
67  *      Suff_IsTransform        Return TRUE if the passed string is the lhs
68  *                              of a transformation rule.
69  *
70  *      Suff_AddSuffix          Add the passed string as another known suffix.
71  *
72  *      Suff_GetPath            Return the search path for the given suffix.
73  *
74  *      Suff_AddInclude         Mark the given suffix as denoting an include
75  *                              file.
76  *
77  *      Suff_AddLib             Mark the given suffix as denoting a library.
78  *
79  *      Suff_AddTransform       Add another transformation to the suffix
80  *                              graph. Returns  GNode suitable for framing, I
81  *                              mean, tacking commands, attributes, etc. on.
82  *
83  *      Suff_SetNull            Define the suffix to consider the suffix of
84  *                              any file that doesn't have a known one.
85  *
86  *      Suff_FindDeps           Find implicit sources for and the location of
87  *                              a target based on its suffix. Returns the
88  *                              bottom-most node added to the graph or NULL
89  *                              if the target had no implicit sources.
90  */
91
92 #include <sys/queue.h>
93 #include <assert.h>
94 #include <string.h>
95 #include <stdlib.h>
96
97 #include "arch.h"
98 #include "buf.h"
99 #include "config.h"
100 #include "dir.h"
101 #include "globals.h"
102 #include "GNode.h"
103 #include "lst.h"
104 #include "make.h"
105 #include "parse.h"
106 #include "str.h"
107 #include "suff.h"
108 #include "targ.h"
109 #include "util.h"
110 #include "var.h"
111
112 /* Lst of suffixes */
113 static Lst sufflist = Lst_Initializer(sufflist);
114
115 /* Lst of suffixes to be cleaned */
116 static Lst suffClean = Lst_Initializer(suffClean);
117
118 /* Lst of sources */
119 static Lst srclist = Lst_Initializer(srclist);
120
121 /* Lst of transformation rules */
122 static Lst transforms = Lst_Initializer(transforms);
123
124 /* Counter for assigning suffix numbers */
125 static int sNum = 0;
126
127 /*
128  * Structure describing an individual suffix.
129  */
130 typedef struct Suff {
131         char    *name;          /* The suffix itself */
132         int     nameLen;        /* Length of the suffix */
133         short   flags;          /* Type of suffix */
134 #define SUFF_INCLUDE    0x01    /* One which is #include'd */
135 #define SUFF_LIBRARY    0x02    /* One which contains a library */
136 #define SUFF_NULL       0x04    /* The empty suffix */
137         struct Path searchPath; /* Path for files with this suffix */
138         int     sNum;           /* The suffix number */
139         int     refCount;       /* Reference count of list membership */
140         Lst     parents;        /* Suffixes we have a transformation to */
141         Lst     children;       /* Suffixes we have a transformation from */
142         Lst     ref;            /* List of lists this suffix is referenced */
143 } Suff;
144
145 /*
146  * Structure used in the search for implied sources.
147  */
148 typedef struct Src {
149         char    *file;          /* The file to look for */
150         char    *pref;          /* Prefix from which file was formed */
151         Suff    *suff;          /* The suffix on the file */
152         struct Src *parent;     /* The Src for which this is a source */
153         GNode   *node;          /* The node describing the file */
154         int     children;       /* Count of existing children (so we don't free
155                                  * this thing too early or never nuke it) */
156 #ifdef DEBUG_SRC
157         Lst     cp;             /* Debug; children list */
158 #endif
159 } Src;
160
161 /* The NULL suffix for this run */
162 static Suff     *suffNull;
163
164 /* The empty suffix required for POSIX single-suffix transformation rules */
165 static Suff     *emptySuff;
166
167 static void SuffFindDeps(GNode *, Lst *);
168
169
170 /*-
171  *-----------------------------------------------------------------------
172  * SuffSuffIsSuffix  --
173  *      See if suff is a suffix of str.
174  *
175  * Results:
176  *      NULL if it ain't, pointer to character in str before suffix if
177  *      it is.
178  *
179  * Side Effects:
180  *      None
181  *-----------------------------------------------------------------------
182  */
183 static char *
184 SuffSuffIsSuffix(const Suff *s, char *str)
185 {
186         const char      *p1;    /* Pointer into suffix name */
187         char            *p2;    /* Pointer into string being examined */
188         size_t          len;
189
190         len = strlen(str);
191         p1 = s->name + s->nameLen;
192         p2 = str + len;
193
194         while (p1 >= s->name && len > 0 && *p1 == *p2) {
195                 p1--;
196                 p2--;
197                 len--;
198         }
199
200         return (p1 == s->name - 1 ? p2 : NULL);
201 }
202
203 /*-
204  *-----------------------------------------------------------------------
205  * SuffSuffFind --
206  *      Find a suffix given its name.
207  *
208  * Results:
209  *      The suffix or NULL.
210  *
211  * Side Effects:
212  *      None
213  *-----------------------------------------------------------------------
214  */
215 static Suff *
216 SuffSuffFind(const char *s)
217 {
218         LstNode *ln;
219
220         LST_FOREACH(ln, &sufflist) {
221                 if (strcmp(s, ((const Suff *)Lst_Datum(ln))->name) == 0)
222                         return (Lst_Datum(ln));
223         }
224         return (NULL);
225 }
226
227 /*-
228  *-----------------------------------------------------------------------
229  * SuffTransFind
230  *      Find a transform.
231  *
232  * Results:
233  *      transform or NULL.
234  *
235  * Side Effects:
236  *      None
237  *-----------------------------------------------------------------------
238  */
239 static GNode *
240 SuffTransFind(const char *name)
241 {
242         LstNode *ln;
243
244         LST_FOREACH(ln, &transforms) {
245                 if (strcmp(name, ((const GNode *)Lst_Datum(ln))->name) == 0)
246                         return (Lst_Datum(ln));
247         }
248         return (NULL);
249 }
250
251             /*********** Maintenance Functions ************/
252
253 #if 0
254 /*
255  * Keep this function for now until it is clear why a .SUFFIXES: doesn't
256  * actually delete the suffixes but just puts them on the suffClean list.
257  */
258 /*-
259  *-----------------------------------------------------------------------
260  * SuffFree  --
261  *      Free up all memory associated with the given suffix structure.
262  *
263  * Results:
264  *      none
265  *
266  * Side Effects:
267  *      the suffix entry is detroyed
268  *-----------------------------------------------------------------------
269  */
270 static void
271 SuffFree(void *sp)
272 {
273         Suff *s = sp;
274
275         if (s == suffNull)
276                 suffNull = NULL;
277
278         if (s == emptySuff)
279                 emptySuff = NULL;
280
281         Lst_Destroy(&s->ref, NOFREE);
282         Lst_Destroy(&s->children, NOFREE);
283         Lst_Destroy(&s->parents, NOFREE);
284         Lst_Destroy(&s->searchPath, Dir_Destroy);
285
286         free(s->name);
287         free(s);
288 }
289 #endif
290
291 /*-
292  *-----------------------------------------------------------------------
293  * SuffRemove  --
294  *      Remove the suffix into the list
295  *
296  * Results:
297  *      None
298  *
299  * Side Effects:
300  *      The reference count for the suffix is decremented
301  *-----------------------------------------------------------------------
302  */
303 static void
304 SuffRemove(Lst *l, Suff *s)
305 {
306         LstNode *ln = Lst_Member(l, s);
307
308         if (ln != NULL) {
309                 Lst_Remove(l, ln);
310                 s->refCount--;
311         }
312 }
313
314 /*-
315  *-----------------------------------------------------------------------
316  * SuffInsert  --
317  *      Insert the suffix into the list keeping the list ordered by suffix
318  *      numbers.
319  *
320  * Results:
321  *      None
322  *
323  * Side Effects:
324  *      The reference count of the suffix is incremented
325  *-----------------------------------------------------------------------
326  */
327 static void
328 SuffInsert(Lst *l, Suff *s)
329 {
330         LstNode *ln;    /* current element in l we're examining */
331         Suff    *s2;    /* the suffix descriptor in this element */
332
333         s2 = NULL;
334         for (ln = Lst_First(l); ln != NULL; ln = Lst_Succ(ln)) {
335                 s2 = Lst_Datum(ln);
336                 if (s2->sNum >= s->sNum)
337                         break;
338         }
339         if (s2 == NULL) {
340                 DEBUGF(SUFF, ("inserting an empty list?..."));
341         }
342
343         DEBUGF(SUFF, ("inserting %s(%d)...", s->name, s->sNum));
344         if (ln == NULL) {
345                 DEBUGF(SUFF, ("at end of list\n"));
346                 Lst_AtEnd(l, s);
347                 s->refCount++;
348                 Lst_AtEnd(&s->ref, l);
349         } else if (s2->sNum != s->sNum) {
350                 DEBUGF(SUFF, ("before %s(%d)\n", s2->name, s2->sNum));
351                 Lst_Insert(l, ln, s);
352                 s->refCount++;
353                 Lst_AtEnd(&s->ref, l);
354         } else {
355                 DEBUGF(SUFF, ("already there\n"));
356         }
357 }
358
359 /*-
360  *-----------------------------------------------------------------------
361  * Suff_ClearSuffixes --
362  *      This is gross. Nuke the list of suffixes but keep all transformation
363  *      rules around. The transformation graph is destroyed in this process,
364  *      but we leave the list of rules so when a new graph is formed the rules
365  *      will remain.
366  *      This function is called from the parse module when a
367  *      .SUFFIXES:\n line is encountered.
368  *
369  * Results:
370  *      none
371  *
372  * Side Effects:
373  *      the sufflist and its graph nodes are destroyed
374  *-----------------------------------------------------------------------
375  */
376 void
377 Suff_ClearSuffixes(void)
378 {
379
380         Lst_Concat(&suffClean, &sufflist, LST_CONCLINK);
381
382         sNum = 1;
383         suffNull = emptySuff;
384         /*
385          * Clear suffNull's children list (the other suffixes are built new, but
386          * suffNull is used as is).
387          * NOFREE is used because all suffixes are are on the suffClean list.
388          * suffNull should not have parents.
389          */
390         Lst_Destroy(&suffNull->children, NOFREE);
391 }
392
393 /*-
394  *-----------------------------------------------------------------------
395  * SuffParseTransform --
396  *      Parse a transformation string to find its two component suffixes.
397  *
398  * Results:
399  *      TRUE if the string is a valid transformation and FALSE otherwise.
400  *
401  * Side Effects:
402  *      The passed pointers are overwritten.
403  *
404  *-----------------------------------------------------------------------
405  */
406 static Boolean
407 SuffParseTransform(char *str, Suff **srcPtr, Suff **targPtr)
408 {
409         LstNode *srcLn;         /* element in suffix list of trans source*/
410         Suff    *src;           /* Source of transformation */
411         char    *str2;          /* Extra pointer (maybe target suffix) */
412         LstNode *singleLn;      /* element in suffix list of any suffix
413                                  * that exactly matches str */
414         Suff    *single = NULL; /* Source of possible transformation to
415                                  * null suffix */
416
417         singleLn = NULL;
418
419         /*
420          * Loop looking first for a suffix that matches the start of the
421          * string and then for one that exactly matches the rest of it. If
422          * we can find two that meet these criteria, we've successfully
423          * parsed the string.
424          */
425         srcLn = Lst_First(&sufflist);
426         for (;;) {
427                 /* advance to next possible suffix */
428                 while (srcLn != NULL) {
429                         src = Lst_Datum(srcLn);
430                         if (strncmp(str, src->name, strlen(src->name)) == 0)
431                                 break;
432                         srcLn = LST_NEXT(srcLn);
433                 }
434
435                 if (srcLn == NULL) {
436                         /*
437                          * Ran out of source suffixes -- no such rule
438                          */
439                         if (singleLn != NULL) {
440                                 /*
441                                  * Not so fast Mr. Smith! There was a suffix
442                                  * that encompassed the entire string, so we
443                                  * assume it was a transformation to the null
444                                  * suffix (thank you POSIX). We still prefer to
445                                  * find a double rule over a singleton, hence we
446                                  * leave this check until the end.
447                                  *
448                                  * XXX: Use emptySuff over suffNull?
449                                  */
450                                 *srcPtr = single;
451                                 *targPtr = suffNull;
452                                 return (TRUE);
453                         }
454                         return (FALSE);
455                 }
456                 str2 = str + src->nameLen;
457                 if (*str2 == '\0') {
458                         single = src;
459                         singleLn = srcLn;
460                 } else {
461
462                         *targPtr = SuffSuffFind(str2);
463                         if (*targPtr != NULL) {
464                                 *srcPtr = src;
465                                 return (TRUE);
466                         }
467                 }
468                 /* next one */
469                 srcLn = LST_NEXT(srcLn);
470         }
471 }
472
473 /*-
474  *-----------------------------------------------------------------------
475  * Suff_IsTransform  --
476  *      Return TRUE if the given string is a transformation rule
477  *
478  *
479  * Results:
480  *      TRUE if the string is a concatenation of two known suffixes.
481  *      FALSE otherwise
482  *
483  * Side Effects:
484  *      None
485  *-----------------------------------------------------------------------
486  */
487 Boolean
488 Suff_IsTransform(char *str)
489 {
490         Suff    *src, *targ;
491
492         return (SuffParseTransform(str, &src, &targ));
493 }
494
495 /*-
496  *-----------------------------------------------------------------------
497  * Suff_AddTransform --
498  *      Add the transformation rule described by the line to the
499  *      list of rules and place the transformation itself in the graph
500  *
501  * Results:
502  *      The node created for the transformation in the transforms list
503  *
504  * Side Effects:
505  *      The node is placed on the end of the transforms Lst and links are
506  *      made between the two suffixes mentioned in the target name
507  *-----------------------------------------------------------------------
508  */
509 GNode *
510 Suff_AddTransform(char *line)
511 {
512         GNode   *gn;    /* GNode of transformation rule */
513         Suff    *s;     /* source suffix */
514         Suff    *t;     /* target suffix */
515
516         gn = SuffTransFind(line);
517         if (gn == NULL) {
518                 /*
519                  * Make a new graph node for the transformation.
520                  * It will be filled in by the Parse module.
521                  */
522                 gn = Targ_NewGN(line);
523                 Lst_AtEnd(&transforms, gn);
524         } else {
525                 /*
526                  * New specification for transformation rule. Just nuke the
527                  * old list of commands so they can be filled in again...
528                  * We don't actually free the commands themselves, because a
529                  * given command can be attached to several different
530                  * transformations.
531                  */
532                 Lst_Destroy(&gn->commands, NOFREE);
533                 Lst_Destroy(&gn->children, NOFREE);
534         }
535
536         gn->type = OP_TRANSFORM;
537
538         SuffParseTransform(line, &s, &t);
539
540         /*
541          * link the two together in the proper relationship and order
542          */
543         DEBUGF(SUFF, ("defining transformation from `%s' to `%s'\n",
544             s->name, t->name));
545         SuffInsert(&t->children, s);
546         SuffInsert(&s->parents, t);
547
548         return (gn);
549 }
550
551 /*-
552  *-----------------------------------------------------------------------
553  * Suff_EndTransform --
554  *      Handle the finish of a transformation definition, removing the
555  *      transformation from the graph if it has neither commands nor
556  *      sources. This is called from the Parse module at the end of
557  *      a dependency block.
558  *
559  * Side Effects:
560  *      If the node has no commands or children, the children and parents
561  *      lists of the affected suffices are altered.
562  *
563  *-----------------------------------------------------------------------
564  */
565 void
566 Suff_EndTransform(const GNode *gn)
567 {
568         Suff    *s, *t;
569
570         if (!Lst_IsEmpty(&gn->commands) || !Lst_IsEmpty(&gn->children)) {
571                 DEBUGF(SUFF, ("transformation %s complete\n", gn->name));
572                 return;
573         }
574
575         /*
576          * SuffParseTransform() may fail for special rules which are not
577          * actual transformation rules (e.g., .DEFAULT).
578          */
579         if (!SuffParseTransform(gn->name, &s, &t))
580                 return;
581
582         DEBUGF(SUFF, ("deleting transformation from `%s' to `%s'\n",
583             s->name, t->name));
584
585         /*
586          * Remove the source from the target's children list. We check
587          * for a NULL return to handle a beanhead saying something like
588          *  .c.o .c.o:
589          *
590          * We'll be called twice when the next target is seen, but .c
591          * and .o are only linked once...
592          */
593         SuffRemove(&t->children, s);
594
595         /*
596          * Remove the target from the source's parents list
597          */
598         SuffRemove(&s->parents, t);
599 }
600
601 /*-
602  *-----------------------------------------------------------------------
603  * SuffRebuildGraph --
604  *      Called from Suff_AddSuffix via LST_FOREACH to search through the
605  *      list of existing transformation rules and rebuild the transformation
606  *      graph when it has been destroyed by Suff_ClearSuffixes. If the
607  *      given rule is a transformation involving this suffix and another,
608  *      existing suffix, the proper relationship is established between
609  *      the two.
610  *
611  * Side Effects:
612  *      The appropriate links will be made between this suffix and
613  *      others if transformation rules exist for it.
614  *
615  *-----------------------------------------------------------------------
616  */
617 static void
618 SuffRebuildGraph(const GNode *transform, Suff *s)
619 {
620         char    *cp;
621         Suff    *s2 = NULL;
622
623         /*
624          * First see if it is a transformation from this suffix.
625          */
626         if (strncmp(transform->name, s->name, strlen(s->name)) == 0) {
627                 cp = transform->name + strlen(s->name);
628
629                 if (cp[0] == '\0')  /* null rule */
630                         s2 = suffNull;
631                 else
632                         s2 = SuffSuffFind(cp);
633                 if (s2 != NULL) {
634                         /*
635                          * Found target. Link in and return, since it can't be
636                          * anything else.
637                          */
638                         SuffInsert(&s2->children, s);
639                         SuffInsert(&s->parents, s2);
640                         return;
641                 }
642         }
643
644         /*
645          * Not from, maybe to?
646          */
647         cp = SuffSuffIsSuffix(s, transform->name);
648         if (cp != NULL) {
649                 /*
650                  * Null-terminate the source suffix in order to find it.
651                  */
652                 cp[1] = '\0';
653                 s2 = SuffSuffFind(transform->name);
654
655                 /*
656                  * Replace the start of the target suffix
657                  */
658                 cp[1] = s->name[0];
659                 if (s2 != NULL) {
660                         /*
661                          * Found it -- establish the proper relationship
662                          */
663                         SuffInsert(&s->children, s2);
664                         SuffInsert(&s2->parents, s);
665                 }
666         }
667 }
668
669 /*-
670  *-----------------------------------------------------------------------
671  * Suff_AddSuffix --
672  *      Add the suffix in string to the end of the list of known suffixes.
673  *      Should we restructure the suffix graph? Make doesn't...
674  *
675  * Results:
676  *      None
677  *
678  * Side Effects:
679  *      A GNode is created for the suffix and a Suff structure is created and
680  *      added to the suffixes list unless the suffix was already known.
681  *-----------------------------------------------------------------------
682  */
683 void
684 Suff_AddSuffix(char *str)
685 {
686         Suff    *s;     /* new suffix descriptor */
687         LstNode *ln;
688
689         if (SuffSuffFind(str) != NULL)
690                 /*
691                  * Already known
692                  */
693                 return;
694
695         s = emalloc(sizeof(Suff));
696
697         s->name = estrdup(str);
698         s->nameLen = strlen(s->name);
699         TAILQ_INIT(&s->searchPath);
700         Lst_Init(&s->children);
701         Lst_Init(&s->parents);
702         Lst_Init(&s->ref);
703         s->sNum = sNum++;
704         s->flags = 0;
705         s->refCount = 0;
706
707         Lst_AtEnd(&sufflist, s);
708
709         /*
710          * Look for any existing transformations from or to this suffix.
711          * XXX: Only do this after a Suff_ClearSuffixes?
712          */
713         LST_FOREACH(ln, &transforms)
714                 SuffRebuildGraph(Lst_Datum(ln), s);
715 }
716
717 /*-
718  *-----------------------------------------------------------------------
719  * Suff_GetPath --
720  *      Return the search path for the given suffix, if it's defined.
721  *
722  * Results:
723  *      The searchPath for the desired suffix or NULL if the suffix isn't
724  *      defined.
725  *
726  * Side Effects:
727  *      None
728  *-----------------------------------------------------------------------
729  */
730 struct Path *
731 Suff_GetPath(char *sname)
732 {
733         Suff    *s;
734
735         s = SuffSuffFind(sname);
736         if (s == NULL)
737                 return (NULL);
738         return (&s->searchPath);
739 }
740
741 /*-
742  *-----------------------------------------------------------------------
743  * Suff_DoPaths --
744  *      Extend the search paths for all suffixes to include the default
745  *      search path.
746  *
747  * Results:
748  *      None.
749  *
750  * Side Effects:
751  *      The searchPath field of all the suffixes is extended by the
752  *      directories in dirSearchPath. If paths were specified for the
753  *      ".h" suffix, the directories are stuffed into a global variable
754  *      called ".INCLUDES" with each directory preceded by a -I. The same
755  *      is done for the ".a" suffix, except the variable is called
756  *      ".LIBS" and the flag is -L.
757  *-----------------------------------------------------------------------
758  */
759 void
760 Suff_DoPaths(void)
761 {
762         Suff    *s;
763         LstNode *ln;
764         char    *ptr;
765         struct Path inIncludes; /* Cumulative .INCLUDES path */
766         struct Path inLibs;     /* Cumulative .LIBS path */
767
768         TAILQ_INIT(&inIncludes);
769         TAILQ_INIT(&inLibs);
770
771         for (ln = Lst_First(&sufflist); ln != NULL; ln = Lst_Succ(ln)) {
772                 s = Lst_Datum(ln);
773 #ifdef INCLUDES
774                 if (s->flags & SUFF_INCLUDE) {
775                         Path_Concat(&inIncludes, &s->searchPath);
776                 }
777 #endif /* INCLUDES */
778 #ifdef LIBRARIES
779                 if (s->flags & SUFF_LIBRARY) {
780                         Path_Concat(&inLibs, &s->searchPath);
781                 }
782 #endif /* LIBRARIES */
783                 Path_Concat(&s->searchPath, &dirSearchPath);
784         }
785
786         ptr = Path_MakeFlags("-I", &inIncludes);
787         Var_Set(".INCLUDES", ptr, VAR_GLOBAL);
788         free(ptr);
789
790         ptr = Path_MakeFlags("-L", &inLibs);
791         Var_Set(".LIBS", ptr, VAR_GLOBAL);
792         free(ptr);
793
794         Path_Clear(&inIncludes);
795         Path_Clear(&inLibs);
796 }
797
798 /*-
799  *-----------------------------------------------------------------------
800  * Suff_AddInclude --
801  *      Add the given suffix as a type of file which gets included.
802  *      Called from the parse module when a .INCLUDES line is parsed.
803  *      The suffix must have already been defined.
804  *
805  * Results:
806  *      None.
807  *
808  * Side Effects:
809  *      The SUFF_INCLUDE bit is set in the suffix's flags field
810  *
811  *-----------------------------------------------------------------------
812  */
813 void
814 Suff_AddInclude(char *sname)
815 {
816         Suff    *s;
817
818         if ((s = SuffSuffFind(sname)) != NULL)
819                 s->flags |= SUFF_INCLUDE;
820 }
821
822 /*-
823  *-----------------------------------------------------------------------
824  * Suff_AddLib --
825  *      Add the given suffix as a type of file which is a library.
826  *      Called from the parse module when parsing a .LIBS line. The
827  *      suffix must have been defined via .SUFFIXES before this is
828  *      called.
829  *
830  * Results:
831  *      None.
832  *
833  * Side Effects:
834  *      The SUFF_LIBRARY bit is set in the suffix's flags field
835  *
836  *-----------------------------------------------------------------------
837  */
838 void
839 Suff_AddLib(char *sname)
840 {
841         Suff    *s;
842
843         if ((s = SuffSuffFind(sname)) != NULL)
844                 s->flags |= SUFF_LIBRARY;
845 }
846
847 /*
848  * Create a new Src structure
849  */
850 static Src *
851 SuffSrcCreate(char *file, char *prefix, Suff *suff, Src *parent, GNode *node)
852 {
853         Src     *s;
854
855         s = emalloc(sizeof(*s));
856         s->file = file;
857         s->pref = prefix;
858         s->suff = suff;
859         s->parent = parent;
860         s->node = node;
861         s->children = 0;
862
863 #ifdef DEBUG_SRC
864         Lst_Init(&s->cp);
865 #endif
866
867         return (s);
868 }
869
870           /********** Implicit Source Search Functions *********/
871
872 /*-
873  *-----------------------------------------------------------------------
874  * SuffAddLevel  --
875  *      Add all the children of targ as Src structures to the given list:
876  *      Add a suffix as a Src structure to the given list with its parent
877  *      being the given Src structure. If the suffix is the null suffix,
878  *      the prefix is used unaltered as the file name in the Src structure.
879  *
880  * Results:
881  *      None
882  *
883  * Side Effects:
884  *      Lots of structures are created and added to the list
885  *-----------------------------------------------------------------------
886  */
887 static void
888 SuffAddLevel(Lst *l, Src *targ)
889 {
890         LstNode         *ln;
891         Suff            *suff;
892         Src             *s2;
893 #ifdef DEBUG_SRC
894         const LstNode   *ln1;
895 #endif
896
897         LST_FOREACH(ln, &targ->suff->children) {
898                 suff = Lst_Datum(ln);
899
900                 if ((suff->flags & SUFF_NULL) && *suff->name != '\0') {
901                         /*
902                          * If the suffix has been marked as the NULL suffix,
903                          * also create a Src structure for a file with no suffix
904                          * attached. Two birds, and all that...
905                          */
906                         s2 = SuffSrcCreate(estrdup(targ->pref), targ->pref,
907                             suff, targ, NULL);
908                         suff->refCount++;
909                         targ->children += 1;
910                         Lst_AtEnd(l, s2);
911 #ifdef DEBUG_SRC
912                         Lst_AtEnd(&targ->cp, s2);
913                         printf("1 add %p %p to %p:", targ, s2, l);
914                         LST_FOREACH(ln1, l)
915                                 printf("%p ", (const void *)Lst_Datum(ln1));
916                         printf("\n");
917 #endif
918                 }
919                 s2 = SuffSrcCreate(
920                     str_concat(targ->pref, '\0', suff->name),
921                     targ->pref, suff, targ, NULL);
922                 suff->refCount++;
923                 targ->children += 1;
924                 Lst_AtEnd(l, s2);
925 #ifdef DEBUG_SRC
926                 Lst_AtEnd(&targ->cp, s2);
927                 printf("2 add %p %p to %p:", targ, s2, l);
928                 LST_FOREACH(ln1, l)
929                         printf("%p ", (const void *)Lst_Datum(ln1));
930                 printf("\n");
931 #endif
932         }
933 }
934
935 /*-
936  *----------------------------------------------------------------------
937  * SuffRemoveSrc --
938  *      Free all src structures in list that don't have a reference count
939  *      XXX this actually frees only the first of these.
940  *
941  * Results:
942  *      True if a src was removed
943  *
944  * Side Effects:
945  *      The memory is free'd.
946  *----------------------------------------------------------------------
947  */
948 static int
949 SuffRemoveSrc(Lst *l)
950 {
951         LstNode *ln, *ln1;
952         Src     *s;
953         int     t = 0;
954
955 #ifdef DEBUG_SRC
956         printf("cleaning %lx: ", (unsigned long) l);
957         LST_FOREACH(ln, l)
958                 printf("%p ", (const void *)Lst_Datum(ln));
959         printf("\n");
960 #endif
961
962         for (ln = Lst_First(l); ln != NULL; ln = ln1) {
963                 ln1 = Lst_Succ(ln);
964
965                 s = (Src *)Lst_Datum(ln);
966                 if (s->children == 0) {
967                         free(s->file);
968                         if (!s->parent)
969                                 free(s->pref);
970                         else {
971 #ifdef DEBUG_SRC
972                                 LstNode *ln = Lst_Member(&s->parent->cp, s);
973                                 if (ln != NULL)
974                                         Lst_Remove(&s->parent->cp, ln);
975 #endif
976                                 --s->parent->children;
977                         }
978 #ifdef DEBUG_SRC
979                         printf("free: [l=%p] p=%p %d\n", l, s, s->children);
980                         Lst_Destroy(&s->cp, NOFREE);
981 #endif
982                         Lst_Remove(l, ln);
983                         free(s);
984                         t |= 1;
985                         return (TRUE);
986                 }
987 #ifdef DEBUG_SRC
988                 else {
989                         const LstNode *tln;
990
991                         printf("keep: [l=%p] p=%p %d: ", l, s, s->children);
992                         LST_FOREACH(tln, &s->cp)
993                                 printf("%p ", (const void *)Lst_Datum(tln));
994                         printf("\n");
995                 }
996 #endif
997         }
998
999         return (t);
1000 }
1001
1002 /*-
1003  *-----------------------------------------------------------------------
1004  * SuffFindThem --
1005  *      Find the first existing file/target in the list srcs
1006  *
1007  * Results:
1008  *      The lowest structure in the chain of transformations
1009  *
1010  * Side Effects:
1011  *      None
1012  *-----------------------------------------------------------------------
1013  */
1014 static Src *
1015 SuffFindThem(Lst *srcs, Lst *slst)
1016 {
1017         Src     *s;     /* current Src */
1018         Src     *rs;    /* returned Src */
1019         char    *ptr;
1020
1021         rs = NULL;
1022
1023         while (!Lst_IsEmpty (srcs)) {
1024                 s = Lst_DeQueue(srcs);
1025
1026                 DEBUGF(SUFF, ("\ttrying %s...", s->file));
1027
1028                 /*
1029                  * A file is considered to exist if either a node exists in the
1030                  * graph for it or the file actually exists.
1031                  */
1032                 if (Targ_FindNode(s->file, TARG_NOCREATE) != NULL) {
1033 #ifdef DEBUG_SRC
1034                         printf("remove %p from %p\n", s, srcs);
1035 #endif
1036                         rs = s;
1037                         break;
1038                 }
1039
1040                 if ((ptr = Path_FindFile(s->file,
1041                     &s->suff->searchPath)) != NULL) {
1042                         rs = s;
1043 #ifdef DEBUG_SRC
1044                         printf("remove %p from %p\n", s, srcs);
1045 #endif
1046                         free(ptr);
1047                         break;
1048                 }
1049
1050                 DEBUGF(SUFF, ("not there\n"));
1051
1052                 SuffAddLevel(srcs, s);
1053                 Lst_AtEnd(slst, s);
1054         }
1055
1056         if (rs) {
1057                 DEBUGF(SUFF, ("got it\n"));
1058         }
1059         return (rs);
1060 }
1061
1062 /*-
1063  *-----------------------------------------------------------------------
1064  * SuffFindCmds --
1065  *      See if any of the children of the target in the Src structure is
1066  *      one from which the target can be transformed. If there is one,
1067  *      a Src structure is put together for it and returned.
1068  *
1069  * Results:
1070  *      The Src structure of the "winning" child, or NULL if no such beast.
1071  *
1072  * Side Effects:
1073  *      A Src structure may be allocated.
1074  *
1075  *-----------------------------------------------------------------------
1076  */
1077 static Src *
1078 SuffFindCmds(Src *targ, Lst *slst)
1079 {
1080         LstNode *ln;    /* General-purpose list node */
1081         GNode   *t;     /* Target GNode */
1082         GNode   *s;     /* Source GNode */
1083         int     prefLen;/* The length of the defined prefix */
1084         Suff    *suff;  /* Suffix on matching beastie */
1085         Src     *ret;   /* Return value */
1086         char    *cp;
1087
1088         t = targ->node;
1089         prefLen = strlen(targ->pref);
1090
1091         for (ln = Lst_First(&t->children); ln != NULL; ln = Lst_Succ(ln)) {
1092                 s = Lst_Datum(ln);
1093
1094                 cp = strrchr(s->name, '/');
1095                 if (cp == NULL) {
1096                         cp = s->name;
1097                 } else {
1098                         cp++;
1099                 }
1100                 if (strncmp(cp, targ->pref, prefLen) == 0) {
1101                         /*
1102                          * The node matches the prefix ok, see if it has
1103                          * a known suffix.
1104                          */
1105                         suff = SuffSuffFind(&cp[prefLen]);
1106                         if (suff != NULL) {
1107                                 /*
1108                                  * It even has a known suffix, see if there's
1109                                  * a transformation defined between the node's
1110                                  * suffix and the target's suffix.
1111                                  *
1112                                  * XXX: Handle multi-stage transformations
1113                                  * here, too.
1114                                  */
1115                                 if (Lst_Member(&suff->parents,
1116                                     targ->suff) != NULL) {
1117                                         /*
1118                                          * Hot Damn! Create a new Src structure
1119                                          * to describe this transformation
1120                                          * (making sure to duplicate the
1121                                          * source node's name so Suff_FindDeps
1122                                          * can free it again (ick)), and return
1123                                          * the new structure.
1124                                          */
1125                                         ret = SuffSrcCreate(estrdup(s->name),
1126                                             targ->pref, suff, targ, s);
1127                                         suff->refCount++;
1128                                         targ->children += 1;
1129 #ifdef DEBUG_SRC
1130                                         printf("3 add %p %p\n", &targ, ret);
1131                                         Lst_AtEnd(&targ->cp, ret);
1132 #endif
1133                                         Lst_AtEnd(slst, ret);
1134                                         DEBUGF(SUFF, ("\tusing existing source "
1135                                             "%s\n", s->name));
1136                                         return (ret);
1137                                 }
1138                         }
1139                 }
1140         }
1141         return (NULL);
1142 }
1143
1144 /*-
1145  * The child node contains variable references. Expand them and return
1146  * a list of expansions.
1147  */
1148 static void
1149 SuffExpandVariables(GNode *parent, GNode *child, Lst *members)
1150 {
1151         Buffer  *buf;
1152         char    *cp;
1153         char    *start;
1154
1155         Lst_Init(members);
1156
1157         DEBUGF(SUFF, ("Expanding \"%s\"...", child->name));
1158         buf = Var_Subst(child->name, parent, TRUE);
1159         cp = Buf_Data(buf);
1160
1161         if (child->type & OP_ARCHV) {
1162                 /*
1163                  * Node was an archive(member) target, so we
1164                  * want to call on the Arch module to find the
1165                  * nodes for us, expanding variables in the
1166                  * parent's context.
1167                  */
1168                 Arch_ParseArchive(&cp, members, parent);
1169                 Buf_Destroy(buf, TRUE);
1170                 return;
1171         }
1172         /*
1173          * Break the result into a vector of strings whose nodes we can find,
1174          * then add those nodes to the members list.
1175          */
1176         for (start = cp; *start == ' ' || *start == '\t'; start++)
1177                 ;
1178
1179         for (cp = start; *cp != '\0'; cp++) {
1180                 if (*cp == ' ' || *cp == '\t') {
1181                         /*
1182                          * White-space -- terminate element, find the node,
1183                          * add it, skip any further spaces.
1184                          */
1185                         *cp++ = '\0';
1186                         Lst_AtEnd(members, Targ_FindNode(start, TARG_CREATE));
1187
1188                         while (*cp == ' ' || *cp == '\t') {
1189                                 cp++;
1190                         }
1191                         /*
1192                          * Adjust cp for increment at
1193                          * start of loop, but set start
1194                          * to first non-space.
1195                          */
1196                         start = cp--;
1197
1198                 } else if (*cp == '$') {
1199                         /*
1200                          * Start of a variable spec -- contact variable module
1201                          * to find the end so we can skip over it.
1202                          */
1203                         char    *junk;
1204                         size_t  len = 0;
1205                         Boolean doFree;
1206
1207                         junk = Var_Parse(cp, parent, TRUE, &len, &doFree);
1208                         if (junk != var_Error) {
1209                                 cp += len - 1;
1210                         }
1211                         if (doFree) {
1212                                 free(junk);
1213                         }
1214
1215                 } else if (*cp == '\\' && *cp != '\0') {
1216                         /*
1217                          * Escaped something -- skip over it
1218                          */
1219                         cp++;
1220                 }
1221         }
1222
1223         if (cp != start) {
1224                 /*
1225                  * Stuff left over -- add it to the
1226                  * list too
1227                  */
1228                 Lst_AtEnd(members, Targ_FindNode(start, TARG_CREATE));
1229         }
1230
1231         Buf_Destroy(buf, TRUE);
1232 }
1233
1234 /*-
1235  * The child node contains wildcards. Expand them and return a list of
1236  * expansions.
1237  */
1238 static void
1239 SuffExpandWildcards(GNode *child, Lst *members)
1240 {
1241         char    *cp;
1242         Lst     exp;    /* List of expansions */
1243         LstNode *ln;
1244         struct Path *path;      /* Search path along which to expand */
1245
1246         Lst_Init(members);
1247
1248         /*
1249          * Find a path along which to expand the word.
1250          *
1251          * If the word has a known suffix, use that path.
1252          * If it has no known suffix and we're allowed to use the null
1253          *   suffix, use its path.
1254          * Else use the default system search path.
1255          */
1256         LST_FOREACH(ln, &sufflist) {
1257                 if (SuffSuffIsSuffix(Lst_Datum(ln), child->name) != NULL)
1258                         break;
1259         }
1260
1261         DEBUGF(SUFF, ("Wildcard expanding \"%s\"...", child->name));
1262
1263         if (ln != NULL) {
1264                 Suff    *s = Lst_Datum(ln);
1265
1266                 DEBUGF(SUFF, ("suffix is \"%s\"...", s->name));
1267                 path = &s->searchPath;
1268         } else {
1269                 /*
1270                  * Use default search path
1271                  */
1272                 path = &dirSearchPath;
1273         }
1274
1275         /*
1276          * Expand the word along the chosen path
1277          */
1278         Lst_Init(&exp);
1279         Path_Expand(child->name, path, &exp);
1280
1281         while (!Lst_IsEmpty(&exp)) {
1282                 /*
1283                  * Fetch next expansion off the list and find its GNode
1284                  */
1285                 cp = Lst_DeQueue(&exp);
1286
1287                 DEBUGF(SUFF, ("%s...", cp));
1288                 Lst_AtEnd(members, Targ_FindNode(cp, TARG_CREATE));
1289         }
1290 }
1291
1292 /*-
1293  *-----------------------------------------------------------------------
1294  * SuffExpandChildren --
1295  *      Expand the names of any children of a given node that contain
1296  *      variable invocations or file wildcards into actual targets.
1297  *
1298  * Results:
1299  *      == 0 (continue)
1300  *
1301  * Side Effects:
1302  *      The expanded node is removed from the parent's list of children,
1303  *      and the parent's unmade counter is decremented, but other nodes
1304  *      may be added.
1305  *
1306  *-----------------------------------------------------------------------
1307  */
1308 static void
1309 SuffExpandChildren(GNode *parent, LstNode *current)
1310 {
1311         GNode   *cchild;        /* current child */
1312         GNode   *gn;
1313         LstNode *prev;          /* node after which to append new source */
1314         Lst     members;        /* expanded nodes */
1315
1316         if (current == NULL) {
1317                 /* start from begin of parent's children list */
1318                 current = Lst_First(&parent->children);
1319         }
1320
1321         while (current != NULL) {
1322                 cchild = Lst_Datum(current);
1323
1324                 /*
1325                  * First do variable expansion -- this takes precedence over
1326                  * wildcard expansion. If the result contains wildcards, they'll
1327                  * be gotten to later since the resulting words are tacked
1328                  * instead of the current child onto the children list.
1329                  *
1330                  * XXXHB what if cchild contains lib.a(t1.o t2.o t3.o) but
1331                  * no $?
1332                  */
1333                 if (strchr(cchild->name, '$') != NULL) {
1334                         SuffExpandVariables(parent, cchild, &members);
1335
1336                 } else if (Dir_HasWildcards(cchild->name)) {
1337                         SuffExpandWildcards(cchild, &members);
1338
1339                 } else {
1340                         /* nothing special just advance to next child */
1341                         current = LST_NEXT(current);
1342                         continue;
1343                 }
1344
1345                 /*
1346                  * New nodes effectively take the place of the child,
1347                  * so place them after the child
1348                  */
1349                 prev = current;
1350
1351                 /*
1352                  * Add all new elements to the parent node if they aren't
1353                  * already children of it.
1354                  */
1355                 while(!Lst_IsEmpty(&members)) {
1356                         gn = Lst_DeQueue(&members);
1357
1358                         DEBUGF(SUFF, ("%s...", gn->name));
1359                         if (Lst_Member(&parent->children, gn) == NULL) {
1360                                 Lst_Append(&parent->children, prev, gn);
1361                                 prev = Lst_Succ(prev);
1362                                 Lst_AtEnd(&gn->parents, parent);
1363                                 parent->unmade++;
1364                         }
1365                 }
1366
1367                 /*
1368                  * Now the source is expanded, remove it from the list
1369                  * of children to keep it from being processed.
1370                  * Advance to the next child.
1371                  */
1372                 prev = current;
1373                 current = LST_NEXT(current);
1374
1375                 parent->unmade--;
1376                 Lst_Remove(&parent->children, prev);
1377                 DEBUGF(SUFF, ("\n"));
1378         }
1379 }
1380
1381 /*-
1382  *-----------------------------------------------------------------------
1383  * SuffApplyTransform --
1384  *      Apply a transformation rule, given the source and target nodes
1385  *      and suffixes.
1386  *
1387  * Results:
1388  *      TRUE if successful, FALSE if not.
1389  *
1390  * Side Effects:
1391  *      The source and target are linked and the commands from the
1392  *      transformation are added to the target node's commands list.
1393  *      All attributes but OP_DEPMASK and OP_TRANSFORM are applied
1394  *      to the target. The target also inherits all the sources for
1395  *      the transformation rule.
1396  *
1397  *-----------------------------------------------------------------------
1398  */
1399 static Boolean
1400 SuffApplyTransform(GNode *tGn, GNode *sGn, Suff *t, Suff *s)
1401 {
1402         LstNode *ln;    /* General node */
1403         char    *tname; /* Name of transformation rule */
1404         GNode   *gn;    /* Node for same */
1405
1406         if (Lst_Member(&tGn->children, sGn) == NULL) {
1407                 /*
1408                  * Not already linked, so form the proper links between the
1409                  * target and source.
1410                  */
1411                 Lst_AtEnd(&tGn->children, sGn);
1412                 Lst_AtEnd(&sGn->parents, tGn);
1413                 tGn->unmade += 1;
1414         }
1415
1416         if ((sGn->type & OP_OPMASK) == OP_DOUBLEDEP) {
1417                 /*
1418                  * When a :: node is used as the implied source of a node,
1419                  * we have to link all its cohorts in as sources as well. Only
1420                  * the initial sGn gets the target in its iParents list, however
1421                  * as that will be sufficient to get the .IMPSRC variable set
1422                  * for tGn
1423                  */
1424                 for (ln = Lst_First(&sGn->cohorts); ln != NULL;
1425                     ln = Lst_Succ(ln)) {
1426                         gn = Lst_Datum(ln);
1427
1428                         if (Lst_Member(&tGn->children, gn) == NULL) {
1429                                 /*
1430                                  * Not already linked, so form the proper
1431                                  * links between the target and source.
1432                                  */
1433                                 Lst_AtEnd(&tGn->children, gn);
1434                                 Lst_AtEnd(&gn->parents, tGn);
1435                                 tGn->unmade += 1;
1436                         }
1437                 }
1438         }
1439         /*
1440          * Locate the transformation rule itself
1441          */
1442         tname = str_concat(s->name, '\0', t->name);
1443         gn = SuffTransFind(tname);
1444         free(tname);
1445
1446         if (gn == NULL) {
1447                 /*
1448                  * Not really such a transformation rule (can happen when we're
1449                  * called to link an OP_MEMBER and OP_ARCHV node), so return
1450                  * FALSE.
1451                  */
1452                 return (FALSE);
1453         }
1454
1455         DEBUGF(SUFF, ("\tapplying %s -> %s to \"%s\"\n",
1456             s->name, t->name, tGn->name));
1457
1458         /*
1459          * Record last child for expansion purposes
1460          */
1461         ln = Lst_Last(&tGn->children);
1462
1463         /*
1464          * Pass the buck to Make_HandleUse to apply the rule
1465          */
1466         Make_HandleUse(gn, tGn);
1467
1468         /*
1469          * Deal with wildcards and variables in any acquired sources
1470          */
1471         ln = Lst_Succ(ln);
1472         if (ln != NULL) {
1473                 SuffExpandChildren(tGn, ln);
1474         }
1475
1476         /*
1477          * Keep track of another parent to which this beast is transformed so
1478          * the .IMPSRC variable can be set correctly for the parent.
1479          */
1480         Lst_AtEnd(&sGn->iParents, tGn);
1481
1482         return (TRUE);
1483 }
1484
1485
1486 /*-
1487  *-----------------------------------------------------------------------
1488  * SuffFindArchiveDeps --
1489  *      Locate dependencies for an OP_ARCHV node.
1490  *
1491  * Results:
1492  *      None
1493  *
1494  * Side Effects:
1495  *      Same as Suff_FindDeps
1496  *
1497  *-----------------------------------------------------------------------
1498  */
1499 static void
1500 SuffFindArchiveDeps(GNode *gn, Lst *slst)
1501 {
1502         char    *eoarch;        /* End of archive portion */
1503         char    *eoname;        /* End of member portion */
1504         char    *name;          /* Start of member's name */
1505         GNode   *mem;           /* Node for member */
1506         Suff    *ms;            /* Suffix descriptor for member */
1507
1508         /*
1509          * The node is an archive(member) pair. so we must find a
1510          * suffix for both of them.
1511          */
1512         eoarch = strchr(gn->name, '(');
1513         eoname = strchr(eoarch, ')');
1514
1515         *eoname = '\0';   /* Nuke parentheses during suffix search */
1516         *eoarch = '\0';   /* So a suffix can be found */
1517
1518         name = eoarch + 1;
1519
1520         /*
1521          * To simplify things, call Suff_FindDeps recursively on the member now,
1522          * so we can simply compare the member's .PREFIX and .TARGET variables
1523          * to locate its suffix. This allows us to figure out the suffix to
1524          * use for the archive without having to do a quadratic search over the
1525          * suffix list, backtracking for each one...
1526          */
1527         mem = Targ_FindNode(name, TARG_CREATE);
1528         SuffFindDeps(mem, slst);
1529
1530         /*
1531          * Create the link between the two nodes right off
1532          */
1533         if (Lst_Member(&gn->children, mem) == NULL) {
1534                 Lst_AtEnd(&gn->children, mem);
1535                 Lst_AtEnd(&mem->parents, gn);
1536                 gn->unmade += 1;
1537         }
1538
1539         /*
1540          * Copy in the variables from the member node to this one.
1541          */
1542         Var_Set(PREFIX, Var_Value(PREFIX, mem), gn);
1543         Var_Set(TARGET, Var_Value(TARGET, mem), gn);
1544
1545         ms = mem->suffix;
1546         if (ms == NULL) {
1547                 /*
1548                  * Didn't know what it was -- use .NULL suffix if not in
1549                  * make mode
1550                  */
1551                 DEBUGF(SUFF, ("using null suffix\n"));
1552                 ms = suffNull;
1553         }
1554
1555
1556         /*
1557         * Set the other two local variables required for this target.
1558         */
1559         Var_Set(MEMBER, name, gn);
1560         Var_Set(ARCHIVE, gn->name, gn);
1561
1562         if (ms != NULL) {
1563                 /*
1564                  * Member has a known suffix, so look for a transformation rule
1565                  * from it to a possible suffix of the archive. Rather than
1566                  * searching through the entire list, we just look at suffixes
1567                  * to which the member's suffix may be transformed...
1568                  */
1569                 LstNode *ln;
1570
1571                 /*
1572                  * Use first matching suffix...
1573                  */
1574                 LST_FOREACH(ln, &ms->parents) {
1575                         if (SuffSuffIsSuffix(Lst_Datum(ln), gn->name) != NULL)
1576                                 break;
1577                 }
1578
1579                 if (ln != NULL) {
1580                         /*
1581                          * Got one -- apply it
1582                          */
1583                         if (!SuffApplyTransform(gn, mem, Lst_Datum(ln), ms)) {
1584                                 DEBUGF(SUFF, ("\tNo transformation from "
1585                                     "%s -> %s\n", ms->name,
1586                                     ((Suff *)Lst_Datum(ln))->name));
1587                         }
1588                 }
1589         }
1590
1591         /*
1592          * Replace the opening and closing parens now we've no need
1593          * of the separate pieces.
1594          */
1595         *eoarch = '(';
1596         *eoname = ')';
1597
1598         /*
1599          * Pretend gn appeared to the left of a dependency operator so
1600          * the user needn't provide a transformation from the member to the
1601          * archive.
1602          */
1603         if (OP_NOP(gn->type)) {
1604                 gn->type |= OP_DEPENDS;
1605         }
1606
1607         /*
1608          * Flag the member as such so we remember to look in the archive for
1609          * its modification time.
1610          */
1611         mem->type |= OP_MEMBER;
1612 }
1613
1614 /*-
1615  *-----------------------------------------------------------------------
1616  * SuffFindNormalDeps --
1617  *      Locate implicit dependencies for regular targets.
1618  *
1619  * Results:
1620  *      None.
1621  *
1622  * Side Effects:
1623  *      Same as Suff_FindDeps...
1624  *
1625  *-----------------------------------------------------------------------
1626  */
1627 static void
1628 SuffFindNormalDeps(GNode *gn, Lst *slst)
1629 {
1630         char    *eoname;        /* End of name */
1631         char    *sopref;        /* Start of prefix */
1632         LstNode *ln;            /* Next suffix node to check */
1633         Lst     srcs;           /* List of sources at which to look */
1634         Lst     targs;          /* List of targets to which things can be
1635                                  * transformed. They all have the same file,
1636                                  * but different suff and pref fields */
1637         Src     *bottom;        /* Start of found transformation path */
1638         Src     *src;           /* General Src pointer */
1639         char    *pref;          /* Prefix to use */
1640         Src     *targ;          /* General Src target pointer */
1641
1642         eoname = gn->name + strlen(gn->name);
1643         sopref = gn->name;
1644
1645         /*
1646          * Begin at the beginning...
1647          */
1648         ln = Lst_First(&sufflist);
1649         Lst_Init(&srcs);
1650         Lst_Init(&targs);
1651
1652         /*
1653          * We're caught in a catch-22 here. On the one hand, we want to use any
1654          * transformation implied by the target's sources, but we can't examine
1655          * the sources until we've expanded any variables/wildcards they may
1656          * hold, and we can't do that until we've set up the target's local
1657          * variables and we can't do that until we know what the proper suffix
1658          * for the target is (in case there are two suffixes one of which is a
1659          * suffix of the other) and we can't know that until we've found its
1660          * implied source, which we may not want to use if there's an existing
1661          * source that implies a different transformation.
1662          *
1663          * In an attempt to get around this, which may not work all the time,
1664          * but should work most of the time, we look for implied sources first,
1665          * checking transformations to all possible suffixes of the target,
1666          * use what we find to set the target's local variables, expand the
1667          * children, then look for any overriding transformations they imply.
1668          * Should we find one, we discard the one we found before.
1669          */
1670
1671         while (ln != NULL) {
1672                 /*
1673                  * Look for next possible suffix...
1674                  */
1675                 while (ln != NULL) {
1676                         if (SuffSuffIsSuffix(Lst_Datum(ln), gn->name) != NULL)
1677                                 break;
1678                         ln = LST_NEXT(ln);
1679                 }
1680                                 
1681                 if (ln != NULL) {
1682                         int     prefLen;        /* Length of the prefix */
1683                         Src     *target;
1684
1685                         /*
1686                          * Allocate a Src structure to which things can be
1687                          * transformed
1688                          */
1689                         target = SuffSrcCreate(estrdup(gn->name), NULL,
1690                             Lst_Datum(ln), NULL, gn);
1691                         target->suff->refCount++;
1692
1693                         /*
1694                          * Allocate room for the prefix, whose end is found
1695                          * by subtracting the length of the suffix from
1696                          * the end of the name.
1697                          */
1698                         prefLen = (eoname - target->suff->nameLen) - sopref;
1699                         assert(prefLen >= 0);
1700                         target->pref = emalloc(prefLen + 1);
1701                         memcpy(target->pref, sopref, prefLen);
1702                         target->pref[prefLen] = '\0';
1703
1704                         /*
1705                          * Add nodes from which the target can be made
1706                          */
1707                         SuffAddLevel(&srcs, target);
1708
1709                         /*
1710                          * Record the target so we can nuke it
1711                          */
1712                         Lst_AtEnd(&targs, target);
1713
1714                         /*
1715                          * Search from this suffix's successor...
1716                          */
1717                         ln = Lst_Succ(ln);
1718                 }
1719         }
1720
1721         /*
1722          * Handle target of unknown suffix...
1723          */
1724         if (Lst_IsEmpty(&targs) && suffNull != NULL) {
1725                 DEBUGF(SUFF, ("\tNo known suffix on %s. Using .NULL suffix\n",
1726                     gn->name));
1727
1728                 targ = SuffSrcCreate(estrdup(gn->name), estrdup(sopref),
1729                     suffNull, NULL, gn);
1730                 targ->suff->refCount++;
1731
1732                 /*
1733                  * Only use the default suffix rules if we don't have commands
1734                  * or dependencies defined for this gnode
1735                  */
1736                 if (Lst_IsEmpty(&gn->commands) && Lst_IsEmpty(&gn->children))
1737                         SuffAddLevel(&srcs, targ);
1738                 else {
1739                         DEBUGF(SUFF, ("not "));
1740                 }
1741
1742                 DEBUGF(SUFF, ("adding suffix rules\n"));
1743
1744                 Lst_AtEnd(&targs, targ);
1745         }
1746
1747         /*
1748          * Using the list of possible sources built up from the target
1749          * suffix(es), try and find an existing file/target that matches.
1750          */
1751         bottom = SuffFindThem(&srcs, slst);
1752
1753         if (bottom == NULL) {
1754                 /*
1755                  * No known transformations -- use the first suffix found for
1756                  * setting the local variables.
1757                  */
1758                 if (!Lst_IsEmpty(&targs)) {
1759                         targ = Lst_Datum(Lst_First(&targs));
1760                 } else {
1761                         targ = NULL;
1762                 }
1763         } else {
1764                 /*
1765                  * Work up the transformation path to find the suffix of the
1766                  * target to which the transformation was made.
1767                  */
1768                 for (targ = bottom; targ->parent != NULL; targ = targ->parent)
1769                         continue;
1770         }
1771
1772         /*
1773          * The .TARGET variable we always set to be the name at this point,
1774          * since it's only set to the path if the thing is only a source and
1775          * if it's only a source, it doesn't matter what we put here as far
1776          * as expanding sources is concerned, since it has none...
1777          */
1778         Var_Set(TARGET, gn->name, gn);
1779
1780         pref = (targ != NULL) ? targ->pref : gn->name;
1781         Var_Set(PREFIX, pref, gn);
1782
1783         /*
1784          * Now we've got the important local variables set, expand any sources
1785          * that still contain variables or wildcards in their names.
1786          */
1787         SuffExpandChildren(gn, NULL);
1788
1789         if (targ == NULL) {
1790                 DEBUGF(SUFF, ("\tNo valid suffix on %s\n", gn->name));
1791
1792   sfnd_abort:
1793                 /*
1794                  * Deal with finding the thing on the default search path if the
1795                  * node is only a source (not on the lhs of a dependency
1796                  * operator or [XXX] it has neither children or commands).
1797                  */
1798                 if (OP_NOP(gn->type) || (Lst_IsEmpty(&gn->children) &&
1799                     Lst_IsEmpty(&gn->commands))) {
1800                         gn->path = Path_FindFile(gn->name,
1801                             (targ == NULL ? &dirSearchPath :
1802                             &targ->suff->searchPath));
1803                         if (gn->path != NULL) {
1804                                 char *ptr;
1805                                 Var_Set(TARGET, gn->path, gn);
1806
1807                                 if (targ != NULL) {
1808                                         /*
1809                                          * Suffix known for the thing -- trim
1810                                          * the suffix off the path to form the
1811                                          * proper .PREFIX variable.
1812                                          */
1813                                         int     savep = strlen(gn->path) -
1814                                                     targ->suff->nameLen;
1815                                         char    savec;
1816
1817                                         if (gn->suffix)
1818                                                 gn->suffix->refCount--;
1819                                         gn->suffix = targ->suff;
1820                                         gn->suffix->refCount++;
1821
1822                                         savec = gn->path[savep];
1823                                         gn->path[savep] = '\0';
1824
1825                                         if ((ptr = strrchr(gn->path, '/')) != NULL)
1826                                                 ptr++;
1827                                         else
1828                                                 ptr = gn->path;
1829
1830                                         Var_Set(PREFIX, ptr, gn);
1831
1832                                         gn->path[savep] = savec;
1833                                 } else {
1834                                         /*
1835                                          * The .PREFIX gets the full path if
1836                                          * the target has no known suffix.
1837                                          */
1838                                         if (gn->suffix)
1839                                                 gn->suffix->refCount--;
1840                                         gn->suffix = NULL;
1841
1842                                         if ((ptr = strrchr(gn->path, '/')) != NULL)
1843                                                 ptr++;
1844                                         else
1845                                                 ptr = gn->path;
1846
1847                                         Var_Set(PREFIX, ptr, gn);
1848                                 }
1849                         }
1850                 } else {
1851                         /*
1852                          * Not appropriate to search for the thing -- set the
1853                          * path to be the name so Dir_MTime won't go
1854                          * grovelling for it.
1855                          */
1856                         if (gn->suffix)
1857                                 gn->suffix->refCount--;
1858                         gn->suffix = (targ == NULL) ? NULL : targ->suff;
1859                         if (gn->suffix)
1860                                 gn->suffix->refCount++;
1861                         free(gn->path);
1862                         gn->path = estrdup(gn->name);
1863                 }
1864
1865                 goto sfnd_return;
1866         }
1867
1868         /*
1869          * If the suffix indicates that the target is a library, mark that in
1870          * the node's type field.
1871          */
1872         if (targ->suff->flags & SUFF_LIBRARY) {
1873                 gn->type |= OP_LIB;
1874         }
1875
1876         /*
1877          * Check for overriding transformation rule implied by sources
1878          */
1879         if (!Lst_IsEmpty(&gn->children)) {
1880                 src = SuffFindCmds(targ, slst);
1881
1882                 if (src != NULL) {
1883                         /*
1884                          * Free up all the Src structures in the
1885                          * transformation path up to, but not including,
1886                          * the parent node.
1887                          */
1888                         while (bottom && bottom->parent != NULL) {
1889                                 if (Lst_Member(slst, bottom) == NULL) {
1890                                         Lst_AtEnd(slst, bottom);
1891                                 }
1892                                 bottom = bottom->parent;
1893                         }
1894                         bottom = src;
1895                 }
1896         }
1897
1898         if (bottom == NULL) {
1899                 /*
1900                  * No idea from where it can come -- return now.
1901                  */
1902                 goto sfnd_abort;
1903         }
1904
1905         /*
1906          * We now have a list of Src structures headed by 'bottom' and linked
1907          * via their 'parent' pointers. What we do next is create links between
1908          * source and target nodes (which may or may not have been created)
1909          * and set the necessary local variables in each target. The
1910          * commands for each target are set from the commands of the
1911          * transformation rule used to get from the src suffix to the targ
1912          * suffix. Note that this causes the commands list of the original
1913          * node, gn, to be replaced by the commands of the final
1914          * transformation rule. Also, the unmade field of gn is incremented.
1915          * Etc.
1916          */
1917         if (bottom->node == NULL) {
1918                 bottom->node = Targ_FindNode(bottom->file, TARG_CREATE);
1919         }
1920
1921         for (src = bottom; src->parent != NULL; src = src->parent) {
1922                 targ = src->parent;
1923
1924                 if (src->node->suffix)
1925                         src->node->suffix->refCount--;
1926                 src->node->suffix = src->suff;
1927                 src->node->suffix->refCount++;
1928
1929                 if (targ->node == NULL) {
1930                         targ->node = Targ_FindNode(targ->file, TARG_CREATE);
1931                 }
1932
1933                 SuffApplyTransform(targ->node, src->node,
1934                     targ->suff, src->suff);
1935
1936                 if (targ->node != gn) {
1937                         /*
1938                          * Finish off the dependency-search process for any
1939                          * nodes between bottom and gn (no point in questing
1940                          * around the filesystem for their implicit source
1941                          * when it's already known). Note that the node can't
1942                          * have any sources that need expanding, since
1943                          * SuffFindThem will stop on an existing
1944                          * node, so all we need to do is set the standard and
1945                          * System V variables.
1946                          */
1947                         targ->node->type |= OP_DEPS_FOUND;
1948
1949                         Var_Set(PREFIX, targ->pref, targ->node);
1950                         Var_Set(TARGET, targ->node->name, targ->node);
1951                 }
1952         }
1953
1954         if (gn->suffix)
1955                 gn->suffix->refCount--;
1956         gn->suffix = src->suff;
1957         gn->suffix->refCount++;
1958
1959         /*
1960          * So Dir_MTime doesn't go questing for it...
1961          */
1962         free(gn->path);
1963         gn->path = estrdup(gn->name);
1964
1965         /*
1966          * Nuke the transformation path and the Src structures left over in the
1967          * two lists.
1968          */
1969   sfnd_return:
1970         if (bottom)
1971                 if (Lst_Member(slst, bottom) == NULL)
1972                         Lst_AtEnd(slst, bottom);
1973
1974         while (SuffRemoveSrc(&srcs) || SuffRemoveSrc(&targs))
1975                 continue;
1976
1977         Lst_Concat(slst, &srcs, LST_CONCLINK);
1978         Lst_Concat(slst, &targs, LST_CONCLINK);
1979 }
1980
1981 /*-
1982  *-----------------------------------------------------------------------
1983  * Suff_FindDeps  --
1984  *      Find implicit sources for the target described by the graph node
1985  *      gn
1986  *
1987  * Results:
1988  *      Nothing.
1989  *
1990  * Side Effects:
1991  *      Nodes are added to the graph below the passed-in node. The nodes
1992  *      are marked to have their IMPSRC variable filled in. The
1993  *      PREFIX variable is set for the given node and all its
1994  *      implied children.
1995  *
1996  * Notes:
1997  *      The path found by this target is the shortest path in the
1998  *      transformation graph, which may pass through non-existent targets,
1999  *      to an existing target. The search continues on all paths from the
2000  *      root suffix until a file is found. I.e. if there's a path
2001  *      .o -> .c -> .l -> .l,v from the root and the .l,v file exists but
2002  *      the .c and .l files don't, the search will branch out in
2003  *      all directions from .o and again from all the nodes on the
2004  *      next level until the .l,v node is encountered.
2005  *
2006  *-----------------------------------------------------------------------
2007  */
2008 void
2009 Suff_FindDeps(GNode *gn)
2010 {
2011
2012         SuffFindDeps(gn, &srclist);
2013         while (SuffRemoveSrc(&srclist))
2014                 continue;
2015 }
2016
2017
2018 static void
2019 SuffFindDeps(GNode *gn, Lst *slst)
2020 {
2021
2022         if (gn->type & OP_DEPS_FOUND) {
2023                 /*
2024                  * If dependencies already found, no need to do it again...
2025                  */
2026                 return;
2027         } else {
2028                 gn->type |= OP_DEPS_FOUND;
2029         }
2030
2031         DEBUGF(SUFF, ("SuffFindDeps (%s)\n", gn->name));
2032
2033         if (gn->type & OP_ARCHV) {
2034                 SuffFindArchiveDeps(gn, slst);
2035
2036         } else if (gn->type & OP_LIB) {
2037                 /*
2038                 * If the node is a library, it is the arch module's job to find
2039                 * it and set the TARGET variable accordingly. We merely provide
2040                 * the search path, assuming all libraries end in ".a" (if the
2041                 * suffix hasn't been defined, there's nothing we can do for it,
2042                 * so we just set the TARGET variable to the node's name in order
2043                 * to give it a value).
2044                 */
2045                 Suff    *s;
2046
2047                 s = SuffSuffFind(LIBSUFF);
2048                 if (gn->suffix)
2049                         gn->suffix->refCount--;
2050                 if (s != NULL) {
2051                         gn->suffix = s;
2052                         gn->suffix->refCount++;
2053                         Arch_FindLib(gn, &s->searchPath);
2054                 } else {
2055                         gn->suffix = NULL;
2056                         Var_Set(TARGET, gn->name, gn);
2057                 }
2058
2059                 /*
2060                 * Because a library (-lfoo) target doesn't follow the standard
2061                 * filesystem conventions, we don't set the regular variables for
2062                 * the thing. .PREFIX is simply made empty...
2063                 */
2064                 Var_Set(PREFIX, "", gn);
2065
2066         } else {
2067                 SuffFindNormalDeps(gn, slst);
2068         }
2069 }
2070
2071 /*-
2072  *-----------------------------------------------------------------------
2073  * Suff_SetNull --
2074  *      Define which suffix is the null suffix.
2075  *
2076  * Results:
2077  *      None.
2078  *
2079  * Side Effects:
2080  *      'suffNull' is altered.
2081  *
2082  * Notes:
2083  *      Need to handle the changing of the null suffix gracefully so the
2084  *      old transformation rules don't just go away.
2085  *
2086  *-----------------------------------------------------------------------
2087  */
2088 void
2089 Suff_SetNull(char *name)
2090 {
2091         Suff    *s;
2092
2093         if ((s = SuffSuffFind(name)) == NULL) {
2094                 Parse_Error(PARSE_WARNING, "Desired null suffix %s "
2095                     "not defined.", name);
2096                 return;
2097         }
2098
2099         if (suffNull != NULL) {
2100                 suffNull->flags &= ~SUFF_NULL;
2101         }
2102         s->flags |= SUFF_NULL;
2103
2104         /*
2105          * XXX: Here's where the transformation mangling
2106          * would take place
2107          */
2108         suffNull = s;
2109 }
2110
2111 /*-
2112  *-----------------------------------------------------------------------
2113  * Suff_Init --
2114  *      Initialize suffixes module
2115  *
2116  * Results:
2117  *      None
2118  *
2119  * Side Effects:
2120  *      Many
2121  *-----------------------------------------------------------------------
2122  */
2123 void
2124 Suff_Init(void)
2125 {
2126
2127         sNum = 0;
2128         /*
2129         * Create null suffix for single-suffix rules (POSIX). The thing doesn't
2130         * actually go on the suffix list or everyone will think that's its
2131         * suffix.
2132         */
2133         emptySuff = suffNull = emalloc(sizeof(Suff));
2134
2135         suffNull->name = estrdup("");
2136         suffNull->nameLen = 0;
2137         TAILQ_INIT(&suffNull->searchPath);
2138         Path_Concat(&suffNull->searchPath, &dirSearchPath);
2139         Lst_Init(&suffNull->children);
2140         Lst_Init(&suffNull->parents);
2141         Lst_Init(&suffNull->ref);
2142         suffNull->sNum = sNum++;
2143         suffNull->flags = SUFF_NULL;
2144         suffNull->refCount = 1;
2145 }
2146
2147 /********************* DEBUGGING FUNCTIONS **********************/
2148
2149 void
2150 Suff_PrintAll(void)
2151 {
2152         const LstNode   *ln;
2153         const LstNode   *tln;
2154         const GNode     *gn;
2155         const Suff      *s;
2156
2157         static const struct flag2str suff_flags[] = {
2158                 { SUFF_INCLUDE, "INCLUDE" },
2159                 { SUFF_LIBRARY, "LIBRARY" },
2160                 { SUFF_NULL,    "NULL" },
2161                 { 0,            NULL }
2162         };
2163
2164         printf("#*** Suffixes:\n");
2165         LST_FOREACH(ln, &sufflist) {
2166                 s = Lst_Datum(ln);
2167                 printf("# `%s' [%d] ", s->name, s->refCount);
2168
2169                 if (s->flags != 0) {
2170                         printf(" ");
2171                         print_flags(stdout, suff_flags, s->flags, 1);
2172                 }
2173
2174                 printf("\n#\tTo: ");
2175                 LST_FOREACH(tln, &s->parents)
2176                         printf("`%s' ", ((const Suff *)Lst_Datum(tln))->name);
2177
2178                 printf("\n#\tFrom: ");
2179                 LST_FOREACH(tln, &s->children)
2180                         printf("`%s' ", ((const Suff *)Lst_Datum(tln))->name);
2181
2182                 printf("\n#\tSearch Path: ");
2183                 Path_Print(&s->searchPath);
2184
2185                 printf("\n");
2186         }
2187
2188         printf("#*** Transformations:\n");
2189         LST_FOREACH(ln, &transforms) {
2190                 gn = Lst_Datum(ln);
2191                 printf("%-16s: ", gn->name);
2192                 Targ_PrintType(gn->type);
2193                 printf("\n");
2194                 LST_FOREACH(tln, &gn->commands)
2195                         printf("\t%s\n", (const char *)Lst_Datum(tln));
2196                 printf("\n");
2197         }
2198 }