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