Rewrite bignum’s hex and oct overrides
[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 #if defined(PERL_IMPLICIT_SYS)
17 #  define DYNAMIC_ENV_FETCH
18 #  define HAS_GETENV_LEN
19 #  define prime_env_iter()
20 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
21 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
22 #  ifdef PERL_GLOBAL_STRUCT
23 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
24 #  endif
25 #  define win32_get_privlib PerlEnv_lib_path
26 #  define win32_get_sitelib PerlEnv_sitelib_path
27 #  define win32_get_vendorlib PerlEnv_vendorlib_path
28 #endif
29
30 #ifdef __GNUC__
31 #  ifndef __int64               /* some versions seem to #define it already */
32 #    define __int64 long long
33 #  endif
34 #  define Win32_Winsock
35 #ifdef __cplusplus
36 /* Mingw32 gcc -xc++ objects to __attribute((unused)) at least */
37 #undef  PERL_UNUSED_DECL
38 #define PERL_UNUSED_DECL
39 #endif
40 #endif
41
42
43 /* Define DllExport akin to perl's EXT,
44  * If we are in the DLL then Export the symbol,
45  * otherwise import it.
46  */
47
48 /* now even GCC supports __declspec() */
49
50 #if defined(PERLDLL)
51 #define DllExport __declspec(dllexport)
52 #else
53 #define DllExport __declspec(dllimport)
54 #endif
55
56 /* The Perl APIs can only be called directly inside the perl5xx.dll.
57  * All other code has to import them.  By declaring them as "dllimport"
58  * we tell the compiler to generate an indirect call instruction and
59  * avoid redirection through a call thunk.
60  *
61  * The XS code in the re extension is special, in that it redefines
62  * core APIs locally, so don't mark them as "dllimport" because GCC
63  * cannot handle this situation.
64  */
65 #if !defined(PERLDLL) && !defined(PERL_EXT_RE_BUILD)
66 #  ifdef __cplusplus
67 #    define PERL_CALLCONV extern "C" __declspec(dllimport)
68 #    ifdef _MSC_VER
69 #      define PERL_CALLCONV_NO_RET extern "C" __declspec(dllimport) __declspec(noreturn)
70 #    endif
71 #  else
72 #    define PERL_CALLCONV __declspec(dllimport)
73 #    ifdef _MSC_VER
74 #      define PERL_CALLCONV_NO_RET __declspec(dllimport) __declspec(noreturn)
75 #    endif
76 #  endif
77 #else /* MSVC noreturn support inside the interp */
78 #  ifdef _MSC_VER
79 #    define PERL_CALLCONV_NO_RET __declspec(noreturn)
80 #  endif
81 #endif
82
83 #define  WIN32_LEAN_AND_MEAN
84 #include <windows.h>
85
86 /*
87  * Bug in winbase.h in mingw-w64 4.4.0-1 at least... they
88  * do #define GetEnvironmentStringsA GetEnvironmentStrings and fail
89  * to declare GetEnvironmentStringsA.
90  */
91 #if defined(__MINGW64__) && defined(GetEnvironmentStringsA) && !defined(UNICODE)
92 #ifdef __cplusplus
93 extern "C" {
94 #endif
95 #undef GetEnvironmentStringsA
96 WINBASEAPI LPCH WINAPI GetEnvironmentStringsA(VOID);
97 #define GetEnvironmentStrings GetEnvironmentStringsA
98 #ifdef __cplusplus
99 }
100 #endif
101 #endif
102
103 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
104 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
105 #endif /*WIN32_LEAN_AND_MEAN */
106
107 #ifndef TLS_OUT_OF_INDEXES
108 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
109 #endif
110
111 #include <dirent.h>
112 #include <io.h>
113 #include <process.h>
114 #include <stdio.h>
115 #include <direct.h>
116 #include <stdlib.h>
117 #include <stddef.h>
118 #include <fcntl.h>
119 #ifndef EXT
120 #include "EXTERN.h"
121 #endif
122
123 struct tms {
124         long    tms_utime;
125         long    tms_stime;
126         long    tms_cutime;
127         long    tms_cstime;
128 };
129
130 #ifndef SYS_NMLN
131 #define SYS_NMLN        257
132 #endif
133
134 struct utsname {
135     char sysname[SYS_NMLN];
136     char nodename[SYS_NMLN];
137     char release[SYS_NMLN];
138     char version[SYS_NMLN];
139     char machine[SYS_NMLN];
140 };
141
142 #ifndef START_EXTERN_C
143 #undef EXTERN_C
144 #ifdef __cplusplus
145 #  define START_EXTERN_C extern "C" {
146 #  define END_EXTERN_C }
147 #  define EXTERN_C extern "C"
148 #else
149 #  define START_EXTERN_C
150 #  define END_EXTERN_C
151 #  define EXTERN_C
152 #endif
153 #endif
154
155 #define  STANDARD_C     1
156 #define  DOSISH         1               /* no escaping our roots */
157 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
158
159 /* read() and write() aren't transparent for socket handles */
160 #define PERL_SOCK_SYSREAD_IS_RECV
161 #define PERL_SOCK_SYSWRITE_IS_SEND
162
163 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
164
165 #define ENV_IS_CASELESS
166
167 #define PIPESOCK_MODE   "b"             /* pipes, sockets default to binmode */
168
169 /* access() mode bits */
170 #ifndef R_OK
171 #  define       R_OK    4
172 #  define       W_OK    2
173 #  define       X_OK    1
174 #  define       F_OK    0
175 #endif
176
177 /* for waitpid() */
178 #ifndef WNOHANG
179 #  define WNOHANG       1
180 #endif
181
182 #define PERL_GET_CONTEXT_DEFINED
183
184 /* Compiler-specific stuff. */
185
186 /* VC uses non-standard way to determine the size and alignment if bit-fields */
187 /* MinGW will compile with -mms-bitfields, so should use the same types */
188 #define PERL_BITFIELD8  unsigned char
189 #define PERL_BITFIELD16 unsigned short
190 #define PERL_BITFIELD32 unsigned int
191
192 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
193
194 #ifndef UNDER_CE
195 typedef long            uid_t;
196 typedef long            gid_t;
197 typedef unsigned short  mode_t;
198 #endif
199
200 #pragma  warning(disable: 4102) /* "unreferenced label" */
201
202 #define isnan           _isnan
203 #define snprintf        _snprintf
204 #define vsnprintf       _vsnprintf
205
206 #if _MSC_VER < 1300
207 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
208 #define NAN_COMPARE_BROKEN 1
209 #endif
210
211 #endif /* _MSC_VER */
212
213 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
214
215 typedef long            uid_t;
216 typedef long            gid_t;
217 #ifndef _environ
218 #define _environ        environ
219 #endif
220 #define flushall        _flushall
221 #define fcloseall       _fcloseall
222 #ifndef isnan
223 #define isnan           _isnan  /* ...same libraries as MSVC */
224 #endif
225
226 #ifndef _O_NOINHERIT
227 #  define _O_NOINHERIT  0x0080
228 #  ifndef _NO_OLDNAMES
229 #    define O_NOINHERIT _O_NOINHERIT
230 #  endif
231 #endif
232
233 /* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
234  * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
235 #ifdef _STDINT_H
236 #  ifndef _INTPTR_T_DEFINED
237 #    define _INTPTR_T_DEFINED
238 #  endif
239 #  ifndef _UINTPTR_T_DEFINED
240 #    define _UINTPTR_T_DEFINED
241 #  endif
242 #endif
243
244 #ifndef CP_UTF8
245 #  define CP_UTF8       65001
246 #endif
247
248 #endif /* __MINGW32__ */
249
250 #ifndef _INTPTR_T_DEFINED
251 typedef int             intptr_t;
252 #  define _INTPTR_T_DEFINED
253 #endif
254
255 #ifndef _UINTPTR_T_DEFINED
256 typedef unsigned int    uintptr_t;
257 #  define _UINTPTR_T_DEFINED
258 #endif
259
260 START_EXTERN_C
261
262 /* For UNIX compatibility. */
263
264 extern  int     setuid(uid_t uid);
265 extern  int     setgid(gid_t gid);
266
267 #ifdef PERL_CORE
268 extern  uid_t   getuid(void);
269 extern  gid_t   getgid(void);
270 extern  uid_t   geteuid(void);
271 extern  gid_t   getegid(void);
272 extern  int     kill(int pid, int sig);
273 extern  int     killpg(int pid, int sig);
274 #ifndef USE_PERL_SBRK
275 extern  void    *sbrk(ptrdiff_t need);
276 #  define HAS_SBRK_PROTO
277 #endif
278 extern  char *  getlogin(void);
279 extern  int     chown(const char *p, uid_t o, gid_t g);
280 extern  int     mkstemp(const char *path);
281 #endif
282
283 #undef   Stat
284 #define  Stat           win32_stat
285
286 #undef   init_os_extras
287 #define  init_os_extras Perl_init_os_extras
288
289 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
290 DllExport void          Perl_win32_term(void);
291 DllExport void          Perl_init_os_extras(void);
292 DllExport void          win32_str_os_error(void *sv, DWORD err);
293 DllExport int           RunPerl(int argc, char **argv, char **env);
294
295 typedef struct {
296     HANDLE      childStdIn;
297     HANDLE      childStdOut;
298     HANDLE      childStdErr;
299     /*
300      * the following correspond to the fields of the same name
301      * in the STARTUPINFO structure. Embedders can use these to
302      * control the spawning process' look.
303      * Example - to hide the window of the spawned process:
304      *    dwFlags = STARTF_USESHOWWINDOW;
305      *    wShowWindow = SW_HIDE;
306      */
307     DWORD       dwFlags;
308     DWORD       dwX;
309     DWORD       dwY;
310     DWORD       dwXSize;
311     DWORD       dwYSize;
312     DWORD       dwXCountChars;
313     DWORD       dwYCountChars;
314     DWORD       dwFillAttribute;
315     WORD        wShowWindow;
316 } child_IO_table;
317
318 DllExport void          win32_get_child_IO(child_IO_table* ptr);
319 DllExport HWND          win32_create_message_window(void);
320
321 extern int              my_fclose(FILE *);
322 extern char *           win32_get_privlib(const char *pl, STRLEN *const len);
323 extern char *           win32_get_sitelib(const char *pl, STRLEN *const len);
324 extern char *           win32_get_vendorlib(const char *pl, STRLEN *const len);
325
326 #ifdef PERL_IMPLICIT_SYS
327 extern void             win32_delete_internal_host(void *h);
328 #endif
329
330 extern char *           staticlinkmodules[];
331
332 END_EXTERN_C
333
334 typedef  char *         caddr_t;        /* In malloc.c (core address). */
335
336 /*
337  * handle socket stuff, assuming socket is always available
338  */
339 #include <sys/socket.h>
340 #include <netdb.h>
341
342 #ifdef MYMALLOC
343 #define EMBEDMYMALLOC   /**/
344 /* #define USE_PERL_SBRK        /**/
345 /* #define PERL_SBRK_VIA_MALLOC /**/
346 #endif
347
348 #ifdef PERL_TEXTMODE_SCRIPTS
349 #  define PERL_SCRIPT_MODE              "r"
350 #else
351 #  define PERL_SCRIPT_MODE              "rb"
352 #endif
353
354 /*
355  * Now Win32 specific per-thread data stuff
356  */
357
358 /* Leave the first couple ids after WM_USER unused because they
359  * might be used by an embedding application, and on Windows
360  * version before 2000 we might end up eating those messages
361  * if they were not meant for us.
362  */
363 #define WM_USER_MIN     (WM_USER+30)
364 #define WM_USER_MESSAGE (WM_USER_MIN)
365 #define WM_USER_KILL    (WM_USER_MIN+1)
366 #define WM_USER_MAX     (WM_USER_MIN+1)
367
368 struct thread_intern {
369     /* XXX can probably use one buffer instead of several */
370     char                Wstrerror_buffer[512];
371     struct servent      Wservent;
372     char                Wgetlogin_buffer[128];
373     int                 Winit_socktype;
374     char                Wcrypt_buffer[30];
375 #    ifdef USE_RTL_THREAD_API
376     void *              retv;   /* slot for thread return value */
377 #    endif
378     BOOL               Wuse_showwindow;
379     WORD               Wshowwindow;
380 };
381
382 #define HAVE_INTERP_INTERN
383 typedef struct {
384     long        num;
385     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
386     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
387 } child_tab;
388
389 #ifdef USE_ITHREADS
390 typedef struct {
391     long        num;
392     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
393     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
394     HWND        message_hwnds[MAXIMUM_WAIT_OBJECTS];
395     char        sigterm[MAXIMUM_WAIT_OBJECTS];
396 } pseudo_child_tab;
397 #endif
398
399 #ifndef Sighandler_t
400 typedef Signal_t (*Sighandler_t) (int);
401 #define Sighandler_t    Sighandler_t
402 #endif
403
404 struct interp_intern {
405     char *      perlshell_tokens;
406     char **     perlshell_vec;
407     long        perlshell_items;
408     struct av * fdpid;
409     child_tab * children;
410 #ifdef USE_ITHREADS
411     DWORD       pseudo_id;
412     pseudo_child_tab * pseudo_children;
413 #endif
414     void *      internal_host;
415     struct thread_intern        thr_intern;
416     HWND        message_hwnd;
417     UINT        timerid;
418     unsigned    poll_count;
419     Sighandler_t sigtable[SIG_SIZE];
420 };
421
422 DllExport int win32_async_check(pTHX);
423
424 #define WIN32_POLL_INTERVAL 32768
425 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
426
427 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
428 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
429 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
430 #define w32_fdpid               (PL_sys_intern.fdpid)
431 #define w32_children            (PL_sys_intern.children)
432 #define w32_num_children        (w32_children->num)
433 #define w32_child_pids          (w32_children->pids)
434 #define w32_child_handles       (w32_children->handles)
435 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
436 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
437 #define w32_num_pseudo_children         (w32_pseudo_children->num)
438 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
439 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
440 #define w32_pseudo_child_message_hwnds  (w32_pseudo_children->message_hwnds)
441 #define w32_pseudo_child_sigterm        (w32_pseudo_children->sigterm)
442 #define w32_internal_host               (PL_sys_intern.internal_host)
443 #define w32_timerid                     (PL_sys_intern.timerid)
444 #define w32_message_hwnd                (PL_sys_intern.message_hwnd)
445 #define w32_sighandler                  (PL_sys_intern.sigtable)
446 #define w32_poll_count                  (PL_sys_intern.poll_count)
447 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
448 #define w32_strerror_buffer     (PL_sys_intern.thr_intern.Wstrerror_buffer)
449 #define w32_getlogin_buffer     (PL_sys_intern.thr_intern.Wgetlogin_buffer)
450 #define w32_crypt_buffer        (PL_sys_intern.thr_intern.Wcrypt_buffer)
451 #define w32_servent             (PL_sys_intern.thr_intern.Wservent)
452 #define w32_init_socktype       (PL_sys_intern.thr_intern.Winit_socktype)
453 #define w32_use_showwindow      (PL_sys_intern.thr_intern.Wuse_showwindow)
454 #define w32_showwindow  (PL_sys_intern.thr_intern.Wshowwindow)
455
456 #ifdef USE_ITHREADS
457 void win32_wait_for_children(pTHX);
458 #  define PERL_WAIT_FOR_CHILDREN win32_wait_for_children(aTHX)
459 #endif
460
461 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
462 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
463 #undef  PERLIO_NOT_STDIO
464 #endif
465 #define PERLIO_NOT_STDIO 0
466
467 #include "perlio.h"
468
469 /*
470  * This provides a layer of functions and macros to ensure extensions will
471  * get to use the same RTL functions as the core.
472  */
473 #include "win32iop.h"
474
475 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
476
477 DllExport void *win32_signal_context(void);
478 #define PERL_GET_SIG_CONTEXT win32_signal_context()
479
480 #ifdef UNDER_CE
481 #define Win_GetModuleHandle   XCEGetModuleHandleA
482 #define Win_GetProcAddress    XCEGetProcAddressA
483 #define Win_GetModuleFileName XCEGetModuleFileNameA
484 #define Win_CreateSemaphore   CreateSemaphoreW
485 #else
486 #define Win_GetModuleHandle   GetModuleHandle
487 #define Win_GetProcAddress    GetProcAddress
488 #define Win_GetModuleFileName GetModuleFileName
489 #define Win_CreateSemaphore   CreateSemaphore
490 #endif
491
492 #endif /* _INC_WIN32_PERL5 */
493