86578eccf2
Per-source copyright/license notice headers that spell out copyright holder names and years are hard to maintain and often out-of-date or plain wrong. Precise contributor information is already maintained automatically by the version control tool. Ultimately it is the receiver of a file who is responsible for determining its licensing status, and per-source notices are merely a convenience. Therefore it is simpler and more accurate for each source to have a generic notice of the license name and references to more detailed information on copyright holders and full license terms. Our `Copyright.txt` file now contains a list of Contributors whose names appeared source-level copyright notices. It also references version control history for more precise information. Therefore we no longer need to spell out the list of Contributors in each source file notice. Replace CMake per-source copyright/license notice headers with a short description of the license and links to `Copyright.txt` and online information available from "https://cmake.org/licensing". The online URL also handles cases of modules being copied out of our source into other projects, so we can drop our notices about replacing links with full license text. Run the `Utilities/Scripts/filter-notices.bash` script to perform the majority of the replacements mechanically. Manually fix up shebang lines and trailing newlines in a few files. Manually update the notices in a few files that the script does not handle.
110 lines
2.7 KiB
C++
110 lines
2.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 cmCTestGenericHandler_h
|
|
#define cmCTestGenericHandler_h
|
|
|
|
#include <cmConfigure.h>
|
|
|
|
#include "cmCTest.h"
|
|
#include "cmObject.h"
|
|
#include "cmSystemTools.h"
|
|
|
|
#include <map>
|
|
#include <stddef.h>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmCTestCommand;
|
|
class cmGeneratedFileStream;
|
|
class cmMakefile;
|
|
|
|
/** \class cmCTestGenericHandler
|
|
* \brief A superclass of all CTest Handlers
|
|
*
|
|
*/
|
|
class cmCTestGenericHandler : public cmObject
|
|
{
|
|
public:
|
|
/**
|
|
* If verbose then more informaiton is printed out
|
|
*/
|
|
void SetVerbose(bool val)
|
|
{
|
|
this->HandlerVerbose =
|
|
val ? cmSystemTools::OUTPUT_MERGE : cmSystemTools::OUTPUT_NONE;
|
|
}
|
|
|
|
/**
|
|
* Populate internals from CTest custom scripts
|
|
*/
|
|
virtual void PopulateCustomVectors(cmMakefile*) {}
|
|
|
|
/**
|
|
* Do the actual processing. Subclass has to override it.
|
|
* Return < 0 if error.
|
|
*/
|
|
virtual int ProcessHandler() = 0;
|
|
|
|
/**
|
|
* Process command line arguments that are applicable for the handler
|
|
*/
|
|
virtual int ProcessCommandLineArguments(
|
|
const std::string& /*currentArg*/, size_t& /*idx*/,
|
|
const std::vector<std::string>& /*allArgs*/)
|
|
{
|
|
return 1;
|
|
}
|
|
|
|
/**
|
|
* Initialize handler
|
|
*/
|
|
virtual void Initialize();
|
|
|
|
/**
|
|
* Set the CTest instance
|
|
*/
|
|
void SetCTestInstance(cmCTest* ctest) { this->CTest = ctest; }
|
|
cmCTest* GetCTestInstance() { return this->CTest; }
|
|
|
|
/**
|
|
* Construct handler
|
|
*/
|
|
cmCTestGenericHandler();
|
|
~cmCTestGenericHandler() CM_OVERRIDE;
|
|
|
|
typedef std::map<std::string, std::string> t_StringToString;
|
|
|
|
void SetPersistentOption(const std::string& op, const char* value);
|
|
void SetOption(const std::string& op, const char* value);
|
|
const char* GetOption(const std::string& op);
|
|
|
|
void SetCommand(cmCTestCommand* command) { this->Command = command; }
|
|
|
|
void SetSubmitIndex(int idx) { this->SubmitIndex = idx; }
|
|
int GetSubmitIndex() { return this->SubmitIndex; }
|
|
|
|
void SetAppendXML(bool b) { this->AppendXML = b; }
|
|
void SetQuiet(bool b) { this->Quiet = b; }
|
|
bool GetQuiet() { return this->Quiet; }
|
|
void SetTestLoad(unsigned long load) { this->TestLoad = load; }
|
|
unsigned long GetTestLoad() const { return this->TestLoad; }
|
|
|
|
protected:
|
|
bool StartResultingXML(cmCTest::Part part, const char* name,
|
|
cmGeneratedFileStream& xofs);
|
|
bool StartLogFile(const char* name, cmGeneratedFileStream& xofs);
|
|
|
|
bool AppendXML;
|
|
bool Quiet;
|
|
unsigned long TestLoad;
|
|
cmSystemTools::OutputOption HandlerVerbose;
|
|
cmCTest* CTest;
|
|
t_StringToString Options;
|
|
t_StringToString PersistentOptions;
|
|
|
|
cmCTestCommand* Command;
|
|
int SubmitIndex;
|
|
};
|
|
|
|
#endif
|