ffi-bitfield 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8718e2b995e05ebbbfc068b45acef79a24b371905ec0afc4fe828d608f56a32
+  data.tar.gz: e303e6e22a0927d312934fd9085f6b4e7a19ee10361fafe90c465462d8b1de9d
+SHA512:
+  metadata.gz: 54b27c548d1f4d1ec0373f7f0d60a6079b9b3c471be0e773aabe8d5c8dfabee6cdaaa6a2a8982fdec4b3d34cc301817b329e32d734187c1b8bb8dfa44cd427cd
+  data.tar.gz: 163eb57089a2b6f88ada99a2ff9909a7c7bf34dc1bf56afa1665441de7232117df779107250ea66086024689a32c5fabb8e611c8d53af53552208f6cac9818bb

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 kojix2
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# ffi-bitfield
+
+[![Gem Version](https://badge.fury.io/rb/ffi-bitfield.svg)](https://badge.fury.io/rb/ffi-bitfield)
+[![test](https://github.com/kojix2/ffi-bitfield/actions/workflows/ci.yml/badge.svg)](https://github.com/kojix2/ffi-bitfield/actions/workflows/ci.yml)
+
+Bit field for [Ruby-FFI](https://github.com/ffi/ffi)
+
+:construction: alpha　ー Supports reading bit fields only.
+
+## Installation
+
+```sh
+gem install ffi-bitfield
+```
+
+## Usage
+
+```ruby
+require 'ffi/bit_struct'
+
+class Struct1 < FFI::BitStruct
+  layout \
+    :a, :uint8,
+    :b, :uint8
+
+  bit_fields :a,
+    :u, 2,
+    :v, 2,
+    :w, 1,
+    :x, 1,
+    :y, 1,
+    :z, 1
+end
+
+s = Struct1.new
+s[:a] = 63
+
+p s[:u] # 3
+p s[:v] # 3
+p s[:w] # 1
+p s[:x] # 1
+p s[:y] # 0
+p s[:z] # 0
+```
+
+### Loading
+
+```ruby
+require 'ffi/bit_field'
+```
+
+The above is the same as below.
+
+```ruby
+require 'ffi/bit_struct'
+require 'ffi/managed_bit_struct'
+```
+
+## API Overview
+
+```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
+
+```
+git clone https://github.com/kojix2/ffi-bitfield
+cd ffi-bitfield
+bundle install
+bundle exec rake test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kojix2/bitstruct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ffi/bit_field.rb

@@ -0,0 +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
+  module BitField
+  end
+end

data/lib/ffi/bit_field/bit_field_supporter.rb

@@ -0,0 +1,44 @@
+# 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

data/lib/ffi/bit_field/version.rb

@@ -0,0 +1,5 @@
+module FFI
+  module BitField
+    VERSION="0.0.2"
+  end
+end

data/lib/ffi/bit_struct.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require_relative 'bit_field/version'
+require_relative 'bit_field/bit_field_supporter'
+
+module FFI
+  class BitStruct < Struct
+    extend BitField::BitFiledSupporter
+  end
+end

data/lib/ffi/managed_bit_struct.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require_relative 'bit_struct/version'
+require_relative 'bit_field_supporter'
+
+module FFI
+  class ManagedBitStruct < ManagedStruct
+    extend BitFiledSupporter
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: ffi-bitfield
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- kojix2
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: bit fields for Ruby-FFI
+email:
+- 2xijok@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/ffi/bit_field.rb
+- lib/ffi/bit_field/bit_field_supporter.rb
+- lib/ffi/bit_field/version.rb
+- lib/ffi/bit_struct.rb
+- lib/ffi/managed_bit_struct.rb
+homepage: https://github.com/kojix2/ffi-bitfield
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: bit fields for Ruby-FFI
+test_files: []