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