ffi-bitfield 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da1a5728a9f03382d8de48da89ad38e95ddec9e493288b5f5954fc0eeed34f24
-  data.tar.gz: f14ac752955f7a13a0753099cb85b46ff6e7d8bb20f559baea397ad6fa10375d
+  metadata.gz: 7a7ec1a2c9da825cb036e42ad7b0e3745704e5bb9fba89394993c3043da9e521
+  data.tar.gz: 10d2ecd8efcb3312228d684b0e15ccc32654de39dc4399065267ad5866e2d0cb
 SHA512:
-  metadata.gz: 94d9b4e73951519a5f3af827ee4d3131891cf0586f7c01f1a7e83057fcbd27580e3edf61cc5176190ed9fc86feb73e392b122c5c7ea75ba93333609d9bc5bfe1
-  data.tar.gz: 1c652488233f533fb78e2724cb9070e81dd5cf8915e241676f7c60b8e8ecfb4de1c4fb651daf0e2f993d340fbc3a343c9ad4acd9dbebaa08308981f7af9e77c9
+  metadata.gz: 688c1d48d37dc1d9f619af9da8ee5d8ac5546d8b6dcab618db5df90d603c73a4c80aac58dfc91b385da9f4e8ea90f2442e47d73441564f5e75e579d7b2636b4c
+  data.tar.gz: 230ed815df33fe597fdf4fa9dc61afd6b69fa625de30826cb795db58aeebeb31ffecf68ebceed6b764450169dee91949ea86006ee4238d6e058e93ad84ed0b9d

data/lib/ffi/bit_field/{layout.rb → class_methods.rb}

@@ -2,9 +2,9 @@
 
 module FFI
   module BitField
-    # Layout provides methods for defining bit field layouts.
+    # ClassMethods provides methods for defining bit field layouts.
     # This module is extended by BitStruct and ManagedBitStruct classes.
-    module Layout
+    module ClassMethods
       # Returns a hash of bit fields grouped by parent field.
       #
       # @return [Hash] A hash where keys are parent field names and values are arrays of bit field names
@@ -71,6 +71,54 @@ module FFI
         result
       end
 
+      # Returns a hash of bit fields with their bit offsets, grouped by parent field.
+      #
+      # @return [Hash] A hash where keys are parent field names and values are arrays of [bit_field_name, bit_offset] pairs
+      #
+      # @example Get bit field offsets in a struct
+      #   class Flags < FFI::BitStruct
+      #     layout \
+      #       :value, :uint8
+      #
+      #     bit_fields :value,
+      #       :read,    1,
+      #       :write,   1,
+      #       :execute, 1,
+      #       :unused,  5
+      #   end
+      #
+      #   Flags.bit_field_offsets
+      #   # => {
+      #   #      :value => [[:read, 0], [:write, 1], [:execute, 2], [:unused, 3]]
+      #   #    }
+      def bit_field_offsets
+        return {} unless instance_variable_defined?(:@bit_field_hash_table)
+
+        result = {}
+
+        # Get byte offsets of parent fields
+        field_offsets = offsets.to_h
+
+        # Process each bit field
+        @bit_field_hash_table.each do |field_name, info|
+          parent_name, start, _width = info
+
+          # Get byte offset of parent field
+          parent_offset = field_offsets[parent_name]
+          next unless parent_offset
+
+          # Convert byte offset to bit offset and add bit field's start position
+          bit_offset = parent_offset * 8 + start
+
+          # Add to result
+          result[parent_name] ||= []
+          result[parent_name] << [field_name, bit_offset]
+        end
+
+        # Return result
+        result
+      end
+
       # Defines bit fields within a parent field.
       #
       # @param [Array] layout_args An array where the first element is the parent field name,

data/lib/ffi/bit_field/{property.rb → instance_methods.rb}

@@ -2,9 +2,35 @@
 
 module FFI
   module BitField
-    # Property provides methods for reading and writing bit field values.
+    # InstanceMethods provides methods for reading and writing bit field values.
     # This module is included in BitStruct and ManagedBitStruct classes.
-    module Property
+    module InstanceMethods
+      # Returns a hash of bit fields grouped by parent field.
+      # Instance method version of the class method with the same name.
+      #
+      # @return [Hash] A hash where keys are parent field names and values are arrays of bit field names
+      #
+      # @example Get bit field members in a struct instance
+      #   flags = Flags.new
+      #   flags.bit_field_members  # => {:value => [:read, :write, :execute, :unused]}
+      def bit_field_members
+        self.class.bit_field_members
+      end
+
+      # Returns a hash of bit fields with their bit offsets, grouped by parent field.
+      #
+      # @return [Hash] A hash where keys are parent field names and values are arrays of [bit_field_name, bit_offset] pairs
+      #
+      # @example Get bit field offsets in a struct instance
+      #   flags = Flags.new
+      #   flags.bit_field_offsets
+      #   # => {
+      #   #      :value => [[:read, 0], [:write, 1], [:execute, 2], [:unused, 3]]
+      #   #    }
+      def bit_field_offsets
+        self.class.bit_field_offsets
+      end
+
       # Reads a value from a bit field or regular field.
       #
       # @param [Symbol] member_name The name of the field to read

data/lib/ffi/bit_field/version.rb

@@ -3,6 +3,6 @@
 module FFI
   module BitField
     # Current version of the ffi-bitfield gem.
-    VERSION = '0.0.9'
+    VERSION = '0.0.10'
   end
 end

data/lib/ffi/bit_struct.rb

@@ -2,8 +2,8 @@
 
 require 'ffi'
 require_relative 'bit_field/version'
-require_relative 'bit_field/layout'
-require_relative 'bit_field/property'
+require_relative 'bit_field/class_methods'
+require_relative 'bit_field/instance_methods'
 
 module FFI
   # Subclass of FFI::Struct that supports bit fields.
@@ -29,13 +29,13 @@ module FFI
     # [] 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
+    extend BitField::ClassMethods
+    # The InstanceMethods 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...]
+    # # => [MStruct, FFI::ManagedBitStruct, FFI::BitField::InstanceMethods, FFI::ManagedStruct, FFI::Struct...]
     # So you do not need to use `prepend` instead of `include`.
-    include BitField::Property
+    include BitField::InstanceMethods
   end
 end

data/lib/ffi/managed_bit_struct.rb

@@ -2,8 +2,8 @@
 
 require 'ffi'
 require_relative 'bit_field/version'
-require_relative 'bit_field/layout'
-require_relative 'bit_field/property'
+require_relative 'bit_field/class_methods'
+require_relative 'bit_field/instance_methods'
 
 module FFI
   # Subclass of FFI::ManagedStruct that supports bit fields.
@@ -32,13 +32,13 @@ module FFI
     # [] 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
+    extend BitField::ClassMethods
+    # The InstanceMethods 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...]
+    # # => [YourStruct, FFI::BitStruct, FFI::BitField::InstanceMethods, FFI::Struct...]
     # So you do not need to use `prepend` instead of `include`.
-    include BitField::Property
+    include BitField::InstanceMethods
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - kojix2
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-10 00:00:00.000000000 Z
+date: 2025-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -34,8 +33,8 @@ files:
 - LICENSE.txt
 - README.md
 - lib/ffi/bit_field.rb
-- lib/ffi/bit_field/layout.rb
-- lib/ffi/bit_field/property.rb
+- lib/ffi/bit_field/class_methods.rb
+- lib/ffi/bit_field/instance_methods.rb
 - lib/ffi/bit_field/version.rb
 - lib/ffi/bit_struct.rb
 - lib/ffi/managed_bit_struct.rb
@@ -43,7 +42,6 @@ homepage: https://github.com/kojix2/ffi-bitfield
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: bit fields for Ruby-FFI
 test_files: []