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

Module Name:
- cursor.h

Abstract:
- This file implements the NT console server cursor routines.

Author:
- Therese Stowell (ThereseS) 5-Dec-1990

Revision History:
- Grouped into class and items made private. (MiNiksa, 2014)
--*/

#pragma once

#include "../inc/conattrs.hpp"

// the following values are used to create the textmode cursor.
#define CURSOR_SMALL_SIZE 25    // large enough to be one pixel on a six pixel font
class TextBuffer;

class Cursor final
{
public:

    static const unsigned int s_InvertCursorColor = INVALID_COLOR;

    Cursor(const ULONG ulSize, TextBuffer& parentBuffer);

    ~Cursor();

    // No Copy. It will copy the timer handle. Bad news.
    Cursor(const Cursor&) = delete;
    Cursor& operator=(const Cursor&) & = delete;

    Cursor(Cursor&&) = default;
    Cursor& operator=(Cursor&&) & = default;

    bool HasMoved() const noexcept;
    bool IsVisible() const noexcept;
    bool IsOn() const noexcept;
    bool IsBlinkingAllowed() const noexcept;
    bool IsDouble() const noexcept;
    bool IsConversionArea() const noexcept;
    bool IsPopupShown() const noexcept;
    bool GetDelay() const noexcept;
    ULONG GetSize() const noexcept;
    COORD GetPosition() const noexcept;

    const CursorType GetType() const;
    const bool IsUsingColor() const;
    const COLORREF GetColor() const;

    void StartDeferDrawing();
    void EndDeferDrawing();

    void SetHasMoved(const bool fHasMoved);
    void SetIsVisible(const bool fIsVisible);
    void SetIsOn(const bool fIsOn);
    void SetBlinkingAllowed(const bool fIsOn);
    void SetIsDouble(const bool fIsDouble);
    void SetIsConversionArea(const bool fIsConversionArea);
    void SetIsPopupShown(const bool fIsPopupShown);
    void SetDelay(const bool fDelay);
    void SetSize(const ULONG ulSize);
    void SetStyle(const ULONG ulSize, const COLORREF color, const CursorType type) noexcept;

    void SetPosition(const COORD cPosition);
    void SetXPosition(const int NewX);
    void SetYPosition(const int NewY);
    void IncrementXPosition(const int DeltaX);
    void IncrementYPosition(const int DeltaY);
    void DecrementXPosition(const int DeltaX);
    void DecrementYPosition(const int DeltaY);

    void CopyProperties(const Cursor& OtherCursor);

    void DelayEOLWrap(const COORD coordDelayedAt);
    void ResetDelayEOLWrap();
    COORD GetDelayedAtPosition() const;
    bool IsDelayedEOLWrap() const;

    void SetColor(const unsigned int color);
    void SetType(const CursorType type);

private:
    TextBuffer& _parentBuffer;

    //TODO: seperate the rendering and text placement

    // NOTE: If you are adding a property here, go add it to CopyProperties.

    COORD _cPosition;   // current position on screen (in screen buffer coords).

    bool _fHasMoved;
    bool _fIsVisible;  // whether cursor is visible (set only through the API)
    bool _fIsOn;   // whether blinking cursor is on or not
    bool _fIsDouble;   // whether the cursor size should be doubled
    bool _fBlinkingAllowed; //Whether or not the cursor is allowed to blink at all. only set through VT (^[[?12h/l)
    bool _fDelay;    // don't blink scursor on next timer message
    bool _fIsConversionArea; // is attached to a conversion area so it doesn't actually need to display the cursor.
    bool _fIsPopupShown; // if a popup is being shown, turn off, stop blinking.

    bool _fDelayedEolWrap;    // don't wrap at EOL till the next char comes in.
    COORD _coordDelayedAt;   // coordinate the EOL wrap was delayed at.

    bool _fDeferCursorRedraw; // whether we should defer redrawing the cursor or not
    bool _fHaveDeferredCursorRedraw; // have we been asked to redraw the cursor while it was being deferred?

    ULONG _ulSize;

    void _RedrawCursor() noexcept;
    void _RedrawCursorAlways() noexcept;

    CursorType _cursorType;
    bool _fUseColor;
    COLORREF _color;
};