blob: 9d46470eb1e03221dbc873bbc0760cb79de0202b [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
Tim Peters7d3a5112000-07-08 04:17:21 +00006/**************************************************************************
7Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +00008C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +00009
10Please try to make documentation here as clear as possible: by definition,
11the stuff here is trying to illuminate C's darkest corners.
12
13Config #defines referenced here:
14
15SIGNED_RIGHT_SHIFT_ZERO_FILLS
16Meaning: To be defined iff i>>j does not extend the sign bit when i is a
17 signed integral type and i < 0.
18Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000019
Tim Peters8315ea52000-07-23 19:28:35 +000020Py_DEBUG
21Meaning: Extra checks compiled in for debug mode.
22Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000023
24HAVE_UINTPTR_T
25Meaning: The C9X type uintptr_t is supported by the compiler
26Used in: Py_uintptr_t
27
28HAVE_LONG_LONG
29Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000030Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000031
Tim Peters7d3a5112000-07-08 04:17:21 +000032**************************************************************************/
33
34
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000035/* For backward compatibility only. Obsolete, do not use. */
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000036#ifdef HAVE_PROTOTYPES
37#define Py_PROTO(x) x
38#else
39#define Py_PROTO(x) ()
40#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000041#ifndef Py_FPROTO
42#define Py_FPROTO(x) Py_PROTO(x)
43#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000044
Barry Warsawfd847b22000-08-18 04:48:18 +000045/* typedefs for some C9X-defined synonyms for integral types.
46 *
47 * The names in Python are exactly the same as the C9X names, except with a
48 * Py_ prefix. Until C9X is universally implemented, this is the only way
49 * to ensure that Python gets reliable names that don't conflict with names
50 * in non-Python code that are playing their own tricks to define the C9X
51 * names.
52 *
53 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
54 * integral synonyms. Only define the ones we actually need.
55 */
56
57#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000058#ifndef PY_LONG_LONG
59#define PY_LONG_LONG long long
Barry Warsawfd847b22000-08-18 04:48:18 +000060#endif
61#endif /* HAVE_LONG_LONG */
62
63/* uintptr_t is the C9X name for an unsigned integral type such that a
64 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000065 * without loss of information. Similarly for intptr_t, wrt a signed
66 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000067 */
68#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000069typedef uintptr_t Py_uintptr_t;
70typedef intptr_t Py_intptr_t;
71
Barry Warsawfd847b22000-08-18 04:48:18 +000072#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000073typedef unsigned int Py_uintptr_t;
74typedef int Py_intptr_t;
75
Barry Warsawfd847b22000-08-18 04:48:18 +000076#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000077typedef unsigned long Py_uintptr_t;
78typedef long Py_intptr_t;
79
Barry Warsawfd847b22000-08-18 04:48:18 +000080#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000081typedef unsigned PY_LONG_LONG Py_uintptr_t;
82typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000083
Barry Warsawfd847b22000-08-18 04:48:18 +000084#else
85# error "Python needs a typedef for Py_uintptr_t in pyport.h."
86#endif /* HAVE_UINTPTR_T */
87
Tim Petersae1d0c92006-03-17 03:29:34 +000088/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
89 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
90 * unsigned integral type). See PEP 353 for details.
91 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000092#ifdef HAVE_SSIZE_T
93typedef ssize_t Py_ssize_t;
94#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +000095typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000096#else
97# error "Python needs a typedef for Py_ssize_t in pyport.h."
98#endif
Tim Petersae1d0c92006-03-17 03:29:34 +000099
100/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000101#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000102/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000103#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000104
Tim Petersae1d0c92006-03-17 03:29:34 +0000105/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
106 * format to convert an argument with the width of a size_t or Py_ssize_t.
107 * C99 introduced "z" for this purpose, but not all platforms support that;
108 * e.g., MS compilers use "I" instead.
109 *
110 * These "high level" Python format functions interpret "z" correctly on
111 * all platforms (Python interprets the format string itself, and does whatever
112 * the platform C requires to convert a size_t/Py_ssize_t argument):
113 *
114 * PyString_FromFormat
115 * PyErr_Format
116 * PyString_FromFormatV
117 *
118 * Lower-level uses require that you interpolate the correct format modifier
119 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
120 * example,
121 *
122 * Py_ssize_t index;
123 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
124 *
125 * That will expand to %ld, or %Id, or to something else correct for a
126 * Py_ssize_t on the platform.
127 */
128#ifndef PY_FORMAT_SIZE_T
Anthony Baxterc7403ed2006-04-01 01:08:29 +0000129# if SIZEOF_SIZE_T == SIZEOF_INT
130# define PY_FORMAT_SIZE_T ""
131# elif SIZEOF_SIZE_T == SIZEOF_LONG
Tim Petersae1d0c92006-03-17 03:29:34 +0000132# define PY_FORMAT_SIZE_T "l"
133# elif defined(MS_WINDOWS)
134# define PY_FORMAT_SIZE_T "I"
135# else
136# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
137# endif
138#endif
139
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000140/* PY_LOCAL can be used instead of static to get the fastest possible calling
141 * convention for functions that are local to a given module. It also enables
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000142 * inlining, where suitable.
143 *
144 * NOTE: You can only use this for functions that are entirely local to a
145 * module; functions that are exported via method tables, callbacks, etc,
146 * should keep using static.
147 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000148
149#undef USE_INLINE /* XXX - set via configure? */
150
151#if defined(_MSC_VER)
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000152/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000153#pragma warning(disable: 4710)
154/* fastest possible local call under MSVC */
155#define Py_LOCAL(type) static __inline type __fastcall
156#elif defined(USE_INLINE)
157#define Py_LOCAL(type) static inline type
158#else
159#define Py_LOCAL(type) static type
160#endif
161
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000162#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000163
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000164#include <math.h> /* Moved here from the math section, before extern "C" */
165
166/********************************************
167 * WRAPPER FOR <time.h> and/or <sys/time.h> *
168 ********************************************/
169
170#ifdef TIME_WITH_SYS_TIME
171#include <sys/time.h>
172#include <time.h>
173#else /* !TIME_WITH_SYS_TIME */
174#ifdef HAVE_SYS_TIME_H
175#include <sys/time.h>
176#else /* !HAVE_SYS_TIME_H */
177#include <time.h>
178#endif /* !HAVE_SYS_TIME_H */
179#endif /* !TIME_WITH_SYS_TIME */
180
181
182/******************************
183 * WRAPPER FOR <sys/select.h> *
184 ******************************/
185
186/* NB caller must include <sys/types.h> */
187
188#ifdef HAVE_SYS_SELECT_H
189
190#include <sys/select.h>
191
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000192#endif /* !HAVE_SYS_SELECT_H */
193
Tim Peters60f42b52001-01-18 03:03:16 +0000194/*******************************
195 * stat() and fstat() fiddling *
196 *******************************/
197
198/* We expect that stat and fstat exist on most systems.
199 * It's confirmed on Unix, Mac and Windows.
200 * If you don't have them, add
201 * #define DONT_HAVE_STAT
202 * and/or
203 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000204 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000205 * HAVE_FSTAT instead.
206 * Also
207 * #define DONT_HAVE_SYS_STAT_H
208 * if <sys/stat.h> doesn't exist on your platform, and
209 * #define HAVE_STAT_H
210 * if <stat.h> does (don't look at me -- ths mess is inherited).
211 */
212#ifndef DONT_HAVE_STAT
213#define HAVE_STAT
214#endif
215
216#ifndef DONT_HAVE_FSTAT
217#define HAVE_FSTAT
218#endif
219
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000220#ifdef RISCOS
221#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000222#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000223#endif
224
Tim Peters60f42b52001-01-18 03:03:16 +0000225#ifndef DONT_HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000226#if defined(PYOS_OS2) && defined(PYCC_GCC)
227#include <sys/types.h>
228#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000229#include <sys/stat.h>
230#elif defined(HAVE_STAT_H)
231#include <stat.h>
232#endif
233
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000234#if defined(PYCC_VACPP)
235/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
236#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
237#endif
238
239#ifndef S_ISREG
240#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
241#endif
242
243#ifndef S_ISDIR
244#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
245#endif
246
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000247
Tim Peters7d3a5112000-07-08 04:17:21 +0000248#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000249/* Move this down here since some C++ #include's don't like to be included
250 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000251extern "C" {
252#endif
253
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000254
Tim Peters7d3a5112000-07-08 04:17:21 +0000255/* Py_ARITHMETIC_RIGHT_SHIFT
256 * C doesn't define whether a right-shift of a signed integer sign-extends
257 * or zero-fills. Here a macro to force sign extension:
258 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
259 * Return I >> J, forcing sign extension.
260 * Requirements:
261 * I is of basic signed type TYPE (char, short, int, long, or long long).
262 * TYPE is one of char, short, int, long, or long long, although long long
263 * must not be used except on platforms that support it.
264 * J is an integer >= 0 and strictly less than the number of bits in TYPE
265 * (because C doesn't define what happens for J outside that range either).
266 * Caution:
267 * I may be evaluated more than once.
268 */
269#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
270#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
271 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
272#else
273#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
274#endif
275
Tim Peters39dce292000-08-15 03:34:48 +0000276/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000277 * "Simply" returns its argument. However, macro expansions within the
278 * argument are evaluated. This unfortunate trickery is needed to get
279 * token-pasting to work as desired in some cases.
280 */
281#define Py_FORCE_EXPANSION(X) X
282
Tim Peters8315ea52000-07-23 19:28:35 +0000283/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
284 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
285 * assert-fails if any information is lost.
286 * Caution:
287 * VALUE may be evaluated more than once.
288 */
289#ifdef Py_DEBUG
290#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
291 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
292#else
293#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
294#endif
295
Tim Peters862f0592004-09-23 19:11:32 +0000296/* Py_IS_NAN(X)
297 * Return 1 if float or double arg is a NaN, else 0.
298 * Caution:
299 * X is evaluated more than once.
300 * This may not work on all platforms. Each platform has *some*
301 * way to spell this, though -- override in pyconfig.h if you have
302 * a platform where it doesn't work.
303 */
304#ifndef Py_IS_NAN
305#define Py_IS_NAN(X) ((X) != (X))
306#endif
307
Tim Peters39dce292000-08-15 03:34:48 +0000308/* Py_IS_INFINITY(X)
309 * Return 1 if float or double arg is an infinity, else 0.
310 * Caution:
311 * X is evaluated more than once.
312 * This implementation may set the underflow flag if |X| is very small;
313 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000314 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000315 */
Tim Peters862f0592004-09-23 19:11:32 +0000316#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000317#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000318#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000319
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000320/* Py_IS_FINITE(X)
321 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
322 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000323 * macro for this particular test is useful
324 */
325#ifndef Py_IS_FINITE
326#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
327#endif
328
Tim Peters1de41bf2002-07-03 03:31:20 +0000329/* HUGE_VAL is supposed to expand to a positive double infinity. Python
330 * uses Py_HUGE_VAL instead because some platforms are broken in this
331 * respect. We used to embed code in pyport.h to try to worm around that,
332 * but different platforms are broken in conflicting ways. If you're on
333 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
334 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000335 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000336#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000337#define Py_HUGE_VAL HUGE_VAL
338#endif
339
Tim Peters57f282a2001-09-05 05:38:10 +0000340/* Py_OVERFLOWED(X)
341 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
342 * a libm function, and invoke this macro after, passing the function
343 * result.
344 * Caution:
345 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000346 * any exceptional condition, but does require +- HUGE_VAL return
347 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
348 * double infinity, and we're cool if that's so, unless the input
349 * was an infinity and an infinity is the expected result. A C89
350 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000351 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
352 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
353 * in non-overflow cases.
354 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000355 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000356 *
357 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000358 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000359 * should be removed once a newer compiler is available on that platform.
360 * The system that had the failure was running OpenBSD 3.2 on Intel, with
361 * gcc 2.95.3.
362 *
Tim Peters862f0592004-09-23 19:11:32 +0000363 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000364 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000365 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000366#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000367#define Py_OVERFLOWED(X) isinf(X)
368#else
Tim Petersa40c7932001-09-05 22:36:56 +0000369#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
370 (X) == Py_HUGE_VAL || \
371 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000372#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000373
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000374/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000375 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000376 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
377 * to 0 before calling a libm function, and invoke this macro after,
378 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000379 * Caution:
380 * This isn't reliable. See Py_OVERFLOWED comments.
381 * X is evaluated more than once.
382 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000383#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000384#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
385#else
386#define _Py_SET_EDOM_FOR_NAN(X) ;
387#endif
388#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000389 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000390 if (errno == 0) { \
391 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
392 errno = ERANGE; \
393 else _Py_SET_EDOM_FOR_NAN(X) \
394 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000395 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000396
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000397/* Py_SET_ERANGE_ON_OVERFLOW(x)
398 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
399 */
400#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
401
Tim Petersdc5a5082002-03-09 04:58:24 +0000402/* Py_ADJUST_ERANGE1(x)
403 * Py_ADJUST_ERANGE2(x, y)
404 * Set errno to 0 before calling a libm function, and invoke one of these
405 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
406 * for functions returning complex results). This makes two kinds of
407 * adjustments to errno: (A) If it looks like the platform libm set
408 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
409 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
410 * effect, we're trying to force a useful implementation of C89 errno
411 * behavior.
412 * Caution:
413 * This isn't reliable. See Py_OVERFLOWED comments.
414 * X and Y may be evaluated more than once.
415 */
416#define Py_ADJUST_ERANGE1(X) \
417 do { \
418 if (errno == 0) { \
419 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
420 errno = ERANGE; \
421 } \
422 else if (errno == ERANGE && (X) == 0.0) \
423 errno = 0; \
424 } while(0)
425
426#define Py_ADJUST_ERANGE2(X, Y) \
427 do { \
428 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
429 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
430 if (errno == 0) \
431 errno = ERANGE; \
432 } \
433 else if (errno == ERANGE) \
434 errno = 0; \
435 } while(0)
436
Neal Norwitz80292642002-12-19 15:12:26 +0000437/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000438 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000439 * Usage:
440 * extern int old_var Py_DEPRECATED(2.3);
441 * typedef int T1 Py_DEPRECATED(2.4);
442 * extern int x() Py_DEPRECATED(2.5);
443 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000444#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
445 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000446#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
447#else
Tim Peters4643bd92002-12-28 21:56:08 +0000448#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000449#endif
450
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000451/**************************************************************************
452Prototypes that are missing from the standard include files on some systems
453(and possibly only some versions of such systems.)
454
455Please be conservative with adding new ones, document them and enclose them
456in platform-specific #ifdefs.
457**************************************************************************/
458
459#ifdef SOLARIS
460/* Unchecked */
461extern int gethostname(char *, int);
462#endif
463
464#ifdef __BEOS__
465/* Unchecked */
466/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000467int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000468#endif
469
470#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000471#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000472extern char * _getpty(int *, int, mode_t, int);
473#endif
474
475#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
476#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
477/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
478 functions, even though they are included in libutil. */
479#include <termios.h>
480extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
481extern int forkpty(int *, char *, struct termios *, struct winsize *);
482#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
483#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
484
485
486/* These are pulled from various places. It isn't obvious on what platforms
487 they are necessary, nor what the exact prototype should look like (which
488 is likely to vary between platforms!) If you find you need one of these
489 declarations, please move them to a platform-specific block and include
490 proper prototypes. */
491#if 0
492
493/* From Modules/resource.c */
494extern int getrusage();
495extern int getpagesize();
496
497/* From Python/sysmodule.c and Modules/posixmodule.c */
498extern int fclose(FILE *);
499
500/* From Modules/posixmodule.c */
501extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000502#endif /* 0 */
503
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000504
505/************************
506 * WRAPPER FOR <math.h> *
507 ************************/
508
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000509#ifndef HAVE_HYPOT
510extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000511#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000512
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000513
Hye-Shik Changf3032612006-03-22 08:52:43 +0000514/* On 4.4BSD-descendants, ctype functions serves the whole range of
515 * wchar_t character set rather than single byte code points only.
516 * This characteristic can break some operations of string object
517 * including str.upper() and str.split() on UTF-8 locales. This
518 * workaround was provided by Tim Robbins of FreeBSD project.
519 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000520
521#ifdef __FreeBSD__
522#include <osreldate.h>
523#if __FreeBSD_version > 500039
524#include <ctype.h>
525#include <wctype.h>
526#undef isalnum
527#define isalnum(c) iswalnum(btowc(c))
528#undef isalpha
529#define isalpha(c) iswalpha(btowc(c))
530#undef islower
531#define islower(c) iswlower(btowc(c))
532#undef isspace
533#define isspace(c) iswspace(btowc(c))
534#undef isupper
535#define isupper(c) iswupper(btowc(c))
536#undef tolower
537#define tolower(c) towlower(btowc(c))
538#undef toupper
539#define toupper(c) towupper(btowc(c))
540#endif
541#endif
542
543
Mark Hammond8235ea12002-07-19 06:55:41 +0000544/* Declarations for symbol visibility.
545
546 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000547 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000548 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000549 inside the Python core, they are private to the core.
550 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000551 external linkage depending on the platform.
552
553 As a number of platforms support/require "__declspec(dllimport/dllexport)",
554 we support a HAVE_DECLSPEC_DLL macro to save duplication.
555*/
556
Tim Peters4643bd92002-12-28 21:56:08 +0000557/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000558 All windows ports, except cygwin, are handled in PC/pyconfig.h.
559
560 BeOS and cygwin are the only other autoconf platform requiring special
561 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000562*/
563#if defined(__CYGWIN__) || defined(__BEOS__)
564# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000565#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000566
Jason Tishler30765592003-09-04 11:04:06 +0000567/* only get special linkage if built as shared or platform is Cygwin */
568#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000569# if defined(HAVE_DECLSPEC_DLL)
570# ifdef Py_BUILD_CORE
571# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000572# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000573 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000574 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
575# if defined(__CYGWIN__)
576# define PyMODINIT_FUNC __declspec(dllexport) void
577# else /* __CYGWIN__ */
578# define PyMODINIT_FUNC void
579# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000580# else /* Py_BUILD_CORE */
581 /* Building an extension module, or an embedded situation */
582 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000583 /* Under Cygwin, auto-import functions to prevent compilation */
584 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
585# if !defined(__CYGWIN__)
586# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
587# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000588# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000589 /* module init functions outside the core must be exported */
590# if defined(__cplusplus)
591# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
592# else /* __cplusplus */
593# define PyMODINIT_FUNC __declspec(dllexport) void
594# endif /* __cplusplus */
595# endif /* Py_BUILD_CORE */
596# endif /* HAVE_DECLSPEC */
597#endif /* Py_ENABLE_SHARED */
598
599/* If no external linkage macros defined by now, create defaults */
600#ifndef PyAPI_FUNC
601# define PyAPI_FUNC(RTYPE) RTYPE
602#endif
603#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000604# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000605#endif
606#ifndef PyMODINIT_FUNC
607# if defined(__cplusplus)
608# define PyMODINIT_FUNC extern "C" void
609# else /* __cplusplus */
610# define PyMODINIT_FUNC void
611# endif /* __cplusplus */
612#endif
613
614/* Deprecated DL_IMPORT and DL_EXPORT macros */
615#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
616# if defined(Py_BUILD_CORE)
617# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
618# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
619# else
620# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
621# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
622# endif
623#endif
624#ifndef DL_EXPORT
625# define DL_EXPORT(RTYPE) RTYPE
626#endif
627#ifndef DL_IMPORT
628# define DL_IMPORT(RTYPE) RTYPE
629#endif
630/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000631
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000632/* If the fd manipulation macros aren't defined,
633 here is a set that should do the job */
634
Guido van Rossum367e46a2000-08-01 18:28:44 +0000635#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000636
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000637#ifndef FD_SETSIZE
638#define FD_SETSIZE 256
639#endif
640
641#ifndef FD_SET
642
643typedef long fd_mask;
644
645#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
646#ifndef howmany
647#define howmany(x, y) (((x)+((y)-1))/(y))
648#endif /* howmany */
649
650typedef struct fd_set {
651 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
652} fd_set;
653
654#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
655#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
656#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
657#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
658
659#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000660
661#endif /* fd manipulation macros */
662
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000663
Fred Draked5fadf72000-09-26 05:46:01 +0000664/* limits.h constants that may be missing */
665
666#ifndef INT_MAX
667#define INT_MAX 2147483647
668#endif
669
670#ifndef LONG_MAX
671#if SIZEOF_LONG == 4
672#define LONG_MAX 0X7FFFFFFFL
673#elif SIZEOF_LONG == 8
674#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
675#else
676#error "could not set LONG_MAX in pyport.h"
677#endif
678#endif
679
680#ifndef LONG_MIN
681#define LONG_MIN (-LONG_MAX-1)
682#endif
683
Tim Petersd57731f2000-10-05 01:42:25 +0000684#ifndef LONG_BIT
685#define LONG_BIT (8 * SIZEOF_LONG)
686#endif
687
688#if LONG_BIT != 8 * SIZEOF_LONG
689/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
690 * 32-bit platforms using gcc. We try to catch that here at compile-time
691 * rather than waiting for integer multiplication to trigger bogus
692 * overflows.
693 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000694#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000695#endif
696
Tim Peters7d3a5112000-07-08 04:17:21 +0000697#ifdef __cplusplus
698}
699#endif
700
Neil Schemenauer15691082001-10-23 02:20:37 +0000701/*
702 * Hide GCC attributes from compilers that don't support them.
703 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000704#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000705 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000706 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000707#define Py_GCC_ATTRIBUTE(x)
708#else
709#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000710#endif
711
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000712/* Eliminate end-of-loop code not reached warnings from SunPro C
713 * when using do{...}while(0) macros
714 */
715#ifdef __SUNPRO_C
716#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
717#endif
718
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000719/*
720 * Older Microsoft compilers don't support the C99 long long literal suffixes,
721 * so these will be defined in PC/pyconfig.h for those compilers.
722 */
723#ifndef Py_LL
724#define Py_LL(x) x##LL
725#endif
726
727#ifndef Py_ULL
728#define Py_ULL(x) Py_LL(x##U)
729#endif
730
Tim Peters7d3a5112000-07-08 04:17:21 +0000731#endif /* Py_PYPORT_H */