Wine Cross Reference
wine/dlls/msctf/compartmentmgr.c

   /*
    *  ITfCompartmentMgr implementation
    *
    *  Copyright 2009 Aric Stewart, CodeWeavers
    *
    * This library is free software; you can redistribute it and/or
    * modify it under the terms of the GNU Lesser General Public
    * License as published by the Free Software Foundation; either
    * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
   */
  
  #include "config.h"
  
  #include <stdarg.h>
  
  #define COBJMACROS
  
  #include "wine/debug.h"
  #include "windef.h"
  #include "winbase.h"
  #include "winreg.h"
  #include "winuser.h"
  #include "shlwapi.h"
  #include "winerror.h"
  #include "objbase.h"
  #include "oleauto.h"
  #include "olectl.h"
  
  #include "wine/unicode.h"
  #include "wine/list.h"
  
  #include "msctf.h"
  #include "msctf_internal.h"
  
  WINE_DEFAULT_DEBUG_CHANNEL(msctf);
  
  typedef struct tagCompartmentValue {
      struct list entry;
      GUID guid;
      TfClientId owner;
      ITfCompartment *compartment;
  } CompartmentValue;
  
  typedef struct tagCompartmentMgr {
      const ITfCompartmentMgrVtbl *CompartmentMgrVtbl;
      LONG refCount;
  
      IUnknown *pUnkOuter;
  
      struct list values;
  } CompartmentMgr;
  
  typedef struct tagCompartmentEnumGuid {
      const IEnumGUIDVtbl *Vtbl;
      LONG refCount;
  
      struct list *values;
      struct list *cursor;
  } CompartmentEnumGuid;
  
  
  typedef struct tagCompartmentSink {
      struct list         entry;
      union {
          IUnknown            *pIUnknown;
          ITfCompartmentEventSink *pITfCompartmentEventSink;
      } interfaces;
  } CompartmentSink;
  
  typedef struct tagCompartment {
      const ITfCompartmentVtbl *Vtbl;
      const ITfSourceVtbl *SourceVtbl;
      LONG refCount;
  
      /* Only VT_I4, VT_UNKNOWN and VT_BSTR data types are allowed */
      VARIANT variant;
      CompartmentValue *valueData;
      struct list CompartmentEventSink;
  } Compartment;
  
  static HRESULT CompartmentEnumGuid_Constructor(struct list* values, IEnumGUID **ppOut);
  static HRESULT Compartment_Constructor(CompartmentValue *value, ITfCompartment **ppOut);
  
  static inline Compartment *impl_from_ITfSourceVtbl(ITfSource *iface)
  {
      return (Compartment *)((char *)iface - FIELD_OFFSET(Compartment,SourceVtbl));
  }
  
  HRESULT CompartmentMgr_Destructor(ITfCompartmentMgr *iface)
  {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     struct list *cursor, *cursor2;
 
     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->values)
     {
         CompartmentValue* value = LIST_ENTRY(cursor,CompartmentValue,entry);
         list_remove(cursor);
         ITfCompartment_Release(value->compartment);
         HeapFree(GetProcessHeap(),0,value);
     }
 
     HeapFree(GetProcessHeap(),0,This);
     return S_OK;
 }
 
 /*****************************************************
  * ITfCompartmentMgr functions
  *****************************************************/
 static HRESULT WINAPI CompartmentMgr_QueryInterface(ITfCompartmentMgr *iface, REFIID iid, LPVOID *ppvOut)
 {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     if (This->pUnkOuter)
         return IUnknown_QueryInterface(This->pUnkOuter, iid, *ppvOut);
     else
     {
         *ppvOut = NULL;
 
         if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_ITfCompartmentMgr))
         {
             *ppvOut = This;
         }
 
         if (*ppvOut)
         {
             IUnknown_AddRef(iface);
             return S_OK;
         }
 
         WARN("unsupported interface: %s\n", debugstr_guid(iid));
         return E_NOINTERFACE;
     }
 }
 
 static ULONG WINAPI CompartmentMgr_AddRef(ITfCompartmentMgr *iface)
 {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     if (This->pUnkOuter)
         return IUnknown_AddRef(This->pUnkOuter);
     else
         return InterlockedIncrement(&This->refCount);
 }
 
 static ULONG WINAPI CompartmentMgr_Release(ITfCompartmentMgr *iface)
 {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     if (This->pUnkOuter)
         return IUnknown_Release(This->pUnkOuter);
     else
     {
         ULONG ret;
 
         ret = InterlockedDecrement(&This->refCount);
         if (ret == 0)
             CompartmentMgr_Destructor(iface);
         return ret;
     }
 }
 
 static HRESULT WINAPI CompartmentMgr_GetCompartment(ITfCompartmentMgr *iface,
         REFGUID rguid, ITfCompartment **ppcomp)
 {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     CompartmentValue* value;
     struct list *cursor;
     HRESULT hr;
 
     TRACE("(%p) %s  %p\n",This,debugstr_guid(rguid),ppcomp);
 
     LIST_FOR_EACH(cursor, &This->values)
     {
         value = LIST_ENTRY(cursor,CompartmentValue,entry);
         if (IsEqualGUID(rguid,&value->guid))
         {
             ITfCompartment_AddRef(value->compartment);
             *ppcomp = value->compartment;
             return S_OK;
         }
     }
 
     value = HeapAlloc(GetProcessHeap(),0,sizeof(CompartmentValue));
     value->guid = *rguid;
     value->owner = 0;
     hr = Compartment_Constructor(value,&value->compartment);
     if (SUCCEEDED(hr))
     {
         list_add_head(&This->values,&value->entry);
         ITfCompartment_AddRef(value->compartment);
         *ppcomp = value->compartment;
     }
     else
     {
         HeapFree(GetProcessHeap(),0,value);
         *ppcomp = NULL;
     }
     return hr;
 }
 
 static HRESULT WINAPI CompartmentMgr_ClearCompartment(ITfCompartmentMgr *iface,
     TfClientId tid, REFGUID rguid)
 {
     struct list *cursor;
     CompartmentMgr *This = (CompartmentMgr *)iface;
     TRACE("(%p) %i %s\n",This,tid,debugstr_guid(rguid));
 
     LIST_FOR_EACH(cursor, &This->values)
     {
         CompartmentValue* value = LIST_ENTRY(cursor,CompartmentValue,entry);
         if (IsEqualGUID(rguid,&value->guid))
         {
             if (value->owner && tid != value->owner)
                 return E_UNEXPECTED;
             list_remove(cursor);
             ITfCompartment_Release(value->compartment);
             HeapFree(GetProcessHeap(),0,value);
             return S_OK;
         }
     }
 
     return CONNECT_E_NOCONNECTION;
 }
 
 static HRESULT WINAPI CompartmentMgr_EnumCompartments(ITfCompartmentMgr *iface,
  IEnumGUID **ppEnum)
 {
     CompartmentMgr *This = (CompartmentMgr *)iface;
     TRACE("(%p) %p\n",This,ppEnum);
     if (!ppEnum)
         return E_INVALIDARG;
     return CompartmentEnumGuid_Constructor(&This->values, ppEnum);
 }
 
 static const ITfCompartmentMgrVtbl CompartmentMgr_CompartmentMgrVtbl =
 {
     CompartmentMgr_QueryInterface,
     CompartmentMgr_AddRef,
     CompartmentMgr_Release,
 
     CompartmentMgr_GetCompartment,
     CompartmentMgr_ClearCompartment,
     CompartmentMgr_EnumCompartments
 };
 
 HRESULT CompartmentMgr_Constructor(IUnknown *pUnkOuter, REFIID riid, IUnknown **ppOut)
 {
     CompartmentMgr *This;
 
     if (!ppOut)
         return E_POINTER;
 
     if (pUnkOuter && !IsEqualIID (riid, &IID_IUnknown))
         return CLASS_E_NOAGGREGATION;
 
     This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(CompartmentMgr));
     if (This == NULL)
         return E_OUTOFMEMORY;
 
     This->CompartmentMgrVtbl = &CompartmentMgr_CompartmentMgrVtbl;
     This->pUnkOuter = pUnkOuter;
     list_init(&This->values);
 
     if (pUnkOuter)
     {
         TRACE("returning %p\n", This);
         *ppOut = (IUnknown*)This;
         return S_OK;
     }
     else
     {
         HRESULT hr;
         hr = IUnknown_QueryInterface((IUnknown*)This, riid, (LPVOID*)ppOut);
         if (FAILED(hr))
             HeapFree(GetProcessHeap(),0,This);
         return hr;
     }
 }
 
 /**************************************************
  * IEnumGUID implementaion for ITfCompartmentMgr::EnumCompartments
  **************************************************/
 static void CompartmentEnumGuid_Destructor(CompartmentEnumGuid *This)
 {
     TRACE("destroying %p\n", This);
     HeapFree(GetProcessHeap(),0,This);
 }
 
 static HRESULT WINAPI CompartmentEnumGuid_QueryInterface(IEnumGUID *iface, REFIID iid, LPVOID *ppvOut)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     *ppvOut = NULL;
 
     if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_IEnumGUID))
     {
         *ppvOut = This;
     }
 
     if (*ppvOut)
     {
         IUnknown_AddRef(iface);
         return S_OK;
     }
 
     WARN("unsupported interface: %s\n", debugstr_guid(iid));
     return E_NOINTERFACE;
 }
 
 static ULONG WINAPI CompartmentEnumGuid_AddRef(IEnumGUID *iface)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid*)iface;
     return InterlockedIncrement(&This->refCount);
 }
 
 static ULONG WINAPI CompartmentEnumGuid_Release(IEnumGUID *iface)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     ULONG ret;
 
     ret = InterlockedDecrement(&This->refCount);
     if (ret == 0)
         CompartmentEnumGuid_Destructor(This);
     return ret;
 }
 
 /*****************************************************
  * IEnumGuid functions
  *****************************************************/
 static HRESULT WINAPI CompartmentEnumGuid_Next( LPENUMGUID iface,
     ULONG celt, GUID *rgelt, ULONG *pceltFetched)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     ULONG fetched = 0;
 
     TRACE("(%p)\n",This);
 
     if (rgelt == NULL) return E_POINTER;
 
     while (fetched < celt && This->cursor)
     {
         CompartmentValue* value = LIST_ENTRY(This->cursor,CompartmentValue,entry);
         if (!value)
             break;
 
         This->cursor = list_next(This->values,This->cursor);
         *rgelt = value->guid;
 
         ++fetched;
         ++rgelt;
     }
 
     if (pceltFetched) *pceltFetched = fetched;
     return fetched == celt ? S_OK : S_FALSE;
 }
 
 static HRESULT WINAPI CompartmentEnumGuid_Skip( LPENUMGUID iface, ULONG celt)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     TRACE("(%p)\n",This);
 
     This->cursor = list_next(This->values,This->cursor);
     return S_OK;
 }
 
 static HRESULT WINAPI CompartmentEnumGuid_Reset( LPENUMGUID iface)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     TRACE("(%p)\n",This);
     This->cursor = list_head(This->values);
     return S_OK;
 }
 
 static HRESULT WINAPI CompartmentEnumGuid_Clone( LPENUMGUID iface,
     IEnumGUID **ppenum)
 {
     CompartmentEnumGuid *This = (CompartmentEnumGuid *)iface;
     HRESULT res;
 
     TRACE("(%p)\n",This);
 
     if (ppenum == NULL) return E_POINTER;
 
     res = CompartmentEnumGuid_Constructor(This->values, ppenum);
     if (SUCCEEDED(res))
     {
         CompartmentEnumGuid *new_This = (CompartmentEnumGuid *)*ppenum;
         new_This->cursor = This->cursor;
     }
     return res;
 }
 
 static const IEnumGUIDVtbl IEnumGUID_Vtbl ={
     CompartmentEnumGuid_QueryInterface,
     CompartmentEnumGuid_AddRef,
     CompartmentEnumGuid_Release,
 
     CompartmentEnumGuid_Next,
     CompartmentEnumGuid_Skip,
     CompartmentEnumGuid_Reset,
     CompartmentEnumGuid_Clone
 };
 
 static HRESULT CompartmentEnumGuid_Constructor(struct list *values, IEnumGUID **ppOut)
 {
     CompartmentEnumGuid *This;
 
     This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(CompartmentEnumGuid));
     if (This == NULL)
         return E_OUTOFMEMORY;
 
     This->Vtbl= &IEnumGUID_Vtbl;
     This->refCount = 1;
 
     This->values = values;
     This->cursor = list_head(values);
 
     TRACE("returning %p\n", This);
     *ppOut = (IEnumGUID*)This;
     return S_OK;
 }
 
 /**************************************************
  * ITfCompartment
  **************************************************/
 static void free_sink(CompartmentSink *sink)
 {
         IUnknown_Release(sink->interfaces.pIUnknown);
         HeapFree(GetProcessHeap(),0,sink);
 }
 
 static void Compartment_Destructor(Compartment *This)
 {
     struct list *cursor, *cursor2;
     TRACE("destroying %p\n", This);
     VariantClear(&This->variant);
     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->CompartmentEventSink)
     {
         CompartmentSink* sink = LIST_ENTRY(cursor,CompartmentSink,entry);
         list_remove(cursor);
         free_sink(sink);
     }
     HeapFree(GetProcessHeap(),0,This);
 }
 
 static HRESULT WINAPI Compartment_QueryInterface(ITfCompartment *iface, REFIID iid, LPVOID *ppvOut)
 {
     Compartment *This = (Compartment *)iface;
     *ppvOut = NULL;
 
     if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_ITfCompartment))
     {
         *ppvOut = This;
     }
     else if (IsEqualIID(iid, &IID_ITfSource))
     {
         *ppvOut = &This->SourceVtbl;
     }
 
     if (*ppvOut)
     {
         IUnknown_AddRef(iface);
         return S_OK;
     }
 
     WARN("unsupported interface: %s\n", debugstr_guid(iid));
     return E_NOINTERFACE;
 }
 
 static ULONG WINAPI Compartment_AddRef(ITfCompartment *iface)
 {
     Compartment *This = (Compartment*)iface;
     return InterlockedIncrement(&This->refCount);
 }
 
 static ULONG WINAPI Compartment_Release(ITfCompartment *iface)
 {
     Compartment *This = (Compartment *)iface;
     ULONG ret;
 
     ret = InterlockedDecrement(&This->refCount);
     if (ret == 0)
         Compartment_Destructor(This);
     return ret;
 }
 
 static HRESULT WINAPI Compartment_SetValue(ITfCompartment *iface,
     TfClientId tid, const VARIANT *pvarValue)
 {
     Compartment *This = (Compartment *)iface;
     struct list *cursor;
 
     TRACE("(%p) %i %p\n",This,tid,pvarValue);
 
     if (!pvarValue)
         return E_INVALIDARG;
 
     if (!(V_VT(pvarValue) == VT_BSTR || V_VT(pvarValue) == VT_I4 ||
           V_VT(pvarValue) == VT_UNKNOWN))
         return E_INVALIDARG;
 
     if (!This->valueData->owner)
         This->valueData->owner = tid;
 
     VariantClear(&This->variant);
 
     /* Shallow copy of value and type */
     This->variant = *pvarValue;
 
     if (V_VT(pvarValue) == VT_BSTR)
         V_BSTR(&This->variant) = SysAllocStringByteLen((char*)V_BSTR(pvarValue),
                 SysStringByteLen(V_BSTR(pvarValue)));
     else if (V_VT(pvarValue) == VT_UNKNOWN)
         IUnknown_AddRef(V_UNKNOWN(&This->variant));
 
     LIST_FOR_EACH(cursor, &This->CompartmentEventSink)
     {
         CompartmentSink* sink = LIST_ENTRY(cursor,CompartmentSink,entry);
         ITfCompartmentEventSink_OnChange(sink->interfaces.pITfCompartmentEventSink,&This->valueData->guid);
     }
 
     return S_OK;
 }
 
 static HRESULT WINAPI Compartment_GetValue(ITfCompartment *iface,
     VARIANT *pvarValue)
 {
     Compartment *This = (Compartment *)iface;
     TRACE("(%p) %p\n",This, pvarValue);
 
     if (!pvarValue)
         return E_INVALIDARG;
 
     VariantInit(pvarValue);
     if (V_VT(&This->variant) == VT_EMPTY) return S_FALSE;
     return VariantCopy(pvarValue,&This->variant);
 }
 
 static const ITfCompartmentVtbl ITfCompartment_Vtbl ={
     Compartment_QueryInterface,
     Compartment_AddRef,
     Compartment_Release,
 
     Compartment_SetValue,
     Compartment_GetValue
 };
 
 /*****************************************************
  * ITfSource functions
  *****************************************************/
 
 static HRESULT WINAPI Source_QueryInterface(ITfSource *iface, REFIID iid, LPVOID *ppvOut)
 {
     Compartment *This = impl_from_ITfSourceVtbl(iface);
     return Compartment_QueryInterface((ITfCompartment *)This, iid, *ppvOut);
 }
 
 static ULONG WINAPI Source_AddRef(ITfSource *iface)
 {
     Compartment *This = impl_from_ITfSourceVtbl(iface);
     return Compartment_AddRef((ITfCompartment*)This);
 }
 
 static ULONG WINAPI Source_Release(ITfSource *iface)
 {
     Compartment *This = impl_from_ITfSourceVtbl(iface);
     return Compartment_Release((ITfCompartment *)This);
 }
 
 static HRESULT WINAPI CompartmentSource_AdviseSink(ITfSource *iface,
         REFIID riid, IUnknown *punk, DWORD *pdwCookie)
 {
     CompartmentSink *cs;
     Compartment *This = impl_from_ITfSourceVtbl(iface);
 
     TRACE("(%p) %s %p %p\n",This,debugstr_guid(riid),punk,pdwCookie);
 
     if (!riid || !punk || !pdwCookie)
         return E_INVALIDARG;
 
     if (IsEqualIID(riid, &IID_ITfCompartmentEventSink))
     {
         cs = HeapAlloc(GetProcessHeap(),0,sizeof(CompartmentSink));
         if (!cs)
             return E_OUTOFMEMORY;
         if (FAILED(IUnknown_QueryInterface(punk, riid, (LPVOID *)&cs->interfaces.pITfCompartmentEventSink)))
         {
             HeapFree(GetProcessHeap(),0,cs);
             return CONNECT_E_CANNOTCONNECT;
         }
         list_add_head(&This->CompartmentEventSink,&cs->entry);
         *pdwCookie = generate_Cookie(COOKIE_MAGIC_COMPARTMENTSINK , cs);
     }
     else
     {
         FIXME("(%p) Unhandled Sink: %s\n",This,debugstr_guid(riid));
         return E_NOTIMPL;
     }
 
     TRACE("cookie %x\n",*pdwCookie);
 
     return S_OK;
 }
 
 static HRESULT WINAPI CompartmentSource_UnadviseSink(ITfSource *iface, DWORD pdwCookie)
 {
     CompartmentSink *sink;
     Compartment *This = impl_from_ITfSourceVtbl(iface);
 
     TRACE("(%p) %x\n",This,pdwCookie);
 
     if (get_Cookie_magic(pdwCookie)!=COOKIE_MAGIC_COMPARTMENTSINK)
         return E_INVALIDARG;
 
     sink = (CompartmentSink*)remove_Cookie(pdwCookie);
     if (!sink)
         return CONNECT_E_NOCONNECTION;
 
     list_remove(&sink->entry);
     free_sink(sink);
 
     return S_OK;
 }
 
 static const ITfSourceVtbl Compartment_SourceVtbl =
 {
     Source_QueryInterface,
     Source_AddRef,
     Source_Release,
 
     CompartmentSource_AdviseSink,
     CompartmentSource_UnadviseSink,
 };
 
 static HRESULT Compartment_Constructor(CompartmentValue *valueData, ITfCompartment **ppOut)
 {
     Compartment *This;
 
     This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(Compartment));
     if (This == NULL)
         return E_OUTOFMEMORY;
 
     This->Vtbl= &ITfCompartment_Vtbl;
     This->SourceVtbl = &Compartment_SourceVtbl;
     This->refCount = 1;
 
     This->valueData = valueData;
     VariantInit(&This->variant);
 
     list_init(&This->CompartmentEventSink);
 
     TRACE("returning %p\n", This);
     *ppOut = (ITfCompartment*)This;
     return S_OK;
 }