blob: 36d517cd99dac61cf8cb132e0714d48aa8cb135c [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
Barry Warsawfd847b22000-08-18 04:48:18 +000064#endif
65#endif /* HAVE_LONG_LONG */
66
67/* uintptr_t is the C9X name for an unsigned integral type such that a
68 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000069 * without loss of information. Similarly for intptr_t, wrt a signed
70 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000071 */
72#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000073typedef uintptr_t Py_uintptr_t;
74typedef intptr_t Py_intptr_t;
75
Barry Warsawfd847b22000-08-18 04:48:18 +000076#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000077typedef unsigned int Py_uintptr_t;
78typedef int Py_intptr_t;
79
Barry Warsawfd847b22000-08-18 04:48:18 +000080#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000081typedef unsigned long Py_uintptr_t;
82typedef long Py_intptr_t;
83
Barry Warsawfd847b22000-08-18 04:48:18 +000084#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000085typedef unsigned PY_LONG_LONG Py_uintptr_t;
86typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000087
Barry Warsawfd847b22000-08-18 04:48:18 +000088#else
89# error "Python needs a typedef for Py_uintptr_t in pyport.h."
90#endif /* HAVE_UINTPTR_T */
91
Tim Petersae1d0c92006-03-17 03:29:34 +000092/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
93 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
94 * unsigned integral type). See PEP 353 for details.
95 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000096#ifdef HAVE_SSIZE_T
97typedef ssize_t Py_ssize_t;
98#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +000099typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000100#else
101# error "Python needs a typedef for Py_ssize_t in pyport.h."
102#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000103
104/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000106/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000107#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000108
Tim Petersae1d0c92006-03-17 03:29:34 +0000109/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
110 * format to convert an argument with the width of a size_t or Py_ssize_t.
111 * C99 introduced "z" for this purpose, but not all platforms support that;
112 * e.g., MS compilers use "I" instead.
113 *
114 * These "high level" Python format functions interpret "z" correctly on
115 * all platforms (Python interprets the format string itself, and does whatever
116 * the platform C requires to convert a size_t/Py_ssize_t argument):
117 *
118 * PyString_FromFormat
119 * PyErr_Format
120 * PyString_FromFormatV
121 *
122 * Lower-level uses require that you interpolate the correct format modifier
123 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
124 * example,
125 *
126 * Py_ssize_t index;
127 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
128 *
129 * That will expand to %ld, or %Id, or to something else correct for a
130 * Py_ssize_t on the platform.
131 */
132#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000133# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000134# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000135# elif SIZEOF_SIZE_T == SIZEOF_LONG
136# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000137# elif defined(MS_WINDOWS)
138# define PY_FORMAT_SIZE_T "I"
139# else
140# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
141# endif
142#endif
143
Fredrik Lundh7a830892006-05-27 10:39:48 +0000144/* Py_LOCAL can be used instead of static to get the fastest possible calling
145 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000146 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000147 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
148 * for platforms that support that.
149 *
150 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
151 * "aggressive" inlining/optimizaion is enabled for the entire module. This
152 * may lead to code bloat, and may slow things down for those reasons. It may
153 * also lead to errors, if the code relies on pointer aliasing. Use with
154 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000155 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000156 * NOTE: You can only use this for functions that are entirely local to a
157 * module; functions that are exported via method tables, callbacks, etc,
158 * should keep using static.
159 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000160
161#undef USE_INLINE /* XXX - set via configure? */
162
163#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000164#if defined(PY_LOCAL_AGGRESSIVE)
165/* enable more aggressive optimization for visual studio */
166#pragma optimize("agtw", on)
167#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000168/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000169#pragma warning(disable: 4710)
170/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000171#define Py_LOCAL(type) static type __fastcall
172#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000173#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000174#define Py_LOCAL(type) static type
175#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000176#else
177#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000178#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000179#endif
180
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000181/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
182 * are often very short. While most platforms have highly optimized code for
183 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
184 * solves this by doing short copies "in line".
185 */
186
187#if defined(_MSC_VER)
188#define Py_MEMCPY(target, source, length) do { \
189 size_t i_, n_ = (length); \
190 char *t_ = (void*) (target); \
191 const char *s_ = (void*) (source); \
192 if (n_ >= 16) \
193 memcpy(t_, s_, n_); \
194 else \
195 for (i_ = 0; i_ < n_; i_++) \
196 t_[i_] = s_[i_]; \
197 } while (0)
198#else
199#define Py_MEMCPY memcpy
200#endif
201
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000202#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000203
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000204#include <math.h> /* Moved here from the math section, before extern "C" */
205
206/********************************************
207 * WRAPPER FOR <time.h> and/or <sys/time.h> *
208 ********************************************/
209
210#ifdef TIME_WITH_SYS_TIME
211#include <sys/time.h>
212#include <time.h>
213#else /* !TIME_WITH_SYS_TIME */
214#ifdef HAVE_SYS_TIME_H
215#include <sys/time.h>
216#else /* !HAVE_SYS_TIME_H */
217#include <time.h>
218#endif /* !HAVE_SYS_TIME_H */
219#endif /* !TIME_WITH_SYS_TIME */
220
221
222/******************************
223 * WRAPPER FOR <sys/select.h> *
224 ******************************/
225
226/* NB caller must include <sys/types.h> */
227
228#ifdef HAVE_SYS_SELECT_H
229
230#include <sys/select.h>
231
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000232#endif /* !HAVE_SYS_SELECT_H */
233
Tim Peters60f42b52001-01-18 03:03:16 +0000234/*******************************
235 * stat() and fstat() fiddling *
236 *******************************/
237
238/* We expect that stat and fstat exist on most systems.
239 * It's confirmed on Unix, Mac and Windows.
240 * If you don't have them, add
241 * #define DONT_HAVE_STAT
242 * and/or
243 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000244 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000245 * HAVE_FSTAT instead.
246 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000247 * #define HAVE_SYS_STAT_H
248 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000249 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000250 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000251 */
252#ifndef DONT_HAVE_STAT
253#define HAVE_STAT
254#endif
255
256#ifndef DONT_HAVE_FSTAT
257#define HAVE_FSTAT
258#endif
259
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000260#ifdef RISCOS
261#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000262#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000263#endif
264
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000265#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000266#if defined(PYOS_OS2) && defined(PYCC_GCC)
267#include <sys/types.h>
268#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000269#include <sys/stat.h>
270#elif defined(HAVE_STAT_H)
271#include <stat.h>
272#endif
273
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000274#if defined(PYCC_VACPP)
275/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
276#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
277#endif
278
279#ifndef S_ISREG
280#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
281#endif
282
283#ifndef S_ISDIR
284#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
285#endif
286
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000287
Tim Peters7d3a5112000-07-08 04:17:21 +0000288#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000289/* Move this down here since some C++ #include's don't like to be included
290 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000291extern "C" {
292#endif
293
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000294
Tim Peters7d3a5112000-07-08 04:17:21 +0000295/* Py_ARITHMETIC_RIGHT_SHIFT
296 * C doesn't define whether a right-shift of a signed integer sign-extends
297 * or zero-fills. Here a macro to force sign extension:
298 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
299 * Return I >> J, forcing sign extension.
300 * Requirements:
301 * I is of basic signed type TYPE (char, short, int, long, or long long).
302 * TYPE is one of char, short, int, long, or long long, although long long
303 * must not be used except on platforms that support it.
304 * J is an integer >= 0 and strictly less than the number of bits in TYPE
305 * (because C doesn't define what happens for J outside that range either).
306 * Caution:
307 * I may be evaluated more than once.
308 */
309#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
310#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
311 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
312#else
313#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
314#endif
315
Tim Peters39dce292000-08-15 03:34:48 +0000316/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000317 * "Simply" returns its argument. However, macro expansions within the
318 * argument are evaluated. This unfortunate trickery is needed to get
319 * token-pasting to work as desired in some cases.
320 */
321#define Py_FORCE_EXPANSION(X) X
322
Tim Peters8315ea52000-07-23 19:28:35 +0000323/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
324 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
325 * assert-fails if any information is lost.
326 * Caution:
327 * VALUE may be evaluated more than once.
328 */
329#ifdef Py_DEBUG
330#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
331 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
332#else
333#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
334#endif
335
Tim Peters862f0592004-09-23 19:11:32 +0000336/* Py_IS_NAN(X)
337 * Return 1 if float or double arg is a NaN, else 0.
338 * Caution:
339 * X is evaluated more than once.
340 * This may not work on all platforms. Each platform has *some*
341 * way to spell this, though -- override in pyconfig.h if you have
342 * a platform where it doesn't work.
343 */
344#ifndef Py_IS_NAN
345#define Py_IS_NAN(X) ((X) != (X))
346#endif
347
Tim Peters39dce292000-08-15 03:34:48 +0000348/* Py_IS_INFINITY(X)
349 * Return 1 if float or double arg is an infinity, else 0.
350 * Caution:
351 * X is evaluated more than once.
352 * This implementation may set the underflow flag if |X| is very small;
353 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000354 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000355 */
Tim Peters862f0592004-09-23 19:11:32 +0000356#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000357#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000358#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000359
Kristján Valur Jónsson44aa9f712006-05-25 16:39:27 +0000360/* Py_IS_FINITE(X)
361 * Return 1 if float or double arg is neither infinite nor NAN, else 0.
362 * Some compilers (e.g. VisualStudio) have intrisics for this, so a special
Kristján Valur Jónssonf94323f2006-05-25 15:53:30 +0000363 * macro for this particular test is useful
364 */
365#ifndef Py_IS_FINITE
366#define Py_IS_FINITE(X) (!Py_IS_INFINITY(X) && !Py_IS_NAN(X))
367#endif
368
Tim Peters1de41bf2002-07-03 03:31:20 +0000369/* HUGE_VAL is supposed to expand to a positive double infinity. Python
370 * uses Py_HUGE_VAL instead because some platforms are broken in this
371 * respect. We used to embed code in pyport.h to try to worm around that,
372 * but different platforms are broken in conflicting ways. If you're on
373 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
374 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000375 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000376#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000377#define Py_HUGE_VAL HUGE_VAL
378#endif
379
Tim Peters57f282a2001-09-05 05:38:10 +0000380/* Py_OVERFLOWED(X)
381 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
382 * a libm function, and invoke this macro after, passing the function
383 * result.
384 * Caution:
385 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000386 * any exceptional condition, but does require +- HUGE_VAL return
387 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
388 * double infinity, and we're cool if that's so, unless the input
389 * was an infinity and an infinity is the expected result. A C89
390 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000391 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
392 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
393 * in non-overflow cases.
394 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000395 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000396 *
397 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000398 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000399 * should be removed once a newer compiler is available on that platform.
400 * The system that had the failure was running OpenBSD 3.2 on Intel, with
401 * gcc 2.95.3.
402 *
Tim Peters862f0592004-09-23 19:11:32 +0000403 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000404 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000405 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000406#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000407#define Py_OVERFLOWED(X) isinf(X)
408#else
Tim Petersa40c7932001-09-05 22:36:56 +0000409#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
410 (X) == Py_HUGE_VAL || \
411 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000412#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000413
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000414/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000415 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000416 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
417 * to 0 before calling a libm function, and invoke this macro after,
418 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000419 * Caution:
420 * This isn't reliable. See Py_OVERFLOWED comments.
421 * X is evaluated more than once.
422 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000423#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000424#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
425#else
426#define _Py_SET_EDOM_FOR_NAN(X) ;
427#endif
428#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000429 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000430 if (errno == 0) { \
431 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
432 errno = ERANGE; \
433 else _Py_SET_EDOM_FOR_NAN(X) \
434 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000435 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000436
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000437/* Py_SET_ERANGE_ON_OVERFLOW(x)
438 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
439 */
440#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
441
Tim Petersdc5a5082002-03-09 04:58:24 +0000442/* Py_ADJUST_ERANGE1(x)
443 * Py_ADJUST_ERANGE2(x, y)
444 * Set errno to 0 before calling a libm function, and invoke one of these
445 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
446 * for functions returning complex results). This makes two kinds of
447 * adjustments to errno: (A) If it looks like the platform libm set
448 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
449 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
450 * effect, we're trying to force a useful implementation of C89 errno
451 * behavior.
452 * Caution:
453 * This isn't reliable. See Py_OVERFLOWED comments.
454 * X and Y may be evaluated more than once.
455 */
456#define Py_ADJUST_ERANGE1(X) \
457 do { \
458 if (errno == 0) { \
459 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
460 errno = ERANGE; \
461 } \
462 else if (errno == ERANGE && (X) == 0.0) \
463 errno = 0; \
464 } while(0)
465
466#define Py_ADJUST_ERANGE2(X, Y) \
467 do { \
468 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
469 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
470 if (errno == 0) \
471 errno = ERANGE; \
472 } \
473 else if (errno == ERANGE) \
474 errno = 0; \
475 } while(0)
476
Neal Norwitz80292642002-12-19 15:12:26 +0000477/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000478 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000479 * Usage:
480 * extern int old_var Py_DEPRECATED(2.3);
481 * typedef int T1 Py_DEPRECATED(2.4);
482 * extern int x() Py_DEPRECATED(2.5);
483 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000484#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
485 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000486#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
487#else
Tim Peters4643bd92002-12-28 21:56:08 +0000488#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000489#endif
490
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000491/**************************************************************************
492Prototypes that are missing from the standard include files on some systems
493(and possibly only some versions of such systems.)
494
495Please be conservative with adding new ones, document them and enclose them
496in platform-specific #ifdefs.
497**************************************************************************/
498
499#ifdef SOLARIS
500/* Unchecked */
501extern int gethostname(char *, int);
502#endif
503
504#ifdef __BEOS__
505/* Unchecked */
506/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000507int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000508#endif
509
510#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000511#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000512extern char * _getpty(int *, int, mode_t, int);
513#endif
514
515#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
516#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
517/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
518 functions, even though they are included in libutil. */
519#include <termios.h>
520extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
521extern int forkpty(int *, char *, struct termios *, struct winsize *);
522#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
523#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
524
525
526/* These are pulled from various places. It isn't obvious on what platforms
527 they are necessary, nor what the exact prototype should look like (which
528 is likely to vary between platforms!) If you find you need one of these
529 declarations, please move them to a platform-specific block and include
530 proper prototypes. */
531#if 0
532
533/* From Modules/resource.c */
534extern int getrusage();
535extern int getpagesize();
536
537/* From Python/sysmodule.c and Modules/posixmodule.c */
538extern int fclose(FILE *);
539
540/* From Modules/posixmodule.c */
541extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000542#endif /* 0 */
543
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000544
545/************************
546 * WRAPPER FOR <math.h> *
547 ************************/
548
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000549#ifndef HAVE_HYPOT
550extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000551#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000552
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000553
Hye-Shik Changf3032612006-03-22 08:52:43 +0000554/* On 4.4BSD-descendants, ctype functions serves the whole range of
555 * wchar_t character set rather than single byte code points only.
556 * This characteristic can break some operations of string object
557 * including str.upper() and str.split() on UTF-8 locales. This
558 * workaround was provided by Tim Robbins of FreeBSD project.
559 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000560
561#ifdef __FreeBSD__
562#include <osreldate.h>
563#if __FreeBSD_version > 500039
564#include <ctype.h>
565#include <wctype.h>
566#undef isalnum
567#define isalnum(c) iswalnum(btowc(c))
568#undef isalpha
569#define isalpha(c) iswalpha(btowc(c))
570#undef islower
571#define islower(c) iswlower(btowc(c))
572#undef isspace
573#define isspace(c) iswspace(btowc(c))
574#undef isupper
575#define isupper(c) iswupper(btowc(c))
576#undef tolower
577#define tolower(c) towlower(btowc(c))
578#undef toupper
579#define toupper(c) towupper(btowc(c))
580#endif
581#endif
582
583
Mark Hammond8235ea12002-07-19 06:55:41 +0000584/* Declarations for symbol visibility.
585
586 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000587 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000588 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000589 inside the Python core, they are private to the core.
590 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000591 external linkage depending on the platform.
592
593 As a number of platforms support/require "__declspec(dllimport/dllexport)",
594 we support a HAVE_DECLSPEC_DLL macro to save duplication.
595*/
596
Tim Peters4643bd92002-12-28 21:56:08 +0000597/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000598 All windows ports, except cygwin, are handled in PC/pyconfig.h.
599
600 BeOS and cygwin are the only other autoconf platform requiring special
601 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000602*/
603#if defined(__CYGWIN__) || defined(__BEOS__)
604# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000605#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000606
Jason Tishler30765592003-09-04 11:04:06 +0000607/* only get special linkage if built as shared or platform is Cygwin */
608#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000609# if defined(HAVE_DECLSPEC_DLL)
610# ifdef Py_BUILD_CORE
611# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000612# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000613 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000614 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
615# if defined(__CYGWIN__)
616# define PyMODINIT_FUNC __declspec(dllexport) void
617# else /* __CYGWIN__ */
618# define PyMODINIT_FUNC void
619# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000620# else /* Py_BUILD_CORE */
621 /* Building an extension module, or an embedded situation */
622 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000623 /* Under Cygwin, auto-import functions to prevent compilation */
624 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
625# if !defined(__CYGWIN__)
626# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
627# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000628# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000629 /* module init functions outside the core must be exported */
630# if defined(__cplusplus)
631# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
632# else /* __cplusplus */
633# define PyMODINIT_FUNC __declspec(dllexport) void
634# endif /* __cplusplus */
635# endif /* Py_BUILD_CORE */
636# endif /* HAVE_DECLSPEC */
637#endif /* Py_ENABLE_SHARED */
638
639/* If no external linkage macros defined by now, create defaults */
640#ifndef PyAPI_FUNC
641# define PyAPI_FUNC(RTYPE) RTYPE
642#endif
643#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000644# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000645#endif
646#ifndef PyMODINIT_FUNC
647# if defined(__cplusplus)
648# define PyMODINIT_FUNC extern "C" void
649# else /* __cplusplus */
650# define PyMODINIT_FUNC void
651# endif /* __cplusplus */
652#endif
653
654/* Deprecated DL_IMPORT and DL_EXPORT macros */
655#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
656# if defined(Py_BUILD_CORE)
657# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
658# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
659# else
660# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
661# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
662# endif
663#endif
664#ifndef DL_EXPORT
665# define DL_EXPORT(RTYPE) RTYPE
666#endif
667#ifndef DL_IMPORT
668# define DL_IMPORT(RTYPE) RTYPE
669#endif
670/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000671
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000672/* If the fd manipulation macros aren't defined,
673 here is a set that should do the job */
674
Guido van Rossum367e46a2000-08-01 18:28:44 +0000675#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000676
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000677#ifndef FD_SETSIZE
678#define FD_SETSIZE 256
679#endif
680
681#ifndef FD_SET
682
683typedef long fd_mask;
684
685#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
686#ifndef howmany
687#define howmany(x, y) (((x)+((y)-1))/(y))
688#endif /* howmany */
689
690typedef struct fd_set {
691 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
692} fd_set;
693
694#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
695#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
696#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
697#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
698
699#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000700
701#endif /* fd manipulation macros */
702
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000703
Fred Draked5fadf72000-09-26 05:46:01 +0000704/* limits.h constants that may be missing */
705
706#ifndef INT_MAX
707#define INT_MAX 2147483647
708#endif
709
710#ifndef LONG_MAX
711#if SIZEOF_LONG == 4
712#define LONG_MAX 0X7FFFFFFFL
713#elif SIZEOF_LONG == 8
714#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
715#else
716#error "could not set LONG_MAX in pyport.h"
717#endif
718#endif
719
720#ifndef LONG_MIN
721#define LONG_MIN (-LONG_MAX-1)
722#endif
723
Tim Petersd57731f2000-10-05 01:42:25 +0000724#ifndef LONG_BIT
725#define LONG_BIT (8 * SIZEOF_LONG)
726#endif
727
728#if LONG_BIT != 8 * SIZEOF_LONG
729/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
730 * 32-bit platforms using gcc. We try to catch that here at compile-time
731 * rather than waiting for integer multiplication to trigger bogus
732 * overflows.
733 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000734#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000735#endif
736
Tim Peters7d3a5112000-07-08 04:17:21 +0000737#ifdef __cplusplus
738}
739#endif
740
Neil Schemenauer15691082001-10-23 02:20:37 +0000741/*
742 * Hide GCC attributes from compilers that don't support them.
743 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000744#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000745 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000746 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000747#define Py_GCC_ATTRIBUTE(x)
748#else
749#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000750#endif
751
Martin v. Löwisaac13162006-10-19 10:58:46 +0000752/*
753 * Add PyArg_ParseTuple format where available.
754 */
755#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
756#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
757#else
758#define Py_FORMAT_PARSETUPLE(func,p1,p2)
759#endif
760
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000761/* Eliminate end-of-loop code not reached warnings from SunPro C
762 * when using do{...}while(0) macros
763 */
764#ifdef __SUNPRO_C
765#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
766#endif
767
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000768/*
769 * Older Microsoft compilers don't support the C99 long long literal suffixes,
770 * so these will be defined in PC/pyconfig.h for those compilers.
771 */
772#ifndef Py_LL
773#define Py_LL(x) x##LL
774#endif
775
776#ifndef Py_ULL
777#define Py_ULL(x) Py_LL(x##U)
778#endif
779
Tim Peters7d3a5112000-07-08 04:17:21 +0000780#endif /* Py_PYPORT_H */