; Add entry to MAINTAINERS
[emacs.git] / src / conf_post.h
blobd0f04b637002b63ba01046997346ceae5c08e14e
1 /* conf_post.h --- configure.ac includes this via AH_BOTTOM
3 Copyright (C) 1988, 1993-1994, 1999-2002, 2004-2016 Free Software
4 Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* Commentary:
23 Rather than writing this code directly in AH_BOTTOM, we include it
24 via this file. This is so that it does not get processed by
25 autoheader. Eg, any undefs here would otherwise be commented out.
28 /* Code: */
30 /* Include any platform specific configuration file. */
31 #ifdef config_opsysfile
32 # include config_opsysfile
33 #endif
35 #include <stdbool.h>
37 /* The type of bool bitfields. Needed to compile Objective-C with
38 standard GCC. It was also needed to port to pre-C99 compilers,
39 although we don't care about that any more. */
40 #if NS_IMPL_GNUSTEP
41 typedef unsigned int bool_bf;
42 #else
43 typedef bool bool_bf;
44 #endif
46 #ifndef WINDOWSNT
47 /* On AIX 3 this must be included before any other include file. */
48 #include <alloca.h>
49 #if ! HAVE_ALLOCA
50 # error "alloca not available on this machine"
51 #endif
52 #endif
54 /* Simulate __has_attribute on compilers that lack it. It is used only
55 on arguments like alloc_size that are handled in this simulation. */
56 #ifndef __has_attribute
57 # define __has_attribute(a) __has_attribute_##a
58 # define __has_attribute_alloc_size (4 < __GNUC__ + (3 <= __GNUC_MINOR__))
59 # define __has_attribute_cleanup (3 < __GNUC__ + (4 <= __GNUC_MINOR__))
60 # define __has_attribute_externally_visible \
61 (4 < __GNUC__ + (1 <= __GNUC_MINOR__))
62 # define __has_attribute_no_address_safety_analysis false
63 # define __has_attribute_no_sanitize_address \
64 (4 < __GNUC__ + (8 <= __GNUC_MINOR__))
65 #endif
67 /* Simulate __has_feature on compilers that lack it. It is used only
68 to define ADDRESS_SANITIZER below. */
69 #ifndef __has_feature
70 # define __has_feature(a) false
71 #endif
73 /* True if addresses are being sanitized. */
74 #if defined __SANITIZE_ADDRESS__ || __has_feature (address_sanitizer)
75 # define ADDRESS_SANITIZER true
76 #else
77 # define ADDRESS_SANITIZER false
78 #endif
80 #ifdef DARWIN_OS
81 #ifdef emacs
82 #define malloc unexec_malloc
83 #define realloc unexec_realloc
84 #define free unexec_free
85 #endif
86 /* The following solves the problem that Emacs hangs when evaluating
87 (make-comint "test0" "/nodir/nofile" nil "") when /nodir/nofile
88 does not exist. Also, setsid is not allowed in the vfork child's
89 context as of Darwin 9/Mac OS X 10.5. */
90 #undef HAVE_WORKING_VFORK
91 #define vfork fork
92 #endif /* DARWIN_OS */
94 /* If HYBRID_MALLOC is defined (e.g., on Cygwin), emacs will use
95 gmalloc before dumping and the system malloc after dumping.
96 hybrid_malloc and friends, defined in gmalloc.c, are wrappers that
97 accomplish this. */
98 #ifdef HYBRID_MALLOC
99 #ifdef emacs
100 #define malloc hybrid_malloc
101 #define realloc hybrid_realloc
102 #define calloc hybrid_calloc
103 #define free hybrid_free
104 #if defined HAVE_GET_CURRENT_DIR_NAME && !defined BROKEN_GET_CURRENT_DIR_NAME
105 #define HYBRID_GET_CURRENT_DIR_NAME 1
106 #define get_current_dir_name hybrid_get_current_dir_name
107 #endif
108 #endif
109 #endif /* HYBRID_MALLOC */
111 /* We have to go this route, rather than the old hpux9 approach of
112 renaming the functions via macros. The system's stdlib.h has fully
113 prototyped declarations, which yields a conflicting definition of
114 srand48; it tries to redeclare what was once srandom to be srand48.
115 So we go with HAVE_LRAND48 being defined. */
116 #ifdef HPUX
117 #undef srandom
118 #undef random
119 #undef HAVE_RANDOM
120 #undef HAVE_RINT
121 #endif /* HPUX */
123 #ifdef IRIX6_5
124 #ifdef emacs
125 char *_getpty();
126 #endif
127 #define INET6 /* Needed for struct sockaddr_in6. */
128 #undef HAVE_GETADDRINFO /* IRIX has getaddrinfo but not struct addrinfo. */
129 #endif /* IRIX6_5 */
131 #ifdef MSDOS
132 #ifndef __DJGPP__
133 You lose; /* Emacs for DOS must be compiled with DJGPP */
134 #endif
135 #define _NAIVE_DOS_REGS
137 /* Start of gnulib-related stuff */
139 /* lib/ftoastr.c wants strtold, but DJGPP only has _strtold. DJGPP >
140 2.03 has it, but it also has _strtold as a stub that jumps to
141 strtold, so use _strtold in all versions. */
142 #define strtold _strtold
144 #if __DJGPP__ > 2 || __DJGPP_MINOR__ > 3
145 # define HAVE_LSTAT 1
146 #else
147 # define lstat stat
148 #endif
150 /* We must intercept 'opendir' calls to stash away the directory name,
151 so we could reuse it in readlinkat; see msdos.c. */
152 #define opendir sys_opendir
154 /* End of gnulib-related stuff. */
156 #define emacs_raise(sig) msdos_fatal_signal (sig)
158 /* DATA_START is needed by vm-limit.c and unexcoff.c. */
159 #define DATA_START (&etext + 1)
161 /* Define one of these for easier conditionals. */
162 #ifdef HAVE_X_WINDOWS
163 /* We need a little extra space, see ../../lisp/loadup.el and the
164 commentary below, in the non-X branch. The 140KB number was
165 measured on GNU/Linux and on MS-Windows. */
166 #define SYSTEM_PURESIZE_EXTRA (-170000+140000)
167 #else
168 /* We need a little extra space, see ../../lisp/loadup.el.
169 As of 20091024, DOS-specific files use up 62KB of pure space. But
170 overall, we end up wasting 130KB of pure space, because
171 BASE_PURESIZE starts at 1.47MB, while we need only 1.3MB (including
172 non-DOS specific files and load history; the latter is about 55K,
173 but depends on the depth of the top-level Emacs directory in the
174 directory tree). Given the unknown policy of different DPMI
175 hosts regarding loading of untouched pages, I'm not going to risk
176 enlarging Emacs footprint by another 100+ KBytes. */
177 #define SYSTEM_PURESIZE_EXTRA (-170000+90000)
178 #endif
179 #endif /* MSDOS */
181 /* Mac OS X / GNUstep need a bit more pure memory. Of the existing knobs,
182 SYSTEM_PURESIZE_EXTRA seems like the least likely to cause problems. */
183 #ifdef HAVE_NS
184 #if defined NS_IMPL_GNUSTEP
185 # define SYSTEM_PURESIZE_EXTRA 30000
186 #elif defined DARWIN_OS
187 # define SYSTEM_PURESIZE_EXTRA 200000
188 #endif
189 #endif
191 #ifdef CYGWIN
192 #define SYSTEM_PURESIZE_EXTRA 10000
193 #endif
195 #if defined HAVE_NTGUI && !defined DebPrint
196 # ifdef EMACSDEBUG
197 extern void _DebPrint (const char *fmt, ...);
198 # define DebPrint(stuff) _DebPrint stuff
199 # else
200 # define DebPrint(stuff)
201 # endif
202 #endif
204 #if defined CYGWIN && defined HAVE_NTGUI
205 # define NTGUI_UNICODE /* Cygwin runs only on UNICODE-supporting systems */
206 # define _WIN32_WINNT 0x500 /* Win2k */
207 /* The following was in /usr/include/string.h prior to Cygwin 1.7.33. */
208 #ifndef strnicmp
209 #define strnicmp strncasecmp
210 #endif
211 #endif
213 #ifdef emacs /* Don't do this for lib-src. */
214 /* Tell regex.c to use a type compatible with Emacs. */
215 #define RE_TRANSLATE_TYPE Lisp_Object
216 #define RE_TRANSLATE(TBL, C) char_table_translate (TBL, C)
217 #define RE_TRANSLATE_P(TBL) (!EQ (TBL, make_number (0)))
218 #endif
220 /* Tell time_rz.c to use Emacs's getter and setter for TZ.
221 Only Emacs uses time_rz so this is OK. */
222 #define getenv_TZ emacs_getenv_TZ
223 #define setenv_TZ emacs_setenv_TZ
224 extern char *emacs_getenv_TZ (void);
225 extern int emacs_setenv_TZ (char const *);
227 #include <string.h>
228 #include <stdlib.h>
230 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
231 #define NO_INLINE __attribute__((noinline))
232 #else
233 #define NO_INLINE
234 #endif
236 #if __has_attribute (externally_visible)
237 #define EXTERNALLY_VISIBLE __attribute__((externally_visible))
238 #else
239 #define EXTERNALLY_VISIBLE
240 #endif
242 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
243 # define ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
244 #else
245 # define ATTRIBUTE_FORMAT(spec) /* empty */
246 #endif
248 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
249 # define ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
250 ATTRIBUTE_FORMAT ((__gnu_printf__, formatstring_parameter, first_argument))
251 #else
252 # define ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
253 ATTRIBUTE_FORMAT ((__printf__, formatstring_parameter, first_argument))
254 #endif
256 #define ATTRIBUTE_CONST _GL_ATTRIBUTE_CONST
257 #define ATTRIBUTE_UNUSED _GL_UNUSED
259 #if 3 <= __GNUC__
260 # define ATTRIBUTE_MALLOC __attribute__ ((__malloc__))
261 #else
262 # define ATTRIBUTE_MALLOC
263 #endif
265 #if __has_attribute (alloc_size)
266 # define ATTRIBUTE_ALLOC_SIZE(args) __attribute__ ((__alloc_size__ args))
267 #else
268 # define ATTRIBUTE_ALLOC_SIZE(args)
269 #endif
271 #define ATTRIBUTE_MALLOC_SIZE(args) ATTRIBUTE_MALLOC ATTRIBUTE_ALLOC_SIZE (args)
273 /* Work around GCC bug 59600: when a function is inlined, the inlined
274 code may have its addresses sanitized even if the function has the
275 no_sanitize_address attribute. This bug is fixed in GCC 4.9.0 and
276 clang 3.4. */
277 #if (! ADDRESS_SANITIZER \
278 || ((4 < __GNUC__ + (9 <= __GNUC_MINOR__)) \
279 || 3 < __clang_major__ + (4 <= __clang_minor__)))
280 # define ADDRESS_SANITIZER_WORKAROUND /* No workaround needed. */
281 #else
282 # define ADDRESS_SANITIZER_WORKAROUND NO_INLINE
283 #endif
285 /* Attribute of functions whose code should not have addresses
286 sanitized. */
288 #if __has_attribute (no_sanitize_address)
289 # define ATTRIBUTE_NO_SANITIZE_ADDRESS \
290 __attribute__ ((no_sanitize_address)) ADDRESS_SANITIZER_WORKAROUND
291 #elif __has_attribute (no_address_safety_analysis)
292 # define ATTRIBUTE_NO_SANITIZE_ADDRESS \
293 __attribute__ ((no_address_safety_analysis)) ADDRESS_SANITIZER_WORKAROUND
294 #else
295 # define ATTRIBUTE_NO_SANITIZE_ADDRESS
296 #endif
298 /* Some versions of GNU/Linux define noinline in their headers. */
299 #ifdef noinline
300 #undef noinline
301 #endif
303 /* Use Gnulib's extern-inline module for extern inline functions.
304 An include file foo.h should prepend FOO_INLINE to function
305 definitions, with the following overall pattern:
307 [#include any other .h files first.]
309 INLINE_HEADER_BEGIN
311 INLINE int
312 incr (int i)
314 return i + 1;
317 INLINE_HEADER_END
319 For every executable, exactly one file that includes the header
320 should do this:
322 #define INLINE EXTERN_INLINE
324 before including config.h or any other .h file.
325 Other .c files should not define INLINE.
326 For Emacs, this is done by having emacs.c first '#define INLINE
327 EXTERN_INLINE' and then include every .h file that uses INLINE.
329 The INLINE_HEADER_BEGIN and INLINE_HEADER_END suppress bogus
330 warnings in some GCC versions; see ../m4/extern-inline.m4.
332 C99 compilers compile functions like 'incr' as C99-style extern
333 inline functions. Buggy GCC implementations do something similar with
334 GNU-specific keywords. Buggy non-GCC compilers use static
335 functions, which bloats the code but is good enough. */
337 #ifndef INLINE
338 # define INLINE _GL_INLINE
339 #endif
340 #define EXTERN_INLINE _GL_EXTERN_INLINE
341 #define INLINE_HEADER_BEGIN _GL_INLINE_HEADER_BEGIN
342 #define INLINE_HEADER_END _GL_INLINE_HEADER_END
344 /* To use the struct hack with N elements, declare the struct like this:
345 struct s { ...; t name[FLEXIBLE_ARRAY_MEMBER]; };
346 and allocate (offsetof (struct s, name) + N * sizeof (t)) bytes.
347 IBM xlc 12.1 claims to do C99 but mishandles flexible array members. */
348 #ifdef __IBMC__
349 # define FLEXIBLE_ARRAY_MEMBER 1
350 #else
351 # define FLEXIBLE_ARRAY_MEMBER
352 #endif
354 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
355 #ifdef lint
356 /* Use CODE only if lint checking is in effect. */
357 # define IF_LINT(Code) Code
358 #else
359 # define IF_LINT(Code) /* empty */
360 #endif
362 /* conf_post.h ends here */