MouseStat.h

/*
 *  Copyright (C) 2005-2024 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "windowing/XBMC_events.h"


#define XBMC_BUTTON(X) (1 << ((X)-1))
#define XBMC_BUTTON_LEFT 1
#define XBMC_BUTTON_MIDDLE 2
#define XBMC_BUTTON_RIGHT 3
#define XBMC_BUTTON_WHEELUP 4
#define XBMC_BUTTON_WHEELDOWN 5
#define XBMC_BUTTON_X1 6
#define XBMC_BUTTON_X2 7
#define XBMC_BUTTON_X3 8
#define XBMC_BUTTON_X4 9
#define XBMC_BUTTON_LMASK XBMC_BUTTON(XBMC_BUTTON_LEFT)
#define XBMC_BUTTON_MMASK XBMC_BUTTON(XBMC_BUTTON_MIDDLE)
#define XBMC_BUTTON_RMASK XBMC_BUTTON(XBMC_BUTTON_RIGHT)
#define XBMC_BUTTON_X1MASK XBMC_BUTTON(XBMC_BUTTON_X1)
#define XBMC_BUTTON_X2MASK XBMC_BUTTON(XBMC_BUTTON_X2)
#define XBMC_BUTTON_X3MASK XBMC_BUTTON(XBMC_BUTTON_X3)
#define XBMC_BUTTON_X4MASK XBMC_BUTTON(XBMC_BUTTON_X4)

#define MOUSE_MINIMUM_MOVEMENT 2
#define MOUSE_DOUBLE_CLICK_LENGTH 500L
#define MOUSE_ACTIVE_LENGTH 5000L

#define MOUSE_MAX_BUTTON 7

enum MOUSE_STATE
{
  MOUSE_STATE_NORMAL = 1,
  MOUSE_STATE_FOCUS,
  MOUSE_STATE_DRAG,
  MOUSE_STATE_CLICK
};

enum MOUSE_BUTTON
{
  MOUSE_LEFT_BUTTON = 0,
  MOUSE_RIGHT_BUTTON,
  MOUSE_MIDDLE_BUTTON,
  MOUSE_EXTRA_BUTTON1,
  MOUSE_EXTRA_BUTTON2,
  MOUSE_EXTRA_BUTTON3,
  MOUSE_EXTRA_BUTTON4
};

enum class HoldAction
{
  NONE,
  DRAG_START,
  DRAG,
  DRAG_END
};

struct MouseState
{
  int x;
  int y;
  int16_t dx;
  int16_t dy;
  int8_t dz;
  bool button[MOUSE_MAX_BUTTON];
  bool active;
};

struct MousePosition
{
  int x;
  int y;
};

class CAction;

class CMouseStat
{
public:
  CMouseStat();
  virtual ~CMouseStat();

  void Initialize();
  void HandleEvent(const XBMC_Event& newEvent);
  void SetResolution(int maxX, int maxY, float speedX, float speedY);
  bool IsActive();
  bool IsEnabled() const;

  void SetActive(bool active = true);
  void SetState(MOUSE_STATE state) { m_pointerState = state; }
  void SetEnabled(bool enabled = true);
  MOUSE_STATE GetState() const { return m_pointerState; }
  uint32_t GetKey() const;

  HoldAction GetHold(int ButtonID) const;
  inline int GetX(void) const { return m_mouseState.x; }
  inline int GetY(void) const { return m_mouseState.y; }
  inline int GetDX(void) const { return m_mouseState.dx; }
  inline int GetDY(void) const { return m_mouseState.dy; }
  MousePosition GetPosition() { return MousePosition{m_mouseState.x, m_mouseState.y}; }

private:
  class CButtonState
  {
  public:
    enum BUTTON_ACTION
    {
      MB_NONE = 0, 
      MB_SHORT_CLICK, 
      MB_LONG_CLICK, 
      MB_DOUBLE_CLICK, 
      MB_DRAG_START, 
      MB_DRAG, 
      MB_DRAG_END
    }; 

    CButtonState();

    BUTTON_ACTION Update(unsigned int time, int x, int y, bool down);

  private:
    static const unsigned int click_confines = 5;

    static const unsigned int short_click_time = 1000;

    static const unsigned int double_click_time = 500;

    bool InClickRange(int x, int y) const;

    enum BUTTON_STATE
    {
      STATE_RELEASED = 0, 
      STATE_IN_CLICK, 
      STATE_IN_DOUBLE_CLICK, 
      STATE_IN_DOUBLE_IGNORE, 
      STATE_IN_DRAG
    }; 

    BUTTON_STATE m_state;
    unsigned int m_time;
    int m_x;
    int m_y;
  };

  bool MovedPastThreshold() const;

  // state of the mouse
  MOUSE_STATE m_pointerState{MOUSE_STATE_NORMAL};
  MouseState m_mouseState{};
  bool m_mouseEnabled;
  CButtonState m_buttonState[MOUSE_MAX_BUTTON];

  int m_maxX{0};
  int m_maxY{0};
  float m_speedX{0.0f};
  float m_speedY{0.0f};

  // active/click timers
  unsigned int m_lastActiveTime;

  bool bClick[MOUSE_MAX_BUTTON]{};
  bool bDoubleClick[MOUSE_MAX_BUTTON]{};
  HoldAction m_hold[MOUSE_MAX_BUTTON]{};
  bool bLongClick[MOUSE_MAX_BUTTON]{};

  uint32_t m_Key;
};