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