FindPackageHandleStandardArgs.cmake 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. # FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME (DEFAULT_MSG|"Custom failure message") VAR1 ... )
  2. # This macro is intended to be used in FindXXX.cmake modules files.
  3. # It handles the REQUIRED and QUIET argument to FIND_PACKAGE() and
  4. # it also sets the <UPPERCASED_NAME>_FOUND variable.
  5. # The package is found if all variables listed are TRUE.
  6. # Example:
  7. #
  8. # FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibXml2 DEFAULT_MSG LIBXML2_LIBRARIES LIBXML2_INCLUDE_DIR)
  9. #
  10. # LibXml2 is considered to be found, if both LIBXML2_LIBRARIES and
  11. # LIBXML2_INCLUDE_DIR are valid. Then also LIBXML2_FOUND is set to TRUE.
  12. # If it is not found and REQUIRED was used, it fails with FATAL_ERROR,
  13. # independent whether QUIET was used or not.
  14. # If it is found, the location is reported using the VAR1 argument, so
  15. # here a message "Found LibXml2: /usr/lib/libxml2.so" will be printed out.
  16. # If the second argument is DEFAULT_MSG, the message in the failure case will
  17. # be "Could NOT find LibXml2", if you don't like this message you can specify
  18. # your own custom failure message there.
  19. INCLUDE(FindPackageMessage)
  20. FUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS _NAME _FAIL_MSG _VAR1 )
  21. IF("${_FAIL_MSG}" STREQUAL "DEFAULT_MSG")
  22. SET(_FAIL_MESSAGE "Could NOT find ${_NAME}")
  23. ELSE("${_FAIL_MSG}" STREQUAL "DEFAULT_MSG")
  24. SET(_FAIL_MESSAGE "${_FAIL_MSG}")
  25. ENDIF("${_FAIL_MSG}" STREQUAL "DEFAULT_MSG")
  26. STRING(TOUPPER ${_NAME} _NAME_UPPER)
  27. # collect all variables which were not found, so they can be printed, so the
  28. # user knows better what went wrong (#6375)
  29. SET(MISSING_VARS "")
  30. SET(DETAILS "")
  31. SET(${_NAME_UPPER}_FOUND TRUE)
  32. IF(NOT ${_VAR1})
  33. SET(${_NAME_UPPER}_FOUND FALSE)
  34. SET(MISSING_VARS " ${_VAR1}")
  35. ELSE(NOT ${_VAR1})
  36. SET(DETAILS "${DETAILS}[${${_VAR1}}]")
  37. ENDIF(NOT ${_VAR1})
  38. # check if all passed variables are valid
  39. FOREACH(_CURRENT_VAR ${ARGN})
  40. IF(NOT ${_CURRENT_VAR})
  41. SET(${_NAME_UPPER}_FOUND FALSE)
  42. SET(MISSING_VARS "${MISSING_VARS} ${_CURRENT_VAR}")
  43. ELSE(NOT ${_CURRENT_VAR})
  44. SET(DETAILS "${DETAILS}[${${_CURRENT_VAR}}]")
  45. ENDIF(NOT ${_CURRENT_VAR})
  46. ENDFOREACH(_CURRENT_VAR)
  47. IF (${_NAME_UPPER}_FOUND)
  48. FIND_PACKAGE_MESSAGE(${_NAME} "Found ${_NAME}: ${${_VAR1}}" "${DETAILS}")
  49. ELSE (${_NAME_UPPER}_FOUND)
  50. IF (${_NAME}_FIND_REQUIRED)
  51. MESSAGE(FATAL_ERROR "${_FAIL_MESSAGE} (missing: ${MISSING_VARS})")
  52. ELSE (${_NAME}_FIND_REQUIRED)
  53. IF (NOT ${_NAME}_FIND_QUIETLY)
  54. MESSAGE(STATUS "${_FAIL_MESSAGE} (missing: ${MISSING_VARS})")
  55. ENDIF (NOT ${_NAME}_FIND_QUIETLY)
  56. ENDIF (${_NAME}_FIND_REQUIRED)
  57. ENDIF (${_NAME_UPPER}_FOUND)
  58. SET(${_NAME_UPPER}_FOUND ${${_NAME_UPPER}_FOUND} PARENT_SCOPE)
  59. ENDFUNCTION(FIND_PACKAGE_HANDLE_STANDARD_ARGS)