Release 980301
[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 WINELIB
13 # undef WINELIB16
14 # undef WINELIB32
15 # undef UNICODE
16 #else  /* __WINE__ */
17 # ifndef WINELIB
18 #  define WINELIB
19 # endif
20 # ifdef WINELIB16
21 #  undef WINELIB32
22 # else
23 #  define WINELIB32
24 # endif
25 #endif  /* __WINE__ */
26
27 /* Macros to map Winelib names to the correct implementation name */
28 /* depending on WINELIB16, WINELIB32 and UNICODE macros.          */
29
30 #ifdef __WINE__
31 # define WINELIB_NAME(func)      this is a syntax error
32 # define WINELIB_NAME_AW(func)   this is a syntax error
33 #else  /* __WINE__ */
34 # ifdef WINELIB32
35 #  define WINELIB_NAME(func)     func##32
36 #  ifdef UNICODE
37 #   define WINELIB_NAME_AW(func) func##32W
38 #  else
39 #   define WINELIB_NAME_AW(func) func##32A
40 #  endif  /* UNICODE */
41 # else   /* WINELIB32 */
42 #  define WINELIB_NAME(func)     func##16
43 #  define WINELIB_NAME_AW(func)  func##16
44 # endif  /* WINELIB32 */
45 #endif  /* __WINE__ */
46
47 #ifdef __WINE__
48 # define DECL_WINELIB_TYPE(type)     /* nothing */
49 # define DECL_WINELIB_TYPE_AW(type)  /* nothing */
50 #else   /* __WINE__ */
51 # define DECL_WINELIB_TYPE(type)     typedef WINELIB_NAME(type) type
52 # define DECL_WINELIB_TYPE_AW(type)  typedef WINELIB_NAME_AW(type) type
53 #endif  /* __WINE__ */
54
55
56 /* Calling conventions definitions */
57
58 #ifdef __i386__
59 # if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ >= 7)
60 #  define __stdcall __attribute__((__stdcall__))
61 #  define __cdecl   __attribute__((__cdecl__))
62 #  define __RESTORE_ES  __asm__ __volatile__("pushl %ds\n\tpopl %es")
63 # else
64 #  error You need gcc >= 2.7 to build Wine on a 386
65 # endif  /* __GNUC__ */
66 #else  /* __i386__ */
67 # define __stdcall
68 # define __cdecl
69 # define __RESTORE_ES
70 #endif  /* __i386__ */
71
72 #define CALLBACK    __stdcall
73 #define WINAPI      __stdcall
74 #define APIPRIVATE  __stdcall
75 #define PASCAL      __stdcall
76 #define _pascal     __stdcall
77 #define __export    __stdcall
78 #define WINAPIV     __cdecl
79 #define APIENTRY    WINAPI
80
81
82 /* Standard data types. These are the same for emulator and library. */
83
84 typedef void            VOID;
85 typedef short           INT16;
86 typedef unsigned short  UINT16;
87 typedef int             INT32;
88 typedef unsigned int    UINT32;
89 typedef unsigned short  WORD;
90 typedef unsigned long   DWORD;
91 typedef unsigned long   ULONG;
92 typedef unsigned char   BYTE;
93 typedef long            LONG;
94 typedef char            CHAR;
95 /* Some systems might have wchar_t, but we really need 16 bit characters */
96 typedef unsigned short  WCHAR;
97 typedef unsigned short  BOOL16;
98 typedef int             BOOL32;
99
100 /* Integer types. These are the same for emulator and library. */
101
102 typedef UINT16          HANDLE16;
103 typedef UINT32          HANDLE32;
104 typedef UINT16          WPARAM16;
105 typedef UINT32          WPARAM32;
106 typedef LONG            LPARAM;
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 DWORD           LCID;
116 typedef WORD            LANGID;
117 typedef DWORD           LCTYPE;
118 typedef float           FLOAT;
119
120 /* Pointers types. These are the same for emulator and library. */
121
122 typedef CHAR           *LPSTR;
123 typedef const CHAR     *LPCSTR;
124 typedef WCHAR          *LPWSTR;
125 typedef const WCHAR    *LPCWSTR;
126 typedef BYTE           *LPBYTE;
127 typedef WORD           *LPWORD;
128 typedef DWORD          *LPDWORD;
129 typedef LONG           *LPLONG;
130 typedef VOID           *LPVOID;
131 typedef const VOID     *LPCVOID;
132 typedef INT16          *LPINT16;
133 typedef UINT16         *LPUINT16;
134 typedef INT32          *LPINT32;
135 typedef UINT32         *LPUINT32;
136 typedef HKEY           *LPHKEY;
137 typedef FLOAT          *LPFLOAT;
138
139 /* Special case: a segmented pointer is just a pointer in the user's code. */
140
141 #ifdef __WINE__
142 typedef DWORD SEGPTR;
143 #else
144 typedef void* SEGPTR;
145 #endif /* __WINE__ */
146
147 /* Handle types that exist both in Win16 and Win32. */
148
149 #define DECLARE_HANDLE(a)  typedef HANDLE16 a##16; typedef HANDLE32 a##32
150 DECLARE_HANDLE(HACCEL);
151 DECLARE_HANDLE(HBITMAP);
152 DECLARE_HANDLE(HBRUSH);
153 DECLARE_HANDLE(HCURSOR);
154 DECLARE_HANDLE(HDC);
155 DECLARE_HANDLE(HDROP);
156 DECLARE_HANDLE(HDRVR);
157 DECLARE_HANDLE(HDWP);
158 DECLARE_HANDLE(HFILE);
159 DECLARE_HANDLE(HFONT);
160 DECLARE_HANDLE(HGDIOBJ);
161 DECLARE_HANDLE(HGLOBAL);
162 DECLARE_HANDLE(HICON);
163 DECLARE_HANDLE(HINSTANCE);
164 DECLARE_HANDLE(HLOCAL);
165 DECLARE_HANDLE(HMENU);
166 DECLARE_HANDLE(HMETAFILE);
167 DECLARE_HANDLE(HMIDI);
168 DECLARE_HANDLE(HMIDIIN);
169 DECLARE_HANDLE(HMIDIOUT);
170 DECLARE_HANDLE(HMIXER);
171 DECLARE_HANDLE(HMIXEROBJ);
172 DECLARE_HANDLE(HMMIO);
173 DECLARE_HANDLE(HMODULE);
174 DECLARE_HANDLE(HPALETTE);
175 DECLARE_HANDLE(HPEN);
176 DECLARE_HANDLE(HQUEUE);
177 DECLARE_HANDLE(HRGN);
178 DECLARE_HANDLE(HRSRC);
179 DECLARE_HANDLE(HTASK);
180 DECLARE_HANDLE(HWAVE);
181 DECLARE_HANDLE(HWAVEIN);
182 DECLARE_HANDLE(HWAVEOUT);
183 DECLARE_HANDLE(HWND);
184 DECLARE_HANDLE(HKL);
185 #undef DECLARE_HANDLE
186
187 /* Callback function pointers types */
188
189 typedef LRESULT (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
190 typedef LRESULT (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
191 DECL_WINELIB_TYPE(DLGPROC);
192 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
193 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
194 DECL_WINELIB_TYPE(DRIVERPROC);
195 typedef INT16   (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
196 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
197 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
198 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC);
199 typedef LRESULT (CALLBACK *FARPROC16)();
200 typedef LRESULT (CALLBACK *FARPROC32)();
201 DECL_WINELIB_TYPE(FARPROC);
202 typedef INT16   (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
203 typedef INT32   (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
204 DECL_WINELIB_TYPE(GOBJENUMPROC);
205 typedef BOOL16  (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
206 typedef BOOL32  (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
207 DECL_WINELIB_TYPE(GRAYSTRINGPROC);
208 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
209 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
210 DECL_WINELIB_TYPE(HOOKPROC);
211 typedef VOID    (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
212 typedef VOID    (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
213 DECL_WINELIB_TYPE(LINEDDAPROC);
214 typedef BOOL16  (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
215 typedef BOOL32  (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
216 typedef BOOL32  (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
217 DECL_WINELIB_TYPE_AW(PROPENUMPROC);
218 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
219 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
220 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX);
221 typedef VOID    (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
222 typedef VOID    (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
223 DECL_WINELIB_TYPE(TIMERPROC);
224 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
225 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
226 DECL_WINELIB_TYPE(WNDENUMPROC);
227 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
228 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
229 DECL_WINELIB_TYPE(WNDPROC);
230
231 /* TCHAR data types definitions for Winelib. */
232 /* These types are _not_ defined for the emulator, because they */
233 /* depend on the UNICODE macro that only exists in user's code. */
234
235 #ifndef __WINE__
236 # if defined(WINELIB32) && defined(UNICODE)
237 typedef WCHAR TCHAR;
238 typedef LPWSTR LPTSTR;
239 typedef LPCWSTR LPCTSTR;
240 # else  /* WINELIB32 && UNICODE */
241 typedef CHAR TCHAR;
242 typedef LPSTR LPTSTR;
243 typedef LPCSTR LPCTSTR;
244 # endif /* WINELIB32 && UNICODE */
245 #endif   /* __WINE__ */
246
247 /* Data types specific to the library. These do _not_ exist in the emulator. */
248
249 DECL_WINELIB_TYPE(INT);
250 DECL_WINELIB_TYPE(LPINT);
251 DECL_WINELIB_TYPE(LPUINT);
252 DECL_WINELIB_TYPE(UINT);
253 DECL_WINELIB_TYPE(BOOL);
254 DECL_WINELIB_TYPE(WPARAM);
255
256 DECL_WINELIB_TYPE(HACCEL);
257 DECL_WINELIB_TYPE(HANDLE);
258 DECL_WINELIB_TYPE(HBITMAP);
259 DECL_WINELIB_TYPE(HBRUSH);
260 DECL_WINELIB_TYPE(HCURSOR);
261 DECL_WINELIB_TYPE(HDC);
262 DECL_WINELIB_TYPE(HDROP);
263 DECL_WINELIB_TYPE(HDRVR);
264 DECL_WINELIB_TYPE(HDWP);
265 DECL_WINELIB_TYPE(HFILE);
266 DECL_WINELIB_TYPE(HFONT);
267 DECL_WINELIB_TYPE(HGDIOBJ);
268 DECL_WINELIB_TYPE(HGLOBAL);
269 DECL_WINELIB_TYPE(HICON);
270 DECL_WINELIB_TYPE(HINSTANCE);
271 DECL_WINELIB_TYPE(HLOCAL);
272 DECL_WINELIB_TYPE(HMENU);
273 DECL_WINELIB_TYPE(HMETAFILE);
274 DECL_WINELIB_TYPE(HMIDI);
275 DECL_WINELIB_TYPE(HMIDIIN);
276 DECL_WINELIB_TYPE(HMIDIOUT);
277 DECL_WINELIB_TYPE(HMMIO);
278 DECL_WINELIB_TYPE(HMODULE);
279 DECL_WINELIB_TYPE(HPALETTE);
280 DECL_WINELIB_TYPE(HPEN);
281 DECL_WINELIB_TYPE(HQUEUE);
282 DECL_WINELIB_TYPE(HRGN);
283 DECL_WINELIB_TYPE(HRSRC);
284 DECL_WINELIB_TYPE(HTASK);
285 DECL_WINELIB_TYPE(HWAVE);
286 DECL_WINELIB_TYPE(HWAVEIN);
287 DECL_WINELIB_TYPE(HWAVEOUT);
288 DECL_WINELIB_TYPE(HWND);
289
290 /* Misc. constants. */
291
292 #ifdef FALSE
293 #undef FALSE
294 #endif
295 #define FALSE 0
296
297 #ifdef TRUE
298 #undef TRUE
299 #endif
300 #define TRUE  1
301
302 #ifdef NULL
303 #undef NULL
304 #endif
305 #define NULL  0
306
307 /* Define some empty macros for compatibility with Windows code. */
308
309 #ifndef __WINE__
310 #define NEAR
311 #define FAR
312 #define _far
313 #define _near
314 #endif  /* __WINE__ */
315
316 /* Macro for structure packing. */
317
318 #ifdef __GNUC__
319 #define WINE_PACKED __attribute__ ((packed))
320 #else
321 #define WINE_PACKED  /* nothing */
322 #endif
323
324 /* Macros to split words and longs. */
325
326 #define LOBYTE(w)              ((BYTE)(WORD)(w))
327 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
328
329 #define LOWORD(l)              ((WORD)(DWORD)(l))
330 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
331
332 #define SLOWORD(l)             ((INT16)(LONG)(l))
333 #define SHIWORD(l)             ((INT16)((LONG)(l) >> 16))
334
335 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | \
336                                        (((DWORD)((WORD)(high))) << 16)))
337 #define MAKELPARAM(low,high)   ((LPARAM)MAKELONG(low,high))
338 #define MAKEWPARAM(low,high)   ((WPARAM32)MAKELONG(low,high))
339 #define MAKEINTATOM(atom)      ((LPCSTR)MAKELONG((atom),0))
340
341 #define SELECTOROF(ptr)     (HIWORD(ptr))
342 #define OFFSETOF(ptr)       (LOWORD(ptr))
343
344 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
345
346 #ifdef __i386__
347 #define PUT_WORD(ptr,w)   (*(WORD *)(ptr) = (w))
348 #define GET_WORD(ptr)     (*(WORD *)(ptr))
349 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
350 #define GET_DWORD(ptr)    (*(DWORD *)(ptr))
351 #else
352 #define PUT_WORD(ptr,w)   (*(BYTE *)(ptr) = LOBYTE(w), \
353                            *((BYTE *)(ptr) + 1) = HIBYTE(w))
354 #define GET_WORD(ptr)     ((WORD)(*(BYTE *)(ptr) | \
355                                   (WORD)(*((BYTE *)(ptr)+1) << 8)))
356 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
357                            PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
358 #define GET_DWORD(ptr)    ((DWORD)(GET_WORD(ptr) | \
359                                    ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
360 #endif  /* __i386__ */
361
362 /* MIN and MAX macros */
363
364 #ifdef MAX
365 #undef MAX
366 #endif
367 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
368
369 #ifdef MIN
370 #undef MIN
371 #endif
372 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
373
374 /* Winelib run-time flag */
375
376 #ifdef __WINE__
377 extern int __winelib;
378 #endif  /* __WINE__ */
379
380 #endif /* __WINE_WINTYPES_H */