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