Revert "Revert back to hidapi module after finding fix for macOS exclusive mode"

This reverts commit 8a86159.

Author: mkrnr

MANIFEST.in

@@ -33,6 +33,7 @@ include test/*.py
 include test/gui_qt/*.py
 include tox.ini
 include windows/*
+exclude dev/*
 exclude .pre-commit-config.yaml
 # without first including it, exluding .readthedocs.yml results in a warning when running locally
 include .readthedocs.yml

dev/build_hidapi.sh

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Build hidapi library locally for development.
+#
+# Usage:
+#   ./dev/macos_dev_setup.sh
+#   MACOS_UNIVERSAL2=0 ./dev/build_hidapi.sh      # macOS: don't build universal2
+#
+# Resulting libs:
+#   macOS:   build/local-hidapi/macos/lib/libhidapi*.dylib
+#   Linux:   build/local-hidapi/linux/lib/libhidapi-hidraw.so
+#   Windows: build/local-hidapi/windows/bin/hidapi.dll
+
+. ./plover_build_utils/deps.sh
+
+MACOS_UNIVERSAL2="${MACOS_UNIVERSAL2:-1}"
+
+# Resolve repo root relative to this script
+SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(cd -- "${SCRIPT_DIR}/.." && pwd)"
+
+WORK_DIR="${REPO_ROOT}/build/local-hidapi"
+SRC_DIR="${WORK_DIR}/src"
+BUILD_DIR="${WORK_DIR}/build"
+OUT_LIB_DIR_MAC="${WORK_DIR}/macos/lib"
+OUT_LIB_DIR_LNX="${WORK_DIR}/linux/lib"
+OUT_BIN_DIR_WIN="${WORK_DIR}/windows/bin"
+
+# Clean and prep
+# Prepare directories 
+mkdir -p "${SRC_DIR}" "${BUILD_DIR}"
+
+OS="$(uname -s || true)"
+# If outputs already exist for the current platform, skip rebuilding.
+if [[ "${OS}" == "Darwin" ]]; then
+  if ls "${OUT_LIB_DIR_MAC}"/libhidapi*.dylib >/dev/null 2>&1; then
+    echo "hidapi found at ${OUT_LIB_DIR_MAC}; skipping build."
+    exit 0
+  fi
+elif [[ "${OS}" == "Linux" ]]; then
+  if ls "${OUT_LIB_DIR_LNX}"/libhidapi-hidraw.so* >/dev/null 2>&1; then
+    echo "hidapi found at ${OUT_LIB_DIR_LNX}; skipping build."
+    exit 0
+  fi
+elif [[ "${OS}" == MINGW* || "${OS}" == MSYS* || "${OS}" == CYGWIN* || "${OS}" == "Windows_NT" ]]; then
+  if [ -f "${OUT_BIN_DIR_WIN}/hidapi.dll" ]; then
+    echo "hidapi found at ${OUT_BIN_DIR_WIN}/hidapi.dll; skipping build."
+    exit 0
+  fi
+fi
+
+# Clean and prep for a fresh build
+rm -rf "${SRC_DIR}" "${BUILD_DIR}"
+mkdir -p "${SRC_DIR}" "${BUILD_DIR}"
+
+TARBALL="${WORK_DIR}/hidapi-${HIDAPI_VERSION}.tar.gz"
+
+
+if [[ "${OS}" == "Darwin" ]]; then
+  echo "==> Configuring (macOS, IOHIDManager backend)"
+
+  # Shared fetch/build helpers (macOS)
+  # shellcheck disable=SC1091
+  . "${REPO_ROOT}/osx/build_hidapi.sh"
+
+  echo "==> Downloading & unpacking hidapi ${HIDAPI_VERSION}"
+  fetch_hidapi_macos "${HIDAPI_VERSION}" "${SRC_DIR}" "${TARBALL}"
+
+  mkdir -p "${OUT_LIB_DIR_MAC}"
+  # Architectures
+  if [[ "${MACOS_UNIVERSAL2}" == "1" ]]; then
+    OSX_ARCHES="x86_64;arm64"
+  else
+    ARCH="$(uname -m || true)"
+    if [[ "${ARCH}" == "arm64" || "${ARCH}" == "aarch64" ]]; then
+      OSX_ARCHES="arm64"
+    else
+      OSX_ARCHES="x86_64"
+    fi
+  fi
+
+  cmake_build_macos "${SRC_DIR}" "${BUILD_DIR}" "${OSX_ARCHES}" "RelWithDebInfo"
+
+  # Find produced dylib
+  DYLIB="$(/usr/bin/find "${BUILD_DIR}" -type f -name 'libhidapi*.dylib' -print -quit || true)"
+  if [[ -z "${DYLIB}" ]]; then
+    echo "Error: libhidapi*.dylib not found in build output." >&2
+    exit 3
+  fi
+
+  BASENAME="$(basename "${DYLIB}")"
+  echo "==> Staging ${BASENAME}"
+  cp -f "${DYLIB}" "${OUT_LIB_DIR_MAC}/${BASENAME}"
+
+  pushd "${OUT_LIB_DIR_MAC}" >/dev/null
+  ln -sf "${BASENAME}" libhidapi.dylib || true
+  popd >/dev/null
+
+  echo
+  echo "✅ Built macOS hidapi at: ${OUT_LIB_DIR_MAC}/${BASENAME}"
+
+elif [[ "${OS}" == "Linux" ]]; then
+  echo "==> Configuring (Linux, hidraw backend)"
+  mkdir -p "${OUT_LIB_DIR_LNX}"
+
+  # Shared fetch/build helpers (Linux)
+  # shellcheck disable=SC1091
+  . "${REPO_ROOT}/linux/build_hidapi.sh"
+
+  echo "==> Downloading & unpacking hidapi ${HIDAPI_VERSION}"
+  fetch_hidapi_linux "${HIDAPI_VERSION}" "${SRC_DIR}" "${TARBALL}"
+  cmake_build_linux "${SRC_DIR}" "${BUILD_DIR}" "RelWithDebInfo"
+
+  SO="$(/usr/bin/find "${BUILD_DIR}" -type f -name 'libhidapi-hidraw.so*' -print -quit || true)"
+  if [[ -z "${SO}" ]]; then
+    echo "Error: libhidapi-hidraw.so not found in build output." >&2
+    exit 3
+  fi
+
+  BASENAME="$(basename "${SO}")"
+  echo "==> Staging ${BASENAME}"
+  cp -f "${SO}" "${OUT_LIB_DIR_LNX}/${BASENAME}"
+
+  pushd "${OUT_LIB_DIR_LNX}" >/dev/null
+  [[ -e libhidapi-hidraw.so ]] || ln -sf "${BASENAME}" libhidapi-hidraw.so || true
+  popd >/dev/null
+
+  echo
+  echo "✅ Built Linux hidapi at: ${OUT_LIB_DIR_LNX}/${BASENAME}"
+
+elif [[ "${OS}" == MINGW* || "${OS}" == MSYS* || "${OS}" == CYGWIN* || "${OS}" == "Windows_NT" ]]; then
+  echo "==> Configuring (Windows, WinAPI backend)"
+  mkdir -p "${OUT_BIN_DIR_WIN}"
+
+  # Shared fetch/build helpers (Windows)
+  # shellcheck disable=SC1091
+  . "${REPO_ROOT}/windows/build_hidapi.sh"
+
+  echo "==> Downloading & unpacking hidapi ${HIDAPI_VERSION}"
+  fetch_hidapi_windows "${HIDAPI_VERSION}" "${SRC_DIR}" "${TARBALL}"
+
+  # Build shared DLL
+  cmake_build_windows "${SRC_DIR}" "${BUILD_DIR}" "Release"
+
+  # Find the produced DLL (varies by generator)
+  DLL="$(/usr/bin/find "${BUILD_DIR}" -type f \( -iname 'hidapi*.dll' -o -iname 'libhidapi*.dll' \) -print -quit 2>/dev/null || true)"
+  if [[ -z "${DLL}" ]]; then
+    echo "Error: hidapi DLL not found in build output." >&2
+    exit 3
+  fi
+
+  BASENAME="$(basename "${DLL}")"
+  echo "==> Staging ${BASENAME}"
+  cp -f "${DLL}" "${OUT_BIN_DIR_WIN}/hidapi.dll"
+
+  echo
+  echo "✅ Built Windows hidapi at: ${OUT_BIN_DIR_WIN}/hidapi.dll"
+else
+  echo "Unsupported OS: ${OS}. This helper currently supports macOS, Linux, and Windows." >&2
+  exit 4
+fi

dev/write_hidapi_pth.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+"""
+Write a .pth into site-packages that adds the local hidapi bin dir
+to the DLL search path on Windows via os.add_dll_directory.
+
+Usage (optional): write_hidapi_pth.py <repo_dir> <env_sitepackages_dir>
+"""
+
+from __future__ import annotations
+import sys
+from pathlib import Path
+
+
+def main(argv: list[str]) -> int:
+    if sys.platform != "win32":
+        # No-op outside Windows.
+        return 0
+
+    if len(argv) >= 3:
+        repo_dir = Path(argv[1]).resolve()
+        site_packages = Path(argv[2]).resolve()
+    else:
+        repo_dir = Path.cwd()
+        site_packages = Path(sys.prefix, "Lib", "site-packages")
+
+    dll_dir = repo_dir / "build" / "local-hidapi" / "windows" / "bin"
+    if not dll_dir.is_dir():
+        print(f"[hidapi .pth] skip: {dll_dir} does not exist", file=sys.stderr)
+        return 0
+
+    site_packages.mkdir(parents=True, exist_ok=True)
+    pth_path = site_packages / "plover_hidapi_add_dll_dir.pth"
+
+    # Keep it one line: .pth executes arbitrary Python on import.
+    code = (
+        "import os,sys;"
+        "p=r%r;"
+        "getattr(os,'add_dll_directory',lambda *_:None)(p) if sys.platform=='win32' else None\n"
+        % (str(dll_dir),)
+    )
+
+    try:
+        pth_path.write_text(code, encoding="utf-8")
+        print(f"[hidapi .pth] wrote {pth_path}")
+        return 0
+    except Exception as e:
+        print(f"[hidapi .pth] failed to write {pth_path}: {e}", file=sys.stderr)
+        return 2
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv))

linux/appimage/build.sh

@@ -2,6 +2,7 @@
 
 set -e
 
+. ./plover_build_utils/deps.sh
 . ./plover_build_utils/functions.sh
 
 topdir="$PWD"
@@ -196,6 +197,34 @@ run "$linuxdeploy" \
 # Install Plover and dependencies.
 bootstrap_dist "$wheel"
 
+# ------- Start: Build & bundle hidapi from source -------
+hidapi_src="$builddir/hidapi-src"
+hidapi_bld="$builddir/hidapi-build"
+hidapi_tar="$builddir/hidapi.tar.gz"
+
+. ./linux/build_hidapi.sh
+
+echo "Downloading and unpacking hidapi ${HIDAPI_VERSION}…"
+fetch_hidapi_linux "$HIDAPI_VERSION" "$hidapi_src" "$hidapi_tar"
+
+cmake_build_linux "$hidapi_src" "$hidapi_bld" "Release"
+
+# Locate the produced .so
+hidapi_so="$(find "$hidapi_bld" -name 'libhidapi-hidraw.so*' -type f -print -quit)"
+if [ -z "$hidapi_so" ] || [ ! -f "$hidapi_so" ]; then
+  echo "Error: built libhidapi-hidraw.so not found." >&2
+  exit 3
+fi
+
+# Bundle into the AppDir's lib directory
+run cp -v "$hidapi_so" "$appdir/usr/lib/"
+base="$(basename "$hidapi_so")"
+# Add symlink for unversioned .so if needed
+if [ ! -e "$appdir/usr/lib/libhidapi-hidraw.so" ]; then
+  ln -s "$base" "$appdir/usr/lib/libhidapi-hidraw.so"
+fi
+# ------- End: Build & bundle hidapi from source -------
+
 # Trim the fat, second pass.
 run "$python" -m plover_build_utils.trim "$appdir" "$builddir/blacklist.txt"
 

linux/build_hidapi.sh

@@ -0,0 +1,21 @@
+need() { command -v "$1" >/dev/null 2>&1 || { echo "Error: '$1' not found" >&2; exit 2; }; }
+
+fetch_hidapi_linux() {
+  local version="$1" src_dir="$2" tarball="$3"
+  local url="https://github.com/libusb/hidapi/archive/refs/tags/hidapi-${version}.tar.gz"
+  need curl; need tar
+  rm -rf "$src_dir"
+  mkdir -p "$src_dir"
+  curl -fsSL "$url" -o "$tarball"
+  tar -xzf "$tarball" -C "$src_dir" --strip-components=1
+}
+
+cmake_build_linux() {
+  local src="$1" bld="$2" config="${3:-Release}"
+  need cmake
+  rm -rf "$bld"
+  cmake -S "$src" -B "$bld" \
+    -DBUILD_SHARED_LIBS=ON \
+    -DCMAKE_BUILD_TYPE="$config"
+  cmake --build "$bld" --config "$config" --parallel
+}

osx/build_hidapi.sh

@@ -0,0 +1,22 @@
+need() { command -v "$1" >/dev/null 2>&1 || { echo "Error: '$1' not found" >&2; exit 2; }; }
+
+fetch_hidapi_macos() {
+  local version="$1" src_dir="$2" tarball="$3"
+  local url="https://github.com/libusb/hidapi/archive/refs/tags/hidapi-${version}.tar.gz"
+  need curl; need tar
+  rm -rf "$src_dir"
+  mkdir -p "$src_dir"
+  curl -fsSL "$url" -o "$tarball"
+  tar -xzf "$tarball" -C "$src_dir" --strip-components=1
+}
+
+cmake_build_macos() {
+  local src="$1" bld="$2" arches="$3" config="${4:-Release}"
+  need cmake
+  rm -rf "$bld"
+  cmake -S "$src" -B "$bld" \
+    -DBUILD_SHARED_LIBS=ON \
+    -DCMAKE_BUILD_TYPE="$config" \
+    -DCMAKE_OSX_ARCHITECTURES="$arches"
+  cmake --build "$bld" --config "$config" --parallel
+}

osx/make_app.sh

@@ -2,6 +2,7 @@
 
 set -e
 
+. ./plover_build_utils/deps.sh
 . ./plover_build_utils/functions.sh
 
 topdir="$PWD"
@@ -65,6 +66,37 @@ python='appdir_python'
 # Install Plover and dependencies.
 bootstrap_dist "$plover_wheel"
 
+# ------- Start: Build & bundle hidapi from source  -------
+. ./osx/build_hidapi.sh
+
+hidapi_src="$builddir/hidapi-src"
+hidapi_bld="$builddir/hidapi-build"
+hidapi_tar="$builddir/hidapi.tar.gz"
+
+echo "Downloading and unpacking hidapi ${HIDAPI_VERSION}…"
+fetch_hidapi_macos "$HIDAPI_VERSION" "$hidapi_src" "$hidapi_tar"
+
+cmake_build_macos "$hidapi_src" "$hidapi_bld" "x86_64;arm64" "Release"
+
+# Locate the produced dylib
+hidapi_dylib="$(/usr/bin/find "$hidapi_bld" -name 'libhidapi*.dylib' -type f -print -quit)"
+if [ -z "$hidapi_dylib" ] || [ ! -f "$hidapi_dylib" ]; then
+  echo "Error: built libhidapi*.dylib not found." >&2
+  exit 3
+fi
+
+# Bundle into the app's Frameworks directory
+run cp "$hidapi_dylib" "$frameworks_dir/"
+base="$(basename "$hidapi_dylib")"
+
+# Add alias to Frameworks dir
+ln -sfn "$base" "$frameworks_dir/libhidapi.dylib"
+
+# Add RPATH to the Python binary itself and re-sign it
+run install_name_tool -add_rpath "@executable_path/../../../../../Frameworks" "$py_binary"
+run /usr/bin/codesign -f -s - "$py_binary"
+# ------- End: Build & bundle hidapi from source  -------
+
 # Create launcher.
 run gcc -Wall -O2 -arch x86_64 -arch arm64 'osx/app_resources/plover_launcher.c' -o "$macos_dir/Plover"