Add options to open panel too (#799)

Author: cyanzhong

MarkEditKit/Sources/EditorTextEncoding.swift

@@ -67,23 +67,35 @@ public enum EditorTextEncoding: CaseIterable, CustomStringConvertible, Codable {
     }
   }
 
-  public func decode(data: Data) -> String? {
-    switch self {
-    case .ascii: return String(data: data, encoding: .ascii)
-    case .nonLossyASCII: return String(data: data, encoding: .nonLossyASCII)
-    case .utf8: return String(data: data, encoding: .utf8)
-    case .utf16: return String(data: data, encoding: .utf16)
-    case .utf16BigEndian: return String(data: data, encoding: .utf16BigEndian)
-    case .utf16LittleEndian: return String(data: data, encoding: .utf16LittleEndian)
-    case .macOSRoman: return String(data: data, encoding: .macOSRoman)
-    case .isoLatin1: return String(data: data, encoding: .isoLatin1)
-    case .windowsLatin1: return String(data: data, encoding: .windowsCP1252)
-    case .gb18030: return String(data: data, encoding: .GB_18030_2000)
-    case .big5: return String(data: data, encoding: .big5)
-    case .japaneseEUC: return String(data: data, encoding: .japaneseEUC)
-    case .shiftJIS: return String(data: data, encoding: String.Encoding.shiftJIS)
-    case .koreanEUC: return String(data: data, encoding: .EUC_KR)
+  public func decode(data: Data, guessEncoding: Bool = false) -> String {
+    let defaultResult = {
+      switch self {
+      case .ascii: return String(data: data, encoding: .ascii)
+      case .nonLossyASCII: return String(data: data, encoding: .nonLossyASCII)
+      case .utf8: return String(data: data, encoding: .utf8)
+      case .utf16: return String(data: data, encoding: .utf16)
+      case .utf16BigEndian: return String(data: data, encoding: .utf16BigEndian)
+      case .utf16LittleEndian: return String(data: data, encoding: .utf16LittleEndian)
+      case .macOSRoman: return String(data: data, encoding: .macOSRoman)
+      case .isoLatin1: return String(data: data, encoding: .isoLatin1)
+      case .windowsLatin1: return String(data: data, encoding: .windowsCP1252)
+      case .gb18030: return String(data: data, encoding: .GB_18030_2000)
+      case .big5: return String(data: data, encoding: .big5)
+      case .japaneseEUC: return String(data: data, encoding: .japaneseEUC)
+      case .shiftJIS: return String(data: data, encoding: String.Encoding.shiftJIS)
+      case .koreanEUC: return String(data: data, encoding: .EUC_KR)
+      }
+    }()
+
+    if let defaultResult {
+      return defaultResult
     }
+
+    if guessEncoding, let guessedResult = data.toString() {
+      return guessedResult
+    }
+
+    return data.asciiText()
   }
 }
 
@@ -93,3 +105,17 @@ public extension EditorTextEncoding {
     Set([.nonLossyASCII, .utf16LittleEndian, .windowsLatin1, .big5, .shiftJIS])
   }
 }
+
+// MARK: - Private
+
+private extension Data {
+  func asciiText(unsupported: Character = ".") -> String {
+    reduce(into: "") { result, byte in
+      if (byte >= 32 && byte < 127) || (byte >= 160 && byte < 255) || byte == 0x0A || byte == 0x09 {
+        result.append(Character(UnicodeScalar(byte)))
+      } else {
+        result.append(unsupported)
+      }
+    }
+  }
+}

MarkEditMac/Modules/Sources/AppKitExtensions/Foundation/NSSavePanel+Extension.swift

@@ -0,0 +1,20 @@
+//
+//  NSSavePanel+Extension.swift
+//
+//  Created by cyan on 12/22/24.
+//
+
+import AppKit
+import UniformTypeIdentifiers
+
+public extension NSSavePanel {
+  func enforceUniformType(_ type: UTType) {
+    let otherFileTypesWereAllowed = allowsOtherFileTypes
+    allowsOtherFileTypes = false // Must turn this off temporarily to enforce the file type
+    allowedContentTypes = [type]
+
+    DispatchQueue.main.async {
+      self.allowsOtherFileTypes = otherFileTypesWereAllowed
+    }
+  }
+}

MarkEditMac/Sources/Editor/Controllers/EditorViewController+Encoding.swift

@@ -11,14 +11,14 @@ import MarkEditKit
 extension EditorViewController {
   @objc func reopenWithEncoding(_ sender: NSMenuItem) {
     guard let encoding = sender.representedObject as? EditorTextEncoding else {
-      return
+      return Logger.assertFail("Invalid encoding: \(String(describing: sender.representedObject))")
     }
 
-    guard let data = document?.fileData, let string = encoding.decode(data: data) else {
-      return
+    guard let data = document?.fileData else {
+      return Logger.assertFail("Missing fileData from: \(String(describing: document))")
     }
 
-    document?.stringValue = string
+    document?.stringValue = encoding.decode(data: data)
     resetEditor()
   }
 }

MarkEditMac/Sources/Editor/Models/EditorDocument.swift

@@ -177,8 +177,13 @@ extension EditorDocument {
     }
 
     if textBundle == nil {
-      savePanel.accessoryView = EditorSaveOptionsView.wrapper(for: savePanel) { [weak self] in
-        self?.suggestedTextEncoding = $0
+      savePanel.accessoryView = EditorSaveOptionsView.wrapper(for: .all) { [weak self, weak savePanel] result in
+        switch result {
+        case .fileExtension(let value):
+          savePanel?.enforceUniformType(value.uniformType)
+        case .textEncoding(let value):
+          self?.suggestedTextEncoding = value
+        }
       }
     } else {
       savePanel.accessoryView = nil
@@ -195,9 +200,14 @@ extension EditorDocument {
 extension EditorDocument {
   override func read(from data: Data, ofType typeName: String) throws {
     DispatchQueue.global(qos: .userInitiated).async {
-      let encoding = AppPreferences.General.defaultTextEncoding
-      let newValue = encoding.decode(data: data) ?? data.toString() ?? ""
-      guard self.stringValue != newValue else { return }
+      let newValue = {
+        if let encoding = AppDocumentController.suggestedTextEncoding {
+          return encoding.decode(data: data)
+        }
+
+        let encoding = AppPreferences.General.defaultTextEncoding
+        return encoding.decode(data: data, guessEncoding: true)
+      }()
 
       DispatchQueue.main.async {
         self.fileData = data

MarkEditMac/Sources/Editor/Views/EditorSaveOptionsView.swift

@@ -14,54 +14,58 @@ import MarkEditKit
  Accessory view used in NSSavePanel to provide additional options.
  */
 struct EditorSaveOptionsView: View {
+  struct Options: OptionSet {
+    let rawValue: Int
+    static let fileExtension = Self(rawValue: 1 << 0)
+    static let textEncoding = Self(rawValue: 1 << 1)
+    static let all: Self = [.fileExtension, .textEncoding]
+  }
+
+  enum Result {
+    case fileExtension(value: NewFilenameExtension)
+    case textEncoding(value: EditorTextEncoding)
+  }
+
   @State private var filenameExtension = AppPreferences.General.newFilenameExtension
   @State private var textEncoding = AppPreferences.General.defaultTextEncoding
 
-  private let extensionChanged: ((NewFilenameExtension) -> Void)
-  private let encodingChanged: ((EditorTextEncoding) -> Void)
-
-  static func wrapper(for panel: NSSavePanel, encodingChanged: @escaping (EditorTextEncoding) -> Void) -> NSView {
-    NSHostingView(rootView: Self(
-      extensionChanged: {
-        let allowsOtherFileTypes = panel.allowsOtherFileTypes == true
-        panel.allowsOtherFileTypes = false
-        panel.allowedContentTypes = [$0.uniformType]
+  private let options: Options
+  private let onValueChange: ((Result) -> Void)
 
-        // Must turn this off temporarily to enforce the file type
-        DispatchQueue.main.async {
-          panel.allowsOtherFileTypes = allowsOtherFileTypes
-        }
-      },
-      encodingChanged: encodingChanged
-    ))
+  static func wrapper(for options: Options, onValueChange: @escaping ((Result) -> Void)) -> NSView {
+    NSHostingView(rootView: Self(options: options, onValueChange: onValueChange))
   }
 
   var body: some View {
     SettingsForm(padding: 8) {
       Section {
-        Picker(Localized.Document.filenameExtension, selection: $filenameExtension) {
-          ForEach(NewFilenameExtension.allCases, id: \.self) {
-            Text($0.rawValue).tag($0)
+        if options.contains(.fileExtension) {
+          Picker(Localized.Document.filenameExtension, selection: $filenameExtension) {
+            ForEach(NewFilenameExtension.allCases, id: \.self) {
+              Text($0.rawValue).tag($0)
+            }
           }
+          .onChange(of: filenameExtension) {
+            onValueChange(.fileExtension(value: filenameExtension))
+          }
+          .formMenuPicker(minWidth: 120)
         }
-        .onChange(of: filenameExtension) {
-          extensionChanged(filenameExtension)
-        }
-        .formMenuPicker(minWidth: 120)
 
-        Picker(Localized.Document.textEncoding, selection: $textEncoding) {
-          ForEach(EditorTextEncoding.allCases, id: \.self) {
-            Text($0.description)
+        if options.contains(.textEncoding) {
+          Picker(Localized.Document.textEncoding, selection: $textEncoding) {
+            ForEach(EditorTextEncoding.allCases, id: \.self) {
+              Text($0.description)
 
-            if EditorTextEncoding.groupingCases.contains($0) {
-              Divider()
+              if EditorTextEncoding.groupingCases.contains($0) {
+                Divider()
+              }
             }
           }
+          .onChange(of: textEncoding) {
+            onValueChange(.textEncoding(value: textEncoding))
+          }
+          .formMenuPicker(minWidth: 120)
         }
-        .onChange(of: textEncoding) {
-          encodingChanged(textEncoding)
-        }
-        .formMenuPicker(minWidth: 120)
       }
     }
     .frame(maxWidth: .infinity)

MarkEditMac/Sources/Main/AppDocumentController.swift

@@ -6,18 +6,28 @@
 //
 
 import AppKit
+import MarkEditKit
 
 /**
  Subclass of `NSDocumentController` to allow customizations.
 
  NSDocumentController.shared will be an instance of `AppDocumentController` at runtime.
  */
 final class AppDocumentController: NSDocumentController {
-  override func beginOpenPanel() async -> [URL]? {
+  static var suggestedTextEncoding: EditorTextEncoding?
+
+  override func beginOpenPanel(_ openPanel: NSOpenPanel, forTypes inTypes: [String]?) async -> Int {
     if let defaultDirectory = AppRuntimeConfig.defaultOpenDirectory {
       setOpenPanelDirectory(defaultDirectory)
     }
 
-    return await super.beginOpenPanel()
+    openPanel.accessoryView = EditorSaveOptionsView.wrapper(for: .textEncoding) { result in
+      if case .textEncoding(let value) = result {
+        Self.suggestedTextEncoding = value
+      }
+    }
+
+    Self.suggestedTextEncoding = nil
+    return await super.beginOpenPanel(openPanel, forTypes: inTypes)
   }
 }