2 * BindCtx implementation
4 * Copyright 1999 Noomen Hamza
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
32 #include "wine/debug.h"
34 WINE_DEFAULT_DEBUG_CHANNEL(ole);
36 /* represent the first size table and it's increment block size */
37 #define BLOCK_TAB_SIZE 10
38 #define MAX_TAB_SIZE 0xFFFFFFFF
40 /* data structure of the BindCtx table elements */
41 typedef struct BindCtxObject{
43 IUnknown* pObj; /* point on a bound object */
45 LPOLESTR pkeyObj; /* key associated to this bound object */
47 BYTE regType; /* registration type: 1 if RegisterObjectParam and 0 if RegisterObjectBound */
51 /* BindCtx data strucrture */
52 typedef struct BindCtxImpl{
54 const IBindCtxVtbl *lpVtbl; /* VTable relative to the IBindCtx interface.*/
56 LONG ref; /* reference counter for this object */
58 BindCtxObject* bindCtxTable; /* this is a table in which all bounded objects are stored*/
59 DWORD bindCtxTableLastIndex; /* first free index in the table */
60 DWORD bindCtxTableSize; /* size table */
62 BIND_OPTS2 bindOption2; /* a structure which contains the bind options*/
66 /* IBindCtx prototype functions : */
67 static HRESULT WINAPI BindCtxImpl_ReleaseBoundObjects(IBindCtx*);
68 static HRESULT BindCtxImpl_GetObjectIndex(BindCtxImpl*, IUnknown*, LPOLESTR, DWORD *);
70 /*******************************************************************************
71 * BindCtx_QueryInterface
72 *******************************************************************************/
74 BindCtxImpl_QueryInterface(IBindCtx* iface,REFIID riid,void** ppvObject)
76 BindCtxImpl *This = (BindCtxImpl *)iface;
78 TRACE("(%p,%p,%p)\n",This,riid,ppvObject);
80 /* Perform a sanity check on the parameters.*/
81 if ( (This==0) || (ppvObject==0) )
84 /* Initialize the return parameter.*/
87 /* Compare the riid with the interface IDs implemented by this object.*/
88 if (IsEqualIID(&IID_IUnknown, riid) ||
89 IsEqualIID(&IID_IBindCtx, riid))
91 *ppvObject = (IBindCtx*)This;
92 IBindCtx_AddRef(iface);
99 /******************************************************************************
101 ******************************************************************************/
102 static ULONG WINAPI BindCtxImpl_AddRef(IBindCtx* iface)
104 BindCtxImpl *This = (BindCtxImpl *)iface;
106 TRACE("(%p)\n",This);
108 return InterlockedIncrement(&This->ref);
111 /******************************************************************************
112 * BindCtx_Destroy (local function)
113 *******************************************************************************/
114 static HRESULT BindCtxImpl_Destroy(BindCtxImpl* This)
116 TRACE("(%p)\n",This);
118 /* free the table space memory */
119 HeapFree(GetProcessHeap(),0,This->bindCtxTable);
121 /* free the bindctx structure */
122 HeapFree(GetProcessHeap(),0,This);
127 /******************************************************************************
129 ******************************************************************************/
130 static ULONG WINAPI BindCtxImpl_Release(IBindCtx* iface)
132 BindCtxImpl *This = (BindCtxImpl *)iface;
135 TRACE("(%p)\n",This);
137 ref = InterlockedDecrement(&This->ref);
140 /* release all registered objects */
141 BindCtxImpl_ReleaseBoundObjects((IBindCtx*)This);
143 BindCtxImpl_Destroy(This);
149 /******************************************************************************
150 * BindCtx_RegisterObjectBound
151 ******************************************************************************/
152 static HRESULT WINAPI
153 BindCtxImpl_RegisterObjectBound(IBindCtx* iface,IUnknown* punk)
155 BindCtxImpl *This = (BindCtxImpl *)iface;
156 DWORD lastIndex=This->bindCtxTableLastIndex;
158 TRACE("(%p,%p)\n",This,punk);
163 IUnknown_AddRef(punk);
165 /* put the object in the first free element in the table */
166 This->bindCtxTable[lastIndex].pObj = punk;
167 This->bindCtxTable[lastIndex].pkeyObj = NULL;
168 This->bindCtxTable[lastIndex].regType = 0;
169 lastIndex= ++This->bindCtxTableLastIndex;
171 if (lastIndex == This->bindCtxTableSize){ /* the table is full so it must be resized */
173 if (This->bindCtxTableSize > (MAX_TAB_SIZE-BLOCK_TAB_SIZE)){
174 FIXME("This->bindCtxTableSize: %d is out of data limite\n", This->bindCtxTableSize);
178 This->bindCtxTableSize+=BLOCK_TAB_SIZE; /* new table size */
180 This->bindCtxTable = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,This->bindCtxTable,
181 This->bindCtxTableSize * sizeof(BindCtxObject));
182 if (!This->bindCtxTable)
183 return E_OUTOFMEMORY;
188 /******************************************************************************
189 * BindCtx_RevokeObjectBound
190 ******************************************************************************/
191 static HRESULT WINAPI
192 BindCtxImpl_RevokeObjectBound(IBindCtx* iface, IUnknown* punk)
196 BindCtxImpl *This = (BindCtxImpl *)iface;
198 TRACE("(%p,%p)\n",This,punk);
203 /* check if the object was registered or not */
204 if (BindCtxImpl_GetObjectIndex(This,punk,NULL,&index)==S_FALSE)
205 return MK_E_NOTBOUND;
207 if(This->bindCtxTable[index].pObj)
208 IUnknown_Release(This->bindCtxTable[index].pObj);
209 HeapFree(GetProcessHeap(),0,This->bindCtxTable[index].pkeyObj);
211 /* left-shift all elements in the right side of the current revoked object */
212 for(j=index; j<This->bindCtxTableLastIndex-1; j++)
213 This->bindCtxTable[j]= This->bindCtxTable[j+1];
215 This->bindCtxTableLastIndex--;
220 /******************************************************************************
221 * BindCtx_ReleaseBoundObjects
222 ******************************************************************************/
223 static HRESULT WINAPI
224 BindCtxImpl_ReleaseBoundObjects(IBindCtx* iface)
228 BindCtxImpl *This = (BindCtxImpl *)iface;
230 TRACE("(%p)\n",This);
232 for(i=0;i<This->bindCtxTableLastIndex;i++)
234 if(This->bindCtxTable[i].pObj)
235 IUnknown_Release(This->bindCtxTable[i].pObj);
236 HeapFree(GetProcessHeap(),0,This->bindCtxTable[i].pkeyObj);
239 This->bindCtxTableLastIndex = 0;
244 /******************************************************************************
245 * BindCtx_SetBindOptions
246 ******************************************************************************/
247 static HRESULT WINAPI
248 BindCtxImpl_SetBindOptions(IBindCtx* iface,BIND_OPTS *pbindopts)
250 BindCtxImpl *This = (BindCtxImpl *)iface;
252 TRACE("(%p,%p)\n",This,pbindopts);
257 if (pbindopts->cbStruct > sizeof(BIND_OPTS2))
259 WARN("invalid size\n");
260 return E_INVALIDARG; /* FIXME : not verified */
262 memcpy(&This->bindOption2, pbindopts, pbindopts->cbStruct);
266 /******************************************************************************
267 * BindCtx_GetBindOptions
268 ******************************************************************************/
269 static HRESULT WINAPI
270 BindCtxImpl_GetBindOptions(IBindCtx* iface,BIND_OPTS *pbindopts)
272 BindCtxImpl *This = (BindCtxImpl *)iface;
275 TRACE("(%p,%p)\n",This,pbindopts);
280 cbStruct = pbindopts->cbStruct;
281 if (cbStruct > sizeof(BIND_OPTS2))
282 cbStruct = sizeof(BIND_OPTS2);
284 memcpy(pbindopts, &This->bindOption2, cbStruct);
285 pbindopts->cbStruct = cbStruct;
290 /******************************************************************************
291 * BindCtx_GetRunningObjectTable
292 ******************************************************************************/
293 static HRESULT WINAPI
294 BindCtxImpl_GetRunningObjectTable(IBindCtx* iface,IRunningObjectTable** pprot)
298 BindCtxImpl *This = (BindCtxImpl *)iface;
300 TRACE("(%p,%p)\n",This,pprot);
305 res=GetRunningObjectTable(0, pprot);
310 /******************************************************************************
311 * BindCtx_RegisterObjectParam
312 ******************************************************************************/
313 static HRESULT WINAPI
314 BindCtxImpl_RegisterObjectParam(IBindCtx* iface,LPOLESTR pszkey, IUnknown* punk)
317 BindCtxImpl *This = (BindCtxImpl *)iface;
319 TRACE("(%p,%s,%p)\n",This,debugstr_w(pszkey),punk);
324 if (pszkey!=NULL && BindCtxImpl_GetObjectIndex(This,NULL,pszkey,&index)==S_OK)
326 TRACE("Overwriting existing key\n");
327 if(This->bindCtxTable[index].pObj!=NULL)
328 IUnknown_Release(This->bindCtxTable[index].pObj);
329 This->bindCtxTable[index].pObj=punk;
330 IUnknown_AddRef(punk);
333 This->bindCtxTable[This->bindCtxTableLastIndex].pObj = punk;
334 This->bindCtxTable[This->bindCtxTableLastIndex].regType = 1;
338 This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj=NULL;
343 This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj=
344 HeapAlloc(GetProcessHeap(),0,(sizeof(WCHAR)*(1+lstrlenW(pszkey))));
346 if (This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj==NULL)
347 return E_OUTOFMEMORY;
348 lstrcpyW(This->bindCtxTable[This->bindCtxTableLastIndex].pkeyObj,pszkey);
351 This->bindCtxTableLastIndex++;
353 if (This->bindCtxTableLastIndex == This->bindCtxTableSize)
355 /* table is full ! must be resized */
357 This->bindCtxTableSize+=BLOCK_TAB_SIZE; /* new table size */
358 if (This->bindCtxTableSize > (MAX_TAB_SIZE-BLOCK_TAB_SIZE))
360 FIXME("This->bindCtxTableSize: %d is out of data limite\n", This->bindCtxTableSize);
363 This->bindCtxTable = HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,This->bindCtxTable,
364 This->bindCtxTableSize * sizeof(BindCtxObject));
365 if (!This->bindCtxTable)
366 return E_OUTOFMEMORY;
368 IUnknown_AddRef(punk);
372 /******************************************************************************
373 * BindCtx_GetObjectParam
374 ******************************************************************************/
375 static HRESULT WINAPI
376 BindCtxImpl_GetObjectParam(IBindCtx* iface,LPOLESTR pszkey, IUnknown** punk)
379 BindCtxImpl *This = (BindCtxImpl *)iface;
381 TRACE("(%p,%s,%p)\n",This,debugstr_w(pszkey),punk);
388 if (BindCtxImpl_GetObjectIndex(This,NULL,pszkey,&index)==S_FALSE)
391 IUnknown_AddRef(This->bindCtxTable[index].pObj);
393 *punk = This->bindCtxTable[index].pObj;
398 /******************************************************************************
399 * BindCtx_RevokeObjectParam
400 ******************************************************************************/
401 static HRESULT WINAPI
402 BindCtxImpl_RevokeObjectParam(IBindCtx* iface,LPOLESTR ppenum)
406 BindCtxImpl *This = (BindCtxImpl *)iface;
408 TRACE("(%p,%s)\n",This,debugstr_w(ppenum));
410 if (BindCtxImpl_GetObjectIndex(This,NULL,ppenum,&index)==S_FALSE)
413 /* release the object if it's found */
414 if(This->bindCtxTable[index].pObj)
415 IUnknown_Release(This->bindCtxTable[index].pObj);
416 HeapFree(GetProcessHeap(),0,This->bindCtxTable[index].pkeyObj);
418 /* remove the object from the table with a left-shifting of all objects in the right side */
419 for(j=index; j<This->bindCtxTableLastIndex-1; j++)
420 This->bindCtxTable[j]= This->bindCtxTable[j+1];
422 This->bindCtxTableLastIndex--;
427 /******************************************************************************
428 * BindCtx_EnumObjectParam
429 ******************************************************************************/
430 static HRESULT WINAPI
431 BindCtxImpl_EnumObjectParam(IBindCtx* iface,IEnumString** pszkey)
433 TRACE("(%p,%p)\n",iface,pszkey);
437 /* not implemented in native either */
441 /********************************************************************************
442 * GetObjectIndex (local function)
443 ********************************************************************************/
444 static HRESULT BindCtxImpl_GetObjectIndex(BindCtxImpl* This,
453 TRACE("(%p,%p,%p,%p)\n",This,punk,pszkey,index);
456 /* search object identified by a register key */
457 for(i=0; ( (i<This->bindCtxTableLastIndex) && (!found));i++)
459 if(This->bindCtxTable[i].regType==1){
461 if ( ( (This->bindCtxTable[i].pkeyObj==NULL) && (pszkey==NULL) ) ||
462 ( (This->bindCtxTable[i].pkeyObj!=NULL) &&
464 (lstrcmpW(This->bindCtxTable[i].pkeyObj,pszkey)==0)
472 /* search object identified by a moniker*/
473 for(i=0; ( (i<This->bindCtxTableLastIndex) && (!found));i++)
474 if(This->bindCtxTable[i].pObj==punk)
482 TRACE("key not found\n");
486 /* Virtual function table for the BindCtx class. */
487 static const IBindCtxVtbl VT_BindCtxImpl =
489 BindCtxImpl_QueryInterface,
492 BindCtxImpl_RegisterObjectBound,
493 BindCtxImpl_RevokeObjectBound,
494 BindCtxImpl_ReleaseBoundObjects,
495 BindCtxImpl_SetBindOptions,
496 BindCtxImpl_GetBindOptions,
497 BindCtxImpl_GetRunningObjectTable,
498 BindCtxImpl_RegisterObjectParam,
499 BindCtxImpl_GetObjectParam,
500 BindCtxImpl_EnumObjectParam,
501 BindCtxImpl_RevokeObjectParam
504 /******************************************************************************
505 * BindCtx_Construct (local function)
506 *******************************************************************************/
507 static HRESULT BindCtxImpl_Construct(BindCtxImpl* This)
509 TRACE("(%p)\n",This);
511 /* Initialize the virtual function table.*/
512 This->lpVtbl = &VT_BindCtxImpl;
515 /* Initialize the BIND_OPTS2 structure */
516 This->bindOption2.cbStruct = sizeof(BIND_OPTS2);
517 This->bindOption2.grfFlags = 0;
518 This->bindOption2.grfMode = STGM_READWRITE;
519 This->bindOption2.dwTickCountDeadline = 0;
521 This->bindOption2.dwTrackFlags = 0;
522 This->bindOption2.dwClassContext = CLSCTX_SERVER;
523 This->bindOption2.locale = GetThreadLocale();
524 This->bindOption2.pServerInfo = 0;
526 /* Initialize the bindctx table */
527 This->bindCtxTableSize=BLOCK_TAB_SIZE;
528 This->bindCtxTableLastIndex=0;
529 This->bindCtxTable = HeapAlloc(GetProcessHeap(), 0,
530 This->bindCtxTableSize*sizeof(BindCtxObject));
532 if (This->bindCtxTable==NULL)
533 return E_OUTOFMEMORY;
538 /******************************************************************************
539 * CreateBindCtx (OLE32.@)
540 ******************************************************************************/
541 HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
543 BindCtxImpl* newBindCtx = 0;
545 IID riid=IID_IBindCtx;
547 TRACE("(%d,%p)\n",reserved,ppbc);
549 if (!ppbc) return E_INVALIDARG;
555 ERR("reserved should be 0, not 0x%x\n", reserved);
559 newBindCtx = HeapAlloc(GetProcessHeap(), 0, sizeof(BindCtxImpl));
561 return E_OUTOFMEMORY;
563 hr = BindCtxImpl_Construct(newBindCtx);
566 HeapFree(GetProcessHeap(),0,newBindCtx);
570 hr = BindCtxImpl_QueryInterface((IBindCtx*)newBindCtx,&riid,(void**)ppbc);
575 HRESULT WINAPI BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID riid, LPVOID * ppvResult)
580 TRACE("(%p, %x, %s, %p)\n", pmk, grfOpt, debugstr_guid(riid), ppvResult);
582 res = CreateBindCtx(grfOpt, &pbc);
584 res = IMoniker_BindToObject(pmk, pbc, NULL, riid, ppvResult);