MSWindowsClipboard.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 Synergy App Ltd
 * SPDX-FileCopyrightText: (C) 2002 Chris Schoeneman
 * SPDX-License-Identifier: GPL-2.0-only WITH LicenseRef-OpenSSL-Exception
 */
 
#pragma once
 
#include "deskflow/IClipboard.h"
 
#include <mutex>
#include <vector>
 
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
 
class IMSWindowsClipboardConverter;
class IMSWindowsClipboardFacade;

class MSWindowsClipboard : public IClipboard
{
public:
  MSWindowsClipboard(HWND window);
  MSWindowsClipboard(HWND window, IMSWindowsClipboardFacade &facade);
  ~MSWindowsClipboard() override;


  bool emptyUnowned();

  static bool isOwnedByDeskflow();
 
  // IClipboard overrides
  bool empty() override;
  void add(Format, const std::string &data) override;
  bool open(Time) const override;
  void close() const override;
  Time getTime() const override;
  bool has(Format) const override;
  std::string get(Format) const override;
 
  void setFacade(IMSWindowsClipboardFacade &facade);
 
private:
  void clearConverters();
 
  UINT convertFormatToWin32(Format) const;
  HANDLE convertTextToWin32(const std::string &data) const;
  std::string convertTextFromWin32(HANDLE) const;
 
  static UINT getOwnershipFormat();
 
private:
  using ConverterList = std::vector<IMSWindowsClipboardConverter *>;
 
  HWND m_window;
  mutable std::mutex m_mutex;
  mutable Time m_time;
  ConverterList m_converters;
  static UINT s_ownershipFormat;
  IMSWindowsClipboardFacade *m_facade;
  bool m_deleteFacade;
};


class IMSWindowsClipboardConverter
{
public:
  virtual ~IMSWindowsClipboardConverter() = default;
  // accessors
 
  // return the clipboard format this object converts from/to
  virtual IClipboard::Format getFormat() const = 0;
 
  // return the atom representing the win32 clipboard format that
  // this object converts from/to
  virtual UINT getWin32Format() const = 0;
 
  // convert from the IClipboard format to the win32 clipboard format.
  // the input data must be in the IClipboard format returned by
  // getFormat().  the return data will be in the win32 clipboard
  // format returned by getWin32Format(), allocated by GlobalAlloc().
  virtual HANDLE fromIClipboard(const std::string &) const = 0;
 
  // convert from the win32 clipboard format to the IClipboard format
  // (i.e., the reverse of fromIClipboard()).
  virtual std::string toIClipboard(HANDLE data) const = 0;
};