cauterize 0.0.1.pre5 → 0.0.1.pre7

data/lib/cauterize/builders/doc/builtin.rb

@@ -0,0 +1,21 @@
+module Cauterize
+  module Builders
+    module Doc
+      class BuiltIn < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: built-in",
+            "Description: #{(@blueprint.description ? " - #{@blueprint.description}" : "<none>")}",
+          ].join("\n")
+        end
+
+        def body
+          ["data - size: #{@blueprint.byte_length} bytes"]
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::BuiltIn, Cauterize::Builders::Doc::BuiltIn)

data/lib/cauterize/builders/doc/composite.rb

@@ -0,0 +1,23 @@
+module Cauterize
+  module Builders
+    module Doc
+      class Composite < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: composite",
+            "Description: #{(@blueprint.description ? @blueprint.description : "<none>")}",
+          ].join("\n")
+        end
+
+        def body
+          @blueprint.fields.values.map do |v|
+            "#{v.name} - type: #{v.type.name}" + (v.description ? " - description: #{v.description}" : "")
+          end
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::Composite, Cauterize::Builders::Doc::Composite)

data/lib/cauterize/builders/doc/enumeration.rb

@@ -0,0 +1,24 @@
+module Cauterize
+  module Builders
+    module Doc
+      class Enumeration < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: enumeration",
+            "Description: #{@blueprint.description ? @blueprint.description : "<none>"}",
+            "Encoding: #{@blueprint.representation.name}",
+          ].join("\n")
+        end
+
+        def body
+          @blueprint.values.values.map {|v| "  #{v.name} = #{v.value}"}
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::Enumeration, Cauterize::Builders::Doc::Enumeration)
+
+

data/lib/cauterize/builders/doc/fixed_array.rb

@@ -0,0 +1,26 @@
+module Cauterize
+  module Builders
+    module Doc
+      class FixedArray < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: fixed-array",
+            "Description: #{@blueprint.description ? @blueprint.description : "<none>"}",
+            "Stored Type: #{@blueprint.array_type.name}",
+            "Value Count: #{@blueprint.array_size}",
+          ].join("\n")
+        end
+
+        def body
+          [
+            "data - #{@blueprint.array_size} values of type #{@blueprint.array_type.name}",
+          ]
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::FixedArray, Cauterize::Builders::Doc::FixedArray)
+

data/lib/cauterize/builders/doc/group.rb

@@ -0,0 +1,29 @@
+module Cauterize
+  module Builders
+    module Doc
+      class Group < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: group",
+            "Description: #{(@blueprint.description ? @blueprint.description : "<none>")}",
+          ].join("\n")
+        end
+
+        def body
+          vals = @blueprint.fields.values.map do |v|
+            "  #{v.name} - payload: #{v.type ? v.type.name : "<no payload>"}" + (v.description ? " - description: #{v.description}" : "")
+          end
+
+          [
+            "kind tag: #{@blueprint.tag_enum.name}",
+            "kinds:"
+          ] + vals
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::Group, Cauterize::Builders::Doc::Group)
+

data/lib/cauterize/builders/doc/scalar.rb

@@ -0,0 +1,21 @@
+module Cauterize
+  module Builders
+    module Doc
+      class Scalar < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: scalar",
+            "Description: #{(@blueprint.description ? " - #{@blueprint.description}" : "<none>")}",
+          ].join("\n")
+        end
+
+        def body
+          ["data - type: #{@blueprint.type_name.name}"]
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::Scalar, Cauterize::Builders::Doc::Scalar)

data/lib/cauterize/builders/doc/variable_array.rb

@@ -0,0 +1,26 @@
+module Cauterize
+  module Builders
+    module Doc
+      class VariableArray < Buildable
+        def heading
+          [
+            "Type Name: #{@blueprint.name}",
+            "Cauterize Class: variable-array",
+            "Description: #{@blueprint.description ? @blueprint.description : "<none>"}",
+            "Maximum Value Count: #{@blueprint.array_size}",
+          ].join("\n")
+        end
+
+        def body
+          [
+            "length - type #{@blueprint.size_type.name}",
+            "data - 0 to #{@blueprint.array_size} values of type #{@blueprint.array_type.name}",
+          ]
+        end
+      end
+    end
+  end
+end
+
+Cauterize::Builders.register(:doc, Cauterize::VariableArray, Cauterize::Builders::Doc::VariableArray)
+

data/lib/cauterize/builtin.rb

@@ -18,7 +18,7 @@ module Cauterize
 
   def create_builtins
     BUILT_IN_TYPES.each do |b|
-      _b = BuiltIn.new(b[:name])
+      _b = BuiltIn.new(b[:name], nil)
       _b.byte_length(b[:size])
       _b.is_signed(b[:signed])
       builtins[b[:name]] = _b
@@ -26,7 +26,7 @@ module Cauterize
   end
 
   class BuiltIn < BaseType
-    def initialize(name)
+    def initialize(name, desc=nil)
       super
     end
 

data/lib/cauterize/c_builder.rb

@@ -21,6 +21,8 @@ module Cauterize
       f = default_formatter
 
       excluder = @name.up_snake + "_H_#{Time.now.to_i}"
+      f << "/* WARNING: This is generated code. Do not edit this file directly. */"
+      f << ""
       f << "#ifndef #{excluder}"
       f << "#define #{excluder}"
       f.blank_line
@@ -51,6 +53,7 @@ module Cauterize
 
       f.blank_line
       f << "#endif /* #{excluder} */"
+      f << "\n"
 
       File.open(@h, "wb") do |fh|
         fh.write(f.to_s)
@@ -60,6 +63,8 @@ module Cauterize
     def build_c
       f = default_formatter
 
+      f << "/* WARNING: This is generated code. Do not edit this file directly. */"
+      f << ""
       f << %Q{#include <cauterize_util.h>}
       f << %Q{#include "#{@name}.h"}
 

data/lib/cauterize/cauterize.rb

@@ -29,6 +29,12 @@ module Cauterize
     Cauterize::CSBuilder.new(cs_file, output_prefix)
   end
 
+  def make_builder_doc(target_dir, output_prefix)
+    doc_file = File.join(target_dir, "#{output_prefix}.txt")
+
+    Cauterize::DocBuilder.new(doc_file, output_prefix)
+  end
+
   def get_name
     @@description_name
   end
@@ -49,8 +55,7 @@ module Cauterize
     @@version = version
   end
 
-  private 
-  def self.parse_dsl(desc_file)
+  def parse_dsl(desc_file)
     Object.new.extend(Cauterize).instance_exec do
       # this magic allows us to emit useful exception messages when evaling the
       # file. if your description file has errors, you'll be able to find them

data/lib/cauterize/composite.rb

@@ -5,8 +5,8 @@
 module Cauterize
   module_function
 
-  def composite(name)
-    c = Cauterize.composites[name] || Cauterize.composites[name] = Composite.new(name)
+  def composite(name, desc=nil)
+    c = Cauterize.composites[name] || Cauterize.composites[name] = Composite.new(name, desc)
     yield c if block_given?
     return c
   end
@@ -24,26 +24,27 @@ module Cauterize
   end
 
   class CompositeField
-    attr_reader :name, :type
-    def initialize(field_name, type_name)
+    attr_reader :name, :type, :description
+    def initialize(field_name, type_name, desc=nil)
       @name = field_name
       @type = BaseType.find_type!(type_name)
+      @description = desc
     end
   end
 
   class Composite < BaseType
     attr_reader :fields
 
-    def initialize(name)
+    def initialize(name, desc=nil)
       super
       @fields = {}
     end
 
-    def field(name, type)
+    def field(name, type, desc=nil)
       if @fields[name]
         raise Exception.new("Field name #{name} already used.")
       else
-        @fields[name] = CompositeField.new(name, type)
+        @fields[name] = CompositeField.new(name, type, desc)
       end
     end
   end

data/lib/cauterize/cs_builder.rb

@@ -18,19 +18,22 @@ module Cauterize
     def build_cs
       f = four_space_formatter
 
+      f << "/* WARNING: This is generated code. Do not edit this file directly. */"
+      f << ""
       f << "using System;"
       f << "using Cauterize;"
       f.blank_line
       f << "namespace #{@name}"
       f.braces do
-        f << "public class #{@name}CauterizeInfo : CauterizeInfo"
+        f << "public static class #{@name}Cauterize"
         f.braces do
-          f << "static #{@name}CauterizeInfo()"
+          f << "public static CauterizeInfo Info = new CauterizeInfo"
           f.braces do
-            f << "Name = \"#{@name}\";"
-            f << "GeneratedVersion = \"#{Cauterize.get_version}\";"
-            f << "GeneratedDate = \"#{Cauterize.get_version}\";"
+            f << "Name = \"#{@name}\","
+            f << "GeneratedVersion = \"#{Cauterize.get_version}\","
+            f << "GeneratedDate = \"#{DateTime.now.to_s}\""
           end
+          f << ";"
         end
         f.blank_line
 

data/lib/cauterize/doc_builder.rb

@@ -0,0 +1,34 @@
+module Cauterize
+  class DocBuilder
+    attr_reader :doc_path, :name
+    def initialize(doc_path, name="cauterize")
+      @doc_path = doc_path
+      @name = name
+    end
+
+    def build
+      build_doc
+    end
+
+    private
+
+    def build_doc
+      File.open(@doc_path, "wb") do |fh|
+        doc_sections = []
+
+        instances = BaseType.all_instances
+        builders = instances.map {|i| Builders.get(:doc, i)}
+
+        builders.each do |b|
+          body_lines = (b.body || []).map {|l| "  " + l}
+          lines = ([b.heading] + body_lines)
+
+          doc_sections << lines.join("\n") + "\n"
+        end
+
+        fh.write(doc_sections.join("\n"))
+      end
+    end
+  end
+end
+

data/lib/cauterize/enumeration.rb

@@ -6,17 +6,17 @@ require 'set'
 
 module Cauterize
   module_function
-  def enumeration(name)
-    e = Cauterize.enumerations[name] || Cauterize.enumerations[name] = Enumeration.new(name)
+  def enumeration(name, desc=nil)
+    e = Cauterize.enumerations[name] || Cauterize.enumerations[name] = Enumeration.new(name, desc)
     yield e if block_given?
     return e
   end
 
-  def enumeration!(name, &blk)
+  def enumeration!(name, desc=nil, &blk)
     if Cauterize.enumerations[name]
       raise Exception.new("Enumeration with name #{name} already exists.")
     else
-      Cauterize.enumeration(name, &blk)
+      Cauterize.enumeration(name, desc, &blk)
     end
   end
 
@@ -36,7 +36,7 @@ module Cauterize
   class Enumeration < BaseType
     attr_reader :values
 
-    def initialize(name)
+    def initialize(name, desc=nil)
       super
       @values = {}
       @value_id = 0

data/lib/cauterize/fixed_array.rb

@@ -1,8 +1,8 @@
 module Cauterize
   module_function
 
-  def fixed_array(name)
-    a = Cauterize.fixed_arrays[name] || Cauterize.fixed_arrays[name] = FixedArray.new(name)
+  def fixed_array(name, desc=nil)
+    a = Cauterize.fixed_arrays[name] || Cauterize.fixed_arrays[name] = FixedArray.new(name, desc)
     yield a if block_given?
     return a
   end
@@ -20,7 +20,7 @@ module Cauterize
   end
 
   class FixedArray < BaseType
-    def initialize(name)
+    def initialize(name, desc=nil)
       super
     end
 

data/lib/cauterize/group.rb

@@ -1,8 +1,8 @@
 module Cauterize
   module_function
 
-  def group(name)
-    a = Cauterize.groups[name] || Cauterize.groups[name] = Group.new(name)
+  def group(name, desc=nil)
+    a = Cauterize.groups[name] || Cauterize.groups[name] = Group.new(name, desc)
     yield a if block_given?
     return a
   end
@@ -20,32 +20,42 @@ module Cauterize
   end
 
   class GroupField
-    attr_reader :name, :type
+    attr_reader :name, :type, :description
 
-    def initialize(name, type)
+    def initialize(name, type, desc=nil)
       @name = name
       @type = BaseType.find_type!(type) if type
+      @description = desc
     end
   end
 
   class Group < BaseType
     attr_reader :fields, :tag_enum
 
-    def initialize(name)
+    def initialize(name, desc=nil)
+      # This technically should be defined before the group itself is defined
+      # because the group depends on the enumeration. Technically, this snippet
+      # of code doesn't care, but others may depend on the ordering.
+      @tag_enum = Cauterize.enumeration!("group_#{name}_type".to_sym)
+
+      # Make sure that this is called *AFTER* the enumeration is created.
       super
       @fields = {}
-      @tag_enum = Cauterize.enumeration!("group_#{name}_type".to_sym)
     end
 
-    def field(name, type=nil)
+    def field(name, type, desc=nil)
       if @fields[name]
         raise Exception.new("Field name #{name} already used.")
       else
-        @fields[name] = GroupField.new(name, type)
+        @fields[name] = GroupField.new(name, type, desc)
         @tag_enum.value(enum_sym(name))
       end
     end
 
+    def dataless(name, desc=nil)
+      field(name, nil, desc)
+    end
+
     def enum_sym(fname)
       "group_#{@name}_type_#{fname}".up_snake.to_sym
     end