Read/load type libraries. Implementation of ITypeLib, ITYpeInfo,
[wine] / include / wine / obj_moniker.h
1 /*
2  * Defines the COM interfaces and APIs related to the moniker functionality.
3  */
4 #ifndef __WINE_WINE_OBJ_MONIKER_H
5 #define __WINE_WINE_OBJ_MONIKER_H
6
7 #include "wine/obj_base.h"
8 #include "wine/obj_storage.h"
9 #include "wine/obj_misc.h"
10
11 /*****************************************************************************
12  * Predeclare the interfaces
13  */
14 DEFINE_OLEGUID(IID_IBindCtx,0xe,0,0);
15 typedef struct IBindCtx IBindCtx,*LPBINDCTX;
16 typedef LPBINDCTX LPBC;
17
18 DEFINE_OLEGUID(IID_IClassActivator,     0x00000140L, 0, 0);
19 typedef struct IClassActivator IClassActivator,*LPCLASSACTIVATOR;
20
21 DEFINE_OLEGUID(IID_IEnumMoniker,        0x00000102L, 0, 0);
22 typedef struct IEnumMoniker IEnumMoniker,*LPENUMMONIKER;
23
24 DEFINE_OLEGUID(IID_IMoniker,            0x0000000fL, 0, 0);
25 typedef struct IMoniker IMoniker,*LPMONIKER;
26
27 DEFINE_GUID   (IID_IROTData,            0xf29f6bc0L, 0x5021, 0x11ce, 0xaa, 0x15, 0x00, 0x00, 0x69, 0x01, 0x29, 0x3f);
28 typedef struct IROTData IROTData,*LPROTDATA;
29
30 DEFINE_OLEGUID(IID_IRunnableObject,     0x00000126L, 0, 0);
31 typedef struct IRunnableObject IRunnableObject,*LPRUNNABLEOBJECT;
32
33 DEFINE_OLEGUID(IID_IRunningObjectTable, 0x00000010L, 0, 0);
34 typedef struct IRunningObjectTable IRunningObjectTable,*LPRUNNINGOBJECTTABLE;
35
36 DEFINE_GUID( CLSID_FileMoniker,0x00000303,0,0,0xc0,0,0,0,0,0,0,0x46);
37
38 DEFINE_GUID( CLSID_ItemMoniker,0x00000304,0,0,0xc0,0,0,0,0,0,0,0x46);
39
40 DEFINE_GUID( CLSID_AntiMoniker,0x00000305,0,0,0xc0,0,0,0,0,0,0,0x46);
41
42 DEFINE_GUID( CLSID_CompositeMoniker,0x00000309,0,0,0xc0,0,0,0,0,0,0,0x46);
43
44 /*********************************************************************************
45  *      BIND_OPTS and BIND_OPTS2 structures definition
46  *      These structures contain parameters used during a moniker-binding operation.
47  *********************************************************************************/
48 typedef struct tagBIND_OPTS
49 {
50     DWORD cbStruct;
51     DWORD grfFlags;
52     DWORD grfMode;
53     DWORD dwTickCountDeadline;
54 } BIND_OPTS, * LPBIND_OPTS;
55
56 typedef struct tagBIND_OPTS2
57 {
58     DWORD cbStruct;
59     DWORD grfFlags;
60     DWORD grfMode;
61     DWORD dwTickCountDeadline;
62     DWORD dwTrackFlags;
63     DWORD dwClassContext;
64     LCID  locale;
65     COSERVERINFO* pServerInfo;
66 } BIND_OPTS2, * LPBIND_OPTS2;
67
68 /*****************************************************************************
69  * IBindCtx interface
70  */
71 #define ICOM_INTERFACE IBindCtx
72 #define IBindCtx_METHODS \
73     ICOM_METHOD1 (HRESULT, RegisterObjectBound,  IUnknown*,punk) \
74     ICOM_METHOD1 (HRESULT, RevokeObjectBound,    IUnknown*,punk) \
75     ICOM_METHOD  (HRESULT, ReleaseBoundObjects) \
76     ICOM_METHOD1 (HRESULT, SetBindOptions,       LPBIND_OPTS2,pbindopts) \
77     ICOM_METHOD1 (HRESULT, GetBindOptions,       LPBIND_OPTS2,pbindopts) \
78     ICOM_METHOD1 (HRESULT, GetRunningObjectTable,IRunningObjectTable**,pprot) \
79     ICOM_METHOD2 (HRESULT, RegisterObjectParam,  LPOLESTR,pszkey, IUnknown*,punk) \
80     ICOM_METHOD2 (HRESULT, GetObjectParam,       LPOLESTR,pszkey, IUnknown**,punk) \
81     ICOM_METHOD1 (HRESULT, EnumObjectParam,      IEnumString**,ppenum) \
82     ICOM_METHOD1 (HRESULT, RevokeObjectParam,    LPOLESTR,pszkey)
83 #define IBindCtx_IMETHODS \
84     IUnknown_IMETHODS \
85     IBindCtx_METHODS
86 ICOM_DEFINE(IBindCtx,IUnknown)
87 #undef ICOM_INTERFACE
88
89 #ifdef ICOM_CINTERFACE
90 /*** IUnknown methods ***/
91 #define IBindCtx_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
92 #define IBindCtxr_AddRef(p)            ICOM_CALL (AddRef,p)
93 #define IBindCtx_Release(p)            ICOM_CALL (Release,p)
94 /* IBindCtx methods*/
95 #define IBindCtx_RegisterObjectBound(p,a)   ICOM_CALL1(RegisterObjectBound,p,a)
96 #define IBindCtx_RevokeObjectBound(p,a)     ICOM_CALL1(RevokeObjectBound,p,a)
97 #define IBindCtx_ReleaseBoundObjects(p)     ICOM_CALL (ReleaseBoundObjects,p)
98 #define IBindCtx_SetBindOptions(p,a)        ICOM_CALL1(SetBindOptions,p,a)
99 #define IBindCtx_GetBindOptions(p,a)        ICOM_CALL1(GetBindOptions,p,a)
100 #define IBindCtx_GetRunningObjectTable(p,a) ICOM_CALL1(GetRunningObjectTable,p,a)
101 #define IBindCtx_RegisterObjectParam(p,a,b) ICOM_CALL2(RegisterObjectParam,p,a,b)
102 #define IBindCtx_GetObjectParam(p,a,b)      ICOM_CALL2(GetObjectParam,p,a,b)
103 #define IBindCtx_EnumObjectParam(p,a)       ICOM_CALL1(EnumObjectParam,p,a)
104 #define IBindCtx_RevokeObjectParam(p,a)     ICOM_CALL1(RevokeObjectParam,p,a)
105 #endif
106
107 HRESULT WINAPI CreateBindCtx16(DWORD reserved, LPBC* ppbc);
108 HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC* ppbc);
109
110 /*****************************************************************************
111  * IClassActivator interface
112  */
113 #define ICOM_INTERFACE IClassActivator
114 #define IClassActivator_METHODS \
115     ICOM_METHOD5(HRESULT,GetClassObject, REFCLSID,rclsid, DWORD,dwClassContext, LCID,locale, REFIID,riid, void**,ppv)
116 #define IClassActivator_IMETHODS \
117     IUnknown_IMETHODS \
118     IClassActivator_METHODS
119 ICOM_DEFINE(IClassActivator,IUnknown)
120 #undef ICOM_INTERFACE
121
122 #ifdef ICOM_CINTERFACE
123 /*** IUnknown methods ***/
124 #define IClassActivator_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
125 #define IClassActivator_AddRef(p)             ICOM_CALL (AddRef,p)
126 #define IClassActivator_Release(p)            ICOM_CALL (Release,p)
127 /*** IClassActivator methods ***/
128 #define IClassActivator_GetClassObject(p,a,b,c,d,e) ICOM_CALL5(GetClassObject,p,a,b,c,d,e)
129 #endif
130
131
132 /*****************************************************************************
133  * IEnumMoniker interface
134  */
135 #define ICOM_INTERFACE IEnumMoniker
136 #define IEnumMoniker_METHODS \
137     ICOM_METHOD3(HRESULT,Next,  ULONG,celt, IMoniker**,rgelt, ULONG*,pceltFethed) \
138     ICOM_METHOD1(HRESULT,Skip,  ULONG,celt) \
139     ICOM_METHOD (HRESULT,Reset) \
140     ICOM_METHOD1(HRESULT,Clone, IEnumMoniker**,ppenum)
141 #define IEnumMoniker_IMETHODS \
142     IUnknown_IMETHODS \
143     IEnumMoniker_METHODS
144 ICOM_DEFINE(IEnumMoniker,IUnknown)
145 #undef ICOM_INTERFACE
146
147 #ifdef ICOM_CINTERFACE
148 /*** IUnknown methods ***/
149 #define IEnumMoniker_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
150 #define IEnumMoniker_AddRef(p)             ICOM_CALL (AddRef,p)
151 #define IEnumMoniker_Release(p)            ICOM_CALL (Release,p)
152 /*** IEnumMoniker methods ***/
153 #define IEnumMoniker_Next(p,a,b,c) ICOM_CALL3(Next,p,a,b,c)
154 #define IEnumMoniker_Skip(p,a)     ICOM_CALL1(Skip,p,a)
155 #define IEnumMoniker_Reset(p)      ICOM_CALL (Reset,p)
156 #define IEnumMoniker_Clone(p,a)    ICOM_CALL1(Clone,p,a)
157 #endif
158
159 /*****************************************************************************
160  * IMoniker interface
161  */
162
163 typedef enum tagMKSYS
164 {
165     MKSYS_NONE              = 0,
166     MKSYS_GENERICCOMPOSITE  = 1,
167     MKSYS_FILEMONIKER       = 2,
168     MKSYS_ANTIMONIKER       = 3,
169     MKSYS_ITEMMONIKER       = 4,
170     MKSYS_POINTERMONIKER    = 5,
171     MKSYS_CLASSMONIKER      = 7
172 } MKSYS;
173
174 typedef enum tagMKREDUCE
175 {
176     MKRREDUCE_ONE           = 3 << 16,
177     MKRREDUCE_TOUSER        = 2 << 16,
178     MKRREDUCE_THROUGHUSER   = 1 << 16,
179     MKRREDUCE_ALL           = 0
180 } MKRREDUCE;
181
182 #define ICOM_INTERFACE IMoniker
183 #define IMoniker_METHODS \
184     ICOM_METHOD4(HRESULT,BindToObject,        IBindCtx*,pbc, IMoniker*,pmkToLeft, REFIID,riidResult, void**,ppvResult) \
185     ICOM_METHOD4(HRESULT,BindToStorage,       IBindCtx*,pbc, IMoniker*,pmkToLeft, REFIID,riid, void**,ppvObj) \
186     ICOM_METHOD4(HRESULT,Reduce,              IBindCtx*,pbc, DWORD,dwReduceHowFar, IMoniker**,ppmkToLeft, IMoniker**,ppmkReduced) \
187     ICOM_METHOD3(HRESULT,ComposeWith,         IMoniker*,pmkRight, BOOL,fOnlyIfNotGeneric, IMoniker**,ppmkComposite) \
188     ICOM_METHOD2(HRESULT,Enum,                BOOL,fForward, IEnumMoniker**,ppenumMoniker) \
189     ICOM_METHOD1(HRESULT,IsEqual,             IMoniker*,pmkOtherMoniker) \
190     ICOM_METHOD1(HRESULT,Hash,                DWORD*,pdwHash) \
191     ICOM_METHOD3(HRESULT,IsRunning,           IBindCtx*,pbc, IMoniker*,pmkToLeft, IMoniker*,pmkNewlyRunning) \
192     ICOM_METHOD3(HRESULT,GetTimeOfLastChange, IBindCtx*,pbc, IMoniker*,pmkToLeft, FILETIME*,pFileTime) \
193     ICOM_METHOD1(HRESULT,Inverse,             IMoniker**,ppmk) \
194     ICOM_METHOD2(HRESULT,CommonPrefixWith,    IMoniker*,pmkOtherMoniker, IMoniker**,ppmkPrefix) \
195     ICOM_METHOD2(HRESULT,RelativePathTo,      IMoniker*,pmkOther, IMoniker**,ppmkRelPath) \
196     ICOM_METHOD3(HRESULT,GetDisplayName,      IBindCtx*,pbc, IMoniker*,pmkToLeft, LPOLESTR*,ppszDisplayName) \
197     ICOM_METHOD5(HRESULT,ParseDisplayName,    IBindCtx*,pbc, IMoniker*,pmkToLeft, LPOLESTR,pszDisplayName, ULONG*,pchEaten, IMoniker**,ppmkOut) \
198     ICOM_METHOD1(HRESULT,IsSystemMoniker,     DWORD*,pdwMksys)
199 #define IMoniker_IMETHODS \
200     IPersistStream_IMETHODS \
201     IMoniker_METHODS
202 ICOM_DEFINE(IMoniker,IPersistStream)
203 #undef ICOM_INTERFACE
204
205 #ifdef ICOM_CINTERFACE
206 /*** IUnknown methods ***/
207 #define IMoniker_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
208 #define IMoniker_AddRef(p)             ICOM_CALL (AddRef,p)
209 #define IMoniker_Release(p)            ICOM_CALL (Release,p)
210
211 /*** IPersist methods ***/
212 #define IMoniker_GetClassID(p,a) ICOM_CALL1(GetClassID,p,a)
213 /*** IPersistStream methods ***/
214 #define IMoniker_IsDirty(p)      ICOM_CALL (IsDirty,p)
215 #define IMoniker_Load(p,a)       ICOM_CALL1(Load,p,a)
216 #define IMoniker_Save(p,a,b)     ICOM_CALL2(Save,p,a,b)
217 #define IMoniker_GetSizeMax(p,a) ICOM_CALL1(GetSizeMax,p,a)
218 /*** IMoniker methods ***/
219 #define IMoniker_BindToObject(p,a,b,c,d)            ICOM_CALL4(BindToObject,p,a,b,c,d)
220 #define IMoniker_BindToStorage(p,a,b,c,d)           ICOM_CALL4(BindToStorage,p,a,b,c,d)
221 #define IMoniker_Reduce(p,a,b,c,d)                  ICOM_CALL4(Reduce,p,a,b,c,d)
222 #define IMoniker_ComposeWith(p,a,b,c)               ICOM_CALL3(ComposeWith,p,a,b,c)
223 #define IMoniker_Enum(p,a,b)                        ICOM_CALL2(Enum,p,a,b)
224 #define IMoniker_IsEqual(p,a)                       ICOM_CALL1(IsEqual,p,a)
225 #define IMoniker_Hash(p,a)                          ICOM_CALL1(Hash,p,a)
226 #define IMoniker_IsRunning(p,a,b,c)                 ICOM_CALL3(IsRunning,p,a,b,c)
227 #define IMoniker_GetTimeOfLastChange(p,a,b,c)       ICOM_CALL3(GetTimeOfLastChange,p,a,b,c)
228 #define IMoniker_Inverse(p,a)                       ICOM_CALL1(Inverse,p,a)
229 #define IMoniker_CommonPrefixWith(p,a,b)            ICOM_CALL2(CommonPrefixWith,p,a,b)
230 #define IMoniker_RelativePathTo(p,a,b)              ICOM_CALL2(RelativePathTo,p,a,b)
231 #define IMoniker_GetDisplayName(p,a,b,c)            ICOM_CALL3(GetDisplayName,p,a,b,c)
232 #define IMoniker_ParseDisplayName(p,a,b,c,d,e)      ICOM_CALL5(ParseDisplayName,p,a,b,c,d,e)
233 #define IMoniker_IsSystemMoniker(p,a)               ICOM_CALL1(IsSystemMoniker,p,a)
234 #endif
235
236 HRESULT WINAPI CreateFileMoniker16(LPCOLESTR16 lpszPathName, LPMONIKER* ppmk);
237 HRESULT WINAPI CreateFileMoniker(LPCOLESTR lpszPathName, LPMONIKER* ppmk);
238
239 HRESULT WINAPI CreateItemMoniker16(LPCOLESTR16 lpszDelim, LPCOLESTR  lpszItem, LPMONIKER* ppmk);
240 HRESULT WINAPI CreateItemMoniker(LPCOLESTR lpszDelim, LPCOLESTR  lpszItem, LPMONIKER* ppmk);
241
242 HRESULT WINAPI CreateAntiMoniker(LPMONIKER * ppmk);
243
244 HRESULT WINAPI CreateGenericComposite(LPMONIKER pmkFirst, LPMONIKER pmkRest, LPMONIKER* ppmkComposite);
245
246 /* FIXME: not implemented */
247 HRESULT WINAPI  BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID iidResult, LPVOID* ppvResult);
248
249 /* FIXME: not implemented */
250 HRESULT WINAPI CreateClassMoniker(REFCLSID rclsid, LPMONIKER* ppmk);
251
252 /* FIXME: not implemented */
253 HRESULT WINAPI CreatePointerMoniker(LPUNKNOWN punk, LPMONIKER* ppmk);
254
255 /* FIXME: not implemented */
256 HRESULT WINAPI MonikerCommonPrefixWith(IMoniker* pmkThis,IMoniker* pmkOther,IMoniker** ppmkCommon);
257 /*****************************************************************************
258  * IROTData interface
259  */
260 #define ICOM_INTERFACE IROTData
261 #define IROTData_METHODS \
262     ICOM_METHOD3(HRESULT,GetComparisonData, byte*,pbData, ULONG,cbMax, ULONG*,pcbData)
263 #define IROTData_IMETHODS \
264     IUnknown_IMETHODS \
265     IROTData_METHODS
266 ICOM_DEFINE(IROTData,IUnknown)
267 #undef ICOM_INTERFACE
268
269 #ifdef ICOM_CINTERFACE
270 /*** IUnknown methods ***/
271 #define IROTData_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
272 #define IROTData_AddRef(p)             ICOM_CALL (AddRef,p)
273 #define IROTData_Release(p)            ICOM_CALL (Release,p)
274 /*** IROTData methods ***/
275 #define IROTData_GetComparisonData(p,a,b,c) ICOM_CALL3(GetComparisonData,p,a,b,c)
276 #endif
277
278 #define ICOM_THIS_From_IROTData(class, name) class* This = (class*)(((char*)name)-sizeof(void*))
279
280 /*****************************************************************************
281  * IRunnableObject interface
282  */
283 #define ICOM_INTERFACE IRunnableObject
284 #define IRunnableObject_METHODS \
285     ICOM_METHOD1(HRESULT,GetRunningClass,    LPCLSID,lpClsid) \
286     ICOM_METHOD1(HRESULT,Run,                IBindCtx*,pbc) \
287     ICOM_METHOD (BOOL,IsRunning) \
288     ICOM_METHOD2(HRESULT,LockRunning,        BOOL,fLock, BOOL,fLastUnlockCloses) \
289     ICOM_METHOD1(HRESULT,SetContainedObject, BOOL,fContained)
290 #define IRunnableObject_IMETHODS \
291     IUnknown_IMETHODS \
292     IRunnableObject_METHODS
293 ICOM_DEFINE(IRunnableObject,IUnknown)
294 #undef ICOM_INTERFACE
295
296 #ifdef ICOM_CINTERFACE
297 /*** IUnknown methods ***/
298 #define IRunnableObject_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
299 #define IRunnableObject_AddRef(p)             ICOM_CALL (AddRef,p)
300 #define IRunnableObject_Release(p)            ICOM_CALL (Release,p)
301 /*** IRunnableObject methods ***/
302 #define IRunnableObject_GetRunningClass(p,a)    ICOM_CALL1(GetRunningClass,p,a)
303 #define IRunnableObject_Run(p,a)                ICOM_CALL1(Run,p,a)
304 #define IRunnableObject_IsRunning(p)            ICOM_CALL (IsRunning,p)
305 #define IRunnableObject_LockRunning(p,a,b)      ICOM_CALL2(LockRunning,p,a,b)
306 #define IRunnableObject_SetContainedObject(p,a) ICOM_CALL1(SetContainedObject,p,a)
307 #endif
308
309
310 /*****************************************************************************
311  * IRunningObjectTable interface
312  */
313 #define ICOM_INTERFACE IRunningObjectTable
314 #define IRunningObjectTable_METHODS \
315     ICOM_METHOD4(HRESULT,Register,            DWORD,grfFlags, IUnknown*,punkObject, IMoniker*,pmkObjectName, DWORD*,pdwRegister) \
316     ICOM_METHOD1(HRESULT,Revoke,              DWORD,dwRegister) \
317     ICOM_METHOD1(HRESULT,IsRunning,           IMoniker*,pmkObjectName) \
318     ICOM_METHOD2(HRESULT,GetObject,           IMoniker*,pmkObjectName, IUnknown**,ppunkObject) \
319     ICOM_METHOD2(HRESULT,NoteChangeTime,      DWORD,dwRegister, FILETIME*,pfiletime) \
320     ICOM_METHOD2(HRESULT,GetTimeOfLastChange, IMoniker*,pmkObjectName, FILETIME*,pfiletime) \
321     ICOM_METHOD1(HRESULT,EnumRunning,         IEnumMoniker**,ppenumMoniker)
322 #define IRunningObjectTable_IMETHODS \
323     IUnknown_IMETHODS \
324     IRunningObjectTable_METHODS
325 ICOM_DEFINE(IRunningObjectTable,IUnknown)
326 #undef ICOM_INTERFACE
327
328 #ifdef ICOM_CINTERFACE
329 /*** IUnknown methods ***/
330 #define IRunningObjectTable_QueryInterface(p,a,b) ICOM_CALL2(QueryInterface,p,a,b)
331 #define IRunningObjectTable_AddRef(p)             ICOM_CALL (AddRef,p)
332 #define IRunningObjectTable_Release(p)            ICOM_CALL (Release,p)
333 /*** IRunningObjectTable methods ***/
334 #define IRunningObjectTable_Register(p,a,b,c,d)        ICOM_CALL4(Register,p,a,b,c,d)
335 #define IRunningObjectTable_Revoke(p,a)                ICOM_CALL1(Revoke,p,a)
336 #define IRunningObjectTable_IsRunning(p,a)             ICOM_CALL1(IsRunning,p,a)
337 #define IRunningObjectTable_GetObject(p,a,b)           ICOM_CALL2(GetObject,p,a,b)
338 #define IRunningObjectTable_NoteChangeTime(p,a,b)      ICOM_CALL2(NoteChangeTime,p,a,b)
339 #define IRunningObjectTable_GetTimeOfLastChange(p,a,b) ICOM_CALL2(GetTimeOfLastChange,p,a,b)
340 #define IRunningObjectTable_EnumRunning(p,a)           ICOM_CALL1(EnumRunning,p,a)
341 #endif
342
343 HRESULT WINAPI GetRunningObjectTable(DWORD reserved, LPVOID *pprot);
344 HRESULT WINAPI GetRunningObjectTable16(DWORD reserved, LPVOID *pprot);
345
346 /*****************************************************************************
347  * Additional API
348  */
349
350 /* FIXME: not implemented */
351 HRESULT WINAPI CoGetInstanceFromFile(COSERVERINFO* pServerInfo, CLSID* pClsid, IUnknown* punkOuter, DWORD dwClsCtx, DWORD grfMode, OLECHAR* pwszName, DWORD dwCount, MULTI_QI* pResults);
352
353 /* FIXME: not implemented */
354 HRESULT WINAPI CoGetInstanceFromIStorage(COSERVERINFO* pServerInfo, CLSID* pClsid, IUnknown* punkOuter, DWORD dwClsCtx, IStorage* pstg, DWORD dwCount, MULTI_QI* pResults);
355
356
357 #endif /* __WINE_WINE_OBJ_MONIKER_H */