Merge branch 'develop'

Author: colinc86

Package.resolved

@@ -18,7 +18,6 @@ let package = Package(
      .package(url: "https://github.com/colinc86/MathJaxSwift", from: "3.2.2"),
      .package(url: "https://github.com/exyte/SVGView", from: "1.0.4"),
      .package(url: "https://github.com/kean/Nuke", from: "11.3.1"),
-     .package(url: "https://github.com/apple/swift-log", from: "1.4.4"),
      .package(url: "https://github.com/Kitura/swift-html-entities", from: "4.0.1")
   ],
   targets: [
@@ -28,7 +27,6 @@ let package = Package(
         "MathJaxSwift",
         "SVGView",
         "Nuke",
-        .product(name: "Logging", package: "swift-log"),
         .product(name: "HTMLEntities", package: "swift-html-entities")
       ]),
     .testTarget(

Package.swift

@@ -25,7 +25,7 @@ A SwiftUI view that renders LaTeX.
 Add the dependency to your package manifest file.
 
 ```swift
-.package(url: "https://github.com/colinc86/LaTeXSwiftUI", from: "1.0.0")
+.package(url: "https://github.com/colinc86/LaTeXSwiftUI", from: "1.0.3")
 ```
 
 ## ⌨️ Usage

README.md

@@ -133,15 +133,35 @@ extension LaTeX {
 
   /// Preloads the view's components.
   ///
+  /// - Note: You must set this method's parameters the same as its environment
+  ///   or call it is ineffective and adds additional computational overhead.
+  ///
   /// - Returns: A LaTeX view whose components have been preloaded.
-  @MainActor public func preload() -> LaTeX {
-    switch blockMode {
-    case .alwaysInline:
-      blocksAsText(blocks, forceInline: true)
-    case .blockText:
-      blocksAsText(blocks)
-    case .blockViews:
-      blocksAsStack(blocks)
+  @MainActor public func preload(
+    unencodeHTML: Bool = false,
+    parsingMode: ParsingMode = .onlyEquations,
+    imageRenderingMode: Image.TemplateRenderingMode = .template,
+    font: Font = .body,
+    displayScale: CGFloat = 1.0,
+    texOptions: TeXInputProcessorOptions = TeXInputProcessorOptions(loadPackages: TeXInputProcessorOptions.Packages.all)
+  ) -> LaTeX {
+    // Render the blocks
+    let preloadedBlocks = Renderer.shared.render(
+      blocks: Parser.parse(unencodeHTML ? latex.htmlUnescape() : latex, mode: parsingMode),
+      font: font,
+      displayScale: displayScale,
+      texOptions: texOptions)
+    
+    // Render the images
+    for block in preloadedBlocks {
+      for component in block.components where component.type.isEquation {
+        guard let svg = component.svg else { continue }
+        _ = Renderer.shared.convertToImage(
+          svg: svg,
+          font: font,
+          displayScale: displayScale,
+          renderingMode: imageRenderingMode)
+      }
     }
     return self
   }

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -13,7 +13,7 @@ internal struct Parser {
   // MARK: Types
 
   /// An equation component.
-  private struct EquationComponent<T, U> {
+  struct EquationComponent<T, U> {
     let regex: Regex<T>
     let terminatingRegex: Regex<U>
     let equation: Component.ComponentType
@@ -23,42 +23,42 @@ internal struct Parser {
   // MARK: Private properties
 
   /// An inline equation component.
-  private static let inline = EquationComponent(
+  static let inline = EquationComponent(
     regex: #/\$(.|\s)*?\$/#,
     terminatingRegex: #/\$/#,
     equation: .inlineEquation,
     supportsRecursion: false)
 
   /// An TeX-style block equation component.
-  private static let tex = EquationComponent(
+  static let tex = EquationComponent(
     regex: #/\$\$(.|\s)*?\$\$/#,
     terminatingRegex: #/\$\$/#,
     equation: .texEquation,
     supportsRecursion: false)
 
   /// A block equation.
-  private static let block = EquationComponent(
+  static let block = EquationComponent(
     regex: #/\\\[(.|\s)*?\\\]/#,
     terminatingRegex: #/\\\]/#,
     equation: .blockEquation,
     supportsRecursion: false)
 
   /// A named equation component.
-  private static let named = EquationComponent(
-    regex: #/\\begin{equation}(.|\s)*\\end{equation}/#,
+  static let named = EquationComponent(
+    regex: #/\\begin{equation}(.|\s)*?\\end{equation}/#,
     terminatingRegex: #/\\end{equation}/#,
     equation: .namedEquation,
     supportsRecursion: true)
 
   /// A named no number equation component.
-  private static let namedNoNumber = EquationComponent(
-    regex: #/\\begin{equation\*}(.|\s)*\\end{equation\*}/#,
+  static let namedNoNumber = EquationComponent(
+    regex: #/\\begin{equation\*}(.|\s)*?\\end{equation\*}/#,
     terminatingRegex: #/\\end{equation\*}/#,
     equation: .namedNoNumberEquation,
     supportsRecursion: true)
 
   // Order matters
-  private static let allEquations: [EquationComponent] = [
+  static let allEquations: [EquationComponent] = [
     inline,
     tex,
     block,
@@ -185,22 +185,3 @@ extension Parser {
   }
 
 }
-
-// MARK: Private static methods
-
-extension Parser {
-  
-  /// Determines if an index is smaller than all of the indexes in another
-  /// array.
-  ///
-  /// - Parameters:
-  ///   - index: The index to compare.
-  ///   - indexes: The indexes. The value `index` should not be present in this.
-  /// - Returns: A boolean.
-  private static func isSmallest(_ index: String.Index?, outOf indexes: [String.Index?]) -> Bool {
-    guard let index = index else { return false }
-    let indexes = indexes.filter({ $0 != nil }).map({ $0! }) as! [String.Index]
-    return indexes.first(where: { $0 < index }) == nil
-  }
-  
-}

Sources/LaTeXSwiftUI/Models/Logger.swift

@@ -91,7 +91,7 @@ internal class Renderer {
       dataCache = try DataCache(name: "mathJaxRenderDataCache")
     }
     catch {
-      logError("Error creating DataCache instance: \(error)")
+      NSLog("Error creating DataCache instance: \(error)")
       dataCache = nil
     }
 
@@ -101,7 +101,7 @@ internal class Renderer {
       mathjax = try MathJax(preferredOutputFormat: .svg)
     }
     catch {
-      logError("Error creating MathJax instance: \(error)")
+      NSLog("Error creating MathJax instance: \(error)")
       mathjax = nil
     }
   }
@@ -139,7 +139,7 @@ extension Renderer {
         newBlocks.append(ComponentBlock(components: newComponents))
       }
       catch {
-        logError("Error rendering block: \(error)")
+        NSLog("Error rendering block: \(error)")
         newBlocks.append(block)
         continue
       }