rdoc 2.0.0 → 2.1.0

data/test/test_rdoc_ri_default_display.rb

@@ -4,7 +4,7 @@ require 'rdoc/ri/formatter'
 require 'rdoc/ri/display'
 require 'rdoc/ri/driver'
 
-class TestRDocRIDefaultDisplay < Test::Unit::TestCase
+class TestRdocRiDefaultDisplay < Test::Unit::TestCase
 
   def setup
     @output = StringIO.new
@@ -14,7 +14,7 @@ class TestRDocRIDefaultDisplay < Test::Unit::TestCase
     @dd = RDoc::RI::DefaultDisplay.new RDoc::RI::Formatter, @width, true,
                                        @output
 
-    @some_method = {
+    @some_method = h \
       'aliases' => [{'name' => 'some_method_alias'}],
       'block_params' => 'block_param',
       'comment' => [RDoc::Markup::Flow::P.new('some comment')],
@@ -23,13 +23,12 @@ class TestRDocRIDefaultDisplay < Test::Unit::TestCase
       'name' => 'some_method',
       'params' => '(arg1, arg2) {|block_param| ...}',
       'source_path' => '/nonexistent',
-      'visibility' => 'public',
-    }
+      'visibility' => 'public'
   end
 
   def test_display_class_info
     ri_reader = nil
-    klass = {
+    klass = h \
       'attributes' => [
         { 'name' => 'attribute', 'rw' => 'RW',
           'comment' => [RDoc::Markup::Flow::P.new('attribute comment')] },
@@ -58,8 +57,7 @@ class TestRDocRIDefaultDisplay < Test::Unit::TestCase
       'instance_method_extensions' => [
         { 'name' => 'instance_method_extension' },
       ],
-      'superclass_string' => 'Object',
-    }
+      'superclass_string' => 'Object'
 
     @dd.display_class_info klass, ri_reader
 
@@ -154,7 +152,7 @@ Attributes:
   end
 
   def test_display_method_info_singleton
-    method = {
+    method = RDoc::RI::Driver::Hash.new.update \
       'aliases' => [],
       'block_params' => nil,
       'comment' => nil,
@@ -162,8 +160,7 @@ Attributes:
       'is_singleton' => true,
       'name' => 'some_method',
       'params' => '(arg1, arg2)',
-      'visibility' => 'public',
-    }
+      'visibility' => 'public'
 
     @dd.display_method_info method
 
@@ -179,7 +176,7 @@ Attributes:
 
   def test_display_method_list
     methods = [
-      {
+      RDoc::RI::Driver::Hash.new.update(
         "aliases" => [],
         "block_params" => nil,
         "comment" =>  nil,
@@ -187,9 +184,9 @@ Attributes:
         "is_singleton" => false,
         "name" => "some_method",
         "params" => "()",
-        "visibility" => "public",
-      },
-      {
+        "visibility" => "public"
+      ),
+      RDoc::RI::Driver::Hash.new.update(
         "aliases" => [],
         "block_params" => nil,
         "comment" => nil,
@@ -197,8 +194,8 @@ Attributes:
         "is_singleton" => false,
         "name" => "some_other_method",
         "params" => "()",
-        "visibility" => "public",
-      },
+        "visibility" => "public"
+      ),
     ]
 
     @dd.display_method_list methods
@@ -291,5 +288,9 @@ install an additional package, or ask the packager to enable ri generation.
     assert_equal expected, @output.string
   end
 
+  def h(hash)
+    RDoc::RI::Driver::Hash.convert hash
+  end
+
 end
 

data/test/test_rdoc_ri_driver.rb

@@ -0,0 +1,92 @@
+require 'test/unit'
+require 'tmpdir'
+require 'rdoc/ri/driver'
+
+class TestRDocRIDriver < Test::Unit::TestCase
+
+  def setup
+    @tmpdir = File.join Dir.tmpdir, "test_rdoc_ri_driver_#{$$}"
+    @home_ri = File.join @tmpdir, 'dot_ri'
+    @cache_dir = File.join @home_ri, 'cache'
+    @class_cache = File.join @cache_dir, 'classes'
+
+    FileUtils.mkdir_p @tmpdir
+    FileUtils.mkdir_p @home_ri
+    FileUtils.mkdir_p @cache_dir
+
+    @driver = RDoc::RI::Driver.new
+    @driver.homepath = @home_ri
+  end
+
+  def teardown
+    FileUtils.rm_rf @tmpdir
+  end
+
+  def test_lookup_method
+    def @driver.load_cache_for(klassname)
+      { 'Foo#bar' => :found }
+    end
+
+    assert @driver.lookup_method('Foo#bar',  'Foo')
+  end
+
+  def test_lookup_method_class_method
+    def @driver.load_cache_for(klassname)
+      { 'Foo::Bar' => :found }
+    end
+
+    assert @driver.lookup_method('Foo::Bar', 'Foo::Bar')
+  end
+
+  def test_lookup_method_class_missing
+    def @driver.load_cache_for(klassname) end
+
+    assert_nil @driver.lookup_method('Foo#bar', 'Foo')
+  end
+
+  def test_lookup_method_dot_instance
+    def @driver.load_cache_for(klassname)
+      { 'Foo#bar' => :instance, 'Foo::bar' => :klass }
+    end
+
+    assert_equal :instance, @driver.lookup_method('Foo.bar', 'Foo')
+  end
+
+  def test_lookup_method_dot_class
+    def @driver.load_cache_for(klassname)
+      { 'Foo::bar' => :found }
+    end
+
+    assert @driver.lookup_method('Foo.bar', 'Foo')
+  end
+
+  def test_lookup_method_method_missing
+    def @driver.load_cache_for(klassname) {} end
+
+    assert_nil @driver.lookup_method('Foo#bar', 'Foo')
+  end
+
+  def test_parse_name
+    klass, meth = @driver.parse_name 'Foo::Bar'
+
+    assert_equal 'Foo::Bar', klass, 'Foo::Bar class'
+    assert_equal nil,        meth,  'Foo::Bar method'
+
+    klass, meth = @driver.parse_name 'Foo#Bar'
+
+    assert_equal 'Foo', klass, 'Foo#Bar class'
+    assert_equal 'Bar', meth,  'Foo#Bar method'
+
+    klass, meth = @driver.parse_name 'Foo.Bar'
+
+    assert_equal 'Foo', klass, 'Foo#Bar class'
+    assert_equal 'Bar', meth,  'Foo#Bar method'
+
+    klass, meth = @driver.parse_name 'Foo::bar'
+
+    assert_equal 'Foo', klass, 'Foo::bar class'
+    assert_equal 'bar', meth,  'Foo::bar method'
+  end
+
+end
+

metadata

@@ -1,31 +1,55 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Eric Hodel
 - Dave Thomas
+- Phil Hagelberg
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
 
-date: 2008-04-10 00:00:00 -07:00
+date: 2008-07-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.1
+        version: 1.7.0
     version: 
 description: RDoc is an application that produces documentation for one or more Ruby source files.  RDoc includes the `rdoc` and `ri` tools for generating and displaying online documentation.  At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to the RDoc 1.0.1.  Command-line tools are largely unaffected, but internal APIs may shift rapidly.
 email: 
 - drbrain@segment7.net
 - ""
+- technomancy@gmail.com
 executables: 
 - rdoc
 - ri
@@ -50,14 +74,21 @@ files:
 - lib/rdoc/generator/chm.rb
 - lib/rdoc/generator/chm/chm.rb
 - lib/rdoc/generator/html.rb
+- lib/rdoc/generator/html/frameless.rb
 - lib/rdoc/generator/html/hefss.rb
 - lib/rdoc/generator/html/html.rb
 - lib/rdoc/generator/html/kilmer.rb
 - lib/rdoc/generator/html/one_page_html.rb
 - lib/rdoc/generator/ri.rb
+- lib/rdoc/generator/texinfo.rb
+- lib/rdoc/generator/texinfo/class.texinfo.erb
+- lib/rdoc/generator/texinfo/file.texinfo.erb
+- lib/rdoc/generator/texinfo/method.texinfo.erb
+- lib/rdoc/generator/texinfo/texinfo.erb
 - lib/rdoc/generator/xml.rb
 - lib/rdoc/generator/xml/rdf.rb
 - lib/rdoc/generator/xml/xml.rb
+- lib/rdoc/known_classes.rb
 - lib/rdoc/markup.rb
 - lib/rdoc/markup/attribute_manager.rb
 - lib/rdoc/markup/formatter.rb
@@ -70,12 +101,13 @@ files:
 - lib/rdoc/markup/to_html_crossref.rb
 - lib/rdoc/markup/to_latex.rb
 - lib/rdoc/markup/to_test.rb
+- lib/rdoc/markup/to_texinfo.rb
 - lib/rdoc/options.rb
-- lib/rdoc/parsers/parse_c.rb
-- lib/rdoc/parsers/parse_f95.rb
-- lib/rdoc/parsers/parse_rb.rb
-- lib/rdoc/parsers/parse_simple.rb
-- lib/rdoc/parsers/parserfactory.rb
+- lib/rdoc/parser.rb
+- lib/rdoc/parser/c.rb
+- lib/rdoc/parser/f95.rb
+- lib/rdoc/parser/ruby.rb
+- lib/rdoc/parser/simple.rb
 - lib/rdoc/rdoc.rb
 - lib/rdoc/ri.rb
 - lib/rdoc/ri/cache.rb
@@ -90,11 +122,15 @@ files:
 - lib/rdoc/stats.rb
 - lib/rdoc/template.rb
 - lib/rdoc/tokenstream.rb
-- test/test_rdoc_c_parser.rb
+- test/test_rdoc_info_formatting.rb
+- test/test_rdoc_info_sections.rb
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_parser_c.rb
+- test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_ri_attribute_formatter.rb
 - test/test_rdoc_ri_default_display.rb
+- test/test_rdoc_ri_driver.rb
 - test/test_rdoc_ri_formatter.rb
 - test/test_rdoc_ri_overstrike_formatter.rb
 has_rdoc: true
@@ -120,15 +156,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.1.0
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: RDoc is an application that produces documentation for one or more Ruby source files
 test_files: 
-- test/test_rdoc_c_parser.rb
+- test/test_rdoc_info_formatting.rb
+- test/test_rdoc_info_sections.rb
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_markup_to_html.rb
+- test/test_rdoc_markup_to_html_crossref.rb
+- test/test_rdoc_parser_c.rb
+- test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_ri_attribute_formatter.rb
 - test/test_rdoc_ri_default_display.rb
+- test/test_rdoc_ri_driver.rb
 - test/test_rdoc_ri_formatter.rb
 - test/test_rdoc_ri_overstrike_formatter.rb

data/lib/rdoc/parsers/parse_c.rb

@@ -1,775 +0,0 @@
-# Classes and modules built in to the interpreter. We need
-# these to define superclasses of user objects
-
-require "rdoc/code_objects"
-require "rdoc/parsers/parserfactory"
-require "rdoc/rdoc"
-
-module RDoc
-
-  ##
-  # Ruby's built-in classes.
-
-  KNOWN_CLASSES = {
-    "rb_cObject"           => "Object",
-    "rb_cArray"            => "Array",
-    "rb_cBignum"           => "Bignum",
-    "rb_cClass"            => "Class",
-    "rb_cDir"              => "Dir",
-    "rb_cData"             => "Data",
-    "rb_cFalseClass"       => "FalseClass",
-    "rb_cFile"             => "File",
-    "rb_cFixnum"           => "Fixnum",
-    "rb_cFloat"            => "Float",
-    "rb_cHash"             => "Hash",
-    "rb_cInteger"          => "Integer",
-    "rb_cIO"               => "IO",
-    "rb_cModule"           => "Module",
-    "rb_cNilClass"         => "NilClass",
-    "rb_cNumeric"          => "Numeric",
-    "rb_cProc"             => "Proc",
-    "rb_cRange"            => "Range",
-    "rb_cRegexp"           => "Regexp",
-    "rb_cString"           => "String",
-    "rb_cSymbol"           => "Symbol",
-    "rb_cThread"           => "Thread",
-    "rb_cTime"             => "Time",
-    "rb_cTrueClass"        => "TrueClass",
-    "rb_cStruct"           => "Struct",
-    "rb_cVM"               => "VM",
-    "rb_eException"        => "Exception",
-    "rb_eStandardError"    => "StandardError",
-    "rb_eSystemExit"       => "SystemExit",
-    "rb_eInterrupt"        => "Interrupt",
-    "rb_eSignal"           => "Signal",
-    "rb_eFatal"            => "Fatal",
-    "rb_eArgError"         => "ArgError",
-    "rb_eEOFError"         => "EOFError",
-    "rb_eIndexError"       => "IndexError",
-    "rb_eRangeError"       => "RangeError",
-    "rb_eIOError"          => "IOError",
-    "rb_eRuntimeError"     => "RuntimeError",
-    "rb_eSecurityError"    => "SecurityError",
-    "rb_eSystemCallError"  => "SystemCallError",
-    "rb_eTypeError"        => "TypeError",
-    "rb_eZeroDivError"     => "ZeroDivError",
-    "rb_eNotImpError"      => "NotImpError",
-    "rb_eNoMemError"       => "NoMemError",
-    "rb_eFloatDomainError" => "FloatDomainError",
-    "rb_eScriptError"      => "ScriptError",
-    "rb_eNameError"        => "NameError",
-    "rb_eSyntaxError"      => "SyntaxError",
-    "rb_eLoadError"        => "LoadError",
-
-    "rb_mKernel"           => "Kernel",
-    "rb_mComparable"       => "Comparable",
-    "rb_mEnumerable"       => "Enumerable",
-    "rb_mPrecision"        => "Precision",
-    "rb_mErrno"            => "Errno",
-    "rb_mFileTest"         => "FileTest",
-    "rb_mGC"               => "GC",
-    "rb_mMath"             => "Math",
-    "rb_mProcess"          => "Process"
-  }
-
-  ##
-  # We attempt to parse C extension files. Basically we look for
-  # the standard patterns that you find in extensions: <tt>rb_define_class,
-  # rb_define_method</tt> and so on. We also try to find the corresponding
-  # C source for the methods and extract comments, but if we fail
-  # we don't worry too much.
-  #
-  # The comments associated with a Ruby method are extracted from the C
-  # comment block associated with the routine that _implements_ that
-  # method, that is to say the method whose name is given in the
-  # <tt>rb_define_method</tt> call. For example, you might write:
-  #
-  #  /*
-  #   * Returns a new array that is a one-dimensional flattening of this
-  #   * array (recursively). That is, for every element that is an array,
-  #   * extract its elements into the new array.
-  #   *
-  #   *    s = [ 1, 2, 3 ]           #=> [1, 2, 3]
-  #   *    t = [ 4, 5, 6, [7, 8] ]   #=> [4, 5, 6, [7, 8]]
-  #   *    a = [ s, t, 9, 10 ]       #=> [[1, 2, 3], [4, 5, 6, [7, 8]], 9, 10]
-  #   *    a.flatten                 #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
-  #   */
-  #   static VALUE
-  #   rb_ary_flatten(ary)
-  #       VALUE ary;
-  #   {
-  #       ary = rb_obj_dup(ary);
-  #       rb_ary_flatten_bang(ary);
-  #       return ary;
-  #   }
-  #
-  #   ...
-  #
-  #   void
-  #   Init_Array()
-  #   {
-  #     ...
-  #     rb_define_method(rb_cArray, "flatten", rb_ary_flatten, 0);
-  #
-  # Here RDoc will determine from the rb_define_method line that there's a
-  # method called "flatten" in class Array, and will look for the implementation
-  # in the method rb_ary_flatten. It will then use the comment from that
-  # method in the HTML output. This method must be in the same source file
-  # as the rb_define_method.
-  #
-  # C classes can be diagramed (see /tc/dl/ruby/ruby/error.c), and RDoc
-  # integrates C and Ruby source into one tree
-  #
-  # The comment blocks may include special direcives:
-  #
-  # [Document-class: <i>name</i>]
-  #   This comment block is documentation for the given class. Use this
-  #   when the <tt>Init_xxx</tt> method is not named after the class.
-  #
-  # [Document-method: <i>name</i>]
-  #   This comment documents the named method. Use when RDoc cannot
-  #   automatically find the method from it's declaration
-  #
-  # [call-seq:  <i>text up to an empty line</i>]
-  #   Because C source doesn't give descripive names to Ruby-level parameters,
-  #   you need to document the calling sequence explicitly
-  #
-  # In additon, RDoc assumes by default that the C method implementing a 
-  # Ruby function is in the same source file as the rb_define_method call.
-  # If this isn't the case, add the comment 
-  #
-  #    rb_define_method(....);  // in: filename
-  #
-  # As an example, we might have an extension that defines multiple classes
-  # in its Init_xxx method. We could document them using
-  #
-  #  
-  #  /*
-  #   * Document-class:  MyClass
-  #   *
-  #   * Encapsulate the writing and reading of the configuration
-  #   * file. ...
-  #   */
-  #  
-  #  /*
-  #   * Document-method: read_value
-  #   *
-  #   * call-seq:
-  #   *   cfg.read_value(key)            -> value
-  #   *   cfg.read_value(key} { |key| }  -> value
-  #   *
-  #   * Return the value corresponding to +key+ from the configuration.
-  #   * In the second form, if the key isn't found, invoke the
-  #   * block and return its value.
-  #   */
-  #
-
-  class C_Parser
-
-    attr_writer :progress
-
-    extend ParserFactory
-    parse_files_matching(/\.(?:([CcHh])\1?|c([+xp])\2|y)\z/)
-
-    @@enclosure_classes = {}
-    @@known_bodies = {}
-
-    # prepare to parse a C file
-    def initialize(top_level, file_name, body, options, stats)
-      @known_classes = KNOWN_CLASSES.dup
-      @options = options
-      @body = handle_tab_width(handle_ifdefs_in(body))
-      @stats   = stats
-      @top_level = top_level
-      @classes = Hash.new
-      @file_dir = File.dirname(file_name)
-      @progress = $stderr unless @options.quiet
-    end
-
-    # Extract the classes/modules and methods from a C file
-    # and return the corresponding top-level object
-    def scan
-      remove_commented_out_lines
-      do_classes
-      do_constants
-      do_methods
-      do_includes
-      do_aliases
-      @top_level
-    end
-
-    #######
-    private
-    #######
-
-    def progress(char)
-      unless @options.quiet
-        @progress.print(char)
-        @progress.flush
-      end
-    end
-
-    def warn(msg)
-      $stderr.puts
-      $stderr.puts msg
-      $stderr.flush
-    end
-
-    def remove_private_comments(comment)
-       comment.gsub!(/\/?\*--(.*?)\/?\*\+\+/m, '')
-       comment.sub!(/\/?\*--.*/m, '')
-    end
-
-    ##
-    # removes lines that are commented out that might otherwise get picked up
-    # when scanning for classes and methods
-
-    def remove_commented_out_lines
-      @body.gsub!(%r{//.*rb_define_}, '//')
-    end
-    
-    def handle_class_module(var_name, class_mod, class_name, parent, in_module)
-      progress(class_mod[0, 1])
-
-      parent_name = @known_classes[parent] || parent
-
-      if in_module
-        enclosure = @classes[in_module] || @@enclosure_classes[in_module]
-        unless enclosure
-          if enclosure = @known_classes[in_module]
-            handle_class_module(in_module, (/^rb_m/ =~ in_module ? "module" : "class"),
-                                enclosure, nil, nil)
-            enclosure = @classes[in_module]
-          end
-        end
-        unless enclosure
-          warn("Enclosing class/module '#{in_module}' for " +
-                "#{class_mod} #{class_name} not known")
-          return
-        end
-      else
-        enclosure = @top_level
-      end
-
-      if class_mod == "class" 
-        cm = enclosure.add_class(NormalClass, class_name, parent_name)
-        @stats.num_classes += 1
-      else
-        cm = enclosure.add_module(NormalModule, class_name)
-        @stats.num_modules += 1
-      end
-      cm.record_location(enclosure.toplevel)
-
-      find_class_comment(cm.full_name, cm)
-      @classes[var_name] = cm
-      @@enclosure_classes[var_name] = cm
-      @known_classes[var_name] = cm.full_name
-    end
-
-    ##
-    # Look for class or module documentation above Init_+class_name+(void),
-    # in a Document-class +class_name+ (or module) comment or above an
-    # rb_define_class (or module).  If a comment is supplied above a matching
-    # Init_ and a rb_define_class the Init_ comment is used.
-    #
-    #   /*
-    #    * This is a comment for Foo
-    #    */
-    #   Init_Foo(void) {
-    #       VALUE cFoo = rb_define_class("Foo", rb_cObject);
-    #   }
-    #
-    #   /*
-    #    * Document-class: Foo
-    #    * This is a comment for Foo
-    #    */
-    #   Init_foo(void) {
-    #       VALUE cFoo = rb_define_class("Foo", rb_cObject);
-    #   }
-    #
-    #   /*
-    #    * This is a comment for Foo
-    #    */
-    #   VALUE cFoo = rb_define_class("Foo", rb_cObject);
-
-    def find_class_comment(class_name, class_meth)
-      comment = nil
-      if @body =~ %r{((?>/\*.*?\*/\s+))
-                     (static\s+)?void\s+Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)\)}xmi
-        comment = $1
-      elsif @body =~ %r{Document-(class|module):\s#{class_name}\s*?\n((?>.*?\*/))}m
-        comment = $2
-      else
-        if @body =~ /rb_define_(class|module)/m then
-          class_name = class_name.split("::").last
-          comments = []
-          @body.split(/(\/\*.*?\*\/)\s*?\n/m).each_with_index do |chunk, index|
-            comments[index] = chunk
-            if chunk =~ /rb_define_(class|module).*?"(#{class_name})"/m then
-              comment = comments[index-1]
-              break
-            end
-          end
-        end
-      end
-      class_meth.comment = mangle_comment(comment) if comment
-    end
-    
-    ############################################################
-
-    def do_classes
-      @body.scan(/(\w+)\s* = \s*rb_define_module\s*\(\s*"(\w+)"\s*\)/mx) do 
-        |var_name, class_name|
-        handle_class_module(var_name, "module", class_name, nil, nil)
-      end
-      
-      # The '.' lets us handle SWIG-generated files
-      @body.scan(/([\w\.]+)\s* = \s*rb_define_class\s*
-                \( 
-                   \s*"(\w+)",
-                   \s*(\w+)\s*
-                \)/mx) do 
-        
-        |var_name, class_name, parent|
-        handle_class_module(var_name, "class", class_name, parent, nil)
-      end
-      
-      @body.scan(/(\w+)\s*=\s*boot_defclass\s*\(\s*"(\w+?)",\s*(\w+?)\s*\)/) do
-        |var_name, class_name, parent|
-        parent = nil if parent == "0"
-        handle_class_module(var_name, "class", class_name, parent, nil)
-      end
-
-      @body.scan(/(\w+)\s* = \s*rb_define_module_under\s*
-                \( 
-                   \s*(\w+),
-                   \s*"(\w+)"
-                \s*\)/mx) do 
-        
-        |var_name, in_module, class_name|
-        handle_class_module(var_name, "module", class_name, nil, in_module)
-      end
-      
-      @body.scan(/([\w\.]+)\s* = \s*rb_define_class_under\s*
-                \( 
-                   \s*(\w+),
-                   \s*"(\w+)",
-                   \s*(\w+)\s*
-                \s*\)/mx) do 
-        
-        |var_name, in_module, class_name, parent|
-        handle_class_module(var_name, "class", class_name, parent, in_module)
-      end
-      
-    end
-
-		###########################################################
-
-    def do_constants
-      @body.scan(%r{\Wrb_define_
-                     (
-                        variable |
-                        readonly_variable |
-                        const |
-                        global_const |
-                      )
-                 \s*\( 
-                   (?:\s*(\w+),)?
-                   \s*"(\w+)",
-                   \s*(.*?)\s*\)\s*;
-                   }xm) do
-        
-        |type, var_name, const_name, definition|
-        var_name = "rb_cObject" if !var_name or var_name == "rb_mKernel"
-				handle_constants(type, var_name, const_name, definition)
-      end
-    end
-    
-    ############################################################
-    
-    def do_methods
-
-      @body.scan(%r{rb_define_
-                     (
-                        singleton_method |
-                        method           |
-                        module_function  |
-                        private_method
-                     )
-                     \s*\(\s*([\w\.]+),
-                       \s*"([^"]+)",
-                       \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
-                       \s*(-?\w+)\s*\)
-                     (?:;\s*/[*/]\s+in\s+(\w+?\.[cy]))?
-                   }xm) do
-        |type, var_name, meth_name, meth_body, param_count, source_file|
-       #" 
-
-        # Ignore top-object and weird struct.c dynamic stuff
-        next if var_name == "ruby_top_self" 
-        next if var_name == "nstr"
-        next if var_name == "envtbl"
-        next if var_name == "argf"   # it'd be nice to handle this one
-
-        var_name = "rb_cObject" if var_name == "rb_mKernel"
-        handle_method(type, var_name, meth_name, 
-                      meth_body, param_count, source_file)
-      end
-
-      @body.scan(%r{rb_define_attr\(
-                               \s*([\w\.]+),
-                               \s*"([^"]+)",
-                               \s*(\d+),
-                               \s*(\d+)\s*\);
-                  }xm) do  #"
-        |var_name, attr_name, attr_reader, attr_writer|
-        
-        #var_name = "rb_cObject" if var_name == "rb_mKernel"
-        handle_attr(var_name, attr_name,
-                    attr_reader.to_i != 0,
-                    attr_writer.to_i != 0)
-      end
-
-      @body.scan(%r{rb_define_global_function\s*\(
-                               \s*"([^"]+)",
-                               \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
-                               \s*(-?\w+)\s*\)
-                  (?:;\s*/[*/]\s+in\s+(\w+?\.[cy]))?
-                  }xm) do  #"
-        |meth_name, meth_body, param_count, source_file|
-        handle_method("method", "rb_mKernel", meth_name, 
-                      meth_body, param_count, source_file)
-      end
-  
-      @body.scan(/define_filetest_function\s*\(
-                               \s*"([^"]+)",
-                               \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
-                               \s*(-?\w+)\s*\)/xm) do  #"
-        |meth_name, meth_body, param_count|
-        
-        handle_method("method", "rb_mFileTest", meth_name, meth_body, param_count)
-        handle_method("singleton_method", "rb_cFile", meth_name, meth_body, param_count)
-      end
-   end
-
-    ############################################################
-    
-    def do_aliases
-      @body.scan(%r{rb_define_alias\s*\(\s*(\w+),\s*"([^"]+)",\s*"([^"]+)"\s*\)}m) do
-        |var_name, new_name, old_name|
-        @stats.num_methods += 1
-        class_name = @known_classes[var_name] || var_name
-        class_obj  = find_class(var_name, class_name)
-
-        class_obj.add_alias(Alias.new("", old_name, new_name, ""))
-      end
-   end
-
-    ##
-    # Adds constant comments.  By providing some_value: at the start ofthe
-    # comment you can override the C value of the comment to give a friendly
-    # definition.
-    #
-    #   /* 300: The perfect score in bowling */
-    #   rb_define_const(cFoo, "PERFECT", INT2FIX(300);
-    #
-    # Will override +INT2FIX(300)+ with the value +300+ in the output RDoc.
-    # Values may include quotes and escaped colons (\:).
-
-    def handle_constants(type, var_name, const_name, definition)
-      #@stats.num_constants += 1
-      class_name = @known_classes[var_name]
-      
-      return unless class_name
-
-      class_obj  = find_class(var_name, class_name)
-
-      unless class_obj
-        warn("Enclosing class/module '#{const_name}' for not known")
-        return
-      end
-      
-      comment = find_const_comment(type, const_name)
-
-      # In the case of rb_define_const, the definition and comment are in
-      # "/* definition: comment */" form.  The literal ':' and '\' characters
-      # can be escaped with a backslash.
-      if type.downcase == 'const' then
-         elements = mangle_comment(comment).split(':')
-         if elements.nil? or elements.empty? then
-            con = Constant.new(const_name, definition, mangle_comment(comment))
-         else
-            new_definition = elements[0..-2].join(':')
-            if new_definition.empty? then # Default to literal C definition
-               new_definition = definition
-            else
-               new_definition.gsub!("\:", ":")
-               new_definition.gsub!("\\", '\\')
-            end
-            new_definition.sub!(/\A(\s+)/, '')
-            new_comment = $1.nil? ? elements.last : "#{$1}#{elements.last.lstrip}"
-            con = Constant.new(const_name, new_definition,
-                               mangle_comment(new_comment))
-         end
-      else
-         con = Constant.new(const_name, definition, mangle_comment(comment))
-      end
-
-      class_obj.add_constant(con)
-    end
-
-    ##
-    # Finds a comment matching +type+ and +const_name+ either above the
-    # comment or in the matching Document- section.
-
-    def find_const_comment(type, const_name)
-      if @body =~ %r{((?>^\s*/\*.*?\*/\s+))
-                     rb_define_#{type}\((?:\s*(\w+),)?\s*"#{const_name}"\s*,.*?\)\s*;}xmi
-        $1
-      elsif @body =~ %r{Document-(?:const|global|variable):\s#{const_name}\s*?\n((?>.*?\*/))}m
-        $1
-      else
-        ''
-      end
-    end
-
-    ###########################################################
-
-    def handle_attr(var_name, attr_name, reader, writer)
-      rw = ''
-      if reader 
-        #@stats.num_methods += 1
-        rw << 'R'
-      end
-      if writer
-        #@stats.num_methods += 1
-        rw << 'W'
-      end
-
-      class_name = @known_classes[var_name]
-
-      return unless class_name
-      
-      class_obj  = find_class(var_name, class_name)
-
-      if class_obj
-        comment = find_attr_comment(attr_name)
-        unless comment.empty?
-          comment = mangle_comment(comment)
-        end
-        att = Attr.new('', attr_name, rw, comment)
-        class_obj.add_attribute(att)
-      end
-
-    end
-
-    ###########################################################
-
-    def find_attr_comment(attr_name)
-      if @body =~ %r{((?>/\*.*?\*/\s+))
-                     rb_define_attr\((?:\s*(\w+),)?\s*"#{attr_name}"\s*,.*?\)\s*;}xmi
-        $1
-      elsif @body =~ %r{Document-attr:\s#{attr_name}\s*?\n((?>.*?\*/))}m
-        $1
-      else
-        ''
-      end
-    end
-
-    ###########################################################
-
-    def handle_method(type, var_name, meth_name, 
-                      meth_body, param_count, source_file = nil)
-      progress(".")
-
-      @stats.num_methods += 1
-      class_name = @known_classes[var_name]
-
-      return unless class_name
-
-      class_obj  = find_class(var_name, class_name)
-      
-      if class_obj
-        if meth_name == "initialize"
-          meth_name = "new"
-          type = "singleton_method"
-        end
-        meth_obj = AnyMethod.new("", meth_name)
-        meth_obj.singleton =
-	  %w{singleton_method module_function}.include?(type) 
-        
-        p_count = (Integer(param_count) rescue -1)
-        
-        if p_count < 0
-          meth_obj.params = "(...)"
-        elsif p_count == 0
-          meth_obj.params = "()"
-        else
-          meth_obj.params = "(" +
-                            (1..p_count).map{|i| "p#{i}"}.join(", ") + 
-                                                ")"
-        end
-
-        if source_file
-          file_name = File.join(@file_dir, source_file)
-          body = (@@known_bodies[source_file] ||= File.read(file_name))
-        else
-          body = @body
-        end
-        if find_body(meth_body, meth_obj, body) and meth_obj.document_self
-          class_obj.add_method(meth_obj)
-        end
-      end
-    end
-    
-    ############################################################
-
-    # Find the C code corresponding to a Ruby method
-    def find_body(meth_name, meth_obj, body, quiet = false)
-      case body
-      when %r"((?>/\*.*?\*/\s*))(?:static\s+)?VALUE\s+#{meth_name}
-              \s*(\([^)]*\))\s*\{.*?^\}"xm
-        comment, params = $1, $2
-        body_text = $&
-
-        remove_private_comments(comment) if comment
-
-        # see if we can find the whole body
-        
-        re = Regexp.escape(body_text) + '[^(]*^\{.*?^\}'
-        if Regexp.new(re, Regexp::MULTILINE).match(body)
-          body_text = $&
-        end
-
-        # The comment block may have been overridden with a
-        # 'Document-method' block. This happens in the interpreter
-        # when multiple methods are vectored through to the same
-        # C method but those methods are logically distinct (for
-        # example Kernel.hash and Kernel.object_id share the same
-        # implementation
-
-        override_comment = find_override_comment(meth_obj.name)
-        comment = override_comment if override_comment
-
-        find_modifiers(comment, meth_obj) if comment
-        
-#        meth_obj.params = params
-        meth_obj.start_collecting_tokens
-        meth_obj.add_token(RubyToken::Token.new(1,1).set_text(body_text))
-        meth_obj.comment = mangle_comment(comment)
-      when %r{((?>/\*.*?\*/\s*))^\s*\#\s*define\s+#{meth_name}\s+(\w+)}m
-        comment = $1
-        find_body($2, meth_obj, body, true)
-        find_modifiers(comment, meth_obj)
-        meth_obj.comment = mangle_comment(comment) + meth_obj.comment
-      when %r{^\s*\#\s*define\s+#{meth_name}\s+(\w+)}m
-        unless find_body($1, meth_obj, body, true)
-          warn "No definition for #{meth_name}" unless quiet
-          return false
-        end
-      else
-
-        # No body, but might still have an override comment
-        comment = find_override_comment(meth_obj.name)
-
-        if comment
-          find_modifiers(comment, meth_obj)
-          meth_obj.comment = mangle_comment(comment)
-        else
-          warn "No definition for #{meth_name}" unless quiet
-          return false
-        end
-      end
-      true
-    end
-
-
-    ##
-    # If the comment block contains a section that looks like:
-    #
-    #    call-seq:
-    #        Array.new
-    #        Array.new(10)
-    #
-    # use it for the parameters.
-
-    def find_modifiers(comment, meth_obj)
-      if comment.sub!(/:nodoc:\s*^\s*\*?\s*$/m, '') or
-         comment.sub!(/\A\/\*\s*:nodoc:\s*\*\/\Z/, '')
-        meth_obj.document_self = false
-      end
-      if comment.sub!(/call-seq:(.*?)^\s*\*?\s*$/m, '') or
-         comment.sub!(/\A\/\*\s*call-seq:(.*?)\*\/\Z/, '')
-        seq = $1
-        seq.gsub!(/^\s*\*\s*/, '')
-        meth_obj.call_seq = seq
-      end
-    end
-
-    ############################################################
-
-    def find_override_comment(meth_name)
-      name = Regexp.escape(meth_name)
-      if @body =~ %r{Document-method:\s#{name}\s*?\n((?>.*?\*/))}m
-        $1
-      end
-    end
-
-    ##
-    # Look for includes of the form:
-    #
-    #     rb_include_module(rb_cArray, rb_mEnumerable);
-
-    def do_includes
-      @body.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |c,m|
-        if cls = @classes[c]
-          m = @known_classes[m] || m
-          cls.add_include(Include.new(m, ""))
-        end
-      end
-    end
-
-    ##
-    # Remove the /*'s and leading asterisks from C comments
-    
-    def mangle_comment(comment)
-      comment.sub!(%r{/\*+}) { " " * $&.length }
-      comment.sub!(%r{\*+/}) { " " * $&.length }
-      comment.gsub!(/^[ \t]*\*/m) { " " * $&.length }
-      comment
-    end
-
-    def find_class(raw_name, name)
-      unless @classes[raw_name]
-        if raw_name =~ /^rb_m/ 
-          @classes[raw_name] = @top_level.add_module(NormalModule, name)
-        else
-          @classes[raw_name] = @top_level.add_class(NormalClass, name, nil)
-        end
-      end
-      @classes[raw_name]
-    end
-
-    def handle_tab_width(body)
-      if /\t/ =~ body
-        tab_width = @options.tab_width
-        body.split(/\n/).map do |line|
-          1 while line.gsub!(/\t+/) { ' ' * (tab_width*$&.length - $`.length % tab_width)}  && $~ #`
-          line
-        end .join("\n")
-      else
-        body
-      end
-    end
-
-    ##
-    # Removes #ifdefs that would otherwise confuse us
-    
-    def handle_ifdefs_in(body)
-      body.gsub(/^#ifdef HAVE_PROTOTYPES.*?#else.*?\n(.*?)#endif.*?\n/m, '\1')
-    end
-    
-  end
-
-end
-