rabbit-slide-kou-rubykaigi-2016 2016.9.8.0 → 2016.9.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b032ef54474e6fb2d6213f008397240691570368
-  data.tar.gz: 75d63b266c7db660d967f54ab5c7827ed490a8a7
+  metadata.gz: ca44e98f9cccc78fb696c568d8e67915f3e25d16
+  data.tar.gz: 1526cd0e6cfb5cd2ea9316e095a42d892db32ec8
 SHA512:
-  metadata.gz: ca2b829c46c709b8700c6a46cfae91de0598f0fc6914df855f1b79a64e92c0486b61d6e3c4e256d77086f6a7b4cee6950b495981f45ae7b3dcd6c70e064384ea
-  data.tar.gz: fd09c94ecb21cdd388c3c81f23d89e478b8a870f42e989d62a5eabeceadbca48c31af30f8f764c125e3f9425ee23988b5407587a77c073d64730e5b24c90b062
+  metadata.gz: 117395c67a4666de8c3108d3815e2d2b418227c7e527b6f2a5cd15d1b293c1d35b443def0829b8bdef54a4d48debaf09a0e80102dbf1550508db60f64b58b047
+  data.tar.gz: e885d5309adbb94fde9d07d16ecc022c59eb6957165931d4dafdc0dd3a203e623027748ed9cac4ef5ea4781cc4aae607d1d02a47e7c7765468f303979cfc412d

data/bindings-as-extension-library.rab

@@ -0,0 +1,224 @@
+= Bindings as\nan extension library
+
+: author
+   Kouhei Sutou
+: institution
+   ClearCode Inc.
+: content-source
+   RubyKaigi 2016
+: date
+   2016-09-08
+: allotted-time
+   5m
+: theme
+   .
+
+= How to create bindings\n(('note:バインディングの作り方'))
+
+  * Use C API provided by Ruby\n
+    (('note:Rubyが提供するC APIを使う'))
+    * (('wait'))It's for creating ext lib\n
+      (('note:拡張ライブラリーを作るためのAPI'))
+
+= Define class\n(('note:クラス定義'))
+
+  # coderay c
+  #include <ruby.h>
+  void
+  Init_hello(void)
+  {
+    rb_define_class("Hello", rb_cObject);
+    /* Ruby: class Hello; end */
+  }
+
+= Initialize\n(('note:初期化'))
+
+  # coderay c
+  #include <ruby.h>
+  void
+  Init_#{module_name}(void)
+  {
+    /* require "#{module_name}"
+       calls this function */
+  }
+
+= Init example\n(('note:初期化例'))
+
+  # coderay c
+  #include <ruby.h>
+  void
+  Init_hello(void)
+  {
+    /* require "hello"
+       calls this function */
+  }
+
+= Define method\n(('note:メソッド定義'))
+
+  # coderay c
+  static VALUE hello_to_s(VALUE self) {
+    return rb_str_new_cstr("Hello");
+  }
+  void Init_hello(void) {
+    VALUE hello;
+    hello = rb_define_class("Hello", rb_cObject);
+    rb_define_method(hello, "to_s", hello_to_s, 0);
+  }
+
+= Build1\n(('note:ビルド1'))
+
+  # coderay ruby
+  # extconf.rb
+  require "mkmf"
+  # "hello" == "#{module_name}"
+  create_makefile("hello")
+
+= Build2\n(('note:ビルド2'))
+
+  % ruby extconf.rb
+  % make
+  (hello.so is generated.)
+
+= Use\n(('note:使う'))
+
+  % irb -I .
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello.new
+  => #<Hello:0x00000001fd15a0>
+  irb(main):003:0> hello.to_s
+  => "Hello"
+
+= Create bindings\n(('note:バインディングを作る'))
+
+  * C API is for ext lib\n
+    (('note:C APIを使うと拡張ライブラリーを作れる'))
+  * (('wait'))C API is also for bindings\n
+    (('note:C APIを使うとバインディングも作れる'))
+  * (('wait'))Show it from now just FYI\n
+    (('note:参考までにこれから作り方を紹介する'))
+
+= Bindings target\n(('note:バインディング対象'))
+
+  # coderay c
+  /* hello.h */
+  #pragma once
+  typedef struct hello_t Hello;
+  Hello      *hello_new    (void);
+  void        hello_free   (Hello *hello);
+  const char *hello_message(Hello *hello);
+
+= Define class\n(('note:クラス定義'))
+
+  # coderay c
+  void
+  Init_hello(void)
+  {
+    VALUE hello;
+    /* Ruby: class Hello < Data; end */
+    hello = rb_define_class("Hello", rb_cData);
+    rb_define_alloc_func(hello, rb_hello_alloc);
+  }
+
+= Wrap struct\n(('note:構造体をラップ'))
+
+  # coderay c
+  static VALUE
+  rb_hello_alloc(VALUE klass)
+  {
+    /* Allocate memory for wrapping
+       target struct in C (= Hello struct). */
+    return TypedData_Wrap_Struct(klass,
+                                 &rb_hello_type,
+    /* Target struct is NULL at this phase. */
+                                 NULL);
+  }
+
+= Define type metadata\n(('note:型用のメタデータを定義'))
+
+  # coderay c
+  static const rb_data_type_t rb_hello_type = {
+    "Hello", /* Type name. */
+    /* Mark, free, size functions. */
+    {NULL, rb_hello_free, NULL,},
+    NULL, /* Parent. It must be NULL. */
+    NULL, /* Wrapped target struct. */
+    RUBY_TYPED_FREE_IMMEDIATELY,
+  };
+
+= Free function\n(('note:メモリー解放関数'))
+
+  # coderay c
+  static void
+  rb_hello_free(void *data)
+  {
+    Hello *hello = data;
+    /* Just call the free function. */
+    hello_free(hello);
+  }
+
+= Register (({initialize}))\n(('note:(({initialize}))登録'))
+
+  # coderay c
+  void Init_hello(void) {
+    /* VALUE hello = Hello class */
+    /* Ruby: def initialize; end */
+    rb_define_method(hello,
+          /* Name */ "initialize",
+                     rb_hello_initialize,
+    /* No argument */ 0);
+  }
+
+= Initialize\n(('note:初期化'))
+
+  # coderay c
+  static VALUE
+  rb_hello_initialize(VALUE self)
+  {
+    Hello *hello;
+    hello = hello_new();    /* Create a target */
+    DATA_PTR(self) = hello; /* Wrap the target */
+    return Qnil;
+  }
+
+= Bind method\n(('note:メソッドをバインド'))
+
+  # coderay c
+  static VALUE rb_hello_message(VALUE self) {
+    Hello *hello;
+    const char *message;
+    TypedData_Get_Struct( /* Unwrap the target. */
+      self, Hello, &rb_hello_type, hello);
+    message = hello_message(hello); /* Call. */
+    return rb_str_new_cstr(message); /* C -> Ruby */
+  }
+
+= Build1\n(('note:ビルド1'))
+
+  # coderay ruby
+  # extconf.rb
+  require "mkmf"
+  # Accept --with-libhello-*.
+  dir_config("libhello")
+  have_header("hello.h")
+  have_library("hello", "hello_new")
+
+  create_makefile("hello")
+
+= Build2\n(('note:ビルド2'))
+
+  % ruby extconf.rb \
+      --with-libhello-dir=../../libhello
+  % make
+  (hello.so is generated.)
+
+= Use\n(('note:使う'))
+
+  % LD_LIBRARY_PATH=../../libhello/lib \
+      irb -I .
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello.new
+  => #<Hello:0x00000002ae0e28>
+  irb(main):003:0> hello.message
+  => "Hello"

data/config.yaml

@@ -5,8 +5,8 @@ tags:
 - rabbit
 - ruby
 - bindings
-presentation_date: 2016-09-08
-version: 2016.9.8.0
+presentation_date: 2016-09-09
+version: 2016.9.9.0
 licenses:
 - CC BY-SA 4.0
 slideshare_id: 

data/fat-gem.rab

@@ -0,0 +1,165 @@
+= Fat gem
+
+: author
+   Kouhei Sutou
+: institution
+   ClearCode Inc.
+: content-source
+   RubyKaigi 2016
+: date
+   2016-09-08
+: allotted-time
+   5m
+: theme
+   .
+
+= Fat gem?\n(('note:fat gemとは'))
+
+  * Gem includes built binaries\n
+    (('note:ビルド済みバイナリー入りgem'))
+    * (('note:(Mainly)')) Provided for Windows users\n
+      (('note:主にWindowsユーザー向けに提供'))
+  * (('wait'))Windows users don't need C compiler😼\n
+    (('note:WindowsユーザーはCコンパイラーを用意しなくてよい'))
+
+= Why fat gem is needed?\n(('note:どうしてfat gemが必要なのか'))
+
+  * Most Windows users don't have C compiler\n
+    (('note:多くのWindowsユーザーはコンパイラーを持っていない'))
+
+= How to create fat gem\n(('note:fat gemの作り方'))
+
+  * Bundle binaries to gem\n
+    (('note:gemにバイナリーをバンドル'))
+  * Use suitable binaries\n
+    (('note:適切なバイナリーを使う'))
+
+= Path\n(('note:パス'))
+
+  ./lib/hello.rb
+  ./lib/2.1/hello.so # For Ruby 2.1
+  ./lib/2.2/hello.so # For Ruby 2.2
+  ./lib/2.3/hello.so # For Ruby 2.3
+
+= Load\n(('note:読み込み'))
+
+  # coderay ruby
+  # hello.rb
+  begin
+    major, minor, = RUBY_VERSION.split(".")
+    # e.g.: require "2.3/hello.so"
+    require "#{major}.#{minor}/hello.so"
+  rescue LoadError
+    require "hello.so"
+  end
+
+= Paths for bindings\n(('note:バインディングの時のパス'))
+
+  ./lib/hello.rb
+  ./lib/2.1/hello.so # For Ruby 2.1
+  ./lib/2.2/hello.so # For Ruby 2.2
+  ./lib/2.3/hello.so # For Ruby 2.3
+  # ↓Target library's DLL
+  ./vendor/local/bin/hello.dll
+
+= Load for bindings\n(('note:バインディングの時の読み込み'))
+
+  # coderay ruby
+  # hello.rb
+  if /mingw|mswin/ =~ RUBY_PLATFORM
+    ENV["PATH"] += # For finding DLL
+      ";#{__dir__}\\..\\vendor\\local\\bin"
+  end
+  begin
+    major, minor, = RUBY_VERSION.split(".")
+    # ...
+
+= How to create\n(('note:作り方'))
+
+  (1) (('wait'))Build DLLs\n
+      (('note:DLLをビルド'))
+  (2) (('wait'))Bundle DLLs to gem\n
+      (('note:gemにDLLをバンドル'))
+
+= How to build\n(('note:ビルド方法'))
+
+  * (('wait'))Build on Windows with C compiler\n
+    (('note:Windows上でCコンパイラーでビルド'))
+  * (('wait'))Build on GNU/Linux or OS X with C cross compiler\n
+    (('note:GNU/LinuxまたはOS X上でCクロスコンパイラーでビルド'))
+    * Popular\n
+      (('note:こちらが一般的'))
+
+= How to cross compile\n(('note:クロスコンパイル方法'))
+
+  (1) Cross compile target Rubyies\n
+      (('note:対象のRubyをクロスコンパイル'))
+  (2) Run (({extconf.rb})) with target Rubies\n
+      (('note:対象のRubyで(({extconf.rb}))を実行'))
+  (3) Cross compile\n
+      (('note:クロスコンパイル'))
+
+= Fat gem helper gems\n(('note:fat gem作成支援gem'))
+
+  * rake-compiler
+    * Cross compiling and bundling\n
+      (('note:クロスコンパイルとバンドル支援'))
+  * rake-compiler-dock
+    * Prepares build environment\n
+      (('note:ビルド環境用意支援'))
+
+= Fat gem and bindings\n(('note:fat gemとバインディング'))
+
+  * Bindings need DLL of target library\n
+    (('note:バインディングは対象ライブラリーのDLLも必要'))
+  * Target library should be also cross compiled\n
+    (('note:対象ライブラリーもクロスコンパイルが必要'))
+
+= How to cross compile1\n(('note:クロスコンパイル方法1'))
+
+For GNU Autotools:
+
+  % ./configure \
+      --prefix=vendor/local \
+      --host=x86_64-w64-mingw32
+  % make
+  % make install
+
+= How to cross compile2\n(('note:クロスコンパイル方法2'))
+
+For CMake:
+
+  % cmake . \
+      -DCMAKE_INSTALL_PREFIX=vendor/local \
+      -DCMAKE_SYSTEM_NAME=Windows \
+      -DCMAKE_SYSTEM_PROCESSOR=x64 \
+      -DCMAKE_C_COMPILER=x86_64-w64-mingw32-gcc
+  % make
+  % make install
+
+= How to bundle\n(('note:バンドル方法'))
+
+  # coderay ruby
+  # #{gem_name}.gemspec
+  Rake::ExtensionTask.new(gem_name, spec) do |ext|
+    # ...
+    ext.cross_compiling do |cross_spec|
+      cross_spec.files +=
+        Dir.glob("vendor/local/**/*")
+    end
+  end
+
+= How to build gem\n(('note:gemのビルド方法'))
+
+  % rake cross native gem
+
+= How to release gem\n(('note:gemのリリース方法'))
+
+  % gem push pkg/...-x64-mingw32.gem
+
+= How to install fat gem\n(('note:fat gemのインストール方法'))
+
+  > gem install GEM_NAME
+
+No special options\n
+(('note:特別なオプションはない'))

data/how-to-create-bindings-2016.rab

@@ -64,7 +64,7 @@ how to create bindings
   * (('wait'))To use Ruby in more cases\n
     (('note:Rubyをもっといろんな場面で使うため'))
     * e.g.: (('tag:x-small:Machine leaning, multimedia, full text search, cipher and so on'))\n
-      (('note:例：機械学習、画像・動画・音声処理、全文検索・暗号'))
+      (('note:例：機械学習、画像・動画・音声処理、全文検索、暗号'))
   * (('wait'))We can use existing good features in Ruby by bindings\n
     (('note:バインディングがあると既存のいい機能をRubyで使える'))
 
@@ -72,8 +72,8 @@ how to create bindings
 
   * How about becoming a bindings developer?\n
     (('note:バインディング開発者になりませんか？'))
-    * (('wait'))To expand Ruby use cases!\n
-      (('note:Rubyの適用可能領域を増やすために！'))
+    * (('wait'))To expand use cases of Ruby!\n
+      (('note:Rubyを使えるケースを増やすために！'))
     * (('wait'))Not just an user for\n
       provided features\n
       (('note:提供された機能を使う1ユーザーではなく'))
@@ -143,7 +143,8 @@ How powerful auto generated bindings\n
 
 = libffi and FFI: 1\n(('note:libffiとFFIとは：1'))
 
-  * libffi: Library to impl. FFI
+  * libffi: Library to impl. FFI\n
+    (('note:FFIを実現するためのライブラリー'))
   * (('wait'))((*F*))oreign ((*F*))unction ((*I*))nterface
     * Generally:\n
       All APIs to impl. bindings\n
@@ -205,6 +206,17 @@ How powerful auto generated bindings\n
   void        hello_free   (Hello *hello);
   const char *hello_message(Hello *hello);
 
+= Ext impl. by hand\n(('note:手動での拡張ライブラリーの実装'))
+
+  # img
+  # src = images/bindings-as-extension-library.svg
+  # relative_width = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
 = Ext impl. by hand\n(('note:手動での拡張ライブラリーの実装'))
 
 (('note:https://github.com/kou/rabbit-slide-kou-rubykaigi-2016/blob/master/c-api/bindings/hello.c'))
@@ -273,7 +285,18 @@ How powerful auto generated bindings\n
 
 = Ext impl. by generation\n(('note:自動生成での拡張ライブラリーの実装'))
 
-  * (('wait'))SWIG can generate impl.\n
+  # img
+  # src = images/bindings-by-swig.svg
+  # relative_height = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= Ext impl. by generation\n(('note:自動生成での拡張ライブラリーの実装'))
+
+  * SWIG can generate impl.\n
     (('note:Simplified Wrapper and Interface Generator'))\n
     (('note:SWIGで実装を生成できる'))
   * (('wait'))An user
@@ -344,7 +367,8 @@ How powerful auto generated bindings\n
     * (('wait'))By hand: Need more works\n
       (('note:手動：追加作業あり'))
     * (('wait'))By generation: No more works\n
-      (('note:生成：追加作業なし'))\n
+      (('note:(But the bindings may not be easy to use)'))\n
+      (('note:生成：（使いやすくないけど）追加作業なし'))\n
       This is a large benefit!\n
       (('note:これは大きな利点！'))
 
@@ -360,6 +384,17 @@ How powerful auto generated bindings\n
 (('note:★ Extension library（拡張ライブラリー）'))\n
 (('note:☆ GObject Introspection: Recommended（オススメ）'))
 
+= libffi impl. by hand\n(('note:手動でのlibffiベースの実装'))
+
+  # img
+  # src = images/bindings-by-ffi.svg
+  # relative_width = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
 = libffi impl. by hand\n(('note:手動でのlibffiベースの実装'))
 
   # coderay ruby
@@ -403,7 +438,7 @@ How powerful auto generated bindings\n
   class Hello
     def message
       LibHello.hello_message(@hello)
-    endg
+    end
   end
 
 = Use wrapped impl.\n(('note:ラップした実装を使う'))
@@ -416,6 +451,154 @@ How powerful auto generated bindings\n
   => "Hello"
   # Object oriented API!
 
-= libffi impl. by generation\n(('note:自動生成でのlibffiベースの実装'))
+= libffi impl. by gen.\n(('note:自動生成でのlibffiベースの実装'))
+
+  # img
+  # src = images/bindings-by-gobject-introspection.svg
+  # relative_width = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= libffi impl. by gen.\n(('note:自動生成でのlibffiベースの実装'))
+
+  # coderay ruby
+  require "gi"
+  Hello = GI.load("Hello")
+
+= Use libffi impl. by gen.\n(('note:自動生成でのlibffiベースの実装を使う'))
+
+  irb(main):001:0> require "hello"
+  => true
+  irb(main):002:0> hello = Hello::Hello.new
+  => #<Hello::Hello:0x2a9de98 ptr=0x2ecd540>
+  irb(main):003:0> hello.message
+  => "Hello"
+  # Object oriented API!
+
+= Wrap up1: libffi\n(('note:まとめ1：libffi'))
+
+  * (('wait'))By hand: Need many works\n
+    (('note:手動：たくさん書かないといけない'))
+    * Need more works for easy to use\n
+      (('note:使いやすいAPIにするにはさらに書かないといけない'))
+  * (('wait'))By generation: Less works\n
+    (('note:生成：書くことが少ない'))
+    * No more works for easy to use\n
+      (('note:しかも使いやすいAPIになる'))
+
+= Wrap up2: libffi\n(('note:まとめ2：libffi'))
+
+  * On maintenance\n
+    e.g.: New functions\n
+    (('note:メンテナンス時：（例：新しい関数が追加された）'))
+    * (('wait'))By hand: Need more works\n
+      (('note:手動：追加作業あり'))
+    * (('wait'))By generation: No more works\n
+      (('note:生成：追加作業なし'))\n
+      This is a large benefit!\n
+      (('note:これは大きな利点！'))
+
+= SWIG⇔GI: When\n(('note:SWIG⇔GI：生成タイミング'))
+
+  * When are bindings generated?\n
+    (('note:バインディングの生成タイミング'))
+    * (('wait'))On build⇔Runtime\n
+      (('note:ビルド時⇔ランタイム'))
+    * (('wait'))SWIG: Need to build for new ver.\n
+      (('note:新しいバージョンがでたらリビルドが必要'))
+    * (('wait'))GI: No more works for new ver.\n
+      (('note:新しいバージョンがでても追加作業なし'))
+
+= SWIG⇔GI: Maintenance\n(('note:SWIG⇔GI：メンテナンス'))
+
+  * SWIG: Maintain .i file for each bindings\n
+    (('note:各バインディング用に.iファイルをメンテナンス'))
+  * GI: Maintain annotations for all bindings\n
+    (('note:全バインディング用にアノテーションをメンテナンス'))
+    * (('wait'))We can work together with other language bindings maintainers
+
+= SWIG: Overview (reprise)\n(('note:SWIG：概要（再掲）'))
+
+  # img
+  # src = images/bindings-by-swig.svg
+  # relative_height = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= SWIG: Maintenance\n(('note:SWIG：メンテナンス'))
+
+  # img
+  # src = images/maintain-swig-based-bindings.svg
+  # relative_height = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= GI: Overview (reprise)\n(('note:GI：概要（再掲）'))
+
+  # img
+  # src = images/bindings-by-gobject-introspection.svg
+  # relative_width = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= GI: Maintenance\n(('note:GI：メンテナンス'))
+
+  # img
+  # src = images/maintain-gobject-introspection-based-bindings.svg
+  # relative_width = 100
+
+== Slide properties
+
+: enable-title-on-image
+   false
+
+= Wrap up1\n(('note:まとめ1'))
+
+  * Bindings: Glue of C and Ruby\n
+    (('note:バインディング：主にCとRubyをつなぐもの'))
+    * (('wait'))You can use features implemented in C from Ruby\n
+      (('note:Cで実装された機能をRubyから使える'))
+
+= Wrap up2\n(('note:まとめ2'))
+
+  * Bindings expand use cases of Ruby\n
+    (('note:バインディングはRubyを使えるケースを増やす'))
+    * Because they provide existing good features to Ruby\n
+      (('note:バインディングは既存のよい機能をRubyで使えるようにするから'))
+
+= Wrap up3\n(('note:まとめ3'))
+
+  * Recommend GI based bindings\n
+    (('note:GIベースのバインディングがオススメ'))
+    * For easy to maintain\n
+      (('note:メンテンナンスしやすいから'))
+    * For easy to API\n
+      (('note:使いやすいAPIになるから'))
+
+(('note:GI: GObject Introspection'))
+
+= Wrap up4\n(('note:まとめ4'))
+
+Let's becoming a bindings developer!\n
+(('note:バインディング開発者になろう！'))
+
+= Things not talked\n(('note:話さなかったこと'))
 
-TODO
+  * Bindings are difficult to install on Win. Any idea?\n
+    (('note:Windowsでインストールが大変。どうすれば？'))
+  * Performance\n
+    (('note:性能'))
+  * Details of each bindings create method\n
+    (('note:それぞれのバインディング作成方法の詳細'))