cgen 0.16.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.bck
+pkg/*
+doc/*
+junk/*
+tmp/*

data/History.txt

@@ -0,0 +1,199 @@
+cgen 0.16.0
+
+  - Moved to Mr. Bones, git, gems, rubyforge.
+  
+  - API doc reformatted from rd2 to rdoc.
+
+cgen 0.15
+
+  - Reinstated "extern" for extern prototypes.
+
+  - CShadow.shadow_attr returns list of handles to the r/w funcs
+
+  - CGen does 'make clean' if extconf.rb changes
+  
+  - #extconf yields line array
+  
+  - Attributes remember their owner_class.
+
+cgen 0.14
+
+  - Fixed to work with the YAML changes in ruby 1.8.4.
+
+cgen 0.13
+
+  - InitAccumulators were writing code to execute every time, rather
+    than just the first time. Fixed the bug.
+
+  - #declare_struct may be passed attributes, such as
+    "__attribute__((__packed__))"
+
+  - Fixed a bug caused by having more than one ruby interpreter installed.
+
+  - MSVC compatibility fixes.
+
+cgen 0.12
+
+  - CShadow.define_c_function for convenience.
+
+  - Improved sorting of component classes to reduce nondeterminism in code
+    generation, and to thereby reduce time to rebuild.
+
+  - Reorgnized CShadow base classes so that methods are provided by
+    extending with a module, CShadowClassMethods, instead of being
+    defined individually in each base class. This means that they can be
+    overridden and called with super. It's also cleaner and probably
+    faster.
+
+  - Included examples/yaml.rb, which was mistakenly left out of 0.11
+
+  - CShadow#inspect added. Shows both shadow attrs and instance vars.
+
+cgen 0.11
+
+  - CShadow classes are YAML friendly--see docs on cshadow and
+    examples/yaml.rb.
+
+  - Library#literal_symbol to streamline use of rb_hash_aref etc.
+
+  - Improved granularity for efficient separate compilation.
+
+  - Improved indentation in CFunctions.
+  
+  - CShadow: added a new statement accumulators to _dump_data_method
+    and  _load_data_method, called 'pre_code' and 'post_code',
+    replacing 'extra_code'.
+  
+  - Library#extconf should now return a string or array of strings,
+    which will be used as the contents of extconf.rb.
+
+cgen 0.10
+
+  - For versions of ruby 1.7.3 and 1.8 after 20Dec2002, we use
+    rb_define_alloc_func() instead of defining an "allocate" class method,
+    which would cause a warning.
+  
+  - Tested with MinGW/MSYS on Windows.
+  
+  - Deprecated methods (define_method and define_class_method) removed. See
+    notes for 0.9, below.
+
+cgen 0.9 [Never released]
+  
+  - Now uses standard install.rb.
+  
+  - Updated to ruby-1.7.3, 2002-10-30. (CShadow no longer uses class vars,
+    since their semantics have changed. It uses class instance vars instead.)
+  
+  - Tested with ruby-1.6.7 and ruby-1.7.3 (no patch needed for either).
+    Patch for marshal.c in ruby-1.6.6 is still included.
+  
+  - Tests now use Test::Unit.
+  
+  - [INTERFACE CHANGE] Library#define_method and the define_method class
+    methods in shadow classes are now deprecated. They work correctly but issue
+    a warning. They will be removed in future releases. Use #define_c_method
+    instead. This change is necessary because ruby-1.7 already has
+    Module.define_method. For consistency, this name change propagates to other
+    define methods:
+
+      define                    --> define_c_function
+      define_method             --> define_c_method
+      define_module_function    --> define_c_module_function
+      define_global_function    --> define_c_global_function
+      define_singleton_method   --> define_c_singleton_method
+
+cgen 0.8
+  - Minor fix to install.rb for compatibility with ruby 1.7.
+  - CGenerator::Library's purge_source_dir attribute now applies to .o files
+    as well as .c and .h.
+  - Shadow attributes can now be nonpersistent, using the :nonpersistent flag
+    in shadow_attr_accessor declarations. This reduces library size as well
+    as the size of the persistant image.
+  - CShadow: added a new statement accumulator to _dump_data_method and 
+    _load_data_method, called 'extra_code', which can be used to pre- (in
+    the case of dump) or post- (in the case of load) process the object. For
+    instance, additonal (nonpersistent) resources may need to be created or
+    initialized based on the loaded attr values.
+  - [Interface change] Removed the before_commit and after_commit methods from
+    CShadow and added more general methods to CGen::Library, to which CShadow
+    delegates. See the docs in cshadow.rb.
+
+cgen 0.7
+  - Added makedepend step to compilation so that the resulting library
+    reflects changes in headers. Library#makedepend can be overridden.
+  - Added CommentAccumulator, and gave each CFile a CommentAccumulator
+    called 'preamble' that comes before the include accumulator.
+  - Factored Library#write into #write and #update_file to give finer grained
+    control over checking whether a file needs updating.
+  - Added the purge_source_dir attribute of a library to optionally delete
+    or rename any source files that are not part of the current generation.
+  - Added show_times method (controlled by @@show_times) to print timing
+    information for the steps of the commit process.
+
+cgen 0.6
+  - Fixed a bug in CShadow which caused attr initializers not to be
+    inherited by the 'new' method of a subclass. Fixed similar bugs
+    with attr dump and load code. Added tests for these.
+  - Added optional subclass arg to define_method, define_singleton_method,
+    etc. The subclass arg allows the generated template to belong to a
+    subclass of the function template it would normally belong to.
+  - IntAttribute, LongAttribute: Use INT2NUM rather than INT2FIX to handle
+    numbers on the order of 2**30 (n<=2**29 was ok before, n>=2**31 is too
+    large for native longs, and raises an exception). Added tests for this.
+
+cgen 0.5
+  - Added before_commit and after_commit hooks for CShadow classes.
+  - Added LongAttribute.
+  - The protected and private declarations work on shadow attrs (in
+    the command form "protected :x", but not in the block form
+    "protected; shadow_attr_reader :x ...").
+  - declare_struct now uses declare, rather than a separate accumulator,
+    so that the order of declarations in a file is preserved.
+
+cgen 0.4
+  - With a patch to marshal.c in the ruby source, CShadow now handles
+    marshalling of shadow objects. See attribute.rb and marshal.patch.
+  - Tests added to attribute.rb for marshalling.
+  - CGenerator::Structure now allows recursive structs, so this works:
+      class Foo; include CShadow; shadow_attr_accessor :foo => [Foo]
+    (It always worked without the [], but that's another beast.)
+
+cgen 0.3
+  - Shadow structures: C structs painlessly attached to Ruby objects.
+    - Extensible architecture for shadow attributes
+    - Basic attributes for int, double, char*, Ruby object, etc.
+    - Inheritance of attributes.
+    - See docs in cshadow.html and attribute.html.
+  - Structure "inheritance":
+      a_struct.inherit another_struct.declare!
+  - Libraries are now inspectible, with hierarchical display of nested
+    templates and accumulators.
+  - Optional type checking for c_array_args.
+  - It's now easy to send definitions to other .c files besides the
+    main one for the library. See documentation for "add_file" and the
+    example in cgen.rb. CShadow takes advantage of this feature.
+  - Finer granularity in cgen's make process: write, mkmf, and make are
+    separate; mkmf still calls Library#extconf. You can pass arguments
+    to #make that the make program understands, such as 'distclean'.
+  - Cgen has now improved from alpha to beta quality code. Testing is
+    fairly thorough, especially in cshadow.rb and attribute.rb, and
+    documentation covers all public methods and many internal methods.
+  - Updated to work with Ruby 1.6.6.
+  - Now installs all four library files into cgen/ dir (the location of
+    this dir is controllable with the -d arg to install.rb.)
+
+cgen 0.2
+  - Nice syntax for required, optional, rest, and block arguments, using
+    rb_scan_args. Performs default initialization for optional arguments.
+    See new code in sample.rb.
+  - Methods and other RubyFunctions return nil by default.
+  - Runs mkmf.rb in a forked process, because:
+    1. mkmf uses global scope |:(
+    2. might need to run mkmf twice in one session
+    3. this puts the mkmf log file in the lib dir, not the main dir.
+  - The cwd when the extension is 'require'-d is now the same as the main dir.
+  - Fixed bug with #c_array_args in the RubyFunction classes.
+
+cgen 0.1
+  - First public release. Alpha, but basic functionality seems to work.

data/README.txt

@@ -0,0 +1,34 @@
+
+high level overview
+
+purpose and history
+
+getting started
+
+- will need compiler
+
+advanced
+
+==Object attributes
+
+===class CShadow::ObjectAttribute
+
+===class CShadow::ShadowObjectAttribute
+
+
+examples
+
+more docs
+
+
+==web site
+
+==license
+
+==author
+Copyright 2001-2009
+Joel VanderWerf,
+mailto:vjoel@users.sourceforge.net
+
+http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/24443
+

data/examples/bench.rb

@@ -0,0 +1,14 @@
+# for comparison with RubyInline
+
+require 'cgen'
+
+class MyTest
+  def factor
+end
+
+Dir.mkdir "tmp" rescue SystemCallError
+Dir.chdir "tmp"
+
+MyTest.commit
+
+t = MyTest.new

data/examples/complex.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'cgen/cshadow'
+
+class MyComplex < Numeric
+  include CShadow
+
+  shadow_attr_accessor :re => "double re", :im => "double im"
+
+  def initialize re, im
+    self.re = re
+    self.im = im
+  end
+
+  define_c_method(:abs) {
+    include "<math.h>"
+    returns "rb_float_new(sqrt(pow(shadow->re, 2) + pow(shadow->im, 2)))"
+  }
+
+  define_c_method(:mul!) {
+    arguments :other
+    declare :other_shadow => "MyComplex_Shadow *other_shadow"
+    declare :new_re => "double new_re", :new_im => "double new_im"
+    body %{
+      switch (TYPE(other)) {
+        case T_FIXNUM:  shadow->re *= FIX2INT(other);
+                        shadow->im *= FIX2INT(other); break;
+        case T_FLOAT:   shadow->re *= NUM2DBL(other);
+                        shadow->im *= NUM2DBL(other); break;
+        default:
+          if (rb_obj_is_kind_of(other, #{declare_class MyComplex}) ==
+              Qtrue) {
+            Data_Get_Struct(other, MyComplex_Shadow, other_shadow);
+            new_re = shadow->re * other_shadow->re -
+                     shadow->im * other_shadow->im;
+            new_im = shadow->re * other_shadow->im +
+                     shadow->im * other_shadow->re;
+            shadow->re = new_re;
+            shadow->im = new_im;
+          }
+          else
+            rb_raise(#{declare_class ArgumentError},
+                     "Argument to mul! is not numeric.");
+      }
+    }
+    returns "self"
+  }
+end
+
+require 'ftools'
+dir = File.join("tmp", RUBY_VERSION)
+File.mkpath dir
+Dir.chdir dir
+
+MyComplex.commit
+
+z = MyComplex.new 5, 1.3
+puts z.abs
+z.mul! 10
+p [z.re, z.im]
+w = MyComplex.new 7.9, -1.2
+z.mul! w
+p [z.re, z.im]

data/examples/complex2.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'cgen/cshadow'
+
+class MyComplex2 < Numeric
+  include CShadow
+
+  shadow_attr_accessor :re => "double re", :im => "double im"
+
+  def initialize re, im
+    self.re = re
+    self.im = im
+  end
+
+  define_c_method(:abs) {
+    include "<math.h>"
+    returns "rb_float_new(sqrt(pow(shadow->re, 2) + pow(shadow->im, 2)))"
+  }
+  
+  define_c_method(:scale!) {
+    c_array_args {
+      optional  :factor
+      default   :factor => "INT2NUM(10)"
+      typecheck :factor => Numeric
+    }
+    body %{
+      shadow->re *= NUM2DBL(factor);
+      shadow->im *= NUM2DBL(factor);
+    }
+    returns "self"
+  }
+end
+
+require 'ftools'
+dir = File.join("tmp", RUBY_VERSION)
+File.mkpath dir
+Dir.chdir dir do
+  MyComplex2.commit
+end
+
+z = MyComplex2.new 5, 1.3
+puts z.abs      # ==> 5.1662365412358
+z.scale! 3.0    # float
+p [z.re, z.im]  # ==> [15.0, 3.9]
+z.scale! 3      # int
+p [z.re, z.im]  # ==> [45.0, 11.7]
+z.scale!        # use default value
+p [z.re, z.im]  # ==> [450.0, 117]

data/examples/cshadow-example.rb

@@ -0,0 +1,55 @@
+#!/usr/env/bin ruby
+
+require 'cgen/cshadow'
+
+class Test
+  include CShadow
+  shadow_attr_accessor\
+    :i => "int ii",
+    :d => "double d"
+  shadow_attr_reader :obj => Object
+end
+
+class SubTest < Test
+  shadow_attr :hidden_array => Array
+  shadow_attr_accessor\
+    :foo => "char *foo",
+    :bar => Symbol,
+    :test => [Test]
+end
+
+class OtherSubTest < Test
+  shadow_attr_accessor :j => "int j"
+  def initialize j_init
+    self.j = j_init
+  end
+end
+
+class SubSubTest < SubTest
+  shadow_attr_accessor :z => Object
+end
+
+require 'ftools'
+dir = File.join("tmp", RUBY_VERSION)
+File.mkpath dir
+Dir.chdir dir
+
+SubTest.commit # same as Test.commit
+
+x = SubTest.new
+puts "i = #{x.i}, d = #{x.d}, " +
+     "foo = #{x.foo.inspect}, bar = #{x.bar.inspect}"
+x.i = 7.5; x.d = 3; x.foo = "fred"; x.bar = :WILMA
+puts "i = #{x.i}, d = #{x.d}, " +
+     "foo = #{x.foo.inspect}, bar = #{x.bar.inspect}"
+
+y = OtherSubTest.new -123456789
+puts y.j, y.d
+
+# make sure ShadowAttribute works
+puts "x.test = #{x.test || 'nil'}"
+x.test = y
+puts "x.test = #{x.test || 'nil'}"
+puts x.test.j
+
+SubSubTest.each_shadow_attr {|x| p x}

data/examples/cshadow-point.rb

@@ -0,0 +1,58 @@
+#!/usr/env/bin ruby
+
+require 'cgen/cshadow'
+
+class Point
+  include CShadow
+  
+  ###
+  
+  shadow_attr_accessor\
+    :i => "int ii",
+    :d => "double d"
+  shadow_attr_reader :obj => Object
+end
+
+class SubTest < Test
+  shadow_attr :hidden_array => Array
+  shadow_attr_accessor\
+    :foo => "char *foo",
+    :bar => Symbol,
+    :test => [Test]
+end
+
+class OtherSubTest < Test
+  shadow_attr_accessor :j => "int j"
+  def initialize j_init
+    self.j = j_init
+  end
+end
+
+class SubSubTest < SubTest
+  shadow_attr_accessor :z => Object
+end
+
+require 'ftools'
+dir = File.join("tmp", RUBY_VERSION)
+File.mkpath dir
+Dir.chdir dir
+
+SubTest.commit # same as Test.commit
+
+x = SubTest.new
+puts "i = #{x.i}, d = #{x.d}, " +
+     "foo = #{x.foo.inspect}, bar = #{x.bar.inspect}"
+x.i = 7.5; x.d = 3; x.foo = "fred"; x.bar = :WILMA
+puts "i = #{x.i}, d = #{x.d}, " +
+     "foo = #{x.foo.inspect}, bar = #{x.bar.inspect}"
+
+y = OtherSubTest.new -123456789
+puts y.j, y.d
+
+# make sure ShadowAttribute works
+puts "x.test = #{x.test || 'nil'}"
+x.test = y
+puts "x.test = #{x.test || 'nil'}"
+puts x.test.j
+
+SubSubTest.each_shadow_attr {|x| p x}