d447f2bb07d04ba91e6e52170c9d16d0377561d7
[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 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
127
128 /* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
129  * to read the environment, bypassing the runtime's (usually broken)
130  * facilities for accessing the same.  See note in util.c/my_setenv(). */
131 /*#define USE_WIN32_RTL_ENV */
132
133 /* Define USE_FIXED_OSFHANDLE to fix VC's _open_osfhandle() on W95.
134  * Can only enable it if not using the DLL CRT (it doesn't expose internals) */
135 #if defined(_MSC_VER) && !defined(_DLL) && defined(_M_IX86)
136 #define USE_FIXED_OSFHANDLE
137 #endif
138
139 #define ENV_IS_CASELESS
140
141 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
142 #define VER_PLATFORM_WIN32_WINDOWS      1
143 #endif
144
145 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
146 #define FILE_SHARE_DELETE               0x00000004
147 #endif
148
149 /* access() mode bits */
150 #ifndef R_OK
151 #  define       R_OK    4
152 #  define       W_OK    2
153 #  define       X_OK    1
154 #  define       F_OK    0
155 #endif
156
157 /* Compiler-specific stuff. */
158
159 #ifdef __BORLANDC__             /* Borland C++ */
160
161 #define _access access
162 #define _chdir chdir
163 #define _getpid getpid
164 #include <sys/types.h>
165
166 #ifndef DllMain
167 #define DllMain DllEntryPoint
168 #endif
169
170 #pragma warn -ccc       /* "condition is always true/false" */
171 #pragma warn -rch       /* "unreachable code" */
172 #pragma warn -sig       /* "conversion may lose significant digits" */
173 #pragma warn -pia       /* "possibly incorrect assignment" */
174 #pragma warn -par       /* "parameter 'foo' is never used" */
175 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
176 #pragma warn -use       /* "'foo' is declared but never used" */
177 #pragma warn -csu       /* "comparing signed and unsigned values" */
178 #pragma warn -pro       /* "call to function with no prototype" */
179 #pragma warn -stu       /* "undefined structure 'foo'" */
180
181 /* Borland is picky about a bare member function name used as its ptr */
182 #ifdef PERL_OBJECT
183 #  define MEMBER_TO_FPTR(name)  &(name)
184 #endif
185
186 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
187 #define PERL_MEMBER_PTR_SIZE    12
188
189 #endif
190
191 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
192
193 typedef long            uid_t;
194 typedef long            gid_t;
195 typedef unsigned short  mode_t;
196 #pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
197
198 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
199 #define PERL_MEMBER_PTR_SIZE    16
200
201 #endif /* _MSC_VER */
202
203 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
204
205 typedef long            uid_t;
206 typedef long            gid_t;
207 #ifndef _environ
208 #define _environ        environ
209 #endif
210 #define flushall        _flushall
211 #define fcloseall       _fcloseall
212
213 #ifndef CP_UTF8
214 #  define CP_UTF8       65001
215 #endif
216
217 #ifdef PERL_OBJECT
218 #  define MEMBER_TO_FPTR(name)  &(name)
219 #endif
220
221 #ifndef _O_NOINHERIT
222 #  define _O_NOINHERIT  0x0080
223 #  ifndef _NO_OLDNAMES
224 #    define O_NOINHERIT _O_NOINHERIT
225 #  endif
226 #endif
227
228 #endif /* __MINGW32__ */
229
230 /* compatibility stuff for other compilers goes here */
231
232
233 #if !defined(PERL_OBJECT) && defined(PERL_MEMBER_PTR_SIZE)
234 #  define STRUCT_MGVTBL_DEFINITION \
235 struct mgvtbl {                                                         \
236     union {                                                             \
237         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
238         char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
239     };                                                                  \
240     union {                                                             \
241         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
242         char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
243     };                                                                  \
244     union {                                                             \
245         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
246         char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
247     };                                                                  \
248     union {                                                             \
249         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
250         char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
251     };                                                                  \
252     union {                                                             \
253         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
254         char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
255     };                                                                  \
256 }
257
258 #  define BASEOP_DEFINITION \
259     OP*         op_next;                                                \
260     OP*         op_sibling;                                             \
261     OP*         (CPERLscope(*op_ppaddr))(pTHX);                         \
262     char        handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
263     PADOFFSET   op_targ;                                                \
264     OPCODE      op_type;                                                \
265     U16         op_seq;                                                 \
266     U8          op_flags;                                               \
267     U8          op_private;
268
269 #endif /* !PERL_OBJECT && PERL_MEMBER_PTR_SIZE */
270
271
272 START_EXTERN_C
273
274 /* For UNIX compatibility. */
275
276 extern  uid_t   getuid(void);
277 extern  gid_t   getgid(void);
278 extern  uid_t   geteuid(void);
279 extern  gid_t   getegid(void);
280 extern  int     setuid(uid_t uid);
281 extern  int     setgid(gid_t gid);
282 extern  int     kill(int pid, int sig);
283 extern  void    *sbrk(int need);
284 extern  char *  getlogin(void);
285 extern  int     chown(const char *p, uid_t o, gid_t g);
286
287 #undef   Stat
288 #define  Stat           win32_stat
289
290 #undef   init_os_extras
291 #define  init_os_extras Perl_init_os_extras
292
293 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
294 DllExport void          Perl_init_os_extras();
295 DllExport void          win32_str_os_error(void *sv, DWORD err);
296 DllExport int           RunPerl(int argc, char **argv, char **env);
297 DllExport bool          SetPerlInterpreter(void* interp);
298 DllExport void*         GetPerlInterpreter(void);
299
300 #ifndef USE_SOCKETS_AS_HANDLES
301 extern FILE *           my_fdopen(int, char *);
302 #endif
303 extern int              my_fclose(FILE *);
304 extern int              do_aspawn(void *really, void **mark, void **sp);
305 extern int              do_spawn(char *cmd);
306 extern int              do_spawn_nowait(char *cmd);
307 extern char *           win32_get_privlib(char *pl);
308 extern char *           win32_get_sitelib(char *pl);
309 extern int              IsWin95(void);
310 extern int              IsWinNT(void);
311
312 extern char *           staticlinkmodules[];
313
314 END_EXTERN_C
315
316 typedef  char *         caddr_t;        /* In malloc.c (core address). */
317
318 /*
319  * handle socket stuff, assuming socket is always available
320  */
321 #include <sys/socket.h>
322 #include <netdb.h>
323
324 #ifdef MYMALLOC
325 #define EMBEDMYMALLOC   /**/
326 /* #define USE_PERL_SBRK        /**/
327 /* #define PERL_SBRK_VIA_MALLOC /**/
328 #endif
329
330 #if defined(PERLDLL) && !defined(PERL_CORE)
331 #define PERL_CORE
332 #endif
333
334 #ifdef PERL_TEXTMODE_SCRIPTS
335 #  define PERL_SCRIPT_MODE              "r"
336 #else
337 #  define PERL_SCRIPT_MODE              "rb"
338 #endif
339
340 /* 
341  * Now Win32 specific per-thread data stuff 
342  */
343
344 struct thread_intern {
345     /* XXX can probably use one buffer instead of several */
346     char                Wstrerror_buffer[512];
347     struct servent      Wservent;
348     char                Wgetlogin_buffer[128];
349 #    ifdef USE_SOCKETS_AS_HANDLES
350     int                 Winit_socktype;
351 #    endif
352 #    ifdef HAVE_DES_FCRYPT
353     char                Wcrypt_buffer[30];
354 #    endif
355 #    ifdef USE_RTL_THREAD_API
356     void *              retv;   /* slot for thread return value */
357 #    endif
358 };
359
360 #ifdef USE_THREADS
361 #  ifndef USE_DECLSPEC_THREAD
362 #    define HAVE_THREAD_INTERN
363 #  endif /* !USE_DECLSPEC_THREAD */
364 #endif /* USE_THREADS */
365
366 #define HAVE_INTERP_INTERN
367 typedef struct {
368     long        num;
369     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
370     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
371 } child_tab;
372
373 struct interp_intern {
374     char *      perlshell_tokens;
375     char **     perlshell_vec;
376     long        perlshell_items;
377     struct av * fdpid;
378     child_tab * children;
379 #ifdef USE_ITHREADS
380     DWORD       pseudo_id;
381     child_tab * pseudo_children;
382 #endif
383     void *      internal_host;
384 #ifndef USE_THREADS
385     struct thread_intern        thr_intern;
386 #endif
387 };
388
389
390 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
391 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
392 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
393 #define w32_fdpid               (PL_sys_intern.fdpid)
394 #define w32_children            (PL_sys_intern.children)
395 #define w32_num_children        (w32_children->num)
396 #define w32_child_pids          (w32_children->pids)
397 #define w32_child_handles       (w32_children->handles)
398 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
399 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
400 #define w32_num_pseudo_children         (w32_pseudo_children->num)
401 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
402 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
403 #define w32_internal_host               (PL_sys_intern.internal_host)
404 #ifdef USE_THREADS
405 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
406 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
407 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
408 #  define w32_servent           (thr->i.Wservent)
409 #  define w32_init_socktype     (thr->i.Winit_socktype)
410 #else
411 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
412 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
413 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
414 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
415 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
416 #endif /* USE_THREADS */
417
418 /* UNICODE<>ANSI translation helpers */
419 /* Use CP_ACP when mode is ANSI */
420 /* Use CP_UTF8 when mode is UTF8 */
421
422 #define A2WHELPER(lpa, lpw, nBytes)\
423     lpw[0] = 0, MultiByteToWideChar((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpa, -1, lpw, (nBytes/sizeof(WCHAR)))
424
425 #define W2AHELPER(lpw, lpa, nChars)\
426     lpa[0] = '\0', WideCharToMultiByte((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpw, -1, (LPSTR)lpa, nChars, NULL, NULL)
427
428 #define USING_WIDE()    (PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
429
430 #ifdef USE_ITHREADS
431 #  define PERL_WAIT_FOR_CHILDREN \
432     STMT_START {                                                        \
433         if (w32_pseudo_children && w32_num_pseudo_children) {           \
434             long children = w32_num_pseudo_children;                    \
435             WaitForMultipleObjects(children,                            \
436                                    w32_pseudo_child_handles,            \
437                                    TRUE, INFINITE);                     \
438             while (children)                                            \
439                 CloseHandle(w32_pseudo_child_handles[--children]);      \
440         }                                                               \
441     } STMT_END
442 #endif
443
444 /*
445  * This provides a layer of functions and macros to ensure extensions will
446  * get to use the same RTL functions as the core.
447  */
448 #include "win32iop.h"
449
450 #endif /* _INC_WIN32_PERL5 */
451