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 unsigned short  USHORT;
  84 typedef char            CHAR;
  85 typedef unsigned char   UCHAR;
  86 /* Some systems might have wchar_t, but we really need 16 bit characters */
  87 typedef unsigned short  WCHAR;
  88 typedef unsigned short  BOOL16;
  89 typedef int             BOOL32;
  90
  91 /* Integer types. These are the same for emulator and library. */
  92
  93 typedef UINT16          HANDLE16;
  94 typedef UINT32          HANDLE32;
  95 typedef UINT16          WPARAM16;
  96 typedef UINT32          WPARAM32;
  97 typedef LONG            LPARAM;
  98 typedef LONG            HRESULT;
  99 typedef LONG            LRESULT;
 100 typedef WORD            ATOM;
 101 typedef WORD            CATCHBUF[9];
 102 typedef WORD           *LPCATCHBUF;
 103 typedef DWORD           ACCESS_MASK;
 104 typedef ACCESS_MASK     REGSAM;
 105 typedef HANDLE32        HHOOK;
 106 typedef HANDLE32        HKEY;
 107 typedef HANDLE32        HMONITOR;
 108 typedef DWORD           LCID;
 109 typedef WORD            LANGID;
 110 typedef DWORD           LCTYPE;
 111 typedef float           FLOAT;
 112
 113 /* Pointers types. These are the same for emulator and library. */
 114 /* winnt types */
 115 typedef void           *PVOID;
 116 typedef const void     *PCVOID;
 117 typedef CHAR           *PCHAR;
 118 typedef UCHAR          *PUCHAR;
 119 typedef BYTE           *PBYTE;
 120 typedef ULONG          *PULONG;
 121 typedef LONG           *PLONG;
 122 typedef DWORD          *PDWORD;
 123 typedef UINT32         *PUINT32;
 124 /* common win32 types */
 125 typedef CHAR           *LPSTR;
 126 typedef const CHAR     *LPCSTR;
 127 typedef WCHAR          *LPWSTR;
 128 typedef const WCHAR    *LPCWSTR;
 129 typedef BYTE           *LPBYTE;
 130 typedef WORD           *LPWORD;
 131 typedef DWORD          *LPDWORD;
 132 typedef LONG           *LPLONG;
 133 typedef VOID           *LPVOID;
 134 typedef const VOID     *LPCVOID;
 135 typedef INT16          *LPINT16;
 136 typedef UINT16         *LPUINT16;
 137 typedef INT32          *LPINT32;
 138 typedef UINT32         *LPUINT32;
 139 typedef HKEY           *LPHKEY;
 140 typedef FLOAT          *LPFLOAT;
 141 typedef BOOL32         *LPBOOL32;
 142
 143 /* Special case: a segmented pointer is just a pointer in the user's code. */
 144
 145 #ifdef __WINE__
 146 typedef DWORD SEGPTR;
 147 #else
 148 typedef void* SEGPTR;
 149 #endif /* __WINE__ */
 150
 151 /* Handle types that exist both in Win16 and Win32. */
 152
 153 #define DECLARE_HANDLE(a)  typedef HANDLE16 a##16; typedef HANDLE32 a##32
 154 DECLARE_HANDLE(HACCEL);
 155 DECLARE_HANDLE(HBITMAP);
 156 DECLARE_HANDLE(HBRUSH);
 157 DECLARE_HANDLE(HCOLORSPACE);
 158 DECLARE_HANDLE(HCURSOR);
 159 DECLARE_HANDLE(HDC);
 160 DECLARE_HANDLE(HDROP);
 161 DECLARE_HANDLE(HDRVR);
 162 DECLARE_HANDLE(HDWP);
 163 DECLARE_HANDLE(HENHMETAFILE);
 164 DECLARE_HANDLE(HFILE);
 165 DECLARE_HANDLE(HFONT);
 166 DECLARE_HANDLE(HGDIOBJ);
 167 DECLARE_HANDLE(HGLOBAL);
 168 DECLARE_HANDLE(HICON);
 169 DECLARE_HANDLE(HINSTANCE);
 170 DECLARE_HANDLE(HLOCAL);
 171 DECLARE_HANDLE(HMENU);
 172 DECLARE_HANDLE(HMETAFILE);
 173 DECLARE_HANDLE(HMIDI);
 174 DECLARE_HANDLE(HMIDIIN);
 175 DECLARE_HANDLE(HMIDIOUT);
 176 DECLARE_HANDLE(HMIDISTRM);
 177 DECLARE_HANDLE(HMIXER);
 178 DECLARE_HANDLE(HMIXEROBJ);
 179 DECLARE_HANDLE(HMMIO);
 180 DECLARE_HANDLE(HMODULE);
 181 DECLARE_HANDLE(HPALETTE);
 182 DECLARE_HANDLE(HPEN);
 183 DECLARE_HANDLE(HQUEUE);
 184 DECLARE_HANDLE(HRGN);
 185 DECLARE_HANDLE(HRSRC);
 186 DECLARE_HANDLE(HTASK);
 187 DECLARE_HANDLE(HWAVE);
 188 DECLARE_HANDLE(HWAVEIN);
 189 DECLARE_HANDLE(HWAVEOUT);
 190 DECLARE_HANDLE(HWINSTA);
 191 DECLARE_HANDLE(HDESK);
 192 DECLARE_HANDLE(HWND);
 193 DECLARE_HANDLE(HKL);
 194 DECLARE_HANDLE(HIC);
 195 DECLARE_HANDLE(HRASCONN);
 196 #undef DECLARE_HANDLE
 197
 198 /* Callback function pointers types */
 199
 200 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32A)(LPSTR);
 201 typedef BOOL32 (CALLBACK* DATEFMT_ENUMPROC32W)(LPWSTR);
 202 DECL_WINELIB_TYPE_AW(DATEFMT_ENUMPROC)
 203 typedef LRESULT (CALLBACK *DLGPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 204 typedef LRESULT (CALLBACK *DLGPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
 205 DECL_WINELIB_TYPE(DLGPROC)
 206 typedef LRESULT (CALLBACK *DRIVERPROC16)(DWORD,HDRVR16,UINT16,LPARAM,LPARAM);
 207 typedef LRESULT (CALLBACK *DRIVERPROC32)(DWORD,HDRVR32,UINT32,LPARAM,LPARAM);
 208 DECL_WINELIB_TYPE(DRIVERPROC)
 209 typedef INT16   (CALLBACK *EDITWORDBREAKPROC16)(LPSTR,INT16,INT16,INT16);
 210 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32A)(LPSTR,INT32,INT32,INT32);
 211 typedef INT32   (CALLBACK *EDITWORDBREAKPROC32W)(LPWSTR,INT32,INT32,INT32);
 212 DECL_WINELIB_TYPE_AW(EDITWORDBREAKPROC)
 213 typedef LRESULT (CALLBACK *FARPROC16)();
 214 typedef LRESULT (CALLBACK *FARPROC32)();
 215 DECL_WINELIB_TYPE(FARPROC)
 216 typedef INT16   (CALLBACK *GOBJENUMPROC16)(SEGPTR,LPARAM);
 217 typedef INT32   (CALLBACK *GOBJENUMPROC32)(LPVOID,LPARAM);
 218 DECL_WINELIB_TYPE(GOBJENUMPROC)
 219 typedef BOOL16  (CALLBACK *GRAYSTRINGPROC16)(HDC16,LPARAM,INT16);
 220 typedef BOOL32  (CALLBACK *GRAYSTRINGPROC32)(HDC32,LPARAM,INT32);
 221 DECL_WINELIB_TYPE(GRAYSTRINGPROC)
 222 typedef LRESULT (CALLBACK *HOOKPROC16)(INT16,WPARAM16,LPARAM);
 223 typedef LRESULT (CALLBACK *HOOKPROC32)(INT32,WPARAM32,LPARAM);
 224 DECL_WINELIB_TYPE(HOOKPROC)
 225 typedef VOID    (CALLBACK *LINEDDAPROC16)(INT16,INT16,LPARAM);
 226 typedef VOID    (CALLBACK *LINEDDAPROC32)(INT32,INT32,LPARAM);
 227 DECL_WINELIB_TYPE(LINEDDAPROC)
 228 typedef BOOL16  (CALLBACK *PROPENUMPROC16)(HWND16,SEGPTR,HANDLE16);
 229 typedef BOOL32  (CALLBACK *PROPENUMPROC32A)(HWND32,LPCSTR,HANDLE32);
 230 typedef BOOL32  (CALLBACK *PROPENUMPROC32W)(HWND32,LPCWSTR,HANDLE32);
 231 DECL_WINELIB_TYPE_AW(PROPENUMPROC)
 232 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32A)(HWND32,LPCSTR,HANDLE32,LPARAM);
 233 typedef BOOL32  (CALLBACK *PROPENUMPROCEX32W)(HWND32,LPCWSTR,HANDLE32,LPARAM);
 234 DECL_WINELIB_TYPE_AW(PROPENUMPROCEX)
 235 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32A)(LPSTR);
 236 typedef BOOL32 (CALLBACK* TIMEFMT_ENUMPROC32W)(LPWSTR);
 237 DECL_WINELIB_TYPE_AW(TIMEFMT_ENUMPROC)
 238 typedef VOID    (CALLBACK *TIMERPROC16)(HWND16,UINT16,UINT16,DWORD);
 239 typedef VOID    (CALLBACK *TIMERPROC32)(HWND32,UINT32,UINT32,DWORD);
 240 DECL_WINELIB_TYPE(TIMERPROC)
 241 typedef LRESULT (CALLBACK *WNDENUMPROC16)(HWND16,LPARAM);
 242 typedef LRESULT (CALLBACK *WNDENUMPROC32)(HWND32,LPARAM);
 243 DECL_WINELIB_TYPE(WNDENUMPROC)
 244 typedef LRESULT (CALLBACK *WNDPROC16)(HWND16,UINT16,WPARAM16,LPARAM);
 245 typedef LRESULT (CALLBACK *WNDPROC32)(HWND32,UINT32,WPARAM32,LPARAM);
 246 DECL_WINELIB_TYPE(WNDPROC)
 247
 248 /* TCHAR data types definitions for Winelib. */
 249 /* These types are _not_ defined for the emulator, because they */
 250 /* depend on the UNICODE macro that only exists in user's code. */
 251
 252 #ifndef __WINE__
 253 # ifdef UNICODE
 254 typedef WCHAR TCHAR;
 255 typedef LPWSTR LPTSTR;
 256 typedef LPCWSTR LPCTSTR;
 257 #define __TEXT(string) L##string /*probably wrong */
 258 # else  /* UNICODE */
 259 typedef CHAR TCHAR;
 260 typedef LPSTR LPTSTR;
 261 typedef LPCSTR LPCTSTR;
 262 #define __TEXT(string) string
 263 # endif /* UNICODE */
 264 #endif   /* __WINE__ */
 265 #define TEXT(quote) __TEXT(quote)
 266
 267 /* Data types specific to the library. These do _not_ exist in the emulator. */
 268
 269 DECL_WINELIB_TYPE(INT)
 270 DECL_WINELIB_TYPE(LPINT)
 271 DECL_WINELIB_TYPE(LPUINT)
 272 DECL_WINELIB_TYPE(UINT)
 273 DECL_WINELIB_TYPE(BOOL)
 274 DECL_WINELIB_TYPE(WPARAM)
 275
 276 DECL_WINELIB_TYPE(HACCEL)
 277 DECL_WINELIB_TYPE(HANDLE)
 278 DECL_WINELIB_TYPE(HBITMAP)
 279 DECL_WINELIB_TYPE(HBRUSH)
 280 DECL_WINELIB_TYPE(HCOLORSPACE)
 281 DECL_WINELIB_TYPE(HCURSOR)
 282 DECL_WINELIB_TYPE(HDC)
 283 DECL_WINELIB_TYPE(HDROP)
 284 DECL_WINELIB_TYPE(HDRVR)
 285 DECL_WINELIB_TYPE(HDWP)
 286 DECL_WINELIB_TYPE(HENHMETAFILE)
 287 DECL_WINELIB_TYPE(HFILE)
 288 DECL_WINELIB_TYPE(HFONT)
 289 DECL_WINELIB_TYPE(HGDIOBJ)
 290 DECL_WINELIB_TYPE(HGLOBAL)
 291 DECL_WINELIB_TYPE(HICON)
 292 DECL_WINELIB_TYPE(HINSTANCE)
 293 DECL_WINELIB_TYPE(HLOCAL)
 294 DECL_WINELIB_TYPE(HMENU)
 295 DECL_WINELIB_TYPE(HMETAFILE)
 296 DECL_WINELIB_TYPE(HMIDI)
 297 DECL_WINELIB_TYPE(HMIDIIN)
 298 DECL_WINELIB_TYPE(HMIDIOUT)
 299 DECL_WINELIB_TYPE(HMMIO)
 300 DECL_WINELIB_TYPE(HMODULE)
 301 DECL_WINELIB_TYPE(HPALETTE)
 302 DECL_WINELIB_TYPE(HPEN)
 303 DECL_WINELIB_TYPE(HQUEUE)
 304 DECL_WINELIB_TYPE(HRGN)
 305 DECL_WINELIB_TYPE(HRSRC)
 306 DECL_WINELIB_TYPE(HTASK)
 307 DECL_WINELIB_TYPE(HWAVE)
 308 DECL_WINELIB_TYPE(HWAVEIN)
 309 DECL_WINELIB_TYPE(HWAVEOUT)
 310 DECL_WINELIB_TYPE(HWND)
 311
 312 /* Misc. constants. */
 313
 314 #ifdef FALSE
 315 #undef FALSE
 316 #endif
 317 #define FALSE 0
 318
 319 #ifdef TRUE
 320 #undef TRUE
 321 #endif
 322 #define TRUE  1
 323
 324 #ifdef NULL
 325 #undef NULL
 326 #endif
 327 #define NULL  0
 328
 329 /* Define some empty macros for compatibility with Windows code. */
 330
 331 #ifndef __WINE__
 332 #define NEAR
 333 #define FAR
 334 #define _far
 335 #define _near
 336 #endif  /* __WINE__ */
 337
 338 /* Macro for structure packing. */
 339
 340 #ifdef __GNUC__
 341 #define WINE_PACKED __attribute__ ((packed))
 342 #else
 343 #define WINE_PACKED  /* nothing */
 344 #endif
 345
 346 /* Macros to split words and longs. */
 347
 348 #define LOBYTE(w)              ((BYTE)(WORD)(w))
 349 #define HIBYTE(w)              ((BYTE)((WORD)(w) >> 8))
 350
 351 #define LOWORD(l)              ((WORD)(DWORD)(l))
 352 #define HIWORD(l)              ((WORD)((DWORD)(l) >> 16))
 353
 354 #define SLOWORD(l)             ((INT16)(LONG)(l))
 355 #define SHIWORD(l)             ((INT16)((LONG)(l) >> 16))
 356
 357 #define MAKELONG(low,high)     ((LONG)(((WORD)(low)) | \
 358                                        (((DWORD)((WORD)(high))) << 16)))
 359 #define MAKELPARAM(low,high)   ((LPARAM)MAKELONG(low,high))
 360 #define MAKEWPARAM(low,high)   ((WPARAM32)MAKELONG(low,high))
 361 #define MAKELRESULT(low,high)  ((LRESULT)MAKELONG(low,high))
 362 #define MAKEINTATOM(atom)      ((LPCSTR)MAKELONG((atom),0))
 363
 364 #define SELECTOROF(ptr)     (HIWORD(ptr))
 365 #define OFFSETOF(ptr)       (LOWORD(ptr))
 366
 367 /* Macros to access unaligned or wrong-endian WORDs and DWORDs. */
 368
 369 #ifdef __i386__
 370 #define PUT_WORD(ptr,w)   (*(WORD *)(ptr) = (w))
 371 #define GET_WORD(ptr)     (*(WORD *)(ptr))
 372 #define PUT_DWORD(ptr,dw) (*(DWORD *)(ptr) = (dw))
 373 #define GET_DWORD(ptr)    (*(DWORD *)(ptr))
 374 #else
 375 #define PUT_WORD(ptr,w)   (*(BYTE *)(ptr) = LOBYTE(w), \
 376                            *((BYTE *)(ptr) + 1) = HIBYTE(w))
 377 #define GET_WORD(ptr)     ((WORD)(*(BYTE *)(ptr) | \
 378                                   (WORD)(*((BYTE *)(ptr)+1) << 8)))
 379 #define PUT_DWORD(ptr,dw) (PUT_WORD((ptr),LOWORD(dw)), \
 380                            PUT_WORD((WORD *)(ptr)+1,HIWORD(dw)))
 381 #define GET_DWORD(ptr)    ((DWORD)(GET_WORD(ptr) | \
 382                                    ((DWORD)GET_WORD((WORD *)(ptr)+1) << 16)))
 383 #endif  /* __i386__ */
 384
 385 /* MIN and MAX macros */
 386
 387 #ifdef MAX
 388 #undef MAX
 389 #endif
 390 #define MAX(a,b) (((a) > (b)) ? (a) : (b))
 391
 392 #ifdef MIN
 393 #undef MIN
 394 #endif
 395 #define MIN(a,b) (((a) < (b)) ? (a) : (b))
 396
 397 /* Winelib run-time flag */
 398
 399 #ifdef __WINE__
 400 extern int __winelib;
 401 #endif  /* __WINE__ */
 402
 403 #ifdef __cplusplus
 404 }
 405 #endif
 406
 407 #endif /* __WINE_WINTYPES_H */