summaryrefslogtreecommitdiff
path: root/Source/cmFindCommon.cxx
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmFindCommon.cxx')
-rw-r--r--Source/cmFindCommon.cxx505
1 files changed, 505 insertions, 0 deletions
diff --git a/Source/cmFindCommon.cxx b/Source/cmFindCommon.cxx
new file mode 100644
index 000000000..b44864e13
--- /dev/null
+++ b/Source/cmFindCommon.cxx
@@ -0,0 +1,505 @@
+/*============================================================================
+ CMake - Cross Platform Makefile Generator
+ Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
+
+ 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.
+============================================================================*/
+#include "cmFindCommon.h"
+
+//----------------------------------------------------------------------------
+cmFindCommon::cmFindCommon()
+{
+ this->FindRootPathMode = RootPathModeBoth;
+ this->NoDefaultPath = false;
+ this->NoCMakePath = false;
+ this->NoCMakeEnvironmentPath = false;
+ this->NoSystemEnvironmentPath = false;
+ this->NoCMakeSystemPath = false;
+
+ // OS X Bundle and Framework search policy. The default is to
+ // search frameworks first on apple.
+#if defined(__APPLE__)
+ this->SearchFrameworkFirst = true;
+ this->SearchAppBundleFirst = true;
+#else
+ this->SearchFrameworkFirst = false;
+ this->SearchAppBundleFirst = false;
+#endif
+ this->SearchFrameworkOnly = false;
+ this->SearchFrameworkLast = false;
+ this->SearchAppBundleOnly = false;
+ this->SearchAppBundleLast = false;
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::GenerateDocumentation()
+{
+ // Documentation components.
+ this->GenericDocumentationMacPolicy =
+ "On Darwin or systems supporting OS X Frameworks, the cmake variable"
+ " CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:\n"
+ " \"FIRST\" - Try to find frameworks before standard\n"
+ " libraries or headers. This is the default on Darwin.\n"
+ " \"LAST\" - Try to find frameworks after standard\n"
+ " libraries or headers.\n"
+ " \"ONLY\" - Only try to find frameworks.\n"
+ " \"NEVER\" - Never try to find frameworks.\n"
+ "On Darwin or systems supporting OS X Application Bundles, the cmake "
+ "variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the "
+ "following:\n"
+ " \"FIRST\" - Try to find application bundles before standard\n"
+ " programs. This is the default on Darwin.\n"
+ " \"LAST\" - Try to find application bundles after standard\n"
+ " programs.\n"
+ " \"ONLY\" - Only try to find application bundles.\n"
+ " \"NEVER\" - Never try to find application bundles.\n";
+ this->GenericDocumentationRootPath =
+ "The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more "
+ "directories to be prepended to all other search directories. "
+ "This effectively \"re-roots\" the entire search under given locations. "
+ "By default it is empty. It is especially useful when "
+ "cross-compiling to point to the root directory of the "
+ "target environment and CMake will search there too. By default at first "
+ "the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted "
+ "directories will be searched. "
+ "The default behavior can be adjusted by setting "
+ "CMAKE_FIND_ROOT_PATH_MODE_XXX. This behavior can be manually "
+ "overridden on a per-call basis. "
+ "By using CMAKE_FIND_ROOT_PATH_BOTH the search order will "
+ "be as described above. If NO_CMAKE_FIND_ROOT_PATH is used "
+ "then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH "
+ "is used then only the re-rooted directories will be searched.\n";
+ this->GenericDocumentationPathsOrder =
+ "The default search order is designed to be most-specific to "
+ "least-specific for common use cases. "
+ "Projects may override the order by simply calling the command "
+ "multiple times and using the NO_* options:\n"
+ " FIND_XXX(FIND_ARGS_XXX PATHS paths... NO_DEFAULT_PATH)\n"
+ " FIND_XXX(FIND_ARGS_XXX)\n"
+ "Once one of the calls succeeds the result variable will be set "
+ "and stored in the cache so that no call will search again.";
+}
+
+//----------------------------------------------------------------------------
+cmFindCommon::~cmFindCommon()
+{
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::SelectDefaultRootPathMode()
+{
+ // Use both by default.
+ this->FindRootPathMode = RootPathModeBoth;
+
+ // Check the policy variable for this find command type.
+ std::string findRootPathVar = "CMAKE_FIND_ROOT_PATH_MODE_";
+ findRootPathVar += this->CMakePathName;
+ std::string rootPathMode =
+ this->Makefile->GetSafeDefinition(findRootPathVar.c_str());
+ if (rootPathMode=="NEVER")
+ {
+ this->FindRootPathMode = RootPathModeNoRootPath;
+ }
+ else if (rootPathMode=="ONLY")
+ {
+ this->FindRootPathMode = RootPathModeOnlyRootPath;
+ }
+ else if (rootPathMode=="BOTH")
+ {
+ this->FindRootPathMode = RootPathModeBoth;
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::SelectDefaultMacMode()
+{
+ std::string ff = this->Makefile->GetSafeDefinition("CMAKE_FIND_FRAMEWORK");
+ if(ff == "NEVER")
+ {
+ this->SearchFrameworkLast = false;
+ this->SearchFrameworkFirst = false;
+ this->SearchFrameworkOnly = false;
+ }
+ else if(ff == "ONLY")
+ {
+ this->SearchFrameworkLast = false;
+ this->SearchFrameworkFirst = false;
+ this->SearchFrameworkOnly = true;
+ }
+ else if(ff == "FIRST")
+ {
+ this->SearchFrameworkLast = false;
+ this->SearchFrameworkFirst = true;
+ this->SearchFrameworkOnly = false;
+ }
+ else if(ff == "LAST")
+ {
+ this->SearchFrameworkLast = true;
+ this->SearchFrameworkFirst = false;
+ this->SearchFrameworkOnly = false;
+ }
+
+ std::string fab = this->Makefile->GetSafeDefinition("CMAKE_FIND_APPBUNDLE");
+ if(fab == "NEVER")
+ {
+ this->SearchAppBundleLast = false;
+ this->SearchAppBundleFirst = false;
+ this->SearchAppBundleOnly = false;
+ }
+ else if(fab == "ONLY")
+ {
+ this->SearchAppBundleLast = false;
+ this->SearchAppBundleFirst = false;
+ this->SearchAppBundleOnly = true;
+ }
+ else if(fab == "FIRST")
+ {
+ this->SearchAppBundleLast = false;
+ this->SearchAppBundleFirst = true;
+ this->SearchAppBundleOnly = false;
+ }
+ else if(fab == "LAST")
+ {
+ this->SearchAppBundleLast = true;
+ this->SearchAppBundleFirst = false;
+ this->SearchAppBundleOnly = false;
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::RerootPaths(std::vector<std::string>& paths)
+{
+#if 0
+ for(std::vector<std::string>::const_iterator i = paths.begin();
+ i != paths.end(); ++i)
+ {
+ fprintf(stderr, "[%s]\n", i->c_str());
+ }
+#endif
+
+ // Short-circuit if there is nothing to do.
+ if(this->FindRootPathMode == RootPathModeNoRootPath)
+ {
+ return;
+ }
+ const char* rootPath =
+ this->Makefile->GetDefinition("CMAKE_FIND_ROOT_PATH");
+ if((rootPath == 0) || (strlen(rootPath) == 0))
+ {
+ return;
+ }
+
+ // Construct the list of path roots with no trailing slashes.
+ std::vector<std::string> roots;
+ cmSystemTools::ExpandListArgument(rootPath, roots);
+ for(std::vector<std::string>::iterator ri = roots.begin();
+ ri != roots.end(); ++ri)
+ {
+ cmSystemTools::ConvertToUnixSlashes(*ri);
+ }
+
+ // Copy the original set of unrooted paths.
+ std::vector<std::string> unrootedPaths = paths;
+ paths.clear();
+
+ for(std::vector<std::string>::const_iterator ri = roots.begin();
+ ri != roots.end(); ++ri)
+ {
+ for(std::vector<std::string>::const_iterator ui = unrootedPaths.begin();
+ ui != unrootedPaths.end(); ++ui)
+ {
+ // Place the unrooted path under the current root if it is not
+ // already inside. Skip the unrooted path if it is relative to
+ // a user home directory or is empty.
+ std::string rootedDir;
+ if(cmSystemTools::IsSubDirectory(ui->c_str(), ri->c_str()))
+ {
+ rootedDir = *ui;
+ }
+ else if(!ui->empty() && (*ui)[0] != '~')
+ {
+ // Start with the new root.
+ rootedDir = *ri;
+ rootedDir += "/";
+
+ // Append the original path with its old root removed.
+ rootedDir += cmSystemTools::SplitPathRootComponent(ui->c_str());
+ }
+
+ // Store the new path.
+ paths.push_back(rootedDir);
+ }
+ }
+
+ // If searching both rooted and unrooted paths add the original
+ // paths again.
+ if(this->FindRootPathMode == RootPathModeBoth)
+ {
+ paths.insert(paths.end(), unrootedPaths.begin(), unrootedPaths.end());
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::FilterPaths(std::vector<std::string>& paths,
+ const std::set<std::string>& ignore)
+{
+ // Now filter out anything that's in the ignore set.
+ std::vector<std::string> unfiltered;
+ unfiltered.swap(paths);
+
+ for(std::vector<std::string>::iterator pi = unfiltered.begin();
+ pi != unfiltered.end(); ++pi)
+ {
+ if (ignore.count(*pi) == 0)
+ {
+ paths.push_back(*pi);
+ }
+ }
+}
+
+
+//----------------------------------------------------------------------------
+void cmFindCommon::GetIgnoredPaths(std::vector<std::string>& ignore)
+{
+ // null-terminated list of paths.
+ static const char *paths[] =
+ { "CMAKE_SYSTEM_IGNORE_PATH", "CMAKE_IGNORE_PATH", 0 };
+
+ // Construct the list of path roots with no trailing slashes.
+ for(const char **pathName = paths; *pathName; ++pathName)
+ {
+ // Get the list of paths to ignore from the variable.
+ const char* ignorePath = this->Makefile->GetDefinition(*pathName);
+ if((ignorePath == 0) || (strlen(ignorePath) == 0))
+ {
+ continue;
+ }
+
+ cmSystemTools::ExpandListArgument(ignorePath, ignore);
+ }
+
+ for(std::vector<std::string>::iterator i = ignore.begin();
+ i != ignore.end(); ++i)
+ {
+ cmSystemTools::ConvertToUnixSlashes(*i);
+ }
+}
+
+
+//----------------------------------------------------------------------------
+void cmFindCommon::GetIgnoredPaths(std::set<std::string>& ignore)
+{
+ std::vector<std::string> ignoreVec;
+ GetIgnoredPaths(ignoreVec);
+ ignore.insert(ignoreVec.begin(), ignoreVec.end());
+}
+
+
+
+//----------------------------------------------------------------------------
+bool cmFindCommon::CheckCommonArgument(std::string const& arg)
+{
+ if(arg == "NO_DEFAULT_PATH")
+ {
+ this->NoDefaultPath = true;
+ }
+ else if(arg == "NO_CMAKE_ENVIRONMENT_PATH")
+ {
+ this->NoCMakeEnvironmentPath = true;
+ }
+ else if(arg == "NO_CMAKE_PATH")
+ {
+ this->NoCMakePath = true;
+ }
+ else if(arg == "NO_SYSTEM_ENVIRONMENT_PATH")
+ {
+ this->NoSystemEnvironmentPath = true;
+ }
+ else if(arg == "NO_CMAKE_SYSTEM_PATH")
+ {
+ this->NoCMakeSystemPath = true;
+ }
+ else if(arg == "NO_CMAKE_FIND_ROOT_PATH")
+ {
+ this->FindRootPathMode = RootPathModeNoRootPath;
+ }
+ else if(arg == "ONLY_CMAKE_FIND_ROOT_PATH")
+ {
+ this->FindRootPathMode = RootPathModeOnlyRootPath;
+ }
+ else if(arg == "CMAKE_FIND_ROOT_PATH_BOTH")
+ {
+ this->FindRootPathMode = RootPathModeBoth;
+ }
+ else
+ {
+ // The argument is not one of the above.
+ return false;
+ }
+
+ // The argument is one of the above.
+ return true;
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddPathSuffix(std::string const& arg)
+{
+ std::string suffix = arg;
+
+ // Strip leading and trailing slashes.
+ if(suffix.empty())
+ {
+ return;
+ }
+ if(suffix[0] == '/')
+ {
+ suffix = suffix.substr(1, suffix.npos);
+ }
+ if(suffix.empty())
+ {
+ return;
+ }
+ if(suffix[suffix.size()-1] == '/')
+ {
+ suffix = suffix.substr(0, suffix.size()-1);
+ }
+ if(suffix.empty())
+ {
+ return;
+ }
+
+ // Store the suffix.
+ this->SearchPathSuffixes.push_back(suffix);
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddUserPath(std::string const& p,
+ std::vector<std::string>& paths)
+{
+ // We should view the registry as the target application would view
+ // it.
+ cmSystemTools::KeyWOW64 view = cmSystemTools::KeyWOW64_32;
+ cmSystemTools::KeyWOW64 other_view = cmSystemTools::KeyWOW64_64;
+ if(this->Makefile->PlatformIs64Bit())
+ {
+ view = cmSystemTools::KeyWOW64_64;
+ other_view = cmSystemTools::KeyWOW64_32;
+ }
+
+ // Expand using the view of the target application.
+ std::string expanded = p;
+ cmSystemTools::ExpandRegistryValues(expanded, view);
+ cmSystemTools::GlobDirs(expanded.c_str(), paths);
+
+ // Executables can be either 32-bit or 64-bit, so expand using the
+ // alternative view.
+ if(expanded != p && this->CMakePathName == "PROGRAM")
+ {
+ expanded = p;
+ cmSystemTools::ExpandRegistryValues(expanded, other_view);
+ cmSystemTools::GlobDirs(expanded.c_str(), paths);
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddCMakePath(const char* variable)
+{
+ // Get a path from a CMake variable.
+ if(const char* varPath = this->Makefile->GetDefinition(variable))
+ {
+ std::vector<std::string> tmp;
+ cmSystemTools::ExpandListArgument(varPath, tmp);
+
+ // Relative paths are interpreted with respect to the current
+ // source directory.
+ this->AddPathsInternal(tmp, CMakePath);
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddEnvPath(const char* variable)
+{
+ // Get a path from the environment.
+ std::vector<std::string> tmp;
+ cmSystemTools::GetPath(tmp, variable);
+ // Relative paths are interpreted with respect to the current
+ // working directory.
+ this->AddPathsInternal(tmp, EnvPath);
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddPathsInternal(std::vector<std::string> const& in_paths,
+ PathType pathType)
+{
+ for(std::vector<std::string>::const_iterator i = in_paths.begin();
+ i != in_paths.end(); ++i)
+ {
+ this->AddPathInternal(*i, pathType);
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::AddPathInternal(std::string const& in_path,
+ PathType pathType)
+{
+ if(in_path.empty())
+ {
+ return;
+ }
+
+ // Select the base path with which to interpret relative paths.
+ const char* relbase = 0;
+ if(pathType == CMakePath)
+ {
+ relbase = this->Makefile->GetCurrentDirectory();
+ }
+
+ // Convert to clean full path.
+ std::string fullPath =
+ cmSystemTools::CollapseFullPath(in_path.c_str(), relbase);
+
+ // Insert the path if has not already been emitted.
+ if(this->SearchPathsEmitted.insert(fullPath).second)
+ {
+ this->SearchPaths.push_back(fullPath.c_str());
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::ComputeFinalPaths()
+{
+ std::vector<std::string>& paths = this->SearchPaths;
+
+ // Expand list of paths inside all search roots.
+ this->RerootPaths(paths);
+
+ // Add a trailing slash to all paths to aid the search process.
+ for(std::vector<std::string>::iterator i = paths.begin();
+ i != paths.end(); ++i)
+ {
+ std::string& p = *i;
+ if(!p.empty() && p[p.size()-1] != '/')
+ {
+ p += "/";
+ }
+ }
+}
+
+//----------------------------------------------------------------------------
+void cmFindCommon::SetMakefile(cmMakefile* makefile)
+{
+ cmCommand::SetMakefile(makefile);
+
+ // If we are building for Apple (OSX or also iphone), make sure
+ // that frameworks and bundles are searched first.
+ if(this->Makefile->IsOn("APPLE"))
+ {
+ this->SearchFrameworkFirst = true;
+ this->SearchAppBundleFirst = true;
+ }
+}