This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Multiple win32io.o is fatal for GCC (and noise with VC++)
[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
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
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
22239a37 45#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52
GS
46#define DllExport
47/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37
NIS
48#else
49#define DllExport __declspec(dllimport)
50#endif
c69f112c 51
0a753a76 52#define WIN32_LEAN_AND_MEAN
53#include <windows.h>
54
68dc0745 55#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
56#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 57#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 58
eda5ff31
GS
59#ifndef TLS_OUT_OF_INDEXES
60#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
61#endif
62
0a753a76 63#include <dirent.h>
64#include <io.h>
65#include <process.h>
66#include <stdio.h>
67#include <direct.h>
390b85e7 68#include <stdlib.h>
7a1f88ac 69#include <fcntl.h>
390b85e7
GS
70#ifndef EXT
71#include "EXTERN.h"
72#endif
73
c69f112c
NIS
74struct tms {
75 long tms_utime;
76 long tms_stime;
77 long tms_cutime;
78 long tms_cstime;
79};
80
b2af26b1
GS
81#ifndef SYS_NMLN
82#define SYS_NMLN 257
83#endif
84
85struct utsname {
86 char sysname[SYS_NMLN];
87 char nodename[SYS_NMLN];
88 char release[SYS_NMLN];
89 char version[SYS_NMLN];
90 char machine[SYS_NMLN];
91};
92
390b85e7 93#ifndef START_EXTERN_C
b3e5c95e 94#undef EXTERN_C
390b85e7
GS
95#ifdef __cplusplus
96# define START_EXTERN_C extern "C" {
97# define END_EXTERN_C }
98# define EXTERN_C extern "C"
99#else
100# define START_EXTERN_C
101# define END_EXTERN_C
102# define EXTERN_C
103#endif
104#endif
105
106#define STANDARD_C 1
107#define DOSISH 1 /* no escaping our roots */
108#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 109
f3986ebb
GS
110/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
111 * real filehandles. XXX Should always be defined (the other version is untested) */
112#define USE_SOCKETS_AS_HANDLES
113
a7092146
GS
114/* read() and write() aren't transparent for socket handles */
115#define PERL_SOCK_SYSREAD_IS_RECV
116#define PERL_SOCK_SYSWRITE_IS_SEND
117
682fc664 118#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 119
9e5f57de
GS
120/* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
121 It now uses some black magic to work seamlessly with the DLL CRT and
122 works with MSVC++ 4.0+ or GCC/Mingw32
123 -- BKS 1-24-2000 */
124#if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
f3986ebb
GS
125#define USE_FIXED_OSFHANDLE
126#endif
127
6940069f
GS
128/* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
129 DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
130 -- BKS 5-29-2000 */
131#if !(defined(_M_IX86) && _MSC_VER >= 1200)
132#define PERL_WIN32_SOCK_DLOAD
133#endif
902173a3
GS
134#define ENV_IS_CASELESS
135
d41de25a 136#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb
GS
137#define VER_PLATFORM_WIN32_WINDOWS 1
138#endif
139
d41de25a
GS
140#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
141#define FILE_SHARE_DELETE 0x00000004
142#endif
143
327c3667
GS
144/* access() mode bits */
145#ifndef R_OK
146# define R_OK 4
147# define W_OK 2
148# define X_OK 1
149# define F_OK 0
150#endif
151
cc236deb
GS
152/* for waitpid() */
153#ifndef WNOHANG
154# define WNOHANG 1
155#endif
156
c44d3fdb
GS
157#define PERL_GET_CONTEXT_DEFINED
158
f3986ebb
GS
159/* Compiler-specific stuff. */
160
910dfcc8 161#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d 162
cb359b41 163#if (__BORLANDC__ <= 0x520)
3e3baf6d
TB
164#define _access access
165#define _chdir chdir
cb359b41
JH
166#endif
167
4ce4f76e 168#define _getpid getpid
26871e0a 169#define wcsicmp _wcsicmp
3e3baf6d
TB
170#include <sys/types.h>
171
84902520
TB
172#ifndef DllMain
173#define DllMain DllEntryPoint
174#endif
175
189b2af5
GS
176#pragma warn -ccc /* "condition is always true/false" */
177#pragma warn -rch /* "unreachable code" */
178#pragma warn -sig /* "conversion may lose significant digits" */
179#pragma warn -pia /* "possibly incorrect assignment" */
180#pragma warn -par /* "parameter 'foo' is never used" */
181#pragma warn -aus /* "'foo' is assigned a value that is never used" */
182#pragma warn -use /* "'foo' is declared but never used" */
183#pragma warn -csu /* "comparing signed and unsigned values" */
3e3baf6d 184
cd183fd9
GS
185/* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
186#define PERL_MEMBER_PTR_SIZE 12
187
1307044d
VK
188#define isnan _isnan
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
5fb4d820
GS
202#define isnan _isnan
203
f3986ebb
GS
204#endif /* _MSC_VER */
205
910dfcc8
GS
206#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
207
208typedef long uid_t;
209typedef long gid_t;
b1d1613b 210#ifndef _environ
3730b96e 211#define _environ environ
b1d1613b 212#endif
3730b96e
GS
213#define flushall _flushall
214#define fcloseall _fcloseall
6940069f 215#define isnan _isnan /* ...same libraries as MSVC */
910dfcc8 216
ac4c12e7
GS
217#ifndef _O_NOINHERIT
218# define _O_NOINHERIT 0x0080
219# ifndef _NO_OLDNAMES
220# define O_NOINHERIT _O_NOINHERIT
221# endif
222#endif
223
910dfcc8
GS
224#endif /* __MINGW32__ */
225
f8fb7c90
GS
226/* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
227#ifndef CP_UTF8
228# define CP_UTF8 65001
229#endif
230
f3986ebb 231/* compatibility stuff for other compilers goes here */
0a753a76 232
390b85e7 233START_EXTERN_C
f3986ebb
GS
234
235/* For UNIX compatibility. */
236
0a753a76 237extern uid_t getuid(void);
238extern gid_t getgid(void);
239extern uid_t geteuid(void);
240extern gid_t getegid(void);
0a753a76 241extern int setuid(uid_t uid);
242extern int setgid(gid_t gid);
243extern int kill(int pid, int sig);
161b471a 244extern void *sbrk(int need);
e34ffe5a 245extern char * getlogin(void);
b990f8c8 246extern int chown(const char *p, uid_t o, gid_t g);
00b02797 247extern int mkstemp(const char *path);
d55594ae 248
f3986ebb
GS
249#undef Stat
250#define Stat win32_stat
3e3baf6d 251
f3986ebb
GS
252#undef init_os_extras
253#define init_os_extras Perl_init_os_extras
390b85e7 254
22239a37 255DllExport void Perl_win32_init(int *argcp, char ***argvp);
cb359b41 256DllExport void Perl_init_os_extras(void);
c5be433b
GS
257DllExport void win32_str_os_error(void *sv, DWORD err);
258DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 259
635bbe87
GS
260typedef struct {
261 HANDLE childStdIn;
262 HANDLE childStdOut;
263 HANDLE childStdErr;
f83751a7
GS
264 /*
265 * the following correspond to the fields of the same name
266 * in the STARTUPINFO structure. Embedders can use these to
267 * control the spawning process' look.
268 * Example - to hide the window of the spawned process:
269 * dwFlags = STARTF_USESHOWWINDOW;
270 * wShowWindow = SW_HIDE;
271 */
272 DWORD dwFlags;
273 DWORD dwX;
274 DWORD dwY;
275 DWORD dwXSize;
276 DWORD dwYSize;
277 DWORD dwXCountChars;
278 DWORD dwYCountChars;
279 DWORD dwFillAttribute;
280 WORD wShowWindow;
635bbe87
GS
281} child_IO_table;
282
283DllExport void win32_get_child_IO(child_IO_table* ptr);
284
f3986ebb
GS
285#ifndef USE_SOCKETS_AS_HANDLES
286extern FILE * my_fdopen(int, char *);
d55594ae 287#endif
f3986ebb 288extern int my_fclose(FILE *);
ed59ec62 289extern int my_fstat(int fd, struct stat *sbufptr);
c5be433b
GS
290extern int do_aspawn(void *really, void **mark, void **sp);
291extern int do_spawn(char *cmd);
292extern int do_spawn_nowait(char *cmd);
4ea817c6
GS
293extern char * win32_get_privlib(const char *pl);
294extern char * win32_get_sitelib(const char *pl);
295extern char * win32_get_vendorlib(const char *pl);
f3986ebb
GS
296extern int IsWin95(void);
297extern int IsWinNT(void);
c0932edc 298extern void win32_argv2utf8(int argc, char** argv);
d55594ae 299
1c0ca838
GS
300#ifdef PERL_IMPLICIT_SYS
301extern void win32_delete_internal_host(void *h);
302#endif
303
f3986ebb 304extern char * staticlinkmodules[];
390b85e7
GS
305
306END_EXTERN_C
d55594ae 307
68dc0745 308typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 309
68dc0745 310/*
68dc0745 311 * handle socket stuff, assuming socket is always available
312 */
0a753a76 313#include <sys/socket.h>
314#include <netdb.h>
315
bbc8f9de
NIS
316#ifdef MYMALLOC
317#define EMBEDMYMALLOC /**/
318/* #define USE_PERL_SBRK /**/
319/* #define PERL_SBRK_VIA_MALLOC /**/
320#endif
321
c31fac66 322#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de
NIS
323#define PERL_CORE
324#endif
325
e68cb057 326#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 327# define PERL_SCRIPT_MODE "r"
a868473f 328#else
c39cd008 329# define PERL_SCRIPT_MODE "rb"
a868473f
NIS
330#endif
331
3352bfcb
GS
332/*
333 * Now Win32 specific per-thread data stuff
334 */
335
336struct thread_intern {
337 /* XXX can probably use one buffer instead of several */
338 char Wstrerror_buffer[512];
339 struct servent Wservent;
340 char Wgetlogin_buffer[128];
341# ifdef USE_SOCKETS_AS_HANDLES
342 int Winit_socktype;
343# endif
344# ifdef HAVE_DES_FCRYPT
345 char Wcrypt_buffer[30];
346# endif
347# ifdef USE_RTL_THREAD_API
348 void * retv; /* slot for thread return value */
349# endif
350};
351
4d1ff10f 352#ifdef USE_5005THREADS
3352bfcb
GS
353# ifndef USE_DECLSPEC_THREAD
354# define HAVE_THREAD_INTERN
355# endif /* !USE_DECLSPEC_THREAD */
4d1ff10f 356#endif /* USE_5005THREADS */
3352bfcb 357
4b556e6c 358#define HAVE_INTERP_INTERN
0aaad0ff
GS
359typedef struct {
360 long num;
361 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 362 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff
GS
363} child_tab;
364
4b556e6c 365struct interp_intern {
0aaad0ff
GS
366 char * perlshell_tokens;
367 char ** perlshell_vec;
368 long perlshell_items;
369 struct av * fdpid;
370 child_tab * children;
7766f137
GS
371#ifdef USE_ITHREADS
372 DWORD pseudo_id;
373 child_tab * pseudo_children;
374#endif
375 void * internal_host;
4d1ff10f 376#ifndef USE_5005THREADS
3352bfcb
GS
377 struct thread_intern thr_intern;
378#endif
4b556e6c
JD
379};
380
4b556e6c 381
0aaad0ff
GS
382#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
383#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
384#define w32_perlshell_items (PL_sys_intern.perlshell_items)
385#define w32_fdpid (PL_sys_intern.fdpid)
386#define w32_children (PL_sys_intern.children)
387#define w32_num_children (w32_children->num)
388#define w32_child_pids (w32_children->pids)
7766f137
GS
389#define w32_child_handles (w32_children->handles)
390#define w32_pseudo_id (PL_sys_intern.pseudo_id)
391#define w32_pseudo_children (PL_sys_intern.pseudo_children)
392#define w32_num_pseudo_children (w32_pseudo_children->num)
393#define w32_pseudo_child_pids (w32_pseudo_children->pids)
394#define w32_pseudo_child_handles (w32_pseudo_children->handles)
395#define w32_internal_host (PL_sys_intern.internal_host)
4d1ff10f 396#ifdef USE_5005THREADS
3352bfcb
GS
397# define w32_strerror_buffer (thr->i.Wstrerror_buffer)
398# define w32_getlogin_buffer (thr->i.Wgetlogin_buffer)
399# define w32_crypt_buffer (thr->i.Wcrypt_buffer)
400# define w32_servent (thr->i.Wservent)
401# define w32_init_socktype (thr->i.Winit_socktype)
402#else
403# define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
404# define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
405# define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
406# define w32_servent (PL_sys_intern.thr_intern.Wservent)
407# define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
4d1ff10f 408#endif /* USE_5005THREADS */
c53bd28a 409
7fac1903
GS
410/* UNICODE<>ANSI translation helpers */
411/* Use CP_ACP when mode is ANSI */
412/* Use CP_UTF8 when mode is UTF8 */
413
e9ff6d27 414#define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
c8f3d7f8 415 (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27
GS
416 lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
417#define A2WHELPER(lpa, lpw, nBytes) A2WHELPER_LEN(lpa, -1, lpw, nBytes)
418
419#define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
c8f3d7f8 420 (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
e9ff6d27
GS
421 lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
422#define W2AHELPER(lpw, lpa, nChars) W2AHELPER_LEN(lpw, -1, lpa, nChars)
7fac1903 423
46487f74 424#define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
7fac1903 425
7766f137
GS
426#ifdef USE_ITHREADS
427# define PERL_WAIT_FOR_CHILDREN \
428 STMT_START { \
429 if (w32_pseudo_children && w32_num_pseudo_children) { \
430 long children = w32_num_pseudo_children; \
431 WaitForMultipleObjects(children, \
432 w32_pseudo_child_handles, \
433 TRUE, INFINITE); \
434 while (children) \
435 CloseHandle(w32_pseudo_child_handles[--children]); \
436 } \
437 } STMT_END
438#endif
439
a10b7b7e
GS
440#if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
441#ifdef PERL_CORE
442
443/* C doesn't like repeat struct definitions */
444#ifndef _CRTIMP
445#define _CRTIMP __declspec(dllimport)
446#endif
447
448/*
449 * Control structure for lowio file handles
450 */
451typedef struct {
452 long osfhnd; /* underlying OS file HANDLE */
453 char osfile; /* attributes of file (e.g., open in text mode?) */
454 char pipech; /* one char buffer for handles opened on pipes */
455 int lockinitflag;
456 CRITICAL_SECTION lock;
457} ioinfo;
458
459
460/*
461 * Array of arrays of control structures for lowio files.
462 */
463EXTERN_C _CRTIMP ioinfo* __pioinfo[];
464
465/*
466 * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
467 * array of ioinfo structs.
468 */
469#define IOINFO_L2E 5
470
471/*
472 * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
473 */
474#define IOINFO_ARRAY_ELTS (1 << IOINFO_L2E)
475
476/*
477 * Access macros for getting at an ioinfo struct and its fields from a
478 * file handle
479 */
480#define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
481#define _osfhnd(i) (_pioinfo(i)->osfhnd)
482#define _osfile(i) (_pioinfo(i)->osfile)
483#define _pipech(i) (_pioinfo(i)->pipech)
484
485/* since we are not doing a dup2(), this works fine */
486#define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (long)osfh)
487#endif
488#endif
489
adb71456
NIS
490#define PERLIO_NOT_STDIO 0
491
492#include "perlio.h"
493
4f63d024
GS
494/*
495 * This provides a layer of functions and macros to ensure extensions will
496 * get to use the same RTL functions as the core.
497 */
498#include "win32iop.h"
499
b4748376
NIS
500#define EXEC_ARGV_CAST(x) ((const char *const *) x)
501
68dc0745 502#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 503