-
-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathDataGridView.swift
More file actions
580 lines (505 loc) · 24.7 KB
/
DataGridView.swift
File metadata and controls
580 lines (505 loc) · 24.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
//
// DataGridView.swift
// TablePro
//
// High-performance NSTableView wrapper for SwiftUI.
// Custom views extracted to separate files for maintainability.
//
import AppKit
import SwiftUI
struct CellPosition: Hashable {
let row: Int
let column: Int
}
struct RowVisualState {
let isDeleted: Bool
let isInserted: Bool
let modifiedColumns: Set<Int>
static let empty = RowVisualState(isDeleted: false, isInserted: false, modifiedColumns: [])
}
struct DataGridView: NSViewRepresentable {
var tableRowsProvider: @MainActor () -> TableRows = { TableRows() }
var tableRowsMutator: @MainActor (@MainActor (inout TableRows) -> Void) -> Void = { _ in }
var changeManager: AnyChangeManager
let isEditable: Bool
var configuration: DataGridConfiguration = .init()
var sortedIDs: [RowID]?
var displayFormats: [ValueDisplayFormat?] = []
var delegate: (any DataGridViewDelegate)?
@Binding var selectedRowIndices: Set<Int>
@Binding var sortState: SortState
@Binding var columnLayout: ColumnLayoutState
// MARK: - NSViewRepresentable
func makeNSView(context: Context) -> NSScrollView {
let scrollView = NSScrollView()
scrollView.hasVerticalScroller = true
scrollView.hasHorizontalScroller = true
scrollView.autohidesScrollers = true
scrollView.borderType = .noBorder
let tableView = KeyHandlingTableView()
tableView.coordinator = context.coordinator
tableView.style = .plain
tableView.setAccessibilityLabel(String(localized: "Data grid"))
tableView.setAccessibilityRole(.table)
let settings = AppSettingsManager.shared.dataGrid
tableView.usesAlternatingRowBackgroundColors = settings.showAlternateRows
tableView.allowsMultipleSelection = true
tableView.allowsColumnReordering = true
tableView.allowsColumnResizing = true
tableView.columnAutoresizingStyle = .noColumnAutoresizing
tableView.gridStyleMask = [.solidVerticalGridLineMask]
tableView.intercellSpacing = NSSize(width: 1, height: 0)
tableView.rowHeight = CGFloat(settings.rowHeight.rawValue)
tableView.delegate = context.coordinator
tableView.dataSource = context.coordinator
tableView.target = context.coordinator
tableView.action = #selector(TableViewCoordinator.handleClick(_:))
tableView.doubleAction = #selector(TableViewCoordinator.handleDoubleClick(_:))
let rowNumberColumn = NSTableColumn(identifier: NSUserInterfaceItemIdentifier("__rowNumber__"))
rowNumberColumn.title = "#"
rowNumberColumn.width = 40
rowNumberColumn.minWidth = 40
rowNumberColumn.maxWidth = 60
rowNumberColumn.isEditable = false
rowNumberColumn.resizingMask = []
rowNumberColumn.headerCell.setAccessibilityLabel(String(localized: "Row number"))
tableView.addTableColumn(rowNumberColumn)
rowNumberColumn.isHidden = !configuration.showRowNumbers
let initialRows = tableRowsProvider()
context.coordinator.isRebuildingColumns = true
for (index, columnName) in initialRows.columns.enumerated() {
let column = NSTableColumn(identifier: Self.columnIdentifier(for: index))
column.title = columnName
if index < initialRows.columnTypes.count {
let typeName = initialRows.columnTypes[index].rawType ?? initialRows.columnTypes[index].displayName
column.headerToolTip = "\(columnName) (\(typeName))"
}
column.headerCell.setAccessibilityLabel(
String(format: String(localized: "Column: %@"), columnName)
)
column.width = context.coordinator.cellFactory.calculateOptimalColumnWidth(
for: columnName,
columnIndex: index,
tableRows: initialRows
)
column.minWidth = 30
column.resizingMask = .userResizingMask
column.isEditable = isEditable
column.sortDescriptorPrototype = NSSortDescriptor(
key: Self.columnIdentifier(for: index).rawValue,
ascending: true
)
tableView.addTableColumn(column)
}
if !columnLayout.columnWidths.isEmpty {
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < initialRows.columns.count else { continue }
let baseName = initialRows.columns[colIndex]
if let savedWidth = columnLayout.columnWidths[baseName] {
column.width = savedWidth
}
}
context.coordinator.hasUserResizedColumns = true
}
if let savedOrder = columnLayout.columnOrder {
DataGridView.applyColumnOrder(savedOrder, to: tableView, columns: initialRows.columns)
}
context.coordinator.isRebuildingColumns = false
applyColumnVisibility(to: tableView, columns: initialRows.columns)
if let headerView = tableView.headerView {
let headerMenu = NSMenu()
headerMenu.delegate = context.coordinator
headerView.menu = headerMenu
}
let hasMoveRow = delegate != nil
if hasMoveRow {
tableView.registerForDraggedTypes([NSPasteboard.PasteboardType("com.TablePro.rowDrag")])
tableView.draggingDestinationFeedbackStyle = .gap
}
scrollView.documentView = tableView
context.coordinator.tableView = tableView
context.coordinator.tableRowsController.attach(tableView)
context.coordinator.tableRowsProvider = tableRowsProvider
context.coordinator.tableRowsMutator = tableRowsMutator
context.coordinator.sortedIDs = sortedIDs
context.coordinator.syncDisplayFormats(displayFormats)
context.coordinator.delegate = delegate
delegate?.dataGridAttach(tableViewCoordinator: context.coordinator)
context.coordinator.dropdownColumns = configuration.dropdownColumns
context.coordinator.typePickerColumns = configuration.typePickerColumns
context.coordinator.customDropdownOptions = configuration.customDropdownOptions
context.coordinator.connectionId = configuration.connectionId
context.coordinator.databaseType = configuration.databaseType
context.coordinator.tableName = configuration.tableName
context.coordinator.primaryKeyColumns = configuration.primaryKeyColumns
context.coordinator.tabType = configuration.tabType
context.coordinator.rebuildColumnMetadataCache(from: tableRowsProvider())
if let connectionId = configuration.connectionId {
context.coordinator.observeTeardown(connectionId: connectionId)
}
return scrollView
}
func updateNSView(_ scrollView: NSScrollView, context: Context) {
guard let tableView = scrollView.documentView as? NSTableView else { return }
let coordinator = context.coordinator
if tableView.editedRow >= 0 { return }
if let editor = context.coordinator.overlayEditor, editor.isActive { return }
if let rowNumCol = tableView.tableColumns.first(where: { $0.identifier.rawValue == "__rowNumber__" }) {
let shouldHide = !configuration.showRowNumbers
if rowNumCol.isHidden != shouldHide {
rowNumCol.isHidden = shouldHide
}
}
let rowDragType = NSPasteboard.PasteboardType("com.TablePro.rowDrag")
let hasDragRegistered = tableView.registeredDraggedTypes.contains(rowDragType)
let hasMoveRow = delegate != nil
if hasMoveRow && !hasDragRegistered {
tableView.registerForDraggedTypes([rowDragType])
tableView.draggingDestinationFeedbackStyle = .gap
} else if !hasMoveRow && hasDragRegistered {
let remaining = tableView.registeredDraggedTypes.filter { $0 != rowDragType }
tableView.unregisterDraggedTypes()
if !remaining.isEmpty {
tableView.registerForDraggedTypes(remaining)
}
}
if let connectionId = configuration.connectionId, coordinator.teardownObserver == nil {
coordinator.observeTeardown(connectionId: connectionId)
}
let latestRows = tableRowsProvider()
let rowDisplayCount = sortedIDs?.count ?? latestRows.count
let columnCount = latestRows.columns.count
let settings = AppSettingsManager.shared.dataGrid
if tableView.rowHeight != CGFloat(settings.rowHeight.rawValue) {
tableView.rowHeight = CGFloat(settings.rowHeight.rawValue)
}
if tableView.usesAlternatingRowBackgroundColors != settings.showAlternateRows {
tableView.usesAlternatingRowBackgroundColors = settings.showAlternateRows
}
let oldRowCount = coordinator.cachedRowCount
let oldColumnCount = coordinator.cachedColumnCount
let structureChanged = oldRowCount != rowDisplayCount || oldColumnCount != columnCount
let needsFullReload = structureChanged
coordinator.updateCache()
coordinator.rebuildColumnMetadataCache(from: latestRows)
if oldRowCount == 0, rowDisplayCount > 0 {
let rowH = tableView.rowHeight
if rowH > 0 {
let visibleRows = Int(tableView.visibleRect.height / rowH) + 5
coordinator.preWarmDisplayCache(upTo: visibleRows)
}
}
coordinator.changeManager = changeManager
coordinator.isEditable = isEditable
coordinator.tableRowsProvider = tableRowsProvider
coordinator.tableRowsMutator = tableRowsMutator
coordinator.sortedIDs = sortedIDs
coordinator.syncDisplayFormats(displayFormats)
coordinator.delegate = delegate
delegate?.dataGridAttach(tableViewCoordinator: coordinator)
coordinator.dropdownColumns = configuration.dropdownColumns
coordinator.typePickerColumns = configuration.typePickerColumns
coordinator.customDropdownOptions = configuration.customDropdownOptions
coordinator.connectionId = configuration.connectionId
coordinator.databaseType = configuration.databaseType
coordinator.tableName = configuration.tableName
coordinator.primaryKeyColumns = configuration.primaryKeyColumns
coordinator.tabType = configuration.tabType
coordinator.rebuildVisualStateCache()
let currentDataColumns = tableView.tableColumns.dropFirst()
let currentColumnIds = currentDataColumns.map { $0.identifier.rawValue }
let expectedColumnIds = latestRows.columns.indices.map { Self.columnIdentifier(for: $0).rawValue }
let columnsChanged = !latestRows.columns.isEmpty && (currentColumnIds != expectedColumnIds)
let isInitialDataLoad = structureChanged && oldRowCount == 0 && !latestRows.columns.isEmpty
let shouldRebuildColumns = columnsChanged || isInitialDataLoad
updateColumns(
tableView: tableView,
coordinator: coordinator,
tableRows: latestRows,
columnsChanged: columnsChanged,
shouldRebuild: shouldRebuildColumns,
structureChanged: structureChanged
)
applyColumnVisibility(to: tableView, columns: latestRows.columns)
syncSortDescriptors(tableView: tableView, coordinator: coordinator, columns: latestRows.columns)
reloadAndSyncSelection(
tableView: tableView,
coordinator: coordinator,
needsFullReload: needsFullReload
)
}
// MARK: - updateNSView Helpers
private func updateColumns(
tableView: NSTableView,
coordinator: TableViewCoordinator,
tableRows: TableRows,
columnsChanged: Bool,
shouldRebuild: Bool,
structureChanged: Bool
) {
if shouldRebuild {
coordinator.isRebuildingColumns = true
defer { coordinator.isRebuildingColumns = false }
if columnsChanged {
let columnsToRemove = tableView.tableColumns.filter { $0.identifier.rawValue != "__rowNumber__" }
for column in columnsToRemove {
tableView.removeTableColumn(column)
}
let willRestoreWidths = !columnLayout.columnWidths.isEmpty
for (index, columnName) in tableRows.columns.enumerated() {
let column = NSTableColumn(identifier: Self.columnIdentifier(for: index))
column.title = columnName
if index < tableRows.columnTypes.count {
let typeName = tableRows.columnTypes[index].rawType
?? tableRows.columnTypes[index].displayName
column.headerToolTip = "\(columnName) (\(typeName))"
}
column.headerCell.setAccessibilityLabel(
String(format: String(localized: "Column: %@"), columnName)
)
if willRestoreWidths {
column.width = columnLayout.columnWidths[columnName] ?? 100
} else {
column.width = coordinator.cellFactory.calculateOptimalColumnWidth(
for: columnName,
columnIndex: index,
tableRows: tableRows
)
}
column.minWidth = 30
column.resizingMask = .userResizingMask
column.isEditable = isEditable
column.sortDescriptorPrototype = NSSortDescriptor(
key: Self.columnIdentifier(for: index).rawValue,
ascending: true
)
tableView.addTableColumn(column)
}
} else {
let hasSavedWidths = !columnLayout.columnWidths.isEmpty
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < tableRows.columns.count else { continue }
let columnName = tableRows.columns[colIndex]
column.title = columnName
if colIndex < tableRows.columnTypes.count {
let typeName = tableRows.columnTypes[colIndex].rawType
?? tableRows.columnTypes[colIndex].displayName
column.headerToolTip = "\(columnName) (\(typeName))"
}
if !hasSavedWidths {
column.width = coordinator.cellFactory.calculateOptimalColumnWidth(
for: columnName,
columnIndex: colIndex,
tableRows: tableRows
)
}
column.isEditable = isEditable
}
}
let hasSavedLayout = !columnLayout.columnWidths.isEmpty
if hasSavedLayout {
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < tableRows.columns.count else { continue }
let baseName = tableRows.columns[colIndex]
if let savedWidth = columnLayout.columnWidths[baseName] {
column.width = savedWidth
}
}
coordinator.hasUserResizedColumns = true
}
if let savedOrder = columnLayout.columnOrder {
DataGridView.applyColumnOrder(savedOrder, to: tableView, columns: tableRows.columns)
coordinator.hasUserResizedColumns = true
}
if !coordinator.hasUserResizedColumns, !hasSavedLayout {
var newWidths: [String: CGFloat] = [:]
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < tableRows.columns.count else { continue }
newWidths[tableRows.columns[colIndex]] = column.width
}
if !newWidths.isEmpty && newWidths != columnLayout.columnWidths {
coordinator.isWritingColumnLayout = true
Task { @MainActor in
coordinator.isWritingColumnLayout = false
self.columnLayout.columnWidths = newWidths
}
}
}
} else {
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
column.isEditable = isEditable
}
guard !coordinator.isWritingColumnLayout else { return }
if coordinator.hasUserResizedColumns, tableView.tableColumns.count > 1 {
var currentWidths: [String: CGFloat] = [:]
var currentOrder: [String] = []
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < tableRows.columns.count else { continue }
let baseName = tableRows.columns[colIndex]
currentWidths[baseName] = column.width
currentOrder.append(baseName)
}
let widthsChanged = !currentWidths.isEmpty && currentWidths != columnLayout.columnWidths
let orderChanged = !currentOrder.isEmpty && columnLayout.columnOrder != currentOrder
if widthsChanged || orderChanged {
coordinator.isWritingColumnLayout = true
Task { @MainActor in
coordinator.isWritingColumnLayout = false
if widthsChanged {
self.columnLayout.columnWidths = currentWidths
}
if orderChanged {
self.columnLayout.columnOrder = currentOrder
}
}
}
coordinator.hasUserResizedColumns = false
}
}
}
private func syncSortDescriptors(tableView: NSTableView, coordinator: TableViewCoordinator, columns: [String]) {
coordinator.isSyncingSortDescriptors = true
defer { coordinator.isSyncingSortDescriptors = false }
if !sortState.isSorting {
if !tableView.sortDescriptors.isEmpty {
tableView.sortDescriptors = []
}
} else if let firstSort = sortState.columns.first,
firstSort.columnIndex >= 0 && firstSort.columnIndex < columns.count {
let key = Self.columnIdentifier(for: firstSort.columnIndex).rawValue
let ascending = firstSort.direction == .ascending
let currentDescriptor = tableView.sortDescriptors.first
if currentDescriptor?.key != key || currentDescriptor?.ascending != ascending {
tableView.sortDescriptors = [NSSortDescriptor(key: key, ascending: ascending)]
}
}
Self.updateSortIndicators(tableView: tableView, sortState: sortState, columns: columns)
}
private func reloadAndSyncSelection(
tableView: NSTableView,
coordinator: TableViewCoordinator,
needsFullReload: Bool
) {
if needsFullReload {
tableView.reloadData()
}
let currentSelection = tableView.selectedRowIndexes
let targetSelection = IndexSet(selectedRowIndices)
if currentSelection != targetSelection {
coordinator.isSyncingSelection = true
tableView.selectRowIndexes(targetSelection, byExtendingSelection: false)
coordinator.isSyncingSelection = false
}
}
// MARK: - Column Visibility
private func applyColumnVisibility(to tableView: NSTableView, columns: [String]) {
for column in tableView.tableColumns where column.identifier.rawValue != "__rowNumber__" {
guard let colIndex = Self.dataColumnIndex(from: column.identifier),
colIndex < columns.count else { continue }
let columnName = columns[colIndex]
let shouldHide = configuration.hiddenColumns.contains(columnName)
if column.isHidden != shouldHide {
column.isHidden = shouldHide
}
}
}
// MARK: - Column Layout Helpers
static func columnIdentifier(for dataIndex: Int) -> NSUserInterfaceItemIdentifier {
NSUserInterfaceItemIdentifier("col_\(dataIndex)")
}
static func tableColumnIndex(for dataIndex: Int) -> Int {
dataIndex + 1
}
static func dataColumnIndex(for tableColumnIndex: Int) -> Int {
tableColumnIndex - 1
}
static func dataColumnIndex(from identifier: NSUserInterfaceItemIdentifier) -> Int? {
let raw = identifier.rawValue
guard raw.hasPrefix("col_") else { return nil }
return Int(raw.dropFirst(4))
}
private static func applyColumnOrder(_ order: [String], to tableView: NSTableView, columns: [String]) {
guard Set(order) == Set(columns) else { return }
let dataColumns = tableView.tableColumns.filter { $0.identifier.rawValue != "__rowNumber__" }
var columnMap: [String: NSTableColumn] = [:]
for col in dataColumns {
if let idx = dataColumnIndex(from: col.identifier), idx < columns.count {
columnMap[columns[idx]] = col
}
}
for (targetIndex, columnName) in order.enumerated() {
guard let sourceColumn = columnMap[columnName],
let currentIndex = tableView.tableColumns.firstIndex(of: sourceColumn) else { continue }
let targetTableIndex = tableColumnIndex(for: targetIndex)
if currentIndex != targetTableIndex && targetTableIndex < tableView.numberOfColumns {
tableView.moveColumn(currentIndex, toColumn: targetTableIndex)
}
}
}
// MARK: - Sort Indicator Helpers
private static func updateSortIndicators(tableView: NSTableView, sortState: SortState, columns: [String]) {
for column in tableView.tableColumns {
guard let colIndex = dataColumnIndex(from: column.identifier),
colIndex < columns.count else { continue }
let baseName = columns[colIndex]
if let sortIndex = sortState.columns.firstIndex(where: { $0.columnIndex == colIndex }) {
let sortCol = sortState.columns[sortIndex]
if sortState.columns.count > 1 {
let indicator = " \(sortIndex + 1)\(sortCol.direction.indicator)"
column.title = "\(baseName)\(indicator)"
} else {
column.title = baseName
}
} else {
column.title = baseName
}
}
}
static func dismantleNSView(_ nsView: NSScrollView, coordinator: TableViewCoordinator) {
coordinator.overlayEditor?.dismiss(commit: false)
coordinator.persistColumnLayoutToStorage()
if let observer = coordinator.settingsObserver {
NotificationCenter.default.removeObserver(observer)
coordinator.settingsObserver = nil
}
if let observer = coordinator.themeObserver {
NotificationCenter.default.removeObserver(observer)
coordinator.themeObserver = nil
}
coordinator.tableRowsController.detach()
}
func makeCoordinator() -> TableViewCoordinator {
TableViewCoordinator(
changeManager: changeManager,
isEditable: isEditable,
selectedRowIndices: $selectedRowIndices,
delegate: delegate
)
}
}
// MARK: - Preview
private let previewTableRowsForDataGrid = TableRows.from(
queryRows: [
["1", "John", "john@example.com"],
["2", "Jane", nil],
["3", "Bob", "bob@example.com"],
],
columns: ["id", "name", "email"],
columnTypes: Array(repeating: ColumnType.text(rawType: nil), count: 3)
)
#Preview {
DataGridView(
tableRowsProvider: { previewTableRowsForDataGrid },
changeManager: AnyChangeManager(DataChangeManager()),
isEditable: true,
selectedRowIndices: .constant([]),
sortState: .constant(SortState()),
columnLayout: .constant(ColumnLayoutState())
)
.frame(width: 600, height: 400)
}