asciidoctor-pdf-mathjax 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4129aed907ee9beb5d7a2c523a0ed1ffb783502aed7184f687305a051ec60afe
-  data.tar.gz: 5dcf3ee6fb448dd253b3fbafbc0ecdf879035744d490e192779f3cb0c0180015
+  metadata.gz: 3fc66d0f0c7026c39d6363d44464ad9c5f430aed3202b344de302604679d3166
+  data.tar.gz: 62009314bb1e5e72e759e2251ce7eaa7ffc14bb123a365a9c0f88dcc58d04bac
 SHA512:
-  metadata.gz: 208a3e49a730fabb7eddce46b1ab711abd1765716c5647bfce354865b89e5553289d9b00c610f952daefbd9b6152b3718ceb94f90055aa44517867e948c6c09e
-  data.tar.gz: e018fbd87bd4e13675aaef9803c6e41505abdb80c952d07185d1a26d78a4cc56d59016a343836c4d437783fea07a299653de9a3d999c22652a95cb0e8d62b707
+  metadata.gz: 5234f95491bf7ec6320942e21c009f77575567a4312b1651e13736f19b1cb85d8eeee8cd9b3e443e483628c0b1e7d18847384cb98e9b4cab5efafb539973bcc8
+  data.tar.gz: 7e89244f2911bc889e4f2a3cdd2d34fc31fde201bacac64a0d995ddcbfbd14afe367e98c20922c828ce80bed93e0e05877cd2dbfb81fd655adda92e5c396a6e0

data/bin/render.js

@@ -2,10 +2,17 @@
 
 const mj = require('mathjax-node');
 
-const latex = process.argv[2];
-const format = process.argv[3];
-const pixels_per_ex = parseInt(process.argv[4]);
-const font = process.argv[5];
+// Two modes:
+//   render.js <latex> <format> <pixels_per_ex> <font>
+//     renders one formula, prints the SVG and exits.
+//   render.js --server <font>
+//     starts MathJax once and renders one formula per line of stdin,
+//     {"math": "...", "format": "TeX", "ex": 6}, answering with one line
+//     per formula, {"svg": "..."} or {"error": "..."}.
+// Starting MathJax takes seconds; the server mode pays that once per font
+// instead of once per formula.
+const server = process.argv[2] === '--server';
+const font = server ? process.argv[3] : process.argv[5];
 
 mj.config({
   MathJax: {
@@ -26,6 +33,26 @@ async function convertToSvg(latex, format, pixels_per_ex) {
   return data.svg;
 }
 
-convertToSvg(latex, format, pixels_per_ex).then(svg => {
-  console.log(svg);
-}).catch(err => console.error(err));
+if (server) {
+  let queue = Promise.resolve();
+  require('readline').createInterface({ input: process.stdin }).on('line', line => {
+    queue = queue.then(async () => {
+      let answer;
+      try {
+        const request = JSON.parse(line);
+        answer = { svg: await convertToSvg(request.math, request.format, request.ex) };
+      } catch (err) {
+        answer = { error: String(err) };
+      }
+      process.stdout.write(JSON.stringify(answer) + '\n');
+    });
+  });
+} else {
+  const latex = process.argv[2];
+  const format = process.argv[3];
+  const pixels_per_ex = parseInt(process.argv[4]);
+
+  convertToSvg(latex, format, pixels_per_ex).then(svg => {
+    console.log(svg);
+  }).catch(err => console.error(err));
+}

data/lib/asciidoctor-pdf-mathjax.rb

@@ -1,5 +1,6 @@
 require 'asciidoctor-pdf' unless Asciidoctor::Converter.for 'pdf'
 require 'open3'
+require 'json'
 require 'tempfile'
 require 'rexml/document'
 require 'ttfunk'
@@ -16,6 +17,7 @@ FALLBACK_FONT_COLOR = '#000000'
 
 class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
   register_for 'pdf'
+  FontAttributes = Struct.new(:font_size, :font_color, :font_full_height, :font_baseline)
 
   @tempfiles = []
   class << self
@@ -81,13 +83,14 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
 
     theme = (load_theme node.document)
     math_font = node.document.attributes['math-font'] || MATHJAX_DEFAULT_FONT_FAMILY
+    font = analyze_embedding_font(node, theme)
 
     svg_output, error = stem_to_svg(latex_content, true, math_font)
     if svg_output.nil? || svg_output.empty?
       logger.warn "Error processing stem: #{error || 'No SVG output'}"
       return super
     end
-    adjusted_svg, svg_width = adjust_svg_to_match_text(svg_output, node, theme)
+    adjusted_svg, svg_width = adjust_svg_to_match_text(svg_output, font)
     tmp_svg = Tempfile.new(%w[stem- .svg])
     self.class.tempfiles << tmp_svg
     begin
@@ -95,7 +98,7 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
       tmp_svg.close
 
       logger.debug "Successfully embedded stem inline #{node.text} with font #{math_font} as SVG image"
-      quoted_text = "<img src=\"#{tmp_svg.path}\" format=\"svg\" width=\"#{svg_width}\" alt=\"#{node.text}\">"
+      quoted_text = "<img src=\"#{tmp_svg.path}\" format=\"svg\" width=\"#{svg_width}\" alt=\"#{node.text.gsub('"', '&quot;')}\">"
       node.id ? %(<a id="#{node.id}">#{DummyText}</a>#{quoted_text}) : quoted_text
     rescue => e
       logger.warn "Failed to process SVG: #{e.message}"
@@ -122,22 +125,125 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
   end
 
   def stem_to_svg(latex_content, is_inline, math_font)
-    js_script = File.join(File.dirname(__FILE__), '../bin/render.js')
-    svg_output, error = nil, nil
     format = is_inline ? 'inline-TeX' : 'TeX'
-    begin
-      Open3.popen3('node', js_script, latex_content, format, POINTS_PER_EX.to_s, math_font) do |_, stdout, stderr, wait_thr|
-        svg_output = stdout.read
-        error = stderr.read unless wait_thr.value.success?
-      end
+    MathJaxServer.for(math_font).render(latex_content, format)
+  end
+
+  # One long-running render.js process per math font. Starting node and MathJax takes
+  # seconds, rendering a formula takes milliseconds, so a document pays the start once.
+  class MathJaxServer
+    JS_SCRIPT = File.join(File.dirname(__FILE__), '../bin/render.js')
+
+    @servers = {}
+
+    def self.for(math_font)
+      @servers[math_font] ||= new(math_font)
+    end
+
+    def initialize(math_font)
+      @math_font = math_font
+    end
+
+    def render(latex_content, format)
+      start unless @stdin
+      @stdin.puts JSON.generate('math' => latex_content, 'format' => format, 'ex' => POINTS_PER_EX)
+      @stdin.flush
+      answer = read_answer
+      [answer['svg'], answer['error']]
     rescue Errno::ENOENT => e
-      error = "Node.js executable 'node' was not found. Please install Node.js and ensure 'node' is available on your PATH. Original error: #{e.message}"
-      svg_output = nil
+      [nil, "Node.js executable 'node' was not found. Please install Node.js and ensure 'node' is available on your PATH. Original error: #{e.message}"]
+    rescue IOError, SystemCallError => e
+      stop
+      [nil, "MathJax process for font #{@math_font} failed: #{e.message}"]
+    end
+
+    private
+
+    def start
+      @stdin, @stdout, @wait_thr = Open3.popen2('node', JS_SCRIPT, '--server', @math_font)
+      at_exit { stop }
+    end
+
+    # Skips anything else a dependency may print to stdout.
+    def read_answer
+      while (line = @stdout.gets)
+        answer = JSON.parse(line) rescue nil
+        return answer if answer.is_a?(Hash) && (answer.key?('svg') || answer.key?('error'))
+      end
+      raise IOError, 'render.js ended without an answer'
+    end
+
+    def stop
+      return unless @stdin
+      @stdin.close unless @stdin.closed?
+      Process.kill('KILL', @wait_thr.pid) unless @wait_thr.join(5)
+      @stdin = @stdout = @wait_thr = nil
+    rescue SystemCallError
+      @stdin = @stdout = @wait_thr = nil
     end
-    [svg_output, error]
   end
 
-  def adjust_svg_to_match_text(svg_content, node, theme)
+  def adjust_svg_to_match_text(svg_content, font)
+
+    svg_doc = REXML::Document.new(svg_content)
+    svg_width = svg_doc.root.attributes['width'].to_f * POINTS_PER_EX || raise("No width found in SVG")
+    svg_height = svg_doc.root.attributes['height'].to_f * POINTS_PER_EX || raise("No height found in SVG")
+    view_box = svg_doc.root.attributes['viewBox']&.split(/\s+/)&.map(&:to_f) || raise("No viewBox found in SVG")
+    svg_inner_offset = view_box[1]
+    svg_inner_height = view_box[3]
+
+    svg_default_font_size = FALLBACK_FONT_SIZE
+
+    # Adjust SVG height and width so that math font matches embedding text
+    scaling_factor = font.font_size.to_f / svg_default_font_size
+    svg_width = svg_width * scaling_factor
+    svg_height = svg_height * scaling_factor
+
+    svg_height_difference = font.font_full_height - svg_height
+    svg_relative_height_difference = font.font_full_height / svg_height
+    embedding_text_relative_baseline_height = font.font_baseline / font.font_full_height
+
+    logger.debug "Original SVG height: #{svg_height.round(2)}, width: #{svg_width.round(2)}, inner height: #{svg_inner_height.round(2)}, inner offset: #{svg_inner_offset.round(2)}"
+    if svg_height_difference < 0
+      svg_relative_portion_extending_embedding_text_below = (1 - svg_relative_height_difference) / 2
+      svg_relative_baseline_height = embedding_text_relative_baseline_height * svg_relative_height_difference
+      svg_inner_relative_offset = svg_relative_baseline_height + svg_relative_portion_extending_embedding_text_below - 1
+
+      svg_inner_offset_new = svg_inner_relative_offset * svg_inner_height
+      svg_inner_height_padding = (svg_inner_offset - svg_inner_offset_new) * 0.25 # 25% padding to handle fractions
+      svg_inner_height_difference = 2 * svg_inner_height_padding
+      svg_inner_height_new = svg_inner_height + svg_inner_height_difference
+      svg_inner_height_relative_difference = svg_inner_height_new / svg_inner_height
+
+      logger.debug("svg_inner_offset = #{svg_inner_offset}, svg_inner_height = #{svg_inner_height}, svg_inner_offset_new = #{svg_inner_offset_new}, svg_inner_height_new = #{svg_inner_height_new}")
+      logger.debug("svg_inner_offset_diff = #{svg_inner_offset - svg_inner_offset_new}, svg_inner_offset_diff_relative = #{(svg_inner_offset - svg_inner_offset_new) / svg_inner_height}")
+
+      svg_height = svg_height * svg_inner_height_relative_difference
+      svg_inner_height = svg_inner_height_new
+      svg_inner_offset = svg_inner_offset_new - svg_inner_height_padding
+    else
+      svg_height = font.font_full_height
+      svg_inner_height = svg_relative_height_difference * svg_inner_height
+      svg_inner_offset = (embedding_text_relative_baseline_height - 1) * svg_inner_height
+    end
+
+    view_box[1] = svg_inner_offset
+    view_box[3] = svg_inner_height
+    svg_doc.root.attributes['viewBox'] = view_box.join(' ')
+    svg_doc.root.attributes['height'] = "#{svg_height / POINTS_PER_EX}ex"
+    svg_doc.root.attributes['width'] = "#{svg_width / POINTS_PER_EX}ex"
+    svg_doc.root.attributes.delete('style')
+
+    logger.debug "Adjusted SVG height: #{svg_height.round(2)}, width: #{svg_width.round(2)}, inner height: #{svg_inner_height.round(2)}, inner offset: #{svg_inner_offset.round(2)}"
+    svg_output = adjust_svg_color(svg_doc.to_s, font.font_color)
+
+    [svg_output, svg_width]
+  rescue => e
+    logger.warn "Failed to adjust SVG baseline: #{e.full_message}"
+    nil # Fallback to the original if adjustment fails
+  end
+
+  def analyze_embedding_font(node, theme)
     node_context = find_font_context(node)
     logger.debug "Found font context #{node_context} for node #{node}"
 
@@ -183,15 +289,21 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
     end
 
     font = TTFunk::File.open(font_file)
-    unless font
-      raise "Failed opening font file: #{font_file}"
+    raise "Failed opening font file: #{font_file}" unless font
+
+    if font.os2 && font.os2.ascent != 0
+      ascender_height = font.os2.ascent.abs
+      descender_height = font.os2.descent.abs
+      line_gap = font.os2.line_gap
+    else
+      ascender_height = font.horizontal_header.ascent.abs
+      descender_height = font.horizontal_header.descent.abs
+      line_gap = font.horizontal_header.line_gap
     end
 
-    descender_height = font.horizontal_header.descent.abs
-    ascender_height = font.horizontal_header.ascent.abs
-    x_height = font.os2.x_height
+    ex_height = font.os2&.x_height
 
-    unless x_height
+    unless ex_height
       logger.debug "'OS/2' table not found, falling back to estimating font x-height (ex) from glyph"
 
       cmap_table = font.cmap.tables.find { |table| table.format == 4 && table.platform_id == 3 && table.encoding_id == 1 || table.encoding_id == 10 }
@@ -203,72 +315,17 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
       glyph = font.glyph_outlines.for(glyph_id)
       raise 'Glyph data not available' unless glyph
 
-      x_height = glyph.y_max - glyph.y_min
+      ex_height = glyph.y_max - glyph.y_min
     end
-    logger.debug "Embedding Font: #{font_family} #{font_style}, x-height: #{x_height}, ascender: #{ascender_height}, descender: #{descender_height}"
+    logger.debug "Embedding Font: #{font_family} #{font_style}, x-height: #{ex_height}, ascender: #{ascender_height}, descender: #{descender_height}, line gap: #{line_gap}"
 
     units_per_em = font.header.units_per_em.to_f
-    total_height = (descender_height.to_f + ascender_height.to_f)
+    total_height = (descender_height.to_f + ascender_height.to_f + line_gap.to_f)
 
     embedding_text_height = total_height / units_per_em * font_size
-    embedding_text_baseline_height = descender_height / units_per_em * font_size
-
-    svg_doc = REXML::Document.new(svg_content)
-    svg_width = svg_doc.root.attributes['width'].to_f * POINTS_PER_EX || raise("No width found in SVG")
-    svg_height = svg_doc.root.attributes['height'].to_f * POINTS_PER_EX || raise("No height found in SVG")
-    view_box = svg_doc.root.attributes['viewBox']&.split(/\s+/)&.map(&:to_f) || raise("No viewBox found in SVG")
-    svg_inner_offset = view_box[1]
-    svg_inner_height = view_box[3]
-
-    svg_default_font_size = FALLBACK_FONT_SIZE
-
-    # Adjust SVG height and width so that math font matches embedding text
-    scaling_factor = font_size.to_f / svg_default_font_size
-    svg_width = svg_width * scaling_factor
-    svg_height = svg_height * scaling_factor
-
-    svg_height_difference = embedding_text_height - svg_height
-    svg_relative_height_difference = embedding_text_height / svg_height
-    embedding_text_relative_baseline_height = embedding_text_baseline_height / embedding_text_height
-
-    logger.debug "Original SVG height: #{svg_height.round(2)}, width: #{svg_width.round(2)}, inner height: #{svg_inner_height.round(2)}, inner offset: #{svg_inner_offset.round(2)}"
-    if svg_height_difference < 0
-      svg_relative_portion_extending_embedding_text_below = (1 - svg_relative_height_difference) / 2
-      svg_relative_baseline_height = embedding_text_relative_baseline_height * svg_relative_height_difference
-      svg_inner_relative_offset = svg_relative_baseline_height + svg_relative_portion_extending_embedding_text_below - 1
+    embedding_text_baseline_height = (descender_height.to_f + line_gap.to_f) / units_per_em * font_size
 
-      svg_inner_offset_new = svg_inner_relative_offset * svg_inner_height
-      svg_inner_height_padding = (svg_inner_offset - svg_inner_offset_new) * 0.25 # 25% padding to handle fractions
-      svg_inner_height_difference = 2 * svg_inner_height_padding
-      svg_inner_height_new = svg_inner_height + svg_inner_height_difference
-      svg_inner_height_relative_difference = svg_inner_height_new / svg_inner_height
-
-      logger.debug("svg_inner_offset = #{svg_inner_offset}, svg_inner_height = #{svg_inner_height}, svg_inner_offset_new = #{svg_inner_offset_new}, svg_inner_height_new = #{svg_inner_height_new}")
-      logger.debug("svg_inner_offset_diff = #{svg_inner_offset - svg_inner_offset_new}, svg_inner_offset_diff_relative = #{(svg_inner_offset - svg_inner_offset_new) / svg_inner_height}")
-
-      svg_height = svg_height * svg_inner_height_relative_difference
-      svg_inner_height = svg_inner_height_new
-      svg_inner_offset = svg_inner_offset_new - svg_inner_height_padding
-    else
-      svg_height = embedding_text_height
-      svg_inner_height = svg_relative_height_difference * svg_inner_height
-      svg_inner_offset = (embedding_text_relative_baseline_height - 1) * svg_inner_height
-    end
-
-    view_box[1] = svg_inner_offset
-    view_box[3] = svg_inner_height
-    svg_doc.root.attributes['viewBox'] = view_box.join(' ')
-    svg_doc.root.attributes['height'] = "#{svg_height / POINTS_PER_EX}ex"
-    svg_doc.root.attributes['width'] = "#{svg_width / POINTS_PER_EX}ex"
-    svg_doc.root.attributes.delete('style')
-
-    logger.debug "Adjusted SVG height: #{svg_height.round(2)}, width: #{svg_width.round(2)}, inner height: #{svg_inner_height.round(2)}, inner offset: #{svg_inner_offset.round(2)}"
-    svg_output = adjust_svg_color(svg_doc.to_s, font_color)
-
-    [svg_output, svg_width]
-  rescue => e
-    logger.warn "Failed to adjust SVG baseline: #{e.full_message}"
-    nil # Fallback to the original if adjustment fails
+    FontAttributes.new(font_size, font_color, embedding_text_height, embedding_text_baseline_height)
   end
 
   def find_font_context(node)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf-mathjax
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Crown0815