Updates will be applied today, at 4 pm EDT (UTC-0400). No interruption, and site should remain available.

FindPackageMessage.cmake 1.92 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
# FIND_PACKAGE_MESSAGE(<name> "message for user" "find result details")
#
# This macro is intended to be used in FindXXX.cmake modules files.
# It will print a message once for each unique find result.
# This is useful for telling the user where a package was found.
# The first argument specifies the name (XXX) of the package.
# The second argument specifies the message to display.
# The third argument lists details about the find result so that
# if they change the message will be displayed again.
# The macro also obeys the QUIET argument to the find_package command.
#
# Example:
#
14
#  if(X11_FOUND)
15 16
#    FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}"
#      "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
17
#  else()
18
#   ...
19
#  endif()
20

21 22 23 24 25 26 27 28 29 30
#=============================================================================
# Copyright 2008-2009 Kitware, Inc.
#
# 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.
#=============================================================================
31
# (To distribute this file outside of CMake, substitute the full
32 33
#  License text for the above reference.)

34
function(FIND_PACKAGE_MESSAGE pkg msg details)
35
  # Avoid printing a message repeatedly for the same find result.
36 37 38 39
  if(NOT ${pkg}_FIND_QUIETLY)
    string(REGEX REPLACE "[\n]" "" details "${details}")
    set(DETAILS_VAR FIND_PACKAGE_MESSAGE_DETAILS_${pkg})
    if(NOT "${details}" STREQUAL "${${DETAILS_VAR}}")
40
      # The message has not yet been printed.
41
      message(STATUS "${msg}")
42 43 44

      # Save the find details in the cache to avoid printing the same
      # message again.
45
      set("${DETAILS_VAR}" "${details}"
46
        CACHE INTERNAL "Details about finding ${pkg}")
47 48 49
    endif()
  endif()
endfunction()