documentmgr.c File Reference

#include <stdarg.h>
#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 "msctf.h"
#include "msctf_internal.h"

Include dependency graph for documentmgr.c:

Go to the source code of this file.

Classes
struct	tagDocumentMgr
struct	tagEnumTfContext

Macros
#define	COBJMACROS

Typedefs
typedef struct tagDocumentMgr	DocumentMgr
typedef struct tagEnumTfContext	EnumTfContext

Functions
	WINE_DEFAULT_DEBUG_CHANNEL (msctf)
static HRESULT	EnumTfContext_Constructor (DocumentMgr *mgr, IEnumTfContexts **ppOut)
static DocumentMgr *	impl_from_ITfDocumentMgr (ITfDocumentMgr *iface)
static DocumentMgr *	impl_from_ITfSource (ITfSource *iface)
static EnumTfContext *	impl_from_IEnumTfContexts (IEnumTfContexts *iface)
static void	DocumentMgr_Destructor (DocumentMgr *This)
static HRESULT WINAPI	DocumentMgr_QueryInterface (ITfDocumentMgr *iface, REFIID iid, LPVOID *ppvOut)
static ULONG WINAPI	DocumentMgr_AddRef (ITfDocumentMgr *iface)
static ULONG WINAPI	DocumentMgr_Release (ITfDocumentMgr *iface)
static HRESULT WINAPI	DocumentMgr_CreateContext (ITfDocumentMgr *iface, TfClientId tidOwner, DWORD dwFlags, IUnknown *punk, ITfContext **ppic, TfEditCookie *pecTextStore)
static HRESULT WINAPI	DocumentMgr_Push (ITfDocumentMgr *iface, ITfContext *pic)
static HRESULT WINAPI	DocumentMgr_Pop (ITfDocumentMgr *iface, DWORD dwFlags)
static HRESULT WINAPI	DocumentMgr_GetTop (ITfDocumentMgr *iface, ITfContext **ppic)
static HRESULT WINAPI	DocumentMgr_GetBase (ITfDocumentMgr *iface, ITfContext **ppic)
static HRESULT WINAPI	DocumentMgr_EnumContexts (ITfDocumentMgr *iface, IEnumTfContexts **ppEnum)
static HRESULT WINAPI	DocumentMgrSource_QueryInterface (ITfSource *iface, REFIID iid, LPVOID *ppvOut)
static ULONG WINAPI	DocumentMgrSource_AddRef (ITfSource *iface)
static ULONG WINAPI	DocumentMgrSource_Release (ITfSource *iface)
static HRESULT WINAPI	DocumentMgrSource_AdviseSink (ITfSource *iface, REFIID riid, IUnknown *punk, DWORD *pdwCookie)
static HRESULT WINAPI	DocumentMgrSource_UnadviseSink (ITfSource *iface, DWORD pdwCookie)
HRESULT	DocumentMgr_Constructor (ITfThreadMgrEventSink *ThreadMgrSink, ITfDocumentMgr **ppOut)
static void	EnumTfContext_Destructor (EnumTfContext *This)
static HRESULT WINAPI	EnumTfContext_QueryInterface (IEnumTfContexts *iface, REFIID iid, LPVOID *ppvOut)
static ULONG WINAPI	EnumTfContext_AddRef (IEnumTfContexts *iface)
static ULONG WINAPI	EnumTfContext_Release (IEnumTfContexts *iface)
static HRESULT WINAPI	EnumTfContext_Next (IEnumTfContexts *iface, ULONG ulCount, ITfContext **rgContext, ULONG *pcFetched)
static HRESULT WINAPI	EnumTfContext_Skip (IEnumTfContexts *iface, ULONG celt)
static HRESULT WINAPI	EnumTfContext_Reset (IEnumTfContexts *iface)
static HRESULT WINAPI	EnumTfContext_Clone (IEnumTfContexts *iface, IEnumTfContexts **ppenum)

Variables
static const ITfDocumentMgrVtbl	DocumentMgrVtbl
static const ITfSourceVtbl	DocumentMgrSourceVtbl
static const IEnumTfContextsVtbl	IEnumTfContexts_Vtbl

Macro Definition Documentation

COBJMACROS

#define COBJMACROS

Definition at line 23 of file documentmgr.c.

Typedef Documentation

DocumentMgr

typedef struct tagDocumentMgr DocumentMgr

EnumTfContext

typedef struct tagEnumTfContext EnumTfContext

Function Documentation

DocumentMgr_AddRef()

static ULONG WINAPI DocumentMgr_AddRef ( ITfDocumentMgr *  iface )

static

Definition at line 127 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    return InterlockedIncrement(&This->refCount);
}

DocumentMgr_Constructor()

HRESULT DocumentMgr_Constructor	(	ITfThreadMgrEventSink *	ThreadMgrSink,
		ITfDocumentMgr **	ppOut
	)

Definition at line 342 of file documentmgr.c.

{
    DocumentMgr *This;
 
    This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(DocumentMgr));
    if (This == NULL)
        return E_OUTOFMEMORY;
 
    This->ITfDocumentMgr_iface.lpVtbl = &DocumentMgrVtbl;
    This->ITfSource_iface.lpVtbl = &DocumentMgrSourceVtbl;
    This->refCount = 1;
    This->ThreadMgrSink = ThreadMgrSink;
    list_init(&This->TransitoryExtensionSink);
 
    CompartmentMgr_Constructor((IUnknown*)&This->ITfDocumentMgr_iface, &IID_IUnknown, (IUnknown**)&This->CompartmentMgr);
 
    *ppOut = &This->ITfDocumentMgr_iface;
    TRACE("returning %p\n", *ppOut);
    return S_OK;
}

Referenced by ThreadMgr_CreateDocumentMgr().

DocumentMgr_CreateContext()

static HRESULT WINAPI DocumentMgr_CreateContext ( ITfDocumentMgr *  iface, TfClientId  tidOwner, DWORD  dwFlags, IUnknown *  punk, ITfContext **  ppic, TfEditCookie *  pecTextStore  )

static

Definition at line 147 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    TRACE("(%p) 0x%x 0x%x %p %p %p\n",This,tidOwner,dwFlags,punk,ppic,pecTextStore);
    return Context_Constructor(tidOwner, punk, iface, ppic, pecTextStore);
}

DocumentMgr_Destructor()

static void DocumentMgr_Destructor ( DocumentMgr *  This )

static

Definition at line 78 of file documentmgr.c.

{
    ITfThreadMgr *tm = NULL;
    TRACE("destroying %p\n", This);
 
    TF_GetThreadMgr(&tm);
    if (tm)
    {
        ThreadMgr_OnDocumentMgrDestruction(tm, &This->ITfDocumentMgr_iface);
        ITfThreadMgr_Release(tm);
    }
 
    if (This->contextStack[0])
        ITfContext_Release(This->contextStack[0]);
    if (This->contextStack[1])
        ITfContext_Release(This->contextStack[1]);
    free_sinks(&This->TransitoryExtensionSink);
    CompartmentMgr_Destructor(This->CompartmentMgr);
    HeapFree(GetProcessHeap(),0,This);
}

Referenced by DocumentMgr_Release().

DocumentMgr_EnumContexts()

static HRESULT WINAPI DocumentMgr_EnumContexts ( ITfDocumentMgr *  iface, IEnumTfContexts **  ppEnum  )

static

Definition at line 259 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    TRACE("(%p) %p\n",This,ppEnum);
    return EnumTfContext_Constructor(This, ppEnum);
}

DocumentMgr_GetBase()

static HRESULT WINAPI DocumentMgr_GetBase ( ITfDocumentMgr *  iface, ITfContext **  ppic  )

static

Definition at line 237 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    ITfContext *tgt;
 
    TRACE("(%p)\n",This);
    if (!ppic)
        return E_INVALIDARG;
 
    if (This->contextStack[1])
        tgt = This->contextStack[1];
    else
        tgt = This->contextStack[0];
 
    if (tgt)
        ITfContext_AddRef(tgt);
 
    *ppic = tgt;
 
    return S_OK;
}

DocumentMgr_GetTop()

static HRESULT WINAPI DocumentMgr_GetTop ( ITfDocumentMgr *  iface, ITfContext **  ppic  )

static

Definition at line 222 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    TRACE("(%p)\n",This);
    if (!ppic)
        return E_INVALIDARG;
 
    if (This->contextStack[0])
        ITfContext_AddRef(This->contextStack[0]);
 
    *ppic = This->contextStack[0];
 
    return S_OK;
}

DocumentMgr_Pop()

static HRESULT WINAPI DocumentMgr_Pop ( ITfDocumentMgr *  iface, DWORD  dwFlags  )

static

Definition at line 182 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    TRACE("(%p) 0x%x\n",This,dwFlags);
 
    if (dwFlags == TF_POPF_ALL)
    {
        int i;
 
        for (i = 0; i < ARRAY_SIZE(This->contextStack); i++)
            if (This->contextStack[i])
            {
                ITfThreadMgrEventSink_OnPopContext(This->ThreadMgrSink, This->contextStack[i]);
                Context_Uninitialize(This->contextStack[i]);
                ITfContext_Release(This->contextStack[i]);
                This->contextStack[i] = NULL;
            }
 
        ITfThreadMgrEventSink_OnUninitDocumentMgr(This->ThreadMgrSink, iface);
        return S_OK;
    }
 
    if (dwFlags)
        return E_INVALIDARG;
 
    if (This->contextStack[1] == NULL) /* Cannot pop last context */
        return E_FAIL;
 
    ITfThreadMgrEventSink_OnPopContext(This->ThreadMgrSink,This->contextStack[0]);
    Context_Uninitialize(This->contextStack[0]);
    ITfContext_Release(This->contextStack[0]);
    This->contextStack[0] = This->contextStack[1];
    This->contextStack[1] = NULL;
 
    if (This->contextStack[0] == NULL)
        ITfThreadMgrEventSink_OnUninitDocumentMgr(This->ThreadMgrSink, iface);
 
    return S_OK;
}

DocumentMgr_Push()

static HRESULT WINAPI DocumentMgr_Push ( ITfDocumentMgr *  iface, ITfContext *  pic  )

static

Definition at line 157 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    ITfContext *check;
 
    TRACE("(%p) %p\n",This,pic);
 
    if (This->contextStack[1])  /* FUll */
        return TF_E_STACKFULL;
 
    if (!pic || FAILED(ITfContext_QueryInterface(pic,&IID_ITfContext,(LPVOID*) &check)))
        return E_INVALIDARG;
 
    if (This->contextStack[0] == NULL)
        ITfThreadMgrEventSink_OnInitDocumentMgr(This->ThreadMgrSink,iface);
 
    This->contextStack[1] = This->contextStack[0];
    This->contextStack[0] = check;
 
    Context_Initialize(check, iface);
    ITfThreadMgrEventSink_OnPushContext(This->ThreadMgrSink,check);
 
    return S_OK;
}

DocumentMgr_QueryInterface()

static HRESULT WINAPI DocumentMgr_QueryInterface ( ITfDocumentMgr *  iface, REFIID  iid, LPVOID *  ppvOut  )

static

Definition at line 99 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    *ppvOut = NULL;
 
    if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_ITfDocumentMgr))
    {
        *ppvOut = &This->ITfDocumentMgr_iface;
    }
    else if (IsEqualIID(iid, &IID_ITfSource))
    {
        *ppvOut = &This->ITfSource_iface;
    }
    else if (IsEqualIID(iid, &IID_ITfCompartmentMgr))
    {
        *ppvOut = This->CompartmentMgr;
    }
 
    if (*ppvOut)
    {
        ITfDocumentMgr_AddRef(iface);
        return S_OK;
    }
 
    WARN("unsupported interface: %s\n", debugstr_guid(iid));
    return E_NOINTERFACE;
}

DocumentMgr_Release()

static ULONG WINAPI DocumentMgr_Release ( ITfDocumentMgr *  iface )

static

Definition at line 133 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfDocumentMgr(iface);
    ULONG ret;
 
    ret = InterlockedDecrement(&This->refCount);
    if (ret == 0)
        DocumentMgr_Destructor(This);
    return ret;
}

DocumentMgrSource_AddRef()

static ULONG WINAPI DocumentMgrSource_AddRef ( ITfSource *  iface )

static

Definition at line 285 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfSource(iface);
    return ITfDocumentMgr_AddRef(&This->ITfDocumentMgr_iface);
}

DocumentMgrSource_AdviseSink()

static HRESULT WINAPI DocumentMgrSource_AdviseSink ( ITfSource *  iface, REFIID  riid, IUnknown *  punk, DWORD *  pdwCookie  )

static

Definition at line 300 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfSource(iface);
 
    TRACE("(%p) %s %p %p\n", This, debugstr_guid(riid), punk, pdwCookie);
 
    if (!riid || !punk || !pdwCookie)
        return E_INVALIDARG;
 
    if (IsEqualIID(riid, &IID_ITfTransitoryExtensionSink))
    {
        WARN("semi-stub for ITfTransitoryExtensionSink: callback won't be used.\n");
        return advise_sink(&This->TransitoryExtensionSink, &IID_ITfTransitoryExtensionSink,
                           COOKIE_MAGIC_DMSINK, punk, pdwCookie);
    }
 
    FIXME("(%p) Unhandled Sink: %s\n",This,debugstr_guid(riid));
    return E_NOTIMPL;
}

DocumentMgrSource_QueryInterface()

static HRESULT WINAPI DocumentMgrSource_QueryInterface ( ITfSource *  iface, REFIID  iid, LPVOID *  ppvOut  )

static

Definition at line 279 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfSource(iface);
    return ITfDocumentMgr_QueryInterface(&This->ITfDocumentMgr_iface, iid, ppvOut);
}

DocumentMgrSource_Release()

static ULONG WINAPI DocumentMgrSource_Release ( ITfSource *  iface )

static

Definition at line 291 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfSource(iface);
    return ITfDocumentMgr_Release(&This->ITfDocumentMgr_iface);
}

DocumentMgrSource_UnadviseSink()

static HRESULT WINAPI DocumentMgrSource_UnadviseSink ( ITfSource *  iface, DWORD  pdwCookie  )

static

Definition at line 321 of file documentmgr.c.

{
    DocumentMgr *This = impl_from_ITfSource(iface);
 
    TRACE("(%p) %x\n",This,pdwCookie);
 
    if (get_Cookie_magic(pdwCookie)!=COOKIE_MAGIC_DMSINK)
        return E_INVALIDARG;
 
    return unadvise_sink(pdwCookie);
}

EnumTfContext_AddRef()

static ULONG WINAPI EnumTfContext_AddRef ( IEnumTfContexts *  iface )

static

Definition at line 392 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    return InterlockedIncrement(&This->refCount);
}

EnumTfContext_Clone()

static HRESULT WINAPI EnumTfContext_Clone ( IEnumTfContexts *  iface, IEnumTfContexts **  ppenum  )

static

Definition at line 455 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    HRESULT res;
 
    TRACE("(%p)\n",This);
 
    if (ppenum == NULL) return E_POINTER;
 
    res = EnumTfContext_Constructor(This->docmgr, ppenum);
    if (SUCCEEDED(res))
    {
        EnumTfContext *new_This = impl_from_IEnumTfContexts(*ppenum);
        new_This->index = This->index;
    }
    return res;
}

EnumTfContext_Constructor()

static HRESULT EnumTfContext_Constructor ( DocumentMgr *  mgr, IEnumTfContexts **  ppOut  )

static

Definition at line 485 of file documentmgr.c.

{
    EnumTfContext *This;
 
    This = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(EnumTfContext));
    if (This == NULL)
        return E_OUTOFMEMORY;
 
    This->IEnumTfContexts_iface.lpVtbl = &IEnumTfContexts_Vtbl;
    This->refCount = 1;
    This->docmgr = mgr;
 
    *ppOut = &This->IEnumTfContexts_iface;
    TRACE("returning %p\n", *ppOut);
    return S_OK;
}

Referenced by DocumentMgr_EnumContexts(), and EnumTfContext_Clone().

EnumTfContext_Destructor()

static void EnumTfContext_Destructor ( EnumTfContext *  This )

static

Definition at line 366 of file documentmgr.c.

{
    TRACE("destroying %p\n", This);
    HeapFree(GetProcessHeap(),0,This);
}

Referenced by EnumTfContext_Release().

EnumTfContext_Next()

static HRESULT WINAPI EnumTfContext_Next ( IEnumTfContexts *  iface, ULONG  ulCount, ITfContext **  rgContext, ULONG *  pcFetched  )

static

Definition at line 409 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    ULONG fetched = 0;
 
    TRACE("(%p)\n",This);
 
    if (rgContext == NULL) return E_POINTER;
 
    while (fetched < ulCount)
    {
        if (This->index > 1)
            break;
 
        if (!This->docmgr->contextStack[This->index])
            break;
 
        *rgContext = This->docmgr->contextStack[This->index];
        ITfContext_AddRef(*rgContext);
 
        ++This->index;
        ++fetched;
        ++rgContext;
    }
 
    if (pcFetched) *pcFetched = fetched;
    return fetched == ulCount ? S_OK : S_FALSE;
}

EnumTfContext_QueryInterface()

static HRESULT WINAPI EnumTfContext_QueryInterface ( IEnumTfContexts *  iface, REFIID  iid, LPVOID *  ppvOut  )

static

Definition at line 372 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    *ppvOut = NULL;
 
    if (IsEqualIID(iid, &IID_IUnknown) || IsEqualIID(iid, &IID_IEnumTfContexts))
    {
        *ppvOut = &This->IEnumTfContexts_iface;
    }
 
    if (*ppvOut)
    {
        IEnumTfContexts_AddRef(iface);
        return S_OK;
    }
 
    WARN("unsupported interface: %s\n", debugstr_guid(iid));
    return E_NOINTERFACE;
}

EnumTfContext_Release()

static ULONG WINAPI EnumTfContext_Release ( IEnumTfContexts *  iface )

static

Definition at line 398 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    ULONG ret;
 
    ret = InterlockedDecrement(&This->refCount);
    if (ret == 0)
        EnumTfContext_Destructor(This);
    return ret;
}

EnumTfContext_Reset()

static HRESULT WINAPI EnumTfContext_Reset ( IEnumTfContexts *  iface )

static

Definition at line 447 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    TRACE("(%p)\n",This);
    This->index = 0;
    return S_OK;
}

EnumTfContext_Skip()

static HRESULT WINAPI EnumTfContext_Skip ( IEnumTfContexts *  iface, ULONG  celt  )

static

Definition at line 439 of file documentmgr.c.

{
    EnumTfContext *This = impl_from_IEnumTfContexts(iface);
    TRACE("(%p)\n",This);
    This->index += celt;
    return S_OK;
}

impl_from_IEnumTfContexts()

static EnumTfContext * impl_from_IEnumTfContexts ( IEnumTfContexts *  iface )

inlinestatic

Definition at line 73 of file documentmgr.c.

{
    return CONTAINING_RECORD(iface, EnumTfContext, IEnumTfContexts_iface);
}

Referenced by EnumTfContext_AddRef(), EnumTfContext_Clone(), EnumTfContext_Next(), EnumTfContext_QueryInterface(), EnumTfContext_Release(), EnumTfContext_Reset(), and EnumTfContext_Skip().

impl_from_ITfDocumentMgr()

static DocumentMgr * impl_from_ITfDocumentMgr ( ITfDocumentMgr *  iface )

inlinestatic

Definition at line 63 of file documentmgr.c.

{
    return CONTAINING_RECORD(iface, DocumentMgr, ITfDocumentMgr_iface);
}

Referenced by DocumentMgr_AddRef(), DocumentMgr_CreateContext(), DocumentMgr_EnumContexts(), DocumentMgr_GetBase(), DocumentMgr_GetTop(), DocumentMgr_Pop(), DocumentMgr_Push(), DocumentMgr_QueryInterface(), and DocumentMgr_Release().

impl_from_ITfSource()

static DocumentMgr * impl_from_ITfSource ( ITfSource *  iface )

inlinestatic

Definition at line 68 of file documentmgr.c.

{
    return CONTAINING_RECORD(iface, DocumentMgr, ITfSource_iface);
}

Referenced by DocumentMgrSource_AddRef(), DocumentMgrSource_AdviseSink(), DocumentMgrSource_QueryInterface(), DocumentMgrSource_Release(), and DocumentMgrSource_UnadviseSink().

WINE_DEFAULT_DEBUG_CHANNEL()

WINE_DEFAULT_DEBUG_CHANNEL

(

msctf

)

Variable Documentation

DocumentMgrSourceVtbl

const ITfSourceVtbl DocumentMgrSourceVtbl

static

Initial value:

=
{
    DocumentMgrSource_QueryInterface,
    DocumentMgrSource_AddRef,
    DocumentMgrSource_Release,
    DocumentMgrSource_AdviseSink,
    DocumentMgrSource_UnadviseSink,
}

Definition at line 333 of file documentmgr.c.

Referenced by DocumentMgr_Constructor().

DocumentMgrVtbl

const ITfDocumentMgrVtbl DocumentMgrVtbl

static

Initial value:

=
{
    DocumentMgr_QueryInterface,
    DocumentMgr_AddRef,
    DocumentMgr_Release,
    DocumentMgr_CreateContext,
    DocumentMgr_Push,
    DocumentMgr_Pop,
    DocumentMgr_GetTop,
    DocumentMgr_GetBase,
    DocumentMgr_EnumContexts
}

Definition at line 266 of file documentmgr.c.

Referenced by DocumentMgr_Constructor().

IEnumTfContexts_Vtbl

const IEnumTfContextsVtbl IEnumTfContexts_Vtbl

static

Initial value:

={
    EnumTfContext_QueryInterface,
    EnumTfContext_AddRef,
    EnumTfContext_Release,
 
    EnumTfContext_Clone,
    EnumTfContext_Next,
    EnumTfContext_Reset,
    EnumTfContext_Skip
}

Definition at line 474 of file documentmgr.c.

Referenced by EnumTfContext_Constructor().