- better support for ExecuteBuffers
[wine] / include / wintypes.h
1 /*
2  * Basic types definitions
3  *
4  * Copyright 1996 Alexandre Julliard
5  */
6
7 #ifndef __WINE_WINTYPES_H
8 #define __WINE_WINTYPES_H
9
10 #ifdef __WINE__
11 # include "config.h"
12 # undef UNICODE
13 #endif  /* __WINE__ */
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif
18
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.                             */
22
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__ */
34
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__ */
42
43
44 /* Calling conventions definitions */
45
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__ */
59
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
68
69 #define CONST       const
70
71 /* Standard data types. These are the same for emulator and library. */
72
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            LONG_PTR;
93 typedef unsigned long   ULONG_PTR;
94 #ifdef __i386__
95 typedef double          LONGLONG;
96 typedef double          ULONGLONG;
97 #endif /*__i386__*/
98
99 /* Integer types. These are the same for emulator and library. */
100
101 typedef UINT16          HANDLE16;
102 typedef UINT32          HANDLE32;
103 typedef UINT16          WPARAM16;
104 typedef UINT32          WPARAM32;
105 typedef LONG            LPARAM;
106 typedef LONG            HRESULT;
107 typedef LONG            LRESULT;
108 typedef WORD            ATOM;
109 typedef WORD            CATCHBUF[9];
110 typedef WORD           *LPCATCHBUF;
111 typedef DWORD           ACCESS_MASK;
112 typedef ACCESS_MASK     REGSAM;
113 typedef HANDLE32        HHOOK;
114 typedef HANDLE32        HKEY;
115 typedef HANDLE32        HMONITOR;
116 typedef DWORD           LCID;
117 typedef WORD            LANGID;
118 typedef DWORD           LCTYPE;
119 typedef float           FLOAT;
120 typedef long long       __int64;
121
122 /* Pointers types. These are the same for emulator and library. */
123 /* winnt types */
124 typedef void           *PVOID;
125 typedef const void     *PCVOID;
126 typedef CHAR           *PCHAR;
127 typedef UCHAR          *PUCHAR;
128 typedef BYTE           *PBYTE;
129 typedef ULONG          *PULONG;
130 typedef LONG           *PLONG;
131 typedef DWORD          *PDWORD;
132 /* common win32 types */
133 typedef CHAR           *LPSTR;
134 typedef const CHAR     *LPCSTR;
135 typedef WCHAR          *LPWSTR;
136 typedef const WCHAR    *LPCWSTR;
137 typedef BYTE           *LPBYTE;
138 typedef WORD           *LPWORD;
139 typedef DWORD          *LPDWORD;
140 typedef LONG           *LPLONG;
141 typedef VOID           *LPVOID;
142 typedef const VOID     *LPCVOID;
143 typedef INT16          *LPINT16;
144 typedef UINT16         *LPUINT16;
145 typedef INT32          *PINT32;
146 typedef INT32          *LPINT32;
147 typedef UINT32         *PUINT32;
148 typedef UINT32         *LPUINT32;
149 typedef HKEY           *LPHKEY;
150 typedef FLOAT          *PFLOAT;
151 typedef FLOAT          *LPFLOAT;
152 typedef BOOL32         *PBOOL32;
153 typedef BOOL32         *LPBOOL32;
154
155 /* Special case: a segmented pointer is just a pointer in the user's code. */
156
157 #ifdef __WINE__
158 typedef DWORD SEGPTR;
159 #else
160 typedef void* SEGPTR;
161 #endif /* __WINE__ */
162
163 /* Handle types that exist both in Win16 and Win32. */
164
165 #define DECLARE_HANDLE(a)  typedef HANDLE16 a##16; typedef HANDLE32 a##32
166 DECLARE_HANDLE(HACCEL);
167 DECLARE_HANDLE(HBITMAP);
168 DECLARE_HANDLE(HBRUSH);
169 DECLARE_HANDLE(HCOLORSPACE);
170 DECLARE_HANDLE(HCURSOR);
171 DECLARE_HANDLE(HDC);
172 DECLARE_HANDLE(HDROP);
173 DECLARE_HANDLE(HDRVR);
174 DECLARE_HANDLE(HDWP);
175 DECLARE_HANDLE(HENHMETAFILE);
176 DECLARE_HANDLE(HFILE);
177 DECLARE_HANDLE(HFONT);
178 DECLARE_HANDLE(HGDIOBJ);
179 DECLARE_HANDLE(HGLOBAL);
180 DECLARE_HANDLE(HICON);
181 DECLARE_HANDLE(HINSTANCE);
182 DECLARE_HANDLE(HLOCAL);
183 DECLARE_HANDLE(HMENU);
184 DECLARE_HANDLE(HMETAFILE);
185 DECLARE_HANDLE(HMIDI);
186 DECLARE_HANDLE(HMIDIIN);
187 DECLARE_HANDLE(HMIDIOUT);
188 DECLARE_HANDLE(HMIDISTRM);
189 DECLARE_HANDLE(HMIXER);
190 DECLARE_HANDLE(HMIXEROBJ);
191 DECLARE_HANDLE(HMMIO);
192 DECLARE_HANDLE(HMODULE);
193 DECLARE_HANDLE(HPALETTE);
194 DECLARE_HANDLE(HPEN);
195 DECLARE_HANDLE(HQUEUE);
196 DECLARE_HANDLE(HRGN);
197 DECLARE_HANDLE(HRSRC);
198 DECLARE_HANDLE(HTASK);
199 DECLARE_HANDLE(HWAVE);
200 DECLARE_HANDLE(HWAVEIN);
201 DECLARE_HANDLE(HWAVEOUT);
202 DECLARE_HANDLE(HWINSTA);
203 DECLARE_HANDLE(HDESK);
204 DECLARE_HANDLE(HWND);
205 DECLARE_HANDLE(HKL);
206 DECLARE_HANDLE(HIC);
207 DECLARE_HANDLE(HRASCONN);
208 #undef DECLARE_HANDLE
209
210 /* Callback function pointers types */
211
212 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32A)(LPSTR);
213 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32W)(LPWSTR);
214 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
215 typedef BOOL16 (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
216 typedef BOOL32 (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
217 DECL_WINELIB_TYPE(DLGPROC)
218 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
219 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
220 DECL_WINELIB_TYPE(DRIVERPROC)
221 typedef INT16   (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
222 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
223 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
224 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
225 typedef LRESULT (CALLBACK *FARPROC16)();
226 typedef LRESULT (CALLBACK *FARPROC32)();
227 DECL_WINELIB_TYPE(FARPROC)
228 typedef INT16   (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
229 typedef INT32   (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
230 DECL_WINELIB_TYPE(GOBJENUMPROC)
231 typedef BOOL16  (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
232 typedef BOOL32  (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
233 DECL_WINELIB_TYPE(GRAYSTRINGPROC)
234 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
235 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
236 DECL_WINELIB_TYPE(HOOKPROC)
237 typedef VOID    (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
238 typedef VOID    (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
239 DECL_WINELIB_TYPE(LINEDDAPROC)
240 typedef BOOL16  (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
241 typedef BOOL32  (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
242 typedef BOOL32  (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
243 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
244 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
245 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
246 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
247 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32A)(LPSTR);
248 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32W)(LPWSTR);
249 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
250 typedef VOID    (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
251 typedef VOID    (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
252 DECL_WINELIB_TYPE(TIMERPROC)
253 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
254 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
255 DECL_WINELIB_TYPE(WNDENUMPROC)
256 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
257 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
258 DECL_WINELIB_TYPE(WNDPROC)
259
260 /* TCHAR data types definitions for Winelib. */
261 /* These types are _not_ defined for the emulator, because they */
262 /* depend on the UNICODE macro that only exists in user's code. */
263
264 #ifndef __WINE__
265 # ifdef UNICODE
266 typedef WCHAR TCHAR;
267 typedef LPWSTR LPTSTR;
268 typedef LPCWSTR LPCTSTR;
269 #define __TEXT(string) L##string /*probably wrong */
270 # else  /* UNICODE */
271 typedef CHAR TCHAR;
272 typedef LPSTR LPTSTR;
273 typedef LPCSTR LPCTSTR;
274 #define __TEXT(string) string
275 # endif /* UNICODE */
276 #endif   /* __WINE__ */
277 #define TEXT(quote) __TEXT(quote)
278
279 /* Data types specific to the library. These do _not_ exist in the emulator. */
280
281 DECL_WINELIB_TYPE(INT)
282 DECL_WINELIB_TYPE(LPINT)
283 DECL_WINELIB_TYPE(PUINT)
284 DECL_WINELIB_TYPE(LPUINT)
285 DECL_WINELIB_TYPE(UINT)
286 DECL_WINELIB_TYPE(BOOL)
287 DECL_WINELIB_TYPE(WPARAM)
288
289 DECL_WINELIB_TYPE(HACCEL)
290 DECL_WINELIB_TYPE(HANDLE)
291 DECL_WINELIB_TYPE(HBITMAP)
292 DECL_WINELIB_TYPE(HBRUSH)
293 DECL_WINELIB_TYPE(HCOLORSPACE)
294 DECL_WINELIB_TYPE(HCURSOR)
295 DECL_WINELIB_TYPE(HDC)
296 DECL_WINELIB_TYPE(HDROP)
297 DECL_WINELIB_TYPE(HDRVR)
298 DECL_WINELIB_TYPE(HDWP)
299 DECL_WINELIB_TYPE(HENHMETAFILE)
300 DECL_WINELIB_TYPE(HFILE)
301 DECL_WINELIB_TYPE(HFONT)
302 DECL_WINELIB_TYPE(HGDIOBJ)
303 DECL_WINELIB_TYPE(HGLOBAL)
304 DECL_WINELIB_TYPE(HICON)
305 DECL_WINELIB_TYPE(HINSTANCE)
306 DECL_WINELIB_TYPE(HLOCAL)
307 DECL_WINELIB_TYPE(HMENU)
308 DECL_WINELIB_TYPE(HMETAFILE)
309 DECL_WINELIB_TYPE(HMIDI)
310 DECL_WINELIB_TYPE(HMIDIIN)
311 DECL_WINELIB_TYPE(HMIDIOUT)
312 DECL_WINELIB_TYPE(HMMIO)
313 DECL_WINELIB_TYPE(HMODULE)
314 DECL_WINELIB_TYPE(HPALETTE)
315 DECL_WINELIB_TYPE(HPEN)
316 DECL_WINELIB_TYPE(HQUEUE)
317 DECL_WINELIB_TYPE(HRGN)
318 DECL_WINELIB_TYPE(HRSRC)
319 DECL_WINELIB_TYPE(HTASK)
320 DECL_WINELIB_TYPE(HWAVE)
321 DECL_WINELIB_TYPE(HWAVEIN)
322 DECL_WINELIB_TYPE(HWAVEOUT)
323 DECL_WINELIB_TYPE(HWND)
324
325 /* Misc. constants. */
326
327 #ifdef FALSE
328 #undef FALSE
329 #endif
330 #define FALSE 0
331
332 #ifdef TRUE
333 #undef TRUE
334 #endif
335 #define TRUE  1
336
337 #ifdef NULL
338 #undef NULL
339 #endif
340 #define NULL  0
341
342 /* Define some empty macros for compatibility with Windows code. */
343
344 #ifndef __WINE__
345 #define NEAR
346 #define FAR
347 #define _far
348 #define _near
349 #define IN
350 #define OUT
351 #define OPTIONAL
352 #endif  /* __WINE__ */
353
354 /* Macro for structure packing. */
355
356 #ifdef __GNUC__
357 #define WINE_PACKED __attribute__ ((packed))
358 #else
359 #define WINE_PACKED  /* nothing */
360 #endif
361
362 /* Macros to split words and longs. */
363
364 #define LOBYTE(w)              ((BYTE)(WORD)(w))
365 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
366
367 #define LOWORD(l)              ((WORD)(DWORD)(l))
368 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
369
370 #define SLOWORD(l)             ((INT16)(LONG)(l))
371 #define SHIWORD(l)             ((INT16)((LONG)(l) >> 16))
372
373 #define MAKEWORD(low,high)     ((WORD)(((BYTE)(low)) | ((WORD)((BYTE)(high))) << 8))
374 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | (((DWORD)((WORD)(high))) << 16)))
375 #define MAKELPARAM(low,high)   ((LPARAM)MAKELONG(low,high))
376 #define MAKEWPARAM(low,high)   ((WPARAM32)MAKELONG(low,high))
377 #define MAKELRESULT(low,high)  ((LRESULT)MAKELONG(low,high))
378 #define MAKEINTATOM(atom)      ((LPCSTR)MAKELONG((atom),0))
379
380 #define SELECTOROF(ptr)     (HIWORD(ptr))
381 #define OFFSETOF(ptr)       (LOWORD(ptr))
382
383 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
384
385 #ifdef __i386__
386 #define PUT_WORD(ptr,w)   (*(WORD *)(ptr) = (w))
387 #define GET_WORD(ptr)     (*(WORD *)(ptr))
388 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
389 #define GET_DWORD(ptr)    (*(DWORD *)(ptr))
390 #else
391 #define PUT_WORD(ptr,w)   (*(BYTE *)(ptr) = LOBYTE(w), \
392                            *((BYTE *)(ptr) + 1) = HIBYTE(w))
393 #define GET_WORD(ptr)     ((WORD)(*(BYTE *)(ptr) | \
394                                   (WORD)(*((BYTE *)(ptr)+1) << 8)))
395 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
396                            PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
397 #define GET_DWORD(ptr)    ((DWORD)(GET_WORD(ptr) | \
398                                    ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
399 #endif  /* __i386__ */
400
401 /* MIN and MAX macros */
402
403 #ifdef MAX
404 #undef MAX
405 #endif
406 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
407
408 #ifdef MIN
409 #undef MIN
410 #endif
411 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
412
413 #define __max(a,b) MAX(a,b)
414 #define __min(a,b) MIN(a,b)
415 #define max(a,b)   MAX(a,b)
416 #define min(a,b)   MIN(a,b)
417
418 #define _MAX_PATH  260
419 #define _MAX_FNAME 255
420
421 /* Winelib run-time flag */
422
423 #ifdef __WINE__
424 extern int __winelib;
425 #endif  /* __WINE__ */
426
427 /* The SIZE structure */
428
429 typedef struct
430 {
431     INT16  cx;
432     INT16  cy;
433 } SIZE16, *LPSIZE16;
434
435 typedef struct tagSIZE
436 {
437     INT32  cx;
438     INT32  cy;
439 } SIZE32, *LPSIZE32;
440
441 DECL_WINELIB_TYPE(SIZE)
442 DECL_WINELIB_TYPE(LPSIZE)
443
444 #define CONV_SIZE16TO32(s16,s32) \
445             ((s32)->cx = (INT32)(s16)->cx, (s32)->cy = (INT32)(s16)->cy)
446 #define CONV_SIZE32TO16(s32,s16) \
447             ((s16)->cx = (INT16)(s32)->cx, (s16)->cy = (INT16)(s32)->cy)
448
449 /* The POINT structure */
450
451 typedef struct
452 {
453     INT16  x;
454     INT16  y;
455 } POINT16, *LPPOINT16;
456
457 typedef struct tagPOINT
458 {
459     INT32  x;
460     INT32  y;
461 } POINT32, *LPPOINT32;
462
463 DECL_WINELIB_TYPE(POINT)
464 DECL_WINELIB_TYPE(LPPOINT)
465
466 #define CONV_POINT16TO32(p16,p32) \
467             ((p32)->x = (INT32)(p16)->x, (p32)->y = (INT32)(p16)->y)
468 #define CONV_POINT32TO16(p32,p16) \
469             ((p16)->x = (INT16)(p32)->x, (p16)->y = (INT16)(p32)->y)
470
471 #define MAKEPOINT16(l) (*((POINT16 *)&(l)))
472 #define MAKEPOINT WINELIB_NAME(MAKEPOINT)
473
474 /* The RECT structure */
475
476 typedef struct
477 {
478     INT16  left;
479     INT16  top;
480     INT16  right;
481     INT16  bottom;
482 } RECT16, *LPRECT16;
483
484 typedef struct tagRECT
485 {
486     INT32  left;
487     INT32  top;
488     INT32  right;
489     INT32  bottom;
490 } RECT32, *LPRECT32;
491
492 DECL_WINELIB_TYPE(RECT)
493 DECL_WINELIB_TYPE(LPRECT)
494
495 #define CONV_RECT16TO32(r16,r32) \
496     ((r32)->left  = (INT32)(r16)->left,  (r32)->top    = (INT32)(r16)->top, \
497      (r32)->right = (INT32)(r16)->right, (r32)->bottom = (INT32)(r16)->bottom)
498 #define CONV_RECT32TO16(r32,r16) \
499     ((r16)->left  = (INT16)(r32)->left,  (r16)->top    = (INT16)(r32)->top, \
500      (r16)->right = (INT16)(r32)->right, (r16)->bottom = (INT16)(r32)->bottom)
501
502 #ifdef __cplusplus
503 }
504 #endif
505
506 #endif /* __WINE_WINTYPES_H */