inputcontext.h

Go to the documentation of this file.

/*
 * PROJECT:     ReactOS msctfime.ime
 * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
 * PURPOSE:     Input Context of msctfime.ime
 * COPYRIGHT:   Copyright 2024 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
 */
 
#pragma once
 
#include "sinks.h"
#include "misc.h"
 
class CInputContextOwnerCallBack;
class CInputContextOwner;
class CicInputContext;
 
 
typedef HRESULT (CALLBACK *FN_IC_OWNER_CALLBACK)(UINT uType, LPVOID args, LPVOID param);
 
/***********************************************************************
 *      CInputContextOwner
 */
class CInputContextOwner
    : public ITfContextOwner
    , public ITfMouseTrackerACP
{
protected:
    LONG m_cRefs;
    IUnknown *m_pContext;
    DWORD m_dwCookie;
    FN_IC_OWNER_CALLBACK m_fnCallback;
    LPVOID m_pCallbackPV;
 
public:
    CInputContextOwner(FN_IC_OWNER_CALLBACK fnCallback, LPVOID pCallbackPV);
    virtual ~CInputContextOwner();
 
    HRESULT _Advise(IUnknown *pContext);
    HRESULT _Unadvise();
 
    // IUnknown methods
    STDMETHODIMP QueryInterface(REFIID riid, LPVOID* ppvObj) override;
    STDMETHODIMP_(ULONG) AddRef() override;
    STDMETHODIMP_(ULONG) Release() override;
 
    // ITfContextOwner methods
    STDMETHODIMP GetACPFromPoint(
        const POINT *ptScreen,
        DWORD       dwFlags,
        LONG        *pacp) override;
    STDMETHODIMP GetTextExt(
        LONG acpStart,
        LONG acpEnd,
        RECT *prc,
        BOOL *pfClipped) override;
    STDMETHODIMP GetScreenExt(RECT *prc) override;
    STDMETHODIMP GetStatus(TF_STATUS *pdcs) override;
    STDMETHODIMP GetWnd(HWND *phwnd) override;
    STDMETHODIMP GetAttribute(REFGUID rguidAttribute, VARIANT *pvarValue) override;
 
    // ITfMouseTrackerACP methods
    STDMETHODIMP AdviseMouseSink(
        ITfRangeACP *range,
        ITfMouseSink *pSink,
        DWORD *pdwCookie) override;
    STDMETHODIMP UnadviseMouseSink(DWORD dwCookie) override;
};
 
/***********************************************************************
 *      CicInputContext
 *
 * The msctfime.ime's input context.
 */
class CicInputContext
    : public ITfCleanupContextSink
    , public ITfContextOwnerCompositionSink
    , public ITfCompositionSink
{
public:
    LONG m_cRefs;
    HIMC m_hIMC;
    ITfDocumentMgr *m_pDocumentMgr;
    ITfContext *m_pContext;
    ITfContextOwnerServices *m_pContextOwnerServices;
    CInputContextOwnerCallBack *m_pICOwnerCallback;
    CTextEventSink *m_pTextEventSink;
    CCompartmentEventSink *m_pCompEventSink1;
    CCompartmentEventSink *m_pCompEventSink2;
    CInputContextOwner *m_pInputContextOwner;
    DWORD m_dwUnknown3[3];
    DWORD m_dwUnknown4[2];
    DWORD m_dwQueryPos;
    DWORD m_dwUnknown5;
    CModeBias m_ModeBias;
    DWORD m_dwUnknown6;
    BOOL m_bCandidateOpen;
    DWORD m_dwUnknown6_5[9];
    BOOL m_bSelecting;
    BOOL m_bReconverting;
    LONG m_cCompLocks;
    DWORD m_dwUnknown7[5];
    WORD m_cGuidAtoms;
    WORD m_padding;
    DWORD m_adwGuidAtoms[256];
    DWORD m_dwUnknown8;
    RECT m_rcCandidate1;
    CANDIDATEFORM m_CandForm;
    RECT m_rcCandidate2;
    TfClientId m_clientId;
    DWORD m_dwUnknown9;
 
public:
    CicInputContext(
        _In_ TfClientId cliendId,
        _Inout_ PCIC_LIBTHREAD pLibThread,
        _In_ HIMC hIMC);
    virtual ~CicInputContext() { }
 
    // IUnknown interface
    STDMETHODIMP QueryInterface(REFIID riid, LPVOID* ppvObj) override;
    STDMETHODIMP_(ULONG) AddRef() override;
    STDMETHODIMP_(ULONG) Release() override;
 
    // ITfCleanupContextSink interface
    STDMETHODIMP OnCleanupContext(_In_ TfEditCookie ecWrite, _Inout_ ITfContext *pic) override;
 
    // ITfContextOwnerCompositionSink interface
    STDMETHODIMP OnStartComposition(ITfCompositionView *pComposition, BOOL *pfOk) override;
    STDMETHODIMP OnUpdateComposition(ITfCompositionView *pComposition, ITfRange *pRangeNew) override;
    STDMETHODIMP OnEndComposition(ITfCompositionView *pComposition) override;
 
    // ITfCompositionSink interface
    STDMETHODIMP OnCompositionTerminated(TfEditCookie ecWrite, ITfComposition *pComposition) override;
 
    HRESULT
    GetGuidAtom(
        _Inout_ CicIMCLock& imcLock,
        _In_ BYTE iAtom,
        _Out_opt_ LPDWORD pdwGuidAtom);
 
    HRESULT CreateInputContext(_Inout_ ITfThreadMgr *pThreadMgr, _Inout_ CicIMCLock& imcLock);
    HRESULT DestroyInputContext();
 
    BOOL SetCompositionString(CicIMCLock& imcLock, ITfThreadMgr_P *pThreadMgr, DWORD dwIndex,
                              LPCVOID lpComp, DWORD dwCompLen, LPCVOID lpRead, DWORD dwReadLen,
                              UINT uCodePage);
 
    HRESULT SetupDocFeedString(CicIMCLock& imcLock, UINT uCodePage);
    HRESULT EscbClearDocFeedBuffer(CicIMCLock& imcLock, BOOL bFlag);
    HRESULT EscbCompComplete(CicIMCLock& imcLock);
    HRESULT EscbCompCancel(CicIMCLock& imcLock);
    HRESULT SetupReconvertString(
        CicIMCLock& imcLock,
        ITfThreadMgr_P *pThreadMgr,
        UINT uCodePage,
        UINT uMsg,
        BOOL bUndo);
    HRESULT MsImeMouseHandler(
        DWORD dwUnknown58,
        DWORD dwUnknown59,
        UINT keys,
        CicIMCLock& imcLock);
 
    HRESULT EndReconvertString(CicIMCLock& imcLock);
    HRESULT DelayedReconvertFuncCall(CicIMCLock& imcLock);
    void ClearPrevCandidatePos();
 
    HRESULT OnSetCandidatePos(TLS *pTLS, CicIMCLock& imcLock);
};