Combine statistics for selection and full doc

Author: cyanzhong

CoreEditor/src/bridge/web/core.ts

@@ -1,6 +1,6 @@
 import { WebModule } from '../webModule';
 import {
-  ReadableContent,
+  ReadableContentPair,
   ReplaceGranularity,
   resetEditor,
   clearEditor,
@@ -22,7 +22,7 @@ export interface WebModuleCore extends WebModule {
   resetEditor({ text }: { text: string }): void;
   clearEditor(): void;
   getEditorText(): string;
-  getReadableContent(): ReadableContent;
+  getReadableContent(): ReadableContentPair;
   insertText({ text, from, to }: { text: string; from: CodeGen_Int; to: CodeGen_Int }): void;
   replaceText({ text, granularity }: { text: string; granularity: ReplaceGranularity }): void;
   handleFocusLost(): void;
@@ -43,7 +43,7 @@ export class WebModuleCoreImpl implements WebModuleCore {
     return getEditorText();
   }
 
-  getReadableContent(): ReadableContent {
+  getReadableContent(): ReadableContentPair {
     return getReadableContent();
   }
 

CoreEditor/src/core.ts

@@ -19,11 +19,15 @@ import { markContentClean } from './modules/history';
 import { TextEditor } from './api/editor';
 import { editorReadyListeners } from './api/methods';
 
-export interface ReadableContent {
-  selectionBased: boolean;
+type ReadableContent = {
   sourceText: string;
   trimmedText: string;
   commentCount: CodeGen_Int;
+};
+
+export interface ReadableContentPair {
+  fullText: ReadableContent;
+  selection?: ReadableContent;
 }
 
 export enum ReplaceGranularity {
@@ -164,22 +168,26 @@ export function getEditorText() {
   return lines.join(state.lineBreak);
 }
 
-export function getReadableContent(): ReadableContent {
-  // Extract the source to show the statistics view,
-  // use the selected text if the selection is not empty.
-  const selectedText = selectedMainText();
-  const selectionBased = selectedText.length > 0;
-  const sourceText = selectionBased ? selectedText : getEditorText();
-
-  // Remove front matter and extract comments
-  const actualText = removeFrontMatter(sourceText);
-  const { trimmedText, commentCount } = extractComments(actualText);
+export function getReadableContent(): ReadableContentPair {
+  const getContent = (sourceText: string): ReadableContent => {
+    // Remove front matter and extract comments
+    const actualText = removeFrontMatter(sourceText);
+    const { trimmedText, commentCount } = extractComments(actualText);
+
+    return {
+      sourceText,
+      trimmedText,
+      commentCount: commentCount as CodeGen_Int,
+    };
+  };
 
   return {
-    selectionBased,
-    sourceText,
-    trimmedText,
-    commentCount: commentCount as CodeGen_Int,
+    fullText: getContent(getEditorText()),
+    selection: (() => {
+      // Get readable content for selection if the selection is not empty.
+      const selectedText = selectedMainText();
+      return selectedText.length > 0 ? getContent(selectedText) : undefined;
+    })(),
   };
 }
 

MarkEditKit/Sources/Bridge/Web/Generated/WebBridgeCore.swift

@@ -44,7 +44,7 @@ public final class WebBridgeCore {
     }
   }
 
-  public func getReadableContent() async throws -> ReadableContent {
+  public func getReadableContent() async throws -> ReadableContentPair {
     return try await withCheckedThrowingContinuation { continuation in
       webView?.invoke(path: "webModules.core.getReadableContent") { result in
         Task { @MainActor in
@@ -115,14 +115,22 @@ public final class WebBridgeCore {
   }
 }
 
+public struct ReadableContentPair: Codable {
+  public var fullText: ReadableContent
+  public var selection: ReadableContent?
+
+  public init(fullText: ReadableContent, selection: ReadableContent?) {
+    self.fullText = fullText
+    self.selection = selection
+  }
+}
+
 public struct ReadableContent: Codable {
-  public var selectionBased: Bool
   public var sourceText: String
   public var trimmedText: String
   public var commentCount: Int
 
-  public init(selectionBased: Bool, sourceText: String, trimmedText: String, commentCount: Int) {
-    self.selectionBased = selectionBased
+  public init(sourceText: String, trimmedText: String, commentCount: Int) {
     self.sourceText = sourceText
     self.trimmedText = trimmedText
     self.commentCount = commentCount

MarkEditMac/Modules/Package.swift

@@ -91,7 +91,7 @@ let package = Package(
     ),
     .target(
       name: "FileVersion",
-      dependencies: ["MarkEditKit", "AppKitControls"],
+      dependencies: ["AppKitControls", "MarkEditKit"],
       path: "Sources/FileVersion",
       swiftSettings: [
         .enableExperimentalFeature("StrictConcurrency")
@@ -113,7 +113,7 @@ let package = Package(
     ),
     .target(
       name: "Previewer",
-      dependencies: ["MarkEditKit", "AppKitExtensions"],
+      dependencies: ["AppKitExtensions", "MarkEditKit"],
       path: "Sources/Previewer",
       resources: [
         .process("Resources"),
@@ -138,7 +138,7 @@ let package = Package(
     ),
     .target(
       name: "Statistics",
-      dependencies: ["AppKitExtensions"],
+      dependencies: ["AppKitExtensions", "MarkEditKit"],
       path: "Sources/Statistics",
       swiftSettings: [
         .enableExperimentalFeature("StrictConcurrency")

MarkEditMac/Modules/Sources/Statistics/StatisticsController.swift

@@ -6,6 +6,7 @@
 
 import AppKit
 import SwiftUI
+import MarkEditKit
 
 /**
  UI to show statistics of text.
@@ -16,23 +17,17 @@ public final class StatisticsController: NSViewController {
     static let contentHeight: Double = 288
   }
 
-  private let sourceText: String
-  private let trimmedText: String
-  private let commentCount: Int
+  private let content: ReadableContentPair
   private let fileURL: URL?
   private let localizable: StatisticsLocalizable
   private var contentView: NSView?
 
   public init(
-    sourceText: String,
-    trimmedText: String,
-    commentCount: Int,
+    content: ReadableContentPair,
     fileURL: URL?,
     localizable: StatisticsLocalizable
   ) {
-    self.sourceText = sourceText
-    self.trimmedText = trimmedText
-    self.commentCount = commentCount
+    self.content = content
     self.fileURL = fileURL
     self.localizable = localizable
     super.init(nibName: nil, bundle: nil)
@@ -68,21 +63,19 @@ public final class StatisticsController: NSViewController {
       spinner.heightAnchor.constraint(equalToConstant: 24),
     ])
 
-    DispatchQueue.global(qos: .userInitiated).async {
-      // Natural language processing is time-consuming for large documents
-      let tokenizedResult = Tokenizer.tokenize(
-        sourceText: self.sourceText,
-        trimmedText: self.trimmedText,
-        commentCount: self.commentCount
-      )
+    // Natural language processing is time-consuming for large documents
+    Task.detached(priority: .userInitiated) {
+      let fullResult = self.content.fullText.tokenized
+      let selectionResult = self.content.selection?.tokenized
 
       // Remove the spinner and show the result view on main thread
       DispatchQueue.main.async {
         spinner.stopAnimation(nil)
         spinner.removeFromSuperview()
 
         let contentView = NSHostingView(rootView: StatisticsView(
-          tokenizedResult: tokenizedResult,
+          fullResult: fullResult,
+          selectionResult: selectionResult,
           fileURL: self.fileURL,
           localizable: self.localizable
         ))
@@ -94,8 +87,27 @@ public final class StatisticsController: NSViewController {
     }
   }
 
+  override public func viewDidAppear() {
+    super.viewDidAppear()
+    view.window?.makeFirstResponder(self)
+  }
+
   override public func viewDidLayout() {
     super.viewDidLayout()
     contentView?.frame = view.bounds
   }
 }
+
+extension ReadableContentPair: @unchecked @retroactive Sendable {}
+
+// MARK: - Private
+
+private extension ReadableContent {
+  var tokenized: Tokenizer.Result {
+    Tokenizer.tokenize(
+      sourceText: sourceText,
+      trimmedText: trimmedText,
+      commentCount: commentCount
+    )
+  }
+}

MarkEditMac/Modules/Sources/Statistics/StatisticsLocalizable.swift

@@ -8,6 +8,8 @@ import Foundation
 
 public struct StatisticsLocalizable {
   let mainTitle: String
+  let selection: String
+  let document: String
   let characters: String
   let words: String
   let sentences: String
@@ -18,6 +20,8 @@ public struct StatisticsLocalizable {
 
   public init(
     mainTitle: String,
+    selection: String,
+    document: String,
     characters: String,
     words: String,
     sentences: String,
@@ -27,6 +31,8 @@ public struct StatisticsLocalizable {
     fileSize: String
   ) {
     self.mainTitle = mainTitle
+    self.selection = selection
+    self.document = document
     self.characters = characters
     self.words = words
     self.sentences = sentences

MarkEditMac/Modules/Sources/Statistics/Views/StatisticsView.swift

@@ -5,28 +5,67 @@
 //
 
 import AppKit
+import AppKitExtensions
 import SwiftUI
 
 struct StatisticsView: View {
-  private let tokenizedResult: Tokenizer.Result
+  private let fullResult: Tokenizer.Result
+  private let selectionResult: Tokenizer.Result?
   private let fileURL: URL?
   private let localizable: StatisticsLocalizable
 
+  @State private var viewingMode: ViewingMode = .selection
+  @State private var localMonitor: Any?
+
   init(
-    tokenizedResult: Tokenizer.Result,
+    fullResult: Tokenizer.Result,
+    selectionResult: Tokenizer.Result?,
     fileURL: URL?,
     localizable: StatisticsLocalizable
   ) {
-    self.tokenizedResult = tokenizedResult
+    self.fullResult = fullResult
+    self.selectionResult = selectionResult
     self.fileURL = fileURL
     self.localizable = localizable
   }
 
   var body: some View {
     VStack(spacing: 0) {
-      Text(localizable.mainTitle)
-        .fontWeight(.semibold)
-        .frame(height: 36)
+      VStack {
+        if selectionResult != nil {
+          Picker(localizable.mainTitle, selection: $viewingMode) {
+            Text(localizable.selection).tag(ViewingMode.selection)
+            Text(localizable.document).tag(ViewingMode.document)
+          }
+          .labelsHidden() // Hide the label while keeping the accessibility
+          .pickerStyle(.segmented)
+          .padding()
+          .onAppear {
+            localMonitor = NSEvent.addLocalMonitorForEvents(matching: .keyDown) { event in
+              switch event.keyCode {
+              case .kVK_LeftArrow:
+                viewingMode = .selection
+                return nil
+              case .kVK_RightArrow:
+                viewingMode = .document
+                return nil
+              default:
+                return event
+              }
+            }
+          }
+          .onDisappear {
+            if let localMonitor {
+              NSEvent.removeMonitor(localMonitor)
+              self.localMonitor = nil
+            }
+          }
+        } else {
+          Text(localizable.mainTitle)
+            .fontWeight(.semibold)
+        }
+      }
+      .frame(height: 36)
 
       Divider()
 
@@ -72,7 +111,8 @@ struct StatisticsView: View {
             )
           }
 
-          if let fileSize = FileSize.readableSize(of: fileURL) {
+          // The file size is shown only when we are viewing the full document
+          if isViewingDocument, let fileSize = FileSize.readableSize(of: fileURL) {
             StatisticsCell(
               iconName: Icons.fileSize,
               titleText: localizable.fileSize,
@@ -91,12 +131,32 @@ struct StatisticsView: View {
 
 // MARK: - Private
 
-private enum Icons {
-  static let characters = "textformat"
-  static let words = "text.bubble"
-  static let sentences = "textformat.abc.dottedunderline"
-  static let paragraphs = "paragraphsign"
-  static let comments = "eye.slash"
-  static let readTime = "stopwatch"
-  static let fileSize = "doc.text.below.ecg"
+private extension StatisticsView {
+  enum ViewingMode: Int {
+    case selection = 0
+    case document = 1
+  }
+
+  enum Icons {
+    static let characters = "textformat"
+    static let words = "text.bubble"
+    static let sentences = "textformat.abc.dottedunderline"
+    static let paragraphs = "paragraphsign"
+    static let comments = "eye.slash"
+    static let readTime = "stopwatch"
+    static let fileSize = "doc.text.below.ecg"
+  }
+
+  var isViewingDocument: Bool {
+    // We are viewing full document if there's no selection, or we explicitly selected the document section
+    selectionResult == nil || viewingMode == .document
+  }
+
+  var tokenizedResult: Tokenizer.Result {
+    if !isViewingDocument, let selectionResult {
+      return selectionResult
+    }
+
+    return fullResult
+  }
 }