ffi-bitfield 0.0.2 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8718e2b995e05ebbbfc068b45acef79a24b371905ec0afc4fe828d608f56a32
-  data.tar.gz: e303e6e22a0927d312934fd9085f6b4e7a19ee10361fafe90c465462d8b1de9d
+  metadata.gz: 8e2586353fd6f53337bf3ffef8019d477c279c0284642165fad4d592315ccc1a
+  data.tar.gz: 2772a6b9ef73faeccc105c501494d6fe82079614b6e23bab14de3954d1f1d1f2
 SHA512:
-  metadata.gz: 54b27c548d1f4d1ec0373f7f0d60a6079b9b3c471be0e773aabe8d5c8dfabee6cdaaa6a2a8982fdec4b3d34cc301817b329e32d734187c1b8bb8dfa44cd427cd
-  data.tar.gz: 163eb57089a2b6f88ada99a2ff9909a7c7bf34dc1bf56afa1665441de7232117df779107250ea66086024689a32c5fabb8e611c8d53af53552208f6cac9818bb
+  metadata.gz: 911015a3478c323f4469076489e68d7634d12188200dea1e8ae76263af368b992fb424c6f086cc46cb30aa501ca12326039a8a6a184524e2f54b6cb35f2495c1
+  data.tar.gz: 82951de5f89c776408d35e656a8ce100c1306899e808569dd181cd5c56bfbee961329ac989455b9814e5815928227e732d4ea1e8d21a09141fadcb00cce49760

data/README.md

@@ -5,8 +5,6 @@
 
 Bit field for [Ruby-FFI](https://github.com/ffi/ffi)
 
-:construction: alpha　ー Supports reading bit fields only.
-
 ## Installation
 
 ```sh
@@ -61,15 +59,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
@@ -83,6 +73,7 @@ bundle exec rake test
 
 ## Contributing
 
+ffi-bitfield is a library under development, so even small improvements like typofix are welcome! Please feel free to send us your pull requests.
 Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/bitstruct.
 
 ## License

data/lib/ffi/bit_field.rb

@@ -1,11 +1,11 @@
 # 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'
 
 module FFI
+  # This module is just a namespace.
   module BitField
   end
 end

data/lib/ffi/bit_field/layout.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module FFI
+  module BitField
+    # Layout provides the `bit_fields` method for registering field members.
+    module Layout
+      # @param [Array] layout_args
+      # @return [Symbol] parent_name
+      def bit_fields(*layout_args)
+        # The reason for using class instance variable here instead of class variable
+        # is not because class instance variables are clean,
+        # but because sub-class of FFI::Struct cannot be inherited again.
+        @bit_field_hash_table = {} unless instance_variable_defined?(:@bit_field_hash_table)
+
+        parent_name = layout_args.shift.to_sym
+        member_names = []
+        widths = []
+        layout_args.each_slice(2) do |name, width|
+          member_names << name.to_sym
+          widths << width.to_i
+        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
+
+        parent_name
+      end
+      alias bit_field bit_fields
+    end
+  end
+end

data/lib/ffi/bit_field/property.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FFI
+  module BitField
+    # Properties provides methods to read and write bit fields.
+    module Property
+      # @param [Symbol] member_name
+      # @return [Integer] value
+      def [](member_name)
+        parent_name, start, width = member_value_info(member_name)
+        if parent_name
+          value = get_member_value(parent_name)
+          value[start, width]
+        else
+          get_member_value(member_name)
+        end
+      end
+
+      def []=(member_name, value)
+        parent_name, start, width = member_value_info(member_name)
+        if parent_name
+          raise "Value #{value} is larger than bit_length: #{width}" if value.bit_length > width
+
+          parent_value = get_member_value(parent_name)
+          new_value = (((1 << width) - 1 << start) & parent_value ^ parent_value) |
+                      (value << start)
+          set_member_value(parent_name, new_value)
+        else
+          set_member_value(member_name, value)
+        end
+      end
+
+      private
+
+      def member_value_info(member_name)
+        self.class.instance_variable_get(:@bit_field_hash_table)[member_name]
+      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.6'
   end
-end
+end

data/lib/ffi/bit_struct.rb

@@ -2,10 +2,22 @@
 
 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
+  # Subclass of FFI::Struct that support bit fields.
   class BitStruct < Struct
-    extend BitField::BitFiledSupporter
+    # [] is defined in FFI::Struct
+    alias get_member_value []
+    alias set_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,23 @@
 # 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
+  # Subclass of FFI::ManagedStruct that support bit fields.
   class ManagedBitStruct < ManagedStruct
-    extend BitFiledSupporter
+    # [] is defined in FFI::Struct
+    alias get_member_value []
+    alias set_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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.6
 platform: ruby
 authors:
 - kojix2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -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
@@ -120,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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