dlls/shell32/dataobject.c

   1 /*
   2  *      IEnumFORMATETC, IDataObject
   3  *
   4  * selecting and dropping objects within the shell and/or common dialogs
   5  *
   6  *      Copyright 1998, 1999    <juergen.schmied@metronet.de>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21  */
  22 #include <string.h>
  23
  24 #define COBJMACROS
  25 #include "windef.h"
  26 #include "wingdi.h"
  27 #include "pidl.h"
  28 #include "winerror.h"
  29 #include "shell32_main.h"
  30 #include "wine/debug.h"
  31
  32 WINE_DEFAULT_DEBUG_CHANNEL(shell);
  33
  34 /***********************************************************************
  35 *   IEnumFORMATETC implementation
  36 */
  37
  38 typedef struct
  39 {
  40     /* IUnknown fields */
  41     IEnumFORMATETC IEnumFORMATETC_iface;
  42     LONG           ref;
  43     /* IEnumFORMATETC fields */
  44     UINT        posFmt;
  45     UINT        countFmt;
  46     LPFORMATETC pFmt;
  47 } IEnumFORMATETCImpl;
  48
  49 static inline IEnumFORMATETCImpl *impl_from_IEnumFORMATETC(IEnumFORMATETC *iface)
  50 {
  51         return CONTAINING_RECORD(iface, IEnumFORMATETCImpl, IEnumFORMATETC_iface);
  52 }
  53
  54 static HRESULT WINAPI IEnumFORMATETC_fnQueryInterface(
  55                LPENUMFORMATETC iface, REFIID riid, LPVOID* ppvObj)
  56 {
  57         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
  58         TRACE("(%p)->(\n\tIID:\t%s,%p)\n",This,debugstr_guid(riid),ppvObj);
  59
  60         *ppvObj = NULL;
  61
  62         if(IsEqualIID(riid, &IID_IUnknown) ||
  63            IsEqualIID(riid, &IID_IEnumFORMATETC))
  64         {
  65           *ppvObj = &This->IEnumFORMATETC_iface;
  66         }
  67
  68         if(*ppvObj)
  69         {
  70           IUnknown_AddRef((IUnknown*)(*ppvObj));
  71           TRACE("-- Interface: (%p)->(%p)\n",ppvObj,*ppvObj);
  72           return S_OK;
  73         }
  74         TRACE("-- Interface: E_NOINTERFACE\n");
  75         return E_NOINTERFACE;
  76 }
  77
  78 static ULONG WINAPI IEnumFORMATETC_fnAddRef(LPENUMFORMATETC iface)
  79 {
  80         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
  81         ULONG refCount = InterlockedIncrement(&This->ref);
  82
  83         TRACE("(%p)->(count=%lu)\n", This, refCount - 1);
  84
  85         return refCount;
  86 }
  87
  88 static ULONG WINAPI IEnumFORMATETC_fnRelease(LPENUMFORMATETC iface)
  89 {
  90         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
  91         ULONG refCount = InterlockedDecrement(&This->ref);
  92
  93         TRACE("(%p)->(%lu)\n", This, refCount + 1);
  94
  95         if (!refCount)
  96         {
  97           TRACE(" destroying IEnumFORMATETC(%p)\n",This);
  98           SHFree (This->pFmt);
  99           free(This);
 100         }
 101         return refCount;
 102 }
 103
 104 static HRESULT WINAPI IEnumFORMATETC_fnNext(LPENUMFORMATETC iface, ULONG celt, FORMATETC *rgelt, ULONG *pceltFethed)
 105 {
 106         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
 107         UINT i;
 108
 109         TRACE("(%p)->(%lu,%p)\n", This, celt, rgelt);
 110
 111         if(!This->pFmt)return S_FALSE;
 112         if(!rgelt) return E_INVALIDARG;
 113         if (pceltFethed)  *pceltFethed = 0;
 114
 115         for(i = 0; This->posFmt < This->countFmt && celt > i; i++)
 116         {
 117           *rgelt++ = This->pFmt[This->posFmt++];
 118         }
 119
 120         if (pceltFethed) *pceltFethed = i;
 121
 122         return ((i == celt) ? S_OK : S_FALSE);
 123 }
 124
 125 static HRESULT WINAPI IEnumFORMATETC_fnSkip(LPENUMFORMATETC iface, ULONG celt)
 126 {
 127         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
 128         TRACE("(%p)->(num=%lu)\n", This, celt);
 129
 130         if((This->posFmt + celt) >= This->countFmt) return S_FALSE;
 131         This->posFmt += celt;
 132         return S_OK;
 133 }
 134
 135 static HRESULT WINAPI IEnumFORMATETC_fnReset(LPENUMFORMATETC iface)
 136 {
 137         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
 138         TRACE("(%p)->()\n", This);
 139
 140         This->posFmt = 0;
 141         return S_OK;
 142 }
 143
 144 static HRESULT WINAPI IEnumFORMATETC_fnClone(LPENUMFORMATETC iface, LPENUMFORMATETC* ppenum)
 145 {
 146         IEnumFORMATETCImpl *This = impl_from_IEnumFORMATETC(iface);
 147         TRACE("(%p)->(ppenum=%p)\n", This, ppenum);
 148
 149         if (!ppenum) return E_INVALIDARG;
 150         *ppenum = IEnumFORMATETC_Constructor(This->countFmt, This->pFmt);
 151         if(*ppenum)
 152            IEnumFORMATETC_fnSkip(*ppenum, This->posFmt);
 153         return S_OK;
 154 }
 155
 156 static const IEnumFORMATETCVtbl efvt =
 157 {
 158     IEnumFORMATETC_fnQueryInterface,
 159     IEnumFORMATETC_fnAddRef,
 160     IEnumFORMATETC_fnRelease,
 161     IEnumFORMATETC_fnNext,
 162     IEnumFORMATETC_fnSkip,
 163     IEnumFORMATETC_fnReset,
 164     IEnumFORMATETC_fnClone
 165 };
 166
 167 LPENUMFORMATETC IEnumFORMATETC_Constructor(UINT cfmt, const FORMATETC afmt[])
 168 {
 169     IEnumFORMATETCImpl* ef;
 170     DWORD size=cfmt * sizeof(FORMATETC);
 171
 172     ef = calloc(1, sizeof(*ef));
 173
 174     if(ef)
 175     {
 176         ef->ref=1;
 177         ef->IEnumFORMATETC_iface.lpVtbl = &efvt;
 178
 179         ef->countFmt = cfmt;
 180         ef->pFmt = SHAlloc (size);
 181
 182         if (ef->pFmt)
 183             memcpy(ef->pFmt, afmt, size);
 184     }
 185
 186     TRACE("(%p)->(%u,%p)\n",ef, cfmt, afmt);
 187     return &ef->IEnumFORMATETC_iface;
 188 }
 189
 190 struct data
 191 {
 192     UINT cf;
 193     HGLOBAL global;
 194 };
 195
 196 typedef struct
 197 {
 198     IDataObject IDataObject_iface;
 199     LONG ref;
 200
 201     struct data *data;
 202     size_t data_count;
 203 } IDataObjectImpl;
 204
 205 static inline IDataObjectImpl *impl_from_IDataObject(IDataObject *iface)
 206 {
 207         return CONTAINING_RECORD(iface, IDataObjectImpl, IDataObject_iface);
 208 }
 209
 210 /***************************************************************************
 211 *  IDataObject_QueryInterface
 212 */
 213 static HRESULT WINAPI IDataObject_fnQueryInterface(IDataObject *iface, REFIID riid, LPVOID * ppvObj)
 214 {
 215         IDataObjectImpl *This = impl_from_IDataObject(iface);
 216         TRACE("(%p)->(\n\tIID:\t%s,%p)\n",This,debugstr_guid(riid),ppvObj);
 217
 218         *ppvObj = NULL;
 219
 220         if(IsEqualIID(riid, &IID_IUnknown) ||
 221            IsEqualIID(riid, &IID_IDataObject))
 222         {
 223           *ppvObj = &This->IDataObject_iface;
 224         }
 225
 226         if(*ppvObj)
 227         {
 228           IUnknown_AddRef((IUnknown*)*ppvObj);
 229           TRACE("-- Interface: (%p)->(%p)\n",ppvObj,*ppvObj);
 230           return S_OK;
 231         }
 232         TRACE("-- Interface: E_NOINTERFACE\n");
 233         return E_NOINTERFACE;
 234 }
 235
 236 /**************************************************************************
 237 *  IDataObject_AddRef
 238 */
 239 static ULONG WINAPI IDataObject_fnAddRef(IDataObject *iface)
 240 {
 241         IDataObjectImpl *This = impl_from_IDataObject(iface);
 242         ULONG refCount = InterlockedIncrement(&This->ref);
 243
 244         TRACE("(%p)->(count=%lu)\n", This, refCount - 1);
 245
 246         return refCount;
 247 }
 248
 249 /**************************************************************************
 250 *  IDataObject_Release
 251 */
 252 static ULONG WINAPI IDataObject_fnRelease(IDataObject *iface)
 253 {
 254     IDataObjectImpl *obj = impl_from_IDataObject(iface);
 255     ULONG refcount = InterlockedDecrement(&obj->ref);
 256
 257     TRACE("%p decreasing refcount to %lu.\n", obj, refcount);
 258
 259     if (!refcount)
 260     {
 261         for (size_t i = 0; i < obj->data_count; ++i)
 262             GlobalFree(obj->data[i].global);
 263         free(obj->data);
 264         free(obj);
 265     }
 266     return refcount;
 267 }
 268
 269 /**************************************************************************
 270 * IDataObject_fnGetData
 271 */
 272 static HRESULT WINAPI IDataObject_fnGetData(IDataObject *iface, FORMATETC *format, STGMEDIUM *medium)
 273 {
 274     IDataObjectImpl *obj = impl_from_IDataObject(iface);
 275
 276     TRACE("iface %p, format %p, medium %p.\n", iface, format, medium);
 277
 278     if (!(format->tymed & TYMED_HGLOBAL))
 279     {
 280         FIXME("Unrecognized tymed %#lx, returning DV_E_FORMATETC.\n", format->tymed);
 281         return DV_E_FORMATETC;
 282     }
 283
 284     for (size_t i = 0; i < obj->data_count; ++i)
 285     {
 286         if (obj->data[i].cf == format->cfFormat)
 287         {
 288             HGLOBAL src_global = obj->data[i].global;
 289             size_t size = GlobalSize(src_global);
 290             HGLOBAL dst_global;
 291             const void *src;
 292             void *dst;
 293
 294             if (!(dst_global = GlobalAlloc(GMEM_MOVEABLE, size)))
 295                 return E_OUTOFMEMORY;
 296             src = GlobalLock(src_global);
 297             dst = GlobalLock(dst_global);
 298             memcpy(dst, src, size);
 299             GlobalUnlock(src_global);
 300             GlobalUnlock(dst_global);
 301
 302             medium->tymed = TYMED_HGLOBAL;
 303             medium->pUnkForRelease = NULL;
 304             medium->hGlobal = dst_global;
 305             return S_OK;
 306         }
 307     }
 308
 309     return DV_E_FORMATETC;
 310 }
 311
 312 static HRESULT WINAPI IDataObject_fnGetDataHere(IDataObject *iface, LPFORMATETC pformatetc, STGMEDIUM *pmedium)
 313 {
 314         IDataObjectImpl *This = impl_from_IDataObject(iface);
 315         FIXME("(%p)->()\n", This);
 316         return E_NOTIMPL;
 317 }
 318
 319 static HRESULT WINAPI IDataObject_fnQueryGetData(IDataObject *iface, FORMATETC *format)
 320 {
 321     IDataObjectImpl *obj = impl_from_IDataObject(iface);
 322
 323     TRACE("iface %p, format %p.\n", iface, format);
 324
 325     if (!(format->tymed & TYMED_HGLOBAL))
 326     {
 327         FIXME("Unrecognized tymed %#lx, returning S_FALSE.\n", format->tymed);
 328         return S_FALSE;
 329     }
 330
 331     for (size_t i = 0; i < obj->data_count; ++i)
 332     {
 333         if (obj->data[i].cf == format->cfFormat)
 334             return S_OK;
 335     }
 336
 337     return S_FALSE;
 338 }
 339
 340 static HRESULT WINAPI IDataObject_fnGetCanonicalFormatEtc(IDataObject *iface, LPFORMATETC pformatectIn, LPFORMATETC pformatetcOut)
 341 {
 342         IDataObjectImpl *This = impl_from_IDataObject(iface);
 343         FIXME("(%p)->()\n", This);
 344         return E_NOTIMPL;
 345 }
 346
 347 static HRESULT WINAPI IDataObject_fnSetData(IDataObject *iface,
 348         FORMATETC *format, STGMEDIUM *medium, BOOL release)
 349 {
 350     IDataObjectImpl *obj = impl_from_IDataObject(iface);
 351     struct data *new_array;
 352
 353     TRACE("iface %p, format %p, medium %p, release %d.\n", iface, format, medium, release);
 354
 355     if (!release)
 356         return E_INVALIDARG;
 357
 358     if (format->tymed != TYMED_HGLOBAL)
 359     {
 360         FIXME("Unhandled format tymed %#lx.\n", format->tymed);
 361         return E_NOTIMPL;
 362     }
 363
 364     if (medium->tymed != TYMED_HGLOBAL)
 365     {
 366         FIXME("Unhandled medium tymed %#lx.\n", format->tymed);
 367         return E_NOTIMPL;
 368     }
 369
 370     if (medium->pUnkForRelease)
 371         FIXME("Ignoring IUnknown %p.\n", medium->pUnkForRelease);
 372
 373     for (size_t i = 0; i < obj->data_count; ++i)
 374     {
 375         if (obj->data[i].cf == format->cfFormat)
 376         {
 377             GlobalFree(obj->data[i].global);
 378             obj->data[i].global = medium->hGlobal;
 379             return S_OK;
 380         }
 381     }
 382
 383     if (!(new_array = realloc(obj->data, (obj->data_count + 1) * sizeof(*obj->data))))
 384         return E_OUTOFMEMORY;
 385     obj->data = new_array;
 386     obj->data[obj->data_count].cf = format->cfFormat;
 387     obj->data[obj->data_count].global = medium->hGlobal;
 388     ++obj->data_count;
 389     return S_OK;
 390 }
 391
 392 static HRESULT WINAPI IDataObject_fnEnumFormatEtc(IDataObject *iface, DWORD direction, IEnumFORMATETC **out)
 393 {
 394     IDataObjectImpl *obj = impl_from_IDataObject(iface);
 395     FORMATETC *formats;
 396
 397     TRACE("iface %p, direction %#lx, out %p.\n", iface, direction, out);
 398
 399     if (!(formats = calloc(obj->data_count, sizeof(*formats))))
 400         return E_OUTOFMEMORY;
 401     for (size_t i = 0; i < obj->data_count; ++i)
 402         InitFormatEtc(formats[i], obj->data[i].cf, TYMED_HGLOBAL);
 403
 404     if (!(*out = IEnumFORMATETC_Constructor(obj->data_count, formats)))
 405     {
 406         free(formats);
 407         return E_OUTOFMEMORY;
 408     }
 409     free(formats);
 410     return S_OK;
 411 }
 412
 413 static HRESULT WINAPI IDataObject_fnDAdvise(IDataObject *iface, FORMATETC *pformatetc, DWORD advf, IAdviseSink *pAdvSink, DWORD *pdwConnection)
 414 {
 415         IDataObjectImpl *This = impl_from_IDataObject(iface);
 416         FIXME("(%p)->()\n", This);
 417         return E_NOTIMPL;
 418 }
 419 static HRESULT WINAPI IDataObject_fnDUnadvise(IDataObject *iface, DWORD dwConnection)
 420 {
 421         IDataObjectImpl *This = impl_from_IDataObject(iface);
 422         FIXME("(%p)->()\n", This);
 423         return E_NOTIMPL;
 424 }
 425 static HRESULT WINAPI IDataObject_fnEnumDAdvise(IDataObject *iface, IEnumSTATDATA **ppenumAdvise)
 426 {
 427         IDataObjectImpl *This = impl_from_IDataObject(iface);
 428         FIXME("(%p)->()\n", This);
 429         return E_NOTIMPL;
 430 }
 431
 432 static const IDataObjectVtbl dtovt =
 433 {
 434         IDataObject_fnQueryInterface,
 435         IDataObject_fnAddRef,
 436         IDataObject_fnRelease,
 437         IDataObject_fnGetData,
 438         IDataObject_fnGetDataHere,
 439         IDataObject_fnQueryGetData,
 440         IDataObject_fnGetCanonicalFormatEtc,
 441         IDataObject_fnSetData,
 442         IDataObject_fnEnumFormatEtc,
 443         IDataObject_fnDAdvise,
 444         IDataObject_fnDUnadvise,
 445         IDataObject_fnEnumDAdvise
 446 };
 447
 448 /**************************************************************************
 449 *  IDataObject_Constructor
 450 */
 451 IDataObject *IDataObject_Constructor(HWND hwnd, const ITEMIDLIST *root_pidl,
 452         const ITEMIDLIST **pidls, UINT pidl_count)
 453 {
 454     IDataObjectImpl *obj;
 455
 456     if (!(obj = calloc(1, sizeof(*obj))))
 457         return NULL;
 458
 459     obj->ref = 1;
 460     obj->IDataObject_iface.lpVtbl = &dtovt;
 461     obj->data = calloc(4, sizeof(*obj->data));
 462     obj->data[0].cf = RegisterClipboardFormatW(CFSTR_SHELLIDLISTW);
 463     obj->data[0].global = RenderSHELLIDLIST(root_pidl, pidls, pidl_count);
 464     obj->data[1].cf = CF_HDROP;
 465     obj->data[1].global = RenderHDROP(root_pidl, pidls, pidl_count);
 466     obj->data[2].cf = RegisterClipboardFormatA(CFSTR_FILENAMEA);
 467     obj->data[2].global = RenderFILENAMEA(root_pidl, pidls, pidl_count);
 468     obj->data[3].cf = RegisterClipboardFormatW(CFSTR_FILENAMEW);
 469     obj->data[3].global = RenderFILENAMEW(root_pidl, pidls, pidl_count);
 470     obj->data_count = 4;
 471
 472     TRACE("Created data object %p.\n", obj);
 473     return &obj->IDataObject_iface;
 474 }