cauterize 0.0.1.pre5 → 0.0.1.pre7

data/spec/enumeration_spec.rb

@@ -16,6 +16,8 @@ module Cauterize
       end
     end
 
+    it { can_be_documented(Cauterize::Enumeration) }
+
     describe :value do
       it "adds a new value to the enumeration" do
         enum = Cauterize.enumeration(:foo) do |e|

data/spec/fixed_array_spec.rb

@@ -23,6 +23,8 @@ module Cauterize
       end
     end
 
+    it { can_be_documented(Cauterize::FixedArray) }
+
     describe :array_type do
       it "Defines the type of the FixedArray." do
         Cauterize.scalar(:uint32_t)

data/spec/group_spec.rb

@@ -42,6 +42,8 @@ module Cauterize
         end
       end
 
+      it { can_be_documented(Cauterize::Group) }
+
       describe :field do
         it "adds a field to the Group" do
           a = Cauterize.scalar(:aaa)
@@ -85,8 +87,8 @@ module Cauterize
 
         it "allows nil types" do
           grp = Cauterize.group(:empty) do |g|
-            g.field(:a)
-            g.field(:b)
+            g.dataless(:a)
+            g.dataless(:b)
           end
 
           grp.tag_enum.values.keys.should =~ [:GROUP_EMPTY_TYPE_A, :GROUP_EMPTY_TYPE_B]

data/spec/scalar_spec.rb

@@ -6,6 +6,8 @@ module Cauterize
       end
     end
 
+    it { can_be_documented(Cauterize::Scalar) }
+
     describe :id do
       it { has_a_unique_id_for_each_instance(Scalar) }
     end

data/spec/spec_helper.rb

@@ -35,6 +35,10 @@ module Cauterize
       Cauterize.create_builtins
     end
 
+    def can_be_documented(klass)
+      klass.new(:dokumented_klass, "precious documentation").description.should == "precious documentation"
+    end
+
     def is_tagged_as(cls, tag)
       cls.new(:foo).tag.should == tag
     end

data/support/c/src/cauterize.h

@@ -18,7 +18,7 @@ typedef enum cauterize_status {
   CA_ERR_INVALID_LENGTH = 4,
   CA_ERR_INVALUD_TYPE_TAG = 5,
   CA_ERR_INVALID_ENUM_VAL = 6,
-  CA_ERR_GENERAL = UINT32_MAX,
+  CA_ERR_GENERAL = INT32_MAX,
 } CAUTERIZE_STATUS_T;
 
 struct Cauterize {

data/support/cs/src/CauterizeFormatter.cs

@@ -1,9 +1,6 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
-using System.Reflection;
 using System.Runtime.Serialization;
-using System.Text;
 
 namespace Cauterize
 {
@@ -26,8 +23,13 @@ namespace Cauterize
 
         public virtual T Deserialize<T>(Stream serializationStream)
         {
-            var formatter = _formatterFactory.GetFormatter(typeof(T));
-            return (T)formatter.Deserialize(serializationStream, typeof(T));
+            return (T)Deserialize(serializationStream, typeof (T));
+        }
+
+        public virtual object Deserialize(Stream serializationStream, Type t)
+        {
+            var formatter = _formatterFactory.GetFormatter(t);
+            return formatter.Deserialize(serializationStream, t);
         }
 
         public virtual void Serialize(Stream serializationStream, object obj)

data/support/cs/src/CauterizeTypes.cs

@@ -1,21 +1,45 @@
 using System;
-using System.Collections.Generic;
-using System.Text;
 
 namespace Cauterize
 {
     public class CauterizeInfo {
-        public static string Name;
-        public static string GeneratedVersion;
-        public static string GeneratedDate;
+        public string Name;
+        public string GeneratedVersion;
+        public string GeneratedDate;
     }
 
     public class CauterizeComposite
     {
+        public override string ToString()
+        {
+            var result = "{";
+            foreach (var prop in OrderAttribute.GetSortedProperties(GetType()))
+            {
+                result += String.Format("{0}: {1}, ", prop.Name, prop.GetValue(this, null));
+            }
+            result = result.TrimEnd(',', ' ');
+            result += "}";
+            return result;
+        }
     }
 
     public class CauterizeGroup
     {
+        public override string ToString()
+        {
+            var enumProp = OrderAttribute.GetPropertyByOrder(GetType(), 0);
+            var value = enumProp.GetValue(this, null);
+            var index = (int) value + 1;
+            var prop = OrderAttribute.GetPropertyByOrder(GetType(), index);
+            if (prop != null)
+            {
+                return String.Format("({0}: {1})", prop.Name, prop.GetValue(this, null));
+            }
+            else
+            {
+                return String.Format("({0})", value);
+            }
+        }
     }
 
     public abstract class CauterizeFixedArray
@@ -48,6 +72,14 @@ namespace Cauterize
             return array._data;
         }
 
+        public override string ToString()
+        {
+            var result = "[";
+            result += String.Join(", ", _data);
+            result += "]";
+            return result;
+        }
+
         // implicit conversion won't cover slicing
         public T this[int i]
         {
@@ -91,6 +123,14 @@ namespace Cauterize
             return array._data;
         }
 
+        public override string ToString()
+        {
+            var result = "[";
+            result += String.Join(", ", _data);
+            result += "]";
+            return result;
+        }
+
         // implicit conversion won't cover slicing
         public T this[int i]
         {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cauterize
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre5
+  version: 0.0.1.pre7
   prerelease: 6
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2.0
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.2.0
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.16.0
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
@@ -56,15 +56,31 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
   type: :development
@@ -72,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.12.0
 - !ruby/object:Gem::Dependency
@@ -80,7 +96,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.0
   type: :development
@@ -88,7 +104,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.0
 description: Tools to generate C structures and marshalers with a Ruby DSL.
@@ -99,9 +115,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travisci.yml
+- ".gitignore"
+- ".rspec"
+- ".travisci.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,6 +126,9 @@ files:
 - cauterize.gemspec
 - example/Cauterize
 - example/build.sh
+- example/doc_cauterize_output/example_project.txt
+- example/ruby_ex.rb
+- lib/cauterize.rb
 - lib/cauterize/base_type.rb
 - lib/cauterize/builders.rb
 - lib/cauterize/builders/c/buildable.rb
@@ -129,11 +148,20 @@ files:
 - lib/cauterize/builders/cs/group.rb
 - lib/cauterize/builders/cs/scalar.rb
 - lib/cauterize/builders/cs/variable_array.rb
+- lib/cauterize/builders/doc/buildable.rb
+- lib/cauterize/builders/doc/builtin.rb
+- lib/cauterize/builders/doc/composite.rb
+- lib/cauterize/builders/doc/enumeration.rb
+- lib/cauterize/builders/doc/fixed_array.rb
+- lib/cauterize/builders/doc/group.rb
+- lib/cauterize/builders/doc/scalar.rb
+- lib/cauterize/builders/doc/variable_array.rb
 - lib/cauterize/builtin.rb
 - lib/cauterize/c_builder.rb
 - lib/cauterize/cauterize.rb
 - lib/cauterize/composite.rb
 - lib/cauterize/cs_builder.rb
+- lib/cauterize/doc_builder.rb
 - lib/cauterize/enumeration.rb
 - lib/cauterize/fixed_array.rb
 - lib/cauterize/formatter.rb
@@ -158,12 +186,14 @@ files:
 - spec/builders/cs/group_spec.rb
 - spec/builders/cs/scalar_spec.rb
 - spec/builders/cs/variable_array_spec.rb
+- spec/builders/doc/buildable_spec.rb
 - spec/builders_spec.rb
 - spec/builtin_spec.rb
 - spec/c_builder_spec.rb
 - spec/cauterize_spec.rb
 - spec/composite_spec.rb
 - spec/cs_builder_spec.rb
+- spec/doc_builder_spec.rb
 - spec/enumeration_spec.rb
 - spec/fixed_array_spec.rb
 - spec/group_spec.rb
@@ -216,16 +246,16 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
       segments:
       - 0
-      hash: -69308014069678082
+      hash: -3520063422642430845
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
@@ -251,12 +281,14 @@ test_files:
 - spec/builders/cs/group_spec.rb
 - spec/builders/cs/scalar_spec.rb
 - spec/builders/cs/variable_array_spec.rb
+- spec/builders/doc/buildable_spec.rb
 - spec/builders_spec.rb
 - spec/builtin_spec.rb
 - spec/c_builder_spec.rb
 - spec/cauterize_spec.rb
 - spec/composite_spec.rb
 - spec/cs_builder_spec.rb
+- spec/doc_builder_spec.rb
 - spec/enumeration_spec.rb
 - spec/fixed_array_spec.rb
 - spec/group_spec.rb