Tag the callback types

Author: carlosmn

lib/docurium/docparser.rb

@@ -111,11 +111,15 @@ def extract_typedef(cursor)
         #puts "typed struct, #{cursor.spelling}"
         rec.merge! extract_struct(child)
       when :cursor_parm_decl
-        #puts "have parm #{cursor.spelling}, #{cursor.display_name}"
-        subject, desc = extract_subject_desc(cursor.comment)
-        rec[:decl] = cursor.spelling
-        rec[:description] = subject
-        rec[:comments] = desc
+        rec.merge! extract_function(cursor)
+        rec[:type] = :callback
+        # this is wasteful, but we don't get the array from outside
+        cmt = extract_function_comment(cursor.comment)
+        ret = {
+               :type => extract_callback_result(rec[:underlying_type]),
+               :comment => cmt[:return]
+              }
+        rec[:return] = ret
       else
         raise "No idea how to handle #{child.kind}"
       end
@@ -125,21 +129,14 @@ def extract_typedef(cursor)
       rec
     end
 
-    def extract_subject_desc(comment)
-      subject = comment.child.text
-      desc = (comment.find_all { |cmt| cmt.kind == :comment_paragraph }).drop(1).map(&:text).join("\n\n")
-      return subject, desc
+    def extract_callback_result(type)
+      type[0..(type.index('(') - 1)].strip
     end
 
-    def extract_function(cursor)
-      comment = cursor.comment
-
-      #puts "looking at function #{cursor.spelling}, #{cursor.display_name}"
-      cmt = extract_function_comment(comment)
-
+    def extract_function_args(cursor, cmt)
       # We only want to look at parm_decl to avoid looking at a return
       # struct as a parameter
-      args = children(cursor)
+      children(cursor)
         .select {|c| c.kind == :cursor_parm_decl }
         .map do |arg|
         {
@@ -148,6 +145,20 @@ def extract_function(cursor)
           :comment => cmt[:args][arg.display_name],
         }
       end
+    end
+
+    def extract_subject_desc(comment)
+      subject = comment.child.text
+      desc = (comment.find_all { |cmt| cmt.kind == :comment_paragraph }).drop(1).map(&:text).join("\n\n")
+      return subject, desc
+    end
+
+    def extract_function(cursor)
+      comment = cursor.comment
+
+      #puts "looking at function #{cursor.spelling}, #{cursor.display_name}"
+      cmt = extract_function_comment(comment)
+      args = extract_function_args(cursor, cmt)
       #args = args.reject { |arg| arg[:comment].nil? }
 
       ret = {

test/fixtures/git2/callback.h

@@ -0,0 +1,16 @@
+/*
+ * This file is to create a function which takes a callback in order
+ * to test that we detect it correctly and will write it out.
+ */
+
+#include "common.h"
+
+/**
+ * Worker which does soemthing to its pointer
+ */
+typedef int (*git_callback_do_work)(int *foo);
+
+/**
+ * Schedule some work to happen for a particular function
+ */
+GIT_EXTERN(int) git_work_schedule(git_callback_do_work worker);

test/parser_test.rb

@@ -406,4 +406,41 @@ def test_type_reference
 
   end
 
+  def test_callaback
+    name = 'typeref.h'
+    contents = <<EOF
+/**
+* This is a callback type
+*
+* @return whether to reschedule
+*/
+typedef int (*some_callback)(int *foo);
+EOF
+
+    actual = parse(name, contents)
+    expected = [{
+                  :file => "typeref.h",
+                  :line => 6,
+                  :lineto => 6,
+                  :tdef => :typedef,
+                  :name => "some_callback",
+                  :underlying_type => "int (*)(int *)",
+                  :type => :callback,
+                  :body => ' some_callback(int *foo);',
+                  :description => ' This is a callback type',
+                  :comments => ' ',
+                  :sig => "int *",
+                  :args => [{:name => "foo",
+                             :type => "int *",
+                             :comment => nil,
+                            }],
+                  :return => {:type => 'int',
+                              :comment => " whether to reschedule"},
+                  :decl => ' some_callback(int *foo)',
+                  :argline => 'int *foo',
+                }]
+
+    assert_equal actual, expected
+  end
+
 end

test/repo_test.rb

@@ -39,8 +39,8 @@ def teardown
 
   def test_can_parse_headers
     keys = @data.keys.map { |k| k.to_s }.sort
-    assert_equal ['files', 'functions', 'globals', 'groups', 'prefix', 'types'], keys
-    assert_equal 153, @data[:functions].size
+    assert_equal ['callbacks', 'files', 'functions', 'globals', 'groups', 'prefix', 'types'], keys
+    assert_equal 154, @data[:functions].size
   end
 
   def test_can_extract_enum_from_define
@@ -114,7 +114,7 @@ def test_can_get_the_full_description_from_multi_liners
   end
 
   def test_can_group_functions
-    assert_equal 14, @data[:groups].size
+    assert_equal 15, @data[:groups].size
     group, funcs = @data[:groups].first
     assert_equal 'blob', group
     assert_equal 6, funcs.size
@@ -127,4 +127,10 @@ def test_can_store_mutliple_enum_doc_sections
     assert_equal 2, idxentry[1][:sections].size
   end
 
+  def test_can_parse_callback
+    cb = @data[:callbacks]['git_callback_do_work']
+    assert_equal 'int',             cb[:return][:type]
+
+  end
+
 end