This commit was manufactured by cvs2svn to create tag 'r234c1'.
[python/dscho.git] / Include / pyport.h
blobffd46aceb95a97c5c630c6d72c6018690b17c04a
1 #ifndef Py_PYPORT_H
2 #define Py_PYPORT_H
4 #include "pyconfig.h" /* include for defines */
6 /**************************************************************************
7 Symbols and macros to supply platform-independent interfaces to basic
8 C language & library operations whose spellings vary across platforms.
10 Please try to make documentation here as clear as possible: by definition,
11 the stuff here is trying to illuminate C's darkest corners.
13 Config #defines referenced here:
15 SIGNED_RIGHT_SHIFT_ZERO_FILLS
16 Meaning: To be defined iff i>>j does not extend the sign bit when i is a
17 signed integral type and i < 0.
18 Used in: Py_ARITHMETIC_RIGHT_SHIFT
20 Py_DEBUG
21 Meaning: Extra checks compiled in for debug mode.
22 Used in: Py_SAFE_DOWNCAST
24 HAVE_UINTPTR_T
25 Meaning: The C9X type uintptr_t is supported by the compiler
26 Used in: Py_uintptr_t
28 HAVE_LONG_LONG
29 Meaning: The compiler supports the C type "long long"
30 Used in: PY_LONG_LONG
32 **************************************************************************/
35 /* For backward compatibility only. Obsolete, do not use. */
36 #ifdef HAVE_PROTOTYPES
37 #define Py_PROTO(x) x
38 #else
39 #define Py_PROTO(x) ()
40 #endif
41 #ifndef Py_FPROTO
42 #define Py_FPROTO(x) Py_PROTO(x)
43 #endif
45 /* typedefs for some C9X-defined synonyms for integral types.
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.
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.
57 #ifdef HAVE_LONG_LONG
58 #ifndef PY_LONG_LONG
59 #define PY_LONG_LONG long long
60 #endif
61 #endif /* HAVE_LONG_LONG */
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
65 * without loss of information. Similarly for intptr_t, wrt a signed
66 * integral type.
68 #ifdef HAVE_UINTPTR_T
69 typedef uintptr_t Py_uintptr_t;
70 typedef intptr_t Py_intptr_t;
72 #elif SIZEOF_VOID_P <= SIZEOF_INT
73 typedef unsigned int Py_uintptr_t;
74 typedef int Py_intptr_t;
76 #elif SIZEOF_VOID_P <= SIZEOF_LONG
77 typedef unsigned long Py_uintptr_t;
78 typedef long Py_intptr_t;
80 #elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
81 typedef unsigned PY_LONG_LONG Py_uintptr_t;
82 typedef PY_LONG_LONG Py_intptr_t;
84 #else
85 # error "Python needs a typedef for Py_uintptr_t in pyport.h."
86 #endif /* HAVE_UINTPTR_T */
88 #ifdef HAVE_STDLIB_H
89 #include <stdlib.h>
90 #endif
92 #include <math.h> /* Moved here from the math section, before extern "C" */
94 /********************************************
95 * WRAPPER FOR <time.h> and/or <sys/time.h> *
96 ********************************************/
98 #ifdef TIME_WITH_SYS_TIME
99 #include <sys/time.h>
100 #include <time.h>
101 #else /* !TIME_WITH_SYS_TIME */
102 #ifdef HAVE_SYS_TIME_H
103 #include <sys/time.h>
104 #else /* !HAVE_SYS_TIME_H */
105 #include <time.h>
106 #endif /* !HAVE_SYS_TIME_H */
107 #endif /* !TIME_WITH_SYS_TIME */
110 /******************************
111 * WRAPPER FOR <sys/select.h> *
112 ******************************/
114 /* NB caller must include <sys/types.h> */
116 #ifdef HAVE_SYS_SELECT_H
118 #include <sys/select.h>
120 #endif /* !HAVE_SYS_SELECT_H */
122 /*******************************
123 * stat() and fstat() fiddling *
124 *******************************/
126 /* We expect that stat and fstat exist on most systems.
127 * It's confirmed on Unix, Mac and Windows.
128 * If you don't have them, add
129 * #define DONT_HAVE_STAT
130 * and/or
131 * #define DONT_HAVE_FSTAT
132 * to your pyconfig.h. Python code beyond this should check HAVE_STAT and
133 * HAVE_FSTAT instead.
134 * Also
135 * #define DONT_HAVE_SYS_STAT_H
136 * if <sys/stat.h> doesn't exist on your platform, and
137 * #define HAVE_STAT_H
138 * if <stat.h> does (don't look at me -- ths mess is inherited).
140 #ifndef DONT_HAVE_STAT
141 #define HAVE_STAT
142 #endif
144 #ifndef DONT_HAVE_FSTAT
145 #define HAVE_FSTAT
146 #endif
148 #ifdef RISCOS
149 #include <sys/types.h>
150 #include "unixstuff.h"
151 #endif
153 #ifndef DONT_HAVE_SYS_STAT_H
154 #if defined(PYOS_OS2) && defined(PYCC_GCC)
155 #include <sys/types.h>
156 #endif
157 #include <sys/stat.h>
158 #elif defined(HAVE_STAT_H)
159 #include <stat.h>
160 #endif
162 #if defined(PYCC_VACPP)
163 /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
164 #define S_IFMT (S_IFDIR|S_IFCHR|S_IFREG)
165 #endif
167 #ifndef S_ISREG
168 #define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
169 #endif
171 #ifndef S_ISDIR
172 #define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
173 #endif
176 #ifdef __cplusplus
177 /* Move this down here since some C++ #include's don't like to be included
178 inside an extern "C" */
179 extern "C" {
180 #endif
183 /* Py_ARITHMETIC_RIGHT_SHIFT
184 * C doesn't define whether a right-shift of a signed integer sign-extends
185 * or zero-fills. Here a macro to force sign extension:
186 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
187 * Return I >> J, forcing sign extension.
188 * Requirements:
189 * I is of basic signed type TYPE (char, short, int, long, or long long).
190 * TYPE is one of char, short, int, long, or long long, although long long
191 * must not be used except on platforms that support it.
192 * J is an integer >= 0 and strictly less than the number of bits in TYPE
193 * (because C doesn't define what happens for J outside that range either).
194 * Caution:
195 * I may be evaluated more than once.
197 #ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
198 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
199 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
200 #else
201 #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
202 #endif
204 /* Py_FORCE_EXPANSION(X)
205 * "Simply" returns its argument. However, macro expansions within the
206 * argument are evaluated. This unfortunate trickery is needed to get
207 * token-pasting to work as desired in some cases.
209 #define Py_FORCE_EXPANSION(X) X
211 /* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
212 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
213 * assert-fails if any information is lost.
214 * Caution:
215 * VALUE may be evaluated more than once.
217 #ifdef Py_DEBUG
218 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
219 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
220 #else
221 #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
222 #endif
224 /* Py_IS_INFINITY(X)
225 * Return 1 if float or double arg is an infinity, else 0.
226 * Caution:
227 * X is evaluated more than once.
228 * This implementation may set the underflow flag if |X| is very small;
229 * it really can't be implemented correctly (& easily) before C99.
231 #define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
233 /* HUGE_VAL is supposed to expand to a positive double infinity. Python
234 * uses Py_HUGE_VAL instead because some platforms are broken in this
235 * respect. We used to embed code in pyport.h to try to worm around that,
236 * but different platforms are broken in conflicting ways. If you're on
237 * a platform where HUGE_VAL is defined incorrectly, fiddle your Python
238 * config to #define Py_HUGE_VAL to something that works on your platform.
240 #ifndef Py_HUGE_VAL
241 #define Py_HUGE_VAL HUGE_VAL
242 #endif
244 /* Py_OVERFLOWED(X)
245 * Return 1 iff a libm function overflowed. Set errno to 0 before calling
246 * a libm function, and invoke this macro after, passing the function
247 * result.
248 * Caution:
249 * This isn't reliable. C99 no longer requires libm to set errno under
250 * any exceptional condition, but does require +- HUGE_VAL return
251 * values on overflow. A 754 box *probably* maps HUGE_VAL to a
252 * double infinity, and we're cool if that's so, unless the input
253 * was an infinity and an infinity is the expected result. A C89
254 * system sets errno to ERANGE, so we check for that too. We're
255 * out of luck if a C99 754 box doesn't map HUGE_VAL to +Inf, or
256 * if the returned result is a NaN, or if a C89 box returns HUGE_VAL
257 * in non-overflow cases.
258 * X is evaluated more than once.
259 * Some platforms have better way to spell this, so expect some #ifdef'ery.
261 * OpenBSD uses 'isinf()' because a compiler bug on that platform causes
262 * the longer macro version to be mis-compiled. This isn't optimal, and
263 * should be removed once a newer compiler is available on that platform.
264 * The system that had the failure was running OpenBSD 3.2 on Intel, with
265 * gcc 2.95.3.
267 * According to Tim's checkin, the FreeBSD systems use isinf() to work
268 * around a FPE bug on that platform.
270 #if defined(__FreeBSD__) || defined(__OpenBSD__)
271 #define Py_OVERFLOWED(X) isinf(X)
272 #else
273 #define Py_OVERFLOWED(X) ((X) != 0.0 && (errno == ERANGE || \
274 (X) == Py_HUGE_VAL || \
275 (X) == -Py_HUGE_VAL))
276 #endif
278 /* Py_SET_ERANGE_ON_OVERFLOW(x)
279 * If a libm function did not set errno, but it looks like the result
280 * overflowed, set errno to ERANGE. Set errno to 0 before calling a libm
281 * function, and invoke this macro after, passing the function result.
282 * Caution:
283 * This isn't reliable. See Py_OVERFLOWED comments.
284 * X is evaluated more than once.
286 #define Py_SET_ERANGE_IF_OVERFLOW(X) \
287 do { \
288 if (errno == 0 && ((X) == Py_HUGE_VAL || \
289 (X) == -Py_HUGE_VAL)) \
290 errno = ERANGE; \
291 } while(0)
293 /* Py_ADJUST_ERANGE1(x)
294 * Py_ADJUST_ERANGE2(x, y)
295 * Set errno to 0 before calling a libm function, and invoke one of these
296 * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
297 * for functions returning complex results). This makes two kinds of
298 * adjustments to errno: (A) If it looks like the platform libm set
299 * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
300 * platform libm overflowed but didn't set errno, force errno to ERANGE. In
301 * effect, we're trying to force a useful implementation of C89 errno
302 * behavior.
303 * Caution:
304 * This isn't reliable. See Py_OVERFLOWED comments.
305 * X and Y may be evaluated more than once.
307 #define Py_ADJUST_ERANGE1(X) \
308 do { \
309 if (errno == 0) { \
310 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
311 errno = ERANGE; \
313 else if (errno == ERANGE && (X) == 0.0) \
314 errno = 0; \
315 } while(0)
317 #define Py_ADJUST_ERANGE2(X, Y) \
318 do { \
319 if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL || \
320 (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) { \
321 if (errno == 0) \
322 errno = ERANGE; \
324 else if (errno == ERANGE) \
325 errno = 0; \
326 } while(0)
328 /* Py_DEPRECATED(version)
329 * Declare a variable, type, or function deprecated.
330 * Usage:
331 * extern int old_var Py_DEPRECATED(2.3);
332 * typedef int T1 Py_DEPRECATED(2.4);
333 * extern int x() Py_DEPRECATED(2.5);
335 #if defined(__GNUC__) && (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)
336 #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
337 #else
338 #define Py_DEPRECATED(VERSION_UNUSED)
339 #endif
341 /**************************************************************************
342 Prototypes that are missing from the standard include files on some systems
343 (and possibly only some versions of such systems.)
345 Please be conservative with adding new ones, document them and enclose them
346 in platform-specific #ifdefs.
347 **************************************************************************/
349 #ifdef SOLARIS
350 /* Unchecked */
351 extern int gethostname(char *, int);
352 #endif
354 #ifdef __BEOS__
355 /* Unchecked */
356 /* It's in the libs, but not the headers... - [cjh] */
357 int shutdown( int, int );
358 #endif
360 #ifdef HAVE__GETPTY
361 #include <sys/types.h> /* we need to import mode_t */
362 extern char * _getpty(int *, int, mode_t, int);
363 #endif
365 #if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
366 #if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
367 /* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
368 functions, even though they are included in libutil. */
369 #include <termios.h>
370 extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
371 extern int forkpty(int *, char *, struct termios *, struct winsize *);
372 #endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
373 #endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
376 /* These are pulled from various places. It isn't obvious on what platforms
377 they are necessary, nor what the exact prototype should look like (which
378 is likely to vary between platforms!) If you find you need one of these
379 declarations, please move them to a platform-specific block and include
380 proper prototypes. */
381 #if 0
383 /* From Modules/resource.c */
384 extern int getrusage();
385 extern int getpagesize();
387 /* From Python/sysmodule.c and Modules/posixmodule.c */
388 extern int fclose(FILE *);
390 /* From Modules/posixmodule.c */
391 extern int fdatasync(int);
392 /* XXX These are supposedly for SunOS4.1.3 but "shouldn't hurt elsewhere" */
393 extern int rename(const char *, const char *);
394 extern int pclose(FILE *);
395 extern int lstat(const char *, struct stat *);
396 extern int symlink(const char *, const char *);
397 extern int fsync(int fd);
399 #endif /* 0 */
402 /************************
403 * WRAPPER FOR <math.h> *
404 ************************/
406 #ifndef HAVE_HYPOT
407 extern double hypot(double, double);
408 #endif
410 /* Declarations for symbol visibility.
412 PyAPI_FUNC(type): Declares a public Python API function and return type
413 PyAPI_DATA(type): Declares public Python data and its type
414 PyMODINIT_FUNC: A Python module init function. If these functions are
415 inside the Python core, they are private to the core.
416 If in an extension module, it may be declared with
417 external linkage depending on the platform.
419 As a number of platforms support/require "__declspec(dllimport/dllexport)",
420 we support a HAVE_DECLSPEC_DLL macro to save duplication.
424 All windows ports, except cygwin, are handled in PC/pyconfig.h.
426 BeOS and cygwin are the only other autoconf platform requiring special
427 linkage handling and both of these use __declspec().
429 #if defined(__CYGWIN__) || defined(__BEOS__)
430 # define HAVE_DECLSPEC_DLL
431 #endif
433 #if defined(Py_ENABLE_SHARED) /* only get special linkage if built as shared */
434 # if defined(HAVE_DECLSPEC_DLL)
435 # ifdef Py_BUILD_CORE
436 # define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
437 # define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
438 /* module init functions inside the core need no external linkage */
439 # define PyMODINIT_FUNC void
440 # else /* Py_BUILD_CORE */
441 /* Building an extension module, or an embedded situation */
442 /* public Python functions and data are imported */
443 /* Under Cygwin, auto-import functions to prevent compilation */
444 /* failures similar to http://python.org/doc/FAQ.html#3.24 */
445 # if !defined(__CYGWIN__)
446 # define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
447 # endif /* !__CYGWIN__ */
448 # define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
449 /* module init functions outside the core must be exported */
450 # if defined(__cplusplus)
451 # define PyMODINIT_FUNC extern "C" __declspec(dllexport) void
452 # else /* __cplusplus */
453 # define PyMODINIT_FUNC __declspec(dllexport) void
454 # endif /* __cplusplus */
455 # endif /* Py_BUILD_CORE */
456 # endif /* HAVE_DECLSPEC */
457 #endif /* Py_ENABLE_SHARED */
459 /* If no external linkage macros defined by now, create defaults */
460 #ifndef PyAPI_FUNC
461 # define PyAPI_FUNC(RTYPE) RTYPE
462 #endif
463 #ifndef PyAPI_DATA
464 # define PyAPI_DATA(RTYPE) extern RTYPE
465 #endif
466 #ifndef PyMODINIT_FUNC
467 # if defined(__cplusplus)
468 # define PyMODINIT_FUNC extern "C" void
469 # else /* __cplusplus */
470 # define PyMODINIT_FUNC void
471 # endif /* __cplusplus */
472 #endif
474 /* Deprecated DL_IMPORT and DL_EXPORT macros */
475 #if defined(Py_ENABLE_SHARED) && defined (HAVE_DECLSPEC_DLL)
476 # if defined(Py_BUILD_CORE)
477 # define DL_IMPORT(RTYPE) __declspec(dllexport) RTYPE
478 # define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
479 # else
480 # define DL_IMPORT(RTYPE) __declspec(dllimport) RTYPE
481 # define DL_EXPORT(RTYPE) __declspec(dllexport) RTYPE
482 # endif
483 #endif
484 #ifndef DL_EXPORT
485 # define DL_EXPORT(RTYPE) RTYPE
486 #endif
487 #ifndef DL_IMPORT
488 # define DL_IMPORT(RTYPE) RTYPE
489 #endif
490 /* End of deprecated DL_* macros */
492 /* If the fd manipulation macros aren't defined,
493 here is a set that should do the job */
495 #if 0 /* disabled and probably obsolete */
497 #ifndef FD_SETSIZE
498 #define FD_SETSIZE 256
499 #endif
501 #ifndef FD_SET
503 typedef long fd_mask;
505 #define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
506 #ifndef howmany
507 #define howmany(x, y) (((x)+((y)-1))/(y))
508 #endif /* howmany */
510 typedef struct fd_set {
511 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
512 } fd_set;
514 #define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
515 #define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
516 #define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
517 #define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
519 #endif /* FD_SET */
521 #endif /* fd manipulation macros */
524 /* limits.h constants that may be missing */
526 #ifndef INT_MAX
527 #define INT_MAX 2147483647
528 #endif
530 #ifndef LONG_MAX
531 #if SIZEOF_LONG == 4
532 #define LONG_MAX 0X7FFFFFFFL
533 #elif SIZEOF_LONG == 8
534 #define LONG_MAX 0X7FFFFFFFFFFFFFFFL
535 #else
536 #error "could not set LONG_MAX in pyport.h"
537 #endif
538 #endif
540 #ifndef LONG_MIN
541 #define LONG_MIN (-LONG_MAX-1)
542 #endif
544 #ifndef LONG_BIT
545 #define LONG_BIT (8 * SIZEOF_LONG)
546 #endif
548 #if LONG_BIT != 8 * SIZEOF_LONG
549 /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
550 * 32-bit platforms using gcc. We try to catch that here at compile-time
551 * rather than waiting for integer multiplication to trigger bogus
552 * overflows.
554 #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
555 #endif
557 #ifdef __cplusplus
559 #endif
562 * Hide GCC attributes from compilers that don't support them.
564 #if (!defined(__GNUC__) || __GNUC__ < 2 || \
565 (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ) && \
566 !defined(RISCOS)
567 #define Py_GCC_ATTRIBUTE(x)
568 #else
569 #define Py_GCC_ATTRIBUTE(x) __attribute__(x)
570 #endif
572 #endif /* Py_PYPORT_H */