[ruby-dev:14582] Re: marshal API (was Re: [Patch] pp.rb and debug.rb)

咳といいます。

投稿しないとサボってすすまないので、やりかけのものをポストします。

> > なひは、marshalおよびunmarshalの実装は、一行も書きたくないです。
> > traverseしてdumpする/loadしてネットワークを構築するという機能は
> > Ruby本体が既に持っており、また今後も提供していくだろう機能なので、
> > そのカスタマイズ用界面（API）をうまく定義することによって、
> > custom marshal/unmarshalで流用したい。
> > custom marshal/unmarshalをする人たちで共有したい（10個あったら3000行）。
> 
> すばらしいです。オブジェクト群からの情報抽出・再構成と外部フォーマット
> の定義を完全に分離しようという決意のあらわれですね。うむうむ。まったく
> もってそういうふうにモジュール化されるべきですね。

* トラバーズする層
* その結果を外部フォーマットの出力層

にわかれるんでしょうね。

機能で層がわかれるというか、情報の層がちがうのかな。

[Rubyオブジェクトのネットワーク]
               |
           traverser
               |
    [抽象化したネットワーク]  → オブジェクトを再構成する情報の 列 ができる。
               |
           formatter
               |
      [任意のフォーマット]


んで、いまそういうのを書きはじめてみました。

気持ちとしては、marshal.cのw_objectがバッファを出力する代わりに、
オブジェクトを再構成する情報(BMarshal::Ref)を出力します。

フォーマッタはそれを任意の形、順序で外部フォーマットに出力できます。

とりあえず、うそSOAPっぽい出力をさせてみました。
marshal.cの出力と同じものを出すのも簡単だと思います。


---------
class BTraverser
  I32 = (-2147483647-1)..2147483647

  class Ref
    def initialize
      @klass = nil
      @primary = nil
      @ivars = {}
      @custom_loader = false
    end
    attr_accessor :klass, :custom_loader
    attr_reader :ivars, :primary

    # primaryってヘンだな。bodyのがいいかも
    def push_primary(it)
      @primary = [] unless @primary
      @primary.push(it)
    end
  end

  def initialize
    @map = {}
    @limit = nil
    @stream = []
    @cur = nil
  end
  attr_accessor :map, :limit, :stream

  # w_objectというメソッド、呼ばれてないっす。@limitも見てない
  def w_object(obj)
    raise(ArgError, 'exeed depth limit') if @limit == 0
    case obj
    when nil, true, false
      @stream.push(obj)
    when Fixnum
      if I32 === obj
	@stream.push(obj)
      else
	make_ref(obj)
      end
    else
      make_ref(obj)
    end
  end

  def make_ref(obj)
    ref = @map[obj.__id__]
    if ref
      @stream.push ref
      return ref
    end

    ref = Ref.new
    @map[obj.__id__] = ref
    @stream.push ref
    begin
      stack = @cur
      @cur = ref

      ref.klass = obj.class

      if obj.respond_to? (:__load)
	ref.custom_loader = true
      end
      obj.__dump(self)

    ensure
      @cur = stack
    end
    
    return ref
  end

  def put_class(klass)
    @cur.klass = klass
  end

  def put_primary(v)
    @cur.push_primary(v)
  end

  def put_ivar(n, v)
    @cur.ivars[n] = v
  end

  def put_all_ivars(obj)
    obj.instance_variables.each do |var|
      value = obj.instance_eval var
      @cur.ivars[var] = self.put(value)
    end
  end

  def put(obj)
    #    w_object(obj)
    make_ref(obj)
  end
end

class Fixnum
  def __dump(dumper)
    dumper.put_primary(to_i)
  end
end

class Object
  def __dump(dumper)
    dumper.put_all_ivars(self)
  end
end

class Symbol
  def __dump(dumper)
    dumper.put_primary(self.id2name)
  end
end

class Module
  def __dump(dumper)
    dumper.put_primary(name)
  end
end

class Float
  def __dump(dumper)
    dumper.put_primary(to_f)
  end
end

class Bignum
  def __dump(dumper)
    dumper.put_primary(to_i)
  end
end

class String
  def __dump(dumper)
    dumper.put_primary(to_s)
  end
end

class Regexp
  def __dump(dumper)
    dumper.put_primary(source)
    dumper.put_primary(options)
  end
end

class Array
  def __dump(dumper)
    self.each do |v|
      dumper.put_primary(dumper.put(v))
    end
  end
end

class Hash
  def __dump(dumper)
    dumper.put_primary(dumper.put(self.default))
    self.each do |k, v|
      dumper.put_primary(dumper.put(k))
      dumper.put_primary(dumper.put(v))
    end
  end
end

class Struct
  def __dump(dumper)
    dumper.members.each do |m|
      dumper.put_primary(dumper.put(m))
      dumper.put_primary(dumper.put(self[m]))
    end
  end
end


class Foo
  def initialize(it)
    @foo = self
    @bar = it
  end
end

class BXmlDumper
  def initialize(output=[])
    @cur = 1
    @map = {}
    @child = []
    @output = output
  end
  attr_reader :output

  def feed(obj)
    return if @map[obj.id]
    @map[obj.id] = @cur
    @cur += 1
    @child.push(obj)
  end

  def finish
    @child.each do |r|
      begin_obj(r)
      primary_value(r)
      ivars(r)
      end_obj(r)
    end
  end

  def dump(stream)
    stream.each do |obj|
      feed(obj)
    end
    finish
  end

  def put(s)
    @output.push s
  end

  def begin_obj(r)
    put %Q!<obj xsi:type="myns:#{r.klass}" id="id#{@map[r.id]}">! 
  end

  def ivars(r)
    r.ivars.each do |k, v|
      name = k.sub(/^@/, '')
      put %Q!  <#{name} href="#id#{@map[v.id]}">!
    end
  end

  def primary_value(r)
    case r.klass.name
    when 'Fixnum', 'Bignum'
      put r.primary[0]
    when 'Symbol'
      put r.primary[0].dump
    when 'String'
      put r.primary[0].dump
    when 'Array'
      r.primary.each do |e|
	put %Q!  <item href="#id#{@map[e.id]}">!
      end
    when 'Hash'
      it = r.primary[0]
      put %Q!  <default href="#id#{@map[it.id]}">!
      ary = r.primary[1..-1]
      while (ary.size > 0) do
	put '  <pair>'
	put %Q!    <key href="#id#{@map[ary.shift.id]}">!
	put %Q!    <value href="#id#{@map[ary.shift.id]}">!
	put '  </pair>'
      end
    end
  end
  
  def end_obj(r)
    put '</obj>'
  end
end

def test_dump(obj)
  puts
  p obj
  puts
  p Marshal.dump(obj)
  puts

  t = BTraverser.new
  t.put(obj)

  xml = BXmlDumper.new
  xml.dump(t.stream)
  xml.output.each do |line|
    puts line
  end
end

hello = Foo.new("Hello")

complex = Foo.new([:string, 2, 3, hello, :string, {hello=>:string}])
test_dump(complex)
test_dump(hello)