1 # Copyright (C) 2012-2013 CEA/DEN, EDF R&D, OPEN CASCADE
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.
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.
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
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 # Author: A.Geay, V. Sandler, A. Bruneton
22 #----------------------------------------------------------------------------
23 # LIST_CONTAINS is a macro useful for determining whether a list has a
25 #----------------------------------------------------------------------------
26 MACRO(LIST_CONTAINS var value)
28 FOREACH(value2 ${ARGN})
29 IF(${value} STREQUAL "${value2}")
31 ENDIF (${value} STREQUAL "${value2}")
33 ENDMACRO(LIST_CONTAINS)
35 #----------------------------------------------------------------------------
36 # The PARSE_ARGUMENTS macro will take the arguments of another macro and
37 # define several variables.
39 # USAGE: PARSE_ARGUMENTS(prefix arg_names options arg1 arg2...)
43 # prefix: IN: a prefix to put on all variables it creates.
45 # arg_names: IN: a list of names.
46 # For each item in arg_names, PARSE_ARGUMENTS will create a
47 # variable with that name, prefixed with prefix_. Each variable will be filled
48 # with the arguments that occur after the given arg_name is encountered
49 # up to the next arg_name or the end of the arguments. All options are
50 # removed from these lists. PARSE_ARGUMENTS also creates a
51 # prefix_DEFAULT_ARGS variable containing the list of all arguments up
52 # to the first arg_name encountered.
54 # options: IN: a list of options.
55 # For each item in options, PARSE_ARGUMENTS will create a
56 # variable with that name, prefixed with prefix_. So, for example, if prefix is
57 # MY_MACRO and options is OPTION1;OPTION2, then PARSE_ARGUMENTS will
58 # create the variables MY_MACRO_OPTION1 and MY_MACRO_OPTION2. These
59 # variables will be set to true if the option exists in the command line
61 # arg_names and options lists should be quoted.
63 # The rest of PARSE_ARGUMENTS are arguments from another macro to be parsed.
64 #----------------------------------------------------------------------------
65 MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
67 FOREACH(arg_name ${arg_names})
68 SET(${prefix}_${arg_name})
70 FOREACH(option ${option_names})
71 SET(${prefix}_${option} FALSE)
73 SET(current_arg_name DEFAULT_ARGS)
76 LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
78 SET(${prefix}_${current_arg_name} ${current_arg_list})
79 SET(current_arg_name ${arg})
82 LIST_CONTAINS(is_option ${arg} ${option_names})
84 SET(${prefix}_${arg} TRUE)
86 SET(current_arg_list ${current_arg_list} ${arg})
90 SET(${prefix}_${current_arg_name} ${current_arg_list})
91 ENDMACRO(PARSE_ARGUMENTS)
93 #----------------------------------------------------------------------------
94 # SALOME_INSTALL_SCRIPTS is a macro useful for installing scripts.
96 # USAGE: SALOME_INSTALL_SCRIPTS(file_list path [WORKING_DIRECTORY dir] [DEF_PERMS])
99 # file_list: IN : list of files to be installed. This list should be quoted.
100 # path: IN : full pathname for installing.
102 # By default files to be installed as executable scripts.
103 # If DEF_PERMS option is provided, than permissions for installed files are
104 # only OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ.
105 #----------------------------------------------------------------------------
106 MACRO(SALOME_INSTALL_SCRIPTS file_list path)
107 PARSE_ARGUMENTS(SALOME_INSTALL_SCRIPTS "WORKING_DIRECTORY" "DEF_PERMS" ${ARGN})
108 SET(PERMS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
109 IF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
110 SET(PERMS ${PERMS} OWNER_EXECUTE GROUP_EXECUTE WORLD_EXECUTE)
111 ENDIF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
112 FOREACH(file ${file_list})
114 IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
115 SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
116 ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
117 INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
118 GET_FILENAME_COMPONENT(ext ${file} EXT)
120 INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${path}/${file}\")")
121 INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${path}/${file}')\")")
122 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
123 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
124 ENDIF(ext STREQUAL .py)
125 ENDFOREACH(file ${file_list})
126 ENDMACRO(SALOME_INSTALL_SCRIPTS)
128 #----------------------------------------------------------------------------
129 # SALOME_INSTALL_SCRIPTS is a macro useful for installing executable scripts.
131 # PYFILE2COMPINST: IN : list of python files to be installed.
132 # PYFILELOC: IN : full pathname for installing.
133 # Permissions of installed files: OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ
134 #----------------------------------------------------------------------------
135 MACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
136 INSTALL(CODE "SET(PYTHON_FILE ${f})")
137 FOREACH(input ${PYFILE2COMPINST})
138 GET_FILENAME_COMPONENT(inputname ${input} NAME)
139 INSTALL(FILES ${input} DESTINATION ${CMAKE_INSTALL_PREFIX}/${PYFILELOC})
140 INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}\")")
141 INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}')\")")
142 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
143 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
144 ENDFOREACH(input ${PYFILE2COMPINST})
145 ENDMACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
147 #----------------------------------------------------------------------------
148 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
149 # and modify its contents.
151 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
154 # in_file: IN : input file with full paths.
155 # out_file: IN : output file with full paths.
156 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
157 #----------------------------------------------------------------------------
158 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
159 MESSAGE(STATUS "Creation of ${OUT_FILE}")
160 CONFIGURE_FILE(${IN_FILE} ${OUT_FILE} @ONLY)
161 PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
162 IF(SALOME_CONFIGURE_FILE_INSTALL)
163 INSTALL(FILES ${OUT_FILE} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
164 ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
165 ENDMACRO(SALOME_CONFIGURE_FILE)
168 #######################################################################################
169 # Useful macros for SALOME own package detection system
173 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
174 # Check if two paths are identical, resolving links. If the paths do not exist a simple
175 # text comparison is performed.
176 # result is a boolean.
178 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
180 IF(EXISTS "${path1}")
181 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
183 SET(_tmp1 "${path1}")
186 IF(EXISTS "${path2}")
187 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
189 SET(_tmp2 "${path2}")
192 IF("${_tmp1}" STREQUAL "${_tmp2}")
195 # MESSAGE(${${varRes}})
200 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
202 # example: SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
204 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
205 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
206 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
208 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
209 # also handled properly.
211 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
212 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
213 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
214 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
217 # This macro is to be called from within the FindSalomeXXXX.cmake file.
220 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
221 SET(_OPT_ARG ${ARGV3})
222 # Only bother if the package was not already found:
223 # Some old packages use the lower case version - standard should be to always use
225 STRING(TOUPPER ${stdPkg} stdPkgUC)
226 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
227 IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
228 SET(_tmp_quiet "QUIET")
232 IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
233 SET(_tmp_req "REQUIRED")
237 IF(${englobPkg}_FIND_VERSION_EXACT)
238 SET(_tmp_exact "EXACT")
243 # Call the CMake FIND_PACKAGE() command:
244 STRING(TOLOWER ${stdPkg} _pkg_lc)
245 IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
246 # Hope to find direclty a CMake config file, indicating the SALOME CMake file
247 # paths (the command already look in places like "share/cmake", etc ... by default)
248 # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
249 # looking into a previous CMake build done via a GUI, or into the Win registry.
250 # See documentation of FIND_PACKAGE() for full details.
252 # Do we need to call the signature using components?
253 IF(${englobPkg}_FIND_COMPONENTS)
254 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
255 NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
256 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
257 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH)
259 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
260 NO_MODULE ${_tmp_quiet} ${_tmp_req}
261 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
262 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH)
264 MARK_AS_ADVANCED(${stdPkg}_DIR)
266 ELSEIF("${mode}" STREQUAL "MODULE")
268 # Do we need to call the signature using components?
269 IF(${englobPkg}_FIND_COMPONENTS)
270 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
271 MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
273 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
274 MODULE ${_tmp_quiet} ${_tmp_req})
279 MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
287 ####################################################################
288 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
289 # pkg : name of the system package to be detected
290 # referenceVariable: variable containing a path that can be browsed up to
291 # retrieve the package root directory (xxx_ROOT_DIR)
292 # upCount : number of times we have to go up from the path <referenceVariable>
293 # to obtain the package root directory.
295 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
297 # Generic detection (and conflict check) procedure for package XYZ:
298 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
299 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
301 # 2. Invoke FIND_PACKAGE() in this order:
302 # * in CONFIG mode first (if possible): priority is given to a potential
303 # "XYZ-config.cmake" file
304 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
305 # the above XYZ_ROOT_DIR variable
306 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
307 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
308 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
309 # 5. Conflict detection:
310 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
311 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
312 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
313 # conflict detection. This is added after the call to the macro by the callee.
315 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
320 # Package name, upper case
321 STRING(TOUPPER ${pkg} pkg_UC)
324 ## 1. Load environment or any previously detected root dir for the package
326 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
327 FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
328 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
330 # will be blank if no package was previously loaded:
331 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
334 # Detect if the variable has been set on the command line or elsewhere:
335 IF(DEFINED ${pkg_UC}_ROOT_DIR)
336 SET(_var_already_there TRUE)
338 SET(_var_already_there FALSE)
341 SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
344 ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
347 # Override the variable - don't append to it, as it would give precedence
348 # to what was stored there before!
349 SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
351 # Try find_package in config mode. This has the priority, but is
352 # performed QUIET and not REQUIRED:
353 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
355 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
356 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
359 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
360 # We do it quietly to produce our own error message:
361 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
363 # Set the "FOUND" variable for the SALOME wrapper:
364 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
365 SET(SALOME${pkg_UC}_FOUND TRUE)
367 SET(SALOME${pkg_UC}_FOUND FALSE)
368 IF(NOT Salome${pkg}_FIND_QUIETLY)
369 IF(Salome${pkg}_FIND_REQUIRED)
370 MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
371 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}")
373 MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
374 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}")
379 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
380 ## 3. Set the root dir which was finally retained by going up "upDir" times
381 ## from the given reference path. The variable "referenceVariable" may be a list.
382 ## In this case we take its first element.
384 # First test if the variable exists and is not empty:
385 IF((NOT DEFINED ${referenceVariable}) OR ("${${referenceVariable}}" STREQUAL ""))
386 MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
387 "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() does not exist or is empty.")
390 LIST(LENGTH ${referenceVariable} _tmp_len)
392 LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
394 # Note the double de-reference of "referenceVariable":
395 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
398 MATH(EXPR _rge "${upCount}-1")
399 FOREACH(_unused RANGE ${_rge})
400 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
405 ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
407 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
408 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
410 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
411 "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
412 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
415 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
418 IF(NOT _var_already_there)
419 MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
420 "An installation was found anyway: ${_tmp_ROOT_DIR}")
425 ## 5. Conflict detection
426 ## From another prerequisite using the package:
428 IF(${pkg_UC}_ROOT_DIR_EXP)
429 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
431 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
432 " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
434 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
439 ## 6. Save the detected installation
441 SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
444 MESSAGE(STATUS "${pkg} was not found.")
447 SET(Salome${pkg}_FOUND "${pkg}_FOUND")
448 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)