blob: 2bce415c5c01fc6ac49cd4c3134540b4c56b2d71 [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
Tim Peters7d3a5112000-07-08 04:17:21 +00006/**************************************************************************
7Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +00008C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +00009
10Please try to make documentation here as clear as possible: by definition,
11the stuff here is trying to illuminate C's darkest corners.
12
13Config #defines referenced here:
14
15SIGNED_RIGHT_SHIFT_ZERO_FILLS
16Meaning: To be defined iff i>>j does not extend the sign bit when i is a
17 signed integral type and i < 0.
18Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000019
Tim Peters8315ea52000-07-23 19:28:35 +000020Py_DEBUG
21Meaning: Extra checks compiled in for debug mode.
22Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000023
24HAVE_UINTPTR_T
25Meaning: The C9X type uintptr_t is supported by the compiler
26Used in: Py_uintptr_t
27
28HAVE_LONG_LONG
29Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000030Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000031
Tim Peters7d3a5112000-07-08 04:17:21 +000032**************************************************************************/
33
34
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000035/* For backward compatibility only. Obsolete, do not use. */
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000036#ifdef HAVE_PROTOTYPES
37#define Py_PROTO(x) x
38#else
39#define Py_PROTO(x) ()
40#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000041#ifndef Py_FPROTO
42#define Py_FPROTO(x) Py_PROTO(x)
43#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000044
Barry Warsawfd847b22000-08-18 04:48:18 +000045/* typedefs for some C9X-defined synonyms for integral types.
46 *
47 * The names in Python are exactly the same as the C9X names, except with a
48 * Py_ prefix. Until C9X is universally implemented, this is the only way
49 * to ensure that Python gets reliable names that don't conflict with names
50 * in non-Python code that are playing their own tricks to define the C9X
51 * names.
52 *
53 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
54 * integral synonyms. Only define the ones we actually need.
55 */
56
57#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000058#ifndef PY_LONG_LONG
59#define PY_LONG_LONG long long
Barry Warsawfd847b22000-08-18 04:48:18 +000060#endif
61#endif /* HAVE_LONG_LONG */
62
63/* uintptr_t is the C9X name for an unsigned integral type such that a
64 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000065 * without loss of information. Similarly for intptr_t, wrt a signed
66 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000067 */
68#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000069typedef uintptr_t Py_uintptr_t;
70typedef intptr_t Py_intptr_t;
71
Barry Warsawfd847b22000-08-18 04:48:18 +000072#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000073typedef unsigned int Py_uintptr_t;
74typedef int Py_intptr_t;
75
Barry Warsawfd847b22000-08-18 04:48:18 +000076#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000077typedef unsigned long Py_uintptr_t;
78typedef long Py_intptr_t;
79
Barry Warsawfd847b22000-08-18 04:48:18 +000080#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000081typedef unsigned PY_LONG_LONG Py_uintptr_t;
82typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +000083
Barry Warsawfd847b22000-08-18 04:48:18 +000084#else
85# error "Python needs a typedef for Py_uintptr_t in pyport.h."
86#endif /* HAVE_UINTPTR_T */
87
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000088/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
89 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
90 * unsigned integral type). See PEP 353 for details.
91 */
Martin v. Löwis18e16552006-02-15 17:27:45 +000092#ifdef HAVE_SSIZE_T
93typedef ssize_t Py_ssize_t;
94#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +000095typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +000096#else
97# error "Python needs a typedef for Py_ssize_t in pyport.h."
98#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000099
100/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000101#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000102/* Smallest negative value of type Py_ssize_t. */
103#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
104
105/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
106 * format to convert an argument with the width of a size_t or Py_ssize_t.
107 * C99 introduced "z" for this purpose, but not all platforms support that;
108 * e.g., MS compilers use "I" instead.
109 *
110 * These "high level" Python format functions interpret "z" correctly on
111 * all platforms (Python interprets the format string itself, and does whatever
112 * the platform C requires to convert a size_t/Py_ssize_t argument):
113 *
114 * PyString_FromFormat
115 * PyErr_Format
116 * PyString_FromFormatV
117 *
118 * Lower-level uses require that you interpolate the correct format modifier
119 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
120 * example,
121 *
122 * Py_ssize_t index;
123 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
124 *
125 * That will expand to %ld, or %Id, or to something else correct for a
126 * Py_ssize_t on the platform.
127 */
128#ifndef PY_FORMAT_SIZE_T
129# if SIZEOF_SIZE_T == SIZEOF_INT
130# define PY_FORMAT_SIZE_T ""
131# elif SIZEOF_SIZE_T == SIZEOF_LONG
132# define PY_FORMAT_SIZE_T "l"
133# elif defined(MS_WINDOWS)
134# define PY_FORMAT_SIZE_T "I"
135# else
136# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
137# endif
138#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000139
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000140#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000141
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000142#include <math.h> /* Moved here from the math section, before extern "C" */
143
144/********************************************
145 * WRAPPER FOR <time.h> and/or <sys/time.h> *
146 ********************************************/
147
148#ifdef TIME_WITH_SYS_TIME
149#include <sys/time.h>
150#include <time.h>
151#else /* !TIME_WITH_SYS_TIME */
152#ifdef HAVE_SYS_TIME_H
153#include <sys/time.h>
154#else /* !HAVE_SYS_TIME_H */
155#include <time.h>
156#endif /* !HAVE_SYS_TIME_H */
157#endif /* !TIME_WITH_SYS_TIME */
158
159
160/******************************
161 * WRAPPER FOR <sys/select.h> *
162 ******************************/
163
164/* NB caller must include <sys/types.h> */
165
166#ifdef HAVE_SYS_SELECT_H
167
168#include <sys/select.h>
169
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000170#endif /* !HAVE_SYS_SELECT_H */
171
Tim Peters60f42b52001-01-18 03:03:16 +0000172/*******************************
173 * stat() and fstat() fiddling *
174 *******************************/
175
176/* We expect that stat and fstat exist on most systems.
177 * It's confirmed on Unix, Mac and Windows.
178 * If you don't have them, add
179 * #define DONT_HAVE_STAT
180 * and/or
181 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000182 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000183 * HAVE_FSTAT instead.
184 * Also
185 * #define DONT_HAVE_SYS_STAT_H
186 * if <sys/stat.h> doesn't exist on your platform, and
187 * #define HAVE_STAT_H
188 * if <stat.h> does (don't look at me -- ths mess is inherited).
189 */
190#ifndef DONT_HAVE_STAT
191#define HAVE_STAT
192#endif
193
194#ifndef DONT_HAVE_FSTAT
195#define HAVE_FSTAT
196#endif
197
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000198#ifdef RISCOS
199#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000200#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000201#endif
202
Tim Peters60f42b52001-01-18 03:03:16 +0000203#ifndef DONT_HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000204#if defined(PYOS_OS2) && defined(PYCC_GCC)
205#include <sys/types.h>
206#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000207#include <sys/stat.h>
208#elif defined(HAVE_STAT_H)
209#include <stat.h>
210#endif
211
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000212#if defined(PYCC_VACPP)
213/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
214#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
215#endif
216
217#ifndef S_ISREG
218#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
219#endif
220
221#ifndef S_ISDIR
222#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
223#endif
224
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000225
Tim Peters7d3a5112000-07-08 04:17:21 +0000226#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000227/* Move this down here since some C++ #include's don't like to be included
228 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000229extern "C" {
230#endif
231
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000232
Tim Peters7d3a5112000-07-08 04:17:21 +0000233/* Py_ARITHMETIC_RIGHT_SHIFT
234 * C doesn't define whether a right-shift of a signed integer sign-extends
235 * or zero-fills. Here a macro to force sign extension:
236 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
237 * Return I >> J, forcing sign extension.
238 * Requirements:
239 * I is of basic signed type TYPE (char, short, int, long, or long long).
240 * TYPE is one of char, short, int, long, or long long, although long long
241 * must not be used except on platforms that support it.
242 * J is an integer >= 0 and strictly less than the number of bits in TYPE
243 * (because C doesn't define what happens for J outside that range either).
244 * Caution:
245 * I may be evaluated more than once.
246 */
247#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
248#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
249 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
250#else
251#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
252#endif
253
Tim Peters39dce292000-08-15 03:34:48 +0000254/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000255 * "Simply" returns its argument. However, macro expansions within the
256 * argument are evaluated. This unfortunate trickery is needed to get
257 * token-pasting to work as desired in some cases.
258 */
259#define Py_FORCE_EXPANSION(X) X
260
Tim Peters8315ea52000-07-23 19:28:35 +0000261/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
262 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
263 * assert-fails if any information is lost.
264 * Caution:
265 * VALUE may be evaluated more than once.
266 */
267#ifdef Py_DEBUG
268#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
269 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
270#else
271#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
272#endif
273
Tim Peters862f0592004-09-23 19:11:32 +0000274/* Py_IS_NAN(X)
275 * Return 1 if float or double arg is a NaN, else 0.
276 * Caution:
277 * X is evaluated more than once.
278 * This may not work on all platforms. Each platform has *some*
279 * way to spell this, though -- override in pyconfig.h if you have
280 * a platform where it doesn't work.
281 */
282#ifndef Py_IS_NAN
283#define Py_IS_NAN(X) ((X) != (X))
284#endif
285
Tim Peters39dce292000-08-15 03:34:48 +0000286/* Py_IS_INFINITY(X)
287 * Return 1 if float or double arg is an infinity, else 0.
288 * Caution:
289 * X is evaluated more than once.
290 * This implementation may set the underflow flag if |X| is very small;
291 * it really can't be implemented correctly (& easily) before C99.
Tim Peters862f0592004-09-23 19:11:32 +0000292 * Override in pyconfig.h if you have a better spelling on your platform.
Tim Peters39dce292000-08-15 03:34:48 +0000293 */
Tim Peters862f0592004-09-23 19:11:32 +0000294#ifndef Py_IS_INFINITY
Tim Peters1a2eefd2000-09-08 15:45:34 +0000295#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Tim Peters862f0592004-09-23 19:11:32 +0000296#endif
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000297
Tim Peters1de41bf2002-07-03 03:31:20 +0000298/* HUGE_VAL is supposed to expand to a positive double infinity. Python
299 * uses Py_HUGE_VAL instead because some platforms are broken in this
300 * respect. We used to embed code in pyport.h to try to worm around that,
301 * but different platforms are broken in conflicting ways. If you're on
302 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
303 * config to #define Py_HUGE_VAL to something that works on your platform.
Tim Petersa40c7932001-09-05 22:36:56 +0000304 */
Tim Peters1de41bf2002-07-03 03:31:20 +0000305#ifndef Py_HUGE_VAL
Tim Petersa40c7932001-09-05 22:36:56 +0000306#define Py_HUGE_VAL HUGE_VAL
307#endif
308
Tim Peters57f282a2001-09-05 05:38:10 +0000309/* Py_OVERFLOWED(X)
310 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
311 * a libm function, and invoke this macro after, passing the function
312 * result.
313 * Caution:
314 * This isn't reliable. C99 no longer requires libm to set errno under
Tim Petersd893fd62001-09-05 06:24:24 +0000315 * any exceptional condition, but does require +- HUGE_VAL return
316 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
317 * double infinity, and we're cool if that's so, unless the input
318 * was an infinity and an infinity is the expected result. A C89
319 * system sets errno to ERANGE, so we check for that too. We're
Tim Peters57f282a2001-09-05 05:38:10 +0000320 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
321 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
322 * in non-overflow cases.
323 * X is evaluated more than once.
Tim Peters4643bd92002-12-28 21:56:08 +0000324 * Some platforms have better way to spell this, so expect some #ifdef'ery.
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000325 *
326 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
Tim Peters862f0592004-09-23 19:11:32 +0000327 * the longer macro version to be mis-compiled. This isn't optimal, and
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000328 * should be removed once a newer compiler is available on that platform.
329 * The system that had the failure was running OpenBSD 3.2 on Intel, with
330 * gcc 2.95.3.
331 *
Tim Peters862f0592004-09-23 19:11:32 +0000332 * According to Tim's checkin, the FreeBSD systems use isinf() to work
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000333 * around a FPE bug on that platform.
Tim Peters57f282a2001-09-05 05:38:10 +0000334 */
Anthony Baxter83dd43f2003-09-30 14:58:59 +0000335#if defined(__FreeBSD__) || defined(__OpenBSD__)
Tim Peters4643bd92002-12-28 21:56:08 +0000336#define Py_OVERFLOWED(X) isinf(X)
337#else
Tim Petersa40c7932001-09-05 22:36:56 +0000338#define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
339 (X) == Py_HUGE_VAL || \
340 (X) == -Py_HUGE_VAL))
Tim Peters4643bd92002-12-28 21:56:08 +0000341#endif
Tim Petersa40c7932001-09-05 22:36:56 +0000342
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000343/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000344 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000345 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
346 * to 0 before calling a libm function, and invoke this macro after,
347 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000348 * Caution:
349 * This isn't reliable. See Py_OVERFLOWED comments.
350 * X is evaluated more than once.
351 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000352#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000353#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
354#else
355#define _Py_SET_EDOM_FOR_NAN(X) ;
356#endif
357#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000358 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000359 if (errno == 0) { \
360 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
361 errno = ERANGE; \
362 else _Py_SET_EDOM_FOR_NAN(X) \
363 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000364 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000365
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000366/* Py_SET_ERANGE_ON_OVERFLOW(x)
367 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
368 */
369#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
370
Tim Petersdc5a5082002-03-09 04:58:24 +0000371/* Py_ADJUST_ERANGE1(x)
372 * Py_ADJUST_ERANGE2(x, y)
373 * Set errno to 0 before calling a libm function, and invoke one of these
374 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
375 * for functions returning complex results). This makes two kinds of
376 * adjustments to errno: (A) If it looks like the platform libm set
377 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
378 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
379 * effect, we're trying to force a useful implementation of C89 errno
380 * behavior.
381 * Caution:
382 * This isn't reliable. See Py_OVERFLOWED comments.
383 * X and Y may be evaluated more than once.
384 */
385#define Py_ADJUST_ERANGE1(X) \
386 do { \
387 if (errno == 0) { \
388 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
389 errno = ERANGE; \
390 } \
391 else if (errno == ERANGE && (X) == 0.0) \
392 errno = 0; \
393 } while(0)
394
395#define Py_ADJUST_ERANGE2(X, Y) \
396 do { \
397 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
398 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
399 if (errno == 0) \
400 errno = ERANGE; \
401 } \
402 else if (errno == ERANGE) \
403 errno = 0; \
404 } while(0)
405
Neal Norwitz80292642002-12-19 15:12:26 +0000406/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000407 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000408 * Usage:
409 * extern int old_var Py_DEPRECATED(2.3);
410 * typedef int T1 Py_DEPRECATED(2.4);
411 * extern int x() Py_DEPRECATED(2.5);
412 */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000413#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
414 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000415#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
416#else
Tim Peters4643bd92002-12-28 21:56:08 +0000417#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000418#endif
419
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000420/**************************************************************************
421Prototypes that are missing from the standard include files on some systems
422(and possibly only some versions of such systems.)
423
424Please be conservative with adding new ones, document them and enclose them
425in platform-specific #ifdefs.
426**************************************************************************/
427
428#ifdef SOLARIS
429/* Unchecked */
430extern int gethostname(char *, int);
431#endif
432
433#ifdef __BEOS__
434/* Unchecked */
435/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000436int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000437#endif
438
439#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000440#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000441extern char * _getpty(int *, int, mode_t, int);
442#endif
443
444#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
445#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
446/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
447 functions, even though they are included in libutil. */
448#include <termios.h>
449extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
450extern int forkpty(int *, char *, struct termios *, struct winsize *);
451#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
452#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
453
454
455/* These are pulled from various places. It isn't obvious on what platforms
456 they are necessary, nor what the exact prototype should look like (which
457 is likely to vary between platforms!) If you find you need one of these
458 declarations, please move them to a platform-specific block and include
459 proper prototypes. */
460#if 0
461
462/* From Modules/resource.c */
463extern int getrusage();
464extern int getpagesize();
465
466/* From Python/sysmodule.c and Modules/posixmodule.c */
467extern int fclose(FILE *);
468
469/* From Modules/posixmodule.c */
470extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000471#endif /* 0 */
472
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000473
474/************************
475 * WRAPPER FOR <math.h> *
476 ************************/
477
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000478#ifndef HAVE_HYPOT
479extern double hypot(double, double);
Tim Peters60f42b52001-01-18 03:03:16 +0000480#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000481
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000482
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000483/* On 4.4BSD-descendants, ctype functions serves the whole range of
484 * wchar_t character set rather than single byte code points only.
485 * This characteristic can break some operations of string object
486 * including str.upper() and str.split() on UTF-8 locales. This
487 * workaround was provided by Tim Robbins of FreeBSD project.
488 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000489
490#ifdef __FreeBSD__
491#include <osreldate.h>
492#if __FreeBSD_version > 500039
493#include <ctype.h>
494#include <wctype.h>
495#undef isalnum
496#define isalnum(c) iswalnum(btowc(c))
497#undef isalpha
498#define isalpha(c) iswalpha(btowc(c))
499#undef islower
500#define islower(c) iswlower(btowc(c))
501#undef isspace
502#define isspace(c) iswspace(btowc(c))
503#undef isupper
504#define isupper(c) iswupper(btowc(c))
505#undef tolower
506#define tolower(c) towlower(btowc(c))
507#undef toupper
508#define toupper(c) towupper(btowc(c))
509#endif
510#endif
511
512
Mark Hammond8235ea12002-07-19 06:55:41 +0000513/* Declarations for symbol visibility.
514
515 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000516 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000517 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000518 inside the Python core, they are private to the core.
519 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000520 external linkage depending on the platform.
521
522 As a number of platforms support/require "__declspec(dllimport/dllexport)",
523 we support a HAVE_DECLSPEC_DLL macro to save duplication.
524*/
525
Tim Peters4643bd92002-12-28 21:56:08 +0000526/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000527 All windows ports, except cygwin, are handled in PC/pyconfig.h.
528
529 BeOS and cygwin are the only other autoconf platform requiring special
530 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000531*/
532#if defined(__CYGWIN__) || defined(__BEOS__)
533# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000534#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000535
Jason Tishler30765592003-09-04 11:04:06 +0000536/* only get special linkage if built as shared or platform is Cygwin */
537#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000538# if defined(HAVE_DECLSPEC_DLL)
539# ifdef Py_BUILD_CORE
540# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000541# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000542 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000543 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
544# if defined(__CYGWIN__)
545# define PyMODINIT_FUNC __declspec(dllexport) void
546# else /* __CYGWIN__ */
547# define PyMODINIT_FUNC void
548# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000549# else /* Py_BUILD_CORE */
550 /* Building an extension module, or an embedded situation */
551 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000552 /* Under Cygwin, auto-import functions to prevent compilation */
553 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
554# if !defined(__CYGWIN__)
555# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
556# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000557# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000558 /* module init functions outside the core must be exported */
559# if defined(__cplusplus)
560# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
561# else /* __cplusplus */
562# define PyMODINIT_FUNC __declspec(dllexport) void
563# endif /* __cplusplus */
564# endif /* Py_BUILD_CORE */
565# endif /* HAVE_DECLSPEC */
566#endif /* Py_ENABLE_SHARED */
567
568/* If no external linkage macros defined by now, create defaults */
569#ifndef PyAPI_FUNC
570# define PyAPI_FUNC(RTYPE) RTYPE
571#endif
572#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000573# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000574#endif
575#ifndef PyMODINIT_FUNC
576# if defined(__cplusplus)
577# define PyMODINIT_FUNC extern "C" void
578# else /* __cplusplus */
579# define PyMODINIT_FUNC void
580# endif /* __cplusplus */
581#endif
582
583/* Deprecated DL_IMPORT and DL_EXPORT macros */
584#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
585# if defined(Py_BUILD_CORE)
586# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
587# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
588# else
589# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
590# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
591# endif
592#endif
593#ifndef DL_EXPORT
594# define DL_EXPORT(RTYPE) RTYPE
595#endif
596#ifndef DL_IMPORT
597# define DL_IMPORT(RTYPE) RTYPE
598#endif
599/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000600
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000601/* If the fd manipulation macros aren't defined,
602 here is a set that should do the job */
603
Guido van Rossum367e46a2000-08-01 18:28:44 +0000604#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000605
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000606#ifndef FD_SETSIZE
607#define FD_SETSIZE 256
608#endif
609
610#ifndef FD_SET
611
612typedef long fd_mask;
613
614#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
615#ifndef howmany
616#define howmany(x, y) (((x)+((y)-1))/(y))
617#endif /* howmany */
618
619typedef struct fd_set {
620 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
621} fd_set;
622
623#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
624#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
625#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
626#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
627
628#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000629
630#endif /* fd manipulation macros */
631
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000632
Fred Draked5fadf72000-09-26 05:46:01 +0000633/* limits.h constants that may be missing */
634
635#ifndef INT_MAX
636#define INT_MAX 2147483647
637#endif
638
639#ifndef LONG_MAX
640#if SIZEOF_LONG == 4
641#define LONG_MAX 0X7FFFFFFFL
642#elif SIZEOF_LONG == 8
643#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
644#else
645#error "could not set LONG_MAX in pyport.h"
646#endif
647#endif
648
649#ifndef LONG_MIN
650#define LONG_MIN (-LONG_MAX-1)
651#endif
652
Tim Petersd57731f2000-10-05 01:42:25 +0000653#ifndef LONG_BIT
654#define LONG_BIT (8 * SIZEOF_LONG)
655#endif
656
657#if LONG_BIT != 8 * SIZEOF_LONG
658/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
659 * 32-bit platforms using gcc. We try to catch that here at compile-time
660 * rather than waiting for integer multiplication to trigger bogus
661 * overflows.
662 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000663#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000664#endif
665
Tim Peters7d3a5112000-07-08 04:17:21 +0000666#ifdef __cplusplus
667}
668#endif
669
Neil Schemenauer15691082001-10-23 02:20:37 +0000670/*
671 * Hide GCC attributes from compilers that don't support them.
672 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000673#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000674 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000675 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000676#define Py_GCC_ATTRIBUTE(x)
677#else
678#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000679#endif
680
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000681/* Eliminate end-of-loop code not reached warnings from SunPro C
682 * when using do{...}while(0) macros
683 */
684#ifdef __SUNPRO_C
685#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
686#endif
687
Tim Peters7d3a5112000-07-08 04:17:21 +0000688#endif /* Py_PYPORT_H */