binp 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d49a717a9a7b1fcd593c87782a690933f3c9a3042bf334dd11599bdec38f2c9
-  data.tar.gz: 9947217a434b646fee53adbe3b5aa36f0be3139fccdd2942ca80ea7efb1a7de8
+  metadata.gz: 5de1859ad3bbdf310f87399636229f383e4f40dd5e85624d61ae65d6ac52c3ed
+  data.tar.gz: ac7a4cc8b986aa22022e6b3205d9d11d0c06d83504c2ca30b0788a3f7356993e
 SHA512:
-  metadata.gz: a9da24affaff3ac7a84476674ebafc5eb13dabba3ada9c2e18ba7e3b1c0a382d008f1bef9405a1c4b8907a4558a9e2ff32461a516d7b5dbeb30c37bea39a3b16
-  data.tar.gz: b2ceebf7ce2c19abe698e45617407acd379818052fdd6b6f3a95ac58a38b63653f4ed34399f68a3bb5c03d47772383ea5a209c96f5c5fc860d85f3e92a0b0207
+  metadata.gz: 651c3478c7d470f7e25fcaa7f1ef15a9c508a92ee8835e5c9a05380f2662e211036195172e80499df85d0a6ee61503dbcc22db554207781fda2b1e3769e00b1d
+  data.tar.gz: 150b67bc6b8a9502bf7a204e63afb3d6260f7c536cd5f4a89dd24090155678fb1d1a1f886c0bb4ba2fd99437e507cfb41e8a16f67ba685268b52e92de8f26816

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binp (2.0.0)
+    binp (3.0.0)
       formatador
 
 GEM

data/README.md

@@ -38,7 +38,7 @@
   type: UINT32
   endianness: LITTLE
 - name: UINT16_value
-  offset: 2
+  offset: 12
   size: 2
   type: UINT16
   endianness: LITTLE
@@ -53,29 +53,30 @@
 
 実行結果は以下のようになる。
 
-json 形式で出力されるので、 `jq` 等でよしなに pretty-print してください。
+```sh
+$ ruby binary_parser.rb -c setting.yaml example.bin
+  +--------------+-------------------+
+  | name         | value             |
+  +--------------+-------------------+
+  | UINT64_value | 72057594037927936 |
+  | UINT32_value | 16777216          |
+  | UINT16_value | 256               |
+  | UINT8_value  | 1                 |
+  +--------------+-------------------+
+```
+
+`-a` オプションで追加の情報が出力される。
 
 ```sh
-$ ruby binary_parser.rb -c setting.yaml example.bin | jq '.'
-[
-  {
-    "name": "UINT64_72057594037927936",
-    "offset": 0,
-    "size": 8,
-    "type": "UINT64",
-    "endianness": "LITTLE",
-    "value": 72057594037927940
-  },
-...(snip)
-  {
-    "name": "UINT8_value",
-    "offset": 14,
-    "size": 1,
-    "type": "UINT8",
-    "endianness": "LITTLE",
-    "value": 1
-  }
-]
+$ ruby binary_parser.rb -a -c setting.yaml example.bin
+  +------------+--------------+--------+------+--------+-------------------+
+  | endianness | name         | offset | size | type   | value             |
+  +------------+--------------+--------+------+--------+-------------------+
+  | LITTLE     | UINT64_value | 0      | 8    | UINT64 | 72057594037927936 |
+  | LITTLE     | UINT32_value | 8      | 4    | UINT32 | 16777216          |
+  | LITTLE     | UINT16_value | 12     | 2    | UINT16 | 256               |
+  | LITTLE     | UINT8_value  | 14     | 1    | UINT8  | 1                 |
+  +------------+--------------+--------+------+--------+-------------------+
 ```
 
 # TODO:
@@ -83,6 +84,6 @@ $ ruby binary_parser.rb -c setting.yaml example.bin | jq '.'
 - [x] : テーブル形式で表示
 - [ ] : 文字列型サポート
     - [ ] : UTF8
-- [ ] : ビットフラグサポート
+- [x] : ビットフラグサポート
 - [ ] : type からの size 自動設定
-
+- [ ] : json 形式で表示

data/example/example.yaml

@@ -0,0 +1,20 @@
+- name: UINT64_value
+  offset: 0
+  size: 8
+  type: UINT64
+  endianness: LITTLE
+- name: UINT32_value
+  offset: 8
+  size: 4
+  type: UINT32
+  endianness: LITTLE
+- name: UINT16_value
+  offset: 12
+  size: 2
+  type: UINT16
+  endianness: LITTLE
+- name: UINT8_value
+  offset: 14
+  size: 1
+  type: UINT8
+  endianness: LITTLE

data/example/example_01.yaml

@@ -9,9 +9,9 @@
 # +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
 # | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |    30 |    31 |
 # +----+----+----+----+----+----+----+----+----+----+----+----+----+----+-------+-------+
-# | 01 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 01 | 00 | 00 | 00 | 01 | 00 |    88 |    FF |
+# | 01 | 00 | 00 | 00 | 00 | 00 | 00 | 00 | 01 | 00 | 00 | 00 | 01 | 00 |    88 |    AA |
 # +---------------------------------------+-------------------+---------+-------+-------+
-# | UINT64                                | UINT32            |  UINT16 | UINT8 | UINT8 |
+# | UINT64                                | UINT32            |  UINT16 | UINT8 | FLAGS |
 # +---------------------------------------+-------------------+---------+-------+-------+
 ---
 - name: UINT64_72057594037927936
@@ -54,14 +54,30 @@
   size: 2
   type: UINT16
   endianness: BIG
-- name: UINT8_255
+- name: UINT8_136
   offset: 30
   size: 1
   type: UINT8
   endianness: BIG
-- name: UINT8_136
+- name: FLAGS
   offset: 31
-  size: 1
-  type: UINT8
-  endianness: BIG
-
+  type: FLAGS
+  layout:
+    - name: LED1
+      position: 0
+    - name: LED2
+      position: 1
+      true_label: "high"
+      false_label: "low"
+    - name: LED3
+      position: 2
+    - name: LED4
+      position: 3
+    - name: LED5
+      position: 4
+    - name: LED6
+      position: 5
+    - name: LED7
+      position: 6
+    - name: LED8
+      position: 7

data/lib/binp.rb

@@ -3,8 +3,13 @@ require "binp/version"
 
 class BinParser
   def self.parse(uint8_array, config)
-    config.map { |e|
-      e['value'] = BinParserElement.get_value(uint8_array, e['offset'], e['size'], e['type'], e['endianness'])
+    config.flat_map { |e|
+      # ビットフラグかどうかを確認
+      if e['type'] == BinParserElement::Type::FLAGS
+        e = BinParserElement.get_flags(uint8_array, e)
+      else
+        e['value'] = BinParserElement.get_value(uint8_array, e['offset'], e['size'], e['type'], e['endianness'])
+      end
       e
     }
   end
@@ -80,5 +85,27 @@ class BinParserElement
     unpack_template_string = calculate_unpack_template_string(type, endianness)
     target.pack(pack_template_string).unpack(unpack_template_string)[0]
   end
+
+  def self.get_flags(uint8_array, config)
+    offset = config['offset']
+    layout = config['layout']
+    target = uint8_array.slice(offset, 1)
+    layout.map { |e|
+      c = config.dup
+      c['name'] = e['name']
+
+      # ビットが立っているかの確認
+      c['value'] = target[0] & (1 << e['position'])
+
+      # true_label, false_label が存在すればそれに設定。
+      # 存在しなければデフォルト値('ON', 'OFF')に設定。
+      if c['value'] != 0
+        c['value'] = e.fetch('true_label', 'ON')
+      else
+        c['value'] = e.fetch('false_label', 'OFF')
+      end
+      c
+    }
+  end
 end
 

data/lib/binp/cli/main.rb

@@ -21,7 +21,14 @@ class Main
     # 出力用に加工して出力
     result = raw_result.map { |e|
       e['type'] = e['type'][:name]
-      e['endianness'] = e['endianness'][:name]
+
+      # FLAGS では endianness が無い場合があるのでチェックしてから設定
+      if e['endianness']
+        e['endianness'] = e['endianness'][:name]
+      end
+
+      # layout は出力量が多すぎるので削除
+      e.delete('layout')
       e
     }
     if  !opts[:all]
@@ -65,11 +72,13 @@ class Main
       }
 
       # YAML 記載の endianness に対応した Endianness オブジェクトに差し替える
-      if endianness
-        e['endianness'] = BinParserElement::Endianness.const_get(endianness)
-      else
-        STDERR.puts "#{i} 番目の endianness の値が不正です('#{e['endianness']}')。LITTLE or BIG を指定してください。"
-        exit(1)
+      if e['type'] != BinParserElement::Type::FLAGS
+        if endianness
+          e['endianness'] = BinParserElement::Endianness.const_get(endianness)
+        else
+          STDERR.puts "#{i} 番目の endianness の値が不正です('#{e['endianness']}')。LITTLE or BIG を指定してください。"
+          exit(1)
+        end
       end
     }
 

data/lib/binp/version.rb

@@ -1,3 +1,3 @@
 module Binp
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binp
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - mikoto2000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formatador
@@ -70,6 +70,8 @@ files:
 - bin/console
 - bin/setup
 - binp.gemspec
+- example/example.bin
+- example/example.yaml
 - example/example_01.bin
 - example/example_01.yaml
 - exe/binp