CMake/Source/cmFindPathCommand.h

77 lines
2.1 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-04-26 17:38:31 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-04-26 17:38:31 +04: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.
============================================================================*/
2001-04-26 17:38:31 +04:00
#ifndef cmFindPathCommand_h
#define cmFindPathCommand_h
2006-03-02 21:30:22 +03:00
#include "cmFindBase.h"
2001-04-26 17:38:31 +04:00
/** \class cmFindPathCommand
* \brief Define a command to search for a library.
*
* cmFindPathCommand is used to define a CMake variable
* that specifies a library. The command searches for a given
* file in a list of directories.
*/
2006-03-02 21:30:22 +03:00
class cmFindPathCommand : public cmFindBase
2001-04-26 17:38:31 +04:00
{
public:
2006-03-02 21:30:22 +03:00
cmFindPathCommand();
2001-04-26 17:38:31 +04:00
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindPathCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2001-04-26 17:38:31 +04:00
2004-02-23 06:07:02 +03:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
2001-04-26 17:38:31 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "find_path";}
2001-04-26 17:38:31 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find the directory containing a file.";
2001-04-26 17:38:31 +04:00
}
2006-03-02 21:30:22 +03:00
cmTypeMacro(cmFindPathCommand, cmFindBase);
bool IncludeFileInPath;
protected:
virtual void GenerateDocumentation();
private:
std::string FindHeaderInFramework(std::string const& file,
std::string const& dir);
std::string FindHeader();
std::string FindNormalHeader();
std::string FindFrameworkHeader();
2001-04-26 17:38:31 +04:00
};
#endif