ffi-bitfield 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8718e2b995e05ebbbfc068b45acef79a24b371905ec0afc4fe828d608f56a32
-  data.tar.gz: e303e6e22a0927d312934fd9085f6b4e7a19ee10361fafe90c465462d8b1de9d
+  metadata.gz: 6d75494c09a1b688169fd2630a7ea299a5c58ad312f9ae369a4c0c11165c46e6
+  data.tar.gz: 60840b874151b38faa6ef56cf6f7f6f179cf2415053edce96f08f32e82874ceb
 SHA512:
-  metadata.gz: 54b27c548d1f4d1ec0373f7f0d60a6079b9b3c471be0e773aabe8d5c8dfabee6cdaaa6a2a8982fdec4b3d34cc301817b329e32d734187c1b8bb8dfa44cd427cd
-  data.tar.gz: 163eb57089a2b6f88ada99a2ff9909a7c7bf34dc1bf56afa1665441de7232117df779107250ea66086024689a32c5fabb8e611c8d53af53552208f6cac9818bb
+  metadata.gz: 6d1d86bda1e5c71a59bc801eb35ee64522bc5d6bd49452afd01583240d4358d370fadc5b3bfa6c619ebb3b65c3cc116d14e149cce2c8977f923365708a8d20bb
+  data.tar.gz: 6c7642a18712a0959273d6a46a5c46b3f6c2bd1b0861cace828f9d6fb717aa76ab3643dc9af509c5478e80e05371609a9a5f871132016f9767b50cb77985c794

data/README.md

@@ -61,15 +61,7 @@ require 'ffi/managed_bit_struct'
 ```md
 * module FFI
   * class BitStruct < FFI::Struct
-    * include BitFieldSupporter
-
   * class ManagedBitStruct < FFI::ManagedStruct
-    * include BitFieldSupporter
-
-  * module BitField
-    * module BitFieldSupporter
-      * bit_fields
-      * bit_field <- alias of bit_fields
 ```
 
 ## Development

data/lib/ffi/bit_field.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'bit_field/version'
-require_relative 'bit_field/bit_field_supporter'
 require_relative 'bit_struct'
 require_relative 'managed_bit_struct'
 

data/lib/ffi/bit_field/layout.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FFI
+  module BitField
+    module Layout
+      def bit_fields(*args)
+        # The reason for using class instance variable here instead of
+        # class variable is that sub-class of FFI::Struct cannot be inherited again,
+        # not because class instance variables are clean.
+        @bit_field_hash_table = {} unless instance_variable_defined?(:@bit_field_hash_table)
+
+        parent_name = args.shift
+        member_names = []
+        widths = []
+        args.each_slice(2) do |name, width|
+          member_names << name
+          widths << width
+        end
+        starts = widths.inject([0]) do |result, width|
+          result << (result.last + width)
+        end
+        member_names.zip(starts, widths).each do |name, start, width|
+          @bit_field_hash_table[name] = [parent_name, start, width]
+        end
+      end
+      alias bit_field bit_fields
+    end
+  end
+end

data/lib/ffi/bit_field/property.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FFI
+  module BitField
+    module Property
+      def [](member_name)
+        bit_fields = self.class.instance_variable_get(:@bit_field_hash_table)
+        parent_name, start, width = bit_fields[member_name]
+        if parent_name
+          value = get_member_value(parent_name)
+          (value >> start) & ((1 << width) - 1)
+        else
+          get_member_value(member_name)
+        end
+      end
+    end
+  end
+end

data/lib/ffi/bit_field/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module FFI
   module BitField
-    VERSION="0.0.2"
+    VERSION = '0.0.3'
   end
-end
+end

data/lib/ffi/bit_struct.rb

@@ -2,10 +2,20 @@
 
 require 'ffi'
 require_relative 'bit_field/version'
-require_relative 'bit_field/bit_field_supporter'
+require_relative 'bit_field/layout'
+require_relative 'bit_field/property'
 
 module FFI
   class BitStruct < Struct
-    extend BitField::BitFiledSupporter
+    # [] is defined in FFI::Struct
+    alias get_member_value []
+    extend BitField::Layout
+    # The Property module included in the FFI::ManagedBitStruct class is
+    # * behind the FFI::ManagedBitStruct class, but is
+    # * in FRONT of the FFI::Struct class.
+    # `MStruct.ancestors`
+    # # => [MStruct, FFI::ManagedBitStruct, FFI::BitField::Property, FFI::ManagedStruct, FFI::Struct...]
+    # So you do not need to use `prepend` instead of `include`.
+    include BitField::Property
   end
 end

data/lib/ffi/managed_bit_struct.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
 require 'ffi'
-require_relative 'bit_struct/version'
-require_relative 'bit_field_supporter'
+require_relative 'bit_field/version'
+require_relative 'bit_field/layout'
+require_relative 'bit_field/property'
 
 module FFI
   class ManagedBitStruct < ManagedStruct
-    extend BitFiledSupporter
+    # [] is defined in FFI::Struct
+    alias get_member_value []
+    extend BitField::Layout
+    # The Property module included in the FFI::BitStruct class is
+    # * behind the FFI::BitStruct class, but is
+    # * in FRONT of the FFI::Struct class.
+    # `YourStruct.ancestors`
+    # # => [YourStruct, FFI::BitStruct, FFI::BitField::Property, FFI::Struct...]
+    # So you do not need to use `prepend` instead of `include`.
+    include BitField::Property
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - kojix2
@@ -104,7 +104,8 @@ files:
 - LICENSE.txt
 - README.md
 - lib/ffi/bit_field.rb
-- lib/ffi/bit_field/bit_field_supporter.rb
+- lib/ffi/bit_field/layout.rb
+- lib/ffi/bit_field/property.rb
 - lib/ffi/bit_field/version.rb
 - lib/ffi/bit_struct.rb
 - lib/ffi/managed_bit_struct.rb

data/lib/ffi/bit_field/bit_field_supporter.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module FFI
-  module BitField
-    module BitFiledSupporter
-      module BitFieldModule
-        def [](name)
-          bit_fields = self.class.bit_fields_hash_table
-          parent, start, width = bit_fields[name]
-          if parent
-            (super(parent) >> start) & ((1 << width) - 1)
-          else
-            super(name)
-          end
-        end
-      end
-      private_constant :BitFieldModule
-
-      attr_reader :bit_fields_hash_table
-
-      def bit_fields(*args)
-        unless instance_variable_defined?(:@bit_fields_hash_table)
-          @bit_fields_hash_table = {}
-          prepend BitFieldModule
-        end
-
-        parent = args.shift
-        labels = []
-        widths = []
-        args.each_slice(2) do |l, w|
-          labels << l
-          widths << w
-        end
-        starts = widths.inject([0]) do |result, w|
-          result << (result.last + w)
-        end
-        labels.zip(starts, widths).each do |l, s, w|
-          @bit_fields_hash_table[l] = [parent, s, w]
-        end
-      end
-      alias bit_field bit_fields
-    end
-  end
-end