UseSWIG

Этот файл предоставляет поддержку для SWIG. Предполагается, что модуль FindSWIG уже загружен.

Определяет следующую команду для использования с 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: Эта команда создаёт целевой объект со специфицированным <name> , когда политика CMP0078 установлена в значение NEW. В противном случае, поведение по умолчанию выберет другое имя целевого объекта и сохранит его в переменной SWIG_MODULE_<name>_REAL_NAME.

Изменено в версии 3.15: Альтернативное имя библиотеки (установленное с помощью свойства OUTPUT_NAME, например) будет передано в Python и CSharp библиотеки оболочки.

Изменено в версии 3.21: Сгенерированная библиотека использует стандартные соглашения об именовании для CSharp языка, когда политика CMP0122 установлена в значение NEW. В противном случае применяется поведение по умолчанию.

Примечание

Для генераторов с несколькими конфигурациями этот модуль не поддерживает файлы конфигурации, специфичные для конфигурации, сгенерированные SWIG. Все конфигурации сборки должны привести к одному и тому же сгенерированному исходному файлу.

Примечание

Для генераторов Makefile Generators, если для некоторых исходных файлов свойство USE_SWIG_DEPENDENCIES имеет значение FALSE, swig_add_library не отслеживает зависимости файлов, поэтому для целей, которые требуют существования файлов, сгенерированных <name>_swig_compilation, требуется пользовательский целевой объект swig. Другие генераторы могут зависеть от исходных файлов, которые будут сгенерированы SWIG.

TYPE

SHARED, MODULE и STATIC имеют такое же семантическое значение, как и для команды add_library(). Если указан USE_BUILD_SHARED_LIBS, тип библиотеки будет STATIC или SHARED в зависимости от того, равно ли текущее значение переменной BUILD_SHARED_LIBS ON. Если тип не указан, будет использоваться MODULE.

LANGUAGE

Укажите целевой язык.

Новая в версии 3.1: Поддержка языков Go и Lua.

Новая в версии 3.2: Поддержка языка R.

Новая в версии 3.18: Поддержка языка Fortran.

NO_PROXY

Новая в версии 3.12.

Предотвратить генерацию слоя оболочки (опция swig -noproxy).

OUTPUT_DIR

Новая в версии 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.

OUTFILE_DIR

Новая в версии 3.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_link_libraries

Связать библиотеки с модулем swig:

swig_link_libraries(<name> <item>...)

Эта команда имеет те же возможности, что и команда target_link_libraries().

Примечание

Если переменная UseSWIG_TARGET_NAME_PREFERENCE установлена в STANDARD, эта команда устарела и вместо неё необходимо использовать команду target_link_libraries().

Свойства исходных файлов для файлов модуля должны быть установлены до вызова команды swig_add_library для указания специального поведения SWIG и обеспечения того, чтобы сгенерированные файлы получали необходимые настройки.

CPLUSPLUS

Вызов SWIG в режиме c++. Например:

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 and COMPILE_OPTIONS

Новое в версии 3.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 and GENERATED_COMPILE_OPTIONS

Новое в версии 3.12.

Добавление пользовательских флагов к сгенерированному исходному коду C/C++. Они будут, соответственно, заполнять свойства INCLUDE_DIRECTORIES, COMPILE_DEFINITIONS и COMPILE_OPTIONS сгенерированного файла C/C++.

DEPENDS

Новое в версии 3.12.

Указание дополнительных зависимостей от исходного файла.

USE_SWIG_DEPENDENCIES

Новое в версии 3.20.

Если установлено в значение TRUE, неявные зависимости генерируются самим инструментом swig. Это свойство имеет смысл только для генераторов Makefile, Ninja и Xcode. Значение по умолчанию — FALSE.

Новое в версии 3.21: Добавлена поддержка генератора Xcode.

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 ) для рассматриваемого исходного файла. Если не указано, применяются другие способы определения выходного каталога (см. опцию OUTPUT_DIR команды swig_add_library()).

OUTFILE_DIR

Новое в версии 3.19.

Указание выходного каталога, куда будет помещён сгенерированный исходный файл (опция swig -o ) для рассматриваемого исходного файла. Если не указано, используется свойство источника OUTPUT_DIR. Если ни то, ни другое не указано, применяются другие способы определения каталога выходного файла (см. опцию OUTFILE_DIR команды swig_add_library()).

Свойства целевой библиотеки могут быть установлены для применения той же конфигурации ко всем входным файлам SWIG.

SWIG_INCLUDE_DIRECTORIES, SWIG_COMPILE_DEFINITIONS and SWIG_COMPILE_OPTIONS

Новое в версии 3.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 and SWIG_GENERATED_COMPILE_OPTIONS

Новое в версии 3.12.

Эти свойства будут заполнять, соответственно, свойства INCLUDE_DIRECTORIES, COMPILE_DEFINITIONS и COMPILE_FLAGS всех сгенерированных файлов C/C++.

SWIG_DEPENDS

Новое в версии 3.12.

Добавление зависимостей ко всем входным файлам SWIG.

Следующие свойства целевого объекта являются свойствами вывода и могут быть использованы для получения информации о файлах поддержки, сгенерированных компиляцией интерфейса SWIG.

SWIG_SUPPORT_FILES

Новое в версии 3.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_DIRECTORY

Новое в версии 3.12.

Это свойство вывода указывает каталог, в котором будут сгенерированы файлы поддержки.

Примечание

При определении свойства исходного файла OUTPUT_DIR, в SWIG_SUPPORT_FILES_DIRECTORY могут быть указаны несколько каталогов.

Некоторые переменные могут быть установлены для настройки поведения swig_add_library и SWIG:

UseSWIG_MODULE_VERSION

Новое в версии 3.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. Значение по умолчанию FALSE.

Свойство исходного файла USE_SWIG_DEPENDENCIES, если не определено, будет инициализировано значением этой переменной.

Новое в версии 3.21: Добавлена поддержка генератора Xcode.