blob: 37d3575035716eb3fa72c84c328a5b33f2f6d559 (
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
|
/*=========================================================================
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 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);
/**
* 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 "WRITE_FILE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Write a message to a file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
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.";
}
cmTypeMacro(cmWriteFileCommand, cmCommand);
};
#endif
|
