Expansions: more debug verbosity in expansion conditions
[exim.git] / src / src / mytypes.h
CommitLineData
059ec3d9
PH
1/*************************************************
2* Exim - an Internet mail transport agent *
3*************************************************/
4
3386088d 5/* Copyright (c) University of Cambridge 1995 - 2015 */
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
11local_scan.h includes it and exim.h includes them both (to get this earlier). */
12
13#ifndef MYTYPES_H
14#define MYTYPES_H
15
d1406d48 16#ifndef FALSE
059ec3d9 17#define FALSE 0
d1406d48
NM
18#endif
19
20#ifndef TRUE
059ec3d9 21#define TRUE 1
d1406d48
NM
22#endif
23
24#ifndef TRUE_UNSET
059ec3d9 25#define TRUE_UNSET 2
d1406d48 26#endif
059ec3d9
PH
27
28
29/* If gcc is being used to compile Exim, we can use its facility for checking
30the arguments of printf-like functions. This is done by a macro. */
31
b3c261f7 32#if defined(__GNUC__) || defined(__clang__)
ce552449 33#define PRINTF_FUNCTION(A,B) __attribute__((format(printf,A,B)))
7be682ca 34#define ARG_UNUSED __attribute__((__unused__))
059ec3d9 35#else
ce552449 36#define PRINTF_FUNCTION(A,B)
7be682ca 37#define ARG_UNUSED /**/
059ec3d9
PH
38#endif
39
81f91683
PP
40#ifdef WANT_DEEPER_PRINTF_CHECKS
41#define ALMOST_PRINTF(A, B) PRINTF_FUNCTION(A, B)
42#else
43#define ALMOST_PRINTF(A, B)
44#endif
45
059ec3d9
PH
46
47/* Some operating systems (naughtily, imo) include a definition for "uchar" in
48the standard header files, so we use "uschar". Solaris has u_char in
49sys/types.h. This is just a typing convenience, of course. */
50
059ec3d9 51typedef unsigned char uschar;
cd59ab18
PP
52typedef int BOOL;
53/* We also have SIGNAL_BOOL, which requires signal.h be included, so is defined
54elsewhere */
059ec3d9
PH
55
56
57/* These macros save typing for the casting that is needed to cope with the
58mess that is "char" in ISO/ANSI C. Having now been bitten enough times by
59systems where "char" is actually signed, I've converted Exim to use entirely
60unsigned chars, except in a few special places such as arguments that are
61almost always literal strings. */
62
63#define CS (char *)
64#define CCS (const char *)
65#define CSS (char **)
66#define US (unsigned char *)
67#define CUS (const unsigned char *)
68#define USS (unsigned char **)
55414b25 69#define CUSS (const unsigned char **)
059ec3d9
PH
70
71/* The C library string functions expect "char *" arguments. Use macros to
72avoid having to write a cast each time. We do this for string and file
73functions that are called quite often; for other calls to external libraries
74(which are on the whole special-purpose) we just use individual casts. */
75
76#define Uatoi(s) atoi(CCS(s))
77#define Uatol(s) atol(CCS(s))
78#define Uchdir(s) chdir(CCS(s))
79#define Uchmod(s,n) chmod(CCS(s),n)
80#define Uchown(s,n,m) chown(CCS(s),n,m)
81#define Ufgets(b,n,f) fgets(CS(b),n,f)
82#define Ufopen(s,t) fopen(CCS(s),CCS(t))
83#define Ulink(s,t) link(CCS(s),CCS(t))
84#define Ulstat(s,t) lstat(CCS(s),t)
85
86#ifdef O_BINARY /* This is for Cygwin, */
87#define Uopen(s,n,m) open(CCS(s),(n)|O_BINARY,m) /* where all files must */
88#else /* be opened as binary */
89#define Uopen(s,n,m) open(CCS(s),n,m) /* to avoid problems */
90#endif /* with CRLF endings. */
91#define Uread(f,b,l) read(f,CS(b),l)
92#define Urename(s,t) rename(CCS(s),CCS(t))
93#define Ustat(s,t) stat(CCS(s),t)
94#define Ustrcat(s,t) strcat(CS(s),CCS(t))
95#define Ustrchr(s,n) US strchr(CCS(s),n)
96#define CUstrchr(s,n) CUS strchr(CCS(s),n)
97#define CUstrerror(n) CUS strerror(n)
98#define Ustrcmp(s,t) strcmp(CCS(s),CCS(t))
99#define Ustrcpy(s,t) strcpy(CS(s),CCS(t))
100#define Ustrcspn(s,t) strcspn(CCS(s),CCS(t))
101#define Ustrftime(s,m,f,t) strftime(CS(s),m,f,t)
102#define Ustrlen(s) (int)strlen(CCS(s))
103#define Ustrncat(s,t,n) strncat(CS(s),CCS(t),n)
104#define Ustrncmp(s,t,n) strncmp(CCS(s),CCS(t),n)
105#define Ustrncpy(s,t,n) strncpy(CS(s),CCS(t),n)
106#define Ustrpbrk(s,t) strpbrk(CCS(s),CCS(t))
107#define Ustrrchr(s,n) US strrchr(CCS(s),n)
108#define CUstrrchr(s,n) CUS strrchr(CCS(s),n)
109#define Ustrspn(s,t) strspn(CCS(s),CCS(t))
110#define Ustrstr(s,t) US strstr(CCS(s),CCS(t))
111#define CUstrstr(s,t) CUS strstr(CCS(s),CCS(t))
112#define Ustrtod(s,t) strtod(CCS(s),CSS(t))
113#define Ustrtol(s,t,b) strtol(CCS(s),CSS(t),b)
114#define Ustrtoul(s,t,b) strtoul(CCS(s),CSS(t),b)
115#define Uunlink(s) unlink(CCS(s))
116#endif
117
118/* End of mytypes.h */