adm_local_without_kernel/cmake_files/SalomeMacros.cmake

   1 # Copyright (C) 2012-2013  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.
   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   FOREACH(file ${file_list})
 113     SET(PREFIX "")
 114     IF(IS_ABSOLUTE ${file})
 115       GET_FILENAME_COMPONENT(file_name ${file} NAME)
 116     ELSE()
 117       SET(file_name ${file})
 118       IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 119         SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
 120       ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 121     ENDIF(IS_ABSOLUTE ${file})
 122     INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
 123     GET_FILENAME_COMPONENT(ext ${file} EXT)
 124     IF(ext STREQUAL .py)
 125       INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${path}/${file_name}\")")
 126       INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${path}/${file_name}')\")")
 127       INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
 128       INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
 129     ENDIF(ext STREQUAL .py)
 130   ENDFOREACH(file ${file_list})
 131 ENDMACRO(SALOME_INSTALL_SCRIPTS)
 132
 133 #----------------------------------------------------------------------------
 134 # SALOME_INSTALL_SCRIPTS is a macro useful for installing executable scripts.
 135 # ARGUMENTS:
 136 # PYFILE2COMPINST: IN : list of python files to be installed.
 137 # PYFILELOC: IN : full pathname for installing.
 138 # Permissions of installed files: OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ
 139 #----------------------------------------------------------------------------
 140 MACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
 141   INSTALL(CODE "SET(PYTHON_FILE ${f})")
 142   FOREACH(input ${PYFILE2COMPINST})
 143     GET_FILENAME_COMPONENT(inputname ${input} NAME)
 144     INSTALL(FILES ${input} DESTINATION ${CMAKE_INSTALL_PREFIX}/${PYFILELOC})
 145     INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}\")")
 146     INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}')\")")
 147     INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
 148     INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
 149   ENDFOREACH(input ${PYFILE2COMPINST})
 150 ENDMACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
 151
 152 #----------------------------------------------------------------------------
 153 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
 154 # and modify its contents.
 155 #
 156 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
 157 #
 158 # ARGUMENTS:
 159 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
 160 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
 161 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
 162 #----------------------------------------------------------------------------
 163 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
 164   IF(IS_ABSOLUTE ${IN_FILE})
 165     SET(_in_file ${IN_FILE})
 166   ELSE()
 167     SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
 168   ENDIF()
 169   IF(IS_ABSOLUTE  ${OUT_FILE})
 170     SET(_out_file ${OUT_FILE})
 171   ELSE()
 172     SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
 173   ENDIF()
 174   MESSAGE(STATUS "Creation of ${_out_file}")
 175   CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
 176   PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
 177   IF(SALOME_CONFIGURE_FILE_INSTALL)
 178     INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
 179   ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
 180 ENDMACRO(SALOME_CONFIGURE_FILE)
 181
 182
 183 #######################################################################################
 184 # Useful macros for SALOME own package detection system
 185 #
 186
 187 ###
 188 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
 189 #  Check if two paths are identical, resolving links. If the paths do not exist a simple
 190 #  text comparison is performed.
 191 #  result is a boolean.
 192 ###
 193 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
 194   SET("${varRes}" OFF)
 195   IF(EXISTS "${path1}")
 196     GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
 197   ELSE()
 198     SET(_tmp1 "${path1}")
 199   ENDIF()
 200
 201   IF(EXISTS "${path2}")
 202     GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
 203   ELSE()
 204     SET(_tmp2 "${path2}")
 205   ENDIF()
 206
 207   IF("${_tmp1}" STREQUAL "${_tmp2}")
 208     SET("${varRes}" ON)
 209   ENDIF()
 210 #  MESSAGE(${${varRes}})
 211 ENDMACRO()
 212
 213 ####
 214 # SALOME_UPDATE_FLAG_AND_LOG_PACKAGE(pkg flag)
 215 #
 216 # Register in global variables the detection status (found or not) of the optional package 'pkg'
 217 # and the configuration flag that should be turned off if it is not found.
 218 # If the package was not found, the macro explicitly turns off the flag.
 219 # The global variables are read again by SALOME_PACKAGE_REPORT to produce a summary report
 220 # of the detection status, and of the modified flags.
 221 MACRO(SALOME_UPDATE_FLAG_AND_LOG_PACKAGE pkg flag)
 222   # Was the package found
 223   STRING(TOUPPER ${pkg} _pkg_UC)
 224   IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
 225     SET(_isFound TRUE)
 226   ELSE()
 227     SET(_isFound FALSE)
 228   ENDIF()
 229
 230   # Is the package already in the list? Then update its status:
 231   LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
 232   IF(NOT ${_result} EQUAL -1)
 233     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
 234     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
 235     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
 236     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
 237   ELSE()
 238     # Otherwise insert it
 239     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
 240     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
 241     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
 242   ENDIF()
 243
 244   # If the package was not found, force the cache flag to OFF
 245   IF(NOT _isFound)
 246     SET(${flag} OFF)
 247   ENDIF()
 248 ENDMACRO(SALOME_UPDATE_FLAG_AND_LOG_PACKAGE)
 249
 250 ####
 251 # SALOME_PACKAGE_REPORT()
 252 #
 253 # Print a quick summary of the detection of optional prerequisites.
 254 #
 255 MACRO(SALOME_PACKAGE_REPORT)
 256   MESSAGE(STATUS "")
 257   MESSAGE(STATUS "  Optional packages - Detection report ")
 258   MESSAGE(STATUS "  ==================================== ")
 259   MESSAGE(STATUS "")
 260   LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
 261   # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
 262   MATH(EXPR _range "${_list_len}-1")
 263   FOREACH(_idx RANGE ${_range})
 264     LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
 265     LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
 266     LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
 267     IF(_pkg_found)
 268       SET(_found_msg "Found")
 269       SET(_flag_msg "")
 270     ELSE()
 271       SET(_found_msg "NOT Found")
 272       SET(_flag_msg " - ${_pkg_flag} has been switched OFF.")
 273     ENDIF()
 274
 275     MESSAGE(STATUS "  * ${_pkg_name}  ->  ${_found_msg}${_flag_msg}")
 276   ENDFOREACH()
 277   MESSAGE(STATUS "")
 278   MESSAGE(STATUS "")
 279 ENDMACRO(SALOME_PACKAGE_REPORT)
 280
 281 ####
 282 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
 283 #
 284 # example:  SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
 285 #
 286 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
 287 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
 288 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
 289 #
 290 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
 291 # also handled properly.
 292 #
 293 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
 294 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
 295 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
 296 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
 297 # example).
 298 #
 299 # This macro is to be called from within the FindSalomeXXXX.cmake file.
 300 #
 301 ####
 302 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
 303   SET(_OPT_ARG ${ARGV3})
 304   # Only bother if the package was not already found:
 305   # Some old packages use the lower case version - standard should be to always use
 306   # upper case:
 307   STRING(TOUPPER ${stdPkg} stdPkgUC)
 308   IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
 309     IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
 310       SET(_tmp_quiet "QUIET")
 311     ELSE()
 312       SET(_tmp_quiet)
 313     ENDIF()
 314     IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
 315       SET(_tmp_req "REQUIRED")
 316     ELSE()
 317       SET(_tmp_req)
 318     ENDIF()
 319     IF(${englobPkg}_FIND_VERSION_EXACT)
 320       SET(_tmp_exact "EXACT")
 321     ELSE()
 322       SET(_tmp_exact)
 323     ENDIF()
 324
 325     # Call the CMake FIND_PACKAGE() command:
 326     STRING(TOLOWER ${stdPkg} _pkg_lc)
 327     IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
 328       # Hope to find direclty a CMake config file, indicating the SALOME CMake file
 329       # paths (the command already looks in places like "share/cmake", etc ... by default)
 330       # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
 331       # looking into a previous CMake build done via a GUI, or into the Win registry.
 332       # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
 333       # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
 334       # See documentation of FIND_PACKAGE() for full details.
 335
 336       # Do we need to call the signature using components?
 337       IF(${englobPkg}_FIND_COMPONENTS)
 338         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 339               NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
 340               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 341               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 342                 NO_SYSTEM_ENVIRONMENT_PATH)
 343       ELSE()
 344         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 345               NO_MODULE ${_tmp_quiet} ${_tmp_req}
 346               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 347               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 348                  NO_SYSTEM_ENVIRONMENT_PATH)
 349       ENDIF()
 350       MARK_AS_ADVANCED(${stdPkg}_DIR)
 351
 352     ELSEIF("${mode}" STREQUAL "MODULE")
 353
 354       # Do we need to call the signature using components?
 355       IF(${englobPkg}_FIND_COMPONENTS)
 356         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 357               MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
 358       ELSE()
 359         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 360               MODULE ${_tmp_quiet} ${_tmp_req})
 361       ENDIF()
 362
 363     ELSE()
 364
 365       MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
 366
 367     ENDIF()
 368
 369   ENDIF()
 370 ENDMACRO()
 371
 372
 373 ####################################################################
 374 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
 375 #    pkg              : name of the system package to be detected
 376 #    referenceVariable: variable containing a path that can be browsed up to
 377 # retrieve the package root directory (xxx_ROOT_DIR)
 378 #    upCount          : number of times we have to go up from the path <referenceVariable>
 379 # to obtain the package root directory.
 380 #
 381 # For example:  SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
 382 #
 383 # Generic detection (and conflict check) procedure for package XYZ:
 384 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
 385 #    If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
 386 # directly on XYZ)
 387 # 2. Invoke FIND_PACKAGE() in this order:
 388 #    * in CONFIG mode first (if possible): priority is given to a potential
 389 #    "XYZ-config.cmake" file
 390 #    * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
 391 # the above XYZ_ROOT_DIR variable
 392 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
 393 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
 394 #    instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
 395 # 5. Conflict detection:
 396 #    * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
 397 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
 398 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
 399 # conflict detection. This is added after the call to the macro by the callee.
 400 #
 401 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
 402   ##
 403   ## 0. Initialization
 404   ##
 405
 406   # Package name, upper case
 407   STRING(TOUPPER ${pkg} pkg_UC)
 408
 409   ##
 410   ## 1. Load environment or any previously detected root dir for the package
 411   ##
 412   IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 413     FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
 414     SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
 415   ELSE()
 416     # will be blank if no package was previously loaded:
 417     SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
 418   ENDIF()
 419
 420   # Detect if the variable has been set on the command line or elsewhere:
 421   IF(DEFINED ${pkg_UC}_ROOT_DIR)
 422      SET(_var_already_there TRUE)
 423   ELSE()
 424      SET(_var_already_there FALSE)
 425   ENDIF()
 426   #   Make cache entry
 427   SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
 428
 429   ##
 430   ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
 431   ##
 432
 433   # Override the variable - don't append to it, as it would give precedence
 434   # to what was stored there before!
 435   SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
 436
 437   # Try find_package in config mode. This has the priority, but is
 438   # performed QUIET and not REQUIRED:
 439   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
 440
 441   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 442     MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
 443   ENDIF()
 444
 445   # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
 446   # We do it quietly to produce our own error message:
 447   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
 448
 449   # Set the "FOUND" variable for the SALOME wrapper:
 450   IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
 451     SET(SALOME${pkg_UC}_FOUND TRUE)
 452   ELSE()
 453     SET(SALOME${pkg_UC}_FOUND FALSE)
 454     IF(NOT Salome${pkg}_FIND_QUIETLY)
 455       IF(Salome${pkg}_FIND_REQUIRED)
 456          MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 457          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}")
 458       ELSE()
 459          MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 460          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}")
 461       ENDIF()
 462     ENDIF()
 463   ENDIF()
 464
 465   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 466     ## 3. Set the root dir which was finally retained by going up "upDir" times
 467     ## from the given reference path. The variable "referenceVariable" may be a list.
 468     ## In this case we take its first element.
 469
 470     # First test if the variable exists and is not empty:
 471     IF((NOT DEFINED ${referenceVariable}) OR ("${${referenceVariable}}" STREQUAL ""))
 472       MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
 473       "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() does not exist or is empty.")
 474     ENDIF()
 475
 476     LIST(LENGTH ${referenceVariable} _tmp_len)
 477     IF(_tmp_len)
 478        LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
 479     ELSE()
 480        #  Note the double de-reference of "referenceVariable":
 481        SET(_tmp_ROOT_DIR "${${referenceVariable}}")
 482     ENDIF()
 483     IF(${upCount})
 484       MATH(EXPR _rge "${upCount}-1")
 485       FOREACH(_unused RANGE ${_rge})
 486         GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 487       ENDFOREACH()
 488     ENDIF()
 489
 490     ##
 491     ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 492     ##
 493     IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 494       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
 495       IF(NOT _res)
 496         MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
 497             "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
 498             "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
 499
 500       ELSE()
 501         MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
 502       ENDIF()
 503     ELSE()
 504         IF(NOT _var_already_there)
 505           MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
 506           "An installation was found anyway: ${_tmp_ROOT_DIR}")
 507         ENDIF()
 508     ENDIF()
 509
 510     ##
 511     ## 5. Conflict detection
 512     ##     From another prerequisite using the package:
 513     ##
 514     IF(${pkg_UC}_ROOT_DIR_EXP)
 515         SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
 516         IF(NOT _res)
 517            MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
 518                            " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
 519         ELSE()
 520             MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
 521         ENDIF()
 522     ENDIF()
 523
 524     ##
 525     ## 6. Save the detected installation
 526     ##
 527     SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
 528
 529   ELSE()
 530     MESSAGE(STATUS "${pkg} was not found.")
 531   ENDIF()
 532
 533   SET(Salome${pkg}_FOUND "${pkg}_FOUND")
 534 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
 535
 536
 537 ####################################################################
 538 # SALOME_ADD_MPI_TO_HDF5()
 539 #
 540 # Overload the HDF5 flags so that they also contain MPI references.
 541 # This is to be used when HDF5 was compiled with MPI support;
 542 MACRO(SALOME_ADD_MPI_TO_HDF5)
 543   SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
 544   SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
 545   SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
 546 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
 547
 548 ####################################################################
 549 # SALOME_XVERSION()
 550 #
 551 # Computes hexadecimal version of SALOME package
 552 #
 553 # USAGE: SALOME_XVERSION(package)
 554 #
 555 # ARGUMENTS:
 556 #
 557 # package: IN: SALOME package name
 558 #
 559 # The macro reads SALOME package version from PACKAGE_VERSION variable
 560 # (note package name in uppercase as assumed for SALOME modules);
 561 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
 562 # major, minor and maintenance components of package version in
 563 # hexadecimal form) is put to the PACKAGE_XVERSION variable
 564 MACRO(SALOME_XVERSION pkg)
 565   STRING(TOUPPER ${pkg} _pkg_UC)
 566   IF(${_pkg_UC}_VERSION)
 567     EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c "import sys; t=sys.argv[-1].split(\".\") ; t[:]=(int(elt) for elt in t) ; sys.stdout.write(\"0x%02x%02x%02x\"%tuple(t))" ${${_pkg_UC}_VERSION}
 568                     OUTPUT_VARIABLE ${_pkg_UC}_XVERSION)
 569   ENDIF()
 570 ENDMACRO(SALOME_XVERSION)