Skip to content

Commit 81fe0d3

Browse files
thecoolwinterthecoolwinter
committed
Split Warning Characters From Config, Add Tests
1 parent b36b9bd commit 81fe0d3

File tree

5 files changed

+155
-43
lines changed

5 files changed

+155
-43
lines changed

‎Sources/CodeEditSourceEditor/CodeEditSourceEditor/CodeEditSourceEditor.swift‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,14 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
5050
/// - useSystemCursor: If true, uses the system cursor on `>=macOS 14`.
5151
/// - undoManager: The undo manager for the text view. Defaults to `nil`, which will create a new CEUndoManager
5252
/// - coordinators: Any text coordinators for the view to use. See ``TextViewCoordinator`` for more information.
53-
/// - showMinimap: Whether to show the minimap
54-
/// - reformatAtColumn: The column to reformat at
55-
/// - showReformattingGuide: Whether to show the reformatting guide
53+
/// - showMinimap: Whether to show the minimap.
54+
/// - reformatAtColumn: The column to reformat at.
55+
/// - showReformattingGuide: Whether to show the reformatting guide.
5656
/// - invisibleCharactersConfig: Configuration for displaying invisible characters. Defaults to an empty object.
57+
/// See ``TextViewController/invisibleCharactersConfig`` and
58+
/// ``InvisibleCharactersConfig`` for more information.
59+
/// - warningCharacters: A set of characters the editor should draw with a small red border. See
60+
/// ``TextViewController/warningCharacters`` for more information.
5761
public init(
5862
_ text: Binding<String>,
5963
language: CodeLanguage,
@@ -79,7 +83,8 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
7983
showMinimap: Bool,
8084
reformatAtColumn: Int,
8185
showReformattingGuide: Bool,
82-
invisibleCharactersConfig: InvisibleCharactersConfig = .empty
86+
invisibleCharactersConfig: InvisibleCharactersConfig = .empty,
87+
warningCharacters: Set<UInt16> = []
8388
) {
8489
self.text = .binding(text)
8590
self.language = language
@@ -110,6 +115,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
110115
self.reformatAtColumn = reformatAtColumn
111116
self.showReformattingGuide = showReformattingGuide
112117
self.invisibleCharactersConfig = invisibleCharactersConfig
118+
self.warningCharacters = warningCharacters
113119
}
114120

115121
/// Initializes a Text Editor
@@ -139,10 +145,14 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
139145
/// See `BracketPairEmphasis` for more information. Defaults to `nil`
140146
/// - undoManager: The undo manager for the text view. Defaults to `nil`, which will create a new CEUndoManager
141147
/// - coordinators: Any text coordinators for the view to use. See ``TextViewCoordinator`` for more information.
142-
/// - showMinimap: Whether to show the minimap
143-
/// - reformatAtColumn: The column to reformat at
144-
/// - showReformattingGuide: Whether to show the reformatting guide
148+
/// - showMinimap: Whether to show the minimap.
149+
/// - reformatAtColumn: The column to reformat at.
150+
/// - showReformattingGuide: Whether to show the reformatting guide.
145151
/// - invisibleCharactersConfig: Configuration for displaying invisible characters. Defaults to an empty object.
152+
/// See ``TextViewController/invisibleCharactersConfig`` and
153+
/// ``InvisibleCharactersConfig`` for more information.
154+
/// - warningCharacters: A set of characters the editor should draw with a small red border. See
155+
/// ``TextViewController/warningCharacters`` for more information.
146156
public init(
147157
_ text: NSTextStorage,
148158
language: CodeLanguage,
@@ -168,7 +178,8 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
168178
showMinimap: Bool,
169179
reformatAtColumn: Int,
170180
showReformattingGuide: Bool,
171-
invisibleCharactersConfig: InvisibleCharactersConfig = .empty
181+
invisibleCharactersConfig: InvisibleCharactersConfig = .empty,
182+
warningCharacters: Set<UInt16> = []
172183
) {
173184
self.text = .storage(text)
174185
self.language = language
@@ -199,6 +210,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
199210
self.reformatAtColumn = reformatAtColumn
200211
self.showReformattingGuide = showReformattingGuide
201212
self.invisibleCharactersConfig = invisibleCharactersConfig
213+
self.warningCharacters = warningCharacters
202214
}
203215

204216
package var text: TextAPI
@@ -226,6 +238,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
226238
private var reformatAtColumn: Int
227239
private var showReformattingGuide: Bool
228240
private var invisibleCharactersConfig: InvisibleCharactersConfig
241+
private var warningCharacters: Set<UInt16>
229242

230243
public typealias NSViewControllerType = TextViewController
231244

@@ -364,6 +377,10 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
364377
if controller.invisibleCharactersConfig != invisibleCharactersConfig {
365378
controller.invisibleCharactersConfig = invisibleCharactersConfig
366379
}
380+
381+
if controller.warningCharacters != warningCharacters {
382+
controller.warningCharacters = warningCharacters
383+
}
367384
}
368385

369386
private func updateThemeAndLanguage(_ controller: TextViewController) {
@@ -410,6 +427,7 @@ public struct CodeEditSourceEditor: NSViewControllerRepresentable {
410427
controller.reformatAtColumn == reformatAtColumn &&
411428
controller.showReformattingGuide == showReformattingGuide &&
412429
controller.invisibleCharactersConfig == invisibleCharactersConfig &&
430+
controller.warningCharacters == warningCharacters &&
413431
areHighlightProvidersEqual(controller: controller, coordinator: coordinator)
414432
}
415433

‎Sources/CodeEditSourceEditor/Controller/TextViewController.swift‎

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,15 @@ public class TextViewController: NSViewController { // swiftlint:disable:this ty
2727
var gutterView: GutterView!
2828
var minimapView: MinimapView!
2929

30+
/// The reformatting guide view
31+
var guideView: ReformattingGuideView! {
32+
didSet {
33+
if let oldValue = oldValue {
34+
oldValue.removeFromSuperview()
35+
}
36+
}
37+
}
38+
3039
var minimapXConstraint: NSLayoutConstraint?
3140

3241
var _undoManager: CEUndoManager!
@@ -263,19 +272,10 @@ public class TextViewController: NSViewController { // swiftlint:disable:this ty
263272
}
264273
}
265274

266-
/// The reformatting guide view
267-
var guideView: ReformattingGuideView! {
268-
didSet {
269-
if let oldValue = oldValue {
270-
oldValue.removeFromSuperview()
271-
}
272-
}
273-
}
274-
275275
/// Configuration for drawing invisible characters.
276276
///
277277
/// See ``InvisibleCharactersConfig`` for more details.
278-
var invisibleCharactersConfig: InvisibleCharactersConfig {
278+
public var invisibleCharactersConfig: InvisibleCharactersConfig {
279279
get {
280280
invisibleCharactersCoordinator.config
281281
}
@@ -284,6 +284,19 @@ public class TextViewController: NSViewController { // swiftlint:disable:this ty
284284
}
285285
}
286286

287+
/// A set of characters the editor should draw with a small red border.
288+
///
289+
/// Indicates characters that the user may not have meant to insert, such as a zero-width space: `(0x200D)` or a
290+
/// non-standard quote character: `“ (0x201C)`.
291+
public var warningCharacters: Set<UInt16> {
292+
get {
293+
invisibleCharactersCoordinator.warningCharacters
294+
}
295+
set {
296+
invisibleCharactersCoordinator.warningCharacters = newValue
297+
}
298+
}
299+
287300
// MARK: Init
288301

289302
// Disabling function body length warning for now. There's an open issue for combining a lot of these parameters
@@ -314,7 +327,8 @@ public class TextViewController: NSViewController { // swiftlint:disable:this ty
314327
showMinimap: Bool,
315328
reformatAtColumn: Int = 80,
316329
showReformattingGuide: Bool = false,
317-
invisibleCharactersConfig: InvisibleCharactersConfig = .empty
330+
invisibleCharactersConfig: InvisibleCharactersConfig = .empty,
331+
warningCharacters: Set<UInt16> = []
318332
) {
319333
self.language = language
320334
self.font = font
@@ -339,6 +353,7 @@ public class TextViewController: NSViewController { // swiftlint:disable:this ty
339353
self.showReformattingGuide = showReformattingGuide
340354
self.invisibleCharactersCoordinator = InvisibleCharactersCoordinator(
341355
config: invisibleCharactersConfig,
356+
warningCharacters: warningCharacters,
342357
indentOption: indentOption,
343358
theme: theme,
344359
font: font

‎Sources/CodeEditSourceEditor/InvisibleCharacters/InvisibleCharactersConfig.swift‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable {
1313
/// An empty configuration.
1414
public static var empty: InvisibleCharactersConfig {
15-
InvisibleCharactersConfig(showSpaces: false, showTabs: false, showLineEndings: false, warningCharacters: [])
15+
InvisibleCharactersConfig(showSpaces: false, showTabs: false, showLineEndings: false)
1616
}
1717

1818
/// Set to true to draw spaces with a dot.
@@ -37,22 +37,10 @@ public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable
3737
/// Replacement when drawing the line separator character, enabled by ``showLineEndings``.
3838
public var lineSeparatorReplacement: String = "⏎"
3939

40-
/// A set of characters the editor should draw with a small red border.
41-
///
42-
/// Indicates characters that the user may not have meant to insert, such as a zero-width space: `(0x200D)` or a
43-
/// non-standard quote character: `“ (0x201C)`.
44-
public var warningCharacters: Set<UInt16>
45-
46-
public init(
47-
showSpaces: Bool,
48-
showTabs: Bool,
49-
showLineEndings: Bool,
50-
warningCharacters: Set<UInt16>
51-
) {
40+
public init(showSpaces: Bool, showTabs: Bool, showLineEndings: Bool) {
5241
self.showSpaces = showSpaces
5342
self.showTabs = showTabs
5443
self.showLineEndings = showLineEndings
55-
self.warningCharacters = warningCharacters
5644
}
5745

5846
/// Determines what characters should trigger a custom drawing action.
@@ -74,8 +62,6 @@ public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable
7462
set.insert(Symbols.lineSeparator)
7563
}
7664

77-
set.formUnion(warningCharacters)
78-
7965
return set
8066
}
8167

‎Sources/CodeEditSourceEditor/InvisibleCharacters/InvisibleCharactersCoordinator.swift‎

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,19 @@ import CodeEditTextView
2121
final class InvisibleCharactersCoordinator: InvisibleCharactersDelegate {
2222
var config: InvisibleCharactersConfig {
2323
didSet {
24-
triggerCharacters = config.triggerCharacters()
24+
updateTriggerCharacters()
2525
}
2626
}
27+
/// A set of characters the editor should draw with a small red border.
28+
///
29+
/// Indicates characters that the user may not have meant to insert, such as a zero-width space: `(0x200D)` or a
30+
/// non-standard quote character: `“ (0x201C)`.
31+
public var warningCharacters: Set<UInt16> {
32+
didSet {
33+
updateTriggerCharacters()
34+
}
35+
}
36+
2737
var indentOption: IndentOption
2838
var theme: EditorTheme {
2939
didSet {
@@ -43,26 +53,37 @@ final class InvisibleCharactersCoordinator: InvisibleCharactersDelegate {
4353
}
4454
}
4555

46-
private var needsCacheClear = false
47-
private var invisibleColor: NSColor
48-
private var emphasizedFont: NSFont
56+
var needsCacheClear = false
57+
var invisibleColor: NSColor
58+
var emphasizedFont: NSFont
4959

5060
/// The set of characters the text view should trigger a call to ``invisibleStyle`` for.
51-
var triggerCharacters: Set<UInt16>
61+
var triggerCharacters: Set<UInt16> = []
5262

53-
init(config: InvisibleCharactersConfig, indentOption: IndentOption, theme: EditorTheme, font: NSFont) {
63+
init(
64+
config: InvisibleCharactersConfig,
65+
warningCharacters: Set<UInt16>,
66+
indentOption: IndentOption,
67+
theme: EditorTheme,
68+
font: NSFont
69+
) {
5470
self.config = config
71+
self.warningCharacters = warningCharacters
5572
self.indentOption = indentOption
5673
self.theme = theme
5774
self.font = font
58-
triggerCharacters = config.triggerCharacters()
5975
invisibleColor = theme.invisibles.color
6076
emphasizedFont = NSFontManager.shared.font(
6177
withFamily: font.familyName ?? "",
6278
traits: .unboldFontMask,
6379
weight: 15, // Condensed
6480
size: font.pointSize
6581
) ?? font
82+
updateTriggerCharacters()
83+
}
84+
85+
private func updateTriggerCharacters() {
86+
triggerCharacters = config.triggerCharacters().union(warningCharacters)
6687
}
6788

6889
/// Determines if the textview should clear cached styles.
@@ -144,7 +165,7 @@ final class InvisibleCharactersCoordinator: InvisibleCharactersDelegate {
144165
}
145166

146167
private func warningCharacterStyle(for character: UInt16) -> InvisibleCharacterStyle? {
147-
guard config.warningCharacters.contains(character) else { return nil }
168+
guard warningCharacters.contains(character) else { return nil }
148169
return .emphasize(color: .systemRed.withAlphaComponent(0.3))
149170
}
150171
}

‎Tests/CodeEditSourceEditorTests/Controller/TextViewControllerTests.swift‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,5 +487,77 @@ final class TextViewControllerTests: XCTestCase {
487487
lines = controller.getOverlappingLines(for: NSRange(location: 4, length: 1))
488488
XCTAssertEqual(2...2, lines)
489489
}
490+
491+
// MARK: - Invisible Characters
492+
493+
func test_setInvisibleCharacterConfig() {
494+
controller.setText(" Hello world")
495+
controller.indentOption = .spaces(count: 4)
496+
497+
XCTAssertEqual(controller.invisibleCharactersConfig, .empty)
498+
499+
controller.invisibleCharactersConfig = .init(showSpaces: true, showTabs: true, showLineEndings: true)
500+
XCTAssertEqual(
501+
controller.invisibleCharactersConfig,
502+
.init(showSpaces: true, showTabs: true, showLineEndings: true)
503+
)
504+
XCTAssertEqual(
505+
controller.invisibleCharactersCoordinator.config,
506+
.init(showSpaces: true, showTabs: true, showLineEndings: true)
507+
)
508+
509+
// Should emphasize the 4th space
510+
XCTAssertEqual(
511+
controller.invisibleCharactersCoordinator.invisibleStyle(
512+
for: InvisibleCharactersConfig.Symbols.space,
513+
at: NSRange(location: 3, length: 1),
514+
lineRange: NSRange(location: 0, length: 15)
515+
),
516+
.replace(
517+
replacementCharacter: "·",
518+
color: controller.theme.invisibles.color,
519+
font: controller.invisibleCharactersCoordinator.emphasizedFont
520+
)
521+
)
522+
XCTAssertEqual(
523+
controller.invisibleCharactersCoordinator.invisibleStyle(
524+
for: InvisibleCharactersConfig.Symbols.space,
525+
at: NSRange(location: 4, length: 1),
526+
lineRange: NSRange(location: 0, length: 15)
527+
),
528+
.replace(
529+
replacementCharacter: "·",
530+
color: controller.theme.invisibles.color,
531+
font: controller.font
532+
)
533+
)
534+
535+
if case .emphasize = controller.invisibleCharactersCoordinator.invisibleStyle(
536+
for: InvisibleCharactersConfig.Symbols.tab,
537+
at: .zero,
538+
lineRange: .zero
539+
) {
540+
XCTFail("Incorrect character style for invisible character")
541+
}
542+
}
543+
544+
// MARK: - Warning Characters
545+
546+
func test_setWarningCharacterConfig() {
547+
XCTAssertEqual(controller.warningCharacters, [])
548+
549+
controller.warningCharacters = [0, 1]
550+
551+
XCTAssertEqual(controller.warningCharacters, [0, 1])
552+
XCTAssertEqual(controller.invisibleCharactersCoordinator.warningCharacters, [0, 1])
553+
554+
if case .replace = controller.invisibleCharactersCoordinator.invisibleStyle(
555+
for: 0,
556+
at: .zero,
557+
lineRange: .zero
558+
) {
559+
XCTFail("Incorrect character style for warning character")
560+
}
561+
}
490562
}
491563
// swiftlint:enable all

0 commit comments

Comments
 (0)