Remove tex options.

Author: colinc86

README.md

@@ -21,19 +21,20 @@ A SwiftUI view that renders LaTeX equations.
       - [Equation Number Start](#equation-number-start)
       - [Equation Number Offset](#equation-number-offset)
     - [Unencode HTML](#🔗-unencode-html)
-    - [TeX Options](#♾️-tex-options (deprecated))
   - [Caching](#🗄️-caching)
   - [Preloading](#🏃‍♀️-preloading)
 
 ## ℹ️ About
 
-`LaTexSwiftUI` is a package that exposes a view named `LaTeX` that can parse and render TeX and LaTeX equations that contain math-mode marcos.
+`LaTexSwiftUI` is a package that exposes a view named `LaTeX` that can parse and render TeX and LaTeX equations which contain math-mode marcos.
 
 The view utilizes the [MathJaxSwift](https://www.github.com/colinc86/MathJaxSwift) package to render equations with [MathJax](https://www.mathjax.org). Thus, the limitations of the view are heavily influenced by the [limitations](https://docs.mathjax.org/en/v2.7-latest/tex.html#differences) of MathJax.
 
 It will
 - render TeX and LaTeX equations (math-mode macros),
-- and render the `\text{}` macro within equations.
+- render the `\text{}` macro within equations,
+- attempt to render block equations as a Tex or LaTeX engine would,
+- and number block equations (if desired).
 
 It won't
 - render TeX and LaTeX documents (text-mode macros, with the exception of the rule above).
@@ -248,13 +249,18 @@ LaTeX.imageCache.removeAll()
 
 SVGs and images are rendered and cached on demand, but there may be situations where you want to preload the data so that there is minimal lag when the view appears.
 
+SVGs and images are rendered as a result of the view's environment, so it is important to call the `preload` method last in the view's modifier chain if you use it.
+
 ```swift
 VStack {
   ForEach(expressions, id: \.self) { expression in
     LaTeX(expression)
+      .font(.caption2)
+      .foregroundColor(.green)
+      .unencoded()
+      .errorMode(.error)
+      .processEscapes()
       .preload()
   }
 }
 ```
-
-Keep in mind that SVG data and images are rendered as a result of the view's environment, so it is important to call the `preload` method using the same values that will be used when drawing the view.

Sources/LaTeXSwiftUI/Extensions/EnvironmentValues+Extensions.swift

@@ -46,10 +46,6 @@ private struct BlockModeKey: EnvironmentKey {
   static let defaultValue: LaTeX.BlockMode = .blockViews
 }
 
-private struct TeXInputProcessorOptionsKey: EnvironmentKey {
-  static let defaultValue: TeXInputProcessorOptions = TeXInputProcessorOptions(loadPackages: TeXInputProcessorOptions.Packages.all)
-}
-
 private struct ProcessEscapesKey: EnvironmentKey {
   static let defaultValue: Bool = false
 }
@@ -98,12 +94,6 @@ extension EnvironmentValues {
     set { self[BlockModeKey.self] = newValue }
   }
 
-  /// The TeX options of this environment.
-  var texOptions: TeXInputProcessorOptions {
-    get { self[TeXInputProcessorOptionsKey.self] }
-    set { self[TeXInputProcessorOptionsKey.self] = newValue }
-  }
-  
   /// The processEscapes value of this environment.
   var processEscapes: Bool {
     get { self[ProcessEscapesKey.self] }

Sources/LaTeXSwiftUI/Extensions/View+Extensions.swift

@@ -28,6 +28,31 @@ import SwiftUI
 
 public extension View {
 
+  /// Preloads a `LaTeX` view's SVG and image data.
+  ///
+  /// This method should be called last in the view's modifier chain (if at
+  /// all).
+  ///
+  /// - Example:
+  ///
+  /// ```
+  /// LaTeX("Hello, $\\LaTeX$!")
+  ///   .font(.title)
+  ///   .processEscapes()
+  ///   .preload()
+  /// ```
+  ///
+  /// - Note: If the receiver isn't a `LaTeX` view, then this method does
+  ///   nothing.
+  ///
+  /// - Returns: A preloaded view.
+  @MainActor func preload() -> some View {
+    if let latex = self as? LaTeX {
+      latex.preload()
+    }
+    return self
+  }
+  
   /// Sets the image rendering mode for images rendered by MathJax.
   ///
   /// - Parameter mode: The template rendering mode.
@@ -69,24 +94,6 @@ public extension View {
     environment(\.blockMode, mode)
   }
 
-  /// Sets the TeX options for any images rendered with MathJax in this
-  /// environment.
-  ///
-  /// - Note: The environment values `processEscapes`, `equationTags`,
-  ///   `equationTagSide`, and `equationTagIndent` take precedence.
-  ///
-  /// - Parameter options: The TeX input processor options.
-  /// - Returns: A view that uses the given TeX input processor options to
-  ///   render images in its view.
-  @available(*, deprecated, message: """
-This method will be unavailable in the next version. Use the `processEscapes`,
-`equationNumberMode`, `equationNumberStart`, and `equationNumberOffset` methods
-instead.
-""")
-  func texOptions(_ options: TeXInputProcessorOptions) -> some View {
-    environment(\.texOptions, options)
-  }
-  
   /// When set to `true`, you may use `\$` to represent a literal dollar sign,
   /// rather than using it as a math delimiter, and `\\` to represent a literal
   /// backslash (so that you can use `\\\$` to get a literal `\$` or `\\$...$`

Sources/LaTeXSwiftUI/LaTeX.swift

@@ -108,9 +108,6 @@ public struct LaTeX: View {
   /// The view's block rendering mode.
   @Environment(\.blockMode) private var blockMode
 
-  /// The TeX options to pass to MathJax.
-  @Environment(\.texOptions) private var texOptions
-  
   /// Whether the view should process escapes.
   @Environment(\.processEscapes) private var processEscapes
 
@@ -132,9 +129,11 @@ public struct LaTeX: View {
   /// The text's line spacing.
   @Environment(\.lineSpacing) private var lineSpacing
 
-  /// The blocks to render.
-  private var blocks: [ComponentBlock] {
-    let options = texOptions
+  /// The TeX options to use when submitting requests to the renderer.
+  private var texOptions: TeXInputProcessorOptions {
+    let options = TeXInputProcessorOptions()
+    options.processEscapes = processEscapes
+    
     var packages = TeXInputProcessorOptions.Packages.all
     if errorMode != .rendered {
       if let noErrorsIndex = packages.firstIndex(of: TeXInputProcessorOptions.Packages.noerrors) {
@@ -144,15 +143,17 @@ public struct LaTeX: View {
         packages.remove(at: noUndefinedIndex)
       }
     }
-    
     options.loadPackages = packages
-    options.processEscapes = processEscapes
-    
-    return Renderer.shared.render(
+    return options
+  }
+  
+  /// The blocks to render.
+  internal var blocks: [ComponentBlock] {
+    Renderer.shared.render(
       blocks: Parser.parse(unencodeHTML ? latex.htmlUnescape() : latex, mode: parsingMode),
       font: font ?? .body,
       displayScale: displayScale,
-      texOptions: options)
+      texOptions: texOptions)
   }
 
   // MARK: Initializers
@@ -183,102 +184,16 @@ public struct LaTeX: View {
 
 extension LaTeX {
 
-  @MainActor public func preload(
-    unencodeHTML: Bool = false,
-    parsingMode: ParsingMode = .onlyEquations,
-    errorMode: ErrorMode = .rendered,
-    imageRenderingMode: Image.TemplateRenderingMode = .template,
-    font: Font = .body,
-    displayScale: CGFloat = 1.0,
-    processEscapes: Bool
-  ) -> LaTeX {
-    var packages = TeXInputProcessorOptions.Packages.all
-    if errorMode != .rendered {
-      if let noErrorsIndex = packages.firstIndex(of: TeXInputProcessorOptions.Packages.noerrors) {
-        packages.remove(at: noErrorsIndex)
-      }
-      if let noUndefinedIndex = packages.firstIndex(of: TeXInputProcessorOptions.Packages.noundefined) {
-        packages.remove(at: noUndefinedIndex)
-      }
-    }
-    
-    let options = TeXInputProcessorOptions(loadPackages: packages)
-    options.processEscapes = processEscapes
-    
-    // Render the blocks
-    let preloadedBlocks = Renderer.shared.render(
-      blocks: Parser.parse(unencodeHTML ? latex.htmlUnescape() : latex, mode: parsingMode),
-      font: font,
-      displayScale: displayScale,
-      texOptions: options)
-    
-    // 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
-  }
-  
-  /// 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.
-  @available(*, deprecated, message: "This method will be unavailable in the next version.")
-  @MainActor public func preload(
-    unencodeHTML: Bool = false,
-    parsingMode: ParsingMode = .onlyEquations,
-    imageRenderingMode: Image.TemplateRenderingMode = .template,
-    font: Font = .body,
-    displayScale: CGFloat = 1.0,
-    texOptions: TeXInputProcessorOptions? = nil
-  ) -> LaTeX {
-    let options: TeXInputProcessorOptions
-    if let texOptions {
-      options = texOptions
-    }
-    else {
-      var packages = TeXInputProcessorOptions.Packages.all
-      if errorMode != .rendered {
-        if let noErrorsIndex = packages.firstIndex(of: TeXInputProcessorOptions.Packages.noerrors) {
-          packages.remove(at: noErrorsIndex)
-        }
-        if let noUndefinedIndex = packages.firstIndex(of: TeXInputProcessorOptions.Packages.noundefined) {
-          packages.remove(at: noUndefinedIndex)
-        }
-      }
-      
-      options = TeXInputProcessorOptions(loadPackages: packages)
-      options.processEscapes = processEscapes
-    }
-    
-    // Render the blocks
-    let preloadedBlocks = Renderer.shared.render(
-      blocks: Parser.parse(unencodeHTML ? latex.htmlUnescape() : latex, mode: parsingMode),
-      font: font,
-      displayScale: displayScale,
-      texOptions: options)
-    
-    // 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)
-      }
+  /// Preloads the view's SVG and image data.
+  @MainActor public func preload() {
+    switch blockMode {
+    case .alwaysInline:
+      blocksAsText(blocks, forceInline: true)
+    case .blockText:
+      blocksAsText(blocks)
+    case .blockViews:
+      blocksAsStack(blocks)
     }
-    return self
   }
 
 }
@@ -298,8 +213,8 @@ extension LaTeX {
     blocks.map { block in
       let text = text(for: block)
       return block.isEquationBlock && !forceInline ?
-        Text("\n") + text + Text("\n") :
-        text
+      Text("\n") + text + Text("\n") :
+      text
     }.reduce(Text(""), +)
   }
 
@@ -414,6 +329,7 @@ struct LaTeX_Previews: PreviewProvider {
       LaTeX("Hello, $\\LaTeX$!")
         .font(.caption2)
         .foregroundColor(.purple)
+        .preload()
     }
     .fontDesign(.serif)
     .previewLayout(.sizeThatFits)