CMakeDependentOption.cmake 1.64 KB
Newer Older
1 2 3
# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.

4 5 6 7 8 9
#.rst:
# CMakeDependentOption
# --------------------
#
# Macro to provide an option dependent on other options.
#
10
# This macro presents an option to the user only if a set of other
11 12 13 14 15 16 17 18 19 20 21 22 23
# conditions are true.  When the option is not presented a default value
# is used, but any value set by the user is preserved for when the
# option is presented again.  Example invocation:
#
# ::
#
#   CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
#                          "USE_BAR;NOT USE_ZOT" OFF)
#
# If USE_BAR is true and USE_ZOT is false, this provides an option
# called USE_FOO that defaults to ON.  Otherwise, it sets USE_FOO to
# OFF.  If the status of USE_BAR or USE_ZOT ever changes, any value for
# the USE_FOO option is saved so that when the option is re-enabled it
24
# retains its old value.
25

26 27 28 29 30 31
macro(CMAKE_DEPENDENT_OPTION option doc default depends force)
  if(${option}_ISSET MATCHES "^${option}_ISSET$")
    set(${option}_AVAILABLE 1)
    foreach(d ${depends})
      string(REGEX REPLACE " +" ";" CMAKE_DEPENDENT_OPTION_DEP "${d}")
      if(${CMAKE_DEPENDENT_OPTION_DEP})
32
      else()
33
        set(${option}_AVAILABLE 0)
34 35
      endif()
    endforeach()
36 37 38
    if(${option}_AVAILABLE)
      option(${option} "${doc}" "${default}")
      set(${option} "${${option}}" CACHE BOOL "${doc}" FORCE)
39
    else()
40
      if(${option} MATCHES "^${option}$")
41
      else()
42
        set(${option} "${${option}}" CACHE INTERNAL "${doc}")
43
      endif()
44
      set(${option} ${force})
45 46
    endif()
  else()
47
    set(${option} "${${option}_ISSET}")
48 49
  endif()
endmacro()