[MSCTFIME][SDK] Implement CicCaret class (#6287)

Supporting TIPs... UIComposition class requires a caret class.
JIRA issue: CORE-19360
- Add <cicero/ciccaret.h> header.
- Add CicCaret class for displaying a caret.

dll/ime/msctfime/msctfime.h

@@ -27,6 +27,7 @@
 #include <cicero/cicarray.h>
 #include <cicero/cicimc.h>
 #include <cicero/cictf.h>
+#include <cicero/ciccaret.h>
 
 #include <wine/debug.h>
 

sdk/include/reactos/cicero/ciccaret.h

@@ -0,0 +1,135 @@
+/*
+ * PROJECT:     ReactOS Cicero
+ * LICENSE:     LGPL-2.1-or-later (https://spdx.org/licenses/LGPL-2.1-or-later)
+ * PURPOSE:     Displaying Cicero caret
+ * COPYRIGHT:   Copyright 2023 Katayama Hirofumi MZ <katayama.hirofumi.mz@gmail.com>
+ */
+
+#pragma once
+
+class CicCaret
+{
+protected:
+    HWND m_hWnd;
+    UINT m_uCaretBlinkTimerID;
+    POINT m_pt;
+    SIZE m_size;
+    BOOL m_bCaretBlinking;
+    BOOL m_bCaretVisible;
+
+public:
+    enum { TIMER_ID = 0x4F83AF91 };
+    CicCaret();
+    virtual ~CicCaret();
+
+    void CreateCaret(HWND hWnd, SIZE size);
+    void DestroyCaret();
+    void HideCaret();
+    void InvertCaret();
+    void OnTimer();
+    void SetCaretPos(POINT pt);
+    void SetBlinking(BOOL bBlinking);
+};
+
+/***********************************************************************/
+
+/**
+ * @implemented
+ */
+inline CicCaret::CicCaret()
+{
+    m_bCaretBlinking = FALSE;
+    m_bCaretVisible = FALSE;
+    m_uCaretBlinkTimerID = 0;
+    m_pt.x = m_pt.y = 0;
+    m_size.cx = m_size.cy = 0;
+}
+
+/**
+ * @implemented
+ */
+inline CicCaret::~CicCaret()
+{
+    HideCaret();
+    ::KillTimer(m_hWnd, m_uCaretBlinkTimerID);
+    m_uCaretBlinkTimerID = 0;
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::CreateCaret(HWND hWnd, SIZE size)
+{
+    m_hWnd = hWnd;
+    m_size = size;
+    if (::IsWindow(hWnd))
+        m_uCaretBlinkTimerID = ::SetTimer(m_hWnd, TIMER_ID, ::GetCaretBlinkTime(), NULL);
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::DestroyCaret()
+{
+    HideCaret();
+    ::KillTimer(m_hWnd, m_uCaretBlinkTimerID);
+    m_uCaretBlinkTimerID = 0;
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::HideCaret()
+{
+    if (m_bCaretVisible)
+    {
+        m_bCaretVisible = FALSE;
+        InvertCaret();
+    }
+    m_bCaretBlinking = FALSE;
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::InvertCaret()
+{
+    HDC hDC = ::GetDC(m_hWnd);
+    ::PatBlt(hDC, m_pt.x, m_pt.y, m_size.cx, m_size.cy, DSTINVERT);
+    ::ReleaseDC(m_hWnd, hDC);
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::OnTimer()
+{
+    if (m_bCaretBlinking)
+    {
+        m_bCaretVisible = !m_bCaretVisible;
+        InvertCaret();
+    }
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::SetCaretPos(POINT pt)
+{
+    BOOL bCaretVisible = m_bCaretVisible;
+    if (bCaretVisible)
+        InvertCaret();
+
+    m_pt = pt;
+
+    if (bCaretVisible)
+        InvertCaret();
+}
+
+/**
+ * @implemented
+ */
+inline void CicCaret::SetBlinking(BOOL bBlinking)
+{
+    m_bCaretBlinking = bBlinking;
+}