salome_adm/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(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 115       SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
 116     ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
 117     INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
 118     GET_FILENAME_COMPONENT(ext ${file} EXT)
 119     IF(ext STREQUAL .py)
 120       INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${path}/${file}\")")
 121       INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${path}/${file}')\")")
 122       INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
 123       INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
 124     ENDIF(ext STREQUAL .py)
 125   ENDFOREACH(file ${file_list})
 126 ENDMACRO(SALOME_INSTALL_SCRIPTS)
 127
 128 #----------------------------------------------------------------------------
 129 # SALOME_INSTALL_SCRIPTS is a macro useful for installing executable scripts.
 130 # ARGUMENTS:
 131 # PYFILE2COMPINST: IN : list of python files to be installed.
 132 # PYFILELOC: IN : full pathname for installing.
 133 # Permissions of installed files: OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ
 134 #----------------------------------------------------------------------------
 135 MACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
 136   INSTALL(CODE "SET(PYTHON_FILE ${f})")
 137   FOREACH(input ${PYFILE2COMPINST})
 138     GET_FILENAME_COMPONENT(inputname ${input} NAME)
 139     INSTALL(FILES ${input} DESTINATION ${CMAKE_INSTALL_PREFIX}/${PYFILELOC})
 140     INSTALL(CODE "MESSAGE(STATUS \"py compiling ${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}\")")
 141     INSTALL(CODE "SET(CMD \"import py_compile ; py_compile.compile('${CMAKE_INSTALL_PREFIX}/${PYFILELOC}/${inputname}')\")")
 142     INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -c \"\${CMD}\")")
 143     INSTALL(CODE "EXECUTE_PROCESS(COMMAND ${PYTHON_EXECUTABLE} -O -c \"\${CMD}\")")
 144   ENDFOREACH(input ${PYFILE2COMPINST})
 145 ENDMACRO(INSTALL_AND_COMPILE_PYTHON_FILE PYFILE2COMPINST PYFILELOC)
 146
 147 #----------------------------------------------------------------------------
 148 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
 149 # and modify its contents.
 150 #
 151 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
 152 #
 153 # ARGUMENTS:
 154 # in_file: IN : input file with full paths.
 155 # out_file: IN : output file with full paths.
 156 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
 157 #----------------------------------------------------------------------------
 158 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
 159   MESSAGE(STATUS "Creation of ${OUT_FILE}")
 160   CONFIGURE_FILE(${IN_FILE} ${OUT_FILE} @ONLY)
 161   PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
 162   IF(SALOME_CONFIGURE_FILE_INSTALL)
 163     INSTALL(FILES ${OUT_FILE} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
 164   ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
 165 ENDMACRO(SALOME_CONFIGURE_FILE)
 166
 167
 168 #######################################################################################
 169 # Useful macros for SALOME own package detection system
 170 #
 171
 172 ###
 173 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
 174 #  Check if two paths are identical, resolving links. If the paths do not exist a simple
 175 #  text comparison is performed.
 176 #  result is a boolean.
 177 ###
 178 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
 179   SET("${varRes}" OFF)
 180   IF(EXISTS "${path1}")
 181     GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
 182   ELSE()
 183     SET(_tmp1 "${path1}")
 184   ENDIF()
 185
 186   IF(EXISTS "${path2}")
 187     GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
 188   ELSE()
 189     SET(_tmp2 "${path2}")
 190   ENDIF()
 191
 192   IF("${_tmp1}" STREQUAL "${_tmp2}")
 193     SET("${varRes}" ON)
 194   ENDIF()
 195 #  MESSAGE(${${varRes}})
 196 ENDMACRO()
 197
 198
 199 ####
 200 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
 201 #
 202 # example:  SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
 203 #
 204 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
 205 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
 206 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
 207 #
 208 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
 209 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
 210 #
 211 # This macro is to be called from within the FindSalomeXXXX.cmake file.
 212 #
 213 ####
 214 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
 215   SET(_OPT_ARG ${ARGV3})
 216   # Only bother if the package was not already found:
 217   # Some old packages use the lower case version - standard should be to always use
 218   # upper case:
 219   STRING(TOUPPER ${stdPkg} stdPkgUC)
 220   IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
 221     IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
 222       SET(_tmp_quiet "QUIET")
 223     ELSE()
 224       SET(_tmp_quiet)
 225     ENDIF()
 226     IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
 227       SET(_tmp_req "REQUIRED")
 228     ELSE()
 229       SET(_tmp_req)
 230     ENDIF()
 231     IF(${englobPkg}_FIND_VERSION_EXACT)
 232       SET(_tmp_exact "EXACT")
 233     ELSE()
 234       SET(_tmp_exact)
 235     ENDIF()
 236
 237     # Call the CMake FIND_PACKAGE() command:
 238     STRING(TOLOWER ${stdPkg} _pkg_lc)
 239     IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
 240       # Hope to find direclty a CMake config file, indicating the SALOME CMake file
 241       # paths (the command already look in places like "share/cmake", etc ... by default)
 242       # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
 243       # looking into a previous CMake build done via a GUI, or into the Win registry.
 244       # See documentation of FIND_PACKAGE() for full details.
 245
 246       # Do we need to call the signature using components?
 247       IF(${englobPkg}_FIND_COMPONENTS)
 248         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 249               NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
 250               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 251               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY)
 252       ELSE()
 253         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 254               NO_MODULE ${_tmp_quiet} ${_tmp_req}
 255               PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files"
 256               NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY)
 257       ENDIF()
 258       MARK_AS_ADVANCED(${stdPkg}_DIR)
 259
 260     ELSEIF("${mode}" STREQUAL "MODULE")
 261
 262       # Do we need to call the signature using components?
 263       IF(${englobPkg}_FIND_COMPONENTS)
 264         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 265               MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
 266       ELSE()
 267         FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
 268               MODULE ${_tmp_quiet} ${_tmp_req})
 269       ENDIF()
 270
 271     ELSE()
 272
 273       MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
 274
 275     ENDIF()
 276
 277   ENDIF()
 278 ENDMACRO()
 279
 280
 281 ####################################################################
 282 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount <component1> <component2> ...)
 283 #    pkg              : name of the system package to be detected
 284 #    referenceVariable: variable containing a path that can be browsed up to
 285 # retrieve the package root directory (xxx_ROOT_DIR)
 286 #    upCount          : number of times we have to go up from the path <referenceVariable>
 287 # to obtain the package root directory.
 288 #    <component_n>    : an optional list of components to be found.
 289 #
 290 # For example:  SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
 291 #
 292 # Generic detection (and conflict check) procedure for package XYZ:
 293 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
 294 #    If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
 295 # directly on XYZ)
 296 # 2. Invoke FIND_PACKAGE() in this order:
 297 #    * in CONFIG mode first (if possible): priority is given to a potential
 298 #    "XYZ-config.cmake" file
 299 #    * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
 300 # the above XYZ_ROOT_DIR variable
 301 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
 302 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
 303 #    instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
 304 # 5. Conflict detection:
 305 #    * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
 306 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
 307 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
 308 # conflict detection. This is added after the call to the macro by the callee.
 309 #
 310 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
 311   ##
 312   ## 0. Initialization
 313   ##
 314
 315   # Package name, upper case
 316   STRING(TOUPPER ${pkg} pkg_UC)
 317
 318   ##
 319   ## 1. Load environment or any previously detected root dir for the package
 320   ##
 321   IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 322     FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
 323     SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
 324   ELSE()
 325     # will be blank if no package was previously loaded:
 326     SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
 327   ENDIF()
 328
 329   # Detect if the variable has been set on the command line or elsewhere:
 330   IF(DEFINED ${pkg_UC}_ROOT_DIR)
 331      SET(_var_already_there TRUE)
 332   ELSE()
 333      SET(_var_already_there FALSE)
 334   ENDIF()
 335   #   Make cache entry
 336   SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
 337
 338   ##
 339   ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
 340   ##
 341
 342   # Override the variable - don't append to it, as it would give precedence
 343   # to what was stored there before!
 344   SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
 345
 346   # Try find_package in config mode. This has the priority, but is
 347   # performed QUIET and not REQUIRED:
 348   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
 349
 350   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 351      MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
 352   ENDIF()
 353
 354   # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
 355   SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE)
 356
 357   # Set the "FOUND" variable for the SALOME wrapper:
 358   IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
 359     SET(SALOME${pkg_UC}_FOUND TRUE)
 360   ELSE()
 361     SET(SALOME${pkg_UC}_FOUND FALSE)
 362   ENDIF()
 363
 364   IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
 365     ## 3. Set the root dir which was finally retained by going up "upDir" times
 366     ## from the given reference path. The variable "referenceVariable" may be a list.
 367     ## In this case we take its first element.
 368     LIST(LENGTH ${referenceVariable} _tmp_len)
 369     IF(_tmp_len)
 370        LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
 371     ELSE()
 372        #  Note the double de-reference of "referenceVariable":
 373        SET(_tmp_ROOT_DIR "${${referenceVariable}}")
 374     ENDIF()
 375     IF(${upCount})
 376       MATH(EXPR _rge "${upCount}-1")
 377       FOREACH(_unused RANGE ${_rge})
 378         GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
 379       ENDFOREACH()
 380     ENDIF()
 381
 382     ##
 383     ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
 384     ##
 385     IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
 386       SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
 387       IF(NOT _res)
 388         MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
 389             "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
 390             "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
 391
 392       ELSE()
 393         MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
 394       ENDIF()
 395     ELSE()
 396         IF(NOT _var_already_there)
 397           MESSAGE(STATUS "Variable ${pkg_UC}_ROOT_DIR was not explicitly defined. "
 398           "An installation was found anyway: ${_tmp_ROOT_DIR}")
 399         ENDIF()
 400     ENDIF()
 401
 402     ##
 403     ## 5. Conflict detection
 404     ##     From another prerequisite using the package:
 405     ##
 406     IF(${pkg_UC}_ROOT_DIR_EXP)
 407         SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
 408         IF(NOT _res)
 409            MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
 410                            " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
 411         ELSE()
 412             MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
 413         ENDIF()
 414     ENDIF()
 415
 416     ##
 417     ## 6. Save the detected installation
 418     ##
 419     SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
 420
 421   ELSE()
 422     MESSAGE(STATUS "${pkg} was not found.")
 423   ENDIF()
 424
 425   SET(Salome${pkg}_FOUND "${pkg}_FOUND")
 426 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
 427