fontisan 0.4.49-arm-linux

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (792) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/.rubocop.yml +141 -0
  4. data/.rubocop_todo.yml +433 -0
  5. data/BENCHMARKS.md +56 -0
  6. data/BUG-stitcher-drops-isolated-cps.md +58 -0
  7. data/BUG-stitcher-drops-plane1-codepoints.md +310 -0
  8. data/BUG-stitcher-gid-cap-65535.md +110 -0
  9. data/CHANGELOG.md +293 -0
  10. data/Gemfile +40 -0
  11. data/LICENSE +28 -0
  12. data/README.adoc +2811 -0
  13. data/Rakefile +156 -0
  14. data/TODO.bug-fixes/01-cff-expert-charsets.md +27 -0
  15. data/TODO.bug-fixes/02-cff2-subroutine-stubs.md +32 -0
  16. data/TODO.bug-fixes/03-variation-subsetter-placeholders.md +42 -0
  17. data/TODO.bug-fixes/04-ufo-image-compile-roundtrip.md +28 -0
  18. data/TODO.bug-fixes/05-stale-cff-comment.md +18 -0
  19. data/TODO.bug-fixes/06-instance-woff2-output.md +24 -0
  20. data/TODO.bug-fixes/07-encapsulation-violations.md +38 -0
  21. data/TODO.bug-fixes/08-respond-to-violations.md +25 -0
  22. data/TODO.bug-fixes/09-type1-cff-seac-expansion.md +22 -0
  23. data/TODO.bug-fixes/10-ttf-type1-composite-glyphs.md +23 -0
  24. data/TODO.bug-fixes/11-remaining-respond-to.md +25 -0
  25. data/TODO.bug-fixes/12-type1-generators-duck-typing.md +80 -0
  26. data/TODO.bug-fixes/13-hint-extractor-duck-typing.md +30 -0
  27. data/TODO.bug-fixes/14-font-interface-type-checks.md +82 -0
  28. data/TODO.bug-fixes/15-glyph-type-checks-and-simple-glyph-points-bug.md +49 -0
  29. data/TODO.bug-fixes/16-variation-table-checks.md +31 -0
  30. data/TODO.bug-fixes/17-ufo-and-stitcher-cleanup.md +32 -0
  31. data/TODO.bug-fixes/18-generic-value-and-io-checks.md +56 -0
  32. data/TODO.bug-fixes/19-serialization-migration.md +52 -0
  33. data/TODO.bug-fixes/20-variation-validator-type-checks.md +29 -0
  34. data/TODO.bug-fixes/21-xml-builder-send.md +24 -0
  35. data/TODO.bug-fixes/22-type1-converter-font-info.md +25 -0
  36. data/TODO.bug-fixes/23-boundary-type-checks.md +31 -0
  37. data/TODO.bug-fixes/24-validator-dynamic-field-key.md +25 -0
  38. data/TODO.bug-fixes/25-serialization-migration.md +49 -0
  39. data/TODO.bug-fixes/26-variation-preserver-spec-migration.md +25 -0
  40. data/TODO.bug-fixes/27-table-class-registry.md +50 -0
  41. data/TODO.bug-fixes/28-spec-doubles-cleanup.md +40 -0
  42. data/TODO.bug-fixes/29-strategy-registries.md +30 -0
  43. data/TODO.bug-fixes/30-eliminate-send-in-specs.md +36 -0
  44. data/TODO.bug-fixes/README.md +52 -0
  45. data/TODO.improvements/01-cbdt-cblc-gid-stable-propagation.md +73 -0
  46. data/TODO.improvements/02-collection-outline-priority.md +48 -0
  47. data/TODO.improvements/03-fontisan-audit-command.md +219 -0
  48. data/TODO.improvements/04-ufo-composite-glyph-encoding.md +46 -0
  49. data/TODO.improvements/05-otf-compiler-real-cff.md +63 -0
  50. data/TODO.improvements/06-cff2-blend-vsindex-operators.md +51 -0
  51. data/TODO.improvements/07-cpal-v1-header-fields.md +71 -0
  52. data/TODO.improvements/08-cff-standard-string-table.md +52 -0
  53. data/TODO.improvements/09-type1-seac-expansion.md +57 -0
  54. data/TODO.improvements/10-ufo-image-set-feature-writers.md +71 -0
  55. data/TODO.improvements/11-kern-groups-plist.md +49 -0
  56. data/TODO.improvements/12-cbdt-fixture-bindata-conversion.md +68 -0
  57. data/TODO.improvements/13-split-octokit-fetcher.md +45 -0
  58. data/TODO.improvements/14-rubocop-baseline-chip.md +62 -0
  59. data/TODO.improvements/15-cff-cff2-subsetter-strategy.md +78 -0
  60. data/TODO.improvements/README.md +58 -0
  61. data/benchmark/baseline.json +5 -0
  62. data/benchmark/ci_gate.rb +217 -0
  63. data/benchmark/compile_benchmark.rb +78 -0
  64. data/benchmark/corpus/harness.rb +175 -0
  65. data/benchmark/corpus/ops.rb +150 -0
  66. data/benchmark/corpus/run.rb +182 -0
  67. data/benchmark/corpus/scan_child.rb +8 -0
  68. data/benchmark/corpus/tiers.rb +176 -0
  69. data/benchmark/tier_baseline.json +12 -0
  70. data/benchmark/variation_quick_bench.rb +47 -0
  71. data/build_mingw32_stub.rb +15 -0
  72. data/docs/.gitignore +17 -0
  73. data/docs/.vitepress/config.ts +373 -0
  74. data/docs/.vitepress/theme/components/ApiMethod.vue +127 -0
  75. data/docs/.vitepress/theme/components/Badge.vue +51 -0
  76. data/docs/.vitepress/theme/components/FeatureComparison.vue +87 -0
  77. data/docs/.vitepress/theme/components/HeroCodeBlock.vue +98 -0
  78. data/docs/.vitepress/theme/components/WithinHero.vue +30 -0
  79. data/docs/.vitepress/theme/index.ts +22 -0
  80. data/docs/.vitepress/theme/style.css +628 -0
  81. data/docs/AFDKO_MIGRATION.adoc +175 -0
  82. data/docs/APPLE_LEGACY_FONTS.adoc +173 -0
  83. data/docs/CFF2_SUPPORT.adoc +184 -0
  84. data/docs/COLLECTION_VALIDATION.adoc +204 -0
  85. data/docs/COLOR_FONTS.adoc +127 -0
  86. data/docs/CONVERSION_GUIDE.adoc +656 -0
  87. data/docs/EXTRACT_TTC_MIGRATION.md +549 -0
  88. data/docs/FEATURE_PARITY.adoc +263 -0
  89. data/docs/FONT_HINTING.adoc +570 -0
  90. data/docs/STITCHER_GUIDE.adoc +436 -0
  91. data/docs/SVG_TO_GLYF.adoc +118 -0
  92. data/docs/TTX.adoc +176 -0
  93. data/docs/TYPE1_FONTS.adoc +445 -0
  94. data/docs/UFO_COMPILATION.adoc +397 -0
  95. data/docs/VALIDATION.adoc +254 -0
  96. data/docs/VARIABLE_FONT_OPERATIONS.adoc +599 -0
  97. data/docs/WOFF_WOFF2_FORMATS.adoc +220 -0
  98. data/docs/api/conversion-options.md +164 -0
  99. data/docs/api/converters/curve-converter.md +34 -0
  100. data/docs/api/converters/hint-converter.md +34 -0
  101. data/docs/api/converters/outline-converter.md +27 -0
  102. data/docs/api/font-loader.md +117 -0
  103. data/docs/api/font-writer.md +103 -0
  104. data/docs/api/index.md +79 -0
  105. data/docs/api/layer.md +89 -0
  106. data/docs/api/models/glyph-accessor.md +43 -0
  107. data/docs/api/models/glyph.md +40 -0
  108. data/docs/api/models/table-analyzer.md +35 -0
  109. data/docs/api/sfnt-font.md +53 -0
  110. data/docs/api/type1-font.md +43 -0
  111. data/docs/api/validators/font-validator.md +31 -0
  112. data/docs/api/validators/helper.md +36 -0
  113. data/docs/api/validators/profile.md +39 -0
  114. data/docs/cli/convert.md +148 -0
  115. data/docs/cli/dump-table.md +110 -0
  116. data/docs/cli/export.md +176 -0
  117. data/docs/cli/features.md +124 -0
  118. data/docs/cli/glyphs.md +90 -0
  119. data/docs/cli/index.md +232 -0
  120. data/docs/cli/info.md +254 -0
  121. data/docs/cli/instance.md +122 -0
  122. data/docs/cli/ls.md +95 -0
  123. data/docs/cli/optical-size.md +94 -0
  124. data/docs/cli/pack.md +125 -0
  125. data/docs/cli/scripts.md +105 -0
  126. data/docs/cli/subset.md +58 -0
  127. data/docs/cli/tables.md +84 -0
  128. data/docs/cli/unicode.md +101 -0
  129. data/docs/cli/validate-collection.md +95 -0
  130. data/docs/cli/validate.md +56 -0
  131. data/docs/cli/variable.md +126 -0
  132. data/docs/cli/version.md +46 -0
  133. data/docs/guide/cli/convert.md +108 -0
  134. data/docs/guide/cli/export.md +138 -0
  135. data/docs/guide/cli/index.md +99 -0
  136. data/docs/guide/cli/info.md +144 -0
  137. data/docs/guide/cli/pack.md +155 -0
  138. data/docs/guide/cli/subset.md +149 -0
  139. data/docs/guide/cli/validate.md +139 -0
  140. data/docs/guide/color-fonts/bitmaps.md +194 -0
  141. data/docs/guide/color-fonts/colr-cpal.md +175 -0
  142. data/docs/guide/color-fonts/index.md +140 -0
  143. data/docs/guide/color-fonts/svg.md +154 -0
  144. data/docs/guide/color.md +51 -0
  145. data/docs/guide/comparisons/font-validator.md +222 -0
  146. data/docs/guide/comparisons/fonttools.md +200 -0
  147. data/docs/guide/comparisons/index.md +83 -0
  148. data/docs/guide/comparisons/lcdf-typetools.md +205 -0
  149. data/docs/guide/contributing.md +279 -0
  150. data/docs/guide/conversion/collections.md +251 -0
  151. data/docs/guide/conversion/curves.md +246 -0
  152. data/docs/guide/conversion/index.md +157 -0
  153. data/docs/guide/conversion/options.md +280 -0
  154. data/docs/guide/conversion/ttf-otf.md +184 -0
  155. data/docs/guide/conversion/type1.md +208 -0
  156. data/docs/guide/conversion/web.md +299 -0
  157. data/docs/guide/conversion.md +40 -0
  158. data/docs/guide/engines.md +117 -0
  159. data/docs/guide/formats/collections.md +147 -0
  160. data/docs/guide/formats/dfont.md +99 -0
  161. data/docs/guide/formats/index.md +65 -0
  162. data/docs/guide/formats/otf.md +103 -0
  163. data/docs/guide/formats/svg.md +97 -0
  164. data/docs/guide/formats/ttf.md +105 -0
  165. data/docs/guide/formats/type1.md +118 -0
  166. data/docs/guide/formats/woff.md +139 -0
  167. data/docs/guide/hinting/autohint.md +141 -0
  168. data/docs/guide/hinting/conversion.md +161 -0
  169. data/docs/guide/hinting/index.md +86 -0
  170. data/docs/guide/hinting/postscript.md +149 -0
  171. data/docs/guide/hinting/truetype.md +135 -0
  172. data/docs/guide/hinting.md +44 -0
  173. data/docs/guide/index.md +152 -0
  174. data/docs/guide/installation.md +116 -0
  175. data/docs/guide/migrations/extract-ttc.md +549 -0
  176. data/docs/guide/migrations/font-validator.md +260 -0
  177. data/docs/guide/migrations/fonttools.md +208 -0
  178. data/docs/guide/migrations/index.md +64 -0
  179. data/docs/guide/migrations/otfinfo.md +197 -0
  180. data/docs/guide/quick-start.md +204 -0
  181. data/docs/guide/type1.md +58 -0
  182. data/docs/guide/universal-outline.md +151 -0
  183. data/docs/guide/validation/custom.md +195 -0
  184. data/docs/guide/validation/helpers.md +188 -0
  185. data/docs/guide/validation/index.md +132 -0
  186. data/docs/guide/validation/profiles.md +156 -0
  187. data/docs/guide/validation.md +47 -0
  188. data/docs/guide/variable-fonts/advanced.md +231 -0
  189. data/docs/guide/variable-fonts/axes.md +209 -0
  190. data/docs/guide/variable-fonts/conversion.md +197 -0
  191. data/docs/guide/variable-fonts/index.md +84 -0
  192. data/docs/guide/variable-fonts/instances.md +187 -0
  193. data/docs/guide/variable-fonts/named-instances.md +194 -0
  194. data/docs/guide/variable-fonts/static.md +168 -0
  195. data/docs/guide/variable.md +58 -0
  196. data/docs/guide/woff.md +61 -0
  197. data/docs/index.md +136 -0
  198. data/docs/lychee.toml +41 -0
  199. data/docs/package-lock.json +2560 -0
  200. data/docs/package.json +15 -0
  201. data/docs/public/apple-touch-icon.png +0 -0
  202. data/docs/public/favicon-96x96.png +0 -0
  203. data/docs/public/favicon.ico +0 -0
  204. data/docs/public/favicon.svg +1 -0
  205. data/docs/public/logo-full.svg +1 -0
  206. data/docs/public/logo.svg +1 -0
  207. data/docs/public/robots.txt +4 -0
  208. data/docs/public/site.webmanifest +21 -0
  209. data/docs/public/web-app-manifest-192x192.png +0 -0
  210. data/docs/public/web-app-manifest-512x512.png +0 -0
  211. data/docs/reference-facade.md +130 -0
  212. data/docs/scripts/post-build.mjs +81 -0
  213. data/exe/fontisan +7 -0
  214. data/lib/fontisan/audit/check.rb +47 -0
  215. data/lib/fontisan/audit/check_registry.rb +77 -0
  216. data/lib/fontisan/audit/checks/cff_table_check.rb +87 -0
  217. data/lib/fontisan/audit/checks/cmap_check.rb +256 -0
  218. data/lib/fontisan/audit/checks/collection_integrity_check.rb +102 -0
  219. data/lib/fontisan/audit/checks/format_round_trip_check.rb +150 -0
  220. data/lib/fontisan/audit/checks/glyf_table_check.rb +115 -0
  221. data/lib/fontisan/audit/checks/glyph_name_check.rb +107 -0
  222. data/lib/fontisan/audit/checks/head_check.rb +96 -0
  223. data/lib/fontisan/audit/checks/hhea_check.rb +68 -0
  224. data/lib/fontisan/audit/checks/hinting_check.rb +163 -0
  225. data/lib/fontisan/audit/checks/kern_check.rb +47 -0
  226. data/lib/fontisan/audit/checks/layout_table_check.rb +70 -0
  227. data/lib/fontisan/audit/checks/maxp_check.rb +85 -0
  228. data/lib/fontisan/audit/checks/name_table_check.rb +78 -0
  229. data/lib/fontisan/audit/checks/naming_consistency_check.rb +102 -0
  230. data/lib/fontisan/audit/checks/opentype_conformance_check.rb +108 -0
  231. data/lib/fontisan/audit/checks/os2_check.rb +117 -0
  232. data/lib/fontisan/audit/checks/ots_compatibility_check.rb +191 -0
  233. data/lib/fontisan/audit/checks/post_check.rb +75 -0
  234. data/lib/fontisan/audit/checks/table_directory_check.rb +157 -0
  235. data/lib/fontisan/audit/checks/variable_font_check.rb +151 -0
  236. data/lib/fontisan/audit/checks/woff2_validation_check.rb +140 -0
  237. data/lib/fontisan/audit/checks.rb +42 -0
  238. data/lib/fontisan/audit.rb +20 -0
  239. data/lib/fontisan/base_collection.rb +312 -0
  240. data/lib/fontisan/binary/base_record.rb +82 -0
  241. data/lib/fontisan/binary/structures.rb +82 -0
  242. data/lib/fontisan/binary.rb +11 -0
  243. data/lib/fontisan/byte_ops.rb +314 -0
  244. data/lib/fontisan/cli.rb +1111 -0
  245. data/lib/fontisan/collection/builder.rb +336 -0
  246. data/lib/fontisan/collection/dfont_builder.rb +305 -0
  247. data/lib/fontisan/collection/offset_calculator.rb +229 -0
  248. data/lib/fontisan/collection/reader/stats.rb +23 -0
  249. data/lib/fontisan/collection/reader.rb +90 -0
  250. data/lib/fontisan/collection/shared_logic.rb +52 -0
  251. data/lib/fontisan/collection/table_analyzer.rb +289 -0
  252. data/lib/fontisan/collection/table_deduplicator.rb +317 -0
  253. data/lib/fontisan/collection/writer.rb +289 -0
  254. data/lib/fontisan/collection.rb +16 -0
  255. data/lib/fontisan/commands/audit_command.rb +288 -0
  256. data/lib/fontisan/commands/base_command.rb +88 -0
  257. data/lib/fontisan/commands/convert_command.rb +506 -0
  258. data/lib/fontisan/commands/dump_table_command.rb +68 -0
  259. data/lib/fontisan/commands/export_command.rb +157 -0
  260. data/lib/fontisan/commands/features_command.rb +90 -0
  261. data/lib/fontisan/commands/glyphs_command.rb +50 -0
  262. data/lib/fontisan/commands/info_command.rb +447 -0
  263. data/lib/fontisan/commands/instance_command.rb +357 -0
  264. data/lib/fontisan/commands/ls_command.rb +107 -0
  265. data/lib/fontisan/commands/multi_format_output.rb +64 -0
  266. data/lib/fontisan/commands/optical_size_command.rb +38 -0
  267. data/lib/fontisan/commands/pack_command.rb +344 -0
  268. data/lib/fontisan/commands/scripts_command.rb +56 -0
  269. data/lib/fontisan/commands/subset_command.rb +285 -0
  270. data/lib/fontisan/commands/tables_command.rb +52 -0
  271. data/lib/fontisan/commands/unicode_command.rb +73 -0
  272. data/lib/fontisan/commands/unpack_command.rb +387 -0
  273. data/lib/fontisan/commands/validate_collection_command.rb +127 -0
  274. data/lib/fontisan/commands/validate_command.rb +305 -0
  275. data/lib/fontisan/commands/variable_command.rb +87 -0
  276. data/lib/fontisan/commands.rb +30 -0
  277. data/lib/fontisan/config/collection_settings.yml +56 -0
  278. data/lib/fontisan/config/conversion_matrix.yml +626 -0
  279. data/lib/fontisan/config/export_settings.yml +66 -0
  280. data/lib/fontisan/config/features.yml +143 -0
  281. data/lib/fontisan/config/scripts.yml +42 -0
  282. data/lib/fontisan/config/subset_profiles.yml +106 -0
  283. data/lib/fontisan/config/svg_settings.yml +60 -0
  284. data/lib/fontisan/config/variable_settings.yml +99 -0
  285. data/lib/fontisan/config/woff2_settings.yml +77 -0
  286. data/lib/fontisan/constants.rb +219 -0
  287. data/lib/fontisan/conversion_options.rb +389 -0
  288. data/lib/fontisan/converters/cff_table_builder.rb +195 -0
  289. data/lib/fontisan/converters/collection_converter.rb +520 -0
  290. data/lib/fontisan/converters/conversion_strategy.rb +211 -0
  291. data/lib/fontisan/converters/format_converter.rb +536 -0
  292. data/lib/fontisan/converters/glyf_table_builder.rb +61 -0
  293. data/lib/fontisan/converters/outline_converter.rb +720 -0
  294. data/lib/fontisan/converters/outline_extraction.rb +88 -0
  295. data/lib/fontisan/converters/outline_optimizer.rb +84 -0
  296. data/lib/fontisan/converters/svg_generator.rb +236 -0
  297. data/lib/fontisan/converters/table_copier.rb +107 -0
  298. data/lib/fontisan/converters/type1_converter.rb +1201 -0
  299. data/lib/fontisan/converters/woff2_encoder.rb +520 -0
  300. data/lib/fontisan/converters/woff_writer.rb +358 -0
  301. data/lib/fontisan/converters.rb +21 -0
  302. data/lib/fontisan/dfont_collection.rb +288 -0
  303. data/lib/fontisan/engine.rb +393 -0
  304. data/lib/fontisan/error.rb +281 -0
  305. data/lib/fontisan/export/exporter.rb +255 -0
  306. data/lib/fontisan/export/table_serializer.rb +140 -0
  307. data/lib/fontisan/export/transformers/font_to_ttx.rb +163 -0
  308. data/lib/fontisan/export/transformers/head_transformer.rb +94 -0
  309. data/lib/fontisan/export/transformers/hhea_transformer.rb +57 -0
  310. data/lib/fontisan/export/transformers/maxp_transformer.rb +61 -0
  311. data/lib/fontisan/export/transformers/name_transformer.rb +61 -0
  312. data/lib/fontisan/export/transformers/os2_transformer.rb +119 -0
  313. data/lib/fontisan/export/transformers/post_transformer.rb +49 -0
  314. data/lib/fontisan/export/transformers.rb +17 -0
  315. data/lib/fontisan/export/ttx_generator.rb +526 -0
  316. data/lib/fontisan/export/ttx_parser.rb +300 -0
  317. data/lib/fontisan/export.rb +13 -0
  318. data/lib/fontisan/ffi/client.rb +123 -0
  319. data/lib/fontisan/ffi/libfontisan_cdylib.so +0 -0
  320. data/lib/fontisan/ffi.rb +387 -0
  321. data/lib/fontisan/ffi_platform.rb +24 -0
  322. data/lib/fontisan/font_loader.rb +315 -0
  323. data/lib/fontisan/font_writer.rb +309 -0
  324. data/lib/fontisan/formatters/text_formatter.rb +517 -0
  325. data/lib/fontisan/formatters.rb +9 -0
  326. data/lib/fontisan/glyph_accessor.rb +525 -0
  327. data/lib/fontisan/hints/hint_converter.rb +309 -0
  328. data/lib/fontisan/hints/hint_validator.rb +287 -0
  329. data/lib/fontisan/hints/postscript_hint_applier.rb +255 -0
  330. data/lib/fontisan/hints/postscript_hint_extractor.rb +347 -0
  331. data/lib/fontisan/hints/truetype_hint_applier.rb +117 -0
  332. data/lib/fontisan/hints/truetype_hint_extractor.rb +283 -0
  333. data/lib/fontisan/hints/truetype_instruction_analyzer.rb +268 -0
  334. data/lib/fontisan/hints/truetype_instruction_generator.rb +266 -0
  335. data/lib/fontisan/hints.rb +19 -0
  336. data/lib/fontisan/loading_modes.rb +113 -0
  337. data/lib/fontisan/metrics_calculator.rb +275 -0
  338. data/lib/fontisan/models/all_scripts_features_info.rb +20 -0
  339. data/lib/fontisan/models/audit_report.rb +196 -0
  340. data/lib/fontisan/models/bitmap_glyph.rb +123 -0
  341. data/lib/fontisan/models/bitmap_strike.rb +94 -0
  342. data/lib/fontisan/models/collection_brief_info.rb +36 -0
  343. data/lib/fontisan/models/collection_font_summary.rb +52 -0
  344. data/lib/fontisan/models/collection_info.rb +79 -0
  345. data/lib/fontisan/models/collection_list_info.rb +36 -0
  346. data/lib/fontisan/models/collection_validation_report.rb +102 -0
  347. data/lib/fontisan/models/color_glyph.rb +56 -0
  348. data/lib/fontisan/models/color_layer.rb +53 -0
  349. data/lib/fontisan/models/color_palette.rb +60 -0
  350. data/lib/fontisan/models/features_info.rb +42 -0
  351. data/lib/fontisan/models/font_export.rb +158 -0
  352. data/lib/fontisan/models/font_info.rb +98 -0
  353. data/lib/fontisan/models/font_report.rb +23 -0
  354. data/lib/fontisan/models/font_summary.rb +48 -0
  355. data/lib/fontisan/models/glyph_info.rb +26 -0
  356. data/lib/fontisan/models/glyph_outline.rb +343 -0
  357. data/lib/fontisan/models/hint.rb +404 -0
  358. data/lib/fontisan/models/optical_size_info.rb +33 -0
  359. data/lib/fontisan/models/outline.rb +667 -0
  360. data/lib/fontisan/models/scripts_info.rb +39 -0
  361. data/lib/fontisan/models/svg_glyph.rb +89 -0
  362. data/lib/fontisan/models/table_info.rb +55 -0
  363. data/lib/fontisan/models/table_sharing_info.rb +40 -0
  364. data/lib/fontisan/models/ttx/glyph_order.rb +31 -0
  365. data/lib/fontisan/models/ttx/tables/binary_table.rb +67 -0
  366. data/lib/fontisan/models/ttx/tables/head_table.rb +74 -0
  367. data/lib/fontisan/models/ttx/tables/hhea_table.rb +74 -0
  368. data/lib/fontisan/models/ttx/tables/maxp_table.rb +55 -0
  369. data/lib/fontisan/models/ttx/tables/name_table.rb +45 -0
  370. data/lib/fontisan/models/ttx/tables/os2_table.rb +157 -0
  371. data/lib/fontisan/models/ttx/tables/post_table.rb +50 -0
  372. data/lib/fontisan/models/ttx/tables.rb +21 -0
  373. data/lib/fontisan/models/ttx/ttfont.rb +41 -0
  374. data/lib/fontisan/models/ttx.rb +14 -0
  375. data/lib/fontisan/models/unicode_mappings.rb +42 -0
  376. data/lib/fontisan/models/validation_report.rb +435 -0
  377. data/lib/fontisan/models/variable_font_info.rb +82 -0
  378. data/lib/fontisan/models.rb +49 -0
  379. data/lib/fontisan/native/3.2/fontisan_native.so +0 -0
  380. data/lib/fontisan/native/3.3/fontisan_native.so +0 -0
  381. data/lib/fontisan/native/3.4/fontisan_native.so +0 -0
  382. data/lib/fontisan/native/4.0/fontisan_native.so +0 -0
  383. data/lib/fontisan/native.rb +235 -0
  384. data/lib/fontisan/open_type_collection.rb +49 -0
  385. data/lib/fontisan/open_type_font.rb +161 -0
  386. data/lib/fontisan/open_type_font_extensions.rb +54 -0
  387. data/lib/fontisan/optimizers/charstring_rewriter.rb +172 -0
  388. data/lib/fontisan/optimizers/pattern_analyzer.rb +310 -0
  389. data/lib/fontisan/optimizers/stack_tracker.rb +246 -0
  390. data/lib/fontisan/optimizers/subroutine_builder.rb +135 -0
  391. data/lib/fontisan/optimizers/subroutine_generator.rb +207 -0
  392. data/lib/fontisan/optimizers/subroutine_optimizer.rb +114 -0
  393. data/lib/fontisan/optimizers.rb +14 -0
  394. data/lib/fontisan/outline_extractor.rb +417 -0
  395. data/lib/fontisan/output_guard.rb +40 -0
  396. data/lib/fontisan/parsers/dfont_parser.rb +191 -0
  397. data/lib/fontisan/parsers/tag.rb +77 -0
  398. data/lib/fontisan/parsers.rb +10 -0
  399. data/lib/fontisan/pipeline/format_detector.rb +176 -0
  400. data/lib/fontisan/pipeline/output_writer.rb +161 -0
  401. data/lib/fontisan/pipeline/strategies/base_strategy.rb +75 -0
  402. data/lib/fontisan/pipeline/strategies/instance_strategy.rb +89 -0
  403. data/lib/fontisan/pipeline/strategies/named_strategy.rb +114 -0
  404. data/lib/fontisan/pipeline/strategies/preserve_strategy.rb +54 -0
  405. data/lib/fontisan/pipeline/strategies.rb +16 -0
  406. data/lib/fontisan/pipeline/transformation_pipeline.rb +407 -0
  407. data/lib/fontisan/pipeline/variation_resolver.rb +158 -0
  408. data/lib/fontisan/pipeline.rb +14 -0
  409. data/lib/fontisan/reference/table_digests.rb +251 -0
  410. data/lib/fontisan/reference.rb +663 -0
  411. data/lib/fontisan/scan.rb +372 -0
  412. data/lib/fontisan/sfnt_builder.rb +66 -0
  413. data/lib/fontisan/sfnt_directory.rb +41 -0
  414. data/lib/fontisan/sfnt_font.rb +749 -0
  415. data/lib/fontisan/sfnt_source.rb +28 -0
  416. data/lib/fontisan/sfnt_table.rb +260 -0
  417. data/lib/fontisan/stitcher/cbdt_propagator.rb +212 -0
  418. data/lib/fontisan/stitcher/collection_result.rb +19 -0
  419. data/lib/fontisan/stitcher/deduplicator.rb +47 -0
  420. data/lib/fontisan/stitcher/format_metadata.rb +51 -0
  421. data/lib/fontisan/stitcher/glyph_cloner.rb +41 -0
  422. data/lib/fontisan/stitcher/glyph_copier.rb +110 -0
  423. data/lib/fontisan/stitcher/glyph_limit.rb +53 -0
  424. data/lib/fontisan/stitcher/glyph_signature.rb +51 -0
  425. data/lib/fontisan/stitcher/partition_strategy/base.rb +52 -0
  426. data/lib/fontisan/stitcher/partition_strategy/blueprint.rb +24 -0
  427. data/lib/fontisan/stitcher/partition_strategy/by_block.rb +430 -0
  428. data/lib/fontisan/stitcher/partition_strategy/by_plane.rb +161 -0
  429. data/lib/fontisan/stitcher/partition_strategy/by_script.rb +309 -0
  430. data/lib/fontisan/stitcher/partition_strategy/partition.rb +24 -0
  431. data/lib/fontisan/stitcher/partition_strategy.rb +24 -0
  432. data/lib/fontisan/stitcher/selector/codepoints.rb +29 -0
  433. data/lib/fontisan/stitcher/selector/gid.rb +25 -0
  434. data/lib/fontisan/stitcher/selector/range.rb +30 -0
  435. data/lib/fontisan/stitcher/selector.rb +26 -0
  436. data/lib/fontisan/stitcher/source.rb +459 -0
  437. data/lib/fontisan/stitcher/unique_glyph_name.rb +46 -0
  438. data/lib/fontisan/stitcher.rb +185 -0
  439. data/lib/fontisan/stitcher_cli.rb +69 -0
  440. data/lib/fontisan/subset/builder.rb +263 -0
  441. data/lib/fontisan/subset/glyph_mapping.rb +222 -0
  442. data/lib/fontisan/subset/options.rb +142 -0
  443. data/lib/fontisan/subset/profile.rb +152 -0
  444. data/lib/fontisan/subset/shared_state.rb +42 -0
  445. data/lib/fontisan/subset/subset_context.rb +20 -0
  446. data/lib/fontisan/subset/table_strategy/cbdt.rb +30 -0
  447. data/lib/fontisan/subset/table_strategy/cblc.rb +27 -0
  448. data/lib/fontisan/subset/table_strategy/cff.rb +92 -0
  449. data/lib/fontisan/subset/table_strategy/cff2.rb +391 -0
  450. data/lib/fontisan/subset/table_strategy/cmap.rb +146 -0
  451. data/lib/fontisan/subset/table_strategy/color_bitmap_placement.rb +20 -0
  452. data/lib/fontisan/subset/table_strategy/color_bitmap_strike_plan.rb +45 -0
  453. data/lib/fontisan/subset/table_strategy/color_bitmap_subset_plan.rb +62 -0
  454. data/lib/fontisan/subset/table_strategy/color_bitmap_subsetter.rb +182 -0
  455. data/lib/fontisan/subset/table_strategy/color_bitmap_subtable_plan.rb +59 -0
  456. data/lib/fontisan/subset/table_strategy/glyf.rb +29 -0
  457. data/lib/fontisan/subset/table_strategy/glyf_loca_builder.rb +146 -0
  458. data/lib/fontisan/subset/table_strategy/head.rb +43 -0
  459. data/lib/fontisan/subset/table_strategy/hhea.rb +67 -0
  460. data/lib/fontisan/subset/table_strategy/hmtx.rb +52 -0
  461. data/lib/fontisan/subset/table_strategy/loca.rb +41 -0
  462. data/lib/fontisan/subset/table_strategy/maxp.rb +23 -0
  463. data/lib/fontisan/subset/table_strategy/name.rb +19 -0
  464. data/lib/fontisan/subset/table_strategy/os2.rb +21 -0
  465. data/lib/fontisan/subset/table_strategy/pass_through.rb +20 -0
  466. data/lib/fontisan/subset/table_strategy/post.rb +37 -0
  467. data/lib/fontisan/subset/table_strategy.rb +79 -0
  468. data/lib/fontisan/subset/table_subsetter.rb +110 -0
  469. data/lib/fontisan/subset.rb +16 -0
  470. data/lib/fontisan/svg/font_face_generator.rb +274 -0
  471. data/lib/fontisan/svg/font_generator.rb +256 -0
  472. data/lib/fontisan/svg/glyph_generator.rb +201 -0
  473. data/lib/fontisan/svg/standalone_glyph.rb +132 -0
  474. data/lib/fontisan/svg/view_box_calculator.rb +137 -0
  475. data/lib/fontisan/svg.rb +13 -0
  476. data/lib/fontisan/svg_to_glyf/assembler.rb +174 -0
  477. data/lib/fontisan/svg_to_glyf/document.rb +102 -0
  478. data/lib/fontisan/svg_to_glyf/geometry/affine_transform.rb +112 -0
  479. data/lib/fontisan/svg_to_glyf/geometry/normalizer.rb +62 -0
  480. data/lib/fontisan/svg_to_glyf/geometry/transform_parser.rb +98 -0
  481. data/lib/fontisan/svg_to_glyf/geometry.rb +15 -0
  482. data/lib/fontisan/svg_to_glyf/path/command.rb +18 -0
  483. data/lib/fontisan/svg_to_glyf/path/contour_builder.rb +140 -0
  484. data/lib/fontisan/svg_to_glyf/path/parser.rb +98 -0
  485. data/lib/fontisan/svg_to_glyf/path/state.rb +79 -0
  486. data/lib/fontisan/svg_to_glyf/path.rb +14 -0
  487. data/lib/fontisan/svg_to_glyf.rb +62 -0
  488. data/lib/fontisan/tables/cbdt.rb +113 -0
  489. data/lib/fontisan/tables/cblc.rb +172 -0
  490. data/lib/fontisan/tables/cblc_big_glyph_metrics.rb +28 -0
  491. data/lib/fontisan/tables/cblc_bitmap_size.rb +67 -0
  492. data/lib/fontisan/tables/cblc_glyph_bitmap_location.rb +28 -0
  493. data/lib/fontisan/tables/cblc_index_subtable.rb +104 -0
  494. data/lib/fontisan/tables/cblc_index_subtable_array_entry.rb +20 -0
  495. data/lib/fontisan/tables/cblc_index_subtable_format_parser.rb +150 -0
  496. data/lib/fontisan/tables/cblc_index_subtable_header.rb +18 -0
  497. data/lib/fontisan/tables/cblc_sbit_line_metrics.rb +28 -0
  498. data/lib/fontisan/tables/cff/cff2_charstring_builder.rb +225 -0
  499. data/lib/fontisan/tables/cff/cff_glyph.rb +176 -0
  500. data/lib/fontisan/tables/cff/charset.rb +276 -0
  501. data/lib/fontisan/tables/cff/charstring.rb +978 -0
  502. data/lib/fontisan/tables/cff/charstring_builder.rb +356 -0
  503. data/lib/fontisan/tables/cff/charstring_parser.rb +249 -0
  504. data/lib/fontisan/tables/cff/charstring_rebuilder.rb +168 -0
  505. data/lib/fontisan/tables/cff/charstrings_index.rb +159 -0
  506. data/lib/fontisan/tables/cff/dict.rb +353 -0
  507. data/lib/fontisan/tables/cff/dict_builder.rb +260 -0
  508. data/lib/fontisan/tables/cff/encoding.rb +273 -0
  509. data/lib/fontisan/tables/cff/expert_charsets.rb +85 -0
  510. data/lib/fontisan/tables/cff/header.rb +100 -0
  511. data/lib/fontisan/tables/cff/hint_operation_injector.rb +207 -0
  512. data/lib/fontisan/tables/cff/index.rb +241 -0
  513. data/lib/fontisan/tables/cff/index_builder.rb +170 -0
  514. data/lib/fontisan/tables/cff/offset_recalculator.rb +70 -0
  515. data/lib/fontisan/tables/cff/private_dict.rb +282 -0
  516. data/lib/fontisan/tables/cff/private_dict_writer.rb +129 -0
  517. data/lib/fontisan/tables/cff/standard_strings_data.rb +83 -0
  518. data/lib/fontisan/tables/cff/table_builder.rb +215 -0
  519. data/lib/fontisan/tables/cff/top_dict.rb +234 -0
  520. data/lib/fontisan/tables/cff.rb +497 -0
  521. data/lib/fontisan/tables/cff2/blend_operator.rb +240 -0
  522. data/lib/fontisan/tables/cff2/charstring_parser.rb +624 -0
  523. data/lib/fontisan/tables/cff2/dict_encoder.rb +94 -0
  524. data/lib/fontisan/tables/cff2/fd_select.rb +142 -0
  525. data/lib/fontisan/tables/cff2/header.rb +34 -0
  526. data/lib/fontisan/tables/cff2/index.rb +155 -0
  527. data/lib/fontisan/tables/cff2/index_builder.rb +80 -0
  528. data/lib/fontisan/tables/cff2/operand_stack.rb +232 -0
  529. data/lib/fontisan/tables/cff2/private_dict_blend_handler.rb +247 -0
  530. data/lib/fontisan/tables/cff2/region_matcher.rb +200 -0
  531. data/lib/fontisan/tables/cff2/table_builder.rb +567 -0
  532. data/lib/fontisan/tables/cff2/table_reader.rb +418 -0
  533. data/lib/fontisan/tables/cff2/variation_data_extractor.rb +212 -0
  534. data/lib/fontisan/tables/cff2.rb +353 -0
  535. data/lib/fontisan/tables/cmap.rb +399 -0
  536. data/lib/fontisan/tables/cmap_table.rb +228 -0
  537. data/lib/fontisan/tables/colr.rb +290 -0
  538. data/lib/fontisan/tables/cpal.rb +381 -0
  539. data/lib/fontisan/tables/cvar.rb +204 -0
  540. data/lib/fontisan/tables/fvar.rb +159 -0
  541. data/lib/fontisan/tables/glyf/compound_glyph.rb +482 -0
  542. data/lib/fontisan/tables/glyf/compound_glyph_resolver.rb +135 -0
  543. data/lib/fontisan/tables/glyf/curve_converter.rb +349 -0
  544. data/lib/fontisan/tables/glyf/glyph_builder.rb +468 -0
  545. data/lib/fontisan/tables/glyf/simple_glyph.rb +391 -0
  546. data/lib/fontisan/tables/glyf.rb +347 -0
  547. data/lib/fontisan/tables/glyf_table.rb +252 -0
  548. data/lib/fontisan/tables/gpos/glyph_filter.rb +87 -0
  549. data/lib/fontisan/tables/gpos/kerning_pairs.rb +215 -0
  550. data/lib/fontisan/tables/gpos/pair_position.rb +274 -0
  551. data/lib/fontisan/tables/gpos.rb +139 -0
  552. data/lib/fontisan/tables/gsub.rb +116 -0
  553. data/lib/fontisan/tables/gvar.rb +232 -0
  554. data/lib/fontisan/tables/head.rb +208 -0
  555. data/lib/fontisan/tables/head_table.rb +108 -0
  556. data/lib/fontisan/tables/hhea.rb +199 -0
  557. data/lib/fontisan/tables/hhea_table.rb +252 -0
  558. data/lib/fontisan/tables/hmtx.rb +281 -0
  559. data/lib/fontisan/tables/hmtx_table.rb +188 -0
  560. data/lib/fontisan/tables/hvar.rb +192 -0
  561. data/lib/fontisan/tables/layout_common.rb +245 -0
  562. data/lib/fontisan/tables/loca.rb +323 -0
  563. data/lib/fontisan/tables/loca_table.rb +209 -0
  564. data/lib/fontisan/tables/maxp.rb +253 -0
  565. data/lib/fontisan/tables/maxp_table.rb +255 -0
  566. data/lib/fontisan/tables/mvar.rb +185 -0
  567. data/lib/fontisan/tables/name.rb +340 -0
  568. data/lib/fontisan/tables/name_table.rb +173 -0
  569. data/lib/fontisan/tables/os2.rb +291 -0
  570. data/lib/fontisan/tables/os2_table.rb +326 -0
  571. data/lib/fontisan/tables/post.rb +206 -0
  572. data/lib/fontisan/tables/post_table.rb +180 -0
  573. data/lib/fontisan/tables/registry.rb +71 -0
  574. data/lib/fontisan/tables/sbix.rb +379 -0
  575. data/lib/fontisan/tables/svg.rb +300 -0
  576. data/lib/fontisan/tables/variation_common.rb +345 -0
  577. data/lib/fontisan/tables/vvar.rb +234 -0
  578. data/lib/fontisan/tables.rb +69 -0
  579. data/lib/fontisan/true_type_collection.rb +160 -0
  580. data/lib/fontisan/true_type_font.rb +80 -0
  581. data/lib/fontisan/true_type_font_extensions.rb +54 -0
  582. data/lib/fontisan/type1/afm_generator.rb +379 -0
  583. data/lib/fontisan/type1/afm_parser.rb +299 -0
  584. data/lib/fontisan/type1/agl.rb +456 -0
  585. data/lib/fontisan/type1/cff_to_type1_converter.rb +307 -0
  586. data/lib/fontisan/type1/charstring_converter.rb +238 -0
  587. data/lib/fontisan/type1/charstrings.rb +441 -0
  588. data/lib/fontisan/type1/conversion_options.rb +242 -0
  589. data/lib/fontisan/type1/decryptor.rb +183 -0
  590. data/lib/fontisan/type1/encodings.rb +695 -0
  591. data/lib/fontisan/type1/font_dictionary.rb +576 -0
  592. data/lib/fontisan/type1/generator.rb +217 -0
  593. data/lib/fontisan/type1/inf_generator.rb +307 -0
  594. data/lib/fontisan/type1/pfa_generator.rb +376 -0
  595. data/lib/fontisan/type1/pfa_parser.rb +159 -0
  596. data/lib/fontisan/type1/pfb_generator.rb +321 -0
  597. data/lib/fontisan/type1/pfb_parser.rb +166 -0
  598. data/lib/fontisan/type1/pfm_generator.rb +589 -0
  599. data/lib/fontisan/type1/pfm_parser.rb +433 -0
  600. data/lib/fontisan/type1/private_dict.rb +363 -0
  601. data/lib/fontisan/type1/seac_expander.rb +517 -0
  602. data/lib/fontisan/type1/ttf_to_type1_converter.rb +389 -0
  603. data/lib/fontisan/type1/upm_scaler.rb +118 -0
  604. data/lib/fontisan/type1.rb +48 -0
  605. data/lib/fontisan/type1_font.rb +347 -0
  606. data/lib/fontisan/ufo/anchor.rb +17 -0
  607. data/lib/fontisan/ufo/bounds.rb +91 -0
  608. data/lib/fontisan/ufo/cli.rb +105 -0
  609. data/lib/fontisan/ufo/compile/avar.rb +46 -0
  610. data/lib/fontisan/ufo/compile/base_compiler.rb +162 -0
  611. data/lib/fontisan/ufo/compile/cbdt_cblc.rb +104 -0
  612. data/lib/fontisan/ufo/compile/cff.rb +229 -0
  613. data/lib/fontisan/ufo/compile/cff2.rb +323 -0
  614. data/lib/fontisan/ufo/compile/cff2_subroutines.rb +39 -0
  615. data/lib/fontisan/ufo/compile/cmap.rb +143 -0
  616. data/lib/fontisan/ufo/compile/colr.rb +80 -0
  617. data/lib/fontisan/ufo/compile/cpal.rb +62 -0
  618. data/lib/fontisan/ufo/compile/feature_compiler.rb +161 -0
  619. data/lib/fontisan/ufo/compile/feature_writers/base.rb +56 -0
  620. data/lib/fontisan/ufo/compile/feature_writers/curs.rb +72 -0
  621. data/lib/fontisan/ufo/compile/feature_writers/gdef.rb +92 -0
  622. data/lib/fontisan/ufo/compile/feature_writers/kern.rb +50 -0
  623. data/lib/fontisan/ufo/compile/feature_writers/kern2.rb +57 -0
  624. data/lib/fontisan/ufo/compile/feature_writers/mark.rb +45 -0
  625. data/lib/fontisan/ufo/compile/feature_writers/mark_family_base.rb +124 -0
  626. data/lib/fontisan/ufo/compile/feature_writers/mkmk.rb +53 -0
  627. data/lib/fontisan/ufo/compile/feature_writers.rb +38 -0
  628. data/lib/fontisan/ufo/compile/filters/cubic_to_quadratic.rb +176 -0
  629. data/lib/fontisan/ufo/compile/filters/decompose_components.rb +33 -0
  630. data/lib/fontisan/ufo/compile/filters/flatten_components.rb +22 -0
  631. data/lib/fontisan/ufo/compile/filters/propagate_anchors.rb +102 -0
  632. data/lib/fontisan/ufo/compile/filters/remove_overlaps.rb +95 -0
  633. data/lib/fontisan/ufo/compile/filters/reverse_contour_direction.rb +27 -0
  634. data/lib/fontisan/ufo/compile/filters/sort_contours.rb +69 -0
  635. data/lib/fontisan/ufo/compile/filters/transformations.rb +113 -0
  636. data/lib/fontisan/ufo/compile/filters.rb +69 -0
  637. data/lib/fontisan/ufo/compile/fvar.rb +113 -0
  638. data/lib/fontisan/ufo/compile/glyf_loca.rb +206 -0
  639. data/lib/fontisan/ufo/compile/gpos.rb +248 -0
  640. data/lib/fontisan/ufo/compile/gsub.rb +267 -0
  641. data/lib/fontisan/ufo/compile/gvar.rb +225 -0
  642. data/lib/fontisan/ufo/compile/head.rb +97 -0
  643. data/lib/fontisan/ufo/compile/hhea.rb +57 -0
  644. data/lib/fontisan/ufo/compile/hmtx.rb +38 -0
  645. data/lib/fontisan/ufo/compile/hvar.rb +42 -0
  646. data/lib/fontisan/ufo/compile/item_variation_store.rb +100 -0
  647. data/lib/fontisan/ufo/compile/math.rb +143 -0
  648. data/lib/fontisan/ufo/compile/maxp.rb +57 -0
  649. data/lib/fontisan/ufo/compile/meta.rb +51 -0
  650. data/lib/fontisan/ufo/compile/mvar.rb +59 -0
  651. data/lib/fontisan/ufo/compile/name.rb +81 -0
  652. data/lib/fontisan/ufo/compile/os2.rb +81 -0
  653. data/lib/fontisan/ufo/compile/otf2_compiler.rb +40 -0
  654. data/lib/fontisan/ufo/compile/otf_compiler.rb +34 -0
  655. data/lib/fontisan/ufo/compile/post.rb +32 -0
  656. data/lib/fontisan/ufo/compile/sbix.rb +100 -0
  657. data/lib/fontisan/ufo/compile/stat.rb +106 -0
  658. data/lib/fontisan/ufo/compile/svg_table.rb +60 -0
  659. data/lib/fontisan/ufo/compile/ttf_compiler.rb +75 -0
  660. data/lib/fontisan/ufo/compile/variable_otf.rb +84 -0
  661. data/lib/fontisan/ufo/compile/variable_ttf.rb +161 -0
  662. data/lib/fontisan/ufo/compile.rb +72 -0
  663. data/lib/fontisan/ufo/component.rb +18 -0
  664. data/lib/fontisan/ufo/contour.rb +34 -0
  665. data/lib/fontisan/ufo/convert/from_bin_data.rb +366 -0
  666. data/lib/fontisan/ufo/convert/to_dfont.rb +45 -0
  667. data/lib/fontisan/ufo/convert/to_otc.rb +40 -0
  668. data/lib/fontisan/ufo/convert/to_otf.rb +18 -0
  669. data/lib/fontisan/ufo/convert/to_otf2.rb +20 -0
  670. data/lib/fontisan/ufo/convert/to_postscript.rb +64 -0
  671. data/lib/fontisan/ufo/convert/to_ttc.rb +35 -0
  672. data/lib/fontisan/ufo/convert/to_ttf.rb +21 -0
  673. data/lib/fontisan/ufo/convert/to_woff.rb +61 -0
  674. data/lib/fontisan/ufo/convert/to_woff2.rb +50 -0
  675. data/lib/fontisan/ufo/convert.rb +84 -0
  676. data/lib/fontisan/ufo/data_set.rb +21 -0
  677. data/lib/fontisan/ufo/features.rb +17 -0
  678. data/lib/fontisan/ufo/font.rb +63 -0
  679. data/lib/fontisan/ufo/glyph.rb +445 -0
  680. data/lib/fontisan/ufo/glyph_exists_error.rb +23 -0
  681. data/lib/fontisan/ufo/groups.rb +45 -0
  682. data/lib/fontisan/ufo/guideline.rb +19 -0
  683. data/lib/fontisan/ufo/image.rb +29 -0
  684. data/lib/fontisan/ufo/image_set.rb +99 -0
  685. data/lib/fontisan/ufo/info.rb +133 -0
  686. data/lib/fontisan/ufo/kerning.rb +32 -0
  687. data/lib/fontisan/ufo/layer.rb +78 -0
  688. data/lib/fontisan/ufo/layer_set.rb +37 -0
  689. data/lib/fontisan/ufo/lib.rb +24 -0
  690. data/lib/fontisan/ufo/plist.rb +123 -0
  691. data/lib/fontisan/ufo/point.rb +32 -0
  692. data/lib/fontisan/ufo/reader.rb +163 -0
  693. data/lib/fontisan/ufo/transformation.rb +50 -0
  694. data/lib/fontisan/ufo/writer.rb +123 -0
  695. data/lib/fontisan/ufo.rb +47 -0
  696. data/lib/fontisan/unicode/plane.rb +44 -0
  697. data/lib/fontisan/unicode.rb +17 -0
  698. data/lib/fontisan/utilities/brotli_wrapper.rb +177 -0
  699. data/lib/fontisan/utilities/checksum_calculator.rb +104 -0
  700. data/lib/fontisan/utilities/padding.rb +61 -0
  701. data/lib/fontisan/utilities.rb +11 -0
  702. data/lib/fontisan/utils/thread_pool.rb +134 -0
  703. data/lib/fontisan/utils.rb +10 -0
  704. data/lib/fontisan/validation/collection_validator.rb +265 -0
  705. data/lib/fontisan/validation.rb +9 -0
  706. data/lib/fontisan/validators/basic_validator.rb +73 -0
  707. data/lib/fontisan/validators/font_book_validator.rb +107 -0
  708. data/lib/fontisan/validators/opentype_validator.rb +118 -0
  709. data/lib/fontisan/validators/profile_loader.rb +134 -0
  710. data/lib/fontisan/validators/validator.rb +494 -0
  711. data/lib/fontisan/validators/web_font_validator.rb +95 -0
  712. data/lib/fontisan/validators.rb +14 -0
  713. data/lib/fontisan/variable/axis_normalizer.rb +215 -0
  714. data/lib/fontisan/variable/delta_applicator.rb +302 -0
  715. data/lib/fontisan/variable/glyph_delta_processor.rb +218 -0
  716. data/lib/fontisan/variable/instancer.rb +172 -0
  717. data/lib/fontisan/variable/metric_delta_processor.rb +282 -0
  718. data/lib/fontisan/variable/region_matcher.rb +208 -0
  719. data/lib/fontisan/variable/static_font_builder.rb +209 -0
  720. data/lib/fontisan/variable/table_updater.rb +219 -0
  721. data/lib/fontisan/variable.rb +16 -0
  722. data/lib/fontisan/variation/blend_applier.rb +197 -0
  723. data/lib/fontisan/variation/cache.rb +299 -0
  724. data/lib/fontisan/variation/cache_key_builder.rb +162 -0
  725. data/lib/fontisan/variation/converter.rb +373 -0
  726. data/lib/fontisan/variation/data_extractor.rb +84 -0
  727. data/lib/fontisan/variation/delta_applier.rb +262 -0
  728. data/lib/fontisan/variation/delta_parser.rb +228 -0
  729. data/lib/fontisan/variation/inspector.rb +275 -0
  730. data/lib/fontisan/variation/instance_font_wrapper.rb +41 -0
  731. data/lib/fontisan/variation/instance_generator.rb +122 -0
  732. data/lib/fontisan/variation/instance_writer.rb +360 -0
  733. data/lib/fontisan/variation/instancing/axis_space.rb +136 -0
  734. data/lib/fontisan/variation/instancing/glyph_outline.rb +204 -0
  735. data/lib/fontisan/variation/instancing/gvar_reader.rb +146 -0
  736. data/lib/fontisan/variation/instancing/item_variation_store.rb +92 -0
  737. data/lib/fontisan/variation/instancing/name_rewriter.rb +90 -0
  738. data/lib/fontisan/variation/instancing/true_type_instancer.rb +326 -0
  739. data/lib/fontisan/variation/instancing.rb +20 -0
  740. data/lib/fontisan/variation/interpolator.rb +231 -0
  741. data/lib/fontisan/variation/metrics_adjuster.rb +309 -0
  742. data/lib/fontisan/variation/optimizer.rb +417 -0
  743. data/lib/fontisan/variation/parallel_generator.rb +147 -0
  744. data/lib/fontisan/variation/region_matcher.rb +221 -0
  745. data/lib/fontisan/variation/subsetter.rb +400 -0
  746. data/lib/fontisan/variation/table_accessor.rb +105 -0
  747. data/lib/fontisan/variation/tuple_variation_header.rb +49 -0
  748. data/lib/fontisan/variation/validator.rb +336 -0
  749. data/lib/fontisan/variation/variable_svg_generator.rb +235 -0
  750. data/lib/fontisan/variation/variation_context.rb +208 -0
  751. data/lib/fontisan/variation/variation_preserver.rb +287 -0
  752. data/lib/fontisan/variation.rb +33 -0
  753. data/lib/fontisan/version.rb +5 -0
  754. data/lib/fontisan/version.rb.orig +9 -0
  755. data/lib/fontisan/woff2/collection_decoder.rb +223 -0
  756. data/lib/fontisan/woff2/collection_encoder.rb +302 -0
  757. data/lib/fontisan/woff2/directory.rb +255 -0
  758. data/lib/fontisan/woff2/encoder_rules.rb +114 -0
  759. data/lib/fontisan/woff2/glyf_canonicalizer.rb +90 -0
  760. data/lib/fontisan/woff2/glyf_loca_reconstruct.rb +401 -0
  761. data/lib/fontisan/woff2/glyf_loca_transform.rb +319 -0
  762. data/lib/fontisan/woff2/header.rb +101 -0
  763. data/lib/fontisan/woff2/hmtx_transformer.rb +140 -0
  764. data/lib/fontisan/woff2/sfnt_checksum.rb +107 -0
  765. data/lib/fontisan/woff2/table_transformer.rb +575 -0
  766. data/lib/fontisan/woff2/triplet_codec.rb +181 -0
  767. data/lib/fontisan/woff2/uint255.rb +101 -0
  768. data/lib/fontisan/woff2.rb +21 -0
  769. data/lib/fontisan/woff2_collection.rb +127 -0
  770. data/lib/fontisan/woff2_font.rb +754 -0
  771. data/lib/fontisan/woff_container.rb +83 -0
  772. data/lib/fontisan/woff_font.rb +554 -0
  773. data/lib/fontisan.rb +299 -0
  774. data/rakelib/bench.rake +9 -0
  775. data/rakelib/cdylib.rake +39 -0
  776. data/rakelib/corpus.rake +272 -0
  777. data/rakelib/corpus_convert.rake +43 -0
  778. data/rakelib/corpus_goldens.rake +22 -0
  779. data/rakelib/corpus_malformed.rake +20 -0
  780. data/rakelib/corpus_scan.rake +24 -0
  781. data/rakelib/java.rake +61 -0
  782. data/rakelib/native.rake +43 -0
  783. data/scripts/build-woff2.sh +57 -0
  784. data/scripts/compare_stack_aware.rb +187 -0
  785. data/scripts/corpus/generate_convert_goldens.rb +478 -0
  786. data/scripts/corpus/generate_goldens.rb +282 -0
  787. data/scripts/corpus/generate_malformed_goldens.rb +254 -0
  788. data/scripts/corpus/generate_scan_goldens.rb +98 -0
  789. data/scripts/measure_optimization.rb +148 -0
  790. data/scripts/tier_fallback.rb +228 -0
  791. data/scripts/tier_smoke.rb +72 -0
  792. metadata +945 -0
@@ -0,0 +1,397 @@
1
+ = UFO Compilation Guide
2
+
3
+ == General
4
+
5
+ Fontisan compiles UFO (Unified Font Object) v2/v3 sources into binary
6
+ OpenType fonts — TTF, OTF (CFF1), and OTF2 (CFF2) — entirely in pure
7
+ Ruby. No AFDKO or Python fonttools required.
8
+
9
+ All compilers live under `Fontisan::Ufo::Compile` and share a common
10
+ `BaseCompiler` orchestrator that emits the required set of OpenType
11
+ tables (head, hhea, maxp, OS/2, name, post, hmtx, cmap, plus an
12
+ optional GPOS kern table when the source has kerning data). Subclasses
13
+ add format-specific outline tables.
14
+
15
+ == Compilers
16
+
17
+ [cols="1,1,3", options="header"]
18
+ |===
19
+ | Class | Output | Outline format
20
+
21
+ | `Ufo::Compile::TtfCompiler`
22
+ | `.ttf`
23
+ | Quadratic Bezier curves in the `glyf` table
24
+
25
+ | `Ufo::Compile::OtfCompiler`
26
+ | `.otf` (CFF1)
27
+ | Cubic Bezier curves in the `CFF ` table using Type 2 charstrings
28
+
29
+ | `Ufo::Compile::Otf2Compiler`
30
+ | `.otf` (CFF2)
31
+ | Cubic Bezier curves in the `CFF2` table — modern format, supports
32
+ variable fonts via blend/vsindex operators
33
+ |===
34
+
35
+ == Building a single font
36
+
37
+ [source,ruby]
38
+ ----
39
+ require "fontisan"
40
+
41
+ font = Fontisan::Ufo::Font.open("MyFont.ufo")
42
+
43
+ # TrueType
44
+ Fontisan::Ufo::Compile::TtfCompiler.new(font)
45
+ .compile(output_path: "MyFont.ttf")
46
+
47
+ # OpenType / CFF1
48
+ Fontisan::Ufo::Compile::OtfCompiler.new(font)
49
+ .compile(output_path: "MyFont.otf")
50
+
51
+ # OpenType / CFF2 (modern, supports variable fonts)
52
+ Fontisan::Ufo::Compile::Otf2Compiler.new(font)
53
+ .compile(output_path: "MyFont-CFF2.otf")
54
+ ----
55
+
56
+ == TTF filters
57
+
58
+ The TTF compiler applies two UFO glyph filters automatically:
59
+
60
+ 1. `CubicToQuadratic` — converts cubic Bezier control points to
61
+ quadratic. TTF `glyf` only supports quadratic curves; UFO sources
62
+ typically use cubics (matching PostScript/CFF conventions).
63
+ 2. `ReverseContourDirection` — reverses winding order. CFF and TTF
64
+ use opposite fill conventions (CFF: non-zero wind; TTF: even-odd by
65
+ default), so contour direction must be flipped.
66
+
67
+ These filters live under `Ufo::Compile::Filters` and are applied to
68
+ each glyph before serialization to `glyf`.
69
+
70
+ == Tables emitted
71
+
72
+ Every compiler emits this shared set:
73
+
74
+ [cols="1,3", options="header"]
75
+ |===
76
+ | Tag | Purpose
77
+
78
+ | `head` | Font header (units per em, bounding box, timestamps)
79
+ | `hhea` | Horizontal header (ascender, descender, line gap)
80
+ | `maxp` | Maximum profile (glyph count, point/contour limits)
81
+ | `OS/2` | OS/2 and Windows-specific metrics
82
+ | `name` | Name records (family, subfamily, copyright, etc.)
83
+ | `post` | PostScript name table (glyph names)
84
+ | `hmtx` | Horizontal metrics (advance width, left side bearing)
85
+ | `cmap` | Character to glyph mapping
86
+ | `GPOS` | Optional — present only when the UFO has kerning data
87
+ |===
88
+
89
+ Format-specific outline tables:
90
+
91
+ * TTF → `glyf` + `loca`
92
+ * OTF (CFF1) → `CFF `
93
+ * OTF2 (CFF2) → `CFF2`
94
+
95
+ == GPOS kerning
96
+
97
+ If the UFO source includes kerning data (`kerning.plist`), the compiler
98
+ emits a `GPOS` table with a pair-positioning lookup (feature `kern`).
99
+ When no kerning is present, no `GPOS` table is written — the file stays
100
+ smaller.
101
+
102
+ == Round-tripping binary ↔ UFO
103
+
104
+ To go the other way — extract a UFO from an existing binary font:
105
+
106
+ [source,ruby]
107
+ ----
108
+ ttf = Fontisan::FontLoader.load("MyFont.ttf")
109
+ ufo = Fontisan::Ufo::Convert::FromBinData.convert(ttf)
110
+ Fontisan::Ufo::Writer.new(ufo).write("MyFont.ufo")
111
+ ----
112
+
113
+ == Conversion wrappers (Phase 3)
114
+
115
+ For every binary format fontisan can write, there's a UFO → that
116
+ format wrapper under `Ufo::Convert`. They split into two flavors:
117
+
118
+ 1-step wrappers (compile + write directly): `ToTtf`, `ToOtf`,
119
+ `ToOtf2`.
120
+
121
+ 2-step wrappers (compile to TTF/OTF in a tmpfile, then encode):
122
+ `ToWoff`, `ToWoff2`, `ToDfont`, `ToTtc`, `ToOtc`, `ToPfb`,
123
+ `ToPfa`.
124
+
125
+ The 2-step chain looks like:
126
+
127
+ ....
128
+ UFO → Compile::*Compiler → tmpfile → FontLoader.load →
129
+ WoffWriter / Woff2Encoder / DfontBuilder /
130
+ Collection::Builder / Type1::PFB/PFAGenerator → output
131
+ ....
132
+
133
+ The tmpfile is auto-cleaned (`Dir.mktmpdir`); the original UFO is
134
+ never mutated.
135
+
136
+ Use the unified dispatcher to pick a format by symbol:
137
+
138
+ [source,ruby]
139
+ ----
140
+ require "fontisan"
141
+
142
+ ufo = Fontisan::Ufo::Font.open("MyFont.ufo")
143
+
144
+ # 1-step
145
+ Fontisan::Ufo::Convert.convert(ufo, to: :ttf, output_path: "MyFont.ttf")
146
+ Fontisan::Ufo::Convert.convert(ufo, to: :otf, output_path: "MyFont.otf")
147
+
148
+ # 2-step
149
+ Fontisan::Ufo::Convert.convert(ufo, to: :woff2, output_path: "MyFont.woff2")
150
+ Fontisan::Ufo::Convert.convert(ufo, to: :pfb, output_path: "MyFont.pfb")
151
+ ----
152
+
153
+ Format keys: `:ttf`, `:otf`, `:otf2`, `:woff`, `:woff2`, `:dfont`,
154
+ `:ttc`, `:otc`, `:pfb`, `:pfa`. Unknown keys raise `ArgumentError`.
155
+
156
+ For per-format options (zlib level, brotli quality, etc.) call the
157
+ wrapper module directly — options forward through:
158
+
159
+ [source,ruby]
160
+ ----
161
+ Fontisan::Ufo::Convert::ToWoff2.convert(ufo,
162
+ output_path: "MyFont.woff2",
163
+ compiler: :otf, # intermediate format
164
+ brotli_quality: 11, # passed to Woff2Encoder
165
+ transform_tables: true)
166
+ ----
167
+
168
+ == Glyph-processing filters (Phase 2)
169
+
170
+ Filters sit between the UFO model and the binary compilers. Each is
171
+ a stateless module under `Ufo::Compile::Filters` with a `.run(glyphs,
172
+ **opts)` entry that mutates the glyph list in place. They're
173
+ registered in `Filters::REGISTRY` so the compiler (or any caller)
174
+ can apply them by symbol:
175
+
176
+ [source,ruby]
177
+ ----
178
+ glyphs = ufo.layers.default_layer.glyphs.values
179
+ Fontisan::Ufo::Compile::Filters.apply(
180
+ %i[cubic_to_quadratic reverse_contour_direction sort_contours],
181
+ glyphs
182
+ )
183
+ ----
184
+
185
+ Available filters:
186
+
187
+ [cols="1,3", options="header"]
188
+ |===
189
+ | Filter | What it does
190
+
191
+ | `cubic_to_quadratic`
192
+ | Convert cubic Bezier curves to quadratic (TrueType only supports
193
+ quadratic; UFO sources typically use cubic).
194
+
195
+ | `reverse_contour_direction`
196
+ | Reverse point order in every contour (TrueType wants clockwise
197
+ outer winding; UFO is PostScript counter-clockwise).
198
+
199
+ | `decompose_components`
200
+ | Replace composite-glyph components with their base glyph's
201
+ contours.
202
+
203
+ | `flatten_components`
204
+ | Collapse nested component chains (A→B→C becomes A→C).
205
+
206
+ | `transformations`
207
+ | Apply a 2×3 affine matrix to every glyph's contours + components
208
+ (mirroring, slant, scaling, custom offsets).
209
+
210
+ | `sort_contours`
211
+ | Rotate each contour to start with an on-curve point and sort
212
+ contours within each glyph by Y (descending) for hinting
213
+ compatibility.
214
+
215
+ | `propagate_anchors`
216
+ | Copy anchors from base glyphs to composite glyphs (transformed by
217
+ the component matrix) so the GPOS mark feature writer can find
218
+ them on composites.
219
+ |===
220
+
221
+ Adding a new filter = one file under `compile/filters/` + one entry
222
+ in `REGISTRY`. No edits to other filters required (OCP).
223
+
224
+ == Feature writers (Phase 2)
225
+
226
+ Feature writers extract GSUB/GPOS feature data from a UFO source
227
+ into structured form for the table builders to encode. Each writer
228
+ extends `FeatureWriters::Base` with a `#write` method that returns
229
+ either a `FeatureOutput` value object or `nil` (when the UFO has
230
+ no data for the feature).
231
+
232
+ [source,ruby]
233
+ ----
234
+ require "fontisan/ufo/compile/feature_writers"
235
+
236
+ font = Fontisan::Ufo::Font.open("MyFont.ufo")
237
+ Fontisan::Ufo::Compile::FeatureWriters::DEFAULT_WRITERS.each do |writer_cls|
238
+ output = writer_cls.new(font).write
239
+ next unless output
240
+
241
+ puts "#{output.table_tag} / #{output.feature_tag} (lookup #{output.lookup_type})"
242
+ end
243
+ ----
244
+
245
+ Available writers:
246
+
247
+ [cols="1,1,3", options="header"]
248
+ |===
249
+ | Writer | GPOS / GSUB | What it emits
250
+
251
+ | `FeatureWriters::Kern`
252
+ | GPOS lookup 2 (`kern`)
253
+ | PairPos kerning pairs from `font.kerning` (parsed from
254
+ `kerning.plist`).
255
+
256
+ | `FeatureWriters::Kern2`
257
+ | GPOS lookup 2 (`kern`, format 2)
258
+ | Same pair data as Kern, tagged for the extended PairPos format
259
+ (device tables, cross-stream values). Use when you need
260
+ sub-pixel kerning.
261
+
262
+ | `FeatureWriters::Gdef`
263
+ | GDEF
264
+ | GlyphClassDef — classifies every glyph as base/ligature/mark/
265
+ spacing. Prefers `public.openTypeCategory` lib entry; falls
266
+ back to heuristic (mark anchors, `.liga` suffix).
267
+
268
+ | `FeatureWriters::Mark`
269
+ | GPOS lookup 4 (`mark`)
270
+ | MarkToBase attachment. Pairs every glyph with a `_<name>`
271
+ anchor (mark) against every glyph with the matching `<name>`
272
+ anchor (base).
273
+
274
+ | `FeatureWriters::Mkmk`
275
+ | GPOS lookup 6 (`mkmk`)
276
+ | MarkToMark attachment. Same convention as Mark but pairs marks
277
+ with other marks. Anchors are `_<name>mkmk` (attach-from) ↔
278
+ `<name>mkmk` (attach-to).
279
+
280
+ | `FeatureWriters::Curs`
281
+ | GPOS lookup 3 (`curs`)
282
+ | Cursive attachment. Emits entry/exit anchor positions for
283
+ joining-script glyphs.
284
+ |===
285
+
286
+ `FeatureWriters::DEFAULT_WRITERS = [Gdef, Kern, Mark, Mkmk, Curs]`.
287
+ The compiler runs all by default; each returns `nil` when the UFO
288
+ has no data for its feature, so it's safe to always run them all.
289
+
290
+ Adding a new writer = one file under `compile/feature_writers/` +
291
+ one entry in `DEFAULT_WRITERS`. No edits to other writers required
292
+ (OCP).
293
+
294
+ Prerequisite for Mark / Mkmk / Curs: run
295
+ `Filters::PropagateAnchors` first so composite glyphs carry their
296
+ inherited anchors.
297
+
298
+ === Usage examples
299
+
300
+ ==== Kern (pair kerning)
301
+
302
+ Extract kerning pairs from a UFO's `kerning.plist`:
303
+
304
+ [source,ruby]
305
+ ----
306
+ font = Fontisan::Ufo::Font.open("MyFont.ufo")
307
+ out = Fontisan::Ufo::Compile::FeatureWriters::Kern.new(font).write
308
+
309
+ out.data[:pairs].each do |pair|
310
+ puts "#{pair[:left]} + #{pair[:right]} = #{pair[:value]}"
311
+ end
312
+ # A + V = -80.0
313
+ # A + W = -60.0
314
+ # ...
315
+ ----
316
+
317
+ ==== Gdef (glyph classification)
318
+
319
+ Classify every glyph for GDEF:
320
+
321
+ [source,ruby]
322
+ ----
323
+ out = Fontisan::Ufo::Compile::FeatureWriters::Gdef.new(font).write
324
+ out.data[:classes].each { |name, cls| puts "#{name}: #{cls}" }
325
+ # A: 1 (base)
326
+ # f_f_i.liga: 2 (ligature)
327
+ # acutecomb: 3 (mark)
328
+ # ...
329
+ ----
330
+
331
+ ==== Mark (mark-to-base attachment)
332
+
333
+ Pair diacritical marks with base glyphs:
334
+
335
+ [source,ruby]
336
+ ----
337
+ out = Fontisan::Ufo::Compile::FeatureWriters::Mark.new(font).write
338
+ out.data[:attachments]["top"][:marks] # => {"acutecomb" => [100, 600], ...}
339
+ out.data[:attachments]["top"][:bases] # => {"A" => [100, 700], "B" => [90, 700], ...}
340
+ ----
341
+
342
+ ==== Mkmk (mark-to-mark attachment)
343
+
344
+ Stack marks above each other:
345
+
346
+ [source,ruby]
347
+ ----
348
+ out = Fontisan::Ufo::Compile::FeatureWriters::Mkmk.new(font).write
349
+ out.data[:attachments]["top"][:marks] # => {"acutecomb" => [100, 650]}
350
+ out.data[:attachments]["top"][:base_marks] # => {"dieresiscomb" => [100, 700]}
351
+ ----
352
+
353
+ ==== Curs (cursive joining)
354
+
355
+ Emit entry/exit anchors for Arabic-script glyphs:
356
+
357
+ [source,ruby]
358
+ ----
359
+ out = Fontisan::Ufo::Compile::FeatureWriters::Curs.new(font).write
360
+ out.data[:attachments]["alef"] # => {entry: [0, 100], exit: [100, 100]}
361
+ out.data[:attachments"]["beh"] # => {entry: [50, 50], exit: nil}
362
+ ----
363
+
364
+ == CLI
365
+
366
+ `fontisan ufo` exposes the four common operations:
367
+
368
+ [source,bash]
369
+ ----
370
+ # Compile a UFO to a binary font
371
+ fontisan ufo build MyFont.ufo --output MyFont.ttf [--to otf|otf2]
372
+
373
+ # Convert in either direction (UFO ↔ binary)
374
+ fontisan ufo convert MyFont.ufo MyFont.woff2
375
+ fontisan ufo convert MyFont.ttf MyFont.ufo
376
+
377
+ # Structural checks (no .notdef, no family name, etc.)
378
+ fontisan ufo validate MyFont.ufo
379
+
380
+ # Render one glyph as a standalone SVG
381
+ fontisan ufo extract MyFont.ufo A A.svg
382
+ ----
383
+
384
+ The `build` and `convert` commands route through the
385
+ `Ufo::Convert.convert` dispatcher, so adding a new format = one
386
+ registry entry — no CLI edits.
387
+
388
+ == See also
389
+
390
+ * link:AFDKO_MIGRATION.adoc[AFDKO Migration Guide] — switching from
391
+ `makeotf` / `otf2ttf` / `ttx` to fontisan's UFO pipeline.
392
+ * link:CFF2_SUPPORT.adoc[CFF2 Support Guide] — variable-font blend
393
+ operators, FDSelect, subroutines, VariationStore.
394
+ * link:VARIABLE_FONT_OPERATIONS.adoc[Variable Font Operations] —
395
+ reading and modifying existing variable fonts.
396
+ * link:STITCHER_GUIDE.adoc[Stitcher Guide] — multi-source assembly.
397
+
@@ -0,0 +1,254 @@
1
+ = Font Validation Framework
2
+
3
+ == General
4
+
5
+ Fontisan provides a comprehensive validation framework for ensuring font quality,
6
+ structural integrity, and compliance with OpenType specifications.
7
+
8
+ The framework uses a declarative DSL for defining validation checks and supports
9
+ multiple validation profiles for different use cases.
10
+
11
+ == Validation profiles
12
+
13
+ Fontisan includes predefined validation profiles:
14
+
15
+ `indexability`:: Fast font discovery and indexing (8 checks, metadata-only, ~5x faster)
16
+
17
+ `usability`:: Font installation compatibility (26 checks, macOS Font Book focused)
18
+
19
+ `production`:: Comprehensive production quality (37 checks, OpenType spec compliance - default)
20
+
21
+ `web`:: Web font embedding readiness (18 checks for web deployment)
22
+
23
+ `spec_compliance`:: Full OpenType specification compliance (detailed analysis mode)
24
+
25
+ [source,shell]
26
+ ----
27
+ $ fontisan validate --list
28
+ Available validation profiles:
29
+ indexability - Fast validation for font discovery and indexing
30
+ usability - Basic usability for installation
31
+ production - Comprehensive quality checks
32
+ web - Web embedding and optimization
33
+ spec_compliance - Full OpenType spec compliance
34
+ default - Default validation profile (alias for production)
35
+ ----
36
+
37
+ == Command-line validation
38
+
39
+ .Validate with default profile
40
+ [example]
41
+ ====
42
+ [source,shell]
43
+ ----
44
+ $ fontisan validate font.ttf
45
+
46
+ Font: font.ttf
47
+ Status: VALID
48
+
49
+ Summary:
50
+ Checks performed: 37
51
+ Passed: 37
52
+ Failed: 0
53
+
54
+ Errors: 0
55
+ Warnings: 0
56
+ Info: 0
57
+ ----
58
+ ====
59
+
60
+ .Validate for web use with summary
61
+ [example]
62
+ ====
63
+ [source,shell]
64
+ ----
65
+ $ fontisan validate font.ttf -t web -S
66
+
67
+ Font: font.ttf
68
+ Status: VALID
69
+
70
+ Summary:
71
+ Checks performed: 18
72
+ Passed: 17
73
+ Failed: 1
74
+
75
+ Errors: 1
76
+ Warnings: 0
77
+
78
+ Failed checks:
79
+ web_font_tables - Missing required GSUB table
80
+ ----
81
+ ====
82
+
83
+ .Validation with table format output
84
+ [example]
85
+ ====
86
+ [source,shell]
87
+ ----
88
+ $ fontisan validate font.ttf -T
89
+
90
+ CHECK_ID | STATUS | SEVERITY | TABLE
91
+ ------------------------------------------------------------
92
+ required_tables | PASS | error | N/A
93
+ name_version | PASS | error | name
94
+ family_name | PASS | error | name
95
+ ----
96
+ ====
97
+ ====
98
+
99
+ == Ruby API usage
100
+
101
+ === Using predefined profiles
102
+
103
+ [source,ruby]
104
+ ----
105
+ require 'fontisan'
106
+
107
+ # Validate with default profile (production)
108
+ report = Fontisan.validate('font.ttf')
109
+ puts report.valid? # => true or false
110
+
111
+ # Validate with specific profile
112
+ report = Fontisan.validate('font.ttf', profile: :web)
113
+ puts "Errors: #{report.summary.errors}"
114
+ puts "Warnings: #{report.summary.warnings}"
115
+
116
+ # Check validation status
117
+ if report.valid?
118
+ puts "Font is valid for web use!"
119
+ else
120
+ puts "Font has #{report.summary.errors} errors"
121
+ end
122
+ ----
123
+
124
+ === Query validation results
125
+
126
+ [source,ruby]
127
+ ----
128
+ report = Fontisan.validate('font.ttf', profile: :production)
129
+
130
+ # Get issues by severity
131
+ fatal_issues = report.fatal_errors
132
+ error_issues = report.errors_only
133
+ warning_issues = report.warnings_only
134
+ info_issues = report.info_only
135
+
136
+ # Get issues by category
137
+ table_issues = report.issues_by_category('table_validation')
138
+
139
+ # Get check results
140
+ failed_ids = report.failed_check_ids
141
+ pass_rate = report.pass_rate
142
+
143
+ # Export to different formats
144
+ yaml_output = report.to_yaml
145
+ json_output = report.to_json
146
+ summary = report.to_summary # "2 errors, 3 warnings, 0 info"
147
+ ----
148
+
149
+ == Creating custom validators
150
+
151
+ === General
152
+
153
+ Custom validators inherit from `Fontisan::Validators::Validator` and define
154
+ validation logic using the DSL.
155
+
156
+ The DSL provides 6 check methods:
157
+
158
+ * `check_table` - Validate table-level properties
159
+ * `check_field` - Validate specific field values
160
+ * `check_structure` - Validate font structure and relationships
161
+ * `check_usability` - Validate usability and best practices
162
+ * `check_instructions` - Validate TrueType instructions/hinting
163
+ * `check_glyphs` - Validate individual glyphs
164
+
165
+ .Creating a custom validator
166
+ [example]
167
+ ====
168
+ [source,ruby]
169
+ ----
170
+ require 'fontisan/validators/validator'
171
+
172
+ class MyFontValidator < Fontisan::Validators::Validator
173
+ private
174
+
175
+ def define_checks
176
+ # Check name table
177
+ check_table :name_validation, 'name', severity: :error do |table|
178
+ table.valid_version? &&
179
+ table.valid_encoding_heuristics? &&
180
+ table.family_name_present? &&
181
+ table.postscript_name_valid?
182
+ end
183
+
184
+ # Check head table
185
+ check_table :head_validation, 'head', severity: :error do |table|
186
+ table.valid_magic? &&
187
+ table.valid_version? &&
188
+ table.valid_units_per_em?
189
+ end
190
+
191
+ # Check structure
192
+ check_structure :required_tables, severity: :error do |font|
193
+ %w[name head maxp hhea].all? { |tag| !font.table(tag).nil? }
194
+ end
195
+ end
196
+ end
197
+
198
+ # Use the validator
199
+ font = Fontisan::FontLoader.load('font.ttf')
200
+ validator = MyFontValidator.new
201
+ report = validator.validate(font)
202
+
203
+ puts report.valid? # => true/false
204
+ puts report.summary.errors # => number of errors
205
+ puts report.summary.warnings # => number of warnings
206
+ ----
207
+ ====
208
+
209
+ == Validation helpers
210
+
211
+ The validation framework provides 56 helper methods across 8 core OpenType
212
+ tables. Each helper returns a boolean indicating whether the validation passed.
213
+
214
+ .Name table helpers:
215
+ [example]
216
+ ====
217
+ [source,ruby]
218
+ ----
219
+ class MyValidator < Fontisan::Validators::Validator
220
+ private
221
+
222
+ def define_checks
223
+ check_table :name_validation, 'name', severity: :error do |table|
224
+ table.valid_version? &&
225
+ table.valid_encoding_heuristics? &&
226
+ table.family_name_present? &&
227
+ table.postscript_name_valid?
228
+ end
229
+ end
230
+ end
231
+ ----
232
+ ====
233
+
234
+ .Head table helpers:
235
+ [example]
236
+ ====
237
+ [source,ruby]
238
+ ----
239
+ class MyValidator < Fontisan::Validators::Validator
240
+ private
241
+
242
+ def define_checks
243
+ check_table :head_validation, 'head', severity: :error do |table|
244
+ table.valid_magic? &&
245
+ table.valid_version? &&
246
+ table.valid_units_per_em? &&
247
+ table.valid_bounding_box? &&
248
+ table.valid_index_to_loc_format? &&
249
+ table.valid_glyph_data_format?
250
+ end
251
+ end
252
+ end
253
+ ----
254
+ ====