minor tweaks in Porting/pumpkin.pod
[p5sagit/p5-mst-13.2.git] / win32 / win32.h
CommitLineData
68dc0745 1/* WIN32.H
2 *
3fadfdf1 3 * (c) 1995 Microsoft Corporation. All rights reserved.
68dc0745 4 * Developed by hip communications inc., http://info.hip.com/info/
5 *
6 * You may distribute under the terms of either the GNU General Public
7 * License or the Artistic License, as specified in the README file.
8 */
0a753a76 9#ifndef _INC_WIN32_PERL5
10#define _INC_WIN32_PERL5
11
5db10396 12#ifndef _WIN32_WINNT
13# define _WIN32_WINNT 0x0400 /* needed for TryEnterCriticalSection() etc. */
14#endif
638eceb6 15
acfe0abc 16#if defined(PERL_IMPLICIT_SYS)
e9ee4811 17# define DYNAMIC_ENV_FETCH
a6c40364 18# define HAS_GETENV_LEN
e9ee4811 19# define prime_env_iter()
ab39fa9d 20# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 21# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 22# ifdef PERL_GLOBAL_STRUCT
32e30700 23# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 24# endif
e5a95ffb 25# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 26# define win32_get_sitelib PerlEnv_sitelib_path
4ea817c6 27# define win32_get_vendorlib PerlEnv_vendorlib_path
9d8a25dc 28#endif
29
a835ef8a 30#ifdef __GNUC__
b7c82df9 31# ifndef __int64 /* some versions seem to #define it already */
32# define __int64 long long
33# endif
db15561c 34# define Win32_Winsock
1c85e96a 35#ifdef __cplusplus
36/* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
3fadfdf1 37#undef PERL_UNUSED_DECL
38#define PERL_UNUSED_DECL
a835ef8a 39#endif
1c85e96a 40#endif
41
a835ef8a 42
3fadfdf1 43/* Define DllExport akin to perl's EXT,
22239a37 44 * If we are in the DLL or mimicing the DLL for Win95 work round
3fadfdf1 45 * then Export the symbol,
22239a37 46 * otherwise import it.
47 */
48
5db10396 49/* now even GCC supports __declspec() */
50
22239a37 51#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52 52#define DllExport
53/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
3fadfdf1 54#else
22239a37 55#define DllExport __declspec(dllimport)
56#endif
c69f112c 57
0a753a76 58#define WIN32_LEAN_AND_MEAN
59#include <windows.h>
60
68dc0745 61#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
62#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 63#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 64
eda5ff31 65#ifndef TLS_OUT_OF_INDEXES
66#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
67#endif
68
0a753a76 69#include <dirent.h>
70#include <io.h>
71#include <process.h>
72#include <stdio.h>
73#include <direct.h>
390b85e7 74#include <stdlib.h>
c623ac67 75#include <stddef.h>
7a1f88ac 76#include <fcntl.h>
390b85e7 77#ifndef EXT
78#include "EXTERN.h"
79#endif
80
c69f112c 81struct tms {
82 long tms_utime;
83 long tms_stime;
84 long tms_cutime;
85 long tms_cstime;
86};
87
b2af26b1 88#ifndef SYS_NMLN
89#define SYS_NMLN 257
90#endif
91
92struct utsname {
93 char sysname[SYS_NMLN];
94 char nodename[SYS_NMLN];
95 char release[SYS_NMLN];
96 char version[SYS_NMLN];
97 char machine[SYS_NMLN];
98};
99
390b85e7 100#ifndef START_EXTERN_C
b3e5c95e 101#undef EXTERN_C
390b85e7 102#ifdef __cplusplus
103# define START_EXTERN_C extern "C" {
104# define END_EXTERN_C }
105# define EXTERN_C extern "C"
106#else
3fadfdf1 107# define START_EXTERN_C
108# define END_EXTERN_C
390b85e7 109# define EXTERN_C
110#endif
111#endif
112
113#define STANDARD_C 1
114#define DOSISH 1 /* no escaping our roots */
115#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 116
f3986ebb 117/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
118 * real filehandles. XXX Should always be defined (the other version is untested) */
119#define USE_SOCKETS_AS_HANDLES
120
a7092146 121/* read() and write() aren't transparent for socket handles */
122#define PERL_SOCK_SYSREAD_IS_RECV
123#define PERL_SOCK_SYSWRITE_IS_SEND
124
682fc664 125#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 126
9e5f57de 127/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
128 It now uses some black magic to work seamlessly with the DLL CRT and
129 works with MSVC++ 4.0+ or GCC/Mingw32
130 -- BKS 1-24-2000 */
131#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb 132#define USE_FIXED_OSFHANDLE
133#endif
134
6940069f 135/* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
136 DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
137 -- BKS 5-29-2000 */
138#if !(defined(_M_IX86) && _MSC_VER >= 1200)
139#define PERL_WIN32_SOCK_DLOAD
140#endif
902173a3 141#define ENV_IS_CASELESS
142
d41de25a 143#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb 144#define VER_PLATFORM_WIN32_WINDOWS 1
145#endif
146
d41de25a 147#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
148#define FILE_SHARE_DELETE 0x00000004
149#endif
150
327c3667 151/* access() mode bits */
152#ifndef R_OK
153# define R_OK 4
154# define W_OK 2
155# define X_OK 1
156# define F_OK 0
157#endif
158
cc236deb 159/* for waitpid() */
160#ifndef WNOHANG
161# define WNOHANG 1
162#endif
163
c44d3fdb 164#define PERL_GET_CONTEXT_DEFINED
165
f3986ebb 166/* Compiler-specific stuff. */
167
910dfcc8 168#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d 169
cb359b41 170#if (__BORLANDC__ <= 0x520)
3e3baf6d 171#define _access access
172#define _chdir chdir
cb359b41 173#endif
174
4ce4f76e 175#define _getpid getpid
26871e0a 176#define wcsicmp _wcsicmp
3e3baf6d 177#include <sys/types.h>
178
84902520 179#ifndef DllMain
180#define DllMain DllEntryPoint
181#endif
182
189b2af5 183#pragma warn -ccc /* "condition is always true/false" */
184#pragma warn -rch /* "unreachable code" */
185#pragma warn -sig /* "conversion may lose significant digits" */
186#pragma warn -pia /* "possibly incorrect assignment" */
187#pragma warn -par /* "parameter 'foo' is never used" */
188#pragma warn -aus /* "'foo' is assigned a value that is never used" */
189#pragma warn -use /* "'foo' is declared but never used" */
190#pragma warn -csu /* "comparing signed and unsigned values" */
3e3baf6d 191
cd183fd9 192/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
193#define PERL_MEMBER_PTR_SIZE 12
194
1307044d 195#define isnan _isnan
196
910dfcc8 197#endif
3e3baf6d 198
f3986ebb 199#ifdef _MSC_VER /* Microsoft Visual C++ */
200
0a753a76 201typedef long uid_t;
202typedef long gid_t;
a6c40364 203typedef unsigned short mode_t;
c623ac67 204#pragma warning(disable: 4102) /* "unreferenced label" */
f3986ebb 205
0f4eea8f 206/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
cd183fd9 207#define PERL_MEMBER_PTR_SIZE 16
0f4eea8f 208
5fb4d820 209#define isnan _isnan
210
f3986ebb 211#endif /* _MSC_VER */
212
910dfcc8 213#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
214
215typedef long uid_t;
216typedef long gid_t;
b1d1613b 217#ifndef _environ
3730b96e 218#define _environ environ
b1d1613b 219#endif
3730b96e 220#define flushall _flushall
221#define fcloseall _fcloseall
6940069f 222#define isnan _isnan /* ...same libraries as MSVC */
910dfcc8 223
ac4c12e7 224#ifndef _O_NOINHERIT
225# define _O_NOINHERIT 0x0080
226# ifndef _NO_OLDNAMES
227# define O_NOINHERIT _O_NOINHERIT
228# endif
229#endif
230
910dfcc8 231#endif /* __MINGW32__ */
232
f8fb7c90 233/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
234#ifndef CP_UTF8
235# define CP_UTF8 65001
236#endif
237
f3986ebb 238/* compatibility stuff for other compilers goes here */
0a753a76 239
c623ac67 240#ifndef _INTPTR_T_DEFINED
241typedef int intptr_t;
242# define _INTPTR_T_DEFINED
243#endif
244
245#ifndef _UINTPTR_T_DEFINED
246typedef unsigned int uintptr_t;
247# define _UINTPTR_T_DEFINED
248#endif
249
390b85e7 250START_EXTERN_C
f3986ebb 251
252/* For UNIX compatibility. */
253
0a753a76 254extern uid_t getuid(void);
255extern gid_t getgid(void);
256extern uid_t geteuid(void);
257extern gid_t getegid(void);
0a753a76 258extern int setuid(uid_t uid);
259extern int setgid(gid_t gid);
260extern int kill(int pid, int sig);
c623ac67 261#ifndef USE_PERL_SBRK
262extern void *sbrk(ptrdiff_t need);
263# define HAS_SBRK_PROTO
264#endif
e34ffe5a 265extern char * getlogin(void);
b990f8c8 266extern int chown(const char *p, uid_t o, gid_t g);
00b02797 267extern int mkstemp(const char *path);
d55594ae 268
f3986ebb 269#undef Stat
270#define Stat win32_stat
3e3baf6d 271
f3986ebb 272#undef init_os_extras
273#define init_os_extras Perl_init_os_extras
390b85e7 274
22239a37 275DllExport void Perl_win32_init(int *argcp, char ***argvp);
cb359b41 276DllExport void Perl_init_os_extras(void);
c5be433b 277DllExport void win32_str_os_error(void *sv, DWORD err);
278DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 279
635bbe87 280typedef struct {
281 HANDLE childStdIn;
282 HANDLE childStdOut;
283 HANDLE childStdErr;
f83751a7 284 /*
285 * the following correspond to the fields of the same name
286 * in the STARTUPINFO structure. Embedders can use these to
287 * control the spawning process' look.
288 * Example - to hide the window of the spawned process:
289 * dwFlags = STARTF_USESHOWWINDOW;
290 * wShowWindow = SW_HIDE;
291 */
292 DWORD dwFlags;
3fadfdf1 293 DWORD dwX;
294 DWORD dwY;
295 DWORD dwXSize;
296 DWORD dwYSize;
297 DWORD dwXCountChars;
298 DWORD dwYCountChars;
f83751a7 299 DWORD dwFillAttribute;
3fadfdf1 300 WORD wShowWindow;
635bbe87 301} child_IO_table;
302
303DllExport void win32_get_child_IO(child_IO_table* ptr);
304
f3986ebb 305#ifndef USE_SOCKETS_AS_HANDLES
306extern FILE * my_fdopen(int, char *);
d55594ae 307#endif
f3986ebb 308extern int my_fclose(FILE *);
c623ac67 309extern int my_fstat(int fd, Stat_t *sbufptr);
4ea817c6 310extern char * win32_get_privlib(const char *pl);
311extern char * win32_get_sitelib(const char *pl);
312extern char * win32_get_vendorlib(const char *pl);
f3986ebb 313extern int IsWin95(void);
314extern int IsWinNT(void);
c0932edc 315extern void win32_argv2utf8(int argc, char** argv);
d55594ae 316
1c0ca838 317#ifdef PERL_IMPLICIT_SYS
318extern void win32_delete_internal_host(void *h);
319#endif
320
f3986ebb 321extern char * staticlinkmodules[];
390b85e7 322
323END_EXTERN_C
d55594ae 324
68dc0745 325typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 326
68dc0745 327/*
68dc0745 328 * handle socket stuff, assuming socket is always available
329 */
0a753a76 330#include <sys/socket.h>
331#include <netdb.h>
332
bbc8f9de 333#ifdef MYMALLOC
334#define EMBEDMYMALLOC /**/
335/* #define USE_PERL_SBRK /**/
336/* #define PERL_SBRK_VIA_MALLOC /**/
337#endif
338
c31fac66 339#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de 340#define PERL_CORE
341#endif
342
e68cb057 343#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 344# define PERL_SCRIPT_MODE "r"
a868473f 345#else
c39cd008 346# define PERL_SCRIPT_MODE "rb"
a868473f 347#endif
348
3fadfdf1 349/*
350 * Now Win32 specific per-thread data stuff
3352bfcb 351 */
352
353struct thread_intern {
354 /* XXX can probably use one buffer instead of several */
355 char Wstrerror_buffer[512];
356 struct servent Wservent;
357 char Wgetlogin_buffer[128];
358# ifdef USE_SOCKETS_AS_HANDLES
359 int Winit_socktype;
360# endif
361# ifdef HAVE_DES_FCRYPT
362 char Wcrypt_buffer[30];
363# endif
364# ifdef USE_RTL_THREAD_API
365 void * retv; /* slot for thread return value */
366# endif
02637f4c 367 BOOL Wuse_showwindow;
368 WORD Wshowwindow;
3352bfcb 369};
370
4d1ff10f 371#ifdef USE_5005THREADS
3352bfcb 372# ifndef USE_DECLSPEC_THREAD
373# define HAVE_THREAD_INTERN
374# endif /* !USE_DECLSPEC_THREAD */
4d1ff10f 375#endif /* USE_5005THREADS */
3352bfcb 376
4b556e6c 377#define HAVE_INTERP_INTERN
0aaad0ff 378typedef struct {
379 long num;
380 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 381 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff 382} child_tab;
383
3fadfdf1 384#ifndef Sighandler_t
385typedef Signal_t (*Sighandler_t) (int);
386#define Sighandler_t Sighandler_t
387#endif
388
4b556e6c 389struct interp_intern {
0aaad0ff 390 char * perlshell_tokens;
391 char ** perlshell_vec;
392 long perlshell_items;
393 struct av * fdpid;
394 child_tab * children;
7766f137 395#ifdef USE_ITHREADS
396 DWORD pseudo_id;
397 child_tab * pseudo_children;
398#endif
399 void * internal_host;
4d1ff10f 400#ifndef USE_5005THREADS
3352bfcb 401 struct thread_intern thr_intern;
402#endif
8fb3fcfb 403 UINT timerid;
05ec9bb3 404 unsigned poll_count;
3fadfdf1 405 Sighandler_t sigtable[SIG_SIZE];
4b556e6c 406};
407
8fb3fcfb 408DllExport int win32_async_check(pTHX);
409
05ec9bb3 410#define WIN32_POLL_INTERVAL 32768
8fb3fcfb 411#define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
4b556e6c 412
0aaad0ff 413#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
414#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
415#define w32_perlshell_items (PL_sys_intern.perlshell_items)
416#define w32_fdpid (PL_sys_intern.fdpid)
417#define w32_children (PL_sys_intern.children)
418#define w32_num_children (w32_children->num)
419#define w32_child_pids (w32_children->pids)
7766f137 420#define w32_child_handles (w32_children->handles)
421#define w32_pseudo_id (PL_sys_intern.pseudo_id)
422#define w32_pseudo_children (PL_sys_intern.pseudo_children)
423#define w32_num_pseudo_children (w32_pseudo_children->num)
424#define w32_pseudo_child_pids (w32_pseudo_children->pids)
425#define w32_pseudo_child_handles (w32_pseudo_children->handles)
426#define w32_internal_host (PL_sys_intern.internal_host)
8fb3fcfb 427#define w32_timerid (PL_sys_intern.timerid)
3fadfdf1 428#define w32_sighandler (PL_sys_intern.sigtable)
05ec9bb3 429#define w32_poll_count (PL_sys_intern.poll_count)
430#define w32_do_async (w32_poll_count++ > WIN32_POLL_INTERVAL)
4d1ff10f 431#ifdef USE_5005THREADS
3352bfcb 432# define w32_strerror_buffer (thr->i.Wstrerror_buffer)
433# define w32_getlogin_buffer (thr->i.Wgetlogin_buffer)
434# define w32_crypt_buffer (thr->i.Wcrypt_buffer)
435# define w32_servent (thr->i.Wservent)
436# define w32_init_socktype (thr->i.Winit_socktype)
02637f4c 437# define w32_use_showwindow (thr->i.Wuse_showwindow)
438# define w32_showwindow (thr->i.Wshowwindow)
3352bfcb 439#else
440# define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
441# define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
442# define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
443# define w32_servent (PL_sys_intern.thr_intern.Wservent)
444# define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
02637f4c 445# define w32_use_showwindow (PL_sys_intern.thr_intern.Wuse_showwindow)
446# define w32_showwindow (PL_sys_intern.thr_intern.Wshowwindow)
4d1ff10f 447#endif /* USE_5005THREADS */
c53bd28a 448
7fac1903 449/* UNICODE<>ANSI translation helpers */
450/* Use CP_ACP when mode is ANSI */
451/* Use CP_UTF8 when mode is UTF8 */
452
e9ff6d27 453#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
c8f3d7f8 454 (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27 455 lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
456#define A2WHELPER(lpa, lpw, nBytes) A2WHELPER_LEN(lpa, -1, lpw, nBytes)
457
458#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
c8f3d7f8 459 (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27 460 lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
461#define W2AHELPER(lpw, lpa, nChars) W2AHELPER_LEN(lpw, -1, lpa, nChars)
7fac1903 462
46487f74 463#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 464
7766f137 465#ifdef USE_ITHREADS
466# define PERL_WAIT_FOR_CHILDREN \
467 STMT_START { \
468 if (w32_pseudo_children && w32_num_pseudo_children) { \
469 long children = w32_num_pseudo_children; \
470 WaitForMultipleObjects(children, \
471 w32_pseudo_child_handles, \
472 TRUE, INFINITE); \
473 while (children) \
474 CloseHandle(w32_pseudo_child_handles[--children]); \
475 } \
476 } STMT_END
477#endif
478
a10b7b7e 479#if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
480#ifdef PERL_CORE
481
482/* C doesn't like repeat struct definitions */
483#ifndef _CRTIMP
484#define _CRTIMP __declspec(dllimport)
485#endif
486
487/*
488 * Control structure for lowio file handles
489 */
490typedef struct {
c623ac67 491 intptr_t osfhnd;/* underlying OS file HANDLE */
a10b7b7e 492 char osfile; /* attributes of file (e.g., open in text mode?) */
493 char pipech; /* one char buffer for handles opened on pipes */
494 int lockinitflag;
495 CRITICAL_SECTION lock;
496} ioinfo;
497
498
499/*
500 * Array of arrays of control structures for lowio files.
501 */
502EXTERN_C _CRTIMP ioinfo* __pioinfo[];
503
504/*
505 * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
506 * array of ioinfo structs.
507 */
508#define IOINFO_L2E 5
509
510/*
511 * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
512 */
513#define IOINFO_ARRAY_ELTS (1 << IOINFO_L2E)
514
515/*
516 * Access macros for getting at an ioinfo struct and its fields from a
517 * file handle
518 */
519#define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
520#define _osfhnd(i) (_pioinfo(i)->osfhnd)
521#define _osfile(i) (_pioinfo(i)->osfile)
522#define _pipech(i) (_pioinfo(i)->pipech)
523
524/* since we are not doing a dup2(), this works fine */
c623ac67 525#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
a10b7b7e 526#endif
527#endif
528
3fadfdf1 529/* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
6e22d046 530#if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
531#undef PERLIO_NOT_STDIO
532#endif
adb71456 533#define PERLIO_NOT_STDIO 0
534
535#include "perlio.h"
536
4f63d024 537/*
538 * This provides a layer of functions and macros to ensure extensions will
539 * get to use the same RTL functions as the core.
540 */
541#include "win32iop.h"
542
b4748376 543#define EXEC_ARGV_CAST(x) ((const char *const *) x)
544
4fb841ef 545#if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
546#define ECONNABORTED WSAECONNABORTED
547#endif
548#if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
549#define EAFNOSUPPORT WSAEAFNOSUPPORT
550#endif
551
f4958739 552DllExport void *win32_signal_context(void);
1018e26f 553#define PERL_GET_SIG_CONTEXT win32_signal_context()
554
68dc0745 555#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 556