dlls/ole32/errorinfo.c

   1 /*
   2  * ErrorInfo API
   3  *
   4  * Copyright 2000 Patrik Stridvall, Juergen Schmied
   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  * NOTES:
  21  *
  22  * The errorinfo is a per-thread object. The reference is stored in the
  23  * TEB at offset 0xf80.
  24  */
  25
  26 #include <stdarg.h>
  27 #include <string.h>
  28
  29 #define COBJMACROS
  30
  31 #include "windef.h"
  32 #include "winbase.h"
  33 #include "objbase.h"
  34 #include "oleauto.h"
  35 #include "winerror.h"
  36
  37 #include "wine/unicode.h"
  38 #include "compobj_private.h"
  39
  40 #include "wine/debug.h"
  41
  42 WINE_DEFAULT_DEBUG_CHANNEL(ole);
  43
  44 static inline void *heap_alloc(size_t len)
  45 {
  46     return HeapAlloc(GetProcessHeap(), 0, len);
  47 }
  48
  49 static inline BOOL heap_free(void *mem)
  50 {
  51     return HeapFree(GetProcessHeap(), 0, mem);
  52 }
  53
  54 static inline WCHAR *heap_strdupW(const WCHAR *str)
  55 {
  56     WCHAR *ret = NULL;
  57
  58     if(str) {
  59         size_t size;
  60
  61         size = (strlenW(str)+1)*sizeof(WCHAR);
  62         ret = heap_alloc(size);
  63         if(ret)
  64             memcpy(ret, str, size);
  65     }
  66
  67     return ret;
  68 }
  69
  70 /* this code is from SysAllocStringLen (ole2disp.c in oleaut32) */
  71 static BSTR ERRORINFO_SysAllocString(const OLECHAR* in)
  72 {
  73     DWORD  bufferSize;
  74     DWORD* newBuffer;
  75     WCHAR* stringBuffer;
  76     DWORD len;
  77
  78     if (in == NULL)
  79         return NULL;
  80     /*
  81      * Find the length of the buffer passed-in, in bytes.
  82      */
  83     len = strlenW(in);
  84     bufferSize = len * sizeof (WCHAR);
  85
  86     /*
  87      * Allocate a new buffer to hold the string.
  88      * don't forget to keep an empty spot at the beginning of the
  89      * buffer for the character count and an extra character at the
  90      * end for the '\0'.
  91      */
  92     newBuffer = HeapAlloc(GetProcessHeap(), 0,
  93                                  bufferSize + sizeof(WCHAR) + sizeof(DWORD));
  94
  95     /*
  96      * If the memory allocation failed, return a null pointer.
  97      */
  98     if (newBuffer==0)
  99       return 0;
 100
 101     /*
 102      * Copy the length of the string in the placeholder.
 103      */
 104     *newBuffer = bufferSize;
 105
 106     /*
 107      * Skip the byte count.
 108      */
 109     newBuffer++;
 110
 111     /*
 112      * Copy the information in the buffer.  It is not possible to pass
 113      * a NULL pointer here.
 114      */
 115     memcpy(newBuffer, in, bufferSize);
 116
 117     /*
 118      * Make sure that there is a nul character at the end of the
 119      * string.
 120      */
 121     stringBuffer = (WCHAR*)newBuffer;
 122     stringBuffer[len] = 0;
 123
 124     return stringBuffer;
 125 }
 126
 127 /* this code is from SysFreeString (ole2disp.c in oleaut32)*/
 128 static VOID ERRORINFO_SysFreeString(BSTR in)
 129 {
 130     DWORD* bufferPointer;
 131
 132     /* NULL is a valid parameter */
 133     if(!in) return;
 134
 135     /*
 136      * We have to be careful when we free a BSTR pointer, it points to
 137      * the beginning of the string but it skips the byte count contained
 138      * before the string.
 139      */
 140     bufferPointer = (DWORD*)in;
 141
 142     bufferPointer--;
 143
 144     /*
 145      * Free the memory from it's "real" origin.
 146      */
 147     HeapFree(GetProcessHeap(), 0, bufferPointer);
 148 }
 149
 150 typedef struct ErrorInfoImpl
 151 {
 152     IErrorInfo IErrorInfo_iface;
 153     ICreateErrorInfo ICreateErrorInfo_iface;
 154     ISupportErrorInfo ISupportErrorInfo_iface;
 155     LONG ref;
 156
 157     GUID m_Guid;
 158     WCHAR *source;
 159     WCHAR *description;
 160     BSTR bstrHelpFile;
 161     DWORD m_dwHelpContext;
 162 } ErrorInfoImpl;
 163
 164 static inline ErrorInfoImpl *impl_from_IErrorInfo( IErrorInfo *iface )
 165 {
 166     return CONTAINING_RECORD(iface, ErrorInfoImpl, IErrorInfo_iface);
 167 }
 168
 169 static inline ErrorInfoImpl *impl_from_ICreateErrorInfo( ICreateErrorInfo *iface )
 170 {
 171     return CONTAINING_RECORD(iface, ErrorInfoImpl, ICreateErrorInfo_iface);
 172 }
 173
 174 static inline ErrorInfoImpl *impl_from_ISupportErrorInfo( ISupportErrorInfo *iface )
 175 {
 176     return CONTAINING_RECORD(iface, ErrorInfoImpl, ISupportErrorInfo_iface);
 177 }
 178
 179 static HRESULT WINAPI IErrorInfoImpl_QueryInterface(
 180         IErrorInfo* iface,
 181         REFIID     riid,
 182         void**     ppvoid)
 183 {
 184         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 185         TRACE("(%p)->(%s,%p)\n", This, debugstr_guid(riid),ppvoid);
 186
 187         *ppvoid = NULL;
 188
 189         if (IsEqualIID(riid, &IID_IUnknown) || IsEqualIID(riid, &IID_IErrorInfo))
 190         {
 191           *ppvoid = &This->IErrorInfo_iface;
 192         }
 193         else if(IsEqualIID(riid, &IID_ICreateErrorInfo))
 194         {
 195           *ppvoid = &This->ICreateErrorInfo_iface;
 196         }
 197         else if(IsEqualIID(riid, &IID_ISupportErrorInfo))
 198         {
 199           *ppvoid = &This->ISupportErrorInfo_iface;
 200         }
 201
 202         if(*ppvoid)
 203         {
 204           IUnknown_AddRef( (IUnknown*)*ppvoid );
 205           TRACE("-- Interface: (%p)->(%p)\n",ppvoid,*ppvoid);
 206           return S_OK;
 207         }
 208         TRACE("-- Interface: E_NOINTERFACE\n");
 209         return E_NOINTERFACE;
 210 }
 211
 212 static ULONG WINAPI IErrorInfoImpl_AddRef(
 213         IErrorInfo* iface)
 214 {
 215         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 216         TRACE("(%p)->(count=%u)\n",This,This->ref);
 217         return InterlockedIncrement(&This->ref);
 218 }
 219
 220 static ULONG WINAPI IErrorInfoImpl_Release(
 221         IErrorInfo* iface)
 222 {
 223         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 224         ULONG ref = InterlockedDecrement(&This->ref);
 225
 226         TRACE("(%p)->(count=%u)\n",This,ref+1);
 227
 228         if (!ref)
 229         {
 230           TRACE("-- destroying IErrorInfo(%p)\n",This);
 231
 232           heap_free(This->source);
 233           heap_free(This->description);
 234           ERRORINFO_SysFreeString(This->bstrHelpFile);
 235           HeapFree(GetProcessHeap(),0,This);
 236           return 0;
 237         }
 238         return ref;
 239 }
 240
 241 static HRESULT WINAPI IErrorInfoImpl_GetGUID(
 242         IErrorInfo* iface,
 243         GUID * pGUID)
 244 {
 245         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 246         TRACE("(%p)->(count=%u)\n",This,This->ref);
 247         if(!pGUID )return E_INVALIDARG;
 248         *pGUID = This->m_Guid;
 249         return S_OK;
 250 }
 251
 252 static HRESULT WINAPI IErrorInfoImpl_GetSource(
 253         IErrorInfo* iface,
 254         BSTR *pBstrSource)
 255 {
 256         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 257         TRACE("(%p)->(pBstrSource=%p)\n",This,pBstrSource);
 258         if (pBstrSource == NULL)
 259             return E_INVALIDARG;
 260         *pBstrSource = SysAllocString(This->source);
 261         return S_OK;
 262 }
 263
 264 static HRESULT WINAPI IErrorInfoImpl_GetDescription(
 265         IErrorInfo* iface,
 266         BSTR *pBstrDescription)
 267 {
 268         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 269
 270         TRACE("(%p)->(pBstrDescription=%p)\n",This,pBstrDescription);
 271         if (pBstrDescription == NULL)
 272             return E_INVALIDARG;
 273         *pBstrDescription = SysAllocString(This->description);
 274
 275         return S_OK;
 276 }
 277
 278 static HRESULT WINAPI IErrorInfoImpl_GetHelpFile(
 279         IErrorInfo* iface,
 280         BSTR *pBstrHelpFile)
 281 {
 282         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 283
 284         TRACE("(%p)->(pBstrHelpFile=%p)\n",This, pBstrHelpFile);
 285         if (pBstrHelpFile == NULL)
 286             return E_INVALIDARG;
 287         *pBstrHelpFile = ERRORINFO_SysAllocString(This->bstrHelpFile);
 288
 289         return S_OK;
 290 }
 291
 292 static HRESULT WINAPI IErrorInfoImpl_GetHelpContext(
 293         IErrorInfo* iface,
 294         DWORD *pdwHelpContext)
 295 {
 296         ErrorInfoImpl *This = impl_from_IErrorInfo(iface);
 297         TRACE("(%p)->(pdwHelpContext=%p)\n",This, pdwHelpContext);
 298         if (pdwHelpContext == NULL)
 299             return E_INVALIDARG;
 300         *pdwHelpContext = This->m_dwHelpContext;
 301
 302         return S_OK;
 303 }
 304
 305 static const IErrorInfoVtbl ErrorInfoVtbl =
 306 {
 307   IErrorInfoImpl_QueryInterface,
 308   IErrorInfoImpl_AddRef,
 309   IErrorInfoImpl_Release,
 310   IErrorInfoImpl_GetGUID,
 311   IErrorInfoImpl_GetSource,
 312   IErrorInfoImpl_GetDescription,
 313   IErrorInfoImpl_GetHelpFile,
 314   IErrorInfoImpl_GetHelpContext
 315 };
 316
 317
 318 static HRESULT WINAPI ICreateErrorInfoImpl_QueryInterface(
 319         ICreateErrorInfo* iface,
 320         REFIID     riid,
 321         VOID**     ppvoid)
 322 {
 323     ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 324     return IErrorInfo_QueryInterface(&This->IErrorInfo_iface, riid, ppvoid);
 325 }
 326
 327 static ULONG WINAPI ICreateErrorInfoImpl_AddRef(
 328         ICreateErrorInfo* iface)
 329 {
 330     ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 331     return IErrorInfo_AddRef(&This->IErrorInfo_iface);
 332 }
 333
 334 static ULONG WINAPI ICreateErrorInfoImpl_Release(
 335         ICreateErrorInfo* iface)
 336 {
 337     ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 338     return IErrorInfo_Release(&This->IErrorInfo_iface);
 339 }
 340
 341
 342 static HRESULT WINAPI ICreateErrorInfoImpl_SetGUID(
 343         ICreateErrorInfo* iface,
 344         REFGUID rguid)
 345 {
 346         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 347         TRACE("(%p)->(%s)\n", This, debugstr_guid(rguid));
 348         This->m_Guid = *rguid;
 349         return S_OK;
 350 }
 351
 352 static HRESULT WINAPI ICreateErrorInfoImpl_SetSource(
 353         ICreateErrorInfo* iface,
 354         LPOLESTR szSource)
 355 {
 356         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 357         TRACE("(%p): %s\n",This, debugstr_w(szSource));
 358
 359         heap_free(This->source);
 360         This->source = heap_strdupW(szSource);
 361
 362         return S_OK;
 363 }
 364
 365 static HRESULT WINAPI ICreateErrorInfoImpl_SetDescription(
 366         ICreateErrorInfo* iface,
 367         LPOLESTR szDescription)
 368 {
 369         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 370         TRACE("(%p): %s\n",This, debugstr_w(szDescription));
 371
 372         heap_free(This->description);
 373         This->description = heap_strdupW(szDescription);
 374         return S_OK;
 375 }
 376
 377 static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpFile(
 378         ICreateErrorInfo* iface,
 379         LPOLESTR szHelpFile)
 380 {
 381         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 382         TRACE("(%p,%s)\n",This,debugstr_w(szHelpFile));
 383         if (This->bstrHelpFile != NULL)
 384             ERRORINFO_SysFreeString(This->bstrHelpFile);
 385         This->bstrHelpFile = ERRORINFO_SysAllocString(szHelpFile);
 386         return S_OK;
 387 }
 388
 389 static HRESULT WINAPI ICreateErrorInfoImpl_SetHelpContext(
 390         ICreateErrorInfo* iface,
 391         DWORD dwHelpContext)
 392 {
 393         ErrorInfoImpl *This = impl_from_ICreateErrorInfo(iface);
 394         TRACE("(%p,%d)\n",This,dwHelpContext);
 395         This->m_dwHelpContext = dwHelpContext;
 396         return S_OK;
 397 }
 398
 399 static const ICreateErrorInfoVtbl CreateErrorInfoVtbl =
 400 {
 401   ICreateErrorInfoImpl_QueryInterface,
 402   ICreateErrorInfoImpl_AddRef,
 403   ICreateErrorInfoImpl_Release,
 404   ICreateErrorInfoImpl_SetGUID,
 405   ICreateErrorInfoImpl_SetSource,
 406   ICreateErrorInfoImpl_SetDescription,
 407   ICreateErrorInfoImpl_SetHelpFile,
 408   ICreateErrorInfoImpl_SetHelpContext
 409 };
 410
 411 static HRESULT WINAPI ISupportErrorInfoImpl_QueryInterface(
 412         ISupportErrorInfo* iface,
 413         REFIID     riid,
 414         VOID**     ppvoid)
 415 {
 416     ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
 417     return IErrorInfo_QueryInterface(&This->IErrorInfo_iface, riid, ppvoid);
 418 }
 419
 420 static ULONG WINAPI ISupportErrorInfoImpl_AddRef(ISupportErrorInfo* iface)
 421 {
 422     ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
 423     return IErrorInfo_AddRef(&This->IErrorInfo_iface);
 424 }
 425
 426 static ULONG WINAPI ISupportErrorInfoImpl_Release(ISupportErrorInfo* iface)
 427 {
 428     ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
 429     return IErrorInfo_Release(&This->IErrorInfo_iface);
 430 }
 431
 432 static HRESULT WINAPI ISupportErrorInfoImpl_InterfaceSupportsErrorInfo(
 433         ISupportErrorInfo* iface,
 434         REFIID riid)
 435 {
 436         ErrorInfoImpl *This = impl_from_ISupportErrorInfo(iface);
 437         TRACE("(%p)->(%s)\n", This, debugstr_guid(riid));
 438         return (IsEqualIID(riid, &This->m_Guid)) ? S_OK : S_FALSE;
 439 }
 440
 441 static const ISupportErrorInfoVtbl SupportErrorInfoVtbl =
 442 {
 443   ISupportErrorInfoImpl_QueryInterface,
 444   ISupportErrorInfoImpl_AddRef,
 445   ISupportErrorInfoImpl_Release,
 446   ISupportErrorInfoImpl_InterfaceSupportsErrorInfo
 447 };
 448
 449 static IErrorInfo* IErrorInfoImpl_Constructor(void)
 450 {
 451     ErrorInfoImpl *This = heap_alloc(sizeof(ErrorInfoImpl));
 452
 453     if (!This) return NULL;
 454
 455     This->IErrorInfo_iface.lpVtbl = &ErrorInfoVtbl;
 456     This->ICreateErrorInfo_iface.lpVtbl = &CreateErrorInfoVtbl;
 457     This->ISupportErrorInfo_iface.lpVtbl = &SupportErrorInfoVtbl;
 458     This->ref = 1;
 459     This->source = NULL;
 460     This->description = NULL;
 461     This->bstrHelpFile = NULL;
 462     This->m_dwHelpContext = 0;
 463
 464     return &This->IErrorInfo_iface;
 465 }
 466
 467 /***********************************************************************
 468  *              CreateErrorInfo (OLE32.@)
 469  *
 470  * Creates an object used to set details for an error info object.
 471  *
 472  * PARAMS
 473  *  pperrinfo [O]. Address where error info creation object will be stored.
 474  *
 475  * RETURNS
 476  *  Success: S_OK.
 477  *  Failure: HRESULT code.
 478  */
 479 HRESULT WINAPI CreateErrorInfo(ICreateErrorInfo **pperrinfo)
 480 {
 481         IErrorInfo * pei;
 482         HRESULT res;
 483         TRACE("(%p)\n", pperrinfo);
 484         if(! pperrinfo ) return E_INVALIDARG;
 485         if(!(pei=IErrorInfoImpl_Constructor()))return E_OUTOFMEMORY;
 486
 487         res = IErrorInfo_QueryInterface(pei, &IID_ICreateErrorInfo, (LPVOID*)pperrinfo);
 488         IErrorInfo_Release(pei);
 489         return res;
 490 }
 491
 492 /***********************************************************************
 493  *              GetErrorInfo (OLE32.@)
 494  *
 495  * Retrieves the error information object for the current thread.
 496  *
 497  * PARAMS
 498  *  dwReserved [I]. Reserved. Must be zero.
 499  *  pperrinfo  [O]. Address where error information object will be stored on return.
 500  *
 501  * RETURNS
 502  *  Success: S_OK if an error information object was set for the current thread.
 503  *           S_FALSE if otherwise.
 504  *  Failure: E_INVALIDARG if dwReserved is not zero.
 505  *
 506  * NOTES
 507  *  This function causes the current error info object for the thread to be
 508  *  cleared if one was set beforehand.
 509  */
 510 HRESULT WINAPI GetErrorInfo(ULONG dwReserved, IErrorInfo **pperrinfo)
 511 {
 512         TRACE("(%d, %p, %p)\n", dwReserved, pperrinfo, COM_CurrentInfo()->errorinfo);
 513
 514         if (dwReserved)
 515         {
 516                 ERR("dwReserved (0x%x) != 0\n", dwReserved);
 517                 return E_INVALIDARG;
 518         }
 519
 520         if(!pperrinfo) return E_INVALIDARG;
 521
 522         if (!COM_CurrentInfo()->errorinfo)
 523         {
 524            *pperrinfo = NULL;
 525            return S_FALSE;
 526         }
 527
 528         *pperrinfo = COM_CurrentInfo()->errorinfo;
 529
 530         /* clear thread error state */
 531         COM_CurrentInfo()->errorinfo = NULL;
 532         return S_OK;
 533 }
 534
 535 /***********************************************************************
 536  *              SetErrorInfo (OLE32.@)
 537  *
 538  * Sets the error information object for the current thread.
 539  *
 540  * PARAMS
 541  *  dwReserved [I] Reserved. Must be zero.
 542  *  perrinfo   [I] Error info object.
 543  *
 544  * RETURNS
 545  *  Success: S_OK.
 546  *  Failure: E_INVALIDARG if dwReserved is not zero.
 547  */
 548 HRESULT WINAPI SetErrorInfo(ULONG dwReserved, IErrorInfo *perrinfo)
 549 {
 550         IErrorInfo * pei;
 551
 552         TRACE("(%d, %p)\n", dwReserved, perrinfo);
 553
 554         if (dwReserved)
 555         {
 556                 ERR("dwReserved (0x%x) != 0\n", dwReserved);
 557                 return E_INVALIDARG;
 558         }
 559
 560         /* release old errorinfo */
 561         pei = COM_CurrentInfo()->errorinfo;
 562         if (pei) IErrorInfo_Release(pei);
 563
 564         /* set to new value */
 565         COM_CurrentInfo()->errorinfo = perrinfo;
 566         if (perrinfo) IErrorInfo_AddRef(perrinfo);
 567
 568         return S_OK;
 569 }