cmake/SalomeMacros.cmake

   1 # Copyright (C) 2012-2019  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] [TARGET_NAME name])
  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 # WORKING_DIRECTORY option may be used to specify the relative or absolute
 106 # path to the directory containing source files listed in file_list argument.
 107 # If TARGET_NAME option is specified, the name of the target being created
 108 # with this macro is returned via the given variable.
 109 #----------------------------------------------------------------------------
 110 MACRO(SALOME_INSTALL_SCRIPTS file_list path)
 111   PARSE_ARGUMENTS(SALOME_INSTALL_SCRIPTS "WORKING_DIRECTORY;TARGET_NAME;EXTRA_DPYS" "DEF_PERMS" ${ARGN})
 112   SET(PERMS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
 113   IF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
 114     SET(PERMS ${PERMS} OWNER_EXECUTE GROUP_EXECUTE WORLD_EXECUTE)
 115   ENDIF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
 116   SET(_all_pyc)
 117   SET(_all_pyo)
 118   FOREACH(file ${file_list})
 119     SET(PREFIX "")
 120     SET(_source_prefix "")
 121     GET_FILENAME_COMPONENT(file_name ${file} NAME)
 122     IF(NOT IS_ABSOLUTE ${file})
 123       SET(_source_prefix "${CMAKE_CURRENT_SOURCE_DIR}/")
 124       IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 125         SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
 126         SET(_source_prefix "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
 127       ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 128     ENDIF(NOT IS_ABSOLUTE ${file})
 129     INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
 130     GET_FILENAME_COMPONENT(ext ${file} EXT)
 131     GET_FILENAME_COMPONENT(we_ext ${file} NAME_WE)
 132
 133     IF(ext STREQUAL .py)
 134       # Generate and install the pyc and pyo
 135       # [ABN] Important: we avoid references or usage of CMAKE_INSTALL_PREFIX which is not correctly set
 136       # when using CPack.
 137       SET(_pyc_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.cpython-${PYTHON_VERSION_MAJOR}${PYTHON_VERSION_MINOR}.pyc")
 138       SET(_pyo_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.cpython-${PYTHON_VERSION_MAJOR}${PYTHON_VERSION_MINOR}.opt-1.pyc")
 139       LIST(APPEND _all_pyc ${_pyc_file})
 140       LIST(APPEND _all_pyo ${_pyo_file})
 141       ADD_CUSTOM_COMMAND(
 142         OUTPUT ${_pyc_file} ${_pyo_file}
 143         COMMAND ${PYTHON_EXECUTABLE} -c "from py_compile import compile; compile('${_source_prefix}${file}', '${_pyc_file}', doraise=True, optimize=0); compile('${_source_prefix}${file}', '${_pyo_file}', doraise=True, optimize=1)"
 144         DEPENDS ${PREFIX}${file}
 145         VERBATIM
 146       )
 147       # Install the .pyo and the .pyc
 148       INSTALL(FILES ${_pyc_file} DESTINATION ${path}/__pycache__ PERMISSIONS ${PERMS})
 149       INSTALL(FILES ${_pyo_file} DESTINATION ${path}/__pycache__ PERMISSIONS ${PERMS})
 150     ENDIF(ext STREQUAL .py)
 151
 152   # get relative path (from CMAKE_SOURCE_DIR to CMAKE_CURRENT_SOURCE_DIR)
 153   STRING(REGEX REPLACE ${CMAKE_SOURCE_DIR} "" rel_dir ${CMAKE_CURRENT_SOURCE_DIR})
 154   # convert "/" to "_"
 155   IF(rel_dir)
 156     STRING(REGEX REPLACE "/" "_" unique_name ${rel_dir})
 157   ELSE(rel_dir)
 158     SET(unique_name _)
 159   ENDIF(rel_dir)
 160
 161   ENDFOREACH(file ${file_list})
 162   # Generate only one target for all requested Python script compilation.
 163   # Make sure that the target name is unique too.
 164   IF(_all_pyc)
 165      SET(_cnt 0)
 166      WHILE(TARGET "PYCOMPILE${unique_name}_${_cnt}")
 167        MATH(EXPR _cnt ${_cnt}+1)
 168      ENDWHILE()
 169      SET(_target_name "PYCOMPILE${unique_name}_${_cnt}")
 170      ADD_CUSTOM_TARGET(${_target_name} ALL DEPENDS ${_all_pyc} ${_all_pyo})
 171      IF(SALOME_INSTALL_SCRIPTS_TARGET_NAME)
 172        SET(${SALOME_INSTALL_SCRIPTS_TARGET_NAME} ${_target_name})
 173      ENDIF(SALOME_INSTALL_SCRIPTS_TARGET_NAME)
 174      IF(SALOME_INSTALL_SCRIPTS_EXTRA_DPYS)
 175        ADD_DEPENDENCIES(${_target_name} ${SALOME_INSTALL_SCRIPTS_EXTRA_DPYS})
 176      ENDIF(SALOME_INSTALL_SCRIPTS_EXTRA_DPYS)
 177   ENDIF()
 178 ENDMACRO(SALOME_INSTALL_SCRIPTS)
 179
 180 #----------------------------------------------------------------------------
 181 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
 182 # and modify its contents.
 183 #
 184 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir [EXEC_PERMS]])
 185 #
 186 # ARGUMENTS:
 187 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
 188 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
 189 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
 190 # In this case, EXEC_PERMS can be used to set execution permission for installed file.
 191 #----------------------------------------------------------------------------
 192 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
 193   IF(IS_ABSOLUTE ${IN_FILE})
 194     SET(_in_file ${IN_FILE})
 195   ELSE()
 196     SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
 197   ENDIF()
 198   IF(IS_ABSOLUTE  ${OUT_FILE})
 199     SET(_out_file ${OUT_FILE})
 200   ELSE()
 201     SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
 202   ENDIF()
 203   MESSAGE(STATUS "Creation of ${_out_file}")
 204   CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
 205   PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "EXEC_PERMS" ${ARGN})
 206   IF(SALOME_CONFIGURE_FILE_INSTALL)
 207     SET(PERMS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
 208     IF(SALOME_CONFIGURE_FILE_EXEC_PERMS)
 209       SET(PERMS ${PERMS} OWNER_EXECUTE GROUP_EXECUTE WORLD_EXECUTE)
 210     ENDIF(SALOME_CONFIGURE_FILE_EXEC_PERMS)
 211     INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL} PERMISSIONS ${PERMS})
 212   ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
 213 ENDMACRO(SALOME_CONFIGURE_FILE)
 214
 215
 216 #######################################################################################
 217 # Useful macros for SALOME own package detection system
 218 #
 219
 220 ###
 221 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
 222 #  Check if two paths are identical, resolving links. If the paths do not exist a simple
 223 #  text comparison is performed.
 224 #  result is a boolean.
 225 ###
 226 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
 227   SET("${varRes}" OFF)
 228   IF(EXISTS "${path1}")
 229     GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
 230   ELSE()
 231     SET(_tmp1 "${path1}")
 232   ENDIF()
 233
 234   IF(EXISTS "${path2}")
 235     GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
 236   ELSE()
 237     SET(_tmp2 "${path2}")
 238   ENDIF()
 239
 240   IF("${_tmp1}" STREQUAL "${_tmp2}")
 241     SET("${varRes}" ON)
 242   ENDIF()
 243 #  MESSAGE(${${varRes}})
 244 ENDMACRO()
 245
 246 ####
 247 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
 248 #
 249 # Register in global variables the detection status (found or not) of the optional package 'pkg'
 250 # and the configuration flag that should be turned off to avoid detection of the package.
 251 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
 252 # a summary report of the detection status and stops the process if necessary.
 253 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
 254   # Was the package found
 255   STRING(TOUPPER ${pkg} _pkg_UC)
 256   IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
 257     SET(_isFound TRUE)
 258   ELSE()
 259     SET(_isFound FALSE)
 260   ENDIF()
 261
 262   # Is the package already in the list? Then update its status:
 263   LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
 264   IF(NOT ${_result} EQUAL -1)
 265     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
 266     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
 267     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
 268     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
 269   ELSE()
 270     # Otherwise insert it
 271     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
 272     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
 273     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
 274   ENDIF()
 275
 276 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
 277
 278 ####
 279 # SALOME_JUSTIFY_STRING()
 280 #
 281 # Justifies the string specified as an argument to the given length
 282 # adding required number of spaces to the end. Does noting if input
 283 # string is longer as required length.
 284 # Puts the result to the output variable.
 285 #
 286 # USAGE: SALOME_JUSTIFY_STRING(input length result)
 287 #
 288 # ARGUMENTS:
 289 #   input  [in] input string
 290 #   length [in] required length of resulting string
 291 #   result [out] name of variable where the result string is put to
 292 #
 293 MACRO(SALOME_JUSTIFY_STRING input length result)
 294   SET(${result} ${input})
 295   STRING(LENGTH ${input} _input_length)
 296   MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
 297   IF (_nb_spaces GREATER 0)
 298     FOREACH(_idx RANGE ${_nb_spaces})
 299       SET(${result} "${${result}} ")
 300     ENDFOREACH()
 301   ENDIF()
 302 ENDMACRO(SALOME_JUSTIFY_STRING)
 303
 304 ####
 305 # SALOME_PACKAGE_REPORT_AND_CHECK()
 306 #
 307 # Print a quick summary of the detection of optional prerequisites.
 308 # If a package was not found, the configuration is stopped. The summary also indicates
 309 # which flag should be turned off to skip the detection of the package.
 310 #
 311 # If optional JUSTIFY argument is specified, names of packages
 312 # are left-justified to the given length; default value is 10.
 313 #
 314 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
 315 #
 316 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 317   SET(_will_fail OFF)
 318   PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
 319   IF(SALOME_PACKAGE_REPORT_JUSTIFY)
 320     SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
 321   ELSE()
 322     SET(_length 23)
 323   ENDIF()
 324   MESSAGE(STATUS "")
 325   MESSAGE(STATUS "  Optional packages - Detection report ")
 326   MESSAGE(STATUS "  ==================================== ")
 327   MESSAGE(STATUS "")
 328   IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 329     LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
 330     # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
 331     MATH(EXPR _range "${_list_len}-1")
 332     FOREACH(_idx RANGE ${_range})
 333       LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
 334       LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
 335       LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
 336       SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
 337       IF(_pkg_found)
 338         SET(_found_msg "Found")
 339         SET(_flag_msg "")
 340       ELSE()
 341         SET(_will_fail ON)
 342         SET(_found_msg "NOT Found")
 343         SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
 344       ENDIF()
 345
 346       MESSAGE(STATUS "  * ${_pkg_name}  ->  ${_found_msg}${_flag_msg}")
 347     ENDFOREACH()
 348   ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 349   MESSAGE(STATUS "")
 350   MESSAGE(STATUS "")
 351
 352   # Failure if some packages were missing:
 353   IF(_will_fail)
 354     MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
 355   ENDIF()
 356 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 357
 358 ####
 359 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
 360 #
 361 # example:  SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
 362 #
 363 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
 364 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
 365 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
 366 #
 367 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
 368 # also handled properly.
 369 #
 370 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
 371 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
 372 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
 373 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
 374 # example).
 375 #
 376 # This macro is to be called from within the FindSalomeXXXX.cmake file.
 377 #
 378 ####
 379 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
 380   SET(_OPT_ARG ${ARGV3})
 381   # Only bother if the package was not already found:
 382   # Some old packages use the lower case version - standard should be to always use
 383   # upper case:
 384   STRING(TOUPPER ${stdPkg} stdPkgUC)
 385   IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
 386     IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
 387       SET(_tmp_quiet "QUIET")
 388     ELSE()
 389       SET(_tmp_quiet)
 390     ENDIF()
 391     IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
 392       SET(_tmp_req "REQUIRED")
 393     ELSE()
 394       SET(_tmp_req)
 395     ENDIF()
 396     IF(${englobPkg}_FIND_VERSION_EXACT)
 397       SET(_tmp_exact "EXACT")
 398     ELSE()
 399       SET(_tmp_exact)
 400     ENDIF()
 401
 402     # Call the CMake FIND_PACKAGE() command:
 403     STRING(TOLOWER ${stdPkg} _pkg_lc)
 404     IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
 405       # Hope to find direclty a CMake config file, indicating the SALOME CMake file
 406       # paths (the command already looks in places like "share/cmake", etc ... by default)
 407       # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
 408       # looking into a previous CMake build done via a GUI, or into the Win registry.
 409       # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
 410       # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
 411       # See documentation of FIND_PACKAGE() for full details.
 412
 413       # Do we need to call the signature using components?
 414       IF(${englobPkg}_FIND_COMPONENTS)
 415         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 416               NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
 417               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
 418               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 419                 NO_SYSTEM_ENVIRONMENT_PATH)
 420       ELSE()
 421         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 422               NO_MODULE ${_tmp_quiet} ${_tmp_req}
 423               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
 424               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 425                  NO_SYSTEM_ENVIRONMENT_PATH)
 426       ENDIF()
 427       MARK_AS_ADVANCED(${stdPkg}_DIR)
 428
 429     ELSEIF("${mode}" STREQUAL "MODULE")
 430
 431       # Do we need to call the signature using components?
 432       IF(${englobPkg}_FIND_COMPONENTS)
 433         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 434               MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
 435       ELSE()
 436         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 437               MODULE ${_tmp_quiet} ${_tmp_req})
 438       ENDIF()
 439
 440     ELSE()
 441
 442       MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
 443
 444     ENDIF()
 445
 446   ENDIF()
 447 ENDMACRO()
 448
 449
 450 ####################################################################
 451 # SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS(pkg referenceVariable upCount)
 452 #    pkg              : name of the system package to be detected
 453 #    referenceVariable: variable containing a path that can be browsed up to
 454 # retrieve the package root directory (xxx_ROOT_DIR)
 455 #    upCount          : number of times we have to go up from the path <referenceVariable>
 456 # to obtain the package root directory.
 457 # If this is a path to a file, going up one time gives the directory containing the file
 458 # going up 2 times gives the parent directory.
 459 #
 460 # For example:  SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
 461 #     with SWIG_EXECUTABLE set to '/usr/bin/swig'
 462 #     will produce '/usr'
 463 #
 464 # Generic detection (and conflict check) procedure for package XYZ:
 465 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
 466 #    If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
 467 # directly on XYZ)
 468 # 2. Invoke FIND_PACKAGE() in this order:
 469 #    * in CONFIG mode first (if possible): priority is given to a potential
 470 #    "XYZ-config.cmake" file
 471 #    * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
 472 # the above XYZ_ROOT_DIR variable
 473 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
 474 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
 475 #    instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
 476 # 5. Conflict detection:
 477 #    * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
 478 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
 479 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
 480 # conflict detection. This is added after the call to the macro by the callee.
 481 #
 482 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
 483   ##
 484   ## 0. Initialization
 485   ##
 486   PARSE_ARGUMENTS(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS "ENVVAR" "" ${ARGN})
 487
 488   # Package name, upper case
 489   STRING(TOUPPER ${pkg} pkg_UC)
 490
 491   ##
 492   ## 1. Load environment or any previously detected root dir for the package
 493   ##
 494   SET(_envvar ${pkg_UC}_ROOT_DIR)
 495   IF(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS_ENVVAR)
 496     SET(_envvar "${SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS_ENVVAR}")
 497   ENDIF()
 498   IF(DEFINED ENV{${_envvar}})
 499     FILE(TO_CMAKE_PATH "$ENV{${_envvar}}" _${pkg_UC}_ROOT_DIR_ENV)
 500     SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
 501   ELSE()
 502     # will be blank if no package was previously loaded:
 503     SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
 504   ENDIF()
 505   # Detect if the variable has been set on the command line or elsewhere:
 506   IF(DEFINED ${_envvar})
 507      SET(_var_already_there TRUE)
 508   ELSE()
 509      SET(_var_already_there FALSE)
 510   ENDIF()
 511   #   Make cache entry
 512   SET(${_envvar} "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
 513
 514   ##
 515   ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
 516   ##
 517
 518   # Override the variable - don't append to it, as it would give precedence
 519   # to what was stored there before!
 520   IF(DEFINED ${_envvar})
 521     SET(CMAKE_PREFIX_PATH "${${_envvar}}")
 522   ENDIF()
 523
 524   # Try find_package in config mode. This has the priority, but is
 525   # performed QUIET and not REQUIRED:
 526   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
 527
 528   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 529     MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
 530   ENDIF()
 531
 532   # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
 533   # We do it quietly to produce our own error message, except if we are in debug mode:
 534   IF(SALOME_CMAKE_DEBUG)
 535     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
 536   ELSE()
 537     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
 538   ENDIF()
 539
 540   # Set the "FOUND" variable for the SALOME wrapper:
 541   IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
 542     SET(SALOME${pkg_UC}_FOUND TRUE)
 543   ELSE()
 544     SET(SALOME${pkg_UC}_FOUND FALSE)
 545     IF(NOT Salome${pkg}_FIND_QUIETLY)
 546       IF(Salome${pkg}_FIND_REQUIRED)
 547          MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 548          "It currently contains ${_envvar}=${${_envvar}}  "
 549          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 550       ELSE()
 551          MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 552          "It currently contains ${_envvar}=${${_envvar}}  "
 553          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 554       ENDIF()
 555     ENDIF()
 556   ENDIF()
 557
 558   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 559     ## 3. Set the root dir which was finally retained by going up "upDir" times
 560     ## from the given reference path. The variable "referenceVariable" may be a list.
 561     ## In this case we take its first element.
 562
 563     # First test if the variable exists, warn otherwise:
 564     IF(NOT DEFINED ${referenceVariable})
 565       MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
 566       "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
 567     ENDIF()
 568
 569     LIST(LENGTH ${referenceVariable} _tmp_len)
 570     IF(_tmp_len)
 571        LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
 572     ELSE()
 573        #  Note the double de-reference of "referenceVariable":
 574        SET(_tmp_ROOT_DIR "${${referenceVariable}}")
 575     ENDIF()
 576     # Up count can be reset by detection procedure
 577     SET(_upCount ${upCount})
 578     IF(DEFINED ${pkg_UC}_UPCOUNT)
 579       SET(_upCount ${${pkg_UC}_UPCOUNT})
 580     ENDIF()
 581     IF(${_upCount} GREATER 0)
 582       FOREACH(_unused RANGE 1 ${_upCount})
 583         GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 584       ENDFOREACH()
 585     ENDIF()
 586
 587     ##
 588     ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 589     ##
 590     IF(DEFINED ENV{${_envvar}})
 591       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
 592       IF(NOT _res)
 593         MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
 594             "environment ${_envvar}! Is the variable correctly set? "
 595             "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
 596
 597       ELSE()
 598         MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${_envvar} variable, all good!")
 599       ENDIF()
 600     ELSE()
 601         IF(NOT _var_already_there)
 602           MESSAGE(STATUS "Variable ${_envvar} was not explicitly defined. "
 603           "An installation was found anyway: ${_tmp_ROOT_DIR}")
 604         ENDIF()
 605     ENDIF()
 606
 607     ##
 608     ## 5. Conflict detection
 609     ##     From another prerequisite using the package:
 610     ##
 611     IF(${pkg_UC}_ROOT_DIR_EXP)
 612         SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
 613         IF(NOT _res)
 614            MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
 615                            " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
 616         ELSE()
 617             MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
 618         ENDIF()
 619     ENDIF()
 620
 621     ##
 622     ## 6. Save the detected installation
 623     ##
 624     SET(${_envvar} "${_tmp_ROOT_DIR}")
 625
 626   ELSE()
 627     MESSAGE(STATUS "${pkg} was not found.")
 628   ENDIF()
 629
 630   SET(Salome${pkg}_FOUND "${pkg}_FOUND")
 631 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
 632
 633
 634 ####################################################################
 635 # SALOME_ADD_MPI_TO_HDF5()
 636 #
 637 # Overload the HDF5 flags so that they also contain MPI references.
 638 # This is to be used when HDF5 was compiled with MPI support;
 639 MACRO(SALOME_ADD_MPI_TO_HDF5)
 640   SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
 641   SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
 642   SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
 643 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
 644
 645 ####################################################################
 646 # SALOME_TOHEXA()
 647 # Convert a number (smaller than 16) into hexadecimal representation
 648 # with a leading 0.
 649 MACRO(SALOME_TOHEXA num result)
 650   SET(_hexa_map a b c d e f)
 651   IF(${num} LESS 10)
 652     SET(${result} "0${num}")
 653   ELSE()
 654     MATH(EXPR _res "${num}-10" )
 655     LIST(GET _hexa_map ${_res} _out)
 656     SET(${result} "0${_out}")
 657   ENDIF()
 658 ENDMACRO(SALOME_TOHEXA)
 659
 660 ####################################################################
 661 # SALOME_XVERSION()
 662 #
 663 # Computes hexadecimal version of SALOME package
 664 #
 665 # USAGE: SALOME_XVERSION(package)
 666 #
 667 # ARGUMENTS:
 668 #
 669 # package: IN: SALOME package name
 670 #
 671 # The macro reads SALOME package version from PACKAGE_VERSION variable
 672 # (note package name in uppercase as assumed for SALOME modules);
 673 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
 674 # major, minor and maintenance components of package version in
 675 # hexadecimal form) is put to the PACKAGE_XVERSION variable
 676 MACRO(SALOME_XVERSION pkg)
 677   STRING(TOUPPER ${pkg} _pkg_UC)
 678   IF(${_pkg_UC}_VERSION)
 679     SET(_major)
 680     SET(_minor)
 681     SET(_patch)
 682     SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
 683     SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
 684     SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
 685     SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
 686   ENDIF()
 687 ENDMACRO(SALOME_XVERSION)
 688
 689
 690 #########################################################################
 691 # SALOME_ACCUMULATE_HEADERS()
 692 #
 693 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
 694 # internally the list of include headers to be saved for future export.
 695 # The full set of include is saved in a variable called
 696 #      _${PROJECT_NAME}_EXTRA_HEADERS
 697 #
 698 MACRO(SALOME_ACCUMULATE_HEADERS lst)
 699   FOREACH(l IN LISTS ${lst})
 700     LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
 701     IF(_res EQUAL "-1")
 702       IF(NOT "${l}" STREQUAL "/usr/include")
 703         LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
 704       ENDIF()
 705     ENDIF()
 706   ENDFOREACH()
 707 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
 708
 709 #########################################################################
 710 # SALOME_ACCUMULATE_ENVIRONMENT()
 711 #
 712 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
 713 #
 714 # ARGUMENTS:
 715 #   envvar [in] environment variable name, e.g. PATH
 716 #   value  [in] value(s) to be added to environment variable
 717 #
 718 # This macro is called in the various FindSalomeXYZ.cmake modules to
 719 # accumulate environment variables, to be used later to run some command
 720 # in proper environment.
 721 #
 722 # 1. Each envrironment variable is stored in specific CMake variable
 723 #    _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
 724 # 2. Full list of environment variable names is stored in CMake variable
 725 #    _${PROJECT_NAME}_EXTRA_ENV.
 726 #
 727 # Notes:
 728 # - The arguments list can include optional CHECK or NOCHECK keywords:
 729 #   * For all arguments following CHECK keyword the macro perform an
 730 #     additional check (see below); this is the default mode, it is suitable
 731 #     for path variables (PATH, LD_LIBRARY_PATH, etc).
 732 #   * For all arguments following NOCHECK keyword, no additional check is
 733 #     performed.
 734 #   Checking an argument means that we check:
 735 #    - That the path actually exists
 736 #    - That this is not a standard system path (starting with "/usr"); this avoids
 737 #   polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
 738 #
 739 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
 740   SET(_is_check ON)
 741   FOREACH(_item ${ARGN})
 742     IF(${_item} STREQUAL "NOCHECK")
 743       SET(_is_check OFF)
 744     ELSEIF(${_item} STREQUAL "CHECK")
 745       SET(_is_check ON)
 746     ELSE()
 747       IF(_is_check)
 748         IF(NOT IS_DIRECTORY ${_item})
 749           IF(TARGET ${_item})
 750             GET_TARGET_PROPERTY(_target_type ${_item} TYPE)
 751             IF(NOT ${_target_type} STREQUAL "INTERFACE_LIBRARY")
 752               GET_TARGET_PROPERTY(_item ${_item} LOCATION)
 753             ENDIF()
 754           ENDIF()
 755           GET_FILENAME_COMPONENT(_item ${_item} PATH)
 756         ENDIF()
 757         IF(EXISTS ${_item})
 758           STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
 759           LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 760           IF(NOT _usr_find AND _res EQUAL -1)
 761               LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 762           ENDIF()
 763         ENDIF()
 764       ELSE(_is_check)
 765         LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 766         IF( _res EQUAL -1)
 767           LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 768         ENDIF()
 769       ENDIF(_is_check)
 770     ENDIF()
 771   ENDFOREACH()
 772
 773   LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
 774   IF(_res EQUAL -1)
 775     LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
 776   ENDIF()
 777   SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
 778   FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
 779     STRING(REPLACE "${CMAKE_INSTALL_PREFIX}" "\${PACKAGE_PREFIX_DIR}" _res_path "${_${PROJECT_NAME}_EXTRA_ENV_${_res}}")
 780     SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_res_path}\)")
 781   ENDFOREACH()
 782 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
 783
 784 #########################################################################
 785 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
 786 #
 787 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
 788 #
 789 # ARGUMENTS:
 790 #   output [out] output command, e.g. for creation of target.
 791 #   script [in]  output environement script name
 792 #   cmd    [in]  input command, e.g. sphinx or python command.
 793 #   opts   [in]  options for input command (cmd).
 794 #
 795 # This macro is called when it's necessary to use given environment to run some command.
 796 # Macro generates environement script 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 generated command in proper environment into <output> argument. To ignore
 800 # _${PROJECT_NAME}_EXTRA_ENV_<var> and _${PROJECT_NAME}_EXTRA_ENV variables set
 801 # environment variable 'SALOME_HAS_GLOBAL_ENV=1'
 802 #
 803 # NAMED ARGUMENTS:
 804 #  CONTEXT: is used under Windows platform only to generate command file. See explanations
 805 #           below.
 806 #  CONTEXT_NAME: is used under Windows platform only to generate command file. See
 807 #                explanations below.
 808 #  ADDITIONAL_VARIABLES: list of the additional variables to write into environment script.
 809 #                        Each item of this list should be in the 'Variable=Value' format.
 810 #
 811 #
 812 # Notes:
 813 # - If <script> is specified as relative path, it is computed from the current build
 814 #   directory.
 815 # - If CONTEXT variables is passed into this macro, then on
 816 #   Windows platform command file looks like:
 817 #   =================================================
 818 #   IF SET_${CONTEXT}_VARS == 1 GOTO ${CONTEXT_NAME}
 819 #    @SET VAR1=VAR1_VALUE;%VAR1%
 820 #    .........
 821 #    .........
 822 #    .........
 823 #    @SET VARN=VARN_VALUE;%VARN%
 824 #    @SET SET_${CONTEXT}_VARS = 1
 825 #   :${CONTEXT_NAME}
 826 #   =================================================
 827 #   By default CONTEXT_NAME is equal to 'END'
 828 #
 829 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
 830   PARSE_ARGUMENTS(SALOME_GENERATE_ENVIRONMENT_SCRIPT "CONTEXT;CONTEXT_NAME;ADDITIONAL_VARIABLES" "" ${ARGN})
 831
 832   IF(IS_ABSOLUTE ${script})
 833     SET(_script ${script})
 834   ELSE()
 835     SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
 836   ENDIF()
 837
 838   IF(WIN32)
 839     SET(_ext "bat")
 840     SET(_call_cmd "call")
 841   ELSE()
 842     SET(_ext "sh")
 843     SET(_call_cmd ".")
 844   ENDIF()
 845
 846   SET(_ctx "END")
 847   IF(SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT_NAME)
 848     SET(_ctx "${SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT_NAME}")
 849   ENDIF()
 850
 851   SET(_env "")
 852   IF(WIN32 AND SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT)
 853     SET(_env "IF ${_env}\"%SET_${SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT}_VARS%\"==\"1\" GOTO ${_ctx}\n")
 854   ENDIF()
 855   IF (NOT "$ENV{SALOME_HAS_GLOBAL_ENV}" STREQUAL "1")
 856     FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 857       FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 858         SALOME_DO_VAR_SUBSTITUTION(_env ${_item} ${_val})
 859       ENDFOREACH()
 860     ENDFOREACH()
 861   ENDIF()
 862
 863   # Additional variables
 864   IF(SALOME_GENERATE_ENVIRONMENT_SCRIPT_ADDITIONAL_VARIABLES)
 865     FOREACH(_item ${SALOME_GENERATE_ENVIRONMENT_SCRIPT_ADDITIONAL_VARIABLES})
 866       STRING(REGEX MATCHALL "([^=]+|[^=]+$)" a_list "${_item}")
 867       LIST(LENGTH a_list a_list_len)
 868       IF(NOT ${a_list_len} EQUAL 2)
 869         MESSAGE(FATAL_ERROR  "Each item of ${ADDITIONAL_VARIABLES} list should be in 'Variable=Value' format")
 870       ENDIF()
 871       LIST(GET a_list 0 _item)
 872       LIST(GET a_list 1 _val)
 873       SALOME_DO_VAR_SUBSTITUTION(_env ${_item} ${_val})
 874     ENDFOREACH()
 875   ENDIF()
 876
 877   IF(WIN32 AND SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT)
 878      SET(_env "${_env}@SET SET_${SALOME_GENERATE_ENVIRONMENT_SCRIPT_CONTEXT}_VARS=1\n")
 879      SET(_env "${_env}:${_ctx}\n" )
 880   ENDIF()
 881
 882   IF(NOT "${_env}" STREQUAL "")
 883     SET(_script ${_script}.${_ext})
 884     FILE(WRITE ${_script} "${_env}")
 885     SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
 886   ELSE()
 887     SET(${output} ${cmd} ${opts})
 888   ENDIF()
 889
 890 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
 891
 892 #########################################################################
 893 # SALOME_GENERATE_TESTS_ENVIRONMENT()
 894 #
 895 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
 896 #
 897 # ARGUMENTS:
 898 #   output [out] output environement variable.
 899 #
 900 # This macro generates <output> variable to use given environment to run some tests.
 901 # Macro generates environement variable using previously created variables
 902 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
 903 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
 904 # and puts this variable into <output> argument.
 905 #
 906 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
 907  SET(_env)
 908  SET(_WIN_LD_LIBRARY OFF)
 909  FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 910    IF(${_item} STREQUAL "LD_LIBRARY_PATH")
 911      SET(_WIN_LD_LIBRARY ON)
 912    ENDIF()
 913    SET(_env_${_item})
 914    FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 915      IF(WIN32)
 916        STRING(REPLACE "/" "\\" _val "${_val}")
 917        SET(_env_${_item} "${_val};${_env_${_item}}")
 918      ELSE()
 919        SET(_env_${_item} "${_val}:${_env_${_item}}")
 920      ENDIF()
 921    ENDFOREACH()
 922  ENDFOREACH()
 923
 924  IF(_WIN_LD_LIBRARY AND WIN32)
 925    SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
 926  ENDIF()
 927
 928  IF(WIN32)
 929    SET(sep ",")
 930  ELSE()
 931    SET(sep ";")
 932  ENDIF()
 933
 934  FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 935    IF(WIN32)
 936      IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
 937        SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
 938      ENDIF()
 939    ELSE()
 940      STRING(REPLACE ";" ":" _iii "$ENV{${_item}}")
 941      SET(_env "${_item}=${_iii}:${_env_${_item}}${sep}${_env}")
 942    ENDIF()
 943  ENDFOREACH()
 944
 945  # Get module name as substring of "Salome<ModuleName>"
 946  STRING(REGEX MATCH "^Salome" _is_salome_project ${PROJECT_NAME})
 947  IF(_is_salome_project)
 948    STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
 949  ELSE()
 950    SET(PRNAME ${PROJECT_NAME})
 951  ENDIF()
 952  SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
 953
 954  # Creating follow string for Windows environement:
 955  # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
 956  IF(WIN32)
 957    STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
 958    STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
 959  ENDIF()
 960
 961  SET(${output} "${_env}")
 962
 963 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
 964
 965 #########################################################################
 966 # SALOME_APPEND_LIST_OF_LIST()
 967 #
 968 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
 969 #
 970 # Build a list of lists. The element_list is first parsed to convert it
 971 # from
 972 #     a;b;c;d;e
 973 # to
 974 #     a,b,c,d,e
 975 #
 976 # It is then added to the big list 'result'. Hence 'result' looks like:
 977 #     a,b,c,d,e;f,g,h; ...
 978 #
 979 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
 980   SET(_tmp_res)
 981   STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
 982
 983   # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
 984   STRING(LENGTH result _list_len)
 985   IF(NOT _list_len EQUAL 0)
 986     SET(${result} "${${result}}${_tmp_res};")  # LIST(APPEND ...) doesn't handle well empty elements!?
 987   ELSE()
 988     SET(${result} "${_tmp_res};")              # to avoid redundant ';' at the beginning of the list
 989   ENDIF()
 990
 991 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
 992
 993 #########################################################################
 994 # SALOME_CONFIGURE_PREPARE()
 995 #
 996 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
 997 #
 998 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
 999 # namely:
1000 #    - _PREREQ_LIST      : the list of level 1 external prerequisites
1001 #    - _PREREQ_DIR_LIST  : their corresponding CMake directories (i.e. where the CMake configuration
1002 #    file for this package can be found, if there is any!)
1003 #    - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
1004 #
1005 # All this information is built from the package_list, the list of level 1 packages for this module.
1006 # Only the packages found in CONFIG mode are retained.
1007 #
1008 MACRO(SALOME_CONFIGURE_PREPARE)
1009   SET(_tmp_prereq "${ARGV}")
1010   SET(_PREREQ_LIST)
1011   SET(_PREREQ_DIR_LIST)
1012   SET(_PREREQ_COMPO_LIST)
1013   FOREACH(_prereq IN LISTS _tmp_prereq)
1014     IF(${_prereq}_DIR)
1015       SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
1016       FILE(TO_CMAKE_PATH ${${_prereq}_DIR} CURR_DIR)
1017       SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${CURR_DIR}\"")
1018       SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
1019     ENDIF()
1020   ENDFOREACH()
1021 ENDMACRO(SALOME_CONFIGURE_PREPARE)
1022
1023 #######################################################################
1024 #
1025 # From a version string like "2.7.12+" extract the major, minor and patch number
1026 # taking ONLY the numerical part.
1027 # This macro was created to treat Ubuntu Python version number where the libs are
1028 # version 2.7.12+ and the interp is 2.7.12 ...
1029 #
1030 MACRO(SALOME_EXTRACT_VERSION version_string major minor patch)
1031   IF(${version_string} MATCHES "[0-9]+[^0-9.]*\\.[0-9]+[^0-9.]*\\.*[0-9]*[^0-9]*[0-9]*")
1032     STRING(REGEX REPLACE "^([0-9]+)[^0-9.]*\\.[0-9]+[^0-9.]*\\.*[0-9]*[^0-9]*[0-9]*$" "\\1" ${major} "${version_string}")
1033     STRING(REGEX REPLACE "^[0-9]+[^0-9.]*\\.([0-9]+)[^0-9.]*\\.*[0-9]*[^0-9]*[0-9]*$" "\\1" ${minor} "${version_string}")
1034
1035     IF(${version_string} MATCHES "[0-9]+[^0-9.]*\\.[0-9]+[^0-9.]*\\.[0-9]+[^0-9]*[0-9]*")
1036         # X.Y.Z format (python 3.5.2 ...)
1037         STRING(REGEX REPLACE "^[0-9]+[^0-9.]*\\.[0-9]+[^0-9.]*\\.([0-9]+)[^0-9]*[0-9]*$" "\\1" ${patch} "${version_string}")
1038     ELSE()
1039         # X.Y format (python 3.5 ...)
1040         SET(${patch} "0")
1041     ENDIF()
1042   ELSE()
1043     MESSAGE("MACRO(SALOME_EXTRACT_VERSION ${version_string} ${major} ${minor} ${patch}")
1044     MESSAGE(FATAL_ERROR "Problem parsing version string, I can't parse it properly.")
1045   ENDIF()
1046 ENDMACRO(SALOME_EXTRACT_VERSION)
1047
1048 #######################################################################
1049 #
1050 # This macro checks that swig files were generated.
1051 # It is requared under Windows platform, because sometimes under Windows platform
1052 # the genetarion of the swig wrappings tooks long time. And seems swig opens
1053 # file at the begining of generation process and after that swig
1054 # begins the generation of the content. In its turn Microsoft Visual Studio
1055 # tryes to compile file immediately after creation and as a result compilation breaks.
1056 MACRO(SWIG_CHECK_GENERATION swig_module)
1057   IF(WIN32)
1058     SET(SCRIPT
1059 "@echo off
1060 :check
1061 ( (call ) >> @SWIG_GEN_FILE_NAME@ ) 2>null && (
1062   echo The file @SWIG_GEN_FILE_NAME@ was created. & goto :eof
1063 ) || (
1064   echo The file @SWIG_GEN_FILE_NAME@ is still being created !!! & goto :check
1065 )
1066 :eof")
1067     SET(W_LIST)
1068     LIST(LENGTH swig_generated_sources NB_GEN_FILES)
1069     IF(NOT ${NB_GEN_FILES})
1070       LIST(LENGTH swig_generated_file_fullname NB_GEN_FILES)
1071       SET(W_LIST ${swig_generated_file_fullname})
1072     ELSE()
1073       SET(W_LIST ${swig_generated_sources})
1074     ENDIF()
1075     IF(${NB_GEN_FILES})
1076       LIST(GET W_LIST 0 SWIG_GEN_FILE_NAME)
1077       STRING(CONFIGURE ${SCRIPT} SCRIPT)
1078       GET_FILENAME_COMPONENT(SWIG_GEN_FILE_NAME_DIR ${SWIG_GEN_FILE_NAME} DIRECTORY)
1079       GET_FILENAME_COMPONENT(SWIG_GEN_FILE_NAME_WE ${SWIG_GEN_FILE_NAME} NAME_WE)
1080       SET(SCRIPT_FILE_NAME ${SWIG_GEN_FILE_NAME_DIR}/${SWIG_GEN_FILE_NAME_WE}.bat)
1081       FILE(WRITE ${SCRIPT_FILE_NAME} ${SCRIPT})
1082       ADD_CUSTOM_TARGET(${SWIG_MODULE_${swig_module}_REAL_NAME}_ready
1083                         DEPENDS ${SWIG_GEN_FILE_NAME}
1084                         COMMAND ${SCRIPT_FILE_NAME}
1085                         COMMENT "Waiting for swig wrappings !!!")
1086       ADD_DEPENDENCIES(${SWIG_MODULE_${swig_module}_REAL_NAME} ${SWIG_MODULE_${swig_module}_REAL_NAME}_ready)
1087     ELSE()
1088        MESSAGE(FATAL "swig sources for targer ${swig_module} are not found !!!")
1089      ENDIF()
1090   ENDIF()
1091 ENDMACRO(SWIG_CHECK_GENERATION)
1092
1093 #########################################################################
1094 # SALOME_DO_VAR_SUBSTITUTION()
1095 #
1096 # USAGE: SALOME_DO_VAR_SUBSTITUTION(env variable value)
1097 #
1098 # ARGUMENTS:
1099 #   env      [out]: output script.
1100 #   variable  [in]: varable name
1101 #   value     [in]: variable value
1102 #
1103 # This macro concatenate variable value into script, like this:
1104 # on Linux:
1105 # export variable=value:${varuable}
1106 #
1107 # or on Windows:
1108 # SET variable=value;${varuable}
1109 #
1110 # Platform dependat variables PATH (Windows),
1111 # DYLD_LIBRARY_PATH (Apple), LD_LIBRARY_PATH (Linux), should be
1112 # passed in Linux naming style, i.e. LD_LIBRARY_PATH. Macro
1113 # converts this variable into platform scpecific variable.
1114 #
1115 MACRO(SALOME_DO_VAR_SUBSTITUTION env variable value)
1116   SET(_item ${variable})
1117   SET(_val ${value})
1118   IF(WIN32)
1119     IF(${_item} STREQUAL "LD_LIBRARY_PATH")
1120       SET(_item PATH)
1121     ENDIF()
1122       STRING(REPLACE "/" "\\" ${env} "${${env}}@SET ${_item}=${_val};%${_item}%\n")
1123     ELSEIF(APPLE)
1124       IF(${_item} STREQUAL "LD_LIBRARY_PATH")
1125         SET(${env} "${${env}} export DYLD_LIBRARY_PATH=${_val}:\${DYLD_LIBRARY_PATH}\n")
1126       ELSE()
1127         SET(${env} "${${env}} export ${_item}=${_val}:\${${_item}}\n")
1128       ENDIF()
1129     ELSE()
1130        SET(${env} "${${env}} export ${_item}=${_val}:\${${_item}}\n")
1131   ENDIF()
1132 ENDMACRO(SALOME_DO_VAR_SUBSTITUTION)