Fix an issue with PATH_SEPARATOR_CHAR when cross-compiling for Windows.
[make.git] / make.h
blobb6956f79fd38323bac15d63766dc61b0c74f7194
1 /* Miscellaneous global declarations and portability cruft for GNU Make.
2 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
4 2012 Free Software Foundation, Inc.
5 This file is part of GNU Make.
7 GNU Make is free software; you can redistribute it and/or modify it under the
8 terms of the GNU General Public License as published by the Free Software
9 Foundation; either version 3 of the License, or (at your option) any later
10 version.
12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License along with
17 this program. If not, see <http://www.gnu.org/licenses/>. */
19 /* We use <config.h> instead of "config.h" so that a compilation
20 using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
21 (which it would do because make.h was found in $srcdir). */
22 #include <config.h>
23 #undef HAVE_CONFIG_H
24 #define HAVE_CONFIG_H 1
26 /* Specify we want GNU source code. This must be defined before any
27 system headers are included. */
29 #define _GNU_SOURCE 1
31 /* AIX requires this to be the first thing in the file. */
32 #if HAVE_ALLOCA_H
33 # include <alloca.h>
34 #else
35 # ifdef _AIX
36 #pragma alloca
37 # else
38 # if !defined(__GNUC__) && !defined(WINDOWS32)
39 # ifndef alloca /* predefined by HP cc +Olibcalls */
40 char *alloca ();
41 # endif
42 # endif
43 # endif
44 #endif
46 /* Disable assert() unless we're a maintainer.
47 Some asserts are compute-intensive. */
48 #ifndef MAKE_MAINTAINER_MODE
49 # define NDEBUG 1
50 #endif
53 #ifdef CRAY
54 /* This must happen before #include <signal.h> so
55 that the declaration therein is changed. */
56 # define signal bsdsignal
57 #endif
59 /* If we're compiling for the dmalloc debugger, turn off string inlining. */
60 #if defined(HAVE_DMALLOC_H) && defined(__GNUC__)
61 # define __NO_STRING_INLINES
62 #endif
64 #include <sys/types.h>
65 #include <sys/stat.h>
66 #include <signal.h>
67 #include <stdio.h>
68 #include <ctype.h>
70 #ifdef HAVE_SYS_TIMEB_H
71 /* SCO 3.2 "devsys 4.2" has a prototype for `ftime' in <time.h> that bombs
72 unless <sys/timeb.h> has been included first. */
73 # include <sys/timeb.h>
74 #endif
75 #if TIME_WITH_SYS_TIME
76 # include <sys/time.h>
77 # include <time.h>
78 #else
79 # if HAVE_SYS_TIME_H
80 # include <sys/time.h>
81 # else
82 # include <time.h>
83 # endif
84 #endif
86 #include <errno.h>
88 #ifndef errno
89 extern int errno;
90 #endif
92 #ifndef isblank
93 # define isblank(c) ((c) == ' ' || (c) == '\t')
94 #endif
96 #ifdef HAVE_UNISTD_H
97 # include <unistd.h>
98 /* Ultrix's unistd.h always defines _POSIX_VERSION, but you only get
99 POSIX.1 behavior with `cc -YPOSIX', which predefines POSIX itself! */
100 # if defined (_POSIX_VERSION) && !defined (ultrix) && !defined (VMS)
101 # define POSIX 1
102 # endif
103 #endif
105 /* Some systems define _POSIX_VERSION but are not really POSIX.1. */
106 #if (defined (butterfly) || defined (__arm) || (defined (__mips) && defined (_SYSTYPE_SVR3)) || (defined (sequent) && defined (i386)))
107 # undef POSIX
108 #endif
110 #if !defined (POSIX) && defined (_AIX) && defined (_POSIX_SOURCE)
111 # define POSIX 1
112 #endif
114 #ifndef RETSIGTYPE
115 # define RETSIGTYPE void
116 #endif
118 #ifndef sigmask
119 # define sigmask(sig) (1 << ((sig) - 1))
120 #endif
122 #ifndef HAVE_SA_RESTART
123 # define SA_RESTART 0
124 #endif
126 #ifdef HAVE_LIMITS_H
127 # include <limits.h>
128 #endif
129 #ifdef HAVE_SYS_PARAM_H
130 # include <sys/param.h>
131 #endif
133 #ifndef PATH_MAX
134 # ifndef POSIX
135 # define PATH_MAX MAXPATHLEN
136 # endif
137 #endif
138 #ifndef MAXPATHLEN
139 # define MAXPATHLEN 1024
140 #endif
142 #ifdef PATH_MAX
143 # define GET_PATH_MAX PATH_MAX
144 # define PATH_VAR(var) char var[PATH_MAX]
145 #else
146 # define NEED_GET_PATH_MAX 1
147 # define GET_PATH_MAX (get_path_max ())
148 # define PATH_VAR(var) char *var = alloca (GET_PATH_MAX)
149 unsigned int get_path_max (void);
150 #endif
152 #ifndef CHAR_BIT
153 # define CHAR_BIT 8
154 #endif
156 #ifndef USHRT_MAX
157 # define USHRT_MAX 65535
158 #endif
160 /* Nonzero if the integer type T is signed.
161 Use <= to avoid GCC warnings about always-false expressions. */
162 #define INTEGER_TYPE_SIGNED(t) ((t) -1 <= 0)
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))
170 #ifndef CHAR_MAX
171 # define CHAR_MAX INTEGER_TYPE_MAXIMUM (char)
172 #endif
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. */
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
190 #ifdef VMS
191 # include <types.h>
192 # include <unixlib.h>
193 # include <unixio.h>
194 # include <perror.h>
195 /* Needed to use alloca on VMS. */
196 # include <builtins.h>
197 #endif
199 #ifndef __attribute__
200 /* This feature is available in gcc versions 2.5 and later. */
201 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
202 # define __attribute__(x)
203 # endif
204 /* The __-protected variants of `format' and `printf' attributes
205 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
206 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7)
207 # define __format__ format
208 # define __printf__ printf
209 # endif
210 #endif
211 #define UNUSED __attribute__ ((unused))
213 #if defined (STDC_HEADERS) || defined (__GNU_LIBRARY__)
214 # include <stdlib.h>
215 # include <string.h>
216 # define ANSI_STRING 1
217 #else /* No standard headers. */
218 # ifdef HAVE_STRING_H
219 # include <string.h>
220 # define ANSI_STRING 1
221 # else
222 # include <strings.h>
223 # endif
224 # ifdef HAVE_MEMORY_H
225 # include <memory.h>
226 # endif
227 # ifdef HAVE_STDLIB_H
228 # include <stdlib.h>
229 # else
230 void *malloc (int);
231 void *realloc (void *, int);
232 void free (void *);
234 void abort (void) __attribute__ ((noreturn));
235 void exit (int) __attribute__ ((noreturn));
236 # endif /* HAVE_STDLIB_H. */
238 #endif /* Standard headers. */
240 /* These should be in stdlib.h. Make sure we have them. */
241 #ifndef EXIT_SUCCESS
242 # define EXIT_SUCCESS 0
243 #endif
244 #ifndef EXIT_FAILURE
245 # define EXIT_FAILURE 1
246 #endif
248 #ifndef ANSI_STRING
250 /* SCO Xenix has a buggy macro definition in <string.h>. */
251 #undef strerror
252 #if !defined(__DECC)
253 char *strerror (int errnum);
254 #endif
256 #endif /* !ANSI_STRING. */
257 #undef ANSI_STRING
259 #if HAVE_INTTYPES_H
260 # include <inttypes.h>
261 #endif
262 #define FILE_TIMESTAMP uintmax_t
264 #if !defined(HAVE_STRSIGNAL)
265 char *strsignal (int signum);
266 #endif
268 /* ISDIGIT offers the following features:
269 - Its arg may be any int or unsigned int; it need not be an unsigned char.
270 - It's guaranteed to evaluate its argument exactly once.
271 NOTE! Make relies on this behavior, don't change it!
272 - It's typically faster.
273 POSIX 1003.2-1992 section 2.5.2.1 page 50 lines 1556-1558 says that
274 only '0' through '9' are digits. Prefer ISDIGIT to isdigit() unless
275 it's important to use the locale's definition of `digit' even when the
276 host does not conform to POSIX. */
277 #define ISDIGIT(c) ((unsigned) (c) - '0' <= 9)
279 /* Test if two strings are equal. Is this worthwhile? Should be profiled. */
280 #define streq(a, b) \
281 ((a) == (b) || \
282 (*(a) == *(b) && (*(a) == '\0' || !strcmp ((a) + 1, (b) + 1))))
284 /* Test if two strings are equal, but match case-insensitively on systems
285 which have case-insensitive filesystems. Should only be used for
286 filenames! */
287 #ifdef HAVE_CASE_INSENSITIVE_FS
288 # define patheq(a, b) \
289 ((a) == (b) \
290 || (tolower((unsigned char)*(a)) == tolower((unsigned char)*(b)) \
291 && (*(a) == '\0' || !strcasecmp ((a) + 1, (b) + 1))))
292 #else
293 # define patheq(a, b) streq(a, b)
294 #endif
296 #define strneq(a, b, l) (strncmp ((a), (b), (l)) == 0)
298 #if defined(__GNUC__) || defined(ENUM_BITFIELDS)
299 # define ENUM_BITFIELD(bits) :bits
300 #else
301 # define ENUM_BITFIELD(bits)
302 #endif
304 /* Handle gettext and locales. */
306 #if HAVE_LOCALE_H
307 # include <locale.h>
308 #else
309 # define setlocale(category, locale)
310 #endif
312 #include <gettext.h>
314 #define _(msgid) gettext (msgid)
315 #define N_(msgid) gettext_noop (msgid)
316 #define S_(msg1,msg2,num) ngettext (msg1,msg2,num)
318 /* Handle other OSs.
319 To overcome an issue parsing paths in a DOS/Windows environment when
320 built in a unix based environment, override the PATH_SEPARATOR_CHAR
321 definition unless being built for Cygwin. */
322 #if defined(HAVE_DOS_PATHS) && !defined(__CYGWIN__)
323 # undef PATH_SEPARATOR_CHAR
324 # define PATH_SEPARATOR_CHAR ';'
325 #elif !defined(PATH_SEPARATOR_CHAR)
326 # if defined (VMS)
327 # define PATH_SEPARATOR_CHAR ','
328 # else
329 # define PATH_SEPARATOR_CHAR ':'
330 # endif
331 #endif
333 /* This is needed for getcwd() and chdir(), on some W32 systems. */
334 #if defined(HAVE_DIRECT_H)
335 # include <direct.h>
336 #endif
338 #ifdef WINDOWS32
339 # include <fcntl.h>
340 # include <malloc.h>
341 # define pipe(_p) _pipe((_p), 512, O_BINARY)
342 # define kill(_pid,_sig) w32_kill((_pid),(_sig))
344 void sync_Path_environment (void);
345 int w32_kill (pid_t pid, int sig);
346 char *end_of_token_w32 (const char *s, char stopchar);
347 int find_and_set_default_shell (const char *token);
349 /* indicates whether or not we have Bourne shell */
350 extern int no_default_sh_exe;
352 /* is default_shell unixy? */
353 extern int unixy_shell;
354 #endif /* WINDOWS32 */
356 #if defined(HAVE_SYS_RESOURCE_H) && defined(HAVE_GETRLIMIT) && defined(HAVE_SETRLIMIT)
357 # define SET_STACK_SIZE
358 #endif
359 #ifdef SET_STACK_SIZE
360 # include <sys/resource.h>
361 extern struct rlimit stack_limit;
362 #endif
364 struct floc
366 const char *filenm;
367 unsigned long lineno;
369 #define NILF ((struct floc *)0)
371 #define STRING_SIZE_TUPLE(_s) (_s), (sizeof (_s)-1)
374 /* We have to have stdarg.h or varargs.h AND v*printf or doprnt to use
375 variadic versions of these functions. */
377 #if HAVE_STDARG_H || HAVE_VARARGS_H
378 # if HAVE_VPRINTF || HAVE_DOPRNT
379 # define USE_VARIADIC 1
380 # endif
381 #endif
383 #if HAVE_ANSI_COMPILER && USE_VARIADIC && HAVE_STDARG_H
384 const char *concat (unsigned int, ...);
385 void message (int prefix, const char *fmt, ...)
386 __attribute__ ((__format__ (__printf__, 2, 3)));
387 void error (const struct floc *flocp, const char *fmt, ...)
388 __attribute__ ((__format__ (__printf__, 2, 3)));
389 void fatal (const struct floc *flocp, const char *fmt, ...)
390 __attribute__ ((noreturn, __format__ (__printf__, 2, 3)));
391 #else
392 const char *concat ();
393 void message ();
394 void error ();
395 void fatal ();
396 #endif
398 void die (int) __attribute__ ((noreturn));
399 void log_working_directory (int);
400 void pfatal_with_name (const char *) __attribute__ ((noreturn));
401 void perror_with_name (const char *, const char *);
402 void *xmalloc (unsigned int);
403 void *xcalloc (unsigned int);
404 void *xrealloc (void *, unsigned int);
405 char *xstrdup (const char *);
406 char *xstrndup (const char *, unsigned int);
407 char *find_next_token (const char **, unsigned int *);
408 char *next_token (const char *);
409 char *end_of_token (const char *);
410 void collapse_continuations (char *);
411 char *lindex (const char *, const char *, int);
412 int alpha_compare (const void *, const void *);
413 void print_spaces (unsigned int);
414 char *find_percent (char *);
415 const char *find_percent_cached (const char **);
416 FILE *open_tmpfile (char **, const char *);
418 #ifndef NO_ARCHIVES
419 int ar_name (const char *);
420 void ar_parse_name (const char *, char **, char **);
421 int ar_touch (const char *);
422 time_t ar_member_date (const char *);
424 typedef long int (*ar_member_func_t) (int desc, const char *mem, int truncated,
425 long int hdrpos, long int datapos,
426 long int size, long int date, int uid,
427 int gid, int mode, const void *arg);
429 long int ar_scan (const char *archive, ar_member_func_t function, const void *arg);
430 int ar_name_equal (const char *name, const char *mem, int truncated);
431 #ifndef VMS
432 int ar_member_touch (const char *arname, const char *memname);
433 #endif
434 #endif
436 int dir_file_exists_p (const char *, const char *);
437 int file_exists_p (const char *);
438 int file_impossible_p (const char *);
439 void file_impossible (const char *);
440 const char *dir_name (const char *);
441 void hash_init_directories (void);
443 void define_default_variables (void);
444 void set_default_suffixes (void);
445 void install_default_suffix_rules (void);
446 void install_default_implicit_rules (void);
448 void build_vpath_lists (void);
449 void construct_vpath_list (char *pattern, char *dirpath);
450 const char *vpath_search (const char *file, FILE_TIMESTAMP *mtime_ptr,
451 unsigned int* vpath_index, unsigned int* path_index);
452 int gpath_search (const char *file, unsigned int len);
454 void construct_include_path (const char **arg_dirs);
456 void user_access (void);
457 void make_access (void);
458 void child_access (void);
460 void close_stdout (void);
462 char *strip_whitespace (const char **begpp, const char **endpp);
464 /* String caching */
465 void strcache_init (void);
466 void strcache_print_stats (const char *prefix);
467 int strcache_iscached (const char *str);
468 const char *strcache_add (const char *str);
469 const char *strcache_add_len (const char *str, unsigned int len);
470 int strcache_setbufsize (unsigned int size);
472 /* Guile support */
473 int setup_guile (void);
476 #ifdef HAVE_VFORK_H
477 # include <vfork.h>
478 #endif
480 /* We omit these declarations on non-POSIX systems which define _POSIX_VERSION,
481 because such systems often declare them in header files anyway. */
483 #if !defined (__GNU_LIBRARY__) && !defined (POSIX) && !defined (_POSIX_VERSION) && !defined(WINDOWS32)
485 long int atol ();
486 # ifndef VMS
487 long int lseek ();
488 # endif
490 #endif /* Not GNU C library or POSIX. */
492 #ifdef HAVE_GETCWD
493 # if !defined(VMS) && !defined(__DECC)
494 char *getcwd ();
495 # endif
496 #else
497 char *getwd ();
498 # define getcwd(buf, len) getwd (buf)
499 #endif
501 #if !HAVE_STRCASECMP
502 # if HAVE_STRICMP
503 # define strcasecmp stricmp
504 # elif HAVE_STRCMPI
505 # define strcasecmp strcmpi
506 # else
507 /* Create our own, in misc.c */
508 int strcasecmp (const char *s1, const char *s2);
509 # endif
510 #endif
512 #if !HAVE_STRNCASECMP
513 # if HAVE_STRNICMP
514 # define strncasecmp strnicmp
515 # elif HAVE_STRNCMPI
516 # define strncasecmp strncmpi
517 # else
518 /* Create our own, in misc.c */
519 int strncasecmp (const char *s1, const char *s2, int n);
520 # endif
521 #endif
523 extern const struct floc *reading_file;
524 extern const struct floc **expanding_var;
526 extern char **environ;
528 extern int just_print_flag, silent_flag, ignore_errors_flag, keep_going_flag;
529 extern int print_data_base_flag, question_flag, touch_flag, always_make_flag;
530 extern int env_overrides, no_builtin_rules_flag, no_builtin_variables_flag;
531 extern int print_version_flag, print_directory_flag, check_symlink_flag;
532 extern int warn_undefined_variables_flag, trace_flag, posix_pedantic;
533 extern int not_parallel, second_expansion, clock_skew_detected;
534 extern int rebuilding_makefiles, one_shell;
536 /* can we run commands via 'sh -c xxx' or must we use batch files? */
537 extern int batch_mode_shell;
539 /* Resetting the command script introduction prefix character. */
540 #define RECIPEPREFIX_NAME ".RECIPEPREFIX"
541 #define RECIPEPREFIX_DEFAULT '\t'
542 extern char cmd_prefix;
544 extern unsigned int job_slots;
545 extern int job_fds[2];
546 extern int job_rfd;
547 #ifndef NO_FLOAT
548 extern double max_load_average;
549 #else
550 extern int max_load_average;
551 #endif
553 extern char *program;
554 extern char *starting_directory;
555 extern unsigned int makelevel;
556 extern char *version_string, *remote_description, *make_host;
558 extern unsigned int commands_started;
560 extern int handling_fatal_signal;
563 #ifndef MIN
564 #define MIN(_a,_b) ((_a)<(_b)?(_a):(_b))
565 #endif
566 #ifndef MAX
567 #define MAX(_a,_b) ((_a)>(_b)?(_a):(_b))
568 #endif
570 #ifdef VMS
571 # define MAKE_SUCCESS 1
572 # define MAKE_TROUBLE 2
573 # define MAKE_FAILURE 3
574 #else
575 # define MAKE_SUCCESS 0
576 # define MAKE_TROUBLE 1
577 # define MAKE_FAILURE 2
578 #endif
580 /* Set up heap debugging library dmalloc. */
582 #ifdef HAVE_DMALLOC_H
583 #include <dmalloc.h>
584 #endif
586 #ifndef initialize_main
587 # ifdef __EMX__
588 # define initialize_main(pargc, pargv) \
589 { _wildcard(pargc, pargv); _response(pargc, pargv); }
590 # else
591 # define initialize_main(pargc, pargv)
592 # endif
593 #endif
595 #ifdef __EMX__
596 # if !defined chdir
597 # define chdir _chdir2
598 # endif
599 # if !defined getcwd
600 # define getcwd _getcwd2
601 # endif
603 /* NO_CHDIR2 causes make not to use _chdir2() and _getcwd2() instead of
604 chdir() and getcwd(). This avoids some error messages for the
605 make testsuite but restricts the drive letter support. */
606 # ifdef NO_CHDIR2
607 # warning NO_CHDIR2: usage of drive letters restricted
608 # undef chdir
609 # undef getcwd
610 # endif
611 #endif
613 #ifndef initialize_main
614 # define initialize_main(pargc, pargv)
615 #endif
618 /* Some systems (like Solaris, PTX, etc.) do not support the SA_RESTART flag
619 properly according to POSIX. So, we try to wrap common system calls with
620 checks for EINTR. Note that there are still plenty of system calls that
621 can fail with EINTR but this, reportedly, gets the vast majority of
622 failure cases. If you still experience failures you'll need to either get
623 a system where SA_RESTART works, or you need to avoid -j. */
625 #define EINTRLOOP(_v,_c) while (((_v)=_c)==-1 && errno==EINTR)
627 /* While system calls that return integers are pretty consistent about
628 returning -1 on failure and setting errno in that case, functions that
629 return pointers are not always so well behaved. Sometimes they return
630 NULL for expected behavior: one good example is readdir() which returns
631 NULL at the end of the directory--and _doesn't_ reset errno. So, we have
632 to do it ourselves here. */
634 #define ENULLLOOP(_v,_c) do { errno = 0; (_v) = _c; } \
635 while((_v)==0 && errno==EINTR)