This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
on Windows, cwd strings in the environment should be of the
[perl5.git] / win32 / win32.h
CommitLineData
68dc0745
PP
1/* WIN32.H
2 *
3 * (c) 1995 Microsoft Corporation. All rights reserved.
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
PP
9#ifndef _INC_WIN32_PERL5
10#define _INC_WIN32_PERL5
11
5db10396
GS
12#ifndef _WIN32_WINNT
13# define _WIN32_WINNT 0x0400 /* needed for TryEnterCriticalSection() etc. */
14#endif
638eceb6 15
32e30700 16#if defined(PERL_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
e9ee4811
DL
17# define DYNAMIC_ENV_FETCH
18# define ENV_HV_NAME "___ENV_HV_NAME___"
a6c40364 19# define HAS_GETENV_LEN
e9ee4811 20# define prime_env_iter()
ab39fa9d 21# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 22# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 23# ifdef PERL_GLOBAL_STRUCT
32e30700 24# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 25# endif
e5a95ffb 26# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 27# define win32_get_sitelib PerlEnv_sitelib_path
4ea817c6 28# define win32_get_vendorlib PerlEnv_vendorlib_path
9d8a25dc
DL
29#endif
30
a835ef8a 31#ifdef __GNUC__
b7c82df9
GS
32# ifndef __int64 /* some versions seem to #define it already */
33# define __int64 long long
34# endif
db15561c 35# define Win32_Winsock
a835ef8a
NIS
36#endif
37
22239a37
NIS
38/* Define DllExport akin to perl's EXT,
39 * If we are in the DLL or mimicing the DLL for Win95 work round
40 * then Export the symbol,
41 * otherwise import it.
42 */
43
5db10396
GS
44/* now even GCC supports __declspec() */
45
c69f6586
GS
46#if defined(PERL_OBJECT)
47#define DllExport
48#else
22239a37 49#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52
GS
50#define DllExport
51/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37
NIS
52#else
53#define DllExport __declspec(dllimport)
54#endif
c69f6586 55#endif
c69f112c 56
0a753a76
PP
57#define WIN32_LEAN_AND_MEAN
58#include <windows.h>
59
68dc0745
PP
60#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
61#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 62#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 63
eda5ff31
GS
64#ifndef TLS_OUT_OF_INDEXES
65#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
66#endif
67
0a753a76
PP
68#include <dirent.h>
69#include <io.h>
70#include <process.h>
71#include <stdio.h>
72#include <direct.h>
390b85e7 73#include <stdlib.h>
7a1f88ac 74#include <fcntl.h>
390b85e7
GS
75#ifndef EXT
76#include "EXTERN.h"
77#endif
78
c69f112c
NIS
79struct tms {
80 long tms_utime;
81 long tms_stime;
82 long tms_cutime;
83 long tms_cstime;
84};
85
b2af26b1
GS
86#ifndef SYS_NMLN
87#define SYS_NMLN 257
88#endif
89
90struct utsname {
91 char sysname[SYS_NMLN];
92 char nodename[SYS_NMLN];
93 char release[SYS_NMLN];
94 char version[SYS_NMLN];
95 char machine[SYS_NMLN];
96};
97
390b85e7 98#ifndef START_EXTERN_C
b3e5c95e 99#undef EXTERN_C
390b85e7
GS
100#ifdef __cplusplus
101# define START_EXTERN_C extern "C" {
102# define END_EXTERN_C }
103# define EXTERN_C extern "C"
104#else
105# define START_EXTERN_C
106# define END_EXTERN_C
107# define EXTERN_C
108#endif
109#endif
110
111#define STANDARD_C 1
112#define DOSISH 1 /* no escaping our roots */
113#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 114
f3986ebb
GS
115/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
116 * real filehandles. XXX Should always be defined (the other version is untested) */
117#define USE_SOCKETS_AS_HANDLES
118
a7092146
GS
119/* read() and write() aren't transparent for socket handles */
120#define PERL_SOCK_SYSREAD_IS_RECV
121#define PERL_SOCK_SYSWRITE_IS_SEND
122
682fc664 123#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 124
f3986ebb
GS
125/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
126 * to read the environment, bypassing the runtime's (usually broken)
127 * facilities for accessing the same. See note in util.c/my_setenv(). */
128/*#define USE_WIN32_RTL_ENV */
0a753a76 129
9e5f57de
GS
130/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
131 It now uses some black magic to work seamlessly with the DLL CRT and
132 works with MSVC++ 4.0+ or GCC/Mingw32
133 -- BKS 1-24-2000 */
134#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb
GS
135#define USE_FIXED_OSFHANDLE
136#endif
137
6940069f
GS
138/* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
139 DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
140 -- BKS 5-29-2000 */
141#if !(defined(_M_IX86) && _MSC_VER >= 1200)
142#define PERL_WIN32_SOCK_DLOAD
143#endif
902173a3
GS
144#define ENV_IS_CASELESS
145
d41de25a 146#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb
GS
147#define VER_PLATFORM_WIN32_WINDOWS 1
148#endif
149
d41de25a
GS
150#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
151#define FILE_SHARE_DELETE 0x00000004
152#endif
153
327c3667
GS
154/* access() mode bits */
155#ifndef R_OK
156# define R_OK 4
157# define W_OK 2
158# define X_OK 1
159# define F_OK 0
160#endif
161
cc236deb
GS
162/* for waitpid() */
163#ifndef WNOHANG
164# define WNOHANG 1
165#endif
166
c44d3fdb
GS
167#define PERL_GET_CONTEXT_DEFINED
168
f3986ebb
GS
169/* Compiler-specific stuff. */
170
910dfcc8 171#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d
TB
172
173#define _access access
174#define _chdir chdir
4ce4f76e 175#define _getpid getpid
26871e0a 176#define wcsicmp _wcsicmp
3e3baf6d
TB
177#include <sys/types.h>
178
84902520
TB
179#ifndef DllMain
180#define DllMain DllEntryPoint
181#endif
182
189b2af5
GS
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" */
191#pragma warn -pro /* "call to function with no prototype" */
327c3667 192#pragma warn -stu /* "undefined structure 'foo'" */
3e3baf6d 193
ac4c12e7
GS
194/* Borland is picky about a bare member function name used as its ptr */
195#ifdef PERL_OBJECT
0b94c7bb 196# define MEMBER_TO_FPTR(name) &(name)
ac4c12e7
GS
197#endif
198
cd183fd9
GS
199/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
200#define PERL_MEMBER_PTR_SIZE 12
201
1307044d
VK
202#define isnan _isnan
203
910dfcc8 204#endif
3e3baf6d 205
f3986ebb
GS
206#ifdef _MSC_VER /* Microsoft Visual C++ */
207
0a753a76
PP
208typedef long uid_t;
209typedef long gid_t;
a6c40364 210typedef unsigned short mode_t;
f3986ebb
GS
211#pragma warning(disable: 4018 4035 4101 4102 4244 4245 4761)
212
0f4eea8f 213/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
cd183fd9 214#define PERL_MEMBER_PTR_SIZE 16
0f4eea8f 215
5fb4d820
GS
216#define isnan _isnan
217
f3986ebb
GS
218#endif /* _MSC_VER */
219
910dfcc8
GS
220#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
221
222typedef long uid_t;
223typedef long gid_t;
b1d1613b 224#ifndef _environ
3730b96e 225#define _environ environ
b1d1613b 226#endif
3730b96e
GS
227#define flushall _flushall
228#define fcloseall _fcloseall
6940069f 229#define isnan _isnan /* ...same libraries as MSVC */
910dfcc8 230
db15561c 231#ifdef PERL_OBJECT
0b94c7bb 232# define MEMBER_TO_FPTR(name) &(name)
db15561c
GS
233#endif
234
ac4c12e7
GS
235#ifndef _O_NOINHERIT
236# define _O_NOINHERIT 0x0080
237# ifndef _NO_OLDNAMES
238# define O_NOINHERIT _O_NOINHERIT
239# endif
240#endif
241
910dfcc8
GS
242#endif /* __MINGW32__ */
243
f8fb7c90
GS
244/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
245#ifndef CP_UTF8
246# define CP_UTF8 65001
247#endif
248
f3986ebb 249/* compatibility stuff for other compilers goes here */
0a753a76 250
0a753a76 251
dfdd1393 252#if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
cd183fd9
GS
253# define STRUCT_MGVTBL_DEFINITION \
254struct mgvtbl { \
255 union { \
256 int (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg); \
257 char handle_VC_problem1[PERL_MEMBER_PTR_SIZE]; \
258 }; \
259 union { \
260 int (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg); \
261 char handle_VC_problem2[PERL_MEMBER_PTR_SIZE]; \
262 }; \
263 union { \
264 U32 (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg); \
265 char handle_VC_problem3[PERL_MEMBER_PTR_SIZE]; \
266 }; \
267 union { \
268 int (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg); \
269 char handle_VC_problem4[PERL_MEMBER_PTR_SIZE]; \
270 }; \
271 union { \
272 int (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg); \
273 char handle_VC_problem5[PERL_MEMBER_PTR_SIZE]; \
274 }; \
275}
276
277# define BASEOP_DEFINITION \
278 OP* op_next; \
279 OP* op_sibling; \
280 OP* (CPERLscope(*op_ppaddr))(pTHX); \
281 char handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)]; \
282 PADOFFSET op_targ; \
283 OPCODE op_type; \
284 U16 op_seq; \
285 U8 op_flags; \
286 U8 op_private;
287
dfdd1393 288#endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
cd183fd9
GS
289
290
390b85e7 291START_EXTERN_C
f3986ebb
GS
292
293/* For UNIX compatibility. */
294
0a753a76
PP
295extern uid_t getuid(void);
296extern gid_t getgid(void);
297extern uid_t geteuid(void);
298extern gid_t getegid(void);
0a753a76
PP
299extern int setuid(uid_t uid);
300extern int setgid(gid_t gid);
301extern int kill(int pid, int sig);
161b471a 302extern void *sbrk(int need);
e34ffe5a 303extern char * getlogin(void);
b990f8c8 304extern int chown(const char *p, uid_t o, gid_t g);
d55594ae 305
f3986ebb
GS
306#undef Stat
307#define Stat win32_stat
3e3baf6d 308
f3986ebb
GS
309#undef init_os_extras
310#define init_os_extras Perl_init_os_extras
390b85e7 311
22239a37 312DllExport void Perl_win32_init(int *argcp, char ***argvp);
c5be433b
GS
313DllExport void Perl_init_os_extras();
314DllExport void win32_str_os_error(void *sv, DWORD err);
315DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 316
635bbe87
GS
317typedef struct {
318 HANDLE childStdIn;
319 HANDLE childStdOut;
320 HANDLE childStdErr;
f83751a7
GS
321 /*
322 * the following correspond to the fields of the same name
323 * in the STARTUPINFO structure. Embedders can use these to
324 * control the spawning process' look.
325 * Example - to hide the window of the spawned process:
326 * dwFlags = STARTF_USESHOWWINDOW;
327 * wShowWindow = SW_HIDE;
328 */
329 DWORD dwFlags;
330 DWORD dwX;
331 DWORD dwY;
332 DWORD dwXSize;
333 DWORD dwYSize;
334 DWORD dwXCountChars;
335 DWORD dwYCountChars;
336 DWORD dwFillAttribute;
337 WORD wShowWindow;
635bbe87
GS
338} child_IO_table;
339
340DllExport void win32_get_child_IO(child_IO_table* ptr);
341
f3986ebb
GS
342#ifndef USE_SOCKETS_AS_HANDLES
343extern FILE * my_fdopen(int, char *);
d55594ae 344#endif
f3986ebb 345extern int my_fclose(FILE *);
c5be433b
GS
346extern int do_aspawn(void *really, void **mark, void **sp);
347extern int do_spawn(char *cmd);
348extern int do_spawn_nowait(char *cmd);
4ea817c6
GS
349extern char * win32_get_privlib(const char *pl);
350extern char * win32_get_sitelib(const char *pl);
351extern char * win32_get_vendorlib(const char *pl);
f3986ebb
GS
352extern int IsWin95(void);
353extern int IsWinNT(void);
c0932edc 354extern void win32_argv2utf8(int argc, char** argv);
d55594ae 355
1c0ca838
GS
356#ifdef PERL_IMPLICIT_SYS
357extern void win32_delete_internal_host(void *h);
358#endif
359
f3986ebb 360extern char * staticlinkmodules[];
390b85e7
GS
361
362END_EXTERN_C
d55594ae 363
68dc0745 364typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 365
68dc0745 366/*
68dc0745
PP
367 * handle socket stuff, assuming socket is always available
368 */
0a753a76
PP
369#include <sys/socket.h>
370#include <netdb.h>
371
bbc8f9de
NIS
372#ifdef MYMALLOC
373#define EMBEDMYMALLOC /**/
374/* #define USE_PERL_SBRK /**/
375/* #define PERL_SBRK_VIA_MALLOC /**/
376#endif
377
c31fac66 378#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de
NIS
379#define PERL_CORE
380#endif
381
e68cb057 382#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 383# define PERL_SCRIPT_MODE "r"
a868473f 384#else
c39cd008 385# define PERL_SCRIPT_MODE "rb"
a868473f
NIS
386#endif
387
3352bfcb
GS
388/*
389 * Now Win32 specific per-thread data stuff
390 */
391
392struct thread_intern {
393 /* XXX can probably use one buffer instead of several */
394 char Wstrerror_buffer[512];
395 struct servent Wservent;
396 char Wgetlogin_buffer[128];
397# ifdef USE_SOCKETS_AS_HANDLES
398 int Winit_socktype;
399# endif
400# ifdef HAVE_DES_FCRYPT
401 char Wcrypt_buffer[30];
402# endif
403# ifdef USE_RTL_THREAD_API
404 void * retv; /* slot for thread return value */
405# endif
406};
407
408#ifdef USE_THREADS
409# ifndef USE_DECLSPEC_THREAD
410# define HAVE_THREAD_INTERN
411# endif /* !USE_DECLSPEC_THREAD */
412#endif /* USE_THREADS */
413
4b556e6c 414#define HAVE_INTERP_INTERN
0aaad0ff
GS
415typedef struct {
416 long num;
417 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 418 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff
GS
419} child_tab;
420
4b556e6c 421struct interp_intern {
0aaad0ff
GS
422 char * perlshell_tokens;
423 char ** perlshell_vec;
424 long perlshell_items;
425 struct av * fdpid;
426 child_tab * children;
7766f137
GS
427#ifdef USE_ITHREADS
428 DWORD pseudo_id;
429 child_tab * pseudo_children;
430#endif
431 void * internal_host;
3352bfcb
GS
432#ifndef USE_THREADS
433 struct thread_intern thr_intern;
434#endif
4b556e6c
JD
435};
436
4b556e6c 437
0aaad0ff
GS
438#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
439#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
440#define w32_perlshell_items (PL_sys_intern.perlshell_items)
441#define w32_fdpid (PL_sys_intern.fdpid)
442#define w32_children (PL_sys_intern.children)
443#define w32_num_children (w32_children->num)
444#define w32_child_pids (w32_children->pids)
7766f137
GS
445#define w32_child_handles (w32_children->handles)
446#define w32_pseudo_id (PL_sys_intern.pseudo_id)
447#define w32_pseudo_children (PL_sys_intern.pseudo_children)
448#define w32_num_pseudo_children (w32_pseudo_children->num)
449#define w32_pseudo_child_pids (w32_pseudo_children->pids)
450#define w32_pseudo_child_handles (w32_pseudo_children->handles)
451#define w32_internal_host (PL_sys_intern.internal_host)
c53bd28a 452#ifdef USE_THREADS
3352bfcb
GS
453# define w32_strerror_buffer (thr->i.Wstrerror_buffer)
454# define w32_getlogin_buffer (thr->i.Wgetlogin_buffer)
455# define w32_crypt_buffer (thr->i.Wcrypt_buffer)
456# define w32_servent (thr->i.Wservent)
457# define w32_init_socktype (thr->i.Winit_socktype)
458#else
459# define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
460# define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
461# define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
462# define w32_servent (PL_sys_intern.thr_intern.Wservent)
463# define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
e34ffe5a 464#endif /* USE_THREADS */
c53bd28a 465
7fac1903
GS
466/* UNICODE<>ANSI translation helpers */
467/* Use CP_ACP when mode is ANSI */
468/* Use CP_UTF8 when mode is UTF8 */
469
e9ff6d27
GS
470#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
471 (lpw[0] = 0, MultiByteToWideChar((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
472 lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
473#define A2WHELPER(lpa, lpw, nBytes) A2WHELPER_LEN(lpa, -1, lpw, nBytes)
474
475#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
476 (lpa[0] = '\0', WideCharToMultiByte((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
477 lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
478#define W2AHELPER(lpw, lpa, nChars) W2AHELPER_LEN(lpw, -1, lpa, nChars)
7fac1903 479
46487f74 480#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 481
7766f137
GS
482#ifdef USE_ITHREADS
483# define PERL_WAIT_FOR_CHILDREN \
484 STMT_START { \
485 if (w32_pseudo_children && w32_num_pseudo_children) { \
486 long children = w32_num_pseudo_children; \
487 WaitForMultipleObjects(children, \
488 w32_pseudo_child_handles, \
489 TRUE, INFINITE); \
490 while (children) \
491 CloseHandle(w32_pseudo_child_handles[--children]); \
492 } \
493 } STMT_END
494#endif
495
4f63d024
GS
496/*
497 * This provides a layer of functions and macros to ensure extensions will
498 * get to use the same RTL functions as the core.
499 */
500#include "win32iop.h"
501
68dc0745 502#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 503