CMake/Tutorials/SettingVariableGroups

<source lang="cmake"> cmake_minimum_required(VERSION 2.6)

1. The idea of this demo is to show how to set a group of CMake variables together.
2. A common use case is to allow easy enabling/disabling of a large set of targets, while
3. maintaining manual individual target control. This is in contrast to a BUILD_ALL style variable,
4. where targets are build if a corresponding variable to the target is set, OR the BUILD_ALL variable
5. is set. The problem with this method is that if you want to set "all but one" of the targets to ON,
6. it is not possible without manually setting all N-1 of the targets to OFF.

PROJECT(VariablePrefix)

1. Add options to build specific targets

option(build_Green "green") option(build_Blue "blue")

1. Add options to allow enabling/disabling of a set of targets

option(TurnOnAll "all") option(TurnOffAll "all")

1. A function to get all user defined variables with a specified prefix

function (getListOfVarsStartingWith _prefix _varResult)

   get_cmake_property(_vars VARIABLES)
   string (REGEX MATCHALL "(^|;)${_prefix}[A-Za-z0-9_]*" _matchedVars "${_vars}")
   set (${_varResult} ${_matchedVars} PARENT_SCOPE)

endfunction()

1. Mass toggle "commands". These variables (TurnOnAll and TurnOffAll) let you
2. enable or disable all of the variables starting with "build_". This is an abuse
3. of a CMake "variable" to be used as an instruction to issue a command once.
4. For example, when TurnOnAll is set to ON and then configure is run, the following
5. block is run once, and then TurnOnAll sets itself back to OFF.

if(TurnOnAll)

   getListOfVarsStartingWith("build_" matchedVars)
   foreach (_var IN LISTS matchedVars)
       message("Turn on ${item}")
       set(${_var} ON CACHE BOOL "test" FORCE) # "test" is here because I'm not sure how to preserve the docstring.
   endforeach()

   set(TurnOnAll OFF CACHE BOOL "test" FORCE)  # Set itself back to off, as this is a one time thing. "test" is here because I'm not sure how to preserve the docstring.

endif()

1. In exactly the same manner, if TurnOffAll is set to ON, all of the variables starting with build_ are set to OFF.

if(TurnOffAll)

   getListOfVarsStartingWith("build_" matchedVars)
   foreach (_var IN LISTS matchedVars)
       message("Turn off ${item}")
       set(${_var} OFF CACHE BOOL "test" FORCE) # "test" is here because I'm not sure how to preserve the docstring.
   endforeach()

   set(TurnOffAll OFF CACHE BOOL "test" FORCE)  # Set itself back to off, as this is a one time thing. "test" is here because I'm not sure how to preserve the docstring.

endif()

1. Of course turning on all variables at the same time as turning off all variables does not make sense.

if(TurnOnAllTargets AND TurnOffAllTargets)

 message(FATAL_ERROR "You cannot turn targets on and off at the same time!")

endif()

1. Conditional executables

if(build_Green)

  ADD_EXECUTABLE(GreenLaser GroupVariables.cpp)

endif()

if(build_Blue)

  ADD_EXECUTABLE(BlueLaser GroupVariables.cpp)
  # other options here

endif()

</source>