kaitai-struct 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb2b4ae17b2b8d26cecfe15e7e9ec6855be0d6f9
-  data.tar.gz: 9a1b9b1339dacda683de54c419522f093f7694e2
+  metadata.gz: f864fb7a549cb0ffb83d39e1e1a8f3e58feba59b
+  data.tar.gz: f398b795f794ac82e4ab78838dc4f7eb1f773cbe
 SHA512:
-  metadata.gz: b93c930991c6978f41f16d74d0c273fba39142df82ef78a51497785b8fdee61e921a01d5e02e75373cde64556649c6e623897170fb5b6da9422e2a23ab54bfdd
-  data.tar.gz: 592c8dff971cd6d44ff65102f900b8a02c7f32982a1fd2576ab9ab68f64a9a4192c7bc98387dfa19b69acd32c43cbea2be7eb0309710bf667d1d42c681d915f6
+  metadata.gz: 9682c42a2b4636b58255f6b0ed111ba399e182e34269515707471206ae217bd72e26c336749b7737a3c5fa6a9b48eb640cfe0a21bfb4db464420797ef3dce7fb
+  data.tar.gz: 1d6cf8627185ada694d03f2303259f21341f34e4091197907bcc9397b703dc7ba232c7fa36d5bd1244f707ba0dcb2ce1a7a690df65fa8a8fe599ffd5814d6510

data/README.md

@@ -8,9 +8,8 @@ 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)
+* [About Kaitai Struct](http://kaitai.io/)
+* [About API implemented in this library](http://doc.kaitai.io/stream_api.html)
 
 ## Installing
 
@@ -43,7 +42,7 @@ by Ruby source code generate by Kaitai Struct compiler.
 
 ## Licensing
 
-Copyright 2015-2016 Kaitai Project: MIT license
+Copyright 2015-2017 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

data/lib/kaitai/struct/struct.rb

@@ -3,7 +3,7 @@ require 'stringio'
 module Kaitai
 module Struct
 
-VERSION = '0.6'
+VERSION = '0.7'
 
 ##
 # Common base class for all structured generated by Kaitai Struct.
@@ -113,9 +113,7 @@ class Stream
   # Test endianness of the platform
   @@big_endian = [0x0102].pack('s') == [0x0102].pack('n')
 
-  # ========================================================================
-  # Stream positioning
-  # ========================================================================
+  # @!group Stream positioning
 
   ##
   # Check if stream pointer is at the end of stream.
@@ -137,9 +135,9 @@ class Stream
   # @return [Fixnum] size of the stream in bytes
   def size; @_io.size; end
 
-  # ========================================================================
-  # Integer numbers
-  # ========================================================================
+  # @!endgroup
+
+  # @!group Integer numbers
 
   # ------------------------------------------------------------------------
   # Signed
@@ -247,9 +245,9 @@ class Stream
     end
   end
 
-  # ========================================================================
-  # Floating point numbers
-  # ========================================================================
+  # @!endgroup
+
+  # @!group Floating point numbers
 
   # ------------------------------------------------------------------------
   # Big-endian
@@ -275,9 +273,9 @@ class Stream
     read_bytes(8).unpack('E')[0]
   end
 
-  # ========================================================================
-  # Unaligned bit values
-  # ========================================================================
+  # @!endgroup
+
+  # @!group Unaligned bit values
 
   def align_to_byte
     @bits_left = 0
@@ -314,9 +312,9 @@ class Stream
     res
   end
 
-  # ========================================================================
-  # Byte arrays
-  # ========================================================================
+  # @!endgroup
+
+  # @!group Byte arrays
 
   ##
   # Reads designated number of bytes from the stream.
@@ -342,6 +340,26 @@ class Stream
     @_io.read
   end
 
+  def read_bytes_term(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
+        end
+      end
+      c = @_io.getc
+      if c.ord == term
+        r << c if include_term
+        @_io.seek(@_io.pos - 1) unless consume_term
+        return r
+      end
+      r << c
+    }
+  end
+
   ##
   # Reads next len bytes from the stream and ensures that they match
   # expected fixed byte array. If they differ, throws a
@@ -357,41 +375,27 @@ class Stream
     actual
   end
 
-  # ========================================================================
-  # Strings
-  # ========================================================================
-
-  def read_str_eos(encoding)
-    read_bytes_full.force_encoding(encoding)
+  def self.bytes_strip_right(bytes, pad_byte)
+    new_len = bytes.length
+    while bytes.getbyte(new_len - 1) == pad_byte
+      new_len -= 1
+    end
+    bytes[0, new_len]
   end
 
-  def read_str_byte_limit(byte_size, encoding)
-    read_bytes(byte_size).force_encoding(encoding)
+  def self.bytes_terminate(bytes, term, include_term)
+    new_len = 0
+    max_len = bytes.length
+    while bytes.getbyte(new_len) != term and new_len < max_len
+      new_len += 1
+    end
+    new_len += 1 if include_term and new_len < max_len
+    bytes[0, new_len]
   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
+  # @!endgroup
 
-  # ========================================================================
-  # Byte array processing
-  # ========================================================================
+  # @!group Byte array processing
 
   ##
   # Performs a XOR processing with given data, XORing every byte of
@@ -461,7 +465,7 @@ class Stream
     data.bytes.map { |x| (x << amount) | (x >> anti_amount) }.pack('C*')
   end
 
-  # ========================================================================
+  # @!endgroup
 
   ##
   # Resolves value using enum: if the value is not found in the map,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaitai-struct
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Mikhail Yakshin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-04 00:00:00.000000000 Z
+date: 2017-03-22 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.