Use attribute __gnu_printf__ with our estream-printf functions.
[gnupg.git] / common / mischelp.h
1 /* mischelp.h - Miscellaneous helper macros and functions
2  * Copyright (C) 1999, 2000, 2001, 2002, 2003,
3  *               2006, 2007, 2009  Free Software Foundation, Inc.
4  *
5  * This file is part of JNLIB, which is a subsystem of GnuPG.
6  *
7  * JNLIB is free software; you can redistribute it and/or modify it
8  * under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * JNLIB is distributed in the hope that it will be useful, but
23  * WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
25  * General Public License for more details.
26  *
27  * You should have received a copies of the GNU General Public License
28  * and the GNU Lesser General Public License along with this program;
29  * if not, see <http://www.gnu.org/licenses/>.
30  */
31
32 #ifndef LIBJNLIB_MISCHELP_H
33 #define LIBJNLIB_MISCHHELP_H
34
35
36 /* Because we can't use the internal jnlib_free macro in inline
37    functions we provide a wrapper function as well.   */
38 void _jnlib_free (void *p);
39
40 /* Check whether the files NAME1 and NAME2 are identical.  This is for
41    example achieved by comparing the inode numbers of the files.  */
42 int same_file_p (const char *name1, const char *name2);
43
44
45 #ifndef HAVE_TIMEGM
46 #include <time.h>
47 time_t timegm (struct tm *tm);
48 #endif /*!HAVE_TIMEGM*/
49
50
51 #define DIM(v)               (sizeof(v)/sizeof((v)[0]))
52 #define DIMof(type,member)   DIM(((type *)0)->member)
53
54
55 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
56 # define JNLIB_GCC_M_FUNCTION 1
57 # define JNLIB_GCC_A_NR              __attribute__ ((noreturn))
58 # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4 )
59 #   define JNLIB_GCC_A_PRINTF( f, a ) \
60                     __attribute__ ((format (__gnu_printf__,f,a)))
61 #   define JNLIB_GCC_A_NR_PRINTF( f, a ) \
62                     __attribute__ ((noreturn, format (__gnu_printf__,f,a)))
63 # else
64 #   define JNLIB_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
65 #   define JNLIB_GCC_A_NR_PRINTF( f, a ) \
66                             __attribute__ ((noreturn, format (printf,f,a)))
67 # endif
68 #else
69 # define JNLIB_GCC_A_NR
70 # define JNLIB_GCC_A_PRINTF( f, a )
71 # define JNLIB_GCC_A_NR_PRINTF( f, a )
72 #endif
73
74
75 /* To avoid that a compiler optimizes certain memset calls away, these
76    macros may be used instead. */
77 #define wipememory2(_ptr,_set,_len) do { \
78               volatile char *_vptr=(volatile char *)(_ptr); \
79               size_t _vlen=(_len); \
80               while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } \
81                   } while(0)
82 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
83
84
85 /* Include hacks which are mainly required for Slowaris.  */
86 #ifdef JNLIB_NEED_AFLOCAL
87 #ifndef HAVE_W32_SYSTEM
88 # include <sys/socket.h>
89 # include <sys/un.h>
90 #else
91 # ifdef HAVE_WINSOCK2_H
92 #  include <winsock2.h>
93 # endif
94 # include <windows.h>
95 #endif
96
97 #ifndef PF_LOCAL
98 # ifdef PF_UNIX
99 #  define PF_LOCAL PF_UNIX
100 # else
101 #  define PF_LOCAL AF_UNIX
102 # endif
103 #endif /*PF_LOCAL*/
104 #ifndef AF_LOCAL
105 # define AF_LOCAL AF_UNIX
106 #endif /*AF_UNIX*/
107
108 /* We used to avoid this macro in GnuPG and inlined the AF_LOCAL name
109    length computation directly with the little twist of adding 1 extra
110    byte.  It seems that this was needed once on an old HP/UX box and
111    there are also rumours that 4.3 Reno and DEC systems need it.  This
112    one-off buglet did not harm any current system until it came to Mac
113    OS X where the kernel (as of May 2009) exhibited a strange bug: The
114    systems basically froze in the connect call if the passed name
115    contained an invalid directory part.  Ignore the old Unices.  */
116 #ifndef SUN_LEN
117 # define SUN_LEN(ptr) ((size_t) (((struct sockaddr_un *) 0)->sun_path) \
118                        + strlen ((ptr)->sun_path))
119 #endif /*SUN_LEN*/
120 #endif /*JNLIB_NEED_AFLOCAL*/
121
122
123 #endif /*LIBJNLIB_MISCHELP_H*/