swig学习大全

一、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。对各种语言的具体使用方法可以参考使用手册。

 SWIG当前支持以下的C++特性：
?   类
?   类的构造和析构
?   虚函数
?   公共继承（包括多重继承）
?   静态函数
?   函数和方法重载
?   大多数标准运算符的重载
?   引用
?   模板
?   函数指针
?   名字空间
  虽然SWIG能够解析大多数C/C++声明，但不能提供完备的解析机制。限制包括一些非常复杂类型的声明和C++的高级特性。

 

三、SWIG指令简介

3.1 安装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标记脚本文件。

3.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.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文件可直接用来编译连接产生共享库，不需要再对生成文件进行编辑。