Использование SWIG

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

Определяет следующую команду для использования с SWIG:

swig_add_library

Определение модуля 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()).

Примечание

Эта команда создаёт цель со специфицированным <name> при использовании политики CMP0078 установленной в значение NEW. В противном случае, старое поведение выберет другое имя цели и сохранит его в переменной SWIG_MODULE_<name>_REAL_NAME.

Примечание

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

Примечание

Для генераторов на основе Make, 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

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

NO_PROXY

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

OUTPUT_DIR

Укажите, куда записать файлы, специфичные для языка (опция 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

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

SOURCES

Список исходных файлов для библиотеки. Файлы с расширением .i будут определены как исходные файлы для инструмента SWIG. Другие файлы будут обработаны стандартным образом. Это поведение может быть переопределено с помощью переменной 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)

INCLUDE_DIRECTORIES, COMPILE_DEFINITIONS and COMPILE_OPTIONS

Добавить пользовательские флаги к компилятору SWIG и иметь тот же смысл, что и свойства INCLUDE_DIRECTORIES, COMPILE_DEFINITIONS и COMPILE_OPTIONS.

USE_TARGET_INCLUDE_DIRECTORIES

Если установлено в значение TRUE, содержимое свойства цели INCLUDE_DIRECTORIES будет передано компилятору SWIG. Если установлено в значение FALSE, свойство цели INCLUDE_DIRECTORIES будет проигнорировано. Если не установлено, то будет рассмотрено свойство цели SWIG_USE_TARGET_INCLUDE_DIRECTORIES.

GENERATED_INCLUDE_DIRECTORIES, GENERATED_COMPILE_DEFINITIONS and GENERATED_COMPILE_OPTIONS

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

DEPENDS

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

SWIG_MODULE_NAME

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

set_property(SOURCE mymod.i PROPERTY SWIG_MODULE_NAME mymod_realname)

Примечание

Если политика CMP0086 установлена в NEW, -module <module_name> передаётся компилятору SWIG.

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

SWIG_INCLUDE_DIRECTORIES, SWIG_COMPILE_DEFINITIONS and SWIG_COMPILE_OPTIONS

Эти свойства будут применены ко всем входным файлам 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

Если установлено в TRUE, содержимое свойства цели INCLUDE_DIRECTORIES будет передано компилятору SWIG . Если установлено в FALSE или не определено, свойство цели INCLUDE_DIRECTORIES будет проигнорировано. Это поведение можно переопределить, указав свойство исходного файла USE_TARGET_INCLUDE_DIRECTORIES.

SWIG_GENERATED_INCLUDE_DIRECTORIES, SWIG_GENERATED_COMPILE_DEFINITIONS and SWIG_GENERATED_COMPILE_OPTIONS

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

SWIG_DEPENDS

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

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

SWIG_SUPPORT_FILES

Этот список выходных свойств файлов-оберток, сгенерированных во время компиляции 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

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

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

UseSWIG_MODULE_VERSION

Укажите различные варианты поведения для модуля UseSWIG.

• Установка в 1 или отсутствие значения: применяется устаревшее поведение.
• Установка в 2: применяется новая стратегия по отношению к файлам поддержки: каталог вывода файлов поддержки очищается перед компиляцией интерфейса SWIG.

CMAKE_SWIG_FLAGS

Добавить флаги ко всем вызовам swig.

CMAKE_SWIG_OUTDIR

Укажите место для записи файлов, специфичных для языка (опция swig -outdir).

SWIG_OUTFILE_DIR

Укажите имя каталога вывода, куда будет помещён сгенерированный исходный файл. Если не указано, используется CMAKE_SWIG_OUTDIR.

SWIG_MODULE_<name>_EXTRA_DEPS

Укажите дополнительные зависимости для сгенерированного модуля для <name>.

SWIG_SOURCE_FILE_EXTENSIONS

Укажите список расширений файлов исходных кодов для переопределения стандартного поведения, которое рассматривает только файлы .i в качестве источников для инструмента SWIG. Например:

set(SWIG_SOURCE_FILE_EXTENSIONS ".i" ".swg")