UseSWIG¶
此文件提供对 SWIG 的支持。假定 FindSWIG 模块已加载。
CMake 命令¶
为配合 SWIG 使用，定义了以下命令
- swig_add_library¶
版本 3.8 新增。
使用给定名称和指定语言定义 swig 模块
swig_add_library(<name> [TYPE <SHARED|MODULE|STATIC|USE_BUILD_SHARED_LIBS>] LANGUAGE <language> [NO_PROXY] [OUTPUT_DIR <directory>] [OUTFILE_DIR <directory>] SOURCES <file>... )
使用
swig_add_library命令创建的目标具有与使用add_library()命令创建的目标相同的功能，因此这些目标可与任何需要目标的命令一起使用（例如target_link_libraries()）。3.13 版本中已更改: 当策略
CMP0078设置为NEW时，此命令创建具有指定<name>的目标。否则，旧版行为将选择不同的目标名称并将其存储在SWIG_MODULE_<name>_REAL_NAME变量中。3.15 版本中已更改: 备用库名称（例如，通过
OUTPUT_NAME属性设置）将传递给Python和CSharp包装器库。3.21 版本中已更改: 当策略
CMP0122设置为NEW时，生成的库将使用CSharp语言的标准命名约定。否则，将应用旧版行为。注意
对于多配置生成器，此模块不支持由
SWIG生成的配置特定文件。所有构建配置必须生成相同的源文件。注意
对于 Makefile 生成器，如果某些源的
USE_SWIG_DEPENDENCIES属性为FALSE，则swig_add_library不会跟踪文件依赖项，因此需要依赖<name>_swig_compilation自定义目标，以便目标需要swig生成的文件存在。其他生成器可能依赖于 SWIG 生成的源文件。类型SHARED、MODULE和STATIC具有与add_library()命令相同的语义。如果指定了USE_BUILD_SHARED_LIBS，库类型将根据BUILD_SHARED_LIBS变量的当前值是否为ON而为STATIC或SHARED。如果未指定类型，将使用MODULE。语言指定目标语言。
3.1 版本新增: Go 和 Lua 语言支持。
3.2 版本新增: R 语言支持。
3.18 版本新增: Fortran 语言支持。
无代理3.12 版本新增。
防止生成包装器层（swig
-noproxy选项）。输出目录3.12 版本新增。
指定语言特定文件的写入位置（swig
-outdir选项）。如果未给出，将使用CMAKE_SWIG_OUTDIR变量。如果两者都未指定，默认值取决于UseSWIG_MODULE_VERSION变量的值，如下所示如果
UseSWIG_MODULE_VERSION为 1 或未定义，输出将写入CMAKE_CURRENT_BINARY_DIR目录。如果
UseSWIG_MODULE_VERSION为 2，将使用专用目录。此目录的路径可以从SWIG_SUPPORT_FILES_DIRECTORY目标属性中检索。
输出文件目录3.12 版本新增。
指定生成的源文件将放置的输出目录名称（swig
-o选项）。如果未指定，将使用SWIG_OUTFILE_DIR变量。如果两者都未指定，则使用OUTPUT_DIR或CMAKE_SWIG_OUTDIR。源文件库的源文件列表。扩展名为
.i的文件将被识别为SWIG工具的源文件。其他文件将以标准方式处理。3.14 版本新增: 此行为可以通过指定变量
SWIG_SOURCE_FILE_EXTENSIONS来覆盖。
注意
如果
UseSWIG_MODULE_VERSION设置为 2，则在指定OUTPUT_DIR选项或CMAKE_SWIG_OUTDIR变量时，强烈建议使用目标独有的专用目录。输出目录内容在目标构建时会被擦除，因此为防止目标之间相互干扰或丢失其他重要文件，每个目标都应有自己的专用输出目录。
源文件属性¶
模块文件上的源文件属性必须在调用 swig_add_library 命令之前设置，以指定 SWIG 的特殊行为并确保生成的文件将接收所需的设置。
CPLUSPLUS以 c++ 模式调用 SWIG。例如
set_property(SOURCE mymod.i PROPERTY CPLUSPLUS ON) swig_add_library(mymod LANGUAGE python SOURCES mymod.i)
SWIG_FLAGS3.12 版本中已废弃: 已被后续更细粒度的属性取代。
将自定义标志传递给 SWIG 可执行文件。
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS3.12 版本新增。
向 SWIG 编译器添加自定义标志，并具有与属性
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS相同的语义。USE_TARGET_INCLUDE_DIRECTORIES3.13 版本新增。
如果设置为
TRUE，则目标属性INCLUDE_DIRECTORIES的内容将转发到SWIG编译器。如果设置为FALSE，则目标属性INCLUDE_DIRECTORIES将被忽略。如果未设置，将考虑目标属性SWIG_USE_TARGET_INCLUDE_DIRECTORIES。GENERATED_INCLUDE_DIRECTORIES、GENERATED_COMPILE_DEFINITIONS和GENERATED_COMPILE_OPTIONS3.12 版本新增。
向生成的 C/C++ 源添加自定义标志。它们将分别填充生成的 C/C++ 文件的属性
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS。DEPENDS3.12 版本新增。
指定源文件的附加依赖项。
USE_SWIG_DEPENDENCIES在 3.20 版本中添加。
如果设置为
TRUE，则由swig工具本身生成隐式依赖项。此属性仅对 Makefile、Ninja、Xcode和 Visual Studio 生成器有意义。默认值为FALSE。3.21 版本新增: 添加了对
Xcode生成器的支持。3.22 版本新增: 添加了对 Visual Studio 生成器的支持。
SWIG_MODULE_NAME指定模块在目标语言中的实际导入名称。如果无法从源文件自动扫描或与模块文件基本名称不同，则需要此项。例如
set_property(SOURCE mymod.i PROPERTY SWIG_MODULE_NAME mymod_realname)
3.14 版本中已更改: 如果策略
CMP0086设置为NEW，则-module <module_name>会传递给SWIG编译器。输出目录3.19 版本新增。
为所考虑的源文件指定语言特定文件的写入位置（swig
-outdir选项）。如果未指定，将应用定义输出目录的其他方式（参见swig_add_library()命令的OUTPUT_DIR选项）。输出文件目录3.19 版本新增。
为所考虑的源文件指定生成的源文件将放置的输出目录（swig
-o选项）。如果未指定，将使用OUTPUT_DIR源属性。如果两者都未指定，则应用定义输出文件目录的其他方式（参见swig_add_library()命令的OUTFILE_DIR选项）。
目标属性¶
可以设置目标库属性以将相同的配置应用于所有 SWIG 输入文件。
SWIG_INCLUDE_DIRECTORIES、SWIG_COMPILE_DEFINITIONS和SWIG_COMPILE_OPTIONS3.12 版本新增。
这些属性将应用于所有 SWIG 输入文件，并与目标属性
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS具有相同的语义。set (UseSWIG_TARGET_NAME_PREFERENCE STANDARD) swig_add_library(mymod LANGUAGE python SOURCES mymod.i) set_property(TARGET mymod PROPERTY SWIG_COMPILE_DEFINITIONS MY_DEF1 MY_DEF2) set_property(TARGET mymod PROPERTY SWIG_COMPILE_OPTIONS -bla -blb)
SWIG_USE_TARGET_INCLUDE_DIRECTORIES3.13 版本新增。
如果设置为
TRUE，则目标属性INCLUDE_DIRECTORIES的内容将转发到SWIG编译器。如果设置为FALSE或未定义，则目标属性INCLUDE_DIRECTORIES将被忽略。此行为可以通过指定源属性USE_TARGET_INCLUDE_DIRECTORIES来覆盖。SWIG_GENERATED_INCLUDE_DIRECTORIES、SWIG_GENERATED_COMPILE_DEFINITIONS和SWIG_GENERATED_COMPILE_OPTIONS3.12 版本新增。
这些属性将分别填充所有生成的 C/C++ 文件的属性
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_FLAGS。SWIG_DEPENDS3.12 版本新增。
向所有 SWIG 输入文件添加依赖项。
只读目标属性¶
以下目标属性是输出属性，可用于获取 SWIG 接口编译生成的支持文件信息。
SWIG_SUPPORT_FILES3.12 版本新增。
此输出属性列出了 SWIG 编译期间生成的包装器文件。
set (UseSWIG_TARGET_NAME_PREFERENCE STANDARD) swig_add_library(mymod LANGUAGE python SOURCES mymod.i) get_property(support_files TARGET mymod PROPERTY SWIG_SUPPORT_FILES)
注意
仅列出最主要的支持文件。如果使用了
SWIG的一些高级功能（例如%template），则关联的支持文件可能不会被列出。建议使用SWIG_SUPPORT_FILES_DIRECTORY属性来处理支持文件。SWIG_SUPPORT_FILES_DIRECTORY3.12 版本新增。
此输出属性指定将生成支持文件的目录。
注意
当定义了源属性
OUTPUT_DIR时，可以在SWIG_SUPPORT_FILES_DIRECTORY中指定多个目录。
CMake 变量¶
可以设置一些变量来自定义 swig_add_library 以及 SWIG 的行为
UseSWIG_MODULE_VERSION3.12 版本新增。
为
UseSWIG模块指定不同的行为。设置为 1 或未定义：应用旧版行为。
设置为 2：针对支持文件应用新策略：在
SWIG接口编译之前，支持文件的输出目录将被擦除。
CMAKE_SWIG_FLAGS向所有 swig 调用添加标志。
CMAKE_SWIG_OUTDIR指定语言特定文件的写入位置（swig
-outdir选项）。SWIG_OUTFILE_DIR版本 3.8 新增。
指定生成的源文件将放置的输出目录名称。如果未指定，将使用
CMAKE_SWIG_OUTDIR。SWIG_MODULE_<name>_EXTRA_DEPS为生成的模块
<name>指定额外的依赖项。SWIG_SOURCE_FILE_EXTENSIONS3.14 版新增。
指定源文件扩展名列表以覆盖仅将
.i文件视为SWIG工具源文件的默认行为。例如set(SWIG_SOURCE_FILE_EXTENSIONS ".i" ".swg")
SWIG_USE_SWIG_DEPENDENCIES在 3.20 版本中添加。
如果设置为
TRUE，则由swig工具本身生成隐式依赖项。此变量仅对 Makefile、Ninja、Xcode和 Visual Studio 生成器有意义。默认值为FALSE。源文件属性
USE_SWIG_DEPENDENCIES，如果未定义，将使用此变量的值进行初始化。3.21 版本新增: 添加了对
Xcode生成器的支持。3.22 版本新增: 添加了对 Visual Studio 生成器的支持。
已废弃命令¶
- swig_link_libraries¶
3.13 版本中已废弃: 对于标准目标名称，或对于旧版目标命名，使用
target_link_libraries()或${SWIG_MODULE_<name>_REAL_NAME}。将库链接到 swig 模块
swig_link_libraries(<name> <item>...)
此命令与
target_link_libraries()命令具有相同的功能。注意
当策略
CMP0078设置为NEW时，swig_add_library()会创建具有指定<name>的标准目标，并且必须使用target_link_libraries()而不是此命令。在旧版行为下（当
CMP0078设置为OLD且变量UseSWIG_TARGET_NAME_PREFERENCE设置为"LEGACY"，或在 3.12 之前的 CMake 版本中），最好使用target_link_libraries(${SWIG_MODULE_<name>_REAL_NAME} ...)而不是此命令。