adm/cmake/SalomeMacros.cmake

   1 # Copyright (C) 2012-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   2 #
   3 # This library is free software; you can redistribute it and/or
   4 # modify it under the terms of the GNU Lesser General Public
   5 # License as published by the Free Software Foundation; either
   6 # version 2.1 of the License, or (at your option) any later version.
   7 #
   8 # This library is distributed in the hope that it will be useful,
   9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 # Lesser General Public License for more details.
  12 #
  13 # You should have received a copy of the GNU Lesser General Public
  14 # License along with this library; if not, write to the Free Software
  15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 #
  17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 #
  19 # Author: A.Geay, V. Sandler, A. Bruneton
  20 #
  21
  22 #----------------------------------------------------------------------------
  23 # LIST_CONTAINS is a macro useful for determining whether a list has a
  24 # particular entry
  25 #----------------------------------------------------------------------------
  26 MACRO(LIST_CONTAINS var value)
  27   SET(${var})
  28   FOREACH(value2 ${ARGN})
  29     IF(${value} STREQUAL "${value2}")
  30       SET(${var} TRUE)
  31     ENDIF (${value} STREQUAL "${value2}")
  32   ENDFOREACH (value2)
  33 ENDMACRO(LIST_CONTAINS)
  34
  35 #----------------------------------------------------------------------------
  36 # The PARSE_ARGUMENTS macro will take the arguments of another macro and
  37 # define several variables.
  38 #
  39 # USAGE:  PARSE_ARGUMENTS(prefix arg_names options arg1 arg2...)
  40 #
  41 # ARGUMENTS:
  42 #
  43 # prefix: IN: a prefix to put on all variables it creates.
  44 #
  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.
  53 #
  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
  60 # or false otherwise.
  61 # arg_names and options lists should be quoted.
  62 #
  63 # The rest of PARSE_ARGUMENTS are arguments from another macro to be parsed.
  64 #----------------------------------------------------------------------------
  65 MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
  66   SET(DEFAULT_ARGS)
  67   FOREACH(arg_name ${arg_names})
  68     SET(${prefix}_${arg_name})
  69   ENDFOREACH(arg_name)
  70   FOREACH(option ${option_names})
  71     SET(${prefix}_${option} FALSE)
  72   ENDFOREACH(option)
  73   SET(current_arg_name DEFAULT_ARGS)
  74   SET(current_arg_list)
  75   FOREACH(arg ${ARGN})
  76     LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
  77     IF (is_arg_name)
  78       SET(${prefix}_${current_arg_name} ${current_arg_list})
  79       SET(current_arg_name ${arg})
  80       SET(current_arg_list)
  81     ELSE (is_arg_name)
  82       LIST_CONTAINS(is_option ${arg} ${option_names})
  83       IF (is_option)
  84       SET(${prefix}_${arg} TRUE)
  85       ELSE (is_option)
  86       SET(current_arg_list ${current_arg_list} ${arg})
  87       ENDIF (is_option)
  88     ENDIF (is_arg_name)
  89   ENDFOREACH(arg)
  90   SET(${prefix}_${current_arg_name} ${current_arg_list})
  91 ENDMACRO(PARSE_ARGUMENTS)
  92
  93 #----------------------------------------------------------------------------
  94 # SALOME_INSTALL_SCRIPTS is a macro useful for installing scripts.
  95 #
  96 # USAGE: SALOME_INSTALL_SCRIPTS(file_list path [WORKING_DIRECTORY dir] [DEF_PERMS])
  97 #
  98 # ARGUMENTS:
  99 # file_list: IN : list of files to be installed. This list should be quoted.
 100 # path: IN : full pathname for installing.
 101 #
 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   SET(_all_pyc)
 113   SET(_all_pyo)
 114   SET(_all_subdirs)
 115   FOREACH(file ${file_list})
 116     SET(PREFIX "")
 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
 129     IF(ext STREQUAL .py)
 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
 132       # when using CPack.
 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})
 137       ADD_CUSTOM_COMMAND(
 138            OUTPUT ${_pyc_file}
 139            COMMAND ${PYTHON_EXECUTABLE} -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyc_file}' )"
 140            DEPENDS ${PREFIX}${file}
 141            VERBATIM
 142        )
 143       ADD_CUSTOM_COMMAND(
 144            OUTPUT ${_pyo_file}
 145            COMMAND ${PYTHON_EXECUTABLE} -O -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyo_file}' )"
 146            DEPENDS ${PREFIX}${file}
 147            VERBATIM
 148        )
 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
 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})
 156   # convert "/" to "_"
 157   STRING(REGEX REPLACE "/" "_" unique_name ${rel_dir})
 158
 159   ENDFOREACH(file ${file_list})
 160   # Generate only one target for all requested Python script compilation.
 161   # Make sure that the target name is unique too.
 162   IF(_all_pyc)
 163      SET(_cnt 0)
 164      WHILE(TARGET "PYCOMPILE${unique_name}_${_cnt}")
 165        MATH(EXPR _cnt ${_cnt}+1)
 166      ENDWHILE()
 167      ADD_CUSTOM_TARGET("PYCOMPILE${unique_name}_${_cnt}" ALL DEPENDS ${_all_pyc} ${_all_pyo})
 168   ENDIF()
 169 ENDMACRO(SALOME_INSTALL_SCRIPTS)
 170
 171 #----------------------------------------------------------------------------
 172 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
 173 # and modify its contents.
 174 #
 175 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
 176 #
 177 # ARGUMENTS:
 178 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
 179 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
 180 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
 181 #----------------------------------------------------------------------------
 182 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
 183   IF(IS_ABSOLUTE ${IN_FILE})
 184     SET(_in_file ${IN_FILE})
 185   ELSE()
 186     SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
 187   ENDIF()
 188   IF(IS_ABSOLUTE  ${OUT_FILE})
 189     SET(_out_file ${OUT_FILE})
 190   ELSE()
 191     SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
 192   ENDIF()
 193   MESSAGE(STATUS "Creation of ${_out_file}")
 194   CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
 195   PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
 196   IF(SALOME_CONFIGURE_FILE_INSTALL)
 197     INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
 198   ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
 199 ENDMACRO(SALOME_CONFIGURE_FILE)
 200
 201
 202 #######################################################################################
 203 # Useful macros for SALOME own package detection system
 204 #
 205
 206 ###
 207 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
 208 #  Check if two paths are identical, resolving links. If the paths do not exist a simple
 209 #  text comparison is performed.
 210 #  result is a boolean.
 211 ###
 212 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
 213   SET("${varRes}" OFF)
 214   IF(EXISTS "${path1}")
 215     GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
 216   ELSE()
 217     SET(_tmp1 "${path1}")
 218   ENDIF()
 219
 220   IF(EXISTS "${path2}")
 221     GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
 222   ELSE()
 223     SET(_tmp2 "${path2}")
 224   ENDIF()
 225
 226   IF("${_tmp1}" STREQUAL "${_tmp2}")
 227     SET("${varRes}" ON)
 228   ENDIF()
 229 #  MESSAGE(${${varRes}})
 230 ENDMACRO()
 231
 232 ####
 233 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
 234 #
 235 # Register in global variables the detection status (found or not) of the optional package 'pkg'
 236 # and the configuration flag that should be turned off to avoid detection of the package.
 237 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
 238 # a summary report of the detection status and stops the process if necessary.
 239 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
 240   # Was the package found
 241   STRING(TOUPPER ${pkg} _pkg_UC)
 242   IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
 243     SET(_isFound TRUE)
 244   ELSE()
 245     SET(_isFound FALSE)
 246   ENDIF()
 247
 248   # Is the package already in the list? Then update its status:
 249   LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
 250   IF(NOT ${_result} EQUAL -1)
 251     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
 252     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
 253     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
 254     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
 255   ELSE()
 256     # Otherwise insert it
 257     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
 258     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
 259     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
 260   ENDIF()
 261
 262 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
 263
 264 ####
 265 # SALOME_JUSTIFY_STRING()
 266 #
 267 # Justifies the string specified as an argument to the given length
 268 # adding required number of spaces to the end. Does noting if input
 269 # string is longer as required length.
 270 # Puts the result to the output variable.
 271 #
 272 # USAGE: SALOME_JUSTIFY_STRING(input length result)
 273 #
 274 # ARGUMENTS:
 275 #   input  [in] input string
 276 #   length [in] required length of resulting string
 277 #   result [out] name of variable where the result string is put to
 278 #
 279 MACRO(SALOME_JUSTIFY_STRING input length result)
 280   SET(${result} ${input})
 281   STRING(LENGTH ${input} _input_length)
 282   MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
 283   IF (_nb_spaces GREATER 0)
 284     FOREACH(_idx RANGE ${_nb_spaces})
 285       SET(${result} "${${result}} ")
 286     ENDFOREACH()
 287   ENDIF()
 288 ENDMACRO(SALOME_JUSTIFY_STRING)
 289
 290 ####
 291 # SALOME_PACKAGE_REPORT_AND_CHECK()
 292 #
 293 # Print a quick summary of the detection of optional prerequisites.
 294 # If a package was not found, the configuration is stopped. The summary also indicates
 295 # which flag should be turned off to skip the detection of the package.
 296 #
 297 # If optional JUSTIFY argument is specified, names of packages
 298 # are left-justified to the given length; default value is 10.
 299 #
 300 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
 301 #
 302 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 303   SET(_will_fail OFF)
 304   PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
 305   IF(SALOME_PACKAGE_REPORT_JUSTIFY)
 306     SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
 307   ELSE()
 308     SET(_length 23)
 309   ENDIF()
 310   MESSAGE(STATUS "")
 311   MESSAGE(STATUS "  Optional packages - Detection report ")
 312   MESSAGE(STATUS "  ==================================== ")
 313   MESSAGE(STATUS "")
 314   IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 315     LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
 316     # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
 317     MATH(EXPR _range "${_list_len}-1")
 318     FOREACH(_idx RANGE ${_range})
 319       LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
 320       LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
 321       LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
 322       SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
 323       IF(_pkg_found)
 324         SET(_found_msg "Found")
 325         SET(_flag_msg "")
 326       ELSE()
 327         SET(_will_fail ON)
 328         SET(_found_msg "NOT Found")
 329         SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
 330       ENDIF()
 331
 332       MESSAGE(STATUS "  * ${_pkg_name}  ->  ${_found_msg}${_flag_msg}")
 333     ENDFOREACH()
 334   ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 335   MESSAGE(STATUS "")
 336   MESSAGE(STATUS "")
 337
 338   # Failure if some packages were missing:
 339   IF(_will_fail)
 340     MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
 341   ENDIF()
 342 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 343
 344 ####
 345 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
 346 #
 347 # example:  SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
 348 #
 349 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
 350 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
 351 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
 352 #
 353 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
 354 # also handled properly.
 355 #
 356 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
 357 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
 358 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
 359 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
 360 # example).
 361 #
 362 # This macro is to be called from within the FindSalomeXXXX.cmake file.
 363 #
 364 ####
 365 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
 366   SET(_OPT_ARG ${ARGV3})
 367   # Only bother if the package was not already found:
 368   # Some old packages use the lower case version - standard should be to always use
 369   # upper case:
 370   STRING(TOUPPER ${stdPkg} stdPkgUC)
 371   IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
 372     IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
 373       SET(_tmp_quiet "QUIET")
 374     ELSE()
 375       SET(_tmp_quiet)
 376     ENDIF()
 377     IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
 378       SET(_tmp_req "REQUIRED")
 379     ELSE()
 380       SET(_tmp_req)
 381     ENDIF()
 382     IF(${englobPkg}_FIND_VERSION_EXACT)
 383       SET(_tmp_exact "EXACT")
 384     ELSE()
 385       SET(_tmp_exact)
 386     ENDIF()
 387
 388     # Call the CMake FIND_PACKAGE() command:
 389     STRING(TOLOWER ${stdPkg} _pkg_lc)
 390     IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
 391       # Hope to find direclty a CMake config file, indicating the SALOME CMake file
 392       # paths (the command already looks in places like "share/cmake", etc ... by default)
 393       # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
 394       # looking into a previous CMake build done via a GUI, or into the Win registry.
 395       # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
 396       # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
 397       # See documentation of FIND_PACKAGE() for full details.
 398
 399       # Do we need to call the signature using components?
 400       IF(${englobPkg}_FIND_COMPONENTS)
 401         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 402               NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
 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)
 406       ELSE()
 407         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 408               NO_MODULE ${_tmp_quiet} ${_tmp_req}
 409               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
 410               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 411                  NO_SYSTEM_ENVIRONMENT_PATH)
 412       ENDIF()
 413       MARK_AS_ADVANCED(${stdPkg}_DIR)
 414
 415     ELSEIF("${mode}" STREQUAL "MODULE")
 416
 417       # Do we need to call the signature using components?
 418       IF(${englobPkg}_FIND_COMPONENTS)
 419         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 420               MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
 421       ELSE()
 422         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 423               MODULE ${_tmp_quiet} ${_tmp_req})
 424       ENDIF()
 425
 426     ELSE()
 427
 428       MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
 429
 430     ENDIF()
 431
 432   ENDIF()
 433 ENDMACRO()
 434
 435
 436 ####################################################################
 437 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
 438 #    pkg              : name of the system package to be detected
 439 #    referenceVariable: variable containing a path that can be browsed up to
 440 # retrieve the package root directory (xxx_ROOT_DIR)
 441 #    upCount          : number of times we have to go up from the path <referenceVariable>
 442 # to obtain the package root directory.
 443 #
 444 # For example:  SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
 445 #
 446 # Generic detection (and conflict check) procedure for package XYZ:
 447 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
 448 #    If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
 449 # directly on XYZ)
 450 # 2. Invoke FIND_PACKAGE() in this order:
 451 #    * in CONFIG mode first (if possible): priority is given to a potential
 452 #    "XYZ-config.cmake" file
 453 #    * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
 454 # the above XYZ_ROOT_DIR variable
 455 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
 456 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
 457 #    instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
 458 # 5. Conflict detection:
 459 #    * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
 460 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
 461 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
 462 # conflict detection. This is added after the call to the macro by the callee.
 463 #
 464 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
 465   ##
 466   ## 0. Initialization
 467   ##
 468
 469   # Package name, upper case
 470   STRING(TOUPPER ${pkg} pkg_UC)
 471
 472   ##
 473   ## 1. Load environment or any previously detected root dir for the package
 474   ##
 475   IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 476     FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
 477     SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
 478   ELSE()
 479     # will be blank if no package was previously loaded:
 480     SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
 481   ENDIF()
 482
 483   # Detect if the variable has been set on the command line or elsewhere:
 484   IF(DEFINED ${pkg_UC}_ROOT_DIR)
 485      SET(_var_already_there TRUE)
 486   ELSE()
 487      SET(_var_already_there FALSE)
 488   ENDIF()
 489   #   Make cache entry
 490   SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
 491
 492   ##
 493   ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
 494   ##
 495
 496   # Override the variable - don't append to it, as it would give precedence
 497   # to what was stored there before!
 498   SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
 499
 500   # Try find_package in config mode. This has the priority, but is
 501   # performed QUIET and not REQUIRED:
 502   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
 503
 504   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 505     MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
 506   ENDIF()
 507
 508   # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
 509   # We do it quietly to produce our own error message, except if we are in debug mode:
 510   IF(SALOME_CMAKE_DEBUG)
 511     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
 512   ELSE()
 513     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
 514   ENDIF()
 515
 516   # Set the "FOUND" variable for the SALOME wrapper:
 517   IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
 518     SET(SALOME${pkg_UC}_FOUND TRUE)
 519   ELSE()
 520     SET(SALOME${pkg_UC}_FOUND FALSE)
 521     IF(NOT Salome${pkg}_FIND_QUIETLY)
 522       IF(Salome${pkg}_FIND_REQUIRED)
 523          MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 524          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}  "
 525          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 526       ELSE()
 527          MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 528          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}  "
 529          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 530       ENDIF()
 531     ENDIF()
 532   ENDIF()
 533
 534   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 535     ## 3. Set the root dir which was finally retained by going up "upDir" times
 536     ## from the given reference path. The variable "referenceVariable" may be a list.
 537     ## In this case we take its first element.
 538
 539     # First test if the variable exists, warn otherwise:
 540     IF(NOT DEFINED ${referenceVariable})
 541       MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
 542       "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
 543     ENDIF()
 544
 545     LIST(LENGTH ${referenceVariable} _tmp_len)
 546     IF(_tmp_len)
 547        LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
 548     ELSE()
 549        #  Note the double de-reference of "referenceVariable":
 550        SET(_tmp_ROOT_DIR "${${referenceVariable}}")
 551     ENDIF()
 552     IF(${upCount})
 553       FOREACH(_unused RANGE 1 ${upCount})
 554         GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 555       ENDFOREACH()
 556     ENDIF()
 557
 558     ##
 559     ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 560     ##
 561     IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 562       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
 563       IF(NOT _res)
 564         MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
 565             "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
 566             "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
 567
 568       ELSE()
 569         MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
 570       ENDIF()
 571     ELSE()
 572         IF(NOT _var_already_there)
 573           MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
 574           "An installation was found anyway: ${_tmp_ROOT_DIR}")
 575         ENDIF()
 576     ENDIF()
 577
 578     ##
 579     ## 5. Conflict detection
 580     ##     From another prerequisite using the package:
 581     ##
 582     IF(${pkg_UC}_ROOT_DIR_EXP)
 583         SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
 584         IF(NOT _res)
 585            MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
 586                            " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
 587         ELSE()
 588             MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
 589         ENDIF()
 590     ENDIF()
 591
 592     ##
 593     ## 6. Save the detected installation
 594     ##
 595     SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
 596
 597   ELSE()
 598     MESSAGE(STATUS "${pkg} was not found.")
 599   ENDIF()
 600
 601   SET(Salome${pkg}_FOUND "${pkg}_FOUND")
 602 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
 603
 604
 605 ####################################################################
 606 # SALOME_ADD_MPI_TO_HDF5()
 607 #
 608 # Overload the HDF5 flags so that they also contain MPI references.
 609 # This is to be used when HDF5 was compiled with MPI support;
 610 MACRO(SALOME_ADD_MPI_TO_HDF5)
 611   SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
 612   SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
 613   SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
 614 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
 615
 616 ####################################################################
 617 # SALOME_TOHEXA()
 618 # Convert a number (smaller than 16) into hexadecimal representation
 619 # with a leading 0.
 620 MACRO(SALOME_TOHEXA num result)
 621   SET(_hexa_map a b c d e f)
 622   IF(${num} LESS 10)
 623     SET(${result} "0${num}")
 624   ELSE()
 625     MATH(EXPR _res "${num}-10" )
 626     LIST(GET _hexa_map ${_res} _out)
 627     SET(${result} "0${_out}")
 628   ENDIF()
 629 ENDMACRO(SALOME_TOHEXA)
 630
 631 ####################################################################
 632 # SALOME_XVERSION()
 633 #
 634 # Computes hexadecimal version of SALOME package
 635 #
 636 # USAGE: SALOME_XVERSION(package)
 637 #
 638 # ARGUMENTS:
 639 #
 640 # package: IN: SALOME package name
 641 #
 642 # The macro reads SALOME package version from PACKAGE_VERSION variable
 643 # (note package name in uppercase as assumed for SALOME modules);
 644 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
 645 # major, minor and maintenance components of package version in
 646 # hexadecimal form) is put to the PACKAGE_XVERSION variable
 647 MACRO(SALOME_XVERSION pkg)
 648   STRING(TOUPPER ${pkg} _pkg_UC)
 649   IF(${_pkg_UC}_VERSION)
 650     SET(_major)
 651     SET(_minor)
 652     SET(_patch)
 653     SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
 654     SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
 655     SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
 656     SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
 657   ENDIF()
 658 ENDMACRO(SALOME_XVERSION)
 659
 660
 661 #########################################################################
 662 # SALOME_ACCUMULATE_HEADERS()
 663 #
 664 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
 665 # internally the list of include headers to be saved for future export.
 666 # The full set of include is saved in a variable called
 667 #      _${PROJECT_NAME}_EXTRA_HEADERS
 668 #
 669 MACRO(SALOME_ACCUMULATE_HEADERS lst)
 670   FOREACH(l IN LISTS ${lst})
 671     LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
 672     IF(_res EQUAL "-1")
 673       IF(NOT "${l}" STREQUAL "/usr/include")
 674         LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
 675       ENDIF()
 676     ENDIF()
 677   ENDFOREACH()
 678 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
 679
 680 #########################################################################
 681 # SALOME_ACCUMULATE_ENVIRONMENT()
 682 #
 683 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
 684 #
 685 # ARGUMENTS:
 686 #   envvar [in] environment variable name, e.g. PATH
 687 #   value  [in] value(s) to be added to environment variable
 688 #
 689 # This macro is called in the various FindSalomeXYZ.cmake modules to
 690 # accumulate environment variables, to be used later to run some command
 691 # in proper environment.
 692 #
 693 # 1. Each envrironment variable is stored in specific CMake variable
 694 #    _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
 695 # 2. Full list of environment variable names is stored in CMake variable
 696 #    _${PROJECT_NAME}_EXTRA_ENV.
 697 #
 698 # Notes:
 699 # - The arguments list can include optional CHECK or NOCHECK keywords:
 700 #   * For all arguments following CHECK keyword the macro perform an
 701 #     additional check (see below); this is the default mode, it is suitable
 702 #     for path variables (PATH, LD_LIBRARY_PATH, etc).
 703 #   * For all arguments following NOCHECK keyword, no additional check is
 704 #     performed.
 705 #   Checking an argument means that we check:
 706 #    - That the path actually exists
 707 #    - That this is not a standard system path (starting with "/usr"); this avoids
 708 #   polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
 709 #
 710 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
 711   SET(_is_check ON)
 712   FOREACH(_item ${ARGN})
 713     IF(${_item} STREQUAL "NOCHECK")
 714       SET(_is_check OFF)
 715     ELSEIF(${_item} STREQUAL "CHECK")
 716       SET(_is_check ON)
 717     ELSE()
 718       IF(_is_check)
 719         IF(NOT IS_DIRECTORY ${_item})
 720           IF(TARGET ${_item})
 721             GET_TARGET_PROPERTY(_item ${_item} LOCATION)
 722           ENDIF()
 723           GET_FILENAME_COMPONENT(_item ${_item} PATH)
 724         ENDIF()
 725         IF(EXISTS ${_item})
 726           STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
 727           LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 728           IF(NOT _usr_find AND _res EQUAL -1)
 729               LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 730           ENDIF()
 731         ENDIF()
 732       ELSE(_is_check)
 733         LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 734         IF( _res EQUAL -1)
 735           LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 736         ENDIF()
 737       ENDIF(_is_check)
 738     ENDIF()
 739   ENDFOREACH()
 740
 741   LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
 742   IF(_res EQUAL -1)
 743     LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
 744   ENDIF()
 745   SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
 746   FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
 747     SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_${PROJECT_NAME}_EXTRA_ENV_${_res}}\)")
 748   ENDFOREACH()
 749 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
 750
 751 #########################################################################
 752 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
 753 #
 754 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
 755 #
 756 # ARGUMENTS:
 757 #   output [out] output command, e.g. for creation of target.
 758 #   script [in]  output environement script name
 759 #   cmd    [in]  input command, e.g. sphinx or python command.
 760 #   opts   [in]  options for input command (cmd).
 761 #
 762 # This macro is called when it's necessary to use given environment to run some command.
 763 # Macro generates environement script using previously created variables
 764 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
 765 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
 766 # and puts generated command in proper environment into <output> argument.
 767 #
 768 # Notes:
 769 # - If <script> is specified as relative path, it is computed from the current build
 770 #   directory.
 771 #
 772 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
 773   IF(IS_ABSOLUTE ${script})
 774     SET(_script ${script})
 775   ELSE()
 776     SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
 777   ENDIF()
 778
 779   IF(WIN32)
 780     SET(_ext "bat")
 781     SET(_call_cmd "call")
 782   ELSE()
 783     SET(_ext "sh")
 784     SET(_call_cmd ".")
 785   ENDIF()
 786
 787   SET(_env)
 788   FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 789     FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 790       IF(WIN32)
 791         IF(${_item} STREQUAL "LD_LIBRARY_PATH")
 792           SET(_item PATH)
 793         ENDIF()
 794         STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
 795       ELSE(WIN32)
 796         SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
 797       ENDIF(WIN32)
 798     ENDFOREACH()
 799   ENDFOREACH()
 800
 801   SET(_script ${_script}.${_ext})
 802   FILE(WRITE ${_script} "${_env}")
 803
 804   SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
 805
 806 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
 807
 808 #########################################################################
 809 # SALOME_GENERATE_TESTS_ENVIRONMENT()
 810 #
 811 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
 812 #
 813 # ARGUMENTS:
 814 #   output [out] output environement variable.
 815 #
 816 # This macro generates <output> variable to use given environment to run some tests.
 817 # Macro generates environement variable using previously created variables
 818 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
 819 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
 820 # and puts this variable into <output> argument.
 821 #
 822 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
 823  SET(_env)
 824  SET(_WIN_LD_LIBRARY OFF)
 825  FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 826    IF(${_item} STREQUAL "LD_LIBRARY_PATH")
 827      SET(_WIN_LD_LIBRARY ON)
 828    ENDIF()
 829    SET(_env_${_item})
 830    FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 831      IF(WIN32)
 832        STRING(REPLACE "/" "\\" _val "${_val}")
 833        SET(_env_${_item} "${_val};${_env_${_item}}")
 834      ELSE()
 835        SET(_env_${_item} "${_val}:${_env_${_item}}")
 836      ENDIF()
 837    ENDFOREACH()
 838  ENDFOREACH()
 839
 840  IF(_WIN_LD_LIBRARY AND WIN32)
 841    SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
 842  ENDIF()
 843
 844  IF(WIN32)
 845    SET(sep ",")
 846  ELSE()
 847    SET(sep ";")
 848  ENDIF()
 849
 850  FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 851    IF(WIN32)
 852      IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
 853        SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
 854      ENDIF()
 855    ELSE()
 856      STRING(REPLACE ";" ":" _iii "$ENV{${_item}}")
 857      SET(_env "${_item}=${_iii}:${_env_${_item}}${sep}${_env}")
 858    ENDIF()
 859  ENDFOREACH()
 860
 861  # Get module name as substring of "Salome<ModuleName>"
 862  STRING(REGEX MATCH "^Salome" _is_salome_project ${PROJECT_NAME})
 863  IF(_is_salome_project)
 864    STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
 865  ELSE()
 866    SET(PRNAME ${PROJECT_NAME})
 867  ENDIF()
 868  SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
 869
 870  # Creating follow string for Windows environement:
 871  # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
 872  IF(WIN32)
 873    STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
 874    STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
 875  ENDIF()
 876
 877  SET(${output} "${_env}")
 878
 879 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
 880
 881 #########################################################################
 882 # SALOME_APPEND_LIST_OF_LIST()
 883 #
 884 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
 885 #
 886 # Build a list of lists. The element_list is first parsed to convert it
 887 # from
 888 #     a;b;c;d;e
 889 # to
 890 #     a,b,c,d,e
 891 #
 892 # It is then added to the big list 'result'. Hence 'result' looks like:
 893 #     a,b,c,d,e;f,g,h; ...
 894 #
 895 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
 896   SET(_tmp_res)
 897   STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
 898
 899   # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
 900   STRING(LENGTH result _list_len)
 901   IF(NOT _list_len EQUAL 0)
 902     SET(${result} "${${result}}${_tmp_res};")  # LIST(APPEND ...) doesn't handle well empty elements!?
 903   ELSE()
 904     SET(${result} "${_tmp_res};")              # to avoid redundant ';' at the beginning of the list
 905   ENDIF()
 906
 907 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
 908
 909 #########################################################################
 910 # SALOME_CONFIGURE_PREPARE()
 911 #
 912 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
 913 #
 914 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
 915 # namely:
 916 #    - _PREREQ_LIST      : the list of level 1 external prerequisites
 917 #    - _PREREQ_DIR_LIST  : their corresponding CMake directories (i.e. where the CMake configuration
 918 #    file for this package can be found, if there is any!)
 919 #    - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
 920 #
 921 # All this information is built from the package_list, the list of level 1 packages for this module.
 922 # Only the packages found in CONFIG mode are retained.
 923 #
 924 MACRO(SALOME_CONFIGURE_PREPARE)
 925   SET(_tmp_prereq "${ARGV}")
 926   SET(_PREREQ_LIST)
 927   SET(_PREREQ_DIR_LIST)
 928   SET(_PREREQ_COMPO_LIST)
 929   FOREACH(_prereq IN LISTS _tmp_prereq)
 930     IF(${_prereq}_DIR)
 931       SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
 932       SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${${_prereq}_DIR}\"")
 933       SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
 934     ENDIF()
 935   ENDFOREACH()
 936 ENDMACRO(SALOME_CONFIGURE_PREPARE)