Add Replacement Strings Configuration

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -6,6 +6,9 @@
 //
 
 /// Configuration for how the editor draws invisible characters.
+///
+/// Enable specific categories using the ``showSpaces``, ``showTabs``, and ``showLineEndings`` toggles. Customize
+/// drawing further with the ``spaceReplacement`` and family variables.
 public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable {
     /// An empty configuration.
     public static var empty: InvisibleCharactersConfig {
@@ -14,17 +17,38 @@ public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable
 
     /// Set to true to draw spaces with a dot.
     public var showSpaces: Bool
+
     /// Set to true to draw tabs with a small arrow.
     public var showTabs: Bool
+
     /// Set to true to draw line endings.
     public var showLineEndings: Bool
+
+    /// Replacement when drawing the space character, enabled by ``showSpaces``.
+    public var spaceReplacement: String = "·"
+    /// Replacement when drawing the tab character, enabled by ``showTabs``.
+    public var tabReplacement: String = "→"
+    /// Replacement when drawing the carriage return character, enabled by ``showLineEndings``.
+    public var carriageReturnReplacement: String = "↵"
+    /// Replacement when drawing the line feed character, enabled by ``showLineEndings``.
+    public var lineFeedReplacement: String = "¬"
+    /// Replacement when drawing the paragraph separator character, enabled by ``showLineEndings``.
+    public var paragraphSeparatorReplacement: String = "¶"
+    /// Replacement when drawing the line separator character, enabled by ``showLineEndings``.
+    public var lineSeparatorReplacement: String = "⏎"
+
     /// A set of characters the editor should draw with a small red border.
     ///
     /// Indicates characters that the user may not have meant to insert, such as a zero-width space: `(0x200D)` or a
     /// non-standard quote character: `“ (0x201C)`.
     public var warningCharacters: Set<UInt16>
 
-    public init(showSpaces: Bool, showTabs: Bool, showLineEndings: Bool, warningCharacters: Set<UInt16>) {
+    public init(
+        showSpaces: Bool,
+        showTabs: Bool,
+        showLineEndings: Bool,
+        warningCharacters: Set<UInt16>
+    ) {
         self.showSpaces = showSpaces
         self.showTabs = showTabs
         self.showLineEndings = showLineEndings
@@ -46,6 +70,8 @@ public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable
         if showLineEndings {
             set.insert(Symbols.lineFeed)
             set.insert(Symbols.carriageReturn)
+            set.insert(Symbols.paragraphSeparator)
+            set.insert(Symbols.lineSeparator)
         }
 
         set.formUnion(warningCharacters)
@@ -59,5 +85,7 @@ public struct InvisibleCharactersConfig: Equatable, Hashable, Sendable, Codable
         public static let tab: UInt16 = 0x9
         public static let lineFeed: UInt16 = 0xA // \n
         public static let carriageReturn: UInt16 = 0xD // \r
+        public static let paragraphSeparator: UInt16 = 0x2029 // ¶
+        public static let lineSeparator: UInt16 = 0x2028 // line separator
     }
 }

Sources/CodeEditSourceEditor/InvisibleCharacters/InvisibleCharactersConfig.swift

@@ -83,21 +83,68 @@ final class InvisibleCharactersCoordinator: InvisibleCharactersDelegate {
     func invisibleStyle(for character: UInt16, at range: NSRange, lineRange: NSRange) -> InvisibleCharacterStyle? {
         switch character {
         case InvisibleCharactersConfig.Symbols.space:
-            guard config.showSpaces else { return nil }
-            let locationInLine = range.location - lineRange.location
-            let shouldBold = locationInLine % indentOption.charCount == indentOption.charCount - 1
-            return .replace(replacementCharacter: "·", color: invisibleColor, font: shouldBold ? emphasizedFont : font)
+            return spacesStyle(range: range, lineRange: lineRange)
         case InvisibleCharactersConfig.Symbols.tab:
-            guard config.showTabs else { return nil }
-            return .replace(replacementCharacter: "→", color: invisibleColor, font: font)
-        case InvisibleCharactersConfig.Symbols.carriageReturn, InvisibleCharactersConfig.Symbols.lineFeed:
-            guard config.showLineEndings else { return nil }
-            return .replace(replacementCharacter: "¬", color: invisibleColor, font: font)
+            return tabStyle()
+        case InvisibleCharactersConfig.Symbols.carriageReturn:
+            return carriageReturnStyle()
+        case InvisibleCharactersConfig.Symbols.lineFeed:
+            return lineFeedStyle()
+        case InvisibleCharactersConfig.Symbols.paragraphSeparator:
+            return paragraphSeparatorStyle()
+        case InvisibleCharactersConfig.Symbols.lineSeparator:
+            return lineSeparatorStyle()
         default:
-            guard config.warningCharacters.contains(character) else {
-                return nil
-            }
-            return .emphasize(color: .systemRed.withAlphaComponent(0.3))
+            return warningCharacterStyle(for: character)
         }
     }
+
+    private func spacesStyle(range: NSRange, lineRange: NSRange) -> InvisibleCharacterStyle? {
+        guard config.showSpaces else { return nil }
+        let locationInLine = range.location - lineRange.location
+        let shouldBold = locationInLine % indentOption.charCount == indentOption.charCount - 1
+        return .replace(
+            replacementCharacter: config.spaceReplacement,
+            color: invisibleColor,
+            font: shouldBold ? emphasizedFont : font
+        )
+    }
+
+    private func tabStyle() -> InvisibleCharacterStyle? {
+        guard config.showTabs else { return nil }
+        return .replace(replacementCharacter: config.tabReplacement, color: invisibleColor, font: font)
+    }
+
+    private func carriageReturnStyle() -> InvisibleCharacterStyle? {
+        guard config.showLineEndings else { return nil }
+        return .replace(replacementCharacter: config.carriageReturnReplacement, color: invisibleColor, font: font)
+    }
+
+    private func lineFeedStyle() -> InvisibleCharacterStyle? {
+        guard config.showLineEndings else { return nil }
+        return .replace(replacementCharacter: config.lineFeedReplacement, color: invisibleColor, font: font)
+    }
+
+    private func paragraphSeparatorStyle() -> InvisibleCharacterStyle? {
+        guard config.showLineEndings else { return nil }
+        return .replace(
+            replacementCharacter: config.paragraphSeparatorReplacement,
+            color: invisibleColor,
+            font: font
+        )
+    }
+
+    private func lineSeparatorStyle() -> InvisibleCharacterStyle? {
+        guard config.showLineEndings else { return nil }
+        return .replace(
+            replacementCharacter: config.lineSeparatorReplacement,
+            color: invisibleColor,
+            font: font
+        )
+    }
+
+    private func warningCharacterStyle(for character: UInt16) -> InvisibleCharacterStyle? {
+        guard config.warningCharacters.contains(character) else { return nil }
+        return .emphasize(color: .systemRed.withAlphaComponent(0.3))
+    }
 }