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