CMakeLists.txt 9.89 KB
Newer Older
Dean Moldovan's avatar
Dean Moldovan committed
1
# CMakeLists.txt -- Build system for the pybind11 modules
Wenzel Jakob's avatar
Wenzel Jakob committed
2
3
4
5
6
7
#
# Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch>
#
# All rights reserved. Use of this source code is governed by a
# BSD-style license that can be found in the LICENSE file.

8
cmake_minimum_required(VERSION 3.4)
Wenzel Jakob's avatar
Wenzel Jakob committed
9

10
# The `cmake_minimum_required(VERSION 3.4...3.18)` syntax does not work with
Henry Schreiner's avatar
Henry Schreiner committed
11
12
# some versions of VS that have a patched CMake 3.11. This forces us to emulate
# the behavior using the following workaround:
13
if(${CMAKE_VERSION} VERSION_LESS 3.18)
Henry Schreiner's avatar
Henry Schreiner committed
14
  cmake_policy(VERSION ${CMAKE_MAJOR_VERSION}.${CMAKE_MINOR_VERSION})
15
else()
Henry Schreiner's avatar
Henry Schreiner committed
16
  cmake_policy(VERSION 3.18)
17
endif()
Wenzel Jakob's avatar
Wenzel Jakob committed
18

19
# Extract project version from source
Henry Schreiner's avatar
Henry Schreiner committed
20
21
file(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/include/pybind11/detail/common.h"
     pybind11_version_defines REGEX "#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) ")
22
23

foreach(ver ${pybind11_version_defines})
Henry Schreiner's avatar
Henry Schreiner committed
24
25
26
  if(ver MATCHES [[#define PYBIND11_VERSION_(MAJOR|MINOR|PATCH) +([^ ]+)$]])
    set(PYBIND11_VERSION_${CMAKE_MATCH_1} "${CMAKE_MATCH_2}")
  endif()
27
28
endforeach()

29
if(PYBIND11_VERSION_PATCH MATCHES [[([a-zA-Z]+)]])
Henry Schreiner's avatar
Henry Schreiner committed
30
  set(pybind11_VERSION_TYPE "${CMAKE_MATCH_1}")
31
32
33
endif()
string(REGEX MATCH "[0-9]+" PYBIND11_VERSION_PATCH "${PYBIND11_VERSION_PATCH}")

34
project(
Henry Schreiner's avatar
Henry Schreiner committed
35
36
37
  pybind11
  LANGUAGES CXX
  VERSION "${PYBIND11_VERSION_MAJOR}.${PYBIND11_VERSION_MINOR}.${PYBIND11_VERSION_PATCH}")
38
39
40
41
42
43

# Standard includes
include(GNUInstallDirs)
include(CMakePackageConfigHelpers)
include(CMakeDependentOption)

44
45
46
if(NOT pybind11_FIND_QUIETLY)
  message(STATUS "pybind11 v${pybind11_VERSION} ${pybind11_VERSION_TYPE}")
endif()
47

48
# Check if pybind11 is being used directly or via add_subdirectory
49
if(CMAKE_SOURCE_DIR STREQUAL PROJECT_SOURCE_DIR)
50
51
52
53
54
55
56
57
58
59
  ### Warn if not an out-of-source builds
  if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_CURRENT_BINARY_DIR)
    set(lines
        "You are building in-place. If that is not what you intended to "
        "do, you can clean the source directory with:\n"
        "rm -r CMakeCache.txt CMakeFiles/ cmake_uninstall.cmake pybind11Config.cmake "
        "pybind11ConfigVersion.cmake tests/CMakeFiles/\n")
    message(AUTHOR_WARNING ${lines})
  endif()

Henry Schreiner's avatar
Henry Schreiner committed
60
  set(PYBIND11_MASTER_PROJECT ON)
61
62
63
64
65
66
67
68
69

  if(OSX AND CMAKE_VERSION VERSION_LESS 3.7)
    # Bug in macOS CMake < 3.7 is unable to download catch
    message(WARNING "CMAKE 3.7+ needed on macOS to download catch, and newer HIGHLY recommended")
  elseif(WINDOWS AND CMAKE_VERSION VERSION_LESS 3.8)
    # Only tested with 3.8+ in CI.
    message(WARNING "CMAKE 3.8+ tested on Windows, previous versions untested")
  endif()

Henry Schreiner's avatar
Henry Schreiner committed
70
  message(STATUS "CMake ${CMAKE_VERSION}")
71

Henry Schreiner's avatar
Henry Schreiner committed
72
73
74
75
  if(CMAKE_CXX_STANDARD)
    set(CMAKE_CXX_EXTENSIONS OFF)
    set(CMAKE_CXX_STANDARD_REQUIRED ON)
  endif()
76
else()
Henry Schreiner's avatar
Henry Schreiner committed
77
78
  set(PYBIND11_MASTER_PROJECT OFF)
  set(pybind11_system SYSTEM)
Wenzel Jakob's avatar
Wenzel Jakob committed
79
endif()
80

Henry Schreiner's avatar
Henry Schreiner committed
81
# Options
82
option(PYBIND11_INSTALL "Install pybind11 header files?" ${PYBIND11_MASTER_PROJECT})
83
option(PYBIND11_TEST "Build pybind11 test suite?" ${PYBIND11_MASTER_PROJECT})
84
option(PYBIND11_NOPYTHON "Disable search for Python" OFF)
Henry Schreiner's avatar
Henry Schreiner committed
85

86
cmake_dependent_option(
Henry Schreiner's avatar
Henry Schreiner committed
87
88
89
  USE_PYTHON_INCLUDE_DIR
  "Install pybind11 headers in Python include directory instead of default installation prefix"
  OFF "PYBIND11_INSTALL" OFF)
90

91
92
93
cmake_dependent_option(PYBIND11_FINDPYTHON "Force new FindPython" OFF
                       "NOT CMAKE_VERSION VERSION_LESS 3.12" OFF)

94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# NB: when adding a header don't forget to also add it to setup.py
set(PYBIND11_HEADERS
    include/pybind11/detail/class.h
    include/pybind11/detail/common.h
    include/pybind11/detail/descr.h
    include/pybind11/detail/init.h
    include/pybind11/detail/internals.h
    include/pybind11/detail/typeid.h
    include/pybind11/attr.h
    include/pybind11/buffer_info.h
    include/pybind11/cast.h
    include/pybind11/chrono.h
    include/pybind11/common.h
    include/pybind11/complex.h
    include/pybind11/options.h
    include/pybind11/eigen.h
    include/pybind11/embed.h
    include/pybind11/eval.h
112
    include/pybind11/iostream.h
113
114
115
116
117
118
    include/pybind11/functional.h
    include/pybind11/numpy.h
    include/pybind11/operators.h
    include/pybind11/pybind11.h
    include/pybind11/pytypes.h
    include/pybind11/stl.h
Henry Schreiner's avatar
Henry Schreiner committed
119
    include/pybind11/stl_bind.h)
120

121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# Compare with grep and warn if mismatched
if(PYBIND11_MASTER_PROJECT AND NOT CMAKE_VERSION VERSION_LESS 3.12)
  file(
    GLOB_RECURSE _pybind11_header_check
    LIST_DIRECTORIES false
    RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
    CONFIGURE_DEPENDS "include/pybind11/*.h")
  set(_pybind11_here_only ${PYBIND11_HEADERS})
  set(_pybind11_disk_only ${_pybind11_header_check})
  list(REMOVE_ITEM _pybind11_here_only ${_pybind11_header_check})
  list(REMOVE_ITEM _pybind11_disk_only ${PYBIND11_HEADERS})
  if(_pybind11_here_only)
    message(AUTHOR_WARNING "PYBIND11_HEADERS has extra files:" ${_pybind11_here_only})
  endif()
  if(_pybind11_disk_only)
    message(AUTHOR_WARNING "PYBIND11_HEADERS is missing files:" ${_pybind11_disk_only})
  endif()
endif()
139

140
# CMake 3.12 added list(TRANSFORM <list> PREPEND
141
# But we can't use it yet
Henry Schreiner's avatar
Henry Schreiner committed
142
143
string(REPLACE "include/" "${CMAKE_CURRENT_SOURCE_DIR}/include/" PYBIND11_HEADERS
               "${PYBIND11_HEADERS}")
Dean Moldovan's avatar
Dean Moldovan committed
144

145
# Cache variables so pybind11_add_module can be used in parent projects
Henry Schreiner's avatar
Henry Schreiner committed
146
147
148
set(PYBIND11_INCLUDE_DIR
    "${CMAKE_CURRENT_LIST_DIR}/include"
    CACHE INTERNAL "")
149

150
151
# Note: when creating targets, you cannot use if statements at configure time -
# you need generator expressions, because those will be placed in the target file.
152
# You can also place ifs *in* the Config.in, but not here.
153

154
# This section builds targets, but does *not* touch Python
155

156
# Build the headers-only target (no Python included):
157
158
159
160
# (long name used here to keep this from clashing in subdirectory mode)
add_library(pybind11_headers INTERFACE)
add_library(pybind11::pybind11_headers ALIAS pybind11_headers) # to match exported target
add_library(pybind11::headers ALIAS pybind11_headers) # easier to use/remember
161

162
include("${CMAKE_CURRENT_SOURCE_DIR}/tools/pybind11Common.cmake")
163

164
165
166
if(NOT PYBIND11_MASTER_PROJECT AND NOT pybind11_FIND_QUIETLY)
  message(STATUS "Using pybind11: (version \"${pybind11_VERSION}\" ${pybind11_VERSION_TYPE})")
endif()
167

168
169
170
171
172
# Relative directory setting
if(USE_PYTHON_INCLUDE_DIR AND DEFINED Python_INCLUDE_DIRS)
  file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${Python_INCLUDE_DIRS})
elseif(USE_PYTHON_INCLUDE_DIR AND DEFINED PYTHON_INCLUDE_DIR)
  file(RELATIVE_PATH CMAKE_INSTALL_INCLUDEDIR ${CMAKE_INSTALL_PREFIX} ${PYTHON_INCLUDE_DIRS})
173
174
endif()

175
176
# Fill in headers target
target_include_directories(
177
178
  pybind11_headers ${pybind11_system} INTERFACE $<BUILD_INTERFACE:${PYBIND11_INCLUDE_DIR}>
                                                $<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>)
179

180
181
target_compile_features(pybind11_headers INTERFACE cxx_inheriting_constructors cxx_user_literals
                                                   cxx_right_angle_brackets)
182
183

if(PYBIND11_INSTALL)
Henry Schreiner's avatar
Henry Schreiner committed
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
  install(DIRECTORY ${PYBIND11_INCLUDE_DIR}/pybind11 DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
  # GNUInstallDirs "DATADIR" wrong here; CMake search path wants "share".
  set(PYBIND11_CMAKECONFIG_INSTALL_DIR
      "share/cmake/${PROJECT_NAME}"
      CACHE STRING "install path for pybind11Config.cmake")

  configure_package_config_file(
    tools/${PROJECT_NAME}Config.cmake.in "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
    INSTALL_DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})

  if(CMAKE_VERSION VERSION_LESS 3.14)
    # Remove CMAKE_SIZEOF_VOID_P from ConfigVersion.cmake since the library does
    # not depend on architecture specific settings or libraries.
    set(_PYBIND11_CMAKE_SIZEOF_VOID_P ${CMAKE_SIZEOF_VOID_P})
    unset(CMAKE_SIZEOF_VOID_P)

    write_basic_package_version_file(
      ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
      VERSION ${PROJECT_VERSION}
      COMPATIBILITY AnyNewerVersion)

    set(CMAKE_SIZEOF_VOID_P ${_PYBIND11_CMAKE_SIZEOF_VOID_P})
  else()
    # CMake 3.14+ natively supports header-only libraries
    write_basic_package_version_file(
      ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
      VERSION ${PROJECT_VERSION}
      COMPATIBILITY AnyNewerVersion ARCH_INDEPENDENT)
  endif()

  install(
    FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake
          ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake
217
218
219
220
          tools/FindPythonLibsNew.cmake
          tools/pybind11Common.cmake
          tools/pybind11Tools.cmake
          tools/pybind11NewTools.cmake
Henry Schreiner's avatar
Henry Schreiner committed
221
222
223
224
225
226
    DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})

  if(NOT PYBIND11_EXPORT_NAME)
    set(PYBIND11_EXPORT_NAME "${PROJECT_NAME}Targets")
  endif()

227
  install(TARGETS pybind11_headers EXPORT "${PYBIND11_EXPORT_NAME}")
Henry Schreiner's avatar
Henry Schreiner committed
228
229
230
231
232

  install(
    EXPORT "${PYBIND11_EXPORT_NAME}"
    NAMESPACE "pybind11::"
    DESTINATION ${PYBIND11_CMAKECONFIG_INSTALL_DIR})
233

234
235
236
237
  # Uninstall target
  if(PYBIND11_MASTER_PROJECT)
    configure_file("${CMAKE_CURRENT_SOURCE_DIR}/tools/cmake_uninstall.cmake.in"
                   "${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake" IMMEDIATE @ONLY)
238

239
240
241
    add_custom_target(uninstall COMMAND ${CMAKE_COMMAND} -P
                                        ${CMAKE_CURRENT_BINARY_DIR}/cmake_uninstall.cmake)
  endif()
242
endif()
Henry Schreiner's avatar
Henry Schreiner committed
243

244
245
246
# BUILD_TESTING takes priority, but only if this is the master project
if(PYBIND11_MASTER_PROJECT AND DEFINED BUILD_TESTING)
  if(BUILD_TESTING)
247
248
249
250
251
    if(_pybind11_nopython)
      message(FATAL_ERROR "Cannot activate tests in NOPYTHON mode")
    else()
      add_subdirectory(tests)
    endif()
252
253
254
  endif()
else()
  if(PYBIND11_TEST)
255
256
257
258
259
    if(_pybind11_nopython)
      message(FATAL_ERROR "Cannot activate tests in NOPYTHON mode")
    else()
      add_subdirectory(tests)
    endif()
260
  endif()
Henry Schreiner's avatar
Henry Schreiner committed
261
endif()
262
263
264
265
266
267
268
269
270
271

# Better symmetry with find_package(pybind11 CONFIG) mode.
if(NOT PYBIND11_MASTER_PROJECT)
  set(pybind11_FOUND
      TRUE
      CACHE INTERNAL "true if pybind11 and all required components found on the system")
  set(pybind11_INCLUDE_DIR
      "${PYBIND11_INCLUDE_DIR}"
      CACHE INTERNAL "Directory where pybind11 headers are located")
endif()