divine 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 586169794d6b8461baab4af10ef57a52e178039a
+  data.tar.gz: 3939d4f5eb57f2b3a30f272044f7dd74ef46a4cb
+SHA512:
+  metadata.gz: a9624587d78882b3d5b0cd6e6c730c4ebfc907673d648d23ed8b9a3e0e213435cc9c5fbfcb7255257fa5151471fd4bcace450a6f485bbc50744ddaabb2495ac5
+  data.tar.gz: d73c7a67534c01c66fa1832269d926c4c4c9195acc1bfc9b293cc6430010fa9006fe438a93be9515e836c357b5b8949e4ebacf6d6f8f518779ef5b9926f68847

data/.gitignore

@@ -31,7 +31,14 @@ test/binaryTree_test/js_test/test_binaryTree.js
 test/complex_test/js_test/test_complex.js
 test/ipv6_test/js_test/test_ipv6.js
 test/signed_int_test/js_test/test_signed_int.js
+test/binaryTree_test/csharp_test/test_binaryTree.cs
+test/complex_test/csharp_test/test_complex.cs
+test/dynamic_int_test/csharp_test/test_dynamic_int.cs
+test/ipv6_test/csharp_test/test_ipv6.cs
+test/signed_int_test/csharp_test/test_signed_int.cs
 bin.babel
 bin.babel.csharp
 bin.babel.rb
 bin.babel.js
+*.jpg
+.project

data/README.md

@@ -6,7 +6,105 @@ This software is still under active development and testing.
 
 We support C#, Java, Ruby and Javascript at the moment.
 
-## Example
+
+## Supported types
+
+<table>
+	<tr>
+		<th>Name</th>
+		<th>Range</th>
+		<th>Range (hex)</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>int8</td>
+		<td>0-255</td>
+		<td>0x00-0xFF</td>
+		<td>Unsinged integer stored in a singe byte</td>
+	</tr>
+	<tr>
+		<td>int16</td>
+		<td>0-65,535</td>
+		<td>0x00-0xFFFF</td>
+		<td>Unsinged integer stored in two bytes</td>
+	</tr>
+	<tr>
+		<td>int24</td>
+		<td>0-16,777,215</td>
+		<td>0x00-0xFFFFFF</td>
+		<td>Unsinged integer stored in three bytes</td>
+	</tr>
+	<tr>
+		<td>int32</td>
+		<td>0-4,294,967,295</td>
+		<td>0x00-0xFFFFFFFF</td>
+		<td>Unsinged integer stored in four bytes</td>
+	</tr>
+	<tr>
+		<td>dint63</td>
+		<td>0-9,223,372,036,854,775,807</td>
+		<td>0x00-0x7FFFFFFFFFFFFFFF</td>
+		<td>The dynamic int 63 will use between 1 to 9 bytes to represent the value. It will use 1 bit/byte to keep information if the next byte is used for the dynamic int
+			<table>
+				<tr><th>Size</th><th>Max value</th></tr>
+				<tr><td>1 byte</td><td>127</td></tr>
+				<tr><td>2 bytes</td><td>16,383</td></tr>
+				<tr><td>3 bytes</td><td>2,097,151</td></tr>
+				<tr><td>4 bytes</td><td>268,435,455</td></tr>
+				<tr><td>5 bytes</td><td>34,359,738,367</td></tr>
+				<tr><td>6 bytes</td><td>4,398,046,511,103</td></tr>
+				<tr><td>7 bytes</td><td>562,949,953,421,311</td></tr>
+				<tr><td>8 bytes</td><td>72,057,594,037,927,935</td></tr>
+				<tr><td>9 bytes</td><td>9,223,372,036,854,775,807</td></tr>
+			</table>
+		</td>
+	</tr>
+	<tr>
+		<td>sint32</td>
+		<td>-2,147,483,648 to 2,147,483,647</td>
+		<td></td>
+		<td>A signed integer that requires 4 bytes</td>
+	</tr>
+	<tr>
+		<td>sint64</td>
+		<td>-9,223,372,036,854,775,808 to 9,223,372,036,854,775,807</td>
+		<td></td>
+		<td>A signed integer that requires 8 bytes</td>
+	</tr>
+</table>
+
+<table>
+	<tr>
+		<th>Name</th>
+		<th>Description</th>
+	</tr>
+	<tr>
+		<td>bool</td>
+		<td>Write a boolean value requiring 1 byte</td>
+	</tr>
+	<tr>
+		<td>binary</td>
+		<td>Write a byte array of max 4,294,967,295 bytes</td>
+	</tr>
+	<tr>
+		<td>string</td>
+		<td>A UTF-8 based string of max 65,535 bytes (and one UTF8 char is represented by between 1 to 4 bytes)</td>
+	</tr>
+	<tr>
+		<td>ip_number</td>
+		<td>A IPv4 or IPv6 number as a string. An IPv4 number require 5 bytes, while an IPv6 number will require somewhere between 3-17 bytes.</td>
+	</tr>
+	<tr>
+		<td>list</td>
+		<td>A list of items</td>
+	</tr>
+	<tr>
+		<td>map</td>
+		<td>A hash-map of key/value items</td>
+	</tr>
+</table>
+
+## Example 1
 
 
 ```ruby
@@ -97,6 +195,181 @@ c2.deserialize(new BabelDataReader(ca));
 console.log(c2);
 ```
 
+## Example 2
+```ruby
+require 'divine'
+
+struct 'SignedInt' do
+  list :list1, :sint32
+  list :list2, :sint64
+end
+
+Divine::GraphGenerator.new.draw(".", "graph", "jpg")
+
+Divine::CodeGenerator.new.generate(:java, file: 'test.java')
+Divine::CodeGenerator.new.generate(:csharp, file: 'test.cs')
+```
+a Java example that uses the generated file test.java
+```java
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.util.ArrayList;
+
+public class JavaTest {
+
+	public void testSignedInt() throws IOException {
+		SignedInt ser = buildObj();
+		
+		serialize(ser);
+		byte[] res = deserialize();
+
+		SignedInt deser = new SignedInt();
+		deser.deserialize(new ByteArrayInputStream(res));
+
+		compare(ser, deser);
+	}
+
+	public SignedInt buildObj() {
+		SignedInt obj = new SignedInt();
+		obj.list1   = new ArrayList<Integer>(){{
+			add(-1);
+			add(-2);
+			add(-3);
+			add(Integer.MAX_VALUE);
+			add(Integer.MIN_VALUE);
+		}};
+		
+		obj.list2   = new ArrayList<Long>(){{
+			add(-1L);
+			add(-2L);
+			add(-3L);
+			add( (long)Math.pow(2, 54-1)-1 );
+			add( (long)(Math.pow(2, (54-1)) - Math.pow(2, 54)) );
+		}};
+
+		return obj;
+	}
+
+	public void compare(SignedInt obj1, SignedInt obj2) {
+		for (int i = 0; i < obj1.list1.size(); i++){
+			System.out.println("Ser = " + obj1.list1.get(i) + ", Deser = " + obj2.list1.get(i));
+		}		
+		for (int i = 0; i < obj1.list2.size(); i++){
+			System.out.println("Ser = " + obj1.list2.get(i) + ", Deser = " + obj2.list2.get(i));
+		}
+	}
+
+	public void serialize(Divine obj) throws IOException {
+		byte[] data = obj.serialize();
+		File file = new File("bin.babel");
+		try {
+			new FileOutputStream(file).write(data);
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
+
+	public byte[] deserialize() throws IOException{
+		File file = new File("bin.babel");
+		byte[] data = new byte[(int) file.length()];
+		try {
+			new FileInputStream(file).read(data);
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+		return data;
+	}
+
+}
+```
+And a C# example that uses the generated file test.cs
+```csharp
+using System;
+using System.Collections.Generic;
+using System.Text;
+using System.IO;
+using divine;
+
+namespace test
+{
+    class divine
+    {
+        public static void Main(String[] args)
+        {
+            SignedInt ser = buildObj();
+            serialize(ser);
+            byte[] res = deserialize();
+
+            SignedInt deser = new SignedInt();
+            deser.deserialize(new MemoryStream(res));
+
+            compare(ser, deser);
+   
+            System.Console.Read();
+            
+        }
+
+        public static SignedInt buildObj() {
+		SignedInt obj = new SignedInt();
+		obj.list1.Add(-1);
+		obj.list1.Add(-2);
+		obj.list1.Add(-3);
+		obj.list1.Add(int.MaxValue);
+		obj.list1.Add(int.MinValue);
+
+		obj.list2.Add(-1);
+		obj.list2.Add(-2);
+		obj.list2.Add(-3);
+		obj.list2.Add( (long) Math.Pow(2, 53) -1 );
+		obj.list2.Add( (long) (Math.Pow(2, 53) - Math.Pow(2, 54)) );
+            return obj;
+	    }
+
+        public static void compare(SignedInt obj1, SignedInt obj2)
+        {
+            for (int i = 0; i < obj1.list1.Count; i++)
+            {
+                System.Console.Write("Ser = " + obj1.list1[i] + ", Deser = " + obj2.list1[i] + "\n");
+            }
+            for (int i = 0; i < obj1.list2.Count; i++)
+            {
+                System.Console.Write("Ser = " + obj1.list2[i] + ", Deser = " + obj2.list2[i] + "\n");
+            }
+        }
+
+        public static void serialize(Divine obj)
+        {
+            try
+            {
+                byte[] data = obj.serialize();
+                File.WriteAllBytes("bin.babel", data);                
+            }
+            catch (System.IO.IOException ex)
+            {
+                throw ex;
+            }
+	}
+
+	public static byte[] deserialize()
+	{
+            try
+            {
+                byte[] data = File.ReadAllBytes("bin.babel");
+                return data;
+            }
+            catch (System.IO.IOException ex)
+            {
+                throw ex;
+            }
+	}
+            
+    }
+}
+```
+
 ### Versioning
 ```ruby
 require 'divine'
@@ -164,7 +437,17 @@ Divine::GraphGenerator.new.draw(".", "graph", "jpg")
 ```
 
 
+## Caveats
+Javascript does only support numbers in the range of -9,007,199,254,740,992 to 9,007,199,254,740,991, a runtime error is thrown if you try to deserialize bigger number.
+
+
 ## Change log
+Version 0.0.5
+
+* Adapted to docile 1.1.5
+* Removed short_binary
+
+
 Version 0.0.4
 
 * Added dint63 (Dynamic Int 63)
@@ -173,7 +456,7 @@ Version 0.0.4
 Version 0.0.3
 
 * Added C# code generator
-* Added sint64 (Signed Int 64)
+* Added sint32 and sint64 (Signed Int 32 and 64)
 * Added versioning and freezing
 
 

data/divine.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   
-  gem.add_dependency(%q<docile>, [">= 1.0.0"])
+  gem.add_dependency(%q<docile>, [">= 1.1.0"])
   gem.add_dependency(%q<erubis>, [">= 2.7.0"])
-  gem.add_dependency(%q<ruby-graphviz>, [">= 1.0.8"])
+  gem.add_dependency(%q<ruby-graphviz>, [">= 1.2.0"])
 end

data/lib/divine/code_generators/csharp.rb

@@ -105,7 +105,7 @@ namespace divine
             // Force utf8
             try
             {
-                return System.Text.Encoding.UTF8.GetString(readBytes(readInt16(data), data));
+                return System.Text.Encoding.UTF8.GetString(readBytes((int)readDint63(data), data));
             }
             catch (System.IO.IOException ex)
             {
@@ -131,7 +131,7 @@ namespace divine
         {
             try
             {
-                long c = readInt32(data);
+                long c = readDint63(data);
                 if (c > int.MaxValue)
                 {
                     throw new System.IndexOutOfRangeException("Binary data to big for csharp");
@@ -144,23 +144,11 @@ namespace divine
             }
         }
 
-        protected byte[] readShortBinary(MemoryStream data)
-        {
-            try
-            {
-                return readBytes(readInt8(data), data);
-            }
-            catch (System.IO.IOException ex)
-            {
-                throw ex;
-            }
-        }
-
         protected String readIpNumber(MemoryStream data)
         {
             try
             {
-                byte[] ips = readShortBinary(data);
+                byte[] ips = readBytes(readInt8(data), data);
                 if (ips.Length == 4)
                 {
                     return readIpv4Number(ips);
@@ -313,7 +301,7 @@ namespace divine
             for (int i = matches.Count - 1; i >= 0 ; i--)
             {
                 String val = matches[i].Value;
-                val += new String(new char[7 - val.Length]).Replace("\\\\0", "0") + Math.Min(i, 1);
+                val += new String('0', (7 - val.Length)) + Math.Min(i, 1);
                 charArray = val.ToCharArray();
                 Array.Reverse(charArray);
                 String str = new String(charArray);
@@ -338,7 +326,7 @@ namespace divine
                 {
                     raiseError("Too large string: " + bs.Length + " bytes");
                 }
-                writeInt16((ushort)bs.Length, output);
+                writeDint63((long)bs.Length, output);
                 output.Write(bs, 0, bs.Length);
             }
             catch (System.IO.IOException ex)
@@ -355,7 +343,7 @@ namespace divine
                 {
                     raiseError("Too large binary: " + v.Length + " bytes");
                 }
-                writeInt32((uint)v.Length, output);
+                writeDint63((long)v.Length, output);
                 output.Write(v, 0, v.Length);
             }
             catch (System.IO.IOException ex)
@@ -384,23 +372,6 @@ namespace divine
             }
         }
 
-        protected void writeShortBinary(byte[] v, MemoryStream output)
-        {
-            try
-            {
-                if (v.Length > 0xFF)
-                {
-                    raiseError("Too large short_binary: " + v.Length + " bytes");
-                }
-                writeInt8((byte)v.Length, output);
-                output.Write(v, 0, v.Length);
-            }
-            catch (System.IO.IOException ex)
-            {
-                throw ex;
-            }
-        }
-
         protected void writeIpNumber(String v, MemoryStream output)
         {
             try
@@ -437,7 +408,8 @@ namespace divine
                 }
                 if (ss.Length == 0 || ss.Length == 4)
                 {
-                    writeShortBinary(ss, output);
+                    writeInt8((byte)ss.Length, output);
+                    output.Write(ss, 0, ss.Length);
                 }
                 else
                 {
@@ -627,7 +599,6 @@ EOS
 #  * string   --> ""
 #  * ip_number--> ""
 #  * binary   --> new byte[0]
-#  * short_binary --> new byte[0]
 #  * list     --> new List<type>()
 #  * map      --> new Dictionary<keyType, valueType>()
 
@@ -650,12 +621,14 @@ EOS
 
       else
         case types
-        when :binary, :short_binary
+        when :binary
           "new byte[0]"
         when :int8, :int16, :int32, :sint32, :sint64, :dint63
           "0"
         when :string, :ip_number
           "\"\""
+        when :bool
+          "false"
         else
           if $all_structs[types]
             types
@@ -677,7 +650,6 @@ EOS
 #  * string   --> string
 #  * ip_number--> string
 #  * binary   --> byte[]
-#  * short_binary --> byte[]
 #  * list     --> List<type>
 #  * map      --> Dictionary<keyType, valueType>
  
@@ -703,20 +675,22 @@ EOS
 
       else
         case types
-        when :binary, :short_binary
+        when :binary
           "byte[]"
         when :int8
-	  "byte"
-	when :int16
-	  "ushort"
-	when :int32
+      	  "byte"
+      	when :int16
+      	  "ushort"
+      	when :int32
           "uint"
         when :sint32
-  	  "int"
-	when :sint64, :dint63
+      	  "int"
+      	when :sint64, :dint63
           "long"
         when :string, :ip_number
           "string"
+        when :bool
+          "bool"
         else
           if $all_structs[types]
             types
@@ -739,7 +713,7 @@ EOS
           nv = get_fresh_variable_name
           idx = get_fresh_variable_name
           return [
-                  "writeInt32((uint)#{var}.Count, baos);",
+                  "writeDint63((long)#{var}.Count, baos);",
                   "for(int #{idx}=0; #{idx}<#{var}.Count; #{idx}++) {",
                   :indent,
                   "#{csharp_get_type_declaration types[1]} #{nv} = #{var}[#{idx}];",
@@ -751,7 +725,7 @@ EOS
           nv1 = get_fresh_variable_name      
           nv2 = get_fresh_variable_name
           return [
-                  "writeInt32((uint)#{var}.Count, baos);",
+                  "writeDint63((long)#{var}.Count, baos);",
                   "foreach (#{csharp_get_type_declaration types[1]} #{nv1} in #{var}.Keys) {",
                   :indent,
                   "#{csharp_get_type_declaration types[2]} #{nv2} = #{var}[#{nv1}];",
@@ -791,7 +765,7 @@ EOS
           iter = get_fresh_variable_name
           return [
                   "#{"#{csharp_get_type_declaration(types)} " unless var.include? "this."}#{var} = #{csharp_get_empty_declaration(types)};",
-                  "uint #{count} = this.readInt32(bais);",
+                  "uint #{count} = (uint)this.readDint63(bais);",
                   "for(int #{iter}=0; #{iter}<#{count}; #{iter}++) {",
                   :indent,
                   csharp_deserialize_internal(nv, types[1]),
@@ -805,7 +779,7 @@ EOS
           nv2 = get_fresh_variable_name
           iter = get_fresh_variable_name
           return ["#{"#{csharp_get_type_declaration(types)} " unless var.include? "this."}#{var} = #{csharp_get_empty_declaration(types)};",
-                  "uint #{count} = readInt32(bais);",
+                  "uint #{count} = (uint)readDint63(bais);",
                   "for(int #{iter}=0; #{iter}<#{count}; #{iter}++) {",
                   :indent,
                   csharp_deserialize_internal(nv1, types[1]),