emf 0.1.0

data/lib/emf/model/geometry/rect_s.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    module Geometry
+      class RectS
+        def initialize(left:, top:, right:, bottom:)
+          @left = left
+          @top = top
+          @right = right
+          @bottom = bottom
+        end
+
+        attr_reader :left, :top, :right, :bottom
+
+        def self.from_wire(wire)
+          new(left: wire.left, top: wire.top, right: wire.right, bottom: wire.bottom)
+        end
+
+        def to_wire
+          Binary::Types::RectS.new(left: left, top: top, right: right, bottom: bottom)
+        end
+
+        def width
+          right - left
+        end
+
+        def height
+          bottom - top
+        end
+
+        def empty?
+          width <= 0 || height <= 0
+        end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            left == other.left && top == other.top &&
+            right == other.right && bottom == other.bottom
+        end
+        alias eql? ==
+
+        def hash
+          [self.class, left, top, right, bottom].hash
+        end
+      end
+    end
+  end
+end

data/lib/emf/model/geometry/size.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    module Geometry
+      class Size
+        def initialize(cx:, cy:)
+          @cx = cx
+          @cy = cy
+        end
+
+        attr_reader :cx, :cy
+
+        def self.from_wire(wire)
+          new(cx: wire.cx, cy: wire.cy)
+        end
+
+        def to_wire
+          Binary::Types::SizeL.new(cx: cx, cy: cy)
+        end
+
+        def ==(other)
+          other.is_a?(self.class) && cx == other.cx && cy == other.cy
+        end
+        alias eql? ==
+
+        def hash
+          [self.class, cx, cy].hash
+        end
+      end
+    end
+  end
+end

data/lib/emf/model/geometry.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    module Geometry
+      autoload :Point, "emf/model/geometry/point"
+      autoload :PointF, "emf/model/geometry/point_f"
+      autoload :PointS, "emf/model/geometry/point_s"
+      autoload :Size, "emf/model/geometry/size"
+      autoload :Rect, "emf/model/geometry/rect"
+      autoload :RectS, "emf/model/geometry/rect_s"
+      autoload :Color, "emf/model/geometry/color"
+      autoload :Matrix, "emf/model/geometry/matrix"
+    end
+  end
+end

data/lib/emf/model/metafile.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    class Metafile
+      include Enumerable
+
+      def initialize(format:, header:, records:, errors: [], emf_plus: nil, trailing: "")
+        @format = format
+        @header = header
+        @records = records.freeze
+        @errors = errors.freeze
+        @emf_plus = emf_plus
+        @trailing = trailing.freeze
+      end
+
+      attr_reader :format, :header, :records, :errors, :emf_plus, :trailing
+
+      def each(&block)
+        return to_enum unless block
+
+        @records.each(&block)
+      end
+
+      def errors?
+        !@errors.empty?
+      end
+
+      def ok?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/emf/model/record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    class Record
+      def type_id
+        raise NotImplementedError, "subclass must return the integer record type code"
+      end
+
+      def accept(_visitor)
+        raise NotImplementedError, "subclass must implement #accept(visitor)"
+      end
+
+      def inspect
+        "#<#{self.class.name} type_id=#{type_id}>"
+      end
+    end
+  end
+end

data/lib/emf/model/visitor.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    class Visitor
+      @visit_methods = {}
+
+      class << self
+        # Record classes call this to declare a visit method name.
+        # The base class installs a no-op default so subclasses can override
+        # only what they need.
+        def register_visit(name, record_class)
+          @visit_methods[name] = record_class
+          return if method_defined?(name)
+
+          define_method(name) { |_| nil }
+        end
+
+        attr_reader :visit_methods
+
+        # Walk every record in the metafile (and a nested EMF+ sub-stream if any),
+        # dispatching to the matching visit_* method.
+        def visit_all(visitor, metafile)
+          metafile.each { |record| record.accept(visitor) }
+          nested = metafile.emf_plus
+          visit_all(visitor, nested) if nested.is_a?(Emf::Model::Metafile)
+          visitor
+        end
+      end
+
+      def visit(record)
+        record.accept(self)
+        self
+      end
+
+      def visit_all(metafile)
+        self.class.visit_all(self, metafile)
+        self
+      end
+    end
+  end
+end

data/lib/emf/model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Emf
+  module Model
+    autoload :Metafile, "emf/model/metafile"
+    autoload :Record, "emf/model/record"
+    autoload :Visitor, "emf/model/visitor"
+    autoload :Geometry, "emf/model/geometry"
+    autoload :Emr, "emf/model/emr"
+  end
+end

data/lib/emf/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Emf
+  VERSION = "0.1.0"
+end

data/lib/emf/visitors/dump.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Emf
+  module Visitors
+    # Human-readable record-by-record dump. Used by `emf dump` (TODO 19)
+    # and as a debugging tool.
+    class Dump < Emf::Model::Visitor
+      def initialize
+        @lines = []
+      end
+
+      attr_reader :lines
+
+      def to_s
+        @lines.join("\n")
+      end
+
+      def visit(record)
+        record.accept(self)
+        self
+      end
+
+      def visit_all(metafile)
+        @lines << format("Metafile format=%s records=%d errors=%d",
+                         metafile.format, metafile.records.length, metafile.errors.length)
+        header = metafile.header
+        @lines << "  Header: #{header.class}" if header
+        metafile.each { |record| record.accept(self) }
+        metafile.errors.each { |e| @lines << "  Error: #{e.message}" }
+        self
+      end
+
+      def visit_emr_wire_record(adapter)
+        wire = adapter.wire
+        @lines << "  rec[#{adapter.offset}] type_id=#{adapter.type_id} #{wire.class.name&.split('::')&.last}"
+      end
+
+      def method_missing(name, *args)
+        return super unless name.to_s.start_with?("visit_")
+
+        record = args.first
+        return unless record
+
+        type_id = begin
+          record.type_id
+        rescue StandardError
+          nil
+        end
+        @lines << format("  rec: %s type_id=%s", record.class.name&.split("::")&.last, type_id)
+      end
+
+      def respond_to_missing?(name, _include_private = false)
+        name.to_s.start_with?("visit_") || super
+      end
+    end
+  end
+end

data/lib/emf/visitors/stats.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Emf
+  module Visitors
+    # Produces a record-class histogram for a Metafile. Used by spec assertions
+    # (TODO 16) and as a quick sanity-check dump via `emf stats` (TODO 19).
+    #
+    # The base Visitor auto-registers `visit_*` methods as no-ops. Stats
+    # overrides the generic dispatch to tally every record by its class name.
+    # Subclasses that override specific visit_* methods for richer behaviour
+    # still get tallied here because the record's accept calls the visit_*
+    # method, which (if not overridden) calls method_missing -> tally.
+    class Stats < Emf::Model::Visitor
+      def initialize
+        @counts = Hash.new(0)
+      end
+
+      attr_reader :counts
+
+      def histogram
+        @counts.sort.to_h
+      end
+
+      def total
+        @counts.values.sum
+      end
+
+      def to_s
+        lines = ["Total: #{total}", ""]
+        histogram.each { |klass, count| lines << format("%6d  %s", count, klass) }
+        lines.join("\n")
+      end
+
+      def visit(record)
+        record.accept(self)
+        self
+      end
+
+      def visit_all(metafile)
+        metafile.each { |record| record.accept(self) }
+        self
+      end
+
+      # WireAdapter is the catch-all for unknown record types. Tally by the
+      # underlying wire class so the histogram is informative.
+      def visit_emr_wire_record(adapter)
+        wire_class = adapter.wire.class.name&.split("::")&.last || "Raw"
+        @counts["WireAdapter(#{wire_class})"] += 1
+      end
+
+      def method_missing(name, *args)
+        return super unless name.to_s.start_with?("visit_")
+
+        record = args.first
+        @counts[record.class.name&.split("::")&.last || record.class.to_s] += 1 if record
+      end
+
+      def respond_to_missing?(name, _include_private = false)
+        name.to_s.start_with?("visit_") || super
+      end
+    end
+  end
+end

data/lib/emf/visitors.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Emf
+  module Visitors
+    autoload :Stats, "emf/visitors/stats"
+    autoload :Dump, "emf/visitors/dump"
+  end
+end

data/lib/emf/wmf/binary.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Placeholder until TODO.impl/07-wmf-wire-domain-parser.md.
+module Emf
+  module Wmf
+    module Binary
+    end
+  end
+end

data/lib/emf/wmf/parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Emf
+  module Wmf
+    module Parser
+      module_function
+
+      def call(_bytes)
+        raise Error, "WMF parser not yet implemented — see TODO.impl/07-wmf-wire-domain-parser.md"
+      end
+    end
+  end
+end

data/lib/emf/wmf/serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Emf
+  module Wmf
+    module Serializer
+      module_function
+
+      def call(_metafile)
+        raise SerializeError, "WMF serializer not yet implemented — see TODO.impl/07-wmf-wire-domain-parser.md"
+      end
+    end
+  end
+end

data/lib/emf/wmf.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Emf
+  module Wmf
+    autoload :Parser, "emf/wmf/parser"
+    autoload :Serializer, "emf/wmf/serializer"
+    autoload :Binary, "emf/wmf/binary"
+  end
+end

data/lib/emf.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "bindata"
+
+module Emf
+  autoload :VERSION, "emf/version"
+  autoload :Error, "emf/error"
+  autoload :FormatError, "emf/error"
+  autoload :ParseError, "emf/error"
+  autoload :SerializeError, "emf/error"
+  autoload :Detector, "emf/detector"
+  autoload :Binary, "emf/binary"
+  autoload :Model, "emf/model"
+  autoload :Visitors, "emf/visitors"
+  autoload :Wmf, "emf/wmf"
+  autoload :Emr, "emf/emr"
+  autoload :EmfPlus, "emf/emf_plus"
+
+  class << self
+    def parse(bytes)
+      case Detector.call(bytes)
+      when :wmf_apm, :wmf_standard then Wmf::Parser.call(bytes)
+      when :emf then Emr::Parser.call(bytes)
+      end
+    end
+
+    def parse_file(path)
+      parse(File.read(path, mode: "rb"))
+    end
+
+    def serialize(metafile)
+      case metafile.format
+      when :wmf then Wmf::Serializer.call(metafile)
+      when :emf, :emf_plus then Emr::Serializer.call(metafile)
+      else raise SerializeError, "unknown format: #{metafile.format.inspect}"
+      end
+    end
+
+    def serialize_file(metafile, path)
+      File.binwrite(path, serialize(metafile))
+    end
+
+    def detect_format(bytes)
+      case Detector.call(bytes)
+      when :wmf_apm, :wmf_standard then :wmf
+      when :emf then :emf
+      end
+    end
+  end
+
+  # Eager-load the shared bindata primitives so that BinData::RegisteredClasses
+  # knows about `rectl`, `point_l`, `color_ref`, etc. before any record class
+  # is autoloaded. Referencing the constant triggers the autoload of
+  # emf/binary/types, which calls register() for each primitive.
+  Binary::Types
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: emf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Pure-Ruby parser for Windows Metafile (WMF), Enhanced Metafile (EMF),
+  and EMF+ binary formats. Produces an OOP domain model that downstream gems (such
+  as emfsvg) consume.
+email:
+- open.source@ribose.com
+executables:
+- emf
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.adoc
+- exe/emf
+- lib/emf.rb
+- lib/emf/binary.rb
+- lib/emf/binary/codec.rb
+- lib/emf/binary/types.rb
+- lib/emf/detector.rb
+- lib/emf/emf_plus.rb
+- lib/emf/emf_plus/binary.rb
+- lib/emf/emf_plus/parser.rb
+- lib/emf/emf_plus/serializer.rb
+- lib/emf/emr.rb
+- lib/emf/emr/binary.rb
+- lib/emf/emr/binary/header.rb
+- lib/emf/emr/binary/record.rb
+- lib/emf/emr/binary/records.rb
+- lib/emf/emr/binary/records/abort_path.rb
+- lib/emf/emr/binary/records/alpha_blend.rb
+- lib/emf/emr/binary/records/angle_arc.rb
+- lib/emf/emr/binary/records/arc.rb
+- lib/emf/emr/binary/records/arc_to.rb
+- lib/emf/emr/binary/records/begin_path.rb
+- lib/emf/emr/binary/records/bit_blt.rb
+- lib/emf/emr/binary/records/chord.rb
+- lib/emf/emr/binary/records/close_figure.rb
+- lib/emf/emr/binary/records/color_correct_palette.rb
+- lib/emf/emr/binary/records/colormatch_to_target_w.rb
+- lib/emf/emr/binary/records/comment.rb
+- lib/emf/emr/binary/records/create_brush_indirect.rb
+- lib/emf/emr/binary/records/create_colorspace.rb
+- lib/emf/emr/binary/records/create_colorspace_w.rb
+- lib/emf/emr/binary/records/create_dib_pattern_brush_pt.rb
+- lib/emf/emr/binary/records/create_font_indirect_w.rb
+- lib/emf/emr/binary/records/create_mono_brush.rb
+- lib/emf/emr/binary/records/create_palette.rb
+- lib/emf/emr/binary/records/create_pen.rb
+- lib/emf/emr/binary/records/delete_colorspace.rb
+- lib/emf/emr/binary/records/delete_object.rb
+- lib/emf/emr/binary/records/draw_escape.rb
+- lib/emf/emr/binary/records/ellipse.rb
+- lib/emf/emr/binary/records/end_path.rb
+- lib/emf/emr/binary/records/eof.rb
+- lib/emf/emr/binary/records/exclude_clip_rect.rb
+- lib/emf/emr/binary/records/ext_create_pen.rb
+- lib/emf/emr/binary/records/ext_escape.rb
+- lib/emf/emr/binary/records/ext_flood_fill.rb
+- lib/emf/emr/binary/records/ext_select_clip_rgn.rb
+- lib/emf/emr/binary/records/ext_text_out_a.rb
+- lib/emf/emr/binary/records/ext_text_out_w.rb
+- lib/emf/emr/binary/records/fill_path.rb
+- lib/emf/emr/binary/records/fill_rgn.rb
+- lib/emf/emr/binary/records/flatten_path.rb
+- lib/emf/emr/binary/records/force_ufi_mapping.rb
+- lib/emf/emr/binary/records/frame_rgn.rb
+- lib/emf/emr/binary/records/gls_bounded_record.rb
+- lib/emf/emr/binary/records/gls_record.rb
+- lib/emf/emr/binary/records/gradient_fill.rb
+- lib/emf/emr/binary/records/intersect_clip_rect.rb
+- lib/emf/emr/binary/records/invert_rgn.rb
+- lib/emf/emr/binary/records/line_to.rb
+- lib/emf/emr/binary/records/mask_blt.rb
+- lib/emf/emr/binary/records/modify_world_transform.rb
+- lib/emf/emr/binary/records/move_to_ex.rb
+- lib/emf/emr/binary/records/named_escape.rb
+- lib/emf/emr/binary/records/offset_clip_rgn.rb
+- lib/emf/emr/binary/records/paint_rgn.rb
+- lib/emf/emr/binary/records/pie.rb
+- lib/emf/emr/binary/records/pixel_format.rb
+- lib/emf/emr/binary/records/plg_blt.rb
+- lib/emf/emr/binary/records/poly_bezier.rb
+- lib/emf/emr/binary/records/poly_bezier16.rb
+- lib/emf/emr/binary/records/poly_bezier_to.rb
+- lib/emf/emr/binary/records/poly_bezier_to16.rb
+- lib/emf/emr/binary/records/poly_draw.rb
+- lib/emf/emr/binary/records/poly_draw16.rb
+- lib/emf/emr/binary/records/poly_polygon.rb
+- lib/emf/emr/binary/records/poly_polygon16.rb
+- lib/emf/emr/binary/records/poly_polyline.rb
+- lib/emf/emr/binary/records/poly_polyline16.rb
+- lib/emf/emr/binary/records/poly_textout_a.rb
+- lib/emf/emr/binary/records/poly_textout_w.rb
+- lib/emf/emr/binary/records/polygon.rb
+- lib/emf/emr/binary/records/polygon16.rb
+- lib/emf/emr/binary/records/polyline.rb
+- lib/emf/emr/binary/records/polyline16.rb
+- lib/emf/emr/binary/records/polyline_to.rb
+- lib/emf/emr/binary/records/polyline_to16.rb
+- lib/emf/emr/binary/records/raw.rb
+- lib/emf/emr/binary/records/realize_palette.rb
+- lib/emf/emr/binary/records/rectangle.rb
+- lib/emf/emr/binary/records/resize_palette.rb
+- lib/emf/emr/binary/records/restore_dc.rb
+- lib/emf/emr/binary/records/round_rect.rb
+- lib/emf/emr/binary/records/save_dc.rb
+- lib/emf/emr/binary/records/scale_viewport_ext_ex.rb
+- lib/emf/emr/binary/records/scale_window_ext_ex.rb
+- lib/emf/emr/binary/records/select_clip_path.rb
+- lib/emf/emr/binary/records/select_object.rb
+- lib/emf/emr/binary/records/select_palette.rb
+- lib/emf/emr/binary/records/set_arc_direction.rb
+- lib/emf/emr/binary/records/set_bk_color.rb
+- lib/emf/emr/binary/records/set_bk_mode.rb
+- lib/emf/emr/binary/records/set_brush_org_ex.rb
+- lib/emf/emr/binary/records/set_colorspace.rb
+- lib/emf/emr/binary/records/set_dibits_to_device.rb
+- lib/emf/emr/binary/records/set_icm_mode.rb
+- lib/emf/emr/binary/records/set_icm_profile_a.rb
+- lib/emf/emr/binary/records/set_icm_profile_w.rb
+- lib/emf/emr/binary/records/set_layout.rb
+- lib/emf/emr/binary/records/set_linked_ufis.rb
+- lib/emf/emr/binary/records/set_map_mode.rb
+- lib/emf/emr/binary/records/set_mapper_flags.rb
+- lib/emf/emr/binary/records/set_metargn.rb
+- lib/emf/emr/binary/records/set_miter_limit.rb
+- lib/emf/emr/binary/records/set_palette_entries.rb
+- lib/emf/emr/binary/records/set_pixel_v.rb
+- lib/emf/emr/binary/records/set_poly_fill_mode.rb
+- lib/emf/emr/binary/records/set_rop2.rb
+- lib/emf/emr/binary/records/set_stretch_blt_mode.rb
+- lib/emf/emr/binary/records/set_text_align.rb
+- lib/emf/emr/binary/records/set_text_color.rb
+- lib/emf/emr/binary/records/set_text_justification.rb
+- lib/emf/emr/binary/records/set_viewport_ext_ex.rb
+- lib/emf/emr/binary/records/set_viewport_org_ex.rb
+- lib/emf/emr/binary/records/set_window_ext_ex.rb
+- lib/emf/emr/binary/records/set_window_org_ex.rb
+- lib/emf/emr/binary/records/set_world_transform.rb
+- lib/emf/emr/binary/records/small_text_out.rb
+- lib/emf/emr/binary/records/stretch_blt.rb
+- lib/emf/emr/binary/records/stretch_dibits.rb
+- lib/emf/emr/binary/records/stroke_and_fill_path.rb
+- lib/emf/emr/binary/records/stroke_path.rb
+- lib/emf/emr/binary/records/transparent_blt.rb
+- lib/emf/emr/binary/records/widen_path.rb
+- lib/emf/emr/binary/type_codes.rb
+- lib/emf/emr/binary/with_bounds.rb
+- lib/emf/emr/parser.rb
+- lib/emf/emr/path_association.rb
+- lib/emf/emr/serializer.rb
+- lib/emf/error.rb
+- lib/emf/model.rb
+- lib/emf/model/emr.rb
+- lib/emf/model/emr/header.rb
+- lib/emf/model/emr/records.rb
+- lib/emf/model/geometry.rb
+- lib/emf/model/geometry/color.rb
+- lib/emf/model/geometry/matrix.rb
+- lib/emf/model/geometry/point.rb
+- lib/emf/model/geometry/point_f.rb
+- lib/emf/model/geometry/point_s.rb
+- lib/emf/model/geometry/rect.rb
+- lib/emf/model/geometry/rect_s.rb
+- lib/emf/model/geometry/size.rb
+- lib/emf/model/metafile.rb
+- lib/emf/model/record.rb
+- lib/emf/model/visitor.rb
+- lib/emf/version.rb
+- lib/emf/visitors.rb
+- lib/emf/visitors/dump.rb
+- lib/emf/visitors/stats.rb
+- lib/emf/wmf.rb
+- lib/emf/wmf/binary.rb
+- lib/emf/wmf/parser.rb
+- lib/emf/wmf/serializer.rb
+homepage: https://github.com/claricle/emf
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/claricle/emf
+  source_code_uri: https://github.com/claricle/emf
+  changelog_uri: https://github.com/claricle/emf/blob/main/CHANGELOG.adoc
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Pure-Ruby parser for WMF, EMF, and EMF+ metafiles.
+test_files: []