FindPythonLibs.cmake 11.1 KB
Newer Older
1
# - Find python libraries
Ken Martin's avatar
Ken Martin committed
2
3
4
5
# This module finds if Python is installed and determines where the
# include files and libraries are. It also determines what the name of
# the library is. This code sets the following variables:
#
6
7
8
9
#  PYTHONLIBS_FOUND           - have the Python libs been found
#  PYTHON_LIBRARIES           - path to the python library
#  PYTHON_INCLUDE_PATH        - path to where Python.h is found (deprecated)
#  PYTHON_INCLUDE_DIRS        - path to where Python.h is found
10
#  PYTHON_DEBUG_LIBRARIES     - path to the debug library (deprecated)
11
#  PYTHONLIBS_VERSION_STRING  - version of the Python libs found (since CMake 2.8.8)
12
13
14
15
#
# The Python_ADDITIONAL_VERSIONS variable can be used to specify a list of
# version numbers that should be taken into account when searching for Python.
# You need to set this variable before calling find_package(PythonLibs).
Ken Martin's avatar
Ken Martin committed
16

17
18
19
20
21
22
23
24
25
26
#=============================================================================
# Copyright 2001-2009 Kitware, Inc.
#
# 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.
#=============================================================================
27
# (To distribute this file outside of CMake, substitute the full
28
29
#  License text for the above reference.)

30
INCLUDE(CMakeFindFrameworks)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
31
32
33
# Search for the python framework on Apple.
CMAKE_FIND_FRAMEWORKS(Python)

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
SET(_PYTHON1_VERSIONS 1.6 1.5)
SET(_PYTHON2_VERSIONS 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0)
SET(_PYTHON3_VERSIONS 3.3 3.2 3.1 3.0)

IF(PythonLibs_FIND_VERSION)
    IF(PythonLibs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
        STRING(REGEX REPLACE "^([0-9]+\\.[0-9]+).*" "\\1" _PYTHON_FIND_MAJ_MIN "${PythonLibs_FIND_VERSION}")
        STRING(REGEX REPLACE "^([0-9]+).*" "\\1" _PYTHON_FIND_MAJ "${_PYTHON_FIND_MAJ_MIN}")
        UNSET(_PYTHON_FIND_OTHER_VERSIONS)
        IF(NOT PythonLibs_FIND_VERSION_EXACT)
            FOREACH(_PYTHON_V ${_PYTHON${_PYTHON_FIND_MAJ}_VERSIONS})
                IF(NOT _PYTHON_V VERSION_LESS _PYTHON_FIND_MAJ_MIN)
                    LIST(APPEND _PYTHON_FIND_OTHER_VERSIONS ${_PYTHON_V})
                ENDIF()
             ENDFOREACH()
        ENDIF(NOT PythonLibs_FIND_VERSION_EXACT)
        UNSET(_PYTHON_FIND_MAJ_MIN)
        UNSET(_PYTHON_FIND_MAJ)
    ELSE(PythonLibs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
        SET(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON${PythonLibs_FIND_VERSION}_VERSIONS})
    ENDIF(PythonLibs_FIND_VERSION MATCHES "^[0-9]+\\.[0-9]+(\\.[0-9]+.*)?$")
ELSE(PythonLibs_FIND_VERSION)
    SET(_PYTHON_FIND_OTHER_VERSIONS ${_PYTHON3_VERSIONS} ${_PYTHON2_VERSIONS} ${_PYTHON1_VERSIONS})
ENDIF(PythonLibs_FIND_VERSION)

59
60
# Set up the versions we know about, in the order we will search. Always add
# the user supplied additional versions to the front.
61
SET(_Python_VERSIONS
62
  ${Python_ADDITIONAL_VERSIONS}
63
64
65
66
67
68
69
  ${_PYTHON_FIND_OTHER_VERSIONS}
  )

UNSET(_PYTHON_FIND_OTHER_VERSIONS)
UNSET(_PYTHON1_VERSIONS)
UNSET(_PYTHON2_VERSIONS)
UNSET(_PYTHON3_VERSIONS)
70
71

FOREACH(_CURRENT_VERSION ${_Python_VERSIONS})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
72
73
74
75
76
77
  STRING(REPLACE "." "" _CURRENT_VERSION_NO_DOTS ${_CURRENT_VERSION})
  IF(WIN32)
    FIND_LIBRARY(PYTHON_DEBUG_LIBRARY
      NAMES python${_CURRENT_VERSION_NO_DOTS}_d python
      PATHS
      [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug
78
79
80
81
      [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs/Debug
      [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
      [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
      )
Alexander Neundorf's avatar
   
Alexander Neundorf committed
82
  ENDIF(WIN32)
83

Alexander Neundorf's avatar
   
Alexander Neundorf committed
84
  FIND_LIBRARY(PYTHON_LIBRARY
85
86
87
88
89
90
    NAMES
    python${_CURRENT_VERSION_NO_DOTS}
    python${_CURRENT_VERSION}mu
    python${_CURRENT_VERSION}m
    python${_CURRENT_VERSION}u
    python${_CURRENT_VERSION}
91
    PATHS
Alexander Neundorf's avatar
   
Alexander Neundorf committed
92
      [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
93
      [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/libs
Alexander Neundorf's avatar
   
Alexander Neundorf committed
94
95
    # Avoid finding the .dll in the PATH.  We want the .lib.
    NO_SYSTEM_ENVIRONMENT_PATH
96
  )
97
98
99
100
101
102
103
104
  # Look for the static library in the Python config directory
  FIND_LIBRARY(PYTHON_LIBRARY
    NAMES python${_CURRENT_VERSION_NO_DOTS} python${_CURRENT_VERSION}
    # Avoid finding the .dll in the PATH.  We want the .lib.
    NO_SYSTEM_ENVIRONMENT_PATH
    # This is where the static library is usually located
    PATH_SUFFIXES python${_CURRENT_VERSION}/config
  )
105

106
  # For backward compatibility, honour value of PYTHON_INCLUDE_PATH, if
107
108
109
110
111
112
  # PYTHON_INCLUDE_DIR is not set.
  IF(DEFINED PYTHON_INCLUDE_PATH AND NOT DEFINED PYTHON_INCLUDE_DIR)
    SET(PYTHON_INCLUDE_DIR "${PYTHON_INCLUDE_PATH}" CACHE PATH
      "Path to where Python.h is found" FORCE)
  ENDIF(DEFINED PYTHON_INCLUDE_PATH AND NOT DEFINED PYTHON_INCLUDE_DIR)

Alexander Neundorf's avatar
   
Alexander Neundorf committed
113
  SET(PYTHON_FRAMEWORK_INCLUDES)
114
  IF(Python_FRAMEWORKS AND NOT PYTHON_INCLUDE_DIR)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
115
116
117
118
    FOREACH(dir ${Python_FRAMEWORKS})
      SET(PYTHON_FRAMEWORK_INCLUDES ${PYTHON_FRAMEWORK_INCLUDES}
        ${dir}/Versions/${_CURRENT_VERSION}/include/python${_CURRENT_VERSION})
    ENDFOREACH(dir)
119
  ENDIF(Python_FRAMEWORKS AND NOT PYTHON_INCLUDE_DIR)
Ken Martin's avatar
Ken Martin committed
120

121
  FIND_PATH(PYTHON_INCLUDE_DIR
Alexander Neundorf's avatar
   
Alexander Neundorf committed
122
123
124
125
    NAMES Python.h
    PATHS
      ${PYTHON_FRAMEWORK_INCLUDES}
      [HKEY_LOCAL_MACHINE\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include
126
      [HKEY_CURRENT_USER\\SOFTWARE\\Python\\PythonCore\\${_CURRENT_VERSION}\\InstallPath]/include
Alexander Neundorf's avatar
   
Alexander Neundorf committed
127
    PATH_SUFFIXES
128
129
130
      python${_CURRENT_VERSION}mu
      python${_CURRENT_VERSION}m
      python${_CURRENT_VERSION}u
Alexander Neundorf's avatar
   
Alexander Neundorf committed
131
      python${_CURRENT_VERSION}
132
  )
133

134
135
  # For backward compatibility, set PYTHON_INCLUDE_PATH.
  SET(PYTHON_INCLUDE_PATH "${PYTHON_INCLUDE_DIR}")
136

137
138
139
140
141
142
143
  IF(PYTHON_INCLUDE_DIR AND EXISTS "${PYTHON_INCLUDE_DIR}/patchlevel.h")
    FILE(STRINGS "${PYTHON_INCLUDE_DIR}/patchlevel.h" python_version_str
         REGEX "^#define[ \t]+PY_VERSION[ \t]+\"[^\"]+\"")
    STRING(REGEX REPLACE "^#define[ \t]+PY_VERSION[ \t]+\"([^\"]+)\".*" "\\1"
                         PYTHONLIBS_VERSION_STRING "${python_version_str}")
    UNSET(python_version_str)
  ENDIF(PYTHON_INCLUDE_DIR AND EXISTS "${PYTHON_INCLUDE_DIR}/patchlevel.h")
144
145
146
147

  IF(PYTHON_LIBRARY AND PYTHON_INCLUDE_DIR)
    BREAK()
  ENDIF(PYTHON_LIBRARY AND PYTHON_INCLUDE_DIR)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
148
149
150
151
152
ENDFOREACH(_CURRENT_VERSION)

MARK_AS_ADVANCED(
  PYTHON_DEBUG_LIBRARY
  PYTHON_LIBRARY
153
  PYTHON_INCLUDE_DIR
Alexander Neundorf's avatar
   
Alexander Neundorf committed
154
)
155

156
157
158
# We use PYTHON_INCLUDE_DIR, PYTHON_LIBRARY and PYTHON_DEBUG_LIBRARY for the
# cache entries because they are meant to specify the location of a single
# library. We now set the variables listed by the documentation for this
159
# module.
160
SET(PYTHON_INCLUDE_DIRS "${PYTHON_INCLUDE_DIR}")
161
SET(PYTHON_DEBUG_LIBRARIES "${PYTHON_DEBUG_LIBRARY}")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
162

163
164
165
166
167
168
169
170
171
172
# These variables have been historically named in this module different from
# what SELECT_LIBRARY_CONFIGURATIONS() expects.
SET(PYTHON_LIBRARY_DEBUG "${PYTHON_DEBUG_LIBRARY}")
SET(PYTHON_LIBRARY_RELEASE "${PYTHON_LIBRARY}")
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/SelectLibraryConfigurations.cmake)
SELECT_LIBRARY_CONFIGURATIONS(PYTHON)
# SELECT_LIBRARY_CONFIGURATIONS() sets ${PREFIX}_FOUND if it has a library.
# Unset this, this prefix doesn't match the module prefix, they are different
# for historical reasons.
UNSET(PYTHON_FOUND)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
173

174
INCLUDE(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
175
176
177
FIND_PACKAGE_HANDLE_STANDARD_ARGS(PythonLibs
                                  REQUIRED_VARS PYTHON_LIBRARIES PYTHON_INCLUDE_DIRS
                                  VERSION_VAR PYTHONLIBS_VERSION_STRING)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
178

179
# PYTHON_ADD_MODULE(<name> src1 src2 ... srcN) is used to build modules for python.
180
# PYTHON_WRITE_MODULES_HEADER(<filename>) writes a header file you can include
181
182
# in your sources to initialize the static python modules
FUNCTION(PYTHON_ADD_MODULE _NAME )
183
184
  GET_PROPERTY(_TARGET_SUPPORTS_SHARED_LIBS
    GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
185
  OPTION(PYTHON_ENABLE_MODULE_${_NAME} "Add module ${_NAME}" TRUE)
186
187
188
189
190
191
  OPTION(PYTHON_MODULE_${_NAME}_BUILD_SHARED
    "Add module ${_NAME} shared" ${_TARGET_SUPPORTS_SHARED_LIBS})

  # Mark these options as advanced
  MARK_AS_ADVANCED(PYTHON_ENABLE_MODULE_${_NAME}
    PYTHON_MODULE_${_NAME}_BUILD_SHARED)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
192
193

  IF(PYTHON_ENABLE_MODULE_${_NAME})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
194
    IF(PYTHON_MODULE_${_NAME}_BUILD_SHARED)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
195
      SET(PY_MODULE_TYPE MODULE)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
196
    ELSE(PYTHON_MODULE_${_NAME}_BUILD_SHARED)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
197
      SET(PY_MODULE_TYPE STATIC)
198
      SET_PROPERTY(GLOBAL  APPEND  PROPERTY  PY_STATIC_MODULES_LIST ${_NAME})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
199
    ENDIF(PYTHON_MODULE_${_NAME}_BUILD_SHARED)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
200

201
    SET_PROPERTY(GLOBAL  APPEND  PROPERTY  PY_MODULES_LIST ${_NAME})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
202
    ADD_LIBRARY(${_NAME} ${PY_MODULE_TYPE} ${ARGN})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
203
#    TARGET_LINK_LIBRARIES(${_NAME} ${PYTHON_LIBRARIES})
204

205
206
207
208
209
210
211
    IF(PYTHON_MODULE_${_NAME}_BUILD_SHARED)
      SET_TARGET_PROPERTIES(${_NAME} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}")
      IF(WIN32 AND NOT CYGWIN)
        SET_TARGET_PROPERTIES(${_NAME} PROPERTIES SUFFIX ".pyd")
      ENDIF(WIN32 AND NOT CYGWIN)
    ENDIF(PYTHON_MODULE_${_NAME}_BUILD_SHARED)

Alexander Neundorf's avatar
   
Alexander Neundorf committed
212
  ENDIF(PYTHON_ENABLE_MODULE_${_NAME})
213
214
215
216
217
ENDFUNCTION(PYTHON_ADD_MODULE)

FUNCTION(PYTHON_WRITE_MODULES_HEADER _filename)

  GET_PROPERTY(PY_STATIC_MODULES_LIST  GLOBAL  PROPERTY PY_STATIC_MODULES_LIST)
Alexander Neundorf's avatar
   
Alexander Neundorf committed
218
219
220

  GET_FILENAME_COMPONENT(_name "${_filename}" NAME)
  STRING(REPLACE "." "_" _name "${_name}")
221
  STRING(TOUPPER ${_name} _nameUpper)
222
  SET(_filename ${CMAKE_CURRENT_BINARY_DIR}/${_filename})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
223
224
225

  SET(_filenameTmp "${_filename}.in")
  FILE(WRITE ${_filenameTmp} "/*Created by cmake, do not edit, changes will be lost*/\n")
226
  FILE(APPEND ${_filenameTmp}
227
228
"#ifndef ${_nameUpper}
#define ${_nameUpper}
Alexander Neundorf's avatar
   
Alexander Neundorf committed
229
230
231
232
233
234
235
236

#include <Python.h>

#ifdef __cplusplus
extern \"C\" {
#endif /* __cplusplus */

")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
237

Alexander Neundorf's avatar
   
Alexander Neundorf committed
238
  FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
239
    FILE(APPEND ${_filenameTmp} "extern void init${PYTHON_MODULE_PREFIX}${_currentModule}(void);\n\n")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
240
  ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
241

242
  FILE(APPEND ${_filenameTmp}
Alexander Neundorf's avatar
   
Alexander Neundorf committed
243
244
245
246
247
248
249
"#ifdef __cplusplus
}
#endif /* __cplusplus */

")


Alexander Neundorf's avatar
   
Alexander Neundorf committed
250
  FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
251
    FILE(APPEND ${_filenameTmp} "int ${_name}_${_currentModule}(void) \n{\n  static char name[]=\"${PYTHON_MODULE_PREFIX}${_currentModule}\"; return PyImport_AppendInittab(name, init${PYTHON_MODULE_PREFIX}${_currentModule});\n}\n\n")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
252
  ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
Alexander Neundorf's avatar
   
Alexander Neundorf committed
253

254
  FILE(APPEND ${_filenameTmp} "void ${_name}_LoadAllPythonModules(void)\n{\n")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
255
  FOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
256
    FILE(APPEND ${_filenameTmp} "  ${_name}_${_currentModule}();\n")
Alexander Neundorf's avatar
   
Alexander Neundorf committed
257
  ENDFOREACH(_currentModule ${PY_STATIC_MODULES_LIST})
258
259
  FILE(APPEND ${_filenameTmp} "}\n\n")
  FILE(APPEND ${_filenameTmp} "#ifndef EXCLUDE_LOAD_ALL_FUNCTION\nvoid CMakeLoadAllPythonModules(void)\n{\n  ${_name}_LoadAllPythonModules();\n}\n#endif\n\n#endif\n")
260

Alexander Neundorf's avatar
   
Alexander Neundorf committed
261
262
263
# with CONFIGURE_FILE() cmake complains that you may not use a file created using FILE(WRITE) as input file for CONFIGURE_FILE()
  EXECUTE_PROCESS(COMMAND ${CMAKE_COMMAND} -E copy_if_different "${_filenameTmp}" "${_filename}" OUTPUT_QUIET ERROR_QUIET)

264
ENDFUNCTION(PYTHON_WRITE_MODULES_HEADER)