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