BitStructEx 0.0.65 → 0.0.74

data/src/{ruby/bit_struct → bit_struct}/bit_slicer.rb

@@ -2,36 +2,21 @@
 module BitStruct
 
   # Implements access to a 'segment' of a byte string, specified by
-  # offset (from bit 0) and length (in bits). Supports little and big
-  # endian data input and output.
+  # offset (from bit 0) and length (in bits).
   #
   # NOTE: This is highly inefficient. If a segment is byte-aligned,
   # please use the optimized ByteSlicer class.
+  #
+  # NOTE: Oops! Haven't implemented the ByteSlicer, yet! :)
+  #
   class BitSlicer
 
-    module Endianess
-      LITTLE_ENDIAN = LITTLE = INTEL = 0
-      BIG_ENDIAN = BIG = MOTOROLA = 1
-      NETWORK_BYTE_ORDER = BIG_ENDIAN
-    end
+    attr_accessor :data
 
-    include Endianess
-
-    def initialize( bit_offset, bit_length, endianess = MOTOROLA )
+    def initialize( bit_offset, bit_length )
       raise ArgumentError if bit_offset < 0 || bit_length < 0
-
       @bit_offset = bit_offset
       @bit_length = bit_length
-      @endianess = endianess
-    end
-
-    def data=( new_data )
-      raise ArgumentError if ( @bit_offset + @bit_length ) > new_data.length * 8
-      @data = new_data
-    end
-
-    def data
-      @data
     end
 
     def get_bytes
@@ -88,13 +73,11 @@ module BitStruct
     #private
 
     def get_data( idx )
-      return @data[ idx ] if @endianess == MOTOROLA
-      return @data[ -idx ] if @endianess == INTEL
+      @data[ idx ]
     end
 
     def set_data( idx, val )
-      @data[ idx ] = val if @endianess == MOTOROLA
-      @data[ -idx ] = val if @endianess == INTEL
+      @data[ idx ] = val
     end
 
     def first_byte

data/src/bit_struct/byte_data.rb

@@ -0,0 +1,56 @@
+
+module BitStruct
+
+  class ByteData
+
+    LITTLE_ENDIAN = LITTLE = INTEL = 0
+    BIG_ENDIAN = BIG = MOTOROLA = 1
+    NETWORK_BYTE_ORDER = BIG_ENDIAN
+
+    def initialize( data, endianess = nil )
+      raise "Bad input" unless data.respond_to? "[]".to_sym
+      raise "Unknown endianess" unless valid endianess
+      @data = data
+      @endianess = endianess || BIG_ENDIAN
+    end
+
+    def size
+      @data.size
+    end
+
+    def length
+      @data.length
+    end
+
+    def each
+      0.upto( size - 1 ) { |idx| yield self[ idx ] }
+    end
+
+    def to_s
+      str = ''
+      each { |b| str << b }
+      str
+    end
+
+    def []( idx )
+      @data[ endianized( idx ) ]
+    end
+
+    def []=( idx, val )
+      @data[ endianized( idx ) ] = val
+    end
+
+    private
+
+    def valid( endianess )
+      endianess == nil || endianess == LITTLE_ENDIAN || endianess == BIG_ENDIAN
+    end
+
+    def endianized( idx )
+      return idx if @endianess == BIG_ENDIAN
+      return @data.length - idx - 1 if @endianess == LITTLE_ENDIAN
+    end
+
+  end
+
+end

data/src/{ruby/bit_struct → bit_struct}/nested.rb

@@ -8,6 +8,7 @@ module BitStruct
     def initialize( name, nested_class, description = nil )
       super name, nil, description
       @nested_class = nested_class
+      @nested = nested_class.new
     end
 
     def length
@@ -16,7 +17,8 @@ module BitStruct
 
     def read( slicer )
       bytes = slicer.get_bytes
-      @nested_class.new bytes
+      @nested.set_data bytes
+      @nested
     end
 
     def write( slicer, new_value )

data/src/{ruby/bit_struct → bit_struct}/struct_base.rb

@@ -1,5 +1,6 @@
 
 require 'bit_struct/bit_slicer'
+require 'bit_struct/byte_data'
 require 'bit_struct/field'
 
 # The BitStruct module primarily provides the StructBase class, which in turn
@@ -8,27 +9,28 @@ require 'bit_struct/field'
 #
 # Example:
 #
-# class Flags < StructBase
-#   unsigned :direction, 4
-#   unsigned :multiplier, 2
-#   unsigned :offset, 2
-# end
+#   class Flags < StructBase
+#     unsigned :direction, 4
+#     unsigned :multiplier, 2
+#     unsigned :offset, 2
+#   end
 #
-# class Entry < StructBase
-#   unsigned :offset, 4
-#   nested   :flags, Flags
-#   unsigned :address, 24
-#   unsigned :cache_id, 16
-# end
+#   class Entry < StructBase
+#     unsigned :offset, 4
+#     nested   :flags, Flags
+#     unsigned :address, 24
+#     unsigned :cache_id, 16
+#   end
 #
-# In contrast to the already available
+# Then use it like this:
+#
+#   entry = Entry.new some_data
+#   entry.offset
+#
+# NOTE: In contrast to the already available
 # http://raa.ruby-lang.org/project/bit-struct/ implementation, BitStructEx
 # allows nested structures which are not aligned on byte boundaries.
 #
-# Author::    Daniel Lukic (mailto:bitstructex@berlinfactor.com)
-# Copyright:: Copyright (c) 2005 The.Berlin.Factor
-# License::   Distributes under the GPL
-#
 module BitStruct
 
   # Define a subclass of StructBase and use the available field types (at
@@ -41,14 +43,25 @@ module BitStruct
   # Please see the provided examples in the samples folder for.. well..
   # examples.
   #
-  class StructBase < String
+  # NOTE: You may ask 'What examples?'. And right you are, I haven't written
+  # any examples, yet.. Sorry.. :)
+  #
+  class StructBase
 
-    def initialize( data = nil )
-      @data = data
+    attr_reader :data
+
+    def initialize( initial_data = nil, endianess = nil )
+      set_data initial_data, endianess if initial_data
     end
 
-    def data
-      @data
+    def set_data( new_data, endianess = nil )
+      raise "No data?" unless new_data
+      if new_data.is_a? ByteData
+        raise "Cannot change endianess of ByteData object" if endianess
+        @data = new_Data
+      else new_data
+        @data = ByteData.new new_data, endianess
+      end
     end
 
     class << self
@@ -71,6 +84,7 @@ module BitStruct
           slicer.data = @data
           field.send :read, slicer
         end
+
         define_method "#{field.name}=" do |val|
           slicer = context.send :get_slicer_for, field
           slicer.data = @data

metadata

@@ -3,16 +3,16 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: BitStructEx
 version: !ruby/object:Gem::Version 
-  version: 0.0.65
-date: 2006-04-13 00:00:00 +02:00
+  version: 0.0.74
+date: 2006-05-06 00:00:00 +02:00
 summary: Simple DSL for defining bit-based structures on byte data.
 require_paths: 
-- src/ruby
+- src
 email: tfdj {AT} berlinfactor {DOT} com
 homepage: bit-struct-ex.rubyforge.org.
 rubyforge_project: bit-struct-ex
 description: "Allows the specification of bit-based structures and provides an intuitive way of access data.  Example:  class Flags < StructBase unsigned :direction, 4 unsigned :multiplier, 2 unsigned :offset, 2 end  class Entry < StructBase unsigned :offset, 4 nested   :flags, Flags unsigned :address, 24 unsigned :cache_id, 16 end  In contrast to the already available http://raa.ruby-lang.org/project/bit-struct/ implementation, BitStructEx allows nested structures which are not aligned on byte boundaries."
-autorequire: bit_struct/struct_base
+autorequire: 
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -28,12 +28,15 @@ cert_chain:
 authors: 
 - The.French.DJ
 files: 
-- src/ruby/bit_struct/bit_slicer.rb
-- src/ruby/bit_struct/field.rb
-- src/ruby/bit_struct/nested.rb
-- src/ruby/bit_struct/struct_base.rb
-- src/ruby/bit_struct/text.rb
-- src/ruby/bit_struct/unsigned.rb
+- src/bit_struct
+- src/rake
+- src/bit_struct/bit_slicer.rb
+- src/bit_struct/byte_data.rb
+- src/bit_struct/field.rb
+- src/bit_struct/nested.rb
+- src/bit_struct/struct_base.rb
+- src/bit_struct/text.rb
+- src/bit_struct/unsigned.rb
 test_files: []
 
 rdoc_options: []