kaitai-struct 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b07542b0b53559b463ae219d91b5132ae32443f1
+  data.tar.gz: 70117ba80efbb033f7ab465e4226b42a3c4eb238
+SHA512:
+  metadata.gz: 902540aad3e004cfae1a1771b462c85bbfdcdc87d0dbbe2b05d3d08fd5277d2d539eb0ed0c8cf788eac4f44afda293af5b6a624f3d47161100f67ba01343716c
+  data.tar.gz: 25fb636cef7318d76d5139e255b81a9ee4caa78f9a4b440bb4dda437e05720ca0d919bc6bcc97ea93c31952dd3447989e0cc3af72357e8fc5c6bf0e3da8f205b

data/.gitignore

@@ -0,0 +1 @@
+/test/compiled

data/README.md

@@ -0,0 +1,65 @@
+# Kaitai Struct: runtime library for Ruby
+
+This library implements Kaitai Struct API for Ruby.
+
+Kaitai Struct is a declarative language used for describe various binary
+data structures, laid out in files or in memory: i.e. binary file
+formats, network stream packet formats, etc.
+
+Further reading:
+
+* [About Kaitai Struct](https://github.com/kaitai-io/kaitai_struct/)
+* [About API implemented in this library](https://github.com/kaitai-io/kaitai_struct/wiki/Kaitai-Struct-stream-API)
+* [Ruby-specific notes](https://github.com/kaitai-io/kaitai_struct/wiki/Ruby)
+
+## Installing
+
+### Using `Gemfile`
+
+If your project uses Bundler, just include the line
+
+```
+gem 'kaitai-struct'
+```
+
+in your project's `Gemfile`.
+
+### Using `gem install`
+
+If you have a RubyGems package manager installed, you can use command
+
+```
+gem install kaitai-struct
+```
+
+to install this runtime library.
+
+### Manually
+
+This library is intentionally kept as very simple, one-file `.rb`
+file. One can just copy it to your project from this
+repository. Usually you won't `require` it directly, it will be loaded
+by Ruby source code generate by Kaitai Struct compiler.
+
+## Licensing
+
+Copyright 2015-2016 Kaitai Project: MIT license
+
+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/kaitai-struct.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/kaitai/struct/struct", __FILE__)
+require 'date'
+
+Gem::Specification.new { |s|
+  s.name = 'kaitai-struct'
+  s.version = Kaitai::Struct::VERSION
+  s.date = Date.today.to_s
+
+  s.authors = ['Mikhail Yakshin']
+  s.email = 'greycat@kaitai.io'
+
+  s.homepage = 'http://kaitai.io'
+  s.summary = 'Kaitai Struct: runtime library for Ruby'
+  s.license = 'MIT'
+  s.description = <<-EOF
+Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.
+
+The main idea is that a particular format is described in Kaitai Struct language (.ksy file) and then can be compiled with ksc into source files in one of the supported programming languages. These modules will include a generated code for a parser that can read described data structure from a file / stream and give access to it in a nice, easy-to-comprehend API.
+
+This package provides small runtime library used by code generated by Kaitai Struct compiler.
+EOF
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ['lib']
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+}

data/lib/kaitai/struct/struct.rb

@@ -0,0 +1,237 @@
+require 'stringio'
+
+module Kaitai
+module Struct
+
+VERSION = '0.3'
+
+class Struct
+
+  def initialize(_io, _parent = nil, _root = self)
+    @_io = _io
+    @_parent = _parent
+    @_root = _root
+  end
+
+  def self.from_file(filename)
+    self.new(Stream.open(filename))
+  end
+
+  attr_reader :_io
+end
+
+class Stream
+  class UnexpectedDataError < Exception
+    def initialize(actual, expected)
+      super("Unexpected fixed contents: got #{Stream.format_hex(actual)}, was waiting for #{Stream.format_hex(expected)}")
+      @actual = actual
+      @expected = expected
+    end
+  end
+
+  def initialize(arg)
+    if arg.is_a?(String)
+      @_io = StringIO.new(arg)
+    elsif arg.is_a?(IO)
+      @_io = arg
+    else
+      raise TypeError.new('can be initialized with IO or String only')
+    end
+  end
+
+  def self.open(filename)
+    self.new(File.open(filename, 'rb:ASCII-8BIT'))
+  end
+
+  # ========================================================================
+  # Forwarding of IO API calls
+  # ========================================================================
+
+  def eof?; @_io.eof?; end
+  def seek(x); @_io.seek(x); end
+  def pos; @_io.pos; end
+
+  # Test endianness of the platform
+  @@big_endian = [0x0102].pack('s') == [0x0102].pack('n')
+
+  def ensure_fixed_contents(size, expected)
+    buf = @_io.read(size)
+    actual = buf.bytes
+    if actual != expected
+      raise UnexpectedDataError.new(actual, expected)
+    end
+    buf
+  end
+
+  # ========================================================================
+  # Unsigned
+  # ========================================================================
+
+  def read_u1
+    read_bytes(1).unpack('C')[0]
+  end
+
+  def read_u2le
+    read_bytes(2).unpack('v')[0]
+  end
+
+  def read_u4le
+    read_bytes(4).unpack('V')[0]
+  end
+
+  unless @@big_endian
+    def read_u8le
+      read_bytes(8).unpack('Q')[0]
+    end
+  else
+    def read_u8le
+      a, b = read_bytes(8).unpack('VV')
+      (b << 32) + a
+    end
+  end
+
+  def read_u2be
+    read_bytes(2).unpack('n')[0]
+  end
+
+  def read_u4be
+    read_bytes(4).unpack('N')[0]
+  end
+
+  if @@big_endian
+    def read_u8be
+      read_bytes(8).unpack('Q')[0]
+    end
+  else
+    def read_u8be
+      a, b = read_bytes(8).unpack('NN')
+      (a << 32) + b
+    end
+  end
+
+  # ========================================================================
+  # Signed
+  # ========================================================================
+
+  def read_s1
+    read_bytes(1).unpack('c')[0]
+  end
+
+  def read_s2le
+    to_signed(read_u2le, SIGN_MASK_16)
+  end
+
+  def read_s4le
+    to_signed(read_u4le, SIGN_MASK_32)
+  end
+
+  unless @@big_endian
+    def read_s8le
+      read_bytes(8).unpack('q')[0]
+    end
+  else
+    def read_s8le
+      to_signed(read_u8le, SIGN_MASK_64)
+    end
+  end
+
+  def read_s2be
+    to_signed(read_u2be, SIGN_MASK_16)
+  end
+
+  def read_s4be
+    to_signed(read_u4be, SIGN_MASK_32)
+  end
+
+  if @@big_endian
+    def read_s8be
+      read_bytes(8).unpack('q')[0]
+    end
+  else
+    def read_s8be
+      to_signed(read_u8be, SIGN_MASK_64)
+    end
+  end
+
+  # ========================================================================
+
+  def read_bytes_full
+    @_io.read
+  end
+
+  def read_bytes(n)
+    r = @_io.read(n)
+    if r
+      rl = r.bytesize
+    else
+      rl = 0
+    end
+    raise EOFError.new("attempted to read #{n} bytes, got only #{rl}") if rl < n
+    r
+  end
+
+  # ========================================================================
+
+  def read_str_eos(encoding)
+    read_bytes_full.force_encoding(encoding)
+  end
+
+  def read_str_byte_limit(byte_size, encoding)
+    read_bytes(byte_size).force_encoding(encoding)
+  end
+
+  def read_strz(encoding, term, include_term, consume_term, eos_error)
+    r = ''
+    loop {
+      if @_io.eof?
+        if eos_error
+          raise EOFError.new("end of stream reached, but no terminator #{term} found")
+        else
+          return r.force_encoding(encoding)
+        end
+      end
+      c = @_io.getc
+      if c.ord == term
+        r << c if include_term
+        @_io.seek(@_io.pos - 1) unless consume_term
+        return r.force_encoding(encoding)
+      end
+      r << c
+    }
+  end
+
+  # ========================================================================
+
+  def process_rotate_left(data, amount, group_size)
+    raise NotImplementedError.new("unable to rotate group #{group_size} bytes yet") unless group_size == 1
+
+    mask = group_size * 8 - 1
+    anti_amount = -amount & mask
+
+    # NB: actually, left bit shift (<<) in Ruby would have required
+    # truncation to type_bits size (i.e. something like "& 0xff" for
+    # group_size == 8), but we can skip this one, because later these
+    # number would be packed with Array#pack, which will do truncation
+    # anyway
+
+    data.bytes.map { |x| (x << amount) | (x >> anti_amount) }.pack('C*')
+  end
+
+  # ========================================================================
+
+  private
+  SIGN_MASK_16 = (1 << (16 - 1))
+  SIGN_MASK_32 = (1 << (32 - 1))
+  SIGN_MASK_64 = (1 << (64 - 1))
+
+  def to_signed(x, mask)
+    (x & ~mask) - (x & mask)
+  end
+
+  def self.format_hex(arr)
+    arr.map { |x| sprintf('%02X', x) }.join(' ')
+  end
+end
+
+end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: kaitai-struct
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Mikhail Yakshin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-19 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Kaitai Struct is a declarative language used for describe various binary data structures, laid out in files or in memory: i.e. binary file formats, network stream packet formats, etc.
+
+  The main idea is that a particular format is described in Kaitai Struct language (.ksy file) and then can be compiled with ksc into source files in one of the supported programming languages. These modules will include a generated code for a parser that can read described data structure from a file / stream and give access to it in a nice, easy-to-comprehend API.
+
+  This package provides small runtime library used by code generated by Kaitai Struct compiler.
+email: greycat@kaitai.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- kaitai-struct.gemspec
+- lib/kaitai/struct/struct.rb
+homepage: http://kaitai.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: 'Kaitai Struct: runtime library for Ruby'
+test_files: []