Check for NULL in lstrcpy* (Windows uses real exception handlers).
[wine.git] / include / wintypes.h
blobfc981dd6e86ad5ab42f1ba3e55679ed304758d1b
1 /*
2 * Basic types definitions
4 * Copyright 1996 Alexandre Julliard
5 */
7 #ifndef __WINE_WINTYPES_H
8 #define __WINE_WINTYPES_H
10 #ifdef __WINE__
11 # include "config.h"
12 # undef UNICODE
13 #endif /* __WINE__ */
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
19 /* Macros to map Winelib names to the correct implementation name */
20 /* depending on __WINE__ and UNICODE macros. */
21 /* Note that Winelib is purely Win32. */
23 #ifdef __WINE__
24 # define WINELIB_NAME(func) this_is_a_syntax_error this_is_a_syntax_error
25 # define WINELIB_NAME_AW(func) this_is_a_syntax_error this_is_a_syntax_error
26 #else /* __WINE__ */
27 # define WINELIB_NAME(func) func##32
28 # ifdef UNICODE
29 # define WINELIB_NAME_AW(func) func##32W
30 # else
31 # define WINELIB_NAME_AW(func) func##32A
32 # endif /* UNICODE */
33 #endif /* __WINE__ */
35 #ifdef __WINE__
36 # define DECL_WINELIB_TYPE(type) /* nothing */
37 # define DECL_WINELIB_TYPE_AW(type) /* nothing */
38 #else /* __WINE__ */
39 # define DECL_WINELIB_TYPE(type) typedef WINELIB_NAME(type) type;
40 # define DECL_WINELIB_TYPE_AW(type) typedef WINELIB_NAME_AW(type) type;
41 #endif /* __WINE__ */
44 /* Calling conventions definitions */
46 #ifdef __i386__
47 # if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ >= 7)
48 # define __stdcall __attribute__((__stdcall__))
49 # define __cdecl __attribute__((__cdecl__))
50 # define __RESTORE_ES __asm__ __volatile__("pushl %ds\n\tpopl %es")
51 # else
52 # error You need gcc >= 2.7 to build Wine on a 386
53 # endif /* __GNUC__ */
54 #else /* __i386__ */
55 # define __stdcall
56 # define __cdecl
57 # define __RESTORE_ES
58 #endif /* __i386__ */
60 #define CALLBACK __stdcall
61 #define WINAPI __stdcall
62 #define APIPRIVATE __stdcall
63 #define PASCAL __stdcall
64 #define _pascal __stdcall
65 #define __export __stdcall
66 #define WINAPIV __cdecl
67 #define APIENTRY WINAPI
69 #define CONST const
71 /* Standard data types. These are the same for emulator and library. */
73 typedef void VOID;
74 typedef short INT16;
75 typedef unsigned short UINT16;
76 typedef int INT32;
77 typedef unsigned int UINT32;
78 typedef unsigned short WORD;
79 typedef unsigned long DWORD;
80 typedef unsigned long ULONG;
81 typedef unsigned char BYTE;
82 typedef long LONG;
83 typedef short SHORT;
84 typedef unsigned short USHORT;
85 typedef char CHAR;
86 typedef unsigned char UCHAR;
87 /* Some systems might have wchar_t, but we really need 16 bit characters */
88 typedef unsigned short WCHAR;
89 typedef unsigned short BOOL16;
90 typedef int BOOL32;
91 typedef double DATE;
92 typedef long SCODE;
93 typedef long LONG_PTR;
94 typedef unsigned long ULONG_PTR;
95 #ifdef __i386__
96 typedef double LONGLONG;
97 typedef double ULONGLONG;
98 #endif /*__i386__*/
100 /* Integer types. These are the same for emulator and library. */
102 typedef UINT16 HANDLE16;
103 typedef UINT32 HANDLE32;
104 typedef UINT16 WPARAM16;
105 typedef UINT32 WPARAM32;
106 typedef LONG LPARAM;
107 typedef LONG HRESULT;
108 typedef LONG LRESULT;
109 typedef WORD ATOM;
110 typedef WORD CATCHBUF[9];
111 typedef WORD *LPCATCHBUF;
112 typedef DWORD ACCESS_MASK;
113 typedef ACCESS_MASK REGSAM;
114 typedef HANDLE32 HHOOK;
115 typedef HANDLE32 HKEY;
116 typedef HANDLE32 HMONITOR;
117 typedef DWORD LCID;
118 typedef WORD LANGID;
119 typedef DWORD LCTYPE;
120 typedef float FLOAT;
121 typedef long long __int64;
123 /* Pointers types. These are the same for emulator and library. */
124 /* winnt types */
125 typedef void *PVOID;
126 typedef const void *PCVOID;
127 typedef CHAR *PCHAR;
128 typedef UCHAR *PUCHAR;
129 typedef BYTE *PBYTE;
130 typedef ULONG *PULONG;
131 typedef LONG *PLONG;
132 typedef DWORD *PDWORD;
133 /* common win32 types */
134 typedef CHAR *LPSTR;
135 typedef const CHAR *LPCSTR;
136 typedef WCHAR *LPWSTR;
137 typedef const WCHAR *LPCWSTR;
138 typedef BYTE *LPBYTE;
139 typedef WORD *LPWORD;
140 typedef DWORD *LPDWORD;
141 typedef LONG *LPLONG;
142 typedef VOID *LPVOID;
143 typedef const VOID *LPCVOID;
144 typedef INT16 *LPINT16;
145 typedef UINT16 *LPUINT16;
146 typedef INT32 *PINT32;
147 typedef INT32 *LPINT32;
148 typedef UINT32 *PUINT32;
149 typedef UINT32 *LPUINT32;
150 typedef HKEY *LPHKEY;
151 typedef FLOAT *PFLOAT;
152 typedef FLOAT *LPFLOAT;
153 typedef BOOL32 *PBOOL32;
154 typedef BOOL32 *LPBOOL32;
156 /* Special case: a segmented pointer is just a pointer in the user's code. */
158 #ifdef __WINE__
159 typedef DWORD SEGPTR;
160 #else
161 typedef void* SEGPTR;
162 #endif /* __WINE__ */
164 /* Handle types that exist both in Win16 and Win32. */
166 #define DECLARE_HANDLE(a) typedef HANDLE16 a##16; typedef HANDLE32 a##32
167 DECLARE_HANDLE(HACCEL);
168 DECLARE_HANDLE(HBITMAP);
169 DECLARE_HANDLE(HBRUSH);
170 DECLARE_HANDLE(HCOLORSPACE);
171 DECLARE_HANDLE(HCURSOR);
172 DECLARE_HANDLE(HDC);
173 DECLARE_HANDLE(HDROP);
174 DECLARE_HANDLE(HDRVR);
175 DECLARE_HANDLE(HDWP);
176 DECLARE_HANDLE(HENHMETAFILE);
177 DECLARE_HANDLE(HFILE);
178 DECLARE_HANDLE(HFONT);
179 DECLARE_HANDLE(HGDIOBJ);
180 DECLARE_HANDLE(HGLOBAL);
181 DECLARE_HANDLE(HICON);
182 DECLARE_HANDLE(HINSTANCE);
183 DECLARE_HANDLE(HLOCAL);
184 DECLARE_HANDLE(HMENU);
185 DECLARE_HANDLE(HMETAFILE);
186 DECLARE_HANDLE(HMIDI);
187 DECLARE_HANDLE(HMIDIIN);
188 DECLARE_HANDLE(HMIDIOUT);
189 DECLARE_HANDLE(HMIDISTRM);
190 DECLARE_HANDLE(HMIXER);
191 DECLARE_HANDLE(HMIXEROBJ);
192 DECLARE_HANDLE(HMMIO);
193 DECLARE_HANDLE(HMODULE);
194 DECLARE_HANDLE(HPALETTE);
195 DECLARE_HANDLE(HPEN);
196 DECLARE_HANDLE(HQUEUE);
197 DECLARE_HANDLE(HRGN);
198 DECLARE_HANDLE(HRSRC);
199 DECLARE_HANDLE(HTASK);
200 DECLARE_HANDLE(HWAVE);
201 DECLARE_HANDLE(HWAVEIN);
202 DECLARE_HANDLE(HWAVEOUT);
203 DECLARE_HANDLE(HWINSTA);
204 DECLARE_HANDLE(HDESK);
205 DECLARE_HANDLE(HWND);
206 DECLARE_HANDLE(HKL);
207 DECLARE_HANDLE(HIC);
208 DECLARE_HANDLE(HRASCONN);
209 #undef DECLARE_HANDLE
211 /* Callback function pointers types */
213 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32A)(LPSTR);
214 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32W)(LPWSTR);
215 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
216 typedef BOOL16 (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
217 typedef BOOL32 (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
218 DECL_WINELIB_TYPE(DLGPROC)
219 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
220 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
221 DECL_WINELIB_TYPE(DRIVERPROC)
222 typedef INT16 (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
223 typedef INT32 (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
224 typedef INT32 (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
225 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
226 typedef LRESULT (CALLBACK *FARPROC16)();
227 typedef LRESULT (CALLBACK *FARPROC32)();
228 DECL_WINELIB_TYPE(FARPROC)
229 typedef INT16 (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
230 typedef INT32 (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
231 DECL_WINELIB_TYPE(GOBJENUMPROC)
232 typedef BOOL16 (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
233 typedef BOOL32 (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
234 DECL_WINELIB_TYPE(GRAYSTRINGPROC)
235 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
236 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
237 DECL_WINELIB_TYPE(HOOKPROC)
238 typedef VOID (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
239 typedef VOID (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
240 DECL_WINELIB_TYPE(LINEDDAPROC)
241 typedef BOOL16 (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
242 typedef BOOL32 (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
243 typedef BOOL32 (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
244 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
245 typedef BOOL32 (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
246 typedef BOOL32 (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
247 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
248 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32A)(LPSTR);
249 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32W)(LPWSTR);
250 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
251 typedef VOID (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
252 typedef VOID (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
253 DECL_WINELIB_TYPE(TIMERPROC)
254 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
255 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
256 DECL_WINELIB_TYPE(WNDENUMPROC)
257 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
258 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
259 DECL_WINELIB_TYPE(WNDPROC)
261 /* TCHAR data types definitions for Winelib. */
262 /* These types are _not_ defined for the emulator, because they */
263 /* depend on the UNICODE macro that only exists in user's code. */
265 #ifndef __WINE__
266 # ifdef UNICODE
267 typedef WCHAR TCHAR;
268 typedef LPWSTR LPTSTR;
269 typedef LPCWSTR LPCTSTR;
270 #define __TEXT(string) L##string /*probably wrong */
271 # else /* UNICODE */
272 typedef CHAR TCHAR;
273 typedef LPSTR LPTSTR;
274 typedef LPCSTR LPCTSTR;
275 #define __TEXT(string) string
276 # endif /* UNICODE */
277 #endif /* __WINE__ */
278 #define TEXT(quote) __TEXT(quote)
280 /* Data types specific to the library. These do _not_ exist in the emulator. */
282 DECL_WINELIB_TYPE(INT)
283 DECL_WINELIB_TYPE(LPINT)
284 DECL_WINELIB_TYPE(PUINT)
285 DECL_WINELIB_TYPE(LPUINT)
286 DECL_WINELIB_TYPE(UINT)
287 DECL_WINELIB_TYPE(BOOL)
288 DECL_WINELIB_TYPE(WPARAM)
290 DECL_WINELIB_TYPE(HACCEL)
291 DECL_WINELIB_TYPE(HANDLE)
292 DECL_WINELIB_TYPE(HBITMAP)
293 DECL_WINELIB_TYPE(HBRUSH)
294 DECL_WINELIB_TYPE(HCOLORSPACE)
295 DECL_WINELIB_TYPE(HCURSOR)
296 DECL_WINELIB_TYPE(HDC)
297 DECL_WINELIB_TYPE(HDROP)
298 DECL_WINELIB_TYPE(HDRVR)
299 DECL_WINELIB_TYPE(HDWP)
300 DECL_WINELIB_TYPE(HENHMETAFILE)
301 DECL_WINELIB_TYPE(HFILE)
302 DECL_WINELIB_TYPE(HFONT)
303 DECL_WINELIB_TYPE(HGDIOBJ)
304 DECL_WINELIB_TYPE(HGLOBAL)
305 DECL_WINELIB_TYPE(HIC)
306 DECL_WINELIB_TYPE(HICON)
307 DECL_WINELIB_TYPE(HINSTANCE)
308 DECL_WINELIB_TYPE(HLOCAL)
309 DECL_WINELIB_TYPE(HMENU)
310 DECL_WINELIB_TYPE(HMETAFILE)
311 DECL_WINELIB_TYPE(HMIDI)
312 DECL_WINELIB_TYPE(HMIDIIN)
313 DECL_WINELIB_TYPE(HMIDIOUT)
314 DECL_WINELIB_TYPE(HMMIO)
315 DECL_WINELIB_TYPE(HMODULE)
316 DECL_WINELIB_TYPE(HPALETTE)
317 DECL_WINELIB_TYPE(HPEN)
318 DECL_WINELIB_TYPE(HQUEUE)
319 DECL_WINELIB_TYPE(HRGN)
320 DECL_WINELIB_TYPE(HRSRC)
321 DECL_WINELIB_TYPE(HTASK)
322 DECL_WINELIB_TYPE(HWAVE)
323 DECL_WINELIB_TYPE(HWAVEIN)
324 DECL_WINELIB_TYPE(HWAVEOUT)
325 DECL_WINELIB_TYPE(HWND)
327 /* Misc. constants. */
329 #ifdef FALSE
330 #undef FALSE
331 #endif
332 #define FALSE 0
334 #ifdef TRUE
335 #undef TRUE
336 #endif
337 #define TRUE 1
339 #ifdef NULL
340 #undef NULL
341 #endif
342 #define NULL 0
344 /* Define some empty macros for compatibility with Windows code. */
346 #ifndef __WINE__
347 #define NEAR
348 #define FAR
349 #define _far
350 #define _near
351 #define IN
352 #define OUT
353 #define OPTIONAL
354 #endif /* __WINE__ */
356 /* Macro for structure packing. */
358 #ifdef __GNUC__
359 #define WINE_PACKED __attribute__ ((packed))
360 #else
361 #define WINE_PACKED /* nothing */
362 #endif
364 /* Macros to split words and longs. */
366 #define LOBYTE(w) ((BYTE)(WORD)(w))
367 #define HIBYTE(w) ((BYTE)((WORD)(w) >> 8))
369 #define LOWORD(l) ((WORD)(DWORD)(l))
370 #define HIWORD(l) ((WORD)((DWORD)(l) >> 16))
372 #define SLOWORD(l) ((INT16)(LONG)(l))
373 #define SHIWORD(l) ((INT16)((LONG)(l) >> 16))
375 #define MAKEWORD(low,high) ((WORD)(((BYTE)(low)) | ((WORD)((BYTE)(high))) << 8))
376 #define MAKELONG(low,high) ((LONG)(((WORD)(low)) | (((DWORD)((WORD)(high))) << 16)))
377 #define MAKELPARAM(low,high) ((LPARAM)MAKELONG(low,high))
378 #define MAKEWPARAM(low,high) ((WPARAM32)MAKELONG(low,high))
379 #define MAKELRESULT(low,high) ((LRESULT)MAKELONG(low,high))
380 #define MAKEINTATOM(atom) ((LPCSTR)MAKELONG((atom),0))
382 #define SELECTOROF(ptr) (HIWORD(ptr))
383 #define OFFSETOF(ptr) (LOWORD(ptr))
385 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
387 #ifdef __i386__
388 #define PUT_WORD(ptr,w) (*(WORD *)(ptr) = (w))
389 #define GET_WORD(ptr) (*(WORD *)(ptr))
390 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
391 #define GET_DWORD(ptr) (*(DWORD *)(ptr))
392 #else
393 #define PUT_WORD(ptr,w) (*(BYTE *)(ptr) = LOBYTE(w), \
394 *((BYTE *)(ptr) + 1) = HIBYTE(w))
395 #define GET_WORD(ptr) ((WORD)(*(BYTE *)(ptr) | \
396 (WORD)(*((BYTE *)(ptr)+1) << 8)))
397 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
398 PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
399 #define GET_DWORD(ptr) ((DWORD)(GET_WORD(ptr) | \
400 ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
401 #endif /* __i386__ */
403 /* MIN and MAX macros */
405 #ifdef MAX
406 #undef MAX
407 #endif
408 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
410 #ifdef MIN
411 #undef MIN
412 #endif
413 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
415 #define __max(a,b) MAX(a,b)
416 #define __min(a,b) MIN(a,b)
417 #define max(a,b) MAX(a,b)
418 #define min(a,b) MIN(a,b)
420 #define _MAX_PATH 260
421 #define _MAX_FNAME 255
423 /* Winelib run-time flag */
425 #ifdef __WINE__
426 extern int __winelib;
427 #endif /* __WINE__ */
429 /* The SIZE structure */
431 typedef struct
433 INT16 cx;
434 INT16 cy;
435 } SIZE16, *LPSIZE16;
437 typedef struct tagSIZE
439 INT32 cx;
440 INT32 cy;
441 } SIZE32, *LPSIZE32;
443 DECL_WINELIB_TYPE(SIZE)
444 DECL_WINELIB_TYPE(LPSIZE)
446 #define CONV_SIZE16TO32(s16,s32) \
447 ((s32)->cx = (INT32)(s16)->cx, (s32)->cy = (INT32)(s16)->cy)
448 #define CONV_SIZE32TO16(s32,s16) \
449 ((s16)->cx = (INT16)(s32)->cx, (s16)->cy = (INT16)(s32)->cy)
451 /* The POINT structure */
453 typedef struct
455 INT16 x;
456 INT16 y;
457 } POINT16, *LPPOINT16;
459 typedef struct tagPOINT
461 INT32 x;
462 INT32 y;
463 } POINT32, *LPPOINT32;
465 DECL_WINELIB_TYPE(POINT)
466 DECL_WINELIB_TYPE(LPPOINT)
468 #define CONV_POINT16TO32(p16,p32) \
469 ((p32)->x = (INT32)(p16)->x, (p32)->y = (INT32)(p16)->y)
470 #define CONV_POINT32TO16(p32,p16) \
471 ((p16)->x = (INT16)(p32)->x, (p16)->y = (INT16)(p32)->y)
473 #define MAKEPOINT16(l) (*((POINT16 *)&(l)))
474 #define MAKEPOINT WINELIB_NAME(MAKEPOINT)
476 /* The RECT structure */
478 typedef struct
480 INT16 left;
481 INT16 top;
482 INT16 right;
483 INT16 bottom;
484 } RECT16, *LPRECT16;
486 typedef struct tagRECT
488 INT32 left;
489 INT32 top;
490 INT32 right;
491 INT32 bottom;
492 } RECT32, *LPRECT32;
494 DECL_WINELIB_TYPE(RECT)
495 DECL_WINELIB_TYPE(LPRECT)
497 #define CONV_RECT16TO32(r16,r32) \
498 ((r32)->left = (INT32)(r16)->left, (r32)->top = (INT32)(r16)->top, \
499 (r32)->right = (INT32)(r16)->right, (r32)->bottom = (INT32)(r16)->bottom)
500 #define CONV_RECT32TO16(r32,r16) \
501 ((r16)->left = (INT16)(r32)->left, (r16)->top = (INT16)(r32)->top, \
502 (r16)->right = (INT16)(r32)->right, (r16)->bottom = (INT16)(r32)->bottom)
504 #ifdef __cplusplus
506 #endif
508 #endif /* __WINE_WINTYPES_H */