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