spiegel-keyman/mac/Keyman4MacIM/Keyman4MacIM/KMInputController.m

//
//  KMInputController.m
//  Keyman4MacIM
//
//  Created by Serkan Kurt on 29/01/2015.
//  Copyright (c) 2017 SIL International. All rights reserved.
//

#import "KMInputController.h"
#import "KMInputMethodEventHandler.h"
#import "KMOSVersion.h"
#include <Carbon/Carbon.h> /* For kVK_ constants. */
#import "KMLogs.h"

@implementation KMInputController

KMInputMethodEventHandler* _eventHandler;
NSMutableArray *servers;

- (KMInputMethodAppDelegate *)AppDelegate {
  return (KMInputMethodAppDelegate *)[NSApp delegate];
}

- (id)initWithServer:(IMKServer *)server delegate:(id)delegate client:(id)inputClient
{
  os_log_debug([KMLogs lifecycleLog], "Initializing Keyman Input Method for server with bundleID: %{public}@", server.bundle.bundleIdentifier);
  
  self = [super initWithServer:server delegate:delegate client:inputClient];
  if (self) {
    servers = [[NSMutableArray alloc] initWithCapacity:2];
    self.AppDelegate.inputController = self;
    if (self.AppDelegate.kvk != nil && self.AppDelegate.alwaysShowOSK) {
      [self.AppDelegate showOSK];
    }
  }
  
  return self;
}

- (NSUInteger)recognizedEvents:(id)sender {
  return NSEventMaskKeyDown | NSEventMaskFlagsChanged;
}

- (BOOL)handleEvent:(NSEvent *)event client:(id)sender {
  if (event == nil || sender == nil || self.kmx == nil || _eventHandler == nil) {
    os_log_error([KMLogs eventsLog], "IMInputController handleEvent: not prepared to handle event = %{public}@", event);
    return NO; // Not sure this can ever happen.
  }
  
  return [_eventHandler handleEvent:event client:sender];
}

// Passthrough from the app delegate low level event hook
// to the input method event handler for handleBackspace.
- (void)handleBackspace:(NSEvent *)event {
  os_log_debug([KMLogs keyLog], "KMInputController handleBackspace, event = %{public}@", event);
  if(_eventHandler != nil) {
    [_eventHandler handleBackspace:event];
  }
}

- (void)activateServer:(id)sender {
  @synchronized(servers) {
    [sender overrideKeyboardWithKeyboardNamed:@"com.apple.keylayout.US"];
    
    [self.AppDelegate wakeUpWith:sender];
    [servers addObject:sender];
    
    if (_eventHandler != nil) {
      [_eventHandler deactivate];
    }
    
    NSRunningApplication *currApp = [[NSWorkspace sharedWorkspace] frontmostApplication];
    NSString *clientAppId = [currApp bundleIdentifier];
    os_log_debug([KMLogs lifecycleLog], "activateServer, new active app: '%{public}@'", clientAppId);
    
    _eventHandler = [[KMInputMethodEventHandler alloc] initWithClient:clientAppId client:sender];
    
  }
}

- (void)deactivateServer:(id)sender {
  if ([self.AppDelegate debugMode]) {
    os_log_debug([KMLogs lifecycleLog], "deactivateServer, sender %{public}@", sender);
  }
  @synchronized(servers) {
    for (int i = 0; i < servers.count; i++) {
      if (servers[i] == sender) {
        [servers removeObjectAtIndex:i];
        break;
      }
    }
    if (servers.count == 0) {
      os_log_debug([KMLogs lifecycleLog], "No known active server for Keyman IM. Starting countdown to sleep...");
      [self performSelector:@selector(timerAction:) withObject:sender afterDelay:0.7];
    }
  }
}

- (void)timerAction:(id)lastServer {
  @synchronized(servers) {
    if (servers.count == 0) {
      if (_eventHandler != nil) {
        [_eventHandler deactivate];
        _eventHandler = nil;
      }
      [self.AppDelegate sleepFollowingDeactivationOfServer:lastServer];
    }
  }
}


/*
 - (NSDictionary *)modes:(id)sender {
 if ([self.AppDelegate debugMode])
 os_log_debug([KMLogs lifecycleLog], "*** Modes ***");
 if (_kmModes == nil) {
 NSDictionary *amhMode = [[NSDictionary alloc] initWithObjectsAndKeys:@"keyman.png", kTSInputModeAlternateMenuIconFileKey,
 [NSNumber numberWithBool:YES], kTSInputModeDefaultStateKey,
 [NSNumber numberWithBool:YES], kTSInputModeIsVisibleKey,
 @"A", kTSInputModeKeyEquivalentKey,
 [NSNumber numberWithInteger:4608], kTSInputModeKeyEquivalentModifiersKey,
 [NSNumber numberWithBool:YES], kTSInputModeDefaultStateKey,
 @"keyman.png", kTSInputModeMenuIconFileKey,
 @"keyman.png", kTSInputModePaletteIconFileKey,
 [NSNumber numberWithBool:YES], kTSInputModePrimaryInScriptKey,
 @"smUnicodeScript", kTSInputModeScriptKey,
 @"amh", @"TISIntendedLanguage", nil];
 
 NSDictionary *hinMode = [[NSDictionary alloc] initWithObjectsAndKeys:@"keyman.png", kTSInputModeAlternateMenuIconFileKey,
 [NSNumber numberWithBool:YES], kTSInputModeDefaultStateKey,
 [NSNumber numberWithBool:YES], kTSInputModeIsVisibleKey,
 @"H", kTSInputModeKeyEquivalentKey,
 [NSNumber numberWithInteger:4608], kTSInputModeKeyEquivalentModifiersKey,
 [NSNumber numberWithBool:YES], kTSInputModeDefaultStateKey,
 @"keyman.png", kTSInputModeMenuIconFileKey,
 @"keyman.png", kTSInputModePaletteIconFileKey,
 [NSNumber numberWithBool:YES], kTSInputModePrimaryInScriptKey,
 @"smUnicodeScript", kTSInputModeScriptKey,
 @"hin", @"TISIntendedLanguage", nil];
 
 NSDictionary *modeList = [[NSDictionary alloc] initWithObjectsAndKeys:amhMode, @"com.apple.inputmethod.amh", hinMode, @"com.apple.inputmethod.hin", nil];
 NSArray *modeOrder = [[NSArray alloc] initWithObjects:@"com.apple.inputmethod.amh", @"com.apple.inputmethod.hin", nil];
 _kmModes = [[NSDictionary alloc] initWithObjectsAndKeys:modeList, kTSInputModeListKey,
 modeOrder, kTSVisibleInputModeOrderedArrayKey, nil];
 }
 
 return _kmModes;
 }
 */

- (NSMenu *)menu {
  return self.AppDelegate.menu;
}

- (KMXFile *)kmx {
  return self.AppDelegate.kmx;
}

- (void)menuAction:(id)sender {
  NSMenuItem *mItem = [sender objectForKey:kIMKCommandMenuItemName];
  NSInteger itag = mItem.tag;
  os_log_debug([KMLogs uiLog], "Keyman menu clicked - tag: %lu", itag);
  if (itag == CONFIG_MENUITEM_TAG) {
    [self showConfigurationWindow:sender];
  }
  else if (itag == OSK_MENUITEM_TAG) {
    [self.AppDelegate showOSK];
  }
  else if (itag == ABOUT_MENUITEM_TAG) {
    [self.AppDelegate showAboutWindow];
  }
  else if (itag >= KEYMAN_FIRST_KEYBOARD_MENUITEM_TAG) {
    [self.AppDelegate selectKeyboardFromMenu:itag];
  }
}

- (void)showConfigurationWindow:(id)sender {
  // Using `showConfigurationWindow` instead of `showPreferences:` because `showPreferences:` is missing in
  // High Sierra (10.13.1 - 10.13.3). See: https://bugreport.apple.com/web/?problemID=35422518
  // rrb: where Apple's API is broken (10.13.1-10.13.3) call our workaround, otherwise, call showPreferences
  u_int16_t systemVersion = [KMOSVersion SystemVersion];
  if ([KMOSVersion Version_10_13_1] <= systemVersion && systemVersion <= [KMOSVersion Version_10_13_3]) // between 10.13.1 and 10.13.3 inclusive
  {
    os_log_info([KMLogs uiLog], "Input Menu: calling workaround instead of showPreferences (sys ver %x)", systemVersion);
    [self.AppDelegate showConfigurationWindow]; // call our workaround
  }
  else
  {
    os_log_info([KMLogs uiLog], "Input Menu: calling Apple's showPreferences (sys ver %x)", systemVersion);
    [self showPreferences:sender]; // call Apple API
  }
}

@end