cmake/SalomeMacros.cmake

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