cgen 0.16.1 → 0.16.2

data/.gitignore

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

data/History.txt

@@ -1,3 +1,13 @@
+cgen 0.16.2
+
+  - makedepend step uses gcc -MM if appropriate
+
+  - More documentation and refactoring thereof.
+
+cgen 0.16.1
+
+  - More documentation and refactoring thereof.
+
 cgen 0.16.0
 
   - Moved to Mr. Bones, git, gems, rubyforge.

data/examples/example-ruby-talk-26July2009.rb

@@ -0,0 +1,43 @@
+require 'cgen/cshadow'
+
+class Complex < Numeric
+  include CShadow
+
+  shadow_attr_accessor :re => "double re"
+  shadow_attr_accessor :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
+
+Complex.commit
+
+z = Complex.new 5, 1.3
+p z             # ==> #<Complex:0xb7dc0098 re=5.0, im=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/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.1'
+VERSION = '0.16.2'
 
 class Accumulator ## should be a mixin? "Cumulative"?
 
@@ -888,10 +888,19 @@ class Library < Template
     build_wrapper do
       cfg = Config::CONFIG
       dirs = [cfg["sitearchdir"], cfg["archdir"], cfg["includedir"]]
+      
+      makedepend_cmd =
+        case cfg["CC"]
+        when "gcc"
+          "gcc -MM -MF depend"
+        else
+          "makedepend -fdepend"
+        end
+      
       result = system %{
         touch depend
-        makedepend -fdepend *.c -I#{dirs.join " -I"} >#{@logname} 2>&1
-      } ## what about "gcc -MM" as in step 6 in README.EXT ?
+        #{makedepend_cmd} *.c -I#{dirs.join " -I"} >#{@logname} 2>&1
+      }
       unless result
         log_data = File.read(@logname) rescue nil
         msg = "\n  makedepend failed for #{@name}."

data/lib/cgen/cshadow.rb

@@ -23,8 +23,10 @@ require "cgen/attribute"
 # 
 # ==Usage
 #
-# class MyClass
-#   include CShadow
+#   class MyClass
+#     include CShadow
+#     shadow_attr_accessor :x => "int x" # fox example
+#   end
 #
 # Include CShadow in the base class(es) that need to have shadow attributes. The
 # base class is assigned a CGenerator::Library, which can be accessed using
@@ -54,7 +56,7 @@ require "cgen/attribute"
 # Shadow classes that are placed in the same library can still be put in
 # separate C source files, using #shadow_library_file:
 #
-# shadow_library_file <CFile or String>
+#   shadow_library_file <CFile or String>
 #
 # This setting is inherited (and can be overridden) by subclasses of the current
 # class. If a class calls both #shadow_library and #shadow_library_file then
@@ -181,66 +183,66 @@ require "cgen/attribute"
 # ==Limitations:
 #
 # * Hash args are ordered unpredictably, so if struct member order is
-# significant (for example, because you want to pass the struct to C code that
-# expects it that way), use a separate declare statement for each member. Also,
-# take note of the self pointer at the beginning of the struct.
+#   significant (for example, because you want to pass the struct to C code that
+#   expects it that way), use a separate declare statement for each member.
+#   Also, take note of the self pointer at the beginning of the struct.
 #
 # * Creating a ruby+shadow object has a bit more time/space overhead than just a
-# C object, so CShadow may not be the best mechansism for managing heap
-# allocated data (for example, if you want lots of 2-element arrays). Also,
-# CShadow objects are fixed in size (though their members can point to other
-# structures).
+#   C object, so CShadow may not be the best mechansism for managing heap
+#   allocated data (for example, if you want lots of 2-element arrays). Also,
+#   CShadow objects are fixed in size (though their members can point to other
+#   structures).
 #
 # * CShadow attributes are, of course, not dynamic. They are fixed at the time
-# of #commit. Otherwise, they behave essentially like Ruby attributes, except
-# that they can be accessed only with methods or from C code; they cannot be
-# accessed with the @ notation. Of course, the reader and writer for a shadow
-# attribute can be flagged as protected or private. However, a private writer
-# cannot be used, since by definition private methods can only be called in the
-# receiverless form.
+#   of #commit. Otherwise, they behave essentially like Ruby attributes, except
+#   that they can be accessed only with methods or from C code; they cannot be
+#   accessed with the @ notation. Of course, the reader and writer for a shadow
+#   attribute can be flagged as protected or private. However, a private writer
+#   cannot be used, since by definition private methods can only be called in 
+#   the receiverless form.
 #
 # * CShadow is designed for efficient in-memory structs, not packed,
-# network-ordered data as for example in network protocols. See the
-# bit-struct project for the latter.
+#   network-ordered data as for example in network protocols. See the
+#   bit-struct project for the latter.
 #
 # ==To do:
 #
 # * It should be easier to get a handle to entities. Below, shadow_attr has been
-# hacked to return a list of pairs of functions. But it should be easier and
-# more general.
+#   hacked to return a list of pairs of functions. But it should be easier and
+#   more general.
 #
 # * Optimization: if class A<B, and their free func have the same content, use
-# B's function in A, and don't generate a new function for A. Similarly for all
-# the other kinds of functions.
+#   B's function in A, and don't generate a new function for A. Similarly for 
+#   all the other kinds of functions.
 #
 # * Allow
 #
-# shadow_attr "int x", "double y"
+#     shadow_attr "int x", "double y"
 #
-# or even
+#   or even
 #
-# attr_accessor :a, :b, "int x", "double y"
+#     attr_accessor :a, :b, "int x", "double y"
 #
-# and (in cgen)
+#   and (in cgen)
 #
-# declare "int x", "double y"
+#     declare "int x", "double y"
 #
-# The ruby name will be extracted from the string using the matching pattern.
+#   The ruby name will be extracted from the string using the matching pattern.
 #
 # * Generate documentation for the shadow class.
 #
 # * Change name to CStruct? CStructure?
 #
 # * Find a way to propagate append_features so that CShadow can be included in
-# modules and modules can contribute shadow_attrs.
+#   modules and modules can contribute shadow_attrs.
 #
 # * option to omit the "self" pointer, or put it at the end of the struct
-# automatically omit it in a class if no ShadowObjectAttributes point to it?
+#   automatically omit it in a class if no ShadowObjectAttributes point to it?
 #
 # * shadow_struct_constructor class method to use DATA_WRAP_STRUCT
 #
 # * Use CNativeAttribute as a default attribute? Or use the attr class hierarchy
-# to supply defaults?
+#   to supply defaults?
 #
 module CShadow
   SHADOW_SUFFIX = "_Shadow"

data/rakefile

@@ -31,12 +31,11 @@ programs. Includes CShadow module for defining classes in terms of C structs
 with accessors and inheritance.
 END
 PROJ.changes = File.read(PROJ.history_file)[/^\w.*?(?=^\w)/m]
+(PROJ.rdoc.dir = File.readlink(PROJ.rdoc.dir)) rescue nil
 
 PROJ.spec.opts << '--color'
 PROJ.test.files = Dir["test/test-*.rb"]
 
-### pkg dir in tmp
-
 task :release => ["gem:release", "doc:release"]
 
 # EOF

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cgen
 version: !ruby/object:Gem::Version 
-  version: 0.16.1
+  version: 0.16.2
 platform: ruby
 authors: 
 - Joel VanderWerf
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-26 00:00:00 -07:00
+date: 2009-09-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,7 @@ files:
 - examples/ctest3.rb
 - examples/ctest4.rb
 - examples/ctest5.rb
+- examples/example-ruby-talk-26July2009.rb
 - examples/example-ruby-talk-30April2004.rb
 - examples/fixed-array.rb
 - examples/inherit-example.rb
@@ -118,6 +119,6 @@ signing_key:
 specification_version: 3
 summary: Library for packed binary data stored in ruby Strings
 test_files: 
-- test/test-attribute.rb
 - test/test-cgen.rb
+- test/test-attribute.rb
 - test/test-cshadow.rb