cstruct 1.0.0 → 1.0.1

data/lib/cstruct/field.rb

@@ -0,0 +1,45 @@
+class CStruct
+  class Field #:nodoc: all
+    attr_accessor:tag
+    attr_accessor:size
+    attr_accessor:offset
+    attr_accessor:sign
+    attr_accessor:dimension
+
+    def initialize(tag,size,offset,sign,dimension = nil,*args)
+      @tag    = tag
+      @size   = size 
+      @offset = offset
+      @sign   = sign
+      @dimension = dimension
+      @byte_size = size
+
+      if @dimension
+        @byte_size = @size * dimension.inject(1){|m,i| m*=i}
+        @sign = :struct_array if @sign == :struct      
+      end
+
+    end
+    
+    def byte_size
+      @byte_size
+    end
+    
+    def is_float?
+      @sign == :float
+    end
+    
+    def is_double?
+      @sign == :double
+    end
+    
+    def is_struct?
+      @sign == :struct
+    end
+    
+    def is_union?
+      @sign == :union
+    end
+
+  end
+end

data/lib/cstruct/utils.rb

@@ -0,0 +1,53 @@
+require 'enumerator'
+
+class CStruct
+  module Utils #:nodoc: all
+    UnpackFormat =
+    {
+      :little => { 1=>'C',2=>'v',4=>'V',8=>'Q',:float=>'e',:double=>'E'},
+      :big    => { 1=>'C',2=>'n',4=>'N',8=>'Q',:float=>'g',:double=>'G'}, #8=>'Q'? 'Q' is native endian
+    }
+    SigedMaxValue    = {  1 => 0x7F, 2 => 0x7FFF, 4 => 0x7FFFFFFF, 8 => 0x7FFFFFFFFFFFFFFF }
+    UnsigedMaxValue  = {  1 => 0xFF, 2 => 0xFFFF, 4 => 0xFFFFFFFF, 8 => 0xFFFFFFFFFFFFFFFF }
+    
+    class << self
+      # buffer is a String's object
+      def unpack(buffer,struct_endian,fsize,fsign)
+        format_index = (fsign==:float or fsign ==:double) ? (fsign):(fsize)
+        format = UnpackFormat[struct_endian][format_index]
+        value  = buffer.unpack(format).first
+       
+        if  fsign == :signed
+          value = unsigned_to_signed value,fsize
+        end  
+        value
+      end
+      
+      # buffer is a Array's object
+      def pack(buffer,struct_endian,fsize,fsign)
+        format_index = (fsign==:float or fsign ==:double) ? (fsign):(fsize)
+        format = UnpackFormat[struct_endian][format_index] 
+        buffer.pack format
+      end
+
+      def string_setbyte(string,index,value)
+        RUBY_VERSION < "1.9" ? (string[index] = value):(string.setbyte index,value)       
+      end
+
+      def string_getbyte(string,index)
+        RUBY_VERSION < "1.9" ? (string[index]):(string.getbyte index)
+      end
+      
+      def unsigned_to_signed(value,value_size)
+        value > SigedMaxValue[value_size] ? (value - UnsigedMaxValue[value_size]-1):(value)  
+      end
+
+      def buffer_setbytes(target,source,target_index)
+          source.enum_for(:each_byte).each_with_index do |byte,index|
+          string_setbyte(target,target_index + index,byte)
+        end
+      end
+
+    end
+  end
+end 

data/lib/cstruct/win32struct.rb

@@ -0,0 +1,84 @@
+require "cstruct/cstruct"
+#
+# ===Description
+# Win32Struct defined some Win32 type,like as: HANDLE,HMODULE,...
+# ===How to use
+#   require 'cstruct/win32struct
+#
+class Win32Struct< CStruct  
+  class << self             
+    # Handle
+    alias HANDLE    uint32
+    alias HMODULE   uint32
+    alias HINSTANCE uint32       
+    alias HRGN      uint32
+    alias HTASK     uint32
+    alias HKEY      uint32
+    alias HDESK     uint32
+    alias HMF       uint32
+    alias HEMF      uint32
+    alias HRSRC     uint32
+    alias HSTR      uint32
+    alias HWINSTA   uint32
+    alias HKL       uint32
+    alias HGDIOBJ   uint32 
+    alias HICON     uint32  
+    alias HPEN      uint32
+    alias HACCEL    uint32
+    alias HBITMAP   uint32
+    alias HBRUSH    uint32
+    alias HCOLORSPACE   uint32
+    alias HDC           uint32
+    alias HGLRC         uint32
+    alias HENHMETAFILE  uint32
+    alias HFONT         uint32
+    alias HMENU         uint32
+    alias HMETAFILE     uint32
+    alias HPALETTE      uint32
+    alias HCURSOR       uint32
+    
+    # Data Type
+    alias WPARAM    uint32
+    alias LPARAM    uint32
+    alias LRESULT   uint32
+    alias ATOM      uint32
+    
+    alias BOOL      uint32
+    alias DWORD     uint32
+    alias WORD      uint16
+    alias BYTE      uint8
+    
+    alias ULONG     uint32
+    alias UINT      uint32
+    alias USHORT    uint16
+    alias UCHAR     uchar
+    
+    alias LONG      int32
+    alias INT       int32
+    alias SHORT     int16
+    alias CHAR      char   
+    alias WCHAR     uint16
+
+    # Pointer
+    alias DWORD_PTR uint32
+    alias ULONG_PTR uint32
+    alias UINT_PTR  uint32
+    alias PHANDLE   uint32
+    
+    alias PBOOL     uint32
+    alias LPBOOL    uint32
+    alias PBYTE     uint32
+    alias LPBYTE    uint32
+    alias PINT      uint32
+    alias LPINT     uint32
+    alias PWORD     uint32
+    alias LPWORD    uint32
+    alias LPLONG    uint32
+    alias PDWORD    uint32
+    alias LPDWORD   uint32
+    alias LPVOID    uint32
+    alias LPCVOID   uint32
+    alias LPCSTR    uint32
+    
+  end
+end

data/lib/cstruct/win64struct.rb

@@ -0,0 +1,5 @@
+require "cstruct/cstruct"
+# 
+class Win64Struct< CStruct
+  "No Implement!"
+end

data/lib/win32struct.rb

@@ -1,90 +1,3 @@
-###############################################
-# Win32Struct
-# - TWS(Type-Wrapper-Struct) for win32
-#
-# Author: Wang Yong (skandhas)
-# CStruct Homepage: cstruct.rubyforge.org
-# E-Mail: skandhas@163.com
-###############################################
-
-require "cstruct"
-class Win32Struct< CStruct
-	
-  class << self
-  	 		 	
-    # Handle
-    alias HANDLE    uint32
-    alias HMODULE   uint32
-    alias HINSTANCE uint32       
-    alias HRGN      uint32
-    alias HTASK     uint32
-    alias HKEY      uint32
-    alias HDESK     uint32
-    alias HMF       uint32
-    alias HEMF      uint32
-    alias HRSRC     uint32
-    alias HSTR      uint32
-    alias HWINSTA   uint32
-    alias HKL       uint32
-    alias HGDIOBJ   uint32
-    
-    alias HICON     uint32  
-    alias HPEN      uint32
-    alias HACCEL    uint32
-    alias HBITMAP   uint32
-    alias HBRUSH    uint32
-    alias HCOLORSPACE   uint32
-    alias HDC           uint32
-    alias HGLRC         uint32
-    alias HENHMETAFILE  uint32
-    alias HFONT         uint32
-    alias HMENU         uint32
-    alias HMETAFILE     uint32
-    alias HPALETTE      uint32
-    alias HCURSOR       uint32
-    
-    # Data Type
-    alias WPARAM    uint32
-    alias LPARAM    uint32
-    alias LRESULT   uint32
-    alias ATOM      uint32
-    
-    alias BOOL      uint32
-    alias DWORD     uint32
-    alias WORD      uint16
-    alias BYTE      uint8
-    
-    alias ULONG     uint32
-    alias UINT      uint32
-    alias USHORT    uint16
-    alias UCHAR     uchar
-    
-    alias LONG      int32
-    alias INT       int32
-    alias SHORT     int16
-    alias CHAR      char   
-    alias WCHAR     uint16
-
-    # Pointer
-    alias DWORD_PTR uint32
-    alias ULONG_PTR uint32
-    alias UINT_PTR  uint32
-    alias PHANDLE   uint32
-    
-    alias PBOOL     uint32
-    alias LPBOOL    uint32
-    alias PBYTE     uint32
-    alias LPBYTE    uint32
-    alias PINT      uint32
-    alias LPINT     uint32
-    alias PWORD     uint32
-    alias LPWORD    uint32
-    alias LPLONG    uint32
-    alias PDWORD    uint32
-    alias LPDWORD   uint32
-    alias LPVOID    uint32
-    alias LPCVOID   uint32
-    alias LPCSTR    uint32
-    
-  end
-end
+require 'cstruct/win32struct'
+puts "In CStruct-#{CStruct::VERSION} require 'win32struct' is not recommended."
+puts "Replacing 'win32struct' by 'cstruct/win32struct'."

data/lib/win64struct.rb

@@ -1,13 +1,3 @@
-###############################################
-# Win64Struct
-# - TWS(Type-Wrapper-Struct) for win64
-#
-# Author: Wang Yong (skandhas)
-# CStruct Homepage: cstruct.rubyforge.org
-# E-Mail: skandhas@163.com
-###############################################
-
-require "cstruct"
-class Win64Struct< CStruct
-	"No Implement!"
-end
+require 'cstruct/win64struct'
+puts "In CStruct-#{CStruct::VERSION} require 'win64struct' is not recommended."
+puts "Replacing 'win32struct' by 'cstruct/win64struct'."

data/spec/cstruct_spec.rb

@@ -0,0 +1,240 @@
+require 'rspec'
+require 'cstruct'
+
+puts "Test CStruct-#{CStruct::VERSION}"
+
+describe 'Normal Member -> Point' do
+  subject do
+
+    class Point < CStruct
+      int32:x
+      int32:y 
+    end
+
+    point = Point.new
+    point.x,point.y = -10,20
+    point      
+  end      
+  its(:x) { should == -10 }
+  its(:y) { should == 20 }
+end
+
+describe 'Struct Member -> Line' do
+  subject do
+    class Point < CStruct
+      int32:x
+      int32:y 
+    end
+
+    class Line < CStruct
+      Point:begin_point
+      Point:end_point 
+    end
+
+    line = Line.new
+    line.begin_point.x = 10 
+    line.begin_point.y = 20
+    line      
+  end      
+  its(:'begin_point.x') { should == 10 }
+  its(:'begin_point.y') { should == 20 }
+end
+
+describe 'Array Member -> Collection' do
+  subject do
+    
+    class Collection < CStruct
+      int32:elements,[8]
+    end
+
+    collection = Collection.new    
+    
+    (0..7).each do |i|
+      collection.elements[i] = i  # assign like as C language
+    end
+
+    collection     
+  end 
+  its(:elements) { should == (0..7).to_a }
+end
+
+describe 'Array Struct Member -> PointArray' do
+  it 'PointArray' do  
+    class Point < CStruct
+      double:x
+      double:y 
+    end
+
+    class PointArray < CStruct
+      Point:elements,[4]
+    end
+
+    array = PointArray.new 
+    (0..3).each do |i| 
+      array.elements[i].x = i+0.234
+      array.elements[i].y = i+1.667
+    end
+
+    (0..3).each do |i| 
+      array.elements[i].x.should == i+0.234
+      array.elements[i].y.should == i+1.667
+    end
+  end   
+  
+end
+
+
+describe 'Inner Struct Member-> T' do
+  subject do
+    class T < CStruct
+      class Inner < CStruct
+        int32 :v1
+        int32 :v2
+      end
+      Inner :inner
+    end
+
+    t = T.new    
+    t.inner.v1 = 10
+    t.inner.v2 = 20
+    t 
+  end 
+  its(:'inner.v1') { should == 10 }
+  its(:'inner.v2') { should == 20 }
+end
+
+describe 'Anonymous Struct Member -> Window' do  
+  subject do
+    class Window < CStruct
+      int32:style
+      struct :position do
+        int32:x
+        int32:y 
+      end
+    end
+    window = Window.new
+    window.style = 1
+    window.position.x = 10
+    window.position.y = 20
+    window
+  end
+  
+  its(:style)       { should == 1}  
+  its(:'position.x'){ should == 10} 
+  its(:'position.y'){ should == 20} 
+end
+
+describe 'Anonymous Union Member -> U' do  
+  subject do
+    class U < CStruct
+        union:value do
+        int32:x
+        int32:y
+      end
+    end
+
+    u = U.new
+    u.value.x = 10
+    u
+  end  
+  its(:'value.x'){ should == 10}
+end
+
+describe 'Char Buffer Member -> Addition' do
+  subject do
+    class Addition < CStruct
+      char :description,[32]
+    end
+
+    addition = Addition.new
+    addition.description = 'Hello Ruby!'
+    addition
+  end
+  
+  its(:'description.to_cstr') {should == 'Hello Ruby!'}
+end
+
+=begin
+describe 'Binary File IO ' do
+  subject do
+ 
+    class Point < CStruct
+      int32:x
+      int32:y 
+    end
+
+    class PointF < CStruct
+      double:x
+      double:y 
+    end
+
+    class Addition < CStruct
+      char :description,[32]
+    end
+    
+    class IOData < CStruct
+      Point:point
+      PointF:pointf
+      Addition:addition
+    end
+
+    write_data = IOData.new
+    # write file
+    File.open("point.bin","wb")do |f|
+        write_data.point   = Point.new {|st| st.x = 100; st.y =200 }
+        write_data.point_f = PointF.new{|st| st.x = 20.65; st.y =70.86 }
+      
+        write_data.addition = Addition.new 
+        write_data.addition.description= "Hello Ruby!"
+
+        f.write write_data.data
+    end
+
+    read_data = IOData.new
+
+    #read file
+    File.open("point.bin","rb")do |f|      
+      read_data   << f.read(IODtata.size)    
+        
+      puts point.x
+      puts point.y
+      puts point_f.x
+      puts point_f.y
+      puts addition.description.to_cstr
+    end
+    read_data
+  end
+  
+  its(:'point.x') {should == 200}
+end
+=end
+describe 'Namespace ' do
+ it 'NS1 NS2' do
+    module NS1    #namespace
+        class A < CStruct
+            uint32:handle
+        end
+      
+        module NS2
+            class B < CStruct
+                A:a # directly use A
+            end 
+        end
+
+        class C < CStruct
+          A     :a
+          NS2_B :b  # Meaning of the 'NS2_B' is NS2::B
+        end 
+    end
+
+    class D < CStruct
+        NS1_NS2_B:b # Meaning of the 'NS1_NS2_B' is NS1::NS2::B
+    end 
+
+    v = D.new
+    v.b.a.handle = 120
+    v.b.a.handle.should == 120
+    
+  end
+end
+