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