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)
128 GET_FILENAME_COMPONENT(single_dir ${CMAKE_CURRENT_SOURCE_DIR} 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)
153 ENDFOREACH(file ${file_list})
154 # Generate only one target for all requested Python script compilation.
155 # Make sure that the target name is unique too.
158 WHILE(TARGET "PYCOMPILE_${single_dir}_${_cnt}")
159 MATH(EXPR _cnt ${_cnt}+1)
161 ADD_CUSTOM_TARGET("PYCOMPILE_${single_dir}_${_cnt}" ALL DEPENDS ${_all_pyc} ${_all_pyo})
163 ENDMACRO(SALOME_INSTALL_SCRIPTS)
165 #----------------------------------------------------------------------------
166 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
167 # and modify its contents.
169 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
172 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
173 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
174 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
175 #----------------------------------------------------------------------------
176 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
177 IF(IS_ABSOLUTE ${IN_FILE})
178 SET(_in_file ${IN_FILE})
180 SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
182 IF(IS_ABSOLUTE ${OUT_FILE})
183 SET(_out_file ${OUT_FILE})
185 SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
187 MESSAGE(STATUS "Creation of ${_out_file}")
188 CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
189 PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
190 IF(SALOME_CONFIGURE_FILE_INSTALL)
191 INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
192 ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
193 ENDMACRO(SALOME_CONFIGURE_FILE)
196 #######################################################################################
197 # Useful macros for SALOME own package detection system
201 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
202 # Check if two paths are identical, resolving links. If the paths do not exist a simple
203 # text comparison is performed.
204 # result is a boolean.
206 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
208 IF(EXISTS "${path1}")
209 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
211 SET(_tmp1 "${path1}")
214 IF(EXISTS "${path2}")
215 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
217 SET(_tmp2 "${path2}")
220 IF("${_tmp1}" STREQUAL "${_tmp2}")
223 # MESSAGE(${${varRes}})
227 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
229 # Register in global variables the detection status (found or not) of the optional package 'pkg'
230 # and the configuration flag that should be turned off to avoid detection of the package.
231 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
232 # a summary report of the detection status and stops the process if necessary.
233 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
234 # Was the package found
235 STRING(TOUPPER ${pkg} _pkg_UC)
236 IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
242 # Is the package already in the list? Then update its status:
243 LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
244 IF(NOT ${_result} EQUAL -1)
245 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
246 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
247 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
248 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
250 # Otherwise insert it
251 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
252 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
253 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
256 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
259 # SALOME_JUSTIFY_STRING()
261 # Justifies the string specified as an argument to the given length
262 # adding required number of spaces to the end. Does noting if input
263 # string is longer as required length.
264 # Puts the result to the output variable.
266 # USAGE: SALOME_JUSTIFY_STRING(input length result)
269 # input [in] input string
270 # length [in] required length of resulting string
271 # result [out] name of variable where the result string is put to
273 MACRO(SALOME_JUSTIFY_STRING input length result)
274 SET(${result} ${input})
275 STRING(LENGTH ${input} _input_length)
276 MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
277 IF (_nb_spaces GREATER 0)
278 FOREACH(_idx RANGE ${_nb_spaces})
279 SET(${result} "${${result}} ")
282 ENDMACRO(SALOME_JUSTIFY_STRING)
285 # SALOME_PACKAGE_REPORT_AND_CHECK()
287 # Print a quick summary of the detection of optional prerequisites.
288 # If a package was not found, the configuration is stopped. The summary also indicates
289 # which flag should be turned off to skip the detection of the package.
291 # If optional JUSTIFY argument is specified, names of packages
292 # are left-justified to the given length; default value is 10.
294 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
296 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
298 PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
299 IF(SALOME_PACKAGE_REPORT_JUSTIFY)
300 SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
305 MESSAGE(STATUS " Optional packages - Detection report ")
306 MESSAGE(STATUS " ==================================== ")
308 IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
309 LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
310 # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
311 MATH(EXPR _range "${_list_len}-1")
312 FOREACH(_idx RANGE ${_range})
313 LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
314 LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
315 LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
316 SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
318 SET(_found_msg "Found")
322 SET(_found_msg "NOT Found")
323 SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
326 MESSAGE(STATUS " * ${_pkg_name} -> ${_found_msg}${_flag_msg}")
328 ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
332 # Failure if some packages were missing:
334 MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
336 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
339 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
341 # example: SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
343 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
344 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
345 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
347 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
348 # also handled properly.
350 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
351 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
352 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
353 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
356 # This macro is to be called from within the FindSalomeXXXX.cmake file.
359 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
360 SET(_OPT_ARG ${ARGV3})
361 # Only bother if the package was not already found:
362 # Some old packages use the lower case version - standard should be to always use
364 STRING(TOUPPER ${stdPkg} stdPkgUC)
365 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
366 IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
367 SET(_tmp_quiet "QUIET")
371 IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
372 SET(_tmp_req "REQUIRED")
376 IF(${englobPkg}_FIND_VERSION_EXACT)
377 SET(_tmp_exact "EXACT")
382 # Call the CMake FIND_PACKAGE() command:
383 STRING(TOLOWER ${stdPkg} _pkg_lc)
384 IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
385 # Hope to find direclty a CMake config file, indicating the SALOME CMake file
386 # paths (the command already looks in places like "share/cmake", etc ... by default)
387 # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
388 # looking into a previous CMake build done via a GUI, or into the Win registry.
389 # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
390 # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
391 # See documentation of FIND_PACKAGE() for full details.
393 # Do we need to call the signature using components?
394 IF(${englobPkg}_FIND_COMPONENTS)
395 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
396 NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
397 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
398 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
399 NO_SYSTEM_ENVIRONMENT_PATH)
401 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
402 NO_MODULE ${_tmp_quiet} ${_tmp_req}
403 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
404 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
405 NO_SYSTEM_ENVIRONMENT_PATH)
407 MARK_AS_ADVANCED(${stdPkg}_DIR)
409 ELSEIF("${mode}" STREQUAL "MODULE")
411 # Do we need to call the signature using components?
412 IF(${englobPkg}_FIND_COMPONENTS)
413 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
414 MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
416 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
417 MODULE ${_tmp_quiet} ${_tmp_req})
422 MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
430 ####################################################################
431 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
432 # pkg : name of the system package to be detected
433 # referenceVariable: variable containing a path that can be browsed up to
434 # retrieve the package root directory (xxx_ROOT_DIR)
435 # upCount : number of times we have to go up from the path <referenceVariable>
436 # to obtain the package root directory.
438 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
440 # Generic detection (and conflict check) procedure for package XYZ:
441 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
442 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
444 # 2. Invoke FIND_PACKAGE() in this order:
445 # * in CONFIG mode first (if possible): priority is given to a potential
446 # "XYZ-config.cmake" file
447 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
448 # the above XYZ_ROOT_DIR variable
449 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
450 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
451 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
452 # 5. Conflict detection:
453 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
454 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
455 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
456 # conflict detection. This is added after the call to the macro by the callee.
458 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
463 # Package name, upper case
464 STRING(TOUPPER ${pkg} pkg_UC)
467 ## 1. Load environment or any previously detected root dir for the package
469 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
470 FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
471 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
473 # will be blank if no package was previously loaded:
474 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
477 # Detect if the variable has been set on the command line or elsewhere:
478 IF(DEFINED ${pkg_UC}_ROOT_DIR)
479 SET(_var_already_there TRUE)
481 SET(_var_already_there FALSE)
484 SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
487 ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
490 # Override the variable - don't append to it, as it would give precedence
491 # to what was stored there before!
492 SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
494 # Try find_package in config mode. This has the priority, but is
495 # performed QUIET and not REQUIRED:
496 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
498 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
499 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
502 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
503 # We do it quietly to produce our own error message, except if we are in debug mode:
504 IF(SALOME_CMAKE_DEBUG)
505 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
507 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
510 # Set the "FOUND" variable for the SALOME wrapper:
511 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
512 SET(SALOME${pkg_UC}_FOUND TRUE)
514 SET(SALOME${pkg_UC}_FOUND FALSE)
515 IF(NOT Salome${pkg}_FIND_QUIETLY)
516 IF(Salome${pkg}_FIND_REQUIRED)
517 MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
518 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
519 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
521 MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
522 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
523 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
528 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
529 ## 3. Set the root dir which was finally retained by going up "upDir" times
530 ## from the given reference path. The variable "referenceVariable" may be a list.
531 ## In this case we take its first element.
533 # First test if the variable exists, warn otherwise:
534 IF(NOT DEFINED ${referenceVariable})
535 MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
536 "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
539 LIST(LENGTH ${referenceVariable} _tmp_len)
541 LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
543 # Note the double de-reference of "referenceVariable":
544 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
547 FOREACH(_unused RANGE 1 ${upCount})
548 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
553 ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
555 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
556 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
558 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
559 "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
560 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
563 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
566 IF(NOT _var_already_there)
567 MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
568 "An installation was found anyway: ${_tmp_ROOT_DIR}")
573 ## 5. Conflict detection
574 ## From another prerequisite using the package:
576 IF(${pkg_UC}_ROOT_DIR_EXP)
577 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
579 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
580 " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
582 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
587 ## 6. Save the detected installation
589 SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
592 MESSAGE(STATUS "${pkg} was not found.")
595 SET(Salome${pkg}_FOUND "${pkg}_FOUND")
596 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
599 ####################################################################
600 # SALOME_ADD_MPI_TO_HDF5()
602 # Overload the HDF5 flags so that they also contain MPI references.
603 # This is to be used when HDF5 was compiled with MPI support;
604 MACRO(SALOME_ADD_MPI_TO_HDF5)
605 SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
606 SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
607 SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
608 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
610 ####################################################################
612 # Convert a number (smaller than 16) into hexadecimal representation
614 MACRO(SALOME_TOHEXA num result)
615 SET(_hexa_map a b c d e f)
617 SET(${result} "0${num}")
619 MATH(EXPR _res "${num}-10" )
620 LIST(GET _hexa_map ${_res} _out)
621 SET(${result} "0${_out}")
623 ENDMACRO(SALOME_TOHEXA)
625 ####################################################################
628 # Computes hexadecimal version of SALOME package
630 # USAGE: SALOME_XVERSION(package)
634 # package: IN: SALOME package name
636 # The macro reads SALOME package version from PACKAGE_VERSION variable
637 # (note package name in uppercase as assumed for SALOME modules);
638 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
639 # major, minor and maintenance components of package version in
640 # hexadecimal form) is put to the PACKAGE_XVERSION variable
641 MACRO(SALOME_XVERSION pkg)
642 STRING(TOUPPER ${pkg} _pkg_UC)
643 IF(${_pkg_UC}_VERSION)
647 SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
648 SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
649 SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
650 SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
652 ENDMACRO(SALOME_XVERSION)
655 #########################################################################
656 # SALOME_ACCUMULATE_HEADERS()
658 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
659 # internally the list of include headers to be saved for future export.
660 # The full set of include is saved in a variable called
661 # _${PROJECT_NAME}_EXTRA_HEADERS
663 MACRO(SALOME_ACCUMULATE_HEADERS lst)
664 FOREACH(l IN LISTS ${lst})
665 LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
667 IF(NOT "${l}" STREQUAL "/usr/include")
668 LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
672 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
674 #########################################################################
675 # SALOME_ACCUMULATE_ENVIRONMENT()
677 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
680 # envvar [in] environment variable name, e.g. PATH
681 # value [in] value(s) to be added to environment variable
683 # This macro is called in the various FindSalomeXYZ.cmake modules to
684 # accumulate environment variables, to be used later to run some command
685 # in proper environment.
687 # 1. Each envrironment variable is stored in specific CMake variable
688 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
689 # 2. Full list of environment variable names is stored in CMake variable
690 # _${PROJECT_NAME}_EXTRA_ENV.
693 # - The arguments list can include optional CHECK or NOCHECK keywords:
694 # * For all arguments following CHECK keyword the macro perform an
695 # additional check (see below); this is the default mode, it is suitable
696 # for path variables (PATH, LD_LIBRARY_PATH, etc).
697 # * For all arguments following NOCHECK keyword, no additional check is
699 # Checking an argument means that we check:
700 # - That the path actually exists
701 # - That this is not a standard system path (starting with "/usr"); this avoids
702 # polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
704 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
706 FOREACH(_item ${ARGN})
707 IF(${_item} STREQUAL "NOCHECK")
709 ELSEIF(${_item} STREQUAL "CHECK")
713 IF(NOT IS_DIRECTORY ${_item})
715 GET_TARGET_PROPERTY(_item ${_item} LOCATION)
717 GET_FILENAME_COMPONENT(_item ${_item} PATH)
720 STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
721 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
722 IF(NOT _usr_find AND _res EQUAL -1)
723 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
727 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
729 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
735 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
737 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
739 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
740 FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
741 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_${PROJECT_NAME}_EXTRA_ENV_${_res}}\)")
743 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
745 #########################################################################
746 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
748 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
751 # output [out] output command, e.g. for creation of target.
752 # script [in] output environement script name
753 # cmd [in] input command, e.g. sphinx or python command.
754 # opts [in] options for input command (cmd).
756 # This macro is called when it's necessary to use given environment to run some command.
757 # Macro generates environement script using previously created variables
758 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
759 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
760 # and puts generated command in proper environment into <output> argument.
763 # - If <script> is specified as relative path, it is computed from the current build
766 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
767 IF(IS_ABSOLUTE ${script})
768 SET(_script ${script})
770 SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
775 SET(_call_cmd "call")
782 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
783 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
785 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
788 STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
790 SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
795 SET(_script ${_script}.${_ext})
796 FILE(WRITE ${_script} "${_env}")
798 SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
800 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
802 #########################################################################
803 # SALOME_GENERATE_TESTS_ENVIRONMENT()
805 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
808 # output [out] output environement variable.
810 # This macro generates <output> variable to use given environment to run some tests.
811 # Macro generates environement variable using previously created variables
812 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
813 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
814 # and puts this variable into <output> argument.
816 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
818 SET(_WIN_LD_LIBRARY OFF)
819 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
820 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
821 SET(_WIN_LD_LIBRARY ON)
824 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
826 STRING(REPLACE "/" "\\" _val "${_val}")
827 SET(_env_${_item} "${_val};${_env_${_item}}")
829 SET(_env_${_item} "${_val}:${_env_${_item}}")
834 IF(_WIN_LD_LIBRARY AND WIN32)
835 SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
844 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
846 IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
847 SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
850 STRING(REPLACE ";" ":" _iii "$ENV{${_item}}")
851 SET(_env "${_item}=${_iii}:${_env_${_item}}${sep}${_env}")
855 # Get module name as substring of "Salome<ModuleName>"
856 STRING(REGEX MATCH "^Salome" _is_salome_project ${PROJECT_NAME})
857 IF(_is_salome_project)
858 STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
860 SET(PRNAME ${PROJECT_NAME})
862 SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
864 # Creating follow string for Windows environement:
865 # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
867 STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
868 STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
871 SET(${output} "${_env}")
873 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
875 #########################################################################
876 # SALOME_APPEND_LIST_OF_LIST()
878 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
880 # Build a list of lists. The element_list is first parsed to convert it
886 # It is then added to the big list 'result'. Hence 'result' looks like:
887 # a,b,c,d,e;f,g,h; ...
889 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
891 STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
893 # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
894 STRING(LENGTH result _list_len)
895 IF(NOT _list_len EQUAL 0)
896 SET(${result} "${${result}}${_tmp_res};") # LIST(APPEND ...) doesn't handle well empty elements!?
898 SET(${result} "${_tmp_res};") # to avoid redundant ';' at the beginning of the list
901 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
903 #########################################################################
904 # SALOME_CONFIGURE_PREPARE()
906 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
908 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
910 # - _PREREQ_LIST : the list of level 1 external prerequisites
911 # - _PREREQ_DIR_LIST : their corresponding CMake directories (i.e. where the CMake configuration
912 # file for this package can be found, if there is any!)
913 # - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
915 # All this information is built from the package_list, the list of level 1 packages for this module.
916 # Only the packages found in CONFIG mode are retained.
918 MACRO(SALOME_CONFIGURE_PREPARE)
919 SET(_tmp_prereq "${ARGV}")
921 SET(_PREREQ_DIR_LIST)
922 SET(_PREREQ_COMPO_LIST)
923 FOREACH(_prereq IN LISTS _tmp_prereq)
925 SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
926 SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${${_prereq}_DIR}\"")
927 SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
930 ENDMACRO(SALOME_CONFIGURE_PREPARE)