1 # Copyright (C) 2012-2013 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.
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])
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 #----------------------------------------------------------------------------
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})
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)
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)
128 #----------------------------------------------------------------------------
129 # SALOME_INSTALL_SCRIPTS is a macro useful for installing executable scripts.
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)
147 #----------------------------------------------------------------------------
148 # SALOME_CONFIGURE_FILE is a macro useful for copying a file to another location
149 # and modify its contents.
151 # USAGE: SALOME_CONFIGURE_FILE(in_file out_file [INSTALL dir])
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)
168 #######################################################################################
169 # Useful macros for SALOME own package detection system
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.
178 MACRO(SALOME_CHECK_EQUAL_PATHS varRes path1 path2)
180 IF(EXISTS "${path1}")
181 GET_FILENAME_COMPONENT(_tmp1 "${path1}" REALPATH)
183 SET(_tmp1 "${path1}")
186 IF(EXISTS "${path2}")
187 GET_FILENAME_COMPONENT(_tmp2 "${path2}" REALPATH)
189 SET(_tmp2 "${path2}")
192 IF("${_tmp1}" STREQUAL "${_tmp2}")
195 # MESSAGE(${${varRes}})
200 # SALOME_FIND_PACKAGE(englobingPackageName standardPackageName modus)
201 # Encapsulate the call to the standard FIND_PACKAGE(standardPackageName) passing all the options
202 # given when calling the command FIND_PACKAGE(customPackageName)
203 # Modus is either MODULE or CONFIG (cf standard FIND_PACKAGE() documentation).
204 # This macro is to be called from within the FindCustomPackage.cmake file.
206 MACRO(SALOME_FIND_PACKAGE englobPkg stdPkg mode)
207 # Only bother if the package was not already found:
208 # Some old packages use the lower case version - standard should be to always use
210 STRING(TOUPPER ${stdPkg} stdPkgUC)
211 IF(NOT (${stdPkg}_FOUND OR ${stdPkgUC}_FOUND))
212 IF(${englobPkg}_FIND_QUIETLY)
213 SET(_tmp_quiet "QUIET")
217 IF(${englobPkg}_FIND_REQUIRED)
218 SET(_tmp_req "REQUIRED")
222 IF(${englobPkg}_FIND_VERSION_EXACT)
223 SET(_tmp_exact "EXACT")
227 IF(${englobPkg}_FIND_COMPONENTS)
228 STRING(REPLACE ";" " " _tmp_compo ${${englobPkg}_FIND_COMPONENTS})
233 # Call the root FIND_PACKAGE():
234 #MESSAGE("blo / ${CMAKE_PREFIX_PATH} / ${CMAKE_FIND_ROOT_PATH}")
236 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact} ${mode} ${_tmp_quiet} ${_tmp_req} COMPONENTS ${_tmp_compo})
238 FIND_PACKAGE(${stdPkg} ${${englobPkg}_FIND_VERSION} ${_tmp_exact} ${mode} ${_tmp_quiet} ${_tmp_req})
244 ####################################################################"
245 # SALOME_FIND_PACKAGE_DETECT_CONFLICTS(pkg referenceVariable upCount)
246 # pkg : name of the system package to be detected
247 # referenceVariable: variable containing a path that can be browsed up to
248 # retrieve the package root directory (xxx_ROOT_DIR)
249 # upCount : number of times we have to go up from the path <referenceVariable>
250 # to obtain the package root directory.
252 # For example: SALOME_FIND_PACKAGE_DETECT_CONFLICTS(SWIG SWIG_EXECUTABLE 2)
254 # Generic detection (and conflict check) procedure for package XYZ:
255 # 1. Load a potential env variable XYZ_ROOT_DIR as a default choice for the cache entry XYZ_ROOT_DIR
256 # If empty, load a potential XYZ_ROOT_DIR_EXP as default value (path exposed by another package depending
258 # 2. Invoke FIND_PACKAGE() in this order:
259 # * in CONFIG mode first (if possible): priority is given to a potential
260 # "XYZ-config.cmake" file
261 # * then switch to the standard MODULE mode, appending on CMAKE_PREFIX_PATH
262 # the above XYZ_ROOT_DIR variable
263 # 3. Extract the path actually found into a temp variable _XYZ_TMP_DIR
264 # 4. Warn if XYZ_ROOT_DIR is set and doesn't match what was found (e.g. when CMake found the system installation
265 # instead of what is pointed to by XYZ_ROOT_DIR - happens when a typo in the content of XYZ_ROOT_DIR).
266 # 5. Conflict detection:
267 # * check the temp variable against a potentially existing XYZ_ROOT_DIR_EXP
268 # 6. Finally expose what was *actually* found in XYZ_ROOT_DIR.
269 # 7. Specific stuff: for example exposing a prerequisite of XYZ to the rest of the world for future
270 # conflict detection. This is added after the call to the macro by the callee.
272 MACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS pkg referenceVariable upCount)
273 STRING(TOUPPER ${pkg} pkg_UC)
275 # 1. Load environment or any previously detected root dir for the package
276 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
277 FILE(TO_CMAKE_PATH "$ENV{${pkg_UC}_ROOT_DIR}" _${pkg_UC}_ROOT_DIR_ENV)
278 SET(_dflt_value "${_${pkg_UC}_ROOT_DIR_ENV}")
280 # will be blank if no package was previously loaded
281 SET(_dflt_value "${${pkg_UC}_ROOT_DIR_EXP}")
285 SET(${pkg_UC}_ROOT_DIR "${_dflt_value}" CACHE PATH "Path to ${pkg_UC} directory")
287 # 2. Find package - config mode first (i.e. looking for XYZ-config.cmake)
288 IF(EXISTS "${${pkg_UC}_ROOT_DIR}")
289 # Hope to find direclty a CMake config file there
290 SET(_CONF_DIR "${${pkg_UC}_ROOT_DIR}/share/cmake")
292 # Try find_package in config mode with a hard-coded guess. This
294 STRING(TOLOWER ${pkg} _pkg_lc)
295 FIND_PACKAGE(${pkg} NO_MODULE QUIET PATHS "${_CONF_DIR}" "${_CONF_DIR}/${pkg}"
296 "${_CONF_DIR}/${_pkg_lc}")
297 MARK_AS_ADVANCED(${pkg}_DIR)
299 IF (NOT (${pkg_UC}_FOUND OR ${pkg}_FOUND))
300 # Override the variable - don't append to it, as it would give precedence
301 # to what was stored there before!
302 SET(CMAKE_PREFIX_PATH "${${pkg_UC}_ROOT_DIR}")
304 MESSAGE(STATUS "Found ${pkg} in CONFIG mode!")
308 # Otherwise try the standard way (module mode, with the standard CMake Find*** macro):
309 SALOME_FIND_PACKAGE("Salome${pkg}" ${pkg} MODULE)
310 #MESSAGE("dbg ${pkg_UC} / ${PTHREAD_FOUND} / ${${pkg_UC}_FOUND}")
311 # Set the "FOUND" variable for the SALOME wrapper:
312 IF(${pkg_UC}_FOUND OR ${pkg}_FOUND)
313 SET(SALOME${pkg_UC}_FOUND TRUE)
315 SET(SALOME${pkg_UC}_FOUND FALSE)
318 IF (${pkg_UC}_FOUND OR ${pkg}_FOUND)
319 # 3. Set the root dir which was finally retained by going up "upDir" times
320 # from the given reference path. The variable "referenceVariable" may be a list
321 # - we take its first element.
322 # Note the double de-reference of "referenceVariable":
323 LIST(LENGTH "${${referenceVariable}}" _tmp_len)
325 LIST(GET "${${referenceVariable}}" 0 _tmp_ROOT_DIR)
327 SET(_tmp_ROOT_DIR "${${referenceVariable}}")
330 MATH(EXPR _rge "${upCount}-1")
331 FOREACH(_unused RANGE ${_rge})
332 GET_FILENAME_COMPONENT(_tmp_ROOT_DIR "${_tmp_ROOT_DIR}" PATH)
336 # 4. Warn if CMake found something not located under ENV(XYZ_ROOT_DIR)
337 IF(DEFINED ENV{${pkg_UC}_ROOT_DIR})
338 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${_${pkg_UC}_ROOT_DIR_ENV}")
340 MESSAGE(WARNING "${pkg} was found, but not at the path given by the "
341 "environment ${pkg_UC}_ROOT_DIR! Is the variable correctly set? "
342 "The two paths are: ${_tmp_ROOT_DIR} and: ${_${pkg_UC}_ROOT_DIR_ENV}")
345 MESSAGE(STATUS "${pkg} found directory matches what was specified in the ${pkg_UC}_ROOT_DIR variable, all good!")
348 MESSAGE(STATUS "Environment variable ${pkg_UC}_ROOT_DIR is not defined. The system installation was found.")
351 # 5. Conflict detection
352 # 5.1 From another prerequisite using the package
353 IF(${pkg_UC}_ROOT_DIR_EXP)
354 SALOME_CHECK_EQUAL_PATHS(_res "${_tmp_ROOT_DIR}" "${${pkg_UC}_ROOT_DIR_EXP}")
356 MESSAGE(WARNING "Warning: ${pkg}: detected version conflicts with a previously found ${pkg}!"
357 "The two paths are " ${_tmp_ROOT_DIR} " vs " ${${pkg_UC}_ROOT_DIR_EXP})
359 MESSAGE(STATUS "${pkg} directory matches what was previously exposed by another prereq, all good!")
363 # 6. Save the found installation
365 SET(${pkg_UC}_ROOT_DIR "${_tmp_ROOT_DIR}")
368 MESSAGE(STATUS "${pkg} was not found.")
370 ENDMACRO(SALOME_FIND_PACKAGE_AND_DETECT_CONFLICTS)