blob: 2a2950634f067e91bb16dbfb8c50575473fee533 [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öwis6371cd82007-06-09 07:42:52 +000064#define PY_LLONG_MIN LLONG_MIN
65#define PY_LLONG_MAX LLONG_MAX
66#define PY_ULLONG_MAX ULLONG_MAX
Barry Warsawfd847b22000-08-18 04:48:18 +000067#endif
68#endif /* HAVE_LONG_LONG */
69
70/* uintptr_t is the C9X name for an unsigned integral type such that a
71 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000072 * without loss of information. Similarly for intptr_t, wrt a signed
73 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000074 */
75#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000076typedef uintptr_t Py_uintptr_t;
77typedef intptr_t Py_intptr_t;
78
Barry Warsawfd847b22000-08-18 04:48:18 +000079#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000080typedef unsigned int Py_uintptr_t;
81typedef int Py_intptr_t;
82
Barry Warsawfd847b22000-08-18 04:48:18 +000083#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000084typedef unsigned long Py_uintptr_t;
85typedef long Py_intptr_t;
86
Barry Warsawfd847b22000-08-18 04:48:18 +000087#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000088typedef unsigned PY_LONG_LONG Py_uintptr_t;
89typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000090
Barry Warsawfd847b22000-08-18 04:48:18 +000091#else
92# error "Python needs a typedef for Py_uintptr_t in pyport.h."
93#endif /* HAVE_UINTPTR_T */
94
Tim Petersae1d0c92006-03-17 03:29:34 +000095/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
96 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
97 * unsigned integral type). See PEP 353 for details.
98 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000099#ifdef HAVE_SSIZE_T
100typedef ssize_t Py_ssize_t;
101#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000102typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000103#else
104# error "Python needs a typedef for Py_ssize_t in pyport.h."
105#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000106
107/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000108#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000109/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000110#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111
Tim Petersae1d0c92006-03-17 03:29:34 +0000112/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
113 * format to convert an argument with the width of a size_t or Py_ssize_t.
114 * C99 introduced "z" for this purpose, but not all platforms support that;
115 * e.g., MS compilers use "I" instead.
116 *
117 * These "high level" Python format functions interpret "z" correctly on
118 * all platforms (Python interprets the format string itself, and does whatever
119 * the platform C requires to convert a size_t/Py_ssize_t argument):
120 *
121 * PyString_FromFormat
122 * PyErr_Format
123 * PyString_FromFormatV
124 *
125 * Lower-level uses require that you interpolate the correct format modifier
126 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
127 * example,
128 *
129 * Py_ssize_t index;
130 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
131 *
132 * That will expand to %ld, or %Id, or to something else correct for a
133 * Py_ssize_t on the platform.
134 */
135#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000136# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000137# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000138# elif SIZEOF_SIZE_T == SIZEOF_LONG
139# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000140# elif defined(MS_WINDOWS)
141# define PY_FORMAT_SIZE_T "I"
142# else
143# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
144# endif
145#endif
146
Fredrik Lundh7a830892006-05-27 10:39:48 +0000147/* Py_LOCAL can be used instead of static to get the fastest possible calling
148 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000149 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000150 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
151 * for platforms that support that.
152 *
153 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
154 * "aggressive" inlining/optimizaion is enabled for the entire module. This
155 * may lead to code bloat, and may slow things down for those reasons. It may
156 * also lead to errors, if the code relies on pointer aliasing. Use with
157 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000158 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000159 * NOTE: You can only use this for functions that are entirely local to a
160 * module; functions that are exported via method tables, callbacks, etc,
161 * should keep using static.
162 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000163
164#undef USE_INLINE /* XXX - set via configure? */
165
166#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000167#if defined(PY_LOCAL_AGGRESSIVE)
168/* enable more aggressive optimization for visual studio */
169#pragma optimize("agtw", on)
170#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000171/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000172#pragma warning(disable: 4710)
173/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000174#define Py_LOCAL(type) static type __fastcall
175#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000176#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000177#define Py_LOCAL(type) static type
178#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000179#else
180#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000181#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000182#endif
183
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000184/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
185 * are often very short. While most platforms have highly optimized code for
186 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
187 * solves this by doing short copies "in line".
188 */
189
190#if defined(_MSC_VER)
191#define Py_MEMCPY(target, source, length) do { \
192 size_t i_, n_ = (length); \
193 char *t_ = (void*) (target); \
194 const char *s_ = (void*) (source); \
195 if (n_ >= 16) \
196 memcpy(t_, s_, n_); \
197 else \
198 for (i_ = 0; i_ < n_; i_++) \
199 t_[i_] = s_[i_]; \
200 } while (0)
201#else
202#define Py_MEMCPY memcpy
203#endif
204
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000205#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000206
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000207#include <math.h> /* Moved here from the math section, before extern "C" */
208
209/********************************************
210 * WRAPPER FOR <time.h> and/or <sys/time.h> *
211 ********************************************/
212
213#ifdef TIME_WITH_SYS_TIME
214#include <sys/time.h>
215#include <time.h>
216#else /* !TIME_WITH_SYS_TIME */
217#ifdef HAVE_SYS_TIME_H
218#include <sys/time.h>
219#else /* !HAVE_SYS_TIME_H */
220#include <time.h>
221#endif /* !HAVE_SYS_TIME_H */
222#endif /* !TIME_WITH_SYS_TIME */
223
224
225/******************************
226 * WRAPPER FOR <sys/select.h> *
227 ******************************/
228
229/* NB caller must include <sys/types.h> */
230
231#ifdef HAVE_SYS_SELECT_H
232
233#include <sys/select.h>
234
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000235#endif /* !HAVE_SYS_SELECT_H */
236
Tim Peters60f42b52001-01-18 03:03:16 +0000237/*******************************
238 * stat() and fstat() fiddling *
239 *******************************/
240
241/* We expect that stat and fstat exist on most systems.
242 * It's confirmed on Unix, Mac and Windows.
243 * If you don't have them, add
244 * #define DONT_HAVE_STAT
245 * and/or
246 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000247 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000248 * HAVE_FSTAT instead.
249 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000250 * #define HAVE_SYS_STAT_H
251 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000252 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000253 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000254 */
255#ifndef DONT_HAVE_STAT
256#define HAVE_STAT
257#endif
258
259#ifndef DONT_HAVE_FSTAT
260#define HAVE_FSTAT
261#endif
262
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000263#ifdef RISCOS
264#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000265#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000266#endif
267
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000268#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000269#if defined(PYOS_OS2) && defined(PYCC_GCC)
270#include <sys/types.h>
271#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000272#include <sys/stat.h>
273#elif defined(HAVE_STAT_H)
274#include <stat.h>
275#endif
276
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000277#if defined(PYCC_VACPP)
278/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
279#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
280#endif
281
282#ifndef S_ISREG
283#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
284#endif
285
286#ifndef S_ISDIR
287#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
288#endif
289
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000290
Tim Peters7d3a5112000-07-08 04:17:21 +0000291#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000292/* Move this down here since some C++ #include's don't like to be included
293 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000294extern "C" {
295#endif
296
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000297
Tim Peters7d3a5112000-07-08 04:17:21 +0000298/* Py_ARITHMETIC_RIGHT_SHIFT
299 * C doesn't define whether a right-shift of a signed integer sign-extends
300 * or zero-fills. Here a macro to force sign extension:
301 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
302 * Return I >> J, forcing sign extension.
303 * Requirements:
304 * I is of basic signed type TYPE (char, short, int, long, or long long).
305 * TYPE is one of char, short, int, long, or long long, although long long
306 * must not be used except on platforms that support it.
307 * J is an integer >= 0 and strictly less than the number of bits in TYPE
308 * (because C doesn't define what happens for J outside that range either).
309 * Caution:
310 * I may be evaluated more than once.
311 */
312#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
313#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
314 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
315#else
316#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
317#endif
318
Tim Peters39dce292000-08-15 03:34:48 +0000319/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000320 * "Simply" returns its argument. However, macro expansions within the
321 * argument are evaluated. This unfortunate trickery is needed to get
322 * token-pasting to work as desired in some cases.
323 */
324#define Py_FORCE_EXPANSION(X) X
325
Tim Peters8315ea52000-07-23 19:28:35 +0000326/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
327 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
328 * assert-fails if any information is lost.
329 * Caution:
330 * VALUE may be evaluated more than once.
331 */
332#ifdef Py_DEBUG
333#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
334 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
335#else
336#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
337#endif
338
Tim Peters862f0592004-09-23 19:11:32 +0000339/* Py_IS_NAN(X)
340 * Return 1 if float or double arg is a NaN, else 0.
341 * Caution:
342 * X is evaluated more than once.
343 * This may not work on all platforms. Each platform has *some*
344 * way to spell this, though -- override in pyconfig.h if you have
345 * a platform where it doesn't work.
346 */
347#ifndef Py_IS_NAN
348#define Py_IS_NAN(X) ((X) != (X))
349#endif
350
Tim Peters39dce292000-08-15 03:34:48 +0000351/* Py_IS_INFINITY(X)
352 * Return 1 if float or double arg is an infinity, else 0.
353 * Caution:
354 * X is evaluated more than once.
355 * This implementation may set the underflow flag if |X| is very small;
356 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000357 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000358 */
Tim Peters862f0592004-09-23 19:11:32 +0000359#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000360#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000361#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000362
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000363/* Py_IS_FINITE(X)
364 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
365 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000366 * macro for this particular test is useful
367 */
368#ifndef Py_IS_FINITE
369#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
370#endif
371
Tim Peters1de41bf2002-07-03 03:31:20 +0000372/* HUGE_VAL is supposed to expand to a positive double infinity. Python
373 * uses Py_HUGE_VAL instead because some platforms are broken in this
374 * respect. We used to embed code in pyport.h to try to worm around that,
375 * but different platforms are broken in conflicting ways. If you're on
376 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
377 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000378 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000379#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000380#define Py_HUGE_VAL HUGE_VAL
381#endif
382
Tim Peters57f282a2001-09-05 05:38:10 +0000383/* Py_OVERFLOWED(X)
384 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
385 * a libm function, and invoke this macro after, passing the function
386 * result.
387 * Caution:
388 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000389 * any exceptional condition, but does require +- HUGE_VAL return
390 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
391 * double infinity, and we're cool if that's so, unless the input
392 * was an infinity and an infinity is the expected result. A C89
393 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000394 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
395 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
396 * in non-overflow cases.
397 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000398 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000399 *
400 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000401 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000402 * should be removed once a newer compiler is available on that platform.
403 * The system that had the failure was running OpenBSD 3.2 on Intel, with
404 * gcc 2.95.3.
405 *
Tim Peters862f0592004-09-23 19:11:32 +0000406 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000407 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000408 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000409#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000410#define Py_OVERFLOWED(X) isinf(X)
411#else
Tim Petersa40c7932001-09-05 22:36:56 +0000412#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
413 (X) == Py_HUGE_VAL || \
414 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000415#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000416
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000417/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000418 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000419 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
420 * to 0 before calling a libm function, and invoke this macro after,
421 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000422 * Caution:
423 * This isn't reliable. See Py_OVERFLOWED comments.
424 * X is evaluated more than once.
425 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000426#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000427#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
428#else
429#define _Py_SET_EDOM_FOR_NAN(X) ;
430#endif
431#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000432 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000433 if (errno == 0) { \
434 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
435 errno = ERANGE; \
436 else _Py_SET_EDOM_FOR_NAN(X) \
437 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000438 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000439
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000440/* Py_SET_ERANGE_ON_OVERFLOW(x)
441 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
442 */
443#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
444
Tim Petersdc5a5082002-03-09 04:58:24 +0000445/* Py_ADJUST_ERANGE1(x)
446 * Py_ADJUST_ERANGE2(x, y)
447 * Set errno to 0 before calling a libm function, and invoke one of these
448 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
449 * for functions returning complex results). This makes two kinds of
450 * adjustments to errno: (A) If it looks like the platform libm set
451 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
452 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
453 * effect, we're trying to force a useful implementation of C89 errno
454 * behavior.
455 * Caution:
456 * This isn't reliable. See Py_OVERFLOWED comments.
457 * X and Y may be evaluated more than once.
458 */
459#define Py_ADJUST_ERANGE1(X) \
460 do { \
461 if (errno == 0) { \
462 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
463 errno = ERANGE; \
464 } \
465 else if (errno == ERANGE && (X) == 0.0) \
466 errno = 0; \
467 } while(0)
468
469#define Py_ADJUST_ERANGE2(X, Y) \
470 do { \
471 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
472 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
473 if (errno == 0) \
474 errno = ERANGE; \
475 } \
476 else if (errno == ERANGE) \
477 errno = 0; \
478 } while(0)
479
Neal Norwitz80292642002-12-19 15:12:26 +0000480/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000481 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000482 * Usage:
483 * extern int old_var Py_DEPRECATED(2.3);
484 * typedef int T1 Py_DEPRECATED(2.4);
485 * extern int x() Py_DEPRECATED(2.5);
486 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000487#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
488 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000489#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
490#else
Tim Peters4643bd92002-12-28 21:56:08 +0000491#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000492#endif
493
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000494/**************************************************************************
495Prototypes that are missing from the standard include files on some systems
496(and possibly only some versions of such systems.)
497
498Please be conservative with adding new ones, document them and enclose them
499in platform-specific #ifdefs.
500**************************************************************************/
501
502#ifdef SOLARIS
503/* Unchecked */
504extern int gethostname(char *, int);
505#endif
506
507#ifdef __BEOS__
508/* Unchecked */
509/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000510int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000511#endif
512
513#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000514#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000515extern char * _getpty(int *, int, mode_t, int);
516#endif
517
518#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
519#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
520/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
521 functions, even though they are included in libutil. */
522#include <termios.h>
523extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
524extern int forkpty(int *, char *, struct termios *, struct winsize *);
525#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
526#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
527
528
529/* These are pulled from various places. It isn't obvious on what platforms
530 they are necessary, nor what the exact prototype should look like (which
531 is likely to vary between platforms!) If you find you need one of these
532 declarations, please move them to a platform-specific block and include
533 proper prototypes. */
534#if 0
535
536/* From Modules/resource.c */
537extern int getrusage();
538extern int getpagesize();
539
540/* From Python/sysmodule.c and Modules/posixmodule.c */
541extern int fclose(FILE *);
542
543/* From Modules/posixmodule.c */
544extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000545#endif /* 0 */
546
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000547
548/************************
549 * WRAPPER FOR <math.h> *
550 ************************/
551
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000552#ifndef HAVE_HYPOT
553extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000554#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000555
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000556
Hye-Shik Changf3032612006-03-22 08:52:43 +0000557/* On 4.4BSD-descendants, ctype functions serves the whole range of
558 * wchar_t character set rather than single byte code points only.
559 * This characteristic can break some operations of string object
560 * including str.upper() and str.split() on UTF-8 locales. This
561 * workaround was provided by Tim Robbins of FreeBSD project.
562 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000563
564#ifdef __FreeBSD__
565#include <osreldate.h>
566#if __FreeBSD_version > 500039
567#include <ctype.h>
568#include <wctype.h>
569#undef isalnum
570#define isalnum(c) iswalnum(btowc(c))
571#undef isalpha
572#define isalpha(c) iswalpha(btowc(c))
573#undef islower
574#define islower(c) iswlower(btowc(c))
575#undef isspace
576#define isspace(c) iswspace(btowc(c))
577#undef isupper
578#define isupper(c) iswupper(btowc(c))
579#undef tolower
580#define tolower(c) towlower(btowc(c))
581#undef toupper
582#define toupper(c) towupper(btowc(c))
583#endif
584#endif
585
586
Mark Hammond8235ea12002-07-19 06:55:41 +0000587/* Declarations for symbol visibility.
588
589 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000590 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000591 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000592 inside the Python core, they are private to the core.
593 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000594 external linkage depending on the platform.
595
596 As a number of platforms support/require "__declspec(dllimport/dllexport)",
597 we support a HAVE_DECLSPEC_DLL macro to save duplication.
598*/
599
Tim Peters4643bd92002-12-28 21:56:08 +0000600/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000601 All windows ports, except cygwin, are handled in PC/pyconfig.h.
602
603 BeOS and cygwin are the only other autoconf platform requiring special
604 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000605*/
606#if defined(__CYGWIN__) || defined(__BEOS__)
607# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000608#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000609
Jason Tishler30765592003-09-04 11:04:06 +0000610/* only get special linkage if built as shared or platform is Cygwin */
611#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000612# if defined(HAVE_DECLSPEC_DLL)
613# ifdef Py_BUILD_CORE
614# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000615# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000616 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000617 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
618# if defined(__CYGWIN__)
619# define PyMODINIT_FUNC __declspec(dllexport) void
620# else /* __CYGWIN__ */
621# define PyMODINIT_FUNC void
622# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000623# else /* Py_BUILD_CORE */
624 /* Building an extension module, or an embedded situation */
625 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000626 /* Under Cygwin, auto-import functions to prevent compilation */
627 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
628# if !defined(__CYGWIN__)
629# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
630# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000631# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000632 /* module init functions outside the core must be exported */
633# if defined(__cplusplus)
634# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
635# else /* __cplusplus */
636# define PyMODINIT_FUNC __declspec(dllexport) void
637# endif /* __cplusplus */
638# endif /* Py_BUILD_CORE */
639# endif /* HAVE_DECLSPEC */
640#endif /* Py_ENABLE_SHARED */
641
642/* If no external linkage macros defined by now, create defaults */
643#ifndef PyAPI_FUNC
644# define PyAPI_FUNC(RTYPE) RTYPE
645#endif
646#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000647# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000648#endif
649#ifndef PyMODINIT_FUNC
650# if defined(__cplusplus)
651# define PyMODINIT_FUNC extern "C" void
652# else /* __cplusplus */
653# define PyMODINIT_FUNC void
654# endif /* __cplusplus */
655#endif
656
657/* Deprecated DL_IMPORT and DL_EXPORT macros */
658#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
659# if defined(Py_BUILD_CORE)
660# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
661# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
662# else
663# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
664# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
665# endif
666#endif
667#ifndef DL_EXPORT
668# define DL_EXPORT(RTYPE) RTYPE
669#endif
670#ifndef DL_IMPORT
671# define DL_IMPORT(RTYPE) RTYPE
672#endif
673/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000674
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000675/* If the fd manipulation macros aren't defined,
676 here is a set that should do the job */
677
Guido van Rossum367e46a2000-08-01 18:28:44 +0000678#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000679
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000680#ifndef FD_SETSIZE
681#define FD_SETSIZE 256
682#endif
683
684#ifndef FD_SET
685
686typedef long fd_mask;
687
688#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
689#ifndef howmany
690#define howmany(x, y) (((x)+((y)-1))/(y))
691#endif /* howmany */
692
693typedef struct fd_set {
694 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
695} fd_set;
696
697#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
698#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
699#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
700#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
701
702#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000703
704#endif /* fd manipulation macros */
705
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000706
Fred Draked5fadf72000-09-26 05:46:01 +0000707/* limits.h constants that may be missing */
708
709#ifndef INT_MAX
710#define INT_MAX 2147483647
711#endif
712
713#ifndef LONG_MAX
714#if SIZEOF_LONG == 4
715#define LONG_MAX 0X7FFFFFFFL
716#elif SIZEOF_LONG == 8
717#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
718#else
719#error "could not set LONG_MAX in pyport.h"
720#endif
721#endif
722
723#ifndef LONG_MIN
724#define LONG_MIN (-LONG_MAX-1)
725#endif
726
Tim Petersd57731f2000-10-05 01:42:25 +0000727#ifndef LONG_BIT
728#define LONG_BIT (8 * SIZEOF_LONG)
729#endif
730
731#if LONG_BIT != 8 * SIZEOF_LONG
732/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
733 * 32-bit platforms using gcc. We try to catch that here at compile-time
734 * rather than waiting for integer multiplication to trigger bogus
735 * overflows.
736 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000737#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000738#endif
739
Tim Peters7d3a5112000-07-08 04:17:21 +0000740#ifdef __cplusplus
741}
742#endif
743
Neil Schemenauer15691082001-10-23 02:20:37 +0000744/*
745 * Hide GCC attributes from compilers that don't support them.
746 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000747#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000748 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000749 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000750#define Py_GCC_ATTRIBUTE(x)
751#else
752#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000753#endif
754
Martin v. Löwisaac13162006-10-19 10:58:46 +0000755/*
756 * Add PyArg_ParseTuple format where available.
757 */
758#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
759#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
760#else
761#define Py_FORMAT_PARSETUPLE(func,p1,p2)
762#endif
763
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000764/* Eliminate end-of-loop code not reached warnings from SunPro C
765 * when using do{...}while(0) macros
766 */
767#ifdef __SUNPRO_C
768#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
769#endif
770
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000771/*
772 * Older Microsoft compilers don't support the C99 long long literal suffixes,
773 * so these will be defined in PC/pyconfig.h for those compilers.
774 */
775#ifndef Py_LL
776#define Py_LL(x) x##LL
777#endif
778
779#ifndef Py_ULL
780#define Py_ULL(x) Py_LL(x##U)
781#endif
782
Tim Peters7d3a5112000-07-08 04:17:21 +0000783#endif /* Py_PYPORT_H */