bindata 1.2.1 → 1.2.2

data/ChangeLog

@@ -1,5 +1,13 @@
 = BinData Changelog
 
+== Version 1.2.2 (2010-12-14)
+
+* Added Base.bindata_name method.
+* Removed Base#done_read to reduce memory usage and cpu usage.
+* Derived classes should now use do_read et al, instead of _do_read.
+* Added predefinition of record fields to improve speed.
+* Made compatible with ruby 1.9.2.  Thanks to Andrew Watts.
+
 == Version 1.2.1 (2010-07-20)
 
 * Updated specs to be compatible with ruby 1.9.1

data/Rakefile

@@ -10,7 +10,8 @@ PKG_FILES = FileList[
   "{examples,spec,lib}/**/*.rb",
   "tasks/**/*.rake",
   "setup.rb",
-  "manual.haml"
+  "manual.haml",
+  "manual.md"
 ]
 
 task :default => :spec

data/lib/bindata.rb

@@ -30,5 +30,5 @@ require 'bindata/deprecated'
 #
 # Copyright (c) 2007 - 2010 Dion Mendel.
 module BinData
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/lib/bindata/array.rb

@@ -93,6 +93,16 @@ module BinData
       @element_list = nil
     end
 
+    def assign(array)
+      raise ArgumentError, "can't set a nil value for #{debug_name}" if array.nil?
+
+      @element_list = to_storage_formats(array.to_ary)
+    end
+
+    def snapshot
+      elements.collect { |el| el.snapshot }
+    end
+
     def find_index(obj)
       elements.index(obj)
     end
@@ -224,6 +234,22 @@ module BinData
       child.do_num_bytes.is_a?(Integer) ? sum.ceil : sum.floor
     end
 
+    def do_read(io) #:nodoc:
+      if has_parameter?(:initial_length)
+        elements.each { |el| el.do_read(io) }
+      elsif has_parameter?(:read_until)
+        read_until(io)
+      end
+    end
+
+    def do_write(io) #:nodoc:
+      elements.each { |el| el.do_write(io) }
+    end
+
+    def do_num_bytes #:nodoc:
+      sum_num_bytes_for_all_elements.ceil
+    end
+
     #---------------
     private
 
@@ -244,14 +270,6 @@ module BinData
       element
     end
 
-    def _do_read(io)
-      if has_parameter?(:initial_length)
-        elements.each { |el| el.do_read(io) }
-      elsif has_parameter?(:read_until)
-        read_until(io)
-      end
-    end
-
     def read_until(io)
       if get_parameter(:read_until) == :eof
         read_until_eof(io)
@@ -282,28 +300,6 @@ module BinData
       end
     end
 
-    def _done_read
-      elements.each { |el| el.done_read }
-    end
-
-    def _do_write(io)
-      elements.each { |el| el.do_write(io) }
-    end
-
-    def _do_num_bytes
-      sum_num_bytes_for_all_elements.ceil
-    end
-
-    def _assign(array)
-      raise ArgumentError, "can't set a nil value for #{debug_name}" if array.nil?
-
-      @element_list = to_storage_formats(array.to_ary)
-    end
-
-    def _snapshot
-      elements.collect { |el| el.snapshot }
-    end
-
     def elements
       if @element_list.nil?
         @element_list = []

data/lib/bindata/base.rb

@@ -43,6 +43,11 @@ module BinData
         data
       end
 
+      # The name of this class as used by Records, Arrays etc.
+      def bindata_name
+        RegisteredClasses.underscore_name(self.name)
+      end
+
       # Registers this class for use.
       def register_self
         register_class(self)
@@ -74,6 +79,8 @@ module BinData
     def initialize(parameters = {}, parent = nil)
       @params = Sanitizer.sanitize(parameters, self.class)
       @parent = parent
+
+      prepare_for_read_with_offset
     end
 
     attr_reader :parent
@@ -104,21 +111,24 @@ module BinData
     def read(io)
       io = BinData::IO.new(io) unless BinData::IO === io
 
+      @in_read = true
+      clear
       do_read(io)
-      done_read
+      @in_read = false
+
       self
     end
 
-    def do_read(io) #:nodoc:
-      check_or_adjust_offset(io)
-      clear
-      _do_read(io)
-    end
+    #:nodoc:
+    attr_reader :in_read
+    protected   :in_read
 
-    def done_read #:nodoc:
-      _done_read
+    # Returns if this object is currently being read.  This is used
+    # internally by BasePrimitive.
+    def reading? #:nodoc:
+      furthest_ancestor.in_read
     end
-    protected :do_read, :done_read
+    protected :reading?
 
     # Writes the value for this data object to +io+.
     def write(io)
@@ -129,32 +139,11 @@ module BinData
       self
     end
 
-    def do_write(io) #:nodoc:
-      _do_write(io)
-    end
-    protected :do_write
-
     # Returns the number of bytes it will take to write this data object.
     def num_bytes
       do_num_bytes.ceil
     end
 
-    def do_num_bytes #:nodoc:
-      _do_num_bytes
-    end
-    protected :do_num_bytes
-
-    # Assigns the value of +val+ to this data object.  Note that +val+ will
-    # always be deep copied to ensure no aliasing problems can occur.
-    def assign(val)
-      _assign(val)
-    end
-
-    # Returns a snapshot of this data object.
-    def snapshot
-      _snapshot
-    end
-
     # Returns the string representation of this data object.
     def to_binary_s
       io = BinData::IO.create_string_io
@@ -213,6 +202,31 @@ module BinData
     #---------------
     private
 
+    def furthest_ancestor
+      if parent.nil?
+        self
+      else
+        an = parent
+        an = an.parent while an.parent
+        an
+      end
+    end
+
+    def prepare_for_read_with_offset
+      if has_parameter?(:check_offset) or has_parameter?(:adjust_offset)
+        class << self
+          alias_method :do_read_without_offset, :do_read
+          alias_method :do_read, :do_read_with_offset
+          public :do_read # Ruby 1.9.2 bug.  Should be protected
+        end
+      end
+    end
+
+    def do_read_with_offset(io) #:nodoc:
+      check_or_adjust_offset(io)
+      do_read_without_offset(io)
+    end
+
     def check_or_adjust_offset(io)
       if has_parameter?(:check_offset)
         check_offset(io)
@@ -268,6 +282,17 @@ module BinData
       raise NotImplementedError
     end
 
+    # Assigns the value of +val+ to this data object.  Note that +val+ will
+    # always be deep copied to ensure no aliasing problems can occur.
+    def assign(val)
+      raise NotImplementedError
+    end
+
+    # Returns a snapshot of this data object.
+    def snapshot
+      raise NotImplementedError
+    end
+
     # Returns the debug name of +child+.  This only needs to be implemented
     # by objects that contain child objects.
     def debug_name_of(child) #:nodoc:
@@ -281,39 +306,23 @@ module BinData
     end
 
     # Reads the data for this data object from +io+.
-    def _do_read(io)
-      raise NotImplementedError
-    end
-
-    # Trigger function that is called after #do_read.
-    def _done_read
+    def do_read(io) #:nodoc:
       raise NotImplementedError
     end
 
     # Writes the value for this data to +io+.
-    def _do_write(io)
+    def do_write(io) #:nodoc:
       raise NotImplementedError
     end
 
     # Returns the number of bytes it will take to write this data.
-    def _do_num_bytes
-      raise NotImplementedError
-    end
-
-    # Assigns the value of +val+ to this data object.  Note that +val+ will
-    # always be deep copied to ensure no aliasing problems can occur.
-    def _assign(val)
-      raise NotImplementedError
-    end
-
-    # Returns a snapshot of this data object.
-    def _snapshot
+    def do_num_bytes #:nodoc:
       raise NotImplementedError
     end
 
     # Set visibility requirements of methods to implement
-    public :clear, :clear?, :debug_name_of, :offset_of
-    private :_do_read, :_done_read, :_do_write, :_do_num_bytes, :_assign, :_snapshot
+    public :clear, :clear?, :assign, :snapshot, :debug_name_of, :offset_of
+    protected :do_read, :do_write, :do_num_bytes
 
     # End To be implemented by subclasses
     ###########################################################################

data/lib/bindata/base_primitive.rb

@@ -36,8 +36,7 @@ module BinData
   #                           either #read or explicitly set with #value=.
   # [<tt>:value</tt>]         The object will always have this value.
   #                           Calls to #value= are ignored when
-  #                           using this param.  In the interval between
-  #                           calls to #do_read and #done_read, #value
+  #                           using this param.  While reading, #value
   #                           will return the value of the data read from the
   #                           IO, not the result of the <tt>:value</tt> param.
   # [<tt>:check_value</tt>]   Raise an error unless the value read in meets
@@ -54,19 +53,35 @@ module BinData
     def initialize(parameters = {}, parent = nil)
       super
 
-      @value   = nil
-      @in_read = false
+      @value = nil
     end
 
     def clear #:nodoc:
       @value = nil
-      @in_read = false
     end
 
     def clear? #:nodoc:
       @value.nil?
     end
 
+    def assign(val)
+      raise ArgumentError, "can't set a nil value for #{debug_name}" if val.nil?
+
+      unless has_parameter?(:value)
+        raw_val = val.respond_to?(:snapshot) ? val.snapshot : val
+        @value = begin
+                   raw_val.dup
+                 rescue TypeError
+                   # can't dup Fixnums
+                   raw_val
+                 end
+      end
+    end
+
+    def snapshot
+      _value
+    end
+
     def value
       # TODO: warn "#value is deprecated, use #snapshot instead"
       snapshot
@@ -98,11 +113,7 @@ module BinData
       snapshot.hash
     end
 
-    #---------------
-    private
-
-    def _do_read(io)
-      @in_read = true
+    def do_read(io) #:nodoc:
       @value   = read_and_return_value(io)
 
       trace_value
@@ -112,6 +123,17 @@ module BinData
       end
     end
 
+    def do_write(io) #:nodoc:
+      io.writebytes(value_to_binary_string(_value))
+    end
+
+    def do_num_bytes #:nodoc:
+      value_to_binary_string(_value).length
+    end
+
+    #---------------
+    private
+
     def trace_value
       BinData::trace_message do |tracer|
         value_string = _value.inspect
@@ -131,50 +153,19 @@ module BinData
       end
     end
 
-    def _done_read
-      @in_read = false
-    end
-
-    def _do_write(io)
-      raise "can't write whilst reading #{debug_name}" if @in_read
-      io.writebytes(value_to_binary_string(_value))
-    end
-
-    def _do_num_bytes
-      value_to_binary_string(_value).length
-    end
-
-    def _assign(val)
-      raise ArgumentError, "can't set a nil value for #{debug_name}" if val.nil?
-
-      unless has_parameter?(:value)
-        raw_val = val.respond_to?(:snapshot) ? val.snapshot : val
-        @value = begin
-                   raw_val.dup
-                 rescue TypeError
-                   # can't dup Fixnums
-                   raw_val
-                 end
-      end
-    end
-
-    def _snapshot
-      _value
-    end
-
     # The unmodified value of this data object.  Note that #value calls this
     # method.  This indirection is so that #value can be overridden in
     # subclasses to modify the value.
     def _value
       # Table of possible preconditions and expected outcome
-      #   1. :value and !in_read          ->   :value
-      #   2. :value and in_read           ->   @value
+      #   1. :value and !reading?         ->   :value
+      #   2. :value and reading?          ->   @value
       #   3. :initial_value and clear?    ->   :initial_value
       #   4. :initial_value and !clear?   ->   @value
       #   5. clear?                       ->   sensible_default
       #   6. !clear?                      ->   @value
 
-      if not @in_read and has_parameter?(:value)
+      if has_parameter?(:value) and not reading?
         # rule 1 above
         eval_parameter(:value)
       else

data/lib/bindata/bits.rb

@@ -23,23 +23,22 @@ module BinData
 
       def define_methods(bit_class, nbits, endian)
         bit_class.module_eval <<-END
-          #---------------
-          private
-
-          def _assign(val)
+          def assign(val)
             #{create_clamp_code(nbits)}
             super(val)
           end
 
-          def _do_write(io)
-            raise "can't write whilst reading \#{debug_name}" if @in_read
+          def do_write(io)
             io.writebits(_value, #{nbits}, :#{endian})
           end
 
-          def _do_num_bytes
+          def do_num_bytes
             #{nbits / 8.0}
           end
 
+          #---------------
+          private
+
           def read_and_return_value(io)
             io.readbits(#{nbits}, :#{endian})
           end