This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta.pod changes for Win32::* functions
[perl5.git] / win32 / win32.h
CommitLineData
68dc0745
PP
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 */
0a753a76
PP
9#ifndef _INC_WIN32_PERL5
10#define _INC_WIN32_PERL5
11
9d8a25dc 12#ifdef PERL_OBJECT
e9ee4811
DL
13# define DYNAMIC_ENV_FETCH
14# define ENV_HV_NAME "___ENV_HV_NAME___"
15# define prime_env_iter()
ab39fa9d
GS
16# define WIN32IO_IS_STDIO /* don't pull in custom stdio layer */
17# ifdef PERL_GLOBAL_STRUCT
18# error PERL_GLOBAL_STRUCT cannot be defined with PERL_OBJECT
19# endif
e5a95ffb 20# define win32_get_privlib PerlEnv_lib_path
ab39fa9d 21# define win32_get_sitelib PerlEnv_sitelib_path
9d8a25dc
DL
22#endif
23
a835ef8a 24#ifdef __GNUC__
a835ef8a 25typedef long long __int64;
db15561c 26# define Win32_Winsock
22239a37
NIS
27/* GCC does not do __declspec() - render it a nop
28 * and turn on options to avoid importing data
29 */
b1d1613b 30#ifndef __declspec
db15561c 31# define __declspec(x)
b1d1613b 32#endif
db15561c
GS
33# ifndef PERL_OBJECT
34# define PERL_GLOBAL_STRUCT
b86a2fa7
GS
35# ifndef MULTIPLICITY
36# define MULTIPLICITY
37# endif
db15561c 38# endif
a835ef8a
NIS
39#endif
40
22239a37
NIS
41/* Define DllExport akin to perl's EXT,
42 * If we are in the DLL or mimicing the DLL for Win95 work round
43 * then Export the symbol,
44 * otherwise import it.
45 */
46
c69f6586
GS
47#if defined(PERL_OBJECT)
48#define DllExport
49#else
22239a37 50#if defined(PERLDLL) || defined(WIN95FIX)
852c2e52
GS
51#define DllExport
52/*#define DllExport __declspec(dllexport)*/ /* noises with VC5+sp3 */
22239a37
NIS
53#else
54#define DllExport __declspec(dllimport)
55#endif
c69f6586 56#endif
c69f112c 57
0a753a76
PP
58#define WIN32_LEAN_AND_MEAN
59#include <windows.h>
60
68dc0745
PP
61#ifdef WIN32_LEAN_AND_MEAN /* C file is NOT a Perl5 original. */
62#define CONTEXT PERL_CONTEXT /* Avoid conflict of CONTEXT defs. */
68dc0745 63#endif /*WIN32_LEAN_AND_MEAN */
0a753a76 64
eda5ff31
GS
65#ifndef TLS_OUT_OF_INDEXES
66#define TLS_OUT_OF_INDEXES (DWORD)0xFFFFFFFF
67#endif
68
0a753a76
PP
69#include <dirent.h>
70#include <io.h>
71#include <process.h>
72#include <stdio.h>
73#include <direct.h>
390b85e7
GS
74#include <stdlib.h>
75#ifndef EXT
76#include "EXTERN.h"
77#endif
78
c69f112c
NIS
79struct tms {
80 long tms_utime;
81 long tms_stime;
82 long tms_cutime;
83 long tms_cstime;
84};
85
390b85e7 86#ifndef START_EXTERN_C
b3e5c95e 87#undef EXTERN_C
390b85e7
GS
88#ifdef __cplusplus
89# define START_EXTERN_C extern "C" {
90# define END_EXTERN_C }
91# define EXTERN_C extern "C"
92#else
93# define START_EXTERN_C
94# define END_EXTERN_C
95# define EXTERN_C
96#endif
97#endif
98
99#define STANDARD_C 1
100#define DOSISH 1 /* no escaping our roots */
101#define OP_BINARY O_BINARY /* mistake in in pp_sys.c? */
0a753a76 102
f3986ebb
GS
103/* Define USE_SOCKETS_AS_HANDLES to enable emulation of windows sockets as
104 * real filehandles. XXX Should always be defined (the other version is untested) */
105#define USE_SOCKETS_AS_HANDLES
106
a7092146
GS
107/* read() and write() aren't transparent for socket handles */
108#define PERL_SOCK_SYSREAD_IS_RECV
109#define PERL_SOCK_SYSWRITE_IS_SEND
110
111
f3986ebb
GS
112/* if USE_WIN32_RTL_ENV is not defined, Perl uses direct Win32 calls
113 * to read the environment, bypassing the runtime's (usually broken)
114 * facilities for accessing the same. See note in util.c/my_setenv(). */
115/*#define USE_WIN32_RTL_ENV */
0a753a76 116
f3986ebb
GS
117/* Define USE_FIXED_OSFHANDLE to fix VC's _open_osfhandle() on W95.
118 * Can only enable it if not using the DLL CRT (it doesn't expose internals) */
119#if defined(_MSC_VER) && !defined(_DLL) && defined(_M_IX86)
120#define USE_FIXED_OSFHANDLE
121#endif
122
902173a3
GS
123#define ENV_IS_CASELESS
124
d41de25a 125#ifndef VER_PLATFORM_WIN32_WINDOWS /* VC-2.0 headers don't have this */
f3986ebb
GS
126#define VER_PLATFORM_WIN32_WINDOWS 1
127#endif
128
d41de25a
GS
129#ifndef FILE_SHARE_DELETE /* VC-4.0 headers don't have this */
130#define FILE_SHARE_DELETE 0x00000004
131#endif
132
327c3667
GS
133/* access() mode bits */
134#ifndef R_OK
135# define R_OK 4
136# define W_OK 2
137# define X_OK 1
138# define F_OK 0
139#endif
140
f3986ebb
GS
141/* Compiler-specific stuff. */
142
910dfcc8 143#ifdef __BORLANDC__ /* Borland C++ */
3e3baf6d
TB
144
145#define _access access
146#define _chdir chdir
147#include <sys/types.h>
148
84902520
TB
149#ifndef DllMain
150#define DllMain DllEntryPoint
151#endif
152
189b2af5
GS
153#pragma warn -ccc /* "condition is always true/false" */
154#pragma warn -rch /* "unreachable code" */
155#pragma warn -sig /* "conversion may lose significant digits" */
156#pragma warn -pia /* "possibly incorrect assignment" */
157#pragma warn -par /* "parameter 'foo' is never used" */
158#pragma warn -aus /* "'foo' is assigned a value that is never used" */
159#pragma warn -use /* "'foo' is declared but never used" */
160#pragma warn -csu /* "comparing signed and unsigned values" */
161#pragma warn -pro /* "call to function with no prototype" */
327c3667 162#pragma warn -stu /* "undefined structure 'foo'" */
3e3baf6d 163
ac4c12e7
GS
164/* Borland is picky about a bare member function name used as its ptr */
165#ifdef PERL_OBJECT
166#define FUNC_NAME_TO_PTR(name) &(name)
167#endif
168
910dfcc8 169#endif
3e3baf6d 170
f3986ebb
GS
171#ifdef _MSC_VER /* Microsoft Visual C++ */
172
0a753a76
PP
173typedef long uid_t;
174typedef long gid_t;
f3986ebb
GS
175#pragma warning(disable: 4018 4035 4101 4102 4244 4245 4761)
176
0f4eea8f
DL
177#ifndef PERL_OBJECT
178
179/* Visual C thinks that a pointer to a member variable is 16 bytes in size. */
180#define STRUCT_MGVTBL_DEFINITION \
181struct mgvtbl { \
182 union { \
183 int (CPERLscope(*svt_get)) _((SV *sv, MAGIC* mg)); \
184 char handle_VC_problem1[16]; \
185 }; \
186 union { \
187 int (CPERLscope(*svt_set)) _((SV *sv, MAGIC* mg)); \
188 char handle_VC_problem2[16]; \
189 }; \
190 union { \
191 U32 (CPERLscope(*svt_len)) _((SV *sv, MAGIC* mg)); \
192 char handle_VC_problem3[16]; \
193 }; \
194 union { \
195 int (CPERLscope(*svt_clear)) _((SV *sv, MAGIC* mg)); \
196 char handle_VC_problem4[16]; \
197 }; \
198 union { \
199 int (CPERLscope(*svt_free)) _((SV *sv, MAGIC* mg)); \
200 char handle_VC_problem5[16]; \
201 }; \
202}
203
204#define BASEOP_DEFINITION \
205 OP* op_next; \
206 OP* op_sibling; \
207 OP* (CPERLscope(*op_ppaddr))_((ARGSproto)); \
208 char handle_VC_problem[12]; \
209 PADOFFSET op_targ; \
210 OPCODE op_type; \
211 U16 op_seq; \
212 U8 op_flags; \
213 U8 op_private;
214
215#define UNION_ANY_DEFINITION union any { \
216 void* any_ptr; \
217 I32 any_i32; \
218 IV any_iv; \
219 long any_long; \
220 void (CPERLscope(*any_dptr)) _((void*)); \
221 char handle_VC_problem[16]; \
222}
223
224#endif /* PERL_OBJECT */
225
f3986ebb
GS
226#endif /* _MSC_VER */
227
910dfcc8
GS
228#ifdef __MINGW32__ /* Minimal Gnu-Win32 */
229
230typedef long uid_t;
231typedef long gid_t;
b1d1613b 232#ifndef _environ
3730b96e 233#define _environ environ
b1d1613b 234#endif
3730b96e
GS
235#define flushall _flushall
236#define fcloseall _fcloseall
910dfcc8 237
db15561c
GS
238#ifdef PERL_OBJECT
239#define FUNC_NAME_TO_PTR(name) &(name)
240#endif
241
ac4c12e7
GS
242#ifndef _O_NOINHERIT
243# define _O_NOINHERIT 0x0080
244# ifndef _NO_OLDNAMES
245# define O_NOINHERIT _O_NOINHERIT
246# endif
247#endif
248
ba3eb2af
GS
249#ifndef _O_NOINHERIT
250# define _O_NOINHERIT 0x0080
251# ifndef _NO_OLDNAMES
252# define O_NOINHERIT _O_NOINHERIT
253# endif
254#endif
255
910dfcc8
GS
256#endif /* __MINGW32__ */
257
f3986ebb 258/* compatibility stuff for other compilers goes here */
0a753a76 259
0a753a76 260
390b85e7 261START_EXTERN_C
f3986ebb
GS
262
263/* For UNIX compatibility. */
264
0a753a76
PP
265extern uid_t getuid(void);
266extern gid_t getgid(void);
267extern uid_t geteuid(void);
268extern gid_t getegid(void);
0a753a76
PP
269extern int setuid(uid_t uid);
270extern int setgid(gid_t gid);
271extern int kill(int pid, int sig);
161b471a 272extern void *sbrk(int need);
e34ffe5a 273extern char * getlogin(void);
b990f8c8 274extern int chown(const char *p, uid_t o, gid_t g);
d55594ae 275
f3986ebb
GS
276#undef Stat
277#define Stat win32_stat
3e3baf6d 278
f3986ebb
GS
279#undef init_os_extras
280#define init_os_extras Perl_init_os_extras
390b85e7 281
22239a37
NIS
282DllExport void Perl_win32_init(int *argcp, char ***argvp);
283DllExport void Perl_init_os_extras(void);
3730b96e 284DllExport void win32_str_os_error(void *sv, DWORD err);
0551aaa8 285
f3986ebb
GS
286#ifndef USE_SOCKETS_AS_HANDLES
287extern FILE * my_fdopen(int, char *);
d55594ae 288#endif
f3986ebb 289extern int my_fclose(FILE *);
2d7a9237 290extern int do_aspawn(void *really, void **mark, void **sp);
f3986ebb 291extern int do_spawn(char *cmd);
2d7a9237 292extern int do_spawn_nowait(char *cmd);
f3986ebb 293extern char do_exec(char *cmd);
e5a95ffb 294extern char * win32_get_privlib(char *pl);
00dc2f4f 295extern char * win32_get_sitelib(char *pl);
f3986ebb
GS
296extern int IsWin95(void);
297extern int IsWinNT(void);
d55594ae 298
f3986ebb 299extern char * staticlinkmodules[];
390b85e7
GS
300
301END_EXTERN_C
d55594ae 302
68dc0745 303typedef char * caddr_t; /* In malloc.c (core address). */
0a753a76 304
68dc0745 305/*
68dc0745
PP
306 * handle socket stuff, assuming socket is always available
307 */
0a753a76
PP
308#include <sys/socket.h>
309#include <netdb.h>
310
bbc8f9de
NIS
311#ifdef MYMALLOC
312#define EMBEDMYMALLOC /**/
313/* #define USE_PERL_SBRK /**/
314/* #define PERL_SBRK_VIA_MALLOC /**/
315#endif
316
c31fac66 317#if defined(PERLDLL) && !defined(PERL_CORE)
bbc8f9de
NIS
318#define PERL_CORE
319#endif
320
a868473f
NIS
321#ifdef USE_BINMODE_SCRIPTS
322#define PERL_SCRIPT_MODE "rb"
323EXT void win32_strip_return(struct sv *sv);
324#else
325#define PERL_SCRIPT_MODE "r"
326#define win32_strip_return(sv) NOOP
327#endif
328
4b556e6c 329#define HAVE_INTERP_INTERN
0aaad0ff
GS
330typedef struct {
331 long num;
332 DWORD pids[MAXIMUM_WAIT_OBJECTS];
333} child_tab;
334
4b556e6c 335struct interp_intern {
0aaad0ff
GS
336 char * perlshell_tokens;
337 char ** perlshell_vec;
338 long perlshell_items;
339 struct av * fdpid;
340 child_tab * children;
341 HANDLE child_handles[MAXIMUM_WAIT_OBJECTS];
4b556e6c
JD
342};
343
4b556e6c 344
0aaad0ff
GS
345#define w32_perlshell_tokens (PL_sys_intern.perlshell_tokens)
346#define w32_perlshell_vec (PL_sys_intern.perlshell_vec)
347#define w32_perlshell_items (PL_sys_intern.perlshell_items)
348#define w32_fdpid (PL_sys_intern.fdpid)
349#define w32_children (PL_sys_intern.children)
350#define w32_num_children (w32_children->num)
351#define w32_child_pids (w32_children->pids)
352#define w32_child_handles (PL_sys_intern.child_handles)
4b556e6c 353
c53bd28a
NIS
354/*
355 * Now Win32 specific per-thread data stuff
356 */
357
358#ifdef USE_THREADS
e34ffe5a
GS
359# ifndef USE_DECLSPEC_THREAD
360# define HAVE_THREAD_INTERN
361
362struct thread_intern {
363 /* XXX can probably use one buffer instead of several */
364 char Wstrerror_buffer[512];
365 struct servent Wservent;
366 char Wgetlogin_buffer[128];
4b556e6c 367 char Ww32_perllib_root[MAX_PATH+1];
401ef382
SN
368# ifdef USE_SOCKETS_AS_HANDLES
369 int Winit_socktype;
370# endif
e34ffe5a
GS
371# ifdef HAVE_DES_FCRYPT
372 char Wcrypt_buffer[30];
373# endif
2d7a9237
GS
374# ifdef USE_RTL_THREAD_API
375 void * retv; /* slot for thread return value */
376# endif
c53bd28a 377};
e34ffe5a
GS
378# endif /* !USE_DECLSPEC_THREAD */
379#endif /* USE_THREADS */
c53bd28a 380
68dc0745 381#endif /* _INC_WIN32_PERL5 */