blob: 7d51d0a4b63483c00001dbcd6b8089ec3ddcd044 [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
142 * inlining, where suitable. */
143
144#undef USE_INLINE /* XXX - set via configure? */
145
146#if defined(_MSC_VER)
147 /* ignore warnings if the compiler decides not to inline a function */
148#pragma warning(disable: 4710)
149/* fastest possible local call under MSVC */
150#define Py_LOCAL(type) static __inline type __fastcall
151#elif defined(USE_INLINE)
152#define Py_LOCAL(type) static inline type
153#else
154#define Py_LOCAL(type) static type
155#endif
156
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000157#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000158
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000159#include <math.h> /* Moved here from the math section, before extern "C" */
160
161/********************************************
162 * WRAPPER FOR <time.h> and/or <sys/time.h> *
163 ********************************************/
164
165#ifdef TIME_WITH_SYS_TIME
166#include <sys/time.h>
167#include <time.h>
168#else /* !TIME_WITH_SYS_TIME */
169#ifdef HAVE_SYS_TIME_H
170#include <sys/time.h>
171#else /* !HAVE_SYS_TIME_H */
172#include <time.h>
173#endif /* !HAVE_SYS_TIME_H */
174#endif /* !TIME_WITH_SYS_TIME */
175
176
177/******************************
178 * WRAPPER FOR <sys/select.h> *
179 ******************************/
180
181/* NB caller must include <sys/types.h> */
182
183#ifdef HAVE_SYS_SELECT_H
184
185#include <sys/select.h>
186
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000187#endif /* !HAVE_SYS_SELECT_H */
188
Tim Peters60f42b52001-01-18 03:03:16 +0000189/*******************************
190 * stat() and fstat() fiddling *
191 *******************************/
192
193/* We expect that stat and fstat exist on most systems.
194 * It's confirmed on Unix, Mac and Windows.
195 * If you don't have them, add
196 * #define DONT_HAVE_STAT
197 * and/or
198 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000199 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000200 * HAVE_FSTAT instead.
201 * Also
202 * #define DONT_HAVE_SYS_STAT_H
203 * if <sys/stat.h> doesn't exist on your platform, and
204 * #define HAVE_STAT_H
205 * if <stat.h> does (don't look at me -- ths mess is inherited).
206 */
207#ifndef DONT_HAVE_STAT
208#define HAVE_STAT
209#endif
210
211#ifndef DONT_HAVE_FSTAT
212#define HAVE_FSTAT
213#endif
214
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000215#ifdef RISCOS
216#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000217#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000218#endif
219
Tim Peters60f42b52001-01-18 03:03:16 +0000220#ifndef DONT_HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000221#if defined(PYOS_OS2) && defined(PYCC_GCC)
222#include <sys/types.h>
223#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000224#include <sys/stat.h>
225#elif defined(HAVE_STAT_H)
226#include <stat.h>
227#endif
228
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000229#if defined(PYCC_VACPP)
230/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
231#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
232#endif
233
234#ifndef S_ISREG
235#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
236#endif
237
238#ifndef S_ISDIR
239#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
240#endif
241
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000242
Tim Peters7d3a5112000-07-08 04:17:21 +0000243#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000244/* Move this down here since some C++ #include's don't like to be included
245 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000246extern "C" {
247#endif
248
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000249
Tim Peters7d3a5112000-07-08 04:17:21 +0000250/* Py_ARITHMETIC_RIGHT_SHIFT
251 * C doesn't define whether a right-shift of a signed integer sign-extends
252 * or zero-fills. Here a macro to force sign extension:
253 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
254 * Return I >> J, forcing sign extension.
255 * Requirements:
256 * I is of basic signed type TYPE (char, short, int, long, or long long).
257 * TYPE is one of char, short, int, long, or long long, although long long
258 * must not be used except on platforms that support it.
259 * J is an integer >= 0 and strictly less than the number of bits in TYPE
260 * (because C doesn't define what happens for J outside that range either).
261 * Caution:
262 * I may be evaluated more than once.
263 */
264#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
265#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
266 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
267#else
268#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
269#endif
270
Tim Peters39dce292000-08-15 03:34:48 +0000271/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000272 * "Simply" returns its argument. However, macro expansions within the
273 * argument are evaluated. This unfortunate trickery is needed to get
274 * token-pasting to work as desired in some cases.
275 */
276#define Py_FORCE_EXPANSION(X) X
277
Tim Peters8315ea52000-07-23 19:28:35 +0000278/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
279 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
280 * assert-fails if any information is lost.
281 * Caution:
282 * VALUE may be evaluated more than once.
283 */
284#ifdef Py_DEBUG
285#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
286 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
287#else
288#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
289#endif
290
Tim Peters862f0592004-09-23 19:11:32 +0000291/* Py_IS_NAN(X)
292 * Return 1 if float or double arg is a NaN, else 0.
293 * Caution:
294 * X is evaluated more than once.
295 * This may not work on all platforms. Each platform has *some*
296 * way to spell this, though -- override in pyconfig.h if you have
297 * a platform where it doesn't work.
298 */
299#ifndef Py_IS_NAN
300#define Py_IS_NAN(X) ((X) != (X))
301#endif
302
Tim Peters39dce292000-08-15 03:34:48 +0000303/* Py_IS_INFINITY(X)
304 * Return 1 if float or double arg is an infinity, else 0.
305 * Caution:
306 * X is evaluated more than once.
307 * This implementation may set the underflow flag if |X| is very small;
308 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000309 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000310 */
Tim Peters862f0592004-09-23 19:11:32 +0000311#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000312#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000313#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000314
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000315/* Py_IS_FINITE(X)
316 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
317 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000318 * macro for this particular test is useful
319 */
320#ifndef Py_IS_FINITE
321#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
322#endif
323
Tim Peters1de41bf2002-07-03 03:31:20 +0000324/* HUGE_VAL is supposed to expand to a positive double infinity. Python
325 * uses Py_HUGE_VAL instead because some platforms are broken in this
326 * respect. We used to embed code in pyport.h to try to worm around that,
327 * but different platforms are broken in conflicting ways. If you're on
328 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
329 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000330 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000331#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000332#define Py_HUGE_VAL HUGE_VAL
333#endif
334
Tim Peters57f282a2001-09-05 05:38:10 +0000335/* Py_OVERFLOWED(X)
336 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
337 * a libm function, and invoke this macro after, passing the function
338 * result.
339 * Caution:
340 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000341 * any exceptional condition, but does require +- HUGE_VAL return
342 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
343 * double infinity, and we're cool if that's so, unless the input
344 * was an infinity and an infinity is the expected result. A C89
345 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000346 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
347 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
348 * in non-overflow cases.
349 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000350 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000351 *
352 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000353 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000354 * should be removed once a newer compiler is available on that platform.
355 * The system that had the failure was running OpenBSD 3.2 on Intel, with
356 * gcc 2.95.3.
357 *
Tim Peters862f0592004-09-23 19:11:32 +0000358 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000359 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000360 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000361#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000362#define Py_OVERFLOWED(X) isinf(X)
363#else
Tim Petersa40c7932001-09-05 22:36:56 +0000364#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
365 (X) == Py_HUGE_VAL || \
366 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000367#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000368
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000369/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000370 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000371 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
372 * to 0 before calling a libm function, and invoke this macro after,
373 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000374 * Caution:
375 * This isn't reliable. See Py_OVERFLOWED comments.
376 * X is evaluated more than once.
377 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000378#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000379#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
380#else
381#define _Py_SET_EDOM_FOR_NAN(X) ;
382#endif
383#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000384 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000385 if (errno == 0) { \
386 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
387 errno = ERANGE; \
388 else _Py_SET_EDOM_FOR_NAN(X) \
389 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000390 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000391
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000392/* Py_SET_ERANGE_ON_OVERFLOW(x)
393 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
394 */
395#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
396
Tim Petersdc5a5082002-03-09 04:58:24 +0000397/* Py_ADJUST_ERANGE1(x)
398 * Py_ADJUST_ERANGE2(x, y)
399 * Set errno to 0 before calling a libm function, and invoke one of these
400 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
401 * for functions returning complex results). This makes two kinds of
402 * adjustments to errno: (A) If it looks like the platform libm set
403 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
404 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
405 * effect, we're trying to force a useful implementation of C89 errno
406 * behavior.
407 * Caution:
408 * This isn't reliable. See Py_OVERFLOWED comments.
409 * X and Y may be evaluated more than once.
410 */
411#define Py_ADJUST_ERANGE1(X) \
412 do { \
413 if (errno == 0) { \
414 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
415 errno = ERANGE; \
416 } \
417 else if (errno == ERANGE && (X) == 0.0) \
418 errno = 0; \
419 } while(0)
420
421#define Py_ADJUST_ERANGE2(X, Y) \
422 do { \
423 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
424 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
425 if (errno == 0) \
426 errno = ERANGE; \
427 } \
428 else if (errno == ERANGE) \
429 errno = 0; \
430 } while(0)
431
Neal Norwitz80292642002-12-19 15:12:26 +0000432/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000433 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000434 * Usage:
435 * extern int old_var Py_DEPRECATED(2.3);
436 * typedef int T1 Py_DEPRECATED(2.4);
437 * extern int x() Py_DEPRECATED(2.5);
438 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000439#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
440 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000441#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
442#else
Tim Peters4643bd92002-12-28 21:56:08 +0000443#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000444#endif
445
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000446/**************************************************************************
447Prototypes that are missing from the standard include files on some systems
448(and possibly only some versions of such systems.)
449
450Please be conservative with adding new ones, document them and enclose them
451in platform-specific #ifdefs.
452**************************************************************************/
453
454#ifdef SOLARIS
455/* Unchecked */
456extern int gethostname(char *, int);
457#endif
458
459#ifdef __BEOS__
460/* Unchecked */
461/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000462int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000463#endif
464
465#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000466#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000467extern char * _getpty(int *, int, mode_t, int);
468#endif
469
470#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
471#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
472/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
473 functions, even though they are included in libutil. */
474#include <termios.h>
475extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
476extern int forkpty(int *, char *, struct termios *, struct winsize *);
477#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
478#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
479
480
481/* These are pulled from various places. It isn't obvious on what platforms
482 they are necessary, nor what the exact prototype should look like (which
483 is likely to vary between platforms!) If you find you need one of these
484 declarations, please move them to a platform-specific block and include
485 proper prototypes. */
486#if 0
487
488/* From Modules/resource.c */
489extern int getrusage();
490extern int getpagesize();
491
492/* From Python/sysmodule.c and Modules/posixmodule.c */
493extern int fclose(FILE *);
494
495/* From Modules/posixmodule.c */
496extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000497#endif /* 0 */
498
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000499
500/************************
501 * WRAPPER FOR <math.h> *
502 ************************/
503
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000504#ifndef HAVE_HYPOT
505extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000506#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000507
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000508
Hye-Shik Changf3032612006-03-22 08:52:43 +0000509/* On 4.4BSD-descendants, ctype functions serves the whole range of
510 * wchar_t character set rather than single byte code points only.
511 * This characteristic can break some operations of string object
512 * including str.upper() and str.split() on UTF-8 locales. This
513 * workaround was provided by Tim Robbins of FreeBSD project.
514 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000515
516#ifdef __FreeBSD__
517#include <osreldate.h>
518#if __FreeBSD_version > 500039
519#include <ctype.h>
520#include <wctype.h>
521#undef isalnum
522#define isalnum(c) iswalnum(btowc(c))
523#undef isalpha
524#define isalpha(c) iswalpha(btowc(c))
525#undef islower
526#define islower(c) iswlower(btowc(c))
527#undef isspace
528#define isspace(c) iswspace(btowc(c))
529#undef isupper
530#define isupper(c) iswupper(btowc(c))
531#undef tolower
532#define tolower(c) towlower(btowc(c))
533#undef toupper
534#define toupper(c) towupper(btowc(c))
535#endif
536#endif
537
538
Mark Hammond8235ea12002-07-19 06:55:41 +0000539/* Declarations for symbol visibility.
540
541 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000542 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000543 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000544 inside the Python core, they are private to the core.
545 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000546 external linkage depending on the platform.
547
548 As a number of platforms support/require "__declspec(dllimport/dllexport)",
549 we support a HAVE_DECLSPEC_DLL macro to save duplication.
550*/
551
Tim Peters4643bd92002-12-28 21:56:08 +0000552/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000553 All windows ports, except cygwin, are handled in PC/pyconfig.h.
554
555 BeOS and cygwin are the only other autoconf platform requiring special
556 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000557*/
558#if defined(__CYGWIN__) || defined(__BEOS__)
559# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000560#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000561
Jason Tishler30765592003-09-04 11:04:06 +0000562/* only get special linkage if built as shared or platform is Cygwin */
563#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000564# if defined(HAVE_DECLSPEC_DLL)
565# ifdef Py_BUILD_CORE
566# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000567# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000568 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000569 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
570# if defined(__CYGWIN__)
571# define PyMODINIT_FUNC __declspec(dllexport) void
572# else /* __CYGWIN__ */
573# define PyMODINIT_FUNC void
574# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000575# else /* Py_BUILD_CORE */
576 /* Building an extension module, or an embedded situation */
577 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000578 /* Under Cygwin, auto-import functions to prevent compilation */
579 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
580# if !defined(__CYGWIN__)
581# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
582# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000583# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000584 /* module init functions outside the core must be exported */
585# if defined(__cplusplus)
586# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
587# else /* __cplusplus */
588# define PyMODINIT_FUNC __declspec(dllexport) void
589# endif /* __cplusplus */
590# endif /* Py_BUILD_CORE */
591# endif /* HAVE_DECLSPEC */
592#endif /* Py_ENABLE_SHARED */
593
594/* If no external linkage macros defined by now, create defaults */
595#ifndef PyAPI_FUNC
596# define PyAPI_FUNC(RTYPE) RTYPE
597#endif
598#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000599# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000600#endif
601#ifndef PyMODINIT_FUNC
602# if defined(__cplusplus)
603# define PyMODINIT_FUNC extern "C" void
604# else /* __cplusplus */
605# define PyMODINIT_FUNC void
606# endif /* __cplusplus */
607#endif
608
609/* Deprecated DL_IMPORT and DL_EXPORT macros */
610#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
611# if defined(Py_BUILD_CORE)
612# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
613# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
614# else
615# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
616# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
617# endif
618#endif
619#ifndef DL_EXPORT
620# define DL_EXPORT(RTYPE) RTYPE
621#endif
622#ifndef DL_IMPORT
623# define DL_IMPORT(RTYPE) RTYPE
624#endif
625/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000626
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000627/* If the fd manipulation macros aren't defined,
628 here is a set that should do the job */
629
Guido van Rossum367e46a2000-08-01 18:28:44 +0000630#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000631
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000632#ifndef FD_SETSIZE
633#define FD_SETSIZE 256
634#endif
635
636#ifndef FD_SET
637
638typedef long fd_mask;
639
640#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
641#ifndef howmany
642#define howmany(x, y) (((x)+((y)-1))/(y))
643#endif /* howmany */
644
645typedef struct fd_set {
646 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
647} fd_set;
648
649#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
650#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
651#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
652#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
653
654#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000655
656#endif /* fd manipulation macros */
657
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000658
Fred Draked5fadf72000-09-26 05:46:01 +0000659/* limits.h constants that may be missing */
660
661#ifndef INT_MAX
662#define INT_MAX 2147483647
663#endif
664
665#ifndef LONG_MAX
666#if SIZEOF_LONG == 4
667#define LONG_MAX 0X7FFFFFFFL
668#elif SIZEOF_LONG == 8
669#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
670#else
671#error "could not set LONG_MAX in pyport.h"
672#endif
673#endif
674
675#ifndef LONG_MIN
676#define LONG_MIN (-LONG_MAX-1)
677#endif
678
Tim Petersd57731f2000-10-05 01:42:25 +0000679#ifndef LONG_BIT
680#define LONG_BIT (8 * SIZEOF_LONG)
681#endif
682
683#if LONG_BIT != 8 * SIZEOF_LONG
684/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
685 * 32-bit platforms using gcc. We try to catch that here at compile-time
686 * rather than waiting for integer multiplication to trigger bogus
687 * overflows.
688 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000689#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000690#endif
691
Tim Peters7d3a5112000-07-08 04:17:21 +0000692#ifdef __cplusplus
693}
694#endif
695
Neil Schemenauer15691082001-10-23 02:20:37 +0000696/*
697 * Hide GCC attributes from compilers that don't support them.
698 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000699#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000700 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000701 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000702#define Py_GCC_ATTRIBUTE(x)
703#else
704#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000705#endif
706
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000707/* Eliminate end-of-loop code not reached warnings from SunPro C
708 * when using do{...}while(0) macros
709 */
710#ifdef __SUNPRO_C
711#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
712#endif
713
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000714/*
715 * Older Microsoft compilers don't support the C99 long long literal suffixes,
716 * so these will be defined in PC/pyconfig.h for those compilers.
717 */
718#ifndef Py_LL
719#define Py_LL(x) x##LL
720#endif
721
722#ifndef Py_ULL
723#define Py_ULL(x) Py_LL(x##U)
724#endif
725
Tim Peters7d3a5112000-07-08 04:17:21 +0000726#endif /* Py_PYPORT_H */