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