Support Telex entry on different keyboard layouts

- Add options to enable key layout compatibility
- Tested on Dvorak, Coleman, custom Dvorak made with Ukelele application

Author: bachld97

Sources/OpenKey/macOS/ModernKey/AppDelegate.m

@@ -49,6 +49,8 @@
 
 int vShowIconOnDock = 0; //new on version 2.0
 
+int vPerformLayoutCompat = 0;
+
 //beta feature
 int vFixChromiumBrowser = 0; //new on version 2.0
 
@@ -285,6 +287,7 @@ -(void)loadDefaultConfig {
     vTempOffOpenKey = 0;[[NSUserDefaults standardUserDefaults] setInteger:vTempOffOpenKey forKey:@"vTempOffOpenKey"];
     vShowIconOnDock = 0;[[NSUserDefaults standardUserDefaults] setInteger:vShowIconOnDock forKey:@"vShowIconOnDock"];
     vFixChromiumBrowser = 0;[[NSUserDefaults standardUserDefaults] setInteger:vFixChromiumBrowser forKey:@"vFixChromiumBrowser"];
+    vPerformLayoutCompat = 0;[[NSUserDefaults standardUserDefaults] setInteger:vPerformLayoutCompat forKey:@"vPerformLayoutCompat"];
     [[NSUserDefaults standardUserDefaults] setInteger:1 forKey:@"RunOnStartup"];
 
     [self fillData];

Sources/OpenKey/macOS/ModernKey/Base.lproj/Main.storyboard

@@ -26,6 +26,7 @@
 extern AppDelegate* appDelegate;
 extern int vSendKeyStepByStep;
 extern int vFixChromiumBrowser;
+extern int vPerformLayoutCompat;
 
 extern "C" {
     //app which must sent special empty character
@@ -90,6 +91,8 @@ void OpenKeyInit() {
 
         LOAD_DATA(vFixChromiumBrowser, vFixChromiumBrowser);
 
+        LOAD_DATA(vPerformLayoutCompat, vPerformLayoutCompat);
+        
         myEventSource = CGEventSourceCreate(kCGEventSourceStatePrivate);
         pData = (vKeyHookState*)vKeyInit();
 
@@ -523,6 +526,48 @@ void handleMacro() {
         SendKeyCode(_keycode | (_flag & kCGEventFlagMaskShift ? CAPS_MASK : 0));
     }
 
+    // TODO: Research API to convert character into CGKeyCode more elegantly!
+    int ConvertKeyStringToKeyCode(NSString *keyString, CGKeyCode fallback) {
+        // Infomation about capitalization (shift/caps) is already included
+        // in the original CGEvent, only find out which position on keyboard a key is pressed
+        NSString *lowercasedKeyString = [keyString lowercaseString];
+        if (!lowercasedKeyString) {
+            return fallback;
+        }
+        
+        // Ignore code for Modifier keys and numpad
+        // Reference: https://eastmanreference.com/complete-list-of-applescript-key-codes
+        NSDictionary *keyStringToKeyCodeMap = @{
+            // Characters from number row
+            @"`": @50, @"~": @50, @"1": @18, @"!": @18, @"2": @19, @"@": @19, @"3": @20, @"#": @20, @"4": @21, @"$": @21,
+            @"5": @23, @"%": @23, @"6": @22, @"^": @22, @"7": @26, @"&": @26, @"8": @28, @"*": @28, @"9": @25, @"(": @25,
+            @"0": @29, @")": @29, @"-": @27, @"_": @27, @"=": @24, @"+": @24,
+            // Characters from first keyboard row
+            @"q": @12, @"w": @13, @"e": @14, @"r": @15, @"t": @17, @"y": @16, @"u": @32, @"i": @34, @"o": @31, @"p": @35,
+            @"[": @33, @"{": @33, @"]": @30, @"}": @30, @"\\": @42, @"|": @42,
+            // Characters from second keyboard row
+            @"a": @0, @"s": @1, @"d": @2, @"f": @3, @"g": @5, @"h": @4, @"j": @38, @"k": @40, @"l": @37,
+            @";": @41, @":": @41, @"'": @39, @"\"": @39,
+            // Characters from second third row
+            @"z": @6, @"x": @7, @"c": @8, @"v": @9, @"b": @11, @"n": @45, @"m": @46,
+            @",": @43, @"<": @43, @".": @47, @">": @47, @"/": @44, @"?": @44
+        };
+        NSNumber *keycode = [keyStringToKeyCodeMap objectForKey:lowercasedKeyString];
+
+        if (keycode) {
+            return [keycode intValue];
+        }
+        return fallback;
+    }
+
+    // If conversion fails, return fallbackKeyCode
+    CGKeyCode ConvertEventToKeyboadLayoutCompatKeyCode(CGEventRef keyEvent, CGKeyCode fallbackKeyCode) {
+        NSEvent *kbLayoutCompatEvent = [NSEvent eventWithCGEvent:keyEvent];
+        NSString *kbLayoutCompatKeyString = kbLayoutCompatEvent.charactersIgnoringModifiers;
+        return ConvertKeyStringToKeyCode(kbLayoutCompatKeyString,
+                                         fallbackKeyCode);
+    }
+
     /**
      * MAIN HOOK entry, very important function.
      * MAIN Callback.
@@ -536,6 +581,11 @@ CGEventRef OpenKeyCallback(CGEventTapProxy proxy, CGEventType type, CGEventRef e
         _flag = CGEventGetFlags(event);
         _keycode = (CGKeyCode)CGEventGetIntegerValueField(event, kCGKeyboardEventKeycode);
 
+        if (type == kCGEventKeyDown && vPerformLayoutCompat) {
+            // If conversion fail, use current keycode
+           _keycode = ConvertEventToKeyboadLayoutCompatKeyCode(event, _keycode);
+        }
+        
         //switch language shortcut; convert hotkey
         if (type == kCGEventKeyDown) {
             if (GET_SWITCH_KEY(vSwitchKeyStatus) != _keycode && GET_SWITCH_KEY(convertToolHotKey) != _keycode) {

Sources/OpenKey/macOS/ModernKey/OpenKey.mm

@@ -61,6 +61,7 @@
 @property (weak) IBOutlet NSButton *ShowIconOnDock;
 @property (weak) IBOutlet NSButton *CheckNewVersionOnStartup;
 @property (weak) IBOutlet NSButton *FixChromiumBrowser;
+@property (weak) IBOutlet NSButton *PerformLayoutCompat;
 
 @property (weak) IBOutlet NSButton *CheckNewVersionButton;
 @property (weak) IBOutlet NSTextField *VersionInfo;

Sources/OpenKey/macOS/ModernKey/ViewController.h

@@ -36,6 +36,7 @@
 extern int vShowIconOnDock;
 extern int vAutoCapsMacro;
 extern int vFixChromiumBrowser;
+extern int vPerformLayoutCompat;
 
 @implementation ViewController {
     __weak IBOutlet NSButton *CustomSwitchCommand;
@@ -268,6 +269,11 @@ - (IBAction)onSendKeyStepByStep:(id)sender {
     vSendKeyStepByStep = (int)val;
 }
 
+- (IBAction)onPerformLayoutCompat:(id)sender {
+    NSInteger val = [self setCustomValue:sender keyToSet:@"vPerformLayoutCompat"];
+    vPerformLayoutCompat = (int)val;
+}
+
 - (NSInteger)setCustomValue:(NSButton*)sender keyToSet:(NSString*) key {
     NSInteger val = 0;
     if (sender.state == NSControlStateValueOn) {
@@ -444,6 +450,9 @@ -(void)fillData {
     self.FixChromiumBrowser.state = value ? NSControlStateValueOn : NSControlStateValueOff;
     self.FixChromiumBrowser.enabled = fixRecommendBrowser ? YES : NO;
 
+    value = [[NSUserDefaults standardUserDefaults] integerForKey:@"vPerformLayoutCompat"];
+    self.PerformLayoutCompat.state = value ? NSControlStateValueOn : NSControlStateValueOff;
+    
     CustomSwitchControl.state = (vSwitchKeyStatus & 0x100) ? NSControlStateValueOn : NSControlStateValueOff;
     CustomSwitchOption.state = (vSwitchKeyStatus & 0x200) ? NSControlStateValueOn : NSControlStateValueOff;
     CustomSwitchCommand.state = (vSwitchKeyStatus & 0x400) ? NSControlStateValueOn : NSControlStateValueOff;

Sources/OpenKey/macOS/ModernKey/ViewController.m

@@ -308,7 +308,7 @@
 		232EDA4C21F1B33E0085D362 /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1010;
+				LastUpgradeCheck = 1130;
 				ORGANIZATIONNAME = "Tuyen Mai";
 				TargetAttributes = {
 					232EDA5321F1B33E0085D362 = {
@@ -548,6 +548,7 @@
 			buildSettings = {
 				CLANG_ENABLE_MODULES = NO;
 				CODE_SIGN_ENTITLEMENTS = ModernKey/ModernKey.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_TEAM = 7X875U5EVD;
@@ -571,6 +572,7 @@
 			buildSettings = {
 				CLANG_ENABLE_MODULES = NO;
 				CODE_SIGN_ENTITLEMENTS = ModernKey/ModernKey.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_TEAM = 7X875U5EVD;
@@ -594,6 +596,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = OpenKeyHelper/OpenKeyHelper.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_TEAM = 7X875U5EVD;
@@ -613,6 +616,7 @@
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CODE_SIGN_ENTITLEMENTS = OpenKeyHelper/OpenKeyHelper.entitlements;
+				CODE_SIGN_IDENTITY = "-";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
 				DEVELOPMENT_TEAM = 7X875U5EVD;

Sources/OpenKey/macOS/OpenKey.xcodeproj/project.pbxproj

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1010"
+   LastUpgradeVersion = "1130"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -27,8 +27,6 @@
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       shouldUseLaunchSchemeArgsEnv = "YES">
-      <Testables>
-      </Testables>
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
@@ -38,8 +36,8 @@
             ReferencedContainer = "container:OpenKey.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
-      <AdditionalOptions>
-      </AdditionalOptions>
+      <Testables>
+      </Testables>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Release"
@@ -61,8 +59,6 @@
             ReferencedContainer = "container:OpenKey.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <AdditionalOptions>
-      </AdditionalOptions>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"