Stop sub decl redef warnings from leaking CVs
[perl.git] / win32 / win32.h
1 /* WIN32.H
2  *
3  * (c) 1995 Microsoft Corporation. All rights reserved.
4  *              Developed by hip communications inc.
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  */
9 #ifndef  _INC_WIN32_PERL5
10 #define  _INC_WIN32_PERL5
11
12 #ifndef _WIN32_WINNT
13 #  define _WIN32_WINNT 0x0500     /* needed for CreateHardlink() etc. */
14 #endif
15
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
48 #if defined(PERL_IMPLICIT_SYS)
49 #  define DYNAMIC_ENV_FETCH
50 #  define HAS_GETENV_LEN
51 #  define prime_env_iter()
52 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
53 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
54 #  ifdef PERL_GLOBAL_STRUCT
55 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
56 #  endif
57 #  define win32_get_privlib PerlEnv_lib_path
58 #  define win32_get_sitelib PerlEnv_sitelib_path
59 #  define win32_get_vendorlib PerlEnv_vendorlib_path
60 #endif
61
62 #ifdef __GNUC__
63 #  ifndef __int64               /* some versions seem to #define it already */
64 #    define __int64 long long
65 #  endif
66 #  define Win32_Winsock
67 #ifdef __cplusplus
68 /* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
69 #undef  PERL_UNUSED_DECL
70 #define PERL_UNUSED_DECL
71 #endif
72 #endif
73
74
75 /* Define DllExport akin to perl's EXT,
76  * If we are in the DLL then Export the symbol,
77  * otherwise import it.
78  */
79
80 /* now even GCC supports __declspec() */
81 /* miniperl has no reason to export anything */
82 #if defined(PERL_IS_MINIPERL) && !defined(UNDER_CE) && defined(_MSC_VER)
83 #  define DllExport
84 #else
85 #  if defined(PERLDLL)
86 #    define DllExport __declspec(dllexport)
87 #  else
88 #    define DllExport __declspec(dllimport)
89 #  endif
90 #endif
91
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)
102 #  ifdef __cplusplus
103 #    define PERL_CALLCONV extern "C" __declspec(dllimport)
104 #    ifdef _MSC_VER
105 #      define PERL_CALLCONV_NO_RET extern "C" __declspec(dllimport) __declspec(noreturn)
106 #    endif
107 #  else
108 #    define PERL_CALLCONV __declspec(dllimport)
109 #    ifdef _MSC_VER
110 #      define PERL_CALLCONV_NO_RET __declspec(dllimport) __declspec(noreturn)
111 #    endif
112 #  endif
113 #else /* MSVC noreturn support inside the interp */
114 #  ifdef _MSC_VER
115 #    define PERL_CALLCONV_NO_RET __declspec(noreturn)
116 #  endif
117 #endif
118
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
124 #define  WIN32_LEAN_AND_MEAN
125 #include <windows.h>
126
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
134 extern "C" {
135 #endif
136 #undef GetEnvironmentStringsA
137 WINBASEAPI LPCH WINAPI GetEnvironmentStringsA(VOID);
138 #define GetEnvironmentStrings GetEnvironmentStringsA
139 #ifdef __cplusplus
140 }
141 #endif
142 #endif
143
144 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
145 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
146 #endif /*WIN32_LEAN_AND_MEAN */
147
148 #ifndef TLS_OUT_OF_INDEXES
149 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
150 #endif
151
152 #include <dirent.h>
153 #include <io.h>
154 #include <process.h>
155 #include <stdio.h>
156 #include <direct.h>
157 #include <stdlib.h>
158 #include <stddef.h>
159 #include <fcntl.h>
160 #ifndef EXT
161 #include "EXTERN.h"
162 #endif
163
164 struct tms {
165         long    tms_utime;
166         long    tms_stime;
167         long    tms_cutime;
168         long    tms_cstime;
169 };
170
171 #ifndef SYS_NMLN
172 #define SYS_NMLN        257
173 #endif
174
175 struct 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
183 #ifndef START_EXTERN_C
184 #undef EXTERN_C
185 #ifdef __cplusplus
186 #  define START_EXTERN_C extern "C" {
187 #  define END_EXTERN_C }
188 #  define EXTERN_C extern "C"
189 #else
190 #  define START_EXTERN_C
191 #  define END_EXTERN_C
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? */
199
200 /* read() and write() aren't transparent for socket handles */
201 #ifndef WIN32_NO_SOCKETS
202 #  define PERL_SOCK_SYSREAD_IS_RECV
203 #  define PERL_SOCK_SYSWRITE_IS_SEND
204 #endif
205
206 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
207
208 #define ENV_IS_CASELESS
209
210 #define PIPESOCK_MODE   "b"             /* pipes, sockets default to binmode */
211
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
220 /* for waitpid() */
221 #ifndef WNOHANG
222 #  define WNOHANG       1
223 #endif
224
225 #define PERL_GET_CONTEXT_DEFINED
226
227 /* Compiler-specific stuff. */
228
229 /* VC uses non-standard way to determine the size and alignment if bit-fields */
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
234
235 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
236
237 #ifndef UNDER_CE
238 typedef long            uid_t;
239 typedef long            gid_t;
240 typedef unsigned short  mode_t;
241 #endif
242
243 #pragma  warning(disable: 4102) /* "unreferenced label" */
244
245 #define isnan           _isnan
246 #define snprintf        _snprintf
247 #define vsnprintf       _vsnprintf
248
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
254 #endif /* _MSC_VER */
255
256 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
257
258 typedef long            uid_t;
259 typedef long            gid_t;
260 #ifndef _environ
261 #define _environ        environ
262 #endif
263 #define flushall        _flushall
264 #define fcloseall       _fcloseall
265 #ifndef isnan
266 #define isnan           _isnan  /* ...same libraries as MSVC */
267 #endif
268
269 #ifndef _O_NOINHERIT
270 #  define _O_NOINHERIT  0x0080
271 #  ifndef _NO_OLDNAMES
272 #    define O_NOINHERIT _O_NOINHERIT
273 #  endif
274 #endif
275
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
287 #ifndef CP_UTF8
288 #  define CP_UTF8       65001
289 #endif
290
291 #endif /* __MINGW32__ */
292
293 #ifndef _INTPTR_T_DEFINED
294 typedef int             intptr_t;
295 #  define _INTPTR_T_DEFINED
296 #endif
297
298 #ifndef _UINTPTR_T_DEFINED
299 typedef unsigned int    uintptr_t;
300 #  define _UINTPTR_T_DEFINED
301 #endif
302
303 START_EXTERN_C
304
305 /* For UNIX compatibility. */
306
307 #ifdef PERL_CORE
308 extern  uid_t   getuid(void);
309 extern  gid_t   getgid(void);
310 extern  uid_t   geteuid(void);
311 extern  gid_t   getegid(void);
312 extern  int     setuid(uid_t uid);
313 extern  int     setgid(gid_t gid);
314 extern  int     kill(int pid, int sig);
315 extern  int     killpg(int pid, int sig);
316 #ifndef USE_PERL_SBRK
317 extern  void    *sbrk(ptrdiff_t need);
318 #  define HAS_SBRK_PROTO
319 #endif
320 extern  char *  getlogin(void);
321 extern  int     chown(const char *p, uid_t o, gid_t g);
322 extern  int     mkstemp(const char *path);
323 #endif
324
325 #undef   Stat
326 #define  Stat           win32_stat
327
328 #undef   init_os_extras
329 #define  init_os_extras Perl_init_os_extras
330
331 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
332 DllExport void          Perl_win32_term(void);
333 DllExport void          Perl_init_os_extras(void);
334 DllExport void          win32_str_os_error(void *sv, DWORD err);
335 DllExport int           RunPerl(int argc, char **argv, char **env);
336
337 typedef struct {
338     HANDLE      childStdIn;
339     HANDLE      childStdOut;
340     HANDLE      childStdErr;
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;
350     DWORD       dwX;
351     DWORD       dwY;
352     DWORD       dwXSize;
353     DWORD       dwYSize;
354     DWORD       dwXCountChars;
355     DWORD       dwYCountChars;
356     DWORD       dwFillAttribute;
357     WORD        wShowWindow;
358 } child_IO_table;
359
360 DllExport void          win32_get_child_IO(child_IO_table* ptr);
361 DllExport HWND          win32_create_message_window(void);
362
363 extern int              my_fclose(FILE *);
364 extern char *           win32_get_privlib(const char *pl, STRLEN *const len);
365 extern char *           win32_get_sitelib(const char *pl, STRLEN *const len);
366 extern char *           win32_get_vendorlib(const char *pl, STRLEN *const len);
367
368 #ifdef PERL_IMPLICIT_SYS
369 extern void             win32_delete_internal_host(void *h);
370 #endif
371
372 extern const char * const               staticlinkmodules[];
373
374 END_EXTERN_C
375
376 typedef  char *         caddr_t;        /* In malloc.c (core address). */
377
378 /*
379  * handle socket stuff, assuming socket is always available
380  */
381 #include <sys/socket.h>
382 #include <netdb.h>
383
384 #ifdef MYMALLOC
385 #define EMBEDMYMALLOC   /**/
386 /* #define USE_PERL_SBRK        /**/
387 /* #define PERL_SBRK_VIA_MALLOC /**/
388 #endif
389
390 #ifdef PERL_TEXTMODE_SCRIPTS
391 #  define PERL_SCRIPT_MODE              "r"
392 #else
393 #  define PERL_SCRIPT_MODE              "rb"
394 #endif
395
396 /*
397  * Now Win32 specific per-thread data stuff
398  */
399
400 /* Leave the first couple ids after WM_USER unused because they
401  * might be used by an embedding application, and on Windows
402  * version before 2000 we might end up eating those messages
403  * if they were not meant for us.
404  */
405 #define WM_USER_MIN     (WM_USER+30)
406 #define WM_USER_MESSAGE (WM_USER_MIN)
407 #define WM_USER_KILL    (WM_USER_MIN+1)
408 #define WM_USER_MAX     (WM_USER_MIN+1)
409
410 struct thread_intern {
411     /* XXX can probably use one buffer instead of several */
412     char                Wstrerror_buffer[512];
413     struct servent      Wservent;
414     char                Wgetlogin_buffer[128];
415     int                 Winit_socktype;
416     char                Wcrypt_buffer[30];
417 #    ifdef USE_RTL_THREAD_API
418     void *              retv;   /* slot for thread return value */
419 #    endif
420     BOOL               Wuse_showwindow;
421     WORD               Wshowwindow;
422 };
423
424 #define HAVE_INTERP_INTERN
425 typedef struct {
426     long        num;
427     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
428     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
429 } child_tab;
430
431 #ifdef USE_ITHREADS
432 typedef struct {
433     long        num;
434     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
435     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
436     HWND        message_hwnds[MAXIMUM_WAIT_OBJECTS];
437     char        sigterm[MAXIMUM_WAIT_OBJECTS];
438 } pseudo_child_tab;
439 #endif
440
441 #ifndef Sighandler_t
442 typedef Signal_t (*Sighandler_t) (int);
443 #define Sighandler_t    Sighandler_t
444 #endif
445
446 struct interp_intern {
447     char *      perlshell_tokens;
448     char **     perlshell_vec;
449     long        perlshell_items;
450     struct av * fdpid;
451     child_tab * children;
452 #ifdef USE_ITHREADS
453     DWORD       pseudo_id;
454     pseudo_child_tab * pseudo_children;
455 #endif
456     void *      internal_host;
457     struct thread_intern        thr_intern;
458     HWND        message_hwnd;
459     UINT        timerid;
460     unsigned    poll_count;
461     Sighandler_t sigtable[SIG_SIZE];
462 };
463
464 DllExport int win32_async_check(pTHX);
465
466 #define WIN32_POLL_INTERVAL 32768
467 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
468
469 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
470 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
471 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
472 #define w32_fdpid               (PL_sys_intern.fdpid)
473 #define w32_children            (PL_sys_intern.children)
474 #define w32_num_children        (w32_children->num)
475 #define w32_child_pids          (w32_children->pids)
476 #define w32_child_handles       (w32_children->handles)
477 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
478 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
479 #define w32_num_pseudo_children         (w32_pseudo_children->num)
480 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
481 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
482 #define w32_pseudo_child_message_hwnds  (w32_pseudo_children->message_hwnds)
483 #define w32_pseudo_child_sigterm        (w32_pseudo_children->sigterm)
484 #define w32_internal_host               (PL_sys_intern.internal_host)
485 #define w32_timerid                     (PL_sys_intern.timerid)
486 #define w32_message_hwnd                (PL_sys_intern.message_hwnd)
487 #define w32_sighandler                  (PL_sys_intern.sigtable)
488 #define w32_poll_count                  (PL_sys_intern.poll_count)
489 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
490 #define w32_strerror_buffer     (PL_sys_intern.thr_intern.Wstrerror_buffer)
491 #define w32_getlogin_buffer     (PL_sys_intern.thr_intern.Wgetlogin_buffer)
492 #define w32_crypt_buffer        (PL_sys_intern.thr_intern.Wcrypt_buffer)
493 #define w32_servent             (PL_sys_intern.thr_intern.Wservent)
494 #define w32_init_socktype       (PL_sys_intern.thr_intern.Winit_socktype)
495 #define w32_use_showwindow      (PL_sys_intern.thr_intern.Wuse_showwindow)
496 #define w32_showwindow  (PL_sys_intern.thr_intern.Wshowwindow)
497
498 #ifdef USE_ITHREADS
499 void win32_wait_for_children(pTHX);
500 #  define PERL_WAIT_FOR_CHILDREN win32_wait_for_children(aTHX)
501 #endif
502
503 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
504 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
505 #undef  PERLIO_NOT_STDIO
506 #endif
507 #define PERLIO_NOT_STDIO 0
508
509 #include "perlio.h"
510
511 /*
512  * This provides a layer of functions and macros to ensure extensions will
513  * get to use the same RTL functions as the core.
514  */
515 #include "win32iop.h"
516
517 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
518
519 DllExport void *win32_signal_context(void);
520 #define PERL_GET_SIG_CONTEXT win32_signal_context()
521
522 #ifdef UNDER_CE
523 #define Win_GetModuleHandle   XCEGetModuleHandleA
524 #define Win_GetProcAddress    XCEGetProcAddressA
525 #define Win_GetModuleFileName XCEGetModuleFileNameA
526 #define Win_CreateSemaphore   CreateSemaphoreW
527 #else
528 #define Win_GetModuleHandle   GetModuleHandle
529 #define Win_GetProcAddress    GetProcAddress
530 #define Win_GetModuleFileName GetModuleFileName
531 #define Win_CreateSemaphore   CreateSemaphore
532 #endif
533
534 #endif /* _INC_WIN32_PERL5 */
535