blob: 64602c9dbfbbdc49823ee50be790973195f6e6c3 (
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
|
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmForEachCommand_h
#define cmForEachCommand_h
#include "cmCommand.h"
#include "cmFunctionBlocker.h"
#include "cmListFileCache.h"
/** \class cmForEachFunctionBlocker
* \brief subclass of function blocker
*
*
*/
class cmForEachFunctionBlocker : public cmFunctionBlocker
{
public:
cmForEachFunctionBlocker() {m_Executing = false;}
virtual ~cmForEachFunctionBlocker() {}
virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
cmMakefile &mf);
virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf);
virtual void ScopeEnded(cmMakefile &mf);
std::vector<std::string> m_Args;
std::vector<cmListFileFunction> m_Functions;
bool m_Executing;
};
/** \class cmForEachCommand
* \brief starts an if block
*
* cmForEachCommand starts an if block
*/
class cmForEachCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmForEachCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() {return true;}
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FOREACH";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Evaluate a group of commands for each value in a list.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" FOREACH(loop_var arg1 arg2 ...)\n"
" COMMAND1(ARGS ...)\n"
" COMMAND2(ARGS ...)\n"
" ...\n"
" ENDFOREACH(loop_var)\n"
" FOREACH(loop_var RANGE total)\n"
" FOREACH(loop_var RANGE start stop [step])\n"
"All commands between FOREACH and the matching ENDFOREACH are recorded "
"without being invoked. Once the ENDFOREACH is evaluated, the "
"recorded list of commands is invoked once for each argument listed "
"in the original FOREACH command. Each recorded command is modified "
"before invocation to replace any occurrence of \"${loop_var}\" with "
"the current value in the list.\n"
"Foreach can also iterate over the range of numbers generated by "
"foreach. There are three types of this iteration:\n"
"* When specifying single number, the range will have elements "
"0 to \"total\".\n"
"* When specifying two numbers, the range will have elements from "
"the first number to the second number.\n"
"* The third optional number is the increment used to iterate from "
"the first number to the second number.";
}
cmTypeMacro(cmForEachCommand, cmCommand);
};
#endif
|
