358 lines
12 KiB
Swift
358 lines
12 KiB
Swift
// (c) 2022 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 Cocoa
|
||
import Shared
|
||
|
||
/// 候選字窗會用到的資料池單位。
|
||
public struct CandidatePool {
|
||
public let blankCell = CandidateCellData(key: " ", displayedText: " ", isSelected: false)
|
||
public var currentLayout: NSUserInterfaceLayoutOrientation = .horizontal
|
||
public private(set) var candidateDataAll: [CandidateCellData] = []
|
||
public private(set) var selectionKeys: String
|
||
public private(set) var highlightedIndex: Int = 0
|
||
|
||
// 下述變數只有橫排選字窗才會用到
|
||
private var currentRowNumber = 0
|
||
private var maxRowsPerPage = 3
|
||
private var maxRowCapacity: Int = 6
|
||
private var candidateRows: [[CandidateCellData]] = []
|
||
|
||
// 下述變數只有縱排選字窗才會用到
|
||
private var currentColumnNumber = 0
|
||
private var maxColumnsPerPage = 3
|
||
private var maxColumnCapacity: Int = 6
|
||
private var candidateColumns: [[CandidateCellData]] = []
|
||
|
||
// MARK: - 動態變數
|
||
|
||
public var maxRowWidth: Int { Int(ceil((Double(maxRowCapacity + 3) * 2 - 0.5) * CandidateCellData.unifiedSize)) }
|
||
public var maxWindowWidth: Double {
|
||
Double(maxRowCapacity) * (blankCell.minWidthToDrawInSwiftUI + ceil(CandidateCellData.unifiedSize * 0.5))
|
||
}
|
||
|
||
public var currentLineNumber: Int {
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
return currentRowNumber
|
||
case .vertical:
|
||
return currentColumnNumber
|
||
@unknown default:
|
||
return 0
|
||
}
|
||
}
|
||
|
||
public var candidateLines: [[CandidateCellData]] {
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
return candidateRows
|
||
case .vertical:
|
||
return candidateColumns
|
||
@unknown default:
|
||
return []
|
||
}
|
||
}
|
||
|
||
public var maxLineCapacity: Int {
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
return maxRowCapacity
|
||
case .vertical:
|
||
return maxColumnCapacity
|
||
@unknown default:
|
||
return 0
|
||
}
|
||
}
|
||
|
||
public var maxLinesPerPage: Int {
|
||
get {
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
return maxRowsPerPage
|
||
case .vertical:
|
||
return maxColumnsPerPage
|
||
@unknown default:
|
||
return 0
|
||
}
|
||
}
|
||
set {
|
||
switch currentLayout {
|
||
case .horizontal:
|
||
maxRowsPerPage = newValue
|
||
case .vertical:
|
||
maxColumnsPerPage = newValue
|
||
@unknown default:
|
||
return
|
||
}
|
||
}
|
||
}
|
||
|
||
public var rangeForLastPageBlanked: Range<Int> {
|
||
switch currentLayout {
|
||
case .horizontal: return rangeForLastHorizontalPageBlanked
|
||
case .vertical: return rangeForLastVerticalPageBlanked
|
||
@unknown default: return 0 ..< 0
|
||
}
|
||
}
|
||
|
||
public var rangeForCurrentPage: Range<Int> {
|
||
switch currentLayout {
|
||
case .horizontal: return rangeForCurrentHorizontalPage
|
||
case .vertical: return rangeForCurrentVerticalPage
|
||
@unknown default: return 0 ..< 0
|
||
}
|
||
}
|
||
|
||
// MARK: - Constructors
|
||
|
||
/// 初期化一個縱排候選字窗專用資料池。
|
||
/// - Parameters:
|
||
/// - candidates: 要塞入的候選字詞陣列。
|
||
/// - columnCapacity: (第一縱列的最大候選字詞數量, 陣列畫面展開之後的每一縱列的最大候選字詞數量)。
|
||
/// - selectionKeys: 選字鍵。
|
||
/// - locale: 區域編碼。例：「zh-Hans」或「zh-Hant」。
|
||
public init(
|
||
candidates: [String], columnCapacity: Int, columns: Int = 3, selectionKeys: String = "123456789",
|
||
locale: String = ""
|
||
) {
|
||
maxColumnsPerPage = max(1, columns)
|
||
maxColumnCapacity = max(1, columnCapacity)
|
||
self.selectionKeys = selectionKeys
|
||
candidateDataAll = candidates.map { .init(key: "0", displayedText: $0) }
|
||
var currentColumn: [CandidateCellData] = []
|
||
for (i, candidate) in candidateDataAll.enumerated() {
|
||
candidate.index = i
|
||
candidate.whichColumn = candidateColumns.count
|
||
if currentColumn.count == maxColumnCapacity, !currentColumn.isEmpty {
|
||
candidateColumns.append(currentColumn)
|
||
currentColumn.removeAll()
|
||
candidate.whichColumn += 1
|
||
}
|
||
candidate.subIndex = currentColumn.count
|
||
candidate.locale = locale
|
||
currentColumn.append(candidate)
|
||
}
|
||
candidateColumns.append(currentColumn)
|
||
currentLayout = .vertical
|
||
}
|
||
|
||
/// 初期化一個橫排候選字窗專用資料池。
|
||
/// - Parameters:
|
||
/// - candidates: 要塞入的候選字詞陣列。
|
||
/// - rowCapacity: (第一橫行的最大候選字詞數量, 陣列畫面展開之後的每一橫行的最大候選字詞數量)。
|
||
/// - selectionKeys: 選字鍵。
|
||
/// - locale: 區域編碼。例：「zh-Hans」或「zh-Hant」。
|
||
public init(
|
||
candidates: [String], rowCapacity: Int, rows: Int = 3, selectionKeys: String = "123456789", locale: String = ""
|
||
) {
|
||
maxRowsPerPage = max(1, rows)
|
||
maxRowCapacity = max(1, rowCapacity)
|
||
self.selectionKeys = selectionKeys
|
||
candidateDataAll = candidates.map { .init(key: "0", displayedText: $0) }
|
||
var currentRow: [CandidateCellData] = []
|
||
for (i, candidate) in candidateDataAll.enumerated() {
|
||
candidate.index = i
|
||
candidate.whichRow = candidateRows.count
|
||
let isOverflown: Bool = currentRow.map(\.cellLength).reduce(0, +) > maxRowWidth
|
||
if isOverflown || currentRow.count == maxRowCapacity, !currentRow.isEmpty {
|
||
candidateRows.append(currentRow)
|
||
currentRow.removeAll()
|
||
candidate.whichRow += 1
|
||
}
|
||
candidate.subIndex = currentRow.count
|
||
candidate.locale = locale
|
||
currentRow.append(candidate)
|
||
}
|
||
candidateRows.append(currentRow)
|
||
currentLayout = .horizontal
|
||
}
|
||
|
||
// MARK: Public Functions
|
||
|
||
public mutating func selectNewNeighborLine(isForward: Bool) {
|
||
switch currentLayout {
|
||
case .horizontal: selectNewNeighborRow(direction: isForward ? .down : .up)
|
||
case .vertical: selectNewNeighborColumn(direction: isForward ? .right : .left)
|
||
@unknown default: break
|
||
}
|
||
}
|
||
|
||
public mutating func highlight(at indexSpecified: Int) {
|
||
switch currentLayout {
|
||
case .horizontal: highlightHorizontal(at: indexSpecified)
|
||
case .vertical: highlightVertical(at: indexSpecified)
|
||
@unknown default: break
|
||
}
|
||
vCLog("\n" + candidateDataAll[highlightedIndex].charDescriptions)
|
||
}
|
||
}
|
||
|
||
// MARK: - Private Functions
|
||
|
||
extension CandidatePool {
|
||
private enum VerticalDirection {
|
||
case up
|
||
case down
|
||
}
|
||
|
||
private enum HorizontalDirection {
|
||
case left
|
||
case right
|
||
}
|
||
|
||
private var rangeForLastHorizontalPageBlanked: Range<Int> {
|
||
0 ..< (maxRowsPerPage - rangeForCurrentHorizontalPage.count)
|
||
}
|
||
|
||
private var rangeForLastVerticalPageBlanked: Range<Int> {
|
||
0 ..< (maxColumnsPerPage - rangeForCurrentVerticalPage.count)
|
||
}
|
||
|
||
private var rangeForCurrentHorizontalPage: Range<Int> {
|
||
currentRowNumber ..< min(candidateRows.count, currentRowNumber + maxRowsPerPage)
|
||
}
|
||
|
||
private var rangeForCurrentVerticalPage: Range<Int> {
|
||
currentColumnNumber ..< min(candidateColumns.count, currentColumnNumber + maxColumnsPerPage)
|
||
}
|
||
|
||
private mutating func selectNewNeighborRow(direction: VerticalDirection) {
|
||
let currentSubIndex = candidateDataAll[highlightedIndex].subIndex
|
||
var result = currentSubIndex
|
||
switch direction {
|
||
case .up:
|
||
if currentRowNumber <= 0 {
|
||
if candidateRows.isEmpty { break }
|
||
let firstRow = candidateRows[0]
|
||
let newSubIndex = min(currentSubIndex, firstRow.count - 1)
|
||
highlightHorizontal(at: firstRow[newSubIndex].index)
|
||
break
|
||
}
|
||
if currentRowNumber >= candidateRows.count - 1 { currentRowNumber = candidateRows.count - 1 }
|
||
if candidateRows[currentRowNumber].count != candidateRows[currentRowNumber - 1].count {
|
||
let ratio: Double = min(1, Double(currentSubIndex) / Double(candidateRows[currentRowNumber].count))
|
||
result = Int(floor(Double(candidateRows[currentRowNumber - 1].count) * ratio))
|
||
}
|
||
let targetRow = candidateRows[currentRowNumber - 1]
|
||
let newSubIndex = min(result, targetRow.count - 1)
|
||
highlightHorizontal(at: targetRow[newSubIndex].index)
|
||
case .down:
|
||
if currentRowNumber >= candidateRows.count - 1 {
|
||
if candidateRows.isEmpty { break }
|
||
let finalRow = candidateRows[candidateRows.count - 1]
|
||
let newSubIndex = min(currentSubIndex, finalRow.count - 1)
|
||
highlightHorizontal(at: finalRow[newSubIndex].index)
|
||
break
|
||
}
|
||
if candidateRows[currentRowNumber].count != candidateRows[currentRowNumber + 1].count {
|
||
let ratio: Double = min(1, Double(currentSubIndex) / Double(candidateRows[currentRowNumber].count))
|
||
result = Int(floor(Double(candidateRows[currentRowNumber + 1].count) * ratio))
|
||
}
|
||
let targetRow = candidateRows[currentRowNumber + 1]
|
||
let newSubIndex = min(result, targetRow.count - 1)
|
||
highlightHorizontal(at: targetRow[newSubIndex].index)
|
||
}
|
||
}
|
||
|
||
private mutating func selectNewNeighborColumn(direction: HorizontalDirection) {
|
||
let currentSubIndex = candidateDataAll[highlightedIndex].subIndex
|
||
switch direction {
|
||
case .left:
|
||
if currentColumnNumber <= 0 {
|
||
if candidateColumns.isEmpty { break }
|
||
let firstColumn = candidateColumns[0]
|
||
let newSubIndex = min(currentSubIndex, firstColumn.count - 1)
|
||
highlightVertical(at: firstColumn[newSubIndex].index)
|
||
break
|
||
}
|
||
if currentColumnNumber >= candidateColumns.count - 1 { currentColumnNumber = candidateColumns.count - 1 }
|
||
let targetColumn = candidateColumns[currentColumnNumber - 1]
|
||
let newSubIndex = min(currentSubIndex, targetColumn.count - 1)
|
||
highlightVertical(at: targetColumn[newSubIndex].index)
|
||
case .right:
|
||
if currentColumnNumber >= candidateColumns.count - 1 {
|
||
if candidateColumns.isEmpty { break }
|
||
let finalColumn = candidateColumns[candidateColumns.count - 1]
|
||
let newSubIndex = min(currentSubIndex, finalColumn.count - 1)
|
||
highlightVertical(at: finalColumn[newSubIndex].index)
|
||
break
|
||
}
|
||
let targetColumn = candidateColumns[currentColumnNumber + 1]
|
||
let newSubIndex = min(currentSubIndex, targetColumn.count - 1)
|
||
highlightVertical(at: targetColumn[newSubIndex].index)
|
||
}
|
||
}
|
||
|
||
private mutating func highlightHorizontal(at indexSpecified: Int) {
|
||
var indexSpecified = indexSpecified
|
||
highlightedIndex = indexSpecified
|
||
if !(0 ..< candidateDataAll.count).contains(highlightedIndex) {
|
||
switch highlightedIndex {
|
||
case candidateDataAll.count...:
|
||
currentRowNumber = candidateRows.count - 1
|
||
highlightedIndex = max(0, candidateDataAll.count - 1)
|
||
indexSpecified = highlightedIndex
|
||
case ..<0:
|
||
highlightedIndex = 0
|
||
currentRowNumber = 0
|
||
indexSpecified = highlightedIndex
|
||
default: break
|
||
}
|
||
}
|
||
for (i, candidate) in candidateDataAll.enumerated() {
|
||
candidate.isSelected = (indexSpecified == i)
|
||
if candidate.isSelected { currentRowNumber = candidate.whichRow }
|
||
}
|
||
for (i, candidateRow) in candidateRows.enumerated() {
|
||
if i != currentRowNumber {
|
||
candidateRow.forEach {
|
||
$0.key = " "
|
||
}
|
||
} else {
|
||
for (i, neta) in candidateRow.enumerated() {
|
||
neta.key = selectionKeys.map { String($0) }[i]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
private mutating func highlightVertical(at indexSpecified: Int) {
|
||
var indexSpecified = indexSpecified
|
||
highlightedIndex = indexSpecified
|
||
if !(0 ..< candidateDataAll.count).contains(highlightedIndex) {
|
||
switch highlightedIndex {
|
||
case candidateDataAll.count...:
|
||
currentColumnNumber = candidateColumns.count - 1
|
||
highlightedIndex = max(0, candidateDataAll.count - 1)
|
||
indexSpecified = highlightedIndex
|
||
case ..<0:
|
||
highlightedIndex = 0
|
||
currentColumnNumber = 0
|
||
indexSpecified = highlightedIndex
|
||
default: break
|
||
}
|
||
}
|
||
for (i, candidate) in candidateDataAll.enumerated() {
|
||
candidate.isSelected = (indexSpecified == i)
|
||
if candidate.isSelected { currentColumnNumber = candidate.whichColumn }
|
||
}
|
||
for (i, candidateColumn) in candidateColumns.enumerated() {
|
||
if i != currentColumnNumber {
|
||
candidateColumn.forEach {
|
||
$0.key = " "
|
||
}
|
||
} else {
|
||
for (i, neta) in candidateColumn.enumerated() {
|
||
if neta.key.isEmpty { continue }
|
||
neta.key = selectionKeys.map { String($0) }[i]
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|