bindata 1.2.1 → 1.2.2

data/lib/bindata/choice.rb

@@ -145,6 +145,14 @@ module BinData
       current_choice.clear?
     end
 
+    def assign(val)
+      current_choice.assign(val)
+    end
+
+    def snapshot
+      current_choice.snapshot
+    end
+
     def respond_to?(symbol, include_private = false) #:nodoc:
       current_choice.respond_to?(symbol, include_private) || super
     end
@@ -153,39 +161,27 @@ module BinData
       current_choice.__send__(symbol, *args, &block)
     end
 
-    #---------------
-    private
-
-    def _do_read(io)
+    def do_read(io) #:nodoc:
       trace_selection
       current_choice.do_read(io)
     end
 
-    def trace_selection
-      BinData::trace_message do |tracer|
-        selection_string = eval_parameter(:selection).inspect
-        tracer.trace_obj("#{debug_name}-selection-", selection_string)
-      end
-    end
-
-    def _done_read
-      current_choice.done_read
-    end
-
-    def _do_write(io)
+    def do_write(io) #:nodoc:
       current_choice.do_write(io)
     end
 
-    def _do_num_bytes
+    def do_num_bytes #:nodoc:
       current_choice.do_num_bytes
     end
 
-    def _assign(val)
-      current_choice.assign(val)
-    end
+    #---------------
+    private
 
-    def _snapshot
-      current_choice.snapshot
+    def trace_selection
+      BinData::trace_message do |tracer|
+        selection_string = eval_parameter(:selection).inspect
+        tracer.trace_obj("#{debug_name}-selection-", selection_string)
+      end
     end
 
     def current_choice

data/lib/bindata/deprecated.rb

@@ -1,3 +1,20 @@
+# Implement Kernel#instance_exec for Ruby 1.8.6 and below
+unless Object.respond_to? :instance_exec
+  module Kernel
+    # Taken from http://eigenclass.org/hiki/instance_exec
+    def instance_exec(*args, &block)
+      mname = "__instance_exec_#{Thread.current.object_id.abs}_#{object_id.abs}"
+      Object.class_eval{ define_method(mname, &block) }
+      begin
+        ret = send(mname, *args)
+      ensure
+        Object.class_eval{ undef_method(mname) } rescue nil
+      end
+      ret
+    end
+  end
+end
+
 module BinData
   class Base
     class << self
@@ -12,6 +29,31 @@ module BinData
         register_class(class_to_register)
       end
     end
+
+    def _do_read(io)
+      warn "#{caller[0]} `_do_read(io)' is deprecated as of BinData 1.3.0.  Replace with `do_read(io)'"
+      do_read(io)
+    end
+
+    def _do_write(io)
+      warn "#{caller[0]} `_do_write(io)' is deprecated as of BinData 1.3.0.  Replace with `do_write(io)'"
+      do_write(io)
+    end
+
+    def _do_num_bytes
+      warn "#{caller[0]} `_do_num_bytes' is deprecated as of BinData 1.3.0.  Replace with `do_num_bytes'"
+      do_num_bytes
+    end
+
+    def _assign(val)
+      warn "#{caller[0]} `_assign(val)' is deprecated as of BinData 1.3.0.  Replace with `assign(val)'"
+      assign(val)
+    end
+
+    def _snapshot
+      warn "#{caller[0]} `_snapshot' is deprecated as of BinData 1.3.0.  Replace with `snapshot'"
+      snapshot
+    end
   end
 
   class SingleValue

data/lib/bindata/dsl.rb

@@ -23,6 +23,10 @@ module BinData
       def method_missing(symbol, *args, &block) #:nodoc:
         dsl_parser.__send__(symbol, *args, &block)
       end
+
+      # Assert object is not an array or string.
+      def to_ary; nil; end
+      def to_str; nil; end
     end
 
     # An array containing a field definition of the form
@@ -230,6 +234,10 @@ module BinData
           dsl_raise SyntaxError, "field must have a name"
         end
 
+        if malformed_name?(name)
+          dsl_raise NameError.new("", name), "field '#{name}' is an illegal fieldname"
+        end
+
         if duplicate_name?(name)
           dsl_raise SyntaxError, "duplicate field '#{name}'"
         end
@@ -266,6 +274,10 @@ module BinData
         end
       end
 
+      def malformed_name?(name)
+        name != "" and /^[a-z_]\w*$/ !~ name
+      end
+
       def duplicate_name?(name)
         name != "" and fields.field_names.include?(name)
       end

data/lib/bindata/float.rb

@@ -8,7 +8,7 @@ module BinData
     class << self
       def define_methods(float_class, precision, endian)
         float_class.module_eval <<-END
-          def _do_num_bytes
+          def do_num_bytes
             #{create_num_bytes_code(precision)}
           end
 

data/lib/bindata/int.rb

@@ -31,18 +31,18 @@ module BinData
         raise "nbits must be divisible by 8" unless (nbits % 8).zero?
 
         int_class.module_eval <<-END
-          #---------------
-          private
-
-          def _assign(val)
+          def assign(val)
             #{create_clamp_code(nbits, signed)}
             super(val)
           end
 
-          def _do_num_bytes
+          def do_num_bytes
             #{nbits / 8}
           end
 
+          #---------------
+          private
+
           def sensible_default
             0
           end

data/lib/bindata/lazy.rb

@@ -51,7 +51,7 @@ module BinData
       if val.is_a? Symbol
         __send__(val)
       elsif val.respond_to? :arity
-        instance_eval(&val)
+        instance_exec(&val)
       else
         val
       end
@@ -117,7 +117,7 @@ module BinData
       if val.is_a?(Symbol)
         parent.__send__(val, *args)
       elsif val.respond_to?(:arity)
-        parent.instance_eval(&val)
+        parent.instance_exec(&val)
       else
         val
       end

data/lib/bindata/primitive.rb

@@ -95,7 +95,7 @@ module BinData
     end
 
     def read_and_return_value(io)
-      @struct.read(io)
+      @struct.do_read(io)
       get
     end
 

data/lib/bindata/record.rb

@@ -55,6 +55,31 @@ module BinData
         params[:hide]   = hide   unless hide.empty?
 
         super(params, sanitizer)
+
+        define_field_accessors(params[:fields].fields)
+      end
+
+      # Defines accessor methods to avoid the overhead of going through
+      # Struct#method_missing.  This is purely a speed optimisation.
+      # Removing this method will not have any effect on correctness.
+      def define_field_accessors(fields) #:nodoc:
+        unless method_defined?(:bindata_defined_accessors_for_fields?)
+          fields.each_with_index do |field, i|
+            name = field.name
+            if name
+              define_method(name.to_sym) do
+                instantiate_obj_at(i) unless @field_objs[i]
+                @field_objs[i]
+              end
+              define_method((name + "=").to_sym) do |*vals|
+                instantiate_obj_at(i) unless @field_objs[i]
+                @field_objs[i].assign(*vals)
+              end
+            end
+          end
+
+          define_method(:bindata_defined_accessors_for_fields?) { true }
+        end
       end
     end
   end

data/lib/bindata/string.rb

@@ -77,15 +77,12 @@ module BinData
       end
     end
 
-    #---------------
-    private
-
-    def _assign(val)
+    def assign(val)
       val = val.dup.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9"
       super(val)
     end
 
-    def _snapshot
+    def snapshot
       # override to ensure length and optionally trim padding
       result = super
       if has_parameter?(:length)
@@ -97,6 +94,9 @@ module BinData
       result
     end
 
+    #---------------
+    private
+
     def truncate_or_pad_to_length(str)
       len = eval_parameter(:length) || str.length
       if str.length == len

data/lib/bindata/stringz.rb

@@ -31,20 +31,20 @@ module BinData
 
     optional_parameters :max_length
 
-    #---------------
-    private
-
-    def _assign(val)
+    def assign(val)
       val = val.dup.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9"
       super(val)
     end
 
-    def _snapshot
+    def snapshot
       # override to always remove trailing zero bytes
       result = super
       trim_and_zero_terminate(result).chomp("\0")
     end
 
+    #---------------
+    private
+
     def value_to_binary_string(val)
       trim_and_zero_terminate(val)
     end

data/lib/bindata/struct.rb

@@ -157,6 +157,20 @@ module BinData
       @field_objs.all? { |f| f.nil? or f.clear? }
     end
 
+    def assign(val)
+      clear
+      assign_fields(as_snapshot(val))
+    end
+
+    def snapshot
+      snapshot = Snapshot.new
+      field_names.each do |name|
+        obj = find_obj_for_name(name)
+        snapshot[name] = obj.snapshot if include_obj(obj)
+      end
+      snapshot
+    end
+
     # Returns a list of the names of all fields accessible through this
     # object.  +include_hidden+ specifies whether to include hidden names
     # in the listing.
@@ -193,6 +207,21 @@ module BinData
       child.do_num_bytes.is_a?(Integer) ? sum.ceil : sum.floor
     end
 
+    def do_read(io) #:nodoc:
+      instantiate_all_objs
+      @field_objs.each { |f| f.do_read(io) if include_obj(f) }
+    end
+
+    def do_write(io) #:nodoc
+      instantiate_all_objs
+      @field_objs.each { |f| f.do_write(io) if include_obj(f) }
+    end
+
+    def do_num_bytes #:nodoc:
+      instantiate_all_objs
+      sum_num_bytes_for_all_fields.ceil
+    end
+
     #---------------
     private
 
@@ -233,30 +262,6 @@ module BinData
       end
     end
 
-    def _do_read(io)
-      instantiate_all_objs
-      @field_objs.each { |f| f.do_read(io) if include_obj(f) }
-    end
-
-    def _done_read
-      @field_objs.each { |f| f.done_read if include_obj(f) }
-    end
-
-    def _do_write(io)
-      instantiate_all_objs
-      @field_objs.each { |f| f.do_write(io) if include_obj(f) }
-    end
-
-    def _do_num_bytes
-      instantiate_all_objs
-      sum_num_bytes_for_all_fields.ceil
-    end
-
-    def _assign(val)
-      clear
-      assign_fields(as_snapshot(val))
-    end
-
     def as_snapshot(val)
       if val.class == Hash
         snapshot = Snapshot.new
@@ -278,15 +283,6 @@ module BinData
       end
     end
 
-    def _snapshot
-      snapshot = Snapshot.new
-      field_names.each do |name|
-        obj = find_obj_for_name(name)
-        snapshot[name] = obj.snapshot if include_obj(obj)
-      end
-      snapshot
-    end
-
     def sum_num_bytes_for_all_fields
       sum_num_bytes_below_index(@field_objs.length)
     end

data/lib/bindata/wrapper.rb

@@ -48,50 +48,39 @@ module BinData
     end
 
     def clear #:nodoc:
-      wrapped.clear
+      @wrapped.clear
     end
 
     def clear? #:nodoc:
-      wrapped.clear?
+      @wrapped.clear?
     end
 
-    def respond_to?(symbol, include_private = false) #:nodoc:
-      wrapped.respond_to?(symbol, include_private) || super
+    def assign(val)
+      @wrapped.assign(val)
     end
 
-    def method_missing(symbol, *args, &block) #:nodoc:
-      wrapped.__send__(symbol, *args, &block)
-    end
-
-    #---------------
-    private
-
-    def wrapped
-      @wrapped
+    def snapshot
+      @wrapped.snapshot
     end
 
-    def _do_read(io)
-      wrapped.do_read(io)
-    end
-
-    def _done_read
-      wrapped.done_read
+    def respond_to?(symbol, include_private = false) #:nodoc:
+      @wrapped.respond_to?(symbol, include_private) || super
     end
 
-    def _do_write(io)
-      wrapped.do_write(io)
+    def method_missing(symbol, *args, &block) #:nodoc:
+      @wrapped.__send__(symbol, *args, &block)
     end
 
-    def _do_num_bytes
-      wrapped.do_num_bytes
+    def do_read(io) #:nodoc:
+      @wrapped.do_read(io)
     end
 
-    def _assign(val)
-      wrapped.assign(val)
+    def do_write(io) #:nodoc
+      @wrapped.do_write(io)
     end
 
-    def _snapshot
-      wrapped.snapshot
+    def do_num_bytes #:nodoc:
+      @wrapped.do_num_bytes
     end
   end
 end