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