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