[MSCTF][SDK] Add stubs for CRange (#8096)

This PR is just a step, but a slightly great one for OS development history. JIRA issue: CORE-19361 - Add IAnchor interface into textstor.idl. - Fix ITfRangeAnchor interface (that was wrong). - Delete range.c. - Add range.cpp. - Add CRange class as stubs.
2025-07-09 03:18:06 +00:00 · 2025-06-09 23:51:17 +09:00 · 2025-06-09 23:51:17 +09:00 · 5b94656442
commit 5b94656442
parent 2c124893ec
7 changed files with 583 additions and 446 deletions
--- a/base/ctf/msctf/range.cpp
+++ b/base/ctf/msctf/range.cpp
@ -0,0 +1,396 @@
+/*
+ * PROJECT:     ReactOS CTF
+ * LICENSE:     LGPL-2.0-or-later (https://spdx.org/licenses/LGPL-2.0-or-later)
+ * PURPOSE:     ITfRangeACP implementation
+ * COPYRIGHT:   Copyright 2009 Aric Stewart, CodeWeavers
+ *              Copyright 2025 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
+ */
+
+#include <initguid.h>
+#include <windef.h>
+#include <winbase.h>
+#include <winreg.h>
+#include <msctf.h>
+#include <msctf_undoc.h>
+
+// Cicero
+#include <cicbase.h>
+#include <cicreg.h>
+#include <cicutb.h>
+
+class CInputContext;
+#include "range.h"
+#include "msctf_internal.h"
+
+#include <wine/debug.h>
+WINE_DEFAULT_DEBUG_CHANNEL(msctf);
+
+////////////////////////////////////////////////////////////////////////////
+// CRange
+
+CRange::CRange(
+    _In_ CInputContext *pIC,
+    _In_ DWORD dwLockType,
+    _In_ IAnchor *pAnchorStart,
+    _In_ IAnchor *pAnchorEnd,
+    _In_ TfGravity gravity)
+{
+    m_dwLockType = dwLockType;
+    m_pAnchorStart = pAnchorStart;
+    m_pAnchorEnd = pAnchorEnd;
+    m_pInputContext = pIC;
+    m_dwCookie = MAXDWORD;
+    m_gravity = gravity;
+    m_cRefs = 1;
+}
+
+CRange::~CRange()
+{
+}
+
+CRange *CRange::_Clone()
+{
+    CRange *pRange = new(cicNoThrow) CRange(m_pInputContext, 0, m_pAnchorStart, m_pAnchorEnd, (TfGravity)2);
+    if (!pRange)
+        return NULL;
+    pRange->m_dwCookie = m_dwCookie;
+    return pRange;
+}
+
+HRESULT CRange::_IsEqualX(TfEditCookie ec, BOOL bEnd, ITfRange *pWith, TfAnchor aPos, BOOL *pfEqual)
+{
+    return E_NOTIMPL;
+}
+
+HRESULT CRange::_CompareX(
+    TfEditCookie ec,
+    BOOL bEnd,
+    ITfRange *pWidth,
+    TfAnchor aPos,
+    LONG *plResult)
+{
+    return E_NOTIMPL;
+}
+
+////////////////////////////////////////////////////////////////////////////
+// ** IUnknown methods **
+
+STDMETHODIMP CRange::QueryInterface(REFIID riid, void **ppvObj)
+{
+    if (IsEqualGUID(riid, IID_PRIV_CRANGE))
+    {
+        *ppvObj = this;
+        return S_OK; // No AddRef
+    }
+
+    if (IsEqualGUID(riid, IID_ITfRange) || IsEqualGUID(riid, IID_IUnknown))
+        *ppvObj = this;
+    else if (IsEqualGUID(riid, IID_ITfRangeACP))
+        *ppvObj = static_cast<ITfRangeACP *>(this);
+    else if (IsEqualGUID(riid, IID_ITfRangeAnchor))
+        *ppvObj = static_cast<ITfRangeAnchor *>(this);
+    else if (IsEqualGUID(riid, IID_ITfSource))
+        *ppvObj = static_cast<ITfSource *>(this);
+    else
+        *ppvObj = NULL;
+ 
+    if (*ppvObj)
+    {
+        AddRef();
+        return S_OK;
+    }
+
+    return E_NOINTERFACE;
+}
+
+STDMETHODIMP_(ULONG) CRange::AddRef()
+{
+    return InterlockedIncrement(&m_cRefs);
+}
+
+STDMETHODIMP_(ULONG) CRange::Release()
+{
+    if (InterlockedDecrement(&m_cRefs) == 0)
+    {
+        delete this;
+        return 0;
+    }
+    return m_cRefs;
+}
+
+////////////////////////////////////////////////////////////////////////////
+// ** ITfRange methods **
+
+STDMETHODIMP CRange::GetText(
+    _In_ TfEditCookie ec,
+    _In_ DWORD dwFlags,
+    _Out_ WCHAR *pchText,
+    _In_ ULONG cchMax,
+    _Out_ ULONG *pcch)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::SetText(
+    _In_ TfEditCookie ec,
+    _In_ DWORD dwFlags,
+    _In_ const WCHAR *pchText,
+    _In_ LONG cch)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::GetFormattedText(
+    _In_ TfEditCookie ec,
+    _Out_ IDataObject **ppDataObject)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::GetEmbedded(
+    _In_ TfEditCookie ec,
+    _In_ REFGUID rguidService,
+    _In_ REFIID riid,
+    _Out_ IUnknown **ppunk)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::InsertEmbedded(
+    _In_ TfEditCookie ec,
+    _In_ DWORD dwFlags,
+    _In_ IDataObject *pDataObject)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftStart(
+    _In_ TfEditCookie ec,
+    _In_ LONG cchReq,
+    _Out_ LONG *pcch,
+    _In_ const TF_HALTCOND *pHalt)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftEnd(
+    _In_ TfEditCookie ec,
+    _In_ LONG cchReq,
+    _Out_ LONG *pcch,
+    _In_ const TF_HALTCOND *pHalt)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftStartToRange(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pRange,
+    _In_ TfAnchor aPos)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftEndToRange(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pRange,
+    _In_ TfAnchor aPos)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftStartRegion(
+    _In_ TfEditCookie ec,
+    _In_ TfShiftDir dir,
+    _Out_ BOOL *pfNoRegion)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::ShiftEndRegion(
+    _In_ TfEditCookie ec,
+    _In_ TfShiftDir dir,
+    _Out_ BOOL *pfNoRegion)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::IsEmpty(
+    _In_ TfEditCookie ec,
+    _Out_ BOOL *pfEmpty)
+{
+    TRACE("(%d, %p)\n", ec, pfEmpty);
+    return IsEqualStart(ec, static_cast<ITfRangeACP *>(this), TF_ANCHOR_END, pfEmpty);
+}
+
+STDMETHODIMP CRange::Collapse(
+    _In_ TfEditCookie ec,
+    _In_ TfAnchor aPos)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::IsEqualStart(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pWith,
+    _In_ TfAnchor aPos,
+    _Out_ BOOL *pfEqual)
+{
+    FIXME("\n");
+    return _IsEqualX(ec, FALSE, pWith, aPos, pfEqual);
+}
+
+STDMETHODIMP CRange::IsEqualEnd(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pWith,
+    _In_ TfAnchor aPos,
+    _Out_ BOOL *pfEqual)
+{
+    FIXME("\n");
+    return _IsEqualX(ec, TRUE, pWith, aPos, pfEqual);
+}
+
+STDMETHODIMP CRange::CompareStart(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pWith,
+    _In_ TfAnchor aPos,
+    _Out_ LONG *plResult)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::CompareEnd(
+    _In_ TfEditCookie ec,
+    _In_ ITfRange *pWith,
+    _In_ TfAnchor aPos,
+    _Out_ LONG *plResult)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::AdjustForInsert(
+    _In_ TfEditCookie ec,
+    _In_ ULONG cchInsert,
+    _Out_ BOOL *pfInsertOk)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::GetGravity(
+    _Out_ TfGravity *pgStart,
+    _Out_ TfGravity *pgEnd)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::SetGravity(
+    _In_ TfEditCookie ec,
+    _In_ TfGravity gStart,
+    _In_ TfGravity gEnd)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::Clone(
+    _Out_ ITfRange **ppClone)
+{
+    TRACE("%p\n", ppClone);
+
+    if (!ppClone)
+        return E_INVALIDARG;
+
+    CRange *pCloned = _Clone();
+    if (!pCloned)
+        return E_OUTOFMEMORY;
+
+    *ppClone = static_cast<ITfRangeACP *>(pCloned);
+    return S_OK;
+}
+
+STDMETHODIMP CRange::GetContext(
+    _Out_ ITfContext **ppContext)
+{
+    FIXME("%p\n", ppContext);
+    return E_NOTIMPL;
+}
+
+////////////////////////////////////////////////////////////////////////////
+// ** ITfRangeACP methods **
+
+STDMETHODIMP CRange::GetExtent(_Out_ LONG *pacpAnchor, _Out_ LONG *pcch)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::SetExtent(_In_ LONG acpAnchor, _In_ LONG cch)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+////////////////////////////////////////////////////////////////////////////
+// ** ITfRangeAnchor methods **
+
+STDMETHODIMP CRange::GetExtent(_Out_ IAnchor **ppStart, _Out_ IAnchor **ppEnd)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::SetExtent(_In_ IAnchor *pAnchorStart, _In_ IAnchor *pAnchorEnd)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+////////////////////////////////////////////////////////////////////////////
+// ** ITfSource methods **
+
+STDMETHODIMP CRange::AdviseSink(
+    _In_ REFIID riid,
+    _In_ IUnknown *punk,
+    _Out_ DWORD *pdwCookie)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+STDMETHODIMP CRange::UnadviseSink(
+    _In_ DWORD dwCookie)
+{
+    FIXME("\n");
+    return E_NOTIMPL;
+}
+
+////////////////////////////////////////////////////////////////////////////
+
+EXTERN_C
+HRESULT Range_Constructor(ITfContext *context, ITextStoreACP *textstore, DWORD lockType, DWORD anchorStart, DWORD anchorEnd, ITfRange **ppOut)
+{
+    return E_NOTIMPL;
+}
+
+/* Internal conversion functions */
+
+EXTERN_C
+HRESULT TF_SELECTION_to_TS_SELECTION_ACP(const TF_SELECTION *tf, TS_SELECTION_ACP *tsAcp)
+{
+    return E_NOTIMPL;
+}