blob: 1bd1873b809232dfd85916cc143c66234290cb6c [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
Peter Schneider-Kamp25f68942000-07-31 22:19:30 +00004#include "config.h" /* include for defines */
5
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"
30Used in: LONG_LONG
31
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. */
36#define ANY void
37#ifdef HAVE_PROTOTYPES
38#define Py_PROTO(x) x
39#else
40#define Py_PROTO(x) ()
41#endif
Marc-André Lemburg77317ca2000-10-05 17:25:45 +000042#ifndef Py_FPROTO
43#define Py_FPROTO(x) Py_PROTO(x)
44#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000045
Barry Warsawfd847b22000-08-18 04:48:18 +000046/* typedefs for some C9X-defined synonyms for integral types.
47 *
48 * The names in Python are exactly the same as the C9X names, except with a
49 * Py_ prefix. Until C9X is universally implemented, this is the only way
50 * to ensure that Python gets reliable names that don't conflict with names
51 * in non-Python code that are playing their own tricks to define the C9X
52 * names.
53 *
54 * NOTE: don't go nuts here! Python has no use for *most* of the C9X
55 * integral synonyms. Only define the ones we actually need.
56 */
57
58#ifdef HAVE_LONG_LONG
59#ifndef LONG_LONG
60#define LONG_LONG long long
61#endif
62#endif /* HAVE_LONG_LONG */
63
64/* uintptr_t is the C9X name for an unsigned integral type such that a
65 * legitimate void* can be cast to uintptr_t and then back to void* again
66 * without loss of information.
67 */
68#ifdef HAVE_UINTPTR_T
69typedef uintptr_t Py_uintptr_t;
70#elif SIZEOF_VOID_P <= SIZEOF_INT
71typedef unsigned int Py_uintptr_t;
72#elif SIZEOF_VOID_P <= SIZEOF_LONG
73typedef unsigned long Py_uintptr_t;
74#elif defined(HAVE_LONG_LONG) && (SIZEOF_VOID_P <= SIZEOF_LONG_LONG)
75typedef unsigned LONG_LONG Py_uintptr_t;
76#else
77# error "Python needs a typedef for Py_uintptr_t in pyport.h."
78#endif /* HAVE_UINTPTR_T */
79
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +000080#ifdef HAVE_STDLIB_H
81#include <stdlib.h>
82#endif
83
Vladimir Marangozov2c57e072000-08-11 11:48:33 +000084#include <math.h> /* Moved here from the math section, before extern "C" */
85
86/********************************************
87 * WRAPPER FOR <time.h> and/or <sys/time.h> *
88 ********************************************/
89
90#ifdef TIME_WITH_SYS_TIME
91#include <sys/time.h>
92#include <time.h>
93#else /* !TIME_WITH_SYS_TIME */
94#ifdef HAVE_SYS_TIME_H
95#include <sys/time.h>
96#else /* !HAVE_SYS_TIME_H */
97#include <time.h>
98#endif /* !HAVE_SYS_TIME_H */
99#endif /* !TIME_WITH_SYS_TIME */
100
101
102/******************************
103 * WRAPPER FOR <sys/select.h> *
104 ******************************/
105
106/* NB caller must include <sys/types.h> */
107
108#ifdef HAVE_SYS_SELECT_H
109
110#include <sys/select.h>
111
112#else /* !HAVE_SYS_SELECT_H */
113
114#ifdef USE_GUSI1
115/* If we don't have sys/select the definition may be in unistd.h */
116#include <GUSI.h>
117#endif
118
119#endif /* !HAVE_SYS_SELECT_H */
120
Tim Peters60f42b52001-01-18 03:03:16 +0000121/*******************************
122 * stat() and fstat() fiddling *
123 *******************************/
124
125/* We expect that stat and fstat exist on most systems.
126 * It's confirmed on Unix, Mac and Windows.
127 * If you don't have them, add
128 * #define DONT_HAVE_STAT
129 * and/or
130 * #define DONT_HAVE_FSTAT
131 * to your config.h. Python code beyond this should check HAVE_STAT and
132 * HAVE_FSTAT instead.
133 * Also
134 * #define DONT_HAVE_SYS_STAT_H
135 * if <sys/stat.h> doesn't exist on your platform, and
136 * #define HAVE_STAT_H
137 * if <stat.h> does (don't look at me -- ths mess is inherited).
138 */
139#ifndef DONT_HAVE_STAT
140#define HAVE_STAT
141#endif
142
143#ifndef DONT_HAVE_FSTAT
144#define HAVE_FSTAT
145#endif
146
147#ifndef DONT_HAVE_SYS_STAT_H
148#include <sys/stat.h>
149#elif defined(HAVE_STAT_H)
150#include <stat.h>
151#endif
152
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000153
Tim Peters7d3a5112000-07-08 04:17:21 +0000154#ifdef __cplusplus
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000155/* Move this down here since some C++ #include's don't like to be included
156 inside an extern "C" */
Tim Peters7d3a5112000-07-08 04:17:21 +0000157extern "C" {
158#endif
159
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000160
Tim Peters7d3a5112000-07-08 04:17:21 +0000161/* Py_ARITHMETIC_RIGHT_SHIFT
162 * C doesn't define whether a right-shift of a signed integer sign-extends
163 * or zero-fills. Here a macro to force sign extension:
164 * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
165 * Return I >> J, forcing sign extension.
166 * Requirements:
167 * I is of basic signed type TYPE (char, short, int, long, or long long).
168 * TYPE is one of char, short, int, long, or long long, although long long
169 * must not be used except on platforms that support it.
170 * J is an integer >= 0 and strictly less than the number of bits in TYPE
171 * (because C doesn't define what happens for J outside that range either).
172 * Caution:
173 * I may be evaluated more than once.
174 */
175#ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
176#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
177 ((I) < 0 ? ~((~(unsigned TYPE)(I)) >> (J)) : (I) >> (J))
178#else
179#define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
180#endif
181
Tim Peters39dce292000-08-15 03:34:48 +0000182/* Py_FORCE_EXPANSION(X)
Tim Peters1be46842000-07-23 18:10:18 +0000183 * "Simply" returns its argument. However, macro expansions within the
184 * argument are evaluated. This unfortunate trickery is needed to get
185 * token-pasting to work as desired in some cases.
186 */
187#define Py_FORCE_EXPANSION(X) X
188
Tim Peters8315ea52000-07-23 19:28:35 +0000189/* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
190 * Cast VALUE to type NARROW from type WIDE. In Py_DEBUG mode, this
191 * assert-fails if any information is lost.
192 * Caution:
193 * VALUE may be evaluated more than once.
194 */
195#ifdef Py_DEBUG
196#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
197 (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
198#else
199#define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
200#endif
201
Tim Peters39dce292000-08-15 03:34:48 +0000202/* Py_IS_INFINITY(X)
203 * Return 1 if float or double arg is an infinity, else 0.
204 * Caution:
205 * X is evaluated more than once.
206 * This implementation may set the underflow flag if |X| is very small;
207 * it really can't be implemented correctly (& easily) before C99.
208 */
Tim Peters1a2eefd2000-09-08 15:45:34 +0000209#define Py_IS_INFINITY(X) ((X) && (X)*0.5 == (X))
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000210
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000211/**************************************************************************
212Prototypes that are missing from the standard include files on some systems
213(and possibly only some versions of such systems.)
214
215Please be conservative with adding new ones, document them and enclose them
216in platform-specific #ifdefs.
217**************************************************************************/
218
219#ifdef SOLARIS
220/* Unchecked */
221extern int gethostname(char *, int);
222#endif
223
224#ifdef __BEOS__
225/* Unchecked */
226/* It's in the libs, but not the headers... - [cjh] */
Tim Peters60f42b52001-01-18 03:03:16 +0000227int shutdown( int, int );
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000228#endif
229
230#ifdef HAVE__GETPTY
Sjoerd Mullender0765fe32000-07-26 15:46:29 +0000231#include <sys/types.h> /* we need to import mode_t */
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000232extern char * _getpty(int *, int, mode_t, int);
233#endif
234
235#if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
236#if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
237/* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
238 functions, even though they are included in libutil. */
239#include <termios.h>
240extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
241extern int forkpty(int *, char *, struct termios *, struct winsize *);
242#endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
243#endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
244
245
246/* These are pulled from various places. It isn't obvious on what platforms
247 they are necessary, nor what the exact prototype should look like (which
248 is likely to vary between platforms!) If you find you need one of these
249 declarations, please move them to a platform-specific block and include
250 proper prototypes. */
251#if 0
252
253/* From Modules/resource.c */
254extern int getrusage();
255extern int getpagesize();
256
257/* From Python/sysmodule.c and Modules/posixmodule.c */
258extern int fclose(FILE *);
259
260/* From Modules/posixmodule.c */
261extern int fdatasync(int);
262/* XXX These are supposedly for SunOS4.1.3 but "shouldn't hurt elsewhere" */
263extern int rename(const char *, const char *);
264extern int pclose(FILE *);
265extern int lstat(const char *, struct stat *);
266extern int symlink(const char *, const char *);
267extern int fsync(int fd);
268
Thomas Wouterse75e6d02001-01-21 23:34:12 +0000269/* From Modules/nismodule.c */
270CLIENT *clnt_create();
271
Thomas Wouters1e0c2f42000-07-24 16:06:23 +0000272#endif /* 0 */
273
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000274
275/************************
276 * WRAPPER FOR <math.h> *
277 ************************/
278
279/* On the 68K Mac, when using CFM (Code Fragment Manager),
280 <math.h> requires special treatment -- we need to surround it with
281 #pragma lib_export off / on...
282 This is because MathLib.o is a static library, and exporting its
283 symbols doesn't quite work...
284 XXX Not sure now... Seems to be something else going on as well... */
285
286#ifndef HAVE_HYPOT
287extern double hypot(double, double);
288#ifdef MWERKS_BEFORE_PRO4
289#define hypot we_dont_want_faulty_hypot_decl
290#endif
291#endif
292
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000293#ifndef HAVE_HYPOT
294#ifdef __MWERKS__
295#undef hypot
296#endif
297#endif
298
299#if defined(USE_MSL) && defined(__MC68K__)
300/* CodeWarrior MSL 2.1.1 has weird define overrides that don't work
301** when you take the address of math functions. If I interpret the
302** ANSI C standard correctly this is illegal, but I haven't been able
303** to convince the MetroWerks folks of this...
304*/
305#undef acos
306#undef asin
307#undef atan
308#undef atan2
309#undef ceil
310#undef cos
311#undef cosh
312#undef exp
313#undef fabs
314#undef floor
315#undef fmod
316#undef log
317#undef log10
318#undef pow
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000319#undef sin
320#undef sinh
321#undef sqrt
322#undef tan
323#undef tanh
324#define acos acosd
325#define asin asind
326#define atan atand
327#define atan2 atan2d
328#define ceil ceild
329#define cos cosd
330#define cosh coshd
331#define exp expd
332#define fabs fabsd
333#define floor floord
334#define fmod fmodd
335#define log logd
336#define log10 log10d
337#define pow powd
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000338#define sin sind
339#define sinh sinhd
340#define sqrt sqrtd
341#define tan tand
342#define tanh tanhd
Tim Peters60f42b52001-01-18 03:03:16 +0000343#endif
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000344
345
Peter Schneider-Kamp25f68942000-07-31 22:19:30 +0000346/************************************
347 * MALLOC COMPATIBILITY FOR pymem.h *
348 ************************************/
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000349
350#ifndef DL_IMPORT /* declarations for DLL import */
351#define DL_IMPORT(RTYPE) RTYPE
352#endif
353
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000354#ifdef MALLOC_ZERO_RETURNS_NULL
355/* XXX Always allocate one extra byte, since some malloc's return NULL
356 XXX for malloc(0) or realloc(p, 0). */
357#define _PyMem_EXTRA 1
358#else
359#define _PyMem_EXTRA 0
360#endif
361
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000362
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000363/* If the fd manipulation macros aren't defined,
364 here is a set that should do the job */
365
Guido van Rossum367e46a2000-08-01 18:28:44 +0000366#if 0 /* disabled and probably obsolete */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000367
Peter Schneider-Kamp7e018902000-07-31 15:28:04 +0000368#ifndef FD_SETSIZE
369#define FD_SETSIZE 256
370#endif
371
372#ifndef FD_SET
373
374typedef long fd_mask;
375
376#define NFDBITS (sizeof(fd_mask) * NBBY) /* bits per mask */
377#ifndef howmany
378#define howmany(x, y) (((x)+((y)-1))/(y))
379#endif /* howmany */
380
381typedef struct fd_set {
382 fd_mask fds_bits[howmany(FD_SETSIZE, NFDBITS)];
383} fd_set;
384
385#define FD_SET(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))
386#define FD_CLR(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))
387#define FD_ISSET(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))
388#define FD_ZERO(p) memset((char *)(p), '\0', sizeof(*(p)))
389
390#endif /* FD_SET */
Peter Schneider-Kamp1c2b1782000-08-01 16:53:44 +0000391
392#endif /* fd manipulation macros */
393
Vladimir Marangozov2c57e072000-08-11 11:48:33 +0000394
Fred Draked5fadf72000-09-26 05:46:01 +0000395/* limits.h constants that may be missing */
396
397#ifndef INT_MAX
398#define INT_MAX 2147483647
399#endif
400
401#ifndef LONG_MAX
402#if SIZEOF_LONG == 4
403#define LONG_MAX 0X7FFFFFFFL
404#elif SIZEOF_LONG == 8
405#define LONG_MAX 0X7FFFFFFFFFFFFFFFL
406#else
407#error "could not set LONG_MAX in pyport.h"
408#endif
409#endif
410
411#ifndef LONG_MIN
412#define LONG_MIN (-LONG_MAX-1)
413#endif
414
Tim Petersd57731f2000-10-05 01:42:25 +0000415#ifndef LONG_BIT
416#define LONG_BIT (8 * SIZEOF_LONG)
417#endif
418
419#if LONG_BIT != 8 * SIZEOF_LONG
420/* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
421 * 32-bit platforms using gcc. We try to catch that here at compile-time
422 * rather than waiting for integer multiplication to trigger bogus
423 * overflows.
424 */
Andrew M. Kuchling234fb632001-01-12 15:06:28 +0000425#error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
Tim Petersd57731f2000-10-05 01:42:25 +0000426#endif
427
Fred Draked5fadf72000-09-26 05:46:01 +0000428#ifdef __NeXT__
429#ifdef __sparc__
430/*
431 * This works around a bug in the NS/Sparc 3.3 pre-release
432 * limits.h header file.
433 * 10-Feb-1995 bwarsaw@cnri.reston.va.us
434 */
435#undef LONG_MIN
436#define LONG_MIN (-LONG_MAX-1)
437#endif
438#endif
439
Tim Peters7d3a5112000-07-08 04:17:21 +0000440#ifdef __cplusplus
441}
442#endif
443
444#endif /* Py_PYPORT_H */