This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
tweak change#4502
[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
32e30700 12#if defined(PERL_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
e9ee4811
DL
13# define DYNAMIC_ENV_FETCH
14# define ENV_HV_NAME "___ENV_HV_NAME___"
a6c40364 15# define HAS_GETENV_LEN
e9ee4811 16# define prime_env_iter()
ab39fa9d 17# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 18# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 19# ifdef PERL_GLOBAL_STRUCT
32e30700 20# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 21# endif
e5a95ffb 22# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 23# define win32_get_sitelib PerlEnv_sitelib_path
9d8a25dc
DL
24#endif
25
c5be433b
GS
26#if defined(PERL_IMPLICIT_CONTEXT)
27# define PERL_GET_INTERP ((PerlInterpreter*)GetPerlInterpreter())
28# define PERL_SET_INTERP(i) (SetPerlInterpreter(i))
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
22239a37
NIS
36/* GCC does not do __declspec() - render it a nop
37 * and turn on options to avoid importing data
38 */
b1d1613b 39#ifndef __declspec
db15561c 40# define __declspec(x)
b1d1613b 41#endif
db15561c
GS
42# ifndef PERL_OBJECT
43# define PERL_GLOBAL_STRUCT
b86a2fa7
GS
44# ifndef MULTIPLICITY
45# define MULTIPLICITY
46# endif
db15561c 47# endif
a835ef8a
NIS
48#endif
49
22239a37
NIS
50/* Define DllExport akin to perl's EXT,
51 * If we are in the DLL or mimicing the DLL for Win95 work round
52 * then Export the symbol,
53 * otherwise import it.
54 */
55
c69f6586
GS
56#if defined(PERL_OBJECT)
57#define DllExport
58#else
22239a37 59#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52
GS
60#define DllExport
61/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37
NIS
62#else
63#define DllExport __declspec(dllimport)
64#endif
c69f6586 65#endif
c69f112c 66
0a753a76
PP
67#define WIN32_LEAN_AND_MEAN
68#include <windows.h>
69
68dc0745
PP
70#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
71#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 72#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 73
eda5ff31
GS
74#ifndef TLS_OUT_OF_INDEXES
75#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
76#endif
77
0a753a76
PP
78#include <dirent.h>
79#include <io.h>
80#include <process.h>
81#include <stdio.h>
82#include <direct.h>
390b85e7
GS
83#include <stdlib.h>
84#ifndef EXT
85#include "EXTERN.h"
86#endif
87
c69f112c
NIS
88struct tms {
89 long tms_utime;
90 long tms_stime;
91 long tms_cutime;
92 long tms_cstime;
93};
94
b2af26b1
GS
95#ifndef SYS_NMLN
96#define SYS_NMLN 257
97#endif
98
99struct utsname {
100 char sysname[SYS_NMLN];
101 char nodename[SYS_NMLN];
102 char release[SYS_NMLN];
103 char version[SYS_NMLN];
104 char machine[SYS_NMLN];
105};
106
390b85e7 107#ifndef START_EXTERN_C
b3e5c95e 108#undef EXTERN_C
390b85e7
GS
109#ifdef __cplusplus
110# define START_EXTERN_C extern "C" {
111# define END_EXTERN_C }
112# define EXTERN_C extern "C"
113#else
114# define START_EXTERN_C
115# define END_EXTERN_C
116# define EXTERN_C
117#endif
118#endif
119
120#define STANDARD_C 1
121#define DOSISH 1 /* no escaping our roots */
122#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 123
f3986ebb
GS
124/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
125 * real filehandles. XXX Should always be defined (the other version is untested) */
126#define USE_SOCKETS_AS_HANDLES
127
a7092146
GS
128/* read() and write() aren't transparent for socket handles */
129#define PERL_SOCK_SYSREAD_IS_RECV
130#define PERL_SOCK_SYSWRITE_IS_SEND
131
132
f3986ebb
GS
133/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
134 * to read the environment, bypassing the runtime's (usually broken)
135 * facilities for accessing the same. See note in util.c/my_setenv(). */
136/*#define USE_WIN32_RTL_ENV */
0a753a76 137
f3986ebb
GS
138/* Define USE_FIXED_OSFHANDLE to fix VC's _open_osfhandle() on W95.
139 * Can only enable it if not using the DLL CRT (it doesn't expose internals) */
140#if defined(_MSC_VER) && !defined(_DLL) && defined(_M_IX86)
141#define USE_FIXED_OSFHANDLE
142#endif
143
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
f3986ebb
GS
162/* Compiler-specific stuff. */
163
910dfcc8 164#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d
TB
165
166#define _access access
167#define _chdir chdir
168#include <sys/types.h>
169
84902520
TB
170#ifndef DllMain
171#define DllMain DllEntryPoint
172#endif
173
189b2af5
GS
174#pragma warn -ccc /* "condition is always true/false" */
175#pragma warn -rch /* "unreachable code" */
176#pragma warn -sig /* "conversion may lose significant digits" */
177#pragma warn -pia /* "possibly incorrect assignment" */
178#pragma warn -par /* "parameter 'foo' is never used" */
179#pragma warn -aus /* "'foo' is assigned a value that is never used" */
180#pragma warn -use /* "'foo' is declared but never used" */
181#pragma warn -csu /* "comparing signed and unsigned values" */
182#pragma warn -pro /* "call to function with no prototype" */
327c3667 183#pragma warn -stu /* "undefined structure 'foo'" */
3e3baf6d 184
ac4c12e7
GS
185/* Borland is picky about a bare member function name used as its ptr */
186#ifdef PERL_OBJECT
0b94c7bb 187# define MEMBER_TO_FPTR(name) &(name)
ac4c12e7
GS
188#endif
189
910dfcc8 190#endif
3e3baf6d 191
f3986ebb
GS
192#ifdef _MSC_VER /* Microsoft Visual C++ */
193
0a753a76
PP
194typedef long uid_t;
195typedef long gid_t;
a6c40364 196typedef unsigned short mode_t;
f3986ebb
GS
197#pragma warning(disable: 4018 4035 4101 4102 4244 4245 4761)
198
c5be433b 199#ifndef PERL_OBJECT
0f4eea8f
DL
200
201/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
202#define STRUCT_MGVTBL_DEFINITION \
203struct mgvtbl { \
204 union { \
4f63d024 205 int (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg); \
0f4eea8f
DL
206 char handle_VC_problem1[16]; \
207 }; \
208 union { \
4f63d024 209 int (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg); \
0f4eea8f
DL
210 char handle_VC_problem2[16]; \
211 }; \
212 union { \
4f63d024 213 U32 (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg); \
0f4eea8f
DL
214 char handle_VC_problem3[16]; \
215 }; \
216 union { \
4f63d024 217 int (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg); \
0f4eea8f
DL
218 char handle_VC_problem4[16]; \
219 }; \
220 union { \
4f63d024 221 int (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg); \
0f4eea8f
DL
222 char handle_VC_problem5[16]; \
223 }; \
224}
225
226#define BASEOP_DEFINITION \
227 OP* op_next; \
228 OP* op_sibling; \
4f63d024 229 OP* (CPERLscope(*op_ppaddr))(pTHX); \
0f4eea8f
DL
230 char handle_VC_problem[12]; \
231 PADOFFSET op_targ; \
232 OPCODE op_type; \
233 U16 op_seq; \
234 U8 op_flags; \
235 U8 op_private;
236
0f4eea8f
DL
237#endif /* PERL_OBJECT */
238
f3986ebb
GS
239#endif /* _MSC_VER */
240
910dfcc8
GS
241#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
242
243typedef long uid_t;
244typedef long gid_t;
b1d1613b 245#ifndef _environ
3730b96e 246#define _environ environ
b1d1613b 247#endif
3730b96e
GS
248#define flushall _flushall
249#define fcloseall _fcloseall
910dfcc8 250
d543acb6
GS
251#undef __attribute__
252#define __attribute__(x)
253
254#ifndef CP_UTF8
255# define CP_UTF8 65001
256#endif
257
db15561c 258#ifdef PERL_OBJECT
0b94c7bb 259# define MEMBER_TO_FPTR(name) &(name)
db15561c
GS
260#endif
261
ac4c12e7
GS
262#ifndef _O_NOINHERIT
263# define _O_NOINHERIT 0x0080
264# ifndef _NO_OLDNAMES
265# define O_NOINHERIT _O_NOINHERIT
266# endif
267#endif
268
ba3eb2af
GS
269#ifndef _O_NOINHERIT
270# define _O_NOINHERIT 0x0080
271# ifndef _NO_OLDNAMES
272# define O_NOINHERIT _O_NOINHERIT
273# endif
274#endif
275
910dfcc8
GS
276#endif /* __MINGW32__ */
277
f3986ebb 278/* compatibility stuff for other compilers goes here */
0a753a76 279
0a753a76 280
390b85e7 281START_EXTERN_C
f3986ebb
GS
282
283/* For UNIX compatibility. */
284
0a753a76
PP
285extern uid_t getuid(void);
286extern gid_t getgid(void);
287extern uid_t geteuid(void);
288extern gid_t getegid(void);
0a753a76
PP
289extern int setuid(uid_t uid);
290extern int setgid(gid_t gid);
291extern int kill(int pid, int sig);
161b471a 292extern void *sbrk(int need);
e34ffe5a 293extern char * getlogin(void);
b990f8c8 294extern int chown(const char *p, uid_t o, gid_t g);
d55594ae 295
f3986ebb
GS
296#undef Stat
297#define Stat win32_stat
3e3baf6d 298
f3986ebb
GS
299#undef init_os_extras
300#define init_os_extras Perl_init_os_extras
390b85e7 301
22239a37 302DllExport void Perl_win32_init(int *argcp, char ***argvp);
c5be433b
GS
303DllExport void Perl_init_os_extras();
304DllExport void win32_str_os_error(void *sv, DWORD err);
305DllExport int RunPerl(int argc, char **argv, char **env);
306DllExport bool SetPerlInterpreter(void* interp);
307DllExport void* GetPerlInterpreter(void);
0551aaa8 308
f3986ebb
GS
309#ifndef USE_SOCKETS_AS_HANDLES
310extern FILE * my_fdopen(int, char *);
d55594ae 311#endif
f3986ebb 312extern int my_fclose(FILE *);
c5be433b
GS
313extern int do_aspawn(void *really, void **mark, void **sp);
314extern int do_spawn(char *cmd);
315extern int do_spawn_nowait(char *cmd);
316extern char * win32_get_privlib(char *pl);
317extern char * win32_get_sitelib(char *pl);
f3986ebb
GS
318extern int IsWin95(void);
319extern int IsWinNT(void);
d55594ae 320
f3986ebb 321extern char * staticlinkmodules[];
390b85e7
GS
322
323END_EXTERN_C
d55594ae 324
68dc0745 325typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 326
68dc0745 327/*
68dc0745
PP
328 * handle socket stuff, assuming socket is always available
329 */
0a753a76
PP
330#include <sys/socket.h>
331#include <netdb.h>
332
bbc8f9de
NIS
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
NIS
340#define PERL_CORE
341#endif
342
a868473f
NIS
343#ifdef USE_BINMODE_SCRIPTS
344#define PERL_SCRIPT_MODE "rb"
345EXT void win32_strip_return(struct sv *sv);
346#else
347#define PERL_SCRIPT_MODE "r"
348#define win32_strip_return(sv) NOOP
349#endif
350
4b556e6c 351#define HAVE_INTERP_INTERN
0aaad0ff
GS
352typedef struct {
353 long num;
354 DWORD pids[MAXIMUM_WAIT_OBJECTS];
355} child_tab;
356
0cb96387
GS
357struct host_link {
358 char * nameId;
359 void * host_data;
360 struct host_link * next;
361};
362
4b556e6c 363struct interp_intern {
0aaad0ff
GS
364 char * perlshell_tokens;
365 char ** perlshell_vec;
366 long perlshell_items;
367 struct av * fdpid;
368 child_tab * children;
369 HANDLE child_handles[MAXIMUM_WAIT_OBJECTS];
0cb96387 370 struct host_link * hostlist;
4b556e6c
JD
371};
372
4b556e6c 373
0aaad0ff
GS
374#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
375#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
376#define w32_perlshell_items (PL_sys_intern.perlshell_items)
377#define w32_fdpid (PL_sys_intern.fdpid)
378#define w32_children (PL_sys_intern.children)
379#define w32_num_children (w32_children->num)
380#define w32_child_pids (w32_children->pids)
381#define w32_child_handles (PL_sys_intern.child_handles)
0cb96387 382#define w32_host_link (PL_sys_intern.hostlist)
4b556e6c 383
c53bd28a
NIS
384/*
385 * Now Win32 specific per-thread data stuff
386 */
387
388#ifdef USE_THREADS
e34ffe5a
GS
389# ifndef USE_DECLSPEC_THREAD
390# define HAVE_THREAD_INTERN
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];
4b556e6c 397 char Ww32_perllib_root[MAX_PATH+1];
401ef382
SN
398# ifdef USE_SOCKETS_AS_HANDLES
399 int Winit_socktype;
400# endif
e34ffe5a
GS
401# ifdef HAVE_DES_FCRYPT
402 char Wcrypt_buffer[30];
403# endif
2d7a9237
GS
404# ifdef USE_RTL_THREAD_API
405 void * retv; /* slot for thread return value */
406# endif
c53bd28a 407};
e34ffe5a
GS
408# endif /* !USE_DECLSPEC_THREAD */
409#endif /* USE_THREADS */
c53bd28a 410
7fac1903
GS
411/* UNICODE<>ANSI translation helpers */
412/* Use CP_ACP when mode is ANSI */
413/* Use CP_UTF8 when mode is UTF8 */
414
c5be433b
GS
415#define A2WHELPER(lpa, lpw, nBytes)\
416 lpw[0] = 0, MultiByteToWideChar((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpa, -1, lpw, (nBytes/sizeof(WCHAR)))
7fac1903 417
0cb96387
GS
418#define W2AHELPER(lpw, lpa, nChars)\
419 lpa[0] = '\0', WideCharToMultiByte((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpw, -1, (LPSTR)lpa, nChars, NULL, NULL)
7fac1903 420
0cb96387 421#define USING_WIDE() (PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 422
4f63d024
GS
423/*
424 * This provides a layer of functions and macros to ensure extensions will
425 * get to use the same RTL functions as the core.
426 */
427#include "win32iop.h"
428
68dc0745 429#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 430