Extract RegexHighlighting to package

CotEditor/Sources/NSImage.swift

@@ -51,17 +51,3 @@ extension NSImage {
         return image
     }
 }
-
-
-
-extension NSAttributedString {
-
-    convenience init(systemSymbolName: String, configuration: NSImage.SymbolConfiguration? = nil, accessibilityDescription: String? = nil) {
-
-        let attachment = NSTextAttachment()
-        attachment.image = NSImage(systemSymbolName: systemSymbolName, accessibilityDescription: accessibilityDescription)?
-            .withSymbolConfiguration(configuration ?? .init())
-
-        self.init(attachment: attachment)
-    }
-}

CotEditor/Sources/PatternSortView.swift

@@ -245,8 +245,6 @@ struct RegularExpressionSortPatternView: View {
 
     @Namespace private var accessibility
 
-    private let formatter = RegularExpressionFormatter()
-
 
     var body: some View {
 

CotEditor/Sources/RegexFindPanelTextView.swift

@@ -24,17 +24,20 @@
 //
 
 import AppKit
+import RegexHighlighting
 import StringBasics
 
 final class RegexFindPanelTextView: FindPanelTextView {
 
     // MARK: Public Properties
 
-    var parseMode: RegularExpressionParseMode = .search  { didSet { self.invalidateRegularExpression() } }
+    var parseMode: RegexParseMode = .search  { didSet { self.invalidateRegularExpression() } }
     var isRegularExpressionMode: Bool = false  { didSet { self.invalidateRegularExpression() } }
 
     private(set) var isValid = true
 
+    private let theme: RegexTheme<NSColor> = .default
+
 
     // MARK: Text View Methods
 
@@ -100,6 +103,6 @@ final class RegexFindPanelTextView: FindPanelTextView {
     /// Highlights the content string as a regular expression pattern.
     private func invalidateRegularExpression() {
 
-        self.isValid = self.highlightAsRegularExpressionPattern(mode: self.parseMode, enabled: self.isRegularExpressionMode)
+        self.isValid = self.highlightAsRegularExpressionPattern(mode: self.parseMode, theme: self.theme, enabled: self.isRegularExpressionMode)
     }
 }

CotEditor/Sources/RegexTextField.swift

@@ -25,6 +25,7 @@
 
 import AppKit
 import SwiftUI
+import RegexHighlighting
 
 struct RegexTextField: NSViewRepresentable {
 
@@ -38,9 +39,8 @@ struct RegexTextField: NSViewRepresentable {
 
     @Binding private var text: String
     private var isHighlighted: Bool = true
-    private let mode: RegularExpressionParseMode
+    private let mode: RegexParseMode
     private let showsError: Bool
-    private let showsInvisibles: Bool
 
     private let prompt: String?
     private let onSubmit: () -> Void
@@ -49,15 +49,14 @@ struct RegexTextField: NSViewRepresentable {
     private var style: Style = .automatic
 
 
-    init(text: Binding<String>, mode: RegularExpressionParseMode = .search, showsError: Bool = false, showsInvisible: Bool = true, prompt: String? = nil, onSubmit: @escaping () -> Void = {}) {
+    init(text: Binding<String>, mode: RegexParseMode = .search, showsError: Bool = false, prompt: String? = nil, onSubmit: @escaping () -> Void = {}) {
 
         self._text = text
         self.prompt = prompt
         self.onSubmit = onSubmit
 
         self.mode = mode
         self.showsError = showsError
-        self.showsInvisibles = showsInvisible
     }
 
 
@@ -101,7 +100,7 @@ struct RegexTextField: NSViewRepresentable {
 
     func makeNSView(context: Context) -> NSTextField {
 
-        let textField = RegexNSTextField(string: self.text, mode: self.mode, showsError: self.showsError, showsInvisibles: self.showsInvisibles)
+        let textField = RegexNSTextField(string: self.text, mode: self.mode, showsError: self.showsError)
         textField.delegate = context.coordinator
         textField.placeholderString = self.prompt
         textField.isEditable = true
@@ -183,18 +182,16 @@ private final class RegexNSTextField: NSTextField {
 
     // MARK: Private Properties
 
-    private let regexFormatter: RegularExpressionFormatter
+    private let regexFormatter: RegexFormatter<NSColor>
 
 
 
     // MARK: Text Field Methods
 
-    init(string: String = "", mode: RegularExpressionParseMode, showsError: Bool, showsInvisibles: Bool) {
+    init(string: String = "", mode: RegexParseMode, showsError: Bool) {
 
-        let formatter = RegularExpressionFormatter()
+        let formatter = RegexFormatter(theme: .default, showsError: showsError)
         formatter.mode = mode
-        formatter.showsError = showsError
-        formatter.showsInvisibles = showsInvisibles
         self.regexFormatter = formatter
 
         super.init(frame: .zero)
@@ -254,7 +251,7 @@ private final class RegexNSTextField: NSTextField {
 
         guard let editor = self.currentEditor() as? NSTextView else { return }
 
-        editor.highlightAsRegularExpressionPattern(mode: self.regexFormatter.mode, enabled: self.isRegexHighlighted)
+        editor.highlightAsRegularExpressionPattern(mode: self.regexFormatter.mode, theme: self.regexFormatter.theme, enabled: self.isRegexHighlighted)
     }
 }
 

CotEditor/Sources/RegularExpressionSyntaxType+Color.swift → CotEditor/Sources/RegexTheme.swift

@@ -1,14 +1,14 @@
 //
-//  RegularExpressionSyntaxType+Color.swift
+//  RegexTheme.swift
 //
 //  CotEditor
 //  https://coteditor.com
 //
-//  Created by 1024jp on 2018-12-23.
+//  Created by 1024jp on 2024-07-09.
 //
 //  ---------------------------------------------------------------------------
 //
-//  © 2018-2023 1024jp
+//  © 2024 1024jp
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -24,17 +24,16 @@
 //
 
 import AppKit.NSColor
+import RegexHighlighting
 
-extension RegularExpressionSyntaxType {
+extension RegexTheme<NSColor> {
 
-    var color: NSColor {
-
-        switch self {
-            case .character: .Regex.character
-            case .backReference: .Regex.backReference
-            case .symbol: .Regex.symbol
-            case .quantifier: .Regex.quantifier
-            case .anchor: .Regex.anchor
-        }
-    }
+    static let `default` = RegexTheme(
+        character: .Regex.character,
+        backReference: .Regex.backReference,
+        symbol: .Regex.symbol,
+        quantifier: .Regex.quantifier,
+        anchor: .Regex.anchor,
+        invisible: .tertiaryLabelColor
+    )
 }

CotEditor/Sources/RegularExpressionTextField.swift

@@ -24,6 +24,7 @@
 //
 
 import AppKit
+import RegexHighlighting
 
 final class RegularExpressionTextField: NSTextField {
 
@@ -48,7 +49,7 @@ final class RegularExpressionTextField: NSTextField {
 
     // MARK: Private Properties
 
-    private let regexFormatter = RegularExpressionFormatter()
+    private let regexFormatter = RegexFormatter(theme: .default)
 
     @IBInspectable private var isReplacement: Bool = false
 
@@ -77,7 +78,6 @@ final class RegularExpressionTextField: NSTextField {
 
         // setup regex formatter
         self.regexFormatter.mode = self.parseMode
-        self.regexFormatter.showsInvisibles = true
     }
 
 
@@ -113,7 +113,7 @@ final class RegularExpressionTextField: NSTextField {
 
     // MARK: Private Methods
 
-    private var parseMode: RegularExpressionParseMode {
+    private var parseMode: RegexParseMode {
 
         self.isReplacement ? .replacement(unescapes: self.unescapesReplacement) : .search
     }
@@ -124,6 +124,6 @@ final class RegularExpressionTextField: NSTextField {
 
         guard let editor = self.currentEditor() as? NSTextView else { return }
 
-        editor.highlightAsRegularExpressionPattern(mode: self.parseMode, enabled: self.parsesRegularExpression)
+        editor.highlightAsRegularExpressionPattern(mode: self.parseMode, theme: self.regexFormatter.theme, enabled: self.parsesRegularExpression)
     }
 }

CotEditor/Sources/SyntaxHighlightEditView.swift

@@ -80,7 +80,7 @@ struct SyntaxHighlightEditView: View {
 
                 TableColumn(String(localized: "Begin String", table: "SyntaxEditor", comment: "table column header"), value: \.begin) { wrappedItem in
                     if let item = $items[id: wrappedItem.id] {
-                        RegexTextField(text: item.begin, showsError: true, showsInvisible: true)
+                        RegexTextField(text: item.begin, showsError: true)
                             .regexHighlighted(item.isRegularExpression.wrappedValue)
                             .style(.table)
                             .focused($focusedField, equals: item.id)
@@ -89,7 +89,7 @@ struct SyntaxHighlightEditView: View {
 
                 TableColumn(String(localized: "End String", table: "SyntaxEditor", comment: "table column header"), sortUsing: KeyPathComparator(\.end)) { wrappedItem in
                     if let item = $items[id: wrappedItem.id] {
-                        RegexTextField(text: item.end ?? "", showsError: true, showsInvisible: true)
+                        RegexTextField(text: item.end ?? "", showsError: true)
                             .regexHighlighted(item.isRegularExpression.wrappedValue)
                             .style(.table)
                     }

CotEditor/Sources/SyntaxOutlineEditView.swift

@@ -52,7 +52,7 @@ struct SyntaxOutlineEditView: View {
                 .alignment(.center)
 
                 TableColumn(String(localized: "Regular Expression Pattern", table: "SyntaxEditor", comment: "table column header")) { item in
-                    RegexTextField(text: item.pattern, showsError: true, showsInvisible: true)
+                    RegexTextField(text: item.pattern, showsError: true)
                         .style(.table)
                         .focused($focusedField, equals: item.id)
                 }

Packages/MacUI/Package.swift

@@ -12,17 +12,23 @@ let package = Package(
     products: [
         .library(name: "MacUI", targets: [
             "ControlUI",
+            "RegexHighlighting",
             "Shortcut",
         ]),
 
+        .library(name: "RegexHighlighting", targets: ["RegexHighlighting"]),
         .library(name: "Shortcut", targets: ["Shortcut"]),
     ],
     dependencies: [
+        .package(path: "EditorCore"),
         .package(url: "https://github.com/realm/SwiftLint", from: Version(0, 55, 0)),
     ],
     targets: [
         .target(name: "ControlUI"),
 
+        .target(name: "RegexHighlighting", dependencies: ["EditorCore"]),
+        .testTarget(name: "RegexHighlightingTests", dependencies: ["RegexHighlighting"]),
+
         .target(name: "Shortcut", resources: [.process("Resources")]),
         .testTarget(name: "ShortcutTests", dependencies: ["Shortcut"]),
     ],

Packages/MacUI/Sources/RegexHighlighting/NSAttributedString.swift

@@ -0,0 +1,39 @@
+//
+//  NSAttributedString.swift
+//  RegexHighlighting
+//
+//  CotEditor
+//  https://coteditor.com
+//
+//  Created by 1024jp on 2024-07-09.
+//
+//  ---------------------------------------------------------------------------
+//
+//  © 2020-2024 1024jp
+//
+//  Licensed under the Apache License, Version 2.0 (the "License");
+//  you may not use this file except in compliance with the License.
+//  You may obtain a copy of the License at
+//
+//  https://www.apache.org/licenses/LICENSE-2.0
+//
+//  Unless required by applicable law or agreed to in writing, software
+//  distributed under the License is distributed on an "AS IS" BASIS,
+//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//  See the License for the specific language governing permissions and
+//  limitations under the License.
+//
+
+import AppKit
+
+extension NSAttributedString {
+
+    convenience init(systemSymbolName: String, configuration: NSImage.SymbolConfiguration? = nil, accessibilityDescription: String? = nil) {
+
+        let attachment = NSTextAttachment()
+        attachment.image = NSImage(systemSymbolName: systemSymbolName, accessibilityDescription: accessibilityDescription)?
+            .withSymbolConfiguration(configuration ?? .init())
+
+        self.init(attachment: attachment)
+    }
+}

CotEditor/Sources/NSTextSelectionDataSource.swift → Packages/MacUI/Sources/RegexHighlighting/NSTextSelectionDataSource.swift

@@ -1,5 +1,6 @@
 //
 //  NSTextSelectionDataSource.swift
+//  RegexHighlighting
 //
 //  CotEditor
 //  https://coteditor.com
@@ -8,7 +9,7 @@
 //
 //  ---------------------------------------------------------------------------
 //
-//  © 2022 1024jp
+//  © 2022-2024 1024jp
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
 //  you may not use this file except in compliance with the License.
@@ -25,8 +26,6 @@
 
 import AppKit
 
-// MARK: Range Conversion
-
 extension NSTextSelectionDataSource {
 
     /// Converts NSRange to NSTextRange.
@@ -42,17 +41,4 @@ extension NSTextSelectionDataSource {
 
         return NSTextRange(location: location, end: end)
     }
-
-
-    /// Converts NSTextRange to NSRange.
-    ///
-    /// - Parameter textRange: The NSTextRange to convert.
-    /// - Returns: An NSRange.
-    func range(for textRange: NSTextRange) -> NSRange {
-
-        let location = self.offset(from: self.documentRange.location, to: textRange.location)
-        let length = self.offset(from: textRange.location, to: textRange.endLocation)
-
-        return NSRange(location: location, length: length)
-    }
 }