Commit | Line | Data |
---|---|---|
059ec3d9 PH |
1 | /************************************************* |
2 | * Exim - an Internet mail transport agent * | |
3 | *************************************************/ | |
4 | ||
f9ba5e22 | 5 | /* Copyright (c) University of Cambridge 1995 - 2018 */ |
059ec3d9 PH |
6 | /* See the file NOTICE for conditions of use and distribution. */ |
7 | ||
8 | ||
9 | /* This header file contains type definitions and macros that I use as | |
10 | "standard" in the code of Exim and its utilities. Make it idempotent because | |
11 | local_scan.h includes it and exim.h includes them both (to get this earlier). */ | |
12 | ||
13 | #ifndef MYTYPES_H | |
14 | #define MYTYPES_H | |
15 | ||
f3ebb786 JH |
16 | # include <string.h> |
17 | ||
d1406d48 | 18 | #ifndef FALSE |
2f4df477 | 19 | # define FALSE 0 |
d1406d48 NM |
20 | #endif |
21 | ||
22 | #ifndef TRUE | |
2f4df477 | 23 | # define TRUE 1 |
d1406d48 NM |
24 | #endif |
25 | ||
26 | #ifndef TRUE_UNSET | |
2f4df477 | 27 | # define TRUE_UNSET 2 |
d1406d48 | 28 | #endif |
059ec3d9 PH |
29 | |
30 | ||
31 | /* If gcc is being used to compile Exim, we can use its facility for checking | |
32 | the arguments of printf-like functions. This is done by a macro. */ | |
33 | ||
b3c261f7 | 34 | #if defined(__GNUC__) || defined(__clang__) |
268d00ff JH |
35 | # define PRINTF_FUNCTION(A,B) __attribute__((format(printf,A,B))) |
36 | # define ARG_UNUSED __attribute__((__unused__)) | |
37 | # define WARN_UNUSED_RESULT __attribute__((__warn_unused_result__)) | |
1d1e7973 JH |
38 | # define ALLOC __attribute__((malloc)) |
39 | # define ALLOC_SIZE(A) __attribute__((alloc_size(A))) | |
40 | # define NORETURN __attribute__((noreturn)) | |
059ec3d9 | 41 | #else |
2f4df477 | 42 | # define PRINTF_FUNCTION(A,B) |
1d1e7973 JH |
43 | # define ARG_UNUSED /**/ |
44 | # define WARN_UNUSED_RESULT /**/ | |
45 | # define ALLOC /**/ | |
46 | # define ALLOC_SIZE(A) /**/ | |
47 | # define NORETURN /**/ | |
059ec3d9 PH |
48 | #endif |
49 | ||
81f91683 | 50 | #ifdef WANT_DEEPER_PRINTF_CHECKS |
2f4df477 | 51 | # define ALMOST_PRINTF(A, B) PRINTF_FUNCTION(A, B) |
81f91683 | 52 | #else |
2f4df477 | 53 | # define ALMOST_PRINTF(A, B) |
81f91683 PP |
54 | #endif |
55 | ||
059ec3d9 PH |
56 | |
57 | /* Some operating systems (naughtily, imo) include a definition for "uchar" in | |
58 | the standard header files, so we use "uschar". Solaris has u_char in | |
59 | sys/types.h. This is just a typing convenience, of course. */ | |
60 | ||
059ec3d9 | 61 | typedef unsigned char uschar; |
a207d5dd | 62 | typedef unsigned BOOL; |
cd59ab18 PP |
63 | /* We also have SIGNAL_BOOL, which requires signal.h be included, so is defined |
64 | elsewhere */ | |
059ec3d9 PH |
65 | |
66 | ||
67 | /* These macros save typing for the casting that is needed to cope with the | |
68 | mess that is "char" in ISO/ANSI C. Having now been bitten enough times by | |
69 | systems where "char" is actually signed, I've converted Exim to use entirely | |
70 | unsigned chars, except in a few special places such as arguments that are | |
71 | almost always literal strings. */ | |
72 | ||
73 | #define CS (char *) | |
74 | #define CCS (const char *) | |
75 | #define CSS (char **) | |
76 | #define US (unsigned char *) | |
77 | #define CUS (const unsigned char *) | |
78 | #define USS (unsigned char **) | |
55414b25 | 79 | #define CUSS (const unsigned char **) |
3d2e82c5 | 80 | #define CCSS (const char **) |
059ec3d9 PH |
81 | |
82 | /* The C library string functions expect "char *" arguments. Use macros to | |
83 | avoid having to write a cast each time. We do this for string and file | |
84 | functions that are called quite often; for other calls to external libraries | |
85 | (which are on the whole special-purpose) we just use individual casts. */ | |
86 | ||
87 | #define Uatoi(s) atoi(CCS(s)) | |
88 | #define Uatol(s) atol(CCS(s)) | |
89 | #define Uchdir(s) chdir(CCS(s)) | |
90 | #define Uchmod(s,n) chmod(CCS(s),n) | |
059ec3d9 | 91 | #define Ufgets(b,n,f) fgets(CS(b),n,f) |
9e21ce8f | 92 | #define Ufopen(s,t) exim_fopen(CCS(s),CCS(t)) |
059ec3d9 PH |
93 | #define Ulink(s,t) link(CCS(s),CCS(t)) |
94 | #define Ulstat(s,t) lstat(CCS(s),t) | |
95 | ||
9e21ce8f | 96 | #ifdef O_BINARY /* This is for Cygwin, */ |
36eb5d3d JH |
97 | # define Uopen(s,n,m) exim_open(CCS(s),(n)|O_BINARY,m) /* where all files must */ |
98 | # define Uopen2(s,n) exim_open2(CCS(s),(n)|O_BINARY) | |
9e21ce8f | 99 | #else /* be opened as binary */ |
36eb5d3d JH |
100 | # define Uopen(s,n,m) exim_open(CCS(s),n,m) /* to avoid problems */ |
101 | # define Uopen2(s,n) exim_open2(CCS(s),n) | |
9e21ce8f | 102 | #endif /* with CRLF endings. */ |
059ec3d9 PH |
103 | #define Uread(f,b,l) read(f,CS(b),l) |
104 | #define Urename(s,t) rename(CCS(s),CCS(t)) | |
105 | #define Ustat(s,t) stat(CCS(s),t) | |
059ec3d9 PH |
106 | #define Ustrchr(s,n) US strchr(CCS(s),n) |
107 | #define CUstrchr(s,n) CUS strchr(CCS(s),n) | |
108 | #define CUstrerror(n) CUS strerror(n) | |
109 | #define Ustrcmp(s,t) strcmp(CCS(s),CCS(t)) | |
f3ebb786 | 110 | #define Ustrcpy_nt(s,t) strcpy(CS s, CCS t) /* no taint check */ |
059ec3d9 PH |
111 | #define Ustrcspn(s,t) strcspn(CCS(s),CCS(t)) |
112 | #define Ustrftime(s,m,f,t) strftime(CS(s),m,f,t) | |
113 | #define Ustrlen(s) (int)strlen(CCS(s)) | |
059ec3d9 | 114 | #define Ustrncmp(s,t,n) strncmp(CCS(s),CCS(t),n) |
f3ebb786 | 115 | #define Ustrncpy_nt(s,t,n) strncpy(CS s, CCS t, n) /* no taint check */ |
059ec3d9 PH |
116 | #define Ustrpbrk(s,t) strpbrk(CCS(s),CCS(t)) |
117 | #define Ustrrchr(s,n) US strrchr(CCS(s),n) | |
118 | #define CUstrrchr(s,n) CUS strrchr(CCS(s),n) | |
119 | #define Ustrspn(s,t) strspn(CCS(s),CCS(t)) | |
120 | #define Ustrstr(s,t) US strstr(CCS(s),CCS(t)) | |
121 | #define CUstrstr(s,t) CUS strstr(CCS(s),CCS(t)) | |
122 | #define Ustrtod(s,t) strtod(CCS(s),CSS(t)) | |
123 | #define Ustrtol(s,t,b) strtol(CCS(s),CSS(t),b) | |
124 | #define Ustrtoul(s,t,b) strtoul(CCS(s),CSS(t),b) | |
125 | #define Uunlink(s) unlink(CCS(s)) | |
e59797e3 | 126 | |
df92b047 | 127 | #if defined(EM_VERSION_C) || defined(LOCAL_SCAN) || defined(DLFUNC_IMPL) |
36eb5d3d JH |
128 | # define Ustrcat(s,t) strcat(CS(s), CCS(t)) |
129 | # define Ustrcpy(s,t) strcpy(CS(s), CCS(t)) | |
130 | # define Ustrncat(s,t,n) strncat(CS(s), CCS(t), n) | |
131 | # define Ustrncpy(s,t,n) strncpy(CS(s), CCS(t), n) | |
aaabfafe | 132 | #else |
36eb5d3d JH |
133 | # define Ustrcat(s,t) __Ustrcat(s, CUS(t), __FUNCTION__, __LINE__) |
134 | # define Ustrcpy(s,t) __Ustrcpy(s, CUS(t), __FUNCTION__, __LINE__) | |
135 | # define Ustrncat(s,t,n) __Ustrncat(s, CUS(t), n, __FUNCTION__, __LINE__) | |
136 | # define Ustrncpy(s,t,n) __Ustrncpy(s, CUS(t), n, __FUNCTION__, __LINE__) | |
f3ebb786 | 137 | #endif |
059ec3d9 | 138 | |
f3ebb786 | 139 | #endif |
059ec3d9 | 140 | /* End of mytypes.h */ |