1 # Copyright (C) 2012-2016 CEA/DEN, EDF R&D, OPEN CASCADE
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.
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.
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
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 # Author: A.Geay, V. Sandler, A. Bruneton
22 #----------------------------------------------------------------------------
23 # LIST_CONTAINS is a macro useful for determining whether a list has a
25 #----------------------------------------------------------------------------
26 MACRO(LIST_CONTAINS var value)
28 FOREACH(value2 ${ARGN})
29 IF(${value} STREQUAL "${value2}")
31 ENDIF (${value} STREQUAL "${value2}")
33 ENDMACRO(LIST_CONTAINS)
35 #----------------------------------------------------------------------------
36 # The PARSE_ARGUMENTS macro will take the arguments of another macro and
37 # define several variables.
39 # USAGE: PARSE_ARGUMENTS(prefix arg_names options arg1 arg2...)
43 # prefix: IN: a prefix to put on all variables it creates.
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.
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
61 # arg_names and options lists should be quoted.
63 # The rest of PARSE_ARGUMENTS are arguments from another macro to be parsed.
64 #----------------------------------------------------------------------------
65 MACRO(PARSE_ARGUMENTS prefix arg_names option_names)
67 FOREACH(arg_name ${arg_names})
68 SET(${prefix}_${arg_name})
70 FOREACH(option ${option_names})
71 SET(${prefix}_${option} FALSE)
73 SET(current_arg_name DEFAULT_ARGS)
76 LIST_CONTAINS(is_arg_name ${arg} ${arg_names})
78 SET(${prefix}_${current_arg_name} ${current_arg_list})
79 SET(current_arg_name ${arg})
82 LIST_CONTAINS(is_option ${arg} ${option_names})
84 SET(${prefix}_${arg} TRUE)
86 SET(current_arg_list ${current_arg_list} ${arg})
90 SET(${prefix}_${current_arg_name} ${current_arg_list})
91 ENDMACRO(PARSE_ARGUMENTS)
93 #----------------------------------------------------------------------------
94 # SALOME_INSTALL_SCRIPTS is a macro useful for installing scripts.
96 # USAGE: SALOME_INSTALL_SCRIPTS(file_list path [WORKING_DIRECTORY dir] [DEF_PERMS] [TARGET_NAME name])
99 # file_list: IN : list of files to be installed. This list should be quoted.
100 # path: IN : full pathname for installing.
102 # By default files to be installed as executable scripts.
103 # If DEF_PERMS option is provided, than permissions for installed files are
104 # only OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ.
105 # WORKING_DIRECTORY option may be used to specify the relative or absolute
106 # path to the directory containing source files listed in file_list argument.
107 # If TARGET_NAME option is specified, the name of the target being created
108 # with this macro is returned via the given variable.
109 #----------------------------------------------------------------------------
110 MACRO(SALOME_INSTALL_SCRIPTS file_list path)
111 PARSE_ARGUMENTS(SALOME_INSTALL_SCRIPTS "WORKING_DIRECTORY;TARGET_NAME" "DEF_PERMS" ${ARGN})
112 SET(PERMS OWNER_READ OWNER_WRITE GROUP_READ WORLD_READ)
113 IF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
114 SET(PERMS ${PERMS} OWNER_EXECUTE GROUP_EXECUTE WORLD_EXECUTE)
115 ENDIF(NOT SALOME_INSTALL_SCRIPTS_DEF_PERMS)
119 FOREACH(file ${file_list})
121 SET(_source_prefix "")
122 GET_FILENAME_COMPONENT(file_name ${file} NAME)
123 IF(NOT IS_ABSOLUTE ${file})
124 IF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
125 SET(PREFIX "${SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY}/")
126 ENDIF(SALOME_INSTALL_SCRIPTS_WORKING_DIRECTORY)
127 SET(_source_prefix "${CMAKE_CURRENT_SOURCE_DIR}/")
128 ENDIF(NOT IS_ABSOLUTE ${file})
129 INSTALL(FILES ${PREFIX}${file} DESTINATION ${path} PERMISSIONS ${PERMS})
130 GET_FILENAME_COMPONENT(ext ${file} EXT)
131 GET_FILENAME_COMPONENT(we_ext ${file} NAME_WE)
134 # Generate and install the pyc and pyo
135 # [ABN] Important: we avoid references or usage of CMAKE_INSTALL_PREFIX which is not correctly set
137 SET(_pyc_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.pyc")
138 SET(_pyo_file "${CMAKE_CURRENT_BINARY_DIR}/${we_ext}.pyo")
139 LIST(APPEND _all_pyc ${_pyc_file})
140 LIST(APPEND _all_pyo ${_pyo_file})
143 COMMAND ${PYTHON_EXECUTABLE} -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyc_file}', doraise=True )"
144 DEPENDS ${PREFIX}${file}
149 COMMAND ${PYTHON_EXECUTABLE} -O -c "import py_compile ; py_compile.compile('${_source_prefix}${file}', '${_pyo_file}', doraise=True )"
150 DEPENDS ${PREFIX}${file}
153 # Install the .pyo and the .pyc
154 INSTALL(FILES ${_pyc_file} DESTINATION ${path} PERMISSIONS ${PERMS})
155 INSTALL(FILES ${_pyo_file} DESTINATION ${path} PERMISSIONS ${PERMS})
156 ENDIF(ext STREQUAL .py)
158 # get relativa path (from CMAKE_SOURCE_DIR to CMAKE_CURRENT_SOURCE_DIR)
159 STRING(REGEX REPLACE ${CMAKE_SOURCE_DIR} "" rel_dir ${CMAKE_CURRENT_SOURCE_DIR})
162 STRING(REGEX REPLACE "/" "_" unique_name ${rel_dir})
167 ENDFOREACH(file ${file_list})
168 # Generate only one target for all requested Python script compilation.
169 # Make sure that the target name is unique too.
172 WHILE(TARGET "PYCOMPILE${unique_name}_${_cnt}")
173 MATH(EXPR _cnt ${_cnt}+1)
175 SET(_target_name "PYCOMPILE${unique_name}_${_cnt}")
176 ADD_CUSTOM_TARGET(${_target_name} ALL DEPENDS ${_all_pyc} ${_all_pyo})
177 IF(SALOME_INSTALL_SCRIPTS_TARGET_NAME)
178 SET(${SALOME_INSTALL_SCRIPTS_TARGET_NAME} ${_target_name})
179 ENDIF(SALOME_INSTALL_SCRIPTS_TARGET_NAME)
181 ENDMACRO(SALOME_INSTALL_SCRIPTS)
183 #----------------------------------------------------------------------------
184 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
185 # and modify its contents.
187 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
190 # in_file: IN : input file (if relative path is given, full file path is computed from current source dir).
191 # out_file: IN : output file (if relative path is given, full file path is computed from current build dir).
192 # If INSTALL is specified, then 'out_file' will be installed to the 'dir' directory.
193 #----------------------------------------------------------------------------
194 MACRO(SALOME_CONFIGURE_FILE IN_FILE OUT_FILE)
195 IF(IS_ABSOLUTE ${IN_FILE})
196 SET(_in_file ${IN_FILE})
198 SET(_in_file ${CMAKE_CURRENT_SOURCE_DIR}/${IN_FILE})
200 IF(IS_ABSOLUTE ${OUT_FILE})
201 SET(_out_file ${OUT_FILE})
203 SET(_out_file ${CMAKE_CURRENT_BINARY_DIR}/${OUT_FILE})
205 MESSAGE(STATUS "Creation of ${_out_file}")
206 CONFIGURE_FILE(${_in_file} ${_out_file} @ONLY)
207 PARSE_ARGUMENTS(SALOME_CONFIGURE_FILE "INSTALL" "" ${ARGN})
208 IF(SALOME_CONFIGURE_FILE_INSTALL)
209 INSTALL(FILES ${_out_file} DESTINATION ${SALOME_CONFIGURE_FILE_INSTALL})
210 ENDIF(SALOME_CONFIGURE_FILE_INSTALL)
211 ENDMACRO(SALOME_CONFIGURE_FILE)
214 #######################################################################################
215 # Useful macros for SALOME own package detection system
219 # SALOME_CHECK_EQUAL_PATHS(result path1 path2)
220 # Check if two paths are identical, resolving links. If the paths do not exist a simple
221 # text comparison is performed.
222 # result is a boolean.
224 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
226 IF(EXISTS "${path1}")
227 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
229 SET(_tmp1 "${path1}")
232 IF(EXISTS "${path2}")
233 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
235 SET(_tmp2 "${path2}")
238 IF("${_tmp1}" STREQUAL "${_tmp2}")
241 # MESSAGE(${${varRes}})
245 # SALOME_LOG_OPTIONAL_PACKAGE(pkg flag)
247 # Register in global variables the detection status (found or not) of the optional package 'pkg'
248 # and the configuration flag that should be turned off to avoid detection of the package.
249 # The global variables are read again by SALOME_PACKAGE_REPORT_AND_CHECK to produce
250 # a summary report of the detection status and stops the process if necessary.
251 MACRO(SALOME_LOG_OPTIONAL_PACKAGE pkg flag)
252 # Was the package found
253 STRING(TOUPPER ${pkg} _pkg_UC)
254 IF(${pkg}_FOUND OR ${_pkg_UC}_FOUND)
260 # Is the package already in the list? Then update its status:
261 LIST(FIND _SALOME_OPTIONAL_PACKAGES_names ${pkg} _result)
262 IF(NOT ${_result} EQUAL -1)
263 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_found ${_result})
264 LIST(REMOVE_AT _SALOME_OPTIONAL_PACKAGES_flags ${_result})
265 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_found ${_result} ${_isFound})
266 LIST(INSERT _SALOME_OPTIONAL_PACKAGES_flags ${_result} ${flag})
268 # Otherwise insert it
269 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_names ${pkg})
270 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_found ${_isFound})
271 LIST(APPEND _SALOME_OPTIONAL_PACKAGES_flags ${flag})
274 ENDMACRO(SALOME_LOG_OPTIONAL_PACKAGE)
277 # SALOME_JUSTIFY_STRING()
279 # Justifies the string specified as an argument to the given length
280 # adding required number of spaces to the end. Does noting if input
281 # string is longer as required length.
282 # Puts the result to the output variable.
284 # USAGE: SALOME_JUSTIFY_STRING(input length result)
287 # input [in] input string
288 # length [in] required length of resulting string
289 # result [out] name of variable where the result string is put to
291 MACRO(SALOME_JUSTIFY_STRING input length result)
292 SET(${result} ${input})
293 STRING(LENGTH ${input} _input_length)
294 MATH(EXPR _nb_spaces "${length}-${_input_length}-1")
295 IF (_nb_spaces GREATER 0)
296 FOREACH(_idx RANGE ${_nb_spaces})
297 SET(${result} "${${result}} ")
300 ENDMACRO(SALOME_JUSTIFY_STRING)
303 # SALOME_PACKAGE_REPORT_AND_CHECK()
305 # Print a quick summary of the detection of optional prerequisites.
306 # If a package was not found, the configuration is stopped. The summary also indicates
307 # which flag should be turned off to skip the detection of the package.
309 # If optional JUSTIFY argument is specified, names of packages
310 # are left-justified to the given length; default value is 10.
312 # USAGE: SALOME_PACKAGE_REPORT_AND_CHECK([JUSTIFY length])
314 MACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
316 PARSE_ARGUMENTS(SALOME_PACKAGE_REPORT "JUSTIFY" "" ${ARGN})
317 IF(SALOME_PACKAGE_REPORT_JUSTIFY)
318 SET(_length ${SALOME_PACKAGE_REPORT_JUSTIFY})
323 MESSAGE(STATUS " Optional packages - Detection report ")
324 MESSAGE(STATUS " ==================================== ")
326 IF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
327 LIST(LENGTH _SALOME_OPTIONAL_PACKAGES_names _list_len)
328 # Another CMake stupidity - FOREACH(... RANGE r) generates r+1 numbers ...
329 MATH(EXPR _range "${_list_len}-1")
330 FOREACH(_idx RANGE ${_range})
331 LIST(GET _SALOME_OPTIONAL_PACKAGES_names ${_idx} _pkg_name)
332 LIST(GET _SALOME_OPTIONAL_PACKAGES_found ${_idx} _pkg_found)
333 LIST(GET _SALOME_OPTIONAL_PACKAGES_flags ${_idx} _pkg_flag)
334 SALOME_JUSTIFY_STRING(${_pkg_name} ${_length} _pkg_name)
336 SET(_found_msg "Found")
340 SET(_found_msg "NOT Found")
341 SET(_flag_msg " - ${_pkg_flag} can be switched OFF to skip this prerequisite.")
344 MESSAGE(STATUS " * ${_pkg_name} -> ${_found_msg}${_flag_msg}")
346 ENDIF(DEFINED _SALOME_OPTIONAL_PACKAGES_names)
350 # Failure if some packages were missing:
352 MESSAGE(FATAL_ERROR "Some required prerequisites have NOT been found. Take a look at the report above to fix this.")
354 ENDMACRO(SALOME_PACKAGE_REPORT_AND_CHECK)
357 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus [onlyTryQuietly])
359 # example: SALOME_FIND_PACKAGE(SalomeVTK VTK CONFIG)
361 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
362 # given when calling the command FIND_PACKAGE(SalomeXYZ). Those options are stored implicitly in
363 # CMake variables: xyz__FIND_QUIETLY, xyz_FIND_REQUIRED, etc ...
365 # If a list of components was specified when invoking the initial FIND_PACKAGE(SalomeXyz ...) this is
366 # also handled properly.
368 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
369 # The last argument is optional and if set to TRUE will force the search to be OPTIONAL and QUIET.
370 # If the package is looked for in CONFIG mode, the standard system paths are skipped. If you still want a
371 # system installation to be found in this mode, you have to set the ROOT_DIR variable explicitly to /usr (for
374 # This macro is to be called from within the FindSalomeXXXX.cmake file.
377 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
378 SET(_OPT_ARG ${ARGV3})
379 # Only bother if the package was not already found:
380 # Some old packages use the lower case version - standard should be to always use
382 STRING(TOUPPER ${stdPkg} stdPkgUC)
383 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
384 IF(${englobPkg}_FIND_QUIETLY OR _OPT_ARG)
385 SET(_tmp_quiet "QUIET")
389 IF(${englobPkg}_FIND_REQUIRED AND NOT _OPT_ARG)
390 SET(_tmp_req "REQUIRED")
394 IF(${englobPkg}_FIND_VERSION_EXACT)
395 SET(_tmp_exact "EXACT")
400 # Call the CMake FIND_PACKAGE() command:
401 STRING(TOLOWER ${stdPkg} _pkg_lc)
402 IF(("${mode}" STREQUAL "NO_MODULE") OR ("${mode}" STREQUAL "CONFIG"))
403 # Hope to find direclty a CMake config file, indicating the SALOME CMake file
404 # paths (the command already looks in places like "share/cmake", etc ... by default)
405 # Note the options NO_CMAKE_BUILDS_PATH, NO_CMAKE_PACKAGE_REGISTRY to avoid (under Windows)
406 # looking into a previous CMake build done via a GUI, or into the Win registry.
407 # NO_CMAKE_SYSTEM_PATH and NO_SYSTEM_ENVIRONMENT_PATH ensure any _system_ files like 'xyz-config.cmake'
408 # don't get loaded (typically Boost). To force their loading, set the XYZ_ROOT_DIR variable to '/usr'.
409 # See documentation of FIND_PACKAGE() for full details.
411 # Do we need to call the signature using components?
412 IF(${englobPkg}_FIND_COMPONENTS)
413 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
414 NO_MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS}
415 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
416 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
417 NO_SYSTEM_ENVIRONMENT_PATH)
419 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
420 NO_MODULE ${_tmp_quiet} ${_tmp_req}
421 PATH_SUFFIXES "salome_adm/cmake_files" "adm_local/cmake_files" "adm/cmake"
422 NO_CMAKE_BUILDS_PATH NO_CMAKE_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PACKAGE_REGISTRY NO_CMAKE_SYSTEM_PATH
423 NO_SYSTEM_ENVIRONMENT_PATH)
425 MARK_AS_ADVANCED(${stdPkg}_DIR)
427 ELSEIF("${mode}" STREQUAL "MODULE")
429 # Do we need to call the signature using components?
430 IF(${englobPkg}_FIND_COMPONENTS)
431 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
432 MODULE ${_tmp_quiet} ${_tmp_req} COMPONENTS ${${englobPkg}_FIND_COMPONENTS})
434 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact}
435 MODULE ${_tmp_quiet} ${_tmp_req})
440 MESSAGE(FATAL_ERROR "Invalid mode argument in the call to the macro SALOME_FIND_PACKAGE. Should be CONFIG or MODULE.")
448 ####################################################################
449 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
450 # pkg : name of the system package to be detected
451 # referenceVariable: variable containing a path that can be browsed up to
452 # retrieve the package root directory (xxx_ROOT_DIR)
453 # upCount : number of times we have to go up from the path <referenceVariable>
454 # to obtain the package root directory.
455 # If this is a path to a file, going up one time gives the directory containing the file
456 # going up 2 times gives the parent directory.
458 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
459 # with SWIG_EXECUTABLE set to '/usr/bin/swig'
460 # will produce '/usr'
462 # Generic detection (and conflict check) procedure for package XYZ:
463 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
464 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
466 # 2. Invoke FIND_PACKAGE() in this order:
467 # * in CONFIG mode first (if possible): priority is given to a potential
468 # "XYZ-config.cmake" file
469 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
470 # the above XYZ_ROOT_DIR variable
471 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
472 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
473 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
474 # 5. Conflict detection:
475 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
476 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
477 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
478 # conflict detection. This is added after the call to the macro by the callee.
480 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
484 PARSE_ARGUMENTS(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS "ENVVAR" "" ${ARGN})
486 # Package name, upper case
487 STRING(TOUPPER ${pkg} pkg_UC)
490 ## 1. Load environment or any previously detected root dir for the package
492 SET(_envvar ${pkg_UC}_ROOT_DIR)
493 IF(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS_ENVVAR)
494 SET(_envvar "${SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS_ENVVAR}")
496 IF(DEFINED ENV{${_envvar}})
497 FILE(TO_CMAKE_PATH "$ENV{${_envvar}}" _${pkg_UC}_ROOT_DIR_ENV)
498 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
500 # will be blank if no package was previously loaded:
501 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
503 # Detect if the variable has been set on the command line or elsewhere:
504 IF(DEFINED ${_envvar})
505 SET(_var_already_there TRUE)
507 SET(_var_already_there FALSE)
510 SET(${_envvar} "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
513 ## 2. Find package - try CONFIG mode first (i.e. looking for XYZ-config.cmake)
516 # Override the variable - don't append to it, as it would give precedence
517 # to what was stored there before!
518 IF(DEFINED ${_envvar})
519 SET(CMAKE_PREFIX_PATH "${${_envvar}}")
522 # Try find_package in config mode. This has the priority, but is
523 # performed QUIET and not REQUIRED:
524 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} NO_MODULE TRUE)
526 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
527 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
530 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
531 # We do it quietly to produce our own error message, except if we are in debug mode:
532 IF(SALOME_CMAKE_DEBUG)
533 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE FALSE)
535 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE TRUE)
538 # Set the "FOUND" variable for the SALOME wrapper:
539 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
540 SET(SALOME${pkg_UC}_FOUND TRUE)
542 SET(SALOME${pkg_UC}_FOUND FALSE)
543 IF(NOT Salome${pkg}_FIND_QUIETLY)
544 IF(Salome${pkg}_FIND_REQUIRED)
545 MESSAGE(FATAL_ERROR "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
546 "It currently contains ${_envvar}=${${_envvar}} "
547 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
549 MESSAGE(WARNING "Package ${pkg} couldn't be found - did you set the corresponing root dir correctly? "
550 "It currently contains ${_envvar}=${${_envvar}} "
551 "Append -DSALOME_CMAKE_DEBUG=ON on the command line if you want to see the original CMake error.")
556 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
557 ## 3. Set the root dir which was finally retained by going up "upDir" times
558 ## from the given reference path. The variable "referenceVariable" may be a list.
559 ## In this case we take its first element.
561 # First test if the variable exists, warn otherwise:
562 IF(NOT DEFINED ${referenceVariable})
563 MESSAGE(WARNING "${pkg}: the reference variable '${referenceVariable}' used when calling the macro "
564 "SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS() is not defined.")
567 LIST(LENGTH ${referenceVariable} _tmp_len)
569 LIST(GET ${referenceVariable} 0 _tmp_ROOT_DIR)
571 # Note the double de-reference of "referenceVariable":
572 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
574 # Up cound can be reset by detection procedure
575 SET(_upCount ${upCount})
576 IF(DEFINED ${pkg_UC}_UPCOUNT)
577 SET(_upCount ${${pkg_UC}_UPCOUNT})
580 FOREACH(_unused RANGE 1 ${_upCount})
581 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
586 ## 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
588 IF(DEFINED ENV{${_envvar}})
589 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
591 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
592 "environment ${_envvar}! Is the variable correctly set? "
593 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
596 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${_envvar} variable, all good!")
599 IF(NOT _var_already_there)
600 MESSAGE(STATUS "Variable ${_envvar} was not explicitly defined. "
601 "An installation was found anyway: ${_tmp_ROOT_DIR}")
606 ## 5. Conflict detection
607 ## From another prerequisite using the package:
609 IF(${pkg_UC}_ROOT_DIR_EXP)
610 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
612 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
613 " The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
615 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
620 ## 6. Save the detected installation
622 SET(${_envvar} "${_tmp_ROOT_DIR}")
625 MESSAGE(STATUS "${pkg} was not found.")
628 SET(Salome${pkg}_FOUND "${pkg}_FOUND")
629 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)
632 ####################################################################
633 # SALOME_ADD_MPI_TO_HDF5()
635 # Overload the HDF5 flags so that they also contain MPI references.
636 # This is to be used when HDF5 was compiled with MPI support;
637 MACRO(SALOME_ADD_MPI_TO_HDF5)
638 SET(HDF5_INCLUDE_DIRS ${HDF5_INCLUDE_DIRS} ${MPI_INCLUDE_DIRS})
639 SET(HDF5_DEFINITIONS "${HDF5_DEFINITIONS} ${MPI_DEFINITIONS}")
640 SET(HDF5_LIBRARIES ${HDF5_LIBRARIES} ${MPI_LIBRARIES})
641 ENDMACRO(SALOME_ADD_MPI_TO_HDF5)
643 ####################################################################
645 # Convert a number (smaller than 16) into hexadecimal representation
647 MACRO(SALOME_TOHEXA num result)
648 SET(_hexa_map a b c d e f)
650 SET(${result} "0${num}")
652 MATH(EXPR _res "${num}-10" )
653 LIST(GET _hexa_map ${_res} _out)
654 SET(${result} "0${_out}")
656 ENDMACRO(SALOME_TOHEXA)
658 ####################################################################
661 # Computes hexadecimal version of SALOME package
663 # USAGE: SALOME_XVERSION(package)
667 # package: IN: SALOME package name
669 # The macro reads SALOME package version from PACKAGE_VERSION variable
670 # (note package name in uppercase as assumed for SALOME modules);
671 # hexadecimal version value in form 0xAABBCC (where AA, BB and CC are
672 # major, minor and maintenance components of package version in
673 # hexadecimal form) is put to the PACKAGE_XVERSION variable
674 MACRO(SALOME_XVERSION pkg)
675 STRING(TOUPPER ${pkg} _pkg_UC)
676 IF(${_pkg_UC}_VERSION)
680 SALOME_TOHEXA(${${_pkg_UC}_MAJOR_VERSION} _major)
681 SALOME_TOHEXA(${${_pkg_UC}_MINOR_VERSION} _minor)
682 SALOME_TOHEXA(${${_pkg_UC}_PATCH_VERSION} _patch)
683 SET(${_pkg_UC}_XVERSION "0x${_major}${_minor}${_patch}")
685 ENDMACRO(SALOME_XVERSION)
688 #########################################################################
689 # SALOME_ACCUMULATE_HEADERS()
691 # This macro is called in the various FindSalomeXYZ.cmake modules to accumulate
692 # internally the list of include headers to be saved for future export.
693 # The full set of include is saved in a variable called
694 # _${PROJECT_NAME}_EXTRA_HEADERS
696 MACRO(SALOME_ACCUMULATE_HEADERS lst)
697 FOREACH(l IN LISTS ${lst})
698 LIST(FIND _${PROJECT_NAME}_EXTRA_HEADERS "${l}" _res)
700 IF(NOT "${l}" STREQUAL "/usr/include")
701 LIST(APPEND _${PROJECT_NAME}_EXTRA_HEADERS "${l}")
705 ENDMACRO(SALOME_ACCUMULATE_HEADERS)
707 #########################################################################
708 # SALOME_ACCUMULATE_ENVIRONMENT()
710 # USAGE: SALOME_ACCUMULATE_ENVIRONMENT(envvar value [value ...])
713 # envvar [in] environment variable name, e.g. PATH
714 # value [in] value(s) to be added to environment variable
716 # This macro is called in the various FindSalomeXYZ.cmake modules to
717 # accumulate environment variables, to be used later to run some command
718 # in proper environment.
720 # 1. Each envrironment variable is stored in specific CMake variable
721 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable.
722 # 2. Full list of environment variable names is stored in CMake variable
723 # _${PROJECT_NAME}_EXTRA_ENV.
726 # - The arguments list can include optional CHECK or NOCHECK keywords:
727 # * For all arguments following CHECK keyword the macro perform an
728 # additional check (see below); this is the default mode, it is suitable
729 # for path variables (PATH, LD_LIBRARY_PATH, etc).
730 # * For all arguments following NOCHECK keyword, no additional check is
732 # Checking an argument means that we check:
733 # - That the path actually exists
734 # - That this is not a standard system path (starting with "/usr"); this avoids
735 # polluting LD_LIBRARY_PATH or PATH with things like "/usr/lib64" ...
737 MACRO(SALOME_ACCUMULATE_ENVIRONMENT envvar)
739 FOREACH(_item ${ARGN})
740 IF(${_item} STREQUAL "NOCHECK")
742 ELSEIF(${_item} STREQUAL "CHECK")
746 IF(NOT IS_DIRECTORY ${_item})
748 GET_TARGET_PROPERTY(_item ${_item} LOCATION)
750 GET_FILENAME_COMPONENT(_item ${_item} PATH)
753 STRING(REGEX MATCH "^(/usr|/lib|/bin)" _usr_find ${_item})
754 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
755 IF(NOT _usr_find AND _res EQUAL -1)
756 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
760 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item} _res)
762 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV_${envvar} ${_item})
768 LIST(FIND _${PROJECT_NAME}_EXTRA_ENV ${envvar} _res)
770 LIST(APPEND _${PROJECT_NAME}_EXTRA_ENV ${envvar})
772 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "SET\(${PROJECT_NAME}_EXTRA_ENV ${_${PROJECT_NAME}_EXTRA_ENV}\)")
773 FOREACH(_res ${_${PROJECT_NAME}_EXTRA_ENV})
774 STRING(REPLACE "${CMAKE_INSTALL_PREFIX}" "\${PACKAGE_PREFIX_DIR}" _res_path "${_${PROJECT_NAME}_EXTRA_ENV_${_res}}")
775 SET(_${PROJECT_NAME}_EXTRA_ENV_FULL "${_${PROJECT_NAME}_EXTRA_ENV_FULL}\nSET\(${PROJECT_NAME}_EXTRA_ENV_${_res} ${_res_path}\)")
777 ENDMACRO(SALOME_ACCUMULATE_ENVIRONMENT)
779 #########################################################################
780 # SALOME_GENERATE_ENVIRONMENT_SCRIPT()
782 # USAGE: SALOME_GENERATE_ENVIRONMENT_SCRIPT(output script cmd opts)
785 # output [out] output command, e.g. for creation of target.
786 # script [in] output environement script name
787 # cmd [in] input command, e.g. sphinx or python command.
788 # opts [in] options for input command (cmd).
790 # This macro is called when it's necessary to use given environment to run some command.
791 # Macro generates environement script using previously created variables
792 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
793 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
794 # and puts generated command in proper environment into <output> argument.
797 # - If <script> is specified as relative path, it is computed from the current build
800 MACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT output script cmd opts)
801 IF(IS_ABSOLUTE ${script})
802 SET(_script ${script})
804 SET(_script ${CMAKE_CURRENT_BINARY_DIR}/${script})
809 SET(_call_cmd "call")
816 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
817 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
819 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
822 STRING(REPLACE "/" "\\" _env "${_env} @SET ${_item}=${_val};%${_item}%\n")
824 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
825 SET(_env "${_env} export DYLD_LIBRARY_PATH=${_val}:\${DYLD_LIBRARY_PATH}\n")
827 SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
830 SET(_env "${_env} export ${_item}=${_val}:\${${_item}}\n")
835 SET(_script ${_script}.${_ext})
836 FILE(WRITE ${_script} "${_env}")
838 SET(${output} ${_call_cmd} ${_script} && ${cmd} ${opts})
840 ENDMACRO(SALOME_GENERATE_ENVIRONMENT_SCRIPT)
842 #########################################################################
843 # SALOME_GENERATE_TESTS_ENVIRONMENT()
845 # USAGE: SALOME_GENERATE_TESTS_ENVIRONMENT(output)
848 # output [out] output environement variable.
850 # This macro generates <output> variable to use given environment to run some tests.
851 # Macro generates environement variable using previously created variables
852 # _${PROJECT_NAME}_EXTRA_ENV_<var>, where <var> is name of variable and
853 # _${PROJECT_NAME}_EXTRA_ENV (see marco SALOME_ACCUMULATE_ENVIRONMENT);
854 # and puts this variable into <output> argument.
856 MACRO(SALOME_GENERATE_TESTS_ENVIRONMENT output)
858 SET(_WIN_LD_LIBRARY OFF)
859 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
860 IF(${_item} STREQUAL "LD_LIBRARY_PATH")
861 SET(_WIN_LD_LIBRARY ON)
864 FOREACH(_val ${_${PROJECT_NAME}_EXTRA_ENV_${_item}})
866 STRING(REPLACE "/" "\\" _val "${_val}")
867 SET(_env_${_item} "${_val};${_env_${_item}}")
869 SET(_env_${_item} "${_val}:${_env_${_item}}")
874 IF(_WIN_LD_LIBRARY AND WIN32)
875 SET(_env_PATH "${_env_PATH}$ENV{LD_LIBRARY_PATH};${_env_LD_LIBRARY_PATH}")
884 FOREACH(_item ${_${PROJECT_NAME}_EXTRA_ENV})
886 IF(NOT ${_item} STREQUAL "LD_LIBRARY_PATH")
887 SET(_env "${_item}=$ENV{${_item}};${_env_${_item}}${sep}${_env}")
890 STRING(REPLACE ";" ":" _iii "$ENV{${_item}}")
891 SET(_env "${_item}=${_iii}:${_env_${_item}}${sep}${_env}")
895 # Get module name as substring of "Salome<ModuleName>"
896 STRING(REGEX MATCH "^Salome" _is_salome_project ${PROJECT_NAME})
897 IF(_is_salome_project)
898 STRING(SUBSTRING "${PROJECT_NAME}" 6 -1 PRNAME)
900 SET(PRNAME ${PROJECT_NAME})
902 SET(_env "${PRNAME}_ROOT_DIR=${CMAKE_INSTALL_PREFIX}${sep}${_env}")
904 # Creating follow string for Windows environement:
905 # "VAR1_ENV=1\;2\;3\;...\;...\;...;VAR2_ENV=1\;2\;3\;...\;...\;...;VAR3_ENV=1\;2\;3\;...\;...\;...;..."
907 STRING(REGEX REPLACE "\\\\*;" "\\\\;" _env "${_env}")
908 STRING(REGEX REPLACE "\\\\*;*," ";" _env "${_env}")
911 SET(${output} "${_env}")
913 ENDMACRO(SALOME_GENERATE_TESTS_ENVIRONMENT)
915 #########################################################################
916 # SALOME_APPEND_LIST_OF_LIST()
918 # USAGE: SALOME_APPEND_LIST_OF_LIST(result element_list)
920 # Build a list of lists. The element_list is first parsed to convert it
926 # It is then added to the big list 'result'. Hence 'result' looks like:
927 # a,b,c,d,e;f,g,h; ...
929 MACRO(SALOME_APPEND_LIST_OF_LIST result element_list)
931 STRING(REPLACE ";" "," _tmp_res "${${element_list}}")
933 # Yet another CMake stupidity - LIST(LENGTH ";" var) returns 0
934 STRING(LENGTH result _list_len)
935 IF(NOT _list_len EQUAL 0)
936 SET(${result} "${${result}}${_tmp_res};") # LIST(APPEND ...) doesn't handle well empty elements!?
938 SET(${result} "${_tmp_res};") # to avoid redundant ';' at the beginning of the list
941 ENDMACRO(SALOME_APPEND_LIST_OF_LIST)
943 #########################################################################
944 # SALOME_CONFIGURE_PREPARE()
946 # USAGE: SALOME_CONFIGURE_PREPARE(pkg1 pkg2 ...)
948 # Prepare the variable that will be used to configure the file Salome<MODULE>Config.cmake,
950 # - _PREREQ_LIST : the list of level 1 external prerequisites
951 # - _PREREQ_DIR_LIST : their corresponding CMake directories (i.e. where the CMake configuration
952 # file for this package can be found, if there is any!)
953 # - _PREREQ_COMPO_LIST: the list of components requested when this package was invoked
955 # All this information is built from the package_list, the list of level 1 packages for this module.
956 # Only the packages found in CONFIG mode are retained.
958 MACRO(SALOME_CONFIGURE_PREPARE)
959 SET(_tmp_prereq "${ARGV}")
961 SET(_PREREQ_DIR_LIST)
962 SET(_PREREQ_COMPO_LIST)
963 FOREACH(_prereq IN LISTS _tmp_prereq)
965 SET(_PREREQ_LIST "${_PREREQ_LIST} ${_prereq}")
966 FILE(TO_CMAKE_PATH ${${_prereq}_DIR} CURR_DIR)
967 SET(_PREREQ_DIR_LIST "${_PREREQ_DIR_LIST} \"${CURR_DIR}\"")
968 SALOME_APPEND_LIST_OF_LIST(_PREREQ_COMPO_LIST Salome${_prereq}_COMPONENTS)
971 ENDMACRO(SALOME_CONFIGURE_PREPARE)
973 #######################################################################
975 # From a version string like "2.7.12+" extract the major, minor and patch number
976 # taking ONLY the numerical part.
977 # This macro was created to treat Ubuntu Python version number where the libs are
978 # version 2.7.12+ and the interp is 2.7.12 ...
980 MACRO(SALOME_EXTRACT_VERSION version_string major minor patch)
981 IF(${version_string} MATCHES "[0-9]+[^0-9]*\\.[0-9]+[^0-9]*\\.[0-9]+[^0-9]*")
982 STRING(REGEX REPLACE "^([0-9]+)[^0-9]*\\.[0-9]+[^0-9]*\\.[0-9]+[^0-9]*" "\\1" ${major} "${version_string}")
983 STRING(REGEX REPLACE "^[0-9]+[^0-9]*\\.([0-9]+)[^0-9]*\\.[0-9]+[^0-9]*" "\\1" ${minor} "${version_string}")
984 STRING(REGEX REPLACE "^[0-9]+[^0-9]*\\.[0-9]+[^0-9]*\\.([0-9]+)[^0-9]*" "\\1" ${patch} "${version_string}")
986 MESSAGE("MACRO(SALOME_EXTRACT_VERSION ${version_string} ${major} ${minor} ${patch}")
987 MESSAGE(FATAL_ERROR "Problem parsing version string, I can't parse it properly.")
989 ENDMACRO(SALOME_EXTRACT_VERSION)
991 #######################################################################
993 # This macro checks that swig files were generated.
994 # It is requared under Windows platform, because sometimes under Windows platform
995 # the genetarion of the swig wrappings tooks long time. And seems swig opens
996 # file at the begining of generation process and after that swig
997 # begins the generation of the content. In its turn Microsoft Visual Studio
998 # tryes to compile file immediately after creation and as a result compilation breaks.
999 MACRO(SWIG_CHECK_GENERATION swig_module)
1004 ( (call ) >> @SWIG_GEN_FILE_NAME@ ) 2>null && (
1005 echo The file @SWIG_GEN_FILE_NAME@ was created. & goto :eof
1007 echo The file @SWIG_GEN_FILE_NAME@ is still being created !!! & goto :check
1010 LIST(LENGTH swig_generated_sources NB_GEN_FILES)
1012 LIST(GET swig_generated_sources 0 SWIG_GEN_FILE_NAME)
1013 STRING(CONFIGURE ${SCRIPT} SCRIPT)
1014 GET_FILENAME_COMPONENT(SWIG_GEN_FILE_NAME_DIR ${SWIG_GEN_FILE_NAME} DIRECTORY)
1015 GET_FILENAME_COMPONENT(SWIG_GEN_FILE_NAME_WE ${SWIG_GEN_FILE_NAME} NAME_WE)
1016 SET(SCRIPT_FILE_NAME ${SWIG_GEN_FILE_NAME_DIR}/${SWIG_GEN_FILE_NAME_WE}.bat)
1017 FILE(WRITE ${SCRIPT_FILE_NAME} ${SCRIPT})
1018 ADD_CUSTOM_TARGET(${SWIG_MODULE_${swig_module}_REAL_NAME}_ready
1019 DEPENDS ${SWIG_GEN_FILE_NAME}
1020 COMMAND ${SCRIPT_FILE_NAME}
1021 COMMENT "Waiting for swig wrappings !!!")
1022 ADD_DEPENDENCIES(${SWIG_MODULE_${swig_module}_REAL_NAME} ${SWIG_MODULE_${swig_module}_REAL_NAME}_ready)
1024 MESSAGE(FATAL "swig sources for targer ${swig_module} are not found !!!")
1027 ENDMACRO(SWIG_CHECK_GENERATION)