blob: 65bb7c5fcd4f0dea22d2297e2b8bc01a2a763c81 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmCommand_h
#define cmCommand_h
#include "cmObject.h"
#include "cmCommandArgumentsHelper.h"
#include "cmListFileCache.h"
#include "cmMakefile.h"
/** \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 is enabled with no makefile.
*/
cmCommand()
: Makefile(CM_NULLPTR)
, Enabled(true)
{
}
/**
* Need virtual destructor to destroy real command type.
*/
virtual ~cmCommand() {}
/**
* Specify the makefile.
*/
void SetMakefile(cmMakefile* m) { this->Makefile = m; }
cmMakefile* GetMakefile() { return this->Makefile; }
/**
* 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.
*/
virtual 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 called at the end after all the information
* specified by the command is accumulated. Most commands do
* not implement this method. At this point, reading and
* writing to the cache can be done.
*/
virtual void FinalPass() {}
/**
* Does this command have a final pass? Query after InitialPass.
*/
virtual bool HasFinalPass() const { return false; }
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone() = 0;
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return false; }
/**
* This determines if the command is defined in a cmake script.
* It is the case for cmMacroHelperCommand and cmFunctionHelperCommand.
*/
virtual bool IsUserDefined() const { return false; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual std::string GetName() const = 0;
/**
* Enable the command.
*/
void EnabledOn() { this->Enabled = true; }
/**
* Disable the command.
*/
void EnabledOff() { this->Enabled = false; }
/**
* Query whether the command is enabled.
*/
bool GetEnabled() const { return this->Enabled; }
/**
* Disable or enable the command.
*/
void SetEnabled(bool enabled) { this->Enabled = enabled; }
/**
* Return the last error string.
*/
const char* GetError();
/**
* Set the error message
*/
void SetError(const std::string& e);
/** Check if the command is disallowed by a policy. */
bool Disallowed(cmPolicies::PolicyID pol, const char* e);
protected:
cmMakefile* Makefile;
cmCommandArgumentsHelper Helper;
private:
bool Enabled;
std::string Error;
};
#endif
|
