CMakeLists.txt 8.88 KB
Newer Older
Wenzel Jakob's avatar
Wenzel Jakob committed
1
2
3
4
5
6
7
# CMakeLists.txt -- Build system for the pybind11 examples
#
# 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 2.8.12)
Wenzel Jakob's avatar
Wenzel Jakob committed
9

10
project(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
11

Wenzel Jakob's avatar
Wenzel Jakob committed
12
13
option(PYBIND11_INSTALL "Install pybind11 header files?" ON)

14
# Add a CMake parameter for choosing a desired Python version
15
set(PYBIND11_PYTHON_VERSION "" CACHE STRING "Python version to use for compiling the example application")
16

17
18
include(CheckCXXCompilerFlag)

19
# Set a default build configuration if none is specified. 'MinSizeRel' produces the smallest binaries
Wenzel Jakob's avatar
Wenzel Jakob committed
20
21
22
23
24
25
if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  message(STATUS "Setting build type to 'MinSizeRel' as none was specified.")
  set(CMAKE_BUILD_TYPE MinSizeRel CACHE STRING "Choose the type of build." FORCE)
  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
    "MinSizeRel" "RelWithDebInfo")
endif()
26
string(TOUPPER "${CMAKE_BUILD_TYPE}" U_CMAKE_BUILD_TYPE)
27

28
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/tools")
29
set(Python_ADDITIONAL_VERSIONS 3.4 3.5 3.6 3.7)
30
find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} REQUIRED)
31

32
if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" OR CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Intel")
33
34
  # Enable link time optimization and set the default symbol
  # visibility to hidden (very important to obtain small binaries)
Wenzel Jakob's avatar
Wenzel Jakob committed
35
  if (NOT ${U_CMAKE_BUILD_TYPE} MATCHES DEBUG)
36
    # Check for Link Time Optimization support
37
    # (GCC/Clang)
38
39
40
41
    CHECK_CXX_COMPILER_FLAG("-flto" HAS_LTO_FLAG)
    if (HAS_LTO_FLAG)
      set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -flto")
    endif()
42
43

    # Intel equivalent to LTO is called IPO
44
45
46
47
48
    if (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
      CHECK_CXX_COMPILER_FLAG("-ipo" HAS_IPO_FLAG)
      if (HAS_IPO_FLAG)
        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ipo")
      endif()
49
    endif()
Wenzel Jakob's avatar
Wenzel Jakob committed
50
51
52
53
54
55
56
57
58
59
  endif()
endif()

# Compile with compiler warnings turned on
if(MSVC)
  if(CMAKE_CXX_FLAGS MATCHES "/W[0-4]")
    string(REGEX REPLACE "/W[0-4]" "/W4" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
  else()
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4")
  endif()
Wenzel Jakob's avatar
Wenzel Jakob committed
60
elseif ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang" OR "${CMAKE_CXX_COMPILER_ID}" MATCHES "GNU")
Wenzel Jakob's avatar
Wenzel Jakob committed
61
62
63
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra")
endif()

64
65
66
67
68
# Cache variables so pybind11_add_module can be used in parent projects
set(PYBIND11_INCLUDE_DIR "${CMAKE_CURRENT_LIST_DIR}/include" CACHE INTERNAL "")
set(PYTHON_INCLUDE_DIRS ${PYTHON_INCLUDE_DIRS} CACHE INTERNAL "")
set(PYTHON_MODULE_PREFIX ${PYTHON_MODULE_PREFIX} CACHE INTERNAL "")
set(PYTHON_MODULE_EXTENSION ${PYTHON_MODULE_EXTENSION} CACHE INTERNAL "")
69

70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# Build a Python extension module:
# pybind11_add_module(<name> source1 [source2 ...])
#
function(pybind11_add_module target_name)
  add_library(${target_name} MODULE ${ARGN})
  target_include_directories(${target_name} PUBLIC ${PYBIND11_INCLUDE_DIR} ${PYTHON_INCLUDE_DIRS})

  # The prefix and extension are provided by FindPythonLibsNew.cmake
  set_target_properties(${target_name} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}")
  set_target_properties(${target_name} PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}")

  # It's quite common to have multiple copies of the same Python version
  # installed on one's system. E.g.: one copy from the OS and another copy
  # that's statically linked into an application like Blender or Maya.
  # If we link our plugin library against the OS Python here and import it
  # into Blender or Maya later on, this will cause segfaults when multiple
  # conflicting Python instances are active at the same time (even when they
  # are of the same version).
88

89
90
91
92
93
94
95
96
97
98
99
100
  # Windows is not affected by this issue since it handles DLL imports
  # differently. The solution for Linux and Mac OS is simple: we just don't
  # link against the Python library. The resulting shared library will have
  # missing symbols, but that's perfectly fine -- they will be resolved at
  # import time.
  if(MSVC)
    target_link_libraries(${target_name} ${PYTHON_LIBRARIES})
  elseif(APPLE)
    # Make sure OS X does not have any issues with missing symbols
    set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ".")
    target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup")
  endif()
101

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
  # Make sure C++11/14 are enabled
  if(NOT MSVC)
    check_cxx_compiler_flag("-std=c++14" HAS_CPP14_FLAG)
    check_cxx_compiler_flag("-std=c++11" HAS_CPP11_FLAG)

    if (HAS_CPP14_FLAG)
      target_compile_options(${target_name} PUBLIC "-std=c++14")
    elseif (HAS_CPP11_FLAG)
      target_compile_options(${target_name} PUBLIC "-std=c++11")
    else()
      message(FATAL_ERROR "Unsupported compiler -- pybind11 requires C++11 support!")
    endif()

    string(TOUPPER "${CMAKE_BUILD_TYPE}" U_CMAKE_BUILD_TYPE)
    if (NOT ${U_CMAKE_BUILD_TYPE} MATCHES DEBUG)
      # Default symbol visibility
      target_compile_options(${target_name} PRIVATE "-fvisibility=hidden")
    endif()
  endif()
endfunction()
122

123
set(PYBIND11_HEADERS
Wenzel Jakob's avatar
Wenzel Jakob committed
124
  include/pybind11/attr.h
125
126
  include/pybind11/cast.h
  include/pybind11/common.h
127
128
  include/pybind11/complex.h
  include/pybind11/descr.h
129
  include/pybind11/eigen.h
130
131
  include/pybind11/functional.h
  include/pybind11/numpy.h
132
133
134
  include/pybind11/operators.h
  include/pybind11/pybind11.h
  include/pybind11/pytypes.h
Wenzel Jakob's avatar
Wenzel Jakob committed
135
  include/pybind11/stl.h
136
  include/pybind11/stl_bind.h
137
  include/pybind11/typeid.h
138
139
)

Axel Huebl's avatar
Axel Huebl committed
140
set(PYBIND11_EXAMPLES
Wenzel Jakob's avatar
Wenzel Jakob committed
141
142
143
144
145
146
147
148
149
  example/example1.cpp
  example/example2.cpp
  example/example3.cpp
  example/example4.cpp
  example/example5.cpp
  example/example6.cpp
  example/example7.cpp
  example/example8.cpp
  example/example9.cpp
Wenzel Jakob's avatar
Wenzel Jakob committed
150
  example/example10.cpp
151
  example/example11.cpp
152
  example/example12.cpp
153
  example/example13.cpp
Wenzel Jakob's avatar
Wenzel Jakob committed
154
  example/example14.cpp
Wenzel Jakob's avatar
Wenzel Jakob committed
155
  example/example15.cpp
156
  example/example16.cpp
Sergey Lyskov's avatar
Sergey Lyskov committed
157
  example/example17.cpp
158
  example/issues.cpp
Wenzel Jakob's avatar
Wenzel Jakob committed
159
)
Axel Huebl's avatar
Axel Huebl committed
160

161
162
163
# Check if Eigen is available
find_package(Eigen3 QUIET)

164
165
166
167
168
169
170
if (EIGEN3_FOUND)
  list(APPEND PYBIND11_EXAMPLES example/eigen.cpp)
  message(STATUS "Building Eigen testcase")
else()
  message(STATUS "NOT Building Eigen testcase")
endif()

Axel Huebl's avatar
Axel Huebl committed
171
# Create the binding library
172
173
174
175
176
pybind11_add_module(example example/example.cpp ${PYBIND11_EXAMPLES})
if (EIGEN3_FOUND)
  target_include_directories(example PRIVATE ${EIGEN3_INCLUDE_DIR})
  target_compile_definitions(example PRIVATE -DPYBIND11_TEST_EIGEN)
endif()
177

Wenzel Jakob's avatar
Wenzel Jakob committed
178
179
180
181
182
183
184
185
186
187
# Always write the output file directly into the 'example' directory (even on MSVC)
set(CompilerFlags
  LIBRARY_OUTPUT_DIRECTORY LIBRARY_OUTPUT_DIRECTORY_RELEASE LIBRARY_OUTPUT_DIRECTORY_DEBUG
  LIBRARY_OUTPUT_DIRECTORY_MINSIZEREL LIBRARY_OUTPUT_DIRECTORY_RELWITHDEBINFO
  RUNTIME_OUTPUT_DIRECTORY RUNTIME_OUTPUT_DIRECTORY_RELEASE RUNTIME_OUTPUT_DIRECTORY_DEBUG
  RUNTIME_OUTPUT_DIRECTORY_MINSIZEREL RUNTIME_OUTPUT_DIRECTORY_RELWITHDEBINFO)

foreach(CompilerFlag ${CompilerFlags})
  set_target_properties(example PROPERTIES ${CompilerFlag} ${PROJECT_SOURCE_DIR}/example)
endforeach()
Wenzel Jakob's avatar
Wenzel Jakob committed
188
189
190

if (WIN32)
  if (MSVC)
191
192
193
194
195
196
197
198
199
200
201
202
203
    # /MP enables multithreaded builds (relevant when there are many files), /bigobj is
    # needed for bigger binding projects due to the limit to 64k addressable sections
    set_property(TARGET example APPEND PROPERTY COMPILE_OPTIONS /MP /bigobj)
    # Enforce size-based optimization and link time code generation on MSVC
    # (~30% smaller binaries in experiments); do nothing in debug mode.
    set_property(TARGET example APPEND PROPERTY COMPILE_OPTIONS
      "$<$<CONFIG:Release>:/Os>" "$<$<CONFIG:Release>:/GL>"
      "$<$<CONFIG:MinSizeRel>:/Os>" "$<$<CONFIG:MinSizeRel>:/GL>"
      "$<$<CONFIG:RelWithDebInfo>:/Os>" "$<$<CONFIG:RelWithDebInfo>:/GL>"
    )
    set_property(TARGET example APPEND_STRING PROPERTY LINK_FLAGS_RELEASE "/LTCG ")
    set_property(TARGET example APPEND_STRING PROPERTY LINK_FLAGS_MINSIZEREL "/LTCG ")
    set_property(TARGET example APPEND_STRING PROPERTY LINK_FLAGS_RELWITHDEBINFO "/LTCG ")
Wenzel Jakob's avatar
Wenzel Jakob committed
204
205
  endif()
elseif (UNIX)
206
207
208
209
210
  # Optimize for a small binary size
  if (NOT ${U_CMAKE_BUILD_TYPE} MATCHES DEBUG)
    set_target_properties(example PROPERTIES COMPILE_FLAGS "-Os")
  endif()

Wenzel Jakob's avatar
Wenzel Jakob committed
211
212
213
  # Strip unnecessary sections of the binary on Linux/Mac OS
  if(APPLE)
    if (NOT ${U_CMAKE_BUILD_TYPE} MATCHES DEBUG)
214
      add_custom_command(TARGET example POST_BUILD COMMAND strip -u -r $<TARGET_FILE:example>)
Wenzel Jakob's avatar
Wenzel Jakob committed
215
216
217
    endif()
  else()
    if (NOT ${U_CMAKE_BUILD_TYPE} MATCHES DEBUG)
218
      add_custom_command(TARGET example POST_BUILD COMMAND strip $<TARGET_FILE:example>)
Wenzel Jakob's avatar
Wenzel Jakob committed
219
220
221
222
223
    endif()
  endif()
endif()

enable_testing()
224

Wenzel Jakob's avatar
Wenzel Jakob committed
225
set(RUN_TEST ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/example/run_test.py)
226
227
228
229
if (MSVC OR CMAKE_CXX_COMPILER_ID MATCHES "Intel")
  set(RUN_TEST ${RUN_TEST} --relaxed)
endif()

230
231
232
foreach(VALUE ${PYBIND11_EXAMPLES})
  string(REGEX REPLACE "^example/(.+).cpp$" "\\1" EXAMPLE_NAME "${VALUE}")
  add_test(NAME ${EXAMPLE_NAME} COMMAND ${RUN_TEST} ${EXAMPLE_NAME})
Wenzel Jakob's avatar
Wenzel Jakob committed
233
endforeach()
234

Wenzel Jakob's avatar
Wenzel Jakob committed
235
if (PYBIND11_INSTALL)
236
237
    install(FILES ${PYBIND11_HEADERS} DESTINATION include/pybind11)
endif()