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