1 /***************************************************************************************
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 ***************************************************************************************/
25 #include "wine/unicode.h"
27 #include "wine/debug.h"
29 WINE_DEFAULT_DEBUG_CHANNEL(ole
);
31 /* represent the first size table and it's increment block size */
32 #define BLOCK_TAB_SIZE 10
33 #define MAX_TAB_SIZE 0xFFFFFFFF
35 /* data structure of the BindCtx table elements */
36 typedef struct BindCtxObject
{
38 IUnknown
* pObj
; /* point on a bound object */
40 LPOLESTR pkeyObj
; /* key associated to this bound object */
42 BYTE regType
; /* registration type: 1 if RegisterObjectParam and 0 if RegisterObjectBound */
46 /* BindCtx data strucrture */
47 typedef struct BindCtxImpl
{
49 ICOM_VFIELD(IBindCtx
); /* VTable relative to the IBindCtx interface.*/
51 ULONG ref
; /* reference counter for this object */
53 BindCtxObject
* bindCtxTable
; /* this is a table in which all bounded objects are stored*/
54 DWORD bindCtxTableLastIndex
; /* first free index in the table */
55 DWORD bindCtxTableSize
; /* size table */
57 BIND_OPTS2 bindOption2
; /* a structure which contains the bind options*/
61 /* IBindCtx prototype functions : */
63 /* IUnknown functions*/
64 static HRESULT WINAPI
BindCtxImpl_QueryInterface(IBindCtx
* iface
,REFIID riid
,void** ppvObject
);
65 static ULONG WINAPI
BindCtxImpl_AddRef(IBindCtx
* iface
);
66 static ULONG WINAPI
BindCtxImpl_Release(IBindCtx
* iface
);
67 /* IBindCtx functions */
68 static HRESULT WINAPI
BindCtxImpl_RegisterObjectBound(IBindCtx
* iface
,IUnknown
* punk
);
69 static HRESULT WINAPI
BindCtxImpl_RevokeObjectBound(IBindCtx
* iface
, IUnknown
* punk
);
70 static HRESULT WINAPI
BindCtxImpl_ReleaseBoundObjects(IBindCtx
* iface
);
71 static HRESULT WINAPI
BindCtxImpl_SetBindOptions(IBindCtx
* iface
,BIND_OPTS
*pbindopts
);
72 static HRESULT WINAPI
BindCtxImpl_GetBindOptions(IBindCtx
* iface
,BIND_OPTS
*pbindopts
);
73 static HRESULT WINAPI
BindCtxImpl_GetRunningObjectTable(IBindCtx
* iface
,IRunningObjectTable
** pprot
);
74 static HRESULT WINAPI
BindCtxImpl_RegisterObjectParam(IBindCtx
* iface
,LPOLESTR pszkey
, IUnknown
* punk
);
75 static HRESULT WINAPI
BindCtxImpl_GetObjectParam(IBindCtx
* iface
,LPOLESTR pszkey
, IUnknown
** punk
);
76 static HRESULT WINAPI
BindCtxImpl_EnumObjectParam(IBindCtx
* iface
,IEnumString
** ppenum
);
77 static HRESULT WINAPI
BindCtxImpl_RevokeObjectParam(IBindCtx
* iface
,LPOLESTR pszkey
);
79 HRESULT WINAPI
BindCtxImpl_Construct(BindCtxImpl
* This
);
80 HRESULT WINAPI
BindCtxImpl_Destroy(BindCtxImpl
* This
);
81 HRESULT WINAPI
BindCtxImpl_GetObjectIndex(BindCtxImpl
* This
,IUnknown
* punk
,LPOLESTR pszkey
,DWORD
*index
);
83 /* Virtual function table for the BindCtx class. */
84 static ICOM_VTABLE(IBindCtx
) VT_BindCtxImpl
=
86 ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
87 BindCtxImpl_QueryInterface
,
90 BindCtxImpl_RegisterObjectBound
,
91 BindCtxImpl_RevokeObjectBound
,
92 BindCtxImpl_ReleaseBoundObjects
,
93 BindCtxImpl_SetBindOptions
,
94 BindCtxImpl_GetBindOptions
,
95 BindCtxImpl_GetRunningObjectTable
,
96 BindCtxImpl_RegisterObjectParam
,
97 BindCtxImpl_GetObjectParam
,
98 BindCtxImpl_EnumObjectParam
,
99 BindCtxImpl_RevokeObjectParam
102 /*******************************************************************************
103 * BindCtx_QueryInterface
104 *******************************************************************************/
105 HRESULT WINAPI
BindCtxImpl_QueryInterface(IBindCtx
* iface
,REFIID riid
,void** ppvObject
)
107 ICOM_THIS(BindCtxImpl
,iface
);
109 TRACE("(%p,%p,%p)\n",This
,riid
,ppvObject
);
111 /* Perform a sanity check on the parameters.*/
112 if ( (This
==0) || (ppvObject
==0) )
115 /* Initialize the return parameter.*/
118 /* Compare the riid with the interface IDs implemented by this object.*/
119 if (IsEqualIID(&IID_IUnknown
, riid
))
120 *ppvObject
= (IBindCtx
*)This
;
122 if (IsEqualIID(&IID_IBindCtx
, riid
))
123 *ppvObject
= (IBindCtx
*)This
;
125 /* Check that we obtained an interface.*/
127 return E_NOINTERFACE
;
129 /* Query Interface always increases the reference count by one when it is successful */
130 BindCtxImpl_AddRef(iface
);
135 /******************************************************************************
137 ******************************************************************************/
138 ULONG WINAPI
BindCtxImpl_AddRef(IBindCtx
* iface
)
140 ICOM_THIS(BindCtxImpl
,iface
);
142 TRACE("(%p)\n",This
);
144 return ++(This
->ref
);
147 /******************************************************************************
149 ******************************************************************************/
150 ULONG WINAPI
BindCtxImpl_Release(IBindCtx
* iface
)
152 ICOM_THIS(BindCtxImpl
,iface
);
154 TRACE("(%p)\n",This
);
160 /* release all registered objects */
161 BindCtxImpl_ReleaseBoundObjects((IBindCtx
*)This
);
163 BindCtxImpl_Destroy(This
);
171 /******************************************************************************
172 * BindCtx_Construct (local function)
173 *******************************************************************************/
174 HRESULT WINAPI
BindCtxImpl_Construct(BindCtxImpl
* This
)
176 TRACE("(%p)\n",This
);
178 /* Initialize the virtual function table.*/
179 ICOM_VTBL(This
) = &VT_BindCtxImpl
;
182 /* Initialize the BIND_OPTS2 structure */
183 This
->bindOption2
.cbStruct
= sizeof(BIND_OPTS2
);
184 This
->bindOption2
.grfFlags
= 0;
185 This
->bindOption2
.grfMode
= STGM_READWRITE
;
186 This
->bindOption2
.dwTickCountDeadline
= 0;
188 This
->bindOption2
.dwTrackFlags
= 0;
189 This
->bindOption2
.dwClassContext
= CLSCTX_SERVER
;
190 This
->bindOption2
.locale
= 1033;
191 This
->bindOption2
.pServerInfo
= 0;
193 /* Initialize the bindctx table */
194 This
->bindCtxTableSize
=BLOCK_TAB_SIZE
;
195 This
->bindCtxTableLastIndex
=0;
196 This
->bindCtxTable
= HeapAlloc(GetProcessHeap(), 0,This
->bindCtxTableSize
*sizeof(BindCtxObject
));
198 if (This
->bindCtxTable
==NULL
)
199 return E_OUTOFMEMORY
;
204 /******************************************************************************
205 * BindCtx_Destroy (local function)
206 *******************************************************************************/
207 HRESULT WINAPI
BindCtxImpl_Destroy(BindCtxImpl
* This
)
209 TRACE("(%p)\n",This
);
211 /* free the table space memory */
212 HeapFree(GetProcessHeap(),0,This
->bindCtxTable
);
214 /* free the bindctx structure */
215 HeapFree(GetProcessHeap(),0,This
);
221 /******************************************************************************
222 * BindCtx_RegisterObjectBound
223 ******************************************************************************/
224 HRESULT WINAPI
BindCtxImpl_RegisterObjectBound(IBindCtx
* iface
,IUnknown
* punk
)
227 ICOM_THIS(BindCtxImpl
,iface
);
228 DWORD lastIndex
=This
->bindCtxTableLastIndex
;
231 TRACE("(%p,%p)\n",This
,punk
);
236 IUnknown_AddRef(punk
);
238 /* put the object in the first free element in the table */
239 This
->bindCtxTable
[lastIndex
].pObj
= punk
;
240 This
->bindCtxTable
[lastIndex
].pkeyObj
= NULL
;
241 This
->bindCtxTable
[lastIndex
].regType
= 0;
242 cell
=This
->bindCtxTable
[lastIndex
];
243 lastIndex
= ++This
->bindCtxTableLastIndex
;
245 if (lastIndex
== This
->bindCtxTableSize
){ /* the table is full so it must be resized */
247 if (This
->bindCtxTableSize
> (MAX_TAB_SIZE
-BLOCK_TAB_SIZE
)){
248 FIXME("This->bindCtxTableSize: %ld is out of data limite \n",This
->bindCtxTableSize
);
252 This
->bindCtxTableSize
+=BLOCK_TAB_SIZE
; /* new table size */
254 This
->bindCtxTable
= HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY
,This
->bindCtxTable
,
255 This
->bindCtxTableSize
* sizeof(BindCtxObject
));
256 if (!This
->bindCtxTable
)
257 return E_OUTOFMEMORY
;
262 /******************************************************************************
263 * BindCtx_RevokeObjectBound
264 ******************************************************************************/
265 HRESULT WINAPI
BindCtxImpl_RevokeObjectBound(IBindCtx
* iface
, IUnknown
* punk
)
269 ICOM_THIS(BindCtxImpl
,iface
);
271 TRACE("(%p,%p)\n",This
,punk
);
273 /* check if the object was registred or not */
274 if (BindCtxImpl_GetObjectIndex(This
,punk
,NULL
,&index
)==S_FALSE
)
276 return MK_E_NOTBOUND
;
278 IUnknown_Release(This
->bindCtxTable
[index
].pObj
);
280 /* left-shift all elements in the right side of the current revoked object */
281 for(j
=index
; j
<This
->bindCtxTableLastIndex
-1; j
++)
282 This
->bindCtxTable
[j
]= This
->bindCtxTable
[j
+1];
284 This
->bindCtxTableLastIndex
--;
289 /******************************************************************************
290 * BindCtx_ReleaseBoundObjects
291 ******************************************************************************/
292 HRESULT WINAPI
BindCtxImpl_ReleaseBoundObjects(IBindCtx
* iface
)
296 ICOM_THIS(BindCtxImpl
,iface
);
298 TRACE("(%p)\n",This
);
300 for(i
=0;i
<This
->bindCtxTableLastIndex
;i
++)
301 IUnknown_Release(This
->bindCtxTable
[i
].pObj
);
303 This
->bindCtxTableLastIndex
= 0;
308 /******************************************************************************
309 * BindCtx_SetBindOptions
310 ******************************************************************************/
311 HRESULT WINAPI
BindCtxImpl_SetBindOptions(IBindCtx
* iface
,BIND_OPTS
*pbindopts
)
313 ICOM_THIS(BindCtxImpl
,iface
);
315 TRACE("(%p,%p)\n",This
,pbindopts
);
320 if (pbindopts
->cbStruct
> sizeof(BIND_OPTS2
))
322 WARN("invalid size\n");
323 return E_INVALIDARG
; /* FIXME : not verified */
325 memcpy(&This
->bindOption2
, pbindopts
, pbindopts
->cbStruct
);
329 /******************************************************************************
330 * BindCtx_GetBindOptions
331 ******************************************************************************/
332 HRESULT WINAPI
BindCtxImpl_GetBindOptions(IBindCtx
* iface
,BIND_OPTS
*pbindopts
)
334 ICOM_THIS(BindCtxImpl
,iface
);
336 TRACE("(%p,%p)\n",This
,pbindopts
);
341 if (pbindopts
->cbStruct
> sizeof(BIND_OPTS2
))
343 WARN("invalid size\n");
344 return E_INVALIDARG
; /* FIXME : not verified */
346 memcpy(pbindopts
, &This
->bindOption2
, pbindopts
->cbStruct
);
350 /******************************************************************************
351 * BindCtx_GetRunningObjectTable
352 ******************************************************************************/
353 HRESULT WINAPI
BindCtxImpl_GetRunningObjectTable(IBindCtx
* iface
,IRunningObjectTable
** pprot
)
357 ICOM_THIS(BindCtxImpl
,iface
);
359 TRACE("(%p,%p)\n",This
,pprot
);
364 res
=GetRunningObjectTable(0, pprot
);
369 /******************************************************************************
370 * BindCtx_RegisterObjectParam
371 ******************************************************************************/
372 HRESULT WINAPI
BindCtxImpl_RegisterObjectParam(IBindCtx
* iface
,LPOLESTR pszkey
, IUnknown
* punk
)
375 ICOM_THIS(BindCtxImpl
,iface
);
377 TRACE("(%p,%s,%p)\n",This
,debugstr_w(pszkey
),punk
);
382 IUnknown_AddRef(punk
);
384 if (pszkey
!=NULL
&& BindCtxImpl_GetObjectIndex(This
,NULL
,pszkey
,&index
)==S_OK
)
386 TRACE("Overwriting existing key\n");
387 if(This
->bindCtxTable
[index
].pObj
!=NULL
)
388 IUnknown_Release(This
->bindCtxTable
[index
].pObj
);
389 This
->bindCtxTable
[index
].pObj
=punk
;
392 This
->bindCtxTable
[This
->bindCtxTableLastIndex
].pObj
= punk
;
393 This
->bindCtxTable
[This
->bindCtxTableLastIndex
].regType
= 1;
397 This
->bindCtxTable
[This
->bindCtxTableLastIndex
].pkeyObj
=NULL
;
401 This
->bindCtxTable
[This
->bindCtxTableLastIndex
].pkeyObj
=
402 HeapAlloc(GetProcessHeap(),0,(sizeof(WCHAR
)*(1+lstrlenW(pszkey
))));
404 if (This
->bindCtxTable
[This
->bindCtxTableLastIndex
].pkeyObj
==NULL
)
405 return E_OUTOFMEMORY
;
406 strcpyW(This
->bindCtxTable
[This
->bindCtxTableLastIndex
].pkeyObj
,pszkey
);
409 This
->bindCtxTableLastIndex
++;
411 if (This
->bindCtxTableLastIndex
== This
->bindCtxTableSize
){ /* table is full ! must be resized */
413 This
->bindCtxTableSize
+=BLOCK_TAB_SIZE
; /* new table size */
415 if (This
->bindCtxTableSize
> (MAX_TAB_SIZE
-BLOCK_TAB_SIZE
)){
416 FIXME("This->bindCtxTableSize: %ld is out of data limite \n",This
->bindCtxTableSize
);
419 This
->bindCtxTable
= HeapReAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY
,This
->bindCtxTable
,
420 This
->bindCtxTableSize
* sizeof(BindCtxObject
));
421 if (!This
->bindCtxTable
)
422 return E_OUTOFMEMORY
;
426 /******************************************************************************
427 * BindCtx_GetObjectParam
428 ******************************************************************************/
429 HRESULT WINAPI
BindCtxImpl_GetObjectParam(IBindCtx
* iface
,LPOLESTR pszkey
, IUnknown
** punk
)
432 ICOM_THIS(BindCtxImpl
,iface
);
434 TRACE("(%p,%s,%p)\n",This
,debugstr_w(pszkey
),punk
);
441 if (BindCtxImpl_GetObjectIndex(This
,NULL
,pszkey
,&index
)==S_FALSE
)
444 IUnknown_AddRef(This
->bindCtxTable
[index
].pObj
);
446 *punk
= This
->bindCtxTable
[index
].pObj
;
451 /******************************************************************************
452 * BindCtx_RevokeObjectParam
453 ******************************************************************************/
454 HRESULT WINAPI
BindCtxImpl_RevokeObjectParam(IBindCtx
* iface
,LPOLESTR ppenum
)
458 ICOM_THIS(BindCtxImpl
,iface
);
460 TRACE("(%p,%s)\n",This
,debugstr_w(ppenum
));
462 if (BindCtxImpl_GetObjectIndex(This
,NULL
,ppenum
,&index
)==S_FALSE
)
465 /* release the object if it's found */
466 IUnknown_Release(This
->bindCtxTable
[index
].pObj
);
468 /* remove the object from the table with a left-shifting of all objects in the right side */
469 for(j
=index
; j
<This
->bindCtxTableLastIndex
-1; j
++)
470 This
->bindCtxTable
[j
]= This
->bindCtxTable
[j
+1];
472 This
->bindCtxTableLastIndex
--;
477 /******************************************************************************
478 * BindCtx_EnumObjectParam
479 ******************************************************************************/
480 HRESULT WINAPI
BindCtxImpl_EnumObjectParam(IBindCtx
* iface
,IEnumString
** pszkey
)
482 FIXME("(%p,%p),stub!\n",iface
,pszkey
);
486 /********************************************************************************
487 * GetObjectIndex (local function)
488 ********************************************************************************/
489 HRESULT WINAPI
BindCtxImpl_GetObjectIndex(BindCtxImpl
* This
,
498 TRACE("(%p,%p,%p,%p)\n",This
,punk
,pszkey
,index
);
501 /* search object identified by a register key */
502 for(i
=0; ( (i
<This
->bindCtxTableLastIndex
) && (!found
));i
++){
504 if(This
->bindCtxTable
[i
].regType
==1){
506 if ( ( (This
->bindCtxTable
[i
].pkeyObj
==NULL
) && (pszkey
==NULL
) ) ||
507 ( (This
->bindCtxTable
[i
].pkeyObj
!=NULL
) &&
509 (lstrcmpW(This
->bindCtxTable
[i
].pkeyObj
,pszkey
)==0)
517 /* search object identified by a moniker*/
518 for(i
=0; ( (i
<This
->bindCtxTableLastIndex
) && (!found
));i
++)
519 if(This
->bindCtxTable
[i
].pObj
==punk
)
527 TRACE("key not found\n");
531 /******************************************************************************
533 ******************************************************************************/
534 HRESULT WINAPI
CreateBindCtx16(DWORD reserved
, LPBC
* ppbc
)
536 FIXME("(%ld,%p),stub!\n",reserved
,ppbc
);
540 /******************************************************************************
541 * CreateBindCtx (OLE32.52)
542 ******************************************************************************/
543 HRESULT WINAPI
CreateBindCtx(DWORD reserved
, LPBC
* ppbc
)
545 BindCtxImpl
* newBindCtx
= 0;
547 IID riid
=IID_IBindCtx
;
549 TRACE("(%ld,%p)\n",reserved
,ppbc
);
551 newBindCtx
= HeapAlloc(GetProcessHeap(), 0, sizeof(BindCtxImpl
));
554 return E_OUTOFMEMORY
;
556 hr
= BindCtxImpl_Construct(newBindCtx
);
560 HeapFree(GetProcessHeap(),0,newBindCtx
);
564 hr
= BindCtxImpl_QueryInterface((IBindCtx
*)newBindCtx
,&riid
,(void**)ppbc
);
569 HRESULT WINAPI
BindMoniker(LPMONIKER pmk
, DWORD grfOpt
, REFIID riid
, LPVOID
* ppvResult
)
574 TRACE("(%p, %lx, %s, %p)\n", pmk
, grfOpt
, debugstr_guid(riid
), ppvResult
);
576 res
= CreateBindCtx(grfOpt
, &pbc
);
578 res
= IMoniker_BindToObject(pmk
, pbc
, NULL
, riid
, ppvResult
);