blob: 92ce3aec5e665618e79c5cd01dd0406491b29c2f [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
Thomas Wouters89f507f2006-12-13 04:49:30 +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
Barry Warsawfd847b22000-08-18 04:48:18 +000038/* typedefs for some C9X-defined synonyms for integral types.
39 *
40 * The names in Python are exactly the same as the C9X names, except with a
41 * Py_ prefix. Until C9X is universally implemented, this is the only way
42 * to ensure that Python gets reliable names that don't conflict with names
43 * in non-Python code that are playing their own tricks to define the C9X
44 * names.
45 *
46 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
47 * integral synonyms. Only define the ones we actually need.
48 */
49
50#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000051#ifndef PY_LONG_LONG
52#define PY_LONG_LONG long long
Barry Warsawfd847b22000-08-18 04:48:18 +000053#endif
54#endif /* HAVE_LONG_LONG */
55
56/* uintptr_t is the C9X name for an unsigned integral type such that a
57 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000058 * without loss of information. Similarly for intptr_t, wrt a signed
59 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000060 */
61#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000062typedef uintptr_t Py_uintptr_t;
63typedef intptr_t Py_intptr_t;
64
Barry Warsawfd847b22000-08-18 04:48:18 +000065#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000066typedef unsigned int Py_uintptr_t;
67typedef int Py_intptr_t;
68
Barry Warsawfd847b22000-08-18 04:48:18 +000069#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000070typedef unsigned long Py_uintptr_t;
71typedef long Py_intptr_t;
72
Barry Warsawfd847b22000-08-18 04:48:18 +000073#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000074typedef unsigned PY_LONG_LONG Py_uintptr_t;
75typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000076
Barry Warsawfd847b22000-08-18 04:48:18 +000077#else
78# error "Python needs a typedef for Py_uintptr_t in pyport.h."
79#endif /* HAVE_UINTPTR_T */
80
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000081/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
82 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
83 * unsigned integral type). See PEP 353 for details.
84 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000085#ifdef HAVE_SSIZE_T
86typedef ssize_t Py_ssize_t;
87#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +000088typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000089#else
90# error "Python needs a typedef for Py_ssize_t in pyport.h."
91#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000092
93/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +000094#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000095/* Smallest negative value of type Py_ssize_t. */
96#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
97
98/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
99 * format to convert an argument with the width of a size_t or Py_ssize_t.
100 * C99 introduced "z" for this purpose, but not all platforms support that;
101 * e.g., MS compilers use "I" instead.
102 *
103 * These "high level" Python format functions interpret "z" correctly on
104 * all platforms (Python interprets the format string itself, and does whatever
105 * the platform C requires to convert a size_t/Py_ssize_t argument):
106 *
107 * PyString_FromFormat
108 * PyErr_Format
109 * PyString_FromFormatV
Walter Dörwald7696ed72007-05-31 15:51:35 +0000110 * PyUnicode_FromFormatV
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000111 *
112 * Lower-level uses require that you interpolate the correct format modifier
113 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
114 * example,
115 *
116 * Py_ssize_t index;
117 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
118 *
119 * That will expand to %ld, or %Id, or to something else correct for a
120 * Py_ssize_t on the platform.
121 */
122#ifndef PY_FORMAT_SIZE_T
Thomas Wouters89f507f2006-12-13 04:49:30 +0000123# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000124# define PY_FORMAT_SIZE_T ""
125# elif SIZEOF_SIZE_T == SIZEOF_LONG
126# define PY_FORMAT_SIZE_T "l"
127# elif defined(MS_WINDOWS)
128# define PY_FORMAT_SIZE_T "I"
129# else
130# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
131# endif
132#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000133
Thomas Wouters477c8d52006-05-27 19:21:47 +0000134/* Py_LOCAL can be used instead of static to get the fastest possible calling
135 * convention for functions that are local to a given module.
136 *
137 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
138 * for platforms that support that.
139 *
140 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
141 * "aggressive" inlining/optimizaion is enabled for the entire module. This
142 * may lead to code bloat, and may slow things down for those reasons. It may
143 * also lead to errors, if the code relies on pointer aliasing. Use with
144 * care.
145 *
146 * NOTE: You can only use this for functions that are entirely local to a
147 * module; functions that are exported via method tables, callbacks, etc,
148 * should keep using static.
149 */
150
151#undef USE_INLINE /* XXX - set via configure? */
152
153#if defined(_MSC_VER)
154#if defined(PY_LOCAL_AGGRESSIVE)
155/* enable more aggressive optimization for visual studio */
156#pragma optimize("agtw", on)
157#endif
158/* ignore warnings if the compiler decides not to inline a function */
159#pragma warning(disable: 4710)
160/* fastest possible local call under MSVC */
161#define Py_LOCAL(type) static type __fastcall
162#define Py_LOCAL_INLINE(type) static __inline type __fastcall
163#elif defined(USE_INLINE)
164#define Py_LOCAL(type) static type
165#define Py_LOCAL_INLINE(type) static inline type
166#else
167#define Py_LOCAL(type) static type
168#define Py_LOCAL_INLINE(type) static type
169#endif
170
Thomas Wouters4d70c3d2006-06-08 14:42:34 +0000171/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
172 * are often very short. While most platforms have highly optimized code for
173 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
174 * solves this by doing short copies "in line".
175 */
176
177#if defined(_MSC_VER)
178#define Py_MEMCPY(target, source, length) do { \
179 size_t i_, n_ = (length); \
180 char *t_ = (void*) (target); \
181 const char *s_ = (void*) (source); \
182 if (n_ >= 16) \
183 memcpy(t_, s_, n_); \
184 else \
185 for (i_ = 0; i_ < n_; i_++) \
186 t_[i_] = s_[i_]; \
187 } while (0)
188#else
189#define Py_MEMCPY memcpy
190#endif
191
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000192#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000193
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000194#include <math.h> /* Moved here from the math section, before extern "C" */
195
196/********************************************
197 * WRAPPER FOR <time.h> and/or <sys/time.h> *
198 ********************************************/
199
200#ifdef TIME_WITH_SYS_TIME
201#include <sys/time.h>
202#include <time.h>
203#else /* !TIME_WITH_SYS_TIME */
204#ifdef HAVE_SYS_TIME_H
205#include <sys/time.h>
206#else /* !HAVE_SYS_TIME_H */
207#include <time.h>
208#endif /* !HAVE_SYS_TIME_H */
209#endif /* !TIME_WITH_SYS_TIME */
210
211
212/******************************
213 * WRAPPER FOR <sys/select.h> *
214 ******************************/
215
216/* NB caller must include <sys/types.h> */
217
218#ifdef HAVE_SYS_SELECT_H
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000219#include <sys/select.h>
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000220#endif /* !HAVE_SYS_SELECT_H */
221
Tim Peters60f42b52001-01-18 03:03:16 +0000222/*******************************
223 * stat() and fstat() fiddling *
224 *******************************/
225
226/* We expect that stat and fstat exist on most systems.
227 * It's confirmed on Unix, Mac and Windows.
228 * If you don't have them, add
229 * #define DONT_HAVE_STAT
230 * and/or
231 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000232 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000233 * HAVE_FSTAT instead.
234 * Also
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000235 * #define HAVE_SYS_STAT_H
236 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000237 * #define HAVE_STAT_H
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000238 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000239 */
240#ifndef DONT_HAVE_STAT
241#define HAVE_STAT
242#endif
243
244#ifndef DONT_HAVE_FSTAT
245#define HAVE_FSTAT
246#endif
247
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000248#ifdef RISCOS
249#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000250#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000251#endif
252
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000253#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000254#if defined(PYOS_OS2) && defined(PYCC_GCC)
255#include <sys/types.h>
256#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000257#include <sys/stat.h>
258#elif defined(HAVE_STAT_H)
259#include <stat.h>
260#endif
261
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000262#if defined(PYCC_VACPP)
263/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
264#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
265#endif
266
267#ifndef S_ISREG
268#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
269#endif
270
271#ifndef S_ISDIR
272#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
273#endif
274
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000275
Tim Peters7d3a5112000-07-08 04:17:21 +0000276#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000277/* Move this down here since some C++ #include's don't like to be included
278 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000279extern "C" {
280#endif
281
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000282
Tim Peters7d3a5112000-07-08 04:17:21 +0000283/* Py_ARITHMETIC_RIGHT_SHIFT
284 * C doesn't define whether a right-shift of a signed integer sign-extends
285 * or zero-fills. Here a macro to force sign extension:
286 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
287 * Return I >> J, forcing sign extension.
288 * Requirements:
289 * I is of basic signed type TYPE (char, short, int, long, or long long).
290 * TYPE is one of char, short, int, long, or long long, although long long
291 * must not be used except on platforms that support it.
292 * J is an integer >= 0 and strictly less than the number of bits in TYPE
293 * (because C doesn't define what happens for J outside that range either).
294 * Caution:
295 * I may be evaluated more than once.
296 */
297#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
298#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
299 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
300#else
301#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
302#endif
303
Tim Peters39dce292000-08-15 03:34:48 +0000304/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000305 * "Simply" returns its argument. However, macro expansions within the
306 * argument are evaluated. This unfortunate trickery is needed to get
307 * token-pasting to work as desired in some cases.
308 */
309#define Py_FORCE_EXPANSION(X) X
310
Tim Peters8315ea52000-07-23 19:28:35 +0000311/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
312 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
313 * assert-fails if any information is lost.
314 * Caution:
315 * VALUE may be evaluated more than once.
316 */
317#ifdef Py_DEBUG
318#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
319 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
320#else
321#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
322#endif
323
Tim Peters862f0592004-09-23 19:11:32 +0000324/* Py_IS_NAN(X)
325 * Return 1 if float or double arg is a NaN, else 0.
326 * Caution:
327 * X is evaluated more than once.
328 * This may not work on all platforms. Each platform has *some*
329 * way to spell this, though -- override in pyconfig.h if you have
330 * a platform where it doesn't work.
331 */
332#ifndef Py_IS_NAN
333#define Py_IS_NAN(X) ((X) != (X))
334#endif
335
Tim Peters39dce292000-08-15 03:34:48 +0000336/* Py_IS_INFINITY(X)
337 * Return 1 if float or double arg is an infinity, else 0.
338 * Caution:
339 * X is evaluated more than once.
340 * This implementation may set the underflow flag if |X| is very small;
341 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000342 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000343 */
Tim Peters862f0592004-09-23 19:11:32 +0000344#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000345#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000346#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000347
Thomas Wouters477c8d52006-05-27 19:21:47 +0000348/* Py_IS_FINITE(X)
349 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
350 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
351 * macro for this particular test is useful
352 */
353#ifndef Py_IS_FINITE
354#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
355#endif
356
Tim Peters1de41bf2002-07-03 03:31:20 +0000357/* HUGE_VAL is supposed to expand to a positive double infinity. Python
358 * uses Py_HUGE_VAL instead because some platforms are broken in this
359 * respect. We used to embed code in pyport.h to try to worm around that,
360 * but different platforms are broken in conflicting ways. If you're on
361 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
362 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000363 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000364#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000365#define Py_HUGE_VAL HUGE_VAL
366#endif
367
Tim Peters57f282a2001-09-05 05:38:10 +0000368/* Py_OVERFLOWED(X)
369 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
370 * a libm function, and invoke this macro after, passing the function
371 * result.
372 * Caution:
373 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000374 * any exceptional condition, but does require +- HUGE_VAL return
375 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
376 * double infinity, and we're cool if that's so, unless the input
377 * was an infinity and an infinity is the expected result. A C89
378 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000379 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
380 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
381 * in non-overflow cases.
382 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000383 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000384 *
385 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000386 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000387 * should be removed once a newer compiler is available on that platform.
388 * The system that had the failure was running OpenBSD 3.2 on Intel, with
389 * gcc 2.95.3.
390 *
Tim Peters862f0592004-09-23 19:11:32 +0000391 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000392 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000393 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000394#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000395#define Py_OVERFLOWED(X) isinf(X)
396#else
Tim Petersa40c7932001-09-05 22:36:56 +0000397#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
398 (X) == Py_HUGE_VAL || \
399 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000400#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000401
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000402/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000403 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000404 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
405 * to 0 before calling a libm function, and invoke this macro after,
406 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000407 * Caution:
408 * This isn't reliable. See Py_OVERFLOWED comments.
409 * X is evaluated more than once.
410 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000411#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000412#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
413#else
414#define _Py_SET_EDOM_FOR_NAN(X) ;
415#endif
416#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000417 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000418 if (errno == 0) { \
419 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
420 errno = ERANGE; \
421 else _Py_SET_EDOM_FOR_NAN(X) \
422 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000423 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000424
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000425/* Py_SET_ERANGE_ON_OVERFLOW(x)
426 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
427 */
428#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
429
Tim Petersdc5a5082002-03-09 04:58:24 +0000430/* Py_ADJUST_ERANGE1(x)
431 * Py_ADJUST_ERANGE2(x, y)
432 * Set errno to 0 before calling a libm function, and invoke one of these
433 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
434 * for functions returning complex results). This makes two kinds of
435 * adjustments to errno: (A) If it looks like the platform libm set
436 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
437 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
438 * effect, we're trying to force a useful implementation of C89 errno
439 * behavior.
440 * Caution:
441 * This isn't reliable. See Py_OVERFLOWED comments.
442 * X and Y may be evaluated more than once.
443 */
444#define Py_ADJUST_ERANGE1(X) \
445 do { \
446 if (errno == 0) { \
447 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
448 errno = ERANGE; \
449 } \
450 else if (errno == ERANGE && (X) == 0.0) \
451 errno = 0; \
452 } while(0)
453
454#define Py_ADJUST_ERANGE2(X, Y) \
455 do { \
456 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
457 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
458 if (errno == 0) \
459 errno = ERANGE; \
460 } \
461 else if (errno == ERANGE) \
462 errno = 0; \
463 } while(0)
464
Neal Norwitz80292642002-12-19 15:12:26 +0000465/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000466 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000467 * Usage:
468 * extern int old_var Py_DEPRECATED(2.3);
469 * typedef int T1 Py_DEPRECATED(2.4);
470 * extern int x() Py_DEPRECATED(2.5);
471 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000472#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
473 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000474#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
475#else
Tim Peters4643bd92002-12-28 21:56:08 +0000476#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000477#endif
478
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000479/**************************************************************************
480Prototypes that are missing from the standard include files on some systems
481(and possibly only some versions of such systems.)
482
483Please be conservative with adding new ones, document them and enclose them
484in platform-specific #ifdefs.
485**************************************************************************/
486
487#ifdef SOLARIS
488/* Unchecked */
489extern int gethostname(char *, int);
490#endif
491
492#ifdef __BEOS__
493/* Unchecked */
494/* It's in the libs, but not the headers... - [cjh] */
Neal Norwitzf6657e62006-12-28 04:47:50 +0000495int shutdown(int, int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000496#endif
497
498#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000499#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000500extern char * _getpty(int *, int, mode_t, int);
501#endif
502
503#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
504#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
505/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
506 functions, even though they are included in libutil. */
507#include <termios.h>
508extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
509extern int forkpty(int *, char *, struct termios *, struct winsize *);
510#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
511#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
512
513
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000514/************************
515 * WRAPPER FOR <math.h> *
516 ************************/
517
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000518#ifndef HAVE_HYPOT
519extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000520#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000521
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000522
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000523/* On 4.4BSD-descendants, ctype functions serves the whole range of
524 * wchar_t character set rather than single byte code points only.
525 * This characteristic can break some operations of string object
526 * including str.upper() and str.split() on UTF-8 locales. This
527 * workaround was provided by Tim Robbins of FreeBSD project.
528 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000529
530#ifdef __FreeBSD__
531#include <osreldate.h>
532#if __FreeBSD_version > 500039
533#include <ctype.h>
534#include <wctype.h>
535#undef isalnum
536#define isalnum(c) iswalnum(btowc(c))
537#undef isalpha
538#define isalpha(c) iswalpha(btowc(c))
539#undef islower
540#define islower(c) iswlower(btowc(c))
541#undef isspace
542#define isspace(c) iswspace(btowc(c))
543#undef isupper
544#define isupper(c) iswupper(btowc(c))
545#undef tolower
546#define tolower(c) towlower(btowc(c))
547#undef toupper
548#define toupper(c) towupper(btowc(c))
549#endif
550#endif
551
552
Mark Hammond8235ea12002-07-19 06:55:41 +0000553/* Declarations for symbol visibility.
554
555 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000556 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000557 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000558 inside the Python core, they are private to the core.
559 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000560 external linkage depending on the platform.
561
562 As a number of platforms support/require "__declspec(dllimport/dllexport)",
563 we support a HAVE_DECLSPEC_DLL macro to save duplication.
564*/
565
Tim Peters4643bd92002-12-28 21:56:08 +0000566/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000567 All windows ports, except cygwin, are handled in PC/pyconfig.h.
568
569 BeOS and cygwin are the only other autoconf platform requiring special
570 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000571*/
572#if defined(__CYGWIN__) || defined(__BEOS__)
573# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000574#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000575
Jason Tishler30765592003-09-04 11:04:06 +0000576/* only get special linkage if built as shared or platform is Cygwin */
577#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000578# if defined(HAVE_DECLSPEC_DLL)
579# ifdef Py_BUILD_CORE
580# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000581# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000582 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000583 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
584# if defined(__CYGWIN__)
585# define PyMODINIT_FUNC __declspec(dllexport) void
586# else /* __CYGWIN__ */
587# define PyMODINIT_FUNC void
588# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000589# else /* Py_BUILD_CORE */
590 /* Building an extension module, or an embedded situation */
591 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000592 /* Under Cygwin, auto-import functions to prevent compilation */
593 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
594# if !defined(__CYGWIN__)
595# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
596# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000597# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000598 /* module init functions outside the core must be exported */
599# if defined(__cplusplus)
600# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
601# else /* __cplusplus */
602# define PyMODINIT_FUNC __declspec(dllexport) void
603# endif /* __cplusplus */
604# endif /* Py_BUILD_CORE */
605# endif /* HAVE_DECLSPEC */
606#endif /* Py_ENABLE_SHARED */
607
608/* If no external linkage macros defined by now, create defaults */
609#ifndef PyAPI_FUNC
610# define PyAPI_FUNC(RTYPE) RTYPE
611#endif
612#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000613# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000614#endif
615#ifndef PyMODINIT_FUNC
616# if defined(__cplusplus)
617# define PyMODINIT_FUNC extern "C" void
618# else /* __cplusplus */
619# define PyMODINIT_FUNC void
620# endif /* __cplusplus */
621#endif
622
Fred Draked5fadf72000-09-26 05:46:01 +0000623/* limits.h constants that may be missing */
624
625#ifndef INT_MAX
626#define INT_MAX 2147483647
627#endif
628
629#ifndef LONG_MAX
630#if SIZEOF_LONG == 4
631#define LONG_MAX 0X7FFFFFFFL
632#elif SIZEOF_LONG == 8
633#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
634#else
635#error "could not set LONG_MAX in pyport.h"
636#endif
637#endif
638
639#ifndef LONG_MIN
640#define LONG_MIN (-LONG_MAX-1)
641#endif
642
Tim Petersd57731f2000-10-05 01:42:25 +0000643#ifndef LONG_BIT
644#define LONG_BIT (8 * SIZEOF_LONG)
645#endif
646
647#if LONG_BIT != 8 * SIZEOF_LONG
648/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
649 * 32-bit platforms using gcc. We try to catch that here at compile-time
650 * rather than waiting for integer multiplication to trigger bogus
651 * overflows.
652 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000653#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000654#endif
655
Tim Peters7d3a5112000-07-08 04:17:21 +0000656#ifdef __cplusplus
657}
658#endif
659
Neil Schemenauer15691082001-10-23 02:20:37 +0000660/*
661 * Hide GCC attributes from compilers that don't support them.
662 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000663#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000664 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000665 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000666#define Py_GCC_ATTRIBUTE(x)
667#else
668#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000669#endif
670
Thomas Wouters89f507f2006-12-13 04:49:30 +0000671/*
672 * Add PyArg_ParseTuple format where available.
673 */
674#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
675#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
676#else
677#define Py_FORMAT_PARSETUPLE(func,p1,p2)
678#endif
679
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000680/* Eliminate end-of-loop code not reached warnings from SunPro C
681 * when using do{...}while(0) macros
682 */
683#ifdef __SUNPRO_C
684#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
685#endif
686
Thomas Wouters477c8d52006-05-27 19:21:47 +0000687/*
688 * Older Microsoft compilers don't support the C99 long long literal suffixes,
689 * so these will be defined in PC/pyconfig.h for those compilers.
690 */
691#ifndef Py_LL
692#define Py_LL(x) x##LL
693#endif
694
695#ifndef Py_ULL
696#define Py_ULL(x) Py_LL(x##U)
697#endif
698
Tim Peters7d3a5112000-07-08 04:17:21 +0000699#endif /* Py_PYPORT_H */