97 lines
3.0 KiB
C++
97 lines
3.0 KiB
C++
/*=========================================================================
|
|
|
|
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 cmFindLibraryCommand_h
|
|
#define cmFindLibraryCommand_h
|
|
|
|
#include "cmCommand.h"
|
|
|
|
|
|
/** \class cmFindLibraryCommand
|
|
* \brief Define a command to search for a library.
|
|
*
|
|
* cmFindLibraryCommand is used to define a CMake variable
|
|
* that specifies a library. The command searches for a given
|
|
* file in a list of directories.
|
|
*/
|
|
class cmFindLibraryCommand : public cmCommand
|
|
{
|
|
public:
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual cmCommand* Clone()
|
|
{
|
|
return new cmFindLibraryCommand;
|
|
}
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool InitialPass(std::vector<std::string> const& args);
|
|
|
|
/**
|
|
* This determines if the command is invoked when in script mode.
|
|
*/
|
|
virtual bool IsScriptable() { return true; }
|
|
|
|
/**
|
|
* The name of the command as specified in CMakeList.txt.
|
|
*/
|
|
virtual const char* GetName() {return "FIND_LIBRARY";}
|
|
|
|
/**
|
|
* Succinct documentation.
|
|
*/
|
|
virtual const char* GetTerseDocumentation()
|
|
{
|
|
return "Find a library.";
|
|
}
|
|
|
|
/**
|
|
* More documentation.
|
|
*/
|
|
virtual const char* GetFullDocumentation()
|
|
{
|
|
return
|
|
" FIND_LIBRARY(<VAR> NAMES name1 [name2 ...]\n"
|
|
" [PATHS path1 path2 ...]\n"
|
|
" [DOC \"docstring\"])\n"
|
|
"Find a library named by one of the names given after the NAMES "
|
|
"argument. A cache entry named by <VAR> is created "
|
|
"to store the result. If the library is not found, the result "
|
|
"will be <VAR>-NOTFOUND. If DOC is specified then the next "
|
|
"argument is treated as a documentation string for the cache "
|
|
"entry <VAR>.\n"
|
|
" FIND_LIBRARY(VAR libraryName [path1 path2 ...])\n"
|
|
"Find a library with the given name by searching in the specified "
|
|
"paths. This is a short-hand signature for the command that is "
|
|
"sufficient in many cases. "
|
|
"The search proceeds first in paths listed in the CMAKE_LIBRARY_PATH "
|
|
"CMake variable (which is generally set by the user on the command line), "
|
|
"then in paths listed in the CMAKE_LIBRARY_PATH environment variable, "
|
|
"then in paths given to the PATHS option of the command, "
|
|
"and finally in paths listed in the PATH environment variable.";
|
|
}
|
|
|
|
cmTypeMacro(cmFindLibraryCommand, cmCommand);
|
|
};
|
|
|
|
|
|
|
|
#endif
|