CMake/Source/CTest/cmCTestConfigureCommand.h

90 lines
2.5 KiB
C
Raw Normal View History

/*=========================================================================
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.
2006-03-09 19:17:10 +03:00
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 cmCTestConfigureCommand_h
#define cmCTestConfigureCommand_h
#include "cmCTestHandlerCommand.h"
/** \class cmCTestConfigure
* \brief Run a ctest script
*
* cmCTestConfigureCommand defineds the command to configures the project.
*/
class cmCTestConfigureCommand : public cmCTestHandlerCommand
{
public:
cmCTestConfigureCommand();
2006-03-09 19:17:10 +03:00
/**
* This is a virtual constructor for the command.
*/
2006-03-09 19:17:10 +03:00
virtual cmCommand* Clone()
{
cmCTestConfigureCommand* ni = new cmCTestConfigureCommand;
2006-03-10 23:03:09 +03:00
ni->CTest = this->CTest;
ni->CTestScriptHandler = this->CTestScriptHandler;
return ni;
}
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "ctest_configure";}
/**
* Succinct documentation.
*/
2006-03-09 19:17:10 +03:00
virtual const char* GetTerseDocumentation()
{
return "Configure the project build tree.";
}
2006-03-09 19:17:10 +03:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" ctest_configure([BUILD build_dir] [SOURCE source_dir] [APPEND]\n"
" [OPTIONS options] [RETURN_VALUE res])\n"
2006-03-09 19:17:10 +03:00
"Configures the given build directory and stores results in "
"Configure.xml. "
"If no BUILD is given, the CTEST_BINARY_DIRECTORY variable is used. "
"If no SOURCE is given, the CTEST_SOURCE_DIRECTORY variable is used. "
"The OPTIONS argument specifies command line arguments to pass to "
"the configuration tool. "
"The RETURN_VALUE option specifies a variable in which to store the "
"return value of the native build tool."
"\n"
CTEST_COMMAND_APPEND_OPTION_DOCS;
}
cmTypeMacro(cmCTestConfigureCommand, cmCTestHandlerCommand);
protected:
cmCTestGenericHandler* InitializeHandler();
enum {
ctc_FIRST = ct_LAST,
ctc_OPTIONS,
ctc_LAST
};
};
#endif