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