emfsvg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8406a813f99a3967f711a2b650958d84f51b0583f16d982f4546fb6cd2460713
+  data.tar.gz: aec4ceefd1fcb5a45ee36e9887df3c33348d23906a2461b51a7104e87fe02088
+SHA512:
+  metadata.gz: 04d0506ac5adaef03d45450d0b93e0b352950c9c36ba4139c708d167b3cd5f62368258d5788561c5a8112da4cd8fdded08bd2e64d7587e708985bb139493f7ba
+  data.tar.gz: 4c403342b7abfb81b84eea0d3919b0db0d2307a8857cd0da167c5a1e951ff852813e2acc83f8f1d905b67b9be73c7538fe25701710567611ba98e06ef76c1405

data/LICENSE.txt

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2026, Ribose Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,104 @@
+= emfsvg: pure-Ruby EMF to SVG transformer
+
+`emfsvg` converts Microsoft Enhanced Metafile (EMF) documents to SVG
+using the [`emf`](https://github.com/claricle/emf) gem's domain model.
+It is a clean-room Ruby replacement for the FFI wrapper around the
+GPLv2 `libemf2svg` C library.
+
+== Synopsis
+
+  require "emfsvg"
+
+  svg = Emfsvg.from_file("image.emf")
+  svg = Emfsvg.from_bytes(emf_bytes, width: 400, height: 300)
+  metafile = Emf.parse(emf_bytes)
+  svg = Emfsvg.to_svg(metafile, namespace: "svg")
+
+== Command-line tool
+
+  emfsvg convert INPUT.emf OUTPUT.svg [options]
+
+Options:
+
+  -w, --width PIXELS      Override viewport width
+  -h, --height PIXELS     Override viewport height
+  -n, --namespace NAME    XML namespace prefix (e.g. svg)
+  -v, --verbose           Print record-by-record dispatch to STDERR
+      --emf-plus          Render EMF+ records instead of EMF fallback
+
+== Architecture
+
+`emfsvg` adds a renderer layer on top of `emf`'s domain model:
+
+  Emf::Model::Metafile
+       v
+  Emfsvg::Renderer
+       v
+  Emfsvg::Visitors::EmrVisitor
+       v
+  Emfsvg::SvgBuilder (XML)
+       v
+  Emfsvg::DeviceContext (GDI state)
+       v
+  Emfsvg::ObjectTable (1-indexed pen/brush/font handles)
+
+The renderer walks the metafile's records, dispatching each to a
+`visit_<record_type>` method on the visitor. State changes (pen,
+brush, transform, clip) flow through the `DeviceContext`; persistent
+objects are stored in the `ObjectTable`.
+
+=== Handlers
+
+The visitor handles a useful subset of EMF records out of the box:
+
+* *Primitives*: `Rectangle`, `Ellipse`, `RoundRect`, `LineTo`,
+  `MoveToEx`, `Arc` (stub), `Polygon`, `Polyline` + 16-bit variants
+* *Paths*: `BeginPath`/`EndPath`/`CloseFigure`/`FillPath`/`StrokePath`/
+  `StrokeAndFillPath`/`AbortPath`
+* *State*: `SetTextColor`, `SetBkColor`, `SetBkMode`, `SetMapMode`,
+  `SetRop2`, `SetPolyFillMode`, `SetTextAlign`, `SetStretchBltMode`
+* *Transform*: `SetWorldTransform`, `ModifyWorldTransform`
+* *Objects*: `CreatePen`, `CreateBrushIndirect`, `SelectObject`,
+  `DeleteObject`, `SaveDc`, `RestoreDc`
+* *Misc*: `SetMiterLimit`, `SetWindowExtEx`, `SetViewportExtEx`
+
+Unsupported record types fall through silently (verbose mode logs
+them).
+
+=== Sparx/Wine Y-repair
+
+EMFs from Sparx Enterprise Architect under Wine have only the Y anchor
+negated. The detector (`rclBounds.top * rclBounds.bottom < 0`) and the
+per-coordinate repair live in `Emfsvg::Renderer` and
+`Emfsvg::Visitors::EmrVisitor#maybe_flip_y`, matching the behaviour
+of the C library.
+
+== Installation
+
+  gem install emfsvg
+
+Or in your Gemfile:
+
+  gem "emfsvg", "~> 0.1"
+  gem "emf", "~> 0.1"
+
+Requires Ruby >= 3.1.
+
+== Development
+
+  git clone https://github.com/claricle/emfsvg
+  cd emfsvg
+  bundle install
+  bundle exec rspec
+  bundle exec rubocop
+
+== Status
+
+EMF-to-SVG renders the common subset of records from the EMF
+fixtures. Bitmap records (StretchDIBits, AlphaBlend, etc.) and
+EMF+ drawing records are not yet rendered. Corrupted inputs are
+resilient through the `emf` parser's hardened error handling.
+
+== License
+
+BSD-2-Clause. See `LICENSE.txt`.

data/exe/emfsvg

@@ -0,0 +1,69 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+require "emfsvg"
+
+module EmfsvgCLI
+  module_function
+
+  def run(argv)
+    command = argv.shift
+    case command
+    when "convert" then convert(argv)
+    when "version", "-V", "--version"
+      puts "emfsvg #{Emfsvg::VERSION}"
+    when "help", "-h", "--help", nil
+      print_help
+    else
+      warn "emfsvg: unknown command '#{command}'"
+      print_help
+      exit 1
+    end
+  end
+
+  def convert(argv)
+    options = {}
+    parser = OptionParser.new do |opts|
+      opts.banner = "Usage: emfsvg convert [OPTIONS] INPUT.emf OUTPUT.svg"
+      opts.on("-w", "--width PIXELS", Integer, "Override viewport width") { |v| options[:width] = v }
+      opts.on("-h", "--height PIXELS", Integer, "Override viewport height") { |v| options[:height] = v }
+      opts.on("-n", "--namespace NAME", "XML namespace prefix (e.g. svg)") { |v| options[:namespace] = v }
+      opts.on("-v", "--verbose", "Print record-by-record dispatch to STDERR") { options[:verbose] = true }
+      opts.on("--emf-plus", "Render EMF+ records instead of EMF fallback") { options[:emf_plus] = true }
+    end
+
+    args = parser.parse(argv)
+    if args.length != 2
+      warn parser
+      exit 2
+    end
+
+    input, output = args
+    svg = Emfsvg.from_file(input, **options)
+    File.write(output, svg)
+    warn "Wrote #{output} (#{svg.bytesize} bytes)"
+  end
+
+  def print_help
+    puts <<~HELP
+      emfsvg #{Emfsvg::VERSION} — EMF to SVG transformer
+
+      Usage:
+        emfsvg convert INPUT.emf OUTPUT.svg [options]
+        emfsvg version
+        emfsvg help
+
+      Options:
+        -w, --width PIXELS      Override viewport width
+        -h, --height PIXELS     Override viewport height
+        -n, --namespace NAME    XML namespace prefix (e.g. svg)
+        -v, --verbose           Print record-by-record dispatch to STDERR
+            --emf-plus          Render EMF+ records instead of EMF fallback
+    HELP
+  end
+end
+
+EmfsvgCLI.run(ARGV)

data/lib/emfsvg/bsd_rand.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Emfsvg
+  # Replicates BSD rand() (macOS libc default) with default seed 1, which
+  # libemf2svg relies on for clip-path IDs via get_id() → rand().
+  #
+  # The first call returns 16807, then 282475249, 1622650073, ... We pre-load
+  # 5000 values from a generated table to keep the runtime trivial. If more
+  # are needed, extend the table via `scripts/dump_rand.c`.
+  class BsdRand
+    SEQUENCE_PATH = File.expand_path("bsd_rand_sequence.txt", __dir__)
+    @values = File.readlines(SEQUENCE_PATH, chomp: true).map(&:to_i)
+    @index = 0
+
+    class << self
+      def next
+        v = @values[@index]
+        @index += 1
+        v
+      end
+
+      def reset
+        @index = 0
+      end
+
+      attr_reader :values
+    end
+  end
+end