plover 5.0.0.dev3__tar.gz → 5.1.0__tar.gz

{plover-5.0.0.dev3 → plover-5.1.0}/LICENSE.txt

@@ -2,7 +2,7 @@
                        Version 2, June 1991
 
  Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.
 
@@ -304,8 +304,7 @@ the "copyright" line and a pointer to where the full notice is found.
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License along
-    with this program; if not, write to the Free Software Foundation, Inc.,
-    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+    with this program; if not, see <https://www.gnu.org/licenses/>.
 
 Also add information on how to contact you by electronic and paper mail.
 
@@ -329,8 +328,8 @@ necessary.  Here is a sample; alter the names:
   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
   `Gnomovision' (which makes passes at compilers) written by James Hacker.
 
-  <signature of Ty Coon>, 1 April 1989
-  Ty Coon, President of Vice
+  <signature of Moe Ghoul>, 1 April 1989
+  Moe Ghoul, President of Vice
 
 This General Public License does not permit incorporating your program into
 proprietary programs.  If your program is a subroutine library, you may

{plover-5.0.0.dev3 → plover-5.1.0}/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

{plover-5.0.0.dev3 → plover-5.1.0}/NEWS.md

@@ -1,3 +1,64 @@
+# v5.1.0 (2025-11-04)
+
+
+## Features
+
+### Core
+
+- Add support for Plover HID protocol based on plover-machine-hid plugin by dnaq. (#1777)
+
+### User Interface
+
+- Dynamically update individual status icons while loading dictionaries. (#1400)
+
+### macOS
+
+- Add code signing and notarization for macOS app. (#1769)
+
+## Bugfixes
+
+### Core
+
+- Update frontmatter in GPLv2 license file; no substantive change to the license (#1779)
+
+## API
+
+No significant changes.
+
+# v5.0.0 (2025-09-10)
+
+
+## Features
+
+No significant changes.
+
+## Bugfixes
+
+No significant changes.
+
+## API
+
+No significant changes.
+
+# v5.0.0rc1 (2025-09-02)
+
+
+## Features
+
+### Linux
+
+- Refactor Uinput to use pipe instead of select with timeout. (#1760)
+- Passthrough keyboard shortcuts. (#1761)
+- Uinput: refactor initialization and cleanup. (#1765)
+
+## Bugfixes
+
+No significant changes.
+
+## API
+
+No significant changes.
+
 # v5.0.0.dev3 (2025-07-14)
 
 

{plover-5.0.0.dev3/plover.egg-info → plover-5.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plover
-Version: 5.0.0.dev3
+Version: 5.1.0
 Summary: Open Source Stenography Software
 Home-page: http://www.openstenoproject.org/
 Download-URL: http://www.openstenoproject.org/plover
@@ -35,6 +35,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: appdirs
 Requires-Dist: appnope; "darwin" in sys_platform
+Requires-Dist: hid
 Requires-Dist: pkginfo
 Requires-Dist: plover-stroke
 Requires-Dist: plyer; "win32" in sys_platform

{plover-5.0.0.dev3 → plover-5.1.0}/doc/ci.md

@@ -123,13 +123,8 @@ jobs completed successfully.
 ### PyPI release
 
 On *tagged* release, the source distribution and wheel are published
-to PyPI.
+to PyPI via [Trusted Publishing](https://docs.pypi.org/trusted-publishers/).
 
-For this to work, a valid [PyPI token](https://pypi.org/help/#apitoken)
-must be configured: the `PYPI_TOKEN` secret of the `release`
-[environment](https://docs.github.com/en/actions/reference/environments)
-will be used. Additionally, the optional `PYPI_URL` secret can be set to
-use another PyPI compatible index (e.g. Test PyPI).
 
 ### GitHub release
 

{plover-5.0.0.dev3 → plover-5.1.0}/doc/conf.py

@@ -6,7 +6,7 @@ project = "Plover"
 copyright = "Open Steno Project"
 author = copyright
 
-release = "5.0.0.dev3"
+release = "5.1.0"
 version = release
 
 # -- General configuration ---------------------------------------------------

{plover-5.0.0.dev3 → plover-5.1.0}/doc/developer_guide.md

@@ -13,9 +13,12 @@ environment created using tools like [venv](https://docs.python.org/3/library/ve
 This helps keep your global Python environment clean, avoids project conflicts, and
 isolates tox and its dependencies.
 
-A typical setup looks like this:
+You also need [CMake](https://cmake.org) to build [hidapi](https://github.com/libusb/hidapi) from source which is required for Plover HID support.
+
+A typical development setup looks like this, assuming that `python` has the correct version:
 
 ### Linux/macOS (Bash):
+
 ```bash
 cd path/to/plover
 python -m venv .venv
@@ -24,9 +27,13 @@ pip install -r reqs/dev.txt
 pre-commit install
 pre-commit run --all-files
 tox
+tox -e launch -- -l debug
 ```
 
 ### Windows (PowerShell):
+
+This assumes that you installed a Git version that includes Git Bash.
+
 ```powershell
 cd path\to\plover
 python -m venv .venv
@@ -34,9 +41,11 @@ python -m venv .venv
 pip install -r reqs\dev.txt
 pre-commit install
 pre-commit run --all-files
-tox
+& "C:\Program Files\Git\bin\bash.exe" -lc "tox"
+& "C:\Program Files\Git\bin\bash.exe" -lc "tox -e launch -- -l debug"
 ```
-Some features require a Bash shell, so on Windows you may need to use Git Bash or WSL instead of PowerShell.
+
+Some features require a Bash shell, which is why on Windows you need to run commands through Git Bash or similar.
 
 ## Tox
 

{plover-5.0.0.dev3 → plover-5.1.0}/doc/plugins.md

@@ -39,12 +39,13 @@ There are two ways to install plugins:
 
   Plover comes with the following machine plugins installed:
 
-  - Keyboard
   - Gemini PR
-  - TX Bolt
+  - Keyboard
   - Passport
+  - Plover HID
   - ProCAT
   - Stentura
+  - TX Bolt
 
 - **Systems**: Define new key layouts and theories. This lets Plover support
   stenographic layouts other than the standard American Stenotype system,

{plover-5.0.0.dev3 → plover-5.1.0}/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"
+
+. ./linux/build_hidapi.sh
+
+echo "Downloading and unpacking hidapi ${hidapi_version}…"
+fetch_hidapi "$hidapi_src" "$builddir"
+
+echo "Building hidapi…"
+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"
 

plover-5.1.0/linux/build_hidapi.sh

@@ -0,0 +1,8 @@
+cmake_build_linux() {
+  local src="$1" bld="$2" config="${3:-Release}"
+  rm -rf "$bld"
+  cmake -S "$src" -B "$bld" \
+    -DBUILD_SHARED_LIBS=ON \
+    -DCMAKE_BUILD_TYPE="$config"
+  cmake --build "$bld" --config "$config" --parallel
+}

plover-5.1.0/osx/build_hidapi.sh

@@ -0,0 +1,9 @@
+cmake_build_macos() {
+  local src="$1" bld="$2" arches="$3" config="${4:-Release}"
+  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
+}

{plover-5.0.0.dev3 → plover-5.1.0}/osx/make_app.sh

@@ -2,6 +2,7 @@
 
 set -e
 
+. ./plover_build_utils/deps.sh
 . ./plover_build_utils/functions.sh
 
 topdir="$PWD"
@@ -14,6 +15,7 @@ plover_wheel="$1"
 . ./osx/deps.sh
 
 py_version="$py_installer_version"
+bundle_id="org.openstenoproject.plover"
 
 echo "Making Plover.app with Plover wheel $plover_wheel."
 
@@ -34,23 +36,29 @@ py_binary="$py_home/bin/python${py_version%.*}"
 
 # Extract Python binary from launcher and fix its references.
 run mv "$py_home/Resources/Python.app/Contents/MacOS/Python" "$py_binary"
-run install_name_tool -rpath "@executable_path/../../../../../../" "@executable_path/../../../" "$py_binary"
-# Remove the codesignature so that we can change the identifier for notifications.
-run /usr/bin/codesign -s - --deep --force "$py_binary"
-run tee "$py_home/bin/Info.plist" <<\EOF
+
+echo "Rewrite runtime search path of Python binary with install_name_tool..."
+run_quiet install_name_tool -rpath "@executable_path/../../../../../../" "@executable_path/../../../" "$py_binary"
+echo "Rewrite runtime search path complete"
+
+echo "Ad-hoc signing the Python binary after install_name_tool invalidated signature..."
+run_quiet /usr/bin/codesign -s - --force "$py_binary"
+echo "Ad-hoc signing complete"
+
+run tee "$py_home/bin/Info.plist" <<EOF
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
     <key>CFBundleIdentifier</key>
-    <string>org.openstenoproject.plover</string>
+    <string>${bundle_id}</string>
 </dict>
 </plist>
 EOF
 
 # Switch to target Python.
 SSL_CERT_FILE="$("$python" -m certifi)"
-run_eval "appdir_python() { env PYTHONNOUSERSITE=1 "$py_home/bin/python" \"\$@\"; }"
+run_eval "appdir_python() { env PYTHONNOUSERSITE=1 \"$py_home/bin/python\" \"\$@\"; }"
 run_eval "export SSL_CERT_FILE='$SSL_CERT_FILE'"
 run_eval "unset __PYVENV_LAUNCHER__"
 python='appdir_python'
@@ -58,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"
+
+echo "Downloading and unpacking hidapi ${hidapi_version}…"
+fetch_hidapi "$hidapi_src" "$builddir"
+
+echo "Building hidapi…"
+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"
 
@@ -87,4 +126,5 @@ run "$python" -I -m plover_build_utils.check_requirements
 # Ad-hoc signing to satisfy Gatekeeper.
 run /usr/bin/codesign -s - --deep --force "$appdir"
 
+# Move the finished app to dist.
 run mv "$appdir" "$distdir"

plover-5.1.0/osx/make_dmg.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+topdir="$PWD"
+
+. ./plover_build_utils/functions.sh
+
+PLATFORM="${1:-}"
+PACKAGE="${2:-}"
+if [[ -z "$PLATFORM" || -z "$PACKAGE" ]]; then
+  echo "❌ Usage: $0 <platform-string> <package>" >&2
+  echo "   e.g.: $0 macosx_12_0_universal2 plover-5.0.0" >&2
+  exit 1
+fi
+
+APP="$topdir/dist/Plover.app"
+[[ -d "$APP" ]] || { echo "❌ App not found: $APP. Run bdist_app first."; exit 1; }
+
+DMG="$topdir/dist/${PACKAGE}-${PLATFORM}.dmg"
+
+# Build DMG via dmgbuild
+echo "Building DMG → $DMG"
+python3 -m dmgbuild -s osx/dmg_resources/settings.py "Plover" "$DMG"

plover-5.1.0/osx/notarize_app.sh

@@ -0,0 +1,78 @@
+#!/usr/bin/env bash
+set -e
+
+# Sign and notarize + staple a .dmg image.
+# Enabled with:
+#   MACOS_NOTARIZE_ENABLED=1
+# Required envs when notarization is enabled:
+#   MACOS_CODESIGN_IDENTITY
+#   MACOS_NOTARIZE_TEAM_ID
+#   MACOS_NOTARIZE_KEY_ID
+#   MACOS_NOTARIZE_ISSUER_ID
+#   MACOS_NOTARIZE_KEY_CONTENTS
+# Optional:
+#   MACOS_CODESIGN_KEYCHAIN, e.g. plover-dev.keychain
+
+topdir="$PWD"
+builddir="$topdir/build/osxapp"
+APP="$topdir/dist/Plover.app"
+
+notarize_enabled="${MACOS_NOTARIZE_ENABLED:-0}"
+if [[ "$notarize_enabled" != "1" ]]; then
+  echo "ℹ️ Skipping notarization of $APP (MACOS_NOTARIZE_ENABLED=$notarize_enabled)"
+  return 0
+fi
+
+. ./plover_build_utils/functions.sh
+. ./osx/notarize_common.sh
+
+# --- Codesign ---
+require_env MACOS_CODESIGN_IDENTITY
+echo "Signing with identity: $MACOS_CODESIGN_IDENTITY ..."
+# Make sure the build directory exists for the entitlements file
+mkdir -p "$builddir"
+ent_plist="$builddir/entitlements.plist"
+cat >"$ent_plist" <<'EOS'
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>com.apple.security.cs.disable-library-validation</key><true/>
+</dict>
+</plist>
+EOS
+
+# Build common codesign args
+cs_args=(--force --timestamp --options runtime --entitlements "$ent_plist" -s "$MACOS_CODESIGN_IDENTITY")
+if [[ -n "${MACOS_CODESIGN_KEYCHAIN:-}" ]]; then
+  cs_args+=(--keychain "$MACOS_CODESIGN_KEYCHAIN")
+  echo "Using keychain: $MACOS_CODESIGN_KEYCHAIN"
+fi
+
+# 1) Sign all Mach-O binaries first: *.dylib, *.so, and the actual executables inside
+#    framework Versions directories. This ensures their _CodeSignature folders exist
+#    before we sign the framework bundle itself, preventing resource seal mismatches.
+while IFS= read -r -d '' f; do
+  run_quiet /usr/bin/codesign "${cs_args[@]}" "$f"
+done < <(find "$APP/Contents" -type f \
+            \( -name "*.dylib" -o -name "*.so" -o \
+               \( -path "*/*.framework/Versions/*" -perm -111 \) \
+            \) -print0)
+
+# 2) Now sign framework bundles depth-first, after their contents are signed.
+while IFS= read -r -d '' fw; do
+  run_quiet /usr/bin/codesign "${cs_args[@]}" "$fw"
+done < <(find "$APP/Contents" -depth -type d -name "*.framework" -print0)
+
+# 3) Sign the main executable and then the app bundle.
+run_quiet /usr/bin/codesign "${cs_args[@]}" "$APP/Contents/MacOS/Plover"
+run_quiet /usr/bin/codesign "${cs_args[@]}" "$APP"
+
+echo "Verifying signature..."
+run_quiet /usr/bin/codesign --verify --deep --strict "$APP"
+run_quiet /usr/bin/codesign --verify --deep --strict "$APP/Contents/Frameworks/Python.framework"
+echo "✅ Code signing complete"
+# --- End codesign ---
+
+# Notarize & staple app
+notarize_and_staple "$APP"

plover-5.1.0/osx/notarize_common.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+notarize_and_staple() {
+  local path=$1
+  require_env MACOS_NOTARIZE_TEAM_ID
+  require_env MACOS_NOTARIZE_KEY_ID
+  require_env MACOS_NOTARIZE_ISSUER_ID
+  require_env MACOS_NOTARIZE_KEY_CONTENTS
+
+  local workdir; workdir="$(mktemp -d)"; trap 'rm -rf "$workdir"' RETURN
+  local zip="$workdir/$(basename "$path").zip"
+  echo "Zipping for notarization → $zip"
+  ditto -c -k --keepParent "$path" "$zip"
+
+  local key_path="$workdir/AuthKey_${MACOS_NOTARIZE_KEY_ID}.p8"
+  umask 077
+  printf '%s' "$MACOS_NOTARIZE_KEY_CONTENTS" > "$key_path"
+
+  echo "Submitting to notary service (team=$MACOS_NOTARIZE_TEAM_ID, key_id=$MACOS_NOTARIZE_KEY_ID)…"
+  xcrun notarytool submit "$zip" \
+    --key "$key_path" \
+    --key-id "$MACOS_NOTARIZE_KEY_ID" \
+    --issuer "$MACOS_NOTARIZE_ISSUER_ID" \
+    --team-id "$MACOS_NOTARIZE_TEAM_ID" \
+    --wait --timeout 20m --progress
+
+  echo "Stapling ticket to $path..."
+  xcrun stapler staple "$path"
+  echo "Validating staple for $path..."
+  xcrun stapler validate "$path"
+  echo "✅ Notarization complete for $path"
+}

plover-5.1.0/osx/notarize_dmg.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+set -e
+
+# Sign and notarize + staple a .dmg image.
+# Enabled with:
+#   MACOS_NOTARIZE_ENABLED=1
+# Required envs when notarization is enabled:
+#   MACOS_CODESIGN_IDENTITY
+#   MACOS_NOTARIZE_TEAM_ID
+#   MACOS_NOTARIZE_KEY_ID
+#   MACOS_NOTARIZE_ISSUER_ID
+#   MACOS_NOTARIZE_KEY_CONTENTS
+# Optional:
+#   MACOS_CODESIGN_KEYCHAIN, e.g. plover-dev.keychain
+
+dmg_path="${1:-}"
+if [[ -z "$dmg_path" || ! -f "$dmg_path" ]]; then
+  echo "❌ Usage: $0 /path/to/file.dmg" >&2
+  exit 1
+fi
+
+. ./plover_build_utils/functions.sh
+. ./osx/notarize_common.sh
+
+notarize_enabled="${MACOS_NOTARIZE_ENABLED:-0}"
+if [[ "$notarize_enabled" != "1" ]]; then
+  echo "ℹ️ Skipping DMG signing & notarization (MACOS_NOTARIZE_ENABLED=$notarize_enabled)"
+  exit 0
+fi
+
+# --- Codesign ---
+require_env MACOS_CODESIGN_IDENTITY
+echo "Signing with identity $MACOS_CODESIGN_IDENTITY: $dmg_path"
+
+cs_args=(--force --timestamp -s "$MACOS_CODESIGN_IDENTITY")
+if [[ -n "${MACOS_CODESIGN_KEYCHAIN:-}" ]]; then
+  cs_args+=(--keychain "$MACOS_CODESIGN_KEYCHAIN")
+  echo "Using keychain: $MACOS_CODESIGN_KEYCHAIN"
+fi
+run_quiet /usr/bin/codesign "${cs_args[@]}" "$dmg_path"
+
+echo "✅ Code signing complete"
+# --- End codesign ---
+
+# Notarize & staple DMG
+notarize_and_staple "$dmg_path"
+
+echo "🎉 DMG ready: $dmg_path"

{plover-5.0.0.dev3 → plover-5.1.0}/plover/__init__.py

@@ -13,7 +13,7 @@ else:
     # want to translate anyway.
     _ = lambda s: s
 
-__version__ = "5.0.0.dev3"
+__version__ = "5.1.0"
 __copyright__ = "(C) Open Steno Project"
 __url__ = "http://www.openstenoproject.org/"
 __download_url__ = "http://www.openstenoproject.org/plover"

{plover-5.0.0.dev3 → plover-5.1.0}/plover/dictionary/loading_manager.py

@@ -7,13 +7,19 @@ import threading
 import time
 
 from plover.dictionary.base import load_dictionary
-from plover.exception import DictionaryLoaderException
 from plover.resource import resource_timestamp
 from plover import log
 
 
 class DictionaryLoadingManager:
-    def __init__(self):
+    def __init__(self, state_change_callback):
+        """
+        Parameters:
+        state_change_callback -- A function that will be called when any dictionary is loaded
+            with two parameters: the filename and the loaded StenoDictionary object
+            (or an instance of ErroredDictionary if the load fails).
+        """
+        self._state_change_callback = state_change_callback
         self.dictionaries = {}
 
     def __len__(self):
@@ -32,7 +38,7 @@ class DictionaryLoadingManager:
         log.info(
             "%s dictionary: %s", "loading" if op is None else "reloading", filename
         )
-        op = DictionaryLoadingOperation(filename)
+        op = DictionaryLoadingOperation(filename, self._state_change_callback)
         self.dictionaries[filename] = op
         return op
 
@@ -52,7 +58,15 @@ class DictionaryLoadingManager:
 
 
 class DictionaryLoadingOperation:
-    def __init__(self, filename):
+    def __init__(self, filename, state_change_callback):
+        """
+        Parameters:
+        filename -- Path to dictionary file.
+        state_change_callback -- A function that will be called when the load is finished
+            with two parameters: the filename and the loaded StenoDictionary object
+            (or an instance of ErroredDictionary if the load fails).
+        """
+        self._state_change_callback = state_change_callback
         self.loading_thread = threading.Thread(target=self.load)
         self.filename = filename
         self.result = None
@@ -87,8 +101,11 @@ class DictionaryLoadingOperation:
             self.result = load_dictionary(self.filename)
         except Exception as e:
             log.debug("loading dictionary %s failed", self.filename, exc_info=True)
-            self.result = DictionaryLoaderException(self.filename, e)
+            from plover.engine import ErroredDictionary
+
+            self.result = ErroredDictionary(self.filename, e)
             self.result.timestamp = timestamp
+        self._state_change_callback(self.filename, self.result)
 
     def get(self):
         self.loading_thread.join()