/* * Deskflow -- mouse and keyboard sharing utility * SPDX-FileCopyrightText: (C) 2025 Deskflow Developers * SPDX-FileCopyrightText: (C) 2012 - 2016 Symless Ltd. * SPDX-FileCopyrightText: (C) 2004 Chris Schoeneman * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception */ #pragma once #include "deskflow/MouseTypes.h" #include "deskflow/OptionTypes.h" #include "mt/CondVar.h" #include "mt/Mutex.h" #include #include #define WIN32_LEAN_AND_MEAN #include class Event; class EventQueueTimer; class Thread; class IJob; class IScreenSaver; class IEventQueue; //! Microsoft Windows desk handling /*! Desks in Microsoft Windows are only remotely like desktops on X11 systems. A desk is another virtual surface for windows but desks impose serious restrictions: a thread can interact with only one desk at a time, you can't switch desks if the thread has any hooks installed or owns any windows, windows cannot exist on multiple desks at once, etc. Basically, they're useless except for running the login window or the screensaver, which is what they're used for. Deskflow must deal with them mainly because of the login window and screensaver but users can create their own desks and deskflow should work on those too. This class encapsulates all the desk nastiness. Clients of this object don't have to know anything about desks. */ class MSWindowsDesks { public: //! Constructor /*! \p isPrimary is true iff the desk is for a primary screen. \p screensaver points to a screensaver object and it's used only to check if the screensaver is active. The \p updateKeys job is adopted and is called when the key state should be updated in a thread attached to the current desk. \p hookLibrary must be a handle to the hook library. */ MSWindowsDesks(bool isPrimary, bool noHooks, const IScreenSaver *screensaver, IEventQueue *events, IJob *updateKeys); ~MSWindowsDesks(); //! @name manipulators //@{ //! Enable desk tracking /*! Enables desk tracking. While enabled, this object checks to see if the desk has changed and ensures that the hooks are installed on the new desk. \c setShape should be called at least once before calling \c enable. */ void enable(); //! Disable desk tracking /*! Disables desk tracking. \sa enable. */ void disable(); //! Notify of entering a desk /*! Prepares a desk for when the cursor enters it. */ void enter(); //! Notify of leaving a desk /*! Prepares a desk for when the cursor leaves it. */ void leave(HKL keyLayout); //! Notify of options changes /*! Resets all options to their default values. */ void resetOptions(); //! Notify of options changes /*! Set options to given values. Ignores unknown options and doesn't modify options that aren't given in \c options. */ void setOptions(const OptionsList &options); //! Update the key state /*! Causes the key state to get updated to reflect the physical keyboard state and current keyboard mapping. */ void updateKeys(); //! Tell desk about new size /*! This tells the desks that the display size has changed. */ void setShape(int32_t x, int32_t y, int32_t width, int32_t height, int32_t xCenter, int32_t yCenter, bool isMultimon); //! Install/uninstall screensaver hooks /*! If \p install is true then the screensaver hooks are installed and, if desk tracking is enabled, updated whenever the desk changes. If \p install is false then the screensaver hooks are uninstalled. */ void installScreensaverHooks(bool install); //! Start ignoring user input /*! Starts ignoring user input so we don't pick up our own synthesized events. */ void fakeInputBegin(); //! Stop ignoring user input /*! Undoes whatever \c fakeInputBegin() did. */ void fakeInputEnd(); //@} //! @name accessors //@{ //! Get cursor position /*! Return the current position of the cursor in \c x and \c y. */ void getCursorPos(int32_t &x, int32_t &y) const; //! Fake key press/release /*! Synthesize a press or release of key \c button. */ void fakeKeyEvent(WORD virtualKey, WORD scanCode, DWORD flags, bool isAutoRepeat) const; //! Fake mouse press/release /*! Synthesize a press or release of mouse button \c id. */ void fakeMouseButton(ButtonID id, bool press); //! Fake mouse move /*! Synthesize a mouse move to the absolute coordinates \c x,y. */ void fakeMouseMove(int32_t x, int32_t y) const; //! Fake mouse move /*! Synthesize a mouse move to the relative coordinates \c dx,dy. */ void fakeMouseRelativeMove(int32_t dx, int32_t dy) const; //! Fake mouse wheel /*! Synthesize a mouse wheel event of amount \c delta in direction \c axis. */ void fakeMouseWheel(int32_t xDelta, int32_t yDelta) const; //@} private: class Desk { public: std::string m_name; Thread *m_thread; DWORD m_threadID; DWORD m_targetID; HDESK m_desk; HWND m_window; HWND m_foregroundWindow; bool m_lowLevel; }; using Desks = std::map; // initialization and shutdown operations HCURSOR createBlankCursor() const; void destroyCursor(HCURSOR cursor) const; ATOM createDeskWindowClass(bool isPrimary) const; void destroyClass(ATOM windowClass) const; HWND createWindow(ATOM windowClass, const char *name) const; void destroyWindow(HWND) const; // message handlers void deskMouseMove(int32_t x, int32_t y) const; void deskMouseRelativeMove(int32_t dx, int32_t dy) const; void deskEnter(Desk *desk); void deskLeave(Desk *desk, HKL keyLayout); void deskThread(void *vdesk); // desk switch checking and handling Desk *addDesk(const std::string &name, HDESK hdesk); void removeDesks(); void checkDesk(); bool isDeskAccessible(const Desk *desk) const; void handleCheckDesk(); // communication with desk threads void waitForDesk() const; void sendMessage(UINT, WPARAM, LPARAM) const; // work around for messed up keyboard events from low-level hooks HWND getForegroundWindow() const; // desk API wrappers HDESK openInputDesktop(); void closeDesktop(HDESK); std::string getDesktopName(HDESK); // our desk window procs static LRESULT CALLBACK primaryDeskProc(HWND, UINT, WPARAM, LPARAM); static LRESULT CALLBACK secondaryDeskProc(HWND, UINT, WPARAM, LPARAM); private: // true if screen is being used as a primary screen, false otherwise bool m_isPrimary; // true if hooks are not to be installed (useful for debugging) bool m_noHooks; // true if mouse has entered the screen bool m_isOnScreen; // our resources ATOM m_deskClass; HCURSOR m_cursor; // screen shape stuff int32_t m_x = 0; int32_t m_y = 9; int32_t m_w = 0; int32_t m_h = 0; int32_t m_xCenter = 0; int32_t m_yCenter = 0; // true if system appears to have multiple monitors bool m_multimon = false; // the timer used to check for desktop switching EventQueueTimer *m_timer = nullptr; // screen saver stuff DWORD m_threadID; const IScreenSaver *m_screensaver; bool m_screensaverNotify = false; // the current desk and it's name Desk *m_activeDesk = nullptr; std::string m_activeDeskName; // one desk per desktop and a cond var to communicate with it Mutex m_mutex; CondVar m_deskReady; Desks m_desks; // keyboard stuff IJob *m_updateKeys; HKL m_keyLayout; // options bool m_leaveForegroundOption; IEventQueue *m_events; };