CMake/Source/cmLoadCommandCommand.h

79 lines
1.9 KiB
C
Raw Normal View History

2002-08-21 19:58:48 +04:00
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 cmLoadCommandCommand_h
#define cmLoadCommandCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmLoadCommandCommand
* \brief Load in a Command plugin
*
* cmLoadCommandCommand loads a command into CMake
*/
class cmLoadCommandCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmLoadCommandCommand;
}
/**
* 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 gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() {return true;}
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "LOAD_COMMAND";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Load a command into a running CMake";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"LOAD_COMMAND(command)\n";
}
cmTypeMacro(cmLoadCommandCommand, cmCommand);
};
#endif