Support one-parameter unpack(), which unpacks $_.
[perl.git] / win32 / win32.h
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  */
9 #ifndef  _INC_WIN32_PERL5
10 #define  _INC_WIN32_PERL5
11
12 #ifndef _WIN32_WINNT
13 #  define _WIN32_WINNT 0x0400     /* needed for TryEnterCriticalSection() 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 or mimicing the DLL for Win95 work round
45  * then Export the symbol,
46  * otherwise import it.
47  */
48
49 /* now even GCC supports __declspec() */
50
51 #if defined(PERLDLL) || defined(WIN95FIX)
52 #define DllExport
53 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
54 #else
55 #define DllExport __declspec(dllimport)
56 #endif
57
58 #define  WIN32_LEAN_AND_MEAN
59 #include <windows.h>
60
61 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
62 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
63 #endif /*WIN32_LEAN_AND_MEAN */
64
65 #ifndef TLS_OUT_OF_INDEXES
66 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
67 #endif
68
69 #include <dirent.h>
70 #include <io.h>
71 #include <process.h>
72 #include <stdio.h>
73 #include <direct.h>
74 #include <stdlib.h>
75 #include <stddef.h>
76 #include <fcntl.h>
77 #ifndef EXT
78 #include "EXTERN.h"
79 #endif
80
81 struct tms {
82         long    tms_utime;
83         long    tms_stime;
84         long    tms_cutime;
85         long    tms_cstime;
86 };
87
88 #ifndef SYS_NMLN
89 #define SYS_NMLN        257
90 #endif
91
92 struct utsname {
93     char sysname[SYS_NMLN];
94     char nodename[SYS_NMLN];
95     char release[SYS_NMLN];
96     char version[SYS_NMLN];
97     char machine[SYS_NMLN];
98 };
99
100 #ifndef START_EXTERN_C
101 #undef EXTERN_C
102 #ifdef __cplusplus
103 #  define START_EXTERN_C extern "C" {
104 #  define END_EXTERN_C }
105 #  define EXTERN_C extern "C"
106 #else
107 #  define START_EXTERN_C
108 #  define END_EXTERN_C
109 #  define EXTERN_C
110 #endif
111 #endif
112
113 #define  STANDARD_C     1
114 #define  DOSISH         1               /* no escaping our roots */
115 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
116
117 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
118  * real filehandles. XXX Should always be defined (the other version is untested) */
119 #define USE_SOCKETS_AS_HANDLES
120
121 /* read() and write() aren't transparent for socket handles */
122 #define PERL_SOCK_SYSREAD_IS_RECV
123 #define PERL_SOCK_SYSWRITE_IS_SEND
124
125 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
126
127 /* Define USE_FIXED_OSFHANDLE to fix MSVCRT's _open_osfhandle() on W95.
128    It now uses some black magic to work seamlessly with the DLL CRT and
129    works with MSVC++ 4.0+ or GCC/Mingw32
130         -- BKS 1-24-2000 */
131 #if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
132 #define USE_FIXED_OSFHANDLE
133 #endif
134
135 /* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
136    DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
137         -- BKS 5-29-2000 */
138 #if !(defined(_M_IX86) && _MSC_VER >= 1200)
139 #define PERL_WIN32_SOCK_DLOAD
140 #endif
141 #define ENV_IS_CASELESS
142
143 #define PIPESOCK_MODE   "b"             /* pipes, sockets default to binmode */
144
145 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
146 #define VER_PLATFORM_WIN32_WINDOWS      1
147 #endif
148
149 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
150 #define FILE_SHARE_DELETE               0x00000004
151 #endif
152
153 /* access() mode bits */
154 #ifndef R_OK
155 #  define       R_OK    4
156 #  define       W_OK    2
157 #  define       X_OK    1
158 #  define       F_OK    0
159 #endif
160
161 /* for waitpid() */
162 #ifndef WNOHANG
163 #  define WNOHANG       1
164 #endif
165
166 #define PERL_GET_CONTEXT_DEFINED
167
168 /* Compiler-specific stuff. */
169
170 #ifdef __BORLANDC__             /* Borland C++ */
171
172 #if (__BORLANDC__ <= 0x520)
173 #define _access access
174 #define _chdir chdir
175 #endif
176
177 #define _getpid getpid
178 #define wcsicmp _wcsicmp
179 #include <sys/types.h>
180
181 #ifndef DllMain
182 #define DllMain DllEntryPoint
183 #endif
184
185 #pragma warn -ccc       /* "condition is always true/false" */
186 #pragma warn -rch       /* "unreachable code" */
187 #pragma warn -sig       /* "conversion may lose significant digits" */
188 #pragma warn -pia       /* "possibly incorrect assignment" */
189 #pragma warn -par       /* "parameter 'foo' is never used" */
190 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
191 #pragma warn -use       /* "'foo' is declared but never used" */
192 #pragma warn -csu       /* "comparing signed and unsigned values" */
193
194 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
195 #define PERL_MEMBER_PTR_SIZE    12
196
197 #define isnan           _isnan
198
199 #endif
200
201 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
202
203 typedef long            uid_t;
204 typedef long            gid_t;
205 typedef unsigned short  mode_t;
206 #pragma  warning(disable: 4102) /* "unreferenced label" */
207
208 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
209 #define PERL_MEMBER_PTR_SIZE    16
210
211 #define isnan           _isnan
212
213 #endif /* _MSC_VER */
214
215 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
216
217 typedef long            uid_t;
218 typedef long            gid_t;
219 #ifndef _environ
220 #define _environ        environ
221 #endif
222 #define flushall        _flushall
223 #define fcloseall       _fcloseall
224 #define isnan           _isnan  /* ...same libraries as MSVC */
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 #endif /* __MINGW32__ */
234
235 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
236 #ifndef CP_UTF8
237 #  define CP_UTF8       65001
238 #endif
239
240 /* compatibility stuff for other compilers goes here */
241
242 #ifndef _INTPTR_T_DEFINED
243 typedef int             intptr_t;
244 #  define _INTPTR_T_DEFINED
245 #endif
246
247 #ifndef _UINTPTR_T_DEFINED
248 typedef unsigned int    uintptr_t;
249 #  define _UINTPTR_T_DEFINED
250 #endif
251
252 START_EXTERN_C
253
254 /* For UNIX compatibility. */
255
256 extern  uid_t   getuid(void);
257 extern  gid_t   getgid(void);
258 extern  uid_t   geteuid(void);
259 extern  gid_t   getegid(void);
260 extern  int     setuid(uid_t uid);
261 extern  int     setgid(gid_t gid);
262 extern  int     kill(int pid, int sig);
263 #ifndef USE_PERL_SBRK
264 extern  void    *sbrk(ptrdiff_t need);
265 #  define HAS_SBRK_PROTO
266 #endif
267 extern  char *  getlogin(void);
268 extern  int     chown(const char *p, uid_t o, gid_t g);
269 extern  int     mkstemp(const char *path);
270
271 #undef   Stat
272 #define  Stat           win32_stat
273
274 #undef   init_os_extras
275 #define  init_os_extras Perl_init_os_extras
276
277 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
278 DllExport void          Perl_init_os_extras(void);
279 DllExport void          win32_str_os_error(void *sv, DWORD err);
280 DllExport int           RunPerl(int argc, char **argv, char **env);
281
282 typedef struct {
283     HANDLE      childStdIn;
284     HANDLE      childStdOut;
285     HANDLE      childStdErr;
286     /*
287      * the following correspond to the fields of the same name
288      * in the STARTUPINFO structure. Embedders can use these to
289      * control the spawning process' look.
290      * Example - to hide the window of the spawned process:
291      *    dwFlags = STARTF_USESHOWWINDOW;
292      *    wShowWindow = SW_HIDE;
293      */
294     DWORD       dwFlags;
295     DWORD       dwX;
296     DWORD       dwY;
297     DWORD       dwXSize;
298     DWORD       dwYSize;
299     DWORD       dwXCountChars;
300     DWORD       dwYCountChars;
301     DWORD       dwFillAttribute;
302     WORD        wShowWindow;
303 } child_IO_table;
304
305 DllExport void          win32_get_child_IO(child_IO_table* ptr);
306
307 #ifndef USE_SOCKETS_AS_HANDLES
308 extern FILE *           my_fdopen(int, char *);
309 #endif
310 extern int              my_fclose(FILE *);
311 extern int              my_fstat(int fd, Stat_t *sbufptr);
312 extern char *           win32_get_privlib(const char *pl);
313 extern char *           win32_get_sitelib(const char *pl);
314 extern char *           win32_get_vendorlib(const char *pl);
315 extern int              IsWin95(void);
316 extern int              IsWinNT(void);
317 extern void             win32_argv2utf8(int argc, char** argv);
318
319 #ifdef PERL_IMPLICIT_SYS
320 extern void             win32_delete_internal_host(void *h);
321 #endif
322
323 extern char *           staticlinkmodules[];
324
325 END_EXTERN_C
326
327 typedef  char *         caddr_t;        /* In malloc.c (core address). */
328
329 /*
330  * handle socket stuff, assuming socket is always available
331  */
332 #include <sys/socket.h>
333 #include <netdb.h>
334
335 #ifdef MYMALLOC
336 #define EMBEDMYMALLOC   /**/
337 /* #define USE_PERL_SBRK        /**/
338 /* #define PERL_SBRK_VIA_MALLOC /**/
339 #endif
340
341 #if defined(PERLDLL) && !defined(PERL_CORE)
342 #define PERL_CORE
343 #endif
344
345 #ifdef PERL_TEXTMODE_SCRIPTS
346 #  define PERL_SCRIPT_MODE              "r"
347 #else
348 #  define PERL_SCRIPT_MODE              "rb"
349 #endif
350
351 /*
352  * Now Win32 specific per-thread data stuff
353  */
354
355 struct thread_intern {
356     /* XXX can probably use one buffer instead of several */
357     char                Wstrerror_buffer[512];
358     struct servent      Wservent;
359     char                Wgetlogin_buffer[128];
360 #    ifdef USE_SOCKETS_AS_HANDLES
361     int                 Winit_socktype;
362 #    endif
363 #    ifdef HAVE_DES_FCRYPT
364     char                Wcrypt_buffer[30];
365 #    endif
366 #    ifdef USE_RTL_THREAD_API
367     void *              retv;   /* slot for thread return value */
368 #    endif
369     BOOL               Wuse_showwindow;
370     WORD               Wshowwindow;
371 };
372
373 #define HAVE_INTERP_INTERN
374 typedef struct {
375     long        num;
376     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
377     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
378 } child_tab;
379
380 #ifndef Sighandler_t
381 typedef Signal_t (*Sighandler_t) (int);
382 #define Sighandler_t    Sighandler_t
383 #endif
384
385 struct interp_intern {
386     char *      perlshell_tokens;
387     char **     perlshell_vec;
388     long        perlshell_items;
389     struct av * fdpid;
390     child_tab * children;
391 #ifdef USE_ITHREADS
392     DWORD       pseudo_id;
393     child_tab * pseudo_children;
394 #endif
395     void *      internal_host;
396     struct thread_intern        thr_intern;
397     UINT        timerid;
398     unsigned    poll_count;
399     Sighandler_t sigtable[SIG_SIZE];
400 };
401
402 DllExport int win32_async_check(pTHX);
403
404 #define WIN32_POLL_INTERVAL 32768
405 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
406
407 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
408 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
409 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
410 #define w32_fdpid               (PL_sys_intern.fdpid)
411 #define w32_children            (PL_sys_intern.children)
412 #define w32_num_children        (w32_children->num)
413 #define w32_child_pids          (w32_children->pids)
414 #define w32_child_handles       (w32_children->handles)
415 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
416 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
417 #define w32_num_pseudo_children         (w32_pseudo_children->num)
418 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
419 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
420 #define w32_internal_host               (PL_sys_intern.internal_host)
421 #define w32_timerid                     (PL_sys_intern.timerid)
422 #define w32_sighandler                  (PL_sys_intern.sigtable)
423 #define w32_poll_count                  (PL_sys_intern.poll_count)
424 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
425 #define w32_strerror_buffer     (PL_sys_intern.thr_intern.Wstrerror_buffer)
426 #define w32_getlogin_buffer     (PL_sys_intern.thr_intern.Wgetlogin_buffer)
427 #define w32_crypt_buffer        (PL_sys_intern.thr_intern.Wcrypt_buffer)
428 #define w32_servent             (PL_sys_intern.thr_intern.Wservent)
429 #define w32_init_socktype       (PL_sys_intern.thr_intern.Winit_socktype)
430 #define w32_use_showwindow      (PL_sys_intern.thr_intern.Wuse_showwindow)
431 #define w32_showwindow  (PL_sys_intern.thr_intern.Wshowwindow)
432
433 /* UNICODE<>ANSI translation helpers */
434 /* Use CP_ACP when mode is ANSI */
435 /* Use CP_UTF8 when mode is UTF8 */
436
437 #define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
438     (lpw[0] = 0, MultiByteToWideChar((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
439                                     lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
440 #define A2WHELPER(lpa, lpw, nBytes)     A2WHELPER_LEN(lpa, -1, lpw, nBytes)
441
442 #define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
443     (lpa[0] = '\0', WideCharToMultiByte((IN_BYTES) ? CP_ACP : CP_UTF8, 0, \
444                                        lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
445 #define W2AHELPER(lpw, lpa, nChars)     W2AHELPER_LEN(lpw, -1, lpa, nChars)
446
447 #define USING_WIDE() (0)
448
449 #ifdef USE_ITHREADS
450 #  define PERL_WAIT_FOR_CHILDREN \
451     STMT_START {                                                        \
452         if (w32_pseudo_children && w32_num_pseudo_children) {           \
453             long children = w32_num_pseudo_children;                    \
454             WaitForMultipleObjects(children,                            \
455                                    w32_pseudo_child_handles,            \
456                                    TRUE, INFINITE);                     \
457             while (children)                                            \
458                 CloseHandle(w32_pseudo_child_handles[--children]);      \
459         }                                                               \
460     } STMT_END
461 #endif
462
463 #if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
464 #ifdef PERL_CORE
465
466 /* C doesn't like repeat struct definitions */
467 #ifndef _CRTIMP
468 #define _CRTIMP __declspec(dllimport)
469 #endif
470
471 /*
472  * Control structure for lowio file handles
473  */
474 typedef struct {
475     intptr_t osfhnd;/* underlying OS file HANDLE */
476     char osfile;    /* attributes of file (e.g., open in text mode?) */
477     char pipech;    /* one char buffer for handles opened on pipes */
478     int lockinitflag;
479     CRITICAL_SECTION lock;
480 } ioinfo;
481
482
483 /*
484  * Array of arrays of control structures for lowio files.
485  */
486 EXTERN_C _CRTIMP ioinfo* __pioinfo[];
487
488 /*
489  * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
490  * array of ioinfo structs.
491  */
492 #define IOINFO_L2E          5
493
494 /*
495  * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
496  */
497 #define IOINFO_ARRAY_ELTS   (1 << IOINFO_L2E)
498
499 /*
500  * Access macros for getting at an ioinfo struct and its fields from a
501  * file handle
502  */
503 #define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
504 #define _osfhnd(i)  (_pioinfo(i)->osfhnd)
505 #define _osfile(i)  (_pioinfo(i)->osfile)
506 #define _pipech(i)  (_pioinfo(i)->pipech)
507
508 /* since we are not doing a dup2(), this works fine */
509 #define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
510 #endif
511 #endif
512
513 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
514 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
515 #undef  PERLIO_NOT_STDIO
516 #endif
517 #define PERLIO_NOT_STDIO 0
518
519 #include "perlio.h"
520
521 /*
522  * This provides a layer of functions and macros to ensure extensions will
523  * get to use the same RTL functions as the core.
524  */
525 #include "win32iop.h"
526
527 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
528
529 #if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
530 #define ECONNABORTED WSAECONNABORTED
531 #endif
532 #if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
533 #define EAFNOSUPPORT WSAEAFNOSUPPORT
534 #endif
535
536 DllExport void *win32_signal_context(void);
537 #define PERL_GET_SIG_CONTEXT win32_signal_context()
538
539 #endif /* _INC_WIN32_PERL5 */
540