skrift-x11 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a086ab34c955c628b9b32640d98e26415a2e6766e9a784797893b6c8ef7473b0
+  data.tar.gz: 89a0ea4e3ee0cf221037e6c951d746c63f00140dd775f1b332cb0d7afdc52c67
+SHA512:
+  metadata.gz: 8cf85e533b7d29eb13e993842a83a09bd3eaf7322fe41d93d5290637788d5bd944a90dd96f3f21f618edf2d03998f9667f7c403621470622fd552d72f6d039be
+  data.tar.gz: e07c349839802875a8d73f13a0dd2daa3beb76c12f52677f34a7a5f5bdd76aab8acdb38dc5c5c59e5612aad1ae2716ba7ffe223a86b4ca63eebae5fde1eae21d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Vidar Hokstad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Skrift::X11
+
+Skrift::X11 is a binding for the pure-Ruby pure-x11 gem for the pure-
+Ruby [Skrift TrueType engine](https://github.com/vidarh/skrift)
+
+It can produce output like this (see `example.rb`):
+
+![Example image](https://raw.githubusercontent.com/vidarh/skrift-x11/master/example.png)
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add skrift-x11
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install skrift-x11
+
+## Usage
+
+See `example.rb`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vidarh/skrift-x11.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/example.rb

@@ -0,0 +1,85 @@
+#require 'rubygems'
+require 'skrift'
+require 'X11'
+require 'bundler'
+require 'chunky_png'
+require 'pp'
+
+Bundler.setup(:default, :development)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'skrift/x11'
+
+$dpy = dpy = display = X11::Display.new
+screen = dpy.screens.first
+
+# Transparency: Check
+# https://stackoverflow.com/questions/13395179/empty-or-transparent-window-with-xlib-showing-border-lines-only/13397150#13397150
+
+# FIXME: Hack; see XFindVisualMatch
+visual = 123
+
+cmap = $dpy.create_colormap(0, screen.root, visual)
+
+wid = display.new_id
+$dpy.create_window(
+  32, 
+  wid, screen.root,
+  0, 0, # x,y
+  1000, 600, # w,h
+  0,
+  X11::Form::InputOutput,
+  visual, #X11::Form::CopyFromParent -- Must be provided if e.g. depth is different than root.
+  X11::Form::CWBackPixel | X11::Form::CWBorderPixel |
+    X11::Form::CWEventMask | X11::Form::CWColorMap,
+  [0x00000000, # ARGB background
+   0x0, # Border pixel; Necessary when depth != screen.root_depth
+   X11::Form::SubstructureNotifyMask |
+   X11::Form::StructureNotifyMask    | ## Move
+   X11::Form::ExposureMask           |
+   X11::Form::KeyPressMask           |
+   X11::Form::ButtonPressMask,
+   cmap # Colormap. Necessary when depth != screen.root_depth
+  ]
+)
+
+dpy.map_window(wid) # Window won't be visible until this
+
+# A "picture" object for us to draw in the window with.
+fmt  = dpy.render_find_visual_format(visual)
+$pic = dpy.render_create_picture(wid, fmt)
+
+# The easy way
+#$fgpic = dpy.render_create_solid_fill(0xffff,0xffff,0,0)
+
+
+$gc  = dpy.create_gc(wid, foreground: 0xffff0000)
+
+puts "Main loop"
+
+$f = Font.load("resources/FiraGO-Regular_extended_with_NotoSansEgyptianHieroglyphs-Regular.ttf")
+
+$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)])
+  $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, "Μπορώ να φάω σπασμένα γυαλιά χωρίς να πάθω τίποτα.")
+  $skrift.render_str($pic, 0x00ffff, 50,250, "Я можу їсти шкло, й воно мені не пошкодить.")
+end
+
+loop do
+  pkt = display.next_packet
+  if pkt
+    #puts pkt.inspect[0..200]
+    #raise "Error" if pkt.is_a?(X11::Form::Error)
+    redraw(display, wid, $gc) if pkt.is_a?(X11::Form::Expose)
+
+    if pkt.is_a?(X11::Form::KeyPress)
+#      lookup_keysym(dpy,pkt)
+    end
+  end
+end

data/lib/skrift/x11/glyphs.rb

@@ -0,0 +1,129 @@
+
+require 'skrift'
+module Skrift
+  module X11
+    # XRender constants currently not defined in pure-x11.
+    # FIXME.
+    PictOpSrc=1
+    PictOpOver=3
+    CPRepeat = 1
+
+    class Glyphs
+
+      def initialize dpy, font, x_scale:, y_scale:, pic: nil, fixed: nil
+        @dpy = dpy
+        @sft = SFT.new(font)
+        @sft.x_scale = x_scale
+        @sft.y_scale = y_scale
+        @pic = pic
+        @fixed = fixed
+
+        @glyphcache = {}
+        @colcache   = {}
+
+        @lm = @sft.lmetrics
+
+        # 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)
+      end
+    
+
+      def fill_for_col(col)
+        return @colcache[col] if @colcache[col]
+        r = col >> 16
+        r |= r << 8
+        g = (col >> 8) & 0xff
+        g |= g << 8
+        b = col & 0xff
+        b |= b << 8
+        
+        @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
+        end
+      end
+    
+  
+      def cache_glyph(gid, baseline)
+        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)
+        else
+          data = img.pixels.pack("C*")
+        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
+        }
+      end
+      
+      def map_glyphs(str)
+        # FIXME: Should probably cache by character rather than
+        # glyph
+        str.to_s.each_char.map { |ch| @sft.lookup(ch.ord) }
+      end
+      
+      def cache_glyphs(gl)
+        gl.each do |gid|
+          data = @glyphcache[gid]
+          if !data
+            data = cache_glyph(gid, @lm.ascender)
+          end
+        end
+      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]
+        )
+      end
+    end
+  end
+end

data/lib/skrift/x11/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Skrift
+  module X11
+    VERSION = "0.1.0"
+  end
+end

data/lib/skrift/x11.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "x11/version"
+require_relative "x11/glyphs"
+
+module Skrift
+  module X11
+    class Error < StandardError; end
+  end
+end

data/sig/skrift/x11.rbs

@@ -0,0 +1,6 @@
+module Skrift
+  module X11
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: skrift-x11
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vidar Hokstad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: skrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pure-x11
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- vidar@hokstad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- example.png
+- example.rb
+- lib/skrift/x11.rb
+- lib/skrift/x11/glyphs.rb
+- lib/skrift/x11/version.rb
+- resources/FiraGO-Regular_extended_with_NotoSansEgyptianHieroglyphs-Regular.ttf
+- sig/skrift/x11.rbs
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Helpers to use the pure-Ruvy TrueType engine Skrift with pure Pure-X11 X
+  bindings
+test_files: []