b9fbaf4aa8fa0f6d2f3eeae49507519f3af48907
[p5sagit/p5-mst-13.2.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_OBJECT) || defined(PERL_IMPLICIT_SYS) || defined(PERL_CAPI)
17 #  define DYNAMIC_ENV_FETCH
18 #  define ENV_HV_NAME "___ENV_HV_NAME___"
19 #  define HAS_GETENV_LEN
20 #  define prime_env_iter()
21 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
22 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
23 #  ifdef PERL_GLOBAL_STRUCT
24 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_IMPLICIT_SYS
25 #  endif
26 #  define win32_get_privlib PerlEnv_lib_path
27 #  define win32_get_sitelib PerlEnv_sitelib_path
28 #endif
29
30 #if defined(PERL_IMPLICIT_CONTEXT)
31 #  define PERL_GET_INTERP       ((PerlInterpreter*)GetPerlInterpreter())
32 #  define PERL_SET_INTERP(i)    (SetPerlInterpreter(i))
33 #endif
34
35 #ifdef __GNUC__
36 #  ifndef __int64               /* some versions seem to #define it already */
37 #    define __int64 long long
38 #  endif
39 #  define Win32_Winsock
40 #endif
41
42 /* Define DllExport akin to perl's EXT, 
43  * If we are in the DLL or mimicing the DLL for Win95 work round
44  * then Export the symbol, 
45  * otherwise import it.
46  */
47
48 /* now even GCC supports __declspec() */
49
50 #if defined(PERL_OBJECT)
51 #define DllExport
52 #else
53 #if defined(PERLDLL) || defined(WIN95FIX)
54 #define DllExport
55 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
56 #else 
57 #define DllExport __declspec(dllimport)
58 #endif
59 #endif
60
61 #define  WIN32_LEAN_AND_MEAN
62 #include <windows.h>
63
64 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
65 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
66 #endif /*WIN32_LEAN_AND_MEAN */
67
68 #ifndef TLS_OUT_OF_INDEXES
69 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
70 #endif
71
72 #include <dirent.h>
73 #include <io.h>
74 #include <process.h>
75 #include <stdio.h>
76 #include <direct.h>
77 #include <stdlib.h>
78 #ifndef EXT
79 #include "EXTERN.h"
80 #endif
81
82 struct tms {
83         long    tms_utime;
84         long    tms_stime;
85         long    tms_cutime;
86         long    tms_cstime;
87 };
88
89 #ifndef SYS_NMLN
90 #define SYS_NMLN        257
91 #endif
92
93 struct utsname {
94     char sysname[SYS_NMLN];
95     char nodename[SYS_NMLN];
96     char release[SYS_NMLN];
97     char version[SYS_NMLN];
98     char machine[SYS_NMLN];
99 };
100
101 #ifndef START_EXTERN_C
102 #undef EXTERN_C
103 #ifdef __cplusplus
104 #  define START_EXTERN_C extern "C" {
105 #  define END_EXTERN_C }
106 #  define EXTERN_C extern "C"
107 #else
108 #  define START_EXTERN_C 
109 #  define END_EXTERN_C 
110 #  define EXTERN_C
111 #endif
112 #endif
113
114 #define  STANDARD_C     1
115 #define  DOSISH         1               /* no escaping our roots */
116 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
117
118 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
119  * real filehandles. XXX Should always be defined (the other version is untested) */
120 #define USE_SOCKETS_AS_HANDLES
121
122 /* read() and write() aren't transparent for socket handles */
123 #define PERL_SOCK_SYSREAD_IS_RECV
124 #define PERL_SOCK_SYSWRITE_IS_SEND
125
126
127 /* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
128  * to read the environment, bypassing the runtime's (usually broken)
129  * facilities for accessing the same.  See note in util.c/my_setenv(). */
130 /*#define USE_WIN32_RTL_ENV */
131
132 /* Define USE_FIXED_OSFHANDLE to fix VC's _open_osfhandle() on W95.
133  * Can only enable it if not using the DLL CRT (it doesn't expose internals) */
134 #if defined(_MSC_VER) && !defined(_DLL) && defined(_M_IX86)
135 #define USE_FIXED_OSFHANDLE
136 #endif
137
138 #define ENV_IS_CASELESS
139
140 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
141 #define VER_PLATFORM_WIN32_WINDOWS      1
142 #endif
143
144 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
145 #define FILE_SHARE_DELETE               0x00000004
146 #endif
147
148 /* access() mode bits */
149 #ifndef R_OK
150 #  define       R_OK    4
151 #  define       W_OK    2
152 #  define       X_OK    1
153 #  define       F_OK    0
154 #endif
155
156 /* Compiler-specific stuff. */
157
158 #ifdef __BORLANDC__             /* Borland C++ */
159
160 #define _access access
161 #define _chdir chdir
162 #define _getpid getpid
163 #include <sys/types.h>
164
165 #ifndef DllMain
166 #define DllMain DllEntryPoint
167 #endif
168
169 #pragma warn -ccc       /* "condition is always true/false" */
170 #pragma warn -rch       /* "unreachable code" */
171 #pragma warn -sig       /* "conversion may lose significant digits" */
172 #pragma warn -pia       /* "possibly incorrect assignment" */
173 #pragma warn -par       /* "parameter 'foo' is never used" */
174 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
175 #pragma warn -use       /* "'foo' is declared but never used" */
176 #pragma warn -csu       /* "comparing signed and unsigned values" */
177 #pragma warn -pro       /* "call to function with no prototype" */
178 #pragma warn -stu       /* "undefined structure 'foo'" */
179
180 /* Borland is picky about a bare member function name used as its ptr */
181 #ifdef PERL_OBJECT
182 #  define MEMBER_TO_FPTR(name)  &(name)
183 #endif
184
185 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
186 #define PERL_MEMBER_PTR_SIZE    12
187
188 #endif
189
190 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
191
192 typedef long            uid_t;
193 typedef long            gid_t;
194 typedef unsigned short  mode_t;
195 #pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
196
197 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
198 #define PERL_MEMBER_PTR_SIZE    16
199
200 #endif /* _MSC_VER */
201
202 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
203
204 typedef long            uid_t;
205 typedef long            gid_t;
206 #ifndef _environ
207 #define _environ        environ
208 #endif
209 #define flushall        _flushall
210 #define fcloseall       _fcloseall
211
212 #ifndef CP_UTF8
213 #  define CP_UTF8       65001
214 #endif
215
216 #ifdef PERL_OBJECT
217 #  define MEMBER_TO_FPTR(name)  &(name)
218 #endif
219
220 #ifndef _O_NOINHERIT
221 #  define _O_NOINHERIT  0x0080
222 #  ifndef _NO_OLDNAMES
223 #    define O_NOINHERIT _O_NOINHERIT
224 #  endif
225 #endif
226
227 #endif /* __MINGW32__ */
228
229 /* compatibility stuff for other compilers goes here */
230
231
232 #if !defined(PERL_OBJECT) && defined(PERL_MEMBER_PTR_SIZE)
233 #  define STRUCT_MGVTBL_DEFINITION \
234 struct mgvtbl {                                                         \
235     union {                                                             \
236         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
237         char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
238     };                                                                  \
239     union {                                                             \
240         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
241         char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
242     };                                                                  \
243     union {                                                             \
244         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
245         char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
246     };                                                                  \
247     union {                                                             \
248         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
249         char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
250     };                                                                  \
251     union {                                                             \
252         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
253         char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
254     };                                                                  \
255 }
256
257 #  define BASEOP_DEFINITION \
258     OP*         op_next;                                                \
259     OP*         op_sibling;                                             \
260     OP*         (CPERLscope(*op_ppaddr))(pTHX);                         \
261     char        handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
262     PADOFFSET   op_targ;                                                \
263     OPCODE      op_type;                                                \
264     U16         op_seq;                                                 \
265     U8          op_flags;                                               \
266     U8          op_private;
267
268 #endif /* !PERL_OBJECT && PERL_MEMBER_PTR_SIZE */
269
270
271 START_EXTERN_C
272
273 /* For UNIX compatibility. */
274
275 extern  uid_t   getuid(void);
276 extern  gid_t   getgid(void);
277 extern  uid_t   geteuid(void);
278 extern  gid_t   getegid(void);
279 extern  int     setuid(uid_t uid);
280 extern  int     setgid(gid_t gid);
281 extern  int     kill(int pid, int sig);
282 extern  void    *sbrk(int need);
283 extern  char *  getlogin(void);
284 extern  int     chown(const char *p, uid_t o, gid_t g);
285
286 #undef   Stat
287 #define  Stat           win32_stat
288
289 #undef   init_os_extras
290 #define  init_os_extras Perl_init_os_extras
291
292 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
293 DllExport void          Perl_init_os_extras();
294 DllExport void          win32_str_os_error(void *sv, DWORD err);
295 DllExport int           RunPerl(int argc, char **argv, char **env);
296 DllExport bool          SetPerlInterpreter(void* interp);
297 DllExport void*         GetPerlInterpreter(void);
298
299 #ifndef USE_SOCKETS_AS_HANDLES
300 extern FILE *           my_fdopen(int, char *);
301 #endif
302 extern int              my_fclose(FILE *);
303 extern int              do_aspawn(void *really, void **mark, void **sp);
304 extern int              do_spawn(char *cmd);
305 extern int              do_spawn_nowait(char *cmd);
306 extern char *           win32_get_privlib(char *pl);
307 extern char *           win32_get_sitelib(char *pl);
308 extern int              IsWin95(void);
309 extern int              IsWinNT(void);
310
311 extern char *           staticlinkmodules[];
312
313 END_EXTERN_C
314
315 typedef  char *         caddr_t;        /* In malloc.c (core address). */
316
317 /*
318  * handle socket stuff, assuming socket is always available
319  */
320 #include <sys/socket.h>
321 #include <netdb.h>
322
323 #ifdef MYMALLOC
324 #define EMBEDMYMALLOC   /**/
325 /* #define USE_PERL_SBRK        /**/
326 /* #define PERL_SBRK_VIA_MALLOC /**/
327 #endif
328
329 #if defined(PERLDLL) && !defined(PERL_CORE)
330 #define PERL_CORE
331 #endif
332
333 #ifdef USE_TEXTMODE_SCRIPTS
334 #  define PERL_SCRIPT_MODE              "r"
335 #else
336 #  define PERL_SCRIPT_MODE              "rb"
337 #endif
338
339 /* 
340  * Now Win32 specific per-thread data stuff 
341  */
342
343 struct thread_intern {
344     /* XXX can probably use one buffer instead of several */
345     char                Wstrerror_buffer[512];
346     struct servent      Wservent;
347     char                Wgetlogin_buffer[128];
348 #    ifdef USE_SOCKETS_AS_HANDLES
349     int                 Winit_socktype;
350 #    endif
351 #    ifdef HAVE_DES_FCRYPT
352     char                Wcrypt_buffer[30];
353 #    endif
354 #    ifdef USE_RTL_THREAD_API
355     void *              retv;   /* slot for thread return value */
356 #    endif
357 };
358
359 #ifdef USE_THREADS
360 #  ifndef USE_DECLSPEC_THREAD
361 #    define HAVE_THREAD_INTERN
362 #  endif /* !USE_DECLSPEC_THREAD */
363 #endif /* USE_THREADS */
364
365 #define HAVE_INTERP_INTERN
366 typedef struct {
367     long        num;
368     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
369     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
370 } child_tab;
371
372 struct interp_intern {
373     char *      perlshell_tokens;
374     char **     perlshell_vec;
375     long        perlshell_items;
376     struct av * fdpid;
377     child_tab * children;
378 #ifdef USE_ITHREADS
379     DWORD       pseudo_id;
380     child_tab * pseudo_children;
381 #endif
382     void *      internal_host;
383 #ifndef USE_THREADS
384     struct thread_intern        thr_intern;
385 #endif
386 };
387
388
389 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
390 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
391 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
392 #define w32_fdpid               (PL_sys_intern.fdpid)
393 #define w32_children            (PL_sys_intern.children)
394 #define w32_num_children        (w32_children->num)
395 #define w32_child_pids          (w32_children->pids)
396 #define w32_child_handles       (w32_children->handles)
397 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
398 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
399 #define w32_num_pseudo_children         (w32_pseudo_children->num)
400 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
401 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
402 #define w32_internal_host               (PL_sys_intern.internal_host)
403 #ifdef USE_THREADS
404 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
405 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
406 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
407 #  define w32_servent           (thr->i.Wservent)
408 #  define w32_init_socktype     (thr->i.Winit_socktype)
409 #else
410 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
411 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
412 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
413 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
414 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
415 #endif /* USE_THREADS */
416
417 /* UNICODE<>ANSI translation helpers */
418 /* Use CP_ACP when mode is ANSI */
419 /* Use CP_UTF8 when mode is UTF8 */
420
421 #define A2WHELPER(lpa, lpw, nBytes)\
422     lpw[0] = 0, MultiByteToWideChar((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpa, -1, lpw, (nBytes/sizeof(WCHAR)))
423
424 #define W2AHELPER(lpw, lpa, nChars)\
425     lpa[0] = '\0', WideCharToMultiByte((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpw, -1, (LPSTR)lpa, nChars, NULL, NULL)
426
427 #define USING_WIDE()    (PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
428
429 #ifdef USE_ITHREADS
430 #  define PERL_WAIT_FOR_CHILDREN \
431     STMT_START {                                                        \
432         if (w32_pseudo_children && w32_num_pseudo_children) {           \
433             long children = w32_num_pseudo_children;                    \
434             WaitForMultipleObjects(children,                            \
435                                    w32_pseudo_child_handles,            \
436                                    TRUE, INFINITE);                     \
437             while (children)                                            \
438                 CloseHandle(w32_pseudo_child_handles[--children]);      \
439         }                                                               \
440     } STMT_END
441 #endif
442
443 /*
444  * This provides a layer of functions and macros to ensure extensions will
445  * get to use the same RTL functions as the core.
446  */
447 #include "win32iop.h"
448
449 #endif /* _INC_WIN32_PERL5 */
450