win32/ext has been gone for a while. don't search it.
[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 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    Only use this fix for VC++ 6.x or earlier (and for GCC, which we assume
132    uses MSVCRT.DLL). Later versions use MSVCR70.dll, MSVCR71.dll, etc, which
133    do not require the fix. */
134 #if (defined(_M_IX86) && _MSC_VER >= 1000 && _MSC_VER <= 1200) || defined(__MINGW32__)
135 #define USE_FIXED_OSFHANDLE
136 #endif
137
138 /* Define PERL_WIN32_SOCK_DLOAD to have Perl dynamically load the winsock
139    DLL when needed. Don't use if your compiler supports delayloading (ie, VC++ 6.0)
140         -- BKS 5-29-2000 */
141 #if !(defined(_M_IX86) && _MSC_VER >= 1200)
142 #define PERL_WIN32_SOCK_DLOAD
143 #endif
144 #define ENV_IS_CASELESS
145
146 #define PIPESOCK_MODE   "b"             /* pipes, sockets default to binmode */
147
148 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
149 #define VER_PLATFORM_WIN32_WINDOWS      1
150 #endif
151
152 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
153 #define FILE_SHARE_DELETE               0x00000004
154 #endif
155
156 /* access() mode bits */
157 #ifndef R_OK
158 #  define       R_OK    4
159 #  define       W_OK    2
160 #  define       X_OK    1
161 #  define       F_OK    0
162 #endif
163
164 /* for waitpid() */
165 #ifndef WNOHANG
166 #  define WNOHANG       1
167 #endif
168
169 #define PERL_GET_CONTEXT_DEFINED
170
171 /* Compiler-specific stuff. */
172
173 #if defined(_MSC_VER) || defined(__MINGW32__)
174 /* VC uses non-standard way to determine the size and alignment if bit-fields */
175 /* MinGW will compiler with -mms-bitfields, so should use the same types */
176 #  define PERL_BITFIELD8  unsigned char
177 #  define PERL_BITFIELD16 unsigned short
178 #  define PERL_BITFIELD32 unsigned int
179 #endif
180
181 #ifdef __BORLANDC__             /* Borland C++ */
182
183 #if (__BORLANDC__ <= 0x520)
184 #define _access access
185 #define _chdir chdir
186 #endif
187
188 #define _getpid getpid
189 #define wcsicmp _wcsicmp
190 #include <sys/types.h>
191
192 #ifndef DllMain
193 #define DllMain DllEntryPoint
194 #endif
195
196 #pragma warn -8004      /* "'foo' is assigned a value that is never used" */
197 #pragma warn -8008      /* "condition is always true/false" */
198 #pragma warn -8012      /* "comparing signed and unsigned values" */
199 #pragma warn -8027      /* "functions containing %s are not expanded inline" */
200 #pragma warn -8057      /* "parameter 'foo' is never used" */
201 #pragma warn -8060      /* "possibly incorrect assignment" */
202 #pragma warn -8066      /* "unreachable code" */
203 #pragma warn -8071      /* "conversion may lose significant digits" */
204 #pragma warn -8080      /* "'foo' is declared but never used" */
205
206 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
207 #define PERL_MEMBER_PTR_SIZE    12
208
209 #define isnan           _isnan
210
211 #endif
212
213 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
214
215 #ifndef UNDER_CE
216 typedef long            uid_t;
217 typedef long            gid_t;
218 typedef unsigned short  mode_t;
219 #endif
220
221 #pragma  warning(disable: 4102) /* "unreferenced label" */
222
223 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
224 #define PERL_MEMBER_PTR_SIZE    16
225
226 #define isnan           _isnan
227 #define snprintf        _snprintf
228 #define vsnprintf       _vsnprintf
229
230 #if _MSC_VER < 1300
231 /* VC6 has broken NaN semantics: NaN == NaN returns true instead of false */
232 #define NAN_COMPARE_BROKEN 1
233 #endif
234
235 #endif /* _MSC_VER */
236
237 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
238
239 typedef long            uid_t;
240 typedef long            gid_t;
241 #ifndef _environ
242 #define _environ        environ
243 #endif
244 #define flushall        _flushall
245 #define fcloseall       _fcloseall
246 #define isnan           _isnan  /* ...same libraries as MSVC */
247
248 #ifndef _O_NOINHERIT
249 #  define _O_NOINHERIT  0x0080
250 #  ifndef _NO_OLDNAMES
251 #    define O_NOINHERIT _O_NOINHERIT
252 #  endif
253 #endif
254
255 /* <stdint.h>, pulled in by <io.h> as of mingw-runtime-3.3, typedef's
256  * (u)intptr_t but doesn't set the _(U)INTPTR_T_DEFINED defines */
257 #ifdef _STDINT_H
258 #  ifndef _INTPTR_T_DEFINED
259 #    define _INTPTR_T_DEFINED
260 #  endif
261 #  ifndef _UINTPTR_T_DEFINED
262 #    define _UINTPTR_T_DEFINED
263 #  endif
264 #endif
265
266 #endif /* __MINGW32__ */
267
268 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
269 #ifndef CP_UTF8
270 #  define CP_UTF8       65001
271 #endif
272
273 /* compatibility stuff for other compilers goes here */
274
275 #ifndef _INTPTR_T_DEFINED
276 typedef int             intptr_t;
277 #  define _INTPTR_T_DEFINED
278 #endif
279
280 #ifndef _UINTPTR_T_DEFINED
281 typedef unsigned int    uintptr_t;
282 #  define _UINTPTR_T_DEFINED
283 #endif
284
285 START_EXTERN_C
286
287 /* For UNIX compatibility. */
288
289 extern  uid_t   getuid(void);
290 extern  gid_t   getgid(void);
291 extern  uid_t   geteuid(void);
292 extern  gid_t   getegid(void);
293 extern  int     setuid(uid_t uid);
294 extern  int     setgid(gid_t gid);
295 extern  int     kill(int pid, int sig);
296 extern  int     killpg(int pid, int sig);
297 #ifndef USE_PERL_SBRK
298 extern  void    *sbrk(ptrdiff_t need);
299 #  define HAS_SBRK_PROTO
300 #endif
301 extern  char *  getlogin(void);
302 extern  int     chown(const char *p, uid_t o, gid_t g);
303 extern  int     mkstemp(const char *path);
304
305 #undef   Stat
306 #define  Stat           win32_stat
307
308 #undef   init_os_extras
309 #define  init_os_extras Perl_init_os_extras
310
311 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
312 DllExport void          Perl_win32_term(void);
313 DllExport void          Perl_init_os_extras(void);
314 DllExport void          win32_str_os_error(void *sv, DWORD err);
315 DllExport int           RunPerl(int argc, char **argv, char **env);
316
317 typedef struct {
318     HANDLE      childStdIn;
319     HANDLE      childStdOut;
320     HANDLE      childStdErr;
321     /*
322      * the following correspond to the fields of the same name
323      * in the STARTUPINFO structure. Embedders can use these to
324      * control the spawning process' look.
325      * Example - to hide the window of the spawned process:
326      *    dwFlags = STARTF_USESHOWWINDOW;
327      *    wShowWindow = SW_HIDE;
328      */
329     DWORD       dwFlags;
330     DWORD       dwX;
331     DWORD       dwY;
332     DWORD       dwXSize;
333     DWORD       dwYSize;
334     DWORD       dwXCountChars;
335     DWORD       dwYCountChars;
336     DWORD       dwFillAttribute;
337     WORD        wShowWindow;
338 } child_IO_table;
339
340 DllExport void          win32_get_child_IO(child_IO_table* ptr);
341 DllExport HWND          win32_create_message_window(void);
342
343 #ifndef USE_SOCKETS_AS_HANDLES
344 extern FILE *           my_fdopen(int, char *);
345 #endif
346 extern int              my_fclose(FILE *);
347 extern int              my_fstat(int fd, Stat_t *sbufptr);
348 extern char *           win32_get_privlib(const char *pl, STRLEN *const len);
349 extern char *           win32_get_sitelib(const char *pl, STRLEN *const len);
350 extern char *           win32_get_vendorlib(const char *pl, STRLEN *const len);
351 extern int              IsWin95(void);
352 extern int              IsWinNT(void);
353
354 #ifdef PERL_IMPLICIT_SYS
355 extern void             win32_delete_internal_host(void *h);
356 #endif
357
358 extern char *           staticlinkmodules[];
359
360 END_EXTERN_C
361
362 typedef  char *         caddr_t;        /* In malloc.c (core address). */
363
364 /*
365  * handle socket stuff, assuming socket is always available
366  */
367 #include <sys/socket.h>
368 #include <netdb.h>
369
370 #ifdef MYMALLOC
371 #define EMBEDMYMALLOC   /**/
372 /* #define USE_PERL_SBRK        /**/
373 /* #define PERL_SBRK_VIA_MALLOC /**/
374 #endif
375
376 #ifdef PERL_TEXTMODE_SCRIPTS
377 #  define PERL_SCRIPT_MODE              "r"
378 #else
379 #  define PERL_SCRIPT_MODE              "rb"
380 #endif
381
382 /*
383  * Now Win32 specific per-thread data stuff
384  */
385
386 /* Leave the first couple ids after WM_USER unused because they
387  * might be used by an embedding application, and on Windows
388  * version before 2000 we might end up eating those messages
389  * if they were not meant for us.
390  */
391 #define WM_USER_MIN     (WM_USER+30)
392 #define WM_USER_MESSAGE (WM_USER_MIN)
393 #define WM_USER_KILL    (WM_USER_MIN+1)
394 #define WM_USER_MAX     (WM_USER_MIN+1)
395
396 struct thread_intern {
397     /* XXX can probably use one buffer instead of several */
398     char                Wstrerror_buffer[512];
399     struct servent      Wservent;
400     char                Wgetlogin_buffer[128];
401 #    ifdef USE_SOCKETS_AS_HANDLES
402     int                 Winit_socktype;
403 #    endif
404 #    ifdef HAVE_DES_FCRYPT
405     char                Wcrypt_buffer[30];
406 #    endif
407 #    ifdef USE_RTL_THREAD_API
408     void *              retv;   /* slot for thread return value */
409 #    endif
410     BOOL               Wuse_showwindow;
411     WORD               Wshowwindow;
412 };
413
414 #define HAVE_INTERP_INTERN
415 typedef struct {
416     long        num;
417     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
418     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
419 } child_tab;
420
421 #ifdef USE_ITHREADS
422 typedef struct {
423     long        num;
424     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
425     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
426     HWND        message_hwnds[MAXIMUM_WAIT_OBJECTS];
427 } pseudo_child_tab;
428 #endif
429
430 #ifndef Sighandler_t
431 typedef Signal_t (*Sighandler_t) (int);
432 #define Sighandler_t    Sighandler_t
433 #endif
434
435 struct interp_intern {
436     char *      perlshell_tokens;
437     char **     perlshell_vec;
438     long        perlshell_items;
439     struct av * fdpid;
440     child_tab * children;
441 #ifdef USE_ITHREADS
442     DWORD       pseudo_id;
443     pseudo_child_tab * pseudo_children;
444 #endif
445     void *      internal_host;
446     struct thread_intern        thr_intern;
447     HWND        message_hwnd;
448     UINT        timerid;
449     unsigned    poll_count;
450     Sighandler_t sigtable[SIG_SIZE];
451 };
452
453 DllExport int win32_async_check(pTHX);
454
455 #define WIN32_POLL_INTERVAL 32768
456 #define PERL_ASYNC_CHECK() if (w32_do_async || PL_sig_pending) win32_async_check(aTHX)
457
458 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
459 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
460 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
461 #define w32_fdpid               (PL_sys_intern.fdpid)
462 #define w32_children            (PL_sys_intern.children)
463 #define w32_num_children        (w32_children->num)
464 #define w32_child_pids          (w32_children->pids)
465 #define w32_child_handles       (w32_children->handles)
466 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
467 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
468 #define w32_num_pseudo_children         (w32_pseudo_children->num)
469 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
470 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
471 #define w32_pseudo_child_message_hwnds  (w32_pseudo_children->message_hwnds)
472 #define w32_internal_host               (PL_sys_intern.internal_host)
473 #define w32_timerid                     (PL_sys_intern.timerid)
474 #define w32_message_hwnd                (PL_sys_intern.message_hwnd)
475 #define w32_sighandler                  (PL_sys_intern.sigtable)
476 #define w32_poll_count                  (PL_sys_intern.poll_count)
477 #define w32_do_async                    (w32_poll_count++ > WIN32_POLL_INTERVAL)
478 #define w32_strerror_buffer     (PL_sys_intern.thr_intern.Wstrerror_buffer)
479 #define w32_getlogin_buffer     (PL_sys_intern.thr_intern.Wgetlogin_buffer)
480 #define w32_crypt_buffer        (PL_sys_intern.thr_intern.Wcrypt_buffer)
481 #define w32_servent             (PL_sys_intern.thr_intern.Wservent)
482 #define w32_init_socktype       (PL_sys_intern.thr_intern.Winit_socktype)
483 #define w32_use_showwindow      (PL_sys_intern.thr_intern.Wuse_showwindow)
484 #define w32_showwindow  (PL_sys_intern.thr_intern.Wshowwindow)
485
486 #ifdef USE_ITHREADS
487 #  define PERL_WAIT_FOR_CHILDREN \
488     STMT_START {                                                        \
489         if (w32_pseudo_children && w32_num_pseudo_children) {           \
490             long children = w32_num_pseudo_children;                    \
491             WaitForMultipleObjects(children,                            \
492                                    w32_pseudo_child_handles,            \
493                                    TRUE, INFINITE);                     \
494             while (children)                                            \
495                 CloseHandle(w32_pseudo_child_handles[--children]);      \
496         }                                                               \
497     } STMT_END
498 #endif
499
500 #if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
501 #ifdef PERL_CORE
502
503 /* C doesn't like repeat struct definitions */
504 #if defined(__MINGW32__) && (__MINGW32_MAJOR_VERSION>=3)
505 #undef _CRTIMP
506 #endif
507 #ifndef _CRTIMP
508 #define _CRTIMP __declspec(dllimport)
509 #endif
510
511 /*
512  * Control structure for lowio file handles
513  */
514 typedef struct {
515     intptr_t osfhnd;/* underlying OS file HANDLE */
516     char osfile;    /* attributes of file (e.g., open in text mode?) */
517     char pipech;    /* one char buffer for handles opened on pipes */
518     int lockinitflag;
519     CRITICAL_SECTION lock;
520 } ioinfo;
521
522
523 /*
524  * Array of arrays of control structures for lowio files.
525  */
526 EXTERN_C _CRTIMP ioinfo* __pioinfo[];
527
528 /*
529  * Definition of IOINFO_L2E, the log base 2 of the number of elements in each
530  * array of ioinfo structs.
531  */
532 #define IOINFO_L2E          5
533
534 /*
535  * Definition of IOINFO_ARRAY_ELTS, the number of elements in ioinfo array
536  */
537 #define IOINFO_ARRAY_ELTS   (1 << IOINFO_L2E)
538
539 /*
540  * Access macros for getting at an ioinfo struct and its fields from a
541  * file handle
542  */
543 #define _pioinfo(i) (__pioinfo[(i) >> IOINFO_L2E] + ((i) & (IOINFO_ARRAY_ELTS - 1)))
544 #define _osfhnd(i)  (_pioinfo(i)->osfhnd)
545 #define _osfile(i)  (_pioinfo(i)->osfile)
546 #define _pipech(i)  (_pioinfo(i)->pipech)
547
548 /* since we are not doing a dup2(), this works fine */
549 #define _set_osfhnd(fh, osfh) (void)(_osfhnd(fh) = (intptr_t)osfh)
550 #endif
551 #endif
552
553 /* IO.xs and POSIX.xs define PERLIO_NOT_STDIO to 1 */
554 #if defined(PERL_EXT_IO) || defined(PERL_EXT_POSIX)
555 #undef  PERLIO_NOT_STDIO
556 #endif
557 #define PERLIO_NOT_STDIO 0
558
559 #include "perlio.h"
560
561 /*
562  * This provides a layer of functions and macros to ensure extensions will
563  * get to use the same RTL functions as the core.
564  */
565 #include "win32iop.h"
566
567 #define EXEC_ARGV_CAST(x) ((const char *const *) x)
568
569 #if !defined(ECONNABORTED) && defined(WSAECONNABORTED)
570 #define ECONNABORTED WSAECONNABORTED
571 #endif
572 #if !defined(ECONNRESET) && defined(WSAECONNRESET)
573 #define ECONNRESET WSAECONNRESET
574 #endif
575 #if !defined(EAFNOSUPPORT) && defined(WSAEAFNOSUPPORT)
576 #define EAFNOSUPPORT WSAEAFNOSUPPORT
577 #endif
578 /* Why not needed for ECONNREFUSED? --abe */
579
580 DllExport void *win32_signal_context(void);
581 #define PERL_GET_SIG_CONTEXT win32_signal_context()
582
583 #ifdef UNDER_CE
584 #define Win_GetModuleHandle   XCEGetModuleHandleA
585 #define Win_GetProcAddress    XCEGetProcAddressA
586 #define Win_GetModuleFileName XCEGetModuleFileNameA
587 #define Win_CreateSemaphore   CreateSemaphoreW
588 #else
589 #define Win_GetModuleHandle   GetModuleHandle
590 #define Win_GetProcAddress    GetProcAddress
591 #define Win_GetModuleFileName GetModuleFileName
592 #define Win_CreateSemaphore   CreateSemaphore
593 #endif
594
595 #endif /* _INC_WIN32_PERL5 */
596