This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
vendorlib support for Windows; regen win32/config*
[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 #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 #  define win32_get_vendorlib PerlEnv_vendorlib_path
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 #endif
37
38 /* Define DllExport akin to perl's EXT, 
39  * If we are in the DLL or mimicing the DLL for Win95 work round
40  * then Export the symbol, 
41  * otherwise import it.
42  */
43
44 /* now even GCC supports __declspec() */
45
46 #if defined(PERL_OBJECT)
47 #define DllExport
48 #else
49 #if defined(PERLDLL) || defined(WIN95FIX)
50 #define DllExport
51 /*#define DllExport __declspec(dllexport)*/     /* noises with VC5+sp3 */
52 #else 
53 #define DllExport __declspec(dllimport)
54 #endif
55 #endif
56
57 #define  WIN32_LEAN_AND_MEAN
58 #include <windows.h>
59
60 #ifdef   WIN32_LEAN_AND_MEAN            /* C file is NOT a Perl5 original. */
61 #define  CONTEXT        PERL_CONTEXT    /* Avoid conflict of CONTEXT defs. */
62 #endif /*WIN32_LEAN_AND_MEAN */
63
64 #ifndef TLS_OUT_OF_INDEXES
65 #define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
66 #endif
67
68 #include <dirent.h>
69 #include <io.h>
70 #include <process.h>
71 #include <stdio.h>
72 #include <direct.h>
73 #include <stdlib.h>
74 #include <fcntl.h>
75 #ifndef EXT
76 #include "EXTERN.h"
77 #endif
78
79 struct tms {
80         long    tms_utime;
81         long    tms_stime;
82         long    tms_cutime;
83         long    tms_cstime;
84 };
85
86 #ifndef SYS_NMLN
87 #define SYS_NMLN        257
88 #endif
89
90 struct utsname {
91     char sysname[SYS_NMLN];
92     char nodename[SYS_NMLN];
93     char release[SYS_NMLN];
94     char version[SYS_NMLN];
95     char machine[SYS_NMLN];
96 };
97
98 #ifndef START_EXTERN_C
99 #undef EXTERN_C
100 #ifdef __cplusplus
101 #  define START_EXTERN_C extern "C" {
102 #  define END_EXTERN_C }
103 #  define EXTERN_C extern "C"
104 #else
105 #  define START_EXTERN_C 
106 #  define END_EXTERN_C 
107 #  define EXTERN_C
108 #endif
109 #endif
110
111 #define  STANDARD_C     1
112 #define  DOSISH         1               /* no escaping our roots */
113 #define  OP_BINARY      O_BINARY        /* mistake in in pp_sys.c? */
114
115 /* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
116  * real filehandles. XXX Should always be defined (the other version is untested) */
117 #define USE_SOCKETS_AS_HANDLES
118
119 /* read() and write() aren't transparent for socket handles */
120 #define PERL_SOCK_SYSREAD_IS_RECV
121 #define PERL_SOCK_SYSWRITE_IS_SEND
122
123 #define PERL_NO_FORCE_LINK              /* no need for PL_force_link_funcs */
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 MSVCRT's _open_osfhandle() on W95.
131    It now uses some black magic to work seamlessly with the DLL CRT and
132    works with MSVC++ 4.0+ or GCC/Mingw32
133         -- BKS 1-24-2000 */
134 #if (defined(_M_IX86) && _MSC_VER >= 1000) || defined(__MINGW32__)
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 #define PERL_GET_CONTEXT_DEFINED
157
158 /* Compiler-specific stuff. */
159
160 #ifdef __BORLANDC__             /* Borland C++ */
161
162 #define _access access
163 #define _chdir chdir
164 #define _getpid getpid
165 #define wcsicmp _wcsicmp
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 /* Borland C thinks that a pointer to a member variable is 12 bytes in size. */
189 #define PERL_MEMBER_PTR_SIZE    12
190
191 #endif
192
193 #ifdef _MSC_VER                 /* Microsoft Visual C++ */
194
195 typedef long            uid_t;
196 typedef long            gid_t;
197 typedef unsigned short  mode_t;
198 #pragma  warning(disable: 4018 4035 4101 4102 4244 4245 4761)
199
200 /* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
201 #define PERL_MEMBER_PTR_SIZE    16
202
203 #endif /* _MSC_VER */
204
205 #ifdef __MINGW32__              /* Minimal Gnu-Win32 */
206
207 typedef long            uid_t;
208 typedef long            gid_t;
209 #ifndef _environ
210 #define _environ        environ
211 #endif
212 #define flushall        _flushall
213 #define fcloseall       _fcloseall
214
215 #ifdef PERL_OBJECT
216 #  define MEMBER_TO_FPTR(name)  &(name)
217 #endif
218
219 #ifndef _O_NOINHERIT
220 #  define _O_NOINHERIT  0x0080
221 #  ifndef _NO_OLDNAMES
222 #    define O_NOINHERIT _O_NOINHERIT
223 #  endif
224 #endif
225
226 #endif /* __MINGW32__ */
227
228 /* both GCC/Mingw32 and MSVC++ 4.0 are missing this, so we put it here */
229 #ifndef CP_UTF8
230 #  define CP_UTF8       65001
231 #endif
232
233 /* compatibility stuff for other compilers goes here */
234
235
236 #if !defined(PERL_OBJECT) && defined(PERL_CAPI) && defined(PERL_MEMBER_PTR_SIZE)
237 #  define STRUCT_MGVTBL_DEFINITION \
238 struct mgvtbl {                                                         \
239     union {                                                             \
240         int         (CPERLscope(*svt_get))(pTHX_ SV *sv, MAGIC* mg);    \
241         char        handle_VC_problem1[PERL_MEMBER_PTR_SIZE];           \
242     };                                                                  \
243     union {                                                             \
244         int         (CPERLscope(*svt_set))(pTHX_ SV *sv, MAGIC* mg);    \
245         char        handle_VC_problem2[PERL_MEMBER_PTR_SIZE];           \
246     };                                                                  \
247     union {                                                             \
248         U32         (CPERLscope(*svt_len))(pTHX_ SV *sv, MAGIC* mg);    \
249         char        handle_VC_problem3[PERL_MEMBER_PTR_SIZE];           \
250     };                                                                  \
251     union {                                                             \
252         int         (CPERLscope(*svt_clear))(pTHX_ SV *sv, MAGIC* mg);  \
253         char        handle_VC_problem4[PERL_MEMBER_PTR_SIZE];           \
254     };                                                                  \
255     union {                                                             \
256         int         (CPERLscope(*svt_free))(pTHX_ SV *sv, MAGIC* mg);   \
257         char        handle_VC_problem5[PERL_MEMBER_PTR_SIZE];           \
258     };                                                                  \
259 }
260
261 #  define BASEOP_DEFINITION \
262     OP*         op_next;                                                \
263     OP*         op_sibling;                                             \
264     OP*         (CPERLscope(*op_ppaddr))(pTHX);                         \
265     char        handle_VC_problem[PERL_MEMBER_PTR_SIZE-sizeof(OP*)];    \
266     PADOFFSET   op_targ;                                                \
267     OPCODE      op_type;                                                \
268     U16         op_seq;                                                 \
269     U8          op_flags;                                               \
270     U8          op_private;
271
272 #endif /* !PERL_OBJECT && PERL_CAPI && PERL_MEMBER_PTR_SIZE */
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();
298 DllExport void          win32_str_os_error(void *sv, DWORD err);
299 DllExport int           RunPerl(int argc, char **argv, char **env);
300
301 typedef struct {
302     HANDLE      childStdIn;
303     HANDLE      childStdOut;
304     HANDLE      childStdErr;
305 } child_IO_table;
306
307 DllExport void          win32_get_child_IO(child_IO_table* ptr);
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(const char *pl);
317 extern char *           win32_get_sitelib(const char *pl);
318 extern char *           win32_get_vendorlib(const char *pl);
319 extern int              IsWin95(void);
320 extern int              IsWinNT(void);
321 extern void             win32_argv2utf8(int argc, char** argv);
322
323 extern char *           staticlinkmodules[];
324
325 END_EXTERN_C
326
327 typedef  char *         caddr_t;        /* In malloc.c (core address). */
328
329 /*
330  * handle socket stuff, assuming socket is always available
331  */
332 #include <sys/socket.h>
333 #include <netdb.h>
334
335 #ifdef MYMALLOC
336 #define EMBEDMYMALLOC   /**/
337 /* #define USE_PERL_SBRK        /**/
338 /* #define PERL_SBRK_VIA_MALLOC /**/
339 #endif
340
341 #if defined(PERLDLL) && !defined(PERL_CORE)
342 #define PERL_CORE
343 #endif
344
345 #ifdef PERL_TEXTMODE_SCRIPTS
346 #  define PERL_SCRIPT_MODE              "r"
347 #else
348 #  define PERL_SCRIPT_MODE              "rb"
349 #endif
350
351 /* 
352  * Now Win32 specific per-thread data stuff 
353  */
354
355 struct thread_intern {
356     /* XXX can probably use one buffer instead of several */
357     char                Wstrerror_buffer[512];
358     struct servent      Wservent;
359     char                Wgetlogin_buffer[128];
360 #    ifdef USE_SOCKETS_AS_HANDLES
361     int                 Winit_socktype;
362 #    endif
363 #    ifdef HAVE_DES_FCRYPT
364     char                Wcrypt_buffer[30];
365 #    endif
366 #    ifdef USE_RTL_THREAD_API
367     void *              retv;   /* slot for thread return value */
368 #    endif
369 };
370
371 #ifdef USE_THREADS
372 #  ifndef USE_DECLSPEC_THREAD
373 #    define HAVE_THREAD_INTERN
374 #  endif /* !USE_DECLSPEC_THREAD */
375 #endif /* USE_THREADS */
376
377 #define HAVE_INTERP_INTERN
378 typedef struct {
379     long        num;
380     DWORD       pids[MAXIMUM_WAIT_OBJECTS];
381     HANDLE      handles[MAXIMUM_WAIT_OBJECTS];
382 } child_tab;
383
384 struct interp_intern {
385     char *      perlshell_tokens;
386     char **     perlshell_vec;
387     long        perlshell_items;
388     struct av * fdpid;
389     child_tab * children;
390 #ifdef USE_ITHREADS
391     DWORD       pseudo_id;
392     child_tab * pseudo_children;
393 #endif
394     void *      internal_host;
395 #ifndef USE_THREADS
396     struct thread_intern        thr_intern;
397 #endif
398 };
399
400
401 #define w32_perlshell_tokens    (PL_sys_intern.perlshell_tokens)
402 #define w32_perlshell_vec       (PL_sys_intern.perlshell_vec)
403 #define w32_perlshell_items     (PL_sys_intern.perlshell_items)
404 #define w32_fdpid               (PL_sys_intern.fdpid)
405 #define w32_children            (PL_sys_intern.children)
406 #define w32_num_children        (w32_children->num)
407 #define w32_child_pids          (w32_children->pids)
408 #define w32_child_handles       (w32_children->handles)
409 #define w32_pseudo_id           (PL_sys_intern.pseudo_id)
410 #define w32_pseudo_children     (PL_sys_intern.pseudo_children)
411 #define w32_num_pseudo_children         (w32_pseudo_children->num)
412 #define w32_pseudo_child_pids           (w32_pseudo_children->pids)
413 #define w32_pseudo_child_handles        (w32_pseudo_children->handles)
414 #define w32_internal_host               (PL_sys_intern.internal_host)
415 #ifdef USE_THREADS
416 #  define w32_strerror_buffer   (thr->i.Wstrerror_buffer)
417 #  define w32_getlogin_buffer   (thr->i.Wgetlogin_buffer)
418 #  define w32_crypt_buffer      (thr->i.Wcrypt_buffer)
419 #  define w32_servent           (thr->i.Wservent)
420 #  define w32_init_socktype     (thr->i.Winit_socktype)
421 #else
422 #  define w32_strerror_buffer   (PL_sys_intern.thr_intern.Wstrerror_buffer)
423 #  define w32_getlogin_buffer   (PL_sys_intern.thr_intern.Wgetlogin_buffer)
424 #  define w32_crypt_buffer      (PL_sys_intern.thr_intern.Wcrypt_buffer)
425 #  define w32_servent           (PL_sys_intern.thr_intern.Wservent)
426 #  define w32_init_socktype     (PL_sys_intern.thr_intern.Winit_socktype)
427 #endif /* USE_THREADS */
428
429 /* UNICODE<>ANSI translation helpers */
430 /* Use CP_ACP when mode is ANSI */
431 /* Use CP_UTF8 when mode is UTF8 */
432
433 #define A2WHELPER_LEN(lpa, alen, lpw, nBytes)\
434     (lpw[0] = 0, MultiByteToWideChar((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
435                                     lpa, alen, lpw, (nBytes/sizeof(WCHAR))))
436 #define A2WHELPER(lpa, lpw, nBytes)     A2WHELPER_LEN(lpa, -1, lpw, nBytes)
437
438 #define W2AHELPER_LEN(lpw, wlen, lpa, nChars)\
439     (lpa[0] = '\0', WideCharToMultiByte((IN_BYTE) ? CP_ACP : CP_UTF8, 0, \
440                                        lpw, wlen, (LPSTR)lpa, nChars,NULL,NULL))
441 #define W2AHELPER(lpw, lpa, nChars)     W2AHELPER_LEN(lpw, -1, lpa, nChars)
442
443 #define USING_WIDE() (PL_widesyscalls && PerlEnv_os_id() == VER_PLATFORM_WIN32_NT)
444
445 #ifdef USE_ITHREADS
446 #  define PERL_WAIT_FOR_CHILDREN \
447     STMT_START {                                                        \
448         if (w32_pseudo_children && w32_num_pseudo_children) {           \
449             long children = w32_num_pseudo_children;                    \
450             WaitForMultipleObjects(children,                            \
451                                    w32_pseudo_child_handles,            \
452                                    TRUE, INFINITE);                     \
453             while (children)                                            \
454                 CloseHandle(w32_pseudo_child_handles[--children]);      \
455         }                                                               \
456     } STMT_END
457 #endif
458
459 /*
460  * This provides a layer of functions and macros to ensure extensions will
461  * get to use the same RTL functions as the core.
462  */
463 #include "win32iop.h"
464
465 #endif /* _INC_WIN32_PERL5 */
466