UseSWIG.cmake 10 KB
Newer Older
1 2 3 4 5 6
#.rst:
# UseSWIG
# -------
#
# SWIG module for CMake
#
7
# Defines the following macros:
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
#
# ::
#
#    SWIG_ADD_MODULE(name language [ files ])
#      - Define swig module with given name and specified language
#    SWIG_LINK_LIBRARIES(name [ libraries ])
#      - Link libraries to swig module
#
# All other macros are for internal use only.  To get the actual name of
# the swig module, use: ${SWIG_MODULE_${name}_REAL_NAME}.  Set Source
# files properties such as CPLUSPLUS and SWIG_FLAGS to specify special
# behavior of SWIG.  Also global CMAKE_SWIG_FLAGS can be used to add
# special flags to all swig calls.  Another special variable is
# CMAKE_SWIG_OUTDIR, it allows one to specify where to write all the
# swig generated module (swig -outdir option) 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
26
# set_source_files_properties( ${swig_generated_file_fullname}
27 28 29 30
#
# ::
#
#         PROPERTIES COMPILE_FLAGS "-bla")
31

32

33 34
#=============================================================================
# Copyright 2004-2009 Kitware, Inc.
35
# Copyright 2009 Mathieu Malaterre <mathieu.malaterre@gmail.com>
36 37 38 39 40 41 42 43
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
44
# (To distribute this file outside of CMake, substitute the full
45 46
#  License text for the above reference.)

47 48
set(SWIG_CXX_EXTENSION "cxx")
set(SWIG_EXTRA_LIBRARIES "")
49

50
set(SWIG_PYTHON_EXTRA_FILE_EXTENSION "py")
51 52 53 54

#
# For given swig module initialize variables associated with it
#
55 56 57 58 59 60 61 62 63 64
macro(SWIG_MODULE_INITIALIZE name language)
  string(TOUPPER "${language}" swig_uppercase_language)
  string(TOLOWER "${language}" swig_lowercase_language)
  set(SWIG_MODULE_${name}_LANGUAGE "${swig_uppercase_language}")
  set(SWIG_MODULE_${name}_SWIG_LANGUAGE_FLAG "${swig_lowercase_language}")

  set(SWIG_MODULE_${name}_REAL_NAME "${name}")
  if("${SWIG_MODULE_${name}_LANGUAGE}" STREQUAL "UNKNOWN")
    message(FATAL_ERROR "SWIG Error: Language \"${language}\" not found")
  elseif("${SWIG_MODULE_${name}_LANGUAGE}" STREQUAL "PYTHON")
65
    # when swig is used without the -interface it will produce in the module.py
66
    # a 'import _modulename' statement, which implies having a corresponding
67
    # _modulename.so (*NIX), _modulename.pyd (Win32).
68 69 70 71
    set(SWIG_MODULE_${name}_REAL_NAME "_${name}")
  elseif("${SWIG_MODULE_${name}_LANGUAGE}" STREQUAL "PERL")
    set(SWIG_MODULE_${name}_EXTRA_FLAGS "-shadow")
  endif()
72
endmacro()
73 74 75

#
# For a given language, input file, and output file, determine extra files that
76
# will be generated. This is internal swig macro.
77 78
#

79 80 81
macro(SWIG_GET_EXTRA_OUTPUT_FILES language outfiles generatedpath infile)
  set(${outfiles} "")
  get_source_file_property(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename
Bill Hoffman's avatar
Bill Hoffman committed
82
    ${infile} SWIG_MODULE_NAME)
83 84
  if(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename STREQUAL "NOTFOUND")
    get_filename_component(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename "${infile}" NAME_WE)
85
  endif()
86 87
  foreach(it ${SWIG_${language}_EXTRA_FILE_EXTENSION})
    set(${outfiles} ${${outfiles}}
Bill Hoffman's avatar
Bill Hoffman committed
88
      "${generatedpath}/${SWIG_GET_EXTRA_OUTPUT_FILES_module_basename}.${it}")
89 90
  endforeach()
endmacro()
91 92 93 94

#
# Take swig (*.i) file and add proper custom commands for it
#
95 96 97 98 99 100 101 102 103
macro(SWIG_ADD_SOURCE_TO_MODULE name outfiles infile)
  set(swig_full_infile ${infile})
  get_filename_component(swig_source_file_path "${infile}" PATH)
  get_filename_component(swig_source_file_name_we "${infile}" NAME_WE)
  get_source_file_property(swig_source_file_generated ${infile} GENERATED)
  get_source_file_property(swig_source_file_cplusplus ${infile} CPLUSPLUS)
  get_source_file_property(swig_source_file_flags ${infile} SWIG_FLAGS)
  if("${swig_source_file_flags}" STREQUAL "NOTFOUND")
    set(swig_source_file_flags "")
104
  endif()
105 106 107
  set(swig_source_file_fullname "${infile}")
  if(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_SOURCE_DIR}")
    string(REGEX REPLACE
108 109 110
      "^${CMAKE_CURRENT_SOURCE_DIR}" ""
      swig_source_file_relative_path
      "${swig_source_file_path}")
111
  else()
112 113
    if(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_BINARY_DIR}")
      string(REGEX REPLACE
114 115 116
        "^${CMAKE_CURRENT_BINARY_DIR}" ""
        swig_source_file_relative_path
        "${swig_source_file_path}")
117
      set(swig_source_file_generated 1)
118
    else()
119 120 121
      set(swig_source_file_relative_path "${swig_source_file_path}")
      if(swig_source_file_generated)
        set(swig_source_file_fullname "${CMAKE_CURRENT_BINARY_DIR}/${infile}")
122
      else()
123
        set(swig_source_file_fullname "${CMAKE_CURRENT_SOURCE_DIR}/${infile}")
124 125 126
      endif()
    endif()
  endif()
127 128

  set(swig_generated_file_fullname
129
    "${CMAKE_CURRENT_BINARY_DIR}")
130 131
  if(swig_source_file_relative_path)
    set(swig_generated_file_fullname
132
      "${swig_generated_file_fullname}/${swig_source_file_relative_path}")
133
  endif()
Ken Martin's avatar
Ken Martin committed
134
  # If CMAKE_SWIG_OUTDIR was specified then pass it to -outdir
135 136
  if(CMAKE_SWIG_OUTDIR)
    set(swig_outdir ${CMAKE_SWIG_OUTDIR})
137
  else()
138
    set(swig_outdir ${CMAKE_CURRENT_BINARY_DIR})
139
  endif()
140 141
  SWIG_GET_EXTRA_OUTPUT_FILES(${SWIG_MODULE_${name}_LANGUAGE}
    swig_extra_generated_files
Ken Martin's avatar
Ken Martin committed
142
    "${swig_outdir}"
Bill Hoffman's avatar
Bill Hoffman committed
143
    "${infile}")
144
  set(swig_generated_file_fullname
145
    "${swig_generated_file_fullname}/${swig_source_file_name_we}")
Bill Hoffman's avatar
Bill Hoffman committed
146 147
  # add the language into the name of the file (i.e. TCL_wrap)
  # this allows for the same .i file to be wrapped into different languages
148
  set(swig_generated_file_fullname
Bill Hoffman's avatar
Bill Hoffman committed
149
    "${swig_generated_file_fullname}${SWIG_MODULE_${name}_LANGUAGE}_wrap")
150

151 152
  if(swig_source_file_cplusplus)
    set(swig_generated_file_fullname
153
      "${swig_generated_file_fullname}.${SWIG_CXX_EXTENSION}")
154
  else()
155
    set(swig_generated_file_fullname
156
      "${swig_generated_file_fullname}.c")
157
  endif()
158

159 160 161 162 163 164
  #message("Full path to source file: ${swig_source_file_fullname}")
  #message("Full path to the output file: ${swig_generated_file_fullname}")
  get_directory_property(cmake_include_directories INCLUDE_DIRECTORIES)
  set(swig_include_dirs)
  foreach(it ${cmake_include_directories})
    set(swig_include_dirs ${swig_include_dirs} "-I${it}")
165
  endforeach()
166

167
  set(swig_special_flags)
Bill Hoffman's avatar
Bill Hoffman committed
168
  # default is c, so add c++ flag if it is c++
169 170
  if(swig_source_file_cplusplus)
    set(swig_special_flags ${swig_special_flags} "-c++")
171
  endif()
172 173 174
  set(swig_extra_flags)
  if(SWIG_MODULE_${name}_EXTRA_FLAGS)
    set(swig_extra_flags ${swig_extra_flags} ${SWIG_MODULE_${name}_EXTRA_FLAGS})
175
  endif()
176
  add_custom_command(
Ken Martin's avatar
Ken Martin committed
177
    OUTPUT "${swig_generated_file_fullname}" ${swig_extra_generated_files}
178 179
    # Let's create the ${swig_outdir} at execution time, in case dir contains $(OutDir)
    COMMAND ${CMAKE_COMMAND} -E make_directory ${swig_outdir}
Ken Martin's avatar
Ken Martin committed
180 181 182 183 184 185 186 187 188 189 190 191
    COMMAND "${SWIG_EXECUTABLE}"
    ARGS "-${SWIG_MODULE_${name}_SWIG_LANGUAGE_FLAG}"
    ${swig_source_file_flags}
    ${CMAKE_SWIG_FLAGS}
    -outdir ${swig_outdir}
    ${swig_special_flags}
    ${swig_extra_flags}
    ${swig_include_dirs}
    -o "${swig_generated_file_fullname}"
    "${swig_source_file_fullname}"
    MAIN_DEPENDENCY "${swig_source_file_fullname}"
    DEPENDS ${SWIG_MODULE_${name}_EXTRA_DEPS}
192
    COMMENT "Swig source")
193
  set_source_files_properties("${swig_generated_file_fullname}" ${swig_extra_generated_files}
194
    PROPERTIES GENERATED 1)
195
  set(${outfiles} "${swig_generated_file_fullname}" ${swig_extra_generated_files})
196
endmacro()
197 198 199 200

#
# Create Swig module
#
201
macro(SWIG_ADD_MODULE name language)
202
  SWIG_MODULE_INITIALIZE(${name} ${language})
203 204 205 206 207
  set(swig_dot_i_sources)
  set(swig_other_sources)
  foreach(it ${ARGN})
    if(${it} MATCHES ".*\\.i$")
      set(swig_dot_i_sources ${swig_dot_i_sources} "${it}")
208
    else()
209
      set(swig_other_sources ${swig_other_sources} "${it}")
210 211
    endif()
  endforeach()
212 213 214

  set(swig_generated_sources)
  foreach(it ${swig_dot_i_sources})
215
    SWIG_ADD_SOURCE_TO_MODULE(${name} swig_generated_source ${it})
216
    set(swig_generated_sources ${swig_generated_sources} "${swig_generated_source}")
217
  endforeach()
218 219
  get_directory_property(swig_extra_clean_files ADDITIONAL_MAKE_CLEAN_FILES)
  set_directory_properties(PROPERTIES
Bill Hoffman's avatar
Bill Hoffman committed
220
    ADDITIONAL_MAKE_CLEAN_FILES "${swig_extra_clean_files};${swig_generated_sources}")
221
  add_library(${SWIG_MODULE_${name}_REAL_NAME}
222 223 224
    MODULE
    ${swig_generated_sources}
    ${swig_other_sources})
225 226 227
  string(TOLOWER "${language}" swig_lowercase_language)
  if ("${swig_lowercase_language}" STREQUAL "java")
    if (APPLE)
228 229 230 231 232 233
        # In java you want:
        #      System.loadLibrary("LIBRARY");
        # then JNI will look for a library whose name is platform dependent, namely
        #   MacOS  : libLIBRARY.jnilib
        #   Windows: LIBRARY.dll
        #   Linux  : libLIBRARY.so
234
        set_target_properties (${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES SUFFIX ".jnilib")
235 236
      endif ()
  endif ()
237
  if ("${swig_lowercase_language}" STREQUAL "python")
238
    # this is only needed for the python case where a _modulename.so is generated
239
    set_target_properties(${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES PREFIX "")
240 241 242 243 244 245 246 247
    # Python extension modules on Windows must have the extension ".pyd"
    # instead of ".dll" as of Python 2.5.  Older python versions do support
    # this suffix.
    # http://docs.python.org/whatsnew/ports.html#SECTION0001510000000000000000
    # <quote>
    # Windows: .dll is no longer supported as a filename extension for extension modules.
    # .pyd is now the only filename extension that will be searched for.
    # </quote>
248 249
    if(WIN32 AND NOT CYGWIN)
      set_target_properties(${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES SUFFIX ".pyd")
250 251 252
    endif()
  endif ()
endmacro()
253 254 255 256

#
# Like TARGET_LINK_LIBRARIES but for swig modules
#
257 258 259
macro(SWIG_LINK_LIBRARIES name)
  if(SWIG_MODULE_${name}_REAL_NAME)
    target_link_libraries(${SWIG_MODULE_${name}_REAL_NAME} ${ARGN})
260
  else()
261
    message(SEND_ERROR "Cannot find Swig library \"${name}\".")
262 263
  endif()
endmacro()
264