Add __printflike's where possible and fix all related bugs & issues.
[dragonfly.git] / usr.bin / make / util.h
1 /*-
2  * Copyright (c) 1988, 1989, 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
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  * $DragonFly: src/usr.bin/make/util.h,v 1.16 2005/09/24 07:37:01 okumoto Exp $
39  */
40
41 #ifndef util_h_b7020fdb
42 #define util_h_b7020fdb
43
44 #include <sys/types.h>
45 #include <stdio.h>
46
47 #define CONCAT(a,b)     a##b
48
49 #define OPEN_PAREN              '('
50 #define CLOSE_PAREN             ')'
51 #define OPEN_BRACE              '{'
52 #define CLOSE_BRACE             '}'
53
54 struct flag2str {
55         u_int           flag;
56         const char      *str;
57 };
58
59 /*
60  * debug control:
61  *      There is one bit per module.  It is up to the module what debug
62  *      information to print.
63  */
64 #define DEBUG_ARCH      0x0001
65 #define DEBUG_COND      0x0002
66 #define DEBUG_DIR       0x0004
67 #define DEBUG_GRAPH1    0x0008
68 #define DEBUG_GRAPH2    0x0010
69 #define DEBUG_JOB       0x0020
70 #define DEBUG_MAKE      0x0040
71 #define DEBUG_SUFF      0x0080
72 #define DEBUG_TARG      0x0100
73 #define DEBUG_VAR       0x0200
74 #define DEBUG_FOR       0x0400
75 #define DEBUG_LOUD      0x0800
76
77 #define DEBUG(module)   (debug & CONCAT(DEBUG_,module))
78 #define DEBUGF(module,args)             \
79 do {                                            \
80         if (DEBUG(module)) {                    \
81                 Debug args ;                    \
82         }                                       \
83 } while (0)
84 #define DEBUGM(module, args) do {               \
85         if (DEBUG(module)) {                    \
86                 DebugM args;                    \
87         }                                       \
88     } while (0)
89
90 #define ISDOT(c) ((c)[0] == '.' && (((c)[1] == '\0') || ((c)[1] == '/')))
91 #define ISDOTDOT(c) ((c)[0] == '.' && ISDOT(&((c)[1])))
92
93 #ifndef MAX
94 #define MAX(a, b)  ((a) > (b) ? (a) : (b))
95 #endif
96
97 /*
98  * XXX: Avoid SunOS bug... FILENO() is fp->_file, and file
99  * is a char! So when we go above 127 we turn negative!
100  */
101 #define FILENO(a) ((unsigned)fileno(a))
102
103 void Debug(const char *, ...) __printflike(1, 2);
104 void DebugM(const char *, ...) __printflike(1, 2);
105 void Error(const char *, ...) __printflike(1, 2);
106 void Fatal(const char *, ...) __dead2 __printflike(1, 2);
107 void Punt(const char *, ...) __dead2 __printflike(1, 2);
108 void DieHorribly(void) __dead2;
109 void Finish(int) __dead2;
110 char *estrdup(const char *);
111 void *emalloc(size_t);
112 void *erealloc(void *, size_t);
113 int eunlink(const char *);
114 void print_flags(FILE *, const struct flag2str *, u_int, int);
115 int mkfifotemp(char *);
116
117
118 #endif /* util_h_b7020fdb */