msvcp80: Fixed typo in spec file.
[wine] / dlls / hlink / browse_ctx.c
1 /*
2  * Implementation of hyperlinking (hlink.dll)
3  *
4  * Copyright 2005 Aric Stewart for CodeWeavers
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 #include "hlink_private.h"
22
23 #include "wine/debug.h"
24 #include "wine/list.h"
25
26 WINE_DEFAULT_DEBUG_CHANNEL(hlink);
27
28 struct link_entry
29 {
30     struct list entry;
31     IHlink *link;
32 };
33
34 typedef struct
35 {
36     IHlinkBrowseContext IHlinkBrowseContext_iface;
37     LONG        ref;
38     HLBWINFO*   BrowseWindowInfo;
39     struct link_entry *current;
40     struct list links;
41 } HlinkBCImpl;
42
43 static inline HlinkBCImpl *impl_from_IHlinkBrowseContext(IHlinkBrowseContext *iface)
44 {
45     return CONTAINING_RECORD(iface, HlinkBCImpl, IHlinkBrowseContext_iface);
46 }
47
48 static HRESULT WINAPI IHlinkBC_fnQueryInterface( IHlinkBrowseContext *iface,
49         REFIID riid, LPVOID* ppvObj)
50 {
51     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
52     TRACE ("(%p)->(%s,%p)\n", This, debugstr_guid (riid), ppvObj);
53
54     if (IsEqualIID(riid, &IID_IUnknown) ||
55         IsEqualIID(riid, &IID_IHlinkBrowseContext))
56         *ppvObj = This;
57
58     if (*ppvObj)
59     {
60         IUnknown_AddRef((IUnknown*)(*ppvObj));
61         return S_OK;
62     }
63     return E_NOINTERFACE;
64 }
65
66 static ULONG WINAPI IHlinkBC_fnAddRef (IHlinkBrowseContext* iface)
67 {
68     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
69     ULONG refCount = InterlockedIncrement(&This->ref);
70
71     TRACE("(%p)->(count=%u)\n", This, refCount - 1);
72
73     return refCount;
74 }
75
76 static ULONG WINAPI IHlinkBC_fnRelease (IHlinkBrowseContext* iface)
77 {
78     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
79     ULONG ref = InterlockedDecrement(&This->ref);
80
81     TRACE("(%p)->(count=%u)\n", This, ref + 1);
82
83     if (!ref)
84     {
85         struct link_entry *link, *link2;
86
87         LIST_FOR_EACH_ENTRY_SAFE(link, link2, &This->links, struct link_entry, entry)
88         {
89             list_remove(&link->entry);
90             IHlink_Release(link->link);
91             heap_free(link);
92         }
93
94         heap_free(This->BrowseWindowInfo);
95         heap_free(This);
96     }
97
98     return ref;
99 }
100
101 static HRESULT WINAPI IHlinkBC_Register(IHlinkBrowseContext* iface,
102         DWORD dwReserved, IUnknown *piunk, IMoniker *pimk, DWORD *pdwRegister)
103 {
104     static const WCHAR szIdent[] = {'W','I','N','E','H','L','I','N','K',0};
105     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
106     IMoniker *mon;
107     IMoniker *composite;
108     IRunningObjectTable *ROT;
109
110     FIXME("(%p)->(%i %p %p %p)\n", This, dwReserved, piunk, pimk, pdwRegister);
111
112     CreateItemMoniker(NULL, szIdent, &mon);
113     CreateGenericComposite(mon, pimk, &composite);
114
115     GetRunningObjectTable(0, &ROT);
116     IRunningObjectTable_Register(ROT, 0, piunk, composite, pdwRegister);
117
118     IRunningObjectTable_Release(ROT);
119     IMoniker_Release(composite);
120     IMoniker_Release(mon);
121
122     return S_OK;
123 }
124
125 static HRESULT WINAPI IHlinkBC_GetObject(IHlinkBrowseContext* face,
126         IMoniker *pimk, BOOL fBindifRootRegistered, IUnknown **ppiunk)
127 {
128     FIXME("\n");
129     return E_NOTIMPL;
130 }
131
132 static HRESULT WINAPI IHlinkBC_Revoke(IHlinkBrowseContext* iface,
133         DWORD dwRegister)
134 {
135     HRESULT r;
136     IRunningObjectTable *ROT;
137     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
138
139     FIXME("(%p)->(%i)\n", This, dwRegister);
140
141     GetRunningObjectTable(0, &ROT);
142     r = IRunningObjectTable_Revoke(ROT, dwRegister);
143     IRunningObjectTable_Release(ROT);
144
145     return r;
146 }
147
148 static HRESULT WINAPI IHlinkBC_SetBrowseWindowInfo(IHlinkBrowseContext* iface,
149         HLBWINFO *phlbwi)
150 {
151     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
152     TRACE("(%p)->(%p)\n", This, phlbwi);
153
154     if(!phlbwi)
155         return E_INVALIDARG;
156
157     heap_free(This->BrowseWindowInfo);
158     This->BrowseWindowInfo = heap_alloc(phlbwi->cbSize);
159     memcpy(This->BrowseWindowInfo, phlbwi, phlbwi->cbSize);
160
161     return S_OK;
162 }
163
164 static HRESULT WINAPI IHlinkBC_GetBrowseWindowInfo(IHlinkBrowseContext* iface,
165         HLBWINFO *phlbwi)
166 {
167     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
168     TRACE("(%p)->(%p)\n", This, phlbwi);
169
170     if(!phlbwi)
171         return E_INVALIDARG;
172
173     if(!This->BrowseWindowInfo)
174         phlbwi->cbSize = 0;
175     else
176         memcpy(phlbwi, This->BrowseWindowInfo, This->BrowseWindowInfo->cbSize);
177
178     return S_OK;
179 }
180
181 static HRESULT WINAPI IHlinkBC_SetInitialHlink(IHlinkBrowseContext* iface,
182         IMoniker *pimkTarget, LPCWSTR pwzLocation, LPCWSTR pwzFriendlyName)
183 {
184     HlinkBCImpl *This = impl_from_IHlinkBrowseContext(iface);
185     struct link_entry *link;
186
187     TRACE("(%p)->(%p %s %s)\n", This, pimkTarget, debugstr_w(pwzLocation), debugstr_w(pwzFriendlyName));
188
189     if (!list_empty(&This->links))
190         return CO_E_ALREADYINITIALIZED;
191
192     link = heap_alloc(sizeof(struct link_entry));
193     if (!link) return E_OUTOFMEMORY;
194
195     HlinkCreateFromMoniker(pimkTarget, pwzLocation, pwzFriendlyName, NULL,
196             0, NULL, &IID_IHlink, (void**)&link->link);
197
198     list_add_head(&This->links, &link->entry);
199     This->current = LIST_ENTRY(list_head(&This->links), struct link_entry, entry);
200     return S_OK;
201 }
202
203 static HRESULT WINAPI IHlinkBC_OnNavigateHlink(IHlinkBrowseContext *iface,
204         DWORD grfHLNF, IMoniker* pmkTarget, LPCWSTR pwzLocation, LPCWSTR
205         pwzFriendlyName, ULONG *puHLID)
206 {
207     HlinkBCImpl  *This = impl_from_IHlinkBrowseContext(iface);
208
209     FIXME("(%p)->(%i %p %s %s %p)\n", This, grfHLNF, pmkTarget,
210             debugstr_w(pwzLocation), debugstr_w(pwzFriendlyName), puHLID);
211
212     return S_OK;
213 }
214
215 static struct link_entry *context_get_entry(HlinkBCImpl *ctxt, ULONG hlid)
216 {
217     struct list *entry;
218
219     switch (hlid)
220     {
221     case HLID_PREVIOUS:
222         entry = list_prev(&ctxt->links, &ctxt->current->entry);
223         break;
224     case HLID_NEXT:
225         entry = list_next(&ctxt->links, &ctxt->current->entry);
226         break;
227     case HLID_CURRENT:
228         entry = &ctxt->current->entry;
229         break;
230     case HLID_STACKBOTTOM:
231         entry = list_tail(&ctxt->links);
232         break;
233     case HLID_STACKTOP:
234         entry = list_head(&ctxt->links);
235         break;
236     default:
237         WARN("unknown id 0x%x\n", hlid);
238         entry = NULL;
239     }
240
241     return entry ? LIST_ENTRY(entry, struct link_entry, entry) : NULL;
242 }
243
244 static HRESULT WINAPI IHlinkBC_UpdateHlink(IHlinkBrowseContext* iface,
245         ULONG hlid, IMoniker *target, LPCWSTR location, LPCWSTR friendly_name)
246 {
247     HlinkBCImpl *This = impl_from_IHlinkBrowseContext(iface);
248     struct link_entry *entry = context_get_entry(This, hlid);
249     IHlink *link;
250     HRESULT hr;
251
252     TRACE("(%p)->(0x%x %p %s %s)\n", This, hlid, target, debugstr_w(location), debugstr_w(friendly_name));
253
254     if (!entry)
255         return E_INVALIDARG;
256
257     hr = HlinkCreateFromMoniker(target, location, friendly_name, NULL, 0, NULL, &IID_IHlink, (void**)&link);
258     if (FAILED(hr))
259         return hr;
260
261     IHlink_Release(entry->link);
262     entry->link = link;
263
264     return S_OK;
265 }
266
267 static HRESULT WINAPI IHlinkBC_EnumNavigationStack( IHlinkBrowseContext *iface,
268         DWORD dwReserved, DWORD grfHLFNAMEF, IEnumHLITEM** ppienumhlitem)
269 {
270     FIXME("\n");
271     return E_NOTIMPL;
272 }
273
274 static HRESULT WINAPI IHlinkBC_QueryHlink( IHlinkBrowseContext* iface,
275         DWORD grfHLONG, ULONG uHLID)
276 {
277     FIXME("\n");
278     return E_NOTIMPL;
279 }
280
281 static HRESULT WINAPI IHlinkBC_GetHlink(IHlinkBrowseContext* iface, ULONG hlid, IHlink **ret)
282 {
283     HlinkBCImpl *This = impl_from_IHlinkBrowseContext(iface);
284     struct link_entry *link;
285
286     TRACE("(%p)->(0x%x %p)\n", This, hlid, ret);
287
288     link = context_get_entry(This, hlid);
289     if (!link)
290         return E_FAIL;
291
292     *ret = link->link;
293     IHlink_AddRef(*ret);
294
295     return S_OK;
296 }
297
298 static HRESULT WINAPI IHlinkBC_SetCurrentHlink( IHlinkBrowseContext* iface,
299         ULONG uHLID)
300 {
301     FIXME("\n");
302     return E_NOTIMPL;
303 }
304
305 static HRESULT WINAPI IHlinkBC_Clone( IHlinkBrowseContext* iface,
306         IUnknown* piunkOuter, REFIID riid, IUnknown** ppiunkOjb)
307 {
308     FIXME("\n");
309     return E_NOTIMPL;
310 }
311
312 static HRESULT WINAPI IHlinkBC_Close(IHlinkBrowseContext* iface,
313         DWORD reserved)
314 {
315     FIXME("\n");
316     return E_NOTIMPL;
317 }
318
319 static const IHlinkBrowseContextVtbl hlvt =
320 {
321     IHlinkBC_fnQueryInterface,
322     IHlinkBC_fnAddRef,
323     IHlinkBC_fnRelease,
324     IHlinkBC_Register,
325     IHlinkBC_GetObject,
326     IHlinkBC_Revoke,
327     IHlinkBC_SetBrowseWindowInfo,
328     IHlinkBC_GetBrowseWindowInfo,
329     IHlinkBC_SetInitialHlink,
330     IHlinkBC_OnNavigateHlink,
331     IHlinkBC_UpdateHlink,
332     IHlinkBC_EnumNavigationStack,
333     IHlinkBC_QueryHlink,
334     IHlinkBC_GetHlink,
335     IHlinkBC_SetCurrentHlink,
336     IHlinkBC_Clone,
337     IHlinkBC_Close
338 };
339
340 HRESULT HLinkBrowseContext_Constructor(IUnknown *pUnkOuter, REFIID riid, void **ppv)
341 {
342     HlinkBCImpl * hl;
343
344     TRACE("unkOut=%p riid=%s\n", pUnkOuter, debugstr_guid(riid));
345     *ppv = NULL;
346
347     if (pUnkOuter)
348         return CLASS_E_NOAGGREGATION;
349
350     hl = heap_alloc_zero(sizeof(HlinkBCImpl));
351     if (!hl)
352         return E_OUTOFMEMORY;
353
354     hl->ref = 1;
355     hl->IHlinkBrowseContext_iface.lpVtbl = &hlvt;
356     list_init(&hl->links);
357     hl->current = NULL;
358
359     *ppv = hl;
360     return S_OK;
361 }