divine 0.0.3 → 0.0.4

data/lib/divine/code_generators/java.rb

@@ -1,15 +1,32 @@
 module Divine
 
+##
+# * +Java Helper+ :
+# Support base function needed to build Divine enviroment and classes corresponding to DSL structs
+#
   class JavaHelperMethods < BabelHelperMethods
+
+    #
+    # Return the header comment
+    #
     def get_header_comment
       get_header_comment_text.map do |s|
         "// #{s}"
       end.join("\n")
     end
     
+##
+# Generate the base Divine Java Class
+# that contains the main methods:
+# * serialize
+# * serialize Internal
+# * deserialize
+# * Read Methods
+# * Write Methods
+
     def java_base_class_template_str
       <<EOS
-abstract class BabelBase <%= toplevel_class %> {
+abstract class Divine <%= toplevel_class %> {
 	private static final Charset UTF8 = Charset.forName("UTF-8");
 
 	public byte[] serialize() throws IOException {
@@ -47,6 +64,17 @@ abstract class BabelBase <%= toplevel_class %> {
 		return (readInt32(data) << 32) | (readInt32(data) & 0xFFFFFFFFL);
 	}
 
+	protected long readDint63(ByteArrayInputStream data) {
+		int b = readInt8(data);
+		long val = b & 0x7F;
+		while((b >> 7) == 1){
+			b = readInt8(data);
+			val = val << 7;
+			val = val | b & 0x7F;
+		}
+		return val;
+	}
+
 	protected boolean readBool(ByteArrayInputStream data) {
 		return readInt8(data) == 1;
 	}
@@ -161,14 +189,30 @@ abstract class BabelBase <%= toplevel_class %> {
 
 	protected void writeSint64(long v, ByteArrayOutputStream out) {
 		if (v > Long.MAX_VALUE) { 		// Max  9,223,372,036,854,775,807
-			raiseError("Too large sInt64 number: " + v + ", Max = " + Integer.MAX_VALUE);
-		}else if(v < Long.MIN_VALUE){ 		// Min -9,223,372,036,854,775,807
-			raiseError("Too small sInt64 number: " + v + ", Min = " + Integer.MIN_VALUE);
+			raiseError("Too large sInt64 number: " + v + ", Max = " + Long.MAX_VALUE);
+		}else if(v < Long.MIN_VALUE){ 		// Min -9,223,372,036,854,775,808
+			raiseError("Too small sInt64 number: " + v + ", Min = " + Long.MIN_VALUE);
 		}
 		writeInt32(((v >> 32) & 0xFFFFFFFFL), out);
 		writeInt32( (v & 0xFFFFFFFFL) , out);
 	}
 
+	protected void writeDint63(long v, ByteArrayOutputStream out) {
+		if (v > Long.MAX_VALUE) { 	// Max  9,223,372,036,854,775,807
+			raiseError("Too large Dynamic Int64 number: " + v + ", Max = " + Long.MAX_VALUE);
+		}else if(v < 0){ 		// Min 0
+			raiseError("Too small Dynamic Int64 number: " + v + ", Min = " + 0);
+		}
+		String[] bytes = new StringBuffer(Long.toBinaryString(v)).reverse().toString().split("(?<=\\\\G.......)");
+		
+		for (int i = bytes.length - 1; i >= 0; i--){
+			String s = bytes[i];
+			s += new String(new char[7 - s.length()]).replace("\\\\0", "0") + Math.min(i, 1);
+			int t = Integer.parseInt(new StringBuffer(s).reverse().toString(), 2);
+			this.writeInt8(t, out);
+		}
+	}
+
 	protected void writeBool(boolean v, ByteArrayOutputStream out) {
 		writeInt8(v ? 1 : 0, out);
 	}
@@ -276,9 +320,13 @@ abstract class BabelBase <%= toplevel_class %> {
 EOS
     end
 
+##
+#  Generate Java Class that corresponding to the struct definition
+#  * *Args*    :
+#   - +sh+ -> Struct Name
     def java_class_template(sh)
       code = [
-        "class #{sh.name} extends BabelBase {",
+        "class #{sh.name} extends Divine {",
         :indent,
         "",
 
@@ -354,6 +402,30 @@ EOS
       format_src(3, 3, code)
     end
     
+##
+#  Generate default java data types declaration values corresponding to each DSL types:
+#  * DSL Type --> Corresponding Default Java Value
+#  * dint63   --> 0 range -> [0 - 9,223,372,036,854,775,807]
+#   * 1 byte:  range ->  [0 - 127]
+#   * 2 bytes: range ->  [0 - 16,383]
+#   * 3 bytes: range ->  [0 - 2,097,151]
+#   * 4 bytes: range ->  [0 - 268,435,455]
+#   * 5 bytes: range ->  [0 - 34,359,738,367]
+#   * 6 bytes: range ->  [0 - 4,398,046,511,103]
+#   * 7 bytes: range ->  [0 - 562,949,953,421,311]
+#   * 8 bytes: range ->  [0 - 72,057,594,037,927,935]
+#   * 9 bytes: range ->  [0 - 9,223,372,036,854,775,807]
+#  * int8     --> 0  Range -> [0 - 255]
+#  * int16    --> 0  Range -> [0 - 65535]
+#  * int32    --> 0L Range -> [0 - 4.294.967.295]
+#  * sint32   --> 0  Range -> [-2.147.483.648 - 2.147.483.647]
+#  * sint64   --> 0L Range -> [-9.223.372.036.854.775.808, 9.223.372.036.854.775.807]
+#  * string   --> ""
+#  * ip_number--> ""
+#  * binary   --> new Byte[0]
+#  * short_binary --> new Byte[0]
+#  * list     --> new ArrayList<type>()
+#  * map      --> new HashMap<keyType, valueType>()
 
     def java_get_empty_declaration(types, is_reference_type = false)
       if types.respond_to? :referenced_types
@@ -378,7 +450,7 @@ EOS
           is_reference_type ? "new Byte[0]" : "new byte[0]"
         when :int8, :int16, :sint32
           "0"
-        when :int32, :sint64
+        when :int32, :sint64, :dint63
           "0L"
         when :string, :ip_number
           "\"\""
@@ -391,7 +463,23 @@ EOS
         end
       end
     end
-    
+
+##
+#  Generate java data types declaration corresponding to each DSL type
+#  * DSL Type --> Corresponding Java Type
+#  * int8     --> int
+#  * int16    --> int
+#  * sint32   --> int
+#  * int32    --> long
+#  * sint64   --> long
+#  * dint63   --> long
+#  * string   --> String
+#  * ip_number--> String
+#  * binary   --> Byte[]
+#  * short_binary --> Byte[]
+#  * list     --> ArrayList<type>
+#  * map      --> HashMap<keyType, valueType>
+
     def java_get_type_declaration(types, is_reference_type = false)
       if types.respond_to? :referenced_types
         java_get_type_declaration(types.referenced_types, is_reference_type)
@@ -418,7 +506,7 @@ EOS
           is_reference_type ? "Byte[]" : "byte[]"
         when :int8, :int16, :sint32
           is_reference_type ? "Integer" : "int"
-        when :int32, :sint64
+        when :int32, :sint64, :dint63
           is_reference_type ? "Long" : "long"
         when :string, :ip_number
           "String"
@@ -431,7 +519,12 @@ EOS
         end
       end
     end
-    
+
+##
+#  Generate the way of serializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
     def java_serialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -476,6 +569,11 @@ EOS
       end
     end
 
+##
+#  Generate the way of deserializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
     def java_deserialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -531,8 +629,16 @@ EOS
     end
   end
 
-
+##
+# Responsible for generating Divine and structs classes
+#
   class JavaGenerator < JavaHelperMethods
+
+##
+# Generate Java class(es)
+# * *Args*    :
+#   - +structs+ -> Dictionary of structs
+#   - +opts+    -> Dictionary that contains generation params [file, debug, package, parent_class, target_dir]
     def generate_code(structs, opts)
       $debug_java = true if opts[:debug]
       base_template = Erubis::Eruby.new(java_base_class_template_str)
@@ -548,7 +654,7 @@ EOS
       toplevel = opts[:parent_class] || nil
       toplevel = " extends #{toplevel}" if toplevel
       if opts[:package]
-        res = [{file: "BabelBase.java", src: "#{java_get_begin_module(opts)}public #{base_template.result({ toplevel_class: toplevel })}"}]
+        res = [{file: "Divine.java", src: "#{java_get_begin_module(opts)}public #{base_template.result({ toplevel_class: toplevel })}"}]
 	for cls in src
           res << {file: cls.match(/class (.*) extends/)[1]+".java", src: "#{java_get_begin_module(opts)}public #{cls}"}
         end
@@ -557,7 +663,11 @@ EOS
         return [{file: opts[:file], src: "#{java_get_begin_module(opts)}#{base_template.result({ toplevel_class: toplevel })}\n\n#{src.join("\n\n")}"}]
       end
     end
-  
+##
+# Build package name and list of imports
+# * *Args*    :
+#   - +opts+ -> Dictionary that contains package name in key 'package'  
+#
     def java_get_begin_module(opts)
       str = "#{get_header_comment}\n\n"
       str << "package #{opts[:package]};" if opts[:package]
@@ -565,7 +675,9 @@ EOS
       str << "\n\n"
       return str
     end
-    
+##
+# Generate list of imports needed in generated java classes
+#
     def get_java_imports
       [
         "java.io.ByteArrayInputStream",

data/lib/divine/code_generators/javascript.rb

@@ -6,14 +6,27 @@
 
 module Divine
   $debug_javascript = false
-  
+##
+# * +JS Helper+ :
+# Support base function needed to build base divine functions and DSL structs
+#
   class JavascriptHelperMethods < BabelHelperMethods
+
+    #
+    # Return the header comment
+    #
     def get_header_comment
       get_header_comment_text.map do |s|
         "// #{s}"
       end.join("\n")
     end
-    
+##
+# Generate the base functions of:
+# * serialize
+# * deserialize
+# * Read Methods
+# * Write Methods
+
     def javascript_base_class_template_str
       <<EOS
 // ------------------------------------------------------------ DivineDataReader
@@ -114,6 +127,29 @@ DivineHelper.prototype.read_sint64 = function (data) {
     }
 }
 
+DivineHelper.prototype.read_dint63 = function (data) {
+    var byte = this.read_int8(data)
+    var part1 = part2 = "";				// To hold first 32-bit and second 32-bit respectively
+    var bin =  byte & 0x7F;				// tmp To hold binary string
+    var numBytes = 1;
+    while ((byte >> 7) == 1) {
+      byte = this.read_int8(data)
+      bin = bin << 7
+      bin = bin | byte & 0x7F
+      numBytes ++;
+      if (numBytes == 4 && (byte >> 7) == 1){
+        part1 = bin.toString(2);
+        bin = 1;					// To avoid unshifting of zero
+      }
+    }
+    bin = bin.toString(2);
+    if (bin.length > 1 && part1 != "")
+      bin = bin.substr(1, bin.length);
+    part2 = bin;
+    var val = parseInt(part1 + part2, 2);
+    return val;
+}
+
 DivineHelper.prototype.read_binary = function (data) {
     return data.read(this.read_int32(data));
 };
@@ -230,6 +266,23 @@ DivineHelper.prototype.write_sint64 = function (v, out) {
     this.write_int32(parseInt(part2, 2), out);
 }
 
+DivineHelper.prototype.write_dint63 = function (v, out) {
+    var max =  Math.pow(2, 53) - 1;
+    var min = 0;
+    if (v > max)			// Max  9,007,199,254,740,991
+      this.raise_error("Too large Dynamic Int53 number: " + v + ", Max = " + max);
+    if (v < min)	 		// Min 0
+      this.raise_error("Too small Dynamic Int53 number: " + v + ", Min = " + min);
+    
+    bytes = v.toString(2).split("").reverse().join("").split(/(.{7})/).filter(function(t){if (t != "" ) return true});
+    for (var i = bytes.length - 1; i >= 0; i--){
+       var bin = bytes[i];
+       bin += Array(8 - bin.length).join("0") + Math.min(i,1);
+       var val = parseInt(bin.split("").reverse().join(""), 2);
+       this.write_int8(val, out);  
+    }
+}
+
 DivineHelper.prototype.write_bool = function (v, out) {
     this.write_int8(v ? 1 : 0, out)
 }
@@ -454,6 +507,11 @@ DivineHelper.prototype.raise_error = function (msg) {
 EOS
     end
 
+##
+#  Generate required functions that corresponding to the struct definition
+#  * *Args*    :
+#   - +sh+ -> Struct Name
+
     def javascript_class_template(sh)
       code = [
         "",
@@ -537,6 +595,29 @@ EOS
       format_src(0, 3, code)
     end
 
+##
+#  Generate default JS data types declaration values corresponding to each DSL types:
+#  * DSL Type --> Corresponding Default JS Value
+#  * dint63   --> 0 range -> [0 - 9.007.199.254.740.991]
+#   * 1 byte:  range ->  [0 - 127]
+#   * 2 bytes: range ->  [0 - 16,383]
+#   * 3 bytes: range ->  [0 - 2,097,151]
+#   * 4 bytes: range ->  [0 - 268,435,455]
+#   * 5 bytes: range ->  [0 - 34,359,738,367]
+#   * 6 bytes: range ->  [0 - 4,398,046,511,103]
+#   * 7 bytes: range ->  [0 - 562,949,953,421,311]
+#   * 8 bytes: range ->  [0 - 9.007.199.254.740.991] (limited by 53-bit)
+#  * int8     --> 0 Range -> [0 - 255]
+#  * int16    --> 0 Range -> [0 - 65535]
+#  * int32    --> 0 Range -> [0 - 4.294.967.295]
+#  * sint32   --> 0 Range -> [-2.147.483.648 - 2.147.483.647]
+#  * sint64   --> 0 Range -> [-9.007.199.254.740.992, 9.007.199.254.740.991] (limited by 53-bit)
+#  * string   --> ""
+#  * ip_number--> ""
+#  * binary   --> []
+#  * short_binary --> []
+#  * list     --> []
+#  * map      --> {}
 
     def javascript_get_empty_declaration(field)
       case field.type
@@ -544,7 +625,7 @@ EOS
         "[]"
       when :map
         "{}"
-      when :int8, :int16, :int32, :sint32, :sint64
+      when :int8, :int16, :int32, :sint32, :sint64, :dint63
         "0"
       when :string, :ip_number
         "\"\""
@@ -553,6 +634,12 @@ EOS
       end
     end
 
+##
+#  Generate the way of serializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
+
     def javascript_serialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -600,6 +687,12 @@ EOS
       end
     end
 
+##
+#  Generate the way of deserializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
+
     def javascript_deserialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -656,8 +749,18 @@ EOS
   end
     
 
+##
+# Responsible for generating Divine and structs functions
+#
 
   class JavascriptGenerator < JavascriptHelperMethods
+
+##
+# Generate JS Functions
+# * *Args*    :
+#   - +structs+ -> Dictionary of structs
+#   - +opts+    -> Dictionary that contains generation params [file, debug, parent_class, target_dir]
+
     def generate_code(structs, opts)
       $debug_javascript = true if opts[:debug]
       base_template = Erubis::Eruby.new(javascript_base_class_template_str)
@@ -674,11 +777,15 @@ EOS
       toplevel = " < #{toplevel}" if toplevel 
       return [{file: opts[:file], src: "#{javascript_get_begin_module(opts)}#{base_template.result({ toplevel_class: toplevel })}\n\n#{src.join("\n\n")}#{javascript_get_end_module(opts)}"}]
     end
-  
+
+    #
+    # Build Header Comments
+    #
     def javascript_get_begin_module(opts)
        "#{get_header_comment}\n\n"
     end
 
+    # Do nothing
     def javascript_get_end_module(opts)
       nil
     end

data/lib/divine/code_generators/ruby.rb

@@ -1,15 +1,32 @@
 module Divine
 
+##
+# * +Ruby Helper+ :
+# Support base function needed to build Divine enviroment and classes corresponding to DSL structs
+#
   class RubyHelperMethods < BabelHelperMethods
+
+    #
+    # Return the header comment
+    #
     def get_header_comment
       get_header_comment_text.map do |s|
         "# #{s}"
       end.join("\n")
     end
     
+##
+# Generate the base Divine Ruby Class
+# that contains the main methods:
+# * serialize
+# * serialize Internal
+# * deserialize
+# * Read Methods
+# * Write Methods
+
     def ruby_base_class_template_str
       %q{
-  class BabelBase<%= toplevel_class %>
+  class Divine<%= toplevel_class %>
     public
     def serialize
       out = []
@@ -53,6 +70,17 @@ module Divine
       return num
     end
 
+    def read_dint63(data)
+      byte = read_int8(data)
+      val  = byte & 0x7F
+      while (byte >> 7) == 1
+        byte = read_int8(data)
+        val = val << 7
+        val = val | byte & 0x7F
+      end
+      val
+    end
+
     def read_bool(data)
       read_int8(data) == 1
     end
@@ -145,12 +173,26 @@ module Divine
       v = v.to_i
       max = (2** (64 - 1)) - 1
       min = (2** (64 - 1) ) - (2** 64)
-      raise_error "Too large Sint32 number: #{v} , Max = #{max}" if v > max # Max  2.147.483.647
-      raise_error "Too small sInt32 number: #{v} , Min = #{min}" if v < min # Min -2.147.483.648
+      raise_error "Too large Sint64 number: #{v} , Max = #{max}" if v > max # Max  9.223.372.036.854.775.807
+      raise_error "Too small sInt64 number: #{v} , Min = #{min}" if v < min # Min -9.223.372.036.854.775.808
       write_int32( v >> 32 & 0xFFFFFFFF, out)
       write_int32( v & 0xFFFFFFFF, out)
     end
 
+    def write_dint63(v, out)
+      v = v.to_i
+      max = (2** (64 - 1)) - 1
+      min = 0
+      raise_error "Too large Dynamic int63 number: #{v} , Max = #{max}" if v > max # Max  9.223.372.036.854.775.807
+      raise_error "Too small Dynamic int63 number: #{v} , Min = #{min}" if v < min # Min  0
+      
+      bytes = v.to_s(2).reverse.split(/([01]{7})/).reject{ |t| t == ""}.each_with_index.map{ |t, i| t = t + "0"*(7-t.length) + [i,1].min.to_s}
+      bytes.reverse.map{ |t| 
+                          val = t.reverse.to_i 2
+                          write_int8(val, out)
+                       }
+    end
+
     def write_bool(v, out)
       write_int8(v ? 1 : 0, out)
     end
@@ -279,10 +321,14 @@ module Divine
   end
     }
     end
+##
+#  Generate Ruby Class that corresponding to the struct definition
+#  * *Args*    :
+#   - +sh+ -> Struct Name
 
     def ruby_class_template(sh)
       code = [
-        "class #{sh.name} < BabelBase",
+        "class #{sh.name} < Divine",
         :indent,
         "",
         
@@ -364,7 +410,30 @@ module Divine
         ]
       format_src(0, 3, code)
     end
-
+##
+#  Generate default Ruby data types declaration values corresponding to each DSL types:
+#  * DSL Type --> Corresponding Default Ruby Value
+#  * dint63   --> 0 range -> [0 - 9,223,372,036,854,775,807]
+#   * 1 byte:  range ->  [0 - 127]
+#   * 2 bytes: range ->  [0 - 16,383]
+#   * 3 bytes: range ->  [0 - 2,097,151]
+#   * 4 bytes: range ->  [0 - 268,435,455]
+#   * 5 bytes: range ->  [0 - 34,359,738,367]
+#   * 6 bytes: range ->  [0 - 4,398,046,511,103]
+#   * 7 bytes: range ->  [0 - 562,949,953,421,311]
+#   * 8 bytes: range ->  [0 - 72,057,594,037,927,935]
+#   * 9 bytes: range ->  [0 - 9,223,372,036,854,775,807]
+#  * int8     --> 0 Range -> [0 - 255]
+#  * int16    --> 0 Range -> [0 - 65535]
+#  * int32    --> 0 Range -> [0 - 4.294.967.295]
+#  * sint32   --> 0 Range -> [-2.147.483.648 - 2.147.483.647]
+#  * sint64   --> 0 Range -> [-9.223.372.036.854.775.808, 9.223.372.036.854.775.807]
+#  * string   --> ""
+#  * ip_number--> ""
+#  * binary   --> []
+#  * short_binary --> []
+#  * list     --> []
+#  * map      --> {}
 
     def ruby_get_empty_declaration(field)
       case field.type
@@ -372,7 +441,7 @@ module Divine
         "[]"
       when :map
         "{}"
-      when :int8, :int16, :int32, :sint32, :sint64
+      when :dint63, :int8, :int16, :int32, :sint32, :sint64
         "0"
       when :string, :ip_number
         "\"\""
@@ -381,6 +450,12 @@ module Divine
       end
     end
 
+##
+#  Generate the way of serializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
+
     def ruby_serialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -422,6 +497,12 @@ module Divine
       end
     end
 
+##
+#  Generate the way of deserializing different DSL types
+#  * *Args*    :
+#   - +var+   -> variable name
+#   - +types+ -> variable type
+
     def ruby_deserialize_internal(var, types)
       if types.respond_to? :first
         case types.first
@@ -476,10 +557,17 @@ module Divine
   end
     
 
-
+##
+# Responsible for generating Divine and structs classes
+#
   class RubyGenerator < RubyHelperMethods
     @debug = true
-  
+##
+# Generate Ruby class(es)
+# * *Args*    :
+#   - +structs+ -> Dictionary of structs
+#   - +opts+    -> Dictionary that contains generation params [file, module, parent_class, target_dir]
+
     def generate_code(structs, opts)
       base_template = Erubis::Eruby.new(ruby_base_class_template_str)
       keys = structs.keys.sort
@@ -496,6 +584,11 @@ module Divine
       return [{file: opts[:file], src: "#{get_header_comment}\n#{ruby_get_begin_module(opts)}#{base_template.result({ toplevel_class: toplevel, this: self })}\n\n#{src.join("\n\n")}#{ruby_get_end_module(opts)}"}]
     end
   
+##
+# Build module name
+# * *Args*    :
+#   - +opts+ -> Dictionary contains module name in key module
+
     def ruby_get_begin_module(opts)
       if opts[:module]
         "module #{opts[:module]}\n\n"
@@ -503,7 +596,8 @@ module Divine
         nil
       end
     end
-
+##
+# Ending the module
     def ruby_get_end_module(opts)
       if opts[:module]
         "\n\nend\n"