blob: 771ef5a1b392e81c19ecae3f55b068f23540c10a (
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
|
/*============================================================================
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 cmWriteFileCommand_h
#define cmWriteFileCommand_h
#include "cmCommand.h"
/** \class cmWriteFileCommand
* \brief Writes a message to a file
*
*/
class cmWriteFileCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmWriteFileCommand;
}
/**
* 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 "write_file";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
{
return "Deprecated. Use the file(WRITE ) command instead.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
{
return
" write_file(filename \"message to write\"... [APPEND])\n"
"The first argument is the file name, the rest of the arguments are "
"messages to write. If the argument APPEND is specified, then "
"the message will be appended.\n"
"NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as "
"this one but add some more functionality.\n"
"NOTE 2: When using write_file the produced file cannot be used as an "
"input to CMake (CONFIGURE_FILE, source file ...) because it will "
"lead to an infinite loop. Use configure_file if you want to generate "
"input files to CMake.";
}
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged() const
{
return true;
}
cmTypeMacro(cmWriteFileCommand, cmCommand);
};
#endif
|
