blob: 0020d7cf6ed0aa6b879d591732f0d5bd3eead2c9 [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
Martin v. Löwis40e9aed2006-10-02 15:20:37 +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
38
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000039/* For backward compatibility only. Obsolete, do not use. */
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000040#ifdef HAVE_PROTOTYPES
41#define Py_PROTO(x) x
42#else
43#define Py_PROTO(x) ()
44#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000045#ifndef Py_FPROTO
46#define Py_FPROTO(x) Py_PROTO(x)
47#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000048
Barry Warsawfd847b22000-08-18 04:48:18 +000049/* typedefs for some C9X-defined synonyms for integral types.
50 *
51 * The names in Python are exactly the same as the C9X names, except with a
52 * Py_ prefix. Until C9X is universally implemented, this is the only way
53 * to ensure that Python gets reliable names that don't conflict with names
54 * in non-Python code that are playing their own tricks to define the C9X
55 * names.
56 *
57 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
58 * integral synonyms. Only define the ones we actually need.
59 */
60
61#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000062#ifndef PY_LONG_LONG
63#define PY_LONG_LONG long long
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000064#if defined(LLONG_MAX)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000065/* If LLONG_MAX is defined in limits.h, use that. */
Martin v. Löwis6371cd82007-06-09 07:42:52 +000066#define PY_LLONG_MIN LLONG_MIN
67#define PY_LLONG_MAX LLONG_MAX
68#define PY_ULLONG_MAX ULLONG_MAX
Martin v. Löwis2a71a472007-06-13 03:42:19 +000069#elif defined(__LONG_LONG_MAX__)
70/* Otherwise, if GCC has a builtin define, use that. */
71#define PY_LLONG_MAX __LONG_LONG_MAX__
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000072#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000073#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
74#else
75/* Otherwise, rely on two's complement. */
76#define PY_ULLONG_MAX (~0ULL)
77#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
78#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000079#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000080#endif
81#endif /* HAVE_LONG_LONG */
82
83/* uintptr_t is the C9X name for an unsigned integral type such that a
84 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000085 * without loss of information. Similarly for intptr_t, wrt a signed
86 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000087 */
88#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000089typedef uintptr_t Py_uintptr_t;
90typedef intptr_t Py_intptr_t;
91
Barry Warsawfd847b22000-08-18 04:48:18 +000092#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000093typedef unsigned int Py_uintptr_t;
94typedef int Py_intptr_t;
95
Barry Warsawfd847b22000-08-18 04:48:18 +000096#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000097typedef unsigned long Py_uintptr_t;
98typedef long Py_intptr_t;
99
Barry Warsawfd847b22000-08-18 04:48:18 +0000100#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000101typedef unsigned PY_LONG_LONG Py_uintptr_t;
102typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000103
Barry Warsawfd847b22000-08-18 04:48:18 +0000104#else
105# error "Python needs a typedef for Py_uintptr_t in pyport.h."
106#endif /* HAVE_UINTPTR_T */
107
Tim Petersae1d0c92006-03-17 03:29:34 +0000108/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
109 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
110 * unsigned integral type). See PEP 353 for details.
111 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000112#ifdef HAVE_SSIZE_T
113typedef ssize_t Py_ssize_t;
114#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000115typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000116#else
117# error "Python needs a typedef for Py_ssize_t in pyport.h."
118#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000119
120/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000122/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000123#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000124
Tim Petersae1d0c92006-03-17 03:29:34 +0000125/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
126 * format to convert an argument with the width of a size_t or Py_ssize_t.
127 * C99 introduced "z" for this purpose, but not all platforms support that;
128 * e.g., MS compilers use "I" instead.
129 *
130 * These "high level" Python format functions interpret "z" correctly on
131 * all platforms (Python interprets the format string itself, and does whatever
132 * the platform C requires to convert a size_t/Py_ssize_t argument):
133 *
134 * PyString_FromFormat
135 * PyErr_Format
136 * PyString_FromFormatV
137 *
138 * Lower-level uses require that you interpolate the correct format modifier
139 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
140 * example,
141 *
142 * Py_ssize_t index;
143 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
144 *
145 * That will expand to %ld, or %Id, or to something else correct for a
146 * Py_ssize_t on the platform.
147 */
148#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000149# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000150# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000151# elif SIZEOF_SIZE_T == SIZEOF_LONG
152# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000153# elif defined(MS_WINDOWS)
154# define PY_FORMAT_SIZE_T "I"
155# else
156# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
157# endif
158#endif
159
Fredrik Lundh7a830892006-05-27 10:39:48 +0000160/* Py_LOCAL can be used instead of static to get the fastest possible calling
161 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000162 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000163 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
164 * for platforms that support that.
165 *
166 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
167 * "aggressive" inlining/optimizaion is enabled for the entire module. This
168 * may lead to code bloat, and may slow things down for those reasons. It may
169 * also lead to errors, if the code relies on pointer aliasing. Use with
170 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000171 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000172 * NOTE: You can only use this for functions that are entirely local to a
173 * module; functions that are exported via method tables, callbacks, etc,
174 * should keep using static.
175 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000176
177#undef USE_INLINE /* XXX - set via configure? */
178
179#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000180#if defined(PY_LOCAL_AGGRESSIVE)
181/* enable more aggressive optimization for visual studio */
182#pragma optimize("agtw", on)
183#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000184/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000185#pragma warning(disable: 4710)
186/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000187#define Py_LOCAL(type) static type __fastcall
188#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000189#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000190#define Py_LOCAL(type) static type
191#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000192#else
193#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000194#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000195#endif
196
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000197/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
198 * are often very short. While most platforms have highly optimized code for
199 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
200 * solves this by doing short copies "in line".
201 */
202
203#if defined(_MSC_VER)
204#define Py_MEMCPY(target, source, length) do { \
205 size_t i_, n_ = (length); \
206 char *t_ = (void*) (target); \
207 const char *s_ = (void*) (source); \
208 if (n_ >= 16) \
209 memcpy(t_, s_, n_); \
210 else \
211 for (i_ = 0; i_ < n_; i_++) \
212 t_[i_] = s_[i_]; \
213 } while (0)
214#else
215#define Py_MEMCPY memcpy
216#endif
217
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000218#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000219
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000220#include <math.h> /* Moved here from the math section, before extern "C" */
221
222/********************************************
223 * WRAPPER FOR <time.h> and/or <sys/time.h> *
224 ********************************************/
225
226#ifdef TIME_WITH_SYS_TIME
227#include <sys/time.h>
228#include <time.h>
229#else /* !TIME_WITH_SYS_TIME */
230#ifdef HAVE_SYS_TIME_H
231#include <sys/time.h>
232#else /* !HAVE_SYS_TIME_H */
233#include <time.h>
234#endif /* !HAVE_SYS_TIME_H */
235#endif /* !TIME_WITH_SYS_TIME */
236
237
238/******************************
239 * WRAPPER FOR <sys/select.h> *
240 ******************************/
241
242/* NB caller must include <sys/types.h> */
243
244#ifdef HAVE_SYS_SELECT_H
245
246#include <sys/select.h>
247
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000248#endif /* !HAVE_SYS_SELECT_H */
249
Tim Peters60f42b52001-01-18 03:03:16 +0000250/*******************************
251 * stat() and fstat() fiddling *
252 *******************************/
253
254/* We expect that stat and fstat exist on most systems.
255 * It's confirmed on Unix, Mac and Windows.
256 * If you don't have them, add
257 * #define DONT_HAVE_STAT
258 * and/or
259 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000260 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000261 * HAVE_FSTAT instead.
262 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000263 * #define HAVE_SYS_STAT_H
264 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000265 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000266 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000267 */
268#ifndef DONT_HAVE_STAT
269#define HAVE_STAT
270#endif
271
272#ifndef DONT_HAVE_FSTAT
273#define HAVE_FSTAT
274#endif
275
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000276#ifdef RISCOS
277#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000278#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000279#endif
280
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000281#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000282#if defined(PYOS_OS2) && defined(PYCC_GCC)
283#include <sys/types.h>
284#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000285#include <sys/stat.h>
286#elif defined(HAVE_STAT_H)
287#include <stat.h>
288#endif
289
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000290#if defined(PYCC_VACPP)
291/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
292#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
293#endif
294
295#ifndef S_ISREG
296#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
297#endif
298
299#ifndef S_ISDIR
300#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
301#endif
302
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000303
Tim Peters7d3a5112000-07-08 04:17:21 +0000304#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000305/* Move this down here since some C++ #include's don't like to be included
306 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000307extern "C" {
308#endif
309
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000310
Tim Peters7d3a5112000-07-08 04:17:21 +0000311/* Py_ARITHMETIC_RIGHT_SHIFT
312 * C doesn't define whether a right-shift of a signed integer sign-extends
313 * or zero-fills. Here a macro to force sign extension:
314 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
315 * Return I >> J, forcing sign extension.
316 * Requirements:
317 * I is of basic signed type TYPE (char, short, int, long, or long long).
318 * TYPE is one of char, short, int, long, or long long, although long long
319 * must not be used except on platforms that support it.
320 * J is an integer >= 0 and strictly less than the number of bits in TYPE
321 * (because C doesn't define what happens for J outside that range either).
322 * Caution:
323 * I may be evaluated more than once.
324 */
325#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
326#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
327 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
328#else
329#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
330#endif
331
Tim Peters39dce292000-08-15 03:34:48 +0000332/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000333 * "Simply" returns its argument. However, macro expansions within the
334 * argument are evaluated. This unfortunate trickery is needed to get
335 * token-pasting to work as desired in some cases.
336 */
337#define Py_FORCE_EXPANSION(X) X
338
Tim Peters8315ea52000-07-23 19:28:35 +0000339/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
340 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
341 * assert-fails if any information is lost.
342 * Caution:
343 * VALUE may be evaluated more than once.
344 */
345#ifdef Py_DEBUG
346#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
347 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
348#else
349#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
350#endif
351
Tim Peters862f0592004-09-23 19:11:32 +0000352/* Py_IS_NAN(X)
353 * Return 1 if float or double arg is a NaN, else 0.
354 * Caution:
355 * X is evaluated more than once.
356 * This may not work on all platforms. Each platform has *some*
357 * way to spell this, though -- override in pyconfig.h if you have
358 * a platform where it doesn't work.
359 */
360#ifndef Py_IS_NAN
361#define Py_IS_NAN(X) ((X) != (X))
362#endif
363
Tim Peters39dce292000-08-15 03:34:48 +0000364/* Py_IS_INFINITY(X)
365 * Return 1 if float or double arg is an infinity, else 0.
366 * Caution:
367 * X is evaluated more than once.
368 * This implementation may set the underflow flag if |X| is very small;
369 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000370 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000371 */
Tim Peters862f0592004-09-23 19:11:32 +0000372#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000373#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000374#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000375
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000376/* Py_IS_FINITE(X)
377 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
378 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000379 * macro for this particular test is useful
380 */
381#ifndef Py_IS_FINITE
382#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
383#endif
384
Tim Peters1de41bf2002-07-03 03:31:20 +0000385/* HUGE_VAL is supposed to expand to a positive double infinity. Python
386 * uses Py_HUGE_VAL instead because some platforms are broken in this
387 * respect. We used to embed code in pyport.h to try to worm around that,
388 * but different platforms are broken in conflicting ways. If you're on
389 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
390 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000391 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000392#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000393#define Py_HUGE_VAL HUGE_VAL
394#endif
395
Tim Peters57f282a2001-09-05 05:38:10 +0000396/* Py_OVERFLOWED(X)
397 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
398 * a libm function, and invoke this macro after, passing the function
399 * result.
400 * Caution:
401 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000402 * any exceptional condition, but does require +- HUGE_VAL return
403 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
404 * double infinity, and we're cool if that's so, unless the input
405 * was an infinity and an infinity is the expected result. A C89
406 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000407 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
408 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
409 * in non-overflow cases.
410 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000411 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000412 *
413 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000414 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000415 * should be removed once a newer compiler is available on that platform.
416 * The system that had the failure was running OpenBSD 3.2 on Intel, with
417 * gcc 2.95.3.
418 *
Tim Peters862f0592004-09-23 19:11:32 +0000419 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000420 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000421 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000422#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000423#define Py_OVERFLOWED(X) isinf(X)
424#else
Tim Petersa40c7932001-09-05 22:36:56 +0000425#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
426 (X) == Py_HUGE_VAL || \
427 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000428#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000429
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000430/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000431 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000432 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
433 * to 0 before calling a libm function, and invoke this macro after,
434 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000435 * Caution:
436 * This isn't reliable. See Py_OVERFLOWED comments.
437 * X is evaluated more than once.
438 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000439#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000440#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
441#else
442#define _Py_SET_EDOM_FOR_NAN(X) ;
443#endif
444#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000445 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000446 if (errno == 0) { \
447 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
448 errno = ERANGE; \
449 else _Py_SET_EDOM_FOR_NAN(X) \
450 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000451 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000452
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000453/* Py_SET_ERANGE_ON_OVERFLOW(x)
454 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
455 */
456#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
457
Tim Petersdc5a5082002-03-09 04:58:24 +0000458/* Py_ADJUST_ERANGE1(x)
459 * Py_ADJUST_ERANGE2(x, y)
460 * Set errno to 0 before calling a libm function, and invoke one of these
461 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
462 * for functions returning complex results). This makes two kinds of
463 * adjustments to errno: (A) If it looks like the platform libm set
464 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
465 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
466 * effect, we're trying to force a useful implementation of C89 errno
467 * behavior.
468 * Caution:
469 * This isn't reliable. See Py_OVERFLOWED comments.
470 * X and Y may be evaluated more than once.
471 */
472#define Py_ADJUST_ERANGE1(X) \
473 do { \
474 if (errno == 0) { \
475 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
476 errno = ERANGE; \
477 } \
478 else if (errno == ERANGE && (X) == 0.0) \
479 errno = 0; \
480 } while(0)
481
482#define Py_ADJUST_ERANGE2(X, Y) \
483 do { \
484 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
485 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
486 if (errno == 0) \
487 errno = ERANGE; \
488 } \
489 else if (errno == ERANGE) \
490 errno = 0; \
491 } while(0)
492
Neal Norwitz80292642002-12-19 15:12:26 +0000493/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000494 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000495 * Usage:
496 * extern int old_var Py_DEPRECATED(2.3);
497 * typedef int T1 Py_DEPRECATED(2.4);
498 * extern int x() Py_DEPRECATED(2.5);
499 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000500#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
501 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000502#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
503#else
Tim Peters4643bd92002-12-28 21:56:08 +0000504#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000505#endif
506
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000507/**************************************************************************
508Prototypes that are missing from the standard include files on some systems
509(and possibly only some versions of such systems.)
510
511Please be conservative with adding new ones, document them and enclose them
512in platform-specific #ifdefs.
513**************************************************************************/
514
515#ifdef SOLARIS
516/* Unchecked */
517extern int gethostname(char *, int);
518#endif
519
520#ifdef __BEOS__
521/* Unchecked */
522/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000523int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000524#endif
525
526#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000527#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000528extern char * _getpty(int *, int, mode_t, int);
529#endif
530
531#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
532#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
533/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
534 functions, even though they are included in libutil. */
535#include <termios.h>
536extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
537extern int forkpty(int *, char *, struct termios *, struct winsize *);
538#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
539#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
540
541
542/* These are pulled from various places. It isn't obvious on what platforms
543 they are necessary, nor what the exact prototype should look like (which
544 is likely to vary between platforms!) If you find you need one of these
545 declarations, please move them to a platform-specific block and include
546 proper prototypes. */
547#if 0
548
549/* From Modules/resource.c */
550extern int getrusage();
551extern int getpagesize();
552
553/* From Python/sysmodule.c and Modules/posixmodule.c */
554extern int fclose(FILE *);
555
556/* From Modules/posixmodule.c */
557extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000558#endif /* 0 */
559
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000560
561/************************
562 * WRAPPER FOR <math.h> *
563 ************************/
564
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000565#ifndef HAVE_HYPOT
566extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000567#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000568
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000569
Hye-Shik Changf3032612006-03-22 08:52:43 +0000570/* On 4.4BSD-descendants, ctype functions serves the whole range of
571 * wchar_t character set rather than single byte code points only.
572 * This characteristic can break some operations of string object
573 * including str.upper() and str.split() on UTF-8 locales. This
574 * workaround was provided by Tim Robbins of FreeBSD project.
575 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000576
577#ifdef __FreeBSD__
578#include <osreldate.h>
579#if __FreeBSD_version > 500039
580#include <ctype.h>
581#include <wctype.h>
582#undef isalnum
583#define isalnum(c) iswalnum(btowc(c))
584#undef isalpha
585#define isalpha(c) iswalpha(btowc(c))
586#undef islower
587#define islower(c) iswlower(btowc(c))
588#undef isspace
589#define isspace(c) iswspace(btowc(c))
590#undef isupper
591#define isupper(c) iswupper(btowc(c))
592#undef tolower
593#define tolower(c) towlower(btowc(c))
594#undef toupper
595#define toupper(c) towupper(btowc(c))
596#endif
597#endif
598
599
Mark Hammond8235ea12002-07-19 06:55:41 +0000600/* Declarations for symbol visibility.
601
602 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000603 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000604 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000605 inside the Python core, they are private to the core.
606 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000607 external linkage depending on the platform.
608
609 As a number of platforms support/require "__declspec(dllimport/dllexport)",
610 we support a HAVE_DECLSPEC_DLL macro to save duplication.
611*/
612
Tim Peters4643bd92002-12-28 21:56:08 +0000613/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000614 All windows ports, except cygwin, are handled in PC/pyconfig.h.
615
616 BeOS and cygwin are the only other autoconf platform requiring special
617 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000618*/
619#if defined(__CYGWIN__) || defined(__BEOS__)
620# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000621#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000622
Jason Tishler30765592003-09-04 11:04:06 +0000623/* only get special linkage if built as shared or platform is Cygwin */
624#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000625# if defined(HAVE_DECLSPEC_DLL)
626# ifdef Py_BUILD_CORE
627# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000628# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000629 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000630 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
631# if defined(__CYGWIN__)
632# define PyMODINIT_FUNC __declspec(dllexport) void
633# else /* __CYGWIN__ */
634# define PyMODINIT_FUNC void
635# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000636# else /* Py_BUILD_CORE */
637 /* Building an extension module, or an embedded situation */
638 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000639 /* Under Cygwin, auto-import functions to prevent compilation */
640 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
641# if !defined(__CYGWIN__)
642# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
643# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000644# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000645 /* module init functions outside the core must be exported */
646# if defined(__cplusplus)
647# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
648# else /* __cplusplus */
649# define PyMODINIT_FUNC __declspec(dllexport) void
650# endif /* __cplusplus */
651# endif /* Py_BUILD_CORE */
652# endif /* HAVE_DECLSPEC */
653#endif /* Py_ENABLE_SHARED */
654
655/* If no external linkage macros defined by now, create defaults */
656#ifndef PyAPI_FUNC
657# define PyAPI_FUNC(RTYPE) RTYPE
658#endif
659#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000660# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000661#endif
662#ifndef PyMODINIT_FUNC
663# if defined(__cplusplus)
664# define PyMODINIT_FUNC extern "C" void
665# else /* __cplusplus */
666# define PyMODINIT_FUNC void
667# endif /* __cplusplus */
668#endif
669
670/* Deprecated DL_IMPORT and DL_EXPORT macros */
671#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
672# if defined(Py_BUILD_CORE)
673# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
674# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
675# else
676# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
677# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
678# endif
679#endif
680#ifndef DL_EXPORT
681# define DL_EXPORT(RTYPE) RTYPE
682#endif
683#ifndef DL_IMPORT
684# define DL_IMPORT(RTYPE) RTYPE
685#endif
686/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000687
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000688/* If the fd manipulation macros aren't defined,
689 here is a set that should do the job */
690
Guido van Rossum367e46a2000-08-01 18:28:44 +0000691#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000692
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000693#ifndef FD_SETSIZE
694#define FD_SETSIZE 256
695#endif
696
697#ifndef FD_SET
698
699typedef long fd_mask;
700
701#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
702#ifndef howmany
703#define howmany(x, y) (((x)+((y)-1))/(y))
704#endif /* howmany */
705
706typedef struct fd_set {
707 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
708} fd_set;
709
710#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
711#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
712#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
713#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
714
715#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000716
717#endif /* fd manipulation macros */
718
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000719
Fred Draked5fadf72000-09-26 05:46:01 +0000720/* limits.h constants that may be missing */
721
722#ifndef INT_MAX
723#define INT_MAX 2147483647
724#endif
725
726#ifndef LONG_MAX
727#if SIZEOF_LONG == 4
728#define LONG_MAX 0X7FFFFFFFL
729#elif SIZEOF_LONG == 8
730#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
731#else
732#error "could not set LONG_MAX in pyport.h"
733#endif
734#endif
735
736#ifndef LONG_MIN
737#define LONG_MIN (-LONG_MAX-1)
738#endif
739
Tim Petersd57731f2000-10-05 01:42:25 +0000740#ifndef LONG_BIT
741#define LONG_BIT (8 * SIZEOF_LONG)
742#endif
743
744#if LONG_BIT != 8 * SIZEOF_LONG
745/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
746 * 32-bit platforms using gcc. We try to catch that here at compile-time
747 * rather than waiting for integer multiplication to trigger bogus
748 * overflows.
749 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000750#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000751#endif
752
Tim Peters7d3a5112000-07-08 04:17:21 +0000753#ifdef __cplusplus
754}
755#endif
756
Neil Schemenauer15691082001-10-23 02:20:37 +0000757/*
758 * Hide GCC attributes from compilers that don't support them.
759 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000760#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000761 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000762 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000763#define Py_GCC_ATTRIBUTE(x)
764#else
765#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000766#endif
767
Martin v. Löwisaac13162006-10-19 10:58:46 +0000768/*
769 * Add PyArg_ParseTuple format where available.
770 */
771#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
772#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
773#else
774#define Py_FORMAT_PARSETUPLE(func,p1,p2)
775#endif
776
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000777/* Eliminate end-of-loop code not reached warnings from SunPro C
778 * when using do{...}while(0) macros
779 */
780#ifdef __SUNPRO_C
781#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
782#endif
783
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000784/*
785 * Older Microsoft compilers don't support the C99 long long literal suffixes,
786 * so these will be defined in PC/pyconfig.h for those compilers.
787 */
788#ifndef Py_LL
789#define Py_LL(x) x##LL
790#endif
791
792#ifndef Py_ULL
793#define Py_ULL(x) Py_LL(x##U)
794#endif
795
Tim Peters7d3a5112000-07-08 04:17:21 +0000796#endif /* Py_PYPORT_H */