UseSWIG

Этот файл предоставляет поддержку для 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 не отслеживает зависимости файлов, поэтому для целей, требующих существования swig-сгенерированных файлов, требуется пользовательская цель <name>_swig_compilation . Другие генераторы могут зависеть от исходных файлов, которые будут сгенерированы 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.

OUTPUT_DIR

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

OUTFILE_DIR

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

Свойства целевой библиотеки можно установить, чтобы применить одну и ту же конфигурацию ко всем входным файлам 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

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

Примечание

Когда свойство источника OUTPUT_DIR определено, несколько каталогов могут быть указаны в качестве части 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")