blob: 7f8a02724094802070ff9de6eb2bfd64fcd887a8 [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öwis33bb6102006-10-02 15:24:01 +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öwis390240d2007-06-09 12:57:46 +000064#if defined(LLONG_MAX)
Martin v. Löwis22768852007-06-09 08:01:33 +000065#define PY_LLONG_MIN LLONG_MIN
66#define PY_LLONG_MAX LLONG_MAX
67#define PY_ULLONG_MAX ULLONG_MAX
Martin v. Löwis390240d2007-06-09 12:57:46 +000068#elif defined(__s390__)
69/* Apparently, S390 Linux has long long, but no LLONG_MAX */
70#define PY_LLONG_MAX 9223372036854775807LL
71#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
72#define PY_ULLONG_MAX 18446744073709551615ULL
73#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000074#endif
75#endif /* HAVE_LONG_LONG */
76
77/* uintptr_t is the C9X name for an unsigned integral type such that a
78 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000079 * without loss of information. Similarly for intptr_t, wrt a signed
80 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000081 */
82#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000083typedef uintptr_t Py_uintptr_t;
84typedef intptr_t Py_intptr_t;
85
Barry Warsawfd847b22000-08-18 04:48:18 +000086#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000087typedef unsigned int Py_uintptr_t;
88typedef int Py_intptr_t;
89
Barry Warsawfd847b22000-08-18 04:48:18 +000090#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000091typedef unsigned long Py_uintptr_t;
92typedef long Py_intptr_t;
93
Barry Warsawfd847b22000-08-18 04:48:18 +000094#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000095typedef unsigned PY_LONG_LONG Py_uintptr_t;
96typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000097
Barry Warsawfd847b22000-08-18 04:48:18 +000098#else
99# error "Python needs a typedef for Py_uintptr_t in pyport.h."
100#endif /* HAVE_UINTPTR_T */
101
Tim Petersae1d0c92006-03-17 03:29:34 +0000102/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
103 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
104 * unsigned integral type). See PEP 353 for details.
105 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000106#ifdef HAVE_SSIZE_T
107typedef ssize_t Py_ssize_t;
108#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000109typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000110#else
111# error "Python needs a typedef for Py_ssize_t in pyport.h."
112#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000113
114/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000115#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000116/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000117#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000118
Tim Petersae1d0c92006-03-17 03:29:34 +0000119/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
120 * format to convert an argument with the width of a size_t or Py_ssize_t.
121 * C99 introduced "z" for this purpose, but not all platforms support that;
122 * e.g., MS compilers use "I" instead.
123 *
124 * These "high level" Python format functions interpret "z" correctly on
125 * all platforms (Python interprets the format string itself, and does whatever
126 * the platform C requires to convert a size_t/Py_ssize_t argument):
127 *
128 * PyString_FromFormat
129 * PyErr_Format
130 * PyString_FromFormatV
131 *
132 * Lower-level uses require that you interpolate the correct format modifier
133 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
134 * example,
135 *
136 * Py_ssize_t index;
137 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
138 *
139 * That will expand to %ld, or %Id, or to something else correct for a
140 * Py_ssize_t on the platform.
141 */
142#ifndef PY_FORMAT_SIZE_T
Georg Brandl934c90d2006-09-25 06:58:00 +0000143# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Anthony Baxterc7403ed2006-04-01 01:08:29 +0000144# define PY_FORMAT_SIZE_T ""
145# elif SIZEOF_SIZE_T == SIZEOF_LONG
Tim Petersae1d0c92006-03-17 03:29:34 +0000146# define PY_FORMAT_SIZE_T "l"
147# elif defined(MS_WINDOWS)
148# define PY_FORMAT_SIZE_T "I"
149# else
150# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
151# endif
152#endif
153
Fredrik Lundh7a830892006-05-27 10:39:48 +0000154/* Py_LOCAL can be used instead of static to get the fastest possible calling
155 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000156 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000157 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
158 * for platforms that support that.
159 *
160 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
161 * "aggressive" inlining/optimizaion is enabled for the entire module. This
162 * may lead to code bloat, and may slow things down for those reasons. It may
163 * also lead to errors, if the code relies on pointer aliasing. Use with
164 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000165 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000166 * NOTE: You can only use this for functions that are entirely local to a
167 * module; functions that are exported via method tables, callbacks, etc,
168 * should keep using static.
169 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000170
171#undef USE_INLINE /* XXX - set via configure? */
172
173#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000174#if defined(PY_LOCAL_AGGRESSIVE)
175/* enable more aggressive optimization for visual studio */
176#pragma optimize("agtw", on)
177#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000178/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000179#pragma warning(disable: 4710)
180/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000181#define Py_LOCAL(type) static type __fastcall
182#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000183#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000184#define Py_LOCAL(type) static type
185#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000186#else
187#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000188#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000189#endif
190
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000191/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
192 * are often very short. While most platforms have highly optimized code for
193 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
194 * solves this by doing short copies "in line".
195 */
196
197#if defined(_MSC_VER)
198#define Py_MEMCPY(target, source, length) do { \
199 size_t i_, n_ = (length); \
200 char *t_ = (void*) (target); \
201 const char *s_ = (void*) (source); \
202 if (n_ >= 16) \
203 memcpy(t_, s_, n_); \
204 else \
205 for (i_ = 0; i_ < n_; i_++) \
206 t_[i_] = s_[i_]; \
207 } while (0)
208#else
209#define Py_MEMCPY memcpy
210#endif
211
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000212#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000213
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000214#include <math.h> /* Moved here from the math section, before extern "C" */
215
216/********************************************
217 * WRAPPER FOR <time.h> and/or <sys/time.h> *
218 ********************************************/
219
220#ifdef TIME_WITH_SYS_TIME
221#include <sys/time.h>
222#include <time.h>
223#else /* !TIME_WITH_SYS_TIME */
224#ifdef HAVE_SYS_TIME_H
225#include <sys/time.h>
226#else /* !HAVE_SYS_TIME_H */
227#include <time.h>
228#endif /* !HAVE_SYS_TIME_H */
229#endif /* !TIME_WITH_SYS_TIME */
230
231
232/******************************
233 * WRAPPER FOR <sys/select.h> *
234 ******************************/
235
236/* NB caller must include <sys/types.h> */
237
238#ifdef HAVE_SYS_SELECT_H
239
240#include <sys/select.h>
241
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000242#endif /* !HAVE_SYS_SELECT_H */
243
Tim Peters60f42b52001-01-18 03:03:16 +0000244/*******************************
245 * stat() and fstat() fiddling *
246 *******************************/
247
248/* We expect that stat and fstat exist on most systems.
249 * It's confirmed on Unix, Mac and Windows.
250 * If you don't have them, add
251 * #define DONT_HAVE_STAT
252 * and/or
253 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000254 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000255 * HAVE_FSTAT instead.
256 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000257 * #define HAVE_SYS_STAT_H
258 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000259 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000260 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000261 */
262#ifndef DONT_HAVE_STAT
263#define HAVE_STAT
264#endif
265
266#ifndef DONT_HAVE_FSTAT
267#define HAVE_FSTAT
268#endif
269
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000270#ifdef RISCOS
271#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000272#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000273#endif
274
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000275#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000276#if defined(PYOS_OS2) && defined(PYCC_GCC)
277#include <sys/types.h>
278#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000279#include <sys/stat.h>
280#elif defined(HAVE_STAT_H)
281#include <stat.h>
282#endif
283
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000284#if defined(PYCC_VACPP)
285/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
286#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
287#endif
288
289#ifndef S_ISREG
290#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
291#endif
292
293#ifndef S_ISDIR
294#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
295#endif
296
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000297
Tim Peters7d3a5112000-07-08 04:17:21 +0000298#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000299/* Move this down here since some C++ #include's don't like to be included
300 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000301extern "C" {
302#endif
303
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000304
Tim Peters7d3a5112000-07-08 04:17:21 +0000305/* Py_ARITHMETIC_RIGHT_SHIFT
306 * C doesn't define whether a right-shift of a signed integer sign-extends
307 * or zero-fills. Here a macro to force sign extension:
308 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
309 * Return I >> J, forcing sign extension.
310 * Requirements:
311 * I is of basic signed type TYPE (char, short, int, long, or long long).
312 * TYPE is one of char, short, int, long, or long long, although long long
313 * must not be used except on platforms that support it.
314 * J is an integer >= 0 and strictly less than the number of bits in TYPE
315 * (because C doesn't define what happens for J outside that range either).
316 * Caution:
317 * I may be evaluated more than once.
318 */
319#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
320#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
321 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
322#else
323#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
324#endif
325
Tim Peters39dce292000-08-15 03:34:48 +0000326/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000327 * "Simply" returns its argument. However, macro expansions within the
328 * argument are evaluated. This unfortunate trickery is needed to get
329 * token-pasting to work as desired in some cases.
330 */
331#define Py_FORCE_EXPANSION(X) X
332
Tim Peters8315ea52000-07-23 19:28:35 +0000333/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
334 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
335 * assert-fails if any information is lost.
336 * Caution:
337 * VALUE may be evaluated more than once.
338 */
339#ifdef Py_DEBUG
340#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
341 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
342#else
343#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
344#endif
345
Tim Peters862f0592004-09-23 19:11:32 +0000346/* Py_IS_NAN(X)
347 * Return 1 if float or double arg is a NaN, else 0.
348 * Caution:
349 * X is evaluated more than once.
350 * This may not work on all platforms. Each platform has *some*
351 * way to spell this, though -- override in pyconfig.h if you have
352 * a platform where it doesn't work.
353 */
354#ifndef Py_IS_NAN
355#define Py_IS_NAN(X) ((X) != (X))
356#endif
357
Tim Peters39dce292000-08-15 03:34:48 +0000358/* Py_IS_INFINITY(X)
359 * Return 1 if float or double arg is an infinity, else 0.
360 * Caution:
361 * X is evaluated more than once.
362 * This implementation may set the underflow flag if |X| is very small;
363 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000364 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000365 */
Tim Peters862f0592004-09-23 19:11:32 +0000366#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000367#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000368#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000369
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000370/* Py_IS_FINITE(X)
371 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
372 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000373 * macro for this particular test is useful
374 */
375#ifndef Py_IS_FINITE
376#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
377#endif
378
Tim Peters1de41bf2002-07-03 03:31:20 +0000379/* HUGE_VAL is supposed to expand to a positive double infinity. Python
380 * uses Py_HUGE_VAL instead because some platforms are broken in this
381 * respect. We used to embed code in pyport.h to try to worm around that,
382 * but different platforms are broken in conflicting ways. If you're on
383 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
384 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000385 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000386#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000387#define Py_HUGE_VAL HUGE_VAL
388#endif
389
Tim Peters57f282a2001-09-05 05:38:10 +0000390/* Py_OVERFLOWED(X)
391 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
392 * a libm function, and invoke this macro after, passing the function
393 * result.
394 * Caution:
395 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000396 * any exceptional condition, but does require +- HUGE_VAL return
397 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
398 * double infinity, and we're cool if that's so, unless the input
399 * was an infinity and an infinity is the expected result. A C89
400 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000401 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
402 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
403 * in non-overflow cases.
404 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000405 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000406 *
407 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000408 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000409 * should be removed once a newer compiler is available on that platform.
410 * The system that had the failure was running OpenBSD 3.2 on Intel, with
411 * gcc 2.95.3.
412 *
Tim Peters862f0592004-09-23 19:11:32 +0000413 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000414 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000415 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000416#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000417#define Py_OVERFLOWED(X) isinf(X)
418#else
Tim Petersa40c7932001-09-05 22:36:56 +0000419#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
420 (X) == Py_HUGE_VAL || \
421 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000422#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000423
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000424/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000425 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000426 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
427 * to 0 before calling a libm function, and invoke this macro after,
428 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000429 * Caution:
430 * This isn't reliable. See Py_OVERFLOWED comments.
431 * X is evaluated more than once.
432 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000433#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000434#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
435#else
436#define _Py_SET_EDOM_FOR_NAN(X) ;
437#endif
438#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000439 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000440 if (errno == 0) { \
441 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
442 errno = ERANGE; \
443 else _Py_SET_EDOM_FOR_NAN(X) \
444 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000445 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000446
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000447/* Py_SET_ERANGE_ON_OVERFLOW(x)
448 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
449 */
450#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
451
Tim Petersdc5a5082002-03-09 04:58:24 +0000452/* Py_ADJUST_ERANGE1(x)
453 * Py_ADJUST_ERANGE2(x, y)
454 * Set errno to 0 before calling a libm function, and invoke one of these
455 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
456 * for functions returning complex results). This makes two kinds of
457 * adjustments to errno: (A) If it looks like the platform libm set
458 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
459 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
460 * effect, we're trying to force a useful implementation of C89 errno
461 * behavior.
462 * Caution:
463 * This isn't reliable. See Py_OVERFLOWED comments.
464 * X and Y may be evaluated more than once.
465 */
466#define Py_ADJUST_ERANGE1(X) \
467 do { \
468 if (errno == 0) { \
469 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
470 errno = ERANGE; \
471 } \
472 else if (errno == ERANGE && (X) == 0.0) \
473 errno = 0; \
474 } while(0)
475
476#define Py_ADJUST_ERANGE2(X, Y) \
477 do { \
478 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
479 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
480 if (errno == 0) \
481 errno = ERANGE; \
482 } \
483 else if (errno == ERANGE) \
484 errno = 0; \
485 } while(0)
486
Neal Norwitz80292642002-12-19 15:12:26 +0000487/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000488 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000489 * Usage:
490 * extern int old_var Py_DEPRECATED(2.3);
491 * typedef int T1 Py_DEPRECATED(2.4);
492 * extern int x() Py_DEPRECATED(2.5);
493 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000494#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
495 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000496#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
497#else
Tim Peters4643bd92002-12-28 21:56:08 +0000498#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000499#endif
500
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000501/**************************************************************************
502Prototypes that are missing from the standard include files on some systems
503(and possibly only some versions of such systems.)
504
505Please be conservative with adding new ones, document them and enclose them
506in platform-specific #ifdefs.
507**************************************************************************/
508
509#ifdef SOLARIS
510/* Unchecked */
511extern int gethostname(char *, int);
512#endif
513
514#ifdef __BEOS__
515/* Unchecked */
516/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000517int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000518#endif
519
520#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000521#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000522extern char * _getpty(int *, int, mode_t, int);
523#endif
524
525#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
526#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
527/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
528 functions, even though they are included in libutil. */
529#include <termios.h>
530extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
531extern int forkpty(int *, char *, struct termios *, struct winsize *);
532#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
533#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
534
535
536/* These are pulled from various places. It isn't obvious on what platforms
537 they are necessary, nor what the exact prototype should look like (which
538 is likely to vary between platforms!) If you find you need one of these
539 declarations, please move them to a platform-specific block and include
540 proper prototypes. */
541#if 0
542
543/* From Modules/resource.c */
544extern int getrusage();
545extern int getpagesize();
546
547/* From Python/sysmodule.c and Modules/posixmodule.c */
548extern int fclose(FILE *);
549
550/* From Modules/posixmodule.c */
551extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000552#endif /* 0 */
553
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000554
555/************************
556 * WRAPPER FOR <math.h> *
557 ************************/
558
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000559#ifndef HAVE_HYPOT
560extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000561#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000562
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000563
Hye-Shik Changf3032612006-03-22 08:52:43 +0000564/* On 4.4BSD-descendants, ctype functions serves the whole range of
565 * wchar_t character set rather than single byte code points only.
566 * This characteristic can break some operations of string object
567 * including str.upper() and str.split() on UTF-8 locales. This
568 * workaround was provided by Tim Robbins of FreeBSD project.
569 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000570
571#ifdef __FreeBSD__
572#include <osreldate.h>
573#if __FreeBSD_version > 500039
574#include <ctype.h>
575#include <wctype.h>
576#undef isalnum
577#define isalnum(c) iswalnum(btowc(c))
578#undef isalpha
579#define isalpha(c) iswalpha(btowc(c))
580#undef islower
581#define islower(c) iswlower(btowc(c))
582#undef isspace
583#define isspace(c) iswspace(btowc(c))
584#undef isupper
585#define isupper(c) iswupper(btowc(c))
586#undef tolower
587#define tolower(c) towlower(btowc(c))
588#undef toupper
589#define toupper(c) towupper(btowc(c))
590#endif
591#endif
592
593
Mark Hammond8235ea12002-07-19 06:55:41 +0000594/* Declarations for symbol visibility.
595
596 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000597 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000598 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000599 inside the Python core, they are private to the core.
600 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000601 external linkage depending on the platform.
602
603 As a number of platforms support/require "__declspec(dllimport/dllexport)",
604 we support a HAVE_DECLSPEC_DLL macro to save duplication.
605*/
606
Tim Peters4643bd92002-12-28 21:56:08 +0000607/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000608 All windows ports, except cygwin, are handled in PC/pyconfig.h.
609
610 BeOS and cygwin are the only other autoconf platform requiring special
611 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000612*/
613#if defined(__CYGWIN__) || defined(__BEOS__)
614# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000615#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000616
Jason Tishler30765592003-09-04 11:04:06 +0000617/* only get special linkage if built as shared or platform is Cygwin */
618#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000619# if defined(HAVE_DECLSPEC_DLL)
620# ifdef Py_BUILD_CORE
621# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000622# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000623 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000624 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
625# if defined(__CYGWIN__)
626# define PyMODINIT_FUNC __declspec(dllexport) void
627# else /* __CYGWIN__ */
628# define PyMODINIT_FUNC void
629# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000630# else /* Py_BUILD_CORE */
631 /* Building an extension module, or an embedded situation */
632 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000633 /* Under Cygwin, auto-import functions to prevent compilation */
634 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
635# if !defined(__CYGWIN__)
636# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
637# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000638# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000639 /* module init functions outside the core must be exported */
640# if defined(__cplusplus)
641# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
642# else /* __cplusplus */
643# define PyMODINIT_FUNC __declspec(dllexport) void
644# endif /* __cplusplus */
645# endif /* Py_BUILD_CORE */
646# endif /* HAVE_DECLSPEC */
647#endif /* Py_ENABLE_SHARED */
648
649/* If no external linkage macros defined by now, create defaults */
650#ifndef PyAPI_FUNC
651# define PyAPI_FUNC(RTYPE) RTYPE
652#endif
653#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000654# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000655#endif
656#ifndef PyMODINIT_FUNC
657# if defined(__cplusplus)
658# define PyMODINIT_FUNC extern "C" void
659# else /* __cplusplus */
660# define PyMODINIT_FUNC void
661# endif /* __cplusplus */
662#endif
663
664/* Deprecated DL_IMPORT and DL_EXPORT macros */
665#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
666# if defined(Py_BUILD_CORE)
667# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
668# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
669# else
670# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
671# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
672# endif
673#endif
674#ifndef DL_EXPORT
675# define DL_EXPORT(RTYPE) RTYPE
676#endif
677#ifndef DL_IMPORT
678# define DL_IMPORT(RTYPE) RTYPE
679#endif
680/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000681
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000682/* If the fd manipulation macros aren't defined,
683 here is a set that should do the job */
684
Guido van Rossum367e46a2000-08-01 18:28:44 +0000685#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000686
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000687#ifndef FD_SETSIZE
688#define FD_SETSIZE 256
689#endif
690
691#ifndef FD_SET
692
693typedef long fd_mask;
694
695#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
696#ifndef howmany
697#define howmany(x, y) (((x)+((y)-1))/(y))
698#endif /* howmany */
699
700typedef struct fd_set {
701 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
702} fd_set;
703
704#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
705#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
706#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
707#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
708
709#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000710
711#endif /* fd manipulation macros */
712
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000713
Fred Draked5fadf72000-09-26 05:46:01 +0000714/* limits.h constants that may be missing */
715
716#ifndef INT_MAX
717#define INT_MAX 2147483647
718#endif
719
720#ifndef LONG_MAX
721#if SIZEOF_LONG == 4
722#define LONG_MAX 0X7FFFFFFFL
723#elif SIZEOF_LONG == 8
724#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
725#else
726#error "could not set LONG_MAX in pyport.h"
727#endif
728#endif
729
730#ifndef LONG_MIN
731#define LONG_MIN (-LONG_MAX-1)
732#endif
733
Tim Petersd57731f2000-10-05 01:42:25 +0000734#ifndef LONG_BIT
735#define LONG_BIT (8 * SIZEOF_LONG)
736#endif
737
738#if LONG_BIT != 8 * SIZEOF_LONG
739/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
740 * 32-bit platforms using gcc. We try to catch that here at compile-time
741 * rather than waiting for integer multiplication to trigger bogus
742 * overflows.
743 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000744#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000745#endif
746
Tim Peters7d3a5112000-07-08 04:17:21 +0000747#ifdef __cplusplus
748}
749#endif
750
Neil Schemenauer15691082001-10-23 02:20:37 +0000751/*
752 * Hide GCC attributes from compilers that don't support them.
753 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000754#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000755 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000756 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000757#define Py_GCC_ATTRIBUTE(x)
758#else
759#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000760#endif
761
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000762/* Eliminate end-of-loop code not reached warnings from SunPro C
763 * when using do{...}while(0) macros
764 */
765#ifdef __SUNPRO_C
766#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
767#endif
768
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000769/*
770 * Older Microsoft compilers don't support the C99 long long literal suffixes,
771 * so these will be defined in PC/pyconfig.h for those compilers.
772 */
773#ifndef Py_LL
774#define Py_LL(x) x##LL
775#endif
776
777#ifndef Py_ULL
778#define Py_ULL(x) Py_LL(x##U)
779#endif
780
Tim Peters7d3a5112000-07-08 04:17:21 +0000781#endif /* Py_PYPORT_H */