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