1 # Copyright (C) 2012-2014 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)
112 FOREACH(file ${file_list})
114 GET_FILENAME_COMPONENT(file_name ${file} NAME)
115 IF(NOT IS_ABSOLUTE ${file})
116 IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
117 SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
118 ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
119 ENDIF(NOT IS_ABSOLUTE ${file})
120 INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
121 GET_FILENAME_COMPONENT(ext ${file} EXT)
123 INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${path}/${file_name}\")")
124 INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${path}/${file_name}')\")")
125 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
126 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
127 ENDIF(ext STREQUAL .py)
128 ENDFOREACH(file ${file_list})
129 ENDMACRO(SALOME_INSTALL_SCRIPTS)
131 #----------------------------------------------------------------------------
132 # SALOME_INSTALL_SCRIPTS is a macro useful for installing executable scripts.
134 # PYFILE2COMPINST: IN : list of python files to be installed.
135 # PYFILELOC: IN : full pathname for installing.
136 # Permissions of installed files: OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ
137 #----------------------------------------------------------------------------
138 MACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
139 INSTALL(CODE "SET(PYTHON_FILE ${f})")
140 FOREACH(input ${PYFILE2COMPINST})
141 GET_FILENAME_COMPONENT(inputname ${input} NAME)
142 INSTALL(FILES ${input} DESTINATION ${CMAKE_INSTALL_PREFIX}/${PYFILELOC})
143 INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}\")")
144 INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}')\")")
145 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
146 INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
147 ENDFOREACH(input ${PYFILE2COMPINST})
148 ENDMACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
150 #----------------------------------------------------------------------------
151 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
152 # and modify its contents.
154 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
157 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
158 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
159 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
160 #----------------------------------------------------------------------------
161 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
162 IF(IS_ABSOLUTE ${IN_FILE})
163 SET(_in_file ${IN_FILE})
165 SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
167 IF(IS_ABSOLUTE ${OUT_FILE})
168 SET(_out_file ${OUT_FILE})
170 SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
172 MESSAGE(STATUS "Creation of ${_out_file}")
173 CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
174 PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
175 IF(SALOME_CONFIGURE_FILE_INSTALL)
176 INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
177 ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
178 ENDMACRO(SALOME_CONFIGURE_FILE)
181 #######################################################################################
182 # Useful macros for SALOME own package detection system
186 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
187 # Check if two paths are identical, resolving links. If the paths do not exist a simple
188 # text comparison is performed.
189 # result is a boolean.
191 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
193 IF(EXISTS "${path1}")
194 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
196 SET(_tmp1 "${path1}")
199 IF(EXISTS "${path2}")
200 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
202 SET(_tmp2 "${path2}")
205 IF("${_tmp1}" STREQUAL "${_tmp2}")
208 # MESSAGE(${${varRes}})
212 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
214 # Register in global variables the detection status (found or not) of the optional package 'pkg'
215 # and the configuration flag that should be turned off to avoid detection of the package.
216 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
217 # a summary report of the detection status and stops the process if necessary.
218 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
219 # Was the package found
220 STRING(TOUPPER ${pkg} _pkg_UC)
221 IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
227 # Is the package already in the list? Then update its status:
228 LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
229 IF(NOT ${_result} EQUAL -1)
230 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
231 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
232 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
233 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
235 # Otherwise insert it
236 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
237 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
238 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
241 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
244 # SALOME_JUSTIFY_STRING()
246 # Justifies the string specified as an argument to the given length
247 # adding required number of spaces to the end. Does noting if input
248 # string is longer as required length.
249 # Puts the result to the output variable.
251 # USAGE: SALOME_JUSTIFY_STRING(input length result)
254 # input [in] input string
255 # length [in] required length of resulting string
256 # result [out] name of variable where the result string is put to
258 MACRO(SALOME_JUSTIFY_STRING input length result)
259 SET(${result} ${input})
260 STRING(LENGTH ${input} _input_length)
261 MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
262 IF (_nb_spaces GREATER 0)
263 FOREACH(_idx RANGE ${_nb_spaces})
264 SET(${result} "${${result}} ")
267 ENDMACRO(SALOME_JUSTIFY_STRING)
270 # SALOME_PACKAGE_REPORT_AND_CHECK()
272 # Print a quick summary of the detection of optional prerequisites.
273 # If a package was not found, the configuration is stopped. The summary also indicates
274 # which flag should be turned off to skip the detection of the package.
276 # If optional JUSTIFY argument is specified, names of packages
277 # are left-justified to the given length; default value is 10.
279 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
281 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
283 PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
284 IF(SALOME_PACKAGE_REPORT_JUSTIFY)
285 SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
290 MESSAGE(STATUS " Optional packages - Detection report ")
291 MESSAGE(STATUS " ==================================== ")
293 IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
294 LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
295 # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
296 MATH(EXPR _range "${_list_len}-1")
297 FOREACH(_idx RANGE ${_range})
298 LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
299 LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
300 LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
301 SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
303 SET(_found_msg "Found")
307 SET(_found_msg "NOT Found")
308 SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
311 MESSAGE(STATUS " * ${_pkg_name} -> ${_found_msg}${_flag_msg}")
313 ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
317 # Failure if some packages were missing:
319 MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
321 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
324 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
326 # example: SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
328 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
329 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
330 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
332 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
333 # also handled properly.
335 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
336 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
337 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
338 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
341 # This macro is to be called from within the FindSalomeXXXX.cmake file.
344 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
345 SET(_OPT_ARG ${ARGV3})
346 # Only bother if the package was not already found:
347 # Some old packages use the lower case version - standard should be to always use
349 STRING(TOUPPER ${stdPkg} stdPkgUC)
350 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
351 IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
352 SET(_tmp_quiet "QUIET")
356 IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
357 SET(_tmp_req "REQUIRED")
361 IF(${englobPkg}_FIND_VERSION_EXACT)
362 SET(_tmp_exact "EXACT")
367 # Call the CMake FIND_PACKAGE() command:
368 STRING(TOLOWER ${stdPkg} _pkg_lc)
369 IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
370 # Hope to find direclty a CMake config file, indicating the SALOME CMake file
371 # paths (the command already looks in places like "share/cmake", etc ... by default)
372 # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
373 # looking into a previous CMake build done via a GUI, or into the Win registry.
374 # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
375 # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
376 # See documentation of FIND_PACKAGE() for full details.
378 # Do we need to call the signature using components?
379 IF(${englobPkg}_FIND_COMPONENTS)
380 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
381 NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
382 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
383 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
384 NO_SYSTEM_ENVIRONMENT_PATH)
386 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
387 NO_MODULE ${_tmp_quiet} ${_tmp_req}
388 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
389 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
390 NO_SYSTEM_ENVIRONMENT_PATH)
392 MARK_AS_ADVANCED(${stdPkg}_DIR)
394 ELSEIF("${mode}" STREQUAL "MODULE")
396 # Do we need to call the signature using components?
397 IF(${englobPkg}_FIND_COMPONENTS)
398 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
399 MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
401 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
402 MODULE ${_tmp_quiet} ${_tmp_req})
407 MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
415 ####################################################################
416 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
417 # pkg : name of the system package to be detected
418 # referenceVariable: variable containing a path that can be browsed up to
419 # retrieve the package root directory (xxx_ROOT_DIR)
420 # upCount : number of times we have to go up from the path <referenceVariable>
421 # to obtain the package root directory.
423 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
425 # Generic detection (and conflict check) procedure for package XYZ:
426 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
427 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
429 # 2. Invoke FIND_PACKAGE() in this order:
430 # * in CONFIG mode first (if possible): priority is given to a potential
431 # "XYZ-config.cmake" file
432 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
433 # the above XYZ_ROOT_DIR variable
434 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
435 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
436 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
437 # 5. Conflict detection:
438 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
439 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
440 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
441 # conflict detection. This is added after the call to the macro by the callee.
443 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
448 # Package name, upper case
449 STRING(TOUPPER ${pkg} pkg_UC)
452 ## 1. Load environment or any previously detected root dir for the package
454 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
455 FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
456 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
458 # will be blank if no package was previously loaded:
459 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
462 # Detect if the variable has been set on the command line or elsewhere:
463 IF(DEFINED ${pkg_UC}_ROOT_DIR)
464 SET(_var_already_there TRUE)
466 SET(_var_already_there FALSE)
468 # Make cache entry, giving precedence to the env variable
469 SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory" FORCE)
472 ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
475 # Override the variable - don't append to it, as it would give precedence
476 # to what was stored there before!
477 SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
479 # Try find_package in config mode. This has the priority, but is
480 # performed QUIET and not REQUIRED:
481 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
483 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
484 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
487 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
488 # We do it quietly to produce our own error message, except if we are in debug mode:
489 IF(SALOME_CMAKE_DEBUG)
490 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
492 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
495 # Set the "FOUND" variable for the SALOME wrapper:
496 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
497 SET(SALOME${pkg_UC}_FOUND TRUE)
499 SET(SALOME${pkg_UC}_FOUND FALSE)
500 IF(NOT Salome${pkg}_FIND_QUIETLY)
501 IF(Salome${pkg}_FIND_REQUIRED)
502 MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
503 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
504 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
506 MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
507 "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR} "
508 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
513 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
514 ## 3. Set the root dir which was finally retained by going up "upDir" times
515 ## from the given reference path. The variable "referenceVariable" may be a list.
516 ## In this case we take its first element.
518 # First test if the variable exists, warn otherwise:
519 IF(NOT DEFINED ${referenceVariable})
520 MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
521 "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
524 LIST(LENGTH ${referenceVariable} _tmp_len)
526 LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
528 # Note the double de-reference of "referenceVariable":
529 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
532 FOREACH(_unused RANGE 1 ${upCount})
533 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
538 ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
540 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
541 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
543 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
544 "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
545 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
548 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
551 IF(NOT _var_already_there)
552 MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
553 "An installation was found anyway: ${_tmp_ROOT_DIR}")
558 ## 5. Conflict detection
559 ## From another prerequisite using the package:
561 IF(${pkg_UC}_ROOT_DIR_EXP)
562 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
564 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
565 " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
567 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
572 ## 6. Save the detected installation
574 SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
577 MESSAGE(STATUS "${pkg} was not found.")
580 SET(Salome${pkg}_FOUND "${pkg}_FOUND")
581 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
584 ####################################################################
585 # SALOME_ADD_MPI_TO_HDF5()
587 # Overload the HDF5 flags so that they also contain MPI references.
588 # This is to be used when HDF5 was compiled with MPI support;
589 MACRO(SALOME_ADD_MPI_TO_HDF5)
590 SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
591 SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
592 SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
593 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
595 ####################################################################
597 # Convert a number (smaller than 16) into hexadecimal representation
599 MACRO(SALOME_TOHEXA num result)
600 SET(_hexa_map a b c d e f)
602 SET(${result} "0${num}")
604 MATH(EXPR _res "${num}-10" )
605 LIST(GET _hexa_map ${_res} _out)
606 SET(${result} "0${_out}")
608 ENDMACRO(SALOME_TOHEXA)
610 ####################################################################
613 # Computes hexadecimal version of SALOME package
615 # USAGE: SALOME_XVERSION(package)
619 # package: IN: SALOME package name
621 # The macro reads SALOME package version from PACKAGE_VERSION variable
622 # (note package name in uppercase as assumed for SALOME modules);
623 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
624 # major, minor and maintenance components of package version in
625 # hexadecimal form) is put to the PACKAGE_XVERSION variable
626 MACRO(SALOME_XVERSION pkg)
627 STRING(TOUPPER ${pkg} _pkg_UC)
628 IF(${_pkg_UC}_VERSION)
632 SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
633 SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
634 SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
635 SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
637 ENDMACRO(SALOME_XVERSION)
640 #########################################################################
641 # SALOME_ACCUMULATE_HEADERS()
643 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
644 # internally the list of include headers to be saved for future export.
645 # The full set of include is saved in a variable called
646 # _${PROJECT_NAME}_EXTRA_HEADERS
648 MACRO(SALOME_ACCUMULATE_HEADERS lst)
649 FOREACH(l IN LISTS ${lst})
650 LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
652 IF(NOT "${l}" STREQUAL "/usr/include")
653 LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
657 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
659 #########################################################################
660 # SALOME_ACCUMULATE_ENVIRONMENT()
662 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
665 # envvar [in] environment variable name, e.g. PATH
666 # value [in] value(s) to be added to environment variable
668 # This macro is called in the various FindSalomeXYZ.cmake modules to
669 # accumulate environment variables, to be used later to run some command
670 # in proper environment.
672 # 1. Each envrironment variable is stored in specific CMake variable
673 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
674 # 2. Full list of environment variable names is stored in CMake variable
675 # _${PROJECT_NAME}_EXTRA_ENV.
678 # - The arguments list can include optional CHECK or NOCHECK keywords:
679 # * For all arguments following CHECK keyword the macro perform an
680 # additional check (see below); this is the default mode, it is suitable
681 # for path variables (PATH, LD_LIBRARY_PATH, etc).
682 # * For all arguments following NOCHECK keyword, no additional check is
684 # Checking an argument means that we check:
685 # - That the path actually exists
686 # - That this is not a standard system path (starting with "/usr"); this avoids
687 # polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
689 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
691 FOREACH(_item ${ARGN})
692 IF(${_item} STREQUAL "NOCHECK")
694 ELSEIF(${_item} STREQUAL "CHECK")
698 IF(NOT IS_DIRECTORY ${_item})
700 GET_TARGET_PROPERTY(_item ${_item} LOCATION)
702 GET_FILENAME_COMPONENT(_item ${_item} PATH)
705 STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
706 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
707 IF(NOT _usr_find AND _res EQUAL -1)
708 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
712 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
714 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
720 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
722 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
724 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
725 FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
726 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_${PROJECT_NAME}_EXTRA_ENV_${_res}}\)")
728 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
730 #########################################################################
731 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
733 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
736 # output [out] output command, e.g. for creation of target.
737 # script [in] output environement script name
738 # cmd [in] input command, e.g. sphinx or python command.
739 # opts [in] options for input command (cmd).
741 # This macro is called when it's necessary to use given environment to run some command.
742 # Macro generates environement script using previously created variables
743 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
744 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
745 # and puts generated command in proper environment into <output> argument.
748 # - If <script> is specified as relative path, it is computed from the current build
751 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
752 IF(IS_ABSOLUTE ${script})
753 SET(_script ${script})
755 SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
760 SET(_call_cmd "call")
767 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
768 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
770 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
773 STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
775 SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
780 SET(_script ${_script}.${_ext})
781 FILE(WRITE ${_script} "${_env}")
783 SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
785 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
787 #########################################################################
788 # SALOME_GENERATE_TESTS_ENVIRONMENT()
790 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
793 # output [out] output environement variable.
795 # This macro generates <output> variable to use given environment to run some tests.
796 # Macro generates environement variable using previously created variables
797 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
798 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
799 # and puts this variable into <output> argument.
801 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
803 SET(_WIN_LD_LIBRARY OFF)
804 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
805 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
806 SET(_WIN_LD_LIBRARY ON)
809 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
811 STRING(REPLACE "/" "\\" _val "${_val}")
812 SET(_env_${_item} "${_val};${_env_${_item}}")
814 SET(_env_${_item} "${_val}:${_env_${_item}}")
819 IF(_WIN_LD_LIBRARY AND WIN32)
820 SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
829 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
831 IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
832 SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
835 SET(_env "${_item}=$ENV{${_item}}:${_env_${_item}}${sep}${_env}")
839 # Get module name as substring of "Salome<ModuleName>"
840 STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
841 SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
843 # Creating follow string for Windows environement:
844 # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
846 STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
847 STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
850 SET(${output} "${_env}")
852 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
854 #########################################################################
855 # SALOME_APPEND_LIST_OF_LIST()
857 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
859 # Build a list of lists. The element_list is first parsed to convert it
865 # It is then added to the big list 'result'. Hence 'result' looks like:
866 # a,b,c,d,e;f,g,h; ...
868 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
870 STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
872 # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
873 STRING(LENGTH result _list_len)
874 IF(NOT _list_len EQUAL 0)
875 SET(${result} "${${result}}${_tmp_res};") # LIST(APPEND ...) doesn't handle well empty elements!?
877 SET(${result} "${_tmp_res};") # to avoid redundant ';' at the beginning of the list
880 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
882 #########################################################################
883 # SALOME_CONFIGURE_PREPARE()
885 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
887 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
889 # - _PREREQ_LIST : the list of level 1 external prerequisites
890 # - _PREREQ_DIR_LIST : their corresponding CMake directories (i.e. where the CMake configuration
891 # file for this package can be found, if there is any!)
892 # - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
894 # All this information is built from the package_list, the list of level 1 packages for this module.
895 # Only the packages found in CONFIG mode are retained.
897 MACRO(SALOME_CONFIGURE_PREPARE)
898 SET(_tmp_prereq "${ARGV}")
900 SET(_PREREQ_DIR_LIST)
901 SET(_PREREQ_COMPO_LIST)
902 FOREACH(_prereq IN LISTS _tmp_prereq)
904 SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
905 SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${${_prereq}_DIR}\"")
906 SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
909 ENDMACRO(SALOME_CONFIGURE_PREPARE)