Refactor renderer.

Author: colinc86

Sources/LaTeXSwiftUI/Extensions/MathJax+Extensions.swift

@@ -0,0 +1,41 @@
+//
+//  MathJax+Extensions.swift
+//  LaTeXSwiftUI
+//
+//  Copyright (c) 2023 Colin Campbell
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to
+//  deal in the Software without restriction, including without limitation the
+//  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+//  sell copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+//  IN THE SOFTWARE.
+//
+
+import Foundation
+import MathJaxSwift
+
+internal extension MathJax {
+  
+  static var svgRenderer: MathJax? = {
+    do {
+      return try MathJax(preferredOutputFormat: .svg)
+    }
+    catch {
+      NSLog("Error creating MathJax instance: \(error)")
+      return nil
+    }
+  }()
+  
+}

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -104,18 +104,18 @@ public struct LaTeX: View {
 
   /// The package's shared data cache.
   public static var dataCache: NSCache<NSString, NSData> {
-    Renderer.shared.cache.dataCache
+    Cache.shared.dataCache
   }
 
 #if os(macOS)
   /// The package's shared image cache.
   public static var imageCache: NSCache<NSString, NSImage> {
-    Renderer.shared.cache.imageCache
+    Cache.shared.imageCache
   }
 #else
   /// The package's shared image cache.
   public static var imageCache: NSCache<NSString, UIImage> {
-    Renderer.shared.cache.imageCache
+    Cache.shared.imageCache
   }
 #endif
 
@@ -156,8 +156,8 @@ public struct LaTeX: View {
 
   // MARK: Private properties
 
-  /// The view's render state.
-  @StateObject private var renderState: LaTeXRenderState
+  /// The view's renderer.
+  @StateObject private var renderer: Renderer
 
   // MARK: Initializers
 
@@ -166,16 +166,16 @@ public struct LaTeX: View {
   /// - Parameter latex: The LaTeX input.
   public init(_ latex: String) {
     self.latex = latex
-    _renderState = StateObject(wrappedValue: LaTeXRenderState(latex: latex))
+    _renderer = StateObject(wrappedValue: Renderer(latex: latex))
   }
 
   // MARK: View body
 
   public var body: some View {
     VStack(spacing: 0) {
-      if renderState.rendered {
+      if renderer.rendered {
         // If our blocks have been rendered, display them
-        bodyWithBlocks(renderState.blocks)
+        bodyWithBlocks(renderer.blocks)
       }
       else if isCached() {
         // If our blocks are cached, display them
@@ -193,7 +193,8 @@ public struct LaTeX: View {
         }
       }
     }
-    .animation(renderingAnimation, value: renderState.rendered)
+    .animation(renderingAnimation, value: renderer.rendered)
+    .environmentObject(renderer)
   }
 
 }
@@ -222,7 +223,7 @@ extension LaTeX {
   /// - Returns: A boolean indicating whether the components to the view are
   ///   cached.
   private func isCached() -> Bool {
-    renderState.isCached(
+    renderer.isCached(
       unencodeHTML: unencodeHTML,
       parsingMode: parsingMode,
       processEscapes: processEscapes,
@@ -233,7 +234,7 @@ extension LaTeX {
 
   /// Renders the view's components.
   @Sendable private func renderAsync() async {
-    await renderState.render(
+    await renderer.render(
       unencodeHTML: unencodeHTML,
       parsingMode: parsingMode,
       processEscapes: processEscapes,
@@ -246,7 +247,7 @@ extension LaTeX {
   ///
   /// - Returns: The rendered components.
   private func renderSync() -> [ComponentBlock] {
-    renderState.renderSync(
+    renderer.renderSync(
       unencodeHTML: unencodeHTML,
       parsingMode: parsingMode,
       processEscapes: processEscapes,
@@ -274,13 +275,10 @@ extension LaTeX {
     switch renderingStyle {
     case .empty:
       Text("")
-        .task(renderAsync)
     case .original:
       Text(latex)
-        .task(renderAsync)
     case .progress:
       ProgressView()
-        .task(renderAsync)
     default:
       EmptyView()
     }

Sources/LaTeXSwiftUI/Models/Cache.swift

@@ -76,17 +76,24 @@ internal class Cache {
 
   // MARK: Static properties
 
-  /// The renderer's data cache.
-  internal let dataCache: NSCache<NSString, NSData> = NSCache()
+  /// The shared cache.
+  static let shared = Cache()
 
-  /// Semaphore for thread-safe access to `dataCache`.
-  internal let dataCacheSemaphore = DispatchSemaphore(value: 1)
+  // MARK: Public properties
+  
+  /// The renderer's data cache.
+  let dataCache: NSCache<NSString, NSData> = NSCache()
 
   /// The renderer's image cache.
-  internal let imageCache: NSCache<NSString, _Image> = NSCache()
+  let imageCache: NSCache<NSString, _Image> = NSCache()
+  
+  // MARK: Private properties
+  
+  /// Semaphore for thread-safe access to `dataCache`.
+  let dataCacheSemaphore = DispatchSemaphore(value: 1)
 
   /// Semaphore for thread-safe access to `imageCache`.
-  internal let imageCacheSemaphore = DispatchSemaphore(value: 1)
+  let imageCacheSemaphore = DispatchSemaphore(value: 1)
 
 }
 

Sources/LaTeXSwiftUI/Models/Component.swift

@@ -44,26 +44,6 @@ internal struct ComponentBlock: Hashable, Identifiable {
     components.count == 1 && !components[0].type.inline
   }
 
-  /// Creates the image view and its size for the given block.
-  ///
-  /// If the block isn't an equation block, then this method returns `nil`.
-  ///
-  /// - Parameter block: The block.
-  /// - Returns: The image, its size, and any associated error text.
-  @MainActor func image(
-    font: Font,
-    displayScale: CGFloat,
-    renderingMode: Image.TemplateRenderingMode
-  ) -> (Image, CGSize, String?)? {
-    guard isEquationBlock, let component = components.first else {
-      return nil
-    }
-    return component.convertToImage(
-      font: font,
-      displayScale: displayScale,
-      renderingMode: renderingMode)
-  }
-  
 }
 
 /// A LaTeX component.
@@ -203,91 +183,3 @@ internal struct Component: CustomStringConvertible, Equatable, Hashable {
   }
 
 }
-
-// MARK: Methods
-
-extension Component {
-  
-  /// Converts the component to a `Text` view.
-  ///
-  /// - Parameters:
-  ///   - font: The font to use.
-  ///   - displayScale: The view's display scale.
-  ///   - renderingMode: The image rendering mode.
-  ///   - errorMode: The error handling mode.
-  ///   - isLastComponentInBlock: Whether or not this is the last component in
-  ///     the block that contains it.
-  /// - Returns: A text view.
-  @MainActor func convertToText(
-    font: Font,
-    displayScale: CGFloat,
-    renderingMode: Image.TemplateRenderingMode,
-    errorMode: LaTeX.ErrorMode,
-    blockRenderingMode: LaTeX.BlockMode,
-    isInEquationBlock: Bool
-  ) -> Text {
-    // Get the component's text
-    let text: Text
-    if let svg = svg {
-      // Do we have an error?
-      if let errorText = svg.errorText, errorMode != .rendered {
-        switch errorMode {
-        case .original:
-          // Use the original tex input
-          text = Text(blockRenderingMode == .alwaysInline ? originalTextTrimmingNewlines : originalText)
-        case .error:
-          // Use the error text
-          text = Text(errorText)
-        default:
-          text = Text("")
-        }
-      }
-      else if let (image, _, _) = convertToImage(
-        font: font,
-        displayScale: displayScale,
-        renderingMode: renderingMode
-      ) {
-        let xHeight = _Font.preferredFont(from: font).xHeight
-        let offset = svg.geometry.verticalAlignment.toPoints(xHeight)
-        text = Text(image).baselineOffset(blockRenderingMode == .alwaysInline || !isInEquationBlock ? offset : 0)
-      }
-      else {
-        text = Text("")
-      }
-    }
-    else if blockRenderingMode == .alwaysInline {
-      text = Text(originalTextTrimmingNewlines)
-    }
-    else {
-      text = Text(originalText)
-    }
-    
-    return text
-  }
-  
-  /// Converts the component to an image.
-  ///
-  /// - Parameters:
-  ///   - font: The font to use.
-  ///   - displayScale: The current display scale.
-  ///   - renderingMode: The current rendering mode.
-  /// - Returns: Image details.
-  @MainActor func convertToImage(
-    font: Font,
-    displayScale: CGFloat,
-    renderingMode: Image.TemplateRenderingMode
-  ) -> (Image, CGSize, String?)? {
-    guard let svg = svg else {
-      return nil
-    }
-    guard let imageData = Renderer.shared.convertToImage(
-      svg: svg,
-      font: font,
-      displayScale: displayScale,
-      renderingMode: renderingMode) else {
-      return nil
-    }
-    return (imageData.0, imageData.1, svg.errorText)
-  }
-  
-}