binary_parser 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc0580a7a3667f74608fc328897ce3ee3772b94a
-  data.tar.gz: d9c1e1b204e9813ff8239cd2d36f45a509430c54
+  metadata.gz: b0307ae683d47cfe6a2525daadd6e2243ef6c243
+  data.tar.gz: 701289dee15d26ccea833011bdd85cb280153965
 SHA512:
-  metadata.gz: 658d10fb088312e15f51965c4a8a9f366b60a58e3be00a61d0dc70fc243f0f124e8adac9b5ef5f113eb2e43ca7b0fa7f83b0998684a7001492819cec4f94547e
-  data.tar.gz: c8347f938c25674e959014f1bcc1f4097a6d8efdde741f819a5c72f490297d372415c70c68121eea7a14cb6cfffab3a24f46ba394a64163472548ec6a8dc850e
+  metadata.gz: 095aedb2598057330badc1037371333fb7ca6ef5edfb37ad26747984ba95297883883a32575e151d0f66238c48c5bb04d7834c8a2383a9368c59d06e17b1cb9e
+  data.tar.gz: 28e0a0fe38de2617a8e90c900389c26bfdbea4d3bfac2413bbef888e0d3475c468bf3a1a3c695089dea47bcef41ec6a4b6a9aedd90a45f25cc0d05a8a473b101

data/.gitignore

@@ -1,4 +1,5 @@
 *.*~
+*#
 *.gem
 *.rbc
 .bundle
@@ -17,3 +18,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+test.rb
+test2.rb
+test3.rb

data/README.md

@@ -102,54 +102,60 @@ Consider the following (temporary) binary structures which describe Image data.
 
 You can define MyImage structure in ruby program as following code.
 
-
-    require 'binary_parser'
-
-    class MyDate < BinaryParser::TemplateBase
-      require 'date'
-
-      Def do
-        data :year,  UInt, 13
-        data :month, UInt, 9
-        data :day,   UInt, 9
-      end
-
-      def to_date
-        return Date.new(year.to_i, month.to_i, day.to_i)
+```ruby
+require 'binary_parser'
+
+class MyDate < BinaryParser::TemplateBase
+  require 'date'
+
+  Def do
+    data :year,  UInt, 13
+    data :month, UInt, 9
+    data :day,   UInt, 9
+  end
+
+  def to_date
+    return Date.new(year.to_i, month.to_i, day.to_i)
+  end
+end
+
+class MyImage < BinaryParser::TemplateBase
+  Def do
+    data :height, UInt, 8
+    data :width,  UInt, 8
+
+    # Loop statement
+    TIMES var(:height), :i do
+      TIMES var(:width), :j do
+        data :R, UInt, 8
+        data :G, UInt, 8
+        data :B, UInt, 8
       end
     end
 
-    class MyImage < BinaryParser::TemplateBase
-      Def do
-        data :height, UInt, 8
-        data :width,  UInt, 8
-
-        TIMES var(:height), :i do
-          TIMES var(:width), :j do
-            data :R, UInt, 8
-            data :G, UInt, 8
-            data :B, UInt, 8
-          end
-        end
-
-        data :has_date, Flag, 1
-        IF cond(:has_date){|v| v.flagged?} do
-          data :date, MyDate, 31
-        end
-      end
-    end
+    data :has_date, Flag, 1
 
+    # Condition statement
+    # * If you want check whether variable-name is valid, alternative expression
+    #     IF cond(:has_date){|v| v.on?} do ~ end
+    #   is also available.
+    IF E{ has_date.on? } do
+      data :date, MyDate, 31
+    end
+  end
+end
+```
 
 And then you can parse and read binay-data of MyImage as follows.
 
-    File.open('my_image.bin', 'rb') do |f|
-      image = MyImage.new(f.read)
-      print "Image size: #{image.height.to_i}x#{image.width.to_i}\n"
-      ul = image.i[0].j[0]
-      print "RGB color at the first is (#{ul.R.to_i}, #{ul.G.to_i}, #{ul.B.to_i})\n"
-      print "Image date: #{image.date.to_date}\n"
-    end
-
+```ruby
+File.open('my_image.bin', 'rb') do |f|
+  print "Image size: #{image.height}x#{image.width}\n"
+  ul = image.i[0].j[0]
+  print "RGB color at the first is (#{ul.R}, #{ul.G}, #{ul.B})\n"
+  print "Image date: #{image.date.to_date}\n"
+end
+```
 
 If 'my_image.bin' is binary-data-file of [0x02, 0x02, 0xe7,0x39,0x62, 0x00,0x00,0x00, 0xe7,0x39,0x62, 0x00,0x00,0x00, 0x9f, 0x78, 0x08, 0x03], 
 you can get output as follows.
@@ -161,62 +167,93 @@ you can get output as follows.
 
 For your information, you can dump all binary-data's information as follows.
 
-    File.open('my_image.bin', 'rb') do |f|
-      image = MyImage.new(f.read)
-      image.show(true)
-    end
-
+```ruby
+File.open('my_image.bin', 'rb') do |f|
+  image = MyImage.new(f.read)
+  image.show(true)
+end
+```
 
 ### Example 2  ###
 You can also define other structures as follows.
 
-    class DefExample < BinaryParser::TemplateBase
-      Def do
-        data :loop_byte_length, UInt, 8
-
-        # Loop until 'loop_byte_length' * 8 bits are parsed.
-        SPEND var(:loop_byte_length) * 8, :list do
-          data :length, UInt,   8
-          # Specifying length by neigbor value.
-          data :data,   Binary, var(:length) * 8
-        end
-
-        data :v1, UInt, 8
-        data :v2, UInt, 8
-
-        # Number of Condition variables is arbitary. 
-        IF cond(:v1, :v2){|v1, v2| v1.to_i == v2.to_i} do
-          # +, -, *, / is available for var. (Order of [Integer op Variable] is NG.)
-          data :v3, UInt, (var(:v1) + var(:v2)) * 8
-        end
-      end
+```ruby
+class DefExample < BinaryParser::TemplateBase
+  Def do
+    data :loop_byte_length, UInt, 8
+
+    # Loop until 'loop_byte_length' * 8 bits are parsed.
+    SPEND var(:loop_byte_length) * 8, :list do
+
+      data :length, UInt,   8
+
+      # You can specify length by neigbor value.
+      data :data,   Binary, var(:length) * 8
     end
 
-Check this definition by giving some binary-data and calling show method as follows. 
+    data :v1, UInt, 8
+    data :v2, UInt, 8
 
-    i = DefExample.new([0x05, 0x01, 0xff, 0x02, 0xff, 0xff, 0x01, 0x01, 0x01, 0x01].pack("C*"))
-    i.show(true)
+    # Number of Condition variables is arbitary. 
+    IF cond(:v1, :v2){|v1, v2| v1 == v2} do
+
+      # +, -, *, / is available to specify length with variable.
+      data :v3, UInt, 8 * (var(:v1) + var(:v2))
+    end
+  end
+end
+```
+
+You can check this definition by giving some binary-data and calling show method as follows. 
+
+```ruby
+i = DefExample.new([0x05, 0x01, 0xff, 0x02, 0xff, 0xff, 0x01, 0x01, 0x01, 0x01].pack("C*"))
+i.show(true)
+```
+
+Output for above checking-code is shown below.
+
+```
+*--------------------------------------------------------------------------------
+loop_byte_length  Pos:      0  Len:      8  Type:       UInt  Cont: 5
+list              Pos:      8  Len:     40  Type:   LoopList  Cont: list with 2 elements
+  [0]
+    *--------------------------------------------------------------------------------
+    length  Pos:      0  Len:      8  Type:       UInt  Cont: 1
+    data    Pos:      8  Len:      8  Type:     Binary  Cont: [0xff]
+  [1]
+    *--------------------------------------------------------------------------------
+    length  Pos:      0  Len:      8  Type:       UInt  Cont: 2
+    data    Pos:      8  Len:     16  Type:     Binary  Cont: [0xff, 0xff]
+v1                Pos:     48  Len:      8  Type:       UInt  Cont: 1
+v2                Pos:     56  Len:      8  Type:       UInt  Cont: 1
+v3                Pos:     64  Len:     16  Type:       UInt  Cont: 257
+```
 
 
 ### Example 3  ###
 If you want to operate Stream-data, StreamTemplateBase class is useful. Define stream as follows.
 
-    class StreamExample < BinaryParser::StreamTemplateBase
-      # Stream which consists of every 4 byte binary-data.
-      Def(4) do
-        data :data1, UInt,   8
-        data :data2, Binary, 24
-      end
-    end
+```ruby
+class StreamExample < BinaryParser::StreamTemplateBase
+  # Stream which consists of every 4 byte binary-data.
+  Def(4) do
+    data :data1, UInt,   8
+    data :data2, Binary, 24
+  end
+end
+```
 
 And then, get structures from the stream as follows.
 
-    File.open('my_image.bin', 'rb') do |f|
-      stream = StreamExample.new(f)
-      packet = stream.get_next
-      puts "data1: #{packet.data1.to_i}, data2: #{packet.data2.to_s}"
-      stream.get_next.show(true)
-    end
+```ruby
+File.open('my_image.bin', 'rb') do |f|
+  stream = StreamExample.new(f)
+  packet = stream.get_next
+  puts "data1: #{packet.data1}, data2: #{packet.data2}"
+  stream.get_next.show(true)
+end
+```
 
 StreamTemplateBase has many useful methods to choose structures from the stream.
 If you want to know detail of these methods, please read documentation or concerned source-files.
@@ -236,4 +273,5 @@ Access shown address by web browser.
 
 Versions
 --------
-1.0.0 April 6, 2014
+1.0.0 April    6, 2014
+1.2.0 November 7, 2014

data/examples/example1.rb

@@ -0,0 +1,49 @@
+require File.dirname(File.expand_path(File.dirname(__FILE__))) + "/lib/binary_parser.rb"
+
+class MyDate < BinaryParser::TemplateBase
+  require 'date'
+
+  Def do
+    data :year,  UInt, 13
+    data :month, UInt, 9
+    data :day,   UInt, 9
+  end
+
+  def to_date
+    return Date.new(year.to_i, month.to_i, day.to_i)
+  end
+end
+
+class MyImage < BinaryParser::TemplateBase
+  Def do
+    data :height, UInt, 8
+    data :width,  UInt, 8
+
+    # Loop statement
+    TIMES var(:height), :i do
+      TIMES var(:width), :j do
+        data :R, UInt, 8
+        data :G, UInt, 8
+        data :B, UInt, 8
+      end
+    end
+
+    data :has_date, Flag, 1
+
+    # Condition statement
+    # * If you want check whether variable-name is valid, alternative expression
+    #     IF cond(:has_date){|v| v.on?} do ~ end
+    #   is also available.
+    IF E{ has_date.on? } do
+      data :date, MyDate, 31
+    end
+  end
+end
+
+bin = [0x02, 0x02, 0xe7,0x39,0x62, 0x00,0x00,0x00, 0xe7,0x39,0x62, 0x00,0x00,0x00, 0x9f, 0x78, 0x08, 0x03]
+
+image = MyImage.new(bin.pack("C*"))
+print "Image size: #{image.height}x#{image.width}\n"
+ul = image.i[0].j[0]
+print "RGB color at the first is (#{ul.R}, #{ul.G}, #{ul.B})\n"
+print "Image date: #{image.date.to_date}\n"

data/examples/example2.rb

@@ -0,0 +1,29 @@
+require File.dirname(File.expand_path(File.dirname(__FILE__))) + "/lib/binary_parser.rb"
+
+class DefExample < BinaryParser::TemplateBase
+  Def do
+    data :loop_byte_length, UInt, 8
+
+    # Loop until 'loop_byte_length' * 8 bits are parsed.
+    SPEND var(:loop_byte_length) * 8, :list do
+
+      data :length, UInt,   8
+
+      # You can specify length by neigbor value.
+      data :data,   Binary, var(:length) * 8
+    end
+
+    data :v1, UInt, 8
+    data :v2, UInt, 8
+
+    # Number of Condition variables is arbitary. 
+    IF cond(:v1, :v2){|v1, v2| v1 == v2} do
+
+      # +, -, *, / is available to specify length with variable.
+      data :v3, UInt, 8 * (var(:v1) + var(:v2))
+    end
+  end
+end
+
+i = DefExample.new([0x05, 0x01, 0xff, 0x02, 0xff, 0xff, 0x01, 0x01, 0x01, 0x01].pack("C*"))
+i.show(true)

data/lib/binary_parser/version.rb

@@ -1,3 +1,3 @@
 module BinaryParser
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/lib/binary_parser.rb

@@ -53,4 +53,16 @@ module BinaryParser
   LIB_FILES.each do |path|
     require LIBRARY_ROOT_PATH + LIB_DIR  + path
   end
+
+
+  # load sub-built-in template file
+  SUB_BUILT_IN_TEMPLATE_FILES =
+    [
+     'uint_n.rb',
+    ]
+
+  SUB_BUILT_IN_TEMPLATE_FILES.each do |path|
+    require LIBRARY_ROOT_PATH + BUILT_IN_TEMPLATE_DIR  + path
+  end
+
 end

data/lib/built_in_template/uint_n.rb

@@ -0,0 +1,21 @@
+module BinaryParser
+  module BuiltInTemplate
+    class UIntN < UInt
+      def to_i
+        entity.to_i
+      end
+    end
+    
+    class UInt8 < UIntN
+      Def do
+        data :entity, UInt, 8
+      end
+    end
+
+    class UInt16 < UIntN
+      Def do
+        data :entity, UInt, 16
+      end
+    end
+  end
+end

data/lib/general_class/expression.rb

@@ -228,8 +228,8 @@ module BinaryParser
             stack + [token.value]
           elsif token.is_a?(Expression::Token::Variable)
             eval_value = token_eval_proc.call(token)
-            unless eval_value.is_a?(Integer)
-              raise BadManipulationError, "Evaluation is faild. #{eval_value} is not Integer."
+            unless eval_value.is_a?(Integer) || eval_value.is_a?(::BinaryParser::BuiltInTemplate::UInt)
+              raise BadManipulationError, "Evaluation is faild. #{eval_value} is not Integer (or UInt) (#{eval_value.class})."
             end
             stack + [eval_value]
           end

data/lib/scope.rb

@@ -61,7 +61,7 @@ module BinaryParser
       unless @definition[name].conditions.all?{|cond| eval(cond, name)}
         return 0
       end
-      return eval(@definition[name].bit_length, name)
+      return eval(@definition[name].bit_length, name).to_i
     end
   
     def eval_entire_bit_length
@@ -86,7 +86,7 @@ module BinaryParser
           raise ParsingError, "Variable '#{token.symbol}' assigned  to Nil is referenced" +
             "at the time of resolving '#{name}'."
         end
-        val.to_i
+        val
       end
     end
     

data/lib/structure_definition.rb

@@ -31,16 +31,16 @@ module BinaryParser
       define(name, DataDefinition.new(bit_at, bit_length, @conditions.dup, klass))
     end
 
-    def SPEND(bit_length, name, &block)
+    def SPEND(bit_length, name, klass=nil, &block)
       __check_new_def_name(name)
       bit_at, bit_length = __process_bit_length(bit_length, name)
-      klass = NamelessTemplateMaker.new(self, block)
+      klass ||= NamelessTemplateMaker.new(self, block)
       define(name, LoopDefinition.new(bit_at, bit_length, @conditions.dup, klass))
     end
 
-    def TIMES(times, name, &block)
+    def TIMES(times, name, klass=nil, &block)
       __check_new_def_name(name)
-      klass = NamelessTemplateMaker.new(self, block)
+      klass ||= NamelessTemplateMaker.new(self, block)
       structure = klass.structure
       if structure.bit_at.names.empty?
         bit_at, bit_length = __process_bit_length(times * structure.bit_at.imm, name)

data/lib/template_base.rb

@@ -1,5 +1,6 @@
 module BinaryParser
   class TemplateBase
+
     include BuiltInTemplate
 
     def self.def_structure(parent_structure=nil, &definition_proc)

data/unit_test/test_scope.rb

@@ -259,6 +259,44 @@ module BinaryParser
         assert_equal(1 * 8, i.structure_bit_length)
       end
 
+      # TEST CASE STRUCTURE 10
+      # * new way of SPEND and TIMES
+      class ST10 < TemplateBase
+
+        class ST10SPEND < TemplateBase
+          Def do
+            data :dat, UInt, 8
+          end
+        end
+
+        class ST10TIMES < TemplateBase
+          Def do
+            data :dat, UInt, 8
+          end
+        end
+
+        Def do
+          data :spend_size, UInt, 8
+          SPEND var(:spend_size) * 8, :spend_datas, ST10SPEND
+          data :times, UInt, 8
+          TIMES var(:times), :times_datas, ST10TIMES
+        end
+      end
+
+      def test_ST10_CASE1
+        bin = gen_bin(2, 0xaa, 0xbb, 2, 0xcc, 0xdd)
+        i = ST10.new(bin)
+
+        assert_equal(2,    i.spend_size.to_i)
+        assert_equal(0xaa, i.spend_datas[0].dat.to_i)
+        assert_equal(0xbb, i.spend_datas[1].dat.to_i)
+        assert_equal(2,    i.times.to_i)
+        assert_equal(0xcc, i.times_datas[0].dat.to_i)
+        assert_equal(0xdd, i.times_datas[1].dat.to_i)
+        assert(i.hold_just_binary?)
+      end
+
+
       # helpers
       def gen_bin(*chars)
         return AbstractBinary.new(chars.pack("C*"))

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: binary_parser
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - sawaken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "This library can parse all kind of binary-data structures including
@@ -51,17 +51,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - binary_parser.gemspec
+- examples/example1.rb
+- examples/example2.rb
 - lib/binary_parser.rb
 - lib/binary_parser/version.rb
 - lib/built_in_template/binary.rb
 - lib/built_in_template/flag.rb
 - lib/built_in_template/uint.rb
+- lib/built_in_template/uint_n.rb
 - lib/error.rb
 - lib/general_class/abstract_binary.rb
 - lib/general_class/binary_manipulate_function.rb
@@ -101,17 +104,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An elegant DSL library for parsing binary-data.