dlls/msctf/documentmgr.c

   1 /*
   2  *  ITfDocumentMgr implementation
   3  *
   4  *  Copyright 2009 Aric Stewart, CodeWeavers
   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
  21 #include "config.h"
  22
  23 #include <stdarg.h>
  24
  25 #define COBJMACROS
  26
  27 #include "wine/debug.h"
  28 #include "windef.h"
  29 #include "winbase.h"
  30 #include "winreg.h"
  31 #include "winuser.h"
  32 #include "shlwapi.h"
  33 #include "winerror.h"
  34 #include "objbase.h"
  35
  36 #include "wine/unicode.h"
  37
  38 #include "msctf.h"
  39 #include "msctf_internal.h"
  40
  41 WINE_DEFAULT_DEBUG_CHANNEL(msctf);
  42
  43 typedef struct tagDocumentMgr {
  44     const ITfDocumentMgrVtbl *DocumentMgrVtbl;
  45     const ITfSourceVtbl *SourceVtbl;
  46     LONG refCount;
  47
  48     ITfContext*  contextStack[2]; /* limit of 2 contexts */
  49     ITfThreadMgrEventSink* ThreadMgrSink;
  50 } DocumentMgr;
  51
  52 static inline DocumentMgr *impl_from_ITfSourceVtbl(ITfSource *iface)
  53 {
  54     return (DocumentMgr *)((char *)iface - FIELD_OFFSET(DocumentMgr,SourceVtbl));
  55 }
  56
  57 static void DocumentMgr_Destructor(DocumentMgr *This)
  58 {
  59     TRACE("destroying %p\n", This);
  60     if (This->contextStack[0])
  61         ITfContext_Release(This->contextStack[0]);
  62     if (This->contextStack[1])
  63         ITfContext_Release(This->contextStack[1]);
  64     HeapFree(GetProcessHeap(),0,This);
  65 }
  66
  67 static HRESULT WINAPI DocumentMgr_QueryInterface(ITfDocumentMgr *iface, REFIID iid, LPVOID *ppvOut)
  68 {
  69     DocumentMgr *This = (DocumentMgr *)iface;
  70     *ppvOut = NULL;
  71
  72     if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_ITfDocumentMgr))
  73     {
  74         *ppvOut = This;
  75     }
  76     else if (IsEqualIID(iid, &IID_ITfSource))
  77     {
  78         *ppvOut = &This->SourceVtbl;
  79     }
  80
  81     if (*ppvOut)
  82     {
  83         IUnknown_AddRef(iface);
  84         return S_OK;
  85     }
  86
  87     WARN("unsupported interface: %s\n", debugstr_guid(iid));
  88     return E_NOINTERFACE;
  89 }
  90
  91 static ULONG WINAPI DocumentMgr_AddRef(ITfDocumentMgr *iface)
  92 {
  93     DocumentMgr *This = (DocumentMgr *)iface;
  94     return InterlockedIncrement(&This->refCount);
  95 }
  96
  97 static ULONG WINAPI DocumentMgr_Release(ITfDocumentMgr *iface)
  98 {
  99     DocumentMgr *This = (DocumentMgr *)iface;
 100     ULONG ret;
 101
 102     ret = InterlockedDecrement(&This->refCount);
 103     if (ret == 0)
 104         DocumentMgr_Destructor(This);
 105     return ret;
 106 }
 107
 108 /*****************************************************
 109  * ITfDocumentMgr functions
 110  *****************************************************/
 111 static HRESULT WINAPI DocumentMgr_CreateContext(ITfDocumentMgr *iface,
 112         TfClientId tidOwner,
 113         DWORD dwFlags, IUnknown *punk, ITfContext **ppic,
 114         TfEditCookie *pecTextStore)
 115 {
 116     DocumentMgr *This = (DocumentMgr *)iface;
 117     TRACE("(%p) 0x%x 0x%x %p %p %p\n",This,tidOwner,dwFlags,punk,ppic,pecTextStore);
 118     return Context_Constructor(tidOwner, punk, ppic, pecTextStore);
 119 }
 120
 121 static HRESULT WINAPI DocumentMgr_Push(ITfDocumentMgr *iface, ITfContext *pic)
 122 {
 123     DocumentMgr *This = (DocumentMgr *)iface;
 124     ITfContext *check;
 125
 126     TRACE("(%p) %p\n",This,pic);
 127
 128     if (This->contextStack[1])  /* FUll */
 129         return TF_E_STACKFULL;
 130
 131     if (!pic || FAILED(IUnknown_QueryInterface(pic,&IID_ITfContext,(LPVOID*) &check)))
 132         return E_INVALIDARG;
 133
 134     if (This->contextStack[0] == NULL)
 135         ITfThreadMgrEventSink_OnInitDocumentMgr(This->ThreadMgrSink,iface);
 136
 137     This->contextStack[1] = This->contextStack[0];
 138     This->contextStack[0] = check;
 139
 140     ITfThreadMgrEventSink_OnPushContext(This->ThreadMgrSink,check);
 141
 142     return S_OK;
 143 }
 144
 145 static HRESULT WINAPI DocumentMgr_Pop(ITfDocumentMgr *iface, DWORD dwFlags)
 146 {
 147     DocumentMgr *This = (DocumentMgr *)iface;
 148     TRACE("(%p) 0x%x\n",This,dwFlags);
 149
 150     if (dwFlags == TF_POPF_ALL)
 151     {
 152         if (This->contextStack[0])
 153         {
 154             ITfThreadMgrEventSink_OnPopContext(This->ThreadMgrSink,This->contextStack[0]);
 155             ITfContext_Release(This->contextStack[0]);
 156         }
 157         if (This->contextStack[1])
 158         {
 159             ITfThreadMgrEventSink_OnPopContext(This->ThreadMgrSink,This->contextStack[1]);
 160             ITfContext_Release(This->contextStack[1]);
 161         }
 162         This->contextStack[0] = This->contextStack[1] = NULL;
 163         ITfThreadMgrEventSink_OnUninitDocumentMgr(This->ThreadMgrSink, iface);
 164         return S_OK;
 165     }
 166
 167     if (dwFlags)
 168         return E_INVALIDARG;
 169
 170     if (This->contextStack[1] == NULL) /* Cannot pop last context */
 171         return E_FAIL;
 172
 173     ITfThreadMgrEventSink_OnPopContext(This->ThreadMgrSink,This->contextStack[0]);
 174     ITfContext_Release(This->contextStack[0]);
 175     This->contextStack[0] = This->contextStack[1];
 176     This->contextStack[1] = NULL;
 177
 178     if (This->contextStack[0] == NULL)
 179         ITfThreadMgrEventSink_OnUninitDocumentMgr(This->ThreadMgrSink, iface);
 180
 181     return S_OK;
 182 }
 183
 184 static HRESULT WINAPI DocumentMgr_GetTop(ITfDocumentMgr *iface, ITfContext **ppic)
 185 {
 186     DocumentMgr *This = (DocumentMgr *)iface;
 187     TRACE("(%p)\n",This);
 188     if (!ppic)
 189         return E_INVALIDARG;
 190
 191     if (This->contextStack[0])
 192         ITfContext_AddRef(This->contextStack[0]);
 193
 194     *ppic = This->contextStack[0];
 195
 196     return S_OK;
 197 }
 198
 199 static HRESULT WINAPI DocumentMgr_GetBase(ITfDocumentMgr *iface, ITfContext **ppic)
 200 {
 201     DocumentMgr *This = (DocumentMgr *)iface;
 202     ITfContext *tgt;
 203
 204     TRACE("(%p)\n",This);
 205     if (!ppic)
 206         return E_INVALIDARG;
 207
 208     if (This->contextStack[1])
 209         tgt = This->contextStack[1];
 210     else
 211         tgt = This->contextStack[0];
 212
 213     if (tgt)
 214         ITfContext_AddRef(tgt);
 215
 216     *ppic = tgt;
 217
 218     return S_OK;
 219 }
 220
 221 static HRESULT WINAPI DocumentMgr_EnumContexts(ITfDocumentMgr *iface, IEnumTfContexts **ppEnum)
 222 {
 223     DocumentMgr *This = (DocumentMgr *)iface;
 224     FIXME("STUB:(%p)\n",This);
 225     return E_NOTIMPL;
 226 }
 227
 228 static const ITfDocumentMgrVtbl DocumentMgr_DocumentMgrVtbl =
 229 {
 230     DocumentMgr_QueryInterface,
 231     DocumentMgr_AddRef,
 232     DocumentMgr_Release,
 233
 234     DocumentMgr_CreateContext,
 235     DocumentMgr_Push,
 236     DocumentMgr_Pop,
 237     DocumentMgr_GetTop,
 238     DocumentMgr_GetBase,
 239     DocumentMgr_EnumContexts
 240 };
 241
 242
 243 static HRESULT WINAPI Source_QueryInterface(ITfSource *iface, REFIID iid, LPVOID *ppvOut)
 244 {
 245     DocumentMgr *This = impl_from_ITfSourceVtbl(iface);
 246     return DocumentMgr_QueryInterface((ITfDocumentMgr*)This, iid, *ppvOut);
 247 }
 248
 249 static ULONG WINAPI Source_AddRef(ITfSource *iface)
 250 {
 251     DocumentMgr *This = impl_from_ITfSourceVtbl(iface);
 252     return DocumentMgr_AddRef((ITfDocumentMgr*)This);
 253 }
 254
 255 static ULONG WINAPI Source_Release(ITfSource *iface)
 256 {
 257     DocumentMgr *This = impl_from_ITfSourceVtbl(iface);
 258     return DocumentMgr_Release((ITfDocumentMgr*)This);
 259 }
 260
 261 /*****************************************************
 262  * ITfSource functions
 263  *****************************************************/
 264 static WINAPI HRESULT DocumentMgrSource_AdviseSink(ITfSource *iface,
 265         REFIID riid, IUnknown *punk, DWORD *pdwCookie)
 266 {
 267     DocumentMgr *This = impl_from_ITfSourceVtbl(iface);
 268     FIXME("STUB:(%p)\n",This);
 269     return E_NOTIMPL;
 270 }
 271
 272 static WINAPI HRESULT DocumentMgrSource_UnadviseSink(ITfSource *iface, DWORD pdwCookie)
 273 {
 274     DocumentMgr *This = impl_from_ITfSourceVtbl(iface);
 275     FIXME("STUB:(%p)\n",This);
 276     return E_NOTIMPL;
 277 }
 278
 279 static const ITfSourceVtbl DocumentMgr_SourceVtbl =
 280 {
 281     Source_QueryInterface,
 282     Source_AddRef,
 283     Source_Release,
 284
 285     DocumentMgrSource_AdviseSink,
 286     DocumentMgrSource_UnadviseSink,
 287 };
 288
 289 HRESULT DocumentMgr_Constructor(ITfThreadMgrEventSink *ThreadMgrSink, ITfDocumentMgr **ppOut)
 290 {
 291     DocumentMgr *This;
 292
 293     This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(DocumentMgr));
 294     if (This == NULL)
 295         return E_OUTOFMEMORY;
 296
 297     This->DocumentMgrVtbl= &DocumentMgr_DocumentMgrVtbl;
 298     This->SourceVtbl = &DocumentMgr_SourceVtbl;
 299     This->refCount = 1;
 300     This->ThreadMgrSink = ThreadMgrSink;
 301
 302     TRACE("returning %p\n", This);
 303     *ppOut = (ITfDocumentMgr*)This;
 304     return S_OK;
 305 }