Added a WINE_NO_UNICODE_MACROS define to allow Winelib apps to switch
[wine] / include / windef.h
1 /*
2  * Basic types definitions
3  *
4  * Copyright 1996 Alexandre Julliard
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #ifndef _WINDEF_
22 #define _WINDEF_
23
24 #ifndef WINVER
25 #define WINVER 0x0500
26 #endif
27
28 #ifndef NO_STRICT
29 # ifndef STRICT
30 #  define STRICT
31 # endif /* STRICT */
32 #endif /* NO_STRICT */
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 /* Calling conventions definitions */
39
40 #if defined(__i386__) && !defined(_X86_)
41 # define _X86_
42 #endif
43
44 #ifndef __stdcall
45 # ifdef __i386__
46 #  ifdef __GNUC__
47 #   define __stdcall __attribute__((__stdcall__))
48 #  elif defined(_MSC_VER)
49     /* Nothing needs to be done. __stdcall already exists */
50 #  else
51 #   error You need to define __stdcall for your compiler
52 #  endif
53 # else  /* __i386__ */
54 #  define __stdcall
55 # endif  /* __i386__ */
56 #endif /* __stdcall */
57
58 #ifndef __cdecl
59 # if defined(__i386__) && defined(__GNUC__)
60 #  define __cdecl __attribute__((__cdecl__))
61 # elif !defined(_MSC_VER)
62 #  define __cdecl
63 # endif
64 #endif /* __cdecl */
65
66 #ifdef __WINESRC__
67 #define __ONLY_IN_WINELIB(x)    do_not_use_this_in_wine
68 #else
69 #define __ONLY_IN_WINELIB(x)    x
70 #endif
71
72 #ifndef pascal
73 #define pascal      __ONLY_IN_WINELIB(__stdcall)
74 #endif
75 #ifndef _pascal
76 #define _pascal     __ONLY_IN_WINELIB(__stdcall)
77 #endif
78 #ifndef _stdcall
79 #define _stdcall    __ONLY_IN_WINELIB(__stdcall)
80 #endif
81 #ifndef _fastcall
82 #define _fastcall   __ONLY_IN_WINELIB(__stdcall)
83 #endif
84 #ifndef __fastcall
85 #define __fastcall  __ONLY_IN_WINELIB(__stdcall)
86 #endif
87 #ifndef __export
88 #define __export    __ONLY_IN_WINELIB(__stdcall)
89 #endif
90 #ifndef cdecl
91 #define cdecl       __ONLY_IN_WINELIB(__cdecl)
92 #endif
93 #ifndef _cdecl
94 #define _cdecl      __ONLY_IN_WINELIB(__cdecl)
95 #endif
96
97 #ifndef near
98 #define near        __ONLY_IN_WINELIB()
99 #endif
100 #ifndef far
101 #define far         __ONLY_IN_WINELIB()
102 #endif
103 #ifndef _near
104 #define _near       __ONLY_IN_WINELIB()
105 #endif
106 #ifndef _far
107 #define _far        __ONLY_IN_WINELIB()
108 #endif
109 #ifndef NEAR
110 #define NEAR        __ONLY_IN_WINELIB()
111 #endif
112 #ifndef FAR
113 #define FAR         __ONLY_IN_WINELIB()
114 #endif
115
116 #ifndef _MSC_VER
117 # ifndef _declspec
118 #  define _declspec(x)    __ONLY_IN_WINELIB()
119 # endif
120 # ifndef __declspec
121 #  define __declspec(x)   __ONLY_IN_WINELIB()
122 # endif
123 #endif
124
125 #define CALLBACK    __stdcall
126 #define WINAPI      __stdcall
127 #define APIPRIVATE  __stdcall
128 #define PASCAL      __stdcall
129 #define CDECL       __cdecl
130 #define _CDECL      __cdecl
131 #define WINAPIV     __cdecl
132 #define APIENTRY    WINAPI
133 #define CONST       const
134
135 /* Misc. constants. */
136
137 #undef NULL
138 #ifdef __cplusplus
139 #define NULL  0
140 #else
141 #define NULL  ((void*)0)
142 #endif
143
144 #ifdef FALSE
145 #undef FALSE
146 #endif
147 #define FALSE 0
148
149 #ifdef TRUE
150 #undef TRUE
151 #endif
152 #define TRUE  1
153
154 #ifndef IN
155 #define IN
156 #endif
157
158 #ifndef OUT
159 #define OUT
160 #endif
161
162 #ifndef OPTIONAL
163 #define OPTIONAL
164 #endif
165
166 /* Standard data types */
167
168 typedef void                                   *LPVOID;
169 typedef const void                             *LPCVOID;
170 typedef int             BOOL,       *PBOOL,    *LPBOOL;
171 typedef unsigned char   BYTE,       *PBYTE,    *LPBYTE;
172 typedef unsigned char   UCHAR,      *PUCHAR;
173 typedef unsigned short  WORD,       *PWORD,    *LPWORD;
174 typedef unsigned short  USHORT,     *PUSHORT;
175 typedef int             INT,        *PINT,     *LPINT;
176 typedef unsigned int    UINT,       *PUINT;
177 typedef long                                   *LPLONG;
178 typedef unsigned long   DWORD,      *PDWORD,   *LPDWORD;
179 typedef unsigned long   ULONG,      *PULONG;
180 typedef float           FLOAT,      *PFLOAT;
181 typedef char                        *PSZ;
182
183 /* Macros to map Winelib names to the correct implementation name */
184 /* Note that Winelib is purely Win32.                             */
185
186 #ifdef __WINESRC__
187 #define WINE_NO_UNICODE_MACROS
188 #endif
189
190 #ifdef WINE_NO_UNICODE_MACROS
191 # define WINELIB_NAME_AW(func) \
192     func##_must_be_suffixed_with_W_or_A_in_this_context \
193     func##_must_be_suffixed_with_W_or_A_in_this_context
194 #else  /* WINE_NO_UNICODE_MACROS */
195 # ifdef UNICODE
196 #  define WINELIB_NAME_AW(func) func##W
197 # else
198 #  define WINELIB_NAME_AW(func) func##A
199 # endif
200 #endif  /* WINE_NO_UNICODE_MACROS */
201
202 #ifdef WINE_NO_UNICODE_MACROS
203 # define DECL_WINELIB_TYPE_AW(type)  /* nothing */
204 #else
205 # define DECL_WINELIB_TYPE_AW(type)  typedef WINELIB_NAME_AW(type) type;
206 #endif
207
208 #include <winnt.h>
209
210 /* Polymorphic types */
211
212 typedef UINT_PTR        WPARAM;
213 typedef LONG_PTR        LPARAM;
214 typedef LONG_PTR        LRESULT;
215
216 /* Integer types */
217
218 typedef WORD            ATOM;
219 typedef DWORD           COLORREF, *LPCOLORREF;
220
221
222 /* Handle types */
223
224 typedef int HFILE;
225 DECLARE_HANDLE(HACCEL);
226 DECLARE_HANDLE(HBITMAP);
227 DECLARE_HANDLE(HBRUSH);
228 DECLARE_HANDLE(HCOLORSPACE);
229 DECLARE_HANDLE(HDC);
230 DECLARE_HANDLE(HDESK);
231 DECLARE_HANDLE(HENHMETAFILE);
232 DECLARE_HANDLE(HFONT);
233 DECLARE_HANDLE(HGLRC);
234 DECLARE_HANDLE(HHOOK);
235 DECLARE_HANDLE(HICON);
236 DECLARE_HANDLE(HINSTANCE);
237 DECLARE_HANDLE(HKEY);
238 typedef HKEY *PHKEY;
239 DECLARE_HANDLE(HKL);
240 DECLARE_HANDLE(HMENU);
241 DECLARE_HANDLE(HMETAFILE);
242 DECLARE_HANDLE(HMONITOR);
243 DECLARE_HANDLE(HPALETTE);
244 DECLARE_HANDLE(HPEN);
245 DECLARE_HANDLE(HRGN);
246 DECLARE_HANDLE(HRSRC);
247 DECLARE_HANDLE(HTASK);
248 DECLARE_HANDLE(HWINEVENTHOOK);
249 DECLARE_HANDLE(HWINSTA);
250 DECLARE_HANDLE(HWND);
251
252 /* Handle types that must remain interchangeable even with strict on */
253
254 typedef HINSTANCE HMODULE;
255 typedef HANDLE HGDIOBJ;
256 typedef HANDLE HGLOBAL;
257 typedef HANDLE HLOCAL;
258 typedef HANDLE GLOBALHANDLE;
259 typedef HANDLE LOCALHANDLE;
260 typedef HICON HCURSOR;
261
262 /* Callback function pointers types */
263
264 typedef INT     (CALLBACK *FARPROC)();
265 typedef INT     (CALLBACK *PROC)();
266
267
268 /* Macros to split words and longs. */
269
270 #define LOBYTE(w)              ((BYTE)(WORD)(w))
271 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
272
273 #define LOWORD(l)              ((WORD)(DWORD)(l))
274 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
275
276 #define MAKEWORD(low,high)     ((WORD)(((BYTE)(low)) | ((WORD)((BYTE)(high))) << 8))
277 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | (((DWORD)((WORD)(high))) << 16)))
278
279 /* min and max macros */
280 #ifndef NOMINMAX
281 #ifndef max
282 #define max(a,b)   (((a) > (b)) ? (a) : (b))
283 #endif
284 #ifndef min
285 #define min(a,b)   (((a) < (b)) ? (a) : (b))
286 #endif
287 #endif  /* NOMINMAX */
288
289 #ifdef MAX_PATH /* Work-around for Mingw */ 
290 #undef MAX_PATH
291 #endif /* MAX_PATH */
292
293 #define MAX_PATH        260
294 #define HFILE_ERROR     ((HFILE)-1)
295
296 /* The SIZE structure */
297 typedef struct tagSIZE
298 {
299     LONG cx;
300     LONG cy;
301 } SIZE, *PSIZE, *LPSIZE;
302
303 typedef SIZE SIZEL, *PSIZEL, *LPSIZEL;
304
305 /* The POINT structure */
306 typedef struct tagPOINT
307 {
308     LONG  x;
309     LONG  y;
310 } POINT, *PPOINT, *LPPOINT;
311
312 typedef struct _POINTL
313 {
314     LONG x;
315     LONG y;
316 } POINTL, *PPOINTL;
317
318 /* The POINTS structure */
319
320 typedef struct tagPOINTS
321 {
322 #ifdef WORDS_BIGENDIAN
323     SHORT y;
324     SHORT x;
325 #else
326     SHORT x;
327     SHORT y;
328 #endif
329 } POINTS, *PPOINTS, *LPPOINTS;
330
331 /* The RECT structure */
332 typedef struct tagRECT
333 {
334     LONG left;
335     LONG top;
336     LONG right;
337     LONG bottom;
338 } RECT, *PRECT, *LPRECT;
339 typedef const RECT *LPCRECT;
340
341 typedef struct _RECTL
342 {
343     LONG left;
344     LONG top;
345     LONG right;
346     LONG bottom;
347 } RECTL, *PRECTL, *LPRECTL;
348
349 typedef const RECTL *LPCRECTL;
350
351 #ifdef __cplusplus
352 }
353 #endif
354
355 #endif /* _WINDEF_ */