SWIG 源码编译以及调试

SWIG是个帮助使用C或者C编写的软件能与其它各种高级编程语言进行嵌入联接的开发工具。SWIG能应用于各种不同类型的语言包括常用脚本编译语言例如Perl, PHP, Python, Tcl, Ruby and PHP。支持语言列表中也包括非脚本编译语言，例如C#, Common Lisp (CLISP, Allegro CL, CFFI, UFFI), Java, Modula-3, OCAML以及R，甚至是编译器或者汇编的计划应用（Guile, MzScheme, Chicken）。SWIG普遍应用于创建高级语言解析或汇编程序环境，用户接口，作为一种用来测试C/C或进行原型设计的工具。SWIG还能够导出XML或Lisp s-expressions格式的解析树。SWIG可以被自由使用，发布，修改用于商业或非商业中

环境准备

1. swig源码 https://github.com/swig/swig (最新版本有cmake文件，老版本编译比较麻烦，本文使用最新版本编译)
2. bison

bison是一个GNU自由软件，用于自动生成语法分析器。根据自定义的语法规则，你可以分析大部分语言的语法，小到桌面计算器，大到复杂的编程语言
安装完成之后需要将执行目录加到环境变量中

官方文档：http://www.gnu.org/software/bison/manual/bison.html
下载链接：http://gnuwin32.sourceforge.net/packages/bison.htm

3. PCRE2

PCRE库提供了正则表达式匹配功能，它使用与Perl 5一致的语法语义。它的API即包括native的API，又包含一套包装了POSIX regular API的API。PCRE是免费的，也可用于商业用途。

1. 下载地址：http://sourceforge.net/projects/pcre/
2. 官网：http://www.pcre.org/

这个库是可选的，去掉这个库的编译并不会导致swig的编译报错，找到swig的CMakeLists.txt文件，注释掉下面的这段代码

option (WITH_PCRE "Enable PCRE" OFF)
#if (WITH_PCRE)
#  find_package (PCRE2 REQUIRED)
#  set (HAVE_PCRE 1)
#  include_directories (${PCRE2_INCLUDE_DIRS})
#endif()

//开启的方式
option (WITH_PCRE "Enable PCRE" ON)
#if (WITH_PCRE)
  SET(PCRE2_INCLUDE_DIR ${SWIG_ROOT}/pcre-8.45/include)
  SET(PCRE2_LIBRARY ${SWIG_ROOT}/pcre-8.45/lib/pcre2-8-static.lib)
  find_package (PCRE2 REQUIRED)
  add_definitions(-DPCRE2_STATIC)
  set (HAVE_PCRE 1)
  include_directories (${PCRE2_INCLUDE_DIRS})
#endif()

4. VS2017即以上版本

vs2017以及以上的版本都支持cmake工程项目(可以在安装的时候勾选cmake相关组件),直接使用cmake的工程项目即可编译通过。vs2017以下的版本需要使用cmake-gui转换为sln，这种方式转出来的库依赖都是绝对路径，不适合给到别人使用

编译

1. 使用vs2017打开cmake工程

2.通过vs2017菜单栏的cmake菜单中选择编译

3. 使用cmake生成的exe默认是在cmake的缓存文件夹中的，可以在cmake中添加输出路径代码

## 当前cmake项目的文件夹中;
SET(EXECUTABLE_OUTPUT_PATH ${PROJECT_SOURCE_DIR})  

set(LIBRARY_OUTPUT_PATH ${EXECUTABLE_OUTPUT_PATH})

关于调试

调试环境配置

1. 配置调试环境(通过管理配置）

2. vs2017 cmake 通过菜单设置swig.exe启动项之后，还需要一些swig的命令行参数。cmake的命令行参数启动调试可以修改launch.vs.json文件(这个文件的具体用法可以百度)，如

3. 在启动之前可以在适当的位置打断点，入口函数main在swigmain.cxx文件中.

查看基础类型值

在调试中查看string的值

在SWIG中，将String等基础类型抽象成了void*，很不方便调试。我们可以在源码中找到一些方法，来查看void*中具体的值，swig中有一个Swig_to_string的方法可以转为字符串查看，通过监视可以产看

通过控制台输出查看值

调试时如果有错误，会在控制台打印出来，但是如果有错误会直接退出程序导致看不到控制台的及时出错信息，为了调试，可以修改main.cxx的swig_exit函数代码,注释相关退出函数，改为system(“pause”)

void SWIG_exit(int exit_code)
{
	while(freeze)
	{
	}

	if(exit_code > 0)
	{
		CloseAllOpenFiles();

		/* Remove all generated files */
		if(all_output_files)
		{
			for(int i = 0; i < Len(all_output_files); i++)
			{
				String *filename = Getitem(all_output_files, i);
				int removed = remove(Char(filename));

				if(removed == -1)
				{
					fprintf(stderr, "On exit, could not delete file %s: %s\n", Char(filename), strerror(errno));
				}
			}
		}
	}

	//exit(exit_code);
    system("pause");
}