cgen 0.16.4 → 0.16.5

data/History.txt

@@ -1,3 +1,18 @@
+cgen 0.16.5
+
+  - api addition: define_inheritable_c_function
+  
+  - optimization: if mark and free same as parent class
+    implementation, reference the latter directly
+  
+  - optimization: preserve Makefile mtime when nothing changes
+  
+  - optimization: do not generate load and dump methods when
+    super implementation is equivalent
+  
+  - optimization: if mark or free do nothing, don't generate a function,
+    just use 0 or -1 (resp.) in Data_Make_Struct
+
 cgen 0.16.4
 
   - api addition: module and symbol declarations can optionally be sent

data/lib/cgen/cgen.rb

@@ -418,7 +418,7 @@ require 'cgen/inherit'
 # way that makes clear that the problem is really with commit.
 module CGenerator
 
-VERSION = '0.16.4'
+VERSION = '0.16.5'
 
 class Accumulator ## should be a mixin? "Cumulative"?
 
@@ -949,9 +949,22 @@ class Library < Template
         need_to_make_clean = true
       end
       
+      ## it would be better to capture the output of extconf.rb before
+      ## it writes it to Makefile, but mkmf.rb is not written that way :(
+      if File.exist?("Makefile")
+        old_makefile = File.read("Makefile")
+        require 'fileutils'
+        FileUtils.mv("Makefile", "Makefile.old")
+      end
+      
       system %{
         #{ruby} extconf.rb > #{@logname}
       }
+      
+      if old_makefile and old_makefile == File.read("Makefile")
+        FileUtils.rm("Makefile")
+        FileUtils.mv("Makefile.old", "Makefile")
+      end
     end
     
     make "clean" if need_to_make_clean

data/lib/cgen/cshadow.rb

@@ -123,7 +123,8 @@ require "cgen/attribute"
 # simplicity, CShadow defines three methods in the client class for defining
 # methods and class methods:
 #
-# CShadow.define_c_method CShadow.define_c_class_method
+# CShadow.define_c_method
+# CShadow.define_c_class_method
 # CShadow.define_c_function
 #
 # ===Memory management
@@ -269,8 +270,11 @@ module CShadow
         classes.each do |cl|
           # make sure the following have been defined by now
           cl.shadow_struct
-          cl.new_method; cl.mark_function; cl.free_function
-          cl._dump_data_method; cl._load_data_method; cl._alloc_method
+          cl.new_method; cl._alloc_method
+          cl.check_inherited_functions
+          if cl == cl.base_class
+            cl._dump_data_method; cl._load_data_method
+          end
         end
       end
 
@@ -535,7 +539,9 @@ module CShadow
       m
     end
     
-    # Define a global function in the library of this class.
+    # Define a function in the library of this class. By
+    # default, the function has extern scope.
+    # The +name+ is just the function name (as a C function).
     def define_c_function name, subclass = CGenerator::Function, &block
       sf = shadow_library_source_file
       m = sf.define_c_function name, subclass
@@ -543,9 +549,38 @@ module CShadow
       m.instance_eval(&block) if block
       m
     end
-
+    
+    # Define a function in the library of this class. By
+    # default, the function has extern scope.
+    # The +name+ is typically a symbol (like :mark) which is used to
+    # generate a function name in combination with the shadow struct name.
+    #
+    # If a class defines a function with +name+, and the child class does
+    # not do so (i.e. doesn't instantiate the function template to add
+    # code), then the child can call the parent's implementation using
+    # #refer_to_function (see #new_method for an example).
+    def define_inheritable_c_function name,
+          subclass = CGenerator::Function, &block
+      sf = shadow_library_source_file
+      m = sf.define_c_function "#{name}_#{shadow_struct.name}", subclass
+      c_function_templates[name] = m
+      m.scope :extern
+      m.instance_eval(&block) if block
+      m
+    end
+    
     #== Internal methods ==#
 
+    def c_function_templates;         @c_function_templates ||= {};         end
+    # Note that {} nondeterministic, so these should only be used to
+    # check existence or get value, not to iterate.
+    
+    def find_super_function sym
+      c_function_templates[sym] || (
+        defined?(superclass.find_super_function) &&
+          superclass.find_super_function(sym))
+    end
+    
     # Construct the name used for the shadow struct.
     def shadow_struct_name
       name.gsub(/_/, '__').gsub(/::/, '_o_') + CShadow::SHADOW_SUFFIX
@@ -582,6 +617,8 @@ module CShadow
       unless defined?(@new_method) and @new_method
         sf = shadow_library_source_file
         ssn = shadow_struct.name
+        mark_name = refer_to_function :mark
+        free_name = refer_to_function :free
         @new_method = sf.define_c_singleton_method self,
           :new, AttrClassMethod
         @new_method.instance_eval {
@@ -592,11 +629,11 @@ module CShadow
           setup :shadow_struct => %{
             object = Data_Make_Struct(self,
                        #{ssn},
-                       mark_#{ssn},
-                       free_#{ssn},
+                       #{mark_name},
+                       #{free_name},
                        shadow);
             shadow->self = object;
-          }.tabto(0)
+          }
           body attr_code!
           body %{
             rb_obj_call_init(object, argc, argv);
@@ -609,18 +646,37 @@ module CShadow
       end
       @new_method
     end
-
+    
+    def referenced_functions
+      @referenced_functions ||= {}
+    end
+    
+    def refer_to_function sym
+      referenced_functions[sym] = true
+      "#{sym}_#{shadow_struct.name}"
+    end
+    
+    def check_inherited_functions
+      syms = referenced_functions.keys.sort_by{|k|k.to_s}
+      syms.reject {|sym| c_function_templates[sym]}.each do |sym|
+        fname = "#{sym}_#{shadow_struct.name}"
+        pf = find_super_function(sym)
+        pf_str = pf ? pf.name : (sym == :free ? -1 : 0)
+          # -1 means free the struct; See README.EXT
+        shadow_library_source_file.declare fname.intern =>
+          "#define #{fname} #{pf_str}"
+      end
+    end
+    
     # Return the object for managing the mark function of the class.
     def mark_function
       unless defined?(@mark_function) and @mark_function
         sf = shadow_library_source_file
         ssn = shadow_struct.name
-        @mark_function = sf.define_c_function("mark_#{ssn}", MarkFunction)
-        @mark_function.instance_eval {
-          scope :static
+        @mark_function = define_inheritable_c_function(:mark, MarkFunction) do
           arguments "#{ssn} *shadow"
           return_type "void"
-        }
+        end
         if superclass.respond_to? :shadow_struct
           @mark_function.mark superclass.mark_function.mark!
         end
@@ -633,12 +689,10 @@ module CShadow
       unless defined?(@free_function) and @free_function
         sf = shadow_library_source_file
         ssn = shadow_struct.name
-        @free_function = sf.define_c_function("free_#{ssn}", FreeFunction)
-        @free_function.instance_eval {
-          scope :static
+        @free_function = define_inheritable_c_function(:free, FreeFunction) do
           arguments "#{ssn} *shadow"
           return_type "void"
-        }
+        end
         if superclass.respond_to? :shadow_struct
           @free_function.free superclass.free_function.free!
         end
@@ -690,6 +744,8 @@ module CShadow
       unless defined?(@_alloc_method) and @_alloc_method
         sf = shadow_library_source_file
         ssn = shadow_struct.name
+        mark_name = refer_to_function :mark
+        free_name = refer_to_function :free
         @_alloc_method = sf.define_alloc_func(self)
         @_alloc_method.instance_eval {
           scope :extern
@@ -701,8 +757,8 @@ module CShadow
           body %{
             object = Data_Make_Struct(#{klass_c_name},
                        #{ssn},
-                       mark_#{ssn},
-                       free_#{ssn},
+                       #{mark_name},
+                       #{free_name},
                        shadow);
             shadow->self = object;
           }
@@ -899,7 +955,6 @@ module CShadow
     end
 
     unless base_class.ancestors.include? self
-
       base_class.class_eval {@base_class = self; @persistent = true}
       base_class.extend CShadowClassMethods
 

data/rakefile

@@ -30,6 +30,8 @@ END
   test.files = Dir["test/test-*.rb"]
 }
 
+ENV["VERSION"] = CGenerator::VERSION ## why isn't this automatic?
+
 task 'gem:release' => 'rubyforge:release' # to release to rubyforge as well
 
 task :release => ["rubyforge:release", "rubyforge:doc_release"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cgen
 version: !ruby/object:Gem::Version 
-  hash: 87
+  hash: 85
   prerelease: false
   segments: 
   - 0
   - 16
-  - 4
-  version: 0.16.4
+  - 5
+  version: 0.16.5
 platform: ruby
 authors: 
 - Joel VanderWerf
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-26 00:00:00 -07:00
+date: 2010-07-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency