Aug 3, 2008

Ruby 1.9.0-3 : インタプリタ DLL を C から呼ぶ例

(2010-08-29 追記 : 以下の記事は古くなっています。こちらが参考になるかもしれません。 http://sites.google.com/site/ltsevenscore/ruby/tips/interpreter_dll )


  • ruby_options が値を返すようになっている
  • ruby_run という関数がない
など、Rubyの初期化・実行に関する README.EXT の内容は現状に追いついていないようです。
そのようなわけで、Ruby 1.9 を外部から利用する方法を少し調べてみました。
  • アプリケーションに Ruby を組み込みたい
  • rubyw.exe に代わる前処理プログラムを作りたい
といったときに役立つかもしれません。
利用したのは Ruby 1.9.0-3です。 これを VC++ 2008 でビルドした msvcr90-ruby190.dll を C プログラムから利用してみます。
こちらがアプリケーションのソースコード。必要最小限のエントリーポイント を取得した後、インタプリタの初期化と実行に移っています。
UseRubyDLL.c:
#define WIN32_LEAN_AND_MEAN
#include 

#define APP_NAME                "UseRubyDLL.exe"
#define RUBY_DLL_NAME           "d:\\ruby19\\bin\\msvcr90-ruby190.dll"
#define RUBY_SCRIPT_NAME        "script.rb"

HINSTANCE ruby_dll;

/* from include/ruby/ruby.h */
void  (*ruby_init)( void );
void  (*ruby_sysinit)( int*, char*** );
void* (*ruby_options)( int, char** );
/* from include/ruby/intern.h */
void  (*ruby_init_loadpath)( void );
int   (*ruby_run_node)( void* );

void
WinMainCRTStartup()
{
    /* Dummy arguments for ruby_sysinit(). */
    int         sysinit_argc = 0;
    char**      sysinit_argv = NULL;

    /* Manually construct interpreter arguments. */
    int         app_argc = 3;
    char*       app_args[3];
    char**      app_argv = app_args;
    app_args[0] = APP_NAME;
    app_args[1] = RUBY_SCRIPT_NAME;
    app_args[2] = "See ya.";

    ruby_dll = LoadLibrary( RUBY_DLL_NAME );
    if ( ruby_dll )
    {
        ruby_sysinit       = (void (*)( int*, char*** ))GetProcAddress( ruby_dll, "ruby_sysinit" );
        ruby_init          = (void (*)( void ))GetProcAddress( ruby_dll, "ruby_init" );
        ruby_init_loadpath = (void (*)( void ))GetProcAddress( ruby_dll, "ruby_init_loadpath" );
        ruby_options       = (void* (*)( int, char** ))GetProcAddress( ruby_dll, "ruby_options" );
        ruby_run_node      = (int (*)( void* ))GetProcAddress( ruby_dll, "ruby_run_node" );

        ruby_sysinit( &sysinit_argc, &sysinit_argv );
        ruby_init();
        ruby_init_loadpath();

        ruby_run_node( ruby_options( app_argc, app_argv ) );

        /* NOTE: After the execution, +ruby_run_node+ automatically
           calls +ruby_cleanup+. So there's no need to explicitly call
           Ruby's finalizer here(otherwise cause disaster).
         */

        FreeLibrary( ruby_dll );
    }
}
上記の ruby_*() 系関数の利用方法は Ruby のソースコード(winmain.c, eval.c, etc.)から把握したものです。 当然ですがインタプリタ DLL の場所など、ハードコードした部分は適宜変更する必要があります。
アプリケーションから呼び出すスクリプトはこちら。インタプリタ DLL の場所 次第では、標準ライブラリ(ここでは matrix.rb)jの require に失敗しますの でご注意を。
script.rb:
require 'matrix'
File.open( 'result.txt', 'w' ) do |f|
  f.puts Time.now
  f.puts Vector[rand,100*rand,10000*rand]
  f << ARGV
end
ビルドによって生成された UseRubyDLL.exe を以下のように実行します。 script.rb は同じ場所にあるものとします。
$ ./UseRubyDLL
実行すると同じ場所に result.txt ができているはず。以下が結果の一例です。
result.txt(例)
2008-08-03 18:52:16 +0900
Vector[0.434646515113465, 27.44515575993, 9534.51425972162]
["See ya."]
ちなみにビルド用の Makefile はこちら。実行ファイルを小さくするため、あえて Cygwin gcc (gcc -mno-cygwin -mwindows) を利用してみました。
Makefile:
TARGET = UseRubyDLL.exe
SRC = $(TARGET:exe=c)
OBJ = $(TARGET:exe=o)

CC = gcc -mno-cygwin -mwindows
CFLAGS = -Wall -Os
LDFLAGS = -lkernel32 -nostdlib

all: $(TARGET)

$(TARGET): $(OBJ)
 $(CC) -o $(TARGET) $< $(LDFLAGS)
 strip $(TARGET)

clean:
 rm $(OBJ) $(TARGET)

.c.o:
 $(CC) $(CFLAGS) -c $<
手元での結果はこちら:
$ gcc --version
gcc (GCC) 3.4.4 (cygming special, gdc 0.12, using dmd 0.125)
Copyright (C) 2004 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


kazuwe@kazuwe-PC ~/UseRubyDLL
$ ls -l UseRubyDLL.exe
-rwxr-xr-x 1 kazuwe None 2560 Aug  3 18:58 UseRubyDLL.exe
ちょっと心配になるくらい小さくなるものですね :-)

参考

  • embedding Ruby 1.9.0 inside pthread
  • BDS2006(C++Builder)からRubyを使う (山本隆の開発日誌)

Jul 20, 2008

RMath

今年1月に書いておきながら、 そのまま忘れて半年放置していた 3D CG 向けの数学関数の拡張ライブラリを公開しておこうと思います。
RMath といいます。
RMath は行列(3x3,4x4)、ベクトル(3要素,4要素)、クォータニオンの各クラスを含んだ拡張ライブラリです。 デバッグ用に同じインタフェースを持った Ruby 実装版も同梱しています(RMath.rb)。
ライセンスは zlib/libpng としました。
リファレンスやサンプルが少ないので、それらの充実が当面の課題ですね。
(2009-12-26 URLを新しいものに修正しました)

Jul 6, 2008

takeown, icacls コマンド

Windows Vista での chown / chmod コマンドに相当するものです。
訳あって C ドライブの Vista (Home Premium) をインストールしなおしたところ、 以前から D ドライブ側に置いていたファイルへのアクセスに支障が出てしまいました。
具体的には:
  • 消せないファイルが多発。
  • Cygwin 系コマンドでの操作が軒並み ``Permission denied'' に。
OS からは別な(しかももう存在しない!)ユーザーの所有物とみなされているのが原因です。
この問題を次のようにして解決してみました。
1. コマンドプロンプトを「管理者として実行」する
``C:\Windows\System32\cmd.exe'' のアイコンを右クリックし、「管理者として実行(A)」で起動。

2. 作業するディレクトリに移動
ここでは ``D:\cygwin'' とします。
C:\Windows\system32>d:

D:\>cd cygwin

D:\cygwin>
3. ファイルの所有権を取得
takeown コマンドを実行します。 ``/f '' がファイル名の指定。``/r'' は再帰的に実行することを指定するものです。
D:\cygwin>takeown /f * /r

成功: ファイル (またはフォルダ): "D:\cygwin\bin" は現在ユーザー "lt140-PC\lt140" によって所有されています。

成功: ファイル (またはフォルダ): "D:\cygwin\cygdrive" は現在ユーザー "lt140-PC\lt140" によって所有されています。

成功: ファイル (またはフォルダ): "D:\cygwin\Cygwin.bat" は現在ユーザー "lt140-PC\lt140" によって所有されています。

成功: ファイル (またはフォルダ): "D:\cygwin\Cygwin.ico" は現在ユーザー "lt140-PC\lt140" によって所有されています。

成功: ファイル (またはフォルダ): "D:\cygwin\dev" は現在ユーザー "lt140-PC\lt140" によって所有されています。

...(以下略)
4. アクセス権を操作
icacls コマンドを実行します。 複雑なオプションを多数受け付ける高機能なコマンドですが、「ユーザーに指定したパス以下のフルコントロールを与える」のであれば ``icacls <パス名> /grant <ユーザー名>:F /t'' だけで終了です。 フルコントロール可能な状態にしたくない場所での実行には注意してください。その場合は ``:F'' とした部分を変更することになります。``icacls /?'' で詳細を確認してください。
D:\cygwin>icacls D:\cygwin /grant lt140:F /t
処理ファイル: D:\cygwin\bin
処理ファイル: D:\cygwin\cygdrive
処理ファイル: D:\cygwin\Cygwin.bat
処理ファイル: D:\cygwin\Cygwin.ico
処理ファイル: D:\cygwin\dev
処理ファイル: D:\cygwin\etc
処理ファイル: D:\cygwin\lib
処理ファイル: D:\cygwin\setup.exe
処理ファイル: D:\cygwin\tmp

...(以下略)
これで無事に読み書きできるようになりました。
…OS は忠実に自分の仕事をこなしているだけなのですが、自分がPCの管理者かつ唯一の利用者であるという状況では正直切ないですね。

Jun 8, 2008

マニフェスト関連


Visual C++ ファイルの再配布

Visual C++ ライブラリ DLL (MSVCR80.DLL など) に到達できた場合 (アプ
リケーションのローカル フォルダまたはシステム フォルダにインストール
されている場合など)、次のメッセージが表示されます。

R6034 An application has made an attempt to load the C runtime library incorrectly.

C/C++ 分離アプリケーションおよび side-by-side アセンブリのトラブルシューティング

すべての DLL がバイナリに埋め込まれたマニフェストを持つようにすることを
お勧めします。DLL が LoadLibrary 呼び出しで読み込まれる場合、外部マニフェストは
無視されます。

方法 : マニフェストを C/C++ アプリケーションに埋め込む

C/C++ アプリケーション (またはライブラリ) では、そのマニフェストを
最終的なバイナリに埋め込んでおくことをお勧めします。これにより、ほとんどの
シナリオで実行時の適切な動作が保証されます。

wxRuby2


wxWidgets の Ruby バインディング・ wxRuby というものを試そうとしてみました。 利用しているのは One-Click Ruby Installer 1.8.6-26。以下の作業は主に Cygwin Bash シェルで行っています。
インストールは RubyGems で楽勝でした。
$ gem.bat install wxruby
Bulk updating Gem source index for: http://gems.rubyforge.org
Building native extensions.  This could take a while...
Successfully installed wxruby-1.9.7-x86-mswin32-60
1 gem installed
wxRuby 1.9.7 の Windows 版バイナリがインストールされます。
それではさっそくサンプル起動!
$ ruby -rubygems d\:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/samples/minimal/minimal.rb
しかしその瞬間、よくありがちなダイアログボックスが登場しました。
---------------------------
Microsoft Visual C++ Runtime Library
---------------------------
Runtime Error!

Program: d:\ruby\bin\ruby.exe

R6034
An application has made an attempt to load the C runtime library incorrectly.
Please contact the application's support team for more information.

---------------------------
OK   
---------------------------
そしてターミナルにはエラーメッセージが:
d:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/lib/wxruby2.so: 1114: ダイナミック リンク ライブラリ (DLL) 初期化ルーチンの実行に失敗しました。
- d:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/lib/wxruby2.so (LoadError)
from d:/ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:27:in `require'
from d:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/lib/wx.rb:12
from d:/ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:32:in `gem_original_require'
from d:/ruby/lib/ruby/site_ruby/1.8/rubygems/custom_require.rb:32:in `require'
from d:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/samples/minimal/minimal.rb:8
要するに wxruby2.so の LoadError だそうです。見に行きましょう。
$ cd d\:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/lib/
$ ls
wx  wx.rb  wxruby2.exp  wxruby2.lib  wxruby2.so  wxruby2.so.manifest
む、wxruby2.so.manifest が。まさか。
$ strings wxruby2.so | grep manifest

$
埋 め 込 ま れ て な い
LoadLibrary される DLL の場合は外部マニフェストが無視されるそうです。最終的なバイナリファイルにはマニフェストの埋め込みが必要となります。
そのようなわけで Visual Studio のコマンドプロンプトから以下の作業をしました:
Setting environment for using Microsoft Visual Studio 2008 x86 tools.

D:\Programs\Microsoft Visual Studio 9.0\VC>cd D:\ruby\lib\ruby\gems\1.8\gems\wxruby-1.9.7-x86-mswin32-60\lib

D:\ruby\lib\ruby\gems\1.8\gems\wxruby-1.9.7-x86-mswin32-60\lib>mt -manifest wxruby2.so.manifest -outputresource:wxruby2.so;2
確かめてみましょう。元の Cygwin ターミナルから:
$ strings wxruby2.so | grep manifest
無事に埋め込まれた模様。ではあらためて!
$ ruby -rubygems d\:/ruby/lib/ruby/gems/1.8/gems/wxruby-1.9.7-x86-mswin32-60/samples/minimal/minimal.rb


うまくいきました。

May 18, 2008

メニューなどのテスト




Qtの各種機能を試してみました。前回のものではGLUTとの違いがわかりませんからね。
OpenGLによる描画とQtによる2Dオブジェクトの描画機能が併用できる、というのは強力だと思いました(画面右下のRubyロゴがそれ)。
中にはGLUTのソースコード(glut_teapot.c)から移植した 'teapot.rb' というものも入ってます。 GLUTから離れてティーポットが拝めなくなってしまったのが寂しかったものですから(^^;
アーカイブの展開後に
$ ruby -rubygems menutest.rb
…として起動してください。
動作に必要なものは以下の通り:

※menutest.rb: 利用したQtオブジェクトのリファレンス

May 15, 2008

glwidget.rb




QtのOpenGLサンプルにあるglwidget.cppを qt4-qtruby向けに書き直してみました。ruby-openglを併用しています。
これ単体で動くようにしてありますので、
$ ruby -rubygems glwidget.rb
…とすれば起動します。
動作に必要なものは以下の通りです:
コード:
require 'qt'
require 'opengl'

class GLWidget < Qt::GLWidget
  signals 'xRotationChanged(int)'
  signals 'yRotationChanged(int)'
  signals 'zRotationChanged(int)'

  slots 'setXRotation(int)'
  slots 'setYRotation(int)'
  slots 'setZRotation(int)'

  def initialize
    super
    @object = 0
    @xRot = 0
    @yRot = 0
    @zRot = 0
    @lastPos = Qt::Point.new

    @trolltechGreen = Qt::Color::fromCmykF( 0.40, 0.0, 1.0, 0.0 )
    @trolltechPurple = Qt::Color::fromCmykF( 0.39, 0.39, 0.0, 0.0 )
  end

  def destroy
    makeCurrent()
    glDeleteLists( @object, 1 )
  end

  def minimumSizeHint
    return Qt::Size.new( 50, 50 )
  end

  def sizeHint
    return Qt::Size.new( 400, 400 )
  end

  def setXRotation( angle )
    normalizeAngle( angle )
    if ( angle != @xRot )
      @xRot = angle
      emit xRotationChanged( angle )
      updateGL()
    end
  end

  def setYRotation( angle )
    normalizeAngle( angle )
    if ( angle != @yRot )
      @yRot = angle
      emit yRotationChanged( angle )
      updateGL()
    end
  end

  def setZRotation( angle )
    normalizeAngle( angle )
    if ( angle != @zRot )
      @zRot = angle
      emit zRotationChanged( angle )
      updateGL()
    end
  end

  def initializeGL
    qglClearColor( @trolltechPurple.dark() )
    @object = makeObject()
    glShadeModel( GL_FLAT )
    glEnable( GL_DEPTH_TEST )
    glEnable( GL_CULL_FACE )
  end

  def paintGL
    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT )
    glLoadIdentity()
    glTranslated( 0.0, 0.0, -10.0)
    glRotated( @xRot / 16.0, 1.0, 0.0, 0.0 )
    glRotated( @yRot / 16.0, 0.0, 1.0, 0.0 )
    glRotated( @zRot / 16.0, 0.0, 0.0, 1.0 )
    glCallList( @object )
  end

  def resizeGL( width, height )
    # [NOTE] +qMin+ in the original code is a C++ Template Function.
    # Ref.: $(QTDIR)/src/corelib/global/qglobal.h
    #   template 
    #   inline const T &qMin(const T &a, const T &b) { if (a < b) return a; return b; }
    side = [width, height].min
    glViewport( (width - side) / 2, (height - side) / 2, side, side )

    glMatrixMode( GL_PROJECTION )
    glLoadIdentity()
    glOrtho( -0.5, +0.5, +0.5, -0.5, 4.0, 15.0 )
    glMatrixMode( GL_MODELVIEW )
  end

  def mousePressEvent( event ) # event : Qt::MouseEvent
    @lastPos = event.pos
  end

  def mouseMoveEvent( event ) # event : Qt::MouseEvent
    dx = event.x - @lastPos.x
    dy = event.y - @lastPos.y

    if ( event.buttons() & Qt::LeftButton.to_i )
      setXRotation( @xRot + 8 * dy )
      setYRotation( @yRot + 8 * dx )
    elsif ( event.buttons() & Qt::RightButton.to_i )
      setXRotation( @xRot + 8 * dy )
      setZRotation( @zRot + 8 * dx )
    end
    @lastPos = event.pos
  end

  def makeObject
    list = glGenLists( 1 )
    glNewList( list, GL_COMPILE )

    glBegin( GL_QUADS )

    x1 = +0.06
    y1 = -0.14
    x2 = +0.14
    y2 = -0.06
    x3 = +0.08
    y3 = +0.00
    x4 = +0.30
    y4 = +0.22

    quad( x1, y1, x2, y2, y2, x2, y1, x1 )
    quad( x3, y3, x4, y4, y4, x4, y3, x3 )

    extrude( x1, y1, x2, y2 )
    extrude( x2, y2, y2, x2 )
    extrude( y2, x2, y1, x1 )
    extrude( y1, x1, x1, y1 )
    extrude( x3, y3, x4, y4 )
    extrude( x4, y4, y4, x4 )
    extrude( y4, x4, y3, x3 )

    num_sectors = 200

    for i in 0...num_sectors do
      angle1 = (i * 2 * Math::PI) / num_sectors
      x5 = 0.30 * Math::sin( angle1 )
      y5 = 0.30 * Math::cos( angle1 )
      x6 = 0.20 * Math::sin( angle1 )
      y6 = 0.20 * Math::cos( angle1 )

      angle2 = ((i + 1) * 2 * Math::PI) / num_sectors
      x7 = 0.20 * Math::sin( angle2 )
      y7 = 0.20 * Math::cos( angle2 )
      x8 = 0.30 * Math::sin( angle2 )
      y8 = 0.30 * Math::cos( angle2 )

      quad( x5, y5, x6, y6, x7, y7, x8, y8 )

      extrude( x6, y6, x7, y7 )
      extrude( x8, y8, x5, y5 )
    end

    glEnd()

    glEndList()
    return list

  end

  def quad( x1,  y1,  x2,  y2,  x3,  y3,  x4,  y4 )
    qglColor( @trolltechGreen )

    glVertex3d( x1, y1, -0.05 )
    glVertex3d( x2, y2, -0.05 )
    glVertex3d( x3, y3, -0.05 )
    glVertex3d( x4, y4, -0.05 )

    glVertex3d( x4, y4, +0.05 )
    glVertex3d( x3, y3, +0.05 )
    glVertex3d( x2, y2, +0.05 )
    glVertex3d( x1, y1, +0.05 )

  end

  def extrude( x1,  y1,  x2,  y2 )
    qglColor( @trolltechGreen.dark(250 + (100 * x1).to_i) )

    glVertex3d( x1, y1, +0.05 )
    glVertex3d( x2, y2, +0.05 )
    glVertex3d( x2, y2, -0.05 )
    glVertex3d( x1, y1, -0.05 )
  end

  def normalizeAngle( angle )
    while ( angle < 0 ) do
      angle += 360 * 16
    end
    while ( angle > 360 * 16 ) do
      angle -= 360 * 16
    end
  end

end


#
# Application starts here.
#
begin
  a = Qt::Application.new(ARGV)

  w = GLWidget.new
  w.show

  a.exec
ensure
  w.destroy
end