libbin 1.0.5 → 2.0.0

data/lib/libbin.rb

@@ -1,391 +1,113 @@
-module LibBin
-end
 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
+  @big = [0x12345678].pack("i") == "\x12\x34\x56\x78"
+  @output = $stderr
 
-  def self.default_big?
-    if @__big.nil?
-      @__big_architecture
-    else
-      @__big
-    end
+  class << self
+    attr_accessor :big
+    attr_accessor :output
   end
 
-  class DataConverter
-    include Alignment
+  # Returns true the default endianness is big
+  def self.default_big?
+    @big
+  end
 
+  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
 
-    attr_reader :__parent
-    attr_reader :__index
-    attr_reader :__iterator
-    attr_reader :__position
-    def __set_convert_type(input, output, input_big, output_big, parent, index)
-      @__input_big = input_big
-      @__output_big = output_big
-      @__input = input
-      @__output = output
-      @__parent = parent
-      @__index = index
-      @__position = input.tell
-      @__cur_position = @__position
-    end
-
-    def __set_size_type(position, parent, index)
-      @__parent = parent
-      @__index = index
-      @__position = position
-      @__cur_position = @__position
-    end
-
-    def __set_load_type(input, input_big, parent, index)
-      @__input_big = input_big
-      @__input = input
-      @__parent = parent
-      @__index = index
-      @__position = input.tell
-      @__cur_position = @__position
-    end
-
-    def __set_dump_type(output, output_big, parent, index)
-      @__output_big = output_big
-      @__output = output
-      @__parent = parent
-      @__index = index
-      @__position = output.tell
-      @__cur_position = @__position
-    end
-
-    def __unset_convert_type
-      @__input_big = nil
-      @__output_big = nil
-      @__input = nil
-      @__output = nil
-      @__parent = nil
-      @__index = nil
-      @__position = nil
-      @__cur_position = nil
-    end
-
-    def __unset_size_type
-      @__parent = nil
-      @__index = nil
-      @__position = nil
-      @__cur_position = nil
-    end
-
-    def __unset_load_type
-      @__input_big = nil
-      @__input = nil
-      @__parent = nil
-      @__index = nil
-      @__position = nil
-      @__cur_position = nil
-    end
-
-    def __unset_dump_type
-      @__output_big = nil
-      @__output = nil
-      @__parent = nil
-      @__index = nil
-      @__position = nil
-      @__cur_position = nil
-    end
-
+    # @!visibility private
     def self.inherited(subclass)
       subclass.instance_variable_set(:@fields, [])
     end
 
-    def __decode_expression(sym)
-      case sym
-      when Proc
-        return sym.call
-      when String
-        exp = sym.gsub("..","__parent").gsub("\\",".")
-        return eval(exp)
-      else
-        return sym
-      end
-    end
-
-    def __decode_seek_offset(offset, relative_offset)
-      return nil unless offset
-      offset = __decode_expression(offset)
-      return false if offset == 0x0
-      offset += @__position if relative_offset
-      @__cur_position = offset
-      @__input.seek(offset) if @__input
-      @__output.seek(offset) if @__output
-      offset
-    end
-
-    def __decode_condition(condition)
-      return true unless condition
-      __decode_expression(condition)
-    end
-
-    def __decode_count(count)
-      return 1 unless count
-      __decode_expression(count)
-    end
-
-    def __decode_type(type)
-      return __decode_expression(type)
-    end
-
-    def __decode_length(length)
-      __decode_expression(length)
-    end
-
-    def __decode_static_conditions(field)
-      @__offset = nil
-      @__condition = nil
-      @__type = nil
-      @__length = nil
-      @__count = nil
-      unless field.sequence?
-        @__offset = __decode_seek_offset(field.offset, field.relative_offset?)
-        throw :ignored, nil if @__offset == false
-        @__condition = __decode_condition(field.condition)
-        throw :ignored, nil unless @__condition
-        @__type = __decode_type(field.type)
-        @__length = __decode_length(field.length)
-      end
-      @__count = __decode_count(field.count)
-    end
-
-    def __decode_dynamic_conditions(field)
-      return true unless field.sequence?
-      @__offset = nil
-      @__condition = nil
-      @__type = nil
-      @__length = nil
-      @__offset = __decode_seek_offset(field.offset, field.relative_offset?)
-      return false if @__offset == false
-      @__condition = __decode_condition(field.condition)
-      return false unless @__condition
-      @__type = __decode_type(field.type)
-      @__length = __decode_length(field.length)
-      return true
+    # 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
 
-    def __restore_context
-      @__iterator = nil
-      @__type = nil
-      @__length = nil
-      @__count = nil
-      @__offset = nil
-      @__condition = nil
+    # 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
 
-    def __convert_field(field)
-      __decode_static_conditions(field)
-      vs = @__count.times.collect do |it|
-        @__iterator = it
-        if __decode_dynamic_conditions(field)
-          @__type::convert(@__input, @__output, @__input_big, @__output_big, self, it, @__length)
-        else
-          nil
-        end
-      end
-      __restore_context
-      vs = vs.first unless field.count
-      vs
-    end
-
-    def __load_field(field)
-      __decode_static_conditions(field)
-      vs = @__count.times.collect do |it|
-        @__iterator = it
-        if __decode_dynamic_conditions(field)
-          @__type::load(@__input, @__input_big, self, it, @__length)
-        else
-          nil
-        end
-      end
-      __restore_context
-      vs = vs.first unless field.count
-      vs
-    end
-
-    def __dump_field(vs, field)
-      __decode_static_conditions(field)
-      vs = [vs] unless field.count
-      vs.each_with_index do |v, it|
-        @__iterator = it
-        if __decode_dynamic_conditions(field)
-          @__type::dump(v, @__output, @__output_big, self, it, @__length)
-        end
-      end
-      __restore_context
-    end
-
-    def __shape_field(vs, previous_offset, kind, field)
-      __decode_static_conditions(field)
-      vs = [vs] unless field.count
-      vs = vs.each_with_index.collect do |v, it|
-        @__iterator = it
-        if __decode_dynamic_conditions(field)
-          sh = @__type::shape(v, @__cur_position, self, it, kind, @__length)
-          @__cur_position = sh.last + 1 if sh.last && sh.last >= 0
-          sh
-        end
-      end
-      __restore_context
-      vs = vs.first unless field.count
-      vs
-    end
-
-    def __size(previous_offset = 0, parent = nil, index = nil)
-      __shape(previous_offset, parent, index, DataRange).size
-    end
-
-    def __shape(previous_offset = 0, parent = nil, index = nil, kind = DataShape)
-      __set_size_type(previous_offset, parent, index)
-      members = {}
-      self.class.instance_variable_get(:@fields).each { |field|
-        begin
-          vs = send(field.name)
-          member = catch(:ignored) do
-            __shape_field(vs, previous_offset, kind, field)
-          end
-          members[field.name] = member
-        rescue
-          STDERR.puts "#{self.class}: #{field.name}(#{field.type})"
-          raise
-        end
-      }
-      __unset_size_type
-      return nil if members.values.flatten.compact.size <= 0
-      kind::new(members)
-    end
-
-    def __convert_fields
-      self.class.instance_variable_get(:@fields).each { |field|
-        begin
-          vs = catch(:ignored) do
-            __convert_field(field)
-          end
-          send("#{field.name}=", vs)
-        rescue
-          STDERR.puts "#{self.class}: #{field.name}(#{field.type})"
-          raise
-        end
-      }
-      self
-    end
-
-    def __load_fields
-      self.class.instance_variable_get(:@fields).each { |field|
-        begin
-          vs = catch(:ignored) do
-            __load_field(field)
-          end
-          send("#{field.name}=", vs)
-        rescue
-          STDERR.puts "#{self.class}: #{field.name}(#{field.type})"
-          raise
-        end
-      }
-      self
-    end
-
-    def __dump_fields
-      self.class.instance_variable_get(:@fields).each { |field|
-        begin
-          vs = send(field.name)
-          catch(:ignored) do
-            __dump_field(vs, field)
-          end
-        rescue
-          STDERR.puts "#{self.class}: #{field.name}(#{field.type})"
-          raise
-        end
-      }
-      self
-    end
-
-    def __convert(input, output, input_big, output_big, parent = nil, index = nil)
-      __set_convert_type(input, output, input_big, output_big, parent, index)
-      __convert_fields
-      __unset_convert_type
-      self
-    end
-
-    def __load(input, input_big, parent = nil, index = nil)
-      __set_load_type(input, input_big, parent, index)
-      __load_fields
-      __unset_load_type
-      self
-    end
-
-    def __dump(output, output_big, parent = nil, index = nil)
-      __set_dump_type(output, output_big, parent, index)
-      __dump_fields
-      __unset_dump_type
-      self
-    end
-      
-    def self.convert(input, output, input_big = LibBin::default_big?, output_big = !LibBin::default_big?, parent = nil, index = nil, length = nil)
-      if length
-        length.times.collect {
-          h = self::new
-          h.__load(input, input_big, parent, index)
-        }
+    # 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
-        h = self::new
-        h.__convert(input, output, input_big, output_big, parent, index)
+        raise "alignement must be a power of 2" if align && (align - 1) & align != 0
+        @always_align = align
       end
+      align
     end
 
-    def self.load(input, input_big = LibBin::default_big?, parent = nil, index = nil, length = nil)
-      if length
-        length.times.collect {
-          h = self::new
-          h.__load(input, input_big, parent, index)
-        }
-      else
-        h = self::new
-        h.__load(input, input_big, parent, index)
-      end
+    class << self
+      alias always_align= set_always_align
+      attr_reader :always_align
+      attr_reader :fields
     end
 
-    def self.dump(value, output, output_big = LibBin::default_big?, 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
-        length.times.collect { |i|
-          value[i].__dump(output, output_big, parent, index)
-        }
-        value
+        shape(value, offset, parent, index, length).size
       else
-        value.__dump(output, output_big, parent, index)
+        value.__shape(offset, parent, index).size
       end
     end
 
-    def self.size(value, previous_offset = 0, parent = nil, index = nil, length = nil)
-      if length
-        shape(value, previous_offset, parent, index, length).size
-      else
-        value.__shape(previous_offset, parent, index).size
-      end
-    end
-
-    def self.shape(value, previous_offset = 0, parent = nil, index = nil, kind = DataShape, length = nil)
-      if length
-        kind::new(length.times.collect { |i|
-          value[i].__shape(previous_offset, parent, index, kind)
-        })
-      else
-        value.__shape(previous_offset, parent, index, kind)
-      end
+    # Return the structure class fields
+    # @return [Array<Field>]
+    def __fields
+      return self.class.fields
     end
 
   end

data/libbin.gemspec

@@ -1,14 +1,13 @@
 Gem::Specification.new do |s|
   s.name = 'libbin'
-  s.version = "1.0.5"
+  s.version = "2.0.0"
   s.author = "Brice Videau"
-  s.email = "brice.videau@imag.fr"
+  s.email = "brice.videau@gmail.com"
   s.homepage = "https://github.com/kerilk/libbin"
   s.summary = "Library for loading and converting binary files"
   s.description = "Read, write and convert Binary data in Ruby."
   s.files =  Dir[ 'libbin.gemspec', 'LICENSE', 'lib/**/*.rb', 'ext/libbin/extconf.rb', 'ext/libbin/*.c', 'ext/libbin/*.h' ]
   s.extensions << 'ext/libbin/extconf.rb'
-  s.has_rdoc = false
   s.license = 'BSD-2-Clause'
   s.required_ruby_version = '>= 2.0.0'
   s.add_dependency 'float-formats', '~> 0.3', '>=0.3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libbin
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - Brice Videau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2021-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: float-formats
@@ -31,21 +31,24 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.0
 description: Read, write and convert Binary data in Ruby.
-email: brice.videau@imag.fr
+email: brice.videau@gmail.com
 executables: []
 extensions:
 - ext/libbin/extconf.rb
 extra_rdoc_files: []
 files:
 - LICENSE
+- ext/libbin/data_types.c
+- ext/libbin/data_types.h
 - ext/libbin/extconf.rb
 - ext/libbin/half.c
 - ext/libbin/half.h
 - ext/libbin/libbin_c.c
+- ext/libbin/libbin_c.h
+- ext/libbin/libbin_endian.h
 - 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
@@ -67,8 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Library for loading and converting binary files

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