ffi-bitfield 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50775cc156bce79d4d20153303484ba80d19d23707d5413ea2557676260e8b38
-  data.tar.gz: 941e057d7cd548da1fd133f81143e573d7795c060d7678334c74cd1ed7cdaa31
+  metadata.gz: da1a5728a9f03382d8de48da89ad38e95ddec9e493288b5f5954fc0eeed34f24
+  data.tar.gz: f14ac752955f7a13a0753099cb85b46ff6e7d8bb20f559baea397ad6fa10375d
 SHA512:
-  metadata.gz: 7329ad0a6bf66f580af0fdbbc3219774a53e7624a78e8e3891562150444282c0b2aae26b5eb4382edf8f67e27e66224aaf32592757f6e813105ab432a5e646a5
-  data.tar.gz: 3e4bb498d57114b6f9ccaf140d5789239609ff402f3be888d419fefa66957547659f1d5ab8577439f9fb98ad89fa6d56869f30a985b04486bc9bc90799c9b82a
+  metadata.gz: 94d9b4e73951519a5f3af827ee4d3131891cf0586f7c01f1a7e83057fcbd27580e3edf61cc5176190ed9fc86feb73e392b122c5c7ea75ba93333609d9bc5bfe1
+  data.tar.gz: 1c652488233f533fb78e2724cb9070e81dd5cf8915e241676f7c60b8e8ecfb4de1c4fb651daf0e2f993d340fbc3a343c9ad4acd9dbebaa08308981f7af9e77c9

data/README.md

@@ -70,6 +70,42 @@ s[:y] = 1
 p s[:a] # 64
 ```
 
+### Inspecting Bit Fields
+
+You can use the `bit_field_members` method to get a hash of bit fields grouped by parent field:
+
+```ruby
+class Flags < FFI::BitStruct
+  layout \
+    :value, :uint8
+
+  bit_fields :value,
+    :read,    1,
+    :write,   1,
+    :execute, 1,
+    :unused,  5
+end
+
+p Flags.bit_field_members
+# => {:value=>[:read, :write, :execute, :unused]}
+```
+
+For more detailed information, you can use the `bit_field_layout` method:
+
+```ruby
+p Flags.bit_field_layout
+# => {
+#      :value => {
+#        :read    => { :start => 0, :width => 1 },
+#        :write   => { :start => 1, :width => 1 },
+#        :execute => { :start => 2, :width => 1 },
+#        :unused  => { :start => 3, :width => 5 }
+#      }
+#    }
+```
+
+These methods are useful for custom pretty printing or introspection of your bit struct classes.
+
 ### Loading
 
 ```ruby

data/lib/ffi/bit_field/layout.rb

@@ -5,6 +5,72 @@ module FFI
     # Layout provides methods for defining bit field layouts.
     # This module is extended by BitStruct and ManagedBitStruct classes.
     module Layout
+      # 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
+      #
+      # @example Get bit field members 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_members  # => {:value => [:read, :write, :execute, :unused]}
+      def bit_field_members
+        return {} unless instance_variable_defined?(:@bit_field_hash_table)
+
+        result = {}
+        @bit_field_hash_table.each do |field_name, info|
+          parent_name = info[0]
+          result[parent_name] ||= []
+          result[parent_name] << field_name
+        end
+        result
+      end
+
+      # Returns a hash of bit fields with detailed layout information.
+      #
+      # @return [Hash] A hash where keys are parent field names and values are hashes of bit field details
+      #
+      # @example Get detailed bit field layout 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_layout
+      #   # => {
+      #   #      :value => {
+      #   #        :read    => { :start => 0, :width => 1 },
+      #   #        :write   => { :start => 1, :width => 1 },
+      #   #        :execute => { :start => 2, :width => 1 },
+      #   #        :unused  => { :start => 3, :width => 5 }
+      #   #      }
+      #   #    }
+      def bit_field_layout
+        return {} unless instance_variable_defined?(:@bit_field_hash_table)
+
+        result = {}
+        @bit_field_hash_table.each do |field_name, info|
+          parent_name, start, width = info
+          result[parent_name] ||= {}
+          result[parent_name][field_name] = { start: start, width: width }
+        end
+        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/version.rb

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

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - kojix2
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -42,6 +43,7 @@ homepage: https://github.com/kojix2/ffi-bitfield
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,7 +58,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: bit fields for Ruby-FFI
 test_files: []