File indexing completed on 2024-12-08 13:21:52

 /*
     KWin - the KDE window manager
     This file is part of the KDE project.
 
     SPDX-FileCopyrightText: 2013 Martin Gräßlin <mgraesslin@kde.org>
     SPDX-FileCopyrightText: 2018 Roman Gilg <subdiff@gmail.com>
     SPDX-FileCopyrightText: 2019 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 #pragma once
 #include <config-kwin.h>
 
 #include <QObject>
 #include <QPoint>
 #include <QPointer>
 #include <kwinglobals.h>
 
 #include <KConfigWatcher>
 #include <KSharedConfig>
 #include <QSet>
 
 #include <functional>
 
 class KGlobalAccelInterface;
 class QAction;
 class QKeySequence;
 class QMouseEvent;
 class QKeyEvent;
 class QWheelEvent;
 
 namespace KWin
 {
 class IdleDetector;
 class Window;
 class GlobalShortcutsManager;
 class InputEventFilter;
 class InputEventSpy;
 class KeyboardInputRedirection;
 class PointerInputRedirection;
 class TabletInputRedirection;
 class TouchInputRedirection;
 class WindowSelectorFilter;
 class SwitchEvent;
 class TabletEvent;
 class TabletToolId;
 class TabletPadId;
 class MouseEvent;
 class WheelEvent;
 class KeyEvent;
 
 namespace Decoration
 {
 class DecoratedClientImpl;
 }
 
 class InputBackend;
 class InputDevice;
 
 /**
  * @brief This class is responsible for redirecting incoming input to the surface which currently
  * has input or send enter/leave events.
  *
  * In addition input is intercepted before passed to the surfaces to have KWin internal areas
  * getting input first (e.g. screen edges) and filter the input event out if we currently have
  * a full input grab.
  */
 class KWIN_EXPORT InputRedirection : public QObject
 {
     Q_OBJECT
 public:
     enum PointerButtonState {
         PointerButtonReleased,
         PointerButtonPressed
     };
     enum PointerAxis {
         PointerAxisVertical,
         PointerAxisHorizontal
     };
     enum PointerAxisSource {
         PointerAxisSourceUnknown,
         PointerAxisSourceWheel,
         PointerAxisSourceFinger,
         PointerAxisSourceContinuous,
         PointerAxisSourceWheelTilt
     };
     enum KeyboardKeyState {
         KeyboardKeyReleased,
         KeyboardKeyPressed,
         KeyboardKeyAutoRepeat
     };
     enum TabletEventType {
         Axis,
         Proximity,
         Tip
     };
     enum TabletToolType {
         Pen,
         Eraser,
         Brush,
         Pencil,
         Airbrush,
         Finger,
         Mouse,
         Lens,
         Totem,
     };
     enum Capability {
         Tilt,
         Pressure,
         Distance,
         Rotation,
         Slider,
         Wheel,
     };
 
     ~InputRedirection() override;
     void init();
 
     /**
      * @return const QPointF& The current global pointer position
      */
     QPointF globalPointer() const;
     Qt::MouseButtons qtButtonStates() const;
     Qt::KeyboardModifiers keyboardModifiers() const;
     Qt::KeyboardModifiers modifiersRelevantForGlobalShortcuts() const;
 
     void registerPointerShortcut(Qt::KeyboardModifiers modifiers, Qt::MouseButton pointerButtons, QAction *action);
     void registerAxisShortcut(Qt::KeyboardModifiers modifiers, PointerAxisDirection axis, QAction *action);
     void registerTouchpadSwipeShortcut(SwipeDirection direction, uint fingerCount, QAction *action);
     void registerRealtimeTouchpadSwipeShortcut(SwipeDirection direction, uint fingerCount, QAction *onUp, std::function<void(qreal)> progressCallback);
     void registerTouchpadPinchShortcut(PinchDirection direction, uint fingerCount, QAction *action);
     void registerRealtimeTouchpadPinchShortcut(PinchDirection direction, uint fingerCount, QAction *onUp, std::function<void(qreal)> progressCallback);
     void registerTouchscreenSwipeShortcut(SwipeDirection direction, uint fingerCount, QAction *action, std::function<void(qreal)> progressCallback);
     void forceRegisterTouchscreenSwipeShortcut(SwipeDirection direction, uint fingerCount, QAction *action, std::function<void(qreal)> progressCallback);
     void registerGlobalAccel(KGlobalAccelInterface *interface);
 
     bool supportsPointerWarping() const;
     void warpPointer(const QPointF &pos);
 
     /**
      * Adds the @p filter to the list of event filters and makes it the first
      * event filter in processing.
      *
      * Note: the event filter will get events before the lock screen can get them, thus
      * this is a security relevant method.
      */
     void prependInputEventFilter(InputEventFilter *filter);
     void uninstallInputEventFilter(InputEventFilter *filter);
 
     /**
      * Installs the @p spy for spying on events.
      */
     void installInputEventSpy(InputEventSpy *spy);
 
     /**
      * Uninstalls the @p spy. This happens automatically when deleting an InputEventSpy.
      */
     void uninstallInputEventSpy(InputEventSpy *spy);
 
     void simulateUserActivity();
 
     void addIdleDetector(IdleDetector *detector);
     void removeIdleDetector(IdleDetector *detector);
 
     QList<Window *> idleInhibitors() const;
     void addIdleInhibitor(Window *inhibitor);
     void removeIdleInhibitor(Window *inhibitor);
 
     Window *findToplevel(const QPointF &pos);
     GlobalShortcutsManager *shortcuts() const
     {
         return m_shortcuts;
     }
 
     /**
      * Sends an event through all InputFilters.
      * The method @p function is invoked on each input filter. Processing is stopped if
      * a filter returns @c true for @p function.
      *
      * The UnaryPredicate is defined like the UnaryPredicate of std::any_of.
      * The signature of the function should be equivalent to the following:
      * @code
      * bool function(const InputEventFilter *spy);
      * @endcode
      *
      * The intended usage is to std::bind the method to invoke on the filter with all arguments
      * bind.
      */
     template<class UnaryPredicate>
     void processFilters(UnaryPredicate function)
     {
         std::any_of(m_filters.constBegin(), m_filters.constEnd(), function);
     }
 
     /**
      * Sends an event through all input event spies.
      * The @p function is invoked on each InputEventSpy.
      *
      * The UnaryFunction is defined like the UnaryFunction of std::for_each.
      * The signature of the function should be equivalent to the following:
      * @code
      * void function(const InputEventSpy *spy);
      * @endcode
      *
      * The intended usage is to std::bind the method to invoke on the spies with all arguments
      * bind.
      */
     template<class UnaryFunction>
     void processSpies(UnaryFunction function)
     {
         std::for_each(m_spies.constBegin(), m_spies.constEnd(), function);
     }
 
     KeyboardInputRedirection *keyboard() const
     {
         return m_keyboard;
     }
     PointerInputRedirection *pointer() const
     {
         return m_pointer;
     }
     TabletInputRedirection *tablet() const
     {
         return m_tablet;
     }
     TouchInputRedirection *touch() const
     {
         return m_touch;
     }
 
     /**
      * Specifies which was the device that triggered the last input event
      */
     void setLastInputHandler(QObject *device);
     QObject *lastInputHandler() const;
 
     QList<InputDevice *> devices() const;
 
     bool hasAlphaNumericKeyboard();
     bool hasPointer() const;
     bool hasTouch() const;
     bool hasTabletModeSwitch();
 
     void startInteractiveWindowSelection(std::function<void(KWin::Window *)> callback, const QByteArray &cursorName);
     void startInteractivePositionSelection(std::function<void(const QPoint &)> callback);
     bool isSelectingWindow() const;
 
     void toggleTouchpads();
     void enableTouchpads();
     void disableTouchpads();
 
 Q_SIGNALS:
     void deviceAdded(InputDevice *device);
     void deviceRemoved(InputDevice *device);
     /**
      * @brief Emitted when the global pointer position changed
      *
      * @param pos The new global pointer position.
      */
     void globalPointerChanged(const QPointF &pos);
     /**
      * @brief Emitted when the state of a pointer button changed.
      *
      * @param button The button which changed
      * @param state The new button state
      */
     void pointerButtonStateChanged(uint32_t button, InputRedirection::PointerButtonState state);
     /**
      * @brief Emitted when a pointer axis changed
      *
      * @param axis The axis on which the even occurred
      * @param delta The delta of the event.
      */
     void pointerAxisChanged(InputRedirection::PointerAxis axis, qreal delta);
     /**
      * @brief Emitted when the modifiers changes.
      *
      * Only emitted for the mask which is provided by Qt::KeyboardModifiers, if other modifiers
      * change signal is not emitted
      *
      * @param newMods The new modifiers state
      * @param oldMods The previous modifiers state
      */
     void keyboardModifiersChanged(Qt::KeyboardModifiers newMods, Qt::KeyboardModifiers oldMods);
     /**
      * @brief Emitted when the state of a key changed.
      *
      * @param keyCode The keycode of the key which changed
      * @param state The new key state
      */
     void keyStateChanged(quint32 keyCode, InputRedirection::KeyboardKeyState state);
 
     void hasKeyboardChanged(bool set);
     void hasAlphaNumericKeyboardChanged(bool set);
     void hasPointerChanged(bool set);
     void hasTouchChanged(bool set);
     void hasTabletModeSwitchChanged(bool set);
 
 public Q_SLOTS:
     void addInputDevice(InputDevice *device);
     void removeInputDevice(InputDevice *device);
 
 private Q_SLOTS:
     void handleInputConfigChanged(const KConfigGroup &group);
     void updateScreens();
 
 private:
     void setupInputBackends();
     void setupTouchpadShortcuts();
     void setupWorkspace();
     void setupInputFilters();
     void installInputEventFilter(InputEventFilter *filter);
     void updateLeds(LEDs leds);
     void updateAvailableInputDevices();
     void addInputBackend(std::unique_ptr<InputBackend> &&inputBackend);
     KeyboardInputRedirection *m_keyboard;
     PointerInputRedirection *m_pointer;
     TabletInputRedirection *m_tablet;
     TouchInputRedirection *m_touch;
     QObject *m_lastInputDevice = nullptr;
 
     GlobalShortcutsManager *m_shortcuts;
 
     std::vector<std::unique_ptr<InputBackend>> m_inputBackends;
     QList<InputDevice *> m_inputDevices;
 
     QList<IdleDetector *> m_idleDetectors;
     QList<Window *> m_idleInhibitors;
     WindowSelectorFilter *m_windowSelector = nullptr;
 
     QVector<InputEventFilter *> m_filters;
     QVector<InputEventSpy *> m_spies;
     KConfigWatcher::Ptr m_inputConfigWatcher;
 
     LEDs m_leds;
     bool m_hasKeyboard = false;
     bool m_hasAlphaNumericKeyboard = false;
     bool m_hasPointer = false;
     bool m_hasTouch = false;
     bool m_hasTabletModeSwitch = false;
     bool m_touchpadsEnabled = true;
 
     KWIN_SINGLETON(InputRedirection)
     friend InputRedirection *input();
     friend class DecorationEventFilter;
     friend class InternalWindowEventFilter;
     friend class ForwardInputFilter;
 };
 
 /**
  * Base class for filtering input events inside InputRedirection.
  *
  * The idea behind the InputEventFilter is to have task oriented
  * filters. E.g. there is one filter taking care of a locked screen,
  * one to take care of interacting with window decorations, etc.
  *
  * A concrete subclass can reimplement the virtual methods and decide
  * whether an event should be filtered out or not by returning either
  * @c true or @c false. E.g. the lock screen filter can easily ensure
  * that all events are filtered out.
  *
  * As soon as a filter returns @c true the processing is stopped. If
  * a filter returns @c false the next one is invoked. This means a filter
  * installed early gets to see more events than a filter installed later on.
  *
  * Deleting an instance of InputEventFilter automatically uninstalls it from
  * InputRedirection.
  */
 class KWIN_EXPORT InputEventFilter
 {
 public:
     InputEventFilter();
     virtual ~InputEventFilter();
 
     /**
      * Event filter for pointer events which can be described by a QMouseEvent.
      *
      * Please note that the button translation in QMouseEvent cannot cover all
      * possible buttons. Because of that also the @p nativeButton code is passed
      * through the filter. For internal areas it's fine to use @p event, but for
      * passing to client windows the @p nativeButton should be used.
      *
      * @param event The event information about the move or button press/release
      * @param nativeButton The native key code of the button, for move events 0
      * @return @c true to stop further event processing, @c false to pass to next filter
      */
     virtual bool pointerEvent(MouseEvent *event, quint32 nativeButton);
     /**
      * Event filter for pointer axis events.
      *
      * @param event The event information about the axis event
      * @return @c true to stop further event processing, @c false to pass to next filter
      */
     virtual bool wheelEvent(WheelEvent *event);
     /**
      * Event filter for keyboard events.
      *
      * @param event The event information about the key event
      * @return @c true to stop further event processing, @c false to pass to next filter.
      */
     virtual bool keyEvent(KeyEvent *event);
     virtual bool touchDown(qint32 id, const QPointF &pos, std::chrono::microseconds time);
     virtual bool touchMotion(qint32 id, const QPointF &pos, std::chrono::microseconds time);
     virtual bool touchUp(qint32 id, std::chrono::microseconds time);
     virtual bool touchCancel();
     virtual bool touchFrame();
 
     virtual bool pinchGestureBegin(int fingerCount, std::chrono::microseconds time);
     virtual bool pinchGestureUpdate(qreal scale, qreal angleDelta, const QPointF &delta, std::chrono::microseconds time);
     virtual bool pinchGestureEnd(std::chrono::microseconds time);
     virtual bool pinchGestureCancelled(std::chrono::microseconds time);
 
     virtual bool swipeGestureBegin(int fingerCount, std::chrono::microseconds time);
     virtual bool swipeGestureUpdate(const QPointF &delta, std::chrono::microseconds time);
     virtual bool swipeGestureEnd(std::chrono::microseconds time);
     virtual bool swipeGestureCancelled(std::chrono::microseconds time);
 
     virtual bool holdGestureBegin(int fingerCount, std::chrono::microseconds time);
     virtual bool holdGestureEnd(std::chrono::microseconds time);
     virtual bool holdGestureCancelled(std::chrono::microseconds time);
 
     virtual bool switchEvent(SwitchEvent *event);
 
     virtual bool tabletToolEvent(TabletEvent *event);
     virtual bool tabletToolButtonEvent(uint button, bool pressed, const TabletToolId &tabletToolId, std::chrono::microseconds time);
     virtual bool tabletPadButtonEvent(uint button, bool pressed, const TabletPadId &tabletPadId, std::chrono::microseconds time);
     virtual bool tabletPadStripEvent(int number, int position, bool isFinger, const TabletPadId &tabletPadId, std::chrono::microseconds time);
     virtual bool tabletPadRingEvent(int number, int position, bool isFinger, const TabletPadId &tabletPadId, std::chrono::microseconds time);
 
 protected:
     void passToWaylandServer(QKeyEvent *event);
     bool passToInputMethod(QKeyEvent *event);
 };
 
 class KWIN_EXPORT InputDeviceHandler : public QObject
 {
     Q_OBJECT
 public:
     ~InputDeviceHandler() override;
     virtual void init();
 
     void update();
 
     /**
      * @brief First Window currently at the position of the input device
      * according to the stacking order.
      * @return Window* at device position.
      *
      * This will be null if no window is at the position
      */
     Window *hover() const;
     /**
      * @brief Window currently having pointer input focus (this might
      * be different from the Window at the position of the pointer).
      * @return Window* with pointer focus.
      *
      * This will be null if no window has focus
      */
     Window *focus() const;
 
     /**
      * @brief The Decoration currently receiving events.
      * @return decoration with pointer focus.
      */
     Decoration::DecoratedClientImpl *decoration() const;
 
     virtual QPointF position() const = 0;
 
     void setFocus(Window *window);
     void setDecoration(Decoration::DecoratedClientImpl *decoration);
 
 Q_SIGNALS:
     void decorationChanged();
 
 protected:
     explicit InputDeviceHandler(InputRedirection *parent);
 
     virtual void cleanupDecoration(Decoration::DecoratedClientImpl *old, Decoration::DecoratedClientImpl *now) = 0;
 
     virtual void focusUpdate(Window *old, Window *now) = 0;
 
     /**
      * Certain input devices can be in a state of having no valid
      * position. An example are touch screens when no finger/pen
      * is resting on the surface (no touch point).
      */
     virtual bool positionValid() const
     {
         return true;
     }
     virtual bool focusUpdatesBlocked()
     {
         return false;
     }
 
     inline bool inited() const
     {
         return m_inited;
     }
     inline void setInited(bool set)
     {
         m_inited = set;
     }
 
 private:
     bool setHover(Window *window);
     void updateFocus();
     void updateDecoration();
 
     struct
     {
         QPointer<Window> window;
         QMetaObject::Connection surfaceCreatedConnection;
     } m_hover;
 
     struct
     {
         QPointer<Window> window;
         QPointer<Decoration::DecoratedClientImpl> decoration;
     } m_focus;
 
     bool m_inited = false;
 };
 
 inline InputRedirection *input()
 {
     return InputRedirection::s_self;
 }
 
 inline QList<InputDevice *> InputRedirection::devices() const
 {
     return m_inputDevices;
 }
 
 } // namespace KWin
 
 Q_DECLARE_METATYPE(KWin::InputRedirection::KeyboardKeyState)
 Q_DECLARE_METATYPE(KWin::InputRedirection::PointerButtonState)
 Q_DECLARE_METATYPE(KWin::InputRedirection::PointerAxis)
 Q_DECLARE_METATYPE(KWin::InputRedirection::PointerAxisSource)