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