Fix typos in documentation of fopen ",ccs=STRING".
[glibc.git] / include / features.h
blob6038ecc78df3c28a828530efd513c4a89899a3bd
1 /* Copyright (C) 1991-1993,1995-2007,2009,2010,2011
2 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
19 #ifndef _FEATURES_H
20 #define _FEATURES_H 1
22 /* These are defined by the user (or the compiler)
23 to specify the desired environment:
25 __STRICT_ANSI__ ISO Standard C.
26 _ISOC99_SOURCE Extensions to ISO C89 from ISO C99.
27 _ISOC11_SOURCE Extensions to ISO C99 from ISO C11.
28 _POSIX_SOURCE IEEE Std 1003.1.
29 _POSIX_C_SOURCE If ==1, like _POSIX_SOURCE; if >=2 add IEEE Std 1003.2;
30 if >=199309L, add IEEE Std 1003.1b-1993;
31 if >=199506L, add IEEE Std 1003.1c-1995;
32 if >=200112L, all of IEEE 1003.1-2004
33 if >=200809L, all of IEEE 1003.1-2008
34 _XOPEN_SOURCE Includes POSIX and XPG things. Set to 500 if
35 Single Unix conformance is wanted, to 600 for the
36 sixth revision, to 700 for the seventh revision.
37 _XOPEN_SOURCE_EXTENDED XPG things and X/Open Unix extensions.
38 _LARGEFILE_SOURCE Some more functions for correct standard I/O.
39 _LARGEFILE64_SOURCE Additional functionality from LFS for large files.
40 _FILE_OFFSET_BITS=N Select default filesystem interface.
41 _BSD_SOURCE ISO C, POSIX, and 4.3BSD things.
42 _SVID_SOURCE ISO C, POSIX, and SVID things.
43 _ATFILE_SOURCE Additional *at interfaces.
44 _GNU_SOURCE All of the above, plus GNU extensions.
45 _REENTRANT Select additionally reentrant object.
46 _THREAD_SAFE Same as _REENTRANT, often used by other systems.
47 _FORTIFY_SOURCE If set to numeric value > 0 additional security
48 measures are defined, according to level.
50 The `-ansi' switch to the GNU C compiler defines __STRICT_ANSI__.
51 If none of these are defined, the default is to have _SVID_SOURCE,
52 _BSD_SOURCE, and _POSIX_SOURCE set to one and _POSIX_C_SOURCE set to
53 200112L. If more than one of these are defined, they accumulate.
54 For example __STRICT_ANSI__, _POSIX_SOURCE and _POSIX_C_SOURCE
55 together give you ISO C, 1003.1, and 1003.2, but nothing else.
57 These are defined by this file and are used by the
58 header files to decide what to declare or define:
60 __USE_ISOC11 Define ISO C11 things.
61 __USE_ISOC99 Define ISO C99 things.
62 __USE_ISOC95 Define ISO C90 AMD1 (C95) things.
63 __USE_POSIX Define IEEE Std 1003.1 things.
64 __USE_POSIX2 Define IEEE Std 1003.2 things.
65 __USE_POSIX199309 Define IEEE Std 1003.1, and .1b things.
66 __USE_POSIX199506 Define IEEE Std 1003.1, .1b, .1c and .1i things.
67 __USE_XOPEN Define XPG things.
68 __USE_XOPEN_EXTENDED Define X/Open Unix things.
69 __USE_UNIX98 Define Single Unix V2 things.
70 __USE_XOPEN2K Define XPG6 things.
71 __USE_XOPEN2KXSI Define XPG6 XSI things.
72 __USE_XOPEN2K8 Define XPG7 things.
73 __USE_XOPEN2K8XSI Define XPG7 XSI things.
74 __USE_LARGEFILE Define correct standard I/O things.
75 __USE_LARGEFILE64 Define LFS things with separate names.
76 __USE_FILE_OFFSET64 Define 64bit interface as default.
77 __USE_BSD Define 4.3BSD things.
78 __USE_SVID Define SVID things.
79 __USE_MISC Define things common to BSD and System V Unix.
80 __USE_ATFILE Define *at interfaces and AT_* constants for them.
81 __USE_GNU Define GNU extensions.
82 __USE_REENTRANT Define reentrant/thread-safe *_r functions.
83 __USE_FORTIFY_LEVEL Additional security measures used, according to level.
84 __FAVOR_BSD Favor 4.3BSD things in cases of conflict.
86 The macros `__GNU_LIBRARY__', `__GLIBC__', and `__GLIBC_MINOR__' are
87 defined by this file unconditionally. `__GNU_LIBRARY__' is provided
88 only for compatibility. All new code should use the other symbols
89 to test for features.
91 All macros listed above as possibly being defined by this file are
92 explicitly undefined if they are not explicitly defined.
93 Feature-test macros that are not defined by the user or compiler
94 but are implied by the other feature-test macros defined (or by the
95 lack of any definitions) are defined by the file. */
98 /* Undefine everything, so we get a clean slate. */
99 #undef __USE_ISOC11
100 #undef __USE_ISOC99
101 #undef __USE_ISOC95
102 #undef __USE_ISOCXX11
103 #undef __USE_POSIX
104 #undef __USE_POSIX2
105 #undef __USE_POSIX199309
106 #undef __USE_POSIX199506
107 #undef __USE_XOPEN
108 #undef __USE_XOPEN_EXTENDED
109 #undef __USE_UNIX98
110 #undef __USE_XOPEN2K
111 #undef __USE_XOPEN2KXSI
112 #undef __USE_XOPEN2K8
113 #undef __USE_XOPEN2K8XSI
114 #undef __USE_LARGEFILE
115 #undef __USE_LARGEFILE64
116 #undef __USE_FILE_OFFSET64
117 #undef __USE_BSD
118 #undef __USE_SVID
119 #undef __USE_MISC
120 #undef __USE_ATFILE
121 #undef __USE_GNU
122 #undef __USE_REENTRANT
123 #undef __USE_FORTIFY_LEVEL
124 #undef __FAVOR_BSD
125 #undef __KERNEL_STRICT_NAMES
127 /* Suppress kernel-name space pollution unless user expressedly asks
128 for it. */
129 #ifndef _LOOSE_KERNEL_NAMES
130 # define __KERNEL_STRICT_NAMES
131 #endif
133 /* Always use ISO C things. */
134 #define __USE_ANSI 1
136 /* Convenience macros to test the versions of glibc and gcc.
137 Use them like this:
138 #if __GNUC_PREREQ (2,8)
139 ... code requiring gcc 2.8 or later ...
140 #endif
141 Note - they won't work for gcc1 or glibc1, since the _MINOR macros
142 were not defined then. */
143 #if defined __GNUC__ && defined __GNUC_MINOR__
144 # define __GNUC_PREREQ(maj, min) \
145 ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
146 #else
147 # define __GNUC_PREREQ(maj, min) 0
148 #endif
151 /* If _BSD_SOURCE was defined by the user, favor BSD over POSIX. */
152 #if defined _BSD_SOURCE && \
153 !(defined _POSIX_SOURCE || defined _POSIX_C_SOURCE || \
154 defined _XOPEN_SOURCE || defined _GNU_SOURCE || defined _SVID_SOURCE)
155 # define __FAVOR_BSD 1
156 #endif
158 /* If _GNU_SOURCE was defined by the user, turn on all the other features. */
159 #ifdef _GNU_SOURCE
160 # undef _ISOC95_SOURCE
161 # define _ISOC95_SOURCE 1
162 # undef _ISOC99_SOURCE
163 # define _ISOC99_SOURCE 1
164 # undef _ISOC11_SOURCE
165 # define _ISOC11_SOURCE 1
166 # undef _POSIX_SOURCE
167 # define _POSIX_SOURCE 1
168 # undef _POSIX_C_SOURCE
169 # define _POSIX_C_SOURCE 200809L
170 # undef _XOPEN_SOURCE
171 # define _XOPEN_SOURCE 700
172 # undef _XOPEN_SOURCE_EXTENDED
173 # define _XOPEN_SOURCE_EXTENDED 1
174 # undef _LARGEFILE64_SOURCE
175 # define _LARGEFILE64_SOURCE 1
176 # undef _BSD_SOURCE
177 # define _BSD_SOURCE 1
178 # undef _SVID_SOURCE
179 # define _SVID_SOURCE 1
180 # undef _ATFILE_SOURCE
181 # define _ATFILE_SOURCE 1
182 #endif
184 /* If nothing (other than _GNU_SOURCE) is defined,
185 define _BSD_SOURCE and _SVID_SOURCE. */
186 #if (!defined __STRICT_ANSI__ && !defined _ISOC99_SOURCE && \
187 !defined _POSIX_SOURCE && !defined _POSIX_C_SOURCE && \
188 !defined _XOPEN_SOURCE && !defined _BSD_SOURCE && !defined _SVID_SOURCE)
189 # define _BSD_SOURCE 1
190 # define _SVID_SOURCE 1
191 #endif
193 /* This is to enable the ISO C11 extension. */
194 #if (defined _ISOC11_SOURCE \
195 || (defined __STDC_VERSION__ && __STDC_VERSION__ >= 201112L))
196 # define __USE_ISOC11 1
197 #endif
199 /* This is to enable the ISO C99 extension. */
200 #if (defined _ISOC99_SOURCE || defined _ISOC11_SOURCE \
201 || (defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L))
202 # define __USE_ISOC99 1
203 #endif
205 /* This is to enable the ISO C90 Amendment 1:1995 extension. */
206 #if (defined _ISOC99_SOURCE || defined _ISOC11_SOURCE \
207 || (defined __STDC_VERSION__ && __STDC_VERSION__ >= 199409L))
208 # define __USE_ISOC95 1
209 #endif
211 /* This is to enable compatibility for ISO C++11.
213 So far g++ does not provide a macro. Check the temporary macro for
214 now, too. */
215 #if ((defined __cplusplus && __cplusplus >= 201103L) \
216 || defined __GXX_EXPERIMENTAL_CXX0X__)
217 # define __USE_ISOCXX11 1
218 #endif
220 /* If none of the ANSI/POSIX macros are defined, use POSIX.1 and POSIX.2
221 (and IEEE Std 1003.1b-1993 unless _XOPEN_SOURCE is defined). */
222 #if ((!defined __STRICT_ANSI__ || (_XOPEN_SOURCE - 0) >= 500) && \
223 !defined _POSIX_SOURCE && !defined _POSIX_C_SOURCE)
224 # define _POSIX_SOURCE 1
225 # if defined _XOPEN_SOURCE && (_XOPEN_SOURCE - 0) < 500
226 # define _POSIX_C_SOURCE 2
227 # elif defined _XOPEN_SOURCE && (_XOPEN_SOURCE - 0) < 600
228 # define _POSIX_C_SOURCE 199506L
229 # elif defined _XOPEN_SOURCE && (_XOPEN_SOURCE - 0) < 700
230 # define _POSIX_C_SOURCE 200112L
231 # else
232 # define _POSIX_C_SOURCE 200809L
233 # endif
234 # define __USE_POSIX_IMPLICITLY 1
235 #endif
237 #if defined _POSIX_SOURCE || _POSIX_C_SOURCE >= 1 || defined _XOPEN_SOURCE
238 # define __USE_POSIX 1
239 #endif
241 #if defined _POSIX_C_SOURCE && _POSIX_C_SOURCE >= 2 || defined _XOPEN_SOURCE
242 # define __USE_POSIX2 1
243 #endif
245 #if (_POSIX_C_SOURCE - 0) >= 199309L
246 # define __USE_POSIX199309 1
247 #endif
249 #if (_POSIX_C_SOURCE - 0) >= 199506L
250 # define __USE_POSIX199506 1
251 #endif
253 #if (_POSIX_C_SOURCE - 0) >= 200112L
254 # define __USE_XOPEN2K 1
255 # undef __USE_ISOC95
256 # define __USE_ISOC95 1
257 # undef __USE_ISOC99
258 # define __USE_ISOC99 1
259 #endif
261 #if (_POSIX_C_SOURCE - 0) >= 200809L
262 # define __USE_XOPEN2K8 1
263 # undef _ATFILE_SOURCE
264 # define _ATFILE_SOURCE 1
265 #endif
267 #ifdef _XOPEN_SOURCE
268 # define __USE_XOPEN 1
269 # if (_XOPEN_SOURCE - 0) >= 500
270 # define __USE_XOPEN_EXTENDED 1
271 # define __USE_UNIX98 1
272 # undef _LARGEFILE_SOURCE
273 # define _LARGEFILE_SOURCE 1
274 # if (_XOPEN_SOURCE - 0) >= 600
275 # if (_XOPEN_SOURCE - 0) >= 700
276 # define __USE_XOPEN2K8 1
277 # define __USE_XOPEN2K8XSI 1
278 # endif
279 # define __USE_XOPEN2K 1
280 # define __USE_XOPEN2KXSI 1
281 # undef __USE_ISOC95
282 # define __USE_ISOC95 1
283 # undef __USE_ISOC99
284 # define __USE_ISOC99 1
285 # endif
286 # else
287 # ifdef _XOPEN_SOURCE_EXTENDED
288 # define __USE_XOPEN_EXTENDED 1
289 # endif
290 # endif
291 #endif
293 #ifdef _LARGEFILE_SOURCE
294 # define __USE_LARGEFILE 1
295 #endif
297 #ifdef _LARGEFILE64_SOURCE
298 # define __USE_LARGEFILE64 1
299 #endif
301 #if defined _FILE_OFFSET_BITS && _FILE_OFFSET_BITS == 64
302 # define __USE_FILE_OFFSET64 1
303 #endif
305 #if defined _BSD_SOURCE || defined _SVID_SOURCE
306 # define __USE_MISC 1
307 #endif
309 #ifdef _BSD_SOURCE
310 # define __USE_BSD 1
311 #endif
313 #ifdef _SVID_SOURCE
314 # define __USE_SVID 1
315 #endif
317 #ifdef _ATFILE_SOURCE
318 # define __USE_ATFILE 1
319 #endif
321 #ifdef _GNU_SOURCE
322 # define __USE_GNU 1
323 #endif
325 #if defined _REENTRANT || defined _THREAD_SAFE
326 # define __USE_REENTRANT 1
327 #endif
329 #if defined _FORTIFY_SOURCE && _FORTIFY_SOURCE > 0 \
330 && __GNUC_PREREQ (4, 1) && defined __OPTIMIZE__ && __OPTIMIZE__ > 0
331 # if _FORTIFY_SOURCE > 1
332 # define __USE_FORTIFY_LEVEL 2
333 # else
334 # define __USE_FORTIFY_LEVEL 1
335 # endif
336 #else
337 # define __USE_FORTIFY_LEVEL 0
338 #endif
340 /* We do support the IEC 559 math functionality, real and complex. */
341 #define __STDC_IEC_559__ 1
342 #define __STDC_IEC_559_COMPLEX__ 1
344 /* wchar_t uses ISO 10646-1 (2nd ed., published 2000-09-15) / Unicode 3.1. */
345 #define __STDC_ISO_10646__ 200009L
347 /* This macro indicates that the installed library is the GNU C Library.
348 For historic reasons the value now is 6 and this will stay from now
349 on. The use of this variable is deprecated. Use __GLIBC__ and
350 __GLIBC_MINOR__ now (see below) when you want to test for a specific
351 GNU C library version and use the values in <gnu/lib-names.h> to get
352 the sonames of the shared libraries. */
353 #undef __GNU_LIBRARY__
354 #define __GNU_LIBRARY__ 6
356 /* Major and minor version number of the GNU C library package. Use
357 these macros to test for features in specific releases. */
358 #define __GLIBC__ 2
359 #define __GLIBC_MINOR__ 15
361 #define __GLIBC_PREREQ(maj, min) \
362 ((__GLIBC__ << 16) + __GLIBC_MINOR__ >= ((maj) << 16) + (min))
364 /* Decide whether a compiler supports the long long datatypes. */
365 #if defined __GNUC__ \
366 || (defined __PGI && defined __i386__ ) \
367 || (defined __INTEL_COMPILER && (defined __i386__ || defined __ia64__)) \
368 || (defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L)
369 # define __GLIBC_HAVE_LONG_LONG 1
370 #endif
372 /* This is here only because every header file already includes this one. */
373 #ifndef __ASSEMBLER__
374 # ifndef _SYS_CDEFS_H
375 # include <sys/cdefs.h>
376 # endif
378 /* If we don't have __REDIRECT, prototypes will be missing if
379 __USE_FILE_OFFSET64 but not __USE_LARGEFILE[64]. */
380 # if defined __USE_FILE_OFFSET64 && !defined __REDIRECT
381 # define __USE_LARGEFILE 1
382 # define __USE_LARGEFILE64 1
383 # endif
385 #endif /* !ASSEMBLER */
387 /* Decide whether we can define 'extern inline' functions in headers. */
388 #if __GNUC_PREREQ (2, 7) && defined __OPTIMIZE__ \
389 && !defined __OPTIMIZE_SIZE__ && !defined __NO_INLINE__ \
390 && defined __extern_inline
391 # define __USE_EXTERN_INLINES 1
392 #endif
395 /* This is here only because every header file already includes this one.
396 Get the definitions of all the appropriate `__stub_FUNCTION' symbols.
397 <gnu/stubs.h> contains `#define __stub_FUNCTION' when FUNCTION is a stub
398 that will always return failure (and set errno to ENOSYS). */
399 #include <gnu/stubs.h>
402 #endif /* features.h */