File: /Users/paulross/dev/Python-3.6.2/Include/pyport.h

Green shading in the line number column means the source is part of the translation unit, red means it is conditionally excluded. Highlighted line numbers link to the translation unit page. Highlighted macros link to the macro page.

       1: #ifndef Py_PYPORT_H
       2: #define Py_PYPORT_H
       3: 
       4: #include "pyconfig.h" /* include for defines */
       5: 
       6: #include <inttypes.h>
       7: 
       8: /**************************************************************************
       9: Symbols and macros to supply platform-independent interfaces to basic
      10: C language & library operations whose spellings vary across platforms.
      11: 
      12: Please try to make documentation here as clear as possible:  by definition,
      13: the stuff here is trying to illuminate C's darkest corners.
      14: 
      15: Config #defines referenced here:
      16: 
      17: SIGNED_RIGHT_SHIFT_ZERO_FILLS
      18: Meaning:  To be defined iff i>>j does not extend the sign bit when i is a
      19:           signed integral type and i < 0.
      20: Used in:  Py_ARITHMETIC_RIGHT_SHIFT
      21: 
      22: Py_DEBUG
      23: Meaning:  Extra checks compiled in for debug mode.
      24: Used in:  Py_SAFE_DOWNCAST
      25: 
      26: **************************************************************************/
      27: 
      28: /* typedefs for some C9X-defined synonyms for integral types.
      29:  *
      30:  * The names in Python are exactly the same as the C9X names, except with a
      31:  * Py_ prefix.  Until C9X is universally implemented, this is the only way
      32:  * to ensure that Python gets reliable names that don't conflict with names
      33:  * in non-Python code that are playing their own tricks to define the C9X
      34:  * names.
      35:  *
      36:  * NOTE: don't go nuts here!  Python has no use for *most* of the C9X
      37:  * integral synonyms.  Only define the ones we actually need.
      38:  */
      39: 
      40: /* long long is required. Ensure HAVE_LONG_LONG is defined for compatibility. */
      41: #ifndef HAVE_LONG_LONG
      42: #define HAVE_LONG_LONG 1
      43: #endif
      44: #ifndef PY_LONG_LONG
      45: #define PY_LONG_LONG long long
      46: /* If LLONG_MAX is defined in limits.h, use that. */
      47: #define PY_LLONG_MIN LLONG_MIN
      48: #define PY_LLONG_MAX LLONG_MAX
      49: #define PY_ULLONG_MAX ULLONG_MAX
      50: #endif
      51: 
      52: #define PY_UINT32_T uint32_t
      53: #define PY_UINT64_T uint64_t
      54: 
      55: /* Signed variants of the above */
      56: #define PY_INT32_T int32_t
      57: #define PY_INT64_T int64_t
      58: 
      59: /* If PYLONG_BITS_IN_DIGIT is not defined then we'll use 30-bit digits if all
      60:    the necessary integer types are available, and we're on a 64-bit platform
      61:    (as determined by SIZEOF_VOID_P); otherwise we use 15-bit digits. */
      62: 
      63: #ifndef PYLONG_BITS_IN_DIGIT
      64: #if SIZEOF_VOID_P >= 8
      65: #define PYLONG_BITS_IN_DIGIT 30
      66: #else
      67: #define PYLONG_BITS_IN_DIGIT 15
      68: #endif
      69: #endif
      70: 
      71: /* uintptr_t is the C9X name for an unsigned integral type such that a
      72:  * legitimate void* can be cast to uintptr_t and then back to void* again
      73:  * without loss of information.  Similarly for intptr_t, wrt a signed
      74:  * integral type.
      75:  */
      76: typedef uintptr_t       Py_uintptr_t;
      77: typedef intptr_t        Py_intptr_t;
      78: 
      79: /* Py_ssize_t is a signed integral type such that sizeof(Py_ssize_t) ==
      80:  * sizeof(size_t).  C99 doesn't define such a thing directly (size_t is an
      81:  * unsigned integral type).  See PEP 353 for details.
      82:  */
      83: #ifdef HAVE_SSIZE_T
      84: typedef ssize_t         Py_ssize_t;
      85: #elif SIZEOF_VOID_P == SIZEOF_SIZE_T
      86: typedef Py_intptr_t     Py_ssize_t;
      87: #else
      88: #   error "Python needs a typedef for Py_ssize_t in pyport.h."
      89: #endif
      90: 
      91: /* Py_hash_t is the same size as a pointer. */
      92: #define SIZEOF_PY_HASH_T SIZEOF_SIZE_T
      93: typedef Py_ssize_t Py_hash_t;
      94: /* Py_uhash_t is the unsigned equivalent needed to calculate numeric hash. */
      95: #define SIZEOF_PY_UHASH_T SIZEOF_SIZE_T
      96: typedef size_t Py_uhash_t;
      97: 
      98: /* Only used for compatibility with code that may not be PY_SSIZE_T_CLEAN. */
      99: #ifdef PY_SSIZE_T_CLEAN
     100: typedef Py_ssize_t Py_ssize_clean_t;
     101: #else
     102: typedef int Py_ssize_clean_t;
     103: #endif
     104: 
     105: /* Largest possible value of size_t. */
     106: #define PY_SIZE_MAX SIZE_MAX
     107: 
     108: /* Largest positive value of type Py_ssize_t. */
     109: #define PY_SSIZE_T_MAX ((Py_ssize_t)(((size_t)-1)>>1))
     110: /* Smallest negative value of type Py_ssize_t. */
     111: #define PY_SSIZE_T_MIN (-PY_SSIZE_T_MAX-1)
     112: 
     113: /* PY_FORMAT_SIZE_T is a platform-specific modifier for use in a printf
     114:  * format to convert an argument with the width of a size_t or Py_ssize_t.
     115:  * C99 introduced "z" for this purpose, but not all platforms support that;
     116:  * e.g., MS compilers use "I" instead.
     117:  *
     118:  * These "high level" Python format functions interpret "z" correctly on
     119:  * all platforms (Python interprets the format string itself, and does whatever
     120:  * the platform C requires to convert a size_t/Py_ssize_t argument):
     121:  *
     122:  *     PyBytes_FromFormat
     123:  *     PyErr_Format
     124:  *     PyBytes_FromFormatV
     125:  *     PyUnicode_FromFormatV
     126:  *
     127:  * Lower-level uses require that you interpolate the correct format modifier
     128:  * yourself (e.g., calling printf, fprintf, sprintf, PyOS_snprintf); for
     129:  * example,
     130:  *
     131:  *     Py_ssize_t index;
     132:  *     fprintf(stderr, "index %" PY_FORMAT_SIZE_T "d sucks\n", index);
     133:  *
     134:  * That will expand to %ld, or %Id, or to something else correct for a
     135:  * Py_ssize_t on the platform.
     136:  */
     137: #ifndef PY_FORMAT_SIZE_T
     138: #   if SIZEOF_SIZE_T == SIZEOF_INT && !defined(__APPLE__)
     139: #       define PY_FORMAT_SIZE_T ""
     140: #   elif SIZEOF_SIZE_T == SIZEOF_LONG
     141: #       define PY_FORMAT_SIZE_T "l"
     142: #   elif defined(MS_WINDOWS)
     143: #       define PY_FORMAT_SIZE_T "I"
     144: #   else
     145: #       error "This platform's pyconfig.h needs to define PY_FORMAT_SIZE_T"
     146: #   endif
     147: #endif
     148: 
     149: /* Py_LOCAL can be used instead of static to get the fastest possible calling
     150:  * convention for functions that are local to a given module.
     151:  *
     152:  * Py_LOCAL_INLINE does the same thing, and also explicitly requests inlining,
     153:  * for platforms that support that.
     154:  *
     155:  * If PY_LOCAL_AGGRESSIVE is defined before python.h is included, more
     156:  * "aggressive" inlining/optimization is enabled for the entire module.  This
     157:  * may lead to code bloat, and may slow things down for those reasons.  It may
     158:  * also lead to errors, if the code relies on pointer aliasing.  Use with
     159:  * care.
     160:  *
     161:  * NOTE: You can only use this for functions that are entirely local to a
     162:  * module; functions that are exported via method tables, callbacks, etc,
     163:  * should keep using static.
     164:  */
     165: 
     166: #if defined(_MSC_VER)
     167: #if defined(PY_LOCAL_AGGRESSIVE)
     168: /* enable more aggressive optimization for visual studio */
     169: #pragma optimize("agtw", on)
     170: #endif
     171: /* ignore warnings if the compiler decides not to inline a function */
     172: #pragma warning(disable: 4710)
     173: /* fastest possible local call under MSVC */
     174: #define Py_LOCAL(type) static type __fastcall
     175: #define Py_LOCAL_INLINE(type) static __inline type __fastcall
     176: #elif defined(USE_INLINE)
     177: #define Py_LOCAL(type) static type
     178: #define Py_LOCAL_INLINE(type) static inline type
     179: #else
     180: #define Py_LOCAL(type) static type
     181: #define Py_LOCAL_INLINE(type) static type
     182: #endif
     183: 
     184: /* Py_MEMCPY is kept for backwards compatibility,
     185:  * see https://bugs.python.org/issue28126 */
     186: #define Py_MEMCPY memcpy
     187: 
     188: #include <stdlib.h>
     189: 
     190: #ifdef HAVE_IEEEFP_H
     191: #include <ieeefp.h>  /* needed for 'finite' declaration on some platforms */
     192: #endif
     193: 
     194: #include <math.h> /* Moved here from the math section, before extern "C" */
     195: 
     196: /********************************************
     197:  * WRAPPER FOR <time.h> and/or <sys/time.h> *
     198:  ********************************************/
     199: 
     200: #ifdef TIME_WITH_SYS_TIME
     201: #include <sys/time.h>
     202: #include <time.h>
     203: #else /* !TIME_WITH_SYS_TIME */
     204: #ifdef HAVE_SYS_TIME_H
     205: #include <sys/time.h>
     206: #else /* !HAVE_SYS_TIME_H */
     207: #include <time.h>
     208: #endif /* !HAVE_SYS_TIME_H */
     209: #endif /* !TIME_WITH_SYS_TIME */
     210: 
     211: 
     212: /******************************
     213:  * WRAPPER FOR <sys/select.h> *
     214:  ******************************/
     215: 
     216: /* NB caller must include <sys/types.h> */
     217: 
     218: #ifdef HAVE_SYS_SELECT_H
     219: #include <sys/select.h>
     220: #endif /* !HAVE_SYS_SELECT_H */
     221: 
     222: /*******************************
     223:  * stat() and fstat() fiddling *
     224:  *******************************/
     225: 
     226: #ifdef HAVE_SYS_STAT_H
     227: #include <sys/stat.h>
     228: #elif defined(HAVE_STAT_H)
     229: #include <stat.h>
     230: #endif
     231: 
     232: #ifndef S_IFMT
     233: /* VisualAge C/C++ Failed to Define MountType Field in sys/stat.h */
     234: #define S_IFMT 0170000
     235: #endif
     236: 
     237: #ifndef S_IFLNK
     238: /* Windows doesn't define S_IFLNK but posixmodule.c maps
     239:  * IO_REPARSE_TAG_SYMLINK to S_IFLNK */
     240: #  define S_IFLNK 0120000
     241: #endif
     242: 
     243: #ifndef S_ISREG
     244: #define S_ISREG(x) (((x) & S_IFMT) == S_IFREG)
     245: #endif
     246: 
     247: #ifndef S_ISDIR
     248: #define S_ISDIR(x) (((x) & S_IFMT) == S_IFDIR)
     249: #endif
     250: 
     251: #ifndef S_ISCHR
     252: #define S_ISCHR(x) (((x) & S_IFMT) == S_IFCHR)
     253: #endif
     254: 
     255: #ifdef __cplusplus
     256: /* Move this down here since some C++ #include's don't like to be included
     257:    inside an extern "C" */
     258: extern "C" {
     259: #endif
     260: 
     261: 
     262: /* Py_ARITHMETIC_RIGHT_SHIFT
     263:  * C doesn't define whether a right-shift of a signed integer sign-extends
     264:  * or zero-fills.  Here a macro to force sign extension:
     265:  * Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J)
     266:  *    Return I >> J, forcing sign extension.  Arithmetically, return the
     267:  *    floor of I/2**J.
     268:  * Requirements:
     269:  *    I should have signed integer type.  In the terminology of C99, this can
     270:  *    be either one of the five standard signed integer types (signed char,
     271:  *    short, int, long, long long) or an extended signed integer type.
     272:  *    J is an integer >= 0 and strictly less than the number of bits in the
     273:  *    type of I (because C doesn't define what happens for J outside that
     274:  *    range either).
     275:  *    TYPE used to specify the type of I, but is now ignored.  It's been left
     276:  *    in for backwards compatibility with versions <= 2.6 or 3.0.
     277:  * Caution:
     278:  *    I may be evaluated more than once.
     279:  */
     280: #ifdef SIGNED_RIGHT_SHIFT_ZERO_FILLS
     281: #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) \
     282:     ((I) < 0 ? -1-((-1-(I)) >> (J)) : (I) >> (J))
     283: #else
     284: #define Py_ARITHMETIC_RIGHT_SHIFT(TYPE, I, J) ((I) >> (J))
     285: #endif
     286: 
     287: /* Py_FORCE_EXPANSION(X)
     288:  * "Simply" returns its argument.  However, macro expansions within the
     289:  * argument are evaluated.  This unfortunate trickery is needed to get
     290:  * token-pasting to work as desired in some cases.
     291:  */
     292: #define Py_FORCE_EXPANSION(X) X
     293: 
     294: /* Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW)
     295:  * Cast VALUE to type NARROW from type WIDE.  In Py_DEBUG mode, this
     296:  * assert-fails if any information is lost.
     297:  * Caution:
     298:  *    VALUE may be evaluated more than once.
     299:  */
     300: #ifdef Py_DEBUG
     301: #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) \
     302:     (assert((WIDE)(NARROW)(VALUE) == (VALUE)), (NARROW)(VALUE))
     303: #else
     304: #define Py_SAFE_DOWNCAST(VALUE, WIDE, NARROW) (NARROW)(VALUE)
     305: #endif
     306: 
     307: /* Py_SET_ERRNO_ON_MATH_ERROR(x)
     308:  * If a libm function did not set errno, but it looks like the result
     309:  * overflowed or not-a-number, set errno to ERANGE or EDOM.  Set errno
     310:  * to 0 before calling a libm function, and invoke this macro after,
     311:  * passing the function result.
     312:  * Caution:
     313:  *    This isn't reliable.  See Py_OVERFLOWED comments.
     314:  *    X is evaluated more than once.
     315:  */
     316: #if defined(__FreeBSD__) || defined(__OpenBSD__) || (defined(__hpux) && defined(__ia64))
     317: #define _Py_SET_EDOM_FOR_NAN(X) if (isnan(X)) errno = EDOM;
     318: #else
     319: #define _Py_SET_EDOM_FOR_NAN(X) ;
     320: #endif
     321: #define Py_SET_ERRNO_ON_MATH_ERROR(X) \
     322:     do { \
     323:         if (errno == 0) { \
     324:             if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL) \
     325:                 errno = ERANGE; \
     326:             else _Py_SET_EDOM_FOR_NAN(X) \
     327:         } \
     328:     } while(0)
     329: 
     330: /* Py_SET_ERANGE_ON_OVERFLOW(x)
     331:  * An alias of Py_SET_ERRNO_ON_MATH_ERROR for backward-compatibility.
     332:  */
     333: #define Py_SET_ERANGE_IF_OVERFLOW(X) Py_SET_ERRNO_ON_MATH_ERROR(X)
     334: 
     335: /* Py_ADJUST_ERANGE1(x)
     336:  * Py_ADJUST_ERANGE2(x, y)
     337:  * Set errno to 0 before calling a libm function, and invoke one of these
     338:  * macros after, passing the function result(s) (Py_ADJUST_ERANGE2 is useful
     339:  * for functions returning complex results).  This makes two kinds of
     340:  * adjustments to errno:  (A) If it looks like the platform libm set
     341:  * errno=ERANGE due to underflow, clear errno. (B) If it looks like the
     342:  * platform libm overflowed but didn't set errno, force errno to ERANGE.  In
     343:  * effect, we're trying to force a useful implementation of C89 errno
     344:  * behavior.
     345:  * Caution:
     346:  *    This isn't reliable.  See Py_OVERFLOWED comments.
     347:  *    X and Y may be evaluated more than once.
     348:  */
     349: #define Py_ADJUST_ERANGE1(X)                                            \
     350:     do {                                                                \
     351:         if (errno == 0) {                                               \
     352:             if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL)              \
     353:                 errno = ERANGE;                                         \
     354:         }                                                               \
     355:         else if (errno == ERANGE && (X) == 0.0)                         \
     356:             errno = 0;                                                  \
     357:     } while(0)
     358: 
     359: #define Py_ADJUST_ERANGE2(X, Y)                                         \
     360:     do {                                                                \
     361:         if ((X) == Py_HUGE_VAL || (X) == -Py_HUGE_VAL ||                \
     362:             (Y) == Py_HUGE_VAL || (Y) == -Py_HUGE_VAL) {                \
     363:                         if (errno == 0)                                 \
     364:                                 errno = ERANGE;                         \
     365:         }                                                               \
     366:         else if (errno == ERANGE)                                       \
     367:             errno = 0;                                                  \
     368:     } while(0)
     369: 
     370: /*  The functions _Py_dg_strtod and _Py_dg_dtoa in Python/dtoa.c (which are
     371:  *  required to support the short float repr introduced in Python 3.1) require
     372:  *  that the floating-point unit that's being used for arithmetic operations
     373:  *  on C doubles is set to use 53-bit precision.  It also requires that the
     374:  *  FPU rounding mode is round-half-to-even, but that's less often an issue.
     375:  *
     376:  *  If your FPU isn't already set to 53-bit precision/round-half-to-even, and
     377:  *  you want to make use of _Py_dg_strtod and _Py_dg_dtoa, then you should
     378:  *
     379:  *     #define HAVE_PY_SET_53BIT_PRECISION 1
     380:  *
     381:  *  and also give appropriate definitions for the following three macros:
     382:  *
     383:  *    _PY_SET_53BIT_PRECISION_START : store original FPU settings, and
     384:  *        set FPU to 53-bit precision/round-half-to-even
     385:  *    _PY_SET_53BIT_PRECISION_END : restore original FPU settings
     386:  *    _PY_SET_53BIT_PRECISION_HEADER : any variable declarations needed to
     387:  *        use the two macros above.
     388:  *
     389:  * The macros are designed to be used within a single C function: see
     390:  * Python/pystrtod.c for an example of their use.
     391:  */
     392: 
     393: /* get and set x87 control word for gcc/x86 */
     394: #ifdef HAVE_GCC_ASM_FOR_X87
     395: #define HAVE_PY_SET_53BIT_PRECISION 1
     396: /* _Py_get/set_387controlword functions are defined in Python/pymath.c */
     397: #define _Py_SET_53BIT_PRECISION_HEADER                          \
     398:     unsigned short old_387controlword, new_387controlword
     399: #define _Py_SET_53BIT_PRECISION_START                                   \
     400:     do {                                                                \
     401:         old_387controlword = _Py_get_387controlword();                  \
     402:         new_387controlword = (old_387controlword & ~0x0f00) | 0x0200; \
     403:         if (new_387controlword != old_387controlword)                   \
     404:             _Py_set_387controlword(new_387controlword);                 \
     405:     } while (0)
     406: #define _Py_SET_53BIT_PRECISION_END                             \
     407:     if (new_387controlword != old_387controlword)               \
     408:         _Py_set_387controlword(old_387controlword)
     409: #endif
     410: 
     411: /* get and set x87 control word for VisualStudio/x86 */
     412: #if defined(_MSC_VER) && !defined(_WIN64) /* x87 not supported in 64-bit */
     413: #define HAVE_PY_SET_53BIT_PRECISION 1
     414: #define _Py_SET_53BIT_PRECISION_HEADER \
     415:     unsigned int old_387controlword, new_387controlword, out_387controlword
     416: /* We use the __control87_2 function to set only the x87 control word.
     417:    The SSE control word is unaffected. */
     418: #define _Py_SET_53BIT_PRECISION_START                                   \
     419:     do {                                                                \
     420:         __control87_2(0, 0, &old_387controlword, NULL);                 \
     421:         new_387controlword =                                            \
     422:           (old_387controlword & ~(_MCW_PC | _MCW_RC)) | (_PC_53 | _RC_NEAR); \
     423:         if (new_387controlword != old_387controlword)                   \
     424:             __control87_2(new_387controlword, _MCW_PC | _MCW_RC,        \
     425:                           &out_387controlword, NULL);                   \
     426:     } while (0)
     427: #define _Py_SET_53BIT_PRECISION_END                                     \
     428:     do {                                                                \
     429:         if (new_387controlword != old_387controlword)                   \
     430:             __control87_2(old_387controlword, _MCW_PC | _MCW_RC,        \
     431:                           &out_387controlword, NULL);                   \
     432:     } while (0)
     433: #endif
     434: 
     435: #ifdef HAVE_GCC_ASM_FOR_MC68881
     436: #define HAVE_PY_SET_53BIT_PRECISION 1
     437: #define _Py_SET_53BIT_PRECISION_HEADER \
     438:   unsigned int old_fpcr, new_fpcr
     439: #define _Py_SET_53BIT_PRECISION_START                                   \
     440:   do {                                                                  \
     441:     __asm__ ("fmove.l %%fpcr,%0" : "=g" (old_fpcr));                    \
     442:     /* Set double precision / round to nearest.  */                     \
     443:     new_fpcr = (old_fpcr & ~0xf0) | 0x80;                               \
     444:     if (new_fpcr != old_fpcr)                                           \
     445:       __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (new_fpcr));        \
     446:   } while (0)
     447: #define _Py_SET_53BIT_PRECISION_END                                     \
     448:   do {                                                                  \
     449:     if (new_fpcr != old_fpcr)                                           \
     450:       __asm__ volatile ("fmove.l %0,%%fpcr" : : "g" (old_fpcr));        \
     451:   } while (0)
     452: #endif
     453: 
     454: /* default definitions are empty */
     455: #ifndef HAVE_PY_SET_53BIT_PRECISION
     456: #define _Py_SET_53BIT_PRECISION_HEADER
     457: #define _Py_SET_53BIT_PRECISION_START
     458: #define _Py_SET_53BIT_PRECISION_END
     459: #endif
     460: 
     461: /* If we can't guarantee 53-bit precision, don't use the code
     462:    in Python/dtoa.c, but fall back to standard code.  This
     463:    means that repr of a float will be long (17 sig digits).
     464: 
     465:    Realistically, there are two things that could go wrong:
     466: 
     467:    (1) doubles aren't IEEE 754 doubles, or
     468:    (2) we're on x86 with the rounding precision set to 64-bits
     469:        (extended precision), and we don't know how to change
     470:        the rounding precision.
     471:  */
     472: 
     473: #if !defined(DOUBLE_IS_LITTLE_ENDIAN_IEEE754) && \
     474:     !defined(DOUBLE_IS_BIG_ENDIAN_IEEE754) && \
     475:     !defined(DOUBLE_IS_ARM_MIXED_ENDIAN_IEEE754)
     476: #define PY_NO_SHORT_FLOAT_REPR
     477: #endif
     478: 
     479: /* double rounding is symptomatic of use of extended precision on x86.  If
     480:    we're seeing double rounding, and we don't have any mechanism available for
     481:    changing the FPU rounding precision, then don't use Python/dtoa.c. */
     482: #if defined(X87_DOUBLE_ROUNDING) && !defined(HAVE_PY_SET_53BIT_PRECISION)
     483: #define PY_NO_SHORT_FLOAT_REPR
     484: #endif
     485: 
     486: 
     487: /* Py_DEPRECATED(version)
     488:  * Declare a variable, type, or function deprecated.
     489:  * Usage:
     490:  *    extern int old_var Py_DEPRECATED(2.3);
     491:  *    typedef int T1 Py_DEPRECATED(2.4);
     492:  *    extern int x() Py_DEPRECATED(2.5);
     493:  */
     494: #if defined(__GNUC__) && ((__GNUC__ >= 4) || \
     495:               (__GNUC__ == 3) && (__GNUC_MINOR__ >= 1))
     496: #define Py_DEPRECATED(VERSION_UNUSED) __attribute__((__deprecated__))
     497: #else
     498: #define Py_DEPRECATED(VERSION_UNUSED)
     499: #endif
     500: 
     501: /**************************************************************************
     502: Prototypes that are missing from the standard include files on some systems
     503: (and possibly only some versions of such systems.)
     504: 
     505: Please be conservative with adding new ones, document them and enclose them
     506: in platform-specific #ifdefs.
     507: **************************************************************************/
     508: 
     509: #ifdef SOLARIS
     510: /* Unchecked */
     511: extern int gethostname(char *, int);
     512: #endif
     513: 
     514: #ifdef HAVE__GETPTY
     515: #include <sys/types.h>          /* we need to import mode_t */
     516: extern char * _getpty(int *, int, mode_t, int);
     517: #endif
     518: 
     519: /* On QNX 6, struct termio must be declared by including sys/termio.h
     520:    if TCGETA, TCSETA, TCSETAW, or TCSETAF are used.  sys/termio.h must
     521:    be included before termios.h or it will generate an error. */
     522: #if defined(HAVE_SYS_TERMIO_H) && !defined(__hpux)
     523: #include <sys/termio.h>
     524: #endif
     525: 
     526: #if defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY)
     527: #if !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H)
     528: /* BSDI does not supply a prototype for the 'openpty' and 'forkpty'
     529:    functions, even though they are included in libutil. */
     530: #include <termios.h>
     531: extern int openpty(int *, int *, char *, struct termios *, struct winsize *);
     532: extern pid_t forkpty(int *, char *, struct termios *, struct winsize *);
     533: #endif /* !defined(HAVE_PTY_H) && !defined(HAVE_LIBUTIL_H) */
     534: #endif /* defined(HAVE_OPENPTY) || defined(HAVE_FORKPTY) */
     535: 
     536: 
     537: /* On 4.4BSD-descendants, ctype functions serves the whole range of
     538:  * wchar_t character set rather than single byte code points only.
     539:  * This characteristic can break some operations of string object
     540:  * including str.upper() and str.split() on UTF-8 locales.  This
     541:  * workaround was provided by Tim Robbins of FreeBSD project.
     542:  */
     543: 
     544: #ifdef __FreeBSD__
     545: #include <osreldate.h>
     546: #if (__FreeBSD_version >= 500040 && __FreeBSD_version < 602113) || \
     547:     (__FreeBSD_version >= 700000 && __FreeBSD_version < 700054) || \
     548:     (__FreeBSD_version >= 800000 && __FreeBSD_version < 800001)
     549: # define _PY_PORT_CTYPE_UTF8_ISSUE
     550: #endif
     551: #endif
     552: 
     553: 
     554: #if defined(__APPLE__)
     555: # define _PY_PORT_CTYPE_UTF8_ISSUE
     556: #endif
     557: 
     558: #ifdef _PY_PORT_CTYPE_UTF8_ISSUE
     559: #ifndef __cplusplus
     560:    /* The workaround below is unsafe in C++ because
     561:     * the <locale> defines these symbols as real functions,
     562:     * with a slightly different signature.
     563:     * See issue #10910
     564:     */
     565: #include <ctype.h>
     566: #include <wctype.h>
     567: #undef isalnum
     568: #define isalnum(c) iswalnum(btowc(c))
     569: #undef isalpha
     570: #define isalpha(c) iswalpha(btowc(c))
     571: #undef islower
     572: #define islower(c) iswlower(btowc(c))
     573: #undef isspace
     574: #define isspace(c) iswspace(btowc(c))
     575: #undef isupper
     576: #define isupper(c) iswupper(btowc(c))
     577: #undef tolower
     578: #define tolower(c) towlower(btowc(c))
     579: #undef toupper
     580: #define toupper(c) towupper(btowc(c))
     581: #endif
     582: #endif
     583: 
     584: 
     585: /* Declarations for symbol visibility.
     586: 
     587:   PyAPI_FUNC(type): Declares a public Python API function and return type
     588:   PyAPI_DATA(type): Declares public Python data and its type
     589:   PyMODINIT_FUNC:   A Python module init function.  If these functions are
     590:                     inside the Python core, they are private to the core.
     591:                     If in an extension module, it may be declared with
     592:                     external linkage depending on the platform.
     593: 
     594:   As a number of platforms support/require "__declspec(dllimport/dllexport)",
     595:   we support a HAVE_DECLSPEC_DLL macro to save duplication.
     596: */
     597: 
     598: /*
     599:   All windows ports, except cygwin, are handled in PC/pyconfig.h.
     600: 
     601:   Cygwin is the only other autoconf platform requiring special
     602:   linkage handling and it uses __declspec().
     603: */
     604: #if defined(__CYGWIN__)
     605: #       define HAVE_DECLSPEC_DLL
     606: #endif
     607: 
     608: /* only get special linkage if built as shared or platform is Cygwin */
     609: #if defined(Py_ENABLE_SHARED) || defined(__CYGWIN__)
     610: #       if defined(HAVE_DECLSPEC_DLL)
     611: #               ifdef Py_BUILD_CORE
     612: #                       define PyAPI_FUNC(RTYPE) __declspec(dllexport) RTYPE
     613: #                       define PyAPI_DATA(RTYPE) extern __declspec(dllexport) RTYPE
     614:         /* module init functions inside the core need no external linkage */
     615:         /* except for Cygwin to handle embedding */
     616: #                       if defined(__CYGWIN__)
     617: #                               define PyMODINIT_FUNC __declspec(dllexport) PyObject*
     618: #                       else /* __CYGWIN__ */
     619: #                               define PyMODINIT_FUNC PyObject*
     620: #                       endif /* __CYGWIN__ */
     621: #               else /* Py_BUILD_CORE */
     622:         /* Building an extension module, or an embedded situation */
     623:         /* public Python functions and data are imported */
     624:         /* Under Cygwin, auto-import functions to prevent compilation */
     625:         /* failures similar to those described at the bottom of 4.1: */
     626:         /* http://docs.python.org/extending/windows.html#a-cookbook-approach */
     627: #                       if !defined(__CYGWIN__)
     628: #                               define PyAPI_FUNC(RTYPE) __declspec(dllimport) RTYPE
     629: #                       endif /* !__CYGWIN__ */
     630: #                       define PyAPI_DATA(RTYPE) extern __declspec(dllimport) RTYPE
     631:         /* module init functions outside the core must be exported */
     632: #                       if defined(__cplusplus)
     633: #                               define PyMODINIT_FUNC extern "C" __declspec(dllexport) PyObject*
     634: #                       else /* __cplusplus */
     635: #                               define PyMODINIT_FUNC __declspec(dllexport) PyObject*
     636: #                       endif /* __cplusplus */
     637: #               endif /* Py_BUILD_CORE */
     638: #       endif /* HAVE_DECLSPEC */
     639: #endif /* Py_ENABLE_SHARED */
     640: 
     641: /* If no external linkage macros defined by now, create defaults */
     642: #ifndef PyAPI_FUNC
     643: #       define PyAPI_FUNC(RTYPE) RTYPE
     644: #endif
     645: #ifndef PyAPI_DATA
     646: #       define PyAPI_DATA(RTYPE) extern RTYPE
     647: #endif
     648: #ifndef PyMODINIT_FUNC
     649: #       if defined(__cplusplus)
     650: #               define PyMODINIT_FUNC extern "C" PyObject*
     651: #       else /* __cplusplus */
     652: #               define PyMODINIT_FUNC PyObject*
     653: #       endif /* __cplusplus */
     654: #endif
     655: 
     656: /* limits.h constants that may be missing */
     657: 
     658: #ifndef INT_MAX
     659: #define INT_MAX 2147483647
     660: #endif
     661: 
     662: #ifndef LONG_MAX
     663: #if SIZEOF_LONG == 4
     664: #define LONG_MAX 0X7FFFFFFFL
     665: #elif SIZEOF_LONG == 8
     666: #define LONG_MAX 0X7FFFFFFFFFFFFFFFL
     667: #else
     668: #error "could not set LONG_MAX in pyport.h"
     669: #endif
     670: #endif
     671: 
     672: #ifndef LONG_MIN
     673: #define LONG_MIN (-LONG_MAX-1)
     674: #endif
     675: 
     676: #ifndef LONG_BIT
     677: #define LONG_BIT (8 * SIZEOF_LONG)
     678: #endif
     679: 
     680: #if LONG_BIT != 8 * SIZEOF_LONG
     681: /* 04-Oct-2000 LONG_BIT is apparently (mis)defined as 64 on some recent
     682:  * 32-bit platforms using gcc.  We try to catch that here at compile-time
     683:  * rather than waiting for integer multiplication to trigger bogus
     684:  * overflows.
     685:  */
     686: #error "LONG_BIT definition appears wrong for platform (bad gcc/glibc config?)."
     687: #endif
     688: 
     689: #ifdef __cplusplus
     690: }
     691: #endif
     692: 
     693: /*
     694:  * Hide GCC attributes from compilers that don't support them.
     695:  */
     696: #if (!defined(__GNUC__) || __GNUC__ < 2 || \
     697:      (__GNUC__ == 2 && __GNUC_MINOR__ < 7) )
     698: #define Py_GCC_ATTRIBUTE(x)
     699: #else
     700: #define Py_GCC_ATTRIBUTE(x) __attribute__(x)
     701: #endif
     702: 
     703: /*
     704:  * Specify alignment on compilers that support it.
     705:  */
     706: #if defined(__GNUC__) && __GNUC__ >= 3
     707: #define Py_ALIGNED(x) __attribute__((aligned(x)))
     708: #else
     709: #define Py_ALIGNED(x)
     710: #endif
     711: 
     712: /* Eliminate end-of-loop code not reached warnings from SunPro C
     713:  * when using do{...}while(0) macros
     714:  */
     715: #ifdef __SUNPRO_C
     716: #pragma error_messages (off,E_END_OF_LOOP_CODE_NOT_REACHED)
     717: #endif
     718: 
     719: #ifndef Py_LL
     720: #define Py_LL(x) x##LL
     721: #endif
     722: 
     723: #ifndef Py_ULL
     724: #define Py_ULL(x) Py_LL(x##U)
     725: #endif
     726: 
     727: #define Py_VA_COPY va_copy
     728: 
     729: /*
     730:  * Convenient macros to deal with endianness of the platform. WORDS_BIGENDIAN is
     731:  * detected by configure and defined in pyconfig.h. The code in pyconfig.h
     732:  * also takes care of Apple's universal builds.
     733:  */
     734: 
     735: #ifdef WORDS_BIGENDIAN
     736: #define PY_BIG_ENDIAN 1
     737: #define PY_LITTLE_ENDIAN 0
     738: #else
     739: #define PY_BIG_ENDIAN 0
     740: #define PY_LITTLE_ENDIAN 1
     741: #endif
     742: 
     743: #ifdef Py_BUILD_CORE
     744: /*
     745:  * Macros to protect CRT calls against instant termination when passed an
     746:  * invalid parameter (issue23524).
     747:  */
     748: #if defined _MSC_VER && _MSC_VER >= 1900
     749: 
     750: extern _invalid_parameter_handler _Py_silent_invalid_parameter_handler;
     751: #define _Py_BEGIN_SUPPRESS_IPH { _invalid_parameter_handler _Py_old_handler = \
     752:     _set_thread_local_invalid_parameter_handler(_Py_silent_invalid_parameter_handler);
     753: #define _Py_END_SUPPRESS_IPH _set_thread_local_invalid_parameter_handler(_Py_old_handler); }
     754: 
     755: #else
     756: 
     757: #define _Py_BEGIN_SUPPRESS_IPH
     758: #define _Py_END_SUPPRESS_IPH
     759: 
     760: #endif /* _MSC_VER >= 1900 */
     761: #endif /* Py_BUILD_CORE */
     762: 
     763: #ifdef __ANDROID__
     764: #include <android/api-level.h>
     765: #endif
     766: 
     767: #endif /* Py_PYPORT_H */
     768: