Create PersistableConvertible

Author: 1024jp

CotEditor/Sources/Models/Persistable.swift

@@ -27,6 +27,12 @@ import SwiftUI
 import UniformTypeIdentifiers
 import SemanticVersioning
 
+extension UTType {
+    
+    static let cotSettings = UTType(exportedAs: "com.coteditor.CotEditor.settings")
+}
+
+
 struct PortableSettingsDocument: FileDocument {
 
     struct Info: Equatable, Codable {

CotEditor/Sources/Models/PortableSettingsDocument.swift

@@ -0,0 +1,74 @@
+//
+//  MultipleReplace+Persistable.swift
+//
+//  CotEditor
+//  https://coteditor.com
+//
+//  Created by imanishi on 1/10/26.
+//
+//  ---------------------------------------------------------------------------
+//
+//  © 2026 CotEditor Project
+//
+//  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 Foundation
+import UniformTypeIdentifiers
+import TextFind
+
+extension UTType {
+    
+    static let cotReplacement = UTType(exportedAs: "com.coteditor.CotEditor.replacement")
+}
+
+
+extension MultipleReplace: PersistableConvertible {
+    
+    typealias Persistent = Data
+    
+    
+    nonisolated static let fileType: UTType = .cotReplacement
+    
+    
+    init(persistence: any Persistable, type: UTType) throws {
+        
+        switch persistence {
+            case let data as Data where type.conforms(to: .cotReplacement):
+                self = try JSONDecoder().decode(Self.self, from: data)
+                
+            case let data as Data where type.conforms(to: .tabSeparatedText):
+                guard let string = String(data: data, encoding: .utf8) else { throw CocoaError(.fileReadInapplicableStringEncoding) }
+                
+                try self.init(tabSeparatedText: string)
+                
+            default:
+                throw CocoaError(.fileReadUnsupportedScheme)
+        }
+    }
+    
+    
+    nonisolated static func persistence(at fileURL: URL) throws -> Persistent {
+        
+        try Data(contentsOf: fileURL)
+    }
+    
+    
+    func makePersistable() throws -> any Persistable {
+        
+        let encoder = JSONEncoder()
+        encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
+        
+        return try encoder.encode(self)
+    }
+}

CotEditor/Sources/Models/Settings/MultipleReplace+Persistable.swift

@@ -0,0 +1,92 @@
+//
+//  Persistable.swift
+//
+//  CotEditor
+//  https://coteditor.com
+//
+//  Created by 1024jp on 2026-01-10.
+//
+//  ---------------------------------------------------------------------------
+//
+//  © 2026 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 Foundation
+import UniformTypeIdentifiers
+
+protocol PersistableConvertible: Sendable {
+    
+    associatedtype Persistence: Persistable
+    
+    
+    /// The default uniform type identifier for files representing this type.
+    nonisolated static var fileType: UTType { get }
+    
+    
+    /// Creates an instance from a persistable payload and file type.
+    init(persistence: any Persistable, type: UTType) throws
+    
+    /// Loads the persisted payload from a file.
+    nonisolated static func persistence(at fileURL: URL) throws -> Persistence
+    
+    /// Produces a persistable payload that represents the current value.
+    func makePersistable() throws -> any Persistable
+}
+
+
+extension PersistableConvertible {
+    
+    /// Creates an instance by loading contents from a file.
+    ///
+    /// - Parameter fileURL: The location of the file to read.
+    /// - Throws: An error if reading or decoding the file fails.
+    init(contentsOf fileURL: URL) throws {
+        
+        let persistence = try Self.persistence(at: fileURL)
+        
+        try self.init(persistence: persistence, type: UTType(filenameExtension: fileURL.pathExtension) ?? Self.fileType)
+    }
+}
+
+
+// MARK: -
+
+protocol Persistable: Equatable, Sendable {
+    
+    /// The `FileWrapper` representation.
+    var fileWrapper: FileWrapper { get }
+    
+    
+    /// Writes the contents to the specified file location.
+    ///
+    /// - Parameter fileURL: The destination URL to write the persisted data to.
+    /// - Throws: An error if writing the contents fails.
+    func persist(to fileURL: URL) throws
+}
+
+
+extension Data: Persistable {
+    
+    var fileWrapper: FileWrapper {
+        
+        FileWrapper(regularFileWithContents: self)
+    }
+    
+    
+    func persist(to fileURL: URL) throws {
+        
+        try self.write(to: fileURL)
+    }
+}

CotEditor/Sources/Models/Settings/Persistable.swift

@@ -0,0 +1,67 @@
+//
+//  Syntax+Persistable.swift
+//
+//  CotEditor
+//  https://coteditor.com
+//
+//  Created by imanishi on 1/10/26.
+//
+//  ---------------------------------------------------------------------------
+//
+//  © 2026 CotEditor Project
+//
+//  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 Foundation
+import UniformTypeIdentifiers
+import Syntax
+import Yams
+
+extension Syntax: PersistableConvertible {
+    
+    typealias Persistent = Data
+    
+    
+    nonisolated static let fileType: UTType = .yaml
+    
+    
+    init(persistence: any Persistable, type: UTType) throws {
+        
+        switch persistence {
+            case let data as Data where type.conforms(to: .yaml):
+                self = try YAMLDecoder().decode(Self.self, from: data)
+                
+            default:
+                throw CocoaError(.fileReadUnsupportedScheme)
+        }
+    }
+    
+    
+    nonisolated static func persistence(at fileURL: URL) throws -> Persistent {
+        
+        try Data(contentsOf: fileURL)
+    }
+    
+    
+    func makePersistable() throws -> any Persistable {
+        
+        let encoder = YAMLEncoder()
+        encoder.options.allowUnicode = true
+        encoder.options.sortKeys = true
+        
+        let yamlString = try encoder.encode(self)
+        
+        return Data(yamlString.utf8)
+    }
+}

CotEditor/Sources/Models/Settings/Syntax+Persistable.swift

@@ -0,0 +1,68 @@
+//
+//  Theme+Persistable.swift
+//
+//  CotEditor
+//  https://coteditor.com
+//
+//  Created by imanishi on 1/10/26.
+//
+//  ---------------------------------------------------------------------------
+//
+//  © 2026 CotEditor Project
+//
+//  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 Foundation
+import UniformTypeIdentifiers
+
+extension UTType {
+    
+    static let cotTheme = UTType(exportedAs: "com.coteditor.CotEditor.theme")
+}
+
+
+extension Theme: PersistableConvertible, @unchecked Sendable {
+    
+    typealias Persistent = Data
+    
+    
+    nonisolated static let fileType: UTType = .cotTheme
+    
+    
+    init(persistence: any Persistable, type: UTType) throws {
+        
+        switch persistence {
+            case let data as Data where type.conforms(to: UTType.cotTheme):
+                self = try JSONDecoder().decode(Self.self, from: data)
+                
+            default:
+                throw CocoaError(.fileReadUnsupportedScheme)
+        }
+    }
+    
+    
+    nonisolated static func persistence(at fileURL: URL) throws -> Persistent {
+        
+        try Data(contentsOf: fileURL)
+    }
+    
+    
+    func makePersistable() throws -> any Persistable {
+        
+        let encoder = JSONEncoder()
+        encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
+        
+        return try encoder.encode(self)
+    }
+}