mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-04-25 15:49:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'UseSWIG-doc-clarify'

Browse Source 
b844a414 UseSWIG: Clarify documentation of SWIG_OUTFILE_DIR
315b0927 UseSWIG: Improve documentation markup
ce130c7a UseSWIG: Convert docs to a bracket comment

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1733
This commit is contained in:
Brad King
2018-02-01 13:04:10 +00:00
committed by Kitware Robot
parent f04cc45850 b844a414c7
commit 3ffc9b99bb
1 changed files with 64 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/UseSWIG.cmake
+64 -52
View File
@@ -1,58 +1,70 @@
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
#.rst:
# UseSWIG
# -------
#
# Defines the following macros for use with SWIG:
#
# ::
#
# SWIG_ADD_LIBRARY(<name>
# [TYPE <SHARED|MODULE|STATIC|USE_BUILD_SHARED_LIBS>]
# LANGUAGE <language>
# SOURCES <file>...
# )
# - Define swig module with given name and specified language
# SWIG_LINK_LIBRARIES(name [ libraries ])
# - Link libraries to swig module
#
# Source files properties on module files can be set before the invocation
# of the SWIG_ADD_LIBRARY macro to specify special behavior of SWIG.
#
# The source file property CPLUSPLUS calls SWIG in c++ mode, e.g.::
#
# set_property(SOURCE mymod.i PROPERTY CPLUSPLUS ON)
# swig_add_library(mymod LANGUAGE python SOURCES mymod.i)
#
# The source file property SWIG_FLAGS adds custom flags to the SWIG executable.
#
# The source-file property SWIG_MODULE_NAME have to be provided to specify the actual
# import name of the module in the target language if it cannot be scanned automatically
# from source or different from the module file basename.::
#
# set_property(SOURCE mymod.i PROPERTY SWIG_MODULE_NAME mymod_realname)
#
# To get the name of the swig module target library, use: ${SWIG_MODULE_${name}_REAL_NAME}.
#
# Also some variables can be set to specify special behavior of SWIG.
#
# CMAKE_SWIG_FLAGS can be used to add special flags to all swig calls.
#
# CMAKE_SWIG_OUTDIR allows one to specify where to write
# the language specific files (swig -outdir option).
#
# SWIG_OUTFILE_DIR allows one to specify where to write the output file
# (swig -o option). If not specified, CMAKE_SWIG_OUTDIR is used.
#
# The name-specific variable SWIG_MODULE_<name>_EXTRA_DEPS may be used to specify extra
# dependencies for the generated modules.
#
# If the source file generated by swig need some special flag you can use::
#
# set_source_files_properties( ${swig_generated_file_fullname}
# PROPERTIES COMPILE_FLAGS "-bla")
#[=======================================================================[.rst:
UseSWIG
-------
Defines the following macros for use with SWIG:
.. command:: swig_add_library
Define swig module with given name and specified language::
swig_add_library(<name>
[TYPE <SHARED|MODULE|STATIC|USE_BUILD_SHARED_LIBS>]
LANGUAGE <language>
SOURCES <file>...
)
The variable ``SWIG_MODULE_<name>_REAL_NAME`` will be set to the name
of the swig module target library.
.. command:: swig_link_libraries
Link libraries to swig module::
swig_link_libraries(<name> [ libraries ])
Source file properties on module files can be set before the invocation
of the ``swig_add_library`` macro to specify special behavior of SWIG:
``CPLUSPLUS``
Call SWIG in c++ mode. For example:
.. code-block:: cmake
set_property(SOURCE mymod.i PROPERTY CPLUSPLUS ON)
swig_add_library(mymod LANGUAGE python SOURCES mymod.i)
``SWIG_FLAGS``
Add custom flags to the SWIG executable.
``SWIG_MODULE_NAME``
Specify the actual import name of the module in the target language.
This is required if it cannot be scanned automatically from source
or different from the module file basename. For example:
.. code-block:: cmake
set_property(SOURCE mymod.i PROPERTY SWIG_MODULE_NAME mymod_realname)
Some variables can be set to specify special behavior of SWIG:
``CMAKE_SWIG_FLAGS``
Add flags to all swig calls.
``CMAKE_SWIG_OUTDIR``
Specify where to write the language specific files (swig ``-outdir`` option).
``SWIG_OUTFILE_DIR``
Specify an output directory name where the generated source file will be
placed. If not specified, ``CMAKE_SWIG_OUTDIR`` is used.
``SWIG_MODULE_<name>_EXTRA_DEPS``
Specify extra dependencies for the generated module for ``<name>``.
#]=======================================================================]
set(SWIG_CXX_EXTENSION "cxx")
set(SWIG_EXTRA_LIBRARIES "")