24ba7c6784a8963780b9de9a7d56d35da089006f
[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 #endif
186
187 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
188
189 typedef long            uid_t;
190 typedef long            gid_t;
191 typedef unsigned short  mode_t;
192 #pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
193
194 #ifndef PERL_OBJECT
195
196 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
197 #define STRUCT_MGVTBL_DEFINITION                                        \
198 struct mgvtbl {                                                         \
199     union {                                                             \
200         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
201         char        handle_VC_problem1[16];                             \
202     };                                                                  \
203     union {                                                             \
204         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
205         char        handle_VC_problem2[16];                             \
206     };                                                                  \
207     union {                                                             \
208         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
209         char        handle_VC_problem3[16];                             \
210     };                                                                  \
211     union {                                                             \
212         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
213         char        handle_VC_problem4[16];                             \
214     };                                                                  \
215     union {                                                             \
216         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
217         char        handle_VC_problem5[16];                             \
218     };                                                                  \
219 }
220
221 #define BASEOP_DEFINITION               \
222     OP*         op_next;                \
223     OP*         op_sibling;             \
224     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
225     char        handle_VC_problem[12];  \
226     PADOFFSET   op_targ;                \
227     OPCODE      op_type;                \
228     U16         op_seq;                 \
229     U8          op_flags;               \
230     U8          op_private;
231
232 #endif /* PERL_OBJECT */
233
234 #endif /* _MSC_VER */
235
236 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
237
238 typedef long            uid_t;
239 typedef long            gid_t;
240 #ifndef _environ
241 #define _environ        environ
242 #endif
243 #define flushall        _flushall
244 #define fcloseall       _fcloseall
245
246 #ifndef CP_UTF8
247 #  define CP_UTF8       65001
248 #endif
249
250 #ifdef PERL_OBJECT
251 #  define MEMBER_TO_FPTR(name)  &(name)
252 #endif
253
254 #ifndef _O_NOINHERIT
255 #  define _O_NOINHERIT  0x0080
256 #  ifndef _NO_OLDNAMES
257 #    define O_NOINHERIT _O_NOINHERIT
258 #  endif
259 #endif
260
261 #endif /* __MINGW32__ */
262
263 /* compatibility stuff for other compilers goes here */
264
265
266 START_EXTERN_C
267
268 /* For UNIX compatibility. */
269
270 extern  uid_t   getuid(void);
271 extern  gid_t   getgid(void);
272 extern  uid_t   geteuid(void);
273 extern  gid_t   getegid(void);
274 extern  int     setuid(uid_t uid);
275 extern  int     setgid(gid_t gid);
276 extern  int     kill(int pid, int sig);
277 extern  void    *sbrk(int need);
278 extern  char *  getlogin(void);
279 extern  int     chown(const char *p, uid_t o, gid_t g);
280
281 #undef   Stat
282 #define  Stat           win32_stat
283
284 #undef   init_os_extras
285 #define  init_os_extras Perl_init_os_extras
286
287 DllExport void          Perl_win32_init(int *argcp, char ***argvp);
288 DllExport void          Perl_init_os_extras();
289 DllExport void          win32_str_os_error(void *sv, DWORD err);
290 DllExport int           RunPerl(int argc, char **argv, char **env);
291 DllExport bool          SetPerlInterpreter(void* interp);
292 DllExport void*         GetPerlInterpreter(void);
293
294 #ifndef USE_SOCKETS_AS_HANDLES
295 extern FILE *           my_fdopen(int, char *);
296 #endif
297 extern int              my_fclose(FILE *);
298 extern int              do_aspawn(void *really, void **mark, void **sp);
299 extern int              do_spawn(char *cmd);
300 extern int              do_spawn_nowait(char *cmd);
301 extern char *           win32_get_privlib(char *pl);
302 extern char *           win32_get_sitelib(char *pl);
303 extern int              IsWin95(void);
304 extern int              IsWinNT(void);
305
306 extern char *           staticlinkmodules[];
307
308 END_EXTERN_C
309
310 typedef  char *         caddr_t;        /* In malloc.c (core address). */
311
312 /*
313  * handle socket stuff, assuming socket is always available
314  */
315 #include <sys/socket.h>
316 #include <netdb.h>
317
318 #ifdef MYMALLOC
319 #define EMBEDMYMALLOC   /**/
320 /* #define USE_PERL_SBRK        /**/
321 /* #define PERL_SBRK_VIA_MALLOC /**/
322 #endif
323
324 #if defined(PERLDLL) && !defined(PERL_CORE)
325 #define PERL_CORE
326 #endif
327
328 #ifdef USE_TEXTMODE_SCRIPTS
329 #  define PERL_SCRIPT_MODE              "r"
330 #else
331 #  define PERL_SCRIPT_MODE              "rb"
332 #endif
333
334 /* 
335  * Now Win32 specific per-thread data stuff 
336  */
337
338 struct thread_intern {
339     /* XXX can probably use one buffer instead of several */
340     char                Wstrerror_buffer[512];
341     struct servent      Wservent;
342     char                Wgetlogin_buffer[128];
343 #    ifdef USE_SOCKETS_AS_HANDLES
344     int                 Winit_socktype;
345 #    endif
346 #    ifdef HAVE_DES_FCRYPT
347     char                Wcrypt_buffer[30];
348 #    endif
349 #    ifdef USE_RTL_THREAD_API
350     void *              retv;   /* slot for thread return value */
351 #    endif
352 };
353
354 #ifdef USE_THREADS
355 #  ifndef USE_DECLSPEC_THREAD
356 #    define HAVE_THREAD_INTERN
357 #  endif /* !USE_DECLSPEC_THREAD */
358 #endif /* USE_THREADS */
359
360 #define HAVE_INTERP_INTERN
361 typedef struct {
362     long        num;
363     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
364     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
365 } child_tab;
366
367 struct interp_intern {
368     char *      perlshell_tokens;
369     char **     perlshell_vec;
370     long        perlshell_items;
371     struct av * fdpid;
372     child_tab * children;
373 #ifdef USE_ITHREADS
374     DWORD       pseudo_id;
375     child_tab * pseudo_children;
376 #endif
377     void *      internal_host;
378 #ifndef USE_THREADS
379     struct thread_intern        thr_intern;
380 #endif
381 };
382
383
384 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
385 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
386 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
387 #define w32_fdpid               (PL_sys_intern.fdpid)
388 #define w32_children            (PL_sys_intern.children)
389 #define w32_num_children        (w32_children->num)
390 #define w32_child_pids          (w32_children->pids)
391 #define w32_child_handles       (w32_children->handles)
392 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
393 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
394 #define w32_num_pseudo_children         (w32_pseudo_children->num)
395 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
396 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
397 #define w32_internal_host               (PL_sys_intern.internal_host)
398 #ifdef USE_THREADS
399 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
400 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
401 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
402 #  define w32_servent           (thr->i.Wservent)
403 #  define w32_init_socktype     (thr->i.Winit_socktype)
404 #else
405 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
406 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
407 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
408 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
409 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
410 #endif /* USE_THREADS */
411
412 /* UNICODE<>ANSI translation helpers */
413 /* Use CP_ACP when mode is ANSI */
414 /* Use CP_UTF8 when mode is UTF8 */
415
416 #define A2WHELPER(lpa, lpw, nBytes)\
417     lpw[0] = 0, MultiByteToWideChar((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpa, -1, lpw, (nBytes/sizeof(WCHAR)))
418
419 #define W2AHELPER(lpw, lpa, nChars)\
420     lpa[0] = '\0', WideCharToMultiByte((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpw, -1, (LPSTR)lpa, nChars, NULL, NULL)
421
422 #define USING_WIDE()    (PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
423
424 #ifdef USE_ITHREADS
425 #  define PERL_WAIT_FOR_CHILDREN \
426     STMT_START {                                                        \
427         if (w32_pseudo_children && w32_num_pseudo_children) {           \
428             long children = w32_num_pseudo_children;                    \
429             WaitForMultipleObjects(children,                            \
430                                    w32_pseudo_child_handles,            \
431                                    TRUE, INFINITE);                     \
432             while (children)                                            \
433                 CloseHandle(w32_pseudo_child_handles[--children]);      \
434         }                                                               \
435     } STMT_END
436 #endif
437
438 /*
439  * This provides a layer of functions and macros to ensure extensions will
440  * get to use the same RTL functions as the core.
441  */
442 #include "win32iop.h"
443
444 #endif /* _INC_WIN32_PERL5 */
445