Skip to content

Change keyEquivalent to show the typed character, not the QWERTY key cap label #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Change keyEquivalent to show the typed character, not the QWERTY key cap label #72

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bee7b99
rename non-localized keyEquivalent to qwertyKeyLabel (temp)
DivineDominion Apr 6, 2021
c7beaa3
add keyEquivalent as NSMenuItem compatible value
DivineDominion Apr 6, 2021
a8415b4
upcase QWERTYKeyLabel
DivineDominion Apr 6, 2021
c33a06e
Merge upstream/master into keycap-vs-modifiers
DivineDominion Apr 12, 2021
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
16 changes: 14 additions & 2 deletions Lib/Magnet/KeyCombo.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,27 @@ public final class KeyCombo: NSObject, NSCopying, NSCoding, Codable {
guard !doubledModifiers else { return 0 }
return Int(key.QWERTYKeyCode)
}
/// The QWERTY key equivalent of this key combo's key code. Using a different keyboard layout, this
/// will not match the typed character. Use `keyEquivalent` instead.
public var QWERTYKeyLabel: String {
guard !doubledModifiers else { return "" }
let keyCode = Int(Sauce.shared.keyCode(for: key))
guard key.isAlphabet else { return Sauce.shared.character(for: keyCode, cocoaModifiers: []) ?? "" }
let modifiers = NSEvent.ModifierFlags(carbonModifiers: self.modifiers).filterNotShiftModifiers()
return Sauce.shared.character(for: keyCode, cocoaModifiers: modifiers) ?? ""
}
public var characters: String {
guard !doubledModifiers else { return "" }
return Sauce.shared.character(for: Int(Sauce.shared.keyCode(for: key)), carbonModifiers: modifiers) ?? ""
}
/// Character that would be typed in a text field when the user presses the key.
/// Use this for `NSMenuItem`'s `keyEquivalent` which expects the character and not the QWERTY key code.
public var keyEquivalent: String {
guard !doubledModifiers else { return "" }
let keyCode = Int(Sauce.shared.keyCode(for: key))
// Not calling `Sauce.shared.keyCode` skips translation of the current layout
let keyCode = Int(key.QWERTYKeyCode)
guard key.isAlphabet else { return Sauce.shared.character(for: keyCode, cocoaModifiers: []) ?? "" }
let modifiers = keyEquivalentModifierMask.filterNotShiftModifiers()
let modifiers = NSEvent.ModifierFlags(carbonModifiers: self.modifiers).filterNotShiftModifiers()
return Sauce.shared.character(for: keyCode, cocoaModifiers: modifiers) ?? ""
}
public var keyEquivalentModifierMask: NSEvent.ModifierFlags {
Expand Down
18 changes: 9 additions & 9 deletions Lib/MagnetTests/KeyComboTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,31 +93,31 @@ final class KeyComboTests: XCTestCase {
var keyCombo: KeyCombo?
// Command + a
keyCombo = KeyCombo(key: .a, cocoaModifiers: [.command])
XCTAssertEqual(keyCombo?.keyEquivalent, "a")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "a")
// Shift + a
keyCombo = KeyCombo(key: .a, cocoaModifiers: [.shift])
XCTAssertEqual(keyCombo?.keyEquivalent, "A")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "A")
// Option + a
keyCombo = KeyCombo(key: .a, cocoaModifiers: [.option])
XCTAssertEqual(keyCombo?.keyEquivalent, "a")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "a")
// Option + Shift + a
keyCombo = KeyCombo(key: .a, cocoaModifiers: [.option, .shift])
XCTAssertEqual(keyCombo?.keyEquivalent, "A")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "A")
// Option + Shift + 1
keyCombo = KeyCombo(key: .one, cocoaModifiers: [.option, .shift])
XCTAssertEqual(keyCombo?.keyEquivalent, "1")
// Option + Shift + Keypad 1
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "1")
keyCombo = KeyCombo(key: .keypadOne, cocoaModifiers: [.option, .shift])
XCTAssertEqual(keyCombo?.keyEquivalent, "1")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "1")
// Option + ;
keyCombo = KeyCombo(key: .semicolon, cocoaModifiers: [.option])
XCTAssertEqual(keyCombo?.keyEquivalent, ";")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, ";")
// Shift + F1
keyCombo = KeyCombo(key: .f1, cocoaModifiers: [.shift])
XCTAssertEqual(keyCombo?.keyEquivalent, "F1")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "F1")
// Option double tap
keyCombo = KeyCombo(doubledCocoaModifiers: .option)
XCTAssertEqual(keyCombo?.keyEquivalent, "")
XCTAssertEqual(keyCombo?.QWERTYKeyLabel, "")
}

func testKeyEquivalentModifierMaskString() {
Expand Down