CMakeFindDependencyMacro.cmake 2.11 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
#[=======================================================================[.rst:
CMakeFindDependencyMacro
-------------------------

8 9 10 11
.. command:: find_dependency

  The ``find_dependency()`` macro wraps a :command:`find_package` call for
  a package dependency::
12 13 14

    find_dependency(<dep> [...])

15 16
  It is designed to be used in a
  :ref:`Package Configuration File <Config File Packages>`
17
  (``<PackageName>Config.cmake``).  ``find_dependency`` forwards the correct
18 19 20 21 22 23 24 25
  parameters for ``QUIET`` and ``REQUIRED`` which were passed to
  the original :command:`find_package` call.  Any additional arguments
  specified are forwarded to :command:`find_package`.

  If the dependency could not be found it sets an informative diagnostic
  message and calls :command:`return` to end processing of the calling
  package configuration file and return to the :command:`find_package`
  command that loaded it.
26

27
  .. note::
28

29 30
    The call to :command:`return` makes this macro unsuitable to call
    from :ref:`Find Modules`.
31
#]=======================================================================]
32 33

macro(find_dependency dep)
34 35 36 37 38 39 40 41
  set(cmake_fd_quiet_arg)
  if(${CMAKE_FIND_PACKAGE_NAME}_FIND_QUIETLY)
    set(cmake_fd_quiet_arg QUIET)
  endif()
  set(cmake_fd_required_arg)
  if(${CMAKE_FIND_PACKAGE_NAME}_FIND_REQUIRED)
    set(cmake_fd_required_arg REQUIRED)
  endif()
42

43 44 45
  get_property(cmake_fd_alreadyTransitive GLOBAL PROPERTY
    _CMAKE_${dep}_TRANSITIVE_DEPENDENCY
  )
46

47 48 49 50
  find_package(${dep} ${ARGN}
    ${cmake_fd_quiet_arg}
    ${cmake_fd_required_arg}
  )
51

52 53 54
  if(NOT DEFINED cmake_fd_alreadyTransitive OR cmake_fd_alreadyTransitive)
    set_property(GLOBAL PROPERTY _CMAKE_${dep}_TRANSITIVE_DEPENDENCY TRUE)
  endif()
55

56 57 58 59
  if (NOT ${dep}_FOUND)
    set(${CMAKE_FIND_PACKAGE_NAME}_NOT_FOUND_MESSAGE "${CMAKE_FIND_PACKAGE_NAME} could not be found because dependency ${dep} could not be found.")
    set(${CMAKE_FIND_PACKAGE_NAME}_FOUND False)
    return()
60
  endif()
61 62
  set(cmake_fd_required_arg)
  set(cmake_fd_quiet_arg)
63
endmacro()