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