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