Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@ import Combine
final class KeyboardVisualizer {
private static let trackedModifierFlags: NSEvent.ModifierFlags = [.command, .shift, .option, .control, .function]

var isPresentationActive: Bool = false {
didSet {
self.updatePresentationState()
}
}

var isPresented: Bool {
self.visualizerWindow.isVisible
}

var visibleGroupCount: Int {
self.visualizerWindow.groupCount
}

private let visualizerSettings: KeyboardVisualizerSettings
private let visualizerWindow: KeyboardVisualizerWindow
private let eventCoordinator = KeycapEventCoordinator<KeyboardVisualizerGroupView, KeycapItem>()
Expand All @@ -35,19 +49,22 @@ final class KeyboardVisualizer {
self?.eventCoordinator.removeGroup(group)
}
settings.isEnabledChanges
.filter { !$0 }
.sink { [weak self] _ in
self?.clearDisplayState()
.sink { [weak self] isEnabled in
guard let self else { return }
if !isEnabled {
self.clearDisplayState()
}
self.updatePresentationState()
}
.store(in: &self.cancellables)
}

func activate() {
self.visualizerWindow.orderFront(nil)
self.updatePresentationState()
}

func display(_ item: DisplayItem) {
guard self.visualizerSettings.isEnabled else {
guard self.visualizerSettings.isEnabled, self.isPresentationActive else {
self.clearDisplayState()
return
}
Expand Down Expand Up @@ -212,6 +229,15 @@ final class KeyboardVisualizer {
self.visualizerWindow.removeAllGroups()
}

private func updatePresentationState() {
guard self.visualizerSettings.isEnabled, self.isPresentationActive else {
self.clearDisplayState()
self.visualizerWindow.orderOut(nil)
return
}
self.visualizerWindow.orderFront(nil)
}

private var currentTrackedFlags: NSEvent.ModifierFlags {
self.currentModifierFlags.intersection(Self.trackedModifierFlags)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ final class KeyboardVisualizerWindow: NSWindow {
private var groupViews: [KeyboardVisualizerGroupView] = []
private var cancellables = Set<AnyCancellable>()
var onGroupRemoved: ((KeyboardVisualizerGroupView) -> Void)?
var groupCount: Int { self.groupViews.count }

init(
settings: KeyboardVisualizerSettings = KeyboardVisualizerSettings(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,9 @@ private extension CaptureController {
func applyCapturing(_ capturing: Bool) {
guard !capturing || self.eventTap.isInstalled else { return }
let wasCapturing = self.isCapturing
Task { @MainActor [pointerVisualizersManager = self.pointerVisualizersManager] in
Task { @MainActor [pointerVisualizersManager = self.pointerVisualizersManager, keyboardVisualizer = self.keyboardVisualizer] in
pointerVisualizersManager.isPresentationActive = capturing
keyboardVisualizer.isPresentationActive = capturing
}
if wasCapturing != capturing {
self.onCapturingChanged?(capturing)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
//
// KeyboardVisualizerTests.swift
// KeytyTests
//
// SPDX-FileCopyrightText: 2026 Serhii Bykov
// SPDX-License-Identifier: BSD-3-Clause
//

import XCTest
@testable import Keyty

@MainActor
final class KeyboardVisualizerTests: XCTestCase {
private var store: InMemoryKeyValueStore!
private var settings: KeyboardVisualizerSettings!
private var visualizer: KeyboardVisualizer!

override func setUp() {
super.setUp()
self.store = InMemoryKeyValueStore()
self.settings = KeyboardVisualizerSettings(store: self.store)
self.settings.registerDefaults()
self.visualizer = KeyboardVisualizer(settings: self.settings)
}

override func tearDown() {
self.visualizer = nil
self.settings = nil
self.store = nil
super.tearDown()
}

func testEnabledVisualizerWaitsForPresentationActivation() {
self.settings.isEnabled = true

XCTAssertFalse(self.visualizer.isPresented)

self.visualizer.isPresentationActive = true

XCTAssertTrue(self.visualizer.isPresented)
}

func testPresentationDeactivationClearsVisibleGroupsImmediately() {
self.settings.isEnabled = true
self.visualizer.isPresentationActive = true

let keystroke = TestKeystrokes.make(
keyCode: KeyboardKeyCode.k.rawValue,
characters: "k",
charactersIgnoringModifiers: "k"
)
self.visualizer.display(
DisplayItem(
asContentWithText: keystroke.displayString,
sourceEvent: keystroke.inputEvent,
startsNewLine: false,
isCommand: keystroke.isCommand,
isModified: keystroke.isModified,
isMouseEvent: false
)
)

XCTAssertEqual(self.visualizer.visibleGroupCount, 1)

self.visualizer.isPresentationActive = false

XCTAssertFalse(self.visualizer.isPresented)
XCTAssertEqual(self.visualizer.visibleGroupCount, 0)
XCTAssertTrue(self.settings.isEnabled)
}
}
Loading