ole/oleobj.c

   1 /*
   2  *      OLE2 COM objects
   3  *
   4  *      Copyright 1998 Eric Kohl
   5  *      Copyright 1999 Francis Beaudet
   6  */
   7
   8
   9 #include <string.h>
  10 #include "winbase.h"
  11 #include "winerror.h"
  12 #include "oleidl.h"
  13 #include "debug.h"
  14
  15 DEFAULT_DEBUG_CHANNEL(ole)
  16
  17
  18 /**************************************************************************
  19  *  OleAdviseHolderImpl Implementation
  20  */
  21 typedef struct OleAdviseHolderImpl
  22 {
  23   ICOM_VTABLE(IOleAdviseHolder)* lpvtbl;
  24
  25   DWORD ref;
  26
  27   DWORD         maxSinks;
  28   IAdviseSink** arrayOfSinks;
  29
  30 } OleAdviseHolderImpl;
  31
  32 static LPOLEADVISEHOLDER OleAdviseHolderImpl_Constructor();
  33 static void              OleAdviseHolderImpl_Destructor(OleAdviseHolderImpl* ptrToDestroy);
  34 static HRESULT WINAPI    OleAdviseHolderImpl_QueryInterface(LPOLEADVISEHOLDER,REFIID,LPVOID*);
  35 static ULONG WINAPI      OleAdviseHolderImpl_AddRef(LPOLEADVISEHOLDER);
  36 static ULONG WINAPI      OleAdviseHolderImpl_Release(LPOLEADVISEHOLDER);
  37 static HRESULT WINAPI    OleAdviseHolderImpl_Advise(LPOLEADVISEHOLDER, IAdviseSink*, DWORD*);
  38 static HRESULT WINAPI    OleAdviseHolderImpl_Unadvise (LPOLEADVISEHOLDER, DWORD);
  39 static HRESULT WINAPI    OleAdviseHolderImpl_EnumAdvise (LPOLEADVISEHOLDER, IEnumSTATDATA **);
  40 static HRESULT WINAPI    OleAdviseHolderImpl_SendOnRename (LPOLEADVISEHOLDER, IMoniker *);
  41 static HRESULT WINAPI    OleAdviseHolderImpl_SendOnSave (LPOLEADVISEHOLDER);
  42 static HRESULT WINAPI    OleAdviseHolderImpl_SendOnClose (LPOLEADVISEHOLDER);
  43
  44
  45 /**************************************************************************
  46  *  OleAdviseHolderImpl_VTable
  47  */
  48 static struct ICOM_VTABLE(IOleAdviseHolder) oahvt =
  49 {
  50     OleAdviseHolderImpl_QueryInterface,
  51     OleAdviseHolderImpl_AddRef,
  52     OleAdviseHolderImpl_Release,
  53     OleAdviseHolderImpl_Advise,
  54     OleAdviseHolderImpl_Unadvise,
  55     OleAdviseHolderImpl_EnumAdvise,
  56     OleAdviseHolderImpl_SendOnRename,
  57     OleAdviseHolderImpl_SendOnSave,
  58     OleAdviseHolderImpl_SendOnClose
  59 };
  60
  61 /**************************************************************************
  62  *  OleAdviseHolderImpl_Constructor
  63  */
  64
  65 static LPOLEADVISEHOLDER OleAdviseHolderImpl_Constructor()
  66 {
  67   OleAdviseHolderImpl* lpoah;
  68   DWORD                index;
  69
  70   lpoah= (OleAdviseHolderImpl*)HeapAlloc(GetProcessHeap(),
  71                                          0,
  72                                          sizeof(OleAdviseHolderImpl));
  73
  74   lpoah->lpvtbl = &oahvt;
  75   lpoah->ref = 1;
  76   lpoah->maxSinks = 10;
  77   lpoah->arrayOfSinks = HeapAlloc(GetProcessHeap(),
  78                                   0,
  79                                   lpoah->maxSinks * sizeof(IAdviseSink*));
  80
  81   for (index = 0; index < lpoah->maxSinks; index++)
  82     lpoah->arrayOfSinks[index]=0;
  83
  84   return (LPOLEADVISEHOLDER)lpoah;
  85 }
  86
  87 /**************************************************************************
  88  *  OleAdviseHolderImpl_Destructor
  89  */
  90 static void OleAdviseHolderImpl_Destructor(
  91   OleAdviseHolderImpl* ptrToDestroy)
  92 {
  93   DWORD index;
  94
  95   for (index = 0; index < ptrToDestroy->maxSinks; index++)
  96   {
  97     if (ptrToDestroy->arrayOfSinks[index]!=0)
  98     {
  99       IAdviseSink_Release(ptrToDestroy->arrayOfSinks[index]);
 100       ptrToDestroy->arrayOfSinks[index] = NULL;
 101     }
 102   }
 103
 104   HeapFree(GetProcessHeap(),
 105            0,
 106            ptrToDestroy->arrayOfSinks);
 107
 108
 109   HeapFree(GetProcessHeap(),
 110            0,
 111            ptrToDestroy);
 112 }
 113
 114 /**************************************************************************
 115  *  OleAdviseHolderImpl_QueryInterface
 116  */
 117 static HRESULT WINAPI OleAdviseHolderImpl_QueryInterface(
 118   LPOLEADVISEHOLDER iface,
 119   REFIID            riid,
 120   LPVOID*           ppvObj)
 121 {
 122   ICOM_THIS(OleAdviseHolderImpl, iface);
 123
 124   /*
 125    * Sanity check
 126    */
 127   if (ppvObj==NULL)
 128     return E_POINTER;
 129
 130   *ppvObj = NULL;
 131
 132   if (IsEqualIID(riid, &IID_IUnknown))
 133   {
 134     /* IUnknown */
 135     *ppvObj = This;
 136   }
 137   else if(IsEqualIID(riid, &IID_IOleAdviseHolder))
 138   {
 139     /* IOleAdviseHolder */
 140     *ppvObj = (IOleAdviseHolder*) This;
 141   }
 142
 143   if(*ppvObj == NULL)
 144     return E_NOINTERFACE;
 145
 146   /*
 147    * A successful QI always increments the reference count.
 148    */
 149   IUnknown_AddRef((IUnknown*)*ppvObj);
 150
 151   return S_OK;
 152 }
 153
 154 /******************************************************************************
 155  * OleAdviseHolderImpl_AddRef
 156  */
 157 static ULONG WINAPI OleAdviseHolderImpl_AddRef(
 158   LPOLEADVISEHOLDER iface)
 159 {
 160   ICOM_THIS(OleAdviseHolderImpl, iface);
 161
 162   return ++(This->ref);
 163 }
 164
 165 /******************************************************************************
 166  * OleAdviseHolderImpl_Release
 167  */
 168 static ULONG WINAPI OleAdviseHolderImpl_Release(
 169   LPOLEADVISEHOLDER iface)
 170 {
 171   ICOM_THIS(OleAdviseHolderImpl, iface);
 172
 173   This->ref--;
 174
 175   if (This->ref == 0)
 176   {
 177     OleAdviseHolderImpl_Destructor(This);
 178
 179     return 0;
 180   }
 181
 182   return This->ref;
 183 }
 184
 185 /******************************************************************************
 186  * OleAdviseHolderImpl_Advise
 187  */
 188 static HRESULT WINAPI OleAdviseHolderImpl_Advise(
 189   LPOLEADVISEHOLDER iface,
 190   IAdviseSink*      pAdvise,
 191   DWORD*            pdwConnection)
 192 {
 193   DWORD index;
 194
 195   ICOM_THIS(OleAdviseHolderImpl, iface);
 196
 197   TRACE(ole, "(%p, %p, %p)\n", This, pAdvise, pdwConnection);
 198
 199   /*
 200    * Sanity check
 201    */
 202   if (pdwConnection==NULL)
 203     return E_POINTER;
 204
 205   *pdwConnection = 0;
 206
 207   /*
 208    * Find a free spot in the array.
 209    */
 210   for (index = 0; index < This->maxSinks; index++)
 211   {
 212     if (This->arrayOfSinks[index]==NULL)
 213       break;
 214   }
 215
 216   /*
 217    * If the array is full, we need to grow it.
 218    */
 219   if (index == This->maxSinks)
 220   {
 221     DWORD i;
 222
 223     This->maxSinks+=10;
 224
 225     This->arrayOfSinks = HeapReAlloc(GetProcessHeap(),
 226                                      0,
 227                                      This->arrayOfSinks,
 228                                      This->maxSinks*sizeof(IAdviseSink*));
 229
 230     for (i=index;i < This->maxSinks; i++)
 231       This->arrayOfSinks[i]=0;
 232   }
 233
 234   /*
 235    * Store the new sink
 236    */
 237   This->arrayOfSinks[index] = pAdvise;
 238
 239   if (This->arrayOfSinks[index]!=NULL)
 240     IAdviseSink_AddRef(This->arrayOfSinks[index]);
 241
 242   /*
 243    * Return the index as the cookie.
 244    */
 245   *pdwConnection = index;
 246
 247   return S_OK;
 248 }
 249
 250 /******************************************************************************
 251  * OleAdviseHolderImpl_Unadvise
 252  */
 253 static HRESULT WINAPI OleAdviseHolderImpl_Unadvise(
 254   LPOLEADVISEHOLDER iface,
 255   DWORD             dwConnection)
 256 {
 257   ICOM_THIS(OleAdviseHolderImpl, iface);
 258
 259   TRACE(ole, "(%p, %lu)\n", This, dwConnection);
 260
 261   /*
 262    * Check for invalid cookies.
 263    */
 264   if (dwConnection >= This->maxSinks)
 265     return OLE_E_NOCONNECTION;
 266
 267   if (This->arrayOfSinks[dwConnection] == NULL)
 268     return OLE_E_NOCONNECTION;
 269
 270   /*
 271    * Release the sink and mark the spot in the list as free.
 272    */
 273   IAdviseSink_Release(This->arrayOfSinks[dwConnection]);
 274   This->arrayOfSinks[dwConnection] = NULL;
 275
 276   return S_OK;
 277 }
 278
 279 /******************************************************************************
 280  * OleAdviseHolderImpl_EnumAdvise
 281  */
 282 static HRESULT WINAPI
 283 OleAdviseHolderImpl_EnumAdvise (LPOLEADVISEHOLDER iface, IEnumSTATDATA **ppenumAdvise)
 284 {
 285                 ICOM_THIS(OleAdviseHolderImpl, iface);
 286     FIXME (ole, "(%p)->(%p)\n", This, ppenumAdvise);
 287
 288     *ppenumAdvise = NULL;
 289
 290     return S_OK;
 291 }
 292
 293 /******************************************************************************
 294  * OleAdviseHolderImpl_SendOnRename
 295  */
 296 static HRESULT WINAPI
 297 OleAdviseHolderImpl_SendOnRename (LPOLEADVISEHOLDER iface, IMoniker *pmk)
 298 {
 299                 ICOM_THIS(OleAdviseHolderImpl, iface);
 300     FIXME (ole, "(%p)->(%p)\n", This, pmk);
 301
 302
 303     return S_OK;
 304 }
 305
 306 /******************************************************************************
 307  * OleAdviseHolderImpl_SendOnSave
 308  */
 309 static HRESULT WINAPI
 310 OleAdviseHolderImpl_SendOnSave (LPOLEADVISEHOLDER iface)
 311 {
 312                 ICOM_THIS(OleAdviseHolderImpl, iface);
 313     FIXME (ole, "(%p)\n", This);
 314
 315
 316     return S_OK;
 317 }
 318
 319 /******************************************************************************
 320  * OleAdviseHolderImpl_SendOnClose
 321  */
 322 static HRESULT WINAPI
 323 OleAdviseHolderImpl_SendOnClose (LPOLEADVISEHOLDER iface)
 324 {
 325   ICOM_THIS(OleAdviseHolderImpl, iface);
 326     FIXME (ole, "(%p)\n", This);
 327
 328
 329     return S_OK;
 330 }
 331
 332 /**************************************************************************
 333  *  DataAdviseHolder Implementation
 334  */
 335 typedef struct DataAdviseHolder
 336 {
 337   ICOM_VTABLE(IDataAdviseHolder)* lpvtbl;
 338
 339   DWORD ref;
 340 } DataAdviseHolder;
 341
 342 /**************************************************************************
 343  *  DataAdviseHolder method prototypes
 344  */
 345 static IDataAdviseHolder* DataAdviseHolder_Constructor();
 346 static void               DataAdviseHolder_Destructor(DataAdviseHolder* ptrToDestroy);
 347 static HRESULT WINAPI     DataAdviseHolder_QueryInterface(
 348                             IDataAdviseHolder*      iface,
 349                             REFIID                  riid,
 350                             void**                  ppvObject);
 351 static ULONG WINAPI       DataAdviseHolder_AddRef(
 352                             IDataAdviseHolder*      iface);
 353 static ULONG WINAPI       DataAdviseHolder_Release(
 354                             IDataAdviseHolder*      iface);
 355 static HRESULT WINAPI     DataAdviseHolder_Advise(
 356                             IDataAdviseHolder*      iface,
 357                             IDataObject*            pDataObject,
 358                             FORMATETC*              pFetc,
 359                             DWORD                   advf,
 360                             IAdviseSink*            pAdvise,
 361                             DWORD*                  pdwConnection);
 362 static HRESULT WINAPI     DataAdviseHolder_Unadvise(
 363                             IDataAdviseHolder*      iface,
 364                             DWORD                   dwConnection);
 365 static HRESULT WINAPI     DataAdviseHolder_EnumAdvise(
 366                             IDataAdviseHolder*      iface,
 367                             IEnumSTATDATA**         ppenumAdvise);
 368 static HRESULT WINAPI     DataAdviseHolder_SendOnDataChange(
 369                             IDataAdviseHolder*      iface,
 370                             IDataObject*            pDataObject,
 371                             DWORD                   dwReserved,
 372                             DWORD                   advf);
 373
 374 /**************************************************************************
 375  *  DataAdviseHolderImpl_VTable
 376  */
 377 static struct ICOM_VTABLE(IDataAdviseHolder) DataAdviseHolderImpl_VTable =
 378 {
 379   DataAdviseHolder_QueryInterface,
 380   DataAdviseHolder_AddRef,
 381   DataAdviseHolder_Release,
 382   DataAdviseHolder_Advise,
 383   DataAdviseHolder_Unadvise,
 384   DataAdviseHolder_EnumAdvise,
 385   DataAdviseHolder_SendOnDataChange
 386 };
 387
 388 /******************************************************************************
 389  * DataAdviseHolder_Constructor
 390  */
 391 static IDataAdviseHolder* DataAdviseHolder_Constructor()
 392 {
 393   DataAdviseHolder* newHolder;
 394
 395   newHolder = (DataAdviseHolder*)HeapAlloc(GetProcessHeap(),
 396                                            0,
 397                                            sizeof(DataAdviseHolder));
 398
 399   newHolder->lpvtbl = &DataAdviseHolderImpl_VTable;
 400   newHolder->ref = 1;
 401
 402   return (IDataAdviseHolder*)newHolder;
 403 }
 404
 405 /******************************************************************************
 406  * DataAdviseHolder_Destructor
 407  */
 408 static void DataAdviseHolder_Destructor(
 409   DataAdviseHolder* ptrToDestroy)
 410 {
 411   HeapFree(GetProcessHeap(),
 412            0,
 413            ptrToDestroy);
 414 }
 415
 416 /************************************************************************
 417  * DataAdviseHolder_QueryInterface (IUnknown)
 418  *
 419  * See Windows documentation for more details on IUnknown methods.
 420  */
 421 static HRESULT WINAPI DataAdviseHolder_QueryInterface(
 422   IDataAdviseHolder*      iface,
 423   REFIID                  riid,
 424   void**                  ppvObject)
 425 {
 426   ICOM_THIS(DataAdviseHolder, iface);
 427
 428   /*
 429    * Perform a sanity check on the parameters.
 430    */
 431   if ( (This==0) || (ppvObject==0) )
 432     return E_INVALIDARG;
 433
 434   /*
 435    * Initialize the return parameter.
 436    */
 437   *ppvObject = 0;
 438
 439   /*
 440    * Compare the riid with the interface IDs implemented by this object.
 441    */
 442   if ( (memcmp(&IID_IUnknown, riid, sizeof(IID_IUnknown)) == 0) ||
 443        (memcmp(&IID_IDataAdviseHolder, riid, sizeof(IID_IDataAdviseHolder)) == 0)  )
 444   {
 445     *ppvObject = iface;
 446   }
 447
 448   /*
 449    * Check that we obtained an interface.
 450    */
 451   if ((*ppvObject)==0)
 452   {
 453     return E_NOINTERFACE;
 454   }
 455
 456   /*
 457    * Query Interface always increases the reference count by one when it is
 458    * successful.
 459    */
 460   IUnknown_AddRef((IUnknown*)*ppvObject);
 461
 462   return S_OK;;
 463 }
 464
 465 /************************************************************************
 466  * DataAdviseHolder_AddRef (IUnknown)
 467  *
 468  * See Windows documentation for more details on IUnknown methods.
 469  */
 470 static ULONG WINAPI       DataAdviseHolder_AddRef(
 471   IDataAdviseHolder*      iface)
 472 {
 473   ICOM_THIS(DataAdviseHolder, iface);
 474
 475   This->ref++;
 476
 477   return This->ref;
 478 }
 479
 480 /************************************************************************
 481  * DataAdviseHolder_Release (IUnknown)
 482  *
 483  * See Windows documentation for more details on IUnknown methods.
 484  */
 485 static ULONG WINAPI DataAdviseHolder_Release(
 486   IDataAdviseHolder*      iface)
 487 {
 488   ICOM_THIS(DataAdviseHolder, iface);
 489
 490   /*
 491    * Decrease the reference count on this object.
 492    */
 493   This->ref--;
 494
 495   /*
 496    * If the reference count goes down to 0, perform suicide.
 497    */
 498   if (This->ref==0)
 499   {
 500     DataAdviseHolder_Destructor(This);
 501
 502     return 0;
 503   }
 504
 505   return This->ref;
 506 }
 507
 508 static HRESULT WINAPI DataAdviseHolder_Advise(
 509   IDataAdviseHolder*      iface,
 510   IDataObject*            pDataObject,
 511   FORMATETC*              pFetc,
 512   DWORD                   advf,
 513   IAdviseSink*            pAdvise,
 514   DWORD*                  pdwConnection)
 515 {
 516   FIXME(ole, "(): stub\n");
 517   return E_NOTIMPL;
 518 }
 519
 520 static HRESULT WINAPI     DataAdviseHolder_Unadvise(
 521   IDataAdviseHolder*      iface,
 522   DWORD                   dwConnection)
 523 {
 524   FIXME(ole, "(): stub\n");
 525   return E_NOTIMPL;
 526 }
 527
 528 static HRESULT WINAPI     DataAdviseHolder_EnumAdvise(
 529   IDataAdviseHolder*      iface,
 530   IEnumSTATDATA**         ppenumAdvise)
 531 {
 532   FIXME(ole, "(): stub\n");
 533   return E_NOTIMPL;
 534 }
 535
 536 static HRESULT WINAPI     DataAdviseHolder_SendOnDataChange(
 537   IDataAdviseHolder*      iface,
 538   IDataObject*            pDataObject,
 539   DWORD                   dwReserved,
 540   DWORD                   advf)
 541 {
 542   FIXME(ole, "(): stub\n");
 543   return E_NOTIMPL;
 544 }
 545
 546 /***********************************************************************
 547  * API functions
 548  */
 549
 550 /***********************************************************************
 551  * CreateOleAdviseHolder [OLE32.59]
 552  */
 553 HRESULT WINAPI CreateOleAdviseHolder(
 554   LPOLEADVISEHOLDER *ppOAHolder)
 555 {
 556   TRACE(ole, "(%p)\n", ppOAHolder);
 557
 558   /*
 559    * Sanity check,
 560    */
 561   if (ppOAHolder==NULL)
 562     return E_POINTER;
 563
 564   *ppOAHolder = OleAdviseHolderImpl_Constructor ();
 565
 566   if (*ppOAHolder != NULL)
 567     return S_OK;
 568
 569   return E_OUTOFMEMORY;
 570 }
 571
 572 /******************************************************************************
 573  *              CreateDataAdviseHolder        [OLE32.53]
 574  */
 575 HRESULT WINAPI CreateDataAdviseHolder(
 576   LPDATAADVISEHOLDER* ppDAHolder)
 577 {
 578   TRACE(ole,"(%p)\n", ppDAHolder);
 579
 580   /*
 581    * Sanity check,
 582    */
 583   if (ppDAHolder==NULL)
 584     return E_POINTER;
 585
 586   *ppDAHolder = DataAdviseHolder_Constructor();
 587
 588   if (*ppDAHolder != NULL)
 589     return S_OK;
 590
 591   return E_OUTOFMEMORY;
 592 }
 593