summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorDaniel Bovensiepen <[email protected]>2012-09-22 15:42:29 +0800
committerDaniel Bovensiepen <[email protected]>2012-09-22 15:42:29 +0800
commit62b652c2925b2f71972b201a8134cf22183102b0 (patch)
tree0771594b04a73e2b63bc232fe159da543d10ea6f /doc
parent7b8b3c0213eb71df0a10493111ccb383b31b9731 (diff)
downloadmruby-62b652c2925b2f71972b201a8134cf22183102b0.tar.gz
mruby-62b652c2925b2f71972b201a8134cf22183102b0.zip
Catch some corner cases
Diffstat (limited to 'doc')
-rw-r--r--doc/mrbgems/README.md54
-rw-r--r--doc/mrbgems/c_extension_example/Makefile12
-rw-r--r--doc/mrbgems/c_extension_example/README.md4
-rw-r--r--doc/mrbgems/c_extension_example/src/example.c17
-rw-r--r--doc/mrbgems/c_extension_example/test/example.rb3
-rw-r--r--doc/mrbgems/ruby_extension_example/Makefile7
-rw-r--r--doc/mrbgems/ruby_extension_example/README.md4
-rw-r--r--doc/mrbgems/ruby_extension_example/mrblib/example.rb5
-rw-r--r--doc/mrbgems/ruby_extension_example/test/example.rb3
9 files changed, 109 insertions, 0 deletions
diff --git a/doc/mrbgems/README.md b/doc/mrbgems/README.md
new file mode 100644
index 000000000..e23ffdcf2
--- /dev/null
+++ b/doc/mrbgems/README.md
@@ -0,0 +1,54 @@
+# mrbgems
+
+mrbgems is a library manager to integrate C and Ruby extension in an easy and
+standardized way into mruby.
+
+## GEM Structure
+
++- GEM_NAME <- Name of Gem
+ |
+ +- mrblib/ <- Source for Ruby extension
+ |
+ +- src/ <- Source for C extension
+ |
+ +- test/ <- Test code (Ruby)
+ |
+ +- Makefile <- Makefile for Gem
+ |
+ +- README.md <- Readme for Gem
+
+## C Extension
+
+### Example
+
++- c_extension_example/
+ |
+ +- src/
+ | |
+ | +- example.c <- C extension source
+ |
+ +- test/
+ | |
+ | +- example.rb <- Test code for C extension
+ |
+ +- Makefile <- Build rules for C extension
+ |
+ +- README.md
+
+## Ruby Extension
+
+### Example
+
++- ruby_extension_example/
+ |
+ +- mrblib/
+ | |
+ | +- example.rb <- Ruby extension source
+ |
+ +- test/
+ | |
+ | +- example.rb <- Test code for Ruby extension
+ |
+ +- Makefile
+ |
+ +- README.md
diff --git a/doc/mrbgems/c_extension_example/Makefile b/doc/mrbgems/c_extension_example/Makefile
new file mode 100644
index 000000000..b245e9696
--- /dev/null
+++ b/doc/mrbgems/c_extension_example/Makefile
@@ -0,0 +1,12 @@
+include ../../Makefile4gem
+
+GEM := c_extension_example
+
+GEM_C_FILES := $(wildcard $(SRC_DIR)/*.c)
+GEM_OBJECTS := $(patsubst %.c, %.o, $(GEM_C_FILES))
+
+gem-all : $(GEM_OBJECTS)
+ $(AR) rs $(LIBR) $<
+
+gem-clean :
+ -$(RM) $(GEM_OBJECTS)
diff --git a/doc/mrbgems/c_extension_example/README.md b/doc/mrbgems/c_extension_example/README.md
new file mode 100644
index 000000000..3803c2065
--- /dev/null
+++ b/doc/mrbgems/c_extension_example/README.md
@@ -0,0 +1,4 @@
+C Extension Example
+=========
+
+This is an example gem which implements a C extension.
diff --git a/doc/mrbgems/c_extension_example/src/example.c b/doc/mrbgems/c_extension_example/src/example.c
new file mode 100644
index 000000000..9f0b07839
--- /dev/null
+++ b/doc/mrbgems/c_extension_example/src/example.c
@@ -0,0 +1,17 @@
+#include <mruby.h>
+#include <stdio.h>
+
+static struct RClass *_class_cextension;
+
+static mrb_value
+mrb_c_method(mrb_state *mrb, mrb_value self)
+{
+ puts("A C Extension");
+ return self;
+}
+
+void
+mrb_c_extension_example_gem_init(mrb_state* mrb) {
+ _class_cextension = mrb_define_module(mrb, "CExtension");
+ mrb_define_class_method(mrb, _class_cextension, "c_method", mrb_c_method, ARGS_NONE());
+}
diff --git a/doc/mrbgems/c_extension_example/test/example.rb b/doc/mrbgems/c_extension_example/test/example.rb
new file mode 100644
index 000000000..367d18029
--- /dev/null
+++ b/doc/mrbgems/c_extension_example/test/example.rb
@@ -0,0 +1,3 @@
+assert('C Extension Example') do
+ CExtension.respond_to? :c_method
+end
diff --git a/doc/mrbgems/ruby_extension_example/Makefile b/doc/mrbgems/ruby_extension_example/Makefile
new file mode 100644
index 000000000..7ebec4f09
--- /dev/null
+++ b/doc/mrbgems/ruby_extension_example/Makefile
@@ -0,0 +1,7 @@
+include ../../Makefile4gem
+
+GEM := ruby_extension_example
+
+gem-all :
+
+gem-clean :
diff --git a/doc/mrbgems/ruby_extension_example/README.md b/doc/mrbgems/ruby_extension_example/README.md
new file mode 100644
index 000000000..906a0d8f2
--- /dev/null
+++ b/doc/mrbgems/ruby_extension_example/README.md
@@ -0,0 +1,4 @@
+Pure Ruby Extension Example
+=========
+
+This is an example gem which implements a pure Ruby extension.
diff --git a/doc/mrbgems/ruby_extension_example/mrblib/example.rb b/doc/mrbgems/ruby_extension_example/mrblib/example.rb
new file mode 100644
index 000000000..b07a2b580
--- /dev/null
+++ b/doc/mrbgems/ruby_extension_example/mrblib/example.rb
@@ -0,0 +1,5 @@
+class RubyExtension
+ def RubyExtension.ruby_method
+ puts "A Ruby Extension"
+ end
+end
diff --git a/doc/mrbgems/ruby_extension_example/test/example.rb b/doc/mrbgems/ruby_extension_example/test/example.rb
new file mode 100644
index 000000000..0c1b63469
--- /dev/null
+++ b/doc/mrbgems/ruby_extension_example/test/example.rb
@@ -0,0 +1,3 @@
+assert('Ruby Extension Example') do
+ RubyExtension.respond_to? :ruby_method
+end