uhd/mpm/cmake/Modules/MPMComponent.cmake
Joerg Hofrichter 608c8a3ab3 mpm: fixed cmake macro for enabling modules
The macro MPM_REGISTER_COMPONENT did not work as described: in case
the default enable was set to ON and all dependencies were met, the
module was still not enabled.

Also made the status prints more helpful:
- print the default value,
- print the user override (if one was provided)
- print the resulting VAR = VALUE
- print the override hint only if the user did not
  already specify an override

Example of old incorrect behavior:
-- Configuring Mykonos support...
--   Dependency ENABLE_LIBMPM = ON
--   Disabling Mykonos support.
--   Override with -DENABLE_MYKONOS=ON/OFF

Example of new correct behavior (also with changed prints):
-- Configuring Mykonos support...
--   Default value ENABLE_MYKONOS = ON
--   Dependency ENABLE_LIBMPM = ON
--   Enabling Mykonos support (ENABLE_MYKONOS = ON)
--   Override with -DENABLE_MYKONOS=ON/OFF
2020-01-22 12:54:54 -08:00

109 lines
4.5 KiB
CMake

#
# Copyright 2018 Ettus Research, a National Instruments Company
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
########################################################################
set(_mpm_enabled_components "" CACHE INTERNAL "" FORCE)
set(_mpm_disabled_components "" CACHE INTERNAL "" FORCE)
########################################################################
# Register a component into the system
# - name the component string name ("FOO")
# - var the global enable variable (ENABLE_FOO)
# - enb the default enable setting (ON)
# - deps a list of dependencies (DEPENDENCY_FOUND)
# - dis the default disable setting (OFF)
# - req fail if dependencies not met (unless specifically disabled)
#
# In parentheses are examples. If you specify those, we register a component
# "FOO" which is enabled by calling CMake with -DENABLE_FOO=ON. It defaults to
# ON, unless DEPENDENCY_FOUND is false, in which case it becomes false.
########################################################################
macro(MPM_REGISTER_COMPONENT name var enb deps dis req)
message(STATUS "")
message(STATUS "Configuring ${name} support...")
# If user specified option, store here. Note: If the user doesn't specify
# this option on the cmake command line, both user_enabled and
# user_disabled will be false!
if("${${var}}" STREQUAL "OFF")
set(user_disabled TRUE)
else()
set(user_disabled FALSE)
endif("${${var}}" STREQUAL "OFF")
if("${${var}}" STREQUAL "ON")
set(user_enabled TRUE)
else()
set(user_enabled FALSE)
endif("${${var}}" STREQUAL "ON")
# Override default if user set
if(user_enabled OR user_disabled)
message(STATUS " User forced ${var} = ${${var}}")
set(option "${${var}}")
else(user_enabled OR user_disabled)
message(STATUS " Default value ${var} = ${enb}")
set(option ${enb})
endif()
foreach(dep ${deps})
message(STATUS " Dependency ${dep} = ${${dep}}")
endforeach(dep)
# setup the dependent option for this component
include(CMakeDependentOption)
CMAKE_DEPENDENT_OPTION(${var} "enable ${name} support" ${option} "${deps}" ${dis})
# There are two failure cases:
# 1) The user requested this component explicitly (-DENABLE_FOO=ON) but the
# requirements are not met.
# 2) The user did not explicitly turn off this component (-DENABLE_FOO=OFF)
# but it is flagged as required by ${req}
if(NOT ${var} AND user_enabled) # Case 1)
message(FATAL_ERROR "Dependencies for required component ${name} not met.")
endif(NOT ${var} AND user_enabled)
if(NOT ${var} AND ${req} AND NOT user_disabled) # Case 2)
message(FATAL_ERROR "Dependencies for required component ${name} not met.")
endif(NOT ${var} AND ${req} AND NOT user_disabled)
#append the component into one of the lists
if(${var})
message(STATUS " Enabling ${name} support (${var} = ${${var}})")
list(APPEND _mpm_enabled_components ${name})
else(${var})
message(STATUS " Disabling ${name} support (${var} = ${${var}})")
list(APPEND _mpm_disabled_components ${name})
endif(${var})
if(NOT user_enabled AND NOT user_disabled)
message(STATUS " Override with -D${var}=ON/OFF")
endif(NOT user_enabled AND NOT user_disabled)
#make components lists into global variables
set(_mpm_enabled_components ${_uhd_enabled_components} CACHE INTERNAL "" FORCE)
set(_mpm_disabled_components ${_uhd_disabled_components} CACHE INTERNAL "" FORCE)
endmacro(MPM_REGISTER_COMPONENT)
########################################################################
# Print the registered component summary
########################################################################
function(MPM_PRINT_COMPONENT_SUMMARY)
message(STATUS "")
message(STATUS "######################################################")
message(STATUS "# MPM enabled components ")
message(STATUS "######################################################")
foreach(comp ${_mpm_enabled_components})
message(STATUS " * ${comp}")
endforeach(comp)
message(STATUS "")
message(STATUS "######################################################")
message(STATUS "# MPM disabled components ")
message(STATUS "######################################################")
foreach(comp ${_mpm_disabled_components})
message(STATUS " * ${comp}")
endforeach(comp)
message(STATUS "")
endfunction(MPM_PRINT_COMPONENT_SUMMARY)