Fix incorrect usage of @key in the User Manual (Bug#20135)
[emacs.git] / src / conf_post.h
blob246739d457b0b307cbb850092f37bd5177da72ce
1 /* conf_post.h --- configure.ac includes this via AH_BOTTOM
3 Copyright (C) 1988, 1993-1994, 1999-2002, 2004-2015 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
11 (at 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 pre-C99 <stdbool.h> emulation doesn't work for bool bitfields.
38 Nor does compiling Objective-C with standard GCC. */
39 #if __STDC_VERSION__ < 199901 || NS_IMPL_GNUSTEP
40 typedef unsigned int bool_bf;
41 #else
42 typedef bool bool_bf;
43 #endif
45 #ifndef WINDOWSNT
46 /* On AIX 3 this must be included before any other include file. */
47 #include <alloca.h>
48 #if ! HAVE_ALLOCA
49 # error "alloca not available on this machine"
50 #endif
51 #endif
53 /* When not using Clang, assume its attributes and features are absent. */
54 #ifndef __has_attribute
55 # define __has_attribute(a) false
56 #endif
57 #ifndef __has_feature
58 # define __has_feature(a) false
59 #endif
61 /* True if addresses are being sanitized. */
62 #if defined __SANITIZE_ADDRESS__ || __has_feature (address_sanitizer)
63 # define ADDRESS_SANITIZER true
64 #else
65 # define ADDRESS_SANITIZER false
66 #endif
68 #ifdef DARWIN_OS
69 #ifdef emacs
70 #define malloc unexec_malloc
71 #define realloc unexec_realloc
72 #define free unexec_free
73 #endif
74 /* The following solves the problem that Emacs hangs when evaluating
75 (make-comint "test0" "/nodir/nofile" nil "") when /nodir/nofile
76 does not exist. Also, setsid is not allowed in the vfork child's
77 context as of Darwin 9/Mac OS X 10.5. */
78 #undef HAVE_WORKING_VFORK
79 #define vfork fork
80 #endif /* DARWIN_OS */
82 /* We have to go this route, rather than the old hpux9 approach of
83 renaming the functions via macros. The system's stdlib.h has fully
84 prototyped declarations, which yields a conflicting definition of
85 srand48; it tries to redeclare what was once srandom to be srand48.
86 So we go with HAVE_LRAND48 being defined. */
87 #ifdef HPUX
88 #undef srandom
89 #undef random
90 /* We try to avoid checking for random and rint on hpux in
91 configure.ac, but some other configure test might check for them as
92 a dependency, so to be safe we also undefine them here.
94 #undef HAVE_RANDOM
95 #undef HAVE_RINT
96 #endif /* HPUX */
98 #ifdef IRIX6_5
99 #ifdef emacs
100 char *_getpty();
101 #endif
102 #define INET6 /* Needed for struct sockaddr_in6. */
103 #undef HAVE_GETADDRINFO /* IRIX has getaddrinfo but not struct addrinfo. */
104 #endif /* IRIX6_5 */
106 #ifdef MSDOS
107 #ifndef __DJGPP__
108 You lose; /* Emacs for DOS must be compiled with DJGPP */
109 #endif
110 #define _NAIVE_DOS_REGS
112 /* Start of gnulib-related stuff */
114 /* lib/ftoastr.c wants strtold, but DJGPP only has _strtold. DJGPP >
115 2.03 has it, but it also has _strtold as a stub that jumps to
116 strtold, so use _strtold in all versions. */
117 #define strtold _strtold
119 #if __DJGPP__ > 2 || __DJGPP_MINOR__ > 3
120 # define HAVE_LSTAT 1
121 #else
122 # define lstat stat
123 #endif
125 /* We must intercept 'opendir' calls to stash away the directory name,
126 so we could reuse it in readlinkat; see msdos.c. */
127 #define opendir sys_opendir
129 /* End of gnulib-related stuff. */
131 #define emacs_raise(sig) msdos_fatal_signal (sig)
133 /* DATA_START is needed by vm-limit.c and unexcoff.c. */
134 #define DATA_START (&etext + 1)
136 /* Define one of these for easier conditionals. */
137 #ifdef HAVE_X_WINDOWS
138 /* We need a little extra space, see ../../lisp/loadup.el and the
139 commentary below, in the non-X branch. The 140KB number was
140 measured on GNU/Linux and on MS-Windows. */
141 #define SYSTEM_PURESIZE_EXTRA (-170000+140000)
142 #else
143 /* We need a little extra space, see ../../lisp/loadup.el.
144 As of 20091024, DOS-specific files use up 62KB of pure space. But
145 overall, we end up wasting 130KB of pure space, because
146 BASE_PURESIZE starts at 1.47MB, while we need only 1.3MB (including
147 non-DOS specific files and load history; the latter is about 55K,
148 but depends on the depth of the top-level Emacs directory in the
149 directory tree). Given the unknown policy of different DPMI
150 hosts regarding loading of untouched pages, I'm not going to risk
151 enlarging Emacs footprint by another 100+ KBytes. */
152 #define SYSTEM_PURESIZE_EXTRA (-170000+90000)
153 #endif
154 #endif /* MSDOS */
156 /* Mac OS X / GNUstep need a bit more pure memory. Of the existing knobs,
157 SYSTEM_PURESIZE_EXTRA seems like the least likely to cause problems. */
158 #ifdef HAVE_NS
159 #if defined NS_IMPL_GNUSTEP
160 # define SYSTEM_PURESIZE_EXTRA 30000
161 #elif defined DARWIN_OS
162 # define SYSTEM_PURESIZE_EXTRA 200000
163 #endif
164 #endif
166 #ifdef CYGWIN
167 #define SYSTEM_PURESIZE_EXTRA 10000
168 #endif
170 #if defined HAVE_NTGUI && !defined DebPrint
171 # ifdef EMACSDEBUG
172 extern void _DebPrint (const char *fmt, ...);
173 # define DebPrint(stuff) _DebPrint stuff
174 # else
175 # define DebPrint(stuff)
176 # endif
177 #endif
179 #if defined CYGWIN && defined HAVE_NTGUI
180 # define NTGUI_UNICODE /* Cygwin runs only on UNICODE-supporting systems */
181 # define _WIN32_WINNT 0x500 /* Win2k */
182 /* The following was in /usr/include/string.h prior to Cygwin 1.7.33. */
183 #ifndef strnicmp
184 #define strnicmp strncasecmp
185 #endif
186 #endif
188 #ifdef emacs /* Don't do this for lib-src. */
189 /* Tell regex.c to use a type compatible with Emacs. */
190 #define RE_TRANSLATE_TYPE Lisp_Object
191 #define RE_TRANSLATE(TBL, C) char_table_translate (TBL, C)
192 #define RE_TRANSLATE_P(TBL) (!EQ (TBL, make_number (0)))
193 #endif
195 #include <string.h>
196 #include <stdlib.h>
198 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
199 #define NO_INLINE __attribute__((noinline))
200 #else
201 #define NO_INLINE
202 #endif
204 #if (__clang__ \
205 ? __has_attribute (externally_visible) \
206 : (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 1)))
207 #define EXTERNALLY_VISIBLE __attribute__((externally_visible))
208 #else
209 #define EXTERNALLY_VISIBLE
210 #endif
212 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
213 # define ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
214 #else
215 # define ATTRIBUTE_FORMAT(spec) /* empty */
216 #endif
218 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)
219 # define ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
220 ATTRIBUTE_FORMAT ((__gnu_printf__, formatstring_parameter, first_argument))
221 #else
222 # define ATTRIBUTE_FORMAT_PRINTF(formatstring_parameter, first_argument) \
223 ATTRIBUTE_FORMAT ((__printf__, formatstring_parameter, first_argument))
224 #endif
226 #define ATTRIBUTE_CONST _GL_ATTRIBUTE_CONST
228 /* Work around GCC bug 59600: when a function is inlined, the inlined
229 code may have its addresses sanitized even if the function has the
230 no_sanitize_address attribute. This bug is present in GCC 4.8.2
231 and clang 3.3, the latest releases as of December 2013, and the
232 only platforms known to support address sanitization. When the bug
233 is fixed the #if can be updated accordingly. */
234 #if ADDRESS_SANITIZER
235 # define ADDRESS_SANITIZER_WORKAROUND NO_INLINE
236 #else
237 # define ADDRESS_SANITIZER_WORKAROUND
238 #endif
240 /* Attribute of functions whose code should not have addresses
241 sanitized. */
243 #if (__has_attribute (no_sanitize_address) \
244 || 4 < __GNUC__ + (8 <= __GNUC_MINOR__))
245 # define ATTRIBUTE_NO_SANITIZE_ADDRESS \
246 __attribute__ ((no_sanitize_address)) ADDRESS_SANITIZER_WORKAROUND
247 #elif __has_attribute (no_address_safety_analysis)
248 # define ATTRIBUTE_NO_SANITIZE_ADDRESS \
249 __attribute__ ((no_address_safety_analysis)) ADDRESS_SANITIZER_WORKAROUND
250 #else
251 # define ATTRIBUTE_NO_SANITIZE_ADDRESS
252 #endif
254 /* Some versions of GNU/Linux define noinline in their headers. */
255 #ifdef noinline
256 #undef noinline
257 #endif
259 /* Use Gnulib's extern-inline module for extern inline functions.
260 An include file foo.h should prepend FOO_INLINE to function
261 definitions, with the following overall pattern:
263 [#include any other .h files first.]
265 INLINE_HEADER_BEGIN
267 INLINE int
268 incr (int i)
270 return i + 1;
273 INLINE_HEADER_END
275 For every executable, exactly one file that includes the header
276 should do this:
278 #define INLINE EXTERN_INLINE
280 before including config.h or any other .h file.
281 Other .c files should not define INLINE.
283 C99 compilers compile functions like 'incr' as C99-style extern
284 inline functions. Pre-C99 GCCs do something similar with
285 GNU-specific keywords. Pre-C99 non-GCC compilers use static
286 functions, which bloats the code but is good enough. */
288 #ifndef INLINE
289 # define INLINE _GL_INLINE
290 #endif
291 #define EXTERN_INLINE _GL_EXTERN_INLINE
292 #define INLINE_HEADER_BEGIN _GL_INLINE_HEADER_BEGIN
293 #define INLINE_HEADER_END _GL_INLINE_HEADER_END
295 /* To use the struct hack with N elements, declare the struct like this:
296 struct s { ...; t name[FLEXIBLE_ARRAY_MEMBER]; };
297 and allocate (offsetof (struct s, name) + N * sizeof (t)) bytes.
298 IBM xlc 12.1 claims to do C99 but mishandles flexible array members. */
299 #if 199901 <= __STDC_VERSION__ && !defined __IBMC__
300 # define FLEXIBLE_ARRAY_MEMBER
301 #elif __GNUC__ && !defined __STRICT_ANSI__
302 # define FLEXIBLE_ARRAY_MEMBER 0
303 #else
304 # define FLEXIBLE_ARRAY_MEMBER 1
305 #endif
307 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
308 #ifdef lint
309 /* Use CODE only if lint checking is in effect. */
310 # define IF_LINT(Code) Code
311 #else
312 # define IF_LINT(Code) /* empty */
313 #endif
315 /* conf_post.h ends here */