cauterize 0.0.1.pre9 → 0.0.1.pre10

data/.gitignore

@@ -21,9 +21,7 @@ Gemfile.lock
 pkg
 
 # Examples
-example/cauterize_output
-example/c_cauterize_output
-example/cs_cauterize_output
+example/*_cauterize_output
 
 # Nunit test results
 TestResult.xml

data/example/build.sh

@@ -18,3 +18,5 @@ rm -rf cs_cauterize_output
 
 dmcs cs_cauterize_output/*.cs -target:library -out:cs_cauterize_output/example_project.dll
 
+rm -rf ruby_cauterize_output
+../bin/cauterize generate ruby ruby_cauterize_output

data/lib/cauterize/base_type.rb

@@ -1,9 +1,9 @@
 require 'set'
+require 'digest'
 
 module Cauterize
   class BaseType
-    attr_reader :name, :id, :description
-    @@next_id = {}
+    attr_reader :name, :description
     @@instances = {}
 
     def initialize(name, description=nil)
@@ -13,42 +13,25 @@ module Cauterize
 
       @name = name
       @description = description
-      @id = next_id
       register_instance(self)
     end
 
-    def type
-      tag_part = ((tag << BaseType.id_bit_width) & BaseType.tag_bit_mask)
-      id_part  = (id & BaseType.id_bit_mask)
-      (tag_part | id_part) & BaseType.type_bit_mask
+    def type_hash(digest = nil)
+      digest ||= BaseType.digest_class.new
+      digest.update(@name.to_s)
+      local_hash(digest)
     end
 
-    def type_str
-      "0x%04X" % type
-    end
+    def self.all_instances; @@instances.values end
 
-    def tag
-      cname = self.class.name
-      case cname
-      when "Cauterize::Scalar";        0
-      when "Cauterize::Enumeration";   1
-      when "Cauterize::Composite";     2
-      when "Cauterize::FixedArray";    3
-      when "Cauterize::VariableArray"; 4
-      when "Cauterize::Group";         5
-      else
-        raise Exception.new("Tag not defined for #{cname}.")
-      end
+    def self.model_hash
+      @@instances.keys.sort.map do |k|
+        @@instances[k]
+      end.inject(BaseType.digest_class.new) do |d, i|
+        i.type_hash(d)
+      end.digest
     end
 
-    def self.tag_bit_mask;  0xE000 end
-    def self.tag_bit_width;      3 end
-    def self.id_bit_mask;   0x1FFF end
-    def self.id_bit_width;      13 end
-    def self.type_bit_mask; 0xFFFF end
-    def self.type_bit_width; tag_bit_width + id_bit_width end
-    def self.all_instances; @@instances.values end
-
     def self.find_type(name)
       @@instances[name]
     end
@@ -61,6 +44,10 @@ module Cauterize
       end
     end
 
+    def self.digest_class
+      Digest::SHA1
+    end
+
     alias :orig_method_missing :method_missing
 
     def method_missing(sym, *args)
@@ -74,6 +61,12 @@ module Cauterize
 
     protected
 
+    # local_hash is responsible for hashing the things in the type that
+    # are not known about in the BaseType parent class.
+    def local_hash(digest)
+      raise Exception.new("All instances of BaseType (including #{self.class}) must implement local_hash.")
+    end
+
     def register_instance(inst)
       if @@instances[inst.name]
         raise Exception.new("Type with name #{inst.name} already defined.")
@@ -81,14 +74,5 @@ module Cauterize
 
       @@instances[inst.name] = inst
     end
-
-    def next_id
-      cname = self.class.name
-      @@next_id[cname] ||= 0
-
-      an_id = @@next_id[cname]
-      @@next_id[cname] += 1
-      return an_id
-    end
   end
 end

data/lib/cauterize/builtin.rb

@@ -48,6 +48,13 @@ module Cauterize
         @byte_length
       end
     end
+
+    protected
+
+    def local_hash(digest)
+      digest.update(@flavor.to_s)
+      digest.update(@byte_length.to_s)
+    end
   end
 
   # Create all the builtin types.

data/lib/cauterize/c_builder.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'digest'
 
 module Cauterize
   class CBuilder
@@ -32,6 +33,10 @@ module Cauterize
       f << "#define GEN_DATE (\"#{DateTime.now.to_s}\")"
       f.blank_line
 
+      f << "#define MODEL_HASH_LEN (#{BaseType.digest_class.new.length})"
+      f << "#define MODEL_HASH {#{BaseType.model_hash.bytes.to_a.join(", ")}}"
+      f.blank_line
+
       instances = BaseType.all_instances
       builders = instances.map {|i| Builders.get(:c, i)}
 

data/lib/cauterize/composite.rb

@@ -30,6 +30,11 @@ module Cauterize
       @type = BaseType.find_type!(type_name)
       @description = desc
     end
+
+    def field_hash(digest)
+      digest.update(@name.to_s)
+      @type.type_hash(digest)
+    end
   end
 
   class Composite < BaseType
@@ -47,5 +52,13 @@ module Cauterize
         @fields[name] = CompositeField.new(name, type, desc)
       end
     end
+
+    protected
+
+    def local_hash(digest)
+      @fields.keys.inject(digest) {|d, k|
+        @fields[k].field_hash(digest)
+      }
+    end
   end
 end

data/lib/cauterize/cs_builder.rb

@@ -31,7 +31,9 @@ module Cauterize
           f.braces do
             f << "Name = \"#{@name}\","
             f << "GeneratedVersion = \"#{Cauterize.get_version}\","
-            f << "GeneratedDate = \"#{DateTime.now.to_s}\""
+            f << "GeneratedDate = \"#{DateTime.now.to_s}\","
+            f << "ModelHashLength = #{BaseType.digest_class.new.length},"
+            f << "ModelHash = new byte[] {#{BaseType.model_hash.bytes.to_a.join(", ")}}"
           end
           f << ";"
         end

data/lib/cauterize/enumeration.rb

@@ -31,6 +31,11 @@ module Cauterize
       @name = name
       @value = value
     end
+
+    def value_hash(digest)
+      digest.update(@name.to_s)
+      digest.update(@value.to_s)
+    end
   end
 
   class Enumeration < BaseType
@@ -69,12 +74,21 @@ module Cauterize
         raise Exception.new("Unable to represent enumeration (#{min_val} -> #{max_val})")
       end
     end
+    
+    protected
+
+    def local_hash(digest)
+      representation.type_hash(digest)
+      values.keys.sort.inject(digest) {|d, k|
+        values[k].value_hash(digest)
+      }
+    end
 
     private
 
     def value_id(next_id=nil)
       if next_id
-        @value_id = next_id
+        @value_id = next_id.to_i
       end
 
       v = @value_id

data/lib/cauterize/fixed_array.rb

@@ -39,5 +39,12 @@ module Cauterize
         @array_size
       end
     end
+
+    protected
+
+    def local_hash(digest)
+      digest.update(@array_size.to_s)
+      @array_type.type_hash(digest)
+    end
   end
 end

data/lib/cauterize/group.rb

@@ -27,6 +27,15 @@ module Cauterize
       @type = BaseType.find_type!(type) if type
       @description = desc
     end
+
+    def field_hash(digest)
+      digest.update(@name.to_s)
+      if @type
+        @type.type_hash(digest)
+      else 
+        digest
+      end
+    end
   end
 
   class Group < BaseType
@@ -59,5 +68,14 @@ module Cauterize
     def enum_sym(fname)
       "group_#{@name}_type_#{fname}".up_snake.to_sym
     end
+
+    protected
+
+    def local_hash(digest)
+      @tag_enum.type_hash(digest)
+      @fields.keys.inject(digest) {|d, k|
+        @fields[k].field_hash(digest)
+      }
+    end
   end
 end

data/lib/cauterize/ruby_builder.rb

@@ -20,6 +20,14 @@ module Cauterize
       f << "require_relative './cauterize_ruby_builtins'"
       f << ""
 
+      f << "CAUTERIZE_GEN_VERSION = \"#{Cauterize.get_version}\""
+      f << "CAUTERIZE_GEN_DATE = \"#{DateTime.now.to_s}\""
+      f << ""
+
+      f << "CAUTERIZE_MODEL_HASH_LEN = #{BaseType.digest_class.new.length}"
+      f << "CAUTERIZE_MODEL_HASH = [#{BaseType.model_hash.bytes.to_a.join(", ")}]"
+      f << ""
+
       instances = BaseType.all_instances
       builders = instances.map {|i| Builders.get(:ruby, i)}
       builders.each { |b| b.class_defn(f) }

data/lib/cauterize/scalar.rb

@@ -43,5 +43,11 @@ module Cauterize
         @type_name
       end
     end
+
+    protected
+
+    def local_hash(digest)
+      @type_name.type_hash(digest)
+    end
   end
 end

data/lib/cauterize/variable_array.rb

@@ -52,5 +52,13 @@ module Cauterize
         @size_type
       end
     end
+
+    protected
+
+    def local_hash(digest)
+      digest.update(@array_size.to_s)
+      @array_type.type_hash(digest)
+      @size_type.type_hash(digest)
+    end
   end
 end

data/lib/cauterize/version.rb

@@ -1,3 +1,3 @@
 module Cauterize
-  VERSION = "0.0.1.pre9"
+  VERSION = "0.0.1.pre10"
 end

data/spec/base_type_spec.rb

@@ -2,10 +2,6 @@ module Cauterize
 
   describe Cauterize do
     describe BaseType do
-      describe :id do
-        it { has_a_unique_id_for_each_instance(BaseType) }
-      end
-
       describe :description do
         it "handles nil description" do
           BaseType.new(:foo, nil).description.should be_nil
@@ -16,62 +12,6 @@ module Cauterize
         end
       end
 
-      describe :type_str do
-        it "is the hexadecimal representation of type" do
-          f = Cauterize.enumeration(:foo) do |e|
-            e.value :a, 1
-          end
-
-          b = Cauterize.enumeration(:bar) do |e|
-            e.value :a, 1
-          end
-
-          b.type_str.should == "0x2001"
-        end
-      end
-
-      describe :tag do
-        it { is_tagged_as(Scalar, 0) }
-        it { is_tagged_as(Enumeration, 1) }
-        it { is_tagged_as(Composite, 2) }
-        it { is_tagged_as(FixedArray, 3) }
-        it { is_tagged_as(VariableArray, 4) }
-        it { is_tagged_as(Group, 5) }
-      end
-
-      describe :next_id do
-        it "is an incrementing value starting at 0" do
-          # the .new consumes the 0.
-          BaseType.new(:foo).instance_exec do
-            next_id.should == 1
-            next_id.should == 2
-            next_id.should == 3
-            next_id.should == 4
-          end
-        end
-
-        it "should not allow derived class ids to interact" do
-          a1 = Scalar.new(:uint8_t)
-          a2 = Scalar.new(:uint64_t)
-          e1 = Enumeration.new(:zoop)
-          e2 = Enumeration.new(:nih)
-
-          a1.id.should == 0
-          a2.id.should == 1
-          e1.id.should == 0
-          e2.id.should == 1
-        end
-      end
-
-      describe "bit stuff" do
-        it "is consistent" do
-          BaseType.class_exec do
-            (tag_bit_width + id_bit_width).should == type_bit_width
-            (tag_bit_mask >> id_bit_width).should == 0x7
-          end
-        end
-      end
-
       describe :register_instance do
         it "adds an instance to the instance list" do
           orig_len = BaseType.all_instances.length
@@ -122,6 +62,132 @@ module Cauterize
         end
       end
 
+      describe :type_hash do
+        it "is different for objects with different names" do
+          f = Cauterize.scalar(:foo) {|t| t.type_name :uint8}.type_hash
+          g = Cauterize.scalar(:bar) {|t| t.type_name :uint8}.type_hash
+
+          f.should_not == g
+        end
+
+        it "is different for objects with different types" do
+          f = Cauterize.scalar(:foo) {|t| t.type_name :uint8}.type_hash
+          reset_for_test
+
+          g = Cauterize.scalar(:foo) {|t| t.type_name :int8}.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differes on enumeration value differences" do
+          f = Cauterize.enumeration(:foo) { |t| t.value :a, 0 }.type_hash
+          reset_for_test
+
+          g = Cauterize.enumeration(:foo) { |t| t.value :a, 1 }.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differs on differing length in fixed arrays" do
+          f = Cauterize.fixed_array(:foo) { |t| t.array_type :int8; t.array_size 1 }.type_hash
+          reset_for_test
+
+          g = Cauterize.fixed_array(:foo) { |t| t.array_type :int8; t.array_size 2 }.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differs on differing size type in variable arrays" do
+          f = Cauterize.variable_array(:foo) { |t| t.array_type :int8; t.array_size 2; t.size_type :uint8 }.type_hash
+          reset_for_test
+
+          g = Cauterize.variable_array(:foo) { |t| t.array_type :int8; t.array_size 2; t.size_type :uint16 }.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differs on group field reordering" do
+          f = Cauterize.group(:foo) do |t|
+            t.field :a, :int8
+            t.field :b, :int8
+          end.type_hash
+          reset_for_test
+
+          g = Cauterize.group(:foo) do |t|
+            t.field :b, :int8
+            t.field :a, :int8
+          end.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differs on composite field reordering" do
+          f = Cauterize.composite(:foo) do |t|
+            t.field :a, :int8
+            t.field :b, :int8
+          end.type_hash
+          reset_for_test
+
+          g = Cauterize.composite(:foo) do |t|
+            t.field :b, :int8
+            t.field :a, :int8
+          end.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+
+        it "differs on changes in indirect fields" do
+          Cauterize.scalar(:a_thing) { |t| t.type_name :int8 }
+          f = Cauterize.composite(:foo) do |t|
+            t.field :a, :a_thing
+          end.type_hash
+          reset_for_test
+
+          Cauterize.scalar(:a_thing) { |t| t.type_name :uint8 }
+          g = Cauterize.composite(:foo) do |t|
+            t.field :a, :a_thing
+          end.type_hash
+          reset_for_test
+
+          f.should_not == g
+        end
+      end
+
+      describe :model_hash do
+        it "returns a SHA1 of the model" do
+          Cauterize.scalar(:foo) {|t| t.type_name :uint8}
+
+          h = BaseType.model_hash
+          h.should_not be_nil
+          h.length.should == 20 # length of sha1
+        end
+
+        it "is supported by all the types" do
+          gen_a_model
+          h = BaseType.model_hash
+          h.should_not be_nil
+          h.length.should == 20 # length of sha1
+        end
+
+        it "differs on different models" do
+          gen_a_model
+          a = BaseType.model_hash
+          reset_for_test
+
+          gen_b_model
+          b = BaseType.model_hash
+          reset_for_test
+
+          a.should_not == b
+        end
+      end
+
       describe :find_type do
         it "returns the instance with the provided name" do
           f = Cauterize.scalar(:foo)

data/spec/builtin_spec.rb

@@ -14,13 +14,6 @@ module Cauterize
     end
 
     it { can_be_documented(BuiltIn) }
-
-    describe :id do
-     it "has a unique id for each builtin" do
-       ids = Cauterize.builtins.values.map(&:id)
-       ids.uniq.should =~ ids
-     end
-    end
   end
 
 

data/spec/fixed_array_spec.rb

@@ -19,7 +19,6 @@ module Cauterize
     describe :initialize do
       it "Creates a fixed array." do
         @a.name.should == :foo
-        @a.id.should_not be_nil
       end
     end
 

data/spec/scalar_spec.rb

@@ -8,10 +8,6 @@ module Cauterize
 
     it { can_be_documented(Cauterize::Scalar) }
 
-    describe :id do
-      it { has_a_unique_id_for_each_instance(Scalar) }
-    end
-
     describe :type_name do
       it "specifies the builtin type to alias" do
         s = Cauterize.scalar(:foo) do |t|

data/spec/spec_helper.rb

@@ -43,12 +43,6 @@ module Cauterize
       cls.new(:foo).tag.should == tag
     end
 
-    def has_a_unique_id_for_each_instance(cls)
-      cls.new(:foo).id.should == 0
-      cls.new(:bar).id.should == 1
-      cls.new(:baz).id.should == 2
-    end
-
     def creates_a_named_object(fn_sym, obj)
       fn = Cauterize.method(fn_sym)
       a = fn.call(:foo)

data/spec/support/spec_sample_model.rb

@@ -0,0 +1,76 @@
+module Cauterize
+  module CauterizeHelpers
+    def gen_a_model
+      Cauterize.scalar(:foo) do |t|
+        t.type_name :uint8
+      end
+
+      Cauterize.enumeration(:color) do |e|
+        e.value :red
+        e.value :blue
+        e.value :green
+      end
+
+      Cauterize.fixed_array(:color_list) do |a|
+        a.array_type :color
+        a.array_size 41
+      end
+
+      Cauterize.variable_array(:int8_list) do |a|
+        a.size_type  :uint8
+        a.array_type :int8
+        a.array_size 200
+      end
+
+      Cauterize.composite(:two_things) do |t|
+        t.field :thing_1, :uint8
+        t.field :thing_2, :uint16
+      end
+
+      Cauterize.group(:one_of_everything) do |t|
+        t.field :a_foo, :foo
+        t.field :a_color, :color
+        t.field :a_color_list, :color_list
+        t.field :an_int8_list, :int8_list
+        t.field :a_two_things, :two_things
+      end
+    end
+
+    def gen_b_model
+      Cauterize.scalar(:foo) do |t|
+        t.type_name :uint8
+      end
+
+      Cauterize.enumeration(:color) do |e|
+        e.value :red
+        e.value :blue
+        e.value :green
+      end
+
+      Cauterize.fixed_array(:color_list) do |a|
+        a.array_type :color
+        a.array_size 41
+      end
+
+      Cauterize.variable_array(:int8_list) do |a|
+        a.size_type  :uint8
+        a.array_type :int8
+        a.array_size 200
+      end
+
+      Cauterize.composite(:two_things) do |t|
+        t.field :thing_1, :uint8
+        t.field :thing_2, :uint16
+      end
+
+      Cauterize.group(:one_of_everything) do |t|
+        t.field :a_foo, :foo
+        t.field :a_color, :color
+        t.field :a_color_list, :color_list
+        t.field :an_int8_list, :int8_list
+        t.field :a_two_things, :two_things
+        t.dataless :emptyness
+      end
+    end
+  end
+end

data/support/cs/src/CauterizeTypes.cs

@@ -6,6 +6,8 @@ namespace Cauterize
         public string Name;
         public string GeneratedVersion;
         public string GeneratedDate;
+        public int ModelHashLength;
+        public byte[] ModelHash;
     }
 
     public class CauterizeComposite

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cauterize
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre9
+  version: 0.0.1.pre10
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -212,6 +212,7 @@ files:
 - spec/support/shared_examples_for_c_buildables.rb
 - spec/support/shared_examples_for_sane_c_buildables.rb
 - spec/support/shared_examples_for_stubbed_functions.rb
+- spec/support/spec_sample_model.rb
 - spec/test_main.c
 - spec/variable_array_spec.rb
 - support/c/src/cauterize.c
@@ -262,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -966914952996441061
+      hash: 3445789086503525251
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -310,5 +311,6 @@ test_files:
 - spec/support/shared_examples_for_c_buildables.rb
 - spec/support/shared_examples_for_sane_c_buildables.rb
 - spec/support/shared_examples_for_stubbed_functions.rb
+- spec/support/spec_sample_model.rb
 - spec/test_main.c
 - spec/variable_array_spec.rb