This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
https://perl5.git.perl.org / perl5.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Note that the USE_64_BIT_INT build option is not supported with MSVC++ 6.0
[perl5.git] / win32 / win32.h
CommitLineData
68dc0745 1/* WIN32.H
2 *
3fadfdf1 3 * (c) 1995 Microsoft Corporation. All rights reserved.
0d130a44 4 * Developed by hip communications inc.
68dc0745 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 12#ifndef _WIN32_WINNT
8cbe99e5 13# define _WIN32_WINNT 0x0500 /* needed for CreateHardlink() etc. */
5db10396 14#endif
638eceb6 15
19253ae6
DD		 16#ifdef PERL_IS_MINIPERL
17/* this macro will remove Winsock only on miniperl, PERL_IMPLICIT_SYS and
18 * makedef.pl create dependencies that will keep Winsock linked in even with
19 * this macro defined, even though sockets will be umimplemented from a script
20 * level in full perl
21 */
22# define WIN32_NO_SOCKETS
23#endif
24
25#ifdef WIN32_NO_SOCKETS
26# undef HAS_SOCKET
27# undef HAS_GETPROTOBYNAME
28# undef HAS_GETPROTOBYNUMBER
29# undef HAS_GETPROTOENT
30# undef HAS_GETNETBYNAME
31# undef HAS_GETNETBYADDR
32# undef HAS_GETNETENT
33# undef HAS_GETSERVBYNAME
34# undef HAS_GETSERVBYPORT
35# undef HAS_GETSERVENT
36# undef HAS_GETHOSTBYNAME
37# undef HAS_GETHOSTBYADDR
38# undef HAS_GETHOSTENT
39# undef HAS_SELECT
40# undef HAS_IOCTL
41# undef HAS_NTOHL
42# undef HAS_HTONL
43# undef HAS_HTONS
44# undef HAS_NTOHS
45# define WIN32SCK_IS_STDSCK
46#endif
47
acfe0abc 48#if defined(PERL_IMPLICIT_SYS)
e9ee4811 49# define DYNAMIC_ENV_FETCH
a6c40364 50# define HAS_GETENV_LEN
e9ee4811 51# define prime_env_iter()
ab39fa9d 52# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
c5be433b 53# define WIN32SCK_IS_STDSCK /* don't pull in custom wsock layer */
ab39fa9d 54# ifdef PERL_GLOBAL_STRUCT
32e30700 55# error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
ab39fa9d 56# endif
e5a95ffb 57# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 58# define win32_get_sitelib PerlEnv_sitelib_path
4ea817c6 59# define win32_get_vendorlib PerlEnv_vendorlib_path
9d8a25dc
DL		 60#endif
61
a835ef8a 62#ifdef __GNUC__
b7c82df9
GS		 63# ifndef __int64 /* some versions seem to #define it already */
64# define __int64 long long
65# endif
db15561c 66# define Win32_Winsock
1c85e96a
NIS		 67#ifdef __cplusplus
68/* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
3fadfdf1
NIS		 69#undef PERL_UNUSED_DECL
70#define PERL_UNUSED_DECL
a835ef8a 71#endif
1c85e96a
NIS		 72#endif
73
a835ef8a 74
3fadfdf1 75/* Define DllExport akin to perl's EXT,
8cbe99e5 76 * If we are in the DLL then Export the symbol,
22239a37
NIS		 77 * otherwise import it.
78 */
79
5db10396 80/* now even GCC supports __declspec() */
a19baa61
DD		 81/* miniperl has no reason to export anything */
82#if defined(PERL_IS_MINIPERL) && !defined(UNDER_CE) && defined(_MSC_VER)
83# define DllExport
3fadfdf1 84#else
a19baa61
DD		 85# if defined(PERLDLL)
86# define DllExport __declspec(dllexport)
87# else
88# define DllExport __declspec(dllimport)
89# endif
22239a37 90#endif
c69f112c 91
50fd5961
JD		 92/* The Perl APIs can only be called directly inside the perl5xx.dll.
93 * All other code has to import them. By declaring them as "dllimport"
94 * we tell the compiler to generate an indirect call instruction and
95 * avoid redirection through a call thunk.
96 *
97 * The XS code in the re extension is special, in that it redefines
98 * core APIs locally, so don't mark them as "dllimport" because GCC
99 * cannot handle this situation.
100 */
101#if !defined(PERLDLL) && !defined(PERL_EXT_RE_BUILD)
ad6ab6c5
JD		 102# ifdef __cplusplus
103# define PERL_CALLCONV extern "C" __declspec(dllimport)
12a2785c 104# ifdef _MSC_VER
03c98af0 105# define PERL_CALLCONV_NO_RET extern "C" __declspec(dllimport) __declspec(noreturn)
12a2785c 106# endif
ad6ab6c5
JD		 107# else
108# define PERL_CALLCONV __declspec(dllimport)
12a2785c 109# ifdef _MSC_VER
03c98af0 110# define PERL_CALLCONV_NO_RET __declspec(dllimport) __declspec(noreturn)
12a2785c 111# endif
ad6ab6c5 112# endif
50e8e1f5
DD		 113#else /* MSVC noreturn support inside the interp */
114# ifdef _MSC_VER
115# define PERL_CALLCONV_NO_RET __declspec(noreturn)
116# endif
ad6ab6c5
JD		 117#endif
118
98c015b7
DD		 119#ifdef _MSC_VER
120# define PERL_STATIC_NO_RET __declspec(noreturn) static
121# define PERL_STATIC_INLINE_NO_RET __declspec(noreturn) PERL_STATIC_INLINE
122#endif
123
0a753a76 124#define WIN32_LEAN_AND_MEAN
125#include <windows.h>
126
fa58a56f
S		 127/*
128 * Bug in winbase.h in mingw-w64 4.4.0-1 at least... they
129 * do #define GetEnvironmentStringsA GetEnvironmentStrings and fail
130 * to declare GetEnvironmentStringsA.
131 */
132#if defined(__MINGW64__) && defined(GetEnvironmentStringsA) && !defined(UNICODE)
133#ifdef __cplusplus
134extern "C" {
135#endif
136#undef GetEnvironmentStringsA
137WINBASEAPI LPCH WINAPI GetEnvironmentStringsA(VOID);
138#define GetEnvironmentStrings GetEnvironmentStringsA
139#ifdef __cplusplus
140}
141#endif
142#endif
143
68dc0745 144#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
145#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 146#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 147
eda5ff31
GS		 148#ifndef TLS_OUT_OF_INDEXES
149#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
150#endif
151
0a753a76 152#include <dirent.h>
153#include <io.h>
154#include <process.h>
155#include <stdio.h>
156#include <direct.h>
390b85e7 157#include <stdlib.h>
c623ac67 158#include <stddef.h>
7a1f88ac 159#include <fcntl.h>
390b85e7
GS		 160#ifndef EXT
161#include "EXTERN.h"
162#endif
163
c69f112c
NIS		 164struct tms {
165 long tms_utime;
166 long tms_stime;
167 long tms_cutime;
168 long tms_cstime;
169};
170
b2af26b1
GS		 171#ifndef SYS_NMLN
172#define SYS_NMLN 257
173#endif
174
175struct utsname {
176 char sysname[SYS_NMLN];
177 char nodename[SYS_NMLN];
178 char release[SYS_NMLN];
179 char version[SYS_NMLN];
180 char machine[SYS_NMLN];
181};
182
390b85e7 183#ifndef START_EXTERN_C
b3e5c95e 184#undef EXTERN_C
390b85e7
GS		 185#ifdef __cplusplus
186# define START_EXTERN_C extern "C" {
187# define END_EXTERN_C }
188# define EXTERN_C extern "C"
189#else
3fadfdf1
NIS		 190# define START_EXTERN_C
191# define END_EXTERN_C
390b85e7
GS		 192# define EXTERN_C
193#endif
194#endif
195
196#define STANDARD_C 1
197#define DOSISH 1 /* no escaping our roots */
198#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 199
a7092146 200/* read() and write() aren't transparent for socket handles */
19253ae6
DD		 201#ifndef WIN32_NO_SOCKETS
202# define PERL_SOCK_SYSREAD_IS_RECV
203# define PERL_SOCK_SYSWRITE_IS_SEND
204#endif
a7092146 205
682fc664 206#define PERL_NO_FORCE_LINK /* no need for PL_force_link_funcs */
a7092146 207
902173a3
GS		 208#define ENV_IS_CASELESS
209
479b2847
GS		 210#define PIPESOCK_MODE "b" /* pipes, sockets default to binmode */
211
327c3667
GS		 212/* access() mode bits */
213#ifndef R_OK
214# define R_OK 4
215# define W_OK 2
216# define X_OK 1
217# define F_OK 0
218#endif
219
cc236deb
GS		 220/* for waitpid() */
221#ifndef WNOHANG
222# define WNOHANG 1
223#endif
224
c44d3fdb
GS		 225#define PERL_GET_CONTEXT_DEFINED
226
f3986ebb
GS		 227/* Compiler-specific stuff. */
228
654eccd5 229/* VC uses non-standard way to determine the size and alignment if bit-fields */
4eab039d
SH		 230/* MinGW will compile with -mms-bitfields, so should use the same types */
231#define PERL_BITFIELD8 unsigned char
232#define PERL_BITFIELD16 unsigned short
233#define PERL_BITFIELD32 unsigned int
654eccd5 234
f3986ebb
GS		 235#ifdef _MSC_VER /* Microsoft Visual C++ */
236
f4257e4d 237#ifndef UNDER_CE
0a753a76 238typedef long uid_t;
239typedef long gid_t;
a6c40364 240typedef unsigned short mode_t;
f4257e4d
YO		 241#endif
242
c623ac67 243#pragma warning(disable: 4102) /* "unreferenced label" */
f3986ebb 244
5fb4d820 245#define isnan _isnan
80e18237
SH		 246#define snprintf _snprintf
247#define vsnprintf _vsnprintf
5fb4d820 248
cab190d4
JD		 249#if _MSC_VER < 1300
250/* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
251#define NAN_COMPARE_BROKEN 1
252#endif
253
f3986ebb
GS		 254#endif /* _MSC_VER */
255
910dfcc8
GS		 256#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
257
258typedef long uid_t;
259typedef long gid_t;
b1d1613b 260#ifndef _environ
3730b96e 261#define _environ environ
b1d1613b 262#endif
3730b96e
GS		 263#define flushall _flushall
264#define fcloseall _fcloseall
44604af1 265#ifndef isnan
6940069f 266#define isnan _isnan /* ...same libraries as MSVC */
44604af1 267#endif
910dfcc8 268
ac4c12e7
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
8659febc
S		 276/* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
277 * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
278#ifdef _STDINT_H
279# ifndef _INTPTR_T_DEFINED
280# define _INTPTR_T_DEFINED
281# endif
282# ifndef _UINTPTR_T_DEFINED
283# define _UINTPTR_T_DEFINED
284# endif
285#endif
286
f8fb7c90
GS		 287#ifndef CP_UTF8
288# define CP_UTF8 65001
289#endif
290
70764c00
SH		 291#endif /* __MINGW32__ */
292
c623ac67
GS		 293#ifndef _INTPTR_T_DEFINED
294typedef int intptr_t;
295# define _INTPTR_T_DEFINED
296#endif
297
298#ifndef _UINTPTR_T_DEFINED
299typedef unsigned int uintptr_t;
300# define _UINTPTR_T_DEFINED
301#endif
302
390b85e7 303START_EXTERN_C
f3986ebb
GS		 304
305/* For UNIX compatibility. */
306
e37d7e38 307#ifdef PERL_CORE
0a753a76 308extern uid_t getuid(void);
309extern gid_t getgid(void);
310extern uid_t geteuid(void);
311extern gid_t getegid(void);
0c38a575
SH		 312extern int setuid(uid_t uid);
313extern int setgid(gid_t gid);
0a753a76 314extern int kill(int pid, int sig);
542cb85f 315extern int killpg(int pid, int sig);
c623ac67
GS		 316#ifndef USE_PERL_SBRK
317extern void *sbrk(ptrdiff_t need);
318# define HAS_SBRK_PROTO
319#endif
e34ffe5a 320extern char * getlogin(void);
b990f8c8 321extern int chown(const char *p, uid_t o, gid_t g);
00b02797 322extern int mkstemp(const char *path);
e37d7e38 323#endif
d55594ae 324
f3986ebb
GS		 325#undef Stat
326#define Stat win32_stat
3e3baf6d 327
f3986ebb
GS		 328#undef init_os_extras
329#define init_os_extras Perl_init_os_extras
390b85e7 330
22239a37 331DllExport void Perl_win32_init(int *argcp, char ***argvp);
23f519f0 332DllExport void Perl_win32_term(void);
cb359b41 333DllExport void Perl_init_os_extras(void);
c5be433b
GS		 334DllExport void win32_str_os_error(void *sv, DWORD err);
335DllExport int RunPerl(int argc, char **argv, char **env);
0551aaa8 336
635bbe87
GS		 337typedef struct {
338 HANDLE childStdIn;
339 HANDLE childStdOut;
340 HANDLE childStdErr;
f83751a7
GS		 341 /*
342 * the following correspond to the fields of the same name
343 * in the STARTUPINFO structure. Embedders can use these to
344 * control the spawning process' look.
345 * Example - to hide the window of the spawned process:
346 * dwFlags = STARTF_USESHOWWINDOW;
347 * wShowWindow = SW_HIDE;
348 */
349 DWORD dwFlags;
3fadfdf1
NIS		 350 DWORD dwX;
351 DWORD dwY;
352 DWORD dwXSize;
353 DWORD dwYSize;
354 DWORD dwXCountChars;
355 DWORD dwYCountChars;
f83751a7 356 DWORD dwFillAttribute;
3fadfdf1 357 WORD wShowWindow;
635bbe87
GS		 358} child_IO_table;
359
360DllExport void win32_get_child_IO(child_IO_table* ptr);
b69b0499 361DllExport HWND win32_create_message_window(void);
635bbe87 362
f3986ebb 363extern int my_fclose(FILE *);
e6a0bbf8
NC		 364extern char * win32_get_privlib(const char *pl, STRLEN *const len);
365extern char * win32_get_sitelib(const char *pl, STRLEN *const len);
366extern char * win32_get_vendorlib(const char *pl, STRLEN *const len);
d55594ae 367
1c0ca838
GS		 368#ifdef PERL_IMPLICIT_SYS
369extern void win32_delete_internal_host(void *h);
370#endif
371
c9beaf97
SH		 372extern int win32_get_errno(int err);
373
fe1c5936 374extern const char * const staticlinkmodules[];
390b85e7
GS		 375
376END_EXTERN_C
d55594ae 377
68dc0745 378typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 379
68dc0745 380/*
68dc0745 381 * handle socket stuff, assuming socket is always available
382 */
0a753a76 383#include <sys/socket.h>
384#include <netdb.h>
385
bbc8f9de
NIS		 386#ifdef MYMALLOC
387#define EMBEDMYMALLOC /**/
388/* #define USE_PERL_SBRK /**/
389/* #define PERL_SBRK_VIA_MALLOC /**/
390#endif
391
e68cb057 392#ifdef PERL_TEXTMODE_SCRIPTS
c39cd008 393# define PERL_SCRIPT_MODE "r"
a868473f 394#else
c39cd008 395# define PERL_SCRIPT_MODE "rb"
a868473f
NIS		 396#endif
397
3fadfdf1
NIS		 398/*
399 * Now Win32 specific per-thread data stuff
3352bfcb
GS		 400 */
401
aeecf691
JD		 402/* Leave the first couple ids after WM_USER unused because they
403 * might be used by an embedding application, and on Windows
404 * version before 2000 we might end up eating those messages
405 * if they were not meant for us.
406 */
407#define WM_USER_MIN (WM_USER+30)
408#define WM_USER_MESSAGE (WM_USER_MIN)
409#define WM_USER_KILL (WM_USER_MIN+1)
410#define WM_USER_MAX (WM_USER_MIN+1)
411
3352bfcb
GS		 412struct thread_intern {
413 /* XXX can probably use one buffer instead of several */
414 char Wstrerror_buffer[512];
415 struct servent Wservent;
416 char Wgetlogin_buffer[128];
f4257e4d 417 int Winit_socktype;
3352bfcb 418 char Wcrypt_buffer[30];
3352bfcb
GS		 419# ifdef USE_RTL_THREAD_API
420 void * retv; /* slot for thread return value */
421# endif
02637f4c
JD		 422 BOOL Wuse_showwindow;
423 WORD Wshowwindow;
3352bfcb
GS		 424};
425
4b556e6c 426#define HAVE_INTERP_INTERN
0aaad0ff
GS		 427typedef struct {
428 long num;
429 DWORD pids[MAXIMUM_WAIT_OBJECTS];
7766f137 430 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
0aaad0ff
GS		 431} child_tab;
432
aeecf691
JD		 433#ifdef USE_ITHREADS
434typedef struct {
435 long num;
436 DWORD pids[MAXIMUM_WAIT_OBJECTS];
437 HANDLE handles[MAXIMUM_WAIT_OBJECTS];
438 HWND message_hwnds[MAXIMUM_WAIT_OBJECTS];
8a3cb9c6 439 char sigterm[MAXIMUM_WAIT_OBJECTS];
aeecf691
JD		 440} pseudo_child_tab;
441#endif
442
3fadfdf1
NIS		 443#ifndef Sighandler_t
444typedef Signal_t (*Sighandler_t) (int);
445#define Sighandler_t Sighandler_t
446#endif
447
4b556e6c 448struct interp_intern {
0aaad0ff
GS		 449 char * perlshell_tokens;
450 char ** perlshell_vec;
451 long perlshell_items;
452 struct av * fdpid;
453 child_tab * children;
7766f137
GS		 454#ifdef USE_ITHREADS
455 DWORD pseudo_id;
aeecf691 456 pseudo_child_tab * pseudo_children;
7766f137
GS		 457#endif
458 void * internal_host;
3352bfcb 459 struct thread_intern thr_intern;
aeecf691 460 HWND message_hwnd;
8fb3fcfb 461 UINT timerid;
05ec9bb3 462 unsigned poll_count;
3fadfdf1 463 Sighandler_t sigtable[SIG_SIZE];
4b556e6c
JD		 464};
465
8fb3fcfb
NIS		 466DllExport int win32_async_check(pTHX);
467
05ec9bb3 468#define WIN32_POLL_INTERVAL 32768
8fb3fcfb 469#define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
4b556e6c 470
0aaad0ff
GS		 471#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
472#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
473#define w32_perlshell_items (PL_sys_intern.perlshell_items)
474#define w32_fdpid (PL_sys_intern.fdpid)
475#define w32_children (PL_sys_intern.children)
476#define w32_num_children (w32_children->num)
477#define w32_child_pids (w32_children->pids)
7766f137
GS		 478#define w32_child_handles (w32_children->handles)
479#define w32_pseudo_id (PL_sys_intern.pseudo_id)
480#define w32_pseudo_children (PL_sys_intern.pseudo_children)
481#define w32_num_pseudo_children (w32_pseudo_children->num)
482#define w32_pseudo_child_pids (w32_pseudo_children->pids)
483#define w32_pseudo_child_handles (w32_pseudo_children->handles)
aeecf691 484#define w32_pseudo_child_message_hwnds (w32_pseudo_children->message_hwnds)
8a3cb9c6 485#define w32_pseudo_child_sigterm (w32_pseudo_children->sigterm)
7766f137 486#define w32_internal_host (PL_sys_intern.internal_host)
8fb3fcfb 487#define w32_timerid (PL_sys_intern.timerid)
aeecf691 488#define w32_message_hwnd (PL_sys_intern.message_hwnd)
3fadfdf1 489#define w32_sighandler (PL_sys_intern.sigtable)
05ec9bb3
NIS		 490#define w32_poll_count (PL_sys_intern.poll_count)
491#define w32_do_async (w32_poll_count++ > WIN32_POLL_INTERVAL)
3db8f154
MB		 492#define w32_strerror_buffer (PL_sys_intern.thr_intern.Wstrerror_buffer)
493#define w32_getlogin_buffer (PL_sys_intern.thr_intern.Wgetlogin_buffer)
494#define w32_crypt_buffer (PL_sys_intern.thr_intern.Wcrypt_buffer)
495#define w32_servent (PL_sys_intern.thr_intern.Wservent)
f4257e4d 496#define w32_init_socktype (PL_sys_intern.thr_intern.Winit_socktype)
3db8f154
MB		 497#define w32_use_showwindow (PL_sys_intern.thr_intern.Wuse_showwindow)
498#define w32_showwindow (PL_sys_intern.thr_intern.Wshowwindow)
c53bd28a 499
7766f137 500#ifdef USE_ITHREADS
8a3cb9c6
JD		 501void win32_wait_for_children(pTHX);
502# define PERL_WAIT_FOR_CHILDREN win32_wait_for_children(aTHX)
7766f137
GS		 503#endif
504
3fadfdf1 505/* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
6e22d046
JH		 506#if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
507#undef PERLIO_NOT_STDIO
508#endif
adb71456
NIS		 509#define PERLIO_NOT_STDIO 0
510
511#include "perlio.h"
512
4f63d024
GS		 513/*
514 * This provides a layer of functions and macros to ensure extensions will
515 * get to use the same RTL functions as the core.
516 */
517#include "win32iop.h"
518
b4748376
NIS		 519#define EXEC_ARGV_CAST(x) ((const char *const *) x)
520
f4958739 521DllExport void *win32_signal_context(void);
1018e26f
NIS		 522#define PERL_GET_SIG_CONTEXT win32_signal_context()
523
45496817 524#ifdef UNDER_CE
7bd379e8
YO		 525#define Win_GetModuleHandle XCEGetModuleHandleA
526#define Win_GetProcAddress XCEGetProcAddressA
527#define Win_GetModuleFileName XCEGetModuleFileNameA
528#define Win_CreateSemaphore CreateSemaphoreW
529#else
530#define Win_GetModuleHandle GetModuleHandle
531#define Win_GetProcAddress GetProcAddress
532#define Win_GetModuleFileName GetModuleFileName
533#define Win_CreateSemaphore CreateSemaphore
534#endif
535
68dc0745 536#endif /* _INC_WIN32_PERL5 */
7a9ec5a3 537
Unnamed repository; edit this file 'description' to name the repository.