summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-29 12:26:52 -0300
committerSeba Gamboa <[email protected]>2015-09-29 12:26:52 -0300
commitb8602d593eff73609e2f2682375f546f61b58f73 (patch)
tree3628717151b604383024e5680928ddeea19a9a2c
parentbe49b0e4472afbc98c386f1c14afd1598ee14d16 (diff)
downloadyard-mruby-b8602d593eff73609e2f2682375f546f61b58f73.tar.gz
yard-mruby-b8602d593eff73609e2f2682375f546f61b58f73.zip
parse parameter types
-rw-r--r--lib/yard/mruby/code_objects/function_object.rb23
-rw-r--r--lib/yard/mruby/handlers/c/header/function_handler.rb7
-rw-r--r--spec/handlers/c/header/function_handler_spec.rb15
3 files changed, 28 insertions, 17 deletions
diff --git a/lib/yard/mruby/code_objects/function_object.rb b/lib/yard/mruby/code_objects/function_object.rb
index 35b8e4f..2fdc0b7 100644
--- a/lib/yard/mruby/code_objects/function_object.rb
+++ b/lib/yard/mruby/code_objects/function_object.rb
@@ -2,6 +2,7 @@ module YARD::MRuby::CodeObjects
# A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
class FunctionObject < HeaderBaseObject
+ ParameterType = Struct.new(:type,:name)
# Returns the list of parameters parsed out of the method signature
# with their default values.
@@ -23,13 +24,27 @@ module YARD::MRuby::CodeObjects
end
def return_type
- obj.tag(:return).types.first
+ @return_type
end
def return_type=(type)
- return if type == 'void'
- add_tag(YARD::Tags::Tag.new(:return,"", "")) unless has_tag?(:return)
- tag(:return).types = [type]
+ @return_type = (type == 'void' ? nil : type)
+ end
+
+ def parameter_types
+ @parameter_types || []
+ end
+
+ def parse_parameter_types(parameters)
+ @parameter_types = []
+ return if parameters.match /^\s*void\s*$/
+
+ parameters.split(',').each do |parameter|
+ parameter.scan(/((:?struct\s+)?\w+(:?\s*\*)?)\s*(\w+)?/) do |type,_,_,name|
+ @parameter_types << ParameterType.new(type,name)
+ end
+ end
+
end
diff --git a/lib/yard/mruby/handlers/c/header/function_handler.rb b/lib/yard/mruby/handlers/c/header/function_handler.rb
index 079f114..3d401a8 100644
--- a/lib/yard/mruby/handlers/c/header/function_handler.rb
+++ b/lib/yard/mruby/handlers/c/header/function_handler.rb
@@ -4,7 +4,7 @@ module YARD::MRuby::Handlers::C::Header
MRB_(API|INLINE)\s+
((struct\s+)?\w+(\s*\*)?)\s*
((\w+\s+)+)?(\w+)\s*
- \(([\w\s\*,])*\)
+ \(([\w\s\*,]*)\)
/mx
handles MATCH
@@ -17,15 +17,14 @@ module YARD::MRuby::Handlers::C::Header
def handle_function(statement)
header = self.header(statement.file)
-["API", "mrb_value", nil, nil, nil, nil, "sample_api_method"]
- statement.source.scan(MATCH) do |type, retype, _,_,_,_, name, *args|
- puts args.inspect
+ statement.source.scan(MATCH) do |type, retype, _,_,_,_, name, parameters|
register FunctionObject.new(header, name) do |obj|
if statement.comments
register_docstring(obj, statement.comments.source, statement)
end
obj.return_type = retype
+ obj.parse_parameter_types(parameters)
end
end
diff --git a/spec/handlers/c/header/function_handler_spec.rb b/spec/handlers/c/header/function_handler_spec.rb
index 1919fde..5fc56df 100644
--- a/spec/handlers/c/header/function_handler_spec.rb
+++ b/spec/handlers/c/header/function_handler_spec.rb
@@ -23,19 +23,16 @@ describe YARD::MRuby::Handlers::C::Header::FunctionHandler do
MRB_API mrb_value mrb_foo( void );
eof
- expect(subject.tag(:return).types).to eq ['mrb_value']
+ expect(subject.return_type).to eq 'mrb_value'
end
- it "should keep return type independently from docs" do
+ it "should store argument types" do
header_line <<-eof
- /**
- * @return DOCSTRING
- */
- MRB_API mrb_value mrb_foo( void );
+ MRB_API mrb_value mrb_foo( mrb_state *mrb, mrb_value bar );
eof
- expect(subject.tag(:return).text).to eq 'DOCSTRING'
- expect(subject.tag(:return).types).to eq ['mrb_value']
+ expect(subject.parameter_types.first.type).to eq 'mrb_state *'
+ expect(subject.parameter_types.last.type).to eq 'mrb_value'
+ expect(subject.parameter_types.last.name).to eq 'bar'
end
-
end