blob: 818da4c7ebc41d11e79a570cb8de996ab89e96ba (
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
|
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Library of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmRuleMaker_h
#define cmRuleMaker_h
#include "cmStandardIncludes.h"
#include "cmMakefile.h"
/** \class cmRuleMaker
* \brief Superclass for all rules in CMake.
*
* cmRuleMaker is the base class for all rules in CMake.
* cmRuleMaker defines the API for rules with such features
* as enable/disable, inheritance, documentation, and construction.
*/
class cmRuleMaker
{
public:
/**
* Construct the rule enabled with no makefile.
* the input file.
*/
cmRuleMaker()
{m_Makefile = 0; m_Enabled = true;}
/**
* Specify the makefile.
*/
void SetMakefile(cmMakefile*m)
{m_Makefile = m; }
/**
* This is called when the rule is first encountered in
* the CMakeLists.txt file.
*/
virtual bool Invoke(std::vector<std::string>& args) = 0;
/**
* This is called at the end after all the information
* specified by the rules is accumulated.
*/
virtual void FinalPass() = 0;
/**
* This is called to let the rule check the cache.
*/
virtual void LoadCache() {}
/**
* This is a virtual constructor for the rule.
*/
virtual cmRuleMaker* Clone() = 0;
/**
* This determines if the rule gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{
return false;
}
/**
* The name of the rule as specified in CMakeList.txt.
*/
virtual const char* GetName() = 0;
/**
* Succinct documentation.
*/
virtual const char* TerseDocumentation() = 0;
/**
* More documentation.
*/
virtual const char* FullDocumentation() = 0;
/**
* Enable the rule.
*/
void EnabledOn()
{m_Enabled = true;}
/**
* Disable the rule.
*/
void EnabledOff()
{m_Enabled = false;}
/**
* Query whether the rule is enabled.
*/
bool GetEnabled()
{return m_Enabled;}
/**
* Return the last error string.
*/
const char* GetError()
{return m_Error.c_str();}
protected:
void SetError(const char* e)
{
m_Error = this->GetName();
m_Error += " ";
m_Error += e;
}
cmMakefile* m_Makefile;
private:
bool m_Enabled;
std::string m_Error;
};
#endif
|
