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 语言支持。
NO_PROXY3.12 版中新增。
阻止生成包装层（swig
-noproxy选项）。OUTPUT_DIR3.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目标属性中检索。
OUTFILE_DIR3.12 版中新增。
指定一个输出目录名称，将会将生成的源文件放入该目录（swig
-o选项）。如果未指定，将使用SWIG_OUTFILE_DIR变量。如果两者都没有指定，则将使用OUTPUT_DIR或CMAKE_SWIG_OUTDIR。SOURCES库的源文件列表。带有扩展名
.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_FLAGS自版本 3.12 起已弃用：已替换为以下精细的属性。
将自定义标志传递给 SWIG 可执行文件。
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS3.12 版中新增。
向 SWIG 编译器添加自定义标志，具有与其属性
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS相同的语义。USE_TARGET_INCLUDE_DIRECTORIES已在版本 3.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++ 源代码添加自定义标志。它们分别会填充
INCLUDE_DIRECTORIES、COMPILE_DEFINITIONS和COMPILE_OPTIONS属性生成的 C/C++ 文件。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编译器。OUTPUT_DIR在第 3.19 版中添加。
指定针对所考虑的源文件编写特定语言的文件（swig
-outdir选项）的位置。如果没有指定，则应用定义输出目录的其他方式（请参阅swig_add_library()命令的OUTPUT_DIR选项）。OUTFILE_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_DIRECTORIES已在版本 3.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_EXTENSIONS在 3.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} ...)来代替此命令。