bindata 1.4.3 → 1.4.4

data/BSDL

@@ -1,4 +1,4 @@
-Copyright (C) 2007-2011 Dion Mendel. All rights reserved.
+Copyright (C) 2007-2012 Dion Mendel. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

data/ChangeLog

@@ -1,5 +1,13 @@
 = BinData Changelog
 
+== Version 1.4.4 (2012-06-21)
+
+* Fixed bug where user defined boolean primitive wouldn't set its
+  value to false (reported by Frank Roland).
+* Fixed infinite looping bug caused by nested Choices.
+* Renamed String parameter :pad_char to :pad_byte.
+* Updated manual.
+
 == Version 1.4.3 (2011-10-01)
 
 * Exceptions no longer ignored inside lambdas when reading until eof 

data/NEWS

@@ -1,3 +1,10 @@
+= 1.4.4
+
+== Deprecations
+
+The BinData::String parameter :pad_char has been renamed to :pad_byte.  This
+aids readibilty as Ruby 1.9 characters are not necessarily one byte.
+
 = 1.4.0
 
 == Deprecations

data/lib/bindata.rb

@@ -1,5 +1,5 @@
 # BinData -- Binary data manipulator.
-# Copyright (c) 2007 - 2011 Dion Mendel.
+# Copyright (c) 2007 - 2012 Dion Mendel.
 
 require 'bindata/array'
 require 'bindata/bits'
@@ -30,7 +30,7 @@ require 'bindata/deprecated'
 #
 # BinData is released under the same license as Ruby.
 #
-# Copyright (c) 2007 - 2011 Dion Mendel.
+# Copyright (c) 2007 - 2012 Dion Mendel.
 module BinData
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

data/lib/bindata/base.rb

@@ -251,6 +251,13 @@ module BinData
       other == snapshot
     end
 
+    # A version of +respond_to?+ used by the lazy evaluator.  It doesn't
+    # reinvoke the evaluator so as to avoid infinite evaluation loops.
+    def safe_respond_to?(symbol, include_private = false) #:nodoc:
+      respond_to?(symbol, include_private)
+    end
+    alias_method :orig_respond_to?, :respond_to? #:nodoc:
+
     #---------------
     private
 

data/lib/bindata/base_primitive.rb

@@ -179,7 +179,7 @@ module BinData
     #   6. !clear?                      ->   @value
 
     def _value
-      @value || sensible_default()
+      @value != nil ? @value : sensible_default()
     end
 
     def _value_with_value #:nodoc:
@@ -191,7 +191,7 @@ module BinData
     end
 
     def _value_with_initial_value #:nodoc:
-      @value || eval_parameter(:initial_value)
+      @value != nil ? @value : eval_parameter(:initial_value)
     end
 
     ###########################################################################

data/lib/bindata/choice.rb

@@ -144,6 +144,10 @@ module BinData
       current_choice.respond_to?(symbol, include_private) || super
     end
 
+    def safe_respond_to?(symbol, include_private = false) #:nodoc:
+      orig_respond_to?(symbol, include_private)
+    end
+
     def method_missing(symbol, *args, &block) #:nodoc:
       current_choice.__send__(symbol, *args, &block)
     end

data/lib/bindata/io.rb

@@ -85,7 +85,7 @@ module BinData
     def seekbytes(n)
       reset_read_bits
       @raw_io.seek(n, ::IO::SEEK_CUR)
-    rescue Errno::ESPIPE, Errno::EPIPE
+    rescue NoMethodError, Errno::ESPIPE, Errno::EPIPE
       skipbytes(n)
     end
 

data/lib/bindata/lazy.rb

@@ -63,7 +63,7 @@ module BinData
     end
 
     def method_missing(symbol, *args)
-      return @overrides[symbol] if @overrides and @overrides.has_key?(symbol)
+      return @overrides[symbol] if defined? @overrides and @overrides.has_key?(symbol)
 
       if @obj.parent
         eval_symbol_in_parent_context(symbol, args)
@@ -85,7 +85,7 @@ module BinData
 
       if obj_parent.has_parameter?(symbol)
         result = obj_parent.get_parameter(symbol)
-      elsif obj_parent.respond_to?(symbol)
+      elsif obj_parent.safe_respond_to?(symbol)
         result = obj_parent.__send__(symbol, *args)
       else
         result = symbol

data/lib/bindata/sanitize.rb

@@ -188,6 +188,15 @@ module BinData
       end
     end
 
+    def warn_renamed_parameter(old_key, new_key)
+      val = delete(old_key)
+      if val
+        self[new_key] = val
+        warn ":#{old_key} has been renamed to :#{new_key} in #{@the_class}.  " +
+        "Using :#{old_key} is now deprecated and will be removed in the future"
+      end
+    end
+
     def endian
       @endian || self[:endian]
     end

data/lib/bindata/string.rb

@@ -25,7 +25,7 @@ module BinData
   #   obj #=> "abcd"
   #   obj.to_binary_s #=> "abcd\000\000"
   #
-  #   obj = BinData::String.new(:length => 6, :pad_char => 'A')
+  #   obj = BinData::String.new(:length => 6, :pad_byte => 'A')
   #   obj.assign("abcd")
   #   obj #=> "abcdAA"
   #   obj.to_binary_s #=> "abcdAA"
@@ -35,20 +35,20 @@ module BinData
   # String objects accept all the params that BinData::BasePrimitive
   # does, as well as the following:
   #
-  # <tt>:read_length</tt>::    The length to use when reading a value.
+  # <tt>:read_length</tt>::    The length in bytes to use when reading a value.
   # <tt>:length</tt>::         The fixed length of the string.  If a shorter
   #                            string is set, it will be padded to this length.
-  # <tt>:pad_char</tt>::       The character to use when padding a string to a
+  # <tt>:pad_byte</tt>::       The byte to use when padding a string to a
   #                            set length.  Valid values are Integers and
   #                            Strings of length 1.  "\0" is the default.
   # <tt>:trim_padding</tt>::   Boolean, default false.  If set, #value will
-  #                            return the value with all pad_chars trimmed
+  #                            return the value with all pad_bytes trimmed
   #                            from the end of the string.  The value will
   #                            not be trimmed when writing.
   class String < BinData::BasePrimitive
 
     optional_parameters :read_length, :length, :trim_padding
-    default_parameters  :pad_char => "\0"
+    default_parameters  :pad_byte => "\0"
     mutually_exclusive_parameters :read_length, :length
     mutually_exclusive_parameters :length, :value
 
@@ -57,27 +57,36 @@ module BinData
       def sanitize_parameters!(params) #:nodoc:
         params.warn_replacement_parameter(:initial_length, :read_length)
 
-        if params.has_parameter?(:pad_char)
-          ch = params[:pad_char]
-          params[:pad_char] = sanitized_pad_char(ch)
+        params.warn_renamed_parameter(:pad_char, :pad_byte) # Remove this line in the future
+
+        if params.has_parameter?(:pad_byte)
+          byte = params[:pad_byte]
+          params[:pad_byte] = sanitized_pad_byte(byte)
         end
       end
 
       #-------------
       private
 
-      def sanitized_pad_char(ch)
-        result = ch.is_a?(Integer) ? ch.chr : ch.to_s
+      def sanitized_pad_byte(byte)
+        result = byte.is_a?(Integer) ? byte.chr : byte_string(byte.to_s.dup)
         if result.length > 1
-          raise ArgumentError, ":pad_char must not contain more than 1 char"
+          raise ArgumentError, ":pad_byte must not contain more than 1 byte"
         end
         result
       end
+
+      def byte_string(str)
+        if RUBY_VERSION >= "1.9"
+          str.force_encoding(Encoding::BINARY) 
+        else
+          str
+        end
+      end
     end
 
     def assign(val)
-      val = val.dup.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9"
-      super(val)
+      super(byte_string(val.dup))
     end
 
     def snapshot
@@ -94,8 +103,16 @@ module BinData
     #---------------
     private
 
+    def byte_string(str)
+      if RUBY_VERSION >= "1.9"
+        str.force_encoding(Encoding::BINARY) 
+      else
+        str
+      end
+    end
+
     def clamp_to_length(str)
-      str.force_encoding(Encoding::BINARY) if RUBY_VERSION >= "1.9"
+      str = byte_string(str)
 
       len = eval_parameter(:length) || str.length
       if str.length == len
@@ -103,12 +120,12 @@ module BinData
       elsif str.length > len
         str.slice(0, len)
       else
-        str + (eval_parameter(:pad_char) * (len - str.length))
+        str + (eval_parameter(:pad_byte) * (len - str.length))
       end
     end
 
     def trim_padding(str)
-      str.sub(/#{eval_parameter(:pad_char)}*$/, "")
+      str.sub(/#{eval_parameter(:pad_byte)}*$/, "")
     end
 
     def value_to_binary_string(val)

data/manual.haml

@@ -10,7 +10,7 @@
       var TINY={};function T$(i){return document.getElementById(i)}function T$$(e,p){return p.getElementsByTagName(e)}TINY.accordion=function(){function slider(n){this.n=n;this.a=[]}slider.prototype.init=function(t,e,m,o,k){var a=T$(t),i=s=0,n=a.childNodes,l=n.length;this.s=k||0;this.m=m||0;for(i;i<l;i++){var v=n[i];if(v.nodeType!=3){this.a[s]={};this.a[s].h=h=T$$(e,v)[0];this.a[s].c=c=T$$('div',v)[0];h.onclick=new Function(this.n+'.pr(0,'+s+')');if(o==s){h.className=this.s;c.style.height='auto';c.d=1}else{c.style.height=0;c.d=-1}s++}}this.l=s};slider.prototype.pr=function(f,d){for(var i=0;i<this.l;i++){var h=this.a[i].h,c=this.a[i].c,k=c.style.height;k=k=='auto'?1:parseInt(k);clearInterval(c.t);if((k!=1&&c.d==-1)&&(f==1||i==d)){c.style.height='';c.m=c.offsetHeight;c.style.height=k+'px';c.d=1;h.className=this.s;su(c,1)}else if(k>0&&(f==-1||this.m||i==d)){c.d=-1;h.className='';su(c,-1)}}};function su(c){c.t=setInterval(function(){sl(c)},20)};function sl(c){var h=c.offsetHeight,d=c.d==1?c.m-h:h;c.style.height=h+(Math.ceil(d/5)*c.d)+'px';c.style.opacity=h/c.m;c.style.filter='alpha(opacity='+h*100/c.m+')';if((c.d==1&&h>=c.m)||(c.d!=1&&h==1)){if(c.d==1){c.style.height='auto'}clearInterval(c.t)}};return{slider:slider}}();
 
       var menu1, menu2, menu3, menu4, menu5, menu6, menu7;
-      var menu8, menu9, menu10, menu11, menu12, menu13, menu14;
+      var menu8, menu9, menu10, menu11, menu12, menu13, menu14, menu15;
 
       function init_accordion() {
         menu1 = new TINY.accordion.slider("menu1"); menu1.init("menu1","a",1,-1);
@@ -27,6 +27,7 @@
         menu12 = new TINY.accordion.slider("menu12"); menu12.init("menu12","a",1,-1);
         menu13 = new TINY.accordion.slider("menu13"); menu13.init("menu13","a",1,-1);
         menu14 = new TINY.accordion.slider("menu14"); menu14.init("menu14","a",1,-1);
+        menu15 = new TINY.accordion.slider("menu15"); menu15.init("menu15","a",1,-1);
       };
       window.onload = init_accordion;
 
@@ -156,33 +157,12 @@
               Overview
             .acc-section
               .acc-content
-          %li
-            %a{ :href => "#common_operations" }
-              Common Operations
-            .acc-section
-              .acc-content
-                %ul.level2#menu3
-                  %li
-                    %a{ :href => "#reading_and_writing" }
-                      Reading and writing
-                    .acc-section
-                      .acc-content
-                  %li
-                    %a{ :href => "#manipulating" }
-                      Manipulating
-                    .acc-section
-                      .acc-content
-                  %li
-                    %a{ :href => "#inspecting" }
-                      Inspecting
-                    .acc-section
-                      .acc-content
           %li
             %a{ :href => "#records" }
               Records
             .acc-section
               .acc-content
-                %ul.level2#menu4
+                %ul.level2#menu3
                   %li
                     %a{ :href => "#specifying_default_endian" }
                       Specifying default endian
@@ -198,11 +178,6 @@
                       Nested Records
                     .acc-section
                       .acc-content
-                  %li
-                    %a{ :href => "#bitfields" }
-                      Bitfields
-                    .acc-section
-                      .acc-content
                   %li
                     %a{ :href => "#optional_fields" }
                       Optional fields
@@ -213,13 +188,13 @@
               Primitive Types
             .acc-section
               .acc-content
-                %ul.level2#menu5
+                %ul.level2#menu4
                   %li
                     %a{ :href => "#numerics" }
                       Numerics
                     .acc-section
                       .acc-content
-                        %ul.level3#menu6
+                        %ul.level3#menu5
                           %li
                             %a{ :href => "#byte_based_integers" }
                               Byte based integers
@@ -245,7 +220,7 @@
                       Strings
                     .acc-section
                       .acc-content
-                        %ul.level3#menu7
+                        %ul.level3#menu6
                           %li
                             %a{ :href => "#fixed_sized_strings" }
                               Fixed Sized Strings
@@ -261,47 +236,74 @@
                       User-defined Primitive Types
                     .acc-section
                       .acc-content
-                        %ul.level3#menu8
+                        %ul.level3#menu7
                           %li
                             %a{ :href => "#advanced_user_defined_primitive_types" }
                               Advanced Example
                             .acc-section
                               .acc-content
           %li
-            %a{ :href => "#arrays" }
-              Arrays
+            %a{ :href => "#compound_types" }
+              Compound Types
             .acc-section
               .acc-content
-                %ul.level2#menu9
+                %ul.level2#menu8
                   %li
-                    %a{ :href => "#array_syntax" }
-                      Array syntax
+                    %a{ :href => "#arrays" }
+                      Arrays
                     .acc-section
                       .acc-content
+                        %ul.level3#menu9
+                          %li
+                            %a{ :href => "#array_syntax" }
+                              Array syntax
+                            .acc-section
+                              .acc-content
+                          %li
+                            %a{ :href => "#array_parameters" }
+                              Array parameters
+                            .acc-section
+                              .acc-content
                   %li
-                    %a{ :href => "#array_parameters" }
-                      Array parameters
+                    %a{ :href => "#choices" }
+                      Choices
                     .acc-section
                       .acc-content
+                        %ul.level3#menu10
+                          %li
+                            %a{ :href => "#choice_syntax" }
+                              Choice syntax
+                            .acc-section
+                              .acc-content
+                          %li
+                            %a{ :href => "#choice_parameters" }
+                              Choice parameters
+                            .acc-section
+                              .acc-content
+                          %li
+                            %a{ :href => "#default_selection" }
+                              Default Selection
+                            .acc-section
+                              .acc-content
           %li
-            %a{ :href => "#choices" }
-              Choices
+            %a{ :href => "#common_operations" }
+              Common Operations
             .acc-section
               .acc-content
-                %ul.level2#menu10
+                %ul.level2#menu11
                   %li
-                    %a{ :href => "#choice_syntax" }
-                      Choice syntax
+                    %a{ :href => "#reading_and_writing" }
+                      Reading and writing
                     .acc-section
                       .acc-content
                   %li
-                    %a{ :href => "#choice_parameters" }
-                      Choice parameters
+                    %a{ :href => "#manipulating" }
+                      Manipulating
                     .acc-section
                       .acc-content
                   %li
-                    %a{ :href => "#default_selection" }
-                      Default Selection
+                    %a{ :href => "#inspecting" }
+                      Inspecting
                     .acc-section
                       .acc-content
           %li
@@ -309,7 +311,7 @@
               Advanced Topics
             .acc-section
               .acc-content
-                %ul.level2#menu11
+                %ul.level2#menu12
                   %li
                     %a{ :href => "#debugging" }
                       Debugging
@@ -336,7 +338,7 @@
                       Parameterizing Types
                     .acc-section
                       .acc-content
-                        %ul.level3#menu12
+                        %ul.level3#menu14
                           %li
                             %a{ :href => "#mandatory_parameters" }
                               Mandatory Parameters
@@ -363,8 +365,8 @@
                     .acc-section
                       .acc-content
                   %li
-                    %a{ :href => "#bitaligned_records" }
-                      Bit-aligned Records
+                    %a{ :href => "#advanced_bitfields" }
+                      Advanced Bitfields
                     .acc-section
                       .acc-content
           %li
@@ -372,7 +374,7 @@
               FAQ
             .acc-section
               .acc-content
-                %ul.level2#menu14
+                %ul.level2#menu15
                   %li
                     %a{ :href => "#im_using_ruby_19_how_do_i_use_string_encodings_with_bindata" }
                       String encoding - Ruby 1.9