288 lines
11 KiB
Swift
288 lines
11 KiB
Swift
// (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.
|
||
|
||
public class ctlCandidateIMK: IMKCandidates, ctlCandidateProtocol {
|
||
public var currentLayout: CandidateLayout = .horizontal
|
||
public static let defaultIMKSelectionKey: [UInt16: String] = [
|
||
18: "1", 19: "2", 20: "3", 21: "4", 23: "5", 22: "6", 26: "7", 28: "8", 25: "9",
|
||
]
|
||
public weak var delegate: ctlCandidateDelegate? {
|
||
didSet {
|
||
reloadData()
|
||
}
|
||
}
|
||
|
||
public var visible = false { didSet { visible ? show() : hide() } }
|
||
|
||
public var windowTopLeftPoint: NSPoint {
|
||
get {
|
||
let frameRect = candidateFrame()
|
||
return NSPoint(x: frameRect.minX, y: frameRect.maxY)
|
||
}
|
||
set {
|
||
DispatchQueue.main.async {
|
||
self.set(windowTopLeftPoint: newValue, bottomOutOfScreenAdjustmentHeight: 0)
|
||
}
|
||
}
|
||
}
|
||
|
||
public var keyLabels: [CandidateKeyLabel] = ["1", "2", "3", "4", "5", "6", "7", "8", "9"]
|
||
.map {
|
||
CandidateKeyLabel(key: $0, displayedText: $0)
|
||
}
|
||
|
||
public var keyLabelFont = NSFont.monospacedDigitSystemFont(
|
||
ofSize: 14, weight: .medium
|
||
)
|
||
|
||
public var candidateFont = NSFont.systemFont(ofSize: PrefMgr.shared.candidateListTextSize) {
|
||
didSet {
|
||
if #available(macOS 10.14, *) { setFontSize(candidateFont.pointSize) }
|
||
var attributes = attributes()
|
||
// FB11300759: Set "NSAttributedString.Key.font" doesn't work.
|
||
attributes?[NSAttributedString.Key.font] = candidateFont
|
||
if PrefMgr.shared.handleDefaultCandidateFontsByLangIdentifier {
|
||
switch IMEApp.currentInputMode {
|
||
case .imeModeCHS:
|
||
if #available(macOS 12.0, *) {
|
||
attributes?[NSAttributedString.Key.languageIdentifier] = "zh-Hans" as AnyObject
|
||
}
|
||
case .imeModeCHT:
|
||
if #available(macOS 12.0, *) {
|
||
attributes?[NSAttributedString.Key.languageIdentifier] =
|
||
(PrefMgr.shared.shiftJISShinjitaiOutputEnabled || PrefMgr.shared.chineseConversionEnabled)
|
||
? "ja" as AnyObject : "zh-Hant" as AnyObject
|
||
}
|
||
default:
|
||
break
|
||
}
|
||
}
|
||
setAttributes(attributes)
|
||
update()
|
||
}
|
||
}
|
||
|
||
public var tooltip: String = ""
|
||
|
||
var keyCount = 0
|
||
var displayedCandidates = [String]()
|
||
|
||
public func specifyLayout(_ layout: CandidateLayout = .horizontal) {
|
||
currentLayout = layout
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
if #available(macOS 10.14, *) {
|
||
setPanelType(kIMKScrollingGridCandidatePanel)
|
||
} else {
|
||
// macOS 10.13 High Sierra 的矩陣選字窗不支援選字鍵，所以只能弄成橫版單行。
|
||
setPanelType(kIMKSingleRowSteppingCandidatePanel)
|
||
}
|
||
case .vertical:
|
||
setPanelType(kIMKSingleColumnScrollingCandidatePanel)
|
||
}
|
||
}
|
||
|
||
public required init(_ layout: CandidateLayout = .horizontal) {
|
||
super.init(server: theServer, panelType: kIMKScrollingGridCandidatePanel)
|
||
specifyLayout(layout)
|
||
// 設為 true 表示先交給 ctlIME 處理
|
||
setAttributes([IMKCandidatesSendServerKeyEventFirst: true])
|
||
visible = false
|
||
// guard let currentTISInputSource = currentTISInputSource else { return } // 下面兩句都沒用，所以註釋掉。
|
||
// setSelectionKeys([18, 19, 20, 21, 23, 22, 26, 28, 25]) // 這句是壞的，用了反而沒有選字鍵。
|
||
// setSelectionKeysKeylayout(currentTISInputSource) // 這句也是壞的，沒有卵用。
|
||
}
|
||
|
||
@available(*, unavailable)
|
||
required init?(coder _: NSCoder) {
|
||
fatalError("init(coder:) has not been implemented")
|
||
}
|
||
|
||
public func reloadData() {
|
||
// guard let delegate = delegate else { return } // 下文無效，所以這句沒用。
|
||
// 既然下述函式無效，那中間這段沒用的也都砍了。
|
||
// setCandidateData(candidates) // 該函式無效。
|
||
keyCount = selectionKeys().count
|
||
selectedCandidateIndex = 0
|
||
update()
|
||
}
|
||
|
||
/// 幹話：這裡很多函式內容亂寫也都無所謂了，因為都被 IMKCandidates 代管執行。
|
||
/// 對於所有 IMK 選字窗的選字判斷動作，不是在 keyHandler 中，而是在 `ctlIME_Core` 中。
|
||
|
||
private var currentPageIndex: Int = 0
|
||
|
||
private var pageCount: Int {
|
||
guard let delegate = delegate else { return 0 }
|
||
let totalCount = delegate.candidateCountForController(self)
|
||
let keyLabelCount = keyLabels.count
|
||
return totalCount / keyLabelCount + ((totalCount % keyLabelCount) != 0 ? 1 : 0)
|
||
}
|
||
|
||
// 該函式會影響 IMK 選字窗。
|
||
@discardableResult public func showNextPage() -> Bool {
|
||
do { currentLayout == .vertical ? moveRight(self) : moveDown(self) }
|
||
return true
|
||
}
|
||
|
||
// 該函式會影響 IMK 選字窗。
|
||
@discardableResult public func showPreviousPage() -> Bool {
|
||
do { currentLayout == .vertical ? moveLeft(self) : moveUp(self) }
|
||
return true
|
||
}
|
||
|
||
// 該函式會影響 IMK 選字窗。
|
||
@discardableResult public func highlightNextCandidate() -> Bool {
|
||
do { currentLayout == .vertical ? moveDown(self) : moveRight(self) }
|
||
return true
|
||
}
|
||
|
||
// 該函式會影響 IMK 選字窗。
|
||
@discardableResult public func highlightPreviousCandidate() -> Bool {
|
||
do { currentLayout == .vertical ? moveUp(self) : moveLeft(self) }
|
||
return true
|
||
}
|
||
|
||
public func candidateIndexAtKeyLabelIndex(_ index: Int) -> Int {
|
||
guard let delegate = delegate else { return Int.max }
|
||
let result = currentPageIndex * keyLabels.count + index
|
||
return result < delegate.candidateCountForController(self) ? result : Int.max
|
||
}
|
||
|
||
public var selectedCandidateIndex: Int {
|
||
get { selectedCandidate() }
|
||
set { selectCandidate(withIdentifier: newValue) }
|
||
}
|
||
|
||
public func set(windowTopLeftPoint: NSPoint, bottomOutOfScreenAdjustmentHeight height: CGFloat) {
|
||
DispatchQueue.main.async {
|
||
self.doSet(windowTopLeftPoint: windowTopLeftPoint, bottomOutOfScreenAdjustmentHeight: height)
|
||
}
|
||
}
|
||
|
||
func doSet(windowTopLeftPoint: NSPoint, bottomOutOfScreenAdjustmentHeight heightDelta: CGFloat) {
|
||
var adjustedPoint = windowTopLeftPoint
|
||
let windowSize = candidateFrame().size
|
||
var delta = heightDelta
|
||
var screenFrame = NSScreen.main?.visibleFrame ?? NSRect.seniorTheBeast
|
||
for frame in NSScreen.screens.map(\.visibleFrame).filter({ $0.contains(windowTopLeftPoint) }) {
|
||
screenFrame = frame
|
||
break
|
||
}
|
||
|
||
if delta > screenFrame.size.height / 2.0 { delta = 0.0 }
|
||
|
||
if adjustedPoint.y < screenFrame.minY + windowSize.height {
|
||
adjustedPoint.y = windowTopLeftPoint.y + windowSize.height + delta
|
||
}
|
||
adjustedPoint.y = min(adjustedPoint.y, screenFrame.maxY - 1.0)
|
||
adjustedPoint.x = min(max(adjustedPoint.x, screenFrame.minX), screenFrame.maxX - windowSize.width - 1.0)
|
||
|
||
setCandidateFrameTopLeft(adjustedPoint)
|
||
}
|
||
|
||
override public func interpretKeyEvents(_ eventArray: [NSEvent]) {
|
||
// 鬼知道為什麼這個函式接收的參數是陣列，但經過測試卻發現這個函式收到的陣列往往內容只有一個。
|
||
// 這也可能是 Objective-C 當中允許接收內容為 nil 的一種方式。
|
||
guard !eventArray.isEmpty else { return }
|
||
let event = eventArray[0]
|
||
guard let delegate = delegate else { return }
|
||
if event.isEsc || event.isBackSpace || event.isDelete || (event.isShiftHold && !event.isSpace) {
|
||
_ = delegate.sharedEventHandler(event)
|
||
} else if event.isSymbolMenuPhysicalKey {
|
||
// 符號鍵的行為是固定的，不受偏好設定影響。
|
||
switch currentLayout {
|
||
case .horizontal: event.isShiftHold ? moveUp(self) : moveDown(self)
|
||
case .vertical: event.isShiftHold ? moveLeft(self) : moveRight(self)
|
||
}
|
||
} else if event.isSpace {
|
||
switch PrefMgr.shared.specifyShiftSpaceKeyBehavior {
|
||
case true: _ = event.isShiftHold ? highlightNextCandidate() : showNextPage()
|
||
case false: _ = event.isShiftHold ? showNextPage() : highlightNextCandidate()
|
||
}
|
||
} else if event.isTab {
|
||
switch PrefMgr.shared.specifyShiftTabKeyBehavior {
|
||
case true: _ = event.isShiftHold ? showPreviousPage() : showNextPage()
|
||
case false: _ = event.isShiftHold ? highlightPreviousCandidate() : highlightNextCandidate()
|
||
}
|
||
} else {
|
||
if let newChar = Self.defaultIMKSelectionKey[event.keyCode] {
|
||
/// 根據 KeyCode 重新換算一下選字鍵的 NSEvent，糾正其 Character 數值。
|
||
/// 反正 IMK 選字窗目前也沒辦法修改選字鍵。
|
||
let newEvent = event.reinitiate(characters: newChar)
|
||
if let newEvent = newEvent {
|
||
if PrefMgr.shared.useSCPCTypingMode, delegate.isAssociatedPhrasesState {
|
||
// 註：input.isShiftHold 已經在 ctlInputMethod.handle() 內處理，因為在那邊處理才有效。
|
||
if !event.isShiftHold {
|
||
_ = delegate.sharedEventHandler(event)
|
||
return
|
||
}
|
||
} else {
|
||
if #available(macOS 10.14, *) {
|
||
handleKeyboardEvent(newEvent)
|
||
} else {
|
||
super.interpretKeyEvents([newEvent])
|
||
}
|
||
return
|
||
}
|
||
}
|
||
}
|
||
|
||
if PrefMgr.shared.useSCPCTypingMode, !event.isReservedKey {
|
||
_ = delegate.sharedEventHandler(event)
|
||
return
|
||
}
|
||
|
||
if delegate.isAssociatedPhrasesState,
|
||
!event.isPageUp, !event.isPageDown, !event.isCursorForward, !event.isCursorBackward,
|
||
!event.isCursorClockLeft, !event.isCursorClockRight, !event.isSpace,
|
||
!event.isEnter || !PrefMgr.shared.alsoConfirmAssociatedCandidatesByEnter
|
||
{
|
||
_ = delegate.sharedEventHandler(event)
|
||
return
|
||
}
|
||
super.interpretKeyEvents(eventArray)
|
||
}
|
||
}
|
||
|
||
public func superInterpretKeyEvents(_ eventArray: [NSEvent]) {
|
||
super.interpretKeyEvents(eventArray)
|
||
}
|
||
}
|
||
|
||
// MARK: - Generate TISInputSource Object
|
||
|
||
/// 該參數只用來獲取 "com.apple.keylayout.ABC" 對應的 TISInputSource，
|
||
/// 所以少寫了很多在這裡用不到的東西。
|
||
/// 想參考完整版的話，請洽該專案內的 IME.swift。
|
||
var currentTISInputSource: TISInputSource? {
|
||
var result: TISInputSource?
|
||
let list = TISCreateInputSourceList(nil, true).takeRetainedValue() as! [TISInputSource]
|
||
let matchedTISString = "com.apple.keylayout.ABC"
|
||
for source in list {
|
||
guard let ptrCat = TISGetInputSourceProperty(source, kTISPropertyInputSourceCategory) else { continue }
|
||
let category = Unmanaged<CFString>.fromOpaque(ptrCat).takeUnretainedValue()
|
||
guard category == kTISCategoryKeyboardInputSource else { continue }
|
||
guard let ptrSourceID = TISGetInputSourceProperty(source, kTISPropertyInputSourceID) else { continue }
|
||
let sourceID = String(Unmanaged<CFString>.fromOpaque(ptrSourceID).takeUnretainedValue())
|
||
if sourceID == matchedTISString { result = source }
|
||
}
|
||
return result
|
||
}
|
||
|
||
// MARK: - Translating NumPad KeyCodes to Default IMK Candidate Selection KeyCodes.
|
||
|
||
extension ctlCandidateIMK {
|
||
public static func replaceNumPadKeyCodes(target event: NSEvent) -> NSEvent? {
|
||
let mapNumPadKeyCodeTranslation: [UInt16: UInt16] = [
|
||
83: 18, 84: 19, 85: 20, 86: 21, 87: 23, 88: 22, 89: 26, 91: 28, 92: 25,
|
||
]
|
||
return event.reinitiate(keyCode: mapNumPadKeyCodeTranslation[event.keyCode] ?? event.keyCode)
|
||
}
|
||
}
|