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