TfEditSession.h

/*++

Copyright (c) Microsoft Corporation.
Licensed under the MIT license.

Module Name:

    TfEditSession.h

Abstract:

    This file defines the CEditSessionObject Class.

Author:

Revision History:

Notes:

--*/

#pragma once

class CicCategoryMgr;
class CicDisplayAttributeMgr;

/* 183C627A-B46C-44ad-B797-82F6BEC82131 */
const GUID GUID_PROP_CONIME_TRACKCOMPOSITION = {
    0x183c627a,
    0xb46c,
    0x44ad,
    { 0xb7, 0x97, 0x82, 0xf6, 0xbe, 0xc8, 0x21, 0x31 }
};

//+---------------------------------------------------------------------------
//
// CEditSessionObject
//
//----------------------------------------------------------------------------

class CEditSessionObject : public ITfEditSession
{
public:
    CEditSessionObject() :
        m_cRef(1) {}
    virtual ~CEditSessionObject(){};

public:
    //
    // IUnknown methods
    //
    STDMETHODIMP QueryInterface(REFIID riid, void** ppvObj);
    STDMETHODIMP_(ULONG)
    AddRef(void);
    STDMETHODIMP_(ULONG)
    Release(void);

    //
    // ITfEditSession method
    //
    STDMETHODIMP DoEditSession(TfEditCookie ec)
    {
        HRESULT hr = _DoEditSession(ec);
        Release(); // Release reference count for asynchronous edit session.
        return hr;
    }

    //
    // ImmIfSessionObject methods
    //
protected:
    [[nodiscard]] virtual HRESULT _DoEditSession(TfEditCookie ec) = 0;

    //
    // EditSession methods.
    //
public:
    [[nodiscard]] static HRESULT GetAllTextRange(TfEditCookie ec,
                                                 ITfContext* ic,
                                                 ITfRange** range,
                                                 LONG* lpTextLength,
                                                 TF_HALTCOND* lpHaltCond = nullptr);

protected:
    [[nodiscard]] HRESULT SetTextInRange(TfEditCookie ec,
                                         ITfRange* range,
                                         __in_ecount_opt(len) LPWSTR psz,
                                         DWORD len);
    [[nodiscard]] HRESULT ClearTextInRange(TfEditCookie ec,
                                           ITfRange* range);

    [[nodiscard]] HRESULT _GetTextAndAttribute(TfEditCookie ec,
                                               ITfRange* range,
                                               std::wstring& CompStr,
                                               std::vector<TfGuidAtom> CompGuid,
                                               BOOL bInWriteSession,
                                               CicCategoryMgr* pCicCatMgr,
                                               CicDisplayAttributeMgr* pCicDispAttr)
    {
        std::wstring ResultStr;
        return _GetTextAndAttribute(ec, range, CompStr, CompGuid, ResultStr, bInWriteSession, pCicCatMgr, pCicDispAttr);
    }

    [[nodiscard]] HRESULT _GetTextAndAttribute(TfEditCookie ec,
                                               ITfRange* range,
                                               std::wstring& CompStr,
                                               std::vector<TfGuidAtom>& CompGuid,
                                               std::wstring& ResultStr,
                                               BOOL bInWriteSession,
                                               CicCategoryMgr* pCicCatMgr,
                                               CicDisplayAttributeMgr* pCicDispAttr);

    [[nodiscard]] HRESULT _GetTextAndAttributeGapRange(TfEditCookie ec,
                                                       ITfRange* gap_range,
                                                       LONG result_comp,
                                                       std::wstring& CompStr,
                                                       std::vector<TfGuidAtom>& CompGuid,
                                                       std::wstring& ResultStr);

    [[nodiscard]] HRESULT _GetTextAndAttributePropertyRange(TfEditCookie ec,
                                                            ITfRange* pPropRange,
                                                            BOOL fDispAttribute,
                                                            LONG result_comp,
                                                            BOOL bInWriteSession,
                                                            TF_DISPLAYATTRIBUTE da,
                                                            TfGuidAtom guidatom,
                                                            std::wstring& CompStr,
                                                            std::vector<TfGuidAtom>& CompGuid,
                                                            std::wstring& ResultStr);

    [[nodiscard]] HRESULT _GetNoDisplayAttributeRange(TfEditCookie ec,
                                                      ITfRange* range,
                                                      const GUID** guids,
                                                      const int guid_size,
                                                      ITfRange* no_display_attribute_range);

    [[nodiscard]] HRESULT _GetCursorPosition(TfEditCookie ec,
                                             CCompCursorPos& CompCursorPos);

private:
    int m_cRef;
};

//+---------------------------------------------------------------------------
//
// CEditSessionCompositionComplete
//
//----------------------------------------------------------------------------

class CEditSessionCompositionComplete : public CEditSessionObject
{
public:
    CEditSessionCompositionComplete() {}

    [[nodiscard]] HRESULT _DoEditSession(TfEditCookie ec)
    {
        return CompComplete(ec);
    }

    [[nodiscard]] HRESULT CompComplete(TfEditCookie ec);
};

//+---------------------------------------------------------------------------
//
// CEditSessionCompositionCleanup
//
//----------------------------------------------------------------------------

class CEditSessionCompositionCleanup : public CEditSessionObject
{
public:
    CEditSessionCompositionCleanup() {}

    [[nodiscard]] HRESULT _DoEditSession(TfEditCookie ec)
    {
        return EmptyCompositionRange(ec);
    }

    [[nodiscard]] HRESULT EmptyCompositionRange(TfEditCookie ec);
};

//+---------------------------------------------------------------------------
//
// CEditSessionUpdateCompositionString
//
//----------------------------------------------------------------------------

class CEditSessionUpdateCompositionString : public CEditSessionObject
{
public:
    CEditSessionUpdateCompositionString() {}

    [[nodiscard]] HRESULT _DoEditSession(TfEditCookie ec)
    {
        return UpdateCompositionString(ec);
    }

    [[nodiscard]] HRESULT UpdateCompositionString(TfEditCookie ec);

private:
    [[nodiscard]] HRESULT _IsInterimSelection(TfEditCookie ec, ITfRange** pInterimRange, BOOL* pfInterim);

    [[nodiscard]] HRESULT _MakeCompositionString(TfEditCookie ec,
                                                 ITfRange* FullTextRange,
                                                 BOOL bInWriteSession,
                                                 CicCategoryMgr* pCicCatMgr,
                                                 CicDisplayAttributeMgr* pCicDispAttr);

    [[nodiscard]] HRESULT _MakeInterimString(TfEditCookie ec,
                                             ITfRange* FullTextRange,
                                             ITfRange* InterimRange,
                                             LONG lTextLength,
                                             BOOL bInWriteSession,
                                             CicCategoryMgr* pCicCatMgr,
                                             CicDisplayAttributeMgr* pCicDispAttr);

    [[nodiscard]] HRESULT _CreateCategoryAndDisplayAttributeManager(CicCategoryMgr** pCicCatMgr,
                                                                    CicDisplayAttributeMgr** pCicDispAttr);
};