vChewing-macOS/Source/Modules/SessionCtl_Core.swift

282 lines
13 KiB
Swift
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// (c) 2021 and onwards The vChewing Project (MIT-NTL License).
// ====================
// This code is released under the MIT license (SPDX-License-Identifier: MIT)
// ... with NTL restriction stating that:
// No trademark license is granted to use the trade names, trademarks, service
// marks, or product names of Contributor, except as required to fulfill notice
// requirements defined in MIT License.
import CandidateWindow
import CocoaExtension
import IMKUtils
import PopupCompositionBuffer
import Shared
import ShiftKeyUpChecker
import TooltipUI
///
///
/// IMKInputController
///
/// / IMKInputController
/// 調
/// - Remark: IMKServer
/// IMKInputController
@objc(SessionCtl) // ObjC IMK ObjC
class SessionCtl: IMKInputController {
///
static var areWeNerfing = false
///
static var ctlCandidateCurrent: CtlCandidateProtocol = {
let direction: NSUserInterfaceLayoutOrientation =
PrefMgr.shared.useHorizontalCandidateList ? .horizontal : .vertical
if #available(macOS 10.15, *) {
return PrefMgr.shared.useIMKCandidateWindow
? CtlCandidateIMK(direction) : CtlCandidateTDK(direction)
} else {
return CtlCandidateIMK(direction)
}
}()
///
static var tooltipInstance = TooltipUI()
///
static var popupCompositionBuffer = PopupCompositionBuffer()
// MARK: -
/// Caps Lock
var isCapsLocked: Bool { NSEvent.modifierFlags.intersection(.deviceIndependentFlagsMask).contains(.capsLock) }
/// SessionCtl
var isASCIIMode = false {
didSet {
resetKeyHandler()
setKeyLayout()
}
}
/// 調
var keyHandler = KeyHandler(lm: LMMgr.currentLM(), uom: LMMgr.currentUOM(), pref: PrefMgr.shared)
///
var state: IMEStateProtocol = IMEState.ofEmpty() {
didSet {
guard oldValue.type != state.type else { return }
vCLog("Current State: \(state.type.rawValue)")
//
// guard state.isCandidateContainer != oldValue.isCandidateContainer else { return }
// if state.isCandidateContainer || oldValue.isCandidateContainer { setKeyLayout() }
}
}
/// Shift
/// - Remark: Struct Caps Lock Shift
static var theShiftKeyDetector = ShiftKeyUpChecker(useLShift: PrefMgr.shared.togglingAlphanumericalModeWithLShift)
/// `handle(event:)` Shift
var rencentKeyHandledByKeyHandlerEtc = false
///
public static var isVerticalTyping: Bool = false
public var isVerticalTyping: Bool {
guard let client = client() else { return false }
var textFrame = NSRect.seniorTheBeast
let attributes: [AnyHashable: Any]? = client.attributes(
forCharacterIndex: 0, lineHeightRectangle: &textFrame
)
let result = (attributes?["IMKTextOrientation"] as? NSNumber)?.intValue == 0 || false
Self.isVerticalTyping = result
return result
}
/// InputMode
/// IME UserPrefs
var inputMode: Shared.InputMode = IMEApp.currentInputMode {
willSet {
/// Prefs IMEApp
PrefMgr.shared.mostRecentInputMode = newValue.rawValue
}
didSet {
if oldValue != inputMode, inputMode != .imeModeNULL {
UserDefaults.standard.synchronize()
keyHandler.clear() // handle State.Empty()
// ----------------------------
///
keyHandler.currentLM = LMMgr.currentLM() //
keyHandler.currentUOM = LMMgr.currentUOM()
///
keyHandler.ensureKeyboardParser()
///
syncBaseLMPrefs()
// ----------------------------
Self.isVerticalTyping = isVerticalTyping
// 使
handle(state: IMEState.ofEmpty())
}
}
}
///
///
/// inputClient IMKServer IMKTextInput
/// - Remark: IMKInputController client()
/// - Parameters:
/// - server: IMKServer
/// - delegate:
/// - inputClient:
override init!(server: IMKServer!, delegate: Any!, client inputClient: Any!) {
super.init(server: server, delegate: delegate, client: inputClient)
keyHandler.delegate = self
syncBaseLMPrefs()
}
}
// MARK: -
extension SessionCtl {
///
func setKeyLayout() {
guard let client = client() else { return }
func doSetKeyLayout() {
if isASCIIMode, IMKHelper.isDynamicBasicKeyboardLayoutEnabled {
client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.alphanumericalKeyboardLayout)
return
}
client.overrideKeyboard(withKeyboardNamed: PrefMgr.shared.basicKeyboardLayout)
}
DispatchQueue.main.async {
doSetKeyLayout()
}
}
/// 調
func resetKeyHandler() {
//
if state.type == .ofInputting, PrefMgr.shared.trimUnfinishedReadingsOnCommit {
keyHandler.composer.clear()
handle(state: keyHandler.buildInputtingState)
}
let isSecureMode = PrefMgr.shared.clientsIMKTextInputIncapable.contains(clientBundleIdentifier)
if state.hasComposition, !isSecureMode {
/// 調
handle(state: IMEState.ofCommitting(textToCommit: state.displayedText))
}
handle(state: isSecureMode ? IMEState.ofAbortion() : IMEState.ofEmpty())
}
}
// MARK: - IMKStateSetting
extension SessionCtl {
///
/// - Parameter sender: 使
override func activateServer(_ sender: Any!) {
_ = sender //
UserDefaults.standard.synchronize()
// activateServer nil
//
if keyHandler.delegate == nil { keyHandler.delegate = self }
// setValue() IMK activateServer() setValue()
keyHandler.clear() // handle State.Empty()
keyHandler.ensureKeyboardParser()
Self.theShiftKeyDetector.alsoToggleWithLShift = PrefMgr.shared.togglingAlphanumericalModeWithLShift
if #available(macOS 10.15, *) {
if isASCIIMode, PrefMgr.shared.disableShiftTogglingAlphanumericalMode { isASCIIMode = false }
}
DispatchQueue.main.async {
(NSApp.delegate as? AppDelegate)?.updateSputnik.checkForUpdate(forced: false, url: kUpdateInfoSourceURL)
}
}
///
/// - Parameter sender: 使
override func deactivateServer(_ sender: Any!) {
_ = sender //
resetKeyHandler() // Empty
handle(state: IMEState.ofDeactivated())
}
///
/// - Parameters:
/// - value: identifier bundle identifier info.plist
/// - tag: 使
/// - sender: 使
override func setValue(_ value: Any!, forTag tag: Int, client sender: Any!) {
_ = tag //
_ = sender //
let newInputMode = Shared.InputMode(rawValue: value as? String ?? "") ?? Shared.InputMode.imeModeNULL
if PrefMgr.shared.onlyLoadFactoryLangModelsIfNeeded { LMMgr.loadDataModel(newInputMode) }
inputMode = newInputMode
if let rawValString = value as? String, let bundleID = Bundle.main.bundleIdentifier,
!bundleID.isEmpty, !rawValString.contains(bundleID)
{
setKeyLayout()
}
}
///
func syncBaseLMPrefs() {
LMMgr.currentLM().isPhraseReplacementEnabled = PrefMgr.shared.phraseReplacementEnabled
LMMgr.currentLM().isCNSEnabled = PrefMgr.shared.cns11643Enabled
LMMgr.currentLM().isSymbolEnabled = PrefMgr.shared.symbolInputEnabled
LMMgr.currentLM().isSCPCEnabled = PrefMgr.shared.useSCPCTypingMode
LMMgr.currentLM().deltaOfCalendarYears = PrefMgr.shared.deltaOfCalendarYears
}
}
// MARK: - IMKServerInput
// handle(_ event:) SessionCtl_HandleEvent.swift
extension SessionCtl {
///
///
///
/// Swift `NSEvent.EventTypeMask = [.keyDown]` ObjC `NSKeyDownMask`
/// IMK
/// 使
/// `commitComposition(_ message)`
/// - Parameter sender: 使
/// - Returns: uint NSEvent NSEvent.h
override func recognizedEvents(_ sender: Any!) -> Int {
_ = sender //
let events: NSEvent.EventTypeMask = [.keyDown, .flagsChanged]
return Int(events.rawValue)
}
/// App Ctrl+Enter / Shift+Enter
/// handle(event:) Event
/// commitComposition
/// - Parameter sender: 使
override func commitComposition(_ sender: Any!) {
_ = sender //
resetKeyHandler()
// super.commitComposition(sender) //
}
/// InputMethodKit
/// - Parameter sender: 使
/// - Returns: nil
override func composedString(_ sender: Any!) -> Any! {
_ = sender //
guard state.hasComposition else { return "" }
return state.displayedTextConverted
}
///
/// IMK Bug
override func inputControllerWillClose() {
//
resetKeyHandler()
super.inputControllerWillClose()
}
}