include/windef.h

   1 /*
   2  * Basic types definitions
   3  *
   4  * Copyright 1996 Alexandre Julliard
   5  */
   6
   7 #ifndef __WINE_WINDEF_H
   8 #define __WINE_WINDEF_H
   9
  10 #ifdef __WINE__
  11 # include "config.h"
  12 # undef UNICODE
  13 #endif  /* __WINE__ */
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /* Misc. constants. */
  20
  21 #ifdef FALSE
  22 #undef FALSE
  23 #endif
  24 #define FALSE 0
  25
  26 #ifdef TRUE
  27 #undef TRUE
  28 #endif
  29 #define TRUE  1
  30
  31 #ifdef NULL
  32 #undef NULL
  33 #endif
  34 #define NULL  0
  35
  36 /* Macros to map Winelib names to the correct implementation name */
  37 /* depending on __WINE__ and UNICODE macros.                      */
  38 /* Note that Winelib is purely Win32.                             */
  39
  40 #ifdef __WINE__
  41 # define WINELIB_NAME_AW(func)   this_is_a_syntax_error this_is_a_syntax_error
  42 #else  /* __WINE__ */
  43 # ifdef UNICODE
  44 #  define WINELIB_NAME_AW(func) func##W
  45 # else
  46 #  define WINELIB_NAME_AW(func) func##A
  47 # endif  /* UNICODE */
  48 #endif  /* __WINE__ */
  49
  50 #ifdef __WINE__
  51 # define DECL_WINELIB_TYPE_AW(type)  /* nothing */
  52 #else   /* __WINE__ */
  53 # define DECL_WINELIB_TYPE_AW(type)  typedef WINELIB_NAME_AW(type) type;
  54 #endif  /* __WINE__ */
  55
  56
  57 /* Calling conventions definitions */
  58
  59 #ifdef __i386__
  60 # if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ >= 7)
  61 #  define __stdcall __attribute__((__stdcall__))
  62 #  define __cdecl   __attribute__((__cdecl__))
  63 #  define __RESTORE_ES  __asm__ __volatile__("pushl %ds\n\tpopl %es")
  64 # else
  65 #  error You need gcc >= 2.7 to build Wine on a 386
  66 # endif  /* __GNUC__ */
  67 #else  /* __i386__ */
  68 # define __stdcall
  69 # define __cdecl
  70 # define __RESTORE_ES
  71 #endif  /* __i386__ */
  72
  73 #define CALLBACK    __stdcall
  74 #define WINAPI      __stdcall
  75 #define APIPRIVATE  __stdcall
  76 #define PASCAL      __stdcall
  77 #define pascal      __stdcall
  78 #define _pascal     __stdcall
  79 #define _stdcall    __stdcall
  80 #define _fastcall   __stdcall
  81 #define __export    __stdcall
  82 #define CDECL       __cdecl
  83 #define _CDECL      __cdecl
  84 #define cdecl       __cdecl
  85 #define _cdecl      __cdecl
  86 #define WINAPIV     __cdecl
  87 #define APIENTRY    WINAPI
  88
  89 #define __declspec(x)
  90 #define dllimport
  91 #define dllexport
  92
  93 #define CONST       const
  94
  95 /* Standard data types. These are the same for emulator and library. */
  96
  97 typedef void            VOID;
  98 typedef short           INT16;
  99 typedef unsigned short  UINT16;
 100 typedef int             INT;
 101 typedef unsigned int    UINT;
 102 typedef unsigned short  WORD;
 103 typedef unsigned long   DWORD;
 104 typedef unsigned long   ULONG;
 105 typedef unsigned char   BYTE;
 106 typedef long            LONG;
 107 typedef short           SHORT;
 108 typedef unsigned short  USHORT;
 109 typedef char            CHAR;
 110 typedef unsigned char   UCHAR;
 111 /* Some systems might have wchar_t, but we really need 16 bit characters */
 112 typedef unsigned short  WCHAR;
 113 typedef unsigned short  BOOL16;
 114 typedef int             BOOL;
 115 typedef double          DATE;
 116 typedef long            LONG_PTR;
 117 typedef unsigned long   ULONG_PTR;
 118 typedef double          DOUBLE;
 119 typedef double          LONGLONG;
 120 typedef double          ULONGLONG;
 121
 122 /* FIXME: Wine does not compile with strict on, therefore strict
 123  * handles are presently only usable on machines where sizeof(UINT) ==
 124  * sizeof(void*).  HANDLEs are supposed to be void* but a large amount
 125  * of WINE code operates on HANDLES as if they are UINTs. So to WINE
 126  * they exist as UINTs but to the Winelib user who turns on strict,
 127  * they exist as void*. If there is a size difference between UINT and
 128  * void* then things get ugly.  */
 129 #ifdef STRICT
 130 typedef UINT16          HANDLE16;
 131 typedef VOID*           HANDLE;
 132 #else
 133 typedef UINT16          HANDLE16;
 134 typedef UINT            HANDLE;
 135 #endif
 136
 137 typedef HANDLE16       *LPHANDLE16;
 138 typedef HANDLE         *LPHANDLE;
 139
 140 /* Integer types. These are the same for emulator and library. */
 141 typedef UINT16          WPARAM16;
 142 typedef UINT            WPARAM;
 143 typedef LONG            LPARAM;
 144 typedef LONG            HRESULT;
 145 typedef LONG            LRESULT;
 146 typedef WORD            ATOM;
 147 typedef WORD            CATCHBUF[9];
 148 typedef WORD           *LPCATCHBUF;
 149 typedef DWORD           ACCESS_MASK;
 150 typedef ACCESS_MASK     REGSAM;
 151 typedef HANDLE          HHOOK;
 152 typedef HANDLE          HMONITOR;
 153 typedef DWORD           LCID;
 154 typedef WORD            LANGID;
 155 typedef DWORD           LCTYPE;
 156 typedef float           FLOAT;
 157 typedef long long       __int64;
 158
 159 /* Pointers types. These are the same for emulator and library. */
 160 /* winnt types */
 161 typedef VOID           *PVOID;
 162 typedef const void     *PCVOID;
 163 typedef CHAR           *PCHAR;
 164 typedef UCHAR          *PUCHAR;
 165 typedef BYTE           *PBYTE;
 166 typedef ULONG          *PULONG;
 167 typedef LONG           *PLONG;
 168 typedef DWORD          *PDWORD;
 169 /* common win32 types */
 170 typedef CHAR           *LPSTR;
 171 typedef CHAR           *PSTR;
 172 typedef const CHAR     *LPCSTR;
 173 typedef const CHAR     *PCSTR;
 174 typedef WCHAR          *LPWSTR;
 175 typedef WCHAR          *PWSTR;
 176 typedef const WCHAR    *LPCWSTR;
 177 typedef const WCHAR    *PCWSTR;
 178 typedef BYTE           *LPBYTE;
 179 typedef WORD           *LPWORD;
 180 typedef DWORD          *LPDWORD;
 181 typedef LONG           *LPLONG;
 182 typedef VOID           *LPVOID;
 183 typedef const VOID     *LPCVOID;
 184 typedef INT16          *LPINT16;
 185 typedef UINT16         *LPUINT16;
 186 typedef INT            *PINT;
 187 typedef INT            *LPINT;
 188 typedef UINT           *PUINT;
 189 typedef UINT           *LPUINT;
 190 typedef FLOAT          *PFLOAT;
 191 typedef FLOAT          *LPFLOAT;
 192 typedef BOOL           *PBOOL;
 193 typedef BOOL           *LPBOOL;
 194
 195 /* Special case: a segmented pointer is just a pointer in the user's code. */
 196
 197 #ifdef __WINE__
 198 typedef DWORD SEGPTR;
 199 #else
 200 typedef void* SEGPTR;
 201 #endif /* __WINE__ */
 202
 203 /* Handle types that exist both in Win16 and Win32. */
 204
 205 #ifdef STRICT
 206 #define DECLARE_HANDLE(a) \
 207         typedef HANDLE16 a##16; \
 208         typedef a##16 *P##a##16; \
 209         typedef a##16 *NP##a##16; \
 210         typedef a##16 *LP##a##16; \
 211         typedef struct a##__ { int unused; } *a; \
 212         typedef a *P##a; \
 213         typedef a *LP##a
 214 #else /*STRICT*/
 215 #define DECLARE_HANDLE(a) \
 216         typedef HANDLE16 a##16; \
 217         typedef a##16 *P##a##16; \
 218         typedef a##16 *NP##a##16; \
 219         typedef a##16 *LP##a##16; \
 220         typedef HANDLE a; \
 221         typedef a *P##a; \
 222         typedef a *LP##a
 223 #endif /*STRICT*/
 224
 225 DECLARE_HANDLE(HACMDRIVERID);
 226 DECLARE_HANDLE(HACMDRIVER);
 227 DECLARE_HANDLE(HACMOBJ);
 228 DECLARE_HANDLE(HACMSTREAM);
 229 DECLARE_HANDLE(HMETAFILEPICT);
 230
 231 DECLARE_HANDLE(HACCEL);
 232 DECLARE_HANDLE(HBITMAP);
 233 DECLARE_HANDLE(HBRUSH);
 234 DECLARE_HANDLE(HCOLORSPACE);
 235 DECLARE_HANDLE(HCURSOR);
 236 DECLARE_HANDLE(HDC);
 237 DECLARE_HANDLE(HDROP);
 238 DECLARE_HANDLE(HDRVR);
 239 DECLARE_HANDLE(HDWP);
 240 DECLARE_HANDLE(HENHMETAFILE);
 241 DECLARE_HANDLE(HFILE);
 242 DECLARE_HANDLE(HFONT);
 243 DECLARE_HANDLE(HICON);
 244 DECLARE_HANDLE(HINSTANCE);
 245 DECLARE_HANDLE(HKEY);
 246 DECLARE_HANDLE(HMENU);
 247 DECLARE_HANDLE(HMETAFILE);
 248 DECLARE_HANDLE(HMIDI);
 249 DECLARE_HANDLE(HMIDIIN);
 250 DECLARE_HANDLE(HMIDIOUT);
 251 DECLARE_HANDLE(HMIDISTRM);
 252 DECLARE_HANDLE(HMIXER);
 253 DECLARE_HANDLE(HMIXEROBJ);
 254 DECLARE_HANDLE(HMMIO);
 255 DECLARE_HANDLE(HPALETTE);
 256 DECLARE_HANDLE(HPEN);
 257 DECLARE_HANDLE(HQUEUE);
 258 DECLARE_HANDLE(HRGN);
 259 DECLARE_HANDLE(HRSRC);
 260 DECLARE_HANDLE(HTASK);
 261 DECLARE_HANDLE(HWAVE);
 262 DECLARE_HANDLE(HWAVEIN);
 263 DECLARE_HANDLE(HWAVEOUT);
 264 DECLARE_HANDLE(HWINSTA);
 265 DECLARE_HANDLE(HDESK);
 266 DECLARE_HANDLE(HWND);
 267 DECLARE_HANDLE(HKL);
 268 DECLARE_HANDLE(HIC);
 269 DECLARE_HANDLE(HRASCONN);
 270 #undef DECLARE_HANDLE
 271
 272 /* Handle types that must remain interchangeable even with strict on */
 273
 274 typedef HINSTANCE16 HMODULE16;
 275 typedef HINSTANCE HMODULE;
 276 typedef HANDLE16 HGDIOBJ16;
 277 typedef HANDLE16 HGLOBAL16;
 278 typedef HANDLE16 HLOCAL16;
 279 typedef HANDLE HGDIOBJ;
 280 typedef HANDLE HGLOBAL;
 281 typedef HANDLE HLOCAL;
 282
 283 /* Callback function pointers types */
 284
 285 typedef BOOL    (CALLBACK* DATEFMT_ENUMPROCA)(LPSTR);
 286 typedef BOOL    (CALLBACK* DATEFMT_ENUMPROCW)(LPWSTR);
 287 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
 288 typedef BOOL16  (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 289 typedef BOOL    (CALLBACK *DLGPROC)(HWND,UINT,WPARAM,LPARAM);
 290 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
 291 typedef LRESULT (CALLBACK *DRIVERPROC)(DWORD,HDRVR,UINT,LPARAM,LPARAM);
 292 typedef INT16   (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
 293 typedef INT     (CALLBACK *EDITWORDBREAKPROCA)(LPSTR,INT,INT,INT);
 294 typedef INT     (CALLBACK *EDITWORDBREAKPROCW)(LPWSTR,INT,INT,INT);
 295 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
 296 typedef LRESULT (CALLBACK *FARPROC16)();
 297 typedef LRESULT (CALLBACK *FARPROC)();
 298 typedef INT16   (CALLBACK *PROC16)();
 299 typedef INT     (CALLBACK *PROC)();
 300 typedef BOOL16  (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
 301 typedef BOOL    (CALLBACK *GRAYSTRINGPROC)(HDC,LPARAM,INT);
 302 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
 303 typedef LRESULT (CALLBACK *HOOKPROC)(INT,WPARAM,LPARAM);
 304 typedef BOOL16  (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
 305 typedef BOOL    (CALLBACK *PROPENUMPROCA)(HWND,LPCSTR,HANDLE);
 306 typedef BOOL    (CALLBACK *PROPENUMPROCW)(HWND,LPCWSTR,HANDLE);
 307 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
 308 typedef BOOL    (CALLBACK *PROPENUMPROCEXA)(HWND,LPCSTR,HANDLE,LPARAM);
 309 typedef BOOL    (CALLBACK *PROPENUMPROCEXW)(HWND,LPCWSTR,HANDLE,LPARAM);
 310 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
 311 typedef BOOL    (CALLBACK* TIMEFMT_ENUMPROCA)(LPSTR);
 312 typedef BOOL    (CALLBACK* TIMEFMT_ENUMPROCW)(LPWSTR);
 313 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
 314 typedef VOID    (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
 315 typedef VOID    (CALLBACK *TIMERPROC)(HWND,UINT,UINT,DWORD);
 316 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
 317 typedef LRESULT (CALLBACK *WNDENUMPROC)(HWND,LPARAM);
 318 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 319 typedef LRESULT (CALLBACK *WNDPROC)(HWND,UINT,WPARAM,LPARAM);
 320
 321 /* Define some empty macros for compatibility with Windows code. */
 322
 323 #ifndef __WINE__
 324 #define NEAR
 325 #define FAR
 326 #define near
 327 #define far
 328 #define _near
 329 #define _far
 330 #define IN
 331 #define OUT
 332 #define OPTIONAL
 333 #endif  /* __WINE__ */
 334
 335 /* Macro for structure packing. */
 336
 337 #ifdef __GNUC__
 338 #define WINE_PACKED __attribute__ ((packed))
 339 #define WINE_UNUSED __attribute__ ((unused))
 340 #else
 341 #define WINE_PACKED  /* nothing */
 342 #define WINE_UNUSED  /* nothing */
 343 #endif
 344
 345 /* Macros to split words and longs. */
 346
 347 #define LOBYTE(w)              ((BYTE)(WORD)(w))
 348 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
 349
 350 #define LOWORD(l)              ((WORD)(DWORD)(l))
 351 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
 352
 353 #define SLOWORD(l)             ((INT16)(LONG)(l))
 354 #define SHIWORD(l)             ((INT16)((LONG)(l) >> 16))
 355
 356 #define MAKEWORD(low,high)     ((WORD)(((BYTE)(low)) | ((WORD)((BYTE)(high))) << 8))
 357 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | (((DWORD)((WORD)(high))) << 16)))
 358 #define MAKELPARAM(low,high)   ((LPARAM)MAKELONG(low,high))
 359 #define MAKEWPARAM(low,high)   ((WPARAM)MAKELONG(low,high))
 360 #define MAKELRESULT(low,high)  ((LRESULT)MAKELONG(low,high))
 361 #define MAKEINTATOM(atom)      ((LPCSTR)MAKELONG((atom),0))
 362
 363 #define SELECTOROF(ptr)     (HIWORD(ptr))
 364 #define OFFSETOF(ptr)       (LOWORD(ptr))
 365
 366 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
 367 /* Note: These macros are semantically broken, at least for wrc.  wrc
 368    spits out data in the platform's current binary format, *not* in
 369    little-endian format.  These macros are used throughout the resource
 370    code to load and store data to the resources.  Since it is unlikely
 371    that we'll ever be dealing with little-endian resource data, the
 372    byte-swapping nature of these macros has been disabled.  Rather than
 373    remove the use of these macros from the resource loading code, the
 374    macros have simply been disabled.  In the future, someone may want
 375    to reactivate these macros for other purposes.  In that case, the
 376    resource code will have to be modified to use different macros. */
 377
 378 #if 1
 379 #define PUT_WORD(ptr,w)   (*(WORD *)(ptr) = (w))
 380 #define GET_WORD(ptr)     (*(WORD *)(ptr))
 381 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
 382 #define GET_DWORD(ptr)    (*(DWORD *)(ptr))
 383 #else
 384 #define PUT_WORD(ptr,w)   (*(BYTE *)(ptr) = LOBYTE(w), \
 385                            *((BYTE *)(ptr) + 1) = HIBYTE(w))
 386 #define GET_WORD(ptr)     ((WORD)(*(BYTE *)(ptr) | \
 387                                   (WORD)(*((BYTE *)(ptr)+1) << 8)))
 388 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
 389                            PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
 390 #define GET_DWORD(ptr)    ((DWORD)(GET_WORD(ptr) | \
 391                                    ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
 392 #endif  /* 1 */
 393
 394 /* MIN and MAX macros */
 395
 396 #ifdef MAX
 397 #undef MAX
 398 #endif
 399 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
 400
 401 #ifdef MIN
 402 #undef MIN
 403 #endif
 404 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
 405
 406 #define __max(a,b) MAX(a,b)
 407 #define __min(a,b) MIN(a,b)
 408 #define max(a,b)   MAX(a,b)
 409 #define min(a,b)   MIN(a,b)
 410
 411 #define _MAX_PATH  260
 412 #define MAX_PATH   260
 413 #define _MAX_DRIVE 3
 414 #define _MAX_DIR   256
 415 #define _MAX_FNAME 255
 416 #define _MAX_EXT   256
 417
 418 #define HFILE_ERROR16   ((HFILE16)-1)
 419 #define HFILE_ERROR     ((HFILE)-1)
 420
 421 /* Winelib run-time flag */
 422
 423 #ifdef __WINE__
 424 extern int __winelib;
 425 #endif  /* __WINE__ */
 426
 427 /* The SIZE structure */
 428
 429 typedef struct
 430 {
 431     INT16  cx;
 432     INT16  cy;
 433 } SIZE16, *PSIZE16, *LPSIZE16;
 434
 435 typedef struct tagSIZE
 436 {
 437     INT  cx;
 438     INT  cy;
 439 } SIZE, *PSIZE, *LPSIZE;
 440
 441
 442 typedef SIZE SIZEL, *PSIZEL, *LPSIZEL;
 443
 444 #define CONV_SIZE16TO32(s16,s32) \
 445             ((s32)->cx = (INT)(s16)->cx, (s32)->cy = (INT)(s16)->cy)
 446 #define CONV_SIZE32TO16(s32,s16) \
 447             ((s16)->cx = (INT16)(s32)->cx, (s16)->cy = (INT16)(s32)->cy)
 448
 449 /* The POINT structure */
 450
 451 typedef struct
 452 {
 453     INT16  x;
 454     INT16  y;
 455 } POINT16, *PPOINT16, *LPPOINT16;
 456
 457 typedef struct tagPOINT
 458 {
 459     LONG  x;
 460     LONG  y;
 461 } POINT, *PPOINT, *LPPOINT;
 462
 463 typedef struct _POINTL
 464 {
 465     LONG x;
 466     LONG y;
 467 } POINTL;
 468
 469 #define CONV_POINT16TO32(p16,p32) \
 470             ((p32)->x = (INT)(p16)->x, (p32)->y = (INT)(p16)->y)
 471 #define CONV_POINT32TO16(p32,p16) \
 472             ((p16)->x = (INT16)(p32)->x, (p16)->y = (INT16)(p32)->y)
 473
 474 #define MAKEPOINT16(l) (*((POINT16 *)&(l)))
 475
 476 /* The POINTS structure */
 477
 478 typedef struct tagPOINTS
 479 {
 480         SHORT x;
 481         SHORT y;
 482 } POINTS, *PPOINTS, *LPPOINTS;
 483
 484
 485 #define MAKEPOINTS(l)  (*((POINTS *)&(l)))
 486
 487
 488 /* The RECT structure */
 489
 490 typedef struct
 491 {
 492     INT16  left;
 493     INT16  top;
 494     INT16  right;
 495     INT16  bottom;
 496 } RECT16, *LPRECT16;
 497
 498 typedef struct tagRECT
 499 {
 500     INT  left;
 501     INT  top;
 502     INT  right;
 503     INT  bottom;
 504 } RECT, *PRECT, *LPRECT;
 505 typedef const RECT *LPCRECT;
 506
 507
 508 typedef struct tagRECTL
 509 {
 510     LONG left;
 511     LONG top;
 512     LONG right;
 513     LONG bottom;
 514 } RECTL, *PRECTL, *LPRECTL;
 515
 516 typedef const RECTL *LPCRECTL;
 517
 518 #define CONV_RECT16TO32(r16,r32) \
 519     ((r32)->left  = (INT)(r16)->left,  (r32)->top    = (INT)(r16)->top, \
 520      (r32)->right = (INT)(r16)->right, (r32)->bottom = (INT)(r16)->bottom)
 521 #define CONV_RECT32TO16(r32,r16) \
 522     ((r16)->left  = (INT16)(r32)->left,  (r16)->top    = (INT16)(r32)->top, \
 523      (r16)->right = (INT16)(r32)->right, (r16)->bottom = (INT16)(r32)->bottom)
 524
 525 #ifdef __cplusplus
 526 }
 527 #endif
 528
 529 #endif /* __WINE_WINDEF_H */