Record line and byte offsets for C methods

Author: drbrain

History.txt

@@ -6,6 +6,7 @@
     provide a call-seq.
   * RDoc::Parser::C now records the function name for methods implemented in
     C.
+  * RDoc now records file and byte offset inforamtion for methods.
 * Bug fixes
   * Locations of module aliases are now recorded.
   * RDoc::Parser::C finds method bodies better now.

lib/rdoc/code_object.rb

@@ -60,11 +60,23 @@ class RDoc::CodeObject
 
   attr_reader :force_documentation
 
+  ##
+  # Line in #file where this CodeObject was defined
+
+  attr_accessor :line
+
   ##
   # Hash of arbitrary metadata for this CodeObject
 
   attr_reader :metadata
 
+  ##
+  # Offset in #file where this CodeObject was defined
+  #--
+  # TODO character or byte?
+
+  attr_accessor :offset
+
   ##
   # Our parent CodeObject
 

lib/rdoc/parser/c.rb

@@ -379,11 +379,11 @@ def find_body class_name, meth_name, meth_obj, file_content, quiet = false
              \s*(\(.*?\))([^;]|$))%xm then
       comment = $1
       body = $2
+      offset = $~.offset(2).first
 
       remove_private_comments comment if comment
 
-      # see if we can find the whole body
-
+      # try to find the whole body
       body = $& if /#{Regexp.escape body}[^(]*?\{.*?^\}/m =~ file_content
 
       # The comment block may have been overridden with a 'Document-method'
@@ -403,11 +403,15 @@ def find_body class_name, meth_name, meth_obj, file_content, quiet = false
       tk.set_text body
       meth_obj.add_token tk
       meth_obj.comment = strip_stars comment
+      meth_obj.offset  = offset
+      meth_obj.line    = file_content[0, offset].count("\n") + 1
 
       body
     when %r%((?>/\*.*?\*/\s*))^\s*(\#\s*define\s+#{meth_name}\s+(\w+))%m then
       comment = $1
       body = $2
+      offset = $~.offset(2).first
+
       find_body class_name, $3, meth_obj, file_content, true
       find_modifiers comment, meth_obj
 
@@ -416,9 +420,14 @@ def find_body class_name, meth_name, meth_obj, file_content, quiet = false
       tk.set_text body
       meth_obj.add_token tk
       meth_obj.comment = strip_stars(comment) + meth_obj.comment.to_s
+      meth_obj.offset  = offset
+      meth_obj.line    = file_content[0, offset].count("\n") + 1
 
       body
     when %r%^\s*\#\s*define\s+#{meth_name}\s+(\w+)%m then
+      # with no comment we hope the aliased definition has it and use it's
+      # definition
+
       body = find_body(class_name, $1, meth_obj, file_content, true)
 
       return body if body

test/test_rdoc_code_object.rb

@@ -129,6 +129,12 @@ def test_full_name_equals
     assert_nil @co.instance_variable_get(:@full_name)
   end
 
+  def test_line
+    @c1_m.line = 5
+
+    assert_equal 5, @c1_m.line
+  end
+
   def test_metadata
     assert_empty @co.metadata
 
@@ -141,6 +147,12 @@ def test_metadata
     assert_equal 'not_rdoc', @co.metadata['markup']
   end
 
+  def test_offset
+    @c1_m.offset = 5
+
+    assert_equal 5, @c1_m.offset
+  end
+
   def test_parent_file_name
     assert_equal '(unknown)', @co.parent_file_name
     assert_equal 'xref_data.rb', @c1.parent_file_name

test/test_rdoc_parser_c.rb

@@ -581,6 +581,41 @@ def test_find_body_2
 
   def test_find_body_define
     content = <<-EOF
+#define something something_else
+
+#define other_function rb_other_function
+
+/*
+ * a comment for rb_other_function
+ */
+VALUE
+rb_other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "my_method", other_function, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    other_function = klass.method_list.first
+
+    assert_equal 'my_method', other_function.name
+    assert_equal 'a comment for rb_other_function', other_function.comment
+    assert_equal '()', other_function.params
+    assert_equal 118, other_function.offset
+    assert_equal 8, other_function.line
+
+    code = other_function.token_stream.first.text
+
+    assert_equal "VALUE\nrb_other_function() {\n}", code
+  end
+
+  def test_find_body_define_comment
+    content = <<-EOF
 /*
  * a comment for other_function
  */
@@ -603,9 +638,10 @@ def test_find_body_define
     other_function = klass.method_list.first
 
     assert_equal 'my_method', other_function.name
-    assert_equal "a comment for other_function",
-                 other_function.comment
+    assert_equal 'a comment for other_function', other_function.comment
     assert_equal '()', other_function.params
+    assert_equal 39, other_function.offset
+    assert_equal 4, other_function.line
 
     code = other_function.token_stream.first.text
 
@@ -749,18 +785,36 @@ def test_find_modifiers_yields
     assert_equal expected, comment
   end
 
-  def test_handle_method
+  def test_handle_method_args_minus_1
     parser = util_parser "Document-method: Object#m\n blah */"
 
-    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', 2
+    parser.content = <<-BODY
+VALUE
+rb_other(VALUE obj) {
+  rb_funcall(obj, rb_intern("other"), 0);
+  return rb_str_new2("blah, blah, blah");
+}
+
+VALUE
+rb_m(int argc, VALUE *argv, VALUE obj) {
+  VALUE o1, o2;
+  rb_scan_args(argc, argv, "1", &o1, &o2);
+}
+    BODY
+
+    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1
 
     m = @top_level.find_module_named('Object').method_list.first
 
     assert_equal 'm', m.name
-    assert_equal '(p1, p2)', m.params
     assert_equal @top_level, m.file
+    assert_equal 115, m.offset
+    assert_equal 7, m.line
+
+    assert_equal '(p1)', m.params
   end
 
+
   def test_handle_method_args_0
     parser = util_parser "Document-method: BasicObject#==\n blah */"
 
@@ -803,23 +857,7 @@ def test_handle_method_args_2
     assert_equal '(p1, p2)', equals2.params
   end
 
-  def test_handle_method_args_minus_1
-    parser = util_parser "Document-method: Object#m\n blah */"
-
-    parser.content = <<-BODY
-VALUE
-rb_m(int argc, VALUE *argv, VALUE obj) {
-  VALUE o1, o2;
-  rb_scan_args(argc, argv, "1", &o1, &o2);
-}
-    BODY
-
-    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1
-
-    m = @top_level.find_module_named('Object').method_list.first
-
-    assert_equal '(p1)', m.params
-  end
+  # test_handle_args_minus_1 handled by test_handle_method
 
   def test_handle_method_args_minus_2
     parser = util_parser "Document-method: BasicObject#==\n blah */"