GHOST_Wintab.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2021-2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
/* Wacom's Wintab documentation is periodically offline, moved, and increasingly hidden away. You
 * can find a (painstakingly) archived copy of the documentation at
 * https://web.archive.org/web/20201122230125/https://developer-docs-legacy.wacom.com/display/DevDocs/Windows+Wintab+Documentation
 */
 
#pragma once
 
#include <memory>
#include <stdio.h>
#include <vector>
#include <wtypes.h>
 
#include "GHOST_Types.h"
 
#include <wintab.h>
/* PACKETDATA and PACKETMODE modify structs in pktdef.h, so make sure they come first. */
#define PACKETDATA \
  (PK_BUTTONS | PK_NORMAL_PRESSURE | PK_ORIENTATION | PK_CURSOR | PK_X | PK_Y | PK_TIME)
#define PACKETMODE 0
#include <pktdef.h>
 
#if !defined(_MSVC_TRADITIONAL) || _MSVC_TRADITIONAL
#  define WINTAB_PRINTF(x, ...) \
    { \
      if (GHOST_Wintab::getDebug()) { \
        printf(x, __VA_ARGS__); \
      } \
    } \
    (void)0
#else
#  define WINTAB_PRINTF(x, ...) \
    { \
      if (GHOST_Wintab::getDebug()) { \
        printf(x, ##__VA_ARGS__); \
      } \
    } \
    (void)0
#endif
 
/* Typedefs for Wintab functions to allow dynamic loading. */
typedef UINT(API *GHOST_WIN32_WTInfo)(UINT, UINT, LPVOID);
typedef BOOL(API *GHOST_WIN32_WTGet)(HCTX, LPLOGCONTEXTA);
typedef BOOL(API *GHOST_WIN32_WTSet)(HCTX, LPLOGCONTEXTA);
typedef HCTX(API *GHOST_WIN32_WTOpen)(HWND, LPLOGCONTEXTA, BOOL);
typedef BOOL(API *GHOST_WIN32_WTClose)(HCTX);
typedef int(API *GHOST_WIN32_WTPacketsGet)(HCTX, int, LPVOID);
typedef int(API *GHOST_WIN32_WTQueueSizeGet)(HCTX);
typedef BOOL(API *GHOST_WIN32_WTQueueSizeSet)(HCTX, int);
typedef BOOL(API *GHOST_WIN32_WTEnable)(HCTX, BOOL);
typedef BOOL(API *GHOST_WIN32_WTOverlap)(HCTX, BOOL);
 
/* Typedefs for Wintab and Windows resource management. */
typedef std::unique_ptr<std::remove_pointer_t<HMODULE>, decltype(&::FreeLibrary)> unique_hmodule;
typedef std::unique_ptr<std::remove_pointer_t<HCTX>, GHOST_WIN32_WTClose> unique_hctx;
 
struct GHOST_WintabInfoWin32 {
  int32_t x = 0;
  int32_t y = 0;
  GHOST_TEventType type = GHOST_kEventCursorMove;
  GHOST_TButton button = GHOST_kButtonMaskNone;
  uint64_t time = 0;
  GHOST_TabletData tabletData = GHOST_TABLET_DATA_NONE;
};
 
class GHOST_Wintab {
 public:
  static GHOST_Wintab *loadWintab(HWND hwnd);
 
  ~GHOST_Wintab();

  void enable();

  void disable();

  void gainFocus();

  void loseFocus();

  void leaveRange();

  void remapCoordinates();

  void mapWintabToSysCoordinates(int x_in, int y_in, int &x_out, int &y_out);

  void updateCursorInfo();

  void processInfoChange(LPARAM lParam);

  bool devicesPresent();

  void getInput(std::vector<GHOST_WintabInfoWin32> &outWintabInfo);

  bool trustCoordinates();

  bool testCoordinates(int sysX, int sysY, int wtX, int wtY);

  GHOST_TabletData getLastTabletData();
 
  /* Sets Wintab debugging.
   * \param debug: True to enable Wintab debugging.
   */
  static void setDebug(bool debug);
 
  /* Returns whether Wintab logging should occur.
   * \return True if Wintab logging should occur.
   */
  static bool getDebug();
 
 private:
  unique_hmodule m_handle;
  GHOST_WIN32_WTInfo m_fpInfo = nullptr;
  GHOST_WIN32_WTGet m_fpGet = nullptr;
  GHOST_WIN32_WTSet m_fpSet = nullptr;
  GHOST_WIN32_WTPacketsGet m_fpPacketsGet = nullptr;
  GHOST_WIN32_WTEnable m_fpEnable = nullptr;
  GHOST_WIN32_WTOverlap m_fpOverlap = nullptr;

  unique_hctx m_context;
  bool m_enabled = false;
  bool m_focused = false;

  DWORD m_buttons = 0;

  struct Range {
    int org = 0;
    int ext = 1;
  };

  struct Coord {
    Range x = {};
    Range y = {};
  };
  bool m_coordTrusted = false;
  Coord m_tabletCoord = {};
  Coord m_systemCoord = {};
 
  int m_maxPressure = 0;
  int m_maxAzimuth = 0;
  int m_maxAltitude = 0;

  UINT m_numDevices = 0;
  std::vector<PACKET> m_pkts;
  GHOST_TabletData m_lastTabletData = GHOST_TABLET_DATA_NONE;

  static bool m_debug;
 
  GHOST_Wintab(unique_hmodule handle,
               GHOST_WIN32_WTInfo info,
               GHOST_WIN32_WTGet get,
               GHOST_WIN32_WTSet set,
               GHOST_WIN32_WTPacketsGet packetsGet,
               GHOST_WIN32_WTEnable enable,
               GHOST_WIN32_WTOverlap overlap,
               unique_hctx hctx,
               Coord tablet,
               Coord system,
               size_t queueSize);

  GHOST_TButton mapWintabToGhostButton(UINT cursor, WORD physicalButton);

  static void modifyContext(LOGCONTEXT &lc);

  static void extractCoordinates(LOGCONTEXT &lc, Coord &tablet, Coord &system);
 
  /* Prints Wintab Context information. */
  void printContextDebugInfo();
};