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