kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

find_package: add support for a <package>_NOT_FOUND_MESSAGE variable 

If a config-file sets <package>_FOUND to FALSE, it can now give a reason
using the variable <package>_NOT_FOUND_MESSAGE, which is used by cmFindPackage
and FPHSA.

Alex
This commit is contained in:
Alex Neundorf 2012-09-19 21:50:55 +02:00 committed by Brad King
parent 6508a8c804
commit ae4ab62569
3 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Modules/FindPackageHandleStandardArgs.cmake
View File

@ -120,6 +120,9 @@ macro(_FPHSA_HANDLE_FAILURE_CONFIG_MODE)
list(GET ${_NAME}_CONSIDERED_VERSIONS ${currentConfigIndex} version) list(GET ${_NAME}_CONSIDERED_VERSIONS ${currentConfigIndex} version)
set(configsText "${configsText} ${filename} (version ${version})\n") set(configsText "${configsText} ${filename} (version ${version})\n")
endforeach() endforeach()
if (${_NAME}_NOT_FOUND_MESSAGE)
set(configsText "${configsText} Reason given by package: ${${_NAME}_NOT_FOUND_MESSAGE}\n")
endif()
_FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} ${VERSION_MSG}, checked the following files:\n${configsText}") _FPHSA_FAILURE_MESSAGE("${FPHSA_FAIL_MESSAGE} ${VERSION_MSG}, checked the following files:\n${configsText}")
else() else()

3
Modules/readme.txt
View File

@ -18,6 +18,9 @@ XXX_VERSION_YY Expect Version YY if true. Make sure at most one of thes
XXX_WRAP_YY If False, do not try to use the relevent CMake wrapping command. XXX_WRAP_YY If False, do not try to use the relevent CMake wrapping command.
XXX_YY_FOUND If False, optional YY part of XXX sytem is not available. XXX_YY_FOUND If False, optional YY part of XXX sytem is not available.
XXX_FOUND Set to false, or undefined, if we haven't found, or don't want to use XXX. XXX_FOUND Set to false, or undefined, if we haven't found, or don't want to use XXX.
XXX_NOT_FOUND_MESSAGE Should be set by config-files in the case that it has set XXX_FOUND to FALSE.
The contained message will be printed by the find_package() command and by
find_package_handle_standard_args() to inform the user about the problem.
XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries. XXX_RUNTIME_LIBRARY_DIRS Optionally, the runtime library search path for use when running an executable linked to shared libraries.
The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix. The list should be used by user code to create the PATH on windows or LD_LIBRARY_PATH on unix.
This should not be a cache entry. This should not be a cache entry.

10
Source/cmFindPackageCommand.cxx
View File

@ -1016,6 +1016,9 @@ bool cmFindPackageCommand::HandlePackageMode()
std::string foundVar = this->Name; std::string foundVar = this->Name;
foundVar += "_FOUND"; foundVar += "_FOUND";
std::string notFoundMessageVar = this->Name;
notFoundMessageVar += "_NOT_FOUND_MESSAGE";
std::string notFoundMessage;
// If the directory for the config file was found, try to read the file. // If the directory for the config file was found, try to read the file.
bool result = true; bool result = true;
@ -1033,6 +1036,7 @@ bool cmFindPackageCommand::HandlePackageMode()
// has set Foo_FOUND to FALSE itself: // has set Foo_FOUND to FALSE itself:
this->Makefile->RemoveDefinition(foundVar.c_str()); this->Makefile->RemoveDefinition(foundVar.c_str());
} }
this->Makefile->RemoveDefinition(notFoundMessageVar.c_str());
// Set the version variables before loading the config file. // Set the version variables before loading the config file.
// It may override them. // It may override them.
@ -1051,6 +1055,8 @@ bool cmFindPackageCommand::HandlePackageMode()
// we get here if the Config file has set Foo_FOUND actively to FALSE // we get here if the Config file has set Foo_FOUND actively to FALSE
found = false; found = false;
configFileSetFOUNDFalse = true; configFileSetFOUNDFalse = true;
notFoundMessage = this->Makefile->GetSafeDefinition(
notFoundMessageVar.c_str());
} }
} }
else else
@ -1071,6 +1077,10 @@ bool cmFindPackageCommand::HandlePackageMode()
" " << this->FileFound << "\n" " " << this->FileFound << "\n"
"but it set " << foundVar << " to FALSE so package \"" << "but it set " << foundVar << " to FALSE so package \"" <<
this->Name << "\" is considered to be NOT FOUND."; this->Name << "\" is considered to be NOT FOUND.";
if (!notFoundMessage.empty())
{
e << " Reason given by package: \n" << notFoundMessage << "\n";
}
} }
// If there are files in ConsideredConfigs, it means that FooConfig.cmake // If there are files in ConsideredConfigs, it means that FooConfig.cmake
// have been found, but they didn't have appropriate versions. // have been found, but they didn't have appropriate versions.