什么是SWIG?
SWIG,即简化封装和接口生成器(Simplified Wrapper and Interface Generator),按照其创建者的说法,是“一种把用C、C++以及Objective-C所写的程序连接到各种高级编程语言的软件开发工具”。UNIX、Windows以及Macintosh系统都支持SWIG。
对Java程序员来说,SWIG是把C/C++代码嵌入到Java脚本的理想工具。SWIG理解C/C++申明,因此它可以解析C/C++头文件并产生Java模型并对其进行编码,编译之后,你就可以在Java中使用。
SWIG实际上一个“接口文件”作为输入,但它是用带有若干(可选)指示的标准C/C++头定义所组成的。实际上,如果代码相当干净,你就可以使用头文件本身。所产生的代码是完整的(也就是说,没有残留什么东西让你必须填写),而且代码由Java模型和C实现文件组成的,它只需要编译即可。
SWIG可以完成多种脚本语言的C/C++扩展,包括python、tcl、perl、CHICKEN、php、XML等等许多。它通过构造接口函数和代理类来实现模拟。
SWIG支持的语言
SWIG支持的语言非常的广泛,几乎支持目前所有流行的语言,目前支持C/C++转换的语言有Java/C#/PHP/Python/Perl/Perl5/Ruby/Ocaml/Tcl/Chicken。对各种语言的具体使用方法可以参考使用手册。
下面以Java为例描述使用SWIG将C++程序集成的过程。(具体的过程SWIG手册中都有详细的描述)。
SWIG当前支持以下的C++特性:
? 类
? 类的构造和析构
? 虚函数
? 公共继承(包括多重继承)
? 静态函数
? 函数和方法重载
? 大多数标准运算符的重载
? 引用
? 模板
? 函数指针
? 名字空间
虽然SWIG能够解析大多数C/C++声明,但不能提供完备的解析机制。限制包括一些非常复杂类型的声明和C++的高级特性。
下载安装SWIG
从官方网站或者开源项目中下载最新的SWIG程序,解压到本地目录。
安装JDK和添加JNI包
从sun的官方网站下载最新的Java JDK和JNI开发包。
使用VS6.0进行SWIG配置
l 打开一个新的工程并且通过向导建立一个DLL工程。
l 向工程中增加一个SWIG的接口文件(一般以.i结尾,例如example.i),以及SWIG将生成的封装文件(ie.example_wrap.c)。注意如果是使用C++为封装的文件example_wrap.cxx选择不同的后缀,不用担心封装文件没有存在-vs会自动更新。
l 选择SWIG接口文件(example.i),按右健,在弹出的菜单中选择”settings”选项。
l 在Description中输入”SWIG”。
l 在Commands文本框中输入:
echo In order to function correctly, please ensure the following environment variables are correctly set:
echo JAVA_INCLUDE: %JAVA_INCLUDE%
echo JAVA_BIN: %JAVA_BIN%
echo SWIG: %SWIG%
echo on
%SWIG%\swig.exe -c++ -java $(InputPath)”。
其中%SWIG%是在环境变量中定义的swig.exe的文件目录。
l 在Outputs文本框中输入:
$(InputName)_wrap.cxx,表示根据SWIG接口文件(example.i)生成相应的C++封装文件,这里生成的封装文件名为:example_wrap.cxx。
l 接着选中整个工程然后选中C/C++属性页,选择”Category”的Preprocessor项。在”Addition include directories”中输入包含Java和Jni头文件的目录,JAVA_INCLUDE,JAVA_INCLUDE\win32。
l 而后选择Link属性页,选择”Category”的”General”项。在out put file name中设置输出DLL文件的名称。
l 最后在选择Post-build step属性页,在Post-build command(s)中添加通过javac编译java文件的命令: %JAVA_BIN%\javac *.java。
l 至此整个设置过程已经完成,需要说明的是,生成的JNI函数接口定义是由SWIG接口文件(example.i)和方法名称一起定义的,在接口文件中由模块名称:%module example,和C++的方法名称共同组成。比如在C++中有方法Start(),那么此时在Jni中是这样描述的Java_exampleJNI_Start(),如果接口文件定义该成%module example_test那么在JNI中的函数接口定义也变为Java_example_testJNI_Start()。同时JNI函数接口的定义也要求调用的Java程序的包结构与之对应。
l 编译运行。
(1) 运行SWIG
安装SWIG成功后,使用以下格式的命令运行:
$ swig [ options ] filename
选项包括:
-chicken Generate CHICKEN wrappers
-csharp Generate C# wrappers
-guile Generate Guile wrappers
-java Generate Java wrappers
-mzscheme Generate Mzscheme wrappers
-ocaml Generate Ocaml wrappers
-perl Generate Perl wrappers
-php Generate PHP wrappers
-pike Generate Pike wrappers
-python Generate Python wrappers
-ruby Generate Ruby wrappers
-sexp Generate Lisp S-Expressions wrappers
-tcl Generate Tcl wrappers
-xml Generate XML wrappers
-c++ Enable C++ parsing
-Dsymbol Define a preprocessor symbol
-Fstandard Display error/warning messages in commonly used format
-Fmicrosoft Display error/warning messages in Microsoft format
-help Display all options
-Idir Add a directory to the file include path
-lfile Include a SWIG library file.
-module name Set the name of the SWIG module
-o outfile Name of output file
-outdir dir Set language specific files output directory
-swiglib Show location of SWIG library
-version Show SWIG version number
这只是命令行选项的一个子集。对每种目标语言都有各自附加的选项。可以使用命令"swig -help or swig -lang -help"查看全部。
filename是用户编写的SWIG标记脚本文件。
(2) SWIG的输入
输入为编写的脚本文件,通常后缀为.i或.swg。
通常该脚本文件的格式如下:
%module mymodule
%{
#i nclude "myheader.h"
%}
// Now list ANSI C/C++ declarations
int foo;
int bar(int x);
...
模块名使用"%module"(或-module命令行选项)进行标记。这个标记必须在文件的开始出现,用于命名目标扩展模块。如果选择在命令行提供,则不需要"%module"标记。
在"%{ ... %}"中进行头文件和其它特殊的声明(如% rename、% ignore等)。它将被逐字的复制到SWIG创建的wrapper文件中。
(3) SWIG的输出
SWIG的输出是一系列wrapper文件,也可能根据目标文件的不同产生一些其它的文件。默认情况下,输入名为file.i的文件将输出文件
file_wrap.c或file_wrap.cxx(依赖于是否使用了-c++选项)。编译器通常是通过文件后缀来确定源语言(C、C++等)类型的。
输出文件的名字可以通过-o选项修改。例如:
$ swig -c++ -python -o example_wrap.cpp example.i
SWIG创建的wrapper文件可直接用来编译连接产生共享库,不需要再对生成文件进行编辑。
SWIG资源
官方网站: http://www.swig.org
开源项目: http://sourceforge.net/projects/swig/