/*============================================================================ 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. ============================================================================*/ #ifndef cmFindCommon_h #define cmFindCommon_h #include "cmCommand.h" /** \class cmFindCommon * \brief Base class for FIND_XXX implementations. * * cmFindCommon is a parent class for cmFindBase, * cmFindProgramCommand, cmFindPathCommand, cmFindLibraryCommand, * cmFindFileCommand, and cmFindPackageCommand. */ class cmFindCommon : public cmCommand { public: cmFindCommon(); ~cmFindCommon(); cmTypeMacro(cmFindCommon, cmCommand); protected: enum RootPathMode { RootPathModeBoth, RootPathModeOnlyRootPath, RootPathModeNoRootPath }; enum PathType { FullPath, CMakePath, EnvPath }; /** Place a set of search paths under the search roots. */ void RerootPaths(std::vector<std::string>& paths); /** Get ignored paths from CMAKE_[SYSTEM_]IGNORE_path variables. */ void GetIgnoredPaths(std::vector<std::string>& ignore); void GetIgnoredPaths(std::set<std::string>& ignore); /** Remove paths in the ignore set from the supplied vector. */ void FilterPaths(std::vector<std::string>& paths, const std::set<std::string>& ignore); /** Compute final search path list (reroot + trailing slash). */ void ComputeFinalPaths(); /** Compute the current default root path mode. */ void SelectDefaultRootPathMode(); /** Compute the current default bundle/framework search policy. */ void SelectDefaultMacMode(); virtual void GenerateDocumentation(); cmStdString CMakePathName; RootPathMode FindRootPathMode; bool CheckCommonArgument(std::string const& arg); void AddPathSuffix(std::string const& arg); void AddUserPath(std::string const& p, std::vector<std::string>& paths); void AddCMakePath(const char* variable); void AddEnvPath(const char* variable); void AddPathsInternal(std::vector<std::string> const& in_paths, PathType pathType); void AddPathInternal(std::string const& in_path, PathType pathType); void SetMakefile(cmMakefile* makefile); bool NoDefaultPath; bool NoCMakePath; bool NoCMakeEnvironmentPath; bool NoSystemEnvironmentPath; bool NoCMakeSystemPath; std::vector<std::string> SearchPathSuffixes; std::vector<std::string> UserPaths; std::vector<std::string> UserHints; std::vector<std::string> SearchPaths; std::set<cmStdString> SearchPathsEmitted; std::string GenericDocumentationMacPolicy; std::string GenericDocumentationRootPath; std::string GenericDocumentationPathsOrder; bool SearchFrameworkFirst; bool SearchFrameworkOnly; bool SearchFrameworkLast; bool SearchAppBundleFirst; bool SearchAppBundleOnly; bool SearchAppBundleLast; }; #endif