prawnx 0.1.1

data/lib/prawnx/true_type/subset.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module PrawnX
+  module TrueType
+    # A new TrueType font holding only the glyphs a document uses, numbered in the order it first used them
+    # (glyph 0, .notdef, stays first). Composite glyphs bring their components along.
+    class Subset
+      # Tables ISO 32000-1 §9.9 requires in an embedded TrueType font, plus OS/2 and post for strict readers, and
+      # gasp, which tells rasterizers like Poppler at which sizes to hint and smooth glyphs.
+      COPIED_TABLES = %w[cvt\  fpgm prep OS/2 gasp].freeze
+      # Composite glyph flags (OpenType 'glyf' table).
+      ARGUMENTS_ARE_WORDS = 0x0001
+      HAS_SCALE = 0x0008
+      MORE_COMPONENTS = 0x0020
+      HAS_X_AND_Y_SCALE = 0x0040
+      HAS_TWO_BY_TWO = 0x0080
+      CHECKSUM_MAGIC = 0xB1B0AFBA
+
+      def initialize(file)
+        @file = file
+        @new_glyph_by_original = {0 => 0}
+      end
+
+      def glyph_for(original_glyph)
+        @new_glyph_by_original[original_glyph] ||= @new_glyph_by_original.size
+      end
+
+      def original_glyphs
+        @new_glyph_by_original.keys
+      end
+
+      # Numbers the components of composite glyphs, level by level, in the order of their composites' indices.
+      def add_components(originals)
+        level = originals
+        loop do
+          components = level.flat_map { component_glyphs(@file.glyph_data(it)) }
+          break if components.empty?
+
+          components.each { glyph_for(it) }
+          level = components
+        end
+      end
+
+      def bytes(extra_tables = {})
+        glyphs = glyph_data_including_components
+        offsets = [0]
+        glyf = glyphs.each_with_object(+"".b) do |data, table|
+          table << data << ("\x00" * ((4 - (data.bytesize % 4)) % 4))
+          offsets << table.bytesize
+        end
+        glyph_count = glyphs.size
+        widths = @file.advance_widths
+        left_side_bearings = original_glyphs.map { left_side_bearing(it) }
+
+        bounds = glyphs.filter_map { it.unpack("s>5") if it.bytesize >= 10 }
+        advances = original_glyphs.map { widths[it] }
+        tables = {
+          "head" => head_table(bounds),
+          "hhea" => horizontal_header(bounds, advances, left_side_bearings, glyph_count),
+          "maxp" => maximum_profile(bounds, glyphs, glyph_count),
+          "hmtx" => original_glyphs.zip(left_side_bearings).map { |glyph, bearing| [widths[glyph], bearing] }.flatten.pack("n*"),
+          "loca" => offsets.pack("N*"),
+          "glyf" => glyf,
+          "post" => @file.table("post").byteslice(0, 32).dup.tap { it[0, 4] = "\x00\x03\x00\x00".b },
+        }
+        COPIED_TABLES.each { tables[it] = @file.table(it) if @file.table?(it) }
+        Subset.assemble(tables.merge(extra_tables))
+      end
+
+      # An sfnt file of these tables, with its directory and checksums (OpenType specification, "Font file").
+      def self.assemble(tables, sfnt_version: 0x00010000)
+        tags = tables.keys.sort
+        table_count = tags.size
+        search_range = (2**Math.log2(table_count).floor) * 16
+        directory = [sfnt_version, table_count, search_range, Math.log2(search_range / 16).to_i, (table_count * 16) - search_range].pack("Nn4")
+        body = +"".b
+        offset = 12 + (table_count * 16)
+        tags.each do |tag|
+          data = tables[tag]
+          directory << [tag, Subset.checksum(data), offset + body.bytesize, data.bytesize].pack("a4N3")
+          body << data << ("\x00" * ((4 - (data.bytesize % 4)) % 4))
+        end
+        font = directory << body
+        head_offset = 12 + (table_count * 16) + tags.take_while { it != "head" }.sum { (tables[it].bytesize + 3) & ~3 }
+        font[head_offset + 8, 4] = [(CHECKSUM_MAGIC - Subset.checksum(font)) & 0xFFFFFFFF].pack("N")
+        font
+      end
+
+      def self.checksum(data)
+        padded = data + ("\x00" * ((4 - (data.bytesize % 4)) % 4))
+        padded.unpack("N*").sum & 0xFFFFFFFF
+      end
+
+      private
+
+      def glyph_data_including_components
+        glyphs = []
+        index = 0
+        while index < original_glyphs.size
+          glyphs << remap_components(@file.glyph_data(original_glyphs[index]))
+          index += 1
+        end
+        glyphs
+      end
+
+      def component_glyphs(data)
+        return [] if data.bytesize < 10 || data.unpack1("s>") >= 0
+
+        glyphs = []
+        position = 10
+        loop do
+          break if position + 4 > data.bytesize
+
+          flags, original = data.unpack("@#{position} n2")
+          glyphs << original if original < @file.glyph_count
+          position += 4 + ((flags & ARGUMENTS_ARE_WORDS).zero? ? 2 : 4)
+          position += 2 if (flags & HAS_SCALE).nonzero?
+          position += 4 if (flags & HAS_X_AND_Y_SCALE).nonzero?
+          position += 8 if (flags & HAS_TWO_BY_TWO).nonzero?
+          break if (flags & MORE_COMPONENTS).zero?
+        end
+        glyphs
+      end
+
+      def remap_components(data)
+        return data if data.bytesize < 10 || data.unpack1("s>") >= 0
+
+        data = data.dup
+        position = 10
+        loop do
+          raise Error, "Truncated composite glyph" if position + 4 > data.bytesize
+
+          flags, original = data.unpack("@#{position} n2")
+          raise Error, "Composite glyph component #{original} beyond the font's #{@file.glyph_count} glyphs" if original >= @file.glyph_count
+
+          data[position + 2, 2] = [glyph_for(original)].pack("n")
+          position += 4 + ((flags & ARGUMENTS_ARE_WORDS).zero? ? 2 : 4)
+          position += 2 if (flags & HAS_SCALE).nonzero?
+          position += 4 if (flags & HAS_X_AND_Y_SCALE).nonzero?
+          position += 8 if (flags & HAS_TWO_BY_TWO).nonzero?
+          break if (flags & MORE_COMPONENTS).zero?
+        end
+        data
+      end
+
+      def left_side_bearing(glyph)
+        metric_count = @file.table("hhea").unpack1("@34 n")
+        hmtx = @file.table("hmtx")
+        raw = glyph < metric_count ? hmtx.unpack1("@#{(glyph * 4) + 2} n") : hmtx.unpack1("@#{(metric_count * 4) + ((glyph - metric_count) * 2)} n")
+        raw.to_i
+      end
+
+      # The subset's own extremes, as the OpenType specification defines them: readers like Poppler size their
+      # glyph caches from the font's bounding box.
+      def head_table(bounds)
+        head = @file.table("head").dup
+        head[8, 4] = "\x00\x00\x00\x00".b
+        head[36, 8] = [bounds.map { it[1] }.min || 0, bounds.map { it[2] }.min || 0, bounds.map { it[3] }.max || 0, bounds.map { it[4] }.max || 0].pack("s>4")
+        head[50, 2] = [1].pack("n")
+        head
+      end
+
+      def horizontal_header(bounds, advances, left_side_bearings, glyph_count)
+        hhea = @file.table("hhea").dup
+        right_side_bearings = bounds.zip(advances).filter_map { |bound, advance| advance - (bound[3] - bound[1]) - bound[1] if bound && advance }
+        extents = bounds.map { it[3] }
+        hhea[10, 8] = [advances.compact.max || 0, left_side_bearings.min || 0, right_side_bearings.min || 0, extents.max || 0].pack("n s>3")
+        hhea[34, 2] = [glyph_count].pack("n")
+        hhea
+      end
+
+      # Largest simple glyph, in points and contours; composite figures stay those of the whole font.
+      def maximum_profile(bounds, glyphs, glyph_count)
+        maxp = @file.table("maxp").dup
+        maxp[4, 2] = [glyph_count].pack("n")
+        return maxp if maxp.bytesize < 10
+
+        simple = glyphs.select { it.bytesize >= 10 && it.unpack1("s>") >= 0 }
+        contours = simple.map { it.unpack1("s>") }
+        points = simple.zip(contours).map { |glyph, count| count.zero? ? 0 : glyph.unpack1("@#{10 + ((count - 1) * 2)} n") + 1 }
+        maxp[6, 4] = [points.max || 0, contours.max || 0].pack("n2")
+        maxp
+      end
+
+    end
+  end
+end

data/lib/prawnx/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PrawnX
+  # The Prawn API PrawnX reproduces. Prawn is PrawnX, so this is also Prawn::VERSION, which prawn-svg and others check.
+  VERSION = "2.5.0"
+  GEM_VERSION = "0.1.1"
+end

data/lib/prawnx/view.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PrawnX
+  # Mixed into a class, turns it into a document: Prawn's methods are called on an implicit Prawn::Document.
+  module View
+    def document
+      @document ||= Document.new
+    end
+
+    def method_missing(method_name, *arguments, **options, &)
+      return super unless document.respond_to?(method_name)
+
+      document.public_send(method_name, *arguments, **options, &)
+    end
+
+    def respond_to_missing?(method_name, include_all = false)
+      document.respond_to?(method_name) || super
+    end
+
+    def update(&)
+      instance_eval(&)
+    end
+
+    def save_as(filename)
+      document.render_file(filename)
+    end
+  end
+end

data/lib/prawnx.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "set"
+require_relative "prawnx/version"
+
+module PrawnX
+  BASEDIR = File.expand_path("..", __dir__)
+  DATADIR = File.join(BASEDIR, "data")
+  FLOAT_PRECISION = 1.0e-9
+
+  class << self
+    attr_accessor :debug
+
+    def verify_options(accepted, actual)
+      return unless debug || $DEBUG
+
+      unknown = actual.keys - Array(accepted)
+      raise Errors::UnknownOption, "\nDetected unknown option(s): #{unknown.inspect}\nAccepted options are: #{Array(accepted).inspect}" unless unknown.empty?
+
+      yield if block_given?
+    end
+  end
+end
+
+require_relative "prawnx/errors"
+require_relative "prawnx/pdf"
+require_relative "prawnx/pdf/reference"
+require_relative "prawnx/pdf/writer"
+require_relative "prawnx/pdf/outline_node"
+require_relative "prawnx/page_geometry"
+require_relative "prawnx/pdf_core"
+require_relative "prawnx/encoding"
+require_relative "prawnx/graphic_state"
+require_relative "prawnx/page"
+require_relative "prawnx/transformation_stack"
+require_relative "prawnx/graphics/color"
+require_relative "prawnx/graphics/style"
+require_relative "prawnx/graphics/patterns"
+require_relative "prawnx/graphics"
+require_relative "prawnx/text"
+require_relative "prawnx/text/formatted/parser"
+require_relative "prawnx/text/formatted/fragment"
+require_relative "prawnx/text/formatted/arranger"
+require_relative "prawnx/text/formatted/line_wrap"
+require_relative "prawnx/text/formatted/wrap"
+require_relative "prawnx/text/formatted/box"
+require_relative "prawnx/text/box"
+require_relative "prawnx/annotations"
+require_relative "prawnx/stamp"
+require_relative "prawnx/measurements"
+require_relative "prawnx/view"
+require_relative "prawnx/images"
+require_relative "prawnx/images/png_decoder"
+require_relative "prawnx/images/image"
+require_relative "prawnx/repeater"
+require_relative "prawnx/grid"
+require_relative "prawnx/outline"
+require_relative "prawnx/table"
+require_relative "prawnx/table/cells"
+require_relative "prawnx/table/cell"
+require_relative "prawnx/table/cell/kinds"
+require_relative "prawnx/security"
+require_relative "prawnx/pdf_a"
+require_relative "prawnx/pdf_a/srgb_profile"
+require_relative "prawnx/document/internals"
+require_relative "prawnx/document/bounding_box"
+require_relative "prawnx/document/span"
+require_relative "prawnx/document/column_box"
+require_relative "prawnx/document"
+require_relative "prawnx/font"
+require_relative "prawnx/fonts/afm"
+
+# TrueType fonts load on first use: a document of standard fonts never needs them.
+module PrawnX
+  module TrueType
+    autoload :Error, ::File.expand_path("prawnx/true_type/file", __dir__)
+    autoload :File, ::File.expand_path("prawnx/true_type/file", __dir__)
+    autoload :Subset, ::File.expand_path("prawnx/true_type/subset", __dir__)
+    autoload :SimpleSubsets, ::File.expand_path("prawnx/true_type/simple_subsets", __dir__)
+    autoload :CffSubset, ::File.expand_path("prawnx/true_type/cff_subset", __dir__)
+    autoload :OpenTypeLayout, ::File.expand_path("prawnx/true_type/open_type_layout", __dir__)
+  end
+
+  module Fonts
+    %i[TTF TTC DFont].each { autoload it, ::File.expand_path("prawnx/fonts/ttf", __dir__) }
+    autoload :OTF, ::File.expand_path("prawnx/fonts/otf", __dir__)
+  end
+
+  class Font
+    %i[TTF TTC DFont].each { autoload it, ::File.expand_path("prawnx/fonts/ttf", __dir__) }
+  end
+
+  # Loads what PrawnX otherwise loads on first use, SVG support included: call it before a server forks its
+  # workers, so they share that memory instead of each loading its own copy.
+  def self.eager_load!
+    [TrueType::File, TrueType::Subset, Fonts::TTF]
+    require "prawn-svg"
+  end
+end
+
+PrawnX.image_handler.register(PrawnX::Images::JPG)
+PrawnX.image_handler.register(PrawnX::Images::PNG)

metadata

@@ -0,0 +1,251 @@
+--- !ruby/object:Gem::Specification
+name: prawnx
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Clément Joubert
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: matrix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- GPLv2
+- GPLv3
+- LICENSE
+- LICENSE-prawn-svg
+- README.md
+- data/fonts/Courier-Bold.afm
+- data/fonts/Courier-BoldOblique.afm
+- data/fonts/Courier-Oblique.afm
+- data/fonts/Courier.afm
+- data/fonts/Helvetica-Bold.afm
+- data/fonts/Helvetica-BoldOblique.afm
+- data/fonts/Helvetica-Oblique.afm
+- data/fonts/Helvetica.afm
+- data/fonts/MustRead.html
+- data/fonts/Symbol.afm
+- data/fonts/Times-Bold.afm
+- data/fonts/Times-BoldItalic.afm
+- data/fonts/Times-Italic.afm
+- data/fonts/Times-Roman.afm
+- data/fonts/ZapfDingbats.afm
+- lib/pdf/core.rb
+- lib/prawn-svg.rb
+- lib/prawn.rb
+- lib/prawn/measurement_extensions.rb
+- lib/prawn/svg/attributes.rb
+- lib/prawn/svg/attributes/clip_path.rb
+- lib/prawn/svg/attributes/mask.rb
+- lib/prawn/svg/attributes/opacity.rb
+- lib/prawn/svg/attributes/space.rb
+- lib/prawn/svg/attributes/stroke.rb
+- lib/prawn/svg/attributes/transform.rb
+- lib/prawn/svg/calculators/arc_to_bezier_curve.rb
+- lib/prawn/svg/calculators/aspect_ratio.rb
+- lib/prawn/svg/calculators/document_sizing.rb
+- lib/prawn/svg/calculators/path_length.rb
+- lib/prawn/svg/calculators/pixels.rb
+- lib/prawn/svg/color.rb
+- lib/prawn/svg/css/font_face_parser.rb
+- lib/prawn/svg/css/font_family_parser.rb
+- lib/prawn/svg/css/font_parser.rb
+- lib/prawn/svg/css/selector_parser.rb
+- lib/prawn/svg/css/stylesheets.rb
+- lib/prawn/svg/css/values_parser.rb
+- lib/prawn/svg/document.rb
+- lib/prawn/svg/elements.rb
+- lib/prawn/svg/elements/anchor.rb
+- lib/prawn/svg/elements/base.rb
+- lib/prawn/svg/elements/bbox_scaling.rb
+- lib/prawn/svg/elements/call_duplicator.rb
+- lib/prawn/svg/elements/circle.rb
+- lib/prawn/svg/elements/clip_path.rb
+- lib/prawn/svg/elements/container.rb
+- lib/prawn/svg/elements/direct_render_base.rb
+- lib/prawn/svg/elements/ellipse.rb
+- lib/prawn/svg/elements/gradient.rb
+- lib/prawn/svg/elements/ignored.rb
+- lib/prawn/svg/elements/image.rb
+- lib/prawn/svg/elements/line.rb
+- lib/prawn/svg/elements/marker.rb
+- lib/prawn/svg/elements/mask.rb
+- lib/prawn/svg/elements/path.rb
+- lib/prawn/svg/elements/pattern.rb
+- lib/prawn/svg/elements/polygon.rb
+- lib/prawn/svg/elements/polyline.rb
+- lib/prawn/svg/elements/rect.rb
+- lib/prawn/svg/elements/root.rb
+- lib/prawn/svg/elements/switch.rb
+- lib/prawn/svg/elements/text.rb
+- lib/prawn/svg/elements/text_component.rb
+- lib/prawn/svg/elements/text_node.rb
+- lib/prawn/svg/elements/text_path.rb
+- lib/prawn/svg/elements/use.rb
+- lib/prawn/svg/elements/viewport.rb
+- lib/prawn/svg/extension.rb
+- lib/prawn/svg/font.rb
+- lib/prawn/svg/font_metrics.rb
+- lib/prawn/svg/font_registry.rb
+- lib/prawn/svg/funciri.rb
+- lib/prawn/svg/gradient_renderer.rb
+- lib/prawn/svg/gradients.rb
+- lib/prawn/svg/interface.rb
+- lib/prawn/svg/length.rb
+- lib/prawn/svg/link_renderer.rb
+- lib/prawn/svg/loaders/data.rb
+- lib/prawn/svg/loaders/file.rb
+- lib/prawn/svg/loaders/web.rb
+- lib/prawn/svg/paint.rb
+- lib/prawn/svg/pathable.rb
+- lib/prawn/svg/pattern_renderer.rb
+- lib/prawn/svg/pdfmatrix.rb
+- lib/prawn/svg/percentage.rb
+- lib/prawn/svg/properties.rb
+- lib/prawn/svg/renderer.rb
+- lib/prawn/svg/state.rb
+- lib/prawn/svg/transform_parser.rb
+- lib/prawn/svg/ttc.rb
+- lib/prawn/svg/ttf.rb
+- lib/prawn/svg/url_loader.rb
+- lib/prawn/svg/version.rb
+- lib/prawn/table.rb
+- lib/prawnx.rb
+- lib/prawnx/annotations.rb
+- lib/prawnx/document.rb
+- lib/prawnx/document/bounding_box.rb
+- lib/prawnx/document/column_box.rb
+- lib/prawnx/document/internals.rb
+- lib/prawnx/document/span.rb
+- lib/prawnx/encoding.rb
+- lib/prawnx/errors.rb
+- lib/prawnx/font.rb
+- lib/prawnx/fonts/afm.rb
+- lib/prawnx/fonts/otf.rb
+- lib/prawnx/fonts/ttf.rb
+- lib/prawnx/graphic_state.rb
+- lib/prawnx/graphics.rb
+- lib/prawnx/graphics/color.rb
+- lib/prawnx/graphics/patterns.rb
+- lib/prawnx/graphics/style.rb
+- lib/prawnx/grid.rb
+- lib/prawnx/images.rb
+- lib/prawnx/images/image.rb
+- lib/prawnx/images/png_decoder.rb
+- lib/prawnx/measurement_extensions.rb
+- lib/prawnx/measurements.rb
+- lib/prawnx/outline.rb
+- lib/prawnx/page.rb
+- lib/prawnx/page_geometry.rb
+- lib/prawnx/pdf.rb
+- lib/prawnx/pdf/outline_node.rb
+- lib/prawnx/pdf/reference.rb
+- lib/prawnx/pdf/writer.rb
+- lib/prawnx/pdf_a.rb
+- lib/prawnx/pdf_a/srgb_profile.rb
+- lib/prawnx/pdf_core.rb
+- lib/prawnx/repeater.rb
+- lib/prawnx/security.rb
+- lib/prawnx/stamp.rb
+- lib/prawnx/table.rb
+- lib/prawnx/table/cell.rb
+- lib/prawnx/table/cell/kinds.rb
+- lib/prawnx/table/cells.rb
+- lib/prawnx/text.rb
+- lib/prawnx/text/box.rb
+- lib/prawnx/text/formatted/arranger.rb
+- lib/prawnx/text/formatted/box.rb
+- lib/prawnx/text/formatted/fragment.rb
+- lib/prawnx/text/formatted/line_wrap.rb
+- lib/prawnx/text/formatted/parser.rb
+- lib/prawnx/text/formatted/wrap.rb
+- lib/prawnx/transformation_stack.rb
+- lib/prawnx/true_type/cff_subset.rb
+- lib/prawnx/true_type/file.rb
+- lib/prawnx/true_type/open_type_layout.rb
+- lib/prawnx/true_type/simple_subsets.rb
+- lib/prawnx/true_type/subset.rb
+- lib/prawnx/version.rb
+- lib/prawnx/view.rb
+homepage: https://github.com/levups/prawnx
+licenses:
+- Nonstandard
+- GPL-2.0-only
+- GPL-3.0-only
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.23
+specification_version: 4
+summary: 'Prawn''s API, rewritten for speed: same pages, lighter files'
+test_files: []