This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix bit-fields for VC [was RE: [perl #50386] GIMME_V broken with 5.10.0/GCC and XS?]
[perl5.git] / win32 / win32.h
index 830025f..7bfeb15 100644 (file)
@@ -1,6 +1,6 @@
 /* WIN32.H
  *
- * (c) 1995 Microsoft Corporation. All rights reserved. 
+ * (c) 1995 Microsoft Corporation. All rights reserved.
  *             Developed by hip communications inc., http://info.hip.com/info/
  *
  *    You may distribute under the terms of either the GNU General Public
 #  define Win32_Winsock
 #ifdef __cplusplus
 /* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
-#undef  PERL_UNUSED_DECL 
-#define PERL_UNUSED_DECL 
+#undef  PERL_UNUSED_DECL
+#define PERL_UNUSED_DECL
 #endif
 #endif
 
 
-/* Define DllExport akin to perl's EXT, 
+/* Define DllExport akin to perl's EXT,
  * If we are in the DLL or mimicing the DLL for Win95 work round
- * then Export the symbol, 
+ * then Export the symbol,
  * otherwise import it.
  */
 
@@ -51,7 +51,7 @@
 #if defined(PERLDLL) || defined(WIN95FIX)
 #define DllExport
 /*#define DllExport __declspec(dllexport)*/    /* noises with VC5+sp3 */
-#else 
+#else
 #define DllExport __declspec(dllimport)
 #endif
 
@@ -72,6 +72,7 @@
 #include <stdio.h>
 #include <direct.h>
 #include <stdlib.h>
+#include <stddef.h>
 #include <fcntl.h>
 #ifndef EXT
 #include "EXTERN.h"
@@ -103,8 +104,8 @@ struct utsname {
 #  define END_EXTERN_C }
 #  define EXTERN_C extern "C"
 #else
-#  define START_EXTERN_C 
-#  define END_EXTERN_C 
+#  define START_EXTERN_C
+#  define END_EXTERN_C
 #  define EXTERN_C
 #endif
 #endif
@@ -126,8 +127,11 @@ struct utsname {
 /* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
    It now uses some black magic to work seamlessly with the DLL CRT and
    works with MSVC++ 4.0+ or GCC/Mingw32
-       -- BKS 1-24-2000 */
-#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
+       -- BKS 1-24-2000
+   Only use this fix for VC++ 6.x or earlier (and for GCC, which we assume
+   uses MSVCRT.DLL). Later versions use MSVCR70.dll, MSVCR71.dll, etc, which
+   do not require the fix. */
+#if (defined(_M_IX86) && _MSC_VER >= 1000 && _MSC_VER <= 1200) || defined(__MINGW32__)
 #define USE_FIXED_OSFHANDLE
 #endif
 
@@ -139,6 +143,8 @@ struct utsname {
 #endif
 #define ENV_IS_CASELESS
 
+#define PIPESOCK_MODE  "b"             /* pipes, sockets default to binmode */
+
 #ifndef VER_PLATFORM_WIN32_WINDOWS     /* VC-2.0 headers don't have this */
 #define VER_PLATFORM_WIN32_WINDOWS     1
 #endif
@@ -164,6 +170,14 @@ struct utsname {
 
 /* Compiler-specific stuff. */
 
+#if defined(_MSC_VER) || defined(__MINGW32__)
+/* VC uses non-standard way to determine the size and alignment if bit-fields */
+/* MinGW will compiler with -mms-bitfields, so should use the same types */
+#  define PERL_BITFIELD8  unsigned char
+#  define PERL_BITFIELD16 unsigned short
+#  define PERL_BITFIELD32 unsigned int
+#endif
+
 #ifdef __BORLANDC__            /* Borland C++ */
 
 #if (__BORLANDC__ <= 0x520)
@@ -179,14 +193,15 @@ struct utsname {
 #define DllMain DllEntryPoint
 #endif
 
-#pragma warn -ccc      /* "condition is always true/false" */
-#pragma warn -rch      /* "unreachable code" */
-#pragma warn -sig      /* "conversion may lose significant digits" */
-#pragma warn -pia      /* "possibly incorrect assignment" */
-#pragma warn -par      /* "parameter 'foo' is never used" */
-#pragma warn -aus      /* "'foo' is assigned a value that is never used" */
-#pragma warn -use      /* "'foo' is declared but never used" */
-#pragma warn -csu      /* "comparing signed and unsigned values" */
+#pragma warn -8004     /* "'foo' is assigned a value that is never used" */
+#pragma warn -8008     /* "condition is always true/false" */
+#pragma warn -8012     /* "comparing signed and unsigned values" */
+#pragma warn -8027     /* "functions containing %s are not expanded inline" */
+#pragma warn -8057     /* "parameter 'foo' is never used" */
+#pragma warn -8060     /* "possibly incorrect assignment" */
+#pragma warn -8066     /* "unreachable code" */
+#pragma warn -8071     /* "conversion may lose significant digits" */
+#pragma warn -8080     /* "'foo' is declared but never used" */
 
 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
 #define PERL_MEMBER_PTR_SIZE   12
@@ -197,15 +212,25 @@ struct utsname {
 
 #ifdef _MSC_VER                        /* Microsoft Visual C++ */
 
+#ifndef UNDER_CE
 typedef long           uid_t;
 typedef long           gid_t;
 typedef unsigned short mode_t;
-#pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
+#endif
+
+#pragma  warning(disable: 4102)        /* "unreferenced label" */
 
 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
 #define PERL_MEMBER_PTR_SIZE   16
 
 #define isnan          _isnan
+#define snprintf       _snprintf
+#define vsnprintf      _vsnprintf
+
+#if _MSC_VER < 1300
+/* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
+#define NAN_COMPARE_BROKEN 1
+#endif
 
 #endif /* _MSC_VER */
 
@@ -227,6 +252,17 @@ typedef long               gid_t;
 #  endif
 #endif
 
+/* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
+ * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
+#ifdef _STDINT_H
+#  ifndef _INTPTR_T_DEFINED
+#    define _INTPTR_T_DEFINED
+#  endif
+#  ifndef _UINTPTR_T_DEFINED
+#    define _UINTPTR_T_DEFINED
+#  endif
+#endif
+
 #endif /* __MINGW32__ */
 
 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
@@ -236,6 +272,16 @@ typedef long               gid_t;
 
 /* compatibility stuff for other compilers goes here */
 
+#ifndef _INTPTR_T_DEFINED
+typedef int            intptr_t;
+#  define _INTPTR_T_DEFINED
+#endif
+
+#ifndef _UINTPTR_T_DEFINED
+typedef unsigned int   uintptr_t;
+#  define _UINTPTR_T_DEFINED
+#endif
+
 START_EXTERN_C
 
 /* For UNIX compatibility. */
@@ -247,7 +293,11 @@ extern  gid_t      getegid(void);
 extern  int    setuid(uid_t uid);
 extern  int    setgid(gid_t gid);
 extern  int    kill(int pid, int sig);
-extern  void   *sbrk(int need);
+extern  int    killpg(int pid, int sig);
+#ifndef USE_PERL_SBRK
+extern  void   *sbrk(ptrdiff_t need);
+#  define HAS_SBRK_PROTO
+#endif
 extern char *  getlogin(void);
 extern int     chown(const char *p, uid_t o, gid_t g);
 extern  int    mkstemp(const char *path);
@@ -259,6 +309,7 @@ extern  int mkstemp(const char *path);
 #define  init_os_extras Perl_init_os_extras
 
 DllExport void         Perl_win32_init(int *argcp, char ***argvp);
+DllExport void         Perl_win32_term(void);
 DllExport void         Perl_init_os_extras(void);
 DllExport void         win32_str_os_error(void *sv, DWORD err);
 DllExport int          RunPerl(int argc, char **argv, char **env);
@@ -276,32 +327,29 @@ typedef struct {
      *   wShowWindow = SW_HIDE;
      */
     DWORD      dwFlags;
-    DWORD      dwX; 
-    DWORD      dwY; 
-    DWORD      dwXSize; 
-    DWORD      dwYSize; 
-    DWORD      dwXCountChars; 
-    DWORD      dwYCountChars; 
+    DWORD      dwX;
+    DWORD      dwY;
+    DWORD      dwXSize;
+    DWORD      dwYSize;
+    DWORD      dwXCountChars;
+    DWORD      dwYCountChars;
     DWORD      dwFillAttribute;
-    WORD       wShowWindow; 
+    WORD       wShowWindow;
 } child_IO_table;
 
 DllExport void         win32_get_child_IO(child_IO_table* ptr);
+DllExport HWND         win32_create_message_window(void);
 
 #ifndef USE_SOCKETS_AS_HANDLES
 extern FILE *          my_fdopen(int, char *);
 #endif
 extern int             my_fclose(FILE *);
-extern int             my_fstat(int fd, struct stat *sbufptr);
-extern int             do_aspawn(void *really, void **mark, void **sp);
-extern int             do_spawn(char *cmd);
-extern int             do_spawn_nowait(char *cmd);
+extern int             my_fstat(int fd, Stat_t *sbufptr);
 extern char *          win32_get_privlib(const char *pl);
 extern char *          win32_get_sitelib(const char *pl);
 extern char *          win32_get_vendorlib(const char *pl);
 extern int             IsWin95(void);
 extern int             IsWinNT(void);
-extern void            win32_argv2utf8(int argc, char** argv);
 
 #ifdef PERL_IMPLICIT_SYS
 extern void            win32_delete_internal_host(void *h);
@@ -325,19 +373,25 @@ typedef  char *           caddr_t;        /* In malloc.c (core address). */
 /* #define PERL_SBRK_VIA_MALLOC        /**/
 #endif
 
-#if defined(PERLDLL) && !defined(PERL_CORE)
-#define PERL_CORE
-#endif
-
 #ifdef PERL_TEXTMODE_SCRIPTS
 #  define PERL_SCRIPT_MODE             "r"
 #else
 #  define PERL_SCRIPT_MODE             "rb"
 #endif
 
-/* 
- * Now Win32 specific per-thread data stuff 
+/*
+ * Now Win32 specific per-thread data stuff
+ */
+
+/* Leave the first couple ids after WM_USER unused because they
+ * might be used by an embedding application, and on Windows
+ * version before 2000 we might end up eating those messages
+ * if they were not meant for us.
  */
+#define WM_USER_MIN     (WM_USER+30)
+#define WM_USER_MESSAGE (WM_USER_MIN)
+#define WM_USER_KILL    (WM_USER_MIN+1)
+#define WM_USER_MAX     (WM_USER_MIN+1)
 
 struct thread_intern {
     /* XXX can probably use one buffer instead of several */
@@ -353,14 +407,10 @@ struct thread_intern {
 #    ifdef USE_RTL_THREAD_API
     void *             retv;   /* slot for thread return value */
 #    endif
+    BOOL               Wuse_showwindow;
+    WORD               Wshowwindow;
 };
 
-#ifdef USE_5005THREADS
-#  ifndef USE_DECLSPEC_THREAD
-#    define HAVE_THREAD_INTERN
-#  endif /* !USE_DECLSPEC_THREAD */
-#endif /* USE_5005THREADS */
-
 #define HAVE_INTERP_INTERN
 typedef struct {
     long       num;
@@ -368,6 +418,20 @@ typedef struct {
     HANDLE     handles[MAXIMUM_WAIT_OBJECTS];
 } child_tab;
 
+#ifdef USE_ITHREADS
+typedef struct {
+    long       num;
+    DWORD      pids[MAXIMUM_WAIT_OBJECTS];
+    HANDLE     handles[MAXIMUM_WAIT_OBJECTS];
+    HWND       message_hwnds[MAXIMUM_WAIT_OBJECTS];
+} pseudo_child_tab;
+#endif
+
+#ifndef Sighandler_t
+typedef Signal_t (*Sighandler_t) (int);
+#define Sighandler_t   Sighandler_t
+#endif
+
 struct interp_intern {
     char *     perlshell_tokens;
     char **    perlshell_vec;
@@ -376,14 +440,20 @@ struct interp_intern {
     child_tab *        children;
 #ifdef USE_ITHREADS
     DWORD      pseudo_id;
-    child_tab *        pseudo_children;
+    pseudo_child_tab * pseudo_children;
 #endif
     void *     internal_host;
-#ifndef USE_5005THREADS
     struct thread_intern       thr_intern;
-#endif
+    HWND        message_hwnd;
+    UINT       timerid;
+    unsigned   poll_count;
+    Sighandler_t sigtable[SIG_SIZE];
 };
 
+DllExport int win32_async_check(pTHX);
+
+#define WIN32_POLL_INTERVAL 32768
+#define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
 
 #define w32_perlshell_tokens   (PL_sys_intern.perlshell_tokens)
 #define w32_perlshell_vec      (PL_sys_intern.perlshell_vec)
@@ -398,36 +468,20 @@ struct interp_intern {
 #define w32_num_pseudo_children                (w32_pseudo_children->num)
 #define w32_pseudo_child_pids          (w32_pseudo_children->pids)
 #define w32_pseudo_child_handles       (w32_pseudo_children->handles)
+#define w32_pseudo_child_message_hwnds (w32_pseudo_children->message_hwnds)
 #define w32_internal_host              (PL_sys_intern.internal_host)
-#ifdef USE_5005THREADS
-#  define w32_strerror_buffer  (thr->i.Wstrerror_buffer)
-#  define w32_getlogin_buffer  (thr->i.Wgetlogin_buffer)
-#  define w32_crypt_buffer     (thr->i.Wcrypt_buffer)
-#  define w32_servent          (thr->i.Wservent)
-#  define w32_init_socktype    (thr->i.Winit_socktype)
-#else
-#  define w32_strerror_buffer  (PL_sys_intern.thr_intern.Wstrerror_buffer)
-#  define w32_getlogin_buffer  (PL_sys_intern.thr_intern.Wgetlogin_buffer)
-#  define w32_crypt_buffer     (PL_sys_intern.thr_intern.Wcrypt_buffer)
-#  define w32_servent          (PL_sys_intern.thr_intern.Wservent)
-#  define w32_init_socktype    (PL_sys_intern.thr_intern.Winit_socktype)
-#endif /* USE_5005THREADS */
-
-/* UNICODE<>ANSI translation helpers */
-/* Use CP_ACP when mode is ANSI */
-/* Use CP_UTF8 when mode is UTF8 */
-
-#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
-    (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
-                                   lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
-#define A2WHELPER(lpa, lpw, nBytes)    A2WHELPER_LEN(lpa, -1, lpw, nBytes)
-
-#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
-    (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
-                                      lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
-#define W2AHELPER(lpw, lpa, nChars)    W2AHELPER_LEN(lpw, -1, lpa, nChars)
-
-#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
+#define w32_timerid                    (PL_sys_intern.timerid)
+#define w32_message_hwnd               (PL_sys_intern.message_hwnd)
+#define w32_sighandler                 (PL_sys_intern.sigtable)
+#define w32_poll_count                 (PL_sys_intern.poll_count)
+#define w32_do_async                   (w32_poll_count++ > WIN32_POLL_INTERVAL)
+#define w32_strerror_buffer    (PL_sys_intern.thr_intern.Wstrerror_buffer)
+#define w32_getlogin_buffer    (PL_sys_intern.thr_intern.Wgetlogin_buffer)
+#define w32_crypt_buffer       (PL_sys_intern.thr_intern.Wcrypt_buffer)
+#define w32_servent            (PL_sys_intern.thr_intern.Wservent)
+#define w32_init_socktype      (PL_sys_intern.thr_intern.Winit_socktype)
+#define w32_use_showwindow     (PL_sys_intern.thr_intern.Wuse_showwindow)
+#define w32_showwindow (PL_sys_intern.thr_intern.Wshowwindow)
 
 #ifdef USE_ITHREADS
 #  define PERL_WAIT_FOR_CHILDREN \
@@ -447,6 +501,9 @@ struct interp_intern {
 #ifdef PERL_CORE
 
 /* C doesn't like repeat struct definitions */
+#if defined(__MINGW32__) && (__MINGW32_MAJOR_VERSION>=3)
+#undef _CRTIMP
+#endif
 #ifndef _CRTIMP
 #define _CRTIMP __declspec(dllimport)
 #endif
@@ -455,7 +512,7 @@ struct interp_intern {
  * Control structure for lowio file handles
  */
 typedef struct {
-    long osfhnd;    /* underlying OS file HANDLE */
+    intptr_t osfhnd;/* underlying OS file HANDLE */
     char osfile;    /* attributes of file (e.g., open in text mode?) */
     char pipech;    /* one char buffer for handles opened on pipes */
     int lockinitflag;
@@ -489,10 +546,14 @@ EXTERN_C _CRTIMP ioinfo* __pioinfo[];
 #define _pipech(i)  (_pioinfo(i)->pipech)
 
 /* since we are not doing a dup2(), this works fine */
-#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (long)osfh)
+#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
 #endif
 #endif
 
+/* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
+#if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
+#undef  PERLIO_NOT_STDIO
+#endif
 #define PERLIO_NOT_STDIO 0
 
 #include "perlio.h"
@@ -505,5 +566,31 @@ EXTERN_C _CRTIMP ioinfo* __pioinfo[];
 
 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
 
+#if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
+#define ECONNABORTED WSAECONNABORTED
+#endif
+#if !defined(ECONNRESET) && defined(WSAECONNRESET)
+#define ECONNRESET WSAECONNRESET
+#endif
+#if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
+#define EAFNOSUPPORT WSAEAFNOSUPPORT
+#endif
+/* Why not needed for ECONNREFUSED? --abe */
+
+DllExport void *win32_signal_context(void);
+#define PERL_GET_SIG_CONTEXT win32_signal_context()
+
+#ifdef UNDER_CE
+#define Win_GetModuleHandle   XCEGetModuleHandleA
+#define Win_GetProcAddress    XCEGetProcAddressA
+#define Win_GetModuleFileName XCEGetModuleFileNameA
+#define Win_CreateSemaphore   CreateSemaphoreW
+#else
+#define Win_GetModuleHandle   GetModuleHandle
+#define Win_GetProcAddress    GetProcAddress
+#define Win_GetModuleFileName GetModuleFileName
+#define Win_CreateSemaphore   CreateSemaphore
+#endif
+
 #endif /* _INC_WIN32_PERL5 */