cmake/SalomeMacros.cmake

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