IKeyState.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd.
 * SPDX-FileCopyrightText: (C) 2003 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "base/IEventQueue.h"
#include "deskflow/KeyTypes.h"
 
#include <set>
#include <string>


class IKeyState
{
public:
  explicit IKeyState(const IEventQueue *events);
  virtual ~IKeyState() = default;
  inline static const auto s_numButtons = 0x200;

  class KeyInfo
  {
  public:
    static KeyInfo *alloc(KeyID, KeyModifierMask, KeyButton, int32_t count);
    static KeyInfo *alloc(KeyID, KeyModifierMask, KeyButton, int32_t count, const std::set<std::string> &destinations);
    static KeyInfo *alloc(const KeyInfo &);
 
    static bool isDefault(const char *screens);
    static bool contains(const char *screens, const std::string_view &name);
    static bool equal(const KeyInfo *, const KeyInfo *);
    static std::string join(const std::set<std::string> &destinations);
    static void split(const char *screens, std::set<std::string> &);
 
  public:
    KeyID m_key;
    KeyModifierMask m_mask;
    KeyButton m_button;
    int32_t m_count;
    std::string m_screens;
  };
 
  using KeyButtonSet = std::set<KeyButton>;




  virtual void updateKeyMap() = 0;


  virtual void updateKeyState() = 0;


  virtual void setHalfDuplexMask(KeyModifierMask) = 0;


  virtual void fakeKeyDown(KeyID id, KeyModifierMask mask, KeyButton button, const std::string &lang) = 0;


  virtual bool
  fakeKeyRepeat(KeyID id, KeyModifierMask mask, int32_t count, KeyButton button, const std::string &lang) = 0;


  virtual bool fakeKeyUp(KeyButton button) = 0;


  virtual void fakeAllKeysUp() = 0;


  virtual void clearStaleModifiers()
  {
    // Default implementation does nothing
  }


  virtual bool fakeCtrlAltDel() = 0;


  virtual bool fakeMediaKey(KeyID id) = 0;




  virtual bool isKeyDown(KeyButton) const = 0;


  virtual KeyModifierMask getActiveModifiers() const = 0;


  virtual KeyModifierMask pollActiveModifiers() const = 0;


  virtual int32_t pollActiveGroup() const = 0;


  virtual void pollPressedKeys(KeyButtonSet &pressedKeys) const = 0;

};