CMake/Source/cmFindBase.h

77 lines
2.3 KiB
C
Raw Normal View History

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