CMake/Modules/CMakePrintHelpers.cmake
Kitware Robot f051814ed0 Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation:

 ./convert-help.bash "/path/to/CMake-build/bin"

Then remove it.
2013-10-15 14:12:03 -04:00

170 lines
4.4 KiB
CMake

#.rst:
# CMakePrintHelpers
# -----------------
#
# Convenience macros for printing properties and variables, useful e.g. for debugging.
#
#
#
#
#
# CMAKE_PRINT_PROPERTIES([TARGETS target1 .. targetN]
#
# ::
#
# [SOURCES source1 .. sourceN]
# [DIRECTORIES dir1 .. dirN]
# [TESTS test1 .. testN]
# [CACHE_ENTRIES entry1 .. entryN]
# PROPERTIES prop1 .. propN )
#
#
#
# This macro prints the values of the properties of the given targets,
# source files, directories, tests or cache entries. Exactly one of the
# scope keywords must be used. Example:
#
# ::
#
# cmake_print_properties(TARGETS foo bar PROPERTIES LOCATION INTERFACE_INCLUDE_DIRS)
#
# This will print the LOCATION and INTERFACE_INCLUDE_DIRS properties for
# both targets foo and bar.
#
#
#
# CMAKE_PRINT_VARIABLES(var1 var2 .. varN)
#
# This macro will print the name of each variable followed by its value.
# Example:
#
# ::
#
# cmake_print_variables(CMAKE_C_COMPILER CMAKE_MAJOR_VERSION THIS_ONE_DOES_NOT_EXIST)
#
# Gives:
#
# ::
#
# -- CMAKE_C_COMPILER="/usr/bin/gcc" ; CMAKE_MAJOR_VERSION="2" ; THIS_ONE_DOES_NOT_EXIST=""
#=============================================================================
# Copyright 2013 Alexander Neundorf, <neundorf@kde.org>
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
include(CMakeParseArguments)
function(CMAKE_PRINT_VARIABLES)
set(msg "")
foreach(var ${ARGN})
if(msg)
set(msg "${msg} ; ")
endif()
set(msg "${msg}${var}=\"${${var}}\"")
endforeach()
message(STATUS "${msg}")
endfunction()
function(CMAKE_PRINT_PROPERTIES )
set(options )
set(oneValueArgs )
set(multiValueArgs TARGETS SOURCES TESTS DIRECTORIES CACHE_ENTRIES PROPERTIES )
cmake_parse_arguments(CPP "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
if(CPP_UNPARSED_ARGUMENTS)
message(FATAL_ERROR "Unknown keywords given to cmake_print_properties(): \"${CPP_UNPARSED_ARGUMENTS}\"")
return()
endif()
if(NOT CPP_PROPERTIES)
message(FATAL_ERROR "Required argument PROPERTIES missing in cmake_print_properties() call")
return()
endif()
set(mode)
set(items)
set(keyword)
if(CPP_TARGETS)
set(items ${CPP_TARGETS})
set(mode ${mode} TARGETS)
set(keyword TARGET)
endif()
if(CPP_SOURCES)
set(items ${CPP_SOURCES})
set(mode ${mode} SOURCES)
set(keyword SOURCE)
endif()
if(CPP_TESTS)
set(items ${CPP_TESTS})
set(mode ${mode} TESTS)
set(keyword TEST)
endif()
if(CPP_DIRECTORIES)
set(items ${CPP_DIRECTORIES})
set(mode ${mode} DIRECTORIES)
set(keyword DIRECTORY)
endif()
if(CPP_CACHE_ENTRIES)
set(items ${CPP_CACHE_ENTRIES})
set(mode ${mode} CACHE_ENTRIES)
set(keyword CACHE)
endif()
if(NOT mode)
message(FATAL_ERROR "Mode keyword missing in cmake_print_properties() call, must be one of TARGETS SOURCES TESTS DIRECTORIES CACHE_ENTRIES PROPERTIES")
return()
endif()
list(LENGTH mode modeLength)
if("${modeLength}" GREATER 1)
message(FATAL_ERROR "Multiple mode keyword used in cmake_print_properties() call, it must be exactly one of TARGETS SOURCES TESTS DIRECTORIES CACHE_ENTRIES PROPERTIES")
return()
endif()
set(msg "\n")
foreach(item ${items})
set(itemExists TRUE)
if(keyword STREQUAL "TARGET")
if(NOT TARGET ${item})
set(itemExists FALSE)
set(msg "${msg}\n No such TARGET \"${item}\" !\n\n")
endif()
endif()
if (itemExists)
set(msg "${msg} Properties for ${keyword} ${item}:\n")
foreach(prop ${CPP_PROPERTIES})
get_property(propertySet ${keyword} ${item} PROPERTY "${prop}" SET)
if(propertySet)
get_property(property ${keyword} ${item} PROPERTY "${prop}")
set(msg "${msg} ${item}.${prop} = \"${property}\"\n")
else()
set(msg "${msg} ${item}.${prop} = <NOTFOUND>\n")
endif()
endforeach()
endif()
endforeach()
message(STATUS "${msg}")
endfunction()