ENH: add new find stuff

This commit is contained in:
Bill Hoffman 2006-02-27 16:38:22 -05:00
parent 718de4cea5
commit 4650f78dd5
2 changed files with 452 additions and 0 deletions

377
Source/cmFindBase.cxx Normal file
View File

@ -0,0 +1,377 @@
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#include "cmFindBase.h"
cmFindBase::cmFindBase()
{
this->AlreadyInCache = false;
this->NoSystemPath = false;
this->NoCMakePath = false;
this->NoCMakeEnvironmentPath = false;
this->NoCMakeSystemPath = false;
// default is to search frameworks first on apple
#if defined(__APPLE__)
this->SearchFrameworkFirst = true;
#else
this->SearchFrameworkFirst = false;
#endif
this->SearchFrameworkOnly = false;
this->SearchFrameworkLast = false;
}
bool cmFindBase::ParseArguments(std::vector<std::string> const& argsIn)
{
if(argsIn.size() < 2 )
{
this->SetError("called with incorrect number of arguments");
return false;
}
// copy argsIn into args so it can be modified,
// in the process extract the DOC "documentation"
size_t size = argsIn.size();
std::vector<std::string> args;
bool foundDoc = false;
for(unsigned int j = 0; j < size; ++j)
{
if(foundDoc || argsIn[j] != "DOC" )
{
args.push_back(argsIn[j]);
}
else
{
if(j+1 < size)
{
foundDoc = true;
this->VariableDocumentation = argsIn[j+1];
j++;
if(j >= size)
{
break;
}
}
}
}
this->VariableName = args[0];
if(this->CheckForVariableInCache())
{
this->AlreadyInCache = true;
return true;
}
this->AlreadyInCache = false;
std::vector<std::string> userPaths;
std::string doc;
bool foundName = false;
bool doingNames = false;
bool foundPaths = false;
bool doingPaths = false;
bool doingPathSuf = false;
bool newStyle = false;
for (unsigned int j = 1; j < args.size(); ++j)
{
if(args[j] == "NAMES")
{
doingNames = true;
newStyle = true;
doingPathSuf = false;
doingPaths = false;
}
else if (args[j] == "PATHS")
{
doingPaths = true;
newStyle = true;
doingNames = false;
doingPathSuf = false;
}
else if (args[j] == "PATH_SUFFIXES")
{
doingPathSuf = true;
newStyle = true;
doingNames = false;
doingPaths = false;
}
else if (args[j] == "NO_SYSTEM_PATH")
{
this->NoSystemPath = true;
}
else if (args[j] == "NO_CMAKE_PATH")
{
this->NoCMakePath = true;
}
else if (args[j] == "NO_CMAKE_ENVIRONMENT_PATH")
{
this->NoCMakeEnvironmentPath = true;
}
else if (args[j] == "NO_CMAKE_SYSTEM_PATH")
{
this->NoCMakeSystemPath = true;
}
else
{
if(doingNames)
{
this->Names.push_back(args[j]);
}
else if(doingPaths)
{
userPaths.push_back(args[j]);
}
else if(doingPathSuf)
{
this->SearchPathSuffixes.push_back(args[j]);
}
}
}
if(this->VariableDocumentation.size() == 0)
{
this->VariableDocumentation = "Whare can ";
if(this->Names.size() == 0)
{
this->VariableDocumentation += "the (unknown) library be found";
}
else if(this->Names.size() == 1)
{
this->VariableDocumentation += "the " + this->Names[0] + " library be found";
}
else
{
this->VariableDocumentation += "one of the " + this->Names[0];
for (unsigned int j = 1; j < this->Names.size() - 1; ++j)
{
this->VariableDocumentation += ", " + this->Names[j];
}
this->VariableDocumentation += " or " + this->Names[this->Names.size() - 1] + " libraries be found";
}
}
// look for old style
// FIND_*(VAR name path1 path2 ...)
if(!newStyle)
{
std::cerr << "oldstyle\n";
this->Names.push_back(args[1]);
for(unsigned int j = 2; j < args.size(); ++j)
{
userPaths.push_back(args[j]);
}
}
this->ExpandPaths(userPaths);
return true;
}
void cmFindBase::ExpandPaths(std::vector<std::string> userPaths)
{
// Add CMAKE_*_PATH environment variables
if(!this->NoCMakeEnvironmentPath)
{
this->AddEnvironmentVairables();
}
// Add CMake varibles of the same name as the previous environment
// varibles CMAKE_*_PATH to be used most of the time with -D
// command line options
if(!this->NoCMakePath)
{
this->AddCMakeVairables();
}
// add System environment PATH and (LIB or INCLUDE)
if(!this->NoSystemPath)
{
this->AddSystemEnvironmentVairables();
}
// Add CMAKE_SYSTEM_*_PATH variables which are defined in platform files
if(!this->NoCMakeSystemPath)
{
this->AddCMakeSystemVariables();
}
// add the paths specified in the FIND_* call
for(unsigned int i =0; i < userPaths.size(); ++i)
{
this->SearchPaths.push_back(userPaths[i]);
}
// clean things up
this->ExpandRegistryAndCleanPath();
}
void cmFindBase::AddEnvironmentVairables()
{
if(this->SearchFrameworkFirst || this->SearchFrameworkOnly)
{
cmSystemTools::GetPath(this->SearchPaths, "CMAKE_FRAMEWORK_PATH");
}
std::string var = "CMAKE_";
var += this->CMakePathName;
var += "_PATH";
cmSystemTools::GetPath(this->SearchPaths, var.c_str());
if(this->SearchFrameworkLast)
{
cmSystemTools::GetPath(this->SearchPaths, "CMAKE_FRAMEWORK_PATH");
}
}
void cmFindBase::AddCMakeVairables()
{
if(this->SearchFrameworkFirst || this->SearchFrameworkOnly)
{
if(const char* path = m_Makefile->GetDefinition("CMAKE_FRAMEWORK_PATH"))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
}
std::string var = "CMAKE_";
var += this->CMakePathName;
var += "_PATH";
if(const char* path = m_Makefile->GetDefinition(var.c_str()))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
if(this->SearchFrameworkLast)
{
if(const char* path = m_Makefile->GetDefinition("CMAKE_FRAMEWORK_PATH"))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
}
}
void cmFindBase::AddSystemEnvironmentVairables()
{
// Add LIB or INCLUDE
if(this->EnvironmentPath.size())
{
cmSystemTools::GetPath(this->SearchPaths, this->EnvironmentPath.c_str());
}
// Add PATH
cmSystemTools::GetPath(this->SearchPaths);
}
void cmFindBase::AddCMakeSystemVariables()
{
if(this->SearchFrameworkFirst || this->SearchFrameworkOnly)
{
if(const char* path = m_Makefile->GetDefinition("CMAKE_SYSTEM_FRAMEWORK_PATH"))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
}
std::string var = "CMAKE_SYSTEM_";
var += this->CMakePathName;
var += "_PATH";
if(const char* path = m_Makefile->GetDefinition(var.c_str()))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
if(this->SearchFrameworkLast)
{
if(const char* path = m_Makefile->GetDefinition("CMAKE_SYSTEM_FRAMEWORK_PATH"))
{
cmSystemTools::ExpandListArgument(path, this->SearchPaths);
}
}
}
void cmFindBase::ExpandRegistryAndCleanPath()
{
std::vector<std::string> finalPath;
std::vector<std::string>::iterator i;
for(i = this->SearchPaths.begin();
i != this->SearchPaths.end(); ++i)
{
cmSystemTools::ExpandRegistryValues(*i);
cmSystemTools::GlobDirs(i->c_str(), finalPath);
}
this->SearchPaths.clear();
// convert all paths to unix slashes
for(i = finalPath.begin();
i != finalPath.end(); ++i)
{
cmSystemTools::ConvertToUnixSlashes(*i);
// copy each finalPath combined with SearchPathSuffixes
// to the SearchPaths ivar
for(std::vector<std::string>::iterator j = this->SearchPathSuffixes.begin();
j != this->SearchPathSuffixes.end(); ++j)
{
std::string p = *i + std::string("/") + *j;
if(cmSystemTools::FileIsDirectory(p.c_str()))
{
this->SearchPaths.push_back(p);
}
}
}
// now put the path without the path suffixes in the SearchPaths
for(i = finalPath.begin();
i != finalPath.end(); ++i)
{
if(cmSystemTools::FileIsDirectory(i->c_str()))
{
this->SearchPaths.push_back(*i);
}
}
}
void cmFindBase::PrintFindStuff()
{
std::cerr << "VariableName " << this->VariableName << "\n";
std::cerr << "VariableDocumentation " << this->VariableDocumentation << "\n";
std::cerr << "NoSystemPath " << this->NoSystemPath << "\n";
std::cerr << "NoCMakeEnvironmentPath " << this->NoCMakeEnvironmentPath << "\n";
std::cerr << "NoCMakePath " << this->NoCMakePath << "\n";
std::cerr << "NoCMakeSystemPath " << this->NoCMakeSystemPath << "\n";
std::cerr << "EnvironmentPath " << this->EnvironmentPath << "\n";
std::cerr << "CMakePathName " << this->CMakePathName << "\n";
std::cerr << "Names ";
for(unsigned int i =0; i < this->Names.size(); ++i)
{
std::cerr << this->Names[i] << " ";
}
std::cerr << "\n";
std::cerr << "\n";
std::cerr << "SearchPathSuffixes ";
for(unsigned int i =0; i < this->SearchPathSuffixes.size(); ++i)
{
std::cerr << this->SearchPathSuffixes[i] << "\n";
}
std::cerr << "\n";
std::cerr << "SearchPaths\n";
for(unsigned int i =0; i < this->SearchPaths.size(); ++i)
{
std::cerr << "[" << this->SearchPaths[i] << "]\n";
}
}
bool cmFindBase::CheckForVariableInCache()
{
std::cerr << "CheckForVariableInCache " << this->VariableName << "\n";
const char* cacheValue
= m_Makefile->GetDefinition(this->VariableName.c_str());
if(cacheValue && !cmSystemTools::IsNOTFOUND(cacheValue))
{
return true;
}
if(cacheValue)
{
std::cerr << "Cachevalue " << cacheValue << "\n";
cmCacheManager::CacheIterator it =
m_Makefile->GetCacheManager()->GetCacheIterator(this->VariableName.c_str());
if(!it.IsAtEnd())
{
const char* hs = it.GetProperty("HELPSTRING");
this->VariableDocumentation = hs?hs:"(none)";
}
}
return false;
}

75
Source/cmFindBase.h Normal file
View File

@ -0,0 +1,75 @@
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmFindBase_h
#define cmFindBase_h
#include "cmCommand.h"
/** \class cmFindBase
* \brief Define a command to search for an executable program.
*
* cmFindBase is a parent class for cmFindProgramCommand, cmFindPathCommand,
* and cmFindLibraryCommand, cmFindFile
*/
class cmFindBase : public cmCommand
{
public:
cmFindBase();
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool ParseArguments(std::vector<std::string> const& args);
cmTypeMacro(cmFindBase, cmCommand);
protected:
void PrintFindStuff();
void ExpandPaths(std::vector<std::string> userPaths);
void AddEnvironmentVairables();
void AddCMakeVairables();
void AddSystemEnvironmentVairables();
void AddCMakeSystemVariables();
void ExpandRegistryAndCleanPath();
// see if the VariableName is already set in the cache,
// also copy the documentation from the cache to VariableDocumentation
// if it has documentation in the cache
bool CheckForVariableInCache();
// use by command during find
cmStdString VariableDocumentation;
cmStdString VariableName;
std::vector<std::string> Names;
std::vector<std::string> SearchPaths;
std::vector<std::string> SearchPathSuffixes;
cmStdString CMakePathName; // CMAKE_*_PATH CMAKE_SYSTEM_*_PATH FRAMEWORK|LIBRARY|INCLUDE|PROGRAM
cmStdString EnvironmentPath; // LIB,INCLUDE
bool AlreadyInCache;
bool NoSystemPath;
bool NoCMakeEnvironmentPath;
bool NoCMakePath;
bool NoCMakeSystemPath;
bool SearchFrameworkFirst;
bool SearchFrameworkOnly;
bool SearchFrameworkLast;
};
#endif