make.h

   1 /* Miscellaneous global declarations and portability cruft for GNU Make.
   2 Copyright (C) 1988,89,90,91,92,93,94,95,96,97,99 Free Software Foundation, Inc.
   3 This file is part of GNU Make.
   4
   5 GNU Make is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2, or (at your option)
   8 any later version.
   9
  10 GNU Make is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with GNU Make; see the file COPYING.  If not, write to
  17 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18 Boston, MA 02111-1307, USA.  */
  19
  20 /* AIX requires this to be the first thing in the file.  */
  21 #if defined (_AIX) && !defined (__GNUC__)
  22  #pragma alloca
  23 #endif
  24
  25 /* We use <config.h> instead of "config.h" so that a compilation
  26    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
  27    (which it would do because make.h was found in $srcdir).  */
  28 #include <config.h>
  29 #undef  HAVE_CONFIG_H
  30 #define HAVE_CONFIG_H 1
  31
  32
  33 /* Use prototypes if available.  */
  34 #if defined (__cplusplus) || (defined (__STDC__) && __STDC__)
  35 # undef  PARAMS
  36 # define PARAMS(protos)  protos
  37 #else /* Not C++ or ANSI C.  */
  38 # undef  PARAMS
  39 # define PARAMS(protos)  ()
  40 #endif /* C++ or ANSI C.  */
  41
  42
  43 #include "gettext.h"
  44 #define _(Text)     gettext (Text)
  45 #define N_(Text)    gettext_noop (Text)
  46
  47 #if !HAVE_SETLOCALE
  48 # define setlocale(Category, Locale) /* empty */
  49 #endif
  50
  51
  52 #ifdef  CRAY
  53 /* This must happen before #include <signal.h> so
  54    that the declaration therein is changed.  */
  55 # define signal bsdsignal
  56 #endif
  57
  58 /* If we're compiling for the dmalloc debugger, turn off string inlining.  */
  59 #if defined(HAVE_DMALLOC_H) && defined(__GNUC__)
  60 # define __NO_STRING_INLINES
  61 #endif
  62
  63 #define _GNU_SOURCE 1
  64 #include <sys/types.h>
  65 #include <sys/stat.h>
  66 #include <signal.h>
  67 #include <stdio.h>
  68 #include <ctype.h>
  69 #ifdef HAVE_SYS_TIMEB_H
  70 /* SCO 3.2 "devsys 4.2" has a prototype for `ftime' in <time.h> that bombs
  71    unless <sys/timeb.h> has been included first.  Does every system have a
  72    <sys/timeb.h>?  If any does not, configure should check for it.  */
  73 # include <sys/timeb.h>
  74 #endif
  75
  76 #if TIME_WITH_SYS_TIME
  77 # include <sys/time.h>
  78 # include <time.h>
  79 #else
  80 # if HAVE_SYS_TIME_H
  81 #  include <sys/time.h>
  82 # else
  83 #  include <time.h>
  84 # endif
  85 #endif
  86
  87 #include <errno.h>
  88
  89 #ifndef errno
  90 extern int errno;
  91 #endif
  92
  93 /* A shortcut for EINTR checking.  Note you should be careful when negating
  94    this!  That might not mean what you want if EINTR is not available.  */
  95 #ifdef EINTR
  96 # define EINTR_SET (errno == EINTR)
  97 #else
  98 # define EINTR_SET (0)
  99 #endif
 100
 101 #ifndef isblank
 102 # define isblank(c)     ((c) == ' ' || (c) == '\t')
 103 #endif
 104
 105 #ifdef  HAVE_UNISTD_H
 106 # include <unistd.h>
 107 /* Ultrix's unistd.h always defines _POSIX_VERSION, but you only get
 108    POSIX.1 behavior with `cc -YPOSIX', which predefines POSIX itself!  */
 109 # if defined (_POSIX_VERSION) && !defined (ultrix) && !defined (VMS)
 110 #  define POSIX 1
 111 # endif
 112 #endif
 113
 114 /* Some systems define _POSIX_VERSION but are not really POSIX.1.  */
 115 #if (defined (butterfly) || defined (__arm) || (defined (__mips) && defined (_SYSTYPE_SVR3)) || (defined (sequent) && defined (i386)))
 116 # undef POSIX
 117 #endif
 118
 119 #if !defined (POSIX) && defined (_AIX) && defined (_POSIX_SOURCE)
 120 # define POSIX 1
 121 #endif
 122
 123 #ifndef RETSIGTYPE
 124 # define RETSIGTYPE     void
 125 #endif
 126
 127 #ifndef sigmask
 128 # define sigmask(sig)   (1 << ((sig) - 1))
 129 #endif
 130
 131 #ifdef  HAVE_LIMITS_H
 132 # include <limits.h>
 133 #endif
 134 #ifdef  HAVE_SYS_PARAM_H
 135 # include <sys/param.h>
 136 #endif
 137
 138 #ifndef PATH_MAX
 139 # ifndef POSIX
 140 #  define PATH_MAX      MAXPATHLEN
 141 # endif
 142 #endif
 143 #ifndef MAXPATHLEN
 144 # define MAXPATHLEN 1024
 145 #endif
 146
 147 #ifdef  PATH_MAX
 148 # define GET_PATH_MAX   PATH_MAX
 149 # define PATH_VAR(var)  char var[PATH_MAX]
 150 #else
 151 # define NEED_GET_PATH_MAX 1
 152 # define GET_PATH_MAX   (get_path_max ())
 153 # define PATH_VAR(var)  char *var = (char *) alloca (GET_PATH_MAX)
 154 extern unsigned int get_path_max PARAMS ((void));
 155 #endif
 156
 157 #ifndef CHAR_BIT
 158 # define CHAR_BIT 8
 159 #endif
 160
 161 /* Nonzero if the integer type T is signed.  */
 162 #define INTEGER_TYPE_SIGNED(t) ((t) -1 < 0)
 163
 164 /* The minimum and maximum values for the integer type T.
 165    Use ~ (t) 0, not -1, for portability to 1's complement hosts.  */
 166 #define INTEGER_TYPE_MINIMUM(t) \
 167   (! INTEGER_TYPE_SIGNED (t) ? (t) 0 : ~ (t) 0 << (sizeof (t) * CHAR_BIT - 1))
 168 #define INTEGER_TYPE_MAXIMUM(t) (~ (t) 0 - INTEGER_TYPE_MINIMUM (t))
 169
 170 #ifndef CHAR_MAX
 171 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
 172 #endif
 173
 174 #ifdef STAT_MACROS_BROKEN
 175 # ifdef S_ISREG
 176 #  undef S_ISREG
 177 # endif
 178 # ifdef S_ISDIR
 179 #  undef S_ISDIR
 180 # endif
 181 #endif  /* STAT_MACROS_BROKEN.  */
 182
 183 #ifndef S_ISREG
 184 # define S_ISREG(mode)  (((mode) & S_IFMT) == S_IFREG)
 185 #endif
 186 #ifndef S_ISDIR
 187 # define S_ISDIR(mode)  (((mode) & S_IFMT) == S_IFDIR)
 188 #endif
 189
 190 #ifdef VMS
 191 # include <types.h>
 192 # include <unixlib.h>
 193 # include <unixio.h>
 194 # include <perror.h>
 195 #endif
 196
 197 #ifndef __attribute__
 198 /* This feature is available in gcc versions 2.5 and later.  */
 199 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
 200 #  define __attribute__(x)
 201 # endif
 202 /* The __-protected variants of `format' and `printf' attributes
 203    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
 204 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
 205 #  define __format__ format
 206 #  define __printf__ printf
 207 # endif
 208 #endif
 209
 210 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
 211 # include <stdlib.h>
 212 # include <string.h>
 213 # define ANSI_STRING 1
 214 #else   /* No standard headers.  */
 215 # ifdef HAVE_STRING_H
 216 #  include <string.h>
 217 #  define ANSI_STRING 1
 218 # else
 219 #  include <strings.h>
 220 # endif
 221 # ifdef HAVE_MEMORY_H
 222 #  include <memory.h>
 223 # endif
 224 # ifdef HAVE_STDLIB_H
 225 #  include <stdlib.h>
 226 # else
 227 extern char *malloc PARAMS ((int));
 228 extern char *realloc PARAMS ((char *, int));
 229 extern void free PARAMS ((char *));
 230
 231 extern void abort PARAMS ((void)) __attribute__ ((noreturn));
 232 extern void exit PARAMS ((int)) __attribute__ ((noreturn));
 233 # endif /* HAVE_STDLIB_H.  */
 234
 235 #endif /* Standard headers.  */
 236
 237 #ifdef  ANSI_STRING
 238
 239 # ifndef bcmp
 240 #  define bcmp(s1, s2, n)   memcmp ((s1), (s2), (n))
 241 # endif
 242 # ifndef bzero
 243 #  define bzero(s, n)       memset ((s), 0, (n))
 244 # endif
 245 # if defined(HAVE_MEMMOVE) && !defined(bcopy)
 246 #  define bcopy(s, d, n)    memmove ((d), (s), (n))
 247 # endif
 248
 249 #else   /* Not ANSI_STRING.  */
 250
 251 # ifndef HAVE_STRCHR
 252 #  define strchr(s, c)      index((s), (c))
 253 #  define strrchr(s, c)     rindex((s), (c))
 254 # endif
 255
 256 # ifndef bcmp
 257 extern int bcmp PARAMS ((const char *, const char *, int));
 258 # endif
 259 # ifndef bzero
 260 extern void bzero PARAMS ((char *, int));
 261 #endif
 262 # ifndef bcopy
 263 extern void bcopy PARAMS ((const char *b1, char *b2, int));
 264 # endif
 265
 266 #endif  /* ANSI_STRING.  */
 267 #undef  ANSI_STRING
 268
 269 /* SCO Xenix has a buggy macro definition in <string.h>.  */
 270 #undef  strerror
 271
 272 #if !defined(ANSI_STRING) && !defined(__DECC)
 273 extern char *strerror PARAMS ((int errnum));
 274 #endif
 275
 276 #ifdef __GNUC__
 277 # undef alloca
 278 # define alloca(n)      __builtin_alloca (n)
 279 #else   /* Not GCC.  */
 280 # ifdef HAVE_ALLOCA_H
 281 #  include <alloca.h>
 282 # else /* Not HAVE_ALLOCA_H.  */
 283 #  ifndef _AIX
 284 extern char *alloca ();
 285 #  endif /* Not AIX.  */
 286 # endif /* HAVE_ALLOCA_H.  */
 287 #endif /* GCC.  */
 288
 289 #ifdef ST_MTIM_NSEC
 290 # if HAVE_INTTYPES_H
 291 #  include <inttypes.h>
 292 # endif
 293 # define FILE_TIMESTAMP uintmax_t
 294 #else
 295 # define FILE_TIMESTAMP time_t
 296 #endif
 297
 298 /* ISDIGIT offers the following features:
 299    - Its arg may be any int or unsigned int; it need not be an unsigned char.
 300    - It's guaranteed to evaluate its argument exactly once.
 301       NOTE!  Make relies on this behavior, don't change it!
 302    - It's typically faster.
 303    Posix 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
 304    only '0' through '9' are digits.  Prefer ISDIGIT to isdigit() unless
 305    it's important to use the locale's definition of `digit' even when the
 306    host does not conform to Posix.  */
 307 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
 308
 309 #ifndef iAPX286
 310 # define streq(a, b) \
 311    ((a) == (b) || \
 312     (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
 313 # ifdef HAVE_CASE_INSENSITIVE_FS
 314 /* This is only used on Windows/DOS platforms, so we assume strcmpi().  */
 315 #  define strieq(a, b) \
 316     ((a) == (b) \
 317      || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
 318          && (*(a) == '\0' || !strcmpi ((a) + 1, (b) + 1))))
 319 # else
 320 #  define strieq(a, b) streq(a, b)
 321 # endif
 322 #else
 323 /* Buggy compiler can't handle this.  */
 324 # define streq(a, b) (strcmp ((a), (b)) == 0)
 325 # define strieq(a, b) (strcmp ((a), (b)) == 0)
 326 #endif
 327 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
 328 #ifdef  VMS
 329 extern int strcmpi (const char *,const char *);
 330 #endif
 331
 332 /* Add to VAR the hashing value of C, one character in a name.  */
 333 #define HASH(var, c) \
 334   ((var += (c)), (var = ((var) << 7) + ((var) >> 20)))
 335 #ifdef HAVE_CASE_INSENSITIVE_FS /* Fold filenames */
 336 # define HASHI(var, c) \
 337    ((var += tolower((unsigned char)(c))), (var = ((var) << 7) + ((var) >> 20)))
 338 #else
 339 # define HASHI(var, c) HASH(var,c)
 340 #endif
 341
 342 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
 343 # define ENUM_BITFIELD(bits)    :bits
 344 #else
 345 # define ENUM_BITFIELD(bits)
 346 #endif
 347
 348 #if defined(__MSDOS__) || defined(WINDOWS32)
 349 # define PATH_SEPARATOR_CHAR ';'
 350 #else
 351 # if defined(VMS)
 352 #  define PATH_SEPARATOR_CHAR ','
 353 # else
 354 #  define PATH_SEPARATOR_CHAR ':'
 355 # endif
 356 #endif
 357
 358 #ifdef WINDOWS32
 359 # include <fcntl.h>
 360 # include <malloc.h>
 361 # define pipe(p) _pipe(p, 512, O_BINARY)
 362 # define kill(pid,sig) w32_kill(pid,sig)
 363
 364 extern void sync_Path_environment(void);
 365 extern int kill(int pid, int sig);
 366 extern int safe_stat(char *file, struct stat *sb);
 367 extern char *end_of_token_w32(char *s, char stopchar);
 368 extern int find_and_set_default_shell(char *token);
 369
 370 /* indicates whether or not we have Bourne shell */
 371 extern int no_default_sh_exe;
 372
 373 /* is default_shell unixy? */
 374 extern int unixy_shell;
 375 #endif  /* WINDOWS32 */
 376
 377 struct floc
 378   {
 379     char *filenm;
 380     unsigned long lineno;
 381   };
 382 #define NILF ((struct floc *)0)
 383
 384 \f
 385 /* Fancy processing for variadic functions in both ANSI and pre-ANSI
 386    compilers.  */
 387 #if defined __STDC__ && __STDC__
 388 extern void message (int prefix, const char *fmt, ...)
 389                      __attribute__ ((__format__ (__printf__, 2, 3)));
 390 extern void error (const struct floc *flocp, const char *fmt, ...)
 391                    __attribute__ ((__format__ (__printf__, 2, 3)));
 392 extern void fatal (const struct floc *flocp, const char *fmt, ...)
 393                    __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
 394 #else
 395 extern void message ();
 396 extern void error ();
 397 extern void fatal ();
 398 #endif
 399
 400 extern void die PARAMS ((int)) __attribute__ ((noreturn));
 401 extern void log_working_directory PARAMS ((int));
 402 extern void pfatal_with_name PARAMS ((char *)) __attribute__ ((noreturn));
 403 extern void perror_with_name PARAMS ((char *, char *));
 404 extern char *savestring PARAMS ((const char *, unsigned int));
 405 extern char *concat PARAMS ((char *, char *, char *));
 406 extern char *xmalloc PARAMS ((unsigned int));
 407 extern char *xrealloc PARAMS ((char *, unsigned int));
 408 extern char *xstrdup PARAMS ((const char *));
 409 extern char *find_next_token PARAMS ((char **, unsigned int *));
 410 extern char *next_token PARAMS ((char *));
 411 extern char *end_of_token PARAMS ((char *));
 412 extern void collapse_continuations PARAMS ((char *));
 413 extern void remove_comments PARAMS((char *));
 414 extern char *sindex PARAMS ((const char *, unsigned int, \
 415                              const char *, unsigned int));
 416 extern char *lindex PARAMS ((const char *, const char *, int));
 417 extern int alpha_compare PARAMS ((const void *, const void *));
 418 extern void print_spaces PARAMS ((unsigned int));
 419 extern char *find_char_unquote PARAMS ((char *, char *, int));
 420 extern char *find_percent PARAMS ((char *));
 421 extern FILE *open_tmpfile PARAMS ((char **, const char *));
 422
 423 #ifndef NO_ARCHIVES
 424 extern int ar_name PARAMS ((char *));
 425 extern void ar_parse_name PARAMS ((char *, char **, char **));
 426 extern int ar_touch PARAMS ((char *));
 427 extern time_t ar_member_date PARAMS ((char *));
 428 #endif
 429
 430 extern int dir_file_exists_p PARAMS ((char *, char *));
 431 extern int file_exists_p PARAMS ((char *));
 432 extern int file_impossible_p PARAMS ((char *));
 433 extern void file_impossible PARAMS ((char *));
 434 extern char *dir_name PARAMS ((char *));
 435
 436 extern void define_default_variables PARAMS ((void));
 437 extern void set_default_suffixes PARAMS ((void));
 438 extern void install_default_suffix_rules PARAMS ((void));
 439 extern void install_default_implicit_rules PARAMS ((void));
 440
 441 extern void build_vpath_lists PARAMS ((void));
 442 extern void construct_vpath_list PARAMS ((char *pattern, char *dirpath));
 443 extern int vpath_search PARAMS ((char **file, FILE_TIMESTAMP *mtime_ptr));
 444 extern int gpath_search PARAMS ((char *file, int len));
 445
 446 extern void construct_include_path PARAMS ((char **arg_dirs));
 447
 448 extern void user_access PARAMS ((void));
 449 extern void make_access PARAMS ((void));
 450 extern void child_access PARAMS ((void));
 451
 452 #ifdef  HAVE_VFORK_H
 453 # include <vfork.h>
 454 #endif
 455
 456 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
 457    because such systems often declare them in header files anyway.  */
 458
 459 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
 460
 461 extern long int atol ();
 462 # ifndef VMS
 463 extern long int lseek ();
 464 # endif
 465
 466 #endif  /* Not GNU C library or POSIX.  */
 467
 468 #ifdef  HAVE_GETCWD
 469 # if !defined(VMS) && !defined(__DECC)
 470 extern char *getcwd ();
 471 #endif
 472 #else
 473 extern char *getwd ();
 474 # define getcwd(buf, len)       getwd (buf)
 475 #endif
 476
 477 extern const struct floc *reading_file;
 478
 479 extern char **environ;
 480
 481 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
 482 extern int print_data_base_flag, question_flag, touch_flag;
 483 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
 484 extern int print_version_flag, print_directory_flag;
 485 extern int warn_undefined_variables_flag, posix_pedantic, not_parallel;
 486 extern int clock_skew_detected;
 487
 488 /* can we run commands via 'sh -c xxx' or must we use batch files? */
 489 extern int batch_mode_shell;
 490
 491 extern unsigned int job_slots;
 492 extern int job_fds[2];
 493 extern int job_rfd;
 494 #ifndef NO_FLOAT
 495 extern double max_load_average;
 496 #else
 497 extern int max_load_average;
 498 #endif
 499
 500 extern char *program;
 501 extern char *starting_directory;
 502 extern unsigned int makelevel;
 503 extern char *version_string, *remote_description;
 504
 505 extern unsigned int commands_started;
 506
 507 extern int handling_fatal_signal;
 508
 509
 510 #ifndef MIN
 511 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
 512 #endif
 513 #ifndef MAX
 514 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
 515 #endif
 516
 517 #ifdef VMS
 518 # ifndef EXIT_FAILURE
 519 #  define EXIT_FAILURE 3
 520 # endif
 521 # ifndef EXIT_SUCCESS
 522 #  define EXIT_SUCCESS 1
 523 # endif
 524 # ifndef EXIT_TROUBLE
 525 #  define EXIT_TROUBLE 2
 526 # endif
 527 #else
 528 # ifndef EXIT_FAILURE
 529 #  define EXIT_FAILURE 2
 530 # endif
 531 # ifndef EXIT_SUCCESS
 532 #  define EXIT_SUCCESS 0
 533 # endif
 534 # ifndef EXIT_TROUBLE
 535 #  define EXIT_TROUBLE 1
 536 # endif
 537 #endif
 538
 539 /* Set up heap debugging library dmalloc.  */
 540
 541 #ifdef HAVE_DMALLOC_H
 542 #include <dmalloc.h>
 543 #endif