SWIGの使い方

概要

近年、C#を代表とした.NETFrameworkのアプリケーションが増えてきました。 C#は.NETFrameworkの豊富なライブラリによるC++並の柔軟性とVBライクなデザイナによる開発効率性を兼ね備えた言語です。しかし、C++で作られた既存のライブラリやフレームワークを使う機能には制限があり、 DLLの場合、クラスを公開している拡張DLLは使えず、C言語の関数を公開したレギュラーDLLしか使えません。

SWIGは拡張DLLのヘッダファイルを読込み、拡張DLLをレギュラーDLLに変換するラッパと、そのラッパを他の言語のクラスに変換するラッパを出力するものです。本文書ではSWIGを使って拡張DLLであるIrrlichtをC#で使えるようにした際のTipsについてまとめています。

SWIGの基本的な機能・制限は以下のとおり

C++で定義されたクラスをC#から使える形にしてくれる
char*をstringに変換するなど、基本的な型変換は行ってくれる
Directorという機能によってC++側のクラスをC#で継承可能
C++側で多重継承されていた場合、C#側ではそれが反映されない(制限)
ネストされたクラス、構造体、共用体には対応できない(制限)

基本

サンプルコード：00_basic.zip

SWIGは専用の構文を使ってインターフェイスファイル(*.i)を作成してそれをインプットとしてラッパを作成します。最も基本的なインターフェイスファイルは以下になります。

// irrlicht.i
%module "IrrlichtNet"  //(1)

%{
#include "irrlicht.h"  //(2)
%}

%include "irrlicht.h"  //(3)

モジュール名を指定する。モジュール名は生成される*.cppファイルや*.hファイルの名前、C#側での一番親のクラス名になる。
%{、%}で囲まれた部分は生成される*.cppファイルにそのまま出力される。ここでは型の名前解決のためにヘッダファイルを指定している。
%includeでSWIGが解析を行うファイルを指定する。

このようなインターフェイスファイルを作ったら、以下のようにSWIGに食わせるとラッパのIrrlichtNet.cppとIrrlichtNet.hとCSファイルが出力される。

swig.exe -csharp -c++ irrlicht.i

C#に独自のコードを追加したい

サンプルコード：03_AddCSCode.zip

以下のように%typemapを記述します。ただし、設定できるのはクラスに対して1つのみで、多重定義の場合は上書きされます。

 %typemap(cscode) C++型
 %{
 //お好きなC#コード
 %}

Warningを無視する

多くの警告が出ると重要な警告を見逃してしまうことがあります。そんな時には警告を出さないように制御します。全体に適用する方法とクラス単位で適用する方法の2種類があります。

 //全体に適用
 #pragma SWIG nowarn=312
 //クラス単位に適用
 %warnfilter(312) irr::string //C++型名を指定

メソッド・クラスの無効化

サンプルコード：04_ignoreMethod.zip

C#側でラッパを作って欲しくないメソッドやクラスを指定できます。

 //メソッド名で指定
 %ignore irr::core::array::operator==;
 
 //引数まで含めて完全一致で指定
 %ignore irr::io::IAttributes::addBinary(const char* attributeName, void* data, int dataSizeInBytes);
 
 //クラスを指定
 %ignore irr::SEvent::SGUIEvent;

メソッドの名前変更

C++のクラス・メソッドの名前を変更できます。またC#の予約語で使えない識別子を変更ために使ったりします。

 //クラス名の変更
 %rename(Lock) lock;
 
 //メソッド名の変更
 %rename(equalTo) operator==;

C#ラッパクラスにpartialをつける

C#のクラスにpartialをつけるとclassを複数ファイルに書くことができます。そのため、SWIGが生成するクラスに独自のメソッドを追加することができます。

 //全クラスにpartialをつける
 %typemap(csclassmodifiers) SWIGTYPE, SWIGTYPE *, SWIGTYPE &, SWIGTYPE [], SWIGTYPE (CLASS::*) "public partial class"

 //C#
 //SWIG生成csファイル
 public partial class CTest
 {
         ・・・
 }

 //C#
 //自作csファイル
 public partial class CTest
 {
   public void Add(int x)
   {
     ・・・
   }
 }

templateが使われている

サンプルコード：05_template.zip

テンプレートはC#へ変換されません。テンプレート付きのクラスをC#で使うにはテンプレートに型を指定して別名のクラスとして使用します。 C#にはジェネリックというテンプレートライクな機能がありますが、それには変換しません。

 template <class T>
 class CArray
 {
         //・・・
 }
 //CArray<int>型をArrayInt型としてC#から使う
 %template(ArrayInt) CArray<int>;

wchar_tが使われている

サンプルコード：06_wchar_t.zip

SWIG標準では、char*の引数をstringに変換しますが、ワイド文字であるwchar_t*が使われている場合があります。その場合でも以下のよう"wchar.i"を読み込むとstringへ変換されるようになります。

 %include "wchar.i"

応用

再帰的なinclude

SWIGでは、*.hファイルに書かれている#include文を再帰的に読み込んでくれません。オプションで全てのincludeを読むようにもできますが、その場合標準ライブラリも読みに行ってしまうのであまり使えません。宣言の順番もどうやら関係しているようなので、#includeのネストを解析して、順番どおりに並べる必要があります。私の場合、次のようなツールを作ってヘッダファイルを解析し、%includeを並べました。ParseInclude.zip

C++のクラスをC#側で継承し、C++側に渡したい

サンプルコード：07_inheritance.zip

以下のようにインターフェイスファイルを書くと指定した型をC#で継承することができます。特定の型を継承した引数を要求するC++ライブラリに有効です。

 %module(directors="1") ○○
 %feature("director") C++型;

ただし、問題も多いです。

wchar_t*が正しく文字列に変換されない→対応可能
引数の名前がC#の予約語にかぶっていても変更されない→ヘッダファイルを修正するしかない。
無限ループになることがある。

以下にC#で継承する例を示します。

 //Test.h
 class CReceiver
 {
 public:
   virtual void OnReceiveMessage(int msgCode) = 0;
 };
 class CConnection
 {
   CReceiver* m_pReceiver;
 public:
   void SetReceiver(CReceiver* pReceiver){m_pReceiver=pReceiver;}
   void RaiseReceive(int msgCode)
   {
     m_pReceiver->OnReceiveMessage(msgCode);
   }
 };

 //Test.i
 %module(directors="1") "Test"
 %{
   #include "Test.h"
 %}
 %feature("director") CRecever;
 %include "Test.h"

 //Program.cs
 class CSharpRecever : CReceiver
 {
   override void OnReceiveMessage(int msgCode)
   {
     Console.WriteLine("Receive message:{0}", msgCode);
   }
 }
 class Program
 {
   static void Main(string[] args)
   {
     var connection = new CConnection();
     connection.SetReceiver(new CSharpRecever());
         
     connection.RaiseReceive(10);
   }
 }

C++の引数に配列を渡したい

C++へC#の配列を渡す方法です。C++で引数に配列を渡す際はポインタになりますが、 SWIGは、単なる参照渡しか、ポインタに値を格納するのか、配列渡しなのか判断できません。そのため、引数が配列であることを指定する必要があります。指定の方法ですが、まず"arrays_csharp.i"を%includeします。この中に配列の宣言をするための定義が書かれています。その後、%apply文を以下のように書きます。

 %include "arrays_csharp.i"
 %apply C++型 INPUT[] {引数のパターン}

なお、この方法はintやdoubleなど基本型のみです。文字列配列やクラスの配列には対応していません。

以下に実際の例を示します。

 //Test.h
 class CTest
 {
   void SetArray(unsigned short* arr){}
 }

 //Test.i
 %module() "Test"
 %{
   #include "Test.h"
 %}
 %include "arrays_csharp.i"
 %apply unsigned short INPUT[] {unsigned short* arr}
 %include "Test.h"

 //Program.cs
 static void Main(string[] args)
 {
   var test = new CTest();
   test.SetArray(new ushort[]{0,1,2,3});
 }

C++へ引数で渡した配列へ値を格納させたい

上記と逆のパターンです。配列を渡してそこに値を格納するようなC++メソッドをC#から使えるようにします。基本的には上記と同じですが、INPUTをOUTPUTにします。

以下で例を示します。

 //Test.h
 class CTest
 {
   void GetArray(float* arr)
   {
     arr[0] = 0f;
     arr[1] = 1f;
   }
 }

 //Test.i
 %module() "Test"
 %{
 #include "Test.h"
 %}
 %include "arrays_csharp.i"
 %apply float OUTPUT[] {float *arr_out}
 %include "Test.h"

 //Program.cs
 static void Main(string[] args)
 {
   var test = new CTest();
   var arr = new float[2];
   test.GetArray(arr);
 }

C++側に参照を渡したい

C++の引数が参照(○○＆)でC#でrefを使った引数を使いたい場合、以下のように指定します。ただし、intやshortなど基本的な型のみです。enumも非対応です。

%include"typemap.i"
%apply int &INOUT { int& outBegin };

以下で例を示します。

 //Test.h
 class CTest
 {
 public:
   void GetRange(int& outBegin, int& outEnd)
   {
     outBegin = 10;
     outEnd = 14;
   }
 }

 //Test.i
 %module() "Test"
 %{
 #include "Test.h"
 %}
 %include"typemap.i"
 %apply int &INOUT { int& outBegin };
 %apply int &INOUT { int& outEnd };
 %include "Test.h"

 //Program.cs
 static void Main(string[] args)
 {
   var test = new CTest();
   int begin = 0;
   int end = 0;
   test.GetRange(ref begin, ref end);
 }

enumの引数でref、out

サンプルコード：02_enum_ref.zip

SWIGではintやdoubleなど基本的な型でのref、outに対応していますが、enumではできません。以下のような書き方をするとenumでのref、outが使えます。

 //Test.h
 enum E_TYPE
 {
     TYPE_A = 0,
     TYPE_B,
     TYPE_COUNT
 };
 
 class CTest
 {
     E_TYPE m_type;
 public:
     void SetType(E_TYPE type)
     {
         m_type = type;
     }
     void GetType(E_TYPE& type)
     {
         type = m_type;
     }
     void GetType2(E_TYPE* type)
     {
         *type = m_type;
     }
     void Print()
     {
         switch(m_type)
         {
         case TYPE_A:
             printf("m_type=TYPE_A\r\n");
             break;
         case TYPE_B:
             printf("m_type=TYPE_B\r\n");
             break;
         default:
             printf("m_type=Unknown\r\n");
             break;
         }
     }
 };

 //Test.i
 %module "Test"
 
 %{
 #include "..\Test.h"
 %}
 
 %include"typemaps.i"
 
 //■enumのref対応
 %apply int &INOUT {E_TYPE& type};
 %typemap(cstype) E_TYPE& type "ref E_TYPE"     //C#側の引数の型
 %typemap(csin) E_TYPE& type "ref $csinput"     //C#側から中間ラッパへ渡す際の引数
 %typemap(imtype) E_TYPE& type "ref E_TYPE"     //中間ラッパの型
 %typemap(ctype) E_TYPE& type "int*"            //C++側の引数の型
 
 //■enumのout対応
 %apply int &OUTPUT {E_TYPE* type};
 %typemap(cstype) E_TYPE* type "out E_TYPE"     //C#側の引数の型
 %typemap(csin) E_TYPE* type "out $csinput"     //C#側から中間ラッパへ渡す際の引数
 %typemap(imtype) E_TYPE* type "out E_TYPE"     //中間ラッパの型
 %typemap(ctype) E_TYPE* type "int*"            //C++側の引数の型
 
 %include "test.h"

 //Program.cs
 static void Main(string[] args)
 {
     CTest test = new CTest();
 
     //enumのref
     E_TYPE type = E_TYPE.TYPE_B;
     test.GetType(ref type);
 
     //enumのout
     test.GetType2(out type);
 }

Windows独自の構文

サンプルコード：11_dllimport.zip

"declspec(dllimport)"のようなWindows独自の構文が使われているとSWIGでエラーになることがあります。そんな時、インターフェイスファイルでwindows.iを読み込むことで、これらの構文を無視することができます。

 //Test.h
 __declspec(dllimport) class CTest
 {
 
 };

 //Test.i
 %module "Test"
 %{
 #include "..\Test.h"
 %}
 
 %include <windows.i>
 
 %include "Test.h"

クラス・構造体のネストが使われている

サンプルコード：12_nestedClass.zip

近日公開

C++から戻り値で配列を受け取りたい(サイズ固定、コピー渡し)

近日公開

C++の変なコードのせいでエラー

近日公開

C#側でキャストしたい

近日公開

C#側でコピーコンストラクタを使いたい

近日公開

C#側でインデクサを使いたい

近日公開

void*引数をIntPtrに変換

近日公開

publicメンバに配列

近日公開

directorを使うとin,outが変換されない

サンプルコード：09_inheritance_conflictName.zip

近日公開

directorでwchar_t*がstringに変換されない

サンプルコード：08_inheritance_wchar_t.zip

近日公開

Dispose処理の変更

近日公開

新たな関数を追加する

近日公開

ポインタ配列を引数で渡す

近日公開

配列の戻り値を受け取る

近日公開

FILE*を扱えるようにする

近日公開

引数のoutでポインタを返す場合

近日公開

IrrlichtMLNetSwig (1.2.1.531)	2010-11-17 23:14
IrrlichtNetSwig (1.2.0.528)	2010-08-14 13:23

Irrlicht.NET by SWIG

最近の更新 (Recent Changes)

2011-01-10

2010-11-20

2009-08-05

Últimas Arquivo Comunicados

Wikiガイド(Guide)

サイドバー (Side Bar)

SWIGの使い方

概要

基本

C#に独自のコードを追加したい

Warningを無視する

メソッド・クラスの無効化

メソッドの名前変更

C#ラッパクラスにpartialをつける

templateが使われている

wchar_tが使われている

応用

再帰的なinclude

C++のクラスをC#側で継承し、C++側に渡したい

C++の引数に配列を渡したい

C++へ引数で渡した配列へ値を格納させたい

C++側に参照を渡したい

enumの引数でref、out

Windows独自の構文

クラス・構造体のネストが使われている

C++から戻り値で配列を受け取りたい(サイズ固定、コピー渡し)

C++の変なコードのせいでエラー

C#側でキャストしたい

C#側でコピーコンストラクタを使いたい

C#側でインデクサを使いたい

void*引数をIntPtrに変換

publicメンバに配列

directorを使うとin,outが変換されない

directorでwchar_t*がstringに変換されない

Dispose処理の変更

新たな関数を追加する

ポインタ配列を引数で渡す

配列の戻り値を受け取る

FILE*を扱えるようにする

引数のoutでポインタを返す場合