79926acb9d1ea504730cb1c014d6d5b03970f67d
[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 #if defined(PERL_OBJECT) || defined(PERL_CAPI)
13 #  define DYNAMIC_ENV_FETCH
14 #  define ENV_HV_NAME "___ENV_HV_NAME___"
15 #  define HAS_GETENV_LEN
16 #  define prime_env_iter()
17 #  define WIN32IO_IS_STDIO              /* don't pull in custom stdio layer */
18 #  define WIN32SCK_IS_STDSCK            /* don't pull in custom wsock layer */
19 #  ifdef PERL_GLOBAL_STRUCT
20 #    error PERL_GLOBAL_STRUCT cannot be defined with PERL_OBJECT
21 #  endif
22 #  define win32_get_privlib PerlEnv_lib_path
23 #  define win32_get_sitelib PerlEnv_sitelib_path
24 #endif
25
26 #if defined(PERL_IMPLICIT_CONTEXT)
27 #  define PERL_GET_INTERP       ((PerlInterpreter*)GetPerlInterpreter())
28 #  define PERL_SET_INTERP(i)    (SetPerlInterpreter(i))
29 #endif
30
31 #ifdef __GNUC__
32 typedef long long __int64;
33 #  define Win32_Winsock
34 /* GCC does not do __declspec() - render it a nop 
35  * and turn on options to avoid importing data 
36  */
37 #ifndef __declspec
38 #  define __declspec(x)
39 #endif
40 #  ifndef PERL_OBJECT
41 #    define PERL_GLOBAL_STRUCT
42 #    ifndef MULTIPLICITY
43 #      define MULTIPLICITY
44 #    endif
45 #  endif
46 #endif
47
48 /* Define DllExport akin to perl's EXT, 
49  * If we are in the DLL or mimicing the DLL for Win95 work round
50  * then Export the symbol, 
51  * otherwise import it.
52  */
53
54 #if defined(PERL_OBJECT)
55 #define DllExport
56 #else
57 #if defined(PERLDLL) || defined(WIN95FIX)
58 #define DllExport
59 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
60 #else 
61 #define DllExport __declspec(dllimport)
62 #endif
63 #endif
64
65 #define  WIN32_LEAN_AND_MEAN
66 #include <windows.h>
67
68 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
69 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
70 #endif /*WIN32_LEAN_AND_MEAN */
71
72 #ifndef TLS_OUT_OF_INDEXES
73 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
74 #endif
75
76 #include <dirent.h>
77 #include <io.h>
78 #include <process.h>
79 #include <stdio.h>
80 #include <direct.h>
81 #include <stdlib.h>
82 #ifndef EXT
83 #include "EXTERN.h"
84 #endif
85
86 struct tms {
87         long    tms_utime;
88         long    tms_stime;
89         long    tms_cutime;
90         long    tms_cstime;
91 };
92
93 #ifndef SYS_NMLN
94 #define SYS_NMLN        257
95 #endif
96
97 struct utsname {
98     char sysname[SYS_NMLN];
99     char nodename[SYS_NMLN];
100     char release[SYS_NMLN];
101     char version[SYS_NMLN];
102     char machine[SYS_NMLN];
103 };
104
105 #ifndef START_EXTERN_C
106 #undef EXTERN_C
107 #ifdef __cplusplus
108 #  define START_EXTERN_C extern "C" {
109 #  define END_EXTERN_C }
110 #  define EXTERN_C extern "C"
111 #else
112 #  define START_EXTERN_C 
113 #  define END_EXTERN_C 
114 #  define EXTERN_C
115 #endif
116 #endif
117
118 #define  STANDARD_C     1
119 #define  DOSISH         1               /* no escaping our roots */
120 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
121
122 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
123  * real filehandles. XXX Should always be defined (the other version is untested) */
124 #define USE_SOCKETS_AS_HANDLES
125
126 /* read() and write() aren't transparent for socket handles */
127 #define PERL_SOCK_SYSREAD_IS_RECV
128 #define PERL_SOCK_SYSWRITE_IS_SEND
129
130
131 /* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
132  * to read the environment, bypassing the runtime's (usually broken)
133  * facilities for accessing the same.  See note in util.c/my_setenv(). */
134 /*#define USE_WIN32_RTL_ENV */
135
136 /* Define USE_FIXED_OSFHANDLE to fix VC's _open_osfhandle() on W95.
137  * Can only enable it if not using the DLL CRT (it doesn't expose internals) */
138 #if defined(_MSC_VER) && !defined(_DLL) && defined(_M_IX86)
139 #define USE_FIXED_OSFHANDLE
140 #endif
141
142 #define ENV_IS_CASELESS
143
144 #ifndef VER_PLATFORM_WIN32_WINDOWS      /* VC-2.0 headers don't have this */
145 #define VER_PLATFORM_WIN32_WINDOWS      1
146 #endif
147
148 #ifndef FILE_SHARE_DELETE               /* VC-4.0 headers don't have this */
149 #define FILE_SHARE_DELETE               0x00000004
150 #endif
151
152 /* access() mode bits */
153 #ifndef R_OK
154 #  define       R_OK    4
155 #  define       W_OK    2
156 #  define       X_OK    1
157 #  define       F_OK    0
158 #endif
159
160 /* Compiler-specific stuff. */
161
162 #ifdef __BORLANDC__             /* Borland C++ */
163
164 #define _access access
165 #define _chdir chdir
166 #include <sys/types.h>
167
168 #ifndef DllMain
169 #define DllMain DllEntryPoint
170 #endif
171
172 #pragma warn -ccc       /* "condition is always true/false" */
173 #pragma warn -rch       /* "unreachable code" */
174 #pragma warn -sig       /* "conversion may lose significant digits" */
175 #pragma warn -pia       /* "possibly incorrect assignment" */
176 #pragma warn -par       /* "parameter 'foo' is never used" */
177 #pragma warn -aus       /* "'foo' is assigned a value that is never used" */
178 #pragma warn -use       /* "'foo' is declared but never used" */
179 #pragma warn -csu       /* "comparing signed and unsigned values" */
180 #pragma warn -pro       /* "call to function with no prototype" */
181 #pragma warn -stu       /* "undefined structure 'foo'" */
182
183 /* Borland is picky about a bare member function name used as its ptr */
184 #ifdef PERL_OBJECT
185 #  define MEMBER_TO_FPTR(name)  &(name)
186 #endif
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 #ifndef PERL_OBJECT
198
199 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
200 #define STRUCT_MGVTBL_DEFINITION                                        \
201 struct mgvtbl {                                                         \
202     union {                                                             \
203         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
204         char        handle_VC_problem1[16];                             \
205     };                                                                  \
206     union {                                                             \
207         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
208         char        handle_VC_problem2[16];                             \
209     };                                                                  \
210     union {                                                             \
211         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
212         char        handle_VC_problem3[16];                             \
213     };                                                                  \
214     union {                                                             \
215         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
216         char        handle_VC_problem4[16];                             \
217     };                                                                  \
218     union {                                                             \
219         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
220         char        handle_VC_problem5[16];                             \
221     };                                                                  \
222 }
223
224 #define BASEOP_DEFINITION               \
225     OP*         op_next;                \
226     OP*         op_sibling;             \
227     OP*         (CPERLscope(*op_ppaddr))(pTHX);         \
228     char        handle_VC_problem[12];  \
229     PADOFFSET   op_targ;                \
230     OPCODE      op_type;                \
231     U16         op_seq;                 \
232     U8          op_flags;               \
233     U8          op_private;
234
235 #endif /* PERL_OBJECT */
236
237 #endif /* _MSC_VER */
238
239 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
240
241 typedef long            uid_t;
242 typedef long            gid_t;
243 #ifndef _environ
244 #define _environ        environ
245 #endif
246 #define flushall        _flushall
247 #define fcloseall       _fcloseall
248
249 #ifdef PERL_OBJECT
250 #  define MEMBER_TO_FPTR(name)  &(name)
251 #endif
252
253 #ifndef _O_NOINHERIT
254 #  define _O_NOINHERIT  0x0080
255 #  ifndef _NO_OLDNAMES
256 #    define O_NOINHERIT _O_NOINHERIT
257 #  endif
258 #endif
259
260 #ifndef _O_NOINHERIT
261 #  define _O_NOINHERIT  0x0080
262 #  ifndef _NO_OLDNAMES
263 #    define O_NOINHERIT _O_NOINHERIT
264 #  endif
265 #endif
266
267 #endif /* __MINGW32__ */
268
269 /* compatibility stuff for other compilers goes here */
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 USE_BINMODE_SCRIPTS
335 #define PERL_SCRIPT_MODE "rb"
336 EXT void win32_strip_return(struct sv *sv);
337 #else
338 #define PERL_SCRIPT_MODE "r"
339 #define win32_strip_return(sv) NOOP
340 #endif
341
342 #define HAVE_INTERP_INTERN
343 typedef struct {
344     long        num;
345     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
346 } child_tab;
347
348 struct host_link {
349     char *      nameId;
350     void *      host_data;
351     struct host_link *  next;
352 };
353
354 struct interp_intern {
355     char *      perlshell_tokens;
356     char **     perlshell_vec;
357     long        perlshell_items;
358     struct av * fdpid;
359     child_tab * children;
360     HANDLE      child_handles[MAXIMUM_WAIT_OBJECTS];
361     struct host_link *  hostlist;
362 };
363
364
365 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
366 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
367 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
368 #define w32_fdpid               (PL_sys_intern.fdpid)
369 #define w32_children            (PL_sys_intern.children)
370 #define w32_num_children        (w32_children->num)
371 #define w32_child_pids          (w32_children->pids)
372 #define w32_child_handles       (PL_sys_intern.child_handles)
373 #define w32_host_link           (PL_sys_intern.hostlist)
374
375 /* 
376  * Now Win32 specific per-thread data stuff 
377  */
378
379 #ifdef USE_THREADS
380 #  ifndef USE_DECLSPEC_THREAD
381 #    define HAVE_THREAD_INTERN
382
383 struct thread_intern {
384     /* XXX can probably use one buffer instead of several */
385     char                Wstrerror_buffer[512];
386     struct servent      Wservent;
387     char                Wgetlogin_buffer[128];
388     char                Ww32_perllib_root[MAX_PATH+1];
389 #    ifdef USE_SOCKETS_AS_HANDLES
390     int                 Winit_socktype;
391 #    endif
392 #    ifdef HAVE_DES_FCRYPT
393     char                Wcrypt_buffer[30];
394 #    endif
395 #    ifdef USE_RTL_THREAD_API
396     void *              retv;   /* slot for thread return value */
397 #    endif
398 };
399 #  endif /* !USE_DECLSPEC_THREAD */
400 #endif /* USE_THREADS */
401
402 /* UNICODE<>ANSI translation helpers */
403 /* Use CP_ACP when mode is ANSI */
404 /* Use CP_UTF8 when mode is UTF8 */
405
406 #define A2WHELPER(lpa, lpw, nBytes)\
407     lpw[0] = 0, MultiByteToWideChar((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpa, -1, lpw, (nBytes/sizeof(WCHAR)))
408
409 #define W2AHELPER(lpw, lpa, nChars)\
410     lpa[0] = '\0', WideCharToMultiByte((IN_UTF8) ? CP_UTF8 : CP_ACP, 0, lpw, -1, (LPSTR)lpa, nChars, NULL, NULL)
411
412 #define USING_WIDE()    (PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
413
414 /*
415  * This provides a layer of functions and macros to ensure extensions will
416  * get to use the same RTL functions as the core.
417  */
418 #include "win32iop.h"
419
420 #endif /* _INC_WIN32_PERL5 */
421