harfbuzz 0.4 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4401c3c179f2d103fb41c0b754774021af45cc7af0de5526e378e28939e43378
-  data.tar.gz: c4c2d68da5da9f48bd5521706a17debec1a41d772cc442f0493753b6ab18bd6a
+  metadata.gz: 33191ebc2a0aed32b09e1ab47cc80518a812d7f0b8f804e102dcebf9566247c0
+  data.tar.gz: 91cf7a6db5eb787fb5915e1e692f5aa4d646215f42775e403caba72da24bbd3f
 SHA512:
-  metadata.gz: 93df44f68443d7bef5e959e1f331138e46d1c359a6e0231511376ee07813f77662d19fa021c60c7110b21ec6508b617d550cd0cf07abbd19fdd144f202fcba06
-  data.tar.gz: fdaf1f46f8a3eddab026be6d259bb74ee0f6a7654e27a119e7867ebc04b67f04ef56a7d7881c23f9806030c85ae0853fa8784c7e288f4ebb0bc82b6e0960e6b9
+  metadata.gz: 934962978e00ab939e1ebfaf279c9551a52f4115032f177075f1d3fc2dffbb56317bae5272e84d70a520de9bd229c05458049d5aeaed8a3138aab46f6d9936ec
+  data.tar.gz: fc1b54ae57f40f52171118b4addb1127ab832a6ab30d5ca91cb697793fb59d37b5966214286f6b0f1fe625b1c011c7a02a9ee39854d1f43ab409326347286c71

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
+Gemfile.lock
 *.gem

data/README.md

@@ -28,7 +28,7 @@ The Harfbuzz gem is composed of two layers: a low-level direct interface to Harf
 
 The low-level interface is a one-to-one mapping of Harfbuzz C functions to Ruby methods, implemented using the [FFI](https://github.com/ffi/ffi) library. For example, the Harfbuzz C function `hb_version_string()`  is available in Ruby as `Harfbuzz.hb_version_string`. However, as the low-level methods return C pointers wrapped in FFI objects, this layer is generally not useful to a Ruby programmer.
 
-The high-level interface abstracts the C functions, structures, and pointers into Ruby objects. For example, the aftermentioned `hb_version_string()` function is more usefully available via `Harfbuzz.version_string`, which returns a Ruby string containing with the version of the Harfbuzz library.
+The high-level interface abstracts the C functions, structures, and pointers into Ruby objects. For example, `hb_version_string()` function is more usefully available via `Harfbuzz.version_string`, which returns a Ruby string containing with the version of the Harfbuzz library.
 
 Where appropriate, Ruby classes have been constructed to map to the concepts in Harfbuzz. Hence:
 
@@ -53,6 +53,8 @@ Memory management may not be correct. (I've seen crashes when processing large a
 
 ## To-do
 
+- Update for recent (version 4.0+) versions of Harfbuzz.
+
 - Implement hb_buffer_set_* functions.
 
 - Add documentation.

data/Rakefile

@@ -1,10 +1 @@
-require 'rubygems/tasks'
-require 'rake/testtask'
-
-Gem::Tasks.new
-Rake::TestTask.new
-
-desc 'Run benchmark'
-task :benchmark do
-  load './examples/benchmark.rb'
-end
+require 'simple-rake-tasks'

data/examples/benchmark.rb

@@ -8,7 +8,7 @@ Features = %w{+dlig +hlig}
 
 Benchmark.bm do |benchmark|
   benchmark.report do
-    face = Harfbuzz::Face.new(Harfbuzz::Blob.new(File.open('/Library/Fonts/ACaslonPro-Regular.otf', 'rb')))
+    face = Harfbuzz::Face.new(Harfbuzz::Blob.new(File.open('/Users/johnl/Fonts/A/Adobe Caslon Pro/ACaslonPro-Regular.otf', 'rb')))
     font = Harfbuzz::Font.new(face)
     Words.each do |word|
       buffer = Harfbuzz::Buffer.new

data/examples/example.rb

@@ -14,7 +14,7 @@ puts "Shapers: #{Harfbuzz.shapers.join(', ')}"
 # Create a font to be used for shaping. To get the most of out this example, use an OpenType font.
 #
 
-face = Harfbuzz::Face.new(File.open('/Library/Fonts/ACaslonPro-Regular.otf', 'rb'))
+face = Harfbuzz::Face.new(File.open('/Users/johnl/Fonts/A/Adobe Caslon Pro/ACaslonPro-Regular.otf', 'rb'))
 
 puts "Font face index: #{face.index}"
 puts "Font face upem: #{face.upem}"
@@ -82,7 +82,7 @@ buffer.length.times do |i|
   info, position = glyph_infos[i], glyph_positions[i]
   glyph_name = font.glyph_to_string(info.codepoint)
   glyph_extents = font.glyph_extents(info.codepoint)
-  puts "/%-10.10s %5u | mask: %04X | cluster: %2u | advance: %4d,%4d | offset: %4d,%4d | bearing: %4d,%4d | size: %4d,%4d" % [
+  puts "/%-10.10s | gid: %5u | mask: %04X | cluster: %2u | advance: %4d,%4d | offset: %4d,%4d | bearing: %4d,%4d | size: %4d,%4d" % [
     glyph_name,
     info.codepoint,
     info.mask,

data/harfbuzz.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'harfbuzz'
-  s.version       = '0.4'
+  s.version       = '0.6'
   s.summary       = 'Ruby interface to the Harfbuzz text shaping engine'
   s.author        = 'John Labovitz'
   s.email         = 'johnl@johnlabovitz.com'
@@ -14,9 +14,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_path  = 'lib'
 
-  s.add_dependency 'ffi', '~> 1.9'
+  s.add_dependency 'ffi', '~> 1.17'
 
-  s.add_development_dependency 'rake', '~> 12.3'
-  s.add_development_dependency 'minitest', '~> 5.11'
+  s.add_development_dependency 'minitest', '~> 6.0'
   s.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  s.add_development_dependency 'rake', '~> 13.4'
+  s.add_development_dependency 'simple-rake-tasks', '~> 0.1'
 end

data/lib/harfbuzz/base.rb

@@ -4,7 +4,7 @@ module Harfbuzz
 
     def self.finalize(method, ptr)
       proc {
-        Harfbuzz.send(method, ptr) unless ptr == 0
+        Harfbuzz.send(method, ptr) if ptr
       }
     end
 

data/lib/harfbuzz/buffer.rb

@@ -12,6 +12,12 @@ module Harfbuzz
       :var1,      :uint32,  # private
       :var2,      :uint32   # private
 
+    def inspect
+      "<#{self} codepoint = 0x%04x, mask = 0b%032b, cluster = %d>" % [
+        codepoint, mask, cluster,
+      ]
+    end
+
     def codepoint
       self[:codepoint]
     end
@@ -37,8 +43,8 @@ module Harfbuzz
 
     def inspect
       "<#{self} %s>" % [
-        %w{x_advance y_advance x_offset y_offset}.map { |k|
-          "#{k} = #{self[k.to_sym].inspect}"
+        %i{x_advance y_advance x_offset y_offset}.map { |k|
+          "#{k} = #{self[k].inspect}"
         }.join(', ')
       ]
     end
@@ -62,6 +68,7 @@ module Harfbuzz
   end
 
   attach_function :hb_buffer_create, [], :hb_buffer_t
+  attach_function :hb_buffer_destroy, [:hb_buffer_t], :void
   attach_function :hb_buffer_add_utf8, [
     :hb_buffer_t,   # buffer
     :pointer,       # text

data/lib/harfbuzz/face.rb

@@ -1,14 +1,49 @@
 module Harfbuzz
 
   typedef :pointer, :hb_face_t
+  typedef :uint,    :hb_ot_name_id_t
 
   attach_function :hb_face_create, [
     :hb_blob_t,         # blob
     :uint,              # index
   ], :hb_face_t
+  attach_function :hb_face_destroy, [:hb_face_t], :void
   attach_function :hb_face_get_index, [:hb_face_t], :uint
   attach_function :hb_face_get_upem, [:hb_face_t], :uint
   attach_function :hb_face_get_glyph_count, [:hb_face_t], :uint
+  attach_function :hb_ot_name_get_utf8, [
+    :hb_face_t,         # face
+    :hb_ot_name_id_t,   # name_id
+    :hb_language_t,     # language
+    :pointer,           # text_size (uint *)
+    :pointer,           # text (char *)
+  ], :uint
+
+  HB_OT_NAME_ID_COPYRIGHT   = 0
+  HB_OT_NAME_ID_FONT_FAMILY   = 1
+  HB_OT_NAME_ID_FONT_SUBFAMILY    = 2
+  HB_OT_NAME_ID_UNIQUE_ID   = 3
+  HB_OT_NAME_ID_FULL_NAME   = 4
+  HB_OT_NAME_ID_VERSION_STRING    = 5
+  HB_OT_NAME_ID_POSTSCRIPT_NAME   = 6
+  HB_OT_NAME_ID_TRADEMARK   = 7
+  HB_OT_NAME_ID_MANUFACTURER    = 8
+  HB_OT_NAME_ID_DESIGNER    = 9
+  HB_OT_NAME_ID_DESCRIPTION   = 10
+  HB_OT_NAME_ID_VENDOR_URL    = 11
+  HB_OT_NAME_ID_DESIGNER_URL    = 12
+  HB_OT_NAME_ID_LICENSE     = 13
+  HB_OT_NAME_ID_LICENSE_URL   = 14
+  HB_OT_NAME_ID_TYPOGRAPHIC_FAMILY  = 16
+  HB_OT_NAME_ID_TYPOGRAPHIC_SUBFAMILY = 17
+  HB_OT_NAME_ID_MAC_FULL_NAME   = 18
+  HB_OT_NAME_ID_SAMPLE_TEXT   = 19
+  HB_OT_NAME_ID_CID_FINDFONT_NAME = 20
+  HB_OT_NAME_ID_WWS_FAMILY    = 21
+  HB_OT_NAME_ID_WWS_SUBFAMILY   = 22
+  HB_OT_NAME_ID_LIGHT_BACKGROUND  = 23
+  HB_OT_NAME_ID_DARK_BACKGROUND   = 24
+  HB_OT_NAME_ID_VARIATIONS_PS_PREFIX  = 25
 
   class Face < Base
 
@@ -32,6 +67,33 @@ module Harfbuzz
       Harfbuzz.hb_face_get_glyph_count(@hb_face)
     end
 
+    MAX_NAME_LEN = 200
+
+    def name(name_id, language=nil)
+      text_size_ptr = FFI::MemoryPointer.new(:uint, 1)
+      text_size_ptr.write_uint(MAX_NAME_LEN)
+      text_ptr = FFI::MemoryPointer.new(:char, MAX_NAME_LEN) #FIXME: ?
+      #FIXME: check result
+      Harfbuzz.hb_ot_name_get_utf8(@hb_face, name_id, language, text_size_ptr, text_ptr)
+      text_ptr.get_string(0, MAX_NAME_LEN)
+    end
+
+    def font_family_name(language=nil)
+      name(HB_OT_NAME_ID_FONT_FAMILY, language)
+    end
+
+    def font_subfamily_name(language=nil)
+      name(HB_OT_NAME_ID_FONT_SUBFAMILY, language)
+    end
+
+    def full_name(language=nil)
+      name(HB_OT_NAME_ID_FULL_NAME, language)
+    end
+
+    def postscript_name(language=nil)
+      name(HB_OT_NAME_ID_POSTSCRIPT_NAME, language)
+    end
+
   end
 
 end

data/lib/harfbuzz/font.rb

@@ -76,11 +76,19 @@ module Harfbuzz
   end
 
   attach_function :hb_font_create, [:hb_face_t], :hb_font_t
+  attach_function :hb_font_destroy, [:hb_font_t], :void
   attach_function :hb_font_set_scale, [
     :hb_font_t,     # font
     :int,           # x_scale
     :int,           # y_scale
   ], :void
+  attach_function :hb_font_set_ptem, [
+    :hb_font_t,
+    :float,
+  ], :void
+  attach_function :hb_font_get_ptem, [
+    :hb_font_t,
+  ], :float
   attach_function :hb_ft_font_set_funcs, [:hb_font_t], :void
   attach_function :hb_font_get_scale, [
     :hb_font_t,     # font
@@ -115,14 +123,23 @@ module Harfbuzz
     :hb_codepoint_t,     # glyph
     GlyphExtents.by_ref  # extents
   ], :hb_bool_t
+  attach_function :hb_font_get_glyph_advance_for_direction, [
+    :hb_font_t,          # font
+    :hb_codepoint_t,     # glyph
+    # :hb_direction_t,     # direction
+    :int,                # direction
+    :pointer,            # x
+    :pointer,            # y
+  ], :void
 
   class Font < Base
 
     attr_reader :hb_font
 
-    def initialize(face)
+    def initialize(face, size=nil)
       @hb_font = Harfbuzz.hb_font_create(face.hb_face)
       Harfbuzz.hb_font_set_scale(@hb_font, face.upem, face.upem)
+      Harfbuzz.hb_font_set_ptem(@hb_font, size) if size
       Harfbuzz.hb_ft_font_set_funcs(@hb_font)
       define_finalizer(:hb_font_destroy, @hb_font)
     end
@@ -147,6 +164,10 @@ module Harfbuzz
       ]
     end
 
+    def ptem
+      Harfbuzz.hb_font_get_ptem(@hb_font)
+    end
+
     def glyph_to_string(glyph)
       string_ptr = FFI::MemoryPointer.new(:char, 20)
       Harfbuzz.hb_font_glyph_to_string(@hb_font, glyph, string_ptr, 20)
@@ -179,6 +200,17 @@ module Harfbuzz
       glyph_extents
     end
 
+    def glyph_advance_for_direction(glyph, direction)
+      x_ptr = FFI::MemoryPointer.new(:int32, 1)
+      y_ptr = FFI::MemoryPointer.new(:int32, 1)
+      Harfbuzz.hb_font_get_glyph_advance_for_direction(@hb_font, glyph, direction, x_ptr, y_ptr)
+      if Harfbuzz.hb_direction_is_horizontal(direction)
+        x_ptr.read_int32
+      else
+        y_ptr.read_int32
+      end
+    end
+
     if Harfbuzz.version_at_least(1,1,3)
 
       def h_extents

data/lib/harfbuzz/language.rb

@@ -0,0 +1,37 @@
+module Harfbuzz
+
+  class Language < FFI::Struct
+
+    layout :code, :char
+
+    def code
+      self[:code]
+    end
+
+    def inspect
+      "<#{self} code = %d>" % code
+    end
+
+  end
+
+  typedef Language.by_ref, :hb_language_t
+
+  attach_function :hb_language_get_default, [], :hb_language_t
+  attach_function :hb_language_from_string, [:string, :int], :hb_language_t
+  attach_function :hb_language_to_string, [:hb_language_t], :string
+  attach_function :hb_language_matches, [:hb_language_t, :hb_language_t], :hb_bool_t
+
+  def self.language_default
+    Harfbuzz.hb_language_get_default
+  end
+
+  def self.language_from_string(string)
+    Harfbuzz.hb_language_from_string(string, -1)
+  end
+
+  def self.language_to_string(language)
+    Harfbuzz.hb_language_to_string(language)
+  end
+
+
+end

data/lib/harfbuzz.rb

@@ -13,12 +13,45 @@ module Harfbuzz
   typedef :bool,    :hb_bool_t
   typedef :int32,   :hb_position_t
 
+  # hb_direction_t enum
+  HB_DIRECTION_INVALID = 0
+  HB_DIRECTION_LTR = 4
+  HB_DIRECTION_RTL = 5
+  HB_DIRECTION_TTB = 6
+  HB_DIRECTION_BTT = 7
+
+  def self.hb_direction_is_valid(dir)
+    dir & ~3 == 4
+  end
+
+  def self.hb_direction_is_horizontal(dir)
+    dir & ~1 == 4
+  end
+
+  def self.hb_direction_is_vertical(dir)
+    dir & ~1 == 6
+  end
+
+  def self.hb_direction_is_forward(dir)
+    dir & ~2 == 4
+  end
+
+  def self.hb_direction_is_backward(dir)
+    dir & ~2 == 5
+  end
+
+  def self.hb_direction_reverse(dir)
+    dir ^ 1
+  end
+
 end
 
 require 'harfbuzz/version'
 require 'harfbuzz/base'
 require 'harfbuzz/blob'
+require 'harfbuzz/buffer'
+require 'harfbuzz/language'
+
 require 'harfbuzz/face'
 require 'harfbuzz/font'
-require 'harfbuzz/buffer'
 require 'harfbuzz/shaping'

data/test/{test_face.rb → face_test.rb}

@@ -18,6 +18,12 @@ module Harfbuzz
       assert { @face.glyph_count > 0 }
     end
 
+    def test_names
+      assert { @face.font_family_name == 'Adobe Caslon Pro' }
+      assert { @face.font_subfamily_name == 'Regular' }
+      assert { @face.postscript_name == 'ACaslonPro-Regular' }
+    end
+
   end
 
 end

data/test/{test_font.rb → font_test.rb}

@@ -6,6 +6,11 @@ module Harfbuzz
 
     include Setup
 
+    def test_init_with_size
+      font2 = Harfbuzz::Font.new(@face, 12)
+      assert { font2.ptem == 12.0 }
+    end
+
     def test_scale
       scale = @font.scale
       assert { scale.kind_of?(Array) }
@@ -38,6 +43,11 @@ module Harfbuzz
       assert { extents.height != 0 }
     end
 
+    def test_glyph_advance
+      advance = @font.glyph_advance_for_direction(1, Harfbuzz::HB_DIRECTION_LTR)
+      assert { advance > 0 }
+    end
+
   end
 
 end

data/test/general_test.rb

@@ -0,0 +1,30 @@
+require_relative 'helpers'
+
+module Harfbuzz
+
+  class TestGeneral < Minitest::Test
+
+    include Setup
+
+    def test_shapers
+      shapers = Harfbuzz.shapers
+      assert { shapers.kind_of?(Array) }
+      assert { shapers.include?('fallback') }
+    end
+
+    def test_language_default
+      assert { Harfbuzz.language_default.code == 101 }
+    end
+
+    def test_language_from_string
+      assert { Harfbuzz.language_from_string('en').code == 101 }
+    end
+
+    def test_language_to_string
+      en = Harfbuzz.language_from_string('en')
+      assert { Harfbuzz.language_to_string(en) == 'en' }
+    end
+
+  end
+
+end

data/test/helpers.rb

@@ -7,7 +7,7 @@ module Harfbuzz
   module Setup
 
     def setup
-      @data = File.open('/Library/Fonts/ACaslonPro-Regular.otf', 'rb')
+      @data = File.open('/Users/johnl/Fonts/A/Adobe Caslon Pro/ACaslonPro-Regular.otf', 'rb')
       @blob = Harfbuzz::Blob.new(@data)
       @face = Harfbuzz::Face.new(@blob)
       @font = Harfbuzz::Font.new(@face)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: harfbuzz
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.6'
 platform: ruby
 authors:
 - John Labovitz
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -16,56 +15,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-power_assert
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: minitest-power_assert
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '13.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '13.4'
+- !ruby/object:Gem::Dependency
+  name: simple-rake-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: "\n    Harfbuzz is a Ruby interface to the Harfbuzz text shaping engine.\n
   \ "
 email: johnl@johnlabovitz.com
@@ -89,20 +102,20 @@ files:
 - lib/harfbuzz/face.rb
 - lib/harfbuzz/ffi_additions.rb
 - lib/harfbuzz/font.rb
+- lib/harfbuzz/language.rb
 - lib/harfbuzz/shaping.rb
 - lib/harfbuzz/version.rb
+- test/blob_test.rb
+- test/face_test.rb
+- test/font_test.rb
+- test/general_test.rb
 - test/helpers.rb
-- test/test_blob.rb
-- test/test_face.rb
-- test/test_font.rb
-- test/test_general.rb
-- test/test_shaper.rb
-- test/test_version.rb
+- test/shaper_test.rb
+- test/version_test.rb
 homepage: http://github.com/jslabovitz/harfbuzz-gem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -117,16 +130,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 4.0.11
 specification_version: 4
 summary: Ruby interface to the Harfbuzz text shaping engine
 test_files:
+- test/blob_test.rb
+- test/face_test.rb
+- test/font_test.rb
+- test/general_test.rb
 - test/helpers.rb
-- test/test_blob.rb
-- test/test_face.rb
-- test/test_font.rb
-- test/test_general.rb
-- test/test_shaper.rb
-- test/test_version.rb
+- test/shaper_test.rb
+- test/version_test.rb

data/test/test_general.rb

@@ -1,17 +0,0 @@
-require_relative 'helpers'
-
-module Harfbuzz
-
-  class TestGeneral < Minitest::Test
-
-    include Setup
-
-    def test_shapers
-      shapers = Harfbuzz.shapers
-      assert { shapers.kind_of?(Array) }
-      assert { shapers.include?('fallback') }
-    end
-
-  end
-
-end