CMake/Source/cmFindProgramRule.h

85 lines
1.9 KiB
C++

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Library of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmFindProgramRule_h
#define cmFindProgramRule_h
#include "cmStandardIncludes.h"
#include "cmRuleMaker.h"
/** \class cmFindProgramRule
* \brief Define a rule to search for an executable program.
*
* cmFindProgramRule is used to define a CMake variable
* that specifies an executable program. The rule searches
* in the current path (e.g., PATH environment variable) for
* an executable that matches one of the supplied names.
*/
class cmFindProgramRule : public cmRuleMaker
{
public:
/**
* This is a virtual constructor for the rule.
*/
virtual cmRuleMaker* Clone()
{
return new cmFindProgramRule;
}
/**
* This is called when the rule is first encountered in
* the CMakeLists.txt file.
*/
virtual bool Invoke(std::vector<std::string>& args);
/**
* This is called at the end after all the information
* specified by the rules is accumulated.
*/
virtual void FinalPass() { }
/**
* This determines if the rule gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() { return true; }
/**
* The name of the rule as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_PROGRARM";}
/**
* Succinct documentation.
*/
virtual const char* TerseDocumentation()
{
return "Find an executable program.";
}
/**
* More documentation.
*/
virtual const char* FullDocumentation()
{
return
"FIND_PROGRAM(NAME executable1 executable2 ...)";
}
};
#endif