Correctly preview non-text files (#1707)

* Package.resolved changed

* progress

* minor doc change in CodeEditUI EffectView

* add WorkspacePdfFileView

* allow WorkspacePdfFileView to be able to send data to SwiftUI

* properly name `WorkspacePdfFileView` to `WorkspacePDFView`

* improve WorkspacePDFView docs

* add guards to WorkspacePDFView (makeNSView, updateNSView)

* wip

* wip 2

* correct padding

* progress? not

* add attachPDFDocumentToView helper in WorkspacePDFView

* update WorkspacePDFView docs

* remove WorkspaceNonTextFileView

* fix SwiftLint violations in WorkspacePDFView, WorkspaceCodeFileView

* add magic numbers comment to WorkspaceCodeFileView

* update WorkspacePDFView docs

* before i forget

* progressss

* too slow

* wip: the best work yet

* it really works!!

* add WorkspaceImageView

* add WorkspaceCannotPreviewFileView

* its working very predictably but showing/hiding navigator pane isn't smooth

* remove the use of canPreview as it can cause unexpected behaviour

* remove computeFrame helper in WorkspaceCodeFileView

* update PDF preview's background color

* add note for when PDF preview cannot create PDF document

* improve docs for WorkspaceImageView & WorkspacePDFView

* use unnamed parameter for imageUrl in WorkspaceImageView

* implement `WorkspaceCannotPreviewFileView`

* change url variables in `WorkspaceImageView`, `WorkspacePDFView` & `WorkspaceCannotPreviewFileView` to private

* add `WorkspaceLoadingView`

* spacing violation

* change onAppear modifier in WorkspaceCannotPreviewFileView

* remove `WorkspaceCannotPreviewFileView` as it creates a bug that makes thumbnailing slightly unpredictable

Will use QLPreview instead

* improve docs in `WorkspacePDFView` & `WorkspaceImageView`

* use `WorkspaceAnyFileView` to preview GIF images

* add a note to the documentation for `CodeFileDocument.utType`

* add `WorkspaceAnyFileView` to properly preview files of different file types

* rearrange files in `CodeEdit/Features/Documents/Views`

* add `WorkspaceAnyFileView`, `WorkspaceLoadingView`, `WorkspaceImageView`,  & `WorkspacePDFView` to DocC Documentation

* update docs in `WorkspaceAnyFileView`, `WorkspaceLoadingView`, `WorkspaceImageView`,  & `WorkspacePDFView`

* rename `CodeFileDocument.typeOfFile` to `CodeFileDocument.utType`

* fix: allow GIF previews to play, and with their proper dimensions

* do not return
data UTType from CodeFileDocument.utType

* update docs for CodeFileDocument.utType

* change conformance from movie to audiovisualContent in CodeFileDocument.utType

* properly display CodeFileView contents by undo-ing the padding in its parent view

* remove text, image, PDF, video restrictions on `CodeFileDocument.utType`

* update docs in WorkspaceImageView

* WorkspaceCodeFileView: group non-text files, so they inherit modifiers from the parent Group view

* WorkspaceCodeFileView: add important note on document.utType

* remove SwiftUI VideoPlayer view for now, it creates a bug that I can't work around

- the first play click doesn't start the video, but the audio starts playing in the background, even after closing the editor tab
- and everything in-between

* add `NonTextFileView` to clean up code

- NonTextFileView, OtherFileView, URL+isImage, are not needed anymore

* remove QLPreviewItem subclass from CodeFileDocument

* rename `WorkspaceCodeFileView` to `EditorAreaFileView`

* rename `EditorView` to `EditorAreaView`

- also added the view to the App Window docs

* rename 4 Workspace view files

- `WorkspaceAnyFileView` -> `AnyFileView`
- `WorkspaceLoadingView` -> `LoadingFileView`
- `WorkspaceImageView` -> `ImageFileView`
- `WorkspacePDFView` -> `PDFFileView`

* move views for opening files to `CodeEdit/Features/Editor`

* move `CodeFileDocument` to `CodeEdit/Features/Documents`

* NSTableViewWrapper: minor change in comment

* move `WindowCodeFileView` to `CodeEdit/Features/Editor/Views`

* use `AnyFileView` to view all images

- this removes the need to check for GIF images
- this also has a nice add-on of using gestures for zoom

Author: plbstl

CodeEdit.xcodeproj/project.pbxproj

@@ -26,7 +26,7 @@ struct EffectView: NSViewRepresentable {
     ///
     /// By setting the
     /// [`emphasized`](https://developer.apple.com/documentation/appkit/nsvisualeffectview/1644721-isemphasized)
-    /// flag the emphasized state of the material will be used if available.
+    /// flag, the emphasized state of the material will be used if available.
     ///
     /// - Parameters:
     ///   - material: The material to use. Defaults to `.headerView`.

CodeEdit.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -1,5 +1,5 @@
 //
-//  CodeFile.swift
+//  CodeFileDocument.swift
 //  CodeEditModules/CodeFile
 //
 //  Created by Rehatbir Singh on 12/03/2022.
@@ -9,7 +9,6 @@ import AppKit
 import Foundation
 import SwiftUI
 import UniformTypeIdentifiers
-import QuickLookUI
 import CodeEditSourceEditor
 import CodeEditTextView
 import CodeEditLanguages
@@ -22,7 +21,7 @@ enum CodeFileError: Error {
 }
 
 @objc(CodeFileDocument)
-final class CodeFileDocument: NSDocument, ObservableObject, QLPreviewItem {
+final class CodeFileDocument: NSDocument, ObservableObject {
     struct OpenOptions {
         let cursorPositions: [CursorPosition]
     }
@@ -41,37 +40,33 @@ final class CodeFileDocument: NSDocument, ObservableObject, QLPreviewItem {
     /// Document-specific overridden line wrap preference.
     @Published var wrapLines: Bool?
 
-    /*
-     This is the main type of the document.
-     For example, if the file is end with '.png', it will be an image,
-     if the file is end with '.py', it will be a text file.
-     If text content is not empty, return text
-     If its neither image or text, this could be nil.
-    */
-    var typeOfFile: UTType? {
+    /// The type of data this document contains.
+    ///
+    /// If for example, the file ends with `.py`, its type is a text file.
+    /// Or if it ends with `.png`, then it is an image.
+    /// Same goes for PDF and video formats.
+    ///
+    /// Also, if the text content is not empty, it is a text file.
+    ///
+    /// - Note: The UTType doesn't necessarily mean the file extension, it can be the MIME
+    /// type or any other form of data representation.
+    var utType: UTType? {
         if !self.content.isEmpty {
-            return UTType.text
+            return .text
         }
         guard let fileType, let type = UTType(fileType) else {
             return nil
         }
-        if type.conforms(to: UTType.image) {
-            return UTType.image
+        if type.conforms(to: .text) {
+            return .text
         }
-        if type.conforms(to: UTType.text) {
-            return UTType.text
+        if type.conforms(to: .image) {
+            return .image
         }
-        if type.conforms(to: .data) {
-            return .data
+        if type.conforms(to: .pdf) {
+            return .pdf
         }
-        return nil
-    }
-
-    /*
-     This is the QLPreviewItemURL
-     */
-    var previewItemURL: URL? {
-        fileURL
+        return type
     }
 
     /// Specify options for opening the file such as the initial cursor positions.

CodeEdit/Features/CodeEditUI/Views/EffectView.swift

@@ -0,0 +1,36 @@
+//
+//  AnyFileView.swift
+//  CodeEdit
+//
+//  Created by Paul Ebose on 2024/5/9.
+//
+
+import SwiftUI
+import QuickLookUI
+
+/// A view for previewing any kind of file.
+///
+/// ```swift
+/// AnyFileView(fileURL)
+/// ```
+/// If the file cannot be previewed, a file icon thumbnail is shown instead.
+struct AnyFileView: NSViewRepresentable {
+
+    /// URL of the file to preview. You can pass in any file type.
+    private let fileURL: URL
+
+    init(_ fileURL: URL) {
+        self.fileURL = fileURL
+    }
+
+    func makeNSView(context: Context) -> QLPreviewView {
+        let qlPreviewView = QLPreviewView()
+        qlPreviewView.previewItem = fileURL as any QLPreviewItem
+        return qlPreviewView
+    }
+
+    func updateNSView(_ qlPreviewView: QLPreviewView, context: Context) {
+        qlPreviewView.previewItem = fileURL as any QLPreviewItem
+    }
+
+}