Release 980927
[wine.git] / include / wintypes.h
blobe3d4596de29032594937444e0f5103da7c535097
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
21 # define WINELIB_NAME_AW(func) 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
66 /* Standard data types. These are the same for emulator and library. */
68 typedef void VOID;
69 typedef short INT16;
70 typedef unsigned short UINT16;
71 typedef int INT32;
72 typedef unsigned int UINT32;
73 typedef unsigned short WORD;
74 typedef unsigned long DWORD;
75 typedef unsigned long ULONG;
76 typedef unsigned char BYTE;
77 typedef long LONG;
78 typedef char CHAR;
79 /* Some systems might have wchar_t, but we really need 16 bit characters */
80 typedef unsigned short WCHAR;
81 typedef unsigned short BOOL16;
82 typedef int BOOL32;
84 /* Integer types. These are the same for emulator and library. */
86 typedef UINT16 HANDLE16;
87 typedef UINT32 HANDLE32;
88 typedef UINT16 WPARAM16;
89 typedef UINT32 WPARAM32;
90 typedef LONG LPARAM;
91 typedef LONG HRESULT;
92 typedef LONG LRESULT;
93 typedef WORD ATOM;
94 typedef WORD CATCHBUF[9];
95 typedef WORD *LPCATCHBUF;
96 typedef DWORD ACCESS_MASK;
97 typedef ACCESS_MASK REGSAM;
98 typedef HANDLE32 HHOOK;
99 typedef HANDLE32 HKEY;
100 typedef DWORD LCID;
101 typedef WORD LANGID;
102 typedef DWORD LCTYPE;
103 typedef float FLOAT;
105 /* Pointers types. These are the same for emulator and library. */
107 typedef CHAR *LPSTR;
108 typedef const CHAR *LPCSTR;
109 typedef WCHAR *LPWSTR;
110 typedef const WCHAR *LPCWSTR;
111 typedef BYTE *LPBYTE;
112 typedef WORD *LPWORD;
113 typedef DWORD *LPDWORD;
114 typedef LONG *LPLONG;
115 typedef VOID *LPVOID;
116 typedef const VOID *LPCVOID;
117 typedef INT16 *LPINT16;
118 typedef UINT16 *LPUINT16;
119 typedef INT32 *LPINT32;
120 typedef UINT32 *LPUINT32;
121 typedef HKEY *LPHKEY;
122 typedef FLOAT *LPFLOAT;
124 /* Special case: a segmented pointer is just a pointer in the user's code. */
126 #ifdef __WINE__
127 typedef DWORD SEGPTR;
128 #else
129 typedef void* SEGPTR;
130 #endif /* __WINE__ */
132 /* Handle types that exist both in Win16 and Win32. */
134 #define DECLARE_HANDLE(a) typedef HANDLE16 a##16; typedef HANDLE32 a##32
135 DECLARE_HANDLE(HACCEL);
136 DECLARE_HANDLE(HBITMAP);
137 DECLARE_HANDLE(HBRUSH);
138 DECLARE_HANDLE(HCOLORSPACE);
139 DECLARE_HANDLE(HCURSOR);
140 DECLARE_HANDLE(HDC);
141 DECLARE_HANDLE(HDROP);
142 DECLARE_HANDLE(HDRVR);
143 DECLARE_HANDLE(HDWP);
144 DECLARE_HANDLE(HENHMETAFILE);
145 DECLARE_HANDLE(HFILE);
146 DECLARE_HANDLE(HFONT);
147 DECLARE_HANDLE(HGDIOBJ);
148 DECLARE_HANDLE(HGLOBAL);
149 DECLARE_HANDLE(HICON);
150 DECLARE_HANDLE(HINSTANCE);
151 DECLARE_HANDLE(HLOCAL);
152 DECLARE_HANDLE(HMENU);
153 DECLARE_HANDLE(HMETAFILE);
154 DECLARE_HANDLE(HMIDI);
155 DECLARE_HANDLE(HMIDIIN);
156 DECLARE_HANDLE(HMIDIOUT);
157 DECLARE_HANDLE(HMIXER);
158 DECLARE_HANDLE(HMIXEROBJ);
159 DECLARE_HANDLE(HMMIO);
160 DECLARE_HANDLE(HMODULE);
161 DECLARE_HANDLE(HPALETTE);
162 DECLARE_HANDLE(HPEN);
163 DECLARE_HANDLE(HQUEUE);
164 DECLARE_HANDLE(HRGN);
165 DECLARE_HANDLE(HRSRC);
166 DECLARE_HANDLE(HTASK);
167 DECLARE_HANDLE(HWAVE);
168 DECLARE_HANDLE(HWAVEIN);
169 DECLARE_HANDLE(HWAVEOUT);
170 DECLARE_HANDLE(HWND);
171 DECLARE_HANDLE(HKL);
172 DECLARE_HANDLE(HIC);
173 #undef DECLARE_HANDLE
175 /* Callback function pointers types */
177 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32A)(LPSTR);
178 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32W)(LPWSTR);
179 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
180 typedef LRESULT (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
181 typedef LRESULT (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
182 DECL_WINELIB_TYPE(DLGPROC)
183 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
184 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
185 DECL_WINELIB_TYPE(DRIVERPROC)
186 typedef INT16 (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
187 typedef INT32 (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
188 typedef INT32 (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
189 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
190 typedef LRESULT (CALLBACK *FARPROC16)();
191 typedef LRESULT (CALLBACK *FARPROC32)();
192 DECL_WINELIB_TYPE(FARPROC)
193 typedef INT16 (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
194 typedef INT32 (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
195 DECL_WINELIB_TYPE(GOBJENUMPROC)
196 typedef BOOL16 (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
197 typedef BOOL32 (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
198 DECL_WINELIB_TYPE(GRAYSTRINGPROC)
199 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
200 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
201 DECL_WINELIB_TYPE(HOOKPROC)
202 typedef VOID (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
203 typedef VOID (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
204 DECL_WINELIB_TYPE(LINEDDAPROC)
205 typedef BOOL16 (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
206 typedef BOOL32 (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
207 typedef BOOL32 (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
208 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
209 typedef BOOL32 (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
210 typedef BOOL32 (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
211 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
212 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32A)(LPSTR);
213 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32W)(LPWSTR);
214 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
215 typedef VOID (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
216 typedef VOID (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
217 DECL_WINELIB_TYPE(TIMERPROC)
218 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
219 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
220 DECL_WINELIB_TYPE(WNDENUMPROC)
221 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
222 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
223 DECL_WINELIB_TYPE(WNDPROC)
225 /* TCHAR data types definitions for Winelib. */
226 /* These types are _not_ defined for the emulator, because they */
227 /* depend on the UNICODE macro that only exists in user's code. */
229 #ifndef __WINE__
230 # ifdef UNICODE
231 typedef WCHAR TCHAR;
232 typedef LPWSTR LPTSTR;
233 typedef LPCWSTR LPCTSTR;
234 # else /* UNICODE */
235 typedef CHAR TCHAR;
236 typedef LPSTR LPTSTR;
237 typedef LPCSTR LPCTSTR;
238 # endif /* UNICODE */
239 #endif /* __WINE__ */
241 /* Data types specific to the library. These do _not_ exist in the emulator. */
243 DECL_WINELIB_TYPE(INT)
244 DECL_WINELIB_TYPE(LPINT)
245 DECL_WINELIB_TYPE(LPUINT)
246 DECL_WINELIB_TYPE(UINT)
247 DECL_WINELIB_TYPE(BOOL)
248 DECL_WINELIB_TYPE(WPARAM)
250 DECL_WINELIB_TYPE(HACCEL)
251 DECL_WINELIB_TYPE(HANDLE)
252 DECL_WINELIB_TYPE(HBITMAP)
253 DECL_WINELIB_TYPE(HBRUSH)
254 DECL_WINELIB_TYPE(HCOLORSPACE)
255 DECL_WINELIB_TYPE(HCURSOR)
256 DECL_WINELIB_TYPE(HDC)
257 DECL_WINELIB_TYPE(HDROP)
258 DECL_WINELIB_TYPE(HDRVR)
259 DECL_WINELIB_TYPE(HDWP)
260 DECL_WINELIB_TYPE(HENHMETAFILE)
261 DECL_WINELIB_TYPE(HFILE)
262 DECL_WINELIB_TYPE(HFONT)
263 DECL_WINELIB_TYPE(HGDIOBJ)
264 DECL_WINELIB_TYPE(HGLOBAL)
265 DECL_WINELIB_TYPE(HICON)
266 DECL_WINELIB_TYPE(HINSTANCE)
267 DECL_WINELIB_TYPE(HLOCAL)
268 DECL_WINELIB_TYPE(HMENU)
269 DECL_WINELIB_TYPE(HMETAFILE)
270 DECL_WINELIB_TYPE(HMIDI)
271 DECL_WINELIB_TYPE(HMIDIIN)
272 DECL_WINELIB_TYPE(HMIDIOUT)
273 DECL_WINELIB_TYPE(HMMIO)
274 DECL_WINELIB_TYPE(HMODULE)
275 DECL_WINELIB_TYPE(HPALETTE)
276 DECL_WINELIB_TYPE(HPEN)
277 DECL_WINELIB_TYPE(HQUEUE)
278 DECL_WINELIB_TYPE(HRGN)
279 DECL_WINELIB_TYPE(HRSRC)
280 DECL_WINELIB_TYPE(HTASK)
281 DECL_WINELIB_TYPE(HWAVE)
282 DECL_WINELIB_TYPE(HWAVEIN)
283 DECL_WINELIB_TYPE(HWAVEOUT)
284 DECL_WINELIB_TYPE(HWND)
286 /* Misc. constants. */
288 #ifdef FALSE
289 #undef FALSE
290 #endif
291 #define FALSE 0
293 #ifdef TRUE
294 #undef TRUE
295 #endif
296 #define TRUE 1
298 #ifdef NULL
299 #undef NULL
300 #endif
301 #define NULL 0
303 /* Define some empty macros for compatibility with Windows code. */
305 #ifndef __WINE__
306 #define NEAR
307 #define FAR
308 #define _far
309 #define _near
310 #endif /* __WINE__ */
312 /* Macro for structure packing. */
314 #ifdef __GNUC__
315 #define WINE_PACKED __attribute__ ((packed))
316 #else
317 #define WINE_PACKED /* nothing */
318 #endif
320 /* Macros to split words and longs. */
322 #define LOBYTE(w) ((BYTE)(WORD)(w))
323 #define HIBYTE(w) ((BYTE)((WORD)(w) >> 8))
325 #define LOWORD(l) ((WORD)(DWORD)(l))
326 #define HIWORD(l) ((WORD)((DWORD)(l) >> 16))
328 #define SLOWORD(l) ((INT16)(LONG)(l))
329 #define SHIWORD(l) ((INT16)((LONG)(l) >> 16))
331 #define MAKELONG(low,high) ((LONG)(((WORD)(low)) | \
332 (((DWORD)((WORD)(high))) << 16)))
333 #define MAKELPARAM(low,high) ((LPARAM)MAKELONG(low,high))
334 #define MAKEWPARAM(low,high) ((WPARAM32)MAKELONG(low,high))
335 #define MAKEINTATOM(atom) ((LPCSTR)MAKELONG((atom),0))
337 #define SELECTOROF(ptr) (HIWORD(ptr))
338 #define OFFSETOF(ptr) (LOWORD(ptr))
340 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
342 #ifdef __i386__
343 #define PUT_WORD(ptr,w) (*(WORD *)(ptr) = (w))
344 #define GET_WORD(ptr) (*(WORD *)(ptr))
345 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
346 #define GET_DWORD(ptr) (*(DWORD *)(ptr))
347 #else
348 #define PUT_WORD(ptr,w) (*(BYTE *)(ptr) = LOBYTE(w), \
349 *((BYTE *)(ptr) + 1) = HIBYTE(w))
350 #define GET_WORD(ptr) ((WORD)(*(BYTE *)(ptr) | \
351 (WORD)(*((BYTE *)(ptr)+1) << 8)))
352 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
353 PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
354 #define GET_DWORD(ptr) ((DWORD)(GET_WORD(ptr) | \
355 ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
356 #endif /* __i386__ */
358 /* MIN and MAX macros */
360 #ifdef MAX
361 #undef MAX
362 #endif
363 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
365 #ifdef MIN
366 #undef MIN
367 #endif
368 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
370 /* Winelib run-time flag */
372 #ifdef __WINE__
373 extern int __winelib;
374 #endif /* __WINE__ */
376 #endif /* __WINE_WINTYPES_H */