salome_adm/cmake_files/FindSalomePython.cmake

   1 # Copyright (C) 2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19 # Author: Adrien Bruneton
  20 #
  21
  22 # Python libraries and interpreter detection for SALOME
  23 #
  24 #  !! Please read the generic detection procedure in SalomeMacros.cmake !!
  25 #
  26 # The interpreter is found first, and if OK, the corresponding libraries are searched.
  27 # We ensure the version of the libraries matches the one of the interpreter.
  28 #
  29 # We also look for an installation of NumPy, and if found the following variables are set
  30 #   NUMPY_INCLUDE_DIR  - NumPy header location
  31 #   NUMPY_DEFINITIONS  - compiler flag
  32 # and are automatically appended to PYTHON_INCLUDE_DIRS (and PYTHON_DEFINITIONS resp.)
  33 #
  34
  35 # 1. Load environment or any previously detected Python
  36 IF(DEFINED ENV{PYTHON_ROOT_DIR})
  37   FILE(TO_CMAKE_PATH "$ENV{PYTHON_ROOT_DIR}" _PYTHON_ROOT_DIR_ENV)
  38   SET(_dflt_value "${_PYTHON_ROOT_DIR_ENV}")
  39 ELSE()
  40   # will be blank if no Python was previously loaded
  41   SET(_dflt_value "${PYTHON_ROOT_DIR_EXP}")
  42 ENDIF()
  43
  44 #   Make cache entry
  45 SET(PYTHON_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to Python directory (interpreter and libs)")
  46
  47 # 2. Find package - config mode first (i.e. looking for XYZ-config.cmake)
  48 IF(WINDOWS)
  49  IF(CMAKE_BUILD_TYPE STREQUAL Debug)
  50   SET(PythonInterp_FIND_VERSION _d)
  51   SET(PYTHON_DEFINITIONS "-DHAVE_DEBUG_PYTHON")
  52  ENDIF(CMAKE_BUILD_TYPE STREQUAL Debug)
  53 ENDIF(WINDOWS)
  54 IF(EXISTS "${PYTHON_ROOT_DIR}")
  55   # Hope to find direclty a CMake config file there
  56   SET(_CONF_DIR "${PYTHON_ROOT_DIR}/share/cmake")
  57
  58   # Try find_package in config mode with a hard-coded guess. This
  59   # has the priority.
  60   FIND_PACKAGE(Python CONFIG QUIET PATHS "${_CONF_DIR}")
  61   MARK_AS_ADVANCED(Python_DIR)
  62
  63   IF (NOT PYTHON_FOUND)
  64     LIST(APPEND CMAKE_PREFIX_PATH "${PYTHON_ROOT_DIR}")
  65   ELSE()
  66     MESSAGE(STATUS "Found Python in CONFIG mode!")
  67   ENDIF()
  68 ENDIF()
  69
  70 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
  71 SALOME_FIND_PACKAGE(SalomePython PythonInterp MODULE)
  72 SET(_found1 ${PYTHONINTERP_FOUND})
  73
  74 IF (PYTHONINTERP_FOUND)
  75   # Now ensure we find the Python libraries matching the interpreter:
  76   # This uses the variable PYTHON_EXECUTABLE
  77   GET_FILENAME_COMPONENT(_python_dir "${PYTHON_EXECUTABLE}" PATH)
  78   GET_FILENAME_COMPONENT(CMAKE_INCLUDE_PATH "${_python_dir}/../include/python${PYTHON_VERSION_MAJOR}.${PYTHON_VERSION_MINOR}" ABSOLUTE)
  79   GET_FILENAME_COMPONENT(CMAKE_LIBRARY_PATH "${_python_dir}/../lib" ABSOLUTE)
  80   # For a Windows install, this might look more like this:
  81   IF(WIN32)
  82     LIST(APPEND CMAKE_LIBRARY_PATH "${_python_dir}/libs" ABSOLUTE)
  83     LIST(APPEND CMAKE_INCLUDE_PATH "${_python_dir}/include" ABSOLUTE)
  84   ENDIF()
  85   # Override the EXACT and VERSION settings of the SalomePython module
  86   # to force the next call to SALOME_FIND_PACKAGE() to find the exact matching
  87   # version:
  88   SET(_old_EXACT ${SalomePython_FIND_VERSION_EXACT})
  89   SET(_old_VERSION "${SalomePython_FIND_VERSION}")
  90   SET(SalomePython_FIND_VERSION_EXACT TRUE)
  91   SET(SalomePython_FIND_VERSION "${PYTHON_VERSION_STRING}")
  92   # Prepare call to FIND_PACKAGE(PythonLibs) and ensure priority is given to
  93   # the location found for the interpreter:
  94   GET_FILENAME_COMPONENT(_tmp "${_python_dir}" PATH)
  95 #  SET(PYTHON_LIBRARY ${_tmp}/lib)
  96 #  SET(PYTHON_INCLUDE_DIR ${_tmp}/include)
  97   SALOME_FIND_PACKAGE(SalomePython PythonLibs MODULE)
  98   # Restore variables:
  99   SET(SalomePython_FIND_VERSION_EXACT ${_old_EXACT})
 100   SET(SalomePython_FIND_VERSION "${_old_VERSION}")
 101 ENDIF()
 102
 103 # Set the FOUND flag for SalomePython and Python:
 104 SET(SALOMEPYTHON_FOUND FALSE)
 105 IF (_found1 AND PYTHONLIBS_FOUND)
 106   SET(SALOMEPYTHON_FOUND TRUE)
 107   SET(Python_FOUND TRUE)
 108 ELSE()
 109 SET(SALOMEPYTHON_FOUND FALSE)
 110   SET(Python_FOUND FALSE)
 111 ENDIF()
 112
 113 IF (SALOMEPYTHON_FOUND)
 114   MESSAGE(STATUS "Python interpreter and Python libraries found:")
 115   MESSAGE(STATUS "Python libraries: ${PYTHON_LIBRARY}")
 116   MESSAGE(STATUS "Python include dir: ${PYTHON_INCLUDE_DIR}")
 117
 118   # 3. Set the root dir which was finally retained
 119   # For Python this is the grand-parent of the
 120   # include directory:
 121   GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${PYTHON_INCLUDE_DIR}" PATH)
 122   IF(NOT WIN32)
 123     GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 124   ENDIF()
 125
 126   # 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 127   IF(DEFINED ENV{PYTHON_ROOT_DIR})
 128     SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_PYTHON_ROOT_DIR_ENV}")
 129     IF(NOT _res)
 130       MESSAGE(WARNING "Python was found, but not a the path given by the "
 131 "environment PYTHON_ROOT_DIR! Is the variable correctly set?")
 132     ELSE()
 133       MESSAGE(STATUS "Python found directory matches what was specified in the PYTHON_ROOT_DIR, all good!")
 134     ENDIF()
 135   ENDIF()
 136
 137   # 5. Conflict detection
 138   # 5.1  From another prerequisite using Python
 139   IF(PYTHON_ROOT_DIR_EXP)
 140       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${PYTHON_ROOT_DIR_EXP}")
 141       IF(NOT _res)
 142          MESSAGE(WARNING "Warning: Python: detected version conflicts with a previously found Python!"
 143                           "The two paths are " ${_tmp_ROOT_DIR} " vs " ${PYTHON_ROOT_DIR_EXP})
 144       ELSE()
 145           MESSAGE(STATUS "Python directory matches what was previously exposed by another prereq, all good!")
 146       ENDIF()
 147   ENDIF()
 148
 149   # 6. Specifics
 150   #
 151
 152   # NumPy detection
 153   EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c "import numpy ; import sys ; sys.stdout.write(numpy.get_include())" OUTPUT_VARIABLE NUMPY_INCLUDE_DIR ERROR_QUIET )
 154   IF(NUMPY_INCLUDE_DIR)
 155     SET(NUMPY_FOUND TRUE)
 156   ENDIF(NUMPY_INCLUDE_DIR)
 157   IF(NUMPY_FOUND)
 158     SET(PYTHON_INCLUDE_DIRS ${NUMPY_INCLUDE_DIR} ${PYTHON_INCLUDE_DIRS})
 159     SET(PYTHON_DEFINITIONS "${PYTHON_DEFINITIONS} -DWITH_NUMPY")
 160     MESSAGE(STATUS "NumPy found : ${NUMPY_INCLUDE_DIR}")
 161   ELSE(NUMPY_FOUND)
 162     MESSAGE(STATUS "NumPy not found.")
 163   ENDIF(NUMPY_FOUND)
 164
 165   ## None here
 166 ELSE()
 167   MESSAGE(STATUS "Python was only partially (or not at all) found .")
 168 ENDIF()
 169
 170