winedump: Add support for derived types in codeview type info.
[wine] / include / propidl.idl
1 /*
2  * Copyright 2002 Ove Kaaven
3  * Copyright 2004 Francois Gouget
4  * Copyright 2005 Juan Lang
5  *
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.
10  *
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.
15  *
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19  */
20
21 import "objidl.idl";
22 import "oaidl.idl";
23
24
25 /*
26  * Windows SDK braindamage alert
27  *
28  * PID_DICTIONARY and PID_CODEPAGE are defined by msidefs.h too
29  * PID_SECURITY is defined in msidefs.h with a different value!
30  * So these need to be undefined first.
31  */
32 cpp_quote("#ifdef PID_DICTIONARY")
33 cpp_quote("#undef PID_DICTIONARY")
34 cpp_quote("#endif")
35
36 cpp_quote("#ifdef PID_CODEPAGE")
37 cpp_quote("#undef PID_CODEPAGE")
38 cpp_quote("#endif")
39
40 cpp_quote("#ifdef PID_SECURITY")
41 cpp_quote("#undef PID_SECURITY")
42 cpp_quote("#endif")
43
44 /******************** Property Storage ********************/
45
46 interface IEnumSTATPROPSTG;
47 interface IEnumSTATPROPSETSTG;
48
49 [
50   object,
51   uuid(00000138-0000-0000-C000-000000000046),
52   pointer_default(unique)
53 ]
54 interface IPropertyStorage : IUnknown
55 {
56   typedef [unique] IPropertyStorage *LPPROPERTYSTORAGE;
57
58   const DWORD PROPSETFLAG_DEFAULT = 0;
59   const DWORD PROPSETFLAG_NONSIMPLE = 1;
60   const DWORD PROPSETFLAG_ANSI = 2;
61   const DWORD PROPSETFLAG_UNBUFFERED = 4;
62   const DWORD PROPSETFLAG_CASE_SENSITIVE = 8;
63
64   const DWORD PROPSET_BEHAVIOR_CASE_SENSITIVE = 1;
65
66   const PROPID PID_DICTIONARY          = 0x00000000;
67   const PROPID PID_CODEPAGE            = 0x00000001;
68   const PROPID PID_FIRST_USABLE        = 0x00000002;
69   const PROPID PID_FIRST_NAME_DEFAULT  = 0x00000fff;
70   const PROPID PID_LOCALE              = 0x80000000;
71   const PROPID PID_MODIFY_TIME         = 0x80000001;
72   const PROPID PID_SECURITY            = 0x80000002;
73   const PROPID PID_BEHAVIOR            = 0x80000003;
74   const PROPID PID_ILLEGAL             = 0xffffffff;
75   const PROPID PID_MIN_READONLY        = 0x80000000;
76   const PROPID PID_MAX_READONLY        = 0xbfffffff;
77
78   typedef struct tagPROPVARIANT PROPVARIANT;
79
80 #define TYPEDEF_CA(type, name) \
81     typedef struct tag##name { \
82       ULONG cElems; \
83       [size_is(cElems)] \
84       type *pElems; \
85     } name
86
87   TYPEDEF_CA(unsigned char, CAUB);
88   TYPEDEF_CA(short, CAI);
89   TYPEDEF_CA(USHORT, CAUI);
90   TYPEDEF_CA(long, CAL);
91   TYPEDEF_CA(ULONG, CAUL);
92   TYPEDEF_CA(float, CAFLT);
93   TYPEDEF_CA(double, CADBL);
94   TYPEDEF_CA(CY, CACY);
95   TYPEDEF_CA(DATE, CADATE);
96   TYPEDEF_CA(BSTR, CABSTR);
97   TYPEDEF_CA(BSTRBLOB, CABSTRBLOB);
98   TYPEDEF_CA(VARIANT_BOOL, CABOOL);
99   TYPEDEF_CA(SCODE,  CASCODE);
100   TYPEDEF_CA(PROPVARIANT, CAPROPVARIANT);
101   TYPEDEF_CA(LARGE_INTEGER, CAH);
102   TYPEDEF_CA(ULARGE_INTEGER, CAUH);
103   TYPEDEF_CA(LPSTR, CALPSTR);
104   TYPEDEF_CA(LPWSTR, CALPWSTR);
105   TYPEDEF_CA(FILETIME, CAFILETIME);
106   TYPEDEF_CA(CLIPDATA, CACLIPDATA);
107   TYPEDEF_CA(CLSID, CACLSID);
108
109   struct tagPROPVARIANT {
110     VARTYPE vt;
111     WORD wReserved1;
112     WORD wReserved2;
113     WORD wReserved3;
114     [switch_is(vt & 0x1fff)] union {
115     [case(VT_EMPTY, VT_NULL)]             ;
116     [case(VT_I1)]                         char cVal;
117     [case(VT_UI1)]                        UCHAR bVal;
118     [case(VT_I2)]                         short iVal;
119     [case(VT_UI2)]                        USHORT uiVal;
120     [case(VT_BOOL)]                       VARIANT_BOOL boolVal;
121 #if 0 /* illegal in C++ */
122     [case(VT_ILLEGAL)]                    _VARIANT_BOOL bool;
123 #endif
124     [case(VT_I4)]                         long lVal;
125     [case(VT_UI4)]                        ULONG ulVal;
126     [case(VT_R4)]                         float fltVal;
127     [case(VT_ERROR)]                      SCODE scode;
128     [case(VT_I8)]                         LARGE_INTEGER hVal;
129     [case(VT_UI8)]                        ULARGE_INTEGER uhVal;
130     [case(VT_R8)]                         double dblVal;
131     [case(VT_CY)]                         CY cyVal;
132     [case(VT_DATE)]                       DATE date;
133     [case(VT_FILETIME)]                   FILETIME filetime;
134     [case(VT_CLSID)]                      CLSID *puuid;
135     [case(VT_BLOB, VT_BLOB_OBJECT)]       BLOB blob;
136     [case(VT_CF)]                         CLIPDATA *pclipdata;
137     [case(VT_STREAM, VT_STREAMED_OBJECT)] IStream *pStream;
138     [case(VT_STORAGE, VT_STORED_OBJECT)]  IStorage *pStorage;
139     [case(VT_BSTR)]                       BSTR bstrVal;
140     [case(VT_BSTR_BLOB)]                  BSTRBLOB bstrblobVal;
141     [case(VT_LPSTR)]                      LPSTR pszVal;
142     [case(VT_LPWSTR)]                     LPWSTR pwszVal;
143     [case(VT_UI1|VT_VECTOR)]              CAUB caub;
144     [case(VT_I2|VT_VECTOR)]               CAI cai;
145     [case(VT_UI2|VT_VECTOR)]              CAUI caui;
146     [case(VT_BOOL|VT_VECTOR)]             CABOOL cabool;
147     [case(VT_I4|VT_VECTOR)]               CAL cal;
148     [case(VT_UI4|VT_VECTOR)]              CAUL caul;
149     [case(VT_R4|VT_VECTOR)]               CAFLT caflt;
150     [case(VT_ERROR|VT_VECTOR)]            CASCODE cascode;
151     [case(VT_I8|VT_VECTOR)]               CAH cah;
152     [case(VT_UI8|VT_VECTOR)]              CAUH cauh;
153     [case(VT_R8|VT_VECTOR)]               CADBL cadbl;
154     [case(VT_CY|VT_VECTOR)]               CACY cacy;
155     [case(VT_DATE|VT_VECTOR)]             CADATE cadate;
156     [case(VT_FILETIME|VT_VECTOR)]         CAFILETIME cafiletime;
157     [case(VT_CLSID|VT_VECTOR)]            CACLSID cauuid;
158     [case(VT_CF|VT_VECTOR)]               CACLIPDATA caclipdata;
159     [case(VT_BSTR|VT_VECTOR)]             CABSTR cabstr;
160     [case(VT_BSTR_BLOB|VT_VECTOR)]        CABSTRBLOB cabstrblob;
161     [case(VT_LPSTR|VT_VECTOR)]            CALPSTR calpstr;
162     [case(VT_LPWSTR|VT_VECTOR)]           CALPWSTR calpwstr;
163     [case(VT_VARIANT|VT_VECTOR)]          CAPROPVARIANT capropvar;
164     [case(VT_ARRAY|VT_I1,
165           VT_ARRAY|VT_UI1,
166           VT_ARRAY|VT_I2,
167           VT_ARRAY|VT_UI2,
168           VT_ARRAY|VT_I4,
169           VT_ARRAY|VT_UI4,
170           VT_ARRAY|VT_INT,
171           VT_ARRAY|VT_UINT,
172           VT_ARRAY|VT_R4,
173           VT_ARRAY|VT_R8,
174           VT_ARRAY|VT_CY,
175           VT_ARRAY|VT_DATE,
176           VT_ARRAY|VT_BSTR,
177           VT_ARRAY|VT_BOOL,
178           VT_ARRAY|VT_DECIMAL,
179           VT_ARRAY|VT_DISPATCH,
180           VT_ARRAY|VT_UNKNOWN,
181           VT_ARRAY|VT_ERROR,
182           VT_ARRAY|VT_VARIANT)]           LPSAFEARRAY parray;
183     [case(VT_BYREF|VT_I1)]                CHAR *pcVal;
184     [case(VT_BYREF|VT_UI1)]               UCHAR *pbVal;
185     [case(VT_BYREF|VT_I2)]                SHORT *piVal;
186     [case(VT_BYREF|VT_UI2)]               USHORT *puiVal;
187     [case(VT_BYREF|VT_I4)]                LONG *plVal;
188     [case(VT_BYREF|VT_UI4)]               ULONG *pulVal;
189     [case(VT_BYREF|VT_INT)]               INT *pintVal;
190     [case(VT_BYREF|VT_UINT)]              UINT *puintVal;
191     [case(VT_BYREF|VT_R4)]                FLOAT *pfltVal;
192     [case(VT_BYREF|VT_R8)]                DOUBLE *pdblVal;
193     [case(VT_BYREF|VT_BOOL)]              VARIANT_BOOL *pboolVal;
194     [case(VT_BYREF|VT_DECIMAL)]           DECIMAL *pdecVal;
195     [case(VT_BYREF|VT_ERROR)]             SCODE *pscode;
196     [case(VT_BYREF|VT_CY)]                CY *pcyVal;
197     [case(VT_BYREF|VT_DATE)]              DATE *pdate;
198     [case(VT_BYREF|VT_BSTR)]              BSTR *pbstrVal;
199     [case(VT_BYREF|VT_UNKNOWN)]           IUnknown **ppunkVal;
200     [case(VT_BYREF|VT_DISPATCH)]          IDispatch **ppdispVal;
201     [case(VT_BYREF|VT_ARRAY)]             LPSAFEARRAY *pparray;
202     [case(VT_BYREF|VT_VARIANT)]           PROPVARIANT *pvarVal;
203     };
204   };
205
206   typedef struct tagPROPVARIANT *LPPROPVARIANT;
207
208   cpp_quote("#define PIDDI_THUMBNAIL 0x00000002L /* VT_BLOB */")
209   cpp_quote("")
210   cpp_quote("#define PIDSI_TITLE        0x00000002L /* VT_LPSTR */")
211   cpp_quote("#define PIDSI_SUBJECT      0x00000003L /* VT_LPSTR */")
212   cpp_quote("#define PIDSI_AUTHOR       0x00000004L /* VT_LPSTR */")
213   cpp_quote("#define PIDSI_KEYWORDS     0x00000005L /* VT_LPSTR */")
214   cpp_quote("#define PIDSI_COMMENTS     0x00000006L /* VT_LPSTR */")
215   cpp_quote("#define PIDSI_TEMPLATE     0x00000007L /* VT_LPSTR */")
216   cpp_quote("#define PIDSI_LASTAUTHOR   0x00000008L /* VT_LPSTR */")
217   cpp_quote("#define PIDSI_REVNUMBER    0x00000009L /* VT_LPSTR */")
218   cpp_quote("#define PIDSI_EDITTIME     0x0000000AL /* VT_FILETIME (UTC) */")
219   cpp_quote("#define PIDSI_LASTPRINTED  0x0000000BL /* VT_FILETIME (UTC) */")
220   cpp_quote("#define PIDSI_CREATE_DTM   0x0000000CL /* VT_FILETIME (UTC) */")
221   cpp_quote("#define PIDSI_LASTSAVE_DTM 0x0000000DL /* VT_FILETIME (UTC) */")
222   cpp_quote("#define PIDSI_PAGECOUNT    0x0000000EL /* VT_I4 */")
223   cpp_quote("#define PIDSI_WORDCOUNT    0x0000000FL /* VT_I4 */")
224   cpp_quote("#define PIDSI_CHARCOUNT    0x00000010L /* VT_I4 */")
225   cpp_quote("#define PIDSI_THUMBNAIL    0x00000011L /* VT_CF */")
226   cpp_quote("#define PIDSI_APPNAME      0x00000012L /* VT_LPSTR */")
227   cpp_quote("#define PIDSI_DOC_SECURITY 0x00000013L /* VT_I4 */")
228   cpp_quote("")
229   cpp_quote("#define PIDDSI_CATEGORY    0x00000002L /* VT_LPSTR */")
230   cpp_quote("#define PIDDSI_PRESFORMAT  0x00000003L /* VT_LPSTR */")
231   cpp_quote("#define PIDDSI_BYTECOUNT   0x00000004L /* VT_I4 */")
232   cpp_quote("#define PIDDSI_LINECOUNT   0x00000005L /* VT_I4 */")
233   cpp_quote("#define PIDDSI_PARCOUNT    0x00000006L /* VT_I4 */")
234   cpp_quote("#define PIDDSI_SLIDECOUNT  0x00000007L /* VT_I4 */")
235   cpp_quote("#define PIDDSI_NOTECOUNT   0x00000008L /* VT_I4 */")
236   cpp_quote("#define PIDDSI_HIDDENCOUNT 0x00000009L /* VT_I4 */")
237   cpp_quote("#define PIDDSI_MMCLIPCOUNT 0x0000000AL /* VT_I4 */")
238   cpp_quote("#define PIDDSI_SCALE       0x0000000BL /* VT_BOOL */")
239   cpp_quote("#define PIDDSI_HEADINGPAIR 0x0000000CL /* VT_VARIANT|VT_VECTOR */")
240   cpp_quote("#define PIDDSI_DOCPARTS    0x0000000DL /* VT_LPSTR|VT_VECTOR */")
241   cpp_quote("#define PIDDSI_MANAGER     0x0000000EL /* VT_LPSTR */")
242   cpp_quote("#define PIDDSI_COMPANY     0x0000000FL /* VT_LPSTR */")
243   cpp_quote("#define PIDDSI_LINKSDIRTY  0x00000010L /* VT_B0OL */")
244
245   const ULONG PRSPEC_INVALID = 0xffffffff;
246   const ULONG PRSPEC_LPWSTR = 0;
247   const ULONG PRSPEC_PROPID = 1;
248
249   typedef struct tagPROPSPEC {
250     ULONG ulKind;
251     [switch_is(ulKind)] union {
252     [case(PRSPEC_PROPID)] PROPID propid;
253     [case(PRSPEC_LPWSTR)] LPOLESTR lpwstr;
254     [default]             ;
255     };
256   } PROPSPEC;
257
258   typedef struct tagSTATPROPSTG {
259     LPOLESTR lpwstrName;
260     PROPID propid;
261     VARTYPE vt;
262   } STATPROPSTG;
263
264   cpp_quote("/* Macros for dwOSVersion member of STATPROPSETSTG */")
265   cpp_quote("#define PROPSETHDR_OSVER_KIND(dwOSVer)  HIWORD((dwOSVer))")
266   cpp_quote("#define PROPSETHDR_OSVER_MAJOR(dwOSVer) LOBYTE(LOWORD((dwOSVer)))")
267   cpp_quote("#define PROPSETHDR_OSVER_MINOR(dwOSVer) HIBYTE(LOWORD((dwOSVer)))")
268   cpp_quote("#define PROPSETHDR_OSVERSION_UNKNOWN    0xffffffff")
269
270   typedef struct tagSTATPROPSETSTG {
271     FMTID fmtid;
272     CLSID clsid;
273     DWORD grfFlags;
274     FILETIME mtime;
275     FILETIME ctime;
276     FILETIME atime;
277     DWORD dwOSVersion;
278   } STATPROPSETSTG;
279
280   HRESULT ReadMultiple(
281     [in] ULONG cpspec,
282     [in, size_is(cpspec)] const PROPSPEC rgpspec[],
283     [out, size_is(cpspec)] PROPVARIANT rgpropvar[]);
284
285   HRESULT WriteMultiple(
286     [in] ULONG cpspec,
287     [in, size_is(cpspec)] const PROPSPEC rgpspec[],
288     [in, size_is(cpspec)] const PROPVARIANT rgpropvar[],
289     [in] PROPID propidNameFirst);
290
291   HRESULT DeleteMultiple(
292     [in] ULONG cpspec,
293     [in, size_is(cpspec)] const PROPSPEC rgpspec[]);
294
295   HRESULT ReadPropertyNames(
296     [in] ULONG cpropid,
297     [in, size_is(cpropid)] const PROPID rgpropid[],
298     [out, size_is(cpropid)] LPOLESTR rglpwstrName[]);
299
300   HRESULT WritePropertyNames(
301     [in] ULONG cpropid,
302     [in, size_is(cpropid)] const PROPID rgpropid[],
303     [in, size_is(cpropid)] const LPOLESTR rglpwstrName[]);
304
305   HRESULT DeletePropertyNames(
306     [in] ULONG cpropid,
307     [in, size_is(cpropid)] const PROPID rgpropid[]);
308
309   HRESULT Commit(
310     [in] DWORD grfCommitFlags);
311
312   HRESULT Revert();
313
314   HRESULT Enum(
315     [out] IEnumSTATPROPSTG **ppenum);
316
317   HRESULT SetTimes(
318     [in] const FILETIME *pctime,
319     [in] const FILETIME *patime,
320     [in] const FILETIME *pmtime);
321
322   HRESULT SetClass(
323     [in] REFCLSID clsid);
324
325   HRESULT Stat(
326     [out] STATPROPSETSTG *statpsstg);
327 }
328
329 [
330   object,
331   uuid(0000013A-0000-0000-C000-000000000046),
332   pointer_default(unique)
333 ]
334 interface IPropertySetStorage : IUnknown
335 {
336   typedef [unique] IPropertySetStorage *LPPROPERTYSETSTORAGE;
337
338   HRESULT Create(
339     [in] REFFMTID rfmtid,
340     [in, unique] const CLSID *pclsid,
341     [in] DWORD grfFlags,
342     [in] DWORD grfMode,
343     [out] IPropertyStorage **ppprstg);
344
345   HRESULT Open(
346     [in] REFFMTID rfmtid,
347     [in] DWORD grfMode,
348     [out] IPropertyStorage **ppprstg);
349
350   HRESULT Delete(
351     [in] REFFMTID rfmtid);
352
353   HRESULT Enum(
354     [out] IEnumSTATPROPSETSTG **ppenum);
355 }
356
357 [
358   object,
359   uuid(00000139-0000-0000-C000-000000000046),
360   pointer_default(unique)
361 ]
362 interface IEnumSTATPROPSTG : IUnknown
363 {
364   typedef [unique] IEnumSTATPROPSTG *LPENUMSTATPROPSTG;
365
366   [local]
367   HRESULT Next(
368     [in] ULONG celt,
369     [out, size_is(celt), length_is(*pceltFetched)]
370     STATPROPSTG *rgelt,
371     [out] ULONG *pceltFetched);
372
373   [call_as(Next)]
374   HRESULT RemoteNext(
375     [in] ULONG celt,
376     [out, size_is(celt), length_is(*pceltFetched)]
377     STATPROPSTG *rgelt,
378     [out] ULONG *pceltFetched);
379
380   HRESULT Skip(
381     [in] ULONG celt);
382
383   HRESULT Reset();
384
385   HRESULT Clone(
386     [out] IEnumSTATPROPSTG **ppenum);
387 }
388
389 [
390   object,
391   uuid(0000013B-0000-0000-C000-000000000046),
392   pointer_default(unique)
393 ]
394 interface IEnumSTATPROPSETSTG : IUnknown
395 {
396   typedef [unique] IEnumSTATPROPSETSTG *LPENUMSTATPROPSETSTG;
397
398   [local]
399   HRESULT Next(
400     [in] ULONG celt,
401     [out, size_is(celt), length_is(*pceltFetched)]
402     STATPROPSETSTG *rgelt,
403     [out] ULONG *pceltFetched);
404
405   [call_as(Next)]
406   HRESULT RemoteNext(
407     [in] ULONG celt,
408     [out, size_is(celt), length_is(*pceltFetched)]
409     STATPROPSETSTG *rgelt,
410     [out] ULONG *pceltFetched);
411
412   HRESULT Skip(
413     [in] ULONG celt);
414
415   HRESULT Reset();
416
417   HRESULT Clone(
418     [out] IEnumSTATPROPSETSTG **ppenum);
419 }
420
421
422 cpp_quote("HRESULT WINAPI FreePropVariantArray(ULONG,PROPVARIANT*);")
423 cpp_quote("HRESULT WINAPI PropVariantClear(PROPVARIANT*);")
424 cpp_quote("HRESULT WINAPI PropVariantCopy(PROPVARIANT*,const PROPVARIANT*);")
425 cpp_quote("")
426 cpp_quote("#define _PROPVARIANT_INIT_DEFINED_")
427 cpp_quote("#define PropVariantInit(p) memset((p), 0, sizeof(PROPVARIANT))")
428 cpp_quote("")
429 cpp_quote("#ifndef _STGCREATEPROPSTG_DEFINED_")
430 cpp_quote("#define _STGCREATEPROPSTG_DEFINED_")
431 cpp_quote("HRESULT WINAPI StgCreatePropStg(IUnknown *, REFFMTID, const CLSID *, DWORD, DWORD, IPropertyStorage **);")
432 cpp_quote("HRESULT WINAPI StgOpenPropStg(IUnknown *, REFFMTID, DWORD, DWORD, IPropertyStorage **);")
433 cpp_quote("HRESULT WINAPI StgCreatePropSetStg(IStorage *, DWORD, IPropertySetStorage **);")
434 cpp_quote("#define CCH_MAX_PROPSTG_NAME 31")
435 cpp_quote("HRESULT WINAPI FmtIdToPropStgName(const FMTID *, LPOLESTR);")
436 cpp_quote("HRESULT WINAPI PropStgNameToFmtId(const LPOLESTR, FMTID *);")
437 cpp_quote("#endif /* _STGCREATEPROPSTG_DEFINED_ */")
438 cpp_quote("")