MSWindowsDesks.h

Go to the documentation of this file.

/*
 * Deskflow -- mouse and keyboard sharing utility
 * SPDX-FileCopyrightText: (C) 2025 - 2026 Deskflow Developers
 * SPDX-FileCopyrightText: (C) 2012 - 2016 Synergy App 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 <map>
#include <string>
 
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
 
class Event;
class EventQueueTimer;
class Thread;
class IJob;
class IScreenSaver;
class IEventQueue;


class MSWindowsDesks
{
public:

  MSWindowsDesks(bool isPrimary, bool useHooks, const IScreenSaver *screensaver, IEventQueue *events, IJob *updateKeys);
  ~MSWindowsDesks();




  void enable();


  void disable();


  void enter();


  void leave(HKL keyLayout);


  void resetOptions();


  void setOptions(const OptionsList &options);


  void updateKeys();


  void setShape(int32_t x, int32_t y, int32_t width, int32_t height, int32_t xCenter, int32_t yCenter, bool isMultimon);


  void installScreensaverHooks(bool install);


  void fakeInputBegin();


  void fakeInputEnd();




  void getCursorPos(int32_t &x, int32_t &y) const;


  void fakeKeyEvent(WORD virtualKey, WORD scanCode, DWORD flags, bool isAutoRepeat) const;


  void fakeMouseButton(ButtonID id, bool press);


  void fakeMouseMove(int32_t x, int32_t y) const;


  void fakeMouseRelativeMove(int32_t dx, int32_t dy) const;


  void fakeMouseWheel(int32_t xDelta, int32_t yDelta) const;

 
private:
  class Desk
  {
  public:
    std::wstring m_name;
    Thread *m_thread;
    DWORD m_threadID;
    DWORD m_targetID;
    HDESK m_desk;
    HWND m_window;
    HWND m_foregroundWindow;
    bool m_lowLevel;
    bool m_hasRelativeRestorePosition = false;
    int32_t m_relativeRestoreX = 0;
    int32_t m_relativeRestoreY = 0;
  };
  using Desks = std::map<std::wstring, Desk *>;
 
  // 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 wchar_t *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 saveRelativeRestorePosition(Desk *desk) const;
  bool restoreRelativeCursorPosition(Desk *desk) const;
  void deskEnter(Desk *desk);
  void deskLeave(Desk *desk, HKL keyLayout);
  void deskThread(const void *vdesk);
 
  // desk switch checking and handling
  Desk *addDesk(const std::wstring &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::wstring 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 to be installed (when debugging, it can be useful to disable hooks)
  bool m_useHooks;
 
  // 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::wstring m_activeDeskName;
 
  // one desk per desktop and a cond var to communicate with it
  Mutex m_mutex;
  CondVar<bool> m_deskReady;
  Desks m_desks;
 
  // keyboard stuff
  IJob *m_updateKeys;
  HKL m_keyLayout;
 
  // options
  bool m_leaveForegroundOption;
  bool m_relativeMouseMoves = false;
 
  IEventQueue *m_events;
};