ffi-bitfield 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d75494c09a1b688169fd2630a7ea299a5c58ad312f9ae369a4c0c11165c46e6
-  data.tar.gz: 60840b874151b38faa6ef56cf6f7f6f179cf2415053edce96f08f32e82874ceb
+  metadata.gz: 811ea7a9da659976db52363a7e2702e0b377ab4881393e0559cd6aa5cab91117
+  data.tar.gz: d9ba1cb6673e6e332a85050479c9e7307870a5dfa26bddf22ff0aeb313428f38
 SHA512:
-  metadata.gz: 6d1d86bda1e5c71a59bc801eb35ee64522bc5d6bd49452afd01583240d4358d370fadc5b3bfa6c619ebb3b65c3cc116d14e149cce2c8977f923365708a8d20bb
-  data.tar.gz: 6c7642a18712a0959273d6a46a5c46b3f6c2bd1b0861cace828f9d6fb717aa76ab3643dc9af509c5478e80e05371609a9a5f871132016f9767b50cb77985c794
+  metadata.gz: 78437889463ee5752ad5a11969407fd63ba2feaa8687054334e90d5ae040bcd70d85bc6580c6328ff5261c147c36700c3fced1980184cf7f8432f9592420f104
+  data.tar.gz: ee046b7f0c9712fd2463be46e62d96e4a75dda6c966d8ab722d344bd8c3396f7f1d77eb3a6fe3181dd9b7f70e286f22adad63b5e493b384729e013f51b12dda4

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
@@ -75,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

@@ -5,6 +5,7 @@ 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

@@ -2,19 +2,22 @@
 
 module FFI
   module BitField
+    # Layout provides the `bit_fields` method for registering field members.
     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.
+      # @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 = args.shift
+        parent_name = layout_args.shift.to_sym
         member_names = []
         widths = []
-        args.each_slice(2) do |name, width|
-          member_names << name
-          widths << width
+        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)
@@ -22,6 +25,8 @@ module FFI
         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

data/lib/ffi/bit_field/property.rb

@@ -2,17 +2,41 @@
 
 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)
-        bit_fields = self.class.instance_variable_get(:@bit_field_hash_table)
-        parent_name, start, width = bit_fields[member_name]
+        parent_name, start, width = member_value_info(member_name)
         if parent_name
           value = get_member_value(parent_name)
-          (value >> start) & ((1 << width) - 1)
+          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 #{(1 << width) - 1}" if value.bit_length > width
+
+          parent_value = get_member_value(parent_name)
+          all = ((1 << parent_value.bit_length) - 1)
+          mask = all ^ (((1 << width) - 1) << start)
+          masked_value = parent_value & mask
+          new_value = masked_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

@@ -2,6 +2,6 @@
 
 module FFI
   module BitField
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

data/lib/ffi/bit_struct.rb

@@ -6,9 +6,11 @@ require_relative 'bit_field/layout'
 require_relative 'bit_field/property'
 
 module FFI
+  # Subclass of FFI::Struct that support bit fields.
   class BitStruct < Struct
     # [] 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

data/lib/ffi/managed_bit_struct.rb

@@ -6,9 +6,11 @@ require_relative 'bit_field/layout'
 require_relative 'bit_field/property'
 
 module FFI
+  # Subclass of FFI::ManagedStruct that support bit fields.
   class ManagedBitStruct < ManagedStruct
     # [] 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffi-bitfield
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - kojix2