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 # undef UNICODE
  13 #endif  /* __WINE__ */
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /* Macros to map Winelib names to the correct implementation name */
  20 /* depending on __WINE__ and UNICODE macros.                      */
  21 /* Note that Winelib is purely Win32.                             */
  22
  23 #ifdef __WINE__
  24 # define WINELIB_NAME(func)      this_is_a_syntax_error this_is_a_syntax_error
  25 # define WINELIB_NAME_AW(func)   this_is_a_syntax_error this_is_a_syntax_error
  26 #else  /* __WINE__ */
  27 # define WINELIB_NAME(func)     func##32
  28 # ifdef UNICODE
  29 #  define WINELIB_NAME_AW(func) func##32W
  30 # else
  31 #  define WINELIB_NAME_AW(func) func##32A
  32 # endif  /* UNICODE */
  33 #endif  /* __WINE__ */
  34
  35 #ifdef __WINE__
  36 # define DECL_WINELIB_TYPE(type)     /* nothing */
  37 # define DECL_WINELIB_TYPE_AW(type)  /* nothing */
  38 #else   /* __WINE__ */
  39 # define DECL_WINELIB_TYPE(type)     typedef WINELIB_NAME(type) type;
  40 # define DECL_WINELIB_TYPE_AW(type)  typedef WINELIB_NAME_AW(type) type;
  41 #endif  /* __WINE__ */
  42
  43
  44 /* Calling conventions definitions */
  45
  46 #ifdef __i386__
  47 # if defined(__GNUC__) && (__GNUC__ == 2) && (__GNUC_MINOR__ >= 7)
  48 #  define __stdcall __attribute__((__stdcall__))
  49 #  define __cdecl   __attribute__((__cdecl__))
  50 #  define __RESTORE_ES  __asm__ __volatile__("pushl %ds\n\tpopl %es")
  51 # else
  52 #  error You need gcc >= 2.7 to build Wine on a 386
  53 # endif  /* __GNUC__ */
  54 #else  /* __i386__ */
  55 # define __stdcall
  56 # define __cdecl
  57 # define __RESTORE_ES
  58 #endif  /* __i386__ */
  59
  60 #define CALLBACK    __stdcall
  61 #define WINAPI      __stdcall
  62 #define APIPRIVATE  __stdcall
  63 #define PASCAL      __stdcall
  64 #define _pascal     __stdcall
  65 #define __export    __stdcall
  66 #define WINAPIV     __cdecl
  67 #define APIENTRY    WINAPI
  68
  69 #define CONST       const
  70
  71 /* Standard data types. These are the same for emulator and library. */
  72
  73 typedef void            VOID;
  74 typedef short           INT16;
  75 typedef unsigned short  UINT16;
  76 typedef int             INT32;
  77 typedef unsigned int    UINT32;
  78 typedef unsigned short  WORD;
  79 typedef unsigned long   DWORD;
  80 typedef unsigned long   ULONG;
  81 typedef unsigned char   BYTE;
  82 typedef long            LONG;
  83 typedef short           SHORT;
  84 typedef unsigned short  USHORT;
  85 typedef char            CHAR;
  86 typedef unsigned char   UCHAR;
  87 /* Some systems might have wchar_t, but we really need 16 bit characters */
  88 typedef unsigned short  WCHAR;
  89 typedef unsigned short  BOOL16;
  90 typedef int             BOOL32;
  91 typedef double          DATE;
  92 #ifdef __i386__
  93 typedef double          LONGLONG;
  94 typedef double          ULONGLONG;
  95 #endif /*__i386__*/
  96
  97 /* Integer types. These are the same for emulator and library. */
  98
  99 typedef UINT16          HANDLE16;
 100 typedef UINT32          HANDLE32;
 101 typedef UINT16          WPARAM16;
 102 typedef UINT32          WPARAM32;
 103 typedef LONG            LPARAM;
 104 typedef LONG            HRESULT;
 105 typedef LONG            LRESULT;
 106 typedef WORD            ATOM;
 107 typedef WORD            CATCHBUF[9];
 108 typedef WORD           *LPCATCHBUF;
 109 typedef DWORD           ACCESS_MASK;
 110 typedef ACCESS_MASK     REGSAM;
 111 typedef HANDLE32        HHOOK;
 112 typedef HANDLE32        HKEY;
 113 typedef HANDLE32        HMONITOR;
 114 typedef DWORD           LCID;
 115 typedef WORD            LANGID;
 116 typedef DWORD           LCTYPE;
 117 typedef float           FLOAT;
 118
 119 /* Pointers types. These are the same for emulator and library. */
 120 /* winnt types */
 121 typedef void           *PVOID;
 122 typedef const void     *PCVOID;
 123 typedef CHAR           *PCHAR;
 124 typedef UCHAR          *PUCHAR;
 125 typedef BYTE           *PBYTE;
 126 typedef ULONG          *PULONG;
 127 typedef LONG           *PLONG;
 128 typedef DWORD          *PDWORD;
 129 typedef UINT32         *PUINT32;
 130 /* common win32 types */
 131 typedef CHAR           *LPSTR;
 132 typedef const CHAR     *LPCSTR;
 133 typedef WCHAR          *LPWSTR;
 134 typedef const WCHAR    *LPCWSTR;
 135 typedef BYTE           *LPBYTE;
 136 typedef WORD           *LPWORD;
 137 typedef DWORD          *LPDWORD;
 138 typedef LONG           *LPLONG;
 139 typedef VOID           *LPVOID;
 140 typedef const VOID     *LPCVOID;
 141 typedef INT16          *LPINT16;
 142 typedef UINT16         *LPUINT16;
 143 typedef INT32          *LPINT32;
 144 typedef UINT32         *LPUINT32;
 145 typedef HKEY           *LPHKEY;
 146 typedef FLOAT          *LPFLOAT;
 147 typedef BOOL32         *LPBOOL32;
 148
 149 /* Special case: a segmented pointer is just a pointer in the user's code. */
 150
 151 #ifdef __WINE__
 152 typedef DWORD SEGPTR;
 153 #else
 154 typedef void* SEGPTR;
 155 #endif /* __WINE__ */
 156
 157 /* Handle types that exist both in Win16 and Win32. */
 158
 159 #define DECLARE_HANDLE(a)  typedef HANDLE16 a##16; typedef HANDLE32 a##32
 160 DECLARE_HANDLE(HACCEL);
 161 DECLARE_HANDLE(HBITMAP);
 162 DECLARE_HANDLE(HBRUSH);
 163 DECLARE_HANDLE(HCOLORSPACE);
 164 DECLARE_HANDLE(HCURSOR);
 165 DECLARE_HANDLE(HDC);
 166 DECLARE_HANDLE(HDROP);
 167 DECLARE_HANDLE(HDRVR);
 168 DECLARE_HANDLE(HDWP);
 169 DECLARE_HANDLE(HENHMETAFILE);
 170 DECLARE_HANDLE(HFILE);
 171 DECLARE_HANDLE(HFONT);
 172 DECLARE_HANDLE(HGDIOBJ);
 173 DECLARE_HANDLE(HGLOBAL);
 174 DECLARE_HANDLE(HICON);
 175 DECLARE_HANDLE(HINSTANCE);
 176 DECLARE_HANDLE(HLOCAL);
 177 DECLARE_HANDLE(HMENU);
 178 DECLARE_HANDLE(HMETAFILE);
 179 DECLARE_HANDLE(HMIDI);
 180 DECLARE_HANDLE(HMIDIIN);
 181 DECLARE_HANDLE(HMIDIOUT);
 182 DECLARE_HANDLE(HMIDISTRM);
 183 DECLARE_HANDLE(HMIXER);
 184 DECLARE_HANDLE(HMIXEROBJ);
 185 DECLARE_HANDLE(HMMIO);
 186 DECLARE_HANDLE(HMODULE);
 187 DECLARE_HANDLE(HPALETTE);
 188 DECLARE_HANDLE(HPEN);
 189 DECLARE_HANDLE(HQUEUE);
 190 DECLARE_HANDLE(HRGN);
 191 DECLARE_HANDLE(HRSRC);
 192 DECLARE_HANDLE(HTASK);
 193 DECLARE_HANDLE(HWAVE);
 194 DECLARE_HANDLE(HWAVEIN);
 195 DECLARE_HANDLE(HWAVEOUT);
 196 DECLARE_HANDLE(HWINSTA);
 197 DECLARE_HANDLE(HDESK);
 198 DECLARE_HANDLE(HWND);
 199 DECLARE_HANDLE(HKL);
 200 DECLARE_HANDLE(HIC);
 201 DECLARE_HANDLE(HRASCONN);
 202 #undef DECLARE_HANDLE
 203
 204 /* Callback function pointers types */
 205
 206 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32A)(LPSTR);
 207 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32W)(LPWSTR);
 208 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
 209 typedef LRESULT (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 210 typedef LRESULT (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
 211 DECL_WINELIB_TYPE(DLGPROC)
 212 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
 213 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
 214 DECL_WINELIB_TYPE(DRIVERPROC)
 215 typedef INT16   (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
 216 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
 217 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
 218 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
 219 typedef LRESULT (CALLBACK *FARPROC16)();
 220 typedef LRESULT (CALLBACK *FARPROC32)();
 221 DECL_WINELIB_TYPE(FARPROC)
 222 typedef INT16   (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
 223 typedef INT32   (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
 224 DECL_WINELIB_TYPE(GOBJENUMPROC)
 225 typedef BOOL16  (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
 226 typedef BOOL32  (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
 227 DECL_WINELIB_TYPE(GRAYSTRINGPROC)
 228 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
 229 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
 230 DECL_WINELIB_TYPE(HOOKPROC)
 231 typedef VOID    (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
 232 typedef VOID    (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
 233 DECL_WINELIB_TYPE(LINEDDAPROC)
 234 typedef BOOL16  (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
 235 typedef BOOL32  (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
 236 typedef BOOL32  (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
 237 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
 238 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
 239 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
 240 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
 241 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32A)(LPSTR);
 242 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32W)(LPWSTR);
 243 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
 244 typedef VOID    (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
 245 typedef VOID    (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
 246 DECL_WINELIB_TYPE(TIMERPROC)
 247 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
 248 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
 249 DECL_WINELIB_TYPE(WNDENUMPROC)
 250 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 251 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
 252 DECL_WINELIB_TYPE(WNDPROC)
 253
 254 /* TCHAR data types definitions for Winelib. */
 255 /* These types are _not_ defined for the emulator, because they */
 256 /* depend on the UNICODE macro that only exists in user's code. */
 257
 258 #ifndef __WINE__
 259 # ifdef UNICODE
 260 typedef WCHAR TCHAR;
 261 typedef LPWSTR LPTSTR;
 262 typedef LPCWSTR LPCTSTR;
 263 #define __TEXT(string) L##string /*probably wrong */
 264 # else  /* UNICODE */
 265 typedef CHAR TCHAR;
 266 typedef LPSTR LPTSTR;
 267 typedef LPCSTR LPCTSTR;
 268 #define __TEXT(string) string
 269 # endif /* UNICODE */
 270 #endif   /* __WINE__ */
 271 #define TEXT(quote) __TEXT(quote)
 272
 273 /* Data types specific to the library. These do _not_ exist in the emulator. */
 274
 275 DECL_WINELIB_TYPE(INT)
 276 DECL_WINELIB_TYPE(LPINT)
 277 DECL_WINELIB_TYPE(LPUINT)
 278 DECL_WINELIB_TYPE(UINT)
 279 DECL_WINELIB_TYPE(BOOL)
 280 DECL_WINELIB_TYPE(WPARAM)
 281
 282 DECL_WINELIB_TYPE(HACCEL)
 283 DECL_WINELIB_TYPE(HANDLE)
 284 DECL_WINELIB_TYPE(HBITMAP)
 285 DECL_WINELIB_TYPE(HBRUSH)
 286 DECL_WINELIB_TYPE(HCOLORSPACE)
 287 DECL_WINELIB_TYPE(HCURSOR)
 288 DECL_WINELIB_TYPE(HDC)
 289 DECL_WINELIB_TYPE(HDROP)
 290 DECL_WINELIB_TYPE(HDRVR)
 291 DECL_WINELIB_TYPE(HDWP)
 292 DECL_WINELIB_TYPE(HENHMETAFILE)
 293 DECL_WINELIB_TYPE(HFILE)
 294 DECL_WINELIB_TYPE(HFONT)
 295 DECL_WINELIB_TYPE(HGDIOBJ)
 296 DECL_WINELIB_TYPE(HGLOBAL)
 297 DECL_WINELIB_TYPE(HICON)
 298 DECL_WINELIB_TYPE(HINSTANCE)
 299 DECL_WINELIB_TYPE(HLOCAL)
 300 DECL_WINELIB_TYPE(HMENU)
 301 DECL_WINELIB_TYPE(HMETAFILE)
 302 DECL_WINELIB_TYPE(HMIDI)
 303 DECL_WINELIB_TYPE(HMIDIIN)
 304 DECL_WINELIB_TYPE(HMIDIOUT)
 305 DECL_WINELIB_TYPE(HMMIO)
 306 DECL_WINELIB_TYPE(HMODULE)
 307 DECL_WINELIB_TYPE(HPALETTE)
 308 DECL_WINELIB_TYPE(HPEN)
 309 DECL_WINELIB_TYPE(HQUEUE)
 310 DECL_WINELIB_TYPE(HRGN)
 311 DECL_WINELIB_TYPE(HRSRC)
 312 DECL_WINELIB_TYPE(HTASK)
 313 DECL_WINELIB_TYPE(HWAVE)
 314 DECL_WINELIB_TYPE(HWAVEIN)
 315 DECL_WINELIB_TYPE(HWAVEOUT)
 316 DECL_WINELIB_TYPE(HWND)
 317
 318 /* Misc. constants. */
 319
 320 #ifdef FALSE
 321 #undef FALSE
 322 #endif
 323 #define FALSE 0
 324
 325 #ifdef TRUE
 326 #undef TRUE
 327 #endif
 328 #define TRUE  1
 329
 330 #ifdef NULL
 331 #undef NULL
 332 #endif
 333 #define NULL  0
 334
 335 /* Define some empty macros for compatibility with Windows code. */
 336
 337 #ifndef __WINE__
 338 #define NEAR
 339 #define FAR
 340 #define _far
 341 #define _near
 342 #endif  /* __WINE__ */
 343
 344 /* Macro for structure packing. */
 345
 346 #ifdef __GNUC__
 347 #define WINE_PACKED __attribute__ ((packed))
 348 #else
 349 #define WINE_PACKED  /* nothing */
 350 #endif
 351
 352 /* Macros to split words and longs. */
 353
 354 #define LOBYTE(w)              ((BYTE)(WORD)(w))
 355 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
 356
 357 #define LOWORD(l)              ((WORD)(DWORD)(l))
 358 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
 359
 360 #define SLOWORD(l)             ((INT16)(LONG)(l))
 361 #define SHIWORD(l)             ((INT16)((LONG)(l) >> 16))
 362
 363 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | \
 364                                        (((DWORD)((WORD)(high))) << 16)))
 365 #define MAKELPARAM(low,high)   ((LPARAM)MAKELONG(low,high))
 366 #define MAKEWPARAM(low,high)   ((WPARAM32)MAKELONG(low,high))
 367 #define MAKELRESULT(low,high)  ((LRESULT)MAKELONG(low,high))
 368 #define MAKEINTATOM(atom)      ((LPCSTR)MAKELONG((atom),0))
 369
 370 #define SELECTOROF(ptr)     (HIWORD(ptr))
 371 #define OFFSETOF(ptr)       (LOWORD(ptr))
 372
 373 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
 374
 375 #ifdef __i386__
 376 #define PUT_WORD(ptr,w)   (*(WORD *)(ptr) = (w))
 377 #define GET_WORD(ptr)     (*(WORD *)(ptr))
 378 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
 379 #define GET_DWORD(ptr)    (*(DWORD *)(ptr))
 380 #else
 381 #define PUT_WORD(ptr,w)   (*(BYTE *)(ptr) = LOBYTE(w), \
 382                            *((BYTE *)(ptr) + 1) = HIBYTE(w))
 383 #define GET_WORD(ptr)     ((WORD)(*(BYTE *)(ptr) | \
 384                                   (WORD)(*((BYTE *)(ptr)+1) << 8)))
 385 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
 386                            PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
 387 #define GET_DWORD(ptr)    ((DWORD)(GET_WORD(ptr) | \
 388                                    ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
 389 #endif  /* __i386__ */
 390
 391 /* MIN and MAX macros */
 392
 393 #ifdef MAX
 394 #undef MAX
 395 #endif
 396 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
 397
 398 #ifdef MIN
 399 #undef MIN
 400 #endif
 401 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
 402
 403 /* Winelib run-time flag */
 404
 405 #ifdef __WINE__
 406 extern int __winelib;
 407 #endif  /* __WINE__ */
 408
 409 /* The SIZE structure */
 410
 411 typedef struct
 412 {
 413     INT16  cx;
 414     INT16  cy;
 415 } SIZE16, *LPSIZE16;
 416
 417 typedef struct
 418 {
 419     INT32  cx;
 420     INT32  cy;
 421 } SIZE32, *LPSIZE32;
 422
 423 DECL_WINELIB_TYPE(SIZE)
 424 DECL_WINELIB_TYPE(LPSIZE)
 425
 426 #define CONV_SIZE16TO32(s16,s32) \
 427             ((s32)->cx = (INT32)(s16)->cx, (s32)->cy = (INT32)(s16)->cy)
 428 #define CONV_SIZE32TO16(s32,s16) \
 429             ((s16)->cx = (INT16)(s32)->cx, (s16)->cy = (INT16)(s32)->cy)
 430
 431 /* The POINT structure */
 432
 433 typedef struct
 434 {
 435     INT16  x;
 436     INT16  y;
 437 } POINT16, *LPPOINT16;
 438
 439 typedef struct
 440 {
 441     INT32  x;
 442     INT32  y;
 443 } POINT32, *LPPOINT32;
 444
 445 DECL_WINELIB_TYPE(POINT)
 446 DECL_WINELIB_TYPE(LPPOINT)
 447
 448 #define CONV_POINT16TO32(p16,p32) \
 449             ((p32)->x = (INT32)(p16)->x, (p32)->y = (INT32)(p16)->y)
 450 #define CONV_POINT32TO16(p32,p16) \
 451             ((p16)->x = (INT16)(p32)->x, (p16)->y = (INT16)(p32)->y)
 452
 453 #define MAKEPOINT16(l) (*((POINT16 *)&(l)))
 454 #define MAKEPOINT WINELIB_NAME(MAKEPOINT)
 455
 456 /* The RECT structure */
 457
 458 typedef struct
 459 {
 460     INT16  left;
 461     INT16  top;
 462     INT16  right;
 463     INT16  bottom;
 464 } RECT16, *LPRECT16;
 465
 466 typedef struct
 467 {
 468     INT32  left;
 469     INT32  top;
 470     INT32  right;
 471     INT32  bottom;
 472 } RECT32, *LPRECT32;
 473
 474 DECL_WINELIB_TYPE(RECT)
 475 DECL_WINELIB_TYPE(LPRECT)
 476
 477 #define CONV_RECT16TO32(r16,r32) \
 478     ((r32)->left  = (INT32)(r16)->left,  (r32)->top    = (INT32)(r16)->top, \
 479      (r32)->right = (INT32)(r16)->right, (r32)->bottom = (INT32)(r16)->bottom)
 480 #define CONV_RECT32TO16(r32,r16) \
 481     ((r16)->left  = (INT16)(r32)->left,  (r16)->top    = (INT16)(r32)->top, \
 482      (r16)->right = (INT16)(r32)->right, (r16)->bottom = (INT16)(r32)->bottom)
 483
 484 #ifdef __cplusplus
 485 }
 486 #endif
 487
 488 #endif /* __WINE_WINTYPES_H */