extpp 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a6f11af116da3bf20bffbb10008e43f8f03e41f
-  data.tar.gz: adf0040c8f4c3e15aa60093b96a774530f9a09d2
+  metadata.gz: 5e8320433f1d3dfa3badfd3b28f46f9a3b73a9cd
+  data.tar.gz: b0c5a9aa30a8b40f568a1cd523310bc3e31e0063
 SHA512:
-  metadata.gz: '0927493217502f10fc9f96a54ff1970a992ad4eec539c2ce8f5c03a35c22f917f20183c76ee3557ac245c9e033afc5289976a275267299abcb24983048473e94'
-  data.tar.gz: c1b5f0e6710d8abcc2a97a5912176b9536fcd7652870d636b443949f408bbf14dd58711feb174630a84337379868190a6f820efd0e37c2bec26ed481dce2e392
+  metadata.gz: 9ea0d50417278ab94fe8297c846fc35dc69baae3667b21b149a5d615ecd9d0e5c47a3417113d96788111483aceabeb6fe75badbe89aaf1d27180518a389d68ea
+  data.tar.gz: 3c264c961f438c27bee7ab0020c471cc8c60f1badee85dee42ed916643e592c90ec4a21c1af1caf84a8ccee063e249be56ef7c8abe4963a42fda5ff6483c28c6

data/README.md

@@ -16,14 +16,86 @@ can use C API directory from C++.
 
 ## Install
 
-TODO
+```console
+% gem install extpp
+```
 
 ## How to use
 
-TODO
+Here is an example to create `Hello` class.
+
+Create `hello.cpp`:
+
+```c++
+#include <ruby.hpp>
+
+RB_BEGIN_DECLS
+
+void
+Init_hello(void)
+{
+  rb::Class klass("Hello");
+  klass.define_method("initialize", [](VALUE rb_self, int argc, VALUE *argv) {
+      VALUE rb_name;
+      rb_scan_args(argc, argv, "1", &rb_name);
+      rb::Object self(rb_self);
+      self.ivar_set("@name", rb_name);
+      return Qnil;
+    });
+  klass.define_method("greet", [](VALUE rb_self) {
+      rb::Object self(rb_self);
+      rb::Object prefix(rb_str_new_cstr("Hello "));
+      auto message = prefix.send("+", {self.ivar_get("@name")});
+      return static_cast<VALUE>(message);
+    });
+}
+
+RB_END_DECLS
+```
+
+This code equals to the following Ruby code:
+
+```ruby
+class Hello
+  def initialize(name)
+    @name = name
+  end
+
+  def greet
+    "Hello " + @name
+  end
+end
+```
+
+Create `extconf.rb`:
+
+```ruby
+require "extpp"
+
+create_makefile("hello")
+```
+
+Create `Makefile`:
+
+```console
+% ruby extconf.rb
+```
+
+Build this extension:
+
+```console
+% make
+```
+
+Now, you can use this extension:
+
+```console
+% ruby -r ./hello -e 'p Hello.new("me").greet'
+"Hello me"
+```
 
 ## License
 
-Copyright (C) 2017 Kouhei Sutou
+Copyright (C) 2017-2018 Kouhei Sutou
 
 The 2-Clause BSD License. See [LICENSE.txt](LICENSE.txt) for details.

data/doc/text/news.md

@@ -1,5 +1,17 @@
 # News
 
+## 0.0.2 - 2018-02-16
+
+### Improvements
+
+  * `rb::Object::ivar_set()`: Added.
+
+  * `rb::Object::ivar_get()`: Added.
+
+### Fixes
+
+  * Added missing files to gem.
+
 ## 0.0.1 - 2018-02-16
 
 The first release!!!

data/ext/extpp/function.hpp

@@ -0,0 +1,43 @@
+#pragma once
+
+#include <ruby.hpp>
+
+namespace rb {
+  class Function {
+  public:
+    Function() = default;
+    virtual ~Function() = default;
+
+    virtual VALUE call(VALUE self, int argc, VALUE *argv) = 0;
+  };
+
+  class FunctionWithoutArgument : public Function {
+  public:
+    FunctionWithoutArgument(const MethodWithoutArguments &function);
+
+    VALUE call(VALUE self, int argc, VALUE *argv) override;
+
+  private:
+    MethodWithoutArguments function_;
+  };
+
+  class FunctionWithArguments : public Function {
+  public:
+    FunctionWithArguments(const MethodWithArguments &function);
+
+    VALUE call(VALUE self, int argc, VALUE *argv) override;
+
+  private:
+    MethodWithArguments function_;
+  };
+
+  class FunctionWithArgumentsCompatible : public Function {
+  public:
+    FunctionWithArgumentsCompatible(const MethodWithArgumentsCompatible &function);
+
+    VALUE call(VALUE self, int argc, VALUE *argv) override;
+
+  private:
+    MethodWithArgumentsCompatible function_;
+  };
+}

data/include/ruby/object.hpp

@@ -89,6 +89,30 @@ namespace rb {
       return send(rb_intern_str(name), args, block);
     }
 
+    inline Object ivar_set(ID name_id, VALUE value) {
+      return Object(rb_ivar_set(rb_object_, name_id, value));
+    }
+
+    inline Object ivar_set(const char *name, VALUE value) {
+      return ivar_set(rb_intern(name), value);
+    }
+
+    inline Object ivar_set(Object name, VALUE value) {
+      return ivar_set(rb_intern_str(name), value);
+    }
+
+    inline Object ivar_get(ID name_id) {
+      return Object(rb_ivar_get(rb_object_, name_id));
+    }
+
+    inline Object ivar_get(const char *name) {
+      return ivar_get(rb_intern(name));
+    }
+
+    inline Object ivar_get(Object name) {
+      return ivar_get(rb_intern_str(name));
+    }
+
   private:
     VALUE rb_object_;
     bool is_gc_guarding_;

data/lib/extpp/version.rb

@@ -1,3 +1,3 @@
 module ExtPP
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/sample/hello/Rakefile

@@ -0,0 +1,13 @@
+task :default => :build
+
+desc "Build"
+task :build => "hello.so"
+
+file "Makefile" => "extconf.rb" do
+  ruby("extconf.rb")
+  sh("make", "clean")
+end
+
+file "hello.so" => ["Makefile", "hello.cpp"] do
+  sh("make")
+end

data/sample/hello/extconf.rb

@@ -0,0 +1,3 @@
+require "extpp"
+
+create_makefile("hello")

data/sample/hello/hello.cpp

@@ -0,0 +1,24 @@
+#include <ruby.hpp>
+
+RB_BEGIN_DECLS
+
+void
+Init_hello(void)
+{
+  rb::Class klass("Hello");
+  klass.define_method("initialize", [](VALUE rb_self, int argc, VALUE *argv) {
+      VALUE rb_name;
+      rb_scan_args(argc, argv, "1", &rb_name);
+      rb::Object self(rb_self);
+      self.ivar_set("@name", rb_name);
+      return Qnil;
+    });
+  klass.define_method("greet", [](VALUE rb_self) {
+      rb::Object self(rb_self);
+      rb::Object prefix(rb_str_new_cstr("Hello "));
+      auto message = prefix.send("+", {self.ivar_get("@name")});
+      return static_cast<VALUE>(message);
+    });
+}
+
+RB_END_DECLS

data/test/fixtures/cast/Makefile

@@ -0,0 +1,264 @@
+
+SHELL = /bin/sh
+
+# V=0 quiet, V=1 verbose.  other values don't work.
+V = 0
+Q1 = $(V:1=)
+Q = $(Q1:0=@)
+ECHO1 = $(V:1=@:)
+ECHO = $(ECHO1:0=@echo)
+NULLCMD = :
+
+#### Start of system configuration section. ####
+
+srcdir = .
+topdir = /usr/include/ruby-2.3.0
+hdrdir = $(topdir)
+arch_hdrdir = /usr/include/x86_64-linux-gnu/ruby-2.3.0
+PATH_SEPARATOR = :
+VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
+prefix = $(DESTDIR)/usr
+rubysitearchprefix = $(sitearchlibdir)/$(RUBY_BASE_NAME)
+rubyarchprefix = $(archlibdir)/$(RUBY_BASE_NAME)
+rubylibprefix = $(libdir)/$(RUBY_BASE_NAME)
+exec_prefix = $(prefix)
+vendorarchhdrdir = $(sitearchincludedir)/$(RUBY_VERSION_NAME)/vendor_ruby
+sitearchhdrdir = $(sitearchincludedir)/$(RUBY_VERSION_NAME)/site_ruby
+rubyarchhdrdir = $(archincludedir)/$(RUBY_VERSION_NAME)
+vendorhdrdir = $(rubyhdrdir)/vendor_ruby
+sitehdrdir = $(rubyhdrdir)/site_ruby
+rubyhdrdir = $(includedir)/$(RUBY_VERSION_NAME)
+vendorarchdir = $(rubysitearchprefix)/vendor_ruby/$(ruby_version)
+vendorlibdir = $(vendordir)/$(ruby_version)
+vendordir = $(rubylibprefix)/vendor_ruby
+sitearchdir = $(DESTDIR)/usr/local/lib/x86_64-linux-gnu/site_ruby
+sitelibdir = $(sitedir)/$(ruby_version)
+sitedir = $(DESTDIR)/usr/local/lib/site_ruby
+rubyarchdir = $(rubyarchprefix)/$(ruby_version)
+rubylibdir = $(rubylibprefix)/$(ruby_version)
+sitearchincludedir = $(includedir)/$(sitearch)
+archincludedir = $(includedir)/$(arch)
+sitearchlibdir = $(libdir)/$(sitearch)
+archlibdir = $(libdir)/$(arch)
+ridir = $(datarootdir)/$(RI_BASE_NAME)
+mandir = $(prefix)/share/man
+localedir = $(datarootdir)/locale
+libdir = $(exec_prefix)/lib
+psdir = $(docdir)
+pdfdir = $(docdir)
+dvidir = $(docdir)
+htmldir = $(docdir)
+infodir = $(prefix)/share/info
+docdir = $(datarootdir)/doc/$(PACKAGE)
+oldincludedir = $(DESTDIR)/usr/include
+includedir = $(prefix)/include
+runstatedir = $(localstatedir)/run
+localstatedir = $(DESTDIR)/var
+sharedstatedir = $(prefix)/com
+sysconfdir = $(DESTDIR)/etc
+datadir = $(datarootdir)
+datarootdir = $(prefix)/share
+libexecdir = $(prefix)/lib/ruby2.3
+sbindir = $(exec_prefix)/sbin
+bindir = $(exec_prefix)/bin
+archdir = $(rubyarchdir)
+
+
+CC = gcc
+CXX = g++
+LIBRUBY = $(LIBRUBY_SO)
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)-static
+empty =
+OUTFLAG = -o $(empty)
+COUTFLAG = -o $(empty)
+
+RUBY_EXTCONF_H = 
+cflags   =  $(optflags) $(debugflags) $(warnflags)
+cxxflags =  $(optflags) $(debugflags) $(warnflags)
+optflags = -O3 -fno-fast-math
+debugflags = -ggdb3
+warnflags = -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wunused-variable -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wimplicit-function-declaration -Wdeprecated-declarations -Wno-packed-bitfield-compat
+CCDLFLAGS = -fPIC
+CFLAGS   = $(CCDLFLAGS) -g -O2 -fdebug-prefix-map=/build/ruby2.3-KwDbD6/ruby2.3-2.3.6=. -fstack-protector-strong -Wformat -Werror=format-security -fPIC $(ARCH_FLAG)
+INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir) -I/home/kou/work/ruby/extpp/include
+DEFS     = 
+CPPFLAGS =  -Wdate-time -D_FORTIFY_SOURCE=2 $(DEFS) $(cppflags)
+CXXFLAGS = $(CCDLFLAGS) -g -O2 -fdebug-prefix-map=/build/ruby2.3-KwDbD6/ruby2.3-2.3.6=. -fstack-protector-strong -Wformat -Werror=format-security $(ARCH_FLAG)
+ldflags  = -L. -Wl,-z,relro -Wl,-z,now -fstack-protector -rdynamic -Wl,-export-dynamic
+dldflags =  
+ARCH_FLAG = 
+DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
+LDSHARED = $(CC) -shared
+LDSHAREDXX = $(CXX) -shared
+AR = ar
+EXEEXT = 
+
+RUBY_INSTALL_NAME = $(RUBY_BASE_NAME)2.3
+RUBY_SO_NAME = ruby-2.3
+RUBYW_INSTALL_NAME = 
+RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version)
+RUBYW_BASE_NAME = rubyw
+RUBY_BASE_NAME = ruby
+
+arch = x86_64-linux-gnu
+sitearch = $(arch)
+ruby_version = 2.3.0
+ruby = $(bindir)/$(RUBY_BASE_NAME)2.3
+RUBY = $(ruby)
+ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h
+
+RM = rm -f
+RM_RF = $(RUBY) -run -e rm -- -rf
+RMDIRS = rmdir --ignore-fail-on-non-empty -p
+MAKEDIRS = /bin/mkdir -p
+INSTALL = /usr/bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+TOUCH = exit >
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = . $(archlibdir)
+LIBPATH =  -L. -L$(archlibdir)
+DEFFILE = 
+
+CLEANFILES = mkmf.log
+DISTCLEANFILES = 
+DISTCLEANDIRS = 
+
+extout = 
+extout_prefix = 
+target_prefix = 
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED)  -lpthread -lgmp -ldl -lcrypt -lm   -lc /home/kou/work/ruby/extpp/ext/extpp/libruby-extpp.so
+ORIG_SRCS = cast.cpp
+SRCS = $(ORIG_SRCS) 
+OBJS = cast.o
+HDRS = 
+TARGET = cast
+TARGET_NAME = cast
+TARGET_ENTRY = Init_$(TARGET_NAME)
+DLLIB = $(TARGET).so
+EXTSTATIC = 
+STATIC_LIB = 
+
+TIMESTAMP_DIR = .
+BINDIR        = $(bindir)
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+HDRDIR        = $(rubyhdrdir)/ruby$(target_prefix)
+ARCHHDRDIR    = $(rubyhdrdir)/$(arch)/ruby$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).so 
+CLEANOBJS     = *.o  *.bak
+
+all:    $(DLLIB)
+static: $(STATIC_LIB)
+.PHONY: all install static install-so install-rb
+.PHONY: clean clean-so clean-static clean-rb
+
+clean-static::
+clean-rb-default::
+clean-rb::
+clean-so::
+clean: clean-so clean-static clean-rb-default clean-rb
+		-$(Q)$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time
+
+distclean-rb-default::
+distclean-rb::
+distclean-so::
+distclean-static::
+distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb
+		-$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
+		-$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
+		-$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true
+
+realclean: distclean
+install: install-so install-rb
+
+install-so: $(DLLIB) $(TIMESTAMP_DIR)/.RUBYARCHDIR.time
+	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
+clean-static::
+	-$(Q)$(RM) $(STATIC_LIB)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+pre-install-rb-default:
+	@$(NULLCMD)
+$(TIMESTAMP_DIR)/.RUBYARCHDIR.time:
+	$(Q) $(MAKEDIRS) $(@D) $(RUBYARCHDIR)
+	$(Q) $(TOUCH) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .mm .cxx .cpp .o .S
+
+.cc.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.cc.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $<
+
+.mm.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.mm.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $<
+
+.cxx.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.cxx.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $<
+
+.cpp.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $<
+
+.cpp.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $<
+
+.c.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $<
+
+.c.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $<
+
+.m.o:
+	$(ECHO) compiling $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $<
+
+.m.S:
+	$(ECHO) translating $(<)
+	$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $<
+
+$(DLLIB): $(OBJS) Makefile
+	$(ECHO) linking shared-object $(DLLIB)
+	-$(Q)$(RM) $(@)
+	$(Q) $(LDSHAREDXX) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): $(HDRS) $(ruby_headers)
+
+extpp_headers = /home/kou/work/ruby/extpp/include/ruby.hpp /home/kou/work/ruby/extpp/include/ruby/object.hpp /home/kou/work/ruby/extpp/include/ruby/type.hpp /home/kou/work/ruby/extpp/include/ruby/cast.hpp /home/kou/work/ruby/extpp/include/ruby/class.hpp
+$(OBJS): $(extpp_headers)