blob: 5dfdb2152b4edced8663a5379f1a6f59e1542b3c [file] [log] [blame]
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile: cmGetTestPropertyCommand.h,v $
Language: C++
Date: $Date: 2012/03/29 17:21:09 $
Version: $Revision: 1.1.1.1 $
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 cmGetTestPropertyCommand_h
#define cmGetTestPropertyCommand_h
#include "cmCommand.h"
class cmGetTestPropertyCommand : public cmCommand
{
public:
virtual cmCommand* Clone()
{
return new cmGetTestPropertyCommand;
}
/**
* This is called when the command is first encountered in
* the input file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "get_test_property";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Get a property of the test.";
}
/**
* Longer documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" get_test_property(test VAR property)\n"
"Get a property from the Test. The value of the property is "
"stored in the variable VAR. If the property is not found, "
"CMake will report an error. For a list of standard properties "
"you can type cmake --help-property-list";
}
cmTypeMacro(cmGetTestPropertyCommand, cmCommand);
};
#endif