CDocumentMgr Class Reference

#include <documentmgr.h>

Inheritance diagram for CDocumentMgr:

Collaboration diagram for CDocumentMgr:

Public Member Functions
	CDocumentMgr (ITfThreadMgrEventSink *threadMgrSink)
virtual	~CDocumentMgr ()
STDMETHODIMP	QueryInterface (REFIID iid, LPVOID *ppvObject) override
	STDMETHODIMP_ (ULONG) AddRef() override
	STDMETHODIMP_ (ULONG) Release() override
STDMETHODIMP	CreateContext (TfClientId tidOwner, DWORD dwFlags, IUnknown *punk, ITfContext **ppic, TfEditCookie *pecTextStore) override
STDMETHODIMP	Push (ITfContext *pic) override
STDMETHODIMP	Pop (DWORD dwFlags) override
STDMETHODIMP	GetTop (ITfContext **ppic) override
STDMETHODIMP	GetBase (ITfContext **ppic) override
STDMETHODIMP	EnumContexts (IEnumTfContexts **ppEnum) override
STDMETHODIMP	AdviseSink (REFIID riid, IUnknown *punk, DWORD *pdwCookie) override
STDMETHODIMP	UnadviseSink (DWORD pdwCookie) override
HRESULT	CreateContext ([in] TfClientId tidOwner, [in] DWORD dwFlags, [in, unique] IUnknown *punk, [out] ITfContext **ppic, [out] TfEditCookie *pecTextStore)
HRESULT	Push ([in] ITfContext *pic)
HRESULT	Pop ([in] DWORD dwFlags)
HRESULT	GetTop ([out] ITfContext **ppic)
HRESULT	GetBase ([out] ITfContext **ppic)
HRESULT	EnumContexts ([out] IEnumTfContexts **ppEnum)
Public Member Functions inherited from IUnknown
HRESULT	QueryInterface ([in] REFIID riid, [out, iid_is(riid)] void **ppvObject)
ULONG	AddRef ()
ULONG	Release ()
HRESULT	AdviseSink ([in] REFIID riid, [in, iid_is(riid)] IUnknown *punk, [out] DWORD *pdwCookie)
HRESULT	UnadviseSink ([in] DWORD dwCookie)

Static Public Member Functions
static HRESULT	CreateInstance (_In_ ITfThreadMgrEventSink *pThreadMgrSink, _Out_ ITfDocumentMgr **ppOut)

Protected Attributes
LONG	m_cRefs
ITfCompartmentMgr *	m_pCompartmentMgr
ITfContext *	m_initialContext
ITfContext *	m_contextStack [2]
ITfThreadMgrEventSink *	m_pThreadMgrSink
struct list	m_transitoryExtensionSink

Friends
class	CEnumTfContext

Additional Inherited Members
Public Types inherited from IUnknown
typedef IUnknown *	LPUNKNOWN
Public Attributes inherited from ITfDocumentMgr
const DWORD	TF_POPF_ALL = 0x0001

Detailed Description

Definition at line 14 of file documentmgr.h.

Constructor & Destructor Documentation

CDocumentMgr()

CDocumentMgr::CDocumentMgr

(

ITfThreadMgrEventSink *

threadMgrSink

)

Definition at line 17 of file documentmgr.cpp.

    : m_cRefs(1)
    , m_pCompartmentMgr(NULL)
    , m_initialContext(NULL)
    , m_pThreadMgrSink(threadMgrSink)
{
    m_contextStack[1] = m_contextStack[0] = NULL;
 
    list_init(&m_transitoryExtensionSink);
 
    ITfDocumentMgr *pDocMgr = static_cast<ITfDocumentMgr *>(this);
    ITfCompartmentMgr **ppCompMgr = static_cast<ITfCompartmentMgr **>(&m_pCompartmentMgr);
    CompartmentMgr_Constructor(pDocMgr, IID_IUnknown, reinterpret_cast<IUnknown **>(ppCompMgr));
 
    DWORD cookie;
    Context_Constructor(g_processId, NULL, pDocMgr, &m_initialContext, &cookie);
}

~CDocumentMgr()

CDocumentMgr::~CDocumentMgr ( )

virtual

Definition at line 35 of file documentmgr.cpp.

{
    TRACE("destroying %p\n", this);
 
    ITfThreadMgr *tm = NULL;
    TF_GetThreadMgr(&tm);
    if (tm)
    {
        ThreadMgr_OnDocumentMgrDestruction(tm, static_cast<ITfDocumentMgr*>(this));
        tm->Release();
    }
 
    if (m_initialContext)
        m_initialContext->Release();
    if (m_contextStack[0])
        m_contextStack[0]->Release();
    if (m_contextStack[1])
        m_contextStack[1]->Release();
 
    free_sinks(&m_transitoryExtensionSink);
 
    if (m_pCompartmentMgr)
    {
        m_pCompartmentMgr->Release();
        m_pCompartmentMgr = NULL;
    }
}

Member Function Documentation

AdviseSink()

STDMETHODIMP CDocumentMgr::AdviseSink ( REFIID  riid, IUnknown *  punk, DWORD *  pdwCookie  )

override

Implements ITfSource.

Definition at line 281 of file documentmgr.cpp.

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

CreateContext()

STDMETHODIMP CDocumentMgr::CreateContext ( TfClientId  tidOwner, DWORD  dwFlags, IUnknown *  punk, ITfContext **  ppic, TfEditCookie *  pecTextStore  )

override

Implements ITfDocumentMgr.

Definition at line 132 of file documentmgr.cpp.

{
    TRACE("%p -> (%d, 0x%lX, %p, %p, %p)\n", this, tidOwner, dwFlags, punk, ppic, pecTextStore);
    return Context_Constructor(tidOwner, punk, this, ppic, pecTextStore);
}

CreateInstance()

HRESULT CDocumentMgr::CreateInstance ( _In_ ITfThreadMgrEventSink *  pThreadMgrSink, _Out_ ITfDocumentMgr **  ppOut  )

static

Definition at line 64 of file documentmgr.cpp.

{
    if (!ppOut)
    {
        ERR("!ppOut\n");
        return E_POINTER;
    }
 
    if (!pThreadMgrSink)
    {
        ERR("!pThreadMgrSink\n");
        return E_INVALIDARG;
    }
 
    CDocumentMgr *This = new(cicNoThrow) CDocumentMgr(pThreadMgrSink);
    if (!This)
    {
        ERR("E_OUTOFMEMORY\n");
        return E_OUTOFMEMORY;
    }
 
    *ppOut = static_cast<ITfDocumentMgr *>(This);
    TRACE("returning %p\n", *ppOut);
    return S_OK;
}

Referenced by DocumentMgr_Constructor().

EnumContexts()

STDMETHODIMP CDocumentMgr::EnumContexts ( IEnumTfContexts **  ppEnum )

override

Implements ITfDocumentMgr.

Definition at line 275 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, ppEnum);
    return EnumTfContext_Constructor(this, ppEnum);
}

GetBase()

STDMETHODIMP CDocumentMgr::GetBase ( ITfContext **  ppic )

override

Implements ITfDocumentMgr.

Definition at line 250 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, ppic);
 
    if (!ppic)
    {
        ERR("!ppic\n");
        return E_INVALIDARG;
    }
 
    ITfContext *target;
    if (m_contextStack[1])
        target = m_contextStack[1];
    else if (m_contextStack[0])
        target = m_contextStack[0];
    else
        target = m_initialContext;
 
    if (target)
        target->AddRef();
 
    *ppic = target;
    return S_OK;
}

GetTop()

STDMETHODIMP CDocumentMgr::GetTop ( ITfContext **  ppic )

override

Implements ITfDocumentMgr.

Definition at line 227 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, ppic);
 
    if (!ppic)
    {
        ERR("!ppic\n");
        return E_INVALIDARG;
    }
 
    ITfContext *target;
    if (m_contextStack[0])
        target = m_contextStack[0];
    else
        target = m_initialContext;
 
    if (target)
        target->AddRef();
 
    *ppic = target;
    return S_OK;
}

Pop()

STDMETHODIMP CDocumentMgr::Pop ( DWORD  dwFlags )

override

Implements ITfDocumentMgr.

Definition at line 179 of file documentmgr.cpp.

{
    TRACE("%p -> (0x%lX)\n", this, dwFlags);
 
    if (dwFlags == TF_POPF_ALL)
    {
        for (SIZE_T i = 0; i < _countof(m_contextStack); i++)
        {
            if (!m_contextStack[i])
                continue;
 
            m_pThreadMgrSink->OnPopContext(m_contextStack[i]);
            Context_Uninitialize(m_contextStack[i]);
            m_contextStack[i]->Release();
            m_contextStack[i] = NULL;
        }
 
        m_pThreadMgrSink->OnUninitDocumentMgr(this);
        return S_OK;
    }
 
    if (dwFlags)
    {
        ERR("E_INVALIDARG: 0x%lX\n", dwFlags);
        return E_INVALIDARG;
    }
 
    if (!m_contextStack[1]) // Cannot pop last context
    {
        ERR("!m_contextStack[1]\n");
        return E_FAIL;
    }
 
    m_pThreadMgrSink->OnPopContext(m_contextStack[0]);
    Context_Uninitialize(m_contextStack[0]);
 
    if (m_contextStack[0])
        m_contextStack[0]->Release();
 
    m_contextStack[0] = m_contextStack[1];
    m_contextStack[1] = NULL;
 
    if (!m_contextStack[0])
        m_pThreadMgrSink->OnUninitDocumentMgr(this);
 
    return S_OK;
}

Push()

STDMETHODIMP CDocumentMgr::Push ( ITfContext *  pic )

override

Implements ITfDocumentMgr.

Definition at line 143 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, pic);
 
    if (m_contextStack[1]) /* Full */
    {
        ERR("TF_E_STACKFULL\n");
        return TF_E_STACKFULL;
    }
 
    if (!pic)
    {
        ERR("!pic\n");
        return E_INVALIDARG;
    }
 
    ITfContext *check;
    HRESULT hr = pic->QueryInterface(IID_ITfContext, reinterpret_cast<LPVOID *>(&check));
    if (FAILED(hr))
    {
        ERR("hr: 0x%lX\n", hr);
        return E_INVALIDARG;
    }
 
    if (!m_contextStack[0])
        m_pThreadMgrSink->OnInitDocumentMgr(this);
 
    m_contextStack[1] = m_contextStack[0];
    m_contextStack[0] = check;
 
    Context_Initialize(check, this);
    m_pThreadMgrSink->OnPushContext(check);
 
    return S_OK;
}

QueryInterface()

STDMETHODIMP CDocumentMgr::QueryInterface ( REFIID  iid, LPVOID *  ppvObject  )

override

Definition at line 92 of file documentmgr.cpp.

{
    TRACE("%p -> (%s, %p)\n", this, wine_dbgstr_guid(&iid), ppvObject);
    *ppvObject = NULL;
 
    IUnknown *pUnk = NULL;
    if (iid == IID_IUnknown || iid == IID_ITfDocumentMgr)
        pUnk = static_cast<ITfDocumentMgr *>(this);
    else if (iid == IID_ITfSource)
        pUnk = static_cast<ITfSource *>(this);
    else if (iid == IID_ITfCompartmentMgr)
        pUnk = m_pCompartmentMgr;
 
    if (pUnk)
    {
        pUnk->AddRef();
        *ppvObject = pUnk;
        return S_OK;
    }
 
    WARN("unsupported interface: %s\n", debugstr_guid(&iid));
    return E_NOINTERFACE;
}

STDMETHODIMP_() [1/2]

CDocumentMgr::STDMETHODIMP_ ( ULONG  )

override

STDMETHODIMP_() [2/2]

CDocumentMgr::STDMETHODIMP_ ( ULONG  )

override

UnadviseSink()

STDMETHODIMP CDocumentMgr::UnadviseSink ( DWORD  pdwCookie )

override

Implements ITfSource.

Definition at line 299 of file documentmgr.cpp.

{
    TRACE("%p -> (%p)\n", this, pdwCookie);
 
    if (get_Cookie_magic(pdwCookie) != COOKIE_MAGIC_DMSINK)
        return E_INVALIDARG;
 
    return unadvise_sink(pdwCookie);
}

Friends And Related Function Documentation

CEnumTfContext

friend class CEnumTfContext

friend

Definition at line 49 of file documentmgr.h.

Member Data Documentation

m_contextStack

ITfContext* CDocumentMgr::m_contextStack[2]

protected

Definition at line 55 of file documentmgr.h.

Referenced by CDocumentMgr(), GetBase(), GetTop(), CEnumTfContext::Next(), Pop(), Push(), and ~CDocumentMgr().

m_cRefs

LONG CDocumentMgr::m_cRefs

protected

Definition at line 52 of file documentmgr.h.

Referenced by STDMETHODIMP_().

m_initialContext

ITfContext* CDocumentMgr::m_initialContext

protected

Definition at line 54 of file documentmgr.h.

Referenced by CDocumentMgr(), GetBase(), GetTop(), and ~CDocumentMgr().

m_pCompartmentMgr

ITfCompartmentMgr* CDocumentMgr::m_pCompartmentMgr

protected

Definition at line 53 of file documentmgr.h.

Referenced by CDocumentMgr(), QueryInterface(), and ~CDocumentMgr().

m_pThreadMgrSink

ITfThreadMgrEventSink* CDocumentMgr::m_pThreadMgrSink

protected

Definition at line 56 of file documentmgr.h.

Referenced by Pop(), and Push().

m_transitoryExtensionSink

struct list CDocumentMgr::m_transitoryExtensionSink

protected

Definition at line 57 of file documentmgr.h.

Referenced by AdviseSink(), CDocumentMgr(), and ~CDocumentMgr().

---

The documentation for this class was generated from the following files:

• base/ctf/msctf/documentmgr.h
• base/ctf/msctf/documentmgr.cpp