blob: a6ddbeecfce2f5d5cb378b843f6c427a3c03adb9 [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
Mark Dickinson2f865b92009-06-30 15:32:30 +00006/* Some versions of HP-UX & Solaris need inttypes.h for int32_t,
7 INT32_MAX, etc. */
8#ifdef HAVE_INTTYPES_H
9#include <inttypes.h>
10#endif
11
Martin v. Löwis40e9aed2006-10-02 15:20:37 +000012#ifdef HAVE_STDINT_H
13#include <stdint.h>
14#endif
15
Tim Peters7d3a5112000-07-08 04:17:21 +000016/**************************************************************************
17Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000018C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000019
20Please try to make documentation here as clear as possible: by definition,
21the stuff here is trying to illuminate C's darkest corners.
22
23Config #defines referenced here:
24
25SIGNED_RIGHT_SHIFT_ZERO_FILLS
26Meaning: To be defined iff i>>j does not extend the sign bit when i is a
27 signed integral type and i < 0.
28Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000029
Tim Peters8315ea52000-07-23 19:28:35 +000030Py_DEBUG
31Meaning: Extra checks compiled in for debug mode.
32Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000033
34HAVE_UINTPTR_T
35Meaning: The C9X type uintptr_t is supported by the compiler
36Used in: Py_uintptr_t
37
38HAVE_LONG_LONG
39Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000040Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000041
Tim Peters7d3a5112000-07-08 04:17:21 +000042**************************************************************************/
43
44
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000045/* For backward compatibility only. Obsolete, do not use. */
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000046#ifdef HAVE_PROTOTYPES
47#define Py_PROTO(x) x
48#else
49#define Py_PROTO(x) ()
50#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000051#ifndef Py_FPROTO
52#define Py_FPROTO(x) Py_PROTO(x)
53#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000054
Barry Warsawfd847b22000-08-18 04:48:18 +000055/* typedefs for some C9X-defined synonyms for integral types.
56 *
57 * The names in Python are exactly the same as the C9X names, except with a
58 * Py_ prefix. Until C9X is universally implemented, this is the only way
59 * to ensure that Python gets reliable names that don't conflict with names
60 * in non-Python code that are playing their own tricks to define the C9X
61 * names.
62 *
63 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
64 * integral synonyms. Only define the ones we actually need.
65 */
66
67#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000068#ifndef PY_LONG_LONG
69#define PY_LONG_LONG long long
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000070#if defined(LLONG_MAX)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000071/* If LLONG_MAX is defined in limits.h, use that. */
Martin v. Löwis6371cd82007-06-09 07:42:52 +000072#define PY_LLONG_MIN LLONG_MIN
73#define PY_LLONG_MAX LLONG_MAX
74#define PY_ULLONG_MAX ULLONG_MAX
Martin v. Löwis2a71a472007-06-13 03:42:19 +000075#elif defined(__LONG_LONG_MAX__)
76/* Otherwise, if GCC has a builtin define, use that. */
77#define PY_LLONG_MAX __LONG_LONG_MAX__
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000078#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000079#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
80#else
81/* Otherwise, rely on two's complement. */
82#define PY_ULLONG_MAX (~0ULL)
83#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
84#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000085#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000086#endif
87#endif /* HAVE_LONG_LONG */
88
Mark Dickinsonefc82f72009-03-20 15:51:55 +000089/* a build with 30-bit digits for Python long integers needs an exact-width
90 * 32-bit unsigned integer type to store those digits. (We could just use
91 * type 'unsigned long', but that would be wasteful on a system where longs
92 * are 64-bits.) On Unix systems, the autoconf macro AC_TYPE_UINT32_T defines
93 * uint32_t to be such a type unless stdint.h or inttypes.h defines uint32_t.
94 * However, it doesn't set HAVE_UINT32_T, so we do that here.
95 */
96#if (defined UINT32_MAX || defined uint32_t)
97#ifndef PY_UINT32_T
98#define HAVE_UINT32_T 1
99#define PY_UINT32_T uint32_t
100#endif
101#endif
102
103/* Macros for a 64-bit unsigned integer type; used for type 'twodigits' in the
104 * long integer implementation, when 30-bit digits are enabled.
105 */
106#if (defined UINT64_MAX || defined uint64_t)
107#ifndef PY_UINT64_T
108#define HAVE_UINT64_T 1
109#define PY_UINT64_T uint64_t
110#endif
111#endif
112
113/* Signed variants of the above */
114#if (defined INT32_MAX || defined int32_t)
115#ifndef PY_INT32_T
116#define HAVE_INT32_T 1
117#define PY_INT32_T int32_t
118#endif
119#endif
120#if (defined INT64_MAX || defined int64_t)
121#ifndef PY_INT64_T
122#define HAVE_INT64_T 1
123#define PY_INT64_T int64_t
124#endif
125#endif
126
127/* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
128 the necessary integer types are available, and we're on a 64-bit platform
129 (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
130
131#ifndef PYLONG_BITS_IN_DIGIT
132#if (defined HAVE_UINT64_T && defined HAVE_INT64_T && \
133 defined HAVE_UINT32_T && defined HAVE_INT32_T && SIZEOF_VOID_P >= 8)
134#define PYLONG_BITS_IN_DIGIT 30
135#else
136#define PYLONG_BITS_IN_DIGIT 15
137#endif
138#endif
139
Barry Warsawfd847b22000-08-18 04:48:18 +0000140/* uintptr_t is the C9X name for an unsigned integral type such that a
141 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +0000142 * without loss of information. Similarly for intptr_t, wrt a signed
143 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +0000144 */
145#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +0000146typedef uintptr_t Py_uintptr_t;
147typedef intptr_t Py_intptr_t;
148
Barry Warsawfd847b22000-08-18 04:48:18 +0000149#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +0000150typedef unsigned int Py_uintptr_t;
151typedef int Py_intptr_t;
152
Barry Warsawfd847b22000-08-18 04:48:18 +0000153#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +0000154typedef unsigned long Py_uintptr_t;
155typedef long Py_intptr_t;
156
Barry Warsawfd847b22000-08-18 04:48:18 +0000157#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000158typedef unsigned PY_LONG_LONG Py_uintptr_t;
159typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000160
Barry Warsawfd847b22000-08-18 04:48:18 +0000161#else
162# error "Python needs a typedef for Py_uintptr_t in pyport.h."
163#endif /* HAVE_UINTPTR_T */
164
Tim Petersae1d0c92006-03-17 03:29:34 +0000165/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
166 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
167 * unsigned integral type). See PEP 353 for details.
168 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000169#ifdef HAVE_SSIZE_T
170typedef ssize_t Py_ssize_t;
171#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000172typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000173#else
174# error "Python needs a typedef for Py_ssize_t in pyport.h."
175#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000176
Gregory P. Smith9d534572008-06-11 07:41:16 +0000177/* Largest possible value of size_t.
178 SIZE_MAX is part of C99, so it might be defined on some
179 platforms. If it is not defined, (size_t)-1 is a portable
180 definition for C89, due to the way signed->unsigned
181 conversion is defined. */
182#ifdef SIZE_MAX
183#define PY_SIZE_MAX SIZE_MAX
184#else
185#define PY_SIZE_MAX ((size_t)-1)
186#endif
187
Tim Petersae1d0c92006-03-17 03:29:34 +0000188/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000189#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000190/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000191#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000192
Christian Heimes951cc0f2008-01-31 23:08:23 +0000193#if SIZEOF_PID_T > SIZEOF_LONG
194# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
195#endif
196
Tim Petersae1d0c92006-03-17 03:29:34 +0000197/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
198 * format to convert an argument with the width of a size_t or Py_ssize_t.
199 * C99 introduced "z" for this purpose, but not all platforms support that;
200 * e.g., MS compilers use "I" instead.
201 *
202 * These "high level" Python format functions interpret "z" correctly on
203 * all platforms (Python interprets the format string itself, and does whatever
204 * the platform C requires to convert a size_t/Py_ssize_t argument):
205 *
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000206 * PyString_FromFormat
Tim Petersae1d0c92006-03-17 03:29:34 +0000207 * PyErr_Format
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000208 * PyString_FromFormatV
Tim Petersae1d0c92006-03-17 03:29:34 +0000209 *
210 * Lower-level uses require that you interpolate the correct format modifier
211 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
212 * example,
213 *
214 * Py_ssize_t index;
215 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
216 *
217 * That will expand to %ld, or %Id, or to something else correct for a
218 * Py_ssize_t on the platform.
219 */
220#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000221# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000222# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000223# elif SIZEOF_SIZE_T == SIZEOF_LONG
224# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000225# elif defined(MS_WINDOWS)
226# define PY_FORMAT_SIZE_T "I"
227# else
228# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
229# endif
230#endif
231
Mark Dickinson82864d12009-11-15 16:18:58 +0000232/* PY_FORMAT_LONG_LONG is analogous to PY_FORMAT_SIZE_T above, but for
233 * the long long type instead of the size_t type. It's only available
234 * when HAVE_LONG_LONG is defined. The "high level" Python format
235 * functions listed above will interpret "lld" or "llu" correctly on
236 * all platforms.
237 */
238#ifdef HAVE_LONG_LONG
239# ifndef PY_FORMAT_LONG_LONG
240# if defined(MS_WIN64) || defined(MS_WINDOWS)
241# define PY_FORMAT_LONG_LONG "I64"
242# else
243# error "This platform's pyconfig.h needs to define PY_FORMAT_LONG_LONG"
244# endif
245# endif
246#endif
247
Fredrik Lundh7a830892006-05-27 10:39:48 +0000248/* Py_LOCAL can be used instead of static to get the fastest possible calling
249 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000250 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000251 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
252 * for platforms that support that.
253 *
254 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
255 * "aggressive" inlining/optimizaion is enabled for the entire module. This
256 * may lead to code bloat, and may slow things down for those reasons. It may
257 * also lead to errors, if the code relies on pointer aliasing. Use with
258 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000259 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000260 * NOTE: You can only use this for functions that are entirely local to a
261 * module; functions that are exported via method tables, callbacks, etc,
262 * should keep using static.
263 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000264
265#undef USE_INLINE /* XXX - set via configure? */
266
267#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000268#if defined(PY_LOCAL_AGGRESSIVE)
269/* enable more aggressive optimization for visual studio */
270#pragma optimize("agtw", on)
271#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000272/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000273#pragma warning(disable: 4710)
274/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000275#define Py_LOCAL(type) static type __fastcall
276#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000277#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000278#define Py_LOCAL(type) static type
279#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000280#else
281#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000282#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000283#endif
284
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000285/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
286 * are often very short. While most platforms have highly optimized code for
287 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
288 * solves this by doing short copies "in line".
289 */
290
291#if defined(_MSC_VER)
292#define Py_MEMCPY(target, source, length) do { \
293 size_t i_, n_ = (length); \
294 char *t_ = (void*) (target); \
295 const char *s_ = (void*) (source); \
296 if (n_ >= 16) \
297 memcpy(t_, s_, n_); \
298 else \
299 for (i_ = 0; i_ < n_; i_++) \
300 t_[i_] = s_[i_]; \
301 } while (0)
302#else
303#define Py_MEMCPY memcpy
304#endif
305
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000306#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000307
Mark Dickinson31f0cfe2009-11-28 12:30:36 +0000308#ifdef HAVE_IEEEFP_H
309#include <ieeefp.h> /* needed for 'finite' declaration on some platforms */
310#endif
311
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000312#include <math.h> /* Moved here from the math section, before extern "C" */
313
314/********************************************
315 * WRAPPER FOR <time.h> and/or <sys/time.h> *
316 ********************************************/
317
318#ifdef TIME_WITH_SYS_TIME
319#include <sys/time.h>
320#include <time.h>
321#else /* !TIME_WITH_SYS_TIME */
322#ifdef HAVE_SYS_TIME_H
323#include <sys/time.h>
324#else /* !HAVE_SYS_TIME_H */
325#include <time.h>
326#endif /* !HAVE_SYS_TIME_H */
327#endif /* !TIME_WITH_SYS_TIME */
328
329
330/******************************
331 * WRAPPER FOR <sys/select.h> *
332 ******************************/
333
334/* NB caller must include <sys/types.h> */
335
336#ifdef HAVE_SYS_SELECT_H
337
338#include <sys/select.h>
339
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000340#endif /* !HAVE_SYS_SELECT_H */
341
Tim Peters60f42b52001-01-18 03:03:16 +0000342/*******************************
343 * stat() and fstat() fiddling *
344 *******************************/
345
346/* We expect that stat and fstat exist on most systems.
347 * It's confirmed on Unix, Mac and Windows.
348 * If you don't have them, add
349 * #define DONT_HAVE_STAT
350 * and/or
351 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000352 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000353 * HAVE_FSTAT instead.
354 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000355 * #define HAVE_SYS_STAT_H
356 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000357 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000358 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000359 */
360#ifndef DONT_HAVE_STAT
361#define HAVE_STAT
362#endif
363
364#ifndef DONT_HAVE_FSTAT
365#define HAVE_FSTAT
366#endif
367
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000368#ifdef RISCOS
369#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000370#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000371#endif
372
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000373#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000374#if defined(PYOS_OS2) && defined(PYCC_GCC)
375#include <sys/types.h>
376#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000377#include <sys/stat.h>
378#elif defined(HAVE_STAT_H)
379#include <stat.h>
380#endif
381
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000382#if defined(PYCC_VACPP)
383/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
384#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
385#endif
386
387#ifndef S_ISREG
388#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
389#endif
390
391#ifndef S_ISDIR
392#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
393#endif
394
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000395
Tim Peters7d3a5112000-07-08 04:17:21 +0000396#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000397/* Move this down here since some C++ #include's don't like to be included
398 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000399extern "C" {
400#endif
401
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000402
Tim Peters7d3a5112000-07-08 04:17:21 +0000403/* Py_ARITHMETIC_RIGHT_SHIFT
404 * C doesn't define whether a right-shift of a signed integer sign-extends
405 * or zero-fills. Here a macro to force sign extension:
406 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
Mark Dickinsonf35f8042009-03-20 23:16:14 +0000407 * Return I >> J, forcing sign extension. Arithmetically, return the
408 * floor of I/2**J.
Tim Peters7d3a5112000-07-08 04:17:21 +0000409 * Requirements:
Mark Dickinsonf35f8042009-03-20 23:16:14 +0000410 * I should have signed integer type. In the terminology of C99, this can
411 * be either one of the five standard signed integer types (signed char,
412 * short, int, long, long long) or an extended signed integer type.
413 * J is an integer >= 0 and strictly less than the number of bits in the
414 * type of I (because C doesn't define what happens for J outside that
415 * range either).
416 * TYPE used to specify the type of I, but is now ignored. It's been left
417 * in for backwards compatibility with versions <= 2.6 or 3.0.
Tim Peters7d3a5112000-07-08 04:17:21 +0000418 * Caution:
419 * I may be evaluated more than once.
420 */
421#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
422#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
Mark Dickinsonf35f8042009-03-20 23:16:14 +0000423 ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
Tim Peters7d3a5112000-07-08 04:17:21 +0000424#else
425#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
426#endif
427
Tim Peters39dce292000-08-15 03:34:48 +0000428/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000429 * "Simply" returns its argument. However, macro expansions within the
430 * argument are evaluated. This unfortunate trickery is needed to get
431 * token-pasting to work as desired in some cases.
432 */
433#define Py_FORCE_EXPANSION(X) X
434
Tim Peters8315ea52000-07-23 19:28:35 +0000435/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
436 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
437 * assert-fails if any information is lost.
438 * Caution:
439 * VALUE may be evaluated more than once.
440 */
441#ifdef Py_DEBUG
442#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
443 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
444#else
445#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
446#endif
447
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000448/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000449 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000450 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
451 * to 0 before calling a libm function, and invoke this macro after,
452 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000453 * Caution:
454 * This isn't reliable. See Py_OVERFLOWED comments.
455 * X is evaluated more than once.
456 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000457#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000458#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
459#else
460#define _Py_SET_EDOM_FOR_NAN(X) ;
461#endif
462#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000463 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000464 if (errno == 0) { \
465 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
466 errno = ERANGE; \
467 else _Py_SET_EDOM_FOR_NAN(X) \
468 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000469 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000470
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000471/* Py_SET_ERANGE_ON_OVERFLOW(x)
472 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
473 */
474#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
475
Tim Petersdc5a5082002-03-09 04:58:24 +0000476/* Py_ADJUST_ERANGE1(x)
477 * Py_ADJUST_ERANGE2(x, y)
478 * Set errno to 0 before calling a libm function, and invoke one of these
479 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
480 * for functions returning complex results). This makes two kinds of
481 * adjustments to errno: (A) If it looks like the platform libm set
482 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
483 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
484 * effect, we're trying to force a useful implementation of C89 errno
485 * behavior.
486 * Caution:
487 * This isn't reliable. See Py_OVERFLOWED comments.
488 * X and Y may be evaluated more than once.
489 */
490#define Py_ADJUST_ERANGE1(X) \
491 do { \
492 if (errno == 0) { \
493 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
494 errno = ERANGE; \
495 } \
496 else if (errno == ERANGE && (X) == 0.0) \
497 errno = 0; \
498 } while(0)
499
500#define Py_ADJUST_ERANGE2(X, Y) \
501 do { \
502 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
503 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
504 if (errno == 0) \
505 errno = ERANGE; \
506 } \
507 else if (errno == ERANGE) \
508 errno = 0; \
509 } while(0)
510
Mark Dickinson1d6e2e12009-10-24 13:28:38 +0000511/* The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
512 * required to support the short float repr introduced in Python 3.1) require
513 * that the floating-point unit that's being used for arithmetic operations
514 * on C doubles is set to use 53-bit precision. It also requires that the
515 * FPU rounding mode is round-half-to-even, but that's less often an issue.
516 *
517 * If your FPU isn't already set to 53-bit precision/round-half-to-even, and
518 * you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
519 *
520 * #define HAVE_PY_SET_53BIT_PRECISION 1
521 *
522 * and also give appropriate definitions for the following three macros:
523 *
524 * _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
525 * set FPU to 53-bit precision/round-half-to-even
526 * _PY_SET_53BIT_PRECISION_END : restore original FPU settings
527 * _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
528 * use the two macros above.
529 *
530 * The macros are designed to be used within a single C function: see
531 * Python/pystrtod.c for an example of their use.
532 */
533
534/* get and set x87 control word for gcc/x86 */
535#ifdef HAVE_GCC_ASM_FOR_X87
536#define HAVE_PY_SET_53BIT_PRECISION 1
537/* _Py_get/set_387controlword functions are defined in Python/pymath.c */
538#define _Py_SET_53BIT_PRECISION_HEADER \
539 unsigned short old_387controlword, new_387controlword
540#define _Py_SET_53BIT_PRECISION_START \
541 do { \
542 old_387controlword = _Py_get_387controlword(); \
543 new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
544 if (new_387controlword != old_387controlword) \
545 _Py_set_387controlword(new_387controlword); \
546 } while (0)
547#define _Py_SET_53BIT_PRECISION_END \
548 if (new_387controlword != old_387controlword) \
549 _Py_set_387controlword(old_387controlword)
550#endif
551
552/* default definitions are empty */
553#ifndef HAVE_PY_SET_53BIT_PRECISION
554#define _Py_SET_53BIT_PRECISION_HEADER
555#define _Py_SET_53BIT_PRECISION_START
556#define _Py_SET_53BIT_PRECISION_END
557#endif
558
559/* If we can't guarantee 53-bit precision, don't use the code
560 in Python/dtoa.c, but fall back to standard code. This
561 means that repr of a float will be long (17 sig digits).
562
563 Realistically, there are two things that could go wrong:
564
565 (1) doubles aren't IEEE 754 doubles, or
566 (2) we're on x86 with the rounding precision set to 64-bits
567 (extended precision), and we don't know how to change
568 the rounding precision.
569 */
570
571#if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
572 !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
573 !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
574#define PY_NO_SHORT_FLOAT_REPR
575#endif
576
577/* double rounding is symptomatic of use of extended precision on x86. If
578 we're seeing double rounding, and we don't have any mechanism available for
579 changing the FPU rounding precision, then don't use Python/dtoa.c. */
580#if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
581#define PY_NO_SHORT_FLOAT_REPR
582#endif
583
Neal Norwitz80292642002-12-19 15:12:26 +0000584/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000585 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000586 * Usage:
587 * extern int old_var Py_DEPRECATED(2.3);
588 * typedef int T1 Py_DEPRECATED(2.4);
589 * extern int x() Py_DEPRECATED(2.5);
590 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000591#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
592 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000593#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
594#else
Tim Peters4643bd92002-12-28 21:56:08 +0000595#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000596#endif
597
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000598/**************************************************************************
599Prototypes that are missing from the standard include files on some systems
600(and possibly only some versions of such systems.)
601
602Please be conservative with adding new ones, document them and enclose them
603in platform-specific #ifdefs.
604**************************************************************************/
605
606#ifdef SOLARIS
607/* Unchecked */
608extern int gethostname(char *, int);
609#endif
610
611#ifdef __BEOS__
612/* Unchecked */
613/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000614int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000615#endif
616
617#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000618#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000619extern char * _getpty(int *, int, mode_t, int);
620#endif
621
Martin v. Löwis8c255e42008-05-23 15:06:50 +0000622/* On QNX 6, struct termio must be declared by including sys/termio.h
623 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
624 be included before termios.h or it will generate an error. */
625#ifdef HAVE_SYS_TERMIO_H
626#include <sys/termio.h>
627#endif
628
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000629#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
Ronald Oussorena55af9a2010-01-17 16:25:57 +0000630#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) && !defined(HAVE_UTIL_H)
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000631/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
632 functions, even though they are included in libutil. */
633#include <termios.h>
634extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes951cc0f2008-01-31 23:08:23 +0000635extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000636#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
637#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
638
639
640/* These are pulled from various places. It isn't obvious on what platforms
641 they are necessary, nor what the exact prototype should look like (which
642 is likely to vary between platforms!) If you find you need one of these
643 declarations, please move them to a platform-specific block and include
644 proper prototypes. */
645#if 0
646
647/* From Modules/resource.c */
648extern int getrusage();
649extern int getpagesize();
650
651/* From Python/sysmodule.c and Modules/posixmodule.c */
652extern int fclose(FILE *);
653
654/* From Modules/posixmodule.c */
655extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000656#endif /* 0 */
657
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000658
Hye-Shik Changf3032612006-03-22 08:52:43 +0000659/* On 4.4BSD-descendants, ctype functions serves the whole range of
660 * wchar_t character set rather than single byte code points only.
661 * This characteristic can break some operations of string object
662 * including str.upper() and str.split() on UTF-8 locales. This
663 * workaround was provided by Tim Robbins of FreeBSD project.
664 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000665
666#ifdef __FreeBSD__
667#include <osreldate.h>
668#if __FreeBSD_version > 500039
669#include <ctype.h>
670#include <wctype.h>
671#undef isalnum
672#define isalnum(c) iswalnum(btowc(c))
673#undef isalpha
674#define isalpha(c) iswalpha(btowc(c))
675#undef islower
676#define islower(c) iswlower(btowc(c))
677#undef isspace
678#define isspace(c) iswspace(btowc(c))
679#undef isupper
680#define isupper(c) iswupper(btowc(c))
681#undef tolower
682#define tolower(c) towlower(btowc(c))
683#undef toupper
684#define toupper(c) towupper(btowc(c))
685#endif
686#endif
687
688
Mark Hammond8235ea12002-07-19 06:55:41 +0000689/* Declarations for symbol visibility.
690
691 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000692 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000693 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000694 inside the Python core, they are private to the core.
695 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000696 external linkage depending on the platform.
697
698 As a number of platforms support/require "__declspec(dllimport/dllexport)",
699 we support a HAVE_DECLSPEC_DLL macro to save duplication.
700*/
701
Tim Peters4643bd92002-12-28 21:56:08 +0000702/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000703 All windows ports, except cygwin, are handled in PC/pyconfig.h.
704
705 BeOS and cygwin are the only other autoconf platform requiring special
706 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000707*/
708#if defined(__CYGWIN__) || defined(__BEOS__)
709# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000710#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000711
Jason Tishler30765592003-09-04 11:04:06 +0000712/* only get special linkage if built as shared or platform is Cygwin */
713#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000714# if defined(HAVE_DECLSPEC_DLL)
715# ifdef Py_BUILD_CORE
716# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000717# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000718 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000719 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
720# if defined(__CYGWIN__)
721# define PyMODINIT_FUNC __declspec(dllexport) void
722# else /* __CYGWIN__ */
723# define PyMODINIT_FUNC void
724# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000725# else /* Py_BUILD_CORE */
726 /* Building an extension module, or an embedded situation */
727 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000728 /* Under Cygwin, auto-import functions to prevent compilation */
729 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
730# if !defined(__CYGWIN__)
731# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
732# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000733# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000734 /* module init functions outside the core must be exported */
735# if defined(__cplusplus)
736# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
737# else /* __cplusplus */
738# define PyMODINIT_FUNC __declspec(dllexport) void
739# endif /* __cplusplus */
740# endif /* Py_BUILD_CORE */
741# endif /* HAVE_DECLSPEC */
742#endif /* Py_ENABLE_SHARED */
743
744/* If no external linkage macros defined by now, create defaults */
745#ifndef PyAPI_FUNC
746# define PyAPI_FUNC(RTYPE) RTYPE
747#endif
748#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000749# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000750#endif
751#ifndef PyMODINIT_FUNC
752# if defined(__cplusplus)
753# define PyMODINIT_FUNC extern "C" void
754# else /* __cplusplus */
755# define PyMODINIT_FUNC void
756# endif /* __cplusplus */
757#endif
758
759/* Deprecated DL_IMPORT and DL_EXPORT macros */
760#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
761# if defined(Py_BUILD_CORE)
762# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
763# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
764# else
765# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
766# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
767# endif
768#endif
769#ifndef DL_EXPORT
770# define DL_EXPORT(RTYPE) RTYPE
771#endif
772#ifndef DL_IMPORT
773# define DL_IMPORT(RTYPE) RTYPE
774#endif
775/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000776
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000777/* If the fd manipulation macros aren't defined,
778 here is a set that should do the job */
779
Guido van Rossum367e46a2000-08-01 18:28:44 +0000780#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000781
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000782#ifndef FD_SETSIZE
783#define FD_SETSIZE 256
784#endif
785
786#ifndef FD_SET
787
788typedef long fd_mask;
789
790#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
791#ifndef howmany
792#define howmany(x, y) (((x)+((y)-1))/(y))
793#endif /* howmany */
794
795typedef struct fd_set {
796 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
797} fd_set;
798
799#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
800#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
801#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
802#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
803
804#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000805
806#endif /* fd manipulation macros */
807
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000808
Fred Draked5fadf72000-09-26 05:46:01 +0000809/* limits.h constants that may be missing */
810
811#ifndef INT_MAX
812#define INT_MAX 2147483647
813#endif
814
815#ifndef LONG_MAX
816#if SIZEOF_LONG == 4
817#define LONG_MAX 0X7FFFFFFFL
818#elif SIZEOF_LONG == 8
819#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
820#else
821#error "could not set LONG_MAX in pyport.h"
822#endif
823#endif
824
825#ifndef LONG_MIN
826#define LONG_MIN (-LONG_MAX-1)
827#endif
828
Tim Petersd57731f2000-10-05 01:42:25 +0000829#ifndef LONG_BIT
830#define LONG_BIT (8 * SIZEOF_LONG)
831#endif
832
833#if LONG_BIT != 8 * SIZEOF_LONG
834/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
835 * 32-bit platforms using gcc. We try to catch that here at compile-time
836 * rather than waiting for integer multiplication to trigger bogus
837 * overflows.
838 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000839#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000840#endif
841
Tim Peters7d3a5112000-07-08 04:17:21 +0000842#ifdef __cplusplus
843}
844#endif
845
Neil Schemenauer15691082001-10-23 02:20:37 +0000846/*
847 * Hide GCC attributes from compilers that don't support them.
848 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000849#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000850 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000851 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000852#define Py_GCC_ATTRIBUTE(x)
853#else
854#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000855#endif
856
Martin v. Löwisaac13162006-10-19 10:58:46 +0000857/*
858 * Add PyArg_ParseTuple format where available.
859 */
860#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
861#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
862#else
863#define Py_FORMAT_PARSETUPLE(func,p1,p2)
864#endif
865
Jeffrey Yasskind89f5b22009-01-09 16:47:07 +0000866/*
867 * Specify alignment on compilers that support it.
868 */
869#if defined(__GNUC__) && __GNUC__ >= 3
870#define Py_ALIGNED(x) __attribute__((aligned(x)))
871#else
872#define Py_ALIGNED(x)
873#endif
874
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000875/* Eliminate end-of-loop code not reached warnings from SunPro C
876 * when using do{...}while(0) macros
877 */
878#ifdef __SUNPRO_C
879#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
880#endif
881
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000882/*
883 * Older Microsoft compilers don't support the C99 long long literal suffixes,
884 * so these will be defined in PC/pyconfig.h for those compilers.
885 */
886#ifndef Py_LL
887#define Py_LL(x) x##LL
888#endif
889
890#ifndef Py_ULL
891#define Py_ULL(x) Py_LL(x##U)
892#endif
893
Tim Peters7d3a5112000-07-08 04:17:21 +0000894#endif /* Py_PYPORT_H */