CMake/Source/CTest/cmCTestHandlerCommand.h
2019-09-20 13:27:30 +02:00

63 lines
1.7 KiB
C++

/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmCTestHandlerCommand_h
#define cmCTestHandlerCommand_h
#include "cmConfigure.h" // IWYU pragma: keep
#include "cmArgumentParser.h"
#include "cmCTestCommand.h"
#include <string>
#include <vector>
class cmCTestGenericHandler;
class cmExecutionStatus;
/** \class cmCTestHandler
* \brief Run a ctest script
*
* cmCTestHandlerCommand defineds the command to test the project.
*/
class cmCTestHandlerCommand
: public cmCTestCommand
, public cmArgumentParser<void>
{
public:
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual std::string GetName() const = 0;
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus& status) override;
protected:
virtual cmCTestGenericHandler* InitializeHandler() = 0;
virtual void ProcessAdditionalValues(cmCTestGenericHandler* handler);
// Command argument handling.
virtual void BindArguments();
virtual void CheckArguments(std::vector<std::string> const& keywords);
bool Append = false;
bool Quiet = false;
std::string CaptureCMakeError;
std::string ReturnValue;
std::string Build;
std::string Source;
std::string SubmitIndex;
};
#define CTEST_COMMAND_APPEND_OPTION_DOCS \
"The APPEND option marks results for append to those previously " \
"submitted to a dashboard server since the last ctest_start. " \
"Append semantics are defined by the dashboard server in use."
#endif