blob: 225b126a73bb2beb33655abce9627e1234835d5f [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
Christian Heimes0a8143f2007-12-18 23:22:54 +0000352/* High precision defintion of pi and e (Euler)
353 * The values are taken from libc6's math.h.
354 */
Christian Heimes0a83d792008-01-03 21:14:48 +0000355#ifndef Py_MATH_PIl
356#define Py_MATH_PIl 3.1415926535897932384626433832795029L
357#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000358#ifndef Py_MATH_PI
Christian Heimes0a83d792008-01-03 21:14:48 +0000359#define Py_MATH_PI 3.14159265358979323846
360#endif
361
362#ifndef Py_MATH_El
363#define Py_MATH_El 2.7182818284590452353602874713526625L
Christian Heimes0a8143f2007-12-18 23:22:54 +0000364#endif
365
366#ifndef Py_MATH_E
Christian Heimes0a83d792008-01-03 21:14:48 +0000367#define Py_MATH_E 2.7182818284590452354
Christian Heimes0a8143f2007-12-18 23:22:54 +0000368#endif
369
Tim Peters862f0592004-09-23 19:11:32 +0000370/* Py_IS_NAN(X)
371 * Return 1 if float or double arg is a NaN, else 0.
372 * Caution:
373 * X is evaluated more than once.
374 * This may not work on all platforms. Each platform has *some*
375 * way to spell this, though -- override in pyconfig.h if you have
376 * a platform where it doesn't work.
377 */
378#ifndef Py_IS_NAN
Christian Heimes0a8143f2007-12-18 23:22:54 +0000379#ifdef HAVE_ISNAN
380#define Py_IS_NAN(X) isnan(X)
381#else
Tim Peters862f0592004-09-23 19:11:32 +0000382#define Py_IS_NAN(X) ((X) != (X))
383#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000384#endif
Tim Peters862f0592004-09-23 19:11:32 +0000385
Tim Peters39dce292000-08-15 03:34:48 +0000386/* Py_IS_INFINITY(X)
387 * Return 1 if float or double arg is an infinity, else 0.
388 * Caution:
389 * X is evaluated more than once.
390 * This implementation may set the underflow flag if |X| is very small;
391 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000392 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000393 */
Tim Peters862f0592004-09-23 19:11:32 +0000394#ifndef Py_IS_INFINITY
Christian Heimes0a8143f2007-12-18 23:22:54 +0000395#ifdef HAVE_ISINF
396#define Py_IS_INFINITY(X) isinf(X)
397#else
Tim Peters1a2eefd2000-09-08 15:45:34 +0000398#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000399#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000400#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000401
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000402/* Py_IS_FINITE(X)
403 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
404 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000405 * macro for this particular test is useful
406 */
407#ifndef Py_IS_FINITE
Christian Heimes48723512008-01-20 14:28:28 +0000408#ifdef HAVE_FINITE
409#define Py_IS_FINITE(X) finite
Christian Heimes0a8143f2007-12-18 23:22:54 +0000410#else
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000411#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
412#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000413#endif
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000414
Tim Peters1de41bf2002-07-03 03:31:20 +0000415/* HUGE_VAL is supposed to expand to a positive double infinity. Python
416 * uses Py_HUGE_VAL instead because some platforms are broken in this
417 * respect. We used to embed code in pyport.h to try to worm around that,
418 * but different platforms are broken in conflicting ways. If you're on
419 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
420 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000421 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000422#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000423#define Py_HUGE_VAL HUGE_VAL
424#endif
425
Christian Heimes0a8143f2007-12-18 23:22:54 +0000426/* Py_NAN
427 * A value that evaluates to a NaN. On IEEE 754 platforms INF*0 or
428 * INF/INF works. Define Py_NO_NAN in pyconfig.h if your platform
429 * doesn't support NaNs.
430 */
431#if !defined(Py_NAN) && !defined(Py_NO_NAN)
432#define Py_NAN (Py_HUGE_VAL * 0.)
433#endif
434
Tim Peters57f282a2001-09-05 05:38:10 +0000435/* Py_OVERFLOWED(X)
436 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
437 * a libm function, and invoke this macro after, passing the function
438 * result.
439 * Caution:
440 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000441 * any exceptional condition, but does require +- HUGE_VAL return
442 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
443 * double infinity, and we're cool if that's so, unless the input
444 * was an infinity and an infinity is the expected result. A C89
445 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000446 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
447 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
448 * in non-overflow cases.
449 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000450 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000451 *
452 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000453 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000454 * should be removed once a newer compiler is available on that platform.
455 * The system that had the failure was running OpenBSD 3.2 on Intel, with
456 * gcc 2.95.3.
457 *
Tim Peters862f0592004-09-23 19:11:32 +0000458 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000459 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000460 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000461#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000462#define Py_OVERFLOWED(X) isinf(X)
463#else
Tim Petersa40c7932001-09-05 22:36:56 +0000464#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
465 (X) == Py_HUGE_VAL || \
466 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000467#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000468
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000469/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000470 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000471 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
472 * to 0 before calling a libm function, and invoke this macro after,
473 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000474 * Caution:
475 * This isn't reliable. See Py_OVERFLOWED comments.
476 * X is evaluated more than once.
477 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000478#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000479#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
480#else
481#define _Py_SET_EDOM_FOR_NAN(X) ;
482#endif
483#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000484 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000485 if (errno == 0) { \
486 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
487 errno = ERANGE; \
488 else _Py_SET_EDOM_FOR_NAN(X) \
489 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000490 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000491
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000492/* Py_SET_ERANGE_ON_OVERFLOW(x)
493 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
494 */
495#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
496
Tim Petersdc5a5082002-03-09 04:58:24 +0000497/* Py_ADJUST_ERANGE1(x)
498 * Py_ADJUST_ERANGE2(x, y)
499 * Set errno to 0 before calling a libm function, and invoke one of these
500 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
501 * for functions returning complex results). This makes two kinds of
502 * adjustments to errno: (A) If it looks like the platform libm set
503 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
504 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
505 * effect, we're trying to force a useful implementation of C89 errno
506 * behavior.
507 * Caution:
508 * This isn't reliable. See Py_OVERFLOWED comments.
509 * X and Y may be evaluated more than once.
510 */
511#define Py_ADJUST_ERANGE1(X) \
512 do { \
513 if (errno == 0) { \
514 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
515 errno = ERANGE; \
516 } \
517 else if (errno == ERANGE && (X) == 0.0) \
518 errno = 0; \
519 } while(0)
520
521#define Py_ADJUST_ERANGE2(X, Y) \
522 do { \
523 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
524 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
525 if (errno == 0) \
526 errno = ERANGE; \
527 } \
528 else if (errno == ERANGE) \
529 errno = 0; \
530 } while(0)
531
Neal Norwitz80292642002-12-19 15:12:26 +0000532/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000533 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000534 * Usage:
535 * extern int old_var Py_DEPRECATED(2.3);
536 * typedef int T1 Py_DEPRECATED(2.4);
537 * extern int x() Py_DEPRECATED(2.5);
538 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000539#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
540 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000541#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
542#else
Tim Peters4643bd92002-12-28 21:56:08 +0000543#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000544#endif
545
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000546/**************************************************************************
547Prototypes that are missing from the standard include files on some systems
548(and possibly only some versions of such systems.)
549
550Please be conservative with adding new ones, document them and enclose them
551in platform-specific #ifdefs.
552**************************************************************************/
553
554#ifdef SOLARIS
555/* Unchecked */
556extern int gethostname(char *, int);
557#endif
558
559#ifdef __BEOS__
560/* Unchecked */
561/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000562int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000563#endif
564
565#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000566#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000567extern char * _getpty(int *, int, mode_t, int);
568#endif
569
570#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
571#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
572/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
573 functions, even though they are included in libutil. */
574#include <termios.h>
575extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
576extern int forkpty(int *, char *, struct termios *, struct winsize *);
577#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
578#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
579
580
581/* These are pulled from various places. It isn't obvious on what platforms
582 they are necessary, nor what the exact prototype should look like (which
583 is likely to vary between platforms!) If you find you need one of these
584 declarations, please move them to a platform-specific block and include
585 proper prototypes. */
586#if 0
587
588/* From Modules/resource.c */
589extern int getrusage();
590extern int getpagesize();
591
592/* From Python/sysmodule.c and Modules/posixmodule.c */
593extern int fclose(FILE *);
594
595/* From Modules/posixmodule.c */
596extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000597#endif /* 0 */
598
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000599
600/************************
601 * WRAPPER FOR <math.h> *
602 ************************/
603
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000604#ifndef HAVE_HYPOT
605extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000606#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000607
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000608
Hye-Shik Changf3032612006-03-22 08:52:43 +0000609/* On 4.4BSD-descendants, ctype functions serves the whole range of
610 * wchar_t character set rather than single byte code points only.
611 * This characteristic can break some operations of string object
612 * including str.upper() and str.split() on UTF-8 locales. This
613 * workaround was provided by Tim Robbins of FreeBSD project.
614 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000615
616#ifdef __FreeBSD__
617#include <osreldate.h>
618#if __FreeBSD_version > 500039
619#include <ctype.h>
620#include <wctype.h>
621#undef isalnum
622#define isalnum(c) iswalnum(btowc(c))
623#undef isalpha
624#define isalpha(c) iswalpha(btowc(c))
625#undef islower
626#define islower(c) iswlower(btowc(c))
627#undef isspace
628#define isspace(c) iswspace(btowc(c))
629#undef isupper
630#define isupper(c) iswupper(btowc(c))
631#undef tolower
632#define tolower(c) towlower(btowc(c))
633#undef toupper
634#define toupper(c) towupper(btowc(c))
635#endif
636#endif
637
638
Mark Hammond8235ea12002-07-19 06:55:41 +0000639/* Declarations for symbol visibility.
640
641 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000642 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000643 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000644 inside the Python core, they are private to the core.
645 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000646 external linkage depending on the platform.
647
648 As a number of platforms support/require "__declspec(dllimport/dllexport)",
649 we support a HAVE_DECLSPEC_DLL macro to save duplication.
650*/
651
Tim Peters4643bd92002-12-28 21:56:08 +0000652/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000653 All windows ports, except cygwin, are handled in PC/pyconfig.h.
654
655 BeOS and cygwin are the only other autoconf platform requiring special
656 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000657*/
658#if defined(__CYGWIN__) || defined(__BEOS__)
659# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000660#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000661
Jason Tishler30765592003-09-04 11:04:06 +0000662/* only get special linkage if built as shared or platform is Cygwin */
663#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000664# if defined(HAVE_DECLSPEC_DLL)
665# ifdef Py_BUILD_CORE
666# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000667# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000668 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000669 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
670# if defined(__CYGWIN__)
671# define PyMODINIT_FUNC __declspec(dllexport) void
672# else /* __CYGWIN__ */
673# define PyMODINIT_FUNC void
674# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000675# else /* Py_BUILD_CORE */
676 /* Building an extension module, or an embedded situation */
677 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000678 /* Under Cygwin, auto-import functions to prevent compilation */
679 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
680# if !defined(__CYGWIN__)
681# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
682# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000683# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000684 /* module init functions outside the core must be exported */
685# if defined(__cplusplus)
686# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
687# else /* __cplusplus */
688# define PyMODINIT_FUNC __declspec(dllexport) void
689# endif /* __cplusplus */
690# endif /* Py_BUILD_CORE */
691# endif /* HAVE_DECLSPEC */
692#endif /* Py_ENABLE_SHARED */
693
694/* If no external linkage macros defined by now, create defaults */
695#ifndef PyAPI_FUNC
696# define PyAPI_FUNC(RTYPE) RTYPE
697#endif
698#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000699# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000700#endif
701#ifndef PyMODINIT_FUNC
702# if defined(__cplusplus)
703# define PyMODINIT_FUNC extern "C" void
704# else /* __cplusplus */
705# define PyMODINIT_FUNC void
706# endif /* __cplusplus */
707#endif
708
709/* Deprecated DL_IMPORT and DL_EXPORT macros */
710#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
711# if defined(Py_BUILD_CORE)
712# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
713# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
714# else
715# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
716# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
717# endif
718#endif
719#ifndef DL_EXPORT
720# define DL_EXPORT(RTYPE) RTYPE
721#endif
722#ifndef DL_IMPORT
723# define DL_IMPORT(RTYPE) RTYPE
724#endif
725/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000726
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000727/* If the fd manipulation macros aren't defined,
728 here is a set that should do the job */
729
Guido van Rossum367e46a2000-08-01 18:28:44 +0000730#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000731
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000732#ifndef FD_SETSIZE
733#define FD_SETSIZE 256
734#endif
735
736#ifndef FD_SET
737
738typedef long fd_mask;
739
740#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
741#ifndef howmany
742#define howmany(x, y) (((x)+((y)-1))/(y))
743#endif /* howmany */
744
745typedef struct fd_set {
746 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
747} fd_set;
748
749#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
750#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
751#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
752#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
753
754#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000755
756#endif /* fd manipulation macros */
757
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000758
Fred Draked5fadf72000-09-26 05:46:01 +0000759/* limits.h constants that may be missing */
760
761#ifndef INT_MAX
762#define INT_MAX 2147483647
763#endif
764
765#ifndef LONG_MAX
766#if SIZEOF_LONG == 4
767#define LONG_MAX 0X7FFFFFFFL
768#elif SIZEOF_LONG == 8
769#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
770#else
771#error "could not set LONG_MAX in pyport.h"
772#endif
773#endif
774
775#ifndef LONG_MIN
776#define LONG_MIN (-LONG_MAX-1)
777#endif
778
Tim Petersd57731f2000-10-05 01:42:25 +0000779#ifndef LONG_BIT
780#define LONG_BIT (8 * SIZEOF_LONG)
781#endif
782
783#if LONG_BIT != 8 * SIZEOF_LONG
784/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
785 * 32-bit platforms using gcc. We try to catch that here at compile-time
786 * rather than waiting for integer multiplication to trigger bogus
787 * overflows.
788 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000789#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000790#endif
791
Tim Peters7d3a5112000-07-08 04:17:21 +0000792#ifdef __cplusplus
793}
794#endif
795
Neil Schemenauer15691082001-10-23 02:20:37 +0000796/*
797 * Hide GCC attributes from compilers that don't support them.
798 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000799#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000800 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000801 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000802#define Py_GCC_ATTRIBUTE(x)
803#else
804#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000805#endif
806
Martin v. Löwisaac13162006-10-19 10:58:46 +0000807/*
808 * Add PyArg_ParseTuple format where available.
809 */
810#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
811#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
812#else
813#define Py_FORMAT_PARSETUPLE(func,p1,p2)
814#endif
815
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000816/* Eliminate end-of-loop code not reached warnings from SunPro C
817 * when using do{...}while(0) macros
818 */
819#ifdef __SUNPRO_C
820#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
821#endif
822
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000823/*
824 * Older Microsoft compilers don't support the C99 long long literal suffixes,
825 * so these will be defined in PC/pyconfig.h for those compilers.
826 */
827#ifndef Py_LL
828#define Py_LL(x) x##LL
829#endif
830
831#ifndef Py_ULL
832#define Py_ULL(x) Py_LL(x##U)
833#endif
834
Tim Peters7d3a5112000-07-08 04:17:21 +0000835#endif /* Py_PYPORT_H */