使用SWIG将C/C++库移植到其他语言中

SWIG简介

SWIG是一个将C和C++语言程序绑定到其他语言的工具，可以让很多高层次的程序设计语言如脚本语言很方便地调用底层程序。SWIG支持很多的语言如Perl, PHP, Python, Tcl, Ruby, Java, C#, Octave和R等，这些语言在不同程度上支持本地接口调用。利用SWIG，只需写一些接口文件，就可以生成一些用相应语言的本地接口库封装的代码。利用C和C++编译器编译成动态库文件后，就可以直接用高层次的语言调用了。SWIG在很多的跨平台的项目中都得到了广泛的应用，例如Subversion, PyOgre, PyOpenGL, wxPython等。

SWIG的下载与安装

    在Ubuntu系统的软件源上有SWIG软件包，可以直接通过以下命令安装。

sudo apt-get install swig

    在Windows系统或者其他的Linux版本上，可以下载源代码包，下载地址：http://prdownloads.sourceforge.net/swig/swig-2.0.9.tar.gz。

    在Linux系统下，解压缩后，运行

./configure
make

    编译完成后就可以使用。

    在Windows系统下，建议安装MinGW或者Cygwin，使用gcc编译器编译。

准备源文件和接口文件

    在运行SWIG之前，首先要准备好C/C++程序的源文件，并编写接口文件。这里采用一个简单的例子，要封装的是一个叫做Example的模块。

swig -java Example.i

    我们要导出Example.c文件中所有变量和函数中。如下所示。

/* Example.c */
include <stdio.h>

int integer = 100;

int add(int a, int b)
{
        return a + b;
}

char* getString()
{
        return "Some string";
}

void printLine(const char* str)
{
        printf("%s\n", str);
}

    新建一个文件Example.i，输入以下内容：

%module Example

%{
extern int integer;
extern int add(int a, int b);
extern char* getString();
extern void printLine(const char* str);
%}

extern int integer;
extern int add(int a, int b);
extern char* getString();
extern void printLine(const char* str);
 

    Example.i中%module后面是库的名称，%{和%}中的内容是要加入到生成文件中的内容，通常是函数和变量的定义和要包含的头文件，作用是让生成的源文件爱女能够通过编译。之后的内容是正常的C函数和变量的定义，与正常C语言的语法相同。

使用SWIG生成Java类文件

    现在运行命令

swig -java Example.i

    默认将生成Example_wrap.c, Example.java, ExampleJNI.java三个文件。然后用以下命令编译共享库文件。

gcc -c -fPIC Example.c Example_wrap.c -I/usr/lib/jvm/java-7-openjdk-amd64/include/
gcc -shared -o libExample.so Example.o Example_wrap.o

    注意编译时要包含Java本地接口头文件jni.h所在的目录，这个文件的位置在不同系统中不同，编译时需要加入。

    现在就已经可以使用SWIG生成的类文件Example.java和相应的JNI文件ExampleJNI.java来调用库函数了。新建一个文件Main.java来测试一下。

public class Main{
        public static void main(String args[]){
                System.loadLibrary("Example");
                System.out.println("getInteger(): " + Example.getInteger());
                Example.setInteger(100);
                System.out.println(Example.getInteger());
                System.out.println("1 + 2 = " + Example.add(1, 2));
                System.out.println("getString(): " + Example.getString());
                Example.printLine("printString()");
        }
}

为了让我们刚才编译的库文件libExample.so能够被加载，需要添加库路径：

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:.

编译运行：

javac Main.java
java Main

输出结果如下所示：

getInteger(): 100
100
1 + 2 = 3
getString(): Some string
printString()

总结

     SWIG的功能很强大，可以支持很多语言。这里只测试了Java语言的封装，对于其他语言，方法也比较类似，只是在编译的时候需要包含相应的本地库头文件，如Python中的Python.h，Java中的jni.h。另外，这里演示的只是最简单的接口文件的编写，实际上，接口文件可以有更多的选项，这些在SWIG的文档中有更详细的说明。C语言的封装相对比较简单，对于C++这样的面向对象的语言，接口文件的编写略微复杂，但是也比较容易掌握。当然，在调用这些本地接口的时候还有一个问题，就是安全性。在设计接口的时候也要充分意识到安全性问题，防止指针错误和内存泄漏等。虽然SWIG已经能够很好地处理指针，但有的时候还需要自己去实现指针的封装。