bindata 1.8.0 → 1.8.1

data/ChangeLog.rdoc

@@ -1,5 +1,9 @@
 = BinData Changelog
 
+== Version 1.8.1 (2014-01-15)
+
+* Added signed bitfields.  Requested by redood.
+
 == Version 1.8.0 (2014-01-06)
 
 * Allow custom types to have endian, not just numerics.

data/lib/bindata/bits.rb

@@ -6,13 +6,13 @@ module BinData
 
   module BitField #:nodoc: all
     class << self
-      def define_class(nbits, endian)
-        name = "Bit#{nbits}"
+      def define_class(nbits, endian, signed = :unsigned)
+        name = ((signed == :signed ) ? "Sbit" : "Bit") + nbits.to_s
         name << "le" if endian == :little
         unless BinData.const_defined?(name)
           BinData.module_eval <<-END
             class #{name} < BinData::BasePrimitive
-              BitField.define_methods(self, #{nbits}, :#{endian})
+              BitField.define_methods(self, #{nbits}, :#{endian}, :#{signed})
             end
           END
         end
@@ -20,15 +20,17 @@ module BinData
         BinData.const_get(name)
       end
 
-      def define_methods(bit_class, nbits, endian)
+      def define_methods(bit_class, nbits, endian, signed)
         bit_class.module_eval <<-END
           def assign(val)
-            #{create_clamp_code(nbits)}
+            #{create_clamp_code(nbits, signed)}
             super(val)
           end
 
           def do_write(io)
-            io.writebits(_value, #{nbits}, :#{endian})
+            val = _value
+            #{create_int2uint_code(nbits) if signed == :signed}
+            io.writebits(val, #{nbits}, :#{endian})
           end
 
           def do_num_bytes
@@ -39,7 +41,9 @@ module BinData
           private
 
           def read_and_return_value(io)
-            io.readbits(#{nbits}, :#{endian})
+            val = io.readbits(#{nbits}, :#{endian})
+            #{create_uint2int_code(nbits) if signed == :signed}
+            val
           end
 
           def sensible_default
@@ -48,9 +52,19 @@ module BinData
         END
       end
 
-      def create_clamp_code(nbits)
-        min = 0
-        max = (1 << nbits) - 1
+      def create_clamp_code(nbits, signed)
+        if nbits == 1 and signed == :signed
+          raise "signed bitfield must have more than one bit" 
+        end
+
+        if signed == :signed
+          max = (1 << (nbits - 1)) - 1
+          min = -(max + 1)
+        else
+          min = 0
+          max = (1 << nbits) - 1
+        end
+
         clamp = "(val < #{min}) ? #{min} : (val > #{max}) ? #{max} : val"
 
         if nbits == 1
@@ -60,6 +74,14 @@ module BinData
 
         "val = #{clamp}"
       end
+
+      def create_int2uint_code(nbits)
+        "val = val & #{(1 << nbits) - 1}"
+      end
+
+      def create_uint2int_code(nbits)
+        "val = val - #{1 << nbits} if (val >= #{1 << (nbits - 1)})"
+      end
     end
   end
 
@@ -68,13 +90,15 @@ module BinData
     def const_missing(name)
       mappings = {
         /^Bit(\d+)$/ => :big,
-        /^Bit(\d+)le$/ => :little
+        /^Bit(\d+)le$/ => :little,
+        /^Sbit(\d+)$/ => [:big, :signed],
+        /^Sbit(\d+)le$/ => [:little, :signed]
       }
 
-      mappings.each_pair do |regex, endian|
+      mappings.each_pair do |regex, args|
         if regex =~ name.to_s
           nbits = $1.to_i
-          return BitField.define_class(nbits, endian)
+          return BitField.define_class(nbits, *args)
         end
       end
 

data/lib/bindata/registry.rb

@@ -73,7 +73,7 @@ module BinData
     end
 
     def register_dynamic_class(name)
-      if /^u?int\d+(le|be)$/ =~ name or /^bit\d+(le)?$/ =~ name
+      if /^u?int\d+(le|be)$/ =~ name or /^s?bit\d+(le)?$/ =~ name
         class_name = name.gsub(/(?:^|_)(.)/) { $1.upcase }
         begin
           BinData::const_get(class_name)

data/lib/bindata/version.rb

@@ -1,3 +1,3 @@
 module BinData
-  VERSION = "1.8.0"
+  VERSION = "1.8.1"
 end

data/test/bits_test.rb

@@ -69,11 +69,19 @@ module AllBitfields
   end
 
   def min_value
-    0
+    if @signed
+      -max_value - 1
+    else
+      0
+    end
   end
 
   def max_value
-    (1 << @nbits) - 1
+    if @signed
+      (1 << (@nbits - 1)) - 1
+    else
+      (1 << @nbits) - 1
+    end
   end
 
   def some_values_within_range
@@ -89,21 +97,31 @@ module AllBitfields
   end
 end
 
-def generate_bit_classes_to_test(endian)
+def generate_bit_classes_to_test(endian, signed)
   bits = {}
-  (1 .. 50).each do |nbits|
-    name = (endian == :big) ? "Bit#{nbits}" : "Bit#{nbits}le"
+  if signed
+    base  = "Sbit"
+    start = 2
+  else
+    base  = "Bit"
+    start = 1
+  end
+
+  (start .. 50).each do |nbits|
+    name = "#{base}#{nbits}"
+    name << "le" if endian == :little
     bit_class = BinData.const_get(name)
     bits[bit_class] = nbits
   end
   bits
 end
 
-describe "Big endian bitfields" do
+describe "Unsigned big endian bitfields" do
   include AllBitfields
 
   before do
-    @bits = generate_bit_classes_to_test(:big)
+    @signed = false
+    @bits = generate_bit_classes_to_test(:big, @signed)
   end
 
   it "read big endian values" do
@@ -116,11 +134,48 @@ describe "Big endian bitfields" do
   end
 end
 
-describe "Little endian bitfields" do
+describe "Signed big endian bitfields" do
+  include AllBitfields
+
+  before do
+    @signed = true
+    @bits = generate_bit_classes_to_test(:big, @signed)
+  end
+
+  it "read big endian values" do
+    @bits.each_pair do |bit_class, nbits|
+      nbytes = (nbits + 7) / 8
+      str = [0b0100_0000].pack("C") + "\000" * (nbytes - 1)
+
+      bit_class.read(str).must_equal 1 << (nbits - 2)
+    end
+  end
+end
+
+describe "Unsigned little endian bitfields" do
   include AllBitfields
 
   before do
-    @bits = generate_bit_classes_to_test(:little)
+    @signed = false
+    @bits = generate_bit_classes_to_test(:little, @signed)
+  end
+
+  it "read little endian values" do
+    @bits.each_pair do |bit_class, nbits|
+      nbytes = (nbits + 7) / 8
+      str = [0b0000_0001].pack("C") + "\000" * (nbytes - 1)
+
+      bit_class.read(str).must_equal 1
+    end
+  end
+end
+
+describe "Signed little endian bitfields" do
+  include AllBitfields
+
+  before do
+    @signed = true
+    @bits = generate_bit_classes_to_test(:little, @signed)
   end
 
   it "read little endian values" do
@@ -160,4 +215,3 @@ describe "Bits of size 1" do
     end
   end
 end
-

data/test/registry_test.rb

@@ -92,6 +92,7 @@ describe BinData::Registry, "with numerics" do
 
   it "lookup bits" do
     r.lookup("bit5").to_s.must_equal "BinData::Bit5"
+    r.lookup("sbit5").to_s.must_equal "BinData::Sbit5"
     r.lookup("bit6le").to_s.must_equal "BinData::Bit6le"
   end
 
@@ -101,6 +102,13 @@ describe BinData::Registry, "with numerics" do
     r.lookup("bit2", :little).to_s.must_equal "BinData::Bit2"
     r.lookup("bit3le", :little).to_s.must_equal "BinData::Bit3le"
   end
+
+  it "lookup signed bits by ignoring endian" do
+    r.lookup("sbit2", :big).to_s.must_equal "BinData::Sbit2"
+    r.lookup("sbit3le", :big).to_s.must_equal "BinData::Sbit3le"
+    r.lookup("sbit2", :little).to_s.must_equal "BinData::Sbit2"
+    r.lookup("sbit3le", :little).to_s.must_equal "BinData::Sbit3le"
+  end
 end
 
 describe BinData::Registry, "with endian specific types" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 1
   - 8
-  - 0
-  version: 1.8.0
+  - 1
+  version: 1.8.1
 platform: ruby
 authors: 
 - Dion Mendel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-06 00:00:00 +08:00
+date: 2014-01-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency