1 # Copyright (C) 2012-2015 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, or (at your option) any later version.
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)
115 FOREACH(file ${file_list})
117 SET(_source_prefix "")
118 GET_FILENAME_COMPONENT(file_name ${file} NAME)
119 IF(NOT IS_ABSOLUTE ${file})
120 IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
121 SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
122 ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
123 SET(_source_prefix "${CMAKE_CURRENT_SOURCE_DIR}/")
124 ENDIF(NOT IS_ABSOLUTE ${file})
125 INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
126 GET_FILENAME_COMPONENT(ext ${file} EXT)
127 GET_FILENAME_COMPONENT(we_ext ${file} NAME_WE)
130 # Generate and install the pyc and pyo
131 # [ABN] Important: we avoid references or usage of CMAKE_INSTALL_PREFIX which is not correctly set
133 SET(_pyc_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.pyc")
134 SET(_pyo_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.pyo")
135 LIST(APPEND _all_pyc ${_pyc_file})
136 LIST(APPEND _all_pyo ${_pyo_file})
139 COMMAND ${PYTHON_EXECUTABLE} -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyc_file}' )"
140 DEPENDS ${PREFIX}${file}
145 COMMAND ${PYTHON_EXECUTABLE} -O -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyo_file}' )"
146 DEPENDS ${PREFIX}${file}
149 # Install the .pyo and the .pyc
150 INSTALL(FILES ${_pyc_file} DESTINATION ${path} PERMISSIONS ${PERMS})
151 INSTALL(FILES ${_pyo_file} DESTINATION ${path} PERMISSIONS ${PERMS})
152 ENDIF(ext STREQUAL .py)
154 # get relativa path (from CMAKE_SOURCE_DIR to CMAKE_CURRENT_SOURCE_DIR)
155 STRING(REGEX REPLACE ${CMAKE_SOURCE_DIR} "" rel_dir ${CMAKE_CURRENT_SOURCE_DIR})
158 STRING(REGEX REPLACE "/" "_" unique_name ${rel_dir})
163 ENDFOREACH(file ${file_list})
164 # Generate only one target for all requested Python script compilation.
165 # Make sure that the target name is unique too.
168 WHILE(TARGET "PYCOMPILE${unique_name}_${_cnt}")
169 MATH(EXPR _cnt ${_cnt}+1)
171 ADD_CUSTOM_TARGET("PYCOMPILE${unique_name}_${_cnt}" ALL DEPENDS ${_all_pyc} ${_all_pyo})
173 ENDMACRO(SALOME_INSTALL_SCRIPTS)
175 #----------------------------------------------------------------------------
176 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
177 # and modify its contents.
179 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
182 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
183 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
184 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
185 #----------------------------------------------------------------------------
186 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
187 IF(IS_ABSOLUTE ${IN_FILE})
188 SET(_in_file ${IN_FILE})
190 SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
192 IF(IS_ABSOLUTE ${OUT_FILE})
193 SET(_out_file ${OUT_FILE})
195 SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
197 MESSAGE(STATUS "Creation of ${_out_file}")
198 CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
199 PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
200 IF(SALOME_CONFIGURE_FILE_INSTALL)
201 INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
202 ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
203 ENDMACRO(SALOME_CONFIGURE_FILE)
206 #######################################################################################
207 # Useful macros for SALOME own package detection system
211 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
212 # Check if two paths are identical, resolving links. If the paths do not exist a simple
213 # text comparison is performed.
214 # result is a boolean.
216 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
218 IF(EXISTS "${path1}")
219 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
221 SET(_tmp1 "${path1}")
224 IF(EXISTS "${path2}")
225 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
227 SET(_tmp2 "${path2}")
230 IF("${_tmp1}" STREQUAL "${_tmp2}")
233 # MESSAGE(${${varRes}})
237 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
239 # Register in global variables the detection status (found or not) of the optional package 'pkg'
240 # and the configuration flag that should be turned off to avoid detection of the package.
241 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
242 # a summary report of the detection status and stops the process if necessary.
243 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
244 # Was the package found
245 STRING(TOUPPER ${pkg} _pkg_UC)
246 IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
252 # Is the package already in the list? Then update its status:
253 LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
254 IF(NOT ${_result} EQUAL -1)
255 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
256 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
257 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
258 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
260 # Otherwise insert it
261 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
262 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
263 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
266 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
269 # SALOME_JUSTIFY_STRING()
271 # Justifies the string specified as an argument to the given length
272 # adding required number of spaces to the end. Does noting if input
273 # string is longer as required length.
274 # Puts the result to the output variable.
276 # USAGE: SALOME_JUSTIFY_STRING(input length result)
279 # input [in] input string
280 # length [in] required length of resulting string
281 # result [out] name of variable where the result string is put to
283 MACRO(SALOME_JUSTIFY_STRING input length result)
284 SET(${result} ${input})
285 STRING(LENGTH ${input} _input_length)
286 MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
287 IF (_nb_spaces GREATER 0)
288 FOREACH(_idx RANGE ${_nb_spaces})
289 SET(${result} "${${result}} ")
292 ENDMACRO(SALOME_JUSTIFY_STRING)
295 # SALOME_PACKAGE_REPORT_AND_CHECK()
297 # Print a quick summary of the detection of optional prerequisites.
298 # If a package was not found, the configuration is stopped. The summary also indicates
299 # which flag should be turned off to skip the detection of the package.
301 # If optional JUSTIFY argument is specified, names of packages
302 # are left-justified to the given length; default value is 10.
304 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
306 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
308 PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
309 IF(SALOME_PACKAGE_REPORT_JUSTIFY)
310 SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
315 MESSAGE(STATUS " Optional packages - Detection report ")
316 MESSAGE(STATUS " ==================================== ")
318 IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
319 LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
320 # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
321 MATH(EXPR _range "${_list_len}-1")
322 FOREACH(_idx RANGE ${_range})
323 LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
324 LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
325 LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
326 SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
328 SET(_found_msg "Found")
332 SET(_found_msg "NOT Found")
333 SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
336 MESSAGE(STATUS " * ${_pkg_name} -> ${_found_msg}${_flag_msg}")
338 ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
342 # Failure if some packages were missing:
344 MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
346 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
349 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
351 # example: SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
353 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
354 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
355 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
357 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
358 # also handled properly.
360 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
361 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
362 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
363 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
366 # This macro is to be called from within the FindSalomeXXXX.cmake file.
369 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
370 SET(_OPT_ARG ${ARGV3})
371 # Only bother if the package was not already found:
372 # Some old packages use the lower case version - standard should be to always use
374 STRING(TOUPPER ${stdPkg} stdPkgUC)
375 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
376 IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
377 SET(_tmp_quiet "QUIET")
381 IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
382 SET(_tmp_req "REQUIRED")
386 IF(${englobPkg}_FIND_VERSION_EXACT)
387 SET(_tmp_exact "EXACT")
392 # Call the CMake FIND_PACKAGE() command:
393 STRING(TOLOWER ${stdPkg} _pkg_lc)
394 IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
395 # Hope to find direclty a CMake config file, indicating the SALOME CMake file
396 # paths (the command already looks in places like "share/cmake", etc ... by default)
397 # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
398 # looking into a previous CMake build done via a GUI, or into the Win registry.
399 # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
400 # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
401 # See documentation of FIND_PACKAGE() for full details.
403 # Do we need to call the signature using components?
404 IF(${englobPkg}_FIND_COMPONENTS)
405 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
406 NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
407 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
408 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
409 NO_SYSTEM_ENVIRONMENT_PATH)
411 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
412 NO_MODULE ${_tmp_quiet} ${_tmp_req}
413 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
414 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
415 NO_SYSTEM_ENVIRONMENT_PATH)
417 MARK_AS_ADVANCED(${stdPkg}_DIR)
419 ELSEIF("${mode}" STREQUAL "MODULE")
421 # Do we need to call the signature using components?
422 IF(${englobPkg}_FIND_COMPONENTS)
423 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
424 MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
426 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
427 MODULE ${_tmp_quiet} ${_tmp_req})
432 MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
440 ####################################################################
441 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
442 # pkg : name of the system package to be detected
443 # referenceVariable: variable containing a path that can be browsed up to
444 # retrieve the package root directory (xxx_ROOT_DIR)
445 # upCount : number of times we have to go up from the path <referenceVariable>
446 # to obtain the package root directory.
447 # If this is a path to a file, going up one time gives the directory containing the file
448 # going up 2 times gives the parent directory.
450 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
451 # with SWIG_EXECUTABLE set to '/usr/bin/swig'
452 # will produce '/usr'
454 # Generic detection (and conflict check) procedure for package XYZ:
455 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
456 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
458 # 2. Invoke FIND_PACKAGE() in this order:
459 # * in CONFIG mode first (if possible): priority is given to a potential
460 # "XYZ-config.cmake" file
461 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
462 # the above XYZ_ROOT_DIR variable
463 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
464 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
465 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
466 # 5. Conflict detection:
467 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
468 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
469 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
470 # conflict detection. This is added after the call to the macro by the callee.
472 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
477 # Package name, upper case
478 STRING(TOUPPER ${pkg} pkg_UC)
481 ## 1. Load environment or any previously detected root dir for the package
483 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
484 FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
485 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
487 # will be blank if no package was previously loaded:
488 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
491 # Detect if the variable has been set on the command line or elsewhere:
492 IF(DEFINED ${pkg_UC}_ROOT_DIR)
493 SET(_var_already_there TRUE)
495 SET(_var_already_there FALSE)
498 SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
501 ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
504 # Override the variable - don't append to it, as it would give precedence
505 # to what was stored there before!
506 SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
508 # Try find_package in config mode. This has the priority, but is
509 # performed QUIET and not REQUIRED:
510 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
512 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
513 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
516 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
517 # We do it quietly to produce our own error message, except if we are in debug mode:
518 IF(SALOME_CMAKE_DEBUG)
519 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
521 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
524 # Set the "FOUND" variable for the SALOME wrapper:
525 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
526 SET(SALOME${pkg_UC}_FOUND TRUE)
528 SET(SALOME${pkg_UC}_FOUND FALSE)
529 IF(NOT Salome${pkg}_FIND_QUIETLY)
530 IF(Salome${pkg}_FIND_REQUIRED)
531 MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
532 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
533 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
535 MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
536 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
537 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
542 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
543 ## 3. Set the root dir which was finally retained by going up "upDir" times
544 ## from the given reference path. The variable "referenceVariable" may be a list.
545 ## In this case we take its first element.
547 # First test if the variable exists, warn otherwise:
548 IF(NOT DEFINED ${referenceVariable})
549 MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
550 "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
553 LIST(LENGTH ${referenceVariable} _tmp_len)
555 LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
557 # Note the double de-reference of "referenceVariable":
558 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
561 FOREACH(_unused RANGE 1 ${upCount})
562 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
567 ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
569 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
570 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
572 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
573 "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
574 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
577 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
580 IF(NOT _var_already_there)
581 MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
582 "An installation was found anyway: ${_tmp_ROOT_DIR}")
587 ## 5. Conflict detection
588 ## From another prerequisite using the package:
590 IF(${pkg_UC}_ROOT_DIR_EXP)
591 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
593 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
594 " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
596 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
601 ## 6. Save the detected installation
603 SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
606 MESSAGE(STATUS "${pkg} was not found.")
609 SET(Salome${pkg}_FOUND "${pkg}_FOUND")
610 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
613 ####################################################################
614 # SALOME_ADD_MPI_TO_HDF5()
616 # Overload the HDF5 flags so that they also contain MPI references.
617 # This is to be used when HDF5 was compiled with MPI support;
618 MACRO(SALOME_ADD_MPI_TO_HDF5)
619 SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
620 SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
621 SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
622 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
624 ####################################################################
626 # Convert a number (smaller than 16) into hexadecimal representation
628 MACRO(SALOME_TOHEXA num result)
629 SET(_hexa_map a b c d e f)
631 SET(${result} "0${num}")
633 MATH(EXPR _res "${num}-10" )
634 LIST(GET _hexa_map ${_res} _out)
635 SET(${result} "0${_out}")
637 ENDMACRO(SALOME_TOHEXA)
639 ####################################################################
642 # Computes hexadecimal version of SALOME package
644 # USAGE: SALOME_XVERSION(package)
648 # package: IN: SALOME package name
650 # The macro reads SALOME package version from PACKAGE_VERSION variable
651 # (note package name in uppercase as assumed for SALOME modules);
652 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
653 # major, minor and maintenance components of package version in
654 # hexadecimal form) is put to the PACKAGE_XVERSION variable
655 MACRO(SALOME_XVERSION pkg)
656 STRING(TOUPPER ${pkg} _pkg_UC)
657 IF(${_pkg_UC}_VERSION)
661 SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
662 SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
663 SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
664 SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
666 ENDMACRO(SALOME_XVERSION)
669 #########################################################################
670 # SALOME_ACCUMULATE_HEADERS()
672 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
673 # internally the list of include headers to be saved for future export.
674 # The full set of include is saved in a variable called
675 # _${PROJECT_NAME}_EXTRA_HEADERS
677 MACRO(SALOME_ACCUMULATE_HEADERS lst)
678 FOREACH(l IN LISTS ${lst})
679 LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
681 IF(NOT "${l}" STREQUAL "/usr/include")
682 LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
686 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
688 #########################################################################
689 # SALOME_ACCUMULATE_ENVIRONMENT()
691 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
694 # envvar [in] environment variable name, e.g. PATH
695 # value [in] value(s) to be added to environment variable
697 # This macro is called in the various FindSalomeXYZ.cmake modules to
698 # accumulate environment variables, to be used later to run some command
699 # in proper environment.
701 # 1. Each envrironment variable is stored in specific CMake variable
702 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
703 # 2. Full list of environment variable names is stored in CMake variable
704 # _${PROJECT_NAME}_EXTRA_ENV.
707 # - The arguments list can include optional CHECK or NOCHECK keywords:
708 # * For all arguments following CHECK keyword the macro perform an
709 # additional check (see below); this is the default mode, it is suitable
710 # for path variables (PATH, LD_LIBRARY_PATH, etc).
711 # * For all arguments following NOCHECK keyword, no additional check is
713 # Checking an argument means that we check:
714 # - That the path actually exists
715 # - That this is not a standard system path (starting with "/usr"); this avoids
716 # polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
718 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
720 FOREACH(_item ${ARGN})
721 IF(${_item} STREQUAL "NOCHECK")
723 ELSEIF(${_item} STREQUAL "CHECK")
727 IF(NOT IS_DIRECTORY ${_item})
729 GET_TARGET_PROPERTY(_item ${_item} LOCATION)
731 GET_FILENAME_COMPONENT(_item ${_item} PATH)
734 STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
735 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
736 IF(NOT _usr_find AND _res EQUAL -1)
737 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
741 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
743 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
749 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
751 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
753 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
754 FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
755 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_${PROJECT_NAME}_EXTRA_ENV_${_res}}\)")
757 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
759 #########################################################################
760 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
762 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
765 # output [out] output command, e.g. for creation of target.
766 # script [in] output environement script name
767 # cmd [in] input command, e.g. sphinx or python command.
768 # opts [in] options for input command (cmd).
770 # This macro is called when it's necessary to use given environment to run some command.
771 # Macro generates environement script using previously created variables
772 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
773 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
774 # and puts generated command in proper environment into <output> argument.
777 # - If <script> is specified as relative path, it is computed from the current build
780 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
781 IF(IS_ABSOLUTE ${script})
782 SET(_script ${script})
784 SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
789 SET(_call_cmd "call")
796 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
797 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
799 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
802 STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
804 SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
809 SET(_script ${_script}.${_ext})
810 FILE(WRITE ${_script} "${_env}")
812 SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
814 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
816 #########################################################################
817 # SALOME_GENERATE_TESTS_ENVIRONMENT()
819 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
822 # output [out] output environement variable.
824 # This macro generates <output> variable to use given environment to run some tests.
825 # Macro generates environement variable using previously created variables
826 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
827 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
828 # and puts this variable into <output> argument.
830 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
832 SET(_WIN_LD_LIBRARY OFF)
833 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
834 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
835 SET(_WIN_LD_LIBRARY ON)
838 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
840 STRING(REPLACE "/" "\\" _val "${_val}")
841 SET(_env_${_item} "${_val};${_env_${_item}}")
843 SET(_env_${_item} "${_val}:${_env_${_item}}")
848 IF(_WIN_LD_LIBRARY AND WIN32)
849 SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
858 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
860 IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
861 SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
864 STRING(REPLACE ";" ":" _iii "$ENV{${_item}}")
865 SET(_env "${_item}=${_iii}:${_env_${_item}}${sep}${_env}")
869 # Get module name as substring of "Salome<ModuleName>"
870 STRING(REGEX MATCH "^Salome" _is_salome_project ${PROJECT_NAME})
871 IF(_is_salome_project)
872 STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
874 SET(PRNAME ${PROJECT_NAME})
876 SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
878 # Creating follow string for Windows environement:
879 # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
881 STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
882 STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
885 SET(${output} "${_env}")
887 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
889 #########################################################################
890 # SALOME_APPEND_LIST_OF_LIST()
892 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
894 # Build a list of lists. The element_list is first parsed to convert it
900 # It is then added to the big list 'result'. Hence 'result' looks like:
901 # a,b,c,d,e;f,g,h; ...
903 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
905 STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
907 # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
908 STRING(LENGTH result _list_len)
909 IF(NOT _list_len EQUAL 0)
910 SET(${result} "${${result}}${_tmp_res};") # LIST(APPEND ...) doesn't handle well empty elements!?
912 SET(${result} "${_tmp_res};") # to avoid redundant ';' at the beginning of the list
915 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
917 #########################################################################
918 # SALOME_CONFIGURE_PREPARE()
920 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
922 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
924 # - _PREREQ_LIST : the list of level 1 external prerequisites
925 # - _PREREQ_DIR_LIST : their corresponding CMake directories (i.e. where the CMake configuration
926 # file for this package can be found, if there is any!)
927 # - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
929 # All this information is built from the package_list, the list of level 1 packages for this module.
930 # Only the packages found in CONFIG mode are retained.
932 MACRO(SALOME_CONFIGURE_PREPARE)
933 SET(_tmp_prereq "${ARGV}")
935 SET(_PREREQ_DIR_LIST)
936 SET(_PREREQ_COMPO_LIST)
937 FOREACH(_prereq IN LISTS _tmp_prereq)
939 SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
940 SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${${_prereq}_DIR}\"")
941 SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
944 ENDMACRO(SALOME_CONFIGURE_PREPARE)