bit-struct 0.13.1 → 0.13.2

data/History.txt

@@ -1,3 +1,9 @@
+bit-struct 0.13
+
+- Packaged as a gem using bones.
+
+- Added nest fields defined with blocks.
+
 bit-struct 0.12
 
 - Added vectors.

data/TODO

@@ -1,15 +1,10 @@
-website:
-
-  scp doc/ vjoel@rubyforge.org:/var/www/gforge-projects/bit-struct/
-
-
 easy way to define wrappers
 
-
-to do:
-
 generate C code from bit-struct spec?
 
+write extension to extract and insert bit-fields, and use that instead
+  of pack/unpack
+
 variable-length embedded fields, with referenced length field
 
 terminated arrays?

data/TODO-ALSO

@@ -1,22 +1,5 @@
 rest :name, :terminator => ...
 
-> * Allow block also for "nest" ?
-> 
-> It may sound redundant in the first place, but when it's just for
-> providing more structure without requiring an extra class definition, it
-> could be useful:
-> 
->   class Foo < BitStruct
->     nest :coord do
->       signed :x, 8
->       signed :y, 8
->     end
->   end
-> 
->   Foo.new.coord.x
-
-Agree completely. 
-
 > * Is explicit :length for vector necessary?
 > 
 >   class Tag < BitStruct

data/examples/nested-block.rb

@@ -0,0 +1,23 @@
+require 'bit-struct'
+
+class Container < BitStruct
+  nest    :n,  "Nest" do
+    unsigned :x,    5
+    unsigned :y,    3
+    char     :s,  5*8
+  end
+end
+
+cont = Container.new
+
+n = cont.n
+
+n.x = 5
+n.y = 0
+n.s = " xyz "
+
+cont.n = n # note copy semantics here!
+
+p cont
+puts
+puts cont.inspect_detailed

data/lib/bit-struct/bit-struct.rb

@@ -9,7 +9,7 @@
 # The String#replace method is useful.
 #
 class BitStruct < String
-  VERSION = "0.13.1"
+  VERSION = "0.13.2"
 
   class Field
     # Offset of field in bits.

data/lib/bit-struct/fields.rb

@@ -54,15 +54,10 @@ class BitStruct
     # with the given _name_ and _nested_class_. Length is determined from
     # _nested_class_.
     #
-    # In _rest_:
-    #
     # If a class is provided, use it for the Field class (i.e. <=NestedField).
     # If a string is provided, use it for the display_name.
     # If a hash is provided, use it for options.
     #
-    # WARNING: the accessors have COPY semantics, not reference. When you call a
-    # reader method to get the nested structure, you get a *copy* of that data.
-    #
     # For example:
     #
     #   class Sub < BitStruct
@@ -77,6 +72,19 @@ class BitStruct
     #
     #   p a  # ==> #<A n=#<Sub x=0>>
     #
+    # If a block is given, use it to define the nested fields. For example, the
+    # following is equivalent to the above example:
+    #
+    #   class A < BitStruct
+    #     nest :n do
+    #       unsigned :x, 8
+    #     end
+    #   end
+    #
+    # WARNING: the accessors have COPY semantics, not reference. When you call a
+    # reader method to get the nested structure, you get a *copy* of that data.
+    # Expressed in terms of the examples above:
+    #
     #   # This fails to set x in a.
     #   a.n.x = 3
     #   p a  # ==> #<A n=#<Sub x=0>>
@@ -87,8 +95,21 @@ class BitStruct
     #   a.n = n
     #   p a  # ==> #<A n=#<Sub x=3>>
     # 
-    def nest(name, nested_class, *rest)
+    def nest(name, *rest, &block)
       opts = parse_options(rest, name, NestedField)
+      nested_class = opts[:nested_class]
+      
+      unless (block and not nested_class) or (nested_class and not block)
+        raise ArgumentError,
+          "nested field must have either a nested_class option or a block," +
+          " but not both"
+      end
+      
+      unless nested_class
+        nested_class = Class.new(BitStruct)
+        nested_class.class_eval(&block)
+      end
+      
       opts[:default] ||= nested_class.initial_value.dup
       opts[:nested_class] = nested_class
       field = add_field(name, nested_class.bit_length, opts)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bit-struct
 version: !ruby/object:Gem::Version 
-  version: 0.13.1
+  version: 0.13.2
 platform: ruby
 authors: 
 - Joel VanderWerf
@@ -53,6 +53,7 @@ files:
 - examples/md.rb
 - examples/modular-def.rb
 - examples/native.rb
+- examples/nested-block.rb
 - examples/nested.rb
 - examples/pad.rb
 - examples/ping-recv.rb