ruby-core

Hi,
I mailed this RDoc patch to ruby-doc a few months ago, but didn't get
any feedback, although parts of it have been applied to CVS it seems.

Is this the right mailing list for this kind of patch?

(Updated patch so it works with Ruby 1.8.2. Also, extra whitespace
before the *closing* parenthesis isn't accepted for
rb_define_filetest_function(), rb_define_global_function() and
rb_define_module_function() etc. cause I didn't understand the regex that's
used ;)

----- Forwarded message from Tilman Sauerbeck <tilman@code-monkey.de> -----

Date: Sun, 1 Aug 2004 10:30:47 +0200
From: Tilman Sauerbeck <tilman@code-monkey.de>
Reply-To: ruby-doc@ruby-lang.org
Subject: [PATCH] parse_c.rb: allow whitespace after function names
To: ruby-doc@ruby-lang.org
User-Agent: Mutt/1.4.2.1i

Hi,
here's a patch for rdoc (as shipped with ruby 1.8.1) that allows the
use of whitespace between a function name and the opening parenthesis,
like this:

rb_define_class_under (mFoo, "Bar", rb_cObject);
                     ^
Without the patch, rdoc wouldn't recognize the class definition because
it expects the opening parenthesis to appear just after the function
name.

I know omitting the space before the parenthesis is "ruby style", but
IMHO it makes sense to allow it for C code.

Please comment.

-- 
Regards,
Tilman

Attachments (1)

rdoc-allow_whitespace.diff (3.69 KB, text/x-diff)

diff -aur ruby-1.8.2.orig/lib/rdoc/parsers/parse_c.rb ruby-1.8.2/lib/rdoc/parsers/parse_c.rb
--- ruby-1.8.2.orig/lib/rdoc/parsers/parse_c.rb	2004-09-09 04:48:32.000000000 +0200
+++ ruby-1.8.2/lib/rdoc/parsers/parse_c.rb	2005-01-20 18:48:21.084557296 +0100
@@ -249,13 +249,13 @@
     ############################################################
 
     def do_classes
-      @body.scan(/(\w+)\s* = \s*rb_define_module\(\s*"(\w+)"\s*\)/mx) do 
+      @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
+      @body.scan(/([\w\.]+)\s* = \s*rb_define_class\s*
                 \( 
                    \s*"(\w+)",
                    \s*(\w+)\s*
@@ -265,7 +265,7 @@
         handle_class_module(var_name, "class", class_name, parent, nil)
       end
       
-      @body.scan(/(\w+)\s*=\s*boot_defclass\(\s*"(\w+?)",\s*(\w+?)\)/) do
+      @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)
@@ -281,12 +281,12 @@
         handle_class_module(var_name, "module", class_name, nil, in_module)
       end
       
-      @body.scan(/([\w\.]+)\s* = \s*rb_define_class_under
+      @body.scan(/([\w\.]+)\s* = \s*rb_define_class_under\s*
                 \( 
                    \s*(\w+),
                    \s*"(\w+)",
                    \s*(\w+)\s*
-                \)/mx) do 
+                \s*\)/mx) do 
         
         |var_name, in_module, class_name, parent|
         handle_class_module(var_name, "class", class_name, parent, in_module)
@@ -305,7 +305,7 @@
                         module_function  |
                         private_method
                      )
-                     \(\s*([\w\.]+),
+                     \s*\(\s*([\w\.]+),
                        \s*"([^"]+)",
                        \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                        \s*(-?\w+)\s*\)
@@ -325,7 +325,7 @@
                       meth_body, param_count, source_file)
       end
 
-      @body.scan(%r{rb_define_global_function\(
+      @body.scan(%r{rb_define_global_function\s*\(
                                \s*"([^"]+)",
                                \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                                \s*(-?\w+)\s*\)
@@ -336,7 +336,7 @@
                       meth_body, param_count, source_file)
       end
   
-      @body.scan(/define_filetest_function\(
+      @body.scan(/define_filetest_function\s*\(
                                \s*"([^"]+)",
                                \s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
                                \s*(-?\w+)\s*\)/xm) do  #"
@@ -350,7 +350,7 @@
     ############################################################
     
     def do_aliases
-      @body.scan(%r{rb_define_alias\(\s*(\w+),\s*"([^"]+)",\s*"([^"]+)"\s*\)}m) do
+      @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
@@ -482,7 +482,7 @@
     # Look for includes of the form
     #     rb_include_module(rb_cArray, rb_mEnumerable);
     def do_includes
-      @body.scan(/rb_include_module\(\s*(\w+?),\s*(\w+?)\s*\)/) do |c,m|
+      @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, ""))

Thread

Prev Next

In This Thread

Prev Next