2 * Pointer Moniker Implementation
4 * Copyright 1999 Noomen Hamza
5 * Copyright 2008 Robert Shearman (for CodeWeavers)
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
26 #define NONAMELESSUNION
34 #include "wine/debug.h"
37 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
39 /* PointerMoniker data structure */
40 typedef struct PointerMonikerImpl
{
42 IMoniker IMoniker_iface
;
44 LONG ref
; /* reference counter for this object */
46 IUnknown
*pObject
; /* custom marshaler */
49 static inline PointerMonikerImpl
*impl_from_IMoniker(IMoniker
*iface
)
51 return CONTAINING_RECORD(iface
, PointerMonikerImpl
, IMoniker_iface
);
55 PointerMonikerImpl_QueryInterface(IMoniker
* iface
,REFIID riid
,void** ppvObject
)
57 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
59 TRACE("(%p,%p,%p)\n",This
,riid
,ppvObject
);
61 /* Perform a sanity check on the parameters.*/
62 if ( (This
==0) || (ppvObject
==0) )
65 /* Initialize the return parameter */
68 /* Compare the riid with the interface IDs implemented by this object.*/
69 if (IsEqualIID(&IID_IUnknown
, riid
) ||
70 IsEqualIID(&IID_IPersist
, riid
) ||
71 IsEqualIID(&IID_IPersistStream
, riid
) ||
72 IsEqualIID(&IID_IMoniker
, riid
))
75 /* Check that we obtained an interface.*/
79 /* always increase the reference count by one when it is successful */
80 IMoniker_AddRef(iface
);
85 /******************************************************************************
86 * PointerMoniker_AddRef
87 ******************************************************************************/
89 PointerMonikerImpl_AddRef(IMoniker
* iface
)
91 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
95 return InterlockedIncrement(&This
->ref
);
98 /******************************************************************************
99 * PointerMoniker_Release
100 ******************************************************************************/
102 PointerMonikerImpl_Release(IMoniker
* iface
)
104 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
107 TRACE("(%p)\n",This
);
109 ref
= InterlockedDecrement(&This
->ref
);
111 /* destroy the object if there are no more references on it */
114 if (This
->pObject
) IUnknown_Release(This
->pObject
);
115 HeapFree(GetProcessHeap(),0,This
);
121 /******************************************************************************
122 * PointerMoniker_GetClassID
123 ******************************************************************************/
124 static HRESULT WINAPI
125 PointerMonikerImpl_GetClassID(IMoniker
* iface
,CLSID
*pClassID
)
127 TRACE("(%p,%p)\n",iface
,pClassID
);
132 *pClassID
= CLSID_PointerMoniker
;
137 /******************************************************************************
138 * PointerMoniker_IsDirty
139 ******************************************************************************/
140 static HRESULT WINAPI
141 PointerMonikerImpl_IsDirty(IMoniker
* iface
)
143 /* Note that the OLE-provided implementations of the IPersistStream::IsDirty
144 method in the OLE-provided moniker interfaces always return S_FALSE because
145 their internal state never changes. */
147 TRACE("(%p)\n",iface
);
152 /******************************************************************************
153 * PointerMoniker_Load
154 ******************************************************************************/
155 static HRESULT WINAPI
156 PointerMonikerImpl_Load(IMoniker
* iface
,IStream
* pStm
)
158 TRACE("(%p)\n", pStm
);
163 /******************************************************************************
164 * PointerMoniker_Save
165 ******************************************************************************/
166 static HRESULT WINAPI
167 PointerMonikerImpl_Save(IMoniker
* iface
, IStream
* pStm
, BOOL fClearDirty
)
169 TRACE("(%p, %d)\n", pStm
, fClearDirty
);
174 /******************************************************************************
175 * PointerMoniker_GetSizeMax
178 * pcbSize [out] Pointer to size of stream needed to save object
179 ******************************************************************************/
180 static HRESULT WINAPI
181 PointerMonikerImpl_GetSizeMax(IMoniker
* iface
, ULARGE_INTEGER
* pcbSize
)
183 TRACE("(%p,%p)\n",iface
,pcbSize
);
188 pcbSize
->u
.LowPart
= 0;
189 pcbSize
->u
.HighPart
= 0;
194 /******************************************************************************
195 * PointerMoniker_BindToObject
196 ******************************************************************************/
197 static HRESULT WINAPI
198 PointerMonikerImpl_BindToObject(IMoniker
* iface
, IBindCtx
* pbc
, IMoniker
* pmkToLeft
,
199 REFIID riid
, VOID
** ppvResult
)
201 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
203 TRACE("(%p,%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,riid
,ppvResult
);
208 return IUnknown_QueryInterface(This
->pObject
, riid
, ppvResult
);
211 /******************************************************************************
212 * PointerMoniker_BindToStorage
213 ******************************************************************************/
214 static HRESULT WINAPI
215 PointerMonikerImpl_BindToStorage(IMoniker
* iface
, IBindCtx
* pbc
, IMoniker
* pmkToLeft
,
216 REFIID riid
, VOID
** ppvResult
)
218 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
220 TRACE("(%p,%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,riid
,ppvResult
);
225 return IUnknown_QueryInterface(This
->pObject
, riid
, ppvResult
);
228 /******************************************************************************
229 * PointerMoniker_Reduce
230 ******************************************************************************/
231 static HRESULT WINAPI
232 PointerMonikerImpl_Reduce(IMoniker
* iface
, IBindCtx
* pbc
, DWORD dwReduceHowFar
,
233 IMoniker
** ppmkToLeft
, IMoniker
** ppmkReduced
)
235 TRACE("(%p,%p,%d,%p,%p)\n",iface
,pbc
,dwReduceHowFar
,ppmkToLeft
,ppmkReduced
);
237 if (ppmkReduced
==NULL
)
240 PointerMonikerImpl_AddRef(iface
);
244 return MK_S_REDUCED_TO_SELF
;
246 /******************************************************************************
247 * PointerMoniker_ComposeWith
248 ******************************************************************************/
249 static HRESULT WINAPI
250 PointerMonikerImpl_ComposeWith(IMoniker
* iface
, IMoniker
* pmkRight
,
251 BOOL fOnlyIfNotGeneric
, IMoniker
** ppmkComposite
)
256 IEnumMoniker
* penumMk
=0;
257 IMoniker
*pmostLeftMk
=0;
258 IMoniker
* tempMkComposite
=0;
260 TRACE("(%p,%d,%p)\n", pmkRight
, fOnlyIfNotGeneric
, ppmkComposite
);
262 if ((ppmkComposite
==NULL
)||(pmkRight
==NULL
))
267 IMoniker_IsSystemMoniker(pmkRight
,&mkSys
);
269 /* If pmkRight is an anti-moniker, the returned moniker is NULL */
270 if(mkSys
==MKSYS_ANTIMONIKER
)
274 /* if pmkRight is a composite whose leftmost component is an anti-moniker, */
275 /* the returned moniker is the composite after the leftmost anti-moniker is removed. */
277 if(mkSys
==MKSYS_GENERICCOMPOSITE
){
279 res
=IMoniker_Enum(pmkRight
,TRUE
,&penumMk
);
284 res
=IEnumMoniker_Next(penumMk
,1,&pmostLeftMk
,NULL
);
286 IMoniker_IsSystemMoniker(pmostLeftMk
,&mkSys2
);
288 if(mkSys2
==MKSYS_ANTIMONIKER
){
290 IMoniker_Release(pmostLeftMk
);
292 tempMkComposite
=iface
;
293 IMoniker_AddRef(iface
);
295 while(IEnumMoniker_Next(penumMk
,1,&pmostLeftMk
,NULL
)==S_OK
){
297 res
=CreateGenericComposite(tempMkComposite
,pmostLeftMk
,ppmkComposite
);
299 IMoniker_Release(tempMkComposite
);
300 IMoniker_Release(pmostLeftMk
);
302 tempMkComposite
=*ppmkComposite
;
303 IMoniker_AddRef(tempMkComposite
);
308 return CreateGenericComposite(iface
,pmkRight
,ppmkComposite
);
310 /* If pmkRight is not an anti-moniker, the method combines the two monikers into a generic
311 composite if fOnlyIfNotGeneric is FALSE; if fOnlyIfNotGeneric is TRUE, the method returns
312 a NULL moniker and a return value of MK_E_NEEDGENERIC */
314 if (!fOnlyIfNotGeneric
)
315 return CreateGenericComposite(iface
,pmkRight
,ppmkComposite
);
318 return MK_E_NEEDGENERIC
;
321 /******************************************************************************
322 * PointerMoniker_Enum
323 ******************************************************************************/
324 static HRESULT WINAPI
325 PointerMonikerImpl_Enum(IMoniker
* iface
,BOOL fForward
, IEnumMoniker
** ppenumMoniker
)
327 TRACE("(%p,%d,%p)\n",iface
,fForward
,ppenumMoniker
);
329 if (ppenumMoniker
== NULL
)
332 *ppenumMoniker
= NULL
;
337 /******************************************************************************
338 * PointerMoniker_IsEqual
339 ******************************************************************************/
340 static HRESULT WINAPI
341 PointerMonikerImpl_IsEqual(IMoniker
* iface
,IMoniker
* pmkOtherMoniker
)
343 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
346 TRACE("(%p,%p)\n",iface
,pmkOtherMoniker
);
348 if (pmkOtherMoniker
==NULL
)
351 IMoniker_IsSystemMoniker(pmkOtherMoniker
,&mkSys
);
353 if (mkSys
==MKSYS_POINTERMONIKER
)
355 PointerMonikerImpl
*pOtherMoniker
= impl_from_IMoniker(pmkOtherMoniker
);
356 return This
->pObject
== pOtherMoniker
->pObject
? S_OK
: S_FALSE
;
362 /******************************************************************************
363 * PointerMoniker_Hash
364 ******************************************************************************/
365 static HRESULT WINAPI
PointerMonikerImpl_Hash(IMoniker
* iface
,DWORD
* pdwHash
)
367 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
372 *pdwHash
= PtrToUlong(This
->pObject
);
377 /******************************************************************************
378 * PointerMoniker_IsRunning
379 ******************************************************************************/
380 static HRESULT WINAPI
381 PointerMonikerImpl_IsRunning(IMoniker
* iface
, IBindCtx
* pbc
, IMoniker
* pmkToLeft
,
382 IMoniker
* pmkNewlyRunning
)
384 TRACE("(%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,pmkNewlyRunning
);
389 /******************************************************************************
390 * PointerMoniker_GetTimeOfLastChange
391 ******************************************************************************/
392 static HRESULT WINAPI
PointerMonikerImpl_GetTimeOfLastChange(IMoniker
* iface
,
397 TRACE("(%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,pAntiTime
);
401 /******************************************************************************
402 * PointerMoniker_Inverse
403 ******************************************************************************/
404 static HRESULT WINAPI
405 PointerMonikerImpl_Inverse(IMoniker
* iface
,IMoniker
** ppmk
)
407 TRACE("(%p,%p)\n",iface
,ppmk
);
409 return CreateAntiMoniker(ppmk
);
412 /******************************************************************************
413 * PointerMoniker_CommonPrefixWith
414 ******************************************************************************/
415 static HRESULT WINAPI
416 PointerMonikerImpl_CommonPrefixWith(IMoniker
* iface
,IMoniker
* pmkOther
,IMoniker
** ppmkPrefix
)
418 TRACE("(%p, %p)\n", pmkOther
, ppmkPrefix
);
422 if (PointerMonikerImpl_IsEqual(iface
, pmkOther
))
424 IMoniker_AddRef(iface
);
431 return MK_E_NOPREFIX
;
434 /******************************************************************************
435 * PointerMoniker_RelativePathTo
436 ******************************************************************************/
437 static HRESULT WINAPI
438 PointerMonikerImpl_RelativePathTo(IMoniker
* iface
,IMoniker
* pmOther
, IMoniker
** ppmkRelPath
)
440 TRACE("(%p,%p,%p)\n",iface
,pmOther
,ppmkRelPath
);
442 if (ppmkRelPath
==NULL
)
450 /******************************************************************************
451 * PointerMoniker_GetDisplayName
452 ******************************************************************************/
453 static HRESULT WINAPI
454 PointerMonikerImpl_GetDisplayName(IMoniker
* iface
, IBindCtx
* pbc
,
455 IMoniker
* pmkToLeft
, LPOLESTR
*ppszDisplayName
)
457 TRACE("(%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,ppszDisplayName
);
459 if (ppszDisplayName
==NULL
)
462 *ppszDisplayName
= NULL
;
466 /******************************************************************************
467 * PointerMoniker_ParseDisplayName
468 ******************************************************************************/
469 static HRESULT WINAPI
470 PointerMonikerImpl_ParseDisplayName(IMoniker
* iface
, IBindCtx
* pbc
,
471 IMoniker
* pmkToLeft
, LPOLESTR pszDisplayName
,
472 ULONG
* pchEaten
, IMoniker
** ppmkOut
)
474 PointerMonikerImpl
*This
= impl_from_IMoniker(iface
);
476 IParseDisplayName
*pPDN
;
478 TRACE("(%p,%p,%p,%p,%p,%p)\n",iface
,pbc
,pmkToLeft
,pszDisplayName
,pchEaten
,ppmkOut
);
486 hr
= IUnknown_QueryInterface(This
->pObject
, &IID_IParseDisplayName
, (void **)&pPDN
);
490 hr
= IParseDisplayName_ParseDisplayName(pPDN
, pbc
, pszDisplayName
, pchEaten
, ppmkOut
);
491 IParseDisplayName_Release(pPDN
);
496 /******************************************************************************
497 * PointerMoniker_IsSystemMoniker
498 ******************************************************************************/
499 static HRESULT WINAPI
500 PointerMonikerImpl_IsSystemMoniker(IMoniker
* iface
,DWORD
* pwdMksys
)
502 TRACE("(%p,%p)\n",iface
,pwdMksys
);
507 *pwdMksys
= MKSYS_POINTERMONIKER
;
512 /********************************************************************************/
513 /* Virtual function table for the PointerMonikerImpl class which include IPersist,*/
514 /* IPersistStream and IMoniker functions. */
515 static const IMonikerVtbl VT_PointerMonikerImpl
=
517 PointerMonikerImpl_QueryInterface
,
518 PointerMonikerImpl_AddRef
,
519 PointerMonikerImpl_Release
,
520 PointerMonikerImpl_GetClassID
,
521 PointerMonikerImpl_IsDirty
,
522 PointerMonikerImpl_Load
,
523 PointerMonikerImpl_Save
,
524 PointerMonikerImpl_GetSizeMax
,
525 PointerMonikerImpl_BindToObject
,
526 PointerMonikerImpl_BindToStorage
,
527 PointerMonikerImpl_Reduce
,
528 PointerMonikerImpl_ComposeWith
,
529 PointerMonikerImpl_Enum
,
530 PointerMonikerImpl_IsEqual
,
531 PointerMonikerImpl_Hash
,
532 PointerMonikerImpl_IsRunning
,
533 PointerMonikerImpl_GetTimeOfLastChange
,
534 PointerMonikerImpl_Inverse
,
535 PointerMonikerImpl_CommonPrefixWith
,
536 PointerMonikerImpl_RelativePathTo
,
537 PointerMonikerImpl_GetDisplayName
,
538 PointerMonikerImpl_ParseDisplayName
,
539 PointerMonikerImpl_IsSystemMoniker
542 /******************************************************************************
543 * PointerMoniker_Construct (local function)
544 *******************************************************************************/
545 static void PointerMonikerImpl_Construct(PointerMonikerImpl
* This
, IUnknown
*punk
)
547 TRACE("(%p)\n",This
);
549 /* Initialize the virtual function table. */
550 This
->IMoniker_iface
.lpVtbl
= &VT_PointerMonikerImpl
;
553 IUnknown_AddRef(punk
);
554 This
->pObject
= punk
;
557 /***********************************************************************
558 * CreatePointerMoniker (OLE32.@)
560 * Creates a moniker which represents a pointer.
563 * punk [I] Pointer to the object to represent.
564 * ppmk [O] Address that receives the pointer to the created moniker.
568 * Failure: Any HRESULT code.
570 HRESULT WINAPI
CreatePointerMoniker(LPUNKNOWN punk
, LPMONIKER
*ppmk
)
572 PointerMonikerImpl
*This
;
574 TRACE("(%p, %p)\n", punk
, ppmk
);
579 This
= HeapAlloc(GetProcessHeap(), 0, sizeof(*This
));
583 return E_OUTOFMEMORY
;
586 PointerMonikerImpl_Construct(This
, punk
);
587 *ppmk
= &This
->IMoniker_iface
;
591 static HRESULT WINAPI
PointerMonikerCF_QueryInterface(LPCLASSFACTORY iface
,
592 REFIID riid
, LPVOID
*ppv
)
595 if (IsEqualIID(riid
, &IID_IUnknown
) || IsEqualIID(riid
, &IID_IClassFactory
))
598 IClassFactory_AddRef(iface
);
601 return E_NOINTERFACE
;
604 static ULONG WINAPI
PointerMonikerCF_AddRef(LPCLASSFACTORY iface
)
606 return 2; /* non-heap based object */
609 static ULONG WINAPI
PointerMonikerCF_Release(LPCLASSFACTORY iface
)
611 return 1; /* non-heap based object */
614 static HRESULT WINAPI
PointerMonikerCF_CreateInstance(LPCLASSFACTORY iface
,
615 LPUNKNOWN pUnk
, REFIID riid
, LPVOID
*ppv
)
620 TRACE("(%p, %s, %p)\n", pUnk
, debugstr_guid(riid
), ppv
);
625 return CLASS_E_NOAGGREGATION
;
627 hr
= CreatePointerMoniker(NULL
, &pMoniker
);
631 hr
= IMoniker_QueryInterface(pMoniker
, riid
, ppv
);
634 IMoniker_Release(pMoniker
);
639 static HRESULT WINAPI
PointerMonikerCF_LockServer(LPCLASSFACTORY iface
, BOOL fLock
)
641 FIXME("(%d), stub!\n",fLock
);
645 static const IClassFactoryVtbl PointerMonikerCFVtbl
=
647 PointerMonikerCF_QueryInterface
,
648 PointerMonikerCF_AddRef
,
649 PointerMonikerCF_Release
,
650 PointerMonikerCF_CreateInstance
,
651 PointerMonikerCF_LockServer
653 static const IClassFactoryVtbl
*PointerMonikerCF
= &PointerMonikerCFVtbl
;
655 HRESULT
PointerMonikerCF_Create(REFIID riid
, LPVOID
*ppv
)
657 return IClassFactory_QueryInterface((IClassFactory
*)&PointerMonikerCF
, riid
, ppv
);