cmake/SalomeMacros.cmake

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