Compare commits

..

9 Commits

34 changed files with 1916 additions and 121 deletions
+52 -1
View File
@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.24)
project(KSwitcher VERSION 0.6.36 LANGUAGES CXX RC)
project(KSwitcher VERSION 0.6.45 LANGUAGES CXX RC)
if(NOT WIN32)
message(FATAL_ERROR "KSwitcher uses native Windows APIs")
endif()
@@ -30,6 +30,15 @@ target_link_libraries(KSwitcherScrollTests PRIVATE kscore)
target_link_libraries(KSwitcherTests PRIVATE kscore)
add_executable(KSwitcherIntegration tests/integration.cpp src/screenshot_launcher.cpp src/screenshot_activation.cpp src/app.cpp src/screenshot_notifications.cpp src/screenshot.cpp src/configuration.cpp src/ui.cpp resources/app.rc)
target_link_libraries(KSwitcherIntegration PRIVATE kscore)
# Opt-in interactive fixture: requires an installed Far Manager.
add_executable(KSwitcherFarSnippetTests WIN32 tests/far_snippets.cpp src/screenshot_launcher.cpp src/screenshot_activation.cpp src/app.cpp src/screenshot_notifications.cpp src/screenshot.cpp src/configuration.cpp src/ui.cpp resources/app.rc)
target_link_libraries(KSwitcherFarSnippetTests PRIVATE kscore)
if(MSVC)
target_compile_options(KSwitcherFarSnippetTests PRIVATE /utf-8)
set_property(TARGET KSwitcherFarSnippetTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
else()
target_link_options(KSwitcherFarSnippetTests PRIVATE -municode -static -static-libgcc -static-libstdc++)
endif()
add_executable(KSwitcherInputTests tests/input.cpp src/screenshot_launcher.cpp src/screenshot_activation.cpp src/app.cpp src/screenshot_notifications.cpp src/screenshot.cpp src/configuration.cpp src/ui.cpp resources/app.rc)
target_link_libraries(KSwitcherInputTests PRIVATE kscore)
target_compile_definitions(KSwitcherInputTests PRIVATE KS_SCREENSHOT_RESOURCES)
@@ -48,6 +57,7 @@ else()
endif()
add_executable(KSwitcherOcrTests tests/ocr.cpp src/screenshot_launcher.cpp src/screenshot_activation.cpp src/app.cpp src/screenshot_notifications.cpp src/screenshot.cpp src/configuration.cpp src/ui.cpp resources/app.rc)
target_link_libraries(KSwitcherOcrTests PRIVATE kscore)
add_dependencies(KSwitcherOcrTests KSwitcherScreenshot)
if(MSVC)
set_property(TARGET kscore KSwitcher KSwitcherConfig KSwitcherScreenshot KSwitcherTests KSwitcherScrollTests KSwitcherIntegration KSwitcherInputTests KSwitcherOcrTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
target_compile_options(kscore PRIVATE /W4 /utf-8)
@@ -65,6 +75,40 @@ else()
target_link_options(KSwitcherOcrTests PRIVATE -static -static-libgcc -static-libstdc++)
endif()
enable_testing()
add_executable(KSwitcherHistoryHostTests tests/history_host.cpp)
target_link_libraries(KSwitcherHistoryHostTests PRIVATE kscore psapi)
set_target_properties(KSwitcherHistoryHostTests PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/history-host-fixture-$<CONFIG>")
add_dependencies(KSwitcherHistoryHostTests KSwitcher KSwitcherScreenshot)
add_custom_command(TARGET KSwitcherHistoryHostTests POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:KSwitcher>" "$<TARGET_FILE_DIR:KSwitcherHistoryHostTests>/KSwitcher.exe"
COMMAND ${CMAKE_COMMAND} -E copy "$<TARGET_FILE:KSwitcherScreenshot>" "$<TARGET_FILE_DIR:KSwitcherHistoryHostTests>/KSwitcher.Screenshot.exe"
COMMAND ${CMAKE_COMMAND} -E touch "$<TARGET_FILE_DIR:KSwitcherHistoryHostTests>/.local-dev")
if(MSVC)
target_compile_options(KSwitcherHistoryHostTests PRIVATE /utf-8)
set_property(TARGET KSwitcherHistoryHostTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
else()
target_link_options(KSwitcherHistoryHostTests PRIVATE -static -static-libgcc -static-libstdc++)
endif()
add_executable(KSwitcherClipboardSnapshotTests tests/clipboard_snapshot.cpp)
target_link_libraries(KSwitcherClipboardSnapshotTests PRIVATE kscore psapi)
add_dependencies(KSwitcherClipboardSnapshotTests KSwitcherScreenshot)
if(MSVC)
target_compile_options(KSwitcherClipboardSnapshotTests PRIVATE /utf-8)
set_property(TARGET KSwitcherClipboardSnapshotTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
else()
target_link_options(KSwitcherClipboardSnapshotTests PRIVATE -static -static-libgcc -static-libstdc++)
endif()
add_executable(KSwitcherImageCaptureTests tests/image_capture.cpp)
target_link_libraries(KSwitcherImageCaptureTests PRIVATE kscore)
add_dependencies(KSwitcherImageCaptureTests KSwitcherScreenshot)
if(MSVC)
target_compile_options(KSwitcherImageCaptureTests PRIVATE /utf-8)
set_property(TARGET KSwitcherImageCaptureTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
else()
target_link_options(KSwitcherImageCaptureTests PRIVATE -static -static-libgcc -static-libstdc++)
endif()
# Explicit interactive test: stop the resident first so its clipboard listener
# does not capture the test fixtures. Like KSwitcherIntegration, not part of ctest.
add_executable(KSwitcherDictionaryTests tests/dictionary.cpp)
target_link_libraries(KSwitcherDictionaryTests PRIVATE kscore psapi)
if(MSVC)
@@ -76,6 +120,13 @@ add_test(NAME dictionary-regressions COMMAND KSwitcherDictionaryTests)
set_tests_properties(dictionary-regressions PROPERTIES WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}")
add_test(NAME sync-regressions COMMAND KSwitcherSyncTests)
add_test(NAME native-regressions COMMAND KSwitcherTests)
add_executable(KSwitcherUtilitiesTests tests/utilities.cpp)
if(MSVC)
set_property(TARGET KSwitcherUtilitiesTests PROPERTY MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
else()
target_link_options(KSwitcherUtilitiesTests PRIVATE -static -static-libgcc -static-libstdc++)
endif()
add_test(NAME utilities-regressions COMMAND KSwitcherUtilitiesTests)
add_test(NAME scroll-regressions COMMAND KSwitcherScrollTests)
add_test(NAME input-regressions COMMAND KSwitcherInputTests)
add_test(NAME screenshot-ui-regressions COMMAND KSwitcherScreenshotUITests)
+54
View File
@@ -75,6 +75,9 @@ Ctrl+Alt+Delete and Win+L; these cannot be assigned.
Keyboard and mouse input forwarded by Microsoft Mouse Without Borders follows the same input
path as a local keyboard/mouse, including shortcuts, recent-word conversion and snippets.
On the sending computer, KSwitcher ignores keyboard events consumed by another keyboard hook
(including Mouse Without Borders forwarding). The receiving computer still processes delivered
input normally, so both computers can run KSwitcher without starting duplicate snippet operations.
KSwitcher marks its own generated input so copy/paste, selection, modifier releases and shell-mask
keys cannot trigger recursive commands or overwrite the recorded typing run. Other injected input
is accepted, including key-up events and VK-only keyboard events. Unicode packets do not provide
@@ -274,10 +277,24 @@ thumbnails and source labels aligned with the scaled fonts and spacing.
of the complete expected text. Browser/editor compatibility depends on its handling of simulated input.
- Selection conversion and verified recent input (physical scan codes, 2-second typing-run boundary).
- Same-process clipboard ownership plus verified WebView2 descendants, including the Teams fix.
Clipboard synchronizers such as Mouse Without Borders may republish a copy only when
KSwitcher first observed it owned by the target application and the selection text and
editor selection metadata remain identical. Unobserved or altered foreign copies are rejected.
Snippets normally require accessibility verification of their selected trigger and pasted text,
even with logging disabled. If verification is unavailable or the paste differs, expansion
stops without running cursor or Enter actions. Clipboard changes during paste also cancel actions.
Far Manager uses its native Alt+Shift+Arrow selection, Ctrl+Insert copy and Shift+Insert
paste commands instead: both the trigger and inserted text must match verified clipboard
copies from Far. Cancellation restores the full temporary selection, not one cursor step.
Far supports nonempty single-line replacements up to 4096 caret steps, including
`{cursor}` and verified `{enter}` actions. Empty or multiline replacements are rejected
before selection; pasting a newline could execute a command before it can be verified.
- Teams recent-word conversion uses a single word-selection command and validates the copied range.
If the editor's word boundary differs from the recorded typing, it falls back to paced character
selection: Teams can coalesce a burst of Shift+Left events into just one character.
- Clipboard snapshot/restoration with concurrent-copy, foreground and input-version checks.
A snapshot interrupted by a concurrent clipboard publication is retried up to three total
attempts before selection starts, provided the foreground and input context remain unchanged.
A silently dropped copy is retried up to three total attempts while the clipboard and input
context remain unchanged. Temporary transaction contents are excluded from Windows clipboard
history and cloud synchronization. Paste is not blindly retried: with manual paste readback
@@ -525,6 +542,22 @@ OpenBao administrator setup:
and UI integration, so another service can be added without replacing the synchronization logic.
Protocol and conflict regressions run with `build.ps1 -Test` or CMake's `sync-regressions` test.
## Portable utilities
The tray menu's **Utilities** submenu lists `.exe` files in a `tools` folder beside
`KSwitcher.exe`, sorted by filename. For example, place `StayHere.exe` at
`tools/StayHere.exe` and choose **Utilities → StayHere** to launch it manually.
The folder is rescanned whenever the menu opens; no configuration or restart is needed.
Only files directly in `tools` are listed (not subfolders, shortcuts, or KSwitcher's
own executables beside the main program). Utilities start with `tools` as their working
directory and are never started automatically. Their lifetime is independent of KSwitcher.
An absent or empty folder displays a disabled placeholder; launch errors are reported.
From v0.6.45, the release includes `tools/README.txt`, so extracting the ZIP or
installing an update creates the folder. Add your own trusted portable executables;
none are bundled or transferred by settings synchronization. Updates preserve your
utility files and may refresh the bundled README. Repository development scripts
are not included in the portable tools folder.
## Build
The easiest reproducible local route uses the pinned portable w64devkit toolchain:
@@ -648,6 +681,7 @@ Run `./package.ps1 -PublishRelease` after building and testing to refresh the tr
.\build.ps1 -Test # Pure/native regression checks; does not touch the user's clipboard
.\build.ps1 -Ocr # Render a synthetic image, decode it with WIC and recognize it with Windows OCR
.\build.ps1 -Integration # Interactive, isolated test editor; avoid input for about 10 seconds
.\build.ps1 -Far # Explicit integration test using an isolated Far Manager profile
.\tests\configuration.ps1 # Separate-process settings tests; close KSwitcher first
```
@@ -711,3 +745,23 @@ From v0.6.31, KSwitcher recovers trailing ordinary spaces omitted by Ctrl+C only
### Notification registration and Viber — v0.6.36
Notification registration runs in KSwitcher.Screenshot.exe; keep all three executables together. Startup registration is asynchronous. Viber pastes allow 75 ms for clipboard notifications before Ctrl+V, retaining focus, ownership and selection checks. This mitigates an intermittent clipboard timing issue; it does not guarantee all Viber failures are resolved. UI Automation is unchanged.
### Image history, OCR and duplicate fingerprints — v0.6.37
Image clipboard capture and automatic/uncached manual history OCR run in short-lived KSwitcher.Screenshot.exe processes. Keep all three executables together. Original clipboard formats, image limits, privacy exclusions, Windows OCR, optional Tesseract and searchable encrypted OCR results are preserved. Background OCR is cancelled on shutdown or an OCR-profile change; late results do not recreate deleted entries.
Consecutive duplicates use SHA-256 fingerprints inside the encrypted history index, including pixel fingerprints for equivalent image encodings. Older entries acquire fingerprints on first comparison without a bulk migration. Pins and OCR caches survive duplicate detection; non-consecutive copies still create separate entries. New text no longer loads the preceding image to rule out a duplicate. No shortcut, setting or default changed.
Moving OCR isolates its temporary memory rather than reducing the combined processing peak. A controlled three-run comparison retained about 0.8 MiB less private RAM in the caller after recognition; combined peak RAM was about 55.6 MiB before and 56.6 MiB with the helper. Results depend on the image, OCR engine and system.
### Pinned history checkbox — v0.6.42
Check **★ Pinned only** beside the history search box to show only pinned entries; uncheck it to show all entries. The checkbox sits on the left, immediately followed by the search box; its right edge stays aligned with the history list when resizing. The text search applies within that filter. Unpinning an item removes it from the pinned view immediately. The checkbox state and search are remembered after closing and reopening history. **Clear history…** still deletes the entire history after confirmation, including entries hidden by the filter.
### History process and clipboard memory — v0.6.40
History opens in a separate, short-lived instance of **KSwitcher.exe**. **Esc** closes it even when focus is on the window or an action button, releasing Windows UI allocations with the process. The resident keeps keyboard hooks, clipboard capture and history storage. Search and the pinned-only filter are preserved in encrypted view state. Each fresh opening selects and reveals the newest matching entry; background refreshes preserve the selected record while browsing. If a full-text item viewer is still open, the helper stays alive until the last viewer closes. Pin/delete, formatted/plain paste and OCR remain available; settings and default shortcuts are unchanged.
Image thumbnails are decoded in **KSwitcher.Screenshot.exe**, returning only bounded preview pixels. Image clipboard backup/restore also uses that helper and encrypted temporary files, with clipboard-sequence checks before restoring. Selection reads avoid loading image formats. Keep all three executables together; no fourth executable is required. Paste allows a brief foreground handoff after history closes while preserving cancellation checks. UI Automation remains in the resident.
A live development-build test measured **4.37 MiB before history and 4.35 MiB after two open/Esc cycles**, compared with an earlier roughly 8–9 MiB plateau. A same-image clipboard-backup benchmark retained **12.78 MiB before versus 0.05 MiB after**. These measure private working set, not a guaranteed total footprint. Include all helpers when measuring active use: combined memory can be higher while history is open. No forced working-set trimming is used. Existing screenshots and shortcuts remain applicable. The v0.6.38 approach of retaining a hidden history window/RichEdit control is superseded by process termination.
Binary file not shown.
+9 -10
View File
@@ -1,22 +1,21 @@
# Latest Windows release
## v0.6.36 — 2026-11-04
## v0.6.45 — 2026-11-05
## Changes
- Notification registration now runs in the existing KSwitcher.Screenshot.exe helper. Startup launches it asynchronously and checks its exit status without blocking keyboard work; update notification registration waits in its background worker. Keep all three executables together. UI Automation and notification activation routes remain unchanged.
- Viber paste now allows 75 ms for clipboard notifications to settle before sending Ctrl+V, then rechecks input, focus and clipboard ownership. This mitigates a suspected clipboard timing race: an intermittent corrupted Cyrillic paste was reproduced on the prior build. It is not a guarantee that every Viber timing issue is resolved; no blind paste retries or relaxed selection checks were added.
- Added regression coverage for an explicitly selected middle range followed by a repeated shortcut without selection, preserving surrounding text, trailing spaces and the original clipboard. Updated the integration fixture to initialize shared predictor dictionaries.
- Added reproducible standalone COM, UI Automation and Shell memory measurement tools. No shortcuts, settings or defaults changed.
- Fix Far Manager snippet expansion and caret placement. Far uses Alt+Shift+Arrow selection, Ctrl+Insert copy and Shift+Insert paste, with exact trigger and inserted-text verification. Cancellation restores the full temporary selection. Both visible and hidden panels are supported.
- Run Far `{cursor}` and `{enter}` actions only after verified insertion. Far replacements must be nonempty, single-line and no longer than 4096 caret steps. Unsupported templates are rejected before selection; multiline clipboard pastes could execute commands before verification. Other applications retain accessibility verification.
- Add the tray **Utilities** menu. It scans trusted `.exe` files directly in `tools` beside the running KSwitcher.exe, sorted by filename and refreshed whenever the menu opens. Utilities run only when selected, use `tools` as their working directory and remain running independently.
- Include **tools/README.txt** in the release ZIP and manifest. Both extraction and automatic updates create the folder. Personal utility executables are preserved by updates; none are bundled or transferred through settings synchronization. Source-repository development scripts are excluded.
- Retain v0.6.44's newest-item selection when reopening clipboard history, including after a screenshot. Saved search/pinned filters remain active; background refreshes preserve the selected record while browsing.
## Validation
Full staged build and tests cover dictionary equivalence for all 140,939 words, 105 sync checks, wheel batching, 304 native checks, 559 input checks, screenshot UI/PNG/registration, 48 updater checks and updater progress UI. Conversion integration passed 43 assertions. Eight actual Viber conversions passed on the development build, including two complete long-text layout cycles and selected/repeated middle-word conversion; test messages were not sent.
A controlled fresh-launch before/after comparison (five private-working-set samples each, same installation and settings) measured 4.69 → 4.18 MiB, about 0.51 MiB saved. This is one local comparison, not a fixed memory limit or a long-term idle guarantee. The prior compact dictionaries and cache/idle memory reductions remain included.
Passed Utilities, dictionary equivalence (140,939 words), 105 sync checks, shared wheel regressions, 319 native checks, 574 input checks, screenshot UI/save/registration, 52 updater checks and updater progress UI. Updater tests cover creation of tools, preserving personal utilities and rollback. The actual ZIP was validated and installed through the unchanged v0.6.44 updater; all installed manifest hashes matched, tools/README.txt was created, and a staging-only utility was excluded from the ZIP. An 18-check real-Far integration run passed during development (visible/hidden panels, caret restoration, cursor markers and verified Enter). The final release-build Far run was canceled by an unrelated foreground change before expansion; an uninterrupted final-build desktop run remains outstanding.
## Upgrade
Choose **Update** in the tray menu. Legacy v0.3.0–v0.4.1 clients first receive the v0.4.2 compatibility bridge, then the current full release. v0.2.3 and earlier require manual installation.
For manual installation, exit KSwitcher, close screenshot editors and extract the entire ZIP into its installation folder. Keep personal `data/` and customized dictionaries.
For manual installation, exit KSwitcher, close its configurator and screenshot editors, and extract the entire ZIP into its installation folder. Keep personal `data/`, customized dictionaries and your own tools. Look for `tools` beside the executable actually running.
Download **KSwitcher-win-x64.zip** with **SHA256SUMS.txt**. Keep all three executables together. The package contains no personal settings, credentials or clipboard history.
Download **KSwitcher-win-x64.zip** with **SHA256SUMS.txt**. Keep all three executables together; history uses another instance of KSwitcher.exe. The package contains no personal settings, credentials or clipboard history.
Publish stable `release-vX.Y.Z` tags matching the executable version. Keep `v0.4.2` as the last legacy tag.
+1 -1
View File
@@ -1 +1 @@
794d74113bddf13ffee7317cadee9c472bca3b84b3361796db58ff8023f66571 KSwitcher-win-x64.zip
94b4a3e86c218a42ef4fe0c75c1a621af62e1dfd6b395eea2040d6c1e7f138a8 KSwitcher-win-x64.zip
+35 -4
View File
@@ -1,4 +1,4 @@
param([switch]$Test, [switch]$Integration, [switch]$Ocr, [switch]$Stage)
param([switch]$Test, [switch]$Integration, [switch]$Ocr, [switch]$Stage, [switch]$Far)
$ErrorActionPreference = 'Stop'
$root = $PSScriptRoot
$compiler = Join-Path $root '.tools\w64devkit\bin\g++.exe'
@@ -37,10 +37,14 @@ try {
if ($LASTEXITCODE) { throw 'Configurator link failed' }
Copy-Item -LiteralPath $configPath -Destination build/release/KSwitcher.Config.exe -Force
$screenshotPath = Join-Path (Split-Path $executablePath) 'KSwitcher.Screenshot.exe'
& $compiler -mwindows -municode -static -s '-Wl,--gc-sections' build/core.o build/platform.o build/ocr.o build/screenshot.o build/screenshot_notifications.o build/screenshot_activation.o build/screenshot_main.o build/screenshot-res.o @libs -o $screenshotPath
& $compiler -mwindows -municode -static -s '-Wl,--gc-sections' build/core.o build/platform.o build/storage.o build/ocr.o build/screenshot.o build/screenshot_notifications.o build/screenshot_activation.o build/screenshot_main.o build/screenshot-res.o @libs -o $screenshotPath
if ($LASTEXITCODE) { throw 'Screenshot link failed' }
Copy-Item -LiteralPath $screenshotPath -Destination build/release/KSwitcher.Screenshot.exe -Force
if ($Test) {
& $compiler @common tests/utilities.cpp -static -s -o build/KSwitcherUtilitiesTests.exe
if ($LASTEXITCODE) { throw 'Utilities test build failed' }
& .\build\KSwitcherUtilitiesTests.exe
if ($LASTEXITCODE) { throw 'Utilities tests failed' }
& $compiler @common tests/dictionary.cpp build/core.o build/platform.o build/autocorrect.o @libs -lpsapi -static -s -o build/KSwitcherDictionaryTests.exe
if ($LASTEXITCODE) { throw 'Dictionary test build failed' }
& .\build\KSwitcherDictionaryTests.exe
@@ -80,16 +84,43 @@ try {
& "$env:SystemRoot\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -ExecutionPolicy Bypass -File tests/update_progress.ps1
if ($LASTEXITCODE) { throw 'Updater progress UI tests failed' }
}
if ($Far) {
& $compiler @common tests/far_snippets.cpp build/core.o build/platform.o build/autostart.o build/autocorrect.o build/storage.o build/sync.o build/ocr.o build/richtext.o build/update.o build/screenshot.o build/screenshot_launcher.o build/screenshot_activation.o build/screenshot_notifications.o build/app.o build/configuration.o build/ui.o build/screenshot-res.o @libs -mwindows -municode -static -s -o build/KSwitcherFarSnippetTests.exe
if ($LASTEXITCODE) { throw 'Far snippet test build failed' }
$fixture = Start-Process -FilePath (Join-Path $outDir 'KSwitcherFarSnippetTests.exe') -WindowStyle Hidden -Wait -PassThru
Get-Content -LiteralPath (Join-Path $outDir 'far-snippets.log')
if ($fixture.ExitCode) { throw 'Far snippet tests failed' }
}
if ($Integration) {
$historyFixture = Join-Path (Resolve-Path build) ('history-host-fixture-' + [guid]::NewGuid().ToString('N'))
New-Item -ItemType Directory $historyFixture | Out-Null
Copy-Item $executablePath,(Join-Path (Split-Path $executablePath) 'KSwitcher.Screenshot.exe') -Destination $historyFixture
Set-Content (Join-Path $historyFixture '.local-dev') 'Isolated history integration test'
$historyTest = Join-Path $historyFixture 'KSwitcherHistoryHostTests.exe'
& $compiler @common tests/history_host.cpp build/core.o build/platform.o build/storage.o build/ocr.o @libs -lpsapi -static -s -o $historyTest
if ($LASTEXITCODE) { throw 'History host test build failed' }
& $historyTest
if ($LASTEXITCODE) { throw 'History host tests failed' }
$snapshotTest = Join-Path (Split-Path $executablePath) 'KSwitcherClipboardSnapshotTests.exe'
& $compiler @common tests/clipboard_snapshot.cpp build/core.o build/platform.o build/storage.o build/ocr.o @libs -lpsapi -static -s -o $snapshotTest
if ($LASTEXITCODE) { throw 'Clipboard snapshot test build failed' }
& $snapshotTest
if ($LASTEXITCODE) { throw 'Clipboard snapshot tests failed' }
$captureTest = Join-Path (Split-Path $executablePath) 'KSwitcherImageCaptureTests.exe'
& $compiler @common tests/image_capture.cpp build/core.o build/platform.o build/storage.o build/ocr.o @libs -static -s -o $captureTest
if ($LASTEXITCODE) { throw 'Image capture test build failed' }
& $captureTest
if ($LASTEXITCODE) { throw 'Image capture tests failed' }
& $compiler @common tests/integration.cpp build/core.o build/platform.o build/autostart.o build/autocorrect.o build/storage.o build/sync.o build/ocr.o build/richtext.o build/update.o build/screenshot.o build/screenshot_launcher.o build/screenshot_activation.o build/screenshot_notifications.o build/app.o build/configuration.o build/ui.o build/screenshot-res.o @libs -static -s -o build/KSwitcherIntegration.exe
if ($LASTEXITCODE) { throw 'Integration test build failed' }
& .\build\KSwitcherIntegration.exe
if ($LASTEXITCODE) { throw 'Integration tests failed' }
}
if ($Ocr) {
& $compiler @common tests/ocr.cpp build/core.o build/platform.o build/autostart.o build/autocorrect.o build/storage.o build/sync.o build/ocr.o build/richtext.o build/update.o build/screenshot.o build/screenshot_launcher.o build/screenshot_activation.o build/screenshot_notifications.o build/app.o build/configuration.o build/ui.o build/screenshot-res.o @libs -static -s -o build/KSwitcherOcrTests.exe
$ocrTest = Join-Path (Split-Path $executablePath) 'KSwitcherOcrTests.exe'
& $compiler @common tests/ocr.cpp build/core.o build/platform.o build/autostart.o build/autocorrect.o build/storage.o build/sync.o build/ocr.o build/richtext.o build/update.o build/screenshot.o build/screenshot_launcher.o build/screenshot_activation.o build/screenshot_notifications.o build/app.o build/configuration.o build/ui.o build/screenshot-res.o @libs -static -s -o $ocrTest
if ($LASTEXITCODE) { throw 'OCR test build failed' }
& .\build\KSwitcherOcrTests.exe
& $ocrTest
if ($LASTEXITCODE) { throw 'OCR tests failed' }
}
foreach ($folder in @('build/dictionaries','build/release/dictionaries','build/staged/dictionaries')) {
+13 -2
View File
@@ -10,8 +10,10 @@ Copy-Item -LiteralPath (Join-Path $root 'LICENSE') -Destination $destination
Copy-Item -LiteralPath (Join-Path $root 'vendor\json-LICENSE.txt') -Destination $destination
Copy-Item -LiteralPath (Join-Path $root 'README.md') -Destination $destination
Copy-Item -LiteralPath (Join-Path $root 'dictionaries') -Destination $destination -Recurse -Force
New-Item -ItemType Directory -Force (Join-Path $destination 'tools') | Out-Null
Copy-Item -LiteralPath (Join-Path $root 'resources\portable-tools-README.txt') -Destination (Join-Path $destination 'tools\README.txt') -Force
# Enumerate the distributable files explicitly; do not include a user's data directory.
$files = @('KSwitcher.exe','KSwitcher.Config.exe','KSwitcher.Screenshot.exe','LICENSE','json-LICENSE.txt','README.md','dictionaries') | ForEach-Object { Join-Path $destination $_ }
$files = @('KSwitcher.exe','KSwitcher.Config.exe','KSwitcher.Screenshot.exe','LICENSE','json-LICENSE.txt','README.md','dictionaries','tools\README.txt') | ForEach-Object { Join-Path $destination $_ }
$entries = foreach ($path in $files) {
foreach ($file in @(Get-ChildItem -LiteralPath $path -File -Recurse)) {
@{path=$file.FullName.Substring($destination.Length+1).Replace('\','/'); size=$file.Length; sha256=(Get-FileHash -LiteralPath $file.FullName -Algorithm SHA256).Hash.ToLowerInvariant()}
@@ -22,7 +24,16 @@ $manifest=Join-Path $destination 'release-files.json'
@{schema=1; version=$version; files=@($entries)} | ConvertTo-Json -Depth 4 | Set-Content -LiteralPath $manifest -Encoding utf8
$files += $manifest
$archive = Join-Path $root 'dist\KSwitcher-win-x64.zip'
Compress-Archive -LiteralPath $files -DestinationPath $archive -Force
# Archive only manifest-listed files, preserving relative paths. Never sweep up
# personal utilities or leftover developer files from the staging directory.
Add-Type -AssemblyName System.IO.Compression.FileSystem
$stream = [IO.File]::Open($archive,[IO.FileMode]::Create)
$zip = [IO.Compression.ZipArchive]::new($stream,[IO.Compression.ZipArchiveMode]::Create)
try {
foreach ($name in @($entries | ForEach-Object { $_.path }) + @('release-files.json')) {
[IO.Compression.ZipFileExtensions]::CreateEntryFromFile($zip,(Join-Path $destination $name),$name,[IO.Compression.CompressionLevel]::Optimal) | Out-Null
}
} finally { $zip.Dispose(); $stream.Dispose() }
Get-FileHash -LiteralPath $archive -Algorithm SHA256
if ($PublishRelease) {
$release = Join-Path $root 'Release'
+3 -3
View File
@@ -9,8 +9,8 @@ IDC_SCREENSHOT_PENCIL CURSOR "icons/lucide/pencil.cur"
1 RT_MANIFEST "app.manifest"
201 RCDATA "update.ps1"
1 VERSIONINFO
FILEVERSION 0,6,36,0
PRODUCTVERSION 0,6,36,0
FILEVERSION 0,6,45,0
PRODUCTVERSION 0,6,45,0
FILEOS VOS_NT_WINDOWS32
FILETYPE VFT_APP
BEGIN
@@ -20,7 +20,7 @@ BEGIN
BEGIN
VALUE "FileDescription", "KSwitcher — native keyboard and clipboard utility"
VALUE "ProductName", "KSwitcher"
VALUE "FileVersion", "0.6.36"
VALUE "FileVersion", "0.6.45"
END
END
BLOCK "VarFileInfo"
+13
View File
@@ -0,0 +1,13 @@
KSwitcher portable utilities
Put your trusted portable .exe utilities directly in this tools folder,
beside this README.txt. Right-click the KSwitcher tray icon and open Utilities.
For example: tools/StayHere.exe appears as Utilities > StayHere.
The list refreshes each time the tray menu opens. Subfolders and shortcuts
are not listed. Utilities start only when you choose them, with this folder
as their working directory. Closing KSwitcher does not close a utility.
No utility executables are bundled. Supply them separately on each computer.
Normal KSwitcher updates preserve your own files in this folder; this README
may be refreshed. Utilities are not transferred by settings synchronization.
+302 -44
View File
@@ -6,6 +6,7 @@
#include "configuration.h"
#include "diagnostics.h"
#include "paste_probe.h"
#include "utilities.h"
#include "screenshot_notifications.h"
#include <algorithm>
#include <commctrl.h>
@@ -15,6 +16,7 @@ namespace ks
{
#include "app_sync.inl"
App *App::current = nullptr;
#include "app_history.inl"
namespace
{
const char *transformCommandName(int command)
@@ -71,25 +73,46 @@ class Transaction
App &app;
HWND target;
uint64_t version;
Clip snapshot;
ClipboardSnapshot snapshot;
DWORD expected{};
bool captured{};
mutable bool invalidLogged{};
unsigned copyNumber{};
std::wstring adopted;
Bytes adoptedFormats;
bool trustedContentsObserved{};
std::unique_ptr<PasteProbe> selectionProof;
std::wstring provenSelection;
bool farSnippet{};
size_t farSelectedSteps{};
public:
Transaction(App &a, HWND t, uint64_t v) : app(a), target(t), version(v)
Transaction(App &a, HWND t, uint64_t v, bool farEditor = false)
: app(a), target(t), version(v), farSnippet(farEditor)
{
app.suspended = true;
try
{
expected = GetClipboardSequenceNumber();
snapshot = readClipboard(app.window, 64 * 1024 * 1024);
if (expected != GetClipboardSequenceNumber())
throw std::runtime_error("Clipboard changed while taking snapshot");
for (unsigned attempt = 0; ; ++attempt)
{
expected = GetClipboardSequenceNumber();
try
{
snapshot.capture(app.window, expected);
if (expected != GetClipboardSequenceNumber())
throw std::runtime_error("Clipboard changed while taking snapshot");
break;
}
catch (...)
{
// No selection or clipboard write has happened yet. Recapture
// the latest clipboard after a concurrent publisher settles.
if (attempt >= 2 || !valid() || expected == GetClipboardSequenceNumber())
throw;
diagnosticEvent(L"Snapshot retry: clipboard changed during capture");
Sleep(20);
}
}
captured = true;
}
catch (...)
@@ -100,10 +123,11 @@ class Transaction
}
~Transaction()
{
if (farSnippet) finishSelection(false);
if (captured && GetClipboardSequenceNumber() == expected)
try
{
app.ownSequence = writeClipboard(app.window, snapshot);
app.ownSequence = snapshot.restore(app.window, expected);
}
catch (...)
{
@@ -131,9 +155,19 @@ class Transaction
if (GetClipboardSequenceNumber() != expected)
{
auto now = GetClipboardSequenceNumber();
if (adopted.empty() || !ownsClipboard(target) || readClipboard(app.window).text() != adopted ||
GetClipboardSequenceNumber() != now)
auto current = readClipboard(app.window, 32 * 1024 * 1024, ClipboardRead::Selection);
const bool sameContents = selectionClipboardIdentity(current) == adoptedFormats;
if (adopted.empty() || (!trustedContentsObserved && !ownsClipboard(target)) ||
!sameContents || GetClipboardSequenceNumber() != now)
{
diagnosticEvent(L"Clipboard check rejected: expectedSequence=" + std::to_wstring(expected) +
L" readSequence=" + std::to_wstring(now) + L" currentSequence=" +
std::to_wstring(GetClipboardSequenceNumber()) + L" owner=" +
std::to_wstring((uintptr_t)GetClipboardOwner()) + L" sameContents=" +
std::to_wstring(sameContents) + L" expectedText=" + diagnosticText(adopted) +
L" currentText=" + diagnosticText(current.text()));
throw std::runtime_error("Operation cancelled: another application changed the clipboard");
}
expected = now;
}
}
@@ -141,6 +175,8 @@ class Transaction
{
check();
adopted.clear();
adoptedFormats.clear();
trustedContentsObserved = false;
// These are temporary transaction contents, not a user's clipboard entry.
// In particular, do not invite the Windows history service to read our
// sentinel while the target editor is trying to open the clipboard.
@@ -153,7 +189,7 @@ class Transaction
if (GetClipboardOwner() != app.window)
throw std::runtime_error("Clipboard changed immediately after writing");
auto text = c.text();
if ((!text.empty() && readClipboard(app.window).text() != text) ||
if ((!text.empty() && readClipboard(app.window, 32 * 1024 * 1024, ClipboardRead::Selection).text() != text) ||
GetClipboardSequenceNumber() != expected)
throw std::runtime_error("Clipboard changed while verifying our write");
}
@@ -163,11 +199,13 @@ class Transaction
const auto number = ++copyNumber;
if (!valid())
return {};
write(textClip(L"\x2063KSwitcher-" + std::to_wstring(GetTickCount64())));
const auto sentinel = L"\x2063KSwitcher-" + std::to_wstring(GetTickCount64());
write(textClip(sentinel));
DWORD before = expected;
diagnosticEvent(L"Copy begin number=" + std::to_wstring(number) + L" sentinelSequence=" +
std::to_wstring(before) + L" target=" + std::to_wstring((uintptr_t)target));
if (!valid() || !chord(L'C', MOD_CONTROL))
std::to_wstring(before) + L" target=" + std::to_wstring((uintptr_t)target) +
L" sentinel=" + diagnosticText(sentinel));
if (!valid() || !chord(farSnippet ? VK_INSERT : L'C', MOD_CONTROL))
{
diagnosticEvent(L"Copy failed: context changed or simulated Ctrl+C blocked");
return {};
@@ -178,6 +216,7 @@ class Transaction
DWORD changed = before;
ULONGLONG stable = 0;
bool changedAgain = false;
std::optional<Bytes> observedTargetCopy;
while (GetTickCount64() < deadline)
{
if (!valid())
@@ -192,6 +231,18 @@ class Transaction
changedAgain |= changed != before;
changed = now;
stable = GetTickCount64();
// Clipboard synchronizers can republish a legitimate copy under
// their own HWND. Record provenance before that handoff; an
// unobserved or altered foreign copy must still be rejected.
if (ownsClipboard(target))
{
auto candidate = readClipboard(app.window, 32 * 1024 * 1024, ClipboardRead::Selection);
if (GetClipboardSequenceNumber() == now && ownsClipboard(target) && !candidate.text().empty())
{
observedTargetCopy = selectionClipboardIdentity(candidate);
diagnosticEvent(L"Copy: target-owned selection observed number=" + std::to_wstring(number));
}
}
}
if (changed != before && GetTickCount64() - stable >= 60)
break;
@@ -204,7 +255,7 @@ class Transaction
check();
if (!valid() || GetClipboardSequenceNumber() != before)
return {};
if (!chord(L'C', MOD_CONTROL))
if (!chord(farSnippet ? VK_INSERT : L'C', MOD_CONTROL))
return {};
diagnosticEvent(L"Copy retry: clipboard unchanged after Ctrl+C number=" + std::to_wstring(number) +
L" attempt=" + std::to_wstring(attempts + 1) + L" elapsedMs=" + std::to_wstring(GetTickCount64() - started));
@@ -223,16 +274,31 @@ class Transaction
L"Copy failed: context changed");
return {};
}
if ((GetClipboardOwner() ? !ownsClipboard(target) : changedAgain) ||
const bool targetOwned = ownsClipboard(target);
auto clip = readClipboard(app.window, 32 * 1024 * 1024, ClipboardRead::Selection);
const auto formats = selectionClipboardIdentity(clip);
const bool verifiedRelay = observedTargetCopy && *observedTargetCopy == formats;
if (((GetClipboardOwner() ? !targetOwned : changedAgain) && !verifiedRelay) ||
changed != GetClipboardSequenceNumber())
{
diagnosticEvent(L"Copy rejected: observedTarget=" + std::to_wstring(observedTargetCopy.has_value()) +
L" verifiedRelay=" + std::to_wstring(verifiedRelay) + L" expectedSequence=" +
std::to_wstring(changed) + L" currentSequence=" + std::to_wstring(GetClipboardSequenceNumber()) +
L" owner=" + std::to_wstring((uintptr_t)GetClipboardOwner()) + L" targetText=" +
diagnosticText(observedTargetCopy ? decodeClip(*observedTargetCopy).text() : L"") +
L" currentText=" + diagnosticText(clip.text()));
throw std::runtime_error("Operation cancelled: copy did not belong to the target application");
}
if (!targetOwned && verifiedRelay)
diagnosticEvent(L"Copy: identical target selection republished by clipboard synchronizer");
expected = changed;
auto clip = readClipboard(app.window);
auto text = clip.text();
diagnosticEvent(L"Copy result number=" + std::to_wstring(number) + L" attempts=" +
std::to_wstring(attempts) + L" elapsedMs=" + std::to_wstring(GetTickCount64() - started) +
L" text=" + diagnosticText(text));
adopted = text;
adoptedFormats = formats;
trustedContentsObserved = targetOwned || verifiedRelay;
check();
for (auto &f : clip.formats)
{
@@ -276,8 +342,44 @@ class Transaction
bool recoveredSelection() const { return selectionProof != nullptr; }
bool select(size_t n)
{
if (farSnippet)
{
if (n > 4096 || farSelectedSteps) return false;
for (size_t i = 0; i < n; ++i)
{
if (!valid() || !chord(VK_LEFT, MOD_ALT | MOD_SHIFT)) return false;
++farSelectedSteps;
}
return valid();
}
return selectPrevious(n, [&] { return valid(); });
}
bool finishSelection(bool atStart)
{
if (!farSnippet) return valid() && chord(atStart ? VK_LEFT : VK_RIGHT);
if (!farSelectedSteps) return valid();
if (atStart)
{
// Far arrows move one character, rather than collapsing a selection
// to its edge. Move into the nonempty selected range and back.
if (!valid() || !chord(VK_RIGHT)) return false;
farSelectedSteps = 0;
return valid() && chord(VK_LEFT);
}
while (farSelectedSteps && valid())
{
if (!chord(VK_RIGHT, MOD_ALT | MOD_SHIFT)) return false;
--farSelectedSteps;
}
return !farSelectedSteps && valid();
}
std::optional<std::wstring> readFarSnippet(size_t count)
{
if (!farSnippet || !count || !select(count)) return {};
auto observed = copy();
if (!finishSelection(false) || observed.empty()) return {};
return observed;
}
std::wstring copyRange(size_t count, const std::wstring &wordCandidate,
const std::function<bool(const std::wstring &)> &matches,
const std::function<bool(const std::wstring &)> &suffixMatches = {})
@@ -358,6 +460,14 @@ class Transaction
if (!valid())
return false;
write(clip);
// Our verified payload is also trusted across an identical relay. The
// sentinel written by copy() deliberately does not get this allowance.
if (clip.formats.size() == 1 && clip.formats.front().id == CF_UNICODETEXT)
{
adopted = clip.text();
adoptedFormats = selectionClipboardIdentity(clip);
trustedContentsObserved = true;
}
// Viber's Qt editor observes clipboard changes asynchronously. Give it
// a chance to discard the data object from Ctrl+C before requesting paste.
// Recheck ownership and input below; never retry a possibly applied paste.
@@ -372,9 +482,16 @@ class Transaction
if (!valid())
return false;
}
if (!chord(L'V', MOD_CONTROL))
if (!chord(farSnippet ? VK_INSERT : L'V', farSnippet ? MOD_SHIFT : MOD_CONTROL))
throw std::runtime_error("Windows blocked simulated input; check application privilege levels");
// The selected trigger was replaced. Do not restore its old caret range
// if clipboard verification below subsequently rejects a concurrent copy.
if (farSnippet) farSelectedSteps = 0;
Sleep(300);
// A clipboard synchronizer may replace our payload after Ctrl+V is
// queued but before the editor consumes it. Do not run snippet actions
// (especially Enter) after such a race.
check();
return true;
}
bool nativeSelectionIs(const std::wstring &original) const
@@ -405,7 +522,8 @@ class Transaction
}
};
} // namespace
App::App(HINSTANCE h, bool test, const std::filesystem::path &dataRoot) : instance(h), smoke(test)
App::App(HINSTANCE h, bool test, const std::filesystem::path &dataRoot, HWND service)
: historyService(service), instance(h), smoke(test)
{
updateNotifier = notifyUpdateAvailable;
current = this;
@@ -422,7 +540,7 @@ App::App(HINSTANCE h, bool test, const std::filesystem::path &dataRoot) : instan
registrationWarning = L"Settings were not loaded: " + wide(e.what());
}
setLoggingEnabled(settings.writeLog);
if (settings.autoCorrect)
if (settings.autoCorrect && !historyService)
try { autoPredictor.configure(std::filesystem::path(executable()).parent_path() / L"dictionaries", settings.autoLanguages); }
catch (const std::exception &e)
{
@@ -441,6 +559,8 @@ App::App(HINSTANCE h, bool test, const std::filesystem::path &dataRoot) : instan
}
App::~App()
{
if (auto host = historyController(historyProcess)) PostMessageW(host, WM_CLOSE, 0, 0);
if (historyProcess) CloseHandle(historyProcess);
if (notificationRegistration) CloseHandle(notificationRegistration);
if (syncWorker.joinable()) syncWorker.join();
if (updateWorker.joinable())
@@ -536,7 +656,10 @@ void App::scheduleHistoryOcr(const Settings &config)
if (!entry.image || (entry.ocrState != 1 && entry.ocrProfile == profile)) continue;
try
{
auto text = recognizeText(history->load(entry.id), config);
auto text = history->recognizeImage(entry.id, config, [this, &profile] {
std::lock_guard lock(jobsMutex);
return stop || ocrProfile(historyOcrSettings) != profile;
});
std::lock_guard lock(jobsMutex);
if (stop || ocrProfile(historyOcrSettings) != profile) continue;
if (history->saveOcr(entry.id, text, config))
@@ -685,6 +808,7 @@ void App::reloadLayouts()
}
void App::clearHistory()
{
if (historyService) { remoteHistory("clear"); history->reload(); return; }
if (busy) throw std::runtime_error("Wait for the current operation to finish.");
if (history) history->clear();
if (historyWindow) refreshHistory(*this);
@@ -947,6 +1071,15 @@ void App::replayTyping()
}
LRESULT CALLBACK App::keyProc(int code, WPARAM wp, LPARAM lp)
{
// MWB suppresses source-machine events that it forwards elsewhere. Let
// downstream hooks route the event before tracking it or starting a snippet.
// Call the chain exactly once; a local event can still be consumed below.
const auto routed = CallNextHookEx(nullptr, code, wp, lp);
return keyboardAfterHooks(code, wp, lp, routed);
}
LRESULT App::keyboardAfterHooks(int code, WPARAM wp, LPARAM lp, LRESULT routed)
{
if (routed) return routed;
if (code == HC_ACTION && current &&
(wp == WM_KEYDOWN || wp == WM_SYSKEYDOWN || wp == WM_KEYUP || wp == WM_SYSKEYUP))
{
@@ -961,7 +1094,7 @@ LRESULT CALLBACK App::keyProc(int code, WPARAM wp, LPARAM lp)
wp == WM_KEYDOWN || wp == WM_SYSKEYDOWN, mods))
return 1;
}
return CallNextHookEx(nullptr, code, wp, lp);
return routed;
}
LRESULT CALLBACK App::mouseProc(int code, WPARAM wp, LPARAM lp)
{
@@ -1205,14 +1338,16 @@ void App::transform(int command, int snippet)
}
// Collapse a temporary selection on every failed auto-correction,
// including clipboard exceptions, before queued typing is replayed.
const bool farSnippet = snippet >= 0 && lower(processName(target)) == L"far";
bool autoSelected = false;
struct SelectionReset
{
bool &selected;
std::function<bool()> valid;
~SelectionReset() { if (selected && valid()) chord(VK_RIGHT); }
} selectionReset{autoSelected, valid};
Transaction tx(*this, target, version);
bool farEditor;
~SelectionReset() { if (selected && !farEditor && valid()) chord(VK_RIGHT); }
} selectionReset{autoSelected, valid, farSnippet};
Transaction tx(*this, target, version, farSnippet);
reason = L"selection-unavailable";
diagnosticEvent(L"Transform target=" + processName(target) + L" command=" + std::to_wstring(command) +
L" recent=" + std::to_wstring(config.recent) + L" keys=" +
@@ -1292,6 +1427,15 @@ void App::transform(int command, int snippet)
const auto &sn = config.snippets[snippet];
if (recent.keys.size() < sn.trigger.size())
return;
result = parseTemplate(sn.text).text;
// A multiline clipboard paste can execute a console command
// before readback. Only explicit, verified {enter} may do so.
if (farSnippet && (result.empty() || result.find_first_of(L"\r\n") != result.npos ||
caretSteps(result) > 4096))
{
reason = L"far-snippet-template-unsupported";
return;
}
Run tail = recent;
tail.keys = tail.keys.substr(tail.keys.size() - sn.trigger.size());
if (!tx.select(sn.trigger.size()))
@@ -1301,7 +1445,6 @@ void App::transform(int command, int snippet)
text = tx.copy();
if (tail.match(text, available, physicalLayout()) < 0)
return;
result = parseTemplate(sn.text).text;
automatic = true;
}
else if (config.recent && recent.window == target && !recent.keys.empty() && !recent.overflow)
@@ -1390,11 +1533,12 @@ void App::transform(int command, int snippet)
}
}
bool sent = false;
const bool requireReadback = tx.recoveredSelection();
PasteProbe probe(((config.writeLog && manual) || requireReadback) && result != text, text, target);
if (requireReadback && result != text && probe.status != L"ready")
const bool requireReadback = tx.recoveredSelection() || snippet >= 0;
PasteProbe probe(!farSnippet && ((config.writeLog && manual) || requireReadback) && result != text, text, target);
if (requireReadback && !farSnippet && result != text && probe.status != L"ready")
{
reason = L"recovered-selection-unavailable";
verification = probe.status;
reason = snippet >= 0 ? L"snippet-verification-unavailable" : L"recovered-selection-unavailable";
std::lock_guard lock(stateMutex);
last.reset();
run.reset();
@@ -1405,10 +1549,10 @@ void App::transform(int command, int snippet)
if (result != text)
sent = tx.paste(textClip(result));
else if (automatic && tx.valid())
chord(VK_RIGHT);
tx.finishSelection(false);
if (requireReadback && result != text && !sent)
{
reason = L"recovered-selection-paste-cancelled";
reason = snippet >= 0 ? L"snippet-paste-cancelled" : L"recovered-selection-paste-cancelled";
std::lock_guard lock(stateMutex);
last.reset();
run.reset();
@@ -1428,11 +1572,12 @@ void App::transform(int command, int snippet)
verification = probe.status;
if (tx.valid())
{
auto observed = probe.read((int)caretSteps(result));
auto observed = farSnippet ? tx.readFarSnippet(caretSteps(result)) :
probe.read((int)caretSteps(result));
// A native Edit may silently ignore Ctrl+V while the clipboard is busy.
// Retry once only with fresh native proof that the exact original range
// is still selected. Never retry an unknown or changed editor state.
if (observed && newlines(*observed) == newlines(text) && tx.nativeSelectionIs(text))
if (!farSnippet && observed && newlines(*observed) == newlines(text) && tx.nativeSelectionIs(text))
{
diagnosticEvent(L"Paste retry: native Edit still selects the unchanged original");
if (tx.paste(textClip(result)) && tx.valid())
@@ -1440,7 +1585,8 @@ void App::transform(int command, int snippet)
else
observed.reset();
}
verification = probe.status;
verification = farSnippet ? (observed ? L"read-back-via-far-clipboard" :
L"far-readback-unavailable") : probe.status;
if (observed && tx.valid())
{
actual = *observed;
@@ -1484,6 +1630,7 @@ void App::transform(int command, int snippet)
}
if (snippet >= 0 && sent && tx.valid())
{
tx.check();
auto t = parseTemplate(config.snippets[snippet].text);
if (!t.suffix.empty())
{
@@ -1492,15 +1639,18 @@ void App::transform(int command, int snippet)
if (!tx.valid()) return;
if (newlines(suffix) != newlines(t.suffix))
{
chord(VK_RIGHT);
tx.finishSelection(false);
return;
}
if (!chord(VK_LEFT)) return;
if (!tx.finishSelection(true)) return;
}
// Action markers run after insertion and cursor placement,
// before any physical typing buffered during expansion.
for (int i = 0; i < t.enters && tx.valid(); ++i)
{
tx.check();
if (!chord(VK_RETURN)) break;
}
}
if (to >= 0 && config.switchLayout && tx.valid() && (sent || result == text))
{
@@ -1520,6 +1670,7 @@ void App::transform(int command, int snippet)
}
void App::pasteEntry(std::wstring id, bool plain)
{
if (historyService) { remoteHistory("paste", id, plain); return; }
if (installingUpdate) return;
if (!history || busy.exchange(true))
return;
@@ -1541,10 +1692,20 @@ void App::pasteEntry(std::wstring id, bool plain)
} reset{busy};
try
{
for (int i = 0; i < 20 && !modifiersReleased(); ++i)
// Foreground activation crosses a process boundary when the
// history UI closes. Let the destination finish activation,
// while retaining the same input-version cancellation guard.
for (int i = 0; i < 20 && inputVersion == version &&
(!modifiersReleased() || GetForegroundWindow() != target); ++i)
Sleep(10);
if (!modifiersReleased() || GetForegroundWindow() != target || inputVersion != version)
{
log(L"History paste cancelled before transaction: foreground=" +
std::to_wstring(GetForegroundWindow() == target) + L" modifiers=" +
std::to_wstring(modifiersReleased()) + L" expectedVersion=" + std::to_wstring(version) +
L" actualVersion=" + std::to_wstring(inputVersion.load()));
return;
}
auto clip = history->load(id);
if (plain)
{
@@ -1554,7 +1715,7 @@ void App::pasteEntry(std::wstring id, bool plain)
clip = textClip(text);
}
Transaction tx(*this, target, version);
tx.paste(clip);
log(tx.paste(clip) ? L"History paste: simulated paste completed" : L"History paste cancelled before simulated paste");
}
catch (const std::exception &e)
{
@@ -1585,7 +1746,19 @@ void App::captureHistory()
for (auto &name : config.excluded)
if (lower(name) == lower(app))
return;
auto clip = readClipboard(window, (size_t)config.maxImageMiB * 1024 * 1024);
if (IsClipboardFormatAvailable(CF_DIB) || IsClipboardFormatAvailable(CF_DIBV5) ||
IsClipboardFormatAvailable(CF_BITMAP) ||
IsClipboardFormatAvailable(RegisterClipboardFormatW(L"PNG")))
{
if (history->captureImage(sequence, app, config))
{
scheduleHistoryOcr(config);
PostMessageW(window, HistoryMessage, 0, 0);
}
return;
}
auto clip = readClipboard(window, (size_t)config.maxImageMiB * 1024 * 1024,
ClipboardRead::WithoutImages, sequence);
if (sequence != GetClipboardSequenceNumber())
return;
for (auto &f : clip.formats)
@@ -1604,6 +1777,7 @@ void App::captureHistory()
}
void App::recognizeEntry(std::wstring id)
{
if (historyService) { remoteHistory("ocr", id); return; }
if (!history || busy.exchange(true))
return;
auto sequence = GetClipboardSequenceNumber();
@@ -1622,7 +1796,9 @@ void App::recognizeEntry(std::wstring id)
try
{
auto cached = history->ocrText(id, ocrProfile(config));
auto text = cached ? *cached : recognizeText(history->load(id), config);
auto text = cached ? *cached : history->recognizeImage(id, config, [this] {
std::lock_guard lock(jobsMutex); return stop;
});
if (!cached) history->saveOcr(id, text, config);
if (text.empty())
{
@@ -1646,6 +1822,10 @@ void App::recognizeEntry(std::wstring id)
}
void App::trayMenu()
{
constexpr int utilityCommandBase = 1000;
std::error_code utilitiesError;
auto utilities = discoverUtilities(std::filesystem::path(executable()).parent_path() / L"tools", utilitiesError);
if (utilities.size() > 50000) utilities.resize(50000);
HMENU menu = CreatePopupMenu();
AppendMenuW(menu, MF_STRING, 10, L"Clipboard &history");
AppendMenuW(menu, MF_STRING, 24, L"&Capture screen region…");
@@ -1653,6 +1833,13 @@ void App::trayMenu()
SetMenuDefaultItem(menu, 11, FALSE);
AppendMenuW(menu, MF_STRING, 12, L"S&nippets…");
AppendMenuW(menu, MF_STRING, 13, L"&Keyboard shortcuts…");
HMENU utilityMenu = CreatePopupMenu();
for (size_t i = 0; i < utilities.size(); ++i)
AppendMenuW(utilityMenu, MF_STRING, utilityCommandBase + i, utilityMenuLabel(utilities[i]).c_str());
if (utilities.empty())
AppendMenuW(utilityMenu, MF_STRING | MF_GRAYED, 0,
utilitiesError ? L"Cannot read tools folder" : L"No utilities in tools folder");
AppendMenuW(menu, MF_POPUP, (UINT_PTR)utilityMenu, L"&Utilities");
AppendMenuW(menu, MF_SEPARATOR, 0, nullptr);
AppendMenuW(menu, MF_STRING | (settings.awake ? MF_CHECKED : 0), 14, L"Keep screen a&wake");
HMENU pause = CreatePopupMenu();
@@ -1679,6 +1866,20 @@ void App::trayMenu()
PostMessageW(window, WM_NULL, 0, 0);
try
{
if (cmd >= utilityCommandBase && size_t(cmd - utilityCommandBase) < utilities.size())
{
const auto &path = utilities[cmd - utilityCommandBase];
auto command = L"\"" + path.wstring() + L"\"";
STARTUPINFOW startup{sizeof(startup)};
PROCESS_INFORMATION process{};
if (!CreateProcessW(path.c_str(), command.data(), nullptr, nullptr, FALSE, 0, nullptr,
path.parent_path().c_str(), &startup, &process))
throw std::runtime_error(utf8(lastError(L"Cannot start utility " + path.filename().wstring())));
AllowSetForegroundWindow(process.dwProcessId);
CloseHandle(process.hThread);
CloseHandle(process.hProcess);
return;
}
switch (cmd)
{
case 24:
@@ -1772,7 +1973,37 @@ LRESULT CALLBACK App::windowProc(HWND hwnd, UINT msg, WPARAM wp, LPARAM lp)
auto *app = current;
if (!app)
return DefWindowProcW(hwnd, msg, wp, lp);
if (msg == app->taskbarCreated && app->taskbarCreated)
if (app->historyService) {
if (msg == HistoryHostShow || msg == HistoryHostRefresh) {
try {
app->history->reload();
if (msg == HistoryHostShow) showHistory(*app);
else if (IsWindowVisible(app->historyWindow)) refreshHistory(*app);
} catch (const std::exception &e) { app->report(wide(e.what())); }
return 0;
}
if (msg == WM_TIMER) {
if (!IsWindow(app->historyService)) PostMessageW(hwnd, WM_CLOSE, 0, 0);
return 0;
}
if (msg == WM_CLOSE) {
EnumThreadWindows(GetCurrentThreadId(), [](HWND child, LPARAM) -> BOOL {
wchar_t name[64]{}; GetClassNameW(child, name, 64);
if (std::wstring(name) == L"KSwitcher.Entry" || std::wstring(name) == L"KSwitcher.History")
DestroyWindow(child);
return TRUE;
}, 0);
DestroyWindow(hwnd);
return 0;
}
if (msg == WM_DESTROY) { PostQuitMessage(0); return 0; }
if (msg == ErrorMessage) {
std::unique_ptr<std::wstring> text(reinterpret_cast<std::wstring *>(lp));
MessageBoxW(app->historyWindow, text->c_str(), L"Clipboard history", MB_OK | MB_ICONWARNING);
return 0;
}
}
if (!app->historyService && msg == app->taskbarCreated && app->taskbarCreated)
{
app->addTray();
return 0;
@@ -1836,7 +2067,9 @@ LRESULT CALLBACK App::windowProc(HWND hwnd, UINT msg, WPARAM wp, LPARAM lp)
app->replayTyping();
return 0;
case TrayMessage:
if (LOWORD(lp) == WM_CONTEXTMENU)
if (LOWORD(lp) == NIN_BALLOONUSERCLICK)
showLogs(*app);
else if (LOWORD(lp) == WM_CONTEXTMENU)
app->trayMenu();
else if (LOWORD(lp) == WM_LBUTTONDBLCLK)
// The shell still owns the mouse gesture on the second button-down.
@@ -1886,6 +2119,7 @@ LRESULT CALLBACK App::windowProc(HWND hwnd, UINT msg, WPARAM wp, LPARAM lp)
case WM_COPYDATA:
{
auto *data = (COPYDATASTRUCT *)lp;
if (data && data->dwData == HistoryRequest) return app->historyRequest((HWND)wp, *data);
if (data && data->dwData >= ConfigRead && data->dwData < ConfigEnd)
{
if (app->installingUpdate) return FALSE;
@@ -1972,7 +2206,7 @@ int App::execute()
WNDCLASSW cls{};
cls.hInstance = instance;
cls.lpfnWndProc = windowProc;
cls.lpszClassName = L"KSwitcher.Main";
cls.lpszClassName = historyService ? HistoryHostClass : L"KSwitcher.Main";
cls.hIcon = LoadIconW(instance, MAKEINTRESOURCEW(IDI_KSWITCHER));
RegisterClassW(&cls);
window = CreateWindowExW(WS_EX_TOOLWINDOW, cls.lpszClassName, L"KSwitcher", WS_POPUP, 0, 0, 0, 0, nullptr,
@@ -2006,6 +2240,30 @@ int App::execute()
}
CoUninitialize();
});
if (historyService) {
try {
auto bytes = unprotect(readFile(data / L"history-view.bin", 4 * 1024 * 1024));
auto state = HistoryJson::parse(bytes);
historySelection = wide(state.value("selection", std::string{}));
historyTop = wide(state.value("top", std::string{}));
historyQuery = wide(state.value("query", std::string{}));
historyPinnedOnly = state.value("pinnedOnly", false);
} catch (...) {}
showHistory(*this);
remoteHistory("ready", std::to_wstring(reinterpret_cast<uintptr_t>(historyWindow)));
SetTimer(window, 1, 1000, nullptr);
MSG message{};
while (GetMessageW(&message, nullptr, 0, 0) > 0) {
if (message.message == WM_KEYDOWN && message.wParam == VK_ESCAPE && historyWindow &&
(message.hwnd == historyWindow || IsChild(historyWindow, message.hwnd))) {
SendMessageW(historyWindow, WM_CLOSE, 0, 0);
continue;
}
if (historyWindow && message.message == WM_SYSCHAR && IsDialogMessageW(historyWindow, &message)) continue;
TranslateMessage(&message); DispatchMessageW(&message);
}
return int(message.wParam);
}
keyboardHook = SetWindowsHookExW(WH_KEYBOARD_LL, keyProc, instance, 0);
mouseHook = SetWindowsHookExW(WH_MOUSE_LL, mouseProc, instance, 0);
registerHotkeys(settings);
@@ -2042,7 +2300,7 @@ int App::execute()
continue;
}
// Preserve history-specific Enter/Shift+Enter and Ctrl+digit handling.
if (historyWindow && msg.message == WM_SYSCHAR && IsDialogMessageW(historyWindow, &msg))
if (!isolateHistory && historyWindow && msg.message == WM_SYSCHAR && IsDialogMessageW(historyWindow, &msg))
continue;
if (settingsWindow && IsDialogMessageW(settingsWindow, &msg))
continue;
+13 -1
View File
@@ -33,6 +33,11 @@ class App
{
public:
HWND window{}, historyWindow{}, settingsWindow{}, snippetsWindow{};
HWND historyService{}; // Non-null only in the short-lived history UI process.
bool isolateHistory{};
unsigned historyEntryWindows{};
std::wstring historySelection, historyTop, historyQuery;
bool historyPinnedOnly{};
HINSTANCE instance{};
std::filesystem::path data;
std::vector<Layout> layouts;
@@ -55,7 +60,7 @@ class App
bool smoke{};
int startCommand{};
std::wstring updateStartupEvent;
App(HINSTANCE, bool = false, const std::filesystem::path &dataRoot = {});
App(HINSTANCE, bool = false, const std::filesystem::path &dataRoot = {}, HWND historyService = nullptr);
~App();
int execute();
void dispatch(int);
@@ -72,6 +77,11 @@ class App
void applySettings(const Settings &);
void reloadLayouts();
void clearHistory();
void openHistoryProcess();
void refreshHistoryProcess();
void remoteHistory(const char *action, const std::wstring &id = {}, bool plain = false);
LRESULT historyRequest(HWND, const COPYDATASTRUCT &);
void saveHistoryView(const std::wstring &, const std::wstring &, const std::wstring &, bool);
void clearLog(bool previous);
void setHotkeyCapture(HWND);
bool isHotkey(DWORD, UINT);
@@ -88,6 +98,7 @@ class App
friend struct InputRegressionAccess;
void releaseIdleMemory(ULONGLONG now);
HHOOK keyboardHook{}, mouseHook{};
HANDLE historyProcess{};
std::mutex jobsMutex;
std::condition_variable jobsReady;
std::deque<std::function<void()>> jobs;
@@ -132,6 +143,7 @@ class App
void replayTyping();
static LRESULT CALLBACK windowProc(HWND, UINT, WPARAM, LPARAM);
static LRESULT CALLBACK keyProc(int, WPARAM, LPARAM);
static LRESULT keyboardAfterHooks(int, WPARAM, LPARAM, LRESULT);
static LRESULT CALLBACK mouseProc(int, WPARAM, LPARAM);
};
void showHistory(App &, bool visible = true);
+100
View File
@@ -0,0 +1,100 @@
// History UI has no clipboard listener or hooks. The resident remains the only writer.
namespace {
constexpr ULONG_PTR HistoryRequest = 0x4b530200;
constexpr UINT HistoryHostShow = WM_APP + 71, HistoryHostRefresh = WM_APP + 72;
constexpr wchar_t HistoryHostClass[] = L"KSwitcher.HistoryHost";
using HistoryJson = nlohmann::json;
HWND historyController(HANDLE process)
{
if (!process || WaitForSingleObject(process, 0) == WAIT_OBJECT_0) return nullptr;
auto window = FindWindowW(HistoryHostClass, nullptr);
DWORD pid{}; GetWindowThreadProcessId(window, &pid);
return pid == GetProcessId(process) ? window : nullptr;
}
}
void App::openHistoryProcess()
{
auto foreground = GetForegroundWindow();
if (foreground != window && foreground != historyWindow) pasteTarget = foreground;
if (historyProcess && WaitForSingleObject(historyProcess, 0) == WAIT_OBJECT_0) {
CloseHandle(historyProcess); historyProcess = nullptr; historyWindow = nullptr;
}
if (historyProcess) {
if (auto host = historyController(historyProcess)) {
AllowSetForegroundWindow(GetProcessId(historyProcess));
PostMessageW(host, HistoryHostShow, 0, 0);
}
return;
}
auto path = executable();
auto command = L"\"" + path + L"\" --history-host=" + std::to_wstring(reinterpret_cast<uintptr_t>(window));
STARTUPINFOW startup{sizeof(startup)};
startup.dwFlags = STARTF_USESHOWWINDOW; startup.wShowWindow = SW_HIDE;
PROCESS_INFORMATION child{};
if (!CreateProcessW(path.c_str(), command.data(), nullptr, nullptr, FALSE, CREATE_NO_WINDOW,
nullptr, std::filesystem::path(path).parent_path().c_str(), &startup, &child))
throw std::runtime_error("Cannot start clipboard history window");
CloseHandle(child.hThread);
historyProcess = child.hProcess;
AllowSetForegroundWindow(child.dwProcessId);
}
void App::refreshHistoryProcess()
{
if (auto host = historyController(historyProcess)) PostMessageW(host, HistoryHostRefresh, 0, 0);
}
void App::remoteHistory(const char *action, const std::wstring &id, bool plain)
{
if (!historyService || !configurationPeer(historyService, L"KSwitcher.exe"))
throw std::runtime_error("KSwitcher has stopped. Reopen clipboard history.");
auto text = HistoryJson{{"action", action}, {"id", utf8(id)}, {"plain", plain}}.dump();
if (std::string_view(action) == "paste") {
DWORD residentPid{}; GetWindowThreadProcessId(historyService, &residentPid);
AllowSetForegroundWindow(residentPid);
}
COPYDATASTRUCT message{HistoryRequest, DWORD(text.size()), text.data()};
DWORD_PTR result{};
if (!SendMessageTimeoutW(historyService, WM_COPYDATA, reinterpret_cast<WPARAM>(window),
reinterpret_cast<LPARAM>(&message), SMTO_ABORTIFHUNG | SMTO_ERRORONEXIT,
15000, &result) || result != 1)
throw std::runtime_error("KSwitcher could not complete the history request. Reopen history and retry.");
}
LRESULT App::historyRequest(HWND sender, const COPYDATASTRUCT &message)
{
DWORD pid{}; GetWindowThreadProcessId(sender, &pid);
if (!historyProcess || pid != GetProcessId(historyProcess) ||
!configurationPeer(sender, L"KSwitcher.exe") || message.cbData > 4096 ||
!message.cbData || !message.lpData || installingUpdate) return FALSE;
try {
const auto *first = static_cast<const char *>(message.lpData);
auto job = HistoryJson::parse(first, first + message.cbData);
auto action = job.at("action").get<std::string>();
auto id = wide(job.at("id").get<std::string>());
if (id.size() > 128) return FALSE;
if (action == "ready") {
auto ui = reinterpret_cast<HWND>(uintptr_t(std::stoull(id)));
DWORD uiPid{}; GetWindowThreadProcessId(ui, &uiPid);
wchar_t name[64]{}; GetClassNameW(ui, name, 64);
if (uiPid != pid || std::wstring(name) != L"KSwitcher.History") return FALSE;
historyWindow = ui;
} else if (action == "paste") {
if (busy || !history) return FALSE;
pasteEntry(id, job.at("plain").get<bool>());
} else if (action == "ocr") {
if (busy || !history) return FALSE;
recognizeEntry(id);
} else if (action == "clear") clearHistory();
else if (action == "pin" || action == "remove") {
if (busy || !history) return FALSE;
if (action == "pin") history->pin(id); else history->remove(id);
} else return FALSE;
return TRUE;
} catch (...) { return FALSE; }
}
void App::saveHistoryView(const std::wstring &selection, const std::wstring &top, const std::wstring &query, bool pinnedOnly)
{
if (!historyService) return;
try {
auto text = HistoryJson{{"selection", utf8(selection)}, {"top", utf8(top)}, {"query", utf8(query)}, {"pinnedOnly", pinnedOnly}}.dump();
atomicWrite(data / L"history-view.bin", protect(Bytes(text.begin(), text.end())));
} catch (...) {} // Closing the UI must still release its process if state cannot be saved.
}
+1 -1
View File
@@ -79,7 +79,7 @@ LRESULT CALLBACK controller(HWND window, UINT message, WPARAM wp, LPARAM lp)
}
// The configurator owns no history store, dictionaries, worker or input hooks.
// All mutations are validated and committed by the resident process.
App::App(HINSTANCE h, bool, const std::filesystem::path &) : instance(h)
App::App(HINSTANCE h, bool, const std::filesystem::path &, HWND) : instance(h)
{
current = this;
data = dataDirectory();
+16
View File
@@ -1,12 +1,27 @@
#include "app.h"
#include <shellapi.h>
#include <shlobj.h>
#include "configuration.h"
int WINAPI wWinMain(HINSTANCE instance, HINSTANCE, PWSTR, int)
{
CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);
int argc{};
auto argv = CommandLineToArgvW(GetCommandLineW(), &argc);
std::wstring arg = argc > 1 ? argv[1] : L"";
if (argc == 2 && arg.starts_with(L"--history-host=")) {
LocalFree(argv);
int result = 1;
try {
auto service = reinterpret_cast<HWND>(uintptr_t(std::stoull(arg.substr(15))));
wchar_t name[64]{}; GetClassNameW(service, name, 64);
if (std::wstring(name) != L"KSwitcher.Main" || !ks::configurationPeer(service, L"KSwitcher.exe"))
throw std::runtime_error("Invalid history service");
ks::App app(instance, true, {}, service);
result = app.execute();
} catch (...) {}
CoUninitialize();
return result;
}
if (arg.starts_with(L"--configure-autostart="))
{
int result = 1;
@@ -72,6 +87,7 @@ int WINAPI wWinMain(HINSTANCE instance, HINSTANCE, PWSTR, int)
try
{
ks::App app(instance, arg == L"--smoke-test");
app.isolateHistory = !app.smoke;
if (arg.starts_with(L"--update-ready-event="))
app.updateStartupEvent = arg.substr(std::wstring(L"--update-ready-event=").size());
else if (!arg.empty() && arg != L"--smoke-test")
+17 -4
View File
@@ -265,15 +265,27 @@ std::wstring processName(HWND window)
CloseHandle(h);
return ok ? std::filesystem::path(std::wstring(path, n)).stem().wstring() : L"";
}
Clip readClipboard(HWND window, size_t limit)
Clip readClipboard(HWND window, size_t limit, ClipboardRead mode, std::optional<DWORD> expected)
{
ClipboardLock lock(window);
if (expected && *expected != GetClipboardSequenceNumber())
throw std::runtime_error("Clipboard changed while taking snapshot");
if (mode == ClipboardRead::WithoutImages &&
(IsClipboardFormatAvailable(CF_DIB) || IsClipboardFormatAvailable(CF_DIBV5) ||
IsClipboardFormatAvailable(CF_BITMAP) || IsClipboardFormatAvailable(RegisterClipboardFormatW(L"PNG"))))
throw std::runtime_error("Clipboard changed to an image");
Clip c;
size_t total = 0;
for (UINT f = EnumClipboardFormats(0); f; f = EnumClipboardFormats(f))
{
if (!globalFormat(f))
continue;
wchar_t name[256]{};
if (f >= 0xc000) GetClipboardFormatNameW(f, name, 256);
if (mode == ClipboardRead::Selection && f != CF_UNICODETEXT &&
std::wstring_view(name) != L"VisualStudioEditorOperationsLineCutCopyClipboardTag" &&
std::wstring_view(name) != L"MSDEVLineSelect" && std::wstring_view(name) != L"vscode-editor-data")
continue;
HANDLE handle = GetClipboardData(f);
if (!handle)
continue;
@@ -291,8 +303,6 @@ Clip readClipboard(HWND window, size_t limit)
GlobalUnlock(handle);
if (f >= 0xc000)
{
wchar_t name[256]{};
GetClipboardFormatNameW(f, name, 256);
format.name = name;
}
total += size;
@@ -300,7 +310,8 @@ Clip readClipboard(HWND window, size_t limit)
}
return c;
}
DWORD writeClipboard(HWND window, const Clip &c)
DWORD writeClipboard(HWND window, const Clip &c) { return writeClipboardGuarded(window, c, {}); }
DWORD writeClipboardGuarded(HWND window, const Clip &c, std::optional<DWORD> expected)
{
// Allocate all blocks before replacing any existing data.
std::vector<std::pair<UINT, HGLOBAL>> blocks;
@@ -327,6 +338,8 @@ DWORD writeClipboard(HWND window, const Clip &c)
blocks.emplace_back(id, h);
}
ClipboardLock lock(window);
if (expected && *expected != GetClipboardSequenceNumber())
throw std::runtime_error("Clipboard changed before restoring snapshot");
if (!EmptyClipboard())
throw std::runtime_error("Cannot replace clipboard");
for (auto &[id, h] : blocks)
+4 -1
View File
@@ -43,8 +43,11 @@ bool ownsClipboard(HWND);
bool webViewDescendant(DWORD owner, DWORD host,
const std::function<std::optional<std::pair<DWORD, std::wstring>>(DWORD)> &read);
std::wstring processName(HWND);
Clip readClipboard(HWND, size_t limit = 32 * 1024 * 1024);
enum class ClipboardRead { All, Selection, WithoutImages };
Clip readClipboard(HWND, size_t limit = 32 * 1024 * 1024,
ClipboardRead = ClipboardRead::All, std::optional<DWORD> expected = {});
DWORD writeClipboard(HWND, const Clip &);
DWORD writeClipboardGuarded(HWND, const Clip &, std::optional<DWORD> expected);
Clip textClip(const std::wstring &);
bool chord(WORD key, UINT modifiers = 0);
// Process-local marker, shared by every KSwitcher input producer (not an authentication token).
+2 -1
View File
@@ -252,7 +252,7 @@ DWORD CALLBACK readStream(DWORD_PTR cookie, LPBYTE buffer, LONG size, LONG *read
return 0;
}
} // namespace
std::string richPreview(const Clip &clip)
std::string richPreview(const Clip &clip, bool plainFallback)
{
for (const auto &f : clip.formats)
if (f.name == L"Rich Text Format" && f.data.size() <= 65536)
@@ -276,6 +276,7 @@ std::string richPreview(const Clip &clip)
{
}
}
if (!plainFallback) return {};
auto text = clip.text();
if (text.size() > 4096)
text.resize(4096);
+1 -1
View File
@@ -2,7 +2,7 @@
#include "platform.h"
namespace ks
{
std::string richPreview(const Clip &);
std::string richPreview(const Clip &, bool plainFallback = true);
HWND createRichText(HWND parent, int id, bool visible);
bool setRichText(HWND, const std::string &);
} // namespace ks
+13
View File
@@ -1,5 +1,6 @@
#include "screenshot.h"
#include "screenshot_notifications.h"
#include "storage.h"
#include <commctrl.h>
#include <shellapi.h>
#include <roapi.h>
@@ -49,6 +50,18 @@ int WINAPI wWinMain(HINSTANCE instance,HINSTANCE,PWSTR,int)
std::wstring token;
bool autoOpenEditor=false, writeLog=false;
int argc{}; auto argv=CommandLineToArgvW(GetCommandLineW(),&argc);
if(argc==3 && std::wstring(argv[1])==L"--clipboard-snapshot") {
std::filesystem::path request=argv[2]; LocalFree(argv);
return ks::runClipboardSnapshot(request);
}
if(argc==3 && (std::wstring(argv[1])==L"--capture-history" || std::wstring(argv[1])==L"--history-ocr")) {
bool ocr=std::wstring(argv[1])==L"--history-ocr";
std::filesystem::path request=argv[2]; LocalFree(argv);
auto initialized=CoInitializeEx(nullptr,COINIT_MULTITHREADED);
if(FAILED(initialized)) return 1;
int result=ocr ? ks::runHistoryOcr(request) : ks::runImageHistoryCapture(request);
CoUninitialize(); return result;
}
if(argc>1 && std::wstring(argv[argc-1])==L"--write-log") {
writeLog=true; --argc;
ks::setLoggingEnabled(true);
+355 -19
View File
@@ -4,6 +4,7 @@
#include <algorithm>
#include <set>
#include <sstream>
#include <wincrypt.h>
namespace ks
{
@@ -343,6 +344,20 @@ Bytes encodeClip(const Clip &clip)
}
return b;
}
Bytes selectionClipboardIdentity(const Clip &clip)
{
auto normalized = clip;
// GlobalSize includes allocation slack. A clipboard relay may allocate a
// different-sized block for the same NUL-terminated Unicode string.
for (auto &format : normalized.formats)
if (format.id == CF_UNICODETEXT)
format = textClip(clip.text()).formats.front();
std::sort(normalized.formats.begin(), normalized.formats.end(), [](const Format &a, const Format &b)
{
return std::tie(a.name, a.id) < std::tie(b.name, b.id);
});
return encodeClip(normalized);
}
Clip decodeClip(const Bytes &b)
{
size_t p = 0;
@@ -374,9 +389,17 @@ Clip decodeClip(const Bytes &b)
History::History(const std::filesystem::path &folder) : folder_(folder)
{
std::filesystem::create_directories(folder_);
loadIndex();
}
void History::loadIndex()
{
std::vector<Entry> loaded;
auto index = folder_ / L"index.dat";
if (!std::filesystem::exists(index))
{
entries_.clear();
return;
}
auto j = parse(unprotect(readFile(index, 16 * 1024 * 1024)));
if (!j.is_array() || j.size() > 10000)
throw std::runtime_error("Invalid history index");
@@ -391,8 +414,169 @@ History::History(const std::filesystem::path &folder) : folder_(folder)
e.value("image", false),
e.value("files", false), e.value("ocrState", e.value("image", false) ? 1 : 0),
str(e, "ocrProfile", L"windows")};
if (e.value("fingerprintVersion", 0) == 1) {
item.contentHash = e.value("contentHash", std::string{});
item.imageHash = e.value("imageHash", std::string{});
item.pixelHash = e.value("pixelHash", std::string{});
}
if (validId(item.id) && std::filesystem::exists(folder_ / (item.id + L".dat")))
entries_.push_back(std::move(item));
loaded.push_back(std::move(item));
}
entries_ = std::move(loaded);
}
void History::reload() { std::lock_guard lock(mutex_); loadIndex(); }
void ClipboardSnapshot::cleanup() noexcept
{
if (request_.empty()) return;
std::error_code ignored;
for (const auto *suffix : {L"", L".snapshot", L".result"})
std::filesystem::remove(std::filesystem::path(request_.wstring() + suffix), ignored);
request_.clear();
}
ClipboardSnapshot::~ClipboardSnapshot() { cleanup(); }
DWORD ClipboardSnapshot::run(bool restore, DWORD sequence)
{
atomicWrite(request_, protect(jsonBytes(Json{{"schema", 1}, {"restore", restore}, {"sequence", sequence}})));
auto helper = std::filesystem::path(executable()).parent_path() / L"KSwitcher.Screenshot.exe";
auto command = L"\"" + helper.wstring() + L"\" --clipboard-snapshot \"" + request_.wstring() + L"\"";
STARTUPINFOW startup{sizeof(startup)};
startup.dwFlags = STARTF_USESHOWWINDOW; startup.wShowWindow = SW_HIDE;
PROCESS_INFORMATION process{};
if (!CreateProcessW(helper.c_str(), command.data(), nullptr, nullptr, FALSE, CREATE_NO_WINDOW,
nullptr, helper.parent_path().c_str(), &startup, &process))
throw std::runtime_error("Cannot start clipboard snapshot helper");
CloseHandle(process.hThread);
auto wait = WaitForSingleObject(process.hProcess, 10000);
DWORD result = ERROR_GEN_FAILURE;
if (wait != WAIT_OBJECT_0)
{
TerminateProcess(process.hProcess, ERROR_TIMEOUT);
WaitForSingleObject(process.hProcess, INFINITE);
}
GetExitCodeProcess(process.hProcess, &result);
CloseHandle(process.hProcess);
if (wait != WAIT_OBJECT_0 || result) throw std::runtime_error("Clipboard snapshot helper failed");
return parse(unprotect(readFile(request_.wstring() + L".result", 4096))).at("sequence").get<DWORD>();
}
void ClipboardSnapshot::capture(HWND window, DWORD sequence)
{
cleanup();
clip_ = {};
if (!IsClipboardFormatAvailable(CF_DIB) && !IsClipboardFormatAvailable(CF_DIBV5) &&
!IsClipboardFormatAvailable(CF_BITMAP) && !IsClipboardFormatAvailable(RegisterClipboardFormatW(L"PNG")))
{
clip_ = readClipboard(window, 64 * 1024 * 1024, ClipboardRead::WithoutImages, sequence);
return;
}
request_ = std::filesystem::temp_directory_path() / (L"ks-clipboard-" + newSnippetId() + L".request");
try { run(false, sequence); }
catch (...) { cleanup(); throw; }
}
DWORD ClipboardSnapshot::restore(HWND window, DWORD sequence)
{
return request_.empty() ? writeClipboardGuarded(window, clip_, sequence) : run(true, sequence);
}
int runClipboardSnapshot(const std::filesystem::path &request)
{
try
{
if (!request.is_absolute() || !request.filename().wstring().starts_with(L"ks-clipboard-") ||
request.extension() != L".request") return 1;
auto job = parse(unprotect(readFile(request, 4096)));
if (job.at("schema") != 1) return 1;
auto sequence = job.at("sequence").get<DWORD>();
const auto snapshot = request.wstring() + L".snapshot";
if (job.at("restore").get<bool>())
{
auto clip = decodeClip(unprotect(readFile(snapshot, 70 * 1024 * 1024)));
HWND window = CreateWindowExW(0, L"STATIC", L"", 0, 0, 0, 0, 0, HWND_MESSAGE, nullptr, nullptr, nullptr);
if (!window) return 1;
struct WindowCleanup { HWND window; ~WindowCleanup() { DestroyWindow(window); } } cleanup{window};
sequence = writeClipboardGuarded(window, clip, sequence);
}
else
{
auto clip = readClipboard(nullptr, 64 * 1024 * 1024, ClipboardRead::All, sequence);
if (sequence != GetClipboardSequenceNumber()) return 2;
atomicWrite(snapshot, protect(encodeClip(clip)));
}
atomicWrite(request.wstring() + L".result", protect(jsonBytes(Json{{"sequence", sequence}})));
return 0;
}
catch (...) { return 1; }
}
bool History::captureImage(DWORD sequence, const std::wstring &app, const Settings &settings)
{
// Serialize helper index changes with all resident history mutations. Only
// metadata is reloaded: GetClipboardData's image allocations die with the child.
std::lock_guard lock(mutex_);
if (sequence != GetClipboardSequenceNumber()) return false;
auto request = std::filesystem::absolute(folder_) / (L"capture-" + newSnippetId() + L".request");
struct Cleanup {
std::filesystem::path path;
~Cleanup() { std::error_code ignored; std::filesystem::remove(path, ignored); }
} cleanup{request};
Json job{{"schema", 1}, {"sequence", sequence}, {"app", utf8(app)},
{"settings", Json::parse(encodeSettings(settings))}};
atomicWrite(request, protect(jsonBytes(job)));
auto helper = std::filesystem::path(executable()).parent_path() / L"KSwitcher.Screenshot.exe";
auto command = L"\"" + helper.wstring() + L"\" --capture-history \"" + request.wstring() + L"\"";
STARTUPINFOW startup{sizeof(startup)};
startup.dwFlags = STARTF_USESHOWWINDOW; startup.wShowWindow = SW_HIDE;
PROCESS_INFORMATION process{};
if (!CreateProcessW(helper.c_str(), command.data(), nullptr, nullptr, FALSE, CREATE_NO_WINDOW,
nullptr, helper.parent_path().c_str(), &startup, &process))
throw std::runtime_error(utf8(lastError(L"Cannot start image history helper")));
CloseHandle(process.hThread);
auto wait = WaitForSingleObject(process.hProcess, 30000);
DWORD result = ERROR_GEN_FAILURE;
if (wait != WAIT_OBJECT_0)
{
// Never release the index lock while a timed-out child can still write it.
TerminateProcess(process.hProcess, ERROR_TIMEOUT);
WaitForSingleObject(process.hProcess, INFINITE);
}
GetExitCodeProcess(process.hProcess, &result);
CloseHandle(process.hProcess);
loadIndex(); // Also reconcile any completed atomic save before a child failure.
if (wait != WAIT_OBJECT_0) throw std::runtime_error("Image history helper timed out");
if (result == 2) return false;
if (result == 3) throw std::runtime_error("Clipboard exceeds the configured size limit");
if (result) throw std::runtime_error("Image history helper failed: " + std::to_string(result));
return true;
}
int runImageHistoryCapture(const std::filesystem::path &request)
{
try
{
if (!request.is_absolute() || !request.filename().wstring().starts_with(L"capture-") ||
request.extension() != L".request") return 1;
auto job = parse(unprotect(readFile(request, 4 * 1024 * 1024)));
if (job.at("schema") != 1) return 1;
auto sequence = job.at("sequence").get<DWORD>();
auto settings = decodeSettings(jsonBytes(job.at("settings")), readLayouts());
auto valid = [&] {
return settings.history && sequence == GetClipboardSequenceNumber() &&
!IsClipboardFormatAvailable(RegisterClipboardFormatW(L"ExcludeClipboardContentFromMonitorProcessing")) &&
!IsClipboardFormatAvailable(RegisterClipboardFormatW(L"Clipboard Viewer Ignore"));
};
if (!valid()) return 2;
if (!IsClipboardFormatAvailable(CF_DIB) && !IsClipboardFormatAvailable(CF_DIBV5) &&
!IsClipboardFormatAvailable(CF_BITMAP) &&
!IsClipboardFormatAvailable(RegisterClipboardFormatW(L"PNG"))) return 2;
auto clip = readClipboard(nullptr, size_t(settings.maxImageMiB) * 1024 * 1024);
if (!valid()) return 2;
for (const auto &format : clip.formats)
if (format.name == L"CanIncludeInClipboardHistory" && format.data.size() >= 4 &&
!format.data[0] && !format.data[1] && !format.data[2] && !format.data[3]) return 2;
History history(request.parent_path());
if (!valid()) return 2;
history.add(clip, str(job, "app"), settings);
return 0;
}
catch (const std::exception &e)
{
return std::string(e.what()) == "Clipboard exceeds the configured size limit" ? 3 : 1;
}
}
void History::saveIndex()
@@ -406,7 +590,9 @@ void History::saveIndex()
{"at", e.at},
{"pinned", e.pinned},
{"image", e.image},
{"files", e.files}, {"ocrState", e.ocrState}, {"ocrProfile", utf8(e.ocrProfile)}});
{"files", e.files}, {"ocrState", e.ocrState}, {"ocrProfile", utf8(e.ocrProfile)},
{"fingerprintVersion", 1}, {"contentHash", e.contentHash},
{"imageHash", e.imageHash}, {"pixelHash", e.pixelHash}});
atomicWrite(folder_ / L"index.dat", protect(jsonBytes(j)));
}
std::vector<Entry> History::entries() const
@@ -439,12 +625,10 @@ void History::prune(const Settings &s)
entries_.erase(entries_.begin() + i);
}
}
bool sameClipboardImage(const Clip &a, const Clip &b)
static const Format *clipboardImageFormat(const Clip &c)
{
// OLE DataObject / Ole Private Data change when Snipping Tool republishes
// the same capture. They are transport metadata, not image identity.
auto image = [](const Clip &c) -> const Format *
{
if (!c.text().empty())
return nullptr;
for (const auto &f : c.formats)
@@ -458,8 +642,42 @@ bool sameClipboardImage(const Clip &a, const Clip &b)
if (f.id == id && !f.data.empty())
return &f;
return nullptr;
};
const auto *left = image(a), *right = image(b);
}
static std::string clipboardHash(const Bytes &bytes)
{
struct Hash {
HCRYPTPROV provider{}; HCRYPTHASH hash{};
~Hash() { if (hash) CryptDestroyHash(hash); if (provider) CryptReleaseContext(provider, 0); }
} state;
if (!CryptAcquireContextW(&state.provider, nullptr, nullptr, PROV_RSA_AES, CRYPT_VERIFYCONTEXT) ||
!CryptCreateHash(state.provider, CALG_SHA_256, 0, 0, &state.hash) ||
!CryptHashData(state.hash, bytes.data(), static_cast<DWORD>(bytes.size()), 0))
throw std::runtime_error("Cannot hash clipboard data");
BYTE digest[32]{}; DWORD size = sizeof(digest);
if (!CryptGetHashParam(state.hash, HP_HASHVAL, digest, &size, 0) || size != sizeof(digest))
throw std::runtime_error("Cannot read clipboard hash");
static constexpr char hex[] = "0123456789abcdef";
std::string result; result.reserve(64);
for (auto b : digest) { result += hex[b >> 4]; result += hex[b & 15]; }
return result;
}
static void imageFingerprints(Entry &entry, const Clip &clip, bool decodePixels = true)
{
const auto *image = clipboardImageFormat(clip);
if (!image) return;
if (entry.imageHash.empty())
entry.imageHash = std::to_string(image->id) + ":" + utf8(image->name) + ":" + clipboardHash(image->data);
if (!decodePixels) return;
try {
auto pixels = decodeImage(clip);
entry.pixelHash = std::to_string(pixels.width) + "x" + std::to_string(pixels.height) + ":" + clipboardHash(pixels.bgra);
} catch (const std::exception &) {
// Undecodable images can still be compared by their original bytes.
}
}
bool sameClipboardImage(const Clip &a, const Clip &b)
{
const auto *left = clipboardImageFormat(a), *right = clipboardImageFormat(b);
if (!left || !right)
return false;
if (left->id == right->id && left->name == right->name && left->data == right->data)
@@ -483,15 +701,40 @@ void History::add(const Clip &clip, const std::wstring &app, const Settings &s)
auto data = encodeClip(clip);
if (data.size() > uint64_t(s.maxImageMiB) * 1024 * 1024)
return;
bool image = false, files = false;
for (const auto &f : clip.formats)
{
image |= f.id == CF_DIB || f.id == CF_DIBV5 || f.name == L"PNG";
files |= f.id == CF_HDROP;
}
std::lock_guard lock(mutex_);
// Compare only the newest record; never keep image payloads in the resident index.
if (!entries_.empty())
Entry fingerprints;
fingerprints.contentHash = clipboardHash(data);
if (!entries_.empty() && entries_.front().contentHash == fingerprints.contentHash)
return;
imageFingerprints(fingerprints, clip, false);
if (!entries_.empty() && !fingerprints.imageHash.empty() && entries_.front().imageHash == fingerprints.imageHash)
return;
imageFingerprints(fingerprints, clip);
// Different payload kinds cannot be duplicates. Consult the index first so
// copying text after a screenshot never loads/decrypts the previous image.
if (!entries_.empty() && entries_.front().image == image && entries_.front().files == files)
{
try
{
auto previous = load(entries_.front().id);
if (encodeClip(previous) == data || sameClipboardImage(previous, clip))
auto &previous = entries_.front();
bool migrated = previous.contentHash.empty();
if (migrated) {
auto oldClip = load(previous.id);
previous.contentHash = clipboardHash(encodeClip(oldClip));
imageFingerprints(previous, oldClip);
}
if (previous.contentHash == fingerprints.contentHash ||
(!fingerprints.imageHash.empty() && previous.imageHash == fingerprints.imageHash) ||
(!fingerprints.pixelHash.empty() && previous.pixelHash == fingerprints.pixelHash)) {
if (migrated) saveIndex();
return;
}
}
catch (...)
{
@@ -506,12 +749,6 @@ void History::add(const Clip &clip, const std::wstring &app, const Settings &s)
auto encrypted = protect(data);
atomicWrite(folder_ / (id + L".dat"), encrypted);
auto text = clip.text();
bool image = false, files = false;
for (auto &f : clip.formats)
{
image |= f.id == CF_DIB || f.id == CF_DIBV5 || f.name == L"PNG";
files |= f.id == CF_HDROP;
}
if (text.empty())
text = files ? L"[Files]" : image ? L"[Image]" : L"[Clipboard data]";
for (auto &c : text)
@@ -524,7 +761,8 @@ void History::add(const Clip &clip, const std::wstring &app, const Settings &s)
entries_.insert(entries_.begin(),
Entry{id, text, app, encrypted.size(),
(uint64_t(now.dwHighDateTime) << 32) | now.dwLowDateTime, false, image, files,
image ? 1 : 0, ocrProfile(s)});
image ? 1 : 0, ocrProfile(s), std::move(fingerprints.contentHash),
std::move(fingerprints.imageHash), std::move(fingerprints.pixelHash)});
prune(s);
saveIndex();
}
@@ -563,6 +801,103 @@ void History::clear()
std::filesystem::remove(folder_ / (e.id + L".ocr"), ec);
}
}
static Bytes historyImageJob(const std::filesystem::path &folder, const std::wstring &id,
const Json &job, const std::function<bool()> &cancelled)
{
if (!validId(id)) throw std::runtime_error("Invalid history ID");
if (cancelled && cancelled()) throw std::runtime_error("History OCR cancelled");
auto request = std::filesystem::absolute(folder) / (L"ocr-" + newSnippetId() + L".request");
auto response = request; response += L".result";
struct Cleanup {
std::filesystem::path request, response;
~Cleanup() {
std::error_code ignored;
std::filesystem::remove(request, ignored);
std::filesystem::remove(response, ignored);
}
} cleanup{request, response};
atomicWrite(request, protect(jsonBytes(job)));
auto helper = std::filesystem::path(executable()).parent_path() / L"KSwitcher.Screenshot.exe";
auto command = L"\"" + helper.wstring() + L"\" --history-ocr \"" + request.wstring() + L"\"";
STARTUPINFOW startup{sizeof(startup)};
startup.dwFlags = STARTF_USESHOWWINDOW; startup.wShowWindow = SW_HIDE;
PROCESS_INFORMATION process{};
if (!CreateProcessW(helper.c_str(), command.data(), nullptr, nullptr, FALSE, CREATE_NO_WINDOW,
nullptr, helper.parent_path().c_str(), &startup, &process))
throw std::runtime_error(utf8(lastError(L"Cannot start history OCR helper")));
CloseHandle(process.hThread);
struct Child {
HANDLE handle;
~Child() {
if (WaitForSingleObject(handle, 0) != WAIT_OBJECT_0) {
TerminateProcess(handle, ERROR_CANCELLED);
WaitForSingleObject(handle, INFINITE);
}
CloseHandle(handle);
}
} child{process.hProcess};
auto deadline = GetTickCount64() + 60000;
for (;;) {
auto wait = WaitForSingleObject(child.handle, 100);
if (wait == WAIT_OBJECT_0) break;
if (wait != WAIT_TIMEOUT) throw std::runtime_error("Cannot wait for history OCR helper");
if (cancelled && cancelled()) throw std::runtime_error("History OCR cancelled");
if (GetTickCount64() >= deadline) throw std::runtime_error("History OCR helper timed out");
}
DWORD result{};
if (!GetExitCodeProcess(child.handle, &result) || result)
throw std::runtime_error("History OCR helper failed: " + std::to_string(result));
return unprotect(readFile(response, 8 * 1024 * 1024));
}
std::wstring History::recognizeImage(const std::wstring &id, const Settings &settings,
const std::function<bool()> &cancelled) const
{
Json job{{"schema", 1}, {"id", utf8(id)}, {"tesseract", settings.useTesseract},
{"path", utf8(settings.tesseractPath)}, {"languages", utf8(settings.tesseractLanguages)}};
auto reply = parse(historyImageJob(folder_, id, job, cancelled));
if (reply.at("schema") != 1 || str(reply, "id") != id)
throw std::runtime_error("Invalid history OCR response");
return str(reply, "text");
}
Pixels History::thumbnail(const std::wstring &id, const std::function<bool()> &cancelled) const
{
auto bytes = historyImageJob(folder_, id, Json{{"schema", 1}, {"id", utf8(id)}, {"thumbnail", true}}, cancelled);
size_t at = 0;
auto width = get32(bytes, at), height = get32(bytes, at);
if (!width || !height || width > 208 || height > 128 || bytes.size() - at != width * height * 4)
throw std::runtime_error("Invalid history thumbnail response");
bytes.erase(bytes.begin(), bytes.begin() + at);
return Pixels{width, height, std::move(bytes)};
}
int runHistoryOcr(const std::filesystem::path &request)
{
try {
if (!request.is_absolute() || !request.filename().wstring().starts_with(L"ocr-") ||
request.extension() != L".request") return 1;
auto job = parse(unprotect(readFile(request, 1024 * 1024)));
auto id = str(job, "id");
if (job.at("schema") != 1 || !validId(id)) return 1;
auto clip = decodeClip(unprotect(readFile(request.parent_path() / (id + L".dat"), 80 * 1024 * 1024)));
if (job.value("thumbnail", false)) {
auto pixels = decodeImage(clip, 208, 128);
if (!pixels.width || !pixels.height) return 1;
Bytes reply;
put32(reply, pixels.width); put32(reply, pixels.height);
reply.insert(reply.end(), pixels.bgra.begin(), pixels.bgra.end());
atomicWrite(request.wstring() + L".result", protect(reply));
return 0;
}
Settings settings;
settings.useTesseract = job.at("tesseract").get<bool>();
settings.tesseractPath = str(job, "path");
settings.tesseractLanguages = str(job, "languages");
auto text = utf8(recognizeText(clip, settings));
if (text.size() > 1024 * 1024) return 1;
auto response = request; response += L".result";
atomicWrite(response, protect(jsonBytes(Json{{"schema", 1}, {"id", utf8(id)}, {"text", text}})));
return 0;
} catch (...) { return 1; }
}
bool History::saveOcr(const std::wstring &id, const std::optional<std::wstring> &text, const Settings &settings)
{
std::lock_guard lock(mutex_);
@@ -603,9 +938,10 @@ std::optional<std::wstring> History::ocrText(const std::wstring &id, const std::
if (bytes.empty() || bytes.front() != 1) throw std::runtime_error("Invalid OCR text format");
return wide(std::string(bytes.begin() + 1, bytes.end()));
}
std::vector<Entry> History::search(const std::wstring &query) const
std::vector<Entry> History::search(const std::wstring &query, bool pinnedOnly) const
{
auto items = entries();
if (pinnedOnly) std::erase_if(items, [](const Entry &entry) { return !entry.pinned; });
if (query.empty())
return items;
auto q = lower(query);
+29 -1
View File
@@ -1,8 +1,10 @@
#pragma once
#include "platform.h"
#include <mutex>
#include <functional>
namespace ks
{
struct Pixels;
Settings loadSettings(const std::filesystem::path &, const std::vector<Layout> &);
Settings decodeSettings(const Bytes &, const std::vector<Layout> &);
Bytes encodeSettings(const Settings &);
@@ -15,6 +17,7 @@ struct Entry
bool pinned{}, image{}, files{};
int ocrState{}; // 0: legacy/not applicable, 1: pending, 2: saved, 3: failed
std::wstring ocrProfile = L"windows";
std::string contentHash, imageHash, pixelHash;
};
class History
{
@@ -22,21 +25,46 @@ class History
std::vector<Entry> entries_;
mutable std::mutex mutex_;
void saveIndex();
void loadIndex();
void prune(const Settings &);
public:
explicit History(const std::filesystem::path &);
void reload();
std::vector<Entry> entries() const;
Clip load(const std::wstring &id) const;
void add(const Clip &, const std::wstring &app, const Settings &);
bool captureImage(DWORD sequence, const std::wstring &app, const Settings &);
std::wstring recognizeImage(const std::wstring &id, const Settings &,
const std::function<bool()> &cancelled = {}) const;
Pixels thumbnail(const std::wstring &id, const std::function<bool()> &cancelled = {}) const;
bool saveOcr(const std::wstring &id, const std::optional<std::wstring> &, const Settings &);
std::optional<std::wstring> ocrText(const std::wstring &id, const std::wstring &profile = L"") const;
void remove(const std::wstring &);
void pin(const std::wstring &);
void clear();
std::vector<Entry> search(const std::wstring &) const;
std::vector<Entry> search(const std::wstring &, bool pinnedOnly = false) const;
};
Bytes encodeClip(const Clip &);
Bytes selectionClipboardIdentity(const Clip &);
Clip decodeClip(const Bytes &);
bool sameClipboardImage(const Clip &, const Clip &);
int runImageHistoryCapture(const std::filesystem::path &request);
int runHistoryOcr(const std::filesystem::path &request);
// Image backups stay encrypted on disk and are read/written only by a short-lived helper.
class ClipboardSnapshot
{
Clip clip_;
std::filesystem::path request_;
void cleanup() noexcept;
DWORD run(bool restore, DWORD sequence);
public:
ClipboardSnapshot() = default;
ClipboardSnapshot(const ClipboardSnapshot &) = delete;
ClipboardSnapshot &operator=(const ClipboardSnapshot &) = delete;
~ClipboardSnapshot();
void capture(HWND, DWORD sequence);
DWORD restore(HWND, DWORD sequence);
};
int runClipboardSnapshot(const std::filesystem::path &request);
} // namespace ks
+87 -22
View File
@@ -468,12 +468,17 @@ struct SearchResult
uint64_t generation;
std::vector<Entry> items;
};
struct TextPreview
{
std::string rtf;
std::wstring plain;
};
struct PreviewResult
{
uint64_t generation;
std::wstring id;
Pixels pixels;
std::string rtf;
TextPreview text;
};
struct HistoryView
{
@@ -481,12 +486,14 @@ struct HistoryView
std::vector<Entry> items;
std::wstring rememberedSelection, rememberedTop;
uint64_t generation{};
std::shared_ptr<std::atomic<bool>> previewActive = std::make_shared<std::atomic<bool>>(true);
std::map<std::wstring, Pixels> thumbnails;
std::map<std::wstring, std::string> richTexts;
std::map<std::wstring, TextPreview> richTexts;
HWND rich{};
std::set<std::wstring> pending;
bool scrolling{};
bool closed{};
bool selectFirstOnResults{};
};
bool selectedImage(HWND w, HistoryView *v)
{
@@ -504,17 +511,20 @@ std::wstring selected(HWND w, HistoryView *v)
}
void search(HWND w, HistoryView *v)
{
v->previewActive->store(false);
v->previewActive = std::make_shared<std::atomic<bool>>(true);
v->closed = false;
auto q = value(w, 101);
const bool pinnedOnly = SendDlgItemMessageW(w, 117, BM_GETCHECK, 0, 0) == BST_CHECKED;
auto generation = ++v->generation;
v->pending.clear();
auto *app = v->app;
app->enqueueHistorySearch(
[w, app, q, generation]
[w, app, q, generation, pinnedOnly]
{
try
{
auto result = new SearchResult{generation, app->history->search(q)};
auto result = new SearchResult{generation, app->history->search(q, pinnedOnly)};
if (!PostMessageW(w, ResultsMessage, 0, (LPARAM)result))
delete result;
}
@@ -532,23 +542,31 @@ void requestPreview(HWND w, HistoryView *v, const Entry &entry)
if (v->thumbnails.contains(id) || v->richTexts.contains(id) || !v->pending.insert(id).second)
return;
auto generation = v->generation;
auto active = v->previewActive;
auto *app = v->app;
app->enqueue(
[w, app, id, generation, image]
[w, app, id, generation, image, active]
{
if (!active->load()) return;
auto result = new PreviewResult{generation, id, {}, {}};
try
{
auto clip = app->history->load(id);
if (image)
result->pixels = decodeImage(clip, 208, 128);
else
result->rtf = richPreview(clip);
result->pixels = app->history->thumbnail(id, [active] { return !active->load(); });
else {
auto clip = app->history->load(id);
if (!active->load()) { delete result; return; }
result->text.rtf = richPreview(clip, false);
if (result->text.rtf.empty()) {
result->text.plain = clip.text();
if (result->text.plain.size() > 4096) result->text.plain.resize(4096);
}
}
}
catch (const std::exception &)
{
}
if (!PostMessageW(w, PreviewMessage, 0, (LPARAM)result))
if (!active->load() || !PostMessageW(w, PreviewMessage, 0, (LPARAM)result))
delete result;
});
}
@@ -602,9 +620,13 @@ void drawHistoryRow(HWND w, HistoryView *v, const DRAWITEMSTRUCT &draw)
if (!entry.image && !entry.files)
{
auto rich = v->richTexts.find(entry.id);
if (rich != v->richTexts.end() && v->rich && !rich->second.empty())
if (rich != v->richTexts.end() && rich->second.rtf.empty())
text = (entry.pinned ? L"★ " : L"") + rich->second.plain;
if (rich != v->richTexts.end() && !rich->second.rtf.empty() && !v->rich)
v->rich = createRichText(w, 105, false);
if (rich != v->richTexts.end() && v->rich && !rich->second.rtf.empty())
{
setRichText(v->rich, rich->second);
setRichText(v->rich, rich->second.rtf);
CHARFORMAT2W format{};
format.cbSize = sizeof(format);
format.dwMask = CFM_COLOR;
@@ -719,6 +741,12 @@ LRESULT CALLBACK historyProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
case WM_COMMAND:
{
int id = LOWORD(wp);
if (id == 117 && HIWORD(wp) == BN_CLICKED)
{
KillTimer(w, 1);
search(w, v);
return 0;
}
if (id == 101 && HIWORD(wp) == EN_CHANGE)
{
// Reject an older result even during the debounce interval.
@@ -751,7 +779,10 @@ LRESULT CALLBACK historyProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
{
if (!entry.empty())
{
if (id == 112)
if (v->app->historyService) {
v->app->remoteHistory(id == 112 ? "pin" : "remove", entry);
v->app->history->reload();
} else if (id == 112)
v->app->history->pin(entry);
else
v->app->history->remove(entry);
@@ -786,6 +817,14 @@ LRESULT CALLBACK historyProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
int top=(int)SendDlgItemMessageW(w,102,LB_GETTOPINDEX,0,0);
auto topId=top>=0 && top<(int)v->items.size()?v->items[top].id:L"";
if (topId.empty()) topId = v->rememberedTop;
if (v->selectFirstOnResults)
{
old.clear();
topId.clear();
v->rememberedSelection.clear();
v->rememberedTop.clear();
v->selectFirstOnResults = false;
}
v->items = std::move(result->items);
SendDlgItemMessageW(w, 102, WM_SETREDRAW, FALSE, 0);
SendDlgItemMessageW(w, 102, LB_RESETCONTENT, 0, 0);
@@ -825,14 +864,14 @@ LRESULT CALLBACK historyProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
visible.insert(v->items[i].id);
if(v->items[i].id==result->id) { changed=intersection; repaint=true; }
}
if (!result->rtf.empty())
v->richTexts[result->id] = std::move(result->rtf);
if (!result->text.rtf.empty() || !result->text.plain.empty())
v->richTexts[result->id] = std::move(result->text);
else
v->thumbnails[result->id] = std::move(result->pixels);
trimHistoryPreviews(v->thumbnails,visible,32,HistoryThumbnailBudget,
[](const Pixels &p) { return p.bgra.capacity(); });
trimHistoryPreviews(v->richTexts,visible,32,HistoryRichTextBudget,
[](const std::string &s) { return s.capacity(); });
[](const TextPreview &s) { return s.rtf.capacity() + s.plain.capacity() * sizeof(wchar_t); });
if(repaint) InvalidateRect(list,&changed,FALSE);
return 0;
}
@@ -887,20 +926,25 @@ LRESULT CALLBACK historyProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
v->rememberedSelection = selected(w, v);
int top = (int)SendDlgItemMessageW(w,102,LB_GETTOPINDEX,0,0);
v->rememberedTop = top >= 0 && top < (int)v->items.size() ? v->items[top].id : L"";
v->app->saveHistoryView(v->rememberedSelection, v->rememberedTop, value(w, 101),
SendDlgItemMessageW(w, 117, BM_GETCHECK, 0, 0) == BST_CHECKED);
KillTimer(w, 1);
v->closed = true;
v->previewActive->store(false);
++v->generation; // Discard search/preview results queued before closing.
ShowWindow(w, SW_HIDE);
SendDlgItemMessageW(w,102,LB_RESETCONTENT,0,0);
std::vector<Entry>().swap(v->items);
v->thumbnails.clear();
v->richTexts.clear();
if (v->rich)
SetWindowTextW(v->rich, L"");
if (v->rich) SetWindowTextW(v->rich, L"");
v->pending.clear();
if (v->app->historyService && !v->app->historyEntryWindows)
PostMessageW(v->app->window, WM_CLOSE, 0, 0);
return 0;
}
case WM_NCDESTROY:
v->previewActive->store(false);
disposeFont(w);
v->app->historyWindow = nullptr;
delete v;
@@ -1660,13 +1704,19 @@ LRESULT CALLBACK snippetProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
#ifndef KS_CONFIG_APP
LRESULT CALLBACK entryProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
{
if (msg == WM_NCCREATE)
SetWindowLongPtrW(w, GWLP_USERDATA, (LONG_PTR)((CREATESTRUCTW *)lp)->lpCreateParams);
if (msg == WM_SIZE)
{
MoveWindow(GetDlgItem(w, 1), 10, 10, LOWORD(lp) - 20, HIWORD(lp) - 20, TRUE);
return 0;
}
if (msg == WM_NCDESTROY)
if (msg == WM_NCDESTROY) {
disposeFont(w);
auto *app = (App *)GetWindowLongPtrW(w, GWLP_USERDATA);
if (app && app->historyService && app->historyEntryWindows && !--app->historyEntryWindows &&
!IsWindowVisible(app->historyWindow)) PostMessageW(app->window, WM_CLOSE, 0, 0);
}
return DefWindowProcW(w, msg, wp, lp);
}
#endif
@@ -1674,6 +1724,7 @@ LRESULT CALLBACK entryProc(HWND w, UINT msg, WPARAM wp, LPARAM lp)
#ifndef KS_CONFIG_APP
void refreshHistory(App &app)
{
if (app.isolateHistory) { app.refreshHistoryProcess(); return; }
if (app.historyWindow)
{
auto *v = (HistoryView *)GetWindowLongPtrW(app.historyWindow, GWLP_USERDATA);
@@ -1682,6 +1733,7 @@ void refreshHistory(App &app)
}
void showHistory(App &app, bool visible)
{
if (app.isolateHistory) { if (visible) app.openHistoryProcess(); return; }
if (!app.history)
{
app.report(L"Clipboard history is unavailable. See the log in the data folder.");
@@ -1702,9 +1754,11 @@ void showHistory(App &app, bool visible)
HWND w = makeWindow(app, L"KSwitcher.History", L"Clipboard history", historyProc, 760, 500);
app.historyWindow = w;
windowLayoutState(w)->history = true;
((HistoryView *)GetWindowLongPtrW(w, GWLP_USERDATA))->rich = createRichText(w, 105, false);
label(w, L"&Search clipboard history", 16, 12, 500);
edit(w, 101, 16, 38, 728);
auto filter = control(w, L"BUTTON", L"★ Pinned only", WS_TABSTOP | BS_AUTOCHECKBOX,
117, 16, 38, 112, 25);
SendMessageW(filter, BM_SETCHECK, app.historyPinnedOnly ? BST_CHECKED : BST_UNCHECKED, 0);
label(w, L"&Search clipboard history", 136, 12, 500);
edit(w, 101, 136, 38, 608);
auto list = control(w, L"LISTBOX", L"",
WS_TABSTOP | WS_VSCROLL | LBS_NOTIFY | LBS_NOINTEGRALHEIGHT | WS_BORDER |
LBS_OWNERDRAWFIXED | LBS_HASSTRINGS,
@@ -1718,8 +1772,18 @@ void showHistory(App &app, bool visible)
button(w, L"Clear &history…", 116, 546, 452, 150);
SetWindowSubclass(list, historyKey, 1, (DWORD_PTR)w);
SetWindowSubclass(GetDlgItem(w, 101), historyKey, 1, (DWORD_PTR)w);
if (app.historyService) {
auto *v = (HistoryView *)GetWindowLongPtrW(w, GWLP_USERDATA);
v->rememberedSelection = app.historySelection;
v->rememberedTop = app.historyTop;
SetDlgItemTextW(w, 101, app.historyQuery.c_str());
}
}
if (!visible) return;
// A fresh invocation starts at the newest matching item. Background search
// and OCR refreshes still preserve the user's selection while browsing.
auto *view = (HistoryView *)GetWindowLongPtrW(app.historyWindow, GWLP_USERDATA);
view->selectFirstOnResults = true;
POINT cursor;
GetCursorPos(&cursor);
MONITORINFO monitor{sizeof(monitor)};
@@ -1874,6 +1938,7 @@ void showEntry(App &app, const std::wstring &id)
}
HWND w = makeWindow(app, L"KSwitcher.Entry", L"Clipboard item", entryProc, 720, 500,
WS_THICKFRAME | WS_MAXIMIZEBOX);
if (app.historyService) ++app.historyEntryWindows;
auto field = edit(w, 1, 10, 10, 700, 480, ES_MULTILINE | ES_READONLY | ES_AUTOVSCROLL | WS_VSCROLL);
SetWindowTextW(field, text.c_str());
showRequestedWindow(w);
+1 -1
View File
@@ -2,7 +2,7 @@
#include "platform.h"
namespace ks
{
inline constexpr wchar_t AppVersion[] = L"0.6.36";
inline constexpr wchar_t AppVersion[] = L"0.6.45";
inline constexpr UINT UpdateMessage = WM_APP + 7;
inline constexpr UINT UpdateCheckIntervalMs = 6 * 60 * 60 * 1000;
inline constexpr UINT UpdateNotificationRetryMs = 5 * 60 * 1000;
+41
View File
@@ -0,0 +1,41 @@
#pragma once
#include <algorithm>
#include <cwchar>
#include <filesystem>
#include <string>
#include <vector>
namespace ks
{
// Scan each time the menu opens, relative to the resident executable, not its working directory.
inline std::vector<std::filesystem::path> discoverUtilities(const std::filesystem::path &folder,
std::error_code &error)
{
error.clear();
std::vector<std::filesystem::path> result;
std::filesystem::directory_iterator it(folder, error), end;
if (error == std::errc::no_such_file_or_directory) error.clear();
while (!error && it != end)
{
std::error_code entryError;
if (_wcsicmp(it->path().extension().c_str(), L".exe") == 0 && it->is_regular_file(entryError))
result.push_back(it->path());
it.increment(error);
}
if (error) result.clear();
std::sort(result.begin(), result.end(), [](const auto &a, const auto &b) {
return _wcsicmp(a.filename().c_str(), b.filename().c_str()) < 0;
});
return result;
}
inline std::wstring utilityMenuLabel(const std::filesystem::path &path)
{
std::wstring label;
for (wchar_t ch : path.stem().wstring())
{
label += ch;
if (ch == L'&') label += ch; // Win32 uses ampersands for access keys.
}
return label;
}
}
+108
View File
@@ -0,0 +1,108 @@
// Run with the resident stopped. The suite restores the original clipboard.
#include "storage.h"
#include "ocr.h"
#include <psapi.h>
#include <iostream>
#include <algorithm>
static void require(bool ok, const char *name) {
if (!ok) throw std::runtime_error(name);
std::cout << "PASS " << name << '\n';
}
static HWND owner() {
return CreateWindowExW(0,L"STATIC",L"Snapshot test",0,0,0,0,0,HWND_MESSAGE,nullptr,nullptr,nullptr);
}
static void child(const std::wstring &argument) {
auto exe=ks::executable(), command=L"\""+exe+L"\" "+argument;
STARTUPINFOW startup{sizeof(startup)}; startup.dwFlags=STARTF_USESHOWWINDOW; startup.wShowWindow=SW_HIDE;
PROCESS_INFORMATION p{};
if(!CreateProcessW(exe.c_str(),command.data(),nullptr,nullptr,FALSE,CREATE_NO_WINDOW,nullptr,nullptr,&startup,&p))
throw std::runtime_error("start fixture process");
CloseHandle(p.hThread);
auto wait=WaitForSingleObject(p.hProcess,30000); DWORD code=1;
if(wait!=WAIT_OBJECT_0) {TerminateProcess(p.hProcess,1);WaitForSingleObject(p.hProcess,INFINITE);}
GetExitCodeProcess(p.hProcess,&code); CloseHandle(p.hProcess);
if(code) throw std::runtime_error("fixture process failed");
}
static size_t resident() {
ks::Bytes b(1024*1024); auto ws=reinterpret_cast<PSAPI_WORKING_SET_INFORMATION*>(b.data());
if(!QueryWorkingSet(GetCurrentProcess(),ws,DWORD(b.size()))) throw std::runtime_error("working set query");
size_t pages=0; for(size_t i=0;i<ws->NumberOfEntries;++i) if(!ws->WorkingSetInfo[i].Shared) ++pages;
return pages*4096;
}
static void verifyImage(HWND w) {
auto c=ks::readClipboard(w,64*1024*1024);
for(auto id:{CF_DIB,CF_DIBV5}) {
auto it=std::find_if(c.formats.begin(),c.formats.end(),[&](const auto &f){return f.id==UINT(id);});
require(it!=c.formats.end(),"restores image representation");
auto pixels=ks::decodeImage(ks::Clip{{*it}});
require(pixels.width==1566 && pixels.height==1068 && pixels.bgra.front()==77,"preserves image pixels");
}
require(c.text()==L"Snapshot mixed text","preserves accompanying text");
}
int main(int argc,char**argv) {
CoInitializeEx(nullptr,COINIT_MULTITHREADED);
HWND w=owner(); int result=0; ks::Clip original; bool saved=false;
try {
std::string mode=argc>1?argv[1]:"suite";
if(mode=="publish") {
ks::Pixels p{1566,1068,ks::Bytes(1566*1068*4,255)}; p.bgra[0]=77;
auto dib=ks::imageDib(p); auto v5=dib;
BITMAPV5HEADER h{}; h.bV5Size=sizeof(h); h.bV5Width=p.width; h.bV5Height=-p.height;
h.bV5Planes=1; h.bV5BitCount=32; h.bV5Compression=BI_BITFIELDS;
h.bV5RedMask=0xff0000; h.bV5GreenMask=0xff00; h.bV5BlueMask=0xff; h.bV5AlphaMask=0xff000000;
v5.id=CF_DIBV5; v5.data.resize(sizeof(h)+p.bgra.size());
memcpy(v5.data.data(),&h,sizeof(h)); memcpy(v5.data.data()+sizeof(h),p.bgra.data(),p.bgra.size());
auto clip=ks::textClip(L"Snapshot mixed text"); clip.formats.push_back(dib); clip.formats.push_back(v5);
ks::writeClipboard(w,clip);
} else if(mode=="old" || mode=="new") {
child(L"publish"); auto baseline=resident();
if(mode=="old") {
auto clip=ks::readClipboard(w,64*1024*1024);
ks::writeClipboard(w,ks::textClip(L"temporary")); ks::writeClipboard(w,clip);
} else {
ks::ClipboardSnapshot snapshot; snapshot.capture(w,GetClipboardSequenceNumber());
auto seq=ks::writeClipboard(w,ks::textClip(L"temporary"));
require(snapshot.restore(w,seq)==GetClipboardSequenceNumber(),"helper returns current sequence");
}
auto after=resident();
auto report="baseline="+std::to_string(baseline)+" after="+std::to_string(after)+" delta="+std::to_string(int64_t(after)-int64_t(baseline))+"\n";
auto path=std::filesystem::path(ks::executable()).parent_path()/(L"snapshot-memory-"+ks::wide(mode)+L".txt");
ks::atomicWrite(path,ks::Bytes(report.begin(),report.end()));
verifyImage(w); // Only after measuring: verification intentionally reads images.
} else {
original=ks::readClipboard(w,128*1024*1024); saved=true;
child(L"old"); child(L"new"); child(L"publish");
auto seq=GetClipboardSequenceNumber();
auto selected=ks::readClipboard(w,32*1024*1024,ks::ClipboardRead::Selection);
require(selected.formats.size()==1 && selected.text()==L"Snapshot mixed text","selection read excludes image data");
bool rejected=false;
try {ks::readClipboard(w,32*1024*1024,ks::ClipboardRead::WithoutImages,seq);} catch(...) {rejected=true;}
require(rejected,"resident rejects images before reading their data");
{
ks::ClipboardSnapshot snapshot; snapshot.capture(w,seq);
auto stale=ks::writeClipboard(w,ks::textClip(L"temporary"));
ks::writeClipboard(w,ks::textClip(L"external copy")); rejected=false;
try {snapshot.restore(w,stale);} catch(...) {rejected=true;}
require(rejected && ks::readClipboard(w).text()==L"external copy","stale image restore preserves external copy");
}
{
ks::ClipboardSnapshot snapshot; snapshot.capture(w,GetClipboardSequenceNumber());
auto temporary=ks::writeClipboard(w,ks::textClip(L"temporary"));
snapshot.restore(w,temporary);
require(ks::readClipboard(w).text()==L"external copy","text snapshot fast path restores clipboard");
}
{
ks::Clip empty; auto seqEmpty=ks::writeClipboard(w,empty);
ks::ClipboardSnapshot snapshot; snapshot.capture(w,seqEmpty);
snapshot.restore(w,ks::writeClipboard(w,ks::textClip(L"temporary")));
require(ks::readClipboard(w).formats.empty(),"empty clipboard restored");
}
auto marked=ks::textClip(L"line"); marked.formats.push_back({0,L"MSDEVLineSelect",ks::Bytes{1}});
ks::writeClipboard(w,marked);
require(ks::readClipboard(w,1024,ks::ClipboardRead::Selection).formats.size()==2,"selection reader preserves editor guard metadata");
std::cout<<"PASS clipboard snapshot suite\n";
}
} catch(const std::exception &e) {std::cerr<<"FAIL "<<e.what()<<'\n';result=1;}
if(saved) try {ks::writeClipboard(w,original);} catch(...) {result=1;}
DestroyWindow(w); CoUninitialize(); return result;
}
+129
View File
@@ -0,0 +1,129 @@
// Explicit Windows integration test. Opens an isolated Far profile and never
// types into an existing Far window. Requires Far Manager at its default path.
#include "app.h"
#include <cstdlib>
#include <cwctype>
#include <fstream>
#include <future>
namespace ks {
struct InputRegressionAccess {
static void runQueued(App &app) {
std::function<void()> job;
{ std::lock_guard lock(app.jobsMutex);
if (app.jobs.empty()) throw std::runtime_error("snippet did not queue");
job=std::move(app.jobs.front());app.jobs.pop_front(); }
auto future=std::async(std::launch::async,[job=std::move(job)] {
CoInitializeEx(nullptr,COINIT_APARTMENTTHREADED);job();CoUninitialize();
});
while(future.wait_for(std::chrono::milliseconds(5))!=std::future_status::ready) {
MSG message{};while(PeekMessageW(&message,nullptr,0,0,PM_REMOVE)) {
TranslateMessage(&message);DispatchMessageW(&message);
}
}
future.get();app.replayTyping();
}
};
}
int WINAPI wWinMain(HINSTANCE instance,HINSTANCE,PWSTR,int) {
auto base=std::filesystem::path(ks::executable()).parent_path();
std::ofstream log(base/L"far-snippets.log");
int checks=0;
auto require=[&](bool ok,const char *message) {
if(!ok)throw std::runtime_error(message);
++checks;log<<"PASS "<<message<<'\n';log.flush();
};
auto folder=std::filesystem::temp_directory_path()/(L"ks-far-snippets-"+ks::newSnippetId());
std::filesystem::create_directories(folder);
CoInitializeEx(nullptr,COINIT_APARTMENTTHREADED);
ks::Clip saved;bool captured=false;PROCESS_INFORMATION child{};
HANDLE input=INVALID_HANDLE_VALUE,output=INVALID_HANDLE_VALUE;
HWND farWindow{};
HWND owner=CreateWindowExW(0,L"STATIC",L"Far snippet fixture clipboard",0,0,0,0,0,HWND_MESSAGE,nullptr,instance,nullptr);
auto originalForeground=GetForegroundWindow();
int result=1;
try {
saved=ks::readClipboard(owner,128*1024*1024);captured=true;
auto sentinel=ks::textClip(L"KSwitcher Far fixture clipboard");
sentinel.formats.push_back({0,L"ExcludeClipboardContentFromMonitorProcessing",ks::Bytes{0}});
ks::writeClipboard(owner,sentinel);
const auto programFiles=_wgetenv(L"ProgramFiles");
if(!programFiles)throw std::runtime_error("ProgramFiles is unavailable");
auto farExecutable=std::filesystem::path(programFiles)/L"Far Manager/Far.exe";
std::wstring command=L"\""+farExecutable.wstring()+L"\" -m -p -s \""+folder.wstring()+L"\\profile\" \""+folder.wstring()+L"\"";
STARTUPINFOW startup{sizeof(startup)};startup.dwFlags=STARTF_USESHOWWINDOW;startup.wShowWindow=SW_HIDE;
require(CreateProcessW(nullptr,command.data(),nullptr,nullptr,FALSE,CREATE_NEW_CONSOLE,nullptr,folder.c_str(),&startup,&child),"start isolated Far without plugins/macros");
CloseHandle(child.hThread);Sleep(1800);
require(AttachConsole(child.dwProcessId),"attach isolated console for test-only input and observation");
input=CreateFileW(L"CONIN$",GENERIC_READ|GENERIC_WRITE,FILE_SHARE_READ|FILE_SHARE_WRITE,nullptr,OPEN_EXISTING,0,nullptr);
output=CreateFileW(L"CONOUT$",GENERIC_READ|GENERIC_WRITE,FILE_SHARE_READ|FILE_SHARE_WRITE,nullptr,OPEN_EXISTING,0,nullptr);
require(input!=INVALID_HANDLE_VALUE && output!=INVALID_HANDLE_VALUE,"open isolated console buffers");
auto target=GetConsoleWindow();farWindow=target;ShowWindow(target,SW_SHOW);
require(ks::activateWindow(target),"activate only the isolated Far window");
auto key=[&](WORD vk,wchar_t c=0,DWORD mods=0) {
INPUT_RECORD records[2]{};
for(int i=0;i<2;++i) {
auto &r=records[i];r.EventType=KEY_EVENT;
r.Event.KeyEvent={BOOL(i==0),1,vk,WORD(MapVirtualKeyW(vk,MAPVK_VK_TO_VSC)),{c},mods};
}
DWORD written{};
if(!WriteConsoleInputW(input,records,2,&written)||written!=2)throw std::runtime_error("test input failed");
Sleep(60);
};
auto position=[&] {CONSOLE_SCREEN_BUFFER_INFO info{};if(!GetConsoleScreenBufferInfo(output,&info))throw std::runtime_error("console position unavailable");return info.dwCursorPosition;};
auto row=[&] {
CONSOLE_SCREEN_BUFFER_INFO info{};GetConsoleScreenBufferInfo(output,&info);
std::wstring text(info.dwSize.X,L' ');DWORD count{};
if(!ReadConsoleOutputCharacterW(output,text.data(),DWORD(text.size()),{0,info.dwCursorPosition.Y},&count))throw std::runtime_error("console row unavailable");
return text;
};
{
ks::App app(instance,false,folder/L"data");app.window=owner;
app.settings.history=false;app.settings.autoCorrect=false;app.settings.writeLog=true;
auto prepare=[&](wchar_t last=L'r') {
if(!ks::activateWindow(target))throw std::runtime_error("isolated Far lost foreground");
key(VK_ESCAPE);key('Y',0,LEFT_CTRL_PRESSED);key(VK_OEM_1,L':',SHIFT_PRESSED);key(WORD(towupper(last)),last);
app.run.reset();app.run.window=target;app.run.layout=ks::windowLayout(target);
app.run.at=GetTickCount64();app.run.keys=L":r";
};
auto expand=[&](const std::wstring &replacement) {
app.settings.snippets={{L":r",replacement}};
app.transform(0,0);ks::InputRegressionAccess::runQueued(app);Sleep(120);
};
for(int panels=0;panels<2;++panels) {
prepare();auto before=position();auto original=row();expand(L"rider .");
auto expected=original;expected.replace(before.X-2,2,L"rider .");expected.resize(original.size());
// Far's rightmost scroll indicator is redrawn rather than shifted.
require(row().substr(0,before.X+5)==expected.substr(0,before.X+5),"actual snippet replaces :r with rider .");
require(position().X==before.X+5,"successful expansion leaves cursor after replacement");
require(ks::readClipboard(owner).text()==sentinel.text(),"snippet restores original clipboard");
prepare(L'x');before=position();original=row();expand(L"rider .{enter}");
require(row()==original && position().X==before.X,"mismatched trigger restores original caret and never executes Enter");
prepare();before=position();original=row();expand(L"left{cursor}right");
require(row().substr(before.X-2,9)==L"leftright" && position().X==before.X+2,"cursor marker uses Far selection semantics");
prepare();before=position();original=row();expand(L"first\nsecond{enter}");
require(row()==original && position().X==before.X,"multiline console template rejected before changing text or caret");
prepare();before=position();original=row();expand(L"echo KSWITCHER_FAR_FIXTURE{enter}");
for(int wait=0;wait<30 && position().X!=before.X-2;++wait)Sleep(100);
require(position().X==before.X-2 && row().substr(before.X-2,2)==L" ",
"verified Enter runs only the harmless fixture echo and returns to an empty command line");
key('O',0,LEFT_CTRL_PRESSED);
}
app.window=nullptr;
}
log<<"Passed "<<checks<<" Far snippet integration checks\n";result=0;
}catch(const std::exception &e){log<<"FAIL "<<e.what()<<" win32="<<GetLastError()<<'\n';}
// A real user or clipboard synchronizer can copy during this explicit test.
// Never replace that newer content with the fixture's original snapshot.
const auto restoreSequence=GetClipboardSequenceNumber();
const bool restoreClipboard=GetClipboardOwner()==owner || (farWindow && ks::ownsClipboard(farWindow));
if(input!=INVALID_HANDLE_VALUE)CloseHandle(input);
if(output!=INVALID_HANDLE_VALUE)CloseHandle(output);
FreeConsole();
if(child.hProcess){TerminateProcess(child.hProcess,0);WaitForSingleObject(child.hProcess,5000);CloseHandle(child.hProcess);}
if(captured && restoreClipboard && GetClipboardSequenceNumber()==restoreSequence)
try{ks::writeClipboard(owner,saved);}catch(...){result=1;}
DestroyWindow(owner);
if(IsWindow(originalForeground))ks::activateWindow(originalForeground);
CoUninitialize();return result;
}
+184
View File
@@ -0,0 +1,184 @@
// Run from an isolated fixture folder containing KSwitcher.exe and Screenshot.exe,
// with the normal resident stopped. Never points at the installed user's data.
#include "storage.h"
#include "ocr.h"
#include "json.hpp"
#include <commctrl.h>
#include <psapi.h>
#include <iostream>
static HWND editor{};
static bool pastedImage{};
static LRESULT CALLBACK targetProc(HWND w,UINT message,WPARAM wp,LPARAM lp) {
if(message==WM_SETFOCUS && editor) {SetFocus(editor);return 0;}
return DefWindowProcW(w,message,wp,lp);
}
static void require(bool ok,const char *what) {if(!ok)throw std::runtime_error(what);std::cout<<"PASS "<<what<<'\n';}
static void pump() {MSG m;while(PeekMessageW(&m,nullptr,0,0,PM_REMOVE)){TranslateMessage(&m);DispatchMessageW(&m);}}
template<class F> static void until(F condition,const char *what,DWORD timeout=10000) {
auto end=GetTickCount64()+timeout;
while(!condition()){if(GetTickCount64()>=end)throw std::runtime_error(what);pump();Sleep(10);}
}
static LRESULT send(HWND w,UINT message,WPARAM wp=0,LPARAM lp=0) {
DWORD_PTR result{};
if(!SendMessageTimeoutW(w,message,wp,lp,SMTO_ABORTIFHUNG,5000,&result))throw std::runtime_error("window request timed out");
return LRESULT(result);
}
static void command(HWND resident,int cmd) {
COPYDATASTRUCT data{1,sizeof(cmd),&cmd};send(resident,WM_COPYDATA,0,LPARAM(&data));
}
static size_t memory(HANDLE process) {
ks::Bytes bytes(1024*1024);auto ws=reinterpret_cast<PSAPI_WORKING_SET_INFORMATION*>(bytes.data());
if(!QueryWorkingSet(process,ws,DWORD(bytes.size())))throw std::runtime_error("memory query failed");
size_t pages=0;for(size_t i=0;i<ws->NumberOfEntries;++i)if(!ws->WorkingSetInfo[i].Shared)++pages;
return pages*4096;
}
static std::wstring editorText() {wchar_t text[256]{};GetWindowTextW(editor,text,256);return text;}
static LRESULT CALLBACK editProc(HWND w,UINT message,WPARAM wp,LPARAM lp,UINT_PTR,DWORD_PTR) {
if(message==WM_PASTE && IsClipboardFormatAvailable(CF_DIB)) {pastedImage=true;return 0;}
return DefSubclassProc(w,message,wp,lp);
}
static ks::Clip excluded(ks::Clip clip) {
clip.formats.push_back({0,L"ExcludeClipboardContentFromMonitorProcessing",ks::Bytes{0}});return clip;
}
int main() {
CoInitializeEx(nullptr,COINIT_APARTMENTTHREADED);
PROCESS_INFORMATION process{};HWND resident{},target{};ks::Clip saved;bool captured=false;int result=0;
try {
auto folder=std::filesystem::path(ks::executable()).parent_path();
require(folder.filename().wstring().starts_with(L"history-host-fixture-"),"isolated fixture directory");
require(!FindWindowW(L"KSwitcher.Main",nullptr),"normal resident is stopped");
WNDCLASSW targetClass{};targetClass.lpfnWndProc=targetProc;targetClass.hInstance=GetModuleHandleW(nullptr);
targetClass.lpszClassName=L"KSwitcher.HistoryTestDestination";RegisterClassW(&targetClass);
target=CreateWindowExW(0,targetClass.lpszClassName,L"KSwitcher history test destination",WS_OVERLAPPEDWINDOW|WS_VISIBLE,
50,50,500,250,nullptr,nullptr,nullptr,nullptr);
editor=CreateWindowExW(0,L"EDIT",L"",WS_CHILD|WS_VISIBLE|ES_MULTILINE,10,10,450,180,target,nullptr,nullptr,nullptr);
SetWindowSubclass(editor,editProc,1,0);
saved=ks::readClipboard(target,128*1024*1024);captured=true;
ks::writeClipboard(target,excluded(ks::textClip(L"fixture clipboard")));
auto settings=ks::loadSettings(folder/L"missing.json",ks::readLayouts());
settings.autoCorrect=false;settings.writeLog=true;settings.history=true;settings.maxItems=500;settings.maxMiB=100;
std::filesystem::create_directories(folder/L"data");
ks::saveSettings(folder/L"data/settings.json",settings);
ks::History history(folder/L"data/history");
history.clear(); // This executable only runs in its dedicated fixture directory.
ks::Pixels pixels{1566,1068,ks::Bytes(1566*1068*4,255)};
auto image=ks::Clip{{ks::imageDib(pixels)}};
history.add(image,L"test",settings);
auto imageId=history.entries().front().id;
// Seed once rather than rewriting the encrypted index 500 times. This
// also avoids measuring fixture creation in the resident under test.
auto indexPath=folder/L"data/history/index.dat";
auto rows=nlohmann::json::parse(ks::unprotect(ks::readFile(indexPath,1024*1024)));
for(int i=0;i<499;++i) {
auto id=ks::lower(ks::newSnippetId().substr(1,36)),text=L"History fixture "+std::to_wstring(i);
auto bytes=ks::protect(ks::encodeClip(ks::textClip(text)));
ks::atomicWrite(folder/L"data/history"/(id+L".dat"),bytes);
rows.insert(rows.begin(),nlohmann::json{{"id",ks::utf8(id)},{"preview",ks::utf8(text)},
{"app","test"},{"bytes",bytes.size()},{"at",i+1},{"pinned",false},{"image",false},{"files",false}});
}
auto encoded=rows.dump();ks::atomicWrite(indexPath,ks::protect(ks::Bytes(encoded.begin(),encoded.end())));
history.reload();
auto textId=history.entries().front().id;
auto exe=folder/L"KSwitcher.exe";auto line=L"\""+exe.wstring()+L"\"";
STARTUPINFOW startup{sizeof(startup)};startup.dwFlags=STARTF_USESHOWWINDOW;startup.wShowWindow=SW_HIDE;
require(CreateProcessW(exe.c_str(),line.data(),nullptr,nullptr,FALSE,CREATE_NO_WINDOW,nullptr,folder.c_str(),&startup,&process),"start isolated resident");
CloseHandle(process.hThread);process.hThread=nullptr;
until([&]{resident=FindWindowW(L"KSwitcher.Main",nullptr);return resident!=nullptr;},"resident startup");
auto base=memory(process.hProcess);
std::string forged="{\"action\":\"clear\",\"id\":\"\",\"plain\":false}";
COPYDATASTRUCT forgedRequest{0x4b530200,DWORD(forged.size()),forged.data()};
require(send(resident,WM_COPYDATA,WPARAM(target),LPARAM(&forgedRequest))==0,
"history rejects requests from an untrusted process");
auto open=[&] {
require(ks::activateWindow(target),"destination foreground");SetFocus(editor);command(resident,5);
HWND window{};
until([&]{window=FindWindowW(L"KSwitcher.History",nullptr);return window&&IsWindowVisible(window);},"history startup");
until([&]{return send(GetDlgItem(window,102),LB_GETCOUNT)>0;},"history rows");
DWORD pid{};GetWindowThreadProcessId(window,&pid);
require(pid!=process.dwProcessId,"history belongs to a separate process");
return window;
};
auto close=[&](HWND window) {
DWORD pid{};GetWindowThreadProcessId(window,&pid);HANDLE child=OpenProcess(SYNCHRONIZE,FALSE,pid);
PostMessageW(window,WM_KEYDOWN,VK_ESCAPE,0); // Escape also works with focus on the window itself.
until([&]{return WaitForSingleObject(child,0)==WAIT_OBJECT_0;},"history helper exits after Escape");
CloseHandle(child);
require(!FindWindowW(L"KSwitcher.History",nullptr),"Escape destroys history window");
};
for(int i=0;i<3;++i){auto w=open();until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==500;},"all history rows loaded");require(true,"all history entries visible");close(w);}
auto idle=memory(process.hProcess);
std::cout<<"MEMORY resident_before="<<base<<" after_three_closes="<<idle<<'\n';
require(idle<base+2*1024*1024,"repeated history does not retain UI heap in resident");
auto w=open();send(w,WM_COMMAND,112);
until([&]{history.reload();return history.entries().front().pinned;},"resident pin mutation");
require(history.entries().front().id==textId,"pin preserves history identity");
auto filter=[&](HWND window,int index) {
auto checkbox=GetDlgItem(window,117);
if(send(checkbox,BM_GETCHECK)!=(index ? BST_CHECKED : BST_UNCHECKED)) send(checkbox,BM_CLICK);
};
filter(w,1);
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==1;},"pinned filter hides unpinned entries");
send(GetDlgItem(w,101),WM_SETTEXT,0,LPARAM(L"History fixture 497"));
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==0;},"search cannot match an unpinned item in pinned view");
send(GetDlgItem(w,101),WM_SETTEXT,0,LPARAM(L"History fixture 498"));
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==1;},"history search");
send(w,WM_COMMAND,112);
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==0;},"unpin removes the last pinned result");
filter(w,0);
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==1;},"all items restores the matching unpinned entry");
send(w,WM_COMMAND,112);
filter(w,1);
close(w);w=open();
require(send(GetDlgItem(w,117),BM_GETCHECK)==BST_CHECKED,"pinned checkbox survives helper restart");
wchar_t query[100]{};send(GetDlgItem(w,101),WM_GETTEXT,100,LPARAM(query));
require(std::wstring(query)==L"History fixture 498","search survives helper restart");
send(w,WM_COMMAND,114);
HWND entry{};until([&]{entry=FindWindowW(L"KSwitcher.Entry",nullptr);return entry!=nullptr;},"full item opens");
DWORD childPid{};GetWindowThreadProcessId(w,&childPid);HANDLE child=OpenProcess(SYNCHRONIZE,FALSE,childPid);
send(GetDlgItem(w,101),WM_KEYDOWN,VK_ESCAPE);
require(WaitForSingleObject(child,0)==WAIT_TIMEOUT && IsWindow(entry),"full item remains usable after closing history");
send(entry,WM_CLOSE);
until([&]{return WaitForSingleObject(child,0)==WAIT_OBJECT_0;},"helper exits after last full item closes");CloseHandle(child);
w=open();filter(w,0);send(GetDlgItem(w,101),WM_SETTEXT,0,LPARAM(L""));
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==500;},"clear search");close(w);
ks::writeClipboard(target,excluded(image));
w=open();send(w,WM_COMMAND,111);
until([&]{return editorText()==L"History fixture 498";},"paste plain text into native editor");
until([&]{return IsClipboardFormatAvailable(CF_DIB)&&!FindWindowW(L"KSwitcher.HistoryHost",nullptr);},"image clipboard restored after paste");
require(ks::decodeImage(ks::readClipboard(target,64*1024*1024)).width==pixels.width,"image clipboard survives history paste");
auto afterPaste=memory(process.hProcess);
std::cout<<"MEMORY after_paste_with_image_backup="<<afterPaste<<'\n';
require(afterPaste<base+2*1024*1024,"image clipboard backup stays outside resident");
ks::writeClipboard(target,excluded(ks::textClip(L"keep clipboard")));
w=open();send(GetDlgItem(w,101),WM_SETTEXT,0,LPARAM(L"Image"));
until([&]{return send(GetDlgItem(w,102),LB_GETCOUNT)==1;},"image search");
pastedImage=false;send(w,WM_COMMAND,110);
until([&]{return pastedImage;},"image paste reaches destination");
until([&]{return ks::readClipboard(target).text()==L"keep clipboard";},"clipboard restored after image paste");
std::cout<<"MEMORY after_image_paste="<<memory(process.hProcess)<<'\n';
require(memory(process.hProcess)<base+2*1024*1024,"image paste does not retain full bitmap in resident");
until([&]{return !FindWindowW(L"KSwitcher.HistoryHost",nullptr);},"image paste helper exits");
w=open();send(w,WM_COMMAND,113);
until([&]{history.reload();return history.entries().size()==499;},"resident removes selected image");
GetWindowThreadProcessId(w,&childPid);child=OpenProcess(SYNCHRONIZE,FALSE,childPid);
// Startup update checks temporarily reject exit; retry after that
// operation finishes instead of treating its guard as a host leak.
ULONGLONG nextExit{};
until([&]{
if(WaitForSingleObject(process.hProcess,0)==WAIT_OBJECT_0) return true;
if(GetTickCount64()>=nextExit) {
command(resident,99);nextExit=GetTickCount64()+500;
}
return false;
},"resident accepts exit after startup update check",30000);
until([&]{return WaitForSingleObject(child,0)==WAIT_OBJECT_0;},"resident shutdown closes history helper");
CloseHandle(child);resident=nullptr;
std::cout<<"PASS isolated history host suite\n";
} catch(const std::exception &e){std::cerr<<"FAIL "<<e.what()<<" editor="<<ks::utf8(editorText())<<" foreground="<<(GetForegroundWindow()==target)<<'\n';result=1;}
if(resident)try{command(resident,99);}catch(...){}
if(process.hProcess){if(WaitForSingleObject(process.hProcess,10000)!=WAIT_OBJECT_0){TerminateProcess(process.hProcess,1);WaitForSingleObject(process.hProcess,INFINITE);}CloseHandle(process.hProcess);}
if(captured)try{ks::writeClipboard(target,saved);}catch(...){result=1;}
if(target) DestroyWindow(target);
CoUninitialize();
return result;
}
+84
View File
@@ -0,0 +1,84 @@
// Interactive clipboard test. Run with the resident stopped; the original
// clipboard is restored. The helper must be beside this test executable.
#include "storage.h"
#include "ocr.h"
#include <algorithm>
#include <iostream>
static void require(bool ok,const char *name) {
if(!ok) throw std::runtime_error(name);
std::cout << "PASS " << name << '\n';
}
int main() {
CoInitializeEx(nullptr,COINIT_MULTITHREADED);
HWND owner=CreateWindowExW(0,L"STATIC",L"Capture test",0,0,0,0,0,HWND_MESSAGE,nullptr,nullptr,nullptr);
ks::Clip saved; bool captured=false; int result=0;
auto folder=std::filesystem::temp_directory_path()/(L"KSwitcher-image-capture-"+std::to_wstring(GetCurrentProcessId()));
try {
saved=ks::readClipboard(owner,128*1024*1024); captured=true;
ks::Settings settings; settings.history=true;
ks::History history(folder);
history.add(ks::textClip(L"keep pinned"),L"test",settings);
auto pinned=history.entries().front().id; history.pin(pinned);
ks::Pixels pixels{32,16,ks::Bytes(32*16*4,255)};
ks::Clip image{{ks::imageDib(pixels),{0,L"PNG",ks::encodePng(pixels)}}};
auto sequence=ks::writeClipboard(owner,image);
require(history.captureImage(sequence,L"capture test",settings),"helper captures image");
auto entries=history.entries();
require(entries.size()==2 && entries.front().image && entries.front().ocrState==1,"resident reloads metadata with pending OCR");
require(entries.front().contentHash.size()==64 && !entries.front().pixelHash.empty(),
"helper persists fingerprints and resident reloads them");
require(entries.back().id==pinned && entries.back().pinned,"helper preserves existing pinned entry");
auto restored=history.load(entries.front().id);
auto thumbnail=history.thumbnail(entries.front().id);
require(thumbnail.width==pixels.width && thumbnail.height==pixels.height && thumbnail.bgra==pixels.bgra,
"helper thumbnail preserves small image pixels");
bool thumbnailCancelled=false;
try {history.thumbnail(entries.front().id,[]{return true;});} catch(...) {thumbnailCancelled=true;}
require(thumbnailCancelled,"closed history cancels thumbnail work");
auto has=[&](const ks::Format &expected) {
return std::any_of(restored.formats.begin(),restored.formats.end(),[&](const ks::Format &actual) {
return (expected.name.empty()?actual.id==expected.id:actual.name==expected.name) && actual.data==expected.data;
});
};
require(has(image.formats[0]) && has(image.formats[1]),
"encrypted history preserves both image representations");
require(ks::readFile(folder/(entries.front().id+L".dat"),1024*1024)!=ks::encodeClip(restored),"saved image is encrypted");
require(GetClipboardSequenceNumber()==sequence,"capture leaves clipboard unchanged");
require(history.captureImage(sequence,L"capture test",settings) && history.entries().size()==2,"duplicate capture is not added");
ks::writeClipboard(owner,ks::textClip(L"new clipboard"));
require(!history.captureImage(sequence,L"stale",settings) && history.entries().size()==2,"stale request does not save another clipboard");
for(auto name : {L"ExcludeClipboardContentFromMonitorProcessing",L"Clipboard Viewer Ignore",L"CanIncludeInClipboardHistory"}) {
auto blocked=image; blocked.formats.push_back({0,name,ks::Bytes(4,0)});
sequence=ks::writeClipboard(owner,blocked);
require(!history.captureImage(sequence,L"excluded",settings) && history.entries().size()==2,"clipboard privacy flag prevents capture");
}
pixels={1024,512,ks::Bytes(1024*512*4,255)};
sequence=ks::writeClipboard(owner,ks::Clip{{ks::imageDib(pixels)}});
settings.maxImageMiB=1;
bool rejected=false;
try {history.captureImage(sequence,L"oversized",settings);} catch(const std::exception &e) {
rejected=std::string(e.what())=="Clipboard exceeds the configured size limit";
}
require(rejected && history.entries().size()==2,"oversized image is rejected without changing index");
require(GetClipboardSequenceNumber()==sequence,"rejection leaves clipboard unchanged");
settings.maxImageMiB=20;
history.add(ks::Clip{{ks::imageDib(pixels)}},L"thumbnail fixture",settings);
auto largeId=history.entries().front().id;
thumbnail=history.thumbnail(largeId);
require(thumbnail.width==208 && thumbnail.height==104 && thumbnail.bgra.size()==208*104*4,
"large image returns only bounded thumbnail pixels");
history.remove(largeId);
bool missingRejected=false;
try {history.thumbnail(largeId);} catch(...) {missingRejected=true;}
require(missingRejected,"deleted image cannot be previewed or recreated");
for(const auto &file:std::filesystem::directory_iterator(folder))
require(file.path().extension()!=L".request","encrypted capture request is cleaned up");
} catch(const std::exception &e) {std::cerr << "FAIL " << e.what() << '\n';result=1;}
if(captured) try {ks::writeClipboard(owner,saved);} catch(...) {result=1;}
DestroyWindow(owner); CoUninitialize();
// Remove only the exact PID-specific fixture under the system temp directory.
std::error_code ignored;
if(std::filesystem::weakly_canonical(folder).parent_path()==std::filesystem::weakly_canonical(std::filesystem::temp_directory_path()))
std::filesystem::remove_all(folder,ignored);
return result;
}
+41 -2
View File
@@ -2,6 +2,7 @@
#include "ui_scroll.h"
#include "ui_geometry.h"
#include "screenshot.h"
#include "ocr.h"
#include <commctrl.h>
#include <iostream>
#include <cmath>
@@ -94,6 +95,9 @@ struct InputRegressionAccess {
}
static void notificationSetup(App &a) { a.updateNotifier = notify; }
static void setup(App &a) { a.hookBindings = {{Toggle,{MOD_CONTROL,VK_F12}}, {Case,{MOD_CONTROL|MOD_SHIFT,'U'}}}; }
static LRESULT routedKey(int code, UINT message, const KBDLLHOOKSTRUCT &key, LRESULT routed) {
return App::keyboardAfterHooks(code,message,(LPARAM)&key,routed);
}
static bool updateTimer(App &a) {
a.updateRunning=true; // Exercise timer scheduling without launching a network request.
App::windowProc(a.window,WM_TIMER,5,0);
@@ -120,7 +124,7 @@ int main(int argc, char **argv) {
return result.state == L"current" || result.state == L"available" ? 0 : 1;
} catch (const std::exception &e) { std::cerr << e.what() << '\n'; return 1; }
}
auto temp=std::filesystem::temp_directory_path()/(L"KSwitcher-input-tests-"+std::to_wstring(GetCurrentProcessId()));
auto temp=std::filesystem::temp_directory_path()/(L"KSwitcher-input-tests-"+ks::newSnippetId());
int checks=0;
auto require=[&](bool ok,const char* text) { if(!ok) throw std::runtime_error(text); ++checks; };
try {
@@ -648,6 +652,22 @@ int main(int argc, char **argv) {
};
auto commands=[&] { MSG m{}; int n=0; while(PeekMessageW(&m,app.window,WM_HOTKEY,WM_HOTKEY,PM_REMOVE)) ++n; return n; };
auto f12=event(VK_F12);
{
const auto before = app.inputVersion.load();
const auto recorded = app.run.keys;
for (UINT message : {WM_KEYDOWN, WM_KEYUP, WM_SYSKEYDOWN, WM_SYSKEYUP})
require(ks::InputRegressionAccess::routedKey(HC_ACTION,message,event('A',30),7)==7,
"forwarded keyboard events preserve downstream suppression");
require(app.inputVersion==before && app.run.keys==recorded && commands()==0,
"forwarded events never track text, invalidate transactions or dispatch shortcuts");
require(ks::InputRegressionAccess::routedKey(-1,WM_KEYDOWN,event('A',30),0)==0 &&
app.inputVersion==before,"negative hook codes do not process keyboard input");
require(ks::InputRegressionAccess::routedKey(HC_ACTION,WM_KEYDOWN,event('A',30,true),0)==0 &&
app.inputVersion==before,"own input remains excluded after downstream routing");
require(ks::InputRegressionAccess::routedKey(HC_ACTION,WM_KEYDOWN,event('A',30),0)==0 &&
app.inputVersion>before,"delivered remote input is still processed on the receiver");
app.run.reset();
}
require(!app.handleKeyboard(event(VK_LCONTROL),true,0),"remote modifier passes through");
require(app.handleKeyboard(f12,true,MOD_CONTROL),"remote Ctrl+F12 handled");
require(app.handleKeyboard(f12,true,MOD_CONTROL),"remote repeat suppressed");
@@ -912,6 +932,7 @@ int main(int argc, char **argv) {
ks::showHistory(app,false);
auto history=app.historyWindow;
require(history&&!IsWindowVisible(history),"history layout tested without changing focus");
require(!GetDlgItem(history,105),"history creates no RichEdit control before formatted content is displayed");
{
app.history=std::make_unique<ks::History>(temp/L"history-search");
app.history->add(ks::textClip(L"згенеруй приклад"),L"test",app.settings);
@@ -941,7 +962,9 @@ int main(int argc, char **argv) {
require(GetFocus()==originalFocus,"history search preserves focus");
SendDlgItemMessageW(history,102,LB_SETCURSEL,1,0);
ks::refreshHistory(app); // A result may still be in flight when closing.
SendMessageW(history,WM_CLOSE,0,0);
SendDlgItemMessageW(history,101,WM_KEYDOWN,VK_ESCAPE,0);
require(!IsWindowVisible(history) && !GetDlgItem(history,105),
"Escape closes history and leaves no RichEdit control");
SendMessageW(history,WM_TIMER,1,0); // KillTimer cannot retract a posted timer message.
require(pumpUntil(0),"closing history releases list strings");
auto until=GetTickCount64()+250;
@@ -958,6 +981,22 @@ int main(int argc, char **argv) {
require(pumpUntil(2),"history reloads after releasing hidden rows");
require(SendDlgItemMessageW(history,102,LB_GETCURSEL,0,0)==1,
"history retains selected record across close and reload");
SendMessageW(history,WM_CLOSE,0,0);
ks::Pixels screenshot{2,2,ks::Bytes(16,255)};
app.history->add(ks::Clip{{ks::imageDib(screenshot)}},L"screenshot",app.settings);
require(app.history->entries().front().image,"new screenshot is the newest history entry");
ks::showHistory(app);
require(pumpUntil(3),"reopening history loads the new screenshot");
require(SendDlgItemMessageW(history,102,LB_GETCURSEL,0,0)==0 &&
SendDlgItemMessageW(history,102,LB_GETTOPINDEX,0,0)==0,
"fresh history invocation selects and reveals newest screenshot instead of saved selection");
SendDlgItemMessageW(history,102,LB_SETCURSEL,2,0);
app.history->add(ks::textClip(L"background clipboard update"),L"test",app.settings);
ks::refreshHistory(app);
require(pumpUntil(4),"background refresh loads a new item");
require(SendDlgItemMessageW(history,102,LB_GETCURSEL,0,0)==3,
"background refresh preserves the selected record while browsing");
ShowWindow(history,SW_HIDE);
}
auto childRect=[&](int id) { RECT r{}; GetWindowRect(GetDlgItem(history,id),&r); MapWindowPoints(nullptr,history,(POINT*)&r,2); return r; };
RECT historyFrame{}; GetWindowRect(history,&historyFrame);
+62 -1
View File
@@ -33,6 +33,17 @@ bool trimCopiedSpaces = false;
int trimmedCopies = 0;
bool temporaryClipboardExcluded = true;
bool clipboardAccessTimedOut = false;
uint64_t forwardedVersion{};
int forwardedEvents{};
LRESULT CALLBACK forwardingHook(int code, WPARAM wp, LPARAM lp)
{
if (code == HC_ACTION && reinterpret_cast<KBDLLHOOKSTRUCT *>(lp)->dwExtraInfo == 456)
{
++forwardedEvents;
return 1; // Model MWB consuming source input routed to another machine.
}
return CallNextHookEx(nullptr, code, wp, lp);
}
LRESULT CALLBACK observeEnter(HWND w, UINT message, WPARAM wp, LPARAM lp, UINT_PTR, DWORD_PTR)
{
if (message == WM_KEYDOWN && wp == VK_LEFT && droppedSelectionKeys > 0 &&
@@ -309,6 +320,8 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
app->settings.autoCorrect = true;
app->settings.switchLayout = true;
app->settings.autoLanguages = {L"en", L"ru"};
// Direct fixture mutations bypass applySettings' dictionary preload.
app->autoPredictor.configure(L"dictionaries", app->settings.autoLanguages);
app->settings.cycle = {app->layouts[en].id, app->layouts[ru].id};
ActivateKeyboardLayout(app->layouts[en].handle, 0);
prepare(L"ghbdtn ", false);
@@ -575,10 +588,41 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
require(ks::readClipboard(app->window).text() == sentinel, "selected and repeated conversions restore clipboard");
finish();
break;
case 62:
saved = ks::readClipboard(app->window, 64 * 1024 * 1024);
captured = true;
app->ownSequence = ks::writeClipboard(app->window, ks::textClip(sentinel));
app->settings.snippets = {{L";r", L"unexpected{enter}"}};
ActivateKeyboardLayout(app->layouts[en].handle, 0);
prepare(L"prefix ", false);
forwardedVersion = app->inputVersion.load();
copyRequests = forwardedEvents = 0;
{
std::vector<INPUT> inputs;
for (WORD key : {WORD(VK_OEM_1), WORD('R')})
for (DWORD flags : {DWORD(0), DWORD(KEYEVENTF_KEYUP)})
{
auto input = ks::keyboardInput(key, flags);
input.ki.dwExtraInfo = 456;
inputs.push_back(input);
}
require(SendInput((UINT)inputs.size(),inputs.data(),sizeof(INPUT))==inputs.size(),
"forwarded snippet input submitted to real hook chain");
}
break;
case 63:
require(forwardedEvents==4,"downstream forwarding hook consumed every key event");
require(app->inputVersion==forwardedVersion && copyRequests==0,
"forwarded snippet does not start tracking or clipboard work on source computer");
require(text()==L"prefix " && ks::readClipboard(app->window).text()==sentinel,
"forwarded snippet leaves source editor and clipboard untouched");
stage = 30;
break;
case 30:
case 32:
case 34:
case 37:
case 60:
// Earlier password/word tests replace the original multiline
// editor with a single-line EDIT. Restore the snippet fixture:
// a single-line control cannot insert the tested Enter action.
@@ -607,6 +651,11 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
enterPresses = 0;
copyRequests = 0;
copyFailuresRemaining = stage == 38 ? 10 : stage == 33 ? 1 : 0;
if (stage == 61)
{
pasteBehavior = 2; // Editor inserts unrelated clipboard text.
app->settings.writeLog = false;
}
temporaryClipboardExcluded = true;
ActivateKeyboardLayout(app->layouts[en].handle, 0);
prepare(L"prefix ", false);
@@ -670,6 +719,13 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
require(ks::readClipboard(app->window).text() == sentinel,
"exhausted copy retries restore the clipboard");
copyFailuresRemaining = 0;
stage = 60;
break;
case 61:
require(text() == L"prefix other! x", "incorrect snippet paste preserves following typing");
require(enterPresses == 0, "unverified snippet never submits Enter even without logging");
require(ks::readClipboard(app->window).text() == sentinel, "rejected snippet restores clipboard");
pasteBehavior = 0;
finish();
break;
case 20:
@@ -682,6 +738,7 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
app->settings.autoCorrect = true;
app->settings.switchLayout = true;
app->settings.autoLanguages = {L"en", L"ru"};
app->autoPredictor.configure(L"dictionaries", app->settings.autoLanguages);
app->settings.cycle = {app->layouts[en].id, app->layouts[ru].id};
app->autoCorrector = ks::AutoCorrector{};
ActivateKeyboardLayout(app->layouts[en].handle, 0);
@@ -731,6 +788,7 @@ LRESULT CALLBACK procedure(HWND w, UINT msg, WPARAM wp, LPARAM lp)
});
require(uk != app->layouts.end(), "Ukrainian layout available for punctuation-key regression");
app->settings.autoLanguages = {L"en", L"uk"};
app->autoPredictor.configure(L"dictionaries", app->settings.autoLanguages);
app->settings.cycle = {app->layouts[en].id, uk->id};
app->settings.autoWords[L"uk"] = {L"робить"};
app->autoCorrector = ks::AutoCorrector{};
@@ -981,9 +1039,12 @@ int main(int argc, char **argv)
if (typosOnly || (argc > 1 && std::string(argv[1]) == "--typing-only"))
stage = 20;
if (argc > 1 && std::string(argv[1]) == "--snippets-only")
stage = 30;
stage = 62;
SetTimer(host, 1, 100, nullptr);
auto forwarding = SetWindowsHookExW(WH_KEYBOARD_LL,forwardingHook,GetModuleHandleW(nullptr),0);
require(forwarding!=nullptr,"downstream forwarding fixture installed before application hook");
app->execute();
UnhookWindowsHookEx(forwarding);
}
std::filesystem::remove_all(root);
}
+18
View File
@@ -59,6 +59,24 @@ int main(int argc, char **argv)
app.settings.history = true;
app.history->add(clip, L"OCR fixture", app.settings);
auto id = app.history->entries().front().id;
auto isolated = app.history->recognizeImage(id, config);
if (isolated != text) throw std::runtime_error("Helper and in-process OCR results differ");
bool cancelled = false;
try { app.history->recognizeImage(id, config, [] { return true; }); }
catch (const std::exception &) { cancelled = true; }
if (!cancelled) throw std::runtime_error("Cancelled OCR request was executed");
auto invalid = config;
invalid.useTesseract = true;
invalid.tesseractPath = (temp / L"missing-tesseract.exe").wstring();
bool failed = false;
try { app.history->recognizeImage(id, invalid); }
catch (const std::exception &) { failed = true; }
if (!failed || app.history->entries().front().ocrState != 1)
throw std::runtime_error("Failed helper modified history metadata");
for (const auto &file : std::filesystem::directory_iterator(temp / L"history"))
if (file.path().filename().wstring().starts_with(L"ocr-"))
throw std::runtime_error("OCR helper left temporary files");
std::cout << "PASS isolated OCR equivalence, cancellation, failure and encrypted IPC cleanup\n";
if (tesseract)
{
app.history->saveOcr(id, L"old Windows result", app.settings);
+70
View File
@@ -4,6 +4,7 @@
#include "richtext.h"
#include "storage.h"
#include "diagnostics.h"
#include "json.hpp"
#include <algorithm>
#include <iostream>
#include <map>
@@ -189,6 +190,8 @@ int main(int argc, char **argv)
"HTML entities and Unicode survive without script text");
require((effects(0, 6) & CFE_BOLD) != 0, "inline CSS bold is rendered");
auto plain = ks::textClip(L"{\\literal} Привіт");
require(ks::richPreview(plain, false).empty(), "plain history preview does not require RichEdit");
require(!ks::richPreview(styled, false).empty(), "formatted history preview retains HTML rendering");
ks::setRichText(rich, ks::richPreview(plain));
GetWindowTextW(rich, rendered, 256);
require(std::wstring(rendered) == plain.text(), "plain Unicode and RTF metacharacters are escaped");
@@ -514,6 +517,24 @@ int main(int argc, char **argv)
auto encoded = ks::encodeClip(clip);
require(ks::decodeClip(encoded).text() == clip.text(), "clipboard Unicode roundtrip");
require(ks::decodeClip(encoded).formats[1].name == L"HTML Format", "registered format identity");
auto selection = ks::textClip(L";pa");
selection.formats.push_back({0, L"vscode-editor-data", {1, 2, 3}});
auto relayed = selection;
relayed.formats.front().data.resize(128, 0xab);
std::reverse(relayed.formats.begin(), relayed.formats.end());
require(ks::selectionClipboardIdentity(selection) == ks::selectionClipboardIdentity(relayed),
"clipboard relay tolerates Unicode allocation slack and format order");
relayed.formats.front().data[0] ^= 1;
require(ks::selectionClipboardIdentity(selection) != ks::selectionClipboardIdentity(relayed),
"clipboard relay rejects changed editor metadata");
relayed = selection;
relayed.formats.pop_back();
require(ks::selectionClipboardIdentity(selection) != ks::selectionClipboardIdentity(relayed),
"clipboard relay rejects missing editor metadata");
relayed = selection;
relayed.formats.front() = ks::textClip(L";pb").formats.front();
require(ks::selectionClipboardIdentity(selection) != ks::selectionClipboardIdentity(relayed),
"clipboard relay rejects changed Unicode text");
auto encrypted = ks::protect(encoded);
require(encrypted != encoded, "history ciphertext differs");
require(ks::unprotect(encrypted) == encoded, "Windows DPAPI roundtrip");
@@ -635,6 +656,55 @@ int main(int argc, char **argv)
"Snipping Tool republish retains one pinned history entry");
history.add(changedImage, L"SnippingTool", defaults);
require(history.entries().size() == 2, "a new screenshot is retained");
auto copiedText = ks::textClip(L"text after screenshot");
history.add(copiedText, L"Editor", defaults);
history.add(copiedText, L"Editor", defaults);
require(history.entries().size() == 3 && !history.entries().front().image,
"text after screenshot is retained and consecutive text duplicates are skipped");
history.add(changedImage, L"SnippingTool", defaults);
history.add(changedImage, L"SnippingTool", defaults);
require(history.entries().size() == 4 && history.entries().front().image,
"image after text is retained and consecutive image duplicates are skipped");
history.add(withText, L"Editor", defaults);
require(history.entries().size() == 5,
"mixed image and text payload is not discarded by metadata prefilter");
}
{
auto folder = temp / L"fingerprints";
ks::Settings defaults;
ks::History history(folder);
history.add(firstImage, L"test", defaults);
auto id = history.entries().front().id;
history.pin(id);
history.saveOcr(id, L"retained OCR", defaults);
ks::History reopened(folder);
require(reopened.entries().front().contentHash.size() == 64,
"SHA-256 fingerprint survives encrypted index reload");
// Deny payload reads: duplicates must still be detected using only the index.
auto handle = CreateFileW((folder / (id + L".dat")).c_str(), GENERIC_READ, 0, nullptr,
OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
require(handle != INVALID_HANDLE_VALUE, "lock image payload for no-read regression");
reopened.add(firstImage, L"test", defaults);
reopened.add(secondImage, L"test", defaults);
reopened.add(recoded, L"test", defaults);
CloseHandle(handle);
require(reopened.entries().size() == 1 && reopened.entries().front().pinned &&
reopened.ocrText(id) == std::optional<std::wstring>(L"retained OCR"),
"exact, OLE and pixel-equivalent duplicates need no payload read and retain pin/OCR");
auto index = nlohmann::json::parse(ks::unprotect(ks::readFile(folder / L"index.dat", 1024*1024)));
for (auto &entry : index)
for (auto key : {"fingerprintVersion", "contentHash", "imageHash", "pixelHash"}) entry.erase(key);
auto legacy = index.dump();
ks::atomicWrite(folder / L"index.dat", ks::protect(ks::Bytes(legacy.begin(), legacy.end())));
ks::History migrated(folder);
migrated.add(secondImage, L"test", defaults);
ks::History persisted(folder);
require(persisted.entries().size() == 1 && persisted.entries().front().contentHash.size() == 64,
"legacy duplicate migrates fingerprints without adding or losing an entry");
persisted.add(changedImage, L"test", defaults);
require(persisted.entries().size() == 2, "pixel fingerprint preserves genuinely changed images");
persisted.add(firstImage, L"test", defaults);
require(persisted.entries().size() == 3, "hash deduplication remains consecutive rather than global");
}
ks::Settings settings;
settings.writeLog = false;
+14
View File
@@ -50,6 +50,8 @@ try {
foreach ($name in @('LICENSE','json-LICENSE.txt','README.md')) { [IO.File]::WriteAllText((Join-Path $source $name),'fixture') }
[IO.Directory]::CreateDirectory((Join-Path $source 'dictionaries')) | Out-Null
[IO.File]::WriteAllText((Join-Path $source 'dictionaries/en.txt'),'new dictionary')
[IO.Directory]::CreateDirectory((Join-Path $source 'tools')) | Out-Null
[IO.File]::WriteAllText((Join-Path $source 'tools/README.txt'),'portable utilities instructions')
function Write-TestManifest($Folder) {
$entries=@(Get-ChildItem -LiteralPath $Folder -File -Recurse | Where-Object Name -ne 'release-files.json' | ForEach-Object {
@{path=$_.FullName.Substring($Folder.Length+1).Replace('\','/');size=$_.Length;sha256=(Get-FileHash -LiteralPath $_.FullName).Hash}
@@ -92,8 +94,17 @@ try {
$null=$z.CreateEntry('undeclared.dll'); $z.Dispose()
Reject { Expand-Release $extra (Join-Path $root 'extrastage') $binaryVersion } 'undeclared file rejected'
$target=Join-Path $root 'install'; $backup=Join-Path $root 'backup'
$freshTarget=Join-Path $root 'fresh-install'
[IO.Directory]::CreateDirectory($freshTarget) | Out-Null
$freshChanges=[Collections.Generic.List[string]]::new()
$freshStage=Join-Path $root 'fresh-stage'
Copy-Item -LiteralPath $stage -Destination $freshStage -Recurse
Install-Files $freshStage $freshTarget (Join-Path $root 'fresh-backup') $freshChanges
Assert (Test-Path -LiteralPath (Join-Path $freshTarget 'tools/README.txt')) 'update creates portable tools folder'
[IO.Directory]::CreateDirectory((Join-Path $target 'data')) | Out-Null
[IO.Directory]::CreateDirectory((Join-Path $target 'dictionaries')) | Out-Null
[IO.Directory]::CreateDirectory((Join-Path $target 'tools')) | Out-Null
[IO.File]::WriteAllText((Join-Path $target 'tools/Personal.exe'),'personal utility fixture')
[IO.File]::WriteAllText((Join-Path $target 'data/settings.json'),'personal settings')
[IO.File]::WriteAllText((Join-Path $target 'dictionaries/en.txt'),'personal dictionary')
[IO.File]::WriteAllText((Join-Path $target 'KSwitcher.exe'),'old binary fixture')
@@ -105,9 +116,12 @@ try {
}
Assert ([IO.File]::ReadAllText((Join-Path $target 'future-tool.exe')) -eq 'future companion fixture') 'new companion name installs without changing updater'
Assert ([IO.File]::ReadAllText((Join-Path $target 'data/settings.json')) -eq 'personal settings') 'settings preserved'
Assert ([IO.File]::ReadAllText((Join-Path $target 'tools/Personal.exe')) -eq 'personal utility fixture') 'personal utilities preserved'
Assert ([IO.File]::ReadAllText((Join-Path $target 'tools/README.txt')) -eq 'portable utilities instructions') 'bundled tools documentation installed'
Assert ([IO.File]::ReadAllText((Join-Path $target 'dictionaries/en.txt')) -eq 'personal dictionary') 'dictionary preserved'
Undo-Files $target $backup $changed
Assert ([IO.File]::ReadAllText((Join-Path $target 'KSwitcher.exe')) -eq 'old binary fixture') 'rollback restores original'
Assert ([IO.File]::ReadAllText((Join-Path $target 'tools/Personal.exe')) -eq 'personal utility fixture') 'rollback preserves personal utilities'
Assert (!(Test-Path -LiteralPath (Join-Path $target 'README.md'))) 'rollback removes newly introduced files'
Assert (!(Test-Path -LiteralPath (Join-Path $target 'KSwitcher.Config.exe'))) 'rollback removes newly introduced configurator'
Assert (!(Test-Path -LiteralPath (Join-Path $target 'KSwitcher.Screenshot.exe'))) 'rollback removes newly introduced screenshot editor'
+43
View File
@@ -0,0 +1,43 @@
#include <windows.h>
#include "../src/utilities.h"
#include <fstream>
#include <iostream>
#include <stdexcept>
int main()
{
namespace fs = std::filesystem;
auto root = fs::temp_directory_path() / (L"KSwitcher-utilities-" + std::to_wstring(GetCurrentProcessId()));
try
{
std::error_code error;
if (!ks::discoverUtilities(root / L"missing", error).empty() || error)
throw std::runtime_error("Missing folder must be empty, not an error");
fs::create_directories(root / L"tools" / L"nested");
fs::create_directory(root / L"tools" / L"directory.exe");
for (auto name : {L"Zed.exe", L"alpha.EXE", L"A & B.exe", L"readme.txt", L"shortcut.lnk"})
std::ofstream(root / L"tools" / name).put('x');
std::ofstream(root / L"tools" / L"nested" / L"hidden.exe").put('x');
auto found = ks::discoverUtilities(root / L"tools", error);
if (error || found.size() != 3 || found[0].filename() != L"A & B.exe" ||
found[1].filename() != L"alpha.EXE" || found[2].filename() != L"Zed.exe")
throw std::runtime_error("Scan must filter direct executable files and sort names");
if (ks::utilityMenuLabel(found[0]) != L"A && B")
throw std::runtime_error("Ampersand must be displayed literally");
fs::remove(found[1]);
if (ks::discoverUtilities(root / L"tools", error).size() != 2)
throw std::runtime_error("Scan must refresh after a file is removed");
ks::discoverUtilities(root / L"tools" / L"readme.txt", error);
if (!error) throw std::runtime_error("Non-directory must report an error");
fs::remove_all(root);
std::cout << "Utilities regression tests passed\n";
return 0;
}
catch (const std::exception &e)
{
std::error_code ignored;
fs::remove_all(root, ignored);
std::cerr << e.what() << '\n';
return 1;
}
}