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