This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
various shenanigans in change#5342
[perl5.git] / win32 / win32.h
index 525ef0f..6f4c0d0 100644 (file)
 #ifndef  _INC_WIN32_PERL5
 #define  _INC_WIN32_PERL5
 
+#ifndef _WIN32_WINNT
+#  define _WIN32_WINNT 0x0400     /* needed for TryEnterCriticalSection() etc. */
+#endif
+
+#if defined(PERL_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
+#  define DYNAMIC_ENV_FETCH
+#  define ENV_HV_NAME "___ENV_HV_NAME___"
+#  define HAS_GETENV_LEN
+#  define prime_env_iter()
+#  define WIN32IO_IS_STDIO             /* don't pull in custom stdio layer */
+#  define WIN32SCK_IS_STDSCK           /* don't pull in custom wsock layer */
+#  ifdef PERL_GLOBAL_STRUCT
+#    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
+#  endif
+#  define win32_get_privlib PerlEnv_lib_path
+#  define win32_get_sitelib PerlEnv_sitelib_path
+#endif
+
+#if defined(PERL_IMPLICIT_CONTEXT)
+/* compat */
+#  define GetPerlInterpreter   Perl_get_context
+#  define SetPerlInterpreter   Perl_set_context
+#endif
+
+#ifdef __GNUC__
+#  ifndef __int64              /* some versions seem to #define it already */
+#    define __int64 long long
+#  endif
+#  define Win32_Winsock
+#endif
+
+/* 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, 
+ * otherwise import it.
+ */
+
+/* now even GCC supports __declspec() */
+
+#if defined(PERL_OBJECT)
+#define DllExport
+#else
+#if defined(PERLDLL) || defined(WIN95FIX)
+#define DllExport
+/*#define DllExport __declspec(dllexport)*/    /* noises with VC5+sp3 */
+#else 
+#define DllExport __declspec(dllimport)
+#endif
+#endif
+
 #define  WIN32_LEAN_AND_MEAN
 #include <windows.h>
 
 #ifdef   WIN32_LEAN_AND_MEAN           /* C file is NOT a Perl5 original. */
 #define  CONTEXT       PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
-#define  index         strchr          /* Why 'index'? */
 #endif /*WIN32_LEAN_AND_MEAN */
 
+#ifndef TLS_OUT_OF_INDEXES
+#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
+#endif
+
 #include <dirent.h>
 #include <io.h>
 #include <process.h>
 #include <stdio.h>
 #include <direct.h>
+#include <stdlib.h>
+#include <fcntl.h>
+#ifndef EXT
+#include "EXTERN.h"
+#endif
 
-/* For UNIX compatibility. */
+struct tms {
+       long    tms_utime;
+       long    tms_stime;
+       long    tms_cutime;
+       long    tms_cstime;
+};
 
-#ifdef __BORLANDC__
+#ifndef SYS_NMLN
+#define SYS_NMLN       257
+#endif
 
-#define _access access
-#define _chdir chdir
-#include <sys/types.h>
+struct utsname {
+    char sysname[SYS_NMLN];
+    char nodename[SYS_NMLN];
+    char release[SYS_NMLN];
+    char version[SYS_NMLN];
+    char machine[SYS_NMLN];
+};
 
-#ifndef DllMain
-#define DllMain DllEntryPoint
+#ifndef START_EXTERN_C
+#undef EXTERN_C
+#ifdef __cplusplus
+#  define START_EXTERN_C extern "C" {
+#  define END_EXTERN_C }
+#  define EXTERN_C extern "C"
+#else
+#  define START_EXTERN_C 
+#  define END_EXTERN_C 
+#  define EXTERN_C
+#endif
 #endif
 
-#pragma warn -ccc
-#pragma warn -rch
-#pragma warn -sig
-#pragma warn -pia
-#pragma warn -par
-#pragma warn -aus
-#pragma warn -use
-#pragma warn -csu
-#pragma warn -pro
+#define  STANDARD_C    1
+#define  DOSISH                1               /* no escaping our roots */
+#define  OP_BINARY     O_BINARY        /* mistake in in pp_sys.c? */
 
-#else
+/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
+ * real filehandles. XXX Should always be defined (the other version is untested) */
+#define USE_SOCKETS_AS_HANDLES
 
-typedef long           uid_t;
-typedef long           gid_t;
+/* read() and write() aren't transparent for socket handles */
+#define PERL_SOCK_SYSREAD_IS_RECV
+#define PERL_SOCK_SYSWRITE_IS_SEND
 
-#endif
+#define PERL_NO_FORCE_LINK             /* no need for PL_force_link_funcs */
 
-#ifdef __cplusplus
-extern "C" {
+/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
+ * to read the environment, bypassing the runtime's (usually broken)
+ * facilities for accessing the same.  See note in util.c/my_setenv(). */
+/*#define USE_WIN32_RTL_ENV */
+
+/* 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__)
+#define USE_FIXED_OSFHANDLE
 #endif
 
-extern  uid_t  getuid(void);
-extern  gid_t  getgid(void);
-extern  uid_t  geteuid(void);
-extern  gid_t  getegid(void);
-extern  int    setuid(uid_t uid);
-extern  int    setgid(gid_t gid);
+#define ENV_IS_CASELESS
 
-extern  int    kill(int pid, int sig);
+#ifndef VER_PLATFORM_WIN32_WINDOWS     /* VC-2.0 headers don't have this */
+#define VER_PLATFORM_WIN32_WINDOWS     1
+#endif
 
-#ifdef __cplusplus
-}
+#ifndef FILE_SHARE_DELETE              /* VC-4.0 headers don't have this */
+#define FILE_SHARE_DELETE              0x00000004
 #endif
 
+/* access() mode bits */
+#ifndef R_OK
+#  define      R_OK    4
+#  define      W_OK    2
+#  define      X_OK    1
+#  define      F_OK    0
+#endif
 
-extern  char   *staticlinkmodules[];
+#define PERL_GET_CONTEXT_DEFINED
 
-/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
- * to read the environment, bypassing the runtime's (usually broken)
- * facilities for accessing the same.  See note in util.c/my_setenv().
- */
-/*#define USE_WIN32_RTL_ENV */
+/* Compiler-specific stuff. */
 
-#ifndef USE_WIN32_RTL_ENV
-#include <stdlib.h>
-#ifndef EXT
-#include "EXTERN.h"
+#ifdef __BORLANDC__            /* Borland C++ */
+
+#define _access access
+#define _chdir chdir
+#define _getpid getpid
+#define wcsicmp _wcsicmp
+#include <sys/types.h>
+
+#ifndef DllMain
+#define DllMain DllEntryPoint
 #endif
-#undef getenv
-#define getenv win32_getenv
-EXT char *win32_getenv(const char *name);
+
+#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 -pro      /* "call to function with no prototype" */
+#pragma warn -stu      /* "undefined structure 'foo'" */
+
+/* Borland is picky about a bare member function name used as its ptr */
+#ifdef PERL_OBJECT
+#  define MEMBER_TO_FPTR(name) &(name)
 #endif
 
-#ifdef __cplusplus
-extern "C" {
+/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
+#define PERL_MEMBER_PTR_SIZE   12
+
 #endif
 
+#ifdef _MSC_VER                        /* Microsoft Visual C++ */
 
-EXT void Perl_win32_init(int *argcp, char ***argvp);
+typedef long           uid_t;
+typedef long           gid_t;
+typedef unsigned short mode_t;
+#pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
 
-#define USE_SOCKETS_AS_HANDLES
-#ifndef USE_SOCKETS_AS_HANDLES
+/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
+#define PERL_MEMBER_PTR_SIZE   16
+
+#endif /* _MSC_VER */
 
-extern FILE *myfdopen(int, char *);
+#ifdef __MINGW32__             /* Minimal Gnu-Win32 */
 
-#undef fdopen
-#define fdopen myfdopen
-#endif /* USE_SOCKETS_AS_HANDLES */
+typedef long           uid_t;
+typedef long           gid_t;
+#ifndef _environ
+#define _environ       environ
+#endif
+#define flushall       _flushall
+#define fcloseall      _fcloseall
 
-#define  STANDARD_C    1               /* Perl5 likes standard C. */
-#define  DOSISH                1               /* Take advantage of DOSish code in Perl5. */
+#ifndef CP_UTF8
+#  define CP_UTF8      65001
+#endif
 
-#define  OP_BINARY     O_BINARY        /* Mistake in in pp_sys.c. */
+#ifdef PERL_OBJECT
+#  define MEMBER_TO_FPTR(name) &(name)
+#endif
 
-#undef  pipe
-#define  pipe(fd)      win32_pipe((fd), 512, O_BINARY) /* the pipe call is a bit different */
+#ifndef _O_NOINHERIT
+#  define _O_NOINHERIT 0x0080
+#  ifndef _NO_OLDNAMES
+#    define O_NOINHERIT        _O_NOINHERIT
+#  endif
+#endif
 
-#undef  pause
-#define  pause()       sleep((32767L << 16) + 32767)
+#endif /* __MINGW32__ */
+
+/* compatibility stuff for other compilers goes here */
+
+
+#if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
+#  define STRUCT_MGVTBL_DEFINITION \
+struct mgvtbl {                                                                \
+    union {                                                            \
+       int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
+       char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
+    };                                                                 \
+    union {                                                            \
+       int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
+       char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
+    };                                                                 \
+    union {                                                            \
+       U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
+       char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
+    };                                                                 \
+    union {                                                            \
+       int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
+       char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
+    };                                                                 \
+    union {                                                            \
+       int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
+       char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
+    };                                                                 \
+}
 
+#  define BASEOP_DEFINITION \
+    OP*                op_next;                                                \
+    OP*                op_sibling;                                             \
+    OP*                (CPERLscope(*op_ppaddr))(pTHX);                         \
+    char       handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
+    PADOFFSET  op_targ;                                                \
+    OPCODE     op_type;                                                \
+    U16                op_seq;                                                 \
+    U8         op_flags;                                               \
+    U8         op_private;
 
-#undef  times
-#define  times mytimes
+#endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
 
-#undef  alarm
-#define  alarm myalarm
 
-struct tms {
-       long    tms_utime;
-       long    tms_stime;
-       long    tms_cutime;
-       long    tms_cstime;
-};
+START_EXTERN_C
 
-unsigned int sleep(unsigned int);
-char *win32PerlLibPath(void);
-char *win32SiteLibPath(void);
-int mytimes(struct tms *timebuf);
-unsigned int myalarm(unsigned int sec);
-int do_aspawn(void* really, void ** mark, void ** arglast);
-int do_spawn(char *cmd);
-char do_exec(char *cmd);
-void init_os_extras(void);
+/* For UNIX compatibility. */
 
-#ifdef __cplusplus
-}
+extern  uid_t  getuid(void);
+extern  gid_t  getgid(void);
+extern  uid_t  geteuid(void);
+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 char *  getlogin(void);
+extern int     chown(const char *p, uid_t o, gid_t g);
+
+#undef  Stat
+#define  Stat          win32_stat
+
+#undef   init_os_extras
+#define  init_os_extras Perl_init_os_extras
+
+DllExport void         Perl_win32_init(int *argcp, char ***argvp);
+DllExport void         Perl_init_os_extras();
+DllExport void         win32_str_os_error(void *sv, DWORD err);
+DllExport int          RunPerl(int argc, char **argv, char **env);
+
+typedef struct {
+    HANDLE     childStdIn;
+    HANDLE     childStdOut;
+    HANDLE     childStdErr;
+} child_IO_table;
+
+DllExport void         win32_get_child_IO(child_IO_table* ptr);
+
+#ifndef USE_SOCKETS_AS_HANDLES
+extern FILE *          my_fdopen(int, char *);
 #endif
+extern int             my_fclose(FILE *);
+extern int             do_aspawn(void *really, void **mark, void **sp);
+extern int             do_spawn(char *cmd);
+extern int             do_spawn_nowait(char *cmd);
+extern char *          win32_get_privlib(char *pl);
+extern char *          win32_get_sitelib(char *pl);
+extern int             IsWin95(void);
+extern int             IsWinNT(void);
 
-typedef  char *                caddr_t;        /* In malloc.c (core address). */
+extern char *          staticlinkmodules[];
 
-/*
- * Extension Library, only good for VC
- */
+END_EXTERN_C
 
-#define DllExport      __declspec(dllexport)
-#define DllImport      __declspec(dllimport)
+typedef  char *                caddr_t;        /* In malloc.c (core address). */
 
 /*
  * handle socket stuff, assuming socket is always available
  */
-
 #include <sys/socket.h>
 #include <netdb.h>
 
-#ifdef _MSC_VER
-#pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
+#ifdef MYMALLOC
+#define EMBEDMYMALLOC  /**/
+/* #define USE_PERL_SBRK       /**/
+/* #define PERL_SBRK_VIA_MALLOC        /**/
 #endif
 
-#ifdef __cplusplus
-extern "C" {
+#if defined(PERLDLL) && !defined(PERL_CORE)
+#define PERL_CORE
 #endif
 
-int IsWin95(void);
-int IsWinNT(void);
+#ifdef PERL_TEXTMODE_SCRIPTS
+#  define PERL_SCRIPT_MODE             "r"
+#else
+#  define PERL_SCRIPT_MODE             "rb"
+#endif
 
-#ifdef __cplusplus
-}
+/* 
+ * Now Win32 specific per-thread data stuff 
+ */
+
+struct thread_intern {
+    /* XXX can probably use one buffer instead of several */
+    char               Wstrerror_buffer[512];
+    struct servent     Wservent;
+    char               Wgetlogin_buffer[128];
+#    ifdef USE_SOCKETS_AS_HANDLES
+    int                        Winit_socktype;
+#    endif
+#    ifdef HAVE_DES_FCRYPT
+    char               Wcrypt_buffer[30];
+#    endif
+#    ifdef USE_RTL_THREAD_API
+    void *             retv;   /* slot for thread return value */
+#    endif
+};
+
+#ifdef USE_THREADS
+#  ifndef USE_DECLSPEC_THREAD
+#    define HAVE_THREAD_INTERN
+#  endif /* !USE_DECLSPEC_THREAD */
+#endif /* USE_THREADS */
+
+#define HAVE_INTERP_INTERN
+typedef struct {
+    long       num;
+    DWORD      pids[MAXIMUM_WAIT_OBJECTS];
+    HANDLE     handles[MAXIMUM_WAIT_OBJECTS];
+} child_tab;
+
+struct interp_intern {
+    char *     perlshell_tokens;
+    char **    perlshell_vec;
+    long       perlshell_items;
+    struct av *        fdpid;
+    child_tab *        children;
+#ifdef USE_ITHREADS
+    DWORD      pseudo_id;
+    child_tab *        pseudo_children;
 #endif
+    void *     internal_host;
+#ifndef USE_THREADS
+    struct thread_intern       thr_intern;
+#endif
+};
 
 
-#ifndef VER_PLATFORM_WIN32_WINDOWS     /* VC-2.0 headers dont have this */
-#define VER_PLATFORM_WIN32_WINDOWS     1
+#define w32_perlshell_tokens   (PL_sys_intern.perlshell_tokens)
+#define w32_perlshell_vec      (PL_sys_intern.perlshell_vec)
+#define w32_perlshell_items    (PL_sys_intern.perlshell_items)
+#define w32_fdpid              (PL_sys_intern.fdpid)
+#define w32_children           (PL_sys_intern.children)
+#define w32_num_children       (w32_children->num)
+#define w32_child_pids         (w32_children->pids)
+#define w32_child_handles      (w32_children->handles)
+#define w32_pseudo_id          (PL_sys_intern.pseudo_id)
+#define w32_pseudo_children    (PL_sys_intern.pseudo_children)
+#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_internal_host              (PL_sys_intern.internal_host)
+#ifdef USE_THREADS
+#  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_THREADS */
+
+/* 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_BYTE) ? 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_BYTE) ? 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)
+
+#ifdef USE_ITHREADS
+#  define PERL_WAIT_FOR_CHILDREN \
+    STMT_START {                                                       \
+       if (w32_pseudo_children && w32_num_pseudo_children) {           \
+           long children = w32_num_pseudo_children;                    \
+           WaitForMultipleObjects(children,                            \
+                                  w32_pseudo_child_handles,            \
+                                  TRUE, INFINITE);                     \
+           while (children)                                            \
+               CloseHandle(w32_pseudo_child_handles[--children]);      \
+       }                                                               \
+    } STMT_END
 #endif
 
+/*
+ * This provides a layer of functions and macros to ensure extensions will
+ * get to use the same RTL functions as the core.
+ */
+#include "win32iop.h"
+
 #endif /* _INC_WIN32_PERL5 */
+