Fix the type of the This pointer in the vtbl functions inherited from
[wine.git] / include / wtypes.idl
blob07976c90d4f2a180ac804564ffa1aed24b854129
1 /*
2 * Basic types used by COM interfaces
4 * Copyright 2002 Ove Kaaven
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.
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.
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
22 uuid(D3980A60-910C-1068-9341-00DD010F2F1C),
23 version(0.1),
24 pointer_default(unique)
26 interface IWinTypes
29 /******************** WINE STUFF ********************/
31 cpp_quote("#include \"basetsd.h\"")
32 cpp_quote("#include \"guiddef.h\"")
34 /* from Wine's pre-WIDL wtypes.h */
35 /* FIXME: does not belong here */
36 cpp_quote("typedef CHAR OLECHAR16;")
37 cpp_quote("typedef LPSTR LPOLESTR16;")
38 cpp_quote("typedef LPCSTR LPCOLESTR16;")
39 cpp_quote("typedef OLECHAR16 *BSTR16;")
40 cpp_quote("typedef BSTR16 *LPBSTR16;")
41 cpp_quote("#define OLESTR16(x) x")
43 /******************** BASIC WIN32 TYPES ********************/
44 cpp_quote("#if 0 /* winnt.h */") /* don't redefine these */
46 typedef unsigned char BYTE;
47 typedef unsigned short WORD;
48 typedef unsigned long DWORD;
49 typedef long BOOL;
50 typedef unsigned char UCHAR;
51 typedef int INT;
52 typedef unsigned int UINT;
53 typedef short SHORT;
54 typedef unsigned short USHORT;
55 typedef long LONG;
56 typedef unsigned long ULONG;
57 typedef float FLOAT;
58 typedef double DOUBLE;
60 typedef void *PVOID, *LPVOID;
62 typedef char CHAR;
63 typedef [string] CHAR *LPSTR;
64 typedef [string] const CHAR *LPCSTR;
66 typedef wchar_t WCHAR;
67 typedef [string] WCHAR *LPWSTR;
68 typedef [string] const WCHAR *LPCWSTR;
70 typedef boolean BOOLEAN;
72 typedef void *HANDLE;
73 #define DECLARE_HANDLE(name) typedef void *name
74 #define DECLARE_WIREM_HANDLE(name) typedef [wire_marshal(wire##name)] void*name
76 DECLARE_HANDLE(HMODULE);
77 DECLARE_HANDLE(HINSTANCE);
78 DECLARE_HANDLE(HRGN);
79 DECLARE_HANDLE(HTASK);
80 DECLARE_HANDLE(HKEY);
82 typedef double DATE;
83 typedef LONG HRESULT;
84 typedef DWORD LCID;
86 typedef unsigned __int64 DWORDLONG;
87 typedef __int64 LONGLONG;
88 typedef unsigned __int64 ULONGLONG;
90 typedef struct _LARGE_INTEGER {
91 LONGLONG QuadPart;
92 } LARGE_INTEGER;
94 typedef struct _ULARGE_INTEGER {
95 ULONGLONG QuadPart;
96 } ULARGE_INTEGER;
98 typedef struct _SID_IDENTIFIER_AUTHORITY {
99 UCHAR Value[6];
100 } SID_IDENTIFIER_AUTHORITY, *PSID_IDENTIFIER_AUTHORITY;
102 typedef struct _SID {
103 UCHAR Revision;
104 UCHAR SubAuthorityCount;
105 SID_IDENTIFIER_AUTHORITY IdentifierAuthority;
106 [size_is(SubAuthorityCount)] ULONG SubAuthority[*];
107 } SID, *PSID;
109 typedef USHORT SECURITY_DESCRIPTOR_CONTROL, *PSECURITY_DESCRIPTOR_CONTROL;
111 typedef struct _ACL {
112 UCHAR AclRevision;
113 UCHAR Sbz1;
114 USHORT AclSize;
115 USHORT AceCount;
116 USHORT Sbz2;
117 } ACL;
118 typedef ACL *PACL;
120 typedef struct _SECURITY_DESCRIPTOR {
121 UCHAR Revision;
122 UCHAR Sbz1;
123 SECURITY_DESCRIPTOR_CONTROL Control;
124 PSID Owner;
125 PSID Group;
126 PACL Sacl;
127 PACL Dacl;
128 } SECURITY_DESCRIPTOR, *PSECURITY_DESCRIPTOR;
130 cpp_quote("#endif /* winnt.h */")
132 cpp_quote("#ifndef _PALETTEENTRY_DEFINED")
133 cpp_quote("#define _PALETTEENTRY_DEFINED")
134 typedef struct tagPALETTEENTRY {
135 BYTE peRed;
136 BYTE peGreen;
137 BYTE peBlue;
138 BYTE peFlags;
139 } PALETTEENTRY, *PPALETTEENTRY, *LPPALETTEENTRY;
140 cpp_quote("#endif")
142 cpp_quote("#ifndef _LOGPALETTE_DEFINED")
143 cpp_quote("#define _LOGPALETTE_DEFINED")
144 typedef struct tagLOGPALETTE
146 WORD palVersion;
147 WORD palNumEntries;
148 [size_is(palNumEntries)] PALETTEENTRY palPalEntry[*];
149 } LOGPALETTE, *PLOGPALETTE, *LPLOGPALETTE;
150 cpp_quote("#endif")
152 cpp_quote("#ifndef _FILETIME_")
153 cpp_quote("#define _FILETIME_")
154 typedef struct _FILETIME {
155 DWORD dwLowDateTime;
156 DWORD dwHighDateTime;
157 } FILETIME, *PFILETIME, *LPFILETIME;
158 cpp_quote("#endif")
160 /******************** BASIC COM/OLE TYPES ********************/
162 typedef WCHAR OLECHAR;
163 typedef [string] OLECHAR *LPOLESTR;
164 typedef [string] const OLECHAR *LPCOLESTR;
165 cpp_quote("#ifndef __WINE__")
166 cpp_quote("#define OLESTR(str) WINE_UNICODE_TEXT(str)")
167 cpp_quote("#endif")
169 typedef LONG SCODE;
171 typedef struct _COAUTHIDENTITY {
172 [size_is(UserLength+1)] USHORT *User;
173 ULONG UserLength;
174 [size_is(DomainLength+1)] USHORT *Domain;
175 ULONG DomainLength;
176 [size_is(PasswordLength+1)] USHORT *Password;
177 ULONG PasswordLength;
178 ULONG Flags;
179 } COAUTHIDENTITY;
181 typedef struct _COAUTHINFO {
182 DWORD dwAuthnSvc;
183 DWORD dwAuthzSvc;
184 LPWSTR pwszServerPrincName;
185 DWORD dwAuthnLevel;
186 DWORD dwImpersonationLevel;
187 COAUTHIDENTITY *pAuthIdentityData;
188 DWORD dwCapabilities;
189 } COAUTHINFO;
191 /* FIXME: COSERVERINFO was in Wine's pre-WIDL wtypes.h, but should be in objidl.idl */
192 typedef struct _COSERVERINFO {
193 DWORD dwReserved1;
194 LPWSTR pwszName;
195 COAUTHINFO *pAuthInfo;
196 DWORD dwReserved2;
197 } COSERVERINFO;
199 cpp_quote("#ifndef _ROTFLAGS_DEFINED")
200 cpp_quote("#define _ROTFLAGS_DEFINED")
201 cpp_quote("#define ROTFLAGS_REGISTRATIONKEEPSALIVE 0x1")
202 cpp_quote("#define ROTFLAGS_ALLOWANYCLIENT 0x2")
203 cpp_quote("#endif")
205 typedef enum tagCLSCTX {
206 CLSCTX_INPROC_SERVER = 0x1,
207 CLSCTX_INPROC_HANDLER = 0x2,
208 CLSCTX_LOCAL_SERVER = 0x4,
209 CLSCTX_INPROC_SERVER16 = 0x8,
210 CLSCTX_REMOTE_SERVER = 0x10,
211 CLSCTX_INPROC_HANDLER16 = 0x20,
212 CLSCTX_INPROC_SERVERX86 = 0x40,
213 CLSCTX_INPROC_HANDLERX86 = 0x80,
214 CLSCTX_ESERVER_HANDLER = 0x100,
215 CLSCTX_NO_CODE_DOWNLOAD = 0x400,
216 CLSCTX_NO_CUSTOM_MARSHAL = 0x1000,
217 CLSCTX_ENABLE_CODE_DOWNLOAD = 0x2000,
218 CLSCTX_NO_FAILURE_LOG = 0x4000,
219 CLSCTX_DISABLE_AAA = 0x8000,
220 CLSCTX_ENABLE_AAA = 0x10000,
221 CLSCTX_FROM_DEFAULT_CONTEXT = 0x20000
222 } CLSCTX;
224 cpp_quote("#define CLSCTX_INPROC (CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER)")
225 cpp_quote("#define CLSCTX_ALL (CLSCTX_INPROC_SERVER | CLSCTX_INPROC_HANDLER | CLSCTX_LOCAL_SERVER | CLSCTX_REMOTE_SERVER)")
226 cpp_quote("#define CLSCTX_SERVER (CLSCTX_INPROC_SERVER | CLSCTX_LOCAL_SERVER | CLSCTX_REMOTE_SERVER)")
228 typedef enum tagMSHLFLAGS {
229 MSHLFLAGS_NORMAL = 0,
230 MSHLFLAGS_TABLESTRONG = 1,
231 MSHLFLAGS_TABLEWEAK = 2,
232 MSHLFLAGS_NOPING = 4
233 } MSHLFLAGS;
235 typedef enum tagMSHCTX {
236 MSHCTX_LOCAL = 0,
237 MSHCTX_NOSHAREDMEM = 1,
238 MSHCTX_DIFFERENTMACHINE = 2,
239 MSHCTX_INPROC = 3,
240 MSHCTX_CROSSCTX = 4
241 } MSHCTX;
243 /******************** BLOB TYPES ********************/
245 typedef struct _BYTE_BLOB {
246 unsigned long clSize;
247 [size_is(clSize)] byte abData[];
248 } BYTE_BLOB;
249 typedef [unique] BYTE_BLOB *UP_BYTE_BLOB;
251 typedef struct _FLAGGED_BYTE_BLOB {
252 unsigned long fFlags;
253 unsigned long clSize;
254 [size_is(clSize)] byte abData[];
255 } FLAGGED_BYTE_BLOB;
256 typedef [unique] FLAGGED_BYTE_BLOB *UP_FLAGGED_BYTE_BLOB;
258 typedef struct _FLAGGED_WORD_BLOB {
259 unsigned long fFlags;
260 unsigned long clSize;
261 [size_is(clSize)] unsigned short asData[];
262 } FLAGGED_WORD_BLOB;
263 typedef [unique] FLAGGED_WORD_BLOB *UP_FLAGGED_WORD_BLOB;
265 typedef struct _BYTE_SIZEDARR {
266 unsigned long clSize;
267 [size_is(clSize)] byte *pData;
268 } BYTE_SIZEDARR;
270 typedef struct _SHORT_SIZEDARR {
271 unsigned long clSize;
272 [size_is(clSize)] unsigned short *pData;
273 } WORD_SIZEDARR;
275 typedef struct _LONG_SIZEDARR {
276 unsigned long clSize;
277 [size_is(clSize)] unsigned long *pData;
278 } DWORD_SIZEDARR;
280 typedef struct _HYPER_SIZEDARR {
281 unsigned long clSize;
282 [size_is(clSize)] hyper *pData;
283 } HYPER_SIZEDARR;
285 /******************** GDI TYPES ********************/
287 const unsigned long WDT_INPROC_CALL = 0x48746457;
288 const unsigned long WDT_REMOTE_CALL = 0x52746457;
290 typedef union _userCLIPFORMAT switch(long fContext) u {
291 case WDT_INPROC_CALL: DWORD dwValue;
292 case WDT_REMOTE_CALL: LPWSTR pwszName;
293 } userCLIPFORMAT;
295 typedef [unique] userCLIPFORMAT *wireCLIPFORMAT;
296 typedef [wire_marshal(wireCLIPFORMAT)] WORD CLIPFORMAT;
298 typedef struct tagRemHGLOBAL {
299 long fNullHGlobal;
300 unsigned long cbData;
301 [size_is(cbData)] byte data[];
302 } RemHGLOBAL;
304 typedef union _userHGLOBAL switch(long fContext) u {
305 case WDT_INPROC_CALL: long hInproc;
306 case WDT_REMOTE_CALL: FLAGGED_BYTE_BLOB *hRemote;
307 default: long hGlobal;
308 } userHGLOBAL;
310 typedef [unique] userHGLOBAL *wireHGLOBAL;
312 typedef struct tagRemHMETAFILEPICT {
313 long mm;
314 long xExt;
315 long yExt;
316 unsigned long cbData;
317 [size_is(cbData)] byte data[];
318 } RemHMETAFILEPICT;
320 typedef union _userHMETAFILE switch(long fContext) u {
321 case WDT_INPROC_CALL: long hInproc;
322 case WDT_REMOTE_CALL: BYTE_BLOB *hRemote;
323 default: long hGlobal;
324 } userHMETAFILE;
326 typedef [unique] userHMETAFILE *wireHMETAFILE;
328 typedef struct _remoteMETAFILEPICT {
329 long mm;
330 long xExt;
331 long yExt;
332 userHMETAFILE *hMF;
333 } remoteMETAFILEPICT;
335 typedef union _userHMETAFILEPICT switch(long fContext) u {
336 case WDT_INPROC_CALL: long hInproc;
337 case WDT_REMOTE_CALL: remoteMETAFILEPICT *hRemote;
338 default: long hGlobal;
339 } userHMETAFILEPICT;
341 typedef [unique] userHMETAFILEPICT *wireHMETAFILEPICT;
343 typedef struct tagRemHENHMETAFILE {
344 unsigned long cbData;
345 [size_is(cbData)] byte data[];
346 } RemHENHMETAFILE;
348 typedef union _userHENHMETAFILE switch(long fContext) u {
349 case WDT_INPROC_CALL: long hInproc;
350 case WDT_REMOTE_CALL: BYTE_BLOB *hRemote;
351 default: long hGlobal;
352 } userHENHMETAFILE;
354 typedef [unique] userHENHMETAFILE *wireHENHMETAFILE;
356 typedef struct tagRemHBITMAP
358 unsigned long cbData;
359 [size_is(cbData)] byte data[];
360 } RemHBITMAP;
362 typedef struct _userBITMAP {
363 LONG bmType;
364 LONG bmWidth;
365 LONG bmHeight;
366 LONG bmWidthBytes;
367 WORD bmPlanes;
368 WORD bmBitsPixel;
369 ULONG cbSize;
370 [size_is(cbSize)] byte pBuffer[];
371 } userBITMAP;
373 typedef union _userHBITMAP switch(long fContext) u {
374 case WDT_INPROC_CALL: long hInproc;
375 case WDT_REMOTE_CALL: userBITMAP *hRemote;
376 default: long hGlobal;
377 } userHBITMAP;
379 typedef [unique] userHBITMAP *wireHBITMAP;
381 typedef struct tagRemHPALETTE {
382 unsigned long cbData;
383 [size_is(cbData)] byte data[];
384 } RemHPALETTE;
386 typedef struct tagrpcLOGPALETTE {
387 WORD palVersion;
388 WORD palNumEntries;
389 [size_is(palNumEntries)] PALETTEENTRY palPalEntry[];
390 } rpcLOGPALETTE;
392 typedef union _userHPALETTE switch(long fContext) u {
393 case WDT_INPROC_CALL: long hInproc;
394 case WDT_REMOTE_CALL: rpcLOGPALETTE *hRemote;
395 default: long hGlobal;
396 } userHPALETTE;
398 typedef [unique] userHPALETTE *wireHPALETTE;
400 cpp_quote("#if 0")
401 DECLARE_WIREM_HANDLE(HGLOBAL);
402 typedef HGLOBAL HLOCAL;
403 DECLARE_WIREM_HANDLE(HBITMAP);
404 DECLARE_WIREM_HANDLE(HPALETTE);
405 DECLARE_WIREM_HANDLE(HENHMETAFILE);
406 DECLARE_WIREM_HANDLE(HMETAFILE);
407 cpp_quote("#endif")
408 DECLARE_WIREM_HANDLE(HMETAFILEPICT);
410 /******************** GUID TYPES ********************/
412 cpp_quote("#ifndef GUID_DEFINED")
413 cpp_quote("#define GUID_DEFINED")
414 typedef struct _GUID {
415 DWORD Data1;
416 WORD Data2;
417 WORD Data3;
418 BYTE Data4[8];
419 } GUID;
420 cpp_quote("#endif")
422 cpp_quote("#if 0 /* guiddef.h */")
423 typedef GUID *LPGUID;
425 typedef GUID IID;
426 typedef IID *LPIID;
428 typedef GUID CLSID;
429 typedef CLSID *LPCLSID;
431 typedef GUID FMTID;
432 typedef FMTID *LPFMTID;
434 cpp_quote("#if 0") /* for IDL only (C/C++ defs are in guiddef.h) */
435 typedef GUID *REFGUID;
436 typedef IID *REFIID;
437 typedef CLSID *REFCLSID;
438 typedef FMTID *REFFMTID;
439 cpp_quote("#endif")
441 cpp_quote("#endif /* guiddef.h */")
443 /******************** MISC TYPES ********************/
445 typedef enum tagDVASPECT {
446 DVASPECT_CONTENT = 1,
447 DVASPECT_THUMBNAIL = 2,
448 DVASPECT_ICON = 4,
449 DVASPECT_DOCPRINT = 8
450 } DVASPECT;
452 typedef enum tagSTGC {
453 STGC_DEFAULT = 0,
454 STGC_OVERWRITE = 1,
455 STGC_ONLYIFCURRENT = 2,
456 STGC_DANGEROUSLYCOMMITMERELYTODISKCACHE = 4,
457 STGC_CONSOLIDATE = 8
458 } STGC;
460 typedef enum tagSTGMOVE {
461 STGMOVE_MOVE = 0,
462 STGMOVE_COPY = 1,
463 STGMOVE_SHALLOWCOPY = 2
464 } STGMOVE;
466 /******************** OLE Automation ********************/
468 cpp_quote("#if 0") /* for IDL only */
469 typedef struct tagCY {
470 LONGLONG int64;
471 } CY;
472 cpp_quote("#else") /* C/C++ defs */
473 cpp_quote("typedef union tagCY {")
474 cpp_quote(" struct {")
475 cpp_quote("#ifdef WORDS_BIGENDIAN")
476 cpp_quote(" LONG Hi;")
477 cpp_quote(" ULONG Lo;")
478 cpp_quote("#else")
479 cpp_quote(" ULONG Lo;")
480 cpp_quote(" LONG Hi;")
481 cpp_quote("#endif")
482 cpp_quote(" } DUMMYSTRUCTNAME;")
483 cpp_quote(" LONGLONG int64;")
484 cpp_quote("} CY;")
485 cpp_quote("#endif")
487 typedef CY *LPCY;
489 typedef struct tagDEC {
490 USHORT wReserved;
491 BYTE scale;
492 BYTE sign;
493 ULONG Hi32;
494 ULONGLONG Lo64;
495 } DECIMAL;
496 typedef DECIMAL *LPDECIMAL;
498 typedef [unique] FLAGGED_WORD_BLOB *wireBSTR;
499 typedef [wire_marshal(wireBSTR)] OLECHAR *BSTR;
500 typedef BSTR *LPBSTR;
502 typedef short VARIANT_BOOL;
503 typedef VARIANT_BOOL _VARIANT_BOOL;
504 cpp_quote("#define VARIANT_TRUE ((VARIANT_BOOL)0xFFFF)")
505 cpp_quote("#define VARIANT_FALSE ((VARIANT_BOOL)0x0000)")
507 typedef struct tagBSTRBLOB {
508 ULONG cbSize;
509 [size_is(cbSize)] BYTE *pData;
510 } BSTRBLOB, *LPBSTRBLOB;
512 typedef struct tagBLOB {
513 ULONG cbSize;
514 [size_is(cbSize)] BYTE *pBlobData;
515 } BLOB, *LPBLOB;
517 typedef struct tagCLIPDATA {
518 ULONG cbSize;
519 long ulClipFmt;
520 [size_is(cbSize-sizeof(long))] BYTE *pClipData;
521 } CLIPDATA;
522 cpp_quote("#define CBPCLIPDATA(cb) ((cb).cbSize - sizeof((cb).ulClipFmt))")
524 typedef ULONG PROPID;
526 /******************** VARTYPE ********************/
528 typedef unsigned short VARTYPE;
529 enum VARENUM {
530 VT_EMPTY = 0,
531 VT_NULL = 1,
532 VT_I2 = 2,
533 VT_I4 = 3,
534 VT_R4 = 4,
535 VT_R8 = 5,
536 VT_CY = 6,
537 VT_DATE = 7,
538 VT_BSTR = 8,
539 VT_DISPATCH = 9,
540 VT_ERROR = 10,
541 VT_BOOL = 11,
542 VT_VARIANT = 12,
543 VT_UNKNOWN = 13,
544 VT_DECIMAL = 14,
545 VT_I1 = 16,
546 VT_UI1 = 17,
547 VT_UI2 = 18,
548 VT_UI4 = 19,
549 VT_I8 = 20,
550 VT_UI8 = 21,
551 VT_INT = 22,
552 VT_UINT = 23,
553 VT_VOID = 24,
554 VT_HRESULT = 25,
555 VT_PTR = 26,
556 VT_SAFEARRAY = 27,
557 VT_CARRAY = 28,
558 VT_USERDEFINED = 29,
559 VT_LPSTR = 30,
560 VT_LPWSTR = 31,
561 VT_RECORD = 36,
562 VT_FILETIME = 64,
563 VT_BLOB = 65,
564 VT_STREAM = 66,
565 VT_STORAGE = 67,
566 VT_STREAMED_OBJECT = 68,
567 VT_STORED_OBJECT = 69,
568 VT_BLOB_OBJECT = 70,
569 VT_CF = 71,
570 VT_CLSID = 72,
571 VT_BSTR_BLOB = 0x0fff,
572 VT_VECTOR = 0x1000,
573 VT_ARRAY = 0x2000,
574 VT_BYREF = 0x4000,
575 VT_RESERVED = 0x8000,
576 VT_ILLEGAL = 0xffff,
577 VT_ILLEGALMASKED = 0x0fff,
578 VT_TYPEMASK = 0x0fff
581 } /* interface IWinTypes */