CMakeModules/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_LOG_OPTIONAL_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 to avoid detection of the package.
 218 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
 219 # a summary report of the detection status and stops the process if necessary.
 220 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
 221   # Was the package found
 222   STRING(TOUPPER ${pkg} _pkg_UC)
 223   IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
 224     SET(_isFound TRUE)
 225   ELSE()
 226     SET(_isFound FALSE)
 227   ENDIF()
 228
 229   # Is the package already in the list? Then update its status:
 230   LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
 231   IF(NOT ${_result} EQUAL -1)
 232     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
 233     LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
 234     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
 235     LIST(INSERT    _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
 236   ELSE()
 237     # Otherwise insert it
 238     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
 239     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
 240     LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
 241   ENDIF()
 242
 243 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
 244
 245 ####
 246 # SALOME_JUSTIFY_STRING()
 247 #
 248 # Justifies the string specified as an argument to the given length
 249 # adding required number of spaces to the end. Does noting if input
 250 # string is longer as required length.
 251 # Puts the result to the output variable.
 252 #
 253 # USAGE: SALOME_JUSTIFY_STRING(input length result)
 254 #
 255 # ARGUMENTS:
 256 #   input  [in] input string
 257 #   length [in] required length of resulting string
 258 #   result [out] name of variable where the result string is put to
 259 #
 260 MACRO(SALOME_JUSTIFY_STRING input length result)
 261   SET(${result} ${input})
 262   STRING(LENGTH ${input} _input_length)
 263   MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
 264   IF (_nb_spaces GREATER 0)
 265     FOREACH(_idx RANGE ${_nb_spaces})
 266       SET(${result} "${${result}} ")
 267     ENDFOREACH()
 268   ENDIF()
 269 ENDMACRO(SALOME_JUSTIFY_STRING)
 270
 271 ####
 272 # SALOME_PACKAGE_REPORT_AND_CHECK()
 273 #
 274 # Print a quick summary of the detection of optional prerequisites.
 275 # If a package was not found, the configuration is stopped. The summary also indicates
 276 # which flag should be turned off to skip the detection of the package.
 277 #
 278 # If optional JUSTIFY argument is specified, names of packages
 279 # are left-justified to the given length; default value is 10.
 280 #
 281 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
 282 #
 283 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 284   SET(_will_fail OFF)
 285   PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
 286   IF(SALOME_PACKAGE_REPORT_JUSTIFY)
 287     SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
 288   ELSE()
 289     SET(_length 23)
 290   ENDIF()
 291   MESSAGE(STATUS "")
 292   MESSAGE(STATUS "  Optional packages - Detection report ")
 293   MESSAGE(STATUS "  ==================================== ")
 294   MESSAGE(STATUS "")
 295   IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 296     LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
 297     # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
 298     MATH(EXPR _range "${_list_len}-1")
 299     FOREACH(_idx RANGE ${_range})
 300       LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
 301       LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
 302       LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
 303       SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
 304       IF(_pkg_found)
 305         SET(_found_msg "Found")
 306         SET(_flag_msg "")
 307       ELSE()
 308         SET(_will_fail ON)
 309         SET(_found_msg "NOT Found")
 310         SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
 311       ENDIF()
 312
 313       MESSAGE(STATUS "  * ${_pkg_name}  ->  ${_found_msg}${_flag_msg}")
 314     ENDFOREACH()
 315   ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
 316   MESSAGE(STATUS "")
 317   MESSAGE(STATUS "")
 318
 319   # Failure if some packages were missing:
 320   IF(_will_fail)
 321     MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
 322   ENDIF()
 323 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
 324
 325 ####
 326 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
 327 #
 328 # example:  SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
 329 #
 330 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
 331 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
 332 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
 333 #
 334 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
 335 # also handled properly.
 336 #
 337 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
 338 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
 339 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
 340 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
 341 # example).
 342 #
 343 # This macro is to be called from within the FindSalomeXXXX.cmake file.
 344 #
 345 ####
 346 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
 347   SET(_OPT_ARG ${ARGV3})
 348   # Only bother if the package was not already found:
 349   # Some old packages use the lower case version - standard should be to always use
 350   # upper case:
 351   STRING(TOUPPER ${stdPkg} stdPkgUC)
 352   IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
 353     IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
 354       SET(_tmp_quiet "QUIET")
 355     ELSE()
 356       SET(_tmp_quiet)
 357     ENDIF()
 358     IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
 359       SET(_tmp_req "REQUIRED")
 360     ELSE()
 361       SET(_tmp_req)
 362     ENDIF()
 363     IF(${englobPkg}_FIND_VERSION_EXACT)
 364       SET(_tmp_exact "EXACT")
 365     ELSE()
 366       SET(_tmp_exact)
 367     ENDIF()
 368
 369     # Call the CMake FIND_PACKAGE() command:
 370     STRING(TOLOWER ${stdPkg} _pkg_lc)
 371     IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
 372       # Hope to find direclty a CMake config file, indicating the SALOME CMake file
 373       # paths (the command already looks in places like "share/cmake", etc ... by default)
 374       # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
 375       # looking into a previous CMake build done via a GUI, or into the Win registry.
 376       # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
 377       # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
 378       # See documentation of FIND_PACKAGE() for full details.
 379
 380       # Do we need to call the signature using components?
 381       IF(${englobPkg}_FIND_COMPONENTS)
 382         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 383               NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
 384               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 385               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 386                 NO_SYSTEM_ENVIRONMENT_PATH)
 387       ELSE()
 388         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 389               NO_MODULE ${_tmp_quiet} ${_tmp_req}
 390               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 391               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
 392                  NO_SYSTEM_ENVIRONMENT_PATH)
 393       ENDIF()
 394       MARK_AS_ADVANCED(${stdPkg}_DIR)
 395
 396     ELSEIF("${mode}" STREQUAL "MODULE")
 397
 398       # Do we need to call the signature using components?
 399       IF(${englobPkg}_FIND_COMPONENTS)
 400         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 401               MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
 402       ELSE()
 403         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 404               MODULE ${_tmp_quiet} ${_tmp_req})
 405       ENDIF()
 406
 407     ELSE()
 408
 409       MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
 410
 411     ENDIF()
 412
 413   ENDIF()
 414 ENDMACRO()
 415
 416
 417 ####################################################################
 418 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
 419 #    pkg              : name of the system package to be detected
 420 #    referenceVariable: variable containing a path that can be browsed up to
 421 # retrieve the package root directory (xxx_ROOT_DIR)
 422 #    upCount          : number of times we have to go up from the path <referenceVariable>
 423 # to obtain the package root directory.
 424 #
 425 # For example:  SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
 426 #
 427 # Generic detection (and conflict check) procedure for package XYZ:
 428 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
 429 #    If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
 430 # directly on XYZ)
 431 # 2. Invoke FIND_PACKAGE() in this order:
 432 #    * in CONFIG mode first (if possible): priority is given to a potential
 433 #    "XYZ-config.cmake" file
 434 #    * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
 435 # the above XYZ_ROOT_DIR variable
 436 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
 437 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
 438 #    instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
 439 # 5. Conflict detection:
 440 #    * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
 441 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
 442 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
 443 # conflict detection. This is added after the call to the macro by the callee.
 444 #
 445 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
 446   ##
 447   ## 0. Initialization
 448   ##
 449
 450   # Package name, upper case
 451   STRING(TOUPPER ${pkg} pkg_UC)
 452
 453   ##
 454   ## 1. Load environment or any previously detected root dir for the package
 455   ##
 456   IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 457     FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
 458     SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
 459   ELSE()
 460     # will be blank if no package was previously loaded:
 461     SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
 462   ENDIF()
 463
 464   # Detect if the variable has been set on the command line or elsewhere:
 465   IF(DEFINED ${pkg_UC}_ROOT_DIR)
 466      SET(_var_already_there TRUE)
 467   ELSE()
 468      SET(_var_already_there FALSE)
 469   ENDIF()
 470   #   Make cache entry
 471   SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
 472
 473   ##
 474   ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
 475   ##
 476
 477   # Override the variable - don't append to it, as it would give precedence
 478   # to what was stored there before!
 479   SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
 480
 481   # Try find_package in config mode. This has the priority, but is
 482   # performed QUIET and not REQUIRED:
 483   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
 484
 485   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 486     MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
 487   ENDIF()
 488
 489   # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
 490   # We do it quietly to produce our own error message, except if we are in debug mode:
 491   IF(SALOME_CMAKE_DEBUG)
 492     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
 493   ELSE()
 494     SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
 495   ENDIF()
 496
 497   # Set the "FOUND" variable for the SALOME wrapper:
 498   IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
 499     SET(SALOME${pkg_UC}_FOUND TRUE)
 500   ELSE()
 501     SET(SALOME${pkg_UC}_FOUND FALSE)
 502     IF(NOT Salome${pkg}_FIND_QUIETLY)
 503       IF(Salome${pkg}_FIND_REQUIRED)
 504          MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 505          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}  "
 506          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 507       ELSE()
 508          MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
 509          "It currently contains ${pkg_UC}_ROOT_DIR=${${pkg_UC}_ROOT_DIR}  "
 510          "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
 511       ENDIF()
 512     ENDIF()
 513   ENDIF()
 514
 515   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 516     ## 3. Set the root dir which was finally retained by going up "upDir" times
 517     ## from the given reference path. The variable "referenceVariable" may be a list.
 518     ## In this case we take its first element.
 519
 520     # First test if the variable exists, warn otherwise:
 521     IF(NOT DEFINED ${referenceVariable})
 522       MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
 523       "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
 524     ENDIF()
 525
 526     LIST(LENGTH ${referenceVariable} _tmp_len)
 527     IF(_tmp_len)
 528        LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
 529     ELSE()
 530        #  Note the double de-reference of "referenceVariable":
 531        SET(_tmp_ROOT_DIR "${${referenceVariable}}")
 532     ENDIF()
 533     IF(${upCount})
 534       FOREACH(_unused RANGE 1 ${upCount})
 535         GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 536       ENDFOREACH()
 537     ENDIF()
 538
 539     ##
 540     ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 541     ##
 542     IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 543       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
 544       IF(NOT _res)
 545         MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
 546             "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
 547             "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
 548
 549       ELSE()
 550         MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
 551       ENDIF()
 552     ELSE()
 553         IF(NOT _var_already_there)
 554           MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
 555           "An installation was found anyway: ${_tmp_ROOT_DIR}")
 556         ENDIF()
 557     ENDIF()
 558
 559     ##
 560     ## 5. Conflict detection
 561     ##     From another prerequisite using the package:
 562     ##
 563     IF(${pkg_UC}_ROOT_DIR_EXP)
 564         SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
 565         IF(NOT _res)
 566            MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
 567                            " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
 568         ELSE()
 569             MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
 570         ENDIF()
 571     ENDIF()
 572
 573     ##
 574     ## 6. Save the detected installation
 575     ##
 576     SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
 577
 578   ELSE()
 579     MESSAGE(STATUS "${pkg} was not found.")
 580   ENDIF()
 581
 582   SET(Salome${pkg}_FOUND "${pkg}_FOUND")
 583 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
 584
 585
 586 ####################################################################
 587 # SALOME_ADD_MPI_TO_HDF5()
 588 #
 589 # Overload the HDF5 flags so that they also contain MPI references.
 590 # This is to be used when HDF5 was compiled with MPI support;
 591 MACRO(SALOME_ADD_MPI_TO_HDF5)
 592   SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
 593   SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
 594   SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
 595 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
 596
 597 ####################################################################
 598 # SALOME_XVERSION()
 599 #
 600 # Computes hexadecimal version of SALOME package
 601 #
 602 # USAGE: SALOME_XVERSION(package)
 603 #
 604 # ARGUMENTS:
 605 #
 606 # package: IN: SALOME package name
 607 #
 608 # The macro reads SALOME package version from PACKAGE_VERSION variable
 609 # (note package name in uppercase as assumed for SALOME modules);
 610 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
 611 # major, minor and maintenance components of package version in
 612 # hexadecimal form) is put to the PACKAGE_XVERSION variable
 613 MACRO(SALOME_XVERSION pkg)
 614   STRING(TOUPPER ${pkg} _pkg_UC)
 615   IF(${_pkg_UC}_VERSION)
 616     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}
 617                     OUTPUT_VARIABLE ${_pkg_UC}_XVERSION)
 618   ENDIF()
 619 ENDMACRO(SALOME_XVERSION)
 620
 621 #########################################################################
 622 # SALOME_ACCUMULATE_HEADERS()
 623 #
 624 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
 625 # internally the list of include headers to be saved for future export.
 626 # The full set of include is saved in a variable called
 627 #      _${PROJECT_NAME}_EXTRA_HEADERS
 628 #
 629 MACRO(SALOME_ACCUMULATE_HEADERS lst)
 630   FOREACH(l IN LISTS ${lst})
 631     LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
 632     IF(_res EQUAL "-1")
 633       IF(NOT "${l}" STREQUAL "/usr/include")
 634         LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
 635       ENDIF()
 636     ENDIF()
 637   ENDFOREACH()
 638 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
 639
 640 #########################################################################
 641 # SALOME_ACCUMULATE_ENVIRONMENT()
 642 #
 643 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
 644 #
 645 # ARGUMENTS:
 646 #   envvar [in] environment variable name, e.g. PATH
 647 #   value  [in] value(s) to be added to environment variable
 648 #
 649 # This macro is called in the various FindSalomeXYZ.cmake modules to
 650 # accumulate environment variables, to be used later to run some command
 651 # in proper environment.
 652 #
 653 # 1. Each envrironment variable is stored in specific CMake variable
 654 #    _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
 655 # 2. Full list of environment variable names is stored in CMake variable
 656 #    _${PROJECT_NAME}_EXTRA_ENV.
 657 #
 658 # Notes:
 659 # - The arguments list can include optional CHECK or NOCHECK keywords:
 660 #   * For all arguments following CHECK keyword the macro perform an
 661 #     additional check (see below); this is the default mode, it is suitable
 662 #     for path variables (PATH, LD_LIBRARY_PATH, etc).
 663 #   * For all arguments following NOCHECK keyword, no additional check is
 664 #     performed.
 665 #   Checking an argument means that we check:
 666 #    - That the path actually exists
 667 #    - That this is not a standard system path (starting with "/usr"); this avoids
 668 #   polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
 669 #
 670 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
 671   SET(_is_check ON)
 672   FOREACH(_item ${ARGN})
 673     IF(${_item} STREQUAL "NOCHECK")
 674       SET(_is_check OFF)
 675     ELSEIF(${_item} STREQUAL "CHECK")
 676       SET(_is_check ON)
 677     ELSE()
 678       IF(_is_check)
 679         IF(NOT IS_DIRECTORY ${_item})
 680           IF(TARGET ${_item})
 681             GET_TARGET_PROPERTY(_item ${_item} LOCATION)
 682           ENDIF()
 683           GET_FILENAME_COMPONENT(_item ${_item} PATH)
 684         ENDIF()
 685         IF(EXISTS ${_item})
 686           STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
 687           LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 688           IF(NOT _usr_find AND _res EQUAL -1)
 689               LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 690           ENDIF()
 691         ENDIF()
 692       ELSE(_is_check)
 693         LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
 694         IF( _res EQUAL -1)
 695           LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
 696         ENDIF()
 697       ENDIF(_is_check)
 698     ENDIF()
 699   ENDFOREACH()
 700
 701   LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
 702   IF(_res EQUAL -1)
 703     LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
 704   ENDIF()
 705   SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
 706   FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
 707     SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_${PROJECT_NAME}_EXTRA_ENV_${_res}}\)")
 708   ENDFOREACH()
 709 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
 710
 711 #########################################################################
 712 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
 713 #
 714 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
 715 #
 716 # ARGUMENTS:
 717 #   output [out] output command, e.g. for creation of target.
 718 #   script [in]  output environement script name
 719 #   cmd    [in]  input command, e.g. sphinx or python command.
 720 #   opts   [in]  options for input command (cmd).
 721 #
 722 # This macro is called when it's necessary to use given environment to run some command.
 723 # Macro generates environement script using previously created variables
 724 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
 725 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
 726 # and puts generated command in proper environment into <output> argument.
 727 #
 728 # Notes:
 729 # - If <script> is specified as relative path, it is computed from the current build
 730 #   directory.
 731 #
 732 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
 733   IF(IS_ABSOLUTE ${script})
 734     SET(_script ${script})
 735   ELSE()
 736     SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
 737   ENDIF()
 738
 739   SET(_env)
 740   FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 741     FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 742       IF(WIN32)
 743         IF(${_item} STREQUAL "LD_LIBRARY_PATH")
 744           SET(_item PATH)
 745         ENDIF()
 746         STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
 747         SET(_ext "bat")
 748         SET(_call_cmd "call")
 749       ELSE(WIN32)
 750         SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
 751         SET(_ext "sh")
 752         SET(_call_cmd ".")
 753       ENDIF(WIN32)
 754     ENDFOREACH()
 755   ENDFOREACH()
 756
 757   SET(_script ${_script}.${_ext})
 758   FILE(WRITE ${_script} "${_env}")
 759
 760   SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
 761
 762 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
 763
 764 #########################################################################
 765 # SALOME_GENERATE_TESTS_ENVIRONMENT()
 766 #
 767 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
 768 #
 769 # ARGUMENTS:
 770 #   output [out] output environement variable.
 771 #
 772 # This macro generates <output> variable to use given environment to run some tests.
 773 # Macro generates environement variable using previously created variables
 774 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
 775 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
 776 # and puts this variable into <output> argument.
 777 #
 778 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
 779   SET(_env)
 780   FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
 781     FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
 782       IF(WIN32)
 783         SET(_env "${_val};${_env}")
 784       ELSE()
 785         SET(_env "${_val}:${_env}")
 786       ENDIF()
 787     ENDFOREACH()
 788     SET(_env " ${_item}=${_env}")
 789   ENDFOREACH()
 790   SET(${output} ${_env})
 791 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
 792
 793 #########################################################################
 794 # SALOME_APPEND_LIST_OF_LIST()
 795 #
 796 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
 797 #
 798 # Build a list of lists. The element_list is first parsed to convert it
 799 # from
 800 #     a;b;c;d;e
 801 # to
 802 #     a,b,c,d,e
 803 #
 804 # It is then added to the big list 'result'. Hence 'result' looks like:
 805 #     a,b,c,d,e;f,g,h; ...
 806 #
 807 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
 808   SET(_tmp_res)
 809   STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
 810   SET(${result} "${${result}};${_tmp_res}")  # LIST(APPEND ...) doesn't handle well empty elements!?
 811 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
 812
 813 #########################################################################
 814 # SALOME_CONFIGURE_PREPARE()
 815 #
 816 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
 817 #
 818 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
 819 # namely:
 820 #    - _PREREQ_LIST      : the list of level 1 external prerequisites
 821 #    - _PREREQ_DIR_LIST  : their corresponding CMake directories (i.e. where the CMake configuration
 822 #    file for this package can be found, if there is any!)
 823 #    - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
 824 #
 825 # All this information is built from the package_list, the list of level 1 packages for this module.
 826 # Only the packages found in CONFIG mode are retained.
 827 #
 828 MACRO(SALOME_CONFIGURE_PREPARE)
 829   SET(_tmp_prereq "${ARGV}")
 830   SET(_PREREQ_LIST)
 831   SET(_PREREQ_DIR_LIST)
 832   SET(_PREREQ_COMPO_LIST)
 833   FOREACH(_prereq IN LISTS _tmp_prereq)
 834     IF(${_prereq}_DIR)
 835       SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
 836       SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${${_prereq}_DIR}\"")
 837       SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
 838     ENDIF()
 839   ENDFOREACH()
 840 ENDMACRO(SALOME_CONFIGURE_PREPARE)