cstruct 1.0.0

data/examples/anonymous_union.rb

@@ -0,0 +1,42 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+# struct U in C\C++ (32-bit platform): 
+# 
+# struct U
+# {
+#    union{
+#       int x;
+#       int y;
+#    }value; /* values is anonymous union's instance */
+# }; 
+
+# struct U in Ruby: 
+class U < CStruct
+    union:value do
+        int32:x
+        int32:y
+    end
+end
+
+# or like this (use brace):
+# class U < CStruct
+#    union (:position) {
+#        int32:x
+#        int32:y	
+#    }
+# end
+
+
+# create a U's instance
+u = U.new
+
+# Notice! Assign is different from C language.
+# 'value' can not be omitted !
+u.value.x = 10
+
+puts "sizeof(U) = #{U.__size__}" # "__size__" is alias of "size" . You may use 'size'.
+puts "u.value.x = #{u.value.x }, u.value.y = #{u.value.y }"
+
+

data/examples/array_member.rb

@@ -0,0 +1,29 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+# struct T in C\C++ (32-bit platform): 
+# 
+# struct T
+# {
+#    int element[8];
+# }; 
+
+# struct T in Ruby: 
+class T < CStruct
+  int32:elements,[8]
+end
+
+# create a T's instance
+t_array = T.new
+
+(0..7).each do |i|
+	t_array.elements[i] = i  # assign like as C language
+end
+
+# output
+(0..7).each {|i| puts "t_array.elements[#{i}] = #{t_array.elements[i]}" }
+
+
+# Actually,t_array.elements.class is Array. So..
+t_array.elements.each {|element| puts element }

data/examples/file_io.rb

@@ -0,0 +1,49 @@
+# CStruct Examples
+require 'cstruct'
+
+# struct Point in Ruby: 
+class Point < CStruct
+  int32:x
+  int32:y 
+end
+
+# struct PointF in Ruby: 
+class PointF < CStruct
+  double:x
+  double:y 
+end
+
+class Addition < CStruct
+	char :description,[32]
+end
+
+# write file
+File.open("point.bin","wb")do |f|
+    point   = Point.new {|st| st.x = 100; st.y =200 }
+    point_f = PointF.new{|st| st.x = 20.65; st.y =70.86 }
+	
+    addition = Addition.new 
+    addition.description= "Hello Ruby!"
+
+    f.write point.data
+    f.write point_f.data
+    f.write addition.data
+
+end
+
+#read file
+File.open("point.bin","rb")do |f|
+    point    = Point.new 
+    point_f  = PointF.new
+    addition = Addition.new
+    
+    point   << f.read(Point.size)
+    point_f << f.read(PointF.size)
+    addition <<  f.read(Addition.size)
+    
+    puts point.x
+    puts point.y
+    puts point_f.x
+    puts point_f.y
+    puts addition.description.to_cstr
+end

data/examples/first_example.rb

@@ -0,0 +1,53 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+# struct Point in C\C++	(32-bit platform): 
+#
+# struct Point
+# {
+#    int x;
+#    int y;
+# }; 
+
+# struct Point in Ruby: 
+class Point < CStruct
+  int32:x
+  int32:y 
+end
+
+# create a Point's instance
+point   = Point.new
+
+# assign like as C language
+point.x = 10
+point.y = 20
+
+puts "point.x = #{point.x},point.y = #{point.y}"
+
+
+
+# struct PointF in C\C++	(32-bit platform): 
+#
+# struct PointF
+# {
+#    double x;
+#    double y;
+# }; 
+
+# struct PointF in Ruby: 
+class PointF < CStruct
+  double:x
+  double:y 
+end
+
+# create a PointF's instance
+# use 'block' to initialize the fields
+point2   = PointF.new do |st|
+	st.x = 10.56
+	st.y = 20.78
+end
+
+puts "sizeof(PointF) = #{PointF.size}"
+puts "point2.x = #{point2.x},point2.y = #{point2.y}"
+

data/examples/inner_struct.rb

@@ -0,0 +1,28 @@
+# CStruct Examples
+require 'cstruct'
+# example:
+# struct A in C\C++ (32-bit platform): 
+# struct A{
+#     struct Inner
+#     {
+#       int v1; 
+#       int v2;
+#     };
+#     Inner inner;
+# };
+
+# struct A in Ruby:
+class A < CStruct
+    class Inner < CStruct
+        int32 :v1
+        int32 :v2
+    end
+    Inner :inner
+end
+
+a = A.new
+a.inner.v1 = 1
+a.inner.v2 = 2
+
+puts a.inner.v1 
+puts a.inner.v2 

data/examples/inner_union.rb

@@ -0,0 +1,26 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+# struct U in C\C++ (32-bit platform): 
+# 
+#struct U
+#{
+#    union NumericType
+#    {
+#        int   x;
+#        int   y;  
+#    };
+#    NumericType value;
+#};
+
+# Named union is unsupported in CStruct. Fortunately, anonymous union can take the place of it.
+# struct U in Ruby: 
+class U < CStruct
+    union:value do
+        int32:x
+        int32:y
+    end
+end
+
+#  See also: 'anonymous_union.rb' 

data/examples/namespace.rb

@@ -0,0 +1,29 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+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
+p D.__size__
+p v.b.a.handle

data/examples/struct_member.rb

@@ -0,0 +1,77 @@
+# CStruct Examples
+require 'cstruct'
+
+# example:
+# struct Point in C\C++ (32-bit platform): 
+#
+# struct Point
+# {
+#    int x;
+#    int y;
+# }; 
+#
+# struct Line in C\C++ (32-bit platform): 
+#
+# struct Line
+# {
+#    Point begin_point;
+#    Point end_point;
+# }; 
+
+# struct TwoLine in C\C++ (32-bit platform): 
+#
+# struct TwoLine
+# {
+#    Line lines[2];
+# }; 
+
+
+
+# struct Point , Line and TwoLine in Ruby: 
+class Point < CStruct
+  int32:x
+  int32:y 
+end
+
+class Line < CStruct
+  Point:begin_point
+  Point:end_point 
+end
+
+class TwoLine < CStruct
+  Line:lines,[2]
+end
+
+
+line = Line.new
+
+# assign like as C language
+line.begin_point.x = 0
+line.begin_point.y = 0
+line.end_point.x = 20   
+line.end_point.y = 30
+
+
+puts "sizeof(Line) = #{Line.__size__}" # "__size__" is alias of "size"
+puts "line.begin_point.x = #{line.begin_point.x}"
+puts "line.begin_point.y = #{line.begin_point.y}"
+puts "line.end_point.x = #{line.end_point.x}"  
+puts "line.end_point.y = #{line.end_point.y}"
+
+two_line = TwoLine.new
+
+# assign like as C language
+two_line.lines[0].begin_point.x = 6
+two_line.lines[0].begin_point.y = 16
+two_line.lines[0].end_point.x = 26   
+two_line.lines[0].end_point.y = 36
+
+two_line.lines[1].begin_point.x = 6
+two_line.lines[1].begin_point.y = 16
+two_line.lines[1].end_point.x = 26   
+two_line.lines[1].end_point.y = 36
+
+
+
+
+

data/examples/win32/get_system_info.rb

@@ -0,0 +1,64 @@
+# CStruct Examples
+require 'windows/system_info'
+require 'win32struct'
+include Windows::SystemInfo
+
+# SYSTEM_INFO in VC6 's SDK
+# typedef struct _SYSTEM_INFO {
+#     union {
+#         DWORD dwOemId;          // Obsolete field...do not use
+#         struct {
+#             WORD wProcessorArchitecture;
+#             WORD wReserved;
+#         };
+#     };
+#     DWORD dwPageSize;
+#     LPVOID lpMinimumApplicationAddress;
+#     LPVOID lpMaximumApplicationAddress;
+#     DWORD dwActiveProcessorMask;
+#     DWORD dwNumberOfProcessors;
+#     DWORD dwProcessorType;
+#     DWORD dwAllocationGranularity;
+#     WORD wProcessorLevel;
+#     WORD wProcessorRevision;
+# } SYSTEM_INFO, *LPSYSTEM_INFO;
+
+# SYSTEM_INFO in Ruby
+class SYSTEM_INFO < Win32Struct
+    union:u do
+        DWORD:dwOemId
+        struct:x do
+            WORD:wProcessorArchitecture
+            WORD:wReserved	
+        end
+    end
+    DWORD  :dwPageSize
+    LPVOID :lpMinimumApplicationAddress
+    LPVOID :lpMaximumApplicationAddress
+    DWORD  :dwActiveProcessorMask
+    DWORD  :dwNumberOfProcessors
+    DWORD  :dwProcessorType
+    DWORD  :dwAllocationGranularity
+    WORD   :wProcessorLevel
+    WORD   :wProcessorRevision
+end
+
+# call GetSystemInfo
+sys_info = SYSTEM_INFO.new
+GetSystemInfo(sys_info.__data__) # __data__ is an alias for method 'data'	
+	
+#output
+puts "<System Infomation>" 
+puts	"Processor Architecture:#{sys_info.u.x.wProcessorArchitecture}"	# 'u' and 'x' can not be omitted
+puts	"Page Size:#{sys_info.dwPageSize}"
+puts	"Minimum Application Address:0x#{sys_info.lpMinimumApplicationAddress.to_s 16}"
+puts	"Maximum Application Address:0x#{sys_info.lpMaximumApplicationAddress.to_s 16}"
+puts	"Active Processor Mask:#{sys_info.dwActiveProcessorMask}"
+puts	"Number Of Processors:#{sys_info.dwNumberOfProcessors}"
+puts	"Processor Type:#{sys_info.dwProcessorType}"
+puts	"Allocation Granularity:0x#{sys_info.dwAllocationGranularity.to_s 16}"
+puts	"Processor Level:#{sys_info.wProcessorLevel}"
+puts	"Processor Revision:#{sys_info.wProcessorRevision}"
+	
+	
+	

data/examples/win32/get_versionex.rb

@@ -0,0 +1,47 @@
+# CStruct Examples
+require 'windows/system_info'
+require 'win32struct'
+include Windows::SystemInfo
+
+
+# OSVERSIONINFOEXA in VC6 's SDK
+#typedef struct _OSVERSIONINFOEXA {
+#    DWORD dwOSVersionInfoSize;
+#    DWORD dwMajorVersion;
+#    DWORD dwMinorVersion;
+#    DWORD dwBuildNumber;
+#    DWORD dwPlatformId;
+#    CHAR   szCSDVersion[ 128 ];     // Maintenance string for PSS usage
+#    WORD wServicePackMajor;
+#    WORD wServicePackMinor;
+#    WORD wReserved[2];
+#} OSVERSIONINFOEXA;
+
+
+class OSVERSIONINFOEXA < Win32Struct
+    DWORD :dwOSVersionInfoSize
+    DWORD :dwMajorVersion
+    DWORD :dwMinorVersion
+    DWORD :dwBuildNumber
+    DWORD :dwPlatformId
+    CHAR  :szCSDVersion,[ 128 ]
+    WORD  :wServicePackMajor
+    WORD  :wServicePackMinor
+    WORD  :wReserved,[2]    
+end
+
+ver_info_ex = OSVERSIONINFOEXA.new do |st| 
+	st.dwOSVersionInfoSize = OSVERSIONINFOEXA.__size__  # __size__ is an alias for method 'size'
+end
+
+#ANSI Version: GetVersionExA
+GetVersionExA(ver_info_ex.__data__) # __data__ is an alias for method 'data'
+
+puts "<OS Version Infomation>"
+puts "Major Version:#{ver_info_ex.dwMajorVersion}"
+puts "Minor Version:#{ver_info_ex.dwMinorVersion}"
+puts "Build Number:#{ver_info_ex.dwBuildNumber}"
+puts "Platform Id:#{ver_info_ex.dwPlatformId}"
+puts "CSD Version:#{ver_info_ex.szCSDVersion.to_cstr}" 		# to_cstr return a string(C Style)
+puts "ServicePack Major:#{ver_info_ex.wServicePackMajor}"
+puts "ServicePack Minor:#{ver_info_ex.wServicePackMinor}"

data/examples/win32/global_memory.rb

@@ -0,0 +1,51 @@
+# CStruct Examples
+require 'windows/memory'
+require 'win32struct'
+
+include Windows::Memory
+
+# example:
+
+# typedef struct _MEMORYSTATUS {
+#     DWORD dwLength;
+#     DWORD dwMemoryLoad;
+#     DWORD dwTotalPhys;
+#     DWORD dwAvailPhys;
+#     DWORD dwTotalPageFile;
+#     DWORD dwAvailPageFile;
+#     DWORD dwTotalVirtual;
+#     DWORD dwAvailVirtual;
+# } MEMORYSTATUS, *LPMEMORYSTATUS;
+
+class MEMORYSTATUS < Win32Struct
+    DWORD :dwLength
+    DWORD :dwMemoryLoad
+    DWORD :dwTotalPhys
+    DWORD :dwAvailPhys
+    DWORD :dwTotalPageFile
+    DWORD :dwAvailPageFile
+    DWORD :dwTotalVirtual
+    DWORD :dwAvailVirtual	
+end
+
+
+
+# create a MEMORYSTATUS's instance
+stat = MEMORYSTATUS.new {|st| st.dwLength = MEMORYSTATUS.size }
+
+# call API "GlobalMemoryStatus" - See also MSDN
+GlobalMemoryStatus(stat.data)
+
+#output
+printf "[Physical Memory]\n"
+printf "  total:%12d bytes\n",stat.dwTotalPhys
+printf "  free :%12d bytes\n",stat.dwAvailPhys
+
+printf "[Virtual Memory]\n"
+printf "  total:%12d bytes\n",stat.dwTotalVirtual
+printf "  free :%12d bytes\n",stat.dwAvailVirtual
+
+printf "[Paging File]\n"
+printf "  total:%12d bytes\n",stat.dwTotalPageFile
+printf "  free :%12d bytes\n",stat.dwAvailPageFile
+

data/examples/win32/show_processes.rb

@@ -0,0 +1,45 @@
+# CStruct Examples
+require 'windows/tool_helper'
+require 'win32struct'
+include Windows::ToolHelper
+
+module Windows
+    MAX_PATH = 260
+    module ToolHelper	
+        class PROCESSENTRY32 < Win32Struct
+            DWORD   :dwSize
+            DWORD   :cntUsage
+            DWORD   :th32ProcessID 
+            DWORD   :th32DefaultHeapID
+            DWORD   :th32ModuleID 
+            DWORD   :cntThreads
+            DWORD   :th32ParentProcessID
+            LONG    :pcPriClassBase        
+            DWORD   :dwFlags
+            CHAR    :szExeFile,[MAX_PATH]  
+        end
+    end	
+end
+
+def show_all_processes
+    proc_enrty32 = PROCESSENTRY32.new
+    proc_enrty32.dwSize = PROCESSENTRY32.__size__
+    snap_handle  = CreateToolhelp32Snapshot( TH32CS_SNAPPROCESS,0)
+    
+    if Process32First(snap_handle,proc_enrty32.data)
+        show_process proc_enrty32	
+        while true
+            break if !Process32Next( snap_handle,proc_enrty32.data ) 
+            show_process proc_enrty32
+        end		
+    end
+    
+end
+
+def show_process proc_enrty32
+    printf"%20s 0x%08X\n",proc_enrty32.szExeFile.to_cstr,proc_enrty32.th32ProcessID
+end
+
+printf"%20s %s\n","<Process Name>","<PID>"
+printf"%20s %s\n","--------------","-----"
+show_all_processes