XWindowsKeyState.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * 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 "deskflow/KeyState.h"
 
#include <map>
#include <vector>
 
#include <X11/Xlib.h>
#if HAVE_X11_EXTENSIONS_XTEST_H
#include <X11/extensions/XTest.h>
#else
#error The XTest extension is required to build deskflow
#endif
#if HAVE_XKB_EXTENSION
#include <X11/extensions/XKBstr.h>
#endif
 
class IEventQueue;


class XWindowsKeyState : public KeyState
{
public:
  using KeycodeList = std::vector<int>;
  inline static const auto s_groupPoll = -1;
  inline static const auto s_groupPollAndSet = -2;
 
  XWindowsKeyState(Display *, bool useXKB, IEventQueue *events);
  XWindowsKeyState(Display *, bool useXKB, IEventQueue *events, deskflow::KeyMap &keyMap);
  ~XWindowsKeyState() override;




  void setActiveGroup(int32_t group);


  void setAutoRepeat(const XKeyboardState &);




  KeyModifierMask mapModifiersFromX(unsigned int state) const;


  bool mapModifiersToX(KeyModifierMask, unsigned int &) const;


  void mapKeyToKeycodes(KeyID key, KeycodeList &keycodes) const;

 
  // IKeyState overrides
  bool fakeCtrlAltDel() override;
  KeyModifierMask pollActiveModifiers() const override;
  int32_t pollActiveGroup() const final;
  void pollPressedKeys(KeyButtonSet &pressedKeys) const override;
 
protected:
  // KeyState overrides
  void getKeyMap(deskflow::KeyMap &keyMap) override;
  void fakeKey(const Keystroke &keystroke) override;
 
private:
  void init(const Display *display, bool useXKB);
  void updateKeysymMap(deskflow::KeyMap &);
  void updateKeysymMapXKB(deskflow::KeyMap &);
  bool hasModifiersXKB() const;
  int getEffectiveGroup(KeyCode, int group) const;
  uint32_t getGroupFromState(unsigned int state) const;


  bool setCurrentLanguageWithDBus(int32_t group) const;
 
  static void remapKeyModifiers(KeyID, int32_t, deskflow::KeyMap::KeyItem &, void *);
 
private:
  struct XKBModifierInfo
  {
  public:
    unsigned char m_level;
    uint32_t m_mask;
    bool m_lock;
  };
 
  using KeyModifierMaskList = std::vector<KeyModifierMask>;
 
private:
  using KeyModifierToXMask = std::map<KeyModifierMask, unsigned int>;
  using KeyToKeyCodeMap = std::multimap<KeyID, KeyCode>;
  using NonXKBModifierMap = std::map<KeyCode, unsigned int>;
  using XKBModifierMap = std::map<uint32_t, XKBModifierInfo>;
 
  Display *m_display;
#if HAVE_XKB_EXTENSION
  XkbDescPtr m_xkb;
#endif
  int32_t m_group;
  XKBModifierMap m_lastGoodXKBModifiers;
  NonXKBModifierMap m_lastGoodNonXKBModifiers;
 
  // X modifier (bit number) to deskflow modifier (mask) mapping
  KeyModifierMaskList m_modifierFromX = {};
 
  // deskflow modifier (mask) to X modifier (mask)
  KeyModifierToXMask m_modifierToX;
 
  // map KeyID to all keycodes that can synthesize that KeyID
  KeyToKeyCodeMap m_keyCodeFromKey;
 
  // autorepeat state
  XKeyboardState m_keyboardState;
};