Merge branch 'main' into feat/editor-configuration

Author: thecoolwinter

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

@@ -30,6 +30,7 @@ struct ContentView: View {
     @AppStorage("showGutter") private var showGutter: Bool = true
     @AppStorage("showMinimap") private var showMinimap: Bool = true
     @AppStorage("showReformattingGuide") private var showReformattingGuide: Bool = false
+    @State private var invisibleCharactersConfig: InvisibleCharactersConfig = .empty
 
     @State private var isInLongParse = false
     @State private var settingsIsPresented: Bool = false
@@ -79,7 +80,8 @@ struct ContentView: View {
                     showMinimap: $showMinimap,
                     indentOption: $indentOption,
                     reformatAtColumn: $reformatAtColumn,
-                    showReformattingGuide: $showReformattingGuide
+                    showReformattingGuide: $showReformattingGuide,
+                    invisibles: $invisibleCharactersConfig
                 )
             }
             .ignoresSafeArea()

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/ContentView.swift

@@ -27,6 +27,7 @@ struct StatusBar: View {
     @Binding var indentOption: IndentOption
     @Binding var reformatAtColumn: Int
     @Binding var showReformattingGuide: Bool
+    @Binding var invisibles: InvisibleCharactersConfig
 
     var body: some View {
         HStack {
@@ -52,6 +53,33 @@ struct StatusBar: View {
                         .disabled(true)
                         .help("macOS 14 required")
                 }
+
+                Menu {
+                    Toggle("Spaces", isOn: $invisibles.showSpaces)
+                    Toggle("Tabs", isOn: $invisibles.showTabs)
+                    Toggle("Line Endings", isOn: $invisibles.showLineEndings)
+                    Divider()
+                    Toggle(
+                        "Warning Characters",
+                        isOn: Binding(
+                            get: {
+                                !invisibles.warningCharacters.isEmpty
+                            },
+                            set: { newValue in
+                                // In this example app, we only add one character
+                                // For real apps, consider providing a table where users can add UTF16
+                                // char codes to warn about, as well as a set of good defaults.
+                                if newValue {
+                                    invisibles.warningCharacters.insert(0x200B) // zero-width space
+                                } else {
+                                    invisibles.warningCharacters.removeAll()
+                                }
+                            }
+                        )
+                    )
+                } label: {
+                    Text("Invisibles")
+                }
             } label: {}
                 .background {
                     Image(systemName: "switch.2")

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/StatusBar.swift

@@ -17,7 +17,7 @@ let package = Package(
         // A fast, efficient, text view for code.
         .package(
             url: "https://github.com/CodeEditApp/CodeEditTextView.git",
-            from: "0.11.1"
+            from: "0.11.2"
         ),
         // tree-sitter languages
         .package(

Package.resolved

@@ -209,6 +209,8 @@ public class TextViewController: NSViewController {
             delegate: self
         )
 
+        textView.layoutManager.invisibleCharacterDelegate = invisibleCharactersCoordinator
+
         coordinators.forEach {
             $0.prepareCoordinator(controller: self)
         }
@@ -255,4 +257,4 @@ public class TextViewController: NSViewController {
         }
         localEvenMonitor = nil
     }
-}
+} // swiftlint:disable:this file_length

Package.swift

@@ -0,0 +1,77 @@
+//
+//  InvisibleCharactersConfig.swift
+//  CodeEditSourceEditor
+//
+//  Created by Khan Winter on 6/11/25.
+//
+
+/// 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 {
+        InvisibleCharactersConfig(showSpaces: false, showTabs: false, showLineEndings: false)
+    }
+
+    /// 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 = "⏎"
+
+    public init(showSpaces: Bool, showTabs: Bool, showLineEndings: Bool) {
+        self.showSpaces = showSpaces
+        self.showTabs = showTabs
+        self.showLineEndings = showLineEndings
+    }
+
+    /// Determines what characters should trigger a custom drawing action.
+    func triggerCharacters() -> Set<UInt16> {
+        var set = Set<UInt16>()
+
+        if showSpaces {
+            set.insert(Symbols.space)
+        }
+
+        if showTabs {
+            set.insert(Symbols.tab)
+        }
+
+        if showLineEndings {
+            set.insert(Symbols.lineFeed)
+            set.insert(Symbols.carriageReturn)
+            set.insert(Symbols.paragraphSeparator)
+            set.insert(Symbols.lineSeparator)
+        }
+
+        return set
+    }
+
+    /// Some commonly used whitespace symbols in their unichar representation.
+    public enum Symbols {
+        public static let space: UInt16 = 0x20
+        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
+    }
+}