99//
1010
1111#if os(macOS)
12- import Foundation
1312import Carbon
13+ import Foundation
1414
15- final class KeyboardLayout {
16-
15+ internal final class KeyboardLayout {
1716 // MARK: - Properties
1817 private var currentKeyboardLayoutInputSource : InputSource
1918 private var currentASCIICapableInputSource : InputSource
20- private var mappedKeyCodes = [ InputSource: [ Key: CGKeyCode] ] ( )
19+ private var mappedKeyCodes = [ InputSource: [ KeyModifier : [ Key: CGKeyCode] ] ] ( )
2120 private( set) var inputSources = [ InputSource] ( )
2221
2322 private let distributedNotificationCenter : DistributedNotificationCenter
@@ -40,41 +39,40 @@ final class KeyboardLayout {
4039 distributedNotificationCenter. removeObserver ( self )
4140 notificationCenter. removeObserver ( self )
4241 }
43-
4442}
4543
4644// MARK: - KeyCodes
47- extension KeyboardLayout {
48- func currentKeyCodes( ) -> [ Key : CGKeyCode ] ? {
49- return keyCodes ( with: currentKeyboardLayoutInputSource)
45+ internal extension KeyboardLayout {
46+ func currentKeyCodes( carbonModifiers : Int ) -> [ Key : CGKeyCode ] ? {
47+ return keyCodes ( with: currentKeyboardLayoutInputSource, carbonModifiers : carbonModifiers )
5048 }
5149
52- func currentKeyCode( for key: Key ) -> CGKeyCode ? {
53- return keyCode ( with: currentKeyboardLayoutInputSource, key: key)
50+ func currentKeyCode( for key: Key , carbonModifiers : Int ) -> CGKeyCode ? {
51+ return keyCode ( with: currentKeyboardLayoutInputSource, key: key, carbonModifiers : carbonModifiers )
5452 }
5553
56- func keyCodes( with source: InputSource ) -> [ Key : CGKeyCode ] ? {
57- return mappedKeyCodes [ source]
54+ func keyCodes( with source: InputSource , carbonModifiers : Int ) -> [ Key : CGKeyCode ] ? {
55+ return mappedKeyCodes [ source] ? [ . init ( carbonModifiers : carbonModifiers ) ]
5856 }
5957
60- func keyCode( with source: InputSource , key: Key ) -> CGKeyCode ? {
61- return mappedKeyCodes [ source] ? [ key]
58+ func keyCode( with source: InputSource , key: Key , carbonModifiers : Int ) -> CGKeyCode ? {
59+ return mappedKeyCodes [ source] ? [ . init ( carbonModifiers : carbonModifiers ) ] ? [ key]
6260 }
6361}
6462
6563// MARK: - Key
66- extension KeyboardLayout {
67- func currentKey( for keyCode: Int ) -> Key ? {
68- return key ( with: currentKeyboardLayoutInputSource, keyCode: keyCode)
64+ internal extension KeyboardLayout {
65+ func currentKey( for keyCode: Int , carbonModifiers : Int ) -> Key ? {
66+ return key ( with: currentKeyboardLayoutInputSource, keyCode: keyCode, carbonModifiers : carbonModifiers )
6967 }
7068
71- func key( with source: InputSource , keyCode: Int ) -> Key ? {
72- return mappedKeyCodes [ source] ? . first ( where: { $0. value == CGKeyCode ( keyCode) } ) ? . key
69+ func key( with source: InputSource , keyCode: Int , carbonModifiers : Int ) -> Key ? {
70+ return mappedKeyCodes [ source] ? [ . init ( carbonModifiers : carbonModifiers ) ] ? . first ( where: { $0. value == CGKeyCode ( keyCode) } ) ? . key
7371 }
7472}
7573
7674// MARK: - Characters
77- extension KeyboardLayout {
75+ internal extension KeyboardLayout {
7876 func currentCharacter( for keyCode: Int , carbonModifiers: Int ) -> String ? {
7977 return character ( with: currentKeyboardLayoutInputSource, keyCode: keyCode, carbonModifiers: carbonModifiers)
8078 }
@@ -89,7 +87,7 @@ extension KeyboardLayout {
8987}
9088
9189// MARK: - Notifications
92- extension KeyboardLayout {
90+ internal extension KeyboardLayout {
9391 private func observeNotifications( ) {
9492 distributedNotificationCenter. addObserver ( self ,
9593 selector: #selector( selectedKeyboardInputSourceChanged) ,
@@ -145,27 +143,57 @@ private extension KeyboardLayout {
145143 func mappingKeyCodes( with source: InputSource ) {
146144 guard let layoutData = TISGetInputSourceProperty ( source. source, kTISPropertyUnicodeKeyLayoutData) else { return }
147145 let data = Unmanaged < CFData > . fromOpaque ( layoutData) . takeUnretainedValue ( ) as Data
148- var keyCodes = [ Key: CGKeyCode] ( )
149- for i in 0 ..< 128 {
150- guard let character = character ( with: data, keyCode: i, carbonModifiers: 0 ) else { continue }
151- guard let key = Key ( character: character, virtualKeyCode: i) else { continue }
152- guard keyCodes [ key] == nil else { continue }
153- keyCodes [ key] = CGKeyCode ( i)
146+ var codes = [ KeyModifier: [ Key: CGKeyCode] ] ( )
147+ KeyModifier . allCases. forEach { keyModifier in
148+ var keyCodes = [ Key: CGKeyCode] ( )
149+ for i in 0 ..< 128 {
150+ guard let character = character ( with: data, keyCode: i, carbonModifiers: keyModifier. carbonModifier) else { continue }
151+ guard let key = Key ( character: character, virtualKeyCode: i) else { continue }
152+ guard keyCodes [ key] == nil else { continue }
153+ keyCodes [ key] = CGKeyCode ( i)
154+ }
155+ codes [ keyModifier] = keyCodes
154156 }
155- mappedKeyCodes [ source] = keyCodes
157+ mappedKeyCodes [ source] = codes
156158 }
157159
158160 func character( with source: TISInputSource , keyCode: Int , carbonModifiers: Int ) -> String ? {
159161 guard let layoutData = TISGetInputSourceProperty ( source, kTISPropertyUnicodeKeyLayoutData) else { return nil }
160162 let data = Unmanaged < CFData > . fromOpaque ( layoutData) . takeUnretainedValue ( ) as Data
161- return character ( with: data, keyCode: keyCode, carbonModifiers: carbonModifiers)
163+ let keyModifier = KeyModifier ( carbonModifiers: carbonModifiers)
164+ var carbonModifiers = modifierTransformer. convertCharactorSupportCarbonModifiers ( from: carbonModifiers)
165+ switch keyModifier {
166+ case . none:
167+ return character ( with: data, keyCode: keyCode, carbonModifiers: carbonModifiers)
168+ case . withCommand:
169+ /// Determines if it's a special keyboard environment by comparing the string output with and without the ⌘ key pressed
170+ /// For example, with a `Dvorak - QWERTY ⌘` keyboard, entering keycode `47` returns different characters depending on whether the ⌘ key pressed or not
171+ /// ⌘ not pressed: `v`
172+ /// ⌘ pressed: `.` (same as entering keycode `47` on a QWERTY keyboard)
173+ let noCommandCharacter = character ( with: data, keyCode: keyCode, carbonModifiers: 0 )
174+ let commandCharacter = character ( with: data, keyCode: keyCode, carbonModifiers: cmdKey)
175+ guard noCommandCharacter != commandCharacter else {
176+ /// If the outputs are the same, it's a regular keyboard, so return the string excluding the ⌘ key
177+ return character ( with: data, keyCode: keyCode, carbonModifiers: carbonModifiers)
178+ }
179+ /// Workaround: To get a string with modifiers other than ⌘ key working, obtain the keycode for the standard key layout and generate the string
180+ guard let commandCharacter,
181+ let key = Key ( character: commandCharacter, virtualKeyCode: keyCode) ,
182+ let keyCode = mappedKeyCodes [ . init( source: source) ] ? [ . none] ? . first ( where: { $0. key == key } ) ? . value
183+ else {
184+ /// If mapping is not possible, ignore modifiers other than ⌘ and return a value as close as possible to the key input
185+ carbonModifiers |= cmdKey
186+ return character ( with: data, keyCode: keyCode, carbonModifiers: carbonModifiers)
187+ }
188+ return character ( with: data, keyCode: Int ( keyCode) , carbonModifiers: carbonModifiers)
189+ }
162190 }
163191
164192 func character( with layoutData: Data , keyCode: Int , carbonModifiers: Int ) -> String ? {
165193 // In the case of the special key code, it does not depend on the keyboard layout
166194 if let specialKeyCode = SpecialKeyCode ( keyCode: keyCode) { return specialKeyCode. character }
167195
168- let modifierKeyState = ( modifierTransformer . convertCharactorSupportCarbonModifiers ( from : carbonModifiers) >> 8 ) & 0xff
196+ let modifierKeyState = ( carbonModifiers >> 8 ) & 0xff
169197 var deadKeyState : UInt32 = 0
170198 let maxChars = 256
171199 var chars = [ UniChar] ( repeating: 0 , count: maxChars)
0 commit comments