UseSWIG.cmake 10.9 KB
Newer Older
1
# - SWIG module for CMake
2 3 4 5 6 7
# Defines the following macros:
#   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.
8
# To get the actual name of the swig module,
9
# use: ${SWIG_MODULE_${name}_REAL_NAME}.
Ken Martin's avatar
Ken Martin committed
10
# Set Source files properties such as CPLUSPLUS and SWIG_FLAGS to specify
11 12
# special behavior of SWIG. Also global CMAKE_SWIG_FLAGS can be used to add
# special flags to all swig calls.
13
# Another special variable is CMAKE_SWIG_OUTDIR, it allows one to specify
14
# where to write all the swig generated module (swig -outdir option)
15 16
# The name-specific variable SWIG_MODULE_<name>_EXTRA_DEPS may be used
# to specify extra dependencies for the generated modules.
17
# If the source file generated by swig need some special flag you can use
18
# set_source_files_properties( ${swig_generated_file_fullname}
19 20
#        PROPERTIES COMPILE_FLAGS "-bla")

21

22 23
#=============================================================================
# Copyright 2004-2009 Kitware, Inc.
24
# Copyright 2009 Mathieu Malaterre <mathieu.malaterre@gmail.com>
25 26 27 28 29 30 31 32
#
# 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.
#=============================================================================
33
# (To distribute this file outside of CMake, substitute the full
34 35
#  License text for the above reference.)

36 37
set(SWIG_CXX_EXTENSION "cxx")
set(SWIG_EXTRA_LIBRARIES "")
38

39
set(SWIG_PYTHON_EXTRA_FILE_EXTENSION "py")
40 41 42 43

#
# For given swig module initialize variables associated with it
#
44 45 46 47 48 49 50 51 52 53
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")
54
    # when swig is used without the -interface it will produce in the module.py
55
    # a 'import _modulename' statement, which implies having a corresponding
56
    # _modulename.so (*NIX), _modulename.pyd (Win32).
57 58 59 60 61
    set(SWIG_MODULE_${name}_REAL_NAME "_${name}")
  elseif("${SWIG_MODULE_${name}_LANGUAGE}" STREQUAL "PERL")
    set(SWIG_MODULE_${name}_EXTRA_FLAGS "-shadow")
  endif()
endmacro(SWIG_MODULE_INITIALIZE)
62 63 64

#
# For a given language, input file, and output file, determine extra files that
65
# will be generated. This is internal swig macro.
66 67
#

68 69 70
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
71
    ${infile} SWIG_MODULE_NAME)
72 73 74 75 76
  if(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename STREQUAL "NOTFOUND")
    get_filename_component(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename "${infile}" NAME_WE)
  endif(SWIG_GET_EXTRA_OUTPUT_FILES_module_basename STREQUAL "NOTFOUND")
  foreach(it ${SWIG_${language}_EXTRA_FILE_EXTENSION})
    set(${outfiles} ${${outfiles}}
Bill Hoffman's avatar
Bill Hoffman committed
77
      "${generatedpath}/${SWIG_GET_EXTRA_OUTPUT_FILES_module_basename}.${it}")
78 79
  endforeach(it)
endmacro(SWIG_GET_EXTRA_OUTPUT_FILES)
80 81 82 83

#
# Take swig (*.i) file and add proper custom commands for it
#
84 85 86 87 88 89 90 91 92 93 94 95 96
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 "")
  endif("${swig_source_file_flags}" STREQUAL "NOTFOUND")
  set(swig_source_file_fullname "${infile}")
  if(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_SOURCE_DIR}")
    string(REGEX REPLACE
97 98 99
      "^${CMAKE_CURRENT_SOURCE_DIR}" ""
      swig_source_file_relative_path
      "${swig_source_file_path}")
100 101 102
  else(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_SOURCE_DIR}")
    if(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_BINARY_DIR}")
      string(REGEX REPLACE
103 104 105
        "^${CMAKE_CURRENT_BINARY_DIR}" ""
        swig_source_file_relative_path
        "${swig_source_file_path}")
106 107 108 109 110 111 112 113 114 115 116 117
      set(swig_source_file_generated 1)
    else(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_BINARY_DIR}")
      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}")
      else(swig_source_file_generated)
        set(swig_source_file_fullname "${CMAKE_CURRENT_SOURCE_DIR}/${infile}")
      endif(swig_source_file_generated)
    endif(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_BINARY_DIR}")
  endif(${swig_source_file_path} MATCHES "^${CMAKE_CURRENT_SOURCE_DIR}")

  set(swig_generated_file_fullname
118
    "${CMAKE_CURRENT_BINARY_DIR}")
119 120
  if(swig_source_file_relative_path)
    set(swig_generated_file_fullname
121
      "${swig_generated_file_fullname}/${swig_source_file_relative_path}")
122
  endif(swig_source_file_relative_path)
Ken Martin's avatar
Ken Martin committed
123
  # If CMAKE_SWIG_OUTDIR was specified then pass it to -outdir
124 125 126 127 128
  if(CMAKE_SWIG_OUTDIR)
    set(swig_outdir ${CMAKE_SWIG_OUTDIR})
  else(CMAKE_SWIG_OUTDIR)
    set(swig_outdir ${CMAKE_CURRENT_BINARY_DIR})
  endif(CMAKE_SWIG_OUTDIR)
129 130
  SWIG_GET_EXTRA_OUTPUT_FILES(${SWIG_MODULE_${name}_LANGUAGE}
    swig_extra_generated_files
Ken Martin's avatar
Ken Martin committed
131
    "${swig_outdir}"
Bill Hoffman's avatar
Bill Hoffman committed
132
    "${infile}")
133
  set(swig_generated_file_fullname
134
    "${swig_generated_file_fullname}/${swig_source_file_name_we}")
Bill Hoffman's avatar
Bill Hoffman committed
135 136
  # 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
137
  set(swig_generated_file_fullname
Bill Hoffman's avatar
Bill Hoffman committed
138
    "${swig_generated_file_fullname}${SWIG_MODULE_${name}_LANGUAGE}_wrap")
139

140 141
  if(swig_source_file_cplusplus)
    set(swig_generated_file_fullname
142
      "${swig_generated_file_fullname}.${SWIG_CXX_EXTENSION}")
143 144
  else(swig_source_file_cplusplus)
    set(swig_generated_file_fullname
145
      "${swig_generated_file_fullname}.c")
146
  endif(swig_source_file_cplusplus)
147

148 149 150 151 152 153 154
  #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}")
  endforeach(it)
155

156
  set(swig_special_flags)
Bill Hoffman's avatar
Bill Hoffman committed
157
  # default is c, so add c++ flag if it is c++
158 159 160 161 162 163 164 165
  if(swig_source_file_cplusplus)
    set(swig_special_flags ${swig_special_flags} "-c++")
  endif(swig_source_file_cplusplus)
  set(swig_extra_flags)
  if(SWIG_MODULE_${name}_EXTRA_FLAGS)
    set(swig_extra_flags ${swig_extra_flags} ${SWIG_MODULE_${name}_EXTRA_FLAGS})
  endif(SWIG_MODULE_${name}_EXTRA_FLAGS)
  add_custom_command(
Ken Martin's avatar
Ken Martin committed
166
    OUTPUT "${swig_generated_file_fullname}" ${swig_extra_generated_files}
167 168
    # 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
169 170 171 172 173 174 175 176 177 178 179 180
    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}
181
    COMMENT "Swig source")
182
  set_source_files_properties("${swig_generated_file_fullname}" ${swig_extra_generated_files}
183
    PROPERTIES GENERATED 1)
184 185
  set(${outfiles} "${swig_generated_file_fullname}" ${swig_extra_generated_files})
endmacro(SWIG_ADD_SOURCE_TO_MODULE)
186 187 188 189

#
# Create Swig module
#
190
macro(SWIG_ADD_MODULE name language)
191
  SWIG_MODULE_INITIALIZE(${name} ${language})
192 193 194 195 196 197 198 199 200 201 202 203
  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}")
    else(${it} MATCHES ".*\\.i$")
      set(swig_other_sources ${swig_other_sources} "${it}")
    endif(${it} MATCHES ".*\\.i$")
  endforeach(it)

  set(swig_generated_sources)
  foreach(it ${swig_dot_i_sources})
204
    SWIG_ADD_SOURCE_TO_MODULE(${name} swig_generated_source ${it})
205 206 207 208
    set(swig_generated_sources ${swig_generated_sources} "${swig_generated_source}")
  endforeach(it)
  get_directory_property(swig_extra_clean_files ADDITIONAL_MAKE_CLEAN_FILES)
  set_directory_properties(PROPERTIES
Bill Hoffman's avatar
Bill Hoffman committed
209
    ADDITIONAL_MAKE_CLEAN_FILES "${swig_extra_clean_files};${swig_generated_sources}")
210
  add_library(${SWIG_MODULE_${name}_REAL_NAME}
211 212 213
    MODULE
    ${swig_generated_sources}
    ${swig_other_sources})
214 215 216
  string(TOLOWER "${language}" swig_lowercase_language)
  if ("${swig_lowercase_language}" STREQUAL "java")
    if (APPLE)
217 218 219 220 221 222
        # 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
223 224 225 226
        set_target_properties (${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES SUFFIX ".jnilib")
      endif (APPLE)
  endif ("${swig_lowercase_language}" STREQUAL "java")
  if ("${swig_lowercase_language}" STREQUAL "python")
227
    # this is only needed for the python case where a _modulename.so is generated
228
    set_target_properties(${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES PREFIX "")
229 230 231 232 233 234 235 236
    # 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>
237 238 239 240 241
    if(WIN32 AND NOT CYGWIN)
      set_target_properties(${SWIG_MODULE_${name}_REAL_NAME} PROPERTIES SUFFIX ".pyd")
    endif(WIN32 AND NOT CYGWIN)
  endif ("${swig_lowercase_language}" STREQUAL "python")
endmacro(SWIG_ADD_MODULE)
242 243 244 245

#
# Like TARGET_LINK_LIBRARIES but for swig modules
#
246 247 248 249 250 251 252
macro(SWIG_LINK_LIBRARIES name)
  if(SWIG_MODULE_${name}_REAL_NAME)
    target_link_libraries(${SWIG_MODULE_${name}_REAL_NAME} ${ARGN})
  else(SWIG_MODULE_${name}_REAL_NAME)
    message(SEND_ERROR "Cannot find Swig library \"${name}\".")
  endif(SWIG_MODULE_${name}_REAL_NAME)
endmacro(SWIG_LINK_LIBRARIES name)
253