bitstream 0.1.0 → 0.1.1

data/README.en

@@ -72,4 +72,4 @@ In preparation.
 == License
 
 This library is distributed under the dual license of the Ruby license (in the narrow sense) and the 2-clause BSD license. Please see http://www.ruby-lang.org and BSDL.
-Copyright (c) 2011, Natsuki Kawai.
+Copyright (c) 2011, 2012 Natsuki Kawai.

data/lib/bitstream.rb

@@ -11,6 +11,7 @@ require 'types/cstring'
 require 'types/character'
 
 require 'bitstream/utils'
+require 'bitstream/field-info'
 
 module BitStream
 
@@ -104,7 +105,7 @@ module BitStream
 
     def read(s, offset)
       instance = @type.create_with_offset(s, offset, @props)
-      [instance, instance.length]
+      return FieldInfo.new(instance, instance.length)
     end
 
     #def write(s, offset, data)
@@ -166,8 +167,6 @@ module BitStream
     def initialize(type, instance)
       @type = type
       @instance = instance
-      @length = @type.length if @type.respond_to? :length
-      @has_read = false
     end
 
     def props
@@ -175,34 +174,32 @@ module BitStream
     end
     private :props
     
-    def has_read?
-      @has_read
-    end
-
     def read
-      unless @has_read
+      if @info.nil?
         if @offset.nil?
           index
         end
-        @value, @length = @type.read(props.raw_data, @offset)
-        @has_read = true
+        @info = @type.read(props.raw_data, @offset)
       end
-      return @value
+      return @info[:value]
     end
     
     alias :value :read
 
     def length
+      length = @type.length
       # @length must not be nil if @has_read.
-      if @length.nil?
-        if @offset.nil?
-          index
-        else
-          @value, @length = @type.read(props.raw_data, @offset)
-          @has_read = true
+      if length.nil?
+        if @info.nil?
+          if @offset.nil?
+            index
+          end
+          @info = @type.read(props.raw_data, @offset)
         end
+        return @info[:length]
+      else
+        return length
       end
-      return @length
     end
 
     def index
@@ -233,27 +230,6 @@ module BitStream
       @bitstream_mutex = Mutex.new
     end
 
-    # Currently BitStream does not support inheritance.
-    if false
-      def on_inherit(types, chain, fields, mutex)
-        @field_defs = []
-        @fields = fields
-        @types = types
-        @index = 0
-        @class_props = {}
-        @class_props_chain = [@class_props]
-        @class_props_chain.concat(chain)
-        @bitstream_mutex = mutex
-      end
-      
-      def inherited(subclass)
-        subclass.on_inherit(@types, @class_props_chain, @fields, @bitstream_mutex)
-        def subclass.fields
-          raise NameError, "Cannot define fields on a subclass of a class includes BitStream."
-        end
-      end
-    end
-
     def fields(&field_def)
       @field_defs << field_def
     end
@@ -324,9 +300,9 @@ module BitStream
       @singleton_props[:substream_types] = types
     end
 
-    def self.add_type(type, name = nil, bs = self)
+    def self.add_type(type, method_name = nil, bs = self)
       bs.instance_eval do
-        define_method(name) do |*args|
+        define_method(method_name) do |*args|
           name = args.shift.intern
           #if respond_to? name
           #  raise "#{name} has already defined."
@@ -339,11 +315,7 @@ module BitStream
           
           case props.mode
           when :field_def
-            if type.respond_to? :read
-              type_instance = type
-            else
-              type_instance = type.instance(user_props, *args)
-            end
+            type_instance = get_type(method_name, user_props, *args)
             field = FieldReader.new(type_instance, @instance)
             queue.enq(field)
 
@@ -368,24 +340,11 @@ module BitStream
 
     def array(name, size, type_name, *type_args)
       name = name.intern
-      type_name = type_name.intern
-      type = @types[type_name]
       props = @instance.bitstream_properties
       queue = props.eval_queue
       user_props = props.user_props
 
-      if type.nil?
-        raise BitStreamError, "There is no type named \"#{type_name}\""
-      end
-
-      if type.respond_to? :read
-        unless type_args.empty?
-          raise BitStreamError, "#{type} does not accept any arguments."
-        end
-        type_instance = type
-      else
-        type_instance = type.instance(user_props, *type_args)
-      end
+      type_instance = get_type(type_name, user_props, *type_args)
 
       case props.mode
       when :field_def
@@ -425,25 +384,12 @@ module BitStream
 
     def dyn_array(name, type_name, *type_args)
       name = name.intern
-      type_name = type_name.intern
-      type = @types[type_name]
       props = @instance.bitstream_properties
       fields = props.fields
       queue = props.eval_queue
       user_props = props.user_props
 
-      if type.nil?
-        raise BitStreamError, "There is no type named \"#{type_name}\""
-      end
-
-      if type.respond_to? :read
-        unless type_args.empty?
-          raise BitStreamError, "#{type} does not accept any arguments."
-        end
-        type_instance = type
-      else
-        type_instance = type.instance(user_props, *type_args)
-      end
+      type_instance = get_type(type_name, user_props, *type_args)
 
       case props.mode
       when :field_def
@@ -527,16 +473,13 @@ module BitStream
     end
 
     def method_missing(name, *args)
-      name_s = name.to_s
       field_name = args.shift
-      if name_s =~ /^uint(\d+)$/
-        bit_width = Regexp.last_match[1].to_i
-        unsigned field_name, bit_width, *args
-      elsif name_s =~ /^int(\d+)$/
-        bit_width = Regexp.last_match[1].to_i
-        signed field_name, bit_width, *args
+      aliasee = resolve_alias(name, args)
+      args.unshift(field_name)
+      if aliasee.nil?
+        super name, *args
       else
-        super name, args
+        return send(aliasee, *args)
       end
     end
 
@@ -544,6 +487,37 @@ module BitStream
       NestWrapper.new(self, inherited_props, user_props)
     end
     
+    private
+    def resolve_alias(type_name, args)
+      type_s = type_name.to_s
+      if type_s =~ /^uint(\d+)$/
+        bit_width = Regexp.last_match[1].to_i
+        args.unshift(bit_width)
+        return :unsigned
+      elsif type_s =~ /^int(\d+)$/
+        bit_width = Regexp.last_match[1].to_i
+        args.unshift(bit_width)
+        return :signed
+      else
+        return nil
+      end
+    end
+    
+    def get_type(type_name, props, *args)
+      type = @types[type_name.intern]
+      
+      if type.nil?
+        aliasee = resolve_alias(type_name, args)
+        if aliasee.nil?
+          raise BitStreamError, "There is no type named \"#{type_name}\""
+        else
+          type = @types[aliasee]
+        end
+      end
+      
+      return type.instance(props, *args)
+    end
+    
   end
 
   def self.included(obj)
@@ -579,6 +553,10 @@ module BitStream
   def substreams
     @bitstream_properties.substreams.values
   end
+  
+  #def field_info(name)
+  #  @bitstream_properties.field_info[]
+  #end
 
   #def properties=(props)
     # Method to override.

data/lib/types/character.rb

@@ -1,11 +1,14 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
+require 'bitstream/field-info'
 
 module BitStream
 
   class Char
+    
+    LENGTH = 8
 
     @instance = new
 
@@ -14,7 +17,7 @@ module BitStream
     end
 
     def length
-      8
+      LENGTH
     end
 
     def read(s, offset)
@@ -23,7 +26,7 @@ module BitStream
 
       value = s[byteoffset]
 
-      return [value, 8]
+      return FieldInfo.new(value, LENGTH)
     end
 
     def write(s, offset, value)

data/lib/types/cstring.rb

@@ -1,7 +1,8 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
+require 'bitstream/field-info'
 
 module BitStream
 
@@ -29,7 +30,7 @@ module BitStream
 
       bytelen = val.size
       val.slice!(val.size - 1)
-      return [val, 8 * bytelen]
+      return FieldInfo.new(val, 8 * bytelen)
     end
 
     def write(s, offset, data)

data/lib/types/integer.rb

@@ -1,7 +1,8 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
+require 'bitstream/field-info'
 
 module BitStream
 
@@ -59,7 +60,7 @@ module BitStream
       value &= ~(-1 << (bytelength * 8 - bitoffset))
       value >>= (8 - (@bit_width + bitoffset) % 8) % 8
 
-      return [value, @bit_width]
+      return FieldInfo.new(value, @bit_width)
     end
 
     def write(s, offset, value)
@@ -112,12 +113,14 @@ module BitStream
     end
 
     def read(s, offset)
-      val, len = @unsigned.read(s, offset)
+      info = @unsigned.read(s, offset)
+      val = info[:value]
+      len = info[:length]
       mask = -1 << (len - 1)
       if (val & mask) != 0
         val |= mask
       end
-      return [val, len]
+      return FieldInfo.new(val, len)
     end
 
     def write(s, offset, value)

data/lib/types/string.rb

@@ -1,8 +1,9 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
 
+require 'bitstream/field-info'
 require 'types/string-utils'
 
 module BitStream
@@ -29,7 +30,7 @@ module BitStream
       Utils.bit_lshift(val, bitoffset)
       val.slice!(val.size - 1) if bitoffset != 0
 
-      [val, @byte_len * 8]
+      return FieldInfo.new(val, @byte_len * 8)
     end
 
     def write(s, offset, data)

data/test/test-array.rb

@@ -21,7 +21,7 @@ class InfiniteArraySample
   include BitStream
 
   fields do
-    array :a1, nil, :unsigned_int, 16
+    array :a1, nil, :uint16
   end
 
 end

data/test/types/test-character.rb

@@ -1,5 +1,5 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
 
@@ -10,9 +10,9 @@ class TestUint < Test::Unit::TestCase
 
   def test_char_nooffset_read
     type = BitStream::Char.instance({})
-    val, len = type.read("abcd", 8)
-    assert_equal("b", val)
-    assert_equal(8, len)
+    info = type.read("abcd", 8)
+    assert_equal("b", info[:value])
+    assert_equal(8, info[:length])
   end
   
 end

data/test/types/test-cstring.rb

@@ -1,5 +1,5 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
 
@@ -10,9 +10,9 @@ class TestCstring < Test::Unit::TestCase
 
   def test_aligned_read
     type = BitStream::Cstring.instance({})
-    val, len = type.read("foobar\0baz", 16)
-    assert_equal("obar", val)
-    assert_equal(8 * "obar\0".size, len)
+    info = type.read("foobar\0baz", 16)
+    assert_equal("obar", info[:value])
+    assert_equal(8 * "obar\0".size, info[:length])
   end
 
 end

data/test/types/test-integer.rb

@@ -1,5 +1,5 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
 
@@ -13,30 +13,30 @@ class TestUint < Test::Unit::TestCase
 
   def test_uint32be_nooffset_read
     type = BitStream::Unsigned.instance(BE_PROP,32)
-    val, len = type.read("\x01\x02\x03\x04", 0)
-    assert_equal(0x01020304, val)
-    assert_equal(32, len)
+    info = type.read("\x01\x02\x03\x04", 0)
+    assert_equal(0x01020304, info[:value])
+    assert_equal(32, info[:length])
   end
 
   def test_uint32le_nooffset_read
     type = BitStream::Unsigned.instance(LE_PROP,32)
-    val, len = type.read("\x01\x02\x03\x04", 0)
-    assert_equal(0x04030201, val)
-    assert_equal(32, len)
+    info = type.read("\x01\x02\x03\x04", 0)
+    assert_equal(0x04030201, info[:value])
+    assert_equal(32, info[:length])
   end
 
   def test_sint32be_nooffset_read
     type = BitStream::Signed.instance(BE_PROP,32)
-    val, len = type.read("\xfe\xfd\xfc\xfb", 0)
-    assert_equal(-0x01020304 - 1, val)
-    assert_equal(32, len)
+    info = type.read("\xfe\xfd\xfc\xfb", 0)
+    assert_equal(-0x01020304 - 1, info[:value])
+    assert_equal(32, info[:length])
   end
 
   def test_sint32le_nooffset_read
     type = BitStream::Signed.instance(LE_PROP,32)
-    val, len = type.read("\xfe\xfd\xfc\xfb", 0)
-    assert_equal(-0x04030201 - 1, val)
-    assert_equal(32, len)
+    info = type.read("\xfe\xfd\xfc\xfb", 0)
+    assert_equal(-0x04030201 - 1, info[:value])
+    assert_equal(32, info[:length])
   end
 
   def test_uint32_nooffset_write
@@ -48,51 +48,51 @@ class TestUint < Test::Unit::TestCase
 
   def test_uint32be_offset4_read
     type = BitStream::Unsigned.instance(BE_PROP, 32)
-    val, len = type.read("\xf1\x02\x03\x04\x05", 4)
-    assert_equal(0x10203040.to_s(16), val.to_s(16))
-    assert_equal(32, len)
+    info = type.read("\xf1\x02\x03\x04\x05", 4)
+    assert_equal(0x10203040.to_s(16), info[:value].to_s(16))
+    assert_equal(32, info[:length])
   end
 
   def test_uint32be_offset1_read
     type = BitStream::Unsigned.instance(BE_PROP, 32)
-    val, len = type.read("\x12\x23\x34\x45\x56", 1)
-    assert_equal(0x2446688a.to_s(16), val.to_s(16))
-    assert_equal(32, len)
+    info = type.read("\x12\x23\x34\x45\x56", 1)
+    assert_equal(0x2446688a.to_s(16), info[:value].to_s(16))
+    assert_equal(32, info[:length])
   end
 
   def test_uint32le_offset4_read
     type = BitStream::Unsigned.instance(LE_PROP, 32)
-    val, len = type.read("\xf1\x02\x03\x04\x05", 4)
-    assert_equal(0x5040302f.to_s(16), val.to_s(16))
-    assert_equal(32, len)
+    info = type.read("\xf1\x02\x03\x04\x05", 4)
+    assert_equal(0x5040302f.to_s(16), info[:value].to_s(16))
+    assert_equal(32, info[:length])
   end
 
   def test_uint32le_offset1_read
     type = BitStream::Unsigned.instance(LE_PROP, 32)
-    val, len = type.read("\x80\x23\x34\x45\x56", 1)
-    assert_equal(0xac8a6847.to_s(16), val.to_s(16))
-    assert_equal(32, len)
+    info = type.read("\x80\x23\x34\x45\x56", 1)
+    assert_equal(0xac8a6847.to_s(16), info[:value].to_s(16))
+    assert_equal(32, info[:length])
   end
 
   def test_uint1be_read
     type = BitStream::Unsigned.instance(BE_PROP, 1)
-    val, len = type.read("\x40", 1)
-    assert_equal(1, val)
-    assert_equal(1, len)
+    info = type.read("\x40", 1)
+    assert_equal(1, info[:value])
+    assert_equal(1, info[:length])
 
-    val, len = type.read("\xfd", 6)
-    assert_equal(0, val)
-    assert_equal(1, len)
+    info = type.read("\xfd", 6)
+    assert_equal(0, info[:value])
+    assert_equal(1, info[:length])
   end
 
   def test_uint1le_read
     type = BitStream::Unsigned.instance(LE_PROP, 1)
-    val, len = type.read("\x40", 1)
-    assert_equal(1, val)
-    assert_equal(1, len)
+    info = type.read("\x40", 1)
+    assert_equal(1, info[:value])
+    assert_equal(1, info[:length])
 
-    val, len = type.read("\xfd", 6)
-    assert_equal(0, val)
-    assert_equal(1, len)
+    info = type.read("\xfd", 6)
+    assert_equal(0, info[:value])
+    assert_equal(1, info[:length])
   end
 end

data/test/types/test-string.rb

@@ -1,5 +1,5 @@
 # Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
+# Copyright:: Copyright 2011, 2012 Natsuki Kawai
 # License:: 2-clause BSDL or Ruby's
 
 
@@ -10,9 +10,9 @@ class TestString < Test::Unit::TestCase
 
   def test_aligned_read
     type = BitStream::String.instance({}, 3)
-    val, len = type.read("foobarbaz", 16)
-    assert_equal("oba", val)
-    assert_equal(3 * 8, len)
+    info = type.read("foobarbaz", 16)
+    assert_equal("oba", info[:value])
+    assert_equal(3 * 8, info[:length])
   end
 
   def test_aligned_write
@@ -24,9 +24,9 @@ class TestString < Test::Unit::TestCase
 
   def test_unaligned_read
     type = BitStream::String.instance({}, 2)
-    val, len = type.read([0x12345678].pack('N'), 1)
-    assert_equal("\x24\x68", val)
-    assert_equal(2 * 8, len)
+    info = type.read([0x12345678].pack('N'), 1)
+    assert_equal("\x24\x68", info[:value])
+    assert_equal(2 * 8, info[:length])
   end
 
   def test_unaligned_write

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Natsuki Kawai
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-12 00:00:00 +09:00
+date: 2012-02-14 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency