skrift-x11 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92507a6b036b8ab2eb0145017a938019111e2ea17c4e001a693529d2518876f3
-  data.tar.gz: 2da4b5247c4e4b085a4f4591594d09f69f2f35a93c7fe43210b68f7efbfe3798
+  metadata.gz: ed8b7aa32d9e1eb6984384f6f22488d3d6f5be7f5eef1c671c0226cf7ff431c5
+  data.tar.gz: cee3cb6866a431e8f8c2d0e4543a1eed56f85883098b1561902dd52e0641386e
 SHA512:
-  metadata.gz: 8bac35a07d623a9f27539ec68d2a2cc4eb2cc906e788660a7cbea25323d55ff30ada7ac1474f92c7caa4b8c92a50a509bf6eaf25550c5e04d6e273a13aebe15f
-  data.tar.gz: c35c1e39c5b5ef7daf70257dc14e0930ac70607e78b6bc8397563964377d8e090b4472162fbbb061c05c584553ae6d0b7e937e7d3ecc156f534b6eed518c41e5
+  metadata.gz: be22707412fa343bb25f8a9ddbd754801090ccf1458041aeb91c18513d8a963d2121eeae293a65d34d6c782d9d7d166f57b8448bb30dd755ae6452a0a3c9bc27
+  data.tar.gz: 84b80afb3b159bfbdc5733a397c670305b7c6dfc4d37a8e9cfac57bdb12b775703bf65ddbf62ef5a0eeab32ccad3a8ce270b9eec7cd15b99708f196b2454f2ea

data/example.rb

@@ -52,7 +52,7 @@ f = Font.load("resources/FiraGO-Regular_extended_with_NotoSansEgyptianHieroglyph
 $skrift = Skrift::X11::Glyphs.new(dpy, f, x_scale: 40, y_scale: 40)
 
 def redraw(dpy, wid, gc)
-  dpy.poly_fill_rectangle(wid, gc, [X11::Form::Rectangle.new(20,45, 400, 400)])
+  dpy.poly_fill_rectangle(wid, gc, [20,45, 400, 400])
   $skrift.render_str($pic, 0xffffff, 50,90, 'Pure Ruby w/Skrift!')
   $skrift.render_str($pic, 0xffffff, 50,140, "And unicode:")
   $skrift.render_str($pic, 0xff00ff, 50,200, "Μπορώ να φάω σπασμένα γυαλιά χωρίς να πάθω τίποτα.")

data/lib/skrift/x11/glyphs.rb

@@ -1,40 +1,67 @@
+require 'skrift/boxdrawing'
 
-require 'skrift'
-module Skrift
-  module X11
-    # XRender constants currently not defined in pure-x11.
-    # FIXME.
+# Colour-glyph support is optional: only needed when a `color:` font is given.
+begin
+  require 'skrift/color'
+rescue LoadError
+  # skrift-color not installed; colour rendering will be unavailable.
+end
+
+module X11
+  # XRender constants currently not defined in pure-x11.
+  # FIXME: these are generic XRender enumerants and belong in pure-x11.
+  module Form
     PictOpSrc=1
     PictOpOver=3
     CPRepeat = 1
+  end
+end
 
+module Skrift
+  module X11
+    # Thin XRender adapter over Skrift::GlyphCache. Monochrome glyphs go into an
+    # A8 glyph set (coloured at composite time by a solid fill); colour glyphs
+    # (emoji, via the skrift-color delegate) go into an ARGB32 glyph set and are
+    # composited with a neutral white source so their own colours show. A string
+    # is drawn as runs of like-typed glyphs, one composite per run. All the
+    # platform-independent work (fallback, rasterisation, layout, caching, box
+    # drawing, colour delegation) lives in skrift core + the plugins.
     class Glyphs
+      attr_reader :fixed_width
+      attr_accessor :maxheight, :lm
 
-      def initialize dpy, font, x_scale:, y_scale:, pic: nil, fixed: nil
+      # +color+ (optional) is a font (path, name or Skrift::Font) providing
+      # colour glyphs, e.g. an emoji font; requires the skrift-color gem.
+      def initialize(dpy, font=nil, fontset: nil, x_scale:, y_scale:, pic: nil, fixed: nil, maxheight: nil, fit: false, color: nil)
         @dpy = dpy
-        @sft = SFT.new(font)
-        @sft.x_scale = x_scale
-        @sft.y_scale = y_scale
         @pic = pic
-        @fixed = fixed
+        @maxheight = maxheight
 
-        @glyphcache = {}
-        @colcache   = {}
-        @chcache = {}
+        color_renderer = build_color_renderer(color, x_scale, y_scale)
+        @cache = Skrift::GlyphCache.new(fontset || font,
+                                        x_scale: x_scale, y_scale: y_scale,
+                                        fixed: fixed, maxheight: maxheight, fit: fit,
+                                        special: ->(cp) { @boxes.glyph(cp) },
+                                        color: color_renderer)
+        @boxes = Skrift::BoxDrawing.new(@cache.cell_width, @cache.cell_height)
+        @fixed_width = @cache.cell_width
+        @lm = Skrift::LMetrics.new(@cache.ascent, @cache.descent, @cache.line_gap)
 
-        @lm = @sft.lmetrics
+        @colcache = {}
+        @gids     = {}        # codepoint -> [:mono|:color, glyph-set id]
+        @nextgid  = 1
 
-        # The glyph set
         @gfmt     = @dpy.render_find_standard_format(:a8).id
         @glyphset = @dpy.render_create_glyph_set(@gfmt)
-      end
 
-      attr_accessor :lm
-      def gm(ch)
-        gid = @sft.lookup(ch.ord)
-        @sft.gmetrics(gid)
+        if color_renderer
+          @cfmt      = @dpy.render_find_standard_format(:argb24).id
+          @cglyphset = @dpy.render_create_glyph_set(@cfmt)
+          @white     = @dpy.render_create_solid_fill(0xffff, 0xffff, 0xffff, 0xffff)
+        end
       end
-    
+
+      def inspect = "<Glyphs #{object_id}>"
 
       def fill_for_col(col)
         return @colcache[col] if @colcache[col]
@@ -44,89 +71,109 @@ module Skrift
         g |= g << 8
         b = col & 0xff
         b |= b << 8
-        
-        @colcache[col] ||= @dpy.render_create_solid_fill(r,g,b,0xffff)
+        @colcache[col] = @dpy.render_create_solid_fill(r, g, b, 0xffff)
       end
 
-      def fixed_width
-        return @fixed_width if @fixed_width
-        if @fixed
-          # *Ensure* that the glyphs are equal width.
-          g = gm("M")
-          @fixed_width = g.advance_width.ceil
-        else
-          nil
+      def text_width(str) = @cache.text_width(str)
+
+      # Draw +str+ as one composite per run of same-typed glyphs (mono vs
+      # colour). Each rendered glyph advances the pen by one cell, so a pure-text
+      # string is a single A8 composite exactly as before; emoji break the run.
+      def render_str(pic, col, x, y, str)
+        glyphs   = str.to_s.each_char.map { |ch| gsgid_for(ch.ord) }
+        rendered = 0
+        i = 0
+        while i < glyphs.length
+          (i += 1; next) if glyphs[i].nil? # unmapped: skip, no advance
+          type   = glyphs[i].first
+          run_x  = x + rendered * @fixed_width
+          ids    = []
+          while i < glyphs.length && glyphs[i] && glyphs[i].first == type
+            ids << glyphs[i].last
+            rendered += 1
+            i += 1
+          end
+          composite_run(type, pic, col, run_x, y, ids)
         end
       end
-    
-  
-      def cache_glyph(gid, baseline)
-        return if gid.nil?
-        mtx = @sft.gmetrics(gid)
-
-        # FIXME: Not sure what to do if mtx.nil? here.
-        # Maybe use x/y scale?
-        w = fixed_width || mtx.min_width || 0
-        h = mtx.min_height || 1
-        #p [w,h]
-        img = Image.new((w+3)&~3, h)
-        if !@sft.render(gid, img)
-          #STDERR.puts "Unable to render #{gid}\n"
-          data = "\0"*(w*h)
+
+      private
+
+      def build_color_renderer(color, x_scale, y_scale)
+        return nil unless color
+        # A caller can pass its own delegate (e.g. one that gates which
+        # codepoints render in colour); we use it as-is. Otherwise treat the
+        # argument as a font and build an ungated Color::Renderer from it.
+        return color if color.respond_to?(:render)
+        unless defined?(Skrift::Color::Renderer)
+          raise "colour glyphs require the skrift-color gem"
+        end
+        font = Skrift::FontSet.new(color)[0]
+        Skrift::Color::Renderer.new(font, x_scale: x_scale, y_scale: y_scale)
+      end
+
+      def composite_run(type, pic, col, x, y, ids)
+        if type == :color
+          @dpy.render_composite_glyphs32(:PictOpOver, @white, pic, @cfmt, @cglyphset, 0, 0, [x, y, ids])
         else
-          data = img.pixels.pack("C*")
+          @dpy.render_composite_glyphs32(:PictOpOver, fill_for_col(col), pic, @gfmt, @glyphset, 0, 0, [x, y, ids])
         end
-        
-        yoff = mtx.y_offset || baseline
-        
-        info = ::X11::Form::GlyphInfo.new(
-          img.width,              # w
-          img.height,             # h
-          -mtx.left_side_bearing, # x
-          yoff-baseline,          # y
-          fixed_width || mtx.advance_width, # || mtx.advance_width,      # x_off
-          0
-        )
-
-        @dpy.render_add_glyphs(@glyphset, gid, info, data)
-        @glyphcache[gid] = mtx.advance_width#-mtx.left_side_bearing
       end
 
-      def text_width(str)
-        gl = map_glyphs(str)
-        # We *presume* that if you call text_width, you intend
-        # to render the string. Maybe we shouldn't?
-        cache_glyphs(gl)
-        gl.inject(0) {|sum,gl|
-          @glyphcache[gl].to_i + sum
-        }
+      # [:mono|:color, glyph-set id] for a codepoint, uploading on first use, or
+      # nil for a codepoint no font maps (and which isn't box drawing/colour).
+      def gsgid_for(cp)
+        return @gids[cp] if @gids.key?(cp)
+        @gids[cp] = upload(cp)
       end
-      
-      def map_glyphs(str)
-        # FIXME: Should probably cache by character rather than
-        # glyph
-        str.to_s.each_char.map do |ch|
-          @chcache[ch] ||= @sft.lookup(ch.ord).to_i
+
+      def upload(cp)
+        # NUL doubles as the double-width spacer (the trailing cell of a wide
+        # glyph): a blank cell that only advances, letting the wide glyph in the
+        # previous cell overflow into it.
+        return upload_blank if cp.zero?
+
+        g = @cache.glyph(cp)
+        return nil unless g
+
+        gsgid = @nextgid
+        @nextgid += 1
+        if g.color?
+          @dpy.render_add_glyphs(@cglyphset, gsgid, glyph_info(g), argb_data(g.rgba))
+          [:color, gsgid]
+        elsif g.alpha
+          @dpy.render_add_glyphs(@glyphset, gsgid, glyph_info(g), g.alpha.pack("C*"))
+          [:mono, gsgid]
+        else
+          upload_blank # no outline (e.g. space)
         end
       end
-      
-      def cache_glyphs(gl)
-        gl.each do |gid|
-          data = @glyphcache[gid]
-          if !data
-            data = cache_glyph(gid, @lm.ascender)
-          end
-        end
+
+      # A blank glyph that only advances one cell.
+      def upload_blank
+        gsgid = @nextgid
+        @nextgid += 1
+        info = ::X11::Form::GlyphInfo.new(0, 0, 0, 0, @fixed_width, 0)
+        @dpy.render_add_glyphs(@glyphset, gsgid, info, "".b)
+        [:mono, gsgid]
       end
-      
-      def render_str(pic, col, x,y, str)
-        fill = fill_for_col(col)
-        gl = map_glyphs(str)
-        cache_glyphs(gl)
-        @dpy.render_composite_glyphs32(
-          PictOpOver, fill, pic, @gfmt,
-          @glyphset, 0,0, [x, y, gl]
-        )
+
+      def glyph_info(g)
+        ::X11::Form::GlyphInfo.new(g.width, g.height,
+                                   -g.left_side_bearing, g.y_offset - @cache.baseline,
+                                   @fixed_width, 0)
+      end
+
+      # Pack straight-alpha 0xRRGGBBAA pixels as premultiplied ARGB32 in the
+      # little-endian byte order XRender's argb format expects (B, G, R, A).
+      def argb_data(rgba)
+        rgba.map do |px|
+          a = px & 0xff
+          r = (((px >> 24) & 0xff) * a) / 255
+          g = (((px >> 16) & 0xff) * a) / 255
+          b = (((px >> 8) & 0xff) * a) / 255
+          (a << 24) | (r << 16) | (g << 8) | b
+        end.pack("L<*")
       end
     end
   end

data/lib/skrift/x11/version.rb

@@ -2,6 +2,6 @@
 
 module Skrift
   module X11
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/skrift-x11.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/skrift/x11/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "skrift-x11"
+  spec.version = Skrift::X11::VERSION
+  spec.authors = ["Vidar Hokstad"]
+  spec.email = ["vidar@hokstad.com"]
+
+  spec.summary = "Helpers to use the pure-Ruvy TrueType engine Skrift with pure Pure-X11 X bindings"
+  #spec.description = "TODO: Write a longer description or delete this line."
+  #spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "skrift", ">= 0.3.0"
+  spec.add_dependency "skrift-boxdrawing", ">= 0.2.0"
+  spec.add_dependency "pure-x11"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skrift-x11
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vidar Hokstad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-12 00:00:00.000000000 Z
+date: 2026-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: skrift
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: skrift-boxdrawing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: pure-x11
   requirement: !ruby/object:Gem::Requirement
@@ -55,6 +69,7 @@ files:
 - lib/skrift/x11/version.rb
 - resources/FiraGO-Regular_extended_with_NotoSansEgyptianHieroglyphs-Regular.ttf
 - sig/skrift/x11.rbs
+- skrift-x11.gemspec
 homepage: 
 licenses:
 - MIT