blob: 3755e38a3432d9d50363138a095673b391a515a7 [file] [log] [blame]
Tim Peters7d3a5112000-07-08 04:17:21 +00001#ifndef Py_PYPORT_H
Vladimir Marangozov14a4d882000-07-10 04:59:49 +00002#define Py_PYPORT_H
Tim Peters7d3a5112000-07-08 04:17:21 +00003
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +00004#include "pyconfig.h" /* include for defines */
Peter Schneider-Kamp25f68942000-07-31 22:19:30 +00005
Thomas Wouters89f507f2006-12-13 04:49:30 +00006#ifdef HAVE_STDINT_H
7#include <stdint.h>
8#endif
9
Tim Peters7d3a5112000-07-08 04:17:21 +000010/**************************************************************************
11Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000012C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000013
14Please try to make documentation here as clear as possible: by definition,
15the stuff here is trying to illuminate C's darkest corners.
16
17Config #defines referenced here:
18
19SIGNED_RIGHT_SHIFT_ZERO_FILLS
20Meaning: To be defined iff i>>j does not extend the sign bit when i is a
21 signed integral type and i < 0.
22Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000023
Tim Peters8315ea52000-07-23 19:28:35 +000024Py_DEBUG
25Meaning: Extra checks compiled in for debug mode.
26Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000027
28HAVE_UINTPTR_T
29Meaning: The C9X type uintptr_t is supported by the compiler
30Used in: Py_uintptr_t
31
32HAVE_LONG_LONG
33Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000034Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000035
Tim Peters7d3a5112000-07-08 04:17:21 +000036**************************************************************************/
37
Barry Warsawfd847b22000-08-18 04:48:18 +000038/* typedefs for some C9X-defined synonyms for integral types.
39 *
40 * The names in Python are exactly the same as the C9X names, except with a
41 * Py_ prefix. Until C9X is universally implemented, this is the only way
42 * to ensure that Python gets reliable names that don't conflict with names
43 * in non-Python code that are playing their own tricks to define the C9X
44 * names.
45 *
46 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
47 * integral synonyms. Only define the ones we actually need.
48 */
49
50#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000051#ifndef PY_LONG_LONG
52#define PY_LONG_LONG long long
Guido van Rossumcd16bf62007-06-13 18:07:49 +000053#if defined(LLONG_MAX)
54/* If LLONG_MAX is defined in limits.h, use that. */
55#define PY_LLONG_MIN LLONG_MIN
56#define PY_LLONG_MAX LLONG_MAX
57#define PY_ULLONG_MAX ULLONG_MAX
58#elif defined(__LONG_LONG_MAX__)
59/* Otherwise, if GCC has a builtin define, use that. */
60#define PY_LLONG_MAX __LONG_LONG_MAX__
61#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
62#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
63#else
64/* Otherwise, rely on two's complement. */
65#define PY_ULLONG_MAX (~0ULL)
66#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
67#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
68#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000069#endif
70#endif /* HAVE_LONG_LONG */
71
72/* uintptr_t is the C9X name for an unsigned integral type such that a
73 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000074 * without loss of information. Similarly for intptr_t, wrt a signed
75 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000076 */
77#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000078typedef uintptr_t Py_uintptr_t;
79typedef intptr_t Py_intptr_t;
80
Barry Warsawfd847b22000-08-18 04:48:18 +000081#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000082typedef unsigned int Py_uintptr_t;
83typedef int Py_intptr_t;
84
Barry Warsawfd847b22000-08-18 04:48:18 +000085#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000086typedef unsigned long Py_uintptr_t;
87typedef long Py_intptr_t;
88
Barry Warsawfd847b22000-08-18 04:48:18 +000089#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000090typedef unsigned PY_LONG_LONG Py_uintptr_t;
91typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000092
Barry Warsawfd847b22000-08-18 04:48:18 +000093#else
94# error "Python needs a typedef for Py_uintptr_t in pyport.h."
95#endif /* HAVE_UINTPTR_T */
96
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000097/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
98 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
99 * unsigned integral type). See PEP 353 for details.
100 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000101#ifdef HAVE_SSIZE_T
102typedef ssize_t Py_ssize_t;
103#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000104typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105#else
106# error "Python needs a typedef for Py_ssize_t in pyport.h."
107#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000108
109/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000110#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000111/* Smallest negative value of type Py_ssize_t. */
112#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
113
Christian Heimes400adb02008-02-01 08:12:03 +0000114#if SIZEOF_PID_T > SIZEOF_LONG
115# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
116#endif
117
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000118/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
119 * format to convert an argument with the width of a size_t or Py_ssize_t.
120 * C99 introduced "z" for this purpose, but not all platforms support that;
121 * e.g., MS compilers use "I" instead.
122 *
123 * These "high level" Python format functions interpret "z" correctly on
124 * all platforms (Python interprets the format string itself, and does whatever
125 * the platform C requires to convert a size_t/Py_ssize_t argument):
126 *
127 * PyString_FromFormat
128 * PyErr_Format
129 * PyString_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000130 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000131 *
132 * Lower-level uses require that you interpolate the correct format modifier
133 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
134 * example,
135 *
136 * Py_ssize_t index;
137 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
138 *
139 * That will expand to %ld, or %Id, or to something else correct for a
140 * Py_ssize_t on the platform.
141 */
142#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000143# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000144# define PY_FORMAT_SIZE_T ""
145# elif SIZEOF_SIZE_T == SIZEOF_LONG
146# define PY_FORMAT_SIZE_T "l"
147# elif defined(MS_WINDOWS)
148# define PY_FORMAT_SIZE_T "I"
149# else
150# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
151# endif
152#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000153
Thomas Wouters477c8d52006-05-27 19:21:47 +0000154/* Py_LOCAL can be used instead of static to get the fastest possible calling
155 * convention for functions that are local to a given module.
156 *
157 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
158 * for platforms that support that.
159 *
160 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
161 * "aggressive" inlining/optimizaion is enabled for the entire module. This
162 * may lead to code bloat, and may slow things down for those reasons. It may
163 * also lead to errors, if the code relies on pointer aliasing. Use with
164 * care.
165 *
166 * NOTE: You can only use this for functions that are entirely local to a
167 * module; functions that are exported via method tables, callbacks, etc,
168 * should keep using static.
169 */
170
171#undef USE_INLINE /* XXX - set via configure? */
172
173#if defined(_MSC_VER)
174#if defined(PY_LOCAL_AGGRESSIVE)
175/* enable more aggressive optimization for visual studio */
176#pragma optimize("agtw", on)
177#endif
178/* ignore warnings if the compiler decides not to inline a function */
179#pragma warning(disable: 4710)
180/* fastest possible local call under MSVC */
181#define Py_LOCAL(type) static type __fastcall
182#define Py_LOCAL_INLINE(type) static __inline type __fastcall
183#elif defined(USE_INLINE)
184#define Py_LOCAL(type) static type
185#define Py_LOCAL_INLINE(type) static inline type
186#else
187#define Py_LOCAL(type) static type
188#define Py_LOCAL_INLINE(type) static type
189#endif
190
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000191/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
192 * are often very short. While most platforms have highly optimized code for
193 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
194 * solves this by doing short copies "in line".
195 */
196
197#if defined(_MSC_VER)
198#define Py_MEMCPY(target, source, length) do { \
199 size_t i_, n_ = (length); \
200 char *t_ = (void*) (target); \
201 const char *s_ = (void*) (source); \
202 if (n_ >= 16) \
203 memcpy(t_, s_, n_); \
204 else \
205 for (i_ = 0; i_ < n_; i_++) \
206 t_[i_] = s_[i_]; \
207 } while (0)
208#else
209#define Py_MEMCPY memcpy
210#endif
211
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000212#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000213
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000214#include <math.h> /* Moved here from the math section, before extern "C" */
215
216/********************************************
217 * WRAPPER FOR <time.h> and/or <sys/time.h> *
218 ********************************************/
219
220#ifdef TIME_WITH_SYS_TIME
221#include <sys/time.h>
222#include <time.h>
223#else /* !TIME_WITH_SYS_TIME */
224#ifdef HAVE_SYS_TIME_H
225#include <sys/time.h>
226#else /* !HAVE_SYS_TIME_H */
227#include <time.h>
228#endif /* !HAVE_SYS_TIME_H */
229#endif /* !TIME_WITH_SYS_TIME */
230
231
232/******************************
233 * WRAPPER FOR <sys/select.h> *
234 ******************************/
235
236/* NB caller must include <sys/types.h> */
237
238#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000239#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000240#endif /* !HAVE_SYS_SELECT_H */
241
Tim Peters60f42b52001-01-18 03:03:16 +0000242/*******************************
243 * stat() and fstat() fiddling *
244 *******************************/
245
246/* We expect that stat and fstat exist on most systems.
247 * It's confirmed on Unix, Mac and Windows.
248 * If you don't have them, add
249 * #define DONT_HAVE_STAT
250 * and/or
251 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000252 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000253 * HAVE_FSTAT instead.
254 * Also
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000255 * #define HAVE_SYS_STAT_H
256 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000257 * #define HAVE_STAT_H
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000258 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000259 */
260#ifndef DONT_HAVE_STAT
261#define HAVE_STAT
262#endif
263
264#ifndef DONT_HAVE_FSTAT
265#define HAVE_FSTAT
266#endif
267
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000268#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000269#if defined(PYOS_OS2) && defined(PYCC_GCC)
270#include <sys/types.h>
271#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000272#include <sys/stat.h>
273#elif defined(HAVE_STAT_H)
274#include <stat.h>
275#endif
276
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000277#if defined(PYCC_VACPP)
278/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
279#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
280#endif
281
282#ifndef S_ISREG
283#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
284#endif
285
286#ifndef S_ISDIR
287#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
288#endif
289
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000290
Tim Peters7d3a5112000-07-08 04:17:21 +0000291#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000292/* Move this down here since some C++ #include's don't like to be included
293 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000294extern "C" {
295#endif
296
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000297
Tim Peters7d3a5112000-07-08 04:17:21 +0000298/* Py_ARITHMETIC_RIGHT_SHIFT
299 * C doesn't define whether a right-shift of a signed integer sign-extends
300 * or zero-fills. Here a macro to force sign extension:
301 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
302 * Return I >> J, forcing sign extension.
303 * Requirements:
304 * I is of basic signed type TYPE (char, short, int, long, or long long).
305 * TYPE is one of char, short, int, long, or long long, although long long
306 * must not be used except on platforms that support it.
307 * J is an integer >= 0 and strictly less than the number of bits in TYPE
308 * (because C doesn't define what happens for J outside that range either).
309 * Caution:
310 * I may be evaluated more than once.
311 */
312#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
313#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
314 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
315#else
316#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
317#endif
318
Tim Peters39dce292000-08-15 03:34:48 +0000319/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000320 * "Simply" returns its argument. However, macro expansions within the
321 * argument are evaluated. This unfortunate trickery is needed to get
322 * token-pasting to work as desired in some cases.
323 */
324#define Py_FORCE_EXPANSION(X) X
325
Tim Peters8315ea52000-07-23 19:28:35 +0000326/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
327 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
328 * assert-fails if any information is lost.
329 * Caution:
330 * VALUE may be evaluated more than once.
331 */
332#ifdef Py_DEBUG
333#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
334 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
335#else
336#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
337#endif
338
Christian Heimes99170a52007-12-19 02:07:34 +0000339/* High precision defintion of pi and e (Euler)
340 * The values are taken from libc6's math.h.
341 */
Christian Heimes072c0f12008-01-03 23:01:04 +0000342#ifndef Py_MATH_PIl
343#define Py_MATH_PIl 3.1415926535897932384626433832795029L
344#endif
Christian Heimes99170a52007-12-19 02:07:34 +0000345#ifndef Py_MATH_PI
Christian Heimes072c0f12008-01-03 23:01:04 +0000346#define Py_MATH_PI 3.14159265358979323846
347#endif
348
349#ifndef Py_MATH_El
350#define Py_MATH_El 2.7182818284590452353602874713526625L
Christian Heimes99170a52007-12-19 02:07:34 +0000351#endif
352
353#ifndef Py_MATH_E
Christian Heimes072c0f12008-01-03 23:01:04 +0000354#define Py_MATH_E 2.7182818284590452354
Christian Heimes99170a52007-12-19 02:07:34 +0000355#endif
356
Tim Peters862f0592004-09-23 19:11:32 +0000357/* Py_IS_NAN(X)
358 * Return 1 if float or double arg is a NaN, else 0.
359 * Caution:
360 * X is evaluated more than once.
361 * This may not work on all platforms. Each platform has *some*
362 * way to spell this, though -- override in pyconfig.h if you have
363 * a platform where it doesn't work.
364 */
365#ifndef Py_IS_NAN
Christian Heimes99170a52007-12-19 02:07:34 +0000366#ifdef HAVE_ISNAN
367#define Py_IS_NAN(X) isnan(X)
368#else
Tim Peters862f0592004-09-23 19:11:32 +0000369#define Py_IS_NAN(X) ((X) != (X))
370#endif
Christian Heimes99170a52007-12-19 02:07:34 +0000371#endif
Tim Peters862f0592004-09-23 19:11:32 +0000372
Tim Peters39dce292000-08-15 03:34:48 +0000373/* Py_IS_INFINITY(X)
374 * Return 1 if float or double arg is an infinity, else 0.
375 * Caution:
376 * X is evaluated more than once.
377 * This implementation may set the underflow flag if |X| is very small;
378 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000379 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000380 */
Tim Peters862f0592004-09-23 19:11:32 +0000381#ifndef Py_IS_INFINITY
Christian Heimes99170a52007-12-19 02:07:34 +0000382#ifdef HAVE_ISINF
383#define Py_IS_INFINITY(X) isinf(X)
384#else
Tim Peters1a2eefd2000-09-08 15:45:34 +0000385#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000386#endif
Christian Heimes99170a52007-12-19 02:07:34 +0000387#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000388
Thomas Wouters477c8d52006-05-27 19:21:47 +0000389/* Py_IS_FINITE(X)
390 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
391 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
392 * macro for this particular test is useful
393 */
394#ifndef Py_IS_FINITE
Christian Heimes9bd667a2008-01-20 15:14:11 +0000395#ifdef HAVE_FINITE
Christian Heimes1af737c2008-01-23 08:24:23 +0000396#define Py_IS_FINITE(X) finite(X)
Christian Heimes99170a52007-12-19 02:07:34 +0000397#else
Thomas Wouters477c8d52006-05-27 19:21:47 +0000398#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
399#endif
Christian Heimes99170a52007-12-19 02:07:34 +0000400#endif
Thomas Wouters477c8d52006-05-27 19:21:47 +0000401
Tim Peters1de41bf2002-07-03 03:31:20 +0000402/* HUGE_VAL is supposed to expand to a positive double infinity. Python
403 * uses Py_HUGE_VAL instead because some platforms are broken in this
404 * respect. We used to embed code in pyport.h to try to worm around that,
405 * but different platforms are broken in conflicting ways. If you're on
406 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
407 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000408 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000409#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000410#define Py_HUGE_VAL HUGE_VAL
411#endif
412
Christian Heimes99170a52007-12-19 02:07:34 +0000413/* Py_NAN
414 * A value that evaluates to a NaN. On IEEE 754 platforms INF*0 or
415 * INF/INF works. Define Py_NO_NAN in pyconfig.h if your platform
416 * doesn't support NaNs.
417 */
418#if !defined(Py_NAN) && !defined(Py_NO_NAN)
419#define Py_NAN (Py_HUGE_VAL * 0.)
420#endif
421
Tim Peters57f282a2001-09-05 05:38:10 +0000422/* Py_OVERFLOWED(X)
423 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
424 * a libm function, and invoke this macro after, passing the function
425 * result.
426 * Caution:
427 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000428 * any exceptional condition, but does require +- HUGE_VAL return
429 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
430 * double infinity, and we're cool if that's so, unless the input
431 * was an infinity and an infinity is the expected result. A C89
432 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000433 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
434 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
435 * in non-overflow cases.
436 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000437 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000438 *
439 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000440 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000441 * should be removed once a newer compiler is available on that platform.
442 * The system that had the failure was running OpenBSD 3.2 on Intel, with
443 * gcc 2.95.3.
444 *
Tim Peters862f0592004-09-23 19:11:32 +0000445 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000446 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000447 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000448#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000449#define Py_OVERFLOWED(X) isinf(X)
450#else
Tim Petersa40c7932001-09-05 22:36:56 +0000451#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
452 (X) == Py_HUGE_VAL || \
453 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000454#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000455
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000456/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000457 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000458 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
459 * to 0 before calling a libm function, and invoke this macro after,
460 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000461 * Caution:
462 * This isn't reliable. See Py_OVERFLOWED comments.
463 * X is evaluated more than once.
464 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000465#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000466#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
467#else
468#define _Py_SET_EDOM_FOR_NAN(X) ;
469#endif
470#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000471 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000472 if (errno == 0) { \
473 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
474 errno = ERANGE; \
475 else _Py_SET_EDOM_FOR_NAN(X) \
476 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000477 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000478
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000479/* Py_SET_ERANGE_ON_OVERFLOW(x)
480 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
481 */
482#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
483
Tim Petersdc5a5082002-03-09 04:58:24 +0000484/* Py_ADJUST_ERANGE1(x)
485 * Py_ADJUST_ERANGE2(x, y)
486 * Set errno to 0 before calling a libm function, and invoke one of these
487 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
488 * for functions returning complex results). This makes two kinds of
489 * adjustments to errno: (A) If it looks like the platform libm set
490 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
491 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
492 * effect, we're trying to force a useful implementation of C89 errno
493 * behavior.
494 * Caution:
495 * This isn't reliable. See Py_OVERFLOWED comments.
496 * X and Y may be evaluated more than once.
497 */
498#define Py_ADJUST_ERANGE1(X) \
499 do { \
500 if (errno == 0) { \
501 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
502 errno = ERANGE; \
503 } \
504 else if (errno == ERANGE && (X) == 0.0) \
505 errno = 0; \
506 } while(0)
507
508#define Py_ADJUST_ERANGE2(X, Y) \
509 do { \
510 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
511 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
512 if (errno == 0) \
513 errno = ERANGE; \
514 } \
515 else if (errno == ERANGE) \
516 errno = 0; \
517 } while(0)
518
Neal Norwitz80292642002-12-19 15:12:26 +0000519/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000520 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000521 * Usage:
522 * extern int old_var Py_DEPRECATED(2.3);
523 * typedef int T1 Py_DEPRECATED(2.4);
524 * extern int x() Py_DEPRECATED(2.5);
525 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000526#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
527 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000528#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
529#else
Tim Peters4643bd92002-12-28 21:56:08 +0000530#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000531#endif
532
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000533/**************************************************************************
534Prototypes that are missing from the standard include files on some systems
535(and possibly only some versions of such systems.)
536
537Please be conservative with adding new ones, document them and enclose them
538in platform-specific #ifdefs.
539**************************************************************************/
540
541#ifdef SOLARIS
542/* Unchecked */
543extern int gethostname(char *, int);
544#endif
545
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000546#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000547#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000548extern char * _getpty(int *, int, mode_t, int);
549#endif
550
551#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
552#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
553/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
554 functions, even though they are included in libutil. */
555#include <termios.h>
556extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes400adb02008-02-01 08:12:03 +0000557extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000558#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
559#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
560
561
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000562/************************
563 * WRAPPER FOR <math.h> *
564 ************************/
565
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000566#ifndef HAVE_HYPOT
567extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000568#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000569
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000570
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000571/* On 4.4BSD-descendants, ctype functions serves the whole range of
572 * wchar_t character set rather than single byte code points only.
573 * This characteristic can break some operations of string object
574 * including str.upper() and str.split() on UTF-8 locales. This
575 * workaround was provided by Tim Robbins of FreeBSD project.
576 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000577
578#ifdef __FreeBSD__
579#include <osreldate.h>
580#if __FreeBSD_version > 500039
581#include <ctype.h>
582#include <wctype.h>
583#undef isalnum
584#define isalnum(c) iswalnum(btowc(c))
585#undef isalpha
586#define isalpha(c) iswalpha(btowc(c))
587#undef islower
588#define islower(c) iswlower(btowc(c))
589#undef isspace
590#define isspace(c) iswspace(btowc(c))
591#undef isupper
592#define isupper(c) iswupper(btowc(c))
593#undef tolower
594#define tolower(c) towlower(btowc(c))
595#undef toupper
596#define toupper(c) towupper(btowc(c))
597#endif
598#endif
599
600
Mark Hammond8235ea12002-07-19 06:55:41 +0000601/* Declarations for symbol visibility.
602
603 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000604 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000605 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000606 inside the Python core, they are private to the core.
607 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000608 external linkage depending on the platform.
609
610 As a number of platforms support/require "__declspec(dllimport/dllexport)",
611 we support a HAVE_DECLSPEC_DLL macro to save duplication.
612*/
613
Tim Peters4643bd92002-12-28 21:56:08 +0000614/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000615 All windows ports, except cygwin, are handled in PC/pyconfig.h.
616
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000617 Cygwin is the only other autoconf platform requiring special
618 linkage handling and it uses __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000619*/
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000620#if defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000621# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000622#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000623
Jason Tishler30765592003-09-04 11:04:06 +0000624/* only get special linkage if built as shared or platform is Cygwin */
625#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000626# if defined(HAVE_DECLSPEC_DLL)
627# ifdef Py_BUILD_CORE
628# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000629# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000630 /* module init functions inside the core need no external linkage */
Skip Montanaroeb33e5a2007-08-17 12:57:41 +0000631 /* except for Cygwin to handle embedding */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000632# if defined(__CYGWIN__)
633# define PyMODINIT_FUNC __declspec(dllexport) void
634# else /* __CYGWIN__ */
635# define PyMODINIT_FUNC void
636# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000637# else /* Py_BUILD_CORE */
638 /* Building an extension module, or an embedded situation */
639 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000640 /* Under Cygwin, auto-import functions to prevent compilation */
641 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
642# if !defined(__CYGWIN__)
643# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
644# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000645# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000646 /* module init functions outside the core must be exported */
647# if defined(__cplusplus)
648# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
649# else /* __cplusplus */
650# define PyMODINIT_FUNC __declspec(dllexport) void
651# endif /* __cplusplus */
652# endif /* Py_BUILD_CORE */
653# endif /* HAVE_DECLSPEC */
654#endif /* Py_ENABLE_SHARED */
655
656/* If no external linkage macros defined by now, create defaults */
657#ifndef PyAPI_FUNC
658# define PyAPI_FUNC(RTYPE) RTYPE
659#endif
660#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000661# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000662#endif
663#ifndef PyMODINIT_FUNC
664# if defined(__cplusplus)
665# define PyMODINIT_FUNC extern "C" void
666# else /* __cplusplus */
667# define PyMODINIT_FUNC void
668# endif /* __cplusplus */
669#endif
670
Fred Draked5fadf72000-09-26 05:46:01 +0000671/* limits.h constants that may be missing */
672
673#ifndef INT_MAX
674#define INT_MAX 2147483647
675#endif
676
677#ifndef LONG_MAX
678#if SIZEOF_LONG == 4
679#define LONG_MAX 0X7FFFFFFFL
680#elif SIZEOF_LONG == 8
681#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
682#else
683#error "could not set LONG_MAX in pyport.h"
684#endif
685#endif
686
687#ifndef LONG_MIN
688#define LONG_MIN (-LONG_MAX-1)
689#endif
690
Tim Petersd57731f2000-10-05 01:42:25 +0000691#ifndef LONG_BIT
692#define LONG_BIT (8 * SIZEOF_LONG)
693#endif
694
695#if LONG_BIT != 8 * SIZEOF_LONG
696/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
697 * 32-bit platforms using gcc. We try to catch that here at compile-time
698 * rather than waiting for integer multiplication to trigger bogus
699 * overflows.
700 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000701#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000702#endif
703
Tim Peters7d3a5112000-07-08 04:17:21 +0000704#ifdef __cplusplus
705}
706#endif
707
Neil Schemenauer15691082001-10-23 02:20:37 +0000708/*
709 * Hide GCC attributes from compilers that don't support them.
710 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000711#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Skip Montanaro7a98be22007-08-16 14:35:24 +0000712 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000713#define Py_GCC_ATTRIBUTE(x)
714#else
715#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000716#endif
717
Thomas Wouters89f507f2006-12-13 04:49:30 +0000718/*
719 * Add PyArg_ParseTuple format where available.
720 */
721#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
722#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
723#else
724#define Py_FORMAT_PARSETUPLE(func,p1,p2)
725#endif
726
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000727/* Eliminate end-of-loop code not reached warnings from SunPro C
728 * when using do{...}while(0) macros
729 */
730#ifdef __SUNPRO_C
731#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
732#endif
733
Thomas Wouters477c8d52006-05-27 19:21:47 +0000734/*
735 * Older Microsoft compilers don't support the C99 long long literal suffixes,
736 * so these will be defined in PC/pyconfig.h for those compilers.
737 */
738#ifndef Py_LL
739#define Py_LL(x) x##LL
740#endif
741
742#ifndef Py_ULL
743#define Py_ULL(x) Py_LL(x##U)
744#endif
745
Tim Peters7d3a5112000-07-08 04:17:21 +0000746#endif /* Py_PYPORT_H */