You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

202 lines
8.1 KiB

3 months ago
  1. # tools/pybind11Tools.cmake -- Build system for the pybind11 modules
  2. #
  3. # Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch>
  4. #
  5. # All rights reserved. Use of this source code is governed by a
  6. # BSD-style license that can be found in the LICENSE file.
  7. cmake_minimum_required(VERSION 2.8.12)
  8. # Add a CMake parameter for choosing a desired Python version
  9. if(NOT PYBIND11_PYTHON_VERSION)
  10. set(PYBIND11_PYTHON_VERSION "" CACHE STRING "Python version to use for compiling modules")
  11. endif()
  12. set(Python_ADDITIONAL_VERSIONS 3.7 3.6 3.5 3.4)
  13. find_package(PythonLibsNew ${PYBIND11_PYTHON_VERSION} REQUIRED)
  14. include(CheckCXXCompilerFlag)
  15. include(CMakeParseArguments)
  16. function(select_cxx_standard)
  17. if(NOT PYBIND11_CPP_STANDARD)
  18. if(NOT MSVC)
  19. check_cxx_compiler_flag("-std=c++17" HAS_CPP17_FLAG)
  20. check_cxx_compiler_flag("-std=c++14" HAS_CPP14_FLAG)
  21. check_cxx_compiler_flag("-std=c++11" HAS_CPP11_FLAG)
  22. if (HAS_CPP17_FLAG)
  23. set(PYBIND11_CPP_STANDARD -std=c++17)
  24. elseif (HAS_CPP14_FLAG)
  25. set(PYBIND11_CPP_STANDARD -std=c++14)
  26. elseif (HAS_CPP11_FLAG)
  27. set(PYBIND11_CPP_STANDARD -std=c++11)
  28. else()
  29. message(FATAL_ERROR "Unsupported compiler -- pybind11 requires C++11 support!")
  30. endif()
  31. elseif(MSVC)
  32. set(PYBIND11_CPP_STANDARD /std:c++14)
  33. endif()
  34. set(PYBIND11_CPP_STANDARD ${PYBIND11_CPP_STANDARD} CACHE STRING
  35. "C++ standard flag, e.g. -std=c++11, -std=c++14, /std:c++14. Defaults to C++14 mode." FORCE)
  36. endif()
  37. endfunction()
  38. # Checks whether the given CXX/linker flags can compile and link a cxx file. cxxflags and
  39. # linkerflags are lists of flags to use. The result variable is a unique variable name for each set
  40. # of flags: the compilation result will be cached base on the result variable. If the flags work,
  41. # sets them in cxxflags_out/linkerflags_out internal cache variables (in addition to ${result}).
  42. function(_pybind11_return_if_cxx_and_linker_flags_work result cxxflags linkerflags cxxflags_out linkerflags_out)
  43. set(CMAKE_REQUIRED_LIBRARIES ${linkerflags})
  44. check_cxx_compiler_flag("${cxxflags}" ${result})
  45. if (${result})
  46. set(${cxxflags_out} "${cxxflags}" CACHE INTERNAL "" FORCE)
  47. set(${linkerflags_out} "${linkerflags}" CACHE INTERNAL "" FORCE)
  48. endif()
  49. endfunction()
  50. # Internal: find the appropriate link time optimization flags for this compiler
  51. function(_pybind11_add_lto_flags target_name prefer_thin_lto)
  52. if (NOT DEFINED PYBIND11_LTO_CXX_FLAGS)
  53. set(PYBIND11_LTO_CXX_FLAGS "" CACHE INTERNAL "")
  54. set(PYBIND11_LTO_LINKER_FLAGS "" CACHE INTERNAL "")
  55. if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
  56. set(cxx_append "")
  57. set(linker_append "")
  58. if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND NOT APPLE)
  59. # Clang Gold plugin does not support -Os; append -O3 to MinSizeRel builds to override it
  60. set(linker_append ";$<$<CONFIG:MinSizeRel>:-O3>")
  61. elseif(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
  62. set(cxx_append ";-fno-fat-lto-objects")
  63. endif()
  64. if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND prefer_thin_lto)
  65. _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO_THIN
  66. "-flto=thin${cxx_append}" "-flto=thin${linker_append}"
  67. PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS)
  68. endif()
  69. if (NOT HAS_FLTO_THIN)
  70. _pybind11_return_if_cxx_and_linker_flags_work(HAS_FLTO
  71. "-flto${cxx_append}" "-flto${linker_append}"
  72. PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS)
  73. endif()
  74. elseif (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
  75. # Intel equivalent to LTO is called IPO
  76. _pybind11_return_if_cxx_and_linker_flags_work(HAS_INTEL_IPO
  77. "-ipo" "-ipo" PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS)
  78. elseif(MSVC)
  79. # cmake only interprets libraries as linker flags when they start with a - (otherwise it
  80. # converts /LTCG to \LTCG as if it was a Windows path). Luckily MSVC supports passing flags
  81. # with - instead of /, even if it is a bit non-standard:
  82. _pybind11_return_if_cxx_and_linker_flags_work(HAS_MSVC_GL_LTCG
  83. "/GL" "-LTCG" PYBIND11_LTO_CXX_FLAGS PYBIND11_LTO_LINKER_FLAGS)
  84. endif()
  85. if (PYBIND11_LTO_CXX_FLAGS)
  86. message(STATUS "LTO enabled")
  87. else()
  88. message(STATUS "LTO disabled (not supported by the compiler and/or linker)")
  89. endif()
  90. endif()
  91. # Enable LTO flags if found, except for Debug builds
  92. if (PYBIND11_LTO_CXX_FLAGS)
  93. #target_compile_options(${target_name} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_CXX_FLAGS}>")
  94. endif()
  95. if (PYBIND11_LTO_LINKER_FLAGS)
  96. target_link_libraries(${target_name} PRIVATE "$<$<NOT:$<CONFIG:Debug>>:${PYBIND11_LTO_LINKER_FLAGS}>")
  97. endif()
  98. endfunction()
  99. # Build a Python extension module:
  100. # pybind11_add_module(<name> [MODULE | SHARED] [EXCLUDE_FROM_ALL]
  101. # [NO_EXTRAS] [THIN_LTO] source1 [source2 ...])
  102. #
  103. function(pybind11_add_module target_name)
  104. set(options MODULE SHARED EXCLUDE_FROM_ALL NO_EXTRAS THIN_LTO)
  105. cmake_parse_arguments(ARG "${options}" "" "" ${ARGN})
  106. if(ARG_MODULE AND ARG_SHARED)
  107. message(FATAL_ERROR "Can't be both MODULE and SHARED")
  108. elseif(ARG_SHARED)
  109. set(lib_type SHARED)
  110. else()
  111. set(lib_type MODULE)
  112. endif()
  113. if(ARG_EXCLUDE_FROM_ALL)
  114. set(exclude_from_all EXCLUDE_FROM_ALL)
  115. endif()
  116. add_library(${target_name} ${lib_type} ${exclude_from_all} ${ARG_UNPARSED_ARGUMENTS})
  117. target_include_directories(${target_name}
  118. PRIVATE ${PYBIND11_INCLUDE_DIR} # from project CMakeLists.txt
  119. PRIVATE ${pybind11_INCLUDE_DIR} # from pybind11Config
  120. PRIVATE ${PYTHON_INCLUDE_DIRS})
  121. # The prefix and extension are provided by FindPythonLibsNew.cmake
  122. set_target_properties(${target_name} PROPERTIES PREFIX "${PYTHON_MODULE_PREFIX}")
  123. set_target_properties(${target_name} PROPERTIES SUFFIX "${PYTHON_MODULE_EXTENSION}")
  124. if(WIN32 OR CYGWIN)
  125. # Link against the Python shared library on Windows
  126. target_link_libraries(${target_name} PRIVATE ${PYTHON_LIBRARIES})
  127. elseif(APPLE)
  128. # It's quite common to have multiple copies of the same Python version
  129. # installed on one's system. E.g.: one copy from the OS and another copy
  130. # that's statically linked into an application like Blender or Maya.
  131. # If we link our plugin library against the OS Python here and import it
  132. # into Blender or Maya later on, this will cause segfaults when multiple
  133. # conflicting Python instances are active at the same time (even when they
  134. # are of the same version).
  135. # Windows is not affected by this issue since it handles DLL imports
  136. # differently. The solution for Linux and Mac OS is simple: we just don't
  137. # link against the Python library. The resulting shared library will have
  138. # missing symbols, but that's perfectly fine -- they will be resolved at
  139. # import time.
  140. target_link_libraries(${target_name} PRIVATE "-undefined dynamic_lookup")
  141. if(ARG_SHARED)
  142. # Suppress CMake >= 3.0 warning for shared libraries
  143. set_target_properties(${target_name} PROPERTIES MACOSX_RPATH ON)
  144. endif()
  145. endif()
  146. select_cxx_standard()
  147. # Make sure C++11/14 are enabled
  148. target_compile_options(${target_name} PUBLIC ${PYBIND11_CPP_STANDARD})
  149. if(ARG_NO_EXTRAS)
  150. return()
  151. endif()
  152. _pybind11_add_lto_flags(${target_name} ${ARG_THIN_LTO})
  153. if (NOT MSVC AND NOT ${CMAKE_BUILD_TYPE} MATCHES Debug)
  154. # Set the default symbol visibility to hidden (very important to obtain small binaries)
  155. # target_compile_options(${target_name} PRIVATE "-fvisibility=hidden")
  156. # Strip unnecessary sections of the binary on Linux/Mac OS
  157. if(CMAKE_STRIP)
  158. if(APPLE)
  159. add_custom_command(TARGET ${target_name} POST_BUILD
  160. COMMAND ${CMAKE_STRIP} -x $<TARGET_FILE:${target_name}>)
  161. else()
  162. add_custom_command(TARGET ${target_name} POST_BUILD
  163. COMMAND ${CMAKE_STRIP} $<TARGET_FILE:${target_name}>)
  164. endif()
  165. endif()
  166. endif()
  167. if(MSVC)
  168. # /MP enables multithreaded builds (relevant when there are many files), /bigobj is
  169. # needed for bigger binding projects due to the limit to 64k addressable sections
  170. target_compile_options(${target_name} PRIVATE /MP /bigobj)
  171. endif()
  172. endfunction()