libbin 1.0.8 → 2.0.0

data/lib/libbin.rb

@@ -1,49 +1,115 @@
 require "libbin_c.so"
 
-require_relative 'libbin/alignment'
 require_relative 'libbin/data_types'
 
+# Container module, handles the global state default endianness and error output.
 module LibBin
 
-  BIG_ARCHITECTURE = [0x12345678].pack("i") == "\x12\x34\x56\x78"
-  @__big = nil
-  @__output = $stderr
+  @big = [0x12345678].pack("i") == "\x12\x34\x56\x78"
+  @output = $stderr
 
   class << self
-    attr_accessor :__output
+    attr_accessor :big
+    attr_accessor :output
   end
 
+  # Returns true the default endianness is big
   def self.default_big?
-    if @__big.nil?
-      BIG_ARCHITECTURE
-    else
-      @__big
-    end
+    @big
   end
 
-  class DataConverter
-    include Alignment
+  class Structure
+
+    # @!parse
+    #   attr_accessor :__parent
+    #   attr_accessor :__index
+    #   attr_accessor :__position
+    #   attr_accessor :__cur_position
+    #   attr_accessor :__input
+    #   attr_accessor :__output
+    #   attr_accessor :__input_big
+    #   attr_accessor :__output_big
+    #
+    #   attr_accessor :__offset
+    #   attr_accessor :__condition
+    #   attr_accessor :__type
+    #   attr_accessor :__length
+    #   attr_accessor :__count
+    #   attr_accessor :__iterator
+    #   attr_accessor :__value
+    #
+    #   # @method __dump_fields
+    #   # Dump fields according to the internal state of +self+
+    #   # @return [Structure] self
 
+    # @!visibility private
     def inspect
       to_s
     end
 
+    # @!visibility private
     def self.inherited(subclass)
       subclass.instance_variable_set(:@fields, [])
     end
 
-    def __size(previous_offset = 0, parent = nil, index = nil)
-      __shape(previous_offset, parent, index, DataRange).size
+    # Returns the size of the structure
+    # @param offset [Integer] position in the stream
+    # @param parent [Structure] if given, parent structure
+    # @param index [Integer] index if part of a repeated field inside parent
+    # @return [Integer] size of the structure
+    def __size(offset = 0, parent = nil, index = nil)
+      __shape(offset, parent, index, DataRange).size
+    end
+
+    # Returns the alignement of the structure
+    # @return [Integer] alignment of the structure
+    def self.align
+      return @always_align if @always_align
+      align = @fields.collect(&:align).select { |v| v }.max
+      align = 0 unless align
+      align
+    end
+
+    # Set the structure as needing to always be aligned
+    # @param align [true, Integer] if true use the fields' maximum alignment
+    # @return align
+    def self.set_always_align(align)
+      if align == true
+        @always_align = @fields.collect(&:align).select { |v| v }.max
+        @always_align = 0 unless align
+      else
+        raise "alignement must be a power of 2" if align && (align - 1) & align != 0
+        @always_align = align
+      end
+      align
+    end
+
+    class << self
+      alias always_align= set_always_align
+      attr_reader :always_align
+      attr_reader :fields
     end
 
-    def self.size(value, previous_offset = 0, parent = nil, index = nil, length = nil)
+    # Returns the size of a structure
+    # @param value [Structure,Array<Structure>] field or array of field to get the size of
+    # @param offset [Integer] position in the stream
+    # @param parent [Structure] if given, parent structure
+    # @param index [Integer] index if part of a repeated field inside parent
+    # @param length [Integer] if given, the length of the vector
+    def self.size(value, offset = 0, parent = nil, index = nil, length = nil)
       if length
-        shape(value, previous_offset, parent, index, length).size
+        shape(value, offset, parent, index, length).size
       else
-        value.__shape(previous_offset, parent, index).size
+        value.__shape(offset, parent, index).size
       end
     end
 
+    # Return the structure class fields
+    # @return [Array<Field>]
+    def __fields
+      return self.class.fields
+    end
+
   end
 
 end

data/libbin.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'libbin'
-  s.version = "1.0.8"
+  s.version = "2.0.0"
   s.author = "Brice Videau"
   s.email = "brice.videau@gmail.com"
   s.homepage = "https://github.com/kerilk/libbin"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libbin
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.0
 platform: ruby
 authors:
 - Brice Videau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: float-formats
@@ -49,7 +49,6 @@ files:
 - ext/libbin/pghalf.c
 - ext/libbin/pghalf.h
 - lib/libbin.rb
-- lib/libbin/alignment.rb
 - lib/libbin/data_types.rb
 - libbin.gemspec
 homepage: https://github.com/kerilk/libbin

data/lib/libbin/alignment.rb

@@ -1,14 +0,0 @@
-module LibBin
-
-  module Alignment
-
-    def align(val, alignment)
-      remainder = val % alignment
-      val += alignment - remainder if remainder > 0
-      val
-    end
-    private :align
-
-  end
-
-end