2058f09e8cdd708d8583fe3454dfc250cb97a43f
[dragonfly.git] / usr.bin / make / make.h
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  *      from: @(#)make.h        8.3 (Berkeley) 6/13/95
39  * $FreeBSD: src/usr.bin/make/make.h,v 1.12.2.2 2001/02/13 03:13:58 will Exp $
40  * $DragonFly: src/usr.bin/make/make.h,v 1.2 2003/06/17 04:29:29 dillon Exp $
41  */
42
43 /*-
44  * make.h --
45  *      The global definitions for pmake
46  */
47
48 #ifndef _MAKE_H_
49 #define _MAKE_H_
50
51 #include <sys/types.h>
52 #include <stdio.h>
53 #include <string.h>
54 #include <ctype.h>
55 #include <err.h>
56
57 #if !defined(MAKE_BOOTSTRAP) && defined(BSD4_4)
58 # include <sys/cdefs.h>
59 #else
60 # ifndef __P
61 #  if defined(__STDC__) || defined(__cplusplus)
62 #   define      __P(protos)     protos          /* full-blown ANSI C */
63 #  else
64 #   define      __P(protos)     ()              /* traditional C preprocessor */
65 #  endif
66 # endif
67 # ifndef __STDC__
68 #  ifndef const
69 #   define const
70 #  endif
71 #  ifndef volatile
72 #   define volatile
73 #  endif
74 # endif
75 #endif
76
77 #ifdef __STDC__
78 #include <stdlib.h>
79 #include <unistd.h>
80 #endif
81 #include "sprite.h"
82 #include "lst.h"
83 #include "config.h"
84 #include "buf.h"
85
86 /*-
87  * The structure for an individual graph node. Each node has several
88  * pieces of data associated with it.
89  *      1) the name of the target it describes
90  *      2) the location of the target file in the file system.
91  *      3) the type of operator used to define its sources (qv. parse.c)
92  *      4) whether it is involved in this invocation of make
93  *      5) whether the target has been remade
94  *      6) whether any of its children has been remade
95  *      7) the number of its children that are, as yet, unmade
96  *      8) its modification time
97  *      9) the modification time of its youngest child (qv. make.c)
98  *      10) a list of nodes for which this is a source
99  *      11) a list of nodes on which this depends
100  *      12) a list of nodes that depend on this, as gleaned from the
101  *          transformation rules.
102  *      13) a list of nodes of the same name created by the :: operator
103  *      14) a list of nodes that must be made (if they're made) before
104  *          this node can be, but that do no enter into the datedness of
105  *          this node.
106  *      15) a list of nodes that must be made (if they're made) after
107  *          this node is, but that do not depend on this node, in the
108  *          normal sense.
109  *      16) a Lst of ``local'' variables that are specific to this target
110  *         and this target only (qv. var.c [$@ $< $?, etc.])
111  *      17) a Lst of strings that are commands to be given to a shell
112  *         to create this target.
113  */
114 typedef struct GNode {
115     char            *name;      /* The target's name */
116     char            *path;      /* The full pathname of the file */
117     int             type;       /* Its type (see the OP flags, below) */
118     int             order;      /* Its wait weight */
119
120     Boolean         make;       /* TRUE if this target needs to be remade */
121     enum {
122         UNMADE, BEINGMADE, MADE, UPTODATE, ERROR, ABORTED,
123         CYCLE, ENDCYCLE
124     }               made;       /* Set to reflect the state of processing
125                                  * on this node:
126                                  *  UNMADE - Not examined yet
127                                  *  BEINGMADE - Target is already being made.
128                                  *      Indicates a cycle in the graph. (compat
129                                  *      mode only)
130                                  *  MADE - Was out-of-date and has been made
131                                  *  UPTODATE - Was already up-to-date
132                                  *  ERROR - An error occured while it was being
133                                  *      made (used only in compat mode)
134                                  *  ABORTED - The target was aborted due to
135                                  *      an error making an inferior (compat).
136                                  *  CYCLE - Marked as potentially being part of
137                                  *      a graph cycle. If we come back to a
138                                  *      node marked this way, it is printed
139                                  *      and 'made' is changed to ENDCYCLE.
140                                  *  ENDCYCLE - the cycle has been completely
141                                  *      printed. Go back and unmark all its
142                                  *      members.
143                                  */
144     Boolean         childMade;  /* TRUE if one of this target's children was
145                                  * made */
146     int             unmade;     /* The number of unmade children */
147
148     int             mtime;      /* Its modification time */
149     int             cmtime;     /* The modification time of its youngest
150                                  * child */
151
152     Lst             iParents;   /* Links to parents for which this is an
153                                  * implied source, if any */
154     Lst             cohorts;    /* Other nodes for the :: operator */
155     Lst             parents;    /* Nodes that depend on this one */
156     Lst             children;   /* Nodes on which this one depends */
157     Lst             successors; /* Nodes that must be made after this one */
158     Lst             preds;      /* Nodes that must be made before this one */
159
160     Lst             context;    /* The local variables */
161     Lst             commands;   /* Creation commands */
162
163     struct _Suff    *suffix;    /* Suffix for the node (determined by
164                                  * Suff_FindDeps and opaque to everyone
165                                  * but the Suff module) */
166 } GNode;
167
168 /*
169  * Manifest constants
170  */
171 #define NILGNODE        ((GNode *) NIL)
172
173 /*
174  * The OP_ constants are used when parsing a dependency line as a way of
175  * communicating to other parts of the program the way in which a target
176  * should be made. These constants are bitwise-OR'ed together and
177  * placed in the 'type' field of each node. Any node that has
178  * a 'type' field which satisfies the OP_NOP function was never never on
179  * the lefthand side of an operator, though it may have been on the
180  * righthand side...
181  */
182 #define OP_DEPENDS      0x00000001  /* Execution of commands depends on
183                                      * kids (:) */
184 #define OP_FORCE        0x00000002  /* Always execute commands (!) */
185 #define OP_DOUBLEDEP    0x00000004  /* Execution of commands depends on kids
186                                      * per line (::) */
187 #define OP_OPMASK       (OP_DEPENDS|OP_FORCE|OP_DOUBLEDEP)
188
189 #define OP_OPTIONAL     0x00000008  /* Don't care if the target doesn't
190                                      * exist and can't be created */
191 #define OP_USE          0x00000010  /* Use associated commands for parents */
192 #define OP_EXEC         0x00000020  /* Target is never out of date, but always
193                                      * execute commands anyway. Its time
194                                      * doesn't matter, so it has none...sort
195                                      * of */
196 #define OP_IGNORE       0x00000040  /* Ignore errors when creating the node */
197 #define OP_PRECIOUS     0x00000080  /* Don't remove the target when
198                                      * interrupted */
199 #define OP_SILENT       0x00000100  /* Don't echo commands when executed */
200 #define OP_MAKE         0x00000200  /* Target is a recurrsive make so its
201                                      * commands should always be executed when
202                                      * it is out of date, regardless of the
203                                      * state of the -n or -t flags */
204 #define OP_JOIN         0x00000400  /* Target is out-of-date only if any of its
205                                      * children was out-of-date */
206 #define OP_INVISIBLE    0x00004000  /* The node is invisible to its parents.
207                                      * I.e. it doesn't show up in the parents's
208                                      * local variables. */
209 #define OP_NOTMAIN      0x00008000  /* The node is exempt from normal 'main
210                                      * target' processing in parse.c */
211 #define OP_PHONY        0x00010000  /* Not a file target; run always */
212 /* Attributes applied by PMake */
213 #define OP_TRANSFORM    0x80000000  /* The node is a transformation rule */
214 #define OP_MEMBER       0x40000000  /* Target is a member of an archive */
215 #define OP_LIB          0x20000000  /* Target is a library */
216 #define OP_ARCHV        0x10000000  /* Target is an archive construct */
217 #define OP_HAS_COMMANDS 0x08000000  /* Target has all the commands it should.
218                                      * Used when parsing to catch multiple
219                                      * commands for a target */
220 #define OP_SAVE_CMDS    0x04000000  /* Saving commands on .END (Compat) */
221 #define OP_DEPS_FOUND   0x02000000  /* Already processed by Suff_FindDeps */
222
223 /*
224  * OP_NOP will return TRUE if the node with the given type was not the
225  * object of a dependency operator
226  */
227 #define OP_NOP(t)       (((t) & OP_OPMASK) == 0x00000000)
228
229 /*
230  * The TARG_ constants are used when calling the Targ_FindNode and
231  * Targ_FindList functions in targ.c. They simply tell the functions what to
232  * do if the desired node(s) is (are) not found. If the TARG_CREATE constant
233  * is given, a new, empty node will be created for the target, placed in the
234  * table of all targets and its address returned. If TARG_NOCREATE is given,
235  * a NIL pointer will be returned.
236  */
237 #define TARG_CREATE     0x01      /* create node if not found */
238 #define TARG_NOCREATE   0x00      /* don't create it */
239
240 /*
241  * There are several places where expandable buffers are used (parse.c and
242  * var.c). This constant is merely the starting point for those buffers. If
243  * lines tend to be much shorter than this, it would be best to reduce BSIZE.
244  * If longer, it should be increased. Reducing it will cause more copying to
245  * be done for longer lines, but will save space for shorter ones. In any
246  * case, it ought to be a power of two simply because most storage allocation
247  * schemes allocate in powers of two.
248  */
249 #define MAKE_BSIZE              256     /* starting size for expandable buffers */
250
251 /*
252  * These constants are all used by the Str_Concat function to decide how the
253  * final string should look. If STR_ADDSPACE is given, a space will be
254  * placed between the two strings. If STR_ADDSLASH is given, a '/' will
255  * be used instead of a space. If neither is given, no intervening characters
256  * will be placed between the two strings in the final output. If the
257  * STR_DOFREE bit is set, the two input strings will be freed before
258  * Str_Concat returns.
259  */
260 #define STR_ADDSPACE    0x01    /* add a space when Str_Concat'ing */
261 #define STR_DOFREE      0x02    /* free source strings after concatenation */
262 #define STR_ADDSLASH    0x04    /* add a slash when Str_Concat'ing */
263
264 /*
265  * Error levels for parsing. PARSE_FATAL means the process cannot continue
266  * once the makefile has been parsed. PARSE_WARNING means it can. Passed
267  * as the first argument to Parse_Error.
268  */
269 #define PARSE_WARNING   2
270 #define PARSE_FATAL     1
271
272 /*
273  * Values returned by Cond_Eval.
274  */
275 #define COND_PARSE      0       /* Parse the next lines */
276 #define COND_SKIP       1       /* Skip the next lines */
277 #define COND_INVALID    2       /* Not a conditional statement */
278
279 /*
280  * Definitions for the "local" variables. Used only for clarity.
281  */
282 #define TARGET            "@"   /* Target of dependency */
283 #define OODATE            "?"   /* All out-of-date sources */
284 #define ALLSRC            ">"   /* All sources */
285 #define IMPSRC            "<"   /* Source implied by transformation */
286 #define PREFIX            "*"   /* Common prefix */
287 #define ARCHIVE           "!"   /* Archive in "archive(member)" syntax */
288 #define MEMBER            "%"   /* Member in "archive(member)" syntax */
289
290 #define FTARGET           "@F"  /* file part of TARGET */
291 #define DTARGET           "@D"  /* directory part of TARGET */
292 #define FIMPSRC           "<F"  /* file part of IMPSRC */
293 #define DIMPSRC           "<D"  /* directory part of IMPSRC */
294 #define FPREFIX           "*F"  /* file part of PREFIX */
295 #define DPREFIX           "*D"  /* directory part of PREFIX */
296
297 /*
298  * Global Variables
299  */
300 extern Lst      create;         /* The list of target names specified on the
301                                  * command line. used to resolve #if
302                                  * make(...) statements */
303 extern Lst      dirSearchPath;  /* The list of directories to search when
304                                  * looking for targets */
305
306 extern Boolean  compatMake;     /* True if we are make compatible */
307 extern Boolean  ignoreErrors;   /* True if should ignore all errors */
308 extern Boolean  beSilent;       /* True if should print no commands */
309 extern Boolean  beVerbose;      /* True if should print extra cruft */
310 extern Boolean  noExecute;      /* True if should execute nothing */
311 extern Boolean  allPrecious;    /* True if every target is precious */
312 extern Boolean  keepgoing;      /* True if should continue on unaffected
313                                  * portions of the graph when have an error
314                                  * in one portion */
315 extern Boolean  touchFlag;      /* TRUE if targets should just be 'touched'
316                                  * if out of date. Set by the -t flag */
317 extern Boolean  usePipes;       /* TRUE if should capture the output of
318                                  * subshells by means of pipes. Otherwise it
319                                  * is routed to temporary files from which it
320                                  * is retrieved when the shell exits */
321 extern Boolean  queryFlag;      /* TRUE if we aren't supposed to really make
322                                  * anything, just see if the targets are out-
323                                  * of-date */
324
325 extern Boolean  checkEnvFirst;  /* TRUE if environment should be searched for
326                                  * all variables before the global context */
327 extern Lst      envFirstVars;   /* List of specific variables for which the
328                                  * environment should be searched before the
329                                  * global context */
330
331 extern GNode    *DEFAULT;       /* .DEFAULT rule */
332
333 extern GNode    *VAR_GLOBAL;    /* Variables defined in a global context, e.g
334                                  * in the Makefile itself */
335 extern GNode    *VAR_CMD;       /* Variables defined on the command line */
336 extern char     var_Error[];    /* Value returned by Var_Parse when an error
337                                  * is encountered. It actually points to
338                                  * an empty string, so naive callers needn't
339                                  * worry about it. */
340
341 extern time_t   now;            /* The time at the start of this whole
342                                  * process */
343
344 extern Boolean  oldVars;        /* Do old-style variable substitution */
345
346 extern Lst      sysIncPath;     /* The system include path. */
347
348 /*
349  * debug control:
350  *      There is one bit per module.  It is up to the module what debug
351  *      information to print.
352  */
353 extern int debug;
354 #define DEBUG_ARCH      0x0001
355 #define DEBUG_COND      0x0002
356 #define DEBUG_DIR       0x0004
357 #define DEBUG_GRAPH1    0x0008
358 #define DEBUG_GRAPH2    0x0010
359 #define DEBUG_JOB       0x0020
360 #define DEBUG_MAKE      0x0040
361 #define DEBUG_SUFF      0x0080
362 #define DEBUG_TARG      0x0100
363 #define DEBUG_VAR       0x0200
364 #define DEBUG_FOR       0x0400
365 #define DEBUG_LOUD      0x0800
366
367 #ifdef __STDC__
368 #define CONCAT(a,b)     a##b
369 #else
370 #define I(a)            a
371 #define CONCAT(a,b)     I(a)b
372 #endif /* __STDC__ */
373
374 #define DEBUG(module)   (debug & CONCAT(DEBUG_,module))
375 #define ISDOT(c) ((c)[0] == '.' && (((c)[1] == '\0') || ((c)[1] == '/')))
376 #define ISDOTDOT(c) ((c)[0] == '.' && ISDOT(&((c)[1])))
377
378 /*
379  * Since there are so many, all functions that return non-integer values are
380  * extracted by means of a sed script or two and stuck in the file "nonints.h"
381  */
382 #include "nonints.h"
383
384 int Make_TimeStamp __P((GNode *, GNode *));
385 Boolean Make_OODate __P((GNode *));
386 int Make_HandleUse __P((GNode *, GNode *));
387 void Make_Update __P((GNode *));
388 void Make_DoAllVar __P((GNode *));
389 Boolean Make_Run __P((Lst));
390
391 #endif /* _MAKE_H_ */