CMake/Source/cmAddTestCommand.h
2002-01-21 15:30:43 -05:00

88 lines
2.4 KiB
C++

/*=========================================================================
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 cmAddTestCommand_h
#define cmAddTestCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmAddTestCommand
* \brief Add a test to the lists of tests to run.
*
* cmAddTestCommand adds a test to the list of tests to run .
*/
class cmAddTestCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmAddTestCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* This is called at the end after all the information
* specified by the command is accumulated.
*/
virtual void FinalPass();
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ADD_TEST";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Add a test to the project with the specified arguments.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"ADD_TEST(testname exename arg1 arg2 arg3 ...)\n"
"If the ENABLE_TESTING command has been run, this command adds a"
"test target to the current directory. If ENABLE_TESTING has not"
"been run, this command does nothing.\n"
"The tests are run by the testing subsystem by executing exename "
"with the specified arguments. exename can be either an executable "
"built by built by this project or an arbitrary executable on the "
"system (like tclsh).";
}
cmTypeMacro(cmAddTestCommand, cmCommand);
private:
std::vector<std::string> m_Args;
};
#endif