mirror of
https://github.com/Kitware/CMake.git
synced 2025-06-15 08:30:44 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
98 lines
2.6 KiB
C++
98 lines
2.6 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmExecutionStatus;
|
|
class cmMakefile;
|
|
struct cmListFileArgument;
|
|
|
|
/** \class cmCommand
|
|
* \brief Superclass for all commands in CMake.
|
|
*
|
|
* cmCommand is the base class for all commands in CMake. A command
|
|
* manifests as an entry in CMakeLists.txt and produces one or
|
|
* more makefile rules. Commands are associated with a particular
|
|
* makefile. This base class cmCommand defines the API for commands
|
|
* to support such features as enable/disable, inheritance,
|
|
* documentation, and construction.
|
|
*/
|
|
class cmCommand
|
|
{
|
|
public:
|
|
/**
|
|
* Construct the command. By default it has no makefile.
|
|
*/
|
|
cmCommand() = default;
|
|
|
|
/**
|
|
* Need virtual destructor to destroy real command type.
|
|
*/
|
|
virtual ~cmCommand() = default;
|
|
|
|
cmCommand(cmCommand const&) = delete;
|
|
cmCommand& operator=(cmCommand const&) = delete;
|
|
|
|
/**
|
|
* Specify the makefile.
|
|
*/
|
|
cmMakefile* GetMakefile() { return this->Makefile; }
|
|
|
|
void SetExecutionStatus(cmExecutionStatus* s);
|
|
cmExecutionStatus* GetExecutionStatus() { return this->Status; };
|
|
|
|
/**
|
|
* This is called by the cmMakefile when the command is first
|
|
* encountered in the CMakeLists.txt file. It expands the command's
|
|
* arguments and then invokes the InitialPass.
|
|
*/
|
|
bool InvokeInitialPass(const std::vector<cmListFileArgument>& args,
|
|
cmExecutionStatus& status);
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool InitialPass(std::vector<std::string> const& args,
|
|
cmExecutionStatus&) = 0;
|
|
|
|
/**
|
|
* This is a virtual constructor for the command.
|
|
*/
|
|
virtual std::unique_ptr<cmCommand> Clone() = 0;
|
|
|
|
/**
|
|
* Set the error message
|
|
*/
|
|
void SetError(const std::string& e);
|
|
|
|
protected:
|
|
cmMakefile* Makefile = nullptr;
|
|
|
|
private:
|
|
cmExecutionStatus* Status = nullptr;
|
|
};
|
|
|
|
class cmLegacyCommandWrapper
|
|
{
|
|
public:
|
|
explicit cmLegacyCommandWrapper(std::unique_ptr<cmCommand> cmd);
|
|
|
|
cmLegacyCommandWrapper(cmLegacyCommandWrapper const& other);
|
|
cmLegacyCommandWrapper& operator=(cmLegacyCommandWrapper const& other);
|
|
|
|
cmLegacyCommandWrapper(cmLegacyCommandWrapper&&) = default;
|
|
cmLegacyCommandWrapper& operator=(cmLegacyCommandWrapper&&) = default;
|
|
|
|
bool operator()(std::vector<cmListFileArgument> const& args,
|
|
cmExecutionStatus& status) const;
|
|
|
|
private:
|
|
std::unique_ptr<cmCommand> Command;
|
|
};
|