blob: ce760d2bf04cf93f425f65581073886013c13c60 [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
Christian Heimes951cc0f2008-01-31 23:08:23 +0000125#if SIZEOF_PID_T > SIZEOF_LONG
126# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
127#endif
128
Tim Petersae1d0c92006-03-17 03:29:34 +0000129/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
130 * format to convert an argument with the width of a size_t or Py_ssize_t.
131 * C99 introduced "z" for this purpose, but not all platforms support that;
132 * e.g., MS compilers use "I" instead.
133 *
134 * These "high level" Python format functions interpret "z" correctly on
135 * all platforms (Python interprets the format string itself, and does whatever
136 * the platform C requires to convert a size_t/Py_ssize_t argument):
137 *
138 * PyString_FromFormat
139 * PyErr_Format
140 * PyString_FromFormatV
141 *
142 * Lower-level uses require that you interpolate the correct format modifier
143 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
144 * example,
145 *
146 * Py_ssize_t index;
147 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
148 *
149 * That will expand to %ld, or %Id, or to something else correct for a
150 * Py_ssize_t on the platform.
151 */
152#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000153# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000154# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000155# elif SIZEOF_SIZE_T == SIZEOF_LONG
156# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000157# elif defined(MS_WINDOWS)
158# define PY_FORMAT_SIZE_T "I"
159# else
160# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
161# endif
162#endif
163
Fredrik Lundh7a830892006-05-27 10:39:48 +0000164/* Py_LOCAL can be used instead of static to get the fastest possible calling
165 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000166 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000167 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
168 * for platforms that support that.
169 *
170 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
171 * "aggressive" inlining/optimizaion is enabled for the entire module. This
172 * may lead to code bloat, and may slow things down for those reasons. It may
173 * also lead to errors, if the code relies on pointer aliasing. Use with
174 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000175 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000176 * NOTE: You can only use this for functions that are entirely local to a
177 * module; functions that are exported via method tables, callbacks, etc,
178 * should keep using static.
179 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000180
181#undef USE_INLINE /* XXX - set via configure? */
182
183#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000184#if defined(PY_LOCAL_AGGRESSIVE)
185/* enable more aggressive optimization for visual studio */
186#pragma optimize("agtw", on)
187#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000188/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000189#pragma warning(disable: 4710)
190/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000191#define Py_LOCAL(type) static type __fastcall
192#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000193#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000194#define Py_LOCAL(type) static type
195#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000196#else
197#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000198#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000199#endif
200
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000201/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
202 * are often very short. While most platforms have highly optimized code for
203 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
204 * solves this by doing short copies "in line".
205 */
206
207#if defined(_MSC_VER)
208#define Py_MEMCPY(target, source, length) do { \
209 size_t i_, n_ = (length); \
210 char *t_ = (void*) (target); \
211 const char *s_ = (void*) (source); \
212 if (n_ >= 16) \
213 memcpy(t_, s_, n_); \
214 else \
215 for (i_ = 0; i_ < n_; i_++) \
216 t_[i_] = s_[i_]; \
217 } while (0)
218#else
219#define Py_MEMCPY memcpy
220#endif
221
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000222#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000223
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000224#include <math.h> /* Moved here from the math section, before extern "C" */
225
226/********************************************
227 * WRAPPER FOR <time.h> and/or <sys/time.h> *
228 ********************************************/
229
230#ifdef TIME_WITH_SYS_TIME
231#include <sys/time.h>
232#include <time.h>
233#else /* !TIME_WITH_SYS_TIME */
234#ifdef HAVE_SYS_TIME_H
235#include <sys/time.h>
236#else /* !HAVE_SYS_TIME_H */
237#include <time.h>
238#endif /* !HAVE_SYS_TIME_H */
239#endif /* !TIME_WITH_SYS_TIME */
240
241
242/******************************
243 * WRAPPER FOR <sys/select.h> *
244 ******************************/
245
246/* NB caller must include <sys/types.h> */
247
248#ifdef HAVE_SYS_SELECT_H
249
250#include <sys/select.h>
251
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000252#endif /* !HAVE_SYS_SELECT_H */
253
Tim Peters60f42b52001-01-18 03:03:16 +0000254/*******************************
255 * stat() and fstat() fiddling *
256 *******************************/
257
258/* We expect that stat and fstat exist on most systems.
259 * It's confirmed on Unix, Mac and Windows.
260 * If you don't have them, add
261 * #define DONT_HAVE_STAT
262 * and/or
263 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000264 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000265 * HAVE_FSTAT instead.
266 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000267 * #define HAVE_SYS_STAT_H
268 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000269 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000270 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000271 */
272#ifndef DONT_HAVE_STAT
273#define HAVE_STAT
274#endif
275
276#ifndef DONT_HAVE_FSTAT
277#define HAVE_FSTAT
278#endif
279
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000280#ifdef RISCOS
281#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000282#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000283#endif
284
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000285#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000286#if defined(PYOS_OS2) && defined(PYCC_GCC)
287#include <sys/types.h>
288#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000289#include <sys/stat.h>
290#elif defined(HAVE_STAT_H)
291#include <stat.h>
292#endif
293
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000294#if defined(PYCC_VACPP)
295/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
296#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
297#endif
298
299#ifndef S_ISREG
300#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
301#endif
302
303#ifndef S_ISDIR
304#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
305#endif
306
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000307
Tim Peters7d3a5112000-07-08 04:17:21 +0000308#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000309/* Move this down here since some C++ #include's don't like to be included
310 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000311extern "C" {
312#endif
313
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000314
Tim Peters7d3a5112000-07-08 04:17:21 +0000315/* Py_ARITHMETIC_RIGHT_SHIFT
316 * C doesn't define whether a right-shift of a signed integer sign-extends
317 * or zero-fills. Here a macro to force sign extension:
318 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
319 * Return I >> J, forcing sign extension.
320 * Requirements:
321 * I is of basic signed type TYPE (char, short, int, long, or long long).
322 * TYPE is one of char, short, int, long, or long long, although long long
323 * must not be used except on platforms that support it.
324 * J is an integer >= 0 and strictly less than the number of bits in TYPE
325 * (because C doesn't define what happens for J outside that range either).
326 * Caution:
327 * I may be evaluated more than once.
328 */
329#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
330#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
331 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
332#else
333#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
334#endif
335
Tim Peters39dce292000-08-15 03:34:48 +0000336/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000337 * "Simply" returns its argument. However, macro expansions within the
338 * argument are evaluated. This unfortunate trickery is needed to get
339 * token-pasting to work as desired in some cases.
340 */
341#define Py_FORCE_EXPANSION(X) X
342
Tim Peters8315ea52000-07-23 19:28:35 +0000343/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
344 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
345 * assert-fails if any information is lost.
346 * Caution:
347 * VALUE may be evaluated more than once.
348 */
349#ifdef Py_DEBUG
350#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
351 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
352#else
353#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
354#endif
355
Christian Heimes0a8143f2007-12-18 23:22:54 +0000356/* High precision defintion of pi and e (Euler)
357 * The values are taken from libc6's math.h.
358 */
Christian Heimes0a83d792008-01-03 21:14:48 +0000359#ifndef Py_MATH_PIl
360#define Py_MATH_PIl 3.1415926535897932384626433832795029L
361#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000362#ifndef Py_MATH_PI
Christian Heimes0a83d792008-01-03 21:14:48 +0000363#define Py_MATH_PI 3.14159265358979323846
364#endif
365
366#ifndef Py_MATH_El
367#define Py_MATH_El 2.7182818284590452353602874713526625L
Christian Heimes0a8143f2007-12-18 23:22:54 +0000368#endif
369
370#ifndef Py_MATH_E
Christian Heimes0a83d792008-01-03 21:14:48 +0000371#define Py_MATH_E 2.7182818284590452354
Christian Heimes0a8143f2007-12-18 23:22:54 +0000372#endif
373
Tim Peters862f0592004-09-23 19:11:32 +0000374/* Py_IS_NAN(X)
375 * Return 1 if float or double arg is a NaN, else 0.
376 * Caution:
377 * X is evaluated more than once.
378 * This may not work on all platforms. Each platform has *some*
379 * way to spell this, though -- override in pyconfig.h if you have
380 * a platform where it doesn't work.
381 */
382#ifndef Py_IS_NAN
Christian Heimes0a8143f2007-12-18 23:22:54 +0000383#ifdef HAVE_ISNAN
384#define Py_IS_NAN(X) isnan(X)
385#else
Tim Peters862f0592004-09-23 19:11:32 +0000386#define Py_IS_NAN(X) ((X) != (X))
387#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000388#endif
Tim Peters862f0592004-09-23 19:11:32 +0000389
Tim Peters39dce292000-08-15 03:34:48 +0000390/* Py_IS_INFINITY(X)
391 * Return 1 if float or double arg is an infinity, else 0.
392 * Caution:
393 * X is evaluated more than once.
394 * This implementation may set the underflow flag if |X| is very small;
395 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000396 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000397 */
Tim Peters862f0592004-09-23 19:11:32 +0000398#ifndef Py_IS_INFINITY
Christian Heimes0a8143f2007-12-18 23:22:54 +0000399#ifdef HAVE_ISINF
400#define Py_IS_INFINITY(X) isinf(X)
401#else
Tim Peters1a2eefd2000-09-08 15:45:34 +0000402#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000403#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000404#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000405
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000406/* Py_IS_FINITE(X)
407 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
408 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000409 * macro for this particular test is useful
410 */
411#ifndef Py_IS_FINITE
Christian Heimes48723512008-01-20 14:28:28 +0000412#ifdef HAVE_FINITE
Christian Heimes690c9122008-01-22 15:01:25 +0000413#define Py_IS_FINITE(X) finite(X)
Christian Heimes0a8143f2007-12-18 23:22:54 +0000414#else
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000415#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
416#endif
Christian Heimes0a8143f2007-12-18 23:22:54 +0000417#endif
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000418
Tim Peters1de41bf2002-07-03 03:31:20 +0000419/* HUGE_VAL is supposed to expand to a positive double infinity. Python
420 * uses Py_HUGE_VAL instead because some platforms are broken in this
421 * respect. We used to embed code in pyport.h to try to worm around that,
422 * but different platforms are broken in conflicting ways. If you're on
423 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
424 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000425 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000426#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000427#define Py_HUGE_VAL HUGE_VAL
428#endif
429
Christian Heimes0a8143f2007-12-18 23:22:54 +0000430/* Py_NAN
431 * A value that evaluates to a NaN. On IEEE 754 platforms INF*0 or
432 * INF/INF works. Define Py_NO_NAN in pyconfig.h if your platform
433 * doesn't support NaNs.
434 */
435#if !defined(Py_NAN) && !defined(Py_NO_NAN)
436#define Py_NAN (Py_HUGE_VAL * 0.)
437#endif
438
Tim Peters57f282a2001-09-05 05:38:10 +0000439/* Py_OVERFLOWED(X)
440 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
441 * a libm function, and invoke this macro after, passing the function
442 * result.
443 * Caution:
444 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000445 * any exceptional condition, but does require +- HUGE_VAL return
446 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
447 * double infinity, and we're cool if that's so, unless the input
448 * was an infinity and an infinity is the expected result. A C89
449 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000450 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
451 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
452 * in non-overflow cases.
453 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000454 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000455 *
456 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000457 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000458 * should be removed once a newer compiler is available on that platform.
459 * The system that had the failure was running OpenBSD 3.2 on Intel, with
460 * gcc 2.95.3.
461 *
Tim Peters862f0592004-09-23 19:11:32 +0000462 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000463 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000464 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000465#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000466#define Py_OVERFLOWED(X) isinf(X)
467#else
Tim Petersa40c7932001-09-05 22:36:56 +0000468#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
469 (X) == Py_HUGE_VAL || \
470 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000471#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000472
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000473/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000474 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000475 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
476 * to 0 before calling a libm function, and invoke this macro after,
477 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000478 * Caution:
479 * This isn't reliable. See Py_OVERFLOWED comments.
480 * X is evaluated more than once.
481 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000482#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000483#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
484#else
485#define _Py_SET_EDOM_FOR_NAN(X) ;
486#endif
487#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000488 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000489 if (errno == 0) { \
490 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
491 errno = ERANGE; \
492 else _Py_SET_EDOM_FOR_NAN(X) \
493 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000494 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000495
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000496/* Py_SET_ERANGE_ON_OVERFLOW(x)
497 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
498 */
499#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
500
Tim Petersdc5a5082002-03-09 04:58:24 +0000501/* Py_ADJUST_ERANGE1(x)
502 * Py_ADJUST_ERANGE2(x, y)
503 * Set errno to 0 before calling a libm function, and invoke one of these
504 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
505 * for functions returning complex results). This makes two kinds of
506 * adjustments to errno: (A) If it looks like the platform libm set
507 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
508 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
509 * effect, we're trying to force a useful implementation of C89 errno
510 * behavior.
511 * Caution:
512 * This isn't reliable. See Py_OVERFLOWED comments.
513 * X and Y may be evaluated more than once.
514 */
515#define Py_ADJUST_ERANGE1(X) \
516 do { \
517 if (errno == 0) { \
518 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
519 errno = ERANGE; \
520 } \
521 else if (errno == ERANGE && (X) == 0.0) \
522 errno = 0; \
523 } while(0)
524
525#define Py_ADJUST_ERANGE2(X, Y) \
526 do { \
527 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
528 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
529 if (errno == 0) \
530 errno = ERANGE; \
531 } \
532 else if (errno == ERANGE) \
533 errno = 0; \
534 } while(0)
535
Neal Norwitz80292642002-12-19 15:12:26 +0000536/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000537 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000538 * Usage:
539 * extern int old_var Py_DEPRECATED(2.3);
540 * typedef int T1 Py_DEPRECATED(2.4);
541 * extern int x() Py_DEPRECATED(2.5);
542 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000543#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
544 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000545#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
546#else
Tim Peters4643bd92002-12-28 21:56:08 +0000547#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000548#endif
549
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000550/**************************************************************************
551Prototypes that are missing from the standard include files on some systems
552(and possibly only some versions of such systems.)
553
554Please be conservative with adding new ones, document them and enclose them
555in platform-specific #ifdefs.
556**************************************************************************/
557
558#ifdef SOLARIS
559/* Unchecked */
560extern int gethostname(char *, int);
561#endif
562
563#ifdef __BEOS__
564/* Unchecked */
565/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000566int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000567#endif
568
569#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000570#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000571extern char * _getpty(int *, int, mode_t, int);
572#endif
573
574#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
575#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
576/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
577 functions, even though they are included in libutil. */
578#include <termios.h>
579extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes951cc0f2008-01-31 23:08:23 +0000580extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000581#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
582#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
583
584
585/* These are pulled from various places. It isn't obvious on what platforms
586 they are necessary, nor what the exact prototype should look like (which
587 is likely to vary between platforms!) If you find you need one of these
588 declarations, please move them to a platform-specific block and include
589 proper prototypes. */
590#if 0
591
592/* From Modules/resource.c */
593extern int getrusage();
594extern int getpagesize();
595
596/* From Python/sysmodule.c and Modules/posixmodule.c */
597extern int fclose(FILE *);
598
599/* From Modules/posixmodule.c */
600extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000601#endif /* 0 */
602
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000603
604/************************
605 * WRAPPER FOR <math.h> *
606 ************************/
607
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000608#ifndef HAVE_HYPOT
609extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000610#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000611
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000612
Hye-Shik Changf3032612006-03-22 08:52:43 +0000613/* On 4.4BSD-descendants, ctype functions serves the whole range of
614 * wchar_t character set rather than single byte code points only.
615 * This characteristic can break some operations of string object
616 * including str.upper() and str.split() on UTF-8 locales. This
617 * workaround was provided by Tim Robbins of FreeBSD project.
618 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000619
620#ifdef __FreeBSD__
621#include <osreldate.h>
622#if __FreeBSD_version > 500039
623#include <ctype.h>
624#include <wctype.h>
625#undef isalnum
626#define isalnum(c) iswalnum(btowc(c))
627#undef isalpha
628#define isalpha(c) iswalpha(btowc(c))
629#undef islower
630#define islower(c) iswlower(btowc(c))
631#undef isspace
632#define isspace(c) iswspace(btowc(c))
633#undef isupper
634#define isupper(c) iswupper(btowc(c))
635#undef tolower
636#define tolower(c) towlower(btowc(c))
637#undef toupper
638#define toupper(c) towupper(btowc(c))
639#endif
640#endif
641
642
Mark Hammond8235ea12002-07-19 06:55:41 +0000643/* Declarations for symbol visibility.
644
645 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000646 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000647 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000648 inside the Python core, they are private to the core.
649 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000650 external linkage depending on the platform.
651
652 As a number of platforms support/require "__declspec(dllimport/dllexport)",
653 we support a HAVE_DECLSPEC_DLL macro to save duplication.
654*/
655
Tim Peters4643bd92002-12-28 21:56:08 +0000656/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000657 All windows ports, except cygwin, are handled in PC/pyconfig.h.
658
659 BeOS and cygwin are the only other autoconf platform requiring special
660 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000661*/
662#if defined(__CYGWIN__) || defined(__BEOS__)
663# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000664#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000665
Jason Tishler30765592003-09-04 11:04:06 +0000666/* only get special linkage if built as shared or platform is Cygwin */
667#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000668# if defined(HAVE_DECLSPEC_DLL)
669# ifdef Py_BUILD_CORE
670# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000671# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000672 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000673 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
674# if defined(__CYGWIN__)
675# define PyMODINIT_FUNC __declspec(dllexport) void
676# else /* __CYGWIN__ */
677# define PyMODINIT_FUNC void
678# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000679# else /* Py_BUILD_CORE */
680 /* Building an extension module, or an embedded situation */
681 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000682 /* Under Cygwin, auto-import functions to prevent compilation */
683 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
684# if !defined(__CYGWIN__)
685# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
686# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000687# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000688 /* module init functions outside the core must be exported */
689# if defined(__cplusplus)
690# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
691# else /* __cplusplus */
692# define PyMODINIT_FUNC __declspec(dllexport) void
693# endif /* __cplusplus */
694# endif /* Py_BUILD_CORE */
695# endif /* HAVE_DECLSPEC */
696#endif /* Py_ENABLE_SHARED */
697
698/* If no external linkage macros defined by now, create defaults */
699#ifndef PyAPI_FUNC
700# define PyAPI_FUNC(RTYPE) RTYPE
701#endif
702#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000703# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000704#endif
705#ifndef PyMODINIT_FUNC
706# if defined(__cplusplus)
707# define PyMODINIT_FUNC extern "C" void
708# else /* __cplusplus */
709# define PyMODINIT_FUNC void
710# endif /* __cplusplus */
711#endif
712
713/* Deprecated DL_IMPORT and DL_EXPORT macros */
714#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
715# if defined(Py_BUILD_CORE)
716# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
717# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
718# else
719# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
720# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
721# endif
722#endif
723#ifndef DL_EXPORT
724# define DL_EXPORT(RTYPE) RTYPE
725#endif
726#ifndef DL_IMPORT
727# define DL_IMPORT(RTYPE) RTYPE
728#endif
729/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000730
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000731/* If the fd manipulation macros aren't defined,
732 here is a set that should do the job */
733
Guido van Rossum367e46a2000-08-01 18:28:44 +0000734#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000735
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000736#ifndef FD_SETSIZE
737#define FD_SETSIZE 256
738#endif
739
740#ifndef FD_SET
741
742typedef long fd_mask;
743
744#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
745#ifndef howmany
746#define howmany(x, y) (((x)+((y)-1))/(y))
747#endif /* howmany */
748
749typedef struct fd_set {
750 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
751} fd_set;
752
753#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
754#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
755#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
756#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
757
758#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000759
760#endif /* fd manipulation macros */
761
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000762
Fred Draked5fadf72000-09-26 05:46:01 +0000763/* limits.h constants that may be missing */
764
765#ifndef INT_MAX
766#define INT_MAX 2147483647
767#endif
768
769#ifndef LONG_MAX
770#if SIZEOF_LONG == 4
771#define LONG_MAX 0X7FFFFFFFL
772#elif SIZEOF_LONG == 8
773#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
774#else
775#error "could not set LONG_MAX in pyport.h"
776#endif
777#endif
778
779#ifndef LONG_MIN
780#define LONG_MIN (-LONG_MAX-1)
781#endif
782
Tim Petersd57731f2000-10-05 01:42:25 +0000783#ifndef LONG_BIT
784#define LONG_BIT (8 * SIZEOF_LONG)
785#endif
786
787#if LONG_BIT != 8 * SIZEOF_LONG
788/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
789 * 32-bit platforms using gcc. We try to catch that here at compile-time
790 * rather than waiting for integer multiplication to trigger bogus
791 * overflows.
792 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000793#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000794#endif
795
Tim Peters7d3a5112000-07-08 04:17:21 +0000796#ifdef __cplusplus
797}
798#endif
799
Neil Schemenauer15691082001-10-23 02:20:37 +0000800/*
801 * Hide GCC attributes from compilers that don't support them.
802 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000803#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000804 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000805 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000806#define Py_GCC_ATTRIBUTE(x)
807#else
808#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000809#endif
810
Martin v. Löwisaac13162006-10-19 10:58:46 +0000811/*
812 * Add PyArg_ParseTuple format where available.
813 */
814#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
815#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
816#else
817#define Py_FORMAT_PARSETUPLE(func,p1,p2)
818#endif
819
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000820/* Eliminate end-of-loop code not reached warnings from SunPro C
821 * when using do{...}while(0) macros
822 */
823#ifdef __SUNPRO_C
824#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
825#endif
826
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000827/*
828 * Older Microsoft compilers don't support the C99 long long literal suffixes,
829 * so these will be defined in PC/pyconfig.h for those compilers.
830 */
831#ifndef Py_LL
832#define Py_LL(x) x##LL
833#endif
834
835#ifndef Py_ULL
836#define Py_ULL(x) Py_LL(x##U)
837#endif
838
Tim Peters7d3a5112000-07-08 04:17:21 +0000839#endif /* Py_PYPORT_H */