blob: 65ad5b97ba89c9fc29463832e0d12b8e13c80d19 (
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
|
/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
#ifndef cmMacroCommand_h
#define cmMacroCommand_h
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
/** \class cmMacroFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmMacroFunctionBlocker : public cmFunctionBlocker
{
public:
cmMacroFunctionBlocker() {this->Depth=0;}
virtual ~cmMacroFunctionBlocker() {}
virtual bool IsFunctionBlocked(const cmListFileFunction&,
cmMakefile &mf,
cmExecutionStatus &);
virtual bool ShouldRemove(const cmListFileFunction&, cmMakefile &mf);
std::vector<std::string> Args;
std::vector<cmListFileFunction> Functions;
int Depth;
};
/** \class cmMacroCommand
* \brief starts an if block
*
* cmMacroCommand starts an if block
*/
class cmMacroCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmMacroCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "macro";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Start recording a macro for later invocation as a command.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" macro(<name> [arg1 [arg2 [arg3 ...]]])\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" endmacro(<name>)\n"
"Define a macro named <name> that takes arguments named "
"arg1 arg2 arg3 (...). Commands listed after macro, "
"but before the matching endmacro, are not invoked until the macro "
"is invoked. When it is invoked, the commands recorded in the "
"macro are first modified by replacing formal parameters (${arg1}) "
"with the arguments passed, and then invoked as normal commands. In "
"addition to referencing the formal parameters you can reference "
"the values ${ARGC} which will be set to the number of arguments "
"passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} "
"... which "
"will have the actual values of the arguments passed in. This "
"facilitates creating macros with optional arguments. Additionally "
"${ARGV} holds the list of all arguments given to the macro and "
"${ARGN} "
"holds the list of argument past the last expected argument. "
"Note that the parameters to a macro and values such as ARGN "
"are not variables in the usual CMake sense. They are string "
"replacements much like the c preprocessor would do with a "
"macro. If you want true CMake variables you should look at "
"the function command."
"\n"
"See the cmake_policy() command documentation for the behavior of "
"policies inside macros."
;
}
cmTypeMacro(cmMacroCommand, cmCommand);
};
#endif
|
