dlls/msctf/threadmgr.c

   1 /*
   2  *  ITfThreadMgr implementation
   3  *
   4  *  Copyright 2008 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 #include "olectl.h"
  36
  37 #include "wine/unicode.h"
  38 #include "wine/list.h"
  39
  40 #include "msctf.h"
  41 #include "msctf_internal.h"
  42
  43 WINE_DEFAULT_DEBUG_CHANNEL(msctf);
  44
  45 typedef struct tagThreadMgrSink {
  46     struct list         entry;
  47     union {
  48         /* ThreadMgr Sinks */
  49         IUnknown            *pIUnknown;
  50         /* ITfActiveLanguageProfileNotifySink *pITfActiveLanguageProfileNotifySink; */
  51         /* ITfDisplayAttributeNotifySink *pITfDisplayAttributeNotifySink; */
  52         /* ITfKeyTraceEventSink *pITfKeyTraceEventSink; */
  53         /* ITfPreservedKeyNotifySink *pITfPreservedKeyNotifySink; */
  54         /* ITfThreadFocusSink *pITfThreadFocusSink; */
  55         ITfThreadMgrEventSink *pITfThreadMgrEventSink;
  56     } interfaces;
  57 } ThreadMgrSink;
  58
  59 typedef struct tagACLMulti {
  60     const ITfThreadMgrVtbl *ThreadMgrVtbl;
  61     const ITfSourceVtbl *SourceVtbl;
  62     LONG refCount;
  63
  64     const ITfThreadMgrEventSinkVtbl *ThreadMgrEventSinkVtbl; /* internal */
  65
  66     ITfDocumentMgr *focus;
  67
  68     /* kept as separate lists to reduce unnecessary iterations */
  69     struct list     ActiveLanguageProfileNotifySink;
  70     struct list     DisplayAttributeNotifySink;
  71     struct list     KeyTraceEventSink;
  72     struct list     PreservedKeyNotifySink;
  73     struct list     ThreadFocusSink;
  74     struct list     ThreadMgrEventSink;
  75 } ThreadMgr;
  76
  77 static inline ThreadMgr *impl_from_ITfSourceVtbl(ITfSource *iface)
  78 {
  79     return (ThreadMgr *)((char *)iface - FIELD_OFFSET(ThreadMgr,SourceVtbl));
  80 }
  81
  82 static inline ThreadMgr *impl_from_ITfThreadMgrEventSink(ITfThreadMgrEventSink *iface)
  83 {
  84     return (ThreadMgr *)((char *)iface - FIELD_OFFSET(ThreadMgr,ThreadMgrEventSinkVtbl));
  85 }
  86
  87 static void free_sink(ThreadMgrSink *sink)
  88 {
  89         IUnknown_Release(sink->interfaces.pIUnknown);
  90         HeapFree(GetProcessHeap(),0,sink);
  91 }
  92
  93 static void ThreadMgr_Destructor(ThreadMgr *This)
  94 {
  95     struct list *cursor, *cursor2;
  96
  97     TlsSetValue(tlsIndex,NULL);
  98     TRACE("destroying %p\n", This);
  99     if (This->focus)
 100         ITfDocumentMgr_Release(This->focus);
 101
 102     /* free sinks */
 103     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->ActiveLanguageProfileNotifySink)
 104     {
 105         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 106         list_remove(cursor);
 107         free_sink(sink);
 108     }
 109     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->DisplayAttributeNotifySink)
 110     {
 111         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 112         list_remove(cursor);
 113         free_sink(sink);
 114     }
 115     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->KeyTraceEventSink)
 116     {
 117         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 118         list_remove(cursor);
 119         free_sink(sink);
 120     }
 121     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->PreservedKeyNotifySink)
 122     {
 123         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 124         list_remove(cursor);
 125         free_sink(sink);
 126     }
 127     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->ThreadFocusSink)
 128     {
 129         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 130         list_remove(cursor);
 131         free_sink(sink);
 132     }
 133     LIST_FOR_EACH_SAFE(cursor, cursor2, &This->ThreadMgrEventSink)
 134     {
 135         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 136         list_remove(cursor);
 137         free_sink(sink);
 138     }
 139
 140     HeapFree(GetProcessHeap(),0,This);
 141 }
 142
 143 static HRESULT WINAPI ThreadMgr_QueryInterface(ITfThreadMgr *iface, REFIID iid, LPVOID *ppvOut)
 144 {
 145     ThreadMgr *This = (ThreadMgr *)iface;
 146     *ppvOut = NULL;
 147
 148     if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_ITfThreadMgr))
 149     {
 150         *ppvOut = This;
 151     }
 152     else if (IsEqualIID(iid, &IID_ITfSource))
 153     {
 154         *ppvOut = &This->SourceVtbl;
 155     }
 156
 157     if (*ppvOut)
 158     {
 159         IUnknown_AddRef(iface);
 160         return S_OK;
 161     }
 162
 163     WARN("unsupported interface: %s\n", debugstr_guid(iid));
 164     return E_NOINTERFACE;
 165 }
 166
 167 static ULONG WINAPI ThreadMgr_AddRef(ITfThreadMgr *iface)
 168 {
 169     ThreadMgr *This = (ThreadMgr *)iface;
 170     return InterlockedIncrement(&This->refCount);
 171 }
 172
 173 static ULONG WINAPI ThreadMgr_Release(ITfThreadMgr *iface)
 174 {
 175     ThreadMgr *This = (ThreadMgr *)iface;
 176     ULONG ret;
 177
 178     ret = InterlockedDecrement(&This->refCount);
 179     if (ret == 0)
 180         ThreadMgr_Destructor(This);
 181     return ret;
 182 }
 183
 184 /*****************************************************
 185  * ITfThreadMgr functions
 186  *****************************************************/
 187
 188 static HRESULT WINAPI ThreadMgr_fnActivate( ITfThreadMgr* iface, TfClientId *ptid)
 189 {
 190     ThreadMgr *This = (ThreadMgr *)iface;
 191     FIXME("STUB:(%p)\n",This);
 192     return E_NOTIMPL;
 193 }
 194
 195 static HRESULT WINAPI ThreadMgr_fnDeactivate( ITfThreadMgr* iface)
 196 {
 197     ThreadMgr *This = (ThreadMgr *)iface;
 198     FIXME("STUB:(%p)\n",This);
 199
 200     if (This->focus)
 201     {
 202         ITfThreadMgrEventSink_OnSetFocus((ITfThreadMgrEventSink*)&This->ThreadMgrEventSinkVtbl, 0, This->focus);
 203         ITfDocumentMgr_Release(This->focus);
 204         This->focus = 0;
 205     }
 206
 207     return E_NOTIMPL;
 208 }
 209
 210 static HRESULT WINAPI ThreadMgr_CreateDocumentMgr( ITfThreadMgr* iface, ITfDocumentMgr
 211 **ppdim)
 212 {
 213     ThreadMgr *This = (ThreadMgr *)iface;
 214     TRACE("(%p)\n",iface);
 215     return DocumentMgr_Constructor((ITfThreadMgrEventSink*)&This->ThreadMgrEventSinkVtbl, ppdim);
 216 }
 217
 218 static HRESULT WINAPI ThreadMgr_EnumDocumentMgrs( ITfThreadMgr* iface, IEnumTfDocumentMgrs
 219 **ppEnum)
 220 {
 221     ThreadMgr *This = (ThreadMgr *)iface;
 222     FIXME("STUB:(%p)\n",This);
 223     return E_NOTIMPL;
 224 }
 225
 226 static HRESULT WINAPI ThreadMgr_GetFocus( ITfThreadMgr* iface, ITfDocumentMgr
 227 **ppdimFocus)
 228 {
 229     ThreadMgr *This = (ThreadMgr *)iface;
 230     TRACE("(%p)\n",This);
 231
 232     if (!ppdimFocus)
 233         return E_INVALIDARG;
 234
 235     *ppdimFocus = This->focus;
 236
 237     TRACE("->%p\n",This->focus);
 238
 239     if (This->focus == NULL)
 240         return S_FALSE;
 241
 242     ITfDocumentMgr_AddRef(This->focus);
 243
 244     return S_OK;
 245 }
 246
 247 static HRESULT WINAPI ThreadMgr_SetFocus( ITfThreadMgr* iface, ITfDocumentMgr *pdimFocus)
 248 {
 249     ITfDocumentMgr *check;
 250     ThreadMgr *This = (ThreadMgr *)iface;
 251
 252     TRACE("(%p) %p\n",This,pdimFocus);
 253
 254     if (!pdimFocus || FAILED(IUnknown_QueryInterface(pdimFocus,&IID_ITfDocumentMgr,(LPVOID*) &check)))
 255         return E_INVALIDARG;
 256
 257     ITfThreadMgrEventSink_OnSetFocus((ITfThreadMgrEventSink*)&This->ThreadMgrEventSinkVtbl, check, This->focus);
 258
 259     if (This->focus)
 260         ITfDocumentMgr_Release(This->focus);
 261
 262     This->focus = check;
 263     return S_OK;
 264 }
 265
 266 static HRESULT WINAPI ThreadMgr_AssociateFocus( ITfThreadMgr* iface, HWND hwnd,
 267 ITfDocumentMgr *pdimNew, ITfDocumentMgr **ppdimPrev)
 268 {
 269     ThreadMgr *This = (ThreadMgr *)iface;
 270     FIXME("STUB:(%p)\n",This);
 271     return E_NOTIMPL;
 272 }
 273
 274 static HRESULT WINAPI ThreadMgr_IsThreadFocus( ITfThreadMgr* iface, BOOL *pfThreadFocus)
 275 {
 276     ThreadMgr *This = (ThreadMgr *)iface;
 277     FIXME("STUB:(%p)\n",This);
 278     return E_NOTIMPL;
 279 }
 280
 281 static HRESULT WINAPI ThreadMgr_GetFunctionProvider( ITfThreadMgr* iface, REFCLSID clsid,
 282 ITfFunctionProvider **ppFuncProv)
 283 {
 284     ThreadMgr *This = (ThreadMgr *)iface;
 285     FIXME("STUB:(%p)\n",This);
 286     return E_NOTIMPL;
 287 }
 288
 289 static HRESULT WINAPI ThreadMgr_EnumFunctionProviders( ITfThreadMgr* iface,
 290 IEnumTfFunctionProviders **ppEnum)
 291 {
 292     ThreadMgr *This = (ThreadMgr *)iface;
 293     FIXME("STUB:(%p)\n",This);
 294     return E_NOTIMPL;
 295 }
 296
 297 static HRESULT WINAPI ThreadMgr_GetGlobalCompartment( ITfThreadMgr* iface,
 298 ITfCompartmentMgr **ppCompMgr)
 299 {
 300     ThreadMgr *This = (ThreadMgr *)iface;
 301     FIXME("STUB:(%p)\n",This);
 302     return E_NOTIMPL;
 303 }
 304
 305 static const ITfThreadMgrVtbl ThreadMgr_ThreadMgrVtbl =
 306 {
 307     ThreadMgr_QueryInterface,
 308     ThreadMgr_AddRef,
 309     ThreadMgr_Release,
 310
 311     ThreadMgr_fnActivate,
 312     ThreadMgr_fnDeactivate,
 313     ThreadMgr_CreateDocumentMgr,
 314     ThreadMgr_EnumDocumentMgrs,
 315     ThreadMgr_GetFocus,
 316     ThreadMgr_SetFocus,
 317     ThreadMgr_AssociateFocus,
 318     ThreadMgr_IsThreadFocus,
 319     ThreadMgr_GetFunctionProvider,
 320     ThreadMgr_EnumFunctionProviders,
 321     ThreadMgr_GetGlobalCompartment
 322 };
 323
 324
 325 static HRESULT WINAPI Source_QueryInterface(ITfSource *iface, REFIID iid, LPVOID *ppvOut)
 326 {
 327     ThreadMgr *This = impl_from_ITfSourceVtbl(iface);
 328     return ThreadMgr_QueryInterface((ITfThreadMgr *)This, iid, *ppvOut);
 329 }
 330
 331 static ULONG WINAPI Source_AddRef(ITfSource *iface)
 332 {
 333     ThreadMgr *This = impl_from_ITfSourceVtbl(iface);
 334     return ThreadMgr_AddRef((ITfThreadMgr*)This);
 335 }
 336
 337 static ULONG WINAPI Source_Release(ITfSource *iface)
 338 {
 339     ThreadMgr *This = impl_from_ITfSourceVtbl(iface);
 340     return ThreadMgr_Release((ITfThreadMgr *)This);
 341 }
 342
 343 /*****************************************************
 344  * ITfSource functions
 345  *****************************************************/
 346 static WINAPI HRESULT ThreadMgrSource_AdviseSink(ITfSource *iface,
 347         REFIID riid, IUnknown *punk, DWORD *pdwCookie)
 348 {
 349     ThreadMgrSink *tms;
 350     ThreadMgr *This = impl_from_ITfSourceVtbl(iface);
 351
 352     TRACE("(%p) %s %p %p\n",This,debugstr_guid(riid),punk,pdwCookie);
 353
 354     if (!riid || !punk || !pdwCookie)
 355         return E_INVALIDARG;
 356
 357     if (IsEqualIID(riid, &IID_ITfThreadMgrEventSink))
 358     {
 359         tms = HeapAlloc(GetProcessHeap(),0,sizeof(ThreadMgrSink));
 360         if (!tms)
 361             return E_OUTOFMEMORY;
 362         if (!SUCCEEDED(IUnknown_QueryInterface(punk, riid, (LPVOID*)&tms->interfaces.pITfThreadMgrEventSink)))
 363         {
 364             HeapFree(GetProcessHeap(),0,tms);
 365             return CONNECT_E_CANNOTCONNECT;
 366         }
 367         list_add_head(&This->ThreadMgrEventSink,&tms->entry);
 368         *pdwCookie = generate_Cookie(COOKIE_MAGIC_TMSINK, tms);
 369     }
 370     else
 371     {
 372         FIXME("(%p) Unhandled Sink: %s\n",This,debugstr_guid(riid));
 373         return E_NOTIMPL;
 374     }
 375
 376     TRACE("cookie %x\n",*pdwCookie);
 377
 378     return S_OK;
 379 }
 380
 381 static WINAPI HRESULT ThreadMgrSource_UnadviseSink(ITfSource *iface, DWORD pdwCookie)
 382 {
 383     ThreadMgrSink *sink;
 384     ThreadMgr *This = impl_from_ITfSourceVtbl(iface);
 385
 386     TRACE("(%p) %x\n",This,pdwCookie);
 387
 388     if (get_Cookie_magic(pdwCookie)!=COOKIE_MAGIC_TMSINK)
 389         return E_INVALIDARG;
 390
 391     sink = (ThreadMgrSink*)remove_Cookie(pdwCookie);
 392     if (!sink)
 393         return CONNECT_E_NOCONNECTION;
 394
 395     list_remove(&sink->entry);
 396     free_sink(sink);
 397
 398     return S_OK;
 399 }
 400
 401 static const ITfSourceVtbl ThreadMgr_SourceVtbl =
 402 {
 403     Source_QueryInterface,
 404     Source_AddRef,
 405     Source_Release,
 406
 407     ThreadMgrSource_AdviseSink,
 408     ThreadMgrSource_UnadviseSink,
 409 };
 410
 411 /*****************************************************
 412  * ITfThreadMgrEventSink functions  (internal)
 413  *****************************************************/
 414 static HRESULT WINAPI ThreadMgrEventSink_QueryInterface(ITfThreadMgrEventSink *iface, REFIID iid, LPVOID *ppvOut)
 415 {
 416     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 417     return ThreadMgr_QueryInterface((ITfThreadMgr *)This, iid, *ppvOut);
 418 }
 419
 420 static ULONG WINAPI ThreadMgrEventSink_AddRef(ITfThreadMgrEventSink *iface)
 421 {
 422     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 423     return ThreadMgr_AddRef((ITfThreadMgr*)This);
 424 }
 425
 426 static ULONG WINAPI ThreadMgrEventSink_Release(ITfThreadMgrEventSink *iface)
 427 {
 428     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 429     return ThreadMgr_Release((ITfThreadMgr *)This);
 430 }
 431
 432
 433 static WINAPI HRESULT ThreadMgrEventSink_OnInitDocumentMgr(
 434         ITfThreadMgrEventSink *iface,ITfDocumentMgr *pdim)
 435 {
 436     struct list *cursor;
 437     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 438
 439     TRACE("(%p) %p\n",This,pdim);
 440
 441     LIST_FOR_EACH(cursor, &This->ThreadMgrEventSink)
 442     {
 443         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 444         ITfThreadMgrEventSink_OnInitDocumentMgr(sink->interfaces.pITfThreadMgrEventSink,pdim);
 445     }
 446
 447     return S_OK;
 448 }
 449
 450 static WINAPI HRESULT ThreadMgrEventSink_OnUninitDocumentMgr(
 451         ITfThreadMgrEventSink *iface, ITfDocumentMgr *pdim)
 452 {
 453     struct list *cursor;
 454     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 455
 456     TRACE("(%p) %p\n",This,pdim);
 457
 458     LIST_FOR_EACH(cursor, &This->ThreadMgrEventSink)
 459     {
 460         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 461         ITfThreadMgrEventSink_OnUninitDocumentMgr(sink->interfaces.pITfThreadMgrEventSink,pdim);
 462     }
 463
 464     return S_OK;
 465 }
 466
 467 static WINAPI HRESULT ThreadMgrEventSink_OnSetFocus(
 468         ITfThreadMgrEventSink *iface, ITfDocumentMgr *pdimFocus,
 469         ITfDocumentMgr *pdimPrevFocus)
 470 {
 471     struct list *cursor;
 472     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 473
 474     TRACE("(%p) %p %p\n",This,pdimFocus, pdimPrevFocus);
 475
 476     LIST_FOR_EACH(cursor, &This->ThreadMgrEventSink)
 477     {
 478         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 479         ITfThreadMgrEventSink_OnSetFocus(sink->interfaces.pITfThreadMgrEventSink, pdimFocus, pdimPrevFocus);
 480     }
 481
 482     return S_OK;
 483 }
 484
 485 static WINAPI HRESULT ThreadMgrEventSink_OnPushContext(
 486         ITfThreadMgrEventSink *iface, ITfContext *pic)
 487 {
 488     struct list *cursor;
 489     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 490
 491     TRACE("(%p) %p\n",This,pic);
 492
 493     LIST_FOR_EACH(cursor, &This->ThreadMgrEventSink)
 494     {
 495         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 496         ITfThreadMgrEventSink_OnPushContext(sink->interfaces.pITfThreadMgrEventSink,pic);
 497     }
 498
 499     return S_OK;
 500 }
 501
 502 static WINAPI HRESULT ThreadMgrEventSink_OnPopContext(
 503         ITfThreadMgrEventSink *iface, ITfContext *pic)
 504 {
 505     struct list *cursor;
 506     ThreadMgr *This = impl_from_ITfThreadMgrEventSink(iface);
 507
 508     TRACE("(%p) %p\n",This,pic);
 509
 510     LIST_FOR_EACH(cursor, &This->ThreadMgrEventSink)
 511     {
 512         ThreadMgrSink* sink = LIST_ENTRY(cursor,ThreadMgrSink,entry);
 513         ITfThreadMgrEventSink_OnPopContext(sink->interfaces.pITfThreadMgrEventSink,pic);
 514     }
 515
 516     return S_OK;
 517 }
 518
 519 static const ITfThreadMgrEventSinkVtbl ThreadMgr_ThreadMgrEventSinkVtbl =
 520 {
 521     ThreadMgrEventSink_QueryInterface,
 522     ThreadMgrEventSink_AddRef,
 523     ThreadMgrEventSink_Release,
 524
 525     ThreadMgrEventSink_OnInitDocumentMgr,
 526     ThreadMgrEventSink_OnUninitDocumentMgr,
 527     ThreadMgrEventSink_OnSetFocus,
 528     ThreadMgrEventSink_OnPushContext,
 529     ThreadMgrEventSink_OnPopContext
 530 };
 531
 532 HRESULT ThreadMgr_Constructor(IUnknown *pUnkOuter, IUnknown **ppOut)
 533 {
 534     ThreadMgr *This;
 535     if (pUnkOuter)
 536         return CLASS_E_NOAGGREGATION;
 537
 538     /* Only 1 ThreadMgr is created per thread */
 539     This = TlsGetValue(tlsIndex);
 540     if (This)
 541     {
 542         ThreadMgr_AddRef((ITfThreadMgr*)This);
 543         *ppOut = (IUnknown*)This;
 544         return S_OK;
 545     }
 546
 547     This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(ThreadMgr));
 548     if (This == NULL)
 549         return E_OUTOFMEMORY;
 550
 551     This->ThreadMgrVtbl= &ThreadMgr_ThreadMgrVtbl;
 552     This->SourceVtbl = &ThreadMgr_SourceVtbl;
 553     This->ThreadMgrEventSinkVtbl = &ThreadMgr_ThreadMgrEventSinkVtbl;
 554     This->refCount = 1;
 555     TlsSetValue(tlsIndex,This);
 556
 557     list_init(&This->ActiveLanguageProfileNotifySink);
 558     list_init(&This->DisplayAttributeNotifySink);
 559     list_init(&This->KeyTraceEventSink);
 560     list_init(&This->PreservedKeyNotifySink);
 561     list_init(&This->ThreadFocusSink);
 562     list_init(&This->ThreadMgrEventSink);
 563
 564     TRACE("returning %p\n", This);
 565     *ppOut = (IUnknown *)This;
 566     return S_OK;
 567 }