blob: 7c684f7320f32e25700b2566cf03a40196a91b5d [file] [log] [blame]
Tim Peters7d3a5112000-07-08 04:17:21 +00001#ifndef Py_PYPORT_H
Vladimir Marangozov14a4d882000-07-10 04:59:49 +00002#define Py_PYPORT_H
Tim Peters7d3a5112000-07-08 04:17:21 +00003
Martin v. Löwis4f1cd8b2001-07-26 13:41:06 +00004#include "pyconfig.h" /* include for defines */
Peter Schneider-Kamp25f68942000-07-31 22:19:30 +00005
Martin v. Löwis40e9aed2006-10-02 15:20:37 +00006#ifdef HAVE_STDINT_H
7#include <stdint.h>
8#endif
9
Tim Peters7d3a5112000-07-08 04:17:21 +000010/**************************************************************************
11Symbols and macros to supply platform-independent interfaces to basic
Tim Peters1be46842000-07-23 18:10:18 +000012C language & library operations whose spellings vary across platforms.
Tim Peters7d3a5112000-07-08 04:17:21 +000013
14Please try to make documentation here as clear as possible: by definition,
15the stuff here is trying to illuminate C's darkest corners.
16
17Config #defines referenced here:
18
19SIGNED_RIGHT_SHIFT_ZERO_FILLS
20Meaning: To be defined iff i>>j does not extend the sign bit when i is a
21 signed integral type and i < 0.
22Used in: Py_ARITHMETIC_RIGHT_SHIFT
Tim Peters1be46842000-07-23 18:10:18 +000023
Tim Peters8315ea52000-07-23 19:28:35 +000024Py_DEBUG
25Meaning: Extra checks compiled in for debug mode.
26Used in: Py_SAFE_DOWNCAST
Barry Warsawfd847b22000-08-18 04:48:18 +000027
28HAVE_UINTPTR_T
29Meaning: The C9X type uintptr_t is supported by the compiler
30Used in: Py_uintptr_t
31
32HAVE_LONG_LONG
33Meaning: The compiler supports the C type "long long"
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000034Used in: PY_LONG_LONG
Barry Warsawfd847b22000-08-18 04:48:18 +000035
Tim Peters7d3a5112000-07-08 04:17:21 +000036**************************************************************************/
37
38
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000039/* For backward compatibility only. Obsolete, do not use. */
Vladimir Marangozove2bf7e62000-09-08 12:55:35 +000040#ifdef HAVE_PROTOTYPES
41#define Py_PROTO(x) x
42#else
43#define Py_PROTO(x) ()
44#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000045#ifndef Py_FPROTO
46#define Py_FPROTO(x) Py_PROTO(x)
47#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000048
Barry Warsawfd847b22000-08-18 04:48:18 +000049/* typedefs for some C9X-defined synonyms for integral types.
50 *
51 * The names in Python are exactly the same as the C9X names, except with a
52 * Py_ prefix. Until C9X is universally implemented, this is the only way
53 * to ensure that Python gets reliable names that don't conflict with names
54 * in non-Python code that are playing their own tricks to define the C9X
55 * names.
56 *
57 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
58 * integral synonyms. Only define the ones we actually need.
59 */
60
61#ifdef HAVE_LONG_LONG
Martin v. Löwisb9a0f912003-03-29 10:06:18 +000062#ifndef PY_LONG_LONG
63#define PY_LONG_LONG long long
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000064#if defined(LLONG_MAX)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000065/* If LLONG_MAX is defined in limits.h, use that. */
Martin v. Löwis6371cd82007-06-09 07:42:52 +000066#define PY_LLONG_MIN LLONG_MIN
67#define PY_LLONG_MAX LLONG_MAX
68#define PY_ULLONG_MAX ULLONG_MAX
Martin v. Löwis2a71a472007-06-13 03:42:19 +000069#elif defined(__LONG_LONG_MAX__)
70/* Otherwise, if GCC has a builtin define, use that. */
71#define PY_LLONG_MAX __LONG_LONG_MAX__
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000072#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis2a71a472007-06-13 03:42:19 +000073#define PY_ULLONG_MAX (__LONG_LONG_MAX__*2ULL + 1ULL)
74#else
75/* Otherwise, rely on two's complement. */
76#define PY_ULLONG_MAX (~0ULL)
77#define PY_LLONG_MAX ((long long)(PY_ULLONG_MAX>>1))
78#define PY_LLONG_MIN (-PY_LLONG_MAX-1)
Martin v. Löwis9201e7f2007-06-09 10:10:26 +000079#endif /* LLONG_MAX */
Barry Warsawfd847b22000-08-18 04:48:18 +000080#endif
81#endif /* HAVE_LONG_LONG */
82
83/* uintptr_t is the C9X name for an unsigned integral type such that a
84 * legitimate void* can be cast to uintptr_t and then back to void* again
Tim Peters79248aa2001-08-29 21:37:10 +000085 * without loss of information. Similarly for intptr_t, wrt a signed
86 * integral type.
Barry Warsawfd847b22000-08-18 04:48:18 +000087 */
88#ifdef HAVE_UINTPTR_T
Tim Peters79248aa2001-08-29 21:37:10 +000089typedef uintptr_t Py_uintptr_t;
90typedef intptr_t Py_intptr_t;
91
Barry Warsawfd847b22000-08-18 04:48:18 +000092#elif SIZEOF_VOID_P <= SIZEOF_INT
Tim Peters79248aa2001-08-29 21:37:10 +000093typedef unsigned int Py_uintptr_t;
94typedef int Py_intptr_t;
95
Barry Warsawfd847b22000-08-18 04:48:18 +000096#elif SIZEOF_VOID_P <= SIZEOF_LONG
Tim Peters79248aa2001-08-29 21:37:10 +000097typedef unsigned long Py_uintptr_t;
98typedef long Py_intptr_t;
99
Barry Warsawfd847b22000-08-18 04:48:18 +0000100#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
Martin v. Löwisb9a0f912003-03-29 10:06:18 +0000101typedef unsigned PY_LONG_LONG Py_uintptr_t;
102typedef PY_LONG_LONG Py_intptr_t;
Tim Peters79248aa2001-08-29 21:37:10 +0000103
Barry Warsawfd847b22000-08-18 04:48:18 +0000104#else
105# error "Python needs a typedef for Py_uintptr_t in pyport.h."
106#endif /* HAVE_UINTPTR_T */
107
Tim Petersae1d0c92006-03-17 03:29:34 +0000108/* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
109 * sizeof(size_t). C99 doesn't define such a thing directly (size_t is an
110 * unsigned integral type). See PEP 353 for details.
111 */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000112#ifdef HAVE_SSIZE_T
113typedef ssize_t Py_ssize_t;
114#elif SIZEOF_VOID_P == SIZEOF_SIZE_T
Martin v. Löwis2d65b552006-02-18 18:26:55 +0000115typedef Py_intptr_t Py_ssize_t;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000116#else
117# error "Python needs a typedef for Py_ssize_t in pyport.h."
118#endif
Tim Petersae1d0c92006-03-17 03:29:34 +0000119
120/* Largest positive value of type Py_ssize_t. */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000121#define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
Tim Peters3b1c01d2006-04-05 18:43:30 +0000122/* Smallest negative value of type Py_ssize_t. */
Martin v. Löwisc48c8db2006-04-05 18:21:17 +0000123#define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000124
Christian Heimes951cc0f2008-01-31 23:08:23 +0000125#if SIZEOF_PID_T > SIZEOF_LONG
126# error "Python doesn't support sizeof(pid_t) > sizeof(long)"
127#endif
128
Tim Petersae1d0c92006-03-17 03:29:34 +0000129/* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
130 * format to convert an argument with the width of a size_t or Py_ssize_t.
131 * C99 introduced "z" for this purpose, but not all platforms support that;
132 * e.g., MS compilers use "I" instead.
133 *
134 * These "high level" Python format functions interpret "z" correctly on
135 * all platforms (Python interprets the format string itself, and does whatever
136 * the platform C requires to convert a size_t/Py_ssize_t argument):
137 *
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000138 * PyString_FromFormat
Tim Petersae1d0c92006-03-17 03:29:34 +0000139 * PyErr_Format
Gregory P. Smithdd96db62008-06-09 04:58:54 +0000140 * PyString_FromFormatV
Tim Petersae1d0c92006-03-17 03:29:34 +0000141 *
142 * Lower-level uses require that you interpolate the correct format modifier
143 * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
144 * example,
145 *
146 * Py_ssize_t index;
147 * fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
148 *
149 * That will expand to %ld, or %Id, or to something else correct for a
150 * Py_ssize_t on the platform.
151 */
152#ifndef PY_FORMAT_SIZE_T
Neal Norwitz02743ca2006-09-22 08:47:23 +0000153# if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
Neal Norwitz4a8fbdb2006-09-22 08:16:26 +0000154# define PY_FORMAT_SIZE_T ""
Neal Norwitz02743ca2006-09-22 08:47:23 +0000155# elif SIZEOF_SIZE_T == SIZEOF_LONG
156# define PY_FORMAT_SIZE_T "l"
Tim Petersae1d0c92006-03-17 03:29:34 +0000157# elif defined(MS_WINDOWS)
158# define PY_FORMAT_SIZE_T "I"
159# else
160# error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
161# endif
162#endif
163
Fredrik Lundh7a830892006-05-27 10:39:48 +0000164/* Py_LOCAL can be used instead of static to get the fastest possible calling
165 * convention for functions that are local to a given module.
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000166 *
Fredrik Lundh7a830892006-05-27 10:39:48 +0000167 * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
168 * for platforms that support that.
169 *
170 * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
171 * "aggressive" inlining/optimizaion is enabled for the entire module. This
172 * may lead to code bloat, and may slow things down for those reasons. It may
173 * also lead to errors, if the code relies on pointer aliasing. Use with
174 * care.
Fredrik Lundh57640f52006-05-26 11:54:04 +0000175 *
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000176 * NOTE: You can only use this for functions that are entirely local to a
177 * module; functions that are exported via method tables, callbacks, etc,
178 * should keep using static.
179 */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000180
181#undef USE_INLINE /* XXX - set via configure? */
182
183#if defined(_MSC_VER)
Fredrik Lundh57640f52006-05-26 11:54:04 +0000184#if defined(PY_LOCAL_AGGRESSIVE)
185/* enable more aggressive optimization for visual studio */
186#pragma optimize("agtw", on)
187#endif
Fredrik Lundh95e2a912006-05-26 11:38:15 +0000188/* ignore warnings if the compiler decides not to inline a function */
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000189#pragma warning(disable: 4710)
190/* fastest possible local call under MSVC */
Fredrik Lundh7a830892006-05-27 10:39:48 +0000191#define Py_LOCAL(type) static type __fastcall
192#define Py_LOCAL_INLINE(type) static __inline type __fastcall
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000193#elif defined(USE_INLINE)
Fredrik Lundh7a830892006-05-27 10:39:48 +0000194#define Py_LOCAL(type) static type
195#define Py_LOCAL_INLINE(type) static inline type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000196#else
197#define Py_LOCAL(type) static type
Fredrik Lundh7a830892006-05-27 10:39:48 +0000198#define Py_LOCAL_INLINE(type) static type
Fredrik Lundhb8b3c8e2006-05-26 11:29:39 +0000199#endif
200
Fredrik Lundh80f8e802006-05-28 12:06:46 +0000201/* Py_MEMCPY can be used instead of memcpy in cases where the copied blocks
202 * are often very short. While most platforms have highly optimized code for
203 * large transfers, the setup costs for memcpy are often quite high. MEMCPY
204 * solves this by doing short copies "in line".
205 */
206
207#if defined(_MSC_VER)
208#define Py_MEMCPY(target, source, length) do { \
209 size_t i_, n_ = (length); \
210 char *t_ = (void*) (target); \
211 const char *s_ = (void*) (source); \
212 if (n_ >= 16) \
213 memcpy(t_, s_, n_); \
214 else \
215 for (i_ = 0; i_ < n_; i_++) \
216 t_[i_] = s_[i_]; \
217 } while (0)
218#else
219#define Py_MEMCPY memcpy
220#endif
221
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000222#include <stdlib.h>
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000223
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000224#include <math.h> /* Moved here from the math section, before extern "C" */
225
226/********************************************
227 * WRAPPER FOR <time.h> and/or <sys/time.h> *
228 ********************************************/
229
230#ifdef TIME_WITH_SYS_TIME
231#include <sys/time.h>
232#include <time.h>
233#else /* !TIME_WITH_SYS_TIME */
234#ifdef HAVE_SYS_TIME_H
235#include <sys/time.h>
236#else /* !HAVE_SYS_TIME_H */
237#include <time.h>
238#endif /* !HAVE_SYS_TIME_H */
239#endif /* !TIME_WITH_SYS_TIME */
240
241
242/******************************
243 * WRAPPER FOR <sys/select.h> *
244 ******************************/
245
246/* NB caller must include <sys/types.h> */
247
248#ifdef HAVE_SYS_SELECT_H
249
250#include <sys/select.h>
251
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000252#endif /* !HAVE_SYS_SELECT_H */
253
Tim Peters60f42b52001-01-18 03:03:16 +0000254/*******************************
255 * stat() and fstat() fiddling *
256 *******************************/
257
258/* We expect that stat and fstat exist on most systems.
259 * It's confirmed on Unix, Mac and Windows.
260 * If you don't have them, add
261 * #define DONT_HAVE_STAT
262 * and/or
263 * #define DONT_HAVE_FSTAT
Tim Peters76f373d2001-07-26 21:34:59 +0000264 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
Tim Peters60f42b52001-01-18 03:03:16 +0000265 * HAVE_FSTAT instead.
266 * Also
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000267 * #define HAVE_SYS_STAT_H
268 * if <sys/stat.h> exists on your platform, and
Tim Peters60f42b52001-01-18 03:03:16 +0000269 * #define HAVE_STAT_H
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000270 * if <stat.h> does.
Tim Peters60f42b52001-01-18 03:03:16 +0000271 */
272#ifndef DONT_HAVE_STAT
273#define HAVE_STAT
274#endif
275
276#ifndef DONT_HAVE_FSTAT
277#define HAVE_FSTAT
278#endif
279
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000280#ifdef RISCOS
281#include <sys/types.h>
Martin v. Löwisa94568a2003-05-10 07:36:56 +0000282#include "unixstuff.h"
Guido van Rossume2ae77b2001-10-24 20:42:55 +0000283#endif
284
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +0000285#ifdef HAVE_SYS_STAT_H
Andrew MacIntyre5e090fc2002-02-26 11:20:01 +0000286#if defined(PYOS_OS2) && defined(PYCC_GCC)
287#include <sys/types.h>
288#endif
Tim Peters60f42b52001-01-18 03:03:16 +0000289#include <sys/stat.h>
290#elif defined(HAVE_STAT_H)
291#include <stat.h>
292#endif
293
Martin v. Löwisf9836ba2001-08-08 10:28:06 +0000294#if defined(PYCC_VACPP)
295/* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
296#define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
297#endif
298
299#ifndef S_ISREG
300#define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
301#endif
302
303#ifndef S_ISDIR
304#define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
305#endif
306
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000307
Tim Peters7d3a5112000-07-08 04:17:21 +0000308#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000309/* Move this down here since some C++ #include's don't like to be included
310 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000311extern "C" {
312#endif
313
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000314
Tim Peters7d3a5112000-07-08 04:17:21 +0000315/* Py_ARITHMETIC_RIGHT_SHIFT
316 * C doesn't define whether a right-shift of a signed integer sign-extends
317 * or zero-fills. Here a macro to force sign extension:
318 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
319 * Return I >> J, forcing sign extension.
320 * Requirements:
321 * I is of basic signed type TYPE (char, short, int, long, or long long).
322 * TYPE is one of char, short, int, long, or long long, although long long
323 * must not be used except on platforms that support it.
324 * J is an integer >= 0 and strictly less than the number of bits in TYPE
325 * (because C doesn't define what happens for J outside that range either).
326 * Caution:
327 * I may be evaluated more than once.
328 */
329#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
330#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
331 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
332#else
333#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
334#endif
335
Tim Peters39dce292000-08-15 03:34:48 +0000336/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000337 * "Simply" returns its argument. However, macro expansions within the
338 * argument are evaluated. This unfortunate trickery is needed to get
339 * token-pasting to work as desired in some cases.
340 */
341#define Py_FORCE_EXPANSION(X) X
342
Tim Peters8315ea52000-07-23 19:28:35 +0000343/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
344 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
345 * assert-fails if any information is lost.
346 * Caution:
347 * VALUE may be evaluated more than once.
348 */
349#ifdef Py_DEBUG
350#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
351 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
352#else
353#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
354#endif
355
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000356/* Py_SET_ERRNO_ON_MATH_ERROR(x)
Tim Petersa40c7932001-09-05 22:36:56 +0000357 * If a libm function did not set errno, but it looks like the result
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000358 * overflowed or not-a-number, set errno to ERANGE or EDOM. Set errno
359 * to 0 before calling a libm function, and invoke this macro after,
360 * passing the function result.
Tim Petersa40c7932001-09-05 22:36:56 +0000361 * Caution:
362 * This isn't reliable. See Py_OVERFLOWED comments.
363 * X is evaluated more than once.
364 */
Guido van Rossum539c6622005-09-14 17:49:54 +0000365#if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000366#define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
367#else
368#define _Py_SET_EDOM_FOR_NAN(X) ;
369#endif
370#define Py_SET_ERRNO_ON_MATH_ERROR(X) \
Tim Petersa40c7932001-09-05 22:36:56 +0000371 do { \
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000372 if (errno == 0) { \
373 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
374 errno = ERANGE; \
375 else _Py_SET_EDOM_FOR_NAN(X) \
376 } \
Tim Petersa40c7932001-09-05 22:36:56 +0000377 } while(0)
Tim Peters57f282a2001-09-05 05:38:10 +0000378
Hye-Shik Chang77d9a3e2004-03-22 08:43:55 +0000379/* Py_SET_ERANGE_ON_OVERFLOW(x)
380 * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
381 */
382#define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
383
Tim Petersdc5a5082002-03-09 04:58:24 +0000384/* Py_ADJUST_ERANGE1(x)
385 * Py_ADJUST_ERANGE2(x, y)
386 * Set errno to 0 before calling a libm function, and invoke one of these
387 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
388 * for functions returning complex results). This makes two kinds of
389 * adjustments to errno: (A) If it looks like the platform libm set
390 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
391 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
392 * effect, we're trying to force a useful implementation of C89 errno
393 * behavior.
394 * Caution:
395 * This isn't reliable. See Py_OVERFLOWED comments.
396 * X and Y may be evaluated more than once.
397 */
398#define Py_ADJUST_ERANGE1(X) \
399 do { \
400 if (errno == 0) { \
401 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
402 errno = ERANGE; \
403 } \
404 else if (errno == ERANGE && (X) == 0.0) \
405 errno = 0; \
406 } while(0)
407
408#define Py_ADJUST_ERANGE2(X, Y) \
409 do { \
410 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
411 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
412 if (errno == 0) \
413 errno = ERANGE; \
414 } \
415 else if (errno == ERANGE) \
416 errno = 0; \
417 } while(0)
418
Neal Norwitz80292642002-12-19 15:12:26 +0000419/* Py_DEPRECATED(version)
Neal Norwitz93344ab2002-12-19 15:24:11 +0000420 * Declare a variable, type, or function deprecated.
Neal Norwitz80292642002-12-19 15:12:26 +0000421 * Usage:
422 * extern int old_var Py_DEPRECATED(2.3);
423 * typedef int T1 Py_DEPRECATED(2.4);
424 * extern int x() Py_DEPRECATED(2.5);
425 */
Neal Norwitz3dd8be42006-03-20 06:33:01 +0000426#if defined(__GNUC__) && ((__GNUC__ >= 4) || \
427 (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
Neal Norwitz80292642002-12-19 15:12:26 +0000428#define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
429#else
Tim Peters4643bd92002-12-28 21:56:08 +0000430#define Py_DEPRECATED(VERSION_UNUSED)
Neal Norwitz80292642002-12-19 15:12:26 +0000431#endif
432
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000433/**************************************************************************
434Prototypes that are missing from the standard include files on some systems
435(and possibly only some versions of such systems.)
436
437Please be conservative with adding new ones, document them and enclose them
438in platform-specific #ifdefs.
439**************************************************************************/
440
441#ifdef SOLARIS
442/* Unchecked */
443extern int gethostname(char *, int);
444#endif
445
446#ifdef __BEOS__
447/* Unchecked */
448/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000449int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000450#endif
451
452#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000453#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000454extern char * _getpty(int *, int, mode_t, int);
455#endif
456
Martin v. Löwis8c255e42008-05-23 15:06:50 +0000457/* On QNX 6, struct termio must be declared by including sys/termio.h
458 if TCGETA, TCSETA, TCSETAW, or TCSETAF are used. sys/termio.h must
459 be included before termios.h or it will generate an error. */
460#ifdef HAVE_SYS_TERMIO_H
461#include <sys/termio.h>
462#endif
463
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000464#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
465#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
466/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
467 functions, even though they are included in libutil. */
468#include <termios.h>
469extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
Christian Heimes951cc0f2008-01-31 23:08:23 +0000470extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000471#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
472#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
473
474
475/* These are pulled from various places. It isn't obvious on what platforms
476 they are necessary, nor what the exact prototype should look like (which
477 is likely to vary between platforms!) If you find you need one of these
478 declarations, please move them to a platform-specific block and include
479 proper prototypes. */
480#if 0
481
482/* From Modules/resource.c */
483extern int getrusage();
484extern int getpagesize();
485
486/* From Python/sysmodule.c and Modules/posixmodule.c */
487extern int fclose(FILE *);
488
489/* From Modules/posixmodule.c */
490extern int fdatasync(int);
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000491#endif /* 0 */
492
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000493
Hye-Shik Changf3032612006-03-22 08:52:43 +0000494/* On 4.4BSD-descendants, ctype functions serves the whole range of
495 * wchar_t character set rather than single byte code points only.
496 * This characteristic can break some operations of string object
497 * including str.upper() and str.split() on UTF-8 locales. This
498 * workaround was provided by Tim Robbins of FreeBSD project.
499 */
Hye-Shik Changb5047fd2004-08-04 06:33:51 +0000500
501#ifdef __FreeBSD__
502#include <osreldate.h>
503#if __FreeBSD_version > 500039
504#include <ctype.h>
505#include <wctype.h>
506#undef isalnum
507#define isalnum(c) iswalnum(btowc(c))
508#undef isalpha
509#define isalpha(c) iswalpha(btowc(c))
510#undef islower
511#define islower(c) iswlower(btowc(c))
512#undef isspace
513#define isspace(c) iswspace(btowc(c))
514#undef isupper
515#define isupper(c) iswupper(btowc(c))
516#undef tolower
517#define tolower(c) towlower(btowc(c))
518#undef toupper
519#define toupper(c) towupper(btowc(c))
520#endif
521#endif
522
523
Mark Hammond8235ea12002-07-19 06:55:41 +0000524/* Declarations for symbol visibility.
525
526 PyAPI_FUNC(type): Declares a public Python API function and return type
Tim Peters4643bd92002-12-28 21:56:08 +0000527 PyAPI_DATA(type): Declares public Python data and its type
Mark Hammond8235ea12002-07-19 06:55:41 +0000528 PyMODINIT_FUNC: A Python module init function. If these functions are
Tim Peters4643bd92002-12-28 21:56:08 +0000529 inside the Python core, they are private to the core.
530 If in an extension module, it may be declared with
Mark Hammond8235ea12002-07-19 06:55:41 +0000531 external linkage depending on the platform.
532
533 As a number of platforms support/require "__declspec(dllimport/dllexport)",
534 we support a HAVE_DECLSPEC_DLL macro to save duplication.
535*/
536
Tim Peters4643bd92002-12-28 21:56:08 +0000537/*
Michael W. Hudsonf163d102003-02-10 19:36:46 +0000538 All windows ports, except cygwin, are handled in PC/pyconfig.h.
539
540 BeOS and cygwin are the only other autoconf platform requiring special
541 linkage handling and both of these use __declspec().
Mark Hammond8235ea12002-07-19 06:55:41 +0000542*/
543#if defined(__CYGWIN__) || defined(__BEOS__)
544# define HAVE_DECLSPEC_DLL
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000545#endif
Mark Hammond8235ea12002-07-19 06:55:41 +0000546
Jason Tishler30765592003-09-04 11:04:06 +0000547/* only get special linkage if built as shared or platform is Cygwin */
548#if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
Mark Hammond8235ea12002-07-19 06:55:41 +0000549# if defined(HAVE_DECLSPEC_DLL)
550# ifdef Py_BUILD_CORE
551# define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
Mark Hammonda2905272002-07-29 13:42:14 +0000552# define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000553 /* module init functions inside the core need no external linkage */
Jason Tishler6bc06ec2003-09-04 11:59:50 +0000554 /* except for Cygwin to handle embedding (FIXME: BeOS too?) */
555# if defined(__CYGWIN__)
556# define PyMODINIT_FUNC __declspec(dllexport) void
557# else /* __CYGWIN__ */
558# define PyMODINIT_FUNC void
559# endif /* __CYGWIN__ */
Mark Hammond8235ea12002-07-19 06:55:41 +0000560# else /* Py_BUILD_CORE */
561 /* Building an extension module, or an embedded situation */
562 /* public Python functions and data are imported */
Jason Tishlerfb8595d2003-01-06 12:41:26 +0000563 /* Under Cygwin, auto-import functions to prevent compilation */
564 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
565# if !defined(__CYGWIN__)
566# define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
567# endif /* !__CYGWIN__ */
Mark Hammonda2905272002-07-29 13:42:14 +0000568# define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000569 /* module init functions outside the core must be exported */
570# if defined(__cplusplus)
571# define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
572# else /* __cplusplus */
573# define PyMODINIT_FUNC __declspec(dllexport) void
574# endif /* __cplusplus */
575# endif /* Py_BUILD_CORE */
576# endif /* HAVE_DECLSPEC */
577#endif /* Py_ENABLE_SHARED */
578
579/* If no external linkage macros defined by now, create defaults */
580#ifndef PyAPI_FUNC
581# define PyAPI_FUNC(RTYPE) RTYPE
582#endif
583#ifndef PyAPI_DATA
Mark Hammonda2905272002-07-29 13:42:14 +0000584# define PyAPI_DATA(RTYPE) extern RTYPE
Mark Hammond8235ea12002-07-19 06:55:41 +0000585#endif
586#ifndef PyMODINIT_FUNC
587# if defined(__cplusplus)
588# define PyMODINIT_FUNC extern "C" void
589# else /* __cplusplus */
590# define PyMODINIT_FUNC void
591# endif /* __cplusplus */
592#endif
593
594/* Deprecated DL_IMPORT and DL_EXPORT macros */
595#if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
596# if defined(Py_BUILD_CORE)
597# define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
598# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
599# else
600# define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
601# define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
602# endif
603#endif
604#ifndef DL_EXPORT
605# define DL_EXPORT(RTYPE) RTYPE
606#endif
607#ifndef DL_IMPORT
608# define DL_IMPORT(RTYPE) RTYPE
609#endif
610/* End of deprecated DL_* macros */
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000611
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000612/* If the fd manipulation macros aren't defined,
613 here is a set that should do the job */
614
Guido van Rossum367e46a2000-08-01 18:28:44 +0000615#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000616
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000617#ifndef FD_SETSIZE
618#define FD_SETSIZE 256
619#endif
620
621#ifndef FD_SET
622
623typedef long fd_mask;
624
625#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
626#ifndef howmany
627#define howmany(x, y) (((x)+((y)-1))/(y))
628#endif /* howmany */
629
630typedef struct fd_set {
631 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
632} fd_set;
633
634#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
635#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
636#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
637#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
638
639#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000640
641#endif /* fd manipulation macros */
642
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000643
Fred Draked5fadf72000-09-26 05:46:01 +0000644/* limits.h constants that may be missing */
645
646#ifndef INT_MAX
647#define INT_MAX 2147483647
648#endif
649
650#ifndef LONG_MAX
651#if SIZEOF_LONG == 4
652#define LONG_MAX 0X7FFFFFFFL
653#elif SIZEOF_LONG == 8
654#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
655#else
656#error "could not set LONG_MAX in pyport.h"
657#endif
658#endif
659
660#ifndef LONG_MIN
661#define LONG_MIN (-LONG_MAX-1)
662#endif
663
Tim Petersd57731f2000-10-05 01:42:25 +0000664#ifndef LONG_BIT
665#define LONG_BIT (8 * SIZEOF_LONG)
666#endif
667
668#if LONG_BIT != 8 * SIZEOF_LONG
669/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
670 * 32-bit platforms using gcc. We try to catch that here at compile-time
671 * rather than waiting for integer multiplication to trigger bogus
672 * overflows.
673 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000674#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000675#endif
676
Tim Peters7d3a5112000-07-08 04:17:21 +0000677#ifdef __cplusplus
678}
679#endif
680
Neil Schemenauer15691082001-10-23 02:20:37 +0000681/*
682 * Hide GCC attributes from compilers that don't support them.
683 */
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000684#if (!defined(__GNUC__) || __GNUC__ < 2 || \
Jack Jansen4892f242002-02-01 15:46:29 +0000685 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
Guido van Rossumbd67d6f2001-10-27 21:16:16 +0000686 !defined(RISCOS)
Neil Schemenauer96aa0ac2002-09-15 14:09:54 +0000687#define Py_GCC_ATTRIBUTE(x)
688#else
689#define Py_GCC_ATTRIBUTE(x) __attribute__(x)
Neil Schemenauer15691082001-10-23 02:20:37 +0000690#endif
691
Martin v. Löwisaac13162006-10-19 10:58:46 +0000692/*
693 * Add PyArg_ParseTuple format where available.
694 */
695#ifdef HAVE_ATTRIBUTE_FORMAT_PARSETUPLE
696#define Py_FORMAT_PARSETUPLE(func,p1,p2) __attribute__((format(func,p1,p2)))
697#else
698#define Py_FORMAT_PARSETUPLE(func,p1,p2)
699#endif
700
Nicholas Bastin9ba301e2004-07-15 15:54:05 +0000701/* Eliminate end-of-loop code not reached warnings from SunPro C
702 * when using do{...}while(0) macros
703 */
704#ifdef __SUNPRO_C
705#pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
706#endif
707
Martin v. Löwisa43190b2006-05-22 09:15:18 +0000708/*
709 * Older Microsoft compilers don't support the C99 long long literal suffixes,
710 * so these will be defined in PC/pyconfig.h for those compilers.
711 */
712#ifndef Py_LL
713#define Py_LL(x) x##LL
714#endif
715
716#ifndef Py_ULL
717#define Py_ULL(x) Py_LL(x##U)
718#endif
719
Tim Peters7d3a5112000-07-08 04:17:21 +0000720#endif /* Py_PYPORT_H */