Class: Fontisan::Stitcher

Inherits:
Object
  • Object
show all
Defined in:
lib/fontisan/stitcher.rb,
lib/fontisan/stitcher/source.rb,
lib/fontisan/stitcher/selector.rb,
lib/fontisan/stitcher/glyph_limit.rb,
lib/fontisan/stitcher/deduplicator.rb,
lib/fontisan/stitcher/glyph_cloner.rb,
lib/fontisan/stitcher/glyph_copier.rb,
lib/fontisan/stitcher/selector/gid.rb,
lib/fontisan/stitcher/selector/range.rb,
lib/fontisan/stitcher/cbdt_propagator.rb,
lib/fontisan/stitcher/format_metadata.rb,
lib/fontisan/stitcher/glyph_signature.rb,
lib/fontisan/stitcher/collection_result.rb,
lib/fontisan/stitcher/unique_glyph_name.rb,
lib/fontisan/stitcher/partition_strategy.rb,
lib/fontisan/stitcher/selector/codepoints.rb,
lib/fontisan/stitcher/partition_strategy/base.rb,
lib/fontisan/stitcher/partition_strategy/by_block.rb,
lib/fontisan/stitcher/partition_strategy/by_plane.rb,
lib/fontisan/stitcher/partition_strategy/blueprint.rb,
lib/fontisan/stitcher/partition_strategy/by_script.rb,
lib/fontisan/stitcher/partition_strategy/partition.rb

Overview

Multi-source font stitcher with explicit subfont declaration.

Every set of codepoints is explicitly assigned to a named subfont via the required into: keyword. The user controls the collection structure upfront — there are no defaults and no after-the-fact splitting.

Single-font output: write_to requires a subfont: name. Collection output: write_collection writes all declared subfonts.

Examples:

Single font

stitcher = Fontisan::Stitcher.new
stitcher.add_source(:latin, Fontisan::Ufo::Font.open("latin.ufo"))
stitcher.include_range(0x41..0x5A, from: :latin, into: :main)
stitcher.write_to("out.ttf", format: :ttf, subfont: :main)

Collection

stitcher = Fontisan::Stitcher.new
stitcher.add_source(:noto_sans, noto_sans)
stitcher.add_source(:noto_cjk, noto_cjk)
stitcher.include_range(0x41..0x5A, from: :noto_sans, into: :latin)
stitcher.include_range(0x4E00..0x9FFF, from: :noto_cjk, into: :cjk)
stitcher.write_collection("out.otc", format: :otf2)

Defined Under Namespace

Modules: GlyphCloner, GlyphLimit, GlyphSignature, PartitionStrategy, Selector, UniqueGlyphName Classes: CbdtPropagator, CollectionResult, Deduplicator, FormatMetadata, GlyphCopier, Source, SubfontStats

Constant Summary collapse

DEFAULT_DEDUPLICATE = 
true

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deduplicate: DEFAULT_DEDUPLICATE) ⇒ Stitcher

Returns a new instance of Stitcher.



52
53
54
55
56
57
 
# File 'lib/fontisan/stitcher.rb', line 52

def initialize(deduplicate: DEFAULT_DEDUPLICATE)
  @sources = {}
  @subfonts = Hash.new { |h, k| h[k] = [] }
  @info = nil
  @deduplicate = deduplicate
end

Instance Attribute Details

#info ⇒ Object (readonly)

Returns the value of attribute info.



50
51
52
 
# File 'lib/fontisan/stitcher.rb', line 50

def info
  @info
end

#sources ⇒ Object (readonly)

Returns the value of attribute sources.



50
51
52
 
# File 'lib/fontisan/stitcher.rb', line 50

def sources
  @sources
end

#subfonts ⇒ Object (readonly)

Returns the value of attribute subfonts.



50
51
52
 
# File 'lib/fontisan/stitcher.rb', line 50

def subfonts
  @subfonts
end

Instance Method Details

#add_source(label, font, remap: nil) ⇒ Object 



59
60
61
 
# File 'lib/fontisan/stitcher.rb', line 59

def add_source(label, font, remap: nil)
  @sources[label.to_sym] = Source.new(font, remap: remap)
end

#build_target_font(subfont:) ⇒ Object 



94
95
96
 
# File 'lib/fontisan/stitcher.rb', line 94

def build_target_font(subfont:)
  build_target_for(subfont)
end

#include_codepoints(codepoints, from:, into:) ⇒ Object 



67
68
69
 
# File 'lib/fontisan/stitcher.rb', line 67

def include_codepoints(codepoints, from:, into:)
  Selector::Codepoints.new(codepoints).apply(source(from), @subfonts[into])
end

#include_codepoints_map(cp_map, into:) ⇒ Object 



71
72
73
74
75
76
 
# File 'lib/fontisan/stitcher.rb', line 71

def include_codepoints_map(cp_map, into:)
  cp_map.to_h
    .group_by { |_cp, label| label }
    .transform_values { |pairs| pairs.map(&:first).sort }
    .each { |label, cps| include_codepoints(cps, from: label, into: into) }
end

#include_gid(donor_gid, from:, into:) ⇒ Object 



78
79
80
 
# File 'lib/fontisan/stitcher.rb', line 78

def include_gid(donor_gid, from:, into:)
  Selector::Gid.new(donor_gid).apply(source(from), @subfonts[into])
end

#include_notdef(from:, into:) ⇒ Object 



82
83
84
 
# File 'lib/fontisan/stitcher.rb', line 82

def include_notdef(from:, into:)
  include_gid(0, from: from, into: into)
end

#include_range(range, from:, into:) ⇒ Object 



63
64
65
 
# File 'lib/fontisan/stitcher.rb', line 63

def include_range(range, from:, into:)
  Selector::Range.new(range).apply(source(from), @subfonts[into])
end

#set_info(info_hash) ⇒ Object 



86
87
88
 
# File 'lib/fontisan/stitcher.rb', line 86

def set_info(info_hash)
  @info = Ufo::Info.new(info_hash)
end

#subfont_names ⇒ Object 



90
91
92
 
# File 'lib/fontisan/stitcher.rb', line 90

def subfont_names
  @subfonts.keys
end

#write_collection(path, format:) ⇒ Object

Raises:

  • (ArgumentError) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/fontisan/stitcher.rb', line 109

def write_collection(path, format:)
  raise ArgumentError, "no subfonts declared" if @subfonts.empty?

  compiled = @subfonts.keys.map do |name|
    compile_subfont_with_stats(name, format: format)
  end
  fonts = compiled.map(&:font)

  collection_format = FormatMetadata.resolve(format).collection_format
  Collection::Builder.new(fonts, format: collection_format,
                                 optimize: true).build_to_file(path)

  CollectionResult.new(
    path: path,
    bytes: File.size(path),
    subfonts: compiled.map(&:stats),
  )
end

#write_to(path, format:, subfont:) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/fontisan/stitcher.rb', line 98

def write_to(path, format:, subfont:)
  target = build_target_for(subfont)
  GlyphLimit.check!(target.glyphs.size, format: format)

  metadata = FormatMetadata.resolve(format)
  metadata.compiler_class.new(target).compile(output_path: path)

  cbdt_propagator.propagate_tables_into(cbdt_propagator.cbdt_source, path)
  path
end