2009-09-28 15:43:28 +00:00
|
|
|
/*============================================================================
|
|
|
|
CMake - Cross Platform Makefile Generator
|
|
|
|
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
|
2006-02-27 21:38:22 +00:00
|
|
|
|
2009-09-28 15:43:28 +00:00
|
|
|
Distributed under the OSI-approved BSD License (the "License");
|
|
|
|
see accompanying file Copyright.txt for details.
|
2006-02-27 21:38:22 +00:00
|
|
|
|
2009-09-28 15:43:28 +00:00
|
|
|
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.
|
|
|
|
============================================================================*/
|
2006-02-27 21:38:22 +00:00
|
|
|
#ifndef cmFindBase_h
|
|
|
|
#define cmFindBase_h
|
|
|
|
|
2008-01-17 14:02:31 +00:00
|
|
|
#include "cmFindCommon.h"
|
2006-02-27 21:38:22 +00:00
|
|
|
|
|
|
|
/** \class cmFindBase
|
2008-01-17 14:02:31 +00:00
|
|
|
* \brief Base class for most FIND_XXX commands.
|
2006-02-27 21:38:22 +00:00
|
|
|
*
|
|
|
|
* cmFindBase is a parent class for cmFindProgramCommand, cmFindPathCommand,
|
2008-01-17 14:02:31 +00:00
|
|
|
* and cmFindLibraryCommand, cmFindFileCommand
|
2006-02-27 21:38:22 +00:00
|
|
|
*/
|
2008-01-17 14:02:31 +00:00
|
|
|
class cmFindBase : public cmFindCommon
|
2006-02-27 21:38:22 +00:00
|
|
|
{
|
|
|
|
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);
|
2008-01-17 14:02:31 +00:00
|
|
|
cmTypeMacro(cmFindBase, cmFindCommon);
|
2006-03-02 18:30:22 +00:00
|
|
|
|
|
|
|
virtual const char* GetFullDocumentation()
|
|
|
|
{return this->GenericDocumentation.c_str();}
|
|
|
|
|
2006-02-27 21:38:22 +00:00
|
|
|
protected:
|
|
|
|
void PrintFindStuff();
|
2008-06-05 22:20:16 +00:00
|
|
|
void ExpandPaths();
|
|
|
|
void AddPathSuffixes();
|
2008-01-17 14:02:31 +00:00
|
|
|
|
2006-02-27 21:38:22 +00:00
|
|
|
// 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();
|
|
|
|
|
2006-03-02 18:30:22 +00:00
|
|
|
cmStdString GenericDocumentation;
|
2006-02-27 21:38:22 +00:00
|
|
|
// use by command during find
|
|
|
|
cmStdString VariableDocumentation;
|
|
|
|
cmStdString VariableName;
|
|
|
|
std::vector<std::string> Names;
|
2006-03-10 18:54:57 +00:00
|
|
|
|
|
|
|
// CMAKE_*_PATH CMAKE_SYSTEM_*_PATH FRAMEWORK|LIBRARY|INCLUDE|PROGRAM
|
2006-02-27 21:38:22 +00:00
|
|
|
cmStdString EnvironmentPath; // LIB,INCLUDE
|
|
|
|
|
|
|
|
bool AlreadyInCache;
|
2006-07-18 19:21:26 +00:00
|
|
|
bool AlreadyInCacheWithoutMetaInfo;
|
2008-06-05 22:20:16 +00:00
|
|
|
private:
|
|
|
|
// Add pieces of the search.
|
|
|
|
void AddCMakeEnvironmentPath();
|
|
|
|
void AddCMakeVariablePath();
|
|
|
|
void AddSystemEnvironmentPath();
|
|
|
|
void AddCMakeSystemVariablePath();
|
2008-06-09 19:08:59 +00:00
|
|
|
void AddUserHintsPath();
|
|
|
|
void AddUserGuessPath();
|
2008-06-05 22:20:16 +00:00
|
|
|
|
|
|
|
// Helpers.
|
|
|
|
void AddCMakePrefixPath(const char* variable);
|
|
|
|
void AddEnvPrefixPath(const char* variable);
|
|
|
|
void AddPrefixPaths(std::vector<std::string> const& in_paths,
|
|
|
|
PathType pathType);
|
2006-02-27 21:38:22 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|