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