summaryrefslogtreecommitdiffhomepage
path: root/lib/yard/mruby
diff options
context:
space:
mode:
authorSeba Gamboa <[email protected]>2015-09-23 11:42:28 -0300
committerSeba Gamboa <[email protected]>2015-09-23 11:42:37 -0300
commit731c5326b47b34364b2a8f69c6d558f52957a562 (patch)
tree213d83fe80cd4ab7922e5e0879d3bcbd01db9a8a /lib/yard/mruby
parenta88dcf7f44898495fd2d2535ec0c4508a4458c38 (diff)
downloadyard-mruby-731c5326b47b34364b2a8f69c6d558f52957a562.tar.gz
yard-mruby-731c5326b47b34364b2a8f69c6d558f52957a562.zip
Detecting classes and methods from C sources
Diffstat (limited to 'lib/yard/mruby')
-rw-r--r--lib/yard/mruby/code_objects.rb3
-rw-r--r--lib/yard/mruby/code_objects/define_object.rb8
-rw-r--r--lib/yard/mruby/code_objects/function_object.rb7
-rw-r--r--lib/yard/mruby/code_objects/header_object.rb7
-rw-r--r--lib/yard/mruby/handlers.rb2
-rw-r--r--lib/yard/mruby/handlers/header.rb1
-rw-r--r--lib/yard/mruby/handlers/header/base.rb11
-rw-r--r--lib/yard/mruby/handlers/header/define_handler.rb0
-rw-r--r--lib/yard/mruby/handlers/header/function_handler.rb0
-rw-r--r--lib/yard/mruby/handlers/header/header_handler.rb0
-rw-r--r--lib/yard/mruby/handlers/source.rb5
-rw-r--r--lib/yard/mruby/handlers/source/base.rb18
-rw-r--r--lib/yard/mruby/handlers/source/class_handler.rb35
-rw-r--r--lib/yard/mruby/handlers/source/method_handler.rb22
-rw-r--r--lib/yard/mruby/handlers/source/module_handler.rb34
-rw-r--r--lib/yard/mruby/version.rb4
16 files changed, 155 insertions, 2 deletions
diff --git a/lib/yard/mruby/code_objects.rb b/lib/yard/mruby/code_objects.rb
new file mode 100644
index 0000000..83cf18d
--- /dev/null
+++ b/lib/yard/mruby/code_objects.rb
@@ -0,0 +1,3 @@
+require_relative 'code_objects/header_object'
+require_relative 'code_objects/function_object'
+require_relative 'code_objects/define_object'
diff --git a/lib/yard/mruby/code_objects/define_object.rb b/lib/yard/mruby/code_objects/define_object.rb
new file mode 100644
index 0000000..2c05d91
--- /dev/null
+++ b/lib/yard/mruby/code_objects/define_object.rb
@@ -0,0 +1,8 @@
+module YARD::MRuby::CodeObjects
+
+ # A DefineObject represents a MRuby C API define macro declaration inside a header inside an include directory
+ class DefineObject < YARD::CodeObjects::Base
+ end
+end
+
+
diff --git a/lib/yard/mruby/code_objects/function_object.rb b/lib/yard/mruby/code_objects/function_object.rb
new file mode 100644
index 0000000..5eb906e
--- /dev/null
+++ b/lib/yard/mruby/code_objects/function_object.rb
@@ -0,0 +1,7 @@
+module YARD::MRuby::CodeObjects
+
+ # A FunctionObject represents a MRuby C API function declaration inside a header inside an include directory
+ class FunctionObject < YARD::CodeObjects::Base
+ end
+end
+
diff --git a/lib/yard/mruby/code_objects/header_object.rb b/lib/yard/mruby/code_objects/header_object.rb
new file mode 100644
index 0000000..99fb3cf
--- /dev/null
+++ b/lib/yard/mruby/code_objects/header_object.rb
@@ -0,0 +1,7 @@
+module YARD::MRuby::CodeObjects
+
+ # A HeaderObject represents a MRuby header inside an include directory
+ # It groups C Functions and define macros.
+ class HeaderObject < YARD::CodeObjects::NamespaceObject
+ end
+end
diff --git a/lib/yard/mruby/handlers.rb b/lib/yard/mruby/handlers.rb
new file mode 100644
index 0000000..cb0c898
--- /dev/null
+++ b/lib/yard/mruby/handlers.rb
@@ -0,0 +1,2 @@
+require_relative 'handlers/source'
+require_relative 'handlers/header'
diff --git a/lib/yard/mruby/handlers/header.rb b/lib/yard/mruby/handlers/header.rb
new file mode 100644
index 0000000..bb39563
--- /dev/null
+++ b/lib/yard/mruby/handlers/header.rb
@@ -0,0 +1 @@
+ require_relative 'header/base'
diff --git a/lib/yard/mruby/handlers/header/base.rb b/lib/yard/mruby/handlers/header/base.rb
new file mode 100644
index 0000000..35859f7
--- /dev/null
+++ b/lib/yard/mruby/handlers/header/base.rb
@@ -0,0 +1,11 @@
+module YARD
+ module MRuby
+ module Handlers
+ module Header
+ class Base < YARD::Handlers::Base
+ include YARD::Parser::C
+ end
+ end
+ end
+ end
+end
diff --git a/lib/yard/mruby/handlers/header/define_handler.rb b/lib/yard/mruby/handlers/header/define_handler.rb
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/lib/yard/mruby/handlers/header/define_handler.rb
diff --git a/lib/yard/mruby/handlers/header/function_handler.rb b/lib/yard/mruby/handlers/header/function_handler.rb
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/lib/yard/mruby/handlers/header/function_handler.rb
diff --git a/lib/yard/mruby/handlers/header/header_handler.rb b/lib/yard/mruby/handlers/header/header_handler.rb
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/lib/yard/mruby/handlers/header/header_handler.rb
diff --git a/lib/yard/mruby/handlers/source.rb b/lib/yard/mruby/handlers/source.rb
new file mode 100644
index 0000000..af8b0db
--- /dev/null
+++ b/lib/yard/mruby/handlers/source.rb
@@ -0,0 +1,5 @@
+ require_relative 'source/base'
+ require_relative 'source/class_handler'
+ require_relative 'source/module_handler'
+ require_relative 'source/method_handler'
+
diff --git a/lib/yard/mruby/handlers/source/base.rb b/lib/yard/mruby/handlers/source/base.rb
new file mode 100644
index 0000000..4578079
--- /dev/null
+++ b/lib/yard/mruby/handlers/source/base.rb
@@ -0,0 +1,18 @@
+module YARD
+ module MRuby
+ module Handlers
+ module Source
+ class Base < YARD::Handlers::C::Base
+ DEFAULT_NAMESPACES = {
+ 'mrb->object_class' => 'Object'
+ }
+
+ def namespace_for_variable(var)
+ return DEFAULT_NAMESPACES[var] if DEFAULT_NAMESPACES[var]
+ super
+ end
+ end
+ end
+ end
+ end
+end
diff --git a/lib/yard/mruby/handlers/source/class_handler.rb b/lib/yard/mruby/handlers/source/class_handler.rb
new file mode 100644
index 0000000..185aaa6
--- /dev/null
+++ b/lib/yard/mruby/handlers/source/class_handler.rb
@@ -0,0 +1,35 @@
+module YARD::MRuby::Handlers::Source
+ class ClassHandler < Base
+
+ TOP_LEVEL_CLASS = /\*([\w]+)\s*=\s*mrb_define_class\s*
+ \(
+ \s*\w+\s*,
+ \s*"(\w+)"\s*,
+ \s*([\w\->]+)\s*
+ \)
+ /mx
+
+ NAMESPACED_CLASS = /\*([\w]+)\s*=\s*mrb_define_class_under\s*
+ \(
+ \s*\w+\s*,
+ \s*(\w+)\s*,
+ \s*"(\w+)"\s*,
+ \s*([\w\->]+)\s*
+ \)
+ /mx
+
+ handles TOP_LEVEL_CLASS
+ handles NAMESPACED_CLASS
+
+ statement_class BodyStatement
+
+ process do
+ statement.source.scan(TOP_LEVEL_CLASS) do |var_name, class_name, parent|
+ handle_class(var_name, class_name, parent)
+ end
+ statement.source.scan(NAMESPACED_CLASS) do |var_name, in_module, class_name, parent|
+ handle_class(var_name, class_name, parent, in_module)
+ end
+ end
+ end
+end
diff --git a/lib/yard/mruby/handlers/source/method_handler.rb b/lib/yard/mruby/handlers/source/method_handler.rb
new file mode 100644
index 0000000..f3eab8c
--- /dev/null
+++ b/lib/yard/mruby/handlers/source/method_handler.rb
@@ -0,0 +1,22 @@
+module YARD::MRuby::Handlers::Source
+ class MethodHandler < Base
+ MATCH1 = /mrb_define_method\s*
+ \(
+ \s*\w+\s*,
+ \s*(\w+)\s*,
+ \s*"(\w+)"\s*,
+ \s*(\w+)\s*,
+ /mx
+
+ handles MATCH1
+ statement_class BodyStatement
+
+ process do
+ puts statement.inspect
+ statement.source.scan(MATCH1) do |var_name, name, func_name|
+ handle_method(nil, var_name, name, func_name)
+ end
+ end
+
+ end
+end
diff --git a/lib/yard/mruby/handlers/source/module_handler.rb b/lib/yard/mruby/handlers/source/module_handler.rb
new file mode 100644
index 0000000..c9243ac
--- /dev/null
+++ b/lib/yard/mruby/handlers/source/module_handler.rb
@@ -0,0 +1,34 @@
+module YARD::MRuby::Handlers::Source
+ class ModuleHandler < Base
+
+ TOP_LEVEL_MODULE = /\*([\w]+)\s*=\s*mrb_define_module\s*
+ \(
+ \s*\w+\s*,
+ \s*"(\w+)"\s*
+ \)
+ /mx
+
+ NAMESPACED_MODULE = /\*([\w]+)\s*=\s*mrb_define_module_under\s*
+ \(
+ \s*\w+\s*,
+ \s*(\w+)\s*,
+ \s*"(\w+)"\s*
+ \)
+ /mx
+
+ handles TOP_LEVEL_MODULE
+ handles NAMESPACED_MODULE
+
+ statement_class BodyStatement
+
+ process do
+ statement.source.scan(TOP_LEVEL_MODULE) do |var_name, module_name|
+ handle_module(var_name, module_name)
+ end
+ statement.source.scan(NAMESPACED_MODULE) do |var_name, in_module, module_name|
+ handle_module(var_name, module_name, in_module)
+ end
+ end
+ end
+end
+
diff --git a/lib/yard/mruby/version.rb b/lib/yard/mruby/version.rb
index 0903733..7aea642 100644
--- a/lib/yard/mruby/version.rb
+++ b/lib/yard/mruby/version.rb
@@ -1,5 +1,5 @@
-module Yard
- module Mruby
+module YARD
+ module MRuby
VERSION = "0.1.0"
end
end